X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fipsec%2Fipsec.api;h=9b091317ee01d9261b974e9c10258c5b6c366cc1;hb=95f59f380;hp=b5027f6030140100c7e7e3597463cc85db676bc5;hpb=282872127bbeee6ae59ab3f885c09bad601ee0cc;p=vpp.git diff --git a/src/vnet/ipsec/ipsec.api b/src/vnet/ipsec/ipsec.api index b5027f60301..9b091317ee0 100644 --- a/src/vnet/ipsec/ipsec.api +++ b/src/vnet/ipsec/ipsec.api @@ -14,10 +14,13 @@ * limitations under the License. */ -option version = "3.0.0"; +option version = "4.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 @@ -30,7 +33,7 @@ autoreply define ipsec_spd_add_del { u32 client_index; u32 context; - u8 is_add; + bool is_add; u32 spd_id; }; @@ -49,8 +52,8 @@ autoreply define ipsec_interface_add_del_spd u32 client_index; u32 context; - u8 is_add; - u32 sw_if_index; + bool is_add; + vl_api_interface_index_t sw_if_index; u32 spd_id; }; @@ -90,10 +93,11 @@ typedef ipsec_spd_entry { u32 spd_id; i32 priority; - u8 is_outbound; + bool is_outbound; u32 sa_id; vl_api_ipsec_spd_action_t policy; + /* Which protocol?? */ u8 protocol; // Selector @@ -119,7 +123,7 @@ define ipsec_spd_entry_add_del { u32 client_index; u32 context; - u8 is_add; + bool is_add; vl_api_ipsec_spd_entry_t entry; }; @@ -154,7 +158,7 @@ define ipsec_spds_details { u32 context; u32 spd_id; u32 npolicies; -}; +}; /** \brief Dump ipsec policy database data @param client_index - opaque cookie to identify the sender @@ -189,15 +193,28 @@ define ipsec_sad_entry_add_del { u32 client_index; u32 context; - u8 is_add; + 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 @@ -304,7 +321,7 @@ define ipsec_spd_interface_dump { define ipsec_spd_interface_details { u32 context; u32 spd_index; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; }; /** \brief Add or delete IPsec tunnel interface @@ -339,11 +356,12 @@ define ipsec_spd_interface_details { @param salt - for use with counter mode ciphers */ define ipsec_tunnel_if_add_del { + option deprecated; u32 client_index; u32 context; - u8 is_add; - u8 esn; - u8 anti_replay; + bool is_add; + bool esn; + bool anti_replay; vl_api_address_t local_ip; vl_api_address_t remote_ip; u32 local_spi; @@ -358,9 +376,9 @@ define ipsec_tunnel_if_add_del { u8 local_integ_key[128]; u8 remote_integ_key_len; u8 remote_integ_key[128]; - u8 renumber; + bool renumber; u32 show_instance; - u8 udp_encap; + bool udp_encap; u32 tx_table_id; u32 salt; }; @@ -371,9 +389,57 @@ define ipsec_tunnel_if_add_del { @param sw_if_index - sw_if_index of new interface (for successful add) */ define ipsec_tunnel_if_add_del_reply { + option deprecated; u32 context; i32 retval; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; +}; + +typedef ipsec_itf +{ + u32 user_instance [default=0xffffffff]; + vl_api_tunnel_mode_t mode; + vl_api_interface_index_t sw_if_index; +}; + +/** \brief Create an IPSec interface + */ +define ipsec_itf_create { + u32 client_index; + u32 context; + vl_api_ipsec_itf_t itf; +}; + +/** \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_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 @@ -381,7 +447,14 @@ define ipsec_tunnel_if_add_del_reply { @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; @@ -389,42 +462,39 @@ 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 salt - 4 byte salt @param seq - current sequence number for outbound - @param seq_hi - high 32 bits of ESN 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; vl_api_ipsec_sad_entry_t entry; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; + u32 salt; + u64 seq_outbound; + u64 last_seq_inbound; + u64 replay_window; + + u32 stat_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 salt; u64 seq_outbound; u64 last_seq_inbound; u64 replay_window; - u64 total_data_size; + u32 stat_index; }; /** \brief Set new SA on IPsec interface @@ -438,9 +508,10 @@ define ipsec_sa_details { @param is_outbound - 1 if outbound (local) SA, 0 if inbound (remote) */ autoreply define ipsec_tunnel_if_set_sa { + option deprecated; u32 client_index; u32 context; - u32 sw_if_index; + vl_api_interface_index_t sw_if_index; u32 sa_id; u8 is_outbound; }; @@ -462,10 +533,10 @@ define ipsec_backend_dump { */ define ipsec_backend_details { u32 context; - u8 name[128]; + string name[128]; vl_api_ipsec_proto_t protocol; u8 index; - u8 active; + bool active; }; /** \brief Select IPsec backend @@ -481,9 +552,20 @@ 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") * End: */ -