v.0.1.0 - init

pthon package to add vlans, interfaces and dhcpd elements

python/build/lib/opnsense-helper/__init__.py

@@ -0,0 +1,177 @@
+import xml.etree.ElementTree as ET
+import re
+import paramiko
+aliases={
+"parentinterface": "if",
+"_from":"from",
+"_to":"to"
+}
+def get_child(root,element, id, keys):
+    elements=[]
+    for parent in root.findall(element):
+        child= {}
+        for y in keys:
+            child[y]=None
+        for x in parent.findall(id):
+            for key in keys:
+                child[key]=parseChild(x, key)
+        elements.append(child)
+    return elements
+def parseChild(parent, tag):
+    result=parent.find(tag)
+
+    element=result.text if  result is not None else None
+    return element
+class Interface:
+    def __init__(self, name, parent):
+        self.descr = parseChild(parent, "descr")
+        self.enable = parseChild(parent, "enable")
+        self.ipaddr = parseChild(parent, "ipaddr")
+        self.subnet = parseChild(parent, "subnet")
+        self.type = parseChild(parent, "type")
+        self.virtual = parseChild(parent, "virtual")
+        self.spoofmac=parseChild(parent, "spoofmac")
+        self.attr=None
+
+class Vlan:
+    def __init__(self,name, parent):
+        self.parentinterface =parseChild(parent, "if")
+        self.tag = parseChild(parent,"tag")
+        self.pcp = parseChild(parent,"pcp")
+        self.proto = parseChild(parent,"proto")
+        self.descr = parseChild(parent,"descr")
+        self.vlanif = parseChild(parent,"vlanif")
+        self.attr=None
+
+class Dhcpd:
+    def __init__(self, name, parent):
+        self.enable = parseChild(parent, "enable")
+        self.ddnsdomainalgorithm = parseChild(parent, "ddnsdomainalgorithm")
+        self.range={
+            "_from":"",
+            "_to":""
+        }
+        self.attr=None
+
+
+class opnsensehelper():
+    def __init__(self, filepath, ssh=None, user=None, passw=None, remote_address=None):
+        self.filepath=filepath
+        self.tree = ET.parse(filepath)
+        self.root = self.tree.getroot()
+        self.objects={
+        "vlans":{},
+        "dhcpd":{},
+        "interfaces":{}
+        }
+
+        if(ssh!=None):
+            self.ssh = paramiko.SSHClient()
+            self.ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+            self.ssh.connect(remote_address, username=user, password=passw)
+            self.sftp = self.ssh.open_sftp() 
+            #self.ssh .open_sftp
+    def initialize(self):
+        self.get_all("dhcpd")
+        self.get_all("vlans")
+        self.get_all("interfaces")
+    def save(self,output):
+        update_xml_file(self.objects["dhcpd"],self.root,"dhcpd")
+        update_xml_file(self.objects["interfaces"],self.root,"interfaces")
+        update_xml_file(self.objects["vlans"],self.root,"vlans")
+        with open(output, 'w') as f:
+            f.write(ET.tostring(self.root, encoding='unicode', method='xml'))
+
+    def get_all(self,element):
+        print(f'''          -----------------------------
+                    {element}''')
+        for parent in self.root.findall(element):
+            for key in parent:
+                if element== "dhcpd":
+                        child = Dhcpd(key.tag,parent)
+                elif element== "interfaces":
+                        child = Interface(key.tag,parent)
+                elif element== "vlans":
+                        child = Vlan(key.tag,parent)
+
+                child=get_element(parent, key.tag, child)
+                if element== "dhcpd":
+                    _range={"_from": parent.find(key.tag).find("range/from"),
+                    "_to":parent.find(key.tag).find("range/to")}
+                    if _range["_from"] is not None:
+                        _range["_from"]=_range["_from"].text
+                        _range["_to"]=_range["_to"].text
+                        child.range =_range
+                child.attr=key.attrib if key.attrib is not None else None
+                print(child.attr) 
+                self.objects[element][key.tag]=child.__dict__
+                print(f'''{key.tag} : {child.__dict__}
+                -------------------''')
+
+        return(self.objects[element])
+    def close_con(self):
+        self.sftp.close()
+        self.ssh.close()
+    def put_file(self, _from,_to):    
+        self.sftp.put(_from, _to)
+    def get_file(self,_from,_to):
+        self.sftp.get(_from,_to)
+def get_element(root,id, obj):
+    for x in root.findall(id):
+        for key in obj.__dict__.keys():
+#            if isinstance(obj.__dict__[key], dict):
+            if(key!="_to"and key!="_from"):
+
+                if key in aliases.keys():
+                    key2 = aliases[key] 
+                    y=parseChild(x, key2)
+                else:
+                    y=parseChild(x, key)
+                setattr(obj, key, y)
+    return obj
+
+def recoursion(e, value):
+    for key2, value2 in value.items():
+        if(key2!="attr"):
+            if key2 in aliases.keys():
+                key2 = aliases[key2] 
+            x=ET.SubElement(e, key2)
+            if isinstance(value2, dict):
+                recoursion(x,value2)
+            else:
+                x.text = value2
+
+def update_xml_file(objects,root,type):
+    el = root.find(type)
+    el.clear()
+    for key, value in objects.items():
+        if value["attr"] is not None:
+             e = ET.SubElement(el, key,value["attr"])
+        else:
+            e=ET.SubElement(el,key)
+        recoursion(e,value)
+
+def test():
+    filepath = '/home/ji/confignew.xml'
+    output="/home/ji/.ansible/collections/ansible_collections/ji_podhead/podnet/plugins/x.xml"
+    conf_path="/conf/config.xml"
+    vlan3 ={'parentinterface': 'vtnet1', 'tag': '3', 'pcp': '0', 'proto': None, 'descr': 'vlan3', 'vlanif': 'vlan0.3',"attr":{"uuid":"cb503df8-821d-4acd-86ba-66b35e4df17n"}}
+    vlan4 ={'parentinterface': 'vtnet1', 'tag': '4', 'pcp': '0', 'proto': None, 'descr': 'vlan4', 'vlanif': 'vlan0.4',"attr":{"uuid":"cb503df8-821d-4acd-86ba-66b35e4s7c"}}
+    opt3_dhcp= {'enable': '1', 'ddnsdomainalgorithm': 'hmac-md', "range":{'from': '200.0.3.10', '_to': '200.0.3.100'},"attr":None}
+    opt4_dhcp= {'enable': '1', 'ddnsdomainalgorithm': 'hmac-md', "range":{'from': '200.0.4.10', '_to': '200.0.4.100'},"attr":None}
+    opt3_interface= {'descr': 'vlan3', 'enable': '1', 'ipaddr': '200.0.3.1', 'subnet': '24', 'type': None, 'virtual': None, 'spoofmac': '00:00:00:00:00:03', 'attr': {}}
+    opt4_interface= {'descr': 'vlan4', 'enable': '1', 'ipaddr': '200.0.3.1', 'subnet': '24', 'type': None, 'virtual': None, 'spoofmac': '00:00:00:00:00:04', 'attr': {}}
+    helper=opnsensehelper(filepath,True,"root","opnsense","192.168.1.103")
+    helper.get_file(conf_path, output)
+    helper.initialize()
+    helper.objects["dhcpd"]["opt3"]=opt3_dhcp
+    helper.objects["dhcpd"]["opt4"]=opt4_dhcp
+    helper.objects["vlans"]["vlan3"]=vlan3
+    helper.objects["vlans"]["vlan4"]=vlan4
+    helper.objects["interfaces"]["opt3"]=opt3_interface
+    helper.objects["interfaces"]["opt4"]=opt4_interface
+    helper.save(output)
+    helper.put_file(output,conf_path)
+    helper.close_con()
+if __name__ == "__main__":
+    test()

