3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
6 /* ====================================================================
7 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
59 #include <openssl/evp.h>
60 #include <openssl/err.h>
61 #include <openssl/x509v3.h>
63 /* Remove spaces from beginning and end of a string */
65 static void remove_space(char **pval)
67 unsigned char *p = (unsigned char *)*pval;
74 p = p + strlen(*pval) - 1;
76 /* Remove trailing space */
82 * Given a line of the form:
83 * name = value # comment
84 * extract name and value. NB: modifies passed buffer.
87 static int parse_line(char **pkw, char **pval, char *linebuf)
91 p = linebuf + strlen(linebuf) - 1;
94 fprintf(stderr, "FATAL: missing EOL\n");
100 p = strchr(linebuf, '#');
105 /* Look for = sign */
106 p = strchr(linebuf, '=');
117 /* Remove spaces from keyword and value */
124 /* For a hex string "value" convert to a binary allocated buffer */
125 static int test_bin(const char *value, unsigned char **buf, size_t *buflen)
129 /* Don't return NULL for zero length buffer */
130 *buf = OPENSSL_malloc(1);
137 *buf = string_to_hex(value, &len);
139 fprintf(stderr, "Value=%s\n", value);
140 ERR_print_errors_fp(stderr);
143 /* Size of input buffer means we'll never overflow */
148 /* Structure holding test information */
150 /* method for this test */
151 const struct evp_test_method *meth;
152 /* current line being processed */
154 /* start line of current test */
155 unsigned int start_line;
156 /* Error string for test */
158 /* Expected error value of test */
160 /* Number of tests */
164 /* test specific data */
167 /* Test method structure */
168 struct evp_test_method {
169 /* Name of test as it appears in file */
171 /* Initialise test for "alg" */
172 int (*init) (struct evp_test * t, const char *alg);
173 /* Clean up method */
174 void (*cleanup) (struct evp_test * t);
175 /* Test specific name value pair processing */
176 int (*parse) (struct evp_test * t, const char *name, const char *value);
177 /* Run the test itself */
178 int (*run_test) (struct evp_test * t);
181 static const struct evp_test_method digest_test_method, cipher_test_method;
182 static const struct evp_test_method aead_test_method;
184 static const struct evp_test_method *evp_test_list[] = {
190 static const struct evp_test_method *evp_find_test(const char *name)
192 const struct evp_test_method **tt;
193 for (tt = evp_test_list; *tt; tt++) {
194 if (!strcmp(name, (*tt)->name))
200 static int check_test_error(struct evp_test *t)
202 if (!t->err && !t->expected_err)
204 if (t->err && !t->expected_err) {
205 fprintf(stderr, "Test line %d: unexpected error %s\n",
206 t->start_line, t->err);
209 if (!t->err && t->expected_err) {
210 fprintf(stderr, "Test line %d: succeeded expecting %s\n",
211 t->start_line, t->expected_err);
214 if (!strcmp(t->err, t->expected_err))
217 fprintf(stderr, "Test line %d: expecting %s got %s\n",
218 t->start_line, t->expected_err, t->err);
222 /* Setup a new test, run any existing test */
224 static int setup_test(struct evp_test *t, const struct evp_test_method *tmeth)
226 /* If we already have a test set up run it */
230 if (t->meth->run_test(t) != 1) {
231 fprintf(stderr, "%s test error line %d\n",
232 t->meth->name, t->start_line);
235 if (!check_test_error(t)) {
237 ERR_print_errors_fp(stderr);
242 /* If new test type free old data */
243 if (tmeth != t->meth && t->data) {
244 OPENSSL_free(t->data);
247 if (t->expected_err) {
248 OPENSSL_free(t->expected_err);
249 t->expected_err = NULL;
256 static int process_test(struct evp_test *t, char *buf, int verbose)
258 char *keyword, *value;
260 const struct evp_test_method *tmeth;
263 if (!parse_line(&keyword, &value, buf))
265 /* See if keyword corresponds to a test start */
266 tmeth = evp_find_test(keyword);
268 if (!setup_test(t, tmeth))
270 t->start_line = t->line;
271 if (!tmeth->init(t, value)) {
272 fprintf(stderr, "Unknown %s: %s\n", keyword, value);
276 } else if (!strcmp(keyword, "Result")) {
277 if (t->expected_err) {
278 fprintf(stderr, "Line %d: multiple result lines\n", t->line);
281 t->expected_err = BUF_strdup(value);
282 if (!t->expected_err)
285 /* Must be test specific line: try to parse it */
287 rv = t->meth->parse(t, keyword, value);
290 fprintf(stderr, "line %d: unexpected keyword %s\n",
294 fprintf(stderr, "line %d: error processing keyword %s\n",
302 int main(int argc, char **argv)
308 ERR_load_crypto_strings();
309 OpenSSL_add_all_algorithms();
316 in = fopen(argv[1], "r");
317 while (fgets(buf, sizeof(buf), in)) {
319 if (!process_test(&t, buf, 0))
322 /* Run any final test we have */
323 if (!setup_test(&t, NULL))
325 fprintf(stderr, "%d tests completed with %d errors\n",
331 static void test_free(void *d)
337 /* Message digest tests */
340 /* Digest this test is for */
341 const EVP_MD *digest;
342 /* Input to digest */
343 unsigned char *input;
345 /* Expected output */
346 unsigned char *output;
350 static int digest_test_init(struct evp_test *t, const char *alg)
352 const EVP_MD *digest;
353 struct digest_data *mdat = t->data;
354 digest = EVP_get_digestbyname(alg);
357 mdat = OPENSSL_malloc(sizeof(struct digest_data));
358 mdat->digest = digest;
365 static void digest_test_cleanup(struct evp_test *t)
367 struct digest_data *mdat = t->data;
368 test_free(mdat->input);
369 test_free(mdat->output);
372 static int digest_test_parse(struct evp_test *t,
373 const char *keyword, const char *value)
375 struct digest_data *mdata = t->data;
376 if (!strcmp(keyword, "Input"))
377 return test_bin(value, &mdata->input, &mdata->input_len);
378 if (!strcmp(keyword, "Output"))
379 return test_bin(value, &mdata->output, &mdata->output_len);
383 static int digest_test_run(struct evp_test *t)
385 struct digest_data *mdata = t->data;
386 const char *err = "INTERNAL_ERROR";
388 unsigned char md[EVP_MAX_MD_SIZE];
390 mctx = EVP_MD_CTX_create();
393 err = "DIGESTINIT_ERROR";
394 if (!EVP_DigestInit_ex(mctx, mdata->digest, NULL))
396 err = "DIGESTUPDATE_ERROR";
397 if (!EVP_DigestUpdate(mctx, mdata->input, mdata->input_len))
399 err = "DIGESTFINAL_ERROR";
400 if (!EVP_DigestFinal(mctx, md, &md_len))
402 err = "DIGEST_LENGTH_MISMATCH";
403 if (md_len != mdata->output_len)
405 err = "DIGEST_MISMATCH";
406 if (memcmp(mdata->output, md, md_len))
411 EVP_MD_CTX_destroy(mctx);
416 static const struct evp_test_method digest_test_method = {
426 const EVP_CIPHER *cipher;
428 /* Set to EVP_CIPH_GCM_MODE or EVP_CIPH_CCM_MODE if AEAD */
434 unsigned char *plaintext;
435 size_t plaintext_len;
436 unsigned char *ciphertext;
437 size_t ciphertext_len;
445 static int cipher_test_init(struct evp_test *t, const char *alg)
447 const EVP_CIPHER *cipher;
448 struct cipher_data *cdat = t->data;
449 cipher = EVP_get_cipherbyname(alg);
452 cdat = OPENSSL_malloc(sizeof(struct cipher_data));
453 cdat->cipher = cipher;
457 cdat->ciphertext = NULL;
458 cdat->plaintext = NULL;
462 if (EVP_CIPHER_mode(cipher) == EVP_CIPH_GCM_MODE
463 || EVP_CIPHER_mode(cipher) == EVP_CIPH_CCM_MODE)
464 cdat->aead = EVP_CIPHER_mode(cipher);
471 static void cipher_test_cleanup(struct evp_test *t)
473 struct cipher_data *cdat = t->data;
474 test_free(cdat->key);
476 test_free(cdat->ciphertext);
477 test_free(cdat->plaintext);
478 test_free(cdat->aad);
479 test_free(cdat->tag);
482 static int cipher_test_parse(struct evp_test *t, const char *keyword,
485 struct cipher_data *cdat = t->data;
486 if (!strcmp(keyword, "Key"))
487 return test_bin(value, &cdat->key, &cdat->key_len);
488 if (!strcmp(keyword, "IV"))
489 return test_bin(value, &cdat->iv, &cdat->iv_len);
490 if (!strcmp(keyword, "Plaintext"))
491 return test_bin(value, &cdat->plaintext, &cdat->plaintext_len);
492 if (!strcmp(keyword, "Ciphertext"))
493 return test_bin(value, &cdat->ciphertext, &cdat->ciphertext_len);
495 if (!strcmp(keyword, "AAD"))
496 return test_bin(value, &cdat->aad, &cdat->aad_len);
497 if (!strcmp(keyword, "Tag"))
498 return test_bin(value, &cdat->tag, &cdat->tag_len);
501 if (!strcmp(keyword, "Operation")) {
502 if (!strcmp(value, "ENCRYPT"))
504 else if (!strcmp(value, "DECRYPT"))
513 static int cipher_test_enc(struct evp_test *t, int enc)
515 struct cipher_data *cdat = t->data;
516 unsigned char *in, *out, *tmp = NULL;
517 size_t in_len, out_len;
519 EVP_CIPHER_CTX *ctx = NULL;
521 err = "INTERNAL_ERROR";
522 ctx = EVP_CIPHER_CTX_new();
525 EVP_CIPHER_CTX_set_flags(ctx, EVP_CIPHER_CTX_FLAG_WRAP_ALLOW);
527 in = cdat->plaintext;
528 in_len = cdat->plaintext_len;
529 out = cdat->ciphertext;
530 out_len = cdat->ciphertext_len;
532 in = cdat->ciphertext;
533 in_len = cdat->ciphertext_len;
534 out = cdat->plaintext;
535 out_len = cdat->plaintext_len;
537 tmp = OPENSSL_malloc(in_len + 2 * EVP_MAX_BLOCK_LENGTH);
540 err = "CIPHERINIT_ERROR";
541 if (!EVP_CipherInit_ex(ctx, cdat->cipher, NULL, NULL, NULL, enc))
543 err = "INVALID_IV_LENGTH";
545 if (cdat->aead == EVP_CIPH_GCM_MODE) {
546 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GCM_SET_IVLEN,
549 } else if (cdat->aead == EVP_CIPH_CCM_MODE) {
550 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_CCM_SET_IVLEN,
553 } else if (cdat->iv_len != (size_t)EVP_CIPHER_CTX_iv_length(ctx))
559 * If encrypting just set tag length. If decrypting set
560 * tag length and value.
563 err = "TAG_LENGTH_SET_ERROR";
566 err = "TAG_SET_ERROR";
569 if (cdat->aead == EVP_CIPH_GCM_MODE && tag) {
570 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GCM_SET_TAG,
573 } else if (cdat->aead == EVP_CIPH_CCM_MODE) {
574 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_CCM_SET_TAG,
580 err = "INVALID_KEY_LENGTH";
581 if (!EVP_CIPHER_CTX_set_key_length(ctx, cdat->key_len))
583 err = "KEY_SET_ERROR";
584 if (!EVP_CipherInit_ex(ctx, NULL, NULL, cdat->key, cdat->iv, -1))
587 if (cdat->aead == EVP_CIPH_CCM_MODE) {
588 if (!EVP_CipherUpdate(ctx, NULL, &tmplen, NULL, out_len)) {
589 err = "CCM_PLAINTEXT_LENGTH_SET_ERROR";
594 if (!EVP_CipherUpdate(ctx, NULL, &tmplen, cdat->aad, cdat->aad_len)) {
595 err = "AAD_SET_ERROR";
599 EVP_CIPHER_CTX_set_padding(ctx, 0);
600 err = "CIPHERUPDATE_ERROR";
601 if (!EVP_CipherUpdate(ctx, tmp, &tmplen, in, in_len))
603 if (cdat->aead == EVP_CIPH_CCM_MODE)
606 err = "CIPHERFINAL_ERROR";
607 if (!EVP_CipherFinal_ex(ctx, tmp + tmplen, &tmpflen))
610 err = "LENGTH_MISMATCH";
611 if (out_len != (size_t)(tmplen + tmpflen))
613 err = "VALUE_MISMATCH";
614 if (memcmp(out, tmp, out_len))
616 if (enc && cdat->aead) {
617 unsigned char rtag[16];
618 if (cdat->tag_len > sizeof(rtag)) {
619 err = "TAG_LENGTH_INTERNAL_ERROR";
622 /* EVP_CTRL_CCM_GET_TAG and EVP_CTRL_GCM_GET_TAG are equal. */
623 if (!EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GCM_GET_TAG,
624 cdat->tag_len, rtag)) {
625 err = "TAG_RETRIEVE_ERROR";
628 if (memcmp(cdat->tag, rtag, cdat->tag_len)) {
629 err = "TAG_VALUE_MISMATCH";
637 EVP_CIPHER_CTX_free(ctx);
642 static int cipher_test_run(struct evp_test *t)
644 struct cipher_data *cdat = t->data;
650 if (!cdat->iv && EVP_CIPHER_iv_length(cdat->cipher)) {
651 /* IV is optional and usually omitted in wrap mode */
652 if (EVP_CIPHER_mode(cdat->cipher) != EVP_CIPH_WRAP_MODE) {
657 if (cdat->aead && !cdat->tag) {
662 rv = cipher_test_enc(t, 1);
663 /* Not fatal errors: return */
670 if (cdat->enc != 1) {
671 rv = cipher_test_enc(t, 0);
672 /* Not fatal errors: return */
682 static const struct evp_test_method cipher_test_method = {