diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..782912c --- /dev/null +++ b/.dockerignore @@ -0,0 +1,6 @@ +.git +.github +.husky +**/node_modules +**/dist +release/*.tgz diff --git a/.github/workflows/release.test.mjs b/.github/workflows/release.test.mjs new file mode 100644 index 0000000..b210b6a --- /dev/null +++ b/.github/workflows/release.test.mjs @@ -0,0 +1,35 @@ +import assert from "node:assert/strict"; +import { readFile } from "node:fs/promises"; +import test from "node:test"; + +const workflowUrl = new URL("./release.yml", import.meta.url); + +test("the release workflow builds both commands on every supported host architecture", async () => { + const workflow = await readFile(workflowUrl, "utf8"); + + assert.match(workflow, /pull_request:/); + for (const runner of ["ubuntu-latest", "ubuntu-24.04-arm", "macos-15-intel", "macos-15"]) { + assert.match(workflow, new RegExp(`runner: ${runner}`)); + } + assert.match(workflow, /pnpm --filter @egresskit\/egressd build/); + assert.match(workflow, /dist\/control-cli-bin\.js/); + assert.match(workflow, /dist\/cli\.js/); + assert.match(workflow, /archive=.*egresskit-\$\{\{ matrix\.name \}\}\.tgz/); + assert.match(workflow, /pnpm --dir .* add "\$archive"/); + assert.doesNotMatch(workflow, /add --offline "\$archive"/); + assert.match(workflow, /node_modules\/\.bin\/egresskit/); + assert.match(workflow, /node_modules\/\.bin\/egressd/); + assert.doesNotMatch(workflow, /host-artifacts:[\s\S]*?- run: pnpm verify/); + assert.match(workflow, /docker\/build-push-action/); + assert.match(workflow, /linux\/amd64,linux\/arm64/); + assert.match(workflow, /gh release (create|upload)/); + assert.doesNotMatch(workflow, /uses: [^\n]+@v\d/); + assert.match(workflow, /packages: write/); + assert.match(workflow, /contents: write/); + assert.match(workflow, /actionlint/); + assert.match(workflow, /quality:[\s\S]*?run: pnpm verify/); + assert.match(workflow, /needs: \[quality, docker-validation\]/); + assert.match(workflow, /needs: \[quality, host-artifacts, docker-publish\]/); + assert.match(workflow, /load: true/); + assert.match(workflow, /127\.0\.0\.1::8787/); +}); diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..5ea6479 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,183 @@ +name: Release artifacts + +on: + pull_request: + workflow_dispatch: + push: + tags: + - "v*" + +permissions: + contents: read + +jobs: + workflow-lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6 + - name: Validate GitHub Actions workflows + run: go run github.com/rhysd/actionlint/cmd/actionlint@914e7df21a07ef503a81201c76d2b11c789d3fca + + quality: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6 + - uses: pnpm/action-setup@f40ffcd9367d9f12939873eb1018b921a783ffaa # v4 + - uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6 + with: + node-version: 22 + cache: pnpm + - run: pnpm install --frozen-lockfile + - run: pnpm verify + + host-artifacts: + name: ${{ matrix.name }} + strategy: + fail-fast: false + matrix: + include: + - name: linux-x64 + runner: ubuntu-latest + - name: linux-arm64 + runner: ubuntu-24.04-arm + - name: macos-x64 + runner: macos-15-intel + - name: macos-arm64 + runner: macos-15 + runs-on: ${{ matrix.runner }} + steps: + - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6 + - uses: pnpm/action-setup@f40ffcd9367d9f12939873eb1018b921a783ffaa # v4 + - uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6 + with: + node-version: 22 + cache: pnpm + - run: pnpm install --frozen-lockfile + - run: pnpm --filter @egresskit/egressd build + - name: Stamp tag version + if: startsWith(github.ref, 'refs/tags/v') + run: node release/set-package-version.mjs "$GITHUB_REF_NAME" apps/egressd/package.json + - name: Assemble CLI and daemon archive + shell: bash + run: | + test -f apps/egressd/dist/control-cli-bin.js + test -f apps/egressd/dist/cli.js + pnpm --filter @egresskit/egressd pack --pack-destination release + mv release/egresskit-egressd-*.tgz "release/egresskit-${{ matrix.name }}.tgz" + - name: Install and invoke both packaged commands + shell: bash + run: | + install_dir=$(mktemp -d) + trap 'rm -rf "$install_dir"' EXIT + archive="$GITHUB_WORKSPACE/release/egresskit-${{ matrix.name }}.tgz" + pnpm --dir "$install_dir" add "$archive" + if "$install_dir/node_modules/.bin/egresskit" runtime install --destination 2>"$install_dir/egresskit.stderr"; then + exit 1 + fi + grep -F -- '--destination requires a path' "$install_dir/egresskit.stderr" + if env EGRESSKIT_ADMIN_TOKEN=validation-admin EGRESSKIT_HOST=127.0.0.1 \ + EGRESSKIT_PROXY_TOKEN= "$install_dir/node_modules/.bin/egressd" 2>"$install_dir/egressd.stderr"; then + exit 1 + fi + grep -F -- 'EGRESSKIT_PROXY_TOKEN must not be empty' "$install_dir/egressd.stderr" + - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 + with: + name: egresskit-${{ matrix.name }} + path: release/egresskit-${{ matrix.name }}.tgz + + docker-validation: + name: docker-${{ matrix.name }} + strategy: + fail-fast: false + matrix: + include: + - name: amd64 + platform: linux/amd64 + - name: arm64 + platform: linux/arm64 + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6 + - uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3 + - uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3 + - uses: docker/build-push-action@10e90e3645eae34f1e60eeb005ba3a3d33f178e8 # v6 + with: + context: . + file: docker/Dockerfile + platforms: ${{ matrix.platform }} + load: true + tags: egresskit:validation-${{ matrix.name }} + - name: Probe runtime and container boundary + shell: bash + run: | + image="egresskit:validation-${{ matrix.name }}" + docker run --rm --entrypoint mihomo "$image" -v | grep -F 'Mihomo Meta v1.19.30' + docker run --rm --entrypoint sh "$image" -c \ + 'test -r /usr/share/licenses/egresskit/LICENSE && test -r /usr/share/licenses/egresskit/THIRD_PARTY_NOTICES.md && test -r /usr/share/licenses/egresskit/Mihomo-GPL-3.0.txt' + container=$(docker run --detach --publish 127.0.0.1::8787 \ + --env EGRESSKIT_ADMIN_TOKEN=validation-admin \ + --env EGRESSKIT_PROXY_TOKEN=validation-proxy \ + "$image") + trap 'docker rm --force "$container" >/dev/null' EXIT + port=$(docker port "$container" 8787/tcp | sed 's/.*://') + for _ in 1 2 3 4 5 6 7 8 9 10; do + if curl --fail --silent "http://127.0.0.1:${port}/live" | grep -F '"status":"live"'; then + exit 0 + fi + sleep 1 + done + docker logs "$container" + exit 1 + + docker-publish: + if: startsWith(github.ref, 'refs/tags/v') + needs: [quality, docker-validation] + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + steps: + - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6 + - uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3 + - uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3 + - uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5 + id: meta + with: + images: ghcr.io/heyjunpenn/egresskit + tags: type=ref,event=tag + - uses: docker/build-push-action@10e90e3645eae34f1e60eeb005ba3a3d33f178e8 # v6 + with: + context: . + file: docker/Dockerfile + platforms: linux/amd64,linux/arm64 + push: true + tags: ${{ steps.meta.outputs.tags }} + provenance: mode=max + sbom: true + + github-release: + if: startsWith(github.ref, 'refs/tags/v') + needs: [quality, host-artifacts, docker-publish] + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5 + with: + pattern: egresskit-* + path: release-assets + merge-multiple: true + - name: Attach archives to the GitHub Release + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + if gh release view "$GITHUB_REF_NAME" >/dev/null 2>&1; then + gh release upload "$GITHUB_REF_NAME" release-assets/*.tgz --clobber + else + gh release create "$GITHUB_REF_NAME" release-assets/*.tgz --verify-tag --generate-notes + fi diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md new file mode 100644 index 0000000..8914a5d --- /dev/null +++ b/THIRD_PARTY_NOTICES.md @@ -0,0 +1,15 @@ +# Third-party notices + +EgressKit is licensed under Apache-2.0. Its source distribution and release artifacts include the +license text in `LICENSE`. + +The EgressKit Docker image redistributes the unmodified official +[MetaCubeX/mihomo](https://github.com/MetaCubeX/mihomo) executable at version `v1.19.30` as a +separate process. Mihomo is licensed under GPL-3.0. The corresponding license text is included at +`licenses/Mihomo-GPL-3.0.txt` in release archives and at +`/usr/share/licenses/egresskit/Mihomo-GPL-3.0.txt` in the image. + +The exact corresponding Mihomo source can be obtained from the upstream +[`v1.19.30` source tree](https://github.com/MetaCubeX/mihomo/tree/v1.19.30) or its source archive. +EgressKit does not modify or link Mihomo; it invokes the executable through process and local HTTP +boundaries. diff --git a/apps/egressd/LICENSE b/apps/egressd/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/apps/egressd/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/apps/egressd/THIRD_PARTY_NOTICES.md b/apps/egressd/THIRD_PARTY_NOTICES.md new file mode 100644 index 0000000..8914a5d --- /dev/null +++ b/apps/egressd/THIRD_PARTY_NOTICES.md @@ -0,0 +1,15 @@ +# Third-party notices + +EgressKit is licensed under Apache-2.0. Its source distribution and release artifacts include the +license text in `LICENSE`. + +The EgressKit Docker image redistributes the unmodified official +[MetaCubeX/mihomo](https://github.com/MetaCubeX/mihomo) executable at version `v1.19.30` as a +separate process. Mihomo is licensed under GPL-3.0. The corresponding license text is included at +`licenses/Mihomo-GPL-3.0.txt` in release archives and at +`/usr/share/licenses/egresskit/Mihomo-GPL-3.0.txt` in the image. + +The exact corresponding Mihomo source can be obtained from the upstream +[`v1.19.30` source tree](https://github.com/MetaCubeX/mihomo/tree/v1.19.30) or its source archive. +EgressKit does not modify or link Mihomo; it invokes the executable through process and local HTTP +boundaries. diff --git a/apps/egressd/licenses/Mihomo-GPL-3.0.txt b/apps/egressd/licenses/Mihomo-GPL-3.0.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/apps/egressd/licenses/Mihomo-GPL-3.0.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/apps/egressd/package.json b/apps/egressd/package.json index 8a127ae..0c1d4cf 100644 --- a/apps/egressd/package.json +++ b/apps/egressd/package.json @@ -3,6 +3,17 @@ "version": "0.0.0", "private": true, "type": "module", + "license": "Apache-2.0", + "repository": { + "type": "git", + "url": "https://github.com/heyjunpenn/EgressKit.git" + }, + "files": [ + "dist", + "LICENSE", + "THIRD_PARTY_NOTICES.md", + "licenses" + ], "bin": { "egresskit": "dist/control-cli-bin.js", "egressd": "dist/cli.js" @@ -11,11 +22,11 @@ "node": ">=22" }, "scripts": { - "build": "tsc --project tsconfig.build.json --noEmit false --outDir dist", + "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc --project tsconfig.build.json --noEmit false --outDir dist", "check": "pnpm typecheck", "lint": "biome check .", "lint:fix": "biome check --write .", - "test": "pnpm run build && node --import tsx --test src/*.test.ts", + "test": "pnpm run build && node run-tests.mjs", "typecheck": "tsc --noEmit" }, "devDependencies": { diff --git a/apps/egressd/release-package.test.mjs b/apps/egressd/release-package.test.mjs new file mode 100644 index 0000000..f74ebe8 --- /dev/null +++ b/apps/egressd/release-package.test.mjs @@ -0,0 +1,82 @@ +import assert from "node:assert/strict"; +import { execFile } from "node:child_process"; +import { mkdtemp, readFile, rm, unlink } from "node:fs/promises"; +import { tmpdir } from "node:os"; +import { join } from "node:path"; +import test from "node:test"; +import { promisify } from "node:util"; + +const execFileAsync = promisify(execFile); +const root = new URL("../../", import.meta.url); + +async function text(path) { + return readFile(new URL(path, root), "utf8"); +} + +test("release metadata identifies EgressKit and redistributed Mihomo licenses", async () => { + const [rootPackage, appPackage, notice, apache, gpl] = await Promise.all([ + text("package.json"), + text("apps/egressd/package.json"), + text("THIRD_PARTY_NOTICES.md"), + text("LICENSE"), + text("licenses/Mihomo-GPL-3.0.txt"), + ]); + + assert.equal(JSON.parse(rootPackage).license, "Apache-2.0"); + assert.equal(JSON.parse(appPackage).license, "Apache-2.0"); + assert.match(apache, /Apache License[\s\S]*Version 2\.0/); + assert.match(gpl, /GNU GENERAL PUBLIC LICENSE[\s\S]*Version 3/); + assert.match(notice, /MetaCubeX\/mihomo/); + assert.match(notice, /v1\.19\.30/); + assert.match(notice, /GPL-3\.0/); + assert.match(notice, /github\.com\/MetaCubeX\/mihomo\/tree\/v1\.19\.30/); +}); + +test("the packaged release contains both built entry points and legal files", async () => { + await execFileAsync("pnpm", ["--filter", "@egresskit/egressd", "build"], { cwd: root }); + const { stdout } = await execFileAsync( + "pnpm", + ["--filter", "@egresskit/egressd", "pack", "--pack-destination", "release"], + { cwd: root }, + ); + const archive = stdout.trim().split("\n").at(-1); + assert.ok(archive); + const installation = await mkdtemp(join(tmpdir(), "egresskit-package-install-")); + try { + const { stdout: listing } = await execFileAsync("tar", ["-tzf", archive], { cwd: root }); + + for (const path of [ + "package/dist/control-cli-bin.js", + "package/dist/cli.js", + "package/LICENSE", + "package/THIRD_PARTY_NOTICES.md", + "package/licenses/Mihomo-GPL-3.0.txt", + ]) { + assert.match(listing, new RegExp(`^${path}$`, "m")); + } + + await execFileAsync("npm", ["install", "--ignore-scripts", "--no-package-lock", archive], { + cwd: installation, + }); + const binDirectory = join(installation, "node_modules", ".bin"); + await assert.rejects( + execFileAsync(join(binDirectory, "egresskit"), ["runtime", "install", "--destination"]), + (error) => error.code === 1 && error.stderr.includes("--destination requires a path"), + ); + await assert.rejects( + execFileAsync(join(binDirectory, "egressd"), [], { + env: { + ...process.env, + EGRESSKIT_ADMIN_TOKEN: "package-test-admin", + EGRESSKIT_HOST: "0.0.0.0", + EGRESSKIT_PROXY_TOKEN: "", + }, + }), + (error) => + error.code === 1 && error.stderr.includes("EGRESSKIT_PROXY_TOKEN must not be empty"), + ); + } finally { + await unlink(archive); + await rm(installation, { recursive: true, force: true }); + } +}); diff --git a/apps/egressd/run-tests.mjs b/apps/egressd/run-tests.mjs new file mode 100644 index 0000000..5fc186b --- /dev/null +++ b/apps/egressd/run-tests.mjs @@ -0,0 +1,22 @@ +import { spawnSync } from "node:child_process"; +import { readdirSync } from "node:fs"; + +const testFiles = readdirSync("src") + .filter((file) => file.endsWith(".test.ts")) + .sort() + .map((file) => `src/${file}`); + +for (const testFile of testFiles) { + process.stdout.write(`\nRunning ${testFile}\n`); + const result = spawnSync(process.execPath, ["--import", "tsx", "--test", testFile], { + stdio: "inherit", + timeout: 30_000, + }); + if (result.error?.code === "ETIMEDOUT") { + process.stderr.write(`${testFile} exceeded the 30 second test-file timeout\n`); + process.exit(1); + } + if (result.status !== 0) { + process.exit(result.status ?? 1); + } +} diff --git a/apps/egressd/src/control-api.test.ts b/apps/egressd/src/control-api.test.ts index 824e128..14fdbca 100644 --- a/apps/egressd/src/control-api.test.ts +++ b/apps/egressd/src/control-api.test.ts @@ -15,7 +15,6 @@ import { startSimulatedMihomoListener, startTargetServer } from "./testing/harne test("HTTP redacts subscription URLs while authenticated local socket access can reveal them", async (t) => { const directory = await mkdtemp(join(tmpdir(), "egresskit-control-api-")); - t.after(() => rm(directory, { force: true, recursive: true })); const socketPath = join(directory, "egressd.sock"); const daemon = await startEgressd({ adminToken: "admin-secret", @@ -37,7 +36,10 @@ test("HTTP redacts subscription URLs while authenticated local socket access can port: 0, stateDirectory: join(directory, "state"), }); - t.after(() => daemon.close()); + t.after(async () => { + await daemon.close(); + await rm(directory, { force: true, recursive: true }); + }); assert.equal((await stat(socketPath)).mode & 0o777, 0o600); const secretUrl = "https://provider.example/subscription?token=secret"; const created = await socketJson(socketPath, "POST", "/subscriptions/remote", "admin-secret", { @@ -63,7 +65,7 @@ test("HTTP redacts subscription URLs while authenticated local socket access can const remote = await fetch( `http://${daemon.address.host}:${daemon.address.port}/subscriptions/${subscriptionId}`, - { headers: { authorization: "Bearer admin-secret" } }, + { headers: { authorization: "Bearer admin-secret", connection: "close" } }, ); const remoteBody = (await remote.json()) as { url: string }; assert.equal(remote.status, 200); @@ -76,6 +78,7 @@ test("HTTP redacts subscription URLs while authenticated local socket access can body: JSON.stringify({ url: "not-a-url-with-secret" }), headers: { authorization: "Bearer admin-secret", + connection: "close", "content-type": "application/json", }, method: "POST", @@ -87,14 +90,14 @@ test("HTTP redacts subscription URLs while authenticated local socket access can `http://${daemon.address.host}:${daemon.address.port}/subscriptions/local`, { body: "proxies:\n - { name: local, type: vless, server: local.example.com, port: 443, uuid: 11111111-1111-4111-8111-111111111111 }\n", - headers: { authorization: "Bearer admin-secret" }, + headers: { authorization: "Bearer admin-secret", connection: "close" }, method: "POST", }, ); assert.equal(localImport.status, 201); const httpLocal = await fetch( `http://${daemon.address.host}:${daemon.address.port}/subscriptions/local`, - { headers: { authorization: "Bearer admin-secret" } }, + { headers: { authorization: "Bearer admin-secret", connection: "close" } }, ); assert.deepEqual(await httpLocal.json(), { kind: "local", subscriptionId: "local" }); assert.deepEqual( @@ -105,14 +108,11 @@ test("HTTP redacts subscription URLs while authenticated local socket access can test("authenticated metrics and structured logs expose signals without seeded secrets", async (t) => { const directory = await mkdtemp(join(tmpdir(), "egresskit-observability-")); - t.after(() => rm(directory, { force: true, recursive: true })); const events: unknown[] = []; const privateUuid = "123e4567-e89b-12d3-a456-426614174000"; const secretUrl = `https://private-user:private-password@provider.example:8443/private/path?token=subscription-secret&uuid=${privateUuid}#private`; const target = await startTargetServer([]); - t.after(() => target.close()); const mihomo = await startSimulatedMihomoListener(); - t.after(() => mihomo.close()); const stateDirectory = join(directory, "state"); const daemon = await startEgressd({ adminToken: "controller-secret", @@ -124,14 +124,20 @@ test("authenticated metrics and structured logs expose signals without seeded se proxyAuthentication: { tokens: ["proxy-secret"] }, stateDirectory, }); - t.after(() => daemon.close()); const unauthenticated = await fetch( `http://${daemon.address.host}:${daemon.address.port}/metrics`, ); assert.equal(unauthenticated.status, 401); + await unauthenticated.body?.cancel(); const faultDatabase = new DatabaseSync(join(stateDirectory, "control.sqlite")); - t.after(() => faultDatabase.close()); + t.after(async () => { + faultDatabase.close(); + await daemon.close(); + await mihomo.close(); + await target.close(); + await rm(directory, { force: true, recursive: true }); + }); faultDatabase.exec(` CREATE TRIGGER reject_observed_subscription BEFORE INSERT ON subscriptions diff --git a/apps/egressd/src/daemon.test.ts b/apps/egressd/src/daemon.test.ts index dae7607..6c078ac 100644 --- a/apps/egressd/src/daemon.test.ts +++ b/apps/egressd/src/daemon.test.ts @@ -42,6 +42,19 @@ test("/live reports Node process liveness without a Mihomo listener", async (t) assert.deepEqual(await response.json(), { status: "live" }); }); +test("daemon shutdown closes an idle HTTP keep-alive connection", async () => { + const daemon = await startEgressd({ host: "127.0.0.1", port: 0 }); + const client = connect(daemon.address.port, daemon.address.host); + await once(client, "connect"); + client.write("GET /live HTTP/1.1\r\nHost: localhost\r\nConnection: keep-alive\r\n\r\n"); + await once(client, "data"); + const clientClosed = once(client, "close"); + + await daemon.close(); + await clientClosed; + assert.equal(client.destroyed, true); +}); + test("daemon probes exits through their listeners and exposes manual health control", async (t) => { const targetRequests: Parameters[0] = []; const target = await startTargetServer(targetRequests); @@ -991,6 +1004,33 @@ test("an upstream failure after CONNECT 200 only closes the tunnel", { ); }); +test("daemon shutdown closes an established CONNECT tunnel before reporting completion", { + timeout: 3_000, +}, async (t) => { + const target = await startHttpsTarget([]); + t.after(() => target.close()); + const mihomo = await startSimulatedMihomoListener(); + t.after(() => mihomo.close()); + const daemon = await startEgressd({ + host: "127.0.0.1", + port: 0, + mihomoListener: new URL(`http://${mihomo.host}:${mihomo.port}`), + proxyAuthentication: false, + }); + + const client = connect(daemon.address.port, daemon.address.host); + await once(client, "connect"); + client.write( + `CONNECT ${target.host}:${target.port} HTTP/1.1\r\nHost: ${target.host}:${target.port}\r\n\r\n`, + ); + await once(client, "data"); + const clientClosed = once(client, "close"); + + await daemon.close(); + await clientClosed; + assert.equal(client.destroyed, true); +}); + test("CONNECT requires the same standard Basic proxy credentials", { timeout: 2_000, }, async (t) => { diff --git a/apps/egressd/src/daemon.ts b/apps/egressd/src/daemon.ts index 73a0efa..22e6157 100644 --- a/apps/egressd/src/daemon.ts +++ b/apps/egressd/src/daemon.ts @@ -165,20 +165,40 @@ interface RuntimeConfigurationState { status: "failed" | "not-ready" | "ready"; } -function closeServer(server: Server): Promise { +function trackServerSockets(server: Server): Set { + const sockets = new Set(); + server.on("connection", (socket) => { + sockets.add(socket); + socket.once("close", () => sockets.delete(socket)); + }); + return sockets; +} + +function closeServer(server: Server, sockets: ReadonlySet): Promise { return new Promise((resolve, reject) => { + const forceCloseTimer = setTimeout(() => { + for (const socket of sockets) { + socket.destroy(); + } + server.closeAllConnections(); + }, 1_000); server.close((error) => { + clearTimeout(forceCloseTimer); if (error) { reject(error); return; } resolve(); }); + server.closeIdleConnections(); }); } -function closeServerIfListening(server: Server | undefined): Promise { - return server?.listening ? closeServer(server) : Promise.resolve(); +function closeServerIfListening( + server: Server | undefined, + sockets: ReadonlySet, +): Promise { + return server?.listening ? closeServer(server, sockets) : Promise.resolve(); } async function prepareControlSocketPath(path: string): Promise { @@ -1110,12 +1130,16 @@ export async function startEgressd(options: EgressdOptions): Promise(); const closeStartupResources = async () => { stopWatchingRuntime(); await remoteOperations?.close(); await crashRecovery?.close(); - await closeServerIfListening(controlServer); + await closeServerIfListening(controlServer, controlServerSockets); await closeRuntimeAndState(); }; server.on("connect", (incoming, clientSocket, head) => { @@ -1164,7 +1188,7 @@ export async function startEgressd(options: EgressdOptions): Promise parse(await readFile(configPath, "utf8"))), ); - assert.deepEqual( - configs.map((config) => config.listeners), - [[second.mihomoConfig.listeners[0]], [second.mihomoConfig.listeners[1]]], - ); + const startedListeners = configs + .map((config) => { + assert.equal(config.listeners.length, 1); + return config.listeners[0]; + }) + .sort((left, right) => left.port - right.port); + assert.deepEqual(startedListeners, second.mihomoConfig.listeners); }); async function waitForExit(predicate: () => boolean): Promise { diff --git a/apps/egressd/src/testing/harness.ts b/apps/egressd/src/testing/harness.ts index 8ab3c7a..30ae0ed 100644 --- a/apps/egressd/src/testing/harness.ts +++ b/apps/egressd/src/testing/harness.ts @@ -62,6 +62,11 @@ export class ConnectionFaultPlan { function listen(server: Server | TcpServer): Promise { return new Promise((resolve, reject) => { + const sockets = new Set(); + server.on("connection", (socket) => { + sockets.add(socket); + socket.once("close", () => sockets.delete(socket)); + }); server.once("error", reject); server.listen(0, "127.0.0.1", () => { server.off("error", reject); @@ -76,6 +81,9 @@ function listen(server: Server | TcpServer): Promise { close: () => new Promise((closeResolve, closeReject) => { server.close((error) => (error ? closeReject(error) : closeResolve())); + for (const socket of sockets) { + socket.destroy(); + } }), }); }); diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 0000000..c314bbd --- /dev/null +++ b/docker/Dockerfile @@ -0,0 +1,42 @@ +# syntax=docker/dockerfile:1.7@sha256:a57df69d0ea827fb7266491f2813635de6f17269be881f696fbfdf2d83dda33e + +FROM node:22-bookworm-slim@sha256:83f487e0a63425e5b4d146fb5e5be574bcbe1b7b843d3ebafdd95eaf7767a7e5 AS build +ENV PNPM_HOME=/pnpm +ENV PATH=$PNPM_HOME:$PATH +RUN corepack enable +WORKDIR /workspace +COPY package.json pnpm-lock.yaml pnpm-workspace.yaml turbo.json tsconfig.base.json biome.json ./ +COPY apps/egressd/package.json apps/egressd/package.json +RUN pnpm install --frozen-lockfile +COPY apps/egressd apps/egressd +RUN pnpm --filter @egresskit/egressd build \ + && pnpm --filter @egresskit/egressd deploy --prod --legacy /opt/egresskit + +FROM node:22-bookworm-slim@sha256:83f487e0a63425e5b4d146fb5e5be574bcbe1b7b843d3ebafdd95eaf7767a7e5 AS runtime +ARG TARGETARCH +ARG MIHOMO_VERSION=v1.19.30 +ARG MIHOMO_AMD64_SHA256=db214c7a2517e63c150d123178d16d102e03a241ccdae4e5e07ffbe9cf56c6f9 +ARG MIHOMO_ARM64_SHA256=58896873736d28628f66de3677c8654fa0f180662523148e136cff4f6e890069 +RUN set -eux; \ + case "$TARGETARCH" in \ + amd64) asset="mihomo-linux-amd64-compatible-${MIHOMO_VERSION}.gz"; checksum="$MIHOMO_AMD64_SHA256" ;; \ + arm64) asset="mihomo-linux-arm64-${MIHOMO_VERSION}.gz"; checksum="$MIHOMO_ARM64_SHA256" ;; \ + *) echo "unsupported Docker architecture: $TARGETARCH" >&2; exit 1 ;; \ + esac; \ + url="https://github.com/MetaCubeX/mihomo/releases/download/${MIHOMO_VERSION}/${asset}"; \ + node -e 'const fs = require("node:fs"); const url = process.argv[1]; fetch(url).then((response) => { if (!response.ok) throw new Error(`HTTP ${response.status}`); return response.arrayBuffer(); }).then((body) => fs.writeFileSync("/tmp/mihomo.gz", Buffer.from(body)));' "$url"; \ + printf '%s %s\n' "$checksum" /tmp/mihomo.gz | sha256sum -c -; \ + gzip --decompress /tmp/mihomo.gz; \ + install --mode=0755 /tmp/mihomo /usr/local/bin/mihomo; \ + rm /tmp/mihomo +COPY --from=build /opt/egresskit /opt/egresskit +COPY LICENSE THIRD_PARTY_NOTICES.md /usr/share/licenses/egresskit/ +COPY licenses/Mihomo-GPL-3.0.txt /usr/share/licenses/egresskit/Mihomo-GPL-3.0.txt +RUN mkdir --parents /var/lib/egresskit \ + && chown node:node /var/lib/egresskit +ENV EGRESSKIT_STATE_DIRECTORY=/var/lib/egresskit +ENV EGRESSKIT_MIHOMO_BINARY=/usr/local/bin/mihomo +ENV EGRESSKIT_HOST=0.0.0.0 +EXPOSE 8787 +USER node +ENTRYPOINT ["node", "/opt/egresskit/dist/cli.js"] diff --git a/docker/Dockerfile.test.mjs b/docker/Dockerfile.test.mjs new file mode 100644 index 0000000..9ef89cc --- /dev/null +++ b/docker/Dockerfile.test.mjs @@ -0,0 +1,30 @@ +import assert from "node:assert/strict"; +import { readFile } from "node:fs/promises"; +import test from "node:test"; + +const root = new URL("../", import.meta.url); + +test("the Docker release pins and verifies the matching Mihomo asset for both architectures", async () => { + const dockerfile = await readFile(new URL("docker/Dockerfile", root), "utf8"); + + assert.match(dockerfile, /MIHOMO_VERSION=v1\.19\.30/); + assert.match(dockerfile, /dockerfile:1\.7@sha256:[a-f0-9]{64}/); + assert.match(dockerfile, /node:22-bookworm-slim@sha256:[a-f0-9]{64}/); + assert.match(dockerfile, /TARGETARCH/); + assert.match(dockerfile, /amd64/); + assert.match(dockerfile, /arm64/); + assert.match(dockerfile, /db214c7a2517e63c150d123178d16d102e03a241ccdae4e5e07ffbe9cf56c6f9/); + assert.match(dockerfile, /58896873736d28628f66de3677c8654fa0f180662523148e136cff4f6e890069/); + assert.match(dockerfile, /sha256sum -c/); + assert.doesNotMatch(dockerfile, /releases\/latest/); + assert.doesNotMatch(dockerfile, /apt-get/); + assert.match(dockerfile, /EGRESSKIT_HOST=0\.0\.0\.0/); + assert.match(dockerfile, /EXPOSE 8787/); +}); + +test("the Docker image receives both EgressKit and Mihomo license materials", async () => { + const dockerfile = await readFile(new URL("docker/Dockerfile", root), "utf8"); + + assert.match(dockerfile, /COPY LICENSE THIRD_PARTY_NOTICES\.md/); + assert.match(dockerfile, /COPY licenses\/Mihomo-GPL-3\.0\.txt/); +}); diff --git a/docs/deployment.md b/docs/deployment.md new file mode 100644 index 0000000..39f6365 --- /dev/null +++ b/docs/deployment.md @@ -0,0 +1,49 @@ +# Deployment and release support + +## v1 support matrix + +| Distribution | Architecture | v1 status | +| --- | --- | --- | +| Linux CLI and daemon | Linux x64 | Supported and built in the release matrix | +| Linux CLI and daemon | Linux arm64 | Supported and built in the release matrix | +| macOS CLI and daemon | macOS x64 | Supported and built in the release matrix | +| macOS CLI and daemon | macOS arm64 | Supported and built in the release matrix | +| Linux Docker | linux/amd64 | Supported multi-architecture image | +| Linux Docker | linux/arm64 | Supported multi-architecture image | + +Windows 不在 v1 的正式支持范围。发布流水线通过独立任务执行一次完整 `pnpm verify`。 +四种受支持的宿主组合分别执行构建、打包、安装和双入口 smoke，并保存构建归档。Docker manifest 同时包含 +`linux/amd64` 与 `linux/arm64`。正式镜像与 GitHub Release 都依赖完整质量验证成功。 + +带版本的 GitHub Release 附件是 v1 CLI 和 daemon 归档的正式下载渠道；项目不从 npm registry +发布。归档内部 package version 必须与 `v` 前缀 release tag 完全一致。容器镜像从同一 tag 发布到 +`ghcr.io/heyjunpenn/egresskit`，并附带构建 provenance 与 SBOM。 + +## State-directory security + +状态目录是敏感数据边界。SQLite 数据库按产品决策使用明文存储，不启用 SQLCipher、字段加密， +也不由 EgressKit 主动修改系统默认文件权限。数据库可能含有完整订阅 URL、VLESS 节点凭据、 +会话绑定和运行时状态；部署者必须限制状态目录的本机访问。 + +状态目录的备份同样可能包含凭据和其他敏感数据。部署者负责备份的访问控制、加密、保留周期和 +安全删除。不要把数据库、备份、管理 token 或代理 token 加入镜像或公开构建产物。 + +## Docker runtime + +镜像内置并校验固定的官方 Mihomo `v1.19.30`，不使用 `latest` 或 Alpha 资产。默认状态目录是 +`/var/lib/egresskit`，应挂载持久卷并仅授予容器运行用户访问权限。EgressKit 与 Mihomo 的许可证、 +归属和 Mihomo 对应源码获取方式随镜像一起放在 `/usr/share/licenses/egresskit`。 + +示例： + +```sh +docker run --rm \ + -v egresskit-state:/var/lib/egresskit \ + -p 127.0.0.1:8787:8787 \ + -e EGRESSKIT_ADMIN_TOKEN='replace-me' \ + -e EGRESSKIT_PROXY_TOKEN='replace-me' \ + ghcr.io/heyjunpenn/egresskit:VERSION +``` + +镜像内的 daemon 监听 `0.0.0.0:8787` 以穿过容器网络；上述端口映射只把服务暴露到宿主机 +loopback。若要对其他网络开放端口，必须保留代理认证，并由部署者额外配置防火墙和访问控制。 diff --git a/docs/deployment.test.mjs b/docs/deployment.test.mjs new file mode 100644 index 0000000..fb21788 --- /dev/null +++ b/docs/deployment.test.mjs @@ -0,0 +1,26 @@ +import assert from "node:assert/strict"; +import { readFile } from "node:fs/promises"; +import test from "node:test"; + +const deploymentUrl = new URL("./deployment.md", import.meta.url); + +test("deployment docs disclose the exact v1 support and state-security contract", async () => { + const deployment = await readFile(deploymentUrl, "utf8"); + + assert.match(deployment, /Linux x64/); + assert.match(deployment, /Linux arm64/); + assert.match(deployment, /macOS x64/); + assert.match(deployment, /macOS arm64/); + assert.match(deployment, /Windows[^\n]*不在 v1/); + assert.match(deployment, /SQLite[^\n]*明文/); + assert.match(deployment, /状态目录[^\n]*(敏感|秘密)/); + assert.match(deployment, /备份[^\n]*(凭据|敏感|秘密)/); + assert.match(deployment, /EGRESSKIT_PROXY_TOKEN/); + assert.doesNotMatch(deployment, /EGRESSKIT_PROXY_TOKENS/); + assert.match(deployment, /127\.0\.0\.1:8787:8787/); + assert.match(deployment, /GitHub Release/); + assert.match(deployment, /不从 npm registry/); + assert.match(deployment, /SBOM/); + assert.match(deployment, /独立[^\n]*`pnpm verify`/); + assert.match(deployment, /四种[^\n]*构建、打包、安装/); +}); diff --git a/licenses/Mihomo-GPL-3.0.txt b/licenses/Mihomo-GPL-3.0.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/licenses/Mihomo-GPL-3.0.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/package.json b/package.json index 5e6e236..33ddcfb 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "version": "0.0.0", "private": true, "description": "One proxy endpoint, many managed exits.", - "license": "UNLICENSED", + "license": "Apache-2.0", "engines": { "node": ">=22" }, @@ -13,9 +13,9 @@ "check": "pnpm typecheck", "lint": "turbo run lint", "lint:fix": "turbo run lint:fix", - "lint:root": "biome check package.json pnpm-workspace.yaml turbo.json biome.json tsconfig.base.json", + "lint:root": "biome check package.json pnpm-workspace.yaml turbo.json biome.json tsconfig.base.json .github/workflows/release.test.mjs docker/Dockerfile.test.mjs docs/deployment.test.mjs release", "prepare": "husky", - "test": "turbo run test", + "test": "pnpm --filter @egresskit/egressd test && node --test .github/workflows/*.test.mjs apps/egressd/*.test.mjs docker/*.test.mjs docs/*.test.mjs release/*.test.mjs", "typecheck": "turbo run typecheck", "verify": "pnpm lint && pnpm typecheck && pnpm test" }, diff --git a/release/set-package-version.mjs b/release/set-package-version.mjs new file mode 100644 index 0000000..6862e43 --- /dev/null +++ b/release/set-package-version.mjs @@ -0,0 +1,14 @@ +import { readFile, writeFile } from "node:fs/promises"; + +const [, , tag, packagePath] = process.argv; +const match = tag?.match( + /^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?$/, +); + +if (!(match && packagePath)) { + throw new Error("release tag must be a valid v-prefixed semantic version"); +} + +const packageJson = JSON.parse(await readFile(packagePath, "utf8")); +packageJson.version = tag.slice(1); +await writeFile(packagePath, `${JSON.stringify(packageJson, null, 2)}\n`); diff --git a/release/set-package-version.test.mjs b/release/set-package-version.test.mjs new file mode 100644 index 0000000..6b67417 --- /dev/null +++ b/release/set-package-version.test.mjs @@ -0,0 +1,33 @@ +import assert from "node:assert/strict"; +import { execFile } from "node:child_process"; +import { mkdtemp, readFile, writeFile } from "node:fs/promises"; +import { tmpdir } from "node:os"; +import { join } from "node:path"; +import test from "node:test"; +import { promisify } from "node:util"; + +const execFileAsync = promisify(execFile); +const script = new URL("./set-package-version.mjs", import.meta.url); + +test("a release tag stamps the package with the exact semantic version", async () => { + const directory = await mkdtemp(join(tmpdir(), "egresskit-release-version-")); + const packagePath = join(directory, "package.json"); + await writeFile(packagePath, '{"name":"fixture","version":"0.0.0"}\n'); + + await execFileAsync(process.execPath, [script.pathname, "v1.2.3-rc.1+build.5", packagePath]); + + assert.equal(JSON.parse(await readFile(packagePath, "utf8")).version, "1.2.3-rc.1+build.5"); +}); + +test("invalid or ambiguous release tags are rejected without changing metadata", async () => { + const directory = await mkdtemp(join(tmpdir(), "egresskit-release-version-")); + const packagePath = join(directory, "package.json"); + const original = '{"name":"fixture","version":"0.0.0"}\n'; + await writeFile(packagePath, original); + + await assert.rejects( + execFileAsync(process.execPath, [script.pathname, "v01.2.3", packagePath]), + /release tag must be a valid v-prefixed semantic version/, + ); + assert.equal(await readFile(packagePath, "utf8"), original); +});