1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2015-2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 option version = "1.0.1";
19 import "vnet/ip/ip_types.api";
20 import "vnet/interface_types.api";
22 /** \brief Get the plugin version
23 @param client_index - opaque cookie to identify the sender
24 @param context - sender context, to match reply w/ request
26 define ikev2_plugin_get_version
32 /** \brief Reply to get the plugin version
33 @param context - returned sender context, to match reply w/ request
34 @param major - Incremented every time a known breaking behavior change is introduced
35 @param minor - Incremented with small changes, may be used to avoid buggy versions
37 define ikev2_plugin_get_version_reply
44 /** \brief IKEv2: Add/delete profile
45 @param client_index - opaque cookie to identify the sender
46 @param context - sender context, to match reply w/ request
48 @param name - IKEv2 profile name
49 @param is_add - Add IKEv2 profile if non-zero, else delete
51 autoreply define ikev2_profile_add_del
58 option vat_help = "name <profile_name> [del]";
61 /** \brief IKEv2: Set IKEv2 profile authentication method
62 @param client_index - opaque cookie to identify the sender
63 @param context - sender context, to match reply w/ request
65 @param name - IKEv2 profile name
66 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
67 @param is_hex - Authentication data in hex format if non-zero, else string
68 @param data_len - Authentication data length
69 @param data - Authentication data (for rsa-sig cert file path)
71 autoreply define ikev2_profile_set_auth
81 option vat_help = "name <profile_name> auth_method <method> (auth_data 0x<data> | auth_data <data>)";
84 /** \brief IKEv2: Set IKEv2 profile local/remote identification
85 @param client_index - opaque cookie to identify the sender
86 @param context - sender context, to match reply w/ request
88 @param name - IKEv2 profile name
89 @param is_local - Identification is local if non-zero, else remote
90 @param id_type - Identification type
91 @param data_len - Identification data length
92 @param data - Identification data
94 autoreply define ikev2_profile_set_id
104 option vat_help = "name <profile_name> id_type <type> (id_data 0x<data> | id_data <data>) (local|remote)";
107 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
108 @param client_index - opaque cookie to identify the sender
109 @param context - sender context, to match reply w/ request
111 @param name - IKEv2 profile name
112 @param is_local - Traffic selector is local if non-zero, else remote
113 @param proto - Traffic selector IP protocol (if zero not relevant)
114 @param start_port - The smallest port number allowed by traffic selector
115 @param end_port - The largest port number allowed by traffic selector
116 @param start_addr - The smallest address included in traffic selector
117 @param end_addr - The largest address included in traffic selector
119 autoreply define ikev2_profile_set_ts
131 option vat_help = "name <profile_name> protocol <proto> start_port <port> end_port <port> start_addr <ip4> end_addr <ip4> (local|remote)";
134 /** \brief IKEv2: Set IKEv2 local RSA private key
135 @param client_index - opaque cookie to identify the sender
136 @param context - sender context, to match reply w/ request
138 @param key_file - Key file absolute path
140 autoreply define ikev2_set_local_key
146 option vat_help = "file <absolute_file_path>";
149 /** \brief IKEv2: Set the tunnel interface which will be protected by IKE
150 If this API is not called, a new tunnel will be created
151 @param client_index - opaque cookie to identify the sender
152 @param context - sender context, to match reply w/ request
153 @param name - IKEv2 profile name
154 @param sw_if_index - Of an existing tunnel
156 autoreply define ikev2_set_tunnel_interface
162 vl_api_interface_index_t sw_if_index;
165 /** \brief IKEv2: Set IKEv2 responder interface and IP address
166 @param client_index - opaque cookie to identify the sender
167 @param context - sender context, to match reply w/ request
169 @param name - IKEv2 profile name
170 @param sw_if_index - interface index
171 @param address - interface address
173 autoreply define ikev2_set_responder
179 vl_api_interface_index_t sw_if_index;
180 vl_api_ip4_address_t address;
181 option vat_help = "<profile_name> interface <interface> address <addr>";
184 /** \brief IKEv2: Set IKEv2 IKE transforms in SA_INIT proposal (RFC 7296)
185 @param client_index - opaque cookie to identify the sender
186 @param context - sender context, to match reply w/ request
188 @param name - IKEv2 profile name
189 @param crypto_alg - encryption algorithm
190 @param crypto_key_size - encryption key size
191 @param integ_alg - integrity algorithm
192 @param dh_group - Diffie-Hellman group
195 autoreply define ikev2_set_ike_transforms
205 option vat_help = "<profile_name> <crypto alg> <key size> <integrity alg> <DH group>";
208 /** \brief IKEv2: Set IKEv2 ESP transforms in SA_INIT proposal (RFC 7296)
209 @param client_index - opaque cookie to identify the sender
210 @param context - sender context, to match reply w/ request
212 @param name - IKEv2 profile name
213 @param crypto_alg - encryption algorithm
214 @param crypto_key_size - encryption key size
215 @param integ_alg - integrity algorithm
216 @param dh_group - Diffie-Hellman group
219 autoreply define ikev2_set_esp_transforms
229 option vat_help = "<profile_name> <crypto alg> <key size> <integrity alg> <DH group>";
232 /** \brief IKEv2: Set Child SA lifetime, limited by time and/or data
233 @param client_index - opaque cookie to identify the sender
234 @param context - sender context, to match reply w/ request
236 @param name - IKEv2 profile name
237 @param lifetime - SA maximum life time in seconds (0 to disable)
238 @param lifetime_jitter - Jitter added to prevent simultaneous rekeying
239 @param handover - Hand over time
240 @param lifetime_maxdata - SA maximum life time in bytes (0 to disable)
243 autoreply define ikev2_set_sa_lifetime
252 u64 lifetime_maxdata;
253 option vat_help = "<profile_name> <seconds> <jitter> <handover> <max bytes>";
256 /** \brief IKEv2: Initiate the SA_INIT exchange
257 @param client_index - opaque cookie to identify the sender
258 @param context - sender context, to match reply w/ request
260 @param name - IKEv2 profile name
263 autoreply define ikev2_initiate_sa_init
269 option vat_help = "<profile_name>";
272 /** \brief IKEv2: Initiate the delete IKE SA exchange
273 @param client_index - opaque cookie to identify the sender
274 @param context - sender context, to match reply w/ request
276 @param ispi - IKE SA initiator SPI
279 autoreply define ikev2_initiate_del_ike_sa
285 option vat_help = "<ispi>";
288 /** \brief IKEv2: Initiate the delete Child SA exchange
289 @param client_index - opaque cookie to identify the sender
290 @param context - sender context, to match reply w/ request
292 @param ispi - Child SA initiator SPI
295 autoreply define ikev2_initiate_del_child_sa
301 option vat_help = "<ispi>";
304 /** \brief IKEv2: Initiate the rekey Child SA exchange
305 @param client_index - opaque cookie to identify the sender
306 @param context - sender context, to match reply w/ request
308 @param ispi - Child SA initiator SPI
311 autoreply define ikev2_initiate_rekey_child_sa
317 option vat_help = "<ispi>";
320 /** \brief IKEv2: Set UDP encapsulation
321 @param client_index - opaque cookie to identify the sender
322 @param context - sender context, to match reply w/ request
323 @param name - IKEv2 profile name
325 autoreply define ikev2_profile_set_udp_encap
333 /** \brief IKEv2: Set/unset custom ipsec-over-udp port
334 @param client_index - opaque cookie to identify the sender
335 @param context - sender context, to match reply w/ request
336 @param is_set - whether set or unset custom port
337 @param port - port number
338 @param name - IKEv2 profile name
340 autoreply define ikev2_profile_set_ipsec_udp_port
350 /** \brief IKEv2: Set liveness parameters
351 @param client_index - opaque cookie to identify the sender
352 @param context - sender context, to match reply w/ request
353 @param period - how often is liveness check performed
354 @param max_retries - max retries for liveness check
356 autoreply define ikev2_profile_set_liveness
367 * eval: (c-set-style "gnu")