X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fipsec%2Fipsec.api;h=6d34d056003eea050e63055c4448b4f20f7ced63;hb=dbf68c9aa;hp=d6a28017fff1099b587e2cfdca3be57f3cac4fca;hpb=a9a0b2ce2daabc5479aa7722e3ec7023f8c6c0d5;p=vpp.git diff --git a/src/vnet/ipsec/ipsec.api b/src/vnet/ipsec/ipsec.api index d6a28017fff..6d34d056003 100644 --- a/src/vnet/ipsec/ipsec.api +++ b/src/vnet/ipsec/ipsec.api @@ -1,3 +1,4 @@ +/* Hey Emacs use -*- mode: C -*- */ /* * Copyright (c) 2015-2016 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); @@ -13,7 +14,10 @@ * limitations under the License. */ -option version = "2.0.0"; +option version = "3.0.0"; + +import "vnet/ipsec/ipsec_types.api"; +import "vnet/interface_types.api"; /** \brief IPsec: Add/delete Security Policy Database @param client_index - opaque cookie to identify the sender @@ -50,475 +54,263 @@ autoreply define ipsec_interface_add_del_spd u32 spd_id; }; -/** \brief IPsec: Add/delete Security Policy Database entry + +enum ipsec_spd_action +{ + /* bypass - no IPsec processing */ + IPSEC_API_SPD_ACTION_BYPASS = 0, + /* discard - discard packet with ICMP processing */ + IPSEC_API_SPD_ACTION_DISCARD, + /* resolve - send request to control plane for SA resolving */ + IPSEC_API_SPD_ACTION_RESOLVE, + /* protect - apply IPsec policy using following parameters */ + IPSEC_API_SPD_ACTION_PROTECT, +}; + +/** \brief IPsec: Security Policy Database entry See RFC 4301, 4.4.1.1 on how to match packet to selectors - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - @param is_add - add SPD if non-zero, else delete @param spd_id - SPD instance id (control plane allocated) @param priority - priority of SPD entry (non-unique value). Used to order SPD matching - higher priorities match before lower @param is_outbound - entry applies to outbound traffic if non-zero, otherwise applies to inbound traffic - @param is_ipv6 - remote/local address are IPv6 if non-zero, else IPv4 @param remote_address_start - start of remote address range to match @param remote_address_stop - end of remote address range to match @param local_address_start - start of local address range to match @param local_address_stop - end of local address range to match - @param protocol - protocol type to match [0 means any] + @param protocol - protocol type to match [0 means any] otherwise IANA value @param remote_port_start - start of remote port range to match ... @param remote_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE] @param local_port_start - start of local port range to match ... @param local_port_stop - end of remote port range to match [0 to 65535 means ANY, 65535 to 0 means OPAQUE] - @param policy - 0 = bypass (no IPsec processing), 1 = discard (discard packet with ICMP processing), 2 = resolve (send request to control plane for SA resolving, and discard without ICMP processing), 3 = protect (apply IPsec policy using following parameters) + @param policy - action to perform on match @param sa_id - SAD instance id (control plane allocated) - */ - -autoreply define ipsec_spd_add_del_entry +typedef ipsec_spd_entry { - u32 client_index; - u32 context; - u8 is_add; - u32 spd_id; i32 priority; u8 is_outbound; - // Selector - u8 is_ipv6; - u8 is_ip_any; - u8 remote_address_start[16]; - u8 remote_address_stop[16]; - u8 local_address_start[16]; - u8 local_address_stop[16]; - + u32 sa_id; + vl_api_ipsec_spd_action_t policy; u8 protocol; + // Selector + vl_api_address_t remote_address_start; + vl_api_address_t remote_address_stop; + vl_api_address_t local_address_start; + vl_api_address_t local_address_stop; + u16 remote_port_start; u16 remote_port_stop; u16 local_port_start; u16 local_port_stop; - - // Policy - u8 policy; - u32 sa_id; }; -/** \brief IPsec: Add/delete Security Association Database entry - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - @param is_add - add SAD entry if non-zero, else delete - - @param sad_id - sad id - - @param spi - security parameter index - - @param protocol - 0 = AH, 1 = ESP - - @param crypto_algorithm - 0 = Null, 1 = AES-CBC-128, 2 = AES-CBC-192, 3 = AES-CBC-256, 4 = 3DES-CBC - @param crypto_key_length - length of crypto_key in bytes - @param crypto_key - crypto keying material - - @param integrity_algorithm - 0 = None, 1 = MD5-96, 2 = SHA1-96, 3 = SHA-256, 4 = SHA-384, 5=SHA-512 - @param integrity_key_length - length of integrity_key in bytes - @param integrity_key - integrity keying material - - @param use_extended_sequence_number - use ESN when non-zero - - @param is_tunnel - IPsec tunnel mode if non-zero, else transport mode - @param is_tunnel_ipv6 - IPsec tunnel mode is IPv6 if non-zero, else IPv4 tunnel only valid if is_tunnel is non-zero - @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 - @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 - @param udp_encap - enable UDP encapsulation for NAT traversal - - To be added: - Anti-replay - IPsec tunnel address copy mode (to support GDOI) - */ - -autoreply define ipsec_sad_add_del_entry -{ - u32 client_index; - u32 context; - u8 is_add; - - u32 sad_id; - - u32 spi; - - u8 protocol; - - u8 crypto_algorithm; - u8 crypto_key_length; - u8 crypto_key[128]; - - u8 integrity_algorithm; - u8 integrity_key_length; - u8 integrity_key[128]; - - u8 use_extended_sequence_number; - u8 use_anti_replay; - - u8 is_tunnel; - u8 is_tunnel_ipv6; - u8 tunnel_src_address[16]; - u8 tunnel_dst_address[16]; - u8 udp_encap; -}; - -/** \brief IPsec: Update Security Association keys - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param sa_id - sa id - - @param crypto_key_length - length of crypto_key in bytes - @param crypto_key - crypto keying material - - @param integrity_key_length - length of integrity_key in bytes - @param integrity_key - integrity keying material -*/ - -autoreply define ipsec_sa_set_key -{ - u32 client_index; - u32 context; - - u32 sa_id; - - u8 crypto_key_length; - u8 crypto_key[128]; - - u8 integrity_key_length; - u8 integrity_key[128]; -}; +/** \brief IPsec: Add/delete Security Policy Database entry -/** \brief IKEv2: Add/delete profile @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param is_add - Add IKEv2 profile if non-zero, else delete + @param is_add - add SPD if non-zero, else delete + @param entry - Description of the entry to add/dell */ -autoreply define ikev2_profile_add_del +define ipsec_spd_entry_add_del { u32 client_index; u32 context; - - u8 name[64]; u8 is_add; + vl_api_ipsec_spd_entry_t entry; }; -/** \brief IKEv2: Set IKEv2 profile authentication method - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param auth_method - IKEv2 authentication method (shared-key-mic/rsa-sig) - @param is_hex - Authentication data in hex format if non-zero, else string - @param data_len - Authentication data length - @param data - Authentication data (for rsa-sig cert file path) -*/ -autoreply define ikev2_profile_set_auth -{ - u32 client_index; - u32 context; +/** \brief IPsec: Reply Add/delete Security Policy Database entry - u8 name[64]; - u8 auth_method; - u8 is_hex; - u32 data_len; - u8 data[data_len]; -}; - -/** \brief IKEv2: Set IKEv2 profile local/remote identification - @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param is_local - Identification is local if non-zero, else remote - @param id_type - Identification type - @param data_len - Identification data length - @param data - Identification data + @param retval - success/fail rutrun code + @param stat_index - An index for the policy in the stats segment @ /net/ipec/policy */ -autoreply define ikev2_profile_set_id +define ipsec_spd_entry_add_del_reply { - u32 client_index; u32 context; - - u8 name[64]; - u8 is_local; - u8 id_type; - u32 data_len; - u8 data[data_len]; + i32 retval; + u32 stat_index; }; -/** \brief IKEv2: Set IKEv2 profile traffic selector parameters +/** \brief Dump IPsec all SPD IDs @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param is_local - Traffic selector is local if non-zero, else remote - @param proto - Traffic selector IP protocol (if zero not relevant) - @param start_port - The smallest port number allowed by traffic selector - @param end_port - The largest port number allowed by traffic selector - @param start_addr - The smallest address included in traffic selector - @param end_addr - The largest address included in traffic selector */ -autoreply define ikev2_profile_set_ts -{ +define ipsec_spds_dump { u32 client_index; u32 context; - - u8 name[64]; - u8 is_local; - u8 proto; - u16 start_port; - u16 end_port; - u32 start_addr; - u32 end_addr; }; -/** \brief IKEv2: Set IKEv2 local RSA private key +/** \brief Dump IPsec all SPD IDs response @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param key_file - Key file absolute path + @param spd_id - SPD instance id (control plane allocated) + @param npolicies - number of policies in SPD */ -autoreply define ikev2_set_local_key -{ - u32 client_index; +define ipsec_spds_details { u32 context; + u32 spd_id; + u32 npolicies; +}; - u8 key_file[256]; -}; - -/** \brief IKEv2: Set IKEv2 responder interface and IP address +/** \brief Dump ipsec policy database data @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param sw_if_index - interface index - @param address - interface address + @param spd_id - SPD instance id + @param sa_id - SA id, optional, set to ~0 to see all policies in SPD */ -autoreply define ikev2_set_responder -{ - u32 client_index; - u32 context; - - u8 name[64]; - u32 sw_if_index; - u8 address[4]; +define ipsec_spd_dump { + u32 client_index; + u32 context; + u32 spd_id; + u32 sa_id; }; -/** \brief IKEv2: Set IKEv2 IKE transforms in SA_INIT proposal (RFC 7296) - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param crypto_alg - encryption algorithm - @param crypto_key_size - encryption key size - @param integ_alg - integrity algorithm - @param dh_group - Diffie-Hellman group - +/** \brief IPsec policy database response + @param context - sender context which was passed in the request + €param entry - The SPD entry. + @param bytes - byte count of packets matching this policy + @param packets - count of packets matching this policy */ -autoreply define ikev2_set_ike_transforms -{ - u32 client_index; - u32 context; - - u8 name[64]; - u32 crypto_alg; - u32 crypto_key_size; - u32 integ_alg; - u32 dh_group; +define ipsec_spd_details { + u32 context; + vl_api_ipsec_spd_entry_t entry; }; -/** \brief IKEv2: Set IKEv2 ESP transforms in SA_INIT proposal (RFC 7296) +/** \brief IPsec: Add/delete Security Association Database entry @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param crypto_alg - encryption algorithm - @param crypto_key_size - encryption key size - @param integ_alg - integrity algorithm - @param dh_group - Diffie-Hellman group - -*/ -autoreply define ikev2_set_esp_transforms + @param entry - Entry to add or delete + */ +define ipsec_sad_entry_add_del { u32 client_index; u32 context; - - u8 name[64]; - u32 crypto_alg; - u32 crypto_key_size; - u32 integ_alg; - u32 dh_group; + u8 is_add; + vl_api_ipsec_sad_entry_t entry; }; - -/** \brief IKEv2: Set Child SA lifetime, limited by time and/or data - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - @param lifetime - SA maximum life time in seconds (0 to disable) - @param lifetime_jitter - Jitter added to prevent simultaneous rekeying - @param handover - Hand over time - @param lifetime_maxdata - SA maximum life time in bytes (0 to disable) - -*/ -autoreply define ikev2_set_sa_lifetime +define ipsec_sad_entry_add_del_reply { - u32 client_index; u32 context; - - u8 name[64]; - u64 lifetime; - u32 lifetime_jitter; - u32 handover; - u64 lifetime_maxdata; + i32 retval; + u32 stat_index; }; -/** \brief IKEv2: Initiate the SA_INIT exchange +/** \brief Add or Update Protection for a tunnel with IPSEC + + Tunnel protection directly associates an SA with all packets + ingress and egress on the tunnel. This could also be achieved by + assigning an SPD to the tunnel, but that would incur an unnessccary + SPD entry lookup. + + For tunnels the ESP acts on the post-encapsulated packet. So if this + packet: + +---------+------+ + | Payload | O-IP | + +---------+------+ + where O-IP is the overlay IP addrees that was routed into the tunnel, + the resulting encapsulated packet will be: + +---------+------+------+ + | Payload | O-IP | T-IP | + +---------+------+------+ + where T-IP is the tunnel's src.dst IP addresses. + If the SAs used for protection are in transport mode then the ESP is + inserted before T-IP, i.e.: + +---------+------+-----+------+ + | Payload | O-IP | ESP | T-IP | + +---------+------+-----+------+ + If the SAs used for protection are in tunnel mode then another + encapsulation occurs, i.e.: + +---------+------+------+-----+------+ + | Payload | O-IP | T-IP | ESP | C-IP | + +---------+------+------+-----+------+ + where C-IP are the crypto endpoint IP addresses defined as the tunnel + endpoints in the SA. + The mode for the inbound and outbound SA must be the same. + @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - - @param name - IKEv2 profile name - + @param sw_id_index - Tunnel interface to protect + @param sa_in - The ID [set] of inbound SAs + @param sa_out - The ID of outbound SA */ -autoreply define ikev2_initiate_sa_init +typedef ipsec_tunnel_protect { - u32 client_index; - u32 context; - - u8 name[64]; + vl_api_interface_index_t sw_if_index; + u32 sa_out; + u8 n_sa_in; + u32 sa_in[n_sa_in]; }; -/** \brief IKEv2: Initiate the delete IKE SA exchange - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param ispi - IKE SA initiator SPI - -*/ -autoreply define ikev2_initiate_del_ike_sa +autoreply define ipsec_tunnel_protect_update { u32 client_index; u32 context; - u64 ispi; + vl_api_ipsec_tunnel_protect_t tunnel; }; -/** \brief IKEv2: Initiate the delete Child SA exchange - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param ispi - Child SA initiator SPI - -*/ -autoreply define ikev2_initiate_del_child_sa +autoreply define ipsec_tunnel_protect_del { u32 client_index; u32 context; - u32 ispi; + vl_api_interface_index_t sw_if_index; }; -/** \brief IKEv2: Initiate the rekey Child SA exchange - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - - @param ispi - Child SA initiator SPI - -*/ -autoreply define ikev2_initiate_rekey_child_sa +/** + * @brief Dump all tunnel protections + */ +define ipsec_tunnel_protect_dump { u32 client_index; u32 context; - - u32 ispi; + vl_api_interface_index_t sw_if_index; }; -/** \brief Dump IPsec all SPD IDs - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request -*/ -define ipsec_spds_dump { - u32 client_index; +define ipsec_tunnel_protect_details +{ u32 context; + vl_api_ipsec_tunnel_protect_t tun; }; -/** \brief Dump IPsec all SPD IDs response - @param client_index - opaque cookie to identify the sender - @param spd_id - SPD instance id (control plane allocated) - @param npolicies - number of policies in SPD -*/ - define ipsec_spds_details { - u32 context; - u32 spd_id; - u32 npolicies; -}; - -/** \brief Dump ipsec policy database data +/** \brief IPsec: Get SPD interfaces @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - @param spd_id - SPD instance id - @param sa_id - SA id, optional, set to ~0 to see all policies in SPD + @param spd_index - SPD index + @param spd_index_valid - if 1 spd_index is used to filter + spd_index's, if 0 no filtering is done */ -define ipsec_spd_dump { +define ipsec_spd_interface_dump { u32 client_index; u32 context; - u32 spd_id; - u32 sa_id; + u32 spd_index; + u8 spd_index_valid; }; -/** \brief IPsec policy database response +/** \brief IPsec: SPD interface response @param context - sender context which was passed in the request - @param spd_id - SPD instance id - @param priority - numeric value to control policy evaluation order - @param is_outbound - [1|0] to indicate if direction is [out|in]bound - @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4] - @param local_start_addr - first address in local traffic selector range - @param local_stop_addr - last address in local traffic selector range - @param local_start_port - first port in local traffic selector range - @param local_stop_port - last port in local traffic selector range - @param remote_start_addr - first address in remote traffic selector range - @param remote_stop_addr - last address in remote traffic selector range - @param remote_start_port - first port in remote traffic selector range - @param remote_stop_port - last port in remote traffic selector range - @param protocol - traffic selector protocol - @param policy - policy action - @param sa_id - SA id - @param bytes - byte count of packets matching this policy - @param packets - count of packets matching this policy + @param spd_index - SPD index + @param sw_if_index - index of the interface */ -define ipsec_spd_details { +define ipsec_spd_interface_details { u32 context; - u32 spd_id; - i32 priority; - u8 is_outbound; - u8 is_ipv6; - u8 local_start_addr[16]; - u8 local_stop_addr[16]; - u16 local_start_port; - u16 local_stop_port; - u8 remote_start_addr[16]; - u8 remote_stop_addr[16]; - u16 remote_start_port; - u16 remote_stop_port; - u8 protocol; - u8 policy; - u32 sa_id; - u64 bytes; - u64 packets; + u32 spd_index; + u32 sw_if_index; }; /** \brief Add or delete IPsec tunnel interface + + !!DEPRECATED!! + use the tunnel protect APIs instead + @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - add IPsec tunnel interface if nonzero, else delete + @param is_ip6 - tunnel v6 or v4 @param esn - enable extended sequence numbers if nonzero, else disable @param anti_replay - enable anti replay check if nonzero, else disable @param local_ip - local IP address @@ -537,6 +329,9 @@ define ipsec_spd_details { @param remote_integ_key - integrity key for inbound IPsec SA @param renumber - intf display name uses a specified instance if != 0 @param show_instance - instance to display for intf if renumber is set + @param udp_encap - enable UDP encapsulation for NAT traversal + @param tx_table_id - the FIB id used after packet encap + @param salt - for use with counter mode ciphers */ define ipsec_tunnel_if_add_del { u32 client_index; @@ -544,8 +339,8 @@ define ipsec_tunnel_if_add_del { u8 is_add; u8 esn; u8 anti_replay; - u8 local_ip[4]; - u8 remote_ip[4]; + vl_api_address_t local_ip; + vl_api_address_t remote_ip; u32 local_spi; u32 remote_spi; u8 crypto_alg; @@ -560,6 +355,9 @@ define ipsec_tunnel_if_add_del { u8 remote_integ_key[128]; u8 renumber; u32 show_instance; + u8 udp_encap; + u32 tx_table_id; + u32 salt; }; /** \brief Add/delete IPsec tunnel interface response @@ -613,69 +411,69 @@ define ipsec_sa_dump { */ define ipsec_sa_details { u32 context; - u32 sa_id; - u32 sw_if_index; - - u32 spi; - u8 protocol; - - u8 crypto_alg; - u8 crypto_key_len; - u8 crypto_key[128]; - - u8 integ_alg; - u8 integ_key_len; - u8 integ_key[128]; - - u8 use_esn; - u8 use_anti_replay; - - u8 is_tunnel; - u8 is_tunnel_ip6; - u8 tunnel_src_addr[16]; - u8 tunnel_dst_addr[16]; + vl_api_ipsec_sad_entry_t entry; + u32 sw_if_index; u32 salt; u64 seq_outbound; u64 last_seq_inbound; u64 replay_window; u64 total_data_size; - u8 udp_encap; }; -/** \brief Set key on IPsec interface +/** \brief Set new SA on IPsec interface + + !! DEPRECATED !! + @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - index of tunnel interface - @param key_type - type of key being set - @param alg - algorithm used with key - @param key_len - length key in bytes - @param key - key + @param sa_id - ID of SA to use + @param is_outbound - 1 if outbound (local) SA, 0 if inbound (remote) */ -autoreply define ipsec_tunnel_if_set_key { +autoreply define ipsec_tunnel_if_set_sa { u32 client_index; u32 context; u32 sw_if_index; - u8 key_type; - u8 alg; - u8 key_len; - u8 key[128]; + u32 sa_id; + u8 is_outbound; }; -/** \brief Set new SA on IPsec interface +/** \brief Dump IPsec backends @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request - @param sw_if_index - index of tunnel interface - @param sa_id - ID of SA to use - @param is_outbound - 1 if outbound (local) SA, 0 if inbound (remote) */ -autoreply define ipsec_tunnel_if_set_sa { +define ipsec_backend_dump { u32 client_index; u32 context; - u32 sw_if_index; - u32 sa_id; - u8 is_outbound; +}; + +/** \brief IPsec backend details + @param name - name of the backend + @param protocol - IPsec protocol (value from ipsec_protocol_t) + @param index - backend index + @param active - set to 1 if the backend is active, otherwise 0 +*/ +define ipsec_backend_details { + u32 context; + u8 name[128]; + vl_api_ipsec_proto_t protocol; + u8 index; + u8 active; +}; + +/** \brief Select IPsec backend + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param protocol - IPsec protocol (value from ipsec_protocol_t) + @param index - backend index +*/ +autoreply define ipsec_select_backend { + u32 client_index; + u32 context; + vl_api_ipsec_proto_t protocol; + u8 index; }; /*