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 AgentMetadata
- type Client
- func (c *Client) Close() error
- func (c *Client) DirectorRoot(version uint64) ([]byte, error)
- func (c *Client) GetTransactionalStoreMetadata() (*Metadata, 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) TargetFiles(targetFiles []string) (map[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) TimestampExpires() (time.Time, error)
- func (c *Client) UnsafeTargetsMeta() ([]byte, error)
- type ClientOption
- type CoreAgentClient
- func NewCoreAgentClientWithNewTransactionalStore(dbMetadata *Metadata, orgUUIDProvider OrgUUIDProvider, options ...ClientOption) (c *CoreAgentClient, err error)
- func NewCoreAgentClientWithRecreatedTransactionalStore(dbMetadata *Metadata, orgUUIDProvider OrgUUIDProvider, options ...ClientOption) (c *CoreAgentClient, err error)
- type MetaState
- type Metadata
- type OrgUUIDProvider
- type State
- type TUFVersions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentMetadata ¶ added in v0.73.0
type AgentMetadata struct {
Version string `json:"version"`
APIKeyHash string `json:"api-key-hash"`
CreationTime time.Time `json:"creation-time"`
URL string `json:"url"`
}
AgentMetadata is data stored in bolt DB to determine whether or not the agent has changed and the RC cache should be cleared
type Client ¶
Client is an uptane client
func (*Client) DirectorRoot ¶
DirectorRoot returns a director root
func (*Client) GetTransactionalStoreMetadata ¶ added in v0.73.0
GetTransactionalStoreMetadata returns metadata that creates the underlying boltDB instance
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) TargetFiles ¶ added in v0.62.0
TargetFiles returns the content of various multiple target files 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 verifies and returns the current raw targets.json meta of this uptane client
func (*Client) TimestampExpires ¶ added in v0.65.0
TimestampExpires returns the expiry time of the current up-to-date timestamp.json
func (*Client) UnsafeTargetsMeta ¶ added in v0.65.0
UnsafeTargetsMeta returns the current raw targets.json meta of this uptane client without verifying
type ClientOption ¶
type ClientOption func(c *Client)
ClientOption describes a function in charge of changing the uptane client
func WithConfigRootOverride ¶
func WithConfigRootOverride(site string, configRootOverride string) ClientOption
WithConfigRootOverride overrides config root
func WithDirectorRootOverride ¶
func WithDirectorRootOverride(site string, directorRootOverride string) ClientOption
WithDirectorRootOverride overrides director root
type CoreAgentClient ¶ added in v0.59.0
type CoreAgentClient struct {
*Client
// contains filtered or unexported fields
}
CoreAgentClient is an uptane client that fetches the latest configs from the Core Agent
func NewCoreAgentClientWithNewTransactionalStore ¶ added in v0.73.0
func NewCoreAgentClientWithNewTransactionalStore(dbMetadata *Metadata, orgUUIDProvider OrgUUIDProvider, options ...ClientOption) (c *CoreAgentClient, err error)
NewCoreAgentClientWithNewTransactionalStore creates a new uptane client with a new transactional store
func NewCoreAgentClientWithRecreatedTransactionalStore ¶ added in v0.73.0
func NewCoreAgentClientWithRecreatedTransactionalStore(dbMetadata *Metadata, orgUUIDProvider OrgUUIDProvider, options ...ClientOption) (c *CoreAgentClient, err error)
NewCoreAgentClientWithRecreatedTransactionalStore creates a new uptane client with a recreated transactional store
func (*CoreAgentClient) Update ¶ added in v0.59.0
func (c *CoreAgentClient) Update(response *pbgo.LatestConfigsResponse) error
Update updates the uptane client and rollbacks in case of error
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