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>
23 * SA packet & bytes counters
25 vlib_combined_counter_main_t ipsec_sa_counters = {
27 .stat_segment_name = "/net/ipsec/sa",
32 ipsec_call_add_del_callbacks (ipsec_main_t * im, ipsec_sa_t * sa,
33 u32 sa_index, int is_add)
35 ipsec_ah_backend_t *ab;
36 ipsec_esp_backend_t *eb;
39 case IPSEC_PROTOCOL_AH:
40 ab = pool_elt_at_index (im->ah_backends, im->ah_current_backend);
41 if (ab->add_del_sa_sess_cb)
42 return ab->add_del_sa_sess_cb (sa_index, is_add);
44 case IPSEC_PROTOCOL_ESP:
45 eb = pool_elt_at_index (im->esp_backends, im->esp_current_backend);
46 if (eb->add_del_sa_sess_cb)
47 return eb->add_del_sa_sess_cb (sa_index, is_add);
54 ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len)
56 memset (key, 0, sizeof (*key));
58 if (len > sizeof (key->data))
59 key->len = sizeof (key->data);
63 memcpy (key->data, data, key->len);
67 * 'stack' (resolve the recursion for) the SA tunnel destination
70 ipsec_sa_stack (ipsec_sa_t * sa)
72 ipsec_main_t *im = &ipsec_main;
73 fib_forward_chain_type_t fct;
74 dpo_id_t tmp = DPO_INVALID;
77 fib_forw_chain_type_from_fib_proto ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
81 fib_entry_contribute_forwarding (sa->fib_entry_index, fct, &tmp);
83 dpo_stack_from_node ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
84 im->ah6_encrypt_node_index :
85 im->ah4_encrypt_node_index),
86 &sa->dpo[IPSEC_PROTOCOL_AH], &tmp);
87 dpo_stack_from_node ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
88 im->esp6_encrypt_node_index :
89 im->esp4_encrypt_node_index),
90 &sa->dpo[IPSEC_PROTOCOL_ESP], &tmp);
95 ipsec_sa_set_crypto_alg (ipsec_sa_t * sa, ipsec_crypto_alg_t crypto_alg)
97 ipsec_main_t *im = &ipsec_main;
98 sa->crypto_alg = crypto_alg;
99 sa->crypto_iv_size = im->crypto_algs[crypto_alg].iv_size;
100 sa->crypto_block_size = im->crypto_algs[crypto_alg].block_size;
101 sa->crypto_enc_op_id = im->crypto_algs[crypto_alg].enc_op_id;
102 sa->crypto_dec_op_id = im->crypto_algs[crypto_alg].dec_op_id;
103 sa->crypto_calg = im->crypto_algs[crypto_alg].alg;
104 ASSERT (sa->crypto_iv_size <= ESP_MAX_IV_SIZE);
105 ASSERT (sa->crypto_block_size <= ESP_MAX_BLOCK_SIZE);
106 if (IPSEC_CRYPTO_ALG_IS_GCM (crypto_alg))
108 sa->integ_icv_size = im->crypto_algs[crypto_alg].icv_size;
109 ipsec_sa_set_IS_AEAD (sa);
114 ipsec_sa_set_integ_alg (ipsec_sa_t * sa, ipsec_integ_alg_t integ_alg)
116 ipsec_main_t *im = &ipsec_main;
117 sa->integ_alg = integ_alg;
118 sa->integ_icv_size = im->integ_algs[integ_alg].icv_size;
119 sa->integ_op_id = im->integ_algs[integ_alg].op_id;
120 sa->integ_calg = im->integ_algs[integ_alg].alg;
121 ASSERT (sa->integ_icv_size <= ESP_MAX_ICV_SIZE);
125 ipsec_sa_add (u32 id,
127 ipsec_protocol_t proto,
128 ipsec_crypto_alg_t crypto_alg,
129 const ipsec_key_t * ck,
130 ipsec_integ_alg_t integ_alg,
131 const ipsec_key_t * ik,
132 ipsec_sa_flags_t flags,
135 const ip46_address_t * tun_src,
136 const ip46_address_t * tun_dst, u32 * sa_out_index)
138 vlib_main_t *vm = vlib_get_main ();
139 ipsec_main_t *im = &ipsec_main;
145 p = hash_get (im->sa_index_by_sa_id, id);
147 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
149 pool_get_aligned_zero (im->sad, sa, CLIB_CACHE_LINE_BYTES);
151 fib_node_init (&sa->node, FIB_NODE_TYPE_IPSEC_SA);
152 sa_index = sa - im->sad;
154 vlib_validate_combined_counter (&ipsec_sa_counters, sa_index);
155 vlib_zero_combined_counter (&ipsec_sa_counters, sa_index);
159 sa->stat_index = sa_index;
160 sa->protocol = proto;
163 ipsec_sa_set_integ_alg (sa, integ_alg);
164 clib_memcpy (&sa->integ_key, ik, sizeof (sa->integ_key));
165 ipsec_sa_set_crypto_alg (sa, crypto_alg);
166 clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
167 ip46_address_copy (&sa->tunnel_src_addr, tun_src);
168 ip46_address_copy (&sa->tunnel_dst_addr, tun_dst);
170 sa->crypto_key_index = vnet_crypto_key_add (vm,
171 im->crypto_algs[crypto_alg].alg,
172 (u8 *) ck->data, ck->len);
173 if (~0 == sa->crypto_key_index)
175 pool_put (im->sad, sa);
176 return VNET_API_ERROR_KEY_LENGTH;
179 sa->integ_key_index = vnet_crypto_key_add (vm,
180 im->integ_algs[integ_alg].alg,
181 (u8 *) ik->data, ik->len);
182 if (~0 == sa->integ_key_index)
184 pool_put (im->sad, sa);
185 return VNET_API_ERROR_KEY_LENGTH;
188 err = ipsec_check_support_cb (im, sa);
191 clib_warning ("%s", err->what);
192 pool_put (im->sad, sa);
193 return VNET_API_ERROR_UNIMPLEMENTED;
196 err = ipsec_call_add_del_callbacks (im, sa, sa_index, 1);
199 pool_put (im->sad, sa);
200 return VNET_API_ERROR_SYSCALL_ERROR_1;
203 if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
205 fib_protocol_t fproto = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
206 FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4);
208 .fp_addr = sa->tunnel_dst_addr,
209 .fp_len = (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ? 128 : 32),
212 sa->tx_fib_index = fib_table_find (fproto, tx_table_id);
213 if (sa->tx_fib_index == ~((u32) 0))
215 pool_put (im->sad, sa);
216 return VNET_API_ERROR_NO_SUCH_FIB;
219 sa->fib_entry_index = fib_table_entry_special_add (sa->tx_fib_index,
222 FIB_ENTRY_FLAG_NONE);
223 sa->sibling = fib_entry_child_add (sa->fib_entry_index,
224 FIB_NODE_TYPE_IPSEC_SA, sa_index);
227 /* generate header templates */
228 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
230 sa->ip6_hdr.ip_version_traffic_class_and_flow_label = 0x60;
231 sa->ip6_hdr.hop_limit = 254;
232 sa->ip6_hdr.src_address.as_u64[0] =
233 sa->tunnel_src_addr.ip6.as_u64[0];
234 sa->ip6_hdr.src_address.as_u64[1] =
235 sa->tunnel_src_addr.ip6.as_u64[1];
236 sa->ip6_hdr.dst_address.as_u64[0] =
237 sa->tunnel_dst_addr.ip6.as_u64[0];
238 sa->ip6_hdr.dst_address.as_u64[1] =
239 sa->tunnel_dst_addr.ip6.as_u64[1];
240 if (ipsec_sa_is_set_UDP_ENCAP (sa))
241 sa->ip6_hdr.protocol = IP_PROTOCOL_UDP;
243 sa->ip6_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
247 sa->ip4_hdr.ip_version_and_header_length = 0x45;
248 sa->ip4_hdr.ttl = 254;
249 sa->ip4_hdr.src_address.as_u32 = sa->tunnel_src_addr.ip4.as_u32;
250 sa->ip4_hdr.dst_address.as_u32 = sa->tunnel_dst_addr.ip4.as_u32;
252 if (ipsec_sa_is_set_UDP_ENCAP (sa))
253 sa->ip4_hdr.protocol = IP_PROTOCOL_UDP;
255 sa->ip4_hdr.protocol = IP_PROTOCOL_IPSEC_ESP;
256 sa->ip4_hdr.checksum = ip4_header_checksum (&sa->ip4_hdr);
260 if (ipsec_sa_is_set_UDP_ENCAP (sa))
262 sa->udp_hdr.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
263 sa->udp_hdr.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
266 hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
269 *sa_out_index = sa_index;
275 ipsec_sa_del (u32 id)
277 vlib_main_t *vm = vlib_get_main ();
278 ipsec_main_t *im = &ipsec_main;
284 p = hash_get (im->sa_index_by_sa_id, id);
287 return VNET_API_ERROR_NO_SUCH_ENTRY;
290 sa = pool_elt_at_index (im->sad, sa_index);
291 if (ipsec_is_sa_used (sa_index))
293 clib_warning ("sa_id %u used in policy", sa->id);
294 /* sa used in policy */
295 return VNET_API_ERROR_SYSCALL_ERROR_1;
297 hash_unset (im->sa_index_by_sa_id, sa->id);
298 err = ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
300 return VNET_API_ERROR_SYSCALL_ERROR_2;
302 if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
304 fib_entry_child_remove (sa->fib_entry_index, sa->sibling);
305 fib_table_entry_special_remove
307 fib_entry_get_prefix (sa->fib_entry_index), FIB_SOURCE_RR);
308 dpo_reset (&sa->dpo[IPSEC_PROTOCOL_AH]);
309 dpo_reset (&sa->dpo[IPSEC_PROTOCOL_ESP]);
311 vnet_crypto_key_del (vm, sa->crypto_key_index);
312 vnet_crypto_key_del (vm, sa->integ_key_index);
313 pool_put (im->sad, sa);
318 ipsec_is_sa_used (u32 sa_index)
320 ipsec_main_t *im = &ipsec_main;
321 ipsec_tunnel_if_t *t;
325 pool_foreach(p, im->policies, ({
326 if (p->policy == IPSEC_POLICY_ACTION_PROTECT)
328 if (p->sa_index == sa_index)
333 pool_foreach(t, im->tunnel_interfaces, ({
334 if (t->input_sa_index == sa_index)
336 if (t->output_sa_index == sa_index)
345 ipsec_set_sa_key (u32 id, const ipsec_key_t * ck, const ipsec_key_t * ik)
347 vlib_main_t *vm = vlib_get_main ();
348 ipsec_main_t *im = &ipsec_main;
354 p = hash_get (im->sa_index_by_sa_id, id);
356 return VNET_API_ERROR_SYSCALL_ERROR_1; /* no such sa-id */
359 sa = pool_elt_at_index (im->sad, sa_index);
364 clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
365 vnet_crypto_key_modify (vm, sa->crypto_key_index, sa->crypto_calg,
366 (u8 *) ck->data, ck->len);
372 clib_memcpy (&sa->integ_key, ik, sizeof (sa->integ_key));
373 vnet_crypto_key_modify (vm, sa->integ_key_index, sa->integ_calg,
374 (u8 *) ik->data, ik->len);
379 err = ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
382 clib_error_free (err);
383 return VNET_API_ERROR_SYSCALL_ERROR_1;
391 ipsec_get_sa_index_by_sa_id (u32 sa_id)
393 ipsec_main_t *im = &ipsec_main;
394 uword *p = hash_get (im->sa_index_by_sa_id, sa_id);
402 ipsec_sa_walk (ipsec_sa_walk_cb_t cb, void *ctx)
404 ipsec_main_t *im = &ipsec_main;
408 pool_foreach (sa, im->sad,
410 if (WALK_CONTINUE != cb(sa, ctx))
417 * Function definition to get a FIB node from its index
420 ipsec_sa_fib_node_get (fib_node_index_t index)
426 sa = pool_elt_at_index (im->sad, index);
432 * Function definition to inform the FIB node that its last lock has gone.
435 ipsec_sa_last_lock_gone (fib_node_t * node)
438 * The ipsec SA is a root of the graph. As such
439 * it never has children and thus is never locked.
445 ipsec_sa_from_fib_node (fib_node_t * node)
447 ASSERT (FIB_NODE_TYPE_IPSEC_SA == node->fn_type);
448 return ((ipsec_sa_t *) (((char *) node) -
449 STRUCT_OFFSET_OF (ipsec_sa_t, node)));
454 * Function definition to backwalk a FIB node
456 static fib_node_back_walk_rc_t
457 ipsec_sa_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
459 ipsec_sa_stack (ipsec_sa_from_fib_node (node));
461 return (FIB_NODE_BACK_WALK_CONTINUE);
465 * Virtual function table registered by MPLS GRE tunnels
466 * for participation in the FIB object graph.
468 const static fib_node_vft_t ipsec_sa_vft = {
469 .fnv_get = ipsec_sa_fib_node_get,
470 .fnv_last_lock = ipsec_sa_last_lock_gone,
471 .fnv_back_walk = ipsec_sa_back_walk,
474 /* force inclusion from application's main.c */
476 ipsec_sa_interface_init (vlib_main_t * vm)
478 fib_node_register_type (FIB_NODE_TYPE_IPSEC_SA, &ipsec_sa_vft);
483 VLIB_INIT_FUNCTION (ipsec_sa_interface_init);
486 * fd.io coding-style-patch-verification: ON
489 * eval: (c-set-style "gnu")