examples/fips_validation: add parsing for CMAC
[dpdk.git] / examples / fips_validation / fips_validation.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2018 Intel Corporation
3  */
4
5 #include <stdio.h>
6 #include <string.h>
7
8 #include <rte_string_fns.h>
9 #include <rte_cryptodev.h>
10 #include <rte_malloc.h>
11
12 #include "fips_validation.h"
13
14 #define skip_white_spaces(pos)                  \
15 ({                                              \
16         __typeof__(pos) _p = (pos);             \
17         for ( ; isspace(*_p); _p++)             \
18                 ;                               \
19         _p;                                     \
20 })
21
22 static int
23 get_file_line(void)
24 {
25         FILE *fp = info.fp_rd;
26         char *line = info.one_line_text;
27         int ret;
28         uint32_t loc = 0;
29
30         memset(line, 0, MAX_LINE_CHAR);
31         while ((ret = fgetc(fp)) != EOF) {
32                 char c = (char)ret;
33
34                 if (loc >= MAX_LINE_CHAR - 1)
35                         return -ENOMEM;
36                 if (c == '\n')
37                         break;
38                 line[loc++] = c;
39         }
40
41         if (ret == EOF)
42                 return -EOF;
43
44         return 0;
45 }
46
47 int
48 fips_test_fetch_one_block(void)
49 {
50         size_t size;
51         int ret = 0;
52         uint32_t i;
53
54         for (i = 0; i < info.nb_vec_lines; i++) {
55                 free(info.vec[i]);
56                 info.vec[i] = NULL;
57         }
58
59         i = 0;
60         do {
61                 if (i >= MAX_LINE_PER_VECTOR) {
62                         ret = -ENOMEM;
63                         goto error_exit;
64                 }
65
66                 ret = get_file_line();
67                 size = strlen(info.one_line_text);
68                 if (size == 0)
69                         break;
70
71                 info.vec[i] = calloc(1, size + 5);
72                 if (info.vec[i] == NULL)
73                         goto error_exit;
74
75                 strlcpy(info.vec[i], info.one_line_text, size + 1);
76                 i++;
77         } while (ret == 0);
78
79         info.nb_vec_lines = i;
80
81         return ret;
82
83 error_exit:
84         for (i = 0; i < MAX_LINE_PER_VECTOR; i++)
85                 if (info.vec[i] != NULL) {
86                         free(info.vec[i]);
87                         info.vec[i] = NULL;
88                 }
89
90         info.nb_vec_lines = 0;
91
92         return -ENOMEM;
93 }
94
95 static void
96 fips_test_parse_version(void)
97 {
98         int len = strlen(info.vec[0]);
99         char *ptr = info.vec[0];
100
101         info.version = strtof(ptr + len - 4, NULL);
102 }
103
104 static int
105 fips_test_parse_header(void)
106 {
107         uint32_t i;
108         char *tmp;
109         int ret;
110         int algo_parsed = 0;
111         time_t t = time(NULL);
112         struct tm *tm_now = localtime(&t);
113
114         ret = fips_test_fetch_one_block();
115         if (ret < 0)
116                 return ret;
117
118         if (info.nb_vec_lines)
119                 fips_test_parse_version();
120
121         for (i = 0; i < info.nb_vec_lines; i++) {
122                 if (!algo_parsed) {
123                         if (strstr(info.vec[i], "AESVS")) {
124                                 algo_parsed = 1;
125                                 info.algo = FIPS_TEST_ALGO_AES;
126                                 ret = parse_test_aes_init();
127                                 if (ret < 0)
128                                         return ret;
129                         } else if (strstr(info.vec[i], "GCM")) {
130                                 algo_parsed = 1;
131                                 info.algo = FIPS_TEST_ALGO_AES_GCM;
132                                 ret = parse_test_gcm_init();
133                                 if (ret < 0)
134                                         return ret;
135                         } else if (strstr(info.vec[i], "CMAC")) {
136                                 algo_parsed = 1;
137                                 info.algo = FIPS_TEST_ALGO_AES_CMAC;
138                                 ret = parse_test_cmac_init();
139                                 if (ret < 0)
140                                         return 0;
141                         } else if (strstr(info.vec[i], "CCM")) {
142                                 algo_parsed = 1;
143                                 info.algo = FIPS_TEST_ALGO_AES_CCM;
144                                 ret = parse_test_ccm_init();
145                                 if (ret < 0)
146                                         return 0;
147                         } else if (strstr(info.vec[i], "HMAC")) {
148                                 algo_parsed = 1;
149                                 info.algo = FIPS_TEST_ALGO_HMAC;
150                                 ret = parse_test_hmac_init();
151                                 if (ret < 0)
152                                         return ret;
153                         } else if (strstr(info.vec[i], "TDES")) {
154                                 algo_parsed = 1;
155                                 info.algo = FIPS_TEST_ALGO_TDES;
156                                 ret = parse_test_tdes_init();
157                                 if (ret < 0)
158                                         return 0;
159                         } else if (strstr(info.vec[i], "PERMUTATION")) {
160                                 algo_parsed = 1;
161                                 info.algo = FIPS_TEST_ALGO_TDES;
162                                 ret = parse_test_tdes_init();
163                                 if (ret < 0)
164                                         return 0;
165                         } else if (strstr(info.vec[i], "VARIABLE")) {
166                                 algo_parsed = 1;
167                                 info.algo = FIPS_TEST_ALGO_TDES;
168                                 ret = parse_test_tdes_init();
169                                 if (ret < 0)
170                                         return 0;
171                         } else if (strstr(info.vec[i], "SUBSTITUTION")) {
172                                 algo_parsed = 1;
173                                 info.algo = FIPS_TEST_ALGO_TDES;
174                                 ret = parse_test_tdes_init();
175                                 if (ret < 0)
176                                         return 0;
177                         } else if (strstr(info.vec[i], "SHA-")) {
178                                 algo_parsed = 1;
179                                 info.algo = FIPS_TEST_ALGO_SHA;
180                                 ret = parse_test_sha_init();
181                                 if (ret < 0)
182                                         return ret;
183                         } else if (strstr(info.vec[i], "XTS")) {
184                                 algo_parsed = 1;
185                                 info.algo = FIPS_TEST_ALGO_AES_XTS;
186                                 ret = parse_test_xts_init();
187                                 if (ret < 0)
188                                         return ret;
189                         }
190                 }
191
192                 tmp = strstr(info.vec[i], "# Config info for ");
193                 if (tmp != NULL) {
194                         fprintf(info.fp_wr, "%s%s\n", "# Config info for DPDK Cryptodev ",
195                                         info.device_name);
196                         continue;
197                 }
198
199                 tmp = strstr(info.vec[i], "#  HMAC information for ");
200                 if (tmp != NULL) {
201                         fprintf(info.fp_wr, "%s%s\n", "#  HMAC information for "
202                                 "DPDK Cryptodev ",
203                                 info.device_name);
204                         continue;
205                 }
206
207                 tmp = strstr(info.vec[i], "# Config Info for : ");
208                 if (tmp != NULL) {
209
210                         fprintf(info.fp_wr, "%s%s\n", "# Config Info for DPDK Cryptodev : ",
211                                         info.device_name);
212                         continue;
213                 }
214
215                 tmp = strstr(info.vec[i], "# information for ");
216                 if (tmp != NULL) {
217
218                         char tmp_output[128] = {0};
219
220                         strlcpy(tmp_output, info.vec[i], tmp - info.vec[i] + 1);
221
222                         fprintf(info.fp_wr, "%s%s%s\n", tmp_output,
223                                         "information for DPDK Cryptodev ",
224                                         info.device_name);
225                         continue;
226                 }
227
228                 tmp = strstr(info.vec[i], " test information for ");
229                 if (tmp != NULL) {
230                         char tmp_output[128] = {0};
231
232                         strlcpy(tmp_output, info.vec[i], tmp - info.vec[i] + 1);
233
234                         fprintf(info.fp_wr, "%s%s%s\n", tmp_output,
235                                         "test information for DPDK Cryptodev ",
236                                         info.device_name);
237                         continue;
238                 }
239
240                 tmp = strstr(info.vec[i], "\" information for \"");
241                 if (tmp != NULL) {
242                         char tmp_output[128] = {0};
243
244                         strlcpy(tmp_output, info.vec[i], tmp - info.vec[i] + 1);
245
246                         fprintf(info.fp_wr, "%s%s%s\n", tmp_output,
247                                         "\" information for DPDK Cryptodev ",
248                                         info.device_name);
249                         continue;
250                 }
251
252                 if (i == info.nb_vec_lines - 1) {
253                         /** update the time as current time, write to file */
254                         fprintf(info.fp_wr, "%s%s\n", "# Generated on ",
255                                         asctime(tm_now));
256                         continue;
257                 }
258
259                 /* to this point, no field need to update,
260                  *  only copy to rsp file
261                  */
262                 fprintf(info.fp_wr, "%s\n", info.vec[i]);
263         }
264
265         return 0;
266 }
267
268 static int
269 parse_file_type(const char *path)
270 {
271         const char *tmp = path + strlen(path) - 3;
272
273         if (strstr(tmp, REQ_FILE_PREFIX))
274                 info.file_type = FIPS_TYPE_REQ;
275         else if (strstr(tmp, RSP_FILE_PREFIX))
276                 info.file_type = FIPS_TYPE_RSP;
277         else if (strstr(path, FAX_FILE_PREFIX))
278                 info.file_type = FIPS_TYPE_FAX;
279         else if (strstr(path, JSON_FILE_PREFIX))
280                 info.file_type = FIPS_TYPE_JSON;
281         else
282                 return -EINVAL;
283
284         return 0;
285 }
286
287 int
288 fips_test_init(const char *req_file_path, const char *rsp_file_path,
289                 const char *device_name)
290 {
291         if (strcmp(req_file_path, rsp_file_path) == 0) {
292                 RTE_LOG(ERR, USER1, "File paths cannot be the same\n");
293                 return -EINVAL;
294         }
295
296         fips_test_clear();
297
298         if (rte_strscpy(info.file_name, req_file_path,
299                                 sizeof(info.file_name)) < 0) {
300                 RTE_LOG(ERR, USER1, "Path %s too long\n", req_file_path);
301                 return -EINVAL;
302         }
303         info.algo = FIPS_TEST_ALGO_MAX;
304         if (parse_file_type(req_file_path) < 0) {
305                 RTE_LOG(ERR, USER1, "File %s type not supported\n",
306                                 req_file_path);
307                 return -EINVAL;
308         }
309
310         info.fp_rd = fopen(req_file_path, "r");
311         if (!info.fp_rd) {
312                 RTE_LOG(ERR, USER1, "Cannot open file %s\n", req_file_path);
313                 return -EINVAL;
314         }
315
316         if (info.file_type == FIPS_TYPE_JSON) {
317 #ifdef RTE_HAS_JANSSON
318                 json_error_t error;
319                 json_info.json_root = json_loadf(info.fp_rd, 0, &error);
320                 if (!json_info.json_root) {
321                         RTE_LOG(ERR, USER1, "Cannot parse json file %s (line %d, column %d)\n",
322                                 req_file_path, error.line, error.column);
323                         return -EINVAL;
324                 }
325 #else /* RTE_HAS_JANSSON */
326                 RTE_LOG(ERR, USER1, "No json library configured.\n");
327                 return -EINVAL;
328 #endif /* RTE_HAS_JANSSON */
329         }
330
331         info.fp_wr = fopen(rsp_file_path, "w");
332         if (!info.fp_wr) {
333                 RTE_LOG(ERR, USER1, "Cannot open file %s\n", rsp_file_path);
334                 return -EINVAL;
335         }
336
337         info.one_line_text = calloc(1, MAX_LINE_CHAR);
338         if (!info.one_line_text) {
339                 RTE_LOG(ERR, USER1, "Insufficient memory\n");
340                 return -ENOMEM;
341         }
342
343         if (rte_strscpy(info.device_name, device_name,
344                                 sizeof(info.device_name)) < 0) {
345                 RTE_LOG(ERR, USER1, "Device name %s too long\n", device_name);
346                 return -EINVAL;
347         }
348
349         if (info.file_type == FIPS_TYPE_JSON)
350                 return 0;
351
352         if (fips_test_parse_header() < 0) {
353                 RTE_LOG(ERR, USER1, "Failed parsing header\n");
354                 return -1;
355         }
356
357         return 0;
358 }
359
360 void
361 fips_test_clear(void)
362 {
363         if (info.fp_rd)
364                 fclose(info.fp_rd);
365         if (info.fp_wr)
366                 fclose(info.fp_wr);
367         free(info.one_line_text);
368         if (info.nb_vec_lines) {
369                 uint32_t i;
370
371                 for (i = 0; i < info.nb_vec_lines; i++)
372                         free(info.vec[i]);
373         }
374
375         memset(&info, 0, sizeof(info));
376 }
377
378 int
379 fips_test_parse_one_case(void)
380 {
381         uint32_t i, j = 0;
382         uint32_t is_interim;
383         uint32_t interim_cnt = 0;
384         int ret;
385
386         info.vec_start_off = 0;
387
388         if (info.interim_callbacks) {
389                 for (i = 0; i < info.nb_vec_lines; i++) {
390                         is_interim = 0;
391                         for (j = 0; info.interim_callbacks[j].key != NULL; j++)
392                                 if (strstr(info.vec[i],
393                                         info.interim_callbacks[j].key)) {
394                                         is_interim = 1;
395
396                                         ret = info.interim_callbacks[j].cb(
397                                                 info.interim_callbacks[j].key,
398                                                 info.vec[i],
399                                                 info.interim_callbacks[j].val);
400                                         if (ret < 0)
401                                                 return ret;
402                                 }
403
404                         if (is_interim)
405                                 interim_cnt += 1;
406                 }
407         }
408
409         if (interim_cnt) {
410                 if (info.version == 21.4f) {
411                         for (i = 0; i < interim_cnt; i++)
412                                 fprintf(info.fp_wr, "%s\n", info.vec[i]);
413                         fprintf(info.fp_wr, "\n");
414
415                         if (info.nb_vec_lines == interim_cnt)
416                                 return 1;
417                 } else {
418                         for (i = 0; i < info.nb_vec_lines; i++)
419                                 fprintf(info.fp_wr, "%s\n", info.vec[i]);
420                         fprintf(info.fp_wr, "\n");
421                         return 1;
422                 }
423         }
424
425         info.vec_start_off = interim_cnt;
426
427         for (i = info.vec_start_off; i < info.nb_vec_lines; i++) {
428                 for (j = 0; info.callbacks[j].key != NULL; j++)
429                         if (strstr(info.vec[i], info.callbacks[j].key)) {
430                                 ret = info.callbacks[j].cb(
431                                         info.callbacks[j].key,
432                                         info.vec[i], info.callbacks[j].val);
433                                 if (ret < 0)
434                                         return ret;
435                                 break;
436                         }
437         }
438
439         return 0;
440 }
441
442 void
443 fips_test_write_one_case(void)
444 {
445         uint32_t i;
446
447         for (i = info.vec_start_off; i < info.nb_vec_lines; i++)
448                 fprintf(info.fp_wr, "%s\n", info.vec[i]);
449 }
450
451 #ifdef RTE_HAS_JANSSON
452 int
453 fips_test_parse_one_json_vector_set(void)
454 {
455         json_t *algo_obj = json_object_get(json_info.json_vector_set, "algorithm");
456         const char *algo_str = json_string_value(algo_obj);
457
458         /* Vector sets contain the algorithm type, and nothing else we need. */
459         if (strstr(algo_str, "AES-GCM"))
460                 info.algo = FIPS_TEST_ALGO_AES_GCM;
461         if (strstr(algo_str, "HMAC"))
462                 info.algo = FIPS_TEST_ALGO_HMAC;
463         if (strstr(algo_str, "CMAC"))
464                 info.algo = FIPS_TEST_ALGO_AES_CMAC;
465         else
466                 return -EINVAL;
467
468         return 0;
469 }
470
471 int
472 fips_test_parse_one_json_group(void)
473 {
474         int ret, i;
475         json_t *param;
476
477         if (info.interim_callbacks) {
478                 char json_value[256];
479                 for (i = 0; info.interim_callbacks[i].key != NULL; i++) {
480                         param = json_object_get(json_info.json_test_group,
481                                         info.interim_callbacks[i].key);
482                         switch (json_typeof(param)) {
483                         case JSON_STRING:
484                                 snprintf(json_value, 256, "%s", json_string_value(param));
485                                 break;
486
487                         case JSON_INTEGER:
488                                 snprintf(json_value, 255, "%"JSON_INTEGER_FORMAT,
489                                                 json_integer_value(param));
490                                 break;
491
492                         default:
493                                 return -EINVAL;
494                         }
495
496                         /* First argument is blank because the key
497                          * is not included in the string being parsed.
498                          */
499                         ret = info.interim_callbacks[i].cb(
500                                 "", json_value,
501                                 info.interim_callbacks[i].val
502                         );
503                         if (ret < 0)
504                                 return ret;
505                 }
506         }
507
508         return 0;
509 }
510
511 int
512 fips_test_parse_one_json_case(void)
513 {
514         uint32_t i;
515         int ret = 0;
516         json_t *param;
517
518         for (i = 0; info.callbacks[i].key != NULL; i++) {
519                 param = json_object_get(json_info.json_test_case, info.callbacks[i].key);
520                 if (param) {
521                         strcpy(info.one_line_text, json_string_value(param));
522                         /* First argument is blank because the key
523                          * is not included in the string being parsed.
524                          */
525                         ret = info.callbacks[i].cb(
526                                 "", info.one_line_text,
527                                 info.callbacks[i].val
528                         );
529                         if (ret < 0)
530                                 return ret;
531                 }
532         }
533
534         return 0;
535 }
536 #endif /* RTE_HAS_JANSSON */
537
538 static int
539 parser_read_uint64_hex(uint64_t *value, const char *p)
540 {
541         char *next;
542         uint64_t val;
543
544         p = skip_white_spaces(p);
545
546         val = strtoul(p, &next, 16);
547         if (p == next)
548                 return -EINVAL;
549
550         p = skip_white_spaces(next);
551         if (*p != '\0')
552                 return -EINVAL;
553
554         *value = val;
555         return 0;
556 }
557
558 int
559 parser_read_uint8_hex(uint8_t *value, const char *p)
560 {
561         uint64_t val = 0;
562         int ret = parser_read_uint64_hex(&val, p);
563
564         if (ret < 0)
565                 return ret;
566
567         if (val > UINT8_MAX)
568                 return -ERANGE;
569
570         *value = val;
571         return 0;
572 }
573
574 int
575 parse_uint8_known_len_hex_str(const char *key, char *src, struct fips_val *val)
576 {
577         struct fips_val tmp_val = {0};
578         uint32_t len = val->len;
579         int ret;
580
581         if (len == 0) {
582                 if (val->val != NULL) {
583                         rte_free(val->val);
584                         val->val = NULL;
585                 }
586
587                 return 0;
588         }
589
590         ret = parse_uint8_hex_str(key, src, &tmp_val);
591         if (ret < 0)
592                 return ret;
593
594         if (tmp_val.len == val->len) {
595                 val->val = tmp_val.val;
596                 return 0;
597         }
598
599         if (tmp_val.len < val->len) {
600                 rte_free(tmp_val.val);
601                 return -EINVAL;
602         }
603
604         val->val = rte_zmalloc(NULL, val->len, 0);
605         if (!val->val) {
606                 rte_free(tmp_val.val);
607                 memset(val, 0, sizeof(*val));
608                 return -ENOMEM;
609         }
610
611         memcpy(val->val, tmp_val.val, val->len);
612         rte_free(tmp_val.val);
613
614         return 0;
615 }
616
617 int
618 parse_uint8_hex_str(const char *key, char *src, struct fips_val *val)
619 {
620         uint32_t len, j;
621
622         src += strlen(key);
623
624         len = strlen(src) / 2;
625
626         if (val->val) {
627                 rte_free(val->val);
628                 val->val = NULL;
629         }
630
631         val->val = rte_zmalloc(NULL, len, 0);
632         if (!val->val)
633                 return -ENOMEM;
634
635         for (j = 0; j < len; j++) {
636                 char byte[3] = {src[j * 2], src[j * 2 + 1], '\0'};
637
638                 if (parser_read_uint8_hex(&val->val[j], byte) < 0) {
639                         rte_free(val->val);
640                         memset(val, 0, sizeof(*val));
641                         return -EINVAL;
642                 }
643         }
644
645         val->len = len;
646
647         return 0;
648 }
649
650 int
651 parser_read_uint32_val(const char *key, char *src, struct fips_val *val)
652 {
653         char *data = src + strlen(key);
654         size_t data_len = strlen(data);
655         int ret;
656
657         if (data[data_len - 1] == ']') {
658                 char *tmp_data = calloc(1, data_len + 1);
659
660                 if (tmp_data == NULL)
661                         return -ENOMEM;
662
663                 strlcpy(tmp_data, data, data_len);
664
665                 ret = parser_read_uint32(&val->len, tmp_data);
666
667                 free(tmp_data);
668         } else
669                 ret = parser_read_uint32(&val->len, data);
670
671         return ret;
672 }
673
674 int
675 parser_read_uint32_bit_val(const char *key, char *src, struct fips_val *val)
676 {
677         int ret;
678
679         ret = parser_read_uint32_val(key, src, val);
680
681         if (ret < 0)
682                 return ret;
683
684         val->len /= 8;
685
686         return 0;
687 }
688
689 int
690 writeback_hex_str(const char *key, char *dst, struct fips_val *val)
691 {
692         char *str = dst;
693         uint32_t len;
694
695         str += strlen(key);
696
697         for (len = 0; len < val->len; len++)
698                 snprintf(str + len * 2, 255, "%02x", val->val[len]);
699
700         return 0;
701 }
702
703 static int
704 parser_read_uint64(uint64_t *value, const char *p)
705 {
706         char *next;
707         uint64_t val;
708
709         p = skip_white_spaces(p);
710         if (!isdigit(*p))
711                 return -EINVAL;
712
713         val = strtoul(p, &next, 10);
714         if (p == next)
715                 return -EINVAL;
716
717         p = next;
718         switch (*p) {
719         case 'T':
720                 val *= 1024ULL;
721                 /* fall through */
722         case 'G':
723                 val *= 1024ULL;
724                 /* fall through */
725         case 'M':
726                 val *= 1024ULL;
727                 /* fall through */
728         case 'k':
729         case 'K':
730                 val *= 1024ULL;
731                 p++;
732                 break;
733         }
734
735         p = skip_white_spaces(p);
736         if (*p != '\0')
737                 return -EINVAL;
738
739         *value = val;
740         return 0;
741 }
742
743 int
744 parser_read_uint32(uint32_t *value, char *p)
745 {
746         uint64_t val = 0;
747         int ret = parser_read_uint64(&val, p);
748
749         if (ret < 0)
750                 return ret;
751
752         if (val > UINT32_MAX)
753                 return -EINVAL;
754
755         *value = val;
756         return 0;
757 }
758
759 int
760 parser_read_uint16(uint16_t *value, const char *p)
761 {
762         uint64_t val = 0;
763         int ret = parser_read_uint64(&val, p);
764
765         if (ret < 0)
766                 return ret;
767
768         if (val > UINT16_MAX)
769                 return -ERANGE;
770
771         *value = val;
772         return 0;
773 }
774
775 void
776 parse_write_hex_str(struct fips_val *src)
777 {
778         writeback_hex_str("", info.one_line_text, src);
779
780         fprintf(info.fp_wr, "%s\n", info.one_line_text);
781 }
782
783 int
784 update_info_vec(uint32_t count)
785 {
786         const struct fips_test_callback *cb;
787         uint32_t i, j;
788
789         if (!info.writeback_callbacks)
790                 return -1;
791
792         cb = &info.writeback_callbacks[0];
793
794         if ((info.version == 21.4f) && (!(strstr(info.vec[0], cb->key)))) {
795                 fprintf(info.fp_wr, "%s%u\n", cb->key, count);
796                 i = 0;
797         } else {
798                 snprintf(info.vec[0], strlen(info.vec[0]) + 4, "%s%u", cb->key,
799                                 count);
800                 i = 1;
801         }
802
803         for (; i < info.nb_vec_lines; i++) {
804                 for (j = 1; info.writeback_callbacks[j].key != NULL; j++) {
805                         cb = &info.writeback_callbacks[j];
806                         if (strstr(info.vec[i], cb->key)) {
807                                 cb->cb(cb->key, info.vec[i], cb->val);
808                                 break;
809                         }
810                 }
811         }
812
813         return 0;
814 }