[feature] OpenWrt: Added support for WPA3-Personal #194

This patch is tested on these.
- OpenWrt: latest (4b587f25614f3f7215360f96807ce760fa4ef3aa)
- hardware: TP-Link Archer C6 v2

Related to #194

Signed-off-by: Masashi Honma <masashi.honma@gmail.com>

Author: masap

netjsonconfig/backends/openwrt/converters/wireless.py

@@ -93,6 +93,7 @@ def __intermediate_encryption(self, wireless):
             'wep_shared': 'wep-shared',
             'wpa_personal': 'psk',
             'wpa2_personal': 'psk2',
+            'wpa3_personal': 'sae',
             'wpa_personal_mixed': 'psk-mixed',
             'wpa_enterprise': 'wpa',
             'wpa2_enterprise': 'wpa2',
@@ -121,6 +122,8 @@ def __intermediate_encryption(self, wireless):
             uci['key'] = encryption['key']
         # add ciphers
         cipher = encryption.get('cipher')
+        if protocol == 'wpa3_personal':
+            cipher = 'ccmp'
         if cipher and protocol.startswith('wpa') and cipher != 'auto':
             uci['encryption'] += '+{0}'.format(cipher)
         return uci
@@ -254,6 +257,7 @@ def __netjson_encryption(self, wifi):
                 'wep-shared': 'wep_shared',
                 'psk': 'wpa_personal',
                 'psk2': 'wpa2_personal',
+                'sae': 'wpa3_personal',
                 'psk-mixed': 'wpa_personal_mixed',
                 'wpa': 'wpa_enterprise',
                 'wpa2': 'wpa2_enterprise',

netjsonconfig/schema.py

@@ -358,6 +358,7 @@
                     "propertyOrder": 20,
                     "oneOf": [
                         {"$ref": "#/definitions/encryption_none"},
+                        {"$ref": "#/definitions/encryption_wpa3_personal"},
                         {"$ref": "#/definitions/encryption_wpa_personal"},
                         {"$ref": "#/definitions/encryption_wpa_enterprise_ap"},
                         {"$ref": "#/definitions/encryption_wps"},
@@ -375,6 +376,7 @@
                     "propertyOrder": 20,
                     "oneOf": [
                         {"$ref": "#/definitions/encryption_none"},
+                        {"$ref": "#/definitions/encryption_wpa3_personal"},
                         {"$ref": "#/definitions/encryption_wpa_personal"},
                         {"$ref": "#/definitions/encryption_wpa_enterprise_sta"},
                         {"$ref": "#/definitions/encryption_wep"},
@@ -454,6 +456,35 @@
                 }
             }
         },
+        "encryption_mfp_property_required": {
+            "required": ["ieee80211w"],
+            "properties": {
+                "ieee80211w": {
+                    "type": "string",
+                    "title": "management frame protection",
+                    "enum": ["2"],
+                    "options": {"enum_titles": ["required"]},
+                    "propertyOrder": 4,
+                }
+            },
+        },
+        "encryption_wpa3_personal": {
+            "title": "WPA3 only Personal",
+            "allOf": [
+                {"$ref": "#/definitions/encryption_base_settings"},
+                {"$ref": "#/definitions/encryption_cipher_property"},
+                {"$ref": "#/definitions/encryption_mfp_property_required"},
+                {
+                    "properties": {
+                        "protocol": {
+                            "enum": ["wpa3_personal"],
+                            "options": {"enum_titles": ["WPA3 Personal"]},
+                        },
+                        "key": {"minLength": 8},
+                    }
+                },
+            ],
+        },
         "encryption_wpa_personal": {
             "title": "WPA2/WPA Personal",
             "allOf": [

tests/openwrt/test_encryption.py

@@ -7,6 +7,53 @@
 class TestEncryption(unittest.TestCase, _TabsMixin):
     maxDiff = None
 
+    _wpa3_personal_netjson = {
+        "interfaces": [
+            {
+                "name": "wlan0",
+                "type": "wireless",
+                "wireless": {
+                    "radio": "radio0",
+                    "mode": "access_point",
+                    "ssid": "wpa3-personal",
+                    "encryption": {
+                        "protocol": "wpa3_personal",
+                        "cipher": "ccmp",
+                        "key": "passphrase012345",
+                        "ieee80211w": "2",
+                    },
+                },
+            }
+        ]
+    }
+    _wpa3_personal_uci = """package network
+
+config interface 'wlan0'
+    option ifname 'wlan0'
+    option proto 'none'
+
+package wireless
+
+config wifi-iface 'wifi_wlan0'
+    option device 'radio0'
+    option encryption 'sae+ccmp'
+    option ieee80211w '2'
+    option ifname 'wlan0'
+    option key 'passphrase012345'
+    option mode 'ap'
+    option network 'wlan0'
+    option ssid 'wpa3-personal'
+"""
+
+    def test_render_wpa3_personal(self):
+        o = OpenWrt(self._wpa3_personal_netjson)
+        expected = self._tabs(self._wpa3_personal_uci)
+        self.assertEqual(o.render(), expected)
+
+    def test_parse_wpa3_personal(self):
+        o = OpenWrt(native=self._wpa3_personal_uci)
+        self.assertEqual(o.config, self._wpa3_personal_netjson)
+
     _wpa2_personal_netjson = {
         "interfaces": [
             {
@@ -660,3 +707,48 @@ def test_render_wps_ap(self):
     def test_parse_wps_ap(self):
         o = OpenWrt(native=self._wps_ap_uci)
         self.assertEqual(o.config, self._wps_ap_netjson)
+
+    def test_render_ieee80211w(self):
+        _netjson_wpa3_personal_cipher_tkip = {
+            "interfaces": [
+                {
+                    "name": "wlan0",
+                    "type": "wireless",
+                    "wireless": {
+                        "radio": "radio0",
+                        "mode": "access_point",
+                        "ssid": "wpa3-personal",
+                        "encryption": {
+                            "protocol": "wpa3_personal",
+                            "cipher": "tkip",
+                            "key": "passphrase012345",
+                            "ieee80211w": "2",
+                        },
+                    },
+                }
+            ]
+        }
+        _uci_wpa3_personal_cipher_tkip = self._tabs(
+            """package network
+
+config interface 'wlan0'
+    option ifname 'wlan0'
+    option proto 'none'
+
+package wireless
+
+config wifi-iface 'wifi_wlan0'
+    option device 'radio0'
+    option encryption 'sae+ccmp'
+    option ieee80211w '2'
+    option ifname 'wlan0'
+    option key 'passphrase012345'
+    option mode 'ap'
+    option network 'wlan0'
+    option ssid 'wpa3-personal'
+"""
+        )
+        self.assertEqual(
+            OpenWrt(_netjson_wpa3_personal_cipher_tkip).render(),
+            _uci_wpa3_personal_cipher_tkip,
+        )