Compare commits
1 Commits
v1.11.6
...
release/v1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a76d84ea96 |
1
.github/FUNDING.yaml
vendored
1
.github/FUNDING.yaml
vendored
@@ -1 +0,0 @@
|
|||||||
github: [matthewpi]
|
|
||||||
2
.github/FUNDING.yml
vendored
Normal file
2
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
github: [ DaneEveritt ]
|
||||||
|
custom: [ "https://paypal.me/PterodactylSoftware" ]
|
||||||
76
.github/workflows/build-test.yml
vendored
Normal file
76
.github/workflows/build-test.yml
vendored
Normal file
@@ -0,0 +1,76 @@
|
|||||||
|
name: Run Tests
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- develop
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- develop
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
os: [ ubuntu-20.04 ]
|
||||||
|
go: [ '^1.17' ]
|
||||||
|
goos: [ linux ]
|
||||||
|
goarch: [ amd64, arm64 ]
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
steps:
|
||||||
|
- name: Code Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
- name: Setup Go v${{ matrix.go }}
|
||||||
|
uses: actions/setup-go@v2
|
||||||
|
with:
|
||||||
|
go-version: ${{ matrix.go }}
|
||||||
|
- name: Print Environment
|
||||||
|
id: env
|
||||||
|
run: |
|
||||||
|
printf "Go Executable Path: $(which go)\n"
|
||||||
|
printf "Go Version: $(go version)\n"
|
||||||
|
printf "\n\nGo Environment:\n\n"
|
||||||
|
go env
|
||||||
|
printf "\n\nSystem Environment:\n\n"
|
||||||
|
env
|
||||||
|
printf "Git Version: $(git version)\n\n"
|
||||||
|
echo "::set-output name=version_tag::${GITHUB_REF/refs\/tags\//}"
|
||||||
|
echo "::set-output name=short_sha::$(git rev-parse --short HEAD)"
|
||||||
|
echo "::set-output name=go_cache::$(go env GOCACHE)"
|
||||||
|
echo "::set-output name=go_mod_cache::$(go env GOMODCACHE)"
|
||||||
|
- name: Build Cache
|
||||||
|
uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
key: ${{ runner.os }}-go${{ matrix.go }}-${{ hashFiles('**/go.sum') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-go${{ matrix.go }}-
|
||||||
|
path: |
|
||||||
|
${{ steps.env.outputs.go_cache }}
|
||||||
|
${{ steps.env.outputs.go_mod_cache }}
|
||||||
|
- name: Get Dependencies
|
||||||
|
run: |
|
||||||
|
go get -v -t -d ./...
|
||||||
|
- name: Build
|
||||||
|
env:
|
||||||
|
GOOS: ${{ matrix.goos }}
|
||||||
|
GOARCH: ${{ matrix.goarch }}
|
||||||
|
CGO_ENABLED: 0
|
||||||
|
SRC_PATH: github.com/pterodactyl/wings
|
||||||
|
run: |
|
||||||
|
go build -v -trimpath -ldflags="-s -w -X ${SRC_PATH}/system.Version=dev-${GIT_COMMIT:0:7}" -o build/wings_${GOOS}_${GOARCH} wings.go
|
||||||
|
go build -v -trimpath -ldflags="-X ${SRC_PATH}/system.Version=dev-${GIT_COMMIT:0:7}" -o build/wings_${GOOS}_${GOARCH}_debug wings.go
|
||||||
|
upx build/wings_${GOOS}_${{ matrix.goarch }}
|
||||||
|
chmod +x build/*
|
||||||
|
- name: Tests
|
||||||
|
run: go test -race ./...
|
||||||
|
- name: Upload Release Artifact
|
||||||
|
uses: actions/upload-artifact@v2
|
||||||
|
if: ${{ github.ref == 'refs/heads/develop' || github.event_name == 'pull_request' }}
|
||||||
|
with:
|
||||||
|
name: wings_linux_${{ matrix.goarch }}
|
||||||
|
path: build/wings_linux_${{ matrix.goarch }}
|
||||||
|
- name: Upload Debug Artifact
|
||||||
|
uses: actions/upload-artifact@v2
|
||||||
|
if: ${{ github.ref == 'refs/heads/develop' || github.event_name == 'pull_request' }}
|
||||||
|
with:
|
||||||
|
name: wings_linux_${{ matrix.goarch }}_debug
|
||||||
|
path: build/wings_linux_${{ matrix.goarch }}_debug
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
name: CodeQL
|
name: CodeQL
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
@@ -8,35 +7,24 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- develop
|
- develop
|
||||||
schedule:
|
schedule:
|
||||||
- cron: "0 9 * * 4"
|
- cron: '0 9 * * 4'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
analyze:
|
analyze:
|
||||||
name: Analyze
|
name: Analyze
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
actions: read
|
actions: read
|
||||||
contents: read
|
contents: read
|
||||||
security-events: write
|
security-events: write
|
||||||
|
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
language:
|
language: [ 'go' ]
|
||||||
- go
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Code Checkout
|
- uses: actions/checkout@v2
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Initialize CodeQL
|
- name: Initialize CodeQL
|
||||||
uses: github/codeql-action/init@v2
|
uses: github/codeql-action/init@v1
|
||||||
with:
|
with:
|
||||||
languages: ${{ matrix.language }}
|
languages: ${{ matrix.language }}
|
||||||
|
- uses: github/codeql-action/autobuild@v1
|
||||||
- name: Autobuild
|
- uses: github/codeql-action/analyze@v1
|
||||||
uses: github/codeql-action/autobuild@v2
|
|
||||||
|
|
||||||
- name: Perform CodeQL Analysis
|
|
||||||
uses: github/codeql-action/analyze@v2
|
|
||||||
78
.github/workflows/docker.yaml
vendored
78
.github/workflows/docker.yaml
vendored
@@ -1,78 +0,0 @@
|
|||||||
name: Docker
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- develop
|
|
||||||
release:
|
|
||||||
types:
|
|
||||||
- published
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-and-push:
|
|
||||||
name: Build and Push
|
|
||||||
runs-on: ubuntu-20.04
|
|
||||||
# Always run against a tag, even if the commit into the tag has [docker skip] within the commit message.
|
|
||||||
if: "!contains(github.ref, 'develop') || (!contains(github.event.head_commit.message, 'skip docker') && !contains(github.event.head_commit.message, 'docker skip'))"
|
|
||||||
steps:
|
|
||||||
- name: Code checkout
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Docker metadata
|
|
||||||
id: docker_meta
|
|
||||||
uses: docker/metadata-action@v4
|
|
||||||
with:
|
|
||||||
images: ghcr.io/pterodactyl/wings
|
|
||||||
flavor: |
|
|
||||||
latest=false
|
|
||||||
tags: |
|
|
||||||
type=raw,value=latest,enable=${{ github.event_name == 'release' && github.event.action == 'published' && github.event.release.prerelease == false }}
|
|
||||||
type=ref,event=tag
|
|
||||||
type=ref,event=branch
|
|
||||||
|
|
||||||
- name: Setup QEMU
|
|
||||||
uses: docker/setup-qemu-action@v2
|
|
||||||
|
|
||||||
- name: Setup Docker buildx
|
|
||||||
uses: docker/setup-buildx-action@v2
|
|
||||||
|
|
||||||
- name: Login to GitHub Container Registry
|
|
||||||
uses: docker/login-action@v2
|
|
||||||
with:
|
|
||||||
registry: ghcr.io
|
|
||||||
username: ${{ github.repository_owner }}
|
|
||||||
password: ${{ secrets.REGISTRY_TOKEN }}
|
|
||||||
|
|
||||||
- name: Get Build Information
|
|
||||||
id: build_info
|
|
||||||
run: |
|
|
||||||
echo "version_tag=${GITHUB_REF/refs\/tags\/v/}" >> $GITHUB_OUTPUT
|
|
||||||
echo "short_sha=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
|
|
||||||
|
|
||||||
- name: Build and Push (tag)
|
|
||||||
uses: docker/build-push-action@v3
|
|
||||||
if: "github.event_name == 'release' && github.event.action == 'published'"
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
file: ./Dockerfile
|
|
||||||
push: true
|
|
||||||
platforms: linux/amd64,linux/arm64
|
|
||||||
build-args: |
|
|
||||||
VERSION=${{ steps.build_info.outputs.version_tag }}
|
|
||||||
labels: ${{ steps.docker_meta.outputs.labels }}
|
|
||||||
tags: ${{ steps.docker_meta.outputs.tags }}
|
|
||||||
|
|
||||||
- name: Build and Push (develop)
|
|
||||||
uses: docker/build-push-action@v3
|
|
||||||
if: "github.event_name == 'push' && contains(github.ref, 'develop')"
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
file: ./Dockerfile
|
|
||||||
push: ${{ github.event_name != 'pull_request' }}
|
|
||||||
platforms: linux/amd64,linux/arm64
|
|
||||||
build-args: |
|
|
||||||
VERSION=dev-${{ steps.build_info.outputs.short_sha }}
|
|
||||||
labels: ${{ steps.docker_meta.outputs.labels }}
|
|
||||||
tags: ${{ steps.docker_meta.outputs.tags }}
|
|
||||||
cache-from: type=gha
|
|
||||||
cache-to: type=gha,mode=max
|
|
||||||
58
.github/workflows/docker.yml
vendored
Normal file
58
.github/workflows/docker.yml
vendored
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
name: Publish Docker Image
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- develop
|
||||||
|
tags:
|
||||||
|
- 'v*'
|
||||||
|
jobs:
|
||||||
|
push:
|
||||||
|
name: Push
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
|
# Always run against a tag, even if the commit into the tag has [docker skip] within the commit message.
|
||||||
|
if: "!contains(github.ref, 'develop') || (!contains(github.event.head_commit.message, 'skip docker') && !contains(github.event.head_commit.message, 'docker skip'))"
|
||||||
|
steps:
|
||||||
|
- name: Code Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
- name: Docker Meta
|
||||||
|
id: docker_meta
|
||||||
|
uses: crazy-max/ghaction-docker-meta@v1
|
||||||
|
with:
|
||||||
|
images: ghcr.io/pterodactyl/wings
|
||||||
|
- name: Set up QEMU
|
||||||
|
uses: docker/setup-qemu-action@v1
|
||||||
|
- name: Install buildx
|
||||||
|
uses: docker/setup-buildx-action@v1
|
||||||
|
with:
|
||||||
|
version: v0.5.1
|
||||||
|
- name: Login to GitHub Container Registry
|
||||||
|
uses: docker/login-action@v1
|
||||||
|
with:
|
||||||
|
registry: ghcr.io
|
||||||
|
username: ${{ github.repository_owner }}
|
||||||
|
password: ${{ secrets.REGISTRY_TOKEN }}
|
||||||
|
- name: Get Build Information
|
||||||
|
id: build_info
|
||||||
|
run: |
|
||||||
|
echo "::set-output name=version_tag::${GITHUB_REF/refs\/tags\/v/}"
|
||||||
|
echo "::set-output name=short_sha::$(git rev-parse --short HEAD)"
|
||||||
|
- name: Release Production Build
|
||||||
|
uses: docker/build-push-action@v2
|
||||||
|
if: "!contains(github.ref, 'develop')"
|
||||||
|
with:
|
||||||
|
build-args: |
|
||||||
|
VERSION=${{ steps.build_info.outputs.version_tag }}
|
||||||
|
labels: ${{ steps.docker_meta.outputs.labels }}
|
||||||
|
platforms: linux/amd64,linux/arm64
|
||||||
|
push: true
|
||||||
|
tags: ${{ steps.docker_meta.outputs.tags }}
|
||||||
|
- name: Release Development Build
|
||||||
|
uses: docker/build-push-action@v2
|
||||||
|
if: "contains(github.ref, 'develop')"
|
||||||
|
with:
|
||||||
|
build-args: |
|
||||||
|
VERSION=dev-${{ steps.build_info.outputs.short_sha }}
|
||||||
|
labels: ${{ steps.docker_meta.outputs.labels }}
|
||||||
|
platforms: linux/amd64,linux/arm64
|
||||||
|
push: ${{ github.event_name != 'pull_request' }}
|
||||||
|
tags: ${{ steps.docker_meta.outputs.tags }}
|
||||||
75
.github/workflows/push.yaml
vendored
75
.github/workflows/push.yaml
vendored
@@ -1,75 +0,0 @@
|
|||||||
name: Push
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- develop
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- develop
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-and-test:
|
|
||||||
name: Build and Test
|
|
||||||
runs-on: ${{ matrix.os }}
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
os: [ubuntu-20.04]
|
|
||||||
go: ["1.19.9", "1.20.4"]
|
|
||||||
goos: [linux]
|
|
||||||
goarch: [amd64, arm64]
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Setup Go
|
|
||||||
uses: actions/setup-go@v4
|
|
||||||
with:
|
|
||||||
go-version: ${{ matrix.go }}
|
|
||||||
|
|
||||||
- name: Code checkout
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: go mod download
|
|
||||||
env:
|
|
||||||
CGO_ENABLED: 0
|
|
||||||
run: |
|
|
||||||
go mod download
|
|
||||||
|
|
||||||
- name: Build
|
|
||||||
env:
|
|
||||||
GOOS: ${{ matrix.goos }}
|
|
||||||
GOARCH: ${{ matrix.goarch }}
|
|
||||||
CGO_ENABLED: 0
|
|
||||||
SRC_PATH: github.com/pterodactyl/wings
|
|
||||||
run: |
|
|
||||||
go build -v -trimpath -ldflags="-s -w -X ${SRC_PATH}/system.Version=dev-${GIT_COMMIT:0:7}" -o dist/wings ${SRC_PATH}
|
|
||||||
go build -v -trimpath -ldflags="-X ${SRC_PATH}/system.Version=dev-${GIT_COMMIT:0:7}" -o dist/wings_debug ${SRC_PATH}
|
|
||||||
chmod 755 dist/*
|
|
||||||
|
|
||||||
- name: go test
|
|
||||||
if: ${{ matrix.goarch == 'amd64' }}
|
|
||||||
env:
|
|
||||||
CGO_ENABLED: 0
|
|
||||||
run: |
|
|
||||||
go test $(go list ./...)
|
|
||||||
|
|
||||||
- name: go test -race
|
|
||||||
if: ${{ matrix.goarch == 'amd64' }}
|
|
||||||
env:
|
|
||||||
CGO_ENABLED: 1
|
|
||||||
run: |
|
|
||||||
go test -race $(go list ./...)
|
|
||||||
|
|
||||||
- name: Upload Release Artifact
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
if: ${{ github.ref == 'refs/heads/develop' || github.event_name == 'pull_request' }}
|
|
||||||
with:
|
|
||||||
name: wings_linux_${{ matrix.goarch }}
|
|
||||||
path: dist/wings
|
|
||||||
|
|
||||||
- name: Upload Debug Artifact
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
if: ${{ github.ref == 'refs/heads/develop' || github.event_name == 'pull_request' }}
|
|
||||||
with:
|
|
||||||
name: wings_linux_${{ matrix.goarch }}_debug
|
|
||||||
path: dist/wings_debug
|
|
||||||
@@ -1,47 +1,41 @@
|
|||||||
name: Release
|
name: Create Release
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
tags:
|
tags:
|
||||||
- "v*"
|
- 'v*'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
name: Release
|
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-20.04
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Code Checkout
|
- name: Code Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v2
|
||||||
|
- uses: actions/setup-go@v2
|
||||||
- name: Setup Go
|
|
||||||
uses: actions/setup-go@v4
|
|
||||||
with:
|
with:
|
||||||
go-version: "1.19.9"
|
go-version: '^1.17'
|
||||||
|
- name: Build
|
||||||
- name: Build release binaries
|
|
||||||
env:
|
env:
|
||||||
CGO_ENABLED: 0
|
|
||||||
REF: ${{ github.ref }}
|
REF: ${{ github.ref }}
|
||||||
run: |
|
run: |
|
||||||
GOARCH=amd64 go build -o dist/wings_linux_amd64 -v -trimpath -ldflags="-s -w -X github.com/pterodactyl/wings/system.Version=${REF:11}" github.com/pterodactyl/wings
|
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-s -w -X github.com/pterodactyl/wings/system.Version=${REF:11}" -o build/wings_linux_amd64 -v wings.go
|
||||||
chmod 755 dist/wings_linux_amd64
|
CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -ldflags="-s -w -X github.com/pterodactyl/wings/system.Version=${REF:11}" -o build/wings_linux_arm64 -v wings.go
|
||||||
GOARCH=arm64 go build -o dist/wings_linux_arm64 -v -trimpath -ldflags="-s -w -X github.com/pterodactyl/wings/system.Version=${REF:11}" github.com/pterodactyl/wings
|
- name: Test
|
||||||
chmod 755 dist/wings_linux_arm64
|
run: go test ./...
|
||||||
|
- name: Compress binary and make it executable
|
||||||
|
run: |
|
||||||
|
upx build/wings_linux_amd64 && chmod +x build/wings_linux_amd64
|
||||||
|
upx build/wings_linux_arm64 && chmod +x build/wings_linux_arm64
|
||||||
- name: Extract changelog
|
- name: Extract changelog
|
||||||
env:
|
env:
|
||||||
REF: ${{ github.ref }}
|
REF: ${{ github.ref }}
|
||||||
run: |
|
run: |
|
||||||
sed -n "/^## ${REF:10}/,/^## /{/^## /b;p}" CHANGELOG.md > ./RELEASE_CHANGELOG
|
sed -n "/^## ${REF:10}/,/^## /{/^## /b;p}" CHANGELOG.md > ./RELEASE_CHANGELOG
|
||||||
|
echo ::set-output name=version_name::`sed -nr "s/^## (${REF:10} .*)$/\1/p" CHANGELOG.md`
|
||||||
- name: Create checksum and add to changelog
|
- name: Create checksum and add to changelog
|
||||||
run: |
|
run: |
|
||||||
SUM=`cd dist && sha256sum wings_linux_amd64`
|
SUM=`cd build && sha256sum wings_linux_amd64`
|
||||||
SUM2=`cd dist && sha256sum wings_linux_arm64`
|
SUM2=`cd build && sha256sum wings_linux_arm64`
|
||||||
echo -e "\n#### SHA256 Checksum\n\`\`\`\n$SUM\n$SUM2\n\`\`\`\n" >> ./RELEASE_CHANGELOG
|
echo -e "\n#### SHA256 Checksum\n\`\`\`\n$SUM\n$SUM2\n\`\`\`\n" >> ./RELEASE_CHANGELOG
|
||||||
echo -e "$SUM\n$SUM2" > checksums.txt
|
echo -e "$SUM\n$SUM2" > checksums.txt
|
||||||
|
|
||||||
- name: Create release branch
|
- name: Create release branch
|
||||||
env:
|
env:
|
||||||
REF: ${{ github.ref }}
|
REF: ${{ github.ref }}
|
||||||
@@ -55,37 +49,35 @@ jobs:
|
|||||||
git add system/const.go
|
git add system/const.go
|
||||||
git commit -m "bump version for release"
|
git commit -m "bump version for release"
|
||||||
git push
|
git push
|
||||||
|
- name: Create Release
|
||||||
- name: Create release
|
|
||||||
id: create_release
|
id: create_release
|
||||||
uses: softprops/action-gh-release@v1
|
uses: actions/create-release@v1
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
with:
|
with:
|
||||||
draft: true
|
tag_name: ${{ github.ref }}
|
||||||
prerelease: ${{ contains(github.ref, 'rc') || contains(github.ref, 'beta') || contains(github.ref, 'alpha') }}
|
release_name: ${{ steps.extract_changelog.outputs.version_name }}
|
||||||
body_path: ./RELEASE_CHANGELOG
|
body_path: ./RELEASE_CHANGELOG
|
||||||
|
draft: true
|
||||||
- name: Upload amd64 binary
|
prerelease: ${{ contains(github.ref, 'beta') || contains(github.ref, 'alpha') }}
|
||||||
|
- name: Upload amd64 Binary
|
||||||
uses: actions/upload-release-asset@v1
|
uses: actions/upload-release-asset@v1
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
with:
|
with:
|
||||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||||
asset_path: dist/wings_linux_amd64
|
asset_path: build/wings_linux_amd64
|
||||||
asset_name: wings_linux_amd64
|
asset_name: wings_linux_amd64
|
||||||
asset_content_type: application/octet-stream
|
asset_content_type: application/octet-stream
|
||||||
|
- name: Upload arm64 Binary
|
||||||
- name: Upload arm64 binary
|
|
||||||
uses: actions/upload-release-asset@v1
|
uses: actions/upload-release-asset@v1
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
with:
|
with:
|
||||||
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
||||||
asset_path: dist/wings_linux_arm64
|
asset_path: build/wings_linux_arm64
|
||||||
asset_name: wings_linux_arm64
|
asset_name: wings_linux_arm64
|
||||||
asset_content_type: application/octet-stream
|
asset_content_type: application/octet-stream
|
||||||
|
|
||||||
- name: Upload checksum
|
- name: Upload checksum
|
||||||
uses: actions/upload-release-asset@v1
|
uses: actions/upload-release-asset@v1
|
||||||
env:
|
env:
|
||||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -23,8 +23,6 @@
|
|||||||
# ignore configuration file
|
# ignore configuration file
|
||||||
/config.yml
|
/config.yml
|
||||||
/config*.yml
|
/config*.yml
|
||||||
/config.yaml
|
|
||||||
/config*.yaml
|
|
||||||
|
|
||||||
# Ignore Vagrant stuff
|
# Ignore Vagrant stuff
|
||||||
/.vagrant
|
/.vagrant
|
||||||
|
|||||||
106
CHANGELOG.md
106
CHANGELOG.md
@@ -1,111 +1,5 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## v1.11.6
|
|
||||||
### Fixed
|
|
||||||
* CVE-2023-32080
|
|
||||||
|
|
||||||
## v1.11.5
|
|
||||||
### Added
|
|
||||||
* Added a config option to disable Wings config.yml updates from the Panel (https://github.com/pterodactyl/wings/commit/ec6d6d83ea3eb14995c24f001233e85b37ffb87b)
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* Wings is now built with Go 1.19.7
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
* Fixed archives containing partially matched file names (https://github.com/pterodactyl/wings/commit/43b3496f0001cec231c80af1f9a9b3417d04e8d4)
|
|
||||||
|
|
||||||
## v1.11.4
|
|
||||||
### Fixed
|
|
||||||
* CVE-2023-25168
|
|
||||||
|
|
||||||
## v1.11.3
|
|
||||||
### Fixed
|
|
||||||
* CVE-2023-25152
|
|
||||||
|
|
||||||
## v1.11.2
|
|
||||||
### Fixed
|
|
||||||
* Backups being restored from remote storage (s3) erroring out due to a closed stream.
|
|
||||||
* Fix IP validation logic for activity logs filtering out valid IPs instead of invalid IPs
|
|
||||||
|
|
||||||
## v1.11.1
|
|
||||||
### Changed
|
|
||||||
* Release binaries are now built with Go 1.18.10
|
|
||||||
* Timeout when stopping a server before a transfer begins has been reduced to 15 seconds from 1 minute
|
|
||||||
* Removed insecure SSH protocols for use with the SFTP server
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
* Unnecessary Docker client connections being left open, causing a slow leak of file descriptors
|
|
||||||
* Files being left open in parts of the server's filesystem, causing a leak of file descriptors
|
|
||||||
* IPv6 addresses being corrupted by flawed port stripping logic for activity logs, old entries with malformed IPs will be deleted from the local SQLite database automatically
|
|
||||||
* A server that times out while being stopped at the beginning of a transfer no longer causes the server to become stuck in a transferring state
|
|
||||||
|
|
||||||
## v1.11.0
|
|
||||||
### Added (since 1.7.2)
|
|
||||||
* More detailed information returned by the `/api/system` endpoint when using the `?v=2` query parameter.
|
|
||||||
|
|
||||||
### Changed (since 1.7.2)
|
|
||||||
* Send re-installation status separately from installation status.
|
|
||||||
* Wings release versions will now follow the major and minor version of the Panel.
|
|
||||||
* Transfers no longer buffer to disk, instead they are fully streamed with only a small amount of memory used for buffering.
|
|
||||||
* Release binaries are no longer compressed with UPX.
|
|
||||||
* Use `POST` instead of `GET` for sending the status of a transfer to the Panel.
|
|
||||||
|
|
||||||
### Fixed (since 1.7.2)
|
|
||||||
* Fixed servers outgoing IP not being updated whenever a server's primary allocation is changed when using the Force Outgoing IP option.
|
|
||||||
* Fixed servers being terminated rather than gracefully stopped when a signal is used to stop the container rather than a command.
|
|
||||||
* Fixed file not found errors being treated as an internal error, they are now treated as a 404.
|
|
||||||
* Wings can be run with Podman instead of Docker, this is still experimental and not recommended for production use.
|
|
||||||
* Archive progress is now reported correctly.
|
|
||||||
* Labels for containers can now be set by the Panel.
|
|
||||||
* Fixed servers becoming deadlocked when the target node of a transfer goes offline.
|
|
||||||
|
|
||||||
## v1.11.0-rc.2
|
|
||||||
### Added
|
|
||||||
* More detailed information returned by the `/api/system` endpoint when using the `?v=2` query parameter.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* Send reinstallation status separately from installation status.
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
* Fixed servers outgoing IP not being updated whenever a server's primary allocation is changed when using the Force Outgoing IP option.
|
|
||||||
* Fixed servers being terminated rather than gracefully stopped when a signal is used to stop the container rather than a command.
|
|
||||||
* Fixed file not found errors being treated as an internal error, they are now treated as a 404.
|
|
||||||
|
|
||||||
## v1.11.0-rc.1
|
|
||||||
### Changed
|
|
||||||
* Wings release versions will now follow the major and minor version of the panel.
|
|
||||||
* Transfers no longer buffer to disk, instead they are fully streamed with only a small amount of memory used for buffering.
|
|
||||||
* Release binaries are no longer compressed with UPX.
|
|
||||||
|
|
||||||
### Fixed
|
|
||||||
* Wings can be run with podman instead of Docker, this is still experimental and not recommended for production use.
|
|
||||||
* Archive progress is now reported correctly.
|
|
||||||
* Labels for containers can now be set by the Panel.
|
|
||||||
|
|
||||||
## v1.7.5
|
|
||||||
### Fixed
|
|
||||||
* CVE-2023-32080
|
|
||||||
|
|
||||||
## v1.7.4
|
|
||||||
### Fixed
|
|
||||||
* CVE-2023-25168
|
|
||||||
|
|
||||||
## v1.7.3
|
|
||||||
### Fixed
|
|
||||||
* CVE-2023-25152
|
|
||||||
|
|
||||||
## v1.7.2
|
|
||||||
### Fixed
|
|
||||||
* The S3 backup driver now supports Cloudflare R2
|
|
||||||
|
|
||||||
### Added
|
|
||||||
* During a server transfer, there is a new "Archiving" status that outputs the progress of creating the server transfer archive.
|
|
||||||
* Adds a configuration option to control the list of trusted proxies that can be used to determine the client IP address.
|
|
||||||
* Adds a configuration option to control the Docker username space setting when Wings creates containers.
|
|
||||||
|
|
||||||
### Changed
|
|
||||||
* Releases are now built using `Go 1.18` — the minimum version required to build Wings is now `Go 1.18`.
|
|
||||||
|
|
||||||
## v1.7.1
|
## v1.7.1
|
||||||
### Fixed
|
### Fixed
|
||||||
* YAML parser has been updated to fix some strange issues
|
* YAML parser has been updated to fix some strange issues
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# Stage 1 (Build)
|
# Stage 1 (Build)
|
||||||
FROM golang:1.19-alpine AS builder
|
FROM golang:1.17-alpine AS builder
|
||||||
|
|
||||||
ARG VERSION
|
ARG VERSION
|
||||||
RUN apk add --update --no-cache git make
|
RUN apk add --update --no-cache git make
|
||||||
|
|||||||
3
Makefile
3
Makefile
@@ -14,6 +14,9 @@ rmdebug:
|
|||||||
go build -gcflags "all=-N -l" -ldflags="-X github.com/pterodactyl/wings/system.Version=$(GIT_HEAD)" -race
|
go build -gcflags "all=-N -l" -ldflags="-X github.com/pterodactyl/wings/system.Version=$(GIT_HEAD)" -race
|
||||||
sudo dlv --listen=:2345 --headless=true --api-version=2 --accept-multiclient exec ./wings -- --debug --ignore-certificate-errors --config config.yml
|
sudo dlv --listen=:2345 --headless=true --api-version=2 --accept-multiclient exec ./wings -- --debug --ignore-certificate-errors --config config.yml
|
||||||
|
|
||||||
|
compress:
|
||||||
|
upx --brute build/wings_*
|
||||||
|
|
||||||
cross-build: clean build compress
|
cross-build: clean build compress
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
|
|||||||
31
README.md
31
README.md
@@ -5,7 +5,6 @@
|
|||||||
[](https://goreportcard.com/report/github.com/pterodactyl/wings)
|
[](https://goreportcard.com/report/github.com/pterodactyl/wings)
|
||||||
|
|
||||||
# Pterodactyl Wings
|
# Pterodactyl Wings
|
||||||
|
|
||||||
Wings is Pterodactyl's server control plane, built for the rapidly changing gaming industry and designed to be
|
Wings is Pterodactyl's server control plane, built for the rapidly changing gaming industry and designed to be
|
||||||
highly performant and secure. Wings provides an HTTP API allowing you to interface directly with running server
|
highly performant and secure. Wings provides an HTTP API allowing you to interface directly with running server
|
||||||
instances, fetch server logs, generate backups, and control all aspects of the server lifecycle.
|
instances, fetch server logs, generate backups, and control all aspects of the server lifecycle.
|
||||||
@@ -14,29 +13,31 @@ In addition, Wings ships with a built-in SFTP server allowing your system to rem
|
|||||||
dependencies, and allowing users to authenticate with the same credentials they would normally use to access the Panel.
|
dependencies, and allowing users to authenticate with the same credentials they would normally use to access the Panel.
|
||||||
|
|
||||||
## Sponsors
|
## Sponsors
|
||||||
|
I would like to extend my sincere thanks to the following sponsors for helping find Pterodactyl's developement.
|
||||||
|
[Interested in becoming a sponsor?](https://github.com/sponsors/DaneEveritt)
|
||||||
|
|
||||||
I would like to extend my sincere thanks to the following sponsors for helping find Pterodactyl's development.
|
| Company | About |
|
||||||
[Interested in becoming a sponsor?](https://github.com/sponsors/matthewpi)
|
| ------- | ----- |
|
||||||
|
| [**WISP**](https://wisp.gg) | Extra features. |
|
||||||
| Company | About |
|
| [**BisectHosting**](https://www.bisecthosting.com/) | BisectHosting provides Minecraft, Valheim and other server hosting services with the highest reliability and lightning fast support since 2012. |
|
||||||
|-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| [**Fragnet**](https://fragnet.net) | Providing low latency, high-end game hosting solutions to gamers, game studios and eSports platforms. |
|
||||||
| [**WISP**](https://wisp.gg) | Extra features. |
|
| [**Tempest**](https://tempest.net/) | Tempest Hosting is a subsidiary of Path Network, Inc. offering unmetered DDoS protected 10Gbps dedicated servers, starting at just $80/month. Full anycast, tons of filters. |
|
||||||
| [**Aussie Server Hosts**](https://aussieserverhosts.com/) | No frills Australian Owned and operated High Performance Server hosting for some of the most demanding games serving Australia and New Zealand. |
|
| [**Bloom.host**](https://bloom.host) | Bloom.host offers dedicated core VPS and Minecraft hosting with Ryzen 9 processors. With owned-hardware, we offer truly unbeatable prices on high-performance hosting. |
|
||||||
| [**BisectHosting**](https://www.bisecthosting.com/) | BisectHosting provides Minecraft, Valheim and other server hosting services with the highest reliability and lightning fast support since 2012. |
|
| [**MineStrator**](https://minestrator.com/) | Looking for the most highend French hosting company for your minecraft server? More than 24,000 members on our discord trust us. Give us a try! |
|
||||||
| [**MineStrator**](https://minestrator.com/) | Looking for the most highend French hosting company for your minecraft server? More than 24,000 members on our discord trust us. Give us a try! |
|
| [**Skynode**](https://www.skynode.pro/) | Skynode provides blazing fast game servers along with a top-notch user experience. Whatever our clients are looking for, we're able to provide it! |
|
||||||
| [**Skynode**](https://www.skynode.pro/) | Skynode provides blazing fast game servers along with a top-notch user experience. Whatever our clients are looking for, we're able to provide it! |
|
| [**DeinServerHost**](https://deinserverhost.de/) | DeinServerHost offers Dedicated, vps and Gameservers for many popular Games like Minecraft and Rust in Germany since 2013. |
|
||||||
| [**VibeGAMES**](https://vibegames.net/) | VibeGAMES is a game server provider that specializes in DDOS protection for the games we offer. We have multiple locations in the US, Brazil, France, Germany, Singapore, Australia and South Africa. |
|
| [**Aussie Server Hosts**](https://aussieserverhosts.com/) | No frills Australian Owned and operated High Performance Server hosting for some of the most demanding games serving Australia and New Zealand. |
|
||||||
| [**Pterodactyl Market**](https://pterodactylmarket.com/) | Pterodactyl Market is a one-and-stop shop for Pterodactyl. In our market, you can find Add-ons, Themes, Eggs, and more for Pterodactyl. |
|
| [**HostEZ**](https://hostez.io) | Providing North America Valheim, Minecraft and other popular games with low latency, high uptime and maximum availability. EZ! |
|
||||||
|
| [**VibeGAMES**](https://vibegames.net/) | VibeGAMES is a game server provider that specializes in DDOS protection for the games we offer. We have multiple locations in the US, Brazil, France, Germany, Singapore, Australia and South Africa.|
|
||||||
|
| [**Gamenodes**](https://gamenodes.nl) | Gamenodes love quality. For Minecraft, Discord Bots and other services, among others. With our own programmers, we provide just that little bit of extra service! |
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
* [Panel Documentation](https://pterodactyl.io/panel/1.0/getting_started.html)
|
* [Panel Documentation](https://pterodactyl.io/panel/1.0/getting_started.html)
|
||||||
* [Wings Documentation](https://pterodactyl.io/wings/1.0/installing.html)
|
* [Wings Documentation](https://pterodactyl.io/wings/1.0/installing.html)
|
||||||
* [Community Guides](https://pterodactyl.io/community/about.html)
|
* [Community Guides](https://pterodactyl.io/community/about.html)
|
||||||
* Or, get additional help [via Discord](https://discord.gg/pterodactyl)
|
* Or, get additional help [via Discord](https://discord.gg/pterodactyl)
|
||||||
|
|
||||||
## Reporting Issues
|
## Reporting Issues
|
||||||
|
|
||||||
Please use the [pterodactyl/panel](https://github.com/pterodactyl/panel) repository to report any issues or make
|
Please use the [pterodactyl/panel](https://github.com/pterodactyl/panel) repository to report any issues or make
|
||||||
feature requests for Wings. In addition, the [security policy](https://github.com/pterodactyl/panel/security/policy) listed
|
feature requests for Wings. In addition, the [security policy](https://github.com/pterodactyl/panel/security/policy) listed
|
||||||
within that repository also applies to Wings.
|
within that repository also applies to Wings.
|
||||||
|
|||||||
@@ -65,7 +65,7 @@ func newDiagnosticsCommand() *cobra.Command {
|
|||||||
// - the docker debug output
|
// - the docker debug output
|
||||||
// - running docker containers
|
// - running docker containers
|
||||||
// - logs
|
// - logs
|
||||||
func diagnosticsCmdRun(*cobra.Command, []string) {
|
func diagnosticsCmdRun(cmd *cobra.Command, args []string) {
|
||||||
questions := []*survey.Question{
|
questions := []*survey.Question{
|
||||||
{
|
{
|
||||||
Name: "IncludeEndpoints",
|
Name: "IncludeEndpoints",
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ import (
|
|||||||
"crypto/tls"
|
"crypto/tls"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/pterodactyl/wings/internal/cron"
|
||||||
|
"github.com/pterodactyl/wings/internal/database"
|
||||||
log2 "log"
|
log2 "log"
|
||||||
"net/http"
|
"net/http"
|
||||||
_ "net/http/pprof"
|
_ "net/http/pprof"
|
||||||
@@ -28,8 +30,6 @@ import (
|
|||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/internal/cron"
|
|
||||||
"github.com/pterodactyl/wings/internal/database"
|
|
||||||
"github.com/pterodactyl/wings/loggers/cli"
|
"github.com/pterodactyl/wings/loggers/cli"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/router"
|
"github.com/pterodactyl/wings/router"
|
||||||
@@ -110,6 +110,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
log.WithField("error", err).Fatal("failed to configure system directories for pterodactyl")
|
log.WithField("error", err).Fatal("failed to configure system directories for pterodactyl")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
log.WithField("username", config.Get().System.User).Info("checking for pterodactyl system user")
|
||||||
if err := config.EnsurePterodactylUser(); err != nil {
|
if err := config.EnsurePterodactylUser(); err != nil {
|
||||||
log.WithField("error", err).Fatal("failed to create pterodactyl system user")
|
log.WithField("error", err).Fatal("failed to create pterodactyl system user")
|
||||||
}
|
}
|
||||||
@@ -362,7 +363,7 @@ func rootCmdRun(cmd *cobra.Command, _ []string) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check if main http server should run with TLS. Otherwise, reset the TLS
|
// Check if main http server should run with TLS. Otherwise reset the TLS
|
||||||
// config on the server and then serve it over normal HTTP.
|
// config on the server and then serve it over normal HTTP.
|
||||||
if api.Ssl.Enabled {
|
if api.Ssl.Enabled {
|
||||||
if err := s.ListenAndServeTLS(api.Ssl.CertificateFile, api.Ssl.KeyFile); err != nil {
|
if err := s.ListenAndServeTLS(api.Ssl.CertificateFile, api.Ssl.KeyFile); err != nil {
|
||||||
|
|||||||
@@ -16,8 +16,8 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/acobaugh/osrelease"
|
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
|
"github.com/cobaugh/osrelease"
|
||||||
"github.com/creasty/defaults"
|
"github.com/creasty/defaults"
|
||||||
"github.com/gbrlsnchs/jwt/v3"
|
"github.com/gbrlsnchs/jwt/v3"
|
||||||
"gopkg.in/yaml.v2"
|
"gopkg.in/yaml.v2"
|
||||||
@@ -91,9 +91,6 @@ type ApiConfiguration struct {
|
|||||||
|
|
||||||
// The maximum size for files uploaded through the Panel in MB.
|
// The maximum size for files uploaded through the Panel in MB.
|
||||||
UploadLimit int64 `default:"100" json:"upload_limit" yaml:"upload_limit"`
|
UploadLimit int64 `default:"100" json:"upload_limit" yaml:"upload_limit"`
|
||||||
|
|
||||||
// A list of IP address of proxies that may send a X-Forwarded-For header to set the true clients IP
|
|
||||||
TrustedProxies []string `json:"trusted_proxies" yaml:"trusted_proxies"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoteQueryConfiguration defines the configuration settings for remote requests
|
// RemoteQueryConfiguration defines the configuration settings for remote requests
|
||||||
@@ -152,23 +149,9 @@ type SystemConfiguration struct {
|
|||||||
// Definitions for the user that gets created to ensure that we can quickly access
|
// Definitions for the user that gets created to ensure that we can quickly access
|
||||||
// this information without constantly having to do a system lookup.
|
// this information without constantly having to do a system lookup.
|
||||||
User struct {
|
User struct {
|
||||||
// Rootless controls settings related to rootless container daemons.
|
Uid int
|
||||||
Rootless struct {
|
Gid int
|
||||||
// Enabled controls whether rootless containers are enabled.
|
}
|
||||||
Enabled bool `yaml:"enabled" default:"false"`
|
|
||||||
// ContainerUID controls the UID of the user inside the container.
|
|
||||||
// This should likely be set to 0 so the container runs as the user
|
|
||||||
// running Wings.
|
|
||||||
ContainerUID int `yaml:"container_uid" default:"0"`
|
|
||||||
// ContainerGID controls the GID of the user inside the container.
|
|
||||||
// This should likely be set to 0 so the container runs as the user
|
|
||||||
// running Wings.
|
|
||||||
ContainerGID int `yaml:"container_gid" default:"0"`
|
|
||||||
} `yaml:"rootless"`
|
|
||||||
|
|
||||||
Uid int `yaml:"uid"`
|
|
||||||
Gid int `yaml:"gid"`
|
|
||||||
} `yaml:"user"`
|
|
||||||
|
|
||||||
// The amount of time in seconds that can elapse before a server's disk space calculation is
|
// The amount of time in seconds that can elapse before a server's disk space calculation is
|
||||||
// considered stale and a re-check should occur. DANGER: setting this value too low can seriously
|
// considered stale and a re-check should occur. DANGER: setting this value too low can seriously
|
||||||
@@ -319,9 +302,6 @@ type Configuration struct {
|
|||||||
// is only required by users running Wings without SSL certificates and using internal IP
|
// is only required by users running Wings without SSL certificates and using internal IP
|
||||||
// addresses in order to connect. Most users should NOT enable this setting.
|
// addresses in order to connect. Most users should NOT enable this setting.
|
||||||
AllowCORSPrivateNetwork bool `json:"allow_cors_private_network" yaml:"allow_cors_private_network"`
|
AllowCORSPrivateNetwork bool `json:"allow_cors_private_network" yaml:"allow_cors_private_network"`
|
||||||
|
|
||||||
// IgnorePanelConfigUpdates causes confiuration updates that are sent by the panel to be ignored.
|
|
||||||
IgnorePanelConfigUpdates bool `json:"ignore_panel_config_updates" yaml:"ignore_panel_config_updates"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewAtPath creates a new struct and set the path where it should be stored.
|
// NewAtPath creates a new struct and set the path where it should be stored.
|
||||||
@@ -442,19 +422,6 @@ func EnsurePterodactylUser() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
if _config.System.User.Rootless.Enabled {
|
|
||||||
log.Info("rootless mode is enabled, skipping user creation...")
|
|
||||||
u, err := user.Current()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
_config.System.Username = u.Username
|
|
||||||
_config.System.User.Uid = system.MustInt(u.Uid)
|
|
||||||
_config.System.User.Gid = system.MustInt(u.Gid)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
log.WithField("username", _config.System.Username).Info("checking for pterodactyl system user")
|
|
||||||
u, err := user.Lookup(_config.System.Username)
|
u, err := user.Lookup(_config.System.Username)
|
||||||
// If an error is returned but it isn't the unknown user error just abort
|
// If an error is returned but it isn't the unknown user error just abort
|
||||||
// the process entirely. If we did find a user, return it immediately.
|
// the process entirely. If we did find a user, return it immediately.
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import (
|
|||||||
"sort"
|
"sort"
|
||||||
|
|
||||||
"github.com/docker/docker/api/types"
|
"github.com/docker/docker/api/types"
|
||||||
"github.com/docker/docker/api/types/container"
|
|
||||||
"github.com/goccy/go-json"
|
"github.com/goccy/go-json"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -79,30 +78,6 @@ type DockerConfiguration struct {
|
|||||||
Overhead Overhead `json:"overhead" yaml:"overhead"`
|
Overhead Overhead `json:"overhead" yaml:"overhead"`
|
||||||
|
|
||||||
UsePerformantInspect bool `default:"true" json:"use_performant_inspect" yaml:"use_performant_inspect"`
|
UsePerformantInspect bool `default:"true" json:"use_performant_inspect" yaml:"use_performant_inspect"`
|
||||||
|
|
||||||
// Sets the user namespace mode for the container when user namespace remapping option is
|
|
||||||
// enabled.
|
|
||||||
//
|
|
||||||
// If the value is blank, the daemon's user namespace remapping configuration is used,
|
|
||||||
// if the value is "host", then the pterodactyl containers are started with user namespace
|
|
||||||
// remapping disabled
|
|
||||||
UsernsMode string `default:"" json:"userns_mode" yaml:"userns_mode"`
|
|
||||||
|
|
||||||
LogConfig struct {
|
|
||||||
Type string `default:"local" json:"type" yaml:"type"`
|
|
||||||
Config map[string]string `default:"{\"max-size\":\"5m\",\"max-file\":\"1\",\"compress\":\"false\",\"mode\":\"non-blocking\"}" json:"config" yaml:"config"`
|
|
||||||
} `json:"log_config" yaml:"log_config"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c DockerConfiguration) ContainerLogConfig() container.LogConfig {
|
|
||||||
if c.LogConfig.Type == "" {
|
|
||||||
return container.LogConfig{}
|
|
||||||
}
|
|
||||||
|
|
||||||
return container.LogConfig{
|
|
||||||
Type: c.LogConfig.Type,
|
|
||||||
Config: c.LogConfig.Config,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// RegistryConfiguration defines the authentication credentials for a given
|
// RegistryConfiguration defines the authentication credentials for a given
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ type Settings struct {
|
|||||||
Mounts []Mount
|
Mounts []Mount
|
||||||
Allocations Allocations
|
Allocations Allocations
|
||||||
Limits Limits
|
Limits Limits
|
||||||
Labels map[string]string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Defines the actual configuration struct for the environment with all of the settings
|
// Defines the actual configuration struct for the environment with all of the settings
|
||||||
@@ -69,14 +68,6 @@ func (c *Configuration) Mounts() []Mount {
|
|||||||
return c.settings.Mounts
|
return c.settings.Mounts
|
||||||
}
|
}
|
||||||
|
|
||||||
// Labels returns the container labels associated with this instance.
|
|
||||||
func (c *Configuration) Labels() map[string]string {
|
|
||||||
c.mu.RLock()
|
|
||||||
defer c.mu.RUnlock()
|
|
||||||
|
|
||||||
return c.settings.Labels
|
|
||||||
}
|
|
||||||
|
|
||||||
// Returns the environment variables associated with this instance.
|
// Returns the environment variables associated with this instance.
|
||||||
func (c *Configuration) EnvironmentVariables() []string {
|
func (c *Configuration) EnvironmentVariables() []string {
|
||||||
c.mu.RLock()
|
c.mu.RLock()
|
||||||
|
|||||||
@@ -14,7 +14,6 @@ import (
|
|||||||
"github.com/docker/docker/client"
|
"github.com/docker/docker/client"
|
||||||
"github.com/docker/docker/errdefs"
|
"github.com/docker/docker/errdefs"
|
||||||
"github.com/goccy/go-json"
|
"github.com/goccy/go-json"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ import (
|
|||||||
"github.com/docker/docker/api/types/container"
|
"github.com/docker/docker/api/types/container"
|
||||||
"github.com/docker/docker/api/types/mount"
|
"github.com/docker/docker/api/types/mount"
|
||||||
"github.com/docker/docker/client"
|
"github.com/docker/docker/client"
|
||||||
|
"github.com/docker/docker/daemon/logger/local"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
@@ -42,13 +43,17 @@ func (nw noopWriter) Write(b []byte) (int, error) {
|
|||||||
//
|
//
|
||||||
// Calling this function will poll resources for the container in the background
|
// Calling this function will poll resources for the container in the background
|
||||||
// until the container is stopped. The context provided to this function is used
|
// until the container is stopped. The context provided to this function is used
|
||||||
// for the purposes of attaching to the container, a second context is created
|
// for the purposes of attaching to the container, a seecond context is created
|
||||||
// within the function for managing polling.
|
// within the function for managing polling.
|
||||||
func (e *Environment) Attach(ctx context.Context) error {
|
func (e *Environment) Attach(ctx context.Context) error {
|
||||||
if e.IsAttached() {
|
if e.IsAttached() {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if err := e.followOutput(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
opts := types.ContainerAttachOptions{
|
opts := types.ContainerAttachOptions{
|
||||||
Stdin: true,
|
Stdin: true,
|
||||||
Stdout: true,
|
Stdout: true,
|
||||||
@@ -58,7 +63,7 @@ func (e *Environment) Attach(ctx context.Context) error {
|
|||||||
|
|
||||||
// Set the stream again with the container.
|
// Set the stream again with the container.
|
||||||
if st, err := e.client.ContainerAttach(ctx, e.Id, opts); err != nil {
|
if st, err := e.client.ContainerAttach(ctx, e.Id, opts); err != nil {
|
||||||
return errors.WrapIf(err, "environment/docker: error while attaching to container")
|
return err
|
||||||
} else {
|
} else {
|
||||||
e.SetStream(&st)
|
e.SetStream(&st)
|
||||||
}
|
}
|
||||||
@@ -85,13 +90,20 @@ func (e *Environment) Attach(ctx context.Context) error {
|
|||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
if err := system.ScanReader(e.stream.Reader, func(v []byte) {
|
// Block the completion of this routine until the container is no longer running. This allows
|
||||||
e.logCallbackMx.Lock()
|
// the pollResources function to run until it needs to be stopped. Because the container
|
||||||
defer e.logCallbackMx.Unlock()
|
// can be polled for resource usage, even when stopped, we need to have this logic present
|
||||||
e.logCallback(v)
|
// in order to cancel the context and therefore stop the routine that is spawned.
|
||||||
}); err != nil && err != io.EOF {
|
//
|
||||||
log.WithField("error", err).WithField("container_id", e.Id).Warn("error processing scanner line in console output")
|
// For now, DO NOT use client#ContainerWait from the Docker package. There is a nasty
|
||||||
return
|
// bug causing containers to hang on deletion and cause servers to lock up on the system.
|
||||||
|
//
|
||||||
|
// This weird code isn't intuitive, but it keeps the function from ending until the container
|
||||||
|
// is stopped and therefore the stream reader ends up closed.
|
||||||
|
// @see https://github.com/moby/moby/issues/41827
|
||||||
|
c := new(noopWriter)
|
||||||
|
if _, err := io.Copy(c, e.stream.Reader); err != nil {
|
||||||
|
e.log().WithField("error", err).Error("could not copy from environment stream to noop writer")
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
@@ -143,7 +155,7 @@ func (e *Environment) Create() error {
|
|||||||
if _, err := e.ContainerInspect(ctx); err == nil {
|
if _, err := e.ContainerInspect(ctx); err == nil {
|
||||||
return nil
|
return nil
|
||||||
} else if !client.IsErrNotFound(err) {
|
} else if !client.IsErrNotFound(err) {
|
||||||
return errors.WrapIf(err, "environment/docker: failed to inspect container")
|
return errors.Wrap(err, "environment/docker: failed to inspect container")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Try to pull the requested image before creating the container.
|
// Try to pull the requested image before creating the container.
|
||||||
@@ -151,30 +163,21 @@ func (e *Environment) Create() error {
|
|||||||
return errors.WithStackIf(err)
|
return errors.WithStackIf(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg := config.Get()
|
|
||||||
a := e.Configuration.Allocations()
|
a := e.Configuration.Allocations()
|
||||||
|
|
||||||
evs := e.Configuration.EnvironmentVariables()
|
evs := e.Configuration.EnvironmentVariables()
|
||||||
for i, v := range evs {
|
for i, v := range evs {
|
||||||
// Convert 127.0.0.1 to the pterodactyl0 network interface if the environment is Docker
|
// Convert 127.0.0.1 to the pterodactyl0 network interface if the environment is Docker
|
||||||
// so that the server operates as expected.
|
// so that the server operates as expected.
|
||||||
if v == "SERVER_IP=127.0.0.1" {
|
if v == "SERVER_IP=127.0.0.1" {
|
||||||
evs[i] = "SERVER_IP=" + cfg.Docker.Network.Interface
|
evs[i] = "SERVER_IP=" + config.Get().Docker.Network.Interface
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Merge user-provided labels with system labels
|
|
||||||
confLabels := e.Configuration.Labels()
|
|
||||||
labels := make(map[string]string, 2+len(confLabels))
|
|
||||||
|
|
||||||
for key := range confLabels {
|
|
||||||
labels[key] = confLabels[key]
|
|
||||||
}
|
|
||||||
labels["Service"] = "Pterodactyl"
|
|
||||||
labels["ContainerType"] = "server_process"
|
|
||||||
|
|
||||||
conf := &container.Config{
|
conf := &container.Config{
|
||||||
Hostname: e.Id,
|
Hostname: e.Id,
|
||||||
Domainname: cfg.Docker.Domainname,
|
Domainname: config.Get().Docker.Domainname,
|
||||||
|
User: strconv.Itoa(config.Get().System.User.Uid) + ":" + strconv.Itoa(config.Get().System.User.Gid),
|
||||||
AttachStdin: true,
|
AttachStdin: true,
|
||||||
AttachStdout: true,
|
AttachStdout: true,
|
||||||
AttachStderr: true,
|
AttachStderr: true,
|
||||||
@@ -183,20 +186,16 @@ func (e *Environment) Create() error {
|
|||||||
ExposedPorts: a.Exposed(),
|
ExposedPorts: a.Exposed(),
|
||||||
Image: strings.TrimPrefix(e.meta.Image, "~"),
|
Image: strings.TrimPrefix(e.meta.Image, "~"),
|
||||||
Env: e.Configuration.EnvironmentVariables(),
|
Env: e.Configuration.EnvironmentVariables(),
|
||||||
Labels: labels,
|
Labels: map[string]string{
|
||||||
|
"Service": "Pterodactyl",
|
||||||
|
"ContainerType": "server_process",
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set the user running the container properly depending on what mode we are operating in.
|
networkMode := container.NetworkMode(config.Get().Docker.Network.Mode)
|
||||||
if cfg.System.User.Rootless.Enabled {
|
|
||||||
conf.User = fmt.Sprintf("%d:%d", cfg.System.User.Rootless.ContainerUID, cfg.System.User.Rootless.ContainerGID)
|
|
||||||
} else {
|
|
||||||
conf.User = strconv.Itoa(cfg.System.User.Uid) + ":" + strconv.Itoa(cfg.System.User.Gid)
|
|
||||||
}
|
|
||||||
|
|
||||||
networkMode := container.NetworkMode(cfg.Docker.Network.Mode)
|
|
||||||
if a.ForceOutgoingIP {
|
if a.ForceOutgoingIP {
|
||||||
e.log().Debug("environment/docker: forcing outgoing IP address")
|
e.log().Debug("environment/docker: forcing outgoing IP address")
|
||||||
networkName := "ip-" + strings.ReplaceAll(strings.ReplaceAll(a.DefaultMapping.Ip, ".", "-"), ":", "-")
|
networkName := strings.ReplaceAll(e.Id, "-", "")
|
||||||
networkMode = container.NetworkMode(networkName)
|
networkMode = container.NetworkMode(networkName)
|
||||||
|
|
||||||
if _, err := e.client.NetworkInspect(ctx, networkName, types.NetworkInspectOptions{}); err != nil {
|
if _, err := e.client.NetworkInspect(ctx, networkName, types.NetworkInspectOptions{}); err != nil {
|
||||||
@@ -232,20 +231,28 @@ func (e *Environment) Create() error {
|
|||||||
// Configure the /tmp folder mapping in containers. This is necessary for some
|
// Configure the /tmp folder mapping in containers. This is necessary for some
|
||||||
// games that need to make use of it for downloads and other installation processes.
|
// games that need to make use of it for downloads and other installation processes.
|
||||||
Tmpfs: map[string]string{
|
Tmpfs: map[string]string{
|
||||||
"/tmp": "rw,exec,nosuid,size=" + strconv.Itoa(int(cfg.Docker.TmpfsSize)) + "M",
|
"/tmp": "rw,exec,nosuid,size=" + strconv.Itoa(int(config.Get().Docker.TmpfsSize)) + "M",
|
||||||
},
|
},
|
||||||
|
|
||||||
// Define resource limits for the container based on the data passed through
|
// Define resource limits for the container based on the data passed through
|
||||||
// from the Panel.
|
// from the Panel.
|
||||||
Resources: e.Configuration.Limits().AsContainerResources(),
|
Resources: e.Configuration.Limits().AsContainerResources(),
|
||||||
|
|
||||||
DNS: cfg.Docker.Network.Dns,
|
DNS: config.Get().Docker.Network.Dns,
|
||||||
|
|
||||||
// Configure logging for the container to make it easier on the Daemon to grab
|
// Configure logging for the container to make it easier on the Daemon to grab
|
||||||
// the server output. Ensure that we don't use too much space on the host machine
|
// the server output. Ensure that we don't use too much space on the host machine
|
||||||
// since we only need it for the last few hundred lines of output and don't care
|
// since we only need it for the last few hundred lines of output and don't care
|
||||||
// about anything else in it.
|
// about anything else in it.
|
||||||
LogConfig: cfg.Docker.ContainerLogConfig(),
|
LogConfig: container.LogConfig{
|
||||||
|
Type: local.Name,
|
||||||
|
Config: map[string]string{
|
||||||
|
"max-size": "5m",
|
||||||
|
"max-file": "1",
|
||||||
|
"compress": "false",
|
||||||
|
"mode": "non-blocking",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
|
||||||
SecurityOpt: []string{"no-new-privileges"},
|
SecurityOpt: []string{"no-new-privileges"},
|
||||||
ReadonlyRootfs: true,
|
ReadonlyRootfs: true,
|
||||||
@@ -254,7 +261,6 @@ func (e *Environment) Create() error {
|
|||||||
"fowner", "fsetid", "net_bind_service", "sys_chroot", "setfcap",
|
"fowner", "fsetid", "net_bind_service", "sys_chroot", "setfcap",
|
||||||
},
|
},
|
||||||
NetworkMode: networkMode,
|
NetworkMode: networkMode,
|
||||||
UsernsMode: container.UsernsMode(cfg.Docker.UsernsMode),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if _, err := e.client.ContainerCreate(ctx, conf, hostConf, nil, nil, e.Id); err != nil {
|
if _, err := e.client.ContainerCreate(ctx, conf, hostConf, nil, nil, e.Id); err != nil {
|
||||||
@@ -335,6 +341,59 @@ func (e *Environment) Readlog(lines int) ([]string, error) {
|
|||||||
return out, nil
|
return out, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Attaches to the log for the container. This avoids us missing crucial output
|
||||||
|
// that happens in the split seconds before the code moves from 'Starting' to
|
||||||
|
// 'Attaching' on the process.
|
||||||
|
func (e *Environment) followOutput() error {
|
||||||
|
if exists, err := e.Exists(); !exists {
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return errors.New(fmt.Sprintf("no such container: %s", e.Id))
|
||||||
|
}
|
||||||
|
|
||||||
|
opts := types.ContainerLogsOptions{
|
||||||
|
ShowStderr: true,
|
||||||
|
ShowStdout: true,
|
||||||
|
Follow: true,
|
||||||
|
Since: time.Now().Format(time.RFC3339),
|
||||||
|
}
|
||||||
|
|
||||||
|
reader, err := e.client.ContainerLogs(context.Background(), e.Id, opts)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
go e.scanOutput(reader)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Environment) scanOutput(reader io.ReadCloser) {
|
||||||
|
defer reader.Close()
|
||||||
|
|
||||||
|
if err := system.ScanReader(reader, func(v []byte) {
|
||||||
|
e.logCallbackMx.Lock()
|
||||||
|
defer e.logCallbackMx.Unlock()
|
||||||
|
e.logCallback(v)
|
||||||
|
}); err != nil && err != io.EOF {
|
||||||
|
log.WithField("error", err).WithField("container_id", e.Id).Warn("error processing scanner line in console output")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return here if the server is offline or currently stopping.
|
||||||
|
if e.State() == environment.ProcessStoppingState || e.State() == environment.ProcessOfflineState {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close the current reader before starting a new one, the defer will still run,
|
||||||
|
// but it will do nothing if we already closed the stream.
|
||||||
|
_ = reader.Close()
|
||||||
|
|
||||||
|
// Start following the output of the server again.
|
||||||
|
go e.followOutput()
|
||||||
|
}
|
||||||
|
|
||||||
// Pulls the image from Docker. If there is an error while pulling the image
|
// Pulls the image from Docker. If there is an error while pulling the image
|
||||||
// from the source but the image already exists locally, we will report that
|
// from the source but the image already exists locally, we will report that
|
||||||
// error to the logger but continue with the process.
|
// error to the logger but continue with the process.
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ import (
|
|||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/docker/docker/api/types"
|
"github.com/docker/docker/api/types"
|
||||||
"github.com/docker/docker/client"
|
"github.com/docker/docker/client"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/events"
|
"github.com/pterodactyl/wings/events"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
@@ -96,7 +95,7 @@ func (e *Environment) SetStream(s *types.HijackedResponse) {
|
|||||||
e.mu.Unlock()
|
e.mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsAttached determines if this process is currently attached to the
|
// IsAttached determine if the this process is currently attached to the
|
||||||
// container instance by checking if the stream is nil or not.
|
// container instance by checking if the stream is nil or not.
|
||||||
func (e *Environment) IsAttached() bool {
|
func (e *Environment) IsAttached() bool {
|
||||||
e.mu.RLock()
|
e.mu.RLock()
|
||||||
@@ -161,7 +160,7 @@ func (e *Environment) ExitState() (uint32, bool, error) {
|
|||||||
if client.IsErrNotFound(err) {
|
if client.IsErrNotFound(err) {
|
||||||
return 1, false, nil
|
return 1, false, nil
|
||||||
}
|
}
|
||||||
return 0, false, errors.WrapIf(err, "environment/docker: failed to inspect container")
|
return 0, false, err
|
||||||
}
|
}
|
||||||
return uint32(c.State.ExitCode), c.State.OOMKilled, nil
|
return uint32(c.State.ExitCode), c.State.OOMKilled, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ func (e *Environment) OnBeforeStart(ctx context.Context) error {
|
|||||||
//
|
//
|
||||||
// This won't actually run an installation process however, it is just here to ensure the
|
// This won't actually run an installation process however, it is just here to ensure the
|
||||||
// environment gets created properly if it is missing and the server is started. We're making
|
// environment gets created properly if it is missing and the server is started. We're making
|
||||||
// an assumption that all the files will still exist at this point.
|
// an assumption that all of the files will still exist at this point.
|
||||||
if err := e.Create(); err != nil {
|
if err := e.Create(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -103,11 +103,11 @@ func (e *Environment) Start(ctx context.Context) error {
|
|||||||
// exists on the system, and rebuild the container if that is required for server booting to
|
// exists on the system, and rebuild the container if that is required for server booting to
|
||||||
// occur.
|
// occur.
|
||||||
if err := e.OnBeforeStart(ctx); err != nil {
|
if err := e.OnBeforeStart(ctx); err != nil {
|
||||||
return errors.WrapIf(err, "environment/docker: failed to run pre-boot process")
|
return errors.WithStackIf(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// If we cannot start & attach to the container in 30 seconds something has gone
|
// If we cannot start & attach to the container in 30 seconds something has gone
|
||||||
// quite sideways, and we should stop trying to avoid a hanging situation.
|
// quite sideways and we should stop trying to avoid a hanging situation.
|
||||||
actx, cancel := context.WithTimeout(ctx, time.Second*30)
|
actx, cancel := context.WithTimeout(ctx, time.Second*30)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
@@ -119,7 +119,7 @@ func (e *Environment) Start(ctx context.Context) error {
|
|||||||
// By explicitly attaching to the instance before we start it, we can immediately
|
// By explicitly attaching to the instance before we start it, we can immediately
|
||||||
// react to errors/output stopping/etc. when starting.
|
// react to errors/output stopping/etc. when starting.
|
||||||
if err := e.Attach(actx); err != nil {
|
if err := e.Attach(actx); err != nil {
|
||||||
return errors.WrapIf(err, "environment/docker: failed to attach to container")
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := e.client.ContainerStart(actx, e.Id, types.ContainerStartOptions{}); err != nil {
|
if err := e.client.ContainerStart(actx, e.Id, types.ContainerStartOptions{}); err != nil {
|
||||||
@@ -179,12 +179,8 @@ func (e *Environment) Stop(ctx context.Context) error {
|
|||||||
|
|
||||||
// Allow the stop action to run for however long it takes, similar to executing a command
|
// Allow the stop action to run for however long it takes, similar to executing a command
|
||||||
// and using a different logic pathway to wait for the container to stop successfully.
|
// and using a different logic pathway to wait for the container to stop successfully.
|
||||||
//
|
t := time.Duration(-1)
|
||||||
// Using a negative timeout here will allow the container to stop gracefully,
|
if err := e.client.ContainerStop(ctx, e.Id, &t); err != nil {
|
||||||
// rather than forcefully terminating it. Value is in seconds, but -1 is
|
|
||||||
// treated as indefinitely.
|
|
||||||
timeout := -1
|
|
||||||
if err := e.client.ContainerStop(ctx, e.Id, container.StopOptions{Timeout: &timeout}); err != nil {
|
|
||||||
// If the container does not exist just mark the process as stopped and return without
|
// If the container does not exist just mark the process as stopped and return without
|
||||||
// an error.
|
// an error.
|
||||||
if client.IsErrNotFound(err) {
|
if client.IsErrNotFound(err) {
|
||||||
|
|||||||
@@ -134,11 +134,7 @@ func calculateDockerAbsoluteCpu(pStats types.CPUStats, stats types.CPUStats) flo
|
|||||||
|
|
||||||
percent := 0.0
|
percent := 0.0
|
||||||
if systemDelta > 0.0 && cpuDelta > 0.0 {
|
if systemDelta > 0.0 && cpuDelta > 0.0 {
|
||||||
percent = (cpuDelta / systemDelta) * 100.0
|
percent = (cpuDelta / systemDelta) * cpus * 100.0
|
||||||
|
|
||||||
if cpus > 0 {
|
|
||||||
percent *= cpus
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return math.Round(percent*1000) / 1000
|
return math.Round(percent*1000) / 1000
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import (
|
|||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/goccy/go-json"
|
"github.com/goccy/go-json"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
172
go.mod
172
go.mod
@@ -1,123 +1,129 @@
|
|||||||
module github.com/pterodactyl/wings
|
module github.com/pterodactyl/wings
|
||||||
|
|
||||||
go 1.18
|
go 1.17
|
||||||
|
|
||||||
require (
|
require (
|
||||||
emperror.dev/errors v0.8.1
|
emperror.dev/errors v0.8.1
|
||||||
github.com/AlecAivazis/survey/v2 v2.3.6
|
github.com/AlecAivazis/survey/v2 v2.3.4
|
||||||
github.com/Jeffail/gabs/v2 v2.7.0
|
github.com/Jeffail/gabs/v2 v2.6.1
|
||||||
github.com/NYTimes/logrotate v1.0.0
|
github.com/NYTimes/logrotate v1.0.0
|
||||||
github.com/acobaugh/osrelease v0.1.0
|
|
||||||
github.com/apex/log v1.9.0
|
github.com/apex/log v1.9.0
|
||||||
github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2
|
github.com/asaskevich/govalidator v0.0.0-20210307081110-f21760c49a8d
|
||||||
github.com/beevik/etree v1.1.4
|
github.com/beevik/etree v1.1.0
|
||||||
github.com/buger/jsonparser v1.1.1
|
github.com/buger/jsonparser v1.1.1
|
||||||
github.com/cenkalti/backoff/v4 v4.2.1
|
github.com/cenkalti/backoff/v4 v4.1.2
|
||||||
github.com/creasty/defaults v1.7.0
|
github.com/cobaugh/osrelease v0.0.0-20181218015638-a93a0a55a249
|
||||||
github.com/docker/docker v23.0.6+incompatible
|
github.com/creasty/defaults v1.5.2
|
||||||
|
github.com/docker/docker v20.10.14+incompatible
|
||||||
github.com/docker/go-connections v0.4.0
|
github.com/docker/go-connections v0.4.0
|
||||||
github.com/fatih/color v1.15.0
|
github.com/fatih/color v1.13.0
|
||||||
github.com/franela/goblin v0.0.0-20211003143422-0a4f594942bf
|
github.com/franela/goblin v0.0.0-20200825194134-80c0062ed6cd
|
||||||
github.com/gabriel-vasile/mimetype v1.4.2
|
github.com/gabriel-vasile/mimetype v1.4.0
|
||||||
github.com/gammazero/workerpool v1.1.3
|
github.com/gammazero/workerpool v1.1.2
|
||||||
github.com/gbrlsnchs/jwt/v3 v3.0.1
|
github.com/gbrlsnchs/jwt/v3 v3.0.1
|
||||||
github.com/gin-gonic/gin v1.9.0
|
github.com/gin-gonic/gin v1.7.7
|
||||||
github.com/glebarez/sqlite v1.8.0
|
|
||||||
github.com/go-co-op/gocron v1.25.0
|
|
||||||
github.com/goccy/go-json v0.10.2
|
|
||||||
github.com/google/uuid v1.3.0
|
github.com/google/uuid v1.3.0
|
||||||
github.com/gorilla/websocket v1.5.0
|
github.com/gorilla/websocket v1.5.0
|
||||||
github.com/iancoleman/strcase v0.2.0
|
github.com/iancoleman/strcase v0.2.0
|
||||||
github.com/icza/dyno v0.0.0-20230330125955-09f820a8d9c0
|
github.com/icza/dyno v0.0.0-20210726202311-f1bafe5d9996
|
||||||
github.com/juju/ratelimit v1.0.2
|
github.com/juju/ratelimit v1.0.1
|
||||||
github.com/karrick/godirwalk v1.17.0
|
github.com/karrick/godirwalk v1.16.1
|
||||||
github.com/klauspost/compress v1.16.5
|
github.com/klauspost/pgzip v1.2.5
|
||||||
github.com/klauspost/pgzip v1.2.6
|
github.com/magiconair/properties v1.8.6
|
||||||
github.com/magiconair/properties v1.8.7
|
github.com/mattn/go-colorable v0.1.12
|
||||||
github.com/mattn/go-colorable v0.1.13
|
github.com/mholt/archiver/v3 v3.5.1
|
||||||
github.com/mholt/archiver/v4 v4.0.0-alpha.8
|
|
||||||
github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
|
github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db
|
||||||
github.com/patrickmn/go-cache v2.1.0+incompatible
|
github.com/patrickmn/go-cache v2.1.0+incompatible
|
||||||
github.com/pkg/sftp v1.13.5
|
github.com/pkg/sftp v1.13.4
|
||||||
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06
|
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06
|
||||||
github.com/spf13/cobra v1.7.0
|
github.com/spf13/cobra v1.4.0
|
||||||
github.com/stretchr/testify v1.8.2
|
github.com/stretchr/testify v1.7.5
|
||||||
golang.org/x/crypto v0.8.0
|
golang.org/x/crypto v0.0.0-20220321153916-2c7772ba3064
|
||||||
golang.org/x/sync v0.2.0
|
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
|
||||||
gopkg.in/ini.v1 v1.67.0
|
gopkg.in/ini.v1 v1.66.4
|
||||||
gopkg.in/yaml.v2 v2.4.0
|
gopkg.in/yaml.v2 v2.4.0
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
|
||||||
gorm.io/gorm v1.25.1
|
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/Microsoft/go-winio v0.6.1 // indirect
|
github.com/glebarez/sqlite v1.4.6
|
||||||
github.com/Microsoft/hcsshim v0.9.9 // indirect
|
github.com/go-co-op/gocron v1.15.0
|
||||||
github.com/andybalholm/brotli v1.0.5 // indirect
|
github.com/goccy/go-json v0.9.6
|
||||||
github.com/bodgit/plumbing v1.3.0 // indirect
|
github.com/klauspost/compress v1.15.1
|
||||||
github.com/bodgit/sevenzip v1.4.1 // indirect
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
github.com/bodgit/windows v1.0.1 // indirect
|
gorm.io/gorm v1.23.8
|
||||||
github.com/bytedance/sonic v1.8.8 // indirect
|
)
|
||||||
github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect
|
|
||||||
|
require golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
|
||||||
|
github.com/Microsoft/go-winio v0.5.2 // indirect
|
||||||
|
github.com/Microsoft/hcsshim v0.9.2 // indirect
|
||||||
|
github.com/andybalholm/brotli v1.0.4 // indirect
|
||||||
|
github.com/beorn7/perks v1.0.1 // indirect
|
||||||
|
github.com/cespare/xxhash/v2 v2.1.2 // indirect
|
||||||
|
github.com/containerd/containerd v1.6.2 // indirect
|
||||||
|
github.com/containerd/fifo v1.0.0 // indirect
|
||||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||||
github.com/docker/distribution v2.8.1+incompatible // indirect
|
github.com/docker/distribution v2.8.1+incompatible // indirect
|
||||||
github.com/docker/go-units v0.5.0 // indirect
|
github.com/docker/go-metrics v0.0.1 // indirect
|
||||||
|
github.com/docker/go-units v0.4.0 // indirect
|
||||||
github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 // indirect
|
github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 // indirect
|
||||||
github.com/dustin/go-humanize v1.0.1 // indirect
|
github.com/fsnotify/fsnotify v1.5.1 // indirect
|
||||||
github.com/gammazero/deque v0.2.1 // indirect
|
github.com/gammazero/deque v0.1.1 // indirect
|
||||||
github.com/gin-contrib/sse v0.1.0 // indirect
|
github.com/gin-contrib/sse v0.1.0 // indirect
|
||||||
github.com/glebarez/go-sqlite v1.21.1 // indirect
|
github.com/glebarez/go-sqlite v1.17.3 // indirect
|
||||||
github.com/go-playground/locales v0.14.1 // indirect
|
github.com/go-playground/locales v0.14.0 // indirect
|
||||||
github.com/go-playground/universal-translator v0.18.1 // indirect
|
github.com/go-playground/universal-translator v0.18.0 // indirect
|
||||||
github.com/go-playground/validator/v10 v10.13.0 // indirect
|
github.com/go-playground/validator/v10 v10.10.1 // indirect
|
||||||
github.com/gogo/protobuf v1.3.2 // indirect
|
github.com/gogo/protobuf v1.3.2 // indirect
|
||||||
|
github.com/golang/protobuf v1.5.2 // indirect
|
||||||
github.com/golang/snappy v0.0.4 // indirect
|
github.com/golang/snappy v0.0.4 // indirect
|
||||||
github.com/google/go-cmp v0.5.9 // indirect
|
github.com/gorilla/mux v1.7.4 // indirect
|
||||||
github.com/hashicorp/errwrap v1.1.0 // indirect
|
github.com/inconshreveable/mousetrap v1.0.0 // indirect
|
||||||
github.com/hashicorp/go-multierror v1.1.1 // indirect
|
|
||||||
github.com/inconshreveable/mousetrap v1.1.0 // indirect
|
|
||||||
github.com/jinzhu/inflection v1.0.0 // indirect
|
github.com/jinzhu/inflection v1.0.0 // indirect
|
||||||
github.com/jinzhu/now v1.1.5 // indirect
|
github.com/jinzhu/now v1.1.5 // indirect
|
||||||
github.com/json-iterator/go v1.1.12 // indirect
|
github.com/json-iterator/go v1.1.12 // indirect
|
||||||
github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
|
github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
|
||||||
github.com/klauspost/cpuid/v2 v2.2.4 // indirect
|
|
||||||
github.com/kr/fs v0.1.0 // indirect
|
github.com/kr/fs v0.1.0 // indirect
|
||||||
github.com/leodido/go-urn v1.2.4 // indirect
|
github.com/leodido/go-urn v1.2.1 // indirect
|
||||||
github.com/magefile/mage v1.14.0 // indirect
|
github.com/magefile/mage v1.13.0 // indirect
|
||||||
github.com/mattn/go-isatty v0.0.18 // indirect
|
github.com/mattn/go-isatty v0.0.14 // indirect
|
||||||
|
github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
|
||||||
github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
|
github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
|
||||||
github.com/moby/term v0.0.0-20220808134915-39b0c02b01ae // indirect
|
github.com/moby/term v0.0.0-20210619224110-3f7ff695adc6 // indirect
|
||||||
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
|
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
|
||||||
github.com/modern-go/reflect2 v1.0.2 // indirect
|
github.com/modern-go/reflect2 v1.0.2 // indirect
|
||||||
github.com/nwaples/rardecode/v2 v2.0.0-beta.2 // indirect
|
github.com/morikuni/aec v1.0.0 // indirect
|
||||||
|
github.com/nwaples/rardecode v1.1.3 // indirect
|
||||||
github.com/opencontainers/go-digest v1.0.0 // indirect
|
github.com/opencontainers/go-digest v1.0.0 // indirect
|
||||||
github.com/opencontainers/image-spec v1.1.0-rc3 // indirect
|
github.com/opencontainers/image-spec v1.0.2 // indirect
|
||||||
github.com/pelletier/go-toml/v2 v2.0.7 // indirect
|
github.com/pierrec/lz4/v4 v4.1.14 // indirect
|
||||||
github.com/pierrec/lz4/v4 v4.1.17 // indirect
|
|
||||||
github.com/pkg/errors v0.9.1 // indirect
|
github.com/pkg/errors v0.9.1 // indirect
|
||||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||||
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
|
github.com/prometheus/client_golang v1.12.1 // indirect
|
||||||
|
github.com/prometheus/client_model v0.2.0 // indirect
|
||||||
|
github.com/prometheus/common v0.32.1 // indirect
|
||||||
|
github.com/prometheus/procfs v0.7.3 // indirect
|
||||||
|
github.com/remyoudompheng/bigfft v0.0.0-20200410134404-eec4a21b6bb0 // indirect
|
||||||
github.com/robfig/cron/v3 v3.0.1 // indirect
|
github.com/robfig/cron/v3 v3.0.1 // indirect
|
||||||
github.com/sirupsen/logrus v1.9.0 // indirect
|
github.com/sirupsen/logrus v1.8.1 // indirect
|
||||||
github.com/spf13/pflag v1.0.5 // indirect
|
github.com/spf13/pflag v1.0.5 // indirect
|
||||||
github.com/therootcompany/xz v1.0.1 // indirect
|
github.com/ugorji/go/codec v1.2.7 // indirect
|
||||||
github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
|
github.com/ulikunitz/xz v0.5.10 // indirect
|
||||||
github.com/ugorji/go/codec v1.2.11 // indirect
|
github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
|
||||||
github.com/ulikunitz/xz v0.5.11 // indirect
|
go.uber.org/atomic v1.9.0 // indirect
|
||||||
go.uber.org/multierr v1.11.0 // indirect
|
go.uber.org/multierr v1.8.0 // indirect
|
||||||
go4.org v0.0.0-20230225012048-214862532bf5 // indirect
|
golang.org/x/net v0.0.0-20220225172249-27dd8689420f // indirect
|
||||||
golang.org/x/arch v0.3.0 // indirect
|
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 // indirect
|
||||||
golang.org/x/mod v0.10.0 // indirect
|
golang.org/x/text v0.3.7 // indirect
|
||||||
golang.org/x/net v0.10.0 // indirect
|
golang.org/x/time v0.0.0-20220224211638-0e9765cccd65 // indirect
|
||||||
golang.org/x/sys v0.8.0 // indirect
|
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
|
||||||
golang.org/x/term v0.8.0 // indirect
|
google.golang.org/genproto v0.0.0-20220324131243-acbaeb5b85eb // indirect
|
||||||
golang.org/x/text v0.9.0 // indirect
|
google.golang.org/grpc v1.45.0 // indirect
|
||||||
golang.org/x/time v0.0.0-20220922220347-f3bd1da661af // indirect
|
google.golang.org/protobuf v1.28.0 // indirect
|
||||||
golang.org/x/tools v0.8.0 // indirect
|
modernc.org/libc v1.16.17 // indirect
|
||||||
golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
|
modernc.org/mathutil v1.4.1 // indirect
|
||||||
google.golang.org/protobuf v1.30.0 // indirect
|
modernc.org/memory v1.1.1 // indirect
|
||||||
modernc.org/libc v1.22.5 // indirect
|
modernc.org/sqlite v1.17.3 // indirect
|
||||||
modernc.org/mathutil v1.5.0 // indirect
|
|
||||||
modernc.org/memory v1.5.0 // indirect
|
|
||||||
modernc.org/sqlite v1.22.1 // indirect
|
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import (
|
|||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/asaskevich/govalidator"
|
"github.com/asaskevich/govalidator"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
)
|
)
|
||||||
@@ -2,10 +2,7 @@ package cron
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"net"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/internal/database"
|
"github.com/pterodactyl/wings/internal/database"
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
"github.com/pterodactyl/wings/internal/models"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
@@ -18,9 +15,9 @@ type activityCron struct {
|
|||||||
max int
|
max int
|
||||||
}
|
}
|
||||||
|
|
||||||
// Run executes the cronjob and ensures we fetch and send all the stored activity to the
|
// Run executes the cronjob and ensures we fetch and send all of the stored activity to the
|
||||||
// Panel instance. Once activity is sent it is deleted from the local database instance. Any
|
// Panel instance. Once activity is sent it is deleted from the local database instance. Any
|
||||||
// SFTP specific events are not handled in this cron, they're handled separately to account
|
// SFTP specific events are not handled in this cron, they're handled seperately to account
|
||||||
// for de-duplication and event merging.
|
// for de-duplication and event merging.
|
||||||
func (ac *activityCron) Run(ctx context.Context) error {
|
func (ac *activityCron) Run(ctx context.Context) error {
|
||||||
// Don't execute this cron if there is currently one running. Once this task is completed
|
// Don't execute this cron if there is currently one running. Once this task is completed
|
||||||
@@ -35,6 +32,7 @@ func (ac *activityCron) Run(ctx context.Context) error {
|
|||||||
Where("event NOT LIKE ?", "server:sftp.%").
|
Where("event NOT LIKE ?", "server:sftp.%").
|
||||||
Limit(ac.max).
|
Limit(ac.max).
|
||||||
Find(&activity)
|
Find(&activity)
|
||||||
|
|
||||||
if tx.Error != nil {
|
if tx.Error != nil {
|
||||||
return errors.WithStack(tx.Error)
|
return errors.WithStack(tx.Error)
|
||||||
}
|
}
|
||||||
@@ -42,42 +40,15 @@ func (ac *activityCron) Run(ctx context.Context) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ids to delete from the database.
|
if err := ac.manager.Client().SendActivityLogs(ctx, activity); err != nil {
|
||||||
ids := make([]int, 0, len(activity))
|
|
||||||
// activities to send to the panel.
|
|
||||||
activities := make([]models.Activity, 0, len(activity))
|
|
||||||
for _, v := range activity {
|
|
||||||
// Delete any activity that has an invalid IP address. This is a fix for
|
|
||||||
// a bug that truncated the last octet of an IPv6 address in the database.
|
|
||||||
if ip := net.ParseIP(v.IP); ip == nil {
|
|
||||||
ids = append(ids, v.ID)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
activities = append(activities, v)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(ids) > 0 {
|
|
||||||
tx = database.Instance().WithContext(ctx).Where("id IN ?", ids).Delete(&models.Activity{})
|
|
||||||
if tx.Error != nil {
|
|
||||||
return errors.WithStack(tx.Error)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(activities) == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := ac.manager.Client().SendActivityLogs(ctx, activities); err != nil {
|
|
||||||
return errors.WrapIf(err, "cron: failed to send activity events to Panel")
|
return errors.WrapIf(err, "cron: failed to send activity events to Panel")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add all the successful activities to the list of IDs to delete.
|
var ids []int
|
||||||
ids = make([]int, len(activities))
|
for _, v := range activity {
|
||||||
for i, v := range activities {
|
ids = append(ids, v.ID)
|
||||||
ids[i] = v.ID
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Delete all the activities that were sent to the Panel (or that were invalid).
|
|
||||||
tx = database.Instance().WithContext(ctx).Where("id IN ?", ids).Delete(&models.Activity{})
|
tx = database.Instance().WithContext(ctx).Where("id IN ?", ids).Delete(&models.Activity{})
|
||||||
if tx.Error != nil {
|
if tx.Error != nil {
|
||||||
return errors.WithStack(tx.Error)
|
return errors.WithStack(tx.Error)
|
||||||
|
|||||||
@@ -2,15 +2,13 @@ package cron
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
log2 "github.com/apex/log"
|
||||||
"github.com/go-co-op/gocron"
|
"github.com/go-co-op/gocron"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
const ErrCronRunning = errors.Sentinel("cron: job already running")
|
const ErrCronRunning = errors.Sentinel("cron: job already running")
|
||||||
@@ -24,7 +22,7 @@ func Scheduler(ctx context.Context, m *server.Manager) (*gocron.Scheduler, error
|
|||||||
if !o.SwapIf(true) {
|
if !o.SwapIf(true) {
|
||||||
return nil, errors.New("cron: cannot call scheduler more than once in application lifecycle")
|
return nil, errors.New("cron: cannot call scheduler more than once in application lifecycle")
|
||||||
}
|
}
|
||||||
location, err := time.LoadLocation(config.Get().System.Timezone)
|
l, err := time.LoadLocation(config.Get().System.Timezone)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, errors.Wrap(err, "cron: failed to parse configured system timezone")
|
return nil, errors.Wrap(err, "cron: failed to parse configured system timezone")
|
||||||
}
|
}
|
||||||
@@ -41,30 +39,30 @@ func Scheduler(ctx context.Context, m *server.Manager) (*gocron.Scheduler, error
|
|||||||
max: config.Get().System.ActivitySendCount,
|
max: config.Get().System.ActivitySendCount,
|
||||||
}
|
}
|
||||||
|
|
||||||
s := gocron.NewScheduler(location)
|
s := gocron.NewScheduler(l)
|
||||||
l := log.WithField("subsystem", "cron")
|
log := log2.WithField("subsystem", "cron")
|
||||||
|
|
||||||
interval := time.Duration(config.Get().System.ActivitySendInterval) * time.Second
|
interval := time.Duration(config.Get().System.ActivitySendInterval) * time.Second
|
||||||
l.WithField("interval", interval).Info("configuring system crons")
|
log.WithField("interval", interval).Info("configuring system crons")
|
||||||
|
|
||||||
_, _ = s.Tag("activity").Every(interval).Do(func() {
|
_, _ = s.Tag("activity").Every(interval).Do(func() {
|
||||||
l.WithField("cron", "activity").Debug("sending internal activity events to Panel")
|
log.WithField("cron", "activity").Debug("sending internal activity events to Panel")
|
||||||
if err := activity.Run(ctx); err != nil {
|
if err := activity.Run(ctx); err != nil {
|
||||||
if errors.Is(err, ErrCronRunning) {
|
if errors.Is(err, ErrCronRunning) {
|
||||||
l.WithField("cron", "activity").Warn("activity process is already running, skipping...")
|
log.WithField("cron", "activity").Warn("activity process is already running, skipping...")
|
||||||
} else {
|
} else {
|
||||||
l.WithField("cron", "activity").WithField("error", err).Error("activity process failed to execute")
|
log.WithField("cron", "activity").WithField("error", err).Error("activity process failed to execute")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
_, _ = s.Tag("sftp").Every(interval).Do(func() {
|
_, _ = s.Tag("sftp").Every(interval).Do(func() {
|
||||||
l.WithField("cron", "sftp").Debug("sending sftp events to Panel")
|
log.WithField("cron", "sftp").Debug("sending sftp events to Panel")
|
||||||
if err := sftp.Run(ctx); err != nil {
|
if err := sftp.Run(ctx); err != nil {
|
||||||
if errors.Is(err, ErrCronRunning) {
|
if errors.Is(err, ErrCronRunning) {
|
||||||
l.WithField("cron", "sftp").Warn("sftp events process already running, skipping...")
|
log.WithField("cron", "sftp").Warn("sftp events process already running, skipping...")
|
||||||
} else {
|
} else {
|
||||||
l.WithField("cron", "sftp").WithField("error", err).Error("sftp events process failed to execute")
|
log.WithField("cron", "sftp").WithField("error", err).Error("sftp events process failed to execute")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -2,14 +2,12 @@ package cron
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"reflect"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/internal/database"
|
"github.com/pterodactyl/wings/internal/database"
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
"github.com/pterodactyl/wings/internal/models"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
"reflect"
|
||||||
)
|
)
|
||||||
|
|
||||||
type sftpCron struct {
|
type sftpCron struct {
|
||||||
|
|||||||
@@ -1,23 +1,19 @@
|
|||||||
package database
|
package database
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"path/filepath"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/glebarez/sqlite"
|
"github.com/glebarez/sqlite"
|
||||||
"gorm.io/gorm"
|
|
||||||
"gorm.io/gorm/logger"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
"github.com/pterodactyl/wings/internal/models"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
"gorm.io/gorm"
|
||||||
|
"gorm.io/gorm/logger"
|
||||||
|
"path/filepath"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var o system.AtomicBool
|
||||||
o system.AtomicBool
|
var db *gorm.DB
|
||||||
db *gorm.DB
|
|
||||||
)
|
|
||||||
|
|
||||||
// Initialize configures the local SQLite database for Wings and ensures that the models have
|
// Initialize configures the local SQLite database for Wings and ensures that the models have
|
||||||
// been fully migrated.
|
// been fully migrated.
|
||||||
|
|||||||
@@ -1,11 +1,9 @@
|
|||||||
package models
|
package models
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"net"
|
"github.com/pterodactyl/wings/system"
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"gorm.io/gorm"
|
"gorm.io/gorm"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
type Event string
|
type Event string
|
||||||
@@ -57,9 +55,7 @@ func (a Activity) SetUser(u string) *Activity {
|
|||||||
// is trimmed down to remove any extraneous data, and the timestamp is set to the current
|
// is trimmed down to remove any extraneous data, and the timestamp is set to the current
|
||||||
// system time and then stored as UTC.
|
// system time and then stored as UTC.
|
||||||
func (a *Activity) BeforeCreate(_ *gorm.DB) error {
|
func (a *Activity) BeforeCreate(_ *gorm.DB) error {
|
||||||
if ip, _, err := net.SplitHostPort(strings.TrimSpace(a.IP)); err == nil {
|
a.IP = system.TrimIPSuffix(a.IP)
|
||||||
a.IP = ip
|
|
||||||
}
|
|
||||||
if a.Timestamp.IsZero() {
|
if a.Timestamp.IsZero() {
|
||||||
a.Timestamp = time.Now()
|
a.Timestamp = time.Now()
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package models
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"database/sql"
|
"database/sql"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/goccy/go-json"
|
"github.com/goccy/go-json"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,90 +0,0 @@
|
|||||||
package progress
|
|
||||||
|
|
||||||
import (
|
|
||||||
"io"
|
|
||||||
"strings"
|
|
||||||
"sync/atomic"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Progress is used to track the progress of any I/O operation that are being
|
|
||||||
// performed.
|
|
||||||
type Progress struct {
|
|
||||||
// written is the total size of the files that have been written to the writer.
|
|
||||||
written uint64
|
|
||||||
// Total is the total size of the archive in bytes.
|
|
||||||
total uint64
|
|
||||||
|
|
||||||
// Writer .
|
|
||||||
Writer io.Writer
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewProgress returns a new progress tracker for the given total size.
|
|
||||||
func NewProgress(total uint64) *Progress {
|
|
||||||
return &Progress{total: total}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Written returns the total number of bytes written.
|
|
||||||
// This function should be used when the progress is tracking data being written.
|
|
||||||
func (p *Progress) Written() uint64 {
|
|
||||||
return atomic.LoadUint64(&p.written)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Total returns the total size in bytes.
|
|
||||||
func (p *Progress) Total() uint64 {
|
|
||||||
return atomic.LoadUint64(&p.total)
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetTotal sets the total size of the archive in bytes. This function is safe
|
|
||||||
// to call concurrently and can be used to update the total size if it changes,
|
|
||||||
// such as when the total size is simultaneously being calculated as data is
|
|
||||||
// being written through the progress writer.
|
|
||||||
func (p *Progress) SetTotal(total uint64) {
|
|
||||||
atomic.StoreUint64(&p.total, total)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Write totals the number of bytes that have been written to the writer.
|
|
||||||
func (p *Progress) Write(v []byte) (int, error) {
|
|
||||||
n := len(v)
|
|
||||||
atomic.AddUint64(&p.written, uint64(n))
|
|
||||||
if p.Writer != nil {
|
|
||||||
return p.Writer.Write(v)
|
|
||||||
}
|
|
||||||
return n, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Progress returns a formatted progress string for the current progress.
|
|
||||||
func (p *Progress) Progress(width int) string {
|
|
||||||
// current = 100 (Progress, dynamic)
|
|
||||||
// total = 1000 (Content-Length, dynamic)
|
|
||||||
// width = 25 (Number of ticks to display, static)
|
|
||||||
// widthPercentage = 100 / width (What percentage does each tick represent, static)
|
|
||||||
//
|
|
||||||
// percentageDecimal = current / total = 0.1
|
|
||||||
// percentage = percentageDecimal * 100 = 10%
|
|
||||||
// ticks = percentage / widthPercentage = 2.5
|
|
||||||
//
|
|
||||||
// ticks is a float64, so we cast it to an int which rounds it down to 2.
|
|
||||||
|
|
||||||
// Values are cast to floats to prevent integer division.
|
|
||||||
current := p.Written()
|
|
||||||
total := p.Total()
|
|
||||||
// width := is passed as a parameter
|
|
||||||
widthPercentage := float64(100) / float64(width)
|
|
||||||
percentageDecimal := float64(current) / float64(total)
|
|
||||||
percentage := percentageDecimal * 100
|
|
||||||
ticks := int(percentage / widthPercentage)
|
|
||||||
|
|
||||||
// Ensure that we never get a negative number of ticks, this will prevent strings#Repeat
|
|
||||||
// from panicking. A negative number of ticks is likely to happen when the total size is
|
|
||||||
// inaccurate, such as when we are going off of rough disk usage calculation.
|
|
||||||
if ticks < 0 {
|
|
||||||
ticks = 0
|
|
||||||
} else if ticks > width {
|
|
||||||
ticks = width
|
|
||||||
}
|
|
||||||
|
|
||||||
bar := strings.Repeat("=", ticks) + strings.Repeat(" ", width-ticks)
|
|
||||||
return "[" + bar + "] " + system.FormatBytes(current) + " / " + system.FormatBytes(total)
|
|
||||||
}
|
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
package progress_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/franela/goblin"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/internal/progress"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestProgress(t *testing.T) {
|
|
||||||
g := goblin.Goblin(t)
|
|
||||||
|
|
||||||
g.Describe("Progress", func() {
|
|
||||||
g.It("properly initializes", func() {
|
|
||||||
total := uint64(1000)
|
|
||||||
p := progress.NewProgress(total)
|
|
||||||
g.Assert(p).IsNotNil()
|
|
||||||
g.Assert(p.Total()).Equal(total)
|
|
||||||
g.Assert(p.Written()).Equal(uint64(0))
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("increments written when Write is called", func() {
|
|
||||||
v := []byte("hello")
|
|
||||||
p := progress.NewProgress(1000)
|
|
||||||
_, err := p.Write(v)
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
g.Assert(p.Written()).Equal(uint64(len(v)))
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("renders a progress bar", func() {
|
|
||||||
v := bytes.Repeat([]byte{' '}, 100)
|
|
||||||
p := progress.NewProgress(1000)
|
|
||||||
_, err := p.Write(v)
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
g.Assert(p.Written()).Equal(uint64(len(v)))
|
|
||||||
g.Assert(p.Progress(25)).Equal("[== ] 100 B / 1000 B")
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("renders a progress bar when written exceeds total", func() {
|
|
||||||
v := bytes.Repeat([]byte{' '}, 1001)
|
|
||||||
p := progress.NewProgress(1000)
|
|
||||||
_, err := p.Write(v)
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
g.Assert(p.Written()).Equal(uint64(len(v)))
|
|
||||||
g.Assert(p.Progress(25)).Equal("[=========================] 1001 B / 1000 B")
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -4,14 +4,13 @@ import (
|
|||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/pterodactyl/wings/internal/models"
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/cenkalti/backoff/v4"
|
"github.com/cenkalti/backoff/v4"
|
||||||
@@ -29,7 +28,7 @@ type Client interface {
|
|||||||
SetArchiveStatus(ctx context.Context, uuid string, successful bool) error
|
SetArchiveStatus(ctx context.Context, uuid string, successful bool) error
|
||||||
SetBackupStatus(ctx context.Context, backup string, data BackupRequest) error
|
SetBackupStatus(ctx context.Context, backup string, data BackupRequest) error
|
||||||
SendRestorationStatus(ctx context.Context, backup string, successful bool) error
|
SendRestorationStatus(ctx context.Context, backup string, successful bool) error
|
||||||
SetInstallationStatus(ctx context.Context, uuid string, data InstallStatusRequest) error
|
SetInstallationStatus(ctx context.Context, uuid string, successful bool) error
|
||||||
SetTransferStatus(ctx context.Context, uuid string, successful bool) error
|
SetTransferStatus(ctx context.Context, uuid string, successful bool) error
|
||||||
ValidateSftpCredentials(ctx context.Context, request SftpAuthRequest) (SftpAuthResponse, error)
|
ValidateSftpCredentials(ctx context.Context, request SftpAuthRequest) (SftpAuthResponse, error)
|
||||||
SendActivityLogs(ctx context.Context, activity []models.Activity) error
|
SendActivityLogs(ctx context.Context, activity []models.Activity) error
|
||||||
|
|||||||
@@ -3,11 +3,10 @@ package remote
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/pterodactyl/wings/internal/models"
|
||||||
"strconv"
|
"strconv"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"golang.org/x/sync/errgroup"
|
"golang.org/x/sync/errgroup"
|
||||||
@@ -19,7 +18,7 @@ const (
|
|||||||
ProcessStopNativeStop = "stop"
|
ProcessStopNativeStop = "stop"
|
||||||
)
|
)
|
||||||
|
|
||||||
// GetServers returns all the servers that are present on the Panel making
|
// GetServers returns all of the servers that are present on the Panel making
|
||||||
// parallel API calls to the endpoint if more than one page of servers is
|
// parallel API calls to the endpoint if more than one page of servers is
|
||||||
// returned.
|
// returned.
|
||||||
func (c *client) GetServers(ctx context.Context, limit int) ([]RawServerData, error) {
|
func (c *client) GetServers(ctx context.Context, limit int) ([]RawServerData, error) {
|
||||||
@@ -58,7 +57,7 @@ func (c *client) GetServers(ctx context.Context, limit int) ([]RawServerData, er
|
|||||||
//
|
//
|
||||||
// This handles Wings exiting during either of these processes which will leave
|
// This handles Wings exiting during either of these processes which will leave
|
||||||
// things in a bad state within the Panel. This API call is executed once Wings
|
// things in a bad state within the Panel. This API call is executed once Wings
|
||||||
// has fully booted all the servers.
|
// has fully booted all of the servers.
|
||||||
func (c *client) ResetServersState(ctx context.Context) error {
|
func (c *client) ResetServersState(ctx context.Context) error {
|
||||||
res, err := c.Post(ctx, "/servers/reset", nil)
|
res, err := c.Post(ctx, "/servers/reset", nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -92,8 +91,8 @@ func (c *client) GetInstallationScript(ctx context.Context, uuid string) (Instal
|
|||||||
return config, err
|
return config, err
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *client) SetInstallationStatus(ctx context.Context, uuid string, data InstallStatusRequest) error {
|
func (c *client) SetInstallationStatus(ctx context.Context, uuid string, successful bool) error {
|
||||||
resp, err := c.Post(ctx, fmt.Sprintf("/servers/%s/install", uuid), data)
|
resp, err := c.Post(ctx, fmt.Sprintf("/servers/%s/install", uuid), d{"successful": successful})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -115,7 +114,7 @@ func (c *client) SetTransferStatus(ctx context.Context, uuid string, successful
|
|||||||
if successful {
|
if successful {
|
||||||
state = "success"
|
state = "success"
|
||||||
}
|
}
|
||||||
resp, err := c.Post(ctx, fmt.Sprintf("/servers/%s/transfer/%s", uuid, state), nil)
|
resp, err := c.Get(ctx, fmt.Sprintf("/servers/%s/transfer/%s", uuid, state), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -127,7 +126,7 @@ func (c *client) SetTransferStatus(ctx context.Context, uuid string, successful
|
|||||||
// password combination provided is associated with a valid server on the instance
|
// password combination provided is associated with a valid server on the instance
|
||||||
// using the Panel's authentication control mechanisms. This will get itself
|
// using the Panel's authentication control mechanisms. This will get itself
|
||||||
// throttled if too many requests are made, allowing us to completely offload
|
// throttled if too many requests are made, allowing us to completely offload
|
||||||
// all the authorization security logic to the Panel.
|
// all of the authorization security logic to the Panel.
|
||||||
func (c *client) ValidateSftpCredentials(ctx context.Context, request SftpAuthRequest) (SftpAuthResponse, error) {
|
func (c *client) ValidateSftpCredentials(ctx context.Context, request SftpAuthRequest) (SftpAuthResponse, error) {
|
||||||
var auth SftpAuthResponse
|
var auth SftpAuthResponse
|
||||||
res, err := c.Post(ctx, "/sftp/auth", request)
|
res, err := c.Post(ctx, "/sftp/auth", request)
|
||||||
|
|||||||
@@ -2,11 +2,10 @@ package remote
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"regexp"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/goccy/go-json"
|
"github.com/goccy/go-json"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/parser"
|
"github.com/pterodactyl/wings/parser"
|
||||||
)
|
)
|
||||||
@@ -92,8 +91,8 @@ type SftpAuthResponse struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type OutputLineMatcher struct {
|
type OutputLineMatcher struct {
|
||||||
// raw string to match against. This may or may not be prefixed with
|
// The raw string to match against. This may or may not be prefixed with
|
||||||
// `regex:` which indicates we want to match against the regex expression.
|
// regex: which indicates we want to match against the regex expression.
|
||||||
raw []byte
|
raw []byte
|
||||||
reg *regexp.Regexp
|
reg *regexp.Regexp
|
||||||
}
|
}
|
||||||
@@ -139,9 +138,9 @@ type ProcessStopConfiguration struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// ProcessConfiguration defines the process configuration for a given server
|
// ProcessConfiguration defines the process configuration for a given server
|
||||||
// instance. This sets what Wings is looking for to mark a server as done
|
// instance. This sets what Wings is looking for to mark a server as done starting
|
||||||
// starting what to do when stopping, and what changes to make to the
|
// what to do when stopping, and what changes to make to the configuration file
|
||||||
// configuration file for a server.
|
// for a server.
|
||||||
type ProcessConfiguration struct {
|
type ProcessConfiguration struct {
|
||||||
Startup struct {
|
Startup struct {
|
||||||
Done []*OutputLineMatcher `json:"done"`
|
Done []*OutputLineMatcher `json:"done"`
|
||||||
@@ -157,20 +156,9 @@ type BackupRemoteUploadResponse struct {
|
|||||||
PartSize int64 `json:"part_size"`
|
PartSize int64 `json:"part_size"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type BackupPart struct {
|
|
||||||
ETag string `json:"etag"`
|
|
||||||
PartNumber int `json:"part_number"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type BackupRequest struct {
|
type BackupRequest struct {
|
||||||
Checksum string `json:"checksum"`
|
Checksum string `json:"checksum"`
|
||||||
ChecksumType string `json:"checksum_type"`
|
ChecksumType string `json:"checksum_type"`
|
||||||
Size int64 `json:"size"`
|
Size int64 `json:"size"`
|
||||||
Successful bool `json:"successful"`
|
Successful bool `json:"successful"`
|
||||||
Parts []BackupPart `json:"parts"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type InstallStatusRequest struct {
|
|
||||||
Successful bool `json:"successful"`
|
|
||||||
Reinstall bool `json:"reinstall"`
|
|
||||||
}
|
}
|
||||||
|
|||||||
157
router/error.go
Normal file
157
router/error.go
Normal file
@@ -0,0 +1,157 @@
|
|||||||
|
package router
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"emperror.dev/errors"
|
||||||
|
"github.com/apex/log"
|
||||||
|
"github.com/gin-gonic/gin"
|
||||||
|
"github.com/google/uuid"
|
||||||
|
|
||||||
|
"github.com/pterodactyl/wings/server"
|
||||||
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
|
)
|
||||||
|
|
||||||
|
type RequestError struct {
|
||||||
|
err error
|
||||||
|
uuid string
|
||||||
|
message string
|
||||||
|
server *server.Server
|
||||||
|
}
|
||||||
|
|
||||||
|
// Attaches an error to the gin.Context object for the request and ensures that it
|
||||||
|
// has a proper stacktrace associated with it when doing so.
|
||||||
|
//
|
||||||
|
// If you just call c.Error(err) without using this function you'll likely end up
|
||||||
|
// with an error that has no annotated stack on it.
|
||||||
|
func WithError(c *gin.Context, err error) error {
|
||||||
|
return c.Error(errors.WithStackDepthIf(err, 1))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Generates a new tracked error, which simply tracks the specific error that
|
||||||
|
// is being passed in, and also assigned a UUID to the error so that it can be
|
||||||
|
// cross referenced in the logs.
|
||||||
|
func NewTrackedError(err error) *RequestError {
|
||||||
|
return &RequestError{
|
||||||
|
err: err,
|
||||||
|
uuid: uuid.Must(uuid.NewRandom()).String(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Same as NewTrackedError, except this will also attach the server instance that
|
||||||
|
// generated this server for the purposes of logging.
|
||||||
|
func NewServerError(err error, s *server.Server) *RequestError {
|
||||||
|
return &RequestError{
|
||||||
|
err: err,
|
||||||
|
uuid: uuid.Must(uuid.NewRandom()).String(),
|
||||||
|
server: s,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *RequestError) logger() *log.Entry {
|
||||||
|
if e.server != nil {
|
||||||
|
return e.server.Log().WithField("error_id", e.uuid).WithField("error", e.err)
|
||||||
|
}
|
||||||
|
return log.WithField("error_id", e.uuid).WithField("error", e.err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sets the output message to display to the user in the error.
|
||||||
|
func (e *RequestError) SetMessage(msg string) *RequestError {
|
||||||
|
e.message = msg
|
||||||
|
return e
|
||||||
|
}
|
||||||
|
|
||||||
|
// Aborts the request with the given status code, and responds with the error. This
|
||||||
|
// will also include the error UUID in the output so that the user can report that
|
||||||
|
// and link the response to a specific error in the logs.
|
||||||
|
func (e *RequestError) AbortWithStatus(status int, c *gin.Context) {
|
||||||
|
// In instances where the status has already been set just use that existing status
|
||||||
|
// since we cannot change it at this point, and trying to do so will emit a gin warning
|
||||||
|
// into the program output.
|
||||||
|
if c.Writer.Status() != 200 {
|
||||||
|
status = c.Writer.Status()
|
||||||
|
}
|
||||||
|
|
||||||
|
// If this error is because the resource does not exist, we likely do not need to log
|
||||||
|
// the error anywhere, just return a 404 and move on with our lives.
|
||||||
|
if errors.Is(e.err, os.ErrNotExist) {
|
||||||
|
c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
|
||||||
|
"error": "The requested resource was not found on the system.",
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if strings.HasPrefix(e.err.Error(), "invalid URL escape") {
|
||||||
|
c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{
|
||||||
|
"error": "Some of the data provided in the request appears to be escaped improperly.",
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// If this is a Filesystem error just return it without all of the tracking code nonsense
|
||||||
|
// since we don't need to be logging it into the logs or anything, its just a normal error
|
||||||
|
// that the user can solve on their end.
|
||||||
|
if st, msg := e.getAsFilesystemError(); st != 0 {
|
||||||
|
c.AbortWithStatusJSON(st, gin.H{"error": msg})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Otherwise, log the error to zap, and then report the error back to the user.
|
||||||
|
if status >= 500 {
|
||||||
|
e.logger().Error("unexpected error while handling HTTP request")
|
||||||
|
} else {
|
||||||
|
e.logger().Debug("non-server error encountered while handling HTTP request")
|
||||||
|
}
|
||||||
|
|
||||||
|
if e.message == "" {
|
||||||
|
e.message = "An unexpected error was encountered while processing this request."
|
||||||
|
}
|
||||||
|
|
||||||
|
c.AbortWithStatusJSON(status, gin.H{"error": e.message, "error_id": e.uuid})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper function to just abort with an internal server error. This is generally the response
|
||||||
|
// from most errors encountered by the API.
|
||||||
|
func (e *RequestError) Abort(c *gin.Context) {
|
||||||
|
e.AbortWithStatus(http.StatusInternalServerError, c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Looks at the given RequestError and determines if it is a specific filesystem error that
|
||||||
|
// we can process and return differently for the user.
|
||||||
|
func (e *RequestError) getAsFilesystemError() (int, string) {
|
||||||
|
// Some external things end up calling fmt.Errorf() on our filesystem errors
|
||||||
|
// which ends up just unleashing chaos on the system. For the sake of this
|
||||||
|
// fallback to using text checks...
|
||||||
|
if filesystem.IsErrorCode(e.err, filesystem.ErrCodeDenylistFile) || strings.Contains(e.err.Error(), "filesystem: file access prohibited") {
|
||||||
|
return http.StatusForbidden, "This file cannot be modified: present in egg denylist."
|
||||||
|
}
|
||||||
|
if filesystem.IsErrorCode(e.err, filesystem.ErrCodePathResolution) || strings.Contains(e.err.Error(), "resolves to a location outside the server root") {
|
||||||
|
return http.StatusNotFound, "The requested resource was not found on the system."
|
||||||
|
}
|
||||||
|
if filesystem.IsErrorCode(e.err, filesystem.ErrCodeIsDirectory) || strings.Contains(e.err.Error(), "filesystem: is a directory") {
|
||||||
|
return http.StatusBadRequest, "Cannot perform that action: file is a directory."
|
||||||
|
}
|
||||||
|
if filesystem.IsErrorCode(e.err, filesystem.ErrCodeDiskSpace) || strings.Contains(e.err.Error(), "filesystem: not enough disk space") {
|
||||||
|
return http.StatusBadRequest, "Cannot perform that action: not enough disk space available."
|
||||||
|
}
|
||||||
|
if strings.HasSuffix(e.err.Error(), "file name too long") {
|
||||||
|
return http.StatusBadRequest, "Cannot perform that action: file name is too long."
|
||||||
|
}
|
||||||
|
if e, ok := e.err.(*os.SyscallError); ok && e.Syscall == "readdirent" {
|
||||||
|
return http.StatusNotFound, "The requested directory does not exist."
|
||||||
|
}
|
||||||
|
return 0, ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle specific filesystem errors for a server.
|
||||||
|
func (e *RequestError) AbortFilesystemError(c *gin.Context) {
|
||||||
|
e.Abort(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Format the error to a string and include the UUID.
|
||||||
|
func (e *RequestError) Error() string {
|
||||||
|
return fmt.Sprintf("%v (uuid: %s)", e.err, e.uuid)
|
||||||
|
}
|
||||||
@@ -1,9 +1,11 @@
|
|||||||
package middleware
|
package middleware
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"crypto/subtle"
|
"crypto/subtle"
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
@@ -14,8 +16,133 @@ import (
|
|||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// RequestError is a custom error type returned when something goes wrong with
|
||||||
|
// any of the HTTP endpoints.
|
||||||
|
type RequestError struct {
|
||||||
|
err error
|
||||||
|
status int
|
||||||
|
msg string
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewError returns a new RequestError for the provided error.
|
||||||
|
func NewError(err error) *RequestError {
|
||||||
|
return &RequestError{
|
||||||
|
// Attach a stacktrace to the error if it is missing at this point and mark it
|
||||||
|
// as originating from the location where NewError was called, rather than this
|
||||||
|
// specific point in the code.
|
||||||
|
err: errors.WithStackDepthIf(err, 1),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMessage allows for a custom error message to be set on an existing
|
||||||
|
// RequestError instance.
|
||||||
|
func (re *RequestError) SetMessage(m string) {
|
||||||
|
re.msg = m
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetStatus sets the HTTP status code for the error response. By default this
|
||||||
|
// is a HTTP-500 error.
|
||||||
|
func (re *RequestError) SetStatus(s int) {
|
||||||
|
re.status = s
|
||||||
|
}
|
||||||
|
|
||||||
|
// Abort aborts the given HTTP request with the specified status code and then
|
||||||
|
// logs the event into the logs. The error that is output will include the unique
|
||||||
|
// request ID if it is present.
|
||||||
|
func (re *RequestError) Abort(c *gin.Context, status int) {
|
||||||
|
reqId := c.Writer.Header().Get("X-Request-Id")
|
||||||
|
|
||||||
|
// Generate the base logger instance, attaching the unique request ID and
|
||||||
|
// the URL that was requested.
|
||||||
|
event := log.WithField("request_id", reqId).WithField("url", c.Request.URL.String())
|
||||||
|
// If there is a server present in the gin.Context stack go ahead and pull it
|
||||||
|
// and attach that server UUID to the logs as well so that we can see what specific
|
||||||
|
// server triggered this error.
|
||||||
|
if s, ok := c.Get("server"); ok {
|
||||||
|
if s, ok := s.(*server.Server); ok {
|
||||||
|
event = event.WithField("server_id", s.ID())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.Writer.Status() == 200 {
|
||||||
|
// Handle context deadlines being exceeded a little differently since we want
|
||||||
|
// to report a more user-friendly error and a proper error code. The "context
|
||||||
|
// canceled" error is generally when a request is terminated before all of the
|
||||||
|
// logic is finished running.
|
||||||
|
if errors.Is(re.err, context.DeadlineExceeded) {
|
||||||
|
re.SetStatus(http.StatusGatewayTimeout)
|
||||||
|
re.SetMessage("The server could not process this request in time, please try again.")
|
||||||
|
} else if strings.Contains(re.Cause().Error(), "context canceled") {
|
||||||
|
re.SetStatus(http.StatusBadRequest)
|
||||||
|
re.SetMessage("Request aborted by client.")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// c.Writer.Status() will be a non-200 value if the headers have already been sent
|
||||||
|
// to the requester but an error is encountered. This can happen if there is an issue
|
||||||
|
// marshaling a struct placed into a c.JSON() call (or c.AbortWithJSON() call).
|
||||||
|
if status >= 500 || c.Writer.Status() != 200 {
|
||||||
|
event.WithField("status", status).WithField("error", re.err).Error("error while handling HTTP request")
|
||||||
|
} else {
|
||||||
|
event.WithField("status", status).WithField("error", re.err).Debug("error handling HTTP request (not a server error)")
|
||||||
|
}
|
||||||
|
if re.msg == "" {
|
||||||
|
re.msg = "An unexpected error was encountered while processing this request"
|
||||||
|
}
|
||||||
|
// Now abort the request with the error message and include the unique request
|
||||||
|
// ID that was present to make things super easy on people who don't know how
|
||||||
|
// or cannot view the response headers (where X-Request-Id would be present).
|
||||||
|
c.AbortWithStatusJSON(status, gin.H{"error": re.msg, "request_id": reqId})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Cause returns the underlying error.
|
||||||
|
func (re *RequestError) Cause() error {
|
||||||
|
return re.err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error returns the underlying error message for this request.
|
||||||
|
func (re *RequestError) Error() string {
|
||||||
|
return re.err.Error()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Looks at the given RequestError and determines if it is a specific filesystem
|
||||||
|
// error that we can process and return differently for the user.
|
||||||
|
//
|
||||||
|
// Some external things end up calling fmt.Errorf() on our filesystem errors
|
||||||
|
// which ends up just unleashing chaos on the system. For the sake of this,
|
||||||
|
// fallback to using text checks.
|
||||||
|
//
|
||||||
|
// If the error passed into this call is nil or does not match empty values will
|
||||||
|
// be returned to the caller.
|
||||||
|
func (re *RequestError) asFilesystemError() (int, string) {
|
||||||
|
err := re.Cause()
|
||||||
|
if err == nil {
|
||||||
|
return 0, ""
|
||||||
|
}
|
||||||
|
if filesystem.IsErrorCode(err, filesystem.ErrCodeDenylistFile) || strings.Contains(err.Error(), "filesystem: file access prohibited") {
|
||||||
|
return http.StatusForbidden, "This file cannot be modified: present in egg denylist."
|
||||||
|
}
|
||||||
|
if filesystem.IsErrorCode(err, filesystem.ErrCodePathResolution) || strings.Contains(err.Error(), "resolves to a location outside the server root") {
|
||||||
|
return http.StatusNotFound, "The requested resource was not found on the system."
|
||||||
|
}
|
||||||
|
if filesystem.IsErrorCode(err, filesystem.ErrCodeIsDirectory) || strings.Contains(err.Error(), "filesystem: is a directory") {
|
||||||
|
return http.StatusBadRequest, "Cannot perform that action: file is a directory."
|
||||||
|
}
|
||||||
|
if filesystem.IsErrorCode(err, filesystem.ErrCodeDiskSpace) || strings.Contains(err.Error(), "filesystem: not enough disk space") {
|
||||||
|
return http.StatusBadRequest, "There is not enough disk space available to perform that action."
|
||||||
|
}
|
||||||
|
if strings.HasSuffix(err.Error(), "file name too long") {
|
||||||
|
return http.StatusBadRequest, "Cannot perform that action: file name is too long."
|
||||||
|
}
|
||||||
|
if e, ok := err.(*os.SyscallError); ok && e.Syscall == "readdirent" {
|
||||||
|
return http.StatusNotFound, "The requested directory does not exist."
|
||||||
|
}
|
||||||
|
return 0, ""
|
||||||
|
}
|
||||||
|
|
||||||
// AttachRequestID attaches a unique ID to the incoming HTTP request so that any
|
// AttachRequestID attaches a unique ID to the incoming HTTP request so that any
|
||||||
// errors that are generated or returned to the client will include this reference
|
// errors that are generated or returned to the client will include this reference
|
||||||
// allowing for an easier time identifying the specific request that failed for
|
// allowing for an easier time identifying the specific request that failed for
|
||||||
@@ -53,7 +180,7 @@ func AttachApiClient(client remote.Client) gin.HandlerFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// CaptureAndAbort aborts the request and attaches the provided error to the gin
|
// CaptureAndAbort aborts the request and attaches the provided error to the gin
|
||||||
// context, so it can be reported properly. If the error is missing a stacktrace
|
// context so it can be reported properly. If the error is missing a stacktrace
|
||||||
// at the time it is called the stack will be attached.
|
// at the time it is called the stack will be attached.
|
||||||
func CaptureAndAbort(c *gin.Context, err error) {
|
func CaptureAndAbort(c *gin.Context, err error) {
|
||||||
c.Abort()
|
c.Abort()
|
||||||
|
|||||||
@@ -1,141 +0,0 @@
|
|||||||
package middleware
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"net/http"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/apex/log"
|
|
||||||
"github.com/gin-gonic/gin"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/server"
|
|
||||||
"github.com/pterodactyl/wings/server/filesystem"
|
|
||||||
)
|
|
||||||
|
|
||||||
// RequestError is a custom error type returned when something goes wrong with
|
|
||||||
// any of the HTTP endpoints.
|
|
||||||
type RequestError struct {
|
|
||||||
err error
|
|
||||||
status int
|
|
||||||
msg string
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewError returns a new RequestError for the provided error.
|
|
||||||
func NewError(err error) *RequestError {
|
|
||||||
return &RequestError{
|
|
||||||
// Attach a stacktrace to the error if it is missing at this point and mark it
|
|
||||||
// as originating from the location where NewError was called, rather than this
|
|
||||||
// specific point in the code.
|
|
||||||
err: errors.WithStackDepthIf(err, 1),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetMessage allows for a custom error message to be set on an existing
|
|
||||||
// RequestError instance.
|
|
||||||
func (re *RequestError) SetMessage(m string) {
|
|
||||||
re.msg = m
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetStatus sets the HTTP status code for the error response. By default this
|
|
||||||
// is a HTTP-500 error.
|
|
||||||
func (re *RequestError) SetStatus(s int) {
|
|
||||||
re.status = s
|
|
||||||
}
|
|
||||||
|
|
||||||
// Abort aborts the given HTTP request with the specified status code and then
|
|
||||||
// logs the event into the logs. The error that is output will include the unique
|
|
||||||
// request ID if it is present.
|
|
||||||
func (re *RequestError) Abort(c *gin.Context, status int) {
|
|
||||||
reqId := c.Writer.Header().Get("X-Request-Id")
|
|
||||||
|
|
||||||
// Generate the base logger instance, attaching the unique request ID and
|
|
||||||
// the URL that was requested.
|
|
||||||
event := log.WithField("request_id", reqId).WithField("url", c.Request.URL.String())
|
|
||||||
// If there is a server present in the gin.Context stack go ahead and pull it
|
|
||||||
// and attach that server UUID to the logs as well so that we can see what specific
|
|
||||||
// server triggered this error.
|
|
||||||
if s, ok := c.Get("server"); ok {
|
|
||||||
if s, ok := s.(*server.Server); ok {
|
|
||||||
event = event.WithField("server_id", s.ID())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if c.Writer.Status() == 200 {
|
|
||||||
// Handle context deadlines being exceeded a little differently since we want
|
|
||||||
// to report a more user-friendly error and a proper error code. The "context
|
|
||||||
// canceled" error is generally when a request is terminated before all of the
|
|
||||||
// logic is finished running.
|
|
||||||
if errors.Is(re.err, context.DeadlineExceeded) {
|
|
||||||
re.SetStatus(http.StatusGatewayTimeout)
|
|
||||||
re.SetMessage("The server could not process this request in time, please try again.")
|
|
||||||
} else if strings.Contains(re.Cause().Error(), "context canceled") {
|
|
||||||
re.SetStatus(http.StatusBadRequest)
|
|
||||||
re.SetMessage("Request aborted by client.")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// c.Writer.Status() will be a non-200 value if the headers have already been sent
|
|
||||||
// to the requester but an error is encountered. This can happen if there is an issue
|
|
||||||
// marshaling a struct placed into a c.JSON() call (or c.AbortWithJSON() call).
|
|
||||||
if status >= 500 || c.Writer.Status() != 200 {
|
|
||||||
event.WithField("status", status).WithField("error", re.err).Error("error while handling HTTP request")
|
|
||||||
} else {
|
|
||||||
event.WithField("status", status).WithField("error", re.err).Debug("error handling HTTP request (not a server error)")
|
|
||||||
}
|
|
||||||
if re.msg == "" {
|
|
||||||
re.msg = "An unexpected error was encountered while processing this request"
|
|
||||||
}
|
|
||||||
// Now abort the request with the error message and include the unique request
|
|
||||||
// ID that was present to make things super easy on people who don't know how
|
|
||||||
// or cannot view the response headers (where X-Request-Id would be present).
|
|
||||||
c.AbortWithStatusJSON(status, gin.H{"error": re.msg, "request_id": reqId})
|
|
||||||
}
|
|
||||||
|
|
||||||
// Cause returns the underlying error.
|
|
||||||
func (re *RequestError) Cause() error {
|
|
||||||
return re.err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Error returns the underlying error message for this request.
|
|
||||||
func (re *RequestError) Error() string {
|
|
||||||
return re.err.Error()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Looks at the given RequestError and determines if it is a specific filesystem
|
|
||||||
// error that we can process and return differently for the user.
|
|
||||||
//
|
|
||||||
// Some external things end up calling fmt.Errorf() on our filesystem errors
|
|
||||||
// which ends up just unleashing chaos on the system. For the sake of this,
|
|
||||||
// fallback to using text checks.
|
|
||||||
//
|
|
||||||
// If the error passed into this call is nil or does not match empty values will
|
|
||||||
// be returned to the caller.
|
|
||||||
func (re *RequestError) asFilesystemError() (int, string) {
|
|
||||||
err := re.Cause()
|
|
||||||
if err == nil {
|
|
||||||
return 0, ""
|
|
||||||
}
|
|
||||||
if filesystem.IsErrorCode(err, filesystem.ErrNotExist) ||
|
|
||||||
filesystem.IsErrorCode(err, filesystem.ErrCodePathResolution) ||
|
|
||||||
strings.Contains(err.Error(), "resolves to a location outside the server root") {
|
|
||||||
return http.StatusNotFound, "The requested resources was not found on the system."
|
|
||||||
}
|
|
||||||
if filesystem.IsErrorCode(err, filesystem.ErrCodeDenylistFile) || strings.Contains(err.Error(), "filesystem: file access prohibited") {
|
|
||||||
return http.StatusForbidden, "This file cannot be modified: present in egg denylist."
|
|
||||||
}
|
|
||||||
if filesystem.IsErrorCode(err, filesystem.ErrCodeIsDirectory) || strings.Contains(err.Error(), "filesystem: is a directory") {
|
|
||||||
return http.StatusBadRequest, "Cannot perform that action: file is a directory."
|
|
||||||
}
|
|
||||||
if filesystem.IsErrorCode(err, filesystem.ErrCodeDiskSpace) || strings.Contains(err.Error(), "filesystem: not enough disk space") {
|
|
||||||
return http.StatusBadRequest, "There is not enough disk space available to perform that action."
|
|
||||||
}
|
|
||||||
if strings.HasSuffix(err.Error(), "file name too long") {
|
|
||||||
return http.StatusBadRequest, "Cannot perform that action: file name is too long."
|
|
||||||
}
|
|
||||||
if e, ok := err.(*os.SyscallError); ok && e.Syscall == "readdirent" {
|
|
||||||
return http.StatusNotFound, "The requested directory does not exist."
|
|
||||||
}
|
|
||||||
return 0, ""
|
|
||||||
}
|
|
||||||
@@ -1,11 +1,9 @@
|
|||||||
package router
|
package router
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
wserver "github.com/pterodactyl/wings/server"
|
wserver "github.com/pterodactyl/wings/server"
|
||||||
@@ -17,10 +15,6 @@ func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
|
|||||||
|
|
||||||
router := gin.New()
|
router := gin.New()
|
||||||
router.Use(gin.Recovery())
|
router.Use(gin.Recovery())
|
||||||
if err := router.SetTrustedProxies(config.Get().Api.TrustedProxies); err != nil {
|
|
||||||
panic(errors.WithStack(err))
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
router.Use(middleware.AttachRequestID(), middleware.CaptureErrors(), middleware.SetAccessControlHeaders())
|
router.Use(middleware.AttachRequestID(), middleware.CaptureErrors(), middleware.SetAccessControlHeaders())
|
||||||
router.Use(middleware.AttachServerManager(m), middleware.AttachApiClient(client))
|
router.Use(middleware.AttachServerManager(m), middleware.AttachApiClient(client))
|
||||||
// @todo log this into a different file so you can setup IP blocking for abusive requests and such.
|
// @todo log this into a different file so you can setup IP blocking for abusive requests and such.
|
||||||
@@ -44,7 +38,7 @@ func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
|
|||||||
router.GET("/download/file", getDownloadFile)
|
router.GET("/download/file", getDownloadFile)
|
||||||
router.POST("/upload/file", postServerUploadFiles)
|
router.POST("/upload/file", postServerUploadFiles)
|
||||||
|
|
||||||
// This route is special it sits above all the other requests because we are
|
// This route is special it sits above all of the other requests because we are
|
||||||
// using a JWT to authorize access to it, therefore it needs to be publicly
|
// using a JWT to authorize access to it, therefore it needs to be publicly
|
||||||
// accessible.
|
// accessible.
|
||||||
router.GET("/api/servers/:server/ws", middleware.ServerExists(), getServerWebsocket)
|
router.GET("/api/servers/:server/ws", middleware.ServerExists(), getServerWebsocket)
|
||||||
@@ -52,16 +46,16 @@ func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
|
|||||||
// This request is called by another daemon when a server is going to be transferred out.
|
// This request is called by another daemon when a server is going to be transferred out.
|
||||||
// This request does not need the AuthorizationMiddleware as the panel should never call it
|
// This request does not need the AuthorizationMiddleware as the panel should never call it
|
||||||
// and requests are authenticated through a JWT the panel issues to the other daemon.
|
// and requests are authenticated through a JWT the panel issues to the other daemon.
|
||||||
router.POST("/api/transfers", postTransfers)
|
router.GET("/api/servers/:server/archive", middleware.ServerExists(), getServerArchive)
|
||||||
|
|
||||||
// All the routes beyond this mount will use an authorization middleware
|
// All of the routes beyond this mount will use an authorization middleware
|
||||||
// and will not be accessible without the correct Authorization header provided.
|
// and will not be accessible without the correct Authorization header provided.
|
||||||
protected := router.Use(middleware.RequireAuthorization())
|
protected := router.Use(middleware.RequireAuthorization())
|
||||||
protected.POST("/api/update", postUpdateConfiguration)
|
protected.POST("/api/update", postUpdateConfiguration)
|
||||||
protected.GET("/api/system", getSystemInformation)
|
protected.GET("/api/system", getSystemInformation)
|
||||||
protected.GET("/api/servers", getAllServers)
|
protected.GET("/api/servers", getAllServers)
|
||||||
protected.POST("/api/servers", postCreateServer)
|
protected.POST("/api/servers", postCreateServer)
|
||||||
protected.DELETE("/api/transfers/:server", deleteTransfer)
|
protected.POST("/api/transfer", postTransfer)
|
||||||
|
|
||||||
// These are server specific routes, and require that the request be authorized, and
|
// These are server specific routes, and require that the request be authorized, and
|
||||||
// that the server exist on the Daemon.
|
// that the server exist on the Daemon.
|
||||||
@@ -81,8 +75,7 @@ func Configure(m *wserver.Manager, client remote.Client) *gin.Engine {
|
|||||||
|
|
||||||
// This archive request causes the archive to start being created
|
// This archive request causes the archive to start being created
|
||||||
// this should only be triggered by the panel.
|
// this should only be triggered by the panel.
|
||||||
server.POST("/transfer", postServerTransfer)
|
server.POST("/archive", postServerArchive)
|
||||||
server.DELETE("/transfer", deleteServerTransfer)
|
|
||||||
|
|
||||||
files := server.Group("/files")
|
files := server.Group("/files")
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -21,11 +21,12 @@ func getDownloadBackup(c *gin.Context) {
|
|||||||
|
|
||||||
token := tokens.BackupPayload{}
|
token := tokens.BackupPayload{}
|
||||||
if err := tokens.ParseToken([]byte(c.Query("token")), &token); err != nil {
|
if err := tokens.ParseToken([]byte(c.Query("token")), &token); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewTrackedError(err).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if _, ok := manager.Get(token.ServerUuid); !ok || !token.IsUniqueRequest() {
|
s, ok := manager.Get(token.ServerUuid)
|
||||||
|
if !ok || !token.IsUniqueRequest() {
|
||||||
c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
|
c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
|
||||||
"error": "The requested resource was not found on this server.",
|
"error": "The requested resource was not found on this server.",
|
||||||
})
|
})
|
||||||
@@ -41,13 +42,13 @@ func getDownloadBackup(c *gin.Context) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
f, err := os.Open(b.Path())
|
f, err := os.Open(b.Path())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
defer f.Close()
|
defer f.Close()
|
||||||
@@ -56,7 +57,7 @@ func getDownloadBackup(c *gin.Context) {
|
|||||||
c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(st.Name()))
|
c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(st.Name()))
|
||||||
c.Header("Content-Type", "application/octet-stream")
|
c.Header("Content-Type", "application/octet-stream")
|
||||||
|
|
||||||
_, _ = bufio.NewReader(f).WriteTo(c.Writer)
|
bufio.NewReader(f).WriteTo(c.Writer)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Handles downloading a specific file for a server.
|
// Handles downloading a specific file for a server.
|
||||||
@@ -64,7 +65,7 @@ func getDownloadFile(c *gin.Context) {
|
|||||||
manager := middleware.ExtractManager(c)
|
manager := middleware.ExtractManager(c)
|
||||||
token := tokens.FilePayload{}
|
token := tokens.FilePayload{}
|
||||||
if err := tokens.ParseToken([]byte(c.Query("token")), &token); err != nil {
|
if err := tokens.ParseToken([]byte(c.Query("token")), &token); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewTrackedError(err).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -81,7 +82,7 @@ func getDownloadFile(c *gin.Context) {
|
|||||||
// If there is an error or we're somehow trying to download a directory, just
|
// If there is an error or we're somehow trying to download a directory, just
|
||||||
// respond with the appropriate error.
|
// respond with the appropriate error.
|
||||||
if err != nil {
|
if err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
} else if st.IsDir() {
|
} else if st.IsDir() {
|
||||||
c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
|
c.AbortWithStatusJSON(http.StatusNotFound, gin.H{
|
||||||
@@ -92,14 +93,13 @@ func getDownloadFile(c *gin.Context) {
|
|||||||
|
|
||||||
f, err := os.Open(p)
|
f, err := os.Open(p)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
defer f.Close()
|
|
||||||
|
|
||||||
c.Header("Content-Length", strconv.Itoa(int(st.Size())))
|
c.Header("Content-Length", strconv.Itoa(int(st.Size())))
|
||||||
c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(st.Name()))
|
c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(st.Name()))
|
||||||
c.Header("Content-Type", "application/octet-stream")
|
c.Header("Content-Type", "application/octet-stream")
|
||||||
|
|
||||||
_, _ = bufio.NewReader(f).WriteTo(c.Writer)
|
bufio.NewReader(f).WriteTo(c.Writer)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,12 +9,10 @@ import (
|
|||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/router/downloader"
|
"github.com/pterodactyl/wings/router/downloader"
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
"github.com/pterodactyl/wings/router/tokens"
|
"github.com/pterodactyl/wings/router/tokens"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
"github.com/pterodactyl/wings/server/transfer"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Returns a single server from the collection of servers.
|
// Returns a single server from the collection of servers.
|
||||||
@@ -35,7 +33,7 @@ func getServerLogs(c *gin.Context) {
|
|||||||
|
|
||||||
out, err := s.ReadLogfile(l)
|
out, err := s.ReadLogfile(l)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -109,7 +107,7 @@ func postServerCommands(c *gin.Context) {
|
|||||||
s := ExtractServer(c)
|
s := ExtractServer(c)
|
||||||
|
|
||||||
if running, err := s.Environment.IsRunning(c.Request.Context()); err != nil {
|
if running, err := s.Environment.IsRunning(c.Request.Context()); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
} else if !running {
|
} else if !running {
|
||||||
c.AbortWithStatusJSON(http.StatusBadGateway, gin.H{
|
c.AbortWithStatusJSON(http.StatusBadGateway, gin.H{
|
||||||
@@ -143,7 +141,7 @@ func postServerSync(c *gin.Context) {
|
|||||||
s := ExtractServer(c)
|
s := ExtractServer(c)
|
||||||
|
|
||||||
if err := s.Sync(); err != nil {
|
if err := s.Sync(); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
WithError(c, err)
|
||||||
} else {
|
} else {
|
||||||
c.Status(http.StatusNoContent)
|
c.Status(http.StatusNoContent)
|
||||||
}
|
}
|
||||||
@@ -153,15 +151,9 @@ func postServerSync(c *gin.Context) {
|
|||||||
func postServerInstall(c *gin.Context) {
|
func postServerInstall(c *gin.Context) {
|
||||||
s := ExtractServer(c)
|
s := ExtractServer(c)
|
||||||
|
|
||||||
go func(s *server.Server) {
|
go func(serv *server.Server) {
|
||||||
s.Log().Info("syncing server state with remote source before executing installation process")
|
if err := serv.Install(true); err != nil {
|
||||||
if err := s.Sync(); err != nil {
|
serv.Log().WithField("error", err).Error("failed to execute server installation process")
|
||||||
s.Log().WithField("error", err).Error("failed to sync server state with Panel")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := s.Install(); err != nil {
|
|
||||||
s.Log().WithField("error", err).Error("failed to execute server installation process")
|
|
||||||
}
|
}
|
||||||
}(s)
|
}(s)
|
||||||
|
|
||||||
@@ -195,17 +187,6 @@ func deleteServer(c *gin.Context) {
|
|||||||
// Immediately suspend the server to prevent a user from attempting
|
// Immediately suspend the server to prevent a user from attempting
|
||||||
// to start it while this process is running.
|
// to start it while this process is running.
|
||||||
s.Config().SetSuspended(true)
|
s.Config().SetSuspended(true)
|
||||||
|
|
||||||
// Notify all websocket clients that the server is being deleted.
|
|
||||||
// This is useful for two reasons, one to tell clients not to bother
|
|
||||||
// retrying to connect to the websocket. And two, for transfers when
|
|
||||||
// the server has been successfully transferred to another node, and
|
|
||||||
// the client needs to switch to the new node.
|
|
||||||
if s.IsTransferring() {
|
|
||||||
s.Events().Publish(server.TransferStatusEvent, transfer.StatusCompleted)
|
|
||||||
}
|
|
||||||
s.Events().Publish(server.DeletedEvent, nil)
|
|
||||||
|
|
||||||
s.CleanupForDestroy()
|
s.CleanupForDestroy()
|
||||||
|
|
||||||
// Remove any pending remote file downloads for the server.
|
// Remove any pending remote file downloads for the server.
|
||||||
@@ -217,7 +198,7 @@ func deleteServer(c *gin.Context) {
|
|||||||
// forcibly terminate it before removing the container, so we do not need to handle
|
// forcibly terminate it before removing the container, so we do not need to handle
|
||||||
// that here.
|
// that here.
|
||||||
if err := s.Environment.Destroy(); err != nil {
|
if err := s.Environment.Destroy(); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
WithError(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -225,7 +206,7 @@ func deleteServer(c *gin.Context) {
|
|||||||
// done in a separate process since failure is not the end of the world and can be
|
// done in a separate process since failure is not the end of the world and can be
|
||||||
// manually cleaned up after the fact.
|
// manually cleaned up after the fact.
|
||||||
//
|
//
|
||||||
// In addition, servers with large amounts of files can take some time to finish deleting,
|
// In addition, servers with large amounts of files can take some time to finish deleting
|
||||||
// so we don't want to block the HTTP call while waiting on this.
|
// so we don't want to block the HTTP call while waiting on this.
|
||||||
go func(p string) {
|
go func(p string) {
|
||||||
if err := os.RemoveAll(p); err != nil {
|
if err := os.RemoveAll(p); err != nil {
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package router
|
|||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
"context"
|
"context"
|
||||||
|
"github.com/pterodactyl/wings/internal/models"
|
||||||
"io"
|
"io"
|
||||||
"mime/multipart"
|
"mime/multipart"
|
||||||
"net/http"
|
"net/http"
|
||||||
@@ -13,13 +14,13 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/pterodactyl/wings/config"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
"golang.org/x/sync/errgroup"
|
"golang.org/x/sync/errgroup"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
"github.com/pterodactyl/wings/router/downloader"
|
"github.com/pterodactyl/wings/router/downloader"
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
"github.com/pterodactyl/wings/router/tokens"
|
"github.com/pterodactyl/wings/router/tokens"
|
||||||
@@ -79,7 +80,7 @@ func getServerListDirectory(c *gin.Context) {
|
|||||||
s := ExtractServer(c)
|
s := ExtractServer(c)
|
||||||
dir := c.Query("directory")
|
dir := c.Query("directory")
|
||||||
if stats, err := s.Filesystem().ListDirectory(dir); err != nil {
|
if stats, err := s.Filesystem().ListDirectory(dir); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
WithError(c, err)
|
||||||
} else {
|
} else {
|
||||||
c.JSON(http.StatusOK, stats)
|
c.JSON(http.StatusOK, stats)
|
||||||
}
|
}
|
||||||
@@ -152,7 +153,7 @@ func putServerRenameFiles(c *gin.Context) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).AbortFilesystemError(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -172,11 +173,11 @@ func postServerCopyFile(c *gin.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if err := s.Filesystem().IsIgnored(data.Location); err != nil {
|
if err := s.Filesystem().IsIgnored(data.Location); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if err := s.Filesystem().Copy(data.Location); err != nil {
|
if err := s.Filesystem().Copy(data.Location); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).AbortFilesystemError(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -221,7 +222,7 @@ func postServerDeleteFiles(c *gin.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if err := g.Wait(); err != nil {
|
if err := g.Wait(); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -236,7 +237,7 @@ func postServerWriteFile(c *gin.Context) {
|
|||||||
f = "/" + strings.TrimLeft(f, "/")
|
f = "/" + strings.TrimLeft(f, "/")
|
||||||
|
|
||||||
if err := s.Filesystem().IsIgnored(f); err != nil {
|
if err := s.Filesystem().IsIgnored(f); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if err := s.Filesystem().Writefile(f, c.Request.Body); err != nil {
|
if err := s.Filesystem().Writefile(f, c.Request.Body); err != nil {
|
||||||
@@ -247,7 +248,7 @@ func postServerWriteFile(c *gin.Context) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).AbortFilesystemError(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -294,12 +295,12 @@ func postServerPullRemoteFile(c *gin.Context) {
|
|||||||
})
|
})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
middleware.CaptureAndAbort(c, err)
|
WithError(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := s.Filesystem().HasSpaceErr(true); err != nil {
|
if err := s.Filesystem().HasSpaceErr(true); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
WithError(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
// Do not allow more than three simultaneous remote file downloads at one time.
|
// Do not allow more than three simultaneous remote file downloads at one time.
|
||||||
@@ -338,13 +339,13 @@ func postServerPullRemoteFile(c *gin.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if err := download(); err != nil {
|
if err := download(); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
st, err := s.Filesystem().Stat(dl.Path())
|
st, err := s.Filesystem().Stat(dl.Path())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).AbortFilesystemError(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
c.JSON(http.StatusOK, &st)
|
c.JSON(http.StatusOK, &st)
|
||||||
@@ -380,7 +381,7 @@ func postServerCreateDirectory(c *gin.Context) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -415,7 +416,7 @@ func postServerCompressFiles(c *gin.Context) {
|
|||||||
|
|
||||||
f, err := s.Filesystem().CompressFiles(data.RootPath, data.Files)
|
f, err := s.Filesystem().CompressFiles(data.RootPath, data.Files)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).AbortFilesystemError(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -440,7 +441,7 @@ func postServerDecompressFiles(c *gin.Context) {
|
|||||||
s := middleware.ExtractServer(c)
|
s := middleware.ExtractServer(c)
|
||||||
lg := middleware.ExtractLogger(c).WithFields(log.Fields{"root_path": data.RootPath, "file": data.File})
|
lg := middleware.ExtractLogger(c).WithFields(log.Fields{"root_path": data.RootPath, "file": data.File})
|
||||||
lg.Debug("checking if space is available for file decompression")
|
lg.Debug("checking if space is available for file decompression")
|
||||||
err := s.Filesystem().SpaceAvailableForDecompression(context.Background(), data.RootPath, data.File)
|
err := s.Filesystem().SpaceAvailableForDecompression(data.RootPath, data.File)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if filesystem.IsErrorCode(err, filesystem.ErrCodeUnknownArchive) {
|
if filesystem.IsErrorCode(err, filesystem.ErrCodeUnknownArchive) {
|
||||||
lg.WithField("error", err).Warn("failed to decompress file: unknown archive format")
|
lg.WithField("error", err).Warn("failed to decompress file: unknown archive format")
|
||||||
@@ -452,7 +453,7 @@ func postServerDecompressFiles(c *gin.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
lg.Info("starting file decompression")
|
lg.Info("starting file decompression")
|
||||||
if err := s.Filesystem().DecompressFile(context.Background(), data.RootPath, data.File); err != nil {
|
if err := s.Filesystem().DecompressFile(data.RootPath, data.File); err != nil {
|
||||||
// If the file is busy for some reason just return a nicer error to the user since there is not
|
// If the file is busy for some reason just return a nicer error to the user since there is not
|
||||||
// much we specifically can do. They'll need to stop the running server process in order to overwrite
|
// much we specifically can do. They'll need to stop the running server process in order to overwrite
|
||||||
// a file like this.
|
// a file like this.
|
||||||
@@ -533,7 +534,7 @@ func postServerChmodFile(c *gin.Context) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).AbortFilesystemError(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -545,7 +546,7 @@ func postServerUploadFiles(c *gin.Context) {
|
|||||||
|
|
||||||
token := tokens.UploadPayload{}
|
token := tokens.UploadPayload{}
|
||||||
if err := tokens.ParseToken([]byte(c.Query("token")), &token); err != nil {
|
if err := tokens.ParseToken([]byte(c.Query("token")), &token); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewTrackedError(err).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -591,17 +592,17 @@ func postServerUploadFiles(c *gin.Context) {
|
|||||||
for _, header := range headers {
|
for _, header := range headers {
|
||||||
p, err := s.Filesystem().SafePath(filepath.Join(directory, header.Filename))
|
p, err := s.Filesystem().SafePath(filepath.Join(directory, header.Filename))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// We run this in a different method so I can use defer without any of
|
// We run this in a different method so I can use defer without any of
|
||||||
// the consequences caused by calling it in a loop.
|
// the consequences caused by calling it in a loop.
|
||||||
if err := handleFileUpload(p, s, header); err != nil {
|
if err := handleFileUpload(p, s, header); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
} else {
|
} else {
|
||||||
s.SaveActivity(s.NewRequestActivity(token.UserUuid, c.ClientIP()), server.ActivityFileUploaded, models.ActivityMeta{
|
s.SaveActivity(s.NewRequestActivity(token.UserUuid, c.Request.RemoteAddr), server.ActivityFileUploaded, models.ActivityMeta{
|
||||||
"file": header.Filename,
|
"file": header.Filename,
|
||||||
"directory": filepath.Clean(directory),
|
"directory": filepath.Clean(directory),
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,130 +0,0 @@
|
|||||||
package router
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"net/http"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
|
||||||
"github.com/gin-gonic/gin"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/environment"
|
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
|
||||||
"github.com/pterodactyl/wings/server"
|
|
||||||
"github.com/pterodactyl/wings/server/installer"
|
|
||||||
"github.com/pterodactyl/wings/server/transfer"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Data passed over to initiate a server transfer.
|
|
||||||
type serverTransferRequest struct {
|
|
||||||
URL string `binding:"required" json:"url"`
|
|
||||||
Token string `binding:"required" json:"token"`
|
|
||||||
Server installer.ServerDetails `json:"server"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// postServerTransfer handles the start of a transfer for a server.
|
|
||||||
func postServerTransfer(c *gin.Context) {
|
|
||||||
var data serverTransferRequest
|
|
||||||
if err := c.BindJSON(&data); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
s := ExtractServer(c)
|
|
||||||
|
|
||||||
// Check if the server is already being transferred.
|
|
||||||
// There will be another endpoint for resetting this value either by deleting the
|
|
||||||
// server, or by canceling the transfer.
|
|
||||||
if s.IsTransferring() {
|
|
||||||
c.AbortWithStatusJSON(http.StatusConflict, gin.H{
|
|
||||||
"error": "A transfer is already in progress for this server.",
|
|
||||||
})
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
manager := middleware.ExtractManager(c)
|
|
||||||
|
|
||||||
notifyPanelOfFailure := func() {
|
|
||||||
if err := manager.Client().SetTransferStatus(context.Background(), s.ID(), false); err != nil {
|
|
||||||
s.Log().WithField("subsystem", "transfer").
|
|
||||||
WithField("status", false).
|
|
||||||
WithError(err).
|
|
||||||
Error("failed to set transfer status")
|
|
||||||
}
|
|
||||||
|
|
||||||
s.Events().Publish(server.TransferStatusEvent, "failure")
|
|
||||||
s.SetTransferring(false)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Block the server from starting while we are transferring it.
|
|
||||||
s.SetTransferring(true)
|
|
||||||
|
|
||||||
// Ensure the server is offline. Sometimes a "No such container" error gets through
|
|
||||||
// which means the server is already stopped. We can ignore that.
|
|
||||||
if s.Environment.State() != environment.ProcessOfflineState {
|
|
||||||
if err := s.Environment.WaitForStop(
|
|
||||||
s.Context(),
|
|
||||||
time.Second*15,
|
|
||||||
false,
|
|
||||||
); err != nil && !strings.Contains(strings.ToLower(err.Error()), "no such container") {
|
|
||||||
s.SetTransferring(false)
|
|
||||||
middleware.CaptureAndAbort(c, errors.Wrap(err, "failed to stop server for transfer"))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create a new transfer instance for this server.
|
|
||||||
trnsfr := transfer.New(context.Background(), s)
|
|
||||||
transfer.Outgoing().Add(trnsfr)
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
defer transfer.Outgoing().Remove(trnsfr)
|
|
||||||
|
|
||||||
if _, err := trnsfr.PushArchiveToTarget(data.URL, data.Token); err != nil {
|
|
||||||
notifyPanelOfFailure()
|
|
||||||
|
|
||||||
if err == context.Canceled {
|
|
||||||
trnsfr.Log().Debug("canceled")
|
|
||||||
trnsfr.SendMessage("Canceled.")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
trnsfr.Log().WithError(err).Error("failed to push archive to target")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// DO NOT NOTIFY THE PANEL OF SUCCESS HERE. The only node that should send
|
|
||||||
// a success status is the destination node. When we send a failure status,
|
|
||||||
// the panel will automatically cancel the transfer and attempt to reset
|
|
||||||
// the server state on the destination node, we just need to make sure
|
|
||||||
// we clean up our statuses for failure.
|
|
||||||
|
|
||||||
trnsfr.Log().Debug("transfer complete")
|
|
||||||
}()
|
|
||||||
|
|
||||||
c.Status(http.StatusAccepted)
|
|
||||||
}
|
|
||||||
|
|
||||||
// deleteServerTransfer cancels an outgoing transfer for a server.
|
|
||||||
func deleteServerTransfer(c *gin.Context) {
|
|
||||||
s := ExtractServer(c)
|
|
||||||
|
|
||||||
if !s.IsTransferring() {
|
|
||||||
c.AbortWithStatusJSON(http.StatusConflict, gin.H{
|
|
||||||
"error": "Server is not currently being transferred.",
|
|
||||||
})
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
trnsfr := transfer.Outgoing().Get(s.ID())
|
|
||||||
if trnsfr == nil {
|
|
||||||
c.AbortWithStatusJSON(http.StatusConflict, gin.H{
|
|
||||||
"error": "Server is not currently being transferred.",
|
|
||||||
})
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
trnsfr.Cancel()
|
|
||||||
|
|
||||||
c.Status(http.StatusAccepted)
|
|
||||||
}
|
|
||||||
@@ -32,9 +32,9 @@ func getServerWebsocket(c *gin.Context) {
|
|||||||
ctx, cancel := context.WithCancel(c.Request.Context())
|
ctx, cancel := context.WithCancel(c.Request.Context())
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
handler, err := websocket.GetHandler(s, c.Writer, c.Request, c)
|
handler, err := websocket.GetHandler(s, c.Writer, c.Request)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewServerError(err, s).Abort(c)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
defer handler.Connection.Close()
|
defer handler.Connection.Close()
|
||||||
@@ -58,7 +58,7 @@ func getServerWebsocket(c *gin.Context) {
|
|||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
break
|
break
|
||||||
case <-s.Context().Done():
|
case <-s.Context().Done():
|
||||||
_ = handler.Connection.WriteControl(ws.CloseMessage, ws.FormatCloseMessage(ws.CloseGoingAway, "server deleted"), time.Now().Add(time.Second*5))
|
handler.Connection.WriteControl(ws.CloseMessage, ws.FormatCloseMessage(ws.CloseGoingAway, "server deleted"), time.Now().Add(time.Second*5))
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
@@ -83,7 +83,7 @@ func getServerWebsocket(c *gin.Context) {
|
|||||||
|
|
||||||
go func(msg websocket.Message) {
|
go func(msg websocket.Message) {
|
||||||
if err := handler.HandleInbound(ctx, msg); err != nil {
|
if err := handler.HandleInbound(ctx, msg); err != nil {
|
||||||
_ = handler.SendErrorJson(msg, err)
|
handler.SendErrorJson(msg, err)
|
||||||
}
|
}
|
||||||
}(j)
|
}(j)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,9 +10,9 @@ import (
|
|||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
|
"github.com/pterodactyl/wings/installer"
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
"github.com/pterodactyl/wings/server/installer"
|
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -20,31 +20,15 @@ import (
|
|||||||
func getSystemInformation(c *gin.Context) {
|
func getSystemInformation(c *gin.Context) {
|
||||||
i, err := system.GetSystemInformation()
|
i, err := system.GetSystemInformation()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewTrackedError(err).Abort(c)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if c.Query("v") == "2" {
|
c.JSON(http.StatusOK, i)
|
||||||
c.JSON(http.StatusOK, i)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
c.JSON(http.StatusOK, struct {
|
|
||||||
Architecture string `json:"architecture"`
|
|
||||||
CPUCount int `json:"cpu_count"`
|
|
||||||
KernelVersion string `json:"kernel_version"`
|
|
||||||
OS string `json:"os"`
|
|
||||||
Version string `json:"version"`
|
|
||||||
}{
|
|
||||||
Architecture: i.System.Architecture,
|
|
||||||
CPUCount: i.System.CPUThreads,
|
|
||||||
KernelVersion: i.System.KernelVersion,
|
|
||||||
OS: i.System.OSType,
|
|
||||||
Version: i.Version,
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Returns all the servers that are registered and configured correctly on
|
// Returns all of the servers that are registered and configured correctly on
|
||||||
// this wings instance.
|
// this wings instance.
|
||||||
func getAllServers(c *gin.Context) {
|
func getAllServers(c *gin.Context) {
|
||||||
servers := middleware.ExtractManager(c).All()
|
servers := middleware.ExtractManager(c).All()
|
||||||
@@ -91,7 +75,7 @@ func postCreateServer(c *gin.Context) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := i.Server().Install(); err != nil {
|
if err := i.Server().Install(false); err != nil {
|
||||||
log.WithFields(log.Fields{"server": i.Server().ID(), "error": err}).Error("failed to run install process for server")
|
log.WithFields(log.Fields{"server": i.Server().ID(), "error": err}).Error("failed to run install process for server")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -113,21 +97,9 @@ func postCreateServer(c *gin.Context) {
|
|||||||
c.Status(http.StatusAccepted)
|
c.Status(http.StatusAccepted)
|
||||||
}
|
}
|
||||||
|
|
||||||
type postUpdateConfigurationResponse struct {
|
|
||||||
Applied bool `json:"applied"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Updates the running configuration for this Wings instance.
|
// Updates the running configuration for this Wings instance.
|
||||||
func postUpdateConfiguration(c *gin.Context) {
|
func postUpdateConfiguration(c *gin.Context) {
|
||||||
cfg := config.Get()
|
cfg := config.Get()
|
||||||
|
|
||||||
if cfg.IgnorePanelConfigUpdates {
|
|
||||||
c.JSON(http.StatusOK, postUpdateConfigurationResponse{
|
|
||||||
Applied: false,
|
|
||||||
})
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := c.BindJSON(&cfg); err != nil {
|
if err := c.BindJSON(&cfg); err != nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -145,13 +117,11 @@ func postUpdateConfiguration(c *gin.Context) {
|
|||||||
// Try to write this new configuration to the disk before updating our global
|
// Try to write this new configuration to the disk before updating our global
|
||||||
// state with it.
|
// state with it.
|
||||||
if err := config.WriteToDisk(cfg); err != nil {
|
if err := config.WriteToDisk(cfg); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
WithError(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
// Since we wrote it to the disk successfully now update the global configuration
|
// Since we wrote it to the disk successfully now update the global configuration
|
||||||
// state to use this new configuration struct.
|
// state to use this new configuration struct.
|
||||||
config.Set(cfg)
|
config.Set(cfg)
|
||||||
c.JSON(http.StatusOK, postUpdateConfigurationResponse{
|
c.Status(http.StatusNoContent)
|
||||||
Applied: true,
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,33 +1,65 @@
|
|||||||
package router
|
package router
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bufio"
|
||||||
"context"
|
"context"
|
||||||
"crypto/sha256"
|
"crypto/sha256"
|
||||||
"encoding/hex"
|
"encoding/hex"
|
||||||
"errors"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"mime"
|
|
||||||
"mime/multipart"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync/atomic"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
"github.com/google/uuid"
|
"github.com/google/uuid"
|
||||||
|
"github.com/juju/ratelimit"
|
||||||
|
"github.com/mholt/archiver/v3"
|
||||||
|
"github.com/mitchellh/colorstring"
|
||||||
|
|
||||||
|
"github.com/pterodactyl/wings/config"
|
||||||
|
"github.com/pterodactyl/wings/installer"
|
||||||
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/router/middleware"
|
"github.com/pterodactyl/wings/router/middleware"
|
||||||
"github.com/pterodactyl/wings/router/tokens"
|
"github.com/pterodactyl/wings/router/tokens"
|
||||||
"github.com/pterodactyl/wings/server"
|
"github.com/pterodactyl/wings/server"
|
||||||
"github.com/pterodactyl/wings/server/installer"
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
"github.com/pterodactyl/wings/server/transfer"
|
"github.com/pterodactyl/wings/system"
|
||||||
)
|
)
|
||||||
|
|
||||||
// postTransfers .
|
// Number of ticks in the progress bar
|
||||||
func postTransfers(c *gin.Context) {
|
const ticks = 25
|
||||||
|
|
||||||
|
// 100% / number of ticks = percentage represented by each tick
|
||||||
|
const tickPercentage = 100 / ticks
|
||||||
|
|
||||||
|
type downloadProgress struct {
|
||||||
|
size int64
|
||||||
|
progress int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// Data passed over to initiate a server transfer.
|
||||||
|
type serverTransferRequest struct {
|
||||||
|
ServerID string `binding:"required" json:"server_id"`
|
||||||
|
URL string `binding:"required" json:"url"`
|
||||||
|
Token string `binding:"required" json:"token"`
|
||||||
|
Server installer.ServerDetails `json:"server"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func getArchivePath(sID string) string {
|
||||||
|
return filepath.Join(config.Get().System.ArchiveDirectory, sID+".tar.gz")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns the archive for a server so that it can be transferred to a new node.
|
||||||
|
func getServerArchive(c *gin.Context) {
|
||||||
auth := strings.SplitN(c.GetHeader("Authorization"), " ", 2)
|
auth := strings.SplitN(c.GetHeader("Authorization"), " ", 2)
|
||||||
|
|
||||||
if len(auth) != 2 || auth[0] != "Bearer" {
|
if len(auth) != 2 || auth[0] != "Bearer" {
|
||||||
c.Header("WWW-Authenticate", "Bearer")
|
c.Header("WWW-Authenticate", "Bearer")
|
||||||
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{
|
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{
|
||||||
@@ -38,236 +70,441 @@ func postTransfers(c *gin.Context) {
|
|||||||
|
|
||||||
token := tokens.TransferPayload{}
|
token := tokens.TransferPayload{}
|
||||||
if err := tokens.ParseToken([]byte(auth[1]), &token); err != nil {
|
if err := tokens.ParseToken([]byte(auth[1]), &token); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
NewTrackedError(err).Abort(c)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
s := ExtractServer(c)
|
||||||
|
if token.Subject != s.ID() {
|
||||||
|
c.AbortWithStatusJSON(http.StatusForbidden, gin.H{
|
||||||
|
"error": "Missing required token subject, or subject is not valid for the requested server.",
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
archivePath := getArchivePath(s.ID())
|
||||||
|
|
||||||
|
// Stat the archive file.
|
||||||
|
st, err := os.Lstat(archivePath)
|
||||||
|
if err != nil {
|
||||||
|
if !errors.Is(err, os.ErrNotExist) {
|
||||||
|
_ = WithError(c, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
c.AbortWithStatus(http.StatusNotFound)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compute sha1 checksum.
|
||||||
|
h := sha256.New()
|
||||||
|
f, err := os.Open(archivePath)
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if _, err := io.Copy(h, bufio.NewReader(f)); err != nil {
|
||||||
|
_ = f.Close()
|
||||||
|
_ = WithError(c, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := f.Close(); err != nil {
|
||||||
|
_ = WithError(c, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
checksum := hex.EncodeToString(h.Sum(nil))
|
||||||
|
|
||||||
|
// Stream the file to the client.
|
||||||
|
f, err = os.Open(archivePath)
|
||||||
|
if err != nil {
|
||||||
|
_ = WithError(c, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
defer f.Close()
|
||||||
|
|
||||||
|
c.Header("X-Checksum", checksum)
|
||||||
|
c.Header("X-Mime-Type", "application/tar+gzip")
|
||||||
|
c.Header("Content-Length", strconv.Itoa(int(st.Size())))
|
||||||
|
c.Header("Content-Disposition", "attachment; filename="+strconv.Quote(s.ID()+".tar.gz"))
|
||||||
|
c.Header("Content-Type", "application/octet-stream")
|
||||||
|
|
||||||
|
_, _ = bufio.NewReader(f).WriteTo(c.Writer)
|
||||||
|
}
|
||||||
|
|
||||||
|
func postServerArchive(c *gin.Context) {
|
||||||
|
s := middleware.ExtractServer(c)
|
||||||
|
manager := middleware.ExtractManager(c)
|
||||||
|
|
||||||
|
go func(s *server.Server) {
|
||||||
|
l := log.WithField("server", s.ID())
|
||||||
|
|
||||||
|
// This function automatically adds the Source Node prefix and Timestamp to the log
|
||||||
|
// output before sending it over the websocket.
|
||||||
|
sendTransferLog := func(data string) {
|
||||||
|
output := colorstring.Color(fmt.Sprintf("[yellow][bold]%s [Pterodactyl Transfer System] [Source Node]:[default] %s", time.Now().Format(time.RFC1123), data))
|
||||||
|
s.Events().Publish(server.TransferLogsEvent, output)
|
||||||
|
}
|
||||||
|
|
||||||
|
s.Events().Publish(server.TransferStatusEvent, "starting")
|
||||||
|
sendTransferLog("Attempting to archive server...")
|
||||||
|
|
||||||
|
hasError := true
|
||||||
|
defer func() {
|
||||||
|
if !hasError {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mark the server as not being transferred so it can actually be used.
|
||||||
|
s.SetTransferring(false)
|
||||||
|
s.Events().Publish(server.TransferStatusEvent, "failure")
|
||||||
|
|
||||||
|
sendTransferLog("Attempting to notify panel of archive failure..")
|
||||||
|
if err := manager.Client().SetArchiveStatus(s.Context(), s.ID(), false); err != nil {
|
||||||
|
if !remote.IsRequestError(err) {
|
||||||
|
sendTransferLog("Failed to notify panel of archive failure: " + err.Error())
|
||||||
|
l.WithField("error", err).Error("failed to notify panel of failed archive status")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
sendTransferLog("Panel returned an error while notifying it of a failed archive: " + err.Error())
|
||||||
|
l.WithField("error", err.Error()).Error("panel returned an error when notifying it of a failed archive status")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
sendTransferLog("Successfully notified panel of failed archive status")
|
||||||
|
l.Info("successfully notified panel of failed archive status")
|
||||||
|
}()
|
||||||
|
|
||||||
|
// Mark the server as transferring to prevent problems.
|
||||||
|
s.SetTransferring(true)
|
||||||
|
|
||||||
|
// Ensure the server is offline. Sometimes a "No such container" error gets through
|
||||||
|
// which means the server is already stopped. We can ignore that.
|
||||||
|
if err := s.Environment.WaitForStop(s.Context(), time.Minute, false); err != nil && !strings.Contains(strings.ToLower(err.Error()), "no such container") {
|
||||||
|
sendTransferLog("Failed to stop server, aborting transfer..")
|
||||||
|
l.WithField("error", err).Error("failed to stop server")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create an archive of the entire server's data directory.
|
||||||
|
a := &filesystem.Archive{
|
||||||
|
BasePath: s.Filesystem().Path(),
|
||||||
|
}
|
||||||
|
|
||||||
|
// Attempt to get an archive of the server.
|
||||||
|
if err := a.Create(getArchivePath(s.ID())); err != nil {
|
||||||
|
sendTransferLog("An error occurred while archiving the server: " + err.Error())
|
||||||
|
l.WithField("error", err).Error("failed to get transfer archive for server")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
sendTransferLog("Successfully created archive, attempting to notify panel..")
|
||||||
|
l.Info("successfully created server transfer archive, notifying panel..")
|
||||||
|
|
||||||
|
if err := manager.Client().SetArchiveStatus(s.Context(), s.ID(), true); err != nil {
|
||||||
|
if !remote.IsRequestError(err) {
|
||||||
|
sendTransferLog("Failed to notify panel of archive success: " + err.Error())
|
||||||
|
l.WithField("error", err).Error("failed to notify panel of successful archive status")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
sendTransferLog("Panel returned an error while notifying it of a successful archive: " + err.Error())
|
||||||
|
l.WithField("error", err.Error()).Error("panel returned an error when notifying it of a successful archive status")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
hasError = false
|
||||||
|
|
||||||
|
// This log may not be displayed by the client due to the status event being sent before or at the same time.
|
||||||
|
sendTransferLog("Successfully notified panel of successful archive status")
|
||||||
|
|
||||||
|
l.Info("successfully notified panel of successful transfer archive status")
|
||||||
|
s.Events().Publish(server.TransferStatusEvent, "archived")
|
||||||
|
}(s)
|
||||||
|
|
||||||
|
c.Status(http.StatusAccepted)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *downloadProgress) Write(v []byte) (int, error) {
|
||||||
|
n := len(v)
|
||||||
|
atomic.AddInt64(&w.progress, int64(n))
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Log helper function to attach all errors and info output to a consistently formatted
|
||||||
|
// log string for easier querying.
|
||||||
|
func (str serverTransferRequest) log() *log.Entry {
|
||||||
|
return log.WithField("subsystem", "transfers").WithField("server_id", str.ServerID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Downloads an archive from the machine that the server currently lives on.
|
||||||
|
func (str serverTransferRequest) downloadArchive() (*http.Response, error) {
|
||||||
|
client := http.Client{Timeout: 0}
|
||||||
|
req, err := http.NewRequest(http.MethodGet, str.URL, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
req.Header.Set("Authorization", str.Token)
|
||||||
|
res, err := client.Do(req) // lgtm [go/request-forgery]
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return res, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns the path to the local archive on the system.
|
||||||
|
func (str serverTransferRequest) path() string {
|
||||||
|
return getArchivePath(str.ServerID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Creates the archive location on this machine by first checking that the required file
|
||||||
|
// does not already exist. If it does exist, the file is deleted and then re-created as
|
||||||
|
// an empty file.
|
||||||
|
func (str serverTransferRequest) createArchiveFile() (*os.File, error) {
|
||||||
|
p := str.path()
|
||||||
|
if _, err := os.Stat(p); err != nil {
|
||||||
|
if !os.IsNotExist(err) {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
} else if err := os.Remove(p); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return os.Create(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deletes the archive from the local filesystem. This is executed as a deferred function.
|
||||||
|
func (str serverTransferRequest) removeArchivePath() {
|
||||||
|
p := str.path()
|
||||||
|
str.log().Debug("deleting temporary transfer archive")
|
||||||
|
if err := os.Remove(p); err != nil && !os.IsNotExist(err) {
|
||||||
|
str.log().WithField("path", p).WithField("error", err).Error("failed to delete temporary transfer archive file")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
str.log().Debug("deleted temporary transfer archive successfully")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verifies that the SHA-256 checksum of the file on the local filesystem matches the
|
||||||
|
// expected value from the transfer request. The string value returned is the computed
|
||||||
|
// checksum on the system.
|
||||||
|
func (str serverTransferRequest) verifyChecksum(matches string) (bool, string, error) {
|
||||||
|
f, err := os.Open(str.path())
|
||||||
|
if err != nil {
|
||||||
|
return false, "", err
|
||||||
|
}
|
||||||
|
defer f.Close()
|
||||||
|
h := sha256.New()
|
||||||
|
if _, err := io.Copy(h, bufio.NewReader(f)); err != nil {
|
||||||
|
return false, "", err
|
||||||
|
}
|
||||||
|
checksum := hex.EncodeToString(h.Sum(nil))
|
||||||
|
return checksum == matches, checksum, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sends a notification to the Panel letting it know what the status of this transfer is.
|
||||||
|
func (str serverTransferRequest) sendTransferStatus(client remote.Client, successful bool) error {
|
||||||
|
lg := str.log().WithField("transfer_successful", successful)
|
||||||
|
lg.Info("notifying Panel of server transfer state")
|
||||||
|
if err := client.SetTransferStatus(context.Background(), str.ServerID, successful); err != nil {
|
||||||
|
lg.WithField("error", err).Error("error notifying panel of transfer state")
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
lg.Debug("notified panel of transfer state")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Initiates a transfer between two nodes for a server by downloading an archive from the
|
||||||
|
// remote node and then applying the server details to this machine.
|
||||||
|
func postTransfer(c *gin.Context) {
|
||||||
|
var data serverTransferRequest
|
||||||
|
if err := c.BindJSON(&data); err != nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
manager := middleware.ExtractManager(c)
|
manager := middleware.ExtractManager(c)
|
||||||
u, err := uuid.Parse(token.Subject)
|
u, err := uuid.Parse(data.ServerID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
WithError(c, err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
// Force the server ID to be a valid UUID string at this point. If it is not an error
|
||||||
|
// is returned to the caller. This limits injection vulnerabilities that would cause
|
||||||
|
// the str.path() function to return a location not within the server archive directory.
|
||||||
|
data.ServerID = u.String()
|
||||||
|
|
||||||
// Get or create a new transfer instance for this server.
|
data.log().Info("handling incoming server transfer request")
|
||||||
var (
|
go func(data *serverTransferRequest) {
|
||||||
ctx context.Context
|
hasError := true
|
||||||
cancel context.CancelFunc
|
|
||||||
)
|
|
||||||
trnsfr := transfer.Incoming().Get(u.String())
|
|
||||||
if trnsfr == nil {
|
|
||||||
// TODO: should this use the request context?
|
|
||||||
trnsfr = transfer.New(c, nil)
|
|
||||||
|
|
||||||
ctx, cancel = context.WithCancel(trnsfr.Context())
|
// Create a new server installer. This will only configure the environment and not
|
||||||
defer cancel()
|
// run the installer scripts.
|
||||||
|
i, err := installer.New(context.Background(), manager, data.Server)
|
||||||
i, err := installer.New(ctx, manager, installer.ServerDetails{
|
|
||||||
UUID: u.String(),
|
|
||||||
StartOnCompletion: false,
|
|
||||||
})
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if err := manager.Client().SetTransferStatus(context.Background(), trnsfr.Server.ID(), false); err != nil {
|
_ = data.sendTransferStatus(manager.Client(), false)
|
||||||
trnsfr.Log().WithField("status", false).WithError(err).Error("failed to set transfer status")
|
data.log().WithField("error", err).Error("failed to validate received server data")
|
||||||
}
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// This function automatically adds the Target Node prefix and Timestamp to the log output before sending it
|
||||||
|
// over the websocket.
|
||||||
|
sendTransferLog := func(data string) {
|
||||||
|
output := colorstring.Color(fmt.Sprintf("[yellow][bold]%s [Pterodactyl Transfer System] [Target Node]:[default] %s", time.Now().Format(time.RFC1123), data))
|
||||||
|
i.Server().Events().Publish(server.TransferLogsEvent, output)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mark the server as transferring to prevent problems later on during the process and
|
||||||
|
// then push the server into the global server collection for this instance.
|
||||||
i.Server().SetTransferring(true)
|
i.Server().SetTransferring(true)
|
||||||
manager.Add(i.Server())
|
manager.Add(i.Server())
|
||||||
|
defer func(s *server.Server) {
|
||||||
|
// In the event that this transfer call fails, remove the server from the global
|
||||||
|
// server tracking so that we don't have a dangling instance.
|
||||||
|
if err := data.sendTransferStatus(manager.Client(), !hasError); hasError || err != nil {
|
||||||
|
sendTransferLog("Server transfer failed, check Wings logs for additional information.")
|
||||||
|
s.Events().Publish(server.TransferStatusEvent, "failure")
|
||||||
|
manager.Remove(func(match *server.Server) bool {
|
||||||
|
return match.ID() == s.ID()
|
||||||
|
})
|
||||||
|
|
||||||
// We add the transfer to the list of transfers once we have a server instance to use.
|
// If the transfer status was successful but the request failed, act like the transfer failed.
|
||||||
trnsfr.Server = i.Server()
|
if !hasError && err != nil {
|
||||||
transfer.Incoming().Add(trnsfr)
|
// Delete all extracted files.
|
||||||
} else {
|
if err := os.RemoveAll(s.Filesystem().Path()); err != nil && !os.IsNotExist(err) {
|
||||||
ctx, cancel = context.WithCancel(trnsfr.Context())
|
data.log().WithField("error", err).Warn("failed to delete local server files directory")
|
||||||
defer cancel()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Any errors past this point (until the transfer is complete) will abort
|
|
||||||
// the transfer.
|
|
||||||
|
|
||||||
successful := false
|
|
||||||
defer func(ctx context.Context, trnsfr *transfer.Transfer) {
|
|
||||||
// Remove the transfer from the list of incoming transfers.
|
|
||||||
transfer.Incoming().Remove(trnsfr)
|
|
||||||
|
|
||||||
if !successful {
|
|
||||||
trnsfr.Server.Events().Publish(server.TransferStatusEvent, "failure")
|
|
||||||
manager.Remove(func(match *server.Server) bool {
|
|
||||||
return match.ID() == trnsfr.Server.ID()
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := manager.Client().SetTransferStatus(context.Background(), trnsfr.Server.ID(), successful); err != nil {
|
|
||||||
// Only delete the files if the transfer actually failed, otherwise we could have
|
|
||||||
// unrecoverable data-loss.
|
|
||||||
if !successful && err != nil {
|
|
||||||
// Delete all extracted files.
|
|
||||||
go func(trnsfr *transfer.Transfer) {
|
|
||||||
if err := os.RemoveAll(trnsfr.Server.Filesystem().Path()); err != nil && !os.IsNotExist(err) {
|
|
||||||
trnsfr.Log().WithError(err).Warn("failed to delete local server files")
|
|
||||||
}
|
}
|
||||||
}(trnsfr)
|
}
|
||||||
|
} else {
|
||||||
|
s.SetTransferring(false)
|
||||||
|
s.Events().Publish(server.TransferStatusEvent, "success")
|
||||||
|
sendTransferLog("Transfer completed.")
|
||||||
}
|
}
|
||||||
|
}(i.Server())
|
||||||
|
|
||||||
trnsfr.Log().WithField("status", successful).WithError(err).Error("failed to set transfer status on panel")
|
data.log().Info("downloading server archive from current server node")
|
||||||
|
sendTransferLog("Received incoming transfer from Panel, attempting to download archive from source node...")
|
||||||
|
res, err := data.downloadArchive()
|
||||||
|
if err != nil {
|
||||||
|
sendTransferLog("Failed to retrieve server archive from remote node: " + err.Error())
|
||||||
|
data.log().WithField("error", err).Error("failed to download archive for server transfer")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
defer res.Body.Close()
|
||||||
|
if res.StatusCode != http.StatusOK {
|
||||||
|
data.log().WithField("error", err).WithField("status", res.StatusCode).Error("unexpected error response from transfer endpoint")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
trnsfr.Server.SetTransferring(false)
|
size := res.ContentLength
|
||||||
trnsfr.Server.Events().Publish(server.TransferStatusEvent, "success")
|
if size == 0 {
|
||||||
}(ctx, trnsfr)
|
data.log().WithField("error", err).Error("received an archive response with Content-Length of 0")
|
||||||
|
return
|
||||||
mediaType, params, err := mime.ParseMediaType(c.GetHeader("Content-Type"))
|
}
|
||||||
if err != nil {
|
sendTransferLog("Got server archive response from remote node. (Content-Length: " + strconv.Itoa(int(size)) + ")")
|
||||||
trnsfr.Log().Debug("failed to parse content type header")
|
sendTransferLog("Creating local archive file...")
|
||||||
middleware.CaptureAndAbort(c, err)
|
file, err := data.createArchiveFile()
|
||||||
return
|
if err != nil {
|
||||||
}
|
data.log().WithField("error", err).Error("failed to create archive file on local filesystem")
|
||||||
|
return
|
||||||
if !strings.HasPrefix(mediaType, "multipart/") {
|
|
||||||
trnsfr.Log().Debug("invalid content type")
|
|
||||||
middleware.CaptureAndAbort(c, fmt.Errorf("invalid content type \"%s\", expected \"multipart/form-data\"", mediaType))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Used to calculate the hash of the file as it is being uploaded.
|
|
||||||
h := sha256.New()
|
|
||||||
|
|
||||||
// Used to read the file and checksum from the request body.
|
|
||||||
mr := multipart.NewReader(c.Request.Body, params["boundary"])
|
|
||||||
|
|
||||||
// Loop through the parts of the request body and process them.
|
|
||||||
var (
|
|
||||||
hasArchive bool
|
|
||||||
hasChecksum bool
|
|
||||||
checksumVerified bool
|
|
||||||
)
|
|
||||||
out:
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
break out
|
|
||||||
default:
|
|
||||||
p, err := mr.NextPart()
|
|
||||||
if err == io.EOF {
|
|
||||||
break out
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
name := p.FormName()
|
|
||||||
switch name {
|
|
||||||
case "archive":
|
|
||||||
trnsfr.Log().Debug("received archive")
|
|
||||||
|
|
||||||
if err := trnsfr.Server.EnsureDataDirectoryExists(); err != nil {
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
tee := io.TeeReader(p, h)
|
|
||||||
if err := trnsfr.Server.Filesystem().ExtractStreamUnsafe(ctx, "/", tee); err != nil {
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
hasArchive = true
|
|
||||||
case "checksum":
|
|
||||||
trnsfr.Log().Debug("received checksum")
|
|
||||||
|
|
||||||
if !hasArchive {
|
|
||||||
middleware.CaptureAndAbort(c, errors.New("archive must be sent before the checksum"))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
hasChecksum = true
|
|
||||||
|
|
||||||
v, err := io.ReadAll(p)
|
|
||||||
if err != nil {
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
expected := make([]byte, hex.DecodedLen(len(v)))
|
|
||||||
n, err := hex.Decode(expected, v)
|
|
||||||
if err != nil {
|
|
||||||
middleware.CaptureAndAbort(c, err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
actual := h.Sum(nil)
|
|
||||||
|
|
||||||
trnsfr.Log().WithFields(log.Fields{
|
|
||||||
"expected": hex.EncodeToString(expected),
|
|
||||||
"actual": hex.EncodeToString(actual),
|
|
||||||
}).Debug("checksums")
|
|
||||||
|
|
||||||
if !bytes.Equal(expected[:n], actual) {
|
|
||||||
middleware.CaptureAndAbort(c, errors.New("checksums don't match"))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
trnsfr.Log().Debug("checksums match")
|
|
||||||
checksumVerified = true
|
|
||||||
default:
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
if !hasArchive || !hasChecksum {
|
sendTransferLog("Writing archive to disk...")
|
||||||
middleware.CaptureAndAbort(c, errors.New("missing archive or checksum"))
|
data.log().Info("writing transfer archive to disk...")
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if !checksumVerified {
|
// Copy the file.
|
||||||
middleware.CaptureAndAbort(c, errors.New("checksums don't match"))
|
progress := &downloadProgress{size: size}
|
||||||
return
|
ticker := time.NewTicker(3 * time.Second)
|
||||||
}
|
go func(progress *downloadProgress, t *time.Ticker) {
|
||||||
|
for range ticker.C {
|
||||||
|
// p = 100 (Downloaded)
|
||||||
|
// size = 1000 (Content-Length)
|
||||||
|
// p / size = 0.1
|
||||||
|
// * 100 = 10% (Multiply by 100 to get a percentage of the download)
|
||||||
|
// 10% / tickPercentage = (10% / (100 / 25)) (Divide by tick percentage to get the number of ticks)
|
||||||
|
// 2.5 (Number of ticks as a float64)
|
||||||
|
// 2 (convert to an integer)
|
||||||
|
p := atomic.LoadInt64(&progress.progress)
|
||||||
|
// We have to cast these numbers to float in order to get a float result from the division.
|
||||||
|
width := ((float64(p) / float64(size)) * 100) / tickPercentage
|
||||||
|
bar := strings.Repeat("=", int(width)) + strings.Repeat(" ", ticks-int(width))
|
||||||
|
sendTransferLog("Downloading [" + bar + "] " + system.FormatBytes(p) + " / " + system.FormatBytes(progress.size))
|
||||||
|
}
|
||||||
|
}(progress, ticker)
|
||||||
|
|
||||||
// Transfer is almost complete, we just want to ensure the environment is
|
var reader io.Reader
|
||||||
// configured correctly. We might want to not fail the transfer at this
|
downloadLimit := float64(config.Get().System.Transfers.DownloadLimit) * 1024 * 1024
|
||||||
// stage, but we will just to be safe.
|
if downloadLimit > 0 {
|
||||||
|
// Wrap the body with a reader that is limited to the defined download limit speed.
|
||||||
|
reader = ratelimit.Reader(res.Body, ratelimit.NewBucketWithRate(downloadLimit, int64(downloadLimit)))
|
||||||
|
} else {
|
||||||
|
reader = res.Body
|
||||||
|
}
|
||||||
|
|
||||||
// Ensure the server environment gets configured.
|
buf := make([]byte, 1024*4)
|
||||||
if err := trnsfr.Server.CreateEnvironment(); err != nil {
|
if _, err := io.CopyBuffer(file, io.TeeReader(reader, progress), buf); err != nil {
|
||||||
middleware.CaptureAndAbort(c, err)
|
ticker.Stop()
|
||||||
return
|
_ = file.Close()
|
||||||
}
|
|
||||||
|
|
||||||
// Changing this causes us to notify the panel about a successful transfer,
|
sendTransferLog("Failed while writing archive file to disk: " + err.Error())
|
||||||
// rather than failing the transfer like we do by default.
|
data.log().WithField("error", err).Error("failed to copy archive file to disk")
|
||||||
successful = true
|
return
|
||||||
|
}
|
||||||
|
ticker.Stop()
|
||||||
|
|
||||||
// The rest of the logic for ensuring the server is unlocked and everything
|
// Show 100% completion.
|
||||||
// is handled in the deferred function above.
|
humanSize := system.FormatBytes(progress.size)
|
||||||
trnsfr.Log().Debug("done!")
|
sendTransferLog("Downloading [" + strings.Repeat("=", ticks) + "] " + humanSize + " / " + humanSize)
|
||||||
}
|
|
||||||
|
|
||||||
// deleteTransfer cancels an incoming transfer for a server.
|
if err := file.Close(); err != nil {
|
||||||
func deleteTransfer(c *gin.Context) {
|
data.log().WithField("error", err).Error("unable to close archive file on local filesystem")
|
||||||
s := ExtractServer(c)
|
return
|
||||||
|
}
|
||||||
|
data.log().Info("finished writing transfer archive to disk")
|
||||||
|
sendTransferLog("Successfully wrote archive to disk.")
|
||||||
|
|
||||||
if !s.IsTransferring() {
|
// Whenever the transfer fails or succeeds, delete the temporary transfer archive that
|
||||||
c.AbortWithStatusJSON(http.StatusConflict, gin.H{
|
// was created on the disk.
|
||||||
"error": "Server is not currently being transferred.",
|
defer data.removeArchivePath()
|
||||||
})
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
trnsfr := transfer.Incoming().Get(s.ID())
|
sendTransferLog("Verifying checksum of downloaded archive...")
|
||||||
if trnsfr == nil {
|
data.log().Info("computing checksum of downloaded archive file")
|
||||||
c.AbortWithStatusJSON(http.StatusConflict, gin.H{
|
expected := res.Header.Get("X-Checksum")
|
||||||
"error": "Server is not currently being transferred.",
|
if matches, computed, err := data.verifyChecksum(expected); err != nil {
|
||||||
})
|
data.log().WithField("error", err).Error("encountered an error while calculating local filesystem archive checksum")
|
||||||
return
|
return
|
||||||
}
|
} else if !matches {
|
||||||
|
sendTransferLog("@@@@@ CHECKSUM VERIFICATION FAILED @@@@@")
|
||||||
|
sendTransferLog(" - Source Checksum: " + expected)
|
||||||
|
sendTransferLog(" - Computed Checksum: " + computed)
|
||||||
|
data.log().WithField("expected_sum", expected).WithField("computed_checksum", computed).Error("checksum mismatch when verifying integrity of local archive")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
trnsfr.Cancel()
|
// Create the server's environment.
|
||||||
|
sendTransferLog("Creating server environment, this could take a while..")
|
||||||
|
data.log().Info("creating server environment")
|
||||||
|
if err := i.Server().CreateEnvironment(); err != nil {
|
||||||
|
data.log().WithField("error", err).Error("failed to create server environment")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
sendTransferLog("Server environment has been created, extracting transfer archive..")
|
||||||
|
data.log().Info("server environment configured, extracting transfer archive")
|
||||||
|
if err := archiver.NewTarGz().Unarchive(data.path(), i.Server().Filesystem().Path()); err != nil {
|
||||||
|
// Un-archiving failed, delete the server's data directory.
|
||||||
|
if err := os.RemoveAll(i.Server().Filesystem().Path()); err != nil && !os.IsNotExist(err) {
|
||||||
|
data.log().WithField("error", err).Warn("failed to delete local server files directory")
|
||||||
|
}
|
||||||
|
data.log().WithField("error", err).Error("failed to extract server archive")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// We mark the process as being successful here as if we fail to send a transfer success,
|
||||||
|
// then a transfer failure won't probably be successful either.
|
||||||
|
//
|
||||||
|
// It may be useful to retry sending the transfer success every so often just in case of a small
|
||||||
|
// hiccup or the fix of whatever error causing the success request to fail.
|
||||||
|
hasError = false
|
||||||
|
|
||||||
|
data.log().Info("archive extracted successfully, notifying Panel of status")
|
||||||
|
sendTransferLog("Archive extracted successfully.")
|
||||||
|
}(&data)
|
||||||
|
|
||||||
c.Status(http.StatusAccepted)
|
c.Status(http.StatusAccepted)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ import (
|
|||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/goccy/go-json"
|
"github.com/goccy/go-json"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/events"
|
"github.com/pterodactyl/wings/events"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
|
||||||
|
|||||||
@@ -3,21 +3,18 @@ package websocket
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/pterodactyl/wings/internal/models"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/gbrlsnchs/jwt/v3"
|
"github.com/gbrlsnchs/jwt/v3"
|
||||||
"github.com/gin-gonic/gin"
|
|
||||||
"github.com/goccy/go-json"
|
"github.com/goccy/go-json"
|
||||||
"github.com/google/uuid"
|
"github.com/google/uuid"
|
||||||
"github.com/gorilla/websocket"
|
"github.com/gorilla/websocket"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
@@ -82,7 +79,7 @@ func NewTokenPayload(token []byte) (*tokens.WebsocketPayload, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// GetHandler returns a new websocket handler using the context provided.
|
// GetHandler returns a new websocket handler using the context provided.
|
||||||
func GetHandler(s *server.Server, w http.ResponseWriter, r *http.Request, c *gin.Context) (*Handler, error) {
|
func GetHandler(s *server.Server, w http.ResponseWriter, r *http.Request) (*Handler, error) {
|
||||||
upgrader := websocket.Upgrader{
|
upgrader := websocket.Upgrader{
|
||||||
// Ensure that the websocket request is originating from the Panel itself,
|
// Ensure that the websocket request is originating from the Panel itself,
|
||||||
// and not some other location.
|
// and not some other location.
|
||||||
@@ -114,7 +111,7 @@ func GetHandler(s *server.Server, w http.ResponseWriter, r *http.Request, c *gin
|
|||||||
Connection: conn,
|
Connection: conn,
|
||||||
jwt: nil,
|
jwt: nil,
|
||||||
server: s,
|
server: s,
|
||||||
ra: s.NewRequestActivity("", c.ClientIP()),
|
ra: s.NewRequestActivity("", r.RemoteAddr),
|
||||||
uuid: u,
|
uuid: u,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|||||||
124
rpm/ptero-wings.spec
Normal file
124
rpm/ptero-wings.spec
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
Name: ptero-wings
|
||||||
|
Version: 1.7.0
|
||||||
|
Release: 1%{?dist}
|
||||||
|
Summary: The server control plane for Pterodactyl Panel. Written from the ground-up with security, speed, and stability in mind.
|
||||||
|
BuildArch: x86_64
|
||||||
|
License: MIT
|
||||||
|
URL: https://github.com/pterodactyl/wings
|
||||||
|
Source0: https://github.com/pterodactyl/wings/releases/download/v%{version}/wings_linux_amd64
|
||||||
|
|
||||||
|
%if 0%{?rhel} && 0%{?rhel} <= 8
|
||||||
|
BuildRequires: systemd
|
||||||
|
%else
|
||||||
|
BuildRequires: systemd-rpm-macros
|
||||||
|
%endif
|
||||||
|
|
||||||
|
|
||||||
|
%description
|
||||||
|
Wings is Pterodactyl's server control plane, built for the rapidly
|
||||||
|
changing gaming industry and designed to be highly performant and
|
||||||
|
secure. Wings provides an HTTP API allowing you to interface directly
|
||||||
|
with running server instances, fetch server logs, generate backups,
|
||||||
|
and control all aspects of the server lifecycle.
|
||||||
|
|
||||||
|
In addition, Wings ships with a built-in SFTP server allowing your
|
||||||
|
system to remain free of Pterodactyl specific dependencies, and
|
||||||
|
allowing users to authenticate with the same credentials they would
|
||||||
|
normally use to access the Panel.
|
||||||
|
|
||||||
|
%prep
|
||||||
|
|
||||||
|
%build
|
||||||
|
#nothing required
|
||||||
|
|
||||||
|
%install
|
||||||
|
mkdir -p %{buildroot}%{_bindir}
|
||||||
|
mkdir -p %{buildroot}%{_unitdir}
|
||||||
|
cp %{_sourcedir}/wings_linux_amd64 %{buildroot}%{_bindir}/wings
|
||||||
|
|
||||||
|
cat > %{buildroot}%{_unitdir}/wings.service << EOF
|
||||||
|
[Unit]
|
||||||
|
Description=Pterodactyl Wings Daemon
|
||||||
|
After=docker.service
|
||||||
|
Requires=docker.service
|
||||||
|
PartOf=docker.service
|
||||||
|
StartLimitIntervalSec=600
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
WorkingDirectory=/etc/pterodactyl
|
||||||
|
ExecStart=/usr/bin/wings
|
||||||
|
ExecReload=/bin/kill -HUP $MAINPID
|
||||||
|
Restart=on-failure
|
||||||
|
StartLimitInterval=180
|
||||||
|
StartLimitBurst=30
|
||||||
|
RestartSec=5s
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
EOF
|
||||||
|
|
||||||
|
%files
|
||||||
|
%attr(0755, root, root) %{_prefix}/bin/wings
|
||||||
|
%attr(0644, root, root) %{_unitdir}/wings.service
|
||||||
|
|
||||||
|
%post
|
||||||
|
|
||||||
|
# Reload systemd
|
||||||
|
systemctl daemon-reload
|
||||||
|
|
||||||
|
# Create the required directory structure
|
||||||
|
mkdir -p /etc/pterodactyl
|
||||||
|
mkdir -p /var/lib/pterodactyl/{archives,backups,volumes}
|
||||||
|
mkdir -p /var/log/pterodactyl/install
|
||||||
|
|
||||||
|
%preun
|
||||||
|
|
||||||
|
systemctl is-active %{name} >/dev/null 2>&1
|
||||||
|
if [ $? -eq 0 ]; then
|
||||||
|
systemctl stop %{name}
|
||||||
|
fi
|
||||||
|
|
||||||
|
systemctl is-enabled %{name} >/dev/null 2>&1
|
||||||
|
if [ $? -eq 0 ]; then
|
||||||
|
systemctl disable %{name}
|
||||||
|
fi
|
||||||
|
|
||||||
|
%postun
|
||||||
|
rm -rf /var/log/pterodactyl
|
||||||
|
|
||||||
|
%verifyscript
|
||||||
|
|
||||||
|
wings --version
|
||||||
|
|
||||||
|
%changelog
|
||||||
|
* Wed Sep 14 2022 Chance Callahan <ccallaha@redhat.com> - 1.7.0-1
|
||||||
|
- Updating specfile to match stable release.
|
||||||
|
|
||||||
|
* Wed Oct 27 2021 Capitol Hosting Solutions Systems Engineering <syseng@chs.gg> - 1.5.3-1
|
||||||
|
- specfile by Capitol Hosting Solutions, Upstream by Pterodactyl
|
||||||
|
- Rebased for https://github.com/pterodactyl/wings/releases/tag/v1.5.3
|
||||||
|
- Fixes improper event registration and error handling during socket authentication that would cause the incorrect error message to be returned to the client, or no error in some scenarios. Event registration is now delayed until the socket is fully authenticated to ensure needless listeners are not registed.
|
||||||
|
- Fixes dollar signs always being evaluated as environment variables with no way to escape them. They can now be escaped as $$ which will transform into a single dollar sign.
|
||||||
|
- A websocket connection to a server will be closed by Wings if there is a send error encountered and the client will be left to handle reconnections, rather than simply logging the error and continuing to listen for new events.
|
||||||
|
|
||||||
|
* Sun Sep 12 2021 Capitol Hosting Solutions Systems Engineering <syseng@chs.gg> - 1.5.0-1
|
||||||
|
- specfile by Capitol Hosting Solutions, Upstream by Pterodactyl
|
||||||
|
- Rebased for https://github.com/pterodactyl/wings/releases/tag/v1.5.0
|
||||||
|
- Fixes a race condition when setting the application name in the console output for a server.
|
||||||
|
- Fixes a server being reinstalled causing the file_denylist parameter for an Egg to be ignored until Wings is restarted.
|
||||||
|
- Fixes YAML file parser not correctly setting boolean values.
|
||||||
|
- Fixes potential issue where the underlying websocket connection is closed but the parent request context is not yet canceled causing a write over a closed connection.
|
||||||
|
- Fixes race condition when closing all active websocket connections when a server is deleted.
|
||||||
|
- Fixes logic to determine if a server's context is closed out and send a websocket close message to connected clients. Previously this fired off whenever the request itself was closed, and not when the server context was closed.
|
||||||
|
- Exposes 8080 in the wings Dockerfile to better support reverse proxy tools.
|
||||||
|
- Releases are now built using Go 1.17 — the minimum version required to build Wings remains Go 1.16.
|
||||||
|
- Simplifed the logic powering server updates to only pull information from the Panel rather than trying to accept updated values. All parts of Wings needing the most up-to-date server details should call Server#Sync() to fetch the latest stored build information.
|
||||||
|
- Installer#New() no longer requires passing all of the server data as a byte slice, rather a new Installer#ServerDetails struct is exposed which can be passed and accepts a UUID and if the server should be started after the installer finishes.
|
||||||
|
- Removes complicated (and unused) logic during the server installation process that was a hold-over from legacy Wings architectures.
|
||||||
|
- Removes the PATCH /api/servers/:server endpoint — if you were previously using this API call it should be replaced with POST /api/servers/:server/sync.
|
||||||
|
|
||||||
|
* Wed Aug 25 2021 Capitol Hosting Solutions Systems Engineering <syseng@chs.gg> - 1.4.7-1
|
||||||
|
- specfile by Capitol Hosting Solutions, Upstream by Pterodactyl
|
||||||
|
- Rebased for https://github.com/pterodactyl/wings/releases/tag/v1.4.7
|
||||||
|
- SFTP access is now properly denied if a server is suspended.
|
||||||
|
- Correctly uses start_on_completion and crash_detection_enabled for servers.
|
||||||
@@ -2,12 +2,10 @@ package server
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"time"
|
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/internal/database"
|
"github.com/pterodactyl/wings/internal/database"
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
"github.com/pterodactyl/wings/internal/models"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
const ActivityPowerPrefix = "server:power."
|
const ActivityPowerPrefix = "server:power."
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ func (s *Server) notifyPanelOfBackup(uuid string, ad *backup.ArchiveDetails, suc
|
|||||||
"backup": uuid,
|
"backup": uuid,
|
||||||
"error": err,
|
"error": err,
|
||||||
}).Error("failed to notify panel of backup status due to wings error")
|
}).Error("failed to notify panel of backup status due to wings error")
|
||||||
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -126,7 +127,7 @@ func (s *Server) RestoreBackup(b backup.BackupInterface, reader io.ReadCloser) (
|
|||||||
defer func() {
|
defer func() {
|
||||||
s.Config().SetSuspended(false)
|
s.Config().SetSuspended(false)
|
||||||
if reader != nil {
|
if reader != nil {
|
||||||
_ = reader.Close()
|
reader.Close()
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
// Send an API call to the Panel as soon as this function is done running so that
|
// Send an API call to the Panel as soon as this function is done running so that
|
||||||
@@ -141,7 +142,7 @@ func (s *Server) RestoreBackup(b backup.BackupInterface, reader io.ReadCloser) (
|
|||||||
// instance, otherwise you'll likely hit all types of write errors due to the
|
// instance, otherwise you'll likely hit all types of write errors due to the
|
||||||
// server being suspended.
|
// server being suspended.
|
||||||
if s.Environment.State() != environment.ProcessOfflineState {
|
if s.Environment.State() != environment.ProcessOfflineState {
|
||||||
if err = s.Environment.WaitForStop(s.Context(), 2*time.Minute, false); err != nil {
|
if err = s.Environment.WaitForStop(s.Context(), time.Minute*2, false); err != nil {
|
||||||
if !client.IsErrNotFound(err) {
|
if !client.IsErrNotFound(err) {
|
||||||
return errors.WrapIf(err, "server/backup: restore: failed to wait for container stop")
|
return errors.WrapIf(err, "server/backup: restore: failed to wait for container stop")
|
||||||
}
|
}
|
||||||
@@ -151,19 +152,14 @@ func (s *Server) RestoreBackup(b backup.BackupInterface, reader io.ReadCloser) (
|
|||||||
// Attempt to restore the backup to the server by running through each entry
|
// Attempt to restore the backup to the server by running through each entry
|
||||||
// in the file one at a time and writing them to the disk.
|
// in the file one at a time and writing them to the disk.
|
||||||
s.Log().Debug("starting file writing process for backup restoration")
|
s.Log().Debug("starting file writing process for backup restoration")
|
||||||
err = b.Restore(s.Context(), reader, func(file string, info fs.FileInfo, r io.ReadCloser) error {
|
err = b.Restore(s.Context(), reader, func(file string, r io.Reader, mode fs.FileMode, atime, mtime time.Time) error {
|
||||||
defer r.Close()
|
|
||||||
s.Events().Publish(DaemonMessageEvent, "(restoring): "+file)
|
s.Events().Publish(DaemonMessageEvent, "(restoring): "+file)
|
||||||
|
|
||||||
if err := s.Filesystem().Writefile(file, r); err != nil {
|
if err := s.Filesystem().Writefile(file, r); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := s.Filesystem().Chmod(file, info.Mode()); err != nil {
|
if err := s.Filesystem().Chmod(file, mode); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
atime := info.ModTime()
|
|
||||||
mtime := atime
|
|
||||||
return s.Filesystem().Chtimes(file, atime, mtime)
|
return s.Filesystem().Chtimes(file, atime, mtime)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
@@ -8,21 +8,16 @@ import (
|
|||||||
"io/fs"
|
"io/fs"
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
|
"time"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
"github.com/mholt/archiver/v4"
|
|
||||||
"golang.org/x/sync/errgroup"
|
"golang.org/x/sync/errgroup"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
)
|
)
|
||||||
|
|
||||||
var format = archiver.CompressedArchive{
|
|
||||||
Compression: archiver.Gz{},
|
|
||||||
Archival: archiver.Tar{},
|
|
||||||
}
|
|
||||||
|
|
||||||
type AdapterType string
|
type AdapterType string
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -32,12 +27,12 @@ const (
|
|||||||
|
|
||||||
// RestoreCallback is a generic restoration callback that exists for both local
|
// RestoreCallback is a generic restoration callback that exists for both local
|
||||||
// and remote backups allowing the files to be restored.
|
// and remote backups allowing the files to be restored.
|
||||||
type RestoreCallback func(file string, info fs.FileInfo, r io.ReadCloser) error
|
type RestoreCallback func(file string, r io.Reader, mode fs.FileMode, atime, mtime time.Time) error
|
||||||
|
|
||||||
// noinspection GoNameStartsWithPackageName
|
// noinspection GoNameStartsWithPackageName
|
||||||
type BackupInterface interface {
|
type BackupInterface interface {
|
||||||
// SetClient sets the API request client on the backup interface.
|
// SetClient sets the API request client on the backup interface.
|
||||||
SetClient(remote.Client)
|
SetClient(c remote.Client)
|
||||||
// Identifier returns the UUID of this backup as tracked by the panel
|
// Identifier returns the UUID of this backup as tracked by the panel
|
||||||
// instance.
|
// instance.
|
||||||
Identifier() string
|
Identifier() string
|
||||||
@@ -46,7 +41,7 @@ type BackupInterface interface {
|
|||||||
WithLogContext(map[string]interface{})
|
WithLogContext(map[string]interface{})
|
||||||
// Generate creates a backup in whatever the configured source for the
|
// Generate creates a backup in whatever the configured source for the
|
||||||
// specific implementation is.
|
// specific implementation is.
|
||||||
Generate(context.Context, string, string) (*ArchiveDetails, error)
|
Generate(ctx context.Context, basePath string, ignore string) (*ArchiveDetails, error)
|
||||||
// Ignored returns the ignored files for this backup instance.
|
// Ignored returns the ignored files for this backup instance.
|
||||||
Ignored() string
|
Ignored() string
|
||||||
// Checksum returns a SHA1 checksum for the generated backup.
|
// Checksum returns a SHA1 checksum for the generated backup.
|
||||||
@@ -58,13 +53,13 @@ type BackupInterface interface {
|
|||||||
// to store it until it is moved to the final spot.
|
// to store it until it is moved to the final spot.
|
||||||
Path() string
|
Path() string
|
||||||
// Details returns details about the archive.
|
// Details returns details about the archive.
|
||||||
Details(context.Context, []remote.BackupPart) (*ArchiveDetails, error)
|
Details(ctx context.Context) (*ArchiveDetails, error)
|
||||||
// Remove removes a backup file.
|
// Remove removes a backup file.
|
||||||
Remove() error
|
Remove() error
|
||||||
// Restore is called when a backup is ready to be restored to the disk from
|
// Restore is called when a backup is ready to be restored to the disk from
|
||||||
// the given source. Not every backup implementation will support this nor
|
// the given source. Not every backup implementation will support this nor
|
||||||
// will every implementation require a reader be provided.
|
// will every implementation require a reader be provided.
|
||||||
Restore(context.Context, io.Reader, RestoreCallback) error
|
Restore(ctx context.Context, reader io.Reader, callback RestoreCallback) error
|
||||||
}
|
}
|
||||||
|
|
||||||
type Backup struct {
|
type Backup struct {
|
||||||
@@ -124,8 +119,8 @@ func (b *Backup) Checksum() ([]byte, error) {
|
|||||||
|
|
||||||
// Details returns both the checksum and size of the archive currently stored on
|
// Details returns both the checksum and size of the archive currently stored on
|
||||||
// the disk to the caller.
|
// the disk to the caller.
|
||||||
func (b *Backup) Details(ctx context.Context, parts []remote.BackupPart) (*ArchiveDetails, error) {
|
func (b *Backup) Details(ctx context.Context) (*ArchiveDetails, error) {
|
||||||
ad := ArchiveDetails{ChecksumType: "sha1", Parts: parts}
|
ad := ArchiveDetails{ChecksumType: "sha1"}
|
||||||
g, ctx := errgroup.WithContext(ctx)
|
g, ctx := errgroup.WithContext(ctx)
|
||||||
|
|
||||||
g.Go(func() error {
|
g.Go(func() error {
|
||||||
@@ -167,10 +162,9 @@ func (b *Backup) log() *log.Entry {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type ArchiveDetails struct {
|
type ArchiveDetails struct {
|
||||||
Checksum string `json:"checksum"`
|
Checksum string `json:"checksum"`
|
||||||
ChecksumType string `json:"checksum_type"`
|
ChecksumType string `json:"checksum_type"`
|
||||||
Size int64 `json:"size"`
|
Size int64 `json:"size"`
|
||||||
Parts []remote.BackupPart `json:"parts"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ToRequest returns a request object.
|
// ToRequest returns a request object.
|
||||||
@@ -180,6 +174,5 @@ func (ad *ArchiveDetails) ToRequest(successful bool) remote.BackupRequest {
|
|||||||
ChecksumType: ad.ChecksumType,
|
ChecksumType: ad.ChecksumType,
|
||||||
Size: ad.Size,
|
Size: ad.Size,
|
||||||
Successful: successful,
|
Successful: successful,
|
||||||
Parts: ad.Parts,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,10 +6,8 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/juju/ratelimit"
|
"github.com/mholt/archiver/v3"
|
||||||
"github.com/mholt/archiver/v4"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/server/filesystem"
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
)
|
)
|
||||||
@@ -66,12 +64,12 @@ func (b *LocalBackup) Generate(ctx context.Context, basePath, ignore string) (*A
|
|||||||
}
|
}
|
||||||
|
|
||||||
b.log().WithField("path", b.Path()).Info("creating backup for server")
|
b.log().WithField("path", b.Path()).Info("creating backup for server")
|
||||||
if err := a.Create(ctx, b.Path()); err != nil {
|
if err := a.Create(b.Path()); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
b.log().Info("created backup successfully")
|
b.log().Info("created backup successfully")
|
||||||
|
|
||||||
ad, err := b.Details(ctx, nil)
|
ad, err := b.Details(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, errors.WrapIf(err, "backup: failed to get archive details for local backup")
|
return nil, errors.WrapIf(err, "backup: failed to get archive details for local backup")
|
||||||
}
|
}
|
||||||
@@ -81,28 +79,16 @@ func (b *LocalBackup) Generate(ctx context.Context, basePath, ignore string) (*A
|
|||||||
// Restore will walk over the archive and call the callback function for each
|
// Restore will walk over the archive and call the callback function for each
|
||||||
// file encountered.
|
// file encountered.
|
||||||
func (b *LocalBackup) Restore(ctx context.Context, _ io.Reader, callback RestoreCallback) error {
|
func (b *LocalBackup) Restore(ctx context.Context, _ io.Reader, callback RestoreCallback) error {
|
||||||
f, err := os.Open(b.Path())
|
return archiver.Walk(b.Path(), func(f archiver.File) error {
|
||||||
if err != nil {
|
select {
|
||||||
return err
|
case <-ctx.Done():
|
||||||
}
|
// Stop walking if the context is canceled.
|
||||||
defer f.Close()
|
return archiver.ErrStopWalk
|
||||||
|
default:
|
||||||
var reader io.Reader = f
|
if f.IsDir() {
|
||||||
// Steal the logic we use for making backups which will be applied when restoring
|
return nil
|
||||||
// this specific backup. This allows us to prevent overloading the disk unintentionally.
|
}
|
||||||
if writeLimit := int64(config.Get().System.Backups.WriteLimit * 1024 * 1024); writeLimit > 0 {
|
return callback(filesystem.ExtractNameFromArchive(f), f, f.Mode(), f.ModTime(), f.ModTime())
|
||||||
reader = ratelimit.Reader(f, ratelimit.NewBucketWithRate(float64(writeLimit), writeLimit))
|
|
||||||
}
|
|
||||||
if err := format.Extract(ctx, reader, nil, func(ctx context.Context, f archiver.File) error {
|
|
||||||
r, err := f.Open()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
defer r.Close()
|
})
|
||||||
|
|
||||||
return callback(filesystem.ExtractNameFromArchive(f), f.FileInfo, r)
|
|
||||||
}); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
package backup
|
package backup
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"archive/tar"
|
||||||
|
"compress/gzip"
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
@@ -11,12 +13,13 @@ import (
|
|||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/cenkalti/backoff/v4"
|
"github.com/cenkalti/backoff/v4"
|
||||||
|
|
||||||
|
"github.com/pterodactyl/wings/server/filesystem"
|
||||||
|
|
||||||
"github.com/juju/ratelimit"
|
"github.com/juju/ratelimit"
|
||||||
"github.com/mholt/archiver/v4"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
"github.com/pterodactyl/wings/server/filesystem"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type S3Backup struct {
|
type S3Backup struct {
|
||||||
@@ -57,7 +60,7 @@ func (s *S3Backup) Generate(ctx context.Context, basePath, ignore string) (*Arch
|
|||||||
}
|
}
|
||||||
|
|
||||||
s.log().WithField("path", s.Path()).Info("creating backup for server")
|
s.log().WithField("path", s.Path()).Info("creating backup for server")
|
||||||
if err := a.Create(ctx, s.Path()); err != nil {
|
if err := a.Create(s.Path()); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
s.log().Info("created backup successfully")
|
s.log().Info("created backup successfully")
|
||||||
@@ -68,11 +71,10 @@ func (s *S3Backup) Generate(ctx context.Context, basePath, ignore string) (*Arch
|
|||||||
}
|
}
|
||||||
defer rc.Close()
|
defer rc.Close()
|
||||||
|
|
||||||
parts, err := s.generateRemoteRequest(ctx, rc)
|
if err := s.generateRemoteRequest(ctx, rc); err != nil {
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
ad, err := s.Details(ctx, parts)
|
ad, err := s.Details(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, errors.WrapIf(err, "backup: failed to get archive details after upload")
|
return nil, errors.WrapIf(err, "backup: failed to get archive details after upload")
|
||||||
}
|
}
|
||||||
@@ -93,35 +95,50 @@ func (s *S3Backup) Restore(ctx context.Context, r io.Reader, callback RestoreCal
|
|||||||
if writeLimit := int64(config.Get().System.Backups.WriteLimit * 1024 * 1024); writeLimit > 0 {
|
if writeLimit := int64(config.Get().System.Backups.WriteLimit * 1024 * 1024); writeLimit > 0 {
|
||||||
reader = ratelimit.Reader(r, ratelimit.NewBucketWithRate(float64(writeLimit), writeLimit))
|
reader = ratelimit.Reader(r, ratelimit.NewBucketWithRate(float64(writeLimit), writeLimit))
|
||||||
}
|
}
|
||||||
if err := format.Extract(ctx, reader, nil, func(ctx context.Context, f archiver.File) error {
|
gr, err := gzip.NewReader(reader)
|
||||||
r, err := f.Open()
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer gr.Close()
|
||||||
|
tr := tar.NewReader(gr)
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return nil
|
||||||
|
default:
|
||||||
|
// Do nothing, fall through to the next block of code in this loop.
|
||||||
|
}
|
||||||
|
header, err := tr.Next()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
if err == io.EOF {
|
||||||
|
break
|
||||||
|
}
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
defer r.Close()
|
if header.Typeflag == tar.TypeReg {
|
||||||
|
if err := callback(header.Name, tr, header.FileInfo().Mode(), header.AccessTime, header.ModTime); err != nil {
|
||||||
return callback(filesystem.ExtractNameFromArchive(f), f.FileInfo, r)
|
return err
|
||||||
}); err != nil {
|
}
|
||||||
return err
|
}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Generates the remote S3 request and begins the upload.
|
// Generates the remote S3 request and begins the upload.
|
||||||
func (s *S3Backup) generateRemoteRequest(ctx context.Context, rc io.ReadCloser) ([]remote.BackupPart, error) {
|
func (s *S3Backup) generateRemoteRequest(ctx context.Context, rc io.ReadCloser) error {
|
||||||
defer rc.Close()
|
defer rc.Close()
|
||||||
|
|
||||||
s.log().Debug("attempting to get size of backup...")
|
s.log().Debug("attempting to get size of backup...")
|
||||||
size, err := s.Backup.Size()
|
size, err := s.Backup.Size()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return err
|
||||||
}
|
}
|
||||||
s.log().WithField("size", size).Debug("got size of backup")
|
s.log().WithField("size", size).Debug("got size of backup")
|
||||||
|
|
||||||
s.log().Debug("attempting to get S3 upload urls from Panel...")
|
s.log().Debug("attempting to get S3 upload urls from Panel...")
|
||||||
urls, err := s.client.GetBackupRemoteUploadURLs(context.Background(), s.Backup.Uuid, size)
|
urls, err := s.client.GetBackupRemoteUploadURLs(context.Background(), s.Backup.Uuid, size)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return err
|
||||||
}
|
}
|
||||||
s.log().Debug("got S3 upload urls from the Panel")
|
s.log().Debug("got S3 upload urls from the Panel")
|
||||||
s.log().WithField("parts", len(urls.Parts)).Info("attempting to upload backup to s3 endpoint...")
|
s.log().WithField("parts", len(urls.Parts)).Info("attempting to upload backup to s3 endpoint...")
|
||||||
@@ -139,26 +156,22 @@ func (s *S3Backup) generateRemoteRequest(ctx context.Context, rc io.ReadCloser)
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Attempt to upload the part.
|
// Attempt to upload the part.
|
||||||
etag, err := uploader.uploadPart(ctx, part, partSize)
|
if _, err := uploader.uploadPart(ctx, part, partSize); err != nil {
|
||||||
if err != nil {
|
|
||||||
s.log().WithField("part_id", i+1).WithError(err).Warn("failed to upload part")
|
s.log().WithField("part_id", i+1).WithError(err).Warn("failed to upload part")
|
||||||
return nil, err
|
return err
|
||||||
}
|
}
|
||||||
uploader.uploadedParts = append(uploader.uploadedParts, remote.BackupPart{
|
|
||||||
ETag: etag,
|
|
||||||
PartNumber: i + 1,
|
|
||||||
})
|
|
||||||
s.log().WithField("part_id", i+1).Info("successfully uploaded backup part")
|
s.log().WithField("part_id", i+1).Info("successfully uploaded backup part")
|
||||||
}
|
}
|
||||||
|
|
||||||
s.log().WithField("parts", len(urls.Parts)).Info("backup has been successfully uploaded")
|
s.log().WithField("parts", len(urls.Parts)).Info("backup has been successfully uploaded")
|
||||||
|
|
||||||
return uploader.uploadedParts, nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
type s3FileUploader struct {
|
type s3FileUploader struct {
|
||||||
io.ReadCloser
|
io.ReadCloser
|
||||||
client *http.Client
|
client *http.Client
|
||||||
uploadedParts []remote.BackupPart
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// newS3FileUploader returns a new file uploader instance.
|
// newS3FileUploader returns a new file uploader instance.
|
||||||
|
|||||||
@@ -46,9 +46,6 @@ type Configuration struct {
|
|||||||
// server process.
|
// server process.
|
||||||
EnvVars environment.Variables `json:"environment"`
|
EnvVars environment.Variables `json:"environment"`
|
||||||
|
|
||||||
// Labels is a map of container labels that should be applied to the running server process.
|
|
||||||
Labels map[string]string `json:"labels"`
|
|
||||||
|
|
||||||
Allocations environment.Allocations `json:"allocations"`
|
Allocations environment.Allocations `json:"allocations"`
|
||||||
Build environment.Limits `json:"build"`
|
Build environment.Limits `json:"build"`
|
||||||
CrashDetectionEnabled bool `json:"crash_detection_enabled"`
|
CrashDetectionEnabled bool `json:"crash_detection_enabled"`
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/mitchellh/colorstring"
|
"github.com/mitchellh/colorstring"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -6,8 +6,6 @@ import (
|
|||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
)
|
)
|
||||||
@@ -59,7 +57,7 @@ func (s *Server) handleServerCrash() error {
|
|||||||
|
|
||||||
exitCode, oomKilled, err := s.Environment.ExitState()
|
exitCode, oomKilled, err := s.Environment.ExitState()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.Wrap(err, "failed to get exit state for server process")
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the system is not configured to detect a clean exit code as a crash, and the
|
// If the system is not configured to detect a clean exit code as a crash, and the
|
||||||
@@ -87,5 +85,5 @@ func (s *Server) handleServerCrash() error {
|
|||||||
|
|
||||||
s.crasher.SetLastCrash(time.Now())
|
s.crasher.SetLastCrash(time.Now())
|
||||||
|
|
||||||
return errors.Wrap(s.HandlePowerAction(PowerActionStart), "failed to start server after crash detection")
|
return s.HandlePowerAction(PowerActionStart)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,8 @@ import (
|
|||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Defines all the possible output events for a server.
|
// Defines all of the possible output events for a server.
|
||||||
|
// noinspection GoNameStartsWithPackageName
|
||||||
const (
|
const (
|
||||||
DaemonMessageEvent = "daemon message"
|
DaemonMessageEvent = "daemon message"
|
||||||
InstallOutputEvent = "install output"
|
InstallOutputEvent = "install output"
|
||||||
@@ -18,7 +19,6 @@ const (
|
|||||||
BackupCompletedEvent = "backup completed"
|
BackupCompletedEvent = "backup completed"
|
||||||
TransferLogsEvent = "transfer logs"
|
TransferLogsEvent = "transfer logs"
|
||||||
TransferStatusEvent = "transfer status"
|
TransferStatusEvent = "transfer status"
|
||||||
DeletedEvent = "deleted"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Events returns the server's emitter instance.
|
// Events returns the server's emitter instance.
|
||||||
|
|||||||
@@ -2,8 +2,6 @@ package filesystem
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"archive/tar"
|
"archive/tar"
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
"io"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"os"
|
"os"
|
||||||
@@ -19,7 +17,6 @@ import (
|
|||||||
ignore "github.com/sabhiram/go-gitignore"
|
ignore "github.com/sabhiram/go-gitignore"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/internal/progress"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const memory = 4 * 1024
|
const memory = 4 * 1024
|
||||||
@@ -31,31 +28,6 @@ var pool = sync.Pool{
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
// TarProgress .
|
|
||||||
type TarProgress struct {
|
|
||||||
*tar.Writer
|
|
||||||
p *progress.Progress
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewTarProgress .
|
|
||||||
func NewTarProgress(w *tar.Writer, p *progress.Progress) *TarProgress {
|
|
||||||
if p != nil {
|
|
||||||
p.Writer = w
|
|
||||||
}
|
|
||||||
return &TarProgress{
|
|
||||||
Writer: w,
|
|
||||||
p: p,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Write .
|
|
||||||
func (p *TarProgress) Write(v []byte) (int, error) {
|
|
||||||
if p.p == nil {
|
|
||||||
return p.Writer.Write(v)
|
|
||||||
}
|
|
||||||
return p.p.Write(v)
|
|
||||||
}
|
|
||||||
|
|
||||||
type Archive struct {
|
type Archive struct {
|
||||||
// BasePath is the absolute path to create the archive from where Files and Ignore are
|
// BasePath is the absolute path to create the archive from where Files and Ignore are
|
||||||
// relative to.
|
// relative to.
|
||||||
@@ -67,17 +39,12 @@ type Archive struct {
|
|||||||
|
|
||||||
// Files specifies the files to archive, this takes priority over the Ignore option, if
|
// Files specifies the files to archive, this takes priority over the Ignore option, if
|
||||||
// unspecified, all files in the BasePath will be archived unless Ignore is set.
|
// unspecified, all files in the BasePath will be archived unless Ignore is set.
|
||||||
//
|
|
||||||
// All items in Files must be absolute within BasePath.
|
|
||||||
Files []string
|
Files []string
|
||||||
|
|
||||||
// Progress wraps the writer of the archive to pass through the progress tracker.
|
|
||||||
Progress *progress.Progress
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create creates an archive at dst with all the files defined in the
|
// Create creates an archive at dst with all of the files defined in the
|
||||||
// included Files array.
|
// included files struct.
|
||||||
func (a *Archive) Create(ctx context.Context, dst string) error {
|
func (a *Archive) Create(dst string) error {
|
||||||
f, err := os.OpenFile(dst, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o600)
|
f, err := os.OpenFile(dst, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o600)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -95,34 +62,21 @@ func (a *Archive) Create(ctx context.Context, dst string) error {
|
|||||||
writer = f
|
writer = f
|
||||||
}
|
}
|
||||||
|
|
||||||
return a.Stream(ctx, writer)
|
// The default compression level is BestSpeed
|
||||||
}
|
var cl = pgzip.BestSpeed
|
||||||
|
|
||||||
// Stream .
|
|
||||||
func (a *Archive) Stream(ctx context.Context, w io.Writer) error {
|
|
||||||
for _, f := range a.Files {
|
|
||||||
if strings.HasPrefix(f, a.BasePath) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Errorf("archive: all entries in Files must be absolute and within BasePath: %s\n", f)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Choose which compression level to use based on the compression_level configuration option
|
// Choose which compression level to use based on the compression_level configuration option
|
||||||
var compressionLevel int
|
|
||||||
switch config.Get().System.Backups.CompressionLevel {
|
switch config.Get().System.Backups.CompressionLevel {
|
||||||
case "none":
|
case "none":
|
||||||
compressionLevel = pgzip.NoCompression
|
cl = pgzip.NoCompression
|
||||||
case "best_compression":
|
|
||||||
compressionLevel = pgzip.BestCompression
|
|
||||||
case "best_speed":
|
case "best_speed":
|
||||||
fallthrough
|
cl = pgzip.BestSpeed
|
||||||
default:
|
case "best_compression":
|
||||||
compressionLevel = pgzip.BestSpeed
|
cl = pgzip.BestCompression
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create a new gzip writer around the file.
|
// Create a new gzip writer around the file.
|
||||||
gw, _ := pgzip.NewWriterLevel(w, compressionLevel)
|
gw, _ := pgzip.NewWriterLevel(writer, cl)
|
||||||
_ = gw.SetConcurrency(1<<20, 1)
|
_ = gw.SetConcurrency(1<<20, 1)
|
||||||
defer gw.Close()
|
defer gw.Close()
|
||||||
|
|
||||||
@@ -130,22 +84,20 @@ func (a *Archive) Stream(ctx context.Context, w io.Writer) error {
|
|||||||
tw := tar.NewWriter(gw)
|
tw := tar.NewWriter(gw)
|
||||||
defer tw.Close()
|
defer tw.Close()
|
||||||
|
|
||||||
pw := NewTarProgress(tw, a.Progress)
|
|
||||||
|
|
||||||
// Configure godirwalk.
|
// Configure godirwalk.
|
||||||
options := &godirwalk.Options{
|
options := &godirwalk.Options{
|
||||||
FollowSymbolicLinks: false,
|
FollowSymbolicLinks: false,
|
||||||
Unsorted: true,
|
Unsorted: true,
|
||||||
|
Callback: a.callback(tw),
|
||||||
}
|
}
|
||||||
|
|
||||||
// If we're specifically looking for only certain files, or have requested
|
// If we're specifically looking for only certain files, or have requested
|
||||||
// that certain files be ignored we'll update the callback function to reflect
|
// that certain files be ignored we'll update the callback function to reflect
|
||||||
// that request.
|
// that request.
|
||||||
var callback godirwalk.WalkFunc
|
|
||||||
if len(a.Files) == 0 && len(a.Ignore) > 0 {
|
if len(a.Files) == 0 && len(a.Ignore) > 0 {
|
||||||
i := ignore.CompileIgnoreLines(strings.Split(a.Ignore, "\n")...)
|
i := ignore.CompileIgnoreLines(strings.Split(a.Ignore, "\n")...)
|
||||||
|
|
||||||
callback = a.callback(pw, func(_ string, rp string) error {
|
options.Callback = a.callback(tw, func(_ string, rp string) error {
|
||||||
if i.MatchesPath(rp) {
|
if i.MatchesPath(rp) {
|
||||||
return godirwalk.SkipThis
|
return godirwalk.SkipThis
|
||||||
}
|
}
|
||||||
@@ -153,19 +105,7 @@ func (a *Archive) Stream(ctx context.Context, w io.Writer) error {
|
|||||||
return nil
|
return nil
|
||||||
})
|
})
|
||||||
} else if len(a.Files) > 0 {
|
} else if len(a.Files) > 0 {
|
||||||
callback = a.withFilesCallback(pw)
|
options.Callback = a.withFilesCallback(tw)
|
||||||
} else {
|
|
||||||
callback = a.callback(pw)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set the callback function, wrapped with support for context cancellation.
|
|
||||||
options.Callback = func(path string, de *godirwalk.Dirent) error {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return ctx.Err()
|
|
||||||
default:
|
|
||||||
return callback(path, de)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Recursively walk the path we are archiving.
|
// Recursively walk the path we are archiving.
|
||||||
@@ -174,9 +114,9 @@ func (a *Archive) Stream(ctx context.Context, w io.Writer) error {
|
|||||||
|
|
||||||
// Callback function used to determine if a given file should be included in the archive
|
// Callback function used to determine if a given file should be included in the archive
|
||||||
// being generated.
|
// being generated.
|
||||||
func (a *Archive) callback(tw *TarProgress, opts ...func(path string, relative string) error) func(path string, de *godirwalk.Dirent) error {
|
func (a *Archive) callback(tw *tar.Writer, opts ...func(path string, relative string) error) func(path string, de *godirwalk.Dirent) error {
|
||||||
return func(path string, de *godirwalk.Dirent) error {
|
return func(path string, de *godirwalk.Dirent) error {
|
||||||
// Skip directories because we are walking them recursively.
|
// Skip directories because we walking them recursively.
|
||||||
if de.IsDir() {
|
if de.IsDir() {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -198,14 +138,12 @@ func (a *Archive) callback(tw *TarProgress, opts ...func(path string, relative s
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Pushes only files defined in the Files key to the final archive.
|
// Pushes only files defined in the Files key to the final archive.
|
||||||
func (a *Archive) withFilesCallback(tw *TarProgress) func(path string, de *godirwalk.Dirent) error {
|
func (a *Archive) withFilesCallback(tw *tar.Writer) func(path string, de *godirwalk.Dirent) error {
|
||||||
return a.callback(tw, func(p string, rp string) error {
|
return a.callback(tw, func(p string, rp string) error {
|
||||||
for _, f := range a.Files {
|
for _, f := range a.Files {
|
||||||
// Allow exact file matches, otherwise check if file is within a parent directory.
|
// If the given doesn't match, or doesn't have the same prefix continue
|
||||||
//
|
// to the next item in the loop.
|
||||||
// The slashes are added in the prefix checks to prevent partial name matches from being
|
if p != f && !strings.HasPrefix(strings.TrimSuffix(p, "/")+"/", f) {
|
||||||
// included in the archive.
|
|
||||||
if f != p && !strings.HasPrefix(strings.TrimSuffix(p, "/")+"/", strings.TrimSuffix(f, "/")+"/") {
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -221,7 +159,7 @@ func (a *Archive) withFilesCallback(tw *TarProgress) func(path string, de *godir
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Adds a given file path to the final archive being created.
|
// Adds a given file path to the final archive being created.
|
||||||
func (a *Archive) addToArchive(p string, rp string, w *TarProgress) error {
|
func (a *Archive) addToArchive(p string, rp string, w *tar.Writer) error {
|
||||||
// Lstat the file, this will give us the same information as Stat except that it will not
|
// Lstat the file, this will give us the same information as Stat except that it will not
|
||||||
// follow a symlink to its target automatically. This is important to avoid including
|
// follow a symlink to its target automatically. This is important to avoid including
|
||||||
// files that exist outside the server root unintentionally in the backup.
|
// files that exist outside the server root unintentionally in the backup.
|
||||||
@@ -248,7 +186,7 @@ func (a *Archive) addToArchive(p string, rp string, w *TarProgress) error {
|
|||||||
// it doesn't work.
|
// it doesn't work.
|
||||||
target, err = os.Readlink(s.Name())
|
target, err = os.Readlink(s.Name())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// Ignore the not exist errors specifically, since there is nothing important about that.
|
// Ignore the not exist errors specifically, since theres nothing important about that.
|
||||||
if !os.IsNotExist(err) {
|
if !os.IsNotExist(err) {
|
||||||
log.WithField("path", rp).WithField("readlink_err", err.Error()).Warn("failed reading symlink for target path; skipping...")
|
log.WithField("path", rp).WithField("readlink_err", err.Error()).Warn("failed reading symlink for target path; skipping...")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,133 +0,0 @@
|
|||||||
package filesystem
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
iofs "io/fs"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"sort"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
. "github.com/franela/goblin"
|
|
||||||
"github.com/mholt/archiver/v4"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestArchive_Stream(t *testing.T) {
|
|
||||||
g := Goblin(t)
|
|
||||||
fs, rfs := NewFs()
|
|
||||||
|
|
||||||
g.Describe("Archive", func() {
|
|
||||||
g.AfterEach(func() {
|
|
||||||
// Reset the filesystem after each run.
|
|
||||||
rfs.reset()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("throws an error when passed invalid file paths", func() {
|
|
||||||
a := &Archive{
|
|
||||||
BasePath: fs.Path(),
|
|
||||||
Files: []string{
|
|
||||||
// To use the archiver properly, this needs to be filepath.Join(BasePath, "yeet")
|
|
||||||
// However, this test tests that we actually validate that behavior.
|
|
||||||
"yeet",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
g.Assert(a.Create(context.Background(), "")).IsNotNil()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("creates archive with intended files", func() {
|
|
||||||
g.Assert(fs.CreateDirectory("test", "/")).IsNil()
|
|
||||||
g.Assert(fs.CreateDirectory("test2", "/")).IsNil()
|
|
||||||
|
|
||||||
err := fs.Writefile("test/file.txt", strings.NewReader("hello, world!\n"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
err = fs.Writefile("test2/file.txt", strings.NewReader("hello, world!\n"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
err = fs.Writefile("test_file.txt", strings.NewReader("hello, world!\n"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
err = fs.Writefile("test_file.txt.old", strings.NewReader("hello, world!\n"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
a := &Archive{
|
|
||||||
BasePath: fs.Path(),
|
|
||||||
Files: []string{
|
|
||||||
filepath.Join(fs.Path(), "test"),
|
|
||||||
filepath.Join(fs.Path(), "test_file.txt"),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create the archive.
|
|
||||||
archivePath := filepath.Join(rfs.root, "archive.tar.gz")
|
|
||||||
g.Assert(a.Create(context.Background(), archivePath)).IsNil()
|
|
||||||
|
|
||||||
// Ensure the archive exists.
|
|
||||||
_, err = os.Stat(archivePath)
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Open the archive.
|
|
||||||
genericFs, err := archiver.FileSystem(context.Background(), archivePath)
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Assert that we are opening an archive.
|
|
||||||
afs, ok := genericFs.(archiver.ArchiveFS)
|
|
||||||
g.Assert(ok).IsTrue()
|
|
||||||
|
|
||||||
// Get the names of the files recursively from the archive.
|
|
||||||
files, err := getFiles(afs, ".")
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Ensure the files in the archive match what we are expecting.
|
|
||||||
expected := []string{
|
|
||||||
"test_file.txt",
|
|
||||||
"test/file.txt",
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sort the slices to ensure the comparison never fails if the
|
|
||||||
// contents are sorted differently.
|
|
||||||
sort.Strings(expected)
|
|
||||||
sort.Strings(files)
|
|
||||||
|
|
||||||
g.Assert(files).Equal(expected)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func getFiles(f iofs.ReadDirFS, name string) ([]string, error) {
|
|
||||||
var v []string
|
|
||||||
|
|
||||||
entries, err := f.ReadDir(name)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, e := range entries {
|
|
||||||
entryName := e.Name()
|
|
||||||
if name != "." {
|
|
||||||
entryName = filepath.Join(name, entryName)
|
|
||||||
}
|
|
||||||
|
|
||||||
if e.IsDir() {
|
|
||||||
files, err := getFiles(f, entryName)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if files == nil {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, f := range files {
|
|
||||||
v = append(v, f)
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
v = append(v, entryName)
|
|
||||||
}
|
|
||||||
|
|
||||||
return v, nil
|
|
||||||
}
|
|
||||||
@@ -4,10 +4,9 @@ import (
|
|||||||
"archive/tar"
|
"archive/tar"
|
||||||
"archive/zip"
|
"archive/zip"
|
||||||
"compress/gzip"
|
"compress/gzip"
|
||||||
"context"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
gzip2 "github.com/klauspost/compress/gzip"
|
||||||
iofs "io/fs"
|
zip2 "github.com/klauspost/compress/zip"
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -17,12 +16,10 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
gzip2 "github.com/klauspost/compress/gzip"
|
"github.com/mholt/archiver/v3"
|
||||||
zip2 "github.com/klauspost/compress/zip"
|
|
||||||
"github.com/mholt/archiver/v4"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// CompressFiles compresses all the files matching the given paths in the
|
// CompressFiles compresses all of the files matching the given paths in the
|
||||||
// specified directory. This function also supports passing nested paths to only
|
// specified directory. This function also supports passing nested paths to only
|
||||||
// compress certain files and folders when working in a larger directory. This
|
// compress certain files and folders when working in a larger directory. This
|
||||||
// effectively creates a local backup, but rather than ignoring specific files
|
// effectively creates a local backup, but rather than ignoring specific files
|
||||||
@@ -37,7 +34,7 @@ func (fs *Filesystem) CompressFiles(dir string, paths []string) (os.FileInfo, er
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// Take all the paths passed in and merge them together with the root directory we've gotten.
|
// Take all of the paths passed in and merge them together with the root directory we've gotten.
|
||||||
for i, p := range paths {
|
for i, p := range paths {
|
||||||
paths[i] = filepath.Join(cleanedRootDir, p)
|
paths[i] = filepath.Join(cleanedRootDir, p)
|
||||||
}
|
}
|
||||||
@@ -53,7 +50,7 @@ func (fs *Filesystem) CompressFiles(dir string, paths []string) (os.FileInfo, er
|
|||||||
fmt.Sprintf("archive-%s.tar.gz", strings.ReplaceAll(time.Now().Format(time.RFC3339), ":", "")),
|
fmt.Sprintf("archive-%s.tar.gz", strings.ReplaceAll(time.Now().Format(time.RFC3339), ":", "")),
|
||||||
)
|
)
|
||||||
|
|
||||||
if err := a.Create(context.Background(), d); err != nil {
|
if err := a.Create(d); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -75,7 +72,7 @@ func (fs *Filesystem) CompressFiles(dir string, paths []string) (os.FileInfo, er
|
|||||||
|
|
||||||
// SpaceAvailableForDecompression looks through a given archive and determines
|
// SpaceAvailableForDecompression looks through a given archive and determines
|
||||||
// if decompressing it would put the server over its allocated disk space limit.
|
// if decompressing it would put the server over its allocated disk space limit.
|
||||||
func (fs *Filesystem) SpaceAvailableForDecompression(ctx context.Context, dir string, file string) error {
|
func (fs *Filesystem) SpaceAvailableForDecompression(dir string, file string) error {
|
||||||
// Don't waste time trying to determine this if we know the server will have the space for
|
// Don't waste time trying to determine this if we know the server will have the space for
|
||||||
// it since there is no limit.
|
// it since there is no limit.
|
||||||
if fs.MaxDisk() <= 0 {
|
if fs.MaxDisk() <= 0 {
|
||||||
@@ -91,139 +88,68 @@ func (fs *Filesystem) SpaceAvailableForDecompression(ctx context.Context, dir st
|
|||||||
// waiting an unnecessary amount of time on this call.
|
// waiting an unnecessary amount of time on this call.
|
||||||
dirSize, err := fs.DiskUsage(false)
|
dirSize, err := fs.DiskUsage(false)
|
||||||
|
|
||||||
fsys, err := archiver.FileSystem(ctx, source)
|
var size int64
|
||||||
|
// Walk over the archive and figure out just how large the final output would be from unarchiving it.
|
||||||
|
err = archiver.Walk(source, func(f archiver.File) error {
|
||||||
|
if atomic.AddInt64(&size, f.Size())+dirSize > fs.MaxDisk() {
|
||||||
|
return newFilesystemError(ErrCodeDiskSpace, nil)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errors.Is(err, archiver.ErrNoMatch) {
|
if IsUnknownArchiveFormatError(err) {
|
||||||
return newFilesystemError(ErrCodeUnknownArchive, err)
|
return newFilesystemError(ErrCodeUnknownArchive, err)
|
||||||
}
|
}
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
return err
|
||||||
var size int64
|
|
||||||
return iofs.WalkDir(fsys, ".", func(path string, d iofs.DirEntry, err error) error {
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
// Stop walking if the context is canceled.
|
|
||||||
return ctx.Err()
|
|
||||||
default:
|
|
||||||
info, err := d.Info()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if atomic.AddInt64(&size, info.Size())+dirSize > fs.MaxDisk() {
|
|
||||||
return newFilesystemError(ErrCodeDiskSpace, nil)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// DecompressFile will decompress a file in a given directory by using the
|
// DecompressFile will decompress a file in a given directory by using the
|
||||||
// archiver tool to infer the file type and go from there. This will walk over
|
// archiver tool to infer the file type and go from there. This will walk over
|
||||||
// all the files within the given archive and ensure that there is not a
|
// all of the files within the given archive and ensure that there is not a
|
||||||
// zip-slip attack being attempted by validating that the final path is within
|
// zip-slip attack being attempted by validating that the final path is within
|
||||||
// the server data directory.
|
// the server data directory.
|
||||||
func (fs *Filesystem) DecompressFile(ctx context.Context, dir string, file string) error {
|
func (fs *Filesystem) DecompressFile(dir string, file string) error {
|
||||||
source, err := fs.SafePath(filepath.Join(dir, file))
|
source, err := fs.SafePath(filepath.Join(dir, file))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return fs.DecompressFileUnsafe(ctx, dir, source)
|
// Ensure that the source archive actually exists on the system.
|
||||||
}
|
if _, err := os.Stat(source); err != nil {
|
||||||
|
|
||||||
// DecompressFileUnsafe will decompress any file on the local disk without checking
|
|
||||||
// if it is owned by the server. The file will be SAFELY decompressed and extracted
|
|
||||||
// into the server's directory.
|
|
||||||
func (fs *Filesystem) DecompressFileUnsafe(ctx context.Context, dir string, file string) error {
|
|
||||||
// Ensure that the archive actually exists on the system.
|
|
||||||
if _, err := os.Stat(file); err != nil {
|
|
||||||
return errors.WithStack(err)
|
return errors.WithStack(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
f, err := os.Open(file)
|
// Walk all of the files in the archiver file and write them to the disk. If any
|
||||||
if err != nil {
|
// directory is encountered it will be skipped since we handle creating any missing
|
||||||
return err
|
// directories automatically when writing files.
|
||||||
}
|
err = archiver.Walk(source, func(f archiver.File) error {
|
||||||
defer f.Close()
|
if f.IsDir() {
|
||||||
|
|
||||||
// Identify the type of archive we are dealing with.
|
|
||||||
format, input, err := archiver.Identify(filepath.Base(file), f)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, archiver.ErrNoMatch) {
|
|
||||||
return newFilesystemError(ErrCodeUnknownArchive, err)
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return fs.extractStream(ctx, extractStreamOptions{
|
|
||||||
Directory: dir,
|
|
||||||
Format: format,
|
|
||||||
Reader: input,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// ExtractStreamUnsafe .
|
|
||||||
func (fs *Filesystem) ExtractStreamUnsafe(ctx context.Context, dir string, r io.Reader) error {
|
|
||||||
format, input, err := archiver.Identify("archive.tar.gz", r)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, archiver.ErrNoMatch) {
|
|
||||||
return newFilesystemError(ErrCodeUnknownArchive, err)
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return fs.extractStream(ctx, extractStreamOptions{
|
|
||||||
Directory: dir,
|
|
||||||
Format: format,
|
|
||||||
Reader: input,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
type extractStreamOptions struct {
|
|
||||||
// The directory to extract the archive to.
|
|
||||||
Directory string
|
|
||||||
// File name of the archive.
|
|
||||||
FileName string
|
|
||||||
// Format of the archive.
|
|
||||||
Format archiver.Format
|
|
||||||
// Reader for the archive.
|
|
||||||
Reader io.Reader
|
|
||||||
}
|
|
||||||
|
|
||||||
func (fs *Filesystem) extractStream(ctx context.Context, opts extractStreamOptions) error {
|
|
||||||
// Decompress and extract archive
|
|
||||||
if ex, ok := opts.Format.(archiver.Extractor); ok {
|
|
||||||
return ex.Extract(ctx, opts.Reader, nil, func(ctx context.Context, f archiver.File) error {
|
|
||||||
if f.IsDir() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
p := filepath.Join(opts.Directory, ExtractNameFromArchive(f))
|
|
||||||
// If it is ignored, just don't do anything with the file and skip over it.
|
|
||||||
if err := fs.IsIgnored(p); err != nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
r, err := f.Open()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer r.Close()
|
|
||||||
if err := fs.Writefile(p, r); err != nil {
|
|
||||||
return wrapError(err, opts.FileName)
|
|
||||||
}
|
|
||||||
// Update the file permissions to the one set in the archive.
|
|
||||||
if err := fs.Chmod(p, f.Mode()); err != nil {
|
|
||||||
return wrapError(err, opts.FileName)
|
|
||||||
}
|
|
||||||
// Update the file modification time to the one set in the archive.
|
|
||||||
if err := fs.Chtimes(p, f.ModTime(), f.ModTime()); err != nil {
|
|
||||||
return wrapError(err, opts.FileName)
|
|
||||||
}
|
|
||||||
return nil
|
return nil
|
||||||
})
|
}
|
||||||
|
p := filepath.Join(dir, ExtractNameFromArchive(f))
|
||||||
|
// If it is ignored, just don't do anything with the file and skip over it.
|
||||||
|
if err := fs.IsIgnored(p); err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := fs.Writefile(p, f); err != nil {
|
||||||
|
return wrapError(err, source)
|
||||||
|
}
|
||||||
|
// Update the file permissions to the one set in the archive.
|
||||||
|
if err := fs.Chmod(p, f.Mode()); err != nil {
|
||||||
|
return wrapError(err, source)
|
||||||
|
}
|
||||||
|
// Update the file modification time to the one set in the archive.
|
||||||
|
if err := fs.Chtimes(p, f.ModTime(), f.ModTime()); err != nil {
|
||||||
|
return wrapError(err, source)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
if IsUnknownArchiveFormatError(err) {
|
||||||
|
return newFilesystemError(ErrCodeUnknownArchive, err)
|
||||||
|
}
|
||||||
|
return err
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
package filesystem
|
package filesystem
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
|
||||||
"os"
|
"os"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"testing"
|
"testing"
|
||||||
@@ -29,7 +28,7 @@ func TestFilesystem_DecompressFile(t *testing.T) {
|
|||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
// decompress
|
// decompress
|
||||||
err = fs.DecompressFile(context.Background(), "/", "test."+ext)
|
err = fs.DecompressFile("/", "test."+ext)
|
||||||
g.Assert(err).IsNil()
|
g.Assert(err).IsNil()
|
||||||
|
|
||||||
// make sure everything is where it is supposed to be
|
// make sure everything is where it is supposed to be
|
||||||
|
|||||||
@@ -183,7 +183,7 @@ func (fs *Filesystem) DirectorySize(dir string) (int64, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if !e.IsDir() {
|
if !e.IsDir() {
|
||||||
_ = syscall.Lstat(p, &st)
|
syscall.Lstat(p, &st)
|
||||||
atomic.AddInt64(&size, st.Size)
|
atomic.AddInt64(&size, st.Size)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
@@ -18,7 +19,6 @@ const (
|
|||||||
ErrCodePathResolution ErrorCode = "E_BADPATH"
|
ErrCodePathResolution ErrorCode = "E_BADPATH"
|
||||||
ErrCodeDenylistFile ErrorCode = "E_DENYLIST"
|
ErrCodeDenylistFile ErrorCode = "E_DENYLIST"
|
||||||
ErrCodeUnknownError ErrorCode = "E_UNKNOWN"
|
ErrCodeUnknownError ErrorCode = "E_UNKNOWN"
|
||||||
ErrNotExist ErrorCode = "E_NOTEXIST"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type Error struct {
|
type Error struct {
|
||||||
@@ -69,8 +69,6 @@ func (e *Error) Error() string {
|
|||||||
r = "<empty>"
|
r = "<empty>"
|
||||||
}
|
}
|
||||||
return fmt.Sprintf("filesystem: server path [%s] resolves to a location outside the server root: %s", e.path, r)
|
return fmt.Sprintf("filesystem: server path [%s] resolves to a location outside the server root: %s", e.path, r)
|
||||||
case ErrNotExist:
|
|
||||||
return "filesystem: does not exist"
|
|
||||||
case ErrCodeUnknownError:
|
case ErrCodeUnknownError:
|
||||||
fallthrough
|
fallthrough
|
||||||
default:
|
default:
|
||||||
@@ -124,6 +122,15 @@ func IsErrorCode(err error, code ErrorCode) bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// IsUnknownArchiveFormatError checks if the error is due to the archive being
|
||||||
|
// in an unexpected file format.
|
||||||
|
func IsUnknownArchiveFormatError(err error) bool {
|
||||||
|
if err != nil && strings.HasPrefix(err.Error(), "format ") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
// NewBadPathResolution returns a new BadPathResolution error.
|
// NewBadPathResolution returns a new BadPathResolution error.
|
||||||
func NewBadPathResolution(path string, resolved string) error {
|
func NewBadPathResolution(path string, resolved string) error {
|
||||||
return errors.WithStackDepth(&Error{code: ErrCodePathResolution, path: path, resolved: resolved}, 1)
|
return errors.WithStackDepth(&Error{code: ErrCodePathResolution, path: path, resolved: resolved}, 1)
|
||||||
|
|||||||
@@ -61,28 +61,25 @@ func (fs *Filesystem) Path() string {
|
|||||||
func (fs *Filesystem) File(p string) (*os.File, Stat, error) {
|
func (fs *Filesystem) File(p string) (*os.File, Stat, error) {
|
||||||
cleaned, err := fs.SafePath(p)
|
cleaned, err := fs.SafePath(p)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, Stat{}, errors.WithStackIf(err)
|
return nil, Stat{}, err
|
||||||
}
|
}
|
||||||
st, err := fs.Stat(cleaned)
|
st, err := fs.Stat(cleaned)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errors.Is(err, os.ErrNotExist) {
|
return nil, Stat{}, err
|
||||||
return nil, Stat{}, newFilesystemError(ErrNotExist, err)
|
|
||||||
}
|
|
||||||
return nil, Stat{}, errors.WithStackIf(err)
|
|
||||||
}
|
}
|
||||||
if st.IsDir() {
|
if st.IsDir() {
|
||||||
return nil, Stat{}, newFilesystemError(ErrCodeIsDirectory, nil)
|
return nil, Stat{}, newFilesystemError(ErrCodeIsDirectory, nil)
|
||||||
}
|
}
|
||||||
f, err := os.Open(cleaned)
|
f, err := os.Open(cleaned)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, Stat{}, errors.WithStackIf(err)
|
return nil, Stat{}, err
|
||||||
}
|
}
|
||||||
return f, st, nil
|
return f, st, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Touch acts by creating the given file and path on the disk if it is not present
|
// Acts by creating the given file and path on the disk if it is not present already. If
|
||||||
// already. If it is present, the file is opened using the defaults which will truncate
|
// it is present, the file is opened using the defaults which will truncate the contents.
|
||||||
// the contents. The opened file is then returned to the caller.
|
// The opened file is then returned to the caller.
|
||||||
func (fs *Filesystem) Touch(p string, flag int) (*os.File, error) {
|
func (fs *Filesystem) Touch(p string, flag int) (*os.File, error) {
|
||||||
cleaned, err := fs.SafePath(p)
|
cleaned, err := fs.SafePath(p)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -92,9 +89,6 @@ func (fs *Filesystem) Touch(p string, flag int) (*os.File, error) {
|
|||||||
if err == nil {
|
if err == nil {
|
||||||
return f, nil
|
return f, nil
|
||||||
}
|
}
|
||||||
if f != nil {
|
|
||||||
_ = f.Close()
|
|
||||||
}
|
|
||||||
// If the error is not because it doesn't exist then we just need to bail at this point.
|
// If the error is not because it doesn't exist then we just need to bail at this point.
|
||||||
if !errors.Is(err, os.ErrNotExist) {
|
if !errors.Is(err, os.ErrNotExist) {
|
||||||
return nil, errors.Wrap(err, "server/filesystem: touch: failed to open file handle")
|
return nil, errors.Wrap(err, "server/filesystem: touch: failed to open file handle")
|
||||||
@@ -165,7 +159,7 @@ func (fs *Filesystem) Writefile(p string, r io.Reader) error {
|
|||||||
// Adjust the disk usage to account for the old size and the new size of the file.
|
// Adjust the disk usage to account for the old size and the new size of the file.
|
||||||
fs.addDisk(sz - currentSize)
|
fs.addDisk(sz - currentSize)
|
||||||
|
|
||||||
return fs.unsafeChown(cleaned)
|
return fs.Chown(cleaned)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Creates a new directory (name) at a specified path (p) for the server.
|
// Creates a new directory (name) at a specified path (p) for the server.
|
||||||
@@ -223,12 +217,7 @@ func (fs *Filesystem) Chown(path string) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return fs.unsafeChown(cleaned)
|
|
||||||
}
|
|
||||||
|
|
||||||
// unsafeChown chowns the given path, without checking if the path is safe. This should only be used
|
|
||||||
// when the path has already been checked.
|
|
||||||
func (fs *Filesystem) unsafeChown(path string) error {
|
|
||||||
if fs.isTest {
|
if fs.isTest {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -237,19 +226,19 @@ func (fs *Filesystem) unsafeChown(path string) error {
|
|||||||
gid := config.Get().System.User.Gid
|
gid := config.Get().System.User.Gid
|
||||||
|
|
||||||
// Start by just chowning the initial path that we received.
|
// Start by just chowning the initial path that we received.
|
||||||
if err := os.Chown(path, uid, gid); err != nil {
|
if err := os.Chown(cleaned, uid, gid); err != nil {
|
||||||
return errors.Wrap(err, "server/filesystem: chown: failed to chown path")
|
return errors.Wrap(err, "server/filesystem: chown: failed to chown path")
|
||||||
}
|
}
|
||||||
|
|
||||||
// If this is not a directory we can now return from the function, there is nothing
|
// If this is not a directory we can now return from the function, there is nothing
|
||||||
// left that we need to do.
|
// left that we need to do.
|
||||||
if st, err := os.Stat(path); err != nil || !st.IsDir() {
|
if st, err := os.Stat(cleaned); err != nil || !st.IsDir() {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// If this was a directory, begin walking over its contents recursively and ensure that all
|
// If this was a directory, begin walking over its contents recursively and ensure that all
|
||||||
// of the subfiles and directories get their permissions updated as well.
|
// of the subfiles and directories get their permissions updated as well.
|
||||||
err := godirwalk.Walk(path, &godirwalk.Options{
|
err = godirwalk.Walk(cleaned, &godirwalk.Options{
|
||||||
Unsorted: true,
|
Unsorted: true,
|
||||||
Callback: func(p string, e *godirwalk.Dirent) error {
|
Callback: func(p string, e *godirwalk.Dirent) error {
|
||||||
// Do not attempt to chown a symlink. Go's os.Chown function will affect the symlink
|
// Do not attempt to chown a symlink. Go's os.Chown function will affect the symlink
|
||||||
@@ -266,6 +255,7 @@ func (fs *Filesystem) unsafeChown(path string) error {
|
|||||||
return os.Chown(p, uid, gid)
|
return os.Chown(p, uid, gid)
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|
||||||
return errors.Wrap(err, "server/filesystem: chown: failed to chown during walk function")
|
return errors.Wrap(err, "server/filesystem: chown: failed to chown during walk function")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -387,9 +377,10 @@ func (fs *Filesystem) TruncateRootDirectory() error {
|
|||||||
// Delete removes a file or folder from the system. Prevents the user from
|
// Delete removes a file or folder from the system. Prevents the user from
|
||||||
// accidentally (or maliciously) removing their root server data directory.
|
// accidentally (or maliciously) removing their root server data directory.
|
||||||
func (fs *Filesystem) Delete(p string) error {
|
func (fs *Filesystem) Delete(p string) error {
|
||||||
|
wg := sync.WaitGroup{}
|
||||||
// This is one of the few (only?) places in the codebase where we're explicitly not using
|
// This is one of the few (only?) places in the codebase where we're explicitly not using
|
||||||
// the SafePath functionality when working with user provided input. If we did, you would
|
// the SafePath functionality when working with user provided input. If we did, you would
|
||||||
// not be able to delete a file that is a symlink pointing to a location outside the data
|
// not be able to delete a file that is a symlink pointing to a location outside of the data
|
||||||
// directory.
|
// directory.
|
||||||
//
|
//
|
||||||
// We also want to avoid resolving a symlink that points _within_ the data directory and thus
|
// We also want to avoid resolving a symlink that points _within_ the data directory and thus
|
||||||
@@ -406,66 +397,26 @@ func (fs *Filesystem) Delete(p string) error {
|
|||||||
return errors.New("cannot delete root server directory")
|
return errors.New("cannot delete root server directory")
|
||||||
}
|
}
|
||||||
|
|
||||||
st, err := os.Lstat(resolved)
|
if st, err := os.Lstat(resolved); err != nil {
|
||||||
if err != nil {
|
|
||||||
if !os.IsNotExist(err) {
|
if !os.IsNotExist(err) {
|
||||||
fs.error(err).Warn("error while attempting to stat file before deletion")
|
fs.error(err).Warn("error while attempting to stat file before deletion")
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// The following logic is used to handle a case where a user attempts to
|
|
||||||
// delete a file that does not exist through a directory symlink.
|
|
||||||
// We don't want to reveal that the file does not exist, so we validate
|
|
||||||
// the path of the symlink and return a bad path error if it is invalid.
|
|
||||||
|
|
||||||
// The requested file or directory doesn't exist, so at this point we
|
|
||||||
// need to iterate up the path chain until we hit a directory that
|
|
||||||
// _does_ exist and can be validated.
|
|
||||||
parts := strings.Split(filepath.Dir(resolved), "/")
|
|
||||||
|
|
||||||
// Range over all the path parts and form directory paths from the end
|
|
||||||
// moving up until we have a valid resolution, or we run out of paths to
|
|
||||||
// try.
|
|
||||||
for k := range parts {
|
|
||||||
try := strings.Join(parts[:(len(parts)-k)], "/")
|
|
||||||
if !fs.unsafeIsInDataDirectory(try) {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
t, err := filepath.EvalSymlinks(try)
|
|
||||||
if err == nil {
|
|
||||||
if !fs.unsafeIsInDataDirectory(t) {
|
|
||||||
return NewBadPathResolution(p, t)
|
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Always return early if the file does not exist.
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the file is not a symlink, we need to check that it is not within a
|
|
||||||
// symlinked directory that points outside the data directory.
|
|
||||||
if st.Mode()&os.ModeSymlink == 0 {
|
|
||||||
ep, err := filepath.EvalSymlinks(resolved)
|
|
||||||
if err != nil {
|
|
||||||
if !os.IsNotExist(err) {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
} else if !fs.unsafeIsInDataDirectory(ep) {
|
|
||||||
return NewBadPathResolution(p, ep)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if st.IsDir() {
|
|
||||||
if s, err := fs.DirectorySize(resolved); err == nil {
|
|
||||||
fs.addDisk(-s)
|
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
fs.addDisk(-st.Size())
|
if !st.IsDir() {
|
||||||
|
fs.addDisk(-st.Size())
|
||||||
|
} else {
|
||||||
|
wg.Add(1)
|
||||||
|
go func(wg *sync.WaitGroup, st os.FileInfo, resolved string) {
|
||||||
|
defer wg.Done()
|
||||||
|
if s, err := fs.DirectorySize(resolved); err == nil {
|
||||||
|
fs.addDisk(-s)
|
||||||
|
}
|
||||||
|
}(&wg, st, resolved)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
wg.Wait()
|
||||||
|
|
||||||
return os.RemoveAll(resolved)
|
return os.RemoveAll(resolved)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -84,35 +84,6 @@ func (rfs *rootFs) reset() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFilesystem_Openfile(t *testing.T) {
|
|
||||||
g := Goblin(t)
|
|
||||||
fs, rfs := NewFs()
|
|
||||||
|
|
||||||
g.Describe("File", func() {
|
|
||||||
g.It("returns custom error when file does not exist", func() {
|
|
||||||
_, _, err := fs.File("foo/bar.txt")
|
|
||||||
|
|
||||||
g.Assert(err).IsNotNil()
|
|
||||||
g.Assert(IsErrorCode(err, ErrNotExist)).IsTrue()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("returns file stat information", func() {
|
|
||||||
_ = rfs.CreateServerFile("foo.txt", []byte("hello world"))
|
|
||||||
|
|
||||||
f, st, err := fs.File("foo.txt")
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
g.Assert(st.Name()).Equal("foo.txt")
|
|
||||||
g.Assert(f).IsNotNil()
|
|
||||||
_ = f.Close()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.AfterEach(func() {
|
|
||||||
rfs.reset()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFilesystem_Writefile(t *testing.T) {
|
func TestFilesystem_Writefile(t *testing.T) {
|
||||||
g := Goblin(t)
|
g := Goblin(t)
|
||||||
fs, rfs := NewFs()
|
fs, rfs := NewFs()
|
||||||
@@ -537,80 +508,6 @@ func TestFilesystem_Delete(t *testing.T) {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
g.It("deletes a symlink but not it's target within the root directory", func() {
|
|
||||||
// Symlink to a file inside the root directory.
|
|
||||||
err := os.Symlink(filepath.Join(rfs.root, "server/source.txt"), filepath.Join(rfs.root, "server/symlink.txt"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Delete the symlink itself.
|
|
||||||
err = fs.Delete("symlink.txt")
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Ensure the symlink was deleted.
|
|
||||||
_, err = os.Lstat(filepath.Join(rfs.root, "server/symlink.txt"))
|
|
||||||
g.Assert(err).IsNotNil()
|
|
||||||
|
|
||||||
// Ensure the symlink target still exists.
|
|
||||||
_, err = os.Lstat(filepath.Join(rfs.root, "server/source.txt"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("does not delete files symlinked outside of the root directory", func() {
|
|
||||||
// Create a file outside the root directory.
|
|
||||||
err := rfs.CreateServerFileFromString("/../source.txt", "test content")
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Create a symlink to the file outside the root directory.
|
|
||||||
err = os.Symlink(filepath.Join(rfs.root, "source.txt"), filepath.Join(rfs.root, "/server/symlink.txt"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Delete the symlink. (This should pass as we will delete the symlink itself, not it's target)
|
|
||||||
err = fs.Delete("symlink.txt")
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Ensure the file outside the root directory still exists.
|
|
||||||
_, err = os.Lstat(filepath.Join(rfs.root, "source.txt"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("does not delete files symlinked through a directory outside of the root directory", func() {
|
|
||||||
// Create a directory outside the root directory.
|
|
||||||
err := os.Mkdir(filepath.Join(rfs.root, "foo"), 0o755)
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Create a file inside the directory that is outside the root.
|
|
||||||
err = rfs.CreateServerFileFromString("/../foo/source.txt", "test content")
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Symlink the directory that is outside the root to a file inside the root.
|
|
||||||
err = os.Symlink(filepath.Join(rfs.root, "foo"), filepath.Join(rfs.root, "server/symlink"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Delete a file inside the symlinked directory.
|
|
||||||
err = fs.Delete("symlink/source.txt")
|
|
||||||
g.Assert(err).IsNotNil()
|
|
||||||
g.Assert(IsErrorCode(err, ErrCodePathResolution)).IsTrue()
|
|
||||||
|
|
||||||
// Ensure the file outside the root directory still exists.
|
|
||||||
_, err = os.Lstat(filepath.Join(rfs.root, "foo/source.txt"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("returns an error when trying to delete a non-existent file symlinked through a directory outside of the root directory", func() {
|
|
||||||
// Create a directory outside the root directory.
|
|
||||||
err := os.Mkdir(filepath.Join(rfs.root, "foo2"), 0o755)
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Symlink the directory that is outside the root to a file inside the root.
|
|
||||||
err = os.Symlink(filepath.Join(rfs.root, "foo2"), filepath.Join(rfs.root, "server/symlink"))
|
|
||||||
g.Assert(err).IsNil()
|
|
||||||
|
|
||||||
// Delete a file inside the symlinked directory.
|
|
||||||
err = fs.Delete("symlink/source.txt")
|
|
||||||
g.Assert(err).IsNotNil()
|
|
||||||
g.Assert(IsErrorCode(err, ErrCodePathResolution)).IsTrue()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.AfterEach(func() {
|
g.AfterEach(func() {
|
||||||
rfs.reset()
|
rfs.reset()
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ package filesystem
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
iofs "io/fs"
|
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -34,6 +33,8 @@ func (fs *Filesystem) IsIgnored(paths ...string) error {
|
|||||||
// This logic is actually copied over from the SFTP server code. Ideally that eventually
|
// This logic is actually copied over from the SFTP server code. Ideally that eventually
|
||||||
// either gets ported into this application, or is able to make use of this package.
|
// either gets ported into this application, or is able to make use of this package.
|
||||||
func (fs *Filesystem) SafePath(p string) (string, error) {
|
func (fs *Filesystem) SafePath(p string) (string, error) {
|
||||||
|
var nonExistentPathResolution string
|
||||||
|
|
||||||
// Start with a cleaned up path before checking the more complex bits.
|
// Start with a cleaned up path before checking the more complex bits.
|
||||||
r := fs.unsafeFilePath(p)
|
r := fs.unsafeFilePath(p)
|
||||||
|
|
||||||
@@ -43,24 +44,47 @@ func (fs *Filesystem) SafePath(p string) (string, error) {
|
|||||||
if err != nil && !os.IsNotExist(err) {
|
if err != nil && !os.IsNotExist(err) {
|
||||||
return "", errors.Wrap(err, "server/filesystem: failed to evaluate symlink")
|
return "", errors.Wrap(err, "server/filesystem: failed to evaluate symlink")
|
||||||
} else if os.IsNotExist(err) {
|
} else if os.IsNotExist(err) {
|
||||||
// The target of one of the symlinks (EvalSymlinks is recursive) does not exist.
|
// The requested directory doesn't exist, so at this point we need to iterate up the
|
||||||
// So we get what target path does not exist and check if it's within the data
|
// path chain until we hit a directory that _does_ exist and can be validated.
|
||||||
// directory. If it is, we return the original path, otherwise we return an error.
|
parts := strings.Split(filepath.Dir(r), "/")
|
||||||
pErr, ok := err.(*iofs.PathError)
|
|
||||||
if !ok {
|
var try string
|
||||||
return "", errors.Wrap(err, "server/filesystem: failed to evaluate symlink")
|
// Range over all of the path parts and form directory pathings from the end
|
||||||
|
// moving up until we have a valid resolution or we run out of paths to try.
|
||||||
|
for k := range parts {
|
||||||
|
try = strings.Join(parts[:(len(parts)-k)], "/")
|
||||||
|
|
||||||
|
if !fs.unsafeIsInDataDirectory(try) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
t, err := filepath.EvalSymlinks(try)
|
||||||
|
if err == nil {
|
||||||
|
nonExistentPathResolution = t
|
||||||
|
break
|
||||||
|
}
|
||||||
}
|
}
|
||||||
ep = pErr.Path
|
}
|
||||||
|
|
||||||
|
// If the new path doesn't start with their root directory there is clearly an escape
|
||||||
|
// attempt going on, and we should NOT resolve this path for them.
|
||||||
|
if nonExistentPathResolution != "" {
|
||||||
|
if !fs.unsafeIsInDataDirectory(nonExistentPathResolution) {
|
||||||
|
return "", NewBadPathResolution(p, nonExistentPathResolution)
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the nonExistentPathResolution variable is not empty then the initial path requested
|
||||||
|
// did not exist and we looped through the pathway until we found a match. At this point
|
||||||
|
// we've confirmed the first matched pathway exists in the root server directory, so we
|
||||||
|
// can go ahead and just return the path that was requested initially.
|
||||||
|
return r, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the requested directory from EvalSymlinks begins with the server root directory go
|
// If the requested directory from EvalSymlinks begins with the server root directory go
|
||||||
// ahead and return it. If not we'll return an error which will block any further action
|
// ahead and return it. If not we'll return an error which will block any further action
|
||||||
// on the file.
|
// on the file.
|
||||||
if fs.unsafeIsInDataDirectory(ep) {
|
if fs.unsafeIsInDataDirectory(ep) {
|
||||||
// Returning the original path here instead of the resolved path ensures that
|
return ep, nil
|
||||||
// whatever the user is trying to do will work as expected. If we returned the
|
|
||||||
// resolved path, the user would be unable to know that it is in fact a symlink.
|
|
||||||
return r, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return "", NewBadPathResolution(p, r)
|
return "", NewBadPathResolution(p, r)
|
||||||
|
|||||||
@@ -115,14 +115,6 @@ func TestFilesystem_Blocks_Symlinks(t *testing.T) {
|
|||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := os.Symlink(filepath.Join(rfs.root, "malicious_does_not_exist.txt"), filepath.Join(rfs.root, "/server/symlinked_does_not_exist.txt")); err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := os.Symlink(filepath.Join(rfs.root, "/server/symlinked_does_not_exist.txt"), filepath.Join(rfs.root, "/server/symlinked_does_not_exist2.txt")); err != nil {
|
|
||||||
panic(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := os.Symlink(filepath.Join(rfs.root, "/malicious_dir"), filepath.Join(rfs.root, "/server/external_dir")); err != nil {
|
if err := os.Symlink(filepath.Join(rfs.root, "/malicious_dir"), filepath.Join(rfs.root, "/server/external_dir")); err != nil {
|
||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
@@ -136,22 +128,6 @@ func TestFilesystem_Blocks_Symlinks(t *testing.T) {
|
|||||||
g.Assert(IsErrorCode(err, ErrCodePathResolution)).IsTrue()
|
g.Assert(IsErrorCode(err, ErrCodePathResolution)).IsTrue()
|
||||||
})
|
})
|
||||||
|
|
||||||
g.It("cannot write to a non-existent file symlinked outside the root", func() {
|
|
||||||
r := bytes.NewReader([]byte("testing what the fuck"))
|
|
||||||
|
|
||||||
err := fs.Writefile("symlinked_does_not_exist.txt", r)
|
|
||||||
g.Assert(err).IsNotNil()
|
|
||||||
g.Assert(IsErrorCode(err, ErrCodePathResolution)).IsTrue()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("cannot write to chained symlinks with target that does not exist outside the root", func() {
|
|
||||||
r := bytes.NewReader([]byte("testing what the fuck"))
|
|
||||||
|
|
||||||
err := fs.Writefile("symlinked_does_not_exist2.txt", r)
|
|
||||||
g.Assert(err).IsNotNil()
|
|
||||||
g.Assert(IsErrorCode(err, ErrCodePathResolution)).IsTrue()
|
|
||||||
})
|
|
||||||
|
|
||||||
g.It("cannot write a file to a directory symlinked outside the root", func() {
|
g.It("cannot write a file to a directory symlinked outside the root", func() {
|
||||||
r := bytes.NewReader([]byte("testing"))
|
r := bytes.NewReader([]byte("testing"))
|
||||||
|
|
||||||
|
|||||||
@@ -18,7 +18,6 @@ import (
|
|||||||
"github.com/docker/docker/api/types/container"
|
"github.com/docker/docker/api/types/container"
|
||||||
"github.com/docker/docker/api/types/mount"
|
"github.com/docker/docker/api/types/mount"
|
||||||
"github.com/docker/docker/client"
|
"github.com/docker/docker/client"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
"github.com/pterodactyl/wings/remote"
|
"github.com/pterodactyl/wings/remote"
|
||||||
@@ -31,17 +30,19 @@ import (
|
|||||||
//
|
//
|
||||||
// Pass true as the first argument in order to execute a server sync before the
|
// Pass true as the first argument in order to execute a server sync before the
|
||||||
// process to ensure the latest information is used.
|
// process to ensure the latest information is used.
|
||||||
func (s *Server) Install() error {
|
func (s *Server) Install(sync bool) error {
|
||||||
return s.install(false)
|
if sync {
|
||||||
}
|
s.Log().Info("syncing server state with remote source before executing installation process")
|
||||||
|
if err := s.Sync(); err != nil {
|
||||||
|
return errors.WrapIf(err, "install: failed to sync server state with Panel")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func (s *Server) install(reinstall bool) error {
|
|
||||||
var err error
|
var err error
|
||||||
if !s.Config().SkipEggScripts {
|
if !s.Config().SkipEggScripts {
|
||||||
// Send the start event so the Panel can automatically update. We don't
|
// Send the start event so the Panel can automatically update. We don't send this unless the process
|
||||||
// send this unless the process is actually going to run, otherwise all
|
// is actually going to run, otherwise all sorts of weird rapid UI behavior happens since there isn't
|
||||||
// sorts of weird rapid UI behavior happens since there isn't an actual
|
// an actual install process being executed.
|
||||||
// install process being executed.
|
|
||||||
s.Events().Publish(InstallStartedEvent, "")
|
s.Events().Publish(InstallStartedEvent, "")
|
||||||
|
|
||||||
err = s.internalInstall()
|
err = s.internalInstall()
|
||||||
@@ -50,13 +51,12 @@ func (s *Server) install(reinstall bool) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
s.Log().WithField("was_successful", err == nil).Debug("notifying panel of server install state")
|
s.Log().WithField("was_successful", err == nil).Debug("notifying panel of server install state")
|
||||||
if serr := s.SyncInstallState(err == nil, reinstall); serr != nil {
|
if serr := s.SyncInstallState(err == nil); serr != nil {
|
||||||
l := s.Log().WithField("was_successful", err == nil)
|
l := s.Log().WithField("was_successful", err == nil)
|
||||||
|
|
||||||
// If the request was successful but there was an error with this request,
|
// If the request was successful but there was an error with this request, attach the
|
||||||
// attach the error to this log entry. Otherwise, ignore it in this log
|
// error to this log entry. Otherwise ignore it in this log since whatever is calling
|
||||||
// since whatever is calling this function should handle the error and
|
// this function should handle the error and will end up logging the same one.
|
||||||
// will end up logging the same one.
|
|
||||||
if err == nil {
|
if err == nil {
|
||||||
l.WithField("error", err)
|
l.WithField("error", err)
|
||||||
}
|
}
|
||||||
@@ -64,20 +64,19 @@ func (s *Server) install(reinstall bool) error {
|
|||||||
l.Warn("failed to notify panel of server install state")
|
l.Warn("failed to notify panel of server install state")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ensure that the server is marked as offline at this point, otherwise you
|
// Ensure that the server is marked as offline at this point, otherwise you end up
|
||||||
// end up with a blank value which is a bit confusing.
|
// with a blank value which is a bit confusing.
|
||||||
s.Environment.SetState(environment.ProcessOfflineState)
|
s.Environment.SetState(environment.ProcessOfflineState)
|
||||||
|
|
||||||
// Push an event to the websocket, so we can auto-refresh the information in
|
// Push an event to the websocket so we can auto-refresh the information in the panel once
|
||||||
// the panel once the installation is completed.
|
// the install is completed.
|
||||||
s.Events().Publish(InstallCompletedEvent, "")
|
s.Events().Publish(InstallCompletedEvent, "")
|
||||||
|
|
||||||
return errors.WithStackIf(err)
|
return errors.WithStackIf(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Reinstall reinstalls a server's software by utilizing the installation script
|
// Reinstalls a server's software by utilizing the install script for the server egg. This
|
||||||
// for the server egg. This does not touch any existing files for the server,
|
// does not touch any existing files for the server, other than what the script modifies.
|
||||||
// other than what the script modifies.
|
|
||||||
func (s *Server) Reinstall() error {
|
func (s *Server) Reinstall() error {
|
||||||
if s.Environment.State() != environment.ProcessOfflineState {
|
if s.Environment.State() != environment.ProcessOfflineState {
|
||||||
s.Log().Debug("waiting for server instance to enter a stopped state")
|
s.Log().Debug("waiting for server instance to enter a stopped state")
|
||||||
@@ -86,12 +85,7 @@ func (s *Server) Reinstall() error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
s.Log().Info("syncing server state with remote source before executing re-installation process")
|
return s.Install(true)
|
||||||
if err := s.Sync(); err != nil {
|
|
||||||
return errors.WrapIf(err, "install: failed to sync server state with Panel")
|
|
||||||
}
|
|
||||||
|
|
||||||
return s.install(true)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Internal installation function used to simplify reporting back to the Panel.
|
// Internal installation function used to simplify reporting back to the Panel.
|
||||||
@@ -120,9 +114,8 @@ type InstallationProcess struct {
|
|||||||
client *client.Client
|
client *client.Client
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewInstallationProcess returns a new installation process struct that will be
|
// Generates a new installation process struct that will be used to create containers,
|
||||||
// used to create containers and otherwise perform installation commands for a
|
// and otherwise perform installation commands for a server.
|
||||||
// server.
|
|
||||||
func NewInstallationProcess(s *Server, script *remote.InstallationScript) (*InstallationProcess, error) {
|
func NewInstallationProcess(s *Server, script *remote.InstallationScript) (*InstallationProcess, error) {
|
||||||
proc := &InstallationProcess{
|
proc := &InstallationProcess{
|
||||||
Script: script,
|
Script: script,
|
||||||
@@ -138,8 +131,8 @@ func NewInstallationProcess(s *Server, script *remote.InstallationScript) (*Inst
|
|||||||
return proc, nil
|
return proc, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsInstalling returns if the server is actively running the installation
|
// Determines if the server is actively running the installation process by checking the status
|
||||||
// process by checking the status of the installer lock.
|
// of the installer lock.
|
||||||
func (s *Server) IsInstalling() bool {
|
func (s *Server) IsInstalling() bool {
|
||||||
return s.installing.Load()
|
return s.installing.Load()
|
||||||
}
|
}
|
||||||
@@ -160,7 +153,7 @@ func (s *Server) SetRestoring(state bool) {
|
|||||||
s.restoring.Store(state)
|
s.restoring.Store(state)
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoveContainer removes the installation container for the server.
|
// Removes the installer container for the server.
|
||||||
func (ip *InstallationProcess) RemoveContainer() error {
|
func (ip *InstallationProcess) RemoveContainer() error {
|
||||||
err := ip.client.ContainerRemove(ip.Server.Context(), ip.Server.ID()+"_installer", types.ContainerRemoveOptions{
|
err := ip.client.ContainerRemove(ip.Server.Context(), ip.Server.ID()+"_installer", types.ContainerRemoveOptions{
|
||||||
RemoveVolumes: true,
|
RemoveVolumes: true,
|
||||||
@@ -333,14 +326,14 @@ func (ip *InstallationProcess) BeforeExecute() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetLogPath returns the log path for the installation process.
|
// Returns the log path for the installation process.
|
||||||
func (ip *InstallationProcess) GetLogPath() string {
|
func (ip *InstallationProcess) GetLogPath() string {
|
||||||
return filepath.Join(config.Get().System.LogDirectory, "/install", ip.Server.ID()+".log")
|
return filepath.Join(config.Get().System.LogDirectory, "/install", ip.Server.ID()+".log")
|
||||||
}
|
}
|
||||||
|
|
||||||
// AfterExecute cleans up after the execution of the installation process.
|
// Cleans up after the execution of the installation process. This grabs the logs from the
|
||||||
// This grabs the logs from the process to store in the server configuration
|
// process to store in the server configuration directory, and then destroys the associated
|
||||||
// directory, and then destroys the associated installation container.
|
// installation container.
|
||||||
func (ip *InstallationProcess) AfterExecute(containerId string) error {
|
func (ip *InstallationProcess) AfterExecute(containerId string) error {
|
||||||
defer ip.RemoveContainer()
|
defer ip.RemoveContainer()
|
||||||
|
|
||||||
@@ -425,8 +418,7 @@ func (ip *InstallationProcess) Execute() (string, error) {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg := config.Get()
|
tmpfsSize := strconv.Itoa(int(config.Get().Docker.TmpfsSize))
|
||||||
tmpfsSize := strconv.Itoa(int(cfg.Docker.TmpfsSize))
|
|
||||||
hostConf := &container.HostConfig{
|
hostConf := &container.HostConfig{
|
||||||
Mounts: []mount.Mount{
|
Mounts: []mount.Mount{
|
||||||
{
|
{
|
||||||
@@ -446,10 +438,17 @@ func (ip *InstallationProcess) Execute() (string, error) {
|
|||||||
Tmpfs: map[string]string{
|
Tmpfs: map[string]string{
|
||||||
"/tmp": "rw,exec,nosuid,size=" + tmpfsSize + "M",
|
"/tmp": "rw,exec,nosuid,size=" + tmpfsSize + "M",
|
||||||
},
|
},
|
||||||
DNS: cfg.Docker.Network.Dns,
|
DNS: config.Get().Docker.Network.Dns,
|
||||||
LogConfig: cfg.Docker.ContainerLogConfig(),
|
LogConfig: container.LogConfig{
|
||||||
NetworkMode: container.NetworkMode(cfg.Docker.Network.Mode),
|
Type: "local",
|
||||||
UsernsMode: container.UsernsMode(cfg.Docker.UsernsMode),
|
Config: map[string]string{
|
||||||
|
"max-size": "5m",
|
||||||
|
"max-file": "1",
|
||||||
|
"compress": "false",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
Privileged: true,
|
||||||
|
NetworkMode: container.NetworkMode(config.Get().Docker.Network.Mode),
|
||||||
}
|
}
|
||||||
|
|
||||||
// Ensure the root directory for the server exists properly before attempting
|
// Ensure the root directory for the server exists properly before attempting
|
||||||
@@ -525,7 +524,7 @@ func (ip *InstallationProcess) StreamOutput(ctx context.Context, id string) erro
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// resourceLimits returns resource limits for the installation container. This
|
// resourceLimits returns the install container specific resource limits. This
|
||||||
// looks at the globally defined install container limits and attempts to use
|
// looks at the globally defined install container limits and attempts to use
|
||||||
// the higher of the two (defined limits & server limits). This allows for servers
|
// the higher of the two (defined limits & server limits). This allows for servers
|
||||||
// with super low limits (e.g. Discord bots with 128Mb of memory) to perform more
|
// with super low limits (e.g. Discord bots with 128Mb of memory) to perform more
|
||||||
@@ -537,8 +536,8 @@ func (ip *InstallationProcess) StreamOutput(ctx context.Context, id string) erro
|
|||||||
func (ip *InstallationProcess) resourceLimits() container.Resources {
|
func (ip *InstallationProcess) resourceLimits() container.Resources {
|
||||||
limits := config.Get().Docker.InstallerLimits
|
limits := config.Get().Docker.InstallerLimits
|
||||||
|
|
||||||
// Create a copy of the configuration, so we're not accidentally making
|
// Create a copy of the configuration so we're not accidentally making changes
|
||||||
// changes to the underlying server build data.
|
// to the underlying server build data.
|
||||||
c := *ip.Server.Config()
|
c := *ip.Server.Config()
|
||||||
cfg := c.Build
|
cfg := c.Build
|
||||||
if cfg.MemoryLimit < limits.Memory {
|
if cfg.MemoryLimit < limits.Memory {
|
||||||
@@ -562,12 +561,10 @@ func (ip *InstallationProcess) resourceLimits() container.Resources {
|
|||||||
return resources
|
return resources
|
||||||
}
|
}
|
||||||
|
|
||||||
// SyncInstallState makes an HTTP request to the Panel instance notifying it that
|
// SyncInstallState makes a HTTP request to the Panel instance notifying it that
|
||||||
// the server has completed the installation process, and what the state of the
|
// the server has completed the installation process, and what the state of the
|
||||||
// server is.
|
// server is. A boolean value of "true" means everything was successful, "false"
|
||||||
func (s *Server) SyncInstallState(successful, reinstall bool) error {
|
// means something went wrong and the server must be deleted and re-created.
|
||||||
return s.client.SetInstallationStatus(s.Context(), s.ID(), remote.InstallStatusRequest{
|
func (s *Server) SyncInstallState(successful bool) error {
|
||||||
Successful: successful,
|
return s.client.SetInstallationStatus(s.Context(), s.ID(), successful)
|
||||||
Reinstall: reinstall,
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/events"
|
"github.com/pterodactyl/wings/events"
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
|
|
||||||
|
|||||||
@@ -205,7 +205,6 @@ func (m *Manager) InitServer(data remote.ServerConfigurationResponse) (*Server,
|
|||||||
Mounts: s.Mounts(),
|
Mounts: s.Mounts(),
|
||||||
Allocations: s.cfg.Allocations,
|
Allocations: s.cfg.Allocations,
|
||||||
Limits: s.cfg.Build,
|
Limits: s.cfg.Build,
|
||||||
Labels: s.cfg.Labels,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
envCfg := environment.NewConfiguration(settings, s.GetEnvironmentVariables())
|
envCfg := environment.NewConfiguration(settings, s.GetEnvironmentVariables())
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import (
|
|||||||
|
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/google/uuid"
|
"github.com/google/uuid"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/config"
|
"github.com/pterodactyl/wings/config"
|
||||||
"github.com/pterodactyl/wings/environment"
|
"github.com/pterodactyl/wings/environment"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
. "github.com/franela/goblin"
|
. "github.com/franela/goblin"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/system"
|
"github.com/pterodactyl/wings/system"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -147,7 +147,6 @@ func (s *Server) Context() context.Context {
|
|||||||
// server instance.
|
// server instance.
|
||||||
func (s *Server) GetEnvironmentVariables() []string {
|
func (s *Server) GetEnvironmentVariables() []string {
|
||||||
out := []string{
|
out := []string{
|
||||||
// TODO: allow this to be overridden by the user.
|
|
||||||
fmt.Sprintf("TZ=%s", config.Get().System.Timezone),
|
fmt.Sprintf("TZ=%s", config.Get().System.Timezone),
|
||||||
fmt.Sprintf("STARTUP=%s", s.Config().Invocation),
|
fmt.Sprintf("STARTUP=%s", s.Config().Invocation),
|
||||||
fmt.Sprintf("SERVER_MEMORY=%d", s.MemoryLimit()),
|
fmt.Sprintf("SERVER_MEMORY=%d", s.MemoryLimit()),
|
||||||
|
|||||||
@@ -1,52 +0,0 @@
|
|||||||
package transfer
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/internal/progress"
|
|
||||||
"github.com/pterodactyl/wings/server/filesystem"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Archive returns an archive that can be used to stream the contents of the
|
|
||||||
// contents of a server.
|
|
||||||
func (t *Transfer) Archive() (*Archive, error) {
|
|
||||||
if t.archive == nil {
|
|
||||||
// Get the disk usage of the server (used to calculate the progress of the archive process)
|
|
||||||
rawSize, err := t.Server.Filesystem().DiskUsage(true)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("transfer: failed to get server disk usage: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create a new archive instance and assign it to the transfer.
|
|
||||||
t.archive = NewArchive(t, uint64(rawSize))
|
|
||||||
}
|
|
||||||
|
|
||||||
return t.archive, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Archive represents an archive used to transfer the contents of a server.
|
|
||||||
type Archive struct {
|
|
||||||
archive *filesystem.Archive
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewArchive returns a new archive associated with the given transfer.
|
|
||||||
func NewArchive(t *Transfer, size uint64) *Archive {
|
|
||||||
return &Archive{
|
|
||||||
archive: &filesystem.Archive{
|
|
||||||
BasePath: t.Server.Filesystem().Path(),
|
|
||||||
Progress: progress.NewProgress(size),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Stream returns a reader that can be used to stream the contents of the archive.
|
|
||||||
func (a *Archive) Stream(ctx context.Context, w io.Writer) error {
|
|
||||||
return a.archive.Stream(ctx, w)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Progress returns the current progress of the archive.
|
|
||||||
func (a *Archive) Progress() *progress.Progress {
|
|
||||||
return a.archive.Progress
|
|
||||||
}
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
// Package transfer handles all logic related to transferring servers between
|
|
||||||
// two nodes. This includes the logic for archiving a server on the source node
|
|
||||||
// and logic for importing a server from the source node into the target node.
|
|
||||||
package transfer
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
package transfer
|
|
||||||
|
|
||||||
import (
|
|
||||||
"sync"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
incomingTransfers = NewManager()
|
|
||||||
outgoingTransfers = NewManager()
|
|
||||||
)
|
|
||||||
|
|
||||||
// Incoming returns a transfer manager for incoming transfers.
|
|
||||||
func Incoming() *Manager {
|
|
||||||
return incomingTransfers
|
|
||||||
}
|
|
||||||
|
|
||||||
// Outgoing returns a transfer manager for outgoing transfers.
|
|
||||||
func Outgoing() *Manager {
|
|
||||||
return outgoingTransfers
|
|
||||||
}
|
|
||||||
|
|
||||||
// Manager manages transfers.
|
|
||||||
type Manager struct {
|
|
||||||
mu sync.RWMutex
|
|
||||||
transfers map[string]*Transfer
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewManager returns a new transfer manager.
|
|
||||||
func NewManager() *Manager {
|
|
||||||
return &Manager{
|
|
||||||
transfers: make(map[string]*Transfer),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add adds a transfer to the manager.
|
|
||||||
func (m *Manager) Add(transfer *Transfer) {
|
|
||||||
m.mu.Lock()
|
|
||||||
defer m.mu.Unlock()
|
|
||||||
|
|
||||||
m.transfers[transfer.Server.ID()] = transfer
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove removes a transfer from the manager.
|
|
||||||
func (m *Manager) Remove(transfer *Transfer) {
|
|
||||||
m.mu.Lock()
|
|
||||||
defer m.mu.Unlock()
|
|
||||||
|
|
||||||
delete(m.transfers, transfer.Server.ID())
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get gets a transfer from the manager using a server ID.
|
|
||||||
func (m *Manager) Get(id string) *Transfer {
|
|
||||||
m.mu.RLock()
|
|
||||||
defer m.mu.RUnlock()
|
|
||||||
|
|
||||||
return m.transfers[id]
|
|
||||||
}
|
|
||||||
@@ -1,166 +0,0 @@
|
|||||||
package transfer
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"crypto/sha256"
|
|
||||||
"encoding/hex"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"mime/multipart"
|
|
||||||
"net/http"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/internal/progress"
|
|
||||||
)
|
|
||||||
|
|
||||||
// PushArchiveToTarget POSTs the archive to the target node and returns the
|
|
||||||
// response body.
|
|
||||||
func (t *Transfer) PushArchiveToTarget(url, token string) ([]byte, error) {
|
|
||||||
ctx, cancel := context.WithCancel(t.ctx)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
t.SendMessage("Preparing to stream server data to destination...")
|
|
||||||
t.SetStatus(StatusProcessing)
|
|
||||||
|
|
||||||
a, err := t.Archive()
|
|
||||||
if err != nil {
|
|
||||||
t.Error(err, "Failed to get archive for transfer.")
|
|
||||||
return nil, errors.New("failed to get archive for transfer")
|
|
||||||
}
|
|
||||||
|
|
||||||
t.SendMessage("Streaming archive to destination...")
|
|
||||||
|
|
||||||
// Send the upload progress to the websocket every 5 seconds.
|
|
||||||
ctx2, cancel2 := context.WithCancel(ctx)
|
|
||||||
defer cancel2()
|
|
||||||
go func(ctx context.Context, p *progress.Progress, tc *time.Ticker) {
|
|
||||||
defer tc.Stop()
|
|
||||||
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return
|
|
||||||
case <-tc.C:
|
|
||||||
t.SendMessage("Uploading " + p.Progress(25))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}(ctx2, a.Progress(), time.NewTicker(5*time.Second))
|
|
||||||
|
|
||||||
// Create a new request using the pipe as the body.
|
|
||||||
body, writer := io.Pipe()
|
|
||||||
defer body.Close()
|
|
||||||
defer writer.Close()
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, body)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
req.Header.Set("Authorization", token)
|
|
||||||
|
|
||||||
// Create a new multipart writer that writes the archive to the pipe.
|
|
||||||
mp := multipart.NewWriter(writer)
|
|
||||||
defer mp.Close()
|
|
||||||
req.Header.Set("Content-Type", mp.FormDataContentType())
|
|
||||||
|
|
||||||
// Create a new goroutine to write the archive to the pipe used by the
|
|
||||||
// multipart writer.
|
|
||||||
errChan := make(chan error)
|
|
||||||
go func() {
|
|
||||||
defer close(errChan)
|
|
||||||
defer writer.Close()
|
|
||||||
defer mp.Close()
|
|
||||||
|
|
||||||
src, pw := io.Pipe()
|
|
||||||
defer src.Close()
|
|
||||||
defer pw.Close()
|
|
||||||
|
|
||||||
h := sha256.New()
|
|
||||||
tee := io.TeeReader(src, h)
|
|
||||||
|
|
||||||
dest, err := mp.CreateFormFile("archive", "archive.tar.gz")
|
|
||||||
if err != nil {
|
|
||||||
errChan <- errors.New("failed to create form file")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
ch := make(chan error)
|
|
||||||
go func() {
|
|
||||||
defer close(ch)
|
|
||||||
|
|
||||||
if _, err := io.Copy(dest, tee); err != nil {
|
|
||||||
ch <- fmt.Errorf("failed to stream archive to destination: %w", err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Log().Debug("finished copying dest to tee")
|
|
||||||
}()
|
|
||||||
|
|
||||||
if err := a.Stream(ctx, pw); err != nil {
|
|
||||||
errChan <- errors.New("failed to stream archive to pipe")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
t.Log().Debug("finished streaming archive to pipe")
|
|
||||||
|
|
||||||
// Close the pipe writer early to release resources and ensure that the data gets flushed.
|
|
||||||
_ = pw.Close()
|
|
||||||
|
|
||||||
// Wait for the copy to finish before we continue.
|
|
||||||
t.Log().Debug("waiting on copy to finish")
|
|
||||||
if err := <-ch; err != nil {
|
|
||||||
errChan <- err
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := mp.WriteField("checksum", hex.EncodeToString(h.Sum(nil))); err != nil {
|
|
||||||
errChan <- errors.New("failed to stream checksum")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
cancel2()
|
|
||||||
t.SendMessage("Finished streaming archive to destination.")
|
|
||||||
|
|
||||||
if err := mp.Close(); err != nil {
|
|
||||||
t.Log().WithError(err).Error("error while closing multipart writer")
|
|
||||||
}
|
|
||||||
t.Log().Debug("closed multipart writer")
|
|
||||||
}()
|
|
||||||
|
|
||||||
t.Log().Debug("sending archive to destination")
|
|
||||||
client := http.Client{Timeout: 0}
|
|
||||||
res, err := client.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
t.Log().Debug("error while sending archive to destination")
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if res.StatusCode != http.StatusOK {
|
|
||||||
return nil, fmt.Errorf("unexpected status code from destination: %d", res.StatusCode)
|
|
||||||
}
|
|
||||||
t.Log().Debug("waiting for stream to complete")
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return nil, ctx.Err()
|
|
||||||
case err2 := <-errChan:
|
|
||||||
t.Log().Debug("stream completed")
|
|
||||||
if err != nil || err2 != nil {
|
|
||||||
if err == context.Canceled {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Log().WithError(err).Debug("failed to send archive to destination")
|
|
||||||
return nil, fmt.Errorf("http error: %w, multipart error: %v", err, err2)
|
|
||||||
}
|
|
||||||
defer res.Body.Close()
|
|
||||||
t.Log().Debug("received response from destination")
|
|
||||||
|
|
||||||
v, err := io.ReadAll(res.Body)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to read response body: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if res.StatusCode != http.StatusOK {
|
|
||||||
return nil, errors.New(string(v))
|
|
||||||
}
|
|
||||||
|
|
||||||
return v, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,128 +0,0 @@
|
|||||||
package transfer
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/apex/log"
|
|
||||||
"github.com/mitchellh/colorstring"
|
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/server"
|
|
||||||
"github.com/pterodactyl/wings/system"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Status represents the current status of a transfer.
|
|
||||||
type Status string
|
|
||||||
|
|
||||||
// String satisfies the fmt.Stringer interface.
|
|
||||||
func (s Status) String() string {
|
|
||||||
return string(s)
|
|
||||||
}
|
|
||||||
|
|
||||||
const (
|
|
||||||
// StatusPending is the status of a transfer when it is first created.
|
|
||||||
StatusPending Status = "pending"
|
|
||||||
// StatusProcessing is the status of a transfer when it is currently in
|
|
||||||
// progress, such as when the archive is being streamed to the target node.
|
|
||||||
StatusProcessing Status = "processing"
|
|
||||||
|
|
||||||
// StatusCancelling is the status of a transfer when it is in the process of
|
|
||||||
// being cancelled.
|
|
||||||
StatusCancelling Status = "cancelling"
|
|
||||||
|
|
||||||
// StatusCancelled is the final status of a transfer when it has been
|
|
||||||
// cancelled.
|
|
||||||
StatusCancelled Status = "cancelled"
|
|
||||||
// StatusFailed is the final status of a transfer when it has failed.
|
|
||||||
StatusFailed Status = "failed"
|
|
||||||
// StatusCompleted is the final status of a transfer when it has completed.
|
|
||||||
StatusCompleted Status = "completed"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Transfer represents a transfer of a server from one node to another.
|
|
||||||
type Transfer struct {
|
|
||||||
// ctx is the context for the transfer.
|
|
||||||
ctx context.Context
|
|
||||||
// cancel is used to cancel all ongoing transfer operations for the server.
|
|
||||||
cancel *context.CancelFunc
|
|
||||||
|
|
||||||
// Server associated with the transfer.
|
|
||||||
Server *server.Server
|
|
||||||
// status of the transfer.
|
|
||||||
status *system.Atomic[Status]
|
|
||||||
|
|
||||||
// archive is the archive that is being created for the transfer.
|
|
||||||
archive *Archive
|
|
||||||
}
|
|
||||||
|
|
||||||
// New returns a new transfer instance for the given server.
|
|
||||||
func New(ctx context.Context, s *server.Server) *Transfer {
|
|
||||||
ctx, cancel := context.WithCancel(ctx)
|
|
||||||
|
|
||||||
return &Transfer{
|
|
||||||
ctx: ctx,
|
|
||||||
cancel: &cancel,
|
|
||||||
|
|
||||||
Server: s,
|
|
||||||
status: system.NewAtomic(StatusPending),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Context returns the context for the transfer.
|
|
||||||
func (t *Transfer) Context() context.Context {
|
|
||||||
return t.ctx
|
|
||||||
}
|
|
||||||
|
|
||||||
// Cancel cancels the transfer.
|
|
||||||
func (t *Transfer) Cancel() {
|
|
||||||
status := t.Status()
|
|
||||||
if status == StatusCancelling ||
|
|
||||||
status == StatusCancelled ||
|
|
||||||
status == StatusCompleted ||
|
|
||||||
status == StatusFailed {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if t.cancel == nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
t.SetStatus(StatusCancelling)
|
|
||||||
(*t.cancel)()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Status returns the current status of the transfer.
|
|
||||||
func (t *Transfer) Status() Status {
|
|
||||||
return t.status.Load()
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetStatus sets the status of the transfer.
|
|
||||||
func (t *Transfer) SetStatus(s Status) {
|
|
||||||
// TODO: prevent certain status changes from happening.
|
|
||||||
// If we are cancelling, then we can't go back to processing.
|
|
||||||
t.status.Store(s)
|
|
||||||
|
|
||||||
t.Server.Events().Publish(server.TransferStatusEvent, s)
|
|
||||||
}
|
|
||||||
|
|
||||||
// SendMessage sends a message to the server's console.
|
|
||||||
func (t *Transfer) SendMessage(v string) {
|
|
||||||
t.Server.Events().Publish(
|
|
||||||
server.TransferLogsEvent,
|
|
||||||
colorstring.Color("[yellow][bold]"+time.Now().Format(time.RFC1123)+" [Transfer System] [Source Node]:[default] "+v),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Error logs an error that occurred on the source node.
|
|
||||||
func (t *Transfer) Error(err error, v string) {
|
|
||||||
t.Log().WithError(err).Error(v)
|
|
||||||
t.SendMessage(v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Log returns a logger for the transfer.
|
|
||||||
func (t *Transfer) Log() *log.Entry {
|
|
||||||
if t.Server == nil {
|
|
||||||
return log.WithField("subsystem", "transfer")
|
|
||||||
}
|
|
||||||
return t.Server.Log().WithField("subsystem", "transfer")
|
|
||||||
}
|
|
||||||
@@ -3,7 +3,6 @@ package sftp
|
|||||||
import (
|
import (
|
||||||
"emperror.dev/errors"
|
"emperror.dev/errors"
|
||||||
"github.com/apex/log"
|
"github.com/apex/log"
|
||||||
|
|
||||||
"github.com/pterodactyl/wings/internal/database"
|
"github.com/pterodactyl/wings/internal/database"
|
||||||
"github.com/pterodactyl/wings/internal/models"
|
"github.com/pterodactyl/wings/internal/models"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -68,21 +68,6 @@ func (c *SFTPServer) Run() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
conf := &ssh.ServerConfig{
|
conf := &ssh.ServerConfig{
|
||||||
Config: ssh.Config{
|
|
||||||
KeyExchanges: []string{
|
|
||||||
"curve25519-sha256", "curve25519-sha256@libssh.org",
|
|
||||||
"ecdh-sha2-nistp256", "ecdh-sha2-nistp384", "ecdh-sha2-nistp521",
|
|
||||||
"diffie-hellman-group14-sha256",
|
|
||||||
},
|
|
||||||
Ciphers: []string{
|
|
||||||
"aes128-gcm@openssh.com",
|
|
||||||
"chacha20-poly1305@openssh.com",
|
|
||||||
"aes128-ctr", "aes192-ctr", "aes256-ctr",
|
|
||||||
},
|
|
||||||
MACs: []string{
|
|
||||||
"hmac-sha2-256-etm@openssh.com", "hmac-sha2-256",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
NoClientAuth: false,
|
NoClientAuth: false,
|
||||||
MaxAuthTries: 6,
|
MaxAuthTries: 6,
|
||||||
PasswordCallback: func(conn ssh.ConnMetadata, password []byte) (*ssh.Permissions, error) {
|
PasswordCallback: func(conn ssh.ConnMetadata, password []byte) (*ssh.Permissions, error) {
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
package system
|
package system
|
||||||
|
|
||||||
var Version = "develop"
|
var Version = "1.7.1"
|
||||||
|
|||||||
@@ -15,16 +15,7 @@ func MutexLocked(m *sync.RWMutex) bool {
|
|||||||
|
|
||||||
state := v.FieldByName("w").FieldByName("state")
|
state := v.FieldByName("w").FieldByName("state")
|
||||||
|
|
||||||
readerCountField := v.FieldByName("readerCount")
|
return state.Int()&1 == 1 || v.FieldByName("readerCount").Int() > 0
|
||||||
// go1.20 changed readerCount to an atomic
|
|
||||||
// ref; https://github.com/golang/go/commit/e509452727b469d89a3fc4a7d1cbf9d3f110efee
|
|
||||||
var readerCount int64
|
|
||||||
if readerCountField.Kind() == reflect.Struct {
|
|
||||||
readerCount = readerCountField.FieldByName("v").Int()
|
|
||||||
} else {
|
|
||||||
readerCount = readerCountField.Int()
|
|
||||||
}
|
|
||||||
return state.Int()&1 == 1 || readerCount > 0
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSink(t *testing.T) {
|
func TestSink(t *testing.T) {
|
||||||
|
|||||||
29
system/strings.go
Normal file
29
system/strings.go
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
package system
|
||||||
|
|
||||||
|
import (
|
||||||
|
"math/rand"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
var ipTrimRegex = regexp.MustCompile(`(:\d*)?$`)
|
||||||
|
|
||||||
|
const characters = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"
|
||||||
|
|
||||||
|
// RandomString generates a random string of alpha-numeric characters using a
|
||||||
|
// pseudo-random number generator. The output of this function IS NOT cryptographically
|
||||||
|
// secure, it is used solely for generating random strings outside a security context.
|
||||||
|
func RandomString(n int) string {
|
||||||
|
var b strings.Builder
|
||||||
|
b.Grow(n)
|
||||||
|
for i := 0; i < n; i++ {
|
||||||
|
b.WriteByte(characters[rand.Intn(len(characters))])
|
||||||
|
}
|
||||||
|
return b.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// TrimIPSuffix removes the internal port value from an IP address to ensure we're only
|
||||||
|
// ever working directly with the IP address.
|
||||||
|
func TrimIPSuffix(s string) string {
|
||||||
|
return ipTrimRegex.ReplaceAllString(s, "")
|
||||||
|
}
|
||||||
131
system/system.go
131
system/system.go
@@ -1,57 +1,17 @@
|
|||||||
package system
|
package system
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
|
||||||
"runtime"
|
"runtime"
|
||||||
|
|
||||||
"github.com/acobaugh/osrelease"
|
|
||||||
"github.com/docker/docker/api/types"
|
|
||||||
"github.com/docker/docker/client"
|
|
||||||
"github.com/docker/docker/pkg/parsers/kernel"
|
"github.com/docker/docker/pkg/parsers/kernel"
|
||||||
)
|
)
|
||||||
|
|
||||||
type Information struct {
|
type Information struct {
|
||||||
Version string `json:"version"`
|
Version string `json:"version"`
|
||||||
Docker DockerInformation `json:"docker"`
|
|
||||||
System System `json:"system"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type DockerInformation struct {
|
|
||||||
Version string `json:"version"`
|
|
||||||
Cgroups DockerCgroups `json:"cgroups"`
|
|
||||||
Containers DockerContainers `json:"containers"`
|
|
||||||
Storage DockerStorage `json:"storage"`
|
|
||||||
Runc DockerRunc `json:"runc"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type DockerCgroups struct {
|
|
||||||
Driver string `json:"driver"`
|
|
||||||
Version string `json:"version"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type DockerContainers struct {
|
|
||||||
Total int `json:"total"`
|
|
||||||
Running int `json:"running"`
|
|
||||||
Paused int `json:"paused"`
|
|
||||||
Stopped int `json:"stopped"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type DockerStorage struct {
|
|
||||||
Driver string `json:"driver"`
|
|
||||||
Filesystem string `json:"filesystem"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type DockerRunc struct {
|
|
||||||
Version string `json:"version"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type System struct {
|
|
||||||
Architecture string `json:"architecture"`
|
|
||||||
CPUThreads int `json:"cpu_threads"`
|
|
||||||
MemoryBytes int64 `json:"memory_bytes"`
|
|
||||||
KernelVersion string `json:"kernel_version"`
|
KernelVersion string `json:"kernel_version"`
|
||||||
|
Architecture string `json:"architecture"`
|
||||||
OS string `json:"os"`
|
OS string `json:"os"`
|
||||||
OSType string `json:"os_type"`
|
CpuCount int `json:"cpu_count"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func GetSystemInformation() (*Information, error) {
|
func GetSystemInformation() (*Information, error) {
|
||||||
@@ -60,84 +20,13 @@ func GetSystemInformation() (*Information, error) {
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
version, info, err := GetDockerInfo(context.Background())
|
s := &Information{
|
||||||
if err != nil {
|
Version: Version,
|
||||||
return nil, err
|
KernelVersion: k.String(),
|
||||||
|
Architecture: runtime.GOARCH,
|
||||||
|
OS: runtime.GOOS,
|
||||||
|
CpuCount: runtime.NumCPU(),
|
||||||
}
|
}
|
||||||
|
|
||||||
release, err := osrelease.Read()
|
return s, nil
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var os string
|
|
||||||
if release["PRETTY_NAME"] != "" {
|
|
||||||
os = release["PRETTY_NAME"]
|
|
||||||
} else if release["NAME"] != "" {
|
|
||||||
os = release["NAME"]
|
|
||||||
} else {
|
|
||||||
os = info.OperatingSystem
|
|
||||||
}
|
|
||||||
|
|
||||||
var filesystem string
|
|
||||||
for _, v := range info.DriverStatus {
|
|
||||||
if v[0] != "Backing Filesystem" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
filesystem = v[1]
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
return &Information{
|
|
||||||
Version: Version,
|
|
||||||
Docker: DockerInformation{
|
|
||||||
Version: version.Version,
|
|
||||||
Cgroups: DockerCgroups{
|
|
||||||
Driver: info.CgroupDriver,
|
|
||||||
Version: info.CgroupVersion,
|
|
||||||
},
|
|
||||||
Containers: DockerContainers{
|
|
||||||
Total: info.Containers,
|
|
||||||
Running: info.ContainersRunning,
|
|
||||||
Paused: info.ContainersPaused,
|
|
||||||
Stopped: info.ContainersStopped,
|
|
||||||
},
|
|
||||||
Storage: DockerStorage{
|
|
||||||
Driver: info.Driver,
|
|
||||||
Filesystem: filesystem,
|
|
||||||
},
|
|
||||||
Runc: DockerRunc{
|
|
||||||
Version: info.RuncCommit.ID,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
System: System{
|
|
||||||
Architecture: runtime.GOARCH,
|
|
||||||
CPUThreads: runtime.NumCPU(),
|
|
||||||
MemoryBytes: info.MemTotal,
|
|
||||||
KernelVersion: k.String(),
|
|
||||||
OS: os,
|
|
||||||
OSType: runtime.GOOS,
|
|
||||||
},
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func GetDockerInfo(ctx context.Context) (types.Version, types.Info, error) {
|
|
||||||
// TODO: find a way to re-use the client from the docker environment.
|
|
||||||
c, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())
|
|
||||||
if err != nil {
|
|
||||||
return types.Version{}, types.Info{}, err
|
|
||||||
}
|
|
||||||
defer c.Close()
|
|
||||||
|
|
||||||
dockerVersion, err := c.ServerVersion(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return types.Version{}, types.Info{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
dockerInfo, err := c.Info(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return types.Version{}, types.Info{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return dockerVersion, dockerInfo, nil
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -120,7 +120,7 @@ func ScanReader(r io.Reader, callback func(line []byte)) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func FormatBytes[T int | int16 | int32 | int64 | uint | uint16 | uint32 | uint64](b T) string {
|
func FormatBytes(b int64) string {
|
||||||
if b < 1024 {
|
if b < 1024 {
|
||||||
return fmt.Sprintf("%d B", b)
|
return fmt.Sprintf("%d B", b)
|
||||||
}
|
}
|
||||||
@@ -188,14 +188,14 @@ func NewAtomicString(v string) *AtomicString {
|
|||||||
return &AtomicString{v: v}
|
return &AtomicString{v: v}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Store stores the string value passed atomically.
|
// Stores the string value passed atomically.
|
||||||
func (as *AtomicString) Store(v string) {
|
func (as *AtomicString) Store(v string) {
|
||||||
as.mu.Lock()
|
as.mu.Lock()
|
||||||
as.v = v
|
as.v = v
|
||||||
as.mu.Unlock()
|
as.mu.Unlock()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Load loads the string value and returns it.
|
// Loads the string value and returns it.
|
||||||
func (as *AtomicString) Load() string {
|
func (as *AtomicString) Load() string {
|
||||||
as.mu.RLock()
|
as.mu.RLock()
|
||||||
defer as.mu.RUnlock()
|
defer as.mu.RUnlock()
|
||||||
@@ -211,41 +211,3 @@ func (as *AtomicString) UnmarshalJSON(b []byte) error {
|
|||||||
func (as *AtomicString) MarshalJSON() ([]byte, error) {
|
func (as *AtomicString) MarshalJSON() ([]byte, error) {
|
||||||
return json.Marshal(as.Load())
|
return json.Marshal(as.Load())
|
||||||
}
|
}
|
||||||
|
|
||||||
type Atomic[T any] struct {
|
|
||||||
v T
|
|
||||||
mu sync.RWMutex
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewAtomic[T any](v T) *Atomic[T] {
|
|
||||||
return &Atomic[T]{v: v}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store stores the string value passed atomically.
|
|
||||||
func (a *Atomic[T]) Store(v T) {
|
|
||||||
a.mu.Lock()
|
|
||||||
defer a.mu.Unlock()
|
|
||||||
|
|
||||||
a.v = v
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load loads the string value and returns it.
|
|
||||||
func (a *Atomic[T]) Load() T {
|
|
||||||
a.mu.RLock()
|
|
||||||
defer a.mu.RUnlock()
|
|
||||||
|
|
||||||
return a.v
|
|
||||||
}
|
|
||||||
|
|
||||||
// UnmarshalJSON unmarshals the JSON value into the Atomic[T] value.
|
|
||||||
func (a *Atomic[T]) UnmarshalJSON(b []byte) error {
|
|
||||||
a.mu.Lock()
|
|
||||||
defer a.mu.Unlock()
|
|
||||||
|
|
||||||
return json.Unmarshal(b, &a.v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// MarshalJSON marshals the Atomic[T] value into JSON.
|
|
||||||
func (a *Atomic[T]) MarshalJSON() ([]byte, error) {
|
|
||||||
return json.Marshal(a.Load())
|
|
||||||
}
|
|
||||||
|
|||||||
Reference in New Issue
Block a user