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.
16 #include <vnet/ipsec/ipsec.h>
17 #include <vnet/ipsec/esp.h>
18 #include <vnet/udp/udp.h>
19 #include <vnet/fib/fib_table.h>
20 #include <vnet/fib/fib_entry_track.h>
21 #include <vnet/ipsec/ipsec_tun.h>
25 * SA packet & bytes counters
27 vlib_combined_counter_main_t ipsec_sa_counters = {
29 .stat_segment_name = "/net/ipsec/sa",
34 ipsec_call_add_del_callbacks (ipsec_main_t * im, ipsec_sa_t * sa,
35 u32 sa_index, int is_add)
37 ipsec_ah_backend_t *ab;
38 ipsec_esp_backend_t *eb;
41 case IPSEC_PROTOCOL_AH:
42 ab = pool_elt_at_index (im->ah_backends, im->ah_current_backend);
43 if (ab->add_del_sa_sess_cb)
44 return ab->add_del_sa_sess_cb (sa_index, is_add);
46 case IPSEC_PROTOCOL_ESP:
47 eb = pool_elt_at_index (im->esp_backends, im->esp_current_backend);
48 if (eb->add_del_sa_sess_cb)
49 return eb->add_del_sa_sess_cb (sa_index, is_add);
56 ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len)
58 memset (key, 0, sizeof (*key));
60 if (len > sizeof (key->data))
61 key->len = sizeof (key->data);
65 memcpy (key->data, data, key->len);
69 * 'stack' (resolve the recursion for) the SA tunnel destination
72 ipsec_sa_stack (ipsec_sa_t * sa)
74 ipsec_main_t *im = &ipsec_main;
75 fib_forward_chain_type_t fct;
76 dpo_id_t tmp = DPO_INVALID;
79 fib_forw_chain_type_from_fib_proto ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
83 fib_entry_contribute_forwarding (sa->fib_entry_index, fct, &tmp);
85 if (IPSEC_PROTOCOL_AH == sa->protocol)
86 dpo_stack_from_node ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
87 im->ah6_encrypt_node_index :
88 im->ah4_encrypt_node_index), &sa->dpo, &tmp);
90 dpo_stack_from_node ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
91 im->esp6_encrypt_node_index :
92 im->esp4_encrypt_node_index), &sa->dpo, &tmp);
97 ipsec_sa_set_crypto_alg (ipsec_sa_t * sa, ipsec_crypto_alg_t crypto_alg)
99 ipsec_main_t *im = &ipsec_main;
100 sa->crypto_alg = crypto_alg;
101 sa->crypto_iv_size = im->crypto_algs[crypto_alg].iv_size;
102 sa->esp_block_align = clib_max (4, im->crypto_algs[crypto_alg].block_align);
103 sa->sync_op_data.crypto_enc_op_id = im->crypto_algs[crypto_alg].enc_op_id;
104 sa->sync_op_data.crypto_dec_op_id = im->crypto_algs[crypto_alg].dec_op_id;
105 sa->crypto_calg = im->crypto_algs[crypto_alg].alg;
106 ASSERT (sa->crypto_iv_size <= ESP_MAX_IV_SIZE);
107 ASSERT (sa->esp_block_align <= ESP_MAX_BLOCK_SIZE);
108 if (IPSEC_CRYPTO_ALG_IS_GCM (crypto_alg))
110 sa->integ_icv_size = im->crypto_algs[crypto_alg].icv_size;
111 ipsec_sa_set_IS_AEAD (sa);
116 ipsec_sa_set_integ_alg (ipsec_sa_t * sa, ipsec_integ_alg_t integ_alg)
118 ipsec_main_t *im = &ipsec_main;
119 sa->integ_alg = integ_alg;
120 sa->integ_icv_size = im->integ_algs[integ_alg].icv_size;
121 sa->sync_op_data.integ_op_id = im->integ_algs[integ_alg].op_id;
122 sa->integ_calg = im->integ_algs[integ_alg].alg;
123 ASSERT (sa->integ_icv_size <= ESP_MAX_ICV_SIZE);
127 ipsec_sa_set_async_op_ids (ipsec_sa_t * sa)
130 if (ipsec_sa_is_set_USE_ESN (sa))
133 if( sa->sync_op_data.crypto_enc_op_id == VNET_CRYPTO_OP_##n##_ENC ) \
134 sa->async_op_data.crypto_async_enc_op_id = \
135 VNET_CRYPTO_OP_##n##_TAG16_AAD12_ENC; \
136 if( sa->sync_op_data.crypto_dec_op_id == VNET_CRYPTO_OP_##n##_DEC ) \
137 sa->async_op_data.crypto_async_dec_op_id = \
138 VNET_CRYPTO_OP_##n##_TAG16_AAD12_DEC;
139 foreach_crypto_aead_alg
145 if( sa->sync_op_data.crypto_enc_op_id == VNET_CRYPTO_OP_##n##_ENC ) \
146 sa->async_op_data.crypto_async_enc_op_id = \
147 VNET_CRYPTO_OP_##n##_TAG16_AAD8_ENC; \
148 if( sa->sync_op_data.crypto_dec_op_id == VNET_CRYPTO_OP_##n##_DEC ) \
149 sa->async_op_data.crypto_async_dec_op_id = \
150 VNET_CRYPTO_OP_##n##_TAG16_AAD8_DEC;
151 foreach_crypto_aead_alg
155 #define _(c, h, s, k ,d) \
156 if( sa->sync_op_data.crypto_enc_op_id == VNET_CRYPTO_OP_##c##_ENC && \
157 sa->sync_op_data.integ_op_id == VNET_CRYPTO_OP_##h##_HMAC) \
158 sa->async_op_data.crypto_async_enc_op_id = \
159 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_ENC; \
160 if( sa->sync_op_data.crypto_dec_op_id == VNET_CRYPTO_OP_##c##_DEC && \
161 sa->sync_op_data.integ_op_id == VNET_CRYPTO_OP_##h##_HMAC) \
162 sa->async_op_data.crypto_async_dec_op_id = \
163 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_DEC;
164 foreach_crypto_link_async_alg
170 ipsec_sa_add_and_lock (u32 id,
172 ipsec_protocol_t proto,
173 ipsec_crypto_alg_t crypto_alg,
174 const ipsec_key_t * ck,
175 ipsec_integ_alg_t integ_alg,
176 const ipsec_key_t * ik,
177 ipsec_sa_flags_t flags,
180 const ip46_address_t * tun_src,
181 const ip46_address_t * tun_dst, u32 * sa_out_index,
182 u16 src_port, u16 dst_port)
184 vlib_main_t *vm = vlib_get_main ();
185 ipsec_main_t *im = &ipsec_main;
191 p = hash_get (im->sa_index_by_sa_id, id);
193 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
195 pool_get_aligned_zero (im->sad, sa, CLIB_CACHE_LINE_BYTES);
197 fib_node_init (&sa->node, FIB_NODE_TYPE_IPSEC_SA);
198 fib_node_lock (&sa->node);
199 sa_index = sa - im->sad;
201 vlib_validate_combined_counter (&ipsec_sa_counters, sa_index);
202 vlib_zero_combined_counter (&ipsec_sa_counters, sa_index);
206 sa->stat_index = sa_index;
207 sa->protocol = proto;
210 sa->encrypt_thread_index = (vlib_num_workers ())? ~0 : 0;
211 sa->decrypt_thread_index = (vlib_num_workers ())? ~0 : 0;
212 if (integ_alg != IPSEC_INTEG_ALG_NONE)
214 ipsec_sa_set_integ_alg (sa, integ_alg);
215 clib_memcpy (&sa->integ_key, ik, sizeof (sa->integ_key));
217 ipsec_sa_set_crypto_alg (sa, crypto_alg);
218 ipsec_sa_set_async_op_ids (sa);
220 clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
221 ip46_address_copy (&sa->tunnel_src_addr, tun_src);
222 ip46_address_copy (&sa->tunnel_dst_addr, tun_dst);
224 sa->crypto_key_index = vnet_crypto_key_add (vm,
225 im->crypto_algs[crypto_alg].alg,
226 (u8 *) ck->data, ck->len);
227 if (~0 == sa->crypto_key_index)
229 pool_put (im->sad, sa);
230 return VNET_API_ERROR_KEY_LENGTH;
233 if (integ_alg != IPSEC_INTEG_ALG_NONE)
235 sa->integ_key_index = vnet_crypto_key_add (vm,
237 integ_algs[integ_alg].alg,
238 (u8 *) ik->data, ik->len);
239 if (~0 == sa->integ_key_index)
241 pool_put (im->sad, sa);
242 return VNET_API_ERROR_KEY_LENGTH;
246 if (sa->async_op_data.crypto_async_enc_op_id &&
247 !ipsec_sa_is_set_IS_AEAD (sa))
249 sa->async_op_data.linked_key_index =
250 vnet_crypto_key_add_linked (vm, sa->crypto_key_index,
251 sa->integ_key_index);
255 sa->crypto_op_data = sa->async_op_data.data;
257 sa->crypto_op_data = sa->sync_op_data.data;
259 err = ipsec_check_support_cb (im, sa);
262 clib_warning ("%s", err->what);
263 pool_put (im->sad, sa);
264 return VNET_API_ERROR_UNIMPLEMENTED;
267 err = ipsec_call_add_del_callbacks (im, sa, sa_index, 1);
270 pool_put (im->sad, sa);
271 return VNET_API_ERROR_SYSCALL_ERROR_1;
274 if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
276 fib_protocol_t fproto = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
277 FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4);
279 .fp_addr = sa->tunnel_dst_addr,
280 .fp_len = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ? 128 : 32),
283 sa->tx_fib_index = fib_table_find (fproto, tx_table_id);
284 if (sa->tx_fib_index == ~((u32) 0))
286 pool_put (im->sad, sa);
287 return VNET_API_ERROR_NO_SUCH_FIB;
290 sa->fib_entry_index = fib_entry_track (sa->tx_fib_index,
292 FIB_NODE_TYPE_IPSEC_SA,
293 sa_index, &sa->sibling);
296 /* generate header templates */
297 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
299 sa->ip6_hdr.ip_version_traffic_class_and_flow_label = 0x60;
300 sa->ip6_hdr.hop_limit = 254;
301 sa->ip6_hdr.src_address.as_u64[0] =
302 sa->tunnel_src_addr.ip6.as_u64[0];
303 sa->ip6_hdr.src_address.as_u64[1] =
304 sa->tunnel_src_addr.ip6.as_u64[1];
305 sa->ip6_hdr.dst_address.as_u64[0] =
306 sa->tunnel_dst_addr.ip6.as_u64[0];
307 sa->ip6_hdr.dst_address.as_u64[1] =
308 sa->tunnel_dst_addr.ip6.as_u64[1];
309 if (ipsec_sa_is_set_UDP_ENCAP (sa))
310 sa->ip6_hdr.protocol = IP_PROTOCOL_UDP;
312 sa->ip6_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
316 sa->ip4_hdr.ip_version_and_header_length = 0x45;
317 sa->ip4_hdr.ttl = 254;
318 sa->ip4_hdr.src_address.as_u32 = sa->tunnel_src_addr.ip4.as_u32;
319 sa->ip4_hdr.dst_address.as_u32 = sa->tunnel_dst_addr.ip4.as_u32;
321 if (ipsec_sa_is_set_UDP_ENCAP (sa))
322 sa->ip4_hdr.protocol = IP_PROTOCOL_UDP;
324 sa->ip4_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
325 sa->ip4_hdr.checksum = ip4_header_checksum (&sa->ip4_hdr);
329 if (ipsec_sa_is_set_UDP_ENCAP (sa))
331 if (dst_port == IPSEC_UDP_PORT_NONE)
332 sa->udp_hdr.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
334 sa->udp_hdr.dst_port = clib_host_to_net_u16 (dst_port);
336 if (src_port == IPSEC_UDP_PORT_NONE)
337 sa->udp_hdr.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
339 sa->udp_hdr.src_port = clib_host_to_net_u16 (src_port);
341 if (ipsec_sa_is_set_IS_INBOUND (sa))
342 ipsec_register_udp_port (clib_host_to_net_u16 (sa->udp_hdr.dst_port));
345 hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
348 *sa_out_index = sa_index;
354 ipsec_sa_del (ipsec_sa_t * sa)
356 vlib_main_t *vm = vlib_get_main ();
357 ipsec_main_t *im = &ipsec_main;
360 sa_index = sa - im->sad;
361 hash_unset (im->sa_index_by_sa_id, sa->id);
363 /* no recovery possible when deleting an SA */
364 (void) ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
366 if (ipsec_sa_is_set_UDP_ENCAP (sa) && ipsec_sa_is_set_IS_INBOUND (sa))
367 ipsec_unregister_udp_port (clib_net_to_host_u16 (sa->udp_hdr.dst_port));
369 if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
371 fib_entry_untrack (sa->fib_entry_index, sa->sibling);
372 dpo_reset (&sa->dpo);
374 vnet_crypto_key_del (vm, sa->crypto_key_index);
375 if (sa->integ_alg != IPSEC_INTEG_ALG_NONE)
376 vnet_crypto_key_del (vm, sa->integ_key_index);
377 pool_put (im->sad, sa);
381 ipsec_sa_unlock (index_t sai)
383 ipsec_main_t *im = &ipsec_main;
386 if (INDEX_INVALID == sai)
389 sa = pool_elt_at_index (im->sad, sai);
391 fib_node_unlock (&sa->node);
395 ipsec_sa_lock (index_t sai)
397 ipsec_main_t *im = &ipsec_main;
400 if (INDEX_INVALID == sai)
403 sa = pool_elt_at_index (im->sad, sai);
405 fib_node_lock (&sa->node);
409 ipsec_sa_find_and_lock (u32 id)
411 ipsec_main_t *im = &ipsec_main;
415 p = hash_get (im->sa_index_by_sa_id, id);
418 return INDEX_INVALID;
420 sa = pool_elt_at_index (im->sad, p[0]);
422 fib_node_lock (&sa->node);
428 ipsec_sa_unlock_id (u32 id)
430 ipsec_main_t *im = &ipsec_main;
433 p = hash_get (im->sa_index_by_sa_id, id);
436 return VNET_API_ERROR_NO_SUCH_ENTRY;
438 ipsec_sa_unlock (p[0]);
444 ipsec_sa_clear (index_t sai)
446 vlib_zero_combined_counter (&ipsec_sa_counters, sai);
450 ipsec_sa_walk (ipsec_sa_walk_cb_t cb, void *ctx)
452 ipsec_main_t *im = &ipsec_main;
456 pool_foreach (sa, im->sad,
458 if (WALK_CONTINUE != cb(sa, ctx))
465 * Function definition to get a FIB node from its index
468 ipsec_sa_fib_node_get (fib_node_index_t index)
474 sa = pool_elt_at_index (im->sad, index);
480 ipsec_sa_from_fib_node (fib_node_t * node)
482 ASSERT (FIB_NODE_TYPE_IPSEC_SA == node->fn_type);
483 return ((ipsec_sa_t *) (((char *) node) -
484 STRUCT_OFFSET_OF (ipsec_sa_t, node)));
489 * Function definition to inform the FIB node that its last lock has gone.
492 ipsec_sa_last_lock_gone (fib_node_t * node)
495 * The ipsec SA is a root of the graph. As such
496 * it never has children and thus is never locked.
498 ipsec_sa_del (ipsec_sa_from_fib_node (node));
502 * Function definition to backwalk a FIB node
504 static fib_node_back_walk_rc_t
505 ipsec_sa_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
507 ipsec_sa_stack (ipsec_sa_from_fib_node (node));
509 return (FIB_NODE_BACK_WALK_CONTINUE);
513 * Virtual function table registered by SAs
514 * for participation in the FIB object graph.
516 const static fib_node_vft_t ipsec_sa_vft = {
517 .fnv_get = ipsec_sa_fib_node_get,
518 .fnv_last_lock = ipsec_sa_last_lock_gone,
519 .fnv_back_walk = ipsec_sa_back_walk,
522 /* force inclusion from application's main.c */
524 ipsec_sa_interface_init (vlib_main_t * vm)
526 fib_node_register_type (FIB_NODE_TYPE_IPSEC_SA, &ipsec_sa_vft);
531 VLIB_INIT_FUNCTION (ipsec_sa_interface_init);
534 * fd.io coding-style-patch-verification: ON
537 * eval: (c-set-style "gnu")