api/spec/ipsec_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2016-2018 Linaro Limited
 * Copyright (c) 2022-2026 Nokia
 */
 
#ifndef ODP_API_SPEC_IPSEC_TYPES_H_
#define ODP_API_SPEC_IPSEC_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/classification.h>
#include <odp/api/crypto_types.h>
#include <odp/api/packet_io_types.h>
#include <odp/api/protocols.h>
#include <odp/api/std_types.h>
#include <odp/api/traffic_mngr.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum odp_ipsec_op_mode_t {
    ODP_IPSEC_OP_MODE_SYNC = 0,
 
    ODP_IPSEC_OP_MODE_ASYNC,
 
    ODP_IPSEC_OP_MODE_INLINE,
 
    ODP_IPSEC_OP_MODE_DISABLED
 
} odp_ipsec_op_mode_t;
 
typedef enum odp_ipsec_test_sa_operation_t {
    ODP_IPSEC_TEST_SA_UPDATE_SEQ_NUM = 0,
 
    ODP_IPSEC_TEST_SA_UPDATE_ANTIREPLAY_WINDOW_TOP
 
} odp_ipsec_test_sa_operation_t;
 
typedef union odp_ipsec_test_sa_param_t {
    uint64_t seq_num;
 
    uint64_t antireplay_window_top;
 
} odp_ipsec_test_sa_param_t;
 
typedef struct odp_ipsec_inbound_config_t {
    odp_queue_t default_queue;
 
    struct {
        uint32_t min_spi;
 
        uint32_t max_spi;
 
        odp_bool_t spi_overlap;
 
    } lookup;
 
    odp_proto_layer_t retain_outer;
 
    odp_proto_layer_t parse_level;
 
    odp_proto_chksums_t chksums;
 
    odp_reass_config_t reassembly;
 
    odp_bool_t reass_async;
 
    odp_bool_t reass_inline;
 
} odp_ipsec_inbound_config_t;
 
typedef struct odp_ipsec_outbound_config_t {
    union {
        struct {
            uint32_t inner_ipv4   : 1;
 
            uint32_t inner_udp    : 1;
 
            uint32_t inner_tcp    : 1;
 
            uint32_t inner_sctp   : 1;
 
        } chksum;
 
        uint32_t all_chksum;
    };
 
} odp_ipsec_outbound_config_t;
 
typedef struct odp_ipsec_out_op_capability_t {
    struct {
        uint8_t frag_mode :1;
 
        uint8_t tfc_pad   :1;
 
        uint8_t tfc_dummy :1;
 
        uint8_t ip_param  :1;
 
    } opt;
 
} odp_ipsec_out_op_capability_t;
 
typedef struct odp_ipsec_test_capability_t {
    struct {
        odp_bool_t seq_num;
 
        odp_bool_t antireplay_window_top;
 
    } sa_operations;
 
} odp_ipsec_test_capability_t;
 
typedef struct odp_ipsec_capability_t {
    uint32_t max_num_sa;
 
    odp_support_t op_mode_sync;
 
    odp_support_t op_mode_async;
 
    odp_support_t op_mode_inline_in;
 
    odp_support_t op_mode_inline_out;
 
    odp_support_t proto_ah;
 
    odp_support_t frag_after;
 
    odp_support_t frag_before;
 
    odp_support_t pipeline_cls;
 
    odp_support_t retain_header;
 
    odp_ipsec_out_op_capability_t out_op;
 
    odp_proto_chksums_t chksums_in;
 
    uint32_t max_cls_cos;
 
    odp_bool_t queue_type_sched;
 
    odp_bool_t queue_type_plain;
 
    uint32_t max_queues;
 
    odp_pktin_vector_capability_t vector;
 
    uint32_t max_antireplay_ws;
 
    odp_crypto_cipher_algos_t ciphers;
 
    odp_crypto_auth_algos_t   auths;
 
    odp_support_t inline_ipsec_tm;
 
    odp_ipsec_test_capability_t test;
 
    odp_reass_capability_t reassembly;
 
    odp_bool_t reass_async;
 
    odp_bool_t reass_inline;
 
} odp_ipsec_capability_t;
 
typedef struct odp_ipsec_cipher_capability_t {
    uint32_t key_len;
 
} odp_ipsec_cipher_capability_t;
 
typedef struct odp_ipsec_auth_capability_t {
    uint32_t key_len;
 
    uint32_t icv_len;
} odp_ipsec_auth_capability_t;
 
typedef struct odp_ipsec_config_t {
    odp_ipsec_op_mode_t inbound_mode;
 
    odp_ipsec_op_mode_t outbound_mode;
 
    uint32_t max_num_sa;
 
    odp_ipsec_inbound_config_t inbound;
 
    odp_ipsec_outbound_config_t outbound;
 
    odp_bool_t stats_en;
 
    odp_pktin_vector_config_t vector;
 
} odp_ipsec_config_t;
 
