Coverage Report

Created: 2024-01-20 12:36

/src/openssl/crypto/cmac/cmac.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2010-2018 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
23
struct CMAC_CTX_st {
24
    /* Cipher context to use */
25
    EVP_CIPHER_CTX *cctx;
26
    /* Keys k1 and k2 */
27
    unsigned char k1[EVP_MAX_BLOCK_LENGTH];
28
    unsigned char k2[EVP_MAX_BLOCK_LENGTH];
29
    /* Temporary block */
30
    unsigned char tbl[EVP_MAX_BLOCK_LENGTH];
31
    /* Last (possibly partial) block */
32
    unsigned char last_block[EVP_MAX_BLOCK_LENGTH];
33
    /* Number of bytes in last block: -1 means context not initialised */
34
    int nlast_block;
35
};
36
37
/* Make temporary keys K1 and K2 */
38
39
static void make_kn(unsigned char *k1, const unsigned char *l, int bl)
40
0
{
41
0
    int i;
42
0
    unsigned char c = l[0], carry = c >> 7, cnext;
43
44
    /* Shift block to left, including carry */
45
0
    for (i = 0; i < bl - 1; i++, c = cnext)
46
0
        k1[i] = (c << 1) | ((cnext = l[i + 1]) >> 7);
47
48
    /* If MSB set fixup with R */
49
0
    k1[i] = (c << 1) ^ ((0 - carry) & (bl == 16 ? 0x87 : 0x1b));
50
0
}
51
52
CMAC_CTX *CMAC_CTX_new(void)
53
0
{
54
0
    CMAC_CTX *ctx;
55
56
0
    if ((ctx = OPENSSL_malloc(sizeof(*ctx))) == NULL) {
57
0
        CRYPTOerr(CRYPTO_F_CMAC_CTX_NEW, ERR_R_MALLOC_FAILURE);
58
0
        return NULL;
59
0
    }
60
0
    ctx->cctx = EVP_CIPHER_CTX_new();
61
0
    if (ctx->cctx == NULL) {
62
0
        OPENSSL_free(ctx);
63
0
        return NULL;
64
0
    }
65
0
    ctx->nlast_block = -1;
66
0
    return ctx;
67
0
}
68
69
void CMAC_CTX_cleanup(CMAC_CTX *ctx)
70
0
{
71
0
    EVP_CIPHER_CTX_reset(ctx->cctx);
72
0
    OPENSSL_cleanse(ctx->tbl, EVP_MAX_BLOCK_LENGTH);
73
0
    OPENSSL_cleanse(ctx->k1, EVP_MAX_BLOCK_LENGTH);
74
0
    OPENSSL_cleanse(ctx->k2, EVP_MAX_BLOCK_LENGTH);
75
0
    OPENSSL_cleanse(ctx->last_block, EVP_MAX_BLOCK_LENGTH);
76
0
    ctx->nlast_block = -1;
77
0
}
78
79
EVP_CIPHER_CTX *CMAC_CTX_get0_cipher_ctx(CMAC_CTX *ctx)
80
0
{
81
0
    return ctx->cctx;
82
0
}
83
84
void CMAC_CTX_free(CMAC_CTX *ctx)
85
0
{
86
0
    if (!ctx)
87
0
        return;
88
0
    CMAC_CTX_cleanup(ctx);
89
0
    EVP_CIPHER_CTX_free(ctx->cctx);
90
0
    OPENSSL_free(ctx);
91
0
}
92
93
int CMAC_CTX_copy(CMAC_CTX *out, const CMAC_CTX *in)
94
0
{
95
0
    int bl;
96
97
0
    if (in->nlast_block == -1)
98
0
        return 0;
99
0
    if ((bl = EVP_CIPHER_CTX_block_size(in->cctx)) < 0)
100
0
        return 0;
101
0
    if (!EVP_CIPHER_CTX_copy(out->cctx, in->cctx))
102
0
        return 0;
103
0
    memcpy(out->k1, in->k1, bl);
104
0
    memcpy(out->k2, in->k2, bl);
105
0
    memcpy(out->tbl, in->tbl, bl);
106
0
    memcpy(out->last_block, in->last_block, bl);
107
0
    out->nlast_block = in->nlast_block;
108
0
    return 1;
109
0
}
110
111
int CMAC_Init(CMAC_CTX *ctx, const void *key, size_t keylen,
112
              const EVP_CIPHER *cipher, ENGINE *impl)
