GNUTLS_PKCS11_MAX_PIN_LEN

#define GNUTLS_PKCS11_MAX_PIN_LEN 32

gnutls_pkcs11_token_callback_t ()

int                 (*gnutls_pkcs11_token_callback_t)   (void *const global_data,
                                                         const char *const label,
                                                         const unsigned retry Param3);

enum gnutls_pkcs11_pin_flag_t

typedef enum {
    GNUTLS_PKCS11_PIN_USER = (1 << 0),
    GNUTLS_PKCS11_PIN_SO = (1 << 1),
    GNUTLS_PKCS11_PIN_FINAL_TRY = (1 << 2),
    GNUTLS_PKCS11_PIN_COUNT_LOW = (1 << 3),
    GNUTLS_PKCS11_PIN_CONTEXT_SPECIFIC = (1 << 4),
    GNUTLS_PKCS11_PIN_WRONG = (1 << 5),
} gnutls_pkcs11_pin_flag_t;

Enumeration of different PIN flags.

gnutls_pkcs11_pin_callback_t ()

int                 (*gnutls_pkcs11_pin_callback_t)     (void *userdata,
                                                         int attempt,
                                                         const char *token_url,
                                                         const char *token_label,
                                                         unsigned int flags);

Callback function type for PKCS11 PIN entry. It is set by gnutls_pkcs11_set_pin_function().

The callback should provides the PIN code to unlock the token with label token_label, specified by the URL token_url.

The PIN code, as a NUL-terminated ASCII string, should be copied into the pin buffer (of maximum size pin_max), and return 0 to indicate success. Alternatively, the callback may return a negative gnutls error code to indicate failure and cancel PIN entry (in which case, the contents of the pin parameter are ignored).

When a PIN is required, the callback will be invoked repeatedly (and indefinitely) until either the returned PIN code is correct, the callback returns failure, or the token refuses login (e.g. when the token is locked due to too many incorrect PINs!). For the first such invocation, the attempt counter will have value zero; it will increase by one for each subsequent attempt.

Since 2.12.0

struct gnutls_pkcs11_obj_st

struct gnutls_pkcs11_obj_st;

gnutls_pkcs11_obj_t

typedef struct gnutls_pkcs11_obj_st *gnutls_pkcs11_obj_t;

GNUTLS_PKCS11_FLAG_MANUAL

#define GNUTLS_PKCS11_FLAG_MANUAL 0     /* Manual loading of libraries */

GNUTLS_PKCS11_FLAG_AUTO

#define GNUTLS_PKCS11_FLAG_AUTO 1       /* Automatically load libraries by reading /etc/gnutls/pkcs11.conf */

gnutls_pkcs11_init ()

int                 gnutls_pkcs11_init                  (unsigned int flags,
                                                         const char *deprecated_config_file);

This function will initialize the PKCS 11 subsystem in gnutls. It will read configuration files if GNUTLS_PKCS11_FLAG_AUTO is used or allow you to independently load PKCS 11 modules using gnutls_pkcs11_add_provider() if GNUTLS_PKCS11_FLAG_MANUAL is specified.

Using a custom configfile is deprecated and will not be supported in future versions of gnutls.

Normally you don't need to call this function since it is being called by gnutls_global_init() using the GNUTLS_PKCS11_FLAG_AUTO. If you need to call this function, you must call it before gnutls_global_init().

gnutls_pkcs11_deinit ()

void                gnutls_pkcs11_deinit                (void);

This function will deinitialize the PKCS 11 subsystem in gnutls.

gnutls_pkcs11_set_token_function ()

void                gnutls_pkcs11_set_token_function    (gnutls_pkcs11_token_callback_t fn,
                                                         void *userdata);

This function will set a callback function to be used when a token needs to be inserted to continue PKCS 11 operations.

gnutls_pkcs11_set_pin_function ()

void                gnutls_pkcs11_set_pin_function      (gnutls_pkcs11_pin_callback_t fn,
                                                         void *userdata);

This function will set a callback function to be used when a PIN is required for PKCS 11 operations.

Callback for PKCS11 PIN entry. The callback provides the PIN code to unlock the token with label 'token_label', specified by the URL 'token_url'.

The PIN code, as a NUL-terminated ASCII string, should be copied into the 'pin' buffer (of maximum size pin_max), and return 0 to indicate success. Alternatively, the callback may return a negative gnutls error code to indicate failure and cancel PIN entry (in which case, the contents of the 'pin' parameter are ignored).

