/src/openssl36/providers/implementations/ciphers/ciphercommon_ccm.c

Source
/*
 * Copyright 2019-2026 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */
/* clang-format off */

/* clang-format on */

/* Dispatch functions for ccm mode */

#include <openssl/proverr.h>
#include "prov/ciphercommon.h"
#include "prov/ciphercommon_ccm.h"
#include "prov/providercommon.h"

static int ccm_cipher_internal(PROV_CCM_CTX *ctx, unsigned char *out,
    size_t *padlen, const unsigned char *in,
    size_t len);

static int ccm_tls_init(PROV_CCM_CTX *ctx, unsigned char *aad, size_t alen)
{
    size_t len;

    if (!ossl_prov_is_running() || alen != EVP_AEAD_TLS1_AAD_LEN)
        return 0;

    /* Save the aad for later use. */
    memcpy(ctx->buf, aad, alen);
    ctx->tls_aad_len = alen;

    len = ctx->buf[alen - 2] << 8 | ctx->buf[alen - 1];
    if (len < EVP_CCM_TLS_EXPLICIT_IV_LEN)
        return 0;

    /* Correct length for explicit iv. */
    len -= EVP_CCM_TLS_EXPLICIT_IV_LEN;

    if (!ctx->enc) {
        if (len < ctx->m)
            return 0;
        /* Correct length for tag. */
        len -= ctx->m;
    }
    ctx->buf[alen - 2] = (unsigned char)(len >> 8);
    ctx->buf[alen - 1] = (unsigned char)(len & 0xff);

    /* Extra padding: tag appended to record. */
    return (int)ctx->m;
}

static int ccm_tls_iv_set_fixed(PROV_CCM_CTX *ctx, unsigned char *fixed,
    size_t flen)
{
    if (flen != EVP_CCM_TLS_FIXED_IV_LEN)
        return 0;

    /* Copy to first part of the iv. */
    memcpy(ctx->iv, fixed, flen);
    return 1;
}

static size_t ccm_get_ivlen(PROV_CCM_CTX *ctx)
{
    return 15 - ctx->l;
}

/* clang-format off */
/* Machine generated by util/perl/OpenSSL/paramnames.pm */
#ifndef ossl_cipher_ccm_set_ctx_params_list
static const OSSL_PARAM ossl_cipher_ccm_set_ctx_params_list[] = {
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD, NULL, 0),
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, NULL, 0),
    OSSL_PARAM_END
};
#endif

#ifndef ossl_cipher_ccm_set_ctx_params_st
struct ossl_cipher_ccm_set_ctx_params_st {
    OSSL_PARAM *aad;
    OSSL_PARAM *fixed;
    OSSL_PARAM *ivlen;
    OSSL_PARAM *tag;
};
#endif

#ifndef ossl_cipher_ccm_set_ctx_params_decoder
static int ossl_cipher_ccm_set_ctx_params_decoder
    (const OSSL_PARAM *p, struct ossl_cipher_ccm_set_ctx_params_st *r)
{
    const char *s;

    memset(r, 0, sizeof(*r));
    if (p != NULL)
        for (; (s = p->key) != NULL; p++)
            switch(s[0]) {
            default:
                break;
            case 'i':
                if (ossl_likely(strcmp("vlen", s + 1) == 0)) {
                    /* OSSL_CIPHER_PARAM_AEAD_IVLEN */
                    if (ossl_unlikely(r->ivlen != NULL)) {
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                       "param %s is repeated", s);
                        return 0;
                    }
                    r->ivlen = (OSSL_PARAM *)p;
                }
                break;
            case 't':
                switch(s[1]) {
                default:
                    break;
                case 'a':
                    if (ossl_likely(strcmp("g", s + 2) == 0)) {
                        /* OSSL_CIPHER_PARAM_AEAD_TAG */
                        if (ossl_unlikely(r->tag != NULL)) {
                            ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                           "param %s is repeated", s);
                            return 0;
                        }
                        r->tag = (OSSL_PARAM *)p;
                    }
                    break;
                case 'l':
                    switch(s[2]) {
                    default:
                        break;
                    case 's':
                        switch(s[3]) {
                        default:
                            break;
                        case 'a':
                            if (ossl_likely(strcmp("ad", s + 4) == 0)) {
                                /* OSSL_CIPHER_PARAM_AEAD_TLS1_AAD */
                                if (ossl_unlikely(r->aad != NULL)) {
                                    ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                                   "param %s is repeated", s);
                                    return 0;
                                }
                                r->aad = (OSSL_PARAM *)p;
                            }
                            break;
                        case 'i':
                            if (ossl_likely(strcmp("vfixed", s + 4) == 0)) {
                                /* OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED */
                                if (ossl_unlikely(r->fixed != NULL)) {
                                    ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                                   "param %s is repeated", s);
                                    return 0;
                                }
                                r->fixed = (OSSL_PARAM *)p;
                            }
                        }
                    }
                }
            }
    return 1;
}
#endif
/* End of machine generated */
/* clang-format on */

const OSSL_PARAM *ossl_ccm_settable_ctx_params(
    ossl_unused void *cctx, ossl_unused void *provctx)
{
    return ossl_cipher_ccm_set_ctx_params_list;
}

