tuf

Documentation

Index

• func ClientFromRemote(_ context.Context, mirror string, rootJSON []byte, targets string) (*client.Client, error)
• func ClientFromSerializedMirror(_ context.Context, repo, rootJSON []byte, targets, stripPrefix string) (*client.Client, error)
• func CompressFS(fsys fs.FS, buf io.Writer, skipDirs map[string]bool) error
• func FromContextOrDefaults(ctx context.Context) time.Duration
• func GetTrustedRoot(ctx context.Context) (*root.TrustedRoot, error)
• func ToContext(ctx context.Context, duration time.Duration) context.Context
• func Uncompress(src io.Reader, dst string) error
• func UncompressMemFS(src io.Reader, stripPrefix string) (fs.FS, error)

Functions

func ClientFromRemote

func ClientFromRemote(_ context.Context, mirror string, rootJSON []byte, targets string) (*client.Client, error)

ClientFromRemote will construct a TUF client from a root, and mirror

func ClientFromSerializedMirror

func ClientFromSerializedMirror(_ context.Context, repo, rootJSON []byte, targets, stripPrefix string) (*client.Client, error)

ClientFromSerializedMirror will construct a TUF client by unzip/untar the repository and constructing an in-memory TUF client for it. Will also Init/Update it.

func CompressFS

func CompressFS(fsys fs.FS, buf io.Writer, skipDirs map[string]bool) error

func FromContextOrDefaults

func FromContextOrDefaults(ctx context.Context) time.Duration

FromContextOrDefaults returns a stored trustrootResyncPeriod if attached. If not found, it returns a default duration

func GetTrustedRoot

func GetTrustedRoot(ctx context.Context) (*root.TrustedRoot, error)

GetTrustedRoot returns the trusted root for the TUF repository.

func ToContext

func ToContext(ctx context.Context, duration time.Duration) context.Context

ToContext returns a context that includes a key trustrootResyncPeriod set to the included duration

func Uncompress

func Uncompress(src io.Reader, dst string) error

func UncompressMemFS

func UncompressMemFS(src io.Reader, stripPrefix string) (fs.FS, error)

UncompressMemFS takes a TUF repository that's been compressed with CompressFS and returns FS backed by memory.