t_cose_common.h

Go to the documentation of this file.

/*
 * t_cose_common.h
 *
 * Copyright 2019-2024, Laurence Lundblade
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * See BSD-3-Clause license in README.md
 */
 
 
#ifndef __T_COSE_COMMON_H__
#define __T_COSE_COMMON_H__
 
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
#define T_COSE_VERSION_MAJOR 1
#define T_COSE_VERSION_MINOR 1
#define T_COSE_VERSION_PATCH 2
 
 
#define T_COSE_ALGORITHM_ES256 -7
 
#define T_COSE_ALGORITHM_EDDSA -8
 
#define T_COSE_ALGORITHM_ES384 -35
 
#define T_COSE_ALGORITHM_ES512 -36
 
#define T_COSE_ALGORITHM_PS256 -37
 
#define T_COSE_ALGORITHM_PS384 -38
 
#define T_COSE_ALGORITHM_PS512 -39
 
 
 
 
enum t_cose_crypto_lib_t {
    T_COSE_CRYPTO_LIB_UNIDENTIFIED = 0,
    T_COSE_CRYPTO_LIB_OPENSSL = 1,
    T_COSE_CRYPTO_LIB_PSA = 2
};
 
 
struct t_cose_key {
    enum t_cose_crypto_lib_t crypto_lib;
    union {
        void *key_ptr;
        uint64_t key_handle;
    } k;
};
 
 
/*
 * This has to be definied differently in C than C++ because there is
 * no common construct for a literal structure.
 *
 * In C compound literals are used.
 *
 * In C++ list initalization is used. This only works
 * in C++11 and later.
 *
 * Note that some popular C++ compilers can handle compound
 * literals with on-by-default extensions, however
 * this code aims for full correctness with strict
 * compilers so they are not used.
 */
#ifdef __cplusplus
#define T_COSE_NULL_KEY {T_COSE_CRYPTO_LIB_UNIDENTIFIED, {0}}
#else
#define T_COSE_NULL_KEY \
    ((struct t_cose_key){T_COSE_CRYPTO_LIB_UNIDENTIFIED, {0}})
#endif
 
 
/* Private value. Intentionally not documented for Doxygen.  This is
 * the size allocated for the encoded protected header parameters.  It
 * needs to be big enough for encode_protected_parameters() to
 * succeed. It currently sized for one parameter with an algorithm ID
 * up to 32 bits long -- one byte for the wrapping map, one byte for
 * the label, 5 bytes for the ID. If this is made accidentally too
 * small, QCBOR will only return an error, and not overrun any
 * buffers.
 *
 * 17 extra bytes are added, rounding it up to 24 total, in case some
 * other protected header parameter is to be added and so the test
 * using T_COSE_TEST_CRIT_PARAMETER_EXIST can work.
 */
#define T_COSE_SIGN1_MAX_SIZE_PROTECTED_PARAMETERS (1+1+5+17)
 
 
/*
 * Do not reorder these. It is OK to add new ones at the end.
 *
 * Explicit values are included because some tools like debuggers show
 * only the value, not the symbol, and it is hard to count up through
 * 35 lines to figure out the actual value.
 */
enum t_cose_err_t {
    T_COSE_SUCCESS = 0,
 
    T_COSE_ERR_UNSUPPORTED_SIGNING_ALG = 1,
 
    T_COSE_ERR_MAKING_PROTECTED = 2,
 
    T_COSE_ERR_UNSUPPORTED_HASH = 3,
 
    T_COSE_ERR_HASH_GENERAL_FAIL = 4,
 
    T_COSE_ERR_HASH_BUFFER_SIZE = 5,
 
    T_COSE_ERR_SIG_BUFFER_SIZE = 6,
 
    T_COSE_ERR_SIGN1_FORMAT = 8,
 
    T_COSE_ERR_CBOR_NOT_WELL_FORMED = 9,
 
    T_COSE_ERR_PARAMETER_CBOR = 10,
 
    T_COSE_ERR_NO_ALG_ID = 11,
 
    T_COSE_ERR_NO_KID = 12,
 
    T_COSE_ERR_SIG_VERIFY = 13,
 
    T_COSE_ERR_BAD_SHORT_CIRCUIT_KID = 14,
 
    T_COSE_ERR_INVALID_ARGUMENT = 15,
 
    T_COSE_ERR_INSUFFICIENT_MEMORY = 16,
 
    T_COSE_ERR_FAIL = 17,
 
    T_COSE_ERR_TAMPERING_DETECTED = 18,
 
    T_COSE_ERR_UNKNOWN_KEY = 19,
 
    T_COSE_ERR_WRONG_TYPE_OF_KEY = 20,
 
    T_COSE_ERR_SIG_STRUCT = 21,
 
    T_COSE_ERR_SHORT_CIRCUIT_SIG = 22,
 
    T_COSE_ERR_SIG_FAIL = 23,
 
    T_COSE_ERR_CBOR_FORMATTING = 24,
 
    T_COSE_ERR_TOO_SMALL = 25,
 
    T_COSE_ERR_TOO_MANY_PARAMETERS = 26,
 
    T_COSE_ERR_UNKNOWN_CRITICAL_PARAMETER = 27,
 
    T_COSE_ERR_SHORT_CIRCUIT_SIG_DISABLED = 28,
 
    T_COSE_ERR_INCORRECT_KEY_FOR_LIB = 29,
 
    T_COSE_ERR_NON_INTEGER_ALG_ID = 30,
 
    T_COSE_ERR_BAD_CONTENT_TYPE = 31,
 
    T_COSE_ERR_INCORRECTLY_TAGGED = 32,
 
    T_COSE_ERR_EMPTY_KEY = 33,
 
    T_COSE_ERR_DUPLICATE_PARAMETER = 34,
 
    T_COSE_ERR_PARAMETER_NOT_PROTECTED = 35,
 
    T_COSE_ERR_CRIT_PARAMETER = 36,
 
    T_COSE_ERR_TOO_MANY_TAGS = 37,
 
    T_COSE_ERR_NEED_AUXILIARY_BUFFER = 38,
 
    T_COSE_ERR_AUXILIARY_BUFFER_SIZE = 39,
};
 
 
 
 
#define T_COSE_PARAMETER_LIST_MAX 10
 
 
 
#define T_COSE_EMPTY_UINT_CONTENT_TYPE UINT16_MAX+1
 
bool
t_cose_is_algorithm_supported(int32_t cose_algorithm_id);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* __T_COSE_COMMON_H__ */