t_cose_sign1_sign.h

Go to the documentation of this file.

/*
 * t_cose_sign1_sign.h
 *
 * Copyright (c) 2018-2021, Laurence Lundblade. All rights reserved.
 * Copyright (c) 2020, Michael Eckel
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * See BSD-3-Clause license in README.md
 */
 
#ifndef __T_COSE_SIGN1_H__
#define __T_COSE_SIGN1_H__
 
#include <stdint.h>
#include <stdbool.h>
#include "qcbor/qcbor.h"
#include "t_cose/q_useful_buf.h"
#include "t_cose/t_cose_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
struct t_cose_sign1_sign_ctx {
    /* Private data structure */
    struct q_useful_buf_c protected_parameters; /* Encoded protected paramssy */
    int32_t               cose_algorithm_id;
    struct t_cose_key     signing_key;
    uint32_t              option_flags;
    struct q_useful_buf_c kid;
#ifndef T_COSE_DISABLE_CONTENT_TYPE
    uint32_t              content_type_uint;
    const char *          content_type_tstr;
#endif
 
#ifndef T_COSE_DISABLE_EDDSA
    struct q_useful_buf  auxiliary_buffer;
 
    /* The size of the serialized Sig_Structure used in the last
     * signing operation. This can be used by the user to determine
     * a suitable auxiliary buffer size.
     */
    size_t               auxiliary_buffer_size;
#endif
};
 
 
#define T_COSE_OPT_SHORT_CIRCUIT_SIG 0x00000001
 
 
#define T_COSE_OPT_OMIT_CBOR_TAG 0x00000002
 
 
static void
t_cose_sign1_sign_init(struct t_cose_sign1_sign_ctx *context,
                       uint32_t                      option_flags,
                       int32_t                       cose_algorithm_id);
 
 
static void
t_cose_sign1_set_signing_key(struct t_cose_sign1_sign_ctx *context,
                             struct t_cose_key             signing_key,
                             struct q_useful_buf_c         kid);
 
static void
t_cose_sign1_sign_set_auxiliary_buffer(struct t_cose_sign1_sign_ctx *context,
                                       struct q_useful_buf           auxiliary_buffer);
 
static size_t
t_cose_sign1_sign_auxiliary_buffer_size(struct t_cose_sign1_sign_ctx *context);
 
 
 
#ifndef T_COSE_DISABLE_CONTENT_TYPE
static inline void
t_cose_sign1_set_content_type_uint(struct t_cose_sign1_sign_ctx *context,
                                   uint16_t                      content_type);
 
static inline void
t_cose_sign1_set_content_type_tstr(struct t_cose_sign1_sign_ctx *context,
                                   const char                   *content_type);
#endif /* T_COSE_DISABLE_CONTENT_TYPE */
 
 
 
static enum t_cose_err_t
t_cose_sign1_sign(struct t_cose_sign1_sign_ctx *context,
                  struct q_useful_buf_c         payload,
                  struct q_useful_buf           out_buf,
                  struct q_useful_buf_c        *result);
 
 
static enum t_cose_err_t
t_cose_sign1_sign_aad(struct t_cose_sign1_sign_ctx *context,
                      struct q_useful_buf_c         aad,
                      struct q_useful_buf_c         payload,
                      struct q_useful_buf           out_buf,
                      struct q_useful_buf_c        *result);
 
 
static enum t_cose_err_t
t_cose_sign1_sign_detached(struct t_cose_sign1_sign_ctx *context,
                           struct q_useful_buf_c         aad,
                           struct q_useful_buf_c         detached_payload,
                           struct q_useful_buf           out_buf,
                           struct q_useful_buf_c        *result);
 
 
 
static enum t_cose_err_t
t_cose_sign1_encode_parameters(struct t_cose_sign1_sign_ctx *context,
                               QCBOREncodeContext           *cbor_encode_ctx);
 
 
static enum t_cose_err_t
t_cose_sign1_encode_signature(struct t_cose_sign1_sign_ctx *context,
                              QCBOREncodeContext           *cbor_encode_ctx);
 
 
static inline enum t_cose_err_t
t_cose_sign1_encode_signature_aad(struct t_cose_sign1_sign_ctx *context,
                                  struct q_useful_buf_c         aad,
                                  QCBOREncodeContext          *cbor_encode_ctx);
 
 
 
 
 
 
/* ------------------------------------------------------------------------
 * Inline implementations of public functions defined above.
 */
static inline void
t_cose_sign1_sign_init(struct t_cose_sign1_sign_ctx *me,
                       uint32_t                      option_flags,
                       int32_t                       cose_algorithm_id)
{
    memset(me, 0, sizeof(*me));
#ifndef T_COSE_DISABLE_CONTENT_TYPE
    me->content_type_uint = T_COSE_EMPTY_UINT_CONTENT_TYPE;
#endif
 
    me->cose_algorithm_id = cose_algorithm_id;
    me->option_flags      = option_flags;
 
#ifndef T_COSE_DISABLE_EDDSA
    /* Start with large (but NULL) auxiliary buffer. If EdDSA is used,
     * the Sig_Structure data will be serialized here.
     */
    me->auxiliary_buffer.len = SIZE_MAX;
#endif
}
 
 
static inline void
t_cose_sign1_set_signing_key(struct t_cose_sign1_sign_ctx *me,
                             struct t_cose_key             signing_key,
                             struct q_useful_buf_c         kid)
{
    me->kid         = kid;
    me->signing_key = signing_key;
}
 
