examples/fips_validation: add parsing for AES-XTS
authorGowrishankar Muthukrishnan <gmuthukrishn@marvell.com>
Wed, 29 Jun 2022 12:35:05 +0000 (18:05 +0530)
committerAkhil Goyal <gakhil@marvell.com>
Thu, 30 Jun 2022 04:54:21 +0000 (06:54 +0200)
Added function to parse algorithm for AES XTS test.

Signed-off-by: Gowrishankar Muthukrishnan <gmuthukrishn@marvell.com>
Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
doc/guides/sample_app_ug/fips_validation.rst
examples/fips_validation/fips_validation.c
examples/fips_validation/fips_validation.h
examples/fips_validation/fips_validation_xts.c
examples/fips_validation/main.c

index 43190bb..41d2e0d 100644 (file)
@@ -61,6 +61,7 @@ ACVP
     * AES-CBC (128,192,256) - AFT, MCT
     * AES-GCM (128,192,256) - AFT
     * AES-CMAC (128,192,256) - AFT
+    * AES-XTS (128,256) - AFT
     * HMAC (SHA1, SHA224, SHA256, SHA384, SHA512)
 
 
index 68b5572..f181363 100644 (file)
@@ -464,6 +464,8 @@ fips_test_parse_one_json_vector_set(void)
                info.algo = FIPS_TEST_ALGO_AES_CMAC;
        else if (strstr(algo_str, "AES-CBC"))
                info.algo = FIPS_TEST_ALGO_AES_CBC;
+       else if (strstr(algo_str, "AES-XTS"))
+               info.algo = FIPS_TEST_ALGO_AES_XTS;
        else
                return -EINVAL;
 
index 8192369..d716b19 100644 (file)
@@ -38,10 +38,10 @@ enum fips_test_algorithms {
                FIPS_TEST_ALGO_AES_GCM,
                FIPS_TEST_ALGO_AES_CMAC,
                FIPS_TEST_ALGO_AES_CCM,
+               FIPS_TEST_ALGO_AES_XTS,
                FIPS_TEST_ALGO_HMAC,
                FIPS_TEST_ALGO_TDES,
                FIPS_TEST_ALGO_SHA,
-               FIPS_TEST_ALGO_AES_XTS,
                FIPS_TEST_ALGO_MAX
 };
 
@@ -171,6 +171,15 @@ struct gcm_interim_data {
        uint8_t gen_iv;
 };
 
