mirror of
				https://github.com/yuezk/GlobalProtect-openconnect.git
				synced 2025-05-20 07:26:58 -04:00 
			
		
		
		
	Compare commits
	
		
			19 Commits
		
	
	
		
			v2.3.6
			...
			3daad748ae
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|  | 3daad748ae | ||
|  | 5bca84c9cf | ||
|  | 3a6eca2ed2 | ||
|  | 141d66cbde | ||
|  | f44cd85971 | ||
|  | 55b119d0f2 | ||
|  | df1bcd6571 | ||
|  | a19789f1e3 | ||
|  | a0891e9f04 | ||
|  | 5586daf9e5 | ||
|  | d2d45910cb | ||
|  | df4bbe0059 | ||
|  | aa0f6bf5bb | ||
|  | 48e22f4f78 | ||
|  | 480229b69f | ||
|  | c446763a05 | ||
|  | cfdba00a01 | ||
|  | 5404386972 | ||
|  | 4be877bf8c | 
| @@ -8,5 +8,5 @@ end_of_line = lf | ||||
| insert_final_newline = true | ||||
| trim_trailing_whitespace = true | ||||
|  | ||||
| [{Makefile,Makefile.in}] | ||||
| [Makefile] | ||||
| indent_style = tab | ||||
|   | ||||
							
								
								
									
										496
									
								
								.github/workflows/build.yaml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										496
									
								
								.github/workflows/build.yaml
									
									
									
									
										vendored
									
									
								
							| @@ -9,182 +9,392 @@ on: | ||||
|     branches: | ||||
|       - main | ||||
|       - dev | ||||
|       - hotfix/* | ||||
|       - feature/* | ||||
|       - release/* | ||||
|     tags: | ||||
|       - latest | ||||
|       - v*.*.* | ||||
| jobs: | ||||
|   # Include arm64 if ref is a tag | ||||
|   setup-matrix: | ||||
|     runs-on: ubuntu-latest | ||||
|     outputs: | ||||
|       matrix: ${{ steps.set-matrix.outputs.matrix }} | ||||
|     steps: | ||||
|       - name: Set up matrix | ||||
|         id: set-matrix | ||||
|         run: | | ||||
|           if [[ "${{ github.ref }}" == "refs/tags/"* ]]; then | ||||
|             echo 'matrix=[{"runner": "ubuntu-latest", "arch": "amd64"}, {"runner": "arm64", "arch": "arm64"}]' >> $GITHUB_OUTPUT | ||||
|           else | ||||
|             echo 'matrix=[{"runner": "ubuntu-latest", "arch": "amd64"}]' >> $GITHUB_OUTPUT | ||||
|           fi | ||||
|  | ||||
|   tarball: | ||||
|     runs-on: ubuntu-latest | ||||
|     needs: [setup-matrix] | ||||
|     steps: | ||||
|     - uses: pnpm/action-setup@v2 | ||||
|       with: | ||||
|         version: 8 | ||||
|     - name: Prepare workspace | ||||
|       run: rm -rf source && mkdir source | ||||
|     - name: Checkout GlobalProtect-openconnect | ||||
|       uses: actions/checkout@v3 | ||||
|       with: | ||||
|         token: ${{ secrets.GH_PAT }} | ||||
|         repository: yuezk/GlobalProtect-openconnect | ||||
|         ref: ${{ github.ref }} | ||||
|         path: source/gp | ||||
|         path: gp | ||||
|     - name: Create tarball | ||||
|       run: | | ||||
|         cd source/gp | ||||
|         # Generate the SNAPSHOT file for non-tagged commits | ||||
|         if [[ "${{ github.ref }}" != "refs/tags/"* ]]; then | ||||
|           touch SNAPSHOT | ||||
|         fi | ||||
|         cd gp | ||||
|         make tarball | ||||
|     - name: Upload tarball | ||||
|       uses: actions/upload-artifact@v3 | ||||
|       with: | ||||
|         name: artifact-source | ||||
|         if-no-files-found: error | ||||
|         name: artifact-tarball | ||||
|         path: | | ||||
|           source/gp/.build/tarball/*.tar.gz | ||||
|  | ||||
|   build-gp: | ||||
|     needs: | ||||
|     - setup-matrix | ||||
|     - tarball | ||||
|     strategy: | ||||
|       matrix: | ||||
|         # Only build gp on amd64, as the arm64 package will be built in release.yaml | ||||
|         os: [{runner: ubuntu-latest, arch: amd64}] | ||||
|         package: [deb, rpm, pkg, binary] | ||||
|     runs-on: ${{ matrix.os.runner }} | ||||
|     name: build-gp (${{ matrix.package }}, ${{ matrix.os.arch }}) | ||||
|           globalprotect-openconnect-*.tar.gz | ||||
|   deb: | ||||
|     runs-on: ubuntu-latest | ||||
|     needs: [tarball] | ||||
|     container: | ||||
|       image: yuezk/gpdev:main | ||||
|       credentials: | ||||
|         username: ${{ secrets.DOCKER_HUB_USERNAME }} | ||||
|         password: ${{ secrets.DOCKER_HUB_TOKEN }} | ||||
|     steps: | ||||
|     - name: Prepare workspace | ||||
|       run: | | ||||
|         rm -rf build-gp-${{ matrix.package }} | ||||
|         mkdir -p build-gp-${{ matrix.package }} | ||||
|     - name: Download tarball | ||||
|       uses: actions/download-artifact@v3 | ||||
|       with: | ||||
|         name: artifact-source | ||||
|         path: build-gp-${{ matrix.package }} | ||||
|     - name: Docker Login | ||||
|       run: echo ${{ secrets.DOCKER_HUB_TOKEN }} | docker login -u ${{ secrets.DOCKER_HUB_USERNAME }} --password-stdin | ||||
|     - name: Build ${{ matrix.package }} package in Docker | ||||
|         name: artifact-tarball | ||||
|     - name: Build DEB package | ||||
|       run: | | ||||
|         docker run --rm \ | ||||
|           -v $(pwd)/build-gp-${{ matrix.package }}:/${{ matrix.package }} \ | ||||
|           yuezk/gpdev:${{ matrix.package }}-builder | ||||
|     - name: Install ${{ matrix.package }} package in Docker | ||||
|         tar -xzf globalprotect-openconnect-*.tar.gz | ||||
|         cd globalprotect-openconnect-* | ||||
|         make deb | ||||
|     - name: Install DEB package | ||||
|       run: | | ||||
|         docker run --rm \ | ||||
|           -e GPGUI_INSTALLED=0 \ | ||||
|           -v $(pwd)/build-gp-${{ matrix.package }}:/${{ matrix.package }} \ | ||||
|           yuezk/gpdev:${{ matrix.package }}-builder \ | ||||
|           bash install.sh | ||||
|     - name: Upload ${{ matrix.package }} package | ||||
|         sudo dpkg -i globalprotect-openconnect_*.deb | ||||
|  | ||||
|         gpclient --version | ||||
|         gpservice --version | ||||
|         gpauth --version | ||||
|         gpgui-helper --version | ||||
|     - name: Upload DEB package | ||||
|       uses: actions/upload-artifact@v3 | ||||
|       with: | ||||
|         name: artifact-gp-${{ matrix.package }}-${{ matrix.os.arch }} | ||||
|         if-no-files-found: error | ||||
|         name: artifact-deb | ||||
|         path: | | ||||
|           build-gp-${{ matrix.package }}/artifacts/* | ||||
|           globalprotect-openconnect_*.deb | ||||
|  | ||||
|   build-gpgui: | ||||
|     needs: | ||||
|     - setup-matrix | ||||
|     strategy: | ||||
|       matrix: | ||||
|         os: ${{fromJson(needs.setup-matrix.outputs.matrix)}} | ||||
|     runs-on: ${{ matrix.os.runner }} | ||||
|     name: build-gpgui (${{ matrix.os.arch }}) | ||||
|     steps: | ||||
|     - uses: pnpm/action-setup@v2 | ||||
|       with: | ||||
|         version: 8 | ||||
|     - name: Prepare workspace | ||||
|       run: rm -rf gpgui-source && mkdir gpgui-source | ||||
|     - name: Checkout GlobalProtect-openconnect | ||||
|       uses: actions/checkout@v3 | ||||
|       with: | ||||
|         token: ${{ secrets.GH_PAT }} | ||||
|         repository: yuezk/GlobalProtect-openconnect | ||||
|         ref: ${{ github.ref }} | ||||
|         path: gpgui-source/gp | ||||
|     - name: Checkout gpgui@${{ github.ref_name }} | ||||
|       uses: actions/checkout@v3 | ||||
|       with: | ||||
|         token: ${{ secrets.GH_PAT }} | ||||
|         repository: yuezk/gpgui | ||||
|         ref: ${{ github.ref_name }} | ||||
|         path: gpgui-source/gpgui | ||||
|     - name: Tarball | ||||
|       run: | | ||||
|         cd gpgui-source | ||||
|         tar -czf gpgui.tar.gz gpgui gp | ||||
|     - name: Docker Login | ||||
|       run: echo ${{ secrets.DOCKER_HUB_TOKEN }} | docker login -u ${{ secrets.DOCKER_HUB_USERNAME }} --password-stdin | ||||
|     - name: Build gpgui in Docker | ||||
|       run: | | ||||
|         docker run --rm -v $(pwd)/gpgui-source:/gpgui yuezk/gpdev:gpgui-builder | ||||
|     - name: Install gpgui in Docker | ||||
|       run: | | ||||
|         cd gpgui-source | ||||
|         tar -xJf *.bin.tar.xz | ||||
|         docker run --rm -v $(pwd):/gpgui yuezk/gpdev:gpgui-builder \ | ||||
|           bash -c "cd /gpgui/gpgui_*/ && ./gpgui --version" | ||||
|     - name: Upload gpgui | ||||
|       uses: actions/upload-artifact@v3 | ||||
|       with: | ||||
|         name: artifact-gpgui-${{ matrix.os.arch }} | ||||
|         if-no-files-found: error | ||||
|         path: | | ||||
|           gpgui-source/*.bin.tar.xz | ||||
|           gpgui-source/*.bin.tar.xz.sha256 | ||||
|  | ||||
|   gh-release: | ||||
|     if: ${{ github.ref == 'refs/heads/dev' || startsWith(github.ref, 'refs/tags/') }} | ||||
|   rpm: | ||||
|     runs-on: ubuntu-latest | ||||
|     needs: | ||||
|       - tarball | ||||
|       - build-gp | ||||
|       - build-gpgui | ||||
|  | ||||
|     needs: [tarball] | ||||
|     container: | ||||
|       image: yuezk/gpdev:rpm-builder | ||||
|       credentials: | ||||
|         username: ${{ secrets.DOCKER_HUB_USERNAME }} | ||||
|         password: ${{ secrets.DOCKER_HUB_TOKEN }} | ||||
|     steps: | ||||
|     - name: Prepare workspace | ||||
|       run: rm -rf gh-release && mkdir gh-release | ||||
|  | ||||
|     - name: Checkout GlobalProtect-openconnect | ||||
|       uses: actions/checkout@v3 | ||||
|       with: | ||||
|         token: ${{ secrets.GH_PAT }} | ||||
|         repository: yuezk/GlobalProtect-openconnect | ||||
|         ref: ${{ github.ref }} | ||||
|         path: gh-release/gp | ||||
|  | ||||
|     - name: Download all artifacts | ||||
|     - name: Download tarball | ||||
|       uses: actions/download-artifact@v3 | ||||
|       with: | ||||
|         path: gh-release/gp/.build/artifacts | ||||
|  | ||||
|     - name: Create GH release | ||||
|       env: | ||||
|         GH_TOKEN: ${{ secrets.GH_PAT }} | ||||
|         RELEASE_TAG: ${{ github.ref == 'refs/heads/dev' && 'snapshot' || github.ref_name }} | ||||
|         name: artifact-tarball | ||||
|     - name: Build RPM package | ||||
|       run: | | ||||
|         cd gh-release/gp/scripts && ./gh-release.sh "$RELEASE_TAG" | ||||
|         tar -xzf globalprotect-openconnect-*.tar.gz | ||||
|         cd globalprotect-openconnect-*/ | ||||
|         make rpm | ||||
|     - name: Install RPM package | ||||
|       run: | | ||||
|         cd globalprotect-openconnect-*/ | ||||
|         ls -l .build/rpm | ||||
|         sudo rpm -i ".build/rpm/globalprotect-openconnect*.$(uname -m).rpm" | ||||
|  | ||||
|         gpclient --version | ||||
|         gpservice --version | ||||
|         gpauth --version | ||||
|         gpgui-helper --version | ||||
|  | ||||
|     - name: Upload RPM package | ||||
|       uses: actions/upload-artifact@v3 | ||||
|       with: | ||||
|         name: artifact-rpm | ||||
|         path: | | ||||
|           globalprotect-openconnect-*/.build/rpm/*.rpm | ||||
|  | ||||
|   # Include arm64 if ref is a tag | ||||
|   # setup-matrix: | ||||
|   #   runs-on: ubuntu-latest | ||||
|   #   outputs: | ||||
|   #     matrix: ${{ steps.set-matrix.outputs.matrix }} | ||||
|   #   steps: | ||||
|   #     - name: Set up matrix | ||||
|   #       id: set-matrix | ||||
|   #       run: | | ||||
|   #         if [[ "${{ github.ref }}" == "refs/tags/"* ]]; then | ||||
|   #           echo "matrix=[\"amd64\", \"arm64\"]" >> $GITHUB_OUTPUT | ||||
|   #         else | ||||
|   #           echo "matrix=[\"amd64\"]" >> $GITHUB_OUTPUT | ||||
|   #         fi | ||||
|  | ||||
|   # build-fe: | ||||
|   #   runs-on: ubuntu-latest | ||||
|   #   steps: | ||||
|   #     - name: Checkout gpgui repo | ||||
|   #       uses: actions/checkout@v3 | ||||
|   #       with: | ||||
|   #         token: ${{ secrets.GH_PAT }} | ||||
|   #         repository: yuezk/gpgui | ||||
|  | ||||
|   #     - name: Install Node.js | ||||
|   #       uses: actions/setup-node@v4 | ||||
|   #       with: | ||||
|   #         node-version: 18 | ||||
|  | ||||
|   #     - uses: pnpm/action-setup@v2 | ||||
|   #       with: | ||||
|   #         version: 8 | ||||
|  | ||||
|   #     - name: Install dependencies | ||||
|   #       run: | | ||||
|   #         cd app | ||||
|   #         pnpm install | ||||
|   #     - name: Build | ||||
|   #       run: | | ||||
|   #         cd app | ||||
|   #         pnpm run build | ||||
|  | ||||
|   #     - name: Upload artifacts | ||||
|   #       uses: actions/upload-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: gpgui-fe | ||||
|   #         path: app/dist | ||||
|  | ||||
|   # build-tauri-amd64: | ||||
|   #   needs: [build-fe] | ||||
|   #   runs-on: ubuntu-latest | ||||
|   #   steps: | ||||
|   #     - name: Checkout gpgui repo | ||||
|   #       uses: actions/checkout@v3 | ||||
|   #       with: | ||||
|   #         token: ${{ secrets.GH_PAT }} | ||||
|   #         repository: yuezk/gpgui | ||||
|   #         path: gpgui | ||||
|  | ||||
|   #     - name: Checkout gp repo | ||||
|   #       uses: actions/checkout@v3 | ||||
|   #       with: | ||||
|   #         token: ${{ secrets.GH_PAT }} | ||||
|   #         repository: yuezk/GlobalProtect-openconnect | ||||
|   #         path: gp | ||||
|  | ||||
|   #     - name: Download gpgui-fe artifact | ||||
|   #       uses: actions/download-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: gpgui-fe | ||||
|   #         path: gpgui/app/dist | ||||
|  | ||||
|   #     - name: Login to Docker Hub | ||||
|   #       uses: docker/login-action@v3 | ||||
|   #       with: | ||||
|   #         username: ${{ secrets.DOCKER_HUB_USERNAME }} | ||||
|   #         password: ${{ secrets.DOCKER_HUB_TOKEN }} | ||||
|  | ||||
|   #     - name: Build Tauri in Docker | ||||
|   #       run: | | ||||
|   #         docker run \ | ||||
|   #           --rm \ | ||||
|   #           -v $(pwd):/${{ github.workspace }} \ | ||||
|   #           -w ${{ github.workspace }} \ | ||||
|   #           -e CI=true \ | ||||
|   #           yuezk/gpdev:main \ | ||||
|   #           "./gpgui/scripts/build.sh" | ||||
|  | ||||
|   #     - name: Upload artifacts | ||||
|   #       uses: actions/upload-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: artifact-amd64-tauri | ||||
|   #         path: | | ||||
|   #           gpgui/.tmp/artifact | ||||
|  | ||||
|   # build-tauri-arm64: | ||||
|   #   if: startsWith(github.ref, 'refs/tags/') | ||||
|   #   needs: [build-fe] | ||||
|   #   runs-on: self-hosted | ||||
|   #   steps: | ||||
|   #     - name: Checkout gpgui repo | ||||
|   #       uses: actions/checkout@v3 | ||||
|   #       with: | ||||
|   #         token: ${{ secrets.GH_PAT }} | ||||
|   #         repository: yuezk/gpgui | ||||
|   #         path: gpgui | ||||
|  | ||||
|   #     - name: Checkout gp repo | ||||
|   #       uses: actions/checkout@v3 | ||||
|   #       with: | ||||
|   #         token: ${{ secrets.GH_PAT }} | ||||
|   #         repository: yuezk/GlobalProtect-openconnect | ||||
|   #         path: gp | ||||
|  | ||||
|   #     - name: Download gpgui-fe artifact | ||||
|   #       uses: actions/download-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: gpgui-fe | ||||
|   #         path: gpgui/app/dist | ||||
|   #     - name: Build Tauri | ||||
|   #       run: | | ||||
|   #         ./gpgui/scripts/build.sh | ||||
|  | ||||
|   #     - name: Upload artifacts | ||||
|   #       uses: actions/upload-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: artifact-arm64-tauri | ||||
|   #         path: | | ||||
|   #           gpgui/.tmp/artifact | ||||
|  | ||||
|   # package-tarball: | ||||
|   #   needs: [build-tauri-amd64, build-tauri-arm64] | ||||
|   #   runs-on: ubuntu-latest | ||||
|   #   steps: | ||||
|   #     - name: Checkout gpgui repo | ||||
|   #       uses: actions/checkout@v3 | ||||
|   #       with: | ||||
|   #         token: ${{ secrets.GH_PAT }} | ||||
|   #         repository: yuezk/gpgui | ||||
|   #         path: gpgui | ||||
|  | ||||
|   #     - name: Download artifact-amd64-tauri | ||||
|   #       uses: actions/download-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: artifact-amd64-tauri | ||||
|   #         path: gpgui/.tmp/artifact | ||||
|  | ||||
|   #     - name: Download artifact-arm64-tauri | ||||
|   #       uses: actions/download-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: artifact-arm64-tauri | ||||
|   #         path: gpgui/.tmp/artifact | ||||
|  | ||||
|   #     - name: Create tarball | ||||
|   #       run: | | ||||
|   #         ./gpgui/scripts/build-tarball.sh | ||||
|  | ||||
|   #     - name: Upload tarball | ||||
|   #       uses: actions/upload-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: artifact-tarball | ||||
|   #         path: | | ||||
|   #           gpgui/.tmp/tarball/*.tar.gz | ||||
|  | ||||
|   # package-rpm: | ||||
|   #   needs: [setup-matrix, package-tarball] | ||||
|   #   runs-on: ubuntu-latest | ||||
|   #   strategy: | ||||
|   #     matrix: | ||||
|   #       arch: ${{ fromJson(needs.setup-matrix.outputs.matrix) }} | ||||
|   #   steps: | ||||
|   #     - name: Checkout gpgui repo | ||||
|   #       uses: actions/checkout@v3 | ||||
|   #       with: | ||||
|   #         token: ${{ secrets.GH_PAT }} | ||||
|   #         repository: yuezk/gpgui | ||||
|   #         path: gpgui | ||||
|  | ||||
|   #     - name: Download package tarball | ||||
|   #       uses: actions/download-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: artifact-tarball | ||||
|   #         path: gpgui/.tmp/artifact | ||||
|  | ||||
|   #     - name: Set up QEMU | ||||
|   #       uses: docker/setup-qemu-action@v3 | ||||
|   #       with: | ||||
|   #         platforms: ${{ matrix.arch }} | ||||
|  | ||||
|   #     - name: Login to Docker Hub | ||||
|   #       uses: docker/login-action@v3 | ||||
|   #       with: | ||||
|   #         username: ${{ secrets.DOCKER_HUB_USERNAME }} | ||||
|   #         password: ${{ secrets.DOCKER_HUB_TOKEN }} | ||||
|  | ||||
|   #     - name: Create RPM package | ||||
|   #       run: | | ||||
|   #         docker run \ | ||||
|   #           --rm \ | ||||
|   #           -v $(pwd):/${{ github.workspace }} \ | ||||
|   #           -w ${{ github.workspace }} \ | ||||
|   #           --platform linux/${{ matrix.arch }} \ | ||||
|   #           yuezk/gpdev:rpm-builder \ | ||||
|   #           "./gpgui/scripts/build-rpm.sh" | ||||
|  | ||||
|   #     - name: Upload rpm artifacts | ||||
|   #       uses: actions/upload-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: artifact-${{ matrix.arch }}-rpm | ||||
|   #         path: | | ||||
|   #           gpgui/.tmp/artifact/*.rpm | ||||
|  | ||||
|   # package-pkgbuild: | ||||
|   #   needs: [setup-matrix, build-tauri-amd64, build-tauri-arm64] | ||||
|   #   runs-on: ubuntu-latest | ||||
|   #   strategy: | ||||
|   #     matrix: | ||||
|   #       arch: ${{ fromJson(needs.setup-matrix.outputs.matrix) }} | ||||
|   #   steps: | ||||
|   #     - name: Checkout gpgui repo | ||||
|   #       uses: actions/checkout@v3 | ||||
|   #       with: | ||||
|   #         token: ${{ secrets.GH_PAT }} | ||||
|   #         repository: yuezk/gpgui | ||||
|   #         path: gpgui | ||||
|  | ||||
|   #     - name: Download artifact-${{ matrix.arch }} | ||||
|   #       uses: actions/download-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: artifact-${{ matrix.arch }}-tauri | ||||
|   #         path: gpgui/.tmp/artifact | ||||
|  | ||||
|   #     - name: Set up QEMU | ||||
|   #       uses: docker/setup-qemu-action@v3 | ||||
|   #       with: | ||||
|   #         platforms: ${{ matrix.arch }} | ||||
|  | ||||
|   #     - name: Login to Docker Hub | ||||
|   #       uses: docker/login-action@v3 | ||||
|   #       with: | ||||
|   #         username: ${{ secrets.DOCKER_HUB_USERNAME }} | ||||
|   #         password: ${{ secrets.DOCKER_HUB_TOKEN }} | ||||
|  | ||||
|   #     - name: Generate PKGBUILD | ||||
|   #       run: | | ||||
|   #         export CI_ARCH=${{ matrix.arch }} | ||||
|   #         ./gpgui/scripts/generate-pkgbuild.sh | ||||
|  | ||||
|   #     - name: Build PKGBUILD package | ||||
|   #       run: | | ||||
|   #         # Build package | ||||
|   #         docker run \ | ||||
|   #           --rm \ | ||||
|   #           -v $(pwd)/gpgui/.tmp/pkgbuild:/pkgbuild \ | ||||
|   #           --platform linux/${{ matrix.arch }} \ | ||||
|   #           yuezk/gpdev:pkgbuild | ||||
|  | ||||
|   #     - name: Upload pkgbuild artifacts | ||||
|   #       uses: actions/upload-artifact@v3 | ||||
|   #       with: | ||||
|   #         name: artifact-${{ matrix.arch }}-pkgbuild | ||||
|   #         path: | | ||||
|   #           gpgui/.tmp/pkgbuild/*.pkg.tar.zst | ||||
|  | ||||
|   # gh-release: | ||||
|   #   if: startsWith(github.ref, 'refs/tags/') | ||||
|   #   runs-on: ubuntu-latest | ||||
|   #   needs: | ||||
|   #     - package-rpm | ||||
|   #     - package-pkgbuild | ||||
|  | ||||
|   #   steps: | ||||
|   #     - name: Download artifact | ||||
|   #       uses: actions/download-artifact@v3 | ||||
|   #       with: | ||||
|   #         path: artifact | ||||
|   #         # pattern: artifact-* | ||||
|   #         # merge-multiple: true | ||||
|  | ||||
|   #     # - name: Generate checksum | ||||
|   #     #   uses: jmgilman/actions-generate-checksum@v1 | ||||
|   #     #   with: | ||||
|   #     #     output: checksums.txt | ||||
|   #     #     patterns: | | ||||
|   #     #       artifact/* | ||||
|  | ||||
|   #     - name: Create GH release | ||||
|   #       uses: softprops/action-gh-release@v1 | ||||
|   #       with: | ||||
|   #         token: ${{ secrets.GH_PAT }} | ||||
|   #         prerelease: ${{ contains(github.ref, 'latest') }} | ||||
|   #         fail_on_unmatched_files: true | ||||
|   #         files: | | ||||
|   #           artifact/artifact-*/* | ||||
|   | ||||
							
								
								
									
										89
									
								
								.github/workflows/publish.yaml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										89
									
								
								.github/workflows/publish.yaml
									
									
									
									
										vendored
									
									
								
							| @@ -1,89 +0,0 @@ | ||||
| name: Publish Packages | ||||
|  | ||||
| on: | ||||
|   workflow_dispatch: | ||||
|     inputs: | ||||
|       tag: | ||||
|         description: 'Tag to publish' | ||||
|         required: true | ||||
|       revision: | ||||
|         description: 'Package revision' | ||||
|         required: true | ||||
|         default: "1" | ||||
|       ppa: | ||||
|         description: 'Publish to PPA' | ||||
|         type: boolean | ||||
|         required: true | ||||
|         default: true | ||||
|       obs: | ||||
|         description: 'Publish to OBS' | ||||
|         type: boolean | ||||
|         required: true | ||||
|         default: true | ||||
|       aur: | ||||
|         description: 'Publish to AUR' | ||||
|         type: boolean | ||||
|         required: true | ||||
|         default: true | ||||
|  | ||||
| jobs: | ||||
|   check: | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|     - name: Check tag exists | ||||
|       uses: mukunku/tag-exists-action@v1.6.0 | ||||
|       id: check-tag | ||||
|       with: | ||||
|         tag: ${{ inputs.tag }} | ||||
|     - name: Exit if tag does not exist | ||||
|       run: | | ||||
|         if [[ "${{ steps.check-tag.outputs.exists }}" == "false" ]]; then | ||||
|           echo "Tag ${{ inputs.tag }} does not exist" | ||||
|           exit 1 | ||||
|         fi | ||||
|  | ||||
|   publish-ppa: | ||||
|     needs: check | ||||
|     if: ${{ inputs.ppa }} | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|     - uses: pnpm/action-setup@v2 | ||||
|       with: | ||||
|         version: 8 | ||||
|     - name: Prepare workspace | ||||
|       run: rm -rf publish-ppa && mkdir publish-ppa | ||||
|     - name: Download ${{ inputs.tag }} source code | ||||
|       uses: robinraju/release-downloader@v1.9 | ||||
|       with: | ||||
|         token: ${{ secrets.GH_PAT }} | ||||
|         tag: ${{ inputs.tag }} | ||||
|         fileName: globalprotect-openconnect-*.tar.gz | ||||
|         tarBall: false | ||||
|         zipBall: false | ||||
|         out-file-path: publish-ppa | ||||
|     - name: Make the offline tarball | ||||
|       run: | | ||||
|         cd publish-ppa | ||||
|         tar -xf globalprotect-openconnect-*.tar.gz | ||||
|         cd globalprotect-openconnect-*/ | ||||
|  | ||||
|         make tarball OFFLINE=1 | ||||
|  | ||||
|         # Prepare the debian directory with custom files | ||||
|         mkdir -p .build/debian | ||||
|         sed 's/@RUST@/rust-all(>=1.70)/g' packaging/deb/control.in > .build/debian/control | ||||
|         sed 's/@OFFLINE@/1/g' packaging/deb/rules.in > .build/debian/rules | ||||
|         cp packaging/deb/postrm .build/debian/postrm | ||||
|  | ||||
|     - name: Publish to PPA | ||||
|       uses: yuezk/publish-ppa-package@dev | ||||
|       with: | ||||
|         repository: "yuezk/globalprotect-openconnect" | ||||
|         gpg_private_key: ${{ secrets.PPA_GPG_PRIVATE_KEY }} | ||||
|         gpg_passphrase: ${{ secrets.PPA_GPG_PASSPHRASE }} | ||||
|         tarball: publish-ppa/globalprotect-openconnect-*/.build/tarball/*.tar.gz | ||||
|         debian_dir: publish-ppa/globalprotect-openconnect-*/.build/debian | ||||
|         deb_email: "k3vinyue@gmail.com" | ||||
|         deb_fullname: "Kevin Yue" | ||||
|         extra_ppa: "liushuyu-011/rust-bpo-1.75" | ||||
|         revision: ${{ inputs.revision }} | ||||
							
								
								
									
										153
									
								
								.github/workflows/release.yaml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										153
									
								
								.github/workflows/release.yaml
									
									
									
									
										vendored
									
									
								
							| @@ -1,153 +0,0 @@ | ||||
