Merge pull request #16 from sever-sever/T7181

T7181: VPP add initial source NAT implentation

7 files changed, 352 insertions, 2 deletions

diff --git a/data/config-mode-dependencies/vyos-vpp.json b/data/config-mode-dependencies/vyos-vpp.json
index 04dc4a771..50e465e80 100644
--- a/data/config-mode-dependencies/vyos-vpp.json
+++ b/data/config-mode-dependencies/vyos-vpp.json
@@ -10,34 +10,42 @@
         "vpp_interfaces_loopback": ["vpp_interfaces_loopback"],
         "vpp_interfaces_vxlan": ["vpp_interfaces_vxlan"],
         "vpp_interfaces_xconnect": ["vpp_interfaces_xconnect"],
+        "vpp_nat_source": ["vpp_nat_source"],
         "vpp_kernel_interface": ["vpp_kernel-interfaces"]
     },
     "vpp_interfaces_bonding": {
         "vpp_interfaces_xconnect": ["vpp_interfaces_xconnect"],
+        "vpp_nat_source": ["vpp_nat_source"],
         "vpp_kernel_interface": ["vpp_kernel-interfaces"]
     },
     "vpp_interfaces_ethernet": {
         "vpp_interfaces_xconnect": ["vpp_interfaces_xconnect"],
+        "vpp_nat_source": ["vpp_nat_source"],
         "vpp_kernel_interface": ["vpp_kernel-interfaces"]
     },
     "vpp_interfaces_geneve": {
         "vpp_interfaces_xconnect": ["vpp_interfaces_xconnect"],
+        "vpp_nat_source": ["vpp_nat_source"],
         "vpp_kernel_interface": ["vpp_kernel-interfaces"]
     },
     "vpp_interfaces_gre": {
         "vpp_interfaces_xconnect": ["vpp_interfaces_xconnect"],
+        "vpp_nat_source": ["vpp_nat_source"],
         "vpp_kernel_interface": ["vpp_kernel-interfaces"]
     },
     "vpp_interfaces_ipip": {
         "vpp_interfaces_xconnect": ["vpp_interfaces_xconnect"],
+        "vpp_nat_source": ["vpp_nat_source"],
         "vpp_kernel_interface": ["vpp_kernel-interfaces"]
     },
     "vpp_interfaces_loopback": {
+        "vpp_nat_source": ["vpp_nat_source"],
         "vpp_kernel_interface": ["vpp_kernel-interfaces"]
     },
     "vpp_interfaces_vxlan": {
         "vpp_interfaces_bridge": ["vpp_interfaces_bridge"],
         "vpp_interfaces_xconnect": ["vpp_interfaces_xconnect"],
+        "vpp_nat_source": ["vpp_nat_source"],
         "vpp_kernel_interface": ["vpp_kernel-interfaces"]
     }
 }
