From 012865a6b15f44c5cb478c354e7676556cd71d34 Mon Sep 17 00:00:00 2001
From: brent s <r00t@square-r00t.net>
Date: Sun, 10 Nov 2019 05:39:33 -0500
Subject: [PATCH] wireless support. duh.

---
 aif.xsd                                 | 181 ++++++++++++++++--------
 aif/network/__init__.py                 |  16 +++
 aif/network/_common.py                  |  13 ++
 aif/network/netctl.py                   |   0
 aif/{network.py => network/networkd.py} |   3 +
 aif/network/networkd_fallback.py        |   0
 aif/network/networkmanager.py           |   0
 aif/network/networkmanager_fallback.py  |   0
 examples/aif.xml                        |  13 +-
 9 files changed, 165 insertions(+), 61 deletions(-)
 create mode 100644 aif/network/__init__.py
 create mode 100644 aif/network/_common.py
 create mode 100644 aif/network/netctl.py
 rename aif/{network.py => network/networkd.py} (51%)
 create mode 100644 aif/network/networkd_fallback.py
 create mode 100644 aif/network/networkmanager.py
 create mode 100644 aif/network/networkmanager_fallback.py

diff --git a/aif.xsd b/aif.xsd
index f9b3e58..19d1609 100644
--- a/aif.xsd
+++ b/aif.xsd
@@ -159,7 +159,7 @@
         </xs:union>
     </xs:simpleType>
 
-    <xs:simpleType name="t_iface">
+    <xs:simpleType name="t_iface_name">
         <xs:restriction base="xs:token">
             <!-- https://github.com/systemd/systemd/blob/master/src/udev/udev-builtin-net_id.c.
                  I have no idea if this will work. TODO: simplify, validate in-code. -->
@@ -214,6 +214,115 @@
         </xs:restriction>
     </xs:simpleType>
 
