go>> ftpserverlib>> 返回
项目作者： fclairamb

项目描述 ：
golang ftp server library
高级语言： Go
项目地址: git://github.com/fclairamb/ftpserverlib.git
创建时间： 2016-09-25T12:05:29Z
项目社区：https://github.com/fclairamb/ftpserverlib
开源协议：MIT License
下载


Golang FTP Server library

Go version
Release
Build
codecov
Go Report Card
GoDoc
Mentioned in Awesome Go

This library allows to easily build a simple and fully-featured FTP server using afero as the backend filesystem.

If you’re interested in a fully featured FTP server, you should use sftpgo (fully featured SFTP/FTP server) or ftpserver (basic FTP server).

Current status of the project

Features

  • Uploading and downloading files
  • Directory listing (LIST + MLST)
  • File and directory deletion and renaming
  • TLS support (AUTH + PROT)
  • File download/upload resume support (REST)
  • Passive socket connections (PASV and EPSV commands)
  • Active socket connections (PORT and EPRT commands)
  • IPv6 support (EPSV + EPRT)
  • Small memory footprint
  • Clean code: No sleep, no panic, no global sync (only around control/transfer connection per client)
  • Uses only the standard library except for:
  • Supported extensions:
    • AUTH - Control session protection
    • AUTH TLS - TLS session
    • PROT - Transfer protection
    • EPRT/EPSV - IPv6 support
    • MDTM - File Modification Time
    • SIZE - Size of a file
    • REST - Restart of interrupted transfer
    • MLST - Simple file listing for machine processing
    • MLSD - Directory listing for machine processing
    • HASH - Hashing of files
    • AVLB - Available space
    • COMB - Combine files

Quick test

The easiest way to test this library is to use ftpserver.

The driver

The simplest way to get a good understanding of how the driver shall be implemented is to look at the tests driver.

The base API

The API is directly based on afero.

  1. // MainDriver handles the authentication and ClientHandlingDriver selection
  2. type MainDriver interface {
  3.     // GetSettings returns some general settings around the server setup
  4.     GetSettings() (*Settings, error)
  6.     // ClientConnected is called to send the very first welcome message
  7.     ClientConnected(cc ClientContext) (string, error)
  9.     // ClientDisconnected is called when the user disconnects, even if he never authenticated
  10.     ClientDisconnected(cc ClientContext)
  12.     // AuthUser authenticates the user and selects an handling driver
  13.     AuthUser(cc ClientContext, user, pass string) (ClientDriver, error)
  15.     // GetTLSConfig returns a TLS Certificate to use
  16.     // The certificate could frequently change if we use something like "let's encrypt"
  17.     GetTLSConfig() (*tls.Config, error)
  18. }
  21. // ClientDriver is the base FS implementation that allows to manipulate files
  22. type ClientDriver interface {
  23.     afero.Fs
  24. }
  26. // ClientContext is implemented on the server side to provide some access to few data around the client
  27. type ClientContext interface {
  28.     // Path provides the path of the current connection
  29.     Path() string
  31.     // SetDebug activates the debugging of this connection commands
  32.     SetDebug(debug bool)
  34.     // Debug returns the current debugging status of this connection commands
  35.     Debug() bool
  37.     // Client's ID on the server
  38.     ID() uint32
  40.     // Client's address
  41.     RemoteAddr() net.Addr
  43.     // Servers's address
  44.     LocalAddr() net.Addr
  46.     // Client's version can be empty
  47.     GetClientVersion() string
  49.     // Close closes the connection and disconnects the client.
  50.     Close() error
  52.     // HasTLSForControl returns true if the control connection is over TLS
  53.     HasTLSForControl() bool
  55.     // HasTLSForTransfers returns true if the transfer connection is over TLS
  56.     HasTLSForTransfers() bool
  58.     // GetLastCommand returns the last received command
  59.     GetLastCommand() string
  61.     // GetLastDataChannel returns the last data channel mode
  62.     GetLastDataChannel() DataChannel
  63. }
  65. // Settings define all the server settings
  66. type Settings struct {
  67.     Listener                 net.Listener     // (Optional) To provide an already initialized listener
  68.     ListenAddr               string           // Listening address
  69.     PublicHost               string           // Public IP to expose (only an IP address is accepted at this stage)
  70.     PublicIPResolver         PublicIPResolver // (Optional) To fetch a public IP lookup
  71.     PassiveTransferPortRange *PortRange       // (Optional) Port Range for data connections. Random if not specified
  72.     ActiveTransferPortNon20  bool             // Do not impose the port 20 for active data transfer (#88, RFC 1579)
  73.     IdleTimeout              int              // Maximum inactivity time before disconnecting (#58)
  74.     ConnectionTimeout        int              // Maximum time to establish passive or active transfer connections
  75.     DisableMLSD              bool             // Disable MLSD support
  76.     DisableMLST              bool             // Disable MLST support
  77.     DisableMFMT              bool             // Disable MFMT support (modify file mtime)
  78.     Banner                   string           // Banner to use in server status response
  79.     TLSRequired              TLSRequirement   // defines the TLS mode
  80.     DisableLISTArgs          bool             // Disable ls like options (-a,-la etc.) for directory listing
  81.     DisableSite              bool             // Disable SITE command
  82.     DisableActiveMode        bool             // Disable Active FTP
  83.     EnableHASH               bool             // Enable support for calculating hash value of files
  84.     DisableSTAT              bool             // Disable Server STATUS, STAT on files and directories will still work
  85.     DisableSYST              bool             // Disable SYST
  86.     EnableCOMB               bool             // Enable COMB support
  87.     DefaultTransferType      TransferType     // Transfer type to use if the client don't send the TYPE command
  88.     // ActiveConnectionsCheck defines the security requirements for active connections
  89.     ActiveConnectionsCheck DataConnectionRequirement
  90.     // PasvConnectionsCheck defines the security requirements for passive connections
  91.     PasvConnectionsCheck DataConnectionRequirement
  92. }

Extensions

There are a few extensions to the base afero APIs so that you can perform some operations that aren’t offered by afero.

Pre-allocate some space

  1. // ClientDriverExtensionAllocate is an extension to support the "ALLO" - file allocation - command
  2. type ClientDriverExtensionAllocate interface {
  4.     // AllocateSpace reserves the space necessary to upload files
  5.     AllocateSpace(size int) error
  6. }

Get available space

  1. // ClientDriverExtensionAvailableSpace is an extension to implement to support
  2. // the AVBL ftp command
  3. type ClientDriverExtensionAvailableSpace interface {
  4.     GetAvailableSpace(dirName string) (int64, error)
  5. }
  1. // ClientDriverExtensionSymlink is an extension to support the "SITE SYMLINK" - symbolic link creation - command
  2. type ClientDriverExtensionSymlink interface {
  4.     // Symlink creates a symlink
  5.     Symlink(oldname, newname string) error
  7.     // SymlinkIfPossible allows to get the source of a symlink (but we don't need for now)
  8.     // ReadlinkIfPossible(name string) (string, error)
  9. }

Compute file hash

  1. // ClientDriverExtensionHasher is an extension to implement if you want to handle file digests
  2. // yourself. You have to set EnableHASH to true for this extension to be called
  3. type ClientDriverExtensionHasher interface {
  4.     ComputeHash(name string, algo HASHAlgo, startOffset, endOffset int64) (string, error)
  5. }

History of the project

I wanted to make a system which would accept files through FTP and redirect them to something else. Go seemed like the obvious choice and it seemed there was a lot of libraries available but it turns out none of them were in a useable state.