typedef enum odp_ipsec_dir_t {
    ODP_IPSEC_DIR_INBOUND = 0,
 
    ODP_IPSEC_DIR_OUTBOUND
 
} odp_ipsec_dir_t;
 
typedef enum odp_ipsec_mode_t {
    ODP_IPSEC_MODE_TUNNEL = 0,
 
    ODP_IPSEC_MODE_TRANSPORT
 
} odp_ipsec_mode_t;
 
typedef enum odp_ipsec_protocol_t {
    ODP_IPSEC_ESP = 0,
 
    ODP_IPSEC_AH
 
} odp_ipsec_protocol_t;
 
typedef enum odp_ipsec_tunnel_type_t {
    ODP_IPSEC_TUNNEL_IPV4 = 0,
 
    ODP_IPSEC_TUNNEL_IPV6
 
} odp_ipsec_tunnel_type_t;
 
typedef struct odp_ipsec_crypto_param_t {
    odp_cipher_alg_t cipher_alg;
 
    odp_crypto_key_t cipher_key;
 
    odp_crypto_key_t cipher_key_extra;
 
    odp_auth_alg_t auth_alg;
 
    odp_crypto_key_t auth_key;
 
    odp_crypto_key_t auth_key_extra;
 
    uint32_t icv_len;
 
} odp_ipsec_crypto_param_t;
 
typedef struct odp_ipsec_ipv4_param_t {
    void *src_addr;
 
    void *dst_addr;
 
    uint8_t dscp;
 
    uint8_t df;
 
    uint8_t ttl;
 
} odp_ipsec_ipv4_param_t;
 
typedef struct odp_ipsec_ipv6_param_t {
    void *src_addr;
 
    void *dst_addr;
 
    uint32_t flabel;
 
    uint8_t dscp;
 
    uint8_t hlimit;
 
} odp_ipsec_ipv6_param_t;
 
typedef struct odp_ipsec_tunnel_param_t {
    odp_ipsec_tunnel_type_t type;
 
    struct {
        odp_ipsec_ipv4_param_t ipv4;
 
        odp_ipsec_ipv6_param_t ipv6;
    };
} odp_ipsec_tunnel_param_t;
 
typedef struct odp_ipsec_sa_opt_t {
    uint32_t esn : 1;
 
    uint32_t udp_encap : 1;
 
    uint32_t copy_dscp : 1;
 
    uint32_t copy_flabel : 1;
 
    uint32_t copy_df : 1;
 
    uint32_t dec_ttl : 1;
 
} odp_ipsec_sa_opt_t;
 
typedef struct odp_ipsec_lifetime_t {
    struct {
        uint64_t bytes;
 
        uint64_t packets;
    } soft_limit;
 
    struct {
        uint64_t bytes;
 
        uint64_t packets;
    } hard_limit;
} odp_ipsec_lifetime_t;
 
typedef enum odp_ipsec_frag_mode_t {
    ODP_IPSEC_FRAG_DISABLED = 0,
 
    ODP_IPSEC_FRAG_BEFORE,
 
    ODP_IPSEC_FRAG_AFTER,
 
    ODP_IPSEC_FRAG_CHECK
} odp_ipsec_frag_mode_t;
 
typedef enum odp_ipsec_lookup_mode_t {
    ODP_IPSEC_LOOKUP_DISABLED = 0,
 
    ODP_IPSEC_LOOKUP_SPI,
 
    ODP_IPSEC_LOOKUP_DSTADDR_SPI
 
} odp_ipsec_lookup_mode_t;
 
typedef enum odp_ipsec_pipeline_t {
    ODP_IPSEC_PIPELINE_NONE = 0,
 
    ODP_IPSEC_PIPELINE_CLS
 
} odp_ipsec_pipeline_t;
 
typedef enum odp_ipsec_ip_version_t {
    ODP_IPSEC_IPV4 = 4,
 
    ODP_IPSEC_IPV6 = 6
 
} odp_ipsec_ip_version_t;
 
typedef struct odp_ipsec_sa_param_t {
    odp_ipsec_dir_t dir;
 
    odp_ipsec_protocol_t proto;
 
    odp_ipsec_mode_t mode;
 
    odp_ipsec_crypto_param_t crypto;
 
    odp_ipsec_sa_opt_t opt;
 
    odp_ipsec_lifetime_t lifetime;
 
    uint32_t spi;
 
    odp_queue_t dest_queue;
 
    void *context;
 
    uint32_t context_len;
 
    struct {
        struct {
            odp_ipsec_lookup_mode_t lookup_mode;
 
            struct {
                odp_ipsec_ip_version_t ip_version;
 
                void *dst_addr;
 
            } lookup_param;
 
            uint32_t antireplay_ws;
 
            odp_ipsec_pipeline_t pipeline;
 
            odp_cos_t dest_cos;
 
            odp_bool_t reassembly_en;
 
        } inbound;
 
        struct {
            odp_ipsec_tunnel_param_t tunnel;
 
            odp_ipsec_frag_mode_t frag_mode;
 
            uint32_t mtu;
 
        } outbound;
    };
 
} odp_ipsec_sa_param_t;
 
