FD.io VPP  v19.04.2-12-g66b1689
Vector Packet Processing
ipsec_output.c
Go to the documentation of this file.
1 /*
2  * ipsec_output.c : IPSec output 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/ipsec_io.h>
24 
25 #if WITH_LIBSSL > 0
26 
27 #define foreach_ipsec_output_error \
28  _(RX_PKTS, "IPSec pkts received") \
29  _(POLICY_DISCARD, "IPSec policy discard") \
30  _(POLICY_NO_MATCH, "IPSec policy (no match)") \
31  _(POLICY_PROTECT, "IPSec policy protect") \
32  _(POLICY_BYPASS, "IPSec policy bypass") \
33  _(ENCAPS_FAILED, "IPSec encapsulation failed")
34 
35 typedef enum
36 {
37 #define _(sym,str) IPSEC_OUTPUT_ERROR_##sym,
38  foreach_ipsec_output_error
39 #undef _
40  IPSEC_DECAP_N_ERROR,
41 } ipsec_output_error_t;
42 
43 static char *ipsec_output_error_strings[] = {
44 #define _(sym,string) string,
45  foreach_ipsec_output_error
46 #undef _
47 };
48 
49 typedef struct
50 {
51  u32 spd_id;
52  u32 policy_id;
53 } ipsec_output_trace_t;
54 
55 /* packet trace format function */
56 static u8 *
57 format_ipsec_output_trace (u8 * s, va_list * args)
58 {
59  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
60  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
61  ipsec_output_trace_t *t = va_arg (*args, ipsec_output_trace_t *);
62 
63  s = format (s, "spd %u policy %d", t->spd_id, t->policy_id);
64 
65  return s;
66 }
67 
69 ipsec_output_policy_match (ipsec_spd_t * spd, u8 pr, u32 la, u32 ra, u16 lp,
70  u16 rp)
71 {
72  ipsec_main_t *im = &ipsec_main;
73  ipsec_policy_t *p;
74  u32 *i;
75 
76  if (!spd)
77  return 0;
78 
79  vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP4_OUTBOUND])
80  {
81  p = pool_elt_at_index (im->policies, *i);
82  if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
83  continue;
84 
85  if (ra < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
86  continue;
87 
88  if (ra > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
89  continue;
90 
91  if (la < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
92  continue;
93 
94  if (la > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
95  continue;
96 
97  if (PREDICT_FALSE
98  ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
99  && (pr != IP_PROTOCOL_SCTP)))
100  return p;
101 
102  if (lp < p->lport.start)
103  continue;
104 
105  if (lp > p->lport.stop)
106  continue;
107 
108  if (rp < p->rport.start)
109  continue;
110 
111  if (rp > p->rport.stop)
112  continue;
113 
114  return p;
115  }
116  return 0;
117 }
118 
121  ip6_address_t * ua)
122 {
123  if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
124  (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
125  return 1;
126  return 0;
127 }
128 
130 ipsec6_output_policy_match (ipsec_spd_t * spd,
131  ip6_address_t * la,
132  ip6_address_t * ra, u16 lp, u16 rp, u8 pr)
133 {
134  ipsec_main_t *im = &ipsec_main;
135  ipsec_policy_t *p;
136  u32 *i;
137 
138  if (!spd)
139  return 0;
140 
141  vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP6_OUTBOUND])
142  {
143  p = pool_elt_at_index (im->policies, *i);
144  if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
145  continue;
146 
147  if (!ip6_addr_match_range (ra, &p->raddr.start.ip6, &p->raddr.stop.ip6))
148  continue;
149 
150  if (!ip6_addr_match_range (la, &p->laddr.start.ip6, &p->laddr.stop.ip6))
151  continue;
152 
153  if (PREDICT_FALSE
154  ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
155  && (pr != IP_PROTOCOL_SCTP)))
156  return p;
157 
158  if (lp < p->lport.start)
159  continue;
160 
161  if (lp > p->lport.stop)
162  continue;
163 
164  if (rp < p->rport.start)
165  continue;
166 
167  if (rp > p->rport.stop)
168  continue;
169 
170  return p;
171  }
172 
173  return 0;
174 }
175 
176 static inline uword
177 ipsec_output_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
178  vlib_frame_t * from_frame, int is_ipv6)
179 {
180  ipsec_main_t *im = &ipsec_main;
181 
182  u32 *from, *to_next = 0, thread_index;
183  u32 n_left_from, sw_if_index0, last_sw_if_index = (u32) ~ 0;
184  u32 next_node_index = (u32) ~ 0, last_next_node_index = (u32) ~ 0;
185  vlib_frame_t *f = 0;
186  u32 spd_index0 = ~0;
187  ipsec_spd_t *spd0 = 0;
188  int bogus;
189  u64 nc_protect = 0, nc_bypass = 0, nc_discard = 0, nc_nomatch = 0;
190 
191  from = vlib_frame_vector_args (from_frame);
192  n_left_from = from_frame->n_vectors;
193  thread_index = vm->thread_index;
194 
195  while (n_left_from > 0)
196  {
197  u32 bi0, pi0;
198  vlib_buffer_t *b0;
199  ipsec_policy_t *p0;
200  ip4_header_t *ip0;
201  ip6_header_t *ip6_0 = 0;
202  udp_header_t *udp0;
203  u32 iph_offset = 0;
204  tcp_header_t *tcp0;
205  u64 bytes0;
206 
207  bi0 = from[0];
208  b0 = vlib_get_buffer (vm, bi0);
209  sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
210  iph_offset = vnet_buffer (b0)->ip.save_rewrite_length;
211  ip0 = (ip4_header_t *) ((u8 *) vlib_buffer_get_current (b0)
212  + iph_offset);
213 
214  /* lookup for SPD only if sw_if_index is changed */
215  if (PREDICT_FALSE (last_sw_if_index != sw_if_index0))
216  {
217  uword *p = hash_get (im->spd_index_by_sw_if_index, sw_if_index0);
218  ASSERT (p);
219  spd_index0 = p[0];
220  spd0 = pool_elt_at_index (im->spds, spd_index0);
221  last_sw_if_index = sw_if_index0;
222  }
223 
224  if (is_ipv6)
225  {
226  ip6_0 = (ip6_header_t *) ((u8 *) vlib_buffer_get_current (b0)
227  + iph_offset);
228 
229  udp0 = ip6_next_header (ip6_0);
230 #if 0
232  ("packet received from %U port %u to %U port %u spd_id %u",
234  clib_net_to_host_u16 (udp0->src_port), format_ip6_address,
235  &ip6_0->dst_address, clib_net_to_host_u16 (udp0->dst_port),
236  spd0->id);
237 #endif
238 
239  p0 = ipsec6_output_policy_match (spd0,
240  &ip6_0->src_address,
241  &ip6_0->dst_address,
242  clib_net_to_host_u16
243  (udp0->src_port),
244  clib_net_to_host_u16
245  (udp0->dst_port), ip6_0->protocol);
246  }
247  else
248  {
249  udp0 = (udp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
250 
251 #if 0
252  clib_warning ("packet received from %U to %U port %u",
255  clib_net_to_host_u16 (udp0->dst_port));
256  clib_warning ("sw_if_index0 %u spd_index0 %u spd_id %u",
257  sw_if_index0, spd_index0, spd0->id);
258 #endif
259 
260  p0 = ipsec_output_policy_match (spd0, ip0->protocol,
261  clib_net_to_host_u32
262  (ip0->src_address.as_u32),
263  clib_net_to_host_u32
264  (ip0->dst_address.as_u32),
265  clib_net_to_host_u16
266  (udp0->src_port),
267  clib_net_to_host_u16
268  (udp0->dst_port));
269  }
270  tcp0 = (void *) udp0;
271 
272  if (PREDICT_TRUE (p0 != NULL))
273  {
274  pi0 = p0 - im->policies;
275 
277  thread_index, pi0);
278 
279  if (is_ipv6)
280  {
281  bytes0 = clib_net_to_host_u16 (ip6_0->payload_length);
282  bytes0 += sizeof (ip6_header_t);
283  }
284  else
285  {
286  bytes0 = clib_net_to_host_u16 (ip0->length);
287  }
288 
289  if (p0->policy == IPSEC_POLICY_ACTION_PROTECT)
290  {
291  ipsec_sa_t *sa = 0;
292  nc_protect++;
293  sa = pool_elt_at_index (im->sad, p0->sa_index);
294  if (sa->protocol == IPSEC_PROTOCOL_ESP)
295  if (is_ipv6)
296  next_node_index = im->esp6_encrypt_node_index;
297  else
298  next_node_index = im->esp4_encrypt_node_index;
299  else if (is_ipv6)
300  next_node_index = im->ah6_encrypt_node_index;
301  else
302  next_node_index = im->ah4_encrypt_node_index;
303  vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
304 
305  if (is_ipv6)
306  {
307  if (PREDICT_FALSE
308  (b0->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM))
309  {
310  tcp0->checksum =
311  ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6_0,
312  &bogus);
313  b0->flags &= ~VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
314  }
315  if (PREDICT_FALSE
316  (b0->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
317  {
318  udp0->checksum =
319  ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6_0,
320  &bogus);
321  b0->flags &= ~VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
322  }
323  }
324  else
325  {
326  if (b0->flags & VNET_BUFFER_F_OFFLOAD_IP_CKSUM)
327  {
328  ip0->checksum = ip4_header_checksum (ip0);
329  b0->flags &= ~VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
330  }
331  if (PREDICT_FALSE
332  (b0->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM))
333  {
334  tcp0->checksum =
335  ip4_tcp_udp_compute_checksum (vm, b0, ip0);
336  b0->flags &= ~VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
337  }
338  if (PREDICT_FALSE
339  (b0->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
340  {
341  udp0->checksum =
342  ip4_tcp_udp_compute_checksum (vm, b0, ip0);
343  b0->flags &= ~VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
344  }
345  }
346  vlib_buffer_advance (b0, iph_offset);
347  }
348  else if (p0->policy == IPSEC_POLICY_ACTION_BYPASS)
349  {
350  nc_bypass++;
351  next_node_index = get_next_output_feature_node_index (b0, node);
352  }
353  else
354  {
355  nc_discard++;
356  next_node_index = im->error_drop_node_index;
357  }
359  (&ipsec_spd_policy_counters, thread_index, pi0, 1, bytes0);
360  }
361  else
362  {
363  pi0 = ~0;
364  nc_nomatch++;
365  next_node_index = im->error_drop_node_index;
366  }
367 
368  from += 1;
369  n_left_from -= 1;
370 
371  if (PREDICT_FALSE ((last_next_node_index != next_node_index) || f == 0))
372  {
373  /* if this is not 1st frame */
374  if (f)
375  vlib_put_frame_to_node (vm, last_next_node_index, f);
376 
377  last_next_node_index = next_node_index;
378 
379  f = vlib_get_frame_to_node (vm, next_node_index);
380 
381  /* frame->frame_flags, copy it from node */
382  /* Copy trace flag from next_frame and from runtime. */
383  f->frame_flags |= node->flags & VLIB_NODE_FLAG_TRACE;
384 
385  to_next = vlib_frame_vector_args (f);
386  }
387 
388  to_next[0] = bi0;
389  to_next += 1;
390  f->n_vectors++;
391 
392  if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE) &&
393  PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
394  {
395  ipsec_output_trace_t *tr =
396  vlib_add_trace (vm, node, b0, sizeof (*tr));
397  if (spd0)
398  tr->spd_id = spd0->id;
399  tr->policy_id = pi0;
400  }
401  }
402 
403  vlib_put_frame_to_node (vm, next_node_index, f);
405  IPSEC_OUTPUT_ERROR_POLICY_PROTECT, nc_protect);
407  IPSEC_OUTPUT_ERROR_POLICY_BYPASS, nc_bypass);
409  IPSEC_OUTPUT_ERROR_POLICY_DISCARD, nc_discard);
411  IPSEC_OUTPUT_ERROR_POLICY_NO_MATCH,
412  nc_nomatch);
413  return from_frame->n_vectors;
414 }
415 
416 VLIB_NODE_FN (ipsec4_output_node) (vlib_main_t * vm,
417  vlib_node_runtime_t * node,
418  vlib_frame_t * frame)
419 {
420  return ipsec_output_inline (vm, node, frame, 0);
421 }
422 
423 /* *INDENT-OFF* */
424 VLIB_REGISTER_NODE (ipsec4_output_node) = {
425  .name = "ipsec4-output-feature",
426  .vector_size = sizeof (u32),
427  .format_trace = format_ipsec_output_trace,
428  .type = VLIB_NODE_TYPE_INTERNAL,
429 
430  .n_errors = ARRAY_LEN(ipsec_output_error_strings),
431  .error_strings = ipsec_output_error_strings,
432 
433  .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
434  .next_nodes = {
435 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
437 #undef _
438  },
439 };
440 /* *INDENT-ON* */
441 
442 VLIB_NODE_FN (ipsec6_output_node) (vlib_main_t * vm,
443  vlib_node_runtime_t * node,
444  vlib_frame_t * frame)
445 {
446  return ipsec_output_inline (vm, node, frame, 1);
447 }
448 
449 /* *INDENT-OFF* */
450 VLIB_REGISTER_NODE (ipsec6_output_node) = {
451  .name = "ipsec6-output-feature",
452  .vector_size = sizeof (u32),
453  .format_trace = format_ipsec_output_trace,
454  .type = VLIB_NODE_TYPE_INTERNAL,
455 
456  .n_errors = ARRAY_LEN(ipsec_output_error_strings),
457  .error_strings = ipsec_output_error_strings,
458 
459  .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
460  .next_nodes = {
461 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
463 #undef _
464  },
465 };
466 /* *INDENT-ON* */
467 
468 #else /* IPSEC > 1 */
469 
470 /* Dummy ipsec output node, in case when IPSec is disabled */
471 
472 static uword
474  vlib_node_runtime_t * node, vlib_frame_t * frame)
475 {
476  clib_warning ("IPSec disabled");
477  return 0;
478 }
479 
480 /* *INDENT-OFF* */
481 VLIB_REGISTER_NODE (ipsec4_output_node) = {
482  .vector_size = sizeof (u32),
483  .function = ipsec_output_node_fn,
484  .name = "ipsec4-output-feature",
485 };
486 
487 VLIB_REGISTER_NODE (ipsec6_output_node) = {
488  .vector_size = sizeof (u32),
489  .function = ipsec_output_node_fn,
490  .name = "ipsec6-output-feature",
491 };
492 /* *INDENT-ON* */
493 #endif
494 
495 /*
496  * fd.io coding-style-patch-verification: ON
497  *
498  * Local Variables:
499  * eval: (c-set-style "gnu")
500  * End:
501  */
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:124
ipsec_spd_t * spds
Definition: ipsec.h:93
#define CLIB_UNUSED(x)
Definition: clib.h:82
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:220
ip4_address_t src_address
Definition: ip4_packet.h:170
#define PREDICT_TRUE(x)
Definition: clib.h:112
u64 as_u64[2]
Definition: ip6_packet.h:51
unsigned long u64
Definition: types.h:89
ip46_address_range_t laddr
#define NULL
Definition: clib.h:58
u32 thread_index
Definition: main.h:197
int i
static uword ip6_addr_match_range(ip6_address_t *a, ip6_address_t *la, ip6_address_t *ua)
Definition: ipsec_input.c:116
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
A Secruity Policy Database.
Definition: ipsec_spd.h:44
#define VLIB_NODE_FN(node)
Definition: node.h:201
struct _tcp_header tcp_header_t
ip6_address_t src_address
Definition: ip6_packet.h:385
unsigned char u8
Definition: types.h:56
uword * spd_index_by_sw_if_index
Definition: ipsec.h:110
format_function_t format_ip4_address
Definition: format.h:75
ipsec_main_t ipsec_main
Definition: ipsec.c:28
#define always_inline
Definition: clib.h:98
ip4_address_t dst_address
Definition: ip4_packet.h:170
u32 esp6_encrypt_node_index
Definition: ipsec.h:123
vlib_frame_t * vlib_get_frame_to_node(vlib_main_t *vm, u32 to_node_index)
Definition: main.c:189
port_range_t rport
unsigned int u32
Definition: types.h:88
u32 error_drop_node_index
Definition: ipsec.h:118
#define hash_get(h, key)
Definition: hash.h:249
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
vlib_combined_counter_main_t ipsec_spd_policy_counters
Policy packet & bytes counters.
u16 frame_flags
Definition: node.h:383
u32 esp4_encrypt_node_index
Definition: ipsec.h:119
unsigned short u16
Definition: types.h:57
void vlib_put_frame_to_node(vlib_main_t *vm, u32 to_node_index, vlib_frame_t *f)
Definition: main.c:198
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
#define PREDICT_FALSE(x)
Definition: clib.h:111
static void vlib_prefetch_combined_counter(const vlib_combined_counter_main_t *cm, u32 thread_index, u32 index)
Pre-fetch a per-thread combined counter for the given object index.
Definition: counter.h:235
u32 node_index
Node index.
Definition: node.h:495
u8 name[64]
Definition: memclnt.api:152
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1180
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
u16 n_vectors
Definition: node.h:395
format_function_t format_ip6_address
Definition: format.h:93
vlib_main_t * vm
Definition: buffer.c:312
ipsec_policy_action_t policy
ip46_address_t start
#define IP_PROTOCOL_SCTP
Definition: sctp.h:343
#define clib_warning(format, args...)
Definition: error.h:59
#define ARRAY_LEN(x)
Definition: clib.h:62
A Secruity Policy.
static_always_inline u32 get_next_output_feature_node_index(vlib_buffer_t *b, vlib_node_runtime_t *nr)
Definition: ipsec.h:198
static void * ip6_next_header(ip6_header_t *i)
Definition: ip6_packet.h:412
u16 ip6_tcp_udp_icmp_compute_checksum(vlib_main_t *vm, vlib_buffer_t *p0, ip6_header_t *ip0, int *bogus_lengthp)
Definition: ip6_forward.c:947
#define ASSERT(truth)
u32 ah4_encrypt_node_index
Definition: ipsec.h:121
ipsec_policy_t * policies
Definition: ipsec.h:97
u16 ip4_tcp_udp_compute_checksum(vlib_main_t *vm, vlib_buffer_t *p0, ip4_header_t *ip0)
Definition: ip4_forward.c:1128
ipsec_sa_t * sad
Definition: ipsec.h:95
u32 * policies[IPSEC_SPD_POLICY_N_TYPES]
vectors for each of the policy types
Definition: ipsec_spd.h:49
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:248
ipsec_protocol_t protocol
Definition: ipsec_sa.h:148
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:57
u32 ah6_encrypt_node_index
Definition: ipsec.h:125
Definition: defs.h:47
u16 payload_length
Definition: ip6_packet.h:376
ip46_address_range_t raddr
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:274
static uword ipsec_output_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: ipsec_output.c:473
u32 id
the User&#39;s ID for this policy
Definition: ipsec_spd.h:47
#define vnet_buffer(b)
Definition: buffer.h:369
port_range_t lport
#define vec_foreach(var, vec)
Vector iterator.
u16 flags
Copy of main node flags.
Definition: node.h:508
static int ip4_header_bytes(const ip4_header_t *i)
Definition: ip4_packet.h:235
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:301
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
static u16 ip4_header_checksum(ip4_header_t *i)
Definition: ip4_packet.h:247
#define foreach_ipsec_output_next
Definition: ipsec_io.h:18
ip6_address_t dst_address
Definition: ip6_packet.h:385