int ossl_ccm_set_ctx_params(void *vctx, const OSSL_PARAM params[])
{
    PROV_CCM_CTX *ctx = (PROV_CCM_CTX *)vctx;
    size_t sz, ivlen;
    struct ossl_cipher_ccm_set_ctx_params_st p;

    if (ctx == NULL || !ossl_cipher_ccm_set_ctx_params_decoder(params, &p))
        return 0;

    if (p.tag != NULL) {
        if (p.tag->data_type != OSSL_PARAM_OCTET_STRING) {
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
            return 0;
        }
        if ((p.tag->data_size & 1) || (p.tag->data_size < 4) || p.tag->data_size > 16) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH);
            return 0;
        }

        if (p.tag->data != NULL) {
            if (ctx->enc) {
                ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_NEEDED);
                return 0;
            }
            memcpy(ctx->buf, p.tag->data, p.tag->data_size);
            ctx->tag_set = 1;
        }
        ctx->m = p.tag->data_size;
    }

    if (p.ivlen != NULL) {
        if (!OSSL_PARAM_get_size_t(p.ivlen, &sz)) {
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
            return 0;
        }
        ivlen = 15 - sz;
        if (ivlen < 2 || ivlen > 8) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
            return 0;
        }
        if (ctx->l != ivlen) {
            ctx->l = ivlen;
            ctx->iv_set = 0;
        }
    }

    if (p.aad != NULL) {
        if (p.aad->data_type != OSSL_PARAM_OCTET_STRING) {
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
            return 0;
        }
        sz = ccm_tls_init(ctx, p.aad->data, p.aad->data_size);
        if (sz == 0) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
            return 0;
        }
        ctx->tls_aad_pad_sz = sz;
    }

    if (p.fixed != NULL) {
        if (p.fixed->data_type != OSSL_PARAM_OCTET_STRING) {
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
            return 0;
        }
        if (ccm_tls_iv_set_fixed(ctx, p.fixed->data, p.fixed->data_size) == 0) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
            return 0;
        }
    }
    return 1;
}

/* clang-format off */
/* Machine generated by util/perl/OpenSSL/paramnames.pm */
#ifndef ossl_cipher_ccm_get_ctx_params_list
static const OSSL_PARAM ossl_cipher_ccm_get_ctx_params_list[] = {
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_UPDATED_IV, NULL, 0),
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL),
    OSSL_PARAM_END
};
#endif

#ifndef ossl_cipher_ccm_get_ctx_params_st
struct ossl_cipher_ccm_get_ctx_params_st {
    OSSL_PARAM *iv;
    OSSL_PARAM *ivlen;
    OSSL_PARAM *keylen;
    OSSL_PARAM *pad;
    OSSL_PARAM *tag;
    OSSL_PARAM *taglen;
    OSSL_PARAM *updiv;
};
#endif

#ifndef ossl_cipher_ccm_get_ctx_params_decoder
static int ossl_cipher_ccm_get_ctx_params_decoder
    (const OSSL_PARAM *p, struct ossl_cipher_ccm_get_ctx_params_st *r)
{
    const char *s;

    memset(r, 0, sizeof(*r));
    if (p != NULL)
        for (; (s = p->key) != NULL; p++)
            switch(s[0]) {
            default:
                break;
            case 'i':
                switch(s[1]) {
                default:
                    break;
                case 'v':
                    switch(s[2]) {
                    default:
                        break;
                    case 'l':
                        if (ossl_likely(strcmp("en", s + 3) == 0)) {
                            /* OSSL_CIPHER_PARAM_IVLEN */
                            if (ossl_unlikely(r->ivlen != NULL)) {
                                ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                               "param %s is repeated", s);
                                return 0;
                            }
                            r->ivlen = (OSSL_PARAM *)p;
                        }
                        break;
                    case '\0':
                        if (ossl_unlikely(r->iv != NULL)) {
                            ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                           "param %s is repeated", s);
                            return 0;
                        }
                        r->iv = (OSSL_PARAM *)p;
                    }
                }
                break;
            case 'k':
                if (ossl_likely(strcmp("eylen", s + 1) == 0)) {
                    /* OSSL_CIPHER_PARAM_KEYLEN */
                    if (ossl_unlikely(r->keylen != NULL)) {
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                       "param %s is repeated", s);
                        return 0;
                    }
                    r->keylen = (OSSL_PARAM *)p;
                }
                break;
            case 't':
                switch(s[1]) {
                default:
                    break;
                case 'a':
                    switch(s[2]) {
                    default:
                        break;
                    case 'g':
                        switch(s[3]) {
                        default:
                            break;
                        case 'l':
                            if (ossl_likely(strcmp("en", s + 4) == 0)) {
                                /* OSSL_CIPHER_PARAM_AEAD_TAGLEN */
                                if (ossl_unlikely(r->taglen != NULL)) {
                                    ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                                   "param %s is repeated", s);
                                    return 0;
                                }
                                r->taglen = (OSSL_PARAM *)p;
                            }
                            break;
                        case '\0':
                            if (ossl_unlikely(r->tag != NULL)) {
                                ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                               "param %s is repeated", s);
                                return 0;
                            }
                            r->tag = (OSSL_PARAM *)p;
                        }
                    }
                    break;
                case 'l':
                    if (ossl_likely(strcmp("saadpad", s + 2) == 0)) {
                        /* OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD */
                        if (ossl_unlikely(r->pad != NULL)) {
                            ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                           "param %s is repeated", s);
                            return 0;
                        }
                        r->pad = (OSSL_PARAM *)p;
                    }
                }
                break;
            case 'u':
                if (ossl_likely(strcmp("pdated-iv", s + 1) == 0)) {
                    /* OSSL_CIPHER_PARAM_UPDATED_IV */
                    if (ossl_unlikely(r->updiv != NULL)) {
                        ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                       "param %s is repeated", s);
                        return 0;
                    }
                    r->updiv = (OSSL_PARAM *)p;
                }
            }
    return 1;
}
#endif
/* End of machine generated */
/* clang-format on */

const OSSL_PARAM *ossl_ccm_gettable_ctx_params(
    ossl_unused void *cctx, ossl_unused void *provctx)
{
    return ossl_cipher_ccm_get_ctx_params_list;
}

