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_MCT 137 }; 138 139 struct aesavs_interim_data { 140 enum fips_aesavs_test_types test_type; 141 uint32_t cipher_algo; 142 uint32_t key_len; 143 }; 144 145 struct hmac_interim_data { 146 enum rte_crypto_auth_algorithm algo; 147 }; 148 149 struct tdes_interim_data { 150 enum fips_tdes_test_types test_type; 151 enum fips_tdes_test_mode test_mode; 152 uint32_t nb_keys; 153 }; 154 155 struct ccm_interim_data { 156 enum fips_ccm_test_types test_type; 157 uint32_t aad_len; 158 uint32_t pt_len; 159 uint32_t digest_len; 160 uint32_t key_len; 161 uint32_t iv_len; 162 }; 163 164 struct sha_interim_data { 165 enum fips_sha_test_types test_type; 166 enum rte_crypto_auth_algorithm algo; 167 }; 168 169 struct gcm_interim_data { 170 uint8_t is_gmac; 171 uint8_t gen_iv; 172 }; 173 174 enum xts_tweak_modes { 175 XTS_TWEAK_MODE_HEX = 0, 176 XTS_TWEAK_MODE_NUMBER 177 }; 178 179 struct xts_interim_data { 180 enum xts_tweak_modes tweak_mode; 181 }; 182 183 #ifdef USE_JANSSON 184 struct fips_test_json_info { 185 /* Information used for reading from json */ 186 json_t *json_root; 187 json_t *json_vector_set; 188 json_t *json_test_group; 189 json_t *json_test_case; 190 /* Location of json write output */ 191 json_t *json_write_root; 192 json_t *json_write_group; 193 json_t *json_write_set; 194 json_t *json_write_case; 195 /* Other info */ 196 uint8_t is_sample; 197 }; 198 #endif /* USE_JANSSON */ 199 200 struct fips_test_interim_info { 201 FILE *fp_rd; 202 FILE *fp_wr; 203 enum file_types file_type; 204 enum fips_test_algorithms algo; 205 char *one_line_text; 206 char *vec[MAX_LINE_PER_VECTOR]; 207 uint32_t vec_start_off; 208 uint32_t nb_vec_lines; 209 char device_name[MAX_STRING_SIZE]; 210 char file_name[MAX_FILE_NAME_SIZE]; 211 float version; 212 213 union { 214 struct aesavs_interim_data aes_data; 215 struct hmac_interim_data hmac_data; 216 struct tdes_interim_data tdes_data; 217 struct ccm_interim_data ccm_data; 218 struct sha_interim_data sha_data; 219 struct gcm_interim_data gcm_data; 220 struct xts_interim_data xts_data; 221 } interim_info; 222 223 enum fips_test_op op; 224 225 const struct fips_test_callback *callbacks; 226 const struct fips_test_callback *interim_callbacks; 227 const struct fips_test_callback *writeback_callbacks; 228 229 post_prcess_t parse_writeback; 230 post_prcess_t kat_check; 231 }; 232 233 extern struct fips_test_vector vec; 234 extern struct fips_test_interim_info info; 235 236 #ifdef USE_JANSSON 237 extern struct fips_test_json_info json_info; 238 #endif /* USE_JANSSON */ 239 240 int 241 fips_test_init(const char *req_file_path, const char *rsp_file_path, 242 const char *device_name); 243 244 void 245 fips_test_clear(void); 246 247 int 248 fips_test_fetch_one_block(void); 249 250 int 251 fips_test_parse_one_case(void); 252 253 void 254 fips_test_write_one_case(void); 255 256 #ifdef USE_JANSSON 257 int 258 fips_test_parse_one_json_vector_set(void); 259 260 int 261 fips_test_parse_one_json_group(void); 262 263 int 264 fips_test_parse_one_json_case(void); 265 266 int 267 parse_test_gcm_json_init(void); 268 269 int 270 parse_test_hmac_json_init(void); 271 272 int 273 parse_test_hmac_json_algorithm(void); 274 275 int 276 parse_test_cmac_json_init(void); 277 278 int 279 parse_test_aes_json_init(void); 280 281 int 282 parse_test_xts_json_init(void); 283 #endif /* USE_JANSSON */ 284 285 int 286 parse_test_aes_init(void); 287 288 int 289 parse_test_tdes_init(void); 290 291 int 292 parse_test_hmac_init(void); 293 294 int 295 parse_test_gcm_init(void); 296 297 int 298 parse_test_cmac_init(void); 299 300 int 301 parse_test_ccm_init(void); 302 303 int 304 parse_test_sha_init(void); 305 306 int 307 parse_test_xts_init(void); 308 309 int 310 parser_read_uint8_hex(uint8_t *value, const char *p); 311 312 int 313 parse_uint8_hex_str(const char *key, char *src, struct fips_val *val); 314 315 int 316 parse_uint8_known_len_hex_str(const char *key, char *src, struct fips_val *val); 317 318 int 319 parser_read_uint16(uint16_t *value, const char *p); 320 321 int 322 parser_read_uint32_val(const char *key, char *src, struct fips_val *val); 323 324 int 325 parser_read_uint32_bit_val(const char *key, char *src, struct fips_val *val); 326 327 int 328 parser_read_uint32(uint32_t *value, char *p); 329 330 int 331 parser_read_uint32_val(const char *key, char *src, struct fips_val *val); 332 333 int 334 writeback_hex_str(const char *key, char *dst, struct fips_val *val); 335 336 void 337 parse_write_hex_str(struct fips_val *src); 338 339 int 340 update_info_vec(uint32_t count); 341 342 typedef int (*fips_test_one_case_t)(void); 343 typedef int (*fips_prepare_op_t)(void); 344 typedef int (*fips_prepare_xform_t)(struct rte_crypto_sym_xform *); 345 346 struct fips_test_ops { 347 fips_prepare_xform_t prepare_xform; 348 fips_prepare_op_t prepare_op; 349 fips_test_one_case_t test; 350 }; 351 352 extern struct fips_test_ops test_ops; 353 354 int prepare_aead_op(void); 355 356 int prepare_auth_op(void); 357 358 int prepare_gcm_xform(struct rte_crypto_sym_xform *xform); 359 360 int prepare_gmac_xform(struct rte_crypto_sym_xform *xform); 361 362 #endif 363