X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Fnat%2Fnat.api;h=1ff288dba2aa16816693763e5f28762539bf2860;hb=5d28c7af;hp=d515a769cb3922a84189599b070a721a11dfc200;hpb=c6fb36fc2eb43c6158b390918d295f2c8eba737b;p=vpp.git diff --git a/src/plugins/nat/nat.api b/src/plugins/nat/nat.api index d515a769cb3..1ff288dba2a 100644 --- 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 +option version = "4.0.0"; /** * @file nat.api @@ -67,6 +67,8 @@ define nat_show_config @param static_mapping_only - if 1 dynamic translations disabled @param static_mapping_connection_tracking - if 1 create session data @param deterministic - if 1 deterministic mapping + @param endpoint_dependent - if 1 endpoint-dependent mode + @param out2in_dpo - if 1 out2in dpo mode @param translation_buckets - number of translation hash buckets @param translation_memory_size - translation hash memory size @param user_buckets - number of user hash buckets @@ -74,6 +76,11 @@ define nat_show_config @param max_translations_per_user - maximum number of translations per user @param outside_vrf_id - outside VRF id @param inside_vrf_id - default inside VRF id + @param dslite_ce - if DS-Lite is CE/B4 element, if 0 AFTR elemet + @param nat64_bib_buckets - number of NAT64 BIB hash buckets + @param nat64_bib_memory_size - memory size of NAT64 BIB hash + @param nat64_st_buckets - number of NAT64 session table hash buckets + @param nat64_st_memory_size - memory size of NAT64 session table hash */ define nat_show_config_reply { @@ -82,6 +89,8 @@ define nat_show_config_reply u8 static_mapping_only; u8 static_mapping_connection_tracking; u8 deterministic; + u8 endpoint_dependent; + u8 out2in_dpo; u32 translation_buckets; u32 translation_memory_size; u32 user_buckets; @@ -89,6 +98,11 @@ define nat_show_config_reply u32 max_translations_per_user; u32 outside_vrf_id; u32 inside_vrf_id; + u8 dslite_ce; + u32 nat64_bib_buckets; + u32 nat64_bib_memory_size; + u32 nat64_st_buckets; + u32 nat64_st_memory_size; }; /** \brief Set NAT workers @@ -220,6 +234,104 @@ define nat_reass_details { u8 frag_n; }; +/** \brief Set values of timeouts for NAT sessions (seconds) + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param udp - UDP timeout (default 300sec) + @param tcp_established - TCP established timeout (default 7440sec) + @param tcp_transitory - TCP transitory timeout (default 240sec) + @param icmp - ICMP timeout (default 60sec) +*/ +autoreply define nat_set_timeouts { + u32 client_index; + u32 context; + u32 udp; + u32 tcp_established; + u32 tcp_transitory; + u32 icmp; +}; + +/** \brief Get values of timeouts for NAT sessions (seconds) + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request +*/ +define nat_get_timeouts { + u32 client_index; + u32 context; +}; + +/** \brief Get values of timeouts for NAT sessions reply + @param context - sender context, to match reply w/ request + @param retval - return code + @param udp - UDP timeout + @param tcp_established - TCP established timeout + @param tcp_transitory - TCP transitory timeout + @param icmp - ICMP timeout +*/ +define nat_get_timeouts_reply { + u32 context; + i32 retval; + u32 udp; + u32 tcp_established; + u32 tcp_transitory; + u32 icmp; +}; + +/** \brief Set address and port assignment algorithm + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param alg - address and port assignment algorithm: + 0 - default, 1 - MAP-E, 2 - port range + (see nat_addr_and_port_alloc_alg_t in nat.h) + @param psid_offset - number of offset bits (valid only for MAP-E alg) + @param psid_length - length of PSID (valid only for MAP-E alg) + @param psid - Port Set Identifier (PSID) value (valid only for MAP-E alg) + @param start_port - beginning of the port range + @param end_port - end of the port range +*/ +autoreply define nat_set_addr_and_port_alloc_alg { + u32 client_index; + u32 context; + u8 alg; + u8 psid_offset; + u8 psid_length; + u16 psid; + u16 start_port; + u16 end_port; +}; + +/** \brief Get address and port assignment algorithm + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request +*/ +define nat_get_addr_and_port_alloc_alg { + u32 client_index; + u32 context; +}; + +/** \brief Get address and port assignment algorithm reply + @param context - sender context, to match reply w/ request + @param retval - return code + @param alg - address and port assignment algorithm: + 0 - default, 1 - MAP-E, 2 - port range + (see nat_addr_and_port_alloc_alg_t in nat.h) + @param psid_offset - number of offset bits (valid only for MAP-E alg) + @param psid_length - length of PSID (valid only for MAP-E alg) + @param psid - Port Set Identifier (PSID) value (valid only for MAP-E alg) + @param start_port - beginning of the port range + @param end_port - end of the port range +*/ +define nat_get_addr_and_port_alloc_alg_reply { + u32 context; + i32 retval; + u8 alg; + u8 psid_offset; + u8 psid_length; + u16 psid; + u16 start_port; + u16 end_port; +}; + /* * NAT44 APIs */ @@ -230,6 +342,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 +351,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 +367,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; }; @@ -339,13 +455,20 @@ define nat44_interface_output_feature_details { @param addr_only - 1 if address only mapping @param local_ip_address - local IPv4 address @param external_ip_address - external IPv4 address - @param protocol - IP protocol - @param local_port - local port number - @param external_port - external port number + @param protocol - IP protocol, used only if addr_only=0 + @param local_port - local port number, used only if addr_only=0 + @param external_port - external port number, used only if addr_only=0 @param external_sw_if_index - external interface (if set 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) + @param self_twice_nat - if 1 translate external host address and port + whenever external host address equals + local address of internal host + @param out2in_only - if 1 rule match only out2in direction + @param tag - opaque string tag */ autoreply define nat44_add_del_static_mapping { u32 client_index; @@ -359,6 +482,10 @@ autoreply define nat44_add_del_static_mapping { u16 external_port; u32 external_sw_if_index; u32 vrf_id; + u8 twice_nat; + u8 self_twice_nat; + u8 out2in_only; + u8 tag[64]; }; /** \brief Dump NAT44 static mappings @@ -375,11 +502,17 @@ define nat44_static_mapping_dump { @param addr_only - 1 if address only mapping @param local_ip_address - local IPv4 address @param external_ip_address - external IPv4 address - @param protocol - IP protocol - @param local_port - local port number - @param external_port - external port number + @param protocol - IP protocol, valid only if addr_only=0 + @param local_port - local port number, valid only if addr_only=0 + @param external_port - external port number, valid only if addr_only=0 @param external_sw_if_index - external interface @param vfr_id - VRF ID + @param twice_nat - if 1 translate external host address and port + @param self_twice_nat - if 1 translate external host address and port + whenever external host address equals + local address of internal host + @param out2in_only - if 1 rule match only out2in direction + @param tag - opaque string tag */ define nat44_static_mapping_details { u32 context; @@ -391,19 +524,80 @@ define nat44_static_mapping_details { u16 external_port; u32 external_sw_if_index; u32 vrf_id; + u8 twice_nat; + u8 self_twice_nat; + u8 out2in_only; + u8 tag[64]; +}; + +/** \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) + @param tag - opaque string tag +*/ +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; + u8 tag[64]; +}; + +/** \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 + @param tag - opaque string tag +*/ +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; + u8 tag[64]; }; /** \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 +613,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 @@ -474,6 +670,14 @@ define nat44_user_session_dump { @param last_heard - last heard timer @param total_bytes - count of bytes sent through session @param total_pkts - count of pakets sent through session + @param is_twicenat - 1 if session is twice-nat + @param ext_host_valid - 1 if external host address and port are valid + @param ext_host_address - external host IPv4 address + @param ext_host_port - external host port + @param ext_host_nat_address - post-NAT external host IPv4 address (valid + only if twice-nat session) + @param ext_host_nat_port - post-NAT external host port (valid only if + twice-nat session) */ define nat44_user_session_details { u32 context; @@ -486,14 +690,44 @@ define nat44_user_session_details { u64 last_heard; u64 total_bytes; u32 total_pkts; + u8 is_twicenat; + u8 ext_host_valid; + u8 ext_host_address[4]; + u16 ext_host_port; + u8 ext_host_nat_address[4]; + u16 ext_host_nat_port; }; +/** \brief NAT44 load-balancing address and port pair + @param addr - IPv4 address of the internal node + @param port - L4 port number of the internal node + @param probability - probability of the internal node to be randomly matched +*/ typeonly manual_endian define nat44_lb_addr_port { u8 addr[4]; u16 port; u8 probability; + u32 vrf_id; }; +/** \brief Add/delete NAT44 load-balancing static mapping rule + @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 external_addr - external IPv4 address of the service + @param external_port - external L4 port number of the service + @param protocol - IP protocol number of the service + @param twice_nat - if 1 translate external host address and port + @param self_twice_nat - if 1 translate external host address and port + whenever external host address equals + local address of internal host + @param out2in_only - if 1 rule match only out2in direction + @param tag - opaque string tag + @param affinity - if 0 disabled, otherwise client IP affinity sticky time + in seconds + @param local_num - number of local network nodes + @param locals - local network nodes +*/ autoreply manual_endian define nat44_add_del_lb_static_mapping { u32 client_index; u32 context; @@ -501,22 +735,51 @@ autoreply manual_endian define nat44_add_del_lb_static_mapping { u8 external_addr[4]; u16 external_port; u8 protocol; - u32 vrf_id; + u8 twice_nat; + u8 self_twice_nat; + u8 out2in_only; + u8 tag[64]; + u32 affinity; u8 local_num; vl_api_nat44_lb_addr_port_t locals[local_num]; }; +/** \brief Dump NAT44 load-balancing static mapping rules + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request +*/ define nat44_lb_static_mapping_dump { u32 client_index; u32 context; }; +/** \brief NAT44 load-balancing static mapping rule details response + @param context - sender context, to match reply w/ request + @param is_add - 1 if add, 0 if delete + @param external_addr - external IPv4 address of the service + @param external_port - external L4 port number of the service + @param protocol - IP protocol number of the service + @param twice_nat - if 1 translate external host address and port + @param self_twice_nat - if 1 translate external host address and port + whenever external host address equals + local address of internal host + @param out2in_only - if 1 rule match only out2in direction + @param tag - opaque string tag + @param affinity - if 0 disabled, otherwise client IP affinity sticky time + in seconds + @param local_num - number of local network nodes + @param locals - local network nodes +*/ manual_endian define nat44_lb_static_mapping_details { u32 context; u8 external_addr[4]; u16 external_port; u8 protocol; - u32 vrf_id; + u8 twice_nat; + u8 self_twice_nat; + u8 out2in_only; + u8 tag[64]; + u32 affinity; u8 local_num; vl_api_nat44_lb_addr_port_t locals[local_num]; }; @@ -529,6 +792,9 @@ manual_endian define nat44_lb_static_mapping_details { @param protocol - IP protocol @param port - port number @param vfr_id - VRF ID + @param ext_host_valid - 1 if external host address and port are valid + @param ext_host_address - external host IPv4 address + @param ext_host_port - external host port */ autoreply define nat44_del_session { u32 client_index; @@ -538,6 +804,40 @@ autoreply define nat44_del_session { u8 protocol; u16 port; u32 vrf_id; + u8 ext_host_valid; + u8 ext_host_address[4]; + u16 ext_host_port; +}; + +/** \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; }; @@ -653,49 +953,6 @@ define nat_det_map_details { u32 ses_num; }; -/** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default) - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - @param udp - UDP timeout (default 300sec) - @param tcp_established - TCP established timeout (default 7440sec) - @param tcp_transitory - TCP transitory timeout (default 240sec) - @param icmp - ICMP timeout (default 60sec) -*/ -autoreply define nat_det_set_timeouts { - u32 client_index; - u32 context; - u32 udp; - u32 tcp_established; - u32 tcp_transitory; - u32 icmp; -}; - -/** \brief Get values of timeouts for deterministic NAT (seconds) - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request -*/ -define nat_det_get_timeouts { - u32 client_index; - u32 context; -}; - -/** \brief Get values of timeouts for deterministic NAT reply - @param context - sender context, to match reply w/ request - @param retval - return code - @param udp - UDP timeout (default 300sec) - @param tcp_established - TCP established timeout (default 7440sec) - @param tcp_transitory - TCP transitory timeout (default 240sec) - @param icmp - ICMP timeout (default 60sec) -*/ -define nat_det_get_timeouts_reply { - u32 context; - i32 retval; - u32 udp; - u32 tcp_established; - u32 tcp_transitory; - u32 icmp; -}; - /** \brief Close deterministic NAT session by outside address and port @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -755,7 +1012,6 @@ define nat_det_session_dump { @param expire - session expiration timestamp */ define nat_det_session_details { - u32 client_index; u32 context; u16 in_port; u8 ext_addr[4]; @@ -902,53 +1158,6 @@ define nat64_bib_details { u32 ses_num; }; -/** \brief Set values of timeouts for NAT64 (seconds, 0 = default) - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request - @param udp - UDP timeout (default 300sec) - @param icmp - ICMP timeout (default 60sec) - @param tcp_trans - TCP transitory timeout (default 240sec) - @param tcp_est - TCP established timeout (default 7440sec) - @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec) -*/ -autoreply define nat64_set_timeouts { - u32 client_index; - u32 context; - u32 udp; - u32 icmp; - u32 tcp_trans; - u32 tcp_est; - u32 tcp_incoming_syn; -}; - -/** \brief Get values of timeouts for NAT64 (seconds) - @param client_index - opaque cookie to identify the sender - @param context - sender context, to match reply w/ request -*/ -define nat64_get_timeouts { - u32 client_index; - u32 context; -}; - -/** \brief Get values of timeouts for NAT64 reply - @param context - sender context, to match reply w/ request - @param retval - return code - @param udp - UDP timeout - @param icmp - ICMP timeout - @param tcp_trans - TCP transitory timeout - @param tcp_est - TCP established timeout - @param tcp_incoming_syn - TCP incoming SYN timeout -*/ -define nat64_get_timeouts_reply { - u32 context; - i32 retval; - u32 udp; - u32 icmp; - u32 tcp_trans; - u32 tcp_est; - u32 tcp_incoming_syn; -}; - /** \brief Dump NAT64 session table @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @@ -1062,9 +1271,171 @@ autoreply define dslite_add_del_pool_addr_range { u8 is_add; }; +/** \brief Dump DS-Lite addresses + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request +*/ +define dslite_address_dump { + u32 client_index; + u32 context; +}; + +/** \brief DS-Lite address details response + @param context - sender context, to match reply w/ request + @param ip_address - IPv4 address +*/ +define dslite_address_details { + u32 context; + u8 ip_address[4]; +}; + +/** \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]; +}; + +/* + * NAT66 APIs + */ +/** \brief Enable/disable NAT66 feature on the interface + @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 is_inside - 1 if inside, 0 if outside + @param sw_if_index - software index of the interface +*/ +autoreply define nat66_add_del_interface { + u32 client_index; + u32 context; + u8 is_add; + u8 is_inside; + u32 sw_if_index; +}; + +/** \brief Dump interfaces with NAT66 feature + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request +*/ +define nat66_interface_dump { + u32 client_index; + u32 context; +}; + +/** \brief NAT66 interface details response + @param context - sender context, to match reply w/ request + @param is_inside - 1 if inside, 0 if outside + @param sw_if_index - software index of the interface +*/ +define nat66_interface_details { + u32 context; + u8 is_inside; + u32 sw_if_index; +}; + +/** \brief Add/delete 1:1 NAT66 + @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 local_ip_address - local IPv6 address + @param external_ip_address - external IPv6 address + @param vrf_id - VRF id of tenant +*/ +autoreply define nat66_add_del_static_mapping { + u32 client_index; + u32 context; + u8 is_add; + u8 local_ip_address[16]; + u8 external_ip_address[16]; + u32 vrf_id; +}; + +/** \brief Dump NAT66 static mappings + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request +*/ +define nat66_static_mapping_dump { + u32 client_index; + u32 context; +}; + +/** \brief NAT66 static mapping details response + @param context - sender context, to match reply w/ request + @param local_ip_address - local IPv6 address + @param external_ip_address - external IPv6 address + @param vrf_id - VRF id of tenant + @param total_bytes - count of bytes sent through static mapping + @param total_pkts - count of pakets sent through static mapping +*/ +define nat66_static_mapping_details { + u32 context; + u8 local_ip_address[16]; + u8 external_ip_address[16]; + u32 vrf_id; + u64 total_bytes; + u64 total_pkts; +};