pkcs11-helper
Macros
PKCS11H_ENUM_PROPERTY

Library properties. More...

Macros

#define PKCS11H_PROPERTY_FORK_MODE   1
 How does the foked process bahaves after POSIX fork() Value is PKCS11H_BOOL. Default is FALSE.
 
#define PKCS11H_PROPERTY_LOG_HOOK   2
 A log callback. Value is pkcs11h_hook_log_t.
 
#define PKCS11H_PROPERTY_LOG_HOOK_DATA   3
 A log callback data. Value is void *.
 
#define PKCS11H_PROPERTY_SLOT_EVENT_HOOK   4
 A slot event callback. Value is pkcs11h_hook_slotevent_t.
 
#define PKCS11H_PROPERTY_SLOT_EVENT_HOOK_DATA   5
 A slot event callback data. Value is void *.
 
#define PKCS11H_PROPERTY_TOKEN_PROMPT_HOOK   6
 A token prompt callback. Value type is pkcs11h_hook_token_prompt_t.
 
#define PKCS11H_PROPERTY_TOKEN_PROMPT_HOOK_DATA   7
 A token prompt callback data. Value is void *.
 
#define PKCS11H_PROPERTY_PIN_PROMPT_HOOK   8
 A pin prompt callback. Value type is pkcs11h_hook_pin_prompt_t.
 
#define PKCS11H_PROPERTY_PIN_PROMPT_HOOK_DATA   9
 A PIN prompt callback data. Value is void *.
 
#define PKCS11H_PROPERTY_ALLOW_PROTECTED_AUTHENTICATION   10
 Global protected authentication mode. Value is PKCS11H_BOOL. Default is TRUE.
 
#define PKCS11H_PROPERTY_PIN_CACHE_PERIOD   11
 Global PIN cache timeout in seconds. Value is int. Default is infinite.
 
#define PKCS11H_PROPERTY_MAX_LOGIN_RETRIES   12
 Global login retries attempts. Value is unsigned. Default is 3.
 
#define PKCS11H_PROPERTY_KEY_PROMPT_HOOK   13
 A key prompt callback. Value type is pkcs11h_hook_key_prompt_t.
 
#define PKCS11H_PROPERTY_KEY_PROMPT_HOOK_DATA   14
 A key prompt callback data. Value is void *.
 

Detailed Description

Library properties.

Macro Definition Documentation

◆ PKCS11H_PROPERTY_FORK_MODE

#define PKCS11H_PROPERTY_FORK_MODE   1

How does the foked process bahaves after POSIX fork() Value is PKCS11H_BOOL. Default is FALSE.

Attention
This function should be called after pkcs11h_initialize()
Note
This property is relevant if PKCS11H_FEATURE_MASK_THREADING is set. If safe mode is on, the child process can use the loaded PKCS#11 providers but it cannot use fork(), while it is in one of the hooks functions, since locked mutexes cannot be released.

◆ PKCS11H_PROPERTY_KEY_PROMPT_HOOK

#define PKCS11H_PROPERTY_KEY_PROMPT_HOOK   13

A key prompt callback. Value type is pkcs11h_hook_key_prompt_t.

Attention
If pkcs11h_setForkMode() is true, you cannot fork while in hook.

◆ PKCS11H_PROPERTY_PIN_PROMPT_HOOK

#define PKCS11H_PROPERTY_PIN_PROMPT_HOOK   8

A pin prompt callback. Value type is pkcs11h_hook_pin_prompt_t.

Attention
If pkcs11h_setForkMode() is true, you cannot fork while in hook.

◆ PKCS11H_PROPERTY_SLOT_EVENT_HOOK

#define PKCS11H_PROPERTY_SLOT_EVENT_HOOK   4

A slot event callback. Value is pkcs11h_hook_slotevent_t.

Attention
Calling this function initialize slot event notifications, these notifications can be started, but never terminate due to PKCS#11 limitation.
Note
In order to use slot events you must have threading PKCS11H_FEATURE_MASK_THREADING enabled.

◆ PKCS11H_PROPERTY_TOKEN_PROMPT_HOOK

#define PKCS11H_PROPERTY_TOKEN_PROMPT_HOOK   6

A token prompt callback. Value type is pkcs11h_hook_token_prompt_t.

Attention
If pkcs11h_setForkMode() is true, you cannot fork while in hook.

pkcs11-helper, Copyright (C) Alon Bar-Lev <alon.barlev@gmail.com>OpenSC-Project.org Logo