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->crypto_block_size = im->crypto_algs[crypto_alg].block_size;
103 sa->crypto_enc_op_id = im->crypto_algs[crypto_alg].enc_op_id;
104 sa->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->crypto_block_size <= 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->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_add_and_lock (u32 id,
129 ipsec_protocol_t proto,
130 ipsec_crypto_alg_t crypto_alg,
131 const ipsec_key_t * ck,
132 ipsec_integ_alg_t integ_alg,
133 const ipsec_key_t * ik,
134 ipsec_sa_flags_t flags,
137 const ip46_address_t * tun_src,
138 const ip46_address_t * tun_dst, u32 * sa_out_index,
141 vlib_main_t *vm = vlib_get_main ();
142 ipsec_main_t *im = &ipsec_main;
148 p = hash_get (im->sa_index_by_sa_id, id);
150 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
152 pool_get_aligned_zero (im->sad, sa, CLIB_CACHE_LINE_BYTES);
154 fib_node_init (&sa->node, FIB_NODE_TYPE_IPSEC_SA);
155 fib_node_lock (&sa->node);
156 sa_index = sa - im->sad;
158 vlib_validate_combined_counter (&ipsec_sa_counters, sa_index);
159 vlib_zero_combined_counter (&ipsec_sa_counters, sa_index);
163 sa->stat_index = sa_index;
164 sa->protocol = proto;
167 sa->encrypt_thread_index = (vlib_num_workers ())? ~0 : 0;
168 sa->decrypt_thread_index = (vlib_num_workers ())? ~0 : 0;
169 if (integ_alg != IPSEC_INTEG_ALG_NONE)
171 ipsec_sa_set_integ_alg (sa, integ_alg);
172 clib_memcpy (&sa->integ_key, ik, sizeof (sa->integ_key));
174 ipsec_sa_set_crypto_alg (sa, crypto_alg);
175 clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
176 ip46_address_copy (&sa->tunnel_src_addr, tun_src);
177 ip46_address_copy (&sa->tunnel_dst_addr, tun_dst);
179 sa->crypto_key_index = vnet_crypto_key_add (vm,
180 im->crypto_algs[crypto_alg].alg,
181 (u8 *) ck->data, ck->len);
182 if (~0 == sa->crypto_key_index)
184 pool_put (im->sad, sa);
185 return VNET_API_ERROR_KEY_LENGTH;
188 if (integ_alg != IPSEC_INTEG_ALG_NONE)
190 sa->integ_key_index = vnet_crypto_key_add (vm,
192 integ_algs[integ_alg].alg,
193 (u8 *) ik->data, ik->len);
194 if (~0 == sa->integ_key_index)
196 pool_put (im->sad, sa);
197 return VNET_API_ERROR_KEY_LENGTH;
201 err = ipsec_check_support_cb (im, sa);
204 clib_warning ("%s", err->what);
205 pool_put (im->sad, sa);
206 return VNET_API_ERROR_UNIMPLEMENTED;
209 err = ipsec_call_add_del_callbacks (im, sa, sa_index, 1);
212 pool_put (im->sad, sa);
213 return VNET_API_ERROR_SYSCALL_ERROR_1;
216 if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
218 fib_protocol_t fproto = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
219 FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4);
221 .fp_addr = sa->tunnel_dst_addr,
222 .fp_len = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ? 128 : 32),
225 sa->tx_fib_index = fib_table_find (fproto, tx_table_id);
226 if (sa->tx_fib_index == ~((u32) 0))
228 pool_put (im->sad, sa);
229 return VNET_API_ERROR_NO_SUCH_FIB;
232 sa->fib_entry_index = fib_entry_track (sa->tx_fib_index,
234 FIB_NODE_TYPE_IPSEC_SA,
235 sa_index, &sa->sibling);
238 /* generate header templates */
239 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
241 sa->ip6_hdr.ip_version_traffic_class_and_flow_label = 0x60;
242 sa->ip6_hdr.hop_limit = 254;
243 sa->ip6_hdr.src_address.as_u64[0] =
244 sa->tunnel_src_addr.ip6.as_u64[0];
245 sa->ip6_hdr.src_address.as_u64[1] =
246 sa->tunnel_src_addr.ip6.as_u64[1];
247 sa->ip6_hdr.dst_address.as_u64[0] =
248 sa->tunnel_dst_addr.ip6.as_u64[0];
249 sa->ip6_hdr.dst_address.as_u64[1] =
250 sa->tunnel_dst_addr.ip6.as_u64[1];
251 if (ipsec_sa_is_set_UDP_ENCAP (sa))
252 sa->ip6_hdr.protocol = IP_PROTOCOL_UDP;
254 sa->ip6_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
258 sa->ip4_hdr.ip_version_and_header_length = 0x45;
259 sa->ip4_hdr.ttl = 254;
260 sa->ip4_hdr.src_address.as_u32 = sa->tunnel_src_addr.ip4.as_u32;
261 sa->ip4_hdr.dst_address.as_u32 = sa->tunnel_dst_addr.ip4.as_u32;
263 if (ipsec_sa_is_set_UDP_ENCAP (sa))
264 sa->ip4_hdr.protocol = IP_PROTOCOL_UDP;
266 sa->ip4_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
267 sa->ip4_hdr.checksum = ip4_header_checksum (&sa->ip4_hdr);
271 if (ipsec_sa_is_set_UDP_ENCAP (sa))
273 if (dst_port == IPSEC_UDP_PORT_NONE)
275 sa->udp_hdr.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
276 sa->udp_hdr.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
280 sa->udp_hdr.src_port = clib_host_to_net_u16 (dst_port);
281 sa->udp_hdr.dst_port = clib_host_to_net_u16 (dst_port);
285 hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
288 *sa_out_index = sa_index;
294 ipsec_sa_del (ipsec_sa_t * sa)
296 vlib_main_t *vm = vlib_get_main ();
297 ipsec_main_t *im = &ipsec_main;
300 sa_index = sa - im->sad;
301 hash_unset (im->sa_index_by_sa_id, sa->id);
303 /* no recovery possible when deleting an SA */
304 (void) ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
306 if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
308 fib_entry_untrack (sa->fib_entry_index, sa->sibling);
309 dpo_reset (&sa->dpo);
311 vnet_crypto_key_del (vm, sa->crypto_key_index);
312 if (sa->integ_alg != IPSEC_INTEG_ALG_NONE)
313 vnet_crypto_key_del (vm, sa->integ_key_index);
314 pool_put (im->sad, sa);
318 ipsec_sa_unlock (index_t sai)
320 ipsec_main_t *im = &ipsec_main;
323 if (INDEX_INVALID == sai)
326 sa = pool_elt_at_index (im->sad, sai);
328 fib_node_unlock (&sa->node);
332 ipsec_sa_lock (index_t sai)
334 ipsec_main_t *im = &ipsec_main;
337 if (INDEX_INVALID == sai)
340 sa = pool_elt_at_index (im->sad, sai);
342 fib_node_lock (&sa->node);
346 ipsec_sa_find_and_lock (u32 id)
348 ipsec_main_t *im = &ipsec_main;
352 p = hash_get (im->sa_index_by_sa_id, id);
355 return INDEX_INVALID;
357 sa = pool_elt_at_index (im->sad, p[0]);
359 fib_node_lock (&sa->node);
365 ipsec_sa_unlock_id (u32 id)
367 ipsec_main_t *im = &ipsec_main;
370 p = hash_get (im->sa_index_by_sa_id, id);
373 return VNET_API_ERROR_NO_SUCH_ENTRY;
375 ipsec_sa_unlock (p[0]);
381 ipsec_sa_clear (index_t sai)
383 vlib_zero_combined_counter (&ipsec_sa_counters, sai);
387 ipsec_sa_walk (ipsec_sa_walk_cb_t cb, void *ctx)
389 ipsec_main_t *im = &ipsec_main;
393 pool_foreach (sa, im->sad,
395 if (WALK_CONTINUE != cb(sa, ctx))
402 * Function definition to get a FIB node from its index
405 ipsec_sa_fib_node_get (fib_node_index_t index)
411 sa = pool_elt_at_index (im->sad, index);
417 ipsec_sa_from_fib_node (fib_node_t * node)
419 ASSERT (FIB_NODE_TYPE_IPSEC_SA == node->fn_type);
420 return ((ipsec_sa_t *) (((char *) node) -
421 STRUCT_OFFSET_OF (ipsec_sa_t, node)));
426 * Function definition to inform the FIB node that its last lock has gone.
429 ipsec_sa_last_lock_gone (fib_node_t * node)
432 * The ipsec SA is a root of the graph. As such
433 * it never has children and thus is never locked.
435 ipsec_sa_del (ipsec_sa_from_fib_node (node));
439 * Function definition to backwalk a FIB node
441 static fib_node_back_walk_rc_t
442 ipsec_sa_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
444 ipsec_sa_stack (ipsec_sa_from_fib_node (node));
446 return (FIB_NODE_BACK_WALK_CONTINUE);
450 * Virtual function table registered by SAs
451 * for participation in the FIB object graph.
453 const static fib_node_vft_t ipsec_sa_vft = {
454 .fnv_get = ipsec_sa_fib_node_get,
455 .fnv_last_lock = ipsec_sa_last_lock_gone,
456 .fnv_back_walk = ipsec_sa_back_walk,
459 /* force inclusion from application's main.c */
461 ipsec_sa_interface_init (vlib_main_t * vm)
463 fib_node_register_type (FIB_NODE_TYPE_IPSEC_SA, &ipsec_sa_vft);
468 VLIB_INIT_FUNCTION (ipsec_sa_interface_init);
471 * fd.io coding-style-patch-verification: ON
474 * eval: (c-set-style "gnu")