int ossl_ccm_get_ctx_params(void *vctx, OSSL_PARAM params[])
{
    PROV_CCM_CTX *ctx = (PROV_CCM_CTX *)vctx;
    struct ossl_cipher_ccm_get_ctx_params_st p;

    if (ctx == NULL || !ossl_cipher_ccm_get_ctx_params_decoder(params, &p))
        return 0;

    if (p.ivlen != NULL && !OSSL_PARAM_set_size_t(p.ivlen, ccm_get_ivlen(ctx))) {
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
        return 0;
    }

    if (p.taglen != NULL && !OSSL_PARAM_set_size_t(p.taglen, ctx->m)) {
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
        return 0;
    }

    if (p.iv != NULL) {
        if (ccm_get_ivlen(ctx) > p.iv->data_size) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
            return 0;
        }
        if (!OSSL_PARAM_set_octet_string_or_ptr(p.iv, ctx->iv, p.iv->data_size)) {
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
            return 0;
        }
    }

    if (p.updiv != NULL) {
        if (ccm_get_ivlen(ctx) > p.updiv->data_size) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
            return 0;
        }
        if (!OSSL_PARAM_set_octet_string_or_ptr(p.updiv, ctx->iv, p.updiv->data_size)) {
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
            return 0;
        }
    }

    if (p.keylen != NULL && !OSSL_PARAM_set_size_t(p.keylen, ctx->keylen)) {
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
        return 0;
    }

    if (p.pad != NULL && !OSSL_PARAM_set_size_t(p.pad, ctx->tls_aad_pad_sz)) {
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
        return 0;
    }

    if (p.tag != NULL) {
        if (!ctx->enc || !ctx->tag_set) {
            ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_SET);
            return 0;
        }
        if (p.tag->data_type != OSSL_PARAM_OCTET_STRING) {
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
            return 0;
        }
        if (!ctx->hw->gettag(ctx, p.tag->data, p.tag->data_size))
            return 0;
        ctx->tag_set = 0;
        ctx->iv_set = 0;
        ctx->len_set = 0;
    }

    return 1;
}

static int ccm_init(void *vctx, const unsigned char *key, size_t keylen,
    const unsigned char *iv, size_t ivlen,
    const OSSL_PARAM params[], int enc)
{
    PROV_CCM_CTX *ctx = (PROV_CCM_CTX *)vctx;

    if (!ossl_prov_is_running())
        return 0;

    ctx->enc = enc;

    if (iv != NULL) {
        if (ivlen != ccm_get_ivlen(ctx)) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
            return 0;
        }
        memcpy(ctx->iv, iv, ivlen);
        ctx->iv_set = 1;
    }
    if (key != NULL) {
        if (keylen != ctx->keylen) {
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
            return 0;
        }
        if (!ctx->hw->setkey(ctx, key, keylen))
            return 0;
    }
    return ossl_ccm_set_ctx_params(ctx, params);
}

int ossl_ccm_einit(void *vctx, const unsigned char *key, size_t keylen,
    const unsigned char *iv, size_t ivlen,
    const OSSL_PARAM params[])
{
    return ccm_init(vctx, key, keylen, iv, ivlen, params, 1);
}

int ossl_ccm_dinit(void *vctx, const unsigned char *key, size_t keylen,
    const unsigned char *iv, size_t ivlen,
    const OSSL_PARAM params[])
{
    return ccm_init(vctx, key, keylen, iv, ivlen, params, 0);
}

int ossl_ccm_stream_update(void *vctx, unsigned char *out, size_t *outl,
    size_t outsize, const unsigned char *in,
    size_t inl)
{
    PROV_CCM_CTX *ctx = (PROV_CCM_CTX *)vctx;

    if (outsize < inl) {
        ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
        return 0;
    }

    if (!ccm_cipher_internal(ctx, out, outl, in, inl)) {
        ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
        return 0;
    }
    return 1;
}

int ossl_ccm_stream_final(void *vctx, unsigned char *out, size_t *outl,
    size_t outsize)
{
    PROV_CCM_CTX *ctx = (PROV_CCM_CTX *)vctx;
    unsigned char dummy_in = 0, dummy_out = 0;

    if (!ossl_prov_is_running())
        return 0;

    /*
     * Encryption sets tag_set after processing the payload, while successful
     * decryption clears iv_set. Use those transitions to avoid processing an
     * operation twice.
     */
    if (!ctx->key_set
        || (ctx->iv_set && (!ctx->enc || !ctx->tag_set)
            && ccm_cipher_internal(ctx, &dummy_out, outl, &dummy_in, 0) <= 0))
        return 0;

    *outl = 0;
    return 1;
}

int ossl_ccm_cipher(void *vctx, unsigned char *out, size_t *outl, size_t outsize,
    const unsigned char *in, size_t inl)
{
    PROV_CCM_CTX *ctx = (PROV_CCM_CTX *)vctx;

    if (!ossl_prov_is_running())
        return 0;

    if (in == NULL)
        return ossl_ccm_stream_final(vctx, out, outl, outsize);

    if (outsize < inl) {
        ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
        return 0;
    }

    if (ccm_cipher_internal(ctx, out, outl, in, inl) <= 0)
        return 0;

    *outl = inl;
    return 1;
}

/* Copy the buffered iv */
static int ccm_set_iv(PROV_CCM_CTX *ctx, size_t mlen)
{
    const PROV_CCM_HW *hw = ctx->hw;

    if (!hw->setiv(ctx, ctx->iv, ccm_get_ivlen(ctx), mlen))
        return 0;
    ctx->len_set = 1;
    return 1;
}

static int ccm_tls_cipher(PROV_CCM_CTX *ctx,
    unsigned char *out, size_t *padlen,
    const unsigned char *in, size_t len)
{
    int rv = 0;
    size_t olen = 0;

    if (!ossl_prov_is_running())
        goto err;

    /* Encrypt/decrypt must be performed in place */
    if (in == NULL || out != in || len < EVP_CCM_TLS_EXPLICIT_IV_LEN + ctx->m)
        goto err;

    /* If encrypting set explicit IV from sequence number (start of AAD) */
    if (ctx->enc)
        memcpy(out, ctx->buf, EVP_CCM_TLS_EXPLICIT_IV_LEN);
    /* Get rest of IV from explicit IV */
    memcpy(ctx->iv + EVP_CCM_TLS_FIXED_IV_LEN, in, EVP_CCM_TLS_EXPLICIT_IV_LEN);
    /* Correct length value */
    len -= EVP_CCM_TLS_EXPLICIT_IV_LEN + ctx->m;
    if (!ccm_set_iv(ctx, len))
        goto err;

    /* Use saved AAD */
    if (!ctx->hw->setaad(ctx, ctx->buf, ctx->tls_aad_len))
        goto err;

    /* Fix buffer to point to payload */
    in += EVP_CCM_TLS_EXPLICIT_IV_LEN;
    out += EVP_CCM_TLS_EXPLICIT_IV_LEN;
    if (ctx->enc) {
        if (!ctx->hw->auth_encrypt(ctx, in, out, len, out + len, ctx->m))
            goto err;
        olen = len + EVP_CCM_TLS_EXPLICIT_IV_LEN + ctx->m;
    } else {
        if (!ctx->hw->auth_decrypt(ctx, in, out, len,
                (unsigned char *)in + len, ctx->m))
            goto err;
        olen = len;
    }
    rv = 1;
err:
    *padlen = olen;
    return rv;
}

