src/vnet/ipsec-gre/interface.c

   1 /*
   2  * gre_interface.c: gre interfaces
   3  *
   4  * Copyright (c) 2016 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  * @file
  19  * @brief L2-GRE over IPSec tunnel interface.
  20  *
  21  * Creates ipsec-gre tunnel interface.
  22  * Provides a command line interface so humans can interact with VPP.
  23  */
  24
  25 #include <vnet/vnet.h>
  26 #include <vnet/pg/pg.h>
  27 #include <vnet/ipsec-gre/ipsec_gre.h>
  28 #include <vnet/ip/format.h>
  29 #include <vnet/ipsec/ipsec.h>
  30
  31 #include <vnet/ipsec/esp.h>
  32
  33 u8 *
  34 format_ipsec_gre_tunnel (u8 * s, va_list * args)
  35 {
  36   ipsec_gre_tunnel_t *t = va_arg (*args, ipsec_gre_tunnel_t *);
  37   ipsec_gre_main_t *gm = &ipsec_gre_main;
  38
  39   s = format (s,
  40               "[%d] %U (src) %U (dst) local-sa %d remote-sa %d",
  41               t - gm->tunnels,
  42               format_ip4_address, &t->tunnel_src,
  43               format_ip4_address, &t->tunnel_dst,
  44               t->local_sa_id, t->remote_sa_id);
  45   return s;
  46 }
  47
  48 static clib_error_t *
  49 show_ipsec_gre_tunnel_command_fn (vlib_main_t * vm,
  50                                   unformat_input_t * input,
  51                                   vlib_cli_command_t * cmd)
  52 {
  53   ipsec_gre_main_t *igm = &ipsec_gre_main;
  54   ipsec_gre_tunnel_t *t;
  55
  56   if (pool_elts (igm->tunnels) == 0)
  57     vlib_cli_output (vm, "No IPSec GRE tunnels configured...");
  58
  59   /* *INDENT-OFF* */
  60   pool_foreach (t, igm->tunnels,
  61   ({
  62     vlib_cli_output (vm, "%U", format_ipsec_gre_tunnel, t);
  63   }));
  64   /* *INDENT-ON* */
  65
  66   return 0;
  67 }
  68
  69 /* *INDENT-OFF* */
  70 VLIB_CLI_COMMAND (show_ipsec_gre_tunnel_command, static) = {
  71     .path = "show ipsec gre tunnel",
  72     .function = show_ipsec_gre_tunnel_command_fn,
  73 };
  74 /* *INDENT-ON* */
  75
  76 /* force inclusion from application's main.c */
  77 clib_error_t *
  78 ipsec_gre_interface_init (vlib_main_t * vm)
  79 {
  80   return 0;
  81 }
  82
  83 VLIB_INIT_FUNCTION (ipsec_gre_interface_init);
  84
  85 /**
  86  * @brief Add or delete ipsec-gre tunnel interface.
  87  *
  88  * @param *a vnet_ipsec_gre_add_del_tunnel_args_t - tunnel interface parameters
  89  * @param *sw_if_indexp u32 - software interface index
  90  * @return int - 0 if success otherwise <code>VNET_API_ERROR_</code>
  91  */
  92 int
  93 vnet_ipsec_gre_add_del_tunnel (vnet_ipsec_gre_add_del_tunnel_args_t * a,
  94                                u32 * sw_if_indexp)
  95 {
  96   ipsec_gre_main_t *igm = &ipsec_gre_main;
  97   vnet_main_t *vnm = igm->vnet_main;
  98   ip4_main_t *im = &ip4_main;
  99   ipsec_gre_tunnel_t *t;
 100   vnet_hw_interface_t *hi;
 101   u32 hw_if_index, sw_if_index;
 102   u32 slot;
 103   uword *p;
 104   u64 key;
 105   ipsec_add_del_ipsec_gre_tunnel_args_t args;
 106
 107   memset (&args, 0, sizeof (args));
 108   args.is_add = a->is_add;
 109   args.local_sa_id = a->lsa;
 110   args.remote_sa_id = a->rsa;
 111   args.local_ip.as_u32 = a->src.as_u32;
 112   args.remote_ip.as_u32 = a->dst.as_u32;
 113
 114   key = (u64) a->src.as_u32 << 32 | (u64) a->dst.as_u32;
 115   p = hash_get (igm->tunnel_by_key, key);
 116
 117   if (a->is_add)
 118     {
 119       /* check if same src/dst pair exists */
 120       if (p)
 121         return VNET_API_ERROR_INVALID_VALUE;
 122
 123       pool_get_aligned (igm->tunnels, t, CLIB_CACHE_LINE_BYTES);
 124       memset (t, 0, sizeof (*t));
 125
 126       if (vec_len (igm->free_ipsec_gre_tunnel_hw_if_indices) > 0)
 127         {
 128           vnet_interface_main_t *im = &vnm->interface_main;
 129
 130           hw_if_index = igm->free_ipsec_gre_tunnel_hw_if_indices
 131             [vec_len (igm->free_ipsec_gre_tunnel_hw_if_indices) - 1];
 132           _vec_len (igm->free_ipsec_gre_tunnel_hw_if_indices) -= 1;
 133
 134           hi = vnet_get_hw_interface (vnm, hw_if_index);
 135           hi->dev_instance = t - igm->tunnels;
 136           hi->hw_instance = hi->dev_instance;
 137
 138           /* clear old stats of freed tunnel before reuse */
 139           sw_if_index = hi->sw_if_index;
 140           vnet_interface_counter_lock (im);
 141           vlib_zero_combined_counter
 142             (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
 143              sw_if_index);
 144           vlib_zero_combined_counter
 145             (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX],
 146              sw_if_index);
 147           vlib_zero_simple_counter
 148             (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
 149           vnet_interface_counter_unlock (im);
 150         }
 151       else
 152         {
 153           hw_if_index = vnet_register_interface
 154             (vnm, ipsec_gre_device_class.index, t - igm->tunnels,
 155              ipsec_gre_hw_interface_class.index, t - igm->tunnels);
 156           hi = vnet_get_hw_interface (vnm, hw_if_index);
 157           sw_if_index = hi->sw_if_index;
 158         }
 159
 160       t->hw_if_index = hw_if_index;
 161       t->sw_if_index = sw_if_index;
 162       t->local_sa_id = a->lsa;
 163       t->remote_sa_id = a->rsa;
 164       t->local_sa = ipsec_get_sa_index_by_sa_id (a->lsa);
 165       t->remote_sa = ipsec_get_sa_index_by_sa_id (a->rsa);
 166
 167       ip4_sw_interface_enable_disable (sw_if_index, 1);
 168
 169       vec_validate_init_empty (igm->tunnel_index_by_sw_if_index,
 170                                sw_if_index, ~0);
 171       igm->tunnel_index_by_sw_if_index[sw_if_index] = t - igm->tunnels;
 172
 173       vec_validate (im->fib_index_by_sw_if_index, sw_if_index);
 174
 175       hi->min_packet_bytes = 64 + sizeof (gre_header_t) +
 176         sizeof (ip4_header_t) + sizeof (esp_header_t) + sizeof (esp_footer_t);
 177
 178       /* Standard default gre MTU. */
 179       /* TODO: Should take tunnel overhead into consideration */
 180       vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
 181
 182       clib_memcpy (&t->tunnel_src, &a->src, sizeof (t->tunnel_src));
 183       clib_memcpy (&t->tunnel_dst, &a->dst, sizeof (t->tunnel_dst));
 184
 185       hash_set (igm->tunnel_by_key, key, t - igm->tunnels);
 186
 187       slot = vlib_node_add_named_next_with_slot
 188         (vnm->vlib_main, hi->tx_node_index, "esp-encrypt",
 189          IPSEC_GRE_OUTPUT_NEXT_ESP_ENCRYPT);
 190
 191       ASSERT (slot == IPSEC_GRE_OUTPUT_NEXT_ESP_ENCRYPT);
 192
 193     }
 194   else
 195     {                           /* !is_add => delete */
 196       /* tunnel needs to exist */
 197       if (!p)
 198         return VNET_API_ERROR_NO_SUCH_ENTRY;
 199
 200       t = pool_elt_at_index (igm->tunnels, p[0]);
 201
 202       sw_if_index = t->sw_if_index;
 203       ip4_sw_interface_enable_disable (sw_if_index, 0);
 204       vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
 205       /* make sure tunnel is removed from l2 bd or xconnect */
 206       set_int_l2_mode (igm->vlib_main, vnm, MODE_L3, sw_if_index, 0, 0, 0, 0);
 207       vec_add1 (igm->free_ipsec_gre_tunnel_hw_if_indices, t->hw_if_index);
 208       igm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
 209
 210       hash_unset (igm->tunnel_by_key, key);
 211       pool_put (igm->tunnels, t);
 212     }
 213
 214   if (sw_if_indexp)
 215     *sw_if_indexp = sw_if_index;
 216
 217   return ipsec_add_del_ipsec_gre_tunnel (vnm, &args);
 218 }
 219
 220 static clib_error_t *
 221 create_ipsec_gre_tunnel_command_fn (vlib_main_t * vm,
 222                                     unformat_input_t * input,
 223                                     vlib_cli_command_t * cmd)
 224 {
 225   unformat_input_t _line_input, *line_input = &_line_input;
 226   u8 is_add = 1;
 227   u32 num_m_args = 0;
 228   ip4_address_t src, dst;
 229   u32 lsa = 0, rsa = 0;
 230   vnet_ipsec_gre_add_del_tunnel_args_t _a, *a = &_a;
 231   int rv;
 232   u32 sw_if_index;
 233   clib_error_t *error = NULL;
 234
 235   /* Get a line of input. */
 236   if (!unformat_user (input, unformat_line_input, line_input))
 237     return 0;
 238
 239   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 240     {
 241       if (unformat (line_input, "del"))
 242         is_add = 0;
 243       else if (unformat (line_input, "src %U", unformat_ip4_address, &src))
 244         num_m_args++;
 245       else if (unformat (line_input, "dst %U", unformat_ip4_address, &dst))
 246         num_m_args++;
 247       else if (unformat (line_input, "local-sa %d", &lsa))
 248         num_m_args++;
 249       else if (unformat (line_input, "remote-sa %d", &rsa))
 250         num_m_args++;
 251       else
 252         {
 253           error = clib_error_return (0, "unknown input `%U'",
 254                                      format_unformat_error, line_input);
 255           goto done;
 256         }
 257     }
 258
 259   if (num_m_args < 4)
 260     {
 261       error = clib_error_return (0, "mandatory argument(s) missing");
 262       goto done;
 263     }
 264
 265   if (memcmp (&src, &dst, sizeof (src)) == 0)
 266     {
 267       error = clib_error_return (0, "src and dst are identical");
 268       goto done;
 269     }
 270
 271   memset (a, 0, sizeof (*a));
 272   a->is_add = is_add;
 273   a->lsa = lsa;
 274   a->rsa = rsa;
 275   clib_memcpy (&a->src, &src, sizeof (src));
 276   clib_memcpy (&a->dst, &dst, sizeof (dst));
 277
 278   rv = vnet_ipsec_gre_add_del_tunnel (a, &sw_if_index);
 279
 280   switch (rv)
 281     {
 282     case 0:
 283       vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
 284                        vnet_get_main (), sw_if_index);
 285       break;
 286     case VNET_API_ERROR_INVALID_VALUE:
 287       error = clib_error_return (0, "GRE tunnel already exists...");
 288       goto done;
 289     default:
 290       error = clib_error_return (0,
 291                                  "vnet_ipsec_gre_add_del_tunnel returned %d",
 292                                  rv);
 293       goto done;
 294     }
 295
 296 done:
 297   unformat_free (line_input);
 298
 299   return error;
 300 }
 301
 302 /* *INDENT-OFF* */
 303 VLIB_CLI_COMMAND (create_ipsec_gre_tunnel_command, static) = {
 304   .path = "create ipsec gre tunnel",
 305   .short_help = "create ipsec gre tunnel src <addr> dst <addr> "
 306                 "local-sa <id> remote-sa <id> [del]",
 307   .function = create_ipsec_gre_tunnel_command_fn,
 308 };
 309 /* *INDENT-ON* */
 310
 311 /*
 312 * fd.io coding-style-patch-verification: ON
 313 *
 314 * Local Variables:
 315 * eval: (c-set-style "gnu")
 316 * End:
 317 */