chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.12 -> 3.0.13

WIFI-14229: feat: compressed config

.github/workflows/ci.yml

@@ -1,19 +1,19 @@
-name: CI
+name: Build Docker image
 
 on:
   push:
     paths-ignore:
       - 'openapi/**'
       - '**.md'
+      - 'version'
+      - 'package*.json'
+      - 'helm/*.yaml'
+      - 'CMakeLists.txt'
     branches:
-      - master
-      - 'release/*'
-    tags:
-      - 'v*'
+      - kinara
   pull_request:
     branches:
-      - master
-      - 'release/*'
+      - kinara
 
 defaults:
   run:
@@ -21,81 +21,102 @@ defaults:
 
 jobs:
   docker:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     env:
-      DOCKER_REGISTRY_URL: tip-tip-wlan-cloud-ucentral.jfrog.io
-      DOCKER_REGISTRY_USERNAME: ucentral
+      ECR_REGISTRY: 471112855615.dkr.ecr.us-east-1.amazonaws.com
+      ECR_REPOSITORY: owgw
+      AWS_REGION: us-east-1
+
     steps:
-    - name: Checkout actions repo
-      uses: actions/checkout@v3
-      with:
-        repository: Telecominfraproject/.github
-        path: github
+      - name: Checkout source
+        uses: actions/checkout@v4
+        with:
+          path: build
+          token: ${{ secrets.GIT_PUSH_PAT }}
+          persist-credentials: true
 
-    - name: Build and push Docker image
-      uses: ./github/composite-actions/docker-image-build
-      with:
-        image_name: owgw
-        registry: tip-tip-wlan-cloud-ucentral.jfrog.io
-        registry_user: ucentral
-        registry_password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
+      - name: Checkout dot github repo
+        uses: actions/checkout@v4
+        with:
+          repository: kinarasystems/.github
+          ref: main
+          path: tools
+          token: ${{ secrets.GIT_PUSH_PAT }}
 
-    - name: Notify on failure via Slack
-      if: failure() && github.ref == 'refs/heads/master'
-      uses: rtCamp/action-slack-notify@v2
-      env:
-        SLACK_USERNAME: GitHub Actions failure notifier
-        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
-        SLACK_COLOR: "${{ job.status }}"
-        SLACK_ICON: https://raw.githubusercontent.com/quintessence/slack-icons/master/images/github-logo-slack-icon.png
-        SLACK_TITLE: Docker build failed for OWGW service
+      - name: Bump version and checkin
+        if: github.ref == 'refs/heads/kinara'
+        id: bump-version
+        run: |
+          cd build
+          ../tools/utils/setup-git-credentials "${{ secrets.GIT_PUSH_PAT}}"
+          ../tools/utils/ver-bump -b -a -p -V kv -y helm/Chart.yaml -Y helm/values.yaml -M CMakeLists.txt
 
-  trigger-testing:
-    if: startsWith(github.ref, 'refs/pull/')
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Login to Amazon ECR
+        id: login-ecr
+        uses: aws-actions/amazon-ecr-login@v2
+
+      - name: Build, tag, and push image to Amazon ECR
+        id: build-image
+        env:
+          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+          IMAGE_TAG: ${{ github.sha }}
+          GITHUB_REF: ${{ github.ref }}
+        run: |
+          cd build
+          version=$(cat version)
+          ../tools/utils/docker_build \
+              -m kinara \
+              -b "$GITHUB_REF" \
+              -t "$IMAGE_TAG" \
+              -r "$ECR_REGISTRY/$ECR_REPOSITORY" \
+              -v "kv${version}"
+
+      - name: Notify via Teams
+        #if: failure() && github.ref == 'refs/heads/kinara'
+        if: always()
+        uses: skitionek/notify-microsoft-teams@master
+        with:
+          webhook_url: ${{ secrets.MS_TEAMS_WEBHOOK }}
+          needs: ${{ toJson(needs) }}
+          job: ${{ toJson(job) }}
+          steps: ${{ toJson(steps) }}
+          dry_run: False
+
+  deploy-to-dev:
     runs-on: ubuntu-latest
-    needs: docker
-    steps:
-    - name: Get base branch name and set as output
-      id: get_base_branch
-      run: |
-        echo "branch=$(echo ${GITHUB_BASE_REF##*/} | sed 's/master/main/g')" >> $GITHUB_OUTPUT
-
-    - name: Checkout actions repo
-      uses: actions/checkout@v3
-      with:
-        repository: Telecominfraproject/.github
-        path: github
-
-    - name: Trigger testing of OpenWifi Docker Compose deployment and wait for result
-      uses: ./github/composite-actions/trigger-workflow-and-wait
-      env:
-        BASE_BRANCH: ${{ steps.get_base_branch.outputs.branch }}
-      with:
-        owner: Telecominfraproject
-        repo: wlan-testing
-        workflow: ow_docker-compose.yml
-        token: ${{ secrets.WLAN_TESTING_PAT }}
-        ref: master
-        inputs: '{"deployment_version": "${{ env.BASE_BRANCH }}", "owgw_version": "${{ github.sha }}", "owsec_version": "${{ env.BASE_BRANCH }}", "owfms_version": "${{ env.BASE_BRANCH }}", "owprov_version": "${{ env.BASE_BRANCH }}", "owanalytics_version": "${{ env.BASE_BRANCH }}", "owsub_version": "${{ env.BASE_BRANCH }}", "microservice": "owgw"}'
-
-  trigger-deploy-to-dev:
-    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/master'
+    if: github.ref == 'refs/heads/kinara'
+    env:
+      DEPLOY_NAME: owgw
+      AWS_DEFAULT_REGION: us-east-1
+      AWS_NAMESPACE: kic-dev1
+      AWS_EKS_NAME: kinara-dev
+      KUBECTL_VERSION: "v1.27.14"
     needs:
       - docker
     steps:
-    - name: Checkout actions repo
-      uses: actions/checkout@v3
-      with:
-        repository: Telecominfraproject/.github
-        path: github
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ env.AWS_DEFAULT_REGION }}
 
-    - name: Trigger deployment of the latest version to dev instance and wait for result
-      uses: ./github/composite-actions/trigger-workflow-and-wait
-      with:
-        owner: Telecominfraproject
-        repo: wlan-testing
-        workflow: ucentralgw-dev-deployment.yaml
-        token: ${{ secrets.WLAN_TESTING_PAT }}
-        ref: master
-        inputs: '{"force_latest": "true"}'
+      - name: Fetch kubeconfig
+        run: |
+          aws eks update-kubeconfig --name ${{ env.AWS_EKS_NAME }} --region ${{ env.AWS_DEFAULT_REGION }}
+
+      - name: Install kubectl
+        run: |
+          curl -s -LO "https://dl.k8s.io/release/${{ env.KUBECTL_VERSION }}/bin/linux/amd64/kubectl"
+          sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
+
+      - name: Rolling update of deployment
+        run: |
+          kubectl rollout restart deployment/${{ env.DEPLOY_NAME }} -n ${{ env.AWS_NAMESPACE }}

.github/workflows/cleanup.yml

