Coverage Report

Created: 2026-10-28 06:28

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl36/crypto/cmac/cmac.c
Line
Count
Source
1
/*
2
 * Copyright 2010-2025 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
10
/*
11
 * CMAC low level APIs are deprecated for public use, but still ok for internal
12
 * use.
13
 */
14
#include "internal/deprecated.h"
15
16
#include <stdio.h>
17
#include <stdlib.h>
18
#include <string.h>
19
#include "internal/cryptlib.h"
20
#include <openssl/cmac.h>
21
#include <openssl/err.h>
22
#include "crypto/cmac.h"
23
24
2.91k
#define LOCAL_BUF_SIZE 2048
25
struct CMAC_CTX_st {
26
    /* Cipher context to use */
27
    EVP_CIPHER_CTX *cctx;
28
    /* Keys k1 and k2 */
29
    unsigned char k1[EVP_MAX_BLOCK_LENGTH];
30
    unsigned char k2[EVP_MAX_BLOCK_LENGTH];
31
    /* Temporary block */
32
    unsigned char tbl[EVP_MAX_BLOCK_LENGTH];
33
    /* Last (possibly partial) block */
34
    unsigned char last_block[EVP_MAX_BLOCK_LENGTH];
35
    /* Number of bytes in last block: -1 means context not initialised */
36
    int nlast_block;
37
};
38
39
/* Make temporary keys K1 and K2 */
40
41
static void make_kn(unsigned char *k1, const unsigned char *l, int bl)
42
1.96k
{
43
1.96k
    int i;
44
1.96k
    unsigned char c = l[0], carry = c >> 7, cnext;
45
46
    /* Shift block to left, including carry */
47
29.4k
    for (i = 0; i < bl - 1; i++, c = cnext)
48
27.4k
        k1[i] = (c << 1) | ((cnext = l[i + 1]) >> 7);
49
50
    /* If MSB set fixup with R */
51
1.96k
    k1[i] = (c << 1) ^ ((0 - carry) & (bl == 16 ? 0x87 : 0x1b));
52
1.96k
}
53
54
CMAC_CTX *CMAC_CTX_new(void)
55
2.56k
{
56
2.56k
    CMAC_CTX *ctx;
57
58
2.56k
    if ((ctx = OPENSSL_malloc(sizeof(*ctx))) == NULL)
59
0
        return NULL;
60
2.56k
    ctx->cctx = EVP_CIPHER_CTX_new();
61
2.56k
    if (ctx->cctx == NULL) {
62
0
        OPENSSL_free(ctx);
63
0
        return NULL;
64
0
    }
65
2.56k
    ctx->nlast_block = -1;
66
2.56k
    return ctx;
67
2.56k
}
68
69
void CMAC_CTX_cleanup(CMAC_CTX *ctx)
70
2.56k
{
71
2.56k
    EVP_CIPHER_CTX_reset(ctx->cctx);
72
2.56k
    OPENSSL_cleanse(ctx->tbl, EVP_MAX_BLOCK_LENGTH);
73
2.56k
    OPENSSL_cleanse(ctx->k1, EVP_MAX_BLOCK_LENGTH);
74
2.56k
    OPENSSL_cleanse(ctx->k2, EVP_MAX_BLOCK_LENGTH);
75
2.56k
    OPENSSL_cleanse(ctx->last_block, EVP_MAX_BLOCK_LENGTH);
76
2.56k
    ctx->nlast_block = -1;
77
2.56k
}
78
79
EVP_CIPHER_CTX *CMAC_CTX_get0_cipher_ctx(CMAC_CTX *ctx)
80
1.86k
{
81
1.86k
    return ctx->cctx;
82
1.86k
}
83
84
void CMAC_CTX_free(CMAC_CTX *ctx)
85
2.56k
{
86
2.56k
    if (!ctx)
87
0
        return;
88
2.56k
    CMAC_CTX_cleanup(ctx);
89
2.56k
    EVP_CIPHER_CTX_free(ctx->cctx);
90
2.56k
    OPENSSL_free(ctx);
91
2.56k
}
92
93
int CMAC_CTX_copy(CMAC_CTX *out, const CMAC_CTX *in)
94
1.48k
{
95
1.48k
    int bl;
96
97
1.48k
    if (in->nlast_block == -1)
98
0
        return 0;
99
1.48k
    if ((bl = EVP_CIPHER_CTX_get_block_size(in->cctx)) == 0)
100
0
        return 0;
101
1.48k
    if (!EVP_CIPHER_CTX_copy(out->cctx, in->cctx))
102
0
        return 0;
103
1.48k
    memcpy(out->k1, in->k1, bl);
104
1.48k
    memcpy(out->k2, in->k2, bl);
105
1.48k
    memcpy(out->tbl, in->tbl, bl);
106
1.48k
    memcpy(out->last_block, in->last_block, bl);
107
1.48k
    out->nlast_block = in->nlast_block;
108
1.48k
    return 1;
109
1.48k
}
110
111
int ossl_cmac_init(CMAC_CTX *ctx, const void *key, size_t keylen,
112
    const EVP_CIPHER *cipher, ENGINE *impl,
113
    const OSSL_PARAM param[])
