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_unregister_udp_port (u16 port)
130 ipsec_main_t *im = &ipsec_main;
134 p = hash_get (im->udp_port_registrations, port);
142 udp_unregister_dst_port (vlib_get_main (), port, 1);
143 hash_unset (im->udp_port_registrations, port);
147 hash_unset (im->udp_port_registrations, port);
148 hash_set (im->udp_port_registrations, port, n_regs);
153 ipsec_register_udp_port (u16 port)
155 ipsec_main_t *im = &ipsec_main;
159 p = hash_get (im->udp_port_registrations, port);
161 n_regs = (p ? p[0] : 0);
164 udp_register_dst_port (vlib_get_main (), port,
165 ipsec4_tun_input_node.index, 1);
167 hash_unset (im->udp_port_registrations, port);
168 hash_set (im->udp_port_registrations, port, n_regs);
172 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
174 const char *ah4_encrypt_node_name,
175 const char *ah4_decrypt_node_name,
176 const char *ah6_encrypt_node_name,
177 const char *ah6_decrypt_node_name,
178 check_support_cb_t ah_check_support_cb,
179 add_del_sa_sess_cb_t ah_add_del_sa_sess_cb)
181 ipsec_ah_backend_t *b;
182 pool_get (im->ah_backends, b);
183 b->name = format (0, "%s%c", name, 0);
185 ipsec_add_node (vm, ah4_encrypt_node_name, "ipsec4-output-feature",
186 &b->ah4_encrypt_node_index, &b->ah4_encrypt_next_index);
187 ipsec_add_node (vm, ah4_decrypt_node_name, "ipsec4-input-feature",
188 &b->ah4_decrypt_node_index, &b->ah4_decrypt_next_index);
189 ipsec_add_node (vm, ah6_encrypt_node_name, "ipsec6-output-feature",
190 &b->ah6_encrypt_node_index, &b->ah6_encrypt_next_index);
191 ipsec_add_node (vm, ah6_decrypt_node_name, "ipsec6-input-feature",
192 &b->ah6_decrypt_node_index, &b->ah6_decrypt_next_index);
194 b->check_support_cb = ah_check_support_cb;
195 b->add_del_sa_sess_cb = ah_add_del_sa_sess_cb;
196 return b - im->ah_backends;
200 ipsec_register_esp_backend (
201 vlib_main_t *vm, ipsec_main_t *im, const char *name,
202 const char *esp4_encrypt_node_name, const char *esp4_encrypt_node_tun_name,
203 const char *esp4_decrypt_node_name, const char *esp4_decrypt_tun_node_name,
204 const char *esp6_encrypt_node_name, const char *esp6_encrypt_node_tun_name,
205 const char *esp6_decrypt_node_name, const char *esp6_decrypt_tun_node_name,
206 const char *esp_mpls_encrypt_node_tun_name,
207 check_support_cb_t esp_check_support_cb,
208 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb,
209 enable_disable_cb_t enable_disable_cb)
211 ipsec_esp_backend_t *b;
213 pool_get (im->esp_backends, b);
214 b->name = format (0, "%s%c", name, 0);
216 ipsec_add_node (vm, esp4_encrypt_node_name, "ipsec4-output-feature",
217 &b->esp4_encrypt_node_index, &b->esp4_encrypt_next_index);
218 ipsec_add_node (vm, esp4_decrypt_node_name, "ipsec4-input-feature",
219 &b->esp4_decrypt_node_index, &b->esp4_decrypt_next_index);
220 ipsec_add_node (vm, esp6_encrypt_node_name, "ipsec6-output-feature",
221 &b->esp6_encrypt_node_index, &b->esp6_encrypt_next_index);
222 ipsec_add_node (vm, esp6_decrypt_node_name, "ipsec6-input-feature",
223 &b->esp6_decrypt_node_index, &b->esp6_decrypt_next_index);
224 ipsec_add_node (vm, esp4_decrypt_tun_node_name, "ipsec4-tun-input",
225 &b->esp4_decrypt_tun_node_index,
226 &b->esp4_decrypt_tun_next_index);
227 ipsec_add_node (vm, esp6_decrypt_tun_node_name, "ipsec6-tun-input",
228 &b->esp6_decrypt_tun_node_index,
229 &b->esp6_decrypt_tun_next_index);
231 b->esp6_encrypt_tun_node_index =
232 vlib_get_node_by_name (vm, (u8 *) esp6_encrypt_node_tun_name)->index;
233 b->esp_mpls_encrypt_tun_node_index =
234 vlib_get_node_by_name (vm, (u8 *) esp_mpls_encrypt_node_tun_name)->index;
235 b->esp4_encrypt_tun_node_index =
236 vlib_get_node_by_name (vm, (u8 *) esp4_encrypt_node_tun_name)->index;
238 b->check_support_cb = esp_check_support_cb;
239 b->add_del_sa_sess_cb = esp_add_del_sa_sess_cb;
240 b->enable_disable_cb = enable_disable_cb;
242 return b - im->esp_backends;
246 ipsec_rsc_in_use (ipsec_main_t * im)
248 /* return an error is crypto resource are in use */
249 if (pool_elts (im->sad) > 0)
250 return clib_error_return (0,
251 "%d SA entries configured",
252 pool_elts (im->sad));
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 /* lock all SAs before change im->async_mode */
334 pool_foreach (sa, im->sad)
336 fib_node_lock (&sa->node);
339 im->async_mode = is_enabled;
341 /* change SA crypto op data before unlock them */
342 pool_foreach (sa, im->sad)
344 sa->crypto_op_data = is_enabled ?
345 sa->async_op_data.data : sa->sync_op_data.data;
346 fib_node_unlock (&sa->node);
351 crypto_engine_backend_register_post_node (vlib_main_t * vm)
353 esp_async_post_next_t *eit;
354 esp_async_post_next_t *dit;
356 eit = &esp_encrypt_async_next;
357 eit->esp4_post_next =
358 vnet_crypto_register_post_node (vm, "esp4-encrypt-post");
359 eit->esp6_post_next =
360 vnet_crypto_register_post_node (vm, "esp6-encrypt-post");
361 eit->esp4_tun_post_next =
362 vnet_crypto_register_post_node (vm, "esp4-encrypt-tun-post");
363 eit->esp6_tun_post_next =
364 vnet_crypto_register_post_node (vm, "esp6-encrypt-tun-post");
365 eit->esp_mpls_tun_post_next =
366 vnet_crypto_register_post_node (vm, "esp-mpls-encrypt-tun-post");
368 dit = &esp_decrypt_async_next;
369 dit->esp4_post_next =
370 vnet_crypto_register_post_node (vm, "esp4-decrypt-post");
371 dit->esp6_post_next =
372 vnet_crypto_register_post_node (vm, "esp6-decrypt-post");
373 dit->esp4_tun_post_next =
374 vnet_crypto_register_post_node (vm, "esp4-decrypt-tun-post");
375 dit->esp6_tun_post_next =
376 vnet_crypto_register_post_node (vm, "esp6-decrypt-tun-post");
379 static clib_error_t *
380 ipsec_init (vlib_main_t * vm)
383 ipsec_main_t *im = &ipsec_main;
384 ipsec_main_crypto_alg_t *a;
386 /* Backend registration requires the feature arcs to be set up */
387 if ((error = vlib_call_init_function (vm, vnet_feature_init)))
390 im->vnet_main = vnet_get_main ();
393 im->spd_index_by_spd_id = hash_create (0, sizeof (uword));
394 im->sa_index_by_sa_id = hash_create (0, sizeof (uword));
395 im->spd_index_by_sw_if_index = hash_create (0, sizeof (uword));
397 vlib_node_t *node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
399 im->error_drop_node_index = node->index;
401 im->ah_current_backend = ~0;
402 im->esp_current_backend = ~0;
404 u32 idx = ipsec_register_ah_backend (vm, im, "crypto engine backend",
409 ipsec_check_ah_support,
412 im->ah_default_backend = idx;
413 int rv = ipsec_select_ah_backend (im, idx);
415 (void) (rv); // avoid warning
417 idx = ipsec_register_esp_backend (
418 vm, im, "crypto engine backend", "esp4-encrypt", "esp4-encrypt-tun",
419 "esp4-decrypt", "esp4-decrypt-tun", "esp6-encrypt", "esp6-encrypt-tun",
420 "esp6-decrypt", "esp6-decrypt-tun", "esp-mpls-encrypt-tun",
421 ipsec_check_esp_support, NULL, crypto_dispatch_enable_disable);
422 im->esp_default_backend = idx;
424 rv = ipsec_select_esp_backend (im, idx);
426 (void) (rv); // avoid warning
428 if ((error = vlib_call_init_function (vm, ipsec_cli_init)))
431 vec_validate (im->crypto_algs, IPSEC_CRYPTO_N_ALG - 1);
433 a = im->crypto_algs + IPSEC_CRYPTO_ALG_NONE;
434 a->enc_op_id = VNET_CRYPTO_OP_NONE;
435 a->dec_op_id = VNET_CRYPTO_OP_NONE;
436 a->alg = VNET_CRYPTO_ALG_NONE;
440 a = im->crypto_algs + IPSEC_CRYPTO_ALG_DES_CBC;
441 a->enc_op_id = VNET_CRYPTO_OP_DES_CBC_ENC;
442 a->dec_op_id = VNET_CRYPTO_OP_DES_CBC_DEC;
443 a->alg = VNET_CRYPTO_ALG_DES_CBC;
444 a->iv_size = a->block_align = 8;
446 a = im->crypto_algs + IPSEC_CRYPTO_ALG_3DES_CBC;
447 a->enc_op_id = VNET_CRYPTO_OP_3DES_CBC_ENC;
448 a->dec_op_id = VNET_CRYPTO_OP_3DES_CBC_DEC;
449 a->alg = VNET_CRYPTO_ALG_3DES_CBC;
450 a->iv_size = a->block_align = 8;
452 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_128;
453 a->enc_op_id = VNET_CRYPTO_OP_AES_128_CBC_ENC;
454 a->dec_op_id = VNET_CRYPTO_OP_AES_128_CBC_DEC;
455 a->alg = VNET_CRYPTO_ALG_AES_128_CBC;
456 a->iv_size = a->block_align = 16;
458 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_192;
459 a->enc_op_id = VNET_CRYPTO_OP_AES_192_CBC_ENC;
460 a->dec_op_id = VNET_CRYPTO_OP_AES_192_CBC_DEC;
461 a->alg = VNET_CRYPTO_ALG_AES_192_CBC;
462 a->iv_size = a->block_align = 16;
464 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_256;
465 a->enc_op_id = VNET_CRYPTO_OP_AES_256_CBC_ENC;
466 a->dec_op_id = VNET_CRYPTO_OP_AES_256_CBC_DEC;
467 a->alg = VNET_CRYPTO_ALG_AES_256_CBC;
468 a->iv_size = a->block_align = 16;
470 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CTR_128;
471 a->enc_op_id = VNET_CRYPTO_OP_AES_128_CTR_ENC;
472 a->dec_op_id = VNET_CRYPTO_OP_AES_128_CTR_DEC;
473 a->alg = VNET_CRYPTO_ALG_AES_128_CTR;
477 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CTR_192;
478 a->enc_op_id = VNET_CRYPTO_OP_AES_192_CTR_ENC;
479 a->dec_op_id = VNET_CRYPTO_OP_AES_192_CTR_DEC;
480 a->alg = VNET_CRYPTO_ALG_AES_192_CTR;
484 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CTR_256;
485 a->enc_op_id = VNET_CRYPTO_OP_AES_256_CTR_ENC;
486 a->dec_op_id = VNET_CRYPTO_OP_AES_256_CTR_DEC;
487 a->alg = VNET_CRYPTO_ALG_AES_256_CTR;
491 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_128;
492 a->enc_op_id = VNET_CRYPTO_OP_AES_128_GCM_ENC;
493 a->dec_op_id = VNET_CRYPTO_OP_AES_128_GCM_DEC;
494 a->alg = VNET_CRYPTO_ALG_AES_128_GCM;
499 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_192;
500 a->enc_op_id = VNET_CRYPTO_OP_AES_192_GCM_ENC;
501 a->dec_op_id = VNET_CRYPTO_OP_AES_192_GCM_DEC;
502 a->alg = VNET_CRYPTO_ALG_AES_192_GCM;
507 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_256;
508 a->enc_op_id = VNET_CRYPTO_OP_AES_256_GCM_ENC;
509 a->dec_op_id = VNET_CRYPTO_OP_AES_256_GCM_DEC;
510 a->alg = VNET_CRYPTO_ALG_AES_256_GCM;
515 vec_validate (im->integ_algs, IPSEC_INTEG_N_ALG - 1);
516 ipsec_main_integ_alg_t *i;
518 i = &im->integ_algs[IPSEC_INTEG_ALG_MD5_96];
519 i->op_id = VNET_CRYPTO_OP_MD5_HMAC;
520 i->alg = VNET_CRYPTO_ALG_HMAC_MD5;
523 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA1_96];
524 i->op_id = VNET_CRYPTO_OP_SHA1_HMAC;
525 i->alg = VNET_CRYPTO_ALG_HMAC_SHA1;
528 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_256_96];
529 i->op_id = VNET_CRYPTO_OP_SHA1_HMAC;
530 i->alg = VNET_CRYPTO_ALG_HMAC_SHA256;
533 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_256_128];
534 i->op_id = VNET_CRYPTO_OP_SHA256_HMAC;
535 i->alg = VNET_CRYPTO_ALG_HMAC_SHA256;
538 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_384_192];
539 i->op_id = VNET_CRYPTO_OP_SHA384_HMAC;
540 i->alg = VNET_CRYPTO_ALG_HMAC_SHA384;
543 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_512_256];
544 i->op_id = VNET_CRYPTO_OP_SHA512_HMAC;
545 i->alg = VNET_CRYPTO_ALG_HMAC_SHA512;
548 vec_validate_aligned (im->ptd, vlib_num_workers (), CLIB_CACHE_LINE_BYTES);
551 crypto_engine_backend_register_post_node (vm);
556 VLIB_INIT_FUNCTION (ipsec_init);
559 * fd.io coding-style-patch-verification: ON
562 * eval: (c-set-style "gnu")