1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Intel Corporation
5 #ifndef _FIPS_VALIDATION_H_
6 #define _FIPS_VALIDATION_H_
10 #endif /* USE_JANSSON */
12 #define FIPS_PARSE_ERR(fmt, args) \
13 RTE_LOG(ERR, USER1, "FIPS parse error" ## fmt ## "\n", ## args)
15 #define ERR_MSG_SIZE 128
16 #define MAX_CASE_LINE 15
17 #define MAX_LINE_CHAR 204800 /*< max number of characters per line */
18 #define MAX_NB_TESTS 10240
19 #define DEF_MBUF_SEG_SIZE (UINT16_MAX - sizeof(struct rte_mbuf) - \
21 #define MAX_STRING_SIZE 64
22 #define MAX_FILE_NAME_SIZE 256
23 #define MAX_DIGEST_SIZE 64
25 #define POSITIVE_TEST 0
26 #define NEGATIVE_TEST -1
28 #define REQ_FILE_PREFIX "req"
29 #define RSP_FILE_PREFIX "rsp"
30 #define FAX_FILE_PREFIX "fax"
31 #define JSON_FILE_PREFIX "json"
33 #define ACVVERSION "1.0"
35 enum fips_test_algorithms {
36 FIPS_TEST_ALGO_AES = 0,
37 FIPS_TEST_ALGO_AES_CBC,
38 FIPS_TEST_ALGO_AES_GCM,
39 FIPS_TEST_ALGO_AES_CMAC,
40 FIPS_TEST_ALGO_AES_CCM,
41 FIPS_TEST_ALGO_AES_XTS,
56 FIPS_TEST_ENC_AUTH_GEN = 1,
57 FIPS_TEST_DEC_AUTH_VERIF,
60 #define MAX_LINE_PER_VECTOR 16
67 struct fips_test_vector {
71 struct fips_val digest;
72 struct fips_val auth_aad;
77 struct fips_val digest;
86 enum rte_crypto_op_status status;
89 typedef int (*post_prcess_t)(struct fips_val *val);
91 typedef int (*parse_callback_t)(const char *key, char *text,
92 struct fips_val *val);
94 struct fips_test_callback {
100 enum fips_aesavs_test_types {
101 AESAVS_TYPE_GFXBOX = 1,
110 enum fips_tdes_test_types {
111 TDES_INVERSE_PERMUTATION = 0,
113 TDES_SUBSTITUTION_TABLE,
117 TDES_MCT, /* Monte Carlo (Modes) Test */
118 TDES_MMT /* Multi block Message Test */
121 enum fips_tdes_test_mode {
126 enum fips_ccm_test_types {
127 CCM_VADT = 1, /* Variable Associated Data Test */
128 CCM_VPT, /* Variable Payload Test */
129 CCM_VNT, /* Variable Nonce Test */
130 CCM_VTT, /* Variable Tag Test */
131 CCM_DVPT, /* Decryption-Verification Process Test */
134 enum fips_sha_test_types {
140 struct aesavs_interim_data {
141 enum fips_aesavs_test_types test_type;
142 uint32_t cipher_algo;
146 struct hmac_interim_data {
147 enum rte_crypto_auth_algorithm algo;
150 struct tdes_interim_data {
151 enum fips_tdes_test_types test_type;
152 enum fips_tdes_test_mode test_mode;
156 struct ccm_interim_data {
157 enum fips_ccm_test_types test_type;
165 struct sha_interim_data {
166 enum fips_sha_test_types test_type;
167 enum rte_crypto_auth_algorithm algo;
170 struct gcm_interim_data {
175 enum xts_tweak_modes {
176 XTS_TWEAK_MODE_HEX = 0,
177 XTS_TWEAK_MODE_NUMBER
180 struct xts_interim_data {
181 enum xts_tweak_modes tweak_mode;
185 struct fips_test_json_info {
186 /* Information used for reading from json */
188 json_t *json_vector_set;
189 json_t *json_test_group;
190 json_t *json_test_case;
191 /* Location of json write output */
192 json_t *json_write_root;
193 json_t *json_write_group;
194 json_t *json_write_set;
195 json_t *json_write_case;
199 #endif /* USE_JANSSON */
201 struct fips_test_interim_info {
204 enum file_types file_type;
205 enum fips_test_algorithms algo;
207 char *vec[MAX_LINE_PER_VECTOR];
208 uint32_t vec_start_off;
209 uint32_t nb_vec_lines;
210 char device_name[MAX_STRING_SIZE];
211 char file_name[MAX_FILE_NAME_SIZE];
215 struct aesavs_interim_data aes_data;
216 struct hmac_interim_data hmac_data;
217 struct tdes_interim_data tdes_data;
218 struct ccm_interim_data ccm_data;
219 struct sha_interim_data sha_data;
220 struct gcm_interim_data gcm_data;
221 struct xts_interim_data xts_data;
224 enum fips_test_op op;
226 const struct fips_test_callback *callbacks;
227 const struct fips_test_callback *interim_callbacks;
228 const struct fips_test_callback *writeback_callbacks;
230 post_prcess_t parse_writeback;
231 post_prcess_t kat_check;
234 extern struct fips_test_vector vec;
235 extern struct fips_test_interim_info info;
238 extern struct fips_test_json_info json_info;
239 #endif /* USE_JANSSON */
242 fips_test_init(const char *req_file_path, const char *rsp_file_path,
243 const char *device_name);
246 fips_test_clear(void);
249 fips_test_fetch_one_block(void);
252 fips_test_parse_one_case(void);
255 fips_test_write_one_case(void);
259 fips_test_parse_one_json_vector_set(void);
262 fips_test_parse_one_json_group(void);
265 fips_test_parse_one_json_case(void);
268 parse_test_gcm_json_init(void);
271 parse_test_hmac_json_init(void);
274 parse_test_hmac_json_algorithm(void);
277 parse_test_cmac_json_init(void);
280 parse_test_aes_json_init(void);
283 parse_test_xts_json_init(void);
286 parse_test_sha_json_init(void);
289 parse_test_sha_json_algorithm(void);
292 parse_test_sha_json_test_type(void);
293 #endif /* USE_JANSSON */
296 parse_test_aes_init(void);
299 parse_test_tdes_init(void);
302 parse_test_hmac_init(void);
305 parse_test_gcm_init(void);
308 parse_test_cmac_init(void);
311 parse_test_ccm_init(void);
314 parse_test_sha_init(void);
317 parse_test_xts_init(void);
320 parser_read_uint8_hex(uint8_t *value, const char *p);
323 parse_uint8_hex_str(const char *key, char *src, struct fips_val *val);
326 parse_uint8_known_len_hex_str(const char *key, char *src, struct fips_val *val);
329 parser_read_uint16(uint16_t *value, const char *p);
332 parser_read_uint32_val(const char *key, char *src, struct fips_val *val);
335 parser_read_uint32_bit_val(const char *key, char *src, struct fips_val *val);
338 parser_read_uint32(uint32_t *value, char *p);
341 parser_read_uint32_val(const char *key, char *src, struct fips_val *val);
344 writeback_hex_str(const char *key, char *dst, struct fips_val *val);
347 parse_write_hex_str(struct fips_val *src);
350 update_info_vec(uint32_t count);
352 typedef int (*fips_test_one_case_t)(void);
353 typedef int (*fips_prepare_op_t)(void);
354 typedef int (*fips_prepare_xform_t)(struct rte_crypto_sym_xform *);
356 struct fips_test_ops {
357 fips_prepare_xform_t prepare_xform;
358 fips_prepare_op_t prepare_op;
359 fips_test_one_case_t test;
362 extern struct fips_test_ops test_ops;
364 int prepare_aead_op(void);
366 int prepare_auth_op(void);
368 int prepare_gcm_xform(struct rte_crypto_sym_xform *xform);
370 int prepare_gmac_xform(struct rte_crypto_sym_xform *xform);