diff --git a/data/templates/vpp/startup.conf.j2 b/data/templates/vpp/startup.conf.j2
index 57a03386a..1cba80f4e 100644
--- a/data/templates/vpp/startup.conf.j2
+++ b/data/templates/vpp/startup.conf.j2
@@ -94,8 +94,8 @@ plugins {
     plugin pppoe_plugin.so { enable }
     # NAT uncomment if needed
     # plugin cnat_plugin.so { enable }
-    # plugin nat_plugin.so { enable }
-    # plugin nat44_plugin.so { enable }
+    plugin nat_plugin.so { enable }
+    plugin nat44_ei_plugin.so { enable }
     # plugin nat44_ei_plugin.so { enable }
     # plugin nat64_plugin.so { enable }
     # plugin nat66_plugin.so { enable }
diff --git a/interface-definitions/vpp.xml.in b/interface-definitions/vpp.xml.in
index 150803a0d..138991084 100644
--- a/interface-definitions/vpp.xml.in
+++ b/interface-definitions/vpp.xml.in
@@ -842,6 +842,71 @@
         </node>
       </children>
     </node>
+    <node name="nat44">
+      <properties>
+        <help>NAT44</help>
+      </properties>
+      <children>
+        <node name="source" owner="${vyos_conf_scripts_dir}/vpp_nat_source.py">
+          <properties>
+            <help>Source NAT setting</help>
+            <priority>320</priority>
+          </properties>
+          <children>
+            <leafNode name="inbound-interface">
+              <properties>
+                <help>Inbound interface of NAT traffic</help>
+                <completionHelp>
+                  <list>any</list>
+                  <script>${vyos_completion_dir}/list_interfaces</script>
+                </completionHelp>
+              </properties>
+            </leafNode>
+            <leafNode name="outbound-interface">
+              <properties>
+                <help>Outbound interface of NAT traffic</help>
+                <completionHelp>
+                  <list>any</list>
+                  <script>${vyos_completion_dir}/list_interfaces</script>
+                </completionHelp>
+              </properties>
+            </leafNode>
+            <node name="translation">
+              <properties>
+                <help>Outside NAT IP (source NAT only)</help>
+              </properties>
+              <children>
+                <leafNode name="address">
+                  <properties>
+                    <help>IP address, subnet, or range</help>
+                    <completionHelp>
+                      <list>masquerade</list>
+                    </completionHelp>
+                    <valueHelp>
+                      <format>ipv4</format>
+                      <description>IPv4 address to match</description>
+                    </valueHelp>
+                    <valueHelp>
+                      <format>ipv4range</format>
+                      <description>IPv4 address range to match</description>
+                    </valueHelp>
+                    <valueHelp>
+                      <format>masquerade</format>
+                      <description>NAT to the primary address of outbound-interface</description>
+                    </valueHelp>
+                    <constraint>
+                      <validator name="ipv4-address"/>
+                      <validator name="ipv4-range"/>
+                      <regex>(masquerade)</regex>
+                    </constraint>
+                  </properties>
+                </leafNode>
+              </children>
+            </node>
+          </children>
+        </node>
+      </children>
+    </node>
     <tagNode name="kernel-interfaces" owner="${vyos_conf_scripts_dir}/vpp_kernel-interfaces.py">
       <properties>
         <help>VPP kernel interface settings</help>
diff --git a/python/vyos/vpp/nat/__init__.py b/python/vyos/vpp/nat/__init__.py
index e69de29bb..bbd011435 100644
--- a/python/vyos/vpp/nat/__init__.py
+++ b/python/vyos/vpp/nat/__init__.py
@@ -0,0 +1,3 @@
+from .nat44 import Nat44
+
+__all__ = ['Nat44']
diff --git a/python/vyos/vpp/nat/nat44.py b/python/vyos/vpp/nat/nat44.py
new file mode 100644
index 000000000..47d0ced1d
--- /dev/null
+++ b/python/vyos/vpp/nat/nat44.py
@@ -0,0 +1,151 @@
+#
+# Copyright (C) 2025 VyOS Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+from vyos.vpp import VPPControl
+
+
+class Nat44:
+    def __init__(
+        self,
+        interface_in: str,
+        interface_out: str,
+        translation_pool: str,
+    ):
+        self.interface_in = interface_in
+        self.interface_out = interface_out
+        self.translation_pool = translation_pool
+        self.vpp = VPPControl()
+
+    def enable_nat44_ed(self):
+        """Enable NAT44 endpoint dependent plugin
+        Example:
+            from vyos.vpp.nat import Nat44
+            nat44 = Nat44()
+            nat44.enable_nat44_ed()
+        https://github.com/FDio/vpp/blob/stable/2410/src/plugins/nat/nat44-ed/nat44_ed.api
+        """
+        self.vpp.api.nat44_ed_plugin_enable_disable(enable=True)
+
+    def enable_nat44_ei(self):
+        """Enable NAT44 endpoint independent plugin
+        Example:
+            from vyos.vpp.nat import Nat44
+            nat44 = Nat44()
+            nat44.enable_nat44_ei()
+        """
+        self.vpp.api.nat44_ei_plugin_enable_disable(enable=True)
+
+    def enable_nat44_forwarding(self):
+        """Enable NAT44 forwarding
+        Example:
+            from vyos.vpp.nat import Nat44
+            nat44 = Nat44()
+            nat44.enable_nat44_forwarding()
+        """
+        self.vpp.api.nat44_forwarding_enable_disable(enable=True)
+
+    def disable_nat44_forwarding(self):
+        """Disable NAT44 forwarding
+        Example:
+            from vyos.vpp.nat import Nat44
+            nat44 = Nat44()
+            nat44.disable_nat44_forwarding()
+        """
+        self.vpp.api.nat44_forwarding_enable_disable(enable=False)
+
+    def add_nat44_out_interface(self):
+        """Add NAT44 output interface
+        Example:
+            from vyos.vpp.nat import Nat44
+            nat44 = Nat44('eth0')
+            nat44.add_nat44_out_interface()
+        """
+        self.vpp.api.nat44_ed_add_del_output_interface(
+            sw_if_index=self.vpp.get_sw_if_index(self.interface_out),
+            is_add=True,
+        )
+
+    def delete_nat44_out_interface(self):
+        """Delete NAT44 output interface"""
+        self.vpp.api.nat44_ed_add_del_output_interface(
+            sw_if_index=self.vpp.get_sw_if_index(self.interface_out),
+            is_add=False,
+        )
+
+    # needs to check
+    def add_nat44_interface_inside(self):
+        """Add NAT44 interface"""
+        self.vpp.api.nat44_interface_add_del_feature(
+            flags=1,
+            sw_if_index=self.vpp.get_sw_if_index(self.interface_in),
+            is_add=True,
+        )
+
+    # needs to check
+    def delete_nat44_interface_inside(self):
+        """Delete NAT44 interface"""
+        self.vpp.api.nat44_interface_add_del_feature(
+            flags=1,
+            sw_if_index=self.vpp.get_sw_if_index(self.interface_in),
+            is_add=False,
+        )
+
+    # needs to check
+    def add_nat44_interface_outside(self):
+        """Add NAT44 interface"""
+        self.vpp.api.nat44_interface_add_del_feature(
+            flags=0,
+            sw_if_index=self.vpp.get_sw_if_index(self.interface_out),
+            is_add=True,
+        )
+
+    # needs to check
+    def delete_nat44_interface_outside(self):
+        """Delete NAT44 interface"""
+        self.vpp.api.nat44_interface_add_del_feature(
+            flags=0,
+            sw_if_index=self.vpp.get_sw_if_index(self.interface_out),
+            is_add=False,
+        )
+
+    def add_nat44_address_range(self):
+        """Add NAT44 address range"""
+        if '-' not in self.translation_pool and self.translation_pool != 'masquerade':
+            first_ip_address = last_ip_address = self.translation_pool
+        else:
+            first_ip_address, last_ip_address = self.translation_pool.split('-')
+        self.vpp.api.nat44_add_del_address_range(
+            first_ip_address=first_ip_address,
+            last_ip_address=last_ip_address,
+            is_add=True,
+        )
+
+    def delete_nat44_address_range(self):
+        """Delete NAT44 address range"""
+        if '-' not in self.translation_pool and self.translation_pool != 'masquerade':
+            first_ip_address = last_ip_address = self.translation_pool
+        else:
+            first_ip_address, last_ip_address = self.translation_pool.split('-')
+        self.vpp.api.nat44_add_del_address_range(
+            first_ip_address=first_ip_address,
+            last_ip_address=last_ip_address,
+            is_add=False,
+        )
+
+    def enable_ipfix(self):
+        """Enable NAT44 IPFIX logging"""
+        self.vpp.api.nat44_ei_ipfix_enable_disable(enable=True)
diff --git a/src/conf_mode/vpp.py b/src/conf_mode/vpp.py
index 90a3bb7fb..1f4c6c0f0 100755
--- a/src/conf_mode/vpp.py
+++ b/src/conf_mode/vpp.py
@@ -135,6 +135,10 @@ def get_config(config=None):
             # to be reinitialized after the commit
             set_dependents('ethernet', conf, removed_iface)
 
+    # NAT dependency
+    if conf.exists(['vpp', 'nat44', 'source']):
+        set_dependents('vpp_nat_source', conf)
+
     if not conf.exists(base):
         return {
             'removed_ifaces': removed_ifaces,
diff --git a/src/conf_mode/vpp_nat_source.py b/src/conf_mode/vpp_nat_source.py
new file mode 100644
index 000000000..2e1884c3a
--- /dev/null
+++ b/src/conf_mode/vpp_nat_source.py
@@ -0,0 +1,119 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2025 VyOS Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+from vyos.config import Config
+from vyos import ConfigError
+from vyos.vpp.nat.nat44 import Nat44
+
+
+def get_config(config=None) -> dict:
+    if config:
+        conf = config
+    else:
+        conf = Config()
+
+    base = ['vpp', 'nat44', 'source']
+
+    # Get config_dict with default values
+    config = conf.get_config_dict(
+        base,
+        key_mangling=('-', '_'),
+        get_first_key=True,
+        no_tag_node_value_mangle=True,
+        with_defaults=True,
+        with_recursive_defaults=True,
+    )
+
+    # Get effective config as we need full dicitonary per interface delete
+    effective_config = conf.get_config_dict(
+        base,
+        key_mangling=('-', '_'),
+        effective=True,
+        get_first_key=True,
+        no_tag_node_value_mangle=True,
+    )
+
+    if not config:
+        config['remove'] = True
+
+    if effective_config:
+        config.update({'effective': effective_config})
+
+    return config
+
+
+def verify(config):
+    if 'remove' in config:
+        return None
+
+    required_keys = {'inbound_interface', 'outbound_interface'}
+    if not all(key in config for key in required_keys):
+        missing_keys = required_keys - set(config.keys())
+        raise ConfigError(
+            f"Required options are missing: {', '.join(missing_keys).replace('_', '-')}"
+        )
+
+    if not config.get('translation', {}).get('address'):
+        raise ConfigError('Translation requires address')
+
+    if config.get('translation', {}).get('address') == 'masquerade':
+        raise ConfigError('Masquerade is not implemented')
+
+
+def generate(config):
+    pass
+
+
+def apply(config):
+    # Delete NAT source
+    if 'effective' in config:
+        remove_config = config.get('effective')
+        interface_in = remove_config.get('inbound_interface')
+        interface_out = remove_config.get('outbound_interface')
+        translation_address = remove_config.get('translation', {}).get('address')
+
+        n = Nat44(interface_in, interface_out, translation_address)
+        n.delete_nat44_out_interface()
+        n.delete_nat44_interface_inside()
+        n.delete_nat44_address_range()
+
+    if 'remove' in config:
+        return None
+
+    # Add NAT44
+    interface_in = config.get('inbound_interface')
+    interface_out = config.get('outbound_interface')
+    translation_address = config.get('translation', {}).get('address')
+
+    n = Nat44(interface_in, interface_out, translation_address)
+    n.enable_nat44_ed()
+    n.enable_nat44_forwarding()
+    n.add_nat44_out_interface()
+    # n.add_nat44_interface_inside()
+    n.add_nat44_address_range()
+
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)