When a PIN is required, the callback will be invoked repeatedly (and indefinitely) until either the returned PIN code is correct, the callback returns failure, or the token refuses login (e.g. when the token is locked due to too many incorrect PINs!). For the first such invocation, the 'attempt' counter will have value zero; it will increase by one for each subsequent attempt.

gnutls_pkcs11_add_provider ()

int                 gnutls_pkcs11_add_provider          (const char *name,
                                                         const char *params);

This function will load and add a PKCS 11 module to the module list used in gnutls. After this function is called the module will be used for PKCS 11 operations.

gnutls_pkcs11_obj_init ()

int                 gnutls_pkcs11_obj_init              (gnutls_pkcs11_obj_t *obj);

This function will initialize a pkcs11 certificate structure.

GNUTLS_PKCS11_OBJ_FLAG_LOGIN

#define GNUTLS_PKCS11_OBJ_FLAG_LOGIN (1<<0)     /* force login in the token for the operation */

GNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED

#define GNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED (1<<1)      /* object marked as trusted */

GNUTLS_PKCS11_OBJ_FLAG_MARK_SENSITIVE

#define GNUTLS_PKCS11_OBJ_FLAG_MARK_SENSITIVE (1<<2)    /* object marked as sensitive (unexportable) */

enum gnutls_pkcs11_url_type_t

typedef enum {
  GNUTLS_PKCS11_URL_GENERIC,    /* URL specifies the object on token level */
  GNUTLS_PKCS11_URL_LIB,        /* URL specifies the object on module level */
  GNUTLS_PKCS11_URL_LIB_VERSION /* URL specifies the object on module and version level */
} gnutls_pkcs11_url_type_t;

Enumeration of different URL extraction flags.

gnutls_pkcs11_obj_import_url ()

int                 gnutls_pkcs11_obj_import_url        (gnutls_pkcs11_obj_t Param1,
                                                         const char *url,
                                                         unsigned int flags);

gnutls_pkcs11_obj_export_url ()

int                 gnutls_pkcs11_obj_export_url        (gnutls_pkcs11_obj_t obj,
                                                         gnutls_pkcs11_url_type_t detailed,
                                                         char **url);

This function will export a URL identifying the given certificate.

gnutls_pkcs11_obj_deinit ()

void                gnutls_pkcs11_obj_deinit            (gnutls_pkcs11_obj_t obj);

This function will deinitialize a certificate structure.

gnutls_pkcs11_obj_export ()

int                 gnutls_pkcs11_obj_export            (gnutls_pkcs11_obj_t obj,
                                                         void *output_data,
                                                         size_t *output_data_size);

This function will export the pkcs11 object data. It is normal for PKCS 11 data to be inaccesible and in that case GNUTLS_E_INVALID_REQUEST will be returned.

If the buffer provided is not long enough to hold the output, then *output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.

If the structure is PEM encoded, it will have a header of "BEGIN CERTIFICATE".

gnutls_pkcs11_copy_x509_crt ()

int                 gnutls_pkcs11_copy_x509_crt         (const char *token_url,
                                                         gnutls_x509_crt_t crt,
                                                         const char *label,
                                                         unsigned int flags);

This function will copy a certificate into a PKCS 11 token specified by a URL. The certificate can be marked as trusted or not.

gnutls_pkcs11_copy_x509_privkey ()

int                 gnutls_pkcs11_copy_x509_privkey     (const char *token_url,
                                                         gnutls_x509_privkey_t key,
                                                         const char *label,
                                                         unsigned int key_usage,
                                                         unsigned int flags);

This function will copy a private key into a PKCS 11 token specified by a URL. It is highly recommended flags to contain GNUTLS_PKCS11_OBJ_FLAG_MARK_SENSITIVE unless there is a strong reason not to.

gnutls_pkcs11_delete_url ()

int                 gnutls_pkcs11_delete_url            (const char *object_url,
                                                         unsigned int flags);

This function will delete objects matching the given URL.

gnutls_pkcs11_copy_secret_key ()

int                 gnutls_pkcs11_copy_secret_key       (const char *token_url,
                                                         gnutls_datum_t *key,
                                                         const char *label,
                                                         unsigned int key_usage,
                                                         unsigned int flags);

This function will copy a raw secret (symmetric) key into a PKCS 11 token specified by a URL. The key can be marked as sensitive or not.

