OpenDNSSEC-libhsm
1.4.5
|
#include <stdint.h>
Go to the source code of this file.
Data Structures | |
struct | hsm_config_t |
struct | hsm_module_t |
struct | hsm_session_t |
struct | hsm_key_t |
struct | hsm_key_info_t |
struct | hsm_ctx_t |
Macros | |
#define | HSM_MAX_SESSIONS 100 |
#define | HSM_MAX_ALGONAME 16 |
#define | HSM_ERROR_MSGSIZE 512 |
#define | HSM_MAX_SIGNATURE_LENGTH 512 |
#define | HSM_MAX_PIN_LENGTH 255 |
#define | HSM_OK 0 |
#define | HSM_ERROR 0x10000001 |
#define | HSM_PIN_INCORRECT 0x10000002 |
#define | HSM_CONFIG_FILE_ERROR 0x10000003 |
#define | HSM_REPOSITORY_NOT_FOUND 0x10000004 |
#define | HSM_NO_REPOSITORIES 0x10000005 |
#define | HSM_MODULE_NOT_FOUND 0x10000006 |
#define | HSM_PIN_FIRST 0 /* Used when getting the PIN for the first time. */ |
#define | HSM_PIN_RETRY 1 /* Used when we failed to login the first time. */ |
#define | HSM_PIN_SAVE |
Functions | |
int | hsm_open (const char *config, char *(pin_callback)(unsigned int, const char *, unsigned int)) |
char * | hsm_prompt_pin (unsigned int id, const char *repository, unsigned int mode) |
char * | hsm_check_pin (unsigned int id, const char *repository, unsigned int mode) |
int | hsm_logout_pin () |
int | hsm_close () |
hsm_ctx_t * | hsm_create_context (void) |
int | hsm_check_context (hsm_ctx_t *context) |
void | hsm_destroy_context (hsm_ctx_t *context) |
hsm_key_t ** | hsm_list_keys (hsm_ctx_t *context, size_t *count) |
hsm_key_t ** | hsm_list_keys_repository (hsm_ctx_t *context, size_t *count, const char *repository) |
size_t | hsm_count_keys (hsm_ctx_t *context) |
size_t | hsm_count_keys_repository (hsm_ctx_t *context, const char *repository) |
hsm_key_t * | hsm_find_key_by_id (hsm_ctx_t *context, const char *id) |
hsm_key_t * | hsm_generate_rsa_key (hsm_ctx_t *context, const char *repository, unsigned long keysize) |
hsm_key_t * | hsm_generate_dsa_key (hsm_ctx_t *context, const char *repository, unsigned long keysize) |
hsm_key_t * | hsm_generate_gost_key (hsm_ctx_t *context, const char *repository) |
int | hsm_remove_key (hsm_ctx_t *context, hsm_key_t *key) |
void | hsm_key_free (hsm_key_t *key) |
void | hsm_key_list_free (hsm_key_t **key_list, size_t count) |
char * | hsm_get_key_id (hsm_ctx_t *context, const hsm_key_t *key) |
hsm_key_info_t * | hsm_get_key_info (hsm_ctx_t *context, const hsm_key_t *key) |
void | hsm_key_info_free (hsm_key_info_t *key_info) |
int | hsm_random_buffer (hsm_ctx_t *ctx, unsigned char *buffer, unsigned long length) |
uint32_t | hsm_random32 (hsm_ctx_t *ctx) |
uint64_t | hsm_random64 (hsm_ctx_t *ctx) |
int | hsm_attach (const char *repository, const char *token_name, const char *path, const char *pin, const hsm_config_t *config) |
int | hsm_detach (const char *repository) |
int | hsm_token_attached (hsm_ctx_t *ctx, const char *repository) |
char * | hsm_get_error (hsm_ctx_t *gctx) |
void | hsm_print_session (hsm_session_t *session) |
void | hsm_print_ctx (hsm_ctx_t *gctx) |
void | hsm_print_key (hsm_key_t *key) |
void | hsm_print_error (hsm_ctx_t *ctx) |
void | hsm_print_tokeninfo (hsm_ctx_t *gctx) |
#define HSM_CONFIG_FILE_ERROR 0x10000003 |
Definition at line 64 of file libhsm.h.
Referenced by hsm_open().
#define HSM_ERROR 0x10000001 |
Definition at line 62 of file libhsm.h.
Referenced by hsm_check_context(), hsm_check_pin(), hsm_get_slot_id(), hsm_logout_pin(), hsm_open(), hsm_sem_open(), hsm_sem_post(), hsm_sem_wait(), and hsm_shm_open().
#define HSM_ERROR_MSGSIZE 512 |
Definition at line 45 of file libhsm.h.
Referenced by hsm_get_error().
#define HSM_MAX_ALGONAME 16 |
Definition at line 43 of file libhsm.h.
Referenced by cmd_list(), and hsm_get_key_info().
#define HSM_MAX_PIN_LENGTH 255 |
Definition at line 55 of file libhsm.h.
Referenced by hsm_check_pin(), hsm_prompt_pin(), hsm_shm_open(), and prompt_pass().
#define HSM_MAX_SESSIONS 100 |
Definition at line 41 of file libhsm.h.
Referenced by hsm_check_pin(), hsm_prompt_pin(), and hsm_shm_open().
#define HSM_NO_REPOSITORIES 0x10000005 |
Definition at line 66 of file libhsm.h.
Referenced by hsm_open().
#define HSM_OK 0 |
Return codes for some of the functions
These should be different than the list of CKR_ values defined by pkcs11 (for easier debugging purposes of calling applications)
Definition at line 61 of file libhsm.h.
Referenced by cmd_logout(), hsm_attach(), hsm_check_context(), hsm_get_slot_id(), hsm_logout_pin(), hsm_open(), and hsm_print_tokeninfo().
#define HSM_PIN_FIRST 0 /* Used when getting the PIN for the first time. */ |
The mode for the PIN callback functions
Definition at line 70 of file libhsm.h.
Referenced by hsm_check_pin(), hsm_open(), and hsm_prompt_pin().
#define HSM_PIN_INCORRECT 0x10000002 |
Definition at line 63 of file libhsm.h.
Referenced by hsm_open().
#define HSM_PIN_RETRY 1 /* Used when we failed to login the first time. */ |
Definition at line 71 of file libhsm.h.
Referenced by hsm_check_pin(), hsm_open(), and hsm_prompt_pin().
#define HSM_PIN_SAVE |
Definition at line 72 of file libhsm.h.
Referenced by hsm_check_pin(), hsm_open(), and hsm_prompt_pin().
#define HSM_REPOSITORY_NOT_FOUND 0x10000004 |
Definition at line 65 of file libhsm.h.
Referenced by hsm_token_attached().
int hsm_attach | ( | const char * | repository, |
const char * | token_name, | ||
const char * | path, | ||
const char * | pin, | ||
const hsm_config_t * | config | ||
) |
Attached a named HSM using a PKCS#11 shared library and optional credentials (may be NULL, but then undefined) This function changes the global state, and is not threadsafe
repository | the name of the repository |
token_label | the name of the token to attach |
path | the path of the shared PKCS#11 library |
pin | the PIN to log into the token |
config | optional configuration |
Definition at line 3073 of file libhsm.c.
References HSM_OK.
Referenced by hsm_open().
int hsm_check_context | ( | hsm_ctx_t * | context | ) |
Check HSM context
Check if the associated sessions are still alive. If they are not alive, then try re-open libhsm.
context | HSM context |
Definition at line 2146 of file libhsm.c.
References _hsm_ctx, CKF_RW_SESSION, CKF_SERIAL_SESSION, CKS_RW_USER_FUNCTIONS, hsm_ctx_set_error(), HSM_ERROR, HSM_OK, hsm_session_t::module, hsm_session_t::session, hsm_ctx_t::session, hsm_ctx_t::session_count, ck_session_info::state, and hsm_module_t::sym.
char* hsm_check_pin | ( | unsigned int | id, |
const char * | repository, | ||
unsigned int | mode | ||
) |
Function that will check if there is a PIN in the shared memory and returns it.
id | Used for identifying the repository. Will have a value between zero and HSM_MAX_SESSIONS. |
repository | The repository name will be included in the prompt |
mode | The type of mode the function should run in. |
Definition at line 325 of file pin.c.
References hsm_ctx_set_error(), HSM_ERROR, HSM_MAX_PIN_LENGTH, HSM_MAX_SESSIONS, HSM_PIN_FIRST, HSM_PIN_RETRY, HSM_PIN_SAVE, hsm_sem_open(), hsm_sem_post(), hsm_sem_wait(), and hsm_shm_open().
int hsm_close | ( | ) |
size_t hsm_count_keys | ( | hsm_ctx_t * | context | ) |
Count all known keys in all attached HSMs
context | HSM context |
Definition at line 2279 of file libhsm.c.
References _hsm_ctx, hsm_count_keys_session(), hsm_ctx_t::session, and hsm_ctx_t::session_count.
size_t hsm_count_keys_repository | ( | hsm_ctx_t * | context, |
const char * | repository | ||
) |
Count all known keys in a HSM
context | HSM context |
repository | repository in where to count the keys |
Definition at line 2292 of file libhsm.c.
References _hsm_ctx, and hsm_count_keys_session().
hsm_ctx_t* hsm_create_context | ( | void | ) |
Create new HSM context
Creates a new session for each attached HSM. The returned hsm_ctx_t * can be freed with hsm_destroy_context()
Definition at line 2140 of file libhsm.c.
Referenced by main().
void hsm_destroy_context | ( | hsm_ctx_t * | context | ) |
int hsm_detach | ( | const char * | repository | ) |
Detach a named HSM This function changes the global state, and is not threadsafe
token_name | the token to detach |
Detach a named HSM
Definition at line 3097 of file libhsm.c.
References hsm_session_t::module, hsm_module_t::name, hsm_ctx_t::session, and hsm_ctx_t::session_count.
Find a key pair by CKA_ID (as hex string)
The returned key structure can be freed with hsm_key_free()
context | HSM context |
id | CKA_ID of key to find (null-terminated string of hex characters) |
Definition at line 2308 of file libhsm.c.
Referenced by cmd_dnskey(), cmd_remove(), and main().
hsm_key_t* hsm_generate_dsa_key | ( | hsm_ctx_t * | context, |
const char * | repository, | ||
unsigned long | keysize | ||
) |
Generate new key pair in HSM
Keys generated by libhsm will have a 16-byte identifier set as CKA_ID and the hexadecimal representation of it set as CKA_LABEL.
The returned key structure can be freed with hsm_key_free()
context | HSM context |
repository | repository in where to create the key |
keysize | Size of DSA key |
Definition at line 2413 of file libhsm.c.
References _hsm_ctx, CK_FALSE, CK_TRUE, CKA_BASE, CKA_DECRYPT, CKA_ENCRYPT, CKA_EXTRACTABLE, CKA_ID, CKA_KEY_TYPE, CKA_LABEL, CKA_PRIME, CKA_PRIME_BITS, CKA_PRIVATE, CKA_SENSITIVE, CKA_SIGN, CKA_SUBPRIME, CKA_TOKEN, CKA_UNWRAP, CKA_VERIFY, CKA_WRAP, CKK_DSA, CKM_DSA_KEY_PAIR_GEN, CKM_DSA_PARAMETER_GEN, hsm_random_buffer(), hsm_session_t::module, hsm_key_t::module, NULL_PTR, hsm_key_t::private_key, hsm_key_t::public_key, hsm_session_t::session, and hsm_module_t::sym.
Referenced by hsm_test().
Generate new key pair in HSM
Keys generated by libhsm will have a 16-byte identifier set as CKA_ID and the hexadecimal representation of it set as CKA_LABEL.
The returned key structure can be freed with hsm_key_free()
context | HSM context |
repository | repository in where to create the key |
Definition at line 2527 of file libhsm.c.
References _hsm_ctx, CK_FALSE, CK_TRUE, CKA_DECRYPT, CKA_ENCRYPT, CKA_EXTRACTABLE, CKA_GOSTR3410PARAMS, CKA_GOSTR3411PARAMS, CKA_ID, CKA_KEY_TYPE, CKA_LABEL, CKA_PRIVATE, CKA_SENSITIVE, CKA_SIGN, CKA_TOKEN, CKA_UNWRAP, CKA_VERIFY, CKA_WRAP, CKK_GOSTR3410, CKM_GOSTR3410_KEY_PAIR_GEN, hsm_random_buffer(), hsm_session_t::module, hsm_key_t::module, NULL_PTR, hsm_key_t::private_key, hsm_key_t::public_key, hsm_session_t::session, and hsm_module_t::sym.
Referenced by hsm_test().
hsm_key_t* hsm_generate_rsa_key | ( | hsm_ctx_t * | context, |
const char * | repository, | ||
unsigned long | keysize | ||
) |
Generate new key pair in HSM
Keys generated by libhsm will have a 16-byte identifier set as CKA_ID and the hexadecimal representation of it set as CKA_LABEL. Other stuff, like exponent, may be needed here as well.
The returned key structure can be freed with hsm_key_free()
context | HSM context |
repository | repository in where to create the key |
keysize | Size of RSA key |
Definition at line 2324 of file libhsm.c.
References _hsm_ctx, CK_FALSE, CK_TRUE, CKA_DECRYPT, CKA_ENCRYPT, CKA_EXTRACTABLE, CKA_ID, CKA_KEY_TYPE, CKA_LABEL, CKA_MODULUS_BITS, CKA_PRIVATE, CKA_PUBLIC_EXPONENT, CKA_SENSITIVE, CKA_SIGN, CKA_TOKEN, CKA_UNWRAP, CKA_VERIFY, CKA_WRAP, CKK_RSA, CKM_RSA_PKCS_KEY_PAIR_GEN, hsm_module_t::config, hsm_random_buffer(), hsm_session_t::module, hsm_key_t::module, NULL_PTR, hsm_key_t::private_key, hsm_key_t::public_key, hsm_session_t::session, hsm_module_t::sym, and hsm_config_t::use_pubkey.
Referenced by cmd_generate(), hsm_test(), and main().
char* hsm_get_error | ( | hsm_ctx_t * | gctx | ) |
Return the current error message
The returned message is allocated data, and must be free()d by the caller
ctx | HSM context |
Definition at line 3162 of file libhsm.c.
References _hsm_ctx, hsm_ctx_t::error, hsm_ctx_t::error_action, hsm_ctx_t::error_message, and HSM_ERROR_MSGSIZE.
Referenced by hsm_print_error().
Get id as null-terminated hex string using key identifier
The returned id is allocated data, and must be free()d by the caller
context | HSM context |
key | Key pair to get the ID from |
Definition at line 2657 of file libhsm.c.
References _hsm_ctx, and hsm_key_t::private_key.
Referenced by hsm_get_key_info(), hsm_test(), and main().
hsm_key_info_t* hsm_get_key_info | ( | hsm_ctx_t * | context, |
const hsm_key_t * | key | ||
) |
Get extended key information
The returned id is allocated data, and must be freed by the caller With hsm_key_info_free()
context | HSM context |
key | Key pair to get information about |
Definition at line 2685 of file libhsm.c.
References _hsm_ctx, hsm_key_info_t::algorithm, hsm_key_info_t::algorithm_name, CKK_DSA, CKK_GOSTR3410, CKK_RSA, hsm_get_key_id(), HSM_MAX_ALGONAME, hsm_key_info_t::id, and hsm_key_info_t::keysize.
Referenced by cmd_generate(), cmd_list(), cmd_purge(), and hsm_print_key().
void hsm_key_free | ( | hsm_key_t * | key | ) |
Free the memory for a key structure.
key | The key structure to free |
Definition at line 2639 of file libhsm.c.
Referenced by cmd_dnskey(), cmd_generate(), cmd_remove(), hsm_key_list_free(), and main().
void hsm_key_info_free | ( | hsm_key_info_t * | key_info | ) |
Frees the hsm_key_info_t structure
key_info | The structure to free |
Definition at line 2732 of file libhsm.c.
References hsm_key_info_t::algorithm_name, and hsm_key_info_t::id.
Referenced by cmd_generate(), cmd_list(), cmd_purge(), and hsm_print_key().
void hsm_key_list_free | ( | hsm_key_t ** | key_list, |
size_t | count | ||
) |
Free the memory of an array of key structures, as returned by hsm_list_keys()
key_list | The array of keys to free |
count | The number of keys in the array |
Definition at line 2647 of file libhsm.c.
References hsm_key_free().
Referenced by cmd_list(), and cmd_purge().
List all known keys in all attached HSMs
After the function has run, the value at count contains the number of keys found.
The resulting key list can be freed with hsm_key_list_free() Alternatively, each individual key structure in the list could be freed with hsm_key_free()
context | HSM context |
count | location to store the number of keys found |
Definition at line 2231 of file libhsm.c.
References _hsm_ctx, hsm_list_keys_session(), hsm_ctx_t::session, and hsm_ctx_t::session_count.
Referenced by cmd_list(), and main().
hsm_key_t** hsm_list_keys_repository | ( | hsm_ctx_t * | context, |
size_t * | count, | ||
const char * | repository | ||
) |
List all known keys in a HSM
After the function has run, the value at count contains the number of keys found.
The resulting key list can be freed with hsm_key_list_free() Alternatively, each individual key structure in the list could be freed with hsm_key_free()
context | HSM context |
count | location to store the number of keys found |
repository | repository to list the keys in |
Definition at line 2261 of file libhsm.c.
References _hsm_ctx, and hsm_list_keys_session().
Referenced by cmd_list(), and cmd_purge().
int hsm_logout_pin | ( | ) |
Logout
Function that will logout the user by deleting the shared memory and semaphore. Any authenticated process will still be able to interact with the HSM.
Definition at line 413 of file pin.c.
References hsm_ctx_set_error(), HSM_ERROR, HSM_OK, SEM_KEY, and SHM_KEY.
Referenced by cmd_logout().
int hsm_open | ( | const char * | config, |
char * | pin_callback)(unsigned int, const char *, unsigned int | ||
) |
Open HSM library
config | path to OpenDNSSEC XML configuration file |
pin_callback | This function will be called for tokens that have no PIN configured. The default hsm_prompt_pin() can be used. If this value is NULL, these tokens will be skipped |
Attaches all configured HSMs, querying for PINs (using the given callback function) if not known. Also creates initial sessions (not part of any context; every API function that takes a context can be passed NULL, in which case the global context will be used) and log into each HSM.
Definition at line 1979 of file libhsm.c.
References hsm_attach(), HSM_CONFIG_FILE_ERROR, hsm_ctx_set_error(), HSM_ERROR, HSM_NO_REPOSITORIES, HSM_OK, HSM_PIN_FIRST, HSM_PIN_INCORRECT, HSM_PIN_RETRY, HSM_PIN_SAVE, hsm_ctx_t::session_count, and hsm_config_t::use_pubkey.
Referenced by main().
void hsm_print_ctx | ( | hsm_ctx_t * | gctx | ) |
Definition at line 3203 of file libhsm.c.
References _hsm_ctx, hsm_print_session(), hsm_ctx_t::session, and hsm_ctx_t::session_count.
Referenced by cmd_debug(), and main().
void hsm_print_error | ( | hsm_ctx_t * | ctx | ) |
Definition at line 3247 of file libhsm.c.
References hsm_get_error().
Referenced by cmd_generate(), cmd_list(), cmd_logout(), cmd_purge(), hsm_test(), and main().
void hsm_print_key | ( | hsm_key_t * | key | ) |
Definition at line 3220 of file libhsm.c.
References hsm_key_info_t::algorithm_name, hsm_module_t::config, hsm_get_key_info(), hsm_key_info_free(), hsm_key_info_t::id, hsm_key_info_t::keysize, hsm_key_t::module, hsm_module_t::name, hsm_key_t::private_key, hsm_key_t::public_key, and hsm_config_t::use_pubkey.
Referenced by cmd_generate(), and main().
void hsm_print_session | ( | hsm_session_t * | session | ) |
Definition at line 3193 of file libhsm.c.
References hsm_session_t::module, hsm_module_t::name, hsm_module_t::path, hsm_session_t::session, hsm_module_t::sym, and hsm_module_t::token_label.
Referenced by hsm_print_ctx().
void hsm_print_tokeninfo | ( | hsm_ctx_t * | gctx | ) |
Definition at line 3262 of file libhsm.c.
References _hsm_ctx, hsm_get_slot_id(), HSM_OK, ck_token_info::label, ck_token_info::model, hsm_session_t::module, hsm_module_t::name, hsm_module_t::path, hsm_ctx_t::session, hsm_ctx_t::session_count, slot_id, hsm_module_t::sym, and hsm_module_t::token_label.
Referenced by cmd_info().
char* hsm_prompt_pin | ( | unsigned int | id, |
const char * | repository, | ||
unsigned int | mode | ||
) |
Function that queries for a PIN, can be used as callback for hsm_open(). Stores the PIN in the shared memory.
id | Used for identifying the repository. Will have a value between zero and HSM_MAX_SESSIONS. |
repository | The repository name will be included in the prompt |
mode | The type of mode the function should run in. |
Definition at line 228 of file pin.c.
References HSM_MAX_PIN_LENGTH, HSM_MAX_SESSIONS, HSM_PIN_FIRST, HSM_PIN_RETRY, HSM_PIN_SAVE, hsm_sem_open(), hsm_sem_post(), hsm_sem_wait(), hsm_shm_open(), and prompt_pass().
Referenced by main().
uint32_t hsm_random32 | ( | hsm_ctx_t * | ctx | ) |
Return unsigned 32-bit random number from any attached HSM
context | HSM context |
Definition at line 3039 of file libhsm.c.
References hsm_random_buffer().
Referenced by main().
uint64_t hsm_random64 | ( | hsm_ctx_t * | ctx | ) |
Return unsigned 64-bit random number from any attached HSM
context | HSM context |
Definition at line 3054 of file libhsm.c.
References hsm_random_buffer().
Referenced by main().
int hsm_random_buffer | ( | hsm_ctx_t * | ctx, |
unsigned char * | buffer, | ||
unsigned long | length | ||
) |
Fill a buffer with random data from any attached HSM
context | HSM context |
buffer | Buffer to fill with random data |
length | Size of random buffer |
Definition at line 3011 of file libhsm.c.
References _hsm_ctx, CKR_OK, hsm_session_t::module, hsm_session_t::session, hsm_ctx_t::session, hsm_ctx_t::session_count, and hsm_module_t::sym.
Referenced by hsm_generate_dsa_key(), hsm_generate_gost_key(), hsm_generate_rsa_key(), hsm_random32(), and hsm_random64().
Remove a key pair from HSM
When a key is removed, the module pointer is set to NULL, and the public and private key handles are set to 0. The structure still needs to be freed.
context | HSM context |
key | Key pair to be removed |
Definition at line 2609 of file libhsm.c.
References _hsm_ctx, hsm_module_t::config, hsm_session_t::module, hsm_key_t::private_key, hsm_key_t::public_key, hsm_session_t::session, hsm_module_t::sym, and hsm_config_t::use_pubkey.
Referenced by cmd_purge(), cmd_remove(), hsm_test(), and main().
int hsm_token_attached | ( | hsm_ctx_t * | ctx, |
const char * | repository | ||
) |
Check whether a named token has been initialized in this context
ctx | HSM context |
token_name | The name of the token |
Definition at line 3121 of file libhsm.c.
References _hsm_ctx, hsm_ctx_set_error(), HSM_REPOSITORY_NOT_FOUND, hsm_session_t::module, hsm_module_t::name, hsm_ctx_t::session, and hsm_ctx_t::session_count.
Referenced by cmd_generate(), cmd_list(), cmd_purge(), and hsm_test().