IPSEC: no second lookup after tunnel encap
[vpp.git] / src / vnet / ipsec / ipsec_if.c
1 /*
2  * ipsec_if.c : IPSec interface support
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 #include <vnet/fib/fib.h>
22
23 #include <vnet/ipsec/ipsec.h>
24 #include <vnet/ipsec/esp.h>
25
26 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
27
28 static u8 *
29 format_ipsec_name (u8 * s, va_list * args)
30 {
31   u32 dev_instance = va_arg (*args, u32);
32   ipsec_main_t *im = &ipsec_main;
33   ipsec_tunnel_if_t *t = im->tunnel_interfaces + dev_instance;
34
35   return format (s, "ipsec%d", t->show_instance);
36 }
37
38 /* Statistics (not really errors) */
39 #define foreach_ipsec_if_tx_error    \
40 _(TX, "good packets transmitted")
41
42 static char *ipsec_if_tx_error_strings[] = {
43 #define _(sym,string) string,
44   foreach_ipsec_if_tx_error
45 #undef _
46 };
47
48 typedef enum
49 {
50 #define _(sym,str) IPSEC_IF_OUTPUT_ERROR_##sym,
51   foreach_ipsec_if_tx_error
52 #undef _
53     IPSEC_IF_TX_N_ERROR,
54 } ipsec_if_tx_error_t;
55
56 typedef struct
57 {
58   u32 spi;
59   u32 seq;
60 } ipsec_if_tx_trace_t;
61
62 u8 *
63 format_ipsec_if_tx_trace (u8 * s, va_list * args)
64 {
65   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
66   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
67   ipsec_if_tx_trace_t *t = va_arg (*args, ipsec_if_tx_trace_t *);
68
69   s = format (s, "IPSec: spi %u seq %u", t->spi, t->seq);
70   return s;
71 }
72
73 static uword
74 ipsec_if_tx_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
75                      vlib_frame_t * from_frame)
76 {
77   ipsec_main_t *im = &ipsec_main;
78   vnet_main_t *vnm = im->vnet_main;
79   vnet_interface_main_t *vim = &vnm->interface_main;
80   u32 *from, *to_next = 0, next_index;
81   u32 n_left_from, sw_if_index0, last_sw_if_index = ~0;
82   u32 thread_index = vm->thread_index;
83   u32 n_bytes = 0, n_packets = 0;
84
85   from = vlib_frame_vector_args (from_frame);
86   n_left_from = from_frame->n_vectors;
87   next_index = node->cached_next_index;
88
89   while (n_left_from > 0)
90     {
91       u32 n_left_to_next;
92
93       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
94
95       while (n_left_from > 0 && n_left_to_next > 0)
96         {
97           u32 bi0, next0, len0;
98           vlib_buffer_t *b0;
99           ipsec_tunnel_if_t *t0;
100           vnet_hw_interface_t *hi0;
101
102           bi0 = to_next[0] = from[0];
103           from += 1;
104           n_left_from -= 1;
105           to_next += 1;
106           n_left_to_next -= 1;
107           b0 = vlib_get_buffer (vm, bi0);
108           sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
109           hi0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
110           t0 = pool_elt_at_index (im->tunnel_interfaces, hi0->dev_instance);
111           vnet_buffer (b0)->ipsec.sad_index = t0->output_sa_index;
112           next0 = IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT;
113
114           len0 = vlib_buffer_length_in_chain (vm, b0);
115
116           if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
117             {
118               n_packets++;
119               n_bytes += len0;
120             }
121           else
122             {
123               vlib_increment_combined_counter (vim->combined_sw_if_counters +
124                                                VNET_INTERFACE_COUNTER_TX,
125                                                thread_index, sw_if_index0,
126                                                n_packets, n_bytes);
127               last_sw_if_index = sw_if_index0;
128               n_packets = 1;
129               n_bytes = len0;
130             }
131
132           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
133             {
134               ipsec_if_tx_trace_t *tr =
135                 vlib_add_trace (vm, node, b0, sizeof (*tr));
136               ipsec_sa_t *sa0 =
137                 pool_elt_at_index (im->sad, t0->output_sa_index);
138               tr->spi = sa0->spi;
139               tr->seq = sa0->seq;
140             }
141
142           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
143                                            n_left_to_next, bi0, next0);
144         }
145       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
146     }
147
148   if (last_sw_if_index != ~0)
149     {
150       vlib_increment_combined_counter (vim->combined_sw_if_counters +
151                                        VNET_INTERFACE_COUNTER_TX,
152                                        thread_index,
153                                        last_sw_if_index, n_packets, n_bytes);
154     }
155
156   return from_frame->n_vectors;
157 }
158
159
160 static clib_error_t *
161 ipsec_admin_up_down_function (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
162 {
163   ipsec_main_t *im = &ipsec_main;
164   clib_error_t *err = 0;
165   ipsec_tunnel_if_t *t;
166   vnet_hw_interface_t *hi;
167   ipsec_sa_t *sa;
168
169   hi = vnet_get_hw_interface (vnm, hw_if_index);
170   t = pool_elt_at_index (im->tunnel_interfaces, hi->hw_instance);
171
172   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
173     {
174       sa = pool_elt_at_index (im->sad, t->input_sa_index);
175
176       err = ipsec_check_support_cb (im, sa);
177       if (err)
178         return err;
179
180       err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 1);
181       if (err)
182         return err;
183
184       sa = pool_elt_at_index (im->sad, t->output_sa_index);
185
186       err = ipsec_check_support_cb (im, sa);
187       if (err)
188         return err;
189
190       err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 1);
191       if (err)
192         return err;
193
194       vnet_hw_interface_set_flags (vnm, hw_if_index,
195                                    VNET_HW_INTERFACE_FLAG_LINK_UP);
196     }
197   else
198     {
199       vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
200       sa = pool_elt_at_index (im->sad, t->input_sa_index);
201       err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 0);
202       if (err)
203         return err;
204       sa = pool_elt_at_index (im->sad, t->output_sa_index);
205       err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 0);
206       if (err)
207         return err;
208     }
209
210   return /* no error */ 0;
211 }
212
213
214 /* *INDENT-OFF* */
215 VNET_DEVICE_CLASS (ipsec_device_class, static) =
216 {
217   .name = "IPSec",
218   .format_device_name = format_ipsec_name,
219   .format_tx_trace = format_ipsec_if_tx_trace,
220   .tx_function = ipsec_if_tx_node_fn,
221   .tx_function_n_errors = IPSEC_IF_TX_N_ERROR,
222   .tx_function_error_strings = ipsec_if_tx_error_strings,
223   .admin_up_down_function = ipsec_admin_up_down_function,
224 };
225 /* *INDENT-ON* */
226
227 /* *INDENT-OFF* */
228 VNET_HW_INTERFACE_CLASS (ipsec_hw_class) =
229 {
230   .name = "IPSec",
231   .build_rewrite = default_build_rewrite,
232   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
233 };
234 /* *INDENT-ON* */
235
236 static int
237 ipsec_add_del_tunnel_if_rpc_callback (ipsec_add_del_tunnel_args_t * a)
238 {
239   vnet_main_t *vnm = vnet_get_main ();
240   ASSERT (vlib_get_thread_index () == 0);
241
242   return ipsec_add_del_tunnel_if_internal (vnm, a, NULL);
243 }
244
245 int
246 ipsec_add_del_tunnel_if (ipsec_add_del_tunnel_args_t * args)
247 {
248   vl_api_rpc_call_main_thread (ipsec_add_del_tunnel_if_rpc_callback,
249                                (u8 *) args, sizeof (*args));
250   return 0;
251 }
252
253 static u32
254 ipsec_tun_mk_input_sa_id (u32 ti)
255 {
256   return (0x80000000 | ti);
257 }
258
259 static u32
260 ipsec_tun_mk_output_sa_id (u32 ti)
261 {
262   return (0xc0000000 | ti);
263 }
264
265 int
266 ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
267                                   ipsec_add_del_tunnel_args_t * args,
268                                   u32 * sw_if_index)
269 {
270   ipsec_tunnel_if_t *t;
271   ipsec_main_t *im = &ipsec_main;
272   vnet_hw_interface_t *hi = NULL;
273   u32 hw_if_index = ~0;
274   uword *p;
275   u32 dev_instance;
276   u32 slot;
277   ipsec_key_t crypto_key, integ_key;
278   ipsec_sa_flags_t flags;
279   int rv;
280
281   u64 key = (u64) args->remote_ip.ip4.as_u32 << 32 | (u64) args->remote_spi;
282   p = hash_get (im->ipsec_if_pool_index_by_key, key);
283
284   if (args->is_add)
285     {
286       /* check if same src/dst pair exists */
287       if (p)
288         return VNET_API_ERROR_INVALID_VALUE;
289
290       pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
291       clib_memset (t, 0, sizeof (*t));
292
293       dev_instance = t - im->tunnel_interfaces;
294       if (args->renumber)
295         t->show_instance = args->show_instance;
296       else
297         t->show_instance = dev_instance;
298
299       if (hash_get (im->ipsec_if_real_dev_by_show_dev, t->show_instance))
300         {
301           pool_put (im->tunnel_interfaces, t);
302           return VNET_API_ERROR_INSTANCE_IN_USE;
303         }
304
305       hash_set (im->ipsec_if_real_dev_by_show_dev, t->show_instance,
306                 dev_instance);
307
308       flags = IPSEC_SA_FLAG_IS_TUNNEL;
309       if (args->udp_encap)
310         flags |= IPSEC_SA_FLAG_UDP_ENCAP;
311       if (args->esn)
312         flags |= IPSEC_SA_FLAG_USE_EXTENDED_SEQ_NUM;
313       if (args->anti_replay)
314         flags |= IPSEC_SA_FLAG_USE_ANTI_REPLAY;
315
316       ipsec_mk_key (&crypto_key,
317                     args->remote_crypto_key, args->remote_crypto_key_len);
318       ipsec_mk_key (&integ_key,
319                     args->remote_integ_key, args->remote_integ_key_len);
320
321       rv = ipsec_sa_add (ipsec_tun_mk_input_sa_id (dev_instance),
322                          args->remote_spi,
323                          IPSEC_PROTOCOL_ESP,
324                          args->crypto_alg,
325                          &crypto_key,
326                          args->integ_alg,
327                          &integ_key,
328                          flags,
329                          args->tx_table_id,
330                          &args->remote_ip,
331                          &args->local_ip, &t->input_sa_index);
332
333       if (rv)
334         return VNET_API_ERROR_UNIMPLEMENTED;
335
336       ipsec_mk_key (&crypto_key,
337                     args->local_crypto_key, args->local_crypto_key_len);
338       ipsec_mk_key (&integ_key,
339                     args->local_integ_key, args->local_integ_key_len);
340
341       rv = ipsec_sa_add (ipsec_tun_mk_output_sa_id (dev_instance),
342                          args->local_spi,
343                          IPSEC_PROTOCOL_ESP,
344                          args->crypto_alg,
345                          &crypto_key,
346                          args->integ_alg,
347                          &integ_key,
348                          flags,
349                          args->tx_table_id,
350                          &args->local_ip,
351                          &args->remote_ip, &t->output_sa_index);
352
353       if (rv)
354         return VNET_API_ERROR_UNIMPLEMENTED;
355
356       hash_set (im->ipsec_if_pool_index_by_key, key,
357                 t - im->tunnel_interfaces);
358
359       hw_if_index = vnet_register_interface (vnm, ipsec_device_class.index,
360                                              t - im->tunnel_interfaces,
361                                              ipsec_hw_class.index,
362                                              t - im->tunnel_interfaces);
363
364       hi = vnet_get_hw_interface (vnm, hw_if_index);
365
366       slot = vlib_node_add_next_with_slot
367         (vnm->vlib_main, hi->tx_node_index, im->esp4_encrypt_node_index,
368          IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT);
369
370       ASSERT (slot == IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT);
371
372       t->hw_if_index = hw_if_index;
373
374       vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
375                                    hi->sw_if_index, 1, 0, 0);
376
377       /*1st interface, register protocol */
378       if (pool_elts (im->tunnel_interfaces) == 1)
379         ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
380                                ipsec_if_input_node.index);
381
382     }
383   else
384     {
385       /* check if exists */
386       if (!p)
387         return VNET_API_ERROR_INVALID_VALUE;
388
389       t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
390       hi = vnet_get_hw_interface (vnm, t->hw_if_index);
391       vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0);    /* admin down */
392
393       vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
394                                    hi->sw_if_index, 0, 0, 0);
395
396       vnet_delete_hw_interface (vnm, t->hw_if_index);
397
398       hash_unset (im->ipsec_if_pool_index_by_key, key);
399       hash_unset (im->ipsec_if_real_dev_by_show_dev, t->show_instance);
400
401       pool_put (im->tunnel_interfaces, t);
402
403       /* delete input and output SA */
404       ipsec_sa_del (ipsec_tun_mk_input_sa_id (p[0]));
405       ipsec_sa_del (ipsec_tun_mk_output_sa_id (p[0]));
406     }
407
408   if (sw_if_index)
409     *sw_if_index = hi->sw_if_index;
410
411   return 0;
412 }
413
414 int
415 ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
416                                 ipsec_add_del_ipsec_gre_tunnel_args_t * args)
417 {
418   ipsec_tunnel_if_t *t = 0;
419   ipsec_main_t *im = &ipsec_main;
420   uword *p;
421   ipsec_sa_t *sa;
422   u64 key;
423   u32 isa, osa;
424
425   p = hash_get (im->sa_index_by_sa_id, args->local_sa_id);
426   if (!p)
427     return VNET_API_ERROR_INVALID_VALUE;
428   isa = p[0];
429
430   p = hash_get (im->sa_index_by_sa_id, args->remote_sa_id);
431   if (!p)
432     return VNET_API_ERROR_INVALID_VALUE;
433   osa = p[0];
434   sa = pool_elt_at_index (im->sad, p[0]);
435
436   if (sa->is_tunnel)
437     key = (u64) sa->tunnel_dst_addr.ip4.as_u32 << 32 | (u64) sa->spi;
438   else
439     key = (u64) args->remote_ip.as_u32 << 32 | (u64) sa->spi;
440
441   p = hash_get (im->ipsec_if_pool_index_by_key, key);
442
443   if (args->is_add)
444     {
445       /* check if same src/dst pair exists */
446       if (p)
447         return VNET_API_ERROR_INVALID_VALUE;
448
449       pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
450       clib_memset (t, 0, sizeof (*t));
451
452       t->input_sa_index = isa;
453       t->output_sa_index = osa;
454       t->hw_if_index = ~0;
455       hash_set (im->ipsec_if_pool_index_by_key, key,
456                 t - im->tunnel_interfaces);
457
458       /*1st interface, register protocol */
459       if (pool_elts (im->tunnel_interfaces) == 1)
460         ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
461                                ipsec_if_input_node.index);
462     }
463   else
464     {
465       /* check if exists */
466       if (!p)
467         return VNET_API_ERROR_INVALID_VALUE;
468
469       t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
470       hash_unset (im->ipsec_if_pool_index_by_key, key);
471       pool_put (im->tunnel_interfaces, t);
472     }
473   return 0;
474 }
475
476 int
477 ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
478                          ipsec_if_set_key_type_t type, u8 alg, u8 * key)
479 {
480   ipsec_main_t *im = &ipsec_main;
481   vnet_hw_interface_t *hi;
482   ipsec_tunnel_if_t *t;
483   ipsec_sa_t *sa;
484
485   hi = vnet_get_hw_interface (vnm, hw_if_index);
486   t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
487
488   if (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
489     return VNET_API_ERROR_SYSCALL_ERROR_1;
490
491   if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO)
492     {
493       sa = pool_elt_at_index (im->sad, t->output_sa_index);
494       sa->crypto_alg = alg;
495       ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
496     }
497   else if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG)
498     {
499       sa = pool_elt_at_index (im->sad, t->output_sa_index);
500       sa->integ_alg = alg;
501       ipsec_mk_key (&sa->integ_key, key, vec_len (key));
502     }
503   else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO)
504     {
505       sa = pool_elt_at_index (im->sad, t->input_sa_index);
506       sa->crypto_alg = alg;
507       ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
508     }
509   else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG)
510     {
511       sa = pool_elt_at_index (im->sad, t->input_sa_index);
512       sa->integ_alg = alg;
513       ipsec_mk_key (&sa->integ_key, key, vec_len (key));
514     }
515   else
516     return VNET_API_ERROR_INVALID_VALUE;
517
518   return 0;
519 }
520
521
522 int
523 ipsec_set_interface_sa (vnet_main_t * vnm, u32 hw_if_index, u32 sa_id,
524                         u8 is_outbound)
525 {
526   ipsec_main_t *im = &ipsec_main;
527   vnet_hw_interface_t *hi;
528   ipsec_tunnel_if_t *t;
529   ipsec_sa_t *sa, *old_sa;
530   u32 sa_index, old_sa_index;
531   uword *p;
532
533   hi = vnet_get_hw_interface (vnm, hw_if_index);
534   t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
535
536   sa_index = ipsec_get_sa_index_by_sa_id (sa_id);
537   if (sa_index == ~0)
538     {
539       clib_warning ("SA with ID %u not found", sa_id);
540       return VNET_API_ERROR_INVALID_VALUE;
541     }
542
543   if (ipsec_is_sa_used (sa_index))
544     {
545       clib_warning ("SA with ID %u is already in use", sa_id);
546       return VNET_API_ERROR_INVALID_VALUE;
547     }
548
549   sa = pool_elt_at_index (im->sad, sa_index);
550   if (sa->is_tunnel_ip6)
551     {
552       clib_warning ("IPsec interface not supported with IPv6 endpoints");
553       return VNET_API_ERROR_UNIMPLEMENTED;
554     }
555
556   if (!is_outbound)
557     {
558       u64 key;
559
560       old_sa_index = t->input_sa_index;
561       old_sa = pool_elt_at_index (im->sad, old_sa_index);
562
563       /* unset old inbound hash entry. packets should stop arriving */
564       key =
565         (u64) old_sa->tunnel_src_addr.ip4.as_u32 << 32 | (u64) old_sa->spi;
566       p = hash_get (im->ipsec_if_pool_index_by_key, key);
567       if (p)
568         hash_unset (im->ipsec_if_pool_index_by_key, key);
569
570       /* set new inbound SA, then set new hash entry */
571       t->input_sa_index = sa_index;
572       key = (u64) sa->tunnel_src_addr.ip4.as_u32 << 32 | (u64) sa->spi;
573       hash_set (im->ipsec_if_pool_index_by_key, key, hi->dev_instance);
574     }
575   else
576     {
577       old_sa_index = t->output_sa_index;
578       old_sa = pool_elt_at_index (im->sad, old_sa_index);
579       t->output_sa_index = sa_index;
580     }
581
582   /* remove sa_id to sa_index mapping on old SA */
583   if (ipsec_get_sa_index_by_sa_id (old_sa->id) == old_sa_index)
584     hash_unset (im->sa_index_by_sa_id, old_sa->id);
585
586   if (ipsec_add_del_sa_sess_cb (im, old_sa_index, 0))
587     {
588       clib_warning ("IPsec backend add/del callback returned error");
589       return VNET_API_ERROR_SYSCALL_ERROR_1;
590     }
591   pool_put (im->sad, old_sa);
592
593   return 0;
594 }
595
596
597 clib_error_t *
598 ipsec_tunnel_if_init (vlib_main_t * vm)
599 {
600   ipsec_main_t *im = &ipsec_main;
601
602   im->ipsec_if_pool_index_by_key = hash_create (0, sizeof (uword));
603   im->ipsec_if_real_dev_by_show_dev = hash_create (0, sizeof (uword));
604
605   return 0;
606 }
607
608 VLIB_INIT_FUNCTION (ipsec_tunnel_if_init);
609
610
611 /*
612  * fd.io coding-style-patch-verification: ON
613  *
614  * Local Variables:
615  * eval: (c-set-style "gnu")
616  * End:
617  */