michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "seccomon.h"
michael@0: #include "secerr.h"
michael@0: #include "blapi.h"
michael@0: #include "pkcs11i.h"
michael@0: #include "softoken.h"
michael@0: 
michael@0: static CK_RV
michael@0: jpake_mapStatus(SECStatus rv, CK_RV invalidArgsMapping) {
michael@0:     int err;
michael@0:     if (rv == SECSuccess)
michael@0:         return CKR_OK;
michael@0:     err = PORT_GetError();
michael@0:     switch (err) {
michael@0:         /* XXX: SEC_ERROR_INVALID_ARGS might be caused by invalid template
michael@0:             parameters. */
michael@0:         case SEC_ERROR_INVALID_ARGS:  return invalidArgsMapping;
michael@0:         case SEC_ERROR_BAD_SIGNATURE: return CKR_SIGNATURE_INVALID;
michael@0:         case SEC_ERROR_NO_MEMORY:     return CKR_HOST_MEMORY;
michael@0:     }
michael@0:     return CKR_FUNCTION_FAILED;
michael@0: }
michael@0: 
michael@0: /* If key is not NULL then the gx value will be stored as an attribute with
michael@0:    the type given by the gxAttrType parameter. */
michael@0: static CK_RV
michael@0: jpake_Sign(PLArenaPool * arena, const PQGParams * pqg, HASH_HashType hashType,
michael@0:            const SECItem * signerID, const SECItem * x,
michael@0:            CK_NSS_JPAKEPublicValue * out)
michael@0: {
michael@0:     SECItem gx, gv, r;
michael@0:     CK_RV crv;
michael@0: 
michael@0:     PORT_Assert(arena != NULL);
michael@0:     
michael@0:     gx.data = NULL;
michael@0:     gv.data = NULL;
michael@0:     r.data = NULL;
michael@0:     crv = jpake_mapStatus(JPAKE_Sign(arena, pqg, hashType, signerID, x, NULL,
michael@0:                                      NULL, &gx, &gv, &r),
michael@0:                           CKR_MECHANISM_PARAM_INVALID);
michael@0:     if (crv == CKR_OK) {
michael@0:         if ((out->pGX != NULL && out->ulGXLen >= gx.len) ||
michael@0:             (out->pGV != NULL && out->ulGVLen >= gv.len) ||
michael@0:             (out->pR  != NULL && out->ulRLen >= r.len)) {
michael@0:             PORT_Memcpy(out->pGX, gx.data, gx.len); 
michael@0:             PORT_Memcpy(out->pGV, gv.data, gv.len); 
michael@0:             PORT_Memcpy(out->pR, r.data, r.len);
michael@0:             out->ulGXLen = gx.len;
michael@0:             out->ulGVLen = gv.len;
michael@0:             out->ulRLen = r.len;
michael@0:         } else {
michael@0:             crv = CKR_MECHANISM_PARAM_INVALID;
michael@0:         }
michael@0:     } 
michael@0:     return crv;
michael@0: }
michael@0: 
michael@0: static CK_RV
michael@0: jpake_Verify(PLArenaPool * arena, const PQGParams * pqg,
michael@0:              HASH_HashType hashType, const SECItem * signerID,
michael@0:              const CK_BYTE * peerIDData, CK_ULONG peerIDLen,
michael@0:              const CK_NSS_JPAKEPublicValue * publicValueIn)
michael@0: {
michael@0:     SECItem peerID, gx, gv, r;
michael@0:     peerID.data = (unsigned char *) peerIDData; peerID.len = peerIDLen;
michael@0:     gx.data = publicValueIn->pGX; gx.len = publicValueIn->ulGXLen;
michael@0:     gv.data = publicValueIn->pGV; gv.len = publicValueIn->ulGVLen;
michael@0:     r.data = publicValueIn->pR;   r.len = publicValueIn->ulRLen;
michael@0:     return jpake_mapStatus(JPAKE_Verify(arena, pqg, hashType, signerID, &peerID,
michael@0:                                         &gx, &gv, &r),
michael@0:                            CKR_MECHANISM_PARAM_INVALID);
michael@0: }
michael@0: 
michael@0: #define NUM_ELEM(x) (sizeof (x) / sizeof (x)[0])
michael@0: 
michael@0: /* If the template has the key type set, ensure that it was set to the correct
michael@0:  * value. If the template did not have the key type set, set it to the
michael@0:  * correct value.
michael@0:  */
michael@0: static CK_RV
michael@0: jpake_enforceKeyType(SFTKObject * key, CK_KEY_TYPE keyType) {
michael@0:     CK_RV crv;
michael@0:     SFTKAttribute * keyTypeAttr = sftk_FindAttribute(key, CKA_KEY_TYPE);
michael@0:     if (keyTypeAttr != NULL) {
michael@0:         crv = *(CK_KEY_TYPE *)keyTypeAttr->attrib.pValue == keyType
michael@0:             ? CKR_OK
michael@0:             : CKR_TEMPLATE_INCONSISTENT;
michael@0:         sftk_FreeAttribute(keyTypeAttr);
michael@0:     } else {
michael@0:         crv = sftk_forceAttribute(key, CKA_KEY_TYPE, &keyType, sizeof keyType);
michael@0:     }
michael@0:     return crv;
michael@0: }
michael@0: 
michael@0: static CK_RV
michael@0: jpake_MultipleSecItem2Attribute(SFTKObject * key, const SFTKItemTemplate * attrs,
michael@0:                                 size_t attrsCount)
michael@0: {
michael@0:     size_t i;
michael@0:     
michael@0:     for (i = 0; i < attrsCount; ++i) {
michael@0:         CK_RV crv = sftk_forceAttribute(key, attrs[i].type, attrs[i].item->data,
michael@0:                                         attrs[i].item->len);
michael@0:         if (crv != CKR_OK)
michael@0:             return crv;
michael@0:     }
michael@0:     return CKR_OK;
michael@0: }
michael@0: 
michael@0: CK_RV
michael@0: jpake_Round1(HASH_HashType hashType, CK_NSS_JPAKERound1Params * params,
michael@0:              SFTKObject * key)
michael@0: {
michael@0:     CK_RV crv;
michael@0:     PQGParams pqg;
michael@0:     PLArenaPool * arena;
michael@0:     SECItem signerID;
michael@0:     SFTKItemTemplate templateAttrs[] = {
michael@0:         { CKA_PRIME, &pqg.prime },
michael@0:         { CKA_SUBPRIME, &pqg.subPrime },
michael@0:         { CKA_BASE, &pqg.base },
michael@0:         { CKA_NSS_JPAKE_SIGNERID, &signerID }
michael@0:     };
michael@0:     SECItem x2, gx1, gx2;
michael@0:     const SFTKItemTemplate generatedAttrs[] = {
michael@0:         { CKA_NSS_JPAKE_X2,  &x2  },
michael@0:         { CKA_NSS_JPAKE_GX1, &gx1 },
michael@0:         { CKA_NSS_JPAKE_GX2, &gx2 },
michael@0:     };
michael@0:     SECItem x1;
michael@0: 
michael@0:     PORT_Assert(params != NULL);
michael@0:     PORT_Assert(key != NULL);
michael@0: 
michael@0:     arena = PORT_NewArena(NSS_SOFTOKEN_DEFAULT_CHUNKSIZE);
michael@0:     if (arena == NULL)
michael@0:         crv = CKR_HOST_MEMORY;
michael@0: 
michael@0:     crv = sftk_MultipleAttribute2SecItem(arena, key, templateAttrs,
michael@0:                                          NUM_ELEM(templateAttrs));
michael@0: 
michael@0:     if (crv == CKR_OK && (signerID.data == NULL || signerID.len == 0))
michael@0:         crv = CKR_TEMPLATE_INCOMPLETE;
michael@0: 
michael@0:     /* generate x1, g^x1 and the proof of knowledge of x1 */
michael@0:     if (crv == CKR_OK) {
michael@0:         x1.data = NULL;
michael@0:         crv = jpake_mapStatus(DSA_NewRandom(arena, &pqg.subPrime, &x1),
michael@0:                               CKR_TEMPLATE_INCONSISTENT);
michael@0:     }
michael@0:     if (crv == CKR_OK)
michael@0:         crv = jpake_Sign(arena, &pqg, hashType, &signerID, &x1, &params->gx1);
michael@0: 
michael@0:     /* generate x2, g^x2 and the proof of knowledge of x2 */
michael@0:     if (crv == CKR_OK) {
michael@0:         x2.data = NULL;
michael@0:         crv = jpake_mapStatus(DSA_NewRandom(arena, &pqg.subPrime, &x2),
michael@0:                               CKR_TEMPLATE_INCONSISTENT);
michael@0:     }
michael@0:     if (crv == CKR_OK)
michael@0:         crv = jpake_Sign(arena, &pqg, hashType, &signerID, &x2, &params->gx2);
michael@0: 
michael@0:     /* Save the values needed for round 2 into CKA_VALUE */
michael@0:     if (crv == CKR_OK) {
michael@0:         gx1.data = params->gx1.pGX;
michael@0:         gx1.len = params->gx1.ulGXLen;
michael@0:         gx2.data = params->gx2.pGX;
michael@0:         gx2.len = params->gx2.ulGXLen;
michael@0:         crv = jpake_MultipleSecItem2Attribute(key, generatedAttrs, 
michael@0:                                               NUM_ELEM(generatedAttrs));
michael@0:     }
michael@0: 
michael@0:     PORT_FreeArena(arena, PR_TRUE);
michael@0:     return crv;
michael@0: }
michael@0: 
michael@0: CK_RV
michael@0: jpake_Round2(HASH_HashType hashType, CK_NSS_JPAKERound2Params * params,
michael@0:              SFTKObject * sourceKey, SFTKObject * key)
michael@0: {
michael@0:     CK_RV crv;
michael@0:     PLArenaPool * arena;
michael@0:     PQGParams pqg;
michael@0:     SECItem signerID, x2, gx1, gx2;
michael@0:     SFTKItemTemplate sourceAttrs[] = { 
michael@0:         { CKA_PRIME, &pqg.prime },
michael@0:         { CKA_SUBPRIME, &pqg.subPrime },
michael@0:         { CKA_BASE, &pqg.base },
michael@0:         { CKA_NSS_JPAKE_SIGNERID, &signerID },
michael@0:         { CKA_NSS_JPAKE_X2,  &x2 },
michael@0:         { CKA_NSS_JPAKE_GX1, &gx1 },
michael@0:         { CKA_NSS_JPAKE_GX2, &gx2 },
michael@0:     };
michael@0:     SECItem x2s, gx3, gx4;
michael@0:     const SFTKItemTemplate copiedAndGeneratedAttrs[] = {
michael@0:         { CKA_NSS_JPAKE_SIGNERID, &signerID },
michael@0:         { CKA_PRIME, &pqg.prime },
michael@0:         { CKA_SUBPRIME, &pqg.subPrime },
michael@0:         { CKA_NSS_JPAKE_X2,  &x2  },
michael@0:         { CKA_NSS_JPAKE_X2S, &x2s },
michael@0:         { CKA_NSS_JPAKE_GX1, &gx1 },
michael@0:         { CKA_NSS_JPAKE_GX2, &gx2 },
michael@0:         { CKA_NSS_JPAKE_GX3, &gx3 },
michael@0:         { CKA_NSS_JPAKE_GX4, &gx4 }
michael@0:     };
michael@0:     SECItem peerID;
michael@0: 
michael@0:     PORT_Assert(params != NULL);
michael@0:     PORT_Assert(sourceKey != NULL);
michael@0:     PORT_Assert(key != NULL);
michael@0: 
michael@0:     arena = PORT_NewArena(NSS_SOFTOKEN_DEFAULT_CHUNKSIZE);
michael@0:     if (arena == NULL)
michael@0:         crv = CKR_HOST_MEMORY;
michael@0: 
michael@0:     /* TODO: check CKK_NSS_JPAKE_ROUND1 */
michael@0: 
michael@0:     crv = sftk_MultipleAttribute2SecItem(arena, sourceKey, sourceAttrs,
michael@0:                                          NUM_ELEM(sourceAttrs));
michael@0: 
michael@0:     /* Get the peer's ID out of the template and sanity-check it. */
michael@0:     if (crv == CKR_OK)
michael@0:         crv = sftk_Attribute2SecItem(arena, &peerID, key,
michael@0:                                      CKA_NSS_JPAKE_PEERID);
michael@0:     if (crv == CKR_OK && (peerID.data == NULL || peerID.len == 0))
michael@0:         crv = CKR_TEMPLATE_INCOMPLETE;
michael@0:     if (crv == CKR_OK && SECITEM_CompareItem(&signerID, &peerID) == SECEqual)
michael@0:         crv = CKR_TEMPLATE_INCONSISTENT;
michael@0: 
michael@0:     /* Verify zero-knowledge proofs for g^x3 and g^x4 */
michael@0:     if (crv == CKR_OK)
michael@0:         crv = jpake_Verify(arena, &pqg, hashType, &signerID,
michael@0:                            peerID.data, peerID.len, &params->gx3);
michael@0:     if (crv == CKR_OK)
michael@0:         crv = jpake_Verify(arena, &pqg, hashType, &signerID,
michael@0:                            peerID.data, peerID.len, &params->gx4);
michael@0: 
michael@0:     /* Calculate the base and x2s for A=base^x2s */
michael@0:     if (crv == CKR_OK) {
michael@0:         SECItem s;
michael@0:         s.data = params->pSharedKey;
michael@0:         s.len = params->ulSharedKeyLen;
michael@0:         gx3.data = params->gx3.pGX;
michael@0:         gx3.len = params->gx3.ulGXLen;
michael@0:         gx4.data = params->gx4.pGX;
michael@0:         gx4.len = params->gx4.ulGXLen;
michael@0:         pqg.base.data = NULL;
michael@0:         x2s.data = NULL;
michael@0:         crv = jpake_mapStatus(JPAKE_Round2(arena, &pqg.prime, &pqg.subPrime,
michael@0:                                            &gx1, &gx3, &gx4, &pqg.base, 
michael@0:                                            &x2, &s, &x2s),
michael@0:                               CKR_MECHANISM_PARAM_INVALID);
michael@0:     }
michael@0: 
michael@0:     /* Generate A=base^x2s and its zero-knowledge proof. */
michael@0:     if (crv == CKR_OK)
michael@0:         crv = jpake_Sign(arena, &pqg, hashType, &signerID, &x2s, &params->A);
michael@0: 
michael@0:     /* Copy P and Q from the ROUND1 key to the ROUND2 key and save the values
michael@0:        needed for the final key material derivation into CKA_VALUE. */
michael@0:     if (crv == CKR_OK)
michael@0:         crv = sftk_forceAttribute(key, CKA_PRIME, pqg.prime.data,
michael@0:                                   pqg.prime.len);
michael@0:     if (crv == CKR_OK)
michael@0:         crv = sftk_forceAttribute(key, CKA_SUBPRIME, pqg.subPrime.data,
michael@0:                                   pqg.subPrime.len);
michael@0:     if (crv == CKR_OK) {
michael@0:         crv = jpake_MultipleSecItem2Attribute(key, copiedAndGeneratedAttrs,
michael@0:                                               NUM_ELEM(copiedAndGeneratedAttrs));
michael@0:     }
michael@0: 
michael@0:     if (crv == CKR_OK)
michael@0:         crv = jpake_enforceKeyType(key, CKK_NSS_JPAKE_ROUND2);
michael@0: 
michael@0:     PORT_FreeArena(arena, PR_TRUE);
michael@0:     return crv;
michael@0: }
michael@0: 
michael@0: CK_RV
michael@0: jpake_Final(HASH_HashType hashType, const CK_NSS_JPAKEFinalParams * param,
michael@0:             SFTKObject * sourceKey, SFTKObject * key)
michael@0: {
michael@0:     PLArenaPool * arena;
michael@0:     SECItem K;
michael@0:     PQGParams pqg;
michael@0:     CK_RV crv;
michael@0:     SECItem peerID, signerID, x2s, x2, gx1, gx2, gx3, gx4;
michael@0:     SFTKItemTemplate sourceAttrs[] = {
michael@0:         { CKA_NSS_JPAKE_PEERID, &peerID },
michael@0:         { CKA_NSS_JPAKE_SIGNERID, &signerID },
michael@0:         { CKA_PRIME, &pqg.prime },
michael@0:         { CKA_SUBPRIME, &pqg.subPrime },
michael@0:         { CKA_NSS_JPAKE_X2,  &x2  },
michael@0:         { CKA_NSS_JPAKE_X2S, &x2s },
michael@0:         { CKA_NSS_JPAKE_GX1, &gx1 },
michael@0:         { CKA_NSS_JPAKE_GX2, &gx2 },
michael@0:         { CKA_NSS_JPAKE_GX3, &gx3 },
michael@0:         { CKA_NSS_JPAKE_GX4, &gx4 }
michael@0:     };
michael@0: 
michael@0:     PORT_Assert(param != NULL);
michael@0:     PORT_Assert(sourceKey != NULL);
michael@0:     PORT_Assert(key != NULL);
michael@0: 
michael@0:     arena = PORT_NewArena(NSS_SOFTOKEN_DEFAULT_CHUNKSIZE);
michael@0:     if (arena == NULL)
michael@0:         crv = CKR_HOST_MEMORY;
michael@0:     
michael@0:     /* TODO: verify key type CKK_NSS_JPAKE_ROUND2 */
michael@0: 
michael@0:     crv = sftk_MultipleAttribute2SecItem(arena, sourceKey, sourceAttrs,
michael@0:                                          NUM_ELEM(sourceAttrs));
michael@0: 
michael@0:     /* Calculate base for B=base^x4s */
michael@0:     if (crv == CKR_OK) {
michael@0:         pqg.base.data = NULL;
michael@0:         crv = jpake_mapStatus(JPAKE_Round2(arena, &pqg.prime, &pqg.subPrime,
michael@0:                                            &gx1, &gx2, &gx3, &pqg.base,
michael@0:                                            NULL, NULL, NULL),
michael@0:                               CKR_MECHANISM_PARAM_INVALID);
michael@0:     }
michael@0: 
michael@0:     /* Verify zero-knowledge proof for B */
michael@0:     if (crv == CKR_OK)
michael@0:         crv = jpake_Verify(arena, &pqg, hashType, &signerID,
michael@0:                            peerID.data, peerID.len, &param->B);
michael@0:     if (crv == CKR_OK) {
michael@0:         SECItem B;
michael@0:         B.data = param->B.pGX;
michael@0:         B.len = param->B.ulGXLen;
michael@0:         K.data = NULL;
michael@0:         crv = jpake_mapStatus(JPAKE_Final(arena, &pqg.prime, &pqg.subPrime,
michael@0:                                           &x2, &gx4, &x2s, &B, &K),
michael@0:                               CKR_MECHANISM_PARAM_INVALID);
michael@0:     }
michael@0: 
michael@0:     /* Save key material into CKA_VALUE. */
michael@0:     if (crv == CKR_OK)
michael@0:         crv = sftk_forceAttribute(key, CKA_VALUE, K.data, K.len);
michael@0: 
michael@0:     if (crv == CKR_OK)
michael@0:         crv = jpake_enforceKeyType(key, CKK_GENERIC_SECRET);
michael@0: 
michael@0:     PORT_FreeArena(arena, PR_TRUE);
michael@0:     return crv;
michael@0: }