client

package
v1.1.0-0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 16, 2024 License: BSD-3-Clause Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrNoRootKeys       = errors.New("tuf: no root keys found in local meta store")
	ErrInsufficientKeys = errors.New("tuf: insufficient keys to meet threshold")
	ErrNoLocalSnapshot  = errors.New("tuf: no snapshot stored locally")
)
View Source 
var DefaultHTTPRetries = &HTTPRemoteRetries{
	Delay: time.Second,
	Total: 10 * time.Second,
}

Functions

func IsNotFound 

func IsNotFound(err error) bool

Types

type Client 

type Client struct {

	// MaxDelegations limits by default the number of delegations visited for any
	// target
	MaxDelegations int

	// MaxRootRotations limits the number of downloaded roots in 1.0.19 root updater
	MaxRootRotations int
	// contains filtered or unexported fields
}

Client provides methods for fetching updates from a remote repository and downloading remote target files.

func NewClient 

func NewClient(local LocalStore, remote RemoteStore) *Client

func (*Client) Download 

func (c *Client) Download(name string, dest Destination) (err error)

Download downloads the given target file from remote storage into dest.

dest will be deleted and an error returned in the following situations:

  • The target does not exist in the local targets.json
  • Failed to fetch the chain of delegations accessible from local snapshot.json
  • The target does not exist in any targets
  • Metadata cannot be generated for the downloaded data
  • Generated metadata does not match local metadata for the given file
  • Size of the download does not match if the reported size is known and incorrect

func (*Client) DownloadBatch 

func (c *Client) DownloadBatch(targetFiles map[string]Destination) (err error)

DownloadBatch is a batched version of Download.

func (*Client) Init 

func (c *Client) Init(rootJSON []byte) error

Init initializes a local repository from root metadata.

The root's keys are extracted from the root and saved in local storage. Root expiration is not checked. It is expected that rootJSON was securely distributed with the software being updated.

func (*Client) Target 

func (c *Client) Target(name string) (data.TargetFileMeta, error)

Target returns the target metadata for a specific target if it exists, searching from top-level level targets then through all delegations. If it does not, ErrNotFound will be returned.

func (*Client) TargetBatch 

func (c *Client) TargetBatch(names []string) (data.TargetFiles, error)

TargetBatch is a batched version of Target.

func (*Client) Targets 

func (c *Client) Targets() (data.TargetFiles, error)

Targets returns the complete list of available top-level targets.

func (*Client) Update 

func (c *Client) Update() (data.TargetFiles, error)

Update downloads and verifies remote metadata and returns updated targets. It always performs root update (5.2 and 5.3) section of the v1.0.19 spec.

https://theupdateframework.github.io/specification/v1.0.19/index.html#load-trusted-root

func (*Client) UpdateRoots 

func (c *Client) UpdateRoots() error

func (*Client) VerifyDigest 

func (c *Client) VerifyDigest(digest string, digestAlg string, length int64, path string) error

type Destination 

type Destination interface {
	io.Writer
	Delete() error
}

type ErrDecodeFailed 

type ErrDecodeFailed struct {
	File string
	Err  error
}

func (ErrDecodeFailed) Error 

func (e ErrDecodeFailed) Error() string

type ErrDownloadFailed 

type ErrDownloadFailed struct {
	File string
	Err  error
}

func (ErrDownloadFailed) Error 

func (e ErrDownloadFailed) Error() string

type ErrInvalidURL 

type ErrInvalidURL struct {
	URL string
}

func (ErrInvalidURL) Error 

func (e ErrInvalidURL) Error() string

type ErrMaxDelegations 

type ErrMaxDelegations struct {
	Target          string
	MaxDelegations  int
	SnapshotVersion int64
}

func (ErrMaxDelegations) Error 

func (e ErrMaxDelegations) Error() string

type ErrMetaTooLarge 

type ErrMetaTooLarge struct {
	Name    string
	Size    int64
	MaxSize int64
}

