Skip to content

PostgreSQL backup tool with Point-In-Time-Recovery and restore verification

FEATURE (storages): Add SFTP

Rostislav Dugineb8e5aa42831
diff --git a/.github/workflows/ci-release.yml b/.github/workflows/ci-release.yml
index 6f0d8dd0..b662a903 100644
--- a/.github/workflows/ci-release.yml
+++ b/.github/workflows/ci-release.yml
@@ -165,6 +165,10 @@ jobs:
TEST_AZURITE_BLOB_PORT=10000
# testing NAS
TEST_NAS_PORT=7006
+ # testing FTP
+ TEST_FTP_PORT=7007
+ # testing SFTP
+ TEST_SFTP_PORT=7008
# testing Telegram
TEST_TELEGRAM_BOT_TOKEN=${{ secrets.TEST_TELEGRAM_BOT_TOKEN }}
TEST_TELEGRAM_CHAT_ID=${{ secrets.TEST_TELEGRAM_CHAT_ID }}
@@ -200,6 +204,12 @@ jobs:
# Wait for Azurite
timeout 60 bash -c 'until nc -z localhost 10000; do sleep 2; done'
+ # Wait for FTP
+ timeout 60 bash -c 'until nc -z localhost 7007; do sleep 2; done'
+
+ # Wait for SFTP
+ timeout 60 bash -c 'until nc -z localhost 7008; do sleep 2; done'
+
- name: Create data and temp directories
run: |
# Create directories that are used for backups and restore
diff --git a/backend/.cursor/rules/refactor.mdc b/backend/.cursor/rules/refactor.mdc
index 1c2aeb5a..a6dee2c7 100644
--- a/backend/.cursor/rules/refactor.mdc
+++ b/backend/.cursor/rules/refactor.mdc
@@ -9,4 +9,4 @@ When applying changes, do not forget to refactor old code.
You can shortify, make more readable, improve code quality, etc.
Common logic can be extracted to functions, constants, files, etc.
-After each large change with more than ~50-100 lines of code - always run `make lint` (from backend root folder).
\ No newline at end of file
+After each large change with more than ~50-100 lines of code - always run `make lint` (from backend root folder) and, if you change frontend, run `npm run format` (from frontend root folder).
diff --git a/backend/.env.development.example b/backend/.env.development.example
index b4422359..2672d9e9 100644
--- a/backend/.env.development.example
+++ b/backend/.env.development.example
@@ -41,4 +41,6 @@ TEST_SUPABASE_USERNAME=
TEST_SUPABASE_PASSWORD=
TEST_SUPABASE_DATABASE=
# FTP
-TEST_FTP_PORT=7007
\ No newline at end of file
+TEST_FTP_PORT=7007
+# SFTP
+TEST_SFTP_PORT=7008
\ No newline at end of file
diff --git a/backend/docker-compose.yml.example b/backend/docker-compose.yml.example
index a6cfed64..7e01fc77 100644
--- a/backend/docker-compose.yml.example
+++ b/backend/docker-compose.yml.example
@@ -146,3 +146,11 @@ services:
- FTP_USER_HOME=/home/ftpusers/testuser
- FTP_PASSIVE_PORTS=30000:30009
container_name: test-ftp
+
+ # Test SFTP server
+ test-sftp:
+ image: atmoz/sftp:latest
+ ports:
+ - "${TEST_SFTP_PORT:-7008}:22"
+ command: testuser:testpassword:1001::upload
+ container_name: test-sftp
diff --git a/backend/go.mod b/backend/go.mod
index 14a0ed04..a82ef508 100644
--- a/backend/go.mod
+++ b/backend/go.mod
@@ -17,13 +17,14 @@ require (
github.com/joho/godotenv v1.5.1
github.com/lib/pq v1.10.9
github.com/minio/minio-go/v7 v7.0.97
+ github.com/pkg/sftp v1.13.10
github.com/rclone/rclone v1.72.1
github.com/shirou/gopsutil/v4 v4.25.10
github.com/stretchr/testify v1.11.1
github.com/swaggo/files v1.0.1
github.com/swaggo/gin-swagger v1.6.0
github.com/swaggo/swag v1.16.4
- golang.org/x/crypto v0.45.0
+ golang.org/x/crypto v0.46.0
golang.org/x/time v0.14.0
gorm.io/driver/postgres v1.5.11
gorm.io/gorm v1.26.1
@@ -145,7 +146,6 @@ require (
github.com/pierrec/lz4/v4 v4.1.22 // indirect
github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect
github.com/pkg/errors v0.9.1 // indirect
- github.com/pkg/sftp v1.13.10 // indirect
github.com/pkg/xattr v0.4.12 // indirect
github.com/pquerna/otp v1.5.0 // indirect
github.com/prometheus/client_golang v1.23.2 // indirect
@@ -177,7 +177,7 @@ require (
go.mongodb.org/mongo-driver v1.17.6 // indirect
go.yaml.in/yaml/v2 v2.4.3 // indirect
golang.org/x/exp v0.0.0-20251023183803-a4bb9ffd2546 // indirect
- golang.org/x/term v0.37.0 // indirect
+ golang.org/x/term v0.38.0 // indirect
gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
gopkg.in/validator.v2 v2.0.1 // indirect
moul.io/http2curl/v2 v2.3.0 // indirect
@@ -264,10 +264,10 @@ require (
golang.org/x/arch v0.17.0 // indirect
golang.org/x/net v0.47.0 // indirect
golang.org/x/oauth2 v0.33.0
- golang.org/x/sync v0.18.0 // indirect
- golang.org/x/sys v0.38.0 // indirect
- golang.org/x/text v0.31.0 // indirect
- golang.org/x/tools v0.38.0 // indirect
+ golang.org/x/sync v0.19.0 // indirect
+ golang.org/x/sys v0.39.0 // indirect
+ golang.org/x/text v0.32.0 // indirect
+ golang.org/x/tools v0.39.0 // indirect
google.golang.org/api v0.255.0
google.golang.org/protobuf v1.36.10 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
diff --git a/backend/go.sum b/backend/go.sum
index 07a97c41..31817834 100644
--- a/backend/go.sum
+++ b/backend/go.sum
@@ -725,8 +725,8 @@ golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliY
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
-golang.org/x/crypto v0.45.0 h1:jMBrvKuj23MTlT0bQEOBcAE0mjg8mK9RXFhRH6nyF3Q=
-golang.org/x/crypto v0.45.0/go.mod h1:XTGrrkGJve7CYK7J8PEww4aY7gM3qMCElcJQ8n8JdX4=
+golang.org/x/crypto v0.46.0 h1:cKRW/pmt1pKAfetfu+RCEvjvZkA9RimPbh7bhFjGVBU=
+golang.org/x/crypto v0.46.0/go.mod h1:Evb/oLKmMraqjZ2iQTwDwvCtJkczlDuTmdJXoZVzqU0=
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8=
@@ -765,8 +765,8 @@ golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
-golang.org/x/mod v0.29.0 h1:HV8lRxZC4l2cr3Zq1LvtOsi/ThTgWnUk/y64QSs8GwA=
-golang.org/x/mod v0.29.0/go.mod h1:NyhrlYXJ2H4eJiRy/WDBO6HMqZQ6q9nk4JzS3NuCK+w=
+golang.org/x/mod v0.30.0 h1:fDEXFVZ/fmCKProc/yAXXUijritrDzahmwwefnjoPFk=
+golang.org/x/mod v0.30.0/go.mod h1:lAsf5O2EvJeSFMiBxXDki7sCgAxEUcZHXoXMKT4GJKc=
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
@@ -831,8 +831,8 @@ golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
-golang.org/x/sync v0.18.0 h1:kr88TuHDroi+UVf+0hZnirlk8o8T+4MrK6mr60WkH/I=
-golang.org/x/sync v0.18.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
+golang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4=
+golang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
@@ -882,8 +882,8 @@ golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc=
-golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
+golang.org/x/sys v0.39.0 h1:CvCKL8MeisomCi6qNZ+wbb0DN9E5AATixKsvNtMoMFk=
+golang.org/x/sys v0.39.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
@@ -894,8 +894,8 @@ golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU=
golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY=
golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM=
-golang.org/x/term v0.37.0 h1:8EGAD0qCmHYZg6J17DvsMy9/wJ7/D/4pV/wfnld5lTU=
-golang.org/x/term v0.37.0/go.mod h1:5pB4lxRNYYVZuTLmy8oR2BH8dflOR+IbTYFD8fi3254=
+golang.org/x/term v0.38.0 h1:PQ5pkm/rLO6HnxFR7N2lJHOZX6Kez5Y1gDSJla6jo7Q=
+golang.org/x/term v0.38.0/go.mod h1:bSEAKrOT1W+VSu9TSCMtoGEOUcKxOKgl3LE5QEF/xVg=
golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
@@ -910,8 +910,8 @@ golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
-golang.org/x/text v0.31.0 h1:aC8ghyu4JhP8VojJ2lEHBnochRno1sgL6nEi9WGFGMM=
-golang.org/x/text v0.31.0/go.mod h1:tKRAlv61yKIjGGHX/4tP1LTbc13YSec1pxVEWXzfoeM=
+golang.org/x/text v0.32.0 h1:ZD01bjUt1FQ9WJ0ClOL5vxgxOI/sVCNgX1YtKwcY0mU=
+golang.org/x/text v0.32.0/go.mod h1:o/rUWzghvpD5TXrTIBuJU77MTaN0ljMWE47kxGJQ7jY=
golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
@@ -964,8 +964,8 @@ golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
-golang.org/x/tools v0.38.0 h1:Hx2Xv8hISq8Lm16jvBZ2VQf+RLmbd7wVUsALibYI/IQ=
-golang.org/x/tools v0.38.0/go.mod h1:yEsQ/d/YK8cjh0L6rZlY8tgtlKiBNTL14pGDJPJpYQs=
+golang.org/x/tools v0.39.0 h1:ik4ho21kwuQln40uelmciQPp9SipgNDdrafrYA4TmQQ=
+golang.org/x/tools v0.39.0/go.mod h1:JnefbkDPyD8UU2kI5fuf8ZX4/yUeh9W877ZeBONxUqQ=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
diff --git a/backend/internal/config/config.go b/backend/internal/config/config.go
index 1cad04d7..789bd493 100644
--- a/backend/internal/config/config.go
+++ b/backend/internal/config/config.go
@@ -47,8 +47,9 @@ type EnvVariables struct {
TestAzuriteBlobPort string `env:"TEST_AZURITE_BLOB_PORT"`
- TestNASPort string `env:"TEST_NAS_PORT"`
- TestFTPPort string `env:"TEST_FTP_PORT"`
+ TestNASPort string `env:"TEST_NAS_PORT"`
+ TestFTPPort string `env:"TEST_FTP_PORT"`
+ TestSFTPPort string `env:"TEST_SFTP_PORT"`
// oauth
GitHubClientID string `env:"GITHUB_CLIENT_ID"`
diff --git a/backend/internal/features/storages/controller_test.go b/backend/internal/features/storages/controller_test.go
index 672f5e29..a96cccb1 100644
--- a/backend/internal/features/storages/controller_test.go
+++ b/backend/internal/features/storages/controller_test.go
@@ -14,6 +14,7 @@ import (
nas_storage "postgresus-backend/internal/features/storages/models/nas"
rclone_storage "postgresus-backend/internal/features/storages/models/rclone"
s3_storage "postgresus-backend/internal/features/storages/models/s3"
+ sftp_storage "postgresus-backend/internal/features/storages/models/sftp"
users_enums "postgresus-backend/internal/features/users/enums"
users_middleware "postgresus-backend/internal/features/users/middleware"
users_services "postgresus-backend/internal/features/users/services"
@@ -787,6 +788,62 @@ func Test_StorageSensitiveDataLifecycle_AllTypes(t *testing.T) {
assert.Equal(t, "", storage.FTPStorage.Password)
},
},
+ {
+ name: "SFTP Storage",
+ storageType: StorageTypeSFTP,
+ createStorage: func(workspaceID uuid.UUID) *Storage {
+ return &Storage{
+ WorkspaceID: workspaceID,
+ Type: StorageTypeSFTP,
+ Name: "Test SFTP Storage",
+ SFTPStorage: &sftp_storage.SFTPStorage{
+ Host: "sftp.example.com",
+ Port: 22,
+ Username: "testuser",
+ Password: "original-password",
+ PrivateKey: "original-private-key",
+ SkipHostKeyVerify: false,
+ Path: "/backups",
+ },
+ }
+ },
+ updateStorage: func(workspaceID uuid.UUID, storageID uuid.UUID) *Storage {
+ return &Storage{
+ ID: storageID,
+ WorkspaceID: workspaceID,
+ Type: StorageTypeSFTP,
+ Name: "Updated SFTP Storage",
+ SFTPStorage: &sftp_storage.SFTPStorage{
+ Host: "sftp2.example.com",
+ Port: 2222,
+ Username: "testuser2",
+ Password: "",
+ PrivateKey: "",
+ SkipHostKeyVerify: true,
+ Path: "/backups2",
+ },
+ }
+ },
+ verifySensitiveData: func(t *testing.T, storage *Storage) {
+ assert.True(t, strings.HasPrefix(storage.SFTPStorage.Password, "enc:"),
+ "Password should be encrypted with 'enc:' prefix")
+ assert.True(t, strings.HasPrefix(storage.SFTPStorage.PrivateKey, "enc:"),
+ "PrivateKey should be encrypted with 'enc:' prefix")
+
+ encryptor := encryption.GetFieldEncryptor()
+ password, err := encryptor.Decrypt(storage.ID, storage.SFTPStorage.Password)
+ assert.NoError(t, err)
+ assert.Equal(t, "original-password", password)
+
+ privateKey, err := encryptor.Decrypt(storage.ID, storage.SFTPStorage.PrivateKey)
+ assert.NoError(t, err)
+ assert.Equal(t, "original-private-key", privateKey)
+ },
+ verifyHiddenData: func(t *testing.T, storage *Storage) {
+ assert.Equal(t, "", storage.SFTPStorage.Password)
+ assert.Equal(t, "", storage.SFTPStorage.PrivateKey)
+ },
+ },
{
name: "Rclone Storage",
storageType: StorageTypeRclone,
diff --git a/backend/internal/features/storages/enums.go b/backend/internal/features/storages/enums.go
index cf26d48b..d5f6cb3f 100644
--- a/backend/internal/features/storages/enums.go
+++ b/backend/internal/features/storages/enums.go
@@ -9,5 +9,6 @@ const (
StorageTypeNAS StorageType = "NAS"
StorageTypeAzureBlob StorageType = "AZURE_BLOB"
StorageTypeFTP StorageType = "FTP"
+ StorageTypeSFTP StorageType = "SFTP"
StorageTypeRclone StorageType = "RCLONE"
)
diff --git a/backend/internal/features/storages/model.go b/backend/internal/features/storages/model.go
index 1a182825..99a3a15c 100644
--- a/backend/internal/features/storages/model.go
+++ b/backend/internal/features/storages/model.go
@@ -12,6 +12,7 @@ import (
nas_storage "postgresus-backend/internal/features/storages/models/nas"
rclone_storage "postgresus-backend/internal/features/storages/models/rclone"
s3_storage "postgresus-backend/internal/features/storages/models/s3"
+ sftp_storage "postgresus-backend/internal/features/storages/models/sftp"
"postgresus-backend/internal/util/encryption"
"github.com/google/uuid"
@@ -31,6 +32,7 @@ type Storage struct {
NASStorage *nas_storage.NASStorage `json:"nasStorage" gorm:"foreignKey:StorageID"`
AzureBlobStorage *azure_blob_storage.AzureBlobStorage `json:"azureBlobStorage" gorm:"foreignKey:StorageID"`
FTPStorage *ftp_storage.FTPStorage `json:"ftpStorage" gorm:"foreignKey:StorageID"`
+ SFTPStorage *sftp_storage.SFTPStorage `json:"sftpStorage" gorm:"foreignKey:StorageID"`
RcloneStorage *rclone_storage.RcloneStorage `json:"rcloneStorage" gorm:"foreignKey:StorageID"`
}
@@ -117,6 +119,10 @@ func (s *Storage) Update(incoming *Storage) {
if s.FTPStorage != nil && incoming.FTPStorage != nil {
s.FTPStorage.Update(incoming.FTPStorage)
}
+ case StorageTypeSFTP:
+ if s.SFTPStorage != nil && incoming.SFTPStorage != nil {
+ s.SFTPStorage.Update(incoming.SFTPStorage)
+ }
case StorageTypeRclone:
if s.RcloneStorage != nil && incoming.RcloneStorage != nil {
s.RcloneStorage.Update(incoming.RcloneStorage)
@@ -138,6 +144,8 @@ func (s *Storage) getSpecificStorage() StorageFileSaver {
return s.AzureBlobStorage
case StorageTypeFTP:
return s.FTPStorage
+ case StorageTypeSFTP:
+ return s.SFTPStorage
case StorageTypeRclone:
return s.RcloneStorage
default:
diff --git a/backend/internal/features/storages/model_test.go b/backend/internal/features/storages/model_test.go
index 77d54de1..7a5999bd 100644
--- a/backend/internal/features/storages/model_test.go
+++ b/backend/internal/features/storages/model_test.go
@@ -15,6 +15,7 @@ import (
nas_storage "postgresus-backend/internal/features/storages/models/nas"
rclone_storage "postgresus-backend/internal/features/storages/models/rclone"
s3_storage "postgresus-backend/internal/features/storages/models/s3"
+ sftp_storage "postgresus-backend/internal/features/storages/models/sftp"
"postgresus-backend/internal/util/encryption"
"postgresus-backend/internal/util/logger"
"strconv"
@@ -80,6 +81,14 @@ func Test_Storage_BasicOperations(t *testing.T) {
}
}
+ // Setup SFTP port
+ sftpPort := 22
+ if portStr := config.GetEnv().TestSFTPPort; portStr != "" {
+ if port, err := strconv.Atoi(portStr); err == nil {
+ sftpPort = port
+ }
+ }
+
// Run tests
testCases := []struct {
name string
@@ -146,6 +155,18 @@ func Test_Storage_BasicOperations(t *testing.T) {
Path: "test-files",
},
},
+ {
+ name: "SFTPStorage",
+ storage: &sftp_storage.SFTPStorage{
+ StorageID: uuid.New(),
+ Host: "localhost",
+ Port: sftpPort,
+ Username: "testuser",
+ Password: "testpassword",
+ SkipHostKeyVerify: true,
+ Path: "upload",
+ },
+ },
{
name: "RcloneStorage",
storage: &rclone_storage.RcloneStorage{
diff --git a/backend/internal/features/storages/models/sftp/model.go b/backend/internal/features/storages/models/sftp/model.go
new file mode 100644
index 00000000..97a91c82
--- /dev/null
+++ b/backend/internal/features/storages/models/sftp/model.go
@@ -0,0 +1,430 @@
+package sftp_storage
+
+import (
+ "context"
+ "errors"
+ "fmt"
+ "io"
+ "log/slog"
+ "net"
+ "postgresus-backend/internal/util/encryption"
+ "strings"
+ "time"
+
+ "github.com/google/uuid"
+ "github.com/pkg/sftp"
+ "golang.org/x/crypto/ssh"
+)
+
+const (
+ sftpConnectTimeout = 30 * time.Second
+ sftpTestConnectTimeout = 10 * time.Second
+)
+
+type SFTPStorage struct {
+ StorageID uuid.UUID `json:"storageId" gorm:"primaryKey;type:uuid;column:storage_id"`
+ Host string `json:"host" gorm:"not null;type:text;column:host"`
+ Port int `json:"port" gorm:"not null;default:22;column:port"`
+ Username string `json:"username" gorm:"not null;type:text;column:username"`
+ Password string `json:"password" gorm:"type:text;column:password"`
+ PrivateKey string `json:"privateKey" gorm:"type:text;column:private_key"`
+ Path string `json:"path" gorm:"type:text;column:path"`
+ SkipHostKeyVerify bool `json:"skipHostKeyVerify" gorm:"not null;default:false;column:skip_host_key_verify"`
+}
+
+func (s *SFTPStorage) TableName() string {
+ return "sftp_storages"
+}
+
+func (s *SFTPStorage) SaveFile(
+ ctx context.Context,
+ encryptor encryption.FieldEncryptor,
+ logger *slog.Logger,
+ fileID uuid.UUID,
+ file io.Reader,
+) error {
+ select {
+ case <-ctx.Done():
+ return ctx.Err()
+ default:
+ }
+
+ logger.Info("Starting to save file to SFTP storage", "fileId", fileID.String(), "host", s.Host)
+
+ client, sshConn, err := s.connect(encryptor, sftpConnectTimeout)
+ if err != nil {
+ logger.Error("Failed to connect to SFTP", "fileId", fileID.String(), "error", err)
+ return fmt.Errorf("failed to connect to SFTP: %w", err)
+ }
+ defer func() {
+ if closeErr := client.Close(); closeErr != nil {
+ logger.Error(
+ "Failed to close SFTP client",
+ "fileId",
+ fileID.String(),
+ "error",
+ closeErr,
+ )
+ }
+ if closeErr := sshConn.Close(); closeErr != nil {
+ logger.Error(
+ "Failed to close SSH connection",
+ "fileId",
+ fileID.String(),
+ "error",
+ closeErr,
+ )
+ }
+ }()
+
+ if s.Path != "" {
+ if err := s.ensureDirectory(client, s.Path); err != nil {
+ logger.Error(
+ "Failed to ensure directory",
+ "fileId",
+ fileID.String(),
+ "path",
+ s.Path,
+ "error",
+ err,
+ )
+ return fmt.Errorf("failed to ensure directory: %w", err)
+ }
+ }
+
+ filePath := s.getFilePath(fileID.String())
+ logger.Debug("Uploading file to SFTP", "fileId", fileID.String(), "filePath", filePath)
+
+ remoteFile, err := client.Create(filePath)
+ if err != nil {
+ logger.Error("Failed to create remote file", "fileId", fileID.String(), "error", err)
+ return fmt.Errorf("failed to create remote file: %w", err)
+ }
+ defer func() {
+ _ = remoteFile.Close()
+ }()
+
+ ctxReader := &contextReader{ctx: ctx, reader: file}
+
+ _, err = io.Copy(remoteFile, ctxReader)
+ if err != nil {
+ select {
+ case <-ctx.Done():
+ logger.Info("SFTP upload cancelled", "fileId", fileID.String())
+ return ctx.Err()
+ default:
+ logger.Error("Failed to upload file to SFTP", "fileId", fileID.String(), "error", err)
+ return fmt.Errorf("failed to upload file to SFTP: %w", err)
+ }
+ }
+
+ logger.Info(
+ "Successfully saved file to SFTP storage",
+ "fileId",
+ fileID.String(),
+ "filePath",
+ filePath,
+ )
+ return nil
+}
+
+func (s *SFTPStorage) GetFile(
+ encryptor encryption.FieldEncryptor,
+ fileID uuid.UUID,
+) (io.ReadCloser, error) {
+ client, sshConn, err := s.connect(encryptor, sftpConnectTimeout)
+ if err != nil {
+ return nil, fmt.Errorf("failed to connect to SFTP: %w", err)
+ }
+
+ filePath := s.getFilePath(fileID.String())
+
+ remoteFile, err := client.Open(filePath)
+ if err != nil {
+ _ = client.Close()
+ _ = sshConn.Close()
+ return nil, fmt.Errorf("failed to open file from SFTP: %w", err)
+ }
+
+ return &sftpFileReader{
+ file: remoteFile,
+ client: client,
+ sshConn: sshConn,
+ }, nil
+}
+
+func (s *SFTPStorage) DeleteFile(encryptor encryption.FieldEncryptor, fileID uuid.UUID) error {
+ client, sshConn, err := s.connect(encryptor, sftpConnectTimeout)
+ if err != nil {
+ return fmt.Errorf("failed to connect to SFTP: %w", err)
+ }
+ defer func() {
+ _ = client.Close()
+ _ = sshConn.Close()
+ }()
+
+ filePath := s.getFilePath(fileID.String())
+
+ _, err = client.Stat(filePath)
+ if err != nil {
+ return nil
+ }
+
+ err = client.Remove(filePath)
+ if err != nil {
+ return fmt.Errorf("failed to delete file from SFTP: %w", err)
+ }
+
+ return nil
+}
+
+func (s *SFTPStorage) Validate(encryptor encryption.FieldEncryptor) error {
+ if s.Host == "" {
+ return errors.New("SFTP host is required")
+ }
+ if s.Username == "" {
+ return errors.New("SFTP username is required")
+ }
+ if s.Password == "" && s.PrivateKey == "" {
+ return errors.New("SFTP password or private key is required")
+ }
+ if s.Port <= 0 || s.Port > 65535 {
+ return errors.New("SFTP port must be between 1 and 65535")
+ }
+
+ return nil
+}
+
+func (s *SFTPStorage) TestConnection(encryptor encryption.FieldEncryptor) error {
+ ctx, cancel := context.WithTimeout(context.Background(), sftpTestConnectTimeout)
+ defer cancel()
+
+ client, sshConn, err := s.connectWithContext(ctx, encryptor, sftpTestConnectTimeout)
+ if err != nil {
+ return fmt.Errorf("failed to connect to SFTP: %w", err)
+ }
+ defer func() {
+ _ = client.Close()
+ _ = sshConn.Close()
+ }()
+
+ if s.Path != "" {
+ if err := s.ensureDirectory(client, s.Path); err != nil {
+ return fmt.Errorf("failed to access or create path '%s': %w", s.Path, err)
+ }
+ }
+
+ return nil
+}
+
+func (s *SFTPStorage) HideSensitiveData() {
+ s.Password = ""
+ s.PrivateKey = ""
+}
+
+func (s *SFTPStorage) EncryptSensitiveData(encryptor encryption.FieldEncryptor) error {
+ if s.Password != "" {
+ encrypted, err := encryptor.Encrypt(s.StorageID, s.Password)
+ if err != nil {
+ return fmt.Errorf("failed to encrypt SFTP password: %w", err)
+ }
+ s.Password = encrypted
+ }
+
+ if s.PrivateKey != "" {
+ encrypted, err := encryptor.Encrypt(s.StorageID, s.PrivateKey)
+ if err != nil {
+ return fmt.Errorf("failed to encrypt SFTP private key: %w", err)
+ }
+ s.PrivateKey = encrypted
+ }
+
+ return nil
+}
+
+func (s *SFTPStorage) Update(incoming *SFTPStorage) {
+ s.Host = incoming.Host
+ s.Port = incoming.Port
+ s.Username = incoming.Username
+ s.SkipHostKeyVerify = incoming.SkipHostKeyVerify
+ s.Path = incoming.Path
+
+ if incoming.Password != "" {
+ s.Password = incoming.Password
+ }
+
+ if incoming.PrivateKey != "" {
+ s.PrivateKey = incoming.PrivateKey
+ }
+}
+
+func (s *SFTPStorage) connect(
+ encryptor encryption.FieldEncryptor,
+ timeout time.Duration,
+) (*sftp.Client, *ssh.Client, error) {
+ return s.connectWithContext(context.Background(), encryptor, timeout)
+}
+
+func (s *SFTPStorage) connectWithContext(
+ ctx context.Context,
+ encryptor encryption.FieldEncryptor,
+ timeout time.Duration,
+) (*sftp.Client, *ssh.Client, error) {
+ var authMethods []ssh.AuthMethod
+
+ if s.Password != "" {
+ password, err := encryptor.Decrypt(s.StorageID, s.Password)
+ if err != nil {
+ return nil, nil, fmt.Errorf("failed to decrypt SFTP password: %w", err)
+ }
+ authMethods = append(authMethods, ssh.Password(password))
+ }
+
+ if s.PrivateKey != "" {
+ privateKey, err := encryptor.Decrypt(s.StorageID, s.PrivateKey)
+ if err != nil {
+ return nil, nil, fmt.Errorf("failed to decrypt SFTP private key: %w", err)
+ }
+
+ signer, err := ssh.ParsePrivateKey([]byte(privateKey))
+ if err != nil {
+ return nil, nil, fmt.Errorf("failed to parse private key: %w", err)
+ }
+ authMethods = append(authMethods, ssh.PublicKeys(signer))
+ }
+
+ var hostKeyCallback ssh.HostKeyCallback
+ if s.SkipHostKeyVerify {
+ hostKeyCallback = ssh.InsecureIgnoreHostKey()
+ } else {
+ hostKeyCallback = ssh.InsecureIgnoreHostKey()
+ }
+
+ config := &ssh.ClientConfig{
+ User: s.Username,
+ Auth: authMethods,
+ HostKeyCallback: hostKeyCallback,
+ Timeout: timeout,
+ }
+
+ address := fmt.Sprintf("%s:%d", s.Host, s.Port)
+
+ dialer := net.Dialer{Timeout: timeout}
+ conn, err := dialer.DialContext(ctx, "tcp", address)
+ if err != nil {
+ return nil, nil, fmt.Errorf("failed to dial SFTP server: %w", err)
+ }
+
+ sshConn, chans, reqs, err := ssh.NewClientConn(conn, address, config)
+ if err != nil {
+ _ = conn.Close()
+ return nil, nil, fmt.Errorf("failed to create SSH connection: %w", err)
+ }
+
+ sshClient := ssh.NewClient(sshConn, chans, reqs)
+
+ sftpClient, err := sftp.NewClient(sshClient)
+ if err != nil {
+ _ = sshClient.Close()
+ return nil, nil, fmt.Errorf("failed to create SFTP client: %w", err)
+ }
+
+ return sftpClient, sshClient, nil
+}
+
+func (s *SFTPStorage) ensureDirectory(client *sftp.Client, path string) error {
+ path = strings.TrimPrefix(path, "/")
+ path = strings.TrimSuffix(path, "/")
+
+ if path == "" {
+ return nil
+ }
+
+ parts := strings.Split(path, "/")
+ currentPath := ""
+
+ for _, part := range parts {
+ if part == "" || part == "." {
+ continue
+ }
+
+ if currentPath == "" {
+ currentPath = "/" + part
+ } else {
+ currentPath = currentPath + "/" + part
+ }
+
+ _, err := client.Stat(currentPath)
+ if err != nil {
+ err = client.Mkdir(currentPath)
+ if err != nil {
+ return fmt.Errorf("failed to create directory '%s': %w", currentPath, err)
+ }
+ }
+ }
+
+ return nil
+}
+
+func (s *SFTPStorage) getFilePath(filename string) string {
+ if s.Path == "" {
+ return filename
+ }
+
+ path := strings.TrimPrefix(s.Path, "/")
+ path = strings.TrimSuffix(path, "/")
+
+ return "/" + path + "/" + filename
+}
+
+type sftpFileReader struct {
+ file *sftp.File
+ client *sftp.Client
+ sshConn *ssh.Client
+}
+
+func (r *sftpFileReader) Read(p []byte) (n int, err error) {
+ return r.file.Read(p)
+}
+
+func (r *sftpFileReader) Close() error {
+ var errs []error
+
+ if r.file != nil {
+ if err := r.file.Close(); err != nil {
+ errs = append(errs, fmt.Errorf("failed to close file: %w", err))
+ }
+ }
+
+ if r.client != nil {
+ if err := r.client.Close(); err != nil {
+ errs = append(errs, fmt.Errorf("failed to close SFTP client: %w", err))
+ }
+ }
+
+ if r.sshConn != nil {
+ if err := r.sshConn.Close(); err != nil {
+ errs = append(errs, fmt.Errorf("failed to close SSH connection: %w", err))
+ }
+ }
+
+ if len(errs) > 0 {
+ return errs[0]
+ }
+
+ return nil
+}
+
+type contextReader struct {
+ ctx context.Context
+ reader io.Reader
+}
+
+func (r *contextReader) Read(p []byte) (n int, err error) {
+ select {
+ case <-r.ctx.Done():
+ return 0, r.ctx.Err()
+ default:
+ return r.reader.Read(p)
+ }
+}
diff --git a/backend/internal/features/storages/repository.go b/backend/internal/features/storages/repository.go
index 6bbf53f0..d37121fc 100644
--- a/backend/internal/features/storages/repository.go
+++ b/backend/internal/features/storages/repository.go
@@ -38,17 +38,25 @@ func (r *StorageRepository) Save(storage *Storage) (*Storage, error) {
if storage.FTPStorage != nil {
storage.FTPStorage.StorageID = storage.ID
}
+ case StorageTypeSFTP:
+ if storage.SFTPStorage != nil {
+ storage.SFTPStorage.StorageID = storage.ID
+ }
+ case StorageTypeRclone:
+ if storage.RcloneStorage != nil {
+ storage.RcloneStorage.StorageID = storage.ID
+ }
}
if storage.ID == uuid.Nil {
if err := tx.Create(storage).
- Omit("LocalStorage", "S3Storage", "GoogleDriveStorage", "NASStorage", "AzureBlobStorage", "FTPStorage").
+ Omit("LocalStorage", "S3Storage", "GoogleDriveStorage", "NASStorage", "AzureBlobStorage", "FTPStorage", "SFTPStorage", "RcloneStorage").
Error; err != nil {
return err
}
} else {
if err := tx.Save(storage).
- Omit("LocalStorage", "S3Storage", "GoogleDriveStorage", "NASStorage", "AzureBlobStorage", "FTPStorage").
+ Omit("LocalStorage", "S3Storage", "GoogleDriveStorage", "NASStorage", "AzureBlobStorage", "FTPStorage", "SFTPStorage", "RcloneStorage").
Error; err != nil {
return err
}
@@ -97,6 +105,20 @@ func (r *StorageRepository) Save(storage *Storage) (*Storage, error) {
return err
}
}
+ case StorageTypeSFTP:
+ if storage.SFTPStorage != nil {
+ storage.SFTPStorage.StorageID = storage.ID // Ensure ID is set
+ if err := tx.Save(storage.SFTPStorage).Error; err != nil {
+ return err
+ }
+ }
+ case StorageTypeRclone:
+ if storage.RcloneStorage != nil {
+ storage.RcloneStorage.StorageID = storage.ID // Ensure ID is set
+ if err := tx.Save(storage.RcloneStorage).Error; err != nil {
+ return err
+ }
+ }
}
return nil
@@ -120,6 +142,7 @@ func (r *StorageRepository) FindByID(id uuid.UUID) (*Storage, error) {
Preload("NASStorage").
Preload("AzureBlobStorage").
Preload("FTPStorage").
+ Preload("SFTPStorage").
Preload("RcloneStorage").
Where("id = ?", id).
First(&s).Error; err != nil {
@@ -140,6 +163,7 @@ func (r *StorageRepository) FindByWorkspaceID(workspaceID uuid.UUID) ([]*Storage
Preload("NASStorage").
Preload("AzureBlobStorage").
Preload("FTPStorage").
+ Preload("SFTPStorage").
Preload("RcloneStorage").
Where("workspace_id = ?", workspaceID).
Order("name ASC").
@@ -190,6 +214,18 @@ func (r *StorageRepository) Delete(s *Storage) error {
return err
}
}
+ case StorageTypeSFTP:
+ if s.SFTPStorage != nil {
+ if err := tx.Delete(s.SFTPStorage).Error; err != nil {
+ return err
+ }
+ }
+ case StorageTypeRclone:
+ if s.RcloneStorage != nil {
+ if err := tx.Delete(s.RcloneStorage).Error; err != nil {
+ return err
+ }
+ }
}
// Delete the main storage
diff --git a/backend/migrations/20251219220027_add_sftp_storages.sql b/backend/migrations/20251219220027_add_sftp_storages.sql
new file mode 100644
index 00000000..45e8183b
--- /dev/null
+++ b/backend/migrations/20251219220027_add_sftp_storages.sql
@@ -0,0 +1,28 @@
+-- +goose Up
+-- +goose StatementBegin
+
+CREATE TABLE sftp_storages (
+ storage_id UUID PRIMARY KEY,
+ host TEXT NOT NULL,
+ port INTEGER NOT NULL DEFAULT 22,
+ username TEXT NOT NULL,
+ password TEXT,
+ private_key TEXT,
+ path TEXT,
+ skip_host_key_verify BOOLEAN NOT NULL DEFAULT FALSE
+);
+
+ALTER TABLE sftp_storages
+ ADD CONSTRAINT fk_sftp_storages_storage
+ FOREIGN KEY (storage_id)
+ REFERENCES storages (id)
+ ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED;
+
+-- +goose StatementEnd
+
+-- +goose Down
+-- +goose StatementBegin
+
+DROP TABLE IF EXISTS sftp_storages;
+
+-- +goose StatementEnd
diff --git a/frontend/public/icons/storages/sftp.svg b/frontend/public/icons/storages/sftp.svg
new file mode 100644
index 00000000..e56d6d49
--- /dev/null
+++ b/frontend/public/icons/storages/sftp.svg
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Uploaded to: SVG Repo, www.svgrepo.com, Generator: SVG Repo Mixer Tools -->
+<svg width="800px" height="800px" viewBox="0 0 1024 1024" class="icon" version="1.1" xmlns="http://www.w3.org/2000/svg"><path d="M853.333333 256H469.333333l-85.333333-85.333333H170.666667c-46.933333 0-85.333333 38.4-85.333334 85.333333v170.666667h853.333334v-85.333334c0-46.933333-38.4-85.333333-85.333334-85.333333z" fill="#FFA000" /><path d="M853.333333 256H170.666667c-46.933333 0-85.333333 38.4-85.333334 85.333333v426.666667c0 46.933333 38.4 85.333333 85.333334 85.333333h682.666666c46.933333 0 85.333333-38.4 85.333334-85.333333V341.333333c0-46.933333-38.4-85.333333-85.333334-85.333333z" fill="#FFCA28" /></svg>
\ No newline at end of file
diff --git a/frontend/src/entity/storages/index.ts b/frontend/src/entity/storages/index.ts
index d0c5abbd..2132463e 100644
--- a/frontend/src/entity/storages/index.ts
+++ b/frontend/src/entity/storages/index.ts
@@ -9,4 +9,5 @@ export { getStorageNameFromType } from './models/getStorageNameFromType';
export { type GoogleDriveStorage } from './models/GoogleDriveStorage';
export { type AzureBlobStorage } from './models/AzureBlobStorage';
export { type FTPStorage } from './models/FTPStorage';
+export { type SFTPStorage } from './models/SFTPStorage';
export { type RcloneStorage } from './models/RcloneStorage';
diff --git a/frontend/src/entity/storages/models/SFTPStorage.ts b/frontend/src/entity/storages/models/SFTPStorage.ts
new file mode 100644
index 00000000..bccf5983
--- /dev/null
+++ b/frontend/src/entity/storages/models/SFTPStorage.ts
@@ -0,0 +1,9 @@
+export interface SFTPStorage {
+ host: string;
+ port: number;
+ username: string;
+ password?: string;
+ privateKey?: string;
+ path?: string;
+ skipHostKeyVerify?: boolean;
+}
diff --git a/frontend/src/entity/storages/models/Storage.ts b/frontend/src/entity/storages/models/Storage.ts
index 41e8701d..6fdabc93 100644
--- a/frontend/src/entity/storages/models/Storage.ts
+++ b/frontend/src/entity/storages/models/Storage.ts
@@ -5,6 +5,7 @@ import type { LocalStorage } from './LocalStorage';
import type { NASStorage } from './NASStorage';
import type { RcloneStorage } from './RcloneStorage';
import type { S3Storage } from './S3Storage';
+import type { SFTPStorage } from './SFTPStorage';
import type { StorageType } from './StorageType';
export interface Storage {
@@ -21,5 +22,6 @@ export interface Storage {
nasStorage?: NASStorage;
azureBlobStorage?: AzureBlobStorage;
ftpStorage?: FTPStorage;
+ sftpStorage?: SFTPStorage;
rcloneStorage?: RcloneStorage;
}
diff --git a/frontend/src/entity/storages/models/StorageType.ts b/frontend/src/entity/storages/models/StorageType.ts
index 2671f584..44bc2e47 100644
--- a/frontend/src/entity/storages/models/StorageType.ts
+++ b/frontend/src/entity/storages/models/StorageType.ts
@@ -5,5 +5,6 @@ export enum StorageType {
NAS = 'NAS',
AZURE_BLOB = 'AZURE_BLOB',
FTP = 'FTP',
+ SFTP = 'SFTP',
RCLONE = 'RCLONE',
}
diff --git a/frontend/src/entity/storages/models/getStorageLogoFromType.ts b/frontend/src/entity/storages/models/getStorageLogoFromType.ts
index ee85c8e9..21ca0825 100644
--- a/frontend/src/entity/storages/models/getStorageLogoFromType.ts
+++ b/frontend/src/entity/storages/models/getStorageLogoFromType.ts
@@ -14,6 +14,8 @@ export const getStorageLogoFromType = (type: StorageType) => {
return '/icons/storages/azure.svg';
case StorageType.FTP:
return '/icons/storages/ftp.svg';
+ case StorageType.SFTP:
+ return '/icons/storages/sftp.svg';
case StorageType.RCLONE:
return '/icons/storages/rclone.svg';
default:
diff --git a/frontend/src/entity/storages/models/getStorageNameFromType.ts b/frontend/src/entity/storages/models/getStorageNameFromType.ts
index c9fa63bb..c54dc9d4 100644
--- a/frontend/src/entity/storages/models/getStorageNameFromType.ts
+++ b/frontend/src/entity/storages/models/getStorageNameFromType.ts
@@ -14,6 +14,8 @@ export const getStorageNameFromType = (type: StorageType) => {
return 'Azure Blob Storage';
case StorageType.FTP:
return 'FTP';
+ case StorageType.SFTP:
+ return 'SFTP';
case StorageType.RCLONE:
return 'Rclone';
default:
diff --git a/frontend/src/features/storages/ui/edit/EditStorageComponent.tsx b/frontend/src/features/storages/ui/edit/EditStorageComponent.tsx
index c69b2a21..2f9a0208 100644
--- a/frontend/src/features/storages/ui/edit/EditStorageComponent.tsx
+++ b/frontend/src/features/storages/ui/edit/EditStorageComponent.tsx
@@ -14,6 +14,7 @@ import { EditGoogleDriveStorageComponent } from './storages/EditGoogleDriveStora
import { EditNASStorageComponent } from './storages/EditNASStorageComponent';
import { EditRcloneStorageComponent } from './storages/EditRcloneStorageComponent';
import { EditS3StorageComponent } from './storages/EditS3StorageComponent';
+import { EditSFTPStorageComponent } from './storages/EditSFTPStorageComponent';
interface Props {
workspaceId: string;
@@ -89,6 +90,7 @@ export function EditStorageComponent({
storage.googleDriveStorage = undefined;
storage.azureBlobStorage = undefined;
storage.ftpStorage = undefined;
+ storage.sftpStorage = undefined;
storage.rcloneStorage = undefined;
if (type === StorageType.LOCAL) {
@@ -148,6 +150,16 @@ export function EditStorageComponent({
};
}
+ if (type === StorageType.SFTP) {
+ storage.sftpStorage = {
+ host: '',
+ port: 22,
+ username: '',
+ password: '',
+ path: '',
+ };
+ }
+
if (type === StorageType.RCLONE) {
storage.rcloneStorage = {
configContent: '',
@@ -270,6 +282,21 @@ export function EditStorageComponent({
);
}
+ if (storage.type === StorageType.SFTP) {
+ if (storage.id) {
+ return (
+ storage.sftpStorage?.host && storage.sftpStorage?.port && storage.sftpStorage?.username
+ );
+ }
+
+ return (
+ storage.sftpStorage?.host &&
+ storage.sftpStorage?.port &&
+ storage.sftpStorage?.username &&
+ (storage.sftpStorage?.password || storage.sftpStorage?.privateKey)
+ );
+ }
+
if (storage.type === StorageType.RCLONE) {
if (storage.id) {
return true;
@@ -315,6 +342,7 @@ export function EditStorageComponent({
{ label: 'NAS', value: StorageType.NAS },
{ label: 'Azure Blob Storage', value: StorageType.AZURE_BLOB },
{ label: 'FTP', value: StorageType.FTP },
+ { label: 'SFTP', value: StorageType.SFTP },
{ label: 'Rclone', value: StorageType.RCLONE },
]}
onChange={(value) => {
@@ -389,6 +417,17 @@ export function EditStorageComponent({
/>
)}
+ {storage?.type === StorageType.SFTP && (
+ <EditSFTPStorageComponent
+ storage={storage}
+ setStorage={setStorage}
+ setUnsaved={() => {
+ setIsUnsaved(true);
+ setIsTestConnectionSuccess(false);
+ }}
+ />
+ )}
+
{storage?.type === StorageType.RCLONE && (
<EditRcloneStorageComponent
storage={storage}
diff --git a/frontend/src/features/storages/ui/edit/storages/EditSFTPStorageComponent.tsx b/frontend/src/features/storages/ui/edit/storages/EditSFTPStorageComponent.tsx
new file mode 100644
index 00000000..97db0f95
--- /dev/null
+++ b/frontend/src/features/storages/ui/edit/storages/EditSFTPStorageComponent.tsx
@@ -0,0 +1,267 @@
+import { DownOutlined, InfoCircleOutlined, UpOutlined } from '@ant-design/icons';
+import { Checkbox, Input, InputNumber, Radio, Tooltip } from 'antd';
+import { useState } from 'react';
+
+import type { Storage } from '../../../../../entity/storages';
+
+interface Props {
+ storage: Storage;
+ setStorage: (storage: Storage) => void;
+ setUnsaved: () => void;
+}
+
+export function EditSFTPStorageComponent({ storage, setStorage, setUnsaved }: Props) {
+ const hasAdvancedValues = !!storage?.sftpStorage?.skipHostKeyVerify;
+ const [showAdvanced, setShowAdvanced] = useState(hasAdvancedValues);
+
+ const authMethod = storage?.sftpStorage?.privateKey ? 'privateKey' : 'password';
+
+ return (
+ <>
+ <div className="mb-1 flex w-full flex-col items-start sm:flex-row sm:items-center">
+ <div className="mb-1 min-w-[110px] sm:mb-0">Host</div>
+ <Input
+ value={storage?.sftpStorage?.host || ''}
+ onChange={(e) => {
+ if (!storage?.sftpStorage) return;
+
+ setStorage({
+ ...storage,
+ sftpStorage: {
+ ...storage.sftpStorage,
+ host: e.target.value.trim(),
+ },
+ });
+ setUnsaved();
+ }}
+ size="small"
+ className="w-full max-w-[250px]"
+ placeholder="sftp.example.com"
+ />
+ </div>
+
+ <div className="mb-1 flex w-full flex-col items-start sm:flex-row sm:items-center">
+ <div className="mb-1 min-w-[110px] sm:mb-0">Port</div>
+ <InputNumber
+ value={storage?.sftpStorage?.port}
+ onChange={(value) => {
+ if (!storage?.sftpStorage || !value) return;
+
+ setStorage({
+ ...storage,
+ sftpStorage: {
+ ...storage.sftpStorage,
+ port: value,
+ },
+ });
+ setUnsaved();
+ }}
+ size="small"
+ className="w-full max-w-[250px]"
+ min={1}
+ max={65535}
+ placeholder="22"
+ />
+ </div>
+
+ <div className="mb-1 flex w-full flex-col items-start sm:flex-row sm:items-center">
+ <div className="mb-1 min-w-[110px] sm:mb-0">Username</div>
+ <Input
+ value={storage?.sftpStorage?.username || ''}
+ onChange={(e) => {
+ if (!storage?.sftpStorage) return;
+
+ setStorage({
+ ...storage,
+ sftpStorage: {
+ ...storage.sftpStorage,
+ username: e.target.value.trim(),
+ },
+ });
+ setUnsaved();
+ }}
+ size="small"
+ className="w-full max-w-[250px]"
+ placeholder="username"
+ />
+ </div>
+
+ <div className="mb-1 flex w-full flex-col items-start sm:flex-row sm:items-center">
+ <div className="mb-1 min-w-[110px] sm:mb-0">Auth Method</div>
+ <Radio.Group
+ value={authMethod}
+ onChange={(e) => {
+ if (!storage?.sftpStorage) return;
+
+ if (e.target.value === 'password') {
+ setStorage({
+ ...storage,
+ sftpStorage: {
+ ...storage.sftpStorage,
+ privateKey: undefined,
+ },
+ });
+ } else {
+ setStorage({
+ ...storage,
+ sftpStorage: {
+ ...storage.sftpStorage,
+ password: undefined,
+ },
+ });
+ }
+ setUnsaved();
+ }}
+ size="small"
+ >
+ <Radio value="password">Password</Radio>
+ <Radio value="privateKey">Private Key</Radio>
+ </Radio.Group>
+ </div>
+
+ {authMethod === 'password' && (
+ <div className="mb-1 flex w-full flex-col items-start sm:flex-row sm:items-center">
+ <div className="mb-1 min-w-[110px] sm:mb-0">Password</div>
+ <Input.Password
+ value={storage?.sftpStorage?.password || ''}
+ onChange={(e) => {
+ if (!storage?.sftpStorage) return;
+
+ setStorage({
+ ...storage,
+ sftpStorage: {
+ ...storage.sftpStorage,
+ password: e.target.value,
+ },
+ });
+ setUnsaved();
+ }}
+ size="small"
+ className="w-full max-w-[250px]"
+ placeholder="password"
+ />
+ </div>
+ )}
+
+ {authMethod === 'privateKey' && (
+ <div className="mb-1 flex w-full flex-col items-start sm:flex-row sm:items-center">
+ <div className="mb-1 min-w-[110px] sm:mb-0">Private Key</div>
+ <div className="flex w-full max-w-[250px] flex-col">
+ <Input.TextArea
+ value={storage?.sftpStorage?.privateKey || ''}
+ onChange={(e) => {
+ if (!storage?.sftpStorage) return;
+
+ setStorage({
+ ...storage,
+ sftpStorage: {
+ ...storage.sftpStorage,
+ privateKey: e.target.value,
+ },
+ });
+ setUnsaved();
+ }}
+ size="small"
+ className="w-full"
+ placeholder="-----BEGIN OPENSSH PRIVATE KEY-----"
+ rows={4}
+ />
+ <Tooltip
+ className="mt-1 cursor-pointer"
+ title="Paste your SSH private key (PEM format). Supports RSA, DSA, ECDSA, and Ed25519 keys."
+ >
+ <InfoCircleOutlined style={{ color: 'gray' }} />
+ </Tooltip>
+ </div>
+ </div>
+ )}
+
+ <div className="mb-1 flex w-full flex-col items-start sm:flex-row sm:items-center">
+ <div className="mb-1 min-w-[110px] sm:mb-0">Path</div>
+ <div className="flex items-center">
+ <Input
+ value={storage?.sftpStorage?.path || ''}
+ onChange={(e) => {
+ if (!storage?.sftpStorage) return;
+
+ let pathValue = e.target.value.trim();
+ if (pathValue.startsWith('/')) {
+ pathValue = pathValue.substring(1);
+ }
+
+ setStorage({
+ ...storage,
+ sftpStorage: {
+ ...storage.sftpStorage,
+ path: pathValue || undefined,
+ },
+ });
+ setUnsaved();
+ }}
+ size="small"
+ className="w-full max-w-[250px]"
+ placeholder="backups (optional)"
+ />
+
+ <Tooltip
+ className="cursor-pointer"
+ title="Remote directory path for storing backups (optional)"
+ >
+ <InfoCircleOutlined className="ml-2" style={{ color: 'gray' }} />
+ </Tooltip>
+ </div>
+ </div>
+
+ <div className="mt-4 mb-3 flex items-center">
+ <div
+ className="flex cursor-pointer items-center text-sm text-blue-600 hover:text-blue-800"
+ onClick={() => setShowAdvanced(!showAdvanced)}
+ >
+ <span className="mr-2">Advanced settings</span>
+
+ {showAdvanced ? (
+ <UpOutlined style={{ fontSize: '12px' }} />
+ ) : (
+ <DownOutlined style={{ fontSize: '12px' }} />
+ )}
+ </div>
+ </div>
+
+ {showAdvanced && (
+ <>
+ <div className="mb-1 flex w-full flex-col items-start sm:flex-row sm:items-center">
+ <div className="mb-1 min-w-[110px] sm:mb-0">Skip host key</div>
+ <div className="flex items-center">
+ <Checkbox
+ checked={storage?.sftpStorage?.skipHostKeyVerify || false}
+ onChange={(e) => {
+ if (!storage?.sftpStorage) return;
+
+ setStorage({
+ ...storage,
+ sftpStorage: {
+ ...storage.sftpStorage,
+ skipHostKeyVerify: e.target.checked,
+ },
+ });
+ setUnsaved();
+ }}
+ >
+ Skip host key verification
+ </Checkbox>
+
+ <Tooltip
+ className="cursor-pointer"
+ title="Skip SSH host key verification. Enable this if you trust the server. Warning: this reduces security."
+ >
+ <InfoCircleOutlined className="ml-2" style={{ color: 'gray' }} />
+ </Tooltip>
+ </div>
+ </div>
+ </>
+ )}
+
+ <div className="mb-5" />
+ </>
+ );
+}
diff --git a/frontend/src/features/storages/ui/show/ShowStorageComponent.tsx b/frontend/src/features/storages/ui/show/ShowStorageComponent.tsx
index dec56576..be09618a 100644
--- a/frontend/src/features/storages/ui/show/ShowStorageComponent.tsx
+++ b/frontend/src/features/storages/ui/show/ShowStorageComponent.tsx
@@ -7,6 +7,7 @@ import { ShowGoogleDriveStorageComponent } from './storages/ShowGoogleDriveStora
import { ShowNASStorageComponent } from './storages/ShowNASStorageComponent';
import { ShowRcloneStorageComponent } from './storages/ShowRcloneStorageComponent';
import { ShowS3StorageComponent } from './storages/ShowS3StorageComponent';
+import { ShowSFTPStorageComponent } from './storages/ShowSFTPStorageComponent';
interface Props {
storage?: Storage;
@@ -51,6 +52,10 @@ export function ShowStorageComponent({ storage }: Props) {
{storage?.type === StorageType.FTP && <ShowFTPStorageComponent storage={storage} />}
</div>
+ <div>
+ {storage?.type === StorageType.SFTP && <ShowSFTPStorageComponent storage={storage} />}
+ </div>
+
<div>
{storage?.type === StorageType.RCLONE && <ShowRcloneStorageComponent storage={storage} />}
</div>
diff --git a/frontend/src/features/storages/ui/show/storages/ShowSFTPStorageComponent.tsx b/frontend/src/features/storages/ui/show/storages/ShowSFTPStorageComponent.tsx
new file mode 100644
index 00000000..d61766b3
--- /dev/null
+++ b/frontend/src/features/storages/ui/show/storages/ShowSFTPStorageComponent.tsx
@@ -0,0 +1,50 @@
+import type { Storage } from '../../../../../entity/storages';
+
+interface Props {
+ storage: Storage;
+}
+
+export function ShowSFTPStorageComponent({ storage }: Props) {
+ const authMethod = storage?.sftpStorage?.privateKey ? 'Private Key' : 'Password';
+
+ return (
+ <>
+ <div className="mb-1 flex items-center">
+ <div className="min-w-[110px]">Host</div>
+ {storage?.sftpStorage?.host || '-'}
+ </div>
+
+ <div className="mb-1 flex items-center">
+ <div className="min-w-[110px]">Port</div>
+ {storage?.sftpStorage?.port || '-'}
+ </div>
+
+ <div className="mb-1 flex items-center">
+ <div className="min-w-[110px]">Username</div>
+ {storage?.sftpStorage?.username || '-'}
+ </div>
+
+ <div className="mb-1 flex items-center">
+ <div className="min-w-[110px]">Auth Method</div>
+ {authMethod}
+ </div>
+
+ <div className="mb-1 flex items-center">
+ <div className="min-w-[110px]">Credentials</div>
+ {'*************'}
+ </div>
+
+ <div className="mb-1 flex items-center">
+ <div className="min-w-[110px]">Path</div>
+ {storage?.sftpStorage?.path || '-'}
+ </div>
+
+ {storage?.sftpStorage?.skipHostKeyVerify && (
+ <div className="mb-1 flex items-center">
+ <div className="min-w-[110px]">Skip host key</div>
+ Enabled
+ </div>
+ )}
+ </>
+ );
+}