67 #ifndef __PKCS11H_BASE_H
68 #define __PKCS11H_BASE_H
77 #if defined(__cplusplus)
88 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_OPENSSL (1<< 0)
90 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_GNUTLS (1<< 1)
92 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_CRYPTOAPI (1<< 2)
97 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_WIN32 (1<< 2)
99 #define PKCS11H_FEATURE_MASK_DEBUG (1<< 3)
101 #define PKCS11H_FEATURE_MASK_THREADING (1<< 4)
103 #define PKCS11H_FEATURE_MASK_TOKEN (1<< 5)
105 #define PKCS11H_FEATURE_MASK_DATA (1<< 6)
107 #define PKCS11H_FEATURE_MASK_CERTIFICATE (1<< 7)
109 #define PKCS11H_FEATURE_MASK_SLOTEVENT (1<< 8)
111 #define PKCS11H_FEATURE_MASK_OPENSSL (1<< 9)
113 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_POLARSSL (1<< 10)
124 #define PKCS11H_LOG_DEBUG2 5
126 #define PKCS11H_LOG_DEBUG1 4
128 #define PKCS11H_LOG_INFO 3
130 #define PKCS11H_LOG_WARN 2
132 #define PKCS11H_LOG_ERROR 1
134 #define PKCS11H_LOG_QUIET 0
138 #define PKCS11H_PIN_CACHE_INFINITE -1
146 #define PKCS11H_PRIVATEMODE_MASK_AUTO (0)
148 #define PKCS11H_PRIVATEMODE_MASK_SIGN (1<<0)
150 #define PKCS11H_PRIVATEMODE_MASK_RECOVER (1<<1)
152 #define PKCS11H_PRIVATEMODE_MASK_DECRYPT (1<<2)
154 #define PKCS11H_PRIVATEMODE_MASK_UNWRAP (1<<3)
163 #define PKCS11H_SLOTEVENT_METHOD_AUTO 0
165 #define PKCS11H_SLOTEVENT_METHOD_TRIGGER 1
167 #define PKCS11H_SLOTEVENT_METHOD_POLL 2
169 #define PKCS11H_SLOTEVENT_METHOD_FETCH 3
178 #define PKCS11H_PROMPT_MASK_ALLOW_PIN_PROMPT (1<<0)
180 #define PKCS11H_PROMPT_MASK_ALLOW_TOKEN_PROMPT (1<<1)
182 #define PKCS11H_PROMPT_MASK_ALLOW_ALL ( \
183 PKCS11H_PROMPT_MASK_ALLOW_PIN_PROMPT | \
184 PKCS11H_PROMPT_MASK_ALLOW_TOKEN_PROMPT \
194 #define PKCS11H_ENUM_METHOD_CACHE 0
196 #define PKCS11H_ENUM_METHOD_CACHE_EXIST 1
198 #define PKCS11H_ENUM_METHOD_RELOAD 2
216 IN
void *
const global_data,
217 IN
const unsigned flags,
218 IN
const char *
const format,
227 IN
void *
const global_data
239 IN
void *
const global_data,
240 IN
void *
const user_data,
241 IN
const pkcs11h_token_id_t token,
242 IN
const unsigned retry
256 IN
void *
const global_data,
257 IN
void *
const user_data,
258 IN
const pkcs11h_token_id_t token,
259 IN
const unsigned retry,
260 OUT
char *
const pin,
261 IN
const size_t pin_max
273 char model[
sizeof (((CK_TOKEN_INFO *)NULL)->model)+1];
277 char label[
sizeof (((CK_TOKEN_INFO *)NULL)->label)+1];
327 IN
const unsigned flags
351 IN
const PKCS11H_BOOL safe
363 IN
void *
const global_data
380 IN
void *
const global_data
394 IN
void *
const global_data
408 IN
void *
const global_data
419 IN
const PKCS11H_BOOL allow_protected_auth
430 IN
const int pin_cache_period
441 IN
const unsigned max_retries
459 IN
const char *
const reference,
460 IN
const char *
const provider_location,
461 IN
const PKCS11H_BOOL allow_protected_auth,
462 IN
const unsigned mask_private_mode,
463 IN
const unsigned slot_event_method,
464 IN
const unsigned slot_poll_interval,
465 IN
const PKCS11H_BOOL cert_is_private
476 IN
const char *
const reference
CK_RV pkcs11h_logout(void)
Logout from all sessions.
char serialNumber[sizeof(((CK_TOKEN_INFO *) NULL) ->serialNumber)+1]
Definition: pkcs11h-core.h:275
const char * pkcs11h_getMessage(IN const CK_RV rv)
Get message by return value.
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)
Token prompt hook.
Definition: pkcs11h-core.h:238
unsigned pkcs11h_getLogLevel(void)
Get current log level.
char model[sizeof(((CK_TOKEN_INFO *) NULL) ->model)+1]
Definition: pkcs11h-core.h:273
char manufacturerID[sizeof(((CK_TOKEN_INFO *) NULL) ->manufacturerID)+1]
Definition: pkcs11h-core.h:271
CK_RV pkcs11h_plugAndPlay(void)
Handle slot rescan.
char display[1024]
Definition: pkcs11h-core.h:269
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)
Add a PKCS#11 provider.
CK_RV pkcs11h_setMaxLoginRetries(IN const unsigned max_retries)
Set global login retries attempts.
Token identifier.
Definition: pkcs11h-core.h:267
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)
PIN prompt hook.
Definition: pkcs11h-core.h:255
CK_RV pkcs11h_forkFixup(void)
Handle special case of POSIX fork()
unsigned int pkcs11h_getFeatures(void)
Get features of library.
CK_RV pkcs11h_setTokenPromptHook(IN const pkcs11h_hook_token_prompt_t hook, IN void *const global_data)
Set a token prompt callback.
CK_RV pkcs11h_setPINCachePeriod(IN const int pin_cache_period)
Set global PIN cache timeout.
CK_RV pkcs11h_setPINPromptHook(IN const pkcs11h_hook_pin_prompt_t hook, IN void *const global_data)
Set a pin prompt callback.
CK_RV pkcs11h_initialize(void)
Inititalize helper interface.
CK_RV pkcs11h_terminate(void)
Terminate helper interface.
CK_RV pkcs11h_setProtectedAuthentication(IN const PKCS11H_BOOL allow_protected_auth)
Set global protected authentication mode.
CK_RV pkcs11h_setSlotEventHook(IN const pkcs11h_hook_slotevent_t hook, IN void *const global_data)
Set a slot event callback.
void(* pkcs11h_hook_slotevent_t)(IN void *const global_data)
Slotevent hook.
Definition: pkcs11h-core.h:226
CK_RV pkcs11h_removeProvider(IN const char *const reference)
Delete a PKCS#11 provider.
CK_RV pkcs11h_setForkMode(IN const PKCS11H_BOOL safe)
How does the foked process bahaves after POSIX fork()
void(* pkcs11h_hook_log_t)(IN void *const global_data, IN const unsigned flags, IN const char *const format, IN va_list args)
Log hook.
Definition: pkcs11h-core.h:215
CK_RV pkcs11h_setLogHook(IN const pkcs11h_hook_log_t hook, IN void *const global_data)
Set a log callback.
unsigned int pkcs11h_getVersion(void)
Get version of library.
void pkcs11h_setLogLevel(IN const unsigned flags)
Set current log level of the helper.
pkcs11-helper engines definitions.
struct pkcs11h_token_id_s * pkcs11h_token_id_t
Token identifier.
Definition: pkcs11h-core.h:206
pkcs11-helper core definitions.
char label[sizeof(((CK_TOKEN_INFO *) NULL) ->label)+1]
Definition: pkcs11h-core.h:277