Add IPSec interface FIB index for TX packet
[vpp.git] / src / vnet / ipsec / ipsec_if.c
index 9359a3b..3054af1 100644 (file)
@@ -18,6 +18,7 @@
 #include <vnet/vnet.h>
 #include <vnet/api_errno.h>
 #include <vnet/ip/ip.h>
+#include <vnet/fib/fib.h>
 
 #include <vnet/ipsec/ipsec.h>
 #include <vnet/ipsec/esp.h>
@@ -28,17 +29,134 @@ static u8 *
 format_ipsec_name (u8 * s, va_list * args)
 {
   u32 dev_instance = va_arg (*args, u32);
-  return format (s, "ipsec%d", dev_instance);
+  ipsec_main_t *im = &ipsec_main;
+  ipsec_tunnel_if_t *t = im->tunnel_interfaces + dev_instance;
+
+  return format (s, "ipsec%d", t->show_instance);
+}
+
+/* Statistics (not really errors) */
+#define foreach_ipsec_if_tx_error    \
+_(TX, "good packets transmitted")
+
+static char *ipsec_if_tx_error_strings[] = {
+#define _(sym,string) string,
+  foreach_ipsec_if_tx_error
+#undef _
+};
+
+typedef enum
+{
+#define _(sym,str) IPSEC_IF_OUTPUT_ERROR_##sym,
+  foreach_ipsec_if_tx_error
+#undef _
+    IPSEC_IF_TX_N_ERROR,
+} ipsec_if_tx_error_t;
+
+typedef struct
+{
+  u32 spi;
+  u32 seq;
+} ipsec_if_tx_trace_t;
+
+u8 *
+format_ipsec_if_tx_trace (u8 * s, va_list * args)
+{
+  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
+  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
+  ipsec_if_tx_trace_t *t = va_arg (*args, ipsec_if_tx_trace_t *);
+
+  s = format (s, "IPSec: spi %u seq %u", t->spi, t->seq);
+  return s;
 }
 
 static uword
-dummy_interface_tx (vlib_main_t * vm,
-                   vlib_node_runtime_t * node, vlib_frame_t * frame)
+ipsec_if_tx_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
+                    vlib_frame_t * from_frame)
 {
-  clib_warning ("you shouldn't be here, leaking buffers...");
-  return frame->n_vectors;
+  ipsec_main_t *im = &ipsec_main;
+  vnet_main_t *vnm = im->vnet_main;
+  vnet_interface_main_t *vim = &vnm->interface_main;
+  u32 *from, *to_next = 0, next_index;
+  u32 n_left_from, sw_if_index0, last_sw_if_index = ~0;
+  u32 thread_index = vm->thread_index;
+  u32 n_bytes = 0, n_packets = 0;
+
+  from = vlib_frame_vector_args (from_frame);
+  n_left_from = from_frame->n_vectors;
+  next_index = node->cached_next_index;
+
+  while (n_left_from > 0)
+    {
+      u32 n_left_to_next;
+
+      vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
+
+      while (n_left_from > 0 && n_left_to_next > 0)
+       {
+         u32 bi0, next0, len0;
+         vlib_buffer_t *b0;
+         ipsec_tunnel_if_t *t0;
+         vnet_hw_interface_t *hi0;
+
+         bi0 = to_next[0] = from[0];
+         from += 1;
+         n_left_from -= 1;
+         to_next += 1;
+         n_left_to_next -= 1;
+         b0 = vlib_get_buffer (vm, bi0);
+         sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
+         hi0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
+         t0 = pool_elt_at_index (im->tunnel_interfaces, hi0->dev_instance);
+         vnet_buffer (b0)->ipsec.sad_index = t0->output_sa_index;
+         next0 = IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT;
+
+         len0 = vlib_buffer_length_in_chain (vm, b0);
+
+         if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
+           {
+             n_packets++;
+             n_bytes += len0;
+           }
+         else
+           {
+             vlib_increment_combined_counter (vim->combined_sw_if_counters +
+                                              VNET_INTERFACE_COUNTER_TX,
+                                              thread_index, sw_if_index0,
+                                              n_packets, n_bytes);
+             last_sw_if_index = sw_if_index0;
+             n_packets = 1;
+             n_bytes = len0;
+           }
+
+         if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
+           {
+             ipsec_if_tx_trace_t *tr =
+               vlib_add_trace (vm, node, b0, sizeof (*tr));
+             ipsec_sa_t *sa0 =
+               pool_elt_at_index (im->sad, t0->output_sa_index);
+             tr->spi = sa0->spi;
+             tr->seq = sa0->seq;
+           }
+
+         vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
+                                          n_left_to_next, bi0, next0);
+       }
+      vlib_put_next_frame (vm, node, next_index, n_left_to_next);
+    }
+
+  if (last_sw_if_index != ~0)
+    {
+      vlib_increment_combined_counter (vim->combined_sw_if_counters +
+                                      VNET_INTERFACE_COUNTER_TX,
+                                      thread_index,
+                                      last_sw_if_index, n_packets, n_bytes);
+    }
+
+  return from_frame->n_vectors;
 }
 
