/
githubmirror
/
xmlsec
Обзор
Документация
Войти
/
githubmirror
/
xmlsec
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
master
src/nss/hmac.c
612 строк
21 KB
Javid Khan
reject HMACOutputLength larger than the HMAC digest size (#1199)
02 июн 2026, 16:33
Не верифицирован
02 июн 2026, 16:33
4f34e63
Код
Авторство
О чём код?
/** * XML Security Library (http://www.aleksey.com/xmlsec). * * This is free software; see the Copyright file in the source distribution for precise wording. * * Copyright (C) 2002-2026 Aleksey Sanin <aleksey@aleksey.com>. All Rights Reserved. * Copyright (c) 2003 America Online, Inc. All rights reserved. */ /** * @addtogroup xmlsec_nss_crypto * @brief HMAC transforms implementation for NSS. */ #include "globals.h" #include <string.h> #include <nspr.h> #include <nss.h> #include <secoid.h> #include <pk11pub.h> #include <xmlsec/xmlsec.h> #include <xmlsec/keys.h> #include <xmlsec/errors.h> #include <xmlsec/private.h> #include <xmlsec/transforms.h> #include <xmlsec/nss/app.h> #include <xmlsec/nss/crypto.h> #include "../cast_helpers.h" #include "../keysdata_helpers.h" #include "../transform_helpers.h" #ifndef XMLSEC_NO_HMAC /****************************************************************************** * * Configuration * *****************************************************************************/ /****************************************************************************** * * Internal NSS HMAC CTX * *****************************************************************************/ typedef struct _xmlSecNssHmacCtx xmlSecNssHmacCtx, *xmlSecNssHmacCtxPtr; struct _xmlSecNssHmacCtx { CK_MECHANISM_TYPE digestType; PK11Context* digestCtx; xmlSecByte dgst[XMLSEC_TRANSFORM_HMAC_MAX_OUTPUT_SIZE]; xmlSecSize dgstSizeInBits; /* dgst size in bits */ }; /****************************************************************************** * * HMAC transforms * * xmlSecTransform + xmlSecNssHmacCtx * *****************************************************************************/ XMLSEC_TRANSFORM_DECLARE(NssHmac, xmlSecNssHmacCtx) #define xmlSecNssHmacSize XMLSEC_TRANSFORM_SIZE(NssHmac) static int xmlSecNssHmacCheckId (xmlSecTransformPtr transform); static int xmlSecNssHmacInitialize (xmlSecTransformPtr transform); static void xmlSecNssHmacFinalize (xmlSecTransformPtr transform); static int xmlSecNssHmacNodeRead (xmlSecTransformPtr transform, xmlNodePtr node, xmlSecTransformCtxPtr transformCtx); static int xmlSecNssHmacSetKeyReq (xmlSecTransformPtr transform, xmlSecKeyReqPtr keyReq); static int xmlSecNssHmacSetKey (xmlSecTransformPtr transform, xmlSecKeyPtr key); static int xmlSecNssHmacVerify (xmlSecTransformPtr transform, const xmlSecByte* data, xmlSecSize dataSize, xmlSecTransformCtxPtr transformCtx); static int xmlSecNssHmacExecute (xmlSecTransformPtr transform, int last, xmlSecTransformCtxPtr transformCtx); static int xmlSecNssHmacCheckId(xmlSecTransformPtr transform) { #ifndef XMLSEC_NO_MD5 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacMd5Id)) { return(1); } #endif /* XMLSEC_NO_MD5 */ #ifndef XMLSEC_NO_RIPEMD160 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacRipemd160Id)) { return(1); } #endif /* XMLSEC_NO_RIPEMD160 */ #ifndef XMLSEC_NO_SHA1 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacSha1Id)) { return(1); } #endif /* XMLSEC_NO_SHA1 */ #ifndef XMLSEC_NO_SHA224 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacSha224Id)) { return(1); } #endif /* XMLSEC_NO_SHA224 */ #ifndef XMLSEC_NO_SHA256 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacSha256Id)) { return(1); } #endif /* XMLSEC_NO_SHA256 */ #ifndef XMLSEC_NO_SHA384 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacSha384Id)) { return(1); } #endif /* XMLSEC_NO_SHA384 */ #ifndef XMLSEC_NO_SHA512 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacSha512Id)) { return(1); } #endif /* XMLSEC_NO_SHA512 */ /* not found */ return(0); } static int xmlSecNssHmacInitialize(xmlSecTransformPtr transform) { xmlSecNssHmacCtxPtr ctx; xmlSecAssert2(xmlSecNssHmacCheckId(transform), -1); xmlSecAssert2(xmlSecTransformCheckSize(transform, xmlSecNssHmacSize), -1); ctx = xmlSecNssHmacGetCtx(transform); xmlSecAssert2(ctx != NULL, -1); memset(ctx, 0, sizeof(xmlSecNssHmacCtx)); #ifndef XMLSEC_NO_MD5 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacMd5Id)) { ctx->digestType = CKM_MD5_HMAC; } else #endif /* XMLSEC_NO_MD5 */ #ifndef XMLSEC_NO_RIPEMD160 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacRipemd160Id)) { ctx->digestType = CKM_RIPEMD160_HMAC; } else #endif /* XMLSEC_NO_RIPEMD160 */ #ifndef XMLSEC_NO_SHA1 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacSha1Id)) { ctx->digestType = CKM_SHA_1_HMAC; } else #endif /* XMLSEC_NO_SHA1 */ #ifndef XMLSEC_NO_SHA224 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacSha224Id)) { ctx->digestType = CKM_SHA224_HMAC; } else #endif /* XMLSEC_NO_SHA224 */ #ifndef XMLSEC_NO_SHA256 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacSha256Id)) { ctx->digestType = CKM_SHA256_HMAC; } else #endif /* XMLSEC_NO_SHA256 */ #ifndef XMLSEC_NO_SHA384 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacSha384Id)) { ctx->digestType = CKM_SHA384_HMAC; } else #endif /* XMLSEC_NO_SHA384 */ #ifndef XMLSEC_NO_SHA512 if(xmlSecTransformCheckId(transform, xmlSecNssTransformHmacSha512Id)) { ctx->digestType = CKM_SHA512_HMAC; } else #endif /* XMLSEC_NO_SHA512 */ /* not found */ { xmlSecInvalidTransfromError(transform) return(-1); } return(0); } static void xmlSecNssHmacFinalize(xmlSecTransformPtr transform) { xmlSecNssHmacCtxPtr ctx; xmlSecAssert(xmlSecNssHmacCheckId(transform)); xmlSecAssert(xmlSecTransformCheckSize(transform, xmlSecNssHmacSize)); ctx = xmlSecNssHmacGetCtx(transform); xmlSecAssert(ctx != NULL); if(ctx->digestCtx != NULL) { PK11_DestroyContext(ctx->digestCtx, PR_TRUE); } memset(ctx, 0, sizeof(xmlSecNssHmacCtx)); } static int xmlSecNssHmacNodeRead(xmlSecTransformPtr transform, xmlNodePtr node, xmlSecTransformCtxPtr transformCtx XMLSEC_ATTRIBUTE_UNUSED) { xmlSecNssHmacCtxPtr ctx; int ret; xmlSecAssert2(xmlSecNssHmacCheckId(transform), -1); xmlSecAssert2(xmlSecTransformCheckSize(transform, xmlSecNssHmacSize), -1); xmlSecAssert2(node!= NULL, -1); UNREFERENCED_PARAMETER(transformCtx); ctx = xmlSecNssHmacGetCtx(transform); xmlSecAssert2(ctx != NULL, -1); ret = xmlSecTransformHmacReadOutputBitsSize(node, ctx->dgstSizeInBits, &ctx->dgstSizeInBits); if (ret < 0) { xmlSecInternalError("xmlSecTransformHmacReadOutputBitsSize()", xmlSecTransformGetName(transform)); return(-1); } xmlSecAssert2(XMLSEC_TRANSFORM_HMAC_BITS_TO_BYTES(ctx->dgstSizeInBits) <= XMLSEC_TRANSFORM_HMAC_MAX_OUTPUT_SIZE, -1); return(0); } static int xmlSecNssHmacSetKeyReq(xmlSecTransformPtr transform, xmlSecKeyReqPtr keyReq) { xmlSecNssHmacCtxPtr ctx; xmlSecAssert2(xmlSecNssHmacCheckId(transform), -1); xmlSecAssert2((transform->operation == xmlSecTransformOperationSign) || (transform->operation == xmlSecTransformOperationVerify), -1); xmlSecAssert2(keyReq != NULL, -1); xmlSecAssert2(xmlSecTransformCheckSize(transform, xmlSecNssHmacSize), -1); ctx = xmlSecNssHmacGetCtx(transform); xmlSecAssert2(ctx != NULL, -1); keyReq->keyId = xmlSecNssKeyDataHmacId; keyReq->keyType= xmlSecKeyDataTypeSymmetric; if(transform->operation == xmlSecTransformOperationSign) { keyReq->keyUsage = xmlSecKeyUsageSign; } else { keyReq->keyUsage = xmlSecKeyUsageVerify; } return(0); } static int xmlSecNssHmacSetKey(xmlSecTransformPtr transform, xmlSecKeyPtr key) { xmlSecNssHmacCtxPtr ctx; xmlSecKeyDataPtr value; xmlSecBufferPtr buffer; xmlSecSize bufferSize; SECItem keyItem = { siBuffer, NULL, 0 }; SECItem ignore = { siBuffer, NULL, 0 }; PK11SlotInfo* slot; PK11SymKey* symKey; xmlSecAssert2(xmlSecNssHmacCheckId(transform), -1); xmlSecAssert2((transform->operation == xmlSecTransformOperationSign) || (transform->operation == xmlSecTransformOperationVerify), -1); xmlSecAssert2(xmlSecTransformCheckSize(transform, xmlSecNssHmacSize), -1); xmlSecAssert2(key != NULL, -1); ctx = xmlSecNssHmacGetCtx(transform); xmlSecAssert2(ctx != NULL, -1); xmlSecAssert2(ctx->digestType != 0, -1); xmlSecAssert2(ctx->digestCtx == NULL, -1); value = xmlSecKeyGetValue(key); xmlSecAssert2(xmlSecKeyDataCheckId(value, xmlSecNssKeyDataHmacId), -1); buffer = xmlSecKeyDataBinaryValueGetBuffer(value); xmlSecAssert2(buffer != NULL, -1); bufferSize = xmlSecBufferGetSize(buffer); if(bufferSize <= 0) { xmlSecInvalidZeroKeyDataSizeError(xmlSecTransformGetName(transform)); return(-1); } memset(&ignore, 0, sizeof(ignore)); memset(&keyItem, 0, sizeof(keyItem)); keyItem.data = xmlSecBufferGetData(buffer); XMLSEC_SAFE_CAST_SIZE_TO_UINT(bufferSize, keyItem.len, return(-1), xmlSecTransformGetName(transform)); slot = PK11_GetBestSlot(ctx->digestType, NULL); if(slot == NULL) { xmlSecNssError("PK11_GetBestSlot", xmlSecTransformGetName(transform)); return(-1); } symKey = PK11_ImportSymKey(slot, ctx->digestType, PK11_OriginDerive, CKA_SIGN, &keyItem, NULL); if(symKey == NULL) { xmlSecNssError("PK11_ImportSymKey", xmlSecTransformGetName(transform)); PK11_FreeSlot(slot); return(-1); } ctx->digestCtx = PK11_CreateContextBySymKey(ctx->digestType, CKA_SIGN, symKey, &ignore); if(ctx->digestCtx == NULL) { xmlSecNssError("PK11_CreateContextBySymKey", xmlSecTransformGetName(transform)); PK11_FreeSymKey(symKey); PK11_FreeSlot(slot); return(-1); } PK11_FreeSymKey(symKey); PK11_FreeSlot(slot); return(0); } static int xmlSecNssHmacVerify(xmlSecTransformPtr transform, const xmlSecByte* data, xmlSecSize dataSize, xmlSecTransformCtxPtr transformCtx XMLSEC_ATTRIBUTE_UNUSED) { xmlSecNssHmacCtxPtr ctx; int ret; xmlSecAssert2(xmlSecTransformIsValid(transform), -1); xmlSecAssert2(transform->operation == xmlSecTransformOperationVerify, -1); xmlSecAssert2(xmlSecTransformCheckSize(transform, xmlSecNssHmacSize), -1); xmlSecAssert2(transform->status == xmlSecTransformStatusFinished, -1); xmlSecAssert2(data != NULL, -1); UNREFERENCED_PARAMETER(transformCtx); ctx = xmlSecNssHmacGetCtx(transform); xmlSecAssert2(ctx != NULL, -1); xmlSecAssert2(ctx->digestCtx != NULL, -1); xmlSecAssert2(ctx->dgstSizeInBits > 0, -1); /* Returns 1 for match, 0 for no match, <0 for errors. */ ret = xmlSecTransformHmacVerify(data, dataSize, ctx->dgst, ctx->dgstSizeInBits, sizeof(ctx->dgst)); if(ret < 0) { xmlSecInternalError("xmlSecTransformHmacVerify", xmlSecTransformGetName(transform)); return(-1); } if(ret == 1) { transform->status = xmlSecTransformStatusOk; } else { transform->status = xmlSecTransformStatusFail; } /* done */ return(0); } static int xmlSecNssHmacExecute(xmlSecTransformPtr transform, int last, xmlSecTransformCtxPtr transformCtx) { xmlSecNssHmacCtxPtr ctx; xmlSecBufferPtr in, out; SECStatus rv; int ret; xmlSecAssert2(xmlSecNssHmacCheckId(transform), -1); xmlSecAssert2((transform->operation == xmlSecTransformOperationSign) || (transform->operation == xmlSecTransformOperationVerify), -1); xmlSecAssert2(xmlSecTransformCheckSize(transform, xmlSecNssHmacSize), -1); xmlSecAssert2(transformCtx != NULL, -1); ctx = xmlSecNssHmacGetCtx(transform); xmlSecAssert2(ctx != NULL, -1); xmlSecAssert2(ctx->digestCtx != NULL, -1); in = &(transform->inBuf); out = &(transform->outBuf); if(transform->status == xmlSecTransformStatusNone) { rv = PK11_DigestBegin(ctx->digestCtx); if(rv != SECSuccess) { xmlSecNssError("PK11_DigestBegin", xmlSecTransformGetName(transform)); return(-1); } transform->status = xmlSecTransformStatusWorking; } if(transform->status == xmlSecTransformStatusWorking) { xmlSecSize inSize; inSize = xmlSecBufferGetSize(in); if(inSize > 0) { unsigned int inLen; XMLSEC_SAFE_CAST_SIZE_TO_UINT(inSize, inLen, return(-1), xmlSecTransformGetName(transform)); rv = PK11_DigestOp(ctx->digestCtx, xmlSecBufferGetData(in), inLen); if (rv != SECSuccess) { xmlSecNssError("PK11_DigestOp", xmlSecTransformGetName(transform)); return(-1); } ret = xmlSecBufferRemoveHead(in, inLen); if(ret < 0) { xmlSecInternalError2("xmlSecBufferRemoveHead", xmlSecTransformGetName(transform), "size=%u", inLen); return(-1); } } if(last) { unsigned int dgstLen; xmlSecSize dgstSize; rv = PK11_DigestFinal(ctx->digestCtx, ctx->dgst, &dgstLen, sizeof(ctx->dgst)); if(rv != SECSuccess) { xmlSecNssError("PK11_DigestFinal", xmlSecTransformGetName(transform)); return(-1); } xmlSecAssert2(dgstLen > 0, -1); XMLSEC_SAFE_CAST_UINT_TO_SIZE(dgstLen, dgstSize, return(-1), xmlSecTransformGetName(transform)); /* check/set the result digest size */ if(ctx->dgstSizeInBits == 0) { ctx->dgstSizeInBits = dgstSize * 8; /* no dgst size specified, use all we have */ } /* HMACOutputLength can only truncate the digest, not extend it past the bytes we have */ if(XMLSEC_TRANSFORM_HMAC_BITS_TO_BYTES(ctx->dgstSizeInBits) > dgstSize) { xmlSecInvalidSizeMoreThanError("HMAC output length", XMLSEC_TRANSFORM_HMAC_BITS_TO_BYTES(ctx->dgstSizeInBits), dgstSize, xmlSecTransformGetName(transform)); return(-1); } /* write results if needed */ if(transform->operation == xmlSecTransformOperationSign) { ret = xmlSecTransformHmacWriteOutput(ctx->dgst, ctx->dgstSizeInBits, dgstSize, out); if(ret < 0) { xmlSecInternalError("xmlSecTransformHmacWriteOutput", xmlSecTransformGetName(transform)); return(-1); } } transform->status = xmlSecTransformStatusFinished; } } else if(transform->status == xmlSecTransformStatusFinished) { /* the only way we can get here is if there is no input */ xmlSecAssert2(xmlSecBufferGetSize(&(transform->inBuf)) == 0, -1); } else { xmlSecInvalidTransfromStatusError(transform); return(-1); } return(0); } /* Helper macros to define the transform klass */ #define XMLSEC_NSS_HMAC_KLASS_EX(name, readNode) \ static xmlSecTransformKlass xmlSecNssHmac ## name ## Klass = { \ sizeof(xmlSecTransformKlass), /* xmlSecSize klassSize */ \ xmlSecNssHmacSize, /* xmlSecSize objSize */ \ xmlSecNameHmac ## name, /* const xmlChar* name; */ \ xmlSecHrefHmac ## name, /* const xmlChar* href; */ \ xmlSecTransformUsageSignatureMethod, /* xmlSecTransformUsage usage; */ \ xmlSecNssHmacInitialize, /* xmlSecTransformInitializeMethod initialize; */ \ xmlSecNssHmacFinalize, /* xmlSecTransformFinalizeMethod finalize; */ \ readNode, /* xmlSecTransformNodeReadMethod readNode; */ \ NULL, /* xmlSecTransformNodeWriteMethod writeNode; */ \ xmlSecNssHmacSetKeyReq, /* xmlSecTransformSetKeyReqMethod setKeyReq; */ \ xmlSecNssHmacSetKey, /* xmlSecTransformSetKeyMethod setKey; */ \ xmlSecNssHmacVerify, /* xmlSecTransformValidateMethod validate; */ \ xmlSecTransformDefaultGetDataType, /* xmlSecTransformGetDataTypeMethod getDataType; */ \ xmlSecTransformDefaultPushBin, /* xmlSecTransformPushBinMethod pushBin; */ \ xmlSecTransformDefaultPopBin, /* xmlSecTransformPopBinMethod popBin; */ \ NULL, /* xmlSecTransformPushXmlMethod pushXml; */ \ NULL, /* xmlSecTransformPopXmlMethod popXml; */ \ xmlSecNssHmacExecute, /* xmlSecTransformExecuteMethod execute; */ \ NULL, /* void* reserved0; */ \ NULL, /* void* reserved1; */ \ }; #define XMLSEC_NSS_HMAC_KLASS(name) \ XMLSEC_NSS_HMAC_KLASS_EX(name, xmlSecNssHmacNodeRead) #ifndef XMLSEC_NO_RIPEMD160 /****************************************************************************** * * HMAC Ripemd160 * *****************************************************************************/ XMLSEC_NSS_HMAC_KLASS(Ripemd160) /** * @brief The HMAC-RIPEMD160 transform klass. * @return the HMAC-RIPEMD160 transform klass. */ xmlSecTransformId xmlSecNssTransformHmacRipemd160GetKlass(void) { return(&xmlSecNssHmacRipemd160Klass); } #endif /* XMLSEC_NO_RIPEMD160 */ #ifndef XMLSEC_NO_MD5 /****************************************************************************** * * HMAC MD5 * *****************************************************************************/ XMLSEC_NSS_HMAC_KLASS(Md5) /** * @brief The HMAC-MD5 transform klass. * @return the HMAC-MD5 transform klass. */ xmlSecTransformId xmlSecNssTransformHmacMd5GetKlass(void) { return(&xmlSecNssHmacMd5Klass); } #endif /* XMLSEC_NO_MD5 */ #ifndef XMLSEC_NO_SHA1 /****************************************************************************** * * HMAC SHA1 * *****************************************************************************/ XMLSEC_NSS_HMAC_KLASS(Sha1) /** * @brief The HMAC-SHA1 transform klass. * @return the HMAC-SHA1 transform klass. */ xmlSecTransformId xmlSecNssTransformHmacSha1GetKlass(void) { return(&xmlSecNssHmacSha1Klass); } #endif /* XMLSEC_NO_SHA1 */ #ifndef XMLSEC_NO_SHA224 /****************************************************************************** * * HMAC SHA224 * *****************************************************************************/ XMLSEC_NSS_HMAC_KLASS(Sha224) /** * @brief The HMAC-SHA224 transform klass. * @return the HMAC-SHA224 transform klass. */ xmlSecTransformId xmlSecNssTransformHmacSha224GetKlass(void) { return(&xmlSecNssHmacSha224Klass); } #endif /* XMLSEC_NO_SHA224 */ #ifndef XMLSEC_NO_SHA256 /****************************************************************************** * * HMAC SHA256 * *****************************************************************************/ XMLSEC_NSS_HMAC_KLASS(Sha256) /** * @brief The HMAC-SHA256 transform klass. * @return the HMAC-SHA256 transform klass. */ xmlSecTransformId xmlSecNssTransformHmacSha256GetKlass(void) { return(&xmlSecNssHmacSha256Klass); } #endif /* XMLSEC_NO_SHA256 */ #ifndef XMLSEC_NO_SHA384 /****************************************************************************** * * HMAC SHA384 * *****************************************************************************/ XMLSEC_NSS_HMAC_KLASS(Sha384) /** * @brief The HMAC-SHA384 transform klass. * @return the HMAC-SHA384 transform klass. */ xmlSecTransformId xmlSecNssTransformHmacSha384GetKlass(void) { return(&xmlSecNssHmacSha384Klass); } #endif /* XMLSEC_NO_SHA384 */ #ifndef XMLSEC_NO_SHA512 /****************************************************************************** * * HMAC SHA512 * *****************************************************************************/ XMLSEC_NSS_HMAC_KLASS(Sha512) /** * @brief The HMAC-SHA512 transform klass. * @return the HMAC-SHA512 transform klass. */ xmlSecTransformId xmlSecNssTransformHmacSha512GetKlass(void) { return(&xmlSecNssHmacSha512Klass); } #endif /* XMLSEC_NO_SHA512 */ #endif /* XMLSEC_NO_HMAC */