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>
27 #include <vnet/ipsec/ipsec_tun.h>
29 ipsec_main_t ipsec_main;
30 esp_async_post_next_t esp_encrypt_async_next;
31 esp_async_post_next_t esp_decrypt_async_next;
34 ipsec_check_ah_support (ipsec_sa_t * sa)
36 ipsec_main_t *im = &ipsec_main;
38 if (sa->integ_alg == IPSEC_INTEG_ALG_NONE)
39 return clib_error_return (0, "unsupported none integ-alg");
41 if (!vnet_crypto_is_set_handler (im->integ_algs[sa->integ_alg].alg))
42 return clib_error_return (0, "No crypto engine support for %U",
43 format_ipsec_integ_alg, sa->integ_alg);
49 ipsec_check_esp_support (ipsec_sa_t * sa)
51 ipsec_main_t *im = &ipsec_main;
53 if (IPSEC_INTEG_ALG_NONE != sa->integ_alg)
55 if (!vnet_crypto_is_set_handler (im->integ_algs[sa->integ_alg].alg))
56 return clib_error_return (0, "No crypto engine support for %U",
57 format_ipsec_integ_alg, sa->integ_alg);
59 if (IPSEC_CRYPTO_ALG_NONE != sa->crypto_alg)
61 if (!vnet_crypto_is_set_handler (im->crypto_algs[sa->crypto_alg].alg))
62 return clib_error_return (0, "No crypto engine support for %U",
63 format_ipsec_crypto_alg, sa->crypto_alg);
70 ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index, u8 is_add)
72 ipsec_ah_backend_t *ah =
73 pool_elt_at_index (im->ah_backends, im->ah_current_backend);
74 if (ah->add_del_sa_sess_cb)
76 clib_error_t *err = ah->add_del_sa_sess_cb (sa_index, is_add);
80 ipsec_esp_backend_t *esp =
81 pool_elt_at_index (im->esp_backends, im->esp_current_backend);
82 if (esp->add_del_sa_sess_cb)
84 clib_error_t *err = esp->add_del_sa_sess_cb (sa_index, is_add);
92 ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa)
94 clib_error_t *error = 0;
96 if (PREDICT_FALSE (sa->protocol == IPSEC_PROTOCOL_AH))
98 ipsec_ah_backend_t *ah =
99 pool_elt_at_index (im->ah_backends, im->ah_current_backend);
100 ASSERT (ah->check_support_cb);
101 error = ah->check_support_cb (sa);
105 ipsec_esp_backend_t *esp =
106 pool_elt_at_index (im->esp_backends, im->esp_current_backend);
107 ASSERT (esp->check_support_cb);
108 error = esp->check_support_cb (sa);
115 ipsec_add_node (vlib_main_t * vm, const char *node_name,
116 const char *prev_node_name, u32 * out_node_index,
117 u32 * out_next_index)
119 vlib_node_t *prev_node, *node;
120 prev_node = vlib_get_node_by_name (vm, (u8 *) prev_node_name);
122 node = vlib_get_node_by_name (vm, (u8 *) node_name);
124 *out_node_index = node->index;
125 *out_next_index = vlib_node_add_next (vm, prev_node->index, node->index);
129 ipsec_unregister_udp_port (u16 port)
131 ipsec_main_t *im = &ipsec_main;
135 p = hash_get (im->udp_port_registrations, port);
143 udp_unregister_dst_port (vlib_get_main (), port, 1);
144 hash_unset (im->udp_port_registrations, port);
148 hash_unset (im->udp_port_registrations, port);
149 hash_set (im->udp_port_registrations, port, n_regs);
154 ipsec_register_udp_port (u16 port)
156 ipsec_main_t *im = &ipsec_main;
160 p = hash_get (im->udp_port_registrations, port);
162 n_regs = (p ? p[0] : 0);
165 udp_register_dst_port (vlib_get_main (), port,
166 ipsec4_tun_input_node.index, 1);
168 hash_unset (im->udp_port_registrations, port);
169 hash_set (im->udp_port_registrations, port, n_regs);
173 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
175 const char *ah4_encrypt_node_name,
176 const char *ah4_decrypt_node_name,
177 const char *ah6_encrypt_node_name,
178 const char *ah6_decrypt_node_name,
179 check_support_cb_t ah_check_support_cb,
180 add_del_sa_sess_cb_t ah_add_del_sa_sess_cb)
182 ipsec_ah_backend_t *b;
183 pool_get (im->ah_backends, b);
184 b->name = format (0, "%s%c", name, 0);
186 ipsec_add_node (vm, ah4_encrypt_node_name, "ipsec4-output-feature",
187 &b->ah4_encrypt_node_index, &b->ah4_encrypt_next_index);
188 ipsec_add_node (vm, ah4_decrypt_node_name, "ipsec4-input-feature",
189 &b->ah4_decrypt_node_index, &b->ah4_decrypt_next_index);
190 ipsec_add_node (vm, ah6_encrypt_node_name, "ipsec6-output-feature",
191 &b->ah6_encrypt_node_index, &b->ah6_encrypt_next_index);
192 ipsec_add_node (vm, ah6_decrypt_node_name, "ipsec6-input-feature",
193 &b->ah6_decrypt_node_index, &b->ah6_decrypt_next_index);
195 b->check_support_cb = ah_check_support_cb;
196 b->add_del_sa_sess_cb = ah_add_del_sa_sess_cb;
197 return b - im->ah_backends;
201 ipsec_register_esp_backend (
202 vlib_main_t *vm, ipsec_main_t *im, const char *name,
203 const char *esp4_encrypt_node_name, const char *esp4_encrypt_node_tun_name,
204 const char *esp4_decrypt_node_name, const char *esp4_decrypt_tun_node_name,
205 const char *esp6_encrypt_node_name, const char *esp6_encrypt_node_tun_name,
206 const char *esp6_decrypt_node_name, const char *esp6_decrypt_tun_node_name,
207 const char *esp_mpls_encrypt_node_tun_name,
208 check_support_cb_t esp_check_support_cb,
209 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb,
210 enable_disable_cb_t enable_disable_cb)
212 ipsec_esp_backend_t *b;
214 pool_get (im->esp_backends, b);
215 b->name = format (0, "%s%c", name, 0);
217 ipsec_add_node (vm, esp4_encrypt_node_name, "ipsec4-output-feature",
218 &b->esp4_encrypt_node_index, &b->esp4_encrypt_next_index);
219 ipsec_add_node (vm, esp4_decrypt_node_name, "ipsec4-input-feature",
220 &b->esp4_decrypt_node_index, &b->esp4_decrypt_next_index);
221 ipsec_add_node (vm, esp6_encrypt_node_name, "ipsec6-output-feature",
222 &b->esp6_encrypt_node_index, &b->esp6_encrypt_next_index);
223 ipsec_add_node (vm, esp6_decrypt_node_name, "ipsec6-input-feature",
224 &b->esp6_decrypt_node_index, &b->esp6_decrypt_next_index);
225 ipsec_add_node (vm, esp4_decrypt_tun_node_name, "ipsec4-tun-input",
226 &b->esp4_decrypt_tun_node_index,
227 &b->esp4_decrypt_tun_next_index);
228 ipsec_add_node (vm, esp6_decrypt_tun_node_name, "ipsec6-tun-input",
229 &b->esp6_decrypt_tun_node_index,
230 &b->esp6_decrypt_tun_next_index);
232 b->esp6_encrypt_tun_node_index =
233 vlib_get_node_by_name (vm, (u8 *) esp6_encrypt_node_tun_name)->index;
234 b->esp_mpls_encrypt_tun_node_index =
235 vlib_get_node_by_name (vm, (u8 *) esp_mpls_encrypt_node_tun_name)->index;
236 b->esp4_encrypt_tun_node_index =
237 vlib_get_node_by_name (vm, (u8 *) esp4_encrypt_node_tun_name)->index;
239 b->check_support_cb = esp_check_support_cb;
240 b->add_del_sa_sess_cb = esp_add_del_sa_sess_cb;
241 b->enable_disable_cb = enable_disable_cb;
243 return b - im->esp_backends;
247 ipsec_rsc_in_use (ipsec_main_t * im)
249 /* return an error is crypto resource are in use */
250 if (pool_elts (ipsec_sa_pool) > 0)
251 return clib_error_return (0, "%d SA entries configured",
252 pool_elts (ipsec_sa_pool));
258 ipsec_select_ah_backend (ipsec_main_t * im, u32 backend_idx)
260 if (ipsec_rsc_in_use (im))
261 return VNET_API_ERROR_RSRC_IN_USE;
263 if (pool_is_free_index (im->ah_backends, backend_idx))
264 return VNET_API_ERROR_INVALID_VALUE;
266 ipsec_ah_backend_t *b = pool_elt_at_index (im->ah_backends, backend_idx);
267 im->ah_current_backend = backend_idx;
268 im->ah4_encrypt_node_index = b->ah4_encrypt_node_index;
269 im->ah4_decrypt_node_index = b->ah4_decrypt_node_index;
270 im->ah4_encrypt_next_index = b->ah4_encrypt_next_index;
271 im->ah4_decrypt_next_index = b->ah4_decrypt_next_index;
272 im->ah6_encrypt_node_index = b->ah6_encrypt_node_index;
273 im->ah6_decrypt_node_index = b->ah6_decrypt_node_index;
274 im->ah6_encrypt_next_index = b->ah6_encrypt_next_index;
275 im->ah6_decrypt_next_index = b->ah6_decrypt_next_index;
281 ipsec_select_esp_backend (ipsec_main_t * im, u32 backend_idx)
283 if (ipsec_rsc_in_use (im))
284 return VNET_API_ERROR_RSRC_IN_USE;
286 if (pool_is_free_index (im->esp_backends, backend_idx))
287 return VNET_API_ERROR_INVALID_VALUE;
289 /* disable current backend */
290 if (im->esp_current_backend != ~0)
292 ipsec_esp_backend_t *cb = pool_elt_at_index (im->esp_backends,
293 im->esp_current_backend);
294 if (cb->enable_disable_cb)
296 if ((cb->enable_disable_cb) (0) != 0)
301 ipsec_esp_backend_t *b = pool_elt_at_index (im->esp_backends, backend_idx);
302 im->esp_current_backend = backend_idx;
303 im->esp4_encrypt_node_index = b->esp4_encrypt_node_index;
304 im->esp4_decrypt_node_index = b->esp4_decrypt_node_index;
305 im->esp4_encrypt_next_index = b->esp4_encrypt_next_index;
306 im->esp4_decrypt_next_index = b->esp4_decrypt_next_index;
307 im->esp6_encrypt_node_index = b->esp6_encrypt_node_index;
308 im->esp6_decrypt_node_index = b->esp6_decrypt_node_index;
309 im->esp6_encrypt_next_index = b->esp6_encrypt_next_index;
310 im->esp6_decrypt_next_index = b->esp6_decrypt_next_index;
311 im->esp4_decrypt_tun_node_index = b->esp4_decrypt_tun_node_index;
312 im->esp4_decrypt_tun_next_index = b->esp4_decrypt_tun_next_index;
313 im->esp6_decrypt_tun_node_index = b->esp6_decrypt_tun_node_index;
314 im->esp6_decrypt_tun_next_index = b->esp6_decrypt_tun_next_index;
315 im->esp4_encrypt_tun_node_index = b->esp4_encrypt_tun_node_index;
316 im->esp6_encrypt_tun_node_index = b->esp6_encrypt_tun_node_index;
317 im->esp_mpls_encrypt_tun_node_index = b->esp_mpls_encrypt_tun_node_index;
319 if (b->enable_disable_cb)
321 if ((b->enable_disable_cb) (1) != 0)
328 ipsec_set_async_mode (u32 is_enabled)
330 ipsec_main_t *im = &ipsec_main;
333 vnet_crypto_request_async_mode (is_enabled);
335 im->async_mode = is_enabled;
337 /* change SA crypto op data */
338 pool_foreach (sa, ipsec_sa_pool)
341 (is_enabled ? sa->async_op_data.data : sa->sync_op_data.data);
346 crypto_engine_backend_register_post_node (vlib_main_t * vm)
348 esp_async_post_next_t *eit;
349 esp_async_post_next_t *dit;
351 eit = &esp_encrypt_async_next;
352 eit->esp4_post_next =
353 vnet_crypto_register_post_node (vm, "esp4-encrypt-post");
354 eit->esp6_post_next =
355 vnet_crypto_register_post_node (vm, "esp6-encrypt-post");
356 eit->esp4_tun_post_next =
357 vnet_crypto_register_post_node (vm, "esp4-encrypt-tun-post");
358 eit->esp6_tun_post_next =
359 vnet_crypto_register_post_node (vm, "esp6-encrypt-tun-post");
360 eit->esp_mpls_tun_post_next =
361 vnet_crypto_register_post_node (vm, "esp-mpls-encrypt-tun-post");
363 dit = &esp_decrypt_async_next;
364 dit->esp4_post_next =
365 vnet_crypto_register_post_node (vm, "esp4-decrypt-post");
366 dit->esp6_post_next =
367 vnet_crypto_register_post_node (vm, "esp6-decrypt-post");
368 dit->esp4_tun_post_next =
369 vnet_crypto_register_post_node (vm, "esp4-decrypt-tun-post");
370 dit->esp6_tun_post_next =
371 vnet_crypto_register_post_node (vm, "esp6-decrypt-tun-post");
374 static clib_error_t *
375 ipsec_init (vlib_main_t * vm)
378 ipsec_main_t *im = &ipsec_main;
379 ipsec_main_crypto_alg_t *a;
381 /* Backend registration requires the feature arcs to be set up */
382 if ((error = vlib_call_init_function (vm, vnet_feature_init)))
385 im->vnet_main = vnet_get_main ();
388 im->spd_index_by_spd_id = hash_create (0, sizeof (uword));
389 im->sa_index_by_sa_id = hash_create (0, sizeof (uword));
390 im->spd_index_by_sw_if_index = hash_create (0, sizeof (uword));
392 vlib_node_t *node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
394 im->error_drop_node_index = node->index;
396 im->ah_current_backend = ~0;
397 im->esp_current_backend = ~0;
399 u32 idx = ipsec_register_ah_backend (vm, im, "crypto engine backend",
404 ipsec_check_ah_support,
407 im->ah_default_backend = idx;
408 int rv = ipsec_select_ah_backend (im, idx);
410 (void) (rv); // avoid warning
412 idx = ipsec_register_esp_backend (
413 vm, im, "crypto engine backend", "esp4-encrypt", "esp4-encrypt-tun",
414 "esp4-decrypt", "esp4-decrypt-tun", "esp6-encrypt", "esp6-encrypt-tun",
415 "esp6-decrypt", "esp6-decrypt-tun", "esp-mpls-encrypt-tun",
416 ipsec_check_esp_support, NULL, crypto_dispatch_enable_disable);
417 im->esp_default_backend = idx;
419 rv = ipsec_select_esp_backend (im, idx);
421 (void) (rv); // avoid warning
423 if ((error = vlib_call_init_function (vm, ipsec_cli_init)))
426 vec_validate (im->crypto_algs, IPSEC_CRYPTO_N_ALG - 1);
428 a = im->crypto_algs + IPSEC_CRYPTO_ALG_NONE;
429 a->enc_op_id = VNET_CRYPTO_OP_NONE;
430 a->dec_op_id = VNET_CRYPTO_OP_NONE;
431 a->alg = VNET_CRYPTO_ALG_NONE;
435 a = im->crypto_algs + IPSEC_CRYPTO_ALG_DES_CBC;
436 a->enc_op_id = VNET_CRYPTO_OP_DES_CBC_ENC;
437 a->dec_op_id = VNET_CRYPTO_OP_DES_CBC_DEC;
438 a->alg = VNET_CRYPTO_ALG_DES_CBC;
439 a->iv_size = a->block_align = 8;
441 a = im->crypto_algs + IPSEC_CRYPTO_ALG_3DES_CBC;
442 a->enc_op_id = VNET_CRYPTO_OP_3DES_CBC_ENC;
443 a->dec_op_id = VNET_CRYPTO_OP_3DES_CBC_DEC;
444 a->alg = VNET_CRYPTO_ALG_3DES_CBC;
445 a->iv_size = a->block_align = 8;
447 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_128;
448 a->enc_op_id = VNET_CRYPTO_OP_AES_128_CBC_ENC;
449 a->dec_op_id = VNET_CRYPTO_OP_AES_128_CBC_DEC;
450 a->alg = VNET_CRYPTO_ALG_AES_128_CBC;
451 a->iv_size = a->block_align = 16;
453 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_192;
454 a->enc_op_id = VNET_CRYPTO_OP_AES_192_CBC_ENC;
455 a->dec_op_id = VNET_CRYPTO_OP_AES_192_CBC_DEC;
456 a->alg = VNET_CRYPTO_ALG_AES_192_CBC;
457 a->iv_size = a->block_align = 16;
459 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_256;
460 a->enc_op_id = VNET_CRYPTO_OP_AES_256_CBC_ENC;
461 a->dec_op_id = VNET_CRYPTO_OP_AES_256_CBC_DEC;
462 a->alg = VNET_CRYPTO_ALG_AES_256_CBC;
463 a->iv_size = a->block_align = 16;
465 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CTR_128;
466 a->enc_op_id = VNET_CRYPTO_OP_AES_128_CTR_ENC;
467 a->dec_op_id = VNET_CRYPTO_OP_AES_128_CTR_DEC;
468 a->alg = VNET_CRYPTO_ALG_AES_128_CTR;
472 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CTR_192;
473 a->enc_op_id = VNET_CRYPTO_OP_AES_192_CTR_ENC;
474 a->dec_op_id = VNET_CRYPTO_OP_AES_192_CTR_DEC;
475 a->alg = VNET_CRYPTO_ALG_AES_192_CTR;
479 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CTR_256;
480 a->enc_op_id = VNET_CRYPTO_OP_AES_256_CTR_ENC;
481 a->dec_op_id = VNET_CRYPTO_OP_AES_256_CTR_DEC;
482 a->alg = VNET_CRYPTO_ALG_AES_256_CTR;
486 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_128;
487 a->enc_op_id = VNET_CRYPTO_OP_AES_128_GCM_ENC;
488 a->dec_op_id = VNET_CRYPTO_OP_AES_128_GCM_DEC;
489 a->alg = VNET_CRYPTO_ALG_AES_128_GCM;
494 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_192;
495 a->enc_op_id = VNET_CRYPTO_OP_AES_192_GCM_ENC;
496 a->dec_op_id = VNET_CRYPTO_OP_AES_192_GCM_DEC;
497 a->alg = VNET_CRYPTO_ALG_AES_192_GCM;
502 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_256;
503 a->enc_op_id = VNET_CRYPTO_OP_AES_256_GCM_ENC;
504 a->dec_op_id = VNET_CRYPTO_OP_AES_256_GCM_DEC;
505 a->alg = VNET_CRYPTO_ALG_AES_256_GCM;
510 vec_validate (im->integ_algs, IPSEC_INTEG_N_ALG - 1);
511 ipsec_main_integ_alg_t *i;
513 i = &im->integ_algs[IPSEC_INTEG_ALG_MD5_96];
514 i->op_id = VNET_CRYPTO_OP_MD5_HMAC;
515 i->alg = VNET_CRYPTO_ALG_HMAC_MD5;
518 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA1_96];
519 i->op_id = VNET_CRYPTO_OP_SHA1_HMAC;
520 i->alg = VNET_CRYPTO_ALG_HMAC_SHA1;
523 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_256_96];
524 i->op_id = VNET_CRYPTO_OP_SHA1_HMAC;
525 i->alg = VNET_CRYPTO_ALG_HMAC_SHA256;
528 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_256_128];
529 i->op_id = VNET_CRYPTO_OP_SHA256_HMAC;
530 i->alg = VNET_CRYPTO_ALG_HMAC_SHA256;
533 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_384_192];
534 i->op_id = VNET_CRYPTO_OP_SHA384_HMAC;
535 i->alg = VNET_CRYPTO_ALG_HMAC_SHA384;
538 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_512_256];
539 i->op_id = VNET_CRYPTO_OP_SHA512_HMAC;
540 i->alg = VNET_CRYPTO_ALG_HMAC_SHA512;
543 vec_validate_aligned (im->ptd, vlib_num_workers (), CLIB_CACHE_LINE_BYTES);
546 crypto_engine_backend_register_post_node (vm);
551 VLIB_INIT_FUNCTION (ipsec_init);
553 static clib_error_t *
554 ipsec_config (vlib_main_t *vm, unformat_input_t *input)
556 unformat_input_t sub_input;
558 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
560 if (unformat (input, "ip4 %U", unformat_vlib_cli_sub_input, &sub_input))
562 uword table_size = ~0;
565 while (unformat_check_input (&sub_input) != UNFORMAT_END_OF_INPUT)
567 if (unformat (&sub_input, "num-buckets %u", &n_buckets))
570 return clib_error_return (0, "unknown input `%U'",
571 format_unformat_error, &sub_input);
574 ipsec_tun_table_init (AF_IP4, table_size, n_buckets);
576 else if (unformat (input, "ip6 %U", unformat_vlib_cli_sub_input,
579 uword table_size = ~0;
582 while (unformat_check_input (&sub_input) != UNFORMAT_END_OF_INPUT)
584 if (unformat (&sub_input, "num-buckets %u", &n_buckets))
587 return clib_error_return (0, "unknown input `%U'",
588 format_unformat_error, &sub_input);
591 ipsec_tun_table_init (AF_IP6, table_size, n_buckets);
594 return clib_error_return (0, "unknown input `%U'",
595 format_unformat_error, input);
601 VLIB_CONFIG_FUNCTION (ipsec_config, "ipsec");
604 * fd.io coding-style-patch-verification: ON
607 * eval: (c-set-style "gnu")