aboutsummaryrefslogtreecommitdiff log msg author committer range
path: root/lib/ext/t_cose/src/t_cose_crypto.h
blob: 8c98c4896900b55c2e3d361c4fb762fec503069b (plain)
 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731  /* * t_cose_crypto.h * * Copyright 2019, Laurence Lundblade * Copyright (c) 2020, Arm Limited. All rights reserved. * * SPDX-License-Identifier: BSD-3-Clause * * See BSD-3-Clause license in README.md */ #ifndef __T_COSE_CRYPTO_H__ #define __T_COSE_CRYPTO_H__ #include "t_cose_common.h" #include "q_useful_buf.h" #include #include #include "t_cose_standard_constants.h" #ifdef __cplusplus extern "C" { #endif /** * \file t_cose_crypto.h * * \brief This defines the adaptation layer for cryptographic * functions needed by t_cose. * * This is small wrapper around the cryptographic functions to: * - Map COSE algorithm IDs to cryptographic library IDs * - Map cryptographic library errors to \ref t_cose_err_t errors * - Have inputs and outputs be \c struct \c q_useful_buf_c and * \c struct \c q_useful_buf * - Handle key selection * * An implementation must be made of these functions * for the various cryptographic libraries that are used on * various platforms and OSs. The functions are: * - t_cose_t_crypto_sig_size() * - t_cose_crypto_pub_key_sign() * - t_cose_crypto_pub_key_verify() * - t_cose_crypto_hash_start() * - t_cose_crypto_hash_update() * - t_cose_crypto_hash_finish() * * This runs entirely off of COSE-style algorithm identifiers. They * are simple integers and thus work nice as function parameters. An * initial set is defined by [COSE (RFC 8152)] * (https://tools.ietf.org/html/rfc8152). New ones can be registered * in the [IANA COSE Registry] * (https://www.iana.org/assignments/cose/cose.xhtml). Local use new * ones can also be defined (\c \#define) if what is needed is not in * the IANA registry. * * \anchor useful_buf_use * Binary data is returned to the caller using a \c struct \c * q_useful_buf to pass the buffer to receive the data and its length in * and a \c q_useful_buf_c to return the pointer and length of the * returned data. The point of this is coding hygiene. The buffer * passed in is not const as it is to be modified. The \c * q_useful_buf_c returned is const. The lengths of buffers are * handled in a clear, consistent and enforced manner. * * The pointer in the \c q_useful_buf_c will always point to the * buffer passed in via the \c q_useful_buf so the lifetime of the * data is under control of the caller. * * This is not intended as any sort of general cryptographic API. It * is just the functions needed by t_cose in the form that is most * useful for t_cose. * * No other file in t_cose should need modification for new algorithms, * new key types and sizes or the integration of cryptographic libraries * except on some occasions, this file as follows: * * - Support for a new COSE_ALGORITHM_XXX signature algorithm * - See t_cose_algorithm_is_ecdsa() * - If not ECDSA add another function like t_cose_algorithm_is_ecdsa() * - Support for a new COSE_ALGORITHM_XXX signature algorithm is added * - See \ref T_COSE_CRYPTO_MAX_HASH_SIZE for additional hashes * - Support larger key sizes (and thus signature sizes) * - See \ref T_COSE_MAX_SIG_SIZE * - Support another hash implementation that is not a service * - See struct \ref t_cose_crypto_hash * * To reduce stack usage and save a little code these can be defined. * - T_COSE_DISABLE_ES384 * - T_COSE_DISABLE_ES512 * * The actual code that implements these hashes in the crypto library may * or may not be saved with these defines depending on how the library * works, whether dead stripping of object code is on and such. */ #define T_COSE_EC_P256_SIG_SIZE 64 /* size for secp256r1 */ #define T_COSE_EC_P384_SIG_SIZE 96 /* size for secp384r1 */ #define T_COSE_EC_P512_SIG_SIZE 132 /* size for secp521r1 */ /** * There is a stack variable to hold the output of the signing * operation. This sets the maximum signature size this code can * handle based on the COSE algorithms configured. The size of the * signature goes with the size of the key, not the algorithm, so a * key could be given for signing or verification that is larger than * this. However, it is not typical to do so. If the key or signature * is too large the failure will be graceful with an error. * * For ECDSA the signature format used is defined in RFC 8152 section * 8.1. It is the concatenation of r and s, each of which is the key * size in bits rounded up to the nearest byte. That is twice the key * size in bytes. */ #ifndef T_COSE_DISABLE_ES512 #define T_COSE_MAX_SIG_SIZE T_COSE_EC_P512_SIG_SIZE #else #ifndef T_COSE_DISABLE_ES384 #define T_COSE_MAX_SIG_SIZE T_COSE_EC_P384_SIG_SIZE #else #define T_COSE_MAX_SIG_SIZE T_COSE_EC_P256_SIG_SIZE #endif #endif /** * \brief Returns the size of a signature given the key and algorithm. * * \param[in] cose_algorithm_id The algorithm ID * \param[in] signing_key Key to compute size of * \param[out] sig_size The returned size in bytes. * * \return An error code or \ref T_COSE_SUCCESS. * * This is used the caller wishes to compute the size of a token in * order to allocate memory for it. * * The size of a signature depends primarily on the key size but it is * usually necessary to know the algorithm too. * * This always returns the exact size of the signature. */ enum t_cose_err_t t_cose_crypto_sig_size(int32_t cose_algorithm_id, struct t_cose_key signing_key, size_t *sig_size); /** * \brief Perform public key signing. Part of the t_cose crypto * adaptation layer. * * \param[in] cose_algorithm_id The algorithm to sign with. The IDs are * defined in [COSE (RFC 8152)] * (https://tools.ietf.org/html/rfc8152) or * in the [IANA COSE Registry] * (https://www.iana.org/assignments/cose/cose.xhtml). * A proprietary ID can also be defined * locally (\c \#define) if the needed * one hasn't been registered. * \param[in] signing_key Indicates or contains key to sign with. * \param[in] hash_to_sign The bytes to sign. Typically, a hash of * a payload. * \param[in] signature_buffer Pointer and length of buffer into which * the resulting signature is put. * \param[in] signature Pointer and length of the signature * returned. * * \retval T_COSE_SUCCESS * Successfully created the signature. * \retval T_COSE_ERR_SIG_BUFFER_SIZE * The \c signature_buffer too small. * \retval T_COSE_ERR_UNSUPPORTED_SIGNING_ALG * The requested signing algorithm, \c cose_algorithm_id, is not * supported. * \retval T_COSE_ERR_UNKNOWN_KEY * The key identified by \c key_select was not found. * \retval T_COSE_ERR_WRONG_TYPE_OF_KEY * The key was found, but it was the wrong type. * \retval T_COSE_ERR_INVALID_ARGUMENT * Some (unspecified) argument was not valid. * \retval T_COSE_ERR_INSUFFICIENT_MEMORY * Insufficient heap memory. * \retval T_COSE_ERR_FAIL * General unspecific failure. * \retval T_COSE_ERR_TAMPERING_DETECTED * Equivalent to \c PSA_ERROR_TAMPERING_DETECTED. * * This is called to do public key signing. The implementation will * vary from one platform / OS to another but should conform to the * description here. * * The contents of signing_key is usually the type that holds * a key for the cryptographic library. * * See the note in the Detailed Description (the \\file comment block) * for details on how \c q_useful_buf and \c q_useful_buf_c are used * to return the signature. * * To find out the size of the signature buffer needed, call this with * \c signature_buffer->ptr \c NULL and \c signature_buffer->len a * very large number like \c UINT32_MAX. The size will be returned in * \c signature->len. */ enum t_cose_err_t t_cose_crypto_pub_key_sign(int32_t cose_algorithm_id, struct t_cose_key signing_key, struct q_useful_buf_c hash_to_sign, struct q_useful_buf signature_buffer, struct q_useful_buf_c *signature); /** * \brief Perform public key signature verification. Part of the * t_cose crypto adaptation layer. * * \param[in] cose_algorithm_id The algorithm to use for verification. * The IDs are defined in [COSE (RFC 8152)] * (https://tools.ietf.org/html/rfc8152) * or in the [IANA COSE Registry] * (https://www.iana.org/assignments/cose/cose.xhtml). * A proprietary ID can also be defined * locally (\c \#define) if the needed one * hasn't been registered. * \param[in] verification_key The verification key to use. * \param[in] kid The COSE kid (key ID) or \c NULL_Q_USEFUL_BUF_C. * \param[in] hash_to_verify The data or hash that is to be verified. * \param[in] signature The signature. * * This verifies that the \c signature passed in was over the \c * hash_to_verify passed in. * * The public key used to verify the signature is selected by the \c * kid if it is not \c NULL_Q_USEFUL_BUF_C or the \c key_select if it * is. * * The key selected must be, or include, a public key of the correct * type for \c cose_algorithm_id. * * \retval T_COSE_SUCCESS * The signature is valid * \retval T_COSE_ERR_SIG_VERIFY * Signature verification failed. For example, the * cryptographic operations completed successfully but hash * wasn't as expected. * \retval T_COSE_ERR_UNKNOWN_KEY * The key identified by \c key_select or a \c kid was * not found. * \retval T_COSE_ERR_WRONG_TYPE_OF_KEY * The key was found, but it was the wrong type * for the operation. * \retval T_COSE_ERR_UNSUPPORTED_SIGNING_ALG * The requested signing algorithm is not supported. * \retval T_COSE_ERR_INVALID_ARGUMENT * Some (unspecified) argument was not valid. * \retval T_COSE_ERR_INSUFFICIENT_MEMORY * Out of heap memory. * \retval T_COSE_ERR_FAIL * General unspecific failure. * \retval T_COSE_ERR_TAMPERING_DETECTED * Equivalent to \c PSA_ERROR_TAMPERING_DETECTED. */ enum t_cose_err_t t_cose_crypto_pub_key_verify(int32_t cose_algorithm_id, struct t_cose_key verification_key, struct q_useful_buf_c kid, struct q_useful_buf_c hash_to_verify, struct q_useful_buf_c signature); #ifdef T_COSE_USE_PSA_CRYPTO #include "psa/crypto.h" #elif T_COSE_USE_OPENSSL_CRYPTO #include "openssl/sha.h" #elif T_COSE_USE_B_CON_SHA256 /* This is code for use with Brad Conte's crypto. See * https://github.com/B-Con/crypto-algorithms and see the description * of t_cose_crypto_hash */ #include "sha256.h" #endif /** * The context for use with the hash adaptation layer here. * * Hash implementations for this porting layer are put into two * different categories. * * The first can be supported generically without any dependency on * the actual hash implementation in this header. These only need a * pointer or handle for the hash context. Usually these are * implemented by a service, system API or crypto HW that runs in a * separate context or process. They probably allocate memory * internally. These can use context.ptr or context.handle to hold the * pointer or handle to the hash context. * * The second sort of hash implementations need more than just a * pointer or handle. Typically these are libraries that are linked * with this code and run in the same process / context / thread as * this code. These can be efficient requiring no context switches or * memory allocations. These type require this header be modified for * the #include which defines the hash context and so this struct * includes that context as a member. This context is allocated on the * stack, so any members added here should be small enough to go on * the stack. USE_B_CON_SHA256 is an example of this type. * * The actual implementation of the hash is in a separate .c file * that will be specific to the particular platform, library, * service or such used. */ struct t_cose_crypto_hash { #ifdef T_COSE_USE_PSA_CRYPTO /* --- The context for PSA Crypto (MBed Crypto) --- */ /* psa_hash_operation_t actually varied by the implementation of * the crypto library. Sometimes the implementation is inline and * thus the context is a few hundred bytes, sometimes it is not. * This varies by what is in crypto_struct.h (which is not quite * a public interface). * * This can be made smaller for PSA implementations that work inline * by disabling the larger algorithms using PSA / MBed configuration. */ psa_hash_operation_t ctx; psa_status_t status; #elif T_COSE_USE_OPENSSL_CRYPTO /* --- The context for PSA Crypto (MBed Crypto) --- */ /* What is needed for a full proper integration of OpenSSL's hashes */ union { SHA256_CTX sha_256; #if !defined T_COSE_DISABLE_ES512 || !defined T_COSE_DISABLE_ES384 /* SHA 384 uses the sha_512 context * This uses about 100 bytes above SHA-256 */ SHA512_CTX sha_512; #endif } ctx; int update_error; /* Used to track error return by SHAXXX_Upate() */ int32_t cose_hash_alg_id; /* COSE integer ID for the hash alg */ #elif T_COSE_USE_B_CON_SHA256 /* --- Specific context for Brad Conte's sha256.c --- */ SHA256_CTX b_con_hash_context; #else /* --- Default: generic pointer / handle --- */ union { void *ptr; uint64_t handle; } context; int64_t status; #endif }; /** * The context for use with the HMAC adaptation layer here. * Borrow the structure of t_cose_crypto_hash. */ struct t_cose_crypto_hmac { #ifdef T_COSE_USE_PSA_CRYPTO /* --- The context for PSA Crypto (MBed Crypto) --- */ psa_mac_operation_t op_ctx; #else /* --- Default: generic pointer / handle --- */ union { void *ptr; uint64_t handle; } context; int64_t status; #endif }; /** * The size of the output of SHA-256. * * (It is safe to define these independently here as they are * well-known and fixed. There is no need to reference * platform-specific headers and incur messy dependence.) */ #define T_COSE_CRYPTO_SHA256_SIZE 32 /** * The size of the output of SHA-384 in bytes. */ #define T_COSE_CRYPTO_SHA384_SIZE 48 /** * The size of the output of SHA-512 in bytes. */ #define T_COSE_CRYPTO_SHA512_SIZE 64 /** * Size of the signature (tag) output for the HMAC-SHA256. */ #define T_COSE_CRYPTO_HMAC256_TAG_SIZE T_COSE_CRYPTO_SHA256_SIZE /** * Size of the signature (tag) output for the HMAC-SHA384. */ #define T_COSE_CRYPTO_HMAC384_TAG_SIZE T_COSE_CRYPTO_SHA384_SIZE /** * Size of the signature (tag) output for the HMAC-SHA512. */ #define T_COSE_CRYPTO_HMAC512_TAG_SIZE T_COSE_CRYPTO_SHA512_SIZE /** * Max size of the tag output for the HMAC operations. */ #define T_COSE_CRYPTO_HMAC_TAG_MAX_SIZE T_COSE_CRYPTO_SHA512_SIZE /** * The maximum needed to hold a hash. It is smaller and less stack is used * if the larger hashes are disabled. */ #ifndef T_COSE_DISABLE_ES512 #define T_COSE_CRYPTO_MAX_HASH_SIZE T_COSE_CRYPTO_SHA512_SIZE #else #ifndef T_COSE_DISABLE_ES384 #define T_COSE_CRYPTO_MAX_HASH_SIZE T_COSE_CRYPTO_SHA384_SIZE #else #define T_COSE_CRYPTO_MAX_HASH_SIZE T_COSE_CRYPTO_SHA256_SIZE #endif #endif /** * \brief Start cryptographic hash. Part of the t_cose crypto * adaptation layer. * * \param[in,out] hash_ctx Pointer to the hash context that * will be initialized. * \param[in] cose_hash_alg_id Algorithm ID that identifies the * hash to use. This is from the * [IANA COSE Registry] * (https://www.iana.org/assignments/cose/cose.xhtml) * * \retval T_COSE_ERR_UNSUPPORTED_HASH * The requested algorithm is unknown or unsupported. * * \retval T_COSE_ERR_HASH_GENERAL_FAIL * Some general failure of the hash function * * \retval T_COSE_SUCCESS * Success. * * This initializes the hash context for the particular algorithm. It * must be called first. A \c hash_ctx can be reused if it is * reinitialized. * * \ref T_COSE_INVALID_ALGORITHM_ID may be passed to this function, in which * case \ref T_COSE_ERR_UNSUPPORTED_HASH must be returned. * * Other errors can be returned and will usually be propagated up, but hashes * generally don't fail so it is suggested not to bother (and to reduce * object code size for mapping errors). */ enum t_cose_err_t t_cose_crypto_hash_start(struct t_cose_crypto_hash *hash_ctx, int32_t cose_hash_alg_id); /** * \brief Feed data into a cryptographic hash. Part of the t_cose * crypto adaptation layer. * * \param[in,out] hash_ctx Pointer to the hash context in which * accumulate the hash. * \param[in] data_to_hash Pointer and length of data to feed into * hash. The pointer may by \c NULL in which * case no hashing is performed. * * There is no return value. If an error occurs it is remembered in \c * hash_ctx and returned when t_cose_crypto_hash_finish() is called. * Once in the error state, this function may be called, but it will * not do anything. * * This function can be called with \c data_to_hash.ptr NULL and it * will pretend to hash. This allows the same code that is used to * produce the real hash to be used to return a length of the would-be * hash for encoded data structure size calculations. */ void t_cose_crypto_hash_update(struct t_cose_crypto_hash *hash_ctx, struct q_useful_buf_c data_to_hash); /** * \brief Finish a cryptographic hash. Part of the t_cose crypto * adaptation layer. * * \param[in,out] hash_ctx Pointer to the hash context. * \param[in] buffer_to_hold_result Pointer and length into which * the resulting hash is put. * \param[out] hash_result Pointer and length of the * resulting hash. * * \retval T_COSE_ERR_HASH_GENERAL_FAIL * Some general failure of the hash function. * \retval T_COSE_ERR_HASH_BUFFER_SIZE * The size of the buffer to hold the hash result was * too small. * \retval T_COSE_SUCCESS * Success. * * Call this to complete the hashing operation. If the everything * completed correctly, the resulting hash is returned. Note that any * errors that occurred during t_cose_crypto_hash_update() are * returned here. * * See \ref useful_buf_use for details on how \c q_useful_buf and * \c q_useful_buf_c are used to return the hash. * * Other errors can be returned and will usually be propagated up, but * hashes generally don't fail so it is suggested not to bother (and * to reduce object code size for mapping errors). */ enum t_cose_err_t t_cose_crypto_hash_finish(struct t_cose_crypto_hash *hash_ctx, struct q_useful_buf buffer_to_hold_result, struct q_useful_buf_c *hash_result); /** * \brief Set up a multipart HMAC calculation operation * * \param[in,out] hmac_ctx Pointer to the HMAC context. * \param[in] signing_key The key for the HMAC operation * \param[in] cose_alg_id The algorithm used in HMAC. * * \retval T_COSE_SUCCESS * Tag calculation succeeds. * \retval T_COSE_ERR_UNSUPPORTED_SIGNING_ALG * The algorithm is unsupported. * \retval T_COSE_ERR_INVALID_ARGUMENT * Invalid arguments. * \retval T_COSE_ERR_FAIL * Some general failure of the HMAC function. */ enum t_cose_err_t t_cose_crypto_hmac_sign_setup(struct t_cose_crypto_hmac *hmac_ctx, struct t_cose_key signing_key, const int32_t cose_alg_id); /** * \brief Add a message fragment to a multipart HMAC operation * * \param[in,out] hmac_ctx Pointer to the HMAC context. * \param[in] payload Pointer and length of payload * * \retval T_COSE_SUCCESS * Tag calculation succeeds. * \retval T_COSE_ERR_SIG_BUFFER_SIZE * The size of the buffer to hold the tag result was too small. * \retval T_COSE_ERR_INVALID_ARGUMENT * Invalid arguments. * \retval T_COSE_ERR_FAIL * Some general failure of the HMAC function. */ enum t_cose_err_t t_cose_crypto_hmac_update(struct t_cose_crypto_hmac *hmac_ctx, struct q_useful_buf_c payload); /** * \brief Finish the calculation of the HMAC of a message. * * \param[in,out] hmac_ctx Pointer to the HMAC context. * \param[in] tag_buf Pointer and length into which * the resulting tag is put. * \param[out] tag Pointer and length of the * resulting tag. * * \retval T_COSE_SUCCESS * Tag calculation succeeds. * \retval T_COSE_ERR_SIG_BUFFER_SIZE * The size of the buffer to hold the tag result was too small. * \retval T_COSE_ERR_INVALID_ARGUMENT * Invalid arguments. * \retval T_COSE_ERR_FAIL * Some general failure of the HMAC function. */ enum t_cose_err_t t_cose_crypto_hmac_sign_finish(struct t_cose_crypto_hmac *hmac_ctx, struct q_useful_buf tag_buf, struct q_useful_buf_c *tag); /** * \brief Set up a multipart HMAC verification operation * * \param[in,out] hmac_ctx Pointer to the HMAC context. * \param[in] cose_alg_id The algorithm used in HMAC. * \param[in] verify_key Key for HMAC verification * * \retval T_COSE_SUCCESS * Operation succeeds. * \retval T_COSE_ERR_UNSUPPORTED_SIGNING_ALG * The algorithm is unsupported. * \retval T_COSE_ERR_INVALID_ARGUMENT * Invalid arguments. * \retval T_COSE_ERR_FAIL * Some general failure of the HMAC function. */ enum t_cose_err_t t_cose_crypto_hmac_verify_setup(struct t_cose_crypto_hmac *hmac_ctx, const int cose_alg_id, struct t_cose_key verify_key); /** * \brief Finish the verification of the HMAC of a message. * * \param[in,out] hmac_ctx Pointer to the HMAC context. * \param[in] tag Pointer and length of the tag. * * \retval T_COSE_SUCCESS * Tag calculation succeeds. * \retval T_COSE_ERR_INVALID_ARGUMENT * Invalid arguments. * \retval T_COSE_ERR_FAIL * Some general failure of the HMAC function. * \retval PSA_ERROR_INVALID_SIGNATURE * HMAC verification failed. */ enum t_cose_err_t t_cose_crypto_hmac_verify_finish(struct t_cose_crypto_hmac *hmac_ctx, struct q_useful_buf_c tag); /** * \brief Indicate whether a COSE algorithm is ECDSA or not. * * \param[in] cose_algorithm_id The algorithm ID to check. * * \returns This returns \c true if the algorithm is ECDSA and \c false if not. * * This is a convenience function to check whether a given * integer COSE algorithm ID uses the ECDSA signing algorithm * or not. * * (As other types of signing algorithms are added, RSA for example, * a similar function can be added for them.) */ static bool t_cose_algorithm_is_ecdsa(int32_t cose_algorithm_id); /* * Inline implementations. See documentation above. */ /** * \brief Look for an integer in a zero-terminated list of integers. * * \param[in] cose_algorithm_id The algorithm ID to check. * \param[in] list zero-terminated list of algorithm IDs. * * \returns This returns \c true if an integer is in the list, \c false if not. * * Used to implement t_cose_algorithm_is_ecdsa() and in the future * _is_rsa() and such. * * Typically used once in the crypto adaptation layer, so defining it * inline rather than in a .c file is OK and saves creating a whole * new .c file just for this. */ static inline bool t_cose_check_list(int32_t cose_algorithm_id, const int32_t *list) { while(*list) { if(*list == cose_algorithm_id) { return true; } list++; } return false; } static inline bool t_cose_algorithm_is_ecdsa(int32_t cose_algorithm_id) { /* The simple list of COSE alg IDs that use ECDSA */ static const int32_t ecdsa_list[] = { COSE_ALGORITHM_ES256, #ifndef T_COSE_DISABLE_ES384 COSE_ALGORITHM_ES384, #endif #ifndef T_COSE_DISABLE_ES512 COSE_ALGORITHM_ES512, #endif 0}; /* 0 is a reserved COSE alg ID ans will never be used */ return t_cose_check_list(cose_algorithm_id, ecdsa_list); } static inline size_t t_cose_tag_size(int32_t cose_alg_id) { switch(cose_alg_id) { case T_COSE_ALGORITHM_HMAC256: return T_COSE_CRYPTO_HMAC256_TAG_SIZE; case T_COSE_ALGORITHM_HMAC384: return T_COSE_CRYPTO_HMAC384_TAG_SIZE; case T_COSE_ALGORITHM_HMAC512: return T_COSE_CRYPTO_HMAC512_TAG_SIZE; default: return INT32_MAX; } } #ifdef __cplusplus } #endif #endif /* __T_COSE_CRYPTO_H__ */