src/plugins/ikev2/ikev2.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   3  * Copyright (c) 2015-2020 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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 option version = "1.0.1";
  18
  19 import "plugins/ikev2/ikev2_types.api";
  20 import "vnet/ip/ip_types.api";
  21 import "vnet/interface_types.api";
  22
  23 /** \brief Get the plugin version
  24     @param client_index - opaque cookie to identify the sender
  25     @param context - sender context, to match reply w/ request
  26 */
  27 define ikev2_plugin_get_version
  28 {
  29   u32 client_index;
  30   u32 context;
  31 };
  32
  33 /** \brief Reply to get the plugin version
  34     @param context - returned sender context, to match reply w/ request
  35     @param major - Incremented every time a known breaking behavior change is introduced
  36     @param minor - Incremented with small changes, may be used to avoid buggy versions
  37 */
  38 define ikev2_plugin_get_version_reply
  39 {
  40   u32 context;
  41   u32 major;
  42   u32 minor;
  43 };
  44
  45 /** \brief Dump all profiles
  46     @param client_index - opaque cookie to identify the sender
  47     @param context - sender context, to match reply w/ request
  48 */
  49 define ikev2_profile_dump
  50 {
  51   u32 client_index;
  52   u32 context;
  53   option status="in_progress";
  54 };
  55
  56 /** \brief Details about all profiles
  57     @param context - returned sender context, to match reply w/ request
  58     @param profile - profile element with encapsulated attributes
  59 */
  60 define ikev2_profile_details
  61 {
  62   u32 context;
  63   vl_api_ikev2_profile_t profile;
  64   option status="in_progress";
  65 };
  66
  67 /** \brief Dump all SAs
  68     @param client_index - opaque cookie to identify the sender
  69     @param context - sender context, to match reply w/ request
  70 */
  71 define ikev2_sa_dump
  72 {
  73   u32 client_index;
  74   u32 context;
  75
  76   option status = "in_progress";
  77 };
  78
  79 /** \brief Details about IKE SA
  80     @param context - sender context, to match reply w/ request
  81     @param retval - return code
  82     @param sa - SA data
  83 */
  84 define ikev2_sa_details
  85 {
  86   u32 context;
  87   i32 retval;
  88
  89   vl_api_ikev2_sa_t sa;
  90   option status = "in_progress";
  91 };
  92
  93 /** \brief Dump child SA of specific SA
  94     @param client_index - opaque cookie to identify the sender
  95     @param context - sender context, to match reply w/ request
  96     @param sa_index - index of specific sa
  97 */
  98 define ikev2_child_sa_dump
  99 {
 100   u32 client_index;
 101   u32 context;
 102
 103   u32 sa_index;
 104   option vat_help = "sa_index <index>";
 105   option status = "in_progress";
 106 };
 107
 108 /** \brief Child SA details
 109     @param context - sender context, to match reply w/ request
 110     @param retval - return code
 111     @param child_sa - child SA data
 112 */
 113 define ikev2_child_sa_details
 114 {
 115   u32 context;
 116   i32 retval;
 117
 118   vl_api_ikev2_child_sa_t child_sa;
 119   option status = "in_progress";
 120 };
 121
 122 /** \brief get specific nonce
 123     @param client_index - opaque cookie to identify the sender
 124     @param context - sender context, to match reply w/ request
 125     @param is_initiator - specify type initiator|responder of nonce
 126     @param sa_index - index of specific sa
 127 */
 128 define ikev2_nonce_get
 129 {
 130   u32 client_index;
 131   u32 context;
 132
 133   bool is_initiator;
 134   u32 sa_index;
 135   option vat_help = "initiator|responder sa_index <index>";
 136   option status = "in_progress";
 137 };
 138
 139 /** \brief reply on specific nonce
 140     @param context - sender context, to match reply w/ request
 141     @param retval - return code
 142     @param data_len - nonce length
 143     @param nonce - nonce data
 144 */
 145
 146 define ikev2_nonce_get_reply
 147 {
 148   u32 context;
 149   i32 retval;
 150
 151   u32 data_len;
 152   u8 nonce[data_len];
 153   option status = "in_progress";
 154 };
 155
 156 /** \brief dump traffic selectors
 157     @param client_index - opaque cookie to identify the sender
 158     @param context - sender context, to match reply w/ request
 159     @param is_initiator - specify type initiator|responder of nonce
 160     @param sa_index - index of specific sa
 161     @param child_sa_index - index of specific sa child of specific sa
 162 */
 163
 164 define ikev2_traffic_selector_dump
 165 {
 166   u32 client_index;
 167   u32 context;
 168
 169   bool is_initiator;
 170   u32 sa_index;
 171   u32 child_sa_index;
 172   option vat_help = "initiator|responder sa_index <index> child_sa_index <index>";
 173   option status = "in_progress";
 174 };
 175
 176 /** \brief details on specific traffic selector
 177     @param context - sender context, to match reply w/ request
 178     @param retval - return code
 179     @param ts - traffic selector data
 180 */
 181
 182 define ikev2_traffic_selector_details
 183 {
 184   u32 context;
 185   i32 retval;
 186
 187   vl_api_ikev2_ts_t ts;
 188   option status = "in_progress";
 189 };
 190
 191 /** \brief IKEv2: Add/delete profile
 192     @param client_index - opaque cookie to identify the sender
 193     @param context - sender context, to match reply w/ request
 194     @param name - IKEv2 profile name
 195     @param is_add - Add IKEv2 profile if non-zero, else delete
 196 */
 197 autoreply define ikev2_profile_add_del
 198 {
 199   u32 client_index;
 200   u32 context;
 201
 202   string name[64];
 203   bool is_add;
 204   option vat_help = "name <profile_name> [del]";
 205   option status="in_progress";
 206 };
 207
 208 /** \brief IKEv2: Set IKEv2 profile authentication method
 209     @param client_index - opaque cookie to identify the sender
 210     @param context - sender context, to match reply w/ request
 211     @param name - IKEv2 profile name
 212     @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig)
 213     @param is_hex - Authentication data in hex format if non-zero, else string
 214     @param data_len - Authentication data length
 215     @param data - Authentication data (for rsa-sig cert file path)
 216 */
 217 autoreply define ikev2_profile_set_auth
 218 {
 219   u32 client_index;
 220   u32 context;
 221
 222   string name[64];
 223   u8 auth_method;
 224   bool is_hex;
 225   u32 data_len;
 226   u8 data[data_len];
 227   option vat_help = "name <profile_name> auth_method <method> (auth_data 0x<data> | auth_data <data>)";
 228   option status="in_progress";
 229 };
 230
 231 /** \brief IKEv2: Set IKEv2 profile local/remote identification
 232     @param client_index - opaque cookie to identify the sender
 233     @param context - sender context, to match reply w/ request
 234     @param name - IKEv2 profile name
 235     @param is_local - Identification is local if non-zero, else remote
 236     @param id_type - Identification type
 237     @param data_len - Identification data length
 238     @param data - Identification data
 239 */
 240 autoreply define ikev2_profile_set_id
 241 {
 242   u32 client_index;
 243   u32 context;
 244
 245   string name[64];
 246   bool is_local;
 247   u8 id_type;
 248   u32 data_len;
 249   u8 data[data_len];
 250   option vat_help = "name <profile_name> id_type <type> (id_data 0x<data> | id_data <data>) (local|remote)";
 251   option status="in_progress";
 252 };
 253
 254 /** \brief IKEv2: Set IKEv2 profile traffic selector parameters
 255     @param client_index - opaque cookie to identify the sender
 256     @param context - sender context, to match reply w/ request
 257     @param name - IKEv2 profile name
 258     @param ts - traffic selector data
 259 */
 260 autoreply define ikev2_profile_set_ts
 261 {
 262   u32 client_index;
 263   u32 context;
 264
 265   string name[64];
 266   vl_api_ikev2_ts_t ts;
 267   option vat_help = "name <profile_name> protocol <proto> start_port <port> end_port <port> start_addr <ip> end_addr <ip> (local|remote)";
 268   option status="in_progress";
 269 };
 270
 271 /** \brief IKEv2: Set IKEv2 local RSA private key
 272     @param client_index - opaque cookie to identify the sender
 273     @param context - sender context, to match reply w/ request
 274     @param key_file - Key file absolute path
 275 */
 276 autoreply define ikev2_set_local_key
 277 {
 278   u32 client_index;
 279   u32 context;
 280
 281   string key_file[256];
 282   option vat_help = "file <absolute_file_path>";
 283   option status="in_progress";
 284 };
 285
 286 /** \brief IKEv2: Set the tunnel interface which will be protected by IKE
 287     If this API is not called, a new tunnel will be created
 288     @param client_index - opaque cookie to identify the sender
 289     @param context - sender context, to match reply w/ request
 290     @param name - IKEv2 profile name
 291     @param sw_if_index - Of an existing tunnel
 292 */
 293 autoreply define ikev2_set_tunnel_interface
 294 {
 295   u32 client_index;
 296   u32 context;
 297   string name[64];
 298
 299   vl_api_interface_index_t sw_if_index;
 300   option status="in_progress";
 301 };
 302
 303 /** \brief IKEv2: Set IKEv2 responder interface and IP address
 304     @param client_index - opaque cookie to identify the sender
 305     @param context - sender context, to match reply w/ request
 306     @param name - IKEv2 profile name
 307     @param responder - responder data
 308 */
 309 autoreply define ikev2_set_responder
 310 {
 311   u32 client_index;
 312   u32 context;
 313
 314   string name[64];
 315   vl_api_ikev2_responder_t responder;
 316   option vat_help = "<profile_name> interface <interface> address <addr>";
 317   option status="in_progress";
 318 };
 319
 320 /** \brief IKEv2: Set IKEv2 IKE transforms in SA_INIT proposal (RFC 7296)
 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
 324     @param tr - IKE transforms
 325 */
 326 autoreply define ikev2_set_ike_transforms
 327 {
 328   u32 client_index;
 329   u32 context;
 330
 331   string name[64];
 332   vl_api_ikev2_ike_transforms_t tr;
 333   option vat_help = "<profile_name> <crypto alg> <key size> <integrity alg> <DH group>";
 334   option status="in_progress";
 335 };
 336
 337 /** \brief IKEv2: Set IKEv2 ESP transforms in SA_INIT proposal (RFC 7296)
 338     @param client_index - opaque cookie to identify the sender
 339     @param context - sender context, to match reply w/ request
 340     @param name - IKEv2 profile name
 341     @param tr - ESP transforms
 342 */
 343 autoreply define ikev2_set_esp_transforms
 344 {
 345   u32 client_index;
 346   u32 context;
 347
 348   string name[64];
 349   vl_api_ikev2_esp_transforms_t tr;
 350   option vat_help = "<profile_name> <crypto alg> <key size> <integrity alg>";
 351   option status="in_progress";
 352 };
 353
 354 /** \brief IKEv2: Set Child SA lifetime, limited by time and/or data
 355     @param client_index - opaque cookie to identify the sender
 356     @param context - sender context, to match reply w/ request
 357     @param name - IKEv2 profile name
 358     @param lifetime - SA maximum life time in seconds (0 to disable)
 359     @param lifetime_jitter - Jitter added to prevent simultaneous rekeying
 360     @param handover - Hand over time
 361     @param lifetime_maxdata - SA maximum life time in bytes (0 to disable)
 362 */
 363 autoreply define ikev2_set_sa_lifetime
 364 {
 365   u32 client_index;
 366   u32 context;
 367
 368   string name[64];
 369   u64 lifetime;
 370   u32 lifetime_jitter;
 371   u32 handover;
 372   u64 lifetime_maxdata;
 373   option vat_help = "<profile_name> <seconds> <jitter> <handover> <max bytes>";
 374   option status="in_progress";
 375 };
 376
 377 /** \brief IKEv2: Initiate the SA_INIT exchange
 378     @param client_index - opaque cookie to identify the sender
 379     @param context - sender context, to match reply w/ request
 380     @param name - IKEv2 profile name
 381 */
 382 autoreply define ikev2_initiate_sa_init
 383 {
 384   u32 client_index;
 385   u32 context;
 386
 387   string name[64];
 388   option vat_help = "<profile_name>";
 389   option status="in_progress";
 390 };
 391
 392 /** \brief IKEv2: Initiate the delete IKE SA exchange
 393     @param client_index - opaque cookie to identify the sender
 394     @param context - sender context, to match reply w/ request
 395     @param ispi - IKE SA initiator SPI
 396 */
 397 autoreply define ikev2_initiate_del_ike_sa
 398 {
 399   u32 client_index;
 400   u32 context;
 401
 402   u64 ispi;
 403   option vat_help = "<ispi>";
 404   option status="in_progress";
 405 };
 406
 407 /** \brief IKEv2: Initiate the delete Child SA exchange
 408     @param client_index - opaque cookie to identify the sender
 409     @param context - sender context, to match reply w/ request
 410     @param ispi - Child SA initiator SPI
 411 */
 412 autoreply define ikev2_initiate_del_child_sa
 413 {
 414   u32 client_index;
 415   u32 context;
 416
 417   u32 ispi;
 418   option vat_help = "<ispi>";
 419   option status="in_progress";
 420 };
 421
 422 /** \brief IKEv2: Initiate the rekey Child SA exchange
 423     @param client_index - opaque cookie to identify the sender
 424     @param context - sender context, to match reply w/ request
 425     @param ispi - Child SA initiator SPI
 426 */
 427 autoreply define ikev2_initiate_rekey_child_sa
 428 {
 429   u32 client_index;
 430   u32 context;
 431
 432   u32 ispi;
 433   option vat_help = "<ispi>";
 434   option status="in_progress";
 435 };
 436
 437 /** \brief IKEv2: Set UDP encapsulation
 438     @param client_index - opaque cookie to identify the sender
 439     @param context - sender context, to match reply w/ request
 440     @param name - IKEv2 profile name
 441 */
 442 autoreply define ikev2_profile_set_udp_encap
 443 {
 444   u32 client_index;
 445   u32 context;
 446
 447   string name[64];
 448   option status="in_progress";
 449 };
 450
 451 /** \brief IKEv2: Set/unset custom ipsec-over-udp port
 452     @param client_index - opaque cookie to identify the sender
 453     @param context - sender context, to match reply w/ request
 454     @param is_set - whether set or unset custom port
 455     @param port - port number
 456     @param name - IKEv2 profile name
 457 */
 458 autoreply define ikev2_profile_set_ipsec_udp_port
 459 {
 460   u32 client_index;
 461   u32 context;
 462
 463   u8 is_set;
 464   u16 port;
 465   string name[64];
 466   option status="in_progress";
 467 };
 468
 469 /** \brief IKEv2: Set liveness parameters
 470     @param client_index - opaque cookie to identify the sender
 471     @param context - sender context, to match reply w/ request
 472     @param period - how often is liveness check performed
 473     @param max_retries - max retries for liveness check
 474 */
 475 autoreply define ikev2_profile_set_liveness
 476 {
 477   u32 client_index;
 478   u32 context;
 479
 480   u32 period;
 481   u32 max_retries;
 482   option status="in_progress";
 483 };
 484
 485 /*
 486  * Local Variables:
 487  * eval: (c-set-style "gnu")
 488  * End:
 489  */