static inline void
t_cose_sign1_sign_set_auxiliary_buffer(struct t_cose_sign1_sign_ctx *me,
                                       struct q_useful_buf           auxiliary_buffer)
{
#ifndef T_COSE_DISABLE_EDDSA
    me->auxiliary_buffer = auxiliary_buffer;
#else
    (void)me;
    (void)auxiliary_buffer;
#endif
}
 
static inline size_t
t_cose_sign1_sign_auxiliary_buffer_size(struct t_cose_sign1_sign_ctx *me)
{
#ifndef T_COSE_DISABLE_EDDSA
    return me->auxiliary_buffer_size;
#else
    /* If EdDSA is disabled we don't ever need an auxiliary buffer. */
    (void)me;
    return 0;
#endif
}
 
 
enum t_cose_err_t
t_cose_sign1_encode_parameters_internal(struct t_cose_sign1_sign_ctx *context,
                                        bool                          payload_is_detached,
                                        QCBOREncodeContext           *cbor_encode_ctx);
 
 
static inline enum t_cose_err_t
t_cose_sign1_encode_parameters(struct t_cose_sign1_sign_ctx *context,
                               QCBOREncodeContext           *cbor_encode_ctx)
{
    return t_cose_sign1_encode_parameters_internal(context,
                                                   false,
                                                   cbor_encode_ctx);
}
 
 
enum t_cose_err_t
t_cose_sign1_encode_signature_aad_internal(struct t_cose_sign1_sign_ctx *context,
                                           struct q_useful_buf_c         aad,
                                           struct q_useful_buf_c         detached_payload,
                                           QCBOREncodeContext           *cbor_encode_ctx);
 
enum t_cose_err_t
t_cose_sign1_sign_aad_internal(struct t_cose_sign1_sign_ctx *context,
                               bool                          payload_is_detached,
                               struct q_useful_buf_c         aad,
                               struct q_useful_buf_c         payload,
                               struct q_useful_buf           out_buf,
                               struct q_useful_buf_c        *result);
 
 
static inline enum t_cose_err_t
t_cose_sign1_sign_aad(struct t_cose_sign1_sign_ctx *me,
                      struct q_useful_buf_c         aad,
                      struct q_useful_buf_c         payload,
                      struct q_useful_buf           out_buf,
                      struct q_useful_buf_c        *result)
{
    return t_cose_sign1_sign_aad_internal(me,
                                          false,
                                          aad,
                                          payload,
                                          out_buf,
                                          result);
}
 
 
static inline enum t_cose_err_t
t_cose_sign1_sign(struct t_cose_sign1_sign_ctx *me,
                  struct q_useful_buf_c         payload,
                  struct q_useful_buf           out_buf,
                  struct q_useful_buf_c        *result)
{
    return t_cose_sign1_sign_aad_internal(me,
                                          false,
                                          payload,
                                          NULL_Q_USEFUL_BUF_C,
                                          out_buf,
                                          result);
}
 
 
static inline enum t_cose_err_t
t_cose_sign1_sign_detached(struct t_cose_sign1_sign_ctx *me,
                           struct q_useful_buf_c         aad,
                           struct q_useful_buf_c         detached_payload,
                           struct q_useful_buf           out_buf,
                           struct q_useful_buf_c        *result)
{
    return t_cose_sign1_sign_aad_internal(me,
                                          true,
                                          detached_payload,
                                          aad,
                                          out_buf,
                                          result);
}
 
 
static inline enum t_cose_err_t
t_cose_sign1_encode_signature_aad(struct t_cose_sign1_sign_ctx *me,
                                  struct q_useful_buf_c         aad,
                                  QCBOREncodeContext           *cbor_encode_ctx)
{
    return t_cose_sign1_encode_signature_aad_internal(me,
                                                      aad,
                                                      NULL_Q_USEFUL_BUF_C,
                                                      cbor_encode_ctx);
}
 
 
static inline enum t_cose_err_t
t_cose_sign1_encode_signature(struct t_cose_sign1_sign_ctx *me,
                              QCBOREncodeContext           *cbor_encode_ctx)
{
    return t_cose_sign1_encode_signature_aad_internal(me,
                                                      NULL_Q_USEFUL_BUF_C,
                                                      NULL_Q_USEFUL_BUF_C,
                                                      cbor_encode_ctx);
}
 
 
#ifndef T_COSE_DISABLE_CONTENT_TYPE
static inline void
t_cose_sign1_set_content_type_uint(struct t_cose_sign1_sign_ctx *me,
                                   uint16_t                     content_type)
{
    me->content_type_uint = content_type;
}
 
 
static inline void
t_cose_sign1_set_content_type_tstr(struct t_cose_sign1_sign_ctx *me,
                                   const char                   *content_type)
{
    me->content_type_tstr = content_type;
}
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* __T_COSE_SIGN1_H__ */