src/vnet/ipsec/ipsec_sa.c

   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
  16 #include <vnet/ipsec/ipsec.h>
  17 #include <vnet/ipsec/esp.h>
  18 #include <vnet/udp/udp.h>
  19 #include <vnet/fib/fib_table.h>
  20 #include <vnet/fib/fib_entry_track.h>
  21 #include <vnet/ipsec/ipsec_tun.h>
  22
  23 /**
  24  * @brief
  25  * SA packet & bytes counters
  26  */
  27 vlib_combined_counter_main_t ipsec_sa_counters = {
  28   .name = "SA",
  29   .stat_segment_name = "/net/ipsec/sa",
  30 };
  31
  32
  33 static clib_error_t *
  34 ipsec_call_add_del_callbacks (ipsec_main_t * im, ipsec_sa_t * sa,
  35                               u32 sa_index, int is_add)
  36 {
  37   ipsec_ah_backend_t *ab;
  38   ipsec_esp_backend_t *eb;
  39   switch (sa->protocol)
  40     {
  41     case IPSEC_PROTOCOL_AH:
  42       ab = pool_elt_at_index (im->ah_backends, im->ah_current_backend);
  43       if (ab->add_del_sa_sess_cb)
  44         return ab->add_del_sa_sess_cb (sa_index, is_add);
  45       break;
  46     case IPSEC_PROTOCOL_ESP:
  47       eb = pool_elt_at_index (im->esp_backends, im->esp_current_backend);
  48       if (eb->add_del_sa_sess_cb)
  49         return eb->add_del_sa_sess_cb (sa_index, is_add);
  50       break;
  51     }
  52   return 0;
  53 }
  54
  55 void
  56 ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len)
  57 {
  58   memset (key, 0, sizeof (*key));
  59
  60   if (len > sizeof (key->data))
  61     key->len = sizeof (key->data);
  62   else
  63     key->len = len;
  64
  65   memcpy (key->data, data, key->len);
  66 }
  67
  68 /**
  69  * 'stack' (resolve the recursion for) the SA tunnel destination
  70  */
  71 static void
  72 ipsec_sa_stack (ipsec_sa_t * sa)
  73 {
  74   ipsec_main_t *im = &ipsec_main;
  75   fib_forward_chain_type_t fct;
  76   dpo_id_t tmp = DPO_INVALID;
  77
  78   fct =
  79     fib_forw_chain_type_from_fib_proto ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
  80                                          FIB_PROTOCOL_IP6 :
  81                                          FIB_PROTOCOL_IP4));
  82
  83   fib_entry_contribute_forwarding (sa->fib_entry_index, fct, &tmp);
  84
  85   if (IPSEC_PROTOCOL_AH == sa->protocol)
  86     dpo_stack_from_node ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
  87                           im->ah6_encrypt_node_index :
  88                           im->ah4_encrypt_node_index), &sa->dpo, &tmp);
  89   else
  90     dpo_stack_from_node ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
  91                           im->esp6_encrypt_node_index :
  92                           im->esp4_encrypt_node_index), &sa->dpo, &tmp);
  93   dpo_reset (&tmp);
  94 }
  95
  96 void
  97 ipsec_sa_set_crypto_alg (ipsec_sa_t * sa, ipsec_crypto_alg_t crypto_alg)
  98 {
  99   ipsec_main_t *im = &ipsec_main;
 100   sa->crypto_alg = crypto_alg;
 101   sa->crypto_iv_size = im->crypto_algs[crypto_alg].iv_size;
 102   sa->crypto_block_size = im->crypto_algs[crypto_alg].block_size;
 103   sa->crypto_enc_op_id = im->crypto_algs[crypto_alg].enc_op_id;
 104   sa->crypto_dec_op_id = im->crypto_algs[crypto_alg].dec_op_id;
 105   sa->crypto_calg = im->crypto_algs[crypto_alg].alg;
 106   ASSERT (sa->crypto_iv_size <= ESP_MAX_IV_SIZE);
 107   ASSERT (sa->crypto_block_size <= ESP_MAX_BLOCK_SIZE);
 108   if (IPSEC_CRYPTO_ALG_IS_GCM (crypto_alg))
 109     {
 110       sa->integ_icv_size = im->crypto_algs[crypto_alg].icv_size;
 111       ipsec_sa_set_IS_AEAD (sa);
 112     }
 113 }
 114
 115 void
 116 ipsec_sa_set_integ_alg (ipsec_sa_t * sa, ipsec_integ_alg_t integ_alg)
 117 {
 118   ipsec_main_t *im = &ipsec_main;
 119   sa->integ_alg = integ_alg;
 120   sa->integ_icv_size = im->integ_algs[integ_alg].icv_size;
 121   sa->integ_op_id = im->integ_algs[integ_alg].op_id;
 122   sa->integ_calg = im->integ_algs[integ_alg].alg;
 123   ASSERT (sa->integ_icv_size <= ESP_MAX_ICV_SIZE);
 124 }
 125
 126 int
 127 ipsec_sa_add_and_lock (u32 id,
 128                        u32 spi,
 129                        ipsec_protocol_t proto,
 130                        ipsec_crypto_alg_t crypto_alg,
 131                        const ipsec_key_t * ck,
 132                        ipsec_integ_alg_t integ_alg,
 133                        const ipsec_key_t * ik,
 134                        ipsec_sa_flags_t flags,
 135                        u32 tx_table_id,
 136                        u32 salt,
 137                        const ip46_address_t * tun_src,
 138                        const ip46_address_t * tun_dst, u32 * sa_out_index)
 139 {
 140   vlib_main_t *vm = vlib_get_main ();
 141   ipsec_main_t *im = &ipsec_main;
 142   clib_error_t *err;
 143   ipsec_sa_t *sa;
 144   u32 sa_index;
 145   uword *p;
 146
 147   p = hash_get (im->sa_index_by_sa_id, id);
 148   if (p)
 149     return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
 150
 151   pool_get_aligned_zero (im->sad, sa, CLIB_CACHE_LINE_BYTES);
 152
 153   fib_node_init (&sa->node, FIB_NODE_TYPE_IPSEC_SA);
 154   fib_node_lock (&sa->node);
 155   sa_index = sa - im->sad;
 156
 157   vlib_validate_combined_counter (&ipsec_sa_counters, sa_index);
 158   vlib_zero_combined_counter (&ipsec_sa_counters, sa_index);
 159
 160   sa->id = id;
 161   sa->spi = spi;
 162   sa->stat_index = sa_index;
 163   sa->protocol = proto;
 164   sa->flags = flags;
 165   sa->salt = salt;
 166   if (integ_alg != IPSEC_INTEG_ALG_NONE)
 167     {
 168       ipsec_sa_set_integ_alg (sa, integ_alg);
 169       clib_memcpy (&sa->integ_key, ik, sizeof (sa->integ_key));
 170     }
 171   ipsec_sa_set_crypto_alg (sa, crypto_alg);
 172   clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
 173   ip46_address_copy (&sa->tunnel_src_addr, tun_src);
 174   ip46_address_copy (&sa->tunnel_dst_addr, tun_dst);
 175
 176   sa->crypto_key_index = vnet_crypto_key_add (vm,
 177                                               im->crypto_algs[crypto_alg].alg,
 178                                               (u8 *) ck->data, ck->len);
 179   if (~0 == sa->crypto_key_index)
 180     {
 181       pool_put (im->sad, sa);
 182       return VNET_API_ERROR_KEY_LENGTH;
 183     }
 184
 185   if (integ_alg != IPSEC_INTEG_ALG_NONE)
 186     {
 187       sa->integ_key_index = vnet_crypto_key_add (vm,
 188                                                  im->
 189                                                  integ_algs[integ_alg].alg,
 190                                                  (u8 *) ik->data, ik->len);
 191       if (~0 == sa->integ_key_index)
 192         {
 193           pool_put (im->sad, sa);
 194           return VNET_API_ERROR_KEY_LENGTH;
 195         }
 196     }
 197
 198   err = ipsec_check_support_cb (im, sa);
 199   if (err)
 200     {
 201       clib_warning ("%s", err->what);
 202       pool_put (im->sad, sa);
 203       return VNET_API_ERROR_UNIMPLEMENTED;
 204     }
 205
 206   err = ipsec_call_add_del_callbacks (im, sa, sa_index, 1);
 207   if (err)
 208     {
 209       pool_put (im->sad, sa);
 210       return VNET_API_ERROR_SYSCALL_ERROR_1;
 211     }
 212
 213   if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
 214     {
 215       fib_protocol_t fproto = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
 216                                FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4);
 217       fib_prefix_t pfx = {
 218         .fp_addr = sa->tunnel_dst_addr,
 219         .fp_len = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ? 128 : 32),
 220         .fp_proto = fproto,
 221       };
 222       sa->tx_fib_index = fib_table_find (fproto, tx_table_id);
 223       if (sa->tx_fib_index == ~((u32) 0))
 224         {
 225           pool_put (im->sad, sa);
 226           return VNET_API_ERROR_NO_SUCH_FIB;
 227         }
 228
 229       sa->fib_entry_index = fib_entry_track (sa->tx_fib_index,
 230                                              &pfx,
 231                                              FIB_NODE_TYPE_IPSEC_SA,
 232                                              sa_index, &sa->sibling);
 233       ipsec_sa_stack (sa);
 234
 235       /* generate header templates */
 236       if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
 237         {
 238           sa->ip6_hdr.ip_version_traffic_class_and_flow_label = 0x60;
 239           sa->ip6_hdr.hop_limit = 254;
 240           sa->ip6_hdr.src_address.as_u64[0] =
 241             sa->tunnel_src_addr.ip6.as_u64[0];
 242           sa->ip6_hdr.src_address.as_u64[1] =
 243             sa->tunnel_src_addr.ip6.as_u64[1];
 244           sa->ip6_hdr.dst_address.as_u64[0] =
 245             sa->tunnel_dst_addr.ip6.as_u64[0];
 246           sa->ip6_hdr.dst_address.as_u64[1] =
 247             sa->tunnel_dst_addr.ip6.as_u64[1];
 248           if (ipsec_sa_is_set_UDP_ENCAP (sa))
 249             sa->ip6_hdr.protocol = IP_PROTOCOL_UDP;
 250           else
 251             sa->ip6_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
 252         }
 253       else
 254         {
 255           sa->ip4_hdr.ip_version_and_header_length = 0x45;
 256           sa->ip4_hdr.ttl = 254;
 257           sa->ip4_hdr.src_address.as_u32 = sa->tunnel_src_addr.ip4.as_u32;
 258           sa->ip4_hdr.dst_address.as_u32 = sa->tunnel_dst_addr.ip4.as_u32;
 259
 260           if (ipsec_sa_is_set_UDP_ENCAP (sa))
 261             sa->ip4_hdr.protocol = IP_PROTOCOL_UDP;
 262           else
 263             sa->ip4_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
 264           sa->ip4_hdr.checksum = ip4_header_checksum (&sa->ip4_hdr);
 265         }
 266     }
 267
 268   if (ipsec_sa_is_set_UDP_ENCAP (sa))
 269     {
 270       sa->udp_hdr.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
 271       sa->udp_hdr.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
 272     }
 273
 274   hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
 275
 276   if (sa_out_index)
 277     *sa_out_index = sa_index;
 278
 279   return (0);
 280 }
 281
 282 static void
 283 ipsec_sa_del (ipsec_sa_t * sa)
 284 {
 285   vlib_main_t *vm = vlib_get_main ();
 286   ipsec_main_t *im = &ipsec_main;
 287   u32 sa_index;
 288
 289   sa_index = sa - im->sad;
 290   hash_unset (im->sa_index_by_sa_id, sa->id);
 291
 292   /* no recovery possible when deleting an SA */
 293   (void) ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
 294
 295   if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
 296     {
 297       fib_entry_untrack (sa->fib_entry_index, sa->sibling);
 298       dpo_reset (&sa->dpo);
 299     }
 300   vnet_crypto_key_del (vm, sa->crypto_key_index);
 301   if (sa->integ_alg != IPSEC_INTEG_ALG_NONE)
 302     vnet_crypto_key_del (vm, sa->integ_key_index);
 303   pool_put (im->sad, sa);
 304 }
 305
 306 void
 307 ipsec_sa_unlock (index_t sai)
 308 {
 309   ipsec_main_t *im = &ipsec_main;
 310   ipsec_sa_t *sa;
 311
 312   if (INDEX_INVALID == sai)
 313     return;
 314
 315   sa = pool_elt_at_index (im->sad, sai);
 316
 317   fib_node_unlock (&sa->node);
 318 }
 319
 320 void
 321 ipsec_sa_lock (index_t sai)
 322 {
 323   ipsec_main_t *im = &ipsec_main;
 324   ipsec_sa_t *sa;
 325
 326   if (INDEX_INVALID == sai)
 327     return;
 328
 329   sa = pool_elt_at_index (im->sad, sai);
 330
 331   fib_node_lock (&sa->node);
 332 }
 333
 334 index_t
 335 ipsec_sa_find_and_lock (u32 id)
 336 {
 337   ipsec_main_t *im = &ipsec_main;
 338   ipsec_sa_t *sa;
 339   uword *p;
 340
 341   p = hash_get (im->sa_index_by_sa_id, id);
 342
 343   if (!p)
 344     return INDEX_INVALID;
 345
 346   sa = pool_elt_at_index (im->sad, p[0]);
 347
 348   fib_node_lock (&sa->node);
 349
 350   return (p[0]);
 351 }
 352
 353 int
 354 ipsec_sa_unlock_id (u32 id)
 355 {
 356   ipsec_main_t *im = &ipsec_main;
 357   uword *p;
 358
 359   p = hash_get (im->sa_index_by_sa_id, id);
 360
 361   if (!p)
 362     return VNET_API_ERROR_NO_SUCH_ENTRY;
 363
 364   ipsec_sa_unlock (p[0]);
 365
 366   return (0);
 367 }
 368
 369 void
 370 ipsec_sa_clear (index_t sai)
 371 {
 372   vlib_zero_combined_counter (&ipsec_sa_counters, sai);
 373 }
 374
 375 void
 376 ipsec_sa_walk (ipsec_sa_walk_cb_t cb, void *ctx)
 377 {
 378   ipsec_main_t *im = &ipsec_main;
 379   ipsec_sa_t *sa;
 380
 381   /* *INDENT-OFF* */
 382   pool_foreach (sa, im->sad,
 383   ({
 384     if (WALK_CONTINUE != cb(sa, ctx))
 385       break;
 386   }));
 387   /* *INDENT-ON* */
 388 }
 389
 390 /**
 391  * Function definition to get a FIB node from its index
 392  */
 393 static fib_node_t *
 394 ipsec_sa_fib_node_get (fib_node_index_t index)
 395 {
 396   ipsec_main_t *im;
 397   ipsec_sa_t *sa;
 398
 399   im = &ipsec_main;
 400   sa = pool_elt_at_index (im->sad, index);
 401
 402   return (&sa->node);
 403 }
 404
 405 static ipsec_sa_t *
 406 ipsec_sa_from_fib_node (fib_node_t * node)
 407 {
 408   ASSERT (FIB_NODE_TYPE_IPSEC_SA == node->fn_type);
 409   return ((ipsec_sa_t *) (((char *) node) -
 410                           STRUCT_OFFSET_OF (ipsec_sa_t, node)));
 411
 412 }
 413
 414 /**
 415  * Function definition to inform the FIB node that its last lock has gone.
 416  */
 417 static void
 418 ipsec_sa_last_lock_gone (fib_node_t * node)
 419 {
 420   /*
 421    * The ipsec SA is a root of the graph. As such
 422    * it never has children and thus is never locked.
 423    */
 424   ipsec_sa_del (ipsec_sa_from_fib_node (node));
 425 }
 426
 427 /**
 428  * Function definition to backwalk a FIB node
 429  */
 430 static fib_node_back_walk_rc_t
 431 ipsec_sa_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
 432 {
 433   ipsec_sa_stack (ipsec_sa_from_fib_node (node));
 434
 435   return (FIB_NODE_BACK_WALK_CONTINUE);
 436 }
 437
 438 /*
 439  * Virtual function table registered by SAs
 440  * for participation in the FIB object graph.
 441  */
 442 const static fib_node_vft_t ipsec_sa_vft = {
 443   .fnv_get = ipsec_sa_fib_node_get,
 444   .fnv_last_lock = ipsec_sa_last_lock_gone,
 445   .fnv_back_walk = ipsec_sa_back_walk,
 446 };
 447
 448 /* force inclusion from application's main.c */
 449 clib_error_t *
 450 ipsec_sa_interface_init (vlib_main_t * vm)
 451 {
 452   fib_node_register_type (FIB_NODE_TYPE_IPSEC_SA, &ipsec_sa_vft);
 453
 454   return 0;
 455 }
 456
 457 VLIB_INIT_FUNCTION (ipsec_sa_interface_init);
 458
 459 /*
 460  * fd.io coding-style-patch-verification: ON
 461  *
 462  * Local Variables:
 463  * eval: (c-set-style "gnu")
 464  * End:
 465  */