enum gnutls_pkcs11_obj_info_t

typedef enum {
  GNUTLS_PKCS11_OBJ_ID_HEX = 1,
  GNUTLS_PKCS11_OBJ_LABEL,
  GNUTLS_PKCS11_OBJ_TOKEN_LABEL,
  GNUTLS_PKCS11_OBJ_TOKEN_SERIAL,
  GNUTLS_PKCS11_OBJ_TOKEN_MANUFACTURER,
  GNUTLS_PKCS11_OBJ_TOKEN_MODEL,
  GNUTLS_PKCS11_OBJ_ID,
  /* the pkcs11 provider library info  */
  GNUTLS_PKCS11_OBJ_LIBRARY_VERSION,
  GNUTLS_PKCS11_OBJ_LIBRARY_DESCRIPTION,
  GNUTLS_PKCS11_OBJ_LIBRARY_MANUFACTURER
} gnutls_pkcs11_obj_info_t;

Enumeration of several object information types.

gnutls_pkcs11_obj_get_info ()

int                 gnutls_pkcs11_obj_get_info          (gnutls_pkcs11_obj_t crt,
                                                         gnutls_pkcs11_obj_info_t itype,
                                                         void *output,
                                                         size_t *output_size);

This function will return information about the PKCS 11 certificatesuch as the label, id as well as token information where the key is stored. When output is text it returns null terminated string although output_size contains the size of the actual data only.

enum gnutls_pkcs11_obj_attr_t

typedef enum {
  GNUTLS_PKCS11_OBJ_ATTR_CRT_ALL = 1,   /* all certificates */
  GNUTLS_PKCS11_OBJ_ATTR_CRT_TRUSTED,   /* certificates marked as trusted */
  GNUTLS_PKCS11_OBJ_ATTR_CRT_WITH_PRIVKEY,      /* certificates with corresponding private key */
  GNUTLS_PKCS11_OBJ_ATTR_PUBKEY,        /* public keys */
  GNUTLS_PKCS11_OBJ_ATTR_PRIVKEY,       /* private keys */
  GNUTLS_PKCS11_OBJ_ATTR_ALL    /* everything! */
} gnutls_pkcs11_obj_attr_t;

Enumeration of several attributes for object enumeration.

enum gnutls_pkcs11_token_info_t

typedef enum {
  GNUTLS_PKCS11_TOKEN_LABEL,
  GNUTLS_PKCS11_TOKEN_SERIAL,
  GNUTLS_PKCS11_TOKEN_MANUFACTURER,
  GNUTLS_PKCS11_TOKEN_MODEL
} gnutls_pkcs11_token_info_t;

Enumeration of types for retrieving token information.

enum gnutls_pkcs11_obj_type_t

typedef enum {
  GNUTLS_PKCS11_OBJ_UNKNOWN,
  GNUTLS_PKCS11_OBJ_X509_CRT,
  GNUTLS_PKCS11_OBJ_PUBKEY,
  GNUTLS_PKCS11_OBJ_PRIVKEY,
  GNUTLS_PKCS11_OBJ_SECRET_KEY,
  GNUTLS_PKCS11_OBJ_DATA
} gnutls_pkcs11_obj_type_t;

Enumeration of object types.

gnutls_pkcs11_token_init ()

int                 gnutls_pkcs11_token_init            (const char *token_url,
                                                         const char *so_pin,
                                                         const char *label);

This function will initialize (format) a token. If the token is at a factory defaults state the security officer's PIN given will be set to be the default. Otherwise it should match the officer's PIN.

gnutls_pkcs11_token_get_mechanism ()

int                 gnutls_pkcs11_token_get_mechanism   (const char *url,
                                                         int idx,
                                                         unsigned long *mechanism);

This function will return the names of the supported mechanisms by the token. It should be called with an increasing index until it return GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE.

gnutls_pkcs11_token_set_pin ()

int                 gnutls_pkcs11_token_set_pin         (const char *token_url,
                                                         const char *oldpin,
                                                         const char *newpin,
                                                         unsigned int flags);

This function will modify or set a user's PIN for the given token. If it is called to set a user pin for first time the oldpin must be NULL.

gnutls_pkcs11_token_get_url ()

int                 gnutls_pkcs11_token_get_url         (unsigned int seq,
                                                         gnutls_pkcs11_url_type_t detailed,
                                                         char **url);

This function will return the URL for each token available in system. The url has to be released using gnutls_free()

