Documentation
¶
Overview ¶
Package uptane contains the logic needed to perform the Uptane verification checks against stored TUF metadata and the associated config files.
Index ¶
- type Client
- func (c *Client) DirectorRoot(version uint64) ([]byte, error)
- func (c *Client) State() (State, error)
- func (c *Client) StoredOrgUUID() (string, error)
- func (c *Client) TUFVersionState() (TUFVersions, error)
- func (c *Client) TargetFile(path string) ([]byte, error)
- func (c *Client) Targets() (data.TargetFiles, error)
- func (c *Client) TargetsCustom() ([]byte, error)
- func (c *Client) TargetsMeta() ([]byte, error)
- func (c *Client) Update(response *pbgo.LatestConfigsResponse) error
- type ClientOption
- type MetaState
- type OrgUUIDProvider
- type State
- type TUFVersions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client is an uptane client
func NewClient ¶
func NewClient(cacheDB *bbolt.DB, cacheKey string, orgUUIDProvider OrgUUIDProvider, options ...ClientOption) (c *Client, err error)
NewClient creates a new uptane client
func (*Client) DirectorRoot ¶
DirectorRoot returns a director root
func (*Client) StoredOrgUUID ¶
StoredOrgUUID returns the org UUID given by the backend
func (*Client) TUFVersionState ¶
func (c *Client) TUFVersionState() (TUFVersions, error)
TUFVersionState TODO <remote-config>
func (*Client) TargetFile ¶
TargetFile returns the content of a target if the repository is in a verified state
func (*Client) Targets ¶
func (c *Client) Targets() (data.TargetFiles, error)
Targets returns the current targets of this uptane client
func (*Client) TargetsCustom ¶
TargetsCustom returns the current targets custom of this uptane client
func (*Client) TargetsMeta ¶
TargetsMeta returns the current raw targets.json meta of this uptane client
type ClientOption ¶
type ClientOption func(c *Client)
ClientOption describes a function in charge of changing the uptane client
func WithConfigRootOverride ¶
func WithConfigRootOverride(configRootOverride string) ClientOption
WithConfigRootOverride overrides config root
func WithDirectorRootOverride ¶
func WithDirectorRootOverride(directorRootOverride string) ClientOption
WithDirectorRootOverride overrides director root
type OrgUUIDProvider ¶
OrgUUIDProvider is a provider of the agent org UUID
type State ¶
type State struct {
ConfigState map[string]MetaState
DirectorState map[string]MetaState
TargetFilenames map[string]string
}
State represents the state of an uptane client
func (*State) ConfigRootVersion ¶
ConfigRootVersion returns the version of the config root.json file
func (*State) ConfigSnapshotVersion ¶
ConfigSnapshotVersion returns the version of the config snapshot.json file
func (*State) DirectorRootVersion ¶
DirectorRootVersion returns the version of the director root.json file
func (*State) DirectorTargetsVersion ¶
DirectorTargetsVersion returns the version of the director targets.json file
Source Files