123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964 |
- /* 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/.
- *
- * Copyright 2018 (c) Mark Giraud, Fraunhofer IOSB
- */
- #include <mbedtls/aes.h>
- #include <mbedtls/md.h>
- #include <mbedtls/sha1.h>
- #include <mbedtls/x509_crt.h>
- #include <mbedtls/ctr_drbg.h>
- #include <mbedtls/entropy.h>
- #include <mbedtls/entropy_poll.h>
- #include <mbedtls/error.h>
- #include "ua_plugin_pki.h"
- #include "ua_plugin_securitypolicy.h"
- #include "ua_securitypolicy_basic128rsa15.h"
- #include "ua_types.h"
- #include "ua_types_generated_handling.h"
- /* Notes:
- * mbedTLS' AES allows in-place encryption and decryption. Sow we don't have to
- * allocate temp buffers.
- * https://tls.mbed.org/discussions/generic/in-place-decryption-with-aes256-same-input-output-buffer
- */
- #define UA_SECURITYPOLICY_BASIC128RSA15_RSAPADDING_LEN 11
- #define UA_SHA1_LENGTH 20
- #define UA_SECURITYPOLICY_BASIC128RSA15_SYM_KEY_LENGTH 16
- #define UA_BASIC128RSA15_SYM_SIGNING_KEY_LENGTH 16
- #define UA_SECURITYPOLICY_BASIC128RSA15_SYM_ENCRYPTION_BLOCK_SIZE 16
- #define UA_SECURITYPOLICY_BASIC128RSA15_SYM_PLAIN_TEXT_BLOCK_SIZE 16
- #define UA_SECURITYPOLICY_BASIC128RSA15_MINASYMKEYLENGTH 128
- #define UA_SECURITYPOLICY_BASIC128RSA15_MAXASYMKEYLENGTH 256
- #define UA_LOG_MBEDERR \
- char errBuff[300]; \
- mbedtls_strerror(mbedErr, errBuff, 300); \
- UA_LOG_WARNING(securityPolicy->logger, UA_LOGCATEGORY_SECURITYPOLICY, \
- "mbedTLS returned an error: %s", errBuff); \
- #define UA_MBEDTLS_ERRORHANDLING(errorcode) \
- if(mbedErr) { \
- UA_LOG_MBEDERR \
- retval = errorcode; \
- }
- #define UA_MBEDTLS_ERRORHANDLING_RETURN(errorcode) \
- if(mbedErr) { \
- UA_LOG_MBEDERR \
- return errorcode; \
- }
- typedef struct {
- const UA_SecurityPolicy *securityPolicy;
- UA_ByteString localCertThumbprint;
- mbedtls_ctr_drbg_context drbgContext;
- mbedtls_entropy_context entropyContext;
- mbedtls_md_context_t sha1MdContext;
- mbedtls_pk_context localPrivateKey;
- } Basic128Rsa15_PolicyContext;
- typedef struct {
- Basic128Rsa15_PolicyContext *policyContext;
- UA_ByteString localSymSigningKey;
- UA_ByteString localSymEncryptingKey;
- UA_ByteString localSymIv;
- UA_ByteString remoteSymSigningKey;
- UA_ByteString remoteSymEncryptingKey;
- UA_ByteString remoteSymIv;
- mbedtls_x509_crt remoteCertificate;
- } Basic128Rsa15_ChannelContext;
- static void
- sha1(const unsigned char *input, size_t ilen, unsigned char output[20] ) {
- mbedtls_sha1_context sha1Context;
- mbedtls_sha1_init(&sha1Context);
- mbedtls_sha1_starts(&sha1Context);
- mbedtls_sha1_update(&sha1Context, input, ilen);
- mbedtls_sha1_finish(&sha1Context, output);
- mbedtls_sha1_free(&sha1Context);
- }
- /********************/
- /* AsymmetricModule */
- /********************/
- static UA_StatusCode
- asym_verify_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *message,
- const UA_ByteString *signature) {
- if(securityPolicy == NULL || message == NULL || signature == NULL || cc == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- /* Compute the sha1 hash */
- unsigned char hash[UA_SHA1_LENGTH];
- sha1(message->data, message->length, hash);
- /* Set the RSA settings */
- mbedtls_rsa_context *rsaContext = mbedtls_pk_rsa(cc->remoteCertificate.pk);
- mbedtls_rsa_set_padding(rsaContext, MBEDTLS_RSA_PKCS_V15, 0);
- /* Verify */
- int mbedErr = mbedtls_pk_verify(&cc->remoteCertificate.pk,
- MBEDTLS_MD_SHA1, hash, UA_SHA1_LENGTH,
- signature->data, signature->length);
- UA_MBEDTLS_ERRORHANDLING_RETURN(UA_STATUSCODE_BADSECURITYCHECKSFAILED);
- return UA_STATUSCODE_GOOD;
- }
- static UA_StatusCode
- asym_sign_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *message,
- UA_ByteString *signature) {
- if(securityPolicy == NULL || message == NULL || signature == NULL || cc == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- unsigned char hash[UA_SHA1_LENGTH];
- sha1(message->data, message->length, hash);
- Basic128Rsa15_PolicyContext *pc = cc->policyContext;
- mbedtls_rsa_context *rsaContext = mbedtls_pk_rsa(pc->localPrivateKey);
- mbedtls_rsa_set_padding(rsaContext, MBEDTLS_RSA_PKCS_V15, 0);
- size_t sigLen = 0;
- int mbedErr = mbedtls_pk_sign(&pc->localPrivateKey,
- MBEDTLS_MD_SHA1, hash,
- UA_SHA1_LENGTH, signature->data,
- &sigLen, mbedtls_ctr_drbg_random,
- &pc->drbgContext);
- UA_MBEDTLS_ERRORHANDLING_RETURN(UA_STATUSCODE_BADINTERNALERROR);
- return UA_STATUSCODE_GOOD;
- }
- static size_t
- asym_getLocalSignatureSize_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const Basic128Rsa15_ChannelContext *cc) {
- if(securityPolicy == NULL || cc == NULL)
- return 0;
- return mbedtls_pk_rsa(cc->policyContext->localPrivateKey)->len;
- }
- static size_t
- asym_getRemoteSignatureSize_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const Basic128Rsa15_ChannelContext *cc) {
- if(securityPolicy == NULL || cc == NULL)
- return 0;
- return mbedtls_pk_rsa(cc->remoteCertificate.pk)->len;
- }
- static UA_StatusCode
- asym_encrypt_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- Basic128Rsa15_ChannelContext *cc,
- UA_ByteString *data) {
- if(securityPolicy == NULL || cc == NULL || data == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- const size_t plainTextBlockSize = securityPolicy->asymmetricModule.cryptoModule.encryptionAlgorithm.
- getRemotePlainTextBlockSize(securityPolicy, cc);
- if(data->length % plainTextBlockSize != 0)
- return UA_STATUSCODE_BADINTERNALERROR;
- mbedtls_rsa_context *remoteRsaContext = mbedtls_pk_rsa(cc->remoteCertificate.pk);
- mbedtls_rsa_set_padding(remoteRsaContext, MBEDTLS_RSA_PKCS_V15, 0);
- UA_ByteString encrypted;
- const size_t bufferOverhead =
- UA_SecurityPolicy_getRemoteAsymEncryptionBufferLengthOverhead(securityPolicy, cc, data->length);
- UA_StatusCode retval = UA_ByteString_allocBuffer(&encrypted, data->length + bufferOverhead);
- if(retval != UA_STATUSCODE_GOOD)
- return retval;
- size_t lenDataToEncrypt = data->length;
- size_t inOffset = 0;
- size_t offset = 0;
- size_t outLength = 0;
- Basic128Rsa15_PolicyContext *pc = cc->policyContext;
- while(lenDataToEncrypt >= plainTextBlockSize) {
- int mbedErr = mbedtls_pk_encrypt(&cc->remoteCertificate.pk,
- data->data + inOffset, plainTextBlockSize,
- encrypted.data + offset, &outLength,
- encrypted.length - offset,
- mbedtls_ctr_drbg_random,
- &pc->drbgContext);
- UA_MBEDTLS_ERRORHANDLING(UA_STATUSCODE_BADINTERNALERROR);
- if(retval != UA_STATUSCODE_GOOD) {
- UA_ByteString_deleteMembers(&encrypted);
- return retval;
- }
- inOffset += plainTextBlockSize;
- offset += outLength;
- lenDataToEncrypt -= plainTextBlockSize;
- }
- memcpy(data->data, encrypted.data, offset);
- UA_ByteString_deleteMembers(&encrypted);
- return UA_STATUSCODE_GOOD;
- }
- static UA_StatusCode
- asym_decrypt_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- Basic128Rsa15_ChannelContext *cc,
- UA_ByteString *data) {
- if(securityPolicy == NULL || cc == NULL || data == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- mbedtls_rsa_context *rsaContext =
- mbedtls_pk_rsa(cc->policyContext->localPrivateKey);
- if(data->length % rsaContext->len != 0)
- return UA_STATUSCODE_BADINTERNALERROR;
- UA_ByteString decrypted;
- UA_StatusCode retval = UA_ByteString_allocBuffer(&decrypted, data->length);
- if(retval != UA_STATUSCODE_GOOD)
- return retval;
- size_t lenDataToDecrypt = data->length;
- size_t inOffset = 0;
- size_t offset = 0;
- size_t outLength = 0;
- while(lenDataToDecrypt >= rsaContext->len) {
- int mbedErr = mbedtls_pk_decrypt(&cc->policyContext->localPrivateKey,
- data->data + inOffset, rsaContext->len,
- decrypted.data + offset, &outLength,
- decrypted.length - offset, NULL, NULL);
- if(mbedErr)
- UA_ByteString_deleteMembers(&decrypted); // TODO: Maybe change error macro to jump to cleanup?
- UA_MBEDTLS_ERRORHANDLING_RETURN(UA_STATUSCODE_BADSECURITYCHECKSFAILED);
- inOffset += rsaContext->len;
- offset += outLength;
- lenDataToDecrypt -= rsaContext->len;
- }
- if(lenDataToDecrypt == 0) {
- memcpy(data->data, decrypted.data, offset);
- data->length = offset;
- } else {
- retval = UA_STATUSCODE_BADINTERNALERROR;
- }
- UA_ByteString_deleteMembers(&decrypted);
- return retval;
- }
- static size_t
- asym_getRemoteEncryptionKeyLength(const UA_SecurityPolicy *securityPolicy,
- const Basic128Rsa15_ChannelContext *cc) {
- return mbedtls_pk_get_len(&cc->remoteCertificate.pk) * 8;
- }
- static size_t
- asym_getRemoteBlockSize_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const Basic128Rsa15_ChannelContext *cc) {
- mbedtls_rsa_context *const rsaContext = mbedtls_pk_rsa(cc->remoteCertificate.pk);
- return rsaContext->len;
- }
- static size_t
- asym_getRemotePlainTextBlockSize(const UA_SecurityPolicy *securityPolicy,
- const Basic128Rsa15_ChannelContext *cc) {
- mbedtls_rsa_context *const rsaContext = mbedtls_pk_rsa(cc->remoteCertificate.pk);
- return rsaContext->len - UA_SECURITYPOLICY_BASIC128RSA15_RSAPADDING_LEN;
- }
- static UA_StatusCode
- asym_makeThumbprint_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const UA_ByteString *certificate,
- UA_ByteString *thumbprint) {
- if(securityPolicy == NULL || certificate == NULL || thumbprint == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- if(UA_ByteString_equal(certificate, &UA_BYTESTRING_NULL))
- return UA_STATUSCODE_BADINTERNALERROR;
- if(thumbprint->length != UA_SHA1_LENGTH)
- return UA_STATUSCODE_BADINTERNALERROR;
- sha1(certificate->data, certificate->length, thumbprint->data);
- return UA_STATUSCODE_GOOD;
- }
- static UA_StatusCode
- asymmetricModule_compareCertificateThumbprint_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const UA_ByteString *certificateThumbprint) {
- if(securityPolicy == NULL || certificateThumbprint == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- Basic128Rsa15_PolicyContext *pc = (Basic128Rsa15_PolicyContext *)securityPolicy->policyContext;
- if(!UA_ByteString_equal(certificateThumbprint, &pc->localCertThumbprint))
- return UA_STATUSCODE_BADCERTIFICATEINVALID;
- return UA_STATUSCODE_GOOD;
- }
- /*******************/
- /* SymmetricModule */
- /*******************/
- static void
- md_hmac(mbedtls_md_context_t *context, const UA_ByteString *key,
- const UA_ByteString *in, unsigned char out[20]) {
- mbedtls_md_hmac_starts(context, key->data, key->length);
- mbedtls_md_hmac_update(context, in->data, in->length);
- mbedtls_md_hmac_finish(context, out);
- }
- static UA_StatusCode
- sym_verify_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *message,
- const UA_ByteString *signature) {
- if(securityPolicy == NULL || cc == NULL || message == NULL || signature == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- /* Compute MAC */
- if(signature->length != UA_SHA1_LENGTH) {
- UA_LOG_ERROR(securityPolicy->logger, UA_LOGCATEGORY_SECURITYPOLICY,
- "Signature size does not have the desired size defined by the security policy");
- return UA_STATUSCODE_BADSECURITYCHECKSFAILED;
- }
- Basic128Rsa15_PolicyContext *pc =
- (Basic128Rsa15_PolicyContext *)securityPolicy->policyContext;
- unsigned char mac[UA_SHA1_LENGTH];
- md_hmac(&pc->sha1MdContext, &cc->remoteSymSigningKey, message, mac);
- /* Compare with Signature */
- if(memcmp(signature->data, mac, UA_SHA1_LENGTH) != 0)
- return UA_STATUSCODE_BADSECURITYCHECKSFAILED;
- return UA_STATUSCODE_GOOD;
- }
- static UA_StatusCode
- sym_sign_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *message,
- UA_ByteString *signature) {
- if(signature->length != UA_SHA1_LENGTH)
- return UA_STATUSCODE_BADINTERNALERROR;
- md_hmac(&cc->policyContext->sha1MdContext, &cc->localSymSigningKey,
- message, signature->data);
- return UA_STATUSCODE_GOOD;
- }
- static size_t
- sym_getSignatureSize_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const void *channelContext) {
- return UA_SHA1_LENGTH;
- }
- static size_t
- sym_getSigningKeyLength_sp_basic128rsa15(const UA_SecurityPolicy *const securityPolicy,
- const void *const channelContext) {
- return UA_BASIC128RSA15_SYM_SIGNING_KEY_LENGTH;
- }
- static size_t
- sym_getEncryptionKeyLength_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const void *channelContext) {
- return UA_SECURITYPOLICY_BASIC128RSA15_SYM_KEY_LENGTH;
- }
- static size_t
- sym_getEncryptionBlockSize_sp_basic128rsa15(const UA_SecurityPolicy *const securityPolicy,
- const void *const channelContext) {
- return UA_SECURITYPOLICY_BASIC128RSA15_SYM_ENCRYPTION_BLOCK_SIZE;
- }
- static size_t
- sym_getPlainTextBlockSize_sp_basic128rsa15(const UA_SecurityPolicy *const securityPolicy,
- const void *const channelContext) {
- return UA_SECURITYPOLICY_BASIC128RSA15_SYM_PLAIN_TEXT_BLOCK_SIZE;
- }
- static UA_StatusCode
- sym_encrypt_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const Basic128Rsa15_ChannelContext *cc,
- UA_ByteString *data) {
- if(securityPolicy == NULL || cc == NULL || data == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- if(cc->localSymIv.length !=
- securityPolicy->symmetricModule.cryptoModule.encryptionAlgorithm.getLocalBlockSize(securityPolicy, cc))
- return UA_STATUSCODE_BADINTERNALERROR;
- size_t plainTextBlockSize =
- securityPolicy->symmetricModule.cryptoModule.encryptionAlgorithm.getLocalPlainTextBlockSize(securityPolicy, cc);
- if(data->length % plainTextBlockSize != 0) {
- UA_LOG_ERROR(securityPolicy->logger, UA_LOGCATEGORY_SECURITYPOLICY,
- "Length of data to encrypt is not a multiple of the plain text block size."
- "Padding might not have been calculated appropriately.");
- return UA_STATUSCODE_BADINTERNALERROR;
- }
- /* Keylength in bits */
- unsigned int keylength = (unsigned int)(cc->localSymEncryptingKey.length * 8);
- mbedtls_aes_context aesContext;
- int mbedErr = mbedtls_aes_setkey_enc(&aesContext, cc->localSymEncryptingKey.data, keylength);
- UA_MBEDTLS_ERRORHANDLING_RETURN(UA_STATUSCODE_BADINTERNALERROR);
- UA_ByteString ivCopy;
- UA_StatusCode retval = UA_ByteString_copy(&cc->localSymIv, &ivCopy);
- if(retval != UA_STATUSCODE_GOOD)
- return retval;
- mbedErr = mbedtls_aes_crypt_cbc(&aesContext, MBEDTLS_AES_ENCRYPT, data->length,
- ivCopy.data, data->data, data->data);
- UA_MBEDTLS_ERRORHANDLING(UA_STATUSCODE_BADINTERNALERROR);
- UA_ByteString_deleteMembers(&ivCopy);
- return retval;
- }
- static UA_StatusCode
- sym_decrypt_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const Basic128Rsa15_ChannelContext *cc,
- UA_ByteString *data) {
- if(securityPolicy == NULL || cc == NULL || data == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- size_t encryptionBlockSize =
- securityPolicy->symmetricModule.cryptoModule.encryptionAlgorithm.getLocalBlockSize(securityPolicy, cc);
- if(cc->remoteSymIv.length != encryptionBlockSize)
- return UA_STATUSCODE_BADINTERNALERROR;
- if(data->length % encryptionBlockSize != 0) {
- UA_LOG_ERROR(securityPolicy->logger, UA_LOGCATEGORY_SECURITYPOLICY,
- "Length of data to decrypt is not a multiple of the encryptingBlock size.");
- return UA_STATUSCODE_BADINTERNALERROR;
- }
- unsigned int keylength = (unsigned int)(cc->remoteSymEncryptingKey.length * 8);
- mbedtls_aes_context aesContext;
- int mbedErr = mbedtls_aes_setkey_dec(&aesContext, cc->remoteSymEncryptingKey.data, keylength);
- UA_MBEDTLS_ERRORHANDLING_RETURN(UA_STATUSCODE_BADINTERNALERROR);
- UA_ByteString ivCopy;
- UA_StatusCode retval = UA_ByteString_copy(&cc->remoteSymIv, &ivCopy);
- if(retval != UA_STATUSCODE_GOOD)
- return retval;
- mbedErr = mbedtls_aes_crypt_cbc(&aesContext, MBEDTLS_AES_DECRYPT, data->length,
- ivCopy.data, data->data, data->data);
- UA_MBEDTLS_ERRORHANDLING(UA_STATUSCODE_BADINTERNALERROR);
- UA_ByteString_deleteMembers(&ivCopy);
- return retval;
- }
- static void
- swapBuffers(UA_ByteString *const bufA, UA_ByteString *const bufB) {
- UA_ByteString tmp = *bufA;
- *bufA = *bufB;
- *bufB = tmp;
- }
- static UA_StatusCode
- sym_generateKey_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const UA_ByteString *secret, const UA_ByteString *seed,
- UA_ByteString *out) {
- if(securityPolicy == NULL || secret == NULL || seed == NULL || out == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- Basic128Rsa15_PolicyContext *pc =
- (Basic128Rsa15_PolicyContext *)securityPolicy->policyContext;
- size_t hashLen = 0;
- const mbedtls_md_info_t *mdInfo = mbedtls_md_info_from_type(MBEDTLS_MD_SHA1);
- hashLen = (size_t)mbedtls_md_get_size(mdInfo);
- UA_ByteString A_and_seed;
- UA_ByteString_allocBuffer(&A_and_seed, hashLen + seed->length);
- memcpy(A_and_seed.data + hashLen, seed->data, seed->length);
- UA_ByteString ANext_and_seed;
- UA_ByteString_allocBuffer(&ANext_and_seed, hashLen + seed->length);
- memcpy(ANext_and_seed.data + hashLen, seed->data, seed->length);
- UA_ByteString A = {
- hashLen,
- A_and_seed.data
- };
- UA_ByteString ANext = {
- hashLen,
- ANext_and_seed.data
- };
- md_hmac(&pc->sha1MdContext, secret, seed, A.data);
- UA_StatusCode retval = 0;
- for(size_t offset = 0; offset < out->length; offset += hashLen) {
- UA_ByteString outSegment = {
- hashLen,
- out->data + offset
- };
- UA_Boolean bufferAllocated = UA_FALSE;
- // Not enough room in out buffer to write the hash.
- if(offset + hashLen > out->length) {
- outSegment.data = NULL;
- outSegment.length = 0;
- retval |= UA_ByteString_allocBuffer(&outSegment, hashLen);
- if(retval != UA_STATUSCODE_GOOD) {
- UA_ByteString_deleteMembers(&A_and_seed);
- UA_ByteString_deleteMembers(&ANext_and_seed);
- return retval;
- }
- bufferAllocated = UA_TRUE;
- }
- md_hmac(&pc->sha1MdContext, secret, &A_and_seed, outSegment.data);
- md_hmac(&pc->sha1MdContext, secret, &A, ANext.data);
- if(retval != UA_STATUSCODE_GOOD) {
- if(bufferAllocated)
- UA_ByteString_deleteMembers(&outSegment);
- UA_ByteString_deleteMembers(&A_and_seed);
- UA_ByteString_deleteMembers(&ANext_and_seed);
- return retval;
- }
- if(bufferAllocated) {
- memcpy(out->data + offset, outSegment.data, out->length - offset);
- UA_ByteString_deleteMembers(&outSegment);
- }
- swapBuffers(&ANext_and_seed, &A_and_seed);
- swapBuffers(&ANext, &A);
- }
- UA_ByteString_deleteMembers(&A_and_seed);
- UA_ByteString_deleteMembers(&ANext_and_seed);
- return UA_STATUSCODE_GOOD;
- }
- static UA_StatusCode
- sym_generateNonce_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- UA_ByteString *out) {
- if(securityPolicy == NULL || securityPolicy->policyContext == NULL || out == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- Basic128Rsa15_PolicyContext *data =
- (Basic128Rsa15_PolicyContext *)securityPolicy->policyContext;
- int mbedErr = mbedtls_ctr_drbg_random(&data->drbgContext, out->data, out->length);
- UA_MBEDTLS_ERRORHANDLING_RETURN(UA_STATUSCODE_BADUNEXPECTEDERROR);
- return UA_STATUSCODE_GOOD;
- }
- /*****************/
- /* ChannelModule */
- /*****************/
- /* Assumes that the certificate has been verified externally */
- static UA_StatusCode
- parseRemoteCertificate_sp_basic128rsa15(Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *remoteCertificate) {
- if(remoteCertificate == NULL || cc == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- const UA_SecurityPolicy *securityPolicy = cc->policyContext->securityPolicy;
- /* Parse the certificate */
- int mbedErr = mbedtls_x509_crt_parse(&cc->remoteCertificate, remoteCertificate->data,
- remoteCertificate->length);
- UA_MBEDTLS_ERRORHANDLING_RETURN(UA_STATUSCODE_BADSECURITYCHECKSFAILED);
- /* Check the key length */
- mbedtls_rsa_context *rsaContext = mbedtls_pk_rsa(cc->remoteCertificate.pk);
- if(rsaContext->len < UA_SECURITYPOLICY_BASIC128RSA15_MINASYMKEYLENGTH ||
- rsaContext->len > UA_SECURITYPOLICY_BASIC128RSA15_MAXASYMKEYLENGTH)
- return UA_STATUSCODE_BADCERTIFICATEUSENOTALLOWED;
- return UA_STATUSCODE_GOOD;
- }
- static void
- channelContext_deleteContext_sp_basic128rsa15(Basic128Rsa15_ChannelContext *cc) {
- UA_ByteString_deleteMembers(&cc->localSymSigningKey);
- UA_ByteString_deleteMembers(&cc->localSymEncryptingKey);
- UA_ByteString_deleteMembers(&cc->localSymIv);
- UA_ByteString_deleteMembers(&cc->remoteSymSigningKey);
- UA_ByteString_deleteMembers(&cc->remoteSymEncryptingKey);
- UA_ByteString_deleteMembers(&cc->remoteSymIv);
- mbedtls_x509_crt_free(&cc->remoteCertificate);
- UA_free(cc);
- }
- static UA_StatusCode
- channelContext_newContext_sp_basic128rsa15(const UA_SecurityPolicy *securityPolicy,
- const UA_ByteString *remoteCertificate,
- void **pp_contextData) {
- if(securityPolicy == NULL || remoteCertificate == NULL || pp_contextData == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- /* Allocate the channel context */
- *pp_contextData = UA_malloc(sizeof(Basic128Rsa15_ChannelContext));
- if(*pp_contextData == NULL)
- return UA_STATUSCODE_BADOUTOFMEMORY;
- Basic128Rsa15_ChannelContext *cc = (Basic128Rsa15_ChannelContext *)*pp_contextData;
- /* Initialize the channel context */
- cc->policyContext = (Basic128Rsa15_PolicyContext *)securityPolicy->policyContext;
- UA_ByteString_init(&cc->localSymSigningKey);
- UA_ByteString_init(&cc->localSymEncryptingKey);
- UA_ByteString_init(&cc->localSymIv);
- UA_ByteString_init(&cc->remoteSymSigningKey);
- UA_ByteString_init(&cc->remoteSymEncryptingKey);
- UA_ByteString_init(&cc->remoteSymIv);
- mbedtls_x509_crt_init(&cc->remoteCertificate);
- // TODO: this can be optimized so that we dont allocate memory before parsing the certificate
- UA_StatusCode retval = parseRemoteCertificate_sp_basic128rsa15(cc, remoteCertificate);
- if(retval != UA_STATUSCODE_GOOD) {
- channelContext_deleteContext_sp_basic128rsa15(cc);
- *pp_contextData = NULL;
- }
- return retval;
- }
- static UA_StatusCode
- channelContext_setLocalSymEncryptingKey_sp_basic128rsa15(Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *key) {
- if(key == NULL || cc == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- UA_ByteString_deleteMembers(&cc->localSymEncryptingKey);
- return UA_ByteString_copy(key, &cc->localSymEncryptingKey);
- }
- static UA_StatusCode
- channelContext_setLocalSymSigningKey_sp_basic128rsa15(Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *key) {
- if(key == NULL || cc == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- UA_ByteString_deleteMembers(&cc->localSymSigningKey);
- return UA_ByteString_copy(key, &cc->localSymSigningKey);
- }
- static UA_StatusCode
- channelContext_setLocalSymIv_sp_basic128rsa15(Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *iv) {
- if(iv == NULL || cc == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- UA_ByteString_deleteMembers(&cc->localSymIv);
- return UA_ByteString_copy(iv, &cc->localSymIv);
- }
- static UA_StatusCode
- channelContext_setRemoteSymEncryptingKey_sp_basic128rsa15(Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *key) {
- if(key == NULL || cc == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- UA_ByteString_deleteMembers(&cc->remoteSymEncryptingKey);
- return UA_ByteString_copy(key, &cc->remoteSymEncryptingKey);
- }
- static UA_StatusCode
- channelContext_setRemoteSymSigningKey_sp_basic128rsa15(Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *key) {
- if(key == NULL || cc == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- UA_ByteString_deleteMembers(&cc->remoteSymSigningKey);
- return UA_ByteString_copy(key, &cc->remoteSymSigningKey);
- }
- static UA_StatusCode
- channelContext_setRemoteSymIv_sp_basic128rsa15(Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *iv) {
- if(iv == NULL || cc == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- UA_ByteString_deleteMembers(&cc->remoteSymIv);
- return UA_ByteString_copy(iv, &cc->remoteSymIv);
- }
- static UA_StatusCode
- channelContext_compareCertificate_sp_basic128rsa15(const Basic128Rsa15_ChannelContext *cc,
- const UA_ByteString *certificate) {
- if(cc == NULL || certificate == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- const UA_SecurityPolicy *securityPolicy = cc->policyContext->securityPolicy;
- mbedtls_x509_crt cert;
- int mbedErr = mbedtls_x509_crt_parse(&cert, certificate->data, certificate->length);
- UA_MBEDTLS_ERRORHANDLING_RETURN(UA_STATUSCODE_BADSECURITYCHECKSFAILED);
- if(cert.raw.len != cc->remoteCertificate.raw.len)
- return UA_STATUSCODE_BADSECURITYCHECKSFAILED;
- if(memcmp(cert.raw.p, cc->remoteCertificate.raw.p, cert.raw.len) != 0)
- return UA_STATUSCODE_BADSECURITYCHECKSFAILED;
- return UA_STATUSCODE_GOOD;
- }
- static void
- deleteMembers_sp_basic128rsa15(UA_SecurityPolicy *securityPolicy) {
- if(securityPolicy == NULL)
- return;
- if(securityPolicy->policyContext == NULL)
- return;
- UA_ByteString_deleteMembers(&securityPolicy->localCertificate);
- /* delete all allocated members in the context */
- Basic128Rsa15_PolicyContext *pc = (Basic128Rsa15_PolicyContext *)
- securityPolicy->policyContext;
- mbedtls_ctr_drbg_free(&pc->drbgContext);
- mbedtls_entropy_free(&pc->entropyContext);
- mbedtls_pk_free(&pc->localPrivateKey);
- mbedtls_md_free(&pc->sha1MdContext);
- UA_ByteString_deleteMembers(&pc->localCertThumbprint);
- UA_LOG_DEBUG(securityPolicy->logger, UA_LOGCATEGORY_SECURITYPOLICY,
- "Deleted members of EndpointContext for sp_basic128rsa15");
- UA_free(pc);
- securityPolicy->policyContext = NULL;
- }
- static UA_StatusCode
- policyContext_newContext_sp_basic128rsa15(UA_SecurityPolicy *securityPolicy,
- const UA_ByteString localPrivateKey) {
- UA_StatusCode retval = UA_STATUSCODE_GOOD;
- if(securityPolicy == NULL)
- return UA_STATUSCODE_BADINTERNALERROR;
- Basic128Rsa15_PolicyContext *pc = (Basic128Rsa15_PolicyContext *)
- UA_malloc(sizeof(Basic128Rsa15_PolicyContext));
- securityPolicy->policyContext = (void *)pc;
- if(!pc) {
- retval = UA_STATUSCODE_BADOUTOFMEMORY;
- goto error;
- }
- /* Initialize the PolicyContext */
- memset(pc, 0, sizeof(Basic128Rsa15_PolicyContext));
- mbedtls_ctr_drbg_init(&pc->drbgContext);
- mbedtls_entropy_init(&pc->entropyContext);
- mbedtls_pk_init(&pc->localPrivateKey);
- mbedtls_md_init(&pc->sha1MdContext);
- pc->securityPolicy = securityPolicy;
- /* Initialized the message digest */
- const mbedtls_md_info_t *const mdInfo = mbedtls_md_info_from_type(MBEDTLS_MD_SHA1);
- int mbedErr = mbedtls_md_setup(&pc->sha1MdContext, mdInfo, MBEDTLS_MD_SHA1);
- UA_MBEDTLS_ERRORHANDLING(UA_STATUSCODE_BADOUTOFMEMORY);
- if(retval != UA_STATUSCODE_GOOD)
- goto error;
- /* Add the system entropy source */
- mbedErr = mbedtls_entropy_add_source(&pc->entropyContext,
- mbedtls_platform_entropy_poll, NULL, 0,
- MBEDTLS_ENTROPY_SOURCE_STRONG);
- UA_MBEDTLS_ERRORHANDLING(UA_STATUSCODE_BADSECURITYCHECKSFAILED);
- if(retval != UA_STATUSCODE_GOOD)
- goto error;
- /* Seed the RNG */
- char *personalization = "open62541-drbg";
- mbedErr = mbedtls_ctr_drbg_seed(&pc->drbgContext, mbedtls_entropy_func,
- &pc->entropyContext,
- (const unsigned char *)personalization, 14);
- UA_MBEDTLS_ERRORHANDLING(UA_STATUSCODE_BADSECURITYCHECKSFAILED);
- if(retval != UA_STATUSCODE_GOOD)
- goto error;
- /* Set the private key */
- mbedErr = mbedtls_pk_parse_key(&pc->localPrivateKey,
- localPrivateKey.data, localPrivateKey.length,
- NULL, 0);
- UA_MBEDTLS_ERRORHANDLING(UA_STATUSCODE_BADSECURITYCHECKSFAILED);
- if(retval != UA_STATUSCODE_GOOD)
- goto error;
- /* Set the local certificate thumbprint */
- retval = UA_ByteString_allocBuffer(&pc->localCertThumbprint, UA_SHA1_LENGTH);
- if(retval != UA_STATUSCODE_GOOD)
- goto error;
- retval = asym_makeThumbprint_sp_basic128rsa15(pc->securityPolicy,
- &securityPolicy->localCertificate,
- &pc->localCertThumbprint);
- if(retval != UA_STATUSCODE_GOOD)
- goto error;
- return UA_STATUSCODE_GOOD;
- error:
- UA_LOG_ERROR(securityPolicy->logger, UA_LOGCATEGORY_SECURITYPOLICY,
- "Could not create securityContext");
- if(securityPolicy->policyContext != NULL)
- deleteMembers_sp_basic128rsa15(securityPolicy);
- return retval;
- }
- UA_StatusCode
- UA_SecurityPolicy_Basic128Rsa15(UA_SecurityPolicy *policy, UA_CertificateVerification *certificateVerification,
- const UA_ByteString localCertificate, const UA_ByteString localPrivateKey,
- UA_Logger logger) {
- memset(policy, 0, sizeof(UA_SecurityPolicy));
- policy->logger = logger;
- policy->policyUri = UA_STRING("http://opcfoundation.org/UA/SecurityPolicy#Basic128Rsa15");
- UA_SecurityPolicyAsymmetricModule *const asymmetricModule = &policy->asymmetricModule;
- UA_SecurityPolicySymmetricModule *const symmetricModule = &policy->symmetricModule;
- UA_SecurityPolicyChannelModule *const channelModule = &policy->channelModule;
- /* Copy the certificate and add a NULL to the end */
- UA_StatusCode retval =
- UA_ByteString_allocBuffer(&policy->localCertificate, localCertificate.length + 1);
- if(retval != UA_STATUSCODE_GOOD)
- return retval;
- memcpy(policy->localCertificate.data, localCertificate.data, localCertificate.length);
- policy->localCertificate.data[localCertificate.length] = '\0';
- policy->localCertificate.length--;
- policy->certificateVerification = certificateVerification;
- /* AsymmetricModule */
- UA_SecurityPolicySignatureAlgorithm *asym_signatureAlgorithm =
- &asymmetricModule->cryptoModule.signatureAlgorithm;
- asym_signatureAlgorithm->uri =
- UA_STRING("http://www.w3.org/2000/09/xmldsig#rsa-sha1\0");
- asym_signatureAlgorithm->verify =
- (UA_StatusCode (*)(const UA_SecurityPolicy *, void *,
- const UA_ByteString *, const UA_ByteString *))asym_verify_sp_basic128rsa15;
- asym_signatureAlgorithm->sign =
- (UA_StatusCode (*)(const UA_SecurityPolicy *, void *,
- const UA_ByteString *, UA_ByteString *))asym_sign_sp_basic128rsa15;
- asym_signatureAlgorithm->getLocalSignatureSize =
- (size_t (*)(const UA_SecurityPolicy *, const void *))asym_getLocalSignatureSize_sp_basic128rsa15;
- asym_signatureAlgorithm->getRemoteSignatureSize =
- (size_t (*)(const UA_SecurityPolicy *, const void *))asym_getRemoteSignatureSize_sp_basic128rsa15;
- asym_signatureAlgorithm->getLocalKeyLength = NULL; // TODO: Write function
- asym_signatureAlgorithm->getRemoteKeyLength = NULL; // TODO: Write function
- UA_SecurityPolicyEncryptionAlgorithm *asym_encryptionAlgorithm =
- &asymmetricModule->cryptoModule.encryptionAlgorithm;
- asym_encryptionAlgorithm->uri = UA_STRING("TODO: ALG URI");
- asym_encryptionAlgorithm->encrypt =
- (UA_StatusCode(*)(const UA_SecurityPolicy *, void *, UA_ByteString *))asym_encrypt_sp_basic128rsa15;
- asym_encryptionAlgorithm->decrypt =
- (UA_StatusCode(*)(const UA_SecurityPolicy *, void *, UA_ByteString *))
- asym_decrypt_sp_basic128rsa15;
- asym_encryptionAlgorithm->getLocalKeyLength = NULL; // TODO: Write function
- asym_encryptionAlgorithm->getRemoteKeyLength =
- (size_t (*)(const UA_SecurityPolicy *, const void *))asym_getRemoteEncryptionKeyLength;
- asym_encryptionAlgorithm->getLocalBlockSize = NULL; // TODO: Write function
- asym_encryptionAlgorithm->getRemoteBlockSize = (size_t (*)(const UA_SecurityPolicy *,
- const void *))asym_getRemoteBlockSize_sp_basic128rsa15;
- asym_encryptionAlgorithm->getLocalPlainTextBlockSize = NULL; // TODO: Write function
- asym_encryptionAlgorithm->getRemotePlainTextBlockSize =
- (size_t (*)(const UA_SecurityPolicy *, const void *))asym_getRemotePlainTextBlockSize;
- asymmetricModule->makeCertificateThumbprint = asym_makeThumbprint_sp_basic128rsa15;
- asymmetricModule->compareCertificateThumbprint =
- asymmetricModule_compareCertificateThumbprint_sp_basic128rsa15;
- /* SymmetricModule */
- symmetricModule->generateKey = sym_generateKey_sp_basic128rsa15;
- symmetricModule->generateNonce = sym_generateNonce_sp_basic128rsa15;
- UA_SecurityPolicySignatureAlgorithm *sym_signatureAlgorithm =
- &symmetricModule->cryptoModule.signatureAlgorithm;
- sym_signatureAlgorithm->uri =
- UA_STRING("http://www.w3.org/2000/09/xmldsig#hmac-sha1\0");
- sym_signatureAlgorithm->verify =
- (UA_StatusCode (*)(const UA_SecurityPolicy *, void *, const UA_ByteString *,
- const UA_ByteString *))sym_verify_sp_basic128rsa15;
- sym_signatureAlgorithm->sign =
- (UA_StatusCode (*)(const UA_SecurityPolicy *, void *,
- const UA_ByteString *, UA_ByteString *))sym_sign_sp_basic128rsa15;
- sym_signatureAlgorithm->getLocalSignatureSize = sym_getSignatureSize_sp_basic128rsa15;
- sym_signatureAlgorithm->getRemoteSignatureSize = sym_getSignatureSize_sp_basic128rsa15;
- sym_signatureAlgorithm->getLocalKeyLength =
- (size_t (*)(const UA_SecurityPolicy *,
- const void *))sym_getSigningKeyLength_sp_basic128rsa15;
- sym_signatureAlgorithm->getRemoteKeyLength =
- (size_t (*)(const UA_SecurityPolicy *,
- const void *))sym_getSigningKeyLength_sp_basic128rsa15;
- UA_SecurityPolicyEncryptionAlgorithm *sym_encryptionAlgorithm =
- &symmetricModule->cryptoModule.encryptionAlgorithm;
- sym_encryptionAlgorithm->uri = UA_STRING("http://www.w3.org/2001/04/xmlenc#aes128-cbc");
- sym_encryptionAlgorithm->encrypt =
- (UA_StatusCode(*)(const UA_SecurityPolicy *, void *, UA_ByteString *))sym_encrypt_sp_basic128rsa15;
- sym_encryptionAlgorithm->decrypt =
- (UA_StatusCode(*)(const UA_SecurityPolicy *, void *, UA_ByteString *))sym_decrypt_sp_basic128rsa15;
- sym_encryptionAlgorithm->getLocalKeyLength = sym_getEncryptionKeyLength_sp_basic128rsa15;
- sym_encryptionAlgorithm->getRemoteKeyLength = sym_getEncryptionKeyLength_sp_basic128rsa15;
- sym_encryptionAlgorithm->getLocalBlockSize =
- (size_t (*)(const UA_SecurityPolicy *, const void *))sym_getEncryptionBlockSize_sp_basic128rsa15;
- sym_encryptionAlgorithm->getRemoteBlockSize =
- (size_t (*)(const UA_SecurityPolicy *, const void *))sym_getEncryptionBlockSize_sp_basic128rsa15;
- sym_encryptionAlgorithm->getLocalPlainTextBlockSize =
- (size_t (*)(const UA_SecurityPolicy *, const void *))sym_getPlainTextBlockSize_sp_basic128rsa15;
- sym_encryptionAlgorithm->getRemotePlainTextBlockSize =
- (size_t (*)(const UA_SecurityPolicy *, const void *))sym_getPlainTextBlockSize_sp_basic128rsa15;
- symmetricModule->secureChannelNonceLength = 16;
- // Use the same signature algorithm as the asymmetric component for certificate signing (see standard)
- policy->certificateSigningAlgorithm = policy->asymmetricModule.cryptoModule.signatureAlgorithm;
- /* ChannelModule */
- channelModule->newContext = channelContext_newContext_sp_basic128rsa15;
- channelModule->deleteContext = (void (*)(void *))
- channelContext_deleteContext_sp_basic128rsa15;
- channelModule->setLocalSymEncryptingKey = (UA_StatusCode (*)(void *, const UA_ByteString *))
- channelContext_setLocalSymEncryptingKey_sp_basic128rsa15;
- channelModule->setLocalSymSigningKey = (UA_StatusCode (*)(void *, const UA_ByteString *))
- channelContext_setLocalSymSigningKey_sp_basic128rsa15;
- channelModule->setLocalSymIv = (UA_StatusCode (*)(void *, const UA_ByteString *))
- channelContext_setLocalSymIv_sp_basic128rsa15;
- channelModule->setRemoteSymEncryptingKey = (UA_StatusCode (*)(void *, const UA_ByteString *))
- channelContext_setRemoteSymEncryptingKey_sp_basic128rsa15;
- channelModule->setRemoteSymSigningKey = (UA_StatusCode (*)(void *, const UA_ByteString *))
- channelContext_setRemoteSymSigningKey_sp_basic128rsa15;
- channelModule->setRemoteSymIv = (UA_StatusCode (*)(void *, const UA_ByteString *))
- channelContext_setRemoteSymIv_sp_basic128rsa15;
- channelModule->compareCertificate = (UA_StatusCode (*)(const void *, const UA_ByteString *))
- channelContext_compareCertificate_sp_basic128rsa15;
- policy->deleteMembers = deleteMembers_sp_basic128rsa15;
- return policyContext_newContext_sp_basic128rsa15(policy, localPrivateKey);
- }
|