Adds get_oui and flat ci process to pull OUI data into repo

.bandit.yml

@@ -1,6 +1,6 @@
 ---
-skips: []
 # No need to check for security issues in the test scripts!
 exclude_dirs:
   - "./tests/"
   - "./docs/"
+  - "netutils/oui_mappings.py"

.github/workflows/oui_filepull.yml

@@ -0,0 +1,27 @@
+---
+name: "Flat"
+
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  scheduled:
+    runs-on: "ubuntu-latest"
+    steps:
+      # This step installs Deno, which is a new Javascript runtime that improves on Node. Can be used for an optional postprocessing step
+      - name: "Setup deno"
+        uses: "denoland/setup-deno@main"
+        with:
+          deno-version: "v1.10.x"
+      # Check out the repository so it can read the files inside of it and do other operations
+      - name: "Check out repo"
+        uses: "actions/checkout@v2"
+      # The Flat Action step. We fetch the data in the http_url and save it as downloaded_filename
+      - name: "Fetch data"
+        uses: "githubocto/flat@v3"
+        with:
+          http_url: "https://standards-oui.ieee.org"
+          downloaded_filename: "./netutils/oui_mappings.py"
+          postprocess: "./flat_postprocess/oui_postprocess.ts"

flat_postprocess/oui_postprocess.py

@@ -0,0 +1,23 @@
+"""Python code used to postprocess Flat github action data related to OUI mappings."""
+import sys
+import re
+
+HEX_RE = r"^(?P<hex>[A-Fa-f0-9]{6})\s+\(.*\)[^a-zA-Z0-9]+(?P<company>.*)$"
+OUI_MAPPINGS = {}
+
+if __name__ == "__main__":
+    with open(sys.argv[1], "r", encoding="utf-8") as oui_file:
+        for line in oui_file:
+            if re.search(HEX_RE, line):
+                group_regex_values = re.search(HEX_RE, line).groupdict()
+                if group_regex_values.get("hex") and group_regex_values.get("company"):
+                    OUI_MAPPINGS.update({group_regex_values.get("hex").lower(): group_regex_values.get("company")})
+
+    with open(sys.argv[1], "w", encoding="utf-8") as oui_mappings:
+        oui_mappings.write('"""Dictionary object to store OUI information."""\n')
+        oui_mappings.write("# pylint: disable=too-many-lines\n")
+        oui_mappings.write("import typing\n\n")
+        oui_mappings.write("OUI_MAPPINGS: typing.Dict[str, str] = {\n")
+        for mac, company in OUI_MAPPINGS.items():
+            oui_mappings.write(f'    "{mac}": "{company}",\n')
+        oui_mappings.write("}\n")

flat_postprocess/oui_postprocess.ts

@@ -0,0 +1,6 @@
+// Forwards the execution to the python script
+const py_run = Deno.run({
+    cmd: ['python', './flat_postprocess/oui_postprocess.py'].concat(Deno.args),
+});
+
+await py_run.status();

netutils/mac.py

@@ -117,7 +117,7 @@ def mac_type(mac: str) -> t.Optional[str]:
 
 @_valid_mac
 def mac_normalize(mac: str) -> str:
-    """Retuns the MAC address with only the address, and no special characters.
+    """Return the MAC address with only the address, and no special characters.
 
     Args:
         mac: A MAC address in string format that matches one of the defined regex patterns.
@@ -136,3 +136,31 @@ def mac_normalize(mac: str) -> str:
         if char in mac:
             mac = mac.replace(char, "")
     return mac
+
+
+@_valid_mac
+def get_oui(mac: str) -> str:
+    """Returns the company name for a given mac as defined by the IEEE.
+
+    Args:
+        mac: A MAC address in string format that matches one of the defined regex patterns.
+
+    Returns:
+        The name of the company the mac is related to.
+
+    Example:
+        >>> from netutils.mac import get_oui
+        >>> from netutils.oui_mappings import OUI_MAPPINGS
+        >>> get_oui("cc.79.d7.dd.ee.ff")
+        'Cisco Systems, Inc'
+        >>>
+    """
+    from netutils.oui_mappings import OUI_MAPPINGS  # pylint: disable=import-outside-toplevel
+
+    normalized_mac_prefix = mac_normalize(mac)[0:6]
+    oui_company = OUI_MAPPINGS.get(normalized_mac_prefix)
+
+    if not oui_company:
+        raise ValueError(f"There was no matching entry in OUI_MAPPINGS for {normalized_mac_prefix}.")
+
+    return oui_company