@@ -1,26 +0,0 @@
-name: Clean up PR Docker images
-
-on:
-  pull_request:
-    branches:
-      - master
-    types: [ closed ]
-
-defaults:
-  run:
-    shell: bash
-
-jobs:
-  cleanup:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Cleanup Docker image with PR branch tag 
-      run: | 
-        export PR_BRANCH_TAG=$(echo ${GITHUB_HEAD_REF#refs/heads/} | tr '/' '-')
-
-        if [[ ! $PR_BRANCH_TAG =~ (main|master|release-*) ]]; then
-          echo "PR branch is $PR_BRANCH_TAG, deleting Docker image"
-          curl -s -uucentral:${{ secrets.DOCKER_REGISTRY_PASSWORD }} -X DELETE "https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral/owgw/$PR_BRANCH_TAG"
-        else
-          echo "PR branch is $PR_BRANCH_TAG, not deleting Docker image"
-        fi

.github/workflows/enforce-jira-issue-key.yml

@@ -1,24 +0,0 @@
-name: Ensure Jira issue is linked
-
-on:
-  pull_request:
-    types: [opened, edited, reopened, synchronize]
-    branches:
-      - 'release/*'
-
-jobs:
-  check_for_issue_key:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout actions repo
-        uses: actions/checkout@v3
-        with:
-          repository: Telecominfraproject/.github
-          path: github
-
-      - name: Run JIRA check
-        uses: ./github/composite-actions/enforce-jira-issue-key
-        with:
-          jira_base_url: ${{ secrets.TIP_JIRA_URL }}
-          jira_user_email: ${{ secrets.TIP_JIRA_USER_EMAIL }}
-          jira_api_token: ${{ secrets.TIP_JIRA_API_TOKEN }}

.github/workflows/openapi-pages.yml

@@ -1,41 +0,0 @@
-name: Update OpenAPI docs on GitHub Pages
-
-on:
-  push:
-    paths:
-      - 'openapi/**'
-    branches:
-      - master
-  workflow_dispatch:
-
-defaults:
-  run:
-    shell: bash
-
-jobs:
-  docsgen:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Generate static HTML page with docs from OpenAPI definition
-        run: |
-          docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v6.2.1 generate -i https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-ucentralgw/master/openapi/owgw.yaml -g html2 --skip-validate-spec -o /local/
-
-      - name: Update OpenAPI docs
-        run: |
-          mkdir tmp-docs
-          mv index.html tmp-docs/index.html
-          mkdir -p ~/.ssh
-          ssh-keyscan -H github.com >> ~/.ssh/known_hosts
-          echo https://tip-automation:${{ secrets.GIT_PUSH_PAT }}@github.com > ~/.git-credentials
-          git config --global credential.helper store
-          git config --global user.email "tip-automation@telecominfraproject.com"
-          git config --global user.name "TIP Automation User"
-          git pull
-          git checkout gh-pages || git checkout -b gh-pages
-          rm -rf docs
-          mv tmp-docs docs
-          git add docs
-          git commit -m'Update OpenAPI docs for GitHub pages'
-          git push --set-upstream origin gh-pages

.github/workflows/release.yml

@@ -1,46 +0,0 @@
-name: Release chart package
-
-on:
-  push:
-    tags:
-      - 'v*'
-
-defaults:
-  run:
-    shell: bash
-
-jobs:
-  helm-package:
-    runs-on: ubuntu-20.04
-    env:
-      HELM_REPO_URL: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
-      HELM_REPO_USERNAME: ucentral
-    steps:
-      - name: Checkout uCentral assembly chart repo
-        uses: actions/checkout@v3
-        with:
-          path: wlan-cloud-ucentralgw
-
-      - name: Build package
-        working-directory: wlan-cloud-ucentralgw/helm
-        run: |
-          helm plugin install https://github.com/aslafy-z/helm-git --version 0.10.0
-          helm repo add bitnami https://charts.bitnami.com/bitnami
-          helm repo update
-          helm dependency update
-          mkdir dist
-          helm package . -d dist
-
-      - name: Generate GitHub release body
-        working-directory: wlan-cloud-ucentralgw/helm
-        run: |
-          pip3 install yq -q
-          echo "Docker image - tip-tip-wlan-cloud-ucentral.jfrog.io/owgw:$GITHUB_REF_NAME" > release.txt
-          echo "Helm charted may be attached to this release" >> release.txt
-          echo "Deployment artifacts may be found in https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy/tree/$GITHUB_REF_NAME" >> release.txt
-
-      - name: Create GitHub release
-        uses: softprops/action-gh-release@v1
-        with:
-          body_path: wlan-cloud-ucentralgw/helm/release.txt
-          files: wlan-cloud-ucentralgw/helm/dist/*

.gitignore

@@ -29,4 +29,3 @@ helm/charts/*
 !helm/charts/.gitkeep
 /portal-test/
 /src/ow_version.h
-

CHANGELOG.md

@@ -0,0 +1,44 @@
+## 3.0.13 (October 30, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.12 -> 3.0.13
+- Merge pull request #16 from kinarasystems/WIFI-14227-feat-compressed-config
+
+## 3.0.12 (September 27, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.11 -> 3.0.12
+- Merge pull request #15 from kinarasystems/WIFI-14134-fix_file_upload_status
+
+## 3.0.11 (September 27, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.10 -> 3.0.11
+- Merge pull request #14 from kinarasystems/WIFI-14134-fix_file_upload_status
+
+## 3.0.10 (September 18, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.9 -> 3.0.10
+- Merge pull request #12 from kinarasystems/cable_diag
+
+## 3.0.9 (August 30, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.8 -> 3.0.9
+- Merge pull request #11 from kinarasystems/fixedconfig
+
+## 3.0.8 (August 08, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.7 -> 3.0.8
+- Merge pull request #10 from kinarasystems/WIFI-13875-fix-use-dns
+
+## 3.0.7 (August 07, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.6 -> 3.0.7
+- Merge branch 'Telecominfraproject:master' into kinara
+
+## 3.0.6 (July 30, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.5 -> 3.0.6
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.4 -> 3.0.5
+
+## 3.0.5 (July 22, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.4 -> 3.0.5
+- Merge pull request #8 from kinarasystems/command
+
+## 3.0.4 (July 17, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, updated CHANGELOG.md, bumped 3.0.3 -> 3.0.4
+- Merge pull request #7 from kinarasystems/fix_uptime_update_after_reboot
+
+## 3.0.3 (June 19, 2024)
+- chore: updated package.json, updated helm/Chart.yaml, updated helm/values.yaml, updated CMakeLists.txt, updated version, created CHANGELOG.md, bumped 3.0.2 -> 3.0.3
+- Merge pull request #6 from kinarasystems/devices
+

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.13)
-project(owgw VERSION 3.1.0)
+project(owgw VERSION 3.0.13)
 
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED True)

Dockerfile

@@ -1,7 +1,7 @@
 ARG DEBIAN_VERSION=11.5-slim
 ARG POCO_VERSION=poco-tip-v2
 ARG CPPKAFKA_VERSION=tip-v1
-ARG VALIJASON_VERSION=tip-v1
+ARG VALIJASON_VERSION=tip-v1.0.2
 ARG APP_NAME=owgw
 ARG APP_HOME_DIR=/openwifi
 

buildaws

@@ -0,0 +1,21 @@
+#!/bin/bash
+set -e
+[ -z "$AWS_PROFILE" ] && echo "Please set AWS_PROFILE" && exit 1
+registry="471112855615.dkr.ecr.us-east-1.amazonaws.com"
+repo="owgw"
+aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin "$registry"
+img="$registry/$repo"
+if [ -n "$1" ] ; then
+    version="$1"
+else
+    version="latest"
+fi
+#date > about.txt
+#id=$(git rev-parse HEAD)
+#br=$(git branch --show-current)
+#echo "$br" >> about.txt
+#echo "$id" >> about.txt
+#echo "Built manually via $0" >> about.txt
+#docker build --no-cache -t $img:$version .
+docker build -t $img:$version .
+docker push $img:$version

buildit

@@ -0,0 +1,20 @@
+#!/bin/bash
+set -e
+repo="owgw"
+[ -z "$REMOTE_DOCKER_HOST" ] && echo "Please set DOCKER_HOST" && exit 1
+[ -z "$REMOTE_DOCKER_PASSWORD" ] && echo "Please set DOCKER_PASSWORD" && exit 1
+img="$REMOTE_DOCKER_HOST/kinara/$repo"
+if [ -n "$1" ] ; then
+    version="$1"
+else
+    version="latest"
+fi
+#date > about.txt
+#id=$(git rev-parse HEAD)
+#br=$(git branch --show-current)
+#echo "$br" >> about.txt
+#echo "$id" >> about.txt
+#echo "Built manually via $0" >> about.txt
+#docker build --no-cache -t $img:$version .
+docker build -t $img:$version .
+docker push $img:$version

helm/Chart.yaml

@@ -1,18 +1,18 @@
 apiVersion: v2
-appVersion: "1.0"
+appVersion: "3.0.13"
 description: A Helm chart for Kubernetes
 name: owgw
 version: 0.1.0
 dependencies:
-- name: postgresql
-  repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
-  version: 10.9.2
-  condition: postgresql.enabled
-- name: mysql
-  repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
-  version: 8.8.3
-  condition: mysql.enabled
-- name: mariadb
-  repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
-  version: 9.4.2
-  condition: mariadb.enabled
+  - name: postgresql
+    repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
+    version: 10.9.2
+    condition: postgresql.enabled
+  - name: mysql
+    repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
+    version: 8.8.3
+    condition: mysql.enabled
+  - name: mariadb
+    repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
+    version: 9.4.2
+    condition: mariadb.enabled

helm/values.yaml

@@ -2,24 +2,21 @@
 replicaCount: 1
 strategyType: Recreate
 revisionHistoryLimit: 2
-
 nameOverride: ""
 fullnameOverride: ""
-
 images:
   owgw:
-    repository: tip-tip-wlan-cloud-ucentral.jfrog.io/owgw
-    tag: master
+    repository: 471112855615.dkr.ecr.us-east-1.amazonaws.com/owgw
+    tag: kv3.0.13
     pullPolicy: Always
-#    regcred:
-#      registry: tip-tip-wlan-cloud-ucentral.jfrog.io
-#      username: username
-#      password: password
+    #    regcred:
+    #      registry: tip-tip-wlan-cloud-ucentral.jfrog.io
+    #      username: username
+    #      password: password
   dockerize:
-    repository: tip-tip-wlan-cloud-ucentral.jfrog.io/dockerize
-    tag: 0.16.0
+    repository: 471112855615.dkr.ecr.us-east-1.amazonaws.com/wait-ready
+    tag: latest
     pullPolicy: IfNotPresent
-
 services:
   owgw:
     type: ClusterIP
@@ -62,7 +59,6 @@ services:
         servicePort: 3799
         targetPort: 3799
         protocol: UDP
-
 checks:
   owgw:
     liveness:
@@ -73,33 +69,31 @@ checks:
       exec:
         command:
           - /readiness_check
-
 ingresses:
   restapi:
     enabled: false
     annotations: {}
-      # kubernetes.io/ingress.class: nginx
-      # kubernetes.io/tls-acme: "true"
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
     hosts:
-    - restapi.chart-example.local
+      - restapi.chart-example.local
     paths:
-    - path: /
-      pathType: ImplementationSpecific
-      serviceName: owgw
-      servicePort: restapi
+      - path: /
+        pathType: ImplementationSpecific
+        serviceName: owgw
+        servicePort: restapi
   fileuploader:
     enabled: false
     annotations: {}
-      # kubernetes.io/ingress.class: nginx
-      # kubernetes.io/tls-acme: "true"
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
     hosts:
-    - fileuploader.chart-example.local
+      - fileuploader.chart-example.local
     paths:
-    - path: /
-      pathType: ImplementationSpecific
-      serviceName: owgw
-      servicePort: fileuploader
-
+      - path: /
+        pathType: ImplementationSpecific
+        serviceName: owgw
+        servicePort: fileuploader
 volumes:
   owgw:
     - name: config
@@ -125,18 +119,17 @@ volumes:
       volumeDefinition: |
         persistentVolumeClaim:
           claimName: {{ template "owgw.fullname" . }}-pvc
-
 resources: {}
-  # We usually recommend not to specify default resources and to leave this as a conscious
-  # choice for the user. This also increases chances charts run on environments with little
-  # resources, such as Minikube. If you do want to specify resources, uncomment the following
-  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
-  # requests:
-  #  cpu: 100m
-  #  memory: 128Mi
-  # limits:
-  #  cpu: 100m
-  #  memory: 128Mi
+# We usually recommend not to specify default resources and to leave this as a conscious
+# choice for the user. This also increases chances charts run on environments with little
+# resources, such as Minikube. If you do want to specify resources, uncomment the following
+# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+# requests:
+#  cpu: 100m
+#  memory: 128Mi
+# limits:
+#  cpu: 100m
+#  memory: 128Mi
 
 securityContext:
   fsGroup: 1000
@@ -151,18 +144,12 @@ securityContext:
   #  value: "2"
   #- name: net.ipv4.tcp_keepalive_time
   #  value: "45"
-
 nodeSelector: {}
-
 tolerations: []
-
 affinity: {}
-
 podAnnotations: {}
-
 podSecurityPolicy:
   enabled: false
-
 persistence:
   enabled: true
   # storageClassName: "-"
@@ -170,7 +157,6 @@ persistence:
     - ReadWriteOnce
   size: 10Gi
   annotations: {}
-
 # Application
 public_env_variables:
   OWGW_ROOT: /owgw-data
@@ -180,12 +166,10 @@ public_env_variables:
   # NOTE in order for readiness check to use system info you need to set READINESS_METHOD to "systeminfo" and set OWSEC to the OWSEC's REST API endpoint
   #READINESS_METHOD: systeminfo
   #OWSEC: gw-qa01.cicd.lab.wlan.tip.build:16001
-
 secret_env_variables:
   # NOTE in order for readiness check to use system info method you need to override these values to the real OWSEC credentials
   OWSEC_USERNAME: tip@ucentral.com
   OWSEC_PASSWORD: openwifi
-
 configProperties:
   # -> Public part
   # Websocket
@@ -310,7 +294,6 @@ configProperties:
   archiver.db.2.keep: 7
   archiver.db.3.name: commandlist
   archiver.db.3.keep: 7
-
   # -> Secret part
   # Websocket
   ucentral.websocket.host.0.key.password: mypassword
@@ -332,10 +315,8 @@ configProperties:
   ## MySQL
   storage.type.mysql.username: stephb
   storage.type.mysql.password: snoopy99
-
 # NOTE: List of required certificates may be found in "certs" key. Alternative way to pass required certificates is to create external secret with all required certificates and set secret name in "existingCertsSecret" key. Details may be found in https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy/tree/main/chart#tldr
 existingCertsSecret: ""
-
 certs:
   clientcas.pem: ""
   issuer.pem: ""
@@ -345,66 +326,53 @@ certs:
   root.pem: ""
   websocket-cert.pem: ""
   websocket-key.pem: ""
-
 certsCAs:
   issuer.pem: ""
   root.pem: ""
-
 # PostgreSQL (https://github.com/bitnami/charts/tree/master/bitnami/postgresql)
 postgresql:
   enabled: false
-
   image:
     registry: docker.io
     repository: bitnami/postgresql
     tag: 11.13.0-debian-10-r0
-
   postgresqlPostgresPassword: "rootPassword"
   postgresqlUsername: stephb
   postgresqlPassword: snoopy99
   postgresqlDatabase: owgw
-
   persistence:
     enabled: true
     storageClass: ""
     size: 8Gi
-
 # MySQL (https://github.com/bitnami/charts/tree/master/bitnami/mysql)
 mysql:
   enabled: false
-
   image:
     registry: docker.io
     repository: bitnami/mysql
     tag: 8.0.26-debian-10-r10
-
   auth:
     rootPassword: rootPassword
     database: owgw
     username: stephb
     password: snoopy99
-
   primary:
     persistence:
       enabled: true
       storageClass: ""
       size: 8Gi
-
 # MariaDB (https://github.com/bitnami/charts/tree/master/bitnami/mariadb)
 mariadb:
   enabled: false
-
   image:
     registry: docker.io
     repository: bitnami/mariadb
     tag: 10.5.12-debian-10-r0
-
   auth:
     rootPassword: rootPassword
     database: owgw
     username: stephb
     password: snoopy99
-
   primary:
     persistence:
       enabled: true

openapi/owgw.yaml

@@ -12,7 +12,7 @@ info:
     url: https://www.ucentral.info/support
 
 servers:
-  - url: 'https://localhost:16001/api/v1'
+  - url: 'https://localhost:16002/api/v1'
 
 security:
   - bearerAuth: []

package.json

@@ -0,0 +1,15 @@
+{
+  "name": "owgw",
+  "version": "3.0.13",
+  "description": "This is the Kinara version of OpenWifi OWGW",
+  "author": "Kinara Systems",
+  "homepage": "https://kinarasystems.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kinarasystems/wlan-cloud-ucentralgw"
+  },
+  "keywords": [
+    "owgw",
+    "gateway"
+  ]
+}

src/RESTAPI/RESTAPI_RPC.cpp

@@ -54,8 +54,8 @@ namespace OpenWifi::RESTAPI_RPC {
 						std::chrono::milliseconds WaitTimeInMs, Poco::JSON::Object *ObjectToReturn,
 						RESTAPIHandler *Handler, Poco::Logger &Logger, bool Deferred) {
 
-		Logger.information(fmt::format("{},{}: New {} command. User={} Serial={}. ", Cmd.UUID,
-									   RPCID, Cmd.Command, Cmd.SubmittedBy, Cmd.SerialNumber));
+		Logger.information(fmt::format("{},{}: New {} command. User={} Serial={} Details={}. ", Cmd.UUID,
+									   RPCID, Cmd.Command, Cmd.SubmittedBy, Cmd.SerialNumber, Cmd.Details));
 		Cmd.Submitted = Utils::Now();
 		Cmd.Executed = 0;
 

src/RESTAPI/RESTAPI_device_commandHandler.cpp

@@ -167,7 +167,10 @@ namespace OpenWifi {
 		{APCommands::Commands::certupdate, false, true, &RESTAPI_device_commandHandler::CertUpdate, 60000ms},
 		{APCommands::Commands::transfer, false, true, &RESTAPI_device_commandHandler::Transfer, 60000ms},
 		{APCommands::Commands::script, false, true, &RESTAPI_device_commandHandler::Script, 60000ms},
-		{APCommands::Commands::powercycle, false, true, &RESTAPI_device_commandHandler::PowerCycle, 60000ms}
+		{APCommands::Commands::powercycle, false, true, &RESTAPI_device_commandHandler::PowerCycle, 60000ms},
+		{APCommands::Commands::fixedconfig, false, true, &RESTAPI_device_commandHandler::FixedConfig, 120000ms},
+		{APCommands::Commands::cablediagnostics, false, true, &RESTAPI_device_commandHandler::CableDiagnostics, 120000ms},
+
 	};
 
 	void RESTAPI_device_commandHandler::DoPost() {
@@ -691,9 +694,32 @@ namespace OpenWifi {
 				Params.stringify(ParamStream);
 				Cmd.Details = ParamStream.str();
 
+				// retrieve capabilities and encode/compress parameters, if required
+				Poco::JSON::Object ConfigParams = Params;
+				GWObjects::Capabilities Caps;
+				if (StorageService()->GetDeviceCapabilities(SerialNumber_, Caps)) {
+					Poco::JSON::Object CapsJson;
+					Caps.to_json(CapsJson);
+					auto DeviceCaps = CapsJson.getObject(uCentralProtocol::CAPABILITIES);
+					if (DeviceCaps->has("compress_cmd") && DeviceCaps->get("compress_cmd")) {
+						// compressed command capability present and it is set, compress parameters
+						Poco::JSON::Object CompressedParams;
+						std::string CompressedBase64Data;
+						std::uint64_t UncompressedDataLen = ParamStream.str().length();
+						if (Utils::CompressAndEncodeBase64(ParamStream.str(), CompressedBase64Data)) {
+							// set compressed, base 64 encoded data and length of uncompressed data
+							CompressedParams.set(uCentralProtocol::COMPRESS_64, CompressedBase64Data);
+							CompressedParams.set(uCentralProtocol::COMPRESS_SZ, UncompressedDataLen);
+							ConfigParams = CompressedParams;
+							Cmd.Details.append(" (compressed: " + CompressedBase64Data + ")");
+						}
+					}
+				}
+
+
 				// AP_WS_Server()->SetPendingUUID(SerialNumber_, NewUUID);
 				RESTAPI_RPC::WaitForCommand(CMD_RPC, APCommands::Commands::configure, true,
-												   Cmd, Params, *Request, *Response, timeout,
+												   Cmd, ConfigParams, *Request, *Response, timeout,
 												   nullptr, this, Logger_);
 
 				if(!Cmd.Executed) {
@@ -1548,4 +1574,76 @@ namespace OpenWifi {
 										   Logger_);
 	}
 
+	void RESTAPI_device_commandHandler::FixedConfig(
+		const std::string &CMD_UUID, uint64_t CMD_RPC, std::chrono::milliseconds timeout,
+		[[maybe_unused]] const GWObjects::DeviceRestrictions &Restrictions) {
+		poco_debug(Logger_, fmt::format("FIXEDCONFIG({},{}): TID={} user={} serial={}", CMD_UUID, CMD_RPC,
+										TransactionId_, Requester(), SerialNumber_));
+		if(IsDeviceSimulated(SerialNumber_)) {
+			CallCanceled("FIXEDCONFIG", CMD_UUID, CMD_RPC, RESTAPI::Errors::SimulatedDeviceNotSupported);
+			return BadRequest(RESTAPI::Errors::SimulatedDeviceNotSupported);
+		}
+
+		GWObjects::FixedConfig fixed_config;
+		if(!fixed_config.from_json(ParsedBody_)) {
+			return BadRequest(RESTAPI::Errors::MissingOrInvalidParameters);
+		}
+
+		GWObjects::CommandDetails Cmd;
+		Cmd.SerialNumber = SerialNumber_;
+		Cmd.SubmittedBy = Requester();
+		Cmd.UUID = CMD_UUID;
+		Cmd.Command = uCentralProtocol::FIXEDCONFIG;
+		std::ostringstream os;
+		ParsedBody_->stringify(os);
+		Cmd.Details = os.str();
+		Cmd.RunAt = 0;
+		Cmd.ErrorCode = 0;
+		Cmd.WaitingForFile = 0;
+
+		return RESTAPI_RPC::WaitForCommand(CMD_RPC, APCommands::Commands::fixedconfig, false, Cmd,
+										   *ParsedBody_, *Request, *Response, timeout, nullptr, this,
+										   Logger_);
+	}
+
+	void RESTAPI_device_commandHandler::CableDiagnostics(
+		const std::string &CMD_UUID, uint64_t CMD_RPC,
+		[[maybe_unused]] std::chrono::milliseconds timeout,
+		[[maybe_unused]] const GWObjects::DeviceRestrictions &Restrictions) {
+
+		if(UserInfo_.userinfo.userRole != SecurityObjects::ROOT &&
+			UserInfo_.userinfo.userRole != SecurityObjects::ADMIN) {
+			CallCanceled("CABLEDIAGNOSTICS", CMD_UUID, CMD_RPC, RESTAPI::Errors::ACCESS_DENIED);
+			return UnAuthorized(RESTAPI::Errors::ACCESS_DENIED);
+		}
+
+		poco_debug(Logger_, fmt::format("CABLEDIAGNOSTICS({},{}): TID={} user={} serial={}", CMD_UUID,
+										CMD_RPC, TransactionId_, Requester(), SerialNumber_));
+
+		if(IsDeviceSimulated(SerialNumber_)) {
+			CallCanceled("CABLEDIAGNOSTICS", CMD_UUID, CMD_RPC, RESTAPI::Errors::SimulatedDeviceNotSupported);
+			return BadRequest(RESTAPI::Errors::SimulatedDeviceNotSupported);
+		}
+
+		GWObjects::CableDiagnostics	PR;
+		if(!PR.from_json(ParsedBody_)) {
+			return BadRequest(RESTAPI::Errors::MissingOrInvalidParameters);
+		}
+
+		GWObjects::CommandDetails Cmd;
+		Cmd.SerialNumber = SerialNumber_;
+		Cmd.SubmittedBy = Requester();
+		Cmd.UUID = CMD_UUID;
+		Cmd.Command = uCentralProtocol::CABLEDIAGNOSTICS;
+		std::ostringstream os;
+		ParsedBody_->stringify(os);
+		Cmd.Details = os.str();
+		Cmd.RunAt = PR.when;
+		Cmd.ErrorCode = 0;
+		Cmd.WaitingForFile = 0;
+
+		return RESTAPI_RPC::WaitForCommand(CMD_RPC, APCommands::Commands::cablediagnostics, false, Cmd,
+										   *ParsedBody_, *Request, *Response, timeout, nullptr, this,
+										   Logger_);
+	}
 } // namespace OpenWifi

src/RESTAPI/RESTAPI_device_commandHandler.h

@@ -70,6 +70,10 @@ namespace OpenWifi {
 					const GWObjects::DeviceRestrictions &R);
 		void PowerCycle(const std::string &UUID, uint64_t RPC, std::chrono::milliseconds timeout,
 					  const GWObjects::DeviceRestrictions &R);
+		void FixedConfig(const std::string &UUID, uint64_t RPC, std::chrono::milliseconds timeout,
+					  const GWObjects::DeviceRestrictions &R);
+		void CableDiagnostics(const std::string &UUID, uint64_t RPC, std::chrono::milliseconds timeout,
+					  const GWObjects::DeviceRestrictions &R);
 
 		static auto PathName() {
 			return std::list<std::string>{"/api/v1/device/{serialNumber}/{command}"};

src/RESTAPI/RESTAPI_devices_handler.cpp

@@ -127,7 +127,7 @@ namespace OpenWifi {
 
 		} else if (QB_.CountOnly) {
 			uint64_t Count = 0;
-			if (StorageService()->GetDeviceCount(Count, platform)) {
+			if (StorageService()->GetDeviceCount(Count, platform, includeProvisioned)) {
 				return ReturnCountOnly(Count);
 			}
 		} else if (serialOnly) {

src/RESTAPI/RESTAPI_file.cpp

@@ -22,9 +22,15 @@ namespace OpenWifi {
 
 		std::string FileType;
 		std::string FileContent;
-		if (!StorageService()->GetAttachedFileContent(UUID, SerialNumber, FileContent, FileType) || FileContent.empty()) {
+		int WaitingForFile = 0;
+		if (!StorageService()->GetAttachedFileContent(UUID, SerialNumber, FileContent, FileType, WaitingForFile) && !WaitingForFile) {
 			return NotFound();
 		}
+		else if (WaitingForFile) {
+			// waiting for file to be uploaded, return Accepted
+			return Accepted();
+		}
+
 		if (FileType == "pcap") {
 			SendFileContent(FileContent, "application/vnd.tcpdump.pcap", UUID + ".pcap");
 		}

src/RESTAPI/RESTAPI_script_handler.cpp

@@ -23,8 +23,8 @@ namespace OpenWifi {
 	void RESTAPI_script_handler::DoDelete() {
 		std::string UUID = GetBinding("uuid", "");
 
-		if (UserInfo_.userinfo.userRole != SecurityObjects::ROOT) {
-			return BadRequest(RESTAPI::Errors::ACCESS_DENIED);
+		if (!UserInfo_.userinfo.userPermissions[SecurityObjects::PM_SCRIPTS_GW][SecurityObjects::PT_DELETE]) {
+			return UnAuthorized(RESTAPI::Errors::ACCESS_DENIED);
 		}
 
 		if (UUID.empty()) {
@@ -40,8 +40,8 @@ namespace OpenWifi {
 	void RESTAPI_script_handler::DoPost() {
 		std::string UUID = GetBinding("uuid", "");
 
-		if (UserInfo_.userinfo.userRole != SecurityObjects::ROOT) {
-			return BadRequest(RESTAPI::Errors::ACCESS_DENIED);
+		if (!UserInfo_.userinfo.userPermissions[SecurityObjects::PM_SCRIPTS_GW][SecurityObjects::PT_CREATE]) {
+			return UnAuthorized(RESTAPI::Errors::ACCESS_DENIED);
 		}
 
 		if (UUID.empty()) {
@@ -86,8 +86,8 @@ namespace OpenWifi {
 	void RESTAPI_script_handler::DoPut() {
 		std::string UUID = GetBinding("uuid", "");
 
-		if (UserInfo_.userinfo.userRole != SecurityObjects::ROOT) {
-			return BadRequest(RESTAPI::Errors::ACCESS_DENIED);
+		if (!UserInfo_.userinfo.userPermissions[SecurityObjects::PM_SCRIPTS_GW][SecurityObjects::PT_UPDATE]) {
+			return UnAuthorized(RESTAPI::Errors::ACCESS_DENIED);
 		}
 
 		if (UUID.empty()) {

src/RESTObjects/RESTAPI_GWobjects.cpp

@@ -295,7 +295,7 @@ namespace OpenWifi::GWObjects {
 		field_to_json(Obj, "started", started);
 		field_to_json(Obj, "sessionId", sessionId);
 		field_to_json(Obj, "connectionCompletionTime", connectionCompletionTime);
-		field_to_json(Obj, "totalConnectionTime", Utils::Now() - started);
+		field_to_json(Obj, "totalConnectionTime", started ? Utils::Now() - started : 0);
 		field_to_json(Obj, "certificateExpiryDate", certificateExpiryDate);
 		field_to_json(Obj, "connectReason", connectReason);
 		field_to_json(Obj, "uptime", uptime);
@@ -799,4 +799,24 @@ namespace OpenWifi::GWObjects {
 		return false;
 	}
 
+	bool FixedConfig::from_json(const Poco::JSON::Object::Ptr &Obj) {
+		try {
+			field_from_json(Obj, "serial", serialNumber);
+			field_from_json(Obj, "country", country);
+			return true;
+		} catch (const Poco::Exception &E) {
+		}
+		return false;
+	}
+
+	bool CableDiagnostics::from_json(const Poco::JSON::Object::Ptr &Obj) {
+		try {
+			field_from_json(Obj, "serial", serialNumber);
+			field_from_json(Obj, "when", when);
+			field_from_json(Obj, "ports", ports);
+			return true;
+		} catch (const Poco::Exception &E) {
+		}
+		return false;
+	}
 } // namespace OpenWifi::GWObjects

src/RESTObjects/RESTAPI_GWobjects.h

@@ -532,6 +532,19 @@ namespace OpenWifi::GWObjects {
 		std::uint64_t 	when;
 		std::vector<PowerCyclePort> ports;
 
+		bool from_json(const Poco::JSON::Object::Ptr &Obj);
+	};
+	struct FixedConfig {
+		std::string 	serialNumber;
+		std::string 	country;
+
+		bool from_json(const Poco::JSON::Object::Ptr &Obj);
+	};
+	struct CableDiagnostics {
+		std::string 	serialNumber;
+		std::uint64_t 	when;
+		std::vector<std::string> ports;
+
 		bool from_json(const Poco::JSON::Object::Ptr &Obj);
 	};
 } // namespace OpenWifi::GWObjects

src/RESTObjects/RESTAPI_SecurityObjects.cpp

@@ -12,6 +12,8 @@
 #include "RESTAPI_SecurityObjects.h"
 #include "framework/RESTAPI_utils.h"
 
+#include <stdlib.h>
+
 using OpenWifi::RESTAPI_utils::field_from_json;
 using OpenWifi::RESTAPI_utils::field_to_json;
 
@@ -282,6 +284,7 @@ namespace OpenWifi::SecurityObjects {
 		field_to_json(Obj, "oauthUserInfo", oauthUserInfo);
 		field_to_json(Obj, "modified", modified);
 		field_to_json(Obj, "signingUp", signingUp);
+		Obj.set("userPermissions", permissions_to_json(userPermissions));
 	};
 
 	bool UserInfo::from_json(const Poco::JSON::Object::Ptr &Obj) {
@@ -318,6 +321,7 @@ namespace OpenWifi::SecurityObjects {
 			field_from_json(Obj, "oauthUserInfo", oauthUserInfo);
 			field_from_json(Obj, "modified", modified);
 			field_from_json(Obj, "signingUp", signingUp);
+			userPermissions = permissions_from_json(Obj->getObject("userPermissions"));
 			return true;
 		} catch (const Poco::Exception &E) {
 			std::cout << "Cannot parse: UserInfo" << std::endl;
@@ -737,4 +741,218 @@ namespace OpenWifi::SecurityObjects {
         return false;
     }
 
+	PERMISSION_TYPE PermTypeFromString(const std::string &U) {
+		if (!Poco::icompare(U, "create"))
+			return PT_CREATE;
+		else if (!Poco::icompare(U, "update"))
+			return PT_UPDATE;
+		else if (!Poco::icompare(U, "delete"))
+			return PT_DELETE;
+		else if (!Poco::icompare(U, "readonly"))
+			return PT_READ_ONLY;
+		return PT_UNKNOWN;
+	}
+
+	std::string PermTypeToString(PERMISSION_TYPE U) {
+		switch (U) {
+		case PT_CREATE:
+			return "create";
+		case PT_UPDATE:
+			return "update";
+		case PT_DELETE:
+			return "delete";
+		case PT_READ_ONLY:
+			return "readonly";
+		case PT_UNKNOWN:
+		default:
+			return "unknown";
+		}
+	}
+
+
+	PERMISSION_MODEL PermModelFromString(const std::string &U) {
+		if (!Poco::icompare(U, "permissions"))
+			return PM_PERMISSIONS;
+		else if (!Poco::icompare(U, "venues"))
+			return PM_VENUES_PROV;
+		else if (!Poco::icompare(U, "venues_list"))
+			return PM_VENUES_LIST_PROV;
+		else if (!Poco::icompare(U, "entities"))
+			return PM_ENTITIES_PROV;
+		else if (!Poco::icompare(U, "entities_list"))
+			return PM_ENTITIES_LIST_PROV;
+		else if (!Poco::icompare(U, "inventory"))
+			return PM_INVENTORY_PROV;			
+		else if (!Poco::icompare(U, "inventory_list"))
+			return PM_INVENTORY_LIST_PROV;	
+		else if (!Poco::icompare(U, "managementpolicy"))
+			return PM_MANAGEMENTPOLICY_PROV;			
+		else if (!Poco::icompare(U, "managementpolicy_list"))
+			return PM_MANAGEMENTPOLICY_LIST_PROV;	
+		else if (!Poco::icompare(U, "managementrole"))
+			return PM_MANAGEMENTROLE_PROV;			
+		else if (!Poco::icompare(U, "managementrole_list"))
+			return PM_MANAGEMENTROLE_LIST_PROV;
+		//GW
+		else if (!Poco::icompare(U, "scripts"))
+			return PM_SCRIPTS_GW;
+		else if (!Poco::icompare(U, "configure"))
+			return PM_DEVICE_CONFIGURE_GW;
+		else if (!Poco::icompare(U, "upgrade"))
+			return PM_DEVICE_UPGRADE_GW;
+		else if (!Poco::icompare(U, "factoryreset"))
+			return PM_DEVICE_FACTORY_GW;
+		else if (!Poco::icompare(U, "leds"))
+			return PM_DEVICE_LEDS_GW;
+		else if (!Poco::icompare(U, "trace"))
+			return PM_DEVICE_TRACE_GW;
+		else if (!Poco::icompare(U, "request"))
+			return PM_DEVICE_REQUEST_GW;
+		else if (!Poco::icompare(U, "wifiscan"))
+			return PM_DEVICE_WIFISCAN_GW;
+		else if (!Poco::icompare(U, "eventqueue"))
+			return PM_DEVICE_EVENTQUEUE_GW;
+		else if (!Poco::icompare(U, "telemetry"))
+			return PM_DEVICE_TELEMETRY_GW;
+		else if (!Poco::icompare(U, "ping"))
+			return PM_DEVICE_PING_GW;
+		else if (!Poco::icompare(U, "ap_script"))
+			return PM_DEVICE_SCRIPT_GW;
+		else if (!Poco::icompare(U, "rrm"))
+			return PM_DEVICE_RRM_GW;
+		else if (!Poco::icompare(U, "transfer"))
+			return PM_DEVICE_TRANSFER_GW;
+		else if (!Poco::icompare(U, "certupdate"))
+			return PM_DEVICE_CERTUPDATE_GW;
+		else if (!Poco::icompare(U, "powercycle"))
+			return PM_DEVICE_POWERCYCLE_GW;
+		else if (!Poco::icompare(U, "ap_logs"))
+			return PM_DEVICE_LOGS_GW;
+		else if (!Poco::icompare(U, "healthchecks"))
+			return PM_DEVICE_HEALTHCHECKS_GW;
+		else if (!Poco::icompare(U, "ap_capabilities"))
+			return PM_DEVICE_CAPABILITIES_GW;
+		else if (!Poco::icompare(U, "ap_statistics"))
+			return PM_DEVICE_STATISTICS_GW;
+		else if (!Poco::icompare(U, "ap_status"))
+			return PM_DEVICE_STATUS_GW;
+		else if (!Poco::icompare(U, "ap_rtty"))
+			return PM_DEVICE_RTTY_GW;
+			
+		return PM_UNKNOWN;
+	}
+
+	std::string PermModelToString(PERMISSION_MODEL U) {
+		switch (U) {
+		case PM_PERMISSIONS:
+			return "permissions";
+		case PM_VENUES_PROV:
+			return "venues";
+		case PM_VENUES_LIST_PROV:
+			return "venues_list";
+		case PM_ENTITIES_PROV:
+			return "entities";
+		case PM_ENTITIES_LIST_PROV:
+			return "entities_list";
+		case PM_INVENTORY_PROV:
+			return "inventory";
+		case PM_INVENTORY_LIST_PROV:
+			return "inventory_list";
+		case PM_MANAGEMENTPOLICY_PROV:
+			return "managementpolicy";
+		case PM_MANAGEMENTPOLICY_LIST_PROV:
+			return "managementpolicy_list";
+		case PM_MANAGEMENTROLE_PROV:
+			return "managementrole";
+		case PM_MANAGEMENTROLE_LIST_PROV:
+			return "managementrole_list";
+
+		//Gateway
+		case PM_SCRIPTS_GW:
+			return "scripts";
+		case PM_DEVICE_CONFIGURE_GW:
+			return "configure";
+		case PM_DEVICE_UPGRADE_GW:
+			return "upgrade";
+		case PM_DEVICE_FACTORY_GW:
+			return "factoryreset";
+		case PM_DEVICE_LEDS_GW:
+			return "leds";
+		case PM_DEVICE_TRACE_GW:
+			return "trace";
+		case PM_DEVICE_REQUEST_GW:
+			return "request";
+		case PM_DEVICE_WIFISCAN_GW:
+			return "wifiscan";
+		case PM_DEVICE_EVENTQUEUE_GW:
+			return "eventqueue";
+		case PM_DEVICE_TELEMETRY_GW:
+			return "telemetry";
+		case PM_DEVICE_PING_GW:
+			return "ping";
+		case PM_DEVICE_SCRIPT_GW:
+			return "ap_script";
+		case PM_DEVICE_RRM_GW:
+			return "rrm";
+		case PM_DEVICE_TRANSFER_GW:
+			return "transfer";
+		case PM_DEVICE_CERTUPDATE_GW:
+			return "certupdate";
+		case PM_DEVICE_POWERCYCLE_GW:
+			return "powercycle";
+		case PM_DEVICE_LOGS_GW:
+			return "ap_logs";
+		case PM_DEVICE_HEALTHCHECKS_GW:
+			return "healthchecks";
+		case PM_DEVICE_CAPABILITIES_GW:
+			return "ap_capabilities";
+		case PM_DEVICE_STATISTICS_GW:
+			return "ap_statistics";
+		case PM_DEVICE_STATUS_GW:
+			return "ap_status";
+		case PM_DEVICE_RTTY_GW:
+			return "ap_rtty";
+		case PM_UNKNOWN:
+		default:
+			return "unknown";
+		}
+	}
+
+	/**
+	 * Convert PermissionMap into a JSON object and return it
+	*/
+	Poco::JSON::Object permissions_to_json(const PermissionMap &Map) {
+		Poco::JSON::Object MapObj;
+		for (auto &[Model, Permissions] : Map) {
+			Poco::JSON::Object ModelObject;
+			for (auto &[Permission, Allowed] : Permissions) {
+				ModelObject.set(PermTypeToString(Permission), Allowed);
+			}
+			MapObj.set(PermModelToString(Model), ModelObject);
+		}
+		return MapObj;
+	}
+
+	/**
+	 * Convert JSON object into a PermissionMap and return it
+	*/
+	PermissionMap permissions_from_json(const Poco::JSON::Object::Ptr &Obj) {
+		PermissionMap permissions;
+		if (Obj == nullptr) {
+			return permissions;
+		}
+		Poco::JSON::Object::ConstIterator it1;
+		for(it1 = Obj->begin(); it1 != Obj->end(); it1++) {
+			std::string model = it1->first;
+			Poco::JSON::Object::Ptr modelObj = it1->second.extract<Poco::JSON::Object::Ptr>();
+			Poco::JSON::Object::ConstIterator it2;
+			for(it2 = modelObj->begin(); it2 != modelObj->end(); it2++) {
+				std::string permission = it2->first;
+				bool allowed = it2->second;
+				permissions[PermModelFromString(model)]
+				           [PermTypeFromString(permission)] = allowed;
+			}
+		}
+		return permissions;
+	}
 } // namespace OpenWifi::SecurityObjects

src/RESTObjects/RESTAPI_SecurityObjects.h

@@ -11,10 +11,15 @@
 #include "Poco/Data/LOB.h"
 #include "Poco/Data/LOBStream.h"
 #include "Poco/JSON/Object.h"
+#include "Poco/Net/HTTPRequest.h"
 #include "framework/OpenWifiTypes.h"
 #include "framework/utils.h"
 #include <string>
 #include <type_traits>
+#include <iostream>
+#include <fstream>
+#include <map>
+#include <set>
 
 namespace OpenWifi {
 	uint64_t Now();
@@ -55,6 +60,10 @@ namespace OpenWifi {
 			bool from_json(const Poco::JSON::Object::Ptr &Obj);
 		};
 
+		// example entry {"/api/v1/device", {Poco::Net::HTTPRequest::HTTP_POST, Poco::Net::HTTPRequest::HTTP_PUT, Poco::Net::HTTPRequest::HTTP_DELETE}}
+		const std::map<std::string, std::set<std::string>> API_WHITELIST = {
+		};
+
 		enum USER_ROLE {
 			UNKNOWN,
 			ROOT,
@@ -125,6 +134,72 @@ namespace OpenWifi {
 			bool from_json(const Poco::JSON::Object::Ptr &Obj);
 		};
 
+		// Represents particular permissions, i.e. what are you doing do the model
+		enum PERMISSION_TYPE {
+			PT_CREATE,
+			PT_DELETE,
+			PT_UPDATE,
+			PT_READ_ONLY,
+			PT_UNKNOWN
+		};
+		PERMISSION_TYPE PermTypeFromString(const std::string &U);
+		std::string PermTypeToString(PERMISSION_TYPE U);
+
+		// Represents a model that can be operated on
+		enum PERMISSION_MODEL {
+			//Security
+			PM_PERMISSIONS,
+
+			//Provisioning
+			PM_VENUES_PROV,
+			PM_VENUES_LIST_PROV,
+			PM_ENTITIES_PROV,
+			PM_ENTITIES_LIST_PROV,
+			PM_INVENTORY_PROV,
+			PM_INVENTORY_LIST_PROV,
+			PM_MANAGEMENTPOLICY_PROV,
+			PM_MANAGEMENTPOLICY_LIST_PROV,
+			PM_MANAGEMENTROLE_PROV,
+			PM_MANAGEMENTROLE_LIST_PROV,
+
+			//Gateway
+			PM_DEVICE_CONFIGURE_GW,
+			PM_DEVICE_UPGRADE_GW,
+			PM_DEVICE_REBOOT_GW,
+			PM_DEVICE_FACTORY_GW,
+			PM_DEVICE_LEDS_GW,
+			PM_DEVICE_TRACE_GW,
+			PM_DEVICE_REQUEST_GW,
+			PM_DEVICE_WIFISCAN_GW,
+			PM_DEVICE_EVENTQUEUE_GW,
+			PM_DEVICE_TELEMETRY_GW,
+			PM_DEVICE_PING_GW,
+			PM_DEVICE_SCRIPT_GW,
+			PM_DEVICE_RRM_GW,
+			PM_DEVICE_TRANSFER_GW,
+			PM_DEVICE_CERTUPDATE_GW,
+			PM_DEVICE_POWERCYCLE_GW,
+			PM_DEVICE_LOGS_GW,
+			PM_DEVICE_HEALTHCHECKS_GW,
+			PM_DEVICE_CAPABILITIES_GW,
+			PM_DEVICE_STATISTICS_GW,
+			PM_DEVICE_STATUS_GW,
+			PM_DEVICE_RTTY_GW,
+
+			PM_SCRIPTS_GW,
+
+			PM_UNKNOWN
+		};
+		PERMISSION_MODEL PermModelFromString(const std::string &U);
+		std::string PermModelToString(PERMISSION_MODEL U);
+
+		// Map a permission (e.g. create, delete) to true/false
+		typedef std::map<PERMISSION_TYPE, bool> ModelPermissionMap;
+		// Map a model (e.g. venues, devices) to permissions
+		typedef std::map<PERMISSION_MODEL, ModelPermissionMap> PermissionMap;
+		Poco::JSON::Object permissions_to_json(const SecurityObjects::PermissionMap &Map);
+		PermissionMap permissions_from_json(const Poco::JSON::Object::Ptr &Obj);
+
 		struct UserInfo {
 			std::string id;
 			std::string name;
@@ -149,6 +224,7 @@ namespace OpenWifi {
 			bool suspended = false;
 			bool blackListed = false;
 			USER_ROLE userRole;
+			PermissionMap userPermissions;
 			UserLoginLoginExtensions userTypeProprietaryInfo;
 			std::string securityPolicy;
 			uint64_t securityPolicyChange = 0;

src/StorageService.h

@@ -162,7 +162,7 @@ namespace OpenWifi {
 		bool UpdateDevice(Poco::Data::Session &Sess, GWObjects::Device &NewDeviceDetails);
 		bool DeviceExists(std::string &SerialNumber);
 		bool SetConnectInfo(std::string &SerialNumber, std::string &Firmware);
-		bool GetDeviceCount(uint64_t &Count, const std::string &platform = "");
+		bool GetDeviceCount(uint64_t &Count, const std::string &platform = "", bool includeProvisioned = true);
 		bool GetDeviceSerialNumbers(uint64_t From, uint64_t HowMany,
 									std::vector<std::string> &SerialNumbers,
 									const std::string &orderBy = "",
@@ -243,7 +243,7 @@ namespace OpenWifi {
 									 const std::string &Type);
 		bool CancelWaitFile(std::string &UUID, std::string &ErrorText);
 		bool GetAttachedFileContent(std::string &UUID, const std::string &SerialNumber,
-									std::string &FileContent, std::string &Type);
+									std::string &FileContent, std::string &Type, int& WaitingForFile);
 		bool RemoveAttachedFile(std::string &UUID);
 		bool SetCommandResult(std::string &UUID, std::string &Result);
 		bool GetNewestCommands(std::string &SerialNumber, uint64_t HowMany,

src/framework/AuthClient.cpp

@@ -129,4 +129,26 @@ namespace OpenWifi {
 		return RetrieveApiKeyInformation(SessionToken, UInfo, TID, Expired, Contacted, Suspended);
 	}
 
+	/**
+	 * Given a role, remove the cached user info for any user with that role
+	*/
+	void AuthClient::EmptyCacheForRole(const std::string &role) {
+		SecurityObjects::USER_ROLE roleEnum = SecurityObjects::UserTypeFromString(role);
+		Poco::JSON::Object::ConstIterator it;
+		std::set<std::string> tokens = Cache_.getAllKeys();
+		for(const std::string &token : tokens) {
+			auto UInfo = Cache_.get(token);
+			if (UInfo->userinfo.userRole == roleEnum) {
+				Cache_.remove(token);
+			}
+		}
+
+		tokens = ApiKeyCache_.getAllKeys();
+		for(const std::string &token : tokens) {
+			auto UInfo = ApiKeyCache_.get(token);
+			if (UInfo->UserInfo.userinfo.userRole == roleEnum) {
+				ApiKeyCache_.remove(token);
+			}
+		}
+	}
 } // namespace OpenWifi

src/framework/AuthClient.h

@@ -61,6 +61,8 @@ namespace OpenWifi {
 						   SecurityObjects::UserInfoAndPolicy &UInfo, std::uint64_t TID,
 						   bool &Expired, bool &Contacted, bool &Suspended);
 
+		void EmptyCacheForRole(const std::string &role);
+
 	  private:
 		Poco::ExpireLRUCache<std::string, OpenWifi::SecurityObjects::UserInfoAndPolicy> Cache_{
 			512, 1200000};

src/framework/KafkaTopics.h

@@ -27,6 +27,7 @@ namespace OpenWifi::KafkaTopics {
 		inline const char * EVENT_LEAVE = "leave";
 		inline const char * EVENT_KEEP_ALIVE = "keep-alive";
 		inline const char * EVENT_REMOVE_TOKEN = "remove-token";
+		inline const char * EVENT_PERMISSIONS_UPDATE = "permissions-update";
 
 		namespace Fields {
 			inline const char * EVENT = "event";
@@ -37,6 +38,7 @@ namespace OpenWifi::KafkaTopics {
 			inline const char * KEY = "key";
 			inline const char * VRSN = "version";
 			inline const char * TOKEN = "token";
+			inline const char * ROLE = "role";
 		} // namespace Fields
 	}	  // namespace ServiceEvents
 } // namespace OpenWifi::KafkaTopics

src/framework/MicroService.cpp

@@ -155,6 +155,16 @@ namespace OpenWifi {
 								BusLogger,
 								fmt::format("KAFKA-MSG: invalid event '{}', missing token", Event));
 						}
+					} else if (Event == KafkaTopics::ServiceEvents::EVENT_PERMISSIONS_UPDATE) {
+							if (Object->has(KafkaTopics::ServiceEvents::Fields::ROLE)) {
+								// Permissions of this role have updated, cached user info is now invalid
+								AuthClient()->EmptyCacheForRole(
+									Object->get(KafkaTopics::ServiceEvents::Fields::ROLE).toString());
+							} else {
+								poco_information(
+									logger(),
+									fmt::format("KAFKA-MSG: invalid event '{}', missing role", Event));
+							}
 					} else {
 						poco_information(BusLogger,
 								   fmt::format("Unknown Event: {} Source: {}", Event, ID));

src/framework/RESTAPI_Handler.h

@@ -60,9 +60,52 @@ namespace OpenWifi {
 			  AlwaysAuthorize_(AlwaysAuthorize), Server_(Server), MyRates_(Profile),
 			  TransactionId_(TransactionId) {}
 
+		inline int nthOccurrence(const std::string& str, const std::string& findMe, int nth) {
+			/*
+			Helper function to get the index of the nth occurence of string findMe in string str.
+			if there are not n occurrences of findMe in str, returns -1.
+			*/
+			size_t  pos = 0;
+			int     count = 0;
+
+			while(count != nth)
+			{
+				pos+=1;
+				pos = str.find(findMe, pos);
+				if (pos == std::string::npos)
+					return -1;
+				count++;
+			}
+			return pos;
+		}
+
 		inline bool RoleIsAuthorized([[maybe_unused]] const std::string &Path,
 									 [[maybe_unused]] const std::string &Method,
 									 [[maybe_unused]] std::string &Reason) {
+			// If user role is admin or root, authorized is true
+			if (UserInfo_.userinfo.userRole == SecurityObjects::USER_ROLE::ADMIN || UserInfo_.userinfo.userRole == SecurityObjects::USER_ROLE::ROOT) {
+				return true;
+			}
+			
+			// We just want the /api/v1/x part of the path so we need to account for
+			// extra path variables as well as query variables.
+			std::string pathstubtmp = Path.substr(0, nthOccurrence(Path, "/", 3));
+			std::string pathstub = pathstubtmp.substr(0, nthOccurrence(pathstubtmp, "?", 1));
+
+			// Next check the pathstub against the whitelist
+			if (SecurityObjects::API_WHITELIST.find(pathstub) != SecurityObjects::API_WHITELIST.end()) {
+				std::set<std::string> allowed_methods = SecurityObjects::API_WHITELIST.at(pathstub);
+				// The API stub is in the whitelist, but we also need to check that this method is whitelisted for this stub.
+				if (allowed_methods.find(Method) != allowed_methods.end()) {
+					return true;
+				}
+			}
+
+			// At this point, the user is not root/admin and the API + method is not whitelisted, so we disallow any method that is not a GET.
+			if (Method != Poco::Net::HTTPRequest::HTTP_GET) {
+				return false;
+			}
+			
 			return true;
 		}
 
@@ -431,6 +474,11 @@ namespace OpenWifi {
 			}
 		}
 
+		inline void Accepted() {
+			PrepareResponse(Poco::Net::HTTPResponse::HTTP_ACCEPTED);
+			Response->send();
+		}
+
 		inline void SendCompressedTarFile(const std::string &FileName, const std::string &Content) {
 			Response->setStatus(Poco::Net::HTTPResponse::HTTPStatus::HTTP_OK);
 			SetCommonHeaders();

src/framework/ow_constants.h

@@ -580,6 +580,9 @@ namespace OpenWifi::RESTAPI::Protocol {
 	static const char *INTERVAL = "interval";
 	static const char *UI = "UI";
 	static const char *BANDWIDTH = "bandwidth";
+
+	static const char *FIXEDCONFIG = "fixedconfig";
+	static const char *CABLEDIAGNOSTICS = "cablediagnostics";
 } // namespace OpenWifi::RESTAPI::Protocol
 
 namespace OpenWifi::uCentralProtocol {
@@ -608,6 +611,7 @@ namespace OpenWifi::uCentralProtocol {
 	static const char *CFGPENDING = "cfgpending";
 	static const char *RECOVERY = "recovery";
 	static const char *COMPRESS_64 = "compress_64";
+	static const char *COMPRESS_SZ = "compress_sz";
 	static const char *CAPABILITIES = "capabilities";
 	static const char *REQUEST_UUID = "request_uuid";
 	static const char *SANITY = "sanity";
@@ -692,6 +696,9 @@ namespace OpenWifi::uCentralProtocol {
 	static const char *RRM = "rrm";
 	static const char *ACTIONS = "actions";
 
+	static const char *FIXEDCONFIG = "fixedconfig";
+	static const char *CABLEDIAGNOSTICS = "cablediagnostics";
+
 } // namespace OpenWifi::uCentralProtocol
 
 namespace OpenWifi::uCentralProtocol::Events {
@@ -788,6 +795,8 @@ namespace OpenWifi::APCommands {
 		certupdate,
 		transfer,
 		powercycle,
+		fixedconfig,
+		cablediagnostics,
 		unknown
 	};
 
@@ -802,7 +811,8 @@ namespace OpenWifi::APCommands {
 		RESTAPI::Protocol::EVENTQUEUE,	 RESTAPI::Protocol::TELEMETRY,
 		RESTAPI::Protocol::PING,		 RESTAPI::Protocol::SCRIPT,
 		RESTAPI::Protocol::RRM,		 	 RESTAPI::Protocol::CERTUPDATE,
-		RESTAPI::Protocol::TRANSFER,	 RESTAPI::Protocol::POWERCYCLE
+		RESTAPI::Protocol::TRANSFER,	 RESTAPI::Protocol::POWERCYCLE,
+		RESTAPI::Protocol::FIXEDCONFIG,  RESTAPI::Protocol::CABLEDIAGNOSTICS
 	};
 
 	inline const char *to_string(Commands Cmd) { return uCentralAPCommands[(uint8_t)Cmd]; }

src/framework/utils.cpp

@@ -590,6 +590,26 @@ namespace OpenWifi::Utils {
 		return false;
 	}
 
+	//
+	// Compress given data using utility function and encode it in base64 format.
+	//
+	bool CompressAndEncodeBase64(const std::string& UnCompressedData, std::string& CompressedBase64Data) {
+
+		unsigned long CompressedDataSize = UnCompressedData.size();
+		std::vector<Bytef> CompressedData(CompressedDataSize);
+		auto status = compress(&CompressedData[0], &CompressedDataSize,
+								(Bytef*) UnCompressedData.c_str(), UnCompressedData.size());
+		if (status == Z_OK) {
+			CompressedBase64Data = OpenWifi::Utils::base64encode(&CompressedData[0], CompressedDataSize);
+		}
+		else {
+			// failed to compress data
+			return false;
+		}
+
+		return true;
+	}
+
 	bool IsAlphaNumeric(const std::string &s) {
 		return std::all_of(s.begin(), s.end(), [](char c) -> bool { return isalnum(c); });
 	}

src/framework/utils.h

@@ -151,6 +151,8 @@ namespace OpenWifi::Utils {
 	bool ExtractBase64CompressedData(const std::string &CompressedData,
 									 std::string &UnCompressedData, uint64_t compress_sz);
 
+	bool CompressAndEncodeBase64(const std::string& UnCompressedData, std::string& CompressedData);
+
 	inline bool match(const char* first, const char* second)
 	{
 		// If we reach at the end of both strings, we are done

src/storage/storage_command.cpp

@@ -647,18 +647,6 @@ namespace OpenWifi {
 			Sess.begin();
 			Poco::Data::Statement Statement(Sess);
 
-			std::string StatementStr;
-
-			//	Get the existing command
-
-			StatementStr =
-				"UPDATE CommandList SET WaitingForFile=?, AttachDate=?, AttachSize=? WHERE UUID=?";
-
-			Statement << ConvertParams(StatementStr), Poco::Data::Keywords::use(WaitForFile),
-				Poco::Data::Keywords::use(Now), Poco::Data::Keywords::use(Size),
-				Poco::Data::Keywords::use(UUID);
-			Statement.execute();
-			Sess.commit();
 			if (Size < FileUploader()->MaxSize()) {
 
 				Poco::Data::BLOB TheBlob;
@@ -681,6 +669,18 @@ namespace OpenWifi {
 				poco_warning(Logger(), fmt::format("File {} is too large.", UUID));
 			}
 			Sess.commit();
+
+			// update CommandList here to ensure that file us uploaded
+			std::string StatementStr;
+			StatementStr =
+				"UPDATE CommandList SET WaitingForFile=?, AttachDate=?, AttachSize=? WHERE UUID=?";
+
+			Statement << ConvertParams(StatementStr), Poco::Data::Keywords::use(WaitForFile),
+				Poco::Data::Keywords::use(Now), Poco::Data::Keywords::use(Size),
+				Poco::Data::Keywords::use(UUID);
+			Statement.execute();
+			Sess.commit();
+
 			return true;
 		} catch (const Poco::Exception &E) {
 			Logger().log(E);
@@ -689,7 +689,7 @@ namespace OpenWifi {
 	}
 
 	bool Storage::GetAttachedFileContent(std::string &UUID, const std::string &SerialNumber,
-										 std::string &FileContent, std::string &Type) {
+										 std::string &FileContent, std::string &Type, int &WaitingForFile) {
 		try {
 			Poco::Data::BLOB L;
 			/*
@@ -702,10 +702,10 @@ namespace OpenWifi {
 			Poco::Data::Statement Select1(Sess);
 
 			std::string TmpSerialNumber;
-			std::string st1{"SELECT SerialNumber, Command FROM CommandList WHERE UUID=?"};
+			std::string st1{"SELECT SerialNumber, Command , WaitingForFile FROM CommandList WHERE UUID=?"};
 			std::string Command;
 			Select1 << ConvertParams(st1), Poco::Data::Keywords::into(TmpSerialNumber),
-				Poco::Data::Keywords::into(Command), Poco::Data::Keywords::use(UUID);
+				Poco::Data::Keywords::into(Command), Poco::Data::Keywords::into(WaitingForFile), Poco::Data::Keywords::use(UUID);
 			Select1.execute();
 
 			if (TmpSerialNumber != SerialNumber) {

src/storage/storage_device.cpp

@@ -172,18 +172,27 @@ namespace OpenWifi {
 		R.set<30>(D.connectReason);
 	}
 
-	bool Storage::GetDeviceCount(uint64_t &Count, const std::string &platform) {
+	bool Storage::GetDeviceCount(uint64_t &Count, const std::string &platform, bool includeProvisioned) {
 		try {
 			Poco::Data::Session Sess = Pool_->get();
 			Poco::Data::Statement Select(Sess);
 
+			std::string st;
+			std::string whereClause = "";
+
 			if(!platform.empty()) {
-				std::string st{"SELECT COUNT(*) FROM Devices WHERE DeviceType='" + platform + "'"};
-				Select << st, Poco::Data::Keywords::into(Count);
+				if (includeProvisioned == false) {
+					whereClause = fmt::format("WHERE entity='' and venue='' and DeviceType='" + platform + "'");
+				} else {
+					whereClause = fmt::format("WHERE DeviceType='" + platform + "'");
+				}
 			} else {
-				std::string st{"SELECT COUNT(*) FROM Devices"};
-				Select << st, Poco::Data::Keywords::into(Count);
+				if (includeProvisioned == false) {
+					whereClause = fmt::format("WHERE entity='' and venue=''");
+				}
 			}
+			st = fmt::format("SELECT COUNT(*) FROM Devices {}", whereClause);
+			Select << st, Poco::Data::Keywords::into(Count);
 			Select.execute();
 			return true;
 		} catch (const Poco::Exception &E) {

version

@@ -0,0 +1 @@
+3.0.13