func (ErrMetaTooLarge) Error 

func (e ErrMetaTooLarge) Error() string

type ErrMissingRemoteMetadata 

type ErrMissingRemoteMetadata struct {
	Name string
}

func (ErrMissingRemoteMetadata) Error 

func (e ErrMissingRemoteMetadata) Error() string

type ErrNotFound 

type ErrNotFound struct {
	File string
}

func (ErrNotFound) Error 

func (e ErrNotFound) Error() string

type ErrRoleNotInSnapshot 

type ErrRoleNotInSnapshot struct {
	Role            string
	SnapshotVersion int64
}

func (ErrRoleNotInSnapshot) Error 

func (e ErrRoleNotInSnapshot) Error() string

type ErrUnknownTarget 

type ErrUnknownTarget struct {
	Name            string
	SnapshotVersion int64
}

func (ErrUnknownTarget) Error 

func (e ErrUnknownTarget) Error() string

type ErrWrongSize 

type ErrWrongSize struct {
	File     string
	Actual   int64
	Expected int64
}

func (ErrWrongSize) Error 

func (e ErrWrongSize) Error() string

type FileRemoteStore 

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

func NewFileRemoteStore 

func NewFileRemoteStore(fsys fs.FS, targetDir string) (*FileRemoteStore, error)

FileRemoteStore provides a RemoteStore interface compatible implementation that can be used where the RemoteStore is backed by a fs.FS. This is useful for example in air-gapped environments where there's no possibility to make outbound network connections. By having this be a fs.FS instead of directories allows the repository to be backed by something that's not persisted to disk.

func (*FileRemoteStore) GetMeta 

func (f *FileRemoteStore) GetMeta(name string) (io.ReadCloser, int64, error)

func (*FileRemoteStore) GetTarget 

func (f *FileRemoteStore) GetTarget(name string) (io.ReadCloser, int64, error)

type HTTPRemoteOptions 

type HTTPRemoteOptions struct {
	MetadataPath string
	TargetsPath  string
	UserAgent    string
	Retries      *HTTPRemoteRetries
}

type HTTPRemoteRetries 

type HTTPRemoteRetries struct {
	Delay time.Duration
	Total time.Duration
}

type LocalStore 

type LocalStore interface {
	io.Closer

	// GetMeta returns top-level metadata from local storage. The keys are
	// in the form `ROLE.json`, with ROLE being a valid top-level role.
	GetMeta() (map[string]json.RawMessage, error)

	// SetMeta persists the given top-level metadata in local storage, the
	// name taking the same format as the keys returned by GetMeta.
	SetMeta(name string, meta json.RawMessage) error

	// DeleteMeta deletes a given metadata.
	DeleteMeta(name string) error
}

LocalStore is local storage for downloaded top-level metadata.

func MemoryLocalStore 

func MemoryLocalStore() LocalStore

type RemoteStore 

type RemoteStore interface {
	// GetMeta downloads the given metadata from remote storage.
	//
	// `name` is the filename of the metadata (e.g. "root.json")
	//
	// `err` is ErrNotFound if the given file does not exist.
	//
	// `size` is the size of the stream, -1 indicating an unknown length.
	GetMeta(name string) (stream io.ReadCloser, size int64, err error)

	// GetTarget downloads the given target file from remote storage.
	//
	// `path` is the path of the file relative to the root of the remote
	//        targets directory (e.g. "/path/to/file.txt").
	//
	// `err` is ErrNotFound if the given file does not exist.
	//
	// `size` is the size of the stream, -1 indicating an unknown length.
	GetTarget(path string) (stream io.ReadCloser, size int64, err error)
}

RemoteStore downloads top-level metadata and target files from a remote repository.

func HTTPRemoteStore 

func HTTPRemoteStore(baseURL string, opts *HTTPRemoteOptions, client *http.Client) (RemoteStore, error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.