+
 static clib_error_t *
 ipsec_admin_up_down_function (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 {
@@ -49,17 +167,27 @@ ipsec_admin_up_down_function (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
   ipsec_sa_t *sa;
 
   hi = vnet_get_hw_interface (vnm, hw_if_index);
+  t = pool_elt_at_index (im->tunnel_interfaces, hi->hw_instance);
+
   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
     {
-      t = pool_elt_at_index (im->tunnel_interfaces, hi->hw_instance);
-      ASSERT (im->cb.check_support_cb);
       sa = pool_elt_at_index (im->sad, t->input_sa_index);
-      err = im->cb.check_support_cb (sa);
+
+      err = ipsec_check_support_cb (im, sa);
+      if (err)
+       return err;
+
+      err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 1);
       if (err)
        return err;
 
       sa = pool_elt_at_index (im->sad, t->output_sa_index);
-      err = im->cb.check_support_cb (sa);
+
+      err = ipsec_check_support_cb (im, sa);
+      if (err)
+       return err;
+
+      err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 1);
       if (err)
        return err;
 
@@ -67,18 +195,31 @@ ipsec_admin_up_down_function (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
                                   VNET_HW_INTERFACE_FLAG_LINK_UP);
     }
   else
-    vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
+    {
+      vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
+      sa = pool_elt_at_index (im->sad, t->input_sa_index);
+      err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 0);
+      if (err)
+       return err;
+      sa = pool_elt_at_index (im->sad, t->output_sa_index);
+      err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 0);
+      if (err)
+       return err;
+    }
 
   return /* no error */ 0;
 }
 
+
 /* *INDENT-OFF* */
 VNET_DEVICE_CLASS (ipsec_device_class, static) =
 {
   .name = "IPSec",
   .format_device_name = format_ipsec_name,
-  .format_tx_trace = format_ipsec_if_output_trace,
-  .tx_function = dummy_interface_tx,
+  .format_tx_trace = format_ipsec_if_tx_trace,
+  .tx_function = ipsec_if_tx_node_fn,
+  .tx_function_n_errors = IPSEC_IF_TX_N_ERROR,
+  .tx_function_error_strings = ipsec_if_tx_error_strings,
   .admin_up_down_function = ipsec_admin_up_down_function,
 };
 /* *INDENT-ON* */
@@ -120,6 +261,9 @@ ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
   u32 hw_if_index = ~0;
   uword *p;
   ipsec_sa_t *sa;
+  u32 dev_instance;
+  u32 slot;
+  u32 tx_fib_index = ~0;
 
   u64 key = (u64) args->remote_ip.as_u32 << 32 | (u64) args->remote_spi;
   p = hash_get (im->ipsec_if_pool_index_by_key, key);
@@ -130,11 +274,30 @@ ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
       if (p)
        return VNET_API_ERROR_INVALID_VALUE;
 
+      tx_fib_index = fib_table_find (FIB_PROTOCOL_IP4, args->tx_table_id);
+      if (tx_fib_index == ~((u32) 0))
+       return VNET_API_ERROR_NO_SUCH_FIB;
+
       pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
