Baselined from internal Repository

last_commit:7654c114498f53791e791c58adeeeb12c531545b

.env_sample

@@ -0,0 +1,7 @@
+# Webex Control Hub Webhook Configs
+WEBHOOK_SECRET=""
+
+# ServiceNow Section
+SERVICENOW_INSTANCE=""
+SERVICENOW_USERNAME=""
+SERVICENOW_PASSWORD=""

.github/workflows/docker-publish.yml

@@ -0,0 +1,53 @@
+name: Docker Build & Publish
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    tags:
+      - '*'
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Docker buildx
+        uses: docker/setup-buildx-action@79abd3f86f79a9d68a23c75a09a9a85889262adf
+
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@28218f9b04b4f3f62068d7b6ce6ca5b26e35336c
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@ac9327eae2b366085ac7f6a2d02df8aa8ead720a
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.gitignore

@@ -0,0 +1,11 @@
+# Python files and venv
+venv
+__pycache__/
+
+# IDE Files
+.idea/
+.DS_Store
+
+# Sensitive Files
+.env
+

CODE_OF_CONDUCT.md

@@ -0,0 +1,45 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as maintainers of this Cisco Sample Code pledge to making participation with our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Showing empathy towards other people
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other interactions with this project that are not aligned to this Code of Conduct, or to ban temporarily or permanently any person for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project. Examples of representing a project include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Cisco SE GitHub team at [email protected]. The team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project or Cisco SE Leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Cisco Sample Code
+
+This project, and the code contained herein, is provided for example and/or demonstration purposes by Cisco for use by our partners and customers in working with Cisco's products and services. While Cisco's customers and partners are free to use this code pursuant to the terms set forth in the [LICENSE][LICENSE], this is not an Open Source project as we are not seeking to build a community around this project and its capabilities.
+
+
+We do desire to provide functional and high-quality examples and demonstrations.  If you should discover some bug, issue, or opportunity for enhancement with the code contained in this project, please do notify us by:
+
+1. **Reviewing Open Issues** to verify that the issue hasn't already been reported.
+2. **Opening a New Issue** to report the bug, issue, or enhancement opportunity.
+
+[LICENSE]: ../LICENSE

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+COPY ./requirements.txt /app
+RUN pip install -r requirements.txt
+
+COPY ./src .
+
+EXPOSE 5000
+CMD ["python", "./app.py"]

LICENSE.md

