Merge pull request #273 from MikaylaFischler/devel

2023.06.29 Release

.github/workflows/manifest.yml

@@ -0,0 +1,95 @@
+# Deploy installation manifests and shields versions
+name: Deploy Installation Data
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - latest
+      - devel
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Setup Python
+        uses: actions/setup-python@v3.1.3
+      # Generate manifest + shields files for main branch
+      - name: Checkout main
+        id: checkout-main
+        uses: actions/checkout@v3
+        with:
+          ref: 'main'
+          clean: false
+      - name: Create outputs folders
+        if: success() || failure()
+        shell: bash
+        run: mkdir deploy; mkdir deploy/manifests; mkdir deploy/manifests/main deploy/manifests/latest deploy/manifests/devel
+      - name: Generate manifest and shields for main branch
+        id: manifest-main
+        if: ${{ (success() || failure()) && steps.checkout-main.outcome == 'success' }}
+        run: python imgen.py shields
+      - name: Save main's manifest
+        if: ${{ (success() || failure()) && steps.manifest-main.outcome == 'success' }}
+        run: mv install_manifest.json deploy/manifests/main
+      # Generate manifest for latest branch
+      - name: Checkout latest
+        id: checkout-latest
+        if: success() || failure()
+        uses: actions/checkout@v3
+        with:
+          ref: 'latest'
+          clean: false
+      - name: Generate manifest for latest
+        id: manifest-latest
+        if: ${{ (success() || failure()) && steps.checkout-latest.outcome == 'success' }}
+        run: python imgen.py
+      - name: Save latest's manifest
+        if: ${{ (success() || failure()) && steps.manifest-latest.outcome == 'success' }}
+        run: mv install_manifest.json deploy/manifests/latest
+      # Generate manifest for devel branch
+      - name: Checkout devel
+        id: checkout-devel
+        if: success() || failure()
+        uses: actions/checkout@v3
+        with:
+          ref: 'devel'
+          clean: false
+      - name: Generate manifest for devel
+        id: manifest-devel
+        if: ${{ (success() || failure()) && steps.checkout-devel.outcome == 'success' }}
+        run: python imgen.py
+      - name: Save devel's manifest
+        if: ${{ (success() || failure()) && steps.manifest-devel.outcome == 'success' }}
+        run: mv install_manifest.json deploy/manifests/devel
+      # All artifacts ready now, upload deploy directory
+      - name: Upload artifacts
+        id: upload-artifacts
+        if: ${{ (success() || failure()) && (steps.manifest-main.outcome == 'success' || steps.manifest-latest.outcome == 'success' || steps.manifest-devel.outcome == 'success') }}
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload manifest JSON
+          path: 'deploy/'
+      - name: Deploy to GitHub Pages
+        if: ${{ (success() || failure()) && steps.upload-artifacts.outcome == 'success' }}
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/shields.yml

@@ -1,47 +0,0 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: Deploy Component Versions
-
-on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: ["main"]
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  # Single deploy job since we're just deploying
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Pages
-        uses: actions/configure-pages@v3
-      - name: Setup Python
-        uses: actions/setup-python@v3.1.3
-      - run: mkdir shields
-      - run: python imgen.py shields
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
-        with:
-          # Upload shields JSON
-          path: 'shields/'
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2

.gitignore

@@ -1,2 +1,2 @@
 _notes/
-program.sh
+/*program.sh

README.md

@@ -41,7 +41,7 @@ There was also an apparent bug with boilers disconnecting and reconnecting when
 
 You can install this on a ComputerCraft computer using either:
 * `wget https://raw.githubusercontent.com/MikaylaFischler/cc-mek-scada/main/ccmsi.lua`
-* `pastebin get iUMjgW0C ccmsi.lua`
+* `pastebin get eRz6cUNM ccmsi.lua`
 
 ## [SCADA](https://en.wikipedia.org/wiki/SCADA)
 > Supervisory control and data acquisition (SCADA) is a control system architecture comprising computers, networked data communications and graphical user interfaces for high-level supervision of machines and processes. It also covers sensors and other devices, such as programmable logic controllers, which interface with process plant or machinery.

ccmsi.lua

@@ -20,29 +20,96 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 local function println(message) print(tostring(message)) end
 local function print(message) term.write(tostring(message)) end
 
-local CCMSI_VERSION = "v1.0"
+local CCMSI_VERSION = "v1.5a"
 
 local install_dir = "/.install-cache"
+local manifest_path = "https://mikaylafischler.github.io/cc-mek-scada/manifests/"
 local repo_path = "http://raw.githubusercontent.com/MikaylaFischler/cc-mek-scada/"
 
 local opts = { ... }
-local mode = nil
+local mode, app, target
-local app = nil
+local install_manifest = manifest_path .. "main/install_manifest.json"
+
+local function red() term.setTextColor(colors.red) end
+local function orange() term.setTextColor(colors.orange) end
+local function yellow() term.setTextColor(colors.yellow) end
+local function green() term.setTextColor(colors.green) end
+local function blue() term.setTextColor(colors.blue) end
+local function white() term.setTextColor(colors.white) end
+local function lgray() term.setTextColor(colors.lightGray) end
+
+-- get command line option in list
+local function get_opt(opt, options)
+    for _, v in pairs(options) do if opt == v then return v end end
+    return nil
+end
+
+-- ask the user yes or no
+local function ask_y_n(question, default)
+    print(question)
+    if default == true then print(" (Y/n)? ") else print(" (y/N)? ") end
+    local response = read()
+    if response == "" then return default
+    elseif response == "Y" or response == "y" then return true
+    elseif response == "N" or response == "n" then return false
+    else return nil end
+end
+
+-- print out a white + blue text message
+local function pkg_message(message, package) white(); print(message .. " "); blue(); println(package); white() end
+
+-- indicate actions to be taken based on package differences for installs/updates
+local function show_pkg_change(name, v_local, v_remote)
+    if v_local ~= nil then
+        if v_local ~= v_remote then
+            print("[" .. name .. "] updating "); blue(); print(v_local); white(); print(" \xbb "); blue(); println(v_remote); white()
+        elseif mode == "install" then
+            pkg_message("[" .. name .. "] reinstalling", v_local)
+        end
+    else
+        pkg_message("[" .. name .. "] new install of", v_remote)
+    end
+end
+
+-- read the local manifest file
+local function read_local_manifest()
+    local local_ok = false
+    local local_manifest = {}
+    local imfile = fs.open("install_manifest.json", "r")
+    if imfile ~= nil then
+        local_ok, local_manifest = pcall(function () return textutils.unserializeJSON(imfile.readAll()) end)
+        imfile.close()
+    end
+    return local_ok, local_manifest
+end
+
+-- get the manifest from GitHub
+local function get_remote_manifest()
+    local response, error = http.get(install_manifest)
+    if response == nil then
+        orange(); println("failed to get installation manifest from GitHub, cannot update or install")
+        red(); println("HTTP error: " .. error); white()
+        return false, {}
+    end
+
+    local ok, manifest = pcall(function () return textutils.unserializeJSON(response.readAll()) end)
+    if not ok then
+        red(); println("error parsing remote installation manifest"); white()
+    end
+
+    return ok, manifest
+end
 
 -- record the local installation manifest
----@param manifest table
----@param dependencies table
 local function write_install_manifest(manifest, dependencies)
     local versions = {}
     for key, value in pairs(manifest.versions) do
         local is_dependency = false
         for _, dependency in pairs(dependencies) do
-            if key == "bootloader" and dependency == "system" then
+            if (key == "bootloader" and dependency == "system") or key == dependency then
-                is_dependency = true
+                is_dependency = true; break
-                break
             end
         end
-
         if key == app or key == "comms" or is_dependency then versions[key] = value end
     end
 
@@ -53,116 +120,66 @@ local function write_install_manifest(manifest, dependencies)
     imfile.close()
 end
 
---
 -- get and validate command line options
---
 
 println("-- CC Mekanism SCADA Installer " .. CCMSI_VERSION .. " --")
 
 if #opts == 0 or opts[1] == "help" then
-    println("usage: ccmsi <mode> <app> <tag/branch>")
+    println("usage: ccmsi <mode> <app> <branch>")
     println("<mode>")
-    term.setTextColor(colors.lightGray)
+    lgray()
     println(" check       - check latest versions avilable")
-    term.setTextColor(colors.yellow)
+    yellow()
-    println("               ccmsi check <tag/branch> for target")
+    println("               ccmsi check <branch> for target")
-    term.setTextColor(colors.lightGray)
+    lgray()
     println(" install     - fresh install, overwrites config")
     println(" update      - update files EXCEPT for config/logs")
     println(" remove      - delete files EXCEPT for config/logs")
     println(" purge       - delete files INCLUDING config/logs")
-    term.setTextColor(colors.white)
+    white(); println("<app>"); lgray()
-    println("<app>")
-    term.setTextColor(colors.lightGray)
     println(" reactor-plc - reactor PLC firmware")
     println(" rtu         - RTU firmware")
     println(" supervisor  - supervisor server application")
     println(" coordinator - coordinator application")
     println(" pocket      - pocket application")
-    term.setTextColor(colors.white)
+    white(); println("<branch>"); yellow()
-    println("<tag/branch>")
-    term.setTextColor(colors.yellow)
     println(" second parameter when used with check")
-    term.setTextColor(colors.lightGray)
+    lgray(); println(" main (default) | latest | devel"); white()
-    println(" note: defaults to main")
-    println(" target GitHub tag or branch name")
     return
 else
-    for _, v in pairs({ "check", "install", "update", "remove", "purge" }) do
+    mode = get_opt(opts[1], { "check", "install", "update", "remove", "purge" })
-        if opts[1] == v then
-            mode = v
-            break
-        end
-    end
-
     if mode == nil then
-        println("unrecognized mode")
+        red(); println("Unrecognized mode."); white()
         return
     end
 
-    for _, v in pairs({ "reactor-plc", "rtu", "supervisor", "coordinator", "pocket" }) do
+    app = get_opt(opts[2], { "reactor-plc", "rtu", "supervisor", "coordinator", "pocket" })
-        if opts[2] == v then
-            app = v
-            break
-        end
-    end
-
     if app == nil and mode ~= "check" then
-        println("unrecognized application")
+        red(); println("Unrecognized application."); white()
         return
     end
+
+    -- determine target
+    if mode == "check" then target = opts[2] else target = opts[3] end
+    if (target ~= "main") and (target ~= "latest") and (target ~= "devel") then
+        if (target and target ~= "") then yellow(); println("Unknown target, defaulting to 'main'"); white() end
+        target = "main"
+    end
+
+    -- set paths
+    install_manifest = manifest_path .. target .. "/install_manifest.json"
+    repo_path = repo_path .. target .. "/"
 end
 
---
 -- run selected mode
---
 
 if mode == "check" then
-    -------------------------
+    local ok, manifest = get_remote_manifest()
-    -- GET REMOTE MANIFEST --
+    if not ok then return end
-    -------------------------
-
-    if opts[2] then repo_path = repo_path .. opts[2] .. "/" else repo_path = repo_path .. "main/" end
-    local install_manifest = repo_path .. "install_manifest.json"
-
-    local response, error = http.get(install_manifest)
-
-    if response == nil then
-        term.setTextColor(colors.orange)
-        println("failed to get installation manifest from GitHub, cannot update or install")
-        term.setTextColor(colors.red)
-        println("HTTP error: " .. error)
-        term.setTextColor(colors.white)
-        return
-    end
-
-    local ok, manifest = pcall(function () return textutils.unserializeJSON(response.readAll()) end)
-
-    if not ok then
-        term.setTextColor(colors.red)
-        println("error parsing remote installation manifest")
-        term.setTextColor(colors.white)
-        return
-    end
-
-    ------------------------
-    -- GET LOCAL MANIFEST --
-    ------------------------
-
-    local imfile = fs.open("install_manifest.json", "r")
-    local local_ok = false
-    local local_manifest = {}
-
-    if imfile ~= nil then
-        local_ok, local_manifest = pcall(function () return textutils.unserializeJSON(imfile.readAll()) end)
-        imfile.close()
-    end
 
+    local local_ok, local_manifest = read_local_manifest()
     if not local_ok then
-        term.setTextColor(colors.yellow)
+        yellow(); println("failed to load local installation information"); white()
-        println("failed to load local installation information")
-        term.setTextColor(colors.white)
-
         local_manifest = { versions = { installer = CCMSI_VERSION } }
     else
         local_manifest.versions.installer = CCMSI_VERSION
@@ -173,190 +190,95 @@ if mode == "check" then
         term.setTextColor(colors.purple)
         print(string.format("%-14s", "[" .. key .. "]"))
         if key == "installer" or (local_ok and (local_manifest.versions[key] ~= nil)) then
-            term.setTextColor(colors.blue)
+            blue(); print(local_manifest.versions[key])
-            print(local_manifest.versions[key])
             if value ~= local_manifest.versions[key] then
-                term.setTextColor(colors.white)
+                white(); print(" (")
-                print(" (")
                 term.setTextColor(colors.cyan)
-                print(value)
+                print(value); white(); println(" available)")
-                term.setTextColor(colors.white)
+            else green(); println(" (up to date)") end
-                println(" available)")
-            else
-                term.setTextColor(colors.green)
-                println(" (up to date)")
-            end
         else
-            term.setTextColor(colors.lightGray)
+            lgray(); print("not installed"); white(); print(" (latest ")
-            print("not installed")
-            term.setTextColor(colors.white)
-            print(" (latest ")
             term.setTextColor(colors.cyan)
-            print(value)
+            print(value); white(); println(")")
-            term.setTextColor(colors.white)
-            println(")")
         end
     end
 elseif mode == "install" or mode == "update" then
-    -------------------------
+    local ok, manifest = get_remote_manifest()
-    -- GET REMOTE MANIFEST --
+    if not ok then return end
-    -------------------------
 
-    if opts[3] then repo_path = repo_path .. opts[3] .. "/" else repo_path = repo_path .. "main/" end
+    local ver = {
-    local install_manifest = repo_path .. "install_manifest.json"
+        app = { v_local = nil, v_remote = nil, changed = false },
-
+        boot = { v_local = nil, v_remote = nil, changed = false },
-    local response, error = http.get(install_manifest)
+        comms = { v_local = nil, v_remote = nil, changed = false },
-
+        graphics = { v_local = nil, v_remote = nil, changed = false },
-    if response == nil then
+        lockbox = { v_local = nil, v_remote = nil, changed = false }
-        term.setTextColor(colors.orange)
+    }
-        println("failed to get installation manifest from GitHub, cannot update or install")
-        term.setTextColor(colors.red)
-        println("HTTP error: " .. error)
-        term.setTextColor(colors.white)
-        return
-    end
-
-    local ok, manifest = pcall(function () return textutils.unserializeJSON(response.readAll()) end)
-
-    if not ok then
-        term.setTextColor(colors.red)
-        println("error parsing remote installation manifest")
-        term.setTextColor(colors.white)
-    end
-
-    ------------------------
-    -- GET LOCAL MANIFEST --
-    ------------------------
-
-    local imfile = fs.open("install_manifest.json", "r")
-    local local_ok = false
-    local local_manifest = {}
-
-    if imfile ~= nil then
-        local_ok, local_manifest = pcall(function () return textutils.unserializeJSON(imfile.readAll()) end)
-        imfile.close()
-    end
-
-    local local_app_version = nil
-    local local_comms_version = nil
-    local local_boot_version = nil
 
     -- try to find local versions
+    local local_ok, local_manifest = read_local_manifest()
     if not local_ok then
         if mode == "update" then
-            term.setTextColor(colors.red)
+            red(); println("failed to load local installation information, cannot update"); white()
-            println("failed to load local installation information, cannot update")
-            term.setTextColor(colors.white)
             return
         end
     else
-        local_app_version = local_manifest.versions[app]
+        ver.boot.v_local = local_manifest.versions.bootloader
-        local_comms_version = local_manifest.versions.comms
+        ver.app.v_local = local_manifest.versions[app]
-        local_boot_version = local_manifest.versions.bootloader
+        ver.comms.v_local = local_manifest.versions.comms
+        ver.graphics.v_local = local_manifest.versions.graphics
+        ver.lockbox.v_local = local_manifest.versions.lockbox
 
         if local_manifest.versions[app] == nil then
-            term.setTextColor(colors.red)
+            red(); println("another application is already installed, please purge it before installing a new application"); white()
-            println("another application is already installed, please purge it before installing a new application")
-            term.setTextColor(colors.white)
             return
         end
 
         local_manifest.versions.installer = CCMSI_VERSION
         if manifest.versions.installer ~= CCMSI_VERSION then
-            term.setTextColor(colors.yellow)
+            yellow(); println("a newer version of the installer is available, it is recommended to download it"); white()
-            println("a newer version of the installer is available, consider downloading it")
-            term.setTextColor(colors.white)
         end
     end
 
-    local remote_app_version = manifest.versions[app]
+    ver.boot.v_remote = manifest.versions.bootloader
-    local remote_comms_version = manifest.versions.comms
+    ver.app.v_remote = manifest.versions[app]
-    local remote_boot_version = manifest.versions.bootloader
+    ver.comms.v_remote = manifest.versions.comms
+    ver.graphics.v_remote = manifest.versions.graphics
+    ver.lockbox.v_remote = manifest.versions.lockbox
 
-    term.setTextColor(colors.green)
+    green()
     if mode == "install" then
-        println("installing " .. app .. " files...")
+        println("Installing " .. app .. " files...")
     elseif mode == "update" then
-        println("updating " .. app .. " files... (keeping old config.lua)")
+        println("Updating " .. app .. " files... (keeping old config.lua)")
     end
-    term.setTextColor(colors.white)
+    white()
 
     -- display bootloader version change information
-    if local_boot_version ~= nil then
+    show_pkg_change("bootldr", ver.boot.v_local, ver.boot.v_remote)
-        if local_boot_version ~= remote_boot_version then
+    ver.boot.changed = ver.boot.v_local ~= ver.boot.v_remote
-            print("[bootldr] updating ")
-            term.setTextColor(colors.blue)
-            print(local_boot_version)
-            term.setTextColor(colors.white)
-            print(" \xbb ")
-            term.setTextColor(colors.blue)
-            println(remote_boot_version)
-            term.setTextColor(colors.white)
-        elseif mode == "install" then
-            print("[bootldr] reinstalling ")
-            term.setTextColor(colors.blue)
-            println(local_boot_version)
-            term.setTextColor(colors.white)
-        end
-    else
-        print("[bootldr] new install of ")
-        term.setTextColor(colors.blue)
-        println(remote_boot_version)
-        term.setTextColor(colors.white)
-    end
 
     -- display app version change information
-    if local_app_version ~= nil then
+    show_pkg_change(app, ver.app.v_local, ver.app.v_remote)
-        if local_app_version ~= remote_app_version then
+    ver.app.changed = ver.app.v_local ~= ver.app.v_remote
-            print("[" .. app .. "] updating ")
-            term.setTextColor(colors.blue)
-            print(local_app_version)
-            term.setTextColor(colors.white)
-            print(" \xbb ")
-            term.setTextColor(colors.blue)
-            println(remote_app_version)
-            term.setTextColor(colors.white)
-        elseif mode == "install" then
-            print("[" .. app .. "] reinstalling ")
-            term.setTextColor(colors.blue)
-            println(local_app_version)
-            term.setTextColor(colors.white)
-        end
-    else
-        print("[" .. app .. "] new install of ")
-        term.setTextColor(colors.blue)
-        println(remote_app_version)
-        term.setTextColor(colors.white)
-    end
 
     -- display comms version change information
-    if local_comms_version ~= nil then
+    show_pkg_change("comms", ver.comms.v_local, ver.comms.v_remote)
-        if local_comms_version ~= remote_comms_version then
+    ver.comms.changed = ver.comms.v_local ~= ver.comms.v_remote
-            print("[comms] updating ")
+    if ver.comms.changed and ver.comms.v_local ~= nil then
-            term.setTextColor(colors.blue)
+        print("[comms] "); yellow(); println("other devices on the network will require an update"); white()
-            print(local_comms_version)
-            term.setTextColor(colors.white)
-            print(" \xbb ")
-            term.setTextColor(colors.blue)
-            println(remote_comms_version)
-            term.setTextColor(colors.white)
-            print("[comms] ")
-            term.setTextColor(colors.yellow)
-            println("other devices on the network will require an update")
-            term.setTextColor(colors.white)
-        elseif mode == "install" then
-            print("[comms] reinstalling ")
-            term.setTextColor(colors.blue)
-            println(local_comms_version)
-            term.setTextColor(colors.white)
-        end
-    else
-        print("[comms] new install of ")
-        term.setTextColor(colors.blue)
-        println(remote_comms_version)
-        term.setTextColor(colors.white)
     end
 
+    -- display graphics version change information
+    show_pkg_change("graphics", ver.graphics.v_local, ver.graphics.v_remote)
+    ver.graphics.changed = ver.graphics.v_local ~= ver.graphics.v_remote
+
+    -- display lockbox version change information
+    show_pkg_change("lockbox", ver.lockbox.v_local, ver.lockbox.v_remote)
+    ver.lockbox.changed = ver.lockbox.v_local ~= ver.lockbox.v_remote
+
+    -- ask for confirmation
+    if not ask_y_n("Continue?", false) then return end
+
     --------------------------
     -- START INSTALL/UPDATE --
     --------------------------
@@ -380,24 +302,27 @@ elseif mode == "install" or mode == "update" then
     -- check space constraints
     if space_available < space_required then
         single_file_mode = true
-        term.setTextColor(colors.yellow)
+        yellow(); println("WARNING: Insufficient space available for a full download!"); white()
-        println("WARNING: Insufficient space available for a full download!")
-        term.setTextColor(colors.white)
         println("Files can be downloaded one by one, so if you are replacing a current install this will not be a problem unless installation fails.")
-        println("Do you wish to continue? (y/N)")
+        if mode == "update" then println("If installation still fails, delete this device's log file or uninstall the app (not purge) and try again.") end
-
+        if not ask_y_n("Do you wish to continue?", false) then
-        local confirm = read()
+            println("Operation cancelled.")
-        if confirm ~= "y" and confirm ~= "Y" then
-            println("installation cancelled")
             return
         end
     end
 
----@diagnostic disable-next-line: undefined-field
-    os.sleep(2)
-
     local success = true
 
+    -- helper function to check if a dependency is unchanged
+    local function unchanged(dependency)
+        if dependency == "system" then return not ver.boot.changed
+        elseif dependency == "graphics" then return not ver.graphics.changed
+        elseif dependency == "lockbox" then return not ver.lockbox.changed
+        elseif dependency == "common" then return not (ver.app.changed or ver.comms.changed)
+        elseif dependency == app then return not ver.app.changed
+        else return true end
+    end
+
     if not single_file_mode then
         if fs.exists(install_dir) then
             fs.delete(install_dir)
@@ -406,28 +331,19 @@ elseif mode == "install" or mode == "update" then
 
         -- download all dependencies
         for _, dependency in pairs(dependencies) do
-            if mode == "update" and ((dependency == "system" and local_boot_version == remote_boot_version) or (local_app_version == remote_app_version)) then
+            if mode == "update" and unchanged(dependency) then
-                -- skip system package if unchanged, skip app package if not changed
+                pkg_message("skipping download of unchanged package", dependency)
-                -- skip packages that have no version if app version didn't change
-                term.setTextColor(colors.white)
-                print("skipping download of unchanged package ")
-                term.setTextColor(colors.blue)
-                println(dependency)
             else
-                term.setTextColor(colors.white)
+                pkg_message("downloading package", dependency)
-                print("downloading package ")
+                lgray()
-                term.setTextColor(colors.blue)
-                println(dependency)
 
-                term.setTextColor(colors.lightGray)
                 local files = file_list[dependency]
                 for _, file in pairs(files) do
                     println("GET " .. file)
                     local dl, err = http.get(repo_path .. file)
 
                     if dl == nil then
-                        term.setTextColor(colors.red)
+                        red(); println("GET HTTP Error " .. err)
-                        println("GET HTTP Error " .. err)
                         success = false
                         break
                     else
@@ -442,20 +358,12 @@ elseif mode == "install" or mode == "update" then
         -- copy in downloaded files (installation)
         if success then
             for _, dependency in pairs(dependencies) do
-                if mode == "update" and ((dependency == "system" and local_boot_version == remote_boot_version) or (local_app_version == remote_app_version)) then
+                if mode == "update" and unchanged(dependency) then
-                    -- skip system package if unchanged, skip app package if not changed
+                    pkg_message("skipping install of unchanged package", dependency)
-                    -- skip packages that have no version if app version didn't change
-                    term.setTextColor(colors.white)
-                    print("skipping install of unchanged package ")
-                    term.setTextColor(colors.blue)
-                    println(dependency)
                 else
-                    term.setTextColor(colors.white)
+                    pkg_message("installing package", dependency)
-                    print("installing package ")
+                    lgray()
-                    term.setTextColor(colors.blue)
-                    println(dependency)
 
-                    term.setTextColor(colors.lightGray)
                     local files = file_list[dependency]
                     for _, file in pairs(files) do
                         if mode == "install" or file ~= config_file then
@@ -471,41 +379,25 @@ elseif mode == "install" or mode == "update" then
         fs.delete(install_dir)
 
         if success then
-            -- if we made it here, then none of the file system functions threw exceptions
-            -- that means everything is OK
             write_install_manifest(manifest, dependencies)
-            term.setTextColor(colors.green)
+            green()
             if mode == "install" then
-                println("installation completed successfully")
+                println("Installation completed successfully.")
-            else
+            else println("Update completed successfully.") end
-                println("update completed successfully")
-            end
         else
             if mode == "install" then
-                term.setTextColor(colors.red)
+                red(); println("Installation failed.")
-                println("installation failed")
+            else orange(); println("Update failed, existing files unmodified.") end
-            else
-                term.setTextColor(colors.orange)
-                println("update failed, existing files unmodified")
-            end
         end
     else
         -- go through all files and replace one by one
         for _, dependency in pairs(dependencies) do
-            if mode == "update" and ((dependency == "system" and local_boot_version == remote_boot_version) or (local_app_version == remote_app_version)) then
+            if mode == "update" and unchanged(dependency) then
-                -- skip system package if unchanged, skip app package if not changed
+                pkg_message("skipping install of unchanged package", dependency)
-                -- skip packages that have no version if app version didn't change
-                term.setTextColor(colors.white)
-                print("skipping install of unchanged package ")
-                term.setTextColor(colors.blue)
-                println(dependency)
             else
-                term.setTextColor(colors.white)
+                pkg_message("installing package", dependency)
-                print("installing package ")
+                lgray()
-                term.setTextColor(colors.blue)
-                println(dependency)
 
-                term.setTextColor(colors.lightGray)
                 local files = file_list[dependency]
                 for _, file in pairs(files) do
                     if mode == "install" or file ~= config_file then
@@ -513,7 +405,7 @@ elseif mode == "install" or mode == "update" then
                         local dl, err = http.get(repo_path .. file)
 
                         if dl == nil then
-                            println("GET HTTP Error " .. err)
+                            red(); println("GET HTTP Error " .. err)
                             success = false
                             break
                         else
@@ -527,55 +419,37 @@ elseif mode == "install" or mode == "update" then
         end
 
         if success then
-            -- if we made it here, then none of the file system functions threw exceptions
-            -- that means everything is OK
             write_install_manifest(manifest, dependencies)
-            term.setTextColor(colors.green)
+            green()
             if mode == "install" then
-                println("installation completed successfully")
+                println("Installation completed successfully.")
-            else
+            else println("Update completed successfully.") end
-                println("update completed successfully")
-            end
         else
-            term.setTextColor(colors.red)
+            red()
             if mode == "install" then
-                println("installation failed, files may have been skipped")
+                println("Installation failed, files may have been skipped.")
-            else
+            else println("Update failed, files may have been skipped.") end
-                println("update failed, files may have been skipped")
-            end
         end
     end
 elseif mode == "remove" or mode == "purge" then
-    local imfile = fs.open("install_manifest.json", "r")
+    local ok, manifest = read_local_manifest()
-    local ok = false
-    local manifest = {}
-
-    if imfile ~= nil then
-        ok, manifest = pcall(function () return textutils.unserializeJSON(imfile.readAll()) end)
-        imfile.close()
-    end
-
     if not ok then
-        term.setTextColor(colors.red)
+        red(); println("Error parsing local installation manifest."); white()
-        println("error parsing local installation manifest")
-        term.setTextColor(colors.white)
         return
     elseif mode == "remove" and manifest.versions[app] == nil then
-        term.setTextColor(colors.red)
+        red(); println(app .. " is not installed, cannot remove."); white()
-        println(app .. " is not installed")
-        term.setTextColor(colors.white)
         return
     end
 
-    term.setTextColor(colors.orange)
+    orange()
     if mode == "remove" then
-        println("removing all " .. app .. " files except for config.lua and log.txt...")
+        println("Removing all " .. app .. " files except for config and log...")
     elseif mode == "purge" then
-        println("purging all " .. app .. " files...")
+        println("Purging all " .. app .. " files including config and log...")
     end
 
----@diagnostic disable-next-line: undefined-field
+    -- ask for confirmation
-    os.sleep(2)
+    if not ask_y_n("Continue?", false) then return end
 
     local file_list = manifest.files
     local dependencies = manifest.depends[app]
@@ -583,9 +457,8 @@ elseif mode == "remove" or mode == "purge" then
 
     table.insert(dependencies, app)
 
-    term.setTextColor(colors.lightGray)
-
     -- delete log file if purging
+    lgray()
     if mode == "purge" and fs.exists(config_file) then
         local log_deleted = pcall(function ()
             local config = require(app .. ".config")
@@ -596,11 +469,9 @@ elseif mode == "remove" or mode == "purge" then
         end)
 
         if not log_deleted then
-            term.setTextColor(colors.red)
+            red(); println("failed to delete log file")
-            println("failed to delete log file")
+            white(); println("press enter to continue...")
-            term.setTextColor(colors.lightGray)
+            read(); lgray()
----@diagnostic disable-next-line: undefined-field
-            os.sleep(1)
         end
     end
 
@@ -621,11 +492,7 @@ elseif mode == "remove" or mode == "purge" then
             local folder = files[1]
             while true do
                 local dir = fs.getDir(folder)
-                if dir == "" or dir == ".." then
+                if dir == "" or dir == ".." then break else folder = dir end
-                    break
-                else
-                    folder = dir
-                end
             end
 
             if fs.isDir(folder) then
@@ -633,14 +500,11 @@ elseif mode == "remove" or mode == "purge" then
                 println("deleted directory " .. folder)
             end
         elseif dependency == app then
+            -- delete individual subdirectories so we can leave the config
             for _, folder in pairs(files) do
                 while true do
                     local dir = fs.getDir(folder)
-                    if dir == "" or dir == ".." or dir == app then
+                    if dir == "" or dir == ".." or dir == app then break else folder = dir end
-                        break
-                    else
-                        folder = dir
-                    end
                 end
 
                 if folder ~= app and fs.isDir(folder) then
@@ -658,13 +522,12 @@ elseif mode == "remove" or mode == "purge" then
     else
         -- remove all data from versions list to show nothing is installed
         manifest.versions = {}
-        imfile = fs.open("install_manifest.json", "w")
+        local imfile = fs.open("install_manifest.json", "w")
         imfile.write(textutils.serializeJSON(manifest))
         imfile.close()
     end
 
-    term.setTextColor(colors.green)
+    green(); println("Done!")
-    println("done!")
 end
 
-term.setTextColor(colors.white)
+white()

coordinator/config.lua

@@ -1,16 +1,20 @@
 local config = {}
 
--- port of the SCADA supervisor
+-- supervisor comms channel
-config.SCADA_SV_PORT = 16100
+config.SVR_CHANNEL = 16240
--- port to listen to incoming packets from supervisor
+-- coordinator comms channel
-config.SCADA_SV_CTL_LISTEN = 16101
+config.CRD_CHANNEL = 16243
--- listen port for SCADA coordinator API access
+-- pocket comms channel
-config.SCADA_API_LISTEN = 16200
+config.PKT_CHANNEL = 16244
 -- max trusted modem message distance (0 to disable check)
 config.TRUSTED_RANGE = 0
 -- time in seconds (>= 2) before assuming a remote device is no longer active
 config.SV_TIMEOUT = 5
 config.API_TIMEOUT = 5
+-- facility authentication key (do NOT use one of your passwords)
+-- this enables verifying that messages are authentic
+-- all devices on the same network must use the same key
+-- config.AUTH_KEY = "SCADAfacility123"
 
 -- expected number of reactor units, used only to require that number of unit monitors
 config.NUM_UNITS = 4

coordinator/coordinator.lua

@@ -183,7 +183,8 @@ local function log_dmesg(message, dmesg_tag, working)
         GRAPHICS = colors.green,
         SYSTEM = colors.cyan,
         BOOT = colors.blue,
-        COMMS = colors.purple
+        COMMS = colors.purple,
+        CRYPTO = colors.yellow
     }
 
     if working then
@@ -197,6 +198,7 @@ function coordinator.log_graphics(message) log_dmesg(message, "GRAPHICS") end
 function coordinator.log_sys(message) log_dmesg(message, "SYSTEM") end
 function coordinator.log_boot(message) log_dmesg(message, "BOOT") end
 function coordinator.log_comms(message) log_dmesg(message, "COMMS") end
+function coordinator.log_crypto(message) log_dmesg(message, "CRYPTO") end
 
 -- log a message for communications connecting, providing access to progress indication control functions
 ---@nodiscard
@@ -212,15 +214,16 @@ end
 -- coordinator communications
 ---@nodiscard
 ---@param version string coordinator version
----@param modem table modem device
+---@param nic nic network interface device
----@param sv_port integer port of configured supervisor
+---@param crd_channel integer port of configured supervisor
----@param sv_listen integer listening port for supervisor replys
+---@param svr_channel integer listening port for supervisor replys
----@param api_listen integer listening port for pocket API
+---@param pkt_channel integer listening port for pocket API
 ---@param range integer trusted device connection range
 ---@param sv_watchdog watchdog
-function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range, sv_watchdog)
+function coordinator.comms(version, nic, crd_channel, svr_channel, pkt_channel, range, sv_watchdog)
     local self = {
         sv_linked = false,
+        sv_addr = comms.BROADCAST,
         sv_seq_num = 0,
         sv_r_seq_num = nil,
         sv_config_err = false,
@@ -233,17 +236,12 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
 
     -- PRIVATE FUNCTIONS --
 
-    -- configure modem channels
+    -- configure network channels
-    local function _conf_channels()
+    nic.closeAll()
-        modem.closeAll()
+    nic.open(crd_channel)
-        modem.open(sv_listen)
-        modem.open(api_listen)
-    end
 
-    _conf_channels()
+    -- link nic to apisessions
-
+    apisessions.init(nic)
-    -- link modem to apisessions
-    apisessions.init(modem)
 
     -- send a packet to the supervisor
     ---@param msg_type SCADA_MGMT_TYPE|SCADA_CRDN_TYPE
@@ -261,23 +259,24 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
         end
 
         pkt.make(msg_type, msg)
-        s_pkt.make(self.sv_seq_num, protocol, pkt.raw_sendable())
+        s_pkt.make(self.sv_addr, self.sv_seq_num, protocol, pkt.raw_sendable())
 
-        modem.transmit(sv_port, sv_listen, s_pkt.raw_sendable())
+        nic.transmit(svr_channel, crd_channel, s_pkt)
         self.sv_seq_num = self.sv_seq_num + 1
     end
 
     -- send an API establish request response
-    ---@param dest integer
+    ---@param packet scada_packet
-    ---@param msg table
+    ---@param ack ESTABLISH_ACK
-    local function _send_api_establish_ack(seq_id, dest, msg)
+    local function _send_api_establish_ack(packet, ack)
         local s_pkt = comms.scada_packet()
         local m_pkt = comms.mgmt_packet()
 
-        m_pkt.make(SCADA_MGMT_TYPE.ESTABLISH, msg)
+        m_pkt.make(SCADA_MGMT_TYPE.ESTABLISH, { ack })
-        s_pkt.make(seq_id, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
+        s_pkt.make(packet.src_addr(), packet.seq_num() + 1, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
 
-        modem.transmit(dest, api_listen, s_pkt.raw_sendable())
+        nic.transmit(pkt_channel, crd_channel, s_pkt)
+        self.last_api_est_acks[packet.src_addr()] = ack
     end
 
     -- attempt connection establishment
@@ -296,18 +295,12 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
     ---@class coord_comms
     local public = {}
 
-    -- reconnect a newly connected modem
-    ---@param new_modem table
-    function public.reconnect_modem(new_modem)
-        modem = new_modem
-        apisessions.relink_modem(new_modem)
-        _conf_channels()
-    end
-
     -- close the connection to the server
     function public.close()
         sv_watchdog.cancel()
+        self.sv_addr = comms.BROADCAST
         self.sv_linked = false
+        self.sv_r_seq_num = nil
         _send_sv(PROTOCOL.SCADA_MGMT, SCADA_MGMT_TYPE.CLOSE, {})
     end
 
@@ -335,12 +328,13 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
                 tick_dmesg_waiting(math.max(0, timeout_s - (util.time_s() - start)))
                 _send_establish()
                 clock.start()
+            elseif event == "timer" then
+                -- keep checking watchdog timers
+                apisessions.check_all_watchdogs(p1)
             elseif event == "modem_message" then
                 -- handle message
                 local packet = public.parse_packet(p1, p2, p3, p4, p5)
-                if packet ~= nil and packet.type == SCADA_MGMT_TYPE.ESTABLISH then
+                public.handle_packet(packet)
-                    public.handle_packet(packet)
-                end
             elseif event == "terminate" then
                 terminated = true
                 break
@@ -398,13 +392,10 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
     ---@param distance integer
     ---@return mgmt_frame|crdn_frame|capi_frame|nil packet
     function public.parse_packet(side, sender, reply_to, message, distance)
+        local s_pkt = nic.receive(side, sender, reply_to, message, distance)
         local pkt = nil
-        local s_pkt = comms.scada_packet()
 
-        -- parse packet as generic SCADA packet
+        if s_pkt then
-        s_pkt.receive(side, sender, reply_to, message, distance)
-
-        if s_pkt.is_valid() then
             -- get as SCADA management packet
             if s_pkt.protocol() == PROTOCOL.SCADA_MGMT then
                 local mgmt_pkt = comms.mgmt_packet()
@@ -435,15 +426,18 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
     ---@param packet mgmt_frame|crdn_frame|capi_frame|nil
     function public.handle_packet(packet)
         if packet ~= nil then
-            local l_port = packet.scada_frame.local_port()
+            local l_chan = packet.scada_frame.local_channel()
-            local r_port = packet.scada_frame.remote_port()
+            local r_chan = packet.scada_frame.remote_channel()
+            local src_addr = packet.scada_frame.src_addr()
             local protocol = packet.scada_frame.protocol()
 
-            if l_port == api_listen then
+            if l_chan ~= crd_channel then
+                log.debug("received packet on unconfigured channel " .. l_chan, true)
+            elseif r_chan == pkt_channel then
                 if protocol == PROTOCOL.COORD_API then
                     ---@cast packet capi_frame
                     -- look for an associated session
-                    local session = apisessions.find_session(r_port)
+                    local session = apisessions.find_session(src_addr)
 
                     -- API packet
                     if session ~= nil then
@@ -456,7 +450,7 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
                 elseif protocol == PROTOCOL.SCADA_MGMT then
                     ---@cast packet mgmt_frame
                     -- look for an associated session
-                    local session = apisessions.find_session(r_port)
+                    local session = apisessions.find_session(src_addr)
 
                     -- SCADA management packet
                     if session ~= nil then
@@ -464,8 +458,6 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
                         session.in_queue.push_packet(packet)
                     elseif packet.type == SCADA_MGMT_TYPE.ESTABLISH then
                         -- establish a new session
-                        local next_seq_id = packet.scada_frame.seq_num() + 1
-
                         -- validate packet and continue
                         if packet.length == 3 and type(packet.data[1]) == "string" and type(packet.data[2]) == "string" then
                             local comms_v = packet.data[1]
@@ -473,42 +465,43 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
                             local dev_type = packet.data[3]
 
                             if comms_v ~= comms.version then
-                                if self.last_api_est_acks[r_port] ~= ESTABLISH_ACK.BAD_VERSION then
+                                if self.last_api_est_acks[src_addr] ~= ESTABLISH_ACK.BAD_VERSION then
                                     log.info(util.c("dropping API establish packet with incorrect comms version v", comms_v, " (expected v", comms.version, ")"))
-                                    self.last_api_est_acks[r_port] = ESTABLISH_ACK.BAD_VERSION
                                 end
 
-                                _send_api_establish_ack(next_seq_id, r_port, { ESTABLISH_ACK.BAD_VERSION })
+                                _send_api_establish_ack(packet.scada_frame, ESTABLISH_ACK.BAD_VERSION)
                             elseif dev_type == DEVICE_TYPE.PKT then
                                 -- pocket linking request
-                                local id = apisessions.establish_session(l_port, r_port, firmware_v)
+                                local id = apisessions.establish_session(src_addr, firmware_v)
-                                println(util.c("API: pocket (", firmware_v, ") [:", r_port, "] connected with session ID ", id))
+                                println(util.c("[API] pocket (", firmware_v, ") [@", src_addr, "] \xbb connected"))
-                                coordinator.log_comms(util.c("API: pocket (", firmware_v, ") [:", r_port, "] connected with session ID ", id))
+                                coordinator.log_comms(util.c("API_ESTABLISH: pocket (", firmware_v, ") [@", src_addr, "] connected with session ID ", id))
 
-                                _send_api_establish_ack(next_seq_id, r_port, { ESTABLISH_ACK.ALLOW })
+                                _send_api_establish_ack(packet.scada_frame, ESTABLISH_ACK.ALLOW)
-                                self.last_api_est_acks[r_port] = ESTABLISH_ACK.ALLOW
                             else
-                                log.debug(util.c("illegal establish packet for device ", dev_type, " on API listening channel"))
+                                log.debug(util.c("API_ESTABLISH: illegal establish packet for device ", dev_type, " on pocket channel"))
-                                _send_api_establish_ack(next_seq_id, r_port, { ESTABLISH_ACK.DENY })
+                                _send_api_establish_ack(packet.scada_frame, ESTABLISH_ACK.DENY)
                             end
                         else
                             log.debug("invalid establish packet (on API listening channel)")
-                            _send_api_establish_ack(next_seq_id, r_port, { ESTABLISH_ACK.DENY })
+                            _send_api_establish_ack(packet.scada_frame, ESTABLISH_ACK.DENY)
                         end
                     else
                         -- any other packet should be session related, discard it
-                        log.debug(util.c(r_port, "->", l_port, ": discarding SCADA_MGMT packet without a known session"))
+                        log.debug(util.c("discarding pocket SCADA_MGMT packet without a known session from computer ", src_addr))
                     end
                 else
-                    log.debug("illegal packet type " .. protocol .. " on api listening channel", true)
+                    log.debug("illegal packet type " .. protocol .. " on pocket channel", true)
                 end
-            elseif l_port == sv_listen then
+            elseif r_chan == svr_channel then
                 -- check sequence number
                 if self.sv_r_seq_num == nil then
                     self.sv_r_seq_num = packet.scada_frame.seq_num()
                 elseif self.connected and ((self.sv_r_seq_num + 1) ~= packet.scada_frame.seq_num()) then
                     log.warning("sequence out-of-order: last = " .. self.sv_r_seq_num .. ", new = " .. packet.scada_frame.seq_num())
                     return
+                elseif self.sv_linked and src_addr ~= self.sv_addr then
+                    log.debug("received packet from unknown computer " .. src_addr .. " while linked; channel in use by another system?")
+                    return
                 else
                     self.sv_r_seq_num = packet.scada_frame.seq_num()
                 end
@@ -659,6 +652,7 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
                                         -- init io controller
                                         iocontrol.init(conf, public)
 
+                                        self.sv_addr = src_addr
                                         self.sv_linked = true
                                         self.sv_config_err = false
                                     else
@@ -704,10 +698,10 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
                                 local trip_time = util.time() - timestamp
 
                                 if trip_time > 750 then
-                                    log.warning("coord KEEP_ALIVE trip time > 750ms (" .. trip_time .. "ms)")
+                                    log.warning("coordinator KEEP_ALIVE trip time > 750ms (" .. trip_time .. "ms)")
                                 end
 
-                                -- log.debug("coord RTT = " .. trip_time .. "ms")
+                                -- log.debug("coordinator RTT = " .. trip_time .. "ms")
 
                                 iocontrol.get_db().facility.ps.publish("sv_ping", trip_time)
 
@@ -718,7 +712,9 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
                         elseif packet.type == SCADA_MGMT_TYPE.CLOSE then
                             -- handle session close
                             sv_watchdog.cancel()
+                            self.sv_addr = comms.BROADCAST
                             self.sv_linked = false
+                            self.sv_r_seq_num = nil
                             println_ts("server connection closed by remote host")
                             log.info("server connection closed by remote host")
                         else
@@ -731,7 +727,7 @@ function coordinator.comms(version, modem, sv_port, sv_listen, api_listen, range
                     log.debug("illegal packet type " .. protocol .. " on supervisor listening channel", true)
                 end
             else
-                log.debug("received packet on unconfigured channel " .. l_port, true)
+                log.debug("received packet for unknown channel " .. r_chan, true)
             end
         end
     end

coordinator/session/apisessions.lua

@@ -5,12 +5,12 @@ local util   = require("scada-common.util")
 
 local config = require("coordinator.config")
 
-local api    = require("coordinator.session.api")
+local pocket = require("coordinator.session.pocket")
 
 local apisessions = {}
 
 local self = {
-    modem = nil,
+    nic = nil,
     next_id = 0,
     sessions = {}
 }
@@ -18,7 +18,7 @@ local self = {
 -- PRIVATE FUNCTIONS --
 
 -- handle a session output queue
----@param session api_session_struct
+---@param session pkt_session_struct
 local function _api_handle_outq(session)
     -- record handler start time
     local handle_start = util.time()
@@ -31,7 +31,7 @@ local function _api_handle_outq(session)
         if msg ~= nil then
             if msg.qtype == mqueue.TYPE.PACKET then
                 -- handle a packet to be sent
-                self.modem.transmit(session.r_port, session.l_port, msg.message.raw_sendable())
+                self.nic.transmit(config.PKT_CHANNEL, config.CRD_CHANNEL, msg.message)
             elseif msg.qtype == mqueue.TYPE.COMMAND then
                 -- handle instruction/notification
             elseif msg.qtype == mqueue.TYPE.DATA then
@@ -41,15 +41,15 @@ local function _api_handle_outq(session)
 
         -- max 100ms spent processing queue
         if util.time() - handle_start > 100 then
-            log.warning("API out queue handler exceeded 100ms queue process limit")
+            log.warning("[API] out queue handler exceeded 100ms queue process limit")
-            log.warning(util.c("offending session: port ", session.r_port))
+            log.warning(util.c("[API] offending session: ", session))
             break
         end
     end
 end
 
 -- cleanly close a session
----@param session api_session_struct
+---@param session pkt_session_struct
 local function _shutdown(session)
     session.open = false
     session.instance.close()
@@ -58,77 +58,77 @@ local function _shutdown(session)
     while session.out_queue.ready() do
         local msg = session.out_queue.pop()
         if msg ~= nil and msg.qtype == mqueue.TYPE.PACKET then
-            self.modem.transmit(session.r_port, session.l_port, msg.message.raw_sendable())
+            self.nic.transmit(config.PKT_CHANNEL, config.CRD_CHANNEL, msg.message)
         end
     end
 
-    log.debug(util.c("closed API session ", session.instance.get_id(), " on remote port ", session.r_port))
+    log.debug(util.c("[API] closed session ", session))
 end
 
 -- PUBLIC FUNCTIONS --
 
 -- initialize apisessions
----@param modem table
+---@param nic nic
-function apisessions.init(modem)
+function apisessions.init(nic)
-    self.modem = modem
+    self.nic = nic
-end
-
--- re-link the modem
----@param modem table
-function apisessions.relink_modem(modem)
-    self.modem = modem
 end
 
 -- find a session by remote port
 ---@nodiscard
----@param port integer
+---@param source_addr integer
----@return api_session_struct|nil
+---@return pkt_session_struct|nil
-function apisessions.find_session(port)
+function apisessions.find_session(source_addr)
     for i = 1, #self.sessions do
-        if self.sessions[i].r_port == port then return self.sessions[i] end
+        if self.sessions[i].s_addr == source_addr then return self.sessions[i] end
     end
     return nil
 end
 
 -- establish a new API session
 ---@nodiscard
----@param local_port integer
+---@param source_addr integer
----@param remote_port integer
 ---@param version string
 ---@return integer session_id
-function apisessions.establish_session(local_port, remote_port, version)
+function apisessions.establish_session(source_addr, version)
-    ---@class api_session_struct
+    ---@class pkt_session_struct
-    local api_s = {
+    local pkt_s = {
         open = true,
         version = version,
-        l_port = local_port,
+        s_addr = source_addr,
-        r_port = remote_port,
         in_queue = mqueue.new(),
         out_queue = mqueue.new(),
-        instance = nil  ---@type api_session
+        instance = nil  ---@type pkt_session
     }
 
-    api_s.instance = api.new_session(self.next_id, api_s.in_queue, api_s.out_queue, config.API_TIMEOUT)
+    local id = self.next_id
-    table.insert(self.sessions, api_s)
 
-    log.debug(util.c("established new API session to ", remote_port, " with ID ", self.next_id))
+    pkt_s.instance = pocket.new_session(id, source_addr, pkt_s.in_queue, pkt_s.out_queue, config.API_TIMEOUT)
+    table.insert(self.sessions, pkt_s)
 
-    self.next_id = self.next_id + 1
+    local mt = {
+        ---@param s pkt_session_struct
+        __tostring = function (s)  return util.c("PKT [", id, "] (@", s.s_addr, ")") end
+    }
+
+    setmetatable(pkt_s, mt)
+
+    log.debug(util.c("[API] established new session: ", pkt_s))
+
+    self.next_id = id + 1
 
     -- success
-    return api_s.instance.get_id()
+    return pkt_s.instance.get_id()
 end
 
 -- attempt to identify which session's watchdog timer fired
 ---@param timer_event number
 function apisessions.check_all_watchdogs(timer_event)
     for i = 1, #self.sessions do
-        local session = self.sessions[i]  ---@type api_session_struct
+        local session = self.sessions[i]  ---@type pkt_session_struct
         if session.open then
             local triggered = session.instance.check_wd(timer_event)
             if triggered then
-                log.debug(util.c("watchdog closing API session ", session.instance.get_id(),
+                log.debug(util.c("[API] watchdog closing session ", session, "..."))
-                    " on remote port ", session.r_port, "..."))
                 _shutdown(session)
             end
         end
@@ -138,7 +138,7 @@ end
 -- iterate all the API sessions
 function apisessions.iterate_all()
     for i = 1, #self.sessions do
-        local session = self.sessions[i]    ---@type api_session_struct
+        local session = self.sessions[i]    ---@type pkt_session_struct
 
         if session.open and session.instance.iterate() then
             _api_handle_outq(session)
@@ -152,10 +152,9 @@ end
 function apisessions.free_all_closed()
     local f = function (session) return session.open end
 
-    ---@param session api_session_struct
+    ---@param session pkt_session_struct
     local on_delete = function (session)
-        log.debug(util.c("free'ing closed API session ", session.instance.get_id(),
+        log.debug(util.c("[API] free'ing closed session ", session))
-            " on remote port ", session.r_port))
     end
 
     util.filter_table(self.sessions, f, on_delete)
@@ -164,7 +163,7 @@ end
 -- close all open connections
 function apisessions.close_all()
     for i = 1, #self.sessions do
-        local session = self.sessions[i]  ---@type api_session_struct
+        local session = self.sessions[i]  ---@type pkt_session_struct
         if session.open then _shutdown(session) end
     end
 

coordinator/session/pocket.lua

@@ -3,7 +3,7 @@ local log    = require("scada-common.log")
 local mqueue = require("scada-common.mqueue")
 local util   = require("scada-common.util")
 
-local api = {}
+local pocket = {}
 
 local PROTOCOL = comms.PROTOCOL
 -- local CAPI_TYPE = comms.CAPI_TYPE
@@ -21,8 +21,8 @@ local API_S_CMDS = {
 local API_S_DATA = {
 }
 
-api.API_S_CMDS = API_S_CMDS
+pocket.API_S_CMDS = API_S_CMDS
-api.API_S_DATA = API_S_DATA
+pocket.API_S_DATA = API_S_DATA
 
 local PERIODICS = {
     KEEP_ALIVE = 2000
@@ -31,11 +31,12 @@ local PERIODICS = {
 -- pocket API session
 ---@nodiscard
 ---@param id integer session ID
+---@param s_addr integer device source address
 ---@param in_queue mqueue in message queue
 ---@param out_queue mqueue out message queue
 ---@param timeout number communications timeout
-function api.new_session(id, in_queue, out_queue, timeout)
+function pocket.new_session(id, s_addr, in_queue, out_queue, timeout)
-    local log_header = "api_session(" .. id .. "): "
+    local log_header = "pkt_session(" .. id .. "): "
 
     local self = {
         -- connection properties
@@ -61,10 +62,10 @@ function api.new_session(id, in_queue, out_queue, timeout)
         }
     }
 
-    ---@class api_session
+    ---@class pkt_session
     local public = {}
 
-    -- mark this API session as closed, stop watchdog
+    -- mark this pocket session as closed, stop watchdog
     local function _close()
         self.conn_watchdog.cancel()
         self.connected = false
@@ -92,7 +93,7 @@ function api.new_session(id, in_queue, out_queue, timeout)
         local m_pkt = comms.mgmt_packet()
 
         m_pkt.make(msg_type, msg)
-        s_pkt.make(self.seq_num, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
+        s_pkt.make(s_addr, self.seq_num, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
 
         out_queue.push_packet(s_pkt)
         self.seq_num = self.seq_num + 1
@@ -117,8 +118,6 @@ function api.new_session(id, in_queue, out_queue, timeout)
         -- process packet
         if pkt.scada_frame.protocol() == PROTOCOL.COORD_API then
             ---@cast pkt capi_frame
-            -- feed watchdog
-            self.conn_watchdog.feed()
 
             -- handle packet by type
             if pkt.type == nil then
@@ -136,11 +135,11 @@ function api.new_session(id, in_queue, out_queue, timeout)
                     self.last_rtt = srv_now - srv_start
 
                     if self.last_rtt > 750 then
-                        log.warning(log_header .. "API KEEP_ALIVE round trip time > 750ms (" .. self.last_rtt .. "ms)")
+                        log.warning(log_header .. "PKT KEEP_ALIVE round trip time > 750ms (" .. self.last_rtt .. "ms)")
                     end
 
-                    -- log.debug(log_header .. "API RTT = " .. self.last_rtt .. "ms")
+                    -- log.debug(log_header .. "PKT RTT = " .. self.last_rtt .. "ms")
-                    -- log.debug(log_header .. "API TT  = " .. (srv_now - api_send) .. "ms")
+                    -- log.debug(log_header .. "PKT TT  = " .. (srv_now - api_send) .. "ms")
                 else
                     log.debug(log_header .. "SCADA keep alive packet length mismatch")
                 end
@@ -173,7 +172,7 @@ function api.new_session(id, in_queue, out_queue, timeout)
     function public.close()
         _close()
         _send_mgmt(SCADA_MGMT_TYPE.CLOSE, {})
-        println("connection to API session " .. id .. " closed by server")
+        println("connection to pocket session " .. id .. " closed by server")
         log.info(log_header .. "session closed by server")
     end
 
@@ -212,7 +211,7 @@ function api.new_session(id, in_queue, out_queue, timeout)
 
             -- exit if connection was closed
             if not self.connected then
-                println("connection to API session " .. id .. " closed by remote host")
+                println("connection to pocket session " .. id .. " closed by remote host")
                 log.info(log_header .. "session closed by remote host")
                 return self.connected
             end
@@ -248,4 +247,4 @@ function api.new_session(id, in_queue, out_queue, timeout)
     return public
 end
 
-return api
+return pocket

coordinator/startup.lua

@@ -4,23 +4,24 @@
 
 require("/initenv").init_env()
 
-local crash        = require("scada-common.crash")
+local crash       = require("scada-common.crash")
-local log          = require("scada-common.log")
+local log         = require("scada-common.log")
-local ppm          = require("scada-common.ppm")
+local network     = require("scada-common.network")
-local tcallbackdsp = require("scada-common.tcallbackdsp")
+local ppm         = require("scada-common.ppm")
-local util         = require("scada-common.util")
+local tcd         = require("scada-common.tcd")
+local util        = require("scada-common.util")
 
-local core         = require("graphics.core")
+local core        = require("graphics.core")
 
-local config       = require("coordinator.config")
+local config      = require("coordinator.config")
-local coordinator  = require("coordinator.coordinator")
+local coordinator = require("coordinator.coordinator")
-local iocontrol    = require("coordinator.iocontrol")
+local iocontrol   = require("coordinator.iocontrol")
-local renderer     = require("coordinator.renderer")
+local renderer    = require("coordinator.renderer")
-local sounder      = require("coordinator.sounder")
+local sounder     = require("coordinator.sounder")
 
-local apisessions  = require("coordinator.session.apisessions")
+local apisessions = require("coordinator.session.apisessions")
 
-local COORDINATOR_VERSION = "v0.15.1"
+local COORDINATOR_VERSION = "v0.17.1"
 
 local println = util.println
 local println_ts = util.println_ts
@@ -30,6 +31,7 @@ local log_sys = coordinator.log_sys
 local log_boot = coordinator.log_boot
 local log_comms = coordinator.log_comms
 local log_comms_connecting = coordinator.log_comms_connecting
+local log_crypto = coordinator.log_crypto
 
 ----------------------------------------
 -- config validation
@@ -37,9 +39,9 @@ local log_comms_connecting = coordinator.log_comms_connecting
 
 local cfv = util.new_validator()
 
-cfv.assert_port(config.SCADA_SV_PORT)
+cfv.assert_channel(config.SVR_CHANNEL)
-cfv.assert_port(config.SCADA_SV_CTL_LISTEN)
+cfv.assert_channel(config.CRD_CHANNEL)
-cfv.assert_port(config.SCADA_API_LISTEN)
+cfv.assert_channel(config.PKT_CHANNEL)
 cfv.assert_type_int(config.TRUSTED_RANGE)
 cfv.assert_type_num(config.SV_TIMEOUT)
 cfv.assert_min(config.SV_TIMEOUT, 2)
@@ -131,6 +133,12 @@ local function main()
     -- setup communications
     ----------------------------------------
 
+    -- message authentication init
+    if type(config.AUTH_KEY) == "string" then
+        local init_time = network.init_mac(config.AUTH_KEY)
+        log_crypto("HMAC init took " .. init_time .. "ms")
+    end
+
     -- get the communications modem
     local modem = ppm.get_wireless_modem()
     if modem == nil then
@@ -147,9 +155,10 @@ local function main()
     conn_watchdog.cancel()
     log.debug("startup> conn watchdog created")
 
-    -- start comms, open all channels
+    -- create network interface then setup comms
-    local coord_comms = coordinator.comms(COORDINATOR_VERSION, modem, config.SCADA_SV_PORT, config.SCADA_SV_CTL_LISTEN,
+    local nic = network.nic(modem)
-                                            config.SCADA_API_LISTEN, config.TRUSTED_RANGE, conn_watchdog)
+    local coord_comms = coordinator.comms(COORDINATOR_VERSION, nic, config.CRD_CHANNEL, config.SVR_CHANNEL,
+                                            config.PKT_CHANNEL, config.TRUSTED_RANGE, conn_watchdog)
     log.debug("startup> comms init")
     log_comms("comms initialized")
 
@@ -163,7 +172,7 @@ local function main()
 
     -- attempt to connect to the supervisor or exit
     local function init_connect_sv()
-        local tick_waiting, task_done = log_comms_connecting("attempting to connect to configured supervisor on channel " .. config.SCADA_SV_PORT)
+        local tick_waiting, task_done = log_comms_connecting("attempting to connect to configured supervisor on channel " .. config.SVR_CHANNEL)
 
         -- attempt to establish a connection with the supervisory computer
         if not coord_comms.sv_connect(60, tick_waiting, task_done) then
@@ -218,8 +227,6 @@ local function main()
 
     local date_format = util.trinary(config.TIME_24_HOUR, "%X \x04 %A, %B %d %Y", "%r \x04 %A, %B %d %Y")
 
-    local no_modem = false
-
     if ui_ok then
         -- start connection watchdog
         conn_watchdog.feed()
@@ -239,8 +246,9 @@ local function main()
             if type ~= nil and device ~= nil then
                 if type == "modem" then
                     -- we only really care if this is our wireless modem
-                    if device == modem then
+                    -- if it is another modem, handle other peripheral losses separately
-                        no_modem = true
+                    if nic.is_modem(device) then
+                        nic.disconnect()
                         log_sys("comms modem disconnected")
                         println_ts("wireless modem disconnected!")
 
@@ -254,6 +262,7 @@ local function main()
                     end
                 elseif type == "monitor" then
                     if renderer.is_monitor_used(device) then
+                        ---@todo will be handled properly in #249
                         -- "halt and catch fire" style handling
                         local msg = "lost a configured monitor, system will now exit"
                         println_ts(msg)
@@ -275,9 +284,7 @@ local function main()
                 if type == "modem" then
                     if device.isWireless() then
                         -- reconnected modem
-                        no_modem = false
+                        nic.connect(device)
-                        modem = device
-                        coord_comms.reconnect_modem(modem)
 
                         log_sys("comms modem reconnected")
                         println_ts("wireless modem reconnected.")
@@ -289,6 +296,7 @@ local function main()
                         log_sys("wired modem reconnected")
                     end
                 -- elseif type == "monitor" then
+                    ---@todo will be handled properly in #249
                     -- not supported, system will exit on loss of in-use monitors
                 elseif type == "speaker" then
                     local msg = "alarm sounder speaker reconnected"
@@ -322,7 +330,7 @@ local function main()
                 renderer.close_ui()
                 sounder.stop()
 
-                if not no_modem then
+                if nic.connected() then
                     -- try to re-connect to the supervisor
                     if not init_connect_sv() then break end
                     ui_ok = init_start_ui()
@@ -334,7 +342,7 @@ local function main()
                 apisessions.check_all_watchdogs(param1)
 
                 -- notify timer callback dispatcher
-                tcallbackdsp.handle(param1)
+                tcd.handle(param1)
             end
         elseif event == "modem_message" then
             -- got a packet
@@ -350,7 +358,7 @@ local function main()
                 renderer.close_ui()
                 sounder.stop()
 
-                if not no_modem then
+                if nic.connected() then
                     -- try to re-connect to the supervisor
                     if not init_connect_sv() then break end
                     ui_ok = init_start_ui()

coordinator/ui/components/processctl.lua

@@ -1,4 +1,4 @@
-local tcd               = require("scada-common.tcallbackdsp")
+local tcd               = require("scada-common.tcd")
 local util              = require("scada-common.util")
 
 local iocontrol         = require("coordinator.iocontrol")
@@ -33,7 +33,7 @@ local period = core.flasher.PERIOD
 ---@param x integer top left x
 ---@param y integer top left y
 local function new_view(root, x, y)
-    assert(root.height() >= (y + 24), "main display not of sufficient vertical resolution (add an additional row of monitors)")
+    assert(root.get_height() >= (y + 24), "main display not of sufficient vertical resolution (add an additional row of monitors)")
 
     local facility = iocontrol.get_db().facility
     local units = iocontrol.get_db().units

coordinator/ui/components/unit_overview.lua

@@ -38,7 +38,7 @@ local function make(parent, x, y, unit)
         height = 17
     end
 
-    assert(parent.height() >= (y + height), "main display not of sufficient vertical resolution (add an additional row of monitors)")
+    assert(parent.get_height() >= (y + height), "main display not of sufficient vertical resolution (add an additional row of monitors)")
 
     -- bounding box div
     local root = Div{parent=parent,x=x,y=y,width=80,height=height}

coordinator/ui/layout/main_view.lua

@@ -32,7 +32,7 @@ local function init(main)
     local header = TextBox{parent=main,y=1,text="Nuclear Generation Facility SCADA Coordinator",alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=style.header}
     local ping = DataIndicator{parent=main,x=1,y=1,label="SVTT",format="%d",value=0,unit="ms",lu_colors=cpair(colors.lightGray, colors.white),width=12,fg_bg=style.header}
     -- max length example: "01:23:45 AM - Wednesday, September 28 2022"
-    local datetime = TextBox{parent=main,x=(header.width()-42),y=1,text="",alignment=TEXT_ALIGN.RIGHT,width=42,height=1,fg_bg=style.header}
+    local datetime = TextBox{parent=main,x=(header.get_width()-42),y=1,text="",alignment=TEXT_ALIGN.RIGHT,width=42,height=1,fg_bg=style.header}
 
     ping.register(facility.ps, "sv_ping", ping.update)
     datetime.register(facility.ps, "date_time", datetime.set_value)
@@ -45,12 +45,12 @@ local function init(main)
     -- unit overviews
     if facility.num_units >= 1 then
         uo_1 = unit_overview(main, 2, 3, units[1])
-        row_1_height = uo_1.height()
+        row_1_height = uo_1.get_height()
     end
 
     if facility.num_units >= 2 then
         uo_2 = unit_overview(main, 84, 3, units[2])
-        row_1_height = math.max(row_1_height, uo_2.height())
+        row_1_height = math.max(row_1_height, uo_2.get_height())
     end
 
     cnc_y_start = cnc_y_start + row_1_height + 1
@@ -60,11 +60,11 @@ local function init(main)
         local row_2_offset = cnc_y_start
 
         uo_3 = unit_overview(main, 2, row_2_offset, units[3])
-        cnc_y_start = row_2_offset + uo_3.height() + 1
+        cnc_y_start = row_2_offset + uo_3.get_height() + 1
 
         if facility.num_units == 4 then
             uo_4 = unit_overview(main, 84, row_2_offset, units[4])
-            cnc_y_start = math.max(cnc_y_start, row_2_offset + uo_4.height() + 1)
+            cnc_y_start = math.max(cnc_y_start, row_2_offset + uo_4.get_height() + 1)
         end
     end
 
@@ -73,11 +73,11 @@ local function init(main)
     cnc_y_start = cnc_y_start
 
     -- induction matrix and process control interfaces are 24 tall + space needed for divider
-    local cnc_bottom_align_start = main.height() - 26
+    local cnc_bottom_align_start = main.get_height() - 26
 
     assert(cnc_bottom_align_start >= cnc_y_start, "main display not of sufficient vertical resolution (add an additional row of monitors)")
 
-    TextBox{parent=main,y=cnc_bottom_align_start,text=util.strrep("\x8c", header.width()),alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=cpair(colors.lightGray,colors.gray)}
+    TextBox{parent=main,y=cnc_bottom_align_start,text=util.strrep("\x8c", header.get_width()),alignment=TEXT_ALIGN.CENTER,height=1,fg_bg=cpair(colors.lightGray,colors.gray)}
 
     cnc_bottom_align_start = cnc_bottom_align_start + 2
 

graphics/core.lua

@@ -7,6 +7,8 @@ local flasher = require("graphics.flasher")
 
 local core = {}
 
+core.version = "1.0.0"
+
 core.flasher = flasher
 core.events = events
 

graphics/element.lua

@@ -12,12 +12,11 @@ local element = {}
 ---@field id? string element id
 ---@field x? integer 1 if omitted
 ---@field y? integer next line if omitted
----@field offset_x? integer 0 if omitted
----@field offset_y? integer 0 if omitted
 ---@field width? integer parent width if omitted
 ---@field height? integer parent height if omitted
 ---@field gframe? graphics_frame frame instead of x/y/width/height
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 ---@alias graphics_args graphics_args_generic
 ---|waiting_args
@@ -46,6 +45,7 @@ local element = {}
 ---|colormap_args
 ---|displaybox_args
 ---|div_args
+---|listbox_args
 ---|multipane_args
 ---|pipenet_args
 ---|rectangle_args
@@ -60,28 +60,30 @@ local element = {}
 -- a base graphics element, should not be created on its own
 ---@nodiscard
 ---@param args graphics_args arguments
-function element.new(args)
+---@param child_offset_x? integer mouse event offset x
+---@param child_offset_y? integer mouse event offset y
+function element.new(args, child_offset_x, child_offset_y)
     local self = {
-        id = -1,
+        id = nil,                                       ---@type element_id|nil
         elem_type = debug.getinfo(2).name,
         define_completed = false,
         p_window = nil,                                 ---@type table
         position = { x = 1, y = 1 },                    ---@type coordinate_2d
-        child_offset = { x = 0, y = 0 },
         bounds = { x1 = 1, y1 = 1, x2 = 1, y2 = 1 },    ---@class element_bounds
         next_y = 1,
-        children = {},
         subscriptions = {},
         mt = {}
     }
 
-    ---@class graphics_template
+    ---@class graphics_base
     local protected = {
         enabled = true,
-        value = nil,    ---@type any
+        value = nil,            ---@type any
-        window = nil,   ---@type table
+        window = nil,           ---@type table
+        content_window = nil,   ---@type table|nil
         fg_bg = core.cpair(colors.white, colors.black),
-        frame = core.gframe(1, 1, 1, 1)
+        frame = core.gframe(1, 1, 1, 1),
+        children = {}
     }
 
     local name_brief = "graphics.element{" .. self.elem_type .. "}: "
@@ -101,8 +103,8 @@ function element.new(args)
     -------------------------
 
     -- prepare the template
-    ---@param offset_x integer x offset
+    ---@param offset_x integer x offset for mouse events
-    ---@param offset_y integer y offset
+    ---@param offset_y integer y offset for mouse events
     ---@param next_y integer next line if no y was provided
     function protected.prepare_template(offset_x, offset_y, next_y)
         -- get frame coordinates/size
@@ -114,36 +116,18 @@ function element.new(args)
         else
             local w, h = self.p_window.getSize()
             protected.frame.x = args.x or 1
-
+            protected.frame.y = args.y or next_y
-            if args.parent ~= nil then
-                protected.frame.y = args.y or (next_y - offset_y)
-            else
-                protected.frame.y = args.y or next_y
-            end
-
             protected.frame.w = args.width or w
             protected.frame.h = args.height or h
         end
 
-        -- inner offsets
-        if args.offset_x ~= nil then self.child_offset.x = args.offset_x end
-        if args.offset_y ~= nil then self.child_offset.y = args.offset_y end
-
         -- adjust window frame if applicable
         local f = protected.frame
-        local x = f.x
-        local y = f.y
-
-        -- apply offsets
         if args.parent ~= nil then
             -- constrain to parent inner width/height
             local w, h = self.p_window.getSize()
-            f.w = math.min(f.w, w - ((2 * offset_x) + (f.x - 1)))
+            f.w = math.min(f.w, w - (f.x - 1))
-            f.h = math.min(f.h, h - ((2 * offset_y) + (f.y - 1)))
+            f.h = math.min(f.h, h - (f.y - 1))
-
-            -- offset x/y
-            f.x = x + offset_x
-            f.y = y + offset_y
         end
 
         -- check frame
@@ -153,7 +137,7 @@ function element.new(args)
         assert(f.h >= 1, name_brief .. "frame height not >= 1")
 
         -- create window
-        protected.window = window.create(self.p_window, f.x, f.y, f.w, f.h, true)
+        protected.window = window.create(self.p_window, f.x, f.y, f.w, f.h, args.hidden ~= true)
 
         -- init colors
         if args.fg_bg ~= nil then
@@ -170,34 +154,47 @@ function element.new(args)
         -- record position
         self.position.x, self.position.y = protected.window.getPosition()
 
-        -- calculate bounds
+        -- shift per parent child offset
+        self.position.x = self.position.x + offset_x
+        self.position.y = self.position.y + offset_y
+
+        -- calculate mouse event bounds
         self.bounds.x1 = self.position.x
         self.bounds.x2 = self.position.x + f.w - 1
         self.bounds.y1 = self.position.y
         self.bounds.y2 = self.position.y + f.h - 1
     end
 
-    -- check if a coordinate is within the bounds of this element
+    -- check if a coordinate relative to the parent is within the bounds of this element
     ---@param x integer
     ---@param y integer
-    function protected.in_bounds(x, y)
+    function protected.in_window_bounds(x, y)
         local in_x = x >= self.bounds.x1 and x <= self.bounds.x2
         local in_y = y >= self.bounds.y1 and y <= self.bounds.y2
         return in_x and in_y
     end
 
+    -- check if a coordinate relative to this window is within the bounds of this element
+    ---@param x integer
+    ---@param y integer
+    function protected.in_frame_bounds(x, y)
+        local in_x = x >= 1 and x <= protected.frame.w
+        local in_y = y >= 1 and y <= protected.frame.h
+        return in_x and in_y
+    end
+
 -- luacheck: push ignore
 ---@diagnostic disable: unused-local, unused-vararg
 
-    -- dynamically insert a child element
+    -- handle a child element having been added
-    ---@param id string|integer element identifier
+    ---@param id element_id element identifier
-    ---@param elem graphics_element element
+    ---@param child graphics_element child element
-    function protected.insert(id, elem)
+    function protected.on_added(id, child)
     end
 
-    -- dynamically remove a child element
+    -- handle a child element having been removed
-    ---@param id string|integer element identifier
+    ---@param id element_id element identifier
-    function protected.remove(id)
+    function protected.on_removed(id)
     end
 
     -- handle a mouse event
@@ -270,6 +267,14 @@ function element.new(args)
     ---@return graphics_element element, element_id id
     function protected.get() return public, self.id end
 
+    -- report completion of element instantiation and get the public interface
+    ---@nodiscard
+    ---@return graphics_element element, element_id id
+    function protected.complete()
+        if args.parent ~= nil then args.parent.__child_ready(self.id, public) end
+        return public, self.id
+    end
+
     -----------
     -- SETUP --
     -----------
@@ -285,6 +290,7 @@ function element.new(args)
 
     -- prepare the template
     if args.parent == nil then
+        self.id = args.id or "__ROOT__"
         protected.prepare_template(0, 0, 1)
     else
         self.id = args.parent.__add_child(args.id, protected)
@@ -296,11 +302,21 @@ function element.new(args)
 
     -- get the window object
     ---@nodiscard
-    function public.window() return protected.window end
+    function public.window() return protected.content_window or protected.window end
 
     -- delete this element (hide and unsubscribe from PSIL)
     function public.delete()
-        -- hide + stop animations
+        local fg_bg = protected.fg_bg
+
+        if args.parent ~= nil then
+            -- grab parent fg/bg so we can clear cleanly as a child element
+            fg_bg = args.parent.get_fg_bg()
+        end
+
+        -- clear, hide, and stop animations
+        protected.window.setBackgroundColor(fg_bg.bkg)
+        protected.window.setTextColor(fg_bg.fgd)
+        protected.window.clear()
         public.hide()
 
         -- unsubscribe from PSIL
@@ -310,9 +326,14 @@ function element.new(args)
         end
 
         -- delete all children
-        for k, v in pairs(self.children) do
+        for k, v in pairs(protected.children) do
             v.delete()
-            self.children[k] = nil
+            protected.children[k] = nil
+        end
+
+        if args.parent ~= nil then
+            -- remove self from parent
+            args.parent.__remove_child(self.id)
         end
     end
 
@@ -321,41 +342,53 @@ function element.new(args)
     -- add a child element
     ---@nodiscard
     ---@param key string|nil id
-    ---@param child graphics_template
+    ---@param child graphics_base
     ---@return integer|string key
     function public.__add_child(key, child)
-        -- offset first automatic placement
+        child.prepare_template(child_offset_x or 0, child_offset_y or 0, self.next_y)
-        if self.next_y <= self.child_offset.y then
-            self.next_y = self.child_offset.y + 1
-        end
-
-        child.prepare_template(self.child_offset.x, self.child_offset.y, self.next_y)
 
         self.next_y = child.frame.y + child.frame.h
 
         local child_element = child.get()
 
         if key == nil then
-            table.insert(self.children, child_element)
+            table.insert(protected.children, child_element)
-            return #self.children
+            return #protected.children
         else
-            self.children[key] = child_element
+            protected.children[key] = child_element
             return key
         end
     end
 
+    -- remove a child element
+    ---@param key element_id id
+    function public.__remove_child(key)
+        if protected.children[key] ~= nil then
+            protected.on_removed(key)
+            protected.children[key] = nil
+        end
+    end
+
+    -- actions to take upon a child element becoming ready (initial draw/construction completed)
+    ---@param key element_id id
+    ---@param child graphics_element
+    function public.__child_ready(key, child)
+        protected.on_added(key, child)
+    end
+
     -- get a child element
     ---@nodiscard
     ---@param id element_id
     ---@return graphics_element
-    function public.get_child(id) return self.children[id] end
+    function public.get_child(id) return protected.children[id] end
 
     -- remove a child element
     ---@param id element_id
     function public.remove(id)
-        if self.children[id] ~= nil then
+        if protected.children[id] ~= nil then
-            self.children[id].delete()
+            protected.children[id].delete()
-            self.children[id] = nil
+            protected.on_removed(id)
+            protected.children[id] = nil
         end
     end
 
@@ -364,37 +397,18 @@ function element.new(args)
     ---@param id element_id
     ---@return graphics_element|nil element
     function public.get_element_by_id(id)
-        if self.children[id] == nil then
+        if protected.children[id] == nil then
-            for _, child in pairs(self.children) do
+            for _, child in pairs(protected.children) do
                 local elem = child.get_element_by_id(id)
                 if elem ~= nil then return elem end
             end
         else
-            return self.children[id]
+            return protected.children[id]
         end
 
         return nil
     end
 
-    -- DYNAMIC CHILD ELEMENTS --
-
-    -- insert an element as a contained child<br>
-    -- this is intended to be used dynamically, and depends on the target element type.<br>
-    -- not all elements support dynamic children.
-    ---@param id string|integer element identifier
-    ---@param elem graphics_element element
-    function public.insert_element(id, elem)
-        protected.insert(id, elem)
-    end
-
-    -- remove an element from contained children<br>
-    -- this is intended to be used dynamically, and depends on the target element type.<br>
-    -- not all elements support dynamic children.
-    ---@param id string|integer element identifier
-    function public.remove_element(id)
-        protected.remove(id)
-    end
-
     -- AUTO-PLACEMENT --
 
     -- skip a line for automatically placed elements
@@ -428,14 +442,14 @@ function element.new(args)
     -- get element width
     ---@nodiscard
     ---@return integer width
-    function public.width()
+    function public.get_width()
         return protected.frame.w
     end
 
     -- get element height
     ---@nodiscard
     ---@return integer height
-    function public.height()
+    function public.get_height()
         return protected.frame.h
     end
 
@@ -503,14 +517,14 @@ function element.new(args)
     function public.handle_mouse(event)
         local x_ini, y_ini = event.initial.x, event.initial.y
 
-        local ini_in = protected.in_bounds(x_ini, y_ini)
+        local ini_in = protected.in_window_bounds(x_ini, y_ini)
 
         if ini_in then
             local event_T = core.events.mouse_transposed(event, self.position.x, self.position.y)
 
             -- handle the mouse event then pass to children
             protected.handle_mouse(event_T)
-            for _, child in pairs(self.children) do child.handle_mouse(event_T) end
+            for _, child in pairs(protected.children) do child.handle_mouse(event_T) end
         end
     end
 
@@ -536,27 +550,61 @@ function element.new(args)
         ps.subscribe(key, func)
     end
 
-    -- VISIBILITY --
+    -- VISIBILITY & ANIMATIONS --
 
-    -- show the element
+    -- show the element and enables animations by default
-    function public.show()
+    ---@param animate? boolean true (default) to automatically resume animations
+    function public.show(animate)
         protected.window.setVisible(true)
-        protected.start_anim()
+        if animate ~= false then public.animate_all() end
-        for _, child in pairs(self.children) do child.show() end
     end
 
-    -- hide the element
+    -- hide the element and disables animations<br>
+    -- this alone does not cause an element to be fully hidden, it only prevents updates from being shown<br>
+    ---@see graphics_element.content_redraw
     function public.hide()
-        protected.stop_anim()
+        public.freeze_all() -- stop animations for efficiency/performance
-        for _, child in pairs(self.children) do child.hide() end
         protected.window.setVisible(false)
     end
 
+    -- start/resume animation(s)
+    function public.animate()
+        protected.start_anim()
+    end
+
+    -- start/resume animation(s) for this element and all its children<br>
+    -- only animates if a window is visible
+    function public.animate_all()
+        if protected.window.isVisible() then
+            public.animate()
+            for _, child in pairs(protected.children) do child.animate_all() end
+        end
+    end
+
+    -- freeze animation(s)
+    function public.freeze()
+        protected.stop_anim()
+    end
+
+    -- freeze animation(s) for this element and all its children
+    function public.freeze_all()
+        public.freeze()
+        for _, child in pairs(protected.children) do child.freeze_all() end
+    end
+
     -- re-draw the element
     function public.redraw()
         protected.window.redraw()
     end
 
+    -- if a content window is set, clears it then re-draws all children
+    function public.content_redraw()
+        if protected.content_window ~= nil then
+            protected.content_window.clear()
+            for _, child in pairs(protected.children) do child.redraw() end
+        end
+    end
+
     return protected
 end
 

graphics/elements/animations/waiting.lua

@@ -1,6 +1,6 @@
 -- Loading/Waiting Animation Graphics Element
 
-local tcd     = require("scada-common.tcallbackdsp")
+local tcd     = require("scada-common.tcd")
 
 local element = require("graphics.element")
 
@@ -10,6 +10,7 @@ local element = require("graphics.element")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new waiting animation element
 ---@param args waiting_args
@@ -102,7 +103,7 @@ local function waiting(args)
 
     e.start_anim()
 
-    return e.get()
+    return e.complete()
 end
 
 return waiting

graphics/elements/colormap.lua

@@ -9,6 +9,7 @@ local element = require("graphics.element")
 ---@field id? string element id
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
+---@field hidden? boolean true to hide on initial draw
 
 -- new color map
 ---@param args colormap_args
@@ -27,7 +28,7 @@ local function colormap(args)
     e.window.setCursorPos(1, 1)
     e.window.blit(spaces, bkg, bkg)
 
-    return e.get()
+    return e.complete()
 end
 
 return colormap

graphics/elements/controls/hazard_button.lua

@@ -1,6 +1,6 @@
 -- Hazard-bordered Button Graphics Element
 
-local tcd     = require("scada-common.tcallbackdsp")
+local tcd     = require("scada-common.tcd")
 local util    = require("scada-common.util")
 
 local core    = require("graphics.core")
@@ -16,6 +16,7 @@ local element = require("graphics.element")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new hazard button
 ---@param args hazard_button_args
@@ -198,7 +199,7 @@ local function hazard_button(args)
     -- initial draw of border
     draw_border(args.accent)
 
-    return e.get()
+    return e.complete()
 end
 
 return hazard_button

graphics/elements/controls/multi_button.lua

@@ -23,6 +23,7 @@ local element = require("graphics.element")
 ---@field y? integer 1 if omitted
 ---@field height? integer parent height if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new multi button (latch selection, exclusively one button at a time)
 ---@param args multi_button_args
@@ -130,7 +131,7 @@ local function multi_button(args)
     -- initial draw
     draw()
 
-    return e.get()
+    return e.complete()
 end
 
 return multi_button

graphics/elements/controls/push_button.lua

@@ -1,6 +1,6 @@
 -- Button Graphics Element
 
-local tcd     = require("scada-common.tcallbackdsp")
+local tcd     = require("scada-common.tcd")
 
 local core    = require("graphics.core")
 local element = require("graphics.element")
@@ -19,6 +19,7 @@ local CLICK_TYPE = core.events.CLICK_TYPE
 ---@field y? integer 1 if omitted
 ---@field height? integer parent height if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new push button
 ---@param args push_button_args
@@ -84,7 +85,7 @@ local function push_button(args)
                 show_pressed()
             elseif event.type == CLICK_TYPE.UP then
                 show_unpressed()
-                if e.in_bounds(event.current.x, event.current.y) then
+                if e.in_frame_bounds(event.current.x, event.current.y) then
                     args.callback()
                 end
             end
@@ -120,7 +121,7 @@ local function push_button(args)
     -- initial draw
     draw()
 
-    return e.get()
+    return e.complete()
 end
 
 return push_button

graphics/elements/controls/radio_button.lua

@@ -15,6 +15,7 @@ local element = require("graphics.element")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new radio button list (latch selection, exclusively one button at a time)
 ---@param args radio_button_args
@@ -103,7 +104,7 @@ local function radio_button(args)
     -- initial draw
     draw()
 
-    return e.get()
+    return e.complete()
 end
 
 return radio_button

graphics/elements/controls/sidebar.lua

@@ -1,6 +1,6 @@
 -- Sidebar Graphics Element
 
-local tcd     = require("scada-common.tcallbackdsp")
+local tcd     = require("scada-common.tcd")
 
 local core    = require("graphics.core")
 local element = require("graphics.element")
@@ -20,6 +20,7 @@ local CLICK_TYPE = core.events.CLICK_TYPE
 ---@field y? integer 1 if omitted
 ---@field height? integer parent height if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new sidebar tab selector
 ---@param args sidebar_args
@@ -93,7 +94,7 @@ local function sidebar(args)
                 elseif event.type == CLICK_TYPE.DOWN then
                     draw(true, cur_idx)
                 elseif event.type == CLICK_TYPE.UP then
-                    if cur_idx == ini_idx and e.in_bounds(event.current.x, event.current.y) then
+                    if cur_idx == ini_idx and e.in_frame_bounds(event.current.x, event.current.y) then
                         e.value = cur_idx
                         draw(false)
                         args.callback(e.value)
@@ -115,7 +116,7 @@ local function sidebar(args)
     -- initial draw
     draw(false)
 
-    return e.get()
+    return e.complete()
 end
 
 return sidebar

graphics/elements/controls/spinbox_numeric.lua

@@ -18,6 +18,7 @@ local element = require("graphics.element")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new spinbox control (minimum value is 0)
 ---@param args spinbox_args
@@ -188,7 +189,7 @@ local function spinbox(args)
     e.value = 0
     set_digits()
 
-    return e.get()
+    return e.complete()
 end
 
 return spinbox

graphics/elements/controls/switch_button.lua

@@ -15,6 +15,7 @@ local element = require("graphics.element")
 ---@field y? integer 1 if omitted
 ---@field height? integer parent height if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new switch button (latch high/low)
 ---@param args switch_button_args
@@ -86,7 +87,7 @@ local function switch_button(args)
         draw_state()
     end
 
-    return e.get()
+    return e.complete()
 end
 
 return switch_button

graphics/elements/controls/tabbar.lua

@@ -21,6 +21,7 @@ local element = require("graphics.element")
 ---@field y? integer 1 if omitted
 ---@field width? integer parent width if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new tab selector
 ---@param args tabbar_args
@@ -124,7 +125,7 @@ local function tabbar(args)
     -- initial draw
     draw()
 
-    return e.get()
+    return e.complete()
 end
 
 return tabbar

graphics/elements/displaybox.lua

@@ -4,19 +4,22 @@ local element = require("graphics.element")
 
 ---@class displaybox_args
 ---@field window table
+---@field id? string element id
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field width? integer parent width if omitted
 ---@field height? integer parent height if omitted
 ---@field gframe? graphics_frame frame instead of x/y/width/height
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new root display box
 ---@nodiscard
 ---@param args displaybox_args
+---@return graphics_element element, element_id id
 local function displaybox(args)
     -- create new graphics element base object
-    return element.new(args).get()
+    return element.new(args).complete()
 end
 
 return displaybox

graphics/elements/div.lua

@@ -11,6 +11,7 @@ local element = require("graphics.element")
 ---@field height? integer parent height if omitted
 ---@field gframe? graphics_frame frame instead of x/y/width/height
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new div element
 ---@nodiscard
@@ -18,7 +19,7 @@ local element = require("graphics.element")
 ---@return graphics_element element, element_id id
 local function div(args)
     -- create new graphics element base object
-    return element.new(args).get()
+    return element.new(args).complete()
 end
 
 return div

graphics/elements/indicators/alight.lua

@@ -18,6 +18,7 @@ local flasher = require("graphics.flasher")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new alarm indicator light
 ---@nodiscard
@@ -108,7 +109,7 @@ local function alarm_indicator_light(args)
     e.on_update(1)
     e.window.write(args.label)
 
-    return e.get()
+    return e.complete()
 end
 
 return alarm_indicator_light

graphics/elements/indicators/coremap.lua

@@ -163,7 +163,7 @@ local function core_map(args)
     -- initial draw
     e.on_update(0)
 
-    return e.get()
+    return e.complete()
 end
 
 return core_map

graphics/elements/indicators/data.lua

@@ -17,6 +17,7 @@ local element = require("graphics.element")
 ---@field y? integer 1 if omitted
 ---@field width integer length
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new data indicator
 ---@nodiscard
@@ -43,8 +44,9 @@ local function data(args)
     e.window.setCursorPos(1, 1)
     e.window.write(args.label)
 
-    local label_len = string.len(args.label)
+    local value_color = e.fg_bg.fgd
-    local data_start = 1
+    local label_len   = string.len(args.label)
+    local data_start  = 1
     local clear_width = args.width
 
     if label_len > 0 then
@@ -64,7 +66,7 @@ local function data(args)
         -- write data
         local data_str = util.sprintf(args.format, value)
         e.window.setCursorPos(data_start, 1)
-        e.window.setTextColor(e.fg_bg.fgd)
+        e.window.setTextColor(value_color)
         if args.commas then
             e.window.write(util.comma_format(data_str))
         else
@@ -84,10 +86,17 @@ local function data(args)
     ---@param val any new value
     function e.set_value(val) e.on_update(val) end
 
+    -- change the foreground color of the value, or all text if no label/unit colors provided
+    ---@param c color
+    function e.recolor(c)
+        value_color = c
+        e.on_update(e.value)
+    end
+
     -- initial value draw
     e.on_update(args.value)
 
-    return e.get()
+    return e.complete()
 end
 
 return data

graphics/elements/indicators/hbar.lua

@@ -15,6 +15,7 @@ local element = require("graphics.element")
 ---@field height? integer parent height if omitted
 ---@field gframe? graphics_frame frame instead of x/y/width/height
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new horizontal bar
 ---@nodiscard
@@ -119,7 +120,7 @@ local function hbar(args)
     -- initialize to 0
     e.on_update(0)
 
-    return e.get()
+    return e.complete()
 end
 
 return hbar

graphics/elements/indicators/icon.lua

@@ -18,6 +18,7 @@ local element = require("graphics.element")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new icon indicator
 ---@nodiscard
@@ -68,7 +69,7 @@ local function icon(args)
     -- initial icon draw
     e.on_update(args.value or 1)
 
-    return e.get()
+    return e.complete()
 end
 
 return icon

graphics/elements/indicators/led.lua

@@ -16,6 +16,7 @@ local flasher = require("graphics.flasher")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new indicator LED
 ---@nodiscard
@@ -94,7 +95,7 @@ local function indicator_led(args)
         e.window.write(args.label)
     end
 
-    return e.get()
+    return e.complete()
 end
 
 return indicator_led

graphics/elements/indicators/ledpair.lua

@@ -18,6 +18,7 @@ local flasher = require("graphics.flasher")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new dual LED indicator light
 ---@nodiscard
@@ -108,7 +109,7 @@ local function indicator_led_pair(args)
         e.window.write(args.label)
     end
 
-    return e.get()
+    return e.complete()
 end
 
 return indicator_led_pair

graphics/elements/indicators/ledrgb.lua

@@ -11,6 +11,7 @@ local element = require("graphics.element")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new RGB LED indicator light
 ---@nodiscard
@@ -53,7 +54,7 @@ local function indicator_led_rgb(args)
         e.window.write(args.label)
     end
 
-    return e.get()
+    return e.complete()
 end
 
 return indicator_led_rgb

graphics/elements/indicators/light.lua

@@ -16,6 +16,7 @@ local flasher = require("graphics.flasher")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new indicator light
 ---@nodiscard
@@ -92,7 +93,7 @@ local function indicator_light(args)
     e.window.setCursorPos(3, 1)
     e.window.write(args.label)
 
-    return e.get()
+    return e.complete()
 end
 
 return indicator_light

graphics/elements/indicators/power.lua

@@ -16,6 +16,7 @@ local element = require("graphics.element")
 ---@field y? integer 1 if omitted
 ---@field width integer length
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new power indicator
 ---@nodiscard
@@ -79,7 +80,7 @@ local function power(args)
     -- initial value draw
     e.on_update(args.value)
 
-    return e.get()
+    return e.complete()
 end
 
 return power

graphics/elements/indicators/rad.lua

@@ -17,6 +17,7 @@ local element = require("graphics.element")
 ---@field y? integer 1 if omitted
 ---@field width integer length
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new radiation indicator
 ---@nodiscard
@@ -84,7 +85,7 @@ local function rad(args)
     -- initial value draw
     e.on_update(types.new_zero_radiation_reading())
 
-    return e.get()
+    return e.complete()
 end
 
 return rad

graphics/elements/indicators/state.lua

@@ -18,6 +18,7 @@ local element = require("graphics.element")
 ---@field y? integer 1 if omitted
 ---@field height? integer 1 if omitted, must be an odd number
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new state indicator
 ---@nodiscard
@@ -74,7 +75,7 @@ local function state_indicator(args)
     -- initial draw
     e.on_update(args.value or 1)
 
-    return e.get()
+    return e.complete()
 end
 
 return state_indicator

graphics/elements/indicators/trilight.lua

@@ -18,6 +18,7 @@ local flasher = require("graphics.flasher")
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new tri-state indicator light
 ---@nodiscard
@@ -105,7 +106,7 @@ local function tristate_indicator_light(args)
     e.on_update(1)
     e.window.write(args.label)
 
-    return e.get()
+    return e.complete()
 end
 
 return tristate_indicator_light

graphics/elements/indicators/vbar.lua

@@ -13,6 +13,7 @@ local element = require("graphics.element")
 ---@field height? integer parent height if omitted
 ---@field gframe? graphics_frame frame instead of x/y/width/height
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new vertical bar
 ---@nodiscard
@@ -99,7 +100,7 @@ local function vbar(args)
     ---@param val number 0.0 to 1.0
     function e.set_value(val) e.on_update(val) end
 
-    return e.get()
+    return e.complete()
 end
 
 return vbar

graphics/elements/listbox.lua

@@ -0,0 +1,283 @@
+-- Scroll-able List Box Display Graphics Element
+
+local tcd     = require("scada-common.tcd")
+
+local core    = require("graphics.core")
+local element = require("graphics.element")
+
+local CLICK_TYPE = core.events.CLICK_TYPE
+
+---@class listbox_args
+---@field scroll_height integer height of internal scrolling container (must fit all elements vertically tiled)
+---@field item_pad? integer spacing (lines) between items in the list (default 0)
+---@field nav_fg_bg? cpair foreground/background colors for scroll arrows and bar area
+---@field nav_active? cpair active colors for bar held down or arrow held down
+---@field parent graphics_element
+---@field id? string element id
+---@field x? integer 1 if omitted
+---@field y? integer 1 if omitted
+---@field width? integer parent width if omitted
+---@field height? integer parent height if omitted
+---@field gframe? graphics_frame frame instead of x/y/width/height
+---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
+
+---@class listbox_item
+---@field id string|integer element ID
+---@field e graphics_element element
+---@field y integer y position
+---@field h integer element height
+
+-- new listbox element
+---@nodiscard
+---@param args listbox_args
+---@return graphics_element element, element_id id
+local function listbox(args)
+    -- create new graphics element base object
+    local e = element.new(args)
+
+    -- create content window for child elements
+    local scroll_frame = window.create(e.window, 1, 1, e.frame.w - 1, args.scroll_height, false)
+    e.content_window = scroll_frame
+
+    -- item list and scroll management
+    local list            = {}
+    local item_pad        = args.item_pad or 0
+    local scroll_offset   = 0
+    local content_height  = 0
+    local max_down_scroll = 0
+    -- bar control/tracking variables
+    local max_bar_height  = e.frame.h - 2
+    local bar_height      = 0           -- full height of bar
+    local bar_bounds      = { 0, 0 }    -- top and bottom of bar
+    local bar_is_scaled   = false       -- if the scrollbar doesn't have a 1:1 ratio with lines
+    local holding_bar     = false       -- bar is being held by mouse
+    local bar_grip_pos    = 0           -- where the bar was gripped by mouse down
+    local mouse_last_y    = 0           -- last reported y coordinate of drag
+
+    -- draw scroll bar arrows, optionally showing one of them as pressed
+    ---@param pressed_arrow? 1|0|-1 arrow to show as pressed (1 = scroll up, 0 = neither, -1 = scroll down)
+    local function draw_arrows(pressed_arrow)
+        local nav_fg_bg = args.nav_fg_bg or e.fg_bg
+        local active_fg_bg = args.nav_active or nav_fg_bg
+
+        -- draw up/down arrows
+        if pressed_arrow == 1 then
+            e.window.setTextColor(active_fg_bg.fgd)
+            e.window.setBackgroundColor(active_fg_bg.bkg)
+            e.window.setCursorPos(e.frame.w, 1)
+            e.window.write("\x1e")
+            e.window.setTextColor(nav_fg_bg.fgd)
+            e.window.setBackgroundColor(nav_fg_bg.bkg)
+            e.window.setCursorPos(e.frame.w, e.frame.h)
+            e.window.write("\x1f")
+        elseif pressed_arrow == -1 then
+            e.window.setTextColor(nav_fg_bg.fgd)
+            e.window.setBackgroundColor(nav_fg_bg.bkg)
+            e.window.setCursorPos(e.frame.w, 1)
+            e.window.write("\x1e")
+            e.window.setTextColor(active_fg_bg.fgd)
+            e.window.setBackgroundColor(active_fg_bg.bkg)
+            e.window.setCursorPos(e.frame.w, e.frame.h)
+            e.window.write("\x1f")
+        else
+            e.window.setTextColor(nav_fg_bg.fgd)
+            e.window.setBackgroundColor(nav_fg_bg.bkg)
+            e.window.setCursorPos(e.frame.w, 1)
+            e.window.write("\x1e")
+            e.window.setCursorPos(e.frame.w, e.frame.h)
+            e.window.write("\x1f")
+        end
+
+        e.window.setTextColor(e.fg_bg.fgd)
+        e.window.setBackgroundColor(e.fg_bg.bkg)
+    end
+
+    -- render the scroll bar and re-cacluate height & bounds
+    local function draw_bar()
+        local offset = 2 + math.abs(scroll_offset)
+
+        bar_height = math.min(max_bar_height + max_down_scroll, max_bar_height)
+
+        if bar_height < 1 then
+            bar_is_scaled = true
+            -- can't do a 1:1 ratio
+            -- use minimum size bar with scaled offset
+            local scroll_progress = scroll_offset / max_down_scroll
+            offset = 2 + math.floor(scroll_progress * (max_bar_height - 1))
+            bar_height = 1
+        else
+            bar_is_scaled = false
+        end
+
+        bar_bounds = { offset, (bar_height + offset) - 1 }
+
+        for i = 2, e.frame.h - 1 do
+            if (i >= offset and i < (bar_height + offset)) and (bar_height ~= max_bar_height) then
+                if args.nav_fg_bg ~= nil then
+                    e.window.setBackgroundColor(args.nav_fg_bg.fgd)
+                else
+                    e.window.setBackgroundColor(e.fg_bg.fgd)
+                end
+            else
+                if args.nav_fg_bg ~= nil then
+                    e.window.setBackgroundColor(args.nav_fg_bg.bkg)
+                else
+                    e.window.setBackgroundColor(e.fg_bg.bkg)
+                end
+            end
+
+            e.window.setCursorPos(e.frame.w, i)
+            e.window.write(" ")
+        end
+
+        e.window.setBackgroundColor(e.fg_bg.bkg)
+    end
+
+    -- update item y positions and move elements
+    local function update_positions()
+        local next_y = 1
+
+        scroll_frame.setVisible(false)
+        scroll_frame.setBackgroundColor(e.fg_bg.bkg)
+        scroll_frame.setTextColor(e.fg_bg.fgd)
+        scroll_frame.clear()
+
+        for i = 1, #list do
+            local item = list[i]    ---@type listbox_item
+            item.y = next_y
+            next_y = next_y + item.h + item_pad
+            item.e.reposition(1, item.y)
+            item.e.show()
+        end
+
+        content_height = next_y
+        max_down_scroll = math.min(-1 * (content_height - (e.frame.h + 1 + item_pad)), 0)
+        if scroll_offset < max_down_scroll then scroll_offset = max_down_scroll end
+
+        scroll_frame.reposition(1, 1 + scroll_offset)
+        scroll_frame.setVisible(true)
+
+        draw_bar()
+    end
+
+    -- determine where to scroll to based on a scrollbar being dragged without a 1:1 relationship
+    ---@param direction -1|1 negative 1 to scroll up by one, positive 1 to scroll down by one
+    local function scaled_bar_scroll(direction)
+        local scroll_progress = scroll_offset / max_down_scroll
+        local bar_position = math.floor(scroll_progress * (max_bar_height - 1))
+
+        -- check what moving the scroll bar up or down would mean for the scroll progress
+        scroll_progress = (bar_position + direction) / (max_bar_height - 1)
+
+        return math.max(math.floor(scroll_progress * max_down_scroll), max_down_scroll)
+    end
+
+    -- scroll down the list
+    local function scroll_down(scaled)
+        if scroll_offset > max_down_scroll then
+            if scaled then
+                scroll_offset = scaled_bar_scroll(1)
+            else
+                scroll_offset = scroll_offset - 1
+            end
+
+            update_positions()
+        end
+    end
+
+    -- scroll up the list
+    local function scroll_up(scaled)
+        if scroll_offset < 0 then
+            if scaled then
+                scroll_offset = scaled_bar_scroll(-1)
+            else
+                scroll_offset = scroll_offset + 1
+            end
+
+            update_positions()
+        end
+    end
+
+    -- handle a child element having been added to the list
+    ---@param id element_id element identifier
+    ---@param child graphics_element child element
+    function e.on_added(id, child)
+        table.insert(list, { id = id, e = child, y = 0, h = child.get_height() })
+        update_positions()
+    end
+
+    -- handle a child element having been removed from the list
+    ---@param id element_id element identifier
+    function e.on_removed(id)
+        for idx, elem in ipairs(list) do
+            if elem.id == id then
+                table.remove(list, idx)
+                update_positions()
+                return
+            end
+        end
+    end
+
+    -- handle mouse interaction
+    ---@param event mouse_interaction mouse event
+    function e.handle_mouse(event)
+        if e.enabled then
+            if event.type == CLICK_TYPE.TAP then
+                if event.current.x == e.frame.w then
+                    if event.current.y == 1 or event.current.y < bar_bounds[1] then
+                        draw_arrows(1)
+                        scroll_up()
+                        if args.nav_active ~= nil then tcd.dispatch(0.25, function () draw_arrows(0) end) end
+                    elseif event.current.y == e.frame.h or event.current.y > bar_bounds[2] then
+                        draw_arrows(-1)
+                        scroll_down()
+                        if args.nav_active ~= nil then tcd.dispatch(0.25, function () draw_arrows(0) end) end
+                    end
+                end
+            elseif event.type == CLICK_TYPE.DOWN then
+                if event.current.x == e.frame.w then
+                    if event.current.y == 1 or event.current.y < bar_bounds[1] then
+                        draw_arrows(1)
+                        scroll_up()
+                    elseif event.current.y == e.frame.h or event.current.y > bar_bounds[2] then
+                        draw_arrows(-1)
+                        scroll_down()
+                    else
+                        -- clicked on bar
+                        holding_bar = true
+                        bar_grip_pos = event.current.y - bar_bounds[1]
+                        mouse_last_y = event.current.y
+                    end
+                end
+            elseif event.type == CLICK_TYPE.UP then
+                holding_bar = false
+                draw_arrows(0)
+            elseif event.type == CLICK_TYPE.DRAG then
+                if holding_bar then
+                    -- if mouse is within vertical frame, including the grip point
+                    if event.current.y > (1 + bar_grip_pos) and event.current.y <= ((e.frame.h - bar_height) + bar_grip_pos) then
+                        if event.current.y < mouse_last_y then
+                            scroll_up(bar_is_scaled)
+                        elseif event.current.y > mouse_last_y then
+                            scroll_down(bar_is_scaled)
+                        end
+
+                        mouse_last_y = event.current.y
+                    end
+                end
+            elseif event.type == CLICK_TYPE.SCROLL_DOWN then
+                scroll_down()
+            elseif event.type == CLICK_TYPE.SCROLL_UP then
+                scroll_up()
+            end
+        end
+    end
+
+    draw_arrows(0)
+    draw_bar()
+
+    return e.complete()
+end
+
+return listbox

graphics/elements/multipane.lua

@@ -12,6 +12,7 @@ local element = require("graphics.element")
 ---@field height? integer parent height if omitted
 ---@field gframe? graphics_frame frame instead of x/y/width/height
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new multipane element
 ---@nodiscard
@@ -36,7 +37,7 @@ local function multipane(args)
 
     e.set_value(1)
 
-    return e.get()
+    return e.complete()
 end
 
 return multipane

graphics/elements/pipenet.lua

@@ -12,6 +12,7 @@ local element = require("graphics.element")
 ---@field id? string element id
 ---@field x? integer 1 if omitted
 ---@field y? integer 1 if omitted
+---@field hidden? boolean true to hide on initial draw
 
 -- new pipe network
 ---@param args pipenet_args
@@ -141,7 +142,7 @@ local function pipenet(args)
 
     end
 
-    return e.get()
+    return e.complete()
 end
 
 return pipenet

graphics/elements/rectangle.lua

@@ -16,6 +16,7 @@ local element = require("graphics.element")
 ---@field height? integer parent height if omitted
 ---@field gframe? graphics_frame frame instead of x/y/width/height
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new rectangle
 ---@param args rectangle_args
@@ -30,27 +31,35 @@ local function rectangle(args)
     end
 
     -- offset children
+    local offset_x = 0
+    local offset_y = 0
     if args.border ~= nil then
-        args.offset_x = args.border.width
+        offset_x = args.border.width
-        args.offset_y = args.border.width
+        offset_y = args.border.width
 
         -- slightly different y offset if the border is set to even
         if args.border.even then
             local width_x2 = (2 * args.border.width)
-            args.offset_y = math.floor(width_x2 / 3) + util.trinary(width_x2 % 3 > 0, 1, 0)
+            offset_y = math.floor(width_x2 / 3) + util.trinary(width_x2 % 3 > 0, 1, 0)
         end
     end
 
     -- create new graphics element base object
-    local e = element.new(args)
+    local e = element.new(args, offset_x, offset_y)
+
+    -- create content window for child elements
+    e.content_window = window.create(e.window, 1 + offset_x, 1 + offset_y, e.frame.w - (2 * offset_x), e.frame.h - (2 * offset_y))
+    e.content_window.setBackgroundColor(e.fg_bg.bkg)
+    e.content_window.setTextColor(e.fg_bg.fgd)
+    e.content_window.clear()
 
     -- draw bordered box if requested
     -- element constructor will have drawn basic colored rectangle regardless
     if args.border ~= nil then
         e.window.setCursorPos(1, 1)
 
-        local border_width = args.offset_x
+        local border_width = offset_x
-        local border_height = args.offset_y
+        local border_height = offset_y
         local border_blit = colors.toBlit(args.border.color)
         local width_x2 = border_width * 2
         local inner_width = e.frame.w - width_x2
@@ -177,7 +186,7 @@ local function rectangle(args)
         end
     end
 
-    return e.get()
+    return e.complete()
 end
 
 return rectangle

graphics/elements/textbox.lua

@@ -18,6 +18,7 @@ local TEXT_ALIGN = core.TEXT_ALIGN
 ---@field height? integer parent height if omitted
 ---@field gframe? graphics_frame frame instead of x/y/width/height
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new text box
 ---@param args textbox_args
@@ -64,7 +65,7 @@ local function textbox(args)
         display_text(val)
     end
 
-    return e.get()
+    return e.complete()
 end
 
 return textbox

graphics/elements/tiling.lua

@@ -16,6 +16,7 @@ local element = require("graphics.element")
 ---@field height? integer parent height if omitted
 ---@field gframe? graphics_frame frame instead of x/y/width/height
 ---@field fg_bg? cpair foreground/background colors
+---@field hidden? boolean true to hide on initial draw
 
 -- new tiling box
 ---@param args tiling_args
@@ -81,7 +82,7 @@ local function tiling(args)
         if inner_width % 2 == 0 then alternator = not alternator end
     end
 
-    return e.get()
+    return e.complete()
 end
 
 return tiling

graphics/flasher.lua

@@ -2,7 +2,7 @@
 -- Indicator Light Flasher
 --
 
-local tcd = require("scada-common.tcallbackdsp")
+local tcd = require("scada-common.tcd")
 
 local flasher = {}
 

imgen.py

@@ -23,11 +23,11 @@ def dir_size(path):
     return total
 
 # get the version of an application at the provided path
-def get_version(path, is_comms = False):
+def get_version(path, is_lib = False):
     ver = ""
-    string = "comms.version = \""
+    string = ".version = \""
 
-    if not is_comms:
+    if not is_lib:
         string = "_VERSION = \""
 
     f = open(path, "r")
@@ -49,6 +49,8 @@ def make_manifest(size):
             "installer" : get_version("./ccmsi.lua"),
             "bootloader" : get_version("./startup.lua"),
             "comms" : get_version("./scada-common/comms.lua", True),
+            "graphics" : get_version("./graphics/core.lua", True),
+            "lockbox" : get_version("./lockbox/init.lua", True),
             "reactor-plc" : get_version("./reactor-plc/startup.lua"),
             "rtu" : get_version("./rtu/startup.lua"),
             "supervisor" : get_version("./supervisor/startup.lua"),
@@ -69,11 +71,11 @@ def make_manifest(size):
             "pocket" : list_files("./pocket"),
         },
         "depends" : {
-            "reactor-plc" : [ "system", "common", "graphics" ],
+            "reactor-plc" : [ "system", "common", "graphics", "lockbox" ],
-            "rtu" : [ "system", "common", "graphics" ],
+            "rtu" : [ "system", "common", "graphics", "lockbox" ],
-            "supervisor" : [ "system", "common" ],
+            "supervisor" : [ "system", "common", "graphics", "lockbox" ],
-            "coordinator" : [ "system", "common", "graphics" ],
+            "coordinator" : [ "system", "common", "graphics", "lockbox" ],
-            "pocket" : [ "system", "common", "graphics" ]
+            "pocket" : [ "system", "common", "graphics", "lockbox" ]
         },
         "sizes" : {
             # manifest file estimate
@@ -111,7 +113,7 @@ f.close()
 if len(sys.argv) > 1 and sys.argv[1] == "shields":
     # write all the JSON files for shields.io
     for key, version in final_manifest["versions"].items():
-        f = open("./shields/" + key + ".json", "w")
+        f = open("./deploy/" + key + ".json", "w")
 
         if version.find("alpha") >= 0:
             color = "yellow"

lockbox/cipher/aes128.lua

@@ -1,415 +0,0 @@
-local Array = require("lockbox.util.array");
-local Bit = require("lockbox.util.bit");
-
-local XOR = Bit.bxor;
-
-local SBOX = {
- [0] = 0x63, 0x7C, 0x77, 0x7B, 0xF2, 0x6B, 0x6F, 0xC5, 0x30, 0x01, 0x67, 0x2B, 0xFE, 0xD7, 0xAB, 0x76,
- 0xCA, 0x82, 0xC9, 0x7D, 0xFA, 0x59, 0x47, 0xF0, 0xAD, 0xD4, 0xA2, 0xAF, 0x9C, 0xA4, 0x72, 0xC0,
- 0xB7, 0xFD, 0x93, 0x26, 0x36, 0x3F, 0xF7, 0xCC, 0x34, 0xA5, 0xE5, 0xF1, 0x71, 0xD8, 0x31, 0x15,
- 0x04, 0xC7, 0x23, 0xC3, 0x18, 0x96, 0x05, 0x9A, 0x07, 0x12, 0x80, 0xE2, 0xEB, 0x27, 0xB2, 0x75,
- 0x09, 0x83, 0x2C, 0x1A, 0x1B, 0x6E, 0x5A, 0xA0, 0x52, 0x3B, 0xD6, 0xB3, 0x29, 0xE3, 0x2F, 0x84,
- 0x53, 0xD1, 0x00, 0xED, 0x20, 0xFC, 0xB1, 0x5B, 0x6A, 0xCB, 0xBE, 0x39, 0x4A, 0x4C, 0x58, 0xCF,
- 0xD0, 0xEF, 0xAA, 0xFB, 0x43, 0x4D, 0x33, 0x85, 0x45, 0xF9, 0x02, 0x7F, 0x50, 0x3C, 0x9F, 0xA8,
- 0x51, 0xA3, 0x40, 0x8F, 0x92, 0x9D, 0x38, 0xF5, 0xBC, 0xB6, 0xDA, 0x21, 0x10, 0xFF, 0xF3, 0xD2,
- 0xCD, 0x0C, 0x13, 0xEC, 0x5F, 0x97, 0x44, 0x17, 0xC4, 0xA7, 0x7E, 0x3D, 0x64, 0x5D, 0x19, 0x73,
- 0x60, 0x81, 0x4F, 0xDC, 0x22, 0x2A, 0x90, 0x88, 0x46, 0xEE, 0xB8, 0x14, 0xDE, 0x5E, 0x0B, 0xDB,
- 0xE0, 0x32, 0x3A, 0x0A, 0x49, 0x06, 0x24, 0x5C, 0xC2, 0xD3, 0xAC, 0x62, 0x91, 0x95, 0xE4, 0x79,
- 0xE7, 0xC8, 0x37, 0x6D, 0x8D, 0xD5, 0x4E, 0xA9, 0x6C, 0x56, 0xF4, 0xEA, 0x65, 0x7A, 0xAE, 0x08,
- 0xBA, 0x78, 0x25, 0x2E, 0x1C, 0xA6, 0xB4, 0xC6, 0xE8, 0xDD, 0x74, 0x1F, 0x4B, 0xBD, 0x8B, 0x8A,
- 0x70, 0x3E, 0xB5, 0x66, 0x48, 0x03, 0xF6, 0x0E, 0x61, 0x35, 0x57, 0xB9, 0x86, 0xC1, 0x1D, 0x9E,
- 0xE1, 0xF8, 0x98, 0x11, 0x69, 0xD9, 0x8E, 0x94, 0x9B, 0x1E, 0x87, 0xE9, 0xCE, 0x55, 0x28, 0xDF,
- 0x8C, 0xA1, 0x89, 0x0D, 0xBF, 0xE6, 0x42, 0x68, 0x41, 0x99, 0x2D, 0x0F, 0xB0, 0x54, 0xBB, 0x16};
-
-local ISBOX = {
- [0] = 0x52, 0x09, 0x6A, 0xD5, 0x30, 0x36, 0xA5, 0x38, 0xBF, 0x40, 0xA3, 0x9E, 0x81, 0xF3, 0xD7, 0xFB,
- 0x7C, 0xE3, 0x39, 0x82, 0x9B, 0x2F, 0xFF, 0x87, 0x34, 0x8E, 0x43, 0x44, 0xC4, 0xDE, 0xE9, 0xCB,
- 0x54, 0x7B, 0x94, 0x32, 0xA6, 0xC2, 0x23, 0x3D, 0xEE, 0x4C, 0x95, 0x0B, 0x42, 0xFA, 0xC3, 0x4E,
- 0x08, 0x2E, 0xA1, 0x66, 0x28, 0xD9, 0x24, 0xB2, 0x76, 0x5B, 0xA2, 0x49, 0x6D, 0x8B, 0xD1, 0x25,
- 0x72, 0xF8, 0xF6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xD4, 0xA4, 0x5C, 0xCC, 0x5D, 0x65, 0xB6, 0x92,
- 0x6C, 0x70, 0x48, 0x50, 0xFD, 0xED, 0xB9, 0xDA, 0x5E, 0x15, 0x46, 0x57, 0xA7, 0x8D, 0x9D, 0x84,
- 0x90, 0xD8, 0xAB, 0x00, 0x8C, 0xBC, 0xD3, 0x0A, 0xF7, 0xE4, 0x58, 0x05, 0xB8, 0xB3, 0x45, 0x06,
- 0xD0, 0x2C, 0x1E, 0x8F, 0xCA, 0x3F, 0x0F, 0x02, 0xC1, 0xAF, 0xBD, 0x03, 0x01, 0x13, 0x8A, 0x6B,
- 0x3A, 0x91, 0x11, 0x41, 0x4F, 0x67, 0xDC, 0xEA, 0x97, 0xF2, 0xCF, 0xCE, 0xF0, 0xB4, 0xE6, 0x73,
- 0x96, 0xAC, 0x74, 0x22, 0xE7, 0xAD, 0x35, 0x85, 0xE2, 0xF9, 0x37, 0xE8, 0x1C, 0x75, 0xDF, 0x6E,
- 0x47, 0xF1, 0x1A, 0x71, 0x1D, 0x29, 0xC5, 0x89, 0x6F, 0xB7, 0x62, 0x0E, 0xAA, 0x18, 0xBE, 0x1B,
- 0xFC, 0x56, 0x3E, 0x4B, 0xC6, 0xD2, 0x79, 0x20, 0x9A, 0xDB, 0xC0, 0xFE, 0x78, 0xCD, 0x5A, 0xF4,
- 0x1F, 0xDD, 0xA8, 0x33, 0x88, 0x07, 0xC7, 0x31, 0xB1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xEC, 0x5F,
- 0x60, 0x51, 0x7F, 0xA9, 0x19, 0xB5, 0x4A, 0x0D, 0x2D, 0xE5, 0x7A, 0x9F, 0x93, 0xC9, 0x9C, 0xEF,
- 0xA0, 0xE0, 0x3B, 0x4D, 0xAE, 0x2A, 0xF5, 0xB0, 0xC8, 0xEB, 0xBB, 0x3C, 0x83, 0x53, 0x99, 0x61,
- 0x17, 0x2B, 0x04, 0x7E, 0xBA, 0x77, 0xD6, 0x26, 0xE1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0C, 0x7D};
-
-local ROW_SHIFT =  {  1,  6, 11, 16,  5, 10, 15,  4,  9, 14,  3,  8, 13,  2,  7, 12, };
-local IROW_SHIFT = {  1, 14, 11,  8,  5,  2, 15, 12,  9,  6,  3, 16, 13, 10,  7,  4, };
-
-local ETABLE = {
- [0] = 0x01, 0x03, 0x05, 0x0F, 0x11, 0x33, 0x55, 0xFF, 0x1A, 0x2E, 0x72, 0x96, 0xA1, 0xF8, 0x13, 0x35,
- 0x5F, 0xE1, 0x38, 0x48, 0xD8, 0x73, 0x95, 0xA4, 0xF7, 0x02, 0x06, 0x0A, 0x1E, 0x22, 0x66, 0xAA,
- 0xE5, 0x34, 0x5C, 0xE4, 0x37, 0x59, 0xEB, 0x26, 0x6A, 0xBE, 0xD9, 0x70, 0x90, 0xAB, 0xE6, 0x31,
- 0x53, 0xF5, 0x04, 0x0C, 0x14, 0x3C, 0x44, 0xCC, 0x4F, 0xD1, 0x68, 0xB8, 0xD3, 0x6E, 0xB2, 0xCD,
- 0x4C, 0xD4, 0x67, 0xA9, 0xE0, 0x3B, 0x4D, 0xD7, 0x62, 0xA6, 0xF1, 0x08, 0x18, 0x28, 0x78, 0x88,
- 0x83, 0x9E, 0xB9, 0xD0, 0x6B, 0xBD, 0xDC, 0x7F, 0x81, 0x98, 0xB3, 0xCE, 0x49, 0xDB, 0x76, 0x9A,
- 0xB5, 0xC4, 0x57, 0xF9, 0x10, 0x30, 0x50, 0xF0, 0x0B, 0x1D, 0x27, 0x69, 0xBB, 0xD6, 0x61, 0xA3,
- 0xFE, 0x19, 0x2B, 0x7D, 0x87, 0x92, 0xAD, 0xEC, 0x2F, 0x71, 0x93, 0xAE, 0xE9, 0x20, 0x60, 0xA0,
- 0xFB, 0x16, 0x3A, 0x4E, 0xD2, 0x6D, 0xB7, 0xC2, 0x5D, 0xE7, 0x32, 0x56, 0xFA, 0x15, 0x3F, 0x41,
- 0xC3, 0x5E, 0xE2, 0x3D, 0x47, 0xC9, 0x40, 0xC0, 0x5B, 0xED, 0x2C, 0x74, 0x9C, 0xBF, 0xDA, 0x75,
- 0x9F, 0xBA, 0xD5, 0x64, 0xAC, 0xEF, 0x2A, 0x7E, 0x82, 0x9D, 0xBC, 0xDF, 0x7A, 0x8E, 0x89, 0x80,
- 0x9B, 0xB6, 0xC1, 0x58, 0xE8, 0x23, 0x65, 0xAF, 0xEA, 0x25, 0x6F, 0xB1, 0xC8, 0x43, 0xC5, 0x54,
- 0xFC, 0x1F, 0x21, 0x63, 0xA5, 0xF4, 0x07, 0x09, 0x1B, 0x2D, 0x77, 0x99, 0xB0, 0xCB, 0x46, 0xCA,
- 0x45, 0xCF, 0x4A, 0xDE, 0x79, 0x8B, 0x86, 0x91, 0xA8, 0xE3, 0x3E, 0x42, 0xC6, 0x51, 0xF3, 0x0E,
- 0x12, 0x36, 0x5A, 0xEE, 0x29, 0x7B, 0x8D, 0x8C, 0x8F, 0x8A, 0x85, 0x94, 0xA7, 0xF2, 0x0D, 0x17,
- 0x39, 0x4B, 0xDD, 0x7C, 0x84, 0x97, 0xA2, 0xFD, 0x1C, 0x24, 0x6C, 0xB4, 0xC7, 0x52, 0xF6, 0x01};
-
-local LTABLE = {
- [0] = 0x00, 0x00, 0x19, 0x01, 0x32, 0x02, 0x1A, 0xC6, 0x4B, 0xC7, 0x1B, 0x68, 0x33, 0xEE, 0xDF, 0x03,
- 0x64, 0x04, 0xE0, 0x0E, 0x34, 0x8D, 0x81, 0xEF, 0x4C, 0x71, 0x08, 0xC8, 0xF8, 0x69, 0x1C, 0xC1,
- 0x7D, 0xC2, 0x1D, 0xB5, 0xF9, 0xB9, 0x27, 0x6A, 0x4D, 0xE4, 0xA6, 0x72, 0x9A, 0xC9, 0x09, 0x78,
- 0x65, 0x2F, 0x8A, 0x05, 0x21, 0x0F, 0xE1, 0x24, 0x12, 0xF0, 0x82, 0x45, 0x35, 0x93, 0xDA, 0x8E,
- 0x96, 0x8F, 0xDB, 0xBD, 0x36, 0xD0, 0xCE, 0x94, 0x13, 0x5C, 0xD2, 0xF1, 0x40, 0x46, 0x83, 0x38,
- 0x66, 0xDD, 0xFD, 0x30, 0xBF, 0x06, 0x8B, 0x62, 0xB3, 0x25, 0xE2, 0x98, 0x22, 0x88, 0x91, 0x10,
- 0x7E, 0x6E, 0x48, 0xC3, 0xA3, 0xB6, 0x1E, 0x42, 0x3A, 0x6B, 0x28, 0x54, 0xFA, 0x85, 0x3D, 0xBA,
- 0x2B, 0x79, 0x0A, 0x15, 0x9B, 0x9F, 0x5E, 0xCA, 0x4E, 0xD4, 0xAC, 0xE5, 0xF3, 0x73, 0xA7, 0x57,
- 0xAF, 0x58, 0xA8, 0x50, 0xF4, 0xEA, 0xD6, 0x74, 0x4F, 0xAE, 0xE9, 0xD5, 0xE7, 0xE6, 0xAD, 0xE8,
- 0x2C, 0xD7, 0x75, 0x7A, 0xEB, 0x16, 0x0B, 0xF5, 0x59, 0xCB, 0x5F, 0xB0, 0x9C, 0xA9, 0x51, 0xA0,
- 0x7F, 0x0C, 0xF6, 0x6F, 0x17, 0xC4, 0x49, 0xEC, 0xD8, 0x43, 0x1F, 0x2D, 0xA4, 0x76, 0x7B, 0xB7,
- 0xCC, 0xBB, 0x3E, 0x5A, 0xFB, 0x60, 0xB1, 0x86, 0x3B, 0x52, 0xA1, 0x6C, 0xAA, 0x55, 0x29, 0x9D,
- 0x97, 0xB2, 0x87, 0x90, 0x61, 0xBE, 0xDC, 0xFC, 0xBC, 0x95, 0xCF, 0xCD, 0x37, 0x3F, 0x5B, 0xD1,
- 0x53, 0x39, 0x84, 0x3C, 0x41, 0xA2, 0x6D, 0x47, 0x14, 0x2A, 0x9E, 0x5D, 0x56, 0xF2, 0xD3, 0xAB,
- 0x44, 0x11, 0x92, 0xD9, 0x23, 0x20, 0x2E, 0x89, 0xB4, 0x7C, 0xB8, 0x26, 0x77, 0x99, 0xE3, 0xA5,
- 0x67, 0x4A, 0xED, 0xDE, 0xC5, 0x31, 0xFE, 0x18, 0x0D, 0x63, 0x8C, 0x80, 0xC0, 0xF7, 0x70, 0x07};
-
-local MIXTABLE = {
- 0x02, 0x03, 0x01, 0x01,
- 0x01, 0x02, 0x03, 0x01,
- 0x01, 0x01, 0x02, 0x03,
- 0x03, 0x01, 0x01, 0x02};
-
-local IMIXTABLE = {
- 0x0E, 0x0B, 0x0D, 0x09,
- 0x09, 0x0E, 0x0B, 0x0D,
- 0x0D, 0x09, 0x0E, 0x0B,
- 0x0B, 0x0D, 0x09, 0x0E};
-
-local RCON = {
-[0] = 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a,
-0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39,
-0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a,
-0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8,
-0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef,
-0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc,
-0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b,
-0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3,
-0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94,
-0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20,
-0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35,
-0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f,
-0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04,
-0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63,
-0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd,
-0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d};
-
-
-local GMUL = function(A, B)
-    if(A == 0x01) then return B; end
-    if(B == 0x01) then return A; end
-    if(A == 0x00) then return 0; end
-    if(B == 0x00) then return 0; end
-
-    local LA = LTABLE[A];
-    local LB = LTABLE[B];
-
-    local sum = LA + LB;
-    if (sum > 0xFF) then sum = sum - 0xFF; end
-
-    return ETABLE[sum];
-end
-
-local byteSub = Array.substitute;
-
-local shiftRow = Array.permute;
-
-local mixCol = function(i, mix)
-    local out = {};
-
-    local a, b, c, d;
-
-    a = GMUL(i[ 1], mix[ 1]);
-    b = GMUL(i[ 2], mix[ 2]);
-    c = GMUL(i[ 3], mix[ 3]);
-    d = GMUL(i[ 4], mix[ 4]);
-    out[ 1] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 1], mix[ 5]);
-    b = GMUL(i[ 2], mix[ 6]);
-    c = GMUL(i[ 3], mix[ 7]);
-    d = GMUL(i[ 4], mix[ 8]);
-    out[ 2] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 1], mix[ 9]);
-    b = GMUL(i[ 2], mix[10]);
-    c = GMUL(i[ 3], mix[11]);
-    d = GMUL(i[ 4], mix[12]);
-    out[ 3] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 1], mix[13]);
-    b = GMUL(i[ 2], mix[14]);
-    c = GMUL(i[ 3], mix[15]);
-    d = GMUL(i[ 4], mix[16]);
-    out[ 4] = XOR(XOR(a, b), XOR(c, d));
-
-
-    a = GMUL(i[ 5], mix[ 1]);
-    b = GMUL(i[ 6], mix[ 2]);
-    c = GMUL(i[ 7], mix[ 3]);
-    d = GMUL(i[ 8], mix[ 4]);
-    out[ 5] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 5], mix[ 5]);
-    b = GMUL(i[ 6], mix[ 6]);
-    c = GMUL(i[ 7], mix[ 7]);
-    d = GMUL(i[ 8], mix[ 8]);
-    out[ 6] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 5], mix[ 9]);
-    b = GMUL(i[ 6], mix[10]);
-    c = GMUL(i[ 7], mix[11]);
-    d = GMUL(i[ 8], mix[12]);
-    out[ 7] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 5], mix[13]);
-    b = GMUL(i[ 6], mix[14]);
-    c = GMUL(i[ 7], mix[15]);
-    d = GMUL(i[ 8], mix[16]);
-    out[ 8] = XOR(XOR(a, b), XOR(c, d));
-
-
-    a = GMUL(i[ 9], mix[ 1]);
-    b = GMUL(i[10], mix[ 2]);
-    c = GMUL(i[11], mix[ 3]);
-    d = GMUL(i[12], mix[ 4]);
-    out[ 9] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 9], mix[ 5]);
-    b = GMUL(i[10], mix[ 6]);
-    c = GMUL(i[11], mix[ 7]);
-    d = GMUL(i[12], mix[ 8]);
-    out[10] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 9], mix[ 9]);
-    b = GMUL(i[10], mix[10]);
-    c = GMUL(i[11], mix[11]);
-    d = GMUL(i[12], mix[12]);
-    out[11] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 9], mix[13]);
-    b = GMUL(i[10], mix[14]);
-    c = GMUL(i[11], mix[15]);
-    d = GMUL(i[12], mix[16]);
-    out[12] = XOR(XOR(a, b), XOR(c, d));
-
-
-    a = GMUL(i[13], mix[ 1]);
-    b = GMUL(i[14], mix[ 2]);
-    c = GMUL(i[15], mix[ 3]);
-    d = GMUL(i[16], mix[ 4]);
-    out[13] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[13], mix[ 5]);
-    b = GMUL(i[14], mix[ 6]);
-    c = GMUL(i[15], mix[ 7]);
-    d = GMUL(i[16], mix[ 8]);
-    out[14] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[13], mix[ 9]);
-    b = GMUL(i[14], mix[10]);
-    c = GMUL(i[15], mix[11]);
-    d = GMUL(i[16], mix[12]);
-    out[15] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[13], mix[13]);
-    b = GMUL(i[14], mix[14]);
-    c = GMUL(i[15], mix[15]);
-    d = GMUL(i[16], mix[16]);
-    out[16] = XOR(XOR(a, b), XOR(c, d));
-
-    return out;
-end
-
-local keyRound = function(key, round)
-    local out = {};
-
-    out[ 1] = XOR(key[ 1], XOR(SBOX[key[14]], RCON[round]));
-    out[ 2] = XOR(key[ 2], SBOX[key[15]]);
-    out[ 3] = XOR(key[ 3], SBOX[key[16]]);
-    out[ 4] = XOR(key[ 4], SBOX[key[13]]);
-
-    out[ 5] = XOR(out[ 1], key[ 5]);
-    out[ 6] = XOR(out[ 2], key[ 6]);
-    out[ 7] = XOR(out[ 3], key[ 7]);
-    out[ 8] = XOR(out[ 4], key[ 8]);
-
-    out[ 9] = XOR(out[ 5], key[ 9]);
-    out[10] = XOR(out[ 6], key[10]);
-    out[11] = XOR(out[ 7], key[11]);
-    out[12] = XOR(out[ 8], key[12]);
-
-    out[13] = XOR(out[ 9], key[13]);
-    out[14] = XOR(out[10], key[14]);
-    out[15] = XOR(out[11], key[15]);
-    out[16] = XOR(out[12], key[16]);
-
-    return out;
-end
-
-local keyExpand = function(key)
-    local keys = {};
-
-    local temp = key;
-
-    keys[1] = temp;
-
-    for i = 1, 10 do
-        temp = keyRound(temp, i);
-        keys[i + 1] = temp;
-    end
-
-    return keys;
-
-end
-
-local addKey = Array.XOR;
-
-
-
-local AES = {};
-
-AES.blockSize = 16;
-
-AES.encrypt = function(_key, block)
-
-    local key = keyExpand(_key);
-
-    --round 0
-    block = addKey(block, key[1]);
-
-    --round 1
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[2]);
-
-    --round 2
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[3]);
-
-    --round 3
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[4]);
-
-    --round 4
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[5]);
-
-    --round 5
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[6]);
-
-    --round 6
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[7]);
-
-    --round 7
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[8]);
-
-    --round 8
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[9]);
-
-    --round 9
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[10]);
-
-    --round 10
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = addKey(block, key[11]);
-
-    return block;
-
-end
-
-AES.decrypt = function(_key, block)
-
-    local key = keyExpand(_key);
-
-    --round 0
-    block = addKey(block, key[11]);
-
-    --round 1
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[10]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 2
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[9]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 3
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[8]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 4
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[7]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 5
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[6]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 6
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[5]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 7
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[4]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 8
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[3]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 9
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[2]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 10
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[1]);
-
-    return block;
-end
-
-return AES;

lockbox/cipher/aes192.lua

@@ -1,462 +0,0 @@
-
-local Array = require("lockbox.util.array");
-local Bit = require("lockbox.util.bit");
-
-local XOR = Bit.bxor;
-
-local SBOX = {
- [0] = 0x63, 0x7C, 0x77, 0x7B, 0xF2, 0x6B, 0x6F, 0xC5, 0x30, 0x01, 0x67, 0x2B, 0xFE, 0xD7, 0xAB, 0x76,
- 0xCA, 0x82, 0xC9, 0x7D, 0xFA, 0x59, 0x47, 0xF0, 0xAD, 0xD4, 0xA2, 0xAF, 0x9C, 0xA4, 0x72, 0xC0,
- 0xB7, 0xFD, 0x93, 0x26, 0x36, 0x3F, 0xF7, 0xCC, 0x34, 0xA5, 0xE5, 0xF1, 0x71, 0xD8, 0x31, 0x15,
- 0x04, 0xC7, 0x23, 0xC3, 0x18, 0x96, 0x05, 0x9A, 0x07, 0x12, 0x80, 0xE2, 0xEB, 0x27, 0xB2, 0x75,
- 0x09, 0x83, 0x2C, 0x1A, 0x1B, 0x6E, 0x5A, 0xA0, 0x52, 0x3B, 0xD6, 0xB3, 0x29, 0xE3, 0x2F, 0x84,
- 0x53, 0xD1, 0x00, 0xED, 0x20, 0xFC, 0xB1, 0x5B, 0x6A, 0xCB, 0xBE, 0x39, 0x4A, 0x4C, 0x58, 0xCF,
- 0xD0, 0xEF, 0xAA, 0xFB, 0x43, 0x4D, 0x33, 0x85, 0x45, 0xF9, 0x02, 0x7F, 0x50, 0x3C, 0x9F, 0xA8,
- 0x51, 0xA3, 0x40, 0x8F, 0x92, 0x9D, 0x38, 0xF5, 0xBC, 0xB6, 0xDA, 0x21, 0x10, 0xFF, 0xF3, 0xD2,
- 0xCD, 0x0C, 0x13, 0xEC, 0x5F, 0x97, 0x44, 0x17, 0xC4, 0xA7, 0x7E, 0x3D, 0x64, 0x5D, 0x19, 0x73,
- 0x60, 0x81, 0x4F, 0xDC, 0x22, 0x2A, 0x90, 0x88, 0x46, 0xEE, 0xB8, 0x14, 0xDE, 0x5E, 0x0B, 0xDB,
- 0xE0, 0x32, 0x3A, 0x0A, 0x49, 0x06, 0x24, 0x5C, 0xC2, 0xD3, 0xAC, 0x62, 0x91, 0x95, 0xE4, 0x79,
- 0xE7, 0xC8, 0x37, 0x6D, 0x8D, 0xD5, 0x4E, 0xA9, 0x6C, 0x56, 0xF4, 0xEA, 0x65, 0x7A, 0xAE, 0x08,
- 0xBA, 0x78, 0x25, 0x2E, 0x1C, 0xA6, 0xB4, 0xC6, 0xE8, 0xDD, 0x74, 0x1F, 0x4B, 0xBD, 0x8B, 0x8A,
- 0x70, 0x3E, 0xB5, 0x66, 0x48, 0x03, 0xF6, 0x0E, 0x61, 0x35, 0x57, 0xB9, 0x86, 0xC1, 0x1D, 0x9E,
- 0xE1, 0xF8, 0x98, 0x11, 0x69, 0xD9, 0x8E, 0x94, 0x9B, 0x1E, 0x87, 0xE9, 0xCE, 0x55, 0x28, 0xDF,
- 0x8C, 0xA1, 0x89, 0x0D, 0xBF, 0xE6, 0x42, 0x68, 0x41, 0x99, 0x2D, 0x0F, 0xB0, 0x54, 0xBB, 0x16};
-
-local ISBOX = {
- [0] = 0x52, 0x09, 0x6A, 0xD5, 0x30, 0x36, 0xA5, 0x38, 0xBF, 0x40, 0xA3, 0x9E, 0x81, 0xF3, 0xD7, 0xFB,
- 0x7C, 0xE3, 0x39, 0x82, 0x9B, 0x2F, 0xFF, 0x87, 0x34, 0x8E, 0x43, 0x44, 0xC4, 0xDE, 0xE9, 0xCB,
- 0x54, 0x7B, 0x94, 0x32, 0xA6, 0xC2, 0x23, 0x3D, 0xEE, 0x4C, 0x95, 0x0B, 0x42, 0xFA, 0xC3, 0x4E,
- 0x08, 0x2E, 0xA1, 0x66, 0x28, 0xD9, 0x24, 0xB2, 0x76, 0x5B, 0xA2, 0x49, 0x6D, 0x8B, 0xD1, 0x25,
- 0x72, 0xF8, 0xF6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xD4, 0xA4, 0x5C, 0xCC, 0x5D, 0x65, 0xB6, 0x92,
- 0x6C, 0x70, 0x48, 0x50, 0xFD, 0xED, 0xB9, 0xDA, 0x5E, 0x15, 0x46, 0x57, 0xA7, 0x8D, 0x9D, 0x84,
- 0x90, 0xD8, 0xAB, 0x00, 0x8C, 0xBC, 0xD3, 0x0A, 0xF7, 0xE4, 0x58, 0x05, 0xB8, 0xB3, 0x45, 0x06,
- 0xD0, 0x2C, 0x1E, 0x8F, 0xCA, 0x3F, 0x0F, 0x02, 0xC1, 0xAF, 0xBD, 0x03, 0x01, 0x13, 0x8A, 0x6B,
- 0x3A, 0x91, 0x11, 0x41, 0x4F, 0x67, 0xDC, 0xEA, 0x97, 0xF2, 0xCF, 0xCE, 0xF0, 0xB4, 0xE6, 0x73,
- 0x96, 0xAC, 0x74, 0x22, 0xE7, 0xAD, 0x35, 0x85, 0xE2, 0xF9, 0x37, 0xE8, 0x1C, 0x75, 0xDF, 0x6E,
- 0x47, 0xF1, 0x1A, 0x71, 0x1D, 0x29, 0xC5, 0x89, 0x6F, 0xB7, 0x62, 0x0E, 0xAA, 0x18, 0xBE, 0x1B,
- 0xFC, 0x56, 0x3E, 0x4B, 0xC6, 0xD2, 0x79, 0x20, 0x9A, 0xDB, 0xC0, 0xFE, 0x78, 0xCD, 0x5A, 0xF4,
- 0x1F, 0xDD, 0xA8, 0x33, 0x88, 0x07, 0xC7, 0x31, 0xB1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xEC, 0x5F,
- 0x60, 0x51, 0x7F, 0xA9, 0x19, 0xB5, 0x4A, 0x0D, 0x2D, 0xE5, 0x7A, 0x9F, 0x93, 0xC9, 0x9C, 0xEF,
- 0xA0, 0xE0, 0x3B, 0x4D, 0xAE, 0x2A, 0xF5, 0xB0, 0xC8, 0xEB, 0xBB, 0x3C, 0x83, 0x53, 0x99, 0x61,
- 0x17, 0x2B, 0x04, 0x7E, 0xBA, 0x77, 0xD6, 0x26, 0xE1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0C, 0x7D};
-
-local ROW_SHIFT =  {  1,  6, 11, 16,  5, 10, 15,  4,  9, 14,  3,  8, 13,  2,  7, 12, };
-local IROW_SHIFT = {  1, 14, 11,  8,  5,  2, 15, 12,  9,  6,  3, 16, 13, 10,  7,  4, };
-
-local ETABLE = {
- [0] = 0x01, 0x03, 0x05, 0x0F, 0x11, 0x33, 0x55, 0xFF, 0x1A, 0x2E, 0x72, 0x96, 0xA1, 0xF8, 0x13, 0x35,
- 0x5F, 0xE1, 0x38, 0x48, 0xD8, 0x73, 0x95, 0xA4, 0xF7, 0x02, 0x06, 0x0A, 0x1E, 0x22, 0x66, 0xAA,
- 0xE5, 0x34, 0x5C, 0xE4, 0x37, 0x59, 0xEB, 0x26, 0x6A, 0xBE, 0xD9, 0x70, 0x90, 0xAB, 0xE6, 0x31,
- 0x53, 0xF5, 0x04, 0x0C, 0x14, 0x3C, 0x44, 0xCC, 0x4F, 0xD1, 0x68, 0xB8, 0xD3, 0x6E, 0xB2, 0xCD,
- 0x4C, 0xD4, 0x67, 0xA9, 0xE0, 0x3B, 0x4D, 0xD7, 0x62, 0xA6, 0xF1, 0x08, 0x18, 0x28, 0x78, 0x88,
- 0x83, 0x9E, 0xB9, 0xD0, 0x6B, 0xBD, 0xDC, 0x7F, 0x81, 0x98, 0xB3, 0xCE, 0x49, 0xDB, 0x76, 0x9A,
- 0xB5, 0xC4, 0x57, 0xF9, 0x10, 0x30, 0x50, 0xF0, 0x0B, 0x1D, 0x27, 0x69, 0xBB, 0xD6, 0x61, 0xA3,
- 0xFE, 0x19, 0x2B, 0x7D, 0x87, 0x92, 0xAD, 0xEC, 0x2F, 0x71, 0x93, 0xAE, 0xE9, 0x20, 0x60, 0xA0,
- 0xFB, 0x16, 0x3A, 0x4E, 0xD2, 0x6D, 0xB7, 0xC2, 0x5D, 0xE7, 0x32, 0x56, 0xFA, 0x15, 0x3F, 0x41,
- 0xC3, 0x5E, 0xE2, 0x3D, 0x47, 0xC9, 0x40, 0xC0, 0x5B, 0xED, 0x2C, 0x74, 0x9C, 0xBF, 0xDA, 0x75,
- 0x9F, 0xBA, 0xD5, 0x64, 0xAC, 0xEF, 0x2A, 0x7E, 0x82, 0x9D, 0xBC, 0xDF, 0x7A, 0x8E, 0x89, 0x80,
- 0x9B, 0xB6, 0xC1, 0x58, 0xE8, 0x23, 0x65, 0xAF, 0xEA, 0x25, 0x6F, 0xB1, 0xC8, 0x43, 0xC5, 0x54,
- 0xFC, 0x1F, 0x21, 0x63, 0xA5, 0xF4, 0x07, 0x09, 0x1B, 0x2D, 0x77, 0x99, 0xB0, 0xCB, 0x46, 0xCA,
- 0x45, 0xCF, 0x4A, 0xDE, 0x79, 0x8B, 0x86, 0x91, 0xA8, 0xE3, 0x3E, 0x42, 0xC6, 0x51, 0xF3, 0x0E,
- 0x12, 0x36, 0x5A, 0xEE, 0x29, 0x7B, 0x8D, 0x8C, 0x8F, 0x8A, 0x85, 0x94, 0xA7, 0xF2, 0x0D, 0x17,
- 0x39, 0x4B, 0xDD, 0x7C, 0x84, 0x97, 0xA2, 0xFD, 0x1C, 0x24, 0x6C, 0xB4, 0xC7, 0x52, 0xF6, 0x01};
-
-local LTABLE = {
- [0] = 0x00, 0x00, 0x19, 0x01, 0x32, 0x02, 0x1A, 0xC6, 0x4B, 0xC7, 0x1B, 0x68, 0x33, 0xEE, 0xDF, 0x03,
- 0x64, 0x04, 0xE0, 0x0E, 0x34, 0x8D, 0x81, 0xEF, 0x4C, 0x71, 0x08, 0xC8, 0xF8, 0x69, 0x1C, 0xC1,
- 0x7D, 0xC2, 0x1D, 0xB5, 0xF9, 0xB9, 0x27, 0x6A, 0x4D, 0xE4, 0xA6, 0x72, 0x9A, 0xC9, 0x09, 0x78,
- 0x65, 0x2F, 0x8A, 0x05, 0x21, 0x0F, 0xE1, 0x24, 0x12, 0xF0, 0x82, 0x45, 0x35, 0x93, 0xDA, 0x8E,
- 0x96, 0x8F, 0xDB, 0xBD, 0x36, 0xD0, 0xCE, 0x94, 0x13, 0x5C, 0xD2, 0xF1, 0x40, 0x46, 0x83, 0x38,
- 0x66, 0xDD, 0xFD, 0x30, 0xBF, 0x06, 0x8B, 0x62, 0xB3, 0x25, 0xE2, 0x98, 0x22, 0x88, 0x91, 0x10,
- 0x7E, 0x6E, 0x48, 0xC3, 0xA3, 0xB6, 0x1E, 0x42, 0x3A, 0x6B, 0x28, 0x54, 0xFA, 0x85, 0x3D, 0xBA,
- 0x2B, 0x79, 0x0A, 0x15, 0x9B, 0x9F, 0x5E, 0xCA, 0x4E, 0xD4, 0xAC, 0xE5, 0xF3, 0x73, 0xA7, 0x57,
- 0xAF, 0x58, 0xA8, 0x50, 0xF4, 0xEA, 0xD6, 0x74, 0x4F, 0xAE, 0xE9, 0xD5, 0xE7, 0xE6, 0xAD, 0xE8,
- 0x2C, 0xD7, 0x75, 0x7A, 0xEB, 0x16, 0x0B, 0xF5, 0x59, 0xCB, 0x5F, 0xB0, 0x9C, 0xA9, 0x51, 0xA0,
- 0x7F, 0x0C, 0xF6, 0x6F, 0x17, 0xC4, 0x49, 0xEC, 0xD8, 0x43, 0x1F, 0x2D, 0xA4, 0x76, 0x7B, 0xB7,
- 0xCC, 0xBB, 0x3E, 0x5A, 0xFB, 0x60, 0xB1, 0x86, 0x3B, 0x52, 0xA1, 0x6C, 0xAA, 0x55, 0x29, 0x9D,
- 0x97, 0xB2, 0x87, 0x90, 0x61, 0xBE, 0xDC, 0xFC, 0xBC, 0x95, 0xCF, 0xCD, 0x37, 0x3F, 0x5B, 0xD1,
- 0x53, 0x39, 0x84, 0x3C, 0x41, 0xA2, 0x6D, 0x47, 0x14, 0x2A, 0x9E, 0x5D, 0x56, 0xF2, 0xD3, 0xAB,
- 0x44, 0x11, 0x92, 0xD9, 0x23, 0x20, 0x2E, 0x89, 0xB4, 0x7C, 0xB8, 0x26, 0x77, 0x99, 0xE3, 0xA5,
- 0x67, 0x4A, 0xED, 0xDE, 0xC5, 0x31, 0xFE, 0x18, 0x0D, 0x63, 0x8C, 0x80, 0xC0, 0xF7, 0x70, 0x07};
-
-local MIXTABLE = {
- 0x02, 0x03, 0x01, 0x01,
- 0x01, 0x02, 0x03, 0x01,
- 0x01, 0x01, 0x02, 0x03,
- 0x03, 0x01, 0x01, 0x02};
-
-local IMIXTABLE = {
- 0x0E, 0x0B, 0x0D, 0x09,
- 0x09, 0x0E, 0x0B, 0x0D,
- 0x0D, 0x09, 0x0E, 0x0B,
- 0x0B, 0x0D, 0x09, 0x0E};
-
-local RCON = {
-[0] = 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a,
-0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39,
-0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a,
-0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8,
-0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef,
-0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc,
-0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b,
-0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3,
-0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94,
-0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20,
-0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35,
-0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f,
-0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04,
-0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63,
-0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd,
-0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d};
-
-
-local GMUL = function(A, B)
-    if(A == 0x01) then return B; end
-    if(B == 0x01) then return A; end
-    if(A == 0x00) then return 0; end
-    if(B == 0x00) then return 0; end
-
-    local LA = LTABLE[A];
-    local LB = LTABLE[B];
-
-    local sum = LA + LB;
-    if (sum > 0xFF) then sum = sum - 0xFF; end
-
-    return ETABLE[sum];
-end
-
-local byteSub = Array.substitute;
-
-local shiftRow = Array.permute;
-
-local mixCol = function(i, mix)
-    local out = {};
-
-    local a, b, c, d;
-
-    a = GMUL(i[ 1], mix[ 1]);
-    b = GMUL(i[ 2], mix[ 2]);
-    c = GMUL(i[ 3], mix[ 3]);
-    d = GMUL(i[ 4], mix[ 4]);
-    out[ 1] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 1], mix[ 5]);
-    b = GMUL(i[ 2], mix[ 6]);
-    c = GMUL(i[ 3], mix[ 7]);
-    d = GMUL(i[ 4], mix[ 8]);
-    out[ 2] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 1], mix[ 9]);
-    b = GMUL(i[ 2], mix[10]);
-    c = GMUL(i[ 3], mix[11]);
-    d = GMUL(i[ 4], mix[12]);
-    out[ 3] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 1], mix[13]);
-    b = GMUL(i[ 2], mix[14]);
-    c = GMUL(i[ 3], mix[15]);
-    d = GMUL(i[ 4], mix[16]);
-    out[ 4] = XOR(XOR(a, b), XOR(c, d));
-
-
-    a = GMUL(i[ 5], mix[ 1]);
-    b = GMUL(i[ 6], mix[ 2]);
-    c = GMUL(i[ 7], mix[ 3]);
-    d = GMUL(i[ 8], mix[ 4]);
-    out[ 5] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 5], mix[ 5]);
-    b = GMUL(i[ 6], mix[ 6]);
-    c = GMUL(i[ 7], mix[ 7]);
-    d = GMUL(i[ 8], mix[ 8]);
-    out[ 6] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 5], mix[ 9]);
-    b = GMUL(i[ 6], mix[10]);
-    c = GMUL(i[ 7], mix[11]);
-    d = GMUL(i[ 8], mix[12]);
-    out[ 7] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 5], mix[13]);
-    b = GMUL(i[ 6], mix[14]);
-    c = GMUL(i[ 7], mix[15]);
-    d = GMUL(i[ 8], mix[16]);
-    out[ 8] = XOR(XOR(a, b), XOR(c, d));
-
-
-    a = GMUL(i[ 9], mix[ 1]);
-    b = GMUL(i[10], mix[ 2]);
-    c = GMUL(i[11], mix[ 3]);
-    d = GMUL(i[12], mix[ 4]);
-    out[ 9] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 9], mix[ 5]);
-    b = GMUL(i[10], mix[ 6]);
-    c = GMUL(i[11], mix[ 7]);
-    d = GMUL(i[12], mix[ 8]);
-    out[10] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 9], mix[ 9]);
-    b = GMUL(i[10], mix[10]);
-    c = GMUL(i[11], mix[11]);
-    d = GMUL(i[12], mix[12]);
-    out[11] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 9], mix[13]);
-    b = GMUL(i[10], mix[14]);
-    c = GMUL(i[11], mix[15]);
-    d = GMUL(i[12], mix[16]);
-    out[12] = XOR(XOR(a, b), XOR(c, d));
-
-
-    a = GMUL(i[13], mix[ 1]);
-    b = GMUL(i[14], mix[ 2]);
-    c = GMUL(i[15], mix[ 3]);
-    d = GMUL(i[16], mix[ 4]);
-    out[13] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[13], mix[ 5]);
-    b = GMUL(i[14], mix[ 6]);
-    c = GMUL(i[15], mix[ 7]);
-    d = GMUL(i[16], mix[ 8]);
-    out[14] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[13], mix[ 9]);
-    b = GMUL(i[14], mix[10]);
-    c = GMUL(i[15], mix[11]);
-    d = GMUL(i[16], mix[12]);
-    out[15] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[13], mix[13]);
-    b = GMUL(i[14], mix[14]);
-    c = GMUL(i[15], mix[15]);
-    d = GMUL(i[16], mix[16]);
-    out[16] = XOR(XOR(a, b), XOR(c, d));
-
-    return out;
-end
-
-local keyRound = function(key, round)
-    local i = (round - 1) * 24;
-    local out = key;
-
-    out[25 + i] = XOR(key[ 1 + i], XOR(SBOX[key[22 + i]], RCON[round]));
-    out[26 + i] = XOR(key[ 2 + i], SBOX[key[23 + i]]);
-    out[27 + i] = XOR(key[ 3 + i], SBOX[key[24 + i]]);
-    out[28 + i] = XOR(key[ 4 + i], SBOX[key[21 + i]]);
-
-    out[29 + i] = XOR(out[25 + i], key[ 5 + i]);
-    out[30 + i] = XOR(out[26 + i], key[ 6 + i]);
-    out[31 + i] = XOR(out[27 + i], key[ 7 + i]);
-    out[32 + i] = XOR(out[28 + i], key[ 8 + i]);
-
-    out[33 + i] = XOR(out[29 + i], key[ 9 + i]);
-    out[34 + i] = XOR(out[30 + i], key[10 + i]);
-    out[35 + i] = XOR(out[31 + i], key[11 + i]);
-    out[36 + i] = XOR(out[32 + i], key[12 + i]);
-
-    out[37 + i] = XOR(out[33 + i], key[13 + i]);
-    out[38 + i] = XOR(out[34 + i], key[14 + i]);
-    out[39 + i] = XOR(out[35 + i], key[15 + i]);
-    out[40 + i] = XOR(out[36 + i], key[16 + i]);
-
-    out[41 + i] = XOR(out[37 + i], key[17 + i]);
-    out[42 + i] = XOR(out[38 + i], key[18 + i]);
-    out[43 + i] = XOR(out[39 + i], key[19 + i]);
-    out[44 + i] = XOR(out[40 + i], key[20 + i]);
-
-    out[45 + i] = XOR(out[41 + i], key[21 + i]);
-    out[46 + i] = XOR(out[42 + i], key[22 + i]);
-    out[47 + i] = XOR(out[43 + i], key[23 + i]);
-    out[48 + i] = XOR(out[44 + i], key[24 + i]);
-
-    return out;
-end
-
-local keyExpand = function(key)
-    local bytes = Array.copy(key);
-
-    for i = 1, 8 do
-        keyRound(bytes, i);
-    end
-
-    local keys = {};
-
-    keys[ 1] = Array.slice(bytes, 1, 16);
-    keys[ 2] = Array.slice(bytes, 17, 32);
-    keys[ 3] = Array.slice(bytes, 33, 48);
-    keys[ 4] = Array.slice(bytes, 49, 64);
-    keys[ 5] = Array.slice(bytes, 65, 80);
-    keys[ 6] = Array.slice(bytes, 81, 96);
-    keys[ 7] = Array.slice(bytes, 97, 112);
-    keys[ 8] = Array.slice(bytes, 113, 128);
-    keys[ 9] = Array.slice(bytes, 129, 144);
-    keys[10] = Array.slice(bytes, 145, 160);
-    keys[11] = Array.slice(bytes, 161, 176);
-    keys[12] = Array.slice(bytes, 177, 192);
-    keys[13] = Array.slice(bytes, 193, 208);
-
-    return keys;
-
-end
-
-local addKey = Array.XOR;
-
-
-
-local AES = {};
-
-AES.blockSize = 16;
-
-AES.encrypt = function(_key, block)
-
-    local key = keyExpand(_key);
-
-    --round 0
-    block = addKey(block, key[1]);
-
-    --round 1
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[2]);
-
-    --round 2
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[3]);
-
-    --round 3
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[4]);
-
-    --round 4
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[5]);
-
-    --round 5
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[6]);
-
-    --round 6
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[7]);
-
-    --round 7
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[8]);
-
-    --round 8
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[9]);
-
-    --round 9
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[10]);
-
-    --round 10
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[11]);
-
-    --round 11
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[12]);
-
-    --round 12
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = addKey(block, key[13]);
-
-    return block;
-
-end
-
-AES.decrypt = function(_key, block)
-
-    local key = keyExpand(_key);
-
-    --round 0
-    block = addKey(block, key[13]);
-
-    --round 1
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[12]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 2
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[11]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 3
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[10]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 4
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[9]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 5
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[8]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 6
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[7]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 7
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[6]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 8
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[5]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 9
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[4]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 10
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[3]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 11
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[2]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 12
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[1]);
-
-    return block;
-end
-
-return AES;

lockbox/cipher/aes256.lua

@@ -1,498 +0,0 @@
-local Array = require("lockbox.util.array");
-local Bit = require("lockbox.util.bit");
-
-local XOR = Bit.bxor;
-
-local SBOX = {
- [0] = 0x63, 0x7C, 0x77, 0x7B, 0xF2, 0x6B, 0x6F, 0xC5, 0x30, 0x01, 0x67, 0x2B, 0xFE, 0xD7, 0xAB, 0x76,
- 0xCA, 0x82, 0xC9, 0x7D, 0xFA, 0x59, 0x47, 0xF0, 0xAD, 0xD4, 0xA2, 0xAF, 0x9C, 0xA4, 0x72, 0xC0,
- 0xB7, 0xFD, 0x93, 0x26, 0x36, 0x3F, 0xF7, 0xCC, 0x34, 0xA5, 0xE5, 0xF1, 0x71, 0xD8, 0x31, 0x15,
- 0x04, 0xC7, 0x23, 0xC3, 0x18, 0x96, 0x05, 0x9A, 0x07, 0x12, 0x80, 0xE2, 0xEB, 0x27, 0xB2, 0x75,
- 0x09, 0x83, 0x2C, 0x1A, 0x1B, 0x6E, 0x5A, 0xA0, 0x52, 0x3B, 0xD6, 0xB3, 0x29, 0xE3, 0x2F, 0x84,
- 0x53, 0xD1, 0x00, 0xED, 0x20, 0xFC, 0xB1, 0x5B, 0x6A, 0xCB, 0xBE, 0x39, 0x4A, 0x4C, 0x58, 0xCF,
- 0xD0, 0xEF, 0xAA, 0xFB, 0x43, 0x4D, 0x33, 0x85, 0x45, 0xF9, 0x02, 0x7F, 0x50, 0x3C, 0x9F, 0xA8,
- 0x51, 0xA3, 0x40, 0x8F, 0x92, 0x9D, 0x38, 0xF5, 0xBC, 0xB6, 0xDA, 0x21, 0x10, 0xFF, 0xF3, 0xD2,
- 0xCD, 0x0C, 0x13, 0xEC, 0x5F, 0x97, 0x44, 0x17, 0xC4, 0xA7, 0x7E, 0x3D, 0x64, 0x5D, 0x19, 0x73,
- 0x60, 0x81, 0x4F, 0xDC, 0x22, 0x2A, 0x90, 0x88, 0x46, 0xEE, 0xB8, 0x14, 0xDE, 0x5E, 0x0B, 0xDB,
- 0xE0, 0x32, 0x3A, 0x0A, 0x49, 0x06, 0x24, 0x5C, 0xC2, 0xD3, 0xAC, 0x62, 0x91, 0x95, 0xE4, 0x79,
- 0xE7, 0xC8, 0x37, 0x6D, 0x8D, 0xD5, 0x4E, 0xA9, 0x6C, 0x56, 0xF4, 0xEA, 0x65, 0x7A, 0xAE, 0x08,
- 0xBA, 0x78, 0x25, 0x2E, 0x1C, 0xA6, 0xB4, 0xC6, 0xE8, 0xDD, 0x74, 0x1F, 0x4B, 0xBD, 0x8B, 0x8A,
- 0x70, 0x3E, 0xB5, 0x66, 0x48, 0x03, 0xF6, 0x0E, 0x61, 0x35, 0x57, 0xB9, 0x86, 0xC1, 0x1D, 0x9E,
- 0xE1, 0xF8, 0x98, 0x11, 0x69, 0xD9, 0x8E, 0x94, 0x9B, 0x1E, 0x87, 0xE9, 0xCE, 0x55, 0x28, 0xDF,
- 0x8C, 0xA1, 0x89, 0x0D, 0xBF, 0xE6, 0x42, 0x68, 0x41, 0x99, 0x2D, 0x0F, 0xB0, 0x54, 0xBB, 0x16};
-
-local ISBOX = {
- [0] = 0x52, 0x09, 0x6A, 0xD5, 0x30, 0x36, 0xA5, 0x38, 0xBF, 0x40, 0xA3, 0x9E, 0x81, 0xF3, 0xD7, 0xFB,
- 0x7C, 0xE3, 0x39, 0x82, 0x9B, 0x2F, 0xFF, 0x87, 0x34, 0x8E, 0x43, 0x44, 0xC4, 0xDE, 0xE9, 0xCB,
- 0x54, 0x7B, 0x94, 0x32, 0xA6, 0xC2, 0x23, 0x3D, 0xEE, 0x4C, 0x95, 0x0B, 0x42, 0xFA, 0xC3, 0x4E,
- 0x08, 0x2E, 0xA1, 0x66, 0x28, 0xD9, 0x24, 0xB2, 0x76, 0x5B, 0xA2, 0x49, 0x6D, 0x8B, 0xD1, 0x25,
- 0x72, 0xF8, 0xF6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xD4, 0xA4, 0x5C, 0xCC, 0x5D, 0x65, 0xB6, 0x92,
- 0x6C, 0x70, 0x48, 0x50, 0xFD, 0xED, 0xB9, 0xDA, 0x5E, 0x15, 0x46, 0x57, 0xA7, 0x8D, 0x9D, 0x84,
- 0x90, 0xD8, 0xAB, 0x00, 0x8C, 0xBC, 0xD3, 0x0A, 0xF7, 0xE4, 0x58, 0x05, 0xB8, 0xB3, 0x45, 0x06,
- 0xD0, 0x2C, 0x1E, 0x8F, 0xCA, 0x3F, 0x0F, 0x02, 0xC1, 0xAF, 0xBD, 0x03, 0x01, 0x13, 0x8A, 0x6B,
- 0x3A, 0x91, 0x11, 0x41, 0x4F, 0x67, 0xDC, 0xEA, 0x97, 0xF2, 0xCF, 0xCE, 0xF0, 0xB4, 0xE6, 0x73,
- 0x96, 0xAC, 0x74, 0x22, 0xE7, 0xAD, 0x35, 0x85, 0xE2, 0xF9, 0x37, 0xE8, 0x1C, 0x75, 0xDF, 0x6E,
- 0x47, 0xF1, 0x1A, 0x71, 0x1D, 0x29, 0xC5, 0x89, 0x6F, 0xB7, 0x62, 0x0E, 0xAA, 0x18, 0xBE, 0x1B,
- 0xFC, 0x56, 0x3E, 0x4B, 0xC6, 0xD2, 0x79, 0x20, 0x9A, 0xDB, 0xC0, 0xFE, 0x78, 0xCD, 0x5A, 0xF4,
- 0x1F, 0xDD, 0xA8, 0x33, 0x88, 0x07, 0xC7, 0x31, 0xB1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xEC, 0x5F,
- 0x60, 0x51, 0x7F, 0xA9, 0x19, 0xB5, 0x4A, 0x0D, 0x2D, 0xE5, 0x7A, 0x9F, 0x93, 0xC9, 0x9C, 0xEF,
- 0xA0, 0xE0, 0x3B, 0x4D, 0xAE, 0x2A, 0xF5, 0xB0, 0xC8, 0xEB, 0xBB, 0x3C, 0x83, 0x53, 0x99, 0x61,
- 0x17, 0x2B, 0x04, 0x7E, 0xBA, 0x77, 0xD6, 0x26, 0xE1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0C, 0x7D};
-
-local ROW_SHIFT =  {  1,  6, 11, 16,  5, 10, 15,  4,  9, 14,  3,  8, 13,  2,  7, 12, };
-local IROW_SHIFT = {  1, 14, 11,  8,  5,  2, 15, 12,  9,  6,  3, 16, 13, 10,  7,  4, };
-
-local ETABLE = {
- [0] = 0x01, 0x03, 0x05, 0x0F, 0x11, 0x33, 0x55, 0xFF, 0x1A, 0x2E, 0x72, 0x96, 0xA1, 0xF8, 0x13, 0x35,
- 0x5F, 0xE1, 0x38, 0x48, 0xD8, 0x73, 0x95, 0xA4, 0xF7, 0x02, 0x06, 0x0A, 0x1E, 0x22, 0x66, 0xAA,
- 0xE5, 0x34, 0x5C, 0xE4, 0x37, 0x59, 0xEB, 0x26, 0x6A, 0xBE, 0xD9, 0x70, 0x90, 0xAB, 0xE6, 0x31,
- 0x53, 0xF5, 0x04, 0x0C, 0x14, 0x3C, 0x44, 0xCC, 0x4F, 0xD1, 0x68, 0xB8, 0xD3, 0x6E, 0xB2, 0xCD,
- 0x4C, 0xD4, 0x67, 0xA9, 0xE0, 0x3B, 0x4D, 0xD7, 0x62, 0xA6, 0xF1, 0x08, 0x18, 0x28, 0x78, 0x88,
- 0x83, 0x9E, 0xB9, 0xD0, 0x6B, 0xBD, 0xDC, 0x7F, 0x81, 0x98, 0xB3, 0xCE, 0x49, 0xDB, 0x76, 0x9A,
- 0xB5, 0xC4, 0x57, 0xF9, 0x10, 0x30, 0x50, 0xF0, 0x0B, 0x1D, 0x27, 0x69, 0xBB, 0xD6, 0x61, 0xA3,
- 0xFE, 0x19, 0x2B, 0x7D, 0x87, 0x92, 0xAD, 0xEC, 0x2F, 0x71, 0x93, 0xAE, 0xE9, 0x20, 0x60, 0xA0,
- 0xFB, 0x16, 0x3A, 0x4E, 0xD2, 0x6D, 0xB7, 0xC2, 0x5D, 0xE7, 0x32, 0x56, 0xFA, 0x15, 0x3F, 0x41,
- 0xC3, 0x5E, 0xE2, 0x3D, 0x47, 0xC9, 0x40, 0xC0, 0x5B, 0xED, 0x2C, 0x74, 0x9C, 0xBF, 0xDA, 0x75,
- 0x9F, 0xBA, 0xD5, 0x64, 0xAC, 0xEF, 0x2A, 0x7E, 0x82, 0x9D, 0xBC, 0xDF, 0x7A, 0x8E, 0x89, 0x80,
- 0x9B, 0xB6, 0xC1, 0x58, 0xE8, 0x23, 0x65, 0xAF, 0xEA, 0x25, 0x6F, 0xB1, 0xC8, 0x43, 0xC5, 0x54,
- 0xFC, 0x1F, 0x21, 0x63, 0xA5, 0xF4, 0x07, 0x09, 0x1B, 0x2D, 0x77, 0x99, 0xB0, 0xCB, 0x46, 0xCA,
- 0x45, 0xCF, 0x4A, 0xDE, 0x79, 0x8B, 0x86, 0x91, 0xA8, 0xE3, 0x3E, 0x42, 0xC6, 0x51, 0xF3, 0x0E,
- 0x12, 0x36, 0x5A, 0xEE, 0x29, 0x7B, 0x8D, 0x8C, 0x8F, 0x8A, 0x85, 0x94, 0xA7, 0xF2, 0x0D, 0x17,
- 0x39, 0x4B, 0xDD, 0x7C, 0x84, 0x97, 0xA2, 0xFD, 0x1C, 0x24, 0x6C, 0xB4, 0xC7, 0x52, 0xF6, 0x01};
-
-local LTABLE = {
- [0] = 0x00, 0x00, 0x19, 0x01, 0x32, 0x02, 0x1A, 0xC6, 0x4B, 0xC7, 0x1B, 0x68, 0x33, 0xEE, 0xDF, 0x03,
- 0x64, 0x04, 0xE0, 0x0E, 0x34, 0x8D, 0x81, 0xEF, 0x4C, 0x71, 0x08, 0xC8, 0xF8, 0x69, 0x1C, 0xC1,
- 0x7D, 0xC2, 0x1D, 0xB5, 0xF9, 0xB9, 0x27, 0x6A, 0x4D, 0xE4, 0xA6, 0x72, 0x9A, 0xC9, 0x09, 0x78,
- 0x65, 0x2F, 0x8A, 0x05, 0x21, 0x0F, 0xE1, 0x24, 0x12, 0xF0, 0x82, 0x45, 0x35, 0x93, 0xDA, 0x8E,
- 0x96, 0x8F, 0xDB, 0xBD, 0x36, 0xD0, 0xCE, 0x94, 0x13, 0x5C, 0xD2, 0xF1, 0x40, 0x46, 0x83, 0x38,
- 0x66, 0xDD, 0xFD, 0x30, 0xBF, 0x06, 0x8B, 0x62, 0xB3, 0x25, 0xE2, 0x98, 0x22, 0x88, 0x91, 0x10,
- 0x7E, 0x6E, 0x48, 0xC3, 0xA3, 0xB6, 0x1E, 0x42, 0x3A, 0x6B, 0x28, 0x54, 0xFA, 0x85, 0x3D, 0xBA,
- 0x2B, 0x79, 0x0A, 0x15, 0x9B, 0x9F, 0x5E, 0xCA, 0x4E, 0xD4, 0xAC, 0xE5, 0xF3, 0x73, 0xA7, 0x57,
- 0xAF, 0x58, 0xA8, 0x50, 0xF4, 0xEA, 0xD6, 0x74, 0x4F, 0xAE, 0xE9, 0xD5, 0xE7, 0xE6, 0xAD, 0xE8,
- 0x2C, 0xD7, 0x75, 0x7A, 0xEB, 0x16, 0x0B, 0xF5, 0x59, 0xCB, 0x5F, 0xB0, 0x9C, 0xA9, 0x51, 0xA0,
- 0x7F, 0x0C, 0xF6, 0x6F, 0x17, 0xC4, 0x49, 0xEC, 0xD8, 0x43, 0x1F, 0x2D, 0xA4, 0x76, 0x7B, 0xB7,
- 0xCC, 0xBB, 0x3E, 0x5A, 0xFB, 0x60, 0xB1, 0x86, 0x3B, 0x52, 0xA1, 0x6C, 0xAA, 0x55, 0x29, 0x9D,
- 0x97, 0xB2, 0x87, 0x90, 0x61, 0xBE, 0xDC, 0xFC, 0xBC, 0x95, 0xCF, 0xCD, 0x37, 0x3F, 0x5B, 0xD1,
- 0x53, 0x39, 0x84, 0x3C, 0x41, 0xA2, 0x6D, 0x47, 0x14, 0x2A, 0x9E, 0x5D, 0x56, 0xF2, 0xD3, 0xAB,
- 0x44, 0x11, 0x92, 0xD9, 0x23, 0x20, 0x2E, 0x89, 0xB4, 0x7C, 0xB8, 0x26, 0x77, 0x99, 0xE3, 0xA5,
- 0x67, 0x4A, 0xED, 0xDE, 0xC5, 0x31, 0xFE, 0x18, 0x0D, 0x63, 0x8C, 0x80, 0xC0, 0xF7, 0x70, 0x07};
-
-local MIXTABLE = {
- 0x02, 0x03, 0x01, 0x01,
- 0x01, 0x02, 0x03, 0x01,
- 0x01, 0x01, 0x02, 0x03,
- 0x03, 0x01, 0x01, 0x02};
-
-local IMIXTABLE = {
- 0x0E, 0x0B, 0x0D, 0x09,
- 0x09, 0x0E, 0x0B, 0x0D,
- 0x0D, 0x09, 0x0E, 0x0B,
- 0x0B, 0x0D, 0x09, 0x0E};
-
-local RCON = {
-[0] = 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a,
-0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39,
-0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a,
-0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8,
-0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef,
-0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc,
-0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b,
-0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3,
-0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94,
-0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20,
-0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35,
-0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd, 0x61, 0xc2, 0x9f,
-0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d, 0x01, 0x02, 0x04,
-0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63,
-0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91, 0x39, 0x72, 0xe4, 0xd3, 0xbd,
-0x61, 0xc2, 0x9f, 0x25, 0x4a, 0x94, 0x33, 0x66, 0xcc, 0x83, 0x1d, 0x3a, 0x74, 0xe8, 0xcb, 0x8d};
-
-
-local GMUL = function(A, B)
-    if(A == 0x01) then return B; end
-    if(B == 0x01) then return A; end
-    if(A == 0x00) then return 0; end
-    if(B == 0x00) then return 0; end
-
-    local LA = LTABLE[A];
-    local LB = LTABLE[B];
-
-    local sum = LA + LB;
-    if (sum > 0xFF) then sum = sum - 0xFF; end
-
-    return ETABLE[sum];
-end
-
-local byteSub = Array.substitute;
-
-local shiftRow = Array.permute;
-
-local mixCol = function(i, mix)
-    local out = {};
-
-    local a, b, c, d;
-
-    a = GMUL(i[ 1], mix[ 1]);
-    b = GMUL(i[ 2], mix[ 2]);
-    c = GMUL(i[ 3], mix[ 3]);
-    d = GMUL(i[ 4], mix[ 4]);
-    out[ 1] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 1], mix[ 5]);
-    b = GMUL(i[ 2], mix[ 6]);
-    c = GMUL(i[ 3], mix[ 7]);
-    d = GMUL(i[ 4], mix[ 8]);
-    out[ 2] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 1], mix[ 9]);
-    b = GMUL(i[ 2], mix[10]);
-    c = GMUL(i[ 3], mix[11]);
-    d = GMUL(i[ 4], mix[12]);
-    out[ 3] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 1], mix[13]);
-    b = GMUL(i[ 2], mix[14]);
-    c = GMUL(i[ 3], mix[15]);
-    d = GMUL(i[ 4], mix[16]);
-    out[ 4] = XOR(XOR(a, b), XOR(c, d));
-
-
-    a = GMUL(i[ 5], mix[ 1]);
-    b = GMUL(i[ 6], mix[ 2]);
-    c = GMUL(i[ 7], mix[ 3]);
-    d = GMUL(i[ 8], mix[ 4]);
-    out[ 5] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 5], mix[ 5]);
-    b = GMUL(i[ 6], mix[ 6]);
-    c = GMUL(i[ 7], mix[ 7]);
-    d = GMUL(i[ 8], mix[ 8]);
-    out[ 6] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 5], mix[ 9]);
-    b = GMUL(i[ 6], mix[10]);
-    c = GMUL(i[ 7], mix[11]);
-    d = GMUL(i[ 8], mix[12]);
-    out[ 7] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 5], mix[13]);
-    b = GMUL(i[ 6], mix[14]);
-    c = GMUL(i[ 7], mix[15]);
-    d = GMUL(i[ 8], mix[16]);
-    out[ 8] = XOR(XOR(a, b), XOR(c, d));
-
-
-    a = GMUL(i[ 9], mix[ 1]);
-    b = GMUL(i[10], mix[ 2]);
-    c = GMUL(i[11], mix[ 3]);
-    d = GMUL(i[12], mix[ 4]);
-    out[ 9] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 9], mix[ 5]);
-    b = GMUL(i[10], mix[ 6]);
-    c = GMUL(i[11], mix[ 7]);
-    d = GMUL(i[12], mix[ 8]);
-    out[10] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 9], mix[ 9]);
-    b = GMUL(i[10], mix[10]);
-    c = GMUL(i[11], mix[11]);
-    d = GMUL(i[12], mix[12]);
-    out[11] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[ 9], mix[13]);
-    b = GMUL(i[10], mix[14]);
-    c = GMUL(i[11], mix[15]);
-    d = GMUL(i[12], mix[16]);
-    out[12] = XOR(XOR(a, b), XOR(c, d));
-
-
-    a = GMUL(i[13], mix[ 1]);
-    b = GMUL(i[14], mix[ 2]);
-    c = GMUL(i[15], mix[ 3]);
-    d = GMUL(i[16], mix[ 4]);
-    out[13] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[13], mix[ 5]);
-    b = GMUL(i[14], mix[ 6]);
-    c = GMUL(i[15], mix[ 7]);
-    d = GMUL(i[16], mix[ 8]);
-    out[14] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[13], mix[ 9]);
-    b = GMUL(i[14], mix[10]);
-    c = GMUL(i[15], mix[11]);
-    d = GMUL(i[16], mix[12]);
-    out[15] = XOR(XOR(a, b), XOR(c, d));
-    a = GMUL(i[13], mix[13]);
-    b = GMUL(i[14], mix[14]);
-    c = GMUL(i[15], mix[15]);
-    d = GMUL(i[16], mix[16]);
-    out[16] = XOR(XOR(a, b), XOR(c, d));
-
-    return out;
-end
-
-local keyRound = function(key, round)
-    local i = (round - 1) * 32;
-    local out = key;
-
-    out[33 + i] = XOR(key[ 1 + i], XOR(SBOX[key[30 + i]], RCON[round]));
-    out[34 + i] = XOR(key[ 2 + i], SBOX[key[31 + i]]);
-    out[35 + i] = XOR(key[ 3 + i], SBOX[key[32 + i]]);
-    out[36 + i] = XOR(key[ 4 + i], SBOX[key[29 + i]]);
-
-    out[37 + i] = XOR(out[33 + i], key[ 5 + i]);
-    out[38 + i] = XOR(out[34 + i], key[ 6 + i]);
-    out[39 + i] = XOR(out[35 + i], key[ 7 + i]);
-    out[40 + i] = XOR(out[36 + i], key[ 8 + i]);
-
-    out[41 + i] = XOR(out[37 + i], key[ 9 + i]);
-    out[42 + i] = XOR(out[38 + i], key[10 + i]);
-    out[43 + i] = XOR(out[39 + i], key[11 + i]);
-    out[44 + i] = XOR(out[40 + i], key[12 + i]);
-
-    out[45 + i] = XOR(out[41 + i], key[13 + i]);
-    out[46 + i] = XOR(out[42 + i], key[14 + i]);
-    out[47 + i] = XOR(out[43 + i], key[15 + i]);
-    out[48 + i] = XOR(out[44 + i], key[16 + i]);
-
-
-    out[49 + i] = XOR(SBOX[out[45 + i]], key[17 + i]);
-    out[50 + i] = XOR(SBOX[out[46 + i]], key[18 + i]);
-    out[51 + i] = XOR(SBOX[out[47 + i]], key[19 + i]);
-    out[52 + i] = XOR(SBOX[out[48 + i]], key[20 + i]);
-
-    out[53 + i] = XOR(out[49 + i], key[21 + i]);
-    out[54 + i] = XOR(out[50 + i], key[22 + i]);
-    out[55 + i] = XOR(out[51 + i], key[23 + i]);
-    out[56 + i] = XOR(out[52 + i], key[24 + i]);
-
-    out[57 + i] = XOR(out[53 + i], key[25 + i]);
-    out[58 + i] = XOR(out[54 + i], key[26 + i]);
-    out[59 + i] = XOR(out[55 + i], key[27 + i]);
-    out[60 + i] = XOR(out[56 + i], key[28 + i]);
-
-    out[61 + i] = XOR(out[57 + i], key[29 + i]);
-    out[62 + i] = XOR(out[58 + i], key[30 + i]);
-    out[63 + i] = XOR(out[59 + i], key[31 + i]);
-    out[64 + i] = XOR(out[60 + i], key[32 + i]);
-
-    return out;
-end
-
-local keyExpand = function(key)
-    local bytes = Array.copy(key);
-
-    for i = 1, 7 do
-        keyRound(bytes, i);
-    end
-
-    local keys = {};
-
-    keys[ 1] = Array.slice(bytes, 1, 16);
-    keys[ 2] = Array.slice(bytes, 17, 32);
-    keys[ 3] = Array.slice(bytes, 33, 48);
-    keys[ 4] = Array.slice(bytes, 49, 64);
-    keys[ 5] = Array.slice(bytes, 65, 80);
-    keys[ 6] = Array.slice(bytes, 81, 96);
-    keys[ 7] = Array.slice(bytes, 97, 112);
-    keys[ 8] = Array.slice(bytes, 113, 128);
-    keys[ 9] = Array.slice(bytes, 129, 144);
-    keys[10] = Array.slice(bytes, 145, 160);
-    keys[11] = Array.slice(bytes, 161, 176);
-    keys[12] = Array.slice(bytes, 177, 192);
-    keys[13] = Array.slice(bytes, 193, 208);
-    keys[14] = Array.slice(bytes, 209, 224);
-    keys[15] = Array.slice(bytes, 225, 240);
-
-    return keys;
-
-end
-
-local addKey = Array.XOR;
-
-
-
-local AES = {};
-
-AES.blockSize = 16;
-
-AES.encrypt = function(_key, block)
-
-    local key = keyExpand(_key);
-
-    --round 0
-    block = addKey(block, key[1]);
-
-    --round 1
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[2]);
-
-    --round 2
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[3]);
-
-    --round 3
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[4]);
-
-    --round 4
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[5]);
-
-    --round 5
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[6]);
-
-    --round 6
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[7]);
-
-    --round 7
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[8]);
-
-    --round 8
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[9]);
-
-    --round 9
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[10]);
-
-    --round 10
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[11]);
-
-    --round 11
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[12]);
-
-    --round 12
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[13]);
-
-    --round 13
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = mixCol(block, MIXTABLE);
-    block = addKey(block, key[14]);
-
-    --round 14
-    block = byteSub(block, SBOX);
-    block = shiftRow(block, ROW_SHIFT);
-    block = addKey(block, key[15]);
-
-    return block;
-
-end
-
-AES.decrypt = function(_key, block)
-
-    local key = keyExpand(_key);
-
-    --round 0
-    block = addKey(block, key[15]);
-
-    --round 1
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[14]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 2
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[13]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 3
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[12]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 4
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[11]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 5
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[10]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 6
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[9]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 7
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[8]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 8
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[7]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 9
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[6]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 10
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[5]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 11
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[4]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 12
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[3]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 13
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[2]);
-    block = mixCol(block, IMIXTABLE);
-
-    --round 14
-    block = shiftRow(block, IROW_SHIFT);
-    block = byteSub(block, ISBOX);
-    block = addKey(block, key[1]);
-
-    return block;
-end
-
-return AES;

lockbox/cipher/mode/cbc.lua

@@ -1,164 +0,0 @@
-local Array = require("lockbox.util.array");
-local Stream = require("lockbox.util.stream");
-local Queue = require("lockbox.util.queue");
-
-local CBC = {};
-
-CBC.Cipher = function()
-
-    local public = {};
-
-    local key;
-    local blockCipher;
-    local padding;
-    local inputQueue;
-    local outputQueue;
-    local iv;
-
-    public.setKey = function(keyBytes)
-        key = keyBytes;
-        return public;
-    end
-
-    public.setBlockCipher = function(cipher)
-        blockCipher = cipher;
-        return public;
-    end
-
-    public.setPadding = function(paddingMode)
-        padding = paddingMode;
-        return public;
-    end
-
-    public.init = function()
-        inputQueue = Queue();
-        outputQueue = Queue();
-        iv = nil;
-        return public;
-    end
-
-    public.update = function(messageStream)
-        local byte = messageStream();
-        while (byte ~= nil) do
-            inputQueue.push(byte);
-            if(inputQueue.size() >= blockCipher.blockSize) then
-                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
-
-                if(iv == nil) then
-                    iv = block;
-                else
-                    local out = Array.XOR(iv, block);
-                    out = blockCipher.encrypt(key, out);
-                    Array.writeToQueue(outputQueue, out);
-                    iv = out;
-                end
-            end
-            byte = messageStream();
-        end
-        return public;
-    end
-
-    public.finish = function()
-        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
-        public.update(paddingStream);
-
-        return public;
-    end
-
-    public.getOutputQueue = function()
-        return outputQueue;
-    end
-
-    public.asHex = function()
-        return Stream.toHex(outputQueue.pop);
-    end
-
-    public.asBytes = function()
-        return Stream.toArray(outputQueue.pop);
-    end
-
-    return public;
-
-end
-
-
-CBC.Decipher = function()
-
-    local public = {};
-
-    local key;
-    local blockCipher;
-    local padding;
-    local inputQueue;
-    local outputQueue;
-    local iv;
-
-    public.setKey = function(keyBytes)
-        key = keyBytes;
-        return public;
-    end
-
-    public.setBlockCipher = function(cipher)
-        blockCipher = cipher;
-        return public;
-    end
-
-    public.setPadding = function(paddingMode)
-        padding = paddingMode;
-        return public;
-    end
-
-    public.init = function()
-        inputQueue = Queue();
-        outputQueue = Queue();
-        iv = nil;
-        return public;
-    end
-
-    public.update = function(messageStream)
-        local byte = messageStream();
-        while (byte ~= nil) do
-            inputQueue.push(byte);
-            if(inputQueue.size() >= blockCipher.blockSize) then
-                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
-
-                if(iv == nil) then
-                    iv = block;
-                else
-                    local out = block;
-                    out = blockCipher.decrypt(key, out);
-                    out = Array.XOR(iv, out);
-                    Array.writeToQueue(outputQueue, out);
-                    iv = block;
-                end
-            end
-            byte = messageStream();
-        end
-        return public;
-    end
-
-    public.finish = function()
-        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
-        public.update(paddingStream);
-
-        return public;
-    end
-
-    public.getOutputQueue = function()
-        return outputQueue;
-    end
-
-    public.asHex = function()
-        return Stream.toHex(outputQueue.pop);
-    end
-
-    public.asBytes = function()
-        return Stream.toArray(outputQueue.pop);
-    end
-
-    return public;
-
-end
-
-return CBC;
-

lockbox/cipher/mode/cfb.lua

@@ -1,163 +0,0 @@
-local Array = require("lockbox.util.array");
-local Stream = require("lockbox.util.stream");
-local Queue = require("lockbox.util.queue");
-
-local CFB = {};
-
-CFB.Cipher = function()
-
-    local public = {};
-
-    local key;
-    local blockCipher;
-    local padding;
-    local inputQueue;
-    local outputQueue;
-    local iv;
-
-    public.setKey = function(keyBytes)
-        key = keyBytes;
-        return public;
-    end
-
-    public.setBlockCipher = function(cipher)
-        blockCipher = cipher;
-        return public;
-    end
-
-    public.setPadding = function(paddingMode)
-        padding = paddingMode;
-        return public;
-    end
-
-    public.init = function()
-        inputQueue = Queue();
-        outputQueue = Queue();
-        iv = nil;
-        return public;
-    end
-
-    public.update = function(messageStream)
-        local byte = messageStream();
-        while (byte ~= nil) do
-            inputQueue.push(byte);
-            if(inputQueue.size() >= blockCipher.blockSize) then
-                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
-
-                if(iv == nil) then
-                    iv = block;
-                else
-                    local out = iv;
-                    out = blockCipher.encrypt(key, out);
-                    out = Array.XOR(out, block);
-                    Array.writeToQueue(outputQueue, out);
-                    iv = out;
-                end
-            end
-            byte = messageStream();
-        end
-        return public;
-    end
-
-    public.finish = function()
-        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
-        public.update(paddingStream);
-
-        return public;
-    end
-
-    public.getOutputQueue = function()
-        return outputQueue;
-    end
-
-    public.asHex = function()
-        return Stream.toHex(outputQueue.pop);
-    end
-
-    public.asBytes = function()
-        return Stream.toArray(outputQueue.pop);
-    end
-
-    return public;
-
-end
-
-CFB.Decipher = function()
-
-    local public = {};
-
-    local key;
-    local blockCipher;
-    local padding;
-    local inputQueue;
-    local outputQueue;
-    local iv;
-
-    public.setKey = function(keyBytes)
-        key = keyBytes;
-        return public;
-    end
-
-    public.setBlockCipher = function(cipher)
-        blockCipher = cipher;
-        return public;
-    end
-
-    public.setPadding = function(paddingMode)
-        padding = paddingMode;
-        return public;
-    end
-
-    public.init = function()
-        inputQueue = Queue();
-        outputQueue = Queue();
-        iv = nil;
-        return public;
-    end
-
-    public.update = function(messageStream)
-        local byte = messageStream();
-        while (byte ~= nil) do
-            inputQueue.push(byte);
-            if(inputQueue.size() >= blockCipher.blockSize) then
-                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
-
-                if(iv == nil) then
-                    iv = block;
-                else
-                    local out = iv;
-                    out = blockCipher.encrypt(key, out);
-                    out = Array.XOR(out, block);
-                    Array.writeToQueue(outputQueue, out);
-                    iv = block;
-                end
-            end
-            byte = messageStream();
-        end
-        return public;
-    end
-
-    public.finish = function()
-        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
-        public.update(paddingStream);
-
-        return public;
-    end
-
-    public.getOutputQueue = function()
-        return outputQueue;
-    end
-
-    public.asHex = function()
-        return Stream.toHex(outputQueue.pop);
-    end
-
-    public.asBytes = function()
-        return Stream.toArray(outputQueue.pop);
-    end
-
-    return public;
-
-end
-
-return CFB;

lockbox/cipher/mode/ctr.lua

@@ -1,248 +0,0 @@
-local Array = require("lockbox.util.array");
-local Stream = require("lockbox.util.stream");
-local Queue = require("lockbox.util.queue");
-
-local Bit = require("lockbox.util.bit");
-
-local AND = Bit.band;
-
-local CTR = {};
-
-CTR.Cipher = function()
-
-    local public = {};
-
-    local key;
-    local blockCipher;
-    local padding;
-    local inputQueue;
-    local outputQueue;
-    local iv;
-
-    public.setKey = function(keyBytes)
-        key = keyBytes;
-        return public;
-    end
-
-    public.setBlockCipher = function(cipher)
-        blockCipher = cipher;
-        return public;
-    end
-
-    public.setPadding = function(paddingMode)
-        padding = paddingMode;
-        return public;
-    end
-
-    public.init = function()
-        inputQueue = Queue();
-        outputQueue = Queue();
-        iv = nil;
-        return public;
-    end
-
-    local updateIV = function()
-        iv[16] = iv[16] + 1;
-        if iv[16] <= 0xFF then return; end
-        iv[16] = AND(iv[16], 0xFF);
-
-        iv[15] = iv[15] + 1;
-        if iv[15] <= 0xFF then return; end
-        iv[15] = AND(iv[15], 0xFF);
-
-        iv[14] = iv[14] + 1;
-        if iv[14] <= 0xFF then return; end
-        iv[14] = AND(iv[14], 0xFF);
-
-        iv[13] = iv[13] + 1;
-        if iv[13] <= 0xFF then return; end
-        iv[13] = AND(iv[13], 0xFF);
-
-        iv[12] = iv[12] + 1;
-        if iv[12] <= 0xFF then return; end
-        iv[12] = AND(iv[12], 0xFF);
-
-        iv[11] = iv[11] + 1;
-        if iv[11] <= 0xFF then return; end
-        iv[11] = AND(iv[11], 0xFF);
-
-        iv[10] = iv[10] + 1;
-        if iv[10] <= 0xFF then return; end
-        iv[10] = AND(iv[10], 0xFF);
-
-        iv[9] = iv[9] + 1;
-        if iv[9] <= 0xFF then return; end
-        iv[9] = AND(iv[9], 0xFF);
-
-        return;
-    end
-
-    public.update = function(messageStream)
-        local byte = messageStream();
-        while (byte ~= nil) do
-            inputQueue.push(byte);
-
-            if(inputQueue.size() >= blockCipher.blockSize) then
-                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
-
-                if(iv == nil) then
-                    iv = block;
-                else
-                    local out = iv;
-                    out = blockCipher.encrypt(key, out);
-
-                    out = Array.XOR(out, block);
-                    Array.writeToQueue(outputQueue, out);
-                    updateIV();
-                end
-            end
-            byte = messageStream();
-        end
-        return public;
-    end
-
-    public.finish = function()
-        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
-        public.update(paddingStream);
-
-        return public;
-    end
-
-    public.getOutputQueue = function()
-        return outputQueue;
-    end
-
-    public.asHex = function()
-        return Stream.toHex(outputQueue.pop);
-    end
-
-    public.asBytes = function()
-        return Stream.toArray(outputQueue.pop);
-    end
-
-    return public;
-
-end
-
-
-CTR.Decipher = function()
-
-    local public = {};
-
-    local key;
-    local blockCipher;
-    local padding;
-    local inputQueue;
-    local outputQueue;
-    local iv;
-
-    public.setKey = function(keyBytes)
-        key = keyBytes;
-        return public;
-    end
-
-    public.setBlockCipher = function(cipher)
-        blockCipher = cipher;
-        return public;
-    end
-
-    public.setPadding = function(paddingMode)
-        padding = paddingMode;
-        return public;
-    end
-
-    public.init = function()
-        inputQueue = Queue();
-        outputQueue = Queue();
-        iv = nil;
-        return public;
-    end
-
-    local updateIV = function()
-        iv[16] = iv[16] + 1;
-        if iv[16] <= 0xFF then return; end
-        iv[16] = AND(iv[16], 0xFF);
-
-        iv[15] = iv[15] + 1;
-        if iv[15] <= 0xFF then return; end
-        iv[15] = AND(iv[15], 0xFF);
-
-        iv[14] = iv[14] + 1;
-        if iv[14] <= 0xFF then return; end
-        iv[14] = AND(iv[14], 0xFF);
-
-        iv[13] = iv[13] + 1;
-        if iv[13] <= 0xFF then return; end
-        iv[13] = AND(iv[13], 0xFF);
-
-        iv[12] = iv[12] + 1;
-        if iv[12] <= 0xFF then return; end
-        iv[12] = AND(iv[12], 0xFF);
-
-        iv[11] = iv[11] + 1;
-        if iv[11] <= 0xFF then return; end
-        iv[11] = AND(iv[11], 0xFF);
-
-        iv[10] = iv[10] + 1;
-        if iv[10] <= 0xFF then return; end
-        iv[10] = AND(iv[10], 0xFF);
-
-        iv[9] = iv[9] + 1;
-        if iv[9] <= 0xFF then return; end
-        iv[9] = AND(iv[9], 0xFF);
-
-        return;
-    end
-
-    public.update = function(messageStream)
-        local byte = messageStream();
-        while (byte ~= nil) do
-            inputQueue.push(byte);
-
-            if(inputQueue.size() >= blockCipher.blockSize) then
-                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
-
-                if(iv == nil) then
-                    iv = block;
-                else
-                    local out = iv;
-                    out = blockCipher.encrypt(key, out);
-
-                    out = Array.XOR(out, block);
-                    Array.writeToQueue(outputQueue, out);
-                    updateIV();
-                end
-            end
-            byte = messageStream();
-        end
-        return public;
-    end
-
-    public.finish = function()
-        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
-        public.update(paddingStream);
-
-        return public;
-    end
-
-    public.getOutputQueue = function()
-        return outputQueue;
-    end
-
-    public.asHex = function()
-        return Stream.toHex(outputQueue.pop);
-    end
-
-    public.asBytes = function()
-        return Stream.toArray(outputQueue.pop);
-    end
-
-    return public;
-
-end
-
-
-
-
-return CTR;
-

lockbox/cipher/mode/ofb.lua

@@ -1,164 +0,0 @@
-local Array = require("lockbox.util.array");
-local Stream = require("lockbox.util.stream");
-local Queue = require("lockbox.util.queue");
-
-local OFB = {};
-
-OFB.Cipher = function()
-
-    local public = {};
-
-    local key;
-    local blockCipher;
-    local padding;
-    local inputQueue;
-    local outputQueue;
-    local iv;
-
-    public.setKey = function(keyBytes)
-        key = keyBytes;
-        return public;
-    end
-
-    public.setBlockCipher = function(cipher)
-        blockCipher = cipher;
-        return public;
-    end
-
-    public.setPadding = function(paddingMode)
-        padding = paddingMode;
-        return public;
-    end
-
-    public.init = function()
-        inputQueue = Queue();
-        outputQueue = Queue();
-        iv = nil;
-        return public;
-    end
-
-    public.update = function(messageStream)
-        local byte = messageStream();
-        while (byte ~= nil) do
-            inputQueue.push(byte);
-            if(inputQueue.size() >= blockCipher.blockSize) then
-                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
-
-                if(iv == nil) then
-                    iv = block;
-                else
-                    local out = iv;
-                    out = blockCipher.encrypt(key, out);
-                    iv = out;
-                    out = Array.XOR(out, block);
-                    Array.writeToQueue(outputQueue, out);
-                end
-            end
-            byte = messageStream();
-        end
-        return public;
-    end
-
-    public.finish = function()
-        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
-        public.update(paddingStream);
-
-        return public;
-    end
-
-    public.getOutputQueue = function()
-        return outputQueue;
-    end
-
-    public.asHex = function()
-        return Stream.toHex(outputQueue.pop);
-    end
-
-    public.asBytes = function()
-        return Stream.toArray(outputQueue.pop);
-    end
-
-    return public;
-
-end
-
-OFB.Decipher = function()
-
-    local public = {};
-
-    local key;
-    local blockCipher;
-    local padding;
-    local inputQueue;
-    local outputQueue;
-    local iv;
-
-    public.setKey = function(keyBytes)
-        key = keyBytes;
-        return public;
-    end
-
-    public.setBlockCipher = function(cipher)
-        blockCipher = cipher;
-        return public;
-    end
-
-    public.setPadding = function(paddingMode)
-        padding = paddingMode;
-        return public;
-    end
-
-    public.init = function()
-        inputQueue = Queue();
-        outputQueue = Queue();
-        iv = nil;
-        return public;
-    end
-
-    public.update = function(messageStream)
-        local byte = messageStream();
-        while (byte ~= nil) do
-            inputQueue.push(byte);
-            if(inputQueue.size() >= blockCipher.blockSize) then
-                local block = Array.readFromQueue(inputQueue, blockCipher.blockSize);
-
-                if(iv == nil) then
-                    iv = block;
-                else
-                    local out = iv;
-                    out = blockCipher.encrypt(key, out);
-                    iv = out;
-                    out = Array.XOR(out, block);
-                    Array.writeToQueue(outputQueue, out);
-                end
-            end
-            byte = messageStream();
-        end
-        return public;
-    end
-
-    public.finish = function()
-        local paddingStream = padding(blockCipher.blockSize, inputQueue.getHead());
-        public.update(paddingStream);
-
-        return public;
-    end
-
-    public.getOutputQueue = function()
-        return outputQueue;
-    end
-
-    public.asHex = function()
-        return Stream.toHex(outputQueue.pop);
-    end
-
-    public.asBytes = function()
-        return Stream.toArray(outputQueue.pop);
-    end
-
-    return public;
-
-end
-
-
-return OFB;

lockbox/digest/md5.lua

@@ -0,0 +1,201 @@
+require("lockbox").insecure();
+
+local Bit = require("lockbox.util.bit");
+local String = require("string");
+local Math = require("math");
+local Queue = require("lockbox.util.queue");
+
+local SHIFT = {
+    7, 12, 17, 22,  7, 12, 17, 22,  7, 12, 17, 22,  7, 12, 17, 22,
+    5,  9, 14, 20,  5,  9, 14, 20,  5,  9, 14, 20,  5,  9, 14, 20,
+    4, 11, 16, 23,  4, 11, 16, 23,  4, 11, 16, 23,  4, 11, 16, 23,
+    6, 10, 15, 21,  6, 10, 15, 21,  6, 10, 15, 21,  6, 10, 15, 21};
+
+local CONSTANTS = {
+    0xd76aa478, 0xe8c7b756, 0x242070db, 0xc1bdceee,
+    0xf57c0faf, 0x4787c62a, 0xa8304613, 0xfd469501,
+    0x698098d8, 0x8b44f7af, 0xffff5bb1, 0x895cd7be,
+    0x6b901122, 0xfd987193, 0xa679438e, 0x49b40821,
+    0xf61e2562, 0xc040b340, 0x265e5a51, 0xe9b6c7aa,
+    0xd62f105d, 0x02441453, 0xd8a1e681, 0xe7d3fbc8,
+    0x21e1cde6, 0xc33707d6, 0xf4d50d87, 0x455a14ed,
+    0xa9e3e905, 0xfcefa3f8, 0x676f02d9, 0x8d2a4c8a,
+    0xfffa3942, 0x8771f681, 0x6d9d6122, 0xfde5380c,
+    0xa4beea44, 0x4bdecfa9, 0xf6bb4b60, 0xbebfbc70,
+    0x289b7ec6, 0xeaa127fa, 0xd4ef3085, 0x04881d05,
+    0xd9d4d039, 0xe6db99e5, 0x1fa27cf8, 0xc4ac5665,
+    0xf4292244, 0x432aff97, 0xab9423a7, 0xfc93a039,
+    0x655b59c3, 0x8f0ccc92, 0xffeff47d, 0x85845dd1,
+    0x6fa87e4f, 0xfe2ce6e0, 0xa3014314, 0x4e0811a1,
+    0xf7537e82, 0xbd3af235, 0x2ad7d2bb, 0xeb86d391};
+
+local AND = Bit.band;
+local OR  = Bit.bor;
+local NOT = Bit.bnot;
+local XOR = Bit.bxor;
+local LROT = Bit.lrotate;
+local LSHIFT = Bit.lshift;
+local RSHIFT = Bit.rshift;
+
+--MD5 is little-endian
+local bytes2word = function(b0, b1, b2, b3)
+    local i = b3; i = LSHIFT(i, 8);
+    i = OR(i, b2); i = LSHIFT(i, 8);
+    i = OR(i, b1); i = LSHIFT(i, 8);
+    i = OR(i, b0);
+    return i;
+end
+
+local word2bytes = function(word)
+    local b0, b1, b2, b3;
+    b0 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b1 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b2 = AND(word, 0xFF); word = RSHIFT(word, 8);
+    b3 = AND(word, 0xFF);
+    return b0, b1, b2, b3;
+end
+
+local dword2bytes = function(i)
+    local b4, b5, b6, b7 = word2bytes(Math.floor(i / 0x100000000));
+    local b0, b1, b2, b3 = word2bytes(i);
+    return b0, b1, b2, b3, b4, b5, b6, b7;
+end
+
+local F = function(x, y, z) return OR(AND(x, y), AND(NOT(x), z)); end
+local G = function(x, y, z) return OR(AND(x, z), AND(y, NOT(z))); end
+local H = function(x, y, z) return XOR(x, XOR(y, z)); end
+local I = function(x, y, z) return XOR(y, OR(x, NOT(z))); end
+
+local MD5 = function()
+
+    local queue = Queue();
+
+    local A = 0x67452301;
+    local B = 0xefcdab89;
+    local C = 0x98badcfe;
+    local D = 0x10325476;
+    local public = {};
+
+    local processBlock = function()
+        local a = A;
+        local b = B;
+        local c = C;
+        local d = D;
+
+        local X = {};
+
+        for i = 1, 16 do
+            X[i] = bytes2word(queue.pop(), queue.pop(), queue.pop(), queue.pop());
+        end
+
+        for i = 0, 63 do
+            local f, g, temp;
+
+            if (0 <= i) and (i <= 15) then
+                f = F(b, c, d);
+                g = i;
+            elseif (16 <= i) and (i <= 31) then
+                f = G(b, c, d);
+                g = (5 * i + 1) % 16;
+            elseif (32 <= i) and (i <= 47) then
+                f = H(b, c, d);
+                g = (3 * i + 5) % 16;
+            elseif (48 <= i) and (i <= 63) then
+                f = I(b, c, d);
+                g = (7 * i) % 16;
+            end
+            temp = d;
+            d = c;
+            c = b;
+            b = b + LROT((a + f + CONSTANTS[i + 1] + X[g + 1]), SHIFT[i + 1]);
+            a = temp;
+        end
+
+        A = AND(A + a, 0xFFFFFFFF);
+        B = AND(B + b, 0xFFFFFFFF);
+        C = AND(C + c, 0xFFFFFFFF);
+        D = AND(D + d, 0xFFFFFFFF);
+    end
+
+    public.init = function()
+        queue.reset();
+
+        A = 0x67452301;
+        B = 0xefcdab89;
+        C = 0x98badcfe;
+        D = 0x10325476;
+
+        return public;
+    end
+
+    public.update = function(bytes)
+        for b in bytes do
+            queue.push(b);
+            if(queue.size() >= 64) then processBlock(); end
+        end
+
+        return public;
+    end
+
+    public.finish = function()
+        local bits = queue.getHead() * 8;
+
+        queue.push(0x80);
+        while ((queue.size() + 7) % 64) < 63 do
+            queue.push(0x00);
+        end
+
+        local b0, b1, b2, b3, b4, b5, b6, b7 = dword2bytes(bits);
+
+        queue.push(b0);
+        queue.push(b1);
+        queue.push(b2);
+        queue.push(b3);
+        queue.push(b4);
+        queue.push(b5);
+        queue.push(b6);
+        queue.push(b7);
+
+        while queue.size() > 0 do
+            processBlock();
+        end
+
+        return public;
+    end
+
+    public.asBytes = function()
+        local  b0, b1, b2, b3 = word2bytes(A);
+        local  b4, b5, b6, b7 = word2bytes(B);
+        local  b8, b9, b10, b11 = word2bytes(C);
+        local b12, b13, b14, b15 = word2bytes(D);
+
+        return {b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, b10, b11, b12, b13, b14, b15};
+    end
+
+    public.asHex = function()
+        local  b0, b1, b2, b3 = word2bytes(A);
+        local  b4, b5, b6, b7 = word2bytes(B);
+        local  b8, b9, b10, b11 = word2bytes(C);
+        local b12, b13, b14, b15 = word2bytes(D);
+
+        return String.format("%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
+                b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, b10, b11, b12, b13, b14, b15);
+    end
+
+    public.asString = function()
+        local b0, b1, b2, b3 = word2bytes(A);
+        local b4, b5, b6, b7 = word2bytes(B);
+        local b8, b9, b10, b11 = word2bytes(C);
+        local b12, b13, b14, b15 = word2bytes(D);
+
+        return string.pack(string.rep('B', 16),
+            b0, b1, b2, b3, b4, b5, b6, b7, b8,
+            b9, b10, b11, b12, b13, b14, b15
+        )
+    end
+
+    return public;
+
+end
+
+return MD5;

lockbox/init.lua

@@ -1,5 +1,8 @@
 local Lockbox = {};
 
+-- cc-mek-scada lockbox version
+Lockbox.version = "1.0"
+
 --[[
 package.path =  "./?.lua;"
                 .. "./cipher/?.lua;"

lockbox/padding/ansix923.lua

@@ -1,22 +0,0 @@
-local ANSIX923Padding = function(blockSize, byteCount)
-
-    local paddingCount = blockSize - (byteCount % blockSize);
-    local bytesLeft = paddingCount;
-
-    local stream = function()
-        if bytesLeft > 1 then
-            bytesLeft = bytesLeft - 1;
-            return 0x00;
-        elseif bytesLeft > 0 then
-            bytesLeft = bytesLeft - 1;
-            return paddingCount;
-        else
-            return nil;
-        end
-    end
-
-    return stream;
-
-end
-
-return ANSIX923Padding;

lockbox/padding/isoiec7816.lua

@@ -1,22 +0,0 @@
-local ISOIEC7816Padding = function(blockSize, byteCount)
-
-    local paddingCount = blockSize - (byteCount % blockSize);
-    local bytesLeft = paddingCount;
-
-    local stream = function()
-        if bytesLeft == paddingCount then
-            bytesLeft = bytesLeft - 1;
-            return 0x80;
-        elseif bytesLeft > 0 then
-            bytesLeft = bytesLeft - 1;
-            return 0x00;
-        else
-            return nil;
-        end
-    end
-
-    return stream;
-
-end
-
-return ISOIEC7816Padding;

lockbox/padding/pkcs7.lua

@@ -1,18 +0,0 @@
-local PKCS7Padding = function(blockSize, byteCount)
-
-    local paddingCount = blockSize - ((byteCount -1) % blockSize) + 1;
-    local bytesLeft = paddingCount;
-
-    local stream = function()
-        if bytesLeft > 0 then
-            bytesLeft = bytesLeft - 1;
-            return paddingCount;
-        else
-            return nil;
-        end
-    end
-
-    return stream;
-end
-
-return PKCS7Padding;

lockbox/padding/zero.lua

@@ -1,19 +0,0 @@
-local ZeroPadding = function(blockSize, byteCount)
-
-    local paddingCount = blockSize - ((byteCount -1) % blockSize) + 1;
-    local bytesLeft = paddingCount;
-
-    local stream = function()
-        if bytesLeft > 0 then
-            bytesLeft = bytesLeft - 1;
-            return 0x00;
-        else
-            return nil;
-        end
-    end
-
-    return stream;
-
-end
-
-return ZeroPadding;

lockbox/util/bit.lua

@@ -1,25 +1,19 @@
-local ok, e
+-- modified (simplified) for ComputerCraft
-ok = nil
+
-if not ok then
+local ok, e = nil, nil
-    ok, e = pcall(require, "bit") -- the LuaJIT one ?
+
-end
 if not ok then
     ok, e = pcall(require, "bit32") -- Lua 5.2
 end
+
 if not ok then
-    ok, e = pcall(require, "bit.numberlua") -- for Lua 5.1, https://github.com/tst2005/lua-bit-numberlua/
+    ok, e = pcall(require, "bit")
 end
+
 if not ok then
     error("no bitwise support found", 2)
 end
+
 assert(type(e) == "table", "invalid bit module")
 
--- Workaround to support Lua 5.2 bit32 API with the LuaJIT bit one
-if e.rol and not e.lrotate then
-    e.lrotate = e.rol
-end
-if e.ror and not e.rrotate then
-    e.rrotate = e.ror
-end
-
 return e

pocket/config.lua

@@ -1,15 +1,19 @@
 local config = {}
 
--- port of the SCADA supervisor
+-- supervisor comms channel
-config.SCADA_SV_PORT = 16100
+config.SVR_CHANNEL = 16240
--- port for SCADA coordinator API access
+-- coordinator comms channel
-config.SCADA_API_PORT = 16200
+config.CRD_CHANNEL = 16243
--- port to listen to incoming packets FROM servers
+-- pocket comms channel
-config.LISTEN_PORT = 16201
+config.PKT_CHANNEL = 16244
 -- max trusted modem message distance (0 to disable check)
 config.TRUSTED_RANGE = 0
 -- time in seconds (>= 2) before assuming a remote device is no longer active
 config.COMMS_TIMEOUT = 5
+-- facility authentication key (do NOT use one of your passwords)
+-- this enables verifying that messages are authentic
+-- all devices on the same network must use the same key
+-- config.AUTH_KEY = "SCADAfacility123"
 
 -- log path
 config.LOG_PATH = "/log.txt"

pocket/pocket.lua

@@ -17,23 +17,25 @@ local pocket = {}
 -- pocket coordinator + supervisor communications
 ---@nodiscard
 ---@param version string pocket version
----@param modem table modem device
+---@param nic nic network interface device
----@param local_port integer local pocket port
+---@param pkt_channel integer pocket comms channel
----@param sv_port integer port of supervisor
+---@param svr_channel integer supervisor access channel
----@param api_port integer port of coordinator API
+---@param crd_channel integer coordinator access channel
 ---@param range integer trusted device connection range
 ---@param sv_watchdog watchdog
 ---@param api_watchdog watchdog
-function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_watchdog, api_watchdog)
+function pocket.comms(version, nic, pkt_channel, svr_channel, crd_channel, range, sv_watchdog, api_watchdog)
     local self = {
         sv = {
             linked = false,
+            addr = comms.BROADCAST,
             seq_num = 0,
             r_seq_num = nil,    ---@type nil|integer
             last_est_ack = ESTABLISH_ACK.ALLOW
         },
         api = {
             linked = false,
+            addr = comms.BROADCAST,
             seq_num = 0,
             r_seq_num = nil,    ---@type nil|integer
             last_est_ack = ESTABLISH_ACK.ALLOW
@@ -45,13 +47,9 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
 
     -- PRIVATE FUNCTIONS --
 
-    -- configure modem channels
+    -- configure network channels
-    local function _conf_channels()
+    nic.closeAll()
-        modem.closeAll()
+    nic.open(pkt_channel)
-        modem.open(local_port)
-    end
-
-    _conf_channels()
 
     -- send a management packet to the supervisor
     ---@param msg_type SCADA_MGMT_TYPE
@@ -61,9 +59,9 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
         local pkt = comms.mgmt_packet()
 
         pkt.make(msg_type, msg)
-        s_pkt.make(self.sv.seq_num, PROTOCOL.SCADA_MGMT, pkt.raw_sendable())
+        s_pkt.make(self.sv.addr, self.sv.seq_num, PROTOCOL.SCADA_MGMT, pkt.raw_sendable())
 
-        modem.transmit(sv_port, local_port, s_pkt.raw_sendable())
+        nic.transmit(svr_channel, pkt_channel, s_pkt)
         self.sv.seq_num = self.sv.seq_num + 1
     end
 
@@ -75,9 +73,9 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
         local pkt = comms.mgmt_packet()
 
         pkt.make(msg_type, msg)
-        s_pkt.make(self.api.seq_num, PROTOCOL.SCADA_MGMT, pkt.raw_sendable())
+        s_pkt.make(self.api.addr, self.api.seq_num, PROTOCOL.SCADA_MGMT, pkt.raw_sendable())
 
-        modem.transmit(api_port, local_port, s_pkt.raw_sendable())
+        nic.transmit(crd_channel, pkt_channel, s_pkt)
         self.api.seq_num = self.api.seq_num + 1
     end
 
@@ -89,9 +87,9 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
     --     local pkt = comms.capi_packet()
 
     --     pkt.make(msg_type, msg)
-    --     s_pkt.make(self.api.seq_num, PROTOCOL.COORD_API, pkt.raw_sendable())
+    --     s_pkt.make(self.api.addr, self.api.seq_num, PROTOCOL.COORD_API, pkt.raw_sendable())
 
-    --     modem.transmit(api_port, local_port, s_pkt.raw_sendable())
+    --     nic.transmit(crd_channel, pkt_channel, s_pkt)
     --     self.api.seq_num = self.api.seq_num + 1
     -- end
 
@@ -122,17 +120,12 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
     ---@class pocket_comms
     local public = {}
 
-    -- reconnect a newly connected modem
-    ---@param new_modem table
-    function public.reconnect_modem(new_modem)
-        modem = new_modem
-        _conf_channels()
-    end
-
     -- close connection to the supervisor
     function public.close_sv()
         sv_watchdog.cancel()
         self.sv.linked = false
+        self.sv.r_seq_num = nil
+        self.sv.addr = comms.BROADCAST
         _send_sv(SCADA_MGMT_TYPE.CLOSE, {})
     end
 
@@ -140,6 +133,8 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
     function public.close_api()
         api_watchdog.cancel()
         self.api.linked = false
+        self.api.r_seq_num = nil
+        self.api.addr = comms.BROADCAST
         _send_crd(SCADA_MGMT_TYPE.CLOSE, {})
     end
 
@@ -183,13 +178,10 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
     ---@param distance integer
     ---@return mgmt_frame|capi_frame|nil packet
     function public.parse_packet(side, sender, reply_to, message, distance)
+        local s_pkt = nic.receive(side, sender, reply_to, message, distance)
         local pkt = nil
-        local s_pkt = comms.scada_packet()
 
-        -- parse packet as generic SCADA packet
+        if s_pkt then
-        s_pkt.receive(side, sender, reply_to, message, distance)
-
-        if s_pkt.is_valid() then
             -- get as SCADA management packet
             if s_pkt.protocol() == PROTOCOL.SCADA_MGMT then
                 local mgmt_pkt = comms.mgmt_packet()
@@ -214,18 +206,23 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
     ---@param packet mgmt_frame|capi_frame|nil
     function public.handle_packet(packet)
         if packet ~= nil then
-            local l_port = packet.scada_frame.local_port()
+            local l_chan   = packet.scada_frame.local_channel()
-            local r_port = packet.scada_frame.remote_port()
+            local r_chan   = packet.scada_frame.remote_channel()
             local protocol = packet.scada_frame.protocol()
+            local src_addr = packet.scada_frame.src_addr()
 
-            if l_port ~= local_port then
+            if l_chan ~= pkt_channel then
-                log.debug("received packet on unconfigured channel " .. l_port, true)
+                log.debug("received packet on unconfigured channel " .. l_chan, true)
-            elseif r_port == api_port then
+            elseif r_chan == crd_channel then
                 -- check sequence number
                 if self.api.r_seq_num == nil then
                     self.api.r_seq_num = packet.scada_frame.seq_num()
                 elseif self.connected and ((self.api.r_seq_num + 1) ~= packet.scada_frame.seq_num()) then
-                    log.warning("sequence out-of-order: last = " .. self.api.r_seq_num .. ", new = " .. packet.scada_frame.seq_num())
+                    log.warning("sequence out-of-order (API): last = " .. self.api.r_seq_num .. ", new = " .. packet.scada_frame.seq_num())
+                    return
+                elseif self.api.linked and (src_addr ~= self.api.addr) then
+                    log.debug("received packet from unknown computer " .. src_addr .. " while linked (API expected " .. self.api.addr ..
+                                "); channel in use by another system?")
                     return
                 else
                     self.api.r_seq_num = packet.scada_frame.seq_num()
@@ -247,6 +244,7 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
                                 log.info("coordinator connection established")
                                 self.establish_delay_counter = 0
                                 self.api.linked = true
+                                self.api.addr = src_addr
 
                                 if self.sv.linked then
                                     coreio.report_link_state(LINK_STATE.LINKED)
@@ -294,6 +292,8 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
                             -- handle session close
                             api_watchdog.cancel()
                             self.api.linked = false
+                            self.api.r_seq_num = nil
+                            self.api.addr = comms.BROADCAST
                             log.info("coordinator server connection closed by remote host")
                         else
                             log.debug("received unknown SCADA_MGMT packet type " .. packet.type .. " from coordinator")
@@ -304,12 +304,16 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
                 else
                     log.debug("illegal packet type " .. protocol .. " from coordinator", true)
                 end
-            elseif r_port == sv_port then
+            elseif r_chan == svr_channel then
                 -- check sequence number
                 if self.sv.r_seq_num == nil then
                     self.sv.r_seq_num = packet.scada_frame.seq_num()
                 elseif self.connected and ((self.sv.r_seq_num + 1) ~= packet.scada_frame.seq_num()) then
-                    log.warning("sequence out-of-order: last = " .. self.sv.r_seq_num .. ", new = " .. packet.scada_frame.seq_num())
+                    log.warning("sequence out-of-order (SVR): last = " .. self.sv.r_seq_num .. ", new = " .. packet.scada_frame.seq_num())
+                    return
+                elseif self.sv.linked and (src_addr ~= self.sv.addr) then
+                    log.debug("received packet from unknown computer " .. src_addr .. " while linked (SVR expected " .. self.sv.addr ..
+                                "); channel in use by another system?")
                     return
                 else
                     self.sv.r_seq_num = packet.scada_frame.seq_num()
@@ -330,6 +334,7 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
                                 log.info("supervisor connection established")
                                 self.establish_delay_counter = 0
                                 self.sv.linked = true
+                                self.sv.addr = src_addr
 
                                 if self.api.linked then
                                     coreio.report_link_state(LINK_STATE.LINKED)
@@ -377,6 +382,8 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
                             -- handle session close
                             sv_watchdog.cancel()
                             self.sv.linked = false
+                            self.sv.r_seq_num = nil
+                            self.sv.addr = comms.BROADCAST
                             log.info("supervisor server connection closed by remote host")
                         else
                             log.debug("received unknown SCADA_MGMT packet type " .. packet.type .. " from supervisor")
@@ -388,7 +395,7 @@ function pocket.comms(version, modem, local_port, sv_port, api_port, range, sv_w
                     log.debug("illegal packet type " .. protocol .. " from supervisor", true)
                 end
             else
-                log.debug("received packet from unconfigured channel " .. r_port, true)
+                log.debug("received packet from unconfigured channel " .. r_chan, true)
             end
         end
     end

pocket/startup.lua

@@ -4,20 +4,21 @@
 
 require("/initenv").init_env()
 
-local crash        = require("scada-common.crash")
+local crash    = require("scada-common.crash")
-local log          = require("scada-common.log")
+local log      = require("scada-common.log")
-local ppm          = require("scada-common.ppm")
+local network  = require("scada-common.network")
-local tcallbackdsp = require("scada-common.tcallbackdsp")
+local ppm      = require("scada-common.ppm")
-local util         = require("scada-common.util")
+local tcd      = require("scada-common.tcd")
+local util     = require("scada-common.util")
 
-local core         = require("graphics.core")
+local core     = require("graphics.core")
 
-local config       = require("pocket.config")
+local config   = require("pocket.config")
-local coreio       = require("pocket.coreio")
+local coreio   = require("pocket.coreio")
-local pocket       = require("pocket.pocket")
+local pocket   = require("pocket.pocket")
-local renderer     = require("pocket.renderer")
+local renderer = require("pocket.renderer")
 
-local POCKET_VERSION = "alpha-v0.3.1"
+local POCKET_VERSION = "alpha-v0.5.1"
 
 local println = util.println
 local println_ts = util.println_ts
@@ -28,9 +29,9 @@ local println_ts = util.println_ts
 
 local cfv = util.new_validator()
 
-cfv.assert_port(config.SCADA_SV_PORT)
+cfv.assert_channel(config.SVR_CHANNEL)
-cfv.assert_port(config.SCADA_API_PORT)
+cfv.assert_channel(config.CRD_CHANNEL)
-cfv.assert_port(config.LISTEN_PORT)
+cfv.assert_channel(config.PKT_CHANNEL)
 cfv.assert_type_int(config.TRUSTED_RANGE)
 cfv.assert_type_num(config.COMMS_TIMEOUT)
 cfv.assert_min(config.COMMS_TIMEOUT, 2)
@@ -67,6 +68,11 @@ local function main()
     -- setup communications & clocks
     ----------------------------------------
 
+    -- message authentication init
+    if type(config.AUTH_KEY) == "string" then
+        network.init_mac(config.AUTH_KEY)
+    end
+
     coreio.report_link_state(coreio.LINK_STATE.UNLINKED)
 
     -- get the communications modem
@@ -88,9 +94,10 @@ local function main()
 
     log.debug("startup> conn watchdogs created")
 
-    -- start comms, open all channels
+    -- create network interface then setup comms
-    local pocket_comms = pocket.comms(POCKET_VERSION, modem, config.LISTEN_PORT, config.SCADA_SV_PORT,
+    local nic = network.nic(modem)
-                                        config.SCADA_API_PORT, config.TRUSTED_RANGE, conn_wd.sv, conn_wd.api)
+    local pocket_comms = pocket.comms(POCKET_VERSION, nic, config.PKT_CHANNEL, config.SVR_CHANNEL,
+                                        config.CRD_CHANNEL, config.TRUSTED_RANGE, conn_wd.sv, conn_wd.api)
     log.debug("startup> comms init")
 
     -- base loop clock (2Hz, 10 ticks)
@@ -120,54 +127,54 @@ local function main()
         conn_wd.sv.feed()
         conn_wd.api.feed()
         log.debug("startup> conn watchdog started")
-    end
 
-    -- main event loop
+        -- main event loop
-    while ui_ok do
+        while true do
-        local event, param1, param2, param3, param4, param5 = util.pull_event()
+            local event, param1, param2, param3, param4, param5 = util.pull_event()
 
-        -- handle event
+            -- handle event
-        if event == "timer" then
+            if event == "timer" then
-            if loop_clock.is_clock(param1) then
+                if loop_clock.is_clock(param1) then
-                -- main loop tick
+                    -- main loop tick
 
-                -- relink if necessary
+                    -- relink if necessary
-                pocket_comms.link_update()
+                    pocket_comms.link_update()
 
-                loop_clock.start()
+                    loop_clock.start()
-            elseif conn_wd.sv.is_timer(param1) then
+                elseif conn_wd.sv.is_timer(param1) then
-                -- supervisor watchdog timeout
+                    -- supervisor watchdog timeout
-                log.info("supervisor server timeout")
+                    log.info("supervisor server timeout")
-                pocket_comms.close_sv()
+                    pocket_comms.close_sv()
-            elseif conn_wd.api.is_timer(param1) then
+                elseif conn_wd.api.is_timer(param1) then
-                -- coordinator watchdog timeout
+                    -- coordinator watchdog timeout
-                log.info("coordinator api server timeout")
+                    log.info("coordinator api server timeout")
-                pocket_comms.close_api()
+                    pocket_comms.close_api()
-            else
+                else
-                -- a non-clock/main watchdog timer event
+                    -- a non-clock/main watchdog timer event
-                -- notify timer callback dispatcher
+                    -- notify timer callback dispatcher
-                tcallbackdsp.handle(param1)
+                    tcd.handle(param1)
+                end
+            elseif event == "modem_message" then
+                -- got a packet
+                local packet = pocket_comms.parse_packet(param1, param2, param3, param4, param5)
+                pocket_comms.handle_packet(packet)
+            elseif event == "mouse_click" or event == "mouse_up" or event == "mouse_drag" or event == "mouse_scroll" then
+                -- handle a monitor touch event
+                renderer.handle_mouse(core.events.new_mouse_event(event, param1, param2, param3))
+            end
+
+            -- check for termination request
+            if event == "terminate" or ppm.should_terminate() then
+                log.info("terminate requested, closing server connections...")
+                pocket_comms.close()
+                log.info("connections closed")
+                break
             end
-        elseif event == "modem_message" then
-            -- got a packet
-            local packet = pocket_comms.parse_packet(param1, param2, param3, param4, param5)
-            pocket_comms.handle_packet(packet)
-        elseif event == "mouse_click" or event == "mouse_up" or event == "mouse_drag" or event == "mouse_scroll" then
-            -- handle a monitor touch event
-            renderer.handle_mouse(core.events.new_mouse_event(event, param1, param2, param3))
         end
 
-        -- check for termination request
+        renderer.close_ui()
-        if event == "terminate" or ppm.should_terminate() then
-            log.info("terminate requested, closing server connections...")
-            pocket_comms.close()
-            log.info("connections closed")
-            break
-        end
     end
 
-    renderer.close_ui()
-
     println_ts("exited")
     log.info("exited")
 end

pocket/ui/components/conn_waiting.lua

@@ -25,7 +25,7 @@ local function init(parent, y, is_api)
     -- bounding box div
     local box = Div{parent=root,x=1,y=y,height=5}
 
-    local waiting_x = math.floor(parent.width() / 2) - 1
+    local waiting_x = math.floor(parent.get_width() / 2) - 1
 
     if is_api then
         WaitingAnim{parent=box,x=waiting_x,y=1,fg_bg=cpair(colors.blue,style.root.bkg)}

pocket/ui/main.lua

@@ -8,11 +8,11 @@ local style        = require("pocket.ui.style")
 
 local conn_waiting = require("pocket.ui.components.conn_waiting")
 
-local home_page    = require("pocket.ui.components.home_page")
+local home_page    = require("pocket.ui.pages.home_page")
-local unit_page    = require("pocket.ui.components.unit_page")
+local unit_page    = require("pocket.ui.pages.unit_page")
-local reactor_page = require("pocket.ui.components.reactor_page")
+local reactor_page = require("pocket.ui.pages.reactor_page")
-local boiler_page  = require("pocket.ui.components.boiler_page")
+local boiler_page  = require("pocket.ui.pages.boiler_page")
-local turbine_page = require("pocket.ui.components.turbine_page")
+local turbine_page = require("pocket.ui.pages.turbine_page")
 
 local core         = require("graphics.core")
 

reactor-plc/config.lua

@@ -9,14 +9,18 @@ config.REACTOR_ID = 1
 -- when emergency coolant is needed due to low coolant
 -- config.EMERGENCY_COOL = { side = "right", color = nil }
 
--- port to send packets TO server
+-- supervisor comms channel
-config.SERVER_PORT = 16000
+config.SVR_CHANNEL = 16240
--- port to listen to incoming packets FROM server
+-- PLC comms channel
-config.LISTEN_PORT = 14001
+config.PLC_CHANNEL = 16241
 -- max trusted modem message distance (0 to disable check)
 config.TRUSTED_RANGE = 0
 -- time in seconds (>= 2) before assuming a remote device is no longer active
 config.COMMS_TIMEOUT = 5
+-- facility authentication key (do NOT use one of your passwords)
+-- this enables verifying that messages are authentic
+-- all devices on the same network must use the same key
+-- config.AUTH_KEY = "SCADAfacility123"
 
 -- log path
 config.LOG_PATH = "/log.txt"

reactor-plc/panel/front_panel.lua

@@ -2,6 +2,7 @@
 -- Main SCADA Coordinator GUI
 --
 
+local types      = require("scada-common.types")
 local util       = require("scada-common.util")
 
 local config     = require("reactor-plc.config")
@@ -49,7 +50,7 @@ local function init(panel)
     local reactor = LEDPair{parent=system,label="REACTOR",off=colors.red,c1=colors.yellow,c2=colors.green}
     local modem = LED{parent=system,label="MODEM",colors=cpair(colors.green,colors.green_off)}
     local network = RGBLED{parent=system,label="NETWORK",colors={colors.green,colors.red,colors.orange,colors.yellow,colors.gray}}
-    network.update(5)
+    network.update(types.PANEL_LINK_STATE.DISCONNECTED)
     system.line_break()
 
     reactor.register(databus.ps, "reactor_dev_state", reactor.update)
@@ -69,6 +70,10 @@ local function init(panel)
     rt_cmrx.register(databus.ps, "routine__comms_rx", rt_cmrx.update)
     rt_sctl.register(databus.ps, "routine__spctl", rt_sctl.update)
 
+---@diagnostic disable-next-line: undefined-field
+    local comp_id = util.sprintf("(%d)", os.getComputerID())
+    TextBox{parent=system,x=9,y=5,width=6,height=1,text=comp_id,fg_bg=cpair(colors.lightGray,colors.ivory)}
+
     --
     -- status & controls
     --

reactor-plc/plc.lua

@@ -445,15 +445,16 @@ end
 ---@nodiscard
 ---@param id integer reactor ID
 ---@param version string PLC version
----@param modem table modem device
+---@param nic nic network interface device
----@param local_port integer local listening port
+---@param plc_channel integer PLC comms channel
----@param server_port integer remote server port
+---@param svr_channel integer supervisor server channel
 ---@param range integer trusted device connection range
 ---@param reactor table reactor device
 ---@param rps rps RPS reference
 ---@param conn_watchdog watchdog watchdog reference
-function plc.comms(id, version, modem, local_port, server_port, range, reactor, rps, conn_watchdog)
+function plc.comms(id, version, nic, plc_channel, svr_channel, range, reactor, rps, conn_watchdog)
     local self = {
+        sv_addr = comms.BROADCAST,
         seq_num = 0,
         r_seq_num = nil,
         scrammed = false,
@@ -469,13 +470,9 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
 
     -- PRIVATE FUNCTIONS --
 
-    -- configure modem channels
+    -- configure network channels
-    local function _conf_channels()
+    nic.closeAll()
-        modem.closeAll()
+    nic.open(plc_channel)
-        modem.open(local_port)
-    end
-
-    _conf_channels()
 
     -- send an RPLC packet
     ---@param msg_type RPLC_TYPE
@@ -485,9 +482,9 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
         local r_pkt = comms.rplc_packet()
 
         r_pkt.make(id, msg_type, msg)
-        s_pkt.make(self.seq_num, PROTOCOL.RPLC, r_pkt.raw_sendable())
+        s_pkt.make(self.sv_addr, self.seq_num, PROTOCOL.RPLC, r_pkt.raw_sendable())
 
-        modem.transmit(server_port, local_port, s_pkt.raw_sendable())
+        nic.transmit(svr_channel, plc_channel, s_pkt)
         self.seq_num = self.seq_num + 1
     end
 
@@ -499,9 +496,9 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
         local m_pkt = comms.mgmt_packet()
 
         m_pkt.make(msg_type, msg)
-        s_pkt.make(self.seq_num, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
+        s_pkt.make(self.sv_addr, self.seq_num, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
 
-        modem.transmit(server_port, local_port, s_pkt.raw_sendable())
+        nic.transmit(svr_channel, plc_channel, s_pkt)
         self.seq_num = self.seq_num + 1
     end
 
@@ -638,7 +635,7 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
 
         parallel.waitForAll(table.unpack(tasks))
 
-        if not reactor.__p_is_faulted() then
+        if reactor.__p_is_ok() then
             _send(RPLC_TYPE.MEK_STRUCT, mek_data)
             self.resend_build = false
         end
@@ -649,13 +646,6 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
     ---@class plc_comms
     local public = {}
 
-    -- reconnect a newly connected modem
-    ---@param new_modem table
-    function public.reconnect_modem(new_modem)
-        modem = new_modem
-        _conf_channels()
-    end
-
     -- reconnect a newly connected reactor
     ---@param new_reactor table
     function public.reconnect_reactor(new_reactor)
@@ -667,9 +657,11 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
 
     -- unlink from the server
     function public.unlink()
+        self.sv_addr = comms.BROADCAST
         self.linked = false
         self.r_seq_num = nil
         self.status_cache = nil
+        databus.tx_link_state(types.PANEL_LINK_STATE.DISCONNECTED)
     end
 
     -- close the connection to the server
@@ -731,7 +723,7 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
         end
     end
 
-    -- parse an RPLC packet
+    -- parse a packet
     ---@nodiscard
     ---@param side string
     ---@param sender integer
@@ -740,13 +732,10 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
     ---@param distance integer
     ---@return rplc_frame|mgmt_frame|nil packet
     function public.parse_packet(side, sender, reply_to, message, distance)
+        local s_pkt = nic.receive(side, sender, reply_to, message, distance)
         local pkt = nil
-        local s_pkt = comms.scada_packet()
 
-        -- parse packet as generic SCADA packet
+        if s_pkt then
-        s_pkt.receive(side, sender, reply_to, message, distance)
-
-        if s_pkt.is_valid() then
             -- get as RPLC packet
             if s_pkt.protocol() == PROTOCOL.RPLC then
                 local rplc_pkt = comms.rplc_packet()
@@ -760,14 +749,14 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
                     pkt = mgmt_pkt.get()
                 end
             else
-                log.debug("illegal packet type " .. s_pkt.protocol(), true)
+                log.debug("unsupported packet type " .. s_pkt.protocol(), true)
             end
         end
 
         return pkt
     end
 
-    -- handle an RPLC packet
+    -- handle RPLC and MGMT packets
     ---@param packet rplc_frame|mgmt_frame packet frame
     ---@param plc_state plc_state PLC state
     ---@param setpoints setpoints setpoint control table
@@ -775,16 +764,22 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
         -- print a log message to the terminal as long as the UI isn't running
         local function println_ts(message) if not plc_state.fp_ok then util.println_ts(message) end end
 
-        local l_port = packet.scada_frame.local_port()
+        local protocol = packet.scada_frame.protocol()
+        local l_chan   = packet.scada_frame.local_channel()
+        local src_addr = packet.scada_frame.src_addr()
 
         -- handle packets now that we have prints setup
-        if l_port == local_port then
+        if l_chan == plc_channel then
             -- check sequence number
             if self.r_seq_num == nil then
                 self.r_seq_num = packet.scada_frame.seq_num()
             elseif self.linked and ((self.r_seq_num + 1) ~= packet.scada_frame.seq_num()) then
                 log.warning("sequence out-of-order: last = " .. self.r_seq_num .. ", new = " .. packet.scada_frame.seq_num())
                 return
+            elseif self.linked and (src_addr ~= self.sv_addr) then
+                log.debug("received packet from unknown computer " .. src_addr .. " while linked (expected " .. self.sv_addr ..
+                            "); channel in use by another system?")
+                return
             else
                 self.r_seq_num = packet.scada_frame.seq_num()
             end
@@ -792,11 +787,10 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
             -- feed the watchdog first so it doesn't uhh...eat our packets :)
             conn_watchdog.feed()
 
-            local protocol = packet.scada_frame.protocol()
-
             -- handle packet
             if protocol == PROTOCOL.RPLC then
                 ---@cast packet rplc_frame
+                -- if linked, only accept packets from configured supervisor
                 if self.linked then
                     if packet.type == RPLC_TYPE.STATUS then
                         -- request of full status, clear cache first
@@ -828,7 +822,7 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
                                         success = true
                                     else
                                         reactor.setBurnRate(burn_rate)
-                                        success = not reactor.__p_is_faulted()
+                                        success = reactor.__p_is_ok()
                                     end
                                 else
                                     log.debug(burn_rate .. " rate outside of 0 < x <= " .. self.max_burn_rate)
@@ -933,6 +927,7 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
                 end
             elseif protocol == PROTOCOL.SCADA_MGMT then
                 ---@cast packet mgmt_frame
+                -- if linked, only accept packets from configured supervisor
                 if self.linked then
                     if packet.type == SCADA_MGMT_TYPE.ESTABLISH then
                         -- link request confirmation
@@ -945,22 +940,26 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
                                 self.status_cache = nil
                                 _send_struct()
                                 public.send_status(plc_state.no_reactor, plc_state.reactor_formed)
-                                log.debug("re-sent initial status data")
+                                log.debug("re-sent initial status data due to re-establish")
-                            elseif est_ack == ESTABLISH_ACK.DENY then
-                                println_ts("received unsolicited link denial, unlinking")
-                                log.warning("unsolicited establish request denied")
-                            elseif est_ack == ESTABLISH_ACK.COLLISION then
-                                println_ts("received unsolicited link collision, unlinking")
-                                log.warning("unsolicited establish request collision")
-                            elseif est_ack == ESTABLISH_ACK.BAD_VERSION then
-                                println_ts("received unsolicited link version mismatch, unlinking")
-                                log.warning("unsolicited establish request version mismatch")
                             else
-                                println_ts("invalid unsolicited link response")
+                                if est_ack == ESTABLISH_ACK.DENY then
-                                log.debug("unsolicited unknown establish request response")
+                                    println_ts("received unsolicited link denial, unlinking")
-                            end
+                                    log.warning("unsolicited establish request denied")
+                                elseif est_ack == ESTABLISH_ACK.COLLISION then
+                                    println_ts("received unsolicited link collision, unlinking")
+                                    log.warning("unsolicited establish request collision")
+                                elseif est_ack == ESTABLISH_ACK.BAD_VERSION then
+                                    println_ts("received unsolicited link version mismatch, unlinking")
+                                    log.warning("unsolicited establish request version mismatch")
+                                else
+                                    println_ts("invalid unsolicited link response")
+                                    log.debug("unsolicited unknown establish request response")
+                                end
 
-                            self.linked = est_ack == ESTABLISH_ACK.ALLOW
+                                -- unlink
+                                self.sv_addr = comms.BROADCAST
+                                self.linked = false
+                            end
 
                             -- clear this since this is for something that was unsolicited
                             self.last_est_ack = ESTABLISH_ACK.ALLOW
@@ -980,7 +979,7 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
                                 log.warning("PLC KEEP_ALIVE trip time > 750ms (" .. trip_time .. "ms)")
                             end
 
-                            -- log.debug("RPLC RTT = " .. trip_time .. "ms")
+                            -- log.debug("PLC RTT = " .. trip_time .. "ms")
 
                             _send_keep_alive_ack(timestamp)
                         else
@@ -1002,9 +1001,11 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
 
                         if est_ack == ESTABLISH_ACK.ALLOW then
                             println_ts("linked!")
-                            log.info("supervisor establish request approved, PLC is linked")
+                            log.info("supervisor establish request approved, linked to SV (CID#" .. src_addr .. ")")
 
-                            -- reset remote sequence number and cache
+                            -- link + reset remote sequence number and cache
+                            self.sv_addr = src_addr
+                            self.linked = true
                             self.r_seq_num = nil
                             self.status_cache = nil
 
@@ -1012,23 +1013,28 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
                             public.send_status(plc_state.no_reactor, plc_state.reactor_formed)
 
                             log.debug("sent initial status data")
-                        elseif self.last_est_ack ~= est_ack then
+                        else
-                            if est_ack == ESTABLISH_ACK.DENY then
+                            if self.last_est_ack ~= est_ack then
-                                println_ts("link request denied, retrying...")
+                                if est_ack == ESTABLISH_ACK.DENY then
-                                log.info("supervisor establish request denied, retrying")
+                                    println_ts("link request denied, retrying...")
-                            elseif est_ack == ESTABLISH_ACK.COLLISION then
+                                    log.info("supervisor establish request denied, retrying")
-                                println_ts("reactor PLC ID collision (check config), retrying...")
+                                elseif est_ack == ESTABLISH_ACK.COLLISION then
-                                log.warning("establish request collision, retrying")
+                                    println_ts("reactor PLC ID collision (check config), retrying...")
-                            elseif est_ack == ESTABLISH_ACK.BAD_VERSION then
+                                    log.warning("establish request collision, retrying")
-                                println_ts("supervisor version mismatch (try updating), retrying...")
+                                elseif est_ack == ESTABLISH_ACK.BAD_VERSION then
-                                log.warning("establish request version mismatch, retrying")
+                                    println_ts("supervisor version mismatch (try updating), retrying...")
-                            else
+                                    log.warning("establish request version mismatch, retrying")
-                                println_ts("invalid link response, bad channel? retrying...")
+                                else
-                                log.error("unknown establish request response, retrying")
+                                    println_ts("invalid link response, bad channel? retrying...")
+                                    log.error("unknown establish request response, retrying")
+                                end
                             end
+
+                            -- unlink
+                            self.sv_addr = comms.BROADCAST
+                            self.linked = false
                         end
 
-                        self.linked = est_ack == ESTABLISH_ACK.ALLOW
                         self.last_est_ack = est_ack
 
                         -- report link state
@@ -1044,7 +1050,7 @@ function plc.comms(id, version, modem, local_port, server_port, range, reactor,
                 log.error("illegal packet type " .. protocol, true)
             end
         else
-            log.debug("received packet on unconfigured channel " .. l_port, true)
+            log.debug("received packet on unconfigured channel " .. l_chan, true)
         end
     end
 

reactor-plc/startup.lua

@@ -8,6 +8,7 @@ local comms    = require("scada-common.comms")
 local crash    = require("scada-common.crash")
 local log      = require("scada-common.log")
 local mqueue   = require("scada-common.mqueue")
+local network  = require("scada-common.network")
 local ppm      = require("scada-common.ppm")
 local rsio     = require("scada-common.rsio")
 local util     = require("scada-common.util")
@@ -18,7 +19,7 @@ local plc      = require("reactor-plc.plc")
 local renderer = require("reactor-plc.renderer")
 local threads  = require("reactor-plc.threads")
 
-local R_PLC_VERSION = "v1.3.1"
+local R_PLC_VERSION = "v1.5.0"
 
 local println = util.println
 local println_ts = util.println_ts
@@ -31,8 +32,8 @@ local cfv = util.new_validator()
 
 cfv.assert_type_bool(config.NETWORKED)
 cfv.assert_type_int(config.REACTOR_ID)
-cfv.assert_port(config.SERVER_PORT)
+cfv.assert_channel(config.SVR_CHANNEL)
-cfv.assert_port(config.LISTEN_PORT)
+cfv.assert_channel(config.PLC_CHANNEL)
 cfv.assert_type_int(config.TRUSTED_RANGE)
 cfv.assert_type_num(config.COMMS_TIMEOUT)
 cfv.assert_min(config.COMMS_TIMEOUT, 2)
@@ -79,6 +80,11 @@ local function main()
     -- mount connected devices
     ppm.mount_all()
 
+    -- message authentication init
+    if type(config.AUTH_KEY) == "string" then
+        network.init_mac(config.AUTH_KEY)
+    end
+
     -- shared memory across threads
     ---@class plc_shared_memory
     local __shared_memory = {
@@ -88,13 +94,13 @@ local function main()
         -- PLC system state flags
         ---@class plc_state
         plc_state = {
-            init_ok = true,
+            init_ok        = true,
-            fp_ok = false,
+            fp_ok          = false,
-            shutdown = false,
+            shutdown       = false,
-            degraded = false,
+            degraded       = true,
             reactor_formed = true,
-            no_reactor = false,
+            no_reactor     = true,
-            no_modem = false
+            no_modem       = true
         },
 
         -- control setpoints
@@ -113,6 +119,7 @@ local function main()
         -- system objects
         plc_sys = {
             rps = nil,              ---@type rps
+            nic = nil,              ---@type nic
             plc_comms = nil,        ---@type plc_comms
             conn_watchdog = nil     ---@type watchdog
         },
@@ -130,14 +137,17 @@ local function main()
 
     local plc_state = __shared_memory.plc_state
 
+    -- initial state evaluation
+    plc_state.no_reactor = smem_dev.reactor == nil
+    plc_state.no_modem = smem_dev.modem == nil
+
     -- we need a reactor, can at least do some things even if it isn't formed though
-    if smem_dev.reactor == nil then
+    if plc_state.no_reactor then
         println("init> fission reactor not found");
         log.warning("init> no reactor on startup")
 
         plc_state.init_ok = false
         plc_state.degraded = true
-        plc_state.no_reactor = true
     elseif not smem_dev.reactor.isFormed() then
         println("init> fission reactor not formed");
         log.warning("init> reactor logic adapter present, but reactor is not formed")
@@ -147,7 +157,7 @@ local function main()
     end
 
     -- modem is required if networked
-    if __shared_memory.networked and smem_dev.modem == nil then
+    if __shared_memory.networked and plc_state.no_modem then
         println("init> wireless modem not found")
         log.warning("init> no wireless modem on startup")
 
@@ -158,7 +168,6 @@ local function main()
 
         plc_state.init_ok = false
         plc_state.degraded = true
-        plc_state.no_modem = true
     end
 
     -- print a log message to the terminal as long as the UI isn't running
@@ -196,8 +205,9 @@ local function main()
                 smem_sys.conn_watchdog = util.new_watchdog(config.COMMS_TIMEOUT)
                 log.debug("init> conn watchdog started")
 
-                -- start comms
+                -- create network interface then setup comms
-                smem_sys.plc_comms = plc.comms(config.REACTOR_ID, R_PLC_VERSION, smem_dev.modem, config.LISTEN_PORT, config.SERVER_PORT,
+                smem_sys.nic = network.nic(smem_dev.modem)
+                smem_sys.plc_comms = plc.comms(config.REACTOR_ID, R_PLC_VERSION, smem_sys.nic, config.PLC_CHANNEL, config.SVR_CHANNEL,
                                                 config.TRUSTED_RANGE, smem_dev.reactor, smem_sys.rps, smem_sys.conn_watchdog)
                 log.debug("init> comms init")
             else

reactor-plc/threads.lua

@@ -1,13 +1,13 @@
-local log          = require("scada-common.log")
+local log      = require("scada-common.log")
-local mqueue       = require("scada-common.mqueue")
+local mqueue   = require("scada-common.mqueue")
-local ppm          = require("scada-common.ppm")
+local ppm      = require("scada-common.ppm")
-local tcallbackdsp = require("scada-common.tcallbackdsp")
+local tcd      = require("scada-common.tcd")
-local util         = require("scada-common.util")
+local util     = require("scada-common.util")
 
-local databus      = require("reactor-plc.databus")
+local databus  = require("reactor-plc.databus")
-local renderer     = require("reactor-plc.renderer")
+local renderer = require("reactor-plc.renderer")
 
-local core         = require("graphics.core")
+local core     = require("graphics.core")
 
 local threads = {}
 
@@ -59,6 +59,7 @@ function threads.thread__main(smem, init)
         while true do
             -- get plc_sys fields (may have been set late due to degraded boot)
             local rps           = smem.plc_sys.rps
+            local nic           = smem.plc_sys.nic
             local plc_comms     = smem.plc_sys.plc_comms
             local conn_watchdog = smem.plc_sys.conn_watchdog
 
@@ -66,6 +67,7 @@ function threads.thread__main(smem, init)
 
             -- handle event
             if event == "timer" and loop_clock.is_clock(param1) then
+                -- note: loop clock is only running if init_ok = true
                 -- blink heartbeat indicator
                 databus.heartbeat()
 
@@ -75,7 +77,7 @@ function threads.thread__main(smem, init)
                     loop_clock.start()
 
                     -- send updated data
-                    if not plc_state.no_modem then
+                    if nic.connected() then
                         if plc_comms.is_linked() then
                             smem.q.mq_comms_tx.push_command(MQ__COMM_CMD.SEND_STATUS)
                         else
@@ -114,7 +116,7 @@ function threads.thread__main(smem, init)
                             smem.q.mq_rps.push_command(MQ__RPS_CMD.SCRAM)
 
                             -- determine if we are still in a degraded state
-                            if not networked or not plc_state.no_modem then
+                            if (not networked) or nic.connected() then
                                 plc_state.degraded = false
                             end
 
@@ -144,7 +146,7 @@ function threads.thread__main(smem, init)
 
                 -- update indicators
                 databus.tx_hw_status(plc_state)
-            elseif event == "modem_message" and networked and plc_state.init_ok and not plc_state.no_modem then
+            elseif event == "modem_message" and networked and plc_state.init_ok and nic.connected() then
                 -- got a packet
                 local packet = plc_comms.parse_packet(param1, param2, param3, param4, param5)
                 if packet ~= nil then
@@ -157,7 +159,7 @@ function threads.thread__main(smem, init)
                 smem.q.mq_rps.push_command(MQ__RPS_CMD.TRIP_TIMEOUT)
             elseif event == "timer" then
                 -- notify timer callback dispatcher if no other timer case claimed this event
-                tcallbackdsp.handle(param1)
+                tcd.handle(param1)
             elseif event == "peripheral_detach" then
                 -- peripheral disconnect
                 local type, device = ppm.handle_unmount(param1)
@@ -171,7 +173,9 @@ function threads.thread__main(smem, init)
                         plc_state.degraded = true
                     elseif networked and type == "modem" then
                         -- we only care if this is our wireless modem
-                        if device == plc_dev.modem then
+                        if nic.is_modem(device) then
+                            nic.disconnect()
+
                             println_ts("comms modem disconnected!")
                             log.error("comms modem disconnected")
 
@@ -199,12 +203,11 @@ function threads.thread__main(smem, init)
                     if type == "fissionReactorLogicAdapter" then
                         -- reconnected reactor
                         plc_dev.reactor = device
+                        plc_state.no_reactor = false
 
                         println_ts("reactor reconnected.")
                         log.info("reactor reconnected")
 
-                        plc_state.no_reactor = false
-
                         -- we need to assume formed here as we cannot check in this main loop
                         -- RPS will identify if it isn't and this will get set false later
                         plc_state.reactor_formed = true
@@ -230,14 +233,12 @@ function threads.thread__main(smem, init)
                         if device.isWireless() then
                             -- reconnected modem
                             plc_dev.modem = device
+                            plc_state.no_modem = false
 
-                            if plc_state.init_ok then
+                            if plc_state.init_ok then nic.connect(device) end
-                                plc_comms.reconnect_modem(plc_dev.modem)
-                            end
 
                             println_ts("wireless modem reconnected.")
                             log.info("comms modem reconnected")
-                            plc_state.no_modem = false
 
                             -- determine if we are still in a degraded state
                             if not plc_state.no_reactor then
@@ -709,9 +710,7 @@ function threads.thread__setpoint_control(smem)
                 end
 
                 -- if ramping completed or was aborted, reset last burn setpoint so that if it is requested again it will be re-attempted
-                if not setpoints.burn_rate_en then
+                if not setpoints.burn_rate_en then last_burn_sp = 0 end
-                    last_burn_sp = 0
-                end
             end
 
             -- check for termination request

rtu/config.lua

@@ -2,14 +2,18 @@ local rsio = require("scada-common.rsio")
 
 local config = {}
 
--- port to send packets TO server
+-- supervisor comms channel
-config.SERVER_PORT = 16000
+config.SVR_CHANNEL = 16240
--- port to listen to incoming packets FROM server
+-- RTU/MODBUS comms channel
-config.LISTEN_PORT = 15001
+config.RTU_CHANNEL = 16242
--- max trusted modem message distance (< 1 to disable check)
+-- max trusted modem message distance (0 to disable check)
 config.TRUSTED_RANGE = 0
 -- time in seconds (>= 2) before assuming a remote device is no longer active
 config.COMMS_TIMEOUT = 5
+-- facility authentication key (do NOT use one of your passwords)
+-- this enables verifying that messages are authentic
+-- all devices on the same network must use the same key
+-- config.AUTH_KEY = "SCADAfacility123"
 
 -- log path
 config.LOG_PATH = "/log.txt"

rtu/dev/boilerv_rtu.lua

@@ -10,6 +10,7 @@ function boilerv_rtu.new(boiler)
     local unit = rtu.init_unit()
 
     -- disable auto fault clearing
+    boiler.__p_clear_fault()
     boiler.__p_disable_afc()
 
     -- discrete inputs --

rtu/dev/envd_rtu.lua

@@ -10,6 +10,7 @@ function envd_rtu.new(envd)
     local unit = rtu.init_unit()
 
     -- disable auto fault clearing
+    envd.__p_clear_fault()
     envd.__p_disable_afc()
 
     -- discrete inputs --

rtu/dev/imatrix_rtu.lua

@@ -10,6 +10,7 @@ function imatrix_rtu.new(imatrix)
     local unit = rtu.init_unit()
 
     -- disable auto fault clearing
+    imatrix.__p_clear_fault()
     imatrix.__p_disable_afc()
 
     -- discrete inputs --

rtu/dev/sna_rtu.lua

@@ -10,6 +10,7 @@ function sna_rtu.new(sna)
     local unit = rtu.init_unit()
 
     -- disable auto fault clearing
+    sna.__p_clear_fault()
     sna.__p_disable_afc()
 
     -- discrete inputs --

rtu/dev/sps_rtu.lua

@@ -10,6 +10,7 @@ function sps_rtu.new(sps)
     local unit = rtu.init_unit()
 
     -- disable auto fault clearing
+    sps.__p_clear_fault()
     sps.__p_disable_afc()
 
     -- discrete inputs --

rtu/dev/turbinev_rtu.lua

@@ -10,6 +10,7 @@ function turbinev_rtu.new(turbine)
     local unit = rtu.init_unit()
 
     -- disable auto fault clearing
+    turbine.__p_clear_fault()
     turbine.__p_disable_afc()
 
     -- discrete inputs --

rtu/panel/front_panel.lua

@@ -2,6 +2,7 @@
 -- Main SCADA Coordinator GUI
 --
 
+local types      = require("scada-common.types")
 local util       = require("scada-common.util")
 
 local databus    = require("rtu.databus")
@@ -44,7 +45,7 @@ local function init(panel, units)
 
     local system = Div{parent=panel,width=14,height=18,x=2,y=3}
 
-    local on = LED{parent=system,label="POWER",colors=cpair(colors.green,colors.red)}
+    local on = LED{parent=system,label="STATUS",colors=cpair(colors.green,colors.red)}
     local heartbeat = LED{parent=system,label="HEARTBEAT",colors=cpair(colors.green,colors.green_off)}
     on.update(true)
     system.line_break()
@@ -53,7 +54,7 @@ local function init(panel, units)
 
     local modem = LED{parent=system,label="MODEM",colors=cpair(colors.green,colors.green_off)}
     local network = RGBLED{parent=system,label="NETWORK",colors={colors.green,colors.red,colors.orange,colors.yellow,colors.gray}}
-    network.update(5)
+    network.update(types.PANEL_LINK_STATE.DISCONNECTED)
     system.line_break()
 
     modem.register(databus.ps, "has_modem", modem.update)
@@ -66,6 +67,10 @@ local function init(panel, units)
     rt_main.register(databus.ps, "routine__main", rt_main.update)
     rt_comm.register(databus.ps, "routine__comms", rt_comm.update)
 
+---@diagnostic disable-next-line: undefined-field
+    local comp_id = util.sprintf("(%d)", os.getComputerID())
+    TextBox{parent=system,x=9,y=4,width=6,height=1,text=comp_id,fg_bg=cpair(colors.lightGray,colors.ivory)}
+
     --
     -- about label
     --

rtu/rtu.lua

@@ -158,13 +158,14 @@ end
 -- RTU Communications
 ---@nodiscard
 ---@param version string RTU version
----@param modem table modem device
+---@param nic nic network interface device
----@param local_port integer local listening port
+---@param rtu_channel integer PLC comms channel
----@param server_port integer remote server port
+---@param svr_channel integer supervisor server channel
 ---@param range integer trusted device connection range
 ---@param conn_watchdog watchdog watchdog reference
-function rtu.comms(version, modem, local_port, server_port, range, conn_watchdog)
+function rtu.comms(version, nic, rtu_channel, svr_channel, range, conn_watchdog)
     local self = {
+        sv_addr = comms.BROADCAST,
         seq_num = 0,
         r_seq_num = nil,
         txn_id = 0,
@@ -178,12 +179,8 @@ function rtu.comms(version, modem, local_port, server_port, range, conn_watchdog
     -- PRIVATE FUNCTIONS --
 
     -- configure modem channels
-    local function _conf_channels()
+    nic.closeAll()
-        modem.closeAll()
+    nic.open(rtu_channel)
-        modem.open(local_port)
-    end
-
-    _conf_channels()
 
     -- send a scada management packet
     ---@param msg_type SCADA_MGMT_TYPE
@@ -193,9 +190,9 @@ function rtu.comms(version, modem, local_port, server_port, range, conn_watchdog
         local m_pkt = comms.mgmt_packet()
 
         m_pkt.make(msg_type, msg)
-        s_pkt.make(self.seq_num, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
+        s_pkt.make(self.sv_addr, self.seq_num, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
 
-        modem.transmit(server_port, local_port, s_pkt.raw_sendable())
+        nic.transmit(svr_channel, rtu_channel, s_pkt)
         self.seq_num = self.seq_num + 1
     end
 
@@ -238,23 +235,18 @@ function rtu.comms(version, modem, local_port, server_port, range, conn_watchdog
     ---@param m_pkt modbus_packet
     function public.send_modbus(m_pkt)
         local s_pkt = comms.scada_packet()
-        s_pkt.make(self.seq_num, PROTOCOL.MODBUS_TCP, m_pkt.raw_sendable())
+        s_pkt.make(self.sv_addr, self.seq_num, PROTOCOL.MODBUS_TCP, m_pkt.raw_sendable())
-        modem.transmit(server_port, local_port, s_pkt.raw_sendable())
+        nic.transmit(svr_channel, rtu_channel, s_pkt)
         self.seq_num = self.seq_num + 1
     end
 
-    -- reconnect a newly connected modem
-    ---@param new_modem table
-    function public.reconnect_modem(new_modem)
-        modem = new_modem
-        _conf_channels()
-    end
-
     -- unlink from the server
     ---@param rtu_state rtu_state
     function public.unlink(rtu_state)
         rtu_state.linked = false
+        self.sv_addr = comms.BROADCAST
         self.r_seq_num = nil
+        databus.tx_link_state(types.PANEL_LINK_STATE.DISCONNECTED)
     end
 
     -- close the connection to the server
@@ -292,13 +284,10 @@ function rtu.comms(version, modem, local_port, server_port, range, conn_watchdog
     ---@param distance integer
     ---@return modbus_frame|mgmt_frame|nil packet
     function public.parse_packet(side, sender, reply_to, message, distance)
+        local s_pkt = nic.receive(side, sender, reply_to, message, distance)
         local pkt = nil
-        local s_pkt = comms.scada_packet()
 
-        -- parse packet as generic SCADA packet
+        if s_pkt then
-        s_pkt.receive(side, sender, reply_to, message, distance)
-
-        if s_pkt.is_valid() then
             -- get as MODBUS TCP packet
             if s_pkt.protocol() == PROTOCOL.MODBUS_TCP then
                 local m_pkt = comms.modbus_packet()
@@ -327,13 +316,21 @@ function rtu.comms(version, modem, local_port, server_port, range, conn_watchdog
         -- print a log message to the terminal as long as the UI isn't running
         local function println_ts(message) if not rtu_state.fp_ok then util.println_ts(message) end end
 
-        if packet.scada_frame.local_port() == local_port then
+        local protocol = packet.scada_frame.protocol()
+        local l_chan   = packet.scada_frame.local_channel()
+        local src_addr = packet.scada_frame.src_addr()
+
+        if l_chan == rtu_channel then
             -- check sequence number
             if self.r_seq_num == nil then
                 self.r_seq_num = packet.scada_frame.seq_num()
             elseif rtu_state.linked and ((self.r_seq_num + 1) ~= packet.scada_frame.seq_num()) then
                 log.warning("sequence out-of-order: last = " .. self.r_seq_num .. ", new = " .. packet.scada_frame.seq_num())
                 return
+            elseif rtu_state.linked and (src_addr ~= self.sv_addr) then
+                log.debug("received packet from unknown computer " .. src_addr .. " while linked (expected " .. self.sv_addr ..
+                            "); channel in use by another system?")
+                return
             else
                 self.r_seq_num = packet.scada_frame.seq_num()
             end
@@ -341,8 +338,7 @@ function rtu.comms(version, modem, local_port, server_port, range, conn_watchdog
             -- feed watchdog on valid sequence number
             conn_watchdog.feed()
 
-            local protocol = packet.scada_frame.protocol()
+            -- handle packet
-
             if protocol == PROTOCOL.MODBUS_TCP then
                 ---@cast packet modbus_frame
                 if rtu_state.linked then
@@ -398,6 +394,7 @@ function rtu.comms(version, modem, local_port, server_port, range, conn_watchdog
                         if est_ack == ESTABLISH_ACK.ALLOW then
                             -- establish allowed
                             rtu_state.linked = true
+                            self.sv_addr = packet.scada_frame.src_addr()
                             self.r_seq_num = nil
                             println_ts("supervisor connection established")
                             log.info("supervisor connection established")
@@ -461,6 +458,8 @@ function rtu.comms(version, modem, local_port, server_port, range, conn_watchdog
                 -- should be unreachable assuming packet is from parse_packet()
                 log.error("illegal packet type " .. protocol, true)
             end
+        else
+            log.debug("received packet on unconfigured channel " .. l_chan, true)
         end
     end
 

rtu/startup.lua

@@ -8,6 +8,7 @@ local comms        = require("scada-common.comms")
 local crash        = require("scada-common.crash")
 local log          = require("scada-common.log")
 local mqueue       = require("scada-common.mqueue")
+local network      = require("scada-common.network")
 local ppm          = require("scada-common.ppm")
 local rsio         = require("scada-common.rsio")
 local types        = require("scada-common.types")
@@ -28,7 +29,7 @@ local sna_rtu      = require("rtu.dev.sna_rtu")
 local sps_rtu      = require("rtu.dev.sps_rtu")
 local turbinev_rtu = require("rtu.dev.turbinev_rtu")
 
-local RTU_VERSION = "v1.2.1"
+local RTU_VERSION = "v1.4.0"
 
 local RTU_UNIT_TYPE = types.RTU_UNIT_TYPE
 local RTU_UNIT_HW_STATE = databus.RTU_UNIT_HW_STATE
@@ -42,8 +43,8 @@ local println_ts = util.println_ts
 
 local cfv = util.new_validator()
 
-cfv.assert_port(config.SERVER_PORT)
+cfv.assert_channel(config.SVR_CHANNEL)
-cfv.assert_port(config.LISTEN_PORT)
+cfv.assert_channel(config.RTU_CHANNEL)
 cfv.assert_type_int(config.TRUSTED_RANGE)
 cfv.assert_type_num(config.COMMS_TIMEOUT)
 cfv.assert_min(config.COMMS_TIMEOUT, 2)
@@ -81,6 +82,19 @@ local function main()
     -- mount connected devices
     ppm.mount_all()
 
+    -- message authentication init
+    if type(config.AUTH_KEY) == "string" then
+        network.init_mac(config.AUTH_KEY)
+    end
+
+    -- get modem
+    local modem = ppm.get_wireless_modem()
+    if modem == nil then
+        println("boot> wireless modem not found")
+        log.fatal("no wireless modem on startup")
+        return
+    end
+
     ---@class rtu_shared_memory
     local __shared_memory = {
         -- RTU system state flags
@@ -91,16 +105,12 @@ local function main()
             shutdown = false
         },
 
-        -- core RTU devices
-        rtu_dev = {
-            modem = ppm.get_wireless_modem()
-        },
-
         -- system objects
         rtu_sys = {
+            nic = network.nic(modem),
             rtu_comms = nil,        ---@type rtu_comms
             conn_watchdog = nil,    ---@type watchdog
-            units = {}              ---@type table
+            units = {}
         },
 
         -- message queues
@@ -109,16 +119,8 @@ local function main()
         }
     }
 
-    local smem_dev = __shared_memory.rtu_dev
     local smem_sys = __shared_memory.rtu_sys
 
-    -- get modem
-    if smem_dev.modem == nil then
-        println("boot> wireless modem not found")
-        log.fatal("no wireless modem on startup")
-        return
-    end
-
     databus.tx_hw_modem(true)
 
     ----------------------------------------
@@ -236,18 +238,19 @@ local function main()
 
                 ---@class rtu_unit_registry_entry
                 local unit = {
-                    uid = 0,                        ---@type integer
+                    uid = 0,                            ---@type integer
-                    name = "redstone_io",           ---@type string
+                    name = "redstone_io",               ---@type string
-                    type = RTU_UNIT_TYPE.REDSTONE,  ---@type RTU_UNIT_TYPE
+                    type = RTU_UNIT_TYPE.REDSTONE,      ---@type RTU_UNIT_TYPE
-                    index = entry_idx,              ---@type integer
+                    index = entry_idx,                  ---@type integer
-                    reactor = io_reactor,           ---@type integer
+                    reactor = io_reactor,               ---@type integer
-                    device = capabilities,          ---@type table use device field for redstone ports
+                    device = capabilities,              ---@type table use device field for redstone ports
-                    is_multiblock = false,          ---@type boolean
+                    is_multiblock = false,              ---@type boolean
-                    formed = nil,                   ---@type boolean|nil
+                    formed = nil,                       ---@type boolean|nil
-                    rtu = rs_rtu,                   ---@type rtu_device|rtu_rs_device
+                    hw_state = RTU_UNIT_HW_STATE.OK,    ---@type RTU_UNIT_HW_STATE
+                    rtu = rs_rtu,                       ---@type rtu_device|rtu_rs_device
                     modbus_io = modbus.new(rs_rtu, false),
-                    pkt_queue = nil,                ---@type mqueue|nil
+                    pkt_queue = nil,                    ---@type mqueue|nil
-                    thread = nil                    ---@type parallel_thread|nil
+                    thread = nil                        ---@type parallel_thread|nil
                 }
 
                 table.insert(units, unit)
@@ -261,7 +264,7 @@ local function main()
 
                 unit.uid = #units
 
-                databus.tx_unit_hw_status(unit.uid, RTU_UNIT_HW_STATE.OK)
+                databus.tx_unit_hw_status(unit.uid, unit.hw_state)
             end
         end
 
@@ -403,6 +406,7 @@ local function main()
                 device = device,                        ---@type table
                 is_multiblock = is_multiblock,          ---@type boolean
                 formed = formed,                        ---@type boolean|nil
+                hw_state = RTU_UNIT_HW_STATE.OFFLINE,   ---@type RTU_UNIT_HW_STATE
                 rtu = rtu_iface,                        ---@type rtu_device|rtu_rs_device
                 modbus_io = modbus.new(rtu_iface, true),
                 pkt_queue = mqueue.new(),               ---@type mqueue|nil
@@ -422,19 +426,21 @@ local function main()
 
             rtu_unit.uid = #units
 
-            -- report hardware status
+            -- determine hardware status
             if rtu_unit.type == RTU_UNIT_TYPE.VIRTUAL then
-                databus.tx_unit_hw_status(rtu_unit.uid, RTU_UNIT_HW_STATE.OFFLINE)
+                rtu_unit.hw_state = RTU_UNIT_HW_STATE.OFFLINE
             else
                 if rtu_unit.is_multiblock then
-                    databus.tx_unit_hw_status(rtu_unit.uid, util.trinary(rtu_unit.formed == true, RTU_UNIT_HW_STATE.OK, RTU_UNIT_HW_STATE.UNFORMED))
+                    rtu_unit.hw_state = util.trinary(rtu_unit.formed == true, RTU_UNIT_HW_STATE.OK, RTU_UNIT_HW_STATE.UNFORMED)
                 elseif faulted then
-                    databus.tx_unit_hw_status(rtu_unit.uid, RTU_UNIT_HW_STATE.FAULTED)
+                    rtu_unit.hw_state = RTU_UNIT_HW_STATE.FAULTED
                 else
-                    databus.tx_unit_hw_status(rtu_unit.uid, RTU_UNIT_HW_STATE.OK)
+                    rtu_unit.hw_state = RTU_UNIT_HW_STATE.OK
                 end
             end
 
+            -- report hardware status
+            databus.tx_unit_hw_status(rtu_unit.uid, rtu_unit.hw_state)
         end
 
         -- we made it through all that trusting-user-to-write-a-config-file chaos
@@ -457,9 +463,9 @@ local function main()
         if not rtu_state.fp_ok then
             renderer.close_ui()
             println_ts(util.c("UI error: ", message))
-            println("init> running without front panel")
+            println("startup> running without front panel")
             log.error(util.c("GUI crashed with error ", message))
-            log.info("init> running in headless mode without front panel")
+            log.info("startup> running in headless mode without front panel")
         end
 
         -- start connection watchdog
@@ -467,7 +473,7 @@ local function main()
         log.debug("startup> conn watchdog started")
 
         -- setup comms
-        smem_sys.rtu_comms = rtu.comms(RTU_VERSION, smem_dev.modem, config.LISTEN_PORT, config.SERVER_PORT,
+        smem_sys.rtu_comms = rtu.comms(RTU_VERSION, smem_sys.nic, config.RTU_CHANNEL, config.SVR_CHANNEL,
                                         config.TRUSTED_RANGE, smem_sys.conn_watchdog)
         log.debug("startup> comms init")
 

rtu/threads.lua

@@ -1,6 +1,7 @@
 local log          = require("scada-common.log")
 local mqueue       = require("scada-common.mqueue")
 local ppm          = require("scada-common.ppm")
+local tcd          = require("scada-common.tcd")
 local types        = require("scada-common.types")
 local util         = require("scada-common.util")
 
@@ -45,7 +46,7 @@ function threads.thread__main(smem)
 
         -- load in from shared memory
         local rtu_state     = smem.rtu_state
-        local rtu_dev       = smem.rtu_dev
+        local nic           = smem.rtu_sys.nic
         local rtu_comms     = smem.rtu_sys.rtu_comms
         local conn_watchdog = smem.rtu_sys.conn_watchdog
         local units         = smem.rtu_sys.units
@@ -82,6 +83,9 @@ function threads.thread__main(smem)
             elseif event == "timer" and conn_watchdog.is_timer(param1) then
                 -- haven't heard from server recently? unlink
                 rtu_comms.unlink(rtu_state)
+            elseif event == "timer" then
+                -- notify timer callback dispatcher if no other timer case claimed this event
+                tcd.handle(param1)
             elseif event == "peripheral_detach" then
                 -- handle loss of a device
                 local type, device = ppm.handle_unmount(param1)
@@ -89,7 +93,9 @@ function threads.thread__main(smem)
                 if type ~= nil and device ~= nil then
                     if type == "modem" then
                         -- we only care if this is our wireless modem
-                        if device == rtu_dev.modem then
+                        if nic.is_modem(device) then
+                            nic.disconnect()
+
                             println_ts("wireless modem disconnected!")
                             log.warning("comms modem disconnected!")
 
@@ -101,13 +107,15 @@ function threads.thread__main(smem)
                         for i = 1, #units do
                             -- find disconnected device
                             if units[i].device == device then
-                                -- we are going to let the PPM prevent crashes
+                                -- will let the PPM prevent crashes, which will indicate failures in MODBUS queries
-                                -- return fault flags/codes to MODBUS queries
                                 local unit = units[i]   ---@type rtu_unit_registry_entry
                                 local type_name = types.rtu_type_to_string(unit.type)
+
                                 println_ts(util.c("lost the ", type_name, " on interface ", unit.name))
                                 log.warning(util.c("lost the ", type_name, " unit peripheral on interface ", unit.name))
-                                databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.OFFLINE)
+
+                                unit.hw_state = UNIT_HW_STATE.OFFLINE
+                                databus.tx_unit_hw_status(unit.uid, unit.hw_state)
                                 break
                             end
                         end
@@ -121,8 +129,7 @@ function threads.thread__main(smem)
                     if type == "modem" then
                         if device.isWireless() then
                             -- reconnected modem
-                            rtu_dev.modem = device
+                            nic.connect(device)
-                            rtu_comms.reconnect_modem(rtu_dev.modem)
 
                             println_ts("wireless modem reconnected.")
                             log.info("comms modem reconnected")
@@ -140,6 +147,8 @@ function threads.thread__main(smem)
                             -- note: cannot check isFormed as that would yield this coroutine and consume events
                             if unit.name == param1 then
                                 local resend_advert = false
+                                local faulted       = false
+                                local unknown       = false
 
                                 -- found, re-link
                                 unit.device = device
@@ -173,57 +182,58 @@ function threads.thread__main(smem)
                                 end
 
                                 if unit.type == RTU_UNIT_TYPE.BOILER_VALVE then
-                                    unit.rtu = boilerv_rtu.new(device)
+                                    unit.rtu, faulted = boilerv_rtu.new(device)
                                      -- if not formed, indexing the multiblock functions would have resulted in a PPM fault
-                                    unit.formed = util.trinary(device.__p_is_faulted(), false, nil)
+                                    unit.formed = util.trinary(faulted, false, nil)
-                                    databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.UNFORMED)
                                 elseif unit.type == RTU_UNIT_TYPE.TURBINE_VALVE then
-                                    unit.rtu = turbinev_rtu.new(device)
+                                    unit.rtu, faulted = turbinev_rtu.new(device)
                                      -- if not formed, indexing the multiblock functions would have resulted in a PPM fault
-                                    unit.formed = util.trinary(device.__p_is_faulted(), false, nil)
+                                    unit.formed = util.trinary(faulted, false, nil)
-                                    databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.UNFORMED)
                                 elseif unit.type == RTU_UNIT_TYPE.IMATRIX then
-                                    unit.rtu = imatrix_rtu.new(device)
+                                    unit.rtu, faulted = imatrix_rtu.new(device)
                                      -- if not formed, indexing the multiblock functions would have resulted in a PPM fault
-                                    unit.formed = util.trinary(device.__p_is_faulted(), false, nil)
+                                    unit.formed = util.trinary(faulted, false, nil)
-                                    databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.UNFORMED)
                                 elseif unit.type == RTU_UNIT_TYPE.SPS then
-                                    unit.rtu = sps_rtu.new(device)
+                                    unit.rtu, faulted = sps_rtu.new(device)
                                      -- if not formed, indexing the multiblock functions would have resulted in a PPM fault
-                                    unit.formed = util.trinary(device.__p_is_faulted(), false, nil)
+                                    unit.formed = util.trinary(faulted, false, nil)
-                                    databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.UNFORMED)
                                 elseif unit.type == RTU_UNIT_TYPE.SNA then
-                                    unit.rtu = sna_rtu.new(device)
+                                    unit.rtu, faulted = sna_rtu.new(device)
-                                    databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.OK)
                                 elseif unit.type == RTU_UNIT_TYPE.ENV_DETECTOR then
-                                    unit.rtu = envd_rtu.new(device)
+                                    unit.rtu, faulted = envd_rtu.new(device)
-                                    databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.OK)
                                 else
+                                    unknown = true
                                     log.error(util.c("failed to identify reconnected RTU unit type (", unit.name, ")"), true)
                                 end
 
                                 if unit.is_multiblock then
-                                    if (unit.formed == false) then
+                                    unit.hw_state = UNIT_HW_STATE.UNFORMED
+                                    if unit.formed == false then
                                         log.info(util.c("assuming ", unit.name, " is not formed due to PPM faults while initializing"))
-                                        databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.UNFORMED)
                                     end
-                                elseif device.__p_is_faulted() then
+                                elseif faulted then
-                                    databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.FAULTED)
+                                    unit.hw_state = UNIT_HW_STATE.FAULTED
+                                elseif not unknown then
+                                    unit.hw_state = UNIT_HW_STATE.OK
                                 else
-                                    databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.OK)
+                                    unit.hw_state = UNIT_HW_STATE.OFFLINE
                                 end
 
-                                unit.modbus_io = modbus.new(unit.rtu, true)
+                                databus.tx_unit_hw_status(unit.uid, unit.hw_state)
 
-                                local type_name = types.rtu_type_to_string(unit.type)
+                                if not unknown then
-                                local message = util.c("reconnected the ", type_name, " on interface ", unit.name)
+                                    unit.modbus_io = modbus.new(unit.rtu, true)
-                                println_ts(message)
-                                log.info(message)
 
-                                if resend_advert then
+                                    local type_name = types.rtu_type_to_string(unit.type)
-                                    rtu_comms.send_advertisement(units)
+                                    local message = util.c("reconnected the ", type_name, " on interface ", unit.name)
-                                else
+                                    println_ts(message)
-                                    rtu_comms.send_remounted(unit.uid)
+                                    log.info(message)
+
+                                    if resend_advert then
+                                        rtu_comms.send_advertisement(units)
+                                    else
+                                        rtu_comms.send_remounted(unit.uid)
+                                    end
                                 end
                             end
                         end
@@ -387,13 +397,6 @@ function threads.thread__unit_comms(smem, unit)
                         -- received a packet
                         local _, reply = unit.modbus_io.handle_packet(msg.message)
                         rtu_comms.send_modbus(reply)
-
-                        -- check if there was a problem and update the hardware state if so
-                        local frame = reply.get()
-                        if unit.formed and (bit.band(frame.func_code, types.MODBUS_FCODE.ERROR_FLAG) ~= 0) and
-                           (frame.data[1] == types.MODBUS_EXCODE.SERVER_DEVICE_FAIL) then
-                            databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.FAULTED)
-                        end
                     end
                 end
 
@@ -409,12 +412,10 @@ function threads.thread__unit_comms(smem, unit)
 
                 if unit.formed == nil then
                     unit.formed = is_formed
-                    if is_formed then databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.OK) end
+                    if is_formed then unit.hw_state = UNIT_HW_STATE.OK end
                 end
 
-                if not unit.formed then
+                if not unit.formed then unit.hw_state = UNIT_HW_STATE.UNFORMED end
-                    databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.UNFORMED)
-                end
 
                 if (not unit.formed) and is_formed then
                     -- newly re-formed
@@ -459,11 +460,11 @@ function threads.thread__unit_comms(smem, unit)
                             if unit.formed and faulted then
                                 -- something is still wrong = can't mark as formed yet
                                 unit.formed = false
+                                unit.hw_state = UNIT_HW_STATE.UNFORMED
                                 log.info(util.c("assuming ", unit.name, " is not formed due to PPM faults while initializing"))
-                                databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.UNFORMED)
                             else
+                                unit.hw_state = UNIT_HW_STATE.OK
                                 rtu_comms.send_remounted(unit.uid)
-                                databus.tx_unit_hw_status(unit.uid, UNIT_HW_STATE.OK)
                             end
 
                             local type_name = types.rtu_type_to_string(unit.type)
@@ -480,6 +481,16 @@ function threads.thread__unit_comms(smem, unit)
                 unit.formed = is_formed
             end
 
+            -- check hardware status
+            if unit.device.__p_is_healthy() then
+                if unit.hw_state == UNIT_HW_STATE.FAULTED then unit.hw_state = UNIT_HW_STATE.OK end
+            else
+                if unit.hw_state == UNIT_HW_STATE.OK then unit.hw_state = UNIT_HW_STATE.FAULTED end
+            end
+
+            -- update hw status
+            databus.tx_unit_hw_status(unit.uid, unit.hw_state)
+
             -- check for termination request
             if rtu_state.shutdown then
                 log.info("rtu unit thread exiting -> " .. short_name)

scada-common/comms.lua

@@ -4,14 +4,17 @@
 
 local log = require("scada-common.log")
 
+local insert = table.insert
+
+---@diagnostic disable-next-line: undefined-field
+local COMPUTER_ID  = os.getComputerID() ---@type integer computer ID
+
+local max_distance = nil                ---@type number|nil maximum acceptable transmission distance
+
 ---@class comms
 local comms = {}
 
-local insert = table.insert
+comms.version = "2.1.0"
-
-local max_distance = nil
-
-comms.version = "1.4.1"
 
 ---@enum PROTOCOL
 local PROTOCOL = {
@@ -122,27 +125,28 @@ comms.PLC_AUTO_ACK = PLC_AUTO_ACK
 comms.UNIT_COMMAND = UNIT_COMMAND
 comms.FAC_COMMAND = FAC_COMMAND
 
+-- destination broadcast address (to all devices)
+comms.BROADCAST = -1
+
 ---@alias packet scada_packet|modbus_packet|rplc_packet|mgmt_packet|crdn_packet|capi_packet
 ---@alias frame modbus_frame|rplc_frame|mgmt_frame|crdn_frame|capi_frame
 
 -- configure the maximum allowable message receive distance<br>
 -- packets received with distances greater than this will be silently discarded
----@param distance integer max modem message distance (less than 1 disables the limit)
+---@param distance integer max modem message distance (0 disables the limit)
 function comms.set_trusted_range(distance)
-    if distance < 1 then
+    if distance == 0 then max_distance = nil else max_distance = distance end
-        max_distance = nil
-    else
-        max_distance = distance
-    end
 end
 
 -- generic SCADA packet object
 ---@nodiscard
 function comms.scada_packet()
     local self = {
-        modem_msg_in = nil,
+        modem_msg_in = nil, ---@type modem_message|nil
         valid = false,
-        raw = { -1, PROTOCOL.SCADA_MGMT, {} },
+        raw = {},
+        src_addr = comms.BROADCAST,
+        dest_addr = comms.BROADCAST,
         seq_num = -1,
         protocol = PROTOCOL.SCADA_MGMT,
         length = 0,
@@ -153,34 +157,39 @@ function comms.scada_packet()
     local public = {}
 
     -- make a SCADA packet
-    ---@param seq_num integer
+    ---@param dest_addr integer destination computer address (ID)
+    ---@param seq_num integer sequence number
     ---@param protocol PROTOCOL
     ---@param payload table
-    function public.make(seq_num, protocol, payload)
+    function public.make(dest_addr, seq_num, protocol, payload)
         self.valid = true
+        self.src_addr = COMPUTER_ID
+        self.dest_addr = dest_addr
         self.seq_num = seq_num
         self.protocol = protocol
         self.length = #payload
         self.payload = payload
-        self.raw = { self.seq_num, self.protocol, self.payload }
+        self.raw = { self.src_addr, self.dest_addr, self.seq_num, self.protocol, self.payload }
     end
 
     -- parse in a modem message as a SCADA packet
     ---@param side string modem side
-    ---@param sender integer sender port
+    ---@param sender integer sender channel
-    ---@param reply_to integer reply port
+    ---@param reply_to integer reply channel
     ---@param message any message body
     ---@param distance integer transmission distance
     ---@return boolean valid valid message received
     function public.receive(side, sender, reply_to, message, distance)
+        ---@class modem_message
         self.modem_msg_in = {
             iface = side,
-            s_port = sender,
+            s_channel = sender,
-            r_port = reply_to,
+            r_channel = reply_to,
             msg = message,
             dist = distance
         }
 
+        self.valid = false
         self.raw = self.modem_msg_in.msg
 
         if (type(max_distance) == "number") and (distance > max_distance) then
@@ -188,20 +197,35 @@ function comms.scada_packet()
             -- log.debug("comms.scada_packet.receive(): discarding packet with distance " .. distance .. " outside of trusted range")
         else
             if type(self.raw) == "table" then
-                if #self.raw >= 3 then
+                if #self.raw == 5 then
-                    self.seq_num = self.raw[1]
+                    self.src_addr = self.raw[1]
-                    self.protocol = self.raw[2]
+                    self.dest_addr = self.raw[2]
+                    self.seq_num = self.raw[3]
+                    self.protocol = self.raw[4]
 
-                    -- element 3 must be a table
+                    -- element 5 must be a table
-                    if type(self.raw[3]) == "table" then
+                    if type(self.raw[5]) == "table" then
-                        self.length = #self.raw[3]
+                        self.length = #self.raw[5]
-                        self.payload = self.raw[3]
+                        self.payload = self.raw[5]
                     end
+                else
+                    self.src_addr = nil
+                    self.dest_addr = nil
+                    self.seq_num = nil
+                    self.protocol = nil
+                    self.length = 0
+                    self.payload = {}
                 end
 
-                self.valid = type(self.seq_num) == "number" and
+                -- check if this packet is destined for this device
-                             type(self.protocol) == "number" and
+                local is_destination = (self.dest_addr == comms.BROADCAST) or (self.dest_addr == COMPUTER_ID)
-                             type(self.payload) == "table"
+
+                self.valid = is_destination and
+                                type(self.src_addr)  == "number" and
+                                type(self.dest_addr) == "number" and
+                                type(self.seq_num)   == "number" and
+                                type(self.protocol)  == "number" and
+                                type(self.payload)   == "table"
             end
         end
 
@@ -216,13 +240,17 @@ function comms.scada_packet()
     function public.raw_sendable() return self.raw end
 
     ---@nodiscard
-    function public.local_port() return self.modem_msg_in.s_port end
+    function public.local_channel() return self.modem_msg_in.s_channel end
     ---@nodiscard
-    function public.remote_port() return self.modem_msg_in.r_port end
+    function public.remote_channel() return self.modem_msg_in.r_channel end
 
     ---@nodiscard
     function public.is_valid() return self.valid end
 
+    ---@nodiscard
+    function public.src_addr() return self.src_addr end
+    ---@nodiscard
+    function public.dest_addr() return self.dest_addr end
     ---@nodiscard
     function public.seq_num() return self.seq_num end
     ---@nodiscard
@@ -235,6 +263,112 @@ function comms.scada_packet()
     return public
 end
 
+-- authenticated SCADA packet object
+---@nodiscard
+function comms.authd_packet()
+    local self = {
+        modem_msg_in = nil, ---@type modem_message|nil
+        valid = false,
+        raw = {},
+        src_addr = comms.BROADCAST,
+        dest_addr = comms.BROADCAST,
+        mac = "",
+        payload = ""
+    }
+
+    ---@class authd_packet
+    local public = {}
+
+    -- make an authenticated SCADA packet
+    ---@param s_packet scada_packet scada packet to authenticate
+    ---@param mac function message authentication function
+    function public.make(s_packet, mac)
+        self.valid = true
+        self.src_addr = s_packet.src_addr()
+        self.dest_addr = s_packet.dest_addr()
+        self.payload = textutils.serialize(s_packet.raw_sendable(), { allow_repetitions = true, compact = true })
+        self.mac = mac(self.payload)
+        self.raw = { self.src_addr, self.dest_addr, self.mac, self.payload }
+    end
+
+    -- parse in a modem message as an authenticated SCADA packet
+    ---@param side string modem side
+    ---@param sender integer sender channel
+    ---@param reply_to integer reply channel
+    ---@param message any message body
+    ---@param distance integer transmission distance
+    ---@return boolean valid valid message received
+    function public.receive(side, sender, reply_to, message, distance)
+        ---@class modem_message
+        self.modem_msg_in = {
+            iface = side,
+            s_channel = sender,
+            r_channel = reply_to,
+            msg = message,
+            dist = distance
+        }
+
+        self.valid = false
+        self.raw = self.modem_msg_in.msg
+
+        if (type(max_distance) == "number") and (distance > max_distance) then
+            -- outside of maximum allowable transmission distance
+            -- log.debug("comms.authd_packet.receive(): discarding packet with distance " .. distance .. " outside of trusted range")
+        else
+            if type(self.raw) == "table" then
+                if #self.raw == 4 then
+                    self.src_addr = self.raw[1]
+                    self.dest_addr = self.raw[2]
+                    self.mac = self.raw[3]
+                    self.payload = self.raw[4]
+                else
+                    self.src_addr = nil
+                    self.dest_addr = nil
+                    self.mac = ""
+                    self.payload = ""
+                end
+
+                -- check if this packet is destined for this device
+                local is_destination = (self.dest_addr == comms.BROADCAST) or (self.dest_addr == COMPUTER_ID)
+
+                self.valid = is_destination and
+                                type(self.src_addr)  == "number" and
+                                type(self.dest_addr) == "number" and
+                                type(self.mac)       == "string" and
+                                type(self.payload)   == "string"
+            end
+        end
+
+        return self.valid
+    end
+
+    -- public accessors --
+
+    ---@nodiscard
+    function public.modem_event() return self.modem_msg_in end
+    ---@nodiscard
+    function public.raw_sendable() return self.raw end
+
+    ---@nodiscard
+    function public.local_channel() return self.modem_msg_in.s_channel end
+    ---@nodiscard
+    function public.remote_channel() return self.modem_msg_in.r_channel end
+
+    ---@nodiscard
+    function public.is_valid() return self.valid end
+
+    ---@nodiscard
+    function public.src_addr() return self.src_addr end
+    ---@nodiscard
+    function public.dest_addr() return self.dest_addr end
+    ---@nodiscard
+    function public.mac() return self.mac end
+    ---@nodiscard
+    function public.data() return self.payload end
+
+    return public
+end
+
 -- MODBUS packet<br>
 -- modeled after MODBUS TCP packet
 ---@nodiscard

scada-common/crash.lua

@@ -6,6 +6,8 @@ local comms = require("scada-common.comms")
 local log   = require("scada-common.log")
 local util  = require("scada-common.util")
 
+local core  = require("graphics.core")
+
 local crash = {}
 
 local app = "unknown"
@@ -32,6 +34,7 @@ function crash.handler(error)
     log.info(util.c("APPLICATION:      ", app))
     log.info(util.c("FIRMWARE VERSION: ", ver))
     log.info(util.c("COMMS VERSION:    ", comms.version))
+    log.info(util.c("GRAPHICS VERSION: ", core.version))
     log.info("----------------------------------")
     log.info(debug.traceback("--- begin debug trace ---", 1))
     log.info("--- end debug trace ---")

scada-common/crypto.lua

@@ -1,244 +0,0 @@
---
--- Cryptographic Communications Engine
---
-
-local aes128   = require("lockbox.cipher.aes128")
-local ctr_mode = require("lockbox.cipher.mode.ctr")
-local sha1     = require("lockbox.digest.sha1")
-local sha2_256 = require("lockbox.digest.sha2_256")
-local pbkdf2   = require("lockbox.kdf.pbkdf2")
-local hmac     = require("lockbox.mac.hmac")
-local zero_pad = require("lockbox.padding.zero")
-local stream   = require("lockbox.util.stream")
-local array    = require("lockbox.util.array")
-
-local log      = require("scada-common.log")
-local util     = require("scada-common.util")
-
-local crypto = {}
-
-local c_eng = {
-    key = nil,
-    cipher = nil,
-    decipher = nil,
-    hmac = nil
-}
-
----@alias hex string
-
--- initialize cryptographic system
-function crypto.init(password, server_port)
-    local key_deriv = pbkdf2()
-
-    -- setup PBKDF2
-    -- the primary goal is to just turn our password into a 16 byte key
-    key_deriv.setPassword(password)
-    key_deriv.setSalt("salty_salt_at_" .. server_port)
-    key_deriv.setIterations(32)
-    key_deriv.setBlockLen(8)
-    key_deriv.setDKeyLen(16)
-
-    local start = util.time()
-
-    key_deriv.setPRF(hmac().setBlockSize(64).setDigest(sha2_256))
-    key_deriv.finish()
-
-    log.dmesg("pbkdf2: key derivation took " .. (util.time() - start) .. "ms", "CRYPTO", colors.yellow)
-
-    c_eng.key = array.fromHex(key_deriv.asHex())
-
-    -- initialize cipher
-    c_eng.cipher = ctr_mode.Cipher()
-    c_eng.cipher.setKey(c_eng.key)
-    c_eng.cipher.setBlockCipher(aes128)
-    c_eng.cipher.setPadding(zero_pad)
-
-    -- initialize decipher
-    c_eng.decipher = ctr_mode.Decipher()
-    c_eng.decipher.setKey(c_eng.key)
-    c_eng.decipher.setBlockCipher(aes128)
-    c_eng.decipher.setPadding(zero_pad)
-
-    -- initialize HMAC
-    c_eng.hmac = hmac()
-    c_eng.hmac.setBlockSize(64)
-    c_eng.hmac.setDigest(sha1)
-    c_eng.hmac.setKey(c_eng.key)
-
-    log.dmesg("init: completed in " .. (util.time() - start) .. "ms", "CRYPTO", colors.yellow)
-end
-
--- encrypt plaintext
----@nodiscard
----@param plaintext string
----@return table initial_value, string ciphertext
-function crypto.encrypt(plaintext)
-    local start = util.time()
-
-    -- initial value
-    local iv = {
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255),
-        math.random(0, 255)
-    }
-
-    log.debug("crypto.random: iv random took " .. (util.time() - start) .. "ms")
-
-    start = util.time()
-
-    c_eng.cipher.init()
-    c_eng.cipher.update(stream.fromArray(iv))
-    c_eng.cipher.update(stream.fromString(plaintext))
-    c_eng.cipher.finish()
-
-    local ciphertext = c_eng.cipher.asHex()    ---@type hex
-
-    log.debug("crypto.encrypt: aes128-ctr-mode took " .. (util.time() - start) .. "ms")
-    log.debug("ciphertext: " .. util.strval(ciphertext))
-
-    return iv, ciphertext
-end
-
--- decrypt ciphertext
----@nodiscard
----@param iv string CTR initial value
----@param ciphertext string ciphertext hex
----@return string plaintext
-function crypto.decrypt(iv, ciphertext)
-    local start = util.time()
-
-    c_eng.decipher.init()
-    c_eng.decipher.update(stream.fromArray(iv))
-    c_eng.decipher.update(stream.fromHex(ciphertext))
-    c_eng.decipher.finish()
-
-    local plaintext_hex = c_eng.decipher.asHex()   ---@type hex
-
-    local plaintext = stream.toString(stream.fromHex(plaintext_hex))
-
-    log.debug("crypto.decrypt: aes128-ctr-mode took " .. (util.time() - start) .. "ms")
-    log.debug("plaintext: " .. util.strval(plaintext))
-
-    return plaintext
-end
-
--- generate HMAC of message
----@nodiscard
----@param message_hex string initial value concatenated with ciphertext
-function crypto.hmac(message_hex)
-    local start = util.time()
-
-    c_eng.hmac.init()
-    c_eng.hmac.update(stream.fromHex(message_hex))
-    c_eng.hmac.finish()
-
-    local hash = c_eng.hmac.asHex()    ---@type hex
-
-    log.debug("crypto.hmac: hmac-sha1 took " .. (util.time() - start) .. "ms")
-    log.debug("hmac: " .. util.strval(hash))
-
-    return hash
-end
-
--- wrap a modem as a secure modem to send encrypted traffic
----@param modem table modem to wrap
-function crypto.secure_modem(modem)
-    ---@class secure_modem
-    ---@field open function
-    ---@field isOpen function
-    ---@field close function
-    ---@field closeAll function
-    ---@field isWireless function
-    ---@field getNamesRemote function
-    ---@field isPresentRemote function
-    ---@field getTypeRemote function
-    ---@field hasTypeRemote function
-    ---@field getMethodsRemote function
-    ---@field callRemote function
-    ---@field getNameLocal function
-    local public = {}
-
-    -- wrap a modem
-    ---@param reconnected_modem table
----@diagnostic disable-next-line: redefined-local
-    function public.wrap(reconnected_modem)
-        modem = reconnected_modem
-        for key, func in pairs(modem) do
-            public[key] = func
-        end
-    end
-
-    -- wrap modem functions, then we replace transmit
-    public.wrap(modem)
-
-    -- send a packet with encryption
-    ---@param channel integer
-    ---@param reply_channel integer
-    ---@param payload table packet raw_sendable
-    function public.transmit(channel, reply_channel, payload)
-        local plaintext = textutils.serialize(payload, { allow_repetitions = true, compact = true })
-
-        local iv, ciphertext = crypto.encrypt(plaintext)
----@diagnostic disable-next-line: redefined-local
-        local computed_hmac = crypto.hmac(iv .. ciphertext)
-
-        modem.transmit(channel, reply_channel, { computed_hmac, iv, ciphertext })
-    end
-
-    -- parse in a modem message as a network packet
-    ---@nodiscard
-    ---@param side string modem side
-    ---@param sender integer sender port
-    ---@param reply_to integer reply port
-    ---@param message any encrypted packet sent with secure_modem.transmit
-    ---@param distance integer transmission distance
-    ---@return string side, integer sender, integer reply_to, any plaintext_message, integer distance
-    function public.receive(side, sender, reply_to, message, distance)
-        local body = ""
-
-        if type(message) == "table" then
-            if #message == 3 then
----@diagnostic disable-next-line: redefined-local
-                local rx_hmac = message[1]
-                local iv = message[2]
-                local ciphertext = message[3]
-
-                local computed_hmac = crypto.hmac(iv .. ciphertext)
-
-                if rx_hmac == computed_hmac then
-                    -- message intact
-                    local plaintext = crypto.decrypt(iv, ciphertext)
-                    body = textutils.unserialize(plaintext)
-
-                    if body == nil then
-                        -- failed decryption
-                        log.debug("crypto.secure_modem: decryption failed")
-                        body = ""
-                    end
-                else
-                    -- something went wrong
-                    log.debug("crypto.secure_modem: hmac mismatch violation")
-                end
-            end
-        end
-
-        return side, sender, reply_to, body, distance
-    end
-
-    return public
-end
-
-return crypto

scada-common/network.lua

@@ -0,0 +1,233 @@
+--
+-- Network Communications
+--
+
+local md5    = require("lockbox.digest.md5")
+local sha256 = require("lockbox.digest.sha2_256")
+local pbkdf2 = require("lockbox.kdf.pbkdf2")
+local hmac   = require("lockbox.mac.hmac")
+local stream = require("lockbox.util.stream")
+local array  = require("lockbox.util.array")
+local comms  = require("scada-common.comms")
+
+local log    = require("scada-common.log")
+local util   = require("scada-common.util")
+
+local network = {}
+
+local c_eng = {
+    key = nil,
+    hmac = nil
+}
+
+-- initialize message authentication system
+---@param passkey string facility passkey
+---@return integer init_time milliseconds init took
+function network.init_mac(passkey)
+    local start = util.time_ms()
+
+    local key_deriv = pbkdf2()
+
+    -- setup PBKDF2
+    key_deriv.setPassword(passkey)
+    key_deriv.setSalt("pepper")
+    key_deriv.setIterations(32)
+    key_deriv.setBlockLen(8)
+    key_deriv.setDKeyLen(16)
+    key_deriv.setPRF(hmac().setBlockSize(64).setDigest(sha256))
+    key_deriv.finish()
+
+    c_eng.key = array.fromHex(key_deriv.asHex())
+
+    -- initialize HMAC
+    c_eng.hmac = hmac()
+    c_eng.hmac.setBlockSize(64)
+    c_eng.hmac.setDigest(md5)
+    c_eng.hmac.setKey(c_eng.key)
+
+    local init_time = util.time_ms() - start
+    log.info("network.init_mac completed in " .. init_time .. "ms")
+
+    return init_time
+end
+
+-- generate HMAC of message
+---@nodiscard
+---@param message string initial value concatenated with ciphertext
+local function compute_hmac(message)
+    -- local start = util.time_ms()
+
+    c_eng.hmac.init()
+    c_eng.hmac.update(stream.fromString(message))
+    c_eng.hmac.finish()
+
+    local hash = c_eng.hmac.asHex()
+
+    -- log.debug("compute_hmac(): hmac-md5 = " .. util.strval(hash) ..  " (took " .. (util.time_ms() - start) .. "ms)")
+
+    return hash
+end
+
+-- NIC: Network Interface Controller<br>
+-- utilizes HMAC-MD5 for message authentication, if enabled
+---@param modem table modem to use
+function network.nic(modem)
+    local self = {
+        connected = true,   -- used to avoid costly MAC calculations if modem isn't even present
+        channels = {}
+    }
+
+    ---@class nic
+    ---@field open function
+    ---@field isOpen function
+    ---@field close function
+    ---@field closeAll function
+    ---@field isWireless function
+    ---@field getNameLocal function
+    ---@field getNamesRemote function
+    ---@field isPresentRemote function
+    ---@field getTypeRemote function
+    ---@field hasTypeRemote function
+    ---@field getMethodsRemote function
+    ---@field callRemote function
+    local public = {}
+
+    -- check if this NIC has a connected modem
+    ---@nodiscard
+    function public.connected() return self.connected end
+
+    -- connect to a modem peripheral
+    ---@param reconnected_modem table
+    function public.connect(reconnected_modem)
+        modem = reconnected_modem
+        self.connected = true
+
+        -- open previously opened channels
+        for _, channel in ipairs(self.channels) do
+            modem.open(channel)
+        end
+
+        -- link all public functions except for transmit
+        for key, func in pairs(modem) do
+            if key ~= "transmit" and key ~= "open" and key ~= "close" and key ~= "closeAll" then public[key] = func end
+        end
+    end
+
+    -- flag this NIC as no longer having a connected modem (usually do to peripheral disconnect)
+    function public.disconnect() self.connected = false end
+
+    -- check if a peripheral is this modem
+    ---@nodiscard
+    ---@param device table
+    function public.is_modem(device) return device == modem end
+
+    -- wrap modem functions, then create custom functions
+    public.connect(modem)
+
+    -- open a channel on the modem<br>
+    -- if disconnected *after* opening, previousy opened channels will be re-opened on reconnection
+    ---@param channel integer
+    function public.open(channel)
+        modem.open(channel)
+
+        local already_open = false
+        for i = 1, #self.channels do
+            if self.channels[i] == channel then
+                already_open = true
+                break
+            end
+        end
+
+        if not already_open then
+            table.insert(self.channels, channel)
+        end
+    end
+
+    -- close a channel on the modem
+    ---@param channel integer
+    function public.close(channel)
+        modem.close(channel)
+
+        for i = 1, #self.channels do
+            if self.channels[i] == channel then
+                table.remove(self.channels, i)
+                return
+            end
+        end
+    end
+
+    -- close all channels on the modem
+    function public.closeAll()
+        modem.closeAll()
+        self.channels = {}
+    end
+
+    -- send a packet, with message authentication if configured
+    ---@param dest_channel integer destination channel
+    ---@param local_channel integer local channel
+    ---@param packet scada_packet packet
+    function public.transmit(dest_channel, local_channel, packet)
+        if self.connected then
+            local tx_packet = packet    ---@type authd_packet|scada_packet
+
+            if c_eng.hmac ~= nil then
+                -- local start = util.time_ms()
+                tx_packet = comms.authd_packet()
+
+                ---@cast tx_packet authd_packet
+                tx_packet.make(packet, compute_hmac)
+
+                -- log.debug("crypto.modem.transmit: data processing took " .. (util.time_ms() - start) .. "ms")
+            end
+
+            modem.transmit(dest_channel, local_channel, tx_packet.raw_sendable())
+        end
+    end
+
+    -- parse in a modem message as a network packet
+    ---@nodiscard
+    ---@param side string modem side
+    ---@param sender integer sender channel
+    ---@param reply_to integer reply channel
+    ---@param message any packet sent with or without message authentication
+    ---@param distance integer transmission distance
+    ---@return scada_packet|nil packet received packet if valid and passed authentication check
+    function public.receive(side, sender, reply_to, message, distance)
+        local packet = nil
+
+        if self.connected then
+            local s_packet = comms.scada_packet()
+
+            if c_eng.hmac ~= nil then
+                -- parse packet as an authenticated SCADA packet
+                local a_packet = comms.authd_packet()
+                a_packet.receive(side, sender, reply_to, message, distance)
+
+                if a_packet.is_valid() then
+                    -- local start         = util.time_ms()
+                    local packet_hmac   = a_packet.mac()
+                    local msg           = a_packet.data()
+                    local computed_hmac = compute_hmac(msg)
+
+                    if packet_hmac == computed_hmac then
+                        -- log.debug("crypto.modem.receive: HMAC verified in " .. (util.time_ms() - start) .. "ms")
+                        s_packet.receive(side, sender, reply_to, textutils.unserialize(msg), distance)
+                    else
+                        -- log.debug("crypto.modem.receive: HMAC failed verification in " .. (util.time_ms() - start) .. "ms")
+                    end
+                end
+            else
+                -- parse packet as a generic SCADA packet
+                s_packet.receive(side, sender, reply_to, message, distance)
+            end
+
+            if s_packet.is_valid() then packet = s_packet end
+        end
+
+        return packet
+    end
+
+    return public
+end
+
+return network

scada-common/ppm.lua

@@ -101,22 +101,31 @@ local function peri_init(iface)
         end
     end
 
-    -- fault management functions
+    -- fault management & monitoring functions
 
     local function clear_fault() self.faulted = false end
     local function get_last_fault() return self.last_fault end
     local function is_faulted() return self.faulted end
     local function is_ok() return not self.faulted end
 
+    -- check if a peripheral has any faulted functions<br>
+    -- contrasted with is_faulted() and is_ok() as those only check if the last operation failed,
+    -- unless auto fault clearing is disabled, at which point faults become sticky faults
+    local function is_healthy()
+        for _, v in pairs(self.fault_counts) do if v > 0 then return false end end
+        return true
+    end
+
     local function enable_afc() self.auto_cf = true end
     local function disable_afc() self.auto_cf = false end
 
-    -- append to device functions
+    -- append PPM functions to device functions
 
     self.device.__p_clear_fault = clear_fault
     self.device.__p_last_fault  = get_last_fault
     self.device.__p_is_faulted  = is_faulted
     self.device.__p_is_ok       = is_ok
+    self.device.__p_is_healthy  = is_healthy
     self.device.__p_enable_afc  = enable_afc
     self.device.__p_disable_afc = disable_afc
 
@@ -156,7 +165,7 @@ local function peri_init(iface)
 
     return {
         type = self.type,
-        dev = self.device
+        dev  = self.device
     }
 end
 

scada-common/tcd.lua

@@ -5,14 +5,14 @@
 local log  = require("scada-common.log")
 local util = require("scada-common.util")
 
-local tcallbackdsp = {}
+local tcd = {}
 
 local registry = {}
 
 -- request a function to be called after the specified time
 ---@param time number seconds
 ---@param f function callback function
-function tcallbackdsp.dispatch(time, f)
+function tcd.dispatch(time, f)
     local timer = util.start_timer(time)
     registry[timer] = {
         callback = f,
@@ -24,7 +24,7 @@ end
 -- request a function to be called after the specified time, aborting any registered instances of that function reference
 ---@param time number seconds
 ---@param f function callback function
-function tcallbackdsp.dispatch_unique(time, f)
+function tcd.dispatch_unique(time, f)
     -- cancel if already registered
     for timer, entry in pairs(registry) do
         if entry.callback == f then
@@ -47,7 +47,7 @@ end
 
 -- abort a requested callback
 ---@param f function callback function
-function tcallbackdsp.abort(f)
+function tcd.abort(f)
     for timer, entry in pairs(registry) do
         if entry.callback == f then
             -- cancel event and remove from registry (even if it fires it won't call)
@@ -59,7 +59,7 @@ end
 
 -- lookup a timer event and execute the callback if found
 ---@param event integer timer event timer ID
-function tcallbackdsp.handle(event)
+function tcd.handle(event)
     if registry[event] ~= nil then
         local callback = registry[event].callback
         -- clear first so that dispatch_unique call from inside callback won't throw a debug message
@@ -70,7 +70,7 @@ end
 
 -- identify any overdo callbacks<br>
 -- prints to log debug output
-function tcallbackdsp.diagnostics()
+function tcd.diagnostics()
     for timer, entry in pairs(registry) do
         if entry.expiry < util.time_s() then
             local overtime = util.time_s() - entry.expiry
@@ -82,4 +82,4 @@ function tcallbackdsp.diagnostics()
     end
 end
 
-return tcallbackdsp
+return tcd

scada-common/types.lua

@@ -74,6 +74,15 @@ function types.new_zero_coordinate() return { x = 0, y = 0, z = 0 } end
 -- ENUMERATION TYPES --
 --#region
 
+---@enum PANEL_LINK_STATE
+types.PANEL_LINK_STATE = {
+    LINKED = 1,
+    DENIED = 2,
+    COLLISION = 3,
+    BAD_VERSION = 4,
+    DISCONNECTED = 5
+}
+
 ---@enum RTU_UNIT_TYPE
 types.RTU_UNIT_TYPE = {
     VIRTUAL = 0,        -- virtual device

scada-common/util.lua

@@ -65,7 +65,8 @@ end
 ---@return string
 function util.strval(val)
     local t = type(val)
-    if t == "table" or t == "function" then
+    -- this depends on Lua short-circuiting the or check for metatables (note: metatables won't have metatables)
+    if (t == "table" and (getmetatable(val) == nil or getmetatable(val).__tostring == nil)) or t == "function" then
         return "[" .. tostring(val) .. "]"
     else
         return tostring(val)
@@ -539,7 +540,7 @@ function util.new_validator()
     function public.assert_range(check, min, max) valid = valid and check >= min and check <= max end
     function public.assert_range_ex(check, min, max) valid = valid and check > min and check < max end
 
-    function public.assert_port(port) valid = valid and type(port) == "number" and port >= 0 and port <= 65535 end
+    function public.assert_channel(channel) valid = valid and type(channel) == "number" and channel >= 0 and channel <= 65535 end
 
     -- check if all assertions passed successfully
     ---@nodiscard

supervisor/config.lua

@@ -1,9 +1,15 @@
 local config = {}
 
--- scada network listen for PLC's and RTU's
+-- supervisor comms channel
-config.SCADA_DEV_LISTEN = 16000
+config.SVR_CHANNEL = 16240
--- listen port for SCADA supervisor access
+-- PLC comms channel
-config.SCADA_SV_CTL_LISTEN = 16100
+config.PLC_CHANNEL = 16241
+-- RTU/MODBUS comms channel
+config.RTU_CHANNEL = 16242
+-- coordinator comms channel
+config.CRD_CHANNEL = 16243
+-- pocket comms channel
+config.PKT_CHANNEL = 16244
 -- max trusted modem message distance (0 to disable check)
 config.TRUSTED_RANGE = 0
 -- time in seconds (>= 2) before assuming a remote device is no longer active
@@ -11,6 +17,10 @@ config.PLC_TIMEOUT = 5
 config.RTU_TIMEOUT = 5
 config.CRD_TIMEOUT = 5
 config.PKT_TIMEOUT = 5
+-- facility authentication key (do NOT use one of your passwords)
+-- this enables verifying that messages are authentic
+-- all devices on the same network must use the same key
+-- config.AUTH_KEY = "SCADAfacility123"
 
 -- expected number of reactors
 config.NUM_REACTORS = 4

supervisor/databus.lua

@@ -0,0 +1,179 @@
+--
+-- Data Bus - Central Communication Linking for Supervisor Front Panel
+--
+
+local psil = require("scada-common.psil")
+local util = require("scada-common.util")
+
+local pgi  = require("supervisor.panel.pgi")
+
+-- nominal RTT is ping (0ms to 10ms usually) + 150ms for SV main loop tick
+local WARN_RTT = 300    -- 2x as long as expected w/ 0 ping
+local HIGH_RTT = 500    -- 3.33x as long as expected w/ 0 ping
+
+local databus = {}
+
+-- databus PSIL
+databus.ps = psil.create()
+
+-- call to toggle heartbeat signal
+function databus.heartbeat() databus.ps.toggle("heartbeat") end
+
+-- transmit firmware versions across the bus
+---@param sv_v string supervisor version
+---@param comms_v string comms version
+function databus.tx_versions(sv_v, comms_v)
+    databus.ps.publish("version", sv_v)
+    databus.ps.publish("comms_version", comms_v)
+end
+
+-- transmit hardware status for modem connection state
+---@param has_modem boolean
+function databus.tx_hw_modem(has_modem)
+    databus.ps.publish("has_modem", has_modem)
+end
+
+-- transmit PLC firmware version and session connection state
+---@param reactor_id integer reactor unit ID
+---@param fw string firmware version
+---@param s_addr integer PLC computer ID
+function databus.tx_plc_connected(reactor_id, fw, s_addr)
+    databus.ps.publish("plc_" .. reactor_id .. "_fw", fw)
+    databus.ps.publish("plc_" .. reactor_id .. "_conn", true)
+    databus.ps.publish("plc_" .. reactor_id .. "_addr", util.sprintf("@% 4d", s_addr))
+end
+
+-- transmit PLC disconnected
+---@param reactor_id integer reactor unit ID
+function databus.tx_plc_disconnected(reactor_id)
+    databus.ps.publish("plc_" .. reactor_id .. "_fw", " ------- ")
+    databus.ps.publish("plc_" .. reactor_id .. "_conn", false)
+    databus.ps.publish("plc_" .. reactor_id .. "_addr", " --- ")
+    databus.ps.publish("plc_" .. reactor_id .. "_rtt", 0)
+    databus.ps.publish("plc_" .. reactor_id .. "_rtt_color", colors.lightGray)
+end
+
+-- transmit PLC session RTT
+---@param reactor_id integer reactor unit ID
+---@param rtt integer round trip time
+function databus.tx_plc_rtt(reactor_id, rtt)
+    databus.ps.publish("plc_" .. reactor_id .. "_rtt", rtt)
+
+    if rtt > HIGH_RTT then
+        databus.ps.publish("plc_" .. reactor_id .. "_rtt_color", colors.red)
+    elseif rtt > WARN_RTT then
+        databus.ps.publish("plc_" .. reactor_id .. "_rtt_color", colors.yellow_hc)
+    else
+        databus.ps.publish("plc_" .. reactor_id .. "_rtt_color", colors.green)
+    end
+end
+
+-- transmit RTU firmware version and session connection state
+---@param session_id integer RTU session
+---@param fw string firmware version
+---@param s_addr integer RTU computer ID
+function databus.tx_rtu_connected(session_id, fw, s_addr)
+    databus.ps.publish("rtu_" .. session_id .. "_fw", fw)
+    databus.ps.publish("rtu_" .. session_id .. "_addr", util.sprintf("@ C% 3d", s_addr))
+    pgi.create_rtu_entry(session_id)
+end
+
+-- transmit RTU disconnected
+---@param session_id integer RTU session
+function databus.tx_rtu_disconnected(session_id)
+    pgi.delete_rtu_entry(session_id)
+end
+
+-- transmit RTU session RTT
+---@param session_id integer RTU session
+---@param rtt integer round trip time
+function databus.tx_rtu_rtt(session_id, rtt)
+    databus.ps.publish("rtu_" .. session_id .. "_rtt", rtt)
+
+    if rtt > HIGH_RTT then
+        databus.ps.publish("rtu_" .. session_id .. "_rtt_color", colors.red)
+    elseif rtt > WARN_RTT then
+        databus.ps.publish("rtu_" .. session_id .. "_rtt_color", colors.yellow_hc)
+    else
+        databus.ps.publish("rtu_" .. session_id .. "_rtt_color", colors.green)
+    end
+end
+
+-- transmit RTU session unit count
+---@param session_id integer RTU session
+---@param units integer unit count
+function databus.tx_rtu_units(session_id, units)
+    databus.ps.publish("rtu_" .. session_id .. "_units", units)
+end
+
+-- transmit coordinator firmware version and session connection state
+---@param fw string firmware version
+---@param s_addr integer coordinator computer ID
+function databus.tx_crd_connected(fw, s_addr)
+    databus.ps.publish("crd_fw", fw)
+    databus.ps.publish("crd_conn", true)
+    databus.ps.publish("crd_addr", tostring(s_addr))
+end
+
+-- transmit coordinator disconnected
+function databus.tx_crd_disconnected()
+    databus.ps.publish("crd_fw", " ------- ")
+    databus.ps.publish("crd_conn", false)
+    databus.ps.publish("crd_addr", "---")
+    databus.ps.publish("crd_rtt", 0)
+    databus.ps.publish("crd_rtt_color", colors.lightGray)
+end
+
+-- transmit coordinator session RTT
+---@param rtt integer round trip time
+function databus.tx_crd_rtt(rtt)
+    databus.ps.publish("crd_rtt", rtt)
+
+    if rtt > HIGH_RTT then
+        databus.ps.publish("crd_rtt_color", colors.red)
+    elseif rtt > WARN_RTT then
+        databus.ps.publish("crd_rtt_color", colors.yellow_hc)
+    else
+        databus.ps.publish("crd_rtt_color", colors.green)
+    end
+end
+
+-- transmit PKT firmware version and PDG session connection state
+---@param session_id integer PDG session
+---@param fw string firmware version
+---@param s_addr integer PDG computer ID
+function databus.tx_pdg_connected(session_id, fw, s_addr)
+    databus.ps.publish("pdg_" .. session_id .. "_fw", fw)
+    databus.ps.publish("pdg_" .. session_id .. "_addr", util.sprintf("@ C% 3d", s_addr))
+    pgi.create_pdg_entry(session_id)
+end
+
+-- transmit PDG session disconnected
+---@param session_id integer PDG session
+function databus.tx_pdg_disconnected(session_id)
+    pgi.delete_pdg_entry(session_id)
+end
+
+-- transmit PDG session RTT
+---@param session_id integer PDG session
+---@param rtt integer round trip time
+function databus.tx_pdg_rtt(session_id, rtt)
+    databus.ps.publish("pdg_" .. session_id .. "_rtt", rtt)
+
+    if rtt > HIGH_RTT then
+        databus.ps.publish("pdg_" .. session_id .. "_rtt_color", colors.red)
+    elseif rtt > WARN_RTT then
+        databus.ps.publish("pdg_" .. session_id .. "_rtt_color", colors.yellow_hc)
+    else
+        databus.ps.publish("pdg_" .. session_id .. "_rtt_color", colors.green)
+    end
+end
+
+-- link a function to receive data from the bus
+---@param field string field name
+---@param func function function to link
+function databus.rx_field(field, func)
+    databus.ps.subscribe(field, func)
+end
+
+return databus