-      memset (t, 0, sizeof (*t));
+      clib_memset (t, 0, sizeof (*t));
+
+      dev_instance = t - im->tunnel_interfaces;
+      if (args->renumber)
+       t->show_instance = args->show_instance;
+      else
+       t->show_instance = dev_instance;
+
+      if (hash_get (im->ipsec_if_real_dev_by_show_dev, t->show_instance))
+       {
+         pool_put (im->tunnel_interfaces, t);
+         return VNET_API_ERROR_INSTANCE_IN_USE;
+       }
+
+      hash_set (im->ipsec_if_real_dev_by_show_dev, t->show_instance,
+               dev_instance);
 
       pool_get (im->sad, sa);
-      memset (sa, 0, sizeof (*sa));
+      clib_memset (sa, 0, sizeof (*sa));
       t->input_sa_index = sa - im->sad;
       sa->spi = args->remote_spi;
       sa->tunnel_src_addr.ip4.as_u32 = args->remote_ip.as_u32;
@@ -143,6 +306,8 @@ ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
       sa->use_esn = args->esn;
       sa->use_anti_replay = args->anti_replay;
       sa->integ_alg = args->integ_alg;
+      sa->udp_encap = args->udp_encap;
+      sa->tx_fib_index = ~((u32) 0);   /* Not used, but set for troubleshooting */
       if (args->remote_integ_key_len <= sizeof (args->remote_integ_key))
        {
          sa->integ_key_len = args->remote_integ_key_len;
@@ -157,21 +322,18 @@ ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
                       args->remote_crypto_key_len);
        }
 
-      if (im->cb.add_del_sa_sess_cb &&
-         im->cb.add_del_sa_sess_cb (t->input_sa_index, args->is_add) < 0)
-       return VNET_API_ERROR_SYSCALL_ERROR_1;
-
       pool_get (im->sad, sa);
-      memset (sa, 0, sizeof (*sa));
+      clib_memset (sa, 0, sizeof (*sa));
       t->output_sa_index = sa - im->sad;
       sa->spi = args->local_spi;
       sa->tunnel_src_addr.ip4.as_u32 = args->local_ip.as_u32;
       sa->tunnel_dst_addr.ip4.as_u32 = args->remote_ip.as_u32;
       sa->is_tunnel = 1;
-      sa->seq = 1;
       sa->use_esn = args->esn;
       sa->use_anti_replay = args->anti_replay;
       sa->integ_alg = args->integ_alg;
+      sa->udp_encap = args->udp_encap;
+      sa->tx_fib_index = tx_fib_index;
       if (args->local_integ_key_len <= sizeof (args->local_integ_key))
        {
          sa->integ_key_len = args->local_integ_key_len;
@@ -186,33 +348,27 @@ ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
                       args->local_crypto_key_len);
        }
 
-      if (im->cb.add_del_sa_sess_cb &&
-         im->cb.add_del_sa_sess_cb (t->output_sa_index, args->is_add) < 0)
-       return VNET_API_ERROR_SYSCALL_ERROR_1;
-
       hash_set (im->ipsec_if_pool_index_by_key, key,
                t - im->tunnel_interfaces);
 
-      if (vec_len (im->free_tunnel_if_indices) > 0)
-       {
-         hw_if_index =
-           im->free_tunnel_if_indices[vec_len (im->free_tunnel_if_indices) -
-                                      1];
-         _vec_len (im->free_tunnel_if_indices) -= 1;
-       }
-      else
-       {
-         hw_if_index =
-           vnet_register_interface (vnm, ipsec_device_class.index,
-                                    t - im->tunnel_interfaces,
-                                    ipsec_hw_class.index,
-                                    t - im->tunnel_interfaces);
-       }
+      hw_if_index = vnet_register_interface (vnm, ipsec_device_class.index,
+                                            t - im->tunnel_interfaces,
+                                            ipsec_hw_class.index,
+                                            t - im->tunnel_interfaces);
 
       hi = vnet_get_hw_interface (vnm, hw_if_index);
-      hi->output_node_index = ipsec_if_output_node.index;
+
+      slot = vlib_node_add_next_with_slot
+       (vnm->vlib_main, hi->tx_node_index, im->esp4_encrypt_node_index,
+        IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT);
+
+      ASSERT (slot == IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT);
+
       t->hw_if_index = hw_if_index;
 
