├── .github └── workflows │ ├── main.yml │ └── ziti-webhook.yml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── SECURITY.md └── docker-compose.yml /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Main Workflow 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | jobs: 7 | call-webhook-workflow: 8 | name: Call the On-Demand Webhook Workflow 9 | uses: ./.github/workflows/ziti-webhook.yml 10 | secrets: inherit 11 | -------------------------------------------------------------------------------- /.github/workflows/ziti-webhook.yml: -------------------------------------------------------------------------------- 1 | name: Ziti Webhook Workflow 2 | on: 3 | workflow_call: 4 | 5 | jobs: 6 | ziti-webhook: 7 | runs-on: ubuntu-latest 8 | name: Ziti Webhook Job 9 | steps: 10 | - name: Send Webhook 11 | uses: openziti/ziti-webhook-action-py@v1 12 | if: ${{ env.ZITI_WEBHOOK_IDENTITY != null }} 13 | env: 14 | ZITI_WEBHOOK_IDENTITY: ${{ secrets.ZITI_WEBHOOK_IDENTITY }} 15 | with: 16 | zitiId: ${{ secrets.ZITI_WEBHOOK_IDENTITY }} 17 | webhookUrl: http://webhookz.ziti/post 18 | eventJson: ${{ toJson(github.event) }} 19 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.json 2 | *.jwt 3 | *.log 4 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Code of Conduct 2 | 3 | All open source projects managed by OpenZiti share a common [code of conduct](https://docs.openziti.io/policies/CODE_OF_CONDUCT.html) 4 | which all contributors are expected to follow. Please be sure you read, understand and adhere to the guidelines expressed therein. 5 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | NetFoundry welcomes all and any contributions. All open source projects managed by NetFoundry share a common 4 | [guide for contributions](https://docs.openziti.io/policies/CONTRIBUTING.html). 5 | 6 | If you are eager to contribute to a NetFoundry-managed open source project please read and act accordingly. 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright NetFoundry Inc. 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # webhookz 2 | 3 | This repo sends a GitHub webhook to a private server with the [OpenZiti Webhook Action](https://github.com/marketplace/actions/ziti-webhook-action-python) over a zero trust, private network based on [OpenZiti](https://github.com/openziti/ziti#readme) ![GitHub Repo stars](https://img.shields.io/github/stars/openziti/ziti?style=social). 4 | 5 | ## Use this template repository 6 | 7 | Do this first: there's a button in the GitHub UI to "Use this template" which will give you a blank commit history in a repo generated from this one. Clone your new repo and follow the steps below in your Git working copy directory. 8 | 9 | ## Decide how you will configure your OpenZiti Network 10 | 11 | You might prefer to self-host your network or you may use the network provided by the Ziti Edge Developer Sandbox (ZEDS). Self-hosting means you won't need to sign up for anything and you'll have full transparency of the open source software and total control of the network. ZEDS requires a painless and free-forever signup for a private developer sandbox on shared servers and does provide end to end encryption like all OpenZiti Networks. 12 | 13 | ## Hosting Option 1: Configure a self-hosted OpenZiti Network 14 | 15 | The steps for this hosting option will guide you to self-host an OpenZiti Network by following [the "Run on your own server" quickstart](https://openziti.github.io/ziti/quickstarts/network/hosted.html). 16 | 17 | With that zero trust overlay in place you can follow these steps on your OpenZiti server to add the necessary entities. 18 | 19 | 1. Create an identity for the webhook sender i.e. API consumer / client 20 | 21 | ```bash 22 | ziti edge create identity device github --jwt-output-file github.jwt --role-attributes webhookz-senders 23 | ``` 24 | 25 | 1. Create an identity for the webhook server 26 | 27 | ```bash 28 | ziti edge create identity device server --jwt-output-file server.jwt --role-attributes webhookz-servers 29 | ``` 30 | 31 | 1. Create a config with type `intercept.v1`. 32 | 33 | ```bash 34 | ziti edge create config webhookz-intercept-config intercept.v1 '{"protocols":["tcp"],"addresses":["webhookz.ziti"], "portRanges":[{"low":80, "high":80}]}' 35 | ``` 36 | 37 | 1. Create a config with type `host.v1` 38 | 39 | ```bash 40 | ziti edge create config webhookz-host-config host.v1 '{"protocol":"tcp", "address":"httpbin","port":8080}' 41 | ``` 42 | 43 | 1. Create a service to associate the two configs 44 | 45 | ```bash 46 | ziti edge create service webhookz-service --configs webhookz-intercept-config,webhookz-host-config 47 | ``` 48 | 49 | 1. Create a bind service policy 50 | 51 | ```bash 52 | ziti edge create service-policy webhookz-bind-policy Bind --service-roles '@webhookz-service' --identity-roles '#webhookz-servers' 53 | ``` 54 | 55 | 1. Create a dial service policy 56 | 57 | ```bash 58 | ziti edge create service-policy webhookz-dial-policy Dial --service-roles '@webhookz-service' --identity-roles '#webhookz-senders' 59 | ``` 60 | 61 | 1. Copy "github.jwt" and "server.jwt" from the OpenZiti server to the computer where you cloned this repo. 62 | 63 | ## Hosting Option 2: Configure OpenZiti with the Developer Sandbox 64 | 65 | We'll use Ziti Edge Developer Sandbox (ZEDS) in this example. 66 | 67 | 1. Sign up for a free developer account at https://zeds.openziti.org/. We'll create a couple of identities to attach to an OpenZiti network provided by ZEDS. 68 | 1. In ZEDS, follow the "build your app" button. Populate the form with an app name like "my webhook app", two identities "github" and "server", and a service named "webhookz". Finish up with the "build my app" button. 69 | 1. On the following screen click the edit button for the service "webhookz". 70 | 1. Create a config with type `intercept.v1`. 71 | 72 | ```json 73 | { 74 | "addresses": [ 75 | "webhookz.ziti" 76 | ], 77 | "protocols": [ 78 | "tcp" 79 | ], 80 | "portRanges": [ 81 | { 82 | "low": 80, 83 | "high": 80 84 | } 85 | ] 86 | } 87 | ``` 88 | 89 | 1. Create a config with type `host.v1`. 90 | 91 | ```json 92 | { 93 | "port": 8080, 94 | "address": "httpbin", 95 | "protocol": "tcp" 96 | } 97 | ``` 98 | 99 | 1. Go back to "manage app" and click the download buttons to get the token files for identities "github" and "server". 100 | 101 | ## Run the private webhook server 102 | 103 | A private webhook server is included in this repo as a Docker Compose project to demonstrate how to publish an unmodified API producer with OpenZiti. These steps will guide you run and publish the server so it can receive the GitHub webhook via OpenZiti. The Compose project provides an OpenZiti sidecar to host the service that provides zero trust ingress to the server in an isolated Docker network. 104 | 105 | ![webhookz drawio (2)](https://user-images.githubusercontent.com/1434400/191101246-dcb23b17-3e33-4b67-98b7-51d7e4a7126e.svg) 106 | 107 | 1. Copy "github.jwt" and "server.jwt" into the directory where you cloned this repo. 108 | 1. In your terminal, change to the directory where you cloned this repo. Enroll "github" to obtain the identity file "github.json" in the current directory. 109 | 110 | ```bash 111 | docker run --rm --volume ${PWD}:/mnt/ openziti/quickstart /openziti/ziti-bin/ziti edge enroll /mnt/github.jwt 112 | ``` 113 | 114 | 1. In the GitHub UI, create a new GitHub Actions secret named `ZITI_WEBHOOK_IDENTITY` with the contents of "github.json". 115 | 1. In your terminal, run the Docker Compose project to start the demo webhook server and OpenZiti tunneler. 116 | 117 | ```bash 118 | docker compose up --detach 119 | ``` 120 | 121 | You should now have a new file "server.json" in the directory where you cloned this repo. That is the OpenZiti identity file used by the tunneler running in one of the containers. 122 | 123 | 1. Finally, trigger the GitHub Actions workflow to demonstrate sending a GitHub webhook to your private server. Navigate to "Actions" / "Main Workflow" in the GitHub UI and punch the "Run workflow" button. You may instead trigger it with the GitHub CLI if your current directory is repo. 124 | 125 | ```bash 126 | gh workflow run main.yml 127 | ``` 128 | 129 | 1. Optionally, follow the private server's log to see the webhook activity from GitHub 130 | 131 | ```bash 132 | docker compose logs --follow httpbin 133 | ``` 134 | 135 | The result of the triggered workflow will be an HTTP response from the `httpbin` application echoing the payload and headers it received. 136 | 137 | ## Have questions? 138 | 139 | * Follow our [Blog](https://openziti.io/) 140 | * Join [Discussion](https://openziti.discourse.group) 141 | * [Development](https://github.com/openziti) 142 | * [Documentation](https://openziti.github.io) 143 | * Like it? Give us a [star](https://github.com/openziti/ziti) 144 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | Until v1.0.0 or higher is reached, only the most recent version is supported. After v1.0.0 a new version support statement will be released. 6 | 7 | ## Reporting a Vulnerability 8 | 9 | If you have an issue that is not a sensitive security issue, please submit your issue via the GitHub issue tracker on either the main repository. 10 | 11 | If you have a sensitive security issue or are unsure if it is sensitive, please email it to: security@openziti.org 12 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.6' 2 | 3 | services: 4 | httpbin: 5 | image: mccutchen/go-httpbin 6 | # ports: 7 | # - "127.0.0.1:8080:8080/tcp" 8 | ziti-host: 9 | image: openziti/ziti-edge-tunnel 10 | environment: 11 | - NF_REG_NAME=server 12 | volumes: 13 | - .:/ziti-edge-tunnel 14 | command: 15 | - run-host 16 | - --verbose=2 17 | --------------------------------------------------------------------------------