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_trunc_size = im->integ_algs[integ_alg].trunc_size;
 113   sa->integ_op_type = im->integ_algs[integ_alg].op_type;
 114   ASSERT (sa->integ_trunc_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   ipsec_sa_set_crypto_alg (sa, crypto_alg);
 153   clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
 154   ipsec_sa_set_integ_alg (sa, integ_alg);
 155   clib_memcpy (&sa->integ_key, ik, sizeof (sa->integ_key));
 156   ip46_address_copy (&sa->tunnel_src_addr, tun_src);
 157   ip46_address_copy (&sa->tunnel_dst_addr, tun_dst);
 158
 159   if (flags & IPSEC_SA_FLAG_USE_ESN)
 160     ipsec_sa_set_USE_ESN (sa);
 161   if (flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY)
 162     ipsec_sa_set_USE_ANTI_REPLAY (sa);
 163   if (flags & IPSEC_SA_FLAG_IS_TUNNEL)
 164     ipsec_sa_set_IS_TUNNEL (sa);
 165   if (flags & IPSEC_SA_FLAG_IS_TUNNEL_V6)
 166     ipsec_sa_set_IS_TUNNEL_V6 (sa);
 167   if (flags & IPSEC_SA_FLAG_UDP_ENCAP)
 168     ipsec_sa_set_UDP_ENCAP (sa);
 169
 170   err = ipsec_check_support_cb (im, sa);
 171   if (err)
 172     {
 173       clib_warning ("%s", err->what);
 174       pool_put (im->sad, sa);
 175       return VNET_API_ERROR_UNIMPLEMENTED;
 176     }
 177
 178   err = ipsec_call_add_del_callbacks (im, sa, sa_index, 1);
 179   if (err)
 180     {
 181       pool_put (im->sad, sa);
 182       return VNET_API_ERROR_SYSCALL_ERROR_1;
 183     }
 184
 185   if (ipsec_sa_is_set_IS_TUNNEL (sa))
 186     {
 187       fib_protocol_t fproto = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
 188                                FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4);
 189       fib_prefix_t pfx = {
 190         .fp_addr = sa->tunnel_dst_addr,
 191         .fp_len = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ? 128 : 32),
 192         .fp_proto = fproto,
 193       };
 194       sa->tx_fib_index = fib_table_find (fproto, tx_table_id);
 195       if (sa->tx_fib_index == ~((u32) 0))
 196         {
 197           pool_put (im->sad, sa);
 198           return VNET_API_ERROR_NO_SUCH_FIB;
 199         }
 200
 201       sa->fib_entry_index = fib_table_entry_special_add (sa->tx_fib_index,
 202                                                          &pfx,
 203                                                          FIB_SOURCE_RR,
 204                                                          FIB_ENTRY_FLAG_NONE);
 205       sa->sibling = fib_entry_child_add (sa->fib_entry_index,
 206                                          FIB_NODE_TYPE_IPSEC_SA, sa_index);
 207       ipsec_sa_stack (sa);
 208
 209       /* generate header templates */
 210       if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
 211         {
 212           sa->ip6_hdr.ip_version_traffic_class_and_flow_label = 0x60;
 213           sa->ip6_hdr.hop_limit = 254;
 214           sa->ip6_hdr.src_address.as_u64[0] =
 215             sa->tunnel_src_addr.ip6.as_u64[0];
 216           sa->ip6_hdr.src_address.as_u64[1] =
 217             sa->tunnel_src_addr.ip6.as_u64[1];
 218           sa->ip6_hdr.dst_address.as_u64[0] =
 219             sa->tunnel_dst_addr.ip6.as_u64[0];
 220           sa->ip6_hdr.dst_address.as_u64[1] =
 221             sa->tunnel_dst_addr.ip6.as_u64[1];
 222           if (ipsec_sa_is_set_UDP_ENCAP (sa))
 223             sa->ip6_hdr.protocol = IP_PROTOCOL_UDP;
 224           else
 225             sa->ip6_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
 226         }
 227       else
 228         {
 229           sa->ip4_hdr.ip_version_and_header_length = 0x45;
 230           sa->ip4_hdr.ttl = 254;
 231           sa->ip4_hdr.src_address.as_u32 = sa->tunnel_src_addr.ip4.as_u32;
 232           sa->ip4_hdr.dst_address.as_u32 = sa->tunnel_dst_addr.ip4.as_u32;
 233
 234           if (ipsec_sa_is_set_UDP_ENCAP (sa))
 235             sa->ip4_hdr.protocol = IP_PROTOCOL_UDP;
 236           else
 237             sa->ip4_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
 238           sa->ip4_hdr.checksum = ip4_header_checksum (&sa->ip4_hdr);
 239         }
 240     }
 241
 242   if (ipsec_sa_is_set_UDP_ENCAP (sa))
 243     {
 244       sa->udp_hdr.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
 245       sa->udp_hdr.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
 246     }
 247
 248   hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
 249
 250   if (sa_out_index)
 251     *sa_out_index = sa_index;
 252
 253   return (0);
 254 }
 255
 256 u32
 257 ipsec_sa_del (u32 id)
 258 {
 259   ipsec_main_t *im = &ipsec_main;
 260   ipsec_sa_t *sa = 0;
 261   uword *p;
 262   u32 sa_index;
 263   clib_error_t *err;
 264
 265   p = hash_get (im->sa_index_by_sa_id, id);
 266
 267   if (!p)
 268     return VNET_API_ERROR_NO_SUCH_ENTRY;
 269
 270   sa_index = p[0];
 271   sa = pool_elt_at_index (im->sad, sa_index);
 272   if (ipsec_is_sa_used (sa_index))
 273     {
 274       clib_warning ("sa_id %u used in policy", sa->id);
 275       /* sa used in policy */
 276       return VNET_API_ERROR_SYSCALL_ERROR_1;
 277     }
 278   hash_unset (im->sa_index_by_sa_id, sa->id);
 279   err = ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
 280   if (err)
 281     return VNET_API_ERROR_SYSCALL_ERROR_1;
 282
 283   if (ipsec_sa_is_set_IS_TUNNEL (sa))
 284     {
 285       fib_entry_child_remove (sa->fib_entry_index, sa->sibling);
 286       fib_table_entry_special_remove
 287         (sa->tx_fib_index,
 288          fib_entry_get_prefix (sa->fib_entry_index), FIB_SOURCE_RR);
 289       dpo_reset (&sa->dpo[IPSEC_PROTOCOL_AH]);
 290       dpo_reset (&sa->dpo[IPSEC_PROTOCOL_ESP]);
 291     }
 292   pool_put (im->sad, sa);
 293   return 0;
 294 }
 295
 296 u8
 297 ipsec_is_sa_used (u32 sa_index)
 298 {
 299   ipsec_main_t *im = &ipsec_main;
 300   ipsec_tunnel_if_t *t;
 301   ipsec_policy_t *p;
 302
 303   /* *INDENT-OFF* */
 304   pool_foreach(p, im->policies, ({
 305      if (p->policy == IPSEC_POLICY_ACTION_PROTECT)
 306        {
 307          if (p->sa_index == sa_index)
 308            return 1;
 309        }
 310   }));
 311
 312   pool_foreach(t, im->tunnel_interfaces, ({
 313     if (t->input_sa_index == sa_index)
 314       return 1;
 315     if (t->output_sa_index == sa_index)
 316       return 1;
 317   }));
 318   /* *INDENT-ON* */
 319
 320   return 0;
 321 }
 322
 323 int
 324 ipsec_set_sa_key (u32 id, const ipsec_key_t * ck, const ipsec_key_t * ik)
 325 {
 326   ipsec_main_t *im = &ipsec_main;
 327   uword *p;
 328   u32 sa_index;
 329   ipsec_sa_t *sa = 0;
 330   clib_error_t *err;
 331
 332   p = hash_get (im->sa_index_by_sa_id, id);
 333   if (!p)
 334     return VNET_API_ERROR_SYSCALL_ERROR_1;      /* no such sa-id */
 335
 336   sa_index = p[0];
 337   sa = pool_elt_at_index (im->sad, sa_index);
 338
 339   /* new crypto key */
 340   if (ck)
 341     {
 342       clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
 343     }
 344
 345   /* new integ key */
 346   if (ik)
 347     {
 348       clib_memcpy (&sa->integ_key, 0, sizeof (sa->integ_key));
 349     }
 350
 351   if (ck || ik)
 352     {
 353       err = ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
 354       if (err)
 355         {
 356           clib_error_free (err);
 357           return VNET_API_ERROR_SYSCALL_ERROR_1;
 358         }
 359     }
 360
 361   return 0;
 362 }
 363
 364 u32
 365 ipsec_get_sa_index_by_sa_id (u32 sa_id)
 366 {
 367   ipsec_main_t *im = &ipsec_main;
 368   uword *p = hash_get (im->sa_index_by_sa_id, sa_id);
 369   if (!p)
 370     return ~0;
 371
 372   return p[0];
 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 /**
 406  * Function definition to inform the FIB node that its last lock has gone.
 407  */
 408 static void
 409 ipsec_sa_last_lock_gone (fib_node_t * node)
 410 {
 411   /*
 412    * The ipsec SA is a root of the graph. As such
 413    * it never has children and thus is never locked.
 414    */
 415   ASSERT (0);
 416 }
 417
 418 static ipsec_sa_t *
 419 ipsec_sa_from_fib_node (fib_node_t * node)
 420 {
 421   ASSERT (FIB_NODE_TYPE_IPSEC_SA == node->fn_type);
 422   return ((ipsec_sa_t *) (((char *) node) -
 423                           STRUCT_OFFSET_OF (ipsec_sa_t, node)));
 424
 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 MPLS GRE tunnels
 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  */