113
0
{
114
0
    static const unsigned char zero_iv[EVP_MAX_BLOCK_LENGTH] = { 0 };
115
116
    /* All zeros means restart */
117
0
    if (!key && !cipher && !impl && keylen == 0) {
118
        /* Not initialised */
119
0
        if (ctx->nlast_block == -1)
120
0
            return 0;
121
0
        if (!EVP_EncryptInit_ex(ctx->cctx, NULL, NULL, NULL, zero_iv))
122
0
            return 0;
123
0
        memset(ctx->tbl, 0, EVP_CIPHER_CTX_block_size(ctx->cctx));
124
0
        ctx->nlast_block = 0;
125
0
        return 1;
126
0
    }
127
    /* Initialise context */
128
0
    if (cipher && !EVP_EncryptInit_ex(ctx->cctx, cipher, impl, NULL, NULL))
129
0
        return 0;
130
    /* Non-NULL key means initialisation complete */
131
0
    if (key) {
132
0
        int bl;
133
134
0
        if (!EVP_CIPHER_CTX_cipher(ctx->cctx))
135
0
            return 0;
136
0
        if (!EVP_CIPHER_CTX_set_key_length(ctx->cctx, keylen))
137
0
            return 0;
138
0
        if (!EVP_EncryptInit_ex(ctx->cctx, NULL, NULL, key, zero_iv))
139
0
            return 0;
140
0
        if ((bl = EVP_CIPHER_CTX_block_size(ctx->cctx)) < 0)
141
0
            return 0;
142
0
        if (!EVP_Cipher(ctx->cctx, ctx->tbl, zero_iv, bl))
143
0
            return 0;
144
0
        make_kn(ctx->k1, ctx->tbl, bl);
145
0
        make_kn(ctx->k2, ctx->k1, bl);
146
0
        OPENSSL_cleanse(ctx->tbl, bl);
147
        /* Reset context again ready for first data block */
148
0
        if (!EVP_EncryptInit_ex(ctx->cctx, NULL, NULL, NULL, zero_iv))
149
0
            return 0;
150
        /* Zero tbl so resume works */
151
0
        memset(ctx->tbl, 0, bl);
152
0
        ctx->nlast_block = 0;
153
0
    }
154
0
    return 1;
155
0
}
156
157
int CMAC_Update(CMAC_CTX *ctx, const void *in, size_t dlen)
158
0
{
159
0
    const unsigned char *data = in;
160
0
    int bl;
161
162
0
    if (ctx->nlast_block == -1)
163
0
        return 0;
164
0
    if (dlen == 0)
165
0
        return 1;
166
0
    if ((bl = EVP_CIPHER_CTX_block_size(ctx->cctx)) < 0)
167
0
        return 0;
168
    /* Copy into partial block if we need to */
169
0
    if (ctx->nlast_block > 0) {
170
0
        size_t nleft;
171
172
0
        nleft = bl - ctx->nlast_block;
173
0
        if (dlen < nleft)
174
0
            nleft = dlen;
175
0
        memcpy(ctx->last_block + ctx->nlast_block, data, nleft);
176
0
        dlen -= nleft;
177
0
        ctx->nlast_block += nleft;
178
        /* If no more to process return */
179
0
        if (dlen == 0)
180
0
            return 1;
181
0
        data += nleft;
182
        /* Else not final block so encrypt it */
183
0
        if (!EVP_Cipher(ctx->cctx, ctx->tbl, ctx->last_block, bl))
184
0
            return 0;
185
0
    }
186
    /* Encrypt all but one of the complete blocks left */
187
0
    while (dlen > (size_t)bl) {
188
0
        if (!EVP_Cipher(ctx->cctx, ctx->tbl, data, bl))
189
0
            return 0;
190
0
        dlen -= bl;
191
0
        data += bl;
192
0
    }
193
    /* Copy any data left to last block buffer */
194
0
    memcpy(ctx->last_block, data, dlen);
195
0
    ctx->nlast_block = dlen;
196
0
    return 1;
197
198
0
}
199
200
int CMAC_Final(CMAC_CTX *ctx, unsigned char *out, size_t *poutlen)
201
0
{
202
0
    int i, bl, lb;
203
204
0
    if (ctx->nlast_block == -1)
205
0
        return 0;
206
0
    if ((bl = EVP_CIPHER_CTX_block_size(ctx->cctx)) < 0)
207
0
        return 0;
208
0
    if (poutlen != NULL)
209
0
        *poutlen = (size_t)bl;
210
0
    if (!out)
211
0
        return 1;
212
0
    lb = ctx->nlast_block;
213
    /* Is last block complete? */
214
0
    if (lb == bl) {
215
0
        for (i = 0; i < bl; i++)
216
0
            out[i] = ctx->last_block[i] ^ ctx->k1[i];
217
0
    } else {
218
0
        ctx->last_block[lb] = 0x80;
219
0
        if (bl - lb > 1)
220
0
            memset(ctx->last_block + lb + 1, 0, bl - lb - 1);
221
0
        for (i = 0; i < bl; i++)
222
0
            out[i] = ctx->last_block[i] ^ ctx->k2[i];
223
0
    }
224
0
    if (!EVP_Cipher(ctx->cctx, out, out, bl)) {
225
0
        OPENSSL_cleanse(out, bl);
226
0
        return 0;
227
0
    }
228
0
    return 1;
229
0
}
230
231
int CMAC_resume(CMAC_CTX *ctx)
232
0
{
233
0
    if (ctx->nlast_block == -1)
234
0
        return 0;
235
    /*
236
     * The buffer "tbl" contains the last fully encrypted block which is the
237
     * last IV (or all zeroes if no last encrypted block). The last block has
238
     * not been modified since CMAC_final(). So reinitialising using the last
239
     * decrypted block will allow CMAC to continue after calling
240
     * CMAC_Final().
241
     */
242
0
    return EVP_EncryptInit_ex(ctx->cctx, NULL, NULL, NULL, ctx->tbl);
243
0
}