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