xref: /aosp_15_r20/external/mbedtls/library/nist_kw.c (revision 62c56f9862f102b96d72393aff6076c951fb8148)
1*62c56f98SSadaf Ebrahimi /*
2*62c56f98SSadaf Ebrahimi  *  Implementation of NIST SP 800-38F key wrapping, supporting KW and KWP modes
3*62c56f98SSadaf Ebrahimi  *  only
4*62c56f98SSadaf Ebrahimi  *
5*62c56f98SSadaf Ebrahimi  *  Copyright The Mbed TLS Contributors
6*62c56f98SSadaf Ebrahimi  *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
7*62c56f98SSadaf Ebrahimi  */
8*62c56f98SSadaf Ebrahimi /*
9*62c56f98SSadaf Ebrahimi  * Definition of Key Wrapping:
10*62c56f98SSadaf Ebrahimi  * https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-38F.pdf
11*62c56f98SSadaf Ebrahimi  * RFC 3394 "Advanced Encryption Standard (AES) Key Wrap Algorithm"
12*62c56f98SSadaf Ebrahimi  * RFC 5649 "Advanced Encryption Standard (AES) Key Wrap with Padding Algorithm"
13*62c56f98SSadaf Ebrahimi  *
14*62c56f98SSadaf Ebrahimi  * Note: RFC 3394 defines different methodology for intermediate operations for
15*62c56f98SSadaf Ebrahimi  * the wrapping and unwrapping operation than the definition in NIST SP 800-38F.
16*62c56f98SSadaf Ebrahimi  */
17*62c56f98SSadaf Ebrahimi 
18*62c56f98SSadaf Ebrahimi #include "common.h"
19*62c56f98SSadaf Ebrahimi 
20*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_NIST_KW_C)
21*62c56f98SSadaf Ebrahimi 
22*62c56f98SSadaf Ebrahimi #include "mbedtls/nist_kw.h"
23*62c56f98SSadaf Ebrahimi #include "mbedtls/platform_util.h"
24*62c56f98SSadaf Ebrahimi #include "mbedtls/error.h"
25*62c56f98SSadaf Ebrahimi #include "mbedtls/constant_time.h"
26*62c56f98SSadaf Ebrahimi #include "constant_time_internal.h"
27*62c56f98SSadaf Ebrahimi 
28*62c56f98SSadaf Ebrahimi #include <stdint.h>
29*62c56f98SSadaf Ebrahimi #include <string.h>
30*62c56f98SSadaf Ebrahimi 
31*62c56f98SSadaf Ebrahimi #include "mbedtls/platform.h"
32*62c56f98SSadaf Ebrahimi 
33*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_NIST_KW_ALT)
34*62c56f98SSadaf Ebrahimi 
35*62c56f98SSadaf Ebrahimi #define KW_SEMIBLOCK_LENGTH    8
36*62c56f98SSadaf Ebrahimi #define MIN_SEMIBLOCKS_COUNT   3
37*62c56f98SSadaf Ebrahimi 
38*62c56f98SSadaf Ebrahimi /*! The 64-bit default integrity check value (ICV) for KW mode. */
39*62c56f98SSadaf Ebrahimi static const unsigned char NIST_KW_ICV1[] = { 0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6 };
40*62c56f98SSadaf Ebrahimi /*! The 32-bit default integrity check value (ICV) for KWP mode. */
41*62c56f98SSadaf Ebrahimi static const  unsigned char NIST_KW_ICV2[] = { 0xA6, 0x59, 0x59, 0xA6 };
42*62c56f98SSadaf Ebrahimi 
43*62c56f98SSadaf Ebrahimi /*
44*62c56f98SSadaf Ebrahimi  * Initialize context
45*62c56f98SSadaf Ebrahimi  */
mbedtls_nist_kw_init(mbedtls_nist_kw_context * ctx)46*62c56f98SSadaf Ebrahimi void mbedtls_nist_kw_init(mbedtls_nist_kw_context *ctx)
47*62c56f98SSadaf Ebrahimi {
48*62c56f98SSadaf Ebrahimi     memset(ctx, 0, sizeof(mbedtls_nist_kw_context));
49*62c56f98SSadaf Ebrahimi }
50*62c56f98SSadaf Ebrahimi 
mbedtls_nist_kw_setkey(mbedtls_nist_kw_context * ctx,mbedtls_cipher_id_t cipher,const unsigned char * key,unsigned int keybits,const int is_wrap)51*62c56f98SSadaf Ebrahimi int mbedtls_nist_kw_setkey(mbedtls_nist_kw_context *ctx,
52*62c56f98SSadaf Ebrahimi                            mbedtls_cipher_id_t cipher,
53*62c56f98SSadaf Ebrahimi                            const unsigned char *key,
54*62c56f98SSadaf Ebrahimi                            unsigned int keybits,
55*62c56f98SSadaf Ebrahimi                            const int is_wrap)
56*62c56f98SSadaf Ebrahimi {
57*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
58*62c56f98SSadaf Ebrahimi     const mbedtls_cipher_info_t *cipher_info;
59*62c56f98SSadaf Ebrahimi 
60*62c56f98SSadaf Ebrahimi     cipher_info = mbedtls_cipher_info_from_values(cipher,
61*62c56f98SSadaf Ebrahimi                                                   keybits,
62*62c56f98SSadaf Ebrahimi                                                   MBEDTLS_MODE_ECB);
63*62c56f98SSadaf Ebrahimi     if (cipher_info == NULL) {
64*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
65*62c56f98SSadaf Ebrahimi     }
66*62c56f98SSadaf Ebrahimi 
67*62c56f98SSadaf Ebrahimi     if (mbedtls_cipher_info_get_block_size(cipher_info) != 16) {
68*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
69*62c56f98SSadaf Ebrahimi     }
70*62c56f98SSadaf Ebrahimi 
71*62c56f98SSadaf Ebrahimi     /*
72*62c56f98SSadaf Ebrahimi      * SP 800-38F currently defines AES cipher as the only block cipher allowed:
73*62c56f98SSadaf Ebrahimi      * "For KW and KWP, the underlying block cipher shall be approved, and the
74*62c56f98SSadaf Ebrahimi      *  block size shall be 128 bits. Currently, the AES block cipher, with key
75*62c56f98SSadaf Ebrahimi      *  lengths of 128, 192, or 256 bits, is the only block cipher that fits
76*62c56f98SSadaf Ebrahimi      *  this profile."
77*62c56f98SSadaf Ebrahimi      *  Currently we don't support other 128 bit block ciphers for key wrapping,
78*62c56f98SSadaf Ebrahimi      *  such as Camellia and Aria.
79*62c56f98SSadaf Ebrahimi      */
80*62c56f98SSadaf Ebrahimi     if (cipher != MBEDTLS_CIPHER_ID_AES) {
81*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
82*62c56f98SSadaf Ebrahimi     }
83*62c56f98SSadaf Ebrahimi 
84*62c56f98SSadaf Ebrahimi     mbedtls_cipher_free(&ctx->cipher_ctx);
85*62c56f98SSadaf Ebrahimi 
86*62c56f98SSadaf Ebrahimi     if ((ret = mbedtls_cipher_setup(&ctx->cipher_ctx, cipher_info)) != 0) {
87*62c56f98SSadaf Ebrahimi         return ret;
88*62c56f98SSadaf Ebrahimi     }
89*62c56f98SSadaf Ebrahimi 
90*62c56f98SSadaf Ebrahimi     if ((ret = mbedtls_cipher_setkey(&ctx->cipher_ctx, key, keybits,
91*62c56f98SSadaf Ebrahimi                                      is_wrap ? MBEDTLS_ENCRYPT :
92*62c56f98SSadaf Ebrahimi                                      MBEDTLS_DECRYPT)
93*62c56f98SSadaf Ebrahimi          ) != 0) {
94*62c56f98SSadaf Ebrahimi         return ret;
95*62c56f98SSadaf Ebrahimi     }
96*62c56f98SSadaf Ebrahimi 
97*62c56f98SSadaf Ebrahimi     return 0;
98*62c56f98SSadaf Ebrahimi }
99*62c56f98SSadaf Ebrahimi 
100*62c56f98SSadaf Ebrahimi /*
101*62c56f98SSadaf Ebrahimi  * Free context
102*62c56f98SSadaf Ebrahimi  */
mbedtls_nist_kw_free(mbedtls_nist_kw_context * ctx)103*62c56f98SSadaf Ebrahimi void mbedtls_nist_kw_free(mbedtls_nist_kw_context *ctx)
104*62c56f98SSadaf Ebrahimi {
105*62c56f98SSadaf Ebrahimi     mbedtls_cipher_free(&ctx->cipher_ctx);
106*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(ctx, sizeof(mbedtls_nist_kw_context));
107*62c56f98SSadaf Ebrahimi }
108*62c56f98SSadaf Ebrahimi 
109*62c56f98SSadaf Ebrahimi /*
110*62c56f98SSadaf Ebrahimi  * Helper function for Xoring the uint64_t "t" with the encrypted A.
111*62c56f98SSadaf Ebrahimi  * Defined in NIST SP 800-38F section 6.1
112*62c56f98SSadaf Ebrahimi  */
calc_a_xor_t(unsigned char A[KW_SEMIBLOCK_LENGTH],uint64_t t)113*62c56f98SSadaf Ebrahimi static void calc_a_xor_t(unsigned char A[KW_SEMIBLOCK_LENGTH], uint64_t t)
114*62c56f98SSadaf Ebrahimi {
115*62c56f98SSadaf Ebrahimi     size_t i = 0;
116*62c56f98SSadaf Ebrahimi     for (i = 0; i < sizeof(t); i++) {
117*62c56f98SSadaf Ebrahimi         A[i] ^= (t >> ((sizeof(t) - 1 - i) * 8)) & 0xff;
118*62c56f98SSadaf Ebrahimi     }
119*62c56f98SSadaf Ebrahimi }
120*62c56f98SSadaf Ebrahimi 
121*62c56f98SSadaf Ebrahimi /*
122*62c56f98SSadaf Ebrahimi  * KW-AE as defined in SP 800-38F section 6.2
123*62c56f98SSadaf Ebrahimi  * KWP-AE as defined in SP 800-38F section 6.3
124*62c56f98SSadaf Ebrahimi  */
mbedtls_nist_kw_wrap(mbedtls_nist_kw_context * ctx,mbedtls_nist_kw_mode_t mode,const unsigned char * input,size_t in_len,unsigned char * output,size_t * out_len,size_t out_size)125*62c56f98SSadaf Ebrahimi int mbedtls_nist_kw_wrap(mbedtls_nist_kw_context *ctx,
126*62c56f98SSadaf Ebrahimi                          mbedtls_nist_kw_mode_t mode,
127*62c56f98SSadaf Ebrahimi                          const unsigned char *input, size_t in_len,
128*62c56f98SSadaf Ebrahimi                          unsigned char *output, size_t *out_len, size_t out_size)
129*62c56f98SSadaf Ebrahimi {
130*62c56f98SSadaf Ebrahimi     int ret = 0;
131*62c56f98SSadaf Ebrahimi     size_t semiblocks = 0;
132*62c56f98SSadaf Ebrahimi     size_t s;
133*62c56f98SSadaf Ebrahimi     size_t olen, padlen = 0;
134*62c56f98SSadaf Ebrahimi     uint64_t t = 0;
135*62c56f98SSadaf Ebrahimi     unsigned char outbuff[KW_SEMIBLOCK_LENGTH * 2];
136*62c56f98SSadaf Ebrahimi     unsigned char inbuff[KW_SEMIBLOCK_LENGTH * 2];
137*62c56f98SSadaf Ebrahimi 
138*62c56f98SSadaf Ebrahimi     *out_len = 0;
139*62c56f98SSadaf Ebrahimi     /*
140*62c56f98SSadaf Ebrahimi      * Generate the String to work on
141*62c56f98SSadaf Ebrahimi      */
142*62c56f98SSadaf Ebrahimi     if (mode == MBEDTLS_KW_MODE_KW) {
143*62c56f98SSadaf Ebrahimi         if (out_size < in_len + KW_SEMIBLOCK_LENGTH) {
144*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
145*62c56f98SSadaf Ebrahimi         }
146*62c56f98SSadaf Ebrahimi 
147*62c56f98SSadaf Ebrahimi         /*
148*62c56f98SSadaf Ebrahimi          * According to SP 800-38F Table 1, the plaintext length for KW
149*62c56f98SSadaf Ebrahimi          * must be between 2 to 2^54-1 semiblocks inclusive.
150*62c56f98SSadaf Ebrahimi          */
151*62c56f98SSadaf Ebrahimi         if (in_len < 16 ||
152*62c56f98SSadaf Ebrahimi #if SIZE_MAX > 0x1FFFFFFFFFFFFF8
153*62c56f98SSadaf Ebrahimi             in_len > 0x1FFFFFFFFFFFFF8 ||
154*62c56f98SSadaf Ebrahimi #endif
155*62c56f98SSadaf Ebrahimi             in_len % KW_SEMIBLOCK_LENGTH != 0) {
156*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
157*62c56f98SSadaf Ebrahimi         }
158*62c56f98SSadaf Ebrahimi 
159*62c56f98SSadaf Ebrahimi         memcpy(output, NIST_KW_ICV1, KW_SEMIBLOCK_LENGTH);
160*62c56f98SSadaf Ebrahimi         memmove(output + KW_SEMIBLOCK_LENGTH, input, in_len);
161*62c56f98SSadaf Ebrahimi     } else {
162*62c56f98SSadaf Ebrahimi         if (in_len % 8 != 0) {
163*62c56f98SSadaf Ebrahimi             padlen = (8 - (in_len % 8));
164*62c56f98SSadaf Ebrahimi         }
165*62c56f98SSadaf Ebrahimi 
166*62c56f98SSadaf Ebrahimi         if (out_size < in_len + KW_SEMIBLOCK_LENGTH + padlen) {
167*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
168*62c56f98SSadaf Ebrahimi         }
169*62c56f98SSadaf Ebrahimi 
170*62c56f98SSadaf Ebrahimi         /*
171*62c56f98SSadaf Ebrahimi          * According to SP 800-38F Table 1, the plaintext length for KWP
172*62c56f98SSadaf Ebrahimi          * must be between 1 and 2^32-1 octets inclusive.
173*62c56f98SSadaf Ebrahimi          */
174*62c56f98SSadaf Ebrahimi         if (in_len < 1
175*62c56f98SSadaf Ebrahimi #if SIZE_MAX > 0xFFFFFFFF
176*62c56f98SSadaf Ebrahimi             || in_len > 0xFFFFFFFF
177*62c56f98SSadaf Ebrahimi #endif
178*62c56f98SSadaf Ebrahimi             ) {
179*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
180*62c56f98SSadaf Ebrahimi         }
181*62c56f98SSadaf Ebrahimi 
182*62c56f98SSadaf Ebrahimi         memcpy(output, NIST_KW_ICV2, KW_SEMIBLOCK_LENGTH / 2);
183*62c56f98SSadaf Ebrahimi         MBEDTLS_PUT_UINT32_BE((in_len & 0xffffffff), output,
184*62c56f98SSadaf Ebrahimi                               KW_SEMIBLOCK_LENGTH / 2);
185*62c56f98SSadaf Ebrahimi 
186*62c56f98SSadaf Ebrahimi         memcpy(output + KW_SEMIBLOCK_LENGTH, input, in_len);
187*62c56f98SSadaf Ebrahimi         memset(output + KW_SEMIBLOCK_LENGTH + in_len, 0, padlen);
188*62c56f98SSadaf Ebrahimi     }
189*62c56f98SSadaf Ebrahimi     semiblocks = ((in_len + padlen) / KW_SEMIBLOCK_LENGTH) + 1;
190*62c56f98SSadaf Ebrahimi 
191*62c56f98SSadaf Ebrahimi     s = 6 * (semiblocks - 1);
192*62c56f98SSadaf Ebrahimi 
193*62c56f98SSadaf Ebrahimi     if (mode == MBEDTLS_KW_MODE_KWP
194*62c56f98SSadaf Ebrahimi         && in_len <= KW_SEMIBLOCK_LENGTH) {
195*62c56f98SSadaf Ebrahimi         memcpy(inbuff, output, 16);
196*62c56f98SSadaf Ebrahimi         ret = mbedtls_cipher_update(&ctx->cipher_ctx,
197*62c56f98SSadaf Ebrahimi                                     inbuff, 16, output, &olen);
198*62c56f98SSadaf Ebrahimi         if (ret != 0) {
199*62c56f98SSadaf Ebrahimi             goto cleanup;
200*62c56f98SSadaf Ebrahimi         }
201*62c56f98SSadaf Ebrahimi     } else {
202*62c56f98SSadaf Ebrahimi         unsigned char *R2 = output + KW_SEMIBLOCK_LENGTH;
203*62c56f98SSadaf Ebrahimi         unsigned char *A = output;
204*62c56f98SSadaf Ebrahimi 
205*62c56f98SSadaf Ebrahimi         /*
206*62c56f98SSadaf Ebrahimi          * Do the wrapping function W, as defined in RFC 3394 section 2.2.1
207*62c56f98SSadaf Ebrahimi          */
208*62c56f98SSadaf Ebrahimi         if (semiblocks < MIN_SEMIBLOCKS_COUNT) {
209*62c56f98SSadaf Ebrahimi             ret = MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
210*62c56f98SSadaf Ebrahimi             goto cleanup;
211*62c56f98SSadaf Ebrahimi         }
212*62c56f98SSadaf Ebrahimi 
213*62c56f98SSadaf Ebrahimi         /* Calculate intermediate values */
214*62c56f98SSadaf Ebrahimi         for (t = 1; t <= s; t++) {
215*62c56f98SSadaf Ebrahimi             memcpy(inbuff, A, KW_SEMIBLOCK_LENGTH);
216*62c56f98SSadaf Ebrahimi             memcpy(inbuff + KW_SEMIBLOCK_LENGTH, R2, KW_SEMIBLOCK_LENGTH);
217*62c56f98SSadaf Ebrahimi 
218*62c56f98SSadaf Ebrahimi             ret = mbedtls_cipher_update(&ctx->cipher_ctx,
219*62c56f98SSadaf Ebrahimi                                         inbuff, 16, outbuff, &olen);
220*62c56f98SSadaf Ebrahimi             if (ret != 0) {
221*62c56f98SSadaf Ebrahimi                 goto cleanup;
222*62c56f98SSadaf Ebrahimi             }
223*62c56f98SSadaf Ebrahimi 
224*62c56f98SSadaf Ebrahimi             memcpy(A, outbuff, KW_SEMIBLOCK_LENGTH);
225*62c56f98SSadaf Ebrahimi             calc_a_xor_t(A, t);
226*62c56f98SSadaf Ebrahimi 
227*62c56f98SSadaf Ebrahimi             memcpy(R2, outbuff + KW_SEMIBLOCK_LENGTH, KW_SEMIBLOCK_LENGTH);
228*62c56f98SSadaf Ebrahimi             R2 += KW_SEMIBLOCK_LENGTH;
229*62c56f98SSadaf Ebrahimi             if (R2 >= output + (semiblocks * KW_SEMIBLOCK_LENGTH)) {
230*62c56f98SSadaf Ebrahimi                 R2 = output + KW_SEMIBLOCK_LENGTH;
231*62c56f98SSadaf Ebrahimi             }
232*62c56f98SSadaf Ebrahimi         }
233*62c56f98SSadaf Ebrahimi     }
234*62c56f98SSadaf Ebrahimi 
235*62c56f98SSadaf Ebrahimi     *out_len = semiblocks * KW_SEMIBLOCK_LENGTH;
236*62c56f98SSadaf Ebrahimi 
237*62c56f98SSadaf Ebrahimi cleanup:
238*62c56f98SSadaf Ebrahimi 
239*62c56f98SSadaf Ebrahimi     if (ret != 0) {
240*62c56f98SSadaf Ebrahimi         memset(output, 0, semiblocks * KW_SEMIBLOCK_LENGTH);
241*62c56f98SSadaf Ebrahimi     }
242*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(inbuff, KW_SEMIBLOCK_LENGTH * 2);
243*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(outbuff, KW_SEMIBLOCK_LENGTH * 2);
244*62c56f98SSadaf Ebrahimi 
245*62c56f98SSadaf Ebrahimi     return ret;
246*62c56f98SSadaf Ebrahimi }
247*62c56f98SSadaf Ebrahimi 
248*62c56f98SSadaf Ebrahimi /*
249*62c56f98SSadaf Ebrahimi  * W-1 function as defined in RFC 3394 section 2.2.2
250*62c56f98SSadaf Ebrahimi  * This function assumes the following:
251*62c56f98SSadaf Ebrahimi  * 1. Output buffer is at least of size ( semiblocks - 1 ) * KW_SEMIBLOCK_LENGTH.
252*62c56f98SSadaf Ebrahimi  * 2. The input buffer is of size semiblocks * KW_SEMIBLOCK_LENGTH.
253*62c56f98SSadaf Ebrahimi  * 3. Minimal number of semiblocks is 3.
254*62c56f98SSadaf Ebrahimi  * 4. A is a buffer to hold the first semiblock of the input buffer.
255*62c56f98SSadaf Ebrahimi  */
unwrap(mbedtls_nist_kw_context * ctx,const unsigned char * input,size_t semiblocks,unsigned char A[KW_SEMIBLOCK_LENGTH],unsigned char * output,size_t * out_len)256*62c56f98SSadaf Ebrahimi static int unwrap(mbedtls_nist_kw_context *ctx,
257*62c56f98SSadaf Ebrahimi                   const unsigned char *input, size_t semiblocks,
258*62c56f98SSadaf Ebrahimi                   unsigned char A[KW_SEMIBLOCK_LENGTH],
259*62c56f98SSadaf Ebrahimi                   unsigned char *output, size_t *out_len)
260*62c56f98SSadaf Ebrahimi {
261*62c56f98SSadaf Ebrahimi     int ret = 0;
262*62c56f98SSadaf Ebrahimi     const size_t s = 6 * (semiblocks - 1);
263*62c56f98SSadaf Ebrahimi     size_t olen;
264*62c56f98SSadaf Ebrahimi     uint64_t t = 0;
265*62c56f98SSadaf Ebrahimi     unsigned char outbuff[KW_SEMIBLOCK_LENGTH * 2];
266*62c56f98SSadaf Ebrahimi     unsigned char inbuff[KW_SEMIBLOCK_LENGTH * 2];
267*62c56f98SSadaf Ebrahimi     unsigned char *R = NULL;
268*62c56f98SSadaf Ebrahimi     *out_len = 0;
269*62c56f98SSadaf Ebrahimi 
270*62c56f98SSadaf Ebrahimi     if (semiblocks < MIN_SEMIBLOCKS_COUNT) {
271*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
272*62c56f98SSadaf Ebrahimi     }
273*62c56f98SSadaf Ebrahimi 
274*62c56f98SSadaf Ebrahimi     memcpy(A, input, KW_SEMIBLOCK_LENGTH);
275*62c56f98SSadaf Ebrahimi     memmove(output, input + KW_SEMIBLOCK_LENGTH, (semiblocks - 1) * KW_SEMIBLOCK_LENGTH);
276*62c56f98SSadaf Ebrahimi     R = output + (semiblocks - 2) * KW_SEMIBLOCK_LENGTH;
277*62c56f98SSadaf Ebrahimi 
278*62c56f98SSadaf Ebrahimi     /* Calculate intermediate values */
279*62c56f98SSadaf Ebrahimi     for (t = s; t >= 1; t--) {
280*62c56f98SSadaf Ebrahimi         calc_a_xor_t(A, t);
281*62c56f98SSadaf Ebrahimi 
282*62c56f98SSadaf Ebrahimi         memcpy(inbuff, A, KW_SEMIBLOCK_LENGTH);
283*62c56f98SSadaf Ebrahimi         memcpy(inbuff + KW_SEMIBLOCK_LENGTH, R, KW_SEMIBLOCK_LENGTH);
284*62c56f98SSadaf Ebrahimi 
285*62c56f98SSadaf Ebrahimi         ret = mbedtls_cipher_update(&ctx->cipher_ctx,
286*62c56f98SSadaf Ebrahimi                                     inbuff, 16, outbuff, &olen);
287*62c56f98SSadaf Ebrahimi         if (ret != 0) {
288*62c56f98SSadaf Ebrahimi             goto cleanup;
289*62c56f98SSadaf Ebrahimi         }
290*62c56f98SSadaf Ebrahimi 
291*62c56f98SSadaf Ebrahimi         memcpy(A, outbuff, KW_SEMIBLOCK_LENGTH);
292*62c56f98SSadaf Ebrahimi 
293*62c56f98SSadaf Ebrahimi         /* Set R as LSB64 of outbuff */
294*62c56f98SSadaf Ebrahimi         memcpy(R, outbuff + KW_SEMIBLOCK_LENGTH, KW_SEMIBLOCK_LENGTH);
295*62c56f98SSadaf Ebrahimi 
296*62c56f98SSadaf Ebrahimi         if (R == output) {
297*62c56f98SSadaf Ebrahimi             R = output + (semiblocks - 2) * KW_SEMIBLOCK_LENGTH;
298*62c56f98SSadaf Ebrahimi         } else {
299*62c56f98SSadaf Ebrahimi             R -= KW_SEMIBLOCK_LENGTH;
300*62c56f98SSadaf Ebrahimi         }
301*62c56f98SSadaf Ebrahimi     }
302*62c56f98SSadaf Ebrahimi 
303*62c56f98SSadaf Ebrahimi     *out_len = (semiblocks - 1) * KW_SEMIBLOCK_LENGTH;
304*62c56f98SSadaf Ebrahimi 
305*62c56f98SSadaf Ebrahimi cleanup:
306*62c56f98SSadaf Ebrahimi     if (ret != 0) {
307*62c56f98SSadaf Ebrahimi         memset(output, 0, (semiblocks - 1) * KW_SEMIBLOCK_LENGTH);
308*62c56f98SSadaf Ebrahimi     }
309*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(inbuff, sizeof(inbuff));
310*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(outbuff, sizeof(outbuff));
311*62c56f98SSadaf Ebrahimi 
312*62c56f98SSadaf Ebrahimi     return ret;
313*62c56f98SSadaf Ebrahimi }
314*62c56f98SSadaf Ebrahimi 
315*62c56f98SSadaf Ebrahimi /*
316*62c56f98SSadaf Ebrahimi  * KW-AD as defined in SP 800-38F section 6.2
317*62c56f98SSadaf Ebrahimi  * KWP-AD as defined in SP 800-38F section 6.3
318*62c56f98SSadaf Ebrahimi  */
mbedtls_nist_kw_unwrap(mbedtls_nist_kw_context * ctx,mbedtls_nist_kw_mode_t mode,const unsigned char * input,size_t in_len,unsigned char * output,size_t * out_len,size_t out_size)319*62c56f98SSadaf Ebrahimi int mbedtls_nist_kw_unwrap(mbedtls_nist_kw_context *ctx,
320*62c56f98SSadaf Ebrahimi                            mbedtls_nist_kw_mode_t mode,
321*62c56f98SSadaf Ebrahimi                            const unsigned char *input, size_t in_len,
322*62c56f98SSadaf Ebrahimi                            unsigned char *output, size_t *out_len, size_t out_size)
323*62c56f98SSadaf Ebrahimi {
324*62c56f98SSadaf Ebrahimi     int ret = 0;
325*62c56f98SSadaf Ebrahimi     size_t olen;
326*62c56f98SSadaf Ebrahimi     unsigned char A[KW_SEMIBLOCK_LENGTH];
327*62c56f98SSadaf Ebrahimi     int diff;
328*62c56f98SSadaf Ebrahimi 
329*62c56f98SSadaf Ebrahimi     *out_len = 0;
330*62c56f98SSadaf Ebrahimi     if (out_size < in_len - KW_SEMIBLOCK_LENGTH) {
331*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
332*62c56f98SSadaf Ebrahimi     }
333*62c56f98SSadaf Ebrahimi 
334*62c56f98SSadaf Ebrahimi     if (mode == MBEDTLS_KW_MODE_KW) {
335*62c56f98SSadaf Ebrahimi         /*
336*62c56f98SSadaf Ebrahimi          * According to SP 800-38F Table 1, the ciphertext length for KW
337*62c56f98SSadaf Ebrahimi          * must be between 3 to 2^54 semiblocks inclusive.
338*62c56f98SSadaf Ebrahimi          */
339*62c56f98SSadaf Ebrahimi         if (in_len < 24 ||
340*62c56f98SSadaf Ebrahimi #if SIZE_MAX > 0x200000000000000
341*62c56f98SSadaf Ebrahimi             in_len > 0x200000000000000 ||
342*62c56f98SSadaf Ebrahimi #endif
343*62c56f98SSadaf Ebrahimi             in_len % KW_SEMIBLOCK_LENGTH != 0) {
344*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
345*62c56f98SSadaf Ebrahimi         }
346*62c56f98SSadaf Ebrahimi 
347*62c56f98SSadaf Ebrahimi         ret = unwrap(ctx, input, in_len / KW_SEMIBLOCK_LENGTH,
348*62c56f98SSadaf Ebrahimi                      A, output, out_len);
349*62c56f98SSadaf Ebrahimi         if (ret != 0) {
350*62c56f98SSadaf Ebrahimi             goto cleanup;
351*62c56f98SSadaf Ebrahimi         }
352*62c56f98SSadaf Ebrahimi 
353*62c56f98SSadaf Ebrahimi         /* Check ICV in "constant-time" */
354*62c56f98SSadaf Ebrahimi         diff = mbedtls_ct_memcmp(NIST_KW_ICV1, A, KW_SEMIBLOCK_LENGTH);
355*62c56f98SSadaf Ebrahimi 
356*62c56f98SSadaf Ebrahimi         if (diff != 0) {
357*62c56f98SSadaf Ebrahimi             ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
358*62c56f98SSadaf Ebrahimi             goto cleanup;
359*62c56f98SSadaf Ebrahimi         }
360*62c56f98SSadaf Ebrahimi 
361*62c56f98SSadaf Ebrahimi     } else if (mode == MBEDTLS_KW_MODE_KWP) {
362*62c56f98SSadaf Ebrahimi         size_t padlen = 0;
363*62c56f98SSadaf Ebrahimi         uint32_t Plen;
364*62c56f98SSadaf Ebrahimi         /*
365*62c56f98SSadaf Ebrahimi          * According to SP 800-38F Table 1, the ciphertext length for KWP
366*62c56f98SSadaf Ebrahimi          * must be between 2 to 2^29 semiblocks inclusive.
367*62c56f98SSadaf Ebrahimi          */
368*62c56f98SSadaf Ebrahimi         if (in_len < KW_SEMIBLOCK_LENGTH * 2 ||
369*62c56f98SSadaf Ebrahimi #if SIZE_MAX > 0x100000000
370*62c56f98SSadaf Ebrahimi             in_len > 0x100000000 ||
371*62c56f98SSadaf Ebrahimi #endif
372*62c56f98SSadaf Ebrahimi             in_len % KW_SEMIBLOCK_LENGTH != 0) {
373*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
374*62c56f98SSadaf Ebrahimi         }
375*62c56f98SSadaf Ebrahimi 
376*62c56f98SSadaf Ebrahimi         if (in_len == KW_SEMIBLOCK_LENGTH * 2) {
377*62c56f98SSadaf Ebrahimi             unsigned char outbuff[KW_SEMIBLOCK_LENGTH * 2];
378*62c56f98SSadaf Ebrahimi             ret = mbedtls_cipher_update(&ctx->cipher_ctx,
379*62c56f98SSadaf Ebrahimi                                         input, 16, outbuff, &olen);
380*62c56f98SSadaf Ebrahimi             if (ret != 0) {
381*62c56f98SSadaf Ebrahimi                 goto cleanup;
382*62c56f98SSadaf Ebrahimi             }
383*62c56f98SSadaf Ebrahimi 
384*62c56f98SSadaf Ebrahimi             memcpy(A, outbuff, KW_SEMIBLOCK_LENGTH);
385*62c56f98SSadaf Ebrahimi             memcpy(output, outbuff + KW_SEMIBLOCK_LENGTH, KW_SEMIBLOCK_LENGTH);
386*62c56f98SSadaf Ebrahimi             mbedtls_platform_zeroize(outbuff, sizeof(outbuff));
387*62c56f98SSadaf Ebrahimi             *out_len = KW_SEMIBLOCK_LENGTH;
388*62c56f98SSadaf Ebrahimi         } else {
389*62c56f98SSadaf Ebrahimi             /* in_len >=  KW_SEMIBLOCK_LENGTH * 3 */
390*62c56f98SSadaf Ebrahimi             ret = unwrap(ctx, input, in_len / KW_SEMIBLOCK_LENGTH,
391*62c56f98SSadaf Ebrahimi                          A, output, out_len);
392*62c56f98SSadaf Ebrahimi             if (ret != 0) {
393*62c56f98SSadaf Ebrahimi                 goto cleanup;
394*62c56f98SSadaf Ebrahimi             }
395*62c56f98SSadaf Ebrahimi         }
396*62c56f98SSadaf Ebrahimi 
397*62c56f98SSadaf Ebrahimi         /* Check ICV in "constant-time" */
398*62c56f98SSadaf Ebrahimi         diff = mbedtls_ct_memcmp(NIST_KW_ICV2, A, KW_SEMIBLOCK_LENGTH / 2);
399*62c56f98SSadaf Ebrahimi 
400*62c56f98SSadaf Ebrahimi         if (diff != 0) {
401*62c56f98SSadaf Ebrahimi             ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
402*62c56f98SSadaf Ebrahimi         }
403*62c56f98SSadaf Ebrahimi 
404*62c56f98SSadaf Ebrahimi         Plen = MBEDTLS_GET_UINT32_BE(A, KW_SEMIBLOCK_LENGTH / 2);
405*62c56f98SSadaf Ebrahimi 
406*62c56f98SSadaf Ebrahimi         /*
407*62c56f98SSadaf Ebrahimi          * Plen is the length of the plaintext, when the input is valid.
408*62c56f98SSadaf Ebrahimi          * If Plen is larger than the plaintext and padding, padlen will be
409*62c56f98SSadaf Ebrahimi          * larger than 8, because of the type wrap around.
410*62c56f98SSadaf Ebrahimi          */
411*62c56f98SSadaf Ebrahimi         padlen = in_len - KW_SEMIBLOCK_LENGTH - Plen;
412*62c56f98SSadaf Ebrahimi         ret = mbedtls_ct_error_if(mbedtls_ct_uint_gt(padlen, 7),
413*62c56f98SSadaf Ebrahimi                                   MBEDTLS_ERR_CIPHER_AUTH_FAILED, ret);
414*62c56f98SSadaf Ebrahimi         padlen &= 7;
415*62c56f98SSadaf Ebrahimi 
416*62c56f98SSadaf Ebrahimi         /* Check padding in "constant-time" */
417*62c56f98SSadaf Ebrahimi         const uint8_t zero[KW_SEMIBLOCK_LENGTH] = { 0 };
418*62c56f98SSadaf Ebrahimi         diff = mbedtls_ct_memcmp_partial(
419*62c56f98SSadaf Ebrahimi             &output[*out_len - KW_SEMIBLOCK_LENGTH], zero,
420*62c56f98SSadaf Ebrahimi             KW_SEMIBLOCK_LENGTH, KW_SEMIBLOCK_LENGTH - padlen, 0);
421*62c56f98SSadaf Ebrahimi 
422*62c56f98SSadaf Ebrahimi         if (diff != 0) {
423*62c56f98SSadaf Ebrahimi             ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
424*62c56f98SSadaf Ebrahimi         }
425*62c56f98SSadaf Ebrahimi 
426*62c56f98SSadaf Ebrahimi         if (ret != 0) {
427*62c56f98SSadaf Ebrahimi             goto cleanup;
428*62c56f98SSadaf Ebrahimi         }
429*62c56f98SSadaf Ebrahimi         memset(output + Plen, 0, padlen);
430*62c56f98SSadaf Ebrahimi         *out_len = Plen;
431*62c56f98SSadaf Ebrahimi     } else {
432*62c56f98SSadaf Ebrahimi         ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
433*62c56f98SSadaf Ebrahimi         goto cleanup;
434*62c56f98SSadaf Ebrahimi     }
435*62c56f98SSadaf Ebrahimi 
436*62c56f98SSadaf Ebrahimi cleanup:
437*62c56f98SSadaf Ebrahimi     if (ret != 0) {
438*62c56f98SSadaf Ebrahimi         memset(output, 0, *out_len);
439*62c56f98SSadaf Ebrahimi         *out_len = 0;
440*62c56f98SSadaf Ebrahimi     }
441*62c56f98SSadaf Ebrahimi 
442*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(&diff, sizeof(diff));
443*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(A, sizeof(A));
444*62c56f98SSadaf Ebrahimi 
445*62c56f98SSadaf Ebrahimi     return ret;
446*62c56f98SSadaf Ebrahimi }
447*62c56f98SSadaf Ebrahimi 
448*62c56f98SSadaf Ebrahimi #endif /* !MBEDTLS_NIST_KW_ALT */
449*62c56f98SSadaf Ebrahimi 
450*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)
451*62c56f98SSadaf Ebrahimi 
452*62c56f98SSadaf Ebrahimi /*
453*62c56f98SSadaf Ebrahimi  * Test vectors taken from NIST
454*62c56f98SSadaf Ebrahimi  * https://csrc.nist.gov/Projects/Cryptographic-Algorithm-Validation-Program/CAVP-TESTING-BLOCK-CIPHER-MODES#KW
455*62c56f98SSadaf Ebrahimi  */
456*62c56f98SSadaf Ebrahimi static const unsigned int key_len[] = {
457*62c56f98SSadaf Ebrahimi     16,
458*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
459*62c56f98SSadaf Ebrahimi     24,
460*62c56f98SSadaf Ebrahimi     32
461*62c56f98SSadaf Ebrahimi #endif
462*62c56f98SSadaf Ebrahimi };
463*62c56f98SSadaf Ebrahimi 
464*62c56f98SSadaf Ebrahimi static const unsigned char kw_key[][32] = {
465*62c56f98SSadaf Ebrahimi     { 0x75, 0x75, 0xda, 0x3a, 0x93, 0x60, 0x7c, 0xc2,
466*62c56f98SSadaf Ebrahimi       0xbf, 0xd8, 0xce, 0xc7, 0xaa, 0xdf, 0xd9, 0xa6 },
467*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
468*62c56f98SSadaf Ebrahimi     { 0x2d, 0x85, 0x26, 0x08, 0x1d, 0x02, 0xfb, 0x5b,
469*62c56f98SSadaf Ebrahimi       0x85, 0xf6, 0x9a, 0xc2, 0x86, 0xec, 0xd5, 0x7d,
470*62c56f98SSadaf Ebrahimi       0x40, 0xdf, 0x5d, 0xf3, 0x49, 0x47, 0x44, 0xd3 },
471*62c56f98SSadaf Ebrahimi     { 0x11, 0x2a, 0xd4, 0x1b, 0x48, 0x56, 0xc7, 0x25,
472*62c56f98SSadaf Ebrahimi       0x4a, 0x98, 0x48, 0xd3, 0x0f, 0xdd, 0x78, 0x33,
473*62c56f98SSadaf Ebrahimi       0x5b, 0x03, 0x9a, 0x48, 0xa8, 0x96, 0x2c, 0x4d,
474*62c56f98SSadaf Ebrahimi       0x1c, 0xb7, 0x8e, 0xab, 0xd5, 0xda, 0xd7, 0x88 }
475*62c56f98SSadaf Ebrahimi #endif
476*62c56f98SSadaf Ebrahimi };
477*62c56f98SSadaf Ebrahimi 
478*62c56f98SSadaf Ebrahimi static const unsigned char kw_msg[][40] = {
479*62c56f98SSadaf Ebrahimi     { 0x42, 0x13, 0x6d, 0x3c, 0x38, 0x4a, 0x3e, 0xea,
480*62c56f98SSadaf Ebrahimi       0xc9, 0x5a, 0x06, 0x6f, 0xd2, 0x8f, 0xed, 0x3f },
481*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
482*62c56f98SSadaf Ebrahimi     { 0x95, 0xc1, 0x1b, 0xf5, 0x35, 0x3a, 0xfe, 0xdb,
483*62c56f98SSadaf Ebrahimi       0x98, 0xfd, 0xd6, 0xc8, 0xca, 0x6f, 0xdb, 0x6d,
484*62c56f98SSadaf Ebrahimi       0xa5, 0x4b, 0x74, 0xb4, 0x99, 0x0f, 0xdc, 0x45,
485*62c56f98SSadaf Ebrahimi       0xc0, 0x9d, 0x15, 0x8f, 0x51, 0xce, 0x62, 0x9d,
486*62c56f98SSadaf Ebrahimi       0xe2, 0xaf, 0x26, 0xe3, 0x25, 0x0e, 0x6b, 0x4c },
487*62c56f98SSadaf Ebrahimi     { 0x1b, 0x20, 0xbf, 0x19, 0x90, 0xb0, 0x65, 0xd7,
488*62c56f98SSadaf Ebrahimi       0x98, 0xe1, 0xb3, 0x22, 0x64, 0xad, 0x50, 0xa8,
489*62c56f98SSadaf Ebrahimi       0x74, 0x74, 0x92, 0xba, 0x09, 0xa0, 0x4d, 0xd1 }
490*62c56f98SSadaf Ebrahimi #endif
491*62c56f98SSadaf Ebrahimi };
492*62c56f98SSadaf Ebrahimi 
493*62c56f98SSadaf Ebrahimi static const size_t kw_msg_len[] = {
494*62c56f98SSadaf Ebrahimi     16,
495*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
496*62c56f98SSadaf Ebrahimi     40,
497*62c56f98SSadaf Ebrahimi     24
498*62c56f98SSadaf Ebrahimi #endif
499*62c56f98SSadaf Ebrahimi };
500*62c56f98SSadaf Ebrahimi static const size_t kw_out_len[] = {
501*62c56f98SSadaf Ebrahimi     24,
502*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
503*62c56f98SSadaf Ebrahimi     48,
504*62c56f98SSadaf Ebrahimi     32
505*62c56f98SSadaf Ebrahimi #endif
506*62c56f98SSadaf Ebrahimi };
507*62c56f98SSadaf Ebrahimi static const unsigned char kw_res[][48] = {
508*62c56f98SSadaf Ebrahimi     { 0x03, 0x1f, 0x6b, 0xd7, 0xe6, 0x1e, 0x64, 0x3d,
509*62c56f98SSadaf Ebrahimi       0xf6, 0x85, 0x94, 0x81, 0x6f, 0x64, 0xca, 0xa3,
510*62c56f98SSadaf Ebrahimi       0xf5, 0x6f, 0xab, 0xea, 0x25, 0x48, 0xf5, 0xfb },
511*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
512*62c56f98SSadaf Ebrahimi     { 0x44, 0x3c, 0x6f, 0x15, 0x09, 0x83, 0x71, 0x91,
513*62c56f98SSadaf Ebrahimi       0x3e, 0x5c, 0x81, 0x4c, 0xa1, 0xa0, 0x42, 0xec,
514*62c56f98SSadaf Ebrahimi       0x68, 0x2f, 0x7b, 0x13, 0x6d, 0x24, 0x3a, 0x4d,
515*62c56f98SSadaf Ebrahimi       0x6c, 0x42, 0x6f, 0xc6, 0x97, 0x15, 0x63, 0xe8,
516*62c56f98SSadaf Ebrahimi       0xa1, 0x4a, 0x55, 0x8e, 0x09, 0x64, 0x16, 0x19,
517*62c56f98SSadaf Ebrahimi       0xbf, 0x03, 0xfc, 0xaf, 0x90, 0xb1, 0xfc, 0x2d },
518*62c56f98SSadaf Ebrahimi     { 0xba, 0x8a, 0x25, 0x9a, 0x47, 0x1b, 0x78, 0x7d,
519*62c56f98SSadaf Ebrahimi       0xd5, 0xd5, 0x40, 0xec, 0x25, 0xd4, 0x3d, 0x87,
520*62c56f98SSadaf Ebrahimi       0x20, 0x0f, 0xda, 0xdc, 0x6d, 0x1f, 0x05, 0xd9,
521*62c56f98SSadaf Ebrahimi       0x16, 0x58, 0x4f, 0xa9, 0xf6, 0xcb, 0xf5, 0x12 }
522*62c56f98SSadaf Ebrahimi #endif
523*62c56f98SSadaf Ebrahimi };
524*62c56f98SSadaf Ebrahimi 
525*62c56f98SSadaf Ebrahimi static const unsigned char kwp_key[][32] = {
526*62c56f98SSadaf Ebrahimi     { 0x78, 0x65, 0xe2, 0x0f, 0x3c, 0x21, 0x65, 0x9a,
527*62c56f98SSadaf Ebrahimi       0xb4, 0x69, 0x0b, 0x62, 0x9c, 0xdf, 0x3c, 0xc4 },
528*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
529*62c56f98SSadaf Ebrahimi     { 0xf5, 0xf8, 0x96, 0xa3, 0xbd, 0x2f, 0x4a, 0x98,
530*62c56f98SSadaf Ebrahimi       0x23, 0xef, 0x16, 0x2b, 0x00, 0xb8, 0x05, 0xd7,
531*62c56f98SSadaf Ebrahimi       0xde, 0x1e, 0xa4, 0x66, 0x26, 0x96, 0xa2, 0x58 },
532*62c56f98SSadaf Ebrahimi     { 0x95, 0xda, 0x27, 0x00, 0xca, 0x6f, 0xd9, 0xa5,
533*62c56f98SSadaf Ebrahimi       0x25, 0x54, 0xee, 0x2a, 0x8d, 0xf1, 0x38, 0x6f,
534*62c56f98SSadaf Ebrahimi       0x5b, 0x94, 0xa1, 0xa6, 0x0e, 0xd8, 0xa4, 0xae,
535*62c56f98SSadaf Ebrahimi       0xf6, 0x0a, 0x8d, 0x61, 0xab, 0x5f, 0x22, 0x5a }
536*62c56f98SSadaf Ebrahimi #endif
537*62c56f98SSadaf Ebrahimi };
538*62c56f98SSadaf Ebrahimi 
539*62c56f98SSadaf Ebrahimi static const unsigned char kwp_msg[][31] = {
540*62c56f98SSadaf Ebrahimi     { 0xbd, 0x68, 0x43, 0xd4, 0x20, 0x37, 0x8d, 0xc8,
541*62c56f98SSadaf Ebrahimi       0x96 },
542*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
543*62c56f98SSadaf Ebrahimi     { 0x6c, 0xcd, 0xd5, 0x85, 0x18, 0x40, 0x97, 0xeb,
544*62c56f98SSadaf Ebrahimi       0xd5, 0xc3, 0xaf, 0x3e, 0x47, 0xd0, 0x2c, 0x19,
545*62c56f98SSadaf Ebrahimi       0x14, 0x7b, 0x4d, 0x99, 0x5f, 0x96, 0x43, 0x66,
546*62c56f98SSadaf Ebrahimi       0x91, 0x56, 0x75, 0x8c, 0x13, 0x16, 0x8f },
547*62c56f98SSadaf Ebrahimi     { 0xd1 }
548*62c56f98SSadaf Ebrahimi #endif
549*62c56f98SSadaf Ebrahimi };
550*62c56f98SSadaf Ebrahimi static const size_t kwp_msg_len[] = {
551*62c56f98SSadaf Ebrahimi     9,
552*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
553*62c56f98SSadaf Ebrahimi     31,
554*62c56f98SSadaf Ebrahimi     1
555*62c56f98SSadaf Ebrahimi #endif
556*62c56f98SSadaf Ebrahimi };
557*62c56f98SSadaf Ebrahimi 
558*62c56f98SSadaf Ebrahimi static const unsigned char kwp_res[][48] = {
559*62c56f98SSadaf Ebrahimi     { 0x41, 0xec, 0xa9, 0x56, 0xd4, 0xaa, 0x04, 0x7e,
560*62c56f98SSadaf Ebrahimi       0xb5, 0xcf, 0x4e, 0xfe, 0x65, 0x96, 0x61, 0xe7,
561*62c56f98SSadaf Ebrahimi       0x4d, 0xb6, 0xf8, 0xc5, 0x64, 0xe2, 0x35, 0x00 },
562*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
563*62c56f98SSadaf Ebrahimi     { 0x4e, 0x9b, 0xc2, 0xbc, 0xbc, 0x6c, 0x1e, 0x13,
564*62c56f98SSadaf Ebrahimi       0xd3, 0x35, 0xbc, 0xc0, 0xf7, 0x73, 0x6a, 0x88,
565*62c56f98SSadaf Ebrahimi       0xfa, 0x87, 0x53, 0x66, 0x15, 0xbb, 0x8e, 0x63,
566*62c56f98SSadaf Ebrahimi       0x8b, 0xcc, 0x81, 0x66, 0x84, 0x68, 0x17, 0x90,
567*62c56f98SSadaf Ebrahimi       0x67, 0xcf, 0xa9, 0x8a, 0x9d, 0x0e, 0x33, 0x26 },
568*62c56f98SSadaf Ebrahimi     { 0x06, 0xba, 0x7a, 0xe6, 0xf3, 0x24, 0x8c, 0xfd,
569*62c56f98SSadaf Ebrahimi       0xcf, 0x26, 0x75, 0x07, 0xfa, 0x00, 0x1b, 0xc4  }
570*62c56f98SSadaf Ebrahimi #endif
571*62c56f98SSadaf Ebrahimi };
572*62c56f98SSadaf Ebrahimi static const size_t kwp_out_len[] = {
573*62c56f98SSadaf Ebrahimi     24,
574*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
575*62c56f98SSadaf Ebrahimi     40,
576*62c56f98SSadaf Ebrahimi     16
577*62c56f98SSadaf Ebrahimi #endif
578*62c56f98SSadaf Ebrahimi };
579*62c56f98SSadaf Ebrahimi 
mbedtls_nist_kw_self_test(int verbose)580*62c56f98SSadaf Ebrahimi int mbedtls_nist_kw_self_test(int verbose)
581*62c56f98SSadaf Ebrahimi {
582*62c56f98SSadaf Ebrahimi     mbedtls_nist_kw_context ctx;
583*62c56f98SSadaf Ebrahimi     unsigned char out[48];
584*62c56f98SSadaf Ebrahimi     size_t olen;
585*62c56f98SSadaf Ebrahimi     int i;
586*62c56f98SSadaf Ebrahimi     int ret = 0;
587*62c56f98SSadaf Ebrahimi     mbedtls_nist_kw_init(&ctx);
588*62c56f98SSadaf Ebrahimi 
589*62c56f98SSadaf Ebrahimi     /*
590*62c56f98SSadaf Ebrahimi      * KW mode
591*62c56f98SSadaf Ebrahimi      */
592*62c56f98SSadaf Ebrahimi     {
593*62c56f98SSadaf Ebrahimi         static const int num_tests = sizeof(kw_key) / sizeof(*kw_key);
594*62c56f98SSadaf Ebrahimi 
595*62c56f98SSadaf Ebrahimi         for (i = 0; i < num_tests; i++) {
596*62c56f98SSadaf Ebrahimi             if (verbose != 0) {
597*62c56f98SSadaf Ebrahimi                 mbedtls_printf("  KW-AES-%u ", (unsigned int) key_len[i] * 8);
598*62c56f98SSadaf Ebrahimi             }
599*62c56f98SSadaf Ebrahimi 
600*62c56f98SSadaf Ebrahimi             ret = mbedtls_nist_kw_setkey(&ctx, MBEDTLS_CIPHER_ID_AES,
601*62c56f98SSadaf Ebrahimi                                          kw_key[i], key_len[i] * 8, 1);
602*62c56f98SSadaf Ebrahimi             if (ret != 0) {
603*62c56f98SSadaf Ebrahimi                 if (verbose != 0) {
604*62c56f98SSadaf Ebrahimi                     mbedtls_printf("  KW: setup failed ");
605*62c56f98SSadaf Ebrahimi                 }
606*62c56f98SSadaf Ebrahimi 
607*62c56f98SSadaf Ebrahimi                 goto end;
608*62c56f98SSadaf Ebrahimi             }
609*62c56f98SSadaf Ebrahimi 
610*62c56f98SSadaf Ebrahimi             ret = mbedtls_nist_kw_wrap(&ctx, MBEDTLS_KW_MODE_KW, kw_msg[i],
611*62c56f98SSadaf Ebrahimi                                        kw_msg_len[i], out, &olen, sizeof(out));
612*62c56f98SSadaf Ebrahimi             if (ret != 0 || kw_out_len[i] != olen ||
613*62c56f98SSadaf Ebrahimi                 memcmp(out, kw_res[i], kw_out_len[i]) != 0) {
614*62c56f98SSadaf Ebrahimi                 if (verbose != 0) {
615*62c56f98SSadaf Ebrahimi                     mbedtls_printf("failed. ");
616*62c56f98SSadaf Ebrahimi                 }
617*62c56f98SSadaf Ebrahimi 
618*62c56f98SSadaf Ebrahimi                 ret = 1;
619*62c56f98SSadaf Ebrahimi                 goto end;
620*62c56f98SSadaf Ebrahimi             }
621*62c56f98SSadaf Ebrahimi 
622*62c56f98SSadaf Ebrahimi             if ((ret = mbedtls_nist_kw_setkey(&ctx, MBEDTLS_CIPHER_ID_AES,
623*62c56f98SSadaf Ebrahimi                                               kw_key[i], key_len[i] * 8, 0))
624*62c56f98SSadaf Ebrahimi                 != 0) {
625*62c56f98SSadaf Ebrahimi                 if (verbose != 0) {
626*62c56f98SSadaf Ebrahimi                     mbedtls_printf("  KW: setup failed ");
627*62c56f98SSadaf Ebrahimi                 }
628*62c56f98SSadaf Ebrahimi 
629*62c56f98SSadaf Ebrahimi                 goto end;
630*62c56f98SSadaf Ebrahimi             }
631*62c56f98SSadaf Ebrahimi 
632*62c56f98SSadaf Ebrahimi             ret = mbedtls_nist_kw_unwrap(&ctx, MBEDTLS_KW_MODE_KW,
633*62c56f98SSadaf Ebrahimi                                          out, olen, out, &olen, sizeof(out));
634*62c56f98SSadaf Ebrahimi 
635*62c56f98SSadaf Ebrahimi             if (ret != 0 || olen != kw_msg_len[i] ||
636*62c56f98SSadaf Ebrahimi                 memcmp(out, kw_msg[i], kw_msg_len[i]) != 0) {
637*62c56f98SSadaf Ebrahimi                 if (verbose != 0) {
638*62c56f98SSadaf Ebrahimi                     mbedtls_printf("failed\n");
639*62c56f98SSadaf Ebrahimi                 }
640*62c56f98SSadaf Ebrahimi 
641*62c56f98SSadaf Ebrahimi                 ret = 1;
642*62c56f98SSadaf Ebrahimi                 goto end;
643*62c56f98SSadaf Ebrahimi             }
644*62c56f98SSadaf Ebrahimi 
645*62c56f98SSadaf Ebrahimi             if (verbose != 0) {
646*62c56f98SSadaf Ebrahimi                 mbedtls_printf(" passed\n");
647*62c56f98SSadaf Ebrahimi             }
648*62c56f98SSadaf Ebrahimi         }
649*62c56f98SSadaf Ebrahimi     }
650*62c56f98SSadaf Ebrahimi 
651*62c56f98SSadaf Ebrahimi     /*
652*62c56f98SSadaf Ebrahimi      * KWP mode
653*62c56f98SSadaf Ebrahimi      */
654*62c56f98SSadaf Ebrahimi     {
655*62c56f98SSadaf Ebrahimi         static const int num_tests = sizeof(kwp_key) / sizeof(*kwp_key);
656*62c56f98SSadaf Ebrahimi 
657*62c56f98SSadaf Ebrahimi         for (i = 0; i < num_tests; i++) {
658*62c56f98SSadaf Ebrahimi             olen = sizeof(out);
659*62c56f98SSadaf Ebrahimi             if (verbose != 0) {
660*62c56f98SSadaf Ebrahimi                 mbedtls_printf("  KWP-AES-%u ", (unsigned int) key_len[i] * 8);
661*62c56f98SSadaf Ebrahimi             }
662*62c56f98SSadaf Ebrahimi 
663*62c56f98SSadaf Ebrahimi             ret = mbedtls_nist_kw_setkey(&ctx, MBEDTLS_CIPHER_ID_AES, kwp_key[i],
664*62c56f98SSadaf Ebrahimi                                          key_len[i] * 8, 1);
665*62c56f98SSadaf Ebrahimi             if (ret  != 0) {
666*62c56f98SSadaf Ebrahimi                 if (verbose != 0) {
667*62c56f98SSadaf Ebrahimi                     mbedtls_printf("  KWP: setup failed ");
668*62c56f98SSadaf Ebrahimi                 }
669*62c56f98SSadaf Ebrahimi 
670*62c56f98SSadaf Ebrahimi                 goto end;
671*62c56f98SSadaf Ebrahimi             }
672*62c56f98SSadaf Ebrahimi             ret = mbedtls_nist_kw_wrap(&ctx, MBEDTLS_KW_MODE_KWP, kwp_msg[i],
673*62c56f98SSadaf Ebrahimi                                        kwp_msg_len[i], out, &olen, sizeof(out));
674*62c56f98SSadaf Ebrahimi 
675*62c56f98SSadaf Ebrahimi             if (ret != 0 || kwp_out_len[i] != olen ||
676*62c56f98SSadaf Ebrahimi                 memcmp(out, kwp_res[i], kwp_out_len[i]) != 0) {
677*62c56f98SSadaf Ebrahimi                 if (verbose != 0) {
678*62c56f98SSadaf Ebrahimi                     mbedtls_printf("failed. ");
679*62c56f98SSadaf Ebrahimi                 }
680*62c56f98SSadaf Ebrahimi 
681*62c56f98SSadaf Ebrahimi                 ret = 1;
682*62c56f98SSadaf Ebrahimi                 goto end;
683*62c56f98SSadaf Ebrahimi             }
684*62c56f98SSadaf Ebrahimi 
685*62c56f98SSadaf Ebrahimi             if ((ret = mbedtls_nist_kw_setkey(&ctx, MBEDTLS_CIPHER_ID_AES,
686*62c56f98SSadaf Ebrahimi                                               kwp_key[i], key_len[i] * 8, 0))
687*62c56f98SSadaf Ebrahimi                 != 0) {
688*62c56f98SSadaf Ebrahimi                 if (verbose != 0) {
689*62c56f98SSadaf Ebrahimi                     mbedtls_printf("  KWP: setup failed ");
690*62c56f98SSadaf Ebrahimi                 }
691*62c56f98SSadaf Ebrahimi 
692*62c56f98SSadaf Ebrahimi                 goto end;
693*62c56f98SSadaf Ebrahimi             }
694*62c56f98SSadaf Ebrahimi 
695*62c56f98SSadaf Ebrahimi             ret = mbedtls_nist_kw_unwrap(&ctx, MBEDTLS_KW_MODE_KWP, out,
696*62c56f98SSadaf Ebrahimi                                          olen, out, &olen, sizeof(out));
697*62c56f98SSadaf Ebrahimi 
698*62c56f98SSadaf Ebrahimi             if (ret != 0 || olen != kwp_msg_len[i] ||
699*62c56f98SSadaf Ebrahimi                 memcmp(out, kwp_msg[i], kwp_msg_len[i]) != 0) {
700*62c56f98SSadaf Ebrahimi                 if (verbose != 0) {
701*62c56f98SSadaf Ebrahimi                     mbedtls_printf("failed. ");
702*62c56f98SSadaf Ebrahimi                 }
703*62c56f98SSadaf Ebrahimi 
704*62c56f98SSadaf Ebrahimi                 ret = 1;
705*62c56f98SSadaf Ebrahimi                 goto end;
706*62c56f98SSadaf Ebrahimi             }
707*62c56f98SSadaf Ebrahimi 
708*62c56f98SSadaf Ebrahimi             if (verbose != 0) {
709*62c56f98SSadaf Ebrahimi                 mbedtls_printf(" passed\n");
710*62c56f98SSadaf Ebrahimi             }
711*62c56f98SSadaf Ebrahimi         }
712*62c56f98SSadaf Ebrahimi     }
713*62c56f98SSadaf Ebrahimi end:
714*62c56f98SSadaf Ebrahimi     mbedtls_nist_kw_free(&ctx);
715*62c56f98SSadaf Ebrahimi 
716*62c56f98SSadaf Ebrahimi     if (verbose != 0) {
717*62c56f98SSadaf Ebrahimi         mbedtls_printf("\n");
718*62c56f98SSadaf Ebrahimi     }
719*62c56f98SSadaf Ebrahimi 
720*62c56f98SSadaf Ebrahimi     return ret;
721*62c56f98SSadaf Ebrahimi }
722*62c56f98SSadaf Ebrahimi 
723*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */
724*62c56f98SSadaf Ebrahimi 
725*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_NIST_KW_C */
726