66 #ifndef __PKCS11H_BASE_H
67 #define __PKCS11H_BASE_H
76 #if defined(__cplusplus)
87 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_OPENSSL (1<< 0)
89 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_GNUTLS (1<< 1)
91 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_CRYPTOAPI (1<< 2)
96 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_WIN32 (1<< 2)
98 #define PKCS11H_FEATURE_MASK_DEBUG (1<< 3)
100 #define PKCS11H_FEATURE_MASK_THREADING (1<< 4)
102 #define PKCS11H_FEATURE_MASK_TOKEN (1<< 5)
104 #define PKCS11H_FEATURE_MASK_DATA (1<< 6)
106 #define PKCS11H_FEATURE_MASK_CERTIFICATE (1<< 7)
108 #define PKCS11H_FEATURE_MASK_SLOTEVENT (1<< 8)
110 #define PKCS11H_FEATURE_MASK_OPENSSL (1<< 9)
112 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_POLARSSL (1<< 10)
114 #define PKCS11H_FEATURE_MASK_ENGINE_CRYPTO_MBEDTLS (1<< 10)
125 #define PKCS11H_LOG_DEBUG2 5
127 #define PKCS11H_LOG_DEBUG1 4
129 #define PKCS11H_LOG_INFO 3
131 #define PKCS11H_LOG_WARN 2
133 #define PKCS11H_LOG_ERROR 1
135 #define PKCS11H_LOG_QUIET 0
139 #define PKCS11H_PIN_CACHE_INFINITE -1
147 #define PKCS11H_PRIVATEMODE_MASK_AUTO (0)
149 #define PKCS11H_PRIVATEMODE_MASK_SIGN (1<<0)
151 #define PKCS11H_PRIVATEMODE_MASK_RECOVER (1<<1)
153 #define PKCS11H_PRIVATEMODE_MASK_DECRYPT (1<<2)
155 #define PKCS11H_PRIVATEMODE_MASK_UNWRAP (1<<3)
164 #define PKCS11H_SLOTEVENT_METHOD_AUTO 0
166 #define PKCS11H_SLOTEVENT_METHOD_TRIGGER 1
168 #define PKCS11H_SLOTEVENT_METHOD_POLL 2
170 #define PKCS11H_SLOTEVENT_METHOD_FETCH 3
179 #define PKCS11H_PROMPT_MASK_ALLOW_PIN_PROMPT (1<<0)
181 #define PKCS11H_PROMPT_MASK_ALLOW_TOKEN_PROMPT (1<<1)
183 #define PKCS11H_PROMPT_MASK_ALLOW_ALL ( \
184 PKCS11H_PROMPT_MASK_ALLOW_PIN_PROMPT | \
185 PKCS11H_PROMPT_MASK_ALLOW_TOKEN_PROMPT \
195 #define PKCS11H_ENUM_METHOD_CACHE 0
197 #define PKCS11H_ENUM_METHOD_CACHE_EXIST 1
199 #define PKCS11H_ENUM_METHOD_RELOAD 2
212 #define PKCS11H_PROVIDER_PROPERTY_LOCATION 0
218 #define PKCS11H_PROVIDER_PROPERTY_ALLOW_PROTECTED_AUTH 1
224 #define PKCS11H_PROVIDER_PROPERTY_MASK_PRIVATE_MODE 2
230 #define PKCS11H_PROVIDER_PROPERTY_SLOT_EVENT_METHOD 3
236 #define PKCS11H_PROVIDER_PROPERTY_SLOT_POLL_INTERVAL 4
242 #define PKCS11H_PROVIDER_PROPERTY_CERT_IS_PRIVATE 5
249 #define PKCS11H_PROVIDER_PROPERTY_INIT_ARGS 6
252 #define _PKCS11H_PROVIDER_PROPERTY_LAST 7
271 IN
void *
const global_data,
272 IN
const unsigned flags,
273 IN
const char *
const format,
282 IN
void *
const global_data
294 IN
void *
const global_data,
295 IN
void *
const user_data,
296 IN
const pkcs11h_token_id_t token,
297 IN
const unsigned retry
311 IN
void *
const global_data,
312 IN
void *
const user_data,
313 IN
const pkcs11h_token_id_t token,
314 IN
const unsigned retry,
315 OUT
char *
const pin,
316 IN
const size_t pin_max
328 char model[
sizeof (((CK_TOKEN_INFO *)NULL)->model)+1];
332 char label[
sizeof (((CK_TOKEN_INFO *)NULL)->label)+1];
382 IN
const unsigned flags
406 IN
const PKCS11H_BOOL safe
418 IN
void *
const global_data
435 IN
void *
const global_data
449 IN
void *
const global_data
463 IN
void *
const global_data
474 IN
const PKCS11H_BOOL allow_protected_auth
485 IN
const int pin_cache_period
496 IN
const unsigned max_retries
514 IN
const char *
const reference,
515 IN
const char *
const provider_location,
516 IN
const PKCS11H_BOOL allow_protected_auth,
517 IN
const unsigned mask_private_mode,
518 IN
const unsigned slot_event_method,
519 IN
const unsigned slot_poll_interval,
520 IN
const PKCS11H_BOOL cert_is_private
530 IN
const char *
const reference
541 IN
const char *
const reference,
542 IN
const char *
const property_str,
543 IN
const char *
const value_str
557 IN
const char *
const reference,
558 IN
const unsigned property,
559 IN
const void * value,
560 IN
const size_t value_size
572 IN
const char *
const reference
583 IN
const char *
const reference
CK_RV pkcs11h_registerProvider(IN const char *const reference)
Register a PKCS#11 provider.
CK_RV pkcs11h_logout(void)
Logout from all sessions.
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:310
CK_RV pkcs11h_setProviderPropertyByName(IN const char *const reference, IN const char *const property_str, IN const char *const value_str)
Set PKCS#11 provider property by name.
char serialNumber[sizeof(((CK_TOKEN_INFO *) NULL) ->serialNumber)+1]
Definition: pkcs11h-core.h:330
const char * pkcs11h_getMessage(IN const CK_RV rv)
Get message by return value.
unsigned pkcs11h_getLogLevel(void)
Get current log level.
char model[sizeof(((CK_TOKEN_INFO *) NULL) ->model)+1]
Definition: pkcs11h-core.h:328
char manufacturerID[sizeof(((CK_TOKEN_INFO *) NULL) ->manufacturerID)+1]
Definition: pkcs11h-core.h:326
CK_RV pkcs11h_plugAndPlay(void)
Handle slot rescan.
char display[1024]
Definition: pkcs11h-core.h:324
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)
Register, configure and initialize a PKCS#11 provider.
CK_RV pkcs11h_setMaxLoginRetries(IN const unsigned max_retries)
Set global login retries attempts.
Token identifier.
Definition: pkcs11h-core.h:322
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:270
CK_RV pkcs11h_forkFixup(void)
Handle special case of POSIX fork()
void(* pkcs11h_hook_slotevent_t)(IN void *const global_data)
Slotevent hook.
Definition: pkcs11h-core.h:281
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.
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()
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.
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:293
CK_RV pkcs11h_initializeProvider(IN const char *const reference)
Initialize a PKCS#11 provider.
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:261
CK_RV pkcs11h_setProviderProperty(IN const char *const reference, IN const unsigned property, IN const void *value, IN const size_t value_size)
Set PKCS#11 provider property.
pkcs11-helper core definitions.
char label[sizeof(((CK_TOKEN_INFO *) NULL) ->label)+1]
Definition: pkcs11h-core.h:332