2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 #include <vnet/ip/ip.h>
19 #include <vnet/feature/feature.h>
21 #define IPSEC_FLAG_IPSEC_GRE_TUNNEL (1 << 0)
23 #define foreach_ipsec_output_next \
24 _ (DROP, "error-drop") \
25 _ (ESP4_ENCRYPT, "esp4-encrypt") \
26 _ (AH4_ENCRYPT, "ah4-encrypt") \
27 _ (ESP6_ENCRYPT, "esp6-encrypt") \
28 _ (AH6_ENCRYPT, "ah6-encrypt")
30 #define _(v, s) IPSEC_OUTPUT_NEXT_##v,
33 foreach_ipsec_output_next
36 } ipsec_output_next_t;
38 #define foreach_ipsec_input_next \
39 _ (DROP, "error-drop") \
40 _ (ESP4_DECRYPT, "esp4-decrypt") \
41 _ (AH4_DECRYPT, "ah4-decrypt") \
42 _ (ESP6_DECRYPT, "esp6-decrypt") \
43 _ (AH6_DECRYPT, "ah6-decrypt")
45 #define _(v, s) IPSEC_INPUT_NEXT_##v,
48 foreach_ipsec_input_next
53 #define foreach_ipsec_policy_action \
54 _ (0, BYPASS, "bypass") \
55 _ (1, DISCARD, "discard") \
56 _ (2, RESOLVE, "resolve") \
57 _ (3, PROTECT, "protect")
61 #define _(v, f, s) IPSEC_POLICY_ACTION_##f = v,
62 foreach_ipsec_policy_action
64 IPSEC_POLICY_N_ACTION,
65 } ipsec_policy_action_t;
67 #define foreach_ipsec_crypto_alg \
69 _ (1, AES_CBC_128, "aes-cbc-128") \
70 _ (2, AES_CBC_192, "aes-cbc-192") \
71 _ (3, AES_CBC_256, "aes-cbc-256") \
72 _ (4, AES_CTR_128, "aes-ctr-128") \
73 _ (5, AES_CTR_192, "aes-ctr-192") \
74 _ (6, AES_CTR_256, "aes-ctr-256") \
75 _ (7, AES_GCM_128, "aes-gcm-128") \
76 _ (8, AES_GCM_192, "aes-gcm-192") \
77 _ (9, AES_GCM_256, "aes-gcm-256") \
78 _ (10, DES_CBC, "des-cbc") \
79 _ (11, 3DES_CBC, "3des-cbc")
83 #define _(v, f, s) IPSEC_CRYPTO_ALG_##f = v,
84 foreach_ipsec_crypto_alg
89 #define foreach_ipsec_integ_alg \
91 _ (1, MD5_96, "md5-96") /* RFC2403 */ \
92 _ (2, SHA1_96, "sha1-96") /* RFC2404 */ \
93 _ (3, SHA_256_96, "sha-256-96") /* draft-ietf-ipsec-ciph-sha-256-00 */ \
94 _ (4, SHA_256_128, "sha-256-128") /* RFC4868 */ \
95 _ (5, SHA_384_192, "sha-384-192") /* RFC4868 */ \
96 _ (6, SHA_512_256, "sha-512-256") /* RFC4868 */
100 #define _(v, f, s) IPSEC_INTEG_ALG_##f = v,
101 foreach_ipsec_integ_alg
108 IPSEC_PROTOCOL_AH = 0,
109 IPSEC_PROTOCOL_ESP = 1
116 ipsec_protocol_t protocol;
118 ipsec_crypto_alg_t crypto_alg;
122 ipsec_integ_alg_t integ_alg;
132 ip46_address_t tunnel_src_addr;
133 ip46_address_t tunnel_dst_addr;
150 ip46_address_t start, stop;
151 } ip46_address_range_t;
163 ip4_address_t local_ip, remote_ip;
166 ipsec_crypto_alg_t crypto_alg;
167 u8 local_crypto_key_len;
168 u8 local_crypto_key[128];
169 u8 remote_crypto_key_len;
170 u8 remote_crypto_key[128];
171 ipsec_integ_alg_t integ_alg;
172 u8 local_integ_key_len;
173 u8 local_integ_key[128];
174 u8 remote_integ_key_len;
175 u8 remote_integ_key[128];
179 } ipsec_add_del_tunnel_args_t;
186 ip4_address_t local_ip;
187 ip4_address_t remote_ip;
188 } ipsec_add_del_ipsec_gre_tunnel_args_t;
192 IPSEC_IF_SET_KEY_TYPE_NONE,
193 IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO,
194 IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO,
195 IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG,
196 IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG,
197 } ipsec_if_set_key_type_t;
207 ip46_address_range_t laddr;
208 ip46_address_range_t raddr;
219 vlib_counter_t counter;
225 /* pool of policies */
226 ipsec_policy_t *policies;
227 /* vectors of policy indices */
228 u32 *ipv4_outbound_policies;
229 u32 *ipv6_outbound_policies;
230 u32 *ipv4_inbound_protect_policy_indices;
231 u32 *ipv4_inbound_policy_discard_and_bypass_indices;
232 u32 *ipv6_inbound_protect_policy_indices;
233 u32 *ipv6_inbound_policy_discard_and_bypass_indices;
239 } ip4_ipsec_config_t;
244 } ip6_ipsec_config_t;
248 /* Required for pool_get_aligned */
249 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
256 typedef clib_error_t *(*add_del_sa_sess_cb_t) (u32 sa_index, u8 is_add);
257 typedef clib_error_t *(*check_support_cb_t) (ipsec_sa_t * sa);
262 /* add/del callback */
263 add_del_sa_sess_cb_t add_del_sa_sess_cb;
264 /* check support function */
265 check_support_cb_t check_support_cb;
266 u32 ah4_encrypt_node_index;
267 u32 ah4_decrypt_node_index;
268 u32 ah4_encrypt_next_index;
269 u32 ah4_decrypt_next_index;
270 u32 ah6_encrypt_node_index;
271 u32 ah6_decrypt_node_index;
272 u32 ah6_encrypt_next_index;
273 u32 ah6_decrypt_next_index;
274 } ipsec_ah_backend_t;
279 /* add/del callback */
280 add_del_sa_sess_cb_t add_del_sa_sess_cb;
281 /* check support function */
282 check_support_cb_t check_support_cb;
283 u32 esp4_encrypt_node_index;
284 u32 esp4_decrypt_node_index;
285 u32 esp4_encrypt_next_index;
286 u32 esp4_decrypt_next_index;
287 u32 esp6_encrypt_node_index;
288 u32 esp6_decrypt_node_index;
289 u32 esp6_encrypt_next_index;
290 u32 esp6_decrypt_next_index;
291 } ipsec_esp_backend_t;
295 /* pool of tunnel instances */
299 /* pool of tunnel interfaces */
300 ipsec_tunnel_if_t *tunnel_interfaces;
301 u32 *free_tunnel_if_indices;
305 uword *tunnel_index_by_key;
308 vlib_main_t *vlib_main;
309 vnet_main_t *vnet_main;
311 /* next node indices */
312 u32 feature_next_node_index[32];
315 uword *spd_index_by_spd_id;
316 uword *spd_index_by_sw_if_index;
317 uword *sa_index_by_sa_id;
318 uword *ipsec_if_pool_index_by_key;
319 uword *ipsec_if_real_dev_by_show_dev;
322 u32 error_drop_node_index;
323 u32 esp4_encrypt_node_index;
324 u32 esp4_decrypt_node_index;
325 u32 ah4_encrypt_node_index;
326 u32 ah4_decrypt_node_index;
327 u32 esp6_encrypt_node_index;
328 u32 esp6_decrypt_node_index;
329 u32 ah6_encrypt_node_index;
330 u32 ah6_decrypt_node_index;
331 /* next node indices */
332 u32 esp4_encrypt_next_index;
333 u32 esp4_decrypt_next_index;
334 u32 ah4_encrypt_next_index;
335 u32 ah4_decrypt_next_index;
336 u32 esp6_encrypt_next_index;
337 u32 esp6_decrypt_next_index;
338 u32 ah6_encrypt_next_index;
339 u32 ah6_decrypt_next_index;
341 /* pool of ah backends */
342 ipsec_ah_backend_t *ah_backends;
343 /* pool of esp backends */
344 ipsec_esp_backend_t *esp_backends;
345 /* index of current ah backend */
346 u32 ah_current_backend;
347 /* index of current esp backend */
348 u32 esp_current_backend;
349 /* index of default ah backend */
350 u32 ah_default_backend;
351 /* index of default esp backend */
352 u32 esp_default_backend;
354 /* helper for sort function */
355 ipsec_spd_t *spd_to_sort;
358 extern ipsec_main_t ipsec_main;
360 clib_error_t *ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index,
363 clib_error_t *ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa);
365 extern vlib_node_registration_t esp4_encrypt_node;
366 extern vlib_node_registration_t esp4_decrypt_node;
367 extern vlib_node_registration_t ah4_encrypt_node;
368 extern vlib_node_registration_t ah4_decrypt_node;
369 extern vlib_node_registration_t esp6_encrypt_node;
370 extern vlib_node_registration_t esp6_decrypt_node;
371 extern vlib_node_registration_t ah6_encrypt_node;
372 extern vlib_node_registration_t ah6_decrypt_node;
373 extern vlib_node_registration_t ipsec_if_input_node;
378 int ipsec_set_interface_spd (vlib_main_t * vm, u32 sw_if_index, u32 spd_id,
380 int ipsec_add_del_spd (vlib_main_t * vm, u32 spd_id, int is_add);
381 int ipsec_add_del_policy (vlib_main_t * vm, ipsec_policy_t * policy,
383 int ipsec_add_del_sa (vlib_main_t * vm, ipsec_sa_t * new_sa, int is_add);
384 int ipsec_set_sa_key (vlib_main_t * vm, ipsec_sa_t * sa_update);
386 u32 ipsec_get_sa_index_by_sa_id (u32 sa_id);
387 u8 ipsec_is_sa_used (u32 sa_index);
388 u8 *format_ipsec_policy_action (u8 * s, va_list * args);
389 u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
390 u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
391 u8 *format_ipsec_replay_window (u8 * s, va_list * args);
392 uword unformat_ipsec_policy_action (unformat_input_t * input, va_list * args);
393 uword unformat_ipsec_crypto_alg (unformat_input_t * input, va_list * args);
394 uword unformat_ipsec_integ_alg (unformat_input_t * input, va_list * args);
396 int ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
397 ipsec_add_del_tunnel_args_t * args,
399 int ipsec_add_del_tunnel_if (ipsec_add_del_tunnel_args_t * args);
400 int ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
401 ipsec_add_del_ipsec_gre_tunnel_args_t *
403 int ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
404 ipsec_if_set_key_type_t type, u8 alg, u8 * key);
405 int ipsec_set_interface_sa (vnet_main_t * vnm, u32 hw_if_index, u32 sa_id,
413 ipsec_alloc_empty_buffers (vlib_main_t * vm, ipsec_main_t * im)
415 u32 thread_index = vm->thread_index;
416 uword l = vec_len (im->empty_buffers[thread_index]);
419 if (PREDICT_FALSE (l < VLIB_FRAME_SIZE))
421 if (!im->empty_buffers[thread_index])
423 vec_alloc (im->empty_buffers[thread_index], 2 * VLIB_FRAME_SIZE);
426 n_alloc = vlib_buffer_alloc (vm, im->empty_buffers[thread_index] + l,
427 2 * VLIB_FRAME_SIZE - l);
429 _vec_len (im->empty_buffers[thread_index]) = l + n_alloc;
433 static_always_inline u32
434 get_next_output_feature_node_index (vlib_buffer_t * b,
435 vlib_node_runtime_t * nr)
438 vlib_main_t *vm = vlib_get_main ();
439 vlib_node_t *node = vlib_get_node (vm, nr->node_index);
441 vnet_feature_next (&next, b);
442 return node->next_nodes[next];
445 u32 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
447 const char *ah4_encrypt_node_name,
448 const char *ah4_decrypt_node_name,
449 const char *ah6_encrypt_node_name,
450 const char *ah6_decrypt_node_name,
451 check_support_cb_t ah_check_support_cb,
452 add_del_sa_sess_cb_t ah_add_del_sa_sess_cb);
454 u32 ipsec_register_esp_backend (vlib_main_t * vm, ipsec_main_t * im,
456 const char *esp4_encrypt_node_name,
457 const char *esp4_decrypt_node_name,
458 const char *esp6_encrypt_node_name,
459 const char *esp6_decrypt_node_name,
460 check_support_cb_t esp_check_support_cb,
461 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb);
463 int ipsec_select_ah_backend (ipsec_main_t * im, u32 ah_backend_idx);
464 int ipsec_select_esp_backend (ipsec_main_t * im, u32 esp_backend_idx);
465 #endif /* __IPSEC_H__ */
468 * fd.io coding-style-patch-verification: ON
471 * eval: (c-set-style "gnu")