ftpserver

Documentation

Index

• type Config
• type Server
  • func New(config *Config, authorizer *authorization.Authorizer, ...) (*Server, error)
  • func (s *Server) GetActiveConnections() int32
  • func (s *Server) GetStartTime() time.Time
  • func (s *Server) GetTotalConnections() int64
  • func (s *Server) ListenAndServe() error
  • func (s *Server) Stop() error

Types

type Config

type Config struct {
	ListenAddr    string // Address to listen on
	Port          int    // Port to listen on
	RootDir       string // Root directory that FTP users will be restricted to
	HomePattern   string // Pattern for user home directories (e.g., "/home/%s")
	TLSCertFile   string // Path to TLS certificate file
	TLSKeyFile    string // Path to TLS private key file
	PasvPortRange [2]int // Range of ports for passive mode transfers
	PasvAddress   string // Public IP for passive mode connections
	PasvIPVerify  bool   // Whether to verify data connection IPs
}

Config holds the server configuration

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server wraps the FTP server with our custom auth

func New

func New(config *Config, authorizer *authorization.Authorizer, authenticator *authentication.Authenticator, version string) (*Server, error)

New creates a new FTP server

func (*Server) GetActiveConnections

func (s *Server) GetActiveConnections() int32

GetActiveConnections returns the current number of active connections

func (*Server) GetStartTime

func (s *Server) GetStartTime() time.Time

GetStartTime returns the server start time

func (*Server) GetTotalConnections

func (s *Server) GetTotalConnections() int64

GetTotalConnections returns the total number of connections since server start

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

ListenAndServe starts the server

func (*Server) Stop

func (s *Server) Stop() error

Stop stops the server