Add usage messages.
[openssl.git] / fips / fips_post.c
1 /* ====================================================================
2  * Copyright (c) 2011 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 <openssl/crypto.h>
53 #include <openssl/rand.h>
54 #include <openssl/fips_rand.h>
55 #include <openssl/err.h>
56 #include <openssl/bio.h>
57 #include <openssl/hmac.h>
58 #include <openssl/rsa.h>
59 #include <openssl/dsa.h>
60 #include <openssl/ecdsa.h>
61 #include <string.h>
62 #include <limits.h>
63
64 #ifdef OPENSSL_FIPS
65
66 /* Power on self test (POST) support functions */
67
68 #include <openssl/fips.h>
69 #include "fips_locl.h"
70
71 /* POST notification callback */
72
73 int (*fips_post_cb)(int op, int id, int subid, void *ex);
74
75 void FIPS_post_set_callback(
76         int (*post_cb)(int op, int id, int subid, void *ex))
77         {
78         fips_post_cb = post_cb;
79         }
80
81 /* POST status: i.e. status of all tests */
82 #define FIPS_POST_STATUS_NOT_STARTED    0
83 #define FIPS_POST_STATUS_OK             1
84 #define FIPS_POST_STATUS_RUNNING        2
85 #define FIPS_POST_STATUS_FAILED         -1
86 static int post_status = 0;
87 /* Set to 1 if any test failed */
88 static int post_failure = 0;
89
90 /* All tests started */
91
92 int fips_post_begin(void)
93         {
94         post_failure = 0;
95         post_status = FIPS_POST_STATUS_NOT_STARTED;
96         if (fips_post_cb)
97                 if (!fips_post_cb(FIPS_POST_BEGIN, 0, 0, NULL))
98                         return 0;
99         post_status = FIPS_POST_STATUS_RUNNING;
100         return 1;
101         }
102
103 void fips_post_end(void)
104         {
105         if (post_failure)
106                 {
107                 post_status = FIPS_POST_STATUS_FAILED;
108                 if(fips_post_cb)
109                         fips_post_cb(FIPS_POST_END, 0, 0, NULL);
110                 }
111         else
112                 {
113                 post_status = FIPS_POST_STATUS_OK;
114                 if (fips_post_cb)
115                         fips_post_cb(FIPS_POST_END, 1, 0, NULL);
116                 }
117         }
118
119 /* A self test started */
120 int fips_post_started(int id, int subid, void *ex)
121         {
122         if (fips_post_cb)
123                 return fips_post_cb(FIPS_POST_STARTED, id, subid, ex);
124         return 1;
125         }
126 /* A self test passed successfully */
127 int fips_post_success(int id, int subid, void *ex)
128         {
129         if (fips_post_cb)
130                 return fips_post_cb(FIPS_POST_SUCCESS, id, subid, ex);
131         return 1;
132         }
133 /* A self test failed */
134 int fips_post_failed(int id, int subid, void *ex)
135         {
136         post_failure = 1;
137         if (fips_post_cb)
138                 return fips_post_cb(FIPS_POST_FAIL, id, subid, ex);
139         return 1;
140         }
141 /* Indicate if a self test failure should be induced */
142 int fips_post_corrupt(int id, int subid, void *ex)
143         {
144         if (fips_post_cb)
145                 return fips_post_cb(FIPS_POST_CORRUPT, id, subid, ex);
146         return 1;
147         }
148 /* Note: if selftests running return status OK so their operation is
149  * not interrupted. This will only happen while selftests are actually
150  * running so will not interfere with normal operation.
151  */
152 int fips_post_status(void)
153         {
154         return post_status > 0 ? 1 : 0;
155         }
156 /* Run all selftests */
157 int FIPS_selftest(void)
158         {
159         int rv = 1;
160         fips_post_begin();
161         if(!FIPS_check_incore_fingerprint())
162                 rv = 0;
163         if (!FIPS_selftest_drbg())
164                 rv = 0;
165         if (!FIPS_selftest_x931())
166                 rv = 0;
167         if (!FIPS_selftest_sha1())
168                 rv = 0;
169         if (!FIPS_selftest_hmac())
170                 rv = 0;
171         if (!FIPS_selftest_cmac())
172                 rv = 0;
173         if (!FIPS_selftest_aes())
174                 rv = 0;
175         if (!FIPS_selftest_aes_ccm())
176                 rv = 0;
177         if (!FIPS_selftest_aes_gcm())
178                 rv = 0;
179         if (!FIPS_selftest_aes_xts())
180                 rv = 0;
181         if (!FIPS_selftest_des())
182                 rv = 0;
183         if (!FIPS_selftest_rsa())
184                 rv = 0;
185         if (!FIPS_selftest_ecdsa())
186                 rv = 0;
187         if (!FIPS_selftest_dsa())
188                 rv = 0;
189         if (!FIPS_selftest_ecdh())
190                 rv = 0;
191         fips_post_end();
192         return rv;
193         }
194
195 /* Generalized public key test routine. Signs and verifies the data
196  * supplied in tbs using mesage digest md and setting RSA padding mode
197  * pad_mode. If the 'kat' parameter is not NULL it will
198  * additionally check the signature matches it: a known answer test
199  * The string "fail_str" is used for identification purposes in case
200  * of failure. If "pkey" is NULL just perform a message digest check.
201  */
202
203 int fips_pkey_signature_test(int id, EVP_PKEY *pkey,
204                         const unsigned char *tbs, size_t tbslen,
205                         const unsigned char *kat, size_t katlen,
206                         const EVP_MD *digest, int pad_mode,
207                         const char *fail_str)
208         {       
209         int subid;
210         void *ex = NULL;
211         int ret = 0;
212         unsigned char *sig = NULL;
213         unsigned int siglen;
214         __fips_constseg
215         static const unsigned char str1[]="12345678901234567890";
216         DSA_SIG *dsig = NULL;
217         ECDSA_SIG *esig = NULL;
218         EVP_MD_CTX mctx;
219         FIPS_md_ctx_init(&mctx);
220
221         if (tbs == NULL)
222                 tbs = str1;
223
224         if (tbslen == 0)
225                 tbslen = strlen((char *)tbs);
226
227         if (digest == NULL)
228                 digest = EVP_sha256();
229
230         subid = M_EVP_MD_type(digest);
231
232
233         if (!fips_post_started(id, subid, pkey))
234                 return 1;
235
236         if (!pkey || pkey->type == EVP_PKEY_RSA)
237                 {
238                 size_t sigsize;
239                 if (!pkey)
240                         sigsize = EVP_MAX_MD_SIZE;
241                 else
242                         sigsize = RSA_size(pkey->pkey.rsa);
243
244                 sig = OPENSSL_malloc(sigsize);
245                 if (!sig)
246                         {
247                         FIPSerr(FIPS_F_FIPS_PKEY_SIGNATURE_TEST,ERR_R_MALLOC_FAILURE);
248                         goto error;
249                         }
250                 }
251
252         if (!FIPS_digestinit(&mctx, digest))
253                 goto error;
254         if (!FIPS_digestupdate(&mctx, tbs, tbslen))
255                 goto error;
256
257         if (!fips_post_corrupt(id, subid, pkey))
258                 {
259                 if (!FIPS_digestupdate(&mctx, tbs, 1))
260                         goto error;
261                 }
262
263         if (pkey == NULL)
264                 {
265                 if (!FIPS_digestfinal(&mctx, sig, &siglen))
266                         goto error;
267                 }
268         else if (pkey->type == EVP_PKEY_RSA)
269                 {
270                 if (!FIPS_rsa_sign_ctx(pkey->pkey.rsa, &mctx,
271                                         pad_mode, 0, NULL, sig, &siglen))
272                         goto error;
273                 }
274         else if (pkey->type == EVP_PKEY_DSA)
275                 {
276                 dsig = FIPS_dsa_sign_ctx(pkey->pkey.dsa, &mctx);
277                 if (!dsig)
278                         goto error;
279                 }
280         else if (pkey->type == EVP_PKEY_EC)
281                 {
282                 esig = FIPS_ecdsa_sign_ctx(pkey->pkey.ec, &mctx);
283                 if (!esig)
284                         goto error;
285                 }
286
287         if (kat && ((siglen != katlen) || memcmp(kat, sig, katlen)))
288                 goto error;
289 #if 0
290         {
291         /* Debug code to print out self test KAT discrepancies */
292         unsigned int i;
293         fprintf(stderr, "%s=", fail_str);
294         for (i = 0; i < siglen; i++)
295                         fprintf(stderr, "%02X", sig[i]);
296         fprintf(stderr, "\n");
297         goto error;
298         }
299 #endif
300         /* If just digest test we've finished */
301         if (pkey == NULL)
302                 {
303                 ret = 1;
304                 /* Well actually sucess as we've set ret to 1 */
305                 goto error;
306                 }
307         if (!FIPS_digestinit(&mctx, digest))
308                 goto error;
309         if (!FIPS_digestupdate(&mctx, tbs, tbslen))
310                 goto error;
311         if (pkey->type == EVP_PKEY_RSA)
312                 {
313                 ret = FIPS_rsa_verify_ctx(pkey->pkey.rsa, &mctx,
314                                                 pad_mode, 0, NULL, sig, siglen);
315                 }
316         else if (pkey->type == EVP_PKEY_DSA)
317                 {
318                 ret = FIPS_dsa_verify_ctx(pkey->pkey.dsa, &mctx, dsig);
319                 }
320         else if (pkey->type == EVP_PKEY_EC)
321                 {
322                 ret = FIPS_ecdsa_verify_ctx(pkey->pkey.ec, &mctx, esig);
323                 }
324
325         error:
326         if (dsig != NULL)
327                 FIPS_dsa_sig_free(dsig);
328         if (esig != NULL)
329                 FIPS_ecdsa_sig_free(esig);
330         if (sig)
331                 OPENSSL_free(sig);
332         FIPS_md_ctx_cleanup(&mctx);
333         if (ret != 1)
334                 {
335                 FIPSerr(FIPS_F_FIPS_PKEY_SIGNATURE_TEST,FIPS_R_TEST_FAILURE);
336                 if (fail_str)
337                         FIPS_add_error_data(2, "Type=", fail_str);
338                 fips_post_failed(id, subid, ex);
339                 return 0;
340                 }
341         return fips_post_success(id, subid, pkey);
342         }
343
344 /* Generalized symmetric cipher test routine. Encrypt data, verify result
345  * against known answer, decrypt and compare with original plaintext.
346  */
347
348 int fips_cipher_test(int id, EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher,
349                         const unsigned char *key,
350                         const unsigned char *iv,
351                         const unsigned char *plaintext,
352                         const unsigned char *ciphertext,
353                         int len)
354         {
355         unsigned char pltmp[FIPS_MAX_CIPHER_TEST_SIZE];
356         unsigned char citmp[FIPS_MAX_CIPHER_TEST_SIZE];
357         int subid = M_EVP_CIPHER_nid(cipher);
358         int rv = 0;
359         OPENSSL_assert(len <= FIPS_MAX_CIPHER_TEST_SIZE);
360         memset(pltmp, 0, FIPS_MAX_CIPHER_TEST_SIZE);
361         memset(citmp, 0, FIPS_MAX_CIPHER_TEST_SIZE);
362
363         if (!fips_post_started(id, subid, NULL))
364                 return 1;
365         if (FIPS_cipherinit(ctx, cipher, key, iv, 1) <= 0)
366                 goto error;
367         if (!FIPS_cipher(ctx, citmp, plaintext, len))
368                 goto error;
369         if (memcmp(citmp, ciphertext, len))
370                 goto error;
371         if (!fips_post_corrupt(id, subid, NULL))
372                         citmp[0] ^= 0x1;
373         if (FIPS_cipherinit(ctx, cipher, key, iv, 0) <= 0)
374                 goto error;
375         FIPS_cipher(ctx, pltmp, citmp, len);
376         if (memcmp(pltmp, plaintext, len))
377                 goto error;
378         rv = 1;
379         error:
380         if (rv == 0)
381                 {
382                 fips_post_failed(id, subid, NULL);
383                 return 0;
384                 }
385         return fips_post_success(id, subid, NULL);
386         }
387
388 #endif