sftp

Documentation

Overview

Package sftp implements repository storage in a directory on a remote server via the sftp protocol.

Index

• func NewFactory() location.Factory
• type Config
  • func NewConfig() Config
  • func ParseConfig(s string) (*Config, error)
• type SFTP
  • func Create(ctx context.Context, cfg Config) (*SFTP, error)
  • func Open(_ context.Context, cfg Config) (*SFTP, error)
  • func (r *SFTP) Close() error
  • func (r *SFTP) Delete(ctx context.Context) error
  • func (r *SFTP) Hasher() hash.Hash
  • func (r *SFTP) IsNotExist(err error) bool
  • func (r *SFTP) IsPermanentError(err error) bool
  • func (r *SFTP) List(ctx context.Context, t backend.FileType, fn func(backend.FileInfo) error) error
  • func (r *SFTP) Load(ctx context.Context, h backend.Handle, length int, offset int64, ...) error
  • func (r *SFTP) Properties() backend.Properties
  • func (r *SFTP) Remove(_ context.Context, h backend.Handle) error
  • func (r *SFTP) Save(_ context.Context, h backend.Handle, rd backend.RewindReader) error
  • func (r *SFTP) Stat(_ context.Context, h backend.Handle) (backend.FileInfo, error)
  • func (r *SFTP) Warmup(_ context.Context, _ []backend.Handle) ([]backend.Handle, error)
  • func (r *SFTP) WarmupWait(_ context.Context, _ []backend.Handle) error

Functions

func NewFactory

func NewFactory() location.Factory

Types

type Config

type Config struct {
	User, Host, Port, Path string

	Command string `option:"command" help:"specify command to create sftp connection"`
	Args    string `option:"args"    help:"specify arguments for ssh"`

	Connections uint `option:"connections" help:"set a limit for the number of concurrent connections (default: 5)"`
}

Config collects all information required to connect to an sftp server.

func NewConfig

func NewConfig() Config

NewConfig returns a new config with default options applied.

func ParseConfig

func ParseConfig(s string) (*Config, error)

ParseConfig parses the string s and extracts the sftp config. The supported configuration formats are sftp://user@host[:port]/directory and sftp:user@host:directory. The directory will be path Cleaned and can be an absolute path if it starts with a '/' (e.g. sftp://user@host//absolute and sftp:user@host:/absolute).

type SFTP

type SFTP struct {
	layout.Layout
	Config
	util.Modes
	// contains filtered or unexported fields
}

SFTP is a backend in a directory accessed via SFTP.

func Create

func Create(ctx context.Context, cfg Config) (*SFTP, error)

Create creates an sftp backend as described by the config by running "ssh" with the appropriate arguments (or cfg.Command, if set).

func Open

func Open(_ context.Context, cfg Config) (*SFTP, error)

Open opens an sftp backend as described by the config by running "ssh" with the appropriate arguments (or cfg.Command, if set).

func (*SFTP) Close

func (r *SFTP) Close() error

Close closes the sftp connection and terminates the underlying command.

func (*SFTP) Delete

func (r *SFTP) Delete(ctx context.Context) error

Delete removes all data in the backend.

func (*SFTP) Hasher

func (r *SFTP) Hasher() hash.Hash

Hasher may return a hash function for calculating a content hash for the backend

func (*SFTP) IsNotExist

func (r *SFTP) IsNotExist(err error) bool

IsNotExist returns true if the error is caused by a not existing file.

func (*SFTP) IsPermanentError

func (r *SFTP) IsPermanentError(err error) bool

func (*SFTP) List

func (r *SFTP) List(ctx context.Context, t backend.FileType, fn func(backend.FileInfo) error) error

List runs fn for each file in the backend which has the type t. When an error occurs (or fn returns an error), List stops and returns it.

func (*SFTP) Load

func (r *SFTP) Load(ctx context.Context, h backend.Handle, length int, offset int64, fn func(rd io.Reader) error) error

Load runs fn with a reader that yields the contents of the file at h at the given offset.

func (*SFTP) Properties

func (r *SFTP) Properties() backend.Properties

func (*SFTP) Remove

func (r *SFTP) Remove(_ context.Context, h backend.Handle) error

Remove removes the content stored at name.

func (*SFTP) Save

func (r *SFTP) Save(_ context.Context, h backend.Handle, rd backend.RewindReader) error

Save stores data in the backend at the handle.

func (*SFTP) Stat

func (r *SFTP) Stat(_ context.Context, h backend.Handle) (backend.FileInfo, error)

Stat returns information about a blob.

func (*SFTP) Warmup

func (r *SFTP) Warmup(_ context.Context, _ []backend.Handle) ([]backend.Handle, error)

Warmup not implemented

func (*SFTP) WarmupWait

func (r *SFTP) WarmupWait(_ context.Context, _ []backend.Handle) error