X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fipsec%2Fipsec.api;h=c009d8dffaa7725612060155f89aa75c68be503b;hb=751bb131e;hp=3f8913fe26e97327d345499f94c9d85c05bcb419;hpb=287d5e109a93f14490f38bdbe34b6741af436984;p=vpp.git diff --git a/src/vnet/ipsec/ipsec.api b/src/vnet/ipsec/ipsec.api index 3f8913fe26e..c009d8dffaa 100644 --- a/src/vnet/ipsec/ipsec.api +++ b/src/vnet/ipsec/ipsec.api @@ -14,12 +14,13 @@ * limitations under the License. */ -option version = "3.0.1"; +option version = "5.0.0"; import "vnet/ipsec/ipsec_types.api"; import "vnet/interface_types.api"; import "vnet/ip/ip_types.api"; import "vnet/interface_types.api"; +import "vnet/tunnel/tunnel_types.api"; /** \brief IPsec: Add/delete Security Policy Database @param client_index - opaque cookie to identify the sender @@ -195,12 +196,25 @@ define ipsec_sad_entry_add_del bool is_add; vl_api_ipsec_sad_entry_t entry; }; +define ipsec_sad_entry_add_del_v2 +{ + u32 client_index; + u32 context; + bool is_add; + vl_api_ipsec_sad_entry_v2_t entry; +}; define ipsec_sad_entry_add_del_reply { u32 context; i32 retval; u32 stat_index; }; +define ipsec_sad_entry_add_del_v2_reply +{ + u32 context; + i32 retval; + u32 stat_index; +}; /** \brief Add or Update Protection for a tunnel with IPSEC @@ -310,81 +324,66 @@ define ipsec_spd_interface_details { vl_api_interface_index_t sw_if_index; }; -/** \brief Add or delete IPsec tunnel interface - - !!DEPRECATED!! - use the tunnel protect APIs instead +typedef ipsec_itf +{ + u32 user_instance [default=0xffffffff]; + vl_api_tunnel_mode_t mode; + vl_api_interface_index_t sw_if_index; +}; - @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 - @param remote_ip - IP address of remote IPsec peer - @param local_spi - SPI of outbound IPsec SA - @param remote_spi - SPI of inbound IPsec SA - @param crypto_alg - encryption algorithm ID - @param local_crypto_key_len - length of local crypto key in bytes - @param local_crypto_key - crypto key for outbound IPsec SA - @param remote_crypto_key_len - length of remote crypto key in bytes - @param remote_crypto_key - crypto key for inbound IPsec SA - @param integ_alg - integrity algorithm ID - @param local_integ_key_len - length of local integrity key in bytes - @param local_integ_key - integrity key for outbound IPsec SA - @param remote_integ_key_len - length of remote integrity key in bytes - @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 { +/** \brief Create an IPSec interface + */ +define ipsec_itf_create { u32 client_index; u32 context; - bool is_add; - bool esn; - bool anti_replay; - vl_api_address_t local_ip; - vl_api_address_t remote_ip; - u32 local_spi; - u32 remote_spi; - u8 crypto_alg; - u8 local_crypto_key_len; - u8 local_crypto_key[128]; - u8 remote_crypto_key_len; - u8 remote_crypto_key[128]; - u8 integ_alg; - u8 local_integ_key_len; - u8 local_integ_key[128]; - u8 remote_integ_key_len; - u8 remote_integ_key[128]; - bool renumber; - u32 show_instance; - bool udp_encap; - u32 tx_table_id; - u32 salt; + vl_api_ipsec_itf_t itf; }; -/** \brief Add/delete IPsec tunnel interface response +/** \brief Add IPsec interface interface response @param context - sender context, to match reply w/ request @param retval - return status @param sw_if_index - sw_if_index of new interface (for successful add) */ -define ipsec_tunnel_if_add_del_reply { +define ipsec_itf_create_reply +{ u32 context; i32 retval; vl_api_interface_index_t sw_if_index; }; +autoreply define ipsec_itf_delete +{ + u32 client_index; + u32 context; + vl_api_interface_index_t sw_if_index; +}; + +define ipsec_itf_dump +{ + u32 client_index; + u32 context; + vl_api_interface_index_t sw_if_index; +}; + +define ipsec_itf_details +{ + u32 context; + vl_api_ipsec_itf_t itf; +}; + /** \brief Dump IPsec security association @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sa_id - optional ID of an SA to dump, if ~0 dump all SAs in SAD */ -define ipsec_sa_dump { +define ipsec_sa_dump +{ + u32 client_index; + u32 context; + u32 sa_id; +}; +define ipsec_sa_v2_dump +{ u32 client_index; u32 context; u32 sa_id; @@ -392,30 +391,15 @@ define ipsec_sa_dump { /** \brief IPsec security association database response @param context - sender context which was passed in the request - @param sa_id - SA ID, policy-based SAs >=0, tunnel interface SAs = 0 + @param entry - The SA details @param sw_if_index - sw_if_index of tunnel interface, policy-based SAs = ~0 - @param spi - security parameter index - @param protocol - IPsec protocol (value from ipsec_protocol_t) - @param crypto_alg - crypto algorithm (value from ipsec_crypto_alg_t) - @param crypto_key_len - length of crypto_key in bytes - @param crypto_key - crypto keying material - @param integ_alg - integrity algorithm (value from ipsec_integ_alg_t) - @param integ_key_len - length of integ_key in bytes - @param integ_key - integrity keying material - @param use_esn - using extended sequence numbers when non-zero - @param use_anti_replay - using anti-replay window when non-zero - @param is_tunnel - IPsec tunnel mode when non-zero, else transport mode - @param is_tunnel_ipv6 - If using tunnel mode, endpoints are IPv6 - @param tunnel_src_addr - Tunnel source address if using tunnel mode - @param tunnel_dst_addr - Tunnel destination address is using tunnel mode @param salt - 4 byte salt @param seq - current sequence number for outbound @param seq_hi - high 32 bits of ESN for outbound @param last_seq - highest sequence number received inbound @param last_seq_hi - high 32 bits of highest ESN received inbound @param replay_window - bit map of seq nums received relative to last_seq if using anti-replay - @param total_data_size - total bytes sent or received - @param udp_encap - 1 if UDP encap enabled, 0 otherwise + @param stat_index - index for the SA in the stats segment @ /net/ipsec/sa */ define ipsec_sa_details { u32 context; @@ -427,25 +411,19 @@ define ipsec_sa_details { u64 last_seq_inbound; u64 replay_window; - u64 total_data_size; + u32 stat_index; }; - -/** \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 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 { - u32 client_index; +define ipsec_sa_v2_details { u32 context; + vl_api_ipsec_sad_entry_v2_t entry; + vl_api_interface_index_t sw_if_index; - u32 sa_id; - u8 is_outbound; + u32 salt; + u64 seq_outbound; + u64 last_seq_inbound; + u64 replay_window; + + u32 stat_index; }; /** \brief Dump IPsec backends @@ -484,6 +462,18 @@ autoreply define ipsec_select_backend { u8 index; }; + +/** \brief IPsec Set Async mode + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param async_enable - ipsec async mode on or off +*/ +autoreply define ipsec_set_async_mode { + u32 client_index; + u32 context; + bool async_enable; +}; + /* * Local Variables: * eval: (c-set-style "gnu")