+    <xs:complexType name="t_iface">
+        <xs:sequence>
+            <xs:choice maxOccurs="unbounded">
+                <xs:element name="addresses" minOccurs="0" maxOccurs="1">
+                    <xs:complexType>
+                        <xs:sequence minOccurs="1" maxOccurs="unbounded">
+                            <xs:element name="ipv4">
+                                <xs:complexType>
+                                    <xs:sequence>
+                                        <xs:element name="address" type="aif:t_address_ip4"
+                                                    minOccurs="1" maxOccurs="unbounded"/>
+                                    </xs:sequence>
+                                    <xs:attribute name="gateway" type="aif:t_address_ip4" use="optional"/>
+                                </xs:complexType>
+                            </xs:element>
+                            <xs:element name="ipv6">
+                                <xs:complexType>
+                                    <xs:sequence>
+                                        <xs:element name="address" type="aif:t_address_ip6"
+                                                    minOccurs="1" maxOccurs="unbounded"/>
+                                    </xs:sequence>
+                                    <xs:attribute name="gateway" type="aif:t_address_ip6" use="optional"/>
+                                </xs:complexType>
+                            </xs:element>
+                        </xs:sequence>
+                    </xs:complexType>
+                </xs:element>
+                <xs:element name="resolvers" minOccurs="0" maxOccurs="1">
+                    <xs:complexType>
+                        <xs:sequence minOccurs="1" maxOccurs="unbounded">
+                            <xs:element name="resolver" minOccurs="1" maxOccurs="unbounded"
+                                        type="aif:t_resolver_addr"/>
+                        </xs:sequence>
+                    </xs:complexType>
+                </xs:element>
+            </xs:choice>
+        </xs:sequence>
+        <xs:attribute name="device" type="aif:t_iface_name" use="required"/>
+        <xs:attribute name="defroute" type="xs:boolean" use="optional" default="false"/>
+    </xs:complexType>
+
+    <xs:simpleType name="t_mac_addr">
+        <xs:restriction base="xs:token">
+            <!-- EUI48[RFC7043§3] (previously MAC48[RFC7042§2.1]) -->
+            <xs:pattern value="([A-Fa-f0-9]{2}[:-]?){5}[A-Fa-f0-9]{2}"/>
+            <!-- EUI64[RFC7043§4, RFC4291§2.5.1] -->
+            <xs:pattern value="([A-Fa-f0-9]{2}[:-]?){3}[Ff]{3}[FfEe][:-]?([A-Fa-f0-9]{2}[:-]?){2}[A-Fa-f0-9]{2}"/>
+            <xs:pattern value="([A-Fa-f0-9]{2}[:-]?){3}[A-Fa-f0-9]{4}[:-]?([A-Fa-f0-9]{2}[:-]?){2}[A-Fa-f0-9]{2}"/>
+            <xs:whiteSpace value="collapse"/>
+        </xs:restriction>
+    </xs:simpleType>
+
+    <!-- TODO: "enterprise" WPA2 (add'l details)? WPA3? -->
+    <xs:complexType name="t_wifi_crypto">
+        <xs:all>
+            <xs:element name="type" minOccurs="1" maxOccurs="1" default="wpa2">
+                <xs:simpleType>
+                    <xs:restriction base="xs:token">
+                        <xs:enumeration value="wep"/>
+                        <xs:enumeration value="wpa"/>
+                        <xs:enumeration value="wpa2"/>
+                        <!-- <xs:enumeration value="wpa3"/> -->
+                        <xs:whiteSpace value="collapse"/>
+                    </xs:restriction>
+                </xs:simpleType>
+            </xs:element>
+            <!-- "mode" only valid for WPA2 -->
+            <xs:element name="mode" minOccurs="0" maxOccurs="1" default="personal">
+                <xs:simpleType>
+                    <xs:restriction base="xs:token">
+                        <!-- PSK -->
+                        <xs:enumeration value="personal"/>
+                        <!-- RADIUS -->
+                        <xs:enumeration value="enterprise"/>
+                        <xs:whiteSpace value="collapse"/>
+                    </xs:restriction>
+                </xs:simpleType>
+            </xs:element>
+            <xs:element name="creds" minOccurs="1" maxOccurs="1">
+                <xs:complexType>
+                    <xs:simpleContent>
+                        <xs:extension base="xs:token">
+                            <xs:attribute name="type" use="optional" default="psk">
+                                <xs:simpleType>
+                                    <xs:restriction base="xs:token">
+                                        <xs:enumeration value="psk"/>
+                                        <xs:enumeration value="radius"/>
+                                    </xs:restriction>
+                                </xs:simpleType>
+                            </xs:attribute>
+                        </xs:extension>
+                    </xs:simpleContent>
+                </xs:complexType>
+            </xs:element>
+        </xs:all>
+    </xs:complexType>
+
+    <xs:complexType name="t_iface_wifi">
+        <xs:complexContent>
+            <xs:extension base="aif:t_iface">
+                <xs:sequence>
+                    <xs:element name="encryption" type="aif:t_wifi_crypto" minOccurs="0" maxOccurs="1"/>
+                </xs:sequence>
+                <xs:attribute name="essid" type="xs:string" use="required"/>
+                <xs:attribute name="bssid" type="xs:string" use="optional"/>
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+
     <xs:simpleType name="t_scripturi">
         <xs:restriction base="xs:anyURI">
             <xs:pattern value="(https?|ftps?|file)://.+"/>
@@ -536,7 +645,8 @@
                                                 </xs:all>
                                                 <xs:attribute name="id" type="xs:ID" use="required"/>
                                                 <xs:attribute name="name" type="aif:t_nonempty" use="required"/>
-                                                <xs:attribute name="extentSize" type="aif:t_pesize" use="optional" default="0"/>
+                                                <xs:attribute name="extentSize" type="aif:t_pesize" use="optional"
+                                                              default="0"/>
                                             </xs:complexType>
                                         </xs:element>
                                     </xs:sequence>
@@ -622,69 +732,24 @@
                 </xs:element>
                 <!-- END STORAGE -->
                 <!-- BEGIN NETWORK -->
+                <!-- TODO: make network optional? -->
                 <xs:element name="network" minOccurs="1" maxOccurs="1">
                     <xs:complexType>
-                        <xs:sequence>
-                            <xs:element name="iface" minOccurs="1" maxOccurs="unbounded">
-                                <xs:complexType>
-                                    <xs:all>
-                                        <xs:element name="addresses" minOccurs="0" maxOccurs="1">
-                                            <xs:complexType>
-                                                <xs:sequence minOccurs="1" maxOccurs="unbounded">
-                                                    <xs:element name="ipv4">
-                                                        <xs:complexType>
-                                                            <xs:sequence>
-                                                                <xs:element name="address" type="aif:t_address_ip4"
-                                                                            minOccurs="1" maxOccurs="unbounded"/>
-                                                            </xs:sequence>
-                                                            <xs:attribute name="gateway" type="aif:t_address_ip4"
-                                                                          use="optional"/>
-                                                        </xs:complexType>
-                                                    </xs:element>
-                                                    <xs:element name="ipv6">
-                                                        <xs:complexType>
-                                                            <xs:sequence>
-                                                                <xs:element name="address" type="aif:t_address_ip6"
-                                                                            minOccurs="1" maxOccurs="unbounded"/>
-                                                            </xs:sequence>
-                                                            <xs:attribute name="gateway" type="aif:t_address_ip6"
-                                                                          use="optional"/>
-                                                        </xs:complexType>
-                                                    </xs:element>
-                                                </xs:sequence>
-                                            </xs:complexType>
-                                            <xs:unique name="uniq_ip4">
-                                                <xs:selector xpath="aif:ipv4"/>
-                                                <xs:field xpath="address"/>
-                                            </xs:unique>
-                                            <xs:unique name="uniq_ip6">
-                                                <xs:selector xpath="aif:ipv6"/>
-                                                <xs:field xpath="address"/>
-                                            </xs:unique>
-                                        </xs:element>
-                                        <xs:element name="resolvers" minOccurs="0" maxOccurs="1">
-                                            <xs:complexType>
-                                                <xs:sequence minOccurs="1" maxOccurs="unbounded">
-                                                    <xs:element name="resolver" minOccurs="1" maxOccurs="unbounded"
-                                                                type="aif:t_resolver_addr"/>
-                                                </xs:sequence>
-                                            </xs:complexType>
-                                        </xs:element>
-                                    </xs:all>
-                                    <xs:attribute name="device" type="aif:t_iface" use="required"/>
-                                </xs:complexType>
-                                <xs:unique name="uniq_resolver">
-                                    <xs:selector xpath="aif:resolvers"/>
-                                    <xs:field xpath="resolver"/>
-                                </xs:unique>
+                        <xs:choice minOccurs="1" maxOccurs="unbounded">
+                            <xs:element name="ethernet" type="aif:t_iface" minOccurs="0" maxOccurs="unbounded"/>
+                            <xs:element name="wireless" type="aif:t_iface_wifi" minOccurs="0" maxOccurs="unbounded">
                             </xs:element>
-                        </xs:sequence>
+                        </xs:choice>
                         <!-- It's nearly impossible to validate FQDNs/hostnames in XSD, so we do it in-code. -->
                         <xs:attribute name="hostname" type="aif:t_nonempty" use="required"/>
                         <xs:attribute name="provider" type="aif:t_netprov" use="optional" default="netctl"/>
                     </xs:complexType>
-                    <xs:unique name="uniq_iface">
-                        <xs:selector xpath="aif:iface"/>
+                    <xs:unique name="uniq_iface_eth">
+                        <xs:selector xpath="aif:ethernet"/>
+                        <xs:field xpath="@device"/>
+                    </xs:unique>
+                    <xs:unique name="uniq_iface_wlan">
+                        <xs:selector xpath="aif:wireless"/>
                         <xs:field xpath="@device"/>
                     </xs:unique>
                 </xs:element>
diff --git a/aif/network/__init__.py b/aif/network/__init__.py
new file mode 100644
index 0000000..20a8caa
--- /dev/null
+++ b/aif/network/__init__.py
@@ -0,0 +1,16 @@
+try:
+    from . import _common
+except ImportError:
+    pass  # GI isn't supported, so we don't even use a fallback.
+
+# TODO: use DBus interface for systemd but fallback to subprocess?
+# http://0pointer.net/blog/the-new-sd-bus-api-of-systemd.html
+# https://www.youtube.com/watch?v=ZUX9Fx8Rwzg
+# https://www.youtube.com/watch?v=lBQgMGPxqNo
+# https://github.com/facebookincubator/pystemd has some unit/service examples
+# try:
+#     from . import networkd
+# except ImportError:
+#     from . import networkd_fallback as networkd
+
+from . import netctl
diff --git a/aif/network/_common.py b/aif/network/_common.py
new file mode 100644
index 0000000..a8686f5
--- /dev/null
+++ b/aif/network/_common.py
@@ -0,0 +1,13 @@
+import gi
+gi.require_version('NM', '2.0')
+from gi.repository import NM, GLib
+
+NM.ensure_init([None])
+
+
+def addBDPlugin(plugin_name):
+    plugins = NM.get_available_plugin_names()
+    plugins.append(plugin_name)
+    plugins = list(set(plugins))  # Deduplicate
+    spec = NM.plugin_specs_from_names(plugins)
+    return(NM.ensure_init(spec))
diff --git a/aif/network/netctl.py b/aif/network/netctl.py
new file mode 100644
index 0000000..e69de29
diff --git a/aif/network.py b/aif/network/networkd.py
similarity index 51%
rename from aif/network.py
rename to aif/network/networkd.py
index 41c438f..dca0967 100644
--- a/aif/network.py
+++ b/aif/network/networkd.py
@@ -1 +1,4 @@
 import ipaddress
+import socket
+
+
diff --git a/aif/network/networkd_fallback.py b/aif/network/networkd_fallback.py
new file mode 100644
index 0000000..e69de29
diff --git a/aif/network/networkmanager.py b/aif/network/networkmanager.py
new file mode 100644
index 0000000..e69de29
diff --git a/aif/network/networkmanager_fallback.py b/aif/network/networkmanager_fallback.py
new file mode 100644
index 0000000..e69de29
diff --git a/examples/aif.xml b/examples/aif.xml
index bf518f3..d8e9a52 100644
--- a/examples/aif.xml
+++ b/examples/aif.xml
@@ -119,8 +119,8 @@
             <mount source="mdraid" target="/mnt/aif/mnt/raid"/>
         </mountPoints>
     </storage>
-    <network hostname="aiftest.square-r00t.net">
-        <iface device="auto">
+    <network hostname="aiftest.square-r00t.net" provider="netctl">
+        <ethernet device="auto" defroute="true">
             <addresses>
                 <ipv4>
                     <address>dhcp</address>
@@ -133,7 +133,14 @@
             <resolvers>
                 <resolver>8.8.8.8</resolver>
             </resolvers>
-        </iface>
+        </ethernet>
+        <wireless device="wlp2s0" essid="MyWirelessLan" bssid="00-00-5E-00-53-00" defroute="false">
+            <encryption>
+                <type>wpa2</type>
+                <mode>personal</mode>
+                <creds type="psk">ABadWiFiPassword</creds>
+            </encryption>
+        </wireless>
     </network>
     <system timezone="EST5EDT" chrootPath="/mnt/aif" reboot="0">
         <rootPassword>