Skip to content

pkcs11.h

Functions

Name
int wc_Pkcs11_Initialize(Pkcs11Dev * dev, const char * library, void * heap)
void wc_Pkcs11_Finalize(Pkcs11Dev * dev)
int wc_Pkcs11Token_Init(Pkcs11Token * token, Pkcs11Dev * dev, int slotId, const char * tokenName, const unsigned char * userPin, int userPinSz)
void wc_Pkcs11Token_Final(Pkcs11Token * token)
int wc_Pkcs11Token_Open(Pkcs11Token * token, int readWrite)
Opens a session on the token that all later operations use, until wc_Pkcs11Token_Close. Without it, wc_Pkcs11StoreKey and generating a key with an id or label on the token return BAD_STATE_E, and a key with neither is generated in software.
void wc_Pkcs11Token_Close(Pkcs11Token * token)
int wc_Pkcs11StoreKey(Pkcs11Token * token, int type, int clear, void * key)
Creates the key on the token as a session object in the session opened with wc_Pkcs11Token_Open, so it lasts until that session closes. An ECC key gets the usages its flags ask for: sign for WC_ECC_FLAG_DEC_SIGN and derive for WC_ECC_FLAG_DERIVE. With neither flag it gets derive, plus sign when the key has an id or label, or only sign when PKCS#11 ECDH is not compiled in, as far as the token supports them. When the key has its public part and the token has ECDSA, the public part is stored too.
int wc_Pkcs11_CryptoDevCb(int devId, wc_CryptoInfo * info, void * ctx)

Functions Documentation

function wc_Pkcs11_Initialize

int wc_Pkcs11_Initialize(
    Pkcs11Dev * dev,
    const char * library,
    void * heap
)

function wc_Pkcs11_Finalize

void wc_Pkcs11_Finalize(
    Pkcs11Dev * dev
)

function wc_Pkcs11Token_Init

int wc_Pkcs11Token_Init(
    Pkcs11Token * token,
    Pkcs11Dev * dev,
    int slotId,
    const char * tokenName,
    const unsigned char * userPin,
    int userPinSz
)

function wc_Pkcs11Token_Final

void wc_Pkcs11Token_Final(
    Pkcs11Token * token
)

function wc_Pkcs11Token_Open

int wc_Pkcs11Token_Open(
    Pkcs11Token * token,
    int readWrite
)

Opens a session on the token that all later operations use, until wc_Pkcs11Token_Close. Without it, wc_Pkcs11StoreKey and generating a key with an id or label on the token return BAD_STATE_E, and a key with neither is generated in software.

Parameters:

  • token Token to open the session on.
  • readWrite 1 for a read-write session, 0 for read-only.

See: wc_Pkcs11Token_Close

Return:

  • 0 on success.
  • BAD_FUNC_ARG when token is NULL.
  • WC_HW_E when opening the session fails.

function wc_Pkcs11Token_Close

void wc_Pkcs11Token_Close(
    Pkcs11Token * token
)

function wc_Pkcs11StoreKey

int wc_Pkcs11StoreKey(
    Pkcs11Token * token,
    int type,
    int clear,
    void * key
)

Creates the key on the token as a session object in the session opened with wc_Pkcs11Token_Open, so it lasts until that session closes. An ECC key gets the usages its flags ask for: sign for WC_ECC_FLAG_DEC_SIGN and derive for WC_ECC_FLAG_DERIVE. With neither flag it gets derive, plus sign when the key has an id or label, or only sign when PKCS#11 ECDH is not compiled in, as far as the token supports them. When the key has its public part and the token has ECDSA, the public part is stored too.

Parameters:

  • token Token to store the key on.
  • type Key type, one of enum Pkcs11KeyType.
  • clear 1 to zeroize the private data in the software key after storing it.
  • key Key object of that type.

See: wc_Pkcs11Token_Open

Return:

  • 0 on success.
  • BAD_FUNC_ARG when token is NULL.
  • BAD_STATE_E when no session was opened with wc_Pkcs11Token_Open.
  • MEMORY_E when memory allocation fails.
  • NOT_COMPILED_IN when the key type is not supported, or the token lacks the mechanism for it or for a usage the key's flags ask for.
  • WC_HW_E when a PKCS#11 call fails.

function wc_Pkcs11_CryptoDevCb

int wc_Pkcs11_CryptoDevCb(
    int devId,
    wc_CryptoInfo * info,
    void * ctx
)

Source code


int wc_Pkcs11_Initialize(Pkcs11Dev* dev, const char* library,
                                     void* heap);

void wc_Pkcs11_Finalize(Pkcs11Dev* dev);

int wc_Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev,
    int slotId, const char* tokenName, const unsigned char *userPin,
    int userPinSz);

void wc_Pkcs11Token_Final(Pkcs11Token* token);

int wc_Pkcs11Token_Open(Pkcs11Token* token, int readWrite);

void wc_Pkcs11Token_Close(Pkcs11Token* token);

int wc_Pkcs11StoreKey(Pkcs11Token* token, int type, int clear,
    void* key);

int wc_Pkcs11_CryptoDevCb(int devId, wc_CryptoInfo* info,
    void* ctx);

Updated on 2026-11-13 at 01:20:07 +0000