wolfSSL/wolfssl
1
0
Fork 1
mirror of https://github.com/wolfSSL/wolfssl.git synced 2025-07-31 19:24:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4700 from dgarske/pkcs11_id

Browse Source 
Improved the PKCS11 init to support slotId or tokenName
This commit is contained in:
Sean Parkinson
2022-01-11 14:25:37 +10:00
committed by GitHub
parent 5910ada93d 9a4981a5a8
commit c7b0b7003e
2 changed files with 99 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
wolfcrypt/src/wc_pkcs11.c
View File

@@ -495,36 +495,44 @@ void wc_Pkcs11_Finalize(Pkcs11Dev* dev)
} }
} }
/** /* lookup by token name and return slotId or (-1) if not found */
* Set up a token for use. static int Pkcs11Slot_FindByTokenName(Pkcs11Dev* dev,
* const char* tokenName, size_t tokenNameSz)
* @param [in] token Token object. {
* @param [in] dev PKCS#11 device object. CK_RV rv;
* @param [in] slotId Slot number of the token.<br> CK_ULONG slotCnt = 0;
* Passing -1 uses the first available slot. CK_TOKEN_INFO tinfo;
* @param [in] tokenName Name of token to initialize. int slotId = -1;
* @param [in] userPin PIN to use to login as user. rv = dev->func->C_GetSlotList(CK_TRUE, NULL, &slotCnt);
* @param [in] userPinSz Number of bytes in PIN. if (rv == CKR_OK) {
* @return BAD_FUNC_ARG when token, dev and/or tokenName is NULL. for (slotId = 0; slotId < (int)slotCnt; slotId++) {
* @return WC_INIT_E when initializing token fails. rv = dev->func->C_GetTokenInfo(slotId, &tinfo);
* @return WC_HW_E when another PKCS#11 library call fails. PKCS11_RV("C_GetTokenInfo", rv);
* @return -1 when no slot available. if (rv == CKR_OK &&
* 0 on success. XMEMCMP(tinfo.label, tokenName, tokenNameSz) == 0) {
*/ return slotId;
int wc_Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev, int slotId, }
const char* tokenName, const unsigned char* userPin, int userPinSz) }
}
return -1;
}
/* lookup by slotId or tokenName */
static int Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev, int slotId,
const char* tokenName, size_t tokenNameSz,
const unsigned char* userPin, size_t userPinSz)
{ {
int ret = 0; int ret = 0;
CK_RV rv; CK_RV rv;
CK_SLOT_ID* slot = NULL; CK_SLOT_ID* slot = NULL;
CK_ULONG slotCnt = 0; CK_ULONG slotCnt = 0;
if (token == NULL || dev == NULL || tokenName == NULL) if (token == NULL || dev == NULL) {
ret = BAD_FUNC_ARG; ret = BAD_FUNC_ARG;
}
if (ret == 0) { if (ret == 0) {
if (slotId < 0) { if (slotId < 0) {
/* Use first available slot with a token. */
rv = dev->func->C_GetSlotList(CK_TRUE, NULL, &slotCnt); rv = dev->func->C_GetSlotList(CK_TRUE, NULL, &slotCnt);
PKCS11_RV("C_GetSlotList", rv); PKCS11_RV("C_GetSlotList", rv);
if (rv != CKR_OK) { if (rv != CKR_OK) {
@@ -544,10 +552,24 @@ int wc_Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev, int slotId,
} }
} }
if (ret == 0) { if (ret == 0) {
if (slotCnt > 0) if (tokenName != NULL && tokenNameSz > 0) {
/* find based on token name */
slotId = Pkcs11Slot_FindByTokenName(dev,
tokenName, tokenNameSz);
}
else {
/* Use first available slot with a token. */
slotId = (int)slot[0]; slotId = (int)slot[0];
else }
ret = WC_HW_E; }
}
else {
/* verify slotId is valid */
CK_SLOT_INFO sinfo;
rv = dev->func->C_GetSlotInfo(slotId, &sinfo);
PKCS11_RV("C_GetSlotInfo", rv);
if (rv != CKR_OK) {
ret = WC_INIT_E;
} }
} }
} }
@@ -559,12 +581,61 @@ int wc_Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev, int slotId,
token->userPinSz = (CK_ULONG)userPinSz; token->userPinSz = (CK_ULONG)userPinSz;
} }
if (slot != NULL) if (slot != NULL) {
XFREE(slot, dev->heap, DYNAMIC_TYPE_TMP_BUFFER); XFREE(slot, dev->heap, DYNAMIC_TYPE_TMP_BUFFER);
}
return ret; return ret;
} }
/**
* Set up a token for use. Lookup by slotId or tokenName
*
* @param [in] token Token object.
* @param [in] dev PKCS#11 device object.
* @param [in] slotId Slot number of the token.<br>
* Passing -1 uses the first available slot.
* @param [in] tokenName Name of token to initialize (optional)
* @param [in] userPin PIN to use to login as user.
* @param [in] userPinSz Number of bytes in PIN.
* @return BAD_FUNC_ARG when token, dev and/or tokenName is NULL.
* @return WC_INIT_E when initializing token fails.
* @return WC_HW_E when another PKCS#11 library call fails.
* @return 0 on success.
*/
int wc_Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev, int slotId,
const char* tokenName, const unsigned char* userPin, int userPinSz)
{
size_t tokenNameSz = 0;
if (tokenName != NULL) {
tokenNameSz = XSTRLEN(tokenName);
}
return Pkcs11Token_Init(token, dev, slotId, tokenName, tokenNameSz,
userPin, (size_t)userPinSz);
}
/**
* Set up a token for use. Lookup by slotId or tokenName/size
*
* @param [in] token Token object.
* @param [in] dev PKCS#11 device object.
* @param [in] tokenName Name of token to initialize.
* @param [in] tokenNameSz Name size for token
* @param [in] userPin PIN to use to login as user.
* @param [in] userPinSz Number of bytes in PIN.
* @return BAD_FUNC_ARG when token, dev and/or tokenName is NULL.
* @return WC_INIT_E when initializing token fails.
* @return WC_HW_E when another PKCS#11 library call fails.
* @return 0 on success.
*/
int wc_Pkcs11Token_InitName(Pkcs11Token* token, Pkcs11Dev* dev,
const char* tokenName, int tokenNameSz,
const unsigned char* userPin, int userPinSz)
{
return Pkcs11Token_Init(token, dev, -1, tokenName, (size_t)tokenNameSz,
userPin, (size_t)userPinSz);
}
/** /**
* Finalize token. * Finalize token.
* Closes all sessions on token. * Closes all sessions on token.

4
wolfssl/wolfcrypt/wc_pkcs11.h
View File

@@ -76,6 +76,10 @@ WOLFSSL_API void wc_Pkcs11_Finalize(Pkcs11Dev* dev);
WOLFSSL_API int wc_Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev, WOLFSSL_API int wc_Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev,
int slotId, const char* tokenName, const unsigned char *userPin, int slotId, const char* tokenName, const unsigned char *userPin,
int userPinSz); int userPinSz);
WOLFSSL_API int wc_Pkcs11Token_InitName(Pkcs11Token* token, Pkcs11Dev* dev,
const char* tokenName, int tokenSz,
const unsigned char* userPin, int userPinSz);
WOLFSSL_API void wc_Pkcs11Token_Final(Pkcs11Token* token); WOLFSSL_API void wc_Pkcs11Token_Final(Pkcs11Token* token);
WOLFSSL_API int wc_Pkcs11Token_Open(Pkcs11Token* token, int readWrite); WOLFSSL_API int wc_Pkcs11Token_Open(Pkcs11Token* token, int readWrite);
WOLFSSL_API void wc_Pkcs11Token_Close(Pkcs11Token* token); WOLFSSL_API void wc_Pkcs11Token_Close(Pkcs11Token* token);