+      vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
+                                  hi->sw_if_index, 1, 0, 0);
+
       /*1st interface, register protocol */
       if (pool_elts (im->tunnel_interfaces) == 1)
        ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
@@ -221,8 +377,6 @@ ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
     }
   else
     {
-      vnet_interface_main_t *vim = &vnm->interface_main;
-
       /* check if exists */
       if (!p)
        return VNET_API_ERROR_INVALID_VALUE;
@@ -230,33 +384,23 @@ ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
       t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
       hi = vnet_get_hw_interface (vnm, t->hw_if_index);
       vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0);   /* admin down */
-      vec_add1 (im->free_tunnel_if_indices, t->hw_if_index);
 
-      vnet_interface_counter_lock (vim);
-      vlib_zero_combined_counter (vim->combined_sw_if_counters +
-                                 VNET_INTERFACE_COUNTER_TX, hi->sw_if_index);
-      vlib_zero_combined_counter (vim->combined_sw_if_counters +
-                                 VNET_INTERFACE_COUNTER_RX, hi->sw_if_index);
-      vnet_interface_counter_unlock (vim);
+      vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
+                                  hi->sw_if_index, 0, 0, 0);
 
-      /* delete input and output SA */
-      sa = pool_elt_at_index (im->sad, t->input_sa_index);
+      vnet_delete_hw_interface (vnm, t->hw_if_index);
 
-      if (im->cb.add_del_sa_sess_cb &&
-         im->cb.add_del_sa_sess_cb (t->input_sa_index, args->is_add) < 0)
-       return VNET_API_ERROR_SYSCALL_ERROR_1;
+      /* delete input and output SA */
 
+      sa = pool_elt_at_index (im->sad, t->input_sa_index);
       pool_put (im->sad, sa);
 
       sa = pool_elt_at_index (im->sad, t->output_sa_index);
-
-      if (im->cb.add_del_sa_sess_cb &&
-         im->cb.add_del_sa_sess_cb (t->output_sa_index, args->is_add) < 0)
-       return VNET_API_ERROR_SYSCALL_ERROR_1;
-
       pool_put (im->sad, sa);
 
       hash_unset (im->ipsec_if_pool_index_by_key, key);
+      hash_unset (im->ipsec_if_real_dev_by_show_dev, t->show_instance);
+
       pool_put (im->tunnel_interfaces, t);
     }
 
@@ -302,7 +446,7 @@ ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
        return VNET_API_ERROR_INVALID_VALUE;
 
       pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
-      memset (t, 0, sizeof (*t));
+      clib_memset (t, 0, sizeof (*t));
 
       t->input_sa_index = isa;
       t->output_sa_index = osa;
@@ -340,16 +484,15 @@ ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
   hi = vnet_get_hw_interface (vnm, hw_if_index);
   t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
 
+  if (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
+    return VNET_API_ERROR_SYSCALL_ERROR_1;
+
   if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO)
     {
       sa = pool_elt_at_index (im->sad, t->output_sa_index);
       sa->crypto_alg = alg;
       sa->crypto_key_len = vec_len (key);
       clib_memcpy (sa->crypto_key, key, vec_len (key));
-
-      if (im->cb.add_del_sa_sess_cb &&
-         im->cb.add_del_sa_sess_cb (t->output_sa_index, 0) < 0)
-       return VNET_API_ERROR_SYSCALL_ERROR_1;
     }
   else if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG)
     {
@@ -357,10 +500,6 @@ ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
       sa->integ_alg = alg;
       sa->integ_key_len = vec_len (key);
       clib_memcpy (sa->integ_key, key, vec_len (key));
-
-      if (im->cb.add_del_sa_sess_cb &&
-         im->cb.add_del_sa_sess_cb (t->output_sa_index, 0) < 0)
-       return VNET_API_ERROR_SYSCALL_ERROR_1;
     }
   else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO)
     {
@@ -368,10 +507,6 @@ ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
       sa->crypto_alg = alg;
       sa->crypto_key_len = vec_len (key);
       clib_memcpy (sa->crypto_key, key, vec_len (key));
-
-      if (im->cb.add_del_sa_sess_cb &&
-         im->cb.add_del_sa_sess_cb (t->input_sa_index, 0) < 0)
-       return VNET_API_ERROR_SYSCALL_ERROR_1;
     }
   else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG)
     {
@@ -379,10 +514,6 @@ ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
       sa->integ_alg = alg;
       sa->integ_key_len = vec_len (key);
       clib_memcpy (sa->integ_key, key, vec_len (key));
-
-      if (im->cb.add_del_sa_sess_cb &&
-         im->cb.add_del_sa_sess_cb (t->input_sa_index, 0) < 0)
-       return VNET_API_ERROR_SYSCALL_ERROR_1;
     }
   else
     return VNET_API_ERROR_INVALID_VALUE;
