2 * ipsec.c : IPSEC module functions
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <vnet/vnet.h>
19 #include <vnet/api_errno.h>
20 #include <vnet/ip/ip.h>
21 #include <vnet/interface.h>
22 #include <vnet/udp/udp_local.h>
24 #include <vnet/ipsec/ipsec.h>
25 #include <vnet/ipsec/esp.h>
26 #include <vnet/ipsec/ah.h>
28 ipsec_main_t ipsec_main;
29 esp_async_post_next_t esp_encrypt_async_next;
30 esp_async_post_next_t esp_decrypt_async_next;
33 ipsec_check_ah_support (ipsec_sa_t * sa)
35 ipsec_main_t *im = &ipsec_main;
37 if (sa->integ_alg == IPSEC_INTEG_ALG_NONE)
38 return clib_error_return (0, "unsupported none integ-alg");
40 if (!vnet_crypto_is_set_handler (im->integ_algs[sa->integ_alg].alg))
41 return clib_error_return (0, "No crypto engine support for %U",
42 format_ipsec_integ_alg, sa->integ_alg);
48 ipsec_check_esp_support (ipsec_sa_t * sa)
50 ipsec_main_t *im = &ipsec_main;
52 if (IPSEC_INTEG_ALG_NONE != sa->integ_alg)
54 if (!vnet_crypto_is_set_handler (im->integ_algs[sa->integ_alg].alg))
55 return clib_error_return (0, "No crypto engine support for %U",
56 format_ipsec_integ_alg, sa->integ_alg);
58 if (IPSEC_CRYPTO_ALG_NONE != sa->crypto_alg)
60 if (!vnet_crypto_is_set_handler (im->crypto_algs[sa->crypto_alg].alg))
61 return clib_error_return (0, "No crypto engine support for %U",
62 format_ipsec_crypto_alg, sa->crypto_alg);
69 ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index, u8 is_add)
71 ipsec_ah_backend_t *ah =
72 pool_elt_at_index (im->ah_backends, im->ah_current_backend);
73 if (ah->add_del_sa_sess_cb)
75 clib_error_t *err = ah->add_del_sa_sess_cb (sa_index, is_add);
79 ipsec_esp_backend_t *esp =
80 pool_elt_at_index (im->esp_backends, im->esp_current_backend);
81 if (esp->add_del_sa_sess_cb)
83 clib_error_t *err = esp->add_del_sa_sess_cb (sa_index, is_add);
91 ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa)
93 clib_error_t *error = 0;
95 if (PREDICT_FALSE (sa->protocol == IPSEC_PROTOCOL_AH))
97 ipsec_ah_backend_t *ah =
98 pool_elt_at_index (im->ah_backends, im->ah_current_backend);
99 ASSERT (ah->check_support_cb);
100 error = ah->check_support_cb (sa);
104 ipsec_esp_backend_t *esp =
105 pool_elt_at_index (im->esp_backends, im->esp_current_backend);
106 ASSERT (esp->check_support_cb);
107 error = esp->check_support_cb (sa);
114 ipsec_add_node (vlib_main_t * vm, const char *node_name,
115 const char *prev_node_name, u32 * out_node_index,
116 u32 * out_next_index)
118 vlib_node_t *prev_node, *node;
119 prev_node = vlib_get_node_by_name (vm, (u8 *) prev_node_name);
121 node = vlib_get_node_by_name (vm, (u8 *) node_name);
123 *out_node_index = node->index;
124 *out_next_index = vlib_node_add_next (vm, prev_node->index, node->index);
128 ipsec_add_feature (const char *arc_name,
129 const char *node_name, u32 * out_feature_index)
133 arc = vnet_get_feature_arc_index (arc_name);
134 ASSERT (arc != (u8) ~ 0);
135 *out_feature_index = vnet_get_feature_index (arc, node_name);
139 ipsec_unregister_udp_port (u16 port)
141 ipsec_main_t *im = &ipsec_main;
145 p = hash_get (im->udp_port_registrations, port);
153 udp_unregister_dst_port (vlib_get_main (), port, 1);
154 hash_unset (im->udp_port_registrations, port);
158 hash_unset (im->udp_port_registrations, port);
159 hash_set (im->udp_port_registrations, port, n_regs);
164 ipsec_register_udp_port (u16 port)
166 ipsec_main_t *im = &ipsec_main;
170 p = hash_get (im->udp_port_registrations, port);
172 n_regs = (p ? p[0] : 0);
175 udp_register_dst_port (vlib_get_main (), port,
176 ipsec4_tun_input_node.index, 1);
178 hash_unset (im->udp_port_registrations, port);
179 hash_set (im->udp_port_registrations, port, n_regs);
183 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
185 const char *ah4_encrypt_node_name,
186 const char *ah4_decrypt_node_name,
187 const char *ah6_encrypt_node_name,
188 const char *ah6_decrypt_node_name,
189 check_support_cb_t ah_check_support_cb,
190 add_del_sa_sess_cb_t ah_add_del_sa_sess_cb)
192 ipsec_ah_backend_t *b;
193 pool_get (im->ah_backends, b);
194 b->name = format (0, "%s%c", name, 0);
196 ipsec_add_node (vm, ah4_encrypt_node_name, "ipsec4-output-feature",
197 &b->ah4_encrypt_node_index, &b->ah4_encrypt_next_index);
198 ipsec_add_node (vm, ah4_decrypt_node_name, "ipsec4-input-feature",
199 &b->ah4_decrypt_node_index, &b->ah4_decrypt_next_index);
200 ipsec_add_node (vm, ah6_encrypt_node_name, "ipsec6-output-feature",
201 &b->ah6_encrypt_node_index, &b->ah6_encrypt_next_index);
202 ipsec_add_node (vm, ah6_decrypt_node_name, "ipsec6-input-feature",
203 &b->ah6_decrypt_node_index, &b->ah6_decrypt_next_index);
205 b->check_support_cb = ah_check_support_cb;
206 b->add_del_sa_sess_cb = ah_add_del_sa_sess_cb;
207 return b - im->ah_backends;
211 ipsec_register_esp_backend (
212 vlib_main_t *vm, ipsec_main_t *im, const char *name,
213 const char *esp4_encrypt_node_name, const char *esp4_encrypt_node_tun_name,
214 const char *esp4_decrypt_node_name, const char *esp4_decrypt_tun_node_name,
215 const char *esp6_encrypt_node_name, const char *esp6_encrypt_node_tun_name,
216 const char *esp6_decrypt_node_name, const char *esp6_decrypt_tun_node_name,
217 const char *esp_mpls_encrypt_node_tun_name,
218 check_support_cb_t esp_check_support_cb,
219 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb,
220 enable_disable_cb_t enable_disable_cb)
222 ipsec_esp_backend_t *b;
224 pool_get (im->esp_backends, b);
225 b->name = format (0, "%s%c", name, 0);
227 ipsec_add_node (vm, esp4_encrypt_node_name, "ipsec4-output-feature",
228 &b->esp4_encrypt_node_index, &b->esp4_encrypt_next_index);
229 ipsec_add_node (vm, esp4_decrypt_node_name, "ipsec4-input-feature",
230 &b->esp4_decrypt_node_index, &b->esp4_decrypt_next_index);
231 ipsec_add_node (vm, esp6_encrypt_node_name, "ipsec6-output-feature",
232 &b->esp6_encrypt_node_index, &b->esp6_encrypt_next_index);
233 ipsec_add_node (vm, esp6_decrypt_node_name, "ipsec6-input-feature",
234 &b->esp6_decrypt_node_index, &b->esp6_decrypt_next_index);
235 ipsec_add_node (vm, esp4_decrypt_tun_node_name, "ipsec4-tun-input",
236 &b->esp4_decrypt_tun_node_index,
237 &b->esp4_decrypt_tun_next_index);
238 ipsec_add_node (vm, esp6_decrypt_tun_node_name, "ipsec6-tun-input",
239 &b->esp6_decrypt_tun_node_index,
240 &b->esp6_decrypt_tun_next_index);
242 b->esp6_encrypt_tun_node_index =
243 vlib_get_node_by_name (vm, (u8 *) esp6_encrypt_node_tun_name)->index;
244 b->esp_mpls_encrypt_tun_node_index =
245 vlib_get_node_by_name (vm, (u8 *) esp_mpls_encrypt_node_tun_name)->index;
246 b->esp4_encrypt_tun_node_index =
247 vlib_get_node_by_name (vm, (u8 *) esp4_encrypt_node_tun_name)->index;
249 b->check_support_cb = esp_check_support_cb;
250 b->add_del_sa_sess_cb = esp_add_del_sa_sess_cb;
251 b->enable_disable_cb = enable_disable_cb;
253 return b - im->esp_backends;
257 ipsec_rsc_in_use (ipsec_main_t * im)
259 /* return an error is crypto resource are in use */
260 if (pool_elts (im->sad) > 0)
261 return clib_error_return (0,
262 "%d SA entries configured",
263 pool_elts (im->sad));
269 ipsec_select_ah_backend (ipsec_main_t * im, u32 backend_idx)
271 if (ipsec_rsc_in_use (im))
272 return VNET_API_ERROR_RSRC_IN_USE;
274 if (pool_is_free_index (im->ah_backends, backend_idx))
275 return VNET_API_ERROR_INVALID_VALUE;
277 ipsec_ah_backend_t *b = pool_elt_at_index (im->ah_backends, backend_idx);
278 im->ah_current_backend = backend_idx;
279 im->ah4_encrypt_node_index = b->ah4_encrypt_node_index;
280 im->ah4_decrypt_node_index = b->ah4_decrypt_node_index;
281 im->ah4_encrypt_next_index = b->ah4_encrypt_next_index;
282 im->ah4_decrypt_next_index = b->ah4_decrypt_next_index;
283 im->ah6_encrypt_node_index = b->ah6_encrypt_node_index;
284 im->ah6_decrypt_node_index = b->ah6_decrypt_node_index;
285 im->ah6_encrypt_next_index = b->ah6_encrypt_next_index;
286 im->ah6_decrypt_next_index = b->ah6_decrypt_next_index;
292 ipsec_select_esp_backend (ipsec_main_t * im, u32 backend_idx)
294 if (ipsec_rsc_in_use (im))
295 return VNET_API_ERROR_RSRC_IN_USE;
297 if (pool_is_free_index (im->esp_backends, backend_idx))
298 return VNET_API_ERROR_INVALID_VALUE;
300 /* disable current backend */
301 if (im->esp_current_backend != ~0)
303 ipsec_esp_backend_t *cb = pool_elt_at_index (im->esp_backends,
304 im->esp_current_backend);
305 if (cb->enable_disable_cb)
307 if ((cb->enable_disable_cb) (0) != 0)
312 ipsec_esp_backend_t *b = pool_elt_at_index (im->esp_backends, backend_idx);
313 im->esp_current_backend = backend_idx;
314 im->esp4_encrypt_node_index = b->esp4_encrypt_node_index;
315 im->esp4_decrypt_node_index = b->esp4_decrypt_node_index;
316 im->esp4_encrypt_next_index = b->esp4_encrypt_next_index;
317 im->esp4_decrypt_next_index = b->esp4_decrypt_next_index;
318 im->esp6_encrypt_node_index = b->esp6_encrypt_node_index;
319 im->esp6_decrypt_node_index = b->esp6_decrypt_node_index;
320 im->esp6_encrypt_next_index = b->esp6_encrypt_next_index;
321 im->esp6_decrypt_next_index = b->esp6_decrypt_next_index;
322 im->esp4_decrypt_tun_node_index = b->esp4_decrypt_tun_node_index;
323 im->esp4_decrypt_tun_next_index = b->esp4_decrypt_tun_next_index;
324 im->esp6_decrypt_tun_node_index = b->esp6_decrypt_tun_node_index;
325 im->esp6_decrypt_tun_next_index = b->esp6_decrypt_tun_next_index;
326 im->esp4_encrypt_tun_node_index = b->esp4_encrypt_tun_node_index;
327 im->esp6_encrypt_tun_node_index = b->esp6_encrypt_tun_node_index;
328 im->esp_mpls_encrypt_tun_node_index = b->esp_mpls_encrypt_tun_node_index;
330 if (b->enable_disable_cb)
332 if ((b->enable_disable_cb) (1) != 0)
339 ipsec_set_async_mode (u32 is_enabled)
341 ipsec_main_t *im = &ipsec_main;
344 /* lock all SAs before change im->async_mode */
345 pool_foreach (sa, im->sad)
347 fib_node_lock (&sa->node);
350 im->async_mode = is_enabled;
352 /* change SA crypto op data before unlock them */
353 pool_foreach (sa, im->sad)
355 sa->crypto_op_data = is_enabled ?
356 sa->async_op_data.data : sa->sync_op_data.data;
357 fib_node_unlock (&sa->node);
362 crypto_engine_backend_register_post_node (vlib_main_t * vm)
364 esp_async_post_next_t *eit;
365 esp_async_post_next_t *dit;
367 eit = &esp_encrypt_async_next;
368 eit->esp4_post_next =
369 vnet_crypto_register_post_node (vm, "esp4-encrypt-post");
370 eit->esp6_post_next =
371 vnet_crypto_register_post_node (vm, "esp6-encrypt-post");
372 eit->esp4_tun_post_next =
373 vnet_crypto_register_post_node (vm, "esp4-encrypt-tun-post");
374 eit->esp6_tun_post_next =
375 vnet_crypto_register_post_node (vm, "esp6-encrypt-tun-post");
376 eit->esp_mpls_tun_post_next =
377 vnet_crypto_register_post_node (vm, "esp-mpls-encrypt-tun-post");
379 dit = &esp_decrypt_async_next;
380 dit->esp4_post_next =
381 vnet_crypto_register_post_node (vm, "esp4-decrypt-post");
382 dit->esp6_post_next =
383 vnet_crypto_register_post_node (vm, "esp6-decrypt-post");
384 dit->esp4_tun_post_next =
385 vnet_crypto_register_post_node (vm, "esp4-decrypt-tun-post");
386 dit->esp6_tun_post_next =
387 vnet_crypto_register_post_node (vm, "esp6-decrypt-tun-post");
390 static clib_error_t *
391 ipsec_init (vlib_main_t * vm)
394 ipsec_main_t *im = &ipsec_main;
395 ipsec_main_crypto_alg_t *a;
397 /* Backend registration requires the feature arcs to be set up */
398 if ((error = vlib_call_init_function (vm, vnet_feature_init)))
401 im->vnet_main = vnet_get_main ();
404 im->spd_index_by_spd_id = hash_create (0, sizeof (uword));
405 im->sa_index_by_sa_id = hash_create (0, sizeof (uword));
406 im->spd_index_by_sw_if_index = hash_create (0, sizeof (uword));
408 vlib_node_t *node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
410 im->error_drop_node_index = node->index;
412 im->ah_current_backend = ~0;
413 im->esp_current_backend = ~0;
415 u32 idx = ipsec_register_ah_backend (vm, im, "crypto engine backend",
420 ipsec_check_ah_support,
423 im->ah_default_backend = idx;
424 int rv = ipsec_select_ah_backend (im, idx);
426 (void) (rv); // avoid warning
428 idx = ipsec_register_esp_backend (
429 vm, im, "crypto engine backend", "esp4-encrypt", "esp4-encrypt-tun",
430 "esp4-decrypt", "esp4-decrypt-tun", "esp6-encrypt", "esp6-encrypt-tun",
431 "esp6-decrypt", "esp6-decrypt-tun", "esp-mpls-encrypt-tun",
432 ipsec_check_esp_support, NULL, crypto_dispatch_enable_disable);
433 im->esp_default_backend = idx;
435 rv = ipsec_select_esp_backend (im, idx);
437 (void) (rv); // avoid warning
439 if ((error = vlib_call_init_function (vm, ipsec_cli_init)))
442 vec_validate (im->crypto_algs, IPSEC_CRYPTO_N_ALG - 1);
444 a = im->crypto_algs + IPSEC_CRYPTO_ALG_NONE;
445 a->enc_op_id = VNET_CRYPTO_OP_NONE;
446 a->dec_op_id = VNET_CRYPTO_OP_NONE;
447 a->alg = VNET_CRYPTO_ALG_NONE;
451 a = im->crypto_algs + IPSEC_CRYPTO_ALG_DES_CBC;
452 a->enc_op_id = VNET_CRYPTO_OP_DES_CBC_ENC;
453 a->dec_op_id = VNET_CRYPTO_OP_DES_CBC_DEC;
454 a->alg = VNET_CRYPTO_ALG_DES_CBC;
455 a->iv_size = a->block_align = 8;
457 a = im->crypto_algs + IPSEC_CRYPTO_ALG_3DES_CBC;
458 a->enc_op_id = VNET_CRYPTO_OP_3DES_CBC_ENC;
459 a->dec_op_id = VNET_CRYPTO_OP_3DES_CBC_DEC;
460 a->alg = VNET_CRYPTO_ALG_3DES_CBC;
461 a->iv_size = a->block_align = 8;
463 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_128;
464 a->enc_op_id = VNET_CRYPTO_OP_AES_128_CBC_ENC;
465 a->dec_op_id = VNET_CRYPTO_OP_AES_128_CBC_DEC;
466 a->alg = VNET_CRYPTO_ALG_AES_128_CBC;
467 a->iv_size = a->block_align = 16;
469 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_192;
470 a->enc_op_id = VNET_CRYPTO_OP_AES_192_CBC_ENC;
471 a->dec_op_id = VNET_CRYPTO_OP_AES_192_CBC_DEC;
472 a->alg = VNET_CRYPTO_ALG_AES_192_CBC;
473 a->iv_size = a->block_align = 16;
475 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_256;
476 a->enc_op_id = VNET_CRYPTO_OP_AES_256_CBC_ENC;
477 a->dec_op_id = VNET_CRYPTO_OP_AES_256_CBC_DEC;
478 a->alg = VNET_CRYPTO_ALG_AES_256_CBC;
479 a->iv_size = a->block_align = 16;
481 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CTR_128;
482 a->enc_op_id = VNET_CRYPTO_OP_AES_128_CTR_ENC;
483 a->dec_op_id = VNET_CRYPTO_OP_AES_128_CTR_DEC;
484 a->alg = VNET_CRYPTO_ALG_AES_128_CTR;
488 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CTR_192;
489 a->enc_op_id = VNET_CRYPTO_OP_AES_192_CTR_ENC;
490 a->dec_op_id = VNET_CRYPTO_OP_AES_192_CTR_DEC;
491 a->alg = VNET_CRYPTO_ALG_AES_192_CTR;
495 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CTR_256;
496 a->enc_op_id = VNET_CRYPTO_OP_AES_256_CTR_ENC;
497 a->dec_op_id = VNET_CRYPTO_OP_AES_256_CTR_DEC;
498 a->alg = VNET_CRYPTO_ALG_AES_256_CTR;
502 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_128;
503 a->enc_op_id = VNET_CRYPTO_OP_AES_128_GCM_ENC;
504 a->dec_op_id = VNET_CRYPTO_OP_AES_128_GCM_DEC;
505 a->alg = VNET_CRYPTO_ALG_AES_128_GCM;
510 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_192;
511 a->enc_op_id = VNET_CRYPTO_OP_AES_192_GCM_ENC;
512 a->dec_op_id = VNET_CRYPTO_OP_AES_192_GCM_DEC;
513 a->alg = VNET_CRYPTO_ALG_AES_192_GCM;
518 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_256;
519 a->enc_op_id = VNET_CRYPTO_OP_AES_256_GCM_ENC;
520 a->dec_op_id = VNET_CRYPTO_OP_AES_256_GCM_DEC;
521 a->alg = VNET_CRYPTO_ALG_AES_256_GCM;
526 vec_validate (im->integ_algs, IPSEC_INTEG_N_ALG - 1);
527 ipsec_main_integ_alg_t *i;
529 i = &im->integ_algs[IPSEC_INTEG_ALG_MD5_96];
530 i->op_id = VNET_CRYPTO_OP_MD5_HMAC;
531 i->alg = VNET_CRYPTO_ALG_HMAC_MD5;
534 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA1_96];
535 i->op_id = VNET_CRYPTO_OP_SHA1_HMAC;
536 i->alg = VNET_CRYPTO_ALG_HMAC_SHA1;
539 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_256_96];
540 i->op_id = VNET_CRYPTO_OP_SHA1_HMAC;
541 i->alg = VNET_CRYPTO_ALG_HMAC_SHA256;
544 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_256_128];
545 i->op_id = VNET_CRYPTO_OP_SHA256_HMAC;
546 i->alg = VNET_CRYPTO_ALG_HMAC_SHA256;
549 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_384_192];
550 i->op_id = VNET_CRYPTO_OP_SHA384_HMAC;
551 i->alg = VNET_CRYPTO_ALG_HMAC_SHA384;
554 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_512_256];
555 i->op_id = VNET_CRYPTO_OP_SHA512_HMAC;
556 i->alg = VNET_CRYPTO_ALG_HMAC_SHA512;
559 vec_validate_aligned (im->ptd, vlib_num_workers (), CLIB_CACHE_LINE_BYTES);
561 im->ah4_enc_fq_index =
562 vlib_frame_queue_main_init (ah4_encrypt_node.index, 0);
563 im->ah4_dec_fq_index =
564 vlib_frame_queue_main_init (ah4_decrypt_node.index, 0);
565 im->ah6_enc_fq_index =
566 vlib_frame_queue_main_init (ah6_encrypt_node.index, 0);
567 im->ah6_dec_fq_index =
568 vlib_frame_queue_main_init (ah6_decrypt_node.index, 0);
570 im->esp4_enc_fq_index =
571 vlib_frame_queue_main_init (esp4_encrypt_node.index, 0);
572 im->esp4_dec_fq_index =
573 vlib_frame_queue_main_init (esp4_decrypt_node.index, 0);
574 im->esp6_enc_fq_index =
575 vlib_frame_queue_main_init (esp6_encrypt_node.index, 0);
576 im->esp6_dec_fq_index =
577 vlib_frame_queue_main_init (esp6_decrypt_node.index, 0);
578 im->esp4_enc_tun_fq_index =
579 vlib_frame_queue_main_init (esp4_encrypt_tun_node.index, 0);
580 im->esp6_enc_tun_fq_index =
581 vlib_frame_queue_main_init (esp6_encrypt_tun_node.index, 0);
582 im->esp_mpls_enc_tun_fq_index =
583 vlib_frame_queue_main_init (esp_mpls_encrypt_tun_node.index, 0);
584 im->esp4_dec_tun_fq_index =
585 vlib_frame_queue_main_init (esp4_decrypt_tun_node.index, 0);
586 im->esp6_dec_tun_fq_index =
587 vlib_frame_queue_main_init (esp6_decrypt_tun_node.index, 0);
590 crypto_engine_backend_register_post_node (vm);
595 VLIB_INIT_FUNCTION (ipsec_init);
598 * fd.io coding-style-patch-verification: ON
601 * eval: (c-set-style "gnu")