freman/goftp-server
1
0
Fork 0
forked from goftp/server
Code Issues Pull Requests Releases Wiki Activity
A FTP server framework written by Golang
248 Commits 7 Branches 0 Tags 1,007 KiB
Go 100%
Go to file
Shannon Wynter 9aad2e7214 Add auth factory, expose driver on conn
2020-03-31 20:45:04 +10:00
.drone.yml Add null notifier (#104) 2020-03-16 07:16:39 +00:00
.gitignore update projects new package name 2019-07-12 17:18:27 +08:00
auth.go Add auth factory, expose driver on conn 2020-03-31 20:45:04 +10:00
cmd_test.go release v0.3.0 2018-04-20 20:40:37 +08:00
cmd.go Add auth factory, expose driver on conn 2020-03-31 20:45:04 +10:00
conn_test.go Fix lints and add RemoteAddr in Conn (#105) 2020-03-18 06:36:54 +00:00
conn.go Add auth factory, expose driver on conn 2020-03-31 20:45:04 +10:00
doc.go release v0.3.0 2018-04-20 20:40:37 +08:00
driver_file.go Fix lints and add RemoteAddr in Conn (#105) 2020-03-18 06:36:54 +00:00
driver_minio_test.go Add null notifier (#104) 2020-03-16 07:16:39 +00:00
driver_minio.go Fix lints and add RemoteAddr in Conn (#105) 2020-03-18 06:36:54 +00:00
driver.go Fix lints and add RemoteAddr in Conn (#105) 2020-03-18 06:36:54 +00:00
file_info.go Fix lints and add RemoteAddr in Conn (#105) 2020-03-18 06:36:54 +00:00
go.mod Add auth factory, expose driver on conn 2020-03-31 20:45:04 +10:00
go.sum Add minio driver (#86) 2020-02-06 02:09:53 +00:00
LICENSE release v0.3.0 2018-04-20 20:40:37 +08:00
list_formatter.go Merge file driver into main repository (#83) 2020-02-04 12:21:27 +00:00
logger.go Fix lints and add RemoteAddr in Conn (#105) 2020-03-18 06:36:54 +00:00
notifier_test.go Add notifications with tests (#87) 2020-02-19 06:20:24 +00:00
notifier.go Fix lints and add RemoteAddr in Conn (#105) 2020-03-18 06:36:54 +00:00
perm.go Fix lints and add RemoteAddr in Conn (#105) 2020-03-18 06:36:54 +00:00
README.md update projects new package name 2019-07-12 17:18:27 +08:00
server_test.go Add auth factory, expose driver on conn 2020-03-31 20:45:04 +10:00
server.go Add auth factory, expose driver on conn 2020-03-31 20:45:04 +10:00
socket.go Fix some bugs and add tests for cur directory (#98) 2020-02-09 06:08:05 +00:00

README.md

server

Build Status

A FTP server framework forked from github.com/yob/graval and changed a lot.

Full documentation for the package is available on godoc

Version

v0.2.3

Installation

go get goftp.io/server

Usage

To boot a FTP server you will need to provide a driver that speaks to your persistence layer - the required driver contract is in the documentation.

Look at the file driver to see an example of how to build a backend.

There is a sample ftp server as a demo. You can build it with this command:

go install goftp.io/server/exampleftpd

Then run it if you have add $GOPATH to your $PATH:

exampleftpd -root /tmp

And finally, connect to the server with any FTP client and the following details:

host: 127.0.0.1
port: 2121
username: admin
password: 123456

This uses the file driver mentioned above to serve files.

Contributors

see https://gitea.com/goftp/server/graphs/contributors

Warning

FTP is an incredibly insecure protocol. Be careful about forcing users to authenticate with an username or password that are important.

License

This library is distributed under the terms of the MIT License. See the included file for more detail.

Contributing

All suggestions and patches welcome, preferably via a git repository I can pull from. If this library proves useful to you, please let me know.

Further Reading

There are a range of RFCs that together specify the FTP protocol. In chronological order, the more useful ones are:

For an english summary that's somewhat more legible than the RFCs, and provides some commentary on what features are actually useful or relevant 24 years after RFC959 was published:

For a history lesson, check out Appendix III of RCF959. It lists the preceding (obsolete) RFC documents that relate to file transfers, including the ye old RFC114 from 1971, "A File Transfer Protocol"

This library is heavily based on em-ftpd, an FTPd framework with similar design goals within the ruby and EventMachine ecosystems. It worked well enough, but you know, callbacks and event loops make me something something.