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)
63 static void vl_api_ipsec_spd_add_del_t_handler
64 (vl_api_ipsec_spd_add_del_t * mp)
67 clib_warning ("unimplemented");
70 vlib_main_t *vm __attribute__ ((unused)) = vlib_get_main ();
71 vl_api_ipsec_spd_add_del_reply_t *rmp;
75 rv = ipsec_add_del_spd (vm, ntohl (mp->spd_id), mp->is_add);
77 rv = VNET_API_ERROR_UNIMPLEMENTED;
80 REPLY_MACRO (VL_API_IPSEC_SPD_ADD_DEL_REPLY);
84 static void vl_api_ipsec_interface_add_del_spd_t_handler
85 (vl_api_ipsec_interface_add_del_spd_t * mp)
87 vlib_main_t *vm __attribute__ ((unused)) = vlib_get_main ();
88 vl_api_ipsec_interface_add_del_spd_reply_t *rmp;
90 u32 sw_if_index __attribute__ ((unused));
91 u32 spd_id __attribute__ ((unused));
93 sw_if_index = ntohl (mp->sw_if_index);
94 spd_id = ntohl (mp->spd_id);
96 VALIDATE_SW_IF_INDEX (mp);
99 rv = ipsec_set_interface_spd (vm, sw_if_index, spd_id, mp->is_add);
101 rv = VNET_API_ERROR_UNIMPLEMENTED;
104 BAD_SW_IF_INDEX_LABEL;
106 REPLY_MACRO (VL_API_IPSEC_INTERFACE_ADD_DEL_SPD_REPLY);
109 static void vl_api_ipsec_spd_add_del_entry_t_handler
110 (vl_api_ipsec_spd_add_del_entry_t * mp)
112 vlib_main_t *vm __attribute__ ((unused)) = vlib_get_main ();
113 vl_api_ipsec_spd_add_del_entry_reply_t *rmp;
119 memset (&p, 0, sizeof (p));
121 p.id = ntohl (mp->spd_id);
122 p.priority = ntohl (mp->priority);
123 p.is_outbound = mp->is_outbound;
124 p.is_ipv6 = mp->is_ipv6;
126 if (mp->is_ipv6 || mp->is_ip_any)
128 clib_memcpy (&p.raddr.start, mp->remote_address_start, 16);
129 clib_memcpy (&p.raddr.stop, mp->remote_address_stop, 16);
130 clib_memcpy (&p.laddr.start, mp->local_address_start, 16);
131 clib_memcpy (&p.laddr.stop, mp->local_address_stop, 16);
135 clib_memcpy (&p.raddr.start.ip4.data, mp->remote_address_start, 4);
136 clib_memcpy (&p.raddr.stop.ip4.data, mp->remote_address_stop, 4);
137 clib_memcpy (&p.laddr.start.ip4.data, mp->local_address_start, 4);
138 clib_memcpy (&p.laddr.stop.ip4.data, mp->local_address_stop, 4);
140 p.protocol = mp->protocol;
141 p.rport.start = ntohs (mp->remote_port_start);
142 p.rport.stop = ntohs (mp->remote_port_stop);
143 p.lport.start = ntohs (mp->local_port_start);
144 p.lport.stop = ntohs (mp->local_port_stop);
145 /* policy action resolve unsupported */
146 if (mp->policy == IPSEC_POLICY_ACTION_RESOLVE)
148 clib_warning ("unsupported action: 'resolve'");
149 rv = VNET_API_ERROR_UNIMPLEMENTED;
152 p.policy = mp->policy;
153 p.sa_id = ntohl (mp->sa_id);
155 rv = ipsec_add_del_policy (vm, &p, mp->is_add);
162 rv = ipsec_add_del_policy (vm, &p, mp->is_add);
165 rv = VNET_API_ERROR_UNIMPLEMENTED;
170 REPLY_MACRO (VL_API_IPSEC_SPD_ADD_DEL_ENTRY_REPLY);
173 static void vl_api_ipsec_sad_add_del_entry_t_handler
174 (vl_api_ipsec_sad_add_del_entry_t * mp)
176 vlib_main_t *vm __attribute__ ((unused)) = vlib_get_main ();
177 vl_api_ipsec_sad_add_del_entry_reply_t *rmp;
182 memset (&sa, 0, sizeof (sa));
184 sa.id = ntohl (mp->sad_id);
185 sa.spi = ntohl (mp->spi);
186 /* security protocol AH unsupported */
187 if (mp->protocol == IPSEC_PROTOCOL_AH)
189 clib_warning ("unsupported security protocol 'AH'");
190 rv = VNET_API_ERROR_UNIMPLEMENTED;
193 sa.protocol = mp->protocol;
194 /* check for unsupported crypto-alg */
195 if (mp->crypto_algorithm < IPSEC_CRYPTO_ALG_AES_CBC_128 ||
196 mp->crypto_algorithm >= IPSEC_CRYPTO_N_ALG)
198 clib_warning ("unsupported crypto-alg: '%U'", format_ipsec_crypto_alg,
199 mp->crypto_algorithm);
200 rv = VNET_API_ERROR_UNIMPLEMENTED;
203 sa.crypto_alg = mp->crypto_algorithm;
204 sa.crypto_key_len = mp->crypto_key_length;
205 clib_memcpy (&sa.crypto_key, mp->crypto_key, sizeof (sa.crypto_key));
206 /* check for unsupported integ-alg */
208 if (mp->integrity_algorithm < IPSEC_INTEG_ALG_NONE ||
210 if (mp->integrity_algorithm < IPSEC_INTEG_ALG_SHA1_96 ||
212 mp->integrity_algorithm >= IPSEC_INTEG_N_ALG)
214 clib_warning ("unsupported integ-alg: '%U'", format_ipsec_integ_alg,
215 mp->integrity_algorithm);
216 rv = VNET_API_ERROR_UNIMPLEMENTED;
221 /*Special cases, aes-gcm-128 encryption */
222 if (mp->crypto_algorithm == IPSEC_CRYPTO_ALG_AES_GCM_128)
224 if (mp->integrity_algorithm != IPSEC_INTEG_ALG_NONE
225 && mp->integrity_algorithm != IPSEC_INTEG_ALG_AES_GCM_128)
228 ("unsupported: aes-gcm-128 crypto-alg needs none as integ-alg");
229 rv = VNET_API_ERROR_UNIMPLEMENTED;
232 else /*set integ-alg internally to aes-gcm-128 */
233 mp->integrity_algorithm = IPSEC_INTEG_ALG_AES_GCM_128;
235 else if (mp->integrity_algorithm == IPSEC_INTEG_ALG_AES_GCM_128)
237 clib_warning ("unsupported integ-alg: aes-gcm-128");
238 rv = VNET_API_ERROR_UNIMPLEMENTED;
241 else if (mp->integrity_algorithm == IPSEC_INTEG_ALG_NONE)
243 clib_warning ("unsupported integ-alg: none");
244 rv = VNET_API_ERROR_UNIMPLEMENTED;
249 sa.integ_alg = mp->integrity_algorithm;
250 sa.integ_key_len = mp->integrity_key_length;
251 clib_memcpy (&sa.integ_key, mp->integrity_key, sizeof (sa.integ_key));
252 sa.use_esn = mp->use_extended_sequence_number;
253 sa.is_tunnel = mp->is_tunnel;
254 sa.is_tunnel_ip6 = mp->is_tunnel_ipv6;
255 if (sa.is_tunnel_ip6)
257 clib_memcpy (&sa.tunnel_src_addr, mp->tunnel_src_address, 16);
258 clib_memcpy (&sa.tunnel_dst_addr, mp->tunnel_dst_address, 16);
262 clib_memcpy (&sa.tunnel_src_addr.ip4.data, mp->tunnel_src_address, 4);
263 clib_memcpy (&sa.tunnel_dst_addr.ip4.data, mp->tunnel_dst_address, 4);
266 rv = ipsec_add_del_sa (vm, &sa, mp->is_add);
268 rv = VNET_API_ERROR_UNIMPLEMENTED;
273 REPLY_MACRO (VL_API_IPSEC_SAD_ADD_DEL_ENTRY_REPLY);
277 send_ipsec_spd_details (ipsec_policy_t * p, unix_shared_memory_queue_t * q,
280 vl_api_ipsec_spd_details_t *mp;
282 mp = vl_msg_api_alloc (sizeof (*mp));
283 memset (mp, 0, sizeof (*mp));
284 mp->_vl_msg_id = ntohs (VL_API_IPSEC_SPD_DETAILS);
285 mp->context = context;
287 mp->spd_id = htonl (p->id);
288 mp->priority = htonl (p->priority);
289 mp->is_outbound = p->is_outbound;
290 mp->is_ipv6 = p->is_ipv6;
293 memcpy (mp->local_start_addr, &p->laddr.start.ip6, 16);
294 memcpy (mp->local_stop_addr, &p->laddr.stop.ip6, 16);
295 memcpy (mp->remote_start_addr, &p->raddr.start.ip6, 16);
296 memcpy (mp->remote_stop_addr, &p->raddr.stop.ip6, 16);
300 memcpy (mp->local_start_addr, &p->laddr.start.ip4, 4);
301 memcpy (mp->local_stop_addr, &p->laddr.stop.ip4, 4);
302 memcpy (mp->remote_start_addr, &p->raddr.start.ip4, 4);
303 memcpy (mp->remote_stop_addr, &p->raddr.stop.ip4, 4);
305 mp->local_start_port = htons (p->lport.start);
306 mp->local_stop_port = htons (p->lport.stop);
307 mp->remote_start_port = htons (p->rport.start);
308 mp->remote_stop_port = htons (p->rport.stop);
309 mp->protocol = p->protocol;
310 mp->policy = p->policy;
311 mp->sa_id = htonl (p->sa_id);
312 mp->bytes = clib_host_to_net_u64 (p->counter.bytes);
313 mp->packets = clib_host_to_net_u64 (p->counter.packets);
315 vl_msg_api_send_shmem (q, (u8 *) & mp);
319 vl_api_ipsec_spd_dump_t_handler (vl_api_ipsec_spd_dump_t * mp)
321 unix_shared_memory_queue_t *q;
322 ipsec_main_t *im = &ipsec_main;
323 ipsec_policy_t *policy;
328 q = vl_api_client_index_to_input_queue (mp->client_index);
332 p = hash_get (im->spd_index_by_spd_id, ntohl (mp->spd_id));
337 spd = pool_elt_at_index (im->spds, spd_index);
340 pool_foreach (policy, spd->policies,
342 if (mp->sa_id == ~(0) || ntohl (mp->sa_id) == policy->sa_id)
343 send_ipsec_spd_details (policy, q,
348 clib_warning ("unimplemented");
353 vl_api_ipsec_sa_set_key_t_handler (vl_api_ipsec_sa_set_key_t * mp)
355 vlib_main_t *vm __attribute__ ((unused)) = vlib_get_main ();
356 vl_api_ipsec_sa_set_key_reply_t *rmp;
360 sa.id = ntohl (mp->sa_id);
361 sa.crypto_key_len = mp->crypto_key_length;
362 clib_memcpy (&sa.crypto_key, mp->crypto_key, sizeof (sa.crypto_key));
363 sa.integ_key_len = mp->integrity_key_length;
364 clib_memcpy (&sa.integ_key, mp->integrity_key, sizeof (sa.integ_key));
366 rv = ipsec_set_sa_key (vm, &sa);
368 rv = VNET_API_ERROR_UNIMPLEMENTED;
371 REPLY_MACRO (VL_API_IPSEC_SA_SET_KEY_REPLY);
375 vl_api_ikev2_profile_add_del_t_handler (vl_api_ikev2_profile_add_del_t * mp)
377 vl_api_ikev2_profile_add_del_reply_t *rmp;
381 vlib_main_t *vm = vlib_get_main ();
383 u8 *tmp = format (0, "%s", mp->name);
384 error = ikev2_add_del_profile (vm, tmp, mp->is_add);
387 rv = VNET_API_ERROR_UNSPECIFIED;
389 rv = VNET_API_ERROR_UNIMPLEMENTED;
392 REPLY_MACRO (VL_API_IKEV2_PROFILE_ADD_DEL_REPLY);
396 vl_api_ikev2_profile_set_auth_t_handler
397 (vl_api_ikev2_profile_set_auth_t * mp)
399 vl_api_ikev2_profile_set_auth_reply_t *rmp;
403 vlib_main_t *vm = vlib_get_main ();
405 u8 *tmp = format (0, "%s", mp->name);
406 u8 *data = vec_new (u8, mp->data_len);
407 clib_memcpy (data, mp->data, mp->data_len);
408 error = ikev2_set_profile_auth (vm, tmp, mp->auth_method, data, mp->is_hex);
412 rv = VNET_API_ERROR_UNSPECIFIED;
414 rv = VNET_API_ERROR_UNIMPLEMENTED;
417 REPLY_MACRO (VL_API_IKEV2_PROFILE_SET_AUTH_REPLY);
421 vl_api_ikev2_profile_set_id_t_handler (vl_api_ikev2_profile_set_id_t * mp)
423 vl_api_ikev2_profile_add_del_reply_t *rmp;
427 vlib_main_t *vm = vlib_get_main ();
429 u8 *tmp = format (0, "%s", mp->name);
430 u8 *data = vec_new (u8, mp->data_len);
431 clib_memcpy (data, mp->data, mp->data_len);
432 error = ikev2_set_profile_id (vm, tmp, mp->id_type, data, mp->is_local);
436 rv = VNET_API_ERROR_UNSPECIFIED;
438 rv = VNET_API_ERROR_UNIMPLEMENTED;
441 REPLY_MACRO (VL_API_IKEV2_PROFILE_SET_ID_REPLY);
445 vl_api_ikev2_profile_set_ts_t_handler (vl_api_ikev2_profile_set_ts_t * mp)
447 vl_api_ikev2_profile_set_ts_reply_t *rmp;
451 vlib_main_t *vm = vlib_get_main ();
453 u8 *tmp = format (0, "%s", mp->name);
454 error = ikev2_set_profile_ts (vm, tmp, mp->proto, mp->start_port,
455 mp->end_port, (ip4_address_t) mp->start_addr,
456 (ip4_address_t) mp->end_addr, mp->is_local);
459 rv = VNET_API_ERROR_UNSPECIFIED;
461 rv = VNET_API_ERROR_UNIMPLEMENTED;
464 REPLY_MACRO (VL_API_IKEV2_PROFILE_SET_TS_REPLY);
468 vl_api_ikev2_set_local_key_t_handler (vl_api_ikev2_set_local_key_t * mp)
470 vl_api_ikev2_profile_set_ts_reply_t *rmp;
474 vlib_main_t *vm = vlib_get_main ();
477 error = ikev2_set_local_key (vm, mp->key_file);
479 rv = VNET_API_ERROR_UNSPECIFIED;
481 rv = VNET_API_ERROR_UNIMPLEMENTED;
484 REPLY_MACRO (VL_API_IKEV2_SET_LOCAL_KEY_REPLY);
489 * Add vpe's API message handlers to the table.
490 * vlib has alread mapped shared memory and
491 * added the client registration handlers.
492 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
494 #define vl_msg_name_crc_list
495 #include <vnet/vnet_all_api_h.h>
496 #undef vl_msg_name_crc_list
499 setup_message_id_table (api_main_t * am)
501 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
502 foreach_vl_msg_name_crc_ipsec;
506 static clib_error_t *
507 ipsec_api_hookup (vlib_main_t * vm)
509 api_main_t *am = &api_main;
512 vl_msg_api_set_handlers(VL_API_##N, #n, \
513 vl_api_##n##_t_handler, \
515 vl_api_##n##_t_endian, \
516 vl_api_##n##_t_print, \
517 sizeof(vl_api_##n##_t), 1);
522 * Set up the (msg_name, crc, message-id) table
524 setup_message_id_table (am);
529 VLIB_API_INIT_FUNCTION (ipsec_api_hookup);
532 * fd.io coding-style-patch-verification: ON
535 * eval: (c-set-style "gnu")