ipsec: support per next-header next-nodes
[vpp.git] / src / vnet / ipsec / ipsec.api
index 9b09131..be45c3e 100644 (file)
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-option version = "4.0.0";
+option version = "5.0.2";
 
 import "vnet/ipsec/ipsec_types.api";
 import "vnet/interface_types.api";
@@ -191,6 +191,7 @@ define ipsec_spd_details {
  */
 define ipsec_sad_entry_add_del
 {
+  option deprecated;
   u32 client_index;
   u32 context;
   bool is_add;
@@ -203,8 +204,29 @@ define ipsec_sad_entry_add_del_v2
   bool is_add;
   vl_api_ipsec_sad_entry_v2_t entry;
 };
+define ipsec_sad_entry_add_del_v3
+{
+  u32 client_index;
+  u32 context;
+  bool is_add;
+  vl_api_ipsec_sad_entry_v3_t entry;
+};
+define ipsec_sad_entry_add
+{
+  u32 client_index;
+  u32 context;
+  vl_api_ipsec_sad_entry_v3_t entry;
+};
+autoreply define ipsec_sad_entry_del
+{
+  u32 client_index;
+  u32 context;
+  u32 id;
+};
+
 define ipsec_sad_entry_add_del_reply
 {
+  option deprecated;
   u32 context;
   i32 retval;
   u32 stat_index;
@@ -215,6 +237,18 @@ define ipsec_sad_entry_add_del_v2_reply
   i32 retval;
   u32 stat_index;
 };
+define ipsec_sad_entry_add_del_v3_reply
+{
+  u32 context;
+  i32 retval;
+  u32 stat_index;
+};
+define ipsec_sad_entry_add_reply
+{
+  u32 context;
+  i32 retval;
+  u32 stat_index;
+};
 
 /** \brief Add or Update Protection for a tunnel with IPSEC
 
@@ -324,77 +358,6 @@ 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
-
-    @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 {
-  option deprecated;
-  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;
-};
-
-/** \brief Add/delete IPsec tunnel 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 {
-  option deprecated;
-  u32 context;
-  i32 retval;
-  vl_api_interface_index_t sw_if_index;
-};
-
 typedef ipsec_itf
 {
   u32 user_instance [default=0xffffffff];
@@ -449,6 +412,7 @@ define ipsec_itf_details
 */
 define ipsec_sa_dump
 {
+  option deprecated;
   u32 client_index;
   u32 context;
   u32 sa_id;
@@ -459,6 +423,12 @@ define ipsec_sa_v2_dump
   u32 context;
   u32 sa_id;
 };
+define ipsec_sa_v3_dump
+{
+  u32 client_index;
+  u32 context;
+  u32 sa_id;
+};
 
 /** \brief IPsec security association database response
     @param context - sender context which was passed in the request
@@ -473,6 +443,7 @@ define ipsec_sa_v2_dump
     @param stat_index - index for the SA in the stats segment @ /net/ipsec/sa
 */
 define ipsec_sa_details {
+  option deprecated;
   u32 context;
   vl_api_ipsec_sad_entry_t entry;
 
@@ -496,24 +467,16 @@ define ipsec_sa_v2_details {
 
   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 {
-  option deprecated;
-  u32 client_index;
+define ipsec_sa_v3_details {
   u32 context;
+  vl_api_ipsec_sad_entry_v3_t entry;
+
   vl_api_interface_index_t sw_if_index;
-  u32 sa_id;
-  u8 is_outbound;
+  u64 seq_outbound;
+  u64 last_seq_inbound;
+  u64 replay_window;
+
+  u32 stat_index;
 };
 
 /** \brief Dump IPsec backends