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
 237 enum ipsec_proto
 238 {
 239   IPSEC_API_PROTO_ESP,
 240   IPSEC_API_PROTO_AH,
 241 };
 242
 243 typedef key
 244 {
 245   /* the length of the key */
 246   u8 length;
 247   /* The data for the key */
 248   u8 data[128];
 249 };
 250
 251 /** \brief IPsec: Security Association Database entry
 252     @param client_index - opaque cookie to identify the sender
 253     @param context - sender context, to match reply w/ request
 254     @param is_add - add SAD entry if non-zero, else delete
 255     @param sad_id - sad id
 256     @param spi - security parameter index
 257     @param protocol - 0 = AH, 1 = ESP
 258     @param crypto_algorithm - a supported crypto algorithm
 259     @param crypto_key - crypto keying material
 260     @param integrity_algorithm - one of the supported algorithms
 261     @param integrity_key - integrity keying material
 262     @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
 263     @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
 264     @param tx_table_id - the FIB id used for encapsulated packets
 265  */
 266 typedef ipsec_sad_entry
 267 {
 268   u32 sad_id;
 269
 270   u32 spi;
 271
 272   vl_api_ipsec_proto_t protocol;
 273
 274   vl_api_ipsec_crypto_alg_t crypto_algorithm;
 275   vl_api_key_t crypto_key;
 276
 277   vl_api_ipsec_integ_alg_t integrity_algorithm;
 278   vl_api_key_t integrity_key;
 279
 280   vl_api_ipsec_sad_flags_t flags;
 281
 282   vl_api_address_t tunnel_src;
 283   vl_api_address_t tunnel_dst;
 284   u32 tx_table_id;
 285 };
 286
 287 /** \brief IPsec: Add/delete Security Association Database entry
 288     @param client_index - opaque cookie to identify the sender
 289     @param context - sender context, to match reply w/ request
 290     @param entry - Entry to add or delete
 291  */
 292 define ipsec_sad_entry_add_del
 293 {
 294   u32 client_index;
 295   u32 context;
 296   u8 is_add;
 297   vl_api_ipsec_sad_entry_t entry;
 298 };
 299 define ipsec_sad_entry_add_del_reply
 300 {
 301   u32 context;
 302   i32 retval;
 303   u32 stat_index;
 304 };
 305
 306 /** \brief IPsec: Update Security Association keys
 307     @param client_index - opaque cookie to identify the sender
 308     @param context - sender context, to match reply w/ request
 309
 310     @param sa_id - sa id
 311
 312     @param crypto_key - crypto keying material
 313     @param integrity_key - integrity keying material
 314 */
 315
 316 autoreply define ipsec_sa_set_key
 317 {
 318   u32 client_index;
 319   u32 context;
 320
 321   u32 sa_id;
 322
 323   vl_api_key_t crypto_key;
 324   vl_api_key_t integrity_key;
 325 };
 326
 327 /** \brief IPsec: Get SPD interfaces
 328     @param client_index - opaque cookie to identify the sender
 329     @param context - sender context, to match reply w/ request
 330     @param spd_index - SPD index
 331     @param spd_index_valid - if 1 spd_index is used to filter
 332       spd_index's, if 0 no filtering is done
 333 */
 334 define ipsec_spd_interface_dump {
 335     u32 client_index;
 336     u32 context;
 337     u32 spd_index;
 338     u8 spd_index_valid;
 339 };
 340
 341 /** \brief IPsec: SPD interface response
 342     @param context - sender context which was passed in the request
 343     @param spd_index - SPD index
 344     @param sw_if_index - index of the interface
 345 */
 346 define ipsec_spd_interface_details {
 347     u32 context;
 348     u32 spd_index;
 349     u32 sw_if_index;
 350 };
 351
 352 /** \brief Add or delete IPsec tunnel interface
 353     @param client_index - opaque cookie to identify the sender
 354     @param context - sender context, to match reply w/ request
 355     @param is_add - add IPsec tunnel interface if nonzero, else delete
 356     @param esn - enable extended sequence numbers if nonzero, else disable
 357     @param anti_replay - enable anti replay check if nonzero, else disable
 358     @param local_ip - local IP address
 359     @param remote_ip - IP address of remote IPsec peer
 360     @param local_spi - SPI of outbound IPsec SA
 361     @param remote_spi - SPI of inbound IPsec SA
 362     @param crypto_alg - encryption algorithm ID
 363     @param local_crypto_key_len - length of local crypto key in bytes
 364     @param local_crypto_key - crypto key for outbound IPsec SA
 365     @param remote_crypto_key_len - length of remote crypto key in bytes
 366     @param remote_crypto_key - crypto key for inbound IPsec SA
 367     @param integ_alg - integrity algorithm ID
 368     @param local_integ_key_len - length of local integrity key in bytes
 369     @param local_integ_key - integrity key for outbound IPsec SA
 370     @param remote_integ_key_len - length of remote integrity key in bytes
 371     @param remote_integ_key - integrity key for inbound IPsec SA
 372     @param renumber - intf display name uses a specified instance if != 0
 373     @param show_instance - instance to display for intf if renumber is set
 374     @param udp_encap - enable UDP encapsulation for NAT traversal
 375     @param tx_table_id - the FIB id used after packet encap
 376 */
 377 define ipsec_tunnel_if_add_del {
 378   u32 client_index;
 379   u32 context;
 380   u8 is_add;
 381   u8 esn;
 382   u8 anti_replay;
 383   u8 local_ip[4];
 384   u8 remote_ip[4];
 385   u32 local_spi;
 386   u32 remote_spi;
 387   u8 crypto_alg;
 388   u8 local_crypto_key_len;
 389   u8 local_crypto_key[128];
 390   u8 remote_crypto_key_len;
 391   u8 remote_crypto_key[128];
 392   u8 integ_alg;
 393   u8 local_integ_key_len;
 394   u8 local_integ_key[128];
 395   u8 remote_integ_key_len;
 396   u8 remote_integ_key[128];
 397   u8 renumber;
 398   u32 show_instance;
 399   u8 udp_encap;
 400   u32 tx_table_id;
 401 };
 402
 403 /** \brief Add/delete IPsec tunnel interface response
 404     @param context - sender context, to match reply w/ request
 405     @param retval - return status
 406     @param sw_if_index - sw_if_index of new interface (for successful add)
 407 */
 408 define ipsec_tunnel_if_add_del_reply {
 409   u32 context;
 410   i32 retval;
 411   u32 sw_if_index;
 412 };
 413
 414 /** \brief Dump IPsec security association
 415     @param client_index - opaque cookie to identify the sender
 416     @param context - sender context, to match reply w/ request
 417     @param sa_id - optional ID of an SA to dump, if ~0 dump all SAs in SAD
 418 */
 419 define ipsec_sa_dump {
 420   u32 client_index;
 421   u32 context;
 422   u32 sa_id;
 423 };
 424
 425 /** \brief IPsec security association database response
 426     @param context - sender context which was passed in the request
 427     @param sa_id - SA ID, policy-based SAs >=0, tunnel interface SAs = 0
 428     @param sw_if_index - sw_if_index of tunnel interface, policy-based SAs = ~0
 429     @param spi - security parameter index
 430     @param protocol - IPsec protocol (value from ipsec_protocol_t)
 431     @param crypto_alg - crypto algorithm (value from ipsec_crypto_alg_t)
 432     @param crypto_key_len - length of crypto_key in bytes
 433     @param crypto_key - crypto keying material
 434     @param integ_alg - integrity algorithm (value from ipsec_integ_alg_t)
 435     @param integ_key_len - length of integ_key in bytes
 436     @param integ_key - integrity keying material
 437     @param use_esn - using extended sequence numbers when non-zero
 438     @param use_anti_replay - using anti-replay window when non-zero
 439     @param is_tunnel - IPsec tunnel mode when non-zero, else transport mode
 440     @param is_tunnel_ipv6 - If using tunnel mode, endpoints are IPv6
 441     @param tunnel_src_addr - Tunnel source address if using tunnel mode
 442     @param tunnel_dst_addr - Tunnel destination address is using tunnel mode
 443     @param salt - 4 byte salt
 444     @param seq - current sequence number for outbound
 445     @param seq_hi - high 32 bits of ESN for outbound
 446     @param last_seq - highest sequence number received inbound
 447     @param last_seq_hi - high 32 bits of highest ESN received inbound
 448     @param replay_window - bit map of seq nums received relative to last_seq if using anti-replay
 449     @param total_data_size - total bytes sent or received
 450     @param udp_encap - 1 if UDP encap enabled, 0 otherwise
 451 */
 452 define ipsec_sa_details {
 453   u32 context;
 454   vl_api_ipsec_sad_entry_t entry;
 455
 456   u32 sw_if_index;
 457   u32 salt;
 458   u64 seq_outbound;
 459   u64 last_seq_inbound;
 460   u64 replay_window;
 461
 462   u64 total_data_size;
 463 };
 464
 465 /** \brief Set key on IPsec interface
 466     @param client_index - opaque cookie to identify the sender
 467     @param context - sender context, to match reply w/ request
 468     @param sw_if_index - index of tunnel interface
 469     @param key_type - type of key being set
 470     @param alg - algorithm used with key
 471     @param key_len - length key in bytes
 472     @param key - key
 473 */
 474 autoreply define ipsec_tunnel_if_set_key {
 475   u32 client_index;
 476   u32 context;
 477   u32 sw_if_index;
 478   u8 key_type;
 479   u8 alg;
 480   u8 key_len;
 481   u8 key[128];
 482 };
 483
 484 /** \brief Set new SA on IPsec interface
 485     @param client_index - opaque cookie to identify the sender
 486     @param context - sender context, to match reply w/ request
 487     @param sw_if_index - index of tunnel interface
 488     @param sa_id - ID of SA to use
 489     @param is_outbound - 1 if outbound (local) SA, 0 if inbound (remote)
 490 */
 491 autoreply define ipsec_tunnel_if_set_sa {
 492   u32 client_index;
 493   u32 context;
 494   u32 sw_if_index;
 495   u32 sa_id;
 496   u8 is_outbound;
 497 };
 498
 499 /** \brief Dump IPsec backends
 500     @param client_index - opaque cookie to identify the sender
 501     @param context - sender context, to match reply w/ request
 502 */
 503 define ipsec_backend_dump {
 504   u32 client_index;
 505   u32 context;
 506 };
 507
 508 /** \brief IPsec backend details
 509     @param name - name of the backend
 510     @param protocol - IPsec protocol (value from ipsec_protocol_t)
 511     @param index - backend index
 512     @param active - set to 1 if the backend is active, otherwise 0
 513 */
 514 define ipsec_backend_details {
 515   u32 context;
 516   u8 name[128];
 517   vl_api_ipsec_proto_t protocol;
 518   u8 index;
 519   u8 active;
 520 };
 521
 522 /** \brief Select IPsec backend
 523     @param client_index - opaque cookie to identify the sender
 524     @param context - sender context, to match reply w/ request
 525     @param protocol - IPsec protocol (value from ipsec_protocol_t)
 526     @param index - backend index
 527 */
 528 autoreply define ipsec_select_backend {
 529   u32 client_index;
 530   u32 context;
 531   vl_api_ipsec_proto_t protocol;
 532   u8 index;
 533 };
 534
 535 /*
 536  * Local Variables:
 537  * eval: (c-set-style "gnu")
 538  * End:
 539  */
 540