static int ccm_cipher_internal(PROV_CCM_CTX *ctx, unsigned char *out,
    size_t *padlen, const unsigned char *in,
    size_t len)
{
    int rv = 0;
    size_t olen = 0;
    const PROV_CCM_HW *hw = ctx->hw;

    /* If no key set, return error */
    if (!ctx->key_set)
        return 0;

    if (ctx->tls_aad_len != UNINITIALISED_SIZET)
        return ccm_tls_cipher(ctx, out, padlen, in, len);

    /* EVP_*Final() doesn't return any data */
    if (in == NULL && out != NULL)
        goto finish;

    if (!ctx->iv_set)
        goto err;

    if (out == NULL) {
        if (in == NULL) {
            if (!ccm_set_iv(ctx, len))
                goto err;
        } else {
            /* If we have AAD, we need a message length */
            if (!ctx->len_set && len)
                goto err;
            if (!hw->setaad(ctx, in, len))
                goto err;
        }
    } else {
        /* If not set length yet do it */
        if (!ctx->len_set && !ccm_set_iv(ctx, len))
            goto err;

        if (ctx->enc) {
            if (!hw->auth_encrypt(ctx, in, out, len, NULL, 0))
                goto err;
            ctx->tag_set = 1;
        } else {
            /* The tag must be set before actually decrypting data */
            if (!ctx->tag_set)
                goto err;

            if (!hw->auth_decrypt(ctx, in, out, len, ctx->buf, ctx->m))
                goto err;
            /* Finished - reset flags so calling this method again will fail */
            ctx->iv_set = 0;
            ctx->tag_set = 0;
            ctx->len_set = 0;
        }
    }
    olen = len;
finish:
    rv = 1;
err:
    *padlen = olen;
    return rv;
}

void ossl_ccm_initctx(PROV_CCM_CTX *ctx, size_t keybits, const PROV_CCM_HW *hw)
{
    ctx->keylen = keybits / 8;
    ctx->key_set = 0;
    ctx->iv_set = 0;
    ctx->tag_set = 0;
    ctx->len_set = 0;
    ctx->l = 8;
    ctx->m = 12;
    ctx->tls_aad_len = UNINITIALISED_SIZET;
    ctx->hw = hw;
}

Coverage Report

Created: 2026-09-12 06:55

