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 #define FIPS_PARSE_ERR(fmt, args) \ 9 RTE_LOG(ERR, USER1, "FIPS parse error" ## fmt ## "\n", ## args) 10 11 #define ERR_MSG_SIZE 128 12 #define MAX_CASE_LINE 15 13 #define MAX_LINE_CHAR 204800 /*< max number of characters per line */ 14 #define MAX_NB_TESTS 10240 15 #define MAX_BUF_SIZE 2048 16 #define MAX_STRING_SIZE 64 17 #define MAX_DIGEST_SIZE 64 18 19 #define POSITIVE_TEST 0 20 #define NEGATIVE_TEST -1 21 22 #define REQ_FILE_PERFIX "req" 23 #define RSP_FILE_PERFIX "rsp" 24 #define FAX_FILE_PERFIX "fax" 25 26 enum fips_test_algorithms { 27 FIPS_TEST_ALGO_AES = 0, 28 FIPS_TEST_ALGO_AES_GCM, 29 FIPS_TEST_ALGO_AES_CMAC, 30 FIPS_TEST_ALGO_AES_CCM, 31 FIPS_TEST_ALGO_HMAC, 32 FIPS_TEST_ALGO_TDES, 33 FIPS_TEST_ALGO_SHA, 34 FIPS_TEST_ALGO_MAX 35 }; 36 37 enum file_types { 38 FIPS_TYPE_REQ = 1, 39 FIPS_TYPE_FAX, 40 FIPS_TYPE_RSP 41 }; 42 43 enum fips_test_op { 44 FIPS_TEST_ENC_AUTH_GEN = 1, 45 FIPS_TEST_DEC_AUTH_VERIF, 46 }; 47 48 #define MAX_LINE_PER_VECTOR 16 49 50 struct fips_val { 51 uint8_t *val; 52 uint32_t len; 53 }; 54 55 struct fips_test_vector { 56 union { 57 struct { 58 struct fips_val key; 59 struct fips_val digest; 60 struct fips_val auth_aad; 61 struct fips_val aad; 62 } cipher_auth; 63 struct { 64 struct fips_val key; 65 struct fips_val digest; 66 struct fips_val aad; 67 } aead; 68 }; 69 70 struct fips_val pt; 71 struct fips_val ct; 72 struct fips_val iv; 73 74 enum rte_crypto_op_status status; 75 }; 76 77 typedef int (*post_prcess_t)(struct fips_val *val); 78 79 typedef int (*parse_callback_t)(const char *key, char *text, 80 struct fips_val *val); 81 82 struct fips_test_callback { 83 const char *key; 84 parse_callback_t cb; 85 struct fips_val *val; 86 }; 87 88 enum fips_aesavs_test_types { 89 AESAVS_TYPE_GFXBOX = 1, 90 AESAVS_TYPE_KEYSBOX, 91 AESAVS_TYPE_VARKEY, 92 AESAVS_TYPE_VARTXT, 93 AESAVS_TYPE_MMT, 94 AESAVS_TYPE_MCT, 95 }; 96 97 enum fips_tdes_test_types { 98 TDES_INVERSE_PERMUTATION = 0, 99 TDES_PERMUTATION, 100 TDES_SUBSTITUTION_TABLE, 101 TDES_VARIABLE_KEY, 102 TDES_VARIABLE_TEXT, 103 TDES_KAT, 104 TDES_MCT, /* Monte Carlo (Modes) Test */ 105 TDES_MMT /* Multi block Message Test */ 106 }; 107 108 enum fips_ccm_test_types { 109 CCM_VADT = 1, /* Variable Associated Data Test */ 110 CCM_VPT, /* Variable Payload Test */ 111 CCM_VNT, /* Variable Nonce Test */ 112 CCM_VTT, /* Variable Tag Test */ 113 CCM_DVPT, /* Decryption-Verification Process Test */ 114 }; 115 116 enum fips_sha_test_types { 117 SHA_KAT = 0, 118 SHA_MCT 119 }; 120 121 struct aesavs_interim_data { 122 enum fips_aesavs_test_types test_type; 123 uint32_t cipher_algo; 124 uint32_t key_len; 125 }; 126 127 struct hmac_interim_data { 128 enum rte_crypto_auth_algorithm algo; 129 }; 130 131 struct tdes_interim_data { 132 enum fips_tdes_test_types test_type; 133 uint32_t nb_keys; 134 }; 135 136 struct ccm_interim_data { 137 enum fips_ccm_test_types test_type; 138 uint32_t aad_len; 139 uint32_t pt_len; 140 uint32_t digest_len; 141 uint32_t key_len; 142 uint32_t iv_len; 143 }; 144 145 struct sha_interim_data { 146 enum fips_sha_test_types test_type; 147 enum rte_crypto_auth_algorithm algo; 148 }; 149 150 struct fips_test_interim_info { 151 FILE *fp_rd; 152 FILE *fp_wr; 153 enum file_types file_type; 154 enum fips_test_algorithms algo; 155 char *one_line_text; 156 char *vec[MAX_LINE_PER_VECTOR]; 157 uint32_t nb_vec_lines; 158 char device_name[MAX_STRING_SIZE]; 159 160 union { 161 struct aesavs_interim_data aes_data; 162 struct hmac_interim_data hmac_data; 163 struct tdes_interim_data tdes_data; 164 struct ccm_interim_data ccm_data; 165 struct sha_interim_data sha_data; 166 } interim_info; 167 168 enum fips_test_op op; 169 170 const struct fips_test_callback *callbacks; 171 const struct fips_test_callback *interim_callbacks; 172 const struct fips_test_callback *writeback_callbacks; 173 174 post_prcess_t parse_writeback; 175 post_prcess_t kat_check; 176 }; 177 178 extern struct fips_test_vector vec; 179 extern struct fips_test_interim_info info; 180 181 int 182 fips_test_init(const char *req_file_path, const char *rsp_file_path, 183 const char *device_name); 184 185 void 186 fips_test_clear(void); 187 188 int 189 fips_test_fetch_one_block(void); 190 191 int 192 fips_test_parse_one_case(void); 193 194 void 195 fips_test_write_one_case(void); 196 197 int 198 parse_test_aes_init(void); 199 200 int 201 parse_test_tdes_init(void); 202 203 int 204 parse_test_hmac_init(void); 205 206 int 207 parse_test_gcm_init(void); 208 209 int 210 parse_test_cmac_init(void); 211 212 int 213 parse_test_ccm_init(void); 214 215 int 216 parse_test_sha_init(void); 217 218 int 219 parser_read_uint8_hex(uint8_t *value, const char *p); 220 221 int 222 parse_uint8_hex_str(const char *key, char *src, struct fips_val *val); 223 224 int 225 parse_uint8_known_len_hex_str(const char *key, char *src, struct fips_val *val); 226 227 int 228 parser_read_uint32_val(const char *key, char *src, struct fips_val *val); 229 230 int 231 parser_read_uint32_bit_val(const char *key, char *src, struct fips_val *val); 232 233 int 234 parser_read_uint32(uint32_t *value, char *p); 235 236 int 237 parser_read_uint32_val(const char *key, char *src, struct fips_val *val); 238 239 int 240 writeback_hex_str(const char *key, char *dst, struct fips_val *val); 241 242 void 243 parse_write_hex_str(struct fips_val *src); 244 245 int 246 update_info_vec(uint32_t count); 247 248 #endif 249