FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
ipsec_if_in.c
Go to the documentation of this file.
1 /*
2  * ipsec_if_in.c : IPSec interface input node
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/vnet.h>
19 #include <vnet/api_errno.h>
20 #include <vnet/ip/ip.h>
21 
22 #include <vnet/ipsec/ipsec.h>
23 #include <vnet/ipsec/esp.h>
24 
25 /* Statistics (not really errors) */
26 #define foreach_ipsec_if_input_error \
27 _(RX, "good packets received")
28 
29 static char *ipsec_if_input_error_strings[] = {
30 #define _(sym,string) string,
32 #undef _
33 };
34 
35 typedef enum
36 {
37 #define _(sym,str) IPSEC_IF_INPUT_ERROR_##sym,
39 #undef _
42 
43 
44 typedef struct
45 {
49 
50 u8 *
51 format_ipsec_if_input_trace (u8 * s, va_list * args)
52 {
53  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
54  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
55  ipsec_if_input_trace_t *t = va_arg (*args, ipsec_if_input_trace_t *);
56 
57  s = format (s, "IPSec: spi %u seq %u", t->spi, t->seq);
58  return s;
59 }
60 
61 static uword
63  vlib_frame_t * from_frame)
64 {
65  ipsec_main_t *im = &ipsec_main;
66  vnet_main_t *vnm = im->vnet_main;
69  u32 *from, *to_next = 0, next_index;
70  u32 n_left_from, last_sw_if_index = ~0;
71  u32 thread_index = vlib_get_thread_index ();
72  u64 n_bytes = 0, n_packets = 0;
73  u8 icv_len;
74  ipsec_tunnel_if_t *last_t = NULL;
75  ipsec_sa_t *sa0;
76 
77  from = vlib_frame_vector_args (from_frame);
78  n_left_from = from_frame->n_vectors;
79  next_index = node->cached_next_index;
80 
81  while (n_left_from > 0)
82  {
83  u32 n_left_to_next;
84 
85  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
86 
87  while (n_left_from > 0 && n_left_to_next > 0)
88  {
89  u32 bi0, next0, sw_if_index0;
90  vlib_buffer_t *b0;
91  ip4_header_t *ip0;
92  esp_header_t *esp0;
93  uword *p;
94 
95  bi0 = to_next[0] = from[0];
96  from += 1;
97  n_left_from -= 1;
98  to_next += 1;
99  n_left_to_next -= 1;
100  b0 = vlib_get_buffer (vm, bi0);
101  ip0 = vlib_buffer_get_current (b0);
102  esp0 = (esp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
103 
104  next0 = IPSEC_INPUT_NEXT_DROP;
105 
106  u64 key = (u64) ip0->src_address.as_u32 << 32 |
107  (u64) clib_net_to_host_u32 (esp0->spi);
108 
109  p = hash_get (im->ipsec_if_pool_index_by_key, key);
110 
111  if (p)
112  {
114  t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
115  vnet_buffer (b0)->ipsec.sad_index = t->input_sa_index;
116  if (t->hw_if_index != ~0)
117  {
119 
120  vnet_buffer (b0)->ipsec.flags = 0;
121  hi = vnet_get_hw_interface (vnm, t->hw_if_index);
122  sw_if_index0 = hi->sw_if_index;
123  vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index0;
124 
125  if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
126  {
127  n_packets++;
128  n_bytes += vlib_buffer_length_in_chain (vm, b0);
129  }
130  else
131  {
132  sa0 = pool_elt_at_index (im->sad, t->input_sa_index);
133  icv_len =
135  integ_alg].trunc_size;
136 
137  /* length = packet length - ESP/tunnel overhead */
138  n_bytes -= n_packets * (sizeof (ip4_header_t) +
139  sizeof (esp_header_t) +
140  sizeof (esp_footer_t) +
141  16 /* aes-cbc IV */ + icv_len);
142 
143  if (last_t)
144  {
148  thread_index, sw_if_index0, n_packets, n_bytes);
149  }
150 
151  last_sw_if_index = sw_if_index0;
152  last_t = t;
153  n_packets = 1;
154  n_bytes = vlib_buffer_length_in_chain (vm, b0);
155  }
156  }
157  else
158  {
159  vnet_buffer (b0)->ipsec.flags = IPSEC_FLAG_IPSEC_GRE_TUNNEL;
160  }
161 
163  next0 = im->esp_decrypt_next_index;
164  }
165 
167  {
169  vlib_add_trace (vm, node, b0, sizeof (*tr));
170  tr->spi = clib_host_to_net_u32 (esp0->spi);
171  tr->seq = clib_host_to_net_u32 (esp0->seq);
172  }
173 
174  vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
175  n_left_to_next, bi0, next0);
176  }
177  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
178  }
179 
180  if (last_t)
181  {
182  sa0 = pool_elt_at_index (im->sad, last_t->input_sa_index);
184 
185  n_bytes -= n_packets * (sizeof (ip4_header_t) + sizeof (esp_header_t) +
186  sizeof (esp_footer_t) + 16 /* aes-cbc IV */ +
187  icv_len);
190  thread_index,
191  last_sw_if_index, n_packets, n_bytes);
192  }
193 
195  IPSEC_IF_INPUT_ERROR_RX,
196  from_frame->n_vectors);
197 
198  return from_frame->n_vectors;
199 }
200 
201 /* *INDENT-OFF* */
203  .function = ipsec_if_input_node_fn,
204  .name = "ipsec-if-input",
205  .vector_size = sizeof (u32),
206  .format_trace = format_ipsec_if_input_trace,
207  .type = VLIB_NODE_TYPE_INTERNAL,
208 
210  .error_strings = ipsec_if_input_error_strings,
211 
212  .sibling_of = "ipsec-input-ip4",
213 };
214 /* *INDENT-ON* */
215 
217 /*
218  * fd.io coding-style-patch-verification: ON
219  *
220  * Local Variables:
221  * eval: (c-set-style "gnu")
222  * End:
223  */
vmrglw vmrglh hi
ipsec_if_input_error_t
Definition: ipsec_if_in.c:35
#define CLIB_UNUSED(x)
Definition: clib.h:79
ipsec_tunnel_if_t * tunnel_interfaces
Definition: ipsec.h:261
static void vlib_increment_combined_counter(vlib_combined_counter_main_t *cm, u32 thread_index, u32 index, u64 n_packets, u64 n_bytes)
Increment a combined counter.
Definition: counter.h:211
ip4_address_t src_address
Definition: ip4_packet.h:164
ipsec_proto_main_integ_alg_t * ipsec_proto_main_integ_algs
Definition: esp.h:93
vnet_interface_main_t interface_main
Definition: vnet.h:56
#define PREDICT_TRUE(x)
Definition: clib.h:106
#define foreach_ipsec_if_input_error
Definition: ipsec_if_in.c:26
static int ip4_header_bytes(ip4_header_t *i)
Definition: ip4_packet.h:227
#define NULL
Definition: clib.h:55
u8 * format_ipsec_if_input_trace(u8 *s, va_list *args)
Definition: ipsec_if_in.c:51
ipsec_integ_alg_t integ_alg
Definition: ipsec.h:121
static vnet_hw_interface_t * vnet_get_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
static uword ipsec_if_input_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *from_frame)
Definition: ipsec_if_in.c:62
static uword vlib_buffer_length_in_chain(vlib_main_t *vm, vlib_buffer_t *b)
Get length in bytes of the buffer chain.
Definition: buffer_funcs.h:107
uword * ipsec_if_pool_index_by_key
Definition: ipsec.h:279
ipsec_main_t ipsec_main
Definition: ipsec.c:28
vlib_combined_counter_main_t * combined_sw_if_counters
Definition: interface.h:672
unsigned long u64
Definition: types.h:89
vlib_node_registration_t ipsec_if_input_node
(constructor) VLIB_REGISTER_NODE (ipsec_if_input_node)
Definition: ipsec_if_in.c:202
#define hash_get(h, key)
Definition: hash.h:248
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:459
vnet_main_t * vnet_main
Definition: ipsec.h:270
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:195
#define PREDICT_FALSE(x)
Definition: clib.h:105
#define vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, bi0, next0)
Finish enqueueing one buffer forward in the graph.
Definition: buffer_node.h:218
#define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)
Get pointer to next frame vector data by (vlib_node_runtime_t, next_index).
Definition: node_funcs.h:364
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1158
u16 n_vectors
Definition: node.h:344
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:221
vlib_main_t * vm
Definition: buffer.c:283
u32 esp_decrypt_next_index
Definition: ipsec.h:289
#define VLIB_BUFFER_IS_TRACED
Definition: buffer.h:93
#define ARRAY_LEN(x)
Definition: clib.h:59
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_vectors_left)
Release pointer to next frame vector data.
Definition: main.c:454
static char * ipsec_if_input_error_strings[]
Definition: ipsec_if_in.c:29
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:456
unsigned int u32
Definition: types.h:88
ipsec_sa_t * sad
Definition: ipsec.h:258
u32 seq
Definition: esp.h:28
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:208
u32 spi
Definition: esp.h:27
u32 input_sa_index
Definition: ipsec.h:243
u64 uword
Definition: types.h:112
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:55
unsigned char u8
Definition: types.h:56
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:267
#define vnet_buffer(b)
Definition: buffer.h:326
#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
Definition: node.h:158
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:143
ipsec_proto_main_t ipsec_proto_main
Definition: esp_encrypt.c:25
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:75
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57
#define IPSEC_FLAG_IPSEC_GRE_TUNNEL
Definition: ipsec.h:21
Definition: defs.h:46