src/vnet/ipsec/ipsec_tun.c

   1 /*
   2  * ipsec_tun.h : IPSEC tunnel protection
   3  *
   4  * Copyright (c) 2015 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <vnet/ipsec/ipsec_tun.h>
  19 #include <vnet/ipsec/ipsec_itf.h>
  20 #include <vnet/ipsec/esp.h>
  21 #include <vnet/udp/udp_local.h>
  22 #include <vnet/adj/adj_delegate.h>
  23 #include <vnet/adj/adj_midchain.h>
  24 #include <vnet/teib/teib.h>
  25
  26 /* instantiate the bihash functions */
  27 #include <vppinfra/bihash_8_16.h>
  28 #include <vppinfra/bihash_template.c>
  29 #include <vppinfra/bihash_24_16.h>
  30 #include <vppinfra/bihash_template.c>
  31
  32 #define IPSEC_TUN_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
  33 #define IPSEC_TUN_DEFAULT_HASH_MEMORY_SIZE 512 << 20
  34
  35 /**
  36  * The logger
  37  */
  38 vlib_log_class_t ipsec_tun_protect_logger;
  39
  40 /**
  41  * Pool of tunnel protection objects
  42  */
  43 ipsec_tun_protect_t *ipsec_tun_protect_pool;
  44
  45 /**
  46  * Adj delegate registered type
  47  */
  48 static adj_delegate_type_t ipsec_tun_adj_delegate_type;
  49
  50 /**
  51  * Adj index to TX SA mapping
  52  */
  53 index_t *ipsec_tun_protect_sa_by_adj_index;
  54
  55 const ip_address_t IP_ADDR_ALL_0 = IP_ADDRESS_V4_ALL_0S;
  56
  57 /**
  58  * The DB of all added per-nh tunnel protectiond
  59  */
  60 typedef struct ipsec_tun_protect_itf_db_t_
  61 {
  62   /** A hash table key'd on IP (4 or 6) address */
  63   uword *id_hash;
  64   /** If the interface is P2P then there is only one protect
  65    * object associated with the auto-adj for each NH proto */
  66   index_t id_itp;
  67 } ipsec_tun_protect_itf_db_t;
  68
  69 typedef struct ipsec_tun_protect_db_t_
  70 {
  71   /** Per-interface vector */
  72   ipsec_tun_protect_itf_db_t *id_itf;
  73 } ipsec_tun_protect_db_t;
  74
  75 static ipsec_tun_protect_db_t itp_db;
  76
  77 const static ipsec_tun_protect_itf_db_t IPSEC_TUN_PROTECT_DEFAULT_DB_ENTRY = {
  78   .id_itp = INDEX_INVALID,
  79 };
  80
  81 #define ITP_DBG(_itp, _fmt, _args...)                   \
  82 {                                                       \
  83   vlib_log_debug(ipsec_tun_protect_logger,              \
  84                  "[%U]: " _fmt,                         \
  85                  format_ipsec_tun_protect,              \
  86                  _itp, ##_args);                        \
  87 }
  88
  89 #define ITP_DBG2(_fmt, _args...)                        \
  90 {                                                       \
  91   vlib_log_debug(ipsec_tun_protect_logger,              \
  92                  _fmt, ##_args);                        \
  93 }
  94
  95 static u32 ipsec_tun_node_regs[N_AF];
  96
  97 void
  98 ipsec_tun_register_nodes (ip_address_family_t af)
  99 {
 100   if (0 == ipsec_tun_node_regs[af]++)
 101     {
 102       if (AF_IP4 == af)
 103         {
 104           ipsec_register_udp_port (UDP_DST_PORT_ipsec);
 105           ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
 106                                  ipsec4_tun_input_node.index);
 107         }
 108       else
 109         ip6_register_protocol (IP_PROTOCOL_IPSEC_ESP,
 110                                ipsec6_tun_input_node.index);
 111     }
 112 }
 113
 114 void
 115 ipsec_tun_unregister_nodes (ip_address_family_t af)
 116 {
 117   ASSERT (0 != ipsec_tun_node_regs[af]);
 118   if (0 == --ipsec_tun_node_regs[af])
 119     {
 120       if (AF_IP4 == af)
 121         {
 122           ipsec_unregister_udp_port (UDP_DST_PORT_ipsec);
 123           ip4_unregister_protocol (IP_PROTOCOL_IPSEC_ESP);
 124         }
 125       else
 126         ip6_unregister_protocol (IP_PROTOCOL_IPSEC_ESP);
 127     }
 128 }
 129
 130 static inline const ipsec_tun_protect_t *
 131 ipsec_tun_protect_from_const_base (const adj_delegate_t * ad)
 132 {
 133   if (ad == NULL)
 134     return (NULL);
 135   return (pool_elt_at_index (ipsec_tun_protect_pool, ad->ad_index));
 136 }
 137
 138 static u32
 139 ipsec_tun_protect_get_adj_next (vnet_link_t linkt,
 140                                 const ipsec_tun_protect_t * itp)
 141 {
 142   ipsec_main_t *im;
 143   ipsec_sa_t *sa;
 144   bool is_ip4;
 145   u32 next;
 146
 147
 148   if (itp->itp_flags & IPSEC_PROTECT_ITF)
 149     is_ip4 = linkt == VNET_LINK_IP4;
 150   else
 151     is_ip4 = ip46_address_is_ip4 (&itp->itp_tun.src);
 152
 153   sa = ipsec_sa_get (itp->itp_out_sa);
 154   im = &ipsec_main;
 155
 156   if ((sa->crypto_alg == IPSEC_CRYPTO_ALG_NONE &&
 157        sa->integ_alg == IPSEC_INTEG_ALG_NONE) &&
 158       !(itp->itp_flags & IPSEC_PROTECT_ITF))
 159     next = (is_ip4 ?
 160             im->esp4_no_crypto_tun_node_index :
 161             im->esp6_no_crypto_tun_node_index);
 162   else if (itp->itp_flags & IPSEC_PROTECT_L2)
 163     next = (is_ip4 ?
 164             im->esp4_encrypt_l2_tun_node_index :
 165             im->esp6_encrypt_l2_tun_node_index);
 166   else
 167     next = (is_ip4 ?
 168             im->esp4_encrypt_tun_node_index :
 169             im->esp6_encrypt_tun_node_index);
 170
 171   return (next);
 172 }
 173
 174 static void
 175 ipsec_tun_protect_add_adj (adj_index_t ai, const ipsec_tun_protect_t * itp)
 176 {
 177   vec_validate_init_empty (ipsec_tun_protect_sa_by_adj_index, ai,
 178                            INDEX_INVALID);
 179
 180   if (NULL == itp)
 181     {
 182       ipsec_tun_protect_sa_by_adj_index[ai] = INDEX_INVALID;
 183       adj_nbr_midchain_reset_next_node (ai);
 184     }
 185   else
 186     {
 187       ipsec_tun_protect_sa_by_adj_index[ai] = itp->itp_out_sa;
 188       adj_nbr_midchain_update_next_node
 189         (ai, ipsec_tun_protect_get_adj_next (adj_get_link_type (ai), itp));
 190     }
 191 }
 192
 193 static index_t
 194 ipsec_tun_protect_find (u32 sw_if_index, const ip_address_t * nh)
 195 {
 196   ipsec_tun_protect_itf_db_t *idi;
 197   uword *p;
 198
 199   if (vec_len (itp_db.id_itf) <= sw_if_index)
 200     return INDEX_INVALID;
 201
 202   if (vnet_sw_interface_is_p2p (vnet_get_main (), sw_if_index))
 203     return (itp_db.id_itf[sw_if_index].id_itp);
 204
 205   idi = &itp_db.id_itf[sw_if_index];
 206   p = hash_get_mem (idi->id_hash, nh);
 207
 208   if (NULL == p)
 209     {
 210       return INDEX_INVALID;
 211     }
 212   return (p[0]);
 213 }
 214
 215 static void
 216 ipsec_tun_protect_rx_db_add (ipsec_main_t * im,
 217                              const ipsec_tun_protect_t * itp)
 218 {
 219   const ipsec_sa_t *sa;
 220   u32 sai;
 221
 222   if (ip46_address_is_zero (&itp->itp_crypto.dst))
 223     return;
 224
 225   /* *INDENT-OFF* */
 226   FOR_EACH_IPSEC_PROTECT_INPUT_SAI(itp, sai,
 227   ({
 228       sa = ipsec_sa_get (sai);
 229
 230       ipsec_tun_lkup_result_t res = {
 231         .tun_index = itp - ipsec_tun_protect_pool,
 232         .sa_index = sai,
 233         .flags = itp->itp_flags,
 234         .sw_if_index = itp->itp_sw_if_index,
 235       };
 236
 237       /*
 238        * The key is formed from the tunnel's destination
 239        * as the packet lookup is done from the packet's source
 240        */
 241       if (ip46_address_is_ip4 (&itp->itp_crypto.dst))
 242         {
 243           ipsec4_tunnel_kv_t key = {
 244             .value = res,
 245           };
 246           clib_bihash_kv_8_16_t *bkey = (clib_bihash_kv_8_16_t*)&key;
 247
 248           ipsec4_tunnel_mk_key(&key, &itp->itp_crypto.dst.ip4,
 249                                clib_host_to_net_u32 (sa->spi));
 250
 251           if (!im->tun4_protect_by_key.nbuckets)
 252               clib_bihash_init_8_16 (&im->tun4_protect_by_key,
 253                         "IPSec IPv4 tunnels",
 254                         IPSEC_TUN_DEFAULT_HASH_NUM_BUCKETS,
 255                         IPSEC_TUN_DEFAULT_HASH_MEMORY_SIZE);
 256
 257           clib_bihash_add_del_8_16 (&im->tun4_protect_by_key, bkey, 1);
 258           ipsec_tun_register_nodes(AF_IP4);
 259         }
 260       else
 261         {
 262           ipsec6_tunnel_kv_t key = {
 263             .key = {
 264               .remote_ip = itp->itp_crypto.dst.ip6,
 265               .spi = clib_host_to_net_u32 (sa->spi),
 266             },
 267             .value = res,
 268           };
 269           clib_bihash_kv_24_16_t *bkey = (clib_bihash_kv_24_16_t*)&key;
 270
 271           if (!im->tun4_protect_by_key.nbuckets)
 272             clib_bihash_init_24_16 (&im->tun6_protect_by_key,
 273                                    "IPSec IPv6 tunnels",
 274                                    IPSEC_TUN_DEFAULT_HASH_NUM_BUCKETS,
 275                                    IPSEC_TUN_DEFAULT_HASH_MEMORY_SIZE);
 276           clib_bihash_add_del_24_16 (&im->tun6_protect_by_key, bkey, 1);
 277           ipsec_tun_register_nodes(AF_IP6);
 278         }
 279   }))
 280   /* *INDENT-ON* */
 281 }
 282
 283 static adj_walk_rc_t
 284 ipsec_tun_protect_adj_add (adj_index_t ai, void *arg)
 285 {
 286   ipsec_tun_protect_t *itp = arg;
 287   adj_delegate_add (adj_get (ai), ipsec_tun_adj_delegate_type,
 288                     itp - ipsec_tun_protect_pool);
 289   ipsec_tun_protect_add_adj (ai, itp);
 290
 291   if (itp->itp_flags & IPSEC_PROTECT_ITF)
 292     ipsec_itf_adj_stack (ai, itp->itp_out_sa);
 293
 294   return (ADJ_WALK_RC_CONTINUE);
 295 }
 296
 297 static void
 298 ipsec_tun_protect_tx_db_add (ipsec_tun_protect_t * itp)
 299 {
 300   /*
 301    * add the delegate to the adj
 302    */
 303   ipsec_tun_protect_itf_db_t *idi;
 304   fib_protocol_t nh_proto;
 305   ip46_address_t nh;
 306
 307   vec_validate_init_empty (itp_db.id_itf,
 308                            itp->itp_sw_if_index,
 309                            IPSEC_TUN_PROTECT_DEFAULT_DB_ENTRY);
 310
 311   idi = &itp_db.id_itf[itp->itp_sw_if_index];
 312
 313   if (vnet_sw_interface_is_p2p (vnet_get_main (), itp->itp_sw_if_index))
 314     {
 315       if (INDEX_INVALID == idi->id_itp)
 316         {
 317           // ipsec_tun_protect_feature_set (itp, 1);
 318         }
 319       idi->id_itp = itp - ipsec_tun_protect_pool;
 320
 321       FOR_EACH_FIB_IP_PROTOCOL (nh_proto)
 322         adj_nbr_walk (itp->itp_sw_if_index,
 323                       nh_proto, ipsec_tun_protect_adj_add, itp);
 324     }
 325   else
 326     {
 327       if (NULL == idi->id_hash)
 328         {
 329           idi->id_hash =
 330             hash_create_mem (0, sizeof (ip_address_t), sizeof (uword));
 331           /*
 332            * enable the encrypt feature for egress if this is the first addition
 333            * on this interface
 334            */
 335           // ipsec_tun_protect_feature_set (itp, 1);
 336         }
 337
 338       hash_set_mem (idi->id_hash, itp->itp_key, itp - ipsec_tun_protect_pool);
 339
 340       /*
 341        * walk all the adjs with the same nh on this interface
 342        * to associate them with this protection
 343        */
 344       nh_proto = ip_address_to_46 (itp->itp_key, &nh);
 345
 346       adj_nbr_walk_nh (itp->itp_sw_if_index,
 347                        nh_proto, &nh, ipsec_tun_protect_adj_add, itp);
 348
 349       ipsec_tun_register_nodes (FIB_PROTOCOL_IP6 == nh_proto ?
 350                                 AF_IP6 : AF_IP4);
 351     }
 352 }
 353
 354 static void
 355 ipsec_tun_protect_rx_db_remove (ipsec_main_t * im,
 356                                 const ipsec_tun_protect_t * itp)
 357 {
 358   const ipsec_sa_t *sa;
 359
 360   /* *INDENT-OFF* */
 361   FOR_EACH_IPSEC_PROTECT_INPUT_SA(itp, sa,
 362   ({
 363     if (ip46_address_is_ip4 (&itp->itp_crypto.dst))
 364       {
 365           ipsec4_tunnel_kv_t key;
 366           clib_bihash_kv_8_16_t res, *bkey = (clib_bihash_kv_8_16_t*)&key;
 367
 368           ipsec4_tunnel_mk_key(&key, &itp->itp_crypto.dst.ip4,
 369                                clib_host_to_net_u32 (sa->spi));
 370
 371           if (!clib_bihash_search_8_16 (&im->tun4_protect_by_key, bkey, &res))
 372             {
 373               clib_bihash_add_del_8_16 (&im->tun4_protect_by_key, bkey, 0);
 374               ipsec_tun_unregister_nodes(AF_IP4);
 375             }
 376       }
 377     else
 378       {
 379         ipsec6_tunnel_kv_t key = {
 380           .key = {
 381             .remote_ip = itp->itp_crypto.dst.ip6,
 382             .spi = clib_host_to_net_u32 (sa->spi),
 383           },
 384         };
 385         clib_bihash_kv_24_16_t res, *bkey = (clib_bihash_kv_24_16_t*)&key;
 386
 387         if (!clib_bihash_search_24_16 (&im->tun6_protect_by_key, bkey, &res))
 388           {
 389             clib_bihash_add_del_24_16 (&im->tun6_protect_by_key, bkey, 0);
 390             ipsec_tun_unregister_nodes(AF_IP6);
 391           }
 392       }
 393   }));
 394   /* *INDENT-ON* */
 395 }
 396
 397 static adj_walk_rc_t
 398 ipsec_tun_protect_adj_remove (adj_index_t ai, void *arg)
 399 {
 400   ipsec_tun_protect_t *itp = arg;
 401
 402   adj_delegate_remove (ai, ipsec_tun_adj_delegate_type);
 403   ipsec_tun_protect_add_adj (ai, NULL);
 404
 405   if (itp->itp_flags & IPSEC_PROTECT_ITF)
 406     ipsec_itf_adj_unstack (ai);
 407
 408   return (ADJ_WALK_RC_CONTINUE);
 409 }
 410
 411 static void
 412 ipsec_tun_protect_tx_db_remove (ipsec_tun_protect_t * itp)
 413 {
 414   ipsec_tun_protect_itf_db_t *idi;
 415   fib_protocol_t nh_proto;
 416   ip46_address_t nh;
 417
 418   nh_proto = ip_address_to_46 (itp->itp_key, &nh);
 419   idi = &itp_db.id_itf[itp->itp_sw_if_index];
 420
 421   if (vnet_sw_interface_is_p2p (vnet_get_main (), itp->itp_sw_if_index))
 422     {
 423       // ipsec_tun_protect_feature_set (itp, 0);
 424       idi->id_itp = INDEX_INVALID;
 425
 426       FOR_EACH_FIB_IP_PROTOCOL (nh_proto)
 427         adj_nbr_walk (itp->itp_sw_if_index,
 428                       nh_proto, ipsec_tun_protect_adj_remove, itp);
 429     }
 430   else
 431     {
 432       adj_nbr_walk_nh (itp->itp_sw_if_index,
 433                        nh_proto, &nh, ipsec_tun_protect_adj_remove, itp);
 434
 435       hash_unset_mem (idi->id_hash, itp->itp_key);
 436
 437       if (0 == hash_elts (idi->id_hash))
 438         {
 439           // ipsec_tun_protect_feature_set (itp, 0);
 440           hash_free (idi->id_hash);
 441           idi->id_hash = NULL;
 442         }
 443       ipsec_tun_unregister_nodes (FIB_PROTOCOL_IP6 == nh_proto ?
 444                                   AF_IP6 : AF_IP4);
 445     }
 446 }
 447
 448 static void
 449 ipsec_tun_protect_set_crypto_addr (ipsec_tun_protect_t * itp)
 450 {
 451   ipsec_sa_t *sa;
 452
 453   /* *INDENT-OFF* */
 454   FOR_EACH_IPSEC_PROTECT_INPUT_SA(itp, sa,
 455   ({
 456     if (ipsec_sa_is_set_IS_TUNNEL (sa))
 457       {
 458         itp->itp_crypto.src = sa->tunnel_dst_addr;
 459         itp->itp_crypto.dst = sa->tunnel_src_addr;
 460         if (!(itp->itp_flags & IPSEC_PROTECT_ITF))
 461           {
 462             ipsec_sa_set_IS_PROTECT (sa);
 463             itp->itp_flags |= IPSEC_PROTECT_ENCAPED;
 464           }
 465       }
 466     else
 467       {
 468         itp->itp_crypto.src = itp->itp_tun.src;
 469         itp->itp_crypto.dst = itp->itp_tun.dst;
 470         itp->itp_flags &= ~IPSEC_PROTECT_ENCAPED;
 471       }
 472   }));
 473   /* *INDENT-ON* */
 474 }
 475
 476 static void
 477 ipsec_tun_protect_config (ipsec_main_t * im,
 478                           ipsec_tun_protect_t * itp, u32 sa_out, u32 * sas_in)
 479 {
 480   index_t sai;
 481   u32 ii;
 482
 483   itp->itp_n_sa_in = vec_len (sas_in);
 484   for (ii = 0; ii < itp->itp_n_sa_in; ii++)
 485     itp->itp_in_sas[ii] = sas_in[ii];
 486   itp->itp_out_sa = sa_out;
 487
 488   ipsec_sa_lock (itp->itp_out_sa);
 489
 490   /* *INDENT-OFF* */
 491   FOR_EACH_IPSEC_PROTECT_INPUT_SAI(itp, sai,
 492   ({
 493     ipsec_sa_lock(sai);
 494   }));
 495   ipsec_tun_protect_set_crypto_addr(itp);
 496   /* *INDENT-ON* */
 497
 498   /*
 499    * add to the DB against each SA
 500    */
 501   ipsec_tun_protect_rx_db_add (im, itp);
 502   ipsec_tun_protect_tx_db_add (itp);
 503
 504   ITP_DBG (itp, "configured");
 505 }
 506
 507 static void
 508 ipsec_tun_protect_unconfig (ipsec_main_t * im, ipsec_tun_protect_t * itp)
 509 {
 510   ipsec_sa_t *sa;
 511   index_t sai;
 512
 513   /* *INDENT-OFF* */
 514   FOR_EACH_IPSEC_PROTECT_INPUT_SA(itp, sa,
 515   ({
 516     ipsec_sa_unset_IS_PROTECT (sa);
 517   }));
 518
 519   ipsec_tun_protect_rx_db_remove (im, itp);
 520   ipsec_tun_protect_tx_db_remove (itp);
 521
 522   ipsec_sa_unlock(itp->itp_out_sa);
 523
 524   FOR_EACH_IPSEC_PROTECT_INPUT_SAI(itp, sai,
 525   ({
 526     ipsec_sa_unlock(sai);
 527   }));
 528   /* *INDENT-ON* */
 529   ITP_DBG (itp, "unconfigured");
 530 }
 531
 532 int
 533 ipsec_tun_protect_update_one (u32 sw_if_index,
 534                               const ip_address_t * nh, u32 sa_out, u32 sa_in)
 535 {
 536   u32 *sas_in = NULL;
 537   int rv;
 538
 539   vec_add1 (sas_in, sa_in);
 540   rv = ipsec_tun_protect_update (sw_if_index, nh, sa_out, sas_in);
 541
 542   return (rv);
 543 }
 544
 545 int
 546 ipsec_tun_protect_update_out (u32 sw_if_index,
 547                               const ip_address_t * nh, u32 sa_out)
 548 {
 549   u32 itpi, *sas_in, sai, *saip;
 550   ipsec_tun_protect_t *itp;
 551   ipsec_main_t *im;
 552   int rv;
 553
 554   sas_in = NULL;
 555   rv = 0;
 556   im = &ipsec_main;
 557
 558   itpi = ipsec_tun_protect_find (sw_if_index, nh);
 559
 560   if (INDEX_INVALID == itpi)
 561     {
 562       return (VNET_API_ERROR_INVALID_INTERFACE);
 563     }
 564
 565   itp = pool_elt_at_index (ipsec_tun_protect_pool, itpi);
 566
 567   /* *INDENT-OFF* */
 568   FOR_EACH_IPSEC_PROTECT_INPUT_SAI (itp, sai,
 569   ({
 570     ipsec_sa_lock (sai);
 571     vec_add1 (sas_in, sai);
 572   }));
 573   /* *INDENT-ON* */
 574
 575   sa_out = ipsec_sa_find_and_lock (sa_out);
 576
 577   if (~0 == sa_out)
 578     {
 579       rv = VNET_API_ERROR_INVALID_VALUE;
 580       goto out;
 581     }
 582
 583   ipsec_tun_protect_unconfig (im, itp);
 584   ipsec_tun_protect_config (im, itp, sa_out, sas_in);
 585
 586   ipsec_sa_unlock (sa_out);
 587   vec_foreach (saip, sas_in) ipsec_sa_unlock (*saip);
 588
 589 out:
 590   vec_free (sas_in);
 591   return (rv);
 592 }
 593
 594 int
 595 ipsec_tun_protect_update_in (u32 sw_if_index,
 596                              const ip_address_t * nh, u32 sa_in)
 597 {
 598   u32 itpi, *sas_in, sa_out;
 599   ipsec_tun_protect_t *itp;
 600   ipsec_main_t *im;
 601   int rv;
 602
 603   sas_in = NULL;
 604   rv = 0;
 605   im = &ipsec_main;
 606   itpi = ipsec_tun_protect_find (sw_if_index, nh);
 607
 608   if (INDEX_INVALID == itpi)
 609     {
 610       return (VNET_API_ERROR_INVALID_INTERFACE);
 611     }
 612
 613   sa_in = ipsec_sa_find_and_lock (sa_in);
 614
 615   if (~0 == sa_in)
 616     {
 617       rv = VNET_API_ERROR_INVALID_VALUE;
 618       goto out;
 619     }
 620   vec_add1 (sas_in, sa_in);
 621
 622   itp = pool_elt_at_index (ipsec_tun_protect_pool, itpi);
 623   sa_out = itp->itp_out_sa;
 624
 625   ipsec_sa_lock (sa_out);
 626
 627   ipsec_tun_protect_unconfig (im, itp);
 628   ipsec_tun_protect_config (im, itp, sa_out, sas_in);
 629
 630   ipsec_sa_unlock (sa_out);
 631   ipsec_sa_unlock (sa_in);
 632 out:
 633   vec_free (sas_in);
 634   return (rv);
 635 }
 636
 637 static void
 638 ipsec_tun_protect_update_from_teib (ipsec_tun_protect_t * itp,
 639                                     const teib_entry_t * ne)
 640 {
 641   if (NULL != ne)
 642     {
 643       const fib_prefix_t *pfx;
 644
 645       pfx = teib_entry_get_nh (ne);
 646
 647       ip46_address_copy (&itp->itp_tun.dst, &pfx->fp_addr);
 648     }
 649   else
 650     ip46_address_reset (&itp->itp_tun.dst);
 651 }
 652
 653 int
 654 ipsec_tun_protect_update (u32 sw_if_index,
 655                           const ip_address_t * nh, u32 sa_out, u32 * sas_in)
 656 {
 657   ipsec_tun_protect_t *itp;
 658   u32 itpi, ii, *saip;
 659   ipsec_main_t *im;
 660   int rv;
 661
 662   ITP_DBG2 ("update: %U/%U",
 663             format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
 664             format_ip_address, nh);
 665
 666   if (vec_len (sas_in) > ITP_MAX_N_SA_IN)
 667     {
 668       rv = VNET_API_ERROR_LIMIT_EXCEEDED;
 669       goto out;
 670     }
 671
 672   rv = 0;
 673   im = &ipsec_main;
 674   if (NULL == nh)
 675     nh = &IP_ADDR_ALL_0;
 676   itpi = ipsec_tun_protect_find (sw_if_index, nh);
 677
 678   vec_foreach_index (ii, sas_in)
 679   {
 680     sas_in[ii] = ipsec_sa_find_and_lock (sas_in[ii]);
 681     if (~0 == sas_in[ii])
 682       {
 683         rv = VNET_API_ERROR_INVALID_VALUE;
 684         goto out;
 685       }
 686   }
 687
 688   sa_out = ipsec_sa_find_and_lock (sa_out);
 689
 690   if (~0 == sa_out)
 691     {
 692       rv = VNET_API_ERROR_INVALID_VALUE;
 693       goto out;
 694     }
 695
 696   if (INDEX_INVALID == itpi)
 697     {
 698       vnet_device_class_t *dev_class;
 699       vnet_hw_interface_t *hi;
 700       vnet_main_t *vnm;
 701       u8 is_l2;
 702
 703       vnm = vnet_get_main ();
 704       hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
 705       dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 706
 707       if (NULL == dev_class->ip_tun_desc)
 708         {
 709           rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
 710           goto out;
 711         }
 712
 713       pool_get_zero (ipsec_tun_protect_pool, itp);
 714
 715       itp->itp_sw_if_index = sw_if_index;
 716       itp->itp_ai = ADJ_INDEX_INVALID;
 717
 718       itp->itp_n_sa_in = vec_len (sas_in);
 719       for (ii = 0; ii < itp->itp_n_sa_in; ii++)
 720         itp->itp_in_sas[ii] = sas_in[ii];
 721       itp->itp_out_sa = sa_out;
 722
 723       itp->itp_key = clib_mem_alloc (sizeof (*itp->itp_key));
 724       ip_address_copy (itp->itp_key, nh);
 725
 726       rv = dev_class->ip_tun_desc (sw_if_index,
 727                                    &itp->itp_tun.src,
 728                                    &itp->itp_tun.dst, &is_l2);
 729
 730       if (rv)
 731         goto out;
 732
 733       if (ip46_address_is_zero (&itp->itp_tun.src))
 734         {
 735           /*
 736            * must be one of those pesky ipsec interfaces that has no encap.
 737            * the encap then MUST come from the tunnel mode SA.
 738            */
 739           ipsec_sa_t *sa;
 740
 741           sa = ipsec_sa_get (itp->itp_out_sa);
 742
 743           if (!ipsec_sa_is_set_IS_TUNNEL (sa))
 744             {
 745               rv = VNET_API_ERROR_INVALID_DST_ADDRESS;
 746               goto out;
 747             }
 748
 749           itp->itp_flags |= IPSEC_PROTECT_ITF;
 750         }
 751       else if (ip46_address_is_zero (&itp->itp_tun.dst))
 752         {
 753           /* tunnel has no destination address, presumably because it's p2mp
 754              in which case we use the nh that this is protection for */
 755           ipsec_tun_protect_update_from_teib
 756             (itp, teib_entry_find (sw_if_index, nh));
 757         }
 758
 759       if (is_l2)
 760         itp->itp_flags |= IPSEC_PROTECT_L2;
 761
 762       /*
 763        * add to the tunnel DB for ingress
 764        *  - if the SA is in trasnport mode, then the packates will arrive
 765        *    with the IP src,dst of the protected tunnel, in which case we can
 766        *    simply strip the IP header and hand the payload to the protocol
 767        *    appropriate input handler
 768        *  - if the SA is in tunnel mode then there are two IP headers present
 769        *    one for the crytpo tunnel endpoints (described in the SA) and one
 770        *    for the tunnel endpoints. The outer IP headers in the srriving
 771        *    packets will have the crypto endpoints. So the DB needs to contain
 772        *    the crpto endpoint. Once the crypto header is stripped, revealing,
 773        *    the tunnel-IP we have 2 choices:
 774        *     1) do a tunnel lookup based on the revealed header
 775        *     2) skip the tunnel lookup and assume that the packet matches the
 776        *        one that is protected here.
 777        *    If we did 1) then we would allow our peer to use the SA for tunnel
 778        *    X to inject traffic onto tunnel Y, this is not good. If we do 2)
 779        *    then we don't verify that the peer is indeed using SA for tunnel
 780        *    X and addressing tunnel X. So we take a compromise, once the SA
 781        *    matches to tunnel X we veriy that the inner IP matches the value
 782        *    of the tunnel we are protecting, else it's dropped.
 783        */
 784       ipsec_tun_protect_config (im, itp, sa_out, sas_in);
 785     }
 786   else
 787     {
 788       /* updating SAs only */
 789       itp = pool_elt_at_index (ipsec_tun_protect_pool, itpi);
 790
 791       ipsec_tun_protect_unconfig (im, itp);
 792       ipsec_tun_protect_config (im, itp, sa_out, sas_in);
 793     }
 794
 795   ipsec_sa_unlock (sa_out);
 796   vec_foreach (saip, sas_in) ipsec_sa_unlock (*saip);
 797   vec_free (sas_in);
 798
 799 out:
 800   return (rv);
 801 }
 802
 803 int
 804 ipsec_tun_protect_del (u32 sw_if_index, const ip_address_t * nh)
 805 {
 806   ipsec_tun_protect_t *itp;
 807   ipsec_main_t *im;
 808   index_t itpi;
 809
 810   ITP_DBG2 ("delete: %U/%U",
 811             format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
 812             format_ip_address, nh);
 813
 814   im = &ipsec_main;
 815   if (NULL == nh)
 816     nh = &IP_ADDR_ALL_0;
 817
 818   itpi = ipsec_tun_protect_find (sw_if_index, nh);
 819
 820   if (INDEX_INVALID == itpi)
 821     return (VNET_API_ERROR_NO_SUCH_ENTRY);
 822
 823   itp = ipsec_tun_protect_get (itpi);
 824   ipsec_tun_protect_unconfig (im, itp);
 825
 826   if (ADJ_INDEX_INVALID != itp->itp_ai)
 827     adj_unlock (itp->itp_ai);
 828
 829   clib_mem_free (itp->itp_key);
 830   pool_put (ipsec_tun_protect_pool, itp);
 831
 832   return (0);
 833 }
 834
 835 void
 836 ipsec_tun_protect_walk (ipsec_tun_protect_walk_cb_t fn, void *ctx)
 837 {
 838   index_t itpi;
 839
 840   /* *INDENT-OFF* */
 841   pool_foreach_index(itpi, ipsec_tun_protect_pool,
 842   ({
 843     fn (itpi, ctx);
 844   }));
 845   /* *INDENT-ON* */
 846 }
 847
 848 void
 849 ipsec_tun_protect_walk_itf (u32 sw_if_index,
 850                             ipsec_tun_protect_walk_cb_t fn, void *ctx)
 851 {
 852   ipsec_tun_protect_itf_db_t *idi;
 853   ip_address_t *key;
 854   index_t itpi;
 855
 856   if (vec_len (itp_db.id_itf) <= sw_if_index)
 857     return;
 858
 859   idi = &itp_db.id_itf[sw_if_index];
 860
 861   /* *INDENT-OFF* */
 862   hash_foreach(key, itpi, idi->id_hash,
 863   ({
 864     fn (itpi, ctx);
 865   }));
 866   /* *INDENT-ON* */
 867   if (INDEX_INVALID != idi->id_itp)
 868     fn (idi->id_itp, ctx);
 869 }
 870
 871 static void
 872 ipsec_tun_protect_adj_delegate_adj_deleted (adj_delegate_t * ad)
 873 {
 874   /* remove our delegate */
 875   ipsec_tun_protect_add_adj (ad->ad_adj_index, NULL);
 876   adj_delegate_remove (ad->ad_adj_index, ipsec_tun_adj_delegate_type);
 877 }
 878
 879 static void
 880 ipsec_tun_protect_adj_delegate_adj_modified (adj_delegate_t * ad)
 881 {
 882   ipsec_tun_protect_add_adj (ad->ad_adj_index,
 883                              ipsec_tun_protect_get (ad->ad_index));
 884 }
 885
 886 static void
 887 ipsec_tun_protect_adj_delegate_adj_created (adj_index_t ai)
 888 {
 889   /* add our delegate if there is protection for this neighbour */
 890   ip_address_t ip = IP_ADDRESS_V4_ALL_0S;
 891   ip_adjacency_t *adj;
 892   index_t itpi;
 893
 894   if (!adj_is_midchain (ai))
 895     return;
 896
 897   adj = adj_get (ai);
 898
 899   ip_address_from_46 (&adj->sub_type.midchain.next_hop,
 900                       adj->ia_nh_proto, &ip);
 901
 902   itpi = ipsec_tun_protect_find (adj->rewrite_header.sw_if_index, &ip);
 903
 904   if (INDEX_INVALID != itpi)
 905     ipsec_tun_protect_adj_add (ai, ipsec_tun_protect_get (itpi));
 906 }
 907
 908 static u8 *
 909 ipsec_tun_protect_adj_delegate_format (const adj_delegate_t * aed, u8 * s)
 910 {
 911   const ipsec_tun_protect_t *itp;
 912
 913   itp = ipsec_tun_protect_from_const_base (aed);
 914   s = format (s, "ipsec-tun-protect:\n%U", format_ipsec_tun_protect, itp);
 915
 916   return (s);
 917 }
 918
 919 static void
 920 ipsec_tun_teib_entry_added (const teib_entry_t * ne)
 921 {
 922   ipsec_tun_protect_t *itp;
 923   index_t itpi;
 924
 925   itpi = ipsec_tun_protect_find (teib_entry_get_sw_if_index (ne),
 926                                  teib_entry_get_peer (ne));
 927
 928   if (INDEX_INVALID == itpi)
 929     return;
 930
 931   itp = ipsec_tun_protect_get (itpi);
 932   ipsec_tun_protect_rx_db_remove (&ipsec_main, itp);
 933   ipsec_tun_protect_update_from_teib (itp, ne);
 934   ipsec_tun_protect_set_crypto_addr (itp);
 935   ipsec_tun_protect_rx_db_add (&ipsec_main, itp);
 936
 937   ITP_DBG (itp, "teib-added");
 938 }
 939
 940 static void
 941 ipsec_tun_teib_entry_deleted (const teib_entry_t * ne)
 942 {
 943   ipsec_tun_protect_t *itp;
 944   index_t itpi;
 945
 946   itpi = ipsec_tun_protect_find (teib_entry_get_sw_if_index (ne),
 947                                  teib_entry_get_peer (ne));
 948
 949   if (INDEX_INVALID == itpi)
 950     return;
 951
 952   itp = ipsec_tun_protect_get (itpi);
 953   ipsec_tun_protect_rx_db_remove (&ipsec_main, itp);
 954   ipsec_tun_protect_update_from_teib (itp, NULL);
 955   ipsec_tun_protect_set_crypto_addr (itp);
 956
 957   ITP_DBG (itp, "teib-removed");
 958 }
 959
 960 /**
 961  * VFT registered with the adjacency delegate
 962  */
 963 const static adj_delegate_vft_t ipsec_tun_adj_delegate_vft = {
 964   .adv_adj_deleted = ipsec_tun_protect_adj_delegate_adj_deleted,
 965   .adv_adj_created = ipsec_tun_protect_adj_delegate_adj_created,
 966   .adv_adj_modified = ipsec_tun_protect_adj_delegate_adj_modified,
 967   .adv_format = ipsec_tun_protect_adj_delegate_format,
 968 };
 969
 970 const static teib_vft_t ipsec_tun_teib_vft = {
 971   .nv_added = ipsec_tun_teib_entry_added,
 972   .nv_deleted = ipsec_tun_teib_entry_deleted,
 973 };
 974
 975 void
 976 ipsec_tun_table_init (ip_address_family_t af, uword table_size, u32 n_buckets)
 977 {
 978   ipsec_main_t *im;
 979
 980   im = &ipsec_main;
 981
 982   if (AF_IP4 == af)
 983     clib_bihash_init_8_16 (&im->tun4_protect_by_key,
 984                            "IPSec IPv4 tunnels", n_buckets, table_size);
 985   else
 986     clib_bihash_init_24_16 (&im->tun6_protect_by_key,
 987                             "IPSec IPv6 tunnels", n_buckets, table_size);
 988 }
 989
 990 clib_error_t *
 991 ipsec_tunnel_protect_init (vlib_main_t * vm)
 992 {
 993   ipsec_main_t *im;
 994
 995   im = &ipsec_main;
 996   clib_bihash_init_24_16 (&im->tun6_protect_by_key,
 997                           "IPSec IPv6 tunnels",
 998                           IPSEC_TUN_DEFAULT_HASH_NUM_BUCKETS,
 999                           IPSEC_TUN_DEFAULT_HASH_MEMORY_SIZE);
1000   clib_bihash_init_8_16 (&im->tun4_protect_by_key,
1001                          "IPSec IPv4 tunnels",
1002                          IPSEC_TUN_DEFAULT_HASH_NUM_BUCKETS,
1003                          IPSEC_TUN_DEFAULT_HASH_MEMORY_SIZE);
1004
1005   /* set up feature nodes to drop outbound packets with no crypto alg set */
1006   im->esp4_no_crypto_tun_node_index =
1007     vlib_get_node_by_name (vm, (u8 *) "esp4-no-crypto")->index;
1008   im->esp6_no_crypto_tun_node_index =
1009     vlib_get_node_by_name (vm, (u8 *) "esp6-no-crypto")->index;
1010   im->esp6_encrypt_l2_tun_node_index =
1011     vlib_get_node_by_name (vm, (u8 *) "esp6-encrypt-tun")->index;
1012   im->esp4_encrypt_l2_tun_node_index =
1013     vlib_get_node_by_name (vm, (u8 *) "esp4-encrypt-tun")->index;
1014
1015   ipsec_tun_adj_delegate_type =
1016     adj_delegate_register_new_type (&ipsec_tun_adj_delegate_vft);
1017
1018   ipsec_tun_protect_logger = vlib_log_register_class ("ipsec", "tun");
1019
1020   teib_register (&ipsec_tun_teib_vft);
1021
1022   return 0;
1023 }
1024
1025 VLIB_INIT_FUNCTION (ipsec_tunnel_protect_init);
1026
1027 static clib_error_t *
1028 ipsec_config (vlib_main_t * vm, unformat_input_t * input)
1029 {
1030   unformat_input_t sub_input;
1031
1032   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1033     {
1034       if (unformat (input, "ip4 %U", unformat_vlib_cli_sub_input, &sub_input))
1035         {
1036           uword table_size = ~0;
1037           u32 n_buckets = ~0;
1038
1039           while (unformat_check_input (&sub_input) != UNFORMAT_END_OF_INPUT)
1040             {
1041               if (unformat (&sub_input, "num-buckets %u", &n_buckets))
1042                 ;
1043               else
1044                 return clib_error_return (0, "unknown input `%U'",
1045                                           format_unformat_error, &sub_input);
1046             }
1047
1048           ipsec_tun_table_init (AF_IP4, table_size, n_buckets);
1049         }
1050       else if (unformat (input, "ip6 %U", unformat_vlib_cli_sub_input,
1051                          &sub_input))
1052         {
1053           uword table_size = ~0;
1054           u32 n_buckets = ~0;
1055
1056           while (unformat_check_input (&sub_input) != UNFORMAT_END_OF_INPUT)
1057             {
1058               if (unformat (&sub_input, "num-buckets %u", &n_buckets))
1059                 ;
1060               else
1061                 return clib_error_return (0, "unknown input `%U'",
1062                                           format_unformat_error, &sub_input);
1063             }
1064
1065           ipsec_tun_table_init (AF_IP6, table_size, n_buckets);
1066         }
1067       else
1068         return clib_error_return (0, "unknown input `%U'",
1069                                   format_unformat_error, input);
1070     }
1071
1072   return 0;
1073 }
1074
1075 VLIB_CONFIG_FUNCTION (ipsec_config, "ipsec");
1076
1077 /*
1078  * fd.io coding-style-patch-verification: ON
1079  *
1080  * Local Variables:
1081  * eval: (c-set-style "gnu")
1082  * End:
1083  */