python/opnsense-helper/__init__.py

@@ -0,0 +1,177 @@
+import xml.etree.ElementTree as ET
+import re
+import paramiko
+aliases={
+"parentinterface": "if",
+"_from":"from",
+"_to":"to"
+}
+def get_child(root,element, id, keys):
+    elements=[]
+    for parent in root.findall(element):
+        child= {}
+        for y in keys:
+            child[y]=None
+        for x in parent.findall(id):
+            for key in keys:
+                child[key]=parseChild(x, key)
+        elements.append(child)
+    return elements
+def parseChild(parent, tag):
+    result=parent.find(tag)
+
+    element=result.text if  result is not None else None
+    return element
+class Interface:
+    def __init__(self, name, parent):
+        self.descr = parseChild(parent, "descr")
+        self.enable = parseChild(parent, "enable")
+        self.ipaddr = parseChild(parent, "ipaddr")
+        self.subnet = parseChild(parent, "subnet")
+        self.type = parseChild(parent, "type")
+        self.virtual = parseChild(parent, "virtual")
+        self.spoofmac=parseChild(parent, "spoofmac")
+        self.attr=None
+
+class Vlan:
+    def __init__(self,name, parent):
+        self.parentinterface =parseChild(parent, "if")
+        self.tag = parseChild(parent,"tag")
+        self.pcp = parseChild(parent,"pcp")
+        self.proto = parseChild(parent,"proto")
+        self.descr = parseChild(parent,"descr")
+        self.vlanif = parseChild(parent,"vlanif")
+        self.attr=None
+
+class Dhcpd:
+    def __init__(self, name, parent):
+        self.enable = parseChild(parent, "enable")
+        self.ddnsdomainalgorithm = parseChild(parent, "ddnsdomainalgorithm")
+        self.range={
+            "_from":"",
+            "_to":""
+        }
+        self.attr=None
+
+
+class opnsensehelper():
+    def __init__(self, filepath, ssh=None, user=None, passw=None, remote_address=None):
+        self.filepath=filepath
+        self.tree = ET.parse(filepath)
+        self.root = self.tree.getroot()
+        self.objects={
+        "vlans":{},
+        "dhcpd":{},
+        "interfaces":{}
+        }
+
+        if(ssh!=None):
+            self.ssh = paramiko.SSHClient()
+            self.ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+            self.ssh.connect(remote_address, username=user, password=passw)
+            self.sftp = self.ssh.open_sftp() 
+            #self.ssh .open_sftp
+    def initialize(self):
+        self.get_all("dhcpd")
+        self.get_all("vlans")
+        self.get_all("interfaces")
+    def save(self,output):
+        update_xml_file(self.objects["dhcpd"],self.root,"dhcpd")
+        update_xml_file(self.objects["interfaces"],self.root,"interfaces")
+        update_xml_file(self.objects["vlans"],self.root,"vlans")
+        with open(output, 'w') as f:
+            f.write(ET.tostring(self.root, encoding='unicode', method='xml'))
+
+    def get_all(self,element):
+        print(f'''          -----------------------------
+                    {element}''')
+        for parent in self.root.findall(element):
+            for key in parent:
+                if element== "dhcpd":
+                        child = Dhcpd(key.tag,parent)
+                elif element== "interfaces":
+                        child = Interface(key.tag,parent)
+                elif element== "vlans":
+                        child = Vlan(key.tag,parent)
+
+                child=get_element(parent, key.tag, child)
+                if element== "dhcpd":
+                    _range={"_from": parent.find(key.tag).find("range/from"),
+                    "_to":parent.find(key.tag).find("range/to")}
+                    if _range["_from"] is not None:
+                        _range["_from"]=_range["_from"].text
+                        _range["_to"]=_range["_to"].text
+                        child.range =_range
+                child.attr=key.attrib if key.attrib is not None else None
+                print(child.attr) 
+                self.objects[element][key.tag]=child.__dict__
+                print(f'''{key.tag} : {child.__dict__}
+                -------------------''')
+
+        return(self.objects[element])
+    def close_con(self):
+        self.sftp.close()
+        self.ssh.close()
+    def put_file(self, _from,_to):    
+        self.sftp.put(_from, _to)
+    def get_file(self,_from,_to):
+        self.sftp.get(_from,_to)
+def get_element(root,id, obj):
+    for x in root.findall(id):
+        for key in obj.__dict__.keys():
+#            if isinstance(obj.__dict__[key], dict):
+            if(key!="_to"and key!="_from"):
+
+                if key in aliases.keys():
+                    key2 = aliases[key] 
+                    y=parseChild(x, key2)
+                else:
+                    y=parseChild(x, key)
+                setattr(obj, key, y)
+    return obj
+
+def recoursion(e, value):
+    for key2, value2 in value.items():
+        if(key2!="attr"):
+            if key2 in aliases.keys():
+                key2 = aliases[key2] 
+            x=ET.SubElement(e, key2)
+            if isinstance(value2, dict):
+                recoursion(x,value2)
+            else:
+                x.text = value2
+
+def update_xml_file(objects,root,type):
+    el = root.find(type)
+    el.clear()
+    for key, value in objects.items():
+        if value["attr"] is not None:
+             e = ET.SubElement(el, key,value["attr"])
+        else:
+            e=ET.SubElement(el,key)
+        recoursion(e,value)
+
+def test():
+    filepath = '/home/ji/confignew.xml'
+    output="/home/ji/.ansible/collections/ansible_collections/ji_podhead/podnet/plugins/x.xml"
+    conf_path="/conf/config.xml"
+    vlan3 ={'parentinterface': 'vtnet1', 'tag': '3', 'pcp': '0', 'proto': None, 'descr': 'vlan3', 'vlanif': 'vlan0.3',"attr":{"uuid":"cb503df8-821d-4acd-86ba-66b35e4df17n"}}
+    vlan4 ={'parentinterface': 'vtnet1', 'tag': '4', 'pcp': '0', 'proto': None, 'descr': 'vlan4', 'vlanif': 'vlan0.4',"attr":{"uuid":"cb503df8-821d-4acd-86ba-66b35e4s7c"}}
+    opt3_dhcp= {'enable': '1', 'ddnsdomainalgorithm': 'hmac-md', "range":{'from': '200.0.3.10', '_to': '200.0.3.100'},"attr":None}
+    opt4_dhcp= {'enable': '1', 'ddnsdomainalgorithm': 'hmac-md', "range":{'from': '200.0.4.10', '_to': '200.0.4.100'},"attr":None}
+    opt3_interface= {'descr': 'vlan3', 'enable': '1', 'ipaddr': '200.0.3.1', 'subnet': '24', 'type': None, 'virtual': None, 'spoofmac': '00:00:00:00:00:03', 'attr': {}}
+    opt4_interface= {'descr': 'vlan4', 'enable': '1', 'ipaddr': '200.0.3.1', 'subnet': '24', 'type': None, 'virtual': None, 'spoofmac': '00:00:00:00:00:04', 'attr': {}}
+    helper=opnsensehelper(filepath,True,"root","opnsense","192.168.1.103")
+    helper.get_file(conf_path, output)
+    helper.initialize()
+    helper.objects["dhcpd"]["opt3"]=opt3_dhcp
+    helper.objects["dhcpd"]["opt4"]=opt4_dhcp
+    helper.objects["vlans"]["vlan3"]=vlan3
+    helper.objects["vlans"]["vlan4"]=vlan4
+    helper.objects["interfaces"]["opt3"]=opt3_interface
+    helper.objects["interfaces"]["opt4"]=opt4_interface
+    helper.save(output)
+    helper.put_file(output,conf_path)
+    helper.close_con()
+if __name__ == "__main__":
+    test()

python/opnsense_helper.egg-info/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.1
+Name: opnsense-helper
+Version: 0.1.0
+Summary: assign lan interfaces, create vlans, vlan-interfaces and setup dhcp in a single script.
+Home-page: https://github.com/the-pod-shop/opnsense-helper/
+Author: ji-podhdead
+Author-email: [email protected]
+License: BSD 2-clause
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Requires-Dist: paramiko

python/opnsense_helper.egg-info/SOURCES.txt

@@ -0,0 +1,7 @@
+setup.py
+opnsense-helper/__init__.py
+opnsense_helper.egg-info/PKG-INFO
+opnsense_helper.egg-info/SOURCES.txt
+opnsense_helper.egg-info/dependency_links.txt
+opnsense_helper.egg-info/requires.txt
+opnsense_helper.egg-info/top_level.txt

python/opnsense_helper.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

python/opnsense_helper.egg-info/requires.txt

@@ -0,0 +1 @@
+paramiko

python/opnsense_helper.egg-info/top_level.txt

@@ -0,0 +1 @@
+opnsense-helper