Categorygoftp.io/server/v2
modulepackage
2.0.1
Repository: https://gitea.com/goftp/server
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
25
Dependents
25
Files
2.4k SLOC

# README

server

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

Full documentation for the package is available on godoc

Installation

go get goftp.io/server/v2

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/ftpd

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.

Contact us

You can contact us via discord https://discord.gg/ytmYqfNfqh or QQ群 972357369

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.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

DefaultCommands returns the default commands.
NewMultiDriver creates a multi driver to combind multiple driver.
NewServer initialises a new FTP server.
NewSimplePerm creates a SimplePerm.

# Variables

ErrServerClosed is returned by ListenAndServe() or Serve() when a shutdown was requested.

# Structs

Context represents a context the driver may want to know.
DiscardLogger represents a silent logger, produces no output.
MultiDriver represents a composite driver.
NullNotifier implements Notifier.
Options contains parameters for server.NewServer().
Server is the root of your FTP application.
Session represents a session between ftp client and the server.
SimpleAuth implements Auth interface to provide a memory user login auth.
SimplePerm implements Perm interface that all files are owned by special owner and group.
StdLogger use an instance of this to log in a standard format.

# Interfaces

Auth is an interface to auth your ftp user login.
Command represents a Command interface to a ftp command.
DataSocket describes a data socket is used to send non-control data between the client and server.
Driver is an interface that you will implement to create a driver for your chosen persistence layer.
FileInfo represents an file interface.
Logger represents an interface to record all ftp information and command.
Notifier represents a notification operator interface.
Perm represents a perm interface.