1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Intel Corporation
9 #include <rte_cryptodev.h>
10 #include <rte_cryptodev_pmd.h>
11 #include <rte_mempool.h>
13 #include <rte_string_fns.h>
15 #include "fips_validation.h"
17 #define REQ_FILE_PATH_KEYWORD "req-file"
18 #define RSP_FILE_PATH_KEYWORD "rsp-file"
19 #define FOLDER_KEYWORD "path-is-folder"
20 #define CRYPTODEV_KEYWORD "cryptodev"
21 #define CRYPTODEV_ID_KEYWORD "cryptodev-id"
23 struct fips_test_vector vec;
24 struct fips_test_interim_info info;
26 struct cryptodev_fips_validate_env {
29 uint32_t is_path_folder;
31 struct rte_mempool *mpool;
32 struct rte_mempool *op_pool;
33 struct rte_mbuf *mbuf;
34 struct rte_crypto_op *op;
35 struct rte_cryptodev_sym_session *sess;
39 cryptodev_fips_validate_app_int(void)
41 struct rte_cryptodev_config conf = {rte_socket_id(), 1};
42 struct rte_cryptodev_qp_conf qp_conf = {128};
45 ret = rte_cryptodev_configure(env.dev_id, &conf);
49 env.mpool = rte_pktmbuf_pool_create("FIPS_MEMPOOL", 128, 0, 0,
50 UINT16_MAX, rte_socket_id());
54 ret = rte_cryptodev_queue_pair_setup(env.dev_id, 0, &qp_conf,
55 rte_socket_id(), env.mpool);
61 env.op_pool = rte_crypto_op_pool_create(
63 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
70 env.mbuf = rte_pktmbuf_alloc(env.mpool);
74 env.op = rte_crypto_op_alloc(env.op_pool, RTE_CRYPTO_OP_TYPE_SYMMETRIC);
81 rte_mempool_free(env.mpool);
83 rte_mempool_free(env.op_pool);
89 cryptodev_fips_validate_app_uninit(void)
91 rte_pktmbuf_free(env.mbuf);
92 rte_crypto_op_free(env.op);
93 rte_cryptodev_sym_session_clear(env.dev_id, env.sess);
94 rte_cryptodev_sym_session_free(env.sess);
95 rte_mempool_free(env.mpool);
96 rte_mempool_free(env.op_pool);
100 fips_test_one_file(void);
103 parse_cryptodev_arg(char *arg)
105 int id = rte_cryptodev_get_dev_id(arg);
108 RTE_LOG(ERR, USER1, "Error %i: invalid cryptodev name %s\n",
113 env.dev_id = (uint32_t)id;
119 parse_cryptodev_id_arg(char *arg)
121 uint32_t cryptodev_id;
123 if (parser_read_uint32(&cryptodev_id, arg) < 0) {
124 RTE_LOG(ERR, USER1, "Error %i: invalid cryptodev id %s\n",
130 if (!rte_cryptodev_pmd_is_valid_dev(cryptodev_id)) {
131 RTE_LOG(ERR, USER1, "Error %i: invalid cryptodev id %s\n",
136 env.dev_id = (uint32_t)cryptodev_id;
142 cryptodev_fips_validate_usage(const char *prgname)
144 printf("%s [EAL options] --\n"
145 " --%s: REQUEST-FILE-PATH\n"
146 " --%s: RESPONSE-FILE-PATH\n"
147 " --%s: indicating both paths are folders\n"
148 " --%s: CRYPTODEV-NAME\n"
149 " --%s: CRYPTODEV-ID-NAME\n",
150 prgname, REQ_FILE_PATH_KEYWORD, RSP_FILE_PATH_KEYWORD,
151 FOLDER_KEYWORD, CRYPTODEV_KEYWORD, CRYPTODEV_ID_KEYWORD);
155 cryptodev_fips_validate_parse_args(int argc, char **argv)
158 char *prgname = argv[0];
161 struct option lgopts[] = {
162 {REQ_FILE_PATH_KEYWORD, required_argument, 0, 0},
163 {RSP_FILE_PATH_KEYWORD, required_argument, 0, 0},
164 {FOLDER_KEYWORD, no_argument, 0, 0},
165 {CRYPTODEV_KEYWORD, required_argument, 0, 0},
166 {CRYPTODEV_ID_KEYWORD, required_argument, 0, 0},
172 while ((opt = getopt_long(argc, argvopt, "s:",
173 lgopts, &option_index)) != EOF) {
177 if (strcmp(lgopts[option_index].name,
178 REQ_FILE_PATH_KEYWORD) == 0)
179 env.req_path = optarg;
180 else if (strcmp(lgopts[option_index].name,
181 RSP_FILE_PATH_KEYWORD) == 0)
182 env.rsp_path = optarg;
183 else if (strcmp(lgopts[option_index].name,
184 FOLDER_KEYWORD) == 0)
185 env.is_path_folder = 1;
186 else if (strcmp(lgopts[option_index].name,
187 CRYPTODEV_KEYWORD) == 0) {
188 ret = parse_cryptodev_arg(optarg);
190 cryptodev_fips_validate_usage(prgname);
193 } else if (strcmp(lgopts[option_index].name,
194 CRYPTODEV_ID_KEYWORD) == 0) {
195 ret = parse_cryptodev_id_arg(optarg);
197 cryptodev_fips_validate_usage(prgname);
201 cryptodev_fips_validate_usage(prgname);
210 if (env.req_path == NULL || env.rsp_path == NULL ||
211 env.dev_id == UINT32_MAX) {
212 cryptodev_fips_validate_usage(prgname);
220 main(int argc, char *argv[])
224 ret = rte_eal_init(argc, argv);
226 RTE_LOG(ERR, USER1, "Error %i: Failed init\n", ret);
233 ret = cryptodev_fips_validate_parse_args(argc, argv);
235 rte_exit(EXIT_FAILURE, "Failed to parse arguments!\n");
237 ret = cryptodev_fips_validate_app_int();
239 RTE_LOG(ERR, USER1, "Error %i: Failed init\n", ret);
243 if (!env.is_path_folder) {
244 printf("Processing file %s... ", env.req_path);
246 ret = fips_test_init(env.req_path, env.rsp_path,
247 rte_cryptodev_name_get(env.dev_id));
249 RTE_LOG(ERR, USER1, "Error %i: Failed test %s\n",
255 ret = fips_test_one_file();
257 RTE_LOG(ERR, USER1, "Error %i: Failed test %s\n",
270 d_req = opendir(env.req_path);
272 RTE_LOG(ERR, USER1, "Error %i: Path %s not exist\n",
273 -EINVAL, env.req_path);
277 d_rsp = opendir(env.rsp_path);
279 ret = mkdir(env.rsp_path, 0700);
281 d_rsp = opendir(env.rsp_path);
283 RTE_LOG(ERR, USER1, "Error %i: Invalid %s\n",
284 -EINVAL, env.rsp_path);
290 while ((dir = readdir(d_req)) != NULL) {
291 if (strstr(dir->d_name, "req") == NULL)
294 snprintf(req_path, 1023, "%s/%s", env.req_path,
296 snprintf(rsp_path, 1023, "%s/%s", env.rsp_path,
298 strlcpy(strstr(rsp_path, "req"), "rsp", 4);
300 printf("Processing file %s... ", req_path);
302 ret = fips_test_init(req_path, rsp_path,
303 rte_cryptodev_name_get(env.dev_id));
305 RTE_LOG(ERR, USER1, "Error %i: Failed test %s\n",
310 ret = fips_test_one_file();
312 RTE_LOG(ERR, USER1, "Error %i: Failed test %s\n",
326 cryptodev_fips_validate_app_uninit();
332 #define IV_OFF (sizeof(struct rte_crypto_op) + sizeof(struct rte_crypto_sym_op))
333 #define CRYPTODEV_FIPS_MAX_RETRIES 16
335 typedef int (*fips_test_one_case_t)(void);
336 typedef int (*fips_prepare_op_t)(void);
337 typedef int (*fips_prepare_xform_t)(struct rte_crypto_sym_xform *);
339 struct fips_test_ops {
340 fips_prepare_xform_t prepare_xform;
341 fips_prepare_op_t prepare_op;
342 fips_test_one_case_t test;
346 prepare_cipher_op(void)
348 struct rte_crypto_sym_op *sym = env.op->sym;
349 uint8_t *iv = rte_crypto_op_ctod_offset(env.op, uint8_t *, IV_OFF);
351 __rte_crypto_op_reset(env.op, RTE_CRYPTO_OP_TYPE_SYMMETRIC);
352 rte_pktmbuf_reset(env.mbuf);
354 sym->m_src = env.mbuf;
355 sym->cipher.data.offset = 0;
357 memcpy(iv, vec.iv.val, vec.iv.len);
359 if (info.op == FIPS_TEST_ENC_AUTH_GEN) {
362 if (vec.pt.len > RTE_MBUF_MAX_NB_SEGS) {
363 RTE_LOG(ERR, USER1, "PT len %u\n", vec.pt.len);
367 pt = (uint8_t *)rte_pktmbuf_append(env.mbuf, vec.pt.len);
370 RTE_LOG(ERR, USER1, "Error %i: MBUF too small\n",
375 memcpy(pt, vec.pt.val, vec.pt.len);
376 sym->cipher.data.length = vec.pt.len;
381 if (vec.ct.len > RTE_MBUF_MAX_NB_SEGS) {
382 RTE_LOG(ERR, USER1, "CT len %u\n", vec.ct.len);
386 ct = (uint8_t *)rte_pktmbuf_append(env.mbuf, vec.ct.len);
389 RTE_LOG(ERR, USER1, "Error %i: MBUF too small\n",
394 memcpy(ct, vec.ct.val, vec.ct.len);
395 sym->cipher.data.length = vec.ct.len;
398 rte_crypto_op_attach_sym_session(env.op, env.sess);
404 prepare_auth_op(void)
406 struct rte_crypto_sym_op *sym = env.op->sym;
408 __rte_crypto_op_reset(env.op, RTE_CRYPTO_OP_TYPE_SYMMETRIC);
409 rte_pktmbuf_reset(env.mbuf);
411 sym->m_src = env.mbuf;
412 sym->auth.data.offset = 0;
414 if (info.op == FIPS_TEST_ENC_AUTH_GEN) {
417 if (vec.pt.len > RTE_MBUF_MAX_NB_SEGS) {
418 RTE_LOG(ERR, USER1, "PT len %u\n", vec.pt.len);
422 pt = (uint8_t *)rte_pktmbuf_append(env.mbuf, vec.pt.len +
423 vec.cipher_auth.digest.len);
426 RTE_LOG(ERR, USER1, "Error %i: MBUF too small\n",
431 memcpy(pt, vec.pt.val, vec.pt.len);
432 sym->auth.data.length = vec.pt.len;
433 sym->auth.digest.data = pt + vec.pt.len;
434 sym->auth.digest.phys_addr = rte_pktmbuf_mtophys_offset(
435 env.mbuf, vec.pt.len);
440 if (vec.ct.len > RTE_MBUF_MAX_NB_SEGS) {
441 RTE_LOG(ERR, USER1, "CT len %u\n", vec.ct.len);
445 ct = (uint8_t *)rte_pktmbuf_append(env.mbuf,
446 vec.ct.len + vec.cipher_auth.digest.len);
449 RTE_LOG(ERR, USER1, "Error %i: MBUF too small\n",
454 memcpy(ct, vec.ct.val, vec.ct.len);
455 sym->auth.data.length = vec.ct.len;
456 sym->auth.digest.data = vec.cipher_auth.digest.val;
457 sym->auth.digest.phys_addr = rte_malloc_virt2iova(
458 sym->auth.digest.data);
461 rte_crypto_op_attach_sym_session(env.op, env.sess);
465 prepare_aes_xform(struct rte_crypto_sym_xform *xform)
467 const struct rte_cryptodev_symmetric_capability *cap;
468 struct rte_cryptodev_sym_capability_idx cap_idx;
469 struct rte_crypto_cipher_xform *cipher_xform = &xform->cipher;
471 xform->type = RTE_CRYPTO_SYM_XFORM_CIPHER;
473 cipher_xform->algo = RTE_CRYPTO_CIPHER_AES_CBC;
474 cipher_xform->op = (info.op == FIPS_TEST_ENC_AUTH_GEN) ?
475 RTE_CRYPTO_CIPHER_OP_ENCRYPT :
476 RTE_CRYPTO_CIPHER_OP_DECRYPT;
477 cipher_xform->key.data = vec.cipher_auth.key.val;
478 cipher_xform->key.length = vec.cipher_auth.key.len;
479 cipher_xform->iv.length = vec.iv.len;
480 cipher_xform->iv.offset = IV_OFF;
482 cap_idx.algo.cipher = RTE_CRYPTO_CIPHER_AES_CBC;
483 cap_idx.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
485 cap = rte_cryptodev_sym_capability_get(env.dev_id, &cap_idx);
487 RTE_LOG(ERR, USER1, "Failed to get capability for cdev %u\n",
492 if (rte_cryptodev_sym_capability_check_cipher(cap,
493 cipher_xform->key.length,
494 cipher_xform->iv.length) != 0) {
495 RTE_LOG(ERR, USER1, "PMD %s key length %u IV length %u\n",
496 info.device_name, cipher_xform->key.length,
497 cipher_xform->iv.length);
505 prepare_hmac_xform(struct rte_crypto_sym_xform *xform)
507 const struct rte_cryptodev_symmetric_capability *cap;
508 struct rte_cryptodev_sym_capability_idx cap_idx;
509 struct rte_crypto_auth_xform *auth_xform = &xform->auth;
511 xform->type = RTE_CRYPTO_SYM_XFORM_AUTH;
513 auth_xform->algo = info.interim_info.hmac_data.algo;
514 auth_xform->op = RTE_CRYPTO_AUTH_OP_GENERATE;
515 auth_xform->digest_length = vec.cipher_auth.digest.len;
516 auth_xform->key.data = vec.cipher_auth.key.val;
517 auth_xform->key.length = vec.cipher_auth.key.len;
519 cap_idx.algo.auth = auth_xform->algo;
520 cap_idx.type = RTE_CRYPTO_SYM_XFORM_AUTH;
522 cap = rte_cryptodev_sym_capability_get(env.dev_id, &cap_idx);
524 RTE_LOG(ERR, USER1, "Failed to get capability for cdev %u\n",
529 if (rte_cryptodev_sym_capability_check_auth(cap,
530 auth_xform->key.length,
531 auth_xform->digest_length, 0) != 0) {
532 RTE_LOG(ERR, USER1, "PMD %s key length %u IV length %u\n",
533 info.device_name, auth_xform->key.length,
534 auth_xform->digest_length);
542 get_writeback_data(struct fips_val *val)
544 val->val = rte_pktmbuf_mtod(env.mbuf, uint8_t *);
545 val->len = rte_pktmbuf_pkt_len(env.mbuf);
551 struct rte_crypto_sym_xform xform = {0};
555 ret = test_ops.prepare_xform(&xform);
559 env.sess = rte_cryptodev_sym_session_create(env.mpool);
563 ret = rte_cryptodev_sym_session_init(env.dev_id,
564 env.sess, &xform, env.mpool);
566 RTE_LOG(ERR, USER1, "Error %i: Init session\n",
571 ret = test_ops.prepare_op();
573 RTE_LOG(ERR, USER1, "Error %i: Prepare op\n",
578 if (rte_cryptodev_enqueue_burst(env.dev_id, 0, &env.op, 1) < 1) {
579 RTE_LOG(ERR, USER1, "Error: Failed enqueue\n");
584 struct rte_crypto_op *deqd_op;
586 n_deqd = rte_cryptodev_dequeue_burst(env.dev_id, 0, &deqd_op,
588 } while (n_deqd == 0);
590 vec.status = env.op->status;
592 rte_cryptodev_sym_session_clear(env.dev_id, env.sess);
593 rte_cryptodev_sym_session_free(env.sess);
600 fips_generic_test(void)
605 fips_test_write_one_case();
607 ret = fips_run_test();
610 fprintf(info.fp_wr, "Bypass\n\n");
617 get_writeback_data(&val);
619 switch (info.file_type) {
622 if (info.parse_writeback == NULL)
624 ret = info.parse_writeback(&val);
629 if (info.kat_check == NULL)
631 ret = info.kat_check(&val);
637 fprintf(info.fp_wr, "\n");
643 fips_mct_aes_test(void)
645 #define AES_BLOCK_SIZE 16
646 #define AES_EXTERN_ITER 100
647 #define AES_INTERN_ITER 1000
648 struct fips_val val, val_key;
649 uint8_t prev_out[AES_BLOCK_SIZE] = {0};
650 uint8_t prev_in[AES_BLOCK_SIZE] = {0};
654 for (i = 0; i < AES_EXTERN_ITER; i++) {
658 fips_test_write_one_case();
660 for (j = 0; j < AES_INTERN_ITER; j++) {
661 ret = fips_run_test();
664 fprintf(info.fp_wr, "Bypass\n");
671 get_writeback_data(&val);
673 if (info.op == FIPS_TEST_DEC_AUTH_VERIF)
674 memcpy(prev_in, vec.ct.val, AES_BLOCK_SIZE);
677 memcpy(prev_out, val.val, AES_BLOCK_SIZE);
679 if (info.op == FIPS_TEST_ENC_AUTH_GEN) {
680 memcpy(vec.pt.val, vec.iv.val,
682 memcpy(vec.iv.val, val.val,
685 memcpy(vec.ct.val, vec.iv.val,
687 memcpy(vec.iv.val, prev_in,
693 if (info.op == FIPS_TEST_ENC_AUTH_GEN) {
694 memcpy(vec.iv.val, val.val, AES_BLOCK_SIZE);
695 memcpy(vec.pt.val, prev_out, AES_BLOCK_SIZE);
697 memcpy(vec.iv.val, prev_in, AES_BLOCK_SIZE);
698 memcpy(vec.ct.val, prev_out, AES_BLOCK_SIZE);
701 if (j == AES_INTERN_ITER - 1)
704 memcpy(prev_out, val.val, AES_BLOCK_SIZE);
707 info.parse_writeback(&val);
708 fprintf(info.fp_wr, "\n");
710 if (i == AES_EXTERN_ITER - 1)
714 memcpy(&val_key, &vec.cipher_auth.key, sizeof(val_key));
715 for (k = 0; k < vec.cipher_auth.key.len; k++) {
716 switch (vec.cipher_auth.key.len) {
718 val_key.val[k] ^= val.val[k];
722 val_key.val[k] ^= prev_out[k + 8];
724 val_key.val[k] ^= val.val[k - 8];
728 val_key.val[k] ^= prev_out[k];
730 val_key.val[k] ^= val.val[k - 16];
737 if (info.op == FIPS_TEST_DEC_AUTH_VERIF)
738 memcpy(vec.iv.val, val.val, AES_BLOCK_SIZE);
748 case FIPS_TEST_ALGO_AES:
749 test_ops.prepare_op = prepare_cipher_op;
750 test_ops.prepare_xform = prepare_aes_xform;
751 if (info.interim_info.aes_data.test_type == AESAVS_TYPE_MCT)
752 test_ops.test = fips_mct_aes_test;
754 test_ops.test = fips_generic_test;
756 case FIPS_TEST_ALGO_HMAC:
757 test_ops.prepare_op = prepare_auth_op;
758 test_ops.prepare_xform = prepare_hmac_xform;
759 test_ops.test = fips_generic_test;
770 print_test_block(void)
774 for (i = 0; i < info.nb_vec_lines; i++)
775 printf("%s\n", info.vec[i]);
781 fips_test_one_file(void)
783 int fetch_ret = 0, ret;
786 ret = init_test_ops();
788 RTE_LOG(ERR, USER1, "Error %i: Init test op\n", ret);
792 while (ret >= 0 && fetch_ret == 0) {
793 fetch_ret = fips_test_fetch_one_block();
795 RTE_LOG(ERR, USER1, "Error %i: Fetch block\n",
801 if (info.nb_vec_lines == 0) {
802 if (fetch_ret == -EOF)
805 fprintf(info.fp_wr, "\n");
809 ret = fips_test_parse_one_case();
812 ret = test_ops.test();
815 RTE_LOG(ERR, USER1, "Error %i: test block\n",
821 RTE_LOG(ERR, USER1, "Error %i: Parse block\n",