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   if (~0 == sa->crypto_key_index)
 174     return VNET_API_ERROR_INVALID_VALUE;
 175
 176   sa->integ_key_index = vnet_crypto_key_add (vm,
 177                                              im->integ_algs[integ_alg].alg,
 178                                              (u8 *) ik->data, ik->len);
 179   if (~0 == sa->integ_key_index)
 180     return VNET_API_ERROR_INVALID_VALUE;
 181
 182   err = ipsec_check_support_cb (im, sa);
 183   if (err)
 184     {
 185       clib_warning ("%s", err->what);
 186       pool_put (im->sad, sa);
 187       return VNET_API_ERROR_UNIMPLEMENTED;
 188     }
 189
 190   err = ipsec_call_add_del_callbacks (im, sa, sa_index, 1);
 191   if (err)
 192     {
 193       pool_put (im->sad, sa);
 194       return VNET_API_ERROR_SYSCALL_ERROR_1;
 195     }
 196
 197   if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
 198     {
 199       fib_protocol_t fproto = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
 200                                FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4);
 201       fib_prefix_t pfx = {
 202         .fp_addr = sa->tunnel_dst_addr,
 203         .fp_len = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ? 128 : 32),
 204         .fp_proto = fproto,
 205       };
 206       sa->tx_fib_index = fib_table_find (fproto, tx_table_id);
 207       if (sa->tx_fib_index == ~((u32) 0))
 208         {
 209           pool_put (im->sad, sa);
 210           return VNET_API_ERROR_NO_SUCH_FIB;
 211         }
 212
 213       sa->fib_entry_index = fib_table_entry_special_add (sa->tx_fib_index,
 214                                                          &pfx,
 215                                                          FIB_SOURCE_RR,
 216                                                          FIB_ENTRY_FLAG_NONE);
 217       sa->sibling = fib_entry_child_add (sa->fib_entry_index,
 218                                          FIB_NODE_TYPE_IPSEC_SA, sa_index);
 219       ipsec_sa_stack (sa);
 220
 221       /* generate header templates */
 222       if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
 223         {
 224           sa->ip6_hdr.ip_version_traffic_class_and_flow_label = 0x60;
 225           sa->ip6_hdr.hop_limit = 254;
 226           sa->ip6_hdr.src_address.as_u64[0] =
 227             sa->tunnel_src_addr.ip6.as_u64[0];
 228           sa->ip6_hdr.src_address.as_u64[1] =
 229             sa->tunnel_src_addr.ip6.as_u64[1];
 230           sa->ip6_hdr.dst_address.as_u64[0] =
 231             sa->tunnel_dst_addr.ip6.as_u64[0];
 232           sa->ip6_hdr.dst_address.as_u64[1] =
 233             sa->tunnel_dst_addr.ip6.as_u64[1];
 234           if (ipsec_sa_is_set_UDP_ENCAP (sa))
 235             sa->ip6_hdr.protocol = IP_PROTOCOL_UDP;
 236           else
 237             sa->ip6_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
 238         }
 239       else
 240         {
 241           sa->ip4_hdr.ip_version_and_header_length = 0x45;
 242           sa->ip4_hdr.ttl = 254;
 243           sa->ip4_hdr.src_address.as_u32 = sa->tunnel_src_addr.ip4.as_u32;
 244           sa->ip4_hdr.dst_address.as_u32 = sa->tunnel_dst_addr.ip4.as_u32;
 245
 246           if (ipsec_sa_is_set_UDP_ENCAP (sa))
 247             sa->ip4_hdr.protocol = IP_PROTOCOL_UDP;
 248           else
 249             sa->ip4_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
 250           sa->ip4_hdr.checksum = ip4_header_checksum (&sa->ip4_hdr);
 251         }
 252     }
 253
 254   if (ipsec_sa_is_set_UDP_ENCAP (sa))
 255     {
 256       sa->udp_hdr.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
 257       sa->udp_hdr.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
 258     }
 259
 260   hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
 261
 262   if (sa_out_index)
 263     *sa_out_index = sa_index;
 264
 265   return (0);
 266 }
 267
 268 u32
 269 ipsec_sa_del (u32 id)
 270 {
 271   vlib_main_t *vm = vlib_get_main ();
 272   ipsec_main_t *im = &ipsec_main;
 273   ipsec_sa_t *sa = 0;
 274   uword *p;
 275   u32 sa_index;
 276   clib_error_t *err;
 277
 278   p = hash_get (im->sa_index_by_sa_id, id);
 279
 280   if (!p)
 281     return VNET_API_ERROR_NO_SUCH_ENTRY;
 282
 283   sa_index = p[0];
 284   sa = pool_elt_at_index (im->sad, sa_index);
 285   if (ipsec_is_sa_used (sa_index))
 286     {
 287       clib_warning ("sa_id %u used in policy", sa->id);
 288       /* sa used in policy */
 289       return VNET_API_ERROR_SYSCALL_ERROR_1;
 290     }
 291   hash_unset (im->sa_index_by_sa_id, sa->id);
 292   err = ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
 293   if (err)
 294     return VNET_API_ERROR_SYSCALL_ERROR_2;
 295
 296   if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
 297     {
 298       fib_entry_child_remove (sa->fib_entry_index, sa->sibling);
 299       fib_table_entry_special_remove
 300         (sa->tx_fib_index,
 301          fib_entry_get_prefix (sa->fib_entry_index), FIB_SOURCE_RR);
 302       dpo_reset (&sa->dpo[IPSEC_PROTOCOL_AH]);
 303       dpo_reset (&sa->dpo[IPSEC_PROTOCOL_ESP]);
 304     }
 305   vnet_crypto_key_del (vm, sa->crypto_key_index);
 306   vnet_crypto_key_del (vm, sa->integ_key_index);
 307   pool_put (im->sad, sa);
 308   return 0;
 309 }
 310
 311 u8
 312 ipsec_is_sa_used (u32 sa_index)
 313 {
 314   ipsec_main_t *im = &ipsec_main;
 315   ipsec_tunnel_if_t *t;
 316   ipsec_policy_t *p;
 317
 318   /* *INDENT-OFF* */
 319   pool_foreach(p, im->policies, ({
 320      if (p->policy == IPSEC_POLICY_ACTION_PROTECT)
 321        {
 322          if (p->sa_index == sa_index)
 323            return 1;
 324        }
 325   }));
 326
 327   pool_foreach(t, im->tunnel_interfaces, ({
 328     if (t->input_sa_index == sa_index)
 329       return 1;
 330     if (t->output_sa_index == sa_index)
 331       return 1;
 332   }));
 333   /* *INDENT-ON* */
 334
 335   return 0;
 336 }
 337
 338 int
 339 ipsec_set_sa_key (u32 id, const ipsec_key_t * ck, const ipsec_key_t * ik)
 340 {
 341   vlib_main_t *vm = vlib_get_main ();
 342   ipsec_main_t *im = &ipsec_main;
 343   uword *p;
 344   u32 sa_index;
 345   ipsec_sa_t *sa = 0;
 346   clib_error_t *err;
 347
 348   p = hash_get (im->sa_index_by_sa_id, id);
 349   if (!p)
 350     return VNET_API_ERROR_SYSCALL_ERROR_1;      /* no such sa-id */
 351
 352   sa_index = p[0];
 353   sa = pool_elt_at_index (im->sad, sa_index);
 354
 355   /* new crypto key */
 356   if (ck)
 357     {
 358       clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
 359       vnet_crypto_key_modify (vm, sa->crypto_key_index, sa->crypto_calg,
 360                               (u8 *) ck->data, ck->len);
 361     }
 362
 363   /* new integ key */
 364   if (ik)
 365     {
 366       clib_memcpy (&sa->integ_key, 0, sizeof (sa->integ_key));
 367       vnet_crypto_key_modify (vm, sa->integ_key_index, sa->integ_calg,
 368                               (u8 *) ik->data, ik->len);
 369     }
 370
 371   if (ck || ik)
 372     {
 373       err = ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
 374       if (err)
 375         {
 376           clib_error_free (err);
 377           return VNET_API_ERROR_SYSCALL_ERROR_1;
 378         }
 379     }
 380
 381   return 0;
 382 }
 383
 384 u32
 385 ipsec_get_sa_index_by_sa_id (u32 sa_id)
 386 {
 387   ipsec_main_t *im = &ipsec_main;
 388   uword *p = hash_get (im->sa_index_by_sa_id, sa_id);
 389   if (!p)
 390     return ~0;
 391
 392   return p[0];
 393 }
 394
 395 void
 396 ipsec_sa_walk (ipsec_sa_walk_cb_t cb, void *ctx)
 397 {
 398   ipsec_main_t *im = &ipsec_main;
 399   ipsec_sa_t *sa;
 400
 401   /* *INDENT-OFF* */
 402   pool_foreach (sa, im->sad,
 403   ({
 404     if (WALK_CONTINUE != cb(sa, ctx))
 405       break;
 406   }));
 407   /* *INDENT-ON* */
 408 }
 409
 410 /**
 411  * Function definition to get a FIB node from its index
 412  */
 413 static fib_node_t *
 414 ipsec_sa_fib_node_get (fib_node_index_t index)
 415 {
 416   ipsec_main_t *im;
 417   ipsec_sa_t *sa;
 418
 419   im = &ipsec_main;
 420   sa = pool_elt_at_index (im->sad, index);
 421
 422   return (&sa->node);
 423 }
 424
 425 /**
 426  * Function definition to inform the FIB node that its last lock has gone.
 427  */
 428 static void
 429 ipsec_sa_last_lock_gone (fib_node_t * node)
 430 {
 431   /*
 432    * The ipsec SA is a root of the graph. As such
 433    * it never has children and thus is never locked.
 434    */
 435   ASSERT (0);
 436 }
 437
 438 static ipsec_sa_t *
 439 ipsec_sa_from_fib_node (fib_node_t * node)
 440 {
 441   ASSERT (FIB_NODE_TYPE_IPSEC_SA == node->fn_type);
 442   return ((ipsec_sa_t *) (((char *) node) -
 443                           STRUCT_OFFSET_OF (ipsec_sa_t, node)));
 444
 445 }
 446
 447 /**
 448  * Function definition to backwalk a FIB node
 449  */
 450 static fib_node_back_walk_rc_t
 451 ipsec_sa_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
 452 {
 453   ipsec_sa_stack (ipsec_sa_from_fib_node (node));
 454
 455   return (FIB_NODE_BACK_WALK_CONTINUE);
 456 }
 457
 458 /*
 459  * Virtual function table registered by MPLS GRE tunnels
 460  * for participation in the FIB object graph.
 461  */
 462 const static fib_node_vft_t ipsec_sa_vft = {
 463   .fnv_get = ipsec_sa_fib_node_get,
 464   .fnv_last_lock = ipsec_sa_last_lock_gone,
 465   .fnv_back_walk = ipsec_sa_back_walk,
 466 };
 467
 468 /* force inclusion from application's main.c */
 469 clib_error_t *
 470 ipsec_sa_interface_init (vlib_main_t * vm)
 471 {
 472   fib_node_register_type (FIB_NODE_TYPE_IPSEC_SA, &ipsec_sa_vft);
 473
 474   return 0;
 475 }
 476
 477 VLIB_INIT_FUNCTION (ipsec_sa_interface_init);
 478
 479 /*
 480  * fd.io coding-style-patch-verification: ON
 481  *
 482  * Local Variables:
 483  * eval: (c-set-style "gnu")
 484  * End:
 485  */