Line	Count	Source
1		/*
2		* Copyright 2019-2026 The OpenSSL Project Authors. All Rights Reserved.
3		*
4		* Licensed under the Apache License 2.0 (the "License"). You may not use
5		* this file except in compliance with the License. You can obtain a copy
6		* in the file LICENSE in the source distribution or at
7		* https://www.openssl.org/source/license.html
8		*/
9		/* clang-format off */
10
11		/* clang-format on */
12
13		/* Dispatch functions for ccm mode */
14
15		#include <openssl/proverr.h>
16		#include "prov/ciphercommon.h"
17		#include "prov/ciphercommon_ccm.h"
18		#include "prov/providercommon.h"
19
20		static int ccm_cipher_internal(PROV_CCM_CTX ctx, unsigned char out,
21		size_t padlen, const unsigned char in,
22		size_t len);
23
24		static int ccm_tls_init(PROV_CCM_CTX ctx, unsigned char aad, size_t alen)
25	78.2k	{
26	78.2k	size_t len;
27
28	78.2k	if (!ossl_prov_is_running() \|\| alen != EVP_AEAD_TLS1_AAD_LEN)
29	0	return 0;
30
31		/* Save the aad for later use. */
32	78.2k	memcpy(ctx->buf, aad, alen);
33	78.2k	ctx->tls_aad_len = alen;
34
35	78.2k	len = ctx->buf[alen - 2] << 8 \| ctx->buf[alen - 1];
36	78.2k	if (len < EVP_CCM_TLS_EXPLICIT_IV_LEN)
37	78	return 0;
38
39		/* Correct length for explicit iv. */
40	78.2k	len -= EVP_CCM_TLS_EXPLICIT_IV_LEN;
41
42	78.2k	if (!ctx->enc) {
43	77.2k	if (len < ctx->m)
44	29	return 0;
45		/* Correct length for tag. */
46	77.2k	len -= ctx->m;
47	77.2k	}
48	78.1k	ctx->buf[alen - 2] = (unsigned char)(len >> 8);
49	78.1k	ctx->buf[alen - 1] = (unsigned char)(len & 0xff);
50
51		/* Extra padding: tag appended to record. */
52	78.1k	return (int)ctx->m;
53	78.2k	}
54
55		static int ccm_tls_iv_set_fixed(PROV_CCM_CTX ctx, unsigned char fixed,
56		size_t flen)
57	1.99k	{
58	1.99k	if (flen != EVP_CCM_TLS_FIXED_IV_LEN)
59	0	return 0;
60
61		/* Copy to first part of the iv. */
62	1.99k	memcpy(ctx->iv, fixed, flen);
63	1.99k	return 1;
64	1.99k	}
65
66		static size_t ccm_get_ivlen(PROV_CCM_CTX *ctx)
67	78.2k	{
68	78.2k	return 15 - ctx->l;
69	78.2k	}
70
71		/* clang-format off */
72		/* Machine generated by util/perl/OpenSSL/paramnames.pm */
73		#ifndef ossl_cipher_ccm_set_ctx_params_list
74		static const OSSL_PARAM ossl_cipher_ccm_set_ctx_params_list[] = {
75		OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
76		OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
77		OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD, NULL, 0),
78		OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, NULL, 0),
79		OSSL_PARAM_END
80		};
81		#endif
82
83		#ifndef ossl_cipher_ccm_set_ctx_params_st
84		struct ossl_cipher_ccm_set_ctx_params_st {
85		OSSL_PARAM *aad;
86		OSSL_PARAM *fixed;
87		OSSL_PARAM *ivlen;
88		OSSL_PARAM *tag;
89		};
90		#endif
91
92		#ifndef ossl_cipher_ccm_set_ctx_params_decoder
93		static int ossl_cipher_ccm_set_ctx_params_decoder
94		(const OSSL_PARAM p, struct ossl_cipher_ccm_set_ctx_params_st r)
95	44.6k	{
96	44.6k	const char *s;
97
98	44.6k	memset(r, 0, sizeof(*r));
99	44.6k	if (p != NULL)
100	86.9k	for (; (s = p->key) != NULL; p++)
101	43.8k	switch(s[0]) {
102	1	default:
103	1	break;
104	768	case 'i':
105	768	if (ossl_likely(strcmp("vlen", s + 1) == 0)) {
106		/* OSSL_CIPHER_PARAM_AEAD_IVLEN */
107	768	if (ossl_unlikely(r->ivlen != NULL)) {
108	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
109	0	"param %s is repeated", s);
110	0	return 0;
111	0	}
112	768	r->ivlen = (OSSL_PARAM *)p;
113	768	}
114	768	break;
115	43.0k	case 't':
116	43.0k	switch(s[1]) {
117	0	default:
118	0	break;
119	768	case 'a':
120	768	if (ossl_likely(strcmp("g", s + 2) == 0)) {
121		/* OSSL_CIPHER_PARAM_AEAD_TAG */
122	768	if (ossl_unlikely(r->tag != NULL)) {
123	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
124	0	"param %s is repeated", s);
125	0	return 0;
126	0	}
127	768	r->tag = (OSSL_PARAM *)p;
128	768	}
129	768	break;
130	42.3k	case 'l':
131	42.3k	switch(s[2]) {
132	0	default:
133	0	break;
134	42.3k	case 's':
135	42.3k	switch(s[3]) {
136	1.50k	default:
137	1.50k	break;
138	40.0k	case 'a':
139	40.0k	if (ossl_likely(strcmp("ad", s + 4) == 0)) {
140		/* OSSL_CIPHER_PARAM_AEAD_TLS1_AAD */
141	40.0k	if (ossl_unlikely(r->aad != NULL)) {
142	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
143	0	"param %s is repeated", s);
144	0	return 0;
145	0	}
146	40.0k	r->aad = (OSSL_PARAM *)p;
147	40.0k	}
148	40.0k	break;
149	40.0k	case 'i':
150	768	if (ossl_likely(strcmp("vfixed", s + 4) == 0)) {
151		/* OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED */
152	768	if (ossl_unlikely(r->fixed != NULL)) {
153	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
154	0	"param %s is repeated", s);
155	0	return 0;
156	0	}
157	768	r->fixed = (OSSL_PARAM *)p;
158	768	}
159	42.3k	}
160	42.3k	}
161	43.0k	}
162	43.8k	}
163	44.6k	return 1;
164	44.6k	}
165		#endif
166		/* End of machine generated */
167		/* clang-format on */
168
169		const OSSL_PARAM *ossl_ccm_settable_ctx_params(
170		ossl_unused void cctx, ossl_unused void provctx)
171	18	{
172	18	return ossl_cipher_ccm_set_ctx_params_list;
173	18	}
174
175		int ossl_ccm_set_ctx_params(void *vctx, const OSSL_PARAM params[])
176	44.6k	{
177	44.6k	PROV_CCM_CTX ctx = (PROV_CCM_CTX )vctx;
178	44.6k	size_t sz, ivlen;
179	44.6k	struct ossl_cipher_ccm_set_ctx_params_st p;
180
181	44.6k	if (ctx == NULL \|\| !ossl_cipher_ccm_set_ctx_params_decoder(params, &p))
182	0	return 0;
183
184	44.6k	if (p.tag != NULL) {
185	768	if (p.tag->data_type != OSSL_PARAM_OCTET_STRING) {
186	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
187	0	return 0;
188	0	}
189	768	if ((p.tag->data_size & 1) \|\| (p.tag->data_size < 4) \|\| p.tag->data_size > 16) {
190	12	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH);
191	12	return 0;
192	12	}
193
194	756	if (p.tag->data != NULL) {
195	2	if (ctx->enc) {
196	2	ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_NEEDED);
197	2	return 0;
198	2	}
199	0	memcpy(ctx->buf, p.tag->data, p.tag->data_size);
200	0	ctx->tag_set = 1;
201	0	}
202	754	ctx->m = p.tag->data_size;
203	754	}
204
205	44.5k	if (p.ivlen != NULL) {
206	754	if (!OSSL_PARAM_get_size_t(p.ivlen, &sz)) {
207	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
208	0	return 0;
209	0	}
210	754	ivlen = 15 - sz;
211	754	if (ivlen < 2 \|\| ivlen > 8) {
212	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
213	0	return 0;
214	0	}
215	754	if (ctx->l != ivlen) {
216	754	ctx->l = ivlen;
217	754	ctx->iv_set = 0;
218	754	}
219	754	}
220
221	44.5k	if (p.aad != NULL) {
222	40.0k	if (p.aad->data_type != OSSL_PARAM_OCTET_STRING) {
223	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
224	0	return 0;
225	0	}
226	40.0k	sz = ccm_tls_init(ctx, p.aad->data, p.aad->data_size);
227	40.0k	if (sz == 0) {
228	58	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
229	58	return 0;
230	58	}
231	39.9k	ctx->tls_aad_pad_sz = sz;
232	39.9k	}
233
234	44.5k	if (p.fixed != NULL) {
235	754	if (p.fixed->data_type != OSSL_PARAM_OCTET_STRING) {
236	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
237	0	return 0;
238	0	}
239	754	if (ccm_tls_iv_set_fixed(ctx, p.fixed->data, p.fixed->data_size) == 0) {
240	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
241	0	return 0;
242	0	}
243	754	}
244	44.5k	return 1;
245	44.5k	}
246
247		/* clang-format off */
248		/* Machine generated by util/perl/OpenSSL/paramnames.pm */
249		#ifndef ossl_cipher_ccm_get_ctx_params_list
250		static const OSSL_PARAM ossl_cipher_ccm_get_ctx_params_list[] = {
251		OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
252		OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
253		OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
254		OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
255		OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_UPDATED_IV, NULL, 0),
256		OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
257		OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL),
258		OSSL_PARAM_END
259		};
260		#endif
261
262		#ifndef ossl_cipher_ccm_get_ctx_params_st
263		struct ossl_cipher_ccm_get_ctx_params_st {
264		OSSL_PARAM *iv;
265		OSSL_PARAM *ivlen;
266		OSSL_PARAM *keylen;
267		OSSL_PARAM *pad;
268		OSSL_PARAM *tag;
269		OSSL_PARAM *taglen;
270		OSSL_PARAM *updiv;
271		};
272		#endif
273
274		#ifndef ossl_cipher_ccm_get_ctx_params_decoder
275		static int ossl_cipher_ccm_get_ctx_params_decoder
276		(const OSSL_PARAM p, struct ossl_cipher_ccm_get_ctx_params_st r)
277	40.7k	{
278	40.7k	const char *s;
279
280	40.7k	memset(r, 0, sizeof(*r));
281	40.7k	if (p != NULL)
282	81.5k	for (; (s = p->key) != NULL; p++)
283	40.7k	switch(s[0]) {
284	0	default:
285	0	break;
286	14	case 'i':
287	14	switch(s[1]) {
288	0	default:
289	0	break;
290	14	case 'v':
291	14	switch(s[2]) {
292	0	default:
293	0	break;
294	14	case 'l':
295	14	if (ossl_likely(strcmp("en", s + 3) == 0)) {
296		/* OSSL_CIPHER_PARAM_IVLEN */
297	14	if (ossl_unlikely(r->ivlen != NULL)) {
298	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
299	0	"param %s is repeated", s);
300	0	return 0;
301	0	}
302	14	r->ivlen = (OSSL_PARAM *)p;
303	14	}
304	14	break;
305	14	case '\0':
306	0	if (ossl_unlikely(r->iv != NULL)) {
307	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
308	0	"param %s is repeated", s);
309	0	return 0;
310	0	}
311	0	r->iv = (OSSL_PARAM *)p;
312	14	}
313	14	}
314	14	break;
315	770	case 'k':
316	770	if (ossl_likely(strcmp("eylen", s + 1) == 0)) {
317		/* OSSL_CIPHER_PARAM_KEYLEN */
318	770	if (ossl_unlikely(r->keylen != NULL)) {
319	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
320	0	"param %s is repeated", s);
321	0	return 0;
322	0	}
323	770	r->keylen = (OSSL_PARAM *)p;
324	770	}
325	770	break;
326	39.9k	case 't':
327	39.9k	switch(s[1]) {
328	0	default:
329	0	break;
330	0	case 'a':
331	0	switch(s[2]) {
332	0	default:
333	0	break;
334	0	case 'g':
335	0	switch(s[3]) {
336	0	default:
337	0	break;
338	0	case 'l':
339	0	if (ossl_likely(strcmp("en", s + 4) == 0)) {
340		/* OSSL_CIPHER_PARAM_AEAD_TAGLEN */
341	0	if (ossl_unlikely(r->taglen != NULL)) {
342	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
343	0	"param %s is repeated", s);
344	0	return 0;
345	0	}
346	0	r->taglen = (OSSL_PARAM *)p;
347	0	}
348	0	break;
349	0	case '\0':
350	0	if (ossl_unlikely(r->tag != NULL)) {
351	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
352	0	"param %s is repeated", s);
353	0	return 0;
354	0	}
355	0	r->tag = (OSSL_PARAM *)p;
356	0	}
357	0	}
358	0	break;
359	39.9k	case 'l':
360	39.9k	if (ossl_likely(strcmp("saadpad", s + 2) == 0)) {
361		/* OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD */
362	39.9k	if (ossl_unlikely(r->pad != NULL)) {
363	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
364	0	"param %s is repeated", s);
365	0	return 0;
366	0	}
367	39.9k	r->pad = (OSSL_PARAM *)p;
368	39.9k	}
369	39.9k	}
370	39.9k	break;
371	39.9k	case 'u':
372	0	if (ossl_likely(strcmp("pdated-iv", s + 1) == 0)) {
373		/* OSSL_CIPHER_PARAM_UPDATED_IV */
374	0	if (ossl_unlikely(r->updiv != NULL)) {
375	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
376	0	"param %s is repeated", s);
377	0	return 0;
378	0	}
379	0	r->updiv = (OSSL_PARAM *)p;
380	0	}
381	40.7k	}
382	40.7k	return 1;
383	40.7k	}
384		#endif
385		/* End of machine generated */
386		/* clang-format on */
387
388		const OSSL_PARAM *ossl_ccm_gettable_ctx_params(
389		ossl_unused void cctx, ossl_unused void provctx)
390	308	{
391	308	return ossl_cipher_ccm_get_ctx_params_list;
392	308	}
393
394		int ossl_ccm_get_ctx_params(void *vctx, OSSL_PARAM params[])
395	40.7k	{
396	40.7k	PROV_CCM_CTX ctx = (PROV_CCM_CTX )vctx;
397	40.7k	struct ossl_cipher_ccm_get_ctx_params_st p;
398
399	40.7k	if (ctx == NULL \|\| !ossl_cipher_ccm_get_ctx_params_decoder(params, &p))
400	0	return 0;
401
402	40.7k	if (p.ivlen != NULL && !OSSL_PARAM_set_size_t(p.ivlen, ccm_get_ivlen(ctx))) {
403	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
404	0	return 0;
405	0	}
406
407	40.7k	if (p.taglen != NULL && !OSSL_PARAM_set_size_t(p.taglen, ctx->m)) {
408	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
409	0	return 0;
410	0	}
411
412	40.7k	if (p.iv != NULL) {
413	0	if (ccm_get_ivlen(ctx) > p.iv->data_size) {
414	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
415	0	return 0;
416	0	}
417	0	if (!OSSL_PARAM_set_octet_string_or_ptr(p.iv, ctx->iv, p.iv->data_size)) {
418	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
419	0	return 0;
420	0	}
421	0	}
422
423	40.7k	if (p.updiv != NULL) {
424	0	if (ccm_get_ivlen(ctx) > p.updiv->data_size) {
425	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
426	0	return 0;
427	0	}
428	0	if (!OSSL_PARAM_set_octet_string_or_ptr(p.updiv, ctx->iv, p.updiv->data_size)) {
429	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
430	0	return 0;
431	0	}
432	0	}
433
434	40.7k	if (p.keylen != NULL && !OSSL_PARAM_set_size_t(p.keylen, ctx->keylen)) {
435	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
436	0	return 0;
437	0	}
438
439	40.7k	if (p.pad != NULL && !OSSL_PARAM_set_size_t(p.pad, ctx->tls_aad_pad_sz)) {
440	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
441	0	return 0;
442	0	}
443
444	40.7k	if (p.tag != NULL) {
445	0	if (!ctx->enc \|\| !ctx->tag_set) {
446	0	ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_SET);
447	0	return 0;
448	0	}
449	0	if (p.tag->data_type != OSSL_PARAM_OCTET_STRING) {
450	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
451	0	return 0;
452	0	}
453	0	if (!ctx->hw->gettag(ctx, p.tag->data, p.tag->data_size))
454	0	return 0;
455	0	ctx->tag_set = 0;
456	0	ctx->iv_set = 0;
457	0	ctx->len_set = 0;
458	0	}
459
460	40.7k	return 1;
461	40.7k	}
462
463		static int ccm_init(void vctx, const unsigned char key, size_t keylen,
464		const unsigned char *iv, size_t ivlen,
465		const OSSL_PARAM params[], int enc)
466	4.03k	{
467	4.03k	PROV_CCM_CTX ctx = (PROV_CCM_CTX )vctx;
468
469	4.03k	if (!ossl_prov_is_running())
470	0	return 0;
471
472	4.03k	ctx->enc = enc;
473
474	4.03k	if (iv != NULL) {
475	14	if (ivlen != ccm_get_ivlen(ctx)) {
476	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
477	0	return 0;
478	0	}
479	14	memcpy(ctx->iv, iv, ivlen);
480	14	ctx->iv_set = 1;
481	14	}
482	4.03k	if (key != NULL) {
483	2.01k	if (keylen != ctx->keylen) {
484	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
485	0	return 0;
486	0	}
487	2.01k	if (!ctx->hw->setkey(ctx, key, keylen))
488	0	return 0;
489	2.01k	}
490	4.03k	return ossl_ccm_set_ctx_params(ctx, params);
491	4.03k	}
492
493		int ossl_ccm_einit(void vctx, const unsigned char key, size_t keylen,
494		const unsigned char *iv, size_t ivlen,
495		const OSSL_PARAM params[])
496	1.59k	{
497	1.59k	return ccm_init(vctx, key, keylen, iv, ivlen, params, 1);
498	1.59k	}
499
500		int ossl_ccm_dinit(void vctx, const unsigned char key, size_t keylen,
501		const unsigned char *iv, size_t ivlen,
502		const OSSL_PARAM params[])
503	2.44k	{
504	2.44k	return ccm_init(vctx, key, keylen, iv, ivlen, params, 0);
505	2.44k	}
506
507		int ossl_ccm_stream_update(void vctx, unsigned char out, size_t *outl,
508		size_t outsize, const unsigned char *in,
509		size_t inl)
510	78.1k	{
511	78.1k	PROV_CCM_CTX ctx = (PROV_CCM_CTX )vctx;
512
513	78.1k	if (outsize < inl) {
514	0	ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
515	0	return 0;
516	0	}
517
518	78.1k	if (!ccm_cipher_internal(ctx, out, outl, in, inl)) {
519	77.1k	ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
520	77.1k	return 0;
521	77.1k	}
522	1.03k	return 1;
523	78.1k	}
524
525		int ossl_ccm_stream_final(void vctx, unsigned char out, size_t *outl,
526		size_t outsize)
527	0	{
528	0	PROV_CCM_CTX ctx = (PROV_CCM_CTX )vctx;
529	0	unsigned char dummy_in = 0, dummy_out = 0;
530
531	0	if (!ossl_prov_is_running())
532	0	return 0;
533
534		/*
535		* Encryption sets tag_set after processing the payload, while successful
536		* decryption clears iv_set. Use those transitions to avoid processing an
537		* operation twice.
538		*/
539	0	if (!ctx->key_set
540	0	\|\| (ctx->iv_set && (!ctx->enc \|\| !ctx->tag_set)
541	0	&& ccm_cipher_internal(ctx, &dummy_out, outl, &dummy_in, 0) <= 0))
542	0	return 0;
543
544	0	*outl = 0;
545	0	return 1;
546	0	}
547
548		int ossl_ccm_cipher(void vctx, unsigned char out, size_t *outl, size_t outsize,
549		const unsigned char *in, size_t inl)
550	0	{
551	0	PROV_CCM_CTX ctx = (PROV_CCM_CTX )vctx;
552
553	0	if (!ossl_prov_is_running())
554	0	return 0;
555
556	0	if (in == NULL)
557	0	return ossl_ccm_stream_final(vctx, out, outl, outsize);
558
559	0	if (outsize < inl) {
560	0	ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
561	0	return 0;
562	0	}
563
564	0	if (ccm_cipher_internal(ctx, out, outl, in, inl) <= 0)
565	0	return 0;
566
567	0	*outl = inl;
568	0	return 1;
569	0	}
570
571		/* Copy the buffered iv */
572		static int ccm_set_iv(PROV_CCM_CTX *ctx, size_t mlen)
573	78.1k	{
574	78.1k	const PROV_CCM_HW *hw = ctx->hw;
575
576	78.1k	if (!hw->setiv(ctx, ctx->iv, ccm_get_ivlen(ctx), mlen))
577	0	return 0;
578	78.1k	ctx->len_set = 1;
579	78.1k	return 1;
580	78.1k	}
581
582		static int ccm_tls_cipher(PROV_CCM_CTX *ctx,
583		unsigned char out, size_t padlen,
584		const unsigned char *in, size_t len)
585	78.1k	{
586	78.1k	int rv = 0;
587	78.1k	size_t olen = 0;
588
589	78.1k	if (!ossl_prov_is_running())
590	0	goto err;
591
592		/* Encrypt/decrypt must be performed in place */
593	78.1k	if (in == NULL \|\| out != in \|\| len < EVP_CCM_TLS_EXPLICIT_IV_LEN + ctx->m)
594	0	goto err;
595
596		/* If encrypting set explicit IV from sequence number (start of AAD) */
597	78.1k	if (ctx->enc)
598	958	memcpy(out, ctx->buf, EVP_CCM_TLS_EXPLICIT_IV_LEN);
599		/* Get rest of IV from explicit IV */
600	78.1k	memcpy(ctx->iv + EVP_CCM_TLS_FIXED_IV_LEN, in, EVP_CCM_TLS_EXPLICIT_IV_LEN);
601		/* Correct length value */
602	78.1k	len -= EVP_CCM_TLS_EXPLICIT_IV_LEN + ctx->m;
603	78.1k	if (!ccm_set_iv(ctx, len))
604	0	goto err;
605
606		/* Use saved AAD */
607	78.1k	if (!ctx->hw->setaad(ctx, ctx->buf, ctx->tls_aad_len))
608	0	goto err;
609
610		/* Fix buffer to point to payload */
611	78.1k	in += EVP_CCM_TLS_EXPLICIT_IV_LEN;
612	78.1k	out += EVP_CCM_TLS_EXPLICIT_IV_LEN;
613	78.1k	if (ctx->enc) {
614	958	if (!ctx->hw->auth_encrypt(ctx, in, out, len, out + len, ctx->m))
615	0	goto err;
616	958	olen = len + EVP_CCM_TLS_EXPLICIT_IV_LEN + ctx->m;
617	77.2k	} else {
618	77.2k	if (!ctx->hw->auth_decrypt(ctx, in, out, len,
619	77.2k	(unsigned char *)in + len, ctx->m))
620	77.1k	goto err;
621	78	olen = len;
622	78	}
623	1.03k	rv = 1;
624	78.1k	err:
625	78.1k	*padlen = olen;
626	78.1k	return rv;
627	1.03k	}
628
629		static int ccm_cipher_internal(PROV_CCM_CTX ctx, unsigned char out,
630		size_t padlen, const unsigned char in,
631		size_t len)
632	78.1k	{
633	78.1k	int rv = 0;
634	78.1k	size_t olen = 0;
635	78.1k	const PROV_CCM_HW *hw = ctx->hw;
636
637		/* If no key set, return error */
638	78.1k	if (!ctx->key_set)
639	0	return 0;
640
641	78.1k	if (ctx->tls_aad_len != UNINITIALISED_SIZET)
642	78.1k	return ccm_tls_cipher(ctx, out, padlen, in, len);
643
644		/* EVP_Final() doesn't return any data /
645	2	if (in == NULL && out != NULL)
646	0	goto finish;
647
648	2	if (!ctx->iv_set)
649	2	goto err;
650
651	0	if (out == NULL) {
652	0	if (in == NULL) {
653	0	if (!ccm_set_iv(ctx, len))
654	0	goto err;
655	0	} else {
656		/* If we have AAD, we need a message length */
657	0	if (!ctx->len_set && len)
658	0	goto err;
659	0	if (!hw->setaad(ctx, in, len))
660	0	goto err;
661	0	}
662	0	} else {
663		/* If not set length yet do it */
664	0	if (!ctx->len_set && !ccm_set_iv(ctx, len))
665	0	goto err;
666
667	0	if (ctx->enc) {
668	0	if (!hw->auth_encrypt(ctx, in, out, len, NULL, 0))
669	0	goto err;
670	0	ctx->tag_set = 1;
671	0	} else {
672		/* The tag must be set before actually decrypting data */
673	0	if (!ctx->tag_set)
674	0	goto err;
675
676	0	if (!hw->auth_decrypt(ctx, in, out, len, ctx->buf, ctx->m))
677	0	goto err;
678		/* Finished - reset flags so calling this method again will fail */
679	0	ctx->iv_set = 0;
680	0	ctx->tag_set = 0;
681	0	ctx->len_set = 0;
682	0	}
683	0	}
684	0	olen = len;
685	0	finish:
686	0	rv = 1;
687	2	err:
688	2	*padlen = olen;
689	2	return rv;
690	0	}
691
692		void ossl_ccm_initctx(PROV_CCM_CTX ctx, size_t keybits, const PROV_CCM_HW hw)
693	2.04k	{
694	2.04k	ctx->keylen = keybits / 8;
695	2.04k	ctx->key_set = 0;
696	2.04k	ctx->iv_set = 0;
697	2.04k	ctx->tag_set = 0;
698	2.04k	ctx->len_set = 0;
699	2.04k	ctx->l = 8;
700	2.04k	ctx->m = 12;
701	2.04k	ctx->tls_aad_len = UNINITIALISED_SIZET;
702	2.04k	ctx->hw = hw;
703	2.04k	}