├── .github └── workflows │ └── build.yml ├── LICENSE.txt ├── README.md ├── action.yml ├── main.sh ├── post.sh └── util ├── install.ps1 ├── install.sh └── post ├── action.yml └── main.js /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: zerotier 2 | on: [ push ] 3 | 4 | jobs: 5 | build: 6 | strategy: 7 | matrix: 8 | # os: [ ubuntu-latest ] 9 | os: [ ubuntu-latest, macos-latest, windows-latest ] 10 | runs-on: ${{ matrix.os }} 11 | steps: 12 | - name: checkout 13 | uses: actions/checkout@v4.0.0 14 | 15 | - name: zerotier 16 | uses: ./ 17 | with: 18 | network_id: ${{ secrets.ZEROTIER_NETWORK_ID }} 19 | auth_token: ${{ secrets.ZEROTIER_CENTRAL_TOKEN }} 20 | 21 | - name: ping host 22 | shell: bash 23 | run: | 24 | count=10 25 | while ! ping -c 1 ${{ secrets.ZEROTIER_HOST_IP }} ; do 26 | echo "waiting..." ; 27 | sleep 1 ; 28 | let count=count-1 29 | done 30 | echo "ping success" 31 | 32 | test: 33 | strategy: 34 | matrix: 35 | # os: [ ubuntu-latest ] 36 | os: [ ubuntu-latest, macos-latest, windows-latest ] 37 | runs-on: ${{ matrix.os }} 38 | if: ${{ github.ref_name }} == "main" 39 | steps: 40 | - name: zerotier 41 | uses: zerotier/github-action@main 42 | with: 43 | network_id: ${{ secrets.ZEROTIER_NETWORK_ID }} 44 | auth_token: ${{ secrets.ZEROTIER_CENTRAL_TOKEN }} 45 | 46 | - name: ping host 47 | shell: bash 48 | run: | 49 | count=10 50 | while ! ping -c 1 ${{ secrets.ZEROTIER_HOST_IP }} ; do 51 | echo "waiting..." ; 52 | sleep 1 ; 53 | let count=count-1 54 | done 55 | echo "ping success" 56 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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 [yyyy] [name of copyright owner] 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 | # ZeroTier GitHub Action 2 | 3 | ZeroTier is an SDN platform that allows users to create virtual 4 | networks that can span multiple devices, locations, and cloud 5 | providers. ZeroTier creates an encrypted peer-to-peer mesh overlay 6 | network that handles NAT traversal and authentication to network 7 | resources. 8 | 9 | The ZeroTier Github Action allows users to easily integrate 10 | ZeroTier into their CI/CD workflows by temporarily joining and 11 | authorizing runners onto private ZeroTier networks. 12 | 13 | ```yaml 14 | - name: ZeroTier 15 | uses: zerotier/github-action@v1.0.1 16 | with: 17 | network_id: ${{ secrets.ZEROTIER_NETWORK_ID }} 18 | auth_token: ${{ secrets.ZEROTIER_CENTRAL_TOKEN }} 19 | ``` 20 | 21 | `ZEROTIER_CENTRAL_TOKEN` can be provisioned from `Account` section in the [ZeroTier Central](https://my.zerotier.com) admin panel. 22 | 23 | This Action works on Ubuntu, MacOS, and Windows runners. 24 | 25 | ---- 26 | 27 | This action installs ZeroTier on the runner node and generates a unique ZeroTier identity. 28 | It then uses the supplied `auth_token` to authorize the runner onto the network. 29 | 30 | ```yaml 31 | - name: ZeroTier 32 | uses: zerotier/github-action@v1.0.1 33 | with: 34 | network_id: ${{ secrets.ZEROTIER_NETWORK_ID }} 35 | auth_token: ${{ secrets.ZEROTIER_CENTRAL_TOKEN }} 36 | 37 | - name: ping host 38 | shell: bash 39 | run: | 40 | count=10 41 | while ! ping -c 1 ${{ secrets.ZEROTIER_HOST_IP }} ; do 42 | echo "waiting..." ; 43 | sleep 1 ; 44 | let count=count-1 45 | done 46 | echo "ping success" 47 | ``` 48 | 49 | After the workflow has completed, a `post` step automatically cleans 50 | up by removing the runner from the network. 51 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: "ZeroTier" 2 | description: "Connect your Github Action workflow to ZeroTier" 3 | branding: 4 | icon: "globe" 5 | color: "gray-dark" 6 | 7 | on: 8 | workflow_call: 9 | 10 | inputs: 11 | network_id: 12 | description: "The ZeroTier network ID to connect to" 13 | required: true 14 | auth_token: 15 | description: "Your ZeroTier Central API Access Token" 16 | required: true 17 | api_url: 18 | description: "ZeroTier Central API URL" 19 | required: false 20 | default: "https://my.zerotier.com/api/v1" 21 | 22 | runs: 23 | using: "composite" 24 | steps: 25 | - name: zerotier 26 | uses: zerotier/github-action/util/post@main 27 | env: 28 | API_URL: ${{ inputs.api_url }} 29 | AUTH_TOKEN: ${{ inputs.auth_token }} 30 | NETWORK_ID: ${{ inputs.network_id }} 31 | with: 32 | main: $GITHUB_ACTION_PATH/main.sh 33 | post: $GITHUB_ACTION_PATH/post.sh 34 | -------------------------------------------------------------------------------- /main.sh: -------------------------------------------------------------------------------- 1 | set -euo pipefail 2 | IFS=$'\n\t' 3 | 4 | echo "⏁ Installing ZeroTier" 5 | # /home/runner/work/zerotier-github-action/zerotier-github-action/./ 6 | echo $GITHUB_ACTION_PATH 7 | 8 | case $(uname -s) in 9 | MINGW64_NT?*) 10 | pwsh "$GITHUB_ACTION_PATH/util/install.ps1" 11 | ztcli="/c/Program Files (x86)/ZeroTier/One/zerotier-cli.bat" 12 | member_id=$("${ztcli}" info | awk '{ print $3 }') 13 | ;; 14 | *) 15 | . $GITHUB_ACTION_PATH/util/install.sh &>/dev/null 16 | member_id=$(sudo zerotier-cli info | awk '{ print $3 }') 17 | ;; 18 | esac 19 | 20 | echo "⏁ Authorizing Runner to ZeroTier network" 21 | MAX_RETRIES=10 22 | RETRY_COUNT=0 23 | 24 | while ! curl -s -X POST \ 25 | -H "Authorization: token $AUTH_TOKEN" \ 26 | -H "Content-Type: application/json" \ 27 | -d '{"name":"Zerotier GitHub Member '"${GITHUB_SHA::7}"'", "description": "Member created by '"${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}"'", "config":{"authorized":true}}' \ 28 | "$API_URL/network/$NETWORK_ID/member/${member_id}" | grep '"authorized":true'; do 29 | RETRY_COUNT=$((RETRY_COUNT + 1)) 30 | 31 | if [ $RETRY_COUNT -ge $MAX_RETRIES ]; then 32 | echo "Reached maximum number of retries ($MAX_RETRIES). Exiting..." 33 | exit 1 34 | fi 35 | 36 | echo "Authorization failed. Retrying in 2 seconds... (Attempt $RETRY_COUNT of $MAX_RETRIES)" 37 | sleep 2 38 | done 39 | 40 | echo "Member authorized successfully." 41 | echo "⏁ Joining ZeroTier Network ID: $NETWORK_ID" 42 | case $(uname -s) in 43 | MINGW64_NT?*) 44 | "${ztcli}" join $NETWORK_ID 45 | while ! "${ztcli}" listnetworks | grep $NETWORK_ID | grep OK; do sleep 0.5; done 46 | ;; 47 | *) 48 | sudo zerotier-cli join $NETWORK_ID 49 | while ! sudo zerotier-cli listnetworks | grep $NETWORK_ID | grep OK; do sleep 0.5; done 50 | ;; 51 | esac 52 | 53 | -------------------------------------------------------------------------------- /post.sh: -------------------------------------------------------------------------------- 1 | set -euo pipefail 2 | IFS=$'\n\t' 3 | 4 | case $(uname -s) in 5 | MINGW64_NT?*) 6 | ztcli="/c/Program Files (x86)/ZeroTier/One/zerotier-cli.bat" 7 | member_id=$("${ztcli}" info | awk '{ print $3 }') 8 | ;; 9 | *) 10 | member_id=$(sudo zerotier-cli info | awk '{ print $3 }') 11 | ;; 12 | esac 13 | 14 | echo "⏁ Removing Runner from ZeroTier network" 15 | curl -i -s -X DELETE -H "Authorization: token $AUTH_TOKEN" "$API_URL/network/$NETWORK_ID/member/${member_id}" >/tmp/api_delete_output.txt 16 | STATUS_CODE=$(cat /tmp/api_delete_output.txt | grep 'HTTP/' | awk '{print $2}') 17 | 18 | if [[ $STATUS_CODE -ge 400 && $STATUS_CODE -le 599 ]]; then 19 | echo "ERROR: Status code: $STATUS_CODE" 20 | echo -e "Complete server response:\n$(cat /tmp/api_delete_output.txt)\n" 21 | exit $STATUS_CODE 22 | else 23 | echo "Success! Status code: $STATUS_CODE" 24 | exit 0 25 | fi 26 | -------------------------------------------------------------------------------- /util/install.ps1: -------------------------------------------------------------------------------- 1 | $uri="https://download.zerotier.com/dist/ZeroTierOne.msi" 2 | $out="ZeroTierOne.msi" 3 | Invoke-WebRequest -uri $uri -OutFile $out 4 | 5 | $file = "ZeroTierOne.msi" 6 | $log = "install.log" 7 | $procMain = Start-Process "msiexec" "/i `"$file`" /qn /l*! `"$log`"" -NoNewWindow -PassThru 8 | # $procLog = Start-Process "powershell" "Get-Content -Path `"$log`" -Wait" -NoNewWindow -PassThru 9 | $procMain.WaitForExit() 10 | # $procLog.Kill() 11 | -------------------------------------------------------------------------------- /util/install.sh: -------------------------------------------------------------------------------- 1 | curl -s https://install.zerotier.com/ | sudo bash 2 | -------------------------------------------------------------------------------- /util/post/action.yml: -------------------------------------------------------------------------------- 1 | # ==================================================================================================================== # 2 | # Authors: # 3 | # Patrick Lehmann # 4 | # Unai Martinez-Corral # 5 | # # 6 | # ==================================================================================================================== # 7 | # Copyright 2020-2022 The pyTooling Authors # 8 | # # 9 | # Licensed under the Apache License, Version 2.0 (the "License"); # 10 | # you may not use this file except in compliance with the License. # 11 | # You may obtain a copy of the License at # 12 | # # 13 | # http://www.apache.org/licenses/LICENSE-2.0 # 14 | # # 15 | # Unless required by applicable law or agreed to in writing, software # 16 | # distributed under the License is distributed on an "AS IS" BASIS, # 17 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # 18 | # See the License for the specific language governing permissions and # 19 | # limitations under the License. # 20 | # # 21 | # SPDX-License-Identifier: Apache-2.0 # 22 | # ==================================================================================================================== # 23 | name: With post step 24 | 25 | description: 'Generic JS Action to execute a main command and set a command as a post step.' 26 | 27 | inputs: 28 | main: 29 | description: 'Main command/script.' 30 | required: true 31 | post: 32 | description: 'Post command/script.' 33 | required: true 34 | key: 35 | description: 'Name of the state variable used to detect the post step.' 36 | required: false 37 | default: POST 38 | 39 | runs: 40 | using: 'node20' 41 | main: 'main.js' 42 | post: 'main.js' 43 | -------------------------------------------------------------------------------- /util/post/main.js: -------------------------------------------------------------------------------- 1 | /* ================================================================================================================== * 2 | * Authors: * 3 | * Unai Martinez-Corral * 4 | * * 5 | * ================================================================================================================== * 6 | * Copyright 2021-2022 Unai Martinez-Corral * 7 | * Copyright 2022 Unai Martinez-Corral * 8 | * * 9 | * Licensed under the Apache License, Version 2.0 (the "License"); * 10 | * you may not use this file except in compliance with the License. * 11 | * You may obtain a copy of the License at * 12 | * * 13 | * http://www.apache.org/licenses/LICENSE-2.0 * 14 | * * 15 | * Unless required by applicable law or agreed to in writing, software * 16 | * distributed under the License is distributed on an "AS IS" BASIS, * 17 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * 18 | * See the License for the specific language governing permissions and * 19 | * limitations under the License. * 20 | * * 21 | * SPDX-License-Identifier: Apache-2.0 * 22 | * ================================================================================================================== * 23 | * * 24 | * Context: * 25 | * * https://github.com/docker/login-action/issues/72 * 26 | * * https://github.com/actions/runner/issues/1478 * 27 | * ================================================================================================================== */ 28 | const { spawn } = require("child_process"); 29 | const fs = require('fs'); 30 | 31 | function run(cmd) { 32 | const subprocess = spawn(cmd, { stdio: "inherit", shell: "bash" }); 33 | subprocess.on("exit", (exitCode) => { 34 | process.exitCode = exitCode; 35 | }); 36 | } 37 | 38 | const key = process.env.INPUT_KEY.toUpperCase(); 39 | 40 | if ( process.env[`STATE_${key}`] !== undefined ) { // Are we in the 'post' step? 41 | run(process.env.INPUT_POST); 42 | } else { // Otherwise, this is the main step 43 | fs.appendFileSync(process.env.GITHUB_STATE, `${key}=true`); 44 | run(process.env.INPUT_MAIN); 45 | } 46 | --------------------------------------------------------------------------------