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.0";
19 /** \brief Get the plugin version
20 @param client_index - opaque cookie to identify the sender
21 @param context - sender context, to match reply w/ request
23 define ikev2_plugin_get_version
29 /** \brief Reply to get the plugin version
30 @param context - returned sender context, to match reply w/ request
31 @param major - Incremented every time a known breaking behavior change is introduced
32 @param minor - Incremented with small changes, may be used to avoid buggy versions
34 define ikev2_plugin_get_version_reply
41 /** \brief IKEv2: Add/delete profile
42 @param client_index - opaque cookie to identify the sender
43 @param context - sender context, to match reply w/ request
45 @param name - IKEv2 profile name
46 @param is_add - Add IKEv2 profile if non-zero, else delete
48 autoreply define ikev2_profile_add_del
55 option vat_help = "name <profile_name> [del]";
58 /** \brief IKEv2: Set IKEv2 profile authentication method
59 @param client_index - opaque cookie to identify the sender
60 @param context - sender context, to match reply w/ request
62 @param name - IKEv2 profile name
63 @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
64 @param is_hex - Authentication data in hex format if non-zero, else string
65 @param data_len - Authentication data length
66 @param data - Authentication data (for rsa-sig cert file path)
68 autoreply define ikev2_profile_set_auth
78 option vat_help = "name <profile_name> auth_method <method> (auth_data 0x<data> | auth_data <data>)";
81 /** \brief IKEv2: Set IKEv2 profile local/remote identification
82 @param client_index - opaque cookie to identify the sender
83 @param context - sender context, to match reply w/ request
85 @param name - IKEv2 profile name
86 @param is_local - Identification is local if non-zero, else remote
87 @param id_type - Identification type
88 @param data_len - Identification data length
89 @param data - Identification data
91 autoreply define ikev2_profile_set_id
101 option vat_help = "name <profile_name> id_type <type> (id_data 0x<data> | id_data <data>) (local|remote)";
104 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
105 @param client_index - opaque cookie to identify the sender
106 @param context - sender context, to match reply w/ request
108 @param name - IKEv2 profile name
109 @param is_local - Traffic selector is local if non-zero, else remote
110 @param proto - Traffic selector IP protocol (if zero not relevant)
111 @param start_port - The smallest port number allowed by traffic selector
112 @param end_port - The largest port number allowed by traffic selector
113 @param start_addr - The smallest address included in traffic selector
114 @param end_addr - The largest address included in traffic selector
116 autoreply define ikev2_profile_set_ts
128 option vat_help = "name <profile_name> protocol <proto> start_port <port> end_port <port> start_addr <ip4> end_addr <ip4> (local|remote)";
131 /** \brief IKEv2: Set IKEv2 local RSA private key
132 @param client_index - opaque cookie to identify the sender
133 @param context - sender context, to match reply w/ request
135 @param key_file - Key file absolute path
137 autoreply define ikev2_set_local_key
143 option vat_help = "file <absolute_file_path>";
146 /** \brief IKEv2: Set IKEv2 responder interface and IP address
147 @param client_index - opaque cookie to identify the sender
148 @param context - sender context, to match reply w/ request
150 @param name - IKEv2 profile name
151 @param sw_if_index - interface index
152 @param address - interface address
154 autoreply define ikev2_set_responder
162 option vat_help = "<profile_name> interface <interface> address <addr>";
165 /** \brief IKEv2: Set IKEv2 IKE transforms in SA_INIT proposal (RFC 7296)
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 crypto_alg - encryption algorithm
171 @param crypto_key_size - encryption key size
172 @param integ_alg - integrity algorithm
173 @param dh_group - Diffie-Hellman group
176 autoreply define ikev2_set_ike_transforms
186 option vat_help = "<profile_name> <crypto alg> <key size> <integrity alg> <DH group>";
189 /** \brief IKEv2: Set IKEv2 ESP transforms in SA_INIT proposal (RFC 7296)
190 @param client_index - opaque cookie to identify the sender
191 @param context - sender context, to match reply w/ request
193 @param name - IKEv2 profile name
194 @param crypto_alg - encryption algorithm
195 @param crypto_key_size - encryption key size
196 @param integ_alg - integrity algorithm
197 @param dh_group - Diffie-Hellman group
200 autoreply define ikev2_set_esp_transforms
210 option vat_help = "<profile_name> <crypto alg> <key size> <integrity alg> <DH group>";
213 /** \brief IKEv2: Set Child SA lifetime, limited by time and/or data
214 @param client_index - opaque cookie to identify the sender
215 @param context - sender context, to match reply w/ request
217 @param name - IKEv2 profile name
218 @param lifetime - SA maximum life time in seconds (0 to disable)
219 @param lifetime_jitter - Jitter added to prevent simultaneous rekeying
220 @param handover - Hand over time
221 @param lifetime_maxdata - SA maximum life time in bytes (0 to disable)
224 autoreply define ikev2_set_sa_lifetime
233 u64 lifetime_maxdata;
234 option vat_help = "<profile_name> <seconds> <jitter> <handover> <max bytes>";
237 /** \brief IKEv2: Initiate the SA_INIT exchange
238 @param client_index - opaque cookie to identify the sender
239 @param context - sender context, to match reply w/ request
241 @param name - IKEv2 profile name
244 autoreply define ikev2_initiate_sa_init
250 option vat_help = "<profile_name>";
253 /** \brief IKEv2: Initiate the delete IKE SA exchange
254 @param client_index - opaque cookie to identify the sender
255 @param context - sender context, to match reply w/ request
257 @param ispi - IKE SA initiator SPI
260 autoreply define ikev2_initiate_del_ike_sa
266 option vat_help = "<ispi>";
269 /** \brief IKEv2: Initiate the delete Child SA exchange
270 @param client_index - opaque cookie to identify the sender
271 @param context - sender context, to match reply w/ request
273 @param ispi - Child SA initiator SPI
276 autoreply define ikev2_initiate_del_child_sa
282 option vat_help = "<ispi>";
285 /** \brief IKEv2: Initiate the rekey Child SA exchange
286 @param client_index - opaque cookie to identify the sender
287 @param context - sender context, to match reply w/ request
289 @param ispi - Child SA initiator SPI
292 autoreply define ikev2_initiate_rekey_child_sa
298 option vat_help = "<ispi>";
303 * eval: (c-set-style "gnu")