[feature] OpenVpn: added option proto to remote setting

Co-authored-by: Federico Capoano <f.capoano@openwisp.io>

Author: okraits

netjsonconfig/backends/openvpn/converters.py

@@ -42,7 +42,12 @@ def __intermediate_vpn(self, config, remove=[False, 0, '']):
             del config[key]
         # reformat remote list in order for simpler handling in template
         if 'remote' in config:
-            remote = ['{host} {port}'.format(**r) for r in config['remote']]
+            remote = [
+                '{host} {port} {proto}'.format(**r)
+                if 'proto' in r.keys() and r['proto'] != 'auto'
+                else '{host} {port}'.format(**r)
+                for r in config['remote']
+            ]
             config['remote'] = remote
         # do not display status-version if status directive not present
         if 'status' not in config and 'status_version' in config:
@@ -95,7 +100,12 @@ def __netjson_vpn(self, vpn):
         if 'remote' in vpn:
             remote = []
             for r in vpn['remote']:
-                host, port = r.split()
-                remote.append(dict(host=host, port=int(port)))
+                items = r.split()
+                if len(items) == 3:
+                    remote.append(
+                        dict(host=items[0], port=int(items[1]), proto=items[2])
+                    )
+                else:
+                    remote.append(dict(host=items[0], port=int(items[1])))
             vpn['remote'] = remote
         return vpn

netjsonconfig/backends/openvpn/schema.py

@@ -517,6 +517,32 @@
                                         "minimum": 1,
                                         "propertyOrder": 2,
                                     },
+                                    "proto": {
+                                        "title": "protocol",
+                                        "type": "string",
+                                        "default": "auto",
+                                        "enum": [
+                                            "auto",
+                                            "udp",
+                                            "udp4",
+                                            "udp6",
+                                            "tcp",
+                                            "tcp4",
+                                            "tcp6",
+                                        ],
+                                        "options": {
+                                            "enum_titles": [
+                                                "Default (automatically determined)",
+                                                "UDP",
+                                                "UDP IPv4",
+                                                "UDP IPv6",
+                                                "TCP",
+                                                "TCP IPv4",
+                                                "TCP IPv6",
+                                            ]
+                                        },
+                                        "propertyOrder": 3,
+                                    },
                                 },
                             },
                         },

tests/openvpn/test_backend.py

@@ -145,7 +145,9 @@ def test_client_mode(self):
                         "pull": True,
                         "remote": [
                             {"host": "vpn1.test.com", "port": 1194},
-                            {"host": "176.9.43.231", "port": 1195},
+                            {"host": "176.9.43.231", "port": 1195, "proto": "udp4"},
+                            {"host": "176.9.43.232", "port": 1195, "proto": "auto"},
+                            {"host": "176.9.43.233", "port": 1196, "proto": "udp6"},
                         ],
                         "resolv_retry": "infinite",
                         "script_security": 1,
@@ -191,7 +193,9 @@ def test_client_mode(self):
 proto tcp-client
 pull
 remote vpn1.test.com 1194
-remote 176.9.43.231 1195
+remote 176.9.43.231 1195 udp4
+remote 176.9.43.232 1195
+remote 176.9.43.233 1196 udp6
 resolv-retry infinite
 script-security 1
 status /var/log/openvpn.status 30