Add basic support for DS-Lite CE (VPP-1059)

[vpp.git] / src / plugins / nat / nat.api

diff --git a/src/plugins/nat/nat.api b/src/plugins/nat/nat.api
index d515a76..6ebe4e3 100644 (file)
--- a/src/plugins/nat/nat.api
+++ b/src/plugins/nat/nat.api
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-vl_api_version 2.0.0
+vl_api_version 2.1.0
 
 /**
  * @file nat.api
@@ -230,6 +230,7 @@ define nat_reass_details {
     @param first_ip_address - first IPv4 address
     @param last_ip_address - last IPv4 address
     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
+    @param twice_nat - twice NAT address range for extenal hosts
     @param is_add - 1 if add, 0 if delete
 */
 autoreply define nat44_add_del_address_range {
@@ -238,6 +239,7 @@ autoreply define nat44_add_del_address_range {
   u8 first_ip_address[4];
   u8 last_ip_address[4];
   u32 vrf_id;
+  u8 twice_nat;
   u8 is_add;
 };
 
@@ -253,11 +255,13 @@ define nat44_address_dump {
 /** \brief NAT44 address details response
     @param context - sender context, to match reply w/ request
     @param ip_address - IPv4 address
+    @param twice_nat - twice NAT address range for extenal hosts
     @param vrf_id - VRF id of tenant, ~0 means independent of VRF
 */
 define nat44_address_details {
   u32 context;
   u8 ip_address[4];
+  u8 twice_nat;
   u32 vrf_id;
 };
 
@@ -346,6 +350,8 @@ define nat44_interface_output_feature_details {
                                   external_ip_address is ignored, ~0 means not
                                   used)
     @param vfr_id - VRF ID
+    @param twice_nat - if 1 translate external host address and port, only for
+                       1:1 NAPT (addr_only must be 0)
 */
 autoreply define nat44_add_del_static_mapping {
   u32 client_index;
@@ -359,6 +365,7 @@ autoreply define nat44_add_del_static_mapping {
   u16 external_port;
   u32 external_sw_if_index;
   u32 vrf_id;
+  u8 twice_nat;
 };
 
 /** \brief Dump NAT44 static mappings
@@ -380,6 +387,7 @@ define nat44_static_mapping_dump {
     @param external_port - external port number
     @param external_sw_if_index - external interface
     @param vfr_id - VRF ID
+    @param twice_nat - if 1 translate external host address and port
 */
 define nat44_static_mapping_details {
   u32 context;
@@ -391,19 +399,73 @@ define nat44_static_mapping_details {
   u16 external_port;
   u32 external_sw_if_index;
   u32 vrf_id;
+  u8 twice_nat;
+};
+
+/** \brief Add/delete NAT44 identity mapping
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param is_add - 1 if add, 0 if delete
+    @param addr_only - 1 if address only mapping
+    @param ip_address - IPv4 address
+    @param protocol - IP protocol
+    @param port - port number
+    @param sw_if_index - interface (if set ip_address is ignored, ~0 means not
+                                    used)
+    @param vfr_id - VRF ID (if ~0 use default VRF)
+*/
+autoreply define nat44_add_del_identity_mapping {
+  u32 client_index;
+  u32 context;
+  u8 is_add;
+  u8 addr_only;
+  u8 ip_address[4];
+  u8 protocol;
+  u16 port;
+  u32 sw_if_index;
+  u32 vrf_id;
+};
+
+/** \brief Dump NAT44 identity mappings
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define nat44_identity_mapping_dump {
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief NAT44 identity mapping details response
+    @param context - sender context, to match reply w/ request
+    @param addr_only - 1 if address only mapping
+    @param ip_address - IPv4 address
+    @param protocol - IP protocol
+    @param port - port number
+    @param sw_if_index - interface
+    @param vfr_id - VRF ID
+*/
+define nat44_identity_mapping_details {
+  u32 context;
+  u8 addr_only;
+  u8 ip_address[4];
+  u8 protocol;
+  u16 port;
+  u32 sw_if_index;
+  u32 vrf_id;
 };
 
 /** \brief Add/delete NAT44 pool address from specific interfce
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param is_add - 1 if add, 0 if delete
+    @param twice_nat - twice NAT address for extenal hosts
     @param sw_if_index - software index of the interface
 */
 autoreply define nat44_add_del_interface_addr {
   u32 client_index;
   u32 context;
   u8 is_add;
-  u8 is_inside;
+  u8 twice_nat;
   u32 sw_if_index;
 };
 
@@ -419,10 +481,12 @@ define nat44_interface_addr_dump {
 /** \brief NAT44 pool addresses interfaces details response
     @param context - sender context, to match reply w/ request
     @param sw_if_index - software index of the interface
+    @param twice_nat - twice NAT address for extenal hosts
 */
 define nat44_interface_addr_details {
   u32 context;
   u32 sw_if_index;
+  u8 twice_nat;
 };
 
 /** \brief Dump NAT44 users
@@ -502,6 +566,7 @@ autoreply manual_endian define nat44_add_del_lb_static_mapping {
   u16 external_port;
   u8 protocol;
   u32 vrf_id;
+  u8 twice_nat;
   u8 local_num;
   vl_api_nat44_lb_addr_port_t locals[local_num];
 };
@@ -517,6 +582,7 @@ manual_endian define nat44_lb_static_mapping_details {
   u16 external_port;
   u8 protocol;
   u32 vrf_id;
+  u8 twice_nat;
   u8 local_num;
   vl_api_nat44_lb_addr_port_t locals[local_num];
 };
@@ -540,6 +606,37 @@ autoreply define nat44_del_session {
   u32 vrf_id;
 };
 
+/** \brief Enable/disable forwarding for NAT44
+    Forward packets which don't match existing translation
+    or static mapping instead of dropping them.
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param enable - 0 for enable, 1 for disable
+*/
+autoreply define nat44_forwarding_enable_disable {
+  u32 client_index;
+  u32 context;
+  u8 enable;
+};
+
+/** \brief Check if forwarding is enabled or disabled
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define nat44_forwarding_is_enabled {
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Response to check if forwarding is enabled or disabled
+    @param context - sender context, to match reply w/ request
+    @param enabled - 1 if enabled, 0 if disabled
+*/
+define nat44_forwarding_is_enabled_reply {
+  u32 context;
+  u8 enabled;
+};
+
 
 /*
  * Deterministic NAT (CGN) APIs
@@ -1062,9 +1159,72 @@ autoreply define dslite_add_del_pool_addr_range {
   u8 is_add;
 };
 
+/** \brief Set AFTR IPv6 and IPv4 addresses
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param ip4_addr - IPv4 address
+    @param ip6_addr - IP64 address
+*/
 autoreply define dslite_set_aftr_addr {
   u32 client_index;
   u32 context;
   u8 ip4_addr[4];
   u8 ip6_addr[16];
 };
+
+/** \brief Get AFTR IPv6 and IPv4 addresses
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define dslite_get_aftr_addr {
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Response to get AFTR IPv6 and IPv4 addresses
+    @param context - sender context, to match reply w/ request
+    @param retval - return code
+    @param ip4_addr - IPv4 address
+    @param ip6_addr - IP64 address
+*/
+define dslite_get_aftr_addr_reply {
+  u32 context;
+  i32 retval;
+  u8 ip4_addr[4];
+  u8 ip6_addr[16];
+};
+
+/** \brief Set B4 IPv6 and IPv4 addresses
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param ip4_addr - IPv4 address
+    @param ip6_addr - IP64 address
+*/
+autoreply define dslite_set_b4_addr {
+  u32 client_index;
+  u32 context;
+  u8 ip4_addr[4];
+  u8 ip6_addr[16];
+};
+
+/** \brief Get B4 IPv6 and IPv4 addresses
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define dslite_get_b4_addr {
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Response to get B4 IPv6 and IPv4 addresses
+    @param context - sender context, to match reply w/ request
+    @param retval - return code
+    @param ip4_addr - IPv4 address
+    @param ip6_addr - IP64 address
+*/
+define dslite_get_b4_addr_reply {
+  u32 context;
+  i32 retval;
+  u8 ip4_addr[4];
+  u8 ip6_addr[16];
+};