rte_swx_ipsec.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2022 Intel Corporation
 */
#ifndef __INCLUDE_RTE_SWX_IPSEC_H__
#define __INCLUDE_RTE_SWX_IPSEC_H__

#include <stdint.h>
#include <stdio.h>
#include <netinet/in.h>

#include <rte_compat.h>
#include <rte_crypto_sym.h>
#include <rte_ip6.h>

#ifdef __cplusplus
extern "C" {
#endif

struct rte_swx_ipsec;

#ifndef RTE_SWX_IPSEC_NAME_SIZE
#define RTE_SWX_IPSEC_NAME_SIZE 64
#endif

#ifndef RTE_SWX_IPSEC_BURST_SIZE_MAX
#define RTE_SWX_IPSEC_BURST_SIZE_MAX 256
#endif

struct rte_swx_ipsec_burst_size {
    uint32_t ring_rd;

    uint32_t ring_wr;

    uint32_t crypto_wr;

    uint32_t crypto_rd;
};

struct rte_swx_ipsec_params {
    const char *ring_in_name;

    const char *ring_out_name;

    const char *crypto_dev_name;

    uint32_t crypto_dev_queue_pair_id;

    struct rte_swx_ipsec_burst_size bsz;

    uint32_t n_sa_max;
};

struct rte_swx_ipsec_input_packet_metadata {
    /* SA ID. */
    uint32_t sa_id;
};

__rte_experimental
struct rte_swx_ipsec *
rte_swx_ipsec_find(const char *name);

__rte_experimental
int
rte_swx_ipsec_create(struct rte_swx_ipsec **ipsec,
             const char *name,
             struct rte_swx_ipsec_params *params,
             int numa_node);

__rte_experimental
void
rte_swx_ipsec_free(struct rte_swx_ipsec *ipsec);

__rte_experimental
void
rte_swx_ipsec_run(struct rte_swx_ipsec *ipsec);

/*
 * IPsec Control Plane API
 */

#define RTE_SWX_IPSEC_KEY_SIZE_MAX 64

struct rte_swx_ipsec_sa_cipher_params {
    enum rte_crypto_cipher_algorithm alg;

    uint8_t key[RTE_SWX_IPSEC_KEY_SIZE_MAX];

    uint32_t key_size;
};

struct rte_swx_ipsec_sa_authentication_params {
    enum rte_crypto_auth_algorithm alg;

    uint8_t key[RTE_SWX_IPSEC_KEY_SIZE_MAX];

    uint32_t key_size;
};

struct rte_swx_ipsec_sa_aead_params {
    enum rte_crypto_aead_algorithm alg;

    uint8_t key[RTE_SWX_IPSEC_KEY_SIZE_MAX];

    uint32_t key_size;
};

struct rte_swx_ipsec_sa_encap_params {
    struct {
        uint32_t spi;
    } esp;

    int tunnel_mode;

    int tunnel_ipv4;

    union {
        struct {
            struct in_addr src_addr;

            struct in_addr dst_addr;
        } ipv4;

        struct {
            struct rte_ipv6_addr src_addr;

            struct rte_ipv6_addr dst_addr;
        } ipv6;
    } tunnel;
};

struct rte_swx_ipsec_sa_params {
    int encrypt;

    struct {
        union {
            struct {
                struct rte_swx_ipsec_sa_cipher_params cipher;

                struct rte_swx_ipsec_sa_authentication_params auth;
            } cipher_auth;

            struct rte_swx_ipsec_sa_aead_params aead;
        };

        int is_aead;
    } crypto;

    struct rte_swx_ipsec_sa_encap_params encap;
};

__rte_experimental
int
rte_swx_ipsec_sa_add(struct rte_swx_ipsec *ipsec,
             struct rte_swx_ipsec_sa_params *sa_params,
             uint32_t *sa_id);

__rte_experimental
void
rte_swx_ipsec_sa_delete(struct rte_swx_ipsec *ipsec,
            uint32_t sa_id);

__rte_experimental
struct rte_swx_ipsec_sa_params *
rte_swx_ipsec_sa_read(struct rte_swx_ipsec *ipsec,
              const char *string,
              int *is_blank_or_comment,
              const char **errmsg);

#ifdef __cplusplus
}
#endif

#endif