Documentation
¶
Overview ¶
Package shared contains docs fields that need to be shared across old and new component implementations, it needs to be separate from the parent package in order to avoid circular dependencies (for now).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CredentialsDocs ¶
func CredentialsDocs() docs.FieldSpecs
CredentialsDocs returns a documentation field spec for SFTP credentials fields within a Config.
func HostCallback ¶
func HostCallback(s *Server) ssh.HostKeyCallback
HostCallback is called when setting up the connection to the SFTP server.
Types ¶
type Credentials ¶
type Credentials struct {
Username string `json:"username" yaml:"username"`
Password string `json:"password" yaml:"password"`
PrivateKeyFile string `json:"private_key_file" yaml:"private_key_file"`
PrivateKeyPass string `json:"private_key_pass" yaml:"private_key_pass"`
}
Credentials contains the credentials for connecting to the SFTP server.
type HostAuthorityCallback ¶
HostAuthorityCallback used when setting up the connection to the SFTP server.
func HostAuthCallback ¶
func HostAuthCallback() HostAuthorityCallback
HostAuthCallback is called when setting up the connection to the SFTP server.
type IsRevokedCallback ¶
type IsRevokedCallback func(cert *ssh.Certificate) bool
IsRevokedCallback used when setting up the connection to the SFTP server.
func CertCallback ¶
func CertCallback(s *Server) IsRevokedCallback
CertCallback is called when setting up the connection to the SFTP server.
type Server ¶
type Server struct {
Address string // host:port
Host string // IP address
Port string // port
IsSSH bool // true if server is running SSH on address:port
Banner string // banner text, if any
Cert ssh.Certificate // server's certificate
Hostname string // hostname
PublicKey ssh.PublicKey // server's public key
}
Server contains connection data for connecting to an SFTP server.
Source Files