114
283
{
115
283
    static const unsigned char zero_iv[EVP_MAX_BLOCK_LENGTH] = { 0 };
116
283
    int block_len;
117
118
    /* All zeros means restart */
119
283
    if (!key && !cipher && !impl && keylen == 0) {
120
        /* Not initialised */
121
0
        if (ctx->nlast_block == -1)
122
0
            return 0;
123
0
        if (!EVP_EncryptInit_ex2(ctx->cctx, NULL, NULL, zero_iv, param))
124
0
            return 0;
125
0
        block_len = EVP_CIPHER_CTX_get_block_size(ctx->cctx);
126
0
        if (block_len == 0)
127
0
            return 0;
128
0
        memset(ctx->tbl, 0, block_len);
129
0
        ctx->nlast_block = 0;
130
0
        return 1;
131
0
    }
132
    /* Initialise context */
133
283
    if (cipher != NULL) {
134
        /* Ensure we can't use this ctx until we also have a key */
135
163
        ctx->nlast_block = -1;
136
163
        if (impl != NULL) {
137
0
            if (!EVP_EncryptInit_ex(ctx->cctx, cipher, impl, NULL, NULL))
138
0
                return 0;
139
163
        } else {
140
163
            if (!EVP_EncryptInit_ex2(ctx->cctx, cipher, NULL, NULL, param))
141
0
                return 0;
142
163
        }
143
163
    }
144
    /* Non-NULL key means initialisation complete */
145
283
    if (key != NULL) {
146
283
        int bl;
147
148
        /* If anything fails then ensure we can't use this ctx */
149
283
        ctx->nlast_block = -1;
150
283
        if (EVP_CIPHER_CTX_get0_cipher(ctx->cctx) == NULL)
151
1
            return 0;
152
282
        if (keylen > INT_MAX
153
282
            || EVP_CIPHER_CTX_set_key_length(ctx->cctx, (int)keylen) <= 0)
154
58
            return 0;
155
224
        if (!EVP_EncryptInit_ex2(ctx->cctx, NULL, key, zero_iv, param))
156
0
            return 0;
157
224
        if ((bl = EVP_CIPHER_CTX_get_block_size(ctx->cctx)) < 0)
158
0
            return 0;
159
224
        if (EVP_Cipher(ctx->cctx, ctx->tbl, zero_iv, bl) <= 0)
160
0
            return 0;
161
224
        make_kn(ctx->k1, ctx->tbl, bl);
162
224
        make_kn(ctx->k2, ctx->k1, bl);
163
224
        OPENSSL_cleanse(ctx->tbl, bl);
164
        /* Reset context again ready for first data block */
165
224
        if (!EVP_EncryptInit_ex2(ctx->cctx, NULL, NULL, zero_iv, param))
166
0
            return 0;
167
        /* Zero tbl so resume works */
168
224
        memset(ctx->tbl, 0, bl);
169
224
        ctx->nlast_block = 0;
170
224
    }
171
224
    return 1;
172
283
}
173
174
int CMAC_Init(CMAC_CTX *ctx, const void *key, size_t keylen,
175
    const EVP_CIPHER *cipher, ENGINE *impl)
