SwFTP is an FTP and SFTP interface for Openstack Object Storage (swift). It will act as a proxy between the FTP/SFTP protocols and OpenStack Object Storage.
pip install swftpInstall via pip:
$ pip install swftp
Note: If you don't have pip here's how to install it.
Install using git/pip:
$ pip install -U git+git://github.com/softlayer/swftp.git
Install from source:
$ python setup.py install
To run the FTP server, simply run this command.
$ swftp-ftp -a http://127.0.0.1:8080/auth/v1.0
2013-02-18 16:28:50-0600 [-] Log opened.
2013-02-18 16:28:50-0600 [-] FTPFactory starting on 5021
2013-02-18 16:28:50-0600 [-] Starting factory <twisted.protocols.ftp.FTPFactory instance at 0x1103fcf80>
The SFTP requires a bit of setup the first time.
You'll need to create a public/private key pair for SSH and move them to the /etc/swftp directory (this location is configurable).
$ mkdir /etc/swftp
$ ssh-keygen -h -b 2048 -N "" -t rsa -f /etc/swftp/id_rsa
After placing the required files, the command to start the server is similar to the FTP one.
$ swftp-sftp -a http://127.0.0.1:8080/auth/v1.0
2013-02-18 16:29:14-0600 [-] Log opened.
2013-02-18 22:29:14+0000 [-] SSHFactory starting on 5022
The command line configuration allows you to speficfy a custom OpenStack Swift Auth URL, as well as the location of the config file (detailed later).
FTP Command-line options:
$ swftp-ftp --help
Usage: swftp-ftp [options]
Options:
-c, --config_file= Location of the swftp config file. [default:
/etc/swftp/swftp.conf]
-a, --auth_url= Auth Url to use. Defaults to the config file value if it
exists. [default: http://127.0.0.1:8080/auth/v1.0]
-p, --port= Port to bind to.
-h, --host= IP to bind to.
--version Display Twisted version and exit.
--help Display this help and exit.
SFTP Command-line options:
$ swftp-sftp --help
Usage: swftp-sftp [options]
Options:
-c, --config_file= Location of the swftp config file. [default:
/etc/swftp/swftp.conf]
-a, --auth_url= Auth Url to use. Defaults to the config file value if it
exists.[default: http://127.0.0.1:8080/auth/v1.0]
-p, --port= Port to bind to.
-h, --host= IP to bind to.
--priv_key= Private Key Location.
--pub_key= Public Key Location.
--version Display Twisted version and exit.
--help Display this help and exit.
The default location for the config file is /etc/swftp/swftp.conf.
Here is an example swftp.conf with all defaults:
[sftp]
auth_url = http://127.0.0.1:8080/auth/v1.0
host = 0.0.0.0
port = 5022
priv_key = /etc/swftp/id_rsa
pub_key = /etc/swftp/id_rsa.pub
num_persistent_connections = 20
num_connections_per_session = 10
connection_timeout = 240
extra_headers = X-Swftp: true, X-Forwarded-Proto: SFTP
log_statsd_host =
log_statsd_port = 8125
log_statsd_sample_rate = 10
log_statsd_metric_prefix = sftp
stats_host =
stats_port = 38022
[ftp]
auth_url = http://127.0.0.1:8080/auth/v1.0
host = 0.0.0.0
port = 5021
num_persistent_connections = 20
num_connections_per_session = 10
connection_timeout = 240
welcome_message = Welcome to SwFTP - An FTP/SFTP interface for Openstack Swift
extra_headers = X-Swftp: true, X-Forwarded-Proto: SFTP
log_statsd_host =
log_statsd_port = 8125
log_statsd_sample_rate = 10
log_statsd_metric_prefix = ftp
stats_host =
stats_port = 38021
Packaged with SwFTP are a set of example init scripts, upstart scripts. They are all located within the /etc/ directory in the source.
The web interface is an HTTP interface that provides a way to get more app-specific metrics. The only format supported currently is JSON. If the 'stats_host' config value is set, the server will listen to that interface.
http://{stats_host}:{stats_port}/stats.json
$ curl http://127.0.0.1:38022/stats.json | python -mjson.tool
{
"rates": {
"auth.fail": 0,
"auth.succeed": 0,
"command.getAttrs": 0,
"command.login": 0,
"command.logout": 9,
"command.makeDirectory": 0,
"command.openDirectory": 0,
"command.openFile": 0,
"command.removeDirectory": 0,
"command.removeFile": 0,
"command.renameFile": 0,
"num_clients": -9,
"transfer.egress_bytes": 0,
"transfer.ingress_bytes": 47662
},
"totals": {
"auth.fail": 0,
"auth.succeed": 91,
"command.getAttrs": 15,
"command.login": 91,
"command.logout": 91,
"command.makeDirectory": 0,
"command.openDirectory": 7,
"command.openFile": 8,
"command.removeDirectory": 3,
"command.removeFile": 0,
"command.renameFile": 7,
"num_clients": 0,
"transfer.egress_bytes": 11567105,
"transfer.ingress_bytes": 11567105
}
}
Statsd support relies on txStatsD. If the 'log_statsd_host' config value is set, the following paths will be emited into statsd.
Development works with a fork and pull request process. Feel free submit pull requests.
To run the tests, run
$ trial swftp
To run tests against live swftp servers (ftp and sftp) it requires a test config. The default location is /etc/swftp/test.conf but can be set with the SWFTP_TEST_CONFIG_FILE environmental variable. Here is a sample test config
[func_test]
auth_host = 127.0.0.1
auth_port = 8080
auth_ssl = no
auth_prefix = /auth/
account = test
username = tester
password = testing
sftp_host = 127.0.0.1
sftp_port = 5022
ftp_host = 127.0.0.1
ftp_port = 5021
Copyright (c) 2013 SoftLayer Technologies, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
SwFTP is an FTP and SFTP interface for Openstack Object Storage (swift)
We found that swftp demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.Ā It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious PyPI checkers validate stolen emails against TikTok and Instagram APIs, enabling targeted account attacks and dark web credential sales.
Security News
The Node.js TSC opted not to endorse a feature bounty program, citing concerns about incentives, governance, and project neutrality.
Research
Security News
A look at the top trends in how threat actors are weaponizing open source packages to deliver malware and persist across the software supply chain.