sftp

package

v1.4.0 Latest Latest Go to latest Published: Sep 1, 2022 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Backend implements storage.Backend for sFTP.

func New(l log.Logger, c Config) (*Backend, error)

New creates a new sFTP backend.

func (b *Backend) Exists(ctx context.Context, p string) (bool, error)

Exists checks if object already exists.

func (b *Backend) Get(ctx context.Context, p string, w io.Writer) error

Get writes downloaded content to the given writer.

func (b *Backend) Put(ctx context.Context, p string, r io.Reader) error

Put uploads contents of the given reader.

type Config struct {
	CacheRoot string
	Username  string
	Host      string
	Port      string
	Auth      SSHAuth
	Timeout   time.Duration
}

Config is a structure to store sFTP backend configuration.

type SSHAuth struct {
	Password      string
	PublicKeyFile string
	Method        SSHAuthMethod
}

SSHAuth is a structure to store authentication information for SSH connection.

type SSHAuthMethod string

SSHAuthMethod describes the type of authentication method.

const (
	SSHAuthMethodPassword      SSHAuthMethod = "PASSWORD"
	SSHAuthMethodPublicKeyFile SSHAuthMethod = "PUBLIC_KEY_FILE"
)