src/vnet/ipsec/ipsec.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __IPSEC_H__
  16 #define __IPSEC_H__
  17
  18 #include <vnet/ip/ip.h>
  19 #include <vnet/feature/feature.h>
  20
  21 #define IPSEC_FLAG_IPSEC_GRE_TUNNEL (1 << 0)
  22
  23
  24 #define foreach_ipsec_output_next                \
  25 _(DROP, "error-drop")                            \
  26 _(ESP_ENCRYPT, "esp-encrypt")
  27
  28 #define _(v, s) IPSEC_OUTPUT_NEXT_##v,
  29 typedef enum
  30 {
  31   foreach_ipsec_output_next
  32 #undef _
  33     IPSEC_OUTPUT_N_NEXT,
  34 } ipsec_output_next_t;
  35
  36
  37 #define foreach_ipsec_input_next                \
  38 _(DROP, "error-drop")                           \
  39 _(ESP_DECRYPT, "esp-decrypt")
  40
  41 #define _(v, s) IPSEC_INPUT_NEXT_##v,
  42 typedef enum
  43 {
  44   foreach_ipsec_input_next
  45 #undef _
  46     IPSEC_INPUT_N_NEXT,
  47 } ipsec_input_next_t;
  48
  49
  50 #define foreach_ipsec_policy_action \
  51   _(0, BYPASS,  "bypass")          \
  52   _(1, DISCARD, "discard")         \
  53   _(2, RESOLVE, "resolve")         \
  54   _(3, PROTECT, "protect")
  55
  56 typedef enum
  57 {
  58 #define _(v,f,s) IPSEC_POLICY_ACTION_##f = v,
  59   foreach_ipsec_policy_action
  60 #undef _
  61     IPSEC_POLICY_N_ACTION,
  62 } ipsec_policy_action_t;
  63
  64 #define foreach_ipsec_crypto_alg \
  65   _(0, NONE,  "none")               \
  66   _(1, AES_CBC_128, "aes-cbc-128")  \
  67   _(2, AES_CBC_192, "aes-cbc-192")  \
  68   _(3, AES_CBC_256, "aes-cbc-256")  \
  69   _(4, AES_CTR_128, "aes-ctr-128")  \
  70   _(5, AES_CTR_192, "aes-ctr-192")  \
  71   _(6, AES_CTR_256, "aes-ctr-256")  \
  72   _(7, AES_GCM_128, "aes-gcm-128")  \
  73   _(8, AES_GCM_192, "aes-gcm-192")  \
  74   _(9, AES_GCM_256, "aes-gcm-256")
  75
  76 typedef enum
  77 {
  78 #define _(v,f,s) IPSEC_CRYPTO_ALG_##f = v,
  79   foreach_ipsec_crypto_alg
  80 #undef _
  81     IPSEC_CRYPTO_N_ALG,
  82 } ipsec_crypto_alg_t;
  83
  84 #define foreach_ipsec_integ_alg \
  85   _(0, NONE,  "none")                                                     \
  86   _(1, MD5_96, "md5-96")           /* RFC2403 */                          \
  87   _(2, SHA1_96, "sha1-96")         /* RFC2404 */                          \
  88   _(3, SHA_256_96, "sha-256-96")   /* draft-ietf-ipsec-ciph-sha-256-00 */ \
  89   _(4, SHA_256_128, "sha-256-128") /* RFC4868 */                          \
  90   _(5, SHA_384_192, "sha-384-192") /* RFC4868 */                          \
  91   _(6, SHA_512_256, "sha-512-256")      /* RFC4868 */
  92
  93 typedef enum
  94 {
  95 #define _(v,f,s) IPSEC_INTEG_ALG_##f = v,
  96   foreach_ipsec_integ_alg
  97 #undef _
  98     IPSEC_INTEG_N_ALG,
  99 } ipsec_integ_alg_t;
 100
 101 typedef enum
 102 {
 103   IPSEC_PROTOCOL_AH = 0,
 104   IPSEC_PROTOCOL_ESP = 1
 105 } ipsec_protocol_t;
 106
 107 typedef struct
 108 {
 109   u32 id;
 110   u32 spi;
 111   ipsec_protocol_t protocol;
 112
 113   ipsec_crypto_alg_t crypto_alg;
 114   u8 crypto_key_len;
 115   u8 crypto_key[128];
 116
 117   ipsec_integ_alg_t integ_alg;
 118   u8 integ_key_len;
 119   u8 integ_key[128];
 120
 121   u8 use_esn;
 122   u8 use_anti_replay;
 123
 124   u8 is_tunnel;
 125   u8 is_tunnel_ip6;
 126   ip46_address_t tunnel_src_addr;
 127   ip46_address_t tunnel_dst_addr;
 128
 129   u32 salt;
 130
 131   /* runtime */
 132   u32 seq;
 133   u32 seq_hi;
 134   u32 last_seq;
 135   u32 last_seq_hi;
 136   u64 replay_window;
 137
 138   /*lifetime data */
 139   u64 total_data_size;
 140 } ipsec_sa_t;
 141
 142 typedef struct
 143 {
 144   ip46_address_t start, stop;
 145 } ip46_address_range_t;
 146
 147 typedef struct
 148 {
 149   u16 start, stop;
 150 } port_range_t;
 151
 152 typedef struct
 153 {
 154   u8 is_add;
 155   u8 esn;
 156   u8 anti_replay;
 157   ip4_address_t local_ip, remote_ip;
 158   u32 local_spi;
 159   u32 remote_spi;
 160   ipsec_crypto_alg_t crypto_alg;
 161   u8 local_crypto_key_len;
 162   u8 local_crypto_key[128];
 163   u8 remote_crypto_key_len;
 164   u8 remote_crypto_key[128];
 165   ipsec_integ_alg_t integ_alg;
 166   u8 local_integ_key_len;
 167   u8 local_integ_key[128];
 168   u8 remote_integ_key_len;
 169   u8 remote_integ_key[128];
 170 } ipsec_add_del_tunnel_args_t;
 171
 172 typedef struct
 173 {
 174   u8 is_add;
 175   u32 local_sa_id;
 176   u32 remote_sa_id;
 177   ip4_address_t local_ip;
 178   ip4_address_t remote_ip;
 179 } ipsec_add_del_ipsec_gre_tunnel_args_t;
 180
 181 typedef enum
 182 {
 183   IPSEC_IF_SET_KEY_TYPE_NONE,
 184   IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO,
 185   IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO,
 186   IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG,
 187   IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG,
 188 } ipsec_if_set_key_type_t;
 189
 190 typedef struct
 191 {
 192   u32 id;
 193   i32 priority;
 194   u8 is_outbound;
 195
 196   // Selector
 197   u8 is_ipv6;
 198   ip46_address_range_t laddr;
 199   ip46_address_range_t raddr;
 200   u8 protocol;
 201   port_range_t lport;
 202   port_range_t rport;
 203
 204   // Policy
 205   u8 policy;
 206   u32 sa_id;
 207   u32 sa_index;
 208
 209   // Counter
 210   vlib_counter_t counter;
 211 } ipsec_policy_t;
 212
 213 typedef struct
 214 {
 215   u32 id;
 216   /* pool of policies */
 217   ipsec_policy_t *policies;
 218   /* vectors of policy indices */
 219   u32 *ipv4_outbound_policies;
 220   u32 *ipv6_outbound_policies;
 221   u32 *ipv4_inbound_protect_policy_indices;
 222   u32 *ipv4_inbound_policy_discard_and_bypass_indices;
 223   u32 *ipv6_inbound_protect_policy_indices;
 224   u32 *ipv6_inbound_policy_discard_and_bypass_indices;
 225 } ipsec_spd_t;
 226
 227 typedef struct
 228 {
 229   u32 spd_index;
 230 } ip4_ipsec_config_t;
 231
 232 typedef struct
 233 {
 234   u32 spd_index;
 235 } ip6_ipsec_config_t;
 236
 237 typedef struct
 238 {
 239   u32 input_sa_index;
 240   u32 output_sa_index;
 241   u32 hw_if_index;
 242 } ipsec_tunnel_if_t;
 243
 244 typedef struct
 245 {
 246   clib_error_t *(*add_del_sa_sess_cb) (u32 sa_index, u8 is_add);
 247   clib_error_t *(*check_support_cb) (ipsec_sa_t * sa);
 248 } ipsec_main_callbacks_t;
 249
 250 typedef struct
 251 {
 252   /* pool of tunnel instances */
 253   ipsec_spd_t *spds;
 254   ipsec_sa_t *sad;
 255
 256   /* pool of tunnel interfaces */
 257   ipsec_tunnel_if_t *tunnel_interfaces;
 258   u32 *free_tunnel_if_indices;
 259
 260   u32 **empty_buffers;
 261
 262   uword *tunnel_index_by_key;
 263
 264   /* convenience */
 265   vlib_main_t *vlib_main;
 266   vnet_main_t *vnet_main;
 267
 268   /* next node indices */
 269   u32 feature_next_node_index[32];
 270
 271   /* hashes */
 272   uword *spd_index_by_spd_id;
 273   uword *spd_index_by_sw_if_index;
 274   uword *sa_index_by_sa_id;
 275   uword *ipsec_if_pool_index_by_key;
 276
 277   /* node indeces */
 278   u32 error_drop_node_index;
 279   u32 esp_encrypt_node_index;
 280   u32 esp_decrypt_node_index;
 281   /* next node indeces */
 282   u32 esp_encrypt_next_index;
 283   u32 esp_decrypt_next_index;
 284
 285   /* callbacks */
 286   ipsec_main_callbacks_t cb;
 287 } ipsec_main_t;
 288
 289 ipsec_main_t ipsec_main;
 290
 291 extern vlib_node_registration_t esp_encrypt_node;
 292 extern vlib_node_registration_t esp_decrypt_node;
 293 extern vlib_node_registration_t ipsec_if_output_node;
 294 extern vlib_node_registration_t ipsec_if_input_node;
 295
 296
 297 /*
 298  * functions
 299  */
 300 int ipsec_set_interface_spd (vlib_main_t * vm, u32 sw_if_index, u32 spd_id,
 301                              int is_add);
 302 int ipsec_add_del_spd (vlib_main_t * vm, u32 spd_id, int is_add);
 303 int ipsec_add_del_policy (vlib_main_t * vm, ipsec_policy_t * policy,
 304                           int is_add);
 305 int ipsec_add_del_sa (vlib_main_t * vm, ipsec_sa_t * new_sa, int is_add);
 306 int ipsec_set_sa_key (vlib_main_t * vm, ipsec_sa_t * sa_update);
 307
 308 u32 ipsec_get_sa_index_by_sa_id (u32 sa_id);
 309 u8 *format_ipsec_if_output_trace (u8 * s, va_list * args);
 310 u8 *format_ipsec_policy_action (u8 * s, va_list * args);
 311 u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
 312 u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
 313 u8 *format_ipsec_replay_window (u8 * s, va_list * args);
 314 uword unformat_ipsec_policy_action (unformat_input_t * input, va_list * args);
 315 uword unformat_ipsec_crypto_alg (unformat_input_t * input, va_list * args);
 316 uword unformat_ipsec_integ_alg (unformat_input_t * input, va_list * args);
 317
 318 int ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
 319                                       ipsec_add_del_tunnel_args_t * args,
 320                                       u32 * sw_if_index);
 321 int ipsec_add_del_tunnel_if (ipsec_add_del_tunnel_args_t * args);
 322 int ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
 323                                     ipsec_add_del_ipsec_gre_tunnel_args_t *
 324                                     args);
 325 int ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
 326                              ipsec_if_set_key_type_t type, u8 alg, u8 * key);
 327
 328
 329 /*
 330  *  inline functions
 331  */
 332
 333 always_inline void
 334 ipsec_alloc_empty_buffers (vlib_main_t * vm, ipsec_main_t * im)
 335 {
 336   u32 thread_index = vlib_get_thread_index ();
 337   uword l = vec_len (im->empty_buffers[thread_index]);
 338   uword n_alloc = 0;
 339
 340   if (PREDICT_FALSE (l < VLIB_FRAME_SIZE))
 341     {
 342       if (!im->empty_buffers[thread_index])
 343         {
 344           vec_alloc (im->empty_buffers[thread_index], 2 * VLIB_FRAME_SIZE);
 345         }
 346
 347       n_alloc = vlib_buffer_alloc (vm, im->empty_buffers[thread_index] + l,
 348                                    2 * VLIB_FRAME_SIZE - l);
 349
 350       _vec_len (im->empty_buffers[thread_index]) = l + n_alloc;
 351     }
 352 }
 353
 354 static_always_inline u32
 355 get_next_output_feature_node_index (vlib_buffer_t * b,
 356                                     vlib_node_runtime_t * nr)
 357 {
 358   u32 next;
 359   u32 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
 360   vlib_main_t *vm = vlib_get_main ();
 361   vlib_node_t *node = vlib_get_node (vm, nr->node_index);
 362
 363   vnet_feature_next (sw_if_index, &next, b);
 364   return node->next_nodes[next];
 365 }
 366
 367 #endif /* __IPSEC_H__ */
 368
 369 /*
 370  * fd.io coding-style-patch-verification: ON
 371  *
 372  * Local Variables:
 373  * eval: (c-set-style "gnu")
 374  * End:
 375  */