gnutls_pkcs11_token_get_info ()

int                 gnutls_pkcs11_token_get_info        (const char *url,
                                                         gnutls_pkcs11_token_info_t ttype,
                                                         void *output,
                                                         size_t *output_size);

This function will return information about the PKCS 11 token such as the label, id as well as token information where the key is stored.

GNUTLS_PKCS11_TOKEN_HW

#define GNUTLS_PKCS11_TOKEN_HW 1

gnutls_pkcs11_token_get_flags ()

int                 gnutls_pkcs11_token_get_flags       (const char *url,
                                                         unsigned int *flags);

This function will return information about the PKCS 11 token flags.

gnutls_pkcs11_obj_list_import_url ()

int                 gnutls_pkcs11_obj_list_import_url   (gnutls_pkcs11_obj_t *p_list,
                                                         unsigned int *const n_list,
                                                         const char *url,
                                                         gnutls_pkcs11_obj_attr_t attrs,
                                                         unsigned int flags);

This function will initialize and set values to an object list by using all objects identified by a PKCS 11 URL.

gnutls_x509_crt_import_pkcs11 ()

int                 gnutls_x509_crt_import_pkcs11       (gnutls_x509_crt_t crt,
                                                         gnutls_pkcs11_obj_t pkcs11_crt);

This function will import a PKCS 11 certificate to a gnutls_x509_crt_t structure.

gnutls_x509_crt_import_pkcs11_url ()

int                 gnutls_x509_crt_import_pkcs11_url   (gnutls_x509_crt_t crt,
                                                         const char *url,
                                                         unsigned int flags);

This function will import a PKCS 11 certificate directly from a token without involving the gnutls_pkcs11_obj_t structure. This function will fail if the certificate stored is not of X.509 type.

gnutls_pkcs11_obj_get_type ()

gnutls_pkcs11_obj_type_t gnutls_pkcs11_obj_get_type     (gnutls_pkcs11_obj_t certificate);

This function will return the type of the certificate being stored in the structure.

gnutls_pkcs11_type_get_name ()

const char *        gnutls_pkcs11_type_get_name         (gnutls_pkcs11_obj_type_t Param1);

gnutls_x509_crt_list_import_pkcs11 ()

int                 gnutls_x509_crt_list_import_pkcs11  (gnutls_x509_crt_t *certs,
                                                         unsigned int cert_max,
                                                         gnutls_pkcs11_obj_t * const objs,
                                                         unsigned int flags);

This function will import a PKCS 11 certificate list to a list of gnutls_x509_crt_t structure. These must not be initialized.

gnutls_pkcs11_privkey_init ()

int                 gnutls_pkcs11_privkey_init          (gnutls_pkcs11_privkey_t *key);

This function will initialize an private key structure.

gnutls_pkcs11_privkey_deinit ()

void                gnutls_pkcs11_privkey_deinit        (gnutls_pkcs11_privkey_t key);

This function will deinitialize a private key structure.

gnutls_pkcs11_privkey_get_pk_algorithm ()

int                 gnutls_pkcs11_privkey_get_pk_algorithm
                                                        (gnutls_pkcs11_privkey_t key,
                                                         unsigned int *bits);

This function will return the public key algorithm of a private key.

gnutls_pkcs11_privkey_get_info ()

int                 gnutls_pkcs11_privkey_get_info      (gnutls_pkcs11_privkey_t pkey,
                                                         gnutls_pkcs11_obj_info_t itype,
                                                         void *output,
                                                         size_t *output_size);

This function will return information about the PKCS 11 private key such as the label, id as well as token information where the key is stored. When output is text it returns null terminated string although output_size contains the size of the actual data only.

gnutls_pkcs11_privkey_import_url ()

int                 gnutls_pkcs11_privkey_import_url    (gnutls_pkcs11_privkey_t pkey,
                                                         const char *url,
                                                         unsigned int flags);

This function will "import" a PKCS 11 URL identifying a certificate key to the gnutls_pkcs11_obj_t structure. This does not involve any parsing (such as X.509 or OpenPGP) since the gnutls_pkcs11_obj_t is format agnostic. Only data are transferred.

gnutls_pkcs11_privkey_export_url ()

int                 gnutls_pkcs11_privkey_export_url    (gnutls_pkcs11_privkey_t key,
                                                         gnutls_pkcs11_url_type_t detailed,
                                                         char **url);

This function will export a URL identifying the given key.