app/test/test_cryptodev_security_ipsec.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(C) 2021 Marvell.
   3  */
   4
   5 #include <rte_common.h>
   6 #include <rte_cryptodev.h>
   7 #include <rte_esp.h>
   8 #include <rte_ip.h>
   9 #include <rte_security.h>
  10 #include <rte_udp.h>
  11
  12 #include "test.h"
  13 #include "test_cryptodev_security_ipsec.h"
  14
  15 #define IV_LEN_MAX 16
  16
  17 extern struct ipsec_test_data pkt_aes_256_gcm;
  18
  19 int
  20 test_ipsec_sec_caps_verify(struct rte_security_ipsec_xform *ipsec_xform,
  21                            const struct rte_security_capability *sec_cap,
  22                            bool silent)
  23 {
  24         /* Verify security capabilities */
  25
  26         if (ipsec_xform->options.esn == 1 && sec_cap->ipsec.options.esn == 0) {
  27                 if (!silent)
  28                         RTE_LOG(INFO, USER1, "ESN is not supported\n");
  29                 return -ENOTSUP;
  30         }
  31
  32         if (ipsec_xform->options.udp_encap == 1 &&
  33             sec_cap->ipsec.options.udp_encap == 0) {
  34                 if (!silent)
  35                         RTE_LOG(INFO, USER1, "UDP encapsulation is not supported\n");
  36                 return -ENOTSUP;
  37         }
  38
  39         if (ipsec_xform->options.copy_dscp == 1 &&
  40             sec_cap->ipsec.options.copy_dscp == 0) {
  41                 if (!silent)
  42                         RTE_LOG(INFO, USER1, "Copy DSCP is not supported\n");
  43                 return -ENOTSUP;
  44         }
  45
  46         if (ipsec_xform->options.copy_flabel == 1 &&
  47             sec_cap->ipsec.options.copy_flabel == 0) {
  48                 if (!silent)
  49                         RTE_LOG(INFO, USER1, "Copy Flow Label is not supported\n");
  50                 return -ENOTSUP;
  51         }
  52
  53         if (ipsec_xform->options.copy_df == 1 &&
  54             sec_cap->ipsec.options.copy_df == 0) {
  55                 if (!silent)
  56                         RTE_LOG(INFO, USER1, "Copy DP bit is not supported\n");
  57                 return -ENOTSUP;
  58         }
  59
  60         if (ipsec_xform->options.dec_ttl == 1 &&
  61             sec_cap->ipsec.options.dec_ttl == 0) {
  62                 if (!silent)
  63                         RTE_LOG(INFO, USER1, "Decrement TTL is not supported\n");
  64                 return -ENOTSUP;
  65         }
  66
  67         if (ipsec_xform->options.ecn == 1 && sec_cap->ipsec.options.ecn == 0) {
  68                 if (!silent)
  69                         RTE_LOG(INFO, USER1, "ECN is not supported\n");
  70                 return -ENOTSUP;
  71         }
  72
  73         if (ipsec_xform->options.stats == 1 &&
  74             sec_cap->ipsec.options.stats == 0) {
  75                 if (!silent)
  76                         RTE_LOG(INFO, USER1, "Stats is not supported\n");
  77                 return -ENOTSUP;
  78         }
  79
  80         if ((ipsec_xform->direction == RTE_SECURITY_IPSEC_SA_DIR_EGRESS) &&
  81             (ipsec_xform->options.iv_gen_disable == 1) &&
  82             (sec_cap->ipsec.options.iv_gen_disable != 1)) {
  83                 if (!silent)
  84                         RTE_LOG(INFO, USER1,
  85                                 "Application provided IV is not supported\n");
  86                 return -ENOTSUP;
  87         }
  88
  89         return 0;
  90 }
  91
  92 int
  93 test_ipsec_crypto_caps_aead_verify(
  94                 const struct rte_security_capability *sec_cap,
  95                 struct rte_crypto_sym_xform *aead)
  96 {
  97         const struct rte_cryptodev_symmetric_capability *sym_cap;
  98         const struct rte_cryptodev_capabilities *crypto_cap;
  99         int j = 0;
 100
 101         while ((crypto_cap = &sec_cap->crypto_capabilities[j++])->op !=
 102                         RTE_CRYPTO_OP_TYPE_UNDEFINED) {
 103                 if (crypto_cap->op == RTE_CRYPTO_OP_TYPE_SYMMETRIC &&
 104                                 crypto_cap->sym.xform_type == aead->type &&
 105                                 crypto_cap->sym.aead.algo == aead->aead.algo) {
 106                         sym_cap = &crypto_cap->sym;
 107                         if (rte_cryptodev_sym_capability_check_aead(sym_cap,
 108                                         aead->aead.key.length,
 109                                         aead->aead.digest_length,
 110                                         aead->aead.aad_length,
 111                                         aead->aead.iv.length) == 0)
 112                                 return 0;
 113                 }
 114         }
 115
 116         return -ENOTSUP;
 117 }
 118
 119 void
 120 test_ipsec_td_in_from_out(const struct ipsec_test_data *td_out,
 121                           struct ipsec_test_data *td_in)
 122 {
 123         memcpy(td_in, td_out, sizeof(*td_in));
 124
 125         /* Populate output text of td_in with input text of td_out */
 126         memcpy(td_in->output_text.data, td_out->input_text.data,
 127                td_out->input_text.len);
 128         td_in->output_text.len = td_out->input_text.len;
 129
 130         /* Populate input text of td_in with output text of td_out */
 131         memcpy(td_in->input_text.data, td_out->output_text.data,
 132                td_out->output_text.len);
 133         td_in->input_text.len = td_out->output_text.len;
 134
 135         td_in->ipsec_xform.direction = RTE_SECURITY_IPSEC_SA_DIR_INGRESS;
 136
 137         if (td_in->aead) {
 138                 td_in->xform.aead.aead.op = RTE_CRYPTO_AEAD_OP_DECRYPT;
 139         } else {
 140                 td_in->xform.chain.auth.auth.op = RTE_CRYPTO_AUTH_OP_VERIFY;
 141                 td_in->xform.chain.cipher.cipher.op =
 142                                 RTE_CRYPTO_CIPHER_OP_DECRYPT;
 143         }
 144 }
 145
 146 void
 147 test_ipsec_td_prepare(const struct crypto_param *param1,
 148                       const struct crypto_param *param2,
 149                       const struct ipsec_test_flags *flags,
 150                       struct ipsec_test_data *td_array,
 151                       int nb_td)
 152
 153 {
 154         struct ipsec_test_data *td;
 155         int i;
 156
 157         memset(td_array, 0, nb_td * sizeof(*td));
 158
 159         for (i = 0; i < nb_td; i++) {
 160                 td = &td_array[i];
 161                 /* Copy template for packet & key fields */
 162                 memcpy(td, &pkt_aes_256_gcm, sizeof(*td));
 163
 164                 /* Override fields based on param */
 165
 166                 if (param1->type == RTE_CRYPTO_SYM_XFORM_AEAD)
 167                         td->aead = true;
 168                 else
 169                         td->aead = false;
 170
 171                 td->xform.aead.aead.algo = param1->alg.aead;
 172                 td->xform.aead.aead.key.length = param1->key_length;
 173
 174                 if (flags->iv_gen)
 175                         td->ipsec_xform.options.iv_gen_disable = 0;
 176
 177                 if (flags->sa_expiry_pkts_soft)
 178                         td->ipsec_xform.life.packets_soft_limit =
 179                                         IPSEC_TEST_PACKETS_MAX - 1;
 180         }
 181
 182         RTE_SET_USED(param2);
 183 }
 184
 185 void
 186 test_ipsec_td_update(struct ipsec_test_data td_inb[],
 187                      const struct ipsec_test_data td_outb[],
 188                      int nb_td,
 189                      const struct ipsec_test_flags *flags)
 190 {
 191         int i;
 192
 193         for (i = 0; i < nb_td; i++) {
 194                 memcpy(td_inb[i].output_text.data, td_outb[i].input_text.data,
 195                        td_outb[i].input_text.len);
 196                 td_inb[i].output_text.len = td_outb->input_text.len;
 197
 198                 if (flags->icv_corrupt) {
 199                         int icv_pos = td_inb[i].input_text.len - 4;
 200                         td_inb[i].input_text.data[icv_pos] += 1;
 201                 }
 202
 203                 if (flags->udp_encap)
 204                         td_inb[i].ipsec_xform.options.udp_encap = 1;
 205
 206                 /* Clear outbound specific flags */
 207                 td_inb[i].ipsec_xform.options.iv_gen_disable = 0;
 208         }
 209 }
 210
 211 void
 212 test_ipsec_display_alg(const struct crypto_param *param1,
 213                        const struct crypto_param *param2)
 214 {
 215         if (param1->type == RTE_CRYPTO_SYM_XFORM_AEAD)
 216                 printf("\t%s [%d]\n",
 217                        rte_crypto_aead_algorithm_strings[param1->alg.aead],
 218                        param1->key_length);
 219
 220         RTE_SET_USED(param2);
 221 }
 222
 223 static int
 224 test_ipsec_tunnel_hdr_len_get(const struct ipsec_test_data *td)
 225 {
 226         int len = 0;
 227
 228         if (td->ipsec_xform.direction == RTE_SECURITY_IPSEC_SA_DIR_EGRESS) {
 229                 if (td->ipsec_xform.mode == RTE_SECURITY_IPSEC_SA_MODE_TUNNEL) {
 230                         if (td->ipsec_xform.tunnel.type ==
 231                                         RTE_SECURITY_IPSEC_TUNNEL_IPV4)
 232                                 len += sizeof(struct rte_ipv4_hdr);
 233                         else
 234                                 len += sizeof(struct rte_ipv6_hdr);
 235                 }
 236         }
 237
 238         return len;
 239 }
 240
 241 static int
 242 test_ipsec_iv_verify_push(struct rte_mbuf *m, const struct ipsec_test_data *td)
 243 {
 244         static uint8_t iv_queue[IV_LEN_MAX * IPSEC_TEST_PACKETS_MAX];
 245         uint8_t *iv_tmp, *output_text = rte_pktmbuf_mtod(m, uint8_t *);
 246         int i, iv_pos, iv_len;
 247         static int index;
 248
 249         if (td->aead)
 250                 iv_len = td->xform.aead.aead.iv.length - td->salt.len;
 251         else
 252                 iv_len = td->xform.chain.cipher.cipher.iv.length;
 253
 254         iv_pos = test_ipsec_tunnel_hdr_len_get(td) + sizeof(struct rte_esp_hdr);
 255         output_text += iv_pos;
 256
 257         TEST_ASSERT(iv_len <= IV_LEN_MAX, "IV length greater than supported");
 258
 259         /* Compare against previous values */
 260         for (i = 0; i < index; i++) {
 261                 iv_tmp = &iv_queue[i * IV_LEN_MAX];
 262
 263                 if (memcmp(output_text, iv_tmp, iv_len) == 0) {
 264                         printf("IV repeated");
 265                         return TEST_FAILED;
 266                 }
 267         }
 268
 269         /* Save IV for future comparisons */
 270
 271         iv_tmp = &iv_queue[index * IV_LEN_MAX];
 272         memcpy(iv_tmp, output_text, iv_len);
 273         index++;
 274
 275         if (index == IPSEC_TEST_PACKETS_MAX)
 276                 index = 0;
 277
 278         return TEST_SUCCESS;
 279 }
 280
 281 static int
 282 test_ipsec_td_verify(struct rte_mbuf *m, const struct ipsec_test_data *td,
 283                      bool silent, const struct ipsec_test_flags *flags)
 284 {
 285         uint8_t *output_text = rte_pktmbuf_mtod(m, uint8_t *);
 286         uint32_t skip, len = rte_pktmbuf_pkt_len(m);
 287
 288         /* For negative tests, no need to do verification */
 289         if (flags->icv_corrupt &&
 290             td->ipsec_xform.direction == RTE_SECURITY_IPSEC_SA_DIR_INGRESS)
 291                 return TEST_SUCCESS;
 292
 293         if (td->ipsec_xform.direction == RTE_SECURITY_IPSEC_SA_DIR_EGRESS &&
 294            flags->udp_encap) {
 295                 const struct rte_ipv4_hdr *iph4;
 296                 const struct rte_ipv6_hdr *iph6;
 297
 298                 if (td->ipsec_xform.tunnel.type ==
 299                                 RTE_SECURITY_IPSEC_TUNNEL_IPV4) {
 300                         iph4 = (const struct rte_ipv4_hdr *)output_text;
 301                         if (iph4->next_proto_id != IPPROTO_UDP) {
 302                                 printf("UDP header is not found\n");
 303                                 return TEST_FAILED;
 304                         }
 305                 } else {
 306                         iph6 = (const struct rte_ipv6_hdr *)output_text;
 307                         if (iph6->proto != IPPROTO_UDP) {
 308                                 printf("UDP header is not found\n");
 309                                 return TEST_FAILED;
 310                         }
 311                 }
 312
 313                 len -= sizeof(struct rte_udp_hdr);
 314                 output_text += sizeof(struct rte_udp_hdr);
 315         }
 316
 317         if (len != td->output_text.len) {
 318                 printf("Output length (%d) not matching with expected (%d)\n",
 319                         len, td->output_text.len);
 320                 return TEST_FAILED;
 321         }
 322
 323         skip = test_ipsec_tunnel_hdr_len_get(td);
 324
 325         len -= skip;
 326         output_text += skip;
 327
 328         if (memcmp(output_text, td->output_text.data + skip, len)) {
 329                 if (silent)
 330                         return TEST_FAILED;
 331
 332                 printf("TestCase %s line %d: %s\n", __func__, __LINE__,
 333                         "output text not as expected\n");
 334
 335                 rte_hexdump(stdout, "expected", td->output_text.data + skip,
 336                             len);
 337                 rte_hexdump(stdout, "actual", output_text, len);
 338                 return TEST_FAILED;
 339         }
 340
 341         return TEST_SUCCESS;
 342 }
 343
 344 static int
 345 test_ipsec_res_d_prepare(struct rte_mbuf *m, const struct ipsec_test_data *td,
 346                    struct ipsec_test_data *res_d)
 347 {
 348         uint8_t *output_text = rte_pktmbuf_mtod(m, uint8_t *);
 349         uint32_t len = rte_pktmbuf_pkt_len(m);
 350
 351         memcpy(res_d, td, sizeof(*res_d));
 352         memcpy(res_d->input_text.data, output_text, len);
 353         res_d->input_text.len = len;
 354
 355         res_d->ipsec_xform.direction = RTE_SECURITY_IPSEC_SA_DIR_INGRESS;
 356         if (res_d->aead) {
 357                 res_d->xform.aead.aead.op = RTE_CRYPTO_AEAD_OP_DECRYPT;
 358         } else {
 359                 printf("Only AEAD supported\n");
 360                 return TEST_SKIPPED;
 361         }
 362
 363         return TEST_SUCCESS;
 364 }
 365
 366 int
 367 test_ipsec_post_process(struct rte_mbuf *m, const struct ipsec_test_data *td,
 368                         struct ipsec_test_data *res_d, bool silent,
 369                         const struct ipsec_test_flags *flags)
 370 {
 371         int ret;
 372
 373         if (flags->iv_gen &&
 374             td->ipsec_xform.direction == RTE_SECURITY_IPSEC_SA_DIR_EGRESS) {
 375                 ret = test_ipsec_iv_verify_push(m, td);
 376                 if (ret != TEST_SUCCESS)
 377                         return ret;
 378         }
 379
 380         /*
 381          * In case of known vector tests & all inbound tests, res_d provided
 382          * would be NULL and output data need to be validated against expected.
 383          * For inbound, output_text would be plain packet and for outbound
 384          * output_text would IPsec packet. Validate by comparing against
 385          * known vectors.
 386          *
 387          * In case of combined mode tests, the output_text from outbound
 388          * operation (ie, IPsec packet) would need to be inbound processed to
 389          * obtain the plain text. Copy output_text to result data, 'res_d', so
 390          * that inbound processing can be done.
 391          */
 392
 393         if (res_d == NULL)
 394                 return test_ipsec_td_verify(m, td, silent, flags);
 395         else
 396                 return test_ipsec_res_d_prepare(m, td, res_d);
 397 }
 398
 399 int
 400 test_ipsec_status_check(struct rte_crypto_op *op,
 401                         const struct ipsec_test_flags *flags,
 402                         enum rte_security_ipsec_sa_direction dir,
 403                         int pkt_num)
 404 {
 405         int ret = TEST_SUCCESS;
 406
 407         if (dir == RTE_SECURITY_IPSEC_SA_DIR_INGRESS && flags->icv_corrupt) {
 408                 if (op->status != RTE_CRYPTO_OP_STATUS_ERROR) {
 409                         printf("ICV corruption test case failed\n");
 410                         ret = TEST_FAILED;
 411                 }
 412         } else {
 413                 if (op->status != RTE_CRYPTO_OP_STATUS_SUCCESS) {
 414                         printf("Security op processing failed [pkt_num: %d]\n",
 415                                pkt_num);
 416                         ret = TEST_FAILED;
 417                 }
 418         }
 419
 420         if (flags->sa_expiry_pkts_soft && pkt_num == IPSEC_TEST_PACKETS_MAX) {
 421                 if (!(op->aux_flags &
 422                       RTE_CRYPTO_OP_AUX_FLAGS_IPSEC_SOFT_EXPIRY)) {
 423                         printf("SA soft expiry (pkts) test failed\n");
 424                         ret = TEST_FAILED;
 425                 }
 426         }
 427
 428         return ret;
 429 }