1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2018 Intel Corporation 3 */ 4 5 #ifndef _FIPS_VALIDATION_H_ 6 #define _FIPS_VALIDATION_H_ 7 8 #ifdef USE_JANSSON 9 #include <jansson.h> 10 #endif /* USE_JANSSON */ 11 12 #define FIPS_PARSE_ERR(fmt, args) \ 13 RTE_LOG(ERR, USER1, "FIPS parse error" ## fmt ## "\n", ## args) 14 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) - \ 20 RTE_PKTMBUF_HEADROOM) 21 #define MAX_STRING_SIZE 64 22 #define MAX_FILE_NAME_SIZE 256 23 #define MAX_DIGEST_SIZE 64 24 25 #define POSITIVE_TEST 0 26 #define NEGATIVE_TEST -1 27 28 #define REQ_FILE_PREFIX "req" 29 #define RSP_FILE_PREFIX "rsp" 30 #define FAX_FILE_PREFIX "fax" 31 #define JSON_FILE_PREFIX "json" 32 33 #define ACVVERSION "1.0" 34 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, 42 FIPS_TEST_ALGO_HMAC, 43 FIPS_TEST_ALGO_TDES, 44 FIPS_TEST_ALGO_SHA, 45 FIPS_TEST_ALGO_MAX 46 }; 47 48 enum file_types { 49 FIPS_TYPE_REQ = 1, 50 FIPS_TYPE_FAX, 51 FIPS_TYPE_RSP, 52 FIPS_TYPE_JSON, 53 }; 54 55 enum fips_test_op { 56 FIPS_TEST_ENC_AUTH_GEN = 1, 57 FIPS_TEST_DEC_AUTH_VERIF, 58 }; 59 60 #define MAX_LINE_PER_VECTOR 16 61 62 struct fips_val { 63 uint8_t *val; 64 uint32_t len; 65 }; 66 67 struct fips_test_vector { 68 union { 69 struct { 70 struct fips_val key; 71 struct fips_val digest; 72 struct fips_val auth_aad; 73 struct fips_val aad; 74 } cipher_auth; 75 struct { 76 struct fips_val key; 77 struct fips_val digest; 78 struct fips_val aad; 79 } aead; 80 }; 81 82 struct fips_val pt; 83 struct fips_val ct; 84 struct fips_val iv; 85 86 enum rte_crypto_op_status status; 87 }; 88 89 typedef int (*post_prcess_t)(struct fips_val *val); 90 91 typedef int (*parse_callback_t)(const char *key, char *text, 92 struct fips_val *val); 93 94 struct fips_test_callback { 95 const char *key; 96 parse_callback_t cb; 97 struct fips_val *val; 98 }; 99 100 enum fips_aesavs_test_types { 101 AESAVS_TYPE_GFXBOX = 1, 102 AESAVS_TYPE_KEYSBOX, 103 AESAVS_TYPE_VARKEY, 104 AESAVS_TYPE_VARTXT, 105 AESAVS_TYPE_MMT, 106 AESAVS_TYPE_MCT, 107 AESAVS_TYPE_AFT, 108 }; 109 110 enum fips_tdes_test_types { 111 TDES_INVERSE_PERMUTATION = 0, 112 TDES_PERMUTATION, 113 TDES_SUBSTITUTION_TABLE, 114 TDES_VARIABLE_KEY, 115 TDES_VARIABLE_TEXT, 116 TDES_KAT, 117 TDES_MCT, /* Monte Carlo (Modes) Test */ 118 TDES_MMT /* Multi block Message Test */ 119 }; 120 121 enum fips_tdes_test_mode { 122 TDES_MODE_CBC = 0, 123 TDES_MODE_ECB 124 }; 125 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 */ 132 }; 133 134 enum fips_sha_test_types { 135 SHA_KAT = 0, 136 SHA_AFT, 137 SHA_MCT 138 }; 139 140 struct aesavs_interim_data { 141 enum fips_aesavs_test_types test_type; 142 uint32_t cipher_algo; 143 uint32_t key_len; 144 }; 145 146 struct hmac_interim_data { 147 enum rte_crypto_auth_algorithm algo; 148 }; 149 150 struct tdes_interim_data { 151 enum fips_tdes_test_types test_type; 152 enum fips_tdes_test_mode test_mode; 153 uint32_t nb_keys; 154 }; 155 156 struct ccm_interim_data { 157 enum fips_ccm_test_types test_type; 158 uint32_t aad_len; 159 uint32_t pt_len; 160 uint32_t digest_len; 161 uint32_t key_len; 162 uint32_t iv_len; 163 }; 164 165 struct sha_interim_data { 166 enum fips_sha_test_types test_type; 167 enum rte_crypto_auth_algorithm algo; 168 }; 169 170 struct gcm_interim_data { 171 uint8_t is_gmac; 172 uint8_t gen_iv; 173 }; 174 175 enum xts_tweak_modes { 176 XTS_TWEAK_MODE_HEX = 0, 177 XTS_TWEAK_MODE_NUMBER 178 }; 179 180 struct xts_interim_data { 181 enum xts_tweak_modes tweak_mode; 182 }; 183 184 #ifdef USE_JANSSON 185 struct fips_test_json_info { 186 /* Information used for reading from json */ 187 json_t *json_root; 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; 196 /* Other info */ 197 uint8_t is_sample; 198 }; 199 #endif /* USE_JANSSON */ 200 201 struct fips_test_interim_info { 202 FILE *fp_rd; 203 FILE *fp_wr; 204 enum file_types file_type; 205 enum fips_test_algorithms algo; 206 char *one_line_text; 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]; 212 float version; 213 214 union { 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; 222 } interim_info; 223 224 enum fips_test_op op; 225 226 const struct fips_test_callback *callbacks; 227 const struct fips_test_callback *interim_callbacks; 228 const struct fips_test_callback *writeback_callbacks; 229 230 post_prcess_t parse_writeback; 231 post_prcess_t kat_check; 232 }; 233 234 extern struct fips_test_vector vec; 235 extern struct fips_test_interim_info info; 236 237 #ifdef USE_JANSSON 238 extern struct fips_test_json_info json_info; 239 #endif /* USE_JANSSON */ 240 241 int 242 fips_test_init(const char *req_file_path, const char *rsp_file_path, 243 const char *device_name); 244 245 void 246 fips_test_clear(void); 247 248 int 249 fips_test_fetch_one_block(void); 250 251 int 252 fips_test_parse_one_case(void); 253 254 void 255 fips_test_write_one_case(void); 256 257 #ifdef USE_JANSSON 258 int 259 fips_test_parse_one_json_vector_set(void); 260 261 int 262 fips_test_parse_one_json_group(void); 263 264 int 265 fips_test_parse_one_json_case(void); 266 267 int 268 parse_test_gcm_json_init(void); 269 270 int 271 parse_test_hmac_json_init(void); 272 273 int 274 parse_test_hmac_json_algorithm(void); 275 276 int 277 parse_test_cmac_json_init(void); 278 279 int 280 parse_test_aes_json_init(void); 281 282 int 283 parse_test_xts_json_init(void); 284 285 int 286 parse_test_sha_json_init(void); 287 288 int 289 parse_test_sha_json_algorithm(void); 290 291 int 292 parse_test_sha_json_test_type(void); 293 #endif /* USE_JANSSON */ 294 295 int 296 parse_test_aes_init(void); 297 298 int 299 parse_test_tdes_init(void); 300 301 int 302 parse_test_hmac_init(void); 303 304 int 305 parse_test_gcm_init(void); 306 307 int 308 parse_test_cmac_init(void); 309 310 int 311 parse_test_ccm_init(void); 312 313 int 314 parse_test_sha_init(void); 315 316 int 317 parse_test_xts_init(void); 318 319 int 320 parser_read_uint8_hex(uint8_t *value, const char *p); 321 322 int 323 parse_uint8_hex_str(const char *key, char *src, struct fips_val *val); 324 325 int 326 parse_uint8_known_len_hex_str(const char *key, char *src, struct fips_val *val); 327 328 int 329 parser_read_uint16(uint16_t *value, const char *p); 330 331 int 332 parser_read_uint32_val(const char *key, char *src, struct fips_val *val); 333 334 int 335 parser_read_uint32_bit_val(const char *key, char *src, struct fips_val *val); 336 337 int 338 parser_read_uint32(uint32_t *value, char *p); 339 340 int 341 parser_read_uint32_val(const char *key, char *src, struct fips_val *val); 342 343 int 344 writeback_hex_str(const char *key, char *dst, struct fips_val *val); 345 346 void 347 parse_write_hex_str(struct fips_val *src); 348 349 int 350 update_info_vec(uint32_t count); 351 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 *); 355 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; 360 }; 361 362 extern struct fips_test_ops test_ops; 363 364 int prepare_aead_op(void); 365 366 int prepare_auth_op(void); 367 368 int prepare_gcm_xform(struct rte_crypto_sym_xform *xform); 369 370 int prepare_gmac_xform(struct rte_crypto_sym_xform *xform); 371 372 #endif 373