pkcs11h-core.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005-2011 Alon Bar-Lev <alon.barlev@gmail.com>
 * All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, or the BSD license.
 *
 * GNU General Public License (GPL) Version 2
 * ===========================================
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program (see the file COPYING.GPL included with this
 * distribution); if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * BSD License
 * ============
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     o Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     o Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     o Neither the name of the Alon Bar-Lev nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __PKCS11H_BASE_H
#define __PKCS11H_BASE_H

#include <stdarg.h>
#include <time.h>

#include <pkcs11-helper-1.0/pkcs11h-version.h>
#include <pkcs11-helper-1.0/pkcs11h-def.h>
#include <pkcs11-helper-1.0/pkcs11h-engines.h>

#if defined(__cplusplus)
extern "C" {
#endif

#define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_OPENSSL      (1<< 0)

#define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_GNUTLS       (1<< 1)

#define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_WIN32        (1<< 2)

#define PKCS11H_FEATURE_MASK_DEBUG                      (1<< 3)

#define PKCS11H_FEATURE_MASK_THREADING                  (1<< 4)

#define PKCS11H_FEATURE_MASK_TOKEN                      (1<< 5)

#define PKCS11H_FEATURE_MASK_DATA                       (1<< 6)

#define PKCS11H_FEATURE_MASK_CERTIFICATE                (1<< 7)

#define PKCS11H_FEATURE_MASK_SLOTEVENT                  (1<< 8)

#define PKCS11H_FEATURE_MASK_OPENSSL                    (1<< 9)

#define PKCS11H_LOG_DEBUG2      5

#define PKCS11H_LOG_DEBUG1      4

#define PKCS11H_LOG_INFO        3

#define PKCS11H_LOG_WARN        2

#define PKCS11H_LOG_ERROR       1

#define PKCS11H_LOG_QUIET       0

#define PKCS11H_PIN_CACHE_INFINITE      -1

#define PKCS11H_PRIVATEMODE_MASK_AUTO           (0)

#define PKCS11H_PRIVATEMODE_MASK_SIGN           (1<<0)

#define PKCS11H_PRIVATEMODE_MASK_RECOVER        (1<<1)

#define PKCS11H_PRIVATEMODE_MASK_DECRYPT        (1<<2)

#define PKCS11H_PRIVATEMODE_MASK_UNWRAP         (1<<3)

/* Auto select by provider information. */
#define PKCS11H_SLOTEVENT_METHOD_AUTO           0

#define PKCS11H_SLOTEVENT_METHOD_TRIGGER        1

#define PKCS11H_SLOTEVENT_METHOD_POLL           2

#define PKCS11H_SLOTEVENT_METHOD_FETCH          3

#define PKCS11H_PROMPT_MASK_ALLOW_PIN_PROMPT    (1<<0)

#define PKCS11H_PROMPT_MASK_ALLOW_TOKEN_PROMPT  (1<<1)

#define PKCS11H_PROMPT_MASK_ALLOW_ALL ( \
                PKCS11H_PROMPT_MASK_ALLOW_PIN_PROMPT | \
                PKCS11H_PROMPT_MASK_ALLOW_TOKEN_PROMPT \
        )

#define PKCS11H_ENUM_METHOD_CACHE               0

#define PKCS11H_ENUM_METHOD_CACHE_EXIST         1

#define PKCS11H_ENUM_METHOD_RELOAD              2

struct pkcs11h_token_id_s;

typedef struct pkcs11h_token_id_s *pkcs11h_token_id_t;

typedef void (*pkcs11h_hook_log_t)(
        IN void * const global_data,
        IN const unsigned flags,
        IN const char * const format,
        IN va_list args
);

typedef void (*pkcs11h_hook_slotevent_t)(
        IN void * const global_data
);

typedef PKCS11H_BOOL (*pkcs11h_hook_token_prompt_t)(
        IN void * const global_data,
        IN void * const user_data,
        IN const pkcs11h_token_id_t token,
        IN const unsigned retry
);

typedef PKCS11H_BOOL (*pkcs11h_hook_pin_prompt_t)(
        IN void * const global_data,
        IN void * const user_data,
        IN const pkcs11h_token_id_t token,
        IN const unsigned retry,
        OUT char * const pin,
        IN const size_t pin_max
);

struct pkcs11h_token_id_s {
        char display[1024];
        char manufacturerID[sizeof (((CK_TOKEN_INFO *)NULL)->manufacturerID)+1];
        char model[sizeof (((CK_TOKEN_INFO *)NULL)->model)+1];
        char serialNumber[sizeof (((CK_TOKEN_INFO *)NULL)->serialNumber)+1];
        char label[sizeof (((CK_TOKEN_INFO *)NULL)->label)+1];
};

const char *
pkcs11h_getMessage (
        IN const CK_RV rv
);

unsigned int
pkcs11h_getVersion (void);

unsigned int
pkcs11h_getFeatures (void);

CK_RV
pkcs11h_initialize (void);

CK_RV
pkcs11h_terminate (void);

void
pkcs11h_setLogLevel (
        IN const unsigned flags
);

unsigned
pkcs11h_getLogLevel (void);

CK_RV
pkcs11h_setForkMode (
        IN const PKCS11H_BOOL safe
);

CK_RV
pkcs11h_setLogHook (
        IN const pkcs11h_hook_log_t hook,
        IN void * const global_data
);

CK_RV
pkcs11h_setSlotEventHook (
        IN const pkcs11h_hook_slotevent_t hook,
        IN void * const global_data
);

CK_RV
pkcs11h_setTokenPromptHook (
        IN const pkcs11h_hook_token_prompt_t hook,
        IN void * const global_data
);

CK_RV
pkcs11h_setPINPromptHook (
        IN const pkcs11h_hook_pin_prompt_t hook,
        IN void * const global_data
);

CK_RV
pkcs11h_setProtectedAuthentication (
        IN const PKCS11H_BOOL allow_protected_auth
);

CK_RV
pkcs11h_setPINCachePeriod (
        IN const int pin_cache_period
);

CK_RV
pkcs11h_setMaxLoginRetries (
        IN const unsigned max_retries
);

CK_RV
pkcs11h_addProvider (
        IN const char * const reference,
        IN const char * const provider_location,
        IN const PKCS11H_BOOL allow_protected_auth,
        IN const unsigned mask_private_mode,
        IN const unsigned slot_event_method,
        IN const unsigned slot_poll_interval,
        IN const PKCS11H_BOOL cert_is_private
);

CK_RV
pkcs11h_removeProvider (
        IN const char * const reference
);

CK_RV
pkcs11h_forkFixup (void);

CK_RV
pkcs11h_plugAndPlay (void);

CK_RV
pkcs11h_logout (void);

#ifdef __cplusplus
}
#endif

#endif                          /* __PKCS11H_BASE_H */