pkcs11-helper
|
Topics | |
PKCS11H_FEATURE_MASK | |
pkcs11-helper features mask. | |
PKCS11H_LOG | |
pkcs11-helper log level. | |
PKCS11H_PRIVATEMODE_MASK | |
Signature mask selection. . | |
PKCS11H_SLOTEVENT_METHOD | |
Slotevent mode selection. . | |
PKCS11H_PROMPT_MASK | |
Prompt mask selection. . | |
PKCS11H_ENUM_METHOD | |
Enumeration mode selection. . | |
PKCS11H_ENUM_PROPERTY | |
Library properties. . | |
PKCS11H_ENUM_PROVIDER_PROPERTY | |
Provider properties. . | |
Files | |
file | pkcs11h-core.h |
pkcs11-helper core. | |
Classes | |
struct | pkcs11h_token_id_s |
Token identifier. More... | |
Macros | |
#define | PKCS11H_PIN_CACHE_INFINITE -1 |
#define | PKCS11H_VERSION |
Library version. | |
Typedefs | |
typedef struct pkcs11h_token_id_s * | pkcs11h_token_id_t |
Token identifier. | |
typedef 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. | |
typedef void(* | pkcs11h_hook_slotevent_t) (IN void *const global_data) |
Slotevent hook. | |
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) |
Token prompt hook. | |
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) |
PIN prompt hook. | |
typedef PKCS11H_BOOL(* | pkcs11h_hook_key_prompt_t) (IN void *const global_data, IN void *const user_data, IN const pkcs11h_token_id_t token, IN const char *const label, IN const unsigned retry, OUT char *const pin, IN const size_t pin_max) |
Key prompt hook. | |
Functions | |
const char * | pkcs11h_getMessage (IN const CK_RV rv) |
Get message by return value. | |
unsigned int | pkcs11h_getVersion (void) |
Get version of library. | |
unsigned int | pkcs11h_getFeatures (void) |
Get features of library. | |
CK_RV | pkcs11h_initialize (void) |
Initialize helper interface. | |
CK_RV | pkcs11h_terminate (void) |
Terminate helper interface. | |
CK_RV | pkcs11h_getProperty (IN const unsigned property, OUT void *const value, IN OUT size_t *const value_size) |
Get library property. | |
CK_RV | pkcs11h_setProperty (IN const unsigned property, IN const void *const value, IN const size_t value_size) |
Set library property. | |
void | pkcs11h_setLogLevel (IN const unsigned flags) |
Set current log level of the helper. | |
unsigned | pkcs11h_getLogLevel (void) |
Get current log level. | |
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. | |
CK_RV | pkcs11h_setSlotEventHook (IN const pkcs11h_hook_slotevent_t hook, IN void *const global_data) |
Set a slot event callback. | |
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_setPINPromptHook (IN const pkcs11h_hook_pin_prompt_t hook, IN void *const global_data) |
Set a pin prompt callback. | |
CK_RV | pkcs11h_setProtectedAuthentication (IN const PKCS11H_BOOL allow_protected_auth) |
Set global protected authentication mode. | |
CK_RV | pkcs11h_setPINCachePeriod (IN const int pin_cache_period) |
Set global PIN cache timeout. | |
CK_RV | pkcs11h_setMaxLoginRetries (IN const unsigned max_retries) |
Set global login retries attempts. | |
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_registerProvider (IN const char *const reference) |
Register a PKCS#11 provider. | |
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. | |
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. | |
CK_RV | pkcs11h_initializeProvider (IN const char *const reference) |
Initialize a PKCS#11 provider. | |
CK_RV | pkcs11h_removeProvider (IN const char *const reference) |
Delete a PKCS#11 provider. | |
CK_RV | pkcs11h_forkFixup (void) |
Handle special case of POSIX fork() | |
CK_RV | pkcs11h_plugAndPlay (void) |
Handle slot rescan. | |
CK_RV | pkcs11h_logout (void) |
Logout from all sessions. | |
Core functionality.
Core functionality.
#define PKCS11H_PIN_CACHE_INFINITE -1 |
Infinite session limit
typedef PKCS11H_BOOL(* pkcs11h_hook_key_prompt_t) (IN void *const global_data, IN void *const user_data, IN const pkcs11h_token_id_t token, IN const char *const label, IN const unsigned retry, OUT char *const pin, IN const size_t pin_max) |
Key prompt hook.
global_data | Hook data. |
user_data | Local data. |
token | Token. |
label | Key label |
retry | Retry counter. |
pin | PIN buffer. |
pin_max | PIN buffer size. |
typedef 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.
global_data | Hook data. |
flags | Log flags. |
format | printf style format. |
args | stdargs |
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) |
PIN prompt hook.
global_data | Hook data. |
user_data | Local data. |
token | Token. |
retry | Retry counter. |
pin | PIN buffer. |
pin_max | PIN buffer size. |
typedef void(* pkcs11h_hook_slotevent_t) (IN void *const global_data) |
Slotevent hook.
global_data | Hook 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) |
Token prompt hook.
global_data | Hook data. |
user_data | Local data. |
token | Token. |
retry | Retry counter. |
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.
reference | Reference name for this provider. |
provider_location | Provider library location. |
allow_protected_auth | Allow this provider to use protected authentication. |
mask_private_mode | Provider private mode PKCS11H_PRIVATEMODE_MASK override. |
slot_event_method | Provider slot event PKCS11H_SLOTEVENT_METHOD method. |
slot_poll_interval | Slot event poll interval (If in polling mode), specify 0 for default. |
cert_is_private | Provider's certificate access should be done after login. |
CK_RV pkcs11h_forkFixup | ( | void | ) |
Handle special case of POSIX fork()
unsigned int pkcs11h_getFeatures | ( | void | ) |
unsigned pkcs11h_getLogLevel | ( | void | ) |
Get current log level.
const char * pkcs11h_getMessage | ( | IN const CK_RV | rv | ) |
Get message by return value.
rv | Return value. |
CK_RV pkcs11h_getProperty | ( | IN const unsigned | property, |
OUT void *const | value, | ||
IN OUT size_t *const | value_size ) |
Get library property.
property | Property kind. |
value | Property value. |
value_size | size of dereferenced property value. |
unsigned int pkcs11h_getVersion | ( | void | ) |
CK_RV pkcs11h_initialize | ( | void | ) |
Initialize helper interface.
CK_RV pkcs11h_initializeProvider | ( | IN const char *const | reference | ) |
Initialize a PKCS#11 provider.
reference | Reference name for this provider. |
CK_RV pkcs11h_logout | ( | void | ) |
Logout from all sessions.
CK_RV pkcs11h_plugAndPlay | ( | void | ) |
Handle slot rescan.
CK_RV pkcs11h_registerProvider | ( | IN const char *const | reference | ) |
Register a PKCS#11 provider.
reference | Reference name for this provider. |
CK_RV pkcs11h_removeProvider | ( | IN const char *const | reference | ) |
Delete a PKCS#11 provider.
reference | Reference name for this provider. |
CK_RV pkcs11h_setForkMode | ( | IN const PKCS11H_BOOL | safe | ) |
How does the foked process bahaves after POSIX fork()
safe | Safe mode, default is false. |
CK_RV pkcs11h_setLogHook | ( | IN const pkcs11h_hook_log_t | hook, |
IN void *const | global_data ) |
Set a log callback.
hook | Callback. |
global_data | Data to send to callback. |
void pkcs11h_setLogLevel | ( | IN const unsigned | flags | ) |
Set current log level of the helper.
flags | Current log level PKCS11H_LOG. |
CK_RV pkcs11h_setMaxLoginRetries | ( | IN const unsigned | max_retries | ) |
Set global login retries attempts.
max_retries | Login retries handled by the helper. |
CK_RV pkcs11h_setPINCachePeriod | ( | IN const int | pin_cache_period | ) |
Set global PIN cache timeout.
pin_cache_period | Cache period in seconds, or PKCS11H_PIN_CACHE_INFINITE. |
CK_RV pkcs11h_setPINPromptHook | ( | IN const pkcs11h_hook_pin_prompt_t | hook, |
IN void *const | global_data ) |
Set a pin prompt callback.
hook | Callback. |
global_data | Data to send to callback. |
CK_RV pkcs11h_setProperty | ( | IN const unsigned | property, |
IN const void *const | value, | ||
IN const size_t | value_size ) |
Set library property.
property | Property kind. |
value | Property value. |
value_size | size of dereferenced property value. |
CK_RV pkcs11h_setProtectedAuthentication | ( | IN const PKCS11H_BOOL | allow_protected_auth | ) |
Set global protected authentication mode.
allow_protected_auth | Allow protected authentication if enabled by token. |
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.
reference | Reference name for this provider. |
property | Property kind. |
value | Property value. |
value_size | size of dereferenced property value. |
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.
reference | Reference name for this provider. |
property_str | Property kind. |
value_str | Property value. |
CK_RV pkcs11h_setSlotEventHook | ( | IN const pkcs11h_hook_slotevent_t | hook, |
IN void *const | global_data ) |
Set a slot event callback.
hook | Callback. |
global_data | Data to send to callback. |
CK_RV pkcs11h_setTokenPromptHook | ( | IN const pkcs11h_hook_token_prompt_t | hook, |
IN void *const | global_data ) |
Set a token prompt callback.
hook | Callback. |
global_data | Data to send to callback. |
CK_RV pkcs11h_terminate | ( | void | ) |
Terminate helper interface.
pkcs11-helper, Copyright (C) Alon Bar-Lev <alon.barlev@gmail.com> | ![]() |