@@ -391,12 +522,88 @@ ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
 }
 
 
+int
+ipsec_set_interface_sa (vnet_main_t * vnm, u32 hw_if_index, u32 sa_id,
+                       u8 is_outbound)
+{
+  ipsec_main_t *im = &ipsec_main;
+  vnet_hw_interface_t *hi;
+  ipsec_tunnel_if_t *t;
+  ipsec_sa_t *sa, *old_sa;
+  u32 sa_index, old_sa_index;
+  uword *p;
+
+  hi = vnet_get_hw_interface (vnm, hw_if_index);
+  t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
+
+  sa_index = ipsec_get_sa_index_by_sa_id (sa_id);
+  if (sa_index == ~0)
+    {
+      clib_warning ("SA with ID %u not found", sa_id);
+      return VNET_API_ERROR_INVALID_VALUE;
+    }
+
+  if (ipsec_is_sa_used (sa_index))
+    {
+      clib_warning ("SA with ID %u is already in use", sa_id);
+      return VNET_API_ERROR_INVALID_VALUE;
+    }
+
+  sa = pool_elt_at_index (im->sad, sa_index);
+  if (sa->is_tunnel_ip6)
+    {
+      clib_warning ("IPsec interface not supported with IPv6 endpoints");
+      return VNET_API_ERROR_UNIMPLEMENTED;
+    }
+
+  if (!is_outbound)
+    {
+      u64 key;
+
+      old_sa_index = t->input_sa_index;
+      old_sa = pool_elt_at_index (im->sad, old_sa_index);
+
+      /* unset old inbound hash entry. packets should stop arriving */
+      key =
+       (u64) old_sa->tunnel_src_addr.ip4.as_u32 << 32 | (u64) old_sa->spi;
+      p = hash_get (im->ipsec_if_pool_index_by_key, key);
+      if (p)
+       hash_unset (im->ipsec_if_pool_index_by_key, key);
+
+      /* set new inbound SA, then set new hash entry */
+      t->input_sa_index = sa_index;
+      key = (u64) sa->tunnel_src_addr.ip4.as_u32 << 32 | (u64) sa->spi;
+      hash_set (im->ipsec_if_pool_index_by_key, key, hi->dev_instance);
+    }
+  else
+    {
+      old_sa_index = t->output_sa_index;
+      old_sa = pool_elt_at_index (im->sad, old_sa_index);
+      t->output_sa_index = sa_index;
+    }
+
+  /* remove sa_id to sa_index mapping on old SA */
+  if (ipsec_get_sa_index_by_sa_id (old_sa->id) == old_sa_index)
+    hash_unset (im->sa_index_by_sa_id, old_sa->id);
+
+  if (!ipsec_add_del_sa_sess_cb (im, old_sa_index, 0))
+    {
+      clib_warning ("IPsec backend add/del callback returned error");
+      return VNET_API_ERROR_SYSCALL_ERROR_1;
+    }
+  pool_put (im->sad, old_sa);
+
+  return 0;
+}
+
+
 clib_error_t *
 ipsec_tunnel_if_init (vlib_main_t * vm)
 {
   ipsec_main_t *im = &ipsec_main;
 
   im->ipsec_if_pool_index_by_key = hash_create (0, sizeof (uword));
+  im->ipsec_if_real_dev_by_show_dev = hash_create (0, sizeof (uword));
 
   return 0;
 }