2 *------------------------------------------------------------------
3 * ipsec_api.c - ipsec api
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/ip/ip.h>
27 #include <vnet/vnet_msg_enum.h>
30 #include <vnet/ipsec/ipsec.h>
31 #include <vnet/ipsec/ikev2.h>
34 #define vl_typedefs /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
38 #define vl_endianfun /* define message structures */
39 #include <vnet/vnet_all_api_h.h>
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
45 #include <vnet/vnet_all_api_h.h>
48 #include <vlibapi/api_helper_macros.h>
50 #define foreach_vpe_api_msg \
51 _(IPSEC_SPD_ADD_DEL, ipsec_spd_add_del) \
52 _(IPSEC_INTERFACE_ADD_DEL_SPD, ipsec_interface_add_del_spd) \
53 _(IPSEC_SPD_ADD_DEL_ENTRY, ipsec_spd_add_del_entry) \
54 _(IPSEC_SAD_ADD_DEL_ENTRY, ipsec_sad_add_del_entry) \
55 _(IPSEC_SA_SET_KEY, ipsec_sa_set_key) \
56 _(IPSEC_SPD_DUMP, ipsec_spd_dump) \
57 _(IKEV2_PROFILE_ADD_DEL, ikev2_profile_add_del) \
58 _(IKEV2_PROFILE_SET_AUTH, ikev2_profile_set_auth) \
59 _(IKEV2_PROFILE_SET_ID, ikev2_profile_set_id) \
60 _(IKEV2_PROFILE_SET_TS, ikev2_profile_set_ts) \
61 _(IKEV2_SET_LOCAL_KEY, ikev2_set_local_key) \
62 _(IKEV2_SET_RESPONDER, ikev2_set_responder) \
63 _(IKEV2_SET_IKE_TRANSFORMS, ikev2_set_ike_transforms) \
64 _(IKEV2_SET_ESP_TRANSFORMS, ikev2_set_esp_transforms) \
65 _(IKEV2_SET_SA_LIFETIME, ikev2_set_sa_lifetime) \
66 _(IKEV2_INITIATE_SA_INIT, ikev2_initiate_sa_init) \
67 _(IKEV2_INITIATE_DEL_IKE_SA, ikev2_initiate_del_ike_sa) \
68 _(IKEV2_INITIATE_DEL_CHILD_SA, ikev2_initiate_del_child_sa) \
69 _(IKEV2_INITIATE_REKEY_CHILD_SA, ikev2_initiate_rekey_child_sa)
71 static void vl_api_ipsec_spd_add_del_t_handler
72 (vl_api_ipsec_spd_add_del_t * mp)
75 clib_warning ("unimplemented");
78 vlib_main_t *vm __attribute__ ((unused)) = vlib_get_main ();
79 vl_api_ipsec_spd_add_del_reply_t *rmp;
83 rv = ipsec_add_del_spd (vm, ntohl (mp->spd_id), mp->is_add);
85 rv = VNET_API_ERROR_UNIMPLEMENTED;
88 REPLY_MACRO (VL_API_IPSEC_SPD_ADD_DEL_REPLY);
92 static void vl_api_ipsec_interface_add_del_spd_t_handler
93 (vl_api_ipsec_interface_add_del_spd_t * mp)
95 vlib_main_t *vm __attribute__ ((unused)) = vlib_get_main ();
96 vl_api_ipsec_interface_add_del_spd_reply_t *rmp;
98 u32 sw_if_index __attribute__ ((unused));
99 u32 spd_id __attribute__ ((unused));
101 sw_if_index = ntohl (mp->sw_if_index);
102 spd_id = ntohl (mp->spd_id);
104 VALIDATE_SW_IF_INDEX (mp);
107 rv = ipsec_set_interface_spd (vm, sw_if_index, spd_id, mp->is_add);
109 rv = VNET_API_ERROR_UNIMPLEMENTED;
112 BAD_SW_IF_INDEX_LABEL;
114 REPLY_MACRO (VL_API_IPSEC_INTERFACE_ADD_DEL_SPD_REPLY);
117 static void vl_api_ipsec_spd_add_del_entry_t_handler
118 (vl_api_ipsec_spd_add_del_entry_t * mp)
120 vlib_main_t *vm __attribute__ ((unused)) = vlib_get_main ();
121 vl_api_ipsec_spd_add_del_entry_reply_t *rmp;
127 memset (&p, 0, sizeof (p));
129 p.id = ntohl (mp->spd_id);
130 p.priority = ntohl (mp->priority);
131 p.is_outbound = mp->is_outbound;
132 p.is_ipv6 = mp->is_ipv6;
134 if (mp->is_ipv6 || mp->is_ip_any)
136 clib_memcpy (&p.raddr.start, mp->remote_address_start, 16);
137 clib_memcpy (&p.raddr.stop, mp->remote_address_stop, 16);
138 clib_memcpy (&p.laddr.start, mp->local_address_start, 16);
139 clib_memcpy (&p.laddr.stop, mp->local_address_stop, 16);
143 clib_memcpy (&p.raddr.start.ip4.data, mp->remote_address_start, 4);
144 clib_memcpy (&p.raddr.stop.ip4.data, mp->remote_address_stop, 4);
145 clib_memcpy (&p.laddr.start.ip4.data, mp->local_address_start, 4);
146 clib_memcpy (&p.laddr.stop.ip4.data, mp->local_address_stop, 4);
148 p.protocol = mp->protocol;
149 p.rport.start = ntohs (mp->remote_port_start);
150 p.rport.stop = ntohs (mp->remote_port_stop);
151 p.lport.start = ntohs (mp->local_port_start);
152 p.lport.stop = ntohs (mp->local_port_stop);
153 /* policy action resolve unsupported */
154 if (mp->policy == IPSEC_POLICY_ACTION_RESOLVE)
156 clib_warning ("unsupported action: 'resolve'");
157 rv = VNET_API_ERROR_UNIMPLEMENTED;
160 p.policy = mp->policy;
161 p.sa_id = ntohl (mp->sa_id);
163 rv = ipsec_add_del_policy (vm, &p, mp->is_add);
170 rv = ipsec_add_del_policy (vm, &p, mp->is_add);
173 rv = VNET_API_ERROR_UNIMPLEMENTED;
178 REPLY_MACRO (VL_API_IPSEC_SPD_ADD_DEL_ENTRY_REPLY);
181 static void vl_api_ipsec_sad_add_del_entry_t_handler
182 (vl_api_ipsec_sad_add_del_entry_t * mp)
184 vlib_main_t *vm __attribute__ ((unused)) = vlib_get_main ();
185 vl_api_ipsec_sad_add_del_entry_reply_t *rmp;
188 ipsec_main_t *im = &ipsec_main;
191 memset (&sa, 0, sizeof (sa));
193 sa.id = ntohl (mp->sad_id);
194 sa.spi = ntohl (mp->spi);
195 /* security protocol AH unsupported */
196 if (mp->protocol == IPSEC_PROTOCOL_AH)
198 clib_warning ("unsupported security protocol 'AH'");
199 rv = VNET_API_ERROR_UNIMPLEMENTED;
202 sa.protocol = mp->protocol;
203 /* check for unsupported crypto-alg */
204 if (mp->crypto_algorithm < IPSEC_CRYPTO_ALG_AES_CBC_128 ||
205 mp->crypto_algorithm >= IPSEC_CRYPTO_N_ALG)
207 clib_warning ("unsupported crypto-alg: '%U'", format_ipsec_crypto_alg,
208 mp->crypto_algorithm);
209 rv = VNET_API_ERROR_UNIMPLEMENTED;
212 sa.crypto_alg = mp->crypto_algorithm;
213 sa.crypto_key_len = mp->crypto_key_length;
214 clib_memcpy (&sa.crypto_key, mp->crypto_key, sizeof (sa.crypto_key));
215 /* check for unsupported integ-alg */
216 if (mp->integrity_algorithm < IPSEC_INTEG_ALG_NONE ||
217 mp->integrity_algorithm >= IPSEC_INTEG_N_ALG)
219 clib_warning ("unsupported integ-alg: '%U'", format_ipsec_integ_alg,
220 mp->integrity_algorithm);
221 rv = VNET_API_ERROR_UNIMPLEMENTED;
225 sa.integ_alg = mp->integrity_algorithm;
226 sa.integ_key_len = mp->integrity_key_length;
227 clib_memcpy (&sa.integ_key, mp->integrity_key, sizeof (sa.integ_key));
228 sa.use_esn = mp->use_extended_sequence_number;
229 sa.is_tunnel = mp->is_tunnel;
230 sa.is_tunnel_ip6 = mp->is_tunnel_ipv6;
231 if (sa.is_tunnel_ip6)
233 clib_memcpy (&sa.tunnel_src_addr, mp->tunnel_src_address, 16);
234 clib_memcpy (&sa.tunnel_dst_addr, mp->tunnel_dst_address, 16);
238 clib_memcpy (&sa.tunnel_src_addr.ip4.data, mp->tunnel_src_address, 4);
239 clib_memcpy (&sa.tunnel_dst_addr.ip4.data, mp->tunnel_dst_address, 4);
242 ASSERT (im->cb.check_support_cb);
243 clib_error_t *err = im->cb.check_support_cb (&sa);
246 clib_warning ("%s", err->what);
247 rv = VNET_API_ERROR_UNIMPLEMENTED;
251 rv = ipsec_add_del_sa (vm, &sa, mp->is_add);
253 rv = VNET_API_ERROR_UNIMPLEMENTED;
258 REPLY_MACRO (VL_API_IPSEC_SAD_ADD_DEL_ENTRY_REPLY);
262 send_ipsec_spd_details (ipsec_policy_t * p, unix_shared_memory_queue_t * q,
265 vl_api_ipsec_spd_details_t *mp;
267 mp = vl_msg_api_alloc (sizeof (*mp));
268 memset (mp, 0, sizeof (*mp));
269 mp->_vl_msg_id = ntohs (VL_API_IPSEC_SPD_DETAILS);
270 mp->context = context;
272 mp->spd_id = htonl (p->id);
273 mp->priority = htonl (p->priority);
274 mp->is_outbound = p->is_outbound;
275 mp->is_ipv6 = p->is_ipv6;
278 memcpy (mp->local_start_addr, &p->laddr.start.ip6, 16);
279 memcpy (mp->local_stop_addr, &p->laddr.stop.ip6, 16);
280 memcpy (mp->remote_start_addr, &p->raddr.start.ip6, 16);
281 memcpy (mp->remote_stop_addr, &p->raddr.stop.ip6, 16);
285 memcpy (mp->local_start_addr, &p->laddr.start.ip4, 4);
286 memcpy (mp->local_stop_addr, &p->laddr.stop.ip4, 4);
287 memcpy (mp->remote_start_addr, &p->raddr.start.ip4, 4);
288 memcpy (mp->remote_stop_addr, &p->raddr.stop.ip4, 4);
290 mp->local_start_port = htons (p->lport.start);
291 mp->local_stop_port = htons (p->lport.stop);
292 mp->remote_start_port = htons (p->rport.start);
293 mp->remote_stop_port = htons (p->rport.stop);
294 mp->protocol = p->protocol;
295 mp->policy = p->policy;
296 mp->sa_id = htonl (p->sa_id);
297 mp->bytes = clib_host_to_net_u64 (p->counter.bytes);
298 mp->packets = clib_host_to_net_u64 (p->counter.packets);
300 vl_msg_api_send_shmem (q, (u8 *) & mp);
304 vl_api_ipsec_spd_dump_t_handler (vl_api_ipsec_spd_dump_t * mp)
306 unix_shared_memory_queue_t *q;
307 ipsec_main_t *im = &ipsec_main;
308 ipsec_policy_t *policy;
313 q = vl_api_client_index_to_input_queue (mp->client_index);
317 p = hash_get (im->spd_index_by_spd_id, ntohl (mp->spd_id));
322 spd = pool_elt_at_index (im->spds, spd_index);
325 pool_foreach (policy, spd->policies,
327 if (mp->sa_id == ~(0) || ntohl (mp->sa_id) == policy->sa_id)
328 send_ipsec_spd_details (policy, q,
333 clib_warning ("unimplemented");
338 vl_api_ipsec_sa_set_key_t_handler (vl_api_ipsec_sa_set_key_t * mp)
340 vlib_main_t *vm __attribute__ ((unused)) = vlib_get_main ();
341 vl_api_ipsec_sa_set_key_reply_t *rmp;
345 sa.id = ntohl (mp->sa_id);
346 sa.crypto_key_len = mp->crypto_key_length;
347 clib_memcpy (&sa.crypto_key, mp->crypto_key, sizeof (sa.crypto_key));
348 sa.integ_key_len = mp->integrity_key_length;
349 clib_memcpy (&sa.integ_key, mp->integrity_key, sizeof (sa.integ_key));
351 rv = ipsec_set_sa_key (vm, &sa);
353 rv = VNET_API_ERROR_UNIMPLEMENTED;
356 REPLY_MACRO (VL_API_IPSEC_SA_SET_KEY_REPLY);
360 vl_api_ikev2_profile_add_del_t_handler (vl_api_ikev2_profile_add_del_t * mp)
362 vl_api_ikev2_profile_add_del_reply_t *rmp;
366 vlib_main_t *vm = vlib_get_main ();
368 u8 *tmp = format (0, "%s", mp->name);
369 error = ikev2_add_del_profile (vm, tmp, mp->is_add);
372 rv = VNET_API_ERROR_UNSPECIFIED;
374 rv = VNET_API_ERROR_UNIMPLEMENTED;
377 REPLY_MACRO (VL_API_IKEV2_PROFILE_ADD_DEL_REPLY);
381 vl_api_ikev2_profile_set_auth_t_handler
382 (vl_api_ikev2_profile_set_auth_t * mp)
384 vl_api_ikev2_profile_set_auth_reply_t *rmp;
388 vlib_main_t *vm = vlib_get_main ();
390 u8 *tmp = format (0, "%s", mp->name);
391 u8 *data = vec_new (u8, mp->data_len);
392 clib_memcpy (data, mp->data, mp->data_len);
393 error = ikev2_set_profile_auth (vm, tmp, mp->auth_method, data, mp->is_hex);
397 rv = VNET_API_ERROR_UNSPECIFIED;
399 rv = VNET_API_ERROR_UNIMPLEMENTED;
402 REPLY_MACRO (VL_API_IKEV2_PROFILE_SET_AUTH_REPLY);
406 vl_api_ikev2_profile_set_id_t_handler (vl_api_ikev2_profile_set_id_t * mp)
408 vl_api_ikev2_profile_add_del_reply_t *rmp;
412 vlib_main_t *vm = vlib_get_main ();
414 u8 *tmp = format (0, "%s", mp->name);
415 u8 *data = vec_new (u8, mp->data_len);
416 clib_memcpy (data, mp->data, mp->data_len);
417 error = ikev2_set_profile_id (vm, tmp, mp->id_type, data, mp->is_local);
421 rv = VNET_API_ERROR_UNSPECIFIED;
423 rv = VNET_API_ERROR_UNIMPLEMENTED;
426 REPLY_MACRO (VL_API_IKEV2_PROFILE_SET_ID_REPLY);
430 vl_api_ikev2_profile_set_ts_t_handler (vl_api_ikev2_profile_set_ts_t * mp)
432 vl_api_ikev2_profile_set_ts_reply_t *rmp;
436 vlib_main_t *vm = vlib_get_main ();
438 u8 *tmp = format (0, "%s", mp->name);
439 error = ikev2_set_profile_ts (vm, tmp, mp->proto, mp->start_port,
440 mp->end_port, (ip4_address_t) mp->start_addr,
441 (ip4_address_t) mp->end_addr, mp->is_local);
444 rv = VNET_API_ERROR_UNSPECIFIED;
446 rv = VNET_API_ERROR_UNIMPLEMENTED;
449 REPLY_MACRO (VL_API_IKEV2_PROFILE_SET_TS_REPLY);
453 vl_api_ikev2_set_local_key_t_handler (vl_api_ikev2_set_local_key_t * mp)
455 vl_api_ikev2_profile_set_ts_reply_t *rmp;
459 vlib_main_t *vm = vlib_get_main ();
462 error = ikev2_set_local_key (vm, mp->key_file);
464 rv = VNET_API_ERROR_UNSPECIFIED;
466 rv = VNET_API_ERROR_UNIMPLEMENTED;
469 REPLY_MACRO (VL_API_IKEV2_SET_LOCAL_KEY_REPLY);
473 vl_api_ikev2_set_responder_t_handler (vl_api_ikev2_set_responder_t * mp)
475 vl_api_ikev2_set_responder_reply_t *rmp;
479 vlib_main_t *vm = vlib_get_main ();
482 u8 *tmp = format (0, "%s", mp->name);
484 clib_memcpy (&ip4, mp->address, sizeof (ip4));
486 error = ikev2_set_profile_responder (vm, tmp, mp->sw_if_index, ip4);
489 rv = VNET_API_ERROR_UNSPECIFIED;
491 rv = VNET_API_ERROR_UNIMPLEMENTED;
494 REPLY_MACRO (VL_API_IKEV2_SET_RESPONDER_REPLY);
498 vl_api_ikev2_set_ike_transforms_t_handler (vl_api_ikev2_set_ike_transforms_t *
501 vl_api_ikev2_set_ike_transforms_reply_t *rmp;
505 vlib_main_t *vm = vlib_get_main ();
508 u8 *tmp = format (0, "%s", mp->name);
511 ikev2_set_profile_ike_transforms (vm, tmp, mp->crypto_alg, mp->integ_alg,
512 mp->dh_group, mp->crypto_key_size);
515 rv = VNET_API_ERROR_UNSPECIFIED;
517 rv = VNET_API_ERROR_UNIMPLEMENTED;
520 REPLY_MACRO (VL_API_IKEV2_SET_IKE_TRANSFORMS_REPLY);
524 vl_api_ikev2_set_esp_transforms_t_handler (vl_api_ikev2_set_esp_transforms_t *
527 vl_api_ikev2_set_esp_transforms_reply_t *rmp;
531 vlib_main_t *vm = vlib_get_main ();
534 u8 *tmp = format (0, "%s", mp->name);
537 ikev2_set_profile_esp_transforms (vm, tmp, mp->crypto_alg, mp->integ_alg,
538 mp->dh_group, mp->crypto_key_size);
541 rv = VNET_API_ERROR_UNSPECIFIED;
543 rv = VNET_API_ERROR_UNIMPLEMENTED;
546 REPLY_MACRO (VL_API_IKEV2_SET_ESP_TRANSFORMS_REPLY);
550 vl_api_ikev2_set_sa_lifetime_t_handler (vl_api_ikev2_set_sa_lifetime_t * mp)
552 vl_api_ikev2_set_sa_lifetime_reply_t *rmp;
556 vlib_main_t *vm = vlib_get_main ();
559 u8 *tmp = format (0, "%s", mp->name);
562 ikev2_set_profile_sa_lifetime (vm, tmp, mp->lifetime, mp->lifetime_jitter,
563 mp->handover, mp->lifetime_maxdata);
566 rv = VNET_API_ERROR_UNSPECIFIED;
568 rv = VNET_API_ERROR_UNIMPLEMENTED;
571 REPLY_MACRO (VL_API_IKEV2_SET_SA_LIFETIME_REPLY);
575 vl_api_ikev2_initiate_sa_init_t_handler (vl_api_ikev2_initiate_sa_init_t * mp)
577 vl_api_ikev2_initiate_sa_init_reply_t *rmp;
581 vlib_main_t *vm = vlib_get_main ();
584 u8 *tmp = format (0, "%s", mp->name);
586 error = ikev2_initiate_sa_init (vm, tmp);
589 rv = VNET_API_ERROR_UNSPECIFIED;
591 rv = VNET_API_ERROR_UNIMPLEMENTED;
594 REPLY_MACRO (VL_API_IKEV2_INITIATE_SA_INIT_REPLY);
598 vl_api_ikev2_initiate_del_ike_sa_t_handler (vl_api_ikev2_initiate_del_ike_sa_t
601 vl_api_ikev2_initiate_del_ike_sa_reply_t *rmp;
605 vlib_main_t *vm = vlib_get_main ();
608 error = ikev2_initiate_delete_ike_sa (vm, mp->ispi);
610 rv = VNET_API_ERROR_UNSPECIFIED;
612 rv = VNET_API_ERROR_UNIMPLEMENTED;
615 REPLY_MACRO (VL_API_IKEV2_INITIATE_DEL_IKE_SA_REPLY);
619 vl_api_ikev2_initiate_del_child_sa_t_handler
620 (vl_api_ikev2_initiate_del_child_sa_t * mp)
622 vl_api_ikev2_initiate_del_child_sa_reply_t *rmp;
626 vlib_main_t *vm = vlib_get_main ();
629 error = ikev2_initiate_delete_child_sa (vm, mp->ispi);
631 rv = VNET_API_ERROR_UNSPECIFIED;
633 rv = VNET_API_ERROR_UNIMPLEMENTED;
636 REPLY_MACRO (VL_API_IKEV2_INITIATE_DEL_CHILD_SA_REPLY);
640 vl_api_ikev2_initiate_rekey_child_sa_t_handler
641 (vl_api_ikev2_initiate_rekey_child_sa_t * mp)
643 vl_api_ikev2_initiate_rekey_child_sa_reply_t *rmp;
647 vlib_main_t *vm = vlib_get_main ();
650 error = ikev2_initiate_rekey_child_sa (vm, mp->ispi);
652 rv = VNET_API_ERROR_UNSPECIFIED;
654 rv = VNET_API_ERROR_UNIMPLEMENTED;
657 REPLY_MACRO (VL_API_IKEV2_INITIATE_REKEY_CHILD_SA_REPLY);
662 * Add vpe's API message handlers to the table.
663 * vlib has alread mapped shared memory and
664 * added the client registration handlers.
665 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
667 #define vl_msg_name_crc_list
668 #include <vnet/vnet_all_api_h.h>
669 #undef vl_msg_name_crc_list
672 setup_message_id_table (api_main_t * am)
674 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
675 foreach_vl_msg_name_crc_ipsec;
679 static clib_error_t *
680 ipsec_api_hookup (vlib_main_t * vm)
682 api_main_t *am = &api_main;
685 vl_msg_api_set_handlers(VL_API_##N, #n, \
686 vl_api_##n##_t_handler, \
688 vl_api_##n##_t_endian, \
689 vl_api_##n##_t_print, \
690 sizeof(vl_api_##n##_t), 1);
695 * Set up the (msg_name, crc, message-id) table
697 setup_message_id_table (am);
702 VLIB_API_INIT_FUNCTION (ipsec_api_hookup);
705 * fd.io coding-style-patch-verification: ON
708 * eval: (c-set-style "gnu")