+enum xts_tweak_modes {
+       XTS_TWEAK_MODE_HEX = 0,
+       XTS_TWEAK_MODE_NUMBER
+};
+
+struct xts_interim_data {
+       enum xts_tweak_modes tweak_mode;
+};
+
 #ifdef USE_JANSSON
 struct fips_test_json_info {
        /* Information used for reading from json */
@@ -208,6 +217,7 @@ struct fips_test_interim_info {
                struct ccm_interim_data ccm_data;
                struct sha_interim_data sha_data;
                struct gcm_interim_data gcm_data;
+               struct xts_interim_data xts_data;
        } interim_info;
 
        enum fips_test_op op;
@@ -267,6 +277,9 @@ parse_test_cmac_json_init(void);
 
 int
 parse_test_aes_json_init(void);
+
+int
+parse_test_xts_json_init(void);
 #endif /* USE_JANSSON */
 
 int
index 5bb1966..531e3c6 100644 (file)
 #define OP_ENC_STR     "ENCRYPT"
 #define OP_DEC_STR     "DECRYPT"
 
+#define ALGO_JSON_STR          "algorithm"
+#define TESTTYPE_JSON_STR      "testType"
+#define DIR_JSON_STR           "direction"
+#define KEYLEN_JSON_STR                "keyLen"
+#define TWEAKMODE_JSON_STR     "tweakMode"
+
+#define KEY_JSON_STR           "key"
+#define DATAUNITLEN_JSON_STR   "dataUnitLen"
+#define PAYLOADLEN_JSON_STR    "payloadLen"
+#define TWEAKVALUE_JSON_STR    "tweakValue"
+#define PT_JSON_STR    "pt"
+#define CT_JSON_STR    "ct"
+
+#define OP_ENC_JSON_STR        "encrypt"
+#define OP_DEC_JSON_STR        "decrypt"
+
 static int
 parse_interim_xts_enc_dec(const char *key,
                __rte_unused char *text,
@@ -62,6 +78,131 @@ struct fips_test_callback xts_writeback_callbacks[] = {
                {NULL, NULL, NULL} /**< end pointer */
 };
 
+#ifdef USE_JANSSON
+static int
+parser_xts_read_keylen(const char *key, char *src, struct fips_val *val)
+{
+       int ret;
+
+       ret = parser_read_uint32_bit_val(key, src, val);
+       if (ret < 0)
+               return ret;
+
+       val->len *= 2;
+       return 0;
+}
+
+static int
+parser_xts_read_tweakval(const char *key, char *src, struct fips_val *val)
+{
+       int ret;
+
+       if (info.interim_info.xts_data.tweak_mode == XTS_TWEAK_MODE_HEX)
+               ret = parse_uint8_hex_str(key, src, val);
+       else if (info.interim_info.xts_data.tweak_mode == XTS_TWEAK_MODE_NUMBER)
+               ret = parser_read_uint32_bit_val(key, src, val);
+       else
+               ret = -1;
+
+       return ret;
+}
+
+struct fips_test_callback xts_dec_json_vectors[] = {
+               {KEY_JSON_STR, parse_uint8_known_len_hex_str, &vec.cipher_auth.key},
+               {TWEAKVALUE_JSON_STR, parser_xts_read_tweakval, &vec.iv},
+               {CT_JSON_STR, parse_uint8_hex_str, &vec.ct},
+               {NULL, NULL, NULL} /**< end pointer */
+};
+
+struct fips_test_callback xts_interim_json_vectors[] = {
+               {KEYLEN_JSON_STR, parser_xts_read_keylen, &vec.cipher_auth.key},
+               {NULL, NULL, NULL} /**< end pointer */
+};
+
+struct fips_test_callback xts_enc_json_vectors[] = {
+               {KEY_JSON_STR, parse_uint8_known_len_hex_str, &vec.cipher_auth.key},
+               {TWEAKVALUE_JSON_STR, parser_xts_read_tweakval, &vec.iv},
+               {PT_JSON_STR, parse_uint8_hex_str, &vec.pt},
+               {NULL, NULL, NULL} /**< end pointer */
+};
+
+static int
+parse_test_xts_json_writeback(struct fips_val *val)
+{
+       struct fips_val tmp_val;
+       json_t *tcId;
+
+       tcId = json_object_get(json_info.json_test_case, "tcId");
+
+       json_info.json_write_case = json_object();
+       json_object_set(json_info.json_write_case, "tcId", tcId);
+
+       if (info.op == FIPS_TEST_ENC_AUTH_GEN) {
+               json_t *ct;
+
+               tmp_val.val = val->val;
+               tmp_val.len = vec.pt.len;
+
+               writeback_hex_str("", info.one_line_text, &tmp_val);
+               ct = json_string(info.one_line_text);
+               json_object_set_new(json_info.json_write_case, CT_JSON_STR, ct);
+
+               tmp_val.val = val->val + vec.pt.len;
+               tmp_val.len = val->len - vec.pt.len;
+
+               writeback_hex_str("", info.one_line_text, &tmp_val);
+       } else {
+               if (vec.status == RTE_CRYPTO_OP_STATUS_SUCCESS) {
+                       tmp_val.val = val->val;
+                       tmp_val.len = vec.ct.len;
+
+                       writeback_hex_str("", info.one_line_text, &tmp_val);
+                       json_object_set_new(json_info.json_write_case, PT_JSON_STR,
+                                                               json_string(info.one_line_text));
+               } else {
+                       json_object_set_new(json_info.json_write_case, "testPassed", json_false());
+               }
+       }
+
+       return 0;
+}
+
+int
+parse_test_xts_json_init(void)
+{
+       if (json_info.json_test_group) {
+               json_t *direction_obj, *tweakmode_obj;
+               const char *direction_str, *tweakmode_str;
+
+               direction_obj = json_object_get(json_info.json_test_group, DIR_JSON_STR);
+               direction_str = json_string_value(direction_obj);
+
+               if (strcmp(direction_str, OP_ENC_JSON_STR) == 0) {
+                       info.op = FIPS_TEST_ENC_AUTH_GEN;
+                       info.callbacks = xts_enc_json_vectors;
+
+               } else if (strcmp(direction_str, OP_DEC_JSON_STR) == 0) {
+                       info.op = FIPS_TEST_DEC_AUTH_VERIF;
+                       info.callbacks = xts_dec_json_vectors;
+               } else {
+                       return -EINVAL;
+               }
+
+               tweakmode_obj = json_object_get(json_info.json_test_group, TWEAKMODE_JSON_STR);
+               tweakmode_str = json_string_value(tweakmode_obj);
+               if (strcmp(tweakmode_str, "hex") == 0)
+                       info.interim_info.xts_data.tweak_mode = XTS_TWEAK_MODE_HEX;
+               else
+                       info.interim_info.xts_data.tweak_mode = XTS_TWEAK_MODE_NUMBER;
+
+               info.interim_callbacks = xts_interim_json_vectors;
+       }
+
+       info.parse_writeback = parse_test_xts_json_writeback;
+       return 0;
+}
+#endif /* USE_JANSSON */
+
 static int
 parse_test_xts_writeback(struct fips_val *val)
 {
index 9c49515..7ccb5f5 100644 (file)
@@ -1989,6 +1989,10 @@ fips_test_one_test_group(void)
        case FIPS_TEST_ALGO_AES_CMAC:
                ret = parse_test_cmac_json_init();
                break;
+       case FIPS_TEST_ALGO_AES_XTS:
+               ret = parse_test_xts_json_init();
+               break;
+       case FIPS_TEST_ALGO_AES_CBC:
        case FIPS_TEST_ALGO_AES:
                ret = parse_test_aes_json_init();
                break;