/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ /* Thse functions are stub functions which will get replaced with calls through * PKCS #11. */ #include "pk11func.h" #include "secmod.h" #include "secmodi.h" #include "secmodti.h" #include "pkcs11t.h" #include "pk11pqg.h" #include "secerr.h" /* Generate PQGParams and PQGVerify structs. * Length of P specified by L. * if L is greater than 1024 then the resulting verify parameters will be * DSA2. * Length of Q specified by N. If zero, The PKCS #11 module will * pick an appropriately sized Q for P. If N is specified and L = 1024, then * the resulting verify parameters will be DSA2, Otherwise DSA1 parameters * will be returned. * Length of SEED in bytes specified in seedBytes. * * The underlying PKCS #11 module will check the values for L, N, * and seedBytes. The rules for softoken are: * * If L <= 1024, then L must be between 512 and 1024 in increments of 64 bits. * If L <= 1024, then N must be 0 or 160. * If L >= 1024, then L and N must match the following table: * L=1024 N=0 or 160 * L=2048 N=0 or 224 * L=2048 N=256 * L=3072 N=0 or 256 * if L <= 1024 * seedBbytes must be in the range [20..256]. * if L >= 1024 * seedBbytes must be in the range [20..L/16]. */ extern SECStatus PK11_PQG_ParamGenV2(unsigned int L, unsigned int N, unsigned int seedBytes, PQGParams **pParams, PQGVerify **pVfy) { PK11SlotInfo *slot = NULL; CK_ATTRIBUTE genTemplate[5]; CK_ATTRIBUTE *attrs = genTemplate; int count = sizeof(genTemplate)/sizeof(genTemplate[0]); CK_MECHANISM mechanism; CK_OBJECT_HANDLE objectID = CK_INVALID_HANDLE; CK_RV crv; CK_ATTRIBUTE pTemplate[] = { { CKA_PRIME, NULL, 0 }, { CKA_SUBPRIME, NULL, 0 }, { CKA_BASE, NULL, 0 }, }; CK_ATTRIBUTE vTemplate[] = { { CKA_NETSCAPE_PQG_COUNTER, NULL, 0 }, { CKA_NETSCAPE_PQG_SEED, NULL, 0 }, { CKA_NETSCAPE_PQG_H, NULL, 0 }, }; CK_ULONG primeBits = L; CK_ULONG subPrimeBits = N; int pTemplateCount = sizeof(pTemplate)/sizeof(pTemplate[0]); int vTemplateCount = sizeof(vTemplate)/sizeof(vTemplate[0]); PLArenaPool *parena = NULL; PLArenaPool *varena = NULL; PQGParams *params = NULL; PQGVerify *verify = NULL; CK_ULONG seedBits = seedBytes*8; *pParams = NULL; *pVfy = NULL; if (primeBits == (CK_ULONG)-1) { PORT_SetError(SEC_ERROR_INVALID_ARGS); goto loser; } PK11_SETATTRS(attrs, CKA_PRIME_BITS,&primeBits,sizeof(primeBits)); attrs++; if (subPrimeBits != 0) { PK11_SETATTRS(attrs, CKA_SUB_PRIME_BITS, &subPrimeBits, sizeof(subPrimeBits)); attrs++; } if (seedBits != 0) { PK11_SETATTRS(attrs, CKA_NETSCAPE_PQG_SEED_BITS, &seedBits, sizeof(seedBits)); attrs++; } count = attrs - genTemplate; PR_ASSERT(count <= sizeof(genTemplate)/sizeof(CK_ATTRIBUTE)); slot = PK11_GetInternalSlot(); if (slot == NULL) { /* set error */ PORT_SetError(SEC_ERROR_LIBRARY_FAILURE);/* shouldn't happen */ goto loser; } /* make sure the internal slot can handle DSA2 type parameters. */ if (primeBits > 1024) { CK_MECHANISM_INFO mechanism_info; if (!slot->isThreadSafe) PK11_EnterSlotMonitor(slot); crv = PK11_GETTAB(slot)->C_GetMechanismInfo(slot->slotID, CKM_DSA_PARAMETER_GEN, &mechanism_info); if (!slot->isThreadSafe) PK11_ExitSlotMonitor(slot); /* a bug in the old softoken left CKM_DSA_PARAMETER_GEN off of the * mechanism List. If we get a failure asking for this value, we know * it can't handle DSA2 */ if ((crv != CKR_OK) || (mechanism_info.ulMaxKeySize < primeBits)) { PK11_FreeSlot(slot); slot = PK11_GetBestSlotWithAttributes(CKM_DSA_PARAMETER_GEN, 0, primeBits, NULL); if (slot == NULL) { PORT_SetError(SEC_ERROR_NO_TOKEN); /* can happen */ goto loser; } /* ditch seedBits in this case, they are NSS specific and at * this point we have a token that claims to handle DSA2 */ if (seedBits) { attrs--; } } } /* Initialize the Key Gen Mechanism */ mechanism.mechanism = CKM_DSA_PARAMETER_GEN; mechanism.pParameter = NULL; mechanism.ulParameterLen = 0; PK11_EnterSlotMonitor(slot); crv = PK11_GETTAB(slot)->C_GenerateKey(slot->session, &mechanism, genTemplate, count, &objectID); PK11_ExitSlotMonitor(slot); if (crv != CKR_OK) { PORT_SetError( PK11_MapError(crv) ); goto loser; } parena = PORT_NewArena(60); if (!parena) { goto loser; } crv = PK11_GetAttributes(parena, slot, objectID, pTemplate, pTemplateCount); if (crv != CKR_OK) { PORT_SetError( PK11_MapError(crv) ); goto loser; } params = (PQGParams *)PORT_ArenaAlloc(parena,sizeof(PQGParams)); if (params == NULL) { goto loser; } /* fill in Params */ params->arena = parena; params->prime.type = siUnsignedInteger; params->prime.data = pTemplate[0].pValue; params->prime.len = pTemplate[0].ulValueLen; params->subPrime.type = siUnsignedInteger; params->subPrime.data = pTemplate[1].pValue; params->subPrime.len = pTemplate[1].ulValueLen; params->base.type = siUnsignedInteger; params->base.data = pTemplate[2].pValue; params->base.len = pTemplate[2].ulValueLen; varena = PORT_NewArena(60); if (!varena) { goto loser; } crv = PK11_GetAttributes(varena, slot, objectID, vTemplate, vTemplateCount); if (crv != CKR_OK) { PORT_SetError( PK11_MapError(crv) ); goto loser; } verify = (PQGVerify *)PORT_ArenaAlloc(varena,sizeof(PQGVerify)); if (verify == NULL) { goto loser; } /* fill in Params */ verify->arena = varena; verify->counter = (unsigned int)(*(CK_ULONG*)vTemplate[0].pValue); verify->seed.type = siUnsignedInteger; verify->seed.data = vTemplate[1].pValue; verify->seed.len = vTemplate[1].ulValueLen; verify->h.type = siUnsignedInteger; verify->h.data = vTemplate[2].pValue; verify->h.len = vTemplate[2].ulValueLen; PK11_DestroyObject(slot,objectID); PK11_FreeSlot(slot); *pParams = params; *pVfy = verify; return SECSuccess; loser: if (objectID != CK_INVALID_HANDLE) { PK11_DestroyObject(slot,objectID); } if (parena != NULL) { PORT_FreeArena(parena,PR_FALSE); } if (varena != NULL) { PORT_FreeArena(varena,PR_FALSE); } if (slot) { PK11_FreeSlot(slot); } return SECFailure; } /* Generate PQGParams and PQGVerify structs. * Length of P specified by j. Length of h will match length of P. * Length of SEED in bytes specified in seedBytes. * seedBbytes must be in the range [20..255] or an error will result. */ extern SECStatus PK11_PQG_ParamGenSeedLen( unsigned int j, unsigned int seedBytes, PQGParams **pParams, PQGVerify **pVfy) { unsigned int primeBits = PQG_INDEX_TO_PBITS(j); return PK11_PQG_ParamGenV2(primeBits, 0, seedBytes, pParams, pVfy); } /* Generate PQGParams and PQGVerify structs. * Length of seed and length of h both equal length of P. * All lengths are specified by "j", according to the table above. */ extern SECStatus PK11_PQG_ParamGen(unsigned int j, PQGParams **pParams, PQGVerify **pVfy) { unsigned int primeBits = PQG_INDEX_TO_PBITS(j); return PK11_PQG_ParamGenV2(primeBits, 0, 0, pParams, pVfy); } /* Test PQGParams for validity as DSS PQG values. * If vfy is non-NULL, test PQGParams to make sure they were generated * using the specified seed, counter, and h values. * * Return value indicates whether Verification operation ran successfully * to completion, but does not indicate if PQGParams are valid or not. * If return value is SECSuccess, then *pResult has these meanings: * SECSuccess: PQGParams are valid. * SECFailure: PQGParams are invalid. */ extern SECStatus PK11_PQG_VerifyParams(const PQGParams *params, const PQGVerify *vfy, SECStatus *result) { CK_ATTRIBUTE keyTempl[] = { { CKA_CLASS, NULL, 0 }, { CKA_KEY_TYPE, NULL, 0 }, { CKA_PRIME, NULL, 0 }, { CKA_SUBPRIME, NULL, 0 }, { CKA_BASE, NULL, 0 }, { CKA_TOKEN, NULL, 0 }, { CKA_NETSCAPE_PQG_COUNTER, NULL, 0 }, { CKA_NETSCAPE_PQG_SEED, NULL, 0 }, { CKA_NETSCAPE_PQG_H, NULL, 0 }, }; CK_ATTRIBUTE *attrs; CK_BBOOL ckfalse = CK_FALSE; CK_OBJECT_CLASS class = CKO_KG_PARAMETERS; CK_KEY_TYPE keyType = CKK_DSA; SECStatus rv = SECSuccess; PK11SlotInfo *slot; int keyCount; CK_OBJECT_HANDLE objectID; CK_ULONG counter; CK_RV crv; attrs = keyTempl; PK11_SETATTRS(attrs, CKA_CLASS, &class, sizeof(class)); attrs++; PK11_SETATTRS(attrs, CKA_KEY_TYPE, &keyType, sizeof(keyType)); attrs++; PK11_SETATTRS(attrs, CKA_PRIME, params->prime.data, params->prime.len); attrs++; PK11_SETATTRS(attrs, CKA_SUBPRIME, params->subPrime.data, params->subPrime.len); attrs++; if (params->base.len) { PK11_SETATTRS(attrs, CKA_BASE,params->base.data,params->base.len); attrs++; } PK11_SETATTRS(attrs, CKA_TOKEN, &ckfalse, sizeof(ckfalse)); attrs++; if (vfy) { if (vfy->counter != -1) { counter = vfy->counter; PK11_SETATTRS(attrs, CKA_NETSCAPE_PQG_COUNTER, &counter, sizeof(counter)); attrs++; } PK11_SETATTRS(attrs, CKA_NETSCAPE_PQG_SEED, vfy->seed.data, vfy->seed.len); attrs++; if (vfy->h.len) { PK11_SETATTRS(attrs, CKA_NETSCAPE_PQG_H, vfy->h.data, vfy->h.len); attrs++; } } keyCount = attrs - keyTempl; PORT_Assert(keyCount <= sizeof(keyTempl)/sizeof(keyTempl[0])); slot = PK11_GetInternalSlot(); if (slot == NULL) { return SECFailure; } PK11_EnterSlotMonitor(slot); crv = PK11_GETTAB(slot)->C_CreateObject(slot->session, keyTempl, keyCount, &objectID); PK11_ExitSlotMonitor(slot); /* throw away the keys, we only wanted the return code */ PK11_DestroyObject(slot,objectID); PK11_FreeSlot(slot); *result = SECSuccess; if (crv == CKR_ATTRIBUTE_VALUE_INVALID) { *result = SECFailure; } else if (crv != CKR_OK) { PORT_SetError( PK11_MapError(crv) ); rv = SECFailure; } return rv; } /************************************************************************** * Free the PQGParams struct and the things it points to. * **************************************************************************/ extern void PK11_PQG_DestroyParams(PQGParams *params) { if (params == NULL) return; if (params->arena != NULL) { PORT_FreeArena(params->arena, PR_FALSE); /* don't zero it */ } else { SECITEM_FreeItem(¶ms->prime, PR_FALSE); /* don't free prime */ SECITEM_FreeItem(¶ms->subPrime, PR_FALSE); /* don't free subPrime */ SECITEM_FreeItem(¶ms->base, PR_FALSE); /* don't free base */ PORT_Free(params); } } /************************************************************************** * Free the PQGVerify struct and the things it points to. * **************************************************************************/ extern void PK11_PQG_DestroyVerify(PQGVerify *vfy) { if (vfy == NULL) return; if (vfy->arena != NULL) { PORT_FreeArena(vfy->arena, PR_FALSE); /* don't zero it */ } else { SECITEM_FreeItem(&vfy->seed, PR_FALSE); /* don't free seed */ SECITEM_FreeItem(&vfy->h, PR_FALSE); /* don't free h */ PORT_Free(vfy); } } #define PQG_DEFAULT_CHUNKSIZE 2048 /* bytes */ /************************************************************************** * Return a pointer to a new PQGParams struct that is constructed from * * copies of the arguments passed in. * * Return NULL on failure. * **************************************************************************/ extern PQGParams * PK11_PQG_NewParams(const SECItem * prime, const SECItem * subPrime, const SECItem * base) { PLArenaPool *arena; PQGParams *dest; SECStatus status; arena = PORT_NewArena(PQG_DEFAULT_CHUNKSIZE); if (arena == NULL) goto loser; dest = (PQGParams*)PORT_ArenaZAlloc(arena, sizeof(PQGParams)); if (dest == NULL) goto loser; dest->arena = arena; status = SECITEM_CopyItem(arena, &dest->prime, prime); if (status != SECSuccess) goto loser; status = SECITEM_CopyItem(arena, &dest->subPrime, subPrime); if (status != SECSuccess) goto loser; status = SECITEM_CopyItem(arena, &dest->base, base); if (status != SECSuccess) goto loser; return dest; loser: if (arena != NULL) PORT_FreeArena(arena, PR_FALSE); return NULL; } /************************************************************************** * Fills in caller's "prime" SECItem with the prime value in params. * Contents can be freed by calling SECITEM_FreeItem(prime, PR_FALSE); **************************************************************************/ extern SECStatus PK11_PQG_GetPrimeFromParams(const PQGParams *params, SECItem * prime) { return SECITEM_CopyItem(NULL, prime, ¶ms->prime); } /************************************************************************** * Fills in caller's "subPrime" SECItem with the prime value in params. * Contents can be freed by calling SECITEM_FreeItem(subPrime, PR_FALSE); **************************************************************************/ extern SECStatus PK11_PQG_GetSubPrimeFromParams(const PQGParams *params, SECItem * subPrime) { return SECITEM_CopyItem(NULL, subPrime, ¶ms->subPrime); } /************************************************************************** * Fills in caller's "base" SECItem with the base value in params. * Contents can be freed by calling SECITEM_FreeItem(base, PR_FALSE); **************************************************************************/ extern SECStatus PK11_PQG_GetBaseFromParams(const PQGParams *params, SECItem *base) { return SECITEM_CopyItem(NULL, base, ¶ms->base); } /************************************************************************** * Return a pointer to a new PQGVerify struct that is constructed from * * copies of the arguments passed in. * * Return NULL on failure. * **************************************************************************/ extern PQGVerify * PK11_PQG_NewVerify(unsigned int counter, const SECItem * seed, const SECItem * h) { PLArenaPool *arena; PQGVerify * dest; SECStatus status; arena = PORT_NewArena(PQG_DEFAULT_CHUNKSIZE); if (arena == NULL) goto loser; dest = (PQGVerify*)PORT_ArenaZAlloc(arena, sizeof(PQGVerify)); if (dest == NULL) goto loser; dest->arena = arena; dest->counter = counter; status = SECITEM_CopyItem(arena, &dest->seed, seed); if (status != SECSuccess) goto loser; status = SECITEM_CopyItem(arena, &dest->h, h); if (status != SECSuccess) goto loser; return dest; loser: if (arena != NULL) PORT_FreeArena(arena, PR_FALSE); return NULL; } /************************************************************************** * Returns "counter" value from the PQGVerify. **************************************************************************/ extern unsigned int PK11_PQG_GetCounterFromVerify(const PQGVerify *verify) { return verify->counter; } /************************************************************************** * Fills in caller's "seed" SECItem with the seed value in verify. * Contents can be freed by calling SECITEM_FreeItem(seed, PR_FALSE); **************************************************************************/ extern SECStatus PK11_PQG_GetSeedFromVerify(const PQGVerify *verify, SECItem *seed) { return SECITEM_CopyItem(NULL, seed, &verify->seed); } /************************************************************************** * Fills in caller's "h" SECItem with the h value in verify. * Contents can be freed by calling SECITEM_FreeItem(h, PR_FALSE); **************************************************************************/ extern SECStatus PK11_PQG_GetHFromVerify(const PQGVerify *verify, SECItem * h) { return SECITEM_CopyItem(NULL, h, &verify->h); }