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 if (sa->integ_alg == IPSEC_INTEG_ALG_NONE)
34 return clib_error_return (0, "unsupported none integ-alg");
39 ipsec_check_esp_support (ipsec_sa_t * sa)
45 ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index, u8 is_add)
47 ipsec_ah_backend_t *ah =
48 pool_elt_at_index (im->ah_backends, im->ah_current_backend);
49 if (ah->add_del_sa_sess_cb)
51 clib_error_t *err = ah->add_del_sa_sess_cb (sa_index, is_add);
55 ipsec_esp_backend_t *esp =
56 pool_elt_at_index (im->esp_backends, im->esp_current_backend);
57 if (esp->add_del_sa_sess_cb)
59 clib_error_t *err = esp->add_del_sa_sess_cb (sa_index, is_add);
67 ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa)
69 clib_error_t *error = 0;
71 if (PREDICT_FALSE (sa->protocol == IPSEC_PROTOCOL_AH))
73 ipsec_ah_backend_t *ah =
74 pool_elt_at_index (im->ah_backends, im->ah_current_backend);
75 ASSERT (ah->check_support_cb);
76 error = ah->check_support_cb (sa);
80 ipsec_esp_backend_t *esp =
81 pool_elt_at_index (im->esp_backends, im->esp_current_backend);
82 ASSERT (esp->check_support_cb);
83 error = esp->check_support_cb (sa);
90 ipsec_add_node (vlib_main_t * vm, const char *node_name,
91 const char *prev_node_name, u32 * out_node_index,
94 vlib_node_t *prev_node, *node;
95 prev_node = vlib_get_node_by_name (vm, (u8 *) prev_node_name);
97 node = vlib_get_node_by_name (vm, (u8 *) node_name);
99 *out_node_index = node->index;
100 *out_next_index = vlib_node_add_next (vm, prev_node->index, node->index);
104 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
106 const char *ah4_encrypt_node_name,
107 const char *ah4_decrypt_node_name,
108 const char *ah6_encrypt_node_name,
109 const char *ah6_decrypt_node_name,
110 check_support_cb_t ah_check_support_cb,
111 add_del_sa_sess_cb_t ah_add_del_sa_sess_cb)
113 ipsec_ah_backend_t *b;
114 pool_get (im->ah_backends, b);
115 b->name = format (0, "%s%c", name, 0);
117 ipsec_add_node (vm, ah4_encrypt_node_name, "ipsec4-output-feature",
118 &b->ah4_encrypt_node_index, &b->ah4_encrypt_next_index);
119 ipsec_add_node (vm, ah4_decrypt_node_name, "ipsec4-input-feature",
120 &b->ah4_decrypt_node_index, &b->ah4_decrypt_next_index);
121 ipsec_add_node (vm, ah6_encrypt_node_name, "ipsec6-output-feature",
122 &b->ah6_encrypt_node_index, &b->ah6_encrypt_next_index);
123 ipsec_add_node (vm, ah6_decrypt_node_name, "ipsec6-input-feature",
124 &b->ah6_decrypt_node_index, &b->ah6_decrypt_next_index);
126 b->check_support_cb = ah_check_support_cb;
127 b->add_del_sa_sess_cb = ah_add_del_sa_sess_cb;
128 return b - im->ah_backends;
132 ipsec_register_esp_backend (vlib_main_t * vm, ipsec_main_t * im,
134 const char *esp4_encrypt_node_name,
135 const char *esp4_decrypt_node_name,
136 const char *esp6_encrypt_node_name,
137 const char *esp6_decrypt_node_name,
138 check_support_cb_t esp_check_support_cb,
139 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb)
141 ipsec_esp_backend_t *b;
142 pool_get (im->esp_backends, b);
143 b->name = format (0, "%s%c", name, 0);
145 ipsec_add_node (vm, esp4_encrypt_node_name, "ipsec4-output-feature",
146 &b->esp4_encrypt_node_index, &b->esp4_encrypt_next_index);
147 ipsec_add_node (vm, esp4_decrypt_node_name, "ipsec4-input-feature",
148 &b->esp4_decrypt_node_index, &b->esp4_decrypt_next_index);
149 ipsec_add_node (vm, esp6_encrypt_node_name, "ipsec6-output-feature",
150 &b->esp6_encrypt_node_index, &b->esp6_encrypt_next_index);
151 ipsec_add_node (vm, esp6_decrypt_node_name, "ipsec6-input-feature",
152 &b->esp6_decrypt_node_index, &b->esp6_decrypt_next_index);
154 b->check_support_cb = esp_check_support_cb;
155 b->add_del_sa_sess_cb = esp_add_del_sa_sess_cb;
156 return b - im->esp_backends;
160 ipsec_sa_restack (ipsec_sa_t * sa, void *ctx)
164 return (WALK_CONTINUE);
168 ipsec_select_ah_backend (ipsec_main_t * im, u32 backend_idx)
170 if (pool_elts (im->sad) > 0
171 || pool_is_free_index (im->ah_backends, backend_idx))
175 ipsec_ah_backend_t *b = pool_elt_at_index (im->ah_backends, backend_idx);
176 im->ah_current_backend = backend_idx;
177 im->ah4_encrypt_node_index = b->ah4_encrypt_node_index;
178 im->ah4_decrypt_node_index = b->ah4_decrypt_node_index;
179 im->ah4_encrypt_next_index = b->ah4_encrypt_next_index;
180 im->ah4_decrypt_next_index = b->ah4_decrypt_next_index;
181 im->ah6_encrypt_node_index = b->ah6_encrypt_node_index;
182 im->ah6_decrypt_node_index = b->ah6_decrypt_node_index;
183 im->ah6_encrypt_next_index = b->ah6_encrypt_next_index;
184 im->ah6_decrypt_next_index = b->ah6_decrypt_next_index;
186 ipsec_sa_walk (ipsec_sa_restack, NULL);
191 ipsec_select_esp_backend (ipsec_main_t * im, u32 backend_idx)
193 if (pool_elts (im->sad) > 0
194 || pool_is_free_index (im->esp_backends, backend_idx))
198 ipsec_esp_backend_t *b = pool_elt_at_index (im->esp_backends, backend_idx);
199 im->esp_current_backend = backend_idx;
200 im->esp4_encrypt_node_index = b->esp4_encrypt_node_index;
201 im->esp4_decrypt_node_index = b->esp4_decrypt_node_index;
202 im->esp4_encrypt_next_index = b->esp4_encrypt_next_index;
203 im->esp4_decrypt_next_index = b->esp4_decrypt_next_index;
204 im->esp6_encrypt_node_index = b->esp6_encrypt_node_index;
205 im->esp6_decrypt_node_index = b->esp6_decrypt_node_index;
206 im->esp6_encrypt_next_index = b->esp6_encrypt_next_index;
207 im->esp6_decrypt_next_index = b->esp6_decrypt_next_index;
209 ipsec_sa_walk (ipsec_sa_restack, NULL);
213 static clib_error_t *
214 ipsec_init (vlib_main_t * vm)
217 ipsec_main_t *im = &ipsec_main;
218 ipsec_main_crypto_alg_t *a;
220 im->vnet_main = vnet_get_main ();
223 im->spd_index_by_spd_id = hash_create (0, sizeof (uword));
224 im->sa_index_by_sa_id = hash_create (0, sizeof (uword));
225 im->spd_index_by_sw_if_index = hash_create (0, sizeof (uword));
227 vlib_node_t *node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
229 im->error_drop_node_index = node->index;
231 u32 idx = ipsec_register_ah_backend (vm, im, "default openssl backend",
236 ipsec_check_ah_support,
239 im->ah_default_backend = idx;
240 int rv = ipsec_select_ah_backend (im, idx);
242 (void) (rv); // avoid warning
244 idx = ipsec_register_esp_backend (vm, im, "default openssl backend",
249 ipsec_check_esp_support, NULL);
250 im->esp_default_backend = idx;
252 rv = ipsec_select_esp_backend (im, idx);
254 (void) (rv); // avoid warning
256 if ((error = vlib_call_init_function (vm, ipsec_cli_init)))
259 if ((error = vlib_call_init_function (vm, ipsec_tunnel_if_init)))
262 vec_validate (im->crypto_algs, IPSEC_CRYPTO_N_ALG - 1);
264 a = im->crypto_algs + IPSEC_CRYPTO_ALG_DES_CBC;
265 a->enc_op_id = VNET_CRYPTO_OP_DES_CBC_ENC;
266 a->dec_op_id = VNET_CRYPTO_OP_DES_CBC_DEC;
267 a->iv_size = a->block_size = 8;
269 a = im->crypto_algs + IPSEC_CRYPTO_ALG_3DES_CBC;
270 a->enc_op_id = VNET_CRYPTO_OP_3DES_CBC_ENC;
271 a->dec_op_id = VNET_CRYPTO_OP_3DES_CBC_DEC;
272 a->iv_size = a->block_size = 8;
274 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_128;
275 a->enc_op_id = VNET_CRYPTO_OP_AES_128_CBC_ENC;
276 a->dec_op_id = VNET_CRYPTO_OP_AES_128_CBC_DEC;
277 a->iv_size = a->block_size = 16;
279 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_192;
280 a->enc_op_id = VNET_CRYPTO_OP_AES_192_CBC_ENC;
281 a->dec_op_id = VNET_CRYPTO_OP_AES_192_CBC_DEC;
282 a->iv_size = a->block_size = 16;
284 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_CBC_256;
285 a->enc_op_id = VNET_CRYPTO_OP_AES_256_CBC_ENC;
286 a->dec_op_id = VNET_CRYPTO_OP_AES_256_CBC_DEC;
287 a->iv_size = a->block_size = 16;
289 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_128;
290 a->enc_op_id = VNET_CRYPTO_OP_AES_128_GCM_ENC;
291 a->dec_op_id = VNET_CRYPTO_OP_AES_128_GCM_DEC;
292 a->iv_size = a->block_size = 8;
295 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_192;
296 a->enc_op_id = VNET_CRYPTO_OP_AES_192_GCM_ENC;
297 a->dec_op_id = VNET_CRYPTO_OP_AES_192_GCM_DEC;
298 a->iv_size = a->block_size = 8;
301 a = im->crypto_algs + IPSEC_CRYPTO_ALG_AES_GCM_256;
302 a->enc_op_id = VNET_CRYPTO_OP_AES_256_GCM_ENC;
303 a->dec_op_id = VNET_CRYPTO_OP_AES_256_GCM_DEC;
304 a->iv_size = a->block_size = 8;
307 vec_validate (im->integ_algs, IPSEC_INTEG_N_ALG - 1);
308 ipsec_main_integ_alg_t *i;
310 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA1_96];
311 i->op_id = VNET_CRYPTO_OP_SHA1_HMAC;
314 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_256_96];
315 i->op_id = VNET_CRYPTO_OP_SHA1_HMAC;
318 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_256_128];
319 i->op_id = VNET_CRYPTO_OP_SHA256_HMAC;
322 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_384_192];
323 i->op_id = VNET_CRYPTO_OP_SHA384_HMAC;
326 i = &im->integ_algs[IPSEC_INTEG_ALG_SHA_512_256];
327 i->op_id = VNET_CRYPTO_OP_SHA512_HMAC;
330 vec_validate_aligned (im->ptd, vlib_num_workers (), CLIB_CACHE_LINE_BYTES);
335 VLIB_INIT_FUNCTION (ipsec_init);
338 * fd.io coding-style-patch-verification: ON
341 * eval: (c-set-style "gnu")