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