src/vnet/ipsec/ipsec.api

   1 /* Hey Emacs use -*- mode: C -*- */
   2 /*
   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:
   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 = "3.0.0";
  18
  19 import "vnet/ip/ip_types.api";
  20
  21 /** \brief IPsec: Add/delete Security Policy Database
  22     @param client_index - opaque cookie to identify the sender
  23     @param context - sender context, to match reply w/ request
  24     @param is_add - add SPD if non-zero, else delete
  25     @param spd_id - SPD instance id (control plane allocated)
  26 */
  27
  28 autoreply define ipsec_spd_add_del
  29 {
  30   u32 client_index;
  31   u32 context;
  32   u8 is_add;
  33   u32 spd_id;
  34 };
  35
  36 /** \brief IPsec: Add/delete SPD from interface
  37
  38     @param client_index - opaque cookie to identify the sender
  39     @param context - sender context, to match reply w/ request
  40     @param is_add - add security mode if non-zero, else delete
  41     @param sw_if_index - index of the interface
  42     @param spd_id - SPD instance id to use for lookups
  43 */
  44
  45
  46 autoreply define ipsec_interface_add_del_spd
  47 {
  48   u32 client_index;
  49   u32 context;
  50
  51   u8 is_add;
  52   u32 sw_if_index;
  53   u32 spd_id;
  54 };
  55
  56
  57 enum ipsec_spd_action
  58 {
  59   /* bypass - no IPsec processing */
  60   IPSEC_API_SPD_ACTION_BYPASS = 0,
  61   /* discard - discard packet with ICMP processing */
  62   IPSEC_API_SPD_ACTION_DISCARD,
  63   /* resolve - send request to control plane for SA resolving */
  64   IPSEC_API_SPD_ACTION_RESOLVE,
  65   /* protect - apply IPsec policy using following parameters */
  66   IPSEC_API_SPD_ACTION_PROTECT,
  67 };
  68
  69 /** \brief IPsec: Security Policy Database entry
  70
  71     See RFC 4301, 4.4.1.1 on how to match packet to selectors
  72
  73     @param spd_id - SPD instance id (control plane allocated)
  74     @param priority - priority of SPD entry (non-unique value).  Used to order SPD matching - higher priorities match before lower
  75     @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic
  76     @param remote_address_start - start of remote address range to match
  77     @param remote_address_stop - end of remote address range to match
  78     @param local_address_start - start of local address range to match
  79     @param local_address_stop - end of local address range to match
  80     @param protocol - protocol type to match [0 means any] otherwise IANA value
  81     @param remote_port_start - start of remote port range to match ...
  82     @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
  83     @param local_port_start - start of local port range to match ...
  84     @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE]
  85     @param policy - action to perform on match
  86     @param sa_id - SAD instance id (control plane allocated)
  87 */
  88 typedef ipsec_spd_entry
  89 {
  90   u32 spd_id;
  91   i32 priority;
  92   u8 is_outbound;
  93
  94   u32 sa_id;
  95   vl_api_ipsec_spd_action_t policy;
  96   u8 protocol;
  97
  98   // Selector
  99   vl_api_address_t remote_address_start;
 100   vl_api_address_t remote_address_stop;
 101   vl_api_address_t local_address_start;
 102   vl_api_address_t local_address_stop;
 103
 104   u16 remote_port_start;
 105   u16 remote_port_stop;
 106   u16 local_port_start;
 107   u16 local_port_stop;
 108 };
 109
 110 /** \brief IPsec: Add/delete Security Policy Database entry
 111
 112     @param client_index - opaque cookie to identify the sender
 113     @param context - sender context, to match reply w/ request
 114     @param is_add - add SPD if non-zero, else delete
 115     @param entry - Description of the entry to add/dell
 116 */
 117 define ipsec_spd_entry_add_del
 118 {
 119   u32 client_index;
 120   u32 context;
 121   u8 is_add;
 122   vl_api_ipsec_spd_entry_t entry;
 123 };
 124
 125 /** \brief IPsec: Reply Add/delete Security Policy Database entry
 126
 127     @param context - sender context, to match reply w/ request
 128     @param retval - success/fail rutrun code
 129     @param stat_index - An index for the policy in the stats segment @ /net/ipec/policy
 130 */
 131 define ipsec_spd_entry_add_del_reply
 132 {
 133   u32 context;
 134   i32 retval;
 135   u32 stat_index;
 136 };
 137
 138 /** \brief Dump IPsec all SPD IDs
 139     @param client_index - opaque cookie to identify the sender
 140     @param context - sender context, to match reply w/ request
 141 */
 142 define ipsec_spds_dump {
 143   u32 client_index;
 144   u32 context;
 145 };
 146
 147 /** \brief Dump IPsec all SPD IDs response
 148     @param client_index - opaque cookie to identify the sender
 149     @param spd_id - SPD instance id (control plane allocated)
 150     @param npolicies - number of policies in SPD
 151 */
 152 define ipsec_spds_details {
 153   u32 context;
 154   u32 spd_id;
 155   u32 npolicies;
 156 };
 157
 158 /** \brief Dump ipsec policy database data
 159     @param client_index - opaque cookie to identify the sender
 160     @param context - sender context, to match reply w/ request
 161     @param spd_id - SPD instance id
 162     @param sa_id - SA id, optional, set to ~0 to see all policies in SPD
 163 */
 164 define ipsec_spd_dump {
 165     u32 client_index;
 166     u32 context;
 167     u32 spd_id;
 168     u32 sa_id;
 169 };
 170
 171 /** \brief IPsec policy database response
 172     @param context - sender context which was passed in the request
 173     €param entry - The SPD entry.
 174     @param bytes - byte count of packets matching this policy
 175     @param packets - count of packets matching this policy
 176 */
 177 define ipsec_spd_details {
 178     u32 context;
 179     vl_api_ipsec_spd_entry_t entry;
 180 };
 181
 182 /*
 183  * @brief Support cryptographic algorithms
 184  */
 185 enum ipsec_crypto_alg
 186 {
 187   IPSEC_API_CRYPTO_ALG_NONE = 0,
 188   IPSEC_API_CRYPTO_ALG_AES_CBC_128,
 189   IPSEC_API_CRYPTO_ALG_AES_CBC_192,
 190   IPSEC_API_CRYPTO_ALG_AES_CBC_256,
 191   IPSEC_API_CRYPTO_ALG_AES_CTR_128,
 192   IPSEC_API_CRYPTO_ALG_AES_CTR_192,
 193   IPSEC_API_CRYPTO_ALG_AES_CTR_256,
 194   IPSEC_API_CRYPTO_ALG_AES_GCM_128,
 195   IPSEC_API_CRYPTO_ALG_AES_GCM_192,
 196   IPSEC_API_CRYPTO_ALG_AES_GCM_256,
 197   IPSEC_API_CRYPTO_ALG_DES_CBC,
 198   IPSEC_API_CRYPTO_ALG_3DES_CBC,
 199 };
 200
 201 /*
 202  * @brief Supported Integrity Algorithms
 203  */
 204 enum ipsec_integ_alg
 205 {
 206   IPSEC_API_INTEG_ALG_NONE = 0,
 207   /* RFC2403 */
 208   IPSEC_API_INTEG_ALG_MD5_96,
 209   /* RFC2404 */
 210   IPSEC_API_INTEG_ALG_SHA1_96,
 211   /* draft-ietf-ipsec-ciph-sha-256-00 */
 212   IPSEC_API_INTEG_ALG_SHA_256_96,
 213   /* RFC4868 */
 214   IPSEC_API_INTEG_ALG_SHA_256_128,
 215   /* RFC4868 */
 216   IPSEC_API_INTEG_ALG_SHA_384_192,
 217   /* RFC4868 */
 218   IPSEC_API_INTEG_ALG_SHA_512_256,
 219 };
 220
 221 enum ipsec_sad_flags
 222 {
 223   IPSEC_API_SAD_FLAG_NONE = 0,
 224   /* Enable extended sequence numbers */
 225   IPSEC_API_SAD_FLAG_USE_EXTENDED_SEQ_NUM = 0x01,
 226   /* Enable Anti-replay */
 227   IPSEC_API_SAD_FLAG_USE_ANTI_REPLAY = 0x02,
 228   /* IPsec tunnel mode if non-zero, else transport mode */
 229   IPSEC_API_SAD_FLAG_IS_TUNNEL = 0x04,
 230   /* IPsec tunnel mode is IPv6 if non-zero,
 231    *  else IPv4 tunnel only valid if is_tunnel is non-zero */
 232   IPSEC_API_SAD_FLAG_IS_TUNNEL_V6 = 0x08,
 233   /* enable UDP encapsulation for NAT traversal */
 234   IPSEC_API_SAD_FLAG_UDP_ENCAP = 0x10,
 235
 236   /* come-on Ole please fix this */
 237   IPSEC_API_SAD_COMBO_12 = 12,
 238   IPSEC_API_SAD_COMBO_20 = 20,
 239 };
 240
 241 enum ipsec_proto
 242 {
 243   IPSEC_API_PROTO_ESP,
 244   IPSEC_API_PROTO_AH,
 245 };
 246
 247 typedef key
 248 {
 249   /* the length of the key */
 250   u8 length;
 251   /* The data for the key */
 252   u8 data[128];
 253 };
 254
 255 /** \brief IPsec: Security Association Database entry
 256     @param client_index - opaque cookie to identify the sender
 257     @param context - sender context, to match reply w/ request
 258     @param is_add - add SAD entry if non-zero, else delete
 259     @param sad_id - sad id
 260     @param spi - security parameter index
 261     @param protocol - 0 = AH, 1 = ESP
 262     @param crypto_algorithm - a supported crypto algorithm
 263     @param crypto_key - crypto keying material
 264     @param integrity_algorithm - one of the supported algorithms
 265     @param integrity_key - integrity keying material
 266     @param tunnel_src_address - IPsec tunnel source address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero
 267     @param tunnel_dst_address - IPsec tunnel destination address IPv6 if is_tunnel_ipv6 is non-zero, else IPv4. Only valid if is_tunnel is non-zero
 268     @param tx_table_id - the FIB id used for encapsulated packets
 269  */
 270 typedef ipsec_sad_entry
 271 {
 272   u32 sad_id;
 273
 274   u32 spi;
 275
 276   vl_api_ipsec_proto_t protocol;
 277
 278   vl_api_ipsec_crypto_alg_t crypto_algorithm;
 279   vl_api_key_t crypto_key;
 280
 281   vl_api_ipsec_integ_alg_t integrity_algorithm;
 282   vl_api_key_t integrity_key;
 283
 284   vl_api_ipsec_sad_flags_t flags;
 285
 286   vl_api_address_t tunnel_src;
 287   vl_api_address_t tunnel_dst;
 288   u32 tx_table_id;
 289 };
 290
 291 /** \brief IPsec: Add/delete Security Association Database entry
 292     @param client_index - opaque cookie to identify the sender
 293     @param context - sender context, to match reply w/ request
 294     @param entry - Entry to add or delete
 295  */
 296 define ipsec_sad_entry_add_del
 297 {
 298   u32 client_index;
 299   u32 context;
 300   u8 is_add;
 301   vl_api_ipsec_sad_entry_t entry;
 302 };
 303 define ipsec_sad_entry_add_del_reply
 304 {
 305   u32 context;
 306   i32 retval;
 307   u32 stat_index;
 308 };
 309
 310 /** \brief IPsec: Update Security Association keys
 311     @param client_index - opaque cookie to identify the sender
 312     @param context - sender context, to match reply w/ request
 313
 314     @param sa_id - sa id
 315
 316     @param crypto_key - crypto keying material
 317     @param integrity_key - integrity keying material
 318 */
 319
 320 autoreply define ipsec_sa_set_key
 321 {
 322   u32 client_index;
 323   u32 context;
 324
 325   u32 sa_id;
 326
 327   vl_api_key_t crypto_key;
 328   vl_api_key_t integrity_key;
 329 };
 330
 331 /** \brief IPsec: Get SPD interfaces
 332     @param client_index - opaque cookie to identify the sender
 333     @param context - sender context, to match reply w/ request
 334     @param spd_index - SPD index
 335     @param spd_index_valid - if 1 spd_index is used to filter
 336       spd_index's, if 0 no filtering is done
 337 */
 338 define ipsec_spd_interface_dump {
 339     u32 client_index;
 340     u32 context;
 341     u32 spd_index;
 342     u8 spd_index_valid;
 343 };
 344
 345 /** \brief IPsec: SPD interface response
 346     @param context - sender context which was passed in the request
 347     @param spd_index - SPD index
 348     @param sw_if_index - index of the interface
 349 */
 350 define ipsec_spd_interface_details {
 351     u32 context;
 352     u32 spd_index;
 353     u32 sw_if_index;
 354 };
 355
 356 /** \brief Add or delete IPsec tunnel interface
 357     @param client_index - opaque cookie to identify the sender
 358     @param context - sender context, to match reply w/ request
 359     @param is_add - add IPsec tunnel interface if nonzero, else delete
 360     @param esn - enable extended sequence numbers if nonzero, else disable
 361     @param anti_replay - enable anti replay check if nonzero, else disable
 362     @param local_ip - local IP address
 363     @param remote_ip - IP address of remote IPsec peer
 364     @param local_spi - SPI of outbound IPsec SA
 365     @param remote_spi - SPI of inbound IPsec SA
 366     @param crypto_alg - encryption algorithm ID
 367     @param local_crypto_key_len - length of local crypto key in bytes
 368     @param local_crypto_key - crypto key for outbound IPsec SA
 369     @param remote_crypto_key_len - length of remote crypto key in bytes
 370     @param remote_crypto_key - crypto key for inbound IPsec SA
 371     @param integ_alg - integrity algorithm ID
 372     @param local_integ_key_len - length of local integrity key in bytes
 373     @param local_integ_key - integrity key for outbound IPsec SA
 374     @param remote_integ_key_len - length of remote integrity key in bytes
 375     @param remote_integ_key - integrity key for inbound IPsec SA
 376     @param renumber - intf display name uses a specified instance if != 0
 377     @param show_instance - instance to display for intf if renumber is set
 378     @param udp_encap - enable UDP encapsulation for NAT traversal
 379     @param tx_table_id - the FIB id used after packet encap
 380 */
 381 define ipsec_tunnel_if_add_del {
 382   u32 client_index;
 383   u32 context;
 384   u8 is_add;
 385   u8 esn;
 386   u8 anti_replay;
 387   u8 local_ip[4];
 388   u8 remote_ip[4];
 389   u32 local_spi;
 390   u32 remote_spi;
 391   u8 crypto_alg;
 392   u8 local_crypto_key_len;
 393   u8 local_crypto_key[128];
 394   u8 remote_crypto_key_len;
 395   u8 remote_crypto_key[128];
 396   u8 integ_alg;
 397   u8 local_integ_key_len;
 398   u8 local_integ_key[128];
 399   u8 remote_integ_key_len;
 400   u8 remote_integ_key[128];
 401   u8 renumber;
 402   u32 show_instance;
 403   u8 udp_encap;
 404   u32 tx_table_id;
 405 };
 406
 407 /** \brief Add/delete IPsec tunnel interface response
 408     @param context - sender context, to match reply w/ request
 409     @param retval - return status
 410     @param sw_if_index - sw_if_index of new interface (for successful add)
 411 */
 412 define ipsec_tunnel_if_add_del_reply {
 413   u32 context;
 414   i32 retval;
 415   u32 sw_if_index;
 416 };
 417
 418 /** \brief Dump IPsec security association
 419     @param client_index - opaque cookie to identify the sender
 420     @param context - sender context, to match reply w/ request
 421     @param sa_id - optional ID of an SA to dump, if ~0 dump all SAs in SAD
 422 */
 423 define ipsec_sa_dump {
 424   u32 client_index;
 425   u32 context;
 426   u32 sa_id;
 427 };
 428
 429 /** \brief IPsec security association database response
 430     @param context - sender context which was passed in the request
 431     @param sa_id - SA ID, policy-based SAs >=0, tunnel interface SAs = 0
 432     @param sw_if_index - sw_if_index of tunnel interface, policy-based SAs = ~0
 433     @param spi - security parameter index
 434     @param protocol - IPsec protocol (value from ipsec_protocol_t)
 435     @param crypto_alg - crypto algorithm (value from ipsec_crypto_alg_t)
 436     @param crypto_key_len - length of crypto_key in bytes
 437     @param crypto_key - crypto keying material
 438     @param integ_alg - integrity algorithm (value from ipsec_integ_alg_t)
 439     @param integ_key_len - length of integ_key in bytes
 440     @param integ_key - integrity keying material
 441     @param use_esn - using extended sequence numbers when non-zero
 442     @param use_anti_replay - using anti-replay window when non-zero
 443     @param is_tunnel - IPsec tunnel mode when non-zero, else transport mode
 444     @param is_tunnel_ipv6 - If using tunnel mode, endpoints are IPv6
 445     @param tunnel_src_addr - Tunnel source address if using tunnel mode
 446     @param tunnel_dst_addr - Tunnel destination address is using tunnel mode
 447     @param salt - 4 byte salt
 448     @param seq - current sequence number for outbound
 449     @param seq_hi - high 32 bits of ESN for outbound
 450     @param last_seq - highest sequence number received inbound
 451     @param last_seq_hi - high 32 bits of highest ESN received inbound
 452     @param replay_window - bit map of seq nums received relative to last_seq if using anti-replay
 453     @param total_data_size - total bytes sent or received
 454     @param udp_encap - 1 if UDP encap enabled, 0 otherwise
 455 */
 456 define ipsec_sa_details {
 457   u32 context;
 458   vl_api_ipsec_sad_entry_t entry;
 459
 460   u32 sw_if_index;
 461   u32 salt;
 462   u64 seq_outbound;
 463   u64 last_seq_inbound;
 464   u64 replay_window;
 465
 466   u64 total_data_size;
 467 };
 468
 469 /** \brief Set key on IPsec interface
 470     @param client_index - opaque cookie to identify the sender
 471     @param context - sender context, to match reply w/ request
 472     @param sw_if_index - index of tunnel interface
 473     @param key_type - type of key being set
 474     @param alg - algorithm used with key
 475     @param key_len - length key in bytes
 476     @param key - key
 477 */
 478 autoreply define ipsec_tunnel_if_set_key {
 479   u32 client_index;
 480   u32 context;
 481   u32 sw_if_index;
 482   u8 key_type;
 483   u8 alg;
 484   u8 key_len;
 485   u8 key[128];
 486 };
 487
 488 /** \brief Set new SA on IPsec interface
 489     @param client_index - opaque cookie to identify the sender
 490     @param context - sender context, to match reply w/ request
 491     @param sw_if_index - index of tunnel interface
 492     @param sa_id - ID of SA to use
 493     @param is_outbound - 1 if outbound (local) SA, 0 if inbound (remote)
 494 */
 495 autoreply define ipsec_tunnel_if_set_sa {
 496   u32 client_index;
 497   u32 context;
 498   u32 sw_if_index;
 499   u32 sa_id;
 500   u8 is_outbound;
 501 };
 502
 503 /** \brief Dump IPsec backends
 504     @param client_index - opaque cookie to identify the sender
 505     @param context - sender context, to match reply w/ request
 506 */
 507 define ipsec_backend_dump {
 508   u32 client_index;
 509   u32 context;
 510 };
 511
 512 /** \brief IPsec backend details
 513     @param name - name of the backend
 514     @param protocol - IPsec protocol (value from ipsec_protocol_t)
 515     @param index - backend index
 516     @param active - set to 1 if the backend is active, otherwise 0
 517 */
 518 define ipsec_backend_details {
 519   u32 context;
 520   u8 name[128];
 521   vl_api_ipsec_proto_t protocol;
 522   u8 index;
 523   u8 active;
 524 };
 525
 526 /** \brief Select IPsec backend
 527     @param client_index - opaque cookie to identify the sender
 528     @param context - sender context, to match reply w/ request
 529     @param protocol - IPsec protocol (value from ipsec_protocol_t)
 530     @param index - backend index
 531 */
 532 autoreply define ipsec_select_backend {
 533   u32 client_index;
 534   u32 context;
 535   vl_api_ipsec_proto_t protocol;
 536   u8 index;
 537 };
 538
 539 /*
 540  * Local Variables:
 541  * eval: (c-set-style "gnu")
 542  * End:
 543  */
 544