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