https://github.com/ggrandes/sftpserver
SFTP Server (SSH File Transfer Protocol) in Java, based on Apache MINA SSHD
https://github.com/ggrandes/sftpserver
java mina sftp sshd
Last synced: 19 days ago
JSON representation
SFTP Server (SSH File Transfer Protocol) in Java, based on Apache MINA SSHD
- Host: GitHub
- URL: https://github.com/ggrandes/sftpserver
- Owner: ggrandes
- License: apache-2.0
- Created: 2013-01-16T20:50:06.000Z (about 13 years ago)
- Default Branch: main
- Last Pushed: 2024-09-15T09:50:14.000Z (over 1 year ago)
- Last Synced: 2025-03-13T03:01:44.849Z (11 months ago)
- Topics: java, mina, sftp, sshd
- Language: Java
- Homepage:
- Size: 139 KB
- Stars: 79
- Watchers: 10
- Forks: 59
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sftpserver
SFTP Server (SSH File Transfer Protocol) based on `Apache MINA SSHD`. Open Source Java project under Apache License v2.0
### Current Stable Version is [1.5.0](https://github.com/ggrandes/sftpserver/releases)
---
### Versions
| sftpserver | Java |
| :--------- | :--- |
| 1.0.x | 1.6+ |
| 1.1.x | 1.6+ |
| 1.2.x | 1.7+ |
| 1.3.x | 1.8+ |
| 1.4.x | 1.8+ |
| 1.5.x | 1.8+ |
## Config:
###### `${sftp.home}/conf/[id]/sftpd.properties` (all in one file)
#
## Global Options
#
# Listen on localhost and localnet
#sftpserver.global.host=127.0.0.1,192.168.1.1
# Listen on TCP port 22222
sftpserver.global.port=22222
# Enable compression (requires jzlib) (default: false)
sftpserver.global.compress=true
# Enable dummy shell (default: false)
sftpserver.global.dummyshell=true
# Enable log request (default: false)
sftpserver.global.logrequest=true
#
## Configure user "test"
#
# Password for user (unencrypted-plain-text)
#sftpserver.user.test.userpassword=changeit
# Password for user (encrypted)
sftpserver.user.test.userpassword=$1$156RlTZJ$76bzjtXvDfgvouurtgEI10
# PublicKeys for user (OpenSSH format)
sftpserver.user.test.userkey.1=ssh-rsa AAAAB3NzaC1yc2EAAAADA...E7uQ==
sftpserver.user.test.userkey.2=ssh-ed25519 AAAAC3NzaC1...QfX
sftpserver.user.test.userkey.3=ecdsa-sha2-nistp256 AAAAE2VjZ...Z99xM=
# Set user home directory (chrooted)
sftpserver.user.test.homedirectory=./home/test/
# Enable user (default: false)
sftpserver.user.test.enableflag=true
# Enable write (default: false)
sftpserver.user.test.writepermission=true
#
###### `${sftp.home}/conf/[id]/sftpd.properties` + `${sftp.home}/conf/[id]/htpasswd`
#
## Global Options
#
# Listen on TCP port 22222
sftpserver.global.port=22222
# ...
# ... same params as "all in one file" ...
# ...
#
## Configure htpasswd
#
# Enable htpasswd (default: false)
sftpserver.htpasswd.enableflag=true
# Set home directory for all users (chrooted)
sftpserver.htpasswd.homedirectory=./home/test/
# Enable write (default: false)
sftpserver.htpasswd.writepermission=true
#
---
## Running (Linux)
./bin/sftpd.sh [id]
## Upstart Script (Linux)
./bin/sftpd.conf (you can copy to /etc/init/)
## Systemd Service (Linux)
./bin/sftpd.service (you can copy to /etc/systemd/system/)
## Generate Encrypted Password (Linux)
./bin/sftpd.sh
---
# DONEs
* Use Java SecurityManager/Policy File
* Non operating system accounts
* Homes are chrooted
* ReadOnly accounts
* Encrypted Passwords (SHA2/MD5/APR1)
* PublicKey Authenticator (OpenSSH keys RSA/EcDSA/Ed25519)
* Support [htpasswd file](https://httpd.apache.org/docs/2.4/misc/password_encryptions.html) (APR1)
## MISC
Current hardcoded values:
* Default `${sftp.home}` is `/opt/sftpd`
* Hostkeys are writed to: `hostkey.pem` or `hostkey.ser` in `${sftp.home}/keys/` directory
* SecurityManager/Policy File is in `conf/${ID}/sftpd.policy` (custom) or `lib/sftpd.policy` (generic)
* Htpasswd File is in `conf/${ID}/htpasswd` (custom) or `conf/htpasswd` (generic)
* Default KexAlgorithms: `curve25519-sha256, curve25519-sha256@libssh.org, diffie-hellman-group14-sha256, diffie-hellman-group16-sha512, diffie-hellman-group-exchange-sha256, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group14-sha1`
* Default Ciphers: `chacha20-poly1305@openssh.com, aes128-ctr, aes192-ctr, aes256-ctr, aes128-gcm@openssh.com, aes256-gcm@openssh.com`
* Default MACs: `hmac-sha2-256-etm@openssh.com, hmac-sha2-512-etm@openssh.com, hmac-sha1-etm@openssh.com, hmac-sha2-256, hmac-sha2-512, hmac-sha1`
---
Inspired in [mina-sshd](https://github.com/apache/mina-sshd/blob/master/sshd-core/src/main/java/org/apache/sshd/server/SshServer.java) and [openssh](http://www.openssh.org/).