@@ -0,0 +1,81 @@
+CISCO SAMPLE CODE LICENSE
+                                  Version 1.1
+                Copyright (c) 2022 Cisco and/or its affiliates
+
+   These terms govern this Cisco Systems, Inc. ("Cisco"), example or demo
+   source code and its associated documentation (together, the "Sample
+   Code"). By downloading, copying, modifying, compiling, or redistributing
+   the Sample Code, you accept and agree to be bound by the following terms
+   and conditions (the "License"). If you are accepting the License on
+   behalf of an entity, you represent that you have the authority to do so
+   (either you or the entity, "you"). Sample Code is not supported by Cisco
+   TAC and is not tested for quality or performance. This is your only
+   license to the Sample Code and all rights not expressly granted are
+   reserved.
+
+   1. LICENSE GRANT: Subject to the terms and conditions of this License,
+      Cisco hereby grants to you a perpetual, worldwide, non-exclusive, non-
+      transferable, non-sublicensable, royalty-free license to copy and
+      modify the Sample Code in source code form, and compile and
+      redistribute the Sample Code in binary/object code or other executable
+      forms, in whole or in part, solely for use with Cisco products and
+      services. For interpreted languages like Java and Python, the
+      executable form of the software may include source code and
+      compilation is not required.
+
+   2. CONDITIONS: You shall not use the Sample Code independent of, or to
+      replicate or compete with, a Cisco product or service. Cisco products
+      and services are licensed under their own separate terms and you shall
+      not use the Sample Code in any way that violates or is inconsistent
+      with those terms (for more information, please visit:
+      www.cisco.com/go/terms).
+
+   3. OWNERSHIP: Cisco retains sole and exclusive ownership of the Sample
+      Code, including all intellectual property rights therein, except with
+      respect to any third-party material that may be used in or by the
+      Sample Code. Any such third-party material is licensed under its own
+      separate terms (such as an open source license) and all use must be in
+      full accordance with the applicable license. This License does not
+      grant you permission to use any trade names, trademarks, service
+      marks, or product names of Cisco. If you provide any feedback to Cisco
+      regarding the Sample Code, you agree that Cisco, its partners, and its
+      customers shall be free to use and incorporate such feedback into the
+      Sample Code, and Cisco products and services, for any purpose, and
+      without restriction, payment, or additional consideration of any kind.
+      If you initiate or participate in any litigation against Cisco, its
+      partners, or its customers (including cross-claims and counter-claims)
+      alleging that the Sample Code and/or its use infringe any patent,
+      copyright, or other intellectual property right, then all rights
+      granted to you under this License shall terminate immediately without
+      notice.
+
+   4. LIMITATION OF LIABILITY: CISCO SHALL HAVE NO LIABILITY IN CONNECTION
+      WITH OR RELATING TO THIS LICENSE OR USE OF THE SAMPLE CODE, FOR
+      DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO DIRECT, INCIDENTAL,
+      AND CONSEQUENTIAL DAMAGES, OR FOR ANY LOSS OF USE, DATA, INFORMATION,
+      PROFITS, BUSINESS, OR GOODWILL, HOWEVER CAUSED, EVEN IF ADVISED OF THE
+      POSSIBILITY OF SUCH DAMAGES.
+
+   5. DISCLAIMER OF WARRANTY: SAMPLE CODE IS INTENDED FOR EXAMPLE PURPOSES
+      ONLY AND IS PROVIDED BY CISCO "AS IS" WITH ALL FAULTS AND WITHOUT
+      WARRANTY OR SUPPORT OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY
+      LAW, ALL EXPRESS AND IMPLIED CONDITIONS, REPRESENTATIONS, AND
+      WARRANTIES INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTY OR
+      CONDITION OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-
+      INFRINGEMENT, SATISFACTORY QUALITY, NON-INTERFERENCE, AND ACCURACY,
+      ARE HEREBY EXCLUDED AND EXPRESSLY DISCLAIMED BY CISCO. CISCO DOES NOT
+      WARRANT THAT THE SAMPLE CODE IS SUITABLE FOR PRODUCTION OR COMMERCIAL
+      USE, WILL OPERATE PROPERLY, IS ACCURATE OR COMPLETE, OR IS WITHOUT
+      ERROR OR DEFECT.
+
+   6. GENERAL: This License shall be governed by and interpreted in
+      accordance with the laws of the State of California, excluding its
+      conflict of laws provisions. You agree to comply with all applicable
+      United States export laws, rules, and regulations. If any provision of
+      this License is judged illegal, invalid, or otherwise unenforceable,
+      that provision shall be severed and the rest of the License shall
+      remain in full force and effect. No failure by Cisco to enforce any of
+      its rights related to the Sample Code or to a breach of this License
+      in a particular situation will act as a waiver of such rights. In the
+      event of any inconsistencies with any other terms, this License shall
+      take precedence.

README.md

@@ -0,0 +1,105 @@
+# Webex Control Hub Alerts Servicenow Integration
+
+This integration creates ServiceNow Incidents based on received Control Hub Alerts. Incidents are created with a combination of `custom configuration` and raw alert data. 
+
+**Note**: This integration does **NOT** clear alerts on Webex Control Hub when they are resolved in ServiceNow, and this integration sets ServiceNow Incident `Short Description` to the name of the Alerting Device.
+
+Supported Control Hub Alerts:
+* Device Offline (10 minutes - not configurable)
+* Issues:
+  * Audio (Microphone Connected)
+  * Camera (Pairing)
+  * Display (Missing Display, Missing Third Display)
+  * System (Connection)
+  * Touch Panel (Connection)
+  * Video (OSD Video Output)
+* Device Live Meeting Alert (latency, loss, etc.)
+
+## Contacts
+* Trevor Maco
+
+## Solution Components
+* Webex Control Hub 
+* ServiceNow
+
+## Prerequisites
+### Control Hub Configurations
+In order to create ServiceNow incidents based on Webex Control Hub Alerts, a `Webhook` and `Alert Rule` must be defined in Control Hub.
+* `Webhook`: To create a Webhook, follow this [documentation](https://help.webex.com/en-us/article/3gv4ci/Enable-webhooks-for-alerts-in-Control-Hub). The Webhook URL must be the HTTPS URL of the machine hosting this integration (publicly reachable from the Internet). For local testing, [ngrok](https://ngrok.com/download) can be used by copying the URL from the following command:
+```
+ngrok http 5000
+```
+**Note**: please include a `Secret Token`, and note it down for later.
+
+* `Alert Rule`: To create an Alert Rule, follow this [documentation](https://help.webex.com/en-us/article/u3uiam/Device-alerts-in-Control-Hub). Be sure to selected `Webhook` as one of the Delivery channels! Make sure the chosen alert is supported by this application.
+
+### Alert to ServiceNow Custom Configuration
+This integration utilizes configurations mapped to each supported alert type which include the fields required by the ServiceNow API. Configurations are organized in the `alert_configurations` folder by `Service` (devices, meetings) and `Type` (issues, offline_online, device_live_meeting). 
+
+Configurations are within the respective `config.json`. **DO NOT** modify the top level values (ex: `offline`). All other fields can be modified, and they control ticket creation behavior for the specified alert.
+
+### ServiceNow
+For integrating with ServiceNow, gather the `url` and `username`/`password` for a ServiceNow Admin associated with the target ServiceNow instance. A free developer instance can be created with the [Developer Program](https://developer.servicenow.com/)
+
+### Docker
+This app provides a `Docker` file for easy deployment. `Docker` is the recommended deployment method. Install `Docker` [here](https://docs.docker.com/get-docker/).
+
+## Installation/Configuration
+1. Clone this repository with `git clone [repository name]`. To find the repository name, click the green `Code` button above the repository files. Then, the dropdown menu will show the https domain name. Click the copy button to the right of the domain name to get the value to replace [repository name] placeholder.
+![git-clone.png](git-clone.png)
+2. Rename the `.env_sample` file to `.env`.
+3. Add the Control Hub Webhook `Secret Token` to `.env` from the prerequisites section.
+```dotenv
+# Webex Control Hub Webhook Configs
+WEBHOOK_SECRET="secret"
+```
+4. Add the `ServiceNow Instance Variables` to `.env` from the prerequisites section.
+```dotenv
+# ServiceNow Section
+SERVICENOW_INSTANCE="https://<something>.com"
+SERVICENOW_USERNAME="admin"
+SERVICENOW_PASSWORD="admin"
+```
+5. Set up a Python virtual environment. Make sure Python 3 is installed in your environment, and if not, you may download Python [here](https://www.python.org/downloads/). Once Python 3 is installed in your environment, you can activate the virtual environment with the instructions found [here](https://docs.python.org/3/tutorial/venv.html).
+6. Install the requirements with `pip3 install -r requirements.txt`
+
+## Usage
+To run this integration, use the following command to run with python directly:
+```
+$ python3 src/app.py
+```
+or with the docker command:
+```
+$ docker-compose up -d --build
+```
+
+**Notes**: 
+* App logs and output are written to stdout console and log files in `src/logs`
+
+Once the app is running, it's now ready to receive Webhook Alerts from Control Hub. When an Alert is received (ex: "Device Offline"), the following output will be displayed to the console:
+
+![console_output.png](IMAGES/console_output.png)
+
+and a ServiceNow Ticket will be created:
+
+![servicenow.png](IMAGES/servicenow.png)
+
+
+![/IMAGES/0image.png](/IMAGES/0image.png)
+
+
+### LICENSE
+
+Provided under Cisco Sample Code License, for details see [LICENSE](LICENSE.md)
+
+### CODE_OF_CONDUCT
+
+Our code of conduct is available [here](CODE_OF_CONDUCT.md)
+
+### CONTRIBUTING
+
+See our contributing guidelines [here](CONTRIBUTING.md)
+
+#### DISCLAIMER:
+<b>Please note:</b> This script is meant for demo purposes only. All tools/ scripts in this repo are released for use "AS IS" without any warranties of any kind, including, but not limited to their installation, use, or performance. Any use of these scripts and tools is at your own risk. There is no guarantee that they have been through thorough testing in a comparable environment and we are not responsible for any damage or data loss incurred with their use.
+You are responsible for reviewing and testing any scripts you run thoroughly before use in any non-testing environment.

docker-compose.yml

@@ -0,0 +1,18 @@
+version: "3.5"
+
+services:
+  gve_devnet_webex_controlhub_alerts_servicenow_integration:
+    image: ghcr.io/gve-sw/gve_devnet_webex_controlhub_alerts_servicenow_integration:latest
+#    build: .
+    container_name: gve_devnet_webex_controlhub_alerts_servicenow_integration
+    environment:
+      - WEBHOOK_SECRET=${WEBHOOK_SECRET}
+      - SERVICENOW_INSTANCE=${SERVICENOW_INSTANCE}
+      - SERVICENOW_USERNAME=${SERVICENOW_USERNAME}
+      - SERVICENOW_PASSWORD=${SERVICENOW_PASSWORD}
+    ports:
+      - "5000:5000"
+    volumes:
+      - ./src/logs:/app/logs
+      - ./src/alert_configurations:/app/alert_configurations
+    restart: "always"

requirements.txt

@@ -0,0 +1,17 @@
+blinker==1.7.0
+certifi==2023.11.17
+charset-normalizer==3.3.2
+click==8.1.7
+Flask==3.0.0
+idna==3.6
+itsdangerous==2.1.2
+Jinja2==3.1.2
+markdown-it-py==3.0.0
+MarkupSafe==2.1.3
+mdurl==0.1.2
+Pygments==2.17.2
+python-dotenv==1.0.0
+requests==2.31.0
+rich==13.7.0
+urllib3==2.1.0
+Werkzeug==3.0.1