Clarify usage message.
[openssl.git] / fips / aes / fips_aes_selftest.c
1 /* ====================================================================
2  * Copyright (c) 2003 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer. 
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    openssl-core@openssl.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  *
48  */
49
50 #define OPENSSL_FIPSAPI
51
52 #include <string.h>
53 #include <openssl/err.h>
54 #include <openssl/fips.h>
55 #include <openssl/evp.h>
56 #include "fips_locl.h"
57
58 #ifdef OPENSSL_FIPS
59 __fips_constseg
60 static const struct
61     {
62     const unsigned char key[16];
63     const unsigned char plaintext[16];
64     const unsigned char ciphertext[16];
65     } tests[]=
66         {
67         {
68         { 0x00,0x01,0x02,0x03,0x04,0x05,0x06,0x07,
69           0x08,0x09,0x0A,0x0B,0x0C,0x0D,0x0E,0x0F },
70         { 0x00,0x11,0x22,0x33,0x44,0x55,0x66,0x77,
71           0x88,0x99,0xAA,0xBB,0xCC,0xDD,0xEE,0xFF },
72         { 0x69,0xC4,0xE0,0xD8,0x6A,0x7B,0x04,0x30,
73           0xD8,0xCD,0xB7,0x80,0x70,0xB4,0xC5,0x5A },
74         },
75         };
76
77 int FIPS_selftest_aes()
78     {
79     int n;
80     int ret = 0;
81     EVP_CIPHER_CTX ctx;
82     FIPS_cipher_ctx_init(&ctx);
83
84     for(n=0 ; n < 1 ; ++n)
85         {
86         if (fips_cipher_test(FIPS_TEST_CIPHER, &ctx, EVP_aes_128_ecb(),
87                                 tests[n].key, NULL,
88                                 tests[n].plaintext,
89                                 tests[n].ciphertext,
90                                 16) <= 0)
91                 goto err;
92         }
93     ret = 1;
94     err:
95     FIPS_cipher_ctx_cleanup(&ctx);
96     if (ret == 0)
97             FIPSerr(FIPS_F_FIPS_SELFTEST_AES,FIPS_R_SELFTEST_FAILED);
98     return ret;
99     }
100
101 /* AES-CCM test data from NIST public test vectors */
102
103 __fips_constseg
104 static const unsigned char ccm_key[] = {
105         0xce,0xb0,0x09,0xae,0xa4,0x45,0x44,0x51,0xfe,0xad,0xf0,0xe6,
106         0xb3,0x6f,0x45,0x55,0x5d,0xd0,0x47,0x23,0xba,0xa4,0x48,0xe8
107 };
108 __fips_constseg
109 static const unsigned char ccm_nonce[] = {
110         0x76,0x40,0x43,0xc4,0x94,0x60,0xb7
111 };
112 __fips_constseg
113 static const unsigned char ccm_adata[] = {
114         0x6e,0x80,0xdd,0x7f,0x1b,0xad,0xf3,0xa1,0xc9,0xab,0x25,0xc7,
115         0x5f,0x10,0xbd,0xe7,0x8c,0x23,0xfa,0x0e,0xb8,0xf9,0xaa,0xa5,
116         0x3a,0xde,0xfb,0xf4,0xcb,0xf7,0x8f,0xe4
117 };
118 __fips_constseg
119 static const unsigned char ccm_pt[] = {
120         0xc8,0xd2,0x75,0xf9,0x19,0xe1,0x7d,0x7f,0xe6,0x9c,0x2a,0x1f,
121         0x58,0x93,0x9d,0xfe,0x4d,0x40,0x37,0x91,0xb5,0xdf,0x13,0x10
122 };
123 __fips_constseg
124 static const unsigned char ccm_ct[] = {
125         0x8a,0x0f,0x3d,0x82,0x29,0xe4,0x8e,0x74,0x87,0xfd,0x95,0xa2,
126         0x8a,0xd3,0x92,0xc8,0x0b,0x36,0x81,0xd4,0xfb,0xc7,0xbb,0xfd
127 };
128 __fips_constseg
129 static const unsigned char ccm_tag[] = {
130         0x2d,0xd6,0xef,0x1c,0x45,0xd4,0xcc,0xb7,0x23,0xdc,0x07,0x44,
131         0x14,0xdb,0x50,0x6d
132 };
133
134 int FIPS_selftest_aes_ccm(void)
135         {
136         int ret = 0, do_corrupt = 0;
137         unsigned char out[128], tag[16];
138         EVP_CIPHER_CTX ctx;
139         FIPS_cipher_ctx_init(&ctx);
140         memset(out, 0, sizeof(out));
141         if (!fips_post_started(FIPS_TEST_CCM, 0, 0))
142                 return 1;
143         if (!fips_post_corrupt(FIPS_TEST_CCM, 0, NULL))
144                 do_corrupt = 1;
145         if (!FIPS_cipherinit(&ctx, EVP_aes_192_ccm(), NULL, NULL, 1))
146                 goto err;
147         if (!FIPS_cipher_ctx_ctrl(&ctx, EVP_CTRL_CCM_SET_IVLEN,
148                                         sizeof(ccm_nonce), NULL))
149                 goto err;
150         if (!FIPS_cipher_ctx_ctrl(&ctx, EVP_CTRL_CCM_SET_TAG,
151                                         sizeof(ccm_tag), NULL))
152                 goto err;
153         if (!FIPS_cipherinit(&ctx, NULL, ccm_key, ccm_nonce, 1))
154                 goto err;
155         if (FIPS_cipher(&ctx, NULL, NULL, sizeof(ccm_pt)) != sizeof(ccm_pt))
156                 goto err;
157         if (FIPS_cipher(&ctx, NULL, ccm_adata, sizeof(ccm_adata)) < 0)
158                 goto err;
159         if (FIPS_cipher(&ctx, out, ccm_pt, sizeof(ccm_pt)) != sizeof(ccm_ct))
160                 goto err;
161
162         if (!FIPS_cipher_ctx_ctrl(&ctx, EVP_CTRL_CCM_GET_TAG, 16, tag))
163                 goto err;
164         if (memcmp(tag, ccm_tag, sizeof(ccm_tag))
165                 || memcmp(out, ccm_ct, sizeof(ccm_ct)))
166                 goto err;
167
168         memset(out, 0, sizeof(out));
169
170         /* Modify expected tag value */
171         if (do_corrupt)
172                 tag[0]++;
173
174         if (!FIPS_cipherinit(&ctx, EVP_aes_192_ccm(), NULL, NULL, 0))
175                 goto err;
176         if (!FIPS_cipher_ctx_ctrl(&ctx, EVP_CTRL_CCM_SET_IVLEN,
177                                         sizeof(ccm_nonce), NULL))
178                 goto err;
179         if (!FIPS_cipher_ctx_ctrl(&ctx, EVP_CTRL_CCM_SET_TAG, 16, tag))
180                 goto err;
181         if (!FIPS_cipherinit(&ctx, NULL, ccm_key, ccm_nonce, 0))
182                 goto err;
183         if (FIPS_cipher(&ctx, NULL, NULL, sizeof(ccm_ct)) != sizeof(ccm_ct))
184                 goto err;
185         if (FIPS_cipher(&ctx, NULL, ccm_adata, sizeof(ccm_adata)) < 0)
186                 goto err;
187         if (FIPS_cipher(&ctx, out, ccm_ct, sizeof(ccm_ct)) != sizeof(ccm_pt))
188                 goto err;
189
190         if (memcmp(out, ccm_pt, sizeof(ccm_pt)))
191                 goto err;
192
193         ret = 1;
194
195         err:
196         FIPS_cipher_ctx_cleanup(&ctx);
197
198         if (ret == 0)
199                 {
200                 fips_post_failed(FIPS_TEST_CCM, 0, NULL);
201                 FIPSerr(FIPS_F_FIPS_SELFTEST_AES_CCM,FIPS_R_SELFTEST_FAILED);
202                 return 0;
203                 }
204         else
205                 return fips_post_success(FIPS_TEST_CCM, 0, NULL);
206
207         }
208
209 /* AES-GCM test data from NIST public test vectors */
210
211 __fips_constseg
212 static const unsigned char gcm_key[] = {
213         0xee,0xbc,0x1f,0x57,0x48,0x7f,0x51,0x92,0x1c,0x04,0x65,0x66,
214         0x5f,0x8a,0xe6,0xd1,0x65,0x8b,0xb2,0x6d,0xe6,0xf8,0xa0,0x69,
215         0xa3,0x52,0x02,0x93,0xa5,0x72,0x07,0x8f
216 };
217 __fips_constseg
218 static const unsigned char gcm_iv[] = {
219         0x99,0xaa,0x3e,0x68,0xed,0x81,0x73,0xa0,0xee,0xd0,0x66,0x84
220 };
221 __fips_constseg
222 static const unsigned char gcm_pt[] = {
223         0xf5,0x6e,0x87,0x05,0x5b,0xc3,0x2d,0x0e,0xeb,0x31,0xb2,0xea,
224         0xcc,0x2b,0xf2,0xa5
225 };
226 __fips_constseg
227 static const unsigned char gcm_aad[] = {
228         0x4d,0x23,0xc3,0xce,0xc3,0x34,0xb4,0x9b,0xdb,0x37,0x0c,0x43,
229         0x7f,0xec,0x78,0xde
230 };
231 __fips_constseg
232 static const unsigned char gcm_ct[] = {
233         0xf7,0x26,0x44,0x13,0xa8,0x4c,0x0e,0x7c,0xd5,0x36,0x86,0x7e,
234         0xb9,0xf2,0x17,0x36
235 };
236 __fips_constseg
237 static const unsigned char gcm_tag[] = {
238         0x67,0xba,0x05,0x10,0x26,0x2a,0xe4,0x87,0xd7,0x37,0xee,0x62,
239         0x98,0xf7,0x7e,0x0c
240 };
241
242 int FIPS_selftest_aes_gcm(void)
243         {
244         int ret = 0, do_corrupt = 0;
245         unsigned char out[128], tag[16];
246         EVP_CIPHER_CTX ctx;
247         FIPS_cipher_ctx_init(&ctx);
248         memset(out, 0, sizeof(out));
249         memset(tag, 0, sizeof(tag));
250         if (!fips_post_started(FIPS_TEST_GCM, 0, 0))
251                 return 1;
252         if (!fips_post_corrupt(FIPS_TEST_GCM, 0, NULL))
253                 do_corrupt = 1;
254         if (!FIPS_cipherinit(&ctx, EVP_aes_256_gcm(), NULL, NULL, 1))
255                 goto err;
256         if (!FIPS_cipher_ctx_ctrl(&ctx, EVP_CTRL_GCM_SET_IVLEN,
257                                         sizeof(gcm_iv), NULL))
258                 goto err;
259         if (!FIPS_cipherinit(&ctx, NULL, gcm_key, gcm_iv, 1))
260                 goto err;
261         if (FIPS_cipher(&ctx, NULL, gcm_aad, sizeof(gcm_aad)) < 0)
262                 goto err;
263         if (FIPS_cipher(&ctx, out, gcm_pt, sizeof(gcm_pt)) != sizeof(gcm_ct))
264                 goto err;
265         if (FIPS_cipher(&ctx, NULL, NULL, 0) < 0)
266                 goto err;
267
268         if (!FIPS_cipher_ctx_ctrl(&ctx, EVP_CTRL_GCM_GET_TAG, 16, tag))
269                 goto err;
270
271         if (memcmp(tag, gcm_tag, 16) || memcmp(out, gcm_ct, 16))
272                 goto err;
273
274         memset(out, 0, sizeof(out));
275
276         /* Modify expected tag value */
277         if (do_corrupt)
278                 tag[0]++;
279
280         if (!FIPS_cipherinit(&ctx, EVP_aes_256_gcm(), NULL, NULL, 0))
281                 goto err;
282         if (!FIPS_cipher_ctx_ctrl(&ctx, EVP_CTRL_GCM_SET_IVLEN,
283                                         sizeof(gcm_iv), NULL))
284                 goto err;
285         if (!FIPS_cipher_ctx_ctrl(&ctx, EVP_CTRL_GCM_SET_TAG, 16, tag))
286                 goto err;
287         if (!FIPS_cipherinit(&ctx, NULL, gcm_key, gcm_iv, 0))
288                 goto err;
289         if (FIPS_cipher(&ctx, NULL, gcm_aad, sizeof(gcm_aad)) < 0)
290                 goto err;
291         if (FIPS_cipher(&ctx, out, gcm_ct, sizeof(gcm_ct)) != sizeof(gcm_pt))
292                 goto err;
293         if (FIPS_cipher(&ctx, NULL, NULL, 0) < 0)
294                 goto err;
295
296         if (memcmp(out, gcm_pt, 16))
297                 goto err;
298
299         ret = 1;
300
301         err:
302         FIPS_cipher_ctx_cleanup(&ctx);
303
304         if (ret == 0)
305                 {
306                 fips_post_failed(FIPS_TEST_GCM, 0, NULL);
307                 FIPSerr(FIPS_F_FIPS_SELFTEST_AES_GCM,FIPS_R_SELFTEST_FAILED);
308                 return 0;
309                 }
310         else
311                 return fips_post_success(FIPS_TEST_GCM, 0, NULL);
312
313         }
314
315
316 __fips_constseg
317 static const unsigned char XTS_128_key[] = {
318         0xa1,0xb9,0x0c,0xba,0x3f,0x06,0xac,0x35,0x3b,0x2c,0x34,0x38,
319         0x76,0x08,0x17,0x62,0x09,0x09,0x23,0x02,0x6e,0x91,0x77,0x18,
320         0x15,0xf2,0x9d,0xab,0x01,0x93,0x2f,0x2f
321 };
322 __fips_constseg
323 static const unsigned char XTS_128_i[] = {
324         0x4f,0xae,0xf7,0x11,0x7c,0xda,0x59,0xc6,0x6e,0x4b,0x92,0x01,
325         0x3e,0x76,0x8a,0xd5
326 };
327 __fips_constseg
328 static const unsigned char XTS_128_pt[] = {
329         0xeb,0xab,0xce,0x95,0xb1,0x4d,0x3c,0x8d,0x6f,0xb3,0x50,0x39,
330         0x07,0x90,0x31,0x1c
331 };
332 __fips_constseg
333 static const unsigned char XTS_128_ct[] = {
334         0x77,0x8a,0xe8,0xb4,0x3c,0xb9,0x8d,0x5a,0x82,0x50,0x81,0xd5,
335         0xbe,0x47,0x1c,0x63
336 };
337
338 __fips_constseg
339 static const unsigned char XTS_256_key[] = {
340         0x1e,0xa6,0x61,0xc5,0x8d,0x94,0x3a,0x0e,0x48,0x01,0xe4,0x2f,
341         0x4b,0x09,0x47,0x14,0x9e,0x7f,0x9f,0x8e,0x3e,0x68,0xd0,0xc7,
342         0x50,0x52,0x10,0xbd,0x31,0x1a,0x0e,0x7c,0xd6,0xe1,0x3f,0xfd,
343         0xf2,0x41,0x8d,0x8d,0x19,0x11,0xc0,0x04,0xcd,0xa5,0x8d,0xa3,
344         0xd6,0x19,0xb7,0xe2,0xb9,0x14,0x1e,0x58,0x31,0x8e,0xea,0x39,
345         0x2c,0xf4,0x1b,0x08
346 };
347 __fips_constseg
348 static const unsigned char XTS_256_i[] = {
349         0xad,0xf8,0xd9,0x26,0x27,0x46,0x4a,0xd2,0xf0,0x42,0x8e,0x84,
350         0xa9,0xf8,0x75,0x64
351 };
352 __fips_constseg
353 static const unsigned char XTS_256_pt[] = {
354         0x2e,0xed,0xea,0x52,0xcd,0x82,0x15,0xe1,0xac,0xc6,0x47,0xe8,
355         0x10,0xbb,0xc3,0x64,0x2e,0x87,0x28,0x7f,0x8d,0x2e,0x57,0xe3,
356         0x6c,0x0a,0x24,0xfb,0xc1,0x2a,0x20,0x2e
357 };
358 __fips_constseg
359 static const unsigned char XTS_256_ct[] = {
360         0xcb,0xaa,0xd0,0xe2,0xf6,0xce,0xa3,0xf5,0x0b,0x37,0xf9,0x34,
361         0xd4,0x6a,0x9b,0x13,0x0b,0x9d,0x54,0xf0,0x7e,0x34,0xf3,0x6a,
362         0xf7,0x93,0xe8,0x6f,0x73,0xc6,0xd7,0xdb
363 };
364
365 int FIPS_selftest_aes_xts()
366         {
367         int ret = 1;
368         EVP_CIPHER_CTX ctx;
369         FIPS_cipher_ctx_init(&ctx);
370
371         if (fips_cipher_test(FIPS_TEST_XTS, &ctx, EVP_aes_128_xts(),
372                                 XTS_128_key, XTS_128_i, XTS_128_pt, XTS_128_ct,
373                                 sizeof(XTS_128_pt)) <= 0)
374                 ret = 0;
375
376         if (fips_cipher_test(FIPS_TEST_XTS, &ctx, EVP_aes_256_xts(),
377                                 XTS_256_key, XTS_256_i, XTS_256_pt, XTS_256_ct,
378                                 sizeof(XTS_256_pt)) <= 0)
379                 ret = 0;
380
381         FIPS_cipher_ctx_cleanup(&ctx);
382         if (ret == 0)
383                 FIPSerr(FIPS_F_FIPS_SELFTEST_AES_XTS,FIPS_R_SELFTEST_FAILED);
384         return ret;
385         }
386
387 #endif