176
0
{
177
0
    return ossl_cmac_init(ctx, key, keylen, cipher, impl, NULL);
178
0
}
179
180
int CMAC_Update(CMAC_CTX *ctx, const void *in, size_t dlen)
181
3.82k
{
182
3.82k
    const unsigned char *data = in;
183
3.82k
    int bl;
184
3.82k
    size_t max_burst_blocks, cipher_blocks;
185
3.82k
    unsigned char buf[LOCAL_BUF_SIZE];
186
187
3.82k
    if (ctx->nlast_block == -1)
188
0
        return 0;
189
3.82k
    if (dlen == 0)
190
240
        return 1;
191
3.58k
    if ((bl = EVP_CIPHER_CTX_get_block_size(ctx->cctx)) == 0)
192
0
        return 0;
193
    /* Copy into partial block if we need to */
194
3.58k
    if (ctx->nlast_block > 0) {
195
2.10k
        size_t nleft;
196
197
2.10k
        nleft = bl - ctx->nlast_block;
198
2.10k
        if (dlen < nleft)
199
582
            nleft = dlen;
200
2.10k
        memcpy(ctx->last_block + ctx->nlast_block, data, nleft);
201
2.10k
        dlen -= nleft;
202
2.10k
        ctx->nlast_block += (int)nleft;
203
        /* If no more to process return */
204
2.10k
        if (dlen == 0)
205
672
            return 1;
206
1.43k
        data += nleft;
207
        /* Else not final block so encrypt it */
208
1.43k
        if (EVP_Cipher(ctx->cctx, ctx->tbl, ctx->last_block, bl) <= 0)
209
0
            return 0;
210
1.43k
    }
211
    /* Encrypt all but one of the complete blocks left */
212
213
2.91k
    max_burst_blocks = LOCAL_BUF_SIZE / bl;
214
2.91k
    cipher_blocks = (dlen - 1) / bl;
215
2.91k
    if (max_burst_blocks == 0) {
216
        /*
217
         * When block length is greater than local buffer size,
218
         * use ctx->tbl as cipher output.
219
         */
220
0
        while (dlen > (size_t)bl) {
221
0
            if (EVP_Cipher(ctx->cctx, ctx->tbl, data, bl) <= 0)
222
0
                return 0;
223
0
            dlen -= bl;
224
0
            data += bl;
225
0
        }
226
2.91k
    } else {
227
15.6k
        while (cipher_blocks > max_burst_blocks) {
228
12.7k
            if (EVP_Cipher(ctx->cctx, buf, data, (int)(max_burst_blocks * bl)) <= 0)
229
0
                return 0;
230
12.7k
            dlen -= max_burst_blocks * bl;
231
12.7k
            data += max_burst_blocks * bl;
232
12.7k
            cipher_blocks -= max_burst_blocks;
233
12.7k
        }
234
2.91k
        if (cipher_blocks > 0) {
235
1.14k
            if (EVP_Cipher(ctx->cctx, buf, data, (int)(cipher_blocks * bl)) <= 0)
236
0
                return 0;
237
1.14k
            dlen -= cipher_blocks * bl;
238
1.14k
            data += cipher_blocks * bl;
239
1.14k
            memcpy(ctx->tbl, &buf[(cipher_blocks - 1) * bl], bl);
240
1.14k
        }
241
2.91k
    }
242
    /* Copy any data left to last block buffer */
243
2.91k
    memcpy(ctx->last_block, data, dlen);
244
2.91k
    ctx->nlast_block = (int)dlen;
245
2.91k
    return 1;
246
2.91k
}
247
248
int CMAC_Final(CMAC_CTX *ctx, unsigned char *out, size_t *poutlen)
249
1.48k
{
250
1.48k
    int i, bl, lb;
251
252
1.48k
    if (ctx->nlast_block == -1)
253
0
        return 0;
254
1.48k
    if ((bl = EVP_CIPHER_CTX_get_block_size(ctx->cctx)) == 0)
255
0
        return 0;
256
1.48k
    if (poutlen != NULL)
257
1.48k
        *poutlen = (size_t)bl;
258
1.48k
    if (!out)
259
0
        return 1;
260
1.48k
    lb = ctx->nlast_block;
261
    /* Is last block complete? */
262
1.48k
    if (lb == bl) {
263
12.4k
        for (i = 0; i < bl; i++)
264
11.7k
            out[i] = ctx->last_block[i] ^ ctx->k1[i];
265
747
    } else {
266
738
        ctx->last_block[lb] = 0x80;
267
738
        if (bl - lb > 1)
268
656
            memset(ctx->last_block + lb + 1, 0, bl - lb - 1);
269
11.0k
        for (i = 0; i < bl; i++)
270
10.2k
            out[i] = ctx->last_block[i] ^ ctx->k2[i];
271
738
    }
272
1.48k
    if (EVP_Cipher(ctx->cctx, out, out, bl) <= 0) {
273
0
        OPENSSL_cleanse(out, bl);
274
0
        return 0;
275
0
    }
276
1.48k
    return 1;
277
1.48k
}
278
279
int CMAC_resume(CMAC_CTX *ctx)
280
0
{
281
0
    if (ctx->nlast_block == -1)
282
0
        return 0;
283
    /*
284
     * The buffer "tbl" contains the last fully encrypted block which is the
285
     * last IV (or all zeroes if no last encrypted block). The last block has
286
     * not been modified since CMAC_final(). So reinitialising using the last
287
     * decrypted block will allow CMAC to continue after calling
288
     * CMAC_Final().
289
     */
290
0
    return EVP_EncryptInit_ex(ctx->cctx, NULL, NULL, NULL, ctx->tbl);
291
0
}