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 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_type = im->crypto_algs[crypto_alg].enc_op_type;
 102   sa->crypto_dec_op_type = im->crypto_algs[crypto_alg].dec_op_type;
 103   ASSERT (sa->crypto_block_size <= ESP_MAX_BLOCK_SIZE);
 104 }
 105
 106 void
 107 ipsec_sa_set_integ_alg (ipsec_sa_t * sa, ipsec_integ_alg_t integ_alg)
 108 {
 109   ipsec_main_t *im = &ipsec_main;
 110   sa->integ_alg = integ_alg;
 111   sa->integ_trunc_size = im->integ_algs[integ_alg].trunc_size;
 112   sa->integ_op_type = im->integ_algs[integ_alg].op_type;
 113   ASSERT (sa->integ_trunc_size <= ESP_MAX_ICV_SIZE);
 114 }
 115
 116 int
 117 ipsec_sa_add (u32 id,
 118               u32 spi,
 119               ipsec_protocol_t proto,
 120               ipsec_crypto_alg_t crypto_alg,
 121               const ipsec_key_t * ck,
 122               ipsec_integ_alg_t integ_alg,
 123               const ipsec_key_t * ik,
 124               ipsec_sa_flags_t flags,
 125               u32 tx_table_id,
 126               const ip46_address_t * tun_src,
 127               const ip46_address_t * tun_dst, u32 * sa_out_index)
 128 {
 129   ipsec_main_t *im = &ipsec_main;
 130   clib_error_t *err;
 131   ipsec_sa_t *sa;
 132   u32 sa_index;
 133   uword *p;
 134
 135   p = hash_get (im->sa_index_by_sa_id, id);
 136   if (p)
 137     return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
 138
 139   pool_get_aligned_zero (im->sad, sa, CLIB_CACHE_LINE_BYTES);
 140
 141   fib_node_init (&sa->node, FIB_NODE_TYPE_IPSEC_SA);
 142   sa_index = sa - im->sad;
 143
 144   vlib_validate_combined_counter (&ipsec_sa_counters, sa_index);
 145   vlib_zero_combined_counter (&ipsec_sa_counters, sa_index);
 146
 147   sa->id = id;
 148   sa->spi = spi;
 149   sa->stat_index = sa_index;
 150   sa->protocol = proto;
 151   ipsec_sa_set_crypto_alg (sa, crypto_alg);
 152   clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
 153   ipsec_sa_set_integ_alg (sa, integ_alg);
 154   clib_memcpy (&sa->integ_key, ik, sizeof (sa->integ_key));
 155   ip46_address_copy (&sa->tunnel_src_addr, tun_src);
 156   ip46_address_copy (&sa->tunnel_dst_addr, tun_dst);
 157
 158   if (flags & IPSEC_SA_FLAG_USE_ESN)
 159     ipsec_sa_set_USE_ESN (sa);
 160   if (flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY)
 161     ipsec_sa_set_USE_ANTI_REPLAY (sa);
 162   if (flags & IPSEC_SA_FLAG_IS_TUNNEL)
 163     ipsec_sa_set_IS_TUNNEL (sa);
 164   if (flags & IPSEC_SA_FLAG_IS_TUNNEL_V6)
 165     ipsec_sa_set_IS_TUNNEL_V6 (sa);
 166   if (flags & IPSEC_SA_FLAG_UDP_ENCAP)
 167     ipsec_sa_set_UDP_ENCAP (sa);
 168
 169   err = ipsec_check_support_cb (im, sa);
 170   if (err)
 171     {
 172       clib_warning ("%s", err->what);
 173       pool_put (im->sad, sa);
 174       return VNET_API_ERROR_UNIMPLEMENTED;
 175     }
 176
 177   err = ipsec_call_add_del_callbacks (im, sa, sa_index, 1);
 178   if (err)
 179     {
 180       pool_put (im->sad, sa);
 181       return VNET_API_ERROR_SYSCALL_ERROR_1;
 182     }
 183
 184   if (ipsec_sa_is_set_IS_TUNNEL (sa))
 185     {
 186       fib_protocol_t fproto = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
 187                                FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4);
 188       fib_prefix_t pfx = {
 189         .fp_addr = sa->tunnel_dst_addr,
 190         .fp_len = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ? 128 : 32),
 191         .fp_proto = fproto,
 192       };
 193       sa->tx_fib_index = fib_table_find (fproto, tx_table_id);
 194       if (sa->tx_fib_index == ~((u32) 0))
 195         {
 196           pool_put (im->sad, sa);
 197           return VNET_API_ERROR_NO_SUCH_FIB;
 198         }
 199
 200       sa->fib_entry_index = fib_table_entry_special_add (sa->tx_fib_index,
 201                                                          &pfx,
 202                                                          FIB_SOURCE_RR,
 203                                                          FIB_ENTRY_FLAG_NONE);
 204       sa->sibling = fib_entry_child_add (sa->fib_entry_index,
 205                                          FIB_NODE_TYPE_IPSEC_SA, sa_index);
 206       ipsec_sa_stack (sa);
 207
 208       /* generate header templates */
 209       if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
 210         {
 211           sa->ip6_hdr.ip_version_traffic_class_and_flow_label = 0x60;
 212           sa->ip6_hdr.hop_limit = 254;
 213           sa->ip6_hdr.src_address.as_u64[0] =
 214             sa->tunnel_src_addr.ip6.as_u64[0];
 215           sa->ip6_hdr.src_address.as_u64[1] =
 216             sa->tunnel_src_addr.ip6.as_u64[1];
 217           sa->ip6_hdr.dst_address.as_u64[0] =
 218             sa->tunnel_dst_addr.ip6.as_u64[0];
 219           sa->ip6_hdr.dst_address.as_u64[1] =
 220             sa->tunnel_dst_addr.ip6.as_u64[1];
 221           if (ipsec_sa_is_set_UDP_ENCAP (sa))
 222             sa->ip6_hdr.protocol = IP_PROTOCOL_UDP;
 223           else
 224             sa->ip6_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
 225         }
 226       else
 227         {
 228           sa->ip4_hdr.ip_version_and_header_length = 0x45;
 229           sa->ip4_hdr.ttl = 254;
 230           sa->ip4_hdr.src_address.as_u32 = sa->tunnel_src_addr.ip4.as_u32;
 231           sa->ip4_hdr.dst_address.as_u32 = sa->tunnel_dst_addr.ip4.as_u32;
 232
 233           if (ipsec_sa_is_set_UDP_ENCAP (sa))
 234             sa->ip4_hdr.protocol = IP_PROTOCOL_UDP;
 235           else
 236             sa->ip4_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
 237           sa->ip4_hdr.checksum = ip4_header_checksum (&sa->ip4_hdr);
 238         }
 239     }
 240
 241   if (ipsec_sa_is_set_UDP_ENCAP (sa))
 242     {
 243       sa->udp_hdr.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
 244       sa->udp_hdr.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
 245     }
 246
 247   hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
 248
 249   if (sa_out_index)
 250     *sa_out_index = sa_index;
 251
 252   return (0);
 253 }
 254
 255 u32
 256 ipsec_sa_del (u32 id)
 257 {
 258   ipsec_main_t *im = &ipsec_main;
 259   ipsec_sa_t *sa = 0;
 260   uword *p;
 261   u32 sa_index;
 262   clib_error_t *err;
 263
 264   p = hash_get (im->sa_index_by_sa_id, id);
 265
 266   if (!p)
 267     return VNET_API_ERROR_NO_SUCH_ENTRY;
 268
 269   sa_index = p[0];
 270   sa = pool_elt_at_index (im->sad, sa_index);
 271   if (ipsec_is_sa_used (sa_index))
 272     {
 273       clib_warning ("sa_id %u used in policy", sa->id);
 274       /* sa used in policy */
 275       return VNET_API_ERROR_SYSCALL_ERROR_1;
 276     }
 277   hash_unset (im->sa_index_by_sa_id, sa->id);
 278   err = ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
 279   if (err)
 280     return VNET_API_ERROR_SYSCALL_ERROR_1;
 281
 282   if (ipsec_sa_is_set_IS_TUNNEL (sa))
 283     {
 284       fib_entry_child_remove (sa->fib_entry_index, sa->sibling);
 285       fib_table_entry_special_remove
 286         (sa->tx_fib_index,
 287          fib_entry_get_prefix (sa->fib_entry_index), FIB_SOURCE_RR);
 288       dpo_reset (&sa->dpo[IPSEC_PROTOCOL_AH]);
 289       dpo_reset (&sa->dpo[IPSEC_PROTOCOL_ESP]);
 290     }
 291   pool_put (im->sad, sa);
 292   return 0;
 293 }
 294
 295 u8
 296 ipsec_is_sa_used (u32 sa_index)
 297 {
 298   ipsec_main_t *im = &ipsec_main;
 299   ipsec_tunnel_if_t *t;
 300   ipsec_policy_t *p;
 301
 302   /* *INDENT-OFF* */
 303   pool_foreach(p, im->policies, ({
 304      if (p->policy == IPSEC_POLICY_ACTION_PROTECT)
 305        {
 306          if (p->sa_index == sa_index)
 307            return 1;
 308        }
 309   }));
 310
 311   pool_foreach(t, im->tunnel_interfaces, ({
 312     if (t->input_sa_index == sa_index)
 313       return 1;
 314     if (t->output_sa_index == sa_index)
 315       return 1;
 316   }));
 317   /* *INDENT-ON* */
 318
 319   return 0;
 320 }
 321
 322 int
 323 ipsec_set_sa_key (u32 id, const ipsec_key_t * ck, const ipsec_key_t * ik)
 324 {
 325   ipsec_main_t *im = &ipsec_main;
 326   uword *p;
 327   u32 sa_index;
 328   ipsec_sa_t *sa = 0;
 329   clib_error_t *err;
 330
 331   p = hash_get (im->sa_index_by_sa_id, id);
 332   if (!p)
 333     return VNET_API_ERROR_SYSCALL_ERROR_1;      /* no such sa-id */
 334
 335   sa_index = p[0];
 336   sa = pool_elt_at_index (im->sad, sa_index);
 337
 338   /* new crypto key */
 339   if (ck)
 340     {
 341       clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
 342     }
 343
 344   /* new integ key */
 345   if (ik)
 346     {
 347       clib_memcpy (&sa->integ_key, 0, sizeof (sa->integ_key));
 348     }
 349
 350   if (ck || ik)
 351     {
 352       err = ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
 353       if (err)
 354         {
 355           clib_error_free (err);
 356           return VNET_API_ERROR_SYSCALL_ERROR_1;
 357         }
 358     }
 359
 360   return 0;
 361 }
 362
 363 u32
 364 ipsec_get_sa_index_by_sa_id (u32 sa_id)
 365 {
 366   ipsec_main_t *im = &ipsec_main;
 367   uword *p = hash_get (im->sa_index_by_sa_id, sa_id);
 368   if (!p)
 369     return ~0;
 370
 371   return p[0];
 372 }
 373
 374 void
 375 ipsec_sa_walk (ipsec_sa_walk_cb_t cb, void *ctx)
 376 {
 377   ipsec_main_t *im = &ipsec_main;
 378   ipsec_sa_t *sa;
 379
 380   /* *INDENT-OFF* */
 381   pool_foreach (sa, im->sad,
 382   ({
 383     if (WALK_CONTINUE != cb(sa, ctx))
 384       break;
 385   }));
 386   /* *INDENT-ON* */
 387 }
 388
 389 /**
 390  * Function definition to get a FIB node from its index
 391  */
 392 static fib_node_t *
 393 ipsec_sa_fib_node_get (fib_node_index_t index)
 394 {
 395   ipsec_main_t *im;
 396   ipsec_sa_t *sa;
 397
 398   im = &ipsec_main;
 399   sa = pool_elt_at_index (im->sad, index);
 400
 401   return (&sa->node);
 402 }
 403
 404 /**
 405  * Function definition to inform the FIB node that its last lock has gone.
 406  */
 407 static void
 408 ipsec_sa_last_lock_gone (fib_node_t * node)
 409 {
 410   /*
 411    * The ipsec SA is a root of the graph. As such
 412    * it never has children and thus is never locked.
 413    */
 414   ASSERT (0);
 415 }
 416
 417 static ipsec_sa_t *
 418 ipsec_sa_from_fib_node (fib_node_t * node)
 419 {
 420   ASSERT (FIB_NODE_TYPE_IPSEC_SA == node->fn_type);
 421   return ((ipsec_sa_t *) (((char *) node) -
 422                           STRUCT_OFFSET_OF (ipsec_sa_t, node)));
 423
 424 }
 425
 426 /**
 427  * Function definition to backwalk a FIB node
 428  */
 429 static fib_node_back_walk_rc_t
 430 ipsec_sa_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
 431 {
 432   ipsec_sa_stack (ipsec_sa_from_fib_node (node));
 433
 434   return (FIB_NODE_BACK_WALK_CONTINUE);
 435 }
 436
 437 /*
 438  * Virtual function table registered by MPLS GRE tunnels
 439  * for participation in the FIB object graph.
 440  */
 441 const static fib_node_vft_t ipsec_sa_vft = {
 442   .fnv_get = ipsec_sa_fib_node_get,
 443   .fnv_last_lock = ipsec_sa_last_lock_gone,
 444   .fnv_back_walk = ipsec_sa_back_walk,
 445 };
 446
 447 /* force inclusion from application's main.c */
 448 clib_error_t *
 449 ipsec_sa_interface_init (vlib_main_t * vm)
 450 {
 451   fib_node_register_type (FIB_NODE_TYPE_IPSEC_SA, &ipsec_sa_vft);
 452
 453   return 0;
 454 }
 455
 456 VLIB_INIT_FUNCTION (ipsec_sa_interface_init);
 457
 458 /*
 459  * fd.io coding-style-patch-verification: ON
 460  *
 461  * Local Variables:
 462  * eval: (c-set-style "gnu")
 463  * End:
 464  */