| name: Release Packages | ||||
|  | ||||
| on: | ||||
|   workflow_dispatch: | ||||
|     inputs: | ||||
|       tag: | ||||
|         description: 'Tag to release' | ||||
|         required: true | ||||
|       arch: | ||||
|         type: choice | ||||
|         description: 'Architecture to build' | ||||
|         required: true | ||||
|         default: all | ||||
|         options: | ||||
|           - all | ||||
|           - x86_64 | ||||
|           - arm64 | ||||
|       release-deb: | ||||
|         type: boolean | ||||
|         description: 'Build DEB package' | ||||
|         required: true | ||||
|         default: true | ||||
|       release-rpm: | ||||
|         type: boolean | ||||
|         description: 'Build RPM package' | ||||
|         required: true | ||||
|         default: true | ||||
|       release-pkg: | ||||
|         type: boolean | ||||
|         description: 'Build PKG package' | ||||
|         required: true | ||||
|         default: true | ||||
|       release-binary: | ||||
|         type: boolean | ||||
|         description: 'Build binary package' | ||||
|         required: true | ||||
|         default: true | ||||
|       gh-release: | ||||
|         type: boolean | ||||
|         description: 'Update GitHub release' | ||||
|         required: true | ||||
|         default: true | ||||
|  | ||||
| jobs: | ||||
|   check: | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|     - name: Check tag exists | ||||
|       uses: mukunku/tag-exists-action@v1.6.0 | ||||
|       id: check-tag | ||||
|       with: | ||||
|         tag: ${{ inputs.tag }} | ||||
|     - name: Exit if tag does not exist | ||||
|       run: | | ||||
|         if [[ "${{ steps.check-tag.outputs.exists }}" == "false" ]]; then | ||||
|           echo "Tag ${{ inputs.tag }} does not exist" | ||||
|           exit 1 | ||||
|         fi | ||||
|  | ||||
|   setup-matrix: | ||||
|     needs: | ||||
|     - check | ||||
|     runs-on: ubuntu-latest | ||||
|     outputs: | ||||
|       matrix: ${{ steps.set-matrix.outputs.result }} | ||||
|     steps: | ||||
|     - name: Set up matrix | ||||
|       id: set-matrix | ||||
|       uses: actions/github-script@v7 | ||||
|       with: | ||||
|         result-encoding: string | ||||
|         script: | | ||||
|           const inputs = ${{ toJson(inputs) }} | ||||
|           const { arch } = inputs | ||||
|           const osMap = { | ||||
|             "all": ["ubuntu-latest", "arm64"], | ||||
|             "x86_64": ["ubuntu-latest"], | ||||
|             "arm64": ["arm64"] | ||||
|           } | ||||
|  | ||||
|           const package = Object.entries(inputs) | ||||
|             .filter(([key, value]) => key.startsWith('release-') && value) | ||||
|             .map(([key, value]) => key.replace('release-', '')) | ||||
|  | ||||
|           return JSON.stringify({ | ||||
|             os: osMap[arch], | ||||
|             package, | ||||
|           }) | ||||
|  | ||||
|   build: | ||||
|     needs: | ||||
|     - setup-matrix | ||||
|     strategy: | ||||
|       matrix: ${{ fromJson(needs.setup-matrix.outputs.matrix) }} | ||||
|     runs-on: ${{ matrix.os }} | ||||
|     steps: | ||||
|     - name: Prepare workspace | ||||
|       run: rm -rf build-${{ matrix.package }} && mkdir -p build-${{ matrix.package }} | ||||
|     - name: Download ${{ inputs.tag }} source code | ||||
|       uses: robinraju/release-downloader@v1.9 | ||||
|       with: | ||||
|         token: ${{ secrets.GH_PAT }} | ||||
|         tag: ${{ inputs.tag }} | ||||
|         fileName: globalprotect-openconnect-*.tar.gz | ||||
|         tarBall: false | ||||
|         zipBall: false | ||||
|         out-file-path: build-${{ matrix.package }} | ||||
|     - name: Docker Login | ||||
|       run: echo ${{ secrets.DOCKER_HUB_TOKEN }} | docker login -u ${{ secrets.DOCKER_HUB_USERNAME }} --password-stdin | ||||
|     - name: Build ${{ matrix.package }} package in Docker | ||||
|       run: | | ||||
|         docker run --rm \ | ||||
|           -v $(pwd)/build-${{ matrix.package }}:/${{ matrix.package }} \ | ||||
|           -e INCLUDE_GUI=1 \ | ||||
|           yuezk/gpdev:${{ matrix.package }}-builder | ||||
|  | ||||
|     - name: Install ${{ matrix.package }} package in Docker | ||||
|       run: | | ||||
|         docker run --rm \ | ||||
|           -v $(pwd)/build-${{ matrix.package }}:/${{ matrix.package }} \ | ||||
|           yuezk/gpdev:${{ matrix.package }}-builder \ | ||||
|           bash install.sh | ||||
|  | ||||
|     - name: Upload ${{ matrix.package }} package | ||||
|       uses: actions/upload-artifact@v3 | ||||
|       with: | ||||
|         name: artifact-${{ matrix.os }}-${{ matrix.package }} | ||||
|         if-no-files-found: error | ||||
|         path: | | ||||
|           build-${{ matrix.package }}/artifacts/* | ||||
|  | ||||
|   gh-release: | ||||
|     needs: | ||||
|     - build | ||||
|     runs-on: ubuntu-latest | ||||
|     if: ${{ inputs.gh-release }} | ||||
|     steps: | ||||
|     - name: Prepare workspace | ||||
|       run: rm -rf gh-release && mkdir gh-release | ||||
|     - name: Download artifact | ||||
|       uses: actions/download-artifact@v3 | ||||
|       with: | ||||
|         path: gh-release | ||||
|     - name: Update release | ||||
|       uses: softprops/action-gh-release@v1 | ||||
|       with: | ||||
|         token: ${{ secrets.GH_PAT }} | ||||
|         prerelease: ${{ contains(github.ref, 'snapshot') }} | ||||
|         fail_on_unmatched_files: true | ||||
|         tag_name: ${{ inputs.tag }} | ||||
|         files: | | ||||
|           gh-release/artifact-*/* | ||||
|  | ||||
							
								
								
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							| @@ -7,4 +7,3 @@ | ||||
|  | ||||
| .cargo | ||||
| .build | ||||
| SNAPSHOT | ||||
|   | ||||
							
								
								
									
										5
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							| @@ -1,7 +1,6 @@ | ||||
| { | ||||
|     "cSpell.words": [ | ||||
|         "authcookie", | ||||
|         "badssl", | ||||
|         "bincode", | ||||
|         "chacha", | ||||
|         "clientos", | ||||
| @@ -11,7 +10,6 @@ | ||||
|         "distro", | ||||
|         "dotenv", | ||||
|         "dotenvy", | ||||
|         "dtls", | ||||
|         "getconfig", | ||||
|         "globalprotect", | ||||
|         "globalprotectcallback", | ||||
| @@ -27,9 +25,7 @@ | ||||
|         "LOGNAME", | ||||
|         "oneshot", | ||||
|         "openconnect", | ||||
|         "pkcs", | ||||
|         "pkexec", | ||||
|         "pkey", | ||||
|         "Prelogin", | ||||
|         "prelogon", | ||||
|         "prelogonuserauthcookie", | ||||
| @@ -39,7 +35,6 @@ | ||||
|         "rspc", | ||||
|         "servercert", | ||||
|         "specta", | ||||
|         "sslkey", | ||||
|         "sysinfo", | ||||
|         "tanstack", | ||||
|         "tauri", | ||||
|   | ||||
							
								
								
									
										189
									
								
								Cargo.lock
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										189
									
								
								Cargo.lock
									
									
									
										generated
									
									
									
								
							| @@ -252,12 +252,6 @@ version = "0.21.5" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "35636a1494ede3b646cc98f74f8e62c773a38a659ebc777a2cf26b9b74171df9" | ||||
|  | ||||
| [[package]] | ||||
| name = "base64" | ||||
| version = "0.22.1" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" | ||||
|  | ||||
| [[package]] | ||||
| name = "bitflags" | ||||
| version = "1.3.2" | ||||
| @@ -568,13 +562,6 @@ dependencies = [ | ||||
|  "memchr", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "common" | ||||
| version = "2.3.6" | ||||
| dependencies = [ | ||||
|  "is_executable", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "compile-time" | ||||
| version = "0.2.0" | ||||
| @@ -889,18 +876,6 @@ version = "0.2.0" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "bd0c93bb4b0c6d9b77f4435b0ae98c24d17f1c45b2ff844c6151a07256ca923b" | ||||
|  | ||||
| [[package]] | ||||
| name = "dns-lookup" | ||||
| version = "2.0.4" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "e5766087c2235fec47fafa4cfecc81e494ee679d0fd4a59887ea0919bfb0e4fc" | ||||
| dependencies = [ | ||||
|  "cfg-if", | ||||
|  "libc", | ||||
|  "socket2", | ||||
|  "windows-sys 0.48.0", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "document-features" | ||||
| version = "0.2.8" | ||||
| @@ -910,6 +885,24 @@ dependencies = [ | ||||
|  "litrs", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "dotenvy" | ||||
| version = "0.15.7" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "1aaf95b3e5c8f23aa320147307562d361db0ae0d51242340f558153b4eb2439b" | ||||
|  | ||||
| [[package]] | ||||
| name = "dotenvy_macro" | ||||
| version = "0.15.7" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "cb0235d912a8c749f4e0c9f18ca253b4c28cfefc1d2518096016d6e3230b6424" | ||||
| dependencies = [ | ||||
|  "dotenvy", | ||||
|  "proc-macro2", | ||||
|  "quote", | ||||
|  "syn 1.0.109", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "dtoa" | ||||
| version = "1.0.9" | ||||
| @@ -1430,18 +1423,16 @@ dependencies = [ | ||||
|  | ||||
| [[package]] | ||||
| name = "gpapi" | ||||
| version = "2.3.6" | ||||
| version = "2.0.0" | ||||
| dependencies = [ | ||||
|  "anyhow", | ||||
|  "base64 0.21.5", | ||||
|  "chacha20poly1305", | ||||
|  "clap", | ||||
|  "dns-lookup", | ||||
|  "dotenvy_macro", | ||||
|  "log", | ||||
|  "md5", | ||||
|  "open", | ||||
|  "openssl", | ||||
|  "pem", | ||||
|  "redact-engine", | ||||
|  "regex", | ||||
|  "reqwest", | ||||
| @@ -1459,20 +1450,18 @@ dependencies = [ | ||||
|  "url", | ||||
|  "urlencoding", | ||||
|  "uzers", | ||||
|  "which", | ||||
|  "whoami", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "gpauth" | ||||
| version = "2.3.6" | ||||
| version = "2.0.0" | ||||
| dependencies = [ | ||||
|  "anyhow", | ||||
|  "clap", | ||||
|  "compile-time", | ||||
|  "env_logger", | ||||
|  "gpapi", | ||||
|  "html-escape", | ||||
|  "log", | ||||
|  "regex", | ||||
|  "serde_json", | ||||
| @@ -1486,11 +1475,10 @@ dependencies = [ | ||||
|  | ||||
| [[package]] | ||||
| name = "gpclient" | ||||
| version = "2.3.6" | ||||
| version = "2.0.0" | ||||
| dependencies = [ | ||||
|  "anyhow", | ||||
|  "clap", | ||||
|  "common", | ||||
|  "compile-time", | ||||
|  "directories", | ||||
|  "env_logger", | ||||
| @@ -1508,7 +1496,7 @@ dependencies = [ | ||||
|  | ||||
| [[package]] | ||||
| name = "gpgui-helper" | ||||
| version = "2.3.6" | ||||
| version = "2.0.0" | ||||
| dependencies = [ | ||||
|  "anyhow", | ||||
|  "clap", | ||||
| @@ -1526,7 +1514,7 @@ dependencies = [ | ||||
|  | ||||
| [[package]] | ||||
| name = "gpservice" | ||||
| version = "2.3.6" | ||||
| version = "2.0.0" | ||||
| dependencies = [ | ||||
|  "anyhow", | ||||
|  "axum", | ||||
| @@ -1539,10 +1527,8 @@ dependencies = [ | ||||
|  "openconnect", | ||||
|  "serde", | ||||
|  "serde_json", | ||||
|  "tar", | ||||
|  "tokio", | ||||
|  "tokio-util", | ||||
|  "xz2", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| @@ -1602,9 +1588,9 @@ dependencies = [ | ||||
|  | ||||
| [[package]] | ||||
| name = "h2" | ||||
| version = "0.3.26" | ||||
| version = "0.3.24" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "81fe527a889e1532da5c525686d96d4c2e74cdd345badf8dfef9f6b39dd5f5e8" | ||||
| checksum = "bb2c4422095b67ee78da96fbb51a4cc413b3b25883c7717ff7ca1ab31022c9c9" | ||||
| dependencies = [ | ||||
|  "bytes", | ||||
|  "fnv", | ||||
| @@ -1621,9 +1607,9 @@ dependencies = [ | ||||
|  | ||||
| [[package]] | ||||
| name = "h2" | ||||
| version = "0.4.4" | ||||
| version = "0.4.2" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "816ec7294445779408f36fe57bc5b7fc1cf59664059096c65f905c1c61f58069" | ||||
| checksum = "31d030e59af851932b72ceebadf4a2b5986dba4c3b99dd2493f8273a0f151943" | ||||
| dependencies = [ | ||||
|  "bytes", | ||||
|  "fnv", | ||||
| @@ -1677,24 +1663,6 @@ version = "0.4.3" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70" | ||||
|  | ||||
| [[package]] | ||||
| name = "home" | ||||
| version = "0.5.9" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "e3d1354bf6b7235cb4a0576c2619fd4ed18183f689b12b006a0ee7329eeff9a5" | ||||
| dependencies = [ | ||||
|  "windows-sys 0.52.0", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "html-escape" | ||||
| version = "0.2.13" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "6d1ad449764d627e22bfd7cd5e8868264fc9236e07c752972b4080cd351cb476" | ||||
| dependencies = [ | ||||
|  "utf8-width", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "html5ever" | ||||
| version = "0.26.0" | ||||
| @@ -1799,7 +1767,7 @@ dependencies = [ | ||||
|  "futures-channel", | ||||
|  "futures-core", | ||||
|  "futures-util", | ||||
|  "h2 0.3.26", | ||||
|  "h2 0.3.24", | ||||
|  "http 0.2.11", | ||||
|  "http-body 0.4.6", | ||||
|  "httparse", | ||||
| @@ -1822,7 +1790,7 @@ dependencies = [ | ||||
|  "bytes", | ||||
|  "futures-channel", | ||||
|  "futures-util", | ||||
|  "h2 0.4.4", | ||||
|  "h2 0.4.2", | ||||
|  "http 1.0.0", | ||||
|  "http-body 1.0.0", | ||||
|  "httparse", | ||||
| @@ -2163,9 +2131,9 @@ checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646" | ||||
|  | ||||
| [[package]] | ||||
| name = "libc" | ||||
| version = "0.2.155" | ||||
| version = "0.2.151" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c" | ||||
| checksum = "302d7ab3130588088d277783b1e2d2e10c9e9e4a16dd9050e6ec93fb3e7048f4" | ||||
|  | ||||
| [[package]] | ||||
| name = "libredox" | ||||
| @@ -2230,17 +2198,6 @@ dependencies = [ | ||||
|  "tracing-subscriber", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "lzma-sys" | ||||
| version = "0.1.20" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "5fda04ab3764e6cde78b9974eec4f779acaba7c4e84b36eca3cf77c581b85d27" | ||||
| dependencies = [ | ||||
|  "cc", | ||||
|  "libc", | ||||
|  "pkg-config", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "mac" | ||||
| version = "0.1.1" | ||||
| @@ -2330,9 +2287,9 @@ dependencies = [ | ||||
|  | ||||
| [[package]] | ||||
| name = "mio" | ||||
| version = "0.8.11" | ||||
| version = "0.8.10" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "a4a650543ca06a924e8b371db273b2756685faae30f8487da1b56505a8f78b0c" | ||||
| checksum = "8f3d0b296e374a4e6f3c7b0a1f5a51d748a0d34c85e7dc48fc3fa9a87657fe09" | ||||
| dependencies = [ | ||||
|  "libc", | ||||
|  "log", | ||||
| @@ -2549,18 +2506,18 @@ dependencies = [ | ||||
|  | ||||
| [[package]] | ||||
| name = "openconnect" | ||||
| version = "2.3.6" | ||||
| version = "2.0.0" | ||||
| dependencies = [ | ||||
|  "cc", | ||||
|  "common", | ||||
|  "is_executable", | ||||
|  "log", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "openssl" | ||||
| version = "0.10.66" | ||||
| version = "0.10.62" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "9529f4786b70a3e8c61e11179af17ab6188ad8d0ded78c5529441ed39d4bd9c1" | ||||
| checksum = "8cde4d2d9200ad5909f8dac647e29482e07c3a35de8a13fce7c9c7747ad9f671" | ||||
| dependencies = [ | ||||
|  "bitflags 2.4.1", | ||||
|  "cfg-if", | ||||
| @@ -2599,9 +2556,9 @@ dependencies = [ | ||||
|  | ||||
| [[package]] | ||||
| name = "openssl-sys" | ||||
| version = "0.9.103" | ||||
| version = "0.9.98" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "7f9e8deee91df40a943c71b917e5874b951d32a802526c85721ce3b776c929d6" | ||||
| checksum = "c1665caf8ab2dc9aef43d1c0023bd904633a6a05cb30b0ad59bec2ae986e57a7" | ||||
| dependencies = [ | ||||
|  "cc", | ||||
|  "libc", | ||||
| @@ -2682,16 +2639,6 @@ version = "0.2.1" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "8835116a5c179084a830efb3adc117ab007512b535bc1a21c991d3b32a6b44dd" | ||||
|  | ||||
| [[package]] | ||||
| name = "pem" | ||||
| version = "3.0.4" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "8e459365e590736a54c3fa561947c84837534b8e9af6fc5bf781307e82658fae" | ||||
| dependencies = [ | ||||
|  "base64 0.22.1", | ||||
|  "serde", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "percent-encoding" | ||||
| version = "2.3.1" | ||||
| @@ -3189,7 +3136,7 @@ dependencies = [ | ||||
|  "encoding_rs", | ||||
|  "futures-core", | ||||
|  "futures-util", | ||||
|  "h2 0.3.26", | ||||
|  "h2 0.3.24", | ||||
|  "http 0.2.11", | ||||
|  "http-body 0.4.6", | ||||
|  "hyper 0.14.28", | ||||
| @@ -3244,9 +3191,9 @@ dependencies = [ | ||||
|  | ||||
| [[package]] | ||||
| name = "rustix" | ||||
| version = "0.38.34" | ||||
| version = "0.38.28" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "70dc5ec042f7a43c4a73241207cecc9873a06d45debb38b329f8541d85c2730f" | ||||
| checksum = "72e572a5e8ca657d7366229cdde4bd14c4eb5499a9573d4d366fe1b599daa316" | ||||
| dependencies = [ | ||||
|  "bitflags 2.4.1", | ||||
|  "errno", | ||||
| @@ -4187,9 +4134,9 @@ checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20" | ||||
|  | ||||
| [[package]] | ||||
| name = "tokio" | ||||
| version = "1.36.0" | ||||
| version = "1.35.1" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "61285f6515fa018fb2d1e46eb21223fff441ee8db5d0f1435e8ab4f5cdb80931" | ||||
| checksum = "c89b4efa943be685f629b149f53829423f8f5531ea21249408e8e2f8671ec104" | ||||
| dependencies = [ | ||||
|  "backtrace", | ||||
|  "bytes", | ||||
| @@ -4516,12 +4463,6 @@ version = "0.7.6" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "09cc8ee72d2a9becf2f2febe0205bbed8fc6615b7cb429ad062dc7b7ddd036a9" | ||||
|  | ||||
| [[package]] | ||||
| name = "utf8-width" | ||||
| version = "0.1.7" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "86bd8d4e895da8537e5315b8254664e6b769c4ff3db18321b297a1e7004392e3" | ||||
|  | ||||
| [[package]] | ||||
| name = "utf8parse" | ||||
| version = "0.2.1" | ||||
| @@ -4628,12 +4569,6 @@ version = "0.11.0+wasi-snapshot-preview1" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" | ||||
|  | ||||
| [[package]] | ||||
| name = "wasite" | ||||
| version = "0.1.0" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "b8dad83b4f25e74f184f64c43b150b91efe7647395b42289f38e50566d82855b" | ||||
|  | ||||
| [[package]] | ||||
| name = "wasm-bindgen" | ||||
| version = "0.2.89" | ||||
| @@ -4808,26 +4743,13 @@ dependencies = [ | ||||
|  "windows-metadata", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "which" | ||||
| version = "6.0.2" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "3d9c5ed668ee1f17edb3b627225343d210006a90bb1e3745ce1f30b1fb115075" | ||||
| dependencies = [ | ||||
|  "either", | ||||
|  "home", | ||||
|  "rustix", | ||||
|  "winsafe", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "whoami" | ||||
| version = "1.5.1" | ||||
| version = "1.4.1" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "a44ab49fad634e88f55bf8f9bb3abd2f27d7204172a112c7c9987e01c1c94ea9" | ||||
| checksum = "22fc3756b8a9133049b26c7f61ab35416c130e8c09b660f5b3958b446f52cc50" | ||||
| dependencies = [ | ||||
|  "redox_syscall", | ||||
|  "wasite", | ||||
|  "wasm-bindgen", | ||||
|  "web-sys", | ||||
| ] | ||||
|  | ||||
| @@ -5126,12 +5048,6 @@ dependencies = [ | ||||
|  "windows-sys 0.48.0", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "winsafe" | ||||
| version = "0.0.19" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "d135d17ab770252ad95e9a872d365cf3090e3be864a34ab46f48555993efc904" | ||||
|  | ||||
| [[package]] | ||||
| name = "wry" | ||||
| version = "0.24.7" | ||||
| @@ -5208,15 +5124,6 @@ version = "0.13.6" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "66fee0b777b0f5ac1c69bb06d361268faafa61cd4682ae064a171c16c433e9e4" | ||||
|  | ||||
| [[package]] | ||||
| name = "xz2" | ||||
| version = "0.1.7" | ||||
| source = "registry+https://github.com/rust-lang/crates.io-index" | ||||
| checksum = "388c44dc09d76f1536602ead6d325eb532f5c122f17782bd57fb47baeeb767e2" | ||||
| dependencies = [ | ||||
|  "lzma-sys", | ||||
| ] | ||||
|  | ||||
| [[package]] | ||||
| name = "zeroize" | ||||
| version = "1.7.0" | ||||
|   | ||||
| @@ -5,7 +5,7 @@ members = ["crates/*", "apps/gpclient", "apps/gpservice", "apps/gpauth", "apps/g | ||||
|  | ||||
| [workspace.package] | ||||
| rust-version = "1.70" | ||||
| version = "2.3.6" | ||||
| version = "2.0.0" | ||||
| authors = ["Kevin Yue <k3vinyue@gmail.com>"] | ||||
| homepage = "https://github.com/yuezk/GlobalProtect-openconnect" | ||||
| edition = "2021" | ||||
| @@ -17,14 +17,11 @@ base64 = "0.21" | ||||
| clap = { version = "4.4.2", features = ["derive"] } | ||||
| ctrlc = "3.4" | ||||
| directories = "5.0" | ||||
| dns-lookup = "2.0.4" | ||||
| env_logger = "0.10" | ||||
| is_executable = "1.0" | ||||
| log = "0.4" | ||||
| regex = "1" | ||||
| reqwest = { version = "0.11", features = ["native-tls-vendored", "json"] } | ||||
| openssl = "0.10" | ||||
| pem = "3" | ||||
| roxmltree = "0.18" | ||||
| serde = { version = "1.0", features = ["derive"] } | ||||
| serde_json = "1.0" | ||||
| @@ -42,11 +39,11 @@ uzers = "0.11" | ||||
| whoami = "1" | ||||
| thiserror = "1" | ||||
| redact-engine = "0.1" | ||||
| dotenvy_macro = "0.15" | ||||
| compile-time = "0.2" | ||||
| serde_urlencoded = "0.7" | ||||
| md5="0.7" | ||||
| sha256="1" | ||||
| which="6" | ||||
|  | ||||
| # Tauri dependencies | ||||
| tauri = { version = "1.5" } | ||||
|   | ||||
							
								
								
									
										196
									
								
								Makefile
									
									
									
									
									
								
							
							
						
						
									
										196
									
								
								Makefile
									
									
									
									
									
								
							| @@ -1,8 +1,4 @@ | ||||
| .SHELLFLAGS += -e | ||||
|  | ||||
| OFFLINE ?= 0 | ||||
| BUILD_FE ?= 1 | ||||
| INCLUDE_GUI ?= 0 | ||||
| CARGO ?= cargo | ||||
|  | ||||
| VERSION = $(shell $(CARGO) metadata --no-deps --format-version 1 | jq -r '.packages[0].version') | ||||
| @@ -11,17 +7,9 @@ PPA_REVISION ?= 1 | ||||
| PKG_NAME = globalprotect-openconnect | ||||
| PKG = $(PKG_NAME)-$(VERSION) | ||||
| SERIES ?= $(shell lsb_release -cs) | ||||
| PUBLISH ?= 0 | ||||
|  | ||||
| export DEBEMAIL = k3vinyue@gmail.com | ||||
| export DEBFULLNAME = Kevin Yue | ||||
| export SNAPSHOT = $(shell test -f SNAPSHOT && echo "true" || echo "false") | ||||
|  | ||||
| ifeq ($(SNAPSHOT), true) | ||||
| 	RELEASE_TAG = snapshot | ||||
| else | ||||
| 	RELEASE_TAG = v$(VERSION) | ||||
| endif | ||||
|  | ||||
| CARGO_BUILD_ARGS = --release | ||||
|  | ||||
| @@ -34,55 +22,28 @@ default: build | ||||
| version: | ||||
| 	@echo $(VERSION) | ||||
|  | ||||
| clean-tarball: | ||||
| 	rm -rf .build/tarball | ||||
| 	rm -rf .vendor | ||||
| 	rm -rf vendor.tar.xz | ||||
| 	rm -rf .cargo | ||||
| # Generate a vendor tarball and a .cargo/config.toml file | ||||
| cargo-vendor: | ||||
| 	mkdir -p .cargo | ||||
|  | ||||
| # Create a tarball, include the cargo dependencies if OFFLINE is set to 1 | ||||
| tarball: clean-tarball | ||||
| 	if [ $(BUILD_FE) -eq 1 ]; then \ | ||||
| 		echo "Building frontend..."; \ | ||||
| 		cd apps/gpgui-helper && pnpm install && pnpm build; \ | ||||
| 	fi | ||||
| 	$(CARGO) vendor .vendor > .cargo/config.toml | ||||
| 	tar -cJf vendor.tar.xz .vendor | ||||
|  | ||||
| 	# Remove node_modules to reduce the tarball size | ||||
| tarball: clean clean-tarball build-fe cargo-vendor | ||||
| 	rm -rf apps/gpgui-helper/node_modules | ||||
|  | ||||
| 	mkdir -p .cargo | ||||
| 	mkdir -p .build/tarball | ||||
| 	tar --transform 's,^,${PKG}/,' -czf ../${PKG}.tar.gz * .cargo | ||||
|  | ||||
| 	# If OFFLINE is set to 1, vendor all cargo dependencies | ||||
| 	if [ $(OFFLINE) -eq 1 ]; then \ | ||||
| 		$(CARGO) vendor .vendor > .cargo/config.toml; \ | ||||
| 		tar -cJf vendor.tar.xz .vendor; \ | ||||
| 	fi | ||||
| # Extract the vendor tarball to the .vendor directory if it exists | ||||
| extract-vendor: | ||||
| 	if [ -f vendor.tar.xz ]; then tar -xJf vendor.tar.xz; fi | ||||
|  | ||||
| 	@echo "Creating tarball..." | ||||
| 	tar --exclude .vendor --exclude target --transform 's,^,${PKG}/,' -czf .build/tarball/${PKG}.tar.gz * .cargo | ||||
|  | ||||
| download-gui: | ||||
| 	rm -rf .build/gpgui | ||||
|  | ||||
| 	if [ $(INCLUDE_GUI) -eq 1 ]; then \ | ||||
| 		echo "Downloading GlobalProtect GUI..."; \ | ||||
| 		mkdir -p .build/gpgui; \ | ||||
| 		curl -sSL https://github.com/yuezk/GlobalProtect-openconnect/releases/download/$(RELEASE_TAG)/gpgui_$(shell uname -m).bin.tar.xz \ | ||||
| 			-o .build/gpgui/gpgui_$(shell uname -m).bin.tar.xz; \ | ||||
| 		tar -xJf .build/gpgui/*.tar.xz -C .build/gpgui; \ | ||||
| 	else \ | ||||
| 		echo "Skipping GlobalProtect GUI download (INCLUDE_GUI=0)"; \ | ||||
| 	fi | ||||
|  | ||||
| build: download-gui build-fe build-rs | ||||
| build: build-fe build-rs | ||||
|  | ||||
| # Install and build the frontend | ||||
| # If OFFLINE is set to 1, skip it | ||||
| build-fe: | ||||
| 	if [ $(OFFLINE) -eq 1 ] || [ $(BUILD_FE) -eq 0 ]; then \ | ||||
| 		echo "Skipping frontend build (OFFLINE=1 or BUILD_FE=0)"; \ | ||||
| 	else \ | ||||
| 	if [ $(OFFLINE) -eq 0 ]; then \ | ||||
| 		cd apps/gpgui-helper && pnpm install && pnpm build; \ | ||||
| 	fi | ||||
|  | ||||
| @@ -91,13 +52,9 @@ build-fe: | ||||
| 		exit 1; \ | ||||
| 	fi | ||||
|  | ||||
| build-rs: | ||||
| 	if [ $(OFFLINE) -eq 1 ]; then \ | ||||
| 		tar -xJf vendor.tar.xz; \ | ||||
| 	fi | ||||
|  | ||||
| 	$(CARGO) build $(CARGO_BUILD_ARGS) -p gpclient -p gpservice -p gpauth | ||||
| 	$(CARGO) build $(CARGO_BUILD_ARGS) -p gpgui-helper --features "tauri/custom-protocol" | ||||
| build-rs: extract-vendor | ||||
| 	$(CARGO) build $(CARGO_BUILD_ARGS) -p gpauth | ||||
| 	# $(CARGO) build $(CARGO_BUILD_ARGS) -p gpgui-helper --features "tauri/custom-protocol" | ||||
|  | ||||
| clean: | ||||
| 	$(CARGO) clean | ||||
| @@ -105,18 +62,16 @@ clean: | ||||
| 	rm -rf .vendor | ||||
| 	rm -rf apps/gpgui-helper/node_modules | ||||
|  | ||||
| install: | ||||
| 	@echo "Installing $(PKG_NAME)..." | ||||
| clean-tarball: | ||||
| 	rm -rf vendor.tar.xz | ||||
| 	rm -rf ../$(PKG).tar.gz | ||||
|  | ||||
| install: | ||||
| 	install -Dm755 target/release/gpclient $(DESTDIR)/usr/bin/gpclient | ||||
| 	install -Dm755 target/release/gpauth $(DESTDIR)/usr/bin/gpauth | ||||
| 	install -Dm755 target/release/gpservice $(DESTDIR)/usr/bin/gpservice | ||||
| 	install -Dm755 target/release/gpgui-helper $(DESTDIR)/usr/bin/gpgui-helper | ||||
|  | ||||
| 	if [ -f .build/gpgui/gpgui_*/gpgui ]; then \ | ||||
| 		install -Dm755 .build/gpgui/gpgui_*/gpgui $(DESTDIR)/usr/bin/gpgui; \ | ||||
| 	fi | ||||
|  | ||||
| 	install -Dm644 packaging/files/usr/share/applications/gpgui.desktop $(DESTDIR)/usr/share/applications/gpgui.desktop | ||||
| 	install -Dm644 packaging/files/usr/share/icons/hicolor/scalable/apps/gpgui.svg $(DESTDIR)/usr/share/icons/hicolor/scalable/apps/gpgui.svg | ||||
| 	install -Dm644 packaging/files/usr/share/icons/hicolor/32x32/apps/gpgui.png $(DESTDIR)/usr/share/icons/hicolor/32x32/apps/gpgui.png | ||||
| @@ -125,13 +80,10 @@ install: | ||||
| 	install -Dm644 packaging/files/usr/share/polkit-1/actions/com.yuezk.gpgui.policy $(DESTDIR)/usr/share/polkit-1/actions/com.yuezk.gpgui.policy | ||||
|  | ||||
| uninstall: | ||||
| 	@echo "Uninstalling $(PKG_NAME)..." | ||||
|  | ||||
| 	rm -f $(DESTDIR)/usr/bin/gpclient | ||||
| 	rm -f $(DESTDIR)/usr/bin/gpauth | ||||
| 	rm -f $(DESTDIR)/usr/bin/gpservice | ||||
| 	rm -f $(DESTDIR)/usr/bin/gpgui-helper | ||||
| 	rm -f $(DESTDIR)/usr/bin/gpgui | ||||
|  | ||||
| 	rm -f $(DESTDIR)/usr/share/applications/gpgui.desktop | ||||
| 	rm -f $(DESTDIR)/usr/share/icons/hicolor/scalable/apps/gpgui.svg | ||||
| @@ -140,61 +92,40 @@ uninstall: | ||||
| 	rm -f $(DESTDIR)/usr/share/icons/hicolor/256x256@2/apps/gpgui.png | ||||
| 	rm -f $(DESTDIR)/usr/share/polkit-1/actions/com.yuezk.gpgui.policy | ||||
|  | ||||
| clean-debian: | ||||
| 	rm -rf .build/deb | ||||
| init-debian: | ||||
| 	rm -rf .vendor | ||||
| 	rm -rf debian | ||||
|  | ||||
| # Generate the debian package structure, without the changelog | ||||
| init-debian: clean-debian tarball | ||||
| 	mkdir -p .build/deb | ||||
| 	cp .build/tarball/${PKG}.tar.gz .build/deb | ||||
| 	debmake | ||||
|  | ||||
| 	tar -xzf .build/deb/${PKG}.tar.gz -C .build/deb | ||||
| 	cd .build/deb/${PKG} && debmake | ||||
|  | ||||
| 	cp -f packaging/deb/control.in .build/deb/$(PKG)/debian/control | ||||
| 	cp -f packaging/deb/rules.in .build/deb/$(PKG)/debian/rules | ||||
| 	cp -f packaging/deb/postrm .build/deb/$(PKG)/debian/postrm | ||||
|  | ||||
| 	sed -i "s/@OFFLINE@/$(OFFLINE)/g" .build/deb/$(PKG)/debian/rules | ||||
|  | ||||
| 	rm -f .build/deb/$(PKG)/debian/changelog | ||||
| 	cp -f packaging/deb/control.in debian/control | ||||
| 	cp -f packaging/deb/rules debian/rules | ||||
| 	rm -f debian/changelog | ||||
|  | ||||
| deb: init-debian | ||||
| 	# Remove the rust build depdency from the control file | ||||
| 	sed -i "s/@RUST@//g" .build/deb/$(PKG)/debian/control | ||||
| 	sed -i "s/@RUST@//g" debian/control | ||||
|  | ||||
| 	cd .build/deb/$(PKG) && dch --create --distribution unstable --package $(PKG_NAME) --newversion $(VERSION)-$(REVISION) "Bugfix and improvements." | ||||
| 	dch --create --distribution unstable --package $(PKG_NAME) --newversion $(VERSION)-$(REVISION) "Bugfix and improvements." | ||||
|  | ||||
| 	cd .build/deb/$(PKG) && debuild --preserve-env -e PATH -us -uc -b | ||||
| 	debuild --preserve-env -e PATH -us -uc -b | ||||
|  | ||||
| check-ppa: | ||||
| 	if [ $(OFFLINE) -eq 0 ]; then \ | ||||
| 		echo "Error: ppa build requires offline mode (OFFLINE=1)"; \ | ||||
| 	fi | ||||
|  | ||||
| # Usage: make ppa SERIES=focal OFFLINE=1 PUBLISH=1 | ||||
| ppa: check-ppa init-debian | ||||
| 	sed -i "s/@RUST@/rust-all(>=1.70)/g" .build/deb/$(PKG)/debian/control | ||||
| # Usage: make ppa SERIES=focal | ||||
| ppa: init-debian | ||||
| 	sed -i "s/@RUST@/rust-all(>=1.70)/g" debian/control | ||||
|  | ||||
| 	$(eval SERIES_VER = $(shell distro-info --series $(SERIES) -r | cut -d' ' -f1)) | ||||
| 	@echo "Building for $(SERIES) $(SERIES_VER)" | ||||
|  | ||||
| 	rm -rf .build/deb/$(PKG)/debian/changelog | ||||
| 	cd .build/deb/$(PKG) && dch --create --distribution $(SERIES) --package $(PKG_NAME) --newversion $(VERSION)-$(REVISION)ppa$(PPA_REVISION)~ubuntu$(SERIES_VER) "Bugfix and improvements." | ||||
| 	dch --create --distribution $(SERIES) --package $(PKG_NAME) --newversion $(VERSION)-$(REVISION)ppa$(PPA_REVISION)~ubuntu$(SERIES_VER) "Bugfix and improvements." | ||||
|  | ||||
| 	cd .build/deb/$(PKG) && echo "y" | debuild -e PATH -S -sa -k"$(GPG_KEY_ID)" -p"gpg --batch --passphrase $(GPG_KEY_PASS) --pinentry-mode loopback" | ||||
| 	echo "y" | debuild -e PATH -S -sa -k"$(GPG_KEY_ID)" -p"gpg --batch --passphrase $(GPG_KEY_PASS) --pinentry-mode loopback" | ||||
|  | ||||
| 	if [ $(PUBLISH) -eq 1 ]; then \ | ||||
| 		cd .build/deb/$(PKG) && dput ppa:yuezk/globalprotect-openconnect ../*.changes; \ | ||||
| 	else \ | ||||
| 		echo "Skipping ppa publish (PUBLISH=0)"; \ | ||||
| 	fi | ||||
|  | ||||
| clean-rpm: | ||||
| 	rm -rf .build/rpm | ||||
| publish-ppa: ppa | ||||
| 	dput ppa:yuezk/globalprotect-openconnect ../*.changes | ||||
|  | ||||
| # Generate RPM sepc file | ||||
| init-rpm: clean-rpm | ||||
| init-rpm: | ||||
| 	rm -rf .build/rpm | ||||
| 	mkdir -p .build/rpm | ||||
|  | ||||
| 	cp packaging/rpm/globalprotect-openconnect.spec.in .build/rpm/globalprotect-openconnect.spec | ||||
| @@ -202,20 +133,26 @@ init-rpm: clean-rpm | ||||
|  | ||||
| 	sed -i "s/@VERSION@/$(VERSION)/g" .build/rpm/globalprotect-openconnect.spec | ||||
| 	sed -i "s/@REVISION@/$(REVISION)/g" .build/rpm/globalprotect-openconnect.spec | ||||
| 	sed -i "s/@OFFLINE@/$(OFFLINE)/g" .build/rpm/globalprotect-openconnect.spec | ||||
| 	sed -i "s/@DATE@/$(shell LC_ALL=en.US date "+%a %b %d %Y")/g" .build/rpm/globalprotect-openconnect.spec | ||||
| 	sed -i "s/@DATE@/$(shell date "+%a %b %d %Y")/g" .build/rpm/globalprotect-openconnect.spec | ||||
|  | ||||
| 	sed -i "s/@VERSION@/$(VERSION)/g" .build/rpm/globalprotect-openconnect.changes | ||||
| 	sed -i "s/@DATE@/$(shell LC_ALL=en.US date -u "+%a %b %e %T %Z %Y")/g" .build/rpm/globalprotect-openconnect.changes | ||||
|  | ||||
| rpm: init-rpm tarball | ||||
| # Ensure ../globalprotect-openconnect-*.tar.gz exists. | ||||
| rpm: init-rpm | ||||
| 	if [ ! -f ../$(PKG).tar.gz ]; then \ | ||||
| 		echo "Missing ../$(PKG).tar.gz"; \ | ||||
| 		exit 1; \ | ||||
| 	fi | ||||
|  | ||||
| 	rm -rf $(HOME)/rpmbuild | ||||
| 	rpmdev-setuptree | ||||
|  | ||||
| 	cp .build/tarball/${PKG}.tar.gz $(HOME)/rpmbuild/SOURCES/${PKG_NAME}.tar.gz | ||||
| 	cp ../$(PKG).tar.gz $(HOME)/rpmbuild/SOURCES/$(PKG_NAME).tar.gz | ||||
|  | ||||
| 	rpmbuild -ba .build/rpm/globalprotect-openconnect.spec | ||||
|  | ||||
| 	# Copy RPM package from build directory | ||||
| 	# Copy RPM package | ||||
| 	cp $(HOME)/rpmbuild/RPMS/$(shell uname -m)/$(PKG_NAME)*.rpm .build/rpm | ||||
|  | ||||
| 	# Copy the SRPM only for x86_64. | ||||
| @@ -223,41 +160,20 @@ rpm: init-rpm tarball | ||||
| 		cp $(HOME)/rpmbuild/SRPMS/$(PKG_NAME)*.rpm .build/rpm; \ | ||||
| 	fi | ||||
|  | ||||
| clean-pkgbuild: | ||||
| init-pkgbuild: | ||||
| 	rm -rf .build/pkgbuild | ||||
|  | ||||
| init-pkgbuild: clean-pkgbuild tarball | ||||
| 	mkdir -p .build/pkgbuild | ||||
|  | ||||
| 	cp .build/tarball/${PKG}.tar.gz .build/pkgbuild | ||||
| 	cp packaging/pkgbuild/PKGBUILD.in .build/pkgbuild/PKGBUILD | ||||
| 	if [ ! -f ../$(PKG).tar.gz ]; then \ | ||||
| 		echo "Missing ../$(PKG).tar.gz"; \ | ||||
| 		exit 1; \ | ||||
| 	fi | ||||
| 	cp ../$(PKG).tar.gz .build/pkgbuild | ||||
|  | ||||
| 	cp packaging/pkgbuild/PKGBUILD.in .build/pkgbuild/PKGBUILD | ||||
| 	sed -i "s/@PKG_NAME@/$(PKG_NAME)/g" .build/pkgbuild/PKGBUILD | ||||
| 	sed -i "s/@VERSION@/$(VERSION)/g" .build/pkgbuild/PKGBUILD | ||||
| 	sed -i "s/@REVISION@/$(REVISION)/g" .build/pkgbuild/PKGBUILD | ||||
| 	sed -i "s/@OFFLINE@/$(OFFLINE)/g" .build/pkgbuild/PKGBUILD | ||||
|  | ||||
| pkgbuild: init-pkgbuild | ||||
| 	cd .build/pkgbuild && makepkg -s --noconfirm | ||||
|  | ||||
| clean-binary: | ||||
| 	rm -rf .build/binary | ||||
|  | ||||
| binary: clean-binary tarball | ||||
| 	mkdir -p .build/binary | ||||
|  | ||||
| 	cp .build/tarball/${PKG}.tar.gz .build/binary | ||||
| 	tar -xzf .build/binary/${PKG}.tar.gz -C .build/binary | ||||
|  | ||||
| 	mkdir -p .build/binary/$(PKG_NAME)_$(VERSION)/artifacts | ||||
|  | ||||
| 	make -C .build/binary/${PKG} build OFFLINE=$(OFFLINE) BUILD_FE=0 INCLUDE_GUI=$(INCLUDE_GUI) | ||||
| 	make -C .build/binary/${PKG} install DESTDIR=$(PWD)/.build/binary/$(PKG_NAME)_$(VERSION)/artifacts | ||||
|  | ||||
| 	cp packaging/binary/Makefile.in .build/binary/$(PKG_NAME)_$(VERSION)/Makefile | ||||
|  | ||||
| 	# Create a tarball for the binary package | ||||
| 	tar -cJf .build/binary/$(PKG_NAME)_$(VERSION)_$(shell uname -m).bin.tar.xz -C .build/binary $(PKG_NAME)_$(VERSION) | ||||
|  | ||||
| 	# Generate sha256sum | ||||
| 	cd .build/binary && sha256sum $(PKG_NAME)_$(VERSION)_$(shell uname -m).bin.tar.xz | cut -d' ' -f1 > $(PKG_NAME)_$(VERSION)_$(shell uname -m).bin.tar.xz.sha256 | ||||
|   | ||||
							
								
								
									
										121
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										121
									
								
								README.md
									
									
									
									
									
								
							| @@ -13,7 +13,6 @@ A GUI for GlobalProtect VPN, based on OpenConnect, supports the SSO authenticati | ||||
| - [x] Support both SSO and non-SSO authentication | ||||
| - [x] Support the FIDO2 authentication (e.g., YubiKey) | ||||
| - [x] Support authentication using default browser | ||||
| - [x] Support client certificate authentication | ||||
| - [x] Support multiple portals | ||||
| - [x] Support gateway selection | ||||
| - [x] Support connect gateway directly | ||||
| @@ -44,20 +43,6 @@ Options: | ||||
| See 'gpclient help <command>' for more information on a specific command. | ||||
| ``` | ||||
|  | ||||
| To use the external browser for authentication with the CLI version, you need to use the following command: | ||||
|  | ||||
| ```bash | ||||
| sudo -E gpclient connect --browser default <portal> | ||||
| ``` | ||||
|  | ||||
| Or you can try the following command if the above command does not work: | ||||
|  | ||||
| ```bash | ||||
| gpauth <portal> --browser default 2>/dev/null | sudo gpclient connect <portal> --cookie-on-stdin | ||||
| ``` | ||||
|  | ||||
| You can specify the browser with the `--browser <browser>` option, e.g., `--browser firefox`, `--browser chrome`, etc. | ||||
|  | ||||
| ### GUI | ||||
|  | ||||
| The GUI version is also available after you installed it. You can launch it from the application menu or run `gpclient launch-gui` in the terminal. | ||||
| @@ -68,9 +53,18 @@ The GUI version is also available after you installed it. You can launch it from | ||||
|  | ||||
| ## Installation | ||||
|  | ||||
| > [!Note] | ||||
| > | ||||
| > This instruction is for the 2.x version. The 1.x version is still available on the [1.x](https://github.com/yuezk/GlobalProtect-openconnect/tree/1.x) branch, you can build it from the source code by following the instructions in the `README.md` file. | ||||
|  | ||||
| > [!Warning] | ||||
| > | ||||
| > The client requires `openconnect >= 8.20, pkexec, and gnome-keyring`, please make sure you have them installed. | ||||
| > Installing the client from PPA will automatically install the required version of `openconnect`. | ||||
|  | ||||
| ### Debian/Ubuntu based distributions | ||||
|  | ||||
| #### Install from PPA (Ubuntu 18.04 and later, except 24.04) | ||||
| #### Install from PPA | ||||
|  | ||||
| ``` | ||||
| sudo apt-get install gir1.2-gtk-3.0 gir1.2-webkit2-4.0 | ||||
| @@ -83,29 +77,12 @@ sudo apt-get install globalprotect-openconnect | ||||
| > | ||||
| > For Linux Mint, you might need to import the GPG key with: `sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 7937C393082992E5D6E4A60453FC26B43838D761` if you encountered an error `gpg: keyserver receive failed: General error`. | ||||
|  | ||||
| #### **Ubuntu 24.04 and later** | ||||
|  | ||||
| The `libwebkit2gtk-4.0-37` package was [removed](https://bugs.launchpad.net/ubuntu/+source/webkit2gtk/+bug/2061914) from its repo, before [the issue](https://github.com/yuezk/GlobalProtect-openconnect/issues/351) gets resolved, you need to install them manually: | ||||
|  | ||||
| ```bash | ||||
| wget http://launchpadlibrarian.net/704701349/libwebkit2gtk-4.0-37_2.43.3-1_amd64.deb | ||||
| wget http://launchpadlibrarian.net/704701345/libjavascriptcoregtk-4.0-18_2.43.3-1_amd64.deb | ||||
|  | ||||
| sudo dpkg --install *.deb | ||||
| ``` | ||||
|  | ||||
| And the latest package is not available in the PPA, you can follow the [Install from deb package](#install-from-deb-package) section to install the latest package. | ||||
|  | ||||
| #### **Ubuntu 18.04** | ||||
|  | ||||
| The latest package is not available in the PPA either, but you still needs to add the `ppa:yuezk/globalprotect-openconnect` repo beforehand to use the required `openconnect` package. Then you can follow the [Install from deb package](#install-from-deb-package) section to install the latest package. | ||||
|  | ||||
| #### Install from deb package | ||||
|  | ||||
| Download the latest deb package from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. Then install it with `apt`: | ||||
| Download the latest deb package from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. Then install it with `dpkg`: | ||||
|  | ||||
| ```bash | ||||
| sudo apt install --fix-broken globalprotect-openconnect_*.deb | ||||
| sudo dpkg -i globalprotect-openconnect_*.deb | ||||
| ``` | ||||
|  | ||||
| ### Arch Linux / Manjaro | ||||
| @@ -126,7 +103,7 @@ Download the latest package from [releases](https://github.com/yuezk/GlobalProte | ||||
| sudo pacman -U globalprotect-openconnect-*.pkg.tar.zst | ||||
| ``` | ||||
|  | ||||
| ### Fedora 38 and later / Fedora Rawhide | ||||
| ### Fedora/OpenSUSE/CentOS/RHEL | ||||
|  | ||||
| #### Install from COPR | ||||
|  | ||||
| @@ -137,79 +114,25 @@ sudo dnf copr enable yuezk/globalprotect-openconnect | ||||
| sudo dnf install globalprotect-openconnect | ||||
| ``` | ||||
|  | ||||
| ### openSUSE Leap 15.6 / openSUSE Tumbleweed | ||||
|  | ||||
| #### Install from OBS (openSUSE Build Service) | ||||
| #### Install from OBS (OpenSUSE Build Service) | ||||
|  | ||||
| The package is also available on [OBS](https://build.opensuse.org/package/show/home:yuezk/globalprotect-openconnect) for various RPM-based distributions. You can follow the instructions [on this page](https://software.opensuse.org//download.html?project=home%3Ayuezk&package=globalprotect-openconnect) to install it. | ||||
|  | ||||
| ### Other RPM-based distributions | ||||
|  | ||||
| #### Install from RPM package | ||||
|  | ||||
| Download the latest RPM package from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. | ||||
|  | ||||
| ```bash | ||||
| sudo rpm -i globalprotect-openconnect-*.rpm | ||||
| ``` | ||||
| ### Gentoo | ||||
|  | ||||
| Install from the ```rios``` or ```slonko``` overlays.  Example using rios: | ||||
|  | ||||
| #### 1. Enable the overlay | ||||
| ``` | ||||
| sudo eselect repository enable rios | ||||
| ``` | ||||
|  | ||||
| #### 2. Sync with the repository | ||||
|  | ||||
|   - If you have eix installed, use it: | ||||
| ``` | ||||
| sudo eix-sync | ||||
| ``` | ||||
|   - Otherwise, use: | ||||
| ``` | ||||
| sudo emerge --sync | ||||
| ``` | ||||
|  | ||||
| #### 3. Install | ||||
|  | ||||
| ```sudo emerge globalprotect-openconnect``` | ||||
|  | ||||
|  | ||||
| ### Other distributions | ||||
|  | ||||
| - Install `openconnect >= 8.20`, `webkit2gtk`, `libsecret`, `libayatana-appindicator` or `libappindicator-gtk3`. | ||||
| - Download `globalprotect-openconnect_${version}_${arch}.bin.tar.xz` from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. | ||||
| - Extract the tarball with `tar -xJf globalprotect-openconnect_${version}_${arch}.bin.tar.xz`. | ||||
| - Run `sudo make install` to install the client. | ||||
|  | ||||
| ## Build from source | ||||
|  | ||||
| You can also build the client from source, steps are as follows: | ||||
|  | ||||
| ### Prerequisites | ||||
|  | ||||
| - [Install Rust 1.75 or later](https://www.rust-lang.org/tools/install) | ||||
| - Install Tauri dependencies: https://tauri.app/v1/guides/getting-started/prerequisites/#setting-up-linux | ||||
| - Install `perl` and `jq` | ||||
| - Install `openconnect >= 8.20` and `libopenconnect-dev` (or `openconnect-devel` on RPM-based distributions) | ||||
| - Install `pkexec`, `gnome-keyring` (or `pam_kwallet` on KDE) | ||||
| - Install `nodejs` and `pnpm` (optional only if you downloaded the source tarball from the release page and run with the `BUILD_FE=0` flag, see below) | ||||
|  | ||||
| ### Build | ||||
|  | ||||
| 1. Download the source code tarball from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. Choose `globalprotect-openconnect-${version}.tar.gz`. | ||||
| 2. Extract the tarball with `tar -xzf globalprotect-openconnect-${version}.tar.gz`. | ||||
| 3. Enter the source directory and run `make build BUILD_FE=0` to build the client. | ||||
| 3. Run `sudo make install` to install the client. (Note, `DESTDIR` is not supported) | ||||
| - Download `globalprotect-openconnect.tar.gz` from [releases](https://github.com/yuezk/GlobalProtect-openconnect/releases) page. | ||||
| - Extract the tarball and run `make build` to build the client. | ||||
| - Run `make install` to install the client. | ||||
|  | ||||
| ## FAQ | ||||
|  | ||||
| 1. How to deal with error `Secure Storage not ready` | ||||
|    | ||||
|    Try upgrade the client to `2.2.0` or later, which will use a file-based storage as a fallback. | ||||
|  | ||||
|    You need to install the `gnome-keyring` package, and restart the system (See [#321](https://github.com/yuezk/GlobalProtect-openconnect/issues/321), [#316](https://github.com/yuezk/GlobalProtect-openconnect/issues/316)). | ||||
|  | ||||
| 2. How to deal with error `(gpauth:18869): Gtk-WARNING **: 10:33:37.566: cannot open display:` | ||||
| @@ -223,12 +146,6 @@ The CLI version is always free, while the GUI version is paid. There are two tri | ||||
| 1. 10-day trial: You can use the GUI stable release for 10 days after the installation. | ||||
| 2. 14-day trial: Each beta release has a fresh trial period (at most 14 days) after released. | ||||
|  | ||||
| ## License | ||||
| ## [License](./LICENSE) | ||||
|  | ||||
| - crate [gpapi](./crates/gpapi): [MIT](./crates/gpapi/LICENSE) | ||||
| - crate [openconnect](./crates/openconnect): [GPL-3.0](./crates/openconnect/LICENSE) | ||||
| - crate [common](./crates/common): [GPL-3.0](./crates/common/LICENSE) | ||||
| - app [gpservice](./apps/gpservice): [GPL-3.0](./apps/gpservice/LICENSE) | ||||
| - app [gpclient](./apps/gpclient): [GPL-3.0](./apps/gpclient/LICENSE) | ||||
| - app [gpauth](./apps/gpauth): [GPL-3.0](./apps/gpauth/LICENSE) | ||||
| - app [gpgui-helper](./apps/gpgui-helper): [GPL-3.0](./apps/gpgui-helper/LICENSE) | ||||
| GPLv3 | ||||
|   | ||||
| @@ -1,6 +1,5 @@ | ||||
| [package] | ||||
| name = "gpauth" | ||||
| authors.workspace = true | ||||
| version.workspace = true | ||||
| edition.workspace = true | ||||
| license.workspace = true | ||||
| @@ -9,11 +8,7 @@ license.workspace = true | ||||
| tauri-build = { version = "1.5", features = [] } | ||||
|  | ||||
| [dependencies] | ||||
| gpapi = { path = "../../crates/gpapi", features = [ | ||||
|   "tauri", | ||||
|   "clap", | ||||
|   "browser-auth", | ||||
| ] } | ||||
| gpapi = { path = "../../crates/gpapi", features = ["tauri", "clap"] } | ||||
| anyhow.workspace = true | ||||
| clap.workspace = true | ||||
| env_logger.workspace = true | ||||
| @@ -23,7 +18,6 @@ serde_json.workspace = true | ||||
| tokio.workspace = true | ||||
| tokio-util.workspace = true | ||||
| tempfile.workspace = true | ||||
| html-escape = "0.2.13" | ||||
| webkit2gtk = "0.18.2" | ||||
| tauri = { workspace = true, features = ["http-all"] } | ||||
| compile-time.workspace = true | ||||
|   | ||||
| @@ -1,674 +0,0 @@ | ||||
|                     GNU GENERAL PUBLIC LICENSE | ||||
|                        Version 3, 29 June 2007 | ||||
|  | ||||
|  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | ||||
|  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. | ||||
|  | ||||
|     <one line to give the program's name and a brief idea of what it does.> | ||||
|     Copyright (C) <year>  <name of author> | ||||
|  | ||||
|     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 <https://www.gnu.org/licenses/>. | ||||
|  | ||||
| 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: | ||||
|  | ||||
|     <program>  Copyright (C) <year>  <name of author> | ||||
|     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 | ||||
| <https://www.gnu.org/licenses/>. | ||||
|  | ||||
|   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 | ||||
| <https://www.gnu.org/licenses/why-not-lgpl.html>. | ||||
| @@ -7,7 +7,6 @@ use std::{ | ||||
| use anyhow::bail; | ||||
| use gpapi::{ | ||||
|   auth::SamlAuthData, | ||||
|   error::AuthDataParseError, | ||||
|   gp_params::GpParams, | ||||
|   portal::{prelogin, Prelogin}, | ||||
|   utils::{redact::redact_uri, window::WindowExt}, | ||||
| @@ -185,10 +184,6 @@ impl<'a> AuthWindow<'a> { | ||||
|           } | ||||
|  | ||||
|           info!("Loaded uri: {}", redact_uri(&uri)); | ||||
|           if uri.starts_with("globalprotectcallback:") { | ||||
|             return; | ||||
|           } | ||||
|  | ||||
|           read_auth_data(&main_resource, auth_result_tx_clone.clone()); | ||||
|         } | ||||
|       }); | ||||
| @@ -207,9 +202,7 @@ impl<'a> AuthWindow<'a> { | ||||
|  | ||||
|       wv.connect_load_failed(move |_wv, _event, uri, err| { | ||||
|         let redacted_uri = redact_uri(uri); | ||||
|         if !uri.starts_with("globalprotectcallback:") { | ||||
|         warn!("Failed to load uri: {} with error: {}", redacted_uri, err); | ||||
|         } | ||||
|         // NOTE: Don't send error here, since load_changed event will be triggered after this | ||||
|         // send_auth_result(&auth_result_tx, Err(AuthDataError::Invalid)); | ||||
|         // true to stop other handlers from being invoked for the event. false to propagate the event further. | ||||
| @@ -346,7 +339,7 @@ fn read_auth_data_from_headers(response: &URIResponse) -> AuthResult { | ||||
|  | ||||
| fn read_auth_data_from_body<F>(main_resource: &WebResource, callback: F) | ||||
| where | ||||
|   F: FnOnce(Result<SamlAuthData, AuthDataParseError>) + Send + 'static, | ||||
|   F: FnOnce(AuthResult) + Send + 'static, | ||||
| { | ||||
|   main_resource.data(Cancellable::NONE, |data| match data { | ||||
|     Ok(data) => { | ||||
| @@ -355,41 +348,53 @@ where | ||||
|     } | ||||
|     Err(err) => { | ||||
|       info!("Failed to read response body: {}", err); | ||||
|       callback(Err(AuthDataParseError::Invalid)) | ||||
|       callback(Err(AuthDataError::Invalid)) | ||||
|     } | ||||
|   }); | ||||
| } | ||||
|  | ||||
| fn read_auth_data_from_html(html: &str) -> Result<SamlAuthData, AuthDataParseError> { | ||||
| fn read_auth_data_from_html(html: &str) -> AuthResult { | ||||
|   if html.contains("Temporarily Unavailable") { | ||||
|     info!("Found 'Temporarily Unavailable' in HTML, auth failed"); | ||||
|     return Err(AuthDataParseError::Invalid); | ||||
|     return Err(AuthDataError::Invalid); | ||||
|   } | ||||
|  | ||||
|   SamlAuthData::from_html(html).or_else(|err| { | ||||
|     if let Some(gpcallback) = extract_gpcallback(html) { | ||||
|       info!("Found gpcallback from html..."); | ||||
|       SamlAuthData::from_gpcallback(&gpcallback) | ||||
|     } else { | ||||
|       Err(err) | ||||
|     } | ||||
|   }) | ||||
| } | ||||
|   match parse_xml_tag(html, "saml-auth-status") { | ||||
|     Some(saml_status) if saml_status == "1" => { | ||||
|       let username = parse_xml_tag(html, "saml-username"); | ||||
|       let prelogin_cookie = parse_xml_tag(html, "prelogin-cookie"); | ||||
|       let portal_userauthcookie = parse_xml_tag(html, "portal-userauthcookie"); | ||||
|  | ||||
| fn extract_gpcallback(html: &str) -> Option<String> { | ||||
|   let re = Regex::new(r#"globalprotectcallback:[^"]+"#).unwrap(); | ||||
|   re.captures(html) | ||||
|     .and_then(|captures| captures.get(0)) | ||||
|     .map(|m| html_escape::decode_html_entities(m.as_str()).to_string()) | ||||
|       if SamlAuthData::check(&username, &prelogin_cookie, &portal_userauthcookie) { | ||||
|         return Ok(SamlAuthData::new( | ||||
|           username.unwrap(), | ||||
|           prelogin_cookie, | ||||
|           portal_userauthcookie, | ||||
|         )); | ||||
|       } | ||||
|  | ||||
|       info!("Found invalid auth data in HTML"); | ||||
|       Err(AuthDataError::Invalid) | ||||
|     } | ||||
|     Some(status) => { | ||||
|       info!("Found invalid SAML status {} in HTML", status); | ||||
|       Err(AuthDataError::Invalid) | ||||
|     } | ||||
|     None => { | ||||
|       info!("No auth data found in HTML"); | ||||
|       Err(AuthDataError::NotFound) | ||||
|     } | ||||
|   } | ||||
| } | ||||
|  | ||||
| fn read_auth_data(main_resource: &WebResource, auth_result_tx: mpsc::UnboundedSender<AuthResult>) { | ||||
|   let Some(response) = main_resource.response() else { | ||||
|   if main_resource.response().is_none() { | ||||
|     info!("No response found in main resource"); | ||||
|     send_auth_result(&auth_result_tx, Err(AuthDataError::Invalid)); | ||||
|     return; | ||||
|   }; | ||||
|   } | ||||
|  | ||||
|   let response = main_resource.response().unwrap(); | ||||
|   info!("Trying to read auth data from response headers..."); | ||||
|  | ||||
|   match read_auth_data_from_headers(&response) { | ||||
| @@ -402,27 +407,22 @@ fn read_auth_data(main_resource: &WebResource, auth_result_tx: mpsc::UnboundedSe | ||||
|       read_auth_data_from_body(main_resource, move |auth_result| { | ||||
|         // Since we have already found invalid auth data in headers, which means this could be the `/SAML20/SP/ACS` endpoint | ||||
|         // any error result from body should be considered as invalid, and trigger a retry | ||||
|         let auth_result = auth_result.map_err(|err| { | ||||
|           info!("Failed to read auth data from body: {}", err); | ||||
|           AuthDataError::Invalid | ||||
|         }); | ||||
|         let auth_result = auth_result.map_err(|_| AuthDataError::Invalid); | ||||
|         send_auth_result(&auth_result_tx, auth_result); | ||||
|       }); | ||||
|     } | ||||
|     Err(AuthDataError::NotFound) => { | ||||
|       info!("No auth data found in headers, trying to read from body..."); | ||||
|  | ||||
|       let is_acs_endpoint = main_resource.uri().map_or(false, |uri| uri.contains("/SAML20/SP/ACS")); | ||||
|       let url = main_resource.uri().unwrap_or("".into()); | ||||
|       let is_acs_endpoint = url.contains("/SAML20/SP/ACS"); | ||||
|  | ||||
|       read_auth_data_from_body(main_resource, move |auth_result| { | ||||
|         // If the endpoint is `/SAML20/SP/ACS` and no auth data found in body, it should be considered as invalid | ||||
|         let auth_result = auth_result.map_err(|err| { | ||||
|           info!("Failed to read auth data from body: {}", err); | ||||
|  | ||||
|           if !is_acs_endpoint && matches!(err, AuthDataParseError::NotFound) { | ||||
|             AuthDataError::NotFound | ||||
|           } else { | ||||
|           if matches!(err, AuthDataError::NotFound) && is_acs_endpoint { | ||||
|             AuthDataError::Invalid | ||||
|           } else { | ||||
|             err | ||||
|           } | ||||
|         }); | ||||
|  | ||||
| @@ -437,6 +437,13 @@ fn read_auth_data(main_resource: &WebResource, auth_result_tx: mpsc::UnboundedSe | ||||
|   } | ||||
| } | ||||
|  | ||||
| fn parse_xml_tag(html: &str, tag: &str) -> Option<String> { | ||||
|   let re = Regex::new(&format!("<{}>(.*)</{}>", tag, tag)).unwrap(); | ||||
|   re.captures(html) | ||||
|     .and_then(|captures| captures.get(1)) | ||||
|     .map(|m| m.as_str().to_string()) | ||||
| } | ||||
|  | ||||
| pub(crate) async fn clear_webview_cookies(window: &Window) -> anyhow::Result<()> { | ||||
|   let (tx, rx) = oneshot::channel::<Result<(), String>>(); | ||||
|  | ||||
| @@ -482,42 +489,3 @@ pub(crate) async fn clear_webview_cookies(window: &Window) -> anyhow::Result<()> | ||||
|  | ||||
|   rx.await?.map_err(|err| anyhow::anyhow!(err)) | ||||
| } | ||||
|  | ||||
| #[cfg(test)] | ||||
| mod tests { | ||||
|   use super::*; | ||||
|  | ||||
|   #[test] | ||||
|   fn extract_gpcallback_some() { | ||||
|     let html = r#" | ||||
|       <meta http-equiv="refresh" content="0; URL=globalprotectcallback:PGh0bWw+PCEtLSA8c"> | ||||
|       <meta http-equiv="refresh" content="0; URL=globalprotectcallback:PGh0bWw+PCEtLSA8c"> | ||||
|     "#; | ||||
|  | ||||
|     assert_eq!( | ||||
|       extract_gpcallback(html).as_deref(), | ||||
|       Some("globalprotectcallback:PGh0bWw+PCEtLSA8c") | ||||
|     ); | ||||
|   } | ||||
|  | ||||
|   #[test] | ||||
|   fn extract_gpcallback_cas() { | ||||
|     let html = r#" | ||||
|       <meta http-equiv="refresh" content="0; URL=globalprotectcallback:cas-as=1&un=xyz@email.com&token=very_long_string"> | ||||
|     "#; | ||||
|  | ||||
|     assert_eq!( | ||||
|       extract_gpcallback(html).as_deref(), | ||||
|       Some("globalprotectcallback:cas-as=1&un=xyz@email.com&token=very_long_string") | ||||
|     ); | ||||
|   } | ||||
|  | ||||
|   #[test] | ||||
|   fn extract_gpcallback_none() { | ||||
|     let html = r#" | ||||
|       <meta http-equiv="refresh" content="0; URL=PGh0bWw+PCEtLSA8c"> | ||||
|     "#; | ||||
|  | ||||
|     assert_eq!(extract_gpcallback(html), None); | ||||
|   } | ||||
| } | ||||
|   | ||||
| @@ -1,11 +1,8 @@ | ||||
| use std::{env::temp_dir, fs, os::unix::fs::PermissionsExt}; | ||||
|  | ||||
| use clap::Parser; | ||||
| use gpapi::{ | ||||
|   auth::{SamlAuthData, SamlAuthResult}, | ||||
|   clap::args::Os, | ||||
|   gp_params::{ClientOs, GpParams}, | ||||
|   process::browser_authenticator::BrowserAuthenticator, | ||||
|   utils::{normalize_server, openssl}, | ||||
|   GP_USER_AGENT, | ||||
| }; | ||||
| @@ -13,69 +10,33 @@ use log::{info, LevelFilter}; | ||||
| use serde_json::json; | ||||
| use tauri::{App, AppHandle, RunEvent}; | ||||
| use tempfile::NamedTempFile; | ||||
| use tokio::{io::AsyncReadExt, net::TcpListener}; | ||||
|  | ||||
| use crate::auth_window::{portal_prelogin, AuthWindow}; | ||||
|  | ||||
| const VERSION: &str = concat!(env!("CARGO_PKG_VERSION"), " (", compile_time::date_str!(), ")"); | ||||
|  | ||||
| #[derive(Parser, Clone)] | ||||
| #[command( | ||||
|   version = VERSION, | ||||
|   author, | ||||
|   about = "The authentication component for the GlobalProtect VPN client, supports the SSO authentication method.", | ||||
|   help_template = "\ | ||||
| {before-help}{name} {version} | ||||
| {author} | ||||
|  | ||||
| {about} | ||||
|  | ||||
| {usage-heading} {usage} | ||||
|  | ||||
| {all-args}{after-help} | ||||
|  | ||||
| See 'gpauth -h' for more information. | ||||
| " | ||||
| )] | ||||
| #[command(version = VERSION)] | ||||
| struct Cli { | ||||
|   #[arg(help = "The portal server to authenticate")] | ||||
|   server: String, | ||||
|  | ||||
|   #[arg(long, help = "Treating the server as a gateway")] | ||||
|   #[arg(long)] | ||||
|   gateway: bool, | ||||
|  | ||||
|   #[arg(long, help = "The SAML authentication request")] | ||||
|   #[arg(long)] | ||||
|   saml_request: Option<String>, | ||||
|  | ||||
|   #[arg(long, default_value = GP_USER_AGENT, help = "The user agent to use")] | ||||
|   #[arg(long, default_value = GP_USER_AGENT)] | ||||
|   user_agent: String, | ||||
|  | ||||
|   #[arg(long, default_value = "Linux")] | ||||
|   os: Os, | ||||
|  | ||||
|   #[arg(long)] | ||||
|   os_version: Option<String>, | ||||
|  | ||||
|   #[arg(long, help = "The HiDPI mode, useful for high-resolution screens")] | ||||
|   #[arg(long)] | ||||
|   hidpi: bool, | ||||
|  | ||||
|   #[arg(long, help = "Get around the OpenSSL `unsafe legacy renegotiation` error")] | ||||
|   #[arg(long)] | ||||
|   fix_openssl: bool, | ||||
|  | ||||
|   #[arg(long, help = "Ignore TLS errors")] | ||||
|   #[arg(long)] | ||||
|   ignore_tls_errors: bool, | ||||
|  | ||||
|   #[arg(long, help = "Clean the cache of the embedded browser")] | ||||
|   #[arg(long)] | ||||
|   clean: bool, | ||||
|  | ||||
|   #[arg(long, help = "Use the default browser for authentication")] | ||||
|   default_browser: bool, | ||||
|  | ||||
|   #[arg( | ||||
|     long, | ||||
|     help = "The browser to use for authentication, e.g., `default`, `firefox`, `chrome`, `chromium`, or the path to the browser executable" | ||||
|   )] | ||||
|   browser: Option<String>, | ||||
| } | ||||
|  | ||||
| impl Cli { | ||||
| @@ -95,31 +56,6 @@ impl Cli { | ||||
|       None => portal_prelogin(&self.server, &gp_params).await?, | ||||
|     }; | ||||
|  | ||||
|     let browser_auth = if let Some(browser) = &self.browser { | ||||
|       Some(BrowserAuthenticator::new_with_browser(&saml_request, browser)) | ||||
|     } else if self.default_browser { | ||||
|       Some(BrowserAuthenticator::new(&saml_request)) | ||||
|     } else { | ||||
|       None | ||||
|     }; | ||||
|  | ||||
|     if let Some(browser_auth) = browser_auth { | ||||
|       browser_auth.authenticate()?; | ||||
|  | ||||
|       info!("Please continue the authentication process in the default browser"); | ||||
|  | ||||
|       let auth_result = match wait_auth_data().await { | ||||
|         Ok(auth_data) => SamlAuthResult::Success(auth_data), | ||||
|         Err(err) => SamlAuthResult::Failure(format!("{}", err)), | ||||
|       }; | ||||
|  | ||||
|       info!("Authentication completed"); | ||||
|  | ||||
|       println!("{}", json!(auth_result)); | ||||
|  | ||||
|       return Ok(()); | ||||
|     } | ||||
|  | ||||
|     self.saml_request.replace(saml_request); | ||||
|  | ||||
|     let app = create_app(self.clone())?; | ||||
| @@ -224,35 +160,3 @@ pub async fn run() { | ||||
|     std::process::exit(1); | ||||
|   } | ||||
| } | ||||
|  | ||||
| async fn wait_auth_data() -> anyhow::Result<SamlAuthData> { | ||||
|   // Start a local server to receive the browser authentication data | ||||
|   let listener = TcpListener::bind("127.0.0.1:0").await?; | ||||
|   let port = listener.local_addr()?.port(); | ||||
|   let port_file = temp_dir().join("gpcallback.port"); | ||||
|  | ||||
|   // Write the port to a file | ||||
|   fs::write(&port_file, port.to_string())?; | ||||
|   fs::set_permissions(&port_file, fs::Permissions::from_mode(0o600))?; | ||||
|  | ||||
|   // Remove the previous log file | ||||
|   let callback_log = temp_dir().join("gpcallback.log"); | ||||
|   let _ = fs::remove_file(&callback_log); | ||||
|  | ||||
|   info!("Listening authentication data on port {}", port); | ||||
|   info!( | ||||
|     "If it hangs, please check the logs at `{}` for more information", | ||||
|     callback_log.display() | ||||
|   ); | ||||
|   let (mut socket, _) = listener.accept().await?; | ||||
|  | ||||
|   info!("Received the browser authentication data from the socket"); | ||||
|   let mut data = String::new(); | ||||
|   socket.read_to_string(&mut data).await?; | ||||
|  | ||||
|   // Remove the port file | ||||
|   fs::remove_file(&port_file)?; | ||||
|  | ||||
|   let auth_data = SamlAuthData::from_gpcallback(&data)?; | ||||
|   Ok(auth_data) | ||||
| } | ||||
|   | ||||
| @@ -22,8 +22,8 @@ | ||||
|         "all": true, | ||||
|         "request": true, | ||||
|         "scope": [ | ||||
|           "http://*", | ||||
|           "https://*" | ||||
|           "http://**", | ||||
|           "https://**" | ||||
|         ] | ||||
|       } | ||||
|     }, | ||||
|   | ||||
| @@ -6,7 +6,6 @@ edition.workspace = true | ||||
| license.workspace = true | ||||
|  | ||||
| [dependencies] | ||||
| common = { path = "../../crates/common" } | ||||
| gpapi = { path = "../../crates/gpapi", features = ["clap"] } | ||||
| openconnect = { path = "../../crates/openconnect" } | ||||
| anyhow.workspace = true | ||||
|   | ||||
| @@ -1,674 +0,0 @@ | ||||
|                     GNU GENERAL PUBLIC LICENSE | ||||
|                        Version 3, 29 June 2007 | ||||
|  | ||||
|  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | ||||
|  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. | ||||
|  | ||||
|     <one line to give the program's name and a brief idea of what it does.> | ||||
|     Copyright (C) <year>  <name of author> | ||||
|  | ||||
|     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 <https://www.gnu.org/licenses/>. | ||||
|  | ||||
| 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: | ||||
|  | ||||
|     <program>  Copyright (C) <year>  <name of author> | ||||
|     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 | ||||
| <https://www.gnu.org/licenses/>. | ||||
|  | ||||
|   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 | ||||
| <https://www.gnu.org/licenses/why-not-lgpl.html>. | ||||
| @@ -1,5 +1,3 @@ | ||||
| use std::{env::temp_dir, fs::File}; | ||||
|  | ||||
| use clap::{Parser, Subcommand}; | ||||
| use gpapi::utils::openssl; | ||||
| use log::{info, LevelFilter}; | ||||
| @@ -21,7 +19,7 @@ pub(crate) struct SharedArgs { | ||||
| #[derive(Subcommand)] | ||||
| enum CliCommand { | ||||
|   #[command(about = "Connect to a portal server")] | ||||
|   Connect(Box<ConnectArgs>), | ||||
|   Connect(ConnectArgs), | ||||
|   #[command(about = "Disconnect from the server")] | ||||
|   Disconnect, | ||||
|   #[command(about = "Launch the GUI")] | ||||
| @@ -87,29 +85,14 @@ impl Cli { | ||||
|   } | ||||
| } | ||||
|  | ||||
| fn init_logger(command: &CliCommand) { | ||||
|   let mut builder = env_logger::builder(); | ||||
|   builder.filter_level(LevelFilter::Info); | ||||
|  | ||||
|   // Output the log messages to a file if the command is the auth callback | ||||
|   if let CliCommand::LaunchGui(args) = command { | ||||
|     let auth_data = args.auth_data.as_deref().unwrap_or_default(); | ||||
|     if !auth_data.is_empty() { | ||||
|       if let Ok(log_file) = File::create(temp_dir().join("gpcallback.log")) { | ||||
|         let target = Box::new(log_file); | ||||
|         builder.target(env_logger::Target::Pipe(target)); | ||||
|       } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   builder.init(); | ||||
| fn init_logger() { | ||||
|   env_logger::builder().filter_level(LevelFilter::Info).init(); | ||||
| } | ||||
|  | ||||
| pub(crate) async fn run() { | ||||
|   let cli = Cli::parse(); | ||||
|  | ||||
|   init_logger(&cli.command); | ||||
|  | ||||
|   init_logger(); | ||||
|   info!("gpclient started: {}", VERSION); | ||||
|  | ||||
|   if let Err(err) = cli.run().await { | ||||
|   | ||||
| @@ -1,21 +1,17 @@ | ||||
| use std::{cell::RefCell, fs, sync::Arc}; | ||||
| use std::{fs, sync::Arc}; | ||||
|  | ||||
| use anyhow::bail; | ||||
| use clap::Args; | ||||
| use common::vpn_utils::find_csd_wrapper; | ||||
| use gpapi::{ | ||||
|   auth::SamlAuthResult, | ||||
|   clap::args::Os, | ||||
|   credential::{Credential, PasswordCredential}, | ||||
|   error::PortalError, | ||||
|   gateway::{gateway_login, GatewayLogin}, | ||||
|   gateway::gateway_login, | ||||
|   gp_params::{ClientOs, GpParams}, | ||||
|   portal::{prelogin, retrieve_config, Prelogin}, | ||||
|   portal::{prelogin, retrieve_config, PortalError, Prelogin}, | ||||
|   process::{ | ||||
|     auth_launcher::SamlAuthLauncher, | ||||
|     users::{get_non_root_user, get_user_by_name}, | ||||
|   }, | ||||
|   utils::{request::RequestIdentityError, shutdown_signal}, | ||||
|   utils::shutdown_signal, | ||||
|   GP_USER_AGENT, | ||||
| }; | ||||
| use inquire::{Password, PasswordDisplayMode, Select, Text}; | ||||
| @@ -28,85 +24,32 @@ use crate::{cli::SharedArgs, GP_CLIENT_LOCK_FILE}; | ||||
| pub(crate) struct ConnectArgs { | ||||
|   #[arg(help = "The portal server to connect to")] | ||||
|   server: String, | ||||
|  | ||||
|   #[arg(short, long, help = "The gateway to connect to, it will prompt if not specified")] | ||||
|   gateway: Option<String>, | ||||
|  | ||||
|   #[arg(short, long, help = "The username to use, it will prompt if not specified")] | ||||
|   user: Option<String>, | ||||
|  | ||||
|   #[arg(long, help = "Read the password from standard input")] | ||||
|   passwd_on_stdin: bool, | ||||
|  | ||||
|   #[arg(long, help = "Read the cookie from standard input")] | ||||
|   cookie_on_stdin: bool, | ||||
|  | ||||
|   #[arg(long, short, help = "The VPNC script to use")] | ||||
|   script: Option<String>, | ||||
|  | ||||
|   #[arg(long, help = "Connect the server as a gateway, instead of a portal")] | ||||
|   as_gateway: bool, | ||||
|  | ||||
|   #[arg( | ||||
|     long, | ||||
|     help = "Use the default CSD wrapper to generate the HIP report and send it to the server" | ||||
|   )] | ||||
|   hip: bool, | ||||
|  | ||||
|   #[arg( | ||||
|     short, | ||||
|     long, | ||||
|     help = "Use SSL client certificate file in pkcs#8 (.pem) or pkcs#12 (.p12, .pfx) format" | ||||
|   )] | ||||
|   certificate: Option<String>, | ||||
|  | ||||
|   #[arg(short = 'k', long, help = "Use SSL private key file in pkcs#8 (.pem) format")] | ||||
|   sslkey: Option<String>, | ||||
|  | ||||
|   #[arg(short = 'p', long, help = "The key passphrase of the private key")] | ||||
|   key_password: Option<String>, | ||||
|  | ||||
|   #[arg(long, help = "Same as the '--csd-user' option in the openconnect command")] | ||||
|   csd_user: Option<String>, | ||||
|  | ||||
|   #[arg(long, help = "Same as the '--csd-wrapper' option in the openconnect command")] | ||||
|   csd_wrapper: Option<String>, | ||||
|  | ||||
|   #[arg(long, default_value = "300", help = "Reconnection retry timeout in seconds")] | ||||
|   reconnect_timeout: u32, | ||||
|  | ||||
|   #[arg(short, long, help = "Request MTU from server (legacy servers only)")] | ||||
|   mtu: Option<u32>, | ||||
|  | ||||
|   #[arg(long, help = "Do not ask for IPv6 connectivity")] | ||||
|   disable_ipv6: bool, | ||||
|  | ||||
|   #[arg(long, default_value = GP_USER_AGENT, help = "The user agent to use")] | ||||
|   user_agent: String, | ||||
|  | ||||
|   #[arg(long, default_value = "Linux")] | ||||
|   os: Os, | ||||
|  | ||||
|   #[arg(long)] | ||||
|   os_version: Option<String>, | ||||
|  | ||||
|   #[arg(long, help = "Disable DTLS and ESP")] | ||||
|   no_dtls: bool, | ||||
|  | ||||
|   #[arg(long, help = "The HiDPI mode, useful for high-resolution screens")] | ||||
|   #[arg(long, help = "The HiDPI mode, useful for high resolution screens")] | ||||
|   hidpi: bool, | ||||
|  | ||||
|   #[arg(long, help = "Do not reuse the remembered authentication cookie")] | ||||
|   clean: bool, | ||||
|  | ||||
|   #[arg(long, help = "Use the default browser to authenticate")] | ||||
|   default_browser: bool, | ||||
|  | ||||
|   #[arg( | ||||
|     long, | ||||
|     help = "Use the specified browser to authenticate, e.g., `default`, `firefox`, `chrome`, `chromium`, or the path to the browser executable" | ||||
|   )] | ||||
|   browser: Option<String>, | ||||
| } | ||||
|  | ||||
| impl ConnectArgs { | ||||
| @@ -126,16 +69,11 @@ impl ConnectArgs { | ||||
| pub(crate) struct ConnectHandler<'a> { | ||||
|   args: &'a ConnectArgs, | ||||
|   shared_args: &'a SharedArgs, | ||||
|   latest_key_password: RefCell<Option<String>>, | ||||
| } | ||||
|  | ||||
| impl<'a> ConnectHandler<'a> { | ||||
|   pub(crate) fn new(args: &'a ConnectArgs, shared_args: &'a SharedArgs) -> Self { | ||||
|     Self { | ||||
|       args, | ||||
|       shared_args, | ||||
|       latest_key_password: Default::default(), | ||||
|     } | ||||
|     Self { args, shared_args } | ||||
|   } | ||||
|  | ||||
|   fn build_gp_params(&self) -> GpParams { | ||||
| @@ -144,56 +82,11 @@ impl<'a> ConnectHandler<'a> { | ||||
|       .client_os(ClientOs::from(&self.args.os)) | ||||
|       .os_version(self.args.os_version()) | ||||
|       .ignore_tls_errors(self.shared_args.ignore_tls_errors) | ||||
|       .certificate(self.args.certificate.clone()) | ||||
|       .sslkey(self.args.sslkey.clone()) | ||||
|       .key_password(self.latest_key_password.borrow().clone()) | ||||
|       .build() | ||||
|   } | ||||
|  | ||||
|   pub(crate) async fn handle(&self) -> anyhow::Result<()> { | ||||
|     if self.args.default_browser && self.args.browser.is_some() { | ||||
|       bail!("Cannot use `--default-browser` and `--browser` options at the same time"); | ||||
|     } | ||||
|  | ||||
|     self.latest_key_password.replace(self.args.key_password.clone()); | ||||
|  | ||||
|     loop { | ||||
|       let Err(err) = self.handle_impl().await else { | ||||
|         return Ok(()); | ||||
|       }; | ||||
|  | ||||
|       let Some(root_cause) = err.root_cause().downcast_ref::<RequestIdentityError>() else { | ||||
|         return Err(err); | ||||
|       }; | ||||
|  | ||||
|       match root_cause { | ||||
|         RequestIdentityError::NoKey => { | ||||
|           eprintln!("ERROR: No private key found in the certificate file"); | ||||
|           eprintln!("ERROR: Please provide the private key file using the `-k` option"); | ||||
|           return Ok(()); | ||||
|         } | ||||
|         RequestIdentityError::NoPassphrase(cert_type) | RequestIdentityError::DecryptError(cert_type) => { | ||||
|           // Decrypt the private key error, ask for the key password | ||||
|           let message = format!("Enter the {} passphrase:", cert_type); | ||||
|           let password = Password::new(&message) | ||||
|             .without_confirmation() | ||||
|             .with_display_mode(PasswordDisplayMode::Masked) | ||||
|             .prompt()?; | ||||
|  | ||||
|           self.latest_key_password.replace(Some(password)); | ||||
|         } | ||||
|       } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   pub(crate) async fn handle_impl(&self) -> anyhow::Result<()> { | ||||
|     let server = self.args.server.as_str(); | ||||
|     let as_gateway = self.args.as_gateway; | ||||
|  | ||||
|     if as_gateway { | ||||
|       info!("Treating the server as a gateway"); | ||||
|       return self.connect_gateway_with_prelogin(server).await; | ||||
|     } | ||||
|  | ||||
|     let Err(err) = self.connect_portal_with_prelogin(server).await else { | ||||
|       return Ok(()); | ||||
| @@ -202,15 +95,10 @@ impl<'a> ConnectHandler<'a> { | ||||
|     info!("Failed to connect portal with prelogin: {}", err); | ||||
|     if err.root_cause().downcast_ref::<PortalError>().is_some() { | ||||
|       info!("Trying the gateway authentication workflow..."); | ||||
|       self.connect_gateway_with_prelogin(server).await?; | ||||
|  | ||||
|       eprintln!("\nNOTE: the server may be a gateway, not a portal."); | ||||
|       eprintln!("NOTE: try to use the `--as-gateway` option if you were authenticated twice."); | ||||
|  | ||||
|       Ok(()) | ||||
|     } else { | ||||
|       Err(err) | ||||
|       return self.connect_gateway_with_prelogin(server).await; | ||||
|     } | ||||
|  | ||||
|     Err(err) | ||||
|   } | ||||
|  | ||||
|   async fn connect_portal_with_prelogin(&self, portal: &str) -> anyhow::Result<()> { | ||||
| @@ -224,19 +112,16 @@ impl<'a> ConnectHandler<'a> { | ||||
|     let selected_gateway = match &self.args.gateway { | ||||
|       Some(gateway) => portal_config | ||||
|         .find_gateway(gateway) | ||||
|         .ok_or_else(|| anyhow::anyhow!("Cannot find gateway specified: {}", gateway))?, | ||||
|         .ok_or_else(|| anyhow::anyhow!("Cannot find gateway {}", gateway))?, | ||||
|       None => { | ||||
|         portal_config.sort_gateways(prelogin.region()); | ||||
|         let gateways = portal_config.gateways(); | ||||
|  | ||||
|         if gateways.len() > 1 { | ||||
|           let gateway = Select::new("Which gateway do you want to connect to?", gateways) | ||||
|           Select::new("Which gateway do you want to connect to?", gateways) | ||||
|             .with_vim_mode(true) | ||||
|             .prompt()?; | ||||
|           info!("Connecting to the selected gateway: {}", gateway); | ||||
|           gateway | ||||
|             .prompt()? | ||||
|         } else { | ||||
|           info!("Connecting to the only available gateway: {}", gateways[0]); | ||||
|           gateways[0] | ||||
|         } | ||||
|       } | ||||
| @@ -245,7 +130,7 @@ impl<'a> ConnectHandler<'a> { | ||||
|     let gateway = selected_gateway.server(); | ||||
|     let cred = portal_config.auth_cookie().into(); | ||||
|  | ||||
|     let cookie = match self.login_gateway(gateway, &cred, &gp_params).await { | ||||
|     let cookie = match gateway_login(gateway, &cred, &gp_params).await { | ||||
|       Ok(cookie) => cookie, | ||||
|       Err(err) => { | ||||
|         info!("Gateway login failed: {}", err); | ||||
| @@ -257,62 +142,28 @@ impl<'a> ConnectHandler<'a> { | ||||
|   } | ||||
|  | ||||
|   async fn connect_gateway_with_prelogin(&self, gateway: &str) -> anyhow::Result<()> { | ||||
|     info!("Performing the gateway authentication..."); | ||||
|  | ||||
|     let mut gp_params = self.build_gp_params(); | ||||
|     gp_params.set_is_gateway(true); | ||||
|  | ||||
|     let prelogin = prelogin(gateway, &gp_params).await?; | ||||
|     let cred = self.obtain_credential(&prelogin, gateway).await?; | ||||
|  | ||||
|     let cookie = self.login_gateway(gateway, &cred, &gp_params).await?; | ||||
|     let cookie = gateway_login(gateway, &cred, &gp_params).await?; | ||||
|  | ||||
|     self.connect_gateway(gateway, &cookie).await | ||||
|   } | ||||
|  | ||||
|   async fn login_gateway(&self, gateway: &str, cred: &Credential, gp_params: &GpParams) -> anyhow::Result<String> { | ||||
|     let mut gp_params = gp_params.clone(); | ||||
|  | ||||
|     loop { | ||||
|       match gateway_login(gateway, cred, &gp_params).await? { | ||||
|         GatewayLogin::Cookie(cookie) => return Ok(cookie), | ||||
|         GatewayLogin::Mfa(message, input_str) => { | ||||
|           let otp = Text::new(&message).prompt()?; | ||||
|           gp_params.set_input_str(&input_str); | ||||
|           gp_params.set_otp(&otp); | ||||
|  | ||||
|           info!("Retrying gateway login with MFA..."); | ||||
|         } | ||||
|       } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   async fn connect_gateway(&self, gateway: &str, cookie: &str) -> anyhow::Result<()> { | ||||
|     let mtu = self.args.mtu.unwrap_or(0); | ||||
|     let csd_uid = get_csd_uid(&self.args.csd_user)?; | ||||
|     let csd_wrapper = if self.args.csd_wrapper.is_some() { | ||||
|       self.args.csd_wrapper.clone() | ||||
|     } else if self.args.hip { | ||||
|       find_csd_wrapper() | ||||
|     } else { | ||||
|       None | ||||
|     }; | ||||
|     let mtu = self.args.mtu.unwrap_or(0); | ||||
|  | ||||
|     let os = ClientOs::from(&self.args.os).to_openconnect_os().to_string(); | ||||
|     let vpn = Vpn::builder(gateway, cookie) | ||||
|       .script(self.args.script.clone()) | ||||
|       .user_agent(self.args.user_agent.clone()) | ||||
|       .os(Some(os)) | ||||
|       .certificate(self.args.certificate.clone()) | ||||
|       .sslkey(self.args.sslkey.clone()) | ||||
|       .key_password(self.latest_key_password.borrow().clone()) | ||||
|       .script(self.args.script.clone()) | ||||
|       .csd_uid(csd_uid) | ||||
|       .csd_wrapper(csd_wrapper) | ||||
|       .reconnect_timeout(self.args.reconnect_timeout) | ||||
|       .csd_wrapper(self.args.csd_wrapper.clone()) | ||||
|       .mtu(mtu) | ||||
|       .disable_ipv6(self.args.disable_ipv6) | ||||
|       .no_dtls(self.args.no_dtls) | ||||
|       .build()?; | ||||
|       .build(); | ||||
|  | ||||
|     let vpn = Arc::new(vpn); | ||||
|     let vpn_clone = vpn.clone(); | ||||
| @@ -335,22 +186,11 @@ impl<'a> ConnectHandler<'a> { | ||||
|   } | ||||
|  | ||||
|   async fn obtain_credential(&self, prelogin: &Prelogin, server: &str) -> anyhow::Result<Credential> { | ||||
|     if self.args.cookie_on_stdin { | ||||
|       return read_cookie_from_stdin(); | ||||
|     } | ||||
|  | ||||
|     let is_gateway = prelogin.is_gateway(); | ||||
|  | ||||
|     match prelogin { | ||||
|       Prelogin::Saml(prelogin) => { | ||||
|         let use_default_browser = prelogin.support_default_browser() && self.args.default_browser; | ||||
|         let browser = if prelogin.support_default_browser() { | ||||
|           self.args.browser.as_deref() | ||||
|         } else { | ||||
|           None | ||||
|         }; | ||||
|  | ||||
|         let cred = SamlAuthLauncher::new(&self.args.server) | ||||
|         SamlAuthLauncher::new(&self.args.server) | ||||
|           .gateway(is_gateway) | ||||
|           .saml_request(prelogin.saml_request()) | ||||
|           .user_agent(&self.args.user_agent) | ||||
| @@ -360,14 +200,9 @@ impl<'a> ConnectHandler<'a> { | ||||
|           .fix_openssl(self.shared_args.fix_openssl) | ||||
|           .ignore_tls_errors(self.shared_args.ignore_tls_errors) | ||||
|           .clean(self.args.clean) | ||||
|           .default_browser(use_default_browser) | ||||
|           .browser(browser) | ||||
|           .launch() | ||||
|           .await?; | ||||
|  | ||||
|         Ok(cred) | ||||
|           .await | ||||
|       } | ||||
|  | ||||
|       Prelogin::Standard(prelogin) => { | ||||
|         let prefix = if is_gateway { "Gateway" } else { "Portal" }; | ||||
|         println!("{} ({}: {})", prelogin.auth_message(), prefix, server); | ||||
| @@ -376,18 +211,10 @@ impl<'a> ConnectHandler<'a> { | ||||
|           || Text::new(&format!("{}:", prelogin.label_username())).prompt(), | ||||
|           |user| Ok(user.to_owned()), | ||||
|         )?; | ||||
|  | ||||
|         let password = if self.args.passwd_on_stdin { | ||||
|           info!("Reading password from standard input"); | ||||
|           let mut input = String::new(); | ||||
|           std::io::stdin().read_line(&mut input)?; | ||||
|           input.trim_end().to_owned() | ||||
|         } else { | ||||
|           Password::new(&format!("{}:", prelogin.label_password())) | ||||
|         let password = Password::new(&format!("{}:", prelogin.label_password())) | ||||
|           .without_confirmation() | ||||
|           .with_display_mode(PasswordDisplayMode::Masked) | ||||
|             .prompt()? | ||||
|         }; | ||||
|           .prompt()?; | ||||
|  | ||||
|         let password_cred = PasswordCredential::new(&user, &password); | ||||
|  | ||||
| @@ -397,19 +224,6 @@ impl<'a> ConnectHandler<'a> { | ||||
|   } | ||||
| } | ||||
|  | ||||
| fn read_cookie_from_stdin() -> anyhow::Result<Credential> { | ||||
|   info!("Reading cookie from standard input"); | ||||
|  | ||||
|   let mut cookie = String::new(); | ||||
|   std::io::stdin().read_line(&mut cookie)?; | ||||
|  | ||||
|   let Ok(auth_result) = serde_json::from_str::<SamlAuthResult>(cookie.trim_end()) else { | ||||
|     bail!("Failed to parse auth data") | ||||
|   }; | ||||
|  | ||||
|   Credential::try_from(auth_result) | ||||
| } | ||||
|  | ||||
| fn write_pid_file() { | ||||
|   let pid = std::process::id(); | ||||
|  | ||||
|   | ||||
| @@ -1,4 +1,4 @@ | ||||
| use std::{collections::HashMap, env::temp_dir, fs, path::PathBuf}; | ||||
| use std::{collections::HashMap, fs, path::PathBuf}; | ||||
|  | ||||
| use clap::Args; | ||||
| use directories::ProjectDirs; | ||||
| @@ -7,7 +7,6 @@ use gpapi::{ | ||||
|   utils::{endpoint::http_endpoint, env_file, shutdown_signal}, | ||||
| }; | ||||
| use log::info; | ||||
| use tokio::io::AsyncWriteExt; | ||||
|  | ||||
| #[derive(Args)] | ||||
| pub(crate) struct LaunchGuiArgs { | ||||
| @@ -15,7 +14,7 @@ pub(crate) struct LaunchGuiArgs { | ||||
|     required = false, | ||||
|     help = "The authentication data, used for the default browser authentication" | ||||
|   )] | ||||
|   pub auth_data: Option<String>, | ||||
|   auth_data: Option<String>, | ||||
|   #[arg(long, help = "Launch the GUI minimized")] | ||||
|   minimized: bool, | ||||
| } | ||||
| @@ -38,7 +37,6 @@ impl<'a> LaunchGuiHandler<'a> { | ||||
|  | ||||
|     let auth_data = self.args.auth_data.as_deref().unwrap_or_default(); | ||||
|     if !auth_data.is_empty() { | ||||
|       info!("Received auth callback data"); | ||||
|       // Process the authentication data, its format is `globalprotectcallback:<data>` | ||||
|       return feed_auth_data(auth_data).await; | ||||
|     } | ||||
| @@ -80,31 +78,11 @@ impl<'a> LaunchGuiHandler<'a> { | ||||
| } | ||||
|  | ||||
| async fn feed_auth_data(auth_data: &str) -> anyhow::Result<()> { | ||||
|   let (res_gui, res_cli) = tokio::join!(feed_auth_data_gui(auth_data), feed_auth_data_cli(auth_data)); | ||||
|   if let Err(err) = res_gui { | ||||
|     info!("Failed to feed auth data to the GUI: {}", err); | ||||
|   } | ||||
|  | ||||
|   if let Err(err) = res_cli { | ||||
|     info!("Failed to feed auth data to the CLI: {}", err); | ||||
|   } | ||||
|  | ||||
|   // Cleanup the temporary file | ||||
|   let html_file = temp_dir().join("gpauth.html"); | ||||
|   if let Err(err) = std::fs::remove_file(&html_file) { | ||||
|     info!("Failed to remove {}: {}", html_file.display(), err); | ||||
|   } | ||||
|  | ||||
|   Ok(()) | ||||
| } | ||||
|  | ||||
| async fn feed_auth_data_gui(auth_data: &str) -> anyhow::Result<()> { | ||||
|   info!("Feeding auth data to the GUI"); | ||||
|   let service_endpoint = http_endpoint().await?; | ||||
|  | ||||
|   reqwest::Client::default() | ||||
|     .post(format!("{}/auth-data", service_endpoint)) | ||||
|     .body(auth_data.to_string()) | ||||
|     .json(&auth_data) | ||||
|     .send() | ||||
|     .await? | ||||
|     .error_for_status()?; | ||||
| @@ -112,18 +90,6 @@ async fn feed_auth_data_gui(auth_data: &str) -> anyhow::Result<()> { | ||||
|   Ok(()) | ||||
| } | ||||
|  | ||||
| async fn feed_auth_data_cli(auth_data: &str) -> anyhow::Result<()> { | ||||
|   info!("Feeding auth data to the CLI"); | ||||
|  | ||||
|   let port_file = temp_dir().join("gpcallback.port"); | ||||
|   let port = tokio::fs::read_to_string(port_file).await?; | ||||
|   let mut stream = tokio::net::TcpStream::connect(format!("127.0.0.1:{}", port.trim())).await?; | ||||
|  | ||||
|   stream.write_all(auth_data.as_bytes()).await?; | ||||
|  | ||||
|   Ok(()) | ||||
| } | ||||
|  | ||||
| async fn try_active_gui() -> anyhow::Result<()> { | ||||
|   let service_endpoint = http_endpoint().await?; | ||||
|  | ||||
| @@ -136,7 +102,7 @@ async fn try_active_gui() -> anyhow::Result<()> { | ||||
|   Ok(()) | ||||
| } | ||||
|  | ||||
| fn get_log_file() -> anyhow::Result<PathBuf> { | ||||
| pub fn get_log_file() -> anyhow::Result<PathBuf> { | ||||
|   let dirs = ProjectDirs::from("com.yuezk", "GlobalProtect-openconnect", "gpclient") | ||||
|     .ok_or_else(|| anyhow::anyhow!("Failed to get project dirs"))?; | ||||
|  | ||||
|   | ||||
| @@ -1,674 +0,0 @@ | ||||
|                     GNU GENERAL PUBLIC LICENSE | ||||
|                        Version 3, 29 June 2007 | ||||
|  | ||||
|  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | ||||
|  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. | ||||
|  | ||||
|     <one line to give the program's name and a brief idea of what it does.> | ||||
|     Copyright (C) <year>  <name of author> | ||||
|  | ||||
|     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 <https://www.gnu.org/licenses/>. | ||||
|  | ||||
| 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: | ||||
|  | ||||
|     <program>  Copyright (C) <year>  <name of author> | ||||
|     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 | ||||
| <https://www.gnu.org/licenses/>. | ||||
|  | ||||
|   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 | ||||
| <https://www.gnu.org/licenses/why-not-lgpl.html>. | ||||
| @@ -9,29 +9,28 @@ | ||||
|     "tauri": "tauri" | ||||
|   }, | ||||
|   "dependencies": { | ||||
|     "@emotion/react": "^11.13.0", | ||||
|     "@emotion/styled": "^11.13.0", | ||||
|     "@mui/icons-material": "^5.16.7", | ||||
|     "@mui/material": "^5.16.7", | ||||
|     "@tauri-apps/api": "^1.6.0", | ||||
|     "react": "^18.3.1", | ||||
|     "react-dom": "^18.3.1" | ||||
|     "@emotion/react": "^11.11.1", | ||||
|     "@emotion/styled": "^11.11.0", | ||||
|     "@mui/icons-material": "^5.14.18", | ||||
|     "@mui/material": "^5.14.18", | ||||
|     "@tauri-apps/api": "^1.5.0", | ||||
|     "react": "^18.2.0", | ||||
|     "react-dom": "^18.2.0" | ||||
|   }, | ||||
|   "devDependencies": { | ||||
|     "@tauri-apps/cli": "^1.6.0", | ||||
|     "@types/node": "^20.14.15", | ||||
|     "@types/react": "^18.3.3", | ||||
|     "@types/react-dom": "^18.3.0", | ||||
|     "@typescript-eslint/eslint-plugin": "^6.21.0", | ||||
|     "@typescript-eslint/parser": "^6.21.0", | ||||
|     "@vitejs/plugin-react": "^4.3.1", | ||||
|     "eslint": "^8.57.0", | ||||
|     "eslint-config-prettier": "^9.1.0", | ||||
|     "eslint-plugin-react": "^7.35.0", | ||||
|     "eslint-plugin-react-hooks": "^4.6.2", | ||||
|     "@tauri-apps/cli": "^1.5.0", | ||||
|     "@types/node": "^20.8.10", | ||||
|     "@types/react": "^18.2.15", | ||||
|     "@types/react-dom": "^18.2.7", | ||||
|     "@typescript-eslint/eslint-plugin": "^6.12.0", | ||||
|     "@typescript-eslint/parser": "^6.12.0", | ||||
|     "@vitejs/plugin-react": "^4.0.3", | ||||
|     "eslint": "^8.54.0", | ||||
|     "eslint-config-prettier": "^9.0.0", | ||||
|     "eslint-plugin-react": "^7.33.2", | ||||
|     "eslint-plugin-react-hooks": "^4.6.0", | ||||
|     "prettier": "3.1.0", | ||||
|     "typescript": "^5.5.4", | ||||
|     "vite": "^4.5.3" | ||||
|   }, | ||||
|   "packageManager": "pnpm@8.15.7" | ||||
|     "typescript": "^5.0.2", | ||||
|     "vite": "^4.4.4" | ||||
|   } | ||||
| } | ||||
|   | ||||
							
								
								
									
										1980
									
								
								apps/gpgui-helper/pnpm-lock.yaml
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										1980
									
								
								apps/gpgui-helper/pnpm-lock.yaml
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @@ -9,12 +9,6 @@ use tauri::{Manager, Window}; | ||||
|  | ||||
| use crate::downloader::{ChecksumFetcher, FileDownloader}; | ||||
|  | ||||
| #[cfg(not(debug_assertions))] | ||||
| const SNAPSHOT: &str = match option_env!("SNAPSHOT") { | ||||
|     Some(val) => val, | ||||
|     None => "false" | ||||
| }; | ||||
|  | ||||
| pub struct ProgressNotifier { | ||||
|   win: Window, | ||||
| } | ||||
| @@ -86,24 +80,12 @@ impl GuiUpdater { | ||||
|   pub async fn update(&self) { | ||||
|     info!("Update GUI, version: {}", self.version); | ||||
|  | ||||
|     #[cfg(debug_assertions)] | ||||
|     let release_tag = "snapshot"; | ||||
|     #[cfg(not(debug_assertions))] | ||||
|     let release_tag = if SNAPSHOT == "true" { | ||||
|       String::from("snapshot") | ||||
|     } else { | ||||
|       format!("v{}", self.version) | ||||
|     }; | ||||
|  | ||||
|     #[cfg(target_arch = "x86_64")] | ||||
|     let arch = "x86_64"; | ||||
|     let arch = "amd64"; | ||||
|     #[cfg(target_arch = "aarch64")] | ||||
|     let arch = "aarch64"; | ||||
|     let arch = "arm64"; | ||||
|  | ||||
|     let file_url = format!( | ||||
|       "https://github.com/yuezk/GlobalProtect-openconnect/releases/download/{}/gpgui_{}.bin.tar.xz", | ||||
|       release_tag, arch | ||||
|     ); | ||||
|     let file_url = format!("https://github.com/yuezk/GlobalProtect-openconnect/releases/download/v{}/gpgui-linux-{}", self.version, arch); | ||||
|     let checksum_url = format!("{}.sha256", file_url); | ||||
|  | ||||
|     info!("Downloading file: {}", file_url); | ||||
|   | ||||
| @@ -18,5 +18,3 @@ serde_json.workspace = true | ||||
| env_logger.workspace = true | ||||
| log.workspace = true | ||||
| compile-time.workspace = true | ||||
| xz2 = "0.1" | ||||
| tar = "0.4" | ||||
|   | ||||
| @@ -1,674 +0,0 @@ | ||||
|                     GNU GENERAL PUBLIC LICENSE | ||||
|                        Version 3, 29 June 2007 | ||||
|  | ||||
|  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | ||||
|  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. | ||||
|  | ||||
|     <one line to give the program's name and a brief idea of what it does.> | ||||
|     Copyright (C) <year>  <name of author> | ||||
|  | ||||
|     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 <https://www.gnu.org/licenses/>. | ||||
|  | ||||
| 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: | ||||
|  | ||||
|     <program>  Copyright (C) <year>  <name of author> | ||||
|     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 | ||||
| <https://www.gnu.org/licenses/>. | ||||
|  | ||||
|   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 | ||||
| <https://www.gnu.org/licenses/why-not-lgpl.html>. | ||||
| @@ -1,12 +1,4 @@ | ||||
| use std::{ | ||||
|   borrow::Cow, | ||||
|   fs::{File, Permissions}, | ||||
|   io::BufReader, | ||||
|   ops::ControlFlow, | ||||
|   os::unix::fs::PermissionsExt, | ||||
|   path::PathBuf, | ||||
|   sync::Arc, | ||||
| }; | ||||
| use std::{borrow::Cow, fs::Permissions, ops::ControlFlow, os::unix::fs::PermissionsExt, path::PathBuf, sync::Arc}; | ||||
|  | ||||
| use anyhow::bail; | ||||
| use axum::{ | ||||
| @@ -25,9 +17,7 @@ use gpapi::{ | ||||
|   GP_GUI_BINARY, | ||||
| }; | ||||
| use log::{info, warn}; | ||||
| use tar::Archive; | ||||
| use tokio::fs; | ||||
| use xz2::read::XzDecoder; | ||||
|  | ||||
| use crate::ws_server::WsServerContext; | ||||
|  | ||||
| @@ -70,7 +60,6 @@ pub async fn update_gui(State(ctx): State<Arc<WsServerContext>>, body: Bytes) -> | ||||
|   Ok(()) | ||||
| } | ||||
|  | ||||
| // Unpack GPGUI archive, gpgui_2.0.0_{arch}.bin.tar.xz and install it | ||||
| async fn install_gui(src: &str) -> anyhow::Result<()> { | ||||
|   let path = PathBuf::from(GP_GUI_BINARY); | ||||
|   let Some(dir) = path.parent() else { | ||||
| @@ -79,27 +68,8 @@ async fn install_gui(src: &str) -> anyhow::Result<()> { | ||||
|  | ||||
|   fs::create_dir_all(dir).await?; | ||||
|  | ||||
|   // Unpack the archive | ||||
|   info!("Unpacking GUI archive"); | ||||
|   let tar = XzDecoder::new(BufReader::new(File::open(src)?)); | ||||
|   let mut ar = Archive::new(tar); | ||||
|  | ||||
|   for entry in ar.entries()? { | ||||
|     let mut entry = entry?; | ||||
|     let path = entry.path()?; | ||||
|  | ||||
|     if let Some(name) = path.file_name() { | ||||
|       let name = name.to_string_lossy(); | ||||
|  | ||||
|       if name == "gpgui" { | ||||
|         let mut file = File::create(GP_GUI_BINARY)?; | ||||
|         std::io::copy(&mut entry, &mut file)?; | ||||
|         break; | ||||
|       } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   // Make the binary executable | ||||
|   // Copy the file to the final location and make it executable | ||||
|   fs::copy(src, GP_GUI_BINARY).await?; | ||||
|   fs::set_permissions(GP_GUI_BINARY, Permissions::from_mode(0o755)).await?; | ||||
|  | ||||
|   Ok(()) | ||||
|   | ||||
| @@ -4,7 +4,7 @@ use gpapi::service::{ | ||||
|   request::{ConnectRequest, WsRequest}, | ||||
|   vpn_state::VpnState, | ||||
| }; | ||||
| use log::{info, warn}; | ||||
| use log::info; | ||||
| use openconnect::Vpn; | ||||
| use tokio::sync::{mpsc, oneshot, watch, RwLock}; | ||||
| use tokio_util::sync::CancellationToken; | ||||
| @@ -31,35 +31,22 @@ impl VpnTaskContext { | ||||
|       return; | ||||
|     } | ||||
|  | ||||
|     let vpn_state_tx = self.vpn_state_tx.clone(); | ||||
|     let info = req.info().clone(); | ||||
|     let vpn_handle = Arc::clone(&self.vpn_handle); | ||||
|     let args = req.args(); | ||||
|     let vpn = match Vpn::builder(req.gateway().server(), args.cookie()) | ||||
|       .script(args.vpnc_script()) | ||||
|     let vpn = Vpn::builder(req.gateway().server(), args.cookie()) | ||||
|       .user_agent(args.user_agent()) | ||||
|       .os(args.openconnect_os()) | ||||
|       .certificate(args.certificate()) | ||||
|       .sslkey(args.sslkey()) | ||||
|       .key_password(args.key_password()) | ||||
|       .script(args.vpnc_script()) | ||||
|       .csd_uid(args.csd_uid()) | ||||
|       .csd_wrapper(args.csd_wrapper()) | ||||
|       .reconnect_timeout(args.reconnect_timeout()) | ||||
|       .mtu(args.mtu()) | ||||
|       .disable_ipv6(args.disable_ipv6()) | ||||
|       .no_dtls(args.no_dtls()) | ||||
|       .build() | ||||
|     { | ||||
|       Ok(vpn) => vpn, | ||||
|       Err(err) => { | ||||
|         warn!("Failed to create VPN: {}", err); | ||||
|         vpn_state_tx.send(VpnState::Disconnected).ok(); | ||||
|         return; | ||||
|       } | ||||
|     }; | ||||
|       .os(args.openconnect_os()) | ||||
|       .build(); | ||||
|  | ||||
|     // Save the VPN handle | ||||
|     vpn_handle.write().await.replace(vpn); | ||||
|  | ||||
|     let vpn_state_tx = self.vpn_state_tx.clone(); | ||||
|     let connect_info = Box::new(info.clone()); | ||||
|     vpn_state_tx.send(VpnState::Connecting(connect_info)).ok(); | ||||
|  | ||||
|   | ||||
| @@ -118,14 +118,12 @@ impl WsServer { | ||||
|   } | ||||
|  | ||||
|   pub async fn start(&self, shutdown_tx: mpsc::Sender<()>) { | ||||
|     let listener = match self.start_tcp_server().await { | ||||
|       Ok(listener) => listener, | ||||
|       Err(err) => { | ||||
|         warn!("Failed to start WS server: {}", err); | ||||
|         let _ = shutdown_tx.send(()).await; | ||||
|         return; | ||||
|       }, | ||||
|     }; | ||||
|     if let Ok(listener) = TcpListener::bind("127.0.0.1:0").await { | ||||
|       let local_addr = listener.local_addr().unwrap(); | ||||
|  | ||||
|       self.lock_file.lock(local_addr.port().to_string()).unwrap(); | ||||
|  | ||||
|       info!("WS server listening on port: {}", local_addr.port()); | ||||
|  | ||||
|       tokio::select! { | ||||
|         _ = watch_vpn_state(self.ctx.vpn_state_rx(), Arc::clone(&self.ctx)) => { | ||||
| @@ -138,20 +136,9 @@ impl WsServer { | ||||
|           info!("WS server cancelled"); | ||||
|         } | ||||
|       } | ||||
|  | ||||
|     let _ = shutdown_tx.send(()).await; | ||||
|     } | ||||
|  | ||||
|   async fn start_tcp_server(&self) -> anyhow::Result<TcpListener> { | ||||
|     let listener = TcpListener::bind("127.0.0.1:0").await?; | ||||
|     let local_addr = listener.local_addr()?; | ||||
|     let port = local_addr.port(); | ||||
|  | ||||
|     info!("WS server listening on port: {}", port); | ||||
|  | ||||
|     self.lock_file.lock(port.to_string())?; | ||||
|  | ||||
|     Ok(listener) | ||||
|     let _ = shutdown_tx.send(()).await; | ||||
|   } | ||||
| } | ||||
|  | ||||
|   | ||||
							
								
								
									
										79
									
								
								changelog.md
									
									
									
									
									
								
							
							
						
						
									
										79
									
								
								changelog.md
									
									
									
									
									
								
							| @@ -1,84 +1,5 @@ | ||||
| # Changelog | ||||
|  | ||||
| ## 2.3.6 - 2024-08-15 | ||||
|  | ||||
| - CLI: enhance the `gpauth` command to support external browser authentication | ||||
| - CLI: add the `--cookie-on-stdin` option to support read the cookie from stdin | ||||
| - CLI: support usage: `gpauth <portal> --browser <browser> 2>/dev/null | sudo gpclient connect <portal> --cookie-on-stdin` | ||||
| - CLI: fix the `--browser <browser>` option not working | ||||
|  | ||||
| ## 2.3.5 - 2024-08-14 | ||||
|  | ||||
| - Support configure `no-dtls` option | ||||
| - GUI: fix the tray icon disk usage issue (#398) | ||||
| - CLI: support specify the browser with `--browser <browser>` option (#405, #407, #397) | ||||
| - CLI: fix the `--os` option not working | ||||
|  | ||||
| ## 2.3.4 - 2024-07-08 | ||||
|  | ||||
| - Support the Internal Host Detection (fix [#377](https://github.com/yuezk/GlobalProtect-openconnect/issues/377)) | ||||
| - CLI: support pass the password from stdin (fix [#381](https://github.com/yuezk/GlobalProtect-openconnect/issues/381)) | ||||
|  | ||||
| ## 2.3.3 - 2024-06-23 | ||||
|  | ||||
| - GUI: add the remark field for the license activation | ||||
| - GUI: check the saved secret key length | ||||
|  | ||||
| ## 2.3.2 - 2024-06-17 | ||||
|  | ||||
| - Fix the CAS callback parsing issue (fix [#372](https://github.com/yuezk/GlobalProtect-openconnect/issues/372)) | ||||
| - CLI: fix the `/tmp/gpauth.html` deletion issue (fix [#366](https://github.com/yuezk/GlobalProtect-openconnect/issues/366)) | ||||
| - GUI: fix the license not working after reboot (fix [#376](https://github.com/yuezk/GlobalProtect-openconnect/issues/376)) | ||||
| - GUI: add the license activation management link | ||||
|  | ||||
| ## 2.3.1 - 2024-05-21 | ||||
|  | ||||
| - Fix the `--sslkey` option not working | ||||
|  | ||||
| ## 2.3.0 - 2024-05-20 | ||||
|  | ||||
| - Support client certificate authentication (fix [#363](https://github.com/yuezk/GlobalProtect-openconnect/issues/363)) | ||||
| - Support `--disable-ipv6`, `--reconnect-timeout` parameters (related: [#364](https://github.com/yuezk/GlobalProtect-openconnect/issues/364)) | ||||
| - Use default labels if label fields are missing in prelogin response (fix [#357](https://github.com/yuezk/GlobalProtect-openconnect/issues/357)) | ||||
|  | ||||
| ## 2.2.1 - 2024-05-07 | ||||
|  | ||||
| - GUI: Restore the default browser auth implementation (fix [#360](https://github.com/yuezk/GlobalProtect-openconnect/issues/360)) | ||||
|  | ||||
| ## 2.2.0 - 2024-04-30 | ||||
|  | ||||
| - CLI: support authentication with external browser (fix [#298](https://github.com/yuezk/GlobalProtect-openconnect/issues/298)) | ||||
| - GUI: support using file-based storage when the system keyring is not available. | ||||
|  | ||||
| ## 2.1.4 - 2024-04-10 | ||||
|  | ||||
| - Support MFA authentication (fix [#343](https://github.com/yuezk/GlobalProtect-openconnect/issues/343)) | ||||
| - Improve the Gateway switcher UI | ||||
|  | ||||
| ## 2.1.3 - 2024-04-07 | ||||
|  | ||||
| - Support CAS authentication (fix [#339](https://github.com/yuezk/GlobalProtect-openconnect/issues/339)) | ||||
| - CLI: Add `--as-gateway` option to connect as gateway directly (fix [#318](https://github.com/yuezk/GlobalProtect-openconnect/issues/318)) | ||||
| - GUI: Support connect the gateway directly (fix [#318](https://github.com/yuezk/GlobalProtect-openconnect/issues/318)) | ||||
| - GUI: Add an option to use symbolic tray icon (fix [#341](https://github.com/yuezk/GlobalProtect-openconnect/issues/341)) | ||||
|  | ||||
| ## 2.1.2 - 2024-03-29 | ||||
|  | ||||
| - Treat portal as gateway when the gateway login is failed (fix #338) | ||||
|  | ||||
| ## 2.1.1 - 2024-03-25 | ||||
|  | ||||
| - Add the `--hip` option to enable HIP report | ||||
| - Fix not working in OpenSuse 15.5 (fix #336, #322) | ||||
| - Treat portal as gateway when the gateway login is failed (fix #338) | ||||
| - Improve the error message (fix #327) | ||||
|  | ||||
| ## 2.1.0 - 2024-02-27 | ||||
|  | ||||
| - Update distribution channel for `gpgui` to complaint with the GPL-3 license. | ||||
| - Add `mtu` option. | ||||
| - Retry auth if failed to obtain the auth cookie | ||||
|  | ||||
| ## 2.0.0 - 2024-02-05 | ||||
|  | ||||
| - Refactor using Tauri | ||||
|   | ||||
| @@ -1,11 +0,0 @@ | ||||
| [package] | ||||
| name = "common" | ||||
| rust-version.workspace = true | ||||
| version.workspace = true | ||||
| authors.workspace = true | ||||
| homepage.workspace = true | ||||
| edition.workspace = true | ||||
| license.workspace = true | ||||
|  | ||||
| [dependencies] | ||||
| is_executable.workspace = true | ||||
| @@ -1,674 +0,0 @@ | ||||
|                     GNU GENERAL PUBLIC LICENSE | ||||
|                        Version 3, 29 June 2007 | ||||
|  | ||||
|  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | ||||
|  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. | ||||
|  | ||||
|     <one line to give the program's name and a brief idea of what it does.> | ||||
|     Copyright (C) <year>  <name of author> | ||||
|  | ||||
|     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 <https://www.gnu.org/licenses/>. | ||||
|  | ||||
| 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: | ||||
|  | ||||
|     <program>  Copyright (C) <year>  <name of author> | ||||
|     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 | ||||
| <https://www.gnu.org/licenses/>. | ||||
|  | ||||
|   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 | ||||
| <https://www.gnu.org/licenses/why-not-lgpl.html>. | ||||
| @@ -1 +0,0 @@ | ||||
| pub mod vpn_utils; | ||||
| @@ -1,54 +0,0 @@ | ||||
| use std::{io, path::Path}; | ||||
|  | ||||
| use is_executable::IsExecutable; | ||||
|  | ||||
| const VPNC_SCRIPT_LOCATIONS: [&str; 6] = [ | ||||
|   "/usr/local/share/vpnc-scripts/vpnc-script", | ||||
|   "/usr/local/sbin/vpnc-script", | ||||
|   "/usr/share/vpnc-scripts/vpnc-script", | ||||
|   "/usr/sbin/vpnc-script", | ||||
|   "/etc/vpnc/vpnc-script", | ||||
|   "/etc/openconnect/vpnc-script", | ||||
| ]; | ||||
|  | ||||
| const CSD_WRAPPER_LOCATIONS: [&str; 3] = [ | ||||
|   #[cfg(target_arch = "x86_64")] | ||||
|   "/usr/lib/x86_64-linux-gnu/openconnect/hipreport.sh", | ||||
|   #[cfg(target_arch = "aarch64")] | ||||
|   "/usr/lib/aarch64-linux-gnu/openconnect/hipreport.sh", | ||||
|   "/usr/lib/openconnect/hipreport.sh", | ||||
|   "/usr/libexec/openconnect/hipreport.sh", | ||||
| ]; | ||||
|  | ||||
| fn find_executable(locations: &[&str]) -> Option<String> { | ||||
|   for location in locations.iter() { | ||||
|     let path = Path::new(location); | ||||
|     if path.is_executable() { | ||||
|       return Some(location.to_string()); | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   None | ||||
| } | ||||
|  | ||||
| pub fn find_vpnc_script() -> Option<String> { | ||||
|   find_executable(&VPNC_SCRIPT_LOCATIONS) | ||||
| } | ||||
|  | ||||
| pub fn find_csd_wrapper() -> Option<String> { | ||||
|   find_executable(&CSD_WRAPPER_LOCATIONS) | ||||
| } | ||||
|  | ||||
| /// If file exists, check if it is executable | ||||
| pub fn check_executable(file: &str) -> Result<(), io::Error> { | ||||
|   let path = Path::new(file); | ||||
|  | ||||
|   if path.exists() && !path.is_executable() { | ||||
|     return Err(io::Error::new( | ||||
|       io::ErrorKind::PermissionDenied, | ||||
|       format!("{} is not executable", file), | ||||
|     )); | ||||
|   } | ||||
|  | ||||
|   Ok(()) | ||||
| } | ||||
| @@ -7,11 +7,8 @@ license = "MIT" | ||||
| [dependencies] | ||||
| anyhow.workspace = true | ||||
| base64.workspace = true | ||||
| dns-lookup.workspace = true | ||||
| log.workspace = true | ||||
| reqwest.workspace = true | ||||
| openssl.workspace = true | ||||
| pem.workspace = true | ||||
| roxmltree.workspace = true | ||||
| serde.workspace = true | ||||
| specta.workspace = true | ||||
| @@ -26,11 +23,11 @@ chacha20poly1305 = { version = "0.10", features = ["std"] } | ||||
| redact-engine.workspace = true | ||||
| url.workspace = true | ||||
| regex.workspace = true | ||||
| dotenvy_macro.workspace = true | ||||
| uzers.workspace = true | ||||
| serde_urlencoded.workspace = true | ||||
| md5.workspace = true | ||||
| sha256.workspace = true | ||||
| which.workspace = true | ||||
|  | ||||
| tauri = { workspace = true, optional = true } | ||||
| clap = { workspace = true, optional = true } | ||||
|   | ||||
| @@ -1,21 +0,0 @@ | ||||
| MIT License | ||||
|  | ||||
| Copyright (c) [2024] [Kevin Yue] | ||||
|  | ||||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||||
| of this software and associated documentation files (the "Software"), to deal | ||||
| in the Software without restriction, including without limitation the rights | ||||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||||
| copies of the Software, and to permit persons to whom the Software is | ||||
| furnished to do so, subject to the following conditions: | ||||
|  | ||||
| The above copyright notice and this permission notice shall be included in all | ||||
| copies or substantial portions of the Software. | ||||
|  | ||||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||||
| SOFTWARE. | ||||
| @@ -1,19 +0,0 @@ | ||||
| use std::path::Path; | ||||
|  | ||||
| fn main() { | ||||
|   let manifest_dir = env!("CARGO_MANIFEST_DIR"); | ||||
|   let workspace_dir = Path::new(manifest_dir).ancestors().nth(2).unwrap(); | ||||
|   let gpgui_dir = workspace_dir.parent().unwrap().join("gpgui"); | ||||
|  | ||||
|   let gp_service_binary = workspace_dir.join("target/debug/gpservice"); | ||||
|   let gp_client_binary = workspace_dir.join("target/debug/gpclient"); | ||||
|   let gp_auth_binary = workspace_dir.join("target/debug/gpauth"); | ||||
|   let gp_gui_helper_binary = workspace_dir.join("target/debug/gpgui-helper"); | ||||
|   let gp_gui_binary = gpgui_dir.join("target/debug/gpgui"); | ||||
|  | ||||
|   println!("cargo:rustc-env=GP_SERVICE_BINARY={}", gp_service_binary.display()); | ||||
|   println!("cargo:rustc-env=GP_CLIENT_BINARY={}", gp_client_binary.display()); | ||||
|   println!("cargo:rustc-env=GP_AUTH_BINARY={}", gp_auth_binary.display()); | ||||
|   println!("cargo:rustc-env=GP_GUI_HELPER_BINARY={}", gp_gui_helper_binary.display()); | ||||
|   println!("cargo:rustc-env=GP_GUI_BINARY={}", gp_gui_binary.display()); | ||||
| } | ||||
| @@ -1,19 +1,13 @@ | ||||
| use std::borrow::{Borrow, Cow}; | ||||
|  | ||||
| use log::{info, warn}; | ||||
| use anyhow::bail; | ||||
| use regex::Regex; | ||||
| use serde::{Deserialize, Serialize}; | ||||
|  | ||||
| use crate::{error::AuthDataParseError, utils::base64::decode_to_string}; | ||||
|  | ||||
| #[derive(Debug, Serialize, Deserialize)] | ||||
| #[serde(rename_all = "camelCase")] | ||||
| pub struct SamlAuthData { | ||||
|   #[serde(alias = "un")] | ||||
|   username: String, | ||||
|   prelogin_cookie: Option<String>, | ||||
|   portal_userauthcookie: Option<String>, | ||||
|   token: Option<String>, | ||||
| } | ||||
|  | ||||
| #[derive(Debug, Serialize, Deserialize)] | ||||
| @@ -38,11 +32,10 @@ impl SamlAuthData { | ||||
|       username, | ||||
|       prelogin_cookie, | ||||
|       portal_userauthcookie, | ||||
|       token: None, | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   pub fn from_html(html: &str) -> anyhow::Result<SamlAuthData, AuthDataParseError> { | ||||
|   pub fn parse_html(html: &str) -> anyhow::Result<SamlAuthData> { | ||||
|     match parse_xml_tag(html, "saml-auth-status") { | ||||
|       Some(saml_status) if saml_status == "1" => { | ||||
|         let username = parse_xml_tag(html, "saml-username"); | ||||
| @@ -50,48 +43,22 @@ impl SamlAuthData { | ||||
|         let portal_userauthcookie = parse_xml_tag(html, "portal-userauthcookie"); | ||||
|  | ||||
|         if SamlAuthData::check(&username, &prelogin_cookie, &portal_userauthcookie) { | ||||
|           Ok(SamlAuthData::new( | ||||
|           return Ok(SamlAuthData::new( | ||||
|             username.unwrap(), | ||||
|             prelogin_cookie, | ||||
|             portal_userauthcookie, | ||||
|           )) | ||||
|         } else { | ||||
|           Err(AuthDataParseError::Invalid) | ||||
|         } | ||||
|       } | ||||
|       Some(_) => Err(AuthDataParseError::Invalid), | ||||
|       None => Err(AuthDataParseError::NotFound), | ||||
|     } | ||||
|           )); | ||||
|         } | ||||
|  | ||||
|   pub fn from_gpcallback(data: &str) -> anyhow::Result<SamlAuthData, AuthDataParseError> { | ||||
|     let auth_data = data.trim_start_matches("globalprotectcallback:"); | ||||
|  | ||||
|     if auth_data.starts_with("cas-as") { | ||||
|       info!("Got CAS auth data from globalprotectcallback"); | ||||
|  | ||||
|       // Decode the auth data and use the original value if decoding fails | ||||
|       let auth_data = urlencoding::decode(auth_data).unwrap_or_else(|err| { | ||||
|         warn!("Failed to decode token auth data: {}", err); | ||||
|         Cow::Borrowed(auth_data) | ||||
|       }); | ||||
|  | ||||
|       let auth_data: SamlAuthData = serde_urlencoded::from_str(auth_data.borrow()).map_err(|e| { | ||||
|         warn!("Failed to parse token auth data: {}", e); | ||||
|         warn!("Auth data: {}", auth_data); | ||||
|         AuthDataParseError::Invalid | ||||
|       })?; | ||||
|  | ||||
|       return Ok(auth_data); | ||||
|         bail!("Found invalid auth data in HTML"); | ||||
|       } | ||||
|       Some(status) => { | ||||
|         bail!("Found invalid SAML status {} in HTML", status); | ||||
|       } | ||||
|       None => { | ||||
|         bail!("No auth data found in HTML"); | ||||
|       } | ||||
|     } | ||||
|  | ||||
|     let auth_data = decode_to_string(auth_data).map_err(|e| { | ||||
|       warn!("Failed to decode SAML auth data: {}", e); | ||||
|       AuthDataParseError::Invalid | ||||
|     })?; | ||||
|     let auth_data = Self::from_html(&auth_data)?; | ||||
|  | ||||
|     Ok(auth_data) | ||||
|   } | ||||
|  | ||||
|   pub fn username(&self) -> &str { | ||||
| @@ -102,10 +69,6 @@ impl SamlAuthData { | ||||
|     self.prelogin_cookie.as_deref() | ||||
|   } | ||||
|  | ||||
|   pub fn token(&self) -> Option<&str> { | ||||
|     self.token.as_deref() | ||||
|   } | ||||
|  | ||||
|   pub fn check( | ||||
|     username: &Option<String>, | ||||
|     prelogin_cookie: &Option<String>, | ||||
| @@ -115,16 +78,7 @@ impl SamlAuthData { | ||||
|     let prelogin_cookie_valid = prelogin_cookie.as_ref().is_some_and(|val| val.len() > 5); | ||||
|     let portal_userauthcookie_valid = portal_userauthcookie.as_ref().is_some_and(|val| val.len() > 5); | ||||
|  | ||||
|     let is_valid = username_valid && (prelogin_cookie_valid || portal_userauthcookie_valid); | ||||
|  | ||||
|     if !is_valid { | ||||
|       warn!( | ||||
|         "Invalid SAML auth data: username: {:?}, prelogin-cookie: {:?}, portal-userauthcookie: {:?}", | ||||
|         username, prelogin_cookie, portal_userauthcookie | ||||
|       ); | ||||
|     } | ||||
|  | ||||
|     is_valid | ||||
|     username_valid && (prelogin_cookie_valid || portal_userauthcookie_valid) | ||||
|   } | ||||
| } | ||||
|  | ||||
| @@ -134,38 +88,3 @@ pub fn parse_xml_tag(html: &str, tag: &str) -> Option<String> { | ||||
|     .and_then(|captures| captures.get(1)) | ||||
|     .map(|m| m.as_str().to_string()) | ||||
| } | ||||
|  | ||||
| #[cfg(test)] | ||||
| mod tests { | ||||
|   use super::*; | ||||
|  | ||||
|   #[test] | ||||
|   fn auth_data_from_gpcallback_cas() { | ||||
|     let auth_data = "globalprotectcallback:cas-as=1&un=xyz@email.com&token=very_long_string"; | ||||
|  | ||||
|     let auth_data = SamlAuthData::from_gpcallback(auth_data).unwrap(); | ||||
|  | ||||
|     assert_eq!(auth_data.username(), "xyz@email.com"); | ||||
|     assert_eq!(auth_data.token(), Some("very_long_string")); | ||||
|   } | ||||
|  | ||||
|   #[test] | ||||
|   fn auth_data_from_gpcallback_cas_urlencoded() { | ||||
|     let auth_data = "globalprotectcallback:cas-as%3D1%26un%3Dxyz%40email.com%26token%3Dvery_long_string"; | ||||
|  | ||||
|     let auth_data = SamlAuthData::from_gpcallback(auth_data).unwrap(); | ||||
|  | ||||
|     assert_eq!(auth_data.username(), "xyz@email.com"); | ||||
|     assert_eq!(auth_data.token(), Some("very_long_string")); | ||||
|   } | ||||
|  | ||||
|   #[test] | ||||
|   fn auth_data_from_gpcallback_non_cas() { | ||||
|     let auth_data = "PGh0bWw+PCEtLSA8c2FtbC1hdXRoLXN0YXR1cz4xPC9zYW1sLWF1dGgtc3RhdHVzPjxwcmVsb2dpbi1jb29raWU+cHJlbG9naW4tY29va2llPC9wcmVsb2dpbi1jb29raWU+PHNhbWwtdXNlcm5hbWU+eHl6QGVtYWlsLmNvbTwvc2FtbC11c2VybmFtZT48c2FtbC1zbG8+bm88L3NhbWwtc2xvPjxzYW1sLVNlc3Npb25Ob3RPbk9yQWZ0ZXI+PC9zYW1sLVNlc3Npb25Ob3RPbk9yQWZ0ZXI+IC0tPjwvaHRtbD4="; | ||||
|  | ||||
|     let auth_data = SamlAuthData::from_gpcallback(auth_data).unwrap(); | ||||
|  | ||||
|     assert_eq!(auth_data.username(), "xyz@email.com"); | ||||
|     assert_eq!(auth_data.prelogin_cookie(), Some("prelogin-cookie")); | ||||
|   } | ||||
| } | ||||
|   | ||||
| @@ -1,10 +1,9 @@ | ||||
| use std::collections::HashMap; | ||||
|  | ||||
| use anyhow::bail; | ||||
| use serde::{Deserialize, Serialize}; | ||||
| use specta::Type; | ||||
|  | ||||
| use crate::auth::{SamlAuthData, SamlAuthResult}; | ||||
| use crate::{auth::SamlAuthData, utils::base64::decode_to_string}; | ||||
|  | ||||
| #[derive(Debug, Serialize, Deserialize, Type, Clone)] | ||||
| #[serde(rename_all = "camelCase")] | ||||
| @@ -38,18 +37,16 @@ impl From<&CachedCredential> for PasswordCredential { | ||||
|  | ||||
| #[derive(Debug, Serialize, Deserialize, Type, Clone)] | ||||
| #[serde(rename_all = "camelCase")] | ||||
| pub struct PreloginCredential { | ||||
| pub struct PreloginCookieCredential { | ||||
|   username: String, | ||||
|   prelogin_cookie: Option<String>, | ||||
|   token: Option<String>, | ||||
|   prelogin_cookie: String, | ||||
| } | ||||
|  | ||||
| impl PreloginCredential { | ||||
|   pub fn new(username: &str, prelogin_cookie: Option<&str>, token: Option<&str>) -> Self { | ||||
| impl PreloginCookieCredential { | ||||
|   pub fn new(username: &str, prelogin_cookie: &str) -> Self { | ||||
|     Self { | ||||
|       username: username.to_string(), | ||||
|       prelogin_cookie: prelogin_cookie.map(|s| s.to_string()), | ||||
|       token: token.map(|s| s.to_string()), | ||||
|       prelogin_cookie: prelogin_cookie.to_string(), | ||||
|     } | ||||
|   } | ||||
|  | ||||
| @@ -57,22 +54,22 @@ impl PreloginCredential { | ||||
|     &self.username | ||||
|   } | ||||
|  | ||||
|   pub fn prelogin_cookie(&self) -> Option<&str> { | ||||
|     self.prelogin_cookie.as_deref() | ||||
|   } | ||||
|  | ||||
|   pub fn token(&self) -> Option<&str> { | ||||
|     self.token.as_deref() | ||||
|   pub fn prelogin_cookie(&self) -> &str { | ||||
|     &self.prelogin_cookie | ||||
|   } | ||||
| } | ||||
|  | ||||
| impl From<SamlAuthData> for PreloginCredential { | ||||
|   fn from(value: SamlAuthData) -> Self { | ||||
|     let username = value.username().to_string(); | ||||
|     let prelogin_cookie = value.prelogin_cookie(); | ||||
|     let token = value.token(); | ||||
| impl TryFrom<SamlAuthData> for PreloginCookieCredential { | ||||
|   type Error = anyhow::Error; | ||||
|  | ||||
|     Self::new(&username, prelogin_cookie, token) | ||||
|   fn try_from(value: SamlAuthData) -> Result<Self, Self::Error> { | ||||
|     let username = value.username().to_string(); | ||||
|     let prelogin_cookie = value | ||||
|       .prelogin_cookie() | ||||
|       .ok_or_else(|| anyhow::anyhow!("Missing prelogin cookie"))? | ||||
|       .to_string(); | ||||
|  | ||||
|     Ok(Self::new(&username, &prelogin_cookie)) | ||||
|   } | ||||
| } | ||||
|  | ||||
| @@ -157,30 +154,34 @@ impl From<PasswordCredential> for CachedCredential { | ||||
|     ) | ||||
|   } | ||||
| } | ||||
|  | ||||
| #[derive(Debug, Serialize, Deserialize, Type, Clone)] | ||||
| #[serde(tag = "type", rename_all = "camelCase")] | ||||
| pub enum Credential { | ||||
|   Password(PasswordCredential), | ||||
|   Prelogin(PreloginCredential), | ||||
|   PreloginCookie(PreloginCookieCredential), | ||||
|   AuthCookie(AuthCookieCredential), | ||||
|   Cached(CachedCredential), | ||||
|   CachedCredential(CachedCredential), | ||||
| } | ||||
|  | ||||
| impl Credential { | ||||
|   /// Create a credential from a globalprotectcallback:<base64 encoded string>, | ||||
|   /// or globalprotectcallback:cas-as=1&un=user@xyz.com&token=very_long_string | ||||
|   pub fn from_gpcallback(auth_data: &str) -> anyhow::Result<Self> { | ||||
|     let auth_data = SamlAuthData::from_gpcallback(auth_data)?; | ||||
|   /// Create a credential from a globalprotectcallback:<base64 encoded string> | ||||
|   pub fn parse_gpcallback(auth_data: &str) -> anyhow::Result<Self> { | ||||
|     // Remove the surrounding quotes | ||||
|     let auth_data = auth_data.trim_matches('"'); | ||||
|     let auth_data = auth_data.trim_start_matches("globalprotectcallback:"); | ||||
|     let auth_data = decode_to_string(auth_data)?; | ||||
|     let auth_data = SamlAuthData::parse_html(&auth_data)?; | ||||
|  | ||||
|     Ok(Self::from(auth_data)) | ||||
|     Self::try_from(auth_data) | ||||
|   } | ||||
|  | ||||
|   pub fn username(&self) -> &str { | ||||
|     match self { | ||||
|       Credential::Password(cred) => cred.username(), | ||||
|       Credential::Prelogin(cred) => cred.username(), | ||||
|       Credential::PreloginCookie(cred) => cred.username(), | ||||
|       Credential::AuthCookie(cred) => cred.username(), | ||||
|       Credential::Cached(cred) => cred.username(), | ||||
|       Credential::CachedCredential(cred) => cred.username(), | ||||
|     } | ||||
|   } | ||||
|  | ||||
| @@ -188,22 +189,20 @@ impl Credential { | ||||
|     let mut params = HashMap::new(); | ||||
|     params.insert("user", self.username()); | ||||
|  | ||||
|     let (passwd, prelogin_cookie, portal_userauthcookie, portal_prelogonuserauthcookie, token) = match self { | ||||
|       Credential::Password(cred) => (Some(cred.password()), None, None, None, None), | ||||
|       Credential::Prelogin(cred) => (None, cred.prelogin_cookie(), None, None, cred.token()), | ||||
|     let (passwd, prelogin_cookie, portal_userauthcookie, portal_prelogonuserauthcookie) = match self { | ||||
|       Credential::Password(cred) => (Some(cred.password()), None, None, None), | ||||
|       Credential::PreloginCookie(cred) => (None, Some(cred.prelogin_cookie()), None, None), | ||||
|       Credential::AuthCookie(cred) => ( | ||||
|         None, | ||||
|         None, | ||||
|         Some(cred.user_auth_cookie()), | ||||
|         Some(cred.prelogon_user_auth_cookie()), | ||||
|         None, | ||||
|       ), | ||||
|       Credential::Cached(cred) => ( | ||||
|       Credential::CachedCredential(cred) => ( | ||||
|         cred.password(), | ||||
|         None, | ||||
|         Some(cred.auth_cookie.user_auth_cookie()), | ||||
|         Some(cred.auth_cookie.prelogon_user_auth_cookie()), | ||||
|         None, | ||||
|       ), | ||||
|     }; | ||||
|  | ||||
| @@ -215,30 +214,17 @@ impl Credential { | ||||
|       portal_prelogonuserauthcookie.unwrap_or_default(), | ||||
|     ); | ||||
|  | ||||
|     if let Some(token) = token { | ||||
|       params.insert("token", token); | ||||
|     } | ||||
|  | ||||
|     params | ||||
|   } | ||||
| } | ||||
|  | ||||
| impl From<SamlAuthData> for Credential { | ||||
|   fn from(value: SamlAuthData) -> Self { | ||||
|     let cred = PreloginCredential::from(value); | ||||
|  | ||||
|     Self::Prelogin(cred) | ||||
|   } | ||||
| } | ||||
|  | ||||
| impl TryFrom<SamlAuthResult> for Credential { | ||||
| impl TryFrom<SamlAuthData> for Credential { | ||||
|   type Error = anyhow::Error; | ||||
|  | ||||
|   fn try_from(value: SamlAuthResult) -> anyhow::Result<Self> { | ||||
|     match value { | ||||
|       SamlAuthResult::Success(auth_data) => Ok(Self::from(auth_data)), | ||||
|       SamlAuthResult::Failure(err) => bail!(err), | ||||
|     } | ||||
|   fn try_from(value: SamlAuthData) -> Result<Self, Self::Error> { | ||||
|     let prelogin_cookie = PreloginCookieCredential::try_from(value)?; | ||||
|  | ||||
|     Ok(Self::PreloginCookie(prelogin_cookie)) | ||||
|   } | ||||
| } | ||||
|  | ||||
| @@ -256,6 +242,6 @@ impl From<&AuthCookieCredential> for Credential { | ||||
|  | ||||
| impl From<&CachedCredential> for Credential { | ||||
|   fn from(value: &CachedCredential) -> Self { | ||||
|     Self::Cached(value.clone()) | ||||
|     Self::CachedCredential(value.clone()) | ||||
|   } | ||||
| } | ||||
|   | ||||
| @@ -1,19 +0,0 @@ | ||||
| use thiserror::Error; | ||||
|  | ||||
| #[derive(Error, Debug)] | ||||
| pub enum PortalError { | ||||
|   #[error("Prelogin error: {0}")] | ||||
|   PreloginError(String), | ||||
|   #[error("Portal config error: {0}")] | ||||
|   ConfigError(String), | ||||
|   #[error("Network error: {0}")] | ||||
|   NetworkError(String), | ||||
| } | ||||
|  | ||||
| #[derive(Error, Debug)] | ||||
| pub enum AuthDataParseError { | ||||
|   #[error("No auth data found")] | ||||
|   NotFound, | ||||
|   #[error("Invalid auth data")] | ||||
|   Invalid, | ||||
| } | ||||
| @@ -156,7 +156,11 @@ fn build_csd_token(cookie: &str) -> anyhow::Result<String> { | ||||
| } | ||||
|  | ||||
| pub async fn hip_report(gateway: &str, cookie: &str, csd_wrapper: &str, gp_params: &GpParams) -> anyhow::Result<()> { | ||||
|   let client = Client::try_from(gp_params)?; | ||||
|   let client = Client::builder() | ||||
|     .danger_accept_invalid_certs(gp_params.ignore_tls_errors()) | ||||
|     .user_agent(gp_params.user_agent()) | ||||
|     .build()?; | ||||
|  | ||||
|   let md5 = build_csd_token(cookie)?; | ||||
|  | ||||
|   info!("Submit HIP report md5: {}", md5); | ||||
|   | ||||
| @@ -1,27 +1,24 @@ | ||||
| use anyhow::bail; | ||||
| use log::{info, warn}; | ||||
| use log::info; | ||||
| use reqwest::Client; | ||||
| use roxmltree::Document; | ||||
| use urlencoding::encode; | ||||
|  | ||||
| use crate::{ | ||||
|   credential::Credential, | ||||
|   error::PortalError, | ||||
|   gp_params::GpParams, | ||||
|   utils::{normalize_server, parse_gp_response, remove_url_scheme}, | ||||
|   utils::{normalize_server, remove_url_scheme}, | ||||
| }; | ||||
|  | ||||
| pub enum GatewayLogin { | ||||
|   Cookie(String), | ||||
|   Mfa(String, String), | ||||
| } | ||||
|  | ||||
| pub async fn gateway_login(gateway: &str, cred: &Credential, gp_params: &GpParams) -> anyhow::Result<GatewayLogin> { | ||||
| pub async fn gateway_login(gateway: &str, cred: &Credential, gp_params: &GpParams) -> anyhow::Result<String> { | ||||
|   let url = normalize_server(gateway)?; | ||||
|   let gateway = remove_url_scheme(&url); | ||||
|  | ||||
|   let login_url = format!("{}/ssl-vpn/login.esp", url); | ||||
|   let client = Client::try_from(gp_params)?; | ||||
|   let client = Client::builder() | ||||
|     .danger_accept_invalid_certs(gp_params.ignore_tls_errors()) | ||||
|     .user_agent(gp_params.user_agent()) | ||||
|     .build()?; | ||||
|  | ||||
|   let mut params = cred.to_params(); | ||||
|   let extra_params = gp_params.to_params(); | ||||
| @@ -29,34 +26,19 @@ pub async fn gateway_login(gateway: &str, cred: &Credential, gp_params: &GpParam | ||||
|   params.extend(extra_params); | ||||
|   params.insert("server", &gateway); | ||||
|  | ||||
|   info!("Perform gateway login, user_agent: {}", gp_params.user_agent()); | ||||
|   info!("Gateway login, user_agent: {}", gp_params.user_agent()); | ||||
|  | ||||
|   let res = client | ||||
|     .post(&login_url) | ||||
|     .form(¶ms) | ||||
|     .send() | ||||
|     .await | ||||
|     .map_err(|e| anyhow::anyhow!(PortalError::NetworkError(e.to_string())))?; | ||||
|   let res = client.post(&login_url).form(¶ms).send().await?; | ||||
|   let status = res.status(); | ||||
|  | ||||
|   let res = parse_gp_response(res).await.map_err(|err| { | ||||
|     warn!("{err}"); | ||||
|     anyhow::anyhow!("Gateway login error: {}", err.reason) | ||||
|   })?; | ||||
|  | ||||
|   // MFA detected | ||||
|   if res.contains("Challenge") { | ||||
|     let Some((message, input_str)) = parse_mfa(&res) else { | ||||
|       bail!("Failed to parse MFA challenge: {res}"); | ||||
|     }; | ||||
|  | ||||
|     return Ok(GatewayLogin::Mfa(message, input_str)); | ||||
|   if status.is_client_error() || status.is_server_error() { | ||||
|     bail!("Gateway login error: {}", status) | ||||
|   } | ||||
|  | ||||
|   let doc = Document::parse(&res)?; | ||||
|   let res_xml = res.text().await?; | ||||
|   let doc = Document::parse(&res_xml)?; | ||||
|  | ||||
|   let cookie = build_gateway_token(&doc, gp_params.computer())?; | ||||
|  | ||||
|   Ok(GatewayLogin::Cookie(cookie)) | ||||
|   build_gateway_token(&doc, gp_params.computer()) | ||||
| } | ||||
|  | ||||
| fn build_gateway_token(doc: &Document, computer: &str) -> anyhow::Result<String> { | ||||
| @@ -90,33 +72,3 @@ fn read_args<'a>(args: &'a [String], index: usize, key: &'a str) -> anyhow::Resu | ||||
|     .ok_or_else(|| anyhow::anyhow!("Failed to read {key} from args")) | ||||
|     .map(|s| (key, s.as_ref())) | ||||
| } | ||||
|  | ||||
| fn parse_mfa(res: &str) -> Option<(String, String)> { | ||||
|   let message = res | ||||
|     .lines() | ||||
|     .find(|l| l.contains("respMsg")) | ||||
|     .and_then(|l| l.split('"').nth(1).map(|s| s.to_string()))?; | ||||
|  | ||||
|   let input_str = res | ||||
|     .lines() | ||||
|     .find(|l| l.contains("inputStr")) | ||||
|     .and_then(|l| l.split('"').nth(1).map(|s| s.to_string()))?; | ||||
|  | ||||
|   Some((message, input_str)) | ||||
| } | ||||
|  | ||||
| #[cfg(test)] | ||||
| mod tests { | ||||
|   use super::*; | ||||
|  | ||||
|   #[test] | ||||
|   fn mfa() { | ||||
|     let res = r#"var respStatus = "Challenge"; | ||||
| var respMsg = "MFA message"; | ||||
| thisForm.inputStr.value = "5ef64e83000119ed";"#; | ||||
|  | ||||
|     let (message, input_str) = parse_mfa(res).unwrap(); | ||||
|     assert_eq!(message, "MFA message"); | ||||
|     assert_eq!(input_str, "5ef64e83000119ed"); | ||||
|   } | ||||
| } | ||||
|   | ||||
| @@ -1,47 +1,44 @@ | ||||
| use log::info; | ||||
| use roxmltree::Node; | ||||
|  | ||||
| use crate::utils::xml::NodeExt; | ||||
| use roxmltree::Document; | ||||
|  | ||||
| use super::{Gateway, PriorityRule}; | ||||
|  | ||||
| pub(crate) fn parse_gateways(node: &Node, prefer_internal: bool) -> Option<Vec<Gateway>> { | ||||
|   let node_gateways = node.find_descendant("gateways")?; | ||||
|   let internal_gateway_list = if prefer_internal { | ||||
|     info!("Try to parse the internal gateways..."); | ||||
|     node_gateways.find_descendant("internal").and_then(|n| n.find_child("list")) | ||||
|   } else { | ||||
|     None | ||||
|   }; | ||||
| pub(crate) fn parse_gateways(doc: &Document) -> Option<Vec<Gateway>> { | ||||
|   let node_gateways = doc.descendants().find(|n| n.has_tag_name("gateways"))?; | ||||
|   let list_gateway = node_gateways.descendants().find(|n| n.has_tag_name("list"))?; | ||||
|  | ||||
|   let gateway_list = internal_gateway_list.or_else(|| { | ||||
|     info!("Try to parse the external gateways..."); | ||||
|     node_gateways.find_descendant("external").and_then(|n| n.find_child("list")) | ||||
|   })?; | ||||
|  | ||||
|   let gateways = gateway_list | ||||
|   let gateways = list_gateway | ||||
|     .children() | ||||
|     .filter_map(|gateway_item| { | ||||
|       if !gateway_item.has_tag_name("entry") { | ||||
|         return None; | ||||
|       } | ||||
|       let address = gateway_item.attribute("name").unwrap_or_default().to_string(); | ||||
|       let name = gateway_item.child_text("description").unwrap_or_default().to_string(); | ||||
|       let address = gateway_item.attribute("name").unwrap_or("").to_string(); | ||||
|       let name = gateway_item | ||||
|         .children() | ||||
|         .find(|n| n.has_tag_name("description")) | ||||
|         .and_then(|n| n.text()) | ||||
|         .unwrap_or("") | ||||
|         .to_string(); | ||||
|       let priority = gateway_item | ||||
|         .child_text("priority") | ||||
|         .children() | ||||
|         .find(|n| n.has_tag_name("priority")) | ||||
|         .and_then(|n| n.text()) | ||||
|         .and_then(|s| s.parse().ok()) | ||||
|         .unwrap_or(u32::MAX); | ||||
|       let priority_rules = gateway_item | ||||
|         .find_child("priority-rule") | ||||
|         .children() | ||||
|         .find(|n| n.has_tag_name("priority-rule")) | ||||
|         .map(|n| { | ||||
|           n.children() | ||||
|             .filter_map(|n| { | ||||
|               if !n.has_tag_name("entry") { | ||||
|                 return None; | ||||
|               } | ||||
|               let name = n.attribute("name").unwrap_or_default().to_string(); | ||||
|               let name = n.attribute("name").unwrap_or("").to_string(); | ||||
|               let priority: u32 = n | ||||
|                 .child_text("priority") | ||||
|                 .children() | ||||
|                 .find(|n| n.has_tag_name("priority")) | ||||
|                 .and_then(|n| n.text()) | ||||
|                 .and_then(|s| s.parse().ok()) | ||||
|                 .unwrap_or(u32::MAX); | ||||
|  | ||||
|   | ||||
| @@ -1,11 +1,9 @@ | ||||
| use std::collections::HashMap; | ||||
|  | ||||
| use log::info; | ||||
| use reqwest::Client; | ||||
| use serde::{Deserialize, Serialize}; | ||||
| use specta::Type; | ||||
|  | ||||
| use crate::{utils::request::create_identity, GP_USER_AGENT}; | ||||
| use crate::GP_USER_AGENT; | ||||
|  | ||||
| #[derive(Debug, Serialize, Deserialize, Clone, Type, Default)] | ||||
| pub enum ClientOs { | ||||
| @@ -44,7 +42,7 @@ impl ClientOs { | ||||
|   } | ||||
| } | ||||
|  | ||||
| #[derive(Debug, Serialize, Deserialize, Type, Default, Clone)] | ||||
| #[derive(Debug, Serialize, Deserialize, Type, Default)] | ||||
| pub struct GpParams { | ||||
|   is_gateway: bool, | ||||
|   user_agent: String, | ||||
| @@ -53,12 +51,7 @@ pub struct GpParams { | ||||
|   client_version: Option<String>, | ||||
|   computer: String, | ||||
|   ignore_tls_errors: bool, | ||||
|   certificate: Option<String>, | ||||
|   sslkey: Option<String>, | ||||
|   key_password: Option<String>, | ||||
|   // Used for MFA | ||||
|   input_str: Option<String>, | ||||
|   otp: Option<String>, | ||||
|   prefer_default_browser: bool, | ||||
| } | ||||
|  | ||||
| impl GpParams { | ||||
| @@ -86,6 +79,10 @@ impl GpParams { | ||||
|     self.ignore_tls_errors | ||||
|   } | ||||
|  | ||||
|   pub fn prefer_default_browser(&self) -> bool { | ||||
|     self.prefer_default_browser | ||||
|   } | ||||
|  | ||||
|   pub fn client_os(&self) -> &str { | ||||
|     self.client_os.as_str() | ||||
|   } | ||||
| @@ -98,14 +95,6 @@ impl GpParams { | ||||
|     self.client_version.as_deref() | ||||
|   } | ||||
|  | ||||
|   pub fn set_input_str(&mut self, input_str: &str) { | ||||
|     self.input_str = Some(input_str.to_string()); | ||||
|   } | ||||
|  | ||||
|   pub fn set_otp(&mut self, otp: &str) { | ||||
|     self.otp = Some(otp.to_string()); | ||||
|   } | ||||
|  | ||||
|   pub(crate) fn to_params(&self) -> HashMap<&str, &str> { | ||||
|     let mut params: HashMap<&str, &str> = HashMap::new(); | ||||
|     let client_os = self.client_os.as_str(); | ||||
| @@ -116,16 +105,11 @@ impl GpParams { | ||||
|     params.insert("ok", "Login"); | ||||
|     params.insert("direct", "yes"); | ||||
|     params.insert("ipv6-support", "yes"); | ||||
|     params.insert("inputStr", ""); | ||||
|     params.insert("clientVer", "4100"); | ||||
|     params.insert("clientos", client_os); | ||||
|     params.insert("computer", &self.computer); | ||||
|  | ||||
|     // MFA | ||||
|     params.insert("inputStr", self.input_str.as_deref().unwrap_or_default()); | ||||
|     if let Some(otp) = &self.otp { | ||||
|       params.insert("passwd", otp); | ||||
|     } | ||||
|  | ||||
|     if let Some(os_version) = &self.os_version { | ||||
|       params.insert("os-version", os_version); | ||||
|     } | ||||
| @@ -147,26 +131,20 @@ pub struct GpParamsBuilder { | ||||
|   client_version: Option<String>, | ||||
|   computer: String, | ||||
|   ignore_tls_errors: bool, | ||||
|   certificate: Option<String>, | ||||
|   sslkey: Option<String>, | ||||
|   key_password: Option<String>, | ||||
|   prefer_default_browser: bool, | ||||
| } | ||||
|  | ||||
| impl GpParamsBuilder { | ||||
|   pub fn new() -> Self { | ||||
|     let computer = whoami::fallible::hostname().unwrap_or_else(|_| String::from("localhost")); | ||||
|  | ||||
|     Self { | ||||
|       is_gateway: false, | ||||
|       user_agent: GP_USER_AGENT.to_string(), | ||||
|       client_os: ClientOs::Linux, | ||||
|       os_version: Default::default(), | ||||
|       client_version: Default::default(), | ||||
|       computer, | ||||
|       computer: whoami::hostname(), | ||||
|       ignore_tls_errors: false, | ||||
|       certificate: Default::default(), | ||||
|       sslkey: Default::default(), | ||||
|       key_password: Default::default(), | ||||
|       prefer_default_browser: false, | ||||
|     } | ||||
|   } | ||||
|  | ||||
| @@ -205,18 +183,8 @@ impl GpParamsBuilder { | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn certificate<T: Into<Option<String>>>(&mut self, certificate: T) -> &mut Self { | ||||
|     self.certificate = certificate.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn sslkey<T: Into<Option<String>>>(&mut self, sslkey: T) -> &mut Self { | ||||
|     self.sslkey = sslkey.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn key_password<T: Into<Option<String>>>(&mut self, password: T) -> &mut Self { | ||||
|     self.key_password = password.into(); | ||||
|   pub fn prefer_default_browser(&mut self, prefer_default_browser: bool) -> &mut Self { | ||||
|     self.prefer_default_browser = prefer_default_browser; | ||||
|     self | ||||
|   } | ||||
|  | ||||
| @@ -229,11 +197,7 @@ impl GpParamsBuilder { | ||||
|       client_version: self.client_version.clone(), | ||||
|       computer: self.computer.clone(), | ||||
|       ignore_tls_errors: self.ignore_tls_errors, | ||||
|       certificate: self.certificate.clone(), | ||||
|       sslkey: self.sslkey.clone(), | ||||
|       key_password: self.key_password.clone(), | ||||
|       input_str: Default::default(), | ||||
|       otp: Default::default(), | ||||
|       prefer_default_browser: self.prefer_default_browser, | ||||
|     } | ||||
|   } | ||||
| } | ||||
| @@ -243,22 +207,3 @@ impl Default for GpParamsBuilder { | ||||
|     Self::new() | ||||
|   } | ||||
| } | ||||
|  | ||||
| impl TryFrom<&GpParams> for Client { | ||||
|   type Error = anyhow::Error; | ||||
|  | ||||
|   fn try_from(value: &GpParams) -> Result<Self, Self::Error> { | ||||
|     let mut builder = Client::builder() | ||||
|       .danger_accept_invalid_certs(value.ignore_tls_errors) | ||||
|       .user_agent(&value.user_agent); | ||||
|  | ||||
|     if let Some(cert) = value.certificate.as_deref() { | ||||
|       info!("Using client certificate authentication..."); | ||||
|       let identity = create_identity(cert, value.sslkey.as_deref(), value.key_password.as_deref())?; | ||||
|       builder = builder.identity(identity); | ||||
|     } | ||||
|  | ||||
|     let client = builder.build()?; | ||||
|     Ok(client) | ||||
|   } | ||||
| } | ||||
|   | ||||
| @@ -1,6 +1,5 @@ | ||||
| pub mod auth; | ||||
| pub mod credential; | ||||
| pub mod error; | ||||
| pub mod gateway; | ||||
| pub mod gp_params; | ||||
| pub mod portal; | ||||
| @@ -29,12 +28,12 @@ pub const GP_GUI_HELPER_BINARY: &str = "/usr/bin/gpgui-helper"; | ||||
| pub(crate) const GP_AUTH_BINARY: &str = "/usr/bin/gpauth"; | ||||
|  | ||||
| #[cfg(debug_assertions)] | ||||
| pub const GP_CLIENT_BINARY: &str = env!("GP_CLIENT_BINARY"); | ||||
| pub const GP_CLIENT_BINARY: &str = dotenvy_macro::dotenv!("GP_CLIENT_BINARY"); | ||||
| #[cfg(debug_assertions)] | ||||
| pub const GP_SERVICE_BINARY: &str = env!("GP_SERVICE_BINARY"); | ||||
| pub const GP_SERVICE_BINARY: &str = dotenvy_macro::dotenv!("GP_SERVICE_BINARY"); | ||||
| #[cfg(debug_assertions)] | ||||
| pub const GP_GUI_BINARY: &str = env!("GP_GUI_BINARY"); | ||||
| pub const GP_GUI_BINARY: &str = dotenvy_macro::dotenv!("GP_GUI_BINARY"); | ||||
| #[cfg(debug_assertions)] | ||||
| pub const GP_GUI_HELPER_BINARY: &str = env!("GP_GUI_HELPER_BINARY"); | ||||
| pub const GP_GUI_HELPER_BINARY: &str = dotenvy_macro::dotenv!("GP_GUI_HELPER_BINARY"); | ||||
| #[cfg(debug_assertions)] | ||||
| pub(crate) const GP_AUTH_BINARY: &str = env!("GP_AUTH_BINARY"); | ||||
| pub(crate) const GP_AUTH_BINARY: &str = dotenvy_macro::dotenv!("GP_AUTH_BINARY"); | ||||
|   | ||||
| @@ -1,17 +1,16 @@ | ||||
| use anyhow::bail; | ||||
| use dns_lookup::lookup_addr; | ||||
| use log::{debug, info, warn}; | ||||
| use log::info; | ||||
| use reqwest::{Client, StatusCode}; | ||||
| use roxmltree::{Document, Node}; | ||||
| use roxmltree::Document; | ||||
| use serde::Serialize; | ||||
| use specta::Type; | ||||
|  | ||||
| use crate::{ | ||||
|   credential::{AuthCookieCredential, Credential}, | ||||
|   error::PortalError, | ||||
|   gateway::{parse_gateways, Gateway}, | ||||
|   gp_params::GpParams, | ||||
|   utils::{normalize_server, parse_gp_response, remove_url_scheme, xml::NodeExt}, | ||||
|   portal::PortalError, | ||||
|   utils::{normalize_server, remove_url_scheme, xml}, | ||||
| }; | ||||
|  | ||||
| #[derive(Debug, Serialize, Type)] | ||||
| @@ -22,13 +21,6 @@ pub struct PortalConfig { | ||||
|   config_cred: Credential, | ||||
|   gateways: Vec<Gateway>, | ||||
|   config_digest: Option<String>, | ||||
|   /** | ||||
|    * Variants: | ||||
|    * - None: Internal host detection is not supported | ||||
|    * - Some(false): Internal host detection is supported but the user is not connected to the internal network | ||||
|    * - Some(true): Internal host detection is supported and the user is connected to the internal network | ||||
|    */ | ||||
|   internal_host_detection: Option<bool>, | ||||
| } | ||||
|  | ||||
| impl PortalConfig { | ||||
| @@ -48,10 +40,6 @@ impl PortalConfig { | ||||
|     &self.config_cred | ||||
|   } | ||||
|  | ||||
|   pub fn internal_host_detection(&self) -> Option<bool> { | ||||
|     self.internal_host_detection | ||||
|   } | ||||
|  | ||||
|   /// In-place sort the gateways by region | ||||
|   pub fn sort_gateways(&mut self, region: &str) { | ||||
|     let preferred_gateway = self.find_preferred_gateway(region); | ||||
| @@ -100,7 +88,10 @@ pub async fn retrieve_config(portal: &str, cred: &Credential, gp_params: &GpPara | ||||
|   let server = remove_url_scheme(&portal); | ||||
|  | ||||
|   let url = format!("{}/global-protect/getconfig.esp", portal); | ||||
|   let client = Client::try_from(gp_params)?; | ||||
|   let client = Client::builder() | ||||
|     .danger_accept_invalid_certs(gp_params.ignore_tls_errors()) | ||||
|     .user_agent(gp_params.user_agent()) | ||||
|     .build()?; | ||||
|  | ||||
|   let mut params = cred.to_params(); | ||||
|   let extra_params = gp_params.to_params(); | ||||
| @@ -109,52 +100,35 @@ pub async fn retrieve_config(portal: &str, cred: &Credential, gp_params: &GpPara | ||||
|   params.insert("server", &server); | ||||
|   params.insert("host", &server); | ||||
|  | ||||
|   info!("Retrieve the portal config, user_agent: {}", gp_params.user_agent()); | ||||
|   info!("Portal config, user_agent: {}", gp_params.user_agent()); | ||||
|  | ||||
|   let res = client | ||||
|     .post(&url) | ||||
|     .form(¶ms) | ||||
|     .send() | ||||
|     .await | ||||
|     .map_err(|e| anyhow::anyhow!(PortalError::NetworkError(e.to_string())))?; | ||||
|   let res = client.post(&url).form(¶ms).send().await?; | ||||
|   let status = res.status(); | ||||
|  | ||||
|   let res_xml = parse_gp_response(res).await.or_else(|err| { | ||||
|     if err.status == StatusCode::NOT_FOUND { | ||||
|       bail!(PortalError::ConfigError("Config endpoint not found".to_string())); | ||||
|   if status == StatusCode::NOT_FOUND { | ||||
|     bail!(PortalError::ConfigError("Config endpoint not found".to_string())) | ||||
|   } | ||||
|  | ||||
|     if err.is_status_error() { | ||||
|       warn!("{err}"); | ||||
|       bail!("Portal config error: {}", err.reason); | ||||
|   if status.is_client_error() || status.is_server_error() { | ||||
|     bail!("Portal config error: {}", status) | ||||
|   } | ||||
|  | ||||
|     Err(anyhow::anyhow!(PortalError::ConfigError(err.reason))) | ||||
|   })?; | ||||
|   let res_xml = res.text().await.map_err(|e| PortalError::ConfigError(e.to_string()))?; | ||||
|  | ||||
|   if res_xml.is_empty() { | ||||
|     bail!(PortalError::ConfigError("Empty portal config response".to_string())) | ||||
|   } | ||||
|  | ||||
|   debug!("Portal config response: {}", res_xml); | ||||
|  | ||||
|   let doc = Document::parse(&res_xml).map_err(|e| PortalError::ConfigError(e.to_string()))?; | ||||
|   let root = doc.root(); | ||||
|  | ||||
|   let mut ihd_enabled = false; | ||||
|   let mut prefer_internal = false; | ||||
|   if let Some(ihd_node) = root.find_descendant("internal-host-detection") { | ||||
|     ihd_enabled = true; | ||||
|     prefer_internal = internal_host_detect(&ihd_node) | ||||
|   } | ||||
|  | ||||
|   let mut gateways = parse_gateways(&root, prefer_internal).unwrap_or_else(|| { | ||||
|   let mut gateways = parse_gateways(&doc).unwrap_or_else(|| { | ||||
|     info!("No gateways found in portal config"); | ||||
|     vec![] | ||||
|   }); | ||||
|  | ||||
|   let user_auth_cookie = root.descendant_text("portal-userauthcookie").unwrap_or_default(); | ||||
|   let prelogon_user_auth_cookie = root.descendant_text("portal-prelogonuserauthcookie").unwrap_or_default(); | ||||
|   let config_digest = root.descendant_text("config-digest"); | ||||
|   let user_auth_cookie = xml::get_child_text(&doc, "portal-userauthcookie").unwrap_or_default(); | ||||
|   let prelogon_user_auth_cookie = xml::get_child_text(&doc, "portal-prelogonuserauthcookie").unwrap_or_default(); | ||||
|   let config_digest = xml::get_child_text(&doc, "config-digest"); | ||||
|  | ||||
|   if gateways.is_empty() { | ||||
|     gateways.push(Gateway::new(server.to_string(), server.to_string())); | ||||
| @@ -162,44 +136,9 @@ pub async fn retrieve_config(portal: &str, cred: &Credential, gp_params: &GpPara | ||||
|  | ||||
|   Ok(PortalConfig { | ||||
|     portal: server.to_string(), | ||||
|     auth_cookie: AuthCookieCredential::new(cred.username(), user_auth_cookie, prelogon_user_auth_cookie), | ||||
|     auth_cookie: AuthCookieCredential::new(cred.username(), &user_auth_cookie, &prelogon_user_auth_cookie), | ||||
|     config_cred: cred.clone(), | ||||
|     gateways, | ||||
|     config_digest: config_digest.map(|s| s.to_string()), | ||||
|     internal_host_detection: if ihd_enabled { Some(prefer_internal) } else { None }, | ||||
|     config_digest, | ||||
|   }) | ||||
| } | ||||
|  | ||||
| // Perform DNS lookup and compare the result with the expected hostname | ||||
| fn internal_host_detect(node: &Node) -> bool { | ||||
|   let ip_info = [ | ||||
|     (node.child_text("ip-address"), node.child_text("host")), | ||||
|     (node.child_text("ipv6-address"), node.child_text("ipv6-host")), | ||||
|   ]; | ||||
|  | ||||
|   info!("Found internal-host-detection, performing DNS lookup"); | ||||
|  | ||||
|   for (ip_address, host) in ip_info.iter() { | ||||
|     if let (Some(ip_address), Some(host)) = (ip_address.as_deref(), host.as_deref()) { | ||||
|       if !ip_address.is_empty() && !host.is_empty() { | ||||
|         match ip_address.parse::<std::net::IpAddr>() { | ||||
|           Ok(ip) => match lookup_addr(&ip) { | ||||
|             Ok(host_lookup) if host_lookup.to_lowercase() == host.to_lowercase() => { | ||||
|               return true; | ||||
|             } | ||||
|             Ok(host_lookup) => { | ||||
|               info!( | ||||
|                 "rDNS lookup for {} returned {}, expected {}", | ||||
|                 ip_address, host_lookup, host | ||||
|               ); | ||||
|             } | ||||
|             Err(err) => warn!("rDNS lookup failed for {}: {}", ip_address, err), | ||||
|           }, | ||||
|           Err(err) => warn!("Invalid IP address {}: {}", ip_address, err), | ||||
|         } | ||||
|       } | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   false | ||||
| } | ||||
|   | ||||
| @@ -3,3 +3,13 @@ mod prelogin; | ||||
|  | ||||
| pub use config::*; | ||||
| pub use prelogin::*; | ||||
|  | ||||
| use thiserror::Error; | ||||
|  | ||||
| #[derive(Error, Debug)] | ||||
| pub enum PortalError { | ||||
|   #[error("Portal prelogin error: {0}")] | ||||
|   PreloginError(String), | ||||
|   #[error("Portal config error: {0}")] | ||||
|   ConfigError(String), | ||||
| } | ||||
|   | ||||
| @@ -1,14 +1,14 @@ | ||||
| use anyhow::{anyhow, bail}; | ||||
| use log::{info, warn}; | ||||
| use anyhow::bail; | ||||
| use log::info; | ||||
| use reqwest::{Client, StatusCode}; | ||||
| use roxmltree::Document; | ||||
| use serde::Serialize; | ||||
| use specta::Type; | ||||
|  | ||||
| use crate::{ | ||||
|   error::PortalError, | ||||
|   gp_params::GpParams, | ||||
|   utils::{base64, normalize_server, parse_gp_response, xml::NodeExt}, | ||||
|   portal::PortalError, | ||||
|   utils::{base64, normalize_server, xml}, | ||||
| }; | ||||
|  | ||||
| const REQUIRED_PARAMS: [&str; 8] = [ | ||||
| @@ -98,81 +98,69 @@ impl Prelogin { | ||||
|  | ||||
| pub async fn prelogin(portal: &str, gp_params: &GpParams) -> anyhow::Result<Prelogin> { | ||||
|   let user_agent = gp_params.user_agent(); | ||||
|   let is_gateway = gp_params.is_gateway(); | ||||
|   let prelogin_type = if is_gateway { "Gateway" } else { "Portal" }; | ||||
|  | ||||
|   info!("{} prelogin with user_agent: {}", prelogin_type, user_agent); | ||||
|   info!("Prelogin with user_agent: {}", user_agent); | ||||
|  | ||||
|   let portal = normalize_server(portal)?; | ||||
|   let is_gateway = gp_params.is_gateway(); | ||||
|   let path = if is_gateway { "ssl-vpn" } else { "global-protect" }; | ||||
|   let prelogin_url = format!("{portal}/{}/prelogin.esp", path); | ||||
|   let mut params = gp_params.to_params(); | ||||
|  | ||||
|   params.insert("tmp", "tmp"); | ||||
|   if gp_params.prefer_default_browser() { | ||||
|     params.insert("default-browser", "1"); | ||||
|   params.insert("cas-support", "yes"); | ||||
|   } | ||||
|  | ||||
|   params.retain(|k, _| REQUIRED_PARAMS.iter().any(|required_param| required_param == k)); | ||||
|  | ||||
|   let client = Client::try_from(gp_params)?; | ||||
|   let client = Client::builder() | ||||
|     .danger_accept_invalid_certs(gp_params.ignore_tls_errors()) | ||||
|     .user_agent(user_agent) | ||||
|     .build()?; | ||||
|  | ||||
|   info!("Perform prelogin, user_agent: {}", gp_params.user_agent()); | ||||
|   let res = client.post(&prelogin_url).form(¶ms).send().await?; | ||||
|   let status = res.status(); | ||||
|  | ||||
|   let res = client | ||||
|     .post(&prelogin_url) | ||||
|     .form(¶ms) | ||||
|     .send() | ||||
|     .await | ||||
|     .map_err(|e| anyhow::anyhow!(PortalError::NetworkError(e.to_string())))?; | ||||
|  | ||||
|   let res_xml = parse_gp_response(res).await.or_else(|err| { | ||||
|     if err.status == StatusCode::NOT_FOUND { | ||||
|   if status == StatusCode::NOT_FOUND { | ||||
|     bail!(PortalError::PreloginError("Prelogin endpoint not found".to_string())) | ||||
|   } | ||||
|  | ||||
|     if err.is_status_error() { | ||||
|       warn!("{err}"); | ||||
|       bail!("Prelogin error: {}", err.reason) | ||||
|   if status.is_client_error() || status.is_server_error() { | ||||
|     bail!("Prelogin error: {}", status) | ||||
|   } | ||||
|  | ||||
|     Err(anyhow!(PortalError::PreloginError(err.reason))) | ||||
|   })?; | ||||
|   let res_xml = res | ||||
|     .text() | ||||
|     .await | ||||
|     .map_err(|e| PortalError::PreloginError(e.to_string()))?; | ||||
|  | ||||
|   let prelogin = parse_res_xml(&res_xml, is_gateway).map_err(|err| { | ||||
|     warn!("Parse response error, response: {}", res_xml); | ||||
|     PortalError::PreloginError(err.to_string()) | ||||
|   })?; | ||||
|   let prelogin = parse_res_xml(res_xml, is_gateway).map_err(|e| PortalError::PreloginError(e.to_string()))?; | ||||
|  | ||||
|   Ok(prelogin) | ||||
| } | ||||
|  | ||||
| fn parse_res_xml(res_xml: &str, is_gateway: bool) -> anyhow::Result<Prelogin> { | ||||
|   let doc = Document::parse(res_xml)?; | ||||
|   let root = doc.root(); | ||||
| fn parse_res_xml(res_xml: String, is_gateway: bool) -> anyhow::Result<Prelogin> { | ||||
|   let doc = Document::parse(&res_xml)?; | ||||
|  | ||||
|   let status = root | ||||
|     .descendant_text("status") | ||||
|   let status = xml::get_child_text(&doc, "status") | ||||
|     .ok_or_else(|| anyhow::anyhow!("Prelogin response does not contain status element"))?; | ||||
|   // Check the status of the prelogin response | ||||
|   if status.to_uppercase() != "SUCCESS" { | ||||
|     let msg = root.descendant_text("msg").unwrap_or("Unknown error"); | ||||
|     bail!("{}", msg) | ||||
|     let msg = xml::get_child_text(&doc, "msg").unwrap_or(String::from("Unknown error")); | ||||
|     bail!("Prelogin failed: {}", msg) | ||||
|   } | ||||
|  | ||||
|   let region = root | ||||
|     .descendant_text("region") | ||||
|     .unwrap_or_else(|| { | ||||
|   let region = xml::get_child_text(&doc, "region").unwrap_or_else(|| { | ||||
|     info!("Prelogin response does not contain region element"); | ||||
|       "Unknown" | ||||
|     }) | ||||
|     .to_string(); | ||||
|     String::from("Unknown") | ||||
|   }); | ||||
|  | ||||
|   let saml_method = root.descendant_text("saml-auth-method"); | ||||
|   let saml_request = root.descendant_text("saml-request"); | ||||
|   let saml_default_browser = root.descendant_text("saml-default-browser"); | ||||
|   let saml_method = xml::get_child_text(&doc, "saml-auth-method"); | ||||
|   let saml_request = xml::get_child_text(&doc, "saml-request"); | ||||
|   let saml_default_browser = xml::get_child_text(&doc, "saml-default-browser"); | ||||
|   // Check if the prelogin response is SAML | ||||
|   if saml_method.is_some() && saml_request.is_some() { | ||||
|     let saml_request = base64::decode_to_string(saml_request.unwrap())?; | ||||
|     let saml_request = base64::decode_to_string(&saml_request.unwrap())?; | ||||
|     let support_default_browser = saml_default_browser.map(|s| s.to_lowercase() == "yes").unwrap_or(false); | ||||
|  | ||||
|     let saml_prelogin = SamlPrelogin { | ||||
| @@ -185,32 +173,22 @@ fn parse_res_xml(res_xml: &str, is_gateway: bool) -> anyhow::Result<Prelogin> { | ||||
|     return Ok(Prelogin::Saml(saml_prelogin)); | ||||
|   } | ||||
|  | ||||
|   let label_username = root | ||||
|     .descendant_text("username-label") | ||||
|     .unwrap_or_else(|| { | ||||
|       info!("Username label has no value, using default"); | ||||
|       "Username" | ||||
|     }) | ||||
|     .to_string(); | ||||
|   let label_password = root | ||||
|     .descendant_text("password-label") | ||||
|     .unwrap_or_else(|| { | ||||
|       info!("Password label has no value, using default"); | ||||
|       "Password" | ||||
|     }) | ||||
|     .to_string(); | ||||
|  | ||||
|   let auth_message = root | ||||
|     .descendant_text("authentication-message") | ||||
|     .unwrap_or("Please enter the login credentials") | ||||
|     .to_string(); | ||||
|   let label_username = xml::get_child_text(&doc, "username-label"); | ||||
|   let label_password = xml::get_child_text(&doc, "password-label"); | ||||
|   // Check if the prelogin response is standard login | ||||
|   if label_username.is_some() && label_password.is_some() { | ||||
|     let auth_message = | ||||
|       xml::get_child_text(&doc, "authentication-message").unwrap_or(String::from("Please enter the login credentials")); | ||||
|     let standard_prelogin = StandardPrelogin { | ||||
|       region, | ||||
|       is_gateway, | ||||
|       auth_message, | ||||
|     label_username, | ||||
|     label_password, | ||||
|       label_username: label_username.unwrap(), | ||||
|       label_password: label_password.unwrap(), | ||||
|     }; | ||||
|  | ||||
|   Ok(Prelogin::Standard(standard_prelogin)) | ||||
|     return Ok(Prelogin::Standard(standard_prelogin)); | ||||
|   } | ||||
|  | ||||
|   bail!("Invalid prelogin response"); | ||||
| } | ||||
|   | ||||
| @@ -18,8 +18,6 @@ pub struct SamlAuthLauncher<'a> { | ||||
|   fix_openssl: bool, | ||||
|   ignore_tls_errors: bool, | ||||
|   clean: bool, | ||||
|   default_browser: bool, | ||||
|   browser: Option<&'a str>, | ||||
| } | ||||
|  | ||||
| impl<'a> SamlAuthLauncher<'a> { | ||||
| @@ -35,8 +33,6 @@ impl<'a> SamlAuthLauncher<'a> { | ||||
|       fix_openssl: false, | ||||
|       ignore_tls_errors: false, | ||||
|       clean: false, | ||||
|       default_browser: false, | ||||
|       browser: None, | ||||
|     } | ||||
|   } | ||||
|  | ||||
| @@ -85,16 +81,6 @@ impl<'a> SamlAuthLauncher<'a> { | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn default_browser(mut self, default_browser: bool) -> Self { | ||||
|     self.default_browser = default_browser; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn browser(mut self, browser: Option<&'a str>) -> Self { | ||||
|     self.browser = browser; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   /// Launch the authenticator binary as the current user or SUDO_USER if available. | ||||
|   pub async fn launch(self) -> anyhow::Result<Credential> { | ||||
|     let mut auth_cmd = Command::new(GP_AUTH_BINARY); | ||||
| @@ -136,14 +122,6 @@ impl<'a> SamlAuthLauncher<'a> { | ||||
|       auth_cmd.arg("--clean"); | ||||
|     } | ||||
|  | ||||
|     if self.default_browser { | ||||
|       auth_cmd.arg("--default-browser"); | ||||
|     } | ||||
|  | ||||
|     if let Some(browser) = self.browser { | ||||
|       auth_cmd.arg("--browser").arg(browser); | ||||
|     } | ||||
|  | ||||
|     let mut non_root_cmd = auth_cmd.into_non_root()?; | ||||
|     let output = non_root_cmd | ||||
|       .kill_on_drop(true) | ||||
| @@ -156,6 +134,9 @@ impl<'a> SamlAuthLauncher<'a> { | ||||
|       bail!("Failed to parse auth data") | ||||
|     }; | ||||
|  | ||||
|     Credential::try_from(auth_result) | ||||
|     match auth_result { | ||||
|       SamlAuthResult::Success(auth_data) => Credential::try_from(auth_data), | ||||
|       SamlAuthResult::Failure(msg) => bail!(msg), | ||||
|     } | ||||
|   } | ||||
| } | ||||
|   | ||||
| @@ -1,72 +1,34 @@ | ||||
| use std::{borrow::Cow, env::temp_dir, fs, io::Write, os::unix::fs::PermissionsExt}; | ||||
|  | ||||
| use anyhow::bail; | ||||
| use log::{info, warn}; | ||||
| use std::{env::temp_dir, io::Write}; | ||||
|  | ||||
| pub struct BrowserAuthenticator<'a> { | ||||
|   auth_request: &'a str, | ||||
|   browser: Option<&'a str>, | ||||
| } | ||||
|  | ||||
| impl BrowserAuthenticator<'_> { | ||||
|   pub fn new(auth_request: &str) -> BrowserAuthenticator { | ||||
|     BrowserAuthenticator { | ||||
|       auth_request, | ||||
|       browser: None, | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   pub fn new_with_browser<'a>(auth_request: &'a str, browser: &'a str) -> BrowserAuthenticator<'a> { | ||||
|     BrowserAuthenticator { | ||||
|       auth_request, | ||||
|       browser: if browser == "default" { None } else { Some(browser) }, | ||||
|     } | ||||
|     BrowserAuthenticator { auth_request } | ||||
|   } | ||||
|  | ||||
|   pub fn authenticate(&self) -> anyhow::Result<()> { | ||||
|     let path = if self.auth_request.starts_with("http") { | ||||
|       Cow::Borrowed(self.auth_request) | ||||
|     if self.auth_request.starts_with("http") { | ||||
|       open::that_detached(self.auth_request)?; | ||||
|     } else { | ||||
|       let html_file = temp_dir().join("gpauth.html"); | ||||
|       let mut file = std::fs::File::create(&html_file)?; | ||||
|  | ||||
|       // Remove the file and error if permission denied | ||||
|       if let Err(err) = fs::remove_file(&html_file) { | ||||
|         if err.kind() != std::io::ErrorKind::NotFound { | ||||
|           warn!("Failed to remove the temporary file: {}", err); | ||||
|           bail!("Please remove the file manually: {:?}", html_file); | ||||
|         } | ||||
|       } | ||||
|  | ||||
|       let mut file = fs::File::create(&html_file)?; | ||||
|  | ||||
|       file.set_permissions(fs::Permissions::from_mode(0o600))?; | ||||
|       file.write_all(self.auth_request.as_bytes())?; | ||||
|  | ||||
|       Cow::Owned(html_file.to_string_lossy().to_string()) | ||||
|     }; | ||||
|  | ||||
|     if let Some(browser) = self.browser { | ||||
|       let app = find_browser_path(browser); | ||||
|  | ||||
|       info!("Launching browser: {}", app); | ||||
|       open::with_detached(path.as_ref(), app)?; | ||||
|     } else { | ||||
|       info!("Launching the default browser..."); | ||||
|       open::that_detached(path.as_ref())?; | ||||
|       open::that_detached(html_file)?; | ||||
|     } | ||||
|  | ||||
|     Ok(()) | ||||
|   } | ||||
| } | ||||
|  | ||||
| fn find_browser_path(browser: &str) -> String { | ||||
|   if browser == "chrome" { | ||||
|     which::which("google-chrome-stable") | ||||
|       .or_else(|_| which::which("google-chrome")) | ||||
|       .or_else(|_| which::which("chromium")) | ||||
|       .map(|path| path.to_string_lossy().to_string()) | ||||
|       .unwrap_or_else(|_| browser.to_string()) | ||||
|   } else { | ||||
|     browser.into() | ||||
| impl Drop for BrowserAuthenticator<'_> { | ||||
|   fn drop(&mut self) { | ||||
|     // Cleanup the temporary file | ||||
|     let html_file = temp_dir().join("gpauth.html"); | ||||
|     let _ = std::fs::remove_file(html_file); | ||||
|   } | ||||
| } | ||||
|   | ||||
| @@ -32,16 +32,10 @@ pub struct ConnectArgs { | ||||
|   cookie: String, | ||||
|   vpnc_script: Option<String>, | ||||
|   user_agent: Option<String>, | ||||
|   os: Option<ClientOs>, | ||||
|   certificate: Option<String>, | ||||
|   sslkey: Option<String>, | ||||
|   key_password: Option<String>, | ||||
|   csd_uid: u32, | ||||
|   csd_wrapper: Option<String>, | ||||
|   reconnect_timeout: u32, | ||||
|   mtu: u32, | ||||
|   disable_ipv6: bool, | ||||
|   no_dtls: bool, | ||||
|   os: Option<ClientOs>, | ||||
| } | ||||
|  | ||||
| impl ConnectArgs { | ||||
| @@ -51,15 +45,9 @@ impl ConnectArgs { | ||||
|       vpnc_script: None, | ||||
|       user_agent: None, | ||||
|       os: None, | ||||
|       certificate: None, | ||||
|       sslkey: None, | ||||
|       key_password: None, | ||||
|       csd_uid: 0, | ||||
|       csd_wrapper: None, | ||||
|       reconnect_timeout: 300, | ||||
|       mtu: 0, | ||||
|       disable_ipv6: false, | ||||
|       no_dtls: false, | ||||
|     } | ||||
|   } | ||||
|  | ||||
| @@ -79,18 +67,6 @@ impl ConnectArgs { | ||||
|     self.os.as_ref().map(|os| os.to_openconnect_os().to_string()) | ||||
|   } | ||||
|  | ||||
|   pub fn certificate(&self) -> Option<String> { | ||||
|     self.certificate.clone() | ||||
|   } | ||||
|  | ||||
|   pub fn sslkey(&self) -> Option<String> { | ||||
|     self.sslkey.clone() | ||||
|   } | ||||
|  | ||||
|   pub fn key_password(&self) -> Option<String> { | ||||
|     self.key_password.clone() | ||||
|   } | ||||
|  | ||||
|   pub fn csd_uid(&self) -> u32 { | ||||
|     self.csd_uid | ||||
|   } | ||||
| @@ -99,21 +75,9 @@ impl ConnectArgs { | ||||
|     self.csd_wrapper.clone() | ||||
|   } | ||||
|  | ||||
|   pub fn reconnect_timeout(&self) -> u32 { | ||||
|     self.reconnect_timeout | ||||
|   } | ||||
|  | ||||
|   pub fn mtu(&self) -> u32 { | ||||
|     self.mtu | ||||
|   } | ||||
|  | ||||
|   pub fn disable_ipv6(&self) -> bool { | ||||
|     self.disable_ipv6 | ||||
|   } | ||||
|  | ||||
|   pub fn no_dtls(&self) -> bool { | ||||
|     self.no_dtls | ||||
|   } | ||||
| } | ||||
|  | ||||
| #[derive(Debug, Deserialize, Serialize, Type)] | ||||
| @@ -145,6 +109,11 @@ impl ConnectRequest { | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn with_mtu(mut self, mtu: u32) -> Self { | ||||
|     self.args.mtu = mtu; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn with_user_agent<T: Into<Option<String>>>(mut self, user_agent: T) -> Self { | ||||
|     self.args.user_agent = user_agent.into(); | ||||
|     self | ||||
| @@ -155,41 +124,6 @@ impl ConnectRequest { | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn with_certificate<T: Into<Option<String>>>(mut self, certificate: T) -> Self { | ||||
|     self.args.certificate = certificate.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn with_sslkey<T: Into<Option<String>>>(mut self, sslkey: T) -> Self { | ||||
|     self.args.sslkey = sslkey.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn with_key_password<T: Into<Option<String>>>(mut self, key_password: T) -> Self { | ||||
|     self.args.key_password = key_password.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn with_reconnect_timeout(mut self, reconnect_timeout: u32) -> Self { | ||||
|     self.args.reconnect_timeout = reconnect_timeout; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn with_mtu(mut self, mtu: u32) -> Self { | ||||
|     self.args.mtu = mtu; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn with_disable_ipv6(mut self, disable_ipv6: bool) -> Self { | ||||
|     self.args.disable_ipv6 = disable_ipv6; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn with_no_dtls(mut self, no_dtls: bool) -> Self { | ||||
|     self.args.no_dtls = no_dtls; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn gateway(&self) -> &Gateway { | ||||
|     self.info.gateway() | ||||
|   } | ||||
|   | ||||
| @@ -1,3 +1,5 @@ | ||||
| use reqwest::Url; | ||||
|  | ||||
| pub(crate) mod xml; | ||||
|  | ||||
| pub mod base64; | ||||
| @@ -8,18 +10,13 @@ pub mod env_file; | ||||
| pub mod lock_file; | ||||
| pub mod openssl; | ||||
| pub mod redact; | ||||
| pub mod request; | ||||
| #[cfg(feature = "tauri")] | ||||
| pub mod window; | ||||
|  | ||||
| mod shutdown_signal; | ||||
|  | ||||
| use log::warn; | ||||
| pub use shutdown_signal::shutdown_signal; | ||||
|  | ||||
| use reqwest::{Response, StatusCode, Url}; | ||||
| use thiserror::Error; | ||||
|  | ||||
| /// Normalize the server URL to the format `https://<host>:<port>` | ||||
| pub fn normalize_server(server: &str) -> anyhow::Result<String> { | ||||
|   let server = if server.starts_with("https://") || server.starts_with("http://") { | ||||
| @@ -44,52 +41,3 @@ pub fn normalize_server(server: &str) -> anyhow::Result<String> { | ||||
| pub fn remove_url_scheme(s: &str) -> String { | ||||
|   s.replace("http://", "").replace("https://", "") | ||||
| } | ||||
|  | ||||
| #[derive(Error, Debug)] | ||||
| #[error("GP response error: reason={reason}, status={status}, body={body}")] | ||||
| pub(crate) struct GpError { | ||||
|   pub status: StatusCode, | ||||
|   pub reason: String, | ||||
|   body: String, | ||||
| } | ||||
|  | ||||
| impl GpError { | ||||
|   pub fn is_status_error(&self) -> bool { | ||||
|     self.status.is_client_error() || self.status.is_server_error() | ||||
|   } | ||||
| } | ||||
|  | ||||
| pub(crate) async fn parse_gp_response(res: Response) -> anyhow::Result<String, GpError> { | ||||
|   let status = res.status(); | ||||
|  | ||||
|   if status.is_client_error() || status.is_server_error() { | ||||
|     let (reason, body) = parse_gp_error(res).await; | ||||
|  | ||||
|     return Err(GpError { status, reason, body }); | ||||
|   } | ||||
|  | ||||
|   res.text().await.map_err(|err| { | ||||
|     warn!("Failed to read response: {}", err); | ||||
|  | ||||
|     GpError { | ||||
|       status, | ||||
|       reason: "failed to read response".to_string(), | ||||
|       body: "<failed to read response>".to_string(), | ||||
|     } | ||||
|   }) | ||||
| } | ||||
|  | ||||
| async fn parse_gp_error(res: Response) -> (String, String) { | ||||
|   let reason = res | ||||
|     .headers() | ||||
|     .get("x-private-pan-globalprotect") | ||||
|     .map_or_else(|| "<none>", |v| v.to_str().unwrap_or("<invalid header>")) | ||||
|     .to_string(); | ||||
|  | ||||
|   let res = res.text().await.map_or_else( | ||||
|     |_| "<failed to read response>".to_string(), | ||||
|     |v| if v.is_empty() { "<empty>".to_string() } else { v }, | ||||
|   ); | ||||
|  | ||||
|   (reason, res) | ||||
| } | ||||
|   | ||||
| @@ -1,140 +0,0 @@ | ||||
| use std::{borrow::Cow, fs}; | ||||
|  | ||||
| use anyhow::bail; | ||||
| use log::warn; | ||||
| use openssl::pkey::PKey; | ||||
| use pem::parse_many; | ||||
| use reqwest::Identity; | ||||
|  | ||||
| #[derive(Debug, thiserror::Error)] | ||||
| pub enum RequestIdentityError { | ||||
|   #[error("Failed to find the private key")] | ||||
|   NoKey, | ||||
|   #[error("No passphrase provided")] | ||||
|   NoPassphrase(&'static str), | ||||
|   #[error("Failed to decrypt private key")] | ||||
|   DecryptError(&'static str), | ||||
| } | ||||
|  | ||||
| /// Create an identity object from a certificate and key | ||||
| /// The file is expected to be the PKCS#8 PEM or PKCS#12 format | ||||
| /// When using a PKCS#12 file, the key is NOT required, but a passphrase is required | ||||
| pub fn create_identity(cert: &str, key: Option<&str>, passphrase: Option<&str>) -> anyhow::Result<Identity> { | ||||
|   if cert.ends_with(".p12") || cert.ends_with(".pfx") { | ||||
|     create_identity_from_pkcs12(cert, passphrase) | ||||
|   } else { | ||||
|     create_identity_from_pem(cert, key, passphrase) | ||||
|   } | ||||
| } | ||||
|  | ||||
| fn create_identity_from_pem(cert: &str, key: Option<&str>, passphrase: Option<&str>) -> anyhow::Result<Identity> { | ||||
|   let cert_pem = fs::read(cert).map_err(|err| anyhow::anyhow!("Failed to read certificate file: {}", err))?; | ||||
|  | ||||
|   // Use the certificate as the key if no key is provided | ||||
|   let key_pem_file = match key { | ||||
|     Some(key) => Cow::Owned(fs::read(key).map_err(|err| anyhow::anyhow!("Failed to read key file: {}", err))?), | ||||
|     None => Cow::Borrowed(&cert_pem), | ||||
|   }; | ||||
|  | ||||
|   // Find the private key in the pem file | ||||
|   let key_pem = parse_many(key_pem_file.as_ref())? | ||||
|     .into_iter() | ||||
|     .find(|pem| pem.tag().ends_with("PRIVATE KEY")) | ||||
|     .ok_or(RequestIdentityError::NoKey)?; | ||||
|  | ||||
|   // The key pem could be encrypted, so we need to decrypt it | ||||
|   let decrypted_key_pem = if key_pem.tag().ends_with("ENCRYPTED PRIVATE KEY") { | ||||
|     let passphrase = passphrase.ok_or_else(|| { | ||||
|       warn!("Key is encrypted but no passphrase provided"); | ||||
|       RequestIdentityError::NoPassphrase("PEM") | ||||
|     })?; | ||||
|     let pem_content = pem::encode(&key_pem); | ||||
|     let key = PKey::private_key_from_pem_passphrase(pem_content.as_bytes(), passphrase.as_bytes()).map_err(|err| { | ||||
|       warn!("Failed to decrypt key: {}", err); | ||||
|       RequestIdentityError::DecryptError("PEM") | ||||
|     })?; | ||||
|  | ||||
|     key.private_key_to_pem_pkcs8()? | ||||
|   } else { | ||||
|     pem::encode(&key_pem).into() | ||||
|   }; | ||||
|  | ||||
|   let identity = Identity::from_pkcs8_pem(&cert_pem, &decrypted_key_pem)?; | ||||
|   Ok(identity) | ||||
| } | ||||
|  | ||||
| fn create_identity_from_pkcs12(pkcs12: &str, passphrase: Option<&str>) -> anyhow::Result<Identity> { | ||||
|   let pkcs12 = fs::read(pkcs12)?; | ||||
|  | ||||
|   let Some(passphrase) = passphrase else { | ||||
|     bail!(RequestIdentityError::NoPassphrase("PKCS#12")); | ||||
|   }; | ||||
|  | ||||
|   let identity = Identity::from_pkcs12_der(&pkcs12, passphrase)?; | ||||
|   Ok(identity) | ||||
| } | ||||
|  | ||||
| #[cfg(test)] | ||||
| mod tests { | ||||
|   use super::*; | ||||
|  | ||||
|   #[test] | ||||
|   fn create_identity_from_pem_requires_passphrase() { | ||||
|     let cert = "tests/files/badssl.com-client.pem"; | ||||
|     let identity = create_identity_from_pem(cert, None, None); | ||||
|  | ||||
|     assert!(identity.is_err()); | ||||
|     assert!(identity.unwrap_err().to_string().contains("No passphrase provided")); | ||||
|   } | ||||
|  | ||||
|   #[test] | ||||
|   fn create_identity_from_pem_with_passphrase() { | ||||
|     let cert = "tests/files/badssl.com-client.pem"; | ||||
|     let passphrase = "badssl.com"; | ||||
|  | ||||
|     let identity = create_identity_from_pem(cert, None, Some(passphrase)); | ||||
|  | ||||
|     assert!(identity.is_ok()); | ||||
|   } | ||||
|  | ||||
|   #[test] | ||||
|   fn create_identity_from_pem_unencrypted_key() { | ||||
|     let cert = "tests/files/badssl.com-client-unencrypted.pem"; | ||||
|     let identity = create_identity_from_pem(cert, None, None); | ||||
|     println!("{:?}", identity); | ||||
|  | ||||
|     assert!(identity.is_ok()); | ||||
|   } | ||||
|  | ||||
|   #[test] | ||||
|   fn create_identity_from_pem_cert_and_encrypted_key() { | ||||
|     let cert = "tests/files/badssl.com-client.pem"; | ||||
|     let key = "tests/files/badssl.com-client.pem"; | ||||
|     let passphrase = "badssl.com"; | ||||
|  | ||||
|     let identity = create_identity_from_pem(cert, Some(key), Some(passphrase)); | ||||
|  | ||||
|     assert!(identity.is_ok()); | ||||
|   } | ||||
|  | ||||
|   #[test] | ||||
|   fn create_identity_from_pem_cert_and_encrypted_key_no_passphrase() { | ||||
|     let cert = "tests/files/badssl.com-client.pem"; | ||||
|     let key = "tests/files/badssl.com-client.pem"; | ||||
|  | ||||
|     let identity = create_identity_from_pem(cert, Some(key), None); | ||||
|  | ||||
|     assert!(identity.is_err()); | ||||
|     assert!(identity.unwrap_err().to_string().contains("No passphrase provided")); | ||||
|   } | ||||
|  | ||||
|   #[test] | ||||
|   fn create_identity_from_pem_cert_and_unencrypted_key() { | ||||
|     let cert = "tests/files/badssl.com-client.pem"; | ||||
|     let key = "tests/files/badssl.com-client-unencrypted.pem"; | ||||
|  | ||||
|     let identity = create_identity_from_pem(cert, Some(key), None); | ||||
|  | ||||
|     assert!(identity.is_ok()); | ||||
|   } | ||||
| } | ||||
| @@ -1,7 +1,7 @@ | ||||
| use std::{process::ExitStatus, time::Duration}; | ||||
|  | ||||
| use anyhow::bail; | ||||
| use log::info; | ||||
| use log::{info, warn}; | ||||
| use tauri::Window; | ||||
| use tokio::process::Command; | ||||
|  | ||||
| @@ -33,7 +33,7 @@ pub fn raise_window(win: &Window) -> anyhow::Result<()> { | ||||
|     let title = win.title()?; | ||||
|     tokio::spawn(async move { | ||||
|       if let Err(err) = wmctrl_raise_window(&title).await { | ||||
|         info!("Window not raised: {}", err); | ||||
|         warn!("Failed to raise window: {}", err); | ||||
|       } | ||||
|     }); | ||||
|   } | ||||
|   | ||||
| @@ -1,27 +1,6 @@ | ||||
| use roxmltree::Node; | ||||
| use roxmltree::Document; | ||||
|  | ||||
| pub(crate) trait NodeExt<'a> { | ||||
|   fn find_descendant(&self, name: &str) -> Option<Node<'a, 'a>>; | ||||
|   fn descendant_text(&self, name: &str) -> Option<&'a str>; | ||||
|  | ||||
|   fn find_child(&self, name: &str) -> Option<Node<'a, 'a>>; | ||||
|   fn child_text(&self, name: &str) -> Option<&'a str>; | ||||
| } | ||||
|  | ||||
| impl<'a> NodeExt<'a> for Node<'a, 'a> { | ||||
|   fn find_descendant(&self, name: &str) -> Option<Node<'a, 'a>> { | ||||
|     self.descendants().find(|n| n.has_tag_name(name)) | ||||
|   } | ||||
|  | ||||
|   fn descendant_text(&self, name: &str) -> Option<&'a str> { | ||||
|     self.find_descendant(name).and_then(|node| node.text()) | ||||
|   } | ||||
|  | ||||
|   fn find_child(&self, name: &str) -> Option<Node<'a, 'a>> { | ||||
|     self.children().find(|n| n.has_tag_name(name)) | ||||
|   } | ||||
|  | ||||
|   fn child_text(&self, name: &str) -> Option<&'a str> { | ||||
|     self.find_child(name).and_then(|node| node.text()) | ||||
|   } | ||||
| pub(crate) fn get_child_text(doc: &Document, name: &str) -> Option<String> { | ||||
|   let node = doc.descendants().find(|n| n.has_tag_name(name))?; | ||||
|   node.text().map(|s| s.to_string()) | ||||
| } | ||||
|   | ||||
| @@ -1,62 +0,0 @@ | ||||
| Bag Attributes | ||||
|     localKeyID: AE DC 75 2E 97 28 71 D8 1E 9A 7F 1E 5A AA F4 2E D3 6D 2C 8B | ||||
| subject=/C=US/ST=California/L=San Francisco/O=BadSSL/CN=BadSSL Client Certificate | ||||
| issuer=/C=US/ST=California/L=San Francisco/O=BadSSL/CN=BadSSL Client Root Certificate Authority | ||||
| -----BEGIN CERTIFICATE----- | ||||
| MIIEnTCCAoWgAwIBAgIJAPfJjkenM2ooMA0GCSqGSIb3DQEBCwUAMH4xCzAJBgNV | ||||
| BAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNp | ||||
| c2NvMQ8wDQYDVQQKDAZCYWRTU0wxMTAvBgNVBAMMKEJhZFNTTCBDbGllbnQgUm9v | ||||
| dCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMjQwNTE3MTc1OTMyWhcNMjYwNTE3 | ||||
| MTc1OTMyWjBvMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQG | ||||
| A1UEBwwNU2FuIEZyYW5jaXNjbzEPMA0GA1UECgwGQmFkU1NMMSIwIAYDVQQDDBlC | ||||
| YWRTU0wgQ2xpZW50IENlcnRpZmljYXRlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A | ||||
| MIIBCgKCAQEAxzdfEeseTs/rukjly6MSLHM+Rh0enA3Ai4Mj2sdl31x3SbPoen08 | ||||
| utVhjPmlxIUdkiMG4+ffe7N+JtDLG75CaxZp9CxytX7kywooRBJsRnQhmQPca8MR | ||||
| WAJBIz+w/L+3AFkTIqWBfyT+1VO8TVKPkEpGdLDovZOmzZAASi9/sj+j6gM7AaCi | ||||
| DeZTf2ES66abA5pOp60Q6OEdwg/vCUJfarhKDpi9tj3P6qToy9Y4DiBUhOct4MG8 | ||||
| w5XwmKAC+Vfm8tb7tMiUoU0yvKKOcL6YXBXxB2kPcOYxYNobXavfVBEdwSrjQ7i/ | ||||
| s3o6hkGQlm9F7JPEuVgbl/Jdwa64OYIqjQIDAQABoy0wKzAJBgNVHRMEAjAAMBEG | ||||
| CWCGSAGG+EIBAQQEAwIHgDALBgNVHQ8EBAMCBeAwDQYJKoZIhvcNAQELBQADggIB | ||||
| AE6iDW5Lv5I0bJY6TGxJUoB4rcsbbtEP4O4MT14GP7j7I48V09VBG9yjskYze0Ls | ||||
| Xb9mQpEpPyQLTDJIWu/ic/y5SMnelCjUxmfl37cfNLJajQZxc4FDEUSemrPKpEkB | ||||
| UzHNkxw9LSzqsyxnQmMIGoN+ZNCFoV7s5pekzPfgZj5+s7a+oiF/AzhOWZzF7vaM | ||||
| aclX7KCeENQV+q0giDjsGIHI6BevUHYkglocEqff+rIDHjjLxHLPooflV50M+ifc | ||||
| 4uJdHgG8hwKxd1uf3LImUsquiBrW5CO6KCgwLrtQNe11pQHpY0urZxK/tnAj7QtD | ||||
| v/O1ryd/3+b0Gx14TyulMtcaLHsE94ppwjcxpYGNcyH+M39OMihuR2aqmkrqcZd/ | ||||
| VWop1cNwZgPtCNVvfivRpX52NLI5I0eMfs6jeTMr719hdAby3akoiNLN3YNKrdrp | ||||
| pyRz/sUFGO8AHHECXA15KTeMBNfZnO32ZAZ4jHyyDBO1A5f9iDbErhXfIpeRCrCO | ||||
| gM9MLuO4YEMG1Skp+qaw7SIaG+oi2t4lbVRr3LOv0Hfkjjb7bVjfWSwLBPH/gv0E | ||||
| ZL6G0p7PjeoCh4obS3Y1yxfNlPR6RQwWl1wve+Nkmf5sDCmgr3P0512ZuvqkbKkB | ||||
| /syiAWDsYzFuq2Ntv2ljTYPEPwXEIQcpsagDRL6WzoLR | ||||
| -----END CERTIFICATE----- | ||||
| Bag Attributes | ||||
|     localKeyID: AE DC 75 2E 97 28 71 D8 1E 9A 7F 1E 5A AA F4 2E D3 6D 2C 8B | ||||
| Key Attributes: <No Attributes> | ||||
| -----BEGIN PRIVATE KEY----- | ||||
| MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDHN18R6x5Oz+u6 | ||||
| SOXLoxIscz5GHR6cDcCLgyPax2XfXHdJs+h6fTy61WGM+aXEhR2SIwbj5997s34m | ||||
| 0MsbvkJrFmn0LHK1fuTLCihEEmxGdCGZA9xrwxFYAkEjP7D8v7cAWRMipYF/JP7V | ||||
| U7xNUo+QSkZ0sOi9k6bNkABKL3+yP6PqAzsBoKIN5lN/YRLrppsDmk6nrRDo4R3C | ||||
| D+8JQl9quEoOmL22Pc/qpOjL1jgOIFSE5y3gwbzDlfCYoAL5V+by1vu0yJShTTK8 | ||||
| oo5wvphcFfEHaQ9w5jFg2htdq99UER3BKuNDuL+zejqGQZCWb0Xsk8S5WBuX8l3B | ||||
| rrg5giqNAgMBAAECggEAVRB/t9b9igmeTlzyQpHPIMvUu3uTpm742JmWpcSe61FA | ||||
| XmhDzInNdLnIfbnb3p44kj4Coy5PbzKlm01sbNxA4BkiBPE1yen1J/2eU/LJ6QuN | ||||
| jRjo9drFfR75UWPQ3xu9uJhQY2rocLILXmvy69FlG+ebThh8SPbTMtNaTFMb47An | ||||
| pk2FrW9+rzPswbklOxls/SDt78usRvfAjslm73IdBTOrbceF+GmYs3/SXz1gu05p | ||||
| LxY2rhC8piBlqnD/QbXBahZbhjb9SkDFn2typMFZKkJIIKDJaOI2E9tIlZ97/0nZ | ||||
| txqchMty8IuU9YYAfLXCmj2IEfnvLtL7thLfKLuWAQKBgQDyXBpEgKFzfy2a1AI0 | ||||
| +1qL/u5UN14l7S6/wmyDTgVMXwoxhwPRXWD5PutQ8D6tMfC/y4AYt3OXg1blCvLD | ||||
| XysNj5SK+dpmQR0SyeWjd9zwxJAXvx0McJefCYd86YGcGhJsuX5bkHIeQlEc6df7 | ||||
| yoqr1480VQx/+Fk1i6Zr0EIUFQKBgQDSbalUOfXZh2EVRQEgf3VoPlxAiwGGQcVT | ||||
| i+pbjMG3pOwmkVyJZusGtN5HN4Oi7n1oiyfMYGsszKQ5j4TDBGS70pNUzhTv3Vn8 | ||||
| 0Vsfz0arJRqJxviiv4FfDmsYXwObNKwOjR+LEn1NUPkOYOLdz1lDuWOu11LE90Dy | ||||
| Q6hg8WwCmQKBgQDTy5lI9AAjpqh7/XpQQrhGT2qHPjuQeU25Vnbt6GjI7OVDkvHL | ||||
| LQdpyYprGQgs4s+5TGWNNARYC/cMAh1Ujv5Yw3jUWrR5V73IhZeg20bBQYWKuwDv | ||||
| thVKblFw377cZAxl51R9QCX6O4oW8mRFLiMxORd0bD6YNrf/CyNMZJraYQKBgAE7 | ||||
| o0JbFJWxtV/qh5cpKAb0VpYKOngO6pkSuMzQhlINJVUUhPZJJBdl9+dy69KIkzOJ | ||||
| nTIVXotkp5GuxZhe7jgrg7F7g6PkKCLTFzWYgVF/ZihoggxyEs/7xaTe6aZ/KILt | ||||
| UMH/2bwaPVtYNfwWuu8qpurfWBzPVhIVU2c+AuQBAoGAXMbw10vyiznlhyMFw5kx | ||||
| SzlBMqJBLJkzQBtpvXuT0lqqxTSNC3N4WxgVOLCHa6HqXiB0790YL8/RWunsXTk2 | ||||
| c7ugThP6iMPNVAycWkIF4vvHTwZ9RCSmEQabRaqGGLz/bhLL3fi3lPGCR+iW2Dxq | ||||
| GTH3fhaM/pZZGdIC75x/69Y= | ||||
| -----END PRIVATE KEY----- | ||||
| @@ -1,64 +0,0 @@ | ||||
| Bag Attributes | ||||
|     localKeyID: AE DC 75 2E 97 28 71 D8 1E 9A 7F 1E 5A AA F4 2E D3 6D 2C 8B  | ||||
| subject=/C=US/ST=California/L=San Francisco/O=BadSSL/CN=BadSSL Client Certificate | ||||
| issuer=/C=US/ST=California/L=San Francisco/O=BadSSL/CN=BadSSL Client Root Certificate Authority | ||||
| -----BEGIN CERTIFICATE----- | ||||
| MIIEnTCCAoWgAwIBAgIJAPfJjkenM2ooMA0GCSqGSIb3DQEBCwUAMH4xCzAJBgNV | ||||
| BAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNp | ||||
| c2NvMQ8wDQYDVQQKDAZCYWRTU0wxMTAvBgNVBAMMKEJhZFNTTCBDbGllbnQgUm9v | ||||
| dCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMjQwNTE3MTc1OTMyWhcNMjYwNTE3 | ||||
| MTc1OTMyWjBvMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQG | ||||
| A1UEBwwNU2FuIEZyYW5jaXNjbzEPMA0GA1UECgwGQmFkU1NMMSIwIAYDVQQDDBlC | ||||
| YWRTU0wgQ2xpZW50IENlcnRpZmljYXRlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A | ||||
| MIIBCgKCAQEAxzdfEeseTs/rukjly6MSLHM+Rh0enA3Ai4Mj2sdl31x3SbPoen08 | ||||
| utVhjPmlxIUdkiMG4+ffe7N+JtDLG75CaxZp9CxytX7kywooRBJsRnQhmQPca8MR | ||||
| WAJBIz+w/L+3AFkTIqWBfyT+1VO8TVKPkEpGdLDovZOmzZAASi9/sj+j6gM7AaCi | ||||
| DeZTf2ES66abA5pOp60Q6OEdwg/vCUJfarhKDpi9tj3P6qToy9Y4DiBUhOct4MG8 | ||||
| w5XwmKAC+Vfm8tb7tMiUoU0yvKKOcL6YXBXxB2kPcOYxYNobXavfVBEdwSrjQ7i/ | ||||
| s3o6hkGQlm9F7JPEuVgbl/Jdwa64OYIqjQIDAQABoy0wKzAJBgNVHRMEAjAAMBEG | ||||
| CWCGSAGG+EIBAQQEAwIHgDALBgNVHQ8EBAMCBeAwDQYJKoZIhvcNAQELBQADggIB | ||||
| AE6iDW5Lv5I0bJY6TGxJUoB4rcsbbtEP4O4MT14GP7j7I48V09VBG9yjskYze0Ls | ||||
| Xb9mQpEpPyQLTDJIWu/ic/y5SMnelCjUxmfl37cfNLJajQZxc4FDEUSemrPKpEkB | ||||
| UzHNkxw9LSzqsyxnQmMIGoN+ZNCFoV7s5pekzPfgZj5+s7a+oiF/AzhOWZzF7vaM | ||||
| aclX7KCeENQV+q0giDjsGIHI6BevUHYkglocEqff+rIDHjjLxHLPooflV50M+ifc | ||||
| 4uJdHgG8hwKxd1uf3LImUsquiBrW5CO6KCgwLrtQNe11pQHpY0urZxK/tnAj7QtD | ||||
| v/O1ryd/3+b0Gx14TyulMtcaLHsE94ppwjcxpYGNcyH+M39OMihuR2aqmkrqcZd/ | ||||
| VWop1cNwZgPtCNVvfivRpX52NLI5I0eMfs6jeTMr719hdAby3akoiNLN3YNKrdrp | ||||
| pyRz/sUFGO8AHHECXA15KTeMBNfZnO32ZAZ4jHyyDBO1A5f9iDbErhXfIpeRCrCO | ||||
| gM9MLuO4YEMG1Skp+qaw7SIaG+oi2t4lbVRr3LOv0Hfkjjb7bVjfWSwLBPH/gv0E | ||||
| ZL6G0p7PjeoCh4obS3Y1yxfNlPR6RQwWl1wve+Nkmf5sDCmgr3P0512ZuvqkbKkB | ||||
| /syiAWDsYzFuq2Ntv2ljTYPEPwXEIQcpsagDRL6WzoLR | ||||
| -----END CERTIFICATE----- | ||||
| Bag Attributes | ||||
|     localKeyID: AE DC 75 2E 97 28 71 D8 1E 9A 7F 1E 5A AA F4 2E D3 6D 2C 8B  | ||||
| Key Attributes: <No Attributes> | ||||
| -----BEGIN ENCRYPTED PRIVATE KEY----- | ||||
| MIIFDjBABgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQIET6L0Ht/lYgCAggA | ||||
| MBQGCCqGSIb3DQMHBAi1Xo+JdQ6XvwSCBMgX20Fk3/GzptJ0zjl7ZqX2G3J4LIkM | ||||
| E5qJ4yv2WUkCCOWqz5DjlSrRz4kdCYHqnM1/qyrLa1UWWJlNQ9lBHTE+yp0vtAC/ | ||||
| ajQfKt3RFyGxblp6nEKJI7kvhmQHDbITilmVEpcZPbci3gi7asQI3bRSLaHwGtbH | ||||
| DY+8hJ8lZQMRjYGDyGb99qEdYnMMRMW+b44lIRASe6W3EUfrvJlp+OUqRA7hJzn2 | ||||
| yha9Zo8KWo9fA9UZDFFKNlXakg76+1HymB+uqvZl14xHHfwhlKPaqzmCb8MUtt7e | ||||
| YJDB9I3y8aHKExXPbRk04bbY5G9o6WdWslDUY4axOZuhUXyn0h6cTZn//qmsjcBH | ||||
| 499+j55vW6W7vkMfurt/pmLIBWC9kDWPZVLizbfXxWiWvRmQvKPfzO5TU8oObYyJ | ||||
| qUVjb3Vpa/WPrF5APUVd/DDofurgzdOkmDGomONPvSHxahHSyEZsxpnl52GD6uU/ | ||||
| i3oa5qLE9uA1QjyX6wyN9SU5wE2FZKTJwwRJwW4+s4T/2eJjhuJez5q1xhSCes4A | ||||
| A2pufAAY/ctQSmCCKCTW+EkrXtcezx66fkgPpNK/m6bz5KGJkA4QXjl8A05PDAFE | ||||
| Z68VOX/T0IGfXc2BbPgP0u+WpCvvO2cW/pU4sjcwOMxFuT1Bn3TwmDLTZ+zba1rE | ||||
| zFRMMCz/8SKq3I+VkzQ66ureEz0RLwk07JVzE9AJUEm+zCFUdoIaz09OMGVqtf4a | ||||
| V+UgupH0QlffmRNJKQtXPuj6Wjfa43GLaCnN/cpXXq8+2o81dLTsCbEsYu+8DRjC | ||||
| B0iyjzdqgjBBYurIEwEc4iGtPt4Y+4rgAJcpEUgwvWii37xyutOC9V7ansvd6zg3 | ||||
| WXiX5Ktj/qS0EzM33WtZfx7jygJIf1MvxrJU+D+HgGii1mHaZ6bHxMX3QGpRsEvh | ||||
| IzBx16XvoHcXARZJG91bC+K1sJ6e05L1PevS7gj4heJTEhtmvABUrn9O1n5fZWPj | ||||
| Q81zRDgplMO7r8aBW/pE+sj4VSTMg0Xu0nlqqvQoWxr9YFcJm0+I9fHQPxewnRus | ||||
| sBZoiTqnWqbTr+uRATRUAp+hU03S4jGZwbzH4ylL2hr/TshGVJk/olBsULAfIiHa | ||||
| dA5H258IEwAoFO6zgI9AvqmTFo3Mnpqb/AS/HuDmmS/3Ud1EF8hFsMLPcV0JdSTY | ||||
| Dl4xgZ6j6jOUlTN5Yt6To2Zg3Q9Bm6qytFaffEP66Jl5aWhksI31Fz/ihzn5wfx9 | ||||
| xh91U8+kGVNrpYHlo5y3FR/ywSXynLkJffCbfUciEaTDv9i0JppoIVXyFqcMofHe | ||||
| GUsWTCozAW3O8MwpLaJxcNcfRq0DWziIdiDgbF2tPoCqnNxXtLYSPpdt3jNDcPcx | ||||
| U0Z6ep6FnAXiujtQRSRSP3Ssq23098BxDSM9+eashFOmSbSClAEEn/THRxTp/gMh | ||||
| zmD8kpX1zN1Cm/lerTGjrGjnkXcQ7LY76/+C1uT+tQbw5LjmCfFEYTFtnFyYFlF1 | ||||
| GiXFokh9SdLaCzW4vmZok85Fe+7VZ7BAchBTfTIMKlXKmeouf3YVYJ8glPsinrjb | ||||
| cB2pKv3tVrdQwo3moYDwSsDgkd7BNKKHDVdY2O6NgX4/Fyd6pZt7ZAphyC1giEqg | ||||
| pPo= | ||||
| -----END ENCRYPTED PRIVATE KEY----- | ||||
| @@ -46,26 +46,7 @@ | ||||
|     <use-sso>yes</use-sso> | ||||
|     <ip-address></ip-address> | ||||
|     <host></host> | ||||
|     <internal-host-detection> | ||||
|       <ip-address></ip-address> | ||||
|       <host></host> | ||||
|       <ipv6-address/> | ||||
|       <ipv6-host/> | ||||
|     </internal-host-detection> | ||||
|     <gateways> | ||||
|         <internal> | ||||
|           <list> | ||||
|                 <entry name="xxx.xxx.xxx.xxx"> | ||||
|                     <priority-rule> | ||||
|                         <entry name="Any"> | ||||
|                             <priority>1</priority> | ||||
|                         </entry> | ||||
|                     </priority-rule> | ||||
|                     <priority>1</priority> | ||||
|                     <description>vpn_gateway</description> | ||||
|                 </entry> | ||||
|             </list> | ||||
|         </internal> | ||||
|         <cutoff-time>5</cutoff-time> | ||||
|         <external> | ||||
|             <list> | ||||
| @@ -82,19 +63,6 @@ | ||||
|         </external> | ||||
|     </gateways> | ||||
|     <gateways-v6> | ||||
|         <internal> | ||||
|             <list> | ||||
|                 <entry name="vpn_gateway"> | ||||
|                     <ipv4>xxx.xxx.xxx.xxx</ipv4> | ||||
|                     <priority-rule> | ||||
|                         <entry name="Any"> | ||||
|                             <priority>1</priority> | ||||
|                         </entry> | ||||
|                     </priority-rule> | ||||
|                     <priority>1</priority> | ||||
|                 </entry> | ||||
|             </list> | ||||
|         </internal> | ||||
|         <cutoff-time>5</cutoff-time> | ||||
|         <external> | ||||
|             <list> | ||||
|   | ||||
| @@ -6,8 +6,8 @@ license.workspace = true | ||||
| links = "openconnect" | ||||
|  | ||||
| [dependencies] | ||||
| common = { path = "../common" } | ||||
| log.workspace = true | ||||
| is_executable.workspace = true | ||||
|  | ||||
| [build-dependencies] | ||||
| cc = "1" | ||||
|   | ||||
| @@ -1,674 +0,0 @@ | ||||
|                     GNU GENERAL PUBLIC LICENSE | ||||
|                        Version 3, 29 June 2007 | ||||
|  | ||||
|  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | ||||
|  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. | ||||
|  | ||||
|     <one line to give the program's name and a brief idea of what it does.> | ||||
|     Copyright (C) <year>  <name of author> | ||||
|  | ||||
|     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 <https://www.gnu.org/licenses/>. | ||||
|  | ||||
| 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: | ||||
|  | ||||
|     <program>  Copyright (C) <year>  <name of author> | ||||
|     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 | ||||
| <https://www.gnu.org/licenses/>. | ||||
|  | ||||
|   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 | ||||
| <https://www.gnu.org/licenses/why-not-lgpl.html>. | ||||
| @@ -14,17 +14,12 @@ pub(crate) struct ConnectOptions { | ||||
|   pub script: *const c_char, | ||||
|   pub os: *const c_char, | ||||
|   pub certificate: *const c_char, | ||||
|   pub sslkey: *const c_char, | ||||
|   pub key_password: *const c_char, | ||||
|   pub servercert: *const c_char, | ||||
|  | ||||
|   pub csd_uid: u32, | ||||
|   pub csd_wrapper: *const c_char, | ||||
|  | ||||
|   pub reconnect_timeout: u32, | ||||
|   pub mtu: u32, | ||||
|   pub disable_ipv6: u32, | ||||
|   pub no_dtls: u32, | ||||
| } | ||||
|  | ||||
| #[link(name = "vpn")] | ||||
|   | ||||
| @@ -16,7 +16,7 @@ static vpn_connected_callback on_vpn_connected; | ||||
| /* Validate the peer certificate */ | ||||
| static int validate_peer_cert(__attribute__((unused)) void *_vpninfo, const char *reason) | ||||
| { | ||||
|     INFO("Accepting the server certificate though %s", reason); | ||||
|     INFO("Validating peer cert: %s", reason); | ||||
|     return 0; | ||||
| } | ||||
|  | ||||
| @@ -28,9 +28,12 @@ static void print_progress(__attribute__((unused)) void *_vpninfo, int level, co | ||||
|     char *message = format_message(format, args); | ||||
|     va_end(args); | ||||
|  | ||||
|     if (message == NULL) { | ||||
|     if (message == NULL) | ||||
|     { | ||||
|         ERROR("Failed to format log message"); | ||||
|     } else { | ||||
|     } | ||||
|     else | ||||
|     { | ||||
|         LOG(level, message); | ||||
|         free(message); | ||||
|     } | ||||
| @@ -60,14 +63,12 @@ int vpn_connect(const vpn_options *options, vpn_connected_callback callback) | ||||
|     INFO("OS: %s", options->os); | ||||
|     INFO("CSD_USER: %d", options->csd_uid); | ||||
|     INFO("CSD_WRAPPER: %s", options->csd_wrapper); | ||||
|     INFO("RECONNECT_TIMEOUT: %d", options->reconnect_timeout); | ||||
|     INFO("MTU: %d", options->mtu); | ||||
|     INFO("DISABLE_IPV6: %d", options->disable_ipv6); | ||||
|     INFO("NO_DTLS: %d", options->no_dtls); | ||||
|  | ||||
|     vpninfo = openconnect_vpninfo_new(options->user_agent, validate_peer_cert, NULL, NULL, print_progress, NULL); | ||||
|  | ||||
|     if (!vpninfo) { | ||||
|     if (!vpninfo) | ||||
|     { | ||||
|         ERROR("openconnect_vpninfo_new failed"); | ||||
|         return 1; | ||||
|     } | ||||
| @@ -82,13 +83,15 @@ int vpn_connect(const vpn_options *options, vpn_connected_callback callback) | ||||
|         openconnect_set_reported_os(vpninfo, options->os); | ||||
|     } | ||||
|  | ||||
|     if (options->certificate) { | ||||
|     if (options->certificate) | ||||
|     { | ||||
|         INFO("Setting client certificate: %s", options->certificate); | ||||
|         openconnect_set_client_cert(vpninfo, options->certificate, options->sslkey); | ||||
|         openconnect_set_client_cert(vpninfo, options->certificate, NULL); | ||||
|     } | ||||
|  | ||||
|     if (options->key_password) { | ||||
|         openconnect_set_key_password(vpninfo, options->key_password); | ||||
|     if (options->servercert) { | ||||
|         INFO("Setting server certificate: %s", options->servercert); | ||||
|         openconnect_set_system_trust(vpninfo, 0); | ||||
|     } | ||||
|  | ||||
|     if (options->csd_wrapper) { | ||||
| @@ -100,37 +103,39 @@ int vpn_connect(const vpn_options *options, vpn_connected_callback callback) | ||||
|         openconnect_set_reqmtu(vpninfo, mtu); | ||||
|     } | ||||
|  | ||||
|     if (options->disable_ipv6) { | ||||
|         openconnect_disable_ipv6(vpninfo); | ||||
|     } | ||||
|  | ||||
|     g_cmd_pipe_fd = openconnect_setup_cmd_pipe(vpninfo); | ||||
|     if (g_cmd_pipe_fd < 0) { | ||||
|     if (g_cmd_pipe_fd < 0) | ||||
|     { | ||||
|         ERROR("openconnect_setup_cmd_pipe failed"); | ||||
|         return 1; | ||||
|     } | ||||
|  | ||||
|     if (!uname(&utsbuf)) { | ||||
|     if (!uname(&utsbuf)) | ||||
|     { | ||||
|         openconnect_set_localname(vpninfo, utsbuf.nodename); | ||||
|     } | ||||
|  | ||||
|     // Essential step | ||||
|     if (openconnect_make_cstp_connection(vpninfo) != 0) { | ||||
|     if (openconnect_make_cstp_connection(vpninfo) != 0) | ||||
|     { | ||||
|         ERROR("openconnect_make_cstp_connection failed"); | ||||
|         return 1; | ||||
|     } | ||||
|  | ||||
|     if (options->no_dtls || openconnect_setup_dtls(vpninfo, 60) != 0) { | ||||
|     if (openconnect_setup_dtls(vpninfo, 60) != 0) | ||||
|     { | ||||
|         openconnect_disable_dtls(vpninfo); | ||||
|     } | ||||
|  | ||||
|     // Essential step | ||||
|     openconnect_set_setup_tun_handler(vpninfo, setup_tun_handler); | ||||
|  | ||||
|     while (1) { | ||||
|         int ret = openconnect_mainloop(vpninfo, options->reconnect_timeout, 10); | ||||
|     while (1) | ||||
|     { | ||||
|         int ret = openconnect_mainloop(vpninfo, 300, 10); | ||||
|  | ||||
|         if (ret) { | ||||
|         if (ret) | ||||
|         { | ||||
|             INFO("openconnect_mainloop returned %d, exiting", ret); | ||||
|             openconnect_vpninfo_free(vpninfo); | ||||
|             return ret; | ||||
| @@ -147,7 +152,8 @@ void vpn_disconnect() | ||||
|  | ||||
|     INFO("Stopping VPN connection: %d", g_cmd_pipe_fd); | ||||
|  | ||||
|     if (write(g_cmd_pipe_fd, &cmd, 1) < 0) { | ||||
|     if (write(g_cmd_pipe_fd, &cmd, 1) < 0) | ||||
|     { | ||||
|         ERROR("Failed to write to command pipe, VPN connection may not be stopped"); | ||||
|     } | ||||
| } | ||||
|   | ||||
| @@ -15,17 +15,12 @@ typedef struct vpn_options | ||||
|     const char *script; | ||||
|     const char *os; | ||||
|     const char *certificate; | ||||
|     const char *sslkey; | ||||
|     const char *key_password; | ||||
|     const char *servercert; | ||||
|  | ||||
|     const uid_t csd_uid; | ||||
|     const char *csd_wrapper; | ||||
|  | ||||
|     const int reconnect_timeout; | ||||
|     const int mtu; | ||||
|     const int disable_ipv6; | ||||
|     const int no_dtls; | ||||
| } vpn_options; | ||||
|  | ||||
| int vpn_connect(const vpn_options *options, vpn_connected_callback callback); | ||||
| @@ -40,7 +35,7 @@ static char *format_message(const char *format, va_list args) | ||||
|     int len = vsnprintf(NULL, 0, format, args_copy); | ||||
|     va_end(args_copy); | ||||
|  | ||||
|     char *buffer = (char*)malloc(len + 1); | ||||
|     char *buffer = malloc(len + 1); | ||||
|     if (buffer == NULL) | ||||
|     { | ||||
|         return NULL; | ||||
|   | ||||
| @@ -1,4 +1,5 @@ | ||||
| mod ffi; | ||||
| mod vpn; | ||||
| mod vpnc_script; | ||||
|  | ||||
| pub use vpn::*; | ||||
|   | ||||
| @@ -1,13 +1,11 @@ | ||||
| use std::{ | ||||
|   ffi::{c_char, CString}, | ||||
|   fmt, | ||||
|   sync::{Arc, RwLock}, | ||||
| }; | ||||
|  | ||||
| use common::vpn_utils::{check_executable, find_vpnc_script}; | ||||
| use log::info; | ||||
|  | ||||
| use crate::ffi; | ||||
| use crate::{ffi, vpnc_script::find_default_vpnc_script}; | ||||
|  | ||||
| type OnConnectedCallback = Arc<RwLock<Option<Box<dyn FnOnce() + 'static + Send + Sync>>>>; | ||||
|  | ||||
| @@ -18,17 +16,12 @@ pub struct Vpn { | ||||
|   script: CString, | ||||
|   os: CString, | ||||
|   certificate: Option<CString>, | ||||
|   sslkey: Option<CString>, | ||||
|   key_password: Option<CString>, | ||||
|   servercert: Option<CString>, | ||||
|  | ||||
|   csd_uid: u32, | ||||
|   csd_wrapper: Option<CString>, | ||||
|  | ||||
|   reconnect_timeout: u32, | ||||
|   mtu: u32, | ||||
|   disable_ipv6: bool, | ||||
|   no_dtls: bool, | ||||
|  | ||||
|   callback: OnConnectedCallback, | ||||
| } | ||||
| @@ -66,19 +59,13 @@ impl Vpn { | ||||
|       user_agent: self.user_agent.as_ptr(), | ||||
|       script: self.script.as_ptr(), | ||||
|       os: self.os.as_ptr(), | ||||
|  | ||||
|       certificate: Self::option_to_ptr(&self.certificate), | ||||
|       sslkey: Self::option_to_ptr(&self.sslkey), | ||||
|       key_password: Self::option_to_ptr(&self.key_password), | ||||
|       servercert: Self::option_to_ptr(&self.servercert), | ||||
|  | ||||
|       csd_uid: self.csd_uid, | ||||
|       csd_wrapper: Self::option_to_ptr(&self.csd_wrapper), | ||||
|  | ||||
|       reconnect_timeout: self.reconnect_timeout, | ||||
|       mtu: self.mtu, | ||||
|       disable_ipv6: self.disable_ipv6 as u32, | ||||
|       no_dtls: self.no_dtls as u32, | ||||
|     } | ||||
|   } | ||||
|  | ||||
| @@ -90,44 +77,17 @@ impl Vpn { | ||||
|   } | ||||
| } | ||||
|  | ||||
| #[derive(Debug)] | ||||
| pub struct VpnError { | ||||
|   message: String, | ||||
| } | ||||
|  | ||||
| impl VpnError { | ||||
|   fn new(message: String) -> Self { | ||||
|     Self { message } | ||||
|   } | ||||
| } | ||||
|  | ||||
| impl fmt::Display for VpnError { | ||||
|   fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | ||||
|     write!(f, "{}", self.message) | ||||
|   } | ||||
| } | ||||
|  | ||||
| impl std::error::Error for VpnError {} | ||||
|  | ||||
| pub struct VpnBuilder { | ||||
|   server: String, | ||||
|   cookie: String, | ||||
|   script: Option<String>, | ||||
|  | ||||
|   user_agent: Option<String>, | ||||
|   script: Option<String>, | ||||
|   os: Option<String>, | ||||
|  | ||||
|   certificate: Option<String>, | ||||
|   sslkey: Option<String>, | ||||
|   key_password: Option<String>, | ||||
|  | ||||
|   csd_uid: u32, | ||||
|   csd_wrapper: Option<String>, | ||||
|  | ||||
|   reconnect_timeout: u32, | ||||
|   mtu: u32, | ||||
|   disable_ipv6: bool, | ||||
|   no_dtls: bool, | ||||
| } | ||||
|  | ||||
| impl VpnBuilder { | ||||
| @@ -135,55 +95,30 @@ impl VpnBuilder { | ||||
|     Self { | ||||
|       server: server.to_string(), | ||||
|       cookie: cookie.to_string(), | ||||
|       script: None, | ||||
|  | ||||
|       user_agent: None, | ||||
|       script: None, | ||||
|       os: None, | ||||
|  | ||||
|       certificate: None, | ||||
|       sslkey: None, | ||||
|       key_password: None, | ||||
|  | ||||
|       csd_uid: 0, | ||||
|       csd_wrapper: None, | ||||
|  | ||||
|       reconnect_timeout: 300, | ||||
|       mtu: 0, | ||||
|       disable_ipv6: false, | ||||
|       no_dtls: false, | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   pub fn script<T: Into<Option<String>>>(mut self, script: T) -> Self { | ||||
|     self.script = script.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn user_agent<T: Into<Option<String>>>(mut self, user_agent: T) -> Self { | ||||
|     self.user_agent = user_agent.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn script<T: Into<Option<String>>>(mut self, script: T) -> Self { | ||||
|     self.script = script.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn os<T: Into<Option<String>>>(mut self, os: T) -> Self { | ||||
|     self.os = os.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn certificate<T: Into<Option<String>>>(mut self, certificate: T) -> Self { | ||||
|     self.certificate = certificate.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn sslkey<T: Into<Option<String>>>(mut self, sslkey: T) -> Self { | ||||
|     self.sslkey = sslkey.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn key_password<T: Into<Option<String>>>(mut self, key_password: T) -> Self { | ||||
|     self.key_password = key_password.into(); | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn csd_uid(mut self, csd_uid: u32) -> Self { | ||||
|     self.csd_uid = csd_uid; | ||||
|     self | ||||
| @@ -194,64 +129,32 @@ impl VpnBuilder { | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn reconnect_timeout(mut self, reconnect_timeout: u32) -> Self { | ||||
|     self.reconnect_timeout = reconnect_timeout; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn mtu(mut self, mtu: u32) -> Self { | ||||
|     self.mtu = mtu; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn disable_ipv6(mut self, disable_ipv6: bool) -> Self { | ||||
|     self.disable_ipv6 = disable_ipv6; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn no_dtls(mut self, no_dtls: bool) -> Self { | ||||
|     self.no_dtls = no_dtls; | ||||
|     self | ||||
|   } | ||||
|  | ||||
|   pub fn build(self) -> Result<Vpn, VpnError> { | ||||
|     let script = match self.script { | ||||
|       Some(script) => { | ||||
|         check_executable(&script).map_err(|e| VpnError::new(e.to_string()))?; | ||||
|         script | ||||
|       } | ||||
|       None => find_vpnc_script().ok_or_else(|| VpnError::new(String::from("Failed to find vpnc-script")))?, | ||||
|     }; | ||||
|  | ||||
|     if let Some(csd_wrapper) = &self.csd_wrapper { | ||||
|       check_executable(csd_wrapper).map_err(|e| VpnError::new(e.to_string()))?; | ||||
|     } | ||||
|  | ||||
|   pub fn build(self) -> Vpn { | ||||
|     let user_agent = self.user_agent.unwrap_or_default(); | ||||
|     let script = self.script.or_else(find_default_vpnc_script).unwrap_or_default(); | ||||
|     let os = self.os.unwrap_or("linux".to_string()); | ||||
|  | ||||
|     Ok(Vpn { | ||||
|     Vpn { | ||||
|       server: Self::to_cstring(&self.server), | ||||
|       cookie: Self::to_cstring(&self.cookie), | ||||
|       user_agent: Self::to_cstring(&user_agent), | ||||
|       script: Self::to_cstring(&script), | ||||
|       os: Self::to_cstring(&os), | ||||
|  | ||||
|       certificate: self.certificate.as_deref().map(Self::to_cstring), | ||||
|       sslkey: self.sslkey.as_deref().map(Self::to_cstring), | ||||
|       key_password: self.key_password.as_deref().map(Self::to_cstring), | ||||
|       certificate: None, | ||||
|       servercert: None, | ||||
|  | ||||
|       csd_uid: self.csd_uid, | ||||
|       csd_wrapper: self.csd_wrapper.as_deref().map(Self::to_cstring), | ||||
|  | ||||
|       reconnect_timeout: self.reconnect_timeout, | ||||
|       mtu: self.mtu, | ||||
|       disable_ipv6: self.disable_ipv6, | ||||
|       no_dtls: self.no_dtls, | ||||
|  | ||||
|       callback: Default::default(), | ||||
|     }) | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   fn to_cstring(value: &str) -> CString { | ||||
|   | ||||
							
								
								
									
										23
									
								
								crates/openconnect/src/vpnc_script.rs
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										23
									
								
								crates/openconnect/src/vpnc_script.rs
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,23 @@ | ||||
| use is_executable::IsExecutable; | ||||
| use std::path::Path; | ||||
|  | ||||
| const VPNC_SCRIPT_LOCATIONS: [&str; 5] = [ | ||||
|   "/usr/local/share/vpnc-scripts/vpnc-script", | ||||
|   "/usr/local/sbin/vpnc-script", | ||||
|   "/usr/share/vpnc-scripts/vpnc-script", | ||||
|   "/usr/sbin/vpnc-script", | ||||
|   "/etc/vpnc/vpnc-script", | ||||
| ]; | ||||
|  | ||||
| pub(crate) fn find_default_vpnc_script() -> Option<String> { | ||||
|   for location in VPNC_SCRIPT_LOCATIONS.iter() { | ||||
|     let path = Path::new(location); | ||||
|     if path.is_executable() { | ||||
|       return Some(location.to_string()); | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   log::warn!("vpnc-script not found"); | ||||
|  | ||||
|   None | ||||
| } | ||||
							
								
								
									
										93
									
								
								flake.lock
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										93
									
								
								flake.lock
									
									
									
										generated
									
									
									
								
							| @@ -1,93 +0,0 @@ | ||||
| { | ||||
|   "nodes": { | ||||
|     "naersk": { | ||||
|       "inputs": { | ||||
|         "nixpkgs": "nixpkgs" | ||||
|       }, | ||||
|       "locked": { | ||||
|         "lastModified": 1718727675, | ||||
|         "narHash": "sha256-uFsCwWYI2pUpt0awahSBorDUrUfBhaAiyz+BPTS2MHk=", | ||||
|         "owner": "nix-community", | ||||
|         "repo": "naersk", | ||||
|         "rev": "941ce6dc38762a7cfb90b5add223d584feed299b", | ||||
|         "type": "github" | ||||
|       }, | ||||
|       "original": { | ||||
|         "owner": "nix-community", | ||||
|         "repo": "naersk", | ||||
|         "type": "github" | ||||
|       } | ||||
|     }, | ||||
|     "nixpkgs": { | ||||
|       "locked": { | ||||
|         "lastModified": 0, | ||||
|         "narHash": "sha256-US1tAChvPxT52RV8GksWZS415tTS7PV42KTc2PNDBmc=", | ||||
|         "path": "/nix/store/aa0zsahvyqnvzkicsh29jirm9hwv95pg-source", | ||||
|         "type": "path" | ||||
|       }, | ||||
|       "original": { | ||||
|         "id": "nixpkgs", | ||||
|         "type": "indirect" | ||||
|       } | ||||
|     }, | ||||
|     "nixpkgs_2": { | ||||
|       "locked": { | ||||
|         "lastModified": 1720244366, | ||||
|         "narHash": "sha256-WrDV0FPMVd2Sq9hkR5LNHudS3OSMmUrs90JUTN+MXpA=", | ||||
|         "owner": "NixOS", | ||||
|         "repo": "nixpkgs", | ||||
|         "rev": "49ee0e94463abada1de470c9c07bfc12b36dcf40", | ||||
|         "type": "github" | ||||
|       }, | ||||
|       "original": { | ||||
|         "owner": "NixOS", | ||||
|         "ref": "nixos-24.05", | ||||
|         "repo": "nixpkgs", | ||||
|         "type": "github" | ||||
|       } | ||||
|     }, | ||||
|     "nixpkgs_3": { | ||||
|       "locked": { | ||||
|         "lastModified": 1718428119, | ||||
|         "narHash": "sha256-WdWDpNaq6u1IPtxtYHHWpl5BmabtpmLnMAx0RdJ/vo8=", | ||||
|         "owner": "NixOS", | ||||
|         "repo": "nixpkgs", | ||||
|         "rev": "e6cea36f83499eb4e9cd184c8a8e823296b50ad5", | ||||
|         "type": "github" | ||||
|       }, | ||||
|       "original": { | ||||
|         "owner": "NixOS", | ||||
|         "ref": "nixpkgs-unstable", | ||||
|         "repo": "nixpkgs", | ||||
|         "type": "github" | ||||
|       } | ||||
|     }, | ||||
|     "root": { | ||||
|       "inputs": { | ||||
|         "naersk": "naersk", | ||||
|         "nixpkgs": "nixpkgs_2", | ||||
|         "rust-overlay": "rust-overlay" | ||||
|       } | ||||
|     }, | ||||
|     "rust-overlay": { | ||||
|       "inputs": { | ||||
|         "nixpkgs": "nixpkgs_3" | ||||
|       }, | ||||
|       "locked": { | ||||
|         "lastModified": 1720318855, | ||||
|         "narHash": "sha256-w3CCVK9LJ5aznXGkO1IyAlbvMNJfyA+dBF7Z1Zwx1LA=", | ||||
|         "owner": "oxalica", | ||||
|         "repo": "rust-overlay", | ||||
|         "rev": "3eed08a074cd2000884a69d448d70da2843f7103", | ||||
|         "type": "github" | ||||
|       }, | ||||
|       "original": { | ||||
|         "owner": "oxalica", | ||||
|         "repo": "rust-overlay", | ||||
|         "type": "github" | ||||
|       } | ||||
|     } | ||||
|   }, | ||||
|   "root": "root", | ||||
|   "version": 7 | ||||
| } | ||||
							
								
								
									
										57
									
								
								flake.nix
									
									
									
									
									
								
							
							
						
						
									
										57
									
								
								flake.nix
									
									
									
									
									
								
							| @@ -1,57 +0,0 @@ | ||||
| # This flake was initially generated by fh, the CLI for FlakeHub (version 0.1.12) | ||||
| { | ||||
|   # Flake inputs | ||||
|   inputs = { | ||||
|     nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.05"; | ||||
|     naersk.url = "github:nix-community/naersk"; | ||||
|     rust-overlay.url = "github:oxalica/rust-overlay"; | ||||
|   }; | ||||
|  | ||||
|   # Flake outputs that other flakes can use | ||||
|   outputs = { | ||||
|     self, | ||||
|     nixpkgs, | ||||
|     naersk, | ||||
|     rust-overlay, | ||||
|   }: let | ||||
|     supportedSystems = ["x86_64-linux" "aarch64-linux"]; | ||||
|     forEachSupportedSystem = f: | ||||
|       nixpkgs.lib.genAttrs supportedSystems (system: | ||||
|         f rec { | ||||
|           pkgs = import nixpkgs { | ||||
|             inherit system; | ||||
|             overlays = [rust-overlay.overlays.default]; | ||||
|           }; | ||||
|           naersk' = pkgs.callPackage naersk {}; | ||||
|         }); | ||||
|   in { | ||||
|     packages = forEachSupportedSystem ({ | ||||
|       pkgs, | ||||
|       naersk', | ||||
|     }: { | ||||
|       default = naersk'.buildPackage { | ||||
|         src = ./.; | ||||
|         nativeBuildInputs = with pkgs; [ | ||||
|           perl | ||||
|           jq | ||||
|           openconnect | ||||
|           libsoup | ||||
|           webkitgtk | ||||
|           pkg-config | ||||
|         ]; | ||||
|  | ||||
|         overrideMain = {...}: { | ||||
|           postPatch  = '' | ||||
|             substituteInPlace crates/gpapi/src/lib.rs \ | ||||
|               --replace-fail /usr/bin/gpclient $out/bin/gpclient \ | ||||
|               --replace-fail /usr/bin/gpservice $out/bin/gpservice \ | ||||
|               --replace-fail /usr/bin/gpgui-helper $out/bin/gpgui-helper \ | ||||
|               --replace-fail /usr/bin/gpgui $out/bin/gpgui \ | ||||
|               --replace-fail /usr/bin/gpauth $out/bin/gpauth | ||||
|           ''; | ||||
|         }; | ||||
|  | ||||
|       }; | ||||
|     }); | ||||
|   }; | ||||
| } | ||||
| @@ -1,34 +0,0 @@ | ||||
| install: | ||||
| 	@echo "===> Installing..." | ||||
|  | ||||
| 	install -Dm755 artifacts/usr/bin/gpclient $(DESTDIR)/usr/bin/gpclient | ||||
| 	install -Dm755 artifacts/usr/bin/gpservice $(DESTDIR)/usr/bin/gpservice | ||||
| 	install -Dm755 artifacts/usr/bin/gpauth $(DESTDIR)/usr/bin/gpauth | ||||
| 	install -Dm755 artifacts/usr/bin/gpgui-helper $(DESTDIR)/usr/bin/gpgui-helper | ||||
|  | ||||
| 	if [ -f artifacts/usr/bin/gpgui ]; then \ | ||||
| 		install -Dm755 artifacts/usr/bin/gpgui $(DESTDIR)/usr/bin/gpgui; \ | ||||
| 	fi | ||||
|  | ||||
| 	install -Dm644 artifacts/usr/share/applications/gpgui.desktop $(DESTDIR)/usr/share/applications/gpgui.desktop | ||||
| 	install -Dm644 artifacts/usr/share/icons/hicolor/scalable/apps/gpgui.svg $(DESTDIR)/usr/share/icons/hicolor/scalable/apps/gpgui.svg | ||||
| 	install -Dm644 artifacts/usr/share/icons/hicolor/32x32/apps/gpgui.png $(DESTDIR)/usr/share/icons/hicolor/32x32/apps/gpgui.png | ||||
| 	install -Dm644 artifacts/usr/share/icons/hicolor/128x128/apps/gpgui.png $(DESTDIR)/usr/share/icons/hicolor/128x128/apps/gpgui.png | ||||
| 	install -Dm644 artifacts/usr/share/icons/hicolor/256x256@2/apps/gpgui.png $(DESTDIR)/usr/share/icons/hicolor/256x256@2/apps/gpgui.png | ||||
| 	install -Dm644 artifacts/usr/share/polkit-1/actions/com.yuezk.gpgui.policy $(DESTDIR)/usr/share/polkit-1/actions/com.yuezk.gpgui.policy | ||||
|  | ||||
| uninstall: | ||||
| 	@echo "===> Uninstalling from $(DESTDIR)..." | ||||
|  | ||||
| 	rm -f $(DESTDIR)/usr/bin/gpclient | ||||
| 	rm -f $(DESTDIR)/usr/bin/gpservice | ||||
| 	rm -f $(DESTDIR)/usr/bin/gpauth | ||||
| 	rm -f $(DESTDIR)/usr/bin/gpgui-helper | ||||
| 	rm -f $(DESTDIR)/usr/bin/gpgui | ||||
|  | ||||
| 	rm -f $(DESTDIR)/usr/share/applications/gpgui.desktop | ||||
| 	rm -f $(DESTDIR)/usr/share/icons/hicolor/scalable/apps/gpgui.svg | ||||
| 	rm -f $(DESTDIR)/usr/share/icons/hicolor/32x32/apps/gpgui.png | ||||
| 	rm -f $(DESTDIR)/usr/share/icons/hicolor/128x128/apps/gpgui.png | ||||
| 	rm -f $(DESTDIR)/usr/share/icons/hicolor/256x256@2/apps/gpgui.png | ||||
| 	rm -f $(DESTDIR)/usr/share/polkit-1/actions/com.yuezk.gpgui.policy | ||||
| @@ -3,16 +3,7 @@ Section: net | ||||
| Priority: optional | ||||
| Maintainer: Kevin Yue <k3vinyue@gmail.com> | ||||
| Standards-Version: 4.1.4 | ||||
| Build-Depends: debhelper (>= 9), | ||||
|   pkg-config, | ||||
|   jq (>= 1), | ||||
|   make (>= 4), | ||||
|   libxml2, | ||||
|   libsecret-1-0, | ||||
|   libayatana-appindicator3-1, | ||||
|   gnome-keyring, | ||||
|   libwebkit2gtk-4.0-dev, | ||||
|   libopenconnect-dev (>= 8.20),@RUST@ | ||||
| Build-Depends: debhelper (>= 9), pkg-config, jq (>= 1), make (>= 4), openconnect (>= 8.20), libxml2, libsecret-1-0, libayatana-appindicator3-1, libwebkit2gtk-4.0-37, libgtk-3-0, gnome-keyring, @RUST@ | ||||
| Homepage: https://github.com/yuezk/GlobalProtect-openconnect | ||||
|  | ||||
| Package: globalprotect-openconnect | ||||
|   | ||||
| @@ -1,14 +0,0 @@ | ||||
| #!/bin/sh | ||||
| set -e | ||||
|  | ||||
| case "$1" in | ||||
|     purge|remove|upgrade) | ||||
|         # Remove the gpgui binary downloaded at runtime | ||||
|         rm -f /usr/bin/gpgui | ||||
|     ;; | ||||
|  | ||||
|     *) | ||||
|     ;; | ||||
| esac | ||||
|  | ||||
| exit 0 | ||||
							
								
								
									
										6
									
								
								packaging/deb/rules
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										6
									
								
								packaging/deb/rules
									
									
									
									
									
										Executable file
									
								
							| @@ -0,0 +1,6 @@ | ||||
| #!/usr/bin/make -f | ||||
|  | ||||
| export OFFLINE = 1 | ||||
|  | ||||
| %: | ||||
| 	dh $@ | ||||
| @@ -1,7 +0,0 @@ | ||||
| #!/usr/bin/make -f | ||||
|  | ||||
| export OFFLINE = @OFFLINE@ | ||||
| export BUILD_FE = 0 | ||||
|  | ||||
| %: | ||||
| 	dh $@ --no-parallel | ||||
| @@ -21,15 +21,10 @@ options=('!strip') | ||||
|  | ||||
| build() { | ||||
|   cd "$pkgname-$pkgver" | ||||
|  | ||||
|   # Must unset the CFLAGS, otherwise the build fails | ||||
|   unset CFLAGS | ||||
|  | ||||
|   make build OFFLINE=@OFFLINE@ BUILD_FE=0 | ||||
|   make build OFFLINE=1 | ||||
| } | ||||
|  | ||||
| package() { | ||||
|   cd "$pkgname-$pkgver" | ||||
|  | ||||
|   make install DESTDIR="$pkgdir" | ||||
| } | ||||
|   | ||||
| @@ -15,9 +15,9 @@ BuildRequires:  jq | ||||
| BuildRequires:  pkg-config | ||||
| BuildRequires:  openconnect-devel | ||||
| BuildRequires:  openssl-devel | ||||
| BuildRequires:  curl | ||||
| BuildRequires:  wget | ||||
| BuildRequires:  file | ||||
| BuildRequires:  perl | ||||
|  | ||||
| BuildRequires:  (webkit2gtk4.0-devel or webkit2gtk3-soup2-devel) | ||||
| BuildRequires:  (libappindicator-gtk3-devel or libappindicator3-1) | ||||
| @@ -34,20 +34,18 @@ A GUI for GlobalProtect VPN, based on OpenConnect, supports the SSO authenticati | ||||
| %prep | ||||
| %setup | ||||
|  | ||||
| %postun | ||||
| rm -f %{_bindir}/gpgui | ||||
|  | ||||
| %build | ||||
| # The injected RUSTFLAGS could fail the build | ||||
| unset RUSTFLAGS | ||||
| make build OFFLINE=@OFFLINE@ BUILD_FE=0 | ||||
| make build OFFLINE=1 | ||||
|  | ||||
| %install | ||||
| %make_install | ||||
|  | ||||
| %files | ||||
| %defattr(-,root,root) | ||||
| %{_bindir}/* | ||||
| %{_bindir}/gpclient | ||||
| %{_bindir}/gpservice | ||||
| %{_bindir}/gpauth | ||||
| %{_bindir}/gpgui-helper | ||||
| %{_datadir}/applications/gpgui.desktop | ||||
| %{_datadir}/icons/hicolor/32x32/apps/gpgui.png | ||||
| %{_datadir}/icons/hicolor/128x128/apps/gpgui.png | ||||
|   | ||||
| @@ -1,51 +0,0 @@ | ||||
| #!/bin/bash | ||||
|  | ||||
| # Usage: ./scripts/gh-release.sh <tag> | ||||
|  | ||||
| set -e | ||||
|  | ||||
| REPO="yuezk/GlobalProtect-openconnect" | ||||
| TAG=$1 | ||||
|  | ||||
| SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" | ||||
| PROJECT_DIR="$(dirname "$SCRIPT_DIR")" | ||||
|  | ||||
| RELEASE_NOTES="Release $TAG" | ||||
|  | ||||
| if [ -z "$TAG" ]; then | ||||
|   echo "Usage: ./scripts/gh-release.sh <tag>" | ||||
|   exit 1 | ||||
| fi | ||||
|  | ||||
| # For snapshot release, we don't create a release, just clear the existing assets and upload new ones. | ||||
| # This is to avoid notification spam. | ||||
| release_snapshot() { | ||||
|   RELEASE_NOTES='**!!! DO NOT USE THIS RELEASE IN PRODUCTION !!!**' | ||||
|  | ||||
|   # Get the existing assets | ||||
|   gh -R "$REPO" release view "$TAG" --json assets --jq '.assets[].name' \ | ||||
|     | xargs -I {} gh -R "$REPO" release delete-asset "$TAG" {} --yes | ||||
|  | ||||
|   echo "Uploading new assets..." | ||||
|   gh -R "$REPO" release upload "$TAG" \ | ||||
|     "$PROJECT_DIR"/.build/artifacts/artifact-source/* \ | ||||
|     "$PROJECT_DIR"/.build/artifacts/artifact-gpgui-*/* | ||||
| } | ||||
|  | ||||
| release_tag() { | ||||
|   echo "Removing existing release..." | ||||
|   gh -R "$REPO" release delete $TAG --yes --cleanup-tag || true | ||||
|  | ||||
|   echo "Creating release..." | ||||
|   gh -R "$REPO" release create $TAG \ | ||||
|     --title "$TAG" \ | ||||
|     --notes "$RELEASE_NOTES" \ | ||||
|     "$PROJECT_DIR"/.build/artifacts/artifact-source/* \ | ||||
|     "$PROJECT_DIR"/.build/artifacts/artifact-gpgui-*/* | ||||
| } | ||||
|  | ||||
| if [[ $TAG == *"snapshot" ]]; then | ||||
|   release_snapshot | ||||
| else | ||||
|   release_tag | ||||
| fi | ||||
		Reference in New Issue
	
	Block a user