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.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;
31 ipsec_check_ah_support (ipsec_sa_t * sa)
33 ipsec_main_t *im = &ipsec_main;
35 if (sa->integ_alg == IPSEC_INTEG_ALG_NONE)
36 return clib_error_return (0, "unsupported none integ-alg");
38 if (!vnet_crypto_is_set_handler (im->integ_algs[sa->integ_alg].alg))
39 return clib_error_return (0, "No crypto engine support for %U",
40 format_ipsec_integ_alg, sa->integ_alg);
46 ipsec_check_esp_support (ipsec_sa_t * sa)
48 ipsec_main_t *im = &ipsec_main;
50 if (IPSEC_INTEG_ALG_NONE != sa->integ_alg)
52 if (!vnet_crypto_is_set_handler (im->integ_algs[sa->integ_alg].alg))
53 return clib_error_return (0, "No crypto engine support for %U",
54 format_ipsec_integ_alg, sa->integ_alg);
56 if (IPSEC_CRYPTO_ALG_NONE != sa->crypto_alg)
58 if (!vnet_crypto_is_set_handler (im->crypto_algs[sa->crypto_alg].alg))
59 return clib_error_return (0, "No crypto engine support for %U",
60 format_ipsec_crypto_alg, sa->crypto_alg);
67 ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index, u8 is_add)
69 ipsec_ah_backend_t *ah =
70 pool_elt_at_index (im->ah_backends, im->ah_current_backend);
71 if (ah->add_del_sa_sess_cb)
73 clib_error_t *err = ah->add_del_sa_sess_cb (sa_index, is_add);
77 ipsec_esp_backend_t *esp =
78 pool_elt_at_index (im->esp_backends, im->esp_current_backend);
79 if (esp->add_del_sa_sess_cb)
81 clib_error_t *err = esp->add_del_sa_sess_cb (sa_index, is_add);
89 ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa)
91 clib_error_t *error = 0;
93 if (PREDICT_FALSE (sa->protocol == IPSEC_PROTOCOL_AH))
95 ipsec_ah_backend_t *ah =
96 pool_elt_at_index (im->ah_backends, im->ah_current_backend);
97 ASSERT (ah->check_support_cb);
98 error = ah->check_support_cb (sa);
102 ipsec_esp_backend_t *esp =
103 pool_elt_at_index (im->esp_backends, im->esp_current_backend);
104 ASSERT (esp->check_support_cb);
105 error = esp->check_support_cb (sa);
112 ipsec_add_node (vlib_main_t * vm, const char *node_name,
113 const char *prev_node_name, u32 * out_node_index,
114 u32 * out_next_index)
116 vlib_node_t *prev_node, *node;
117 prev_node = vlib_get_node_by_name (vm, (u8 *) prev_node_name);
119 node = vlib_get_node_by_name (vm, (u8 *) node_name);
121 *out_node_index = node->index;
122 *out_next_index = vlib_node_add_next (vm, prev_node->index, node->index);
126 ipsec_add_feature (const char *arc_name,
127 const char *node_name, u32 * out_feature_index)
131 arc = vnet_get_feature_arc_index (arc_name);
132 ASSERT (arc != (u8) ~ 0);
133 *out_feature_index = vnet_get_feature_index (arc, node_name);
137 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
139 const char *ah4_encrypt_node_name,
140 const char *ah4_decrypt_node_name,
141 const char *ah6_encrypt_node_name,
142 const char *ah6_decrypt_node_name,
143 check_support_cb_t ah_check_support_cb,
144 add_del_sa_sess_cb_t ah_add_del_sa_sess_cb)
146 ipsec_ah_backend_t *b;
147 pool_get (im->ah_backends, b);
148 b->name = format (0, "%s%c", name, 0);
150 ipsec_add_node (vm, ah4_encrypt_node_name, "ipsec4-output-feature",
151 &b->ah4_encrypt_node_index, &b->ah4_encrypt_next_index);
152 ipsec_add_node (vm, ah4_decrypt_node_name, "ipsec4-input-feature",
153 &b->ah4_decrypt_node_index, &b->ah4_decrypt_next_index);
154 ipsec_add_node (vm, ah6_encrypt_node_name, "ipsec6-output-feature",
155 &b->ah6_encrypt_node_index, &b->ah6_encrypt_next_index);
156 ipsec_add_node (vm, ah6_decrypt_node_name, "ipsec6-input-feature",
157 &b->ah6_decrypt_node_index, &b->ah6_decrypt_next_index);
159 b->check_support_cb = ah_check_support_cb;
160 b->add_del_sa_sess_cb = ah_add_del_sa_sess_cb;
161 return b - im->ah_backends;
165 ipsec_register_esp_backend (vlib_main_t * vm, ipsec_main_t * im,
167 const char *esp4_encrypt_node_name,
168 const char *esp4_encrypt_node_tun_name,
169 const char *esp4_decrypt_node_name,
170 const char *esp4_decrypt_tun_node_name,
171 const char *esp6_encrypt_node_name,
172 const char *esp6_encrypt_node_tun_name,
173 const char *esp6_decrypt_node_name,
174 const char *esp6_decrypt_tun_node_name,
175 check_support_cb_t esp_check_support_cb,
176 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb)
178 ipsec_esp_backend_t *b;
180 pool_get (im->esp_backends, b);
181 b->name = format (0, "%s%c", name, 0);
183 ipsec_add_node (vm, esp4_encrypt_node_name, "ipsec4-output-feature",
184 &b->esp4_encrypt_node_index, &b->esp4_encrypt_next_index);
185 ipsec_add_node (vm, esp4_decrypt_node_name, "ipsec4-input-feature",
186 &b->esp4_decrypt_node_index, &b->esp4_decrypt_next_index);
187 ipsec_add_node (vm, esp6_encrypt_node_name, "ipsec6-output-feature",
188 &b->esp6_encrypt_node_index, &b->esp6_encrypt_next_index);
189 ipsec_add_node (vm, esp6_decrypt_node_name, "ipsec6-input-feature",
190 &b->esp6_decrypt_node_index, &b->esp6_decrypt_next_index);
191 ipsec_add_node (vm, esp4_decrypt_tun_node_name, "ipsec4-tun-input",
192 &b->esp4_decrypt_tun_node_index,
193 &b->esp4_decrypt_tun_next_index);
194 ipsec_add_node (vm, esp6_decrypt_tun_node_name, "ipsec6-tun-input",
195 &b->esp6_decrypt_tun_node_index,
196 &b->esp6_decrypt_tun_next_index);
198 ipsec_add_feature ("ip4-output", esp4_encrypt_node_tun_name,
199 &b->esp44_encrypt_tun_feature_index);
200 ipsec_add_feature ("ip4-output", esp6_encrypt_node_tun_name,
201 &b->esp46_encrypt_tun_feature_index);
202 ipsec_add_feature ("ip6-output", esp6_encrypt_node_tun_name,
203 &b->esp66_encrypt_tun_feature_index);
204 ipsec_add_feature ("ip6-output", esp4_encrypt_node_tun_name,
205 &b->esp64_encrypt_tun_feature_index);
207 b->check_support_cb = esp_check_support_cb;
208 b->add_del_sa_sess_cb = esp_add_del_sa_sess_cb;
209 return b - im->esp_backends;
213 ipsec_rsc_in_use (ipsec_main_t * im)
215 /* return an error is crypto resource are in use */
216 if (pool_elts (im->sad) > 0)
217 return clib_error_return (0,
218 "%d SA entries configured",
219 pool_elts (im->sad));
225 ipsec_select_ah_backend (ipsec_main_t * im, u32 backend_idx)
227 if (ipsec_rsc_in_use (im))
228 return VNET_API_ERROR_RSRC_IN_USE;
230 if (pool_is_free_index (im->ah_backends, backend_idx))
231 return VNET_API_ERROR_INVALID_VALUE;
233 ipsec_ah_backend_t *b = pool_elt_at_index (im->ah_backends, backend_idx);
234 im->ah_current_backend = backend_idx;
235 im->ah4_encrypt_node_index = b->ah4_encrypt_node_index;
236 im->ah4_decrypt_node_index = b->ah4_decrypt_node_index;
237 im->ah4_encrypt_next_index = b->ah4_encrypt_next_index;
238 im->ah4_decrypt_next_index = b->ah4_decrypt_next_index;
239 im->ah6_encrypt_node_index = b->ah6_encrypt_node_index;
240 im->ah6_decrypt_node_index = b->ah6_decrypt_node_index;
241 im->ah6_encrypt_next_index = b->ah6_encrypt_next_index;
242 im->ah6_decrypt_next_index = b->ah6_decrypt_next_index;
248 ipsec_select_esp_backend (ipsec_main_t * im, u32 backend_idx)
250 if (ipsec_rsc_in_use (im))
251 return VNET_API_ERROR_RSRC_IN_USE;
253 if (pool_is_free_index (im->esp_backends, backend_idx))
254 return VNET_API_ERROR_INVALID_VALUE;
256 ipsec_esp_backend_t *b = pool_elt_at_index (im->esp_backends, backend_idx);
257 im->esp_current_backend = backend_idx;
258 im->esp4_encrypt_node_index = b->esp4_encrypt_node_index;
259 im->esp4_decrypt_node_index = b->esp4_decrypt_node_index;
260 im->esp4_encrypt_next_index = b->esp4_encrypt_next_index;
261 im->esp4_decrypt_next_index = b->esp4_decrypt_next_index;
262 im->esp6_encrypt_node_index = b->esp6_encrypt_node_index;
263 im->esp6_decrypt_node_index = b->esp6_decrypt_node_index;
264 im->esp6_encrypt_next_index = b->esp6_encrypt_next_index;
265 im->esp6_decrypt_next_index = b->esp6_decrypt_next_index;
266 im->esp4_decrypt_tun_node_index = b->esp4_decrypt_tun_node_index;
267 im->esp4_decrypt_tun_next_index = b->esp4_decrypt_tun_next_index;
268 im->esp6_decrypt_tun_node_index = b->esp6_decrypt_tun_node_index;
269 im->esp6_decrypt_tun_next_index = b->esp6_decrypt_tun_next_index;
271 im->esp44_encrypt_tun_feature_index = b->esp44_encrypt_tun_feature_index;
272 im->esp64_encrypt_tun_feature_index = b->esp64_encrypt_tun_feature_index;
273 im->esp46_encrypt_tun_feature_index = b->esp46_encrypt_tun_feature_index;
274 im->esp66_encrypt_tun_feature_index = b->esp66_encrypt_tun_feature_index;
279 static clib_error_t *
280 ipsec_init (vlib_main_t * vm)
283 ipsec_main_t *im = &ipsec_main;
284 ipsec_main_crypto_alg_t *a;
286 /* Backend registration requires the feature arcs to be set up */
287 if ((error = vlib_call_init_function (vm, vnet_feature_init)))
290 im->vnet_main = vnet_get_main ();
293 im->spd_index_by_spd_id = hash_create (0, sizeof (uword));
294 im->sa_index_by_sa_id = hash_create (0, sizeof (uword));
295 im->spd_index_by_sw_if_index = hash_create (0, sizeof (uword));
297 vlib_node_t *node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
299 im->error_drop_node_index = node->index;
301 u32 idx = ipsec_register_ah_backend (vm, im, "crypto engine backend",
306 ipsec_check_ah_support,
309 im->ah_default_backend = idx;
310 int rv = ipsec_select_ah_backend (im, idx);
312 (void) (rv); // avoid warning
314 idx = ipsec_register_esp_backend (vm, im, "crypto engine backend",
323 ipsec_check_esp_support, NULL);
324 im->esp_default_backend = idx;
326 rv = ipsec_select_esp_backend (im, idx);
328 (void) (rv); // avoid warning
330 if ((error = vlib_call_init_function (vm, ipsec_cli_init)))
333 vec_validate (im->crypto_algs, IPSEC_CRYPTO_N_ALG - 1);
335 a = im->crypto_algs + IPSEC_CRYPTO_ALG_NONE;
336 a->enc_op_id = VNET_CRYPTO_OP_NONE;
337 a->dec_op_id = VNET_CRYPTO_OP_NONE;
338 a->alg = VNET_CRYPTO_ALG_NONE;
342 a = im->crypto_algs + IPSEC_CRYPTO_ALG_DES_CBC;
343 a->enc_op_id = VNET_CRYPTO_OP_DES_CBC_ENC;
344 a->dec_op_id = VNET_CRYPTO_OP_DES_CBC_DEC;
345 a->alg = VNET_CRYPTO_ALG_DES_CBC;
346 a->iv_size = a->block_size = 8;
348 a = im->crypto_algs + IPSEC_CRYPTO_ALG_3DES_CBC;
349 a->enc_op_id = VNET_CRYPTO_OP_3DES_CBC_ENC;
350 a->dec_op_id = VNET_CRYPTO_OP_3DES_CBC_DEC;
351 a->alg = VNET_CRYPTO_ALG_3DES_CBC;
352 a->iv_size = a->block_size = 8;
354 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_128;
355 a->enc_op_id = VNET_CRYPTO_OP_AES_128_CBC_ENC;
356 a->dec_op_id = VNET_CRYPTO_OP_AES_128_CBC_DEC;
357 a->alg = VNET_CRYPTO_ALG_AES_128_CBC;
358 a->iv_size = a->block_size = 16;
360 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_192;
361 a->enc_op_id = VNET_CRYPTO_OP_AES_192_CBC_ENC;
362 a->dec_op_id = VNET_CRYPTO_OP_AES_192_CBC_DEC;
363 a->alg = VNET_CRYPTO_ALG_AES_192_CBC;
364 a->iv_size = a->block_size = 16;
366 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_256;
367 a->enc_op_id = VNET_CRYPTO_OP_AES_256_CBC_ENC;
368 a->dec_op_id = VNET_CRYPTO_OP_AES_256_CBC_DEC;
369 a->alg = VNET_CRYPTO_ALG_AES_256_CBC;
370 a->iv_size = a->block_size = 16;
372 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_128;
373 a->enc_op_id = VNET_CRYPTO_OP_AES_128_GCM_ENC;
374 a->dec_op_id = VNET_CRYPTO_OP_AES_128_GCM_DEC;
375 a->alg = VNET_CRYPTO_ALG_AES_128_GCM;
376 a->iv_size = a->block_size = 8;
379 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_192;
380 a->enc_op_id = VNET_CRYPTO_OP_AES_192_GCM_ENC;
381 a->dec_op_id = VNET_CRYPTO_OP_AES_192_GCM_DEC;
382 a->alg = VNET_CRYPTO_ALG_AES_192_GCM;
383 a->iv_size = a->block_size = 8;
386 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_256;
387 a->enc_op_id = VNET_CRYPTO_OP_AES_256_GCM_ENC;
388 a->dec_op_id = VNET_CRYPTO_OP_AES_256_GCM_DEC;
389 a->alg = VNET_CRYPTO_ALG_AES_256_GCM;
390 a->iv_size = a->block_size = 8;
393 vec_validate (im->integ_algs, IPSEC_INTEG_N_ALG - 1);
394 ipsec_main_integ_alg_t *i;
396 i = &im->integ_algs[IPSEC_INTEG_ALG_MD5_96];
397 i->op_id = VNET_CRYPTO_OP_MD5_HMAC;
398 i->alg = VNET_CRYPTO_ALG_HMAC_MD5;
401 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA1_96];
402 i->op_id = VNET_CRYPTO_OP_SHA1_HMAC;
403 i->alg = VNET_CRYPTO_ALG_HMAC_SHA1;
406 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_256_96];
407 i->op_id = VNET_CRYPTO_OP_SHA1_HMAC;
408 i->alg = VNET_CRYPTO_ALG_HMAC_SHA256;
411 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_256_128];
412 i->op_id = VNET_CRYPTO_OP_SHA256_HMAC;
413 i->alg = VNET_CRYPTO_ALG_HMAC_SHA256;
416 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_384_192];
417 i->op_id = VNET_CRYPTO_OP_SHA384_HMAC;
418 i->alg = VNET_CRYPTO_ALG_HMAC_SHA384;
421 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_512_256];
422 i->op_id = VNET_CRYPTO_OP_SHA512_HMAC;
423 i->alg = VNET_CRYPTO_ALG_HMAC_SHA512;
426 vec_validate_aligned (im->ptd, vlib_num_workers (), CLIB_CACHE_LINE_BYTES);
428 im->ah4_enc_fq_index =
429 vlib_frame_queue_main_init (ah4_encrypt_node.index, 0);
430 im->ah4_dec_fq_index =
431 vlib_frame_queue_main_init (ah4_decrypt_node.index, 0);
432 im->ah6_enc_fq_index =
433 vlib_frame_queue_main_init (ah6_encrypt_node.index, 0);
434 im->ah6_dec_fq_index =
435 vlib_frame_queue_main_init (ah6_decrypt_node.index, 0);
437 im->esp4_enc_fq_index =
438 vlib_frame_queue_main_init (esp4_encrypt_node.index, 0);
439 im->esp4_dec_fq_index =
440 vlib_frame_queue_main_init (esp4_decrypt_node.index, 0);
441 im->esp6_enc_fq_index =
442 vlib_frame_queue_main_init (esp6_encrypt_node.index, 0);
443 im->esp6_dec_fq_index =
444 vlib_frame_queue_main_init (esp6_decrypt_node.index, 0);
445 im->esp4_enc_tun_fq_index =
446 vlib_frame_queue_main_init (esp4_encrypt_tun_node.index, 0);
447 im->esp6_enc_tun_fq_index =
448 vlib_frame_queue_main_init (esp6_encrypt_tun_node.index, 0);
449 im->esp4_dec_tun_fq_index =
450 vlib_frame_queue_main_init (esp4_decrypt_tun_node.index, 0);
451 im->esp6_dec_tun_fq_index =
452 vlib_frame_queue_main_init (esp6_decrypt_tun_node.index, 0);
457 VLIB_INIT_FUNCTION (ipsec_init);
460 * fd.io coding-style-patch-verification: ON
463 * eval: (c-set-style "gnu")