examples/ipsec-secgw/ipsec.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef __IPSEC_H__
  35 #define __IPSEC_H__
  36
  37 #include <stdint.h>
  38
  39 #include <rte_byteorder.h>
  40 #include <rte_crypto.h>
  41
  42 #define RTE_LOGTYPE_IPSEC       RTE_LOGTYPE_USER1
  43 #define RTE_LOGTYPE_IPSEC_ESP   RTE_LOGTYPE_USER2
  44 #define RTE_LOGTYPE_IPSEC_IPIP  RTE_LOGTYPE_USER3
  45
  46 #define MAX_PKT_BURST 32
  47 #define MAX_QP_PER_LCORE 256
  48
  49 #define MAX_DIGEST_SIZE 32 /* Bytes -- 256 bits */
  50
  51 #define uint32_t_to_char(ip, a, b, c, d) do {\
  52                 *a = (uint8_t)(ip >> 24 & 0xff);\
  53                 *b = (uint8_t)(ip >> 16 & 0xff);\
  54                 *c = (uint8_t)(ip >> 8 & 0xff);\
  55                 *d = (uint8_t)(ip & 0xff);\
  56         } while (0)
  57
  58 #define DEFAULT_MAX_CATEGORIES  1
  59
  60 #define IPSEC_SA_MAX_ENTRIES (128) /* must be power of 2, max 2 power 30 */
  61 #define SPI2IDX(spi) (spi & (IPSEC_SA_MAX_ENTRIES - 1))
  62 #define INVALID_SPI (0)
  63
  64 #define DISCARD (0x80000000)
  65 #define BYPASS (0x40000000)
  66 #define PROTECT_MASK (0x3fffffff)
  67 #define PROTECT(sa_idx) (SPI2IDX(sa_idx) & PROTECT_MASK) /* SA idx 30 bits */
  68
  69 #define IPSEC_XFORM_MAX 2
  70
  71 #define IP6_VERSION (6)
  72
  73 struct rte_crypto_xform;
  74 struct ipsec_xform;
  75 struct rte_cryptodev_session;
  76 struct rte_mbuf;
  77
  78 struct ipsec_sa;
  79
  80 typedef int32_t (*ipsec_xform_fn)(struct rte_mbuf *m, struct ipsec_sa *sa,
  81                 struct rte_crypto_op *cop);
  82
  83 struct ip_addr {
  84         union {
  85                 uint32_t ip4;
  86                 union {
  87                         uint64_t ip6[2];
  88                         uint8_t ip6_b[16];
  89                 } ip6;
  90         } ip;
  91 };
  92
  93 #define MAX_KEY_SIZE            20
  94
  95 struct ipsec_sa {
  96         uint32_t spi;
  97         uint32_t cdev_id_qp;
  98         struct rte_cryptodev_sym_session *crypto_session;
  99         uint32_t seq;
 100         enum rte_crypto_cipher_algorithm cipher_algo;
 101         enum rte_crypto_auth_algorithm auth_algo;
 102         uint16_t digest_len;
 103         uint16_t iv_len;
 104         uint16_t block_size;
 105         uint16_t flags;
 106 #define IP4_TUNNEL (1 << 0)
 107 #define IP6_TUNNEL (1 << 1)
 108 #define TRANSPORT  (1 << 2)
 109         struct ip_addr src;
 110         struct ip_addr dst;
 111         uint8_t cipher_key[MAX_KEY_SIZE];
 112         uint16_t cipher_key_len;
 113         uint8_t auth_key[MAX_KEY_SIZE];
 114         uint16_t auth_key_len;
 115         struct rte_crypto_sym_xform *xforms;
 116 } __rte_cache_aligned;
 117
 118 struct ipsec_mbuf_metadata {
 119         struct ipsec_sa *sa;
 120         struct rte_crypto_op cop;
 121         struct rte_crypto_sym_op sym_cop;
 122 };
 123
 124 struct cdev_qp {
 125         uint16_t id;
 126         uint16_t qp;
 127         uint16_t in_flight;
 128         uint16_t len;
 129         struct rte_crypto_op *buf[MAX_PKT_BURST] __rte_aligned(sizeof(void *));
 130 };
 131
 132 struct ipsec_ctx {
 133         struct rte_hash *cdev_map;
 134         struct sp_ctx *sp4_ctx;
 135         struct sp_ctx *sp6_ctx;
 136         struct sa_ctx *sa_ctx;
 137         uint16_t nb_qps;
 138         uint16_t last_qp;
 139         struct cdev_qp tbl[MAX_QP_PER_LCORE];
 140 };
 141
 142 struct cdev_key {
 143         uint16_t lcore_id;
 144         uint8_t cipher_algo;
 145         uint8_t auth_algo;
 146 };
 147
 148 struct socket_ctx {
 149         struct sa_ctx *sa_in;
 150         struct sa_ctx *sa_out;
 151         struct sp_ctx *sp_ip4_in;
 152         struct sp_ctx *sp_ip4_out;
 153         struct sp_ctx *sp_ip6_in;
 154         struct sp_ctx *sp_ip6_out;
 155         struct rt_ctx *rt_ip4;
 156         struct rt_ctx *rt_ip6;
 157         struct rte_mempool *mbuf_pool;
 158 };
 159
 160 uint16_t
 161 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
 162                 uint16_t nb_pkts, uint16_t len);
 163
 164 uint16_t
 165 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
 166                 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len);
 167
 168 static inline uint16_t
 169 ipsec_metadata_size(void)
 170 {
 171         return sizeof(struct ipsec_mbuf_metadata);
 172 }
 173
 174 static inline struct ipsec_mbuf_metadata *
 175 get_priv(struct rte_mbuf *m)
 176 {
 177         return RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
 178 }
 179
 180 int
 181 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx);
 182
 183 void
 184 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
 185                 struct ipsec_sa *sa[], uint16_t nb_pkts);
 186
 187 void
 188 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
 189                 struct ipsec_sa *sa[], uint16_t nb_pkts);
 190
 191 void
 192 sp4_init(struct socket_ctx *ctx, int32_t socket_id);
 193
 194 void
 195 sp6_init(struct socket_ctx *ctx, int32_t socket_id);
 196
 197 void
 198 sa_init(struct socket_ctx *ctx, int32_t socket_id);
 199
 200 void
 201 rt_init(struct socket_ctx *ctx, int32_t socket_id);
 202
 203 #endif /* __IPSEC_H__ */