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