typedef struct odp_ipsec_stats_t {
    uint64_t success;
 
    uint64_t proto_err;
 
    uint64_t auth_err;
 
    uint64_t antireplay_err;
 
    uint64_t alg_err;
 
    uint64_t mtu_err;
 
    uint64_t hard_exp_bytes_err;
 
    uint64_t hard_exp_pkts_err;
 
    uint64_t success_bytes;
} odp_ipsec_stats_t;
 
typedef struct odp_ipsec_sa_info_t {
    odp_ipsec_sa_param_t param;
 
    union {
        struct {
            struct {
                uint8_t dst_addr[ODP_IPV6_ADDR_SIZE];
            } lookup_param;
 
            uint32_t antireplay_ws;
 
            uint64_t antireplay_window_top;
        } inbound;
 
        struct {
            uint64_t seq_num;
 
            union {
                struct {
                    uint8_t src_addr[ODP_IPV4_ADDR_SIZE];
                    uint8_t dst_addr[ODP_IPV4_ADDR_SIZE];
                } ipv4;
 
                struct {
                    uint8_t src_addr[ODP_IPV6_ADDR_SIZE];
                    uint8_t dst_addr[ODP_IPV6_ADDR_SIZE];
                } ipv6;
            } tunnel;
        } outbound;
    };
} odp_ipsec_sa_info_t;
 
#define ODP_IPSEC_OK 0
 
typedef struct odp_ipsec_error_t {
    union {
        struct {
            uint32_t proto            : 1;
 
            uint32_t sa_lookup        : 1;
 
            uint32_t auth             : 1;
 
            uint32_t antireplay       : 1;
 
            uint32_t alg              : 1;
 
            uint32_t mtu              : 1;
 
            uint32_t hard_exp_bytes   : 1;
 
            uint32_t hard_exp_packets : 1;
        };
 
        uint32_t all;
    };
 
} odp_ipsec_error_t;
 
typedef struct odp_ipsec_warn_t {
    union {
        struct {
            uint32_t soft_exp_bytes   : 1;
 
            uint32_t soft_exp_packets : 1;
        };
 
        uint32_t all;
    };
 
} odp_ipsec_warn_t;
 
typedef struct odp_ipsec_op_status_t {
    union {
        struct {
            odp_ipsec_error_t error;
 
            odp_ipsec_warn_t warn;
        };
 
        uint64_t all;
 
    };
 
} odp_ipsec_op_status_t;
 
typedef struct odp_ipsec_op_flag_t {
    union {
        struct {
            uint32_t inline_mode      : 1;
 
        };
 
        uint32_t all;
    };
 
} odp_ipsec_op_flag_t;
 
typedef struct odp_ipsec_out_opt_t {
    union {
        struct {
            uint32_t frag_mode: 1;
 
            uint32_t tfc_pad:   1;
 
            uint32_t tfc_dummy: 1;
 
            uint32_t ip_param:  1;
 
        } flag;
 
        uint32_t all_flags;
    };
 
    odp_ipsec_frag_mode_t frag_mode;
 
    uint32_t tfc_pad_len;
 
    union {
        odp_ipsec_ipv4_param_t ipv4;
 
        odp_ipsec_ipv6_param_t ipv6;
    };
 
} odp_ipsec_out_opt_t;
 
typedef struct odp_ipsec_out_param_t {
    int num_sa;
 
    int num_opt;
 
    const odp_ipsec_sa_t *sa;
 
    const odp_ipsec_out_opt_t *opt;
 
} odp_ipsec_out_param_t;
 
typedef struct odp_ipsec_in_param_t {
    int num_sa;
 
    const odp_ipsec_sa_t *sa;
 
} odp_ipsec_in_param_t;
 
typedef struct odp_ipsec_out_inline_param_t {
    odp_pktio_t pktio;
 
    odp_tm_queue_t tm_queue;
 
    struct {
        const uint8_t *ptr;
 
        uint32_t len;
    } outer_hdr;
 
} odp_ipsec_out_inline_param_t;
 
typedef struct odp_ipsec_packet_result_t {
    odp_ipsec_op_status_t status;
 
    odp_ipsec_op_flag_t flag;
 
    odp_ipsec_sa_t sa;
 
    struct {
        uint8_t *ptr;
 
        uint32_t len;
    } outer_hdr;
 
    uint32_t orig_ip_len;
 
} odp_ipsec_packet_result_t;
 
typedef enum odp_ipsec_status_id_t {
    ODP_IPSEC_STATUS_SA_DISABLE = 0,
 
    ODP_IPSEC_STATUS_WARN
 
} odp_ipsec_status_id_t;
 
typedef struct odp_ipsec_status_t {
    odp_ipsec_status_id_t id;
 
    odp_ipsec_sa_t sa;
 
    int result;
 
    odp_ipsec_warn_t warn;
 
} odp_ipsec_status_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif