Documentation ¶
Index ¶
- Constants
- Variables
- func CheckHashes(payload []byte, hashes Hashes) error
- func CheckValidHashStructures(hashes Hashes) error
- func DefaultExpires(role string) time.Time
- func IsDelegation(role string) bool
- func RestrictDelegationPathPrefixes(parentPaths, delegationPaths []string) []string
- func SetDefaultExpiryTimes(times map[string]time.Duration)
- func SetTUFTypes(ts map[string]string)
- func ValidRole(name string) bool
- func ValidTUFType(typ, role string) bool
- type BaseRole
- type DelegationRole
- type Delegations
- type ECDSAPrivateKey
- type ECDSAPublicKey
- type ECDSAx509PublicKey
- type ED25519PrivateKey
- type ED25519PublicKey
- type ErrInvalidChecksum
- type ErrInvalidMetadata
- type ErrInvalidRole
- type ErrMismatchedChecksum
- type ErrMissingMeta
- type ErrNoSuchRole
- type FileMeta
- type Files
- type Hashes
- type KeyList
- type KeyPair
- type Keys
- type PrivateKey
- type PublicKey
- type RSAPrivateKey
- type RSAPublicKey
- type RSAx509PublicKey
- type Role
- type Root
- type RootRole
- type SigAlgorithm
- type Signature
- type Signed
- type SignedCommon
- type SignedMeta
- type SignedRoot
- type SignedSnapshot
- type SignedTargets
- func (t *SignedTargets) AddDelegation(role *Role, keys []*PublicKey) error
- func (t *SignedTargets) AddTarget(path string, meta FileMeta)
- func (t *SignedTargets) BuildDelegationRole(roleName string) (DelegationRole, error)
- func (t SignedTargets) GetMeta(path string) *FileMeta
- func (t SignedTargets) GetValidDelegations(parent DelegationRole) []DelegationRole
- func (t *SignedTargets) MarshalJSON() ([]byte, error)
- func (t *SignedTargets) ToSigned() (*Signed, error)
- type SignedTimestamp
- type Snapshot
- type TUFKey
- type Targets
- type Timestamp
- type UnknownPrivateKey
- type UnknownPublicKey
Constants ¶
const ( CanonicalRootRole = "root" CanonicalTargetsRole = "targets" CanonicalSnapshotRole = "snapshot" CanonicalTimestampRole = "timestamp" )
Canonical base role names
const ( ED25519Key = "ed25519" RSAKey = "rsa" RSAx509Key = "rsa-x509" ECDSAKey = "ecdsa" ECDSAx509Key = "ecdsa-x509" )
Key types
Variables ¶
var BaseRoles = []string{ CanonicalRootRole, CanonicalTargetsRole, CanonicalSnapshotRole, CanonicalTimestampRole, }
BaseRoles is an easy to iterate list of the top level roles.
NotaryDefaultHashes contains the default supported hash algorithms.
var TUFTypes = map[string]string{
CanonicalRootRole: "Root",
CanonicalTargetsRole: "Targets",
CanonicalSnapshotRole: "Snapshot",
CanonicalTimestampRole: "Timestamp",
}
TUFTypes is the set of metadata types
Functions ¶
func CheckHashes ¶ added in v0.3.0
CheckHashes verifies all the checksums specified by the "hashes" of the payload.
func CheckValidHashStructures ¶ added in v0.3.0
CheckValidHashStructures returns an error, or nil, depending on whether the content of the hashes is valid or not.
func DefaultExpires ¶
DefaultExpires gets the default expiry time for the given role
func IsDelegation ¶
IsDelegation checks if the role is a delegation or a root role
func RestrictDelegationPathPrefixes ¶
RestrictDelegationPathPrefixes returns the list of valid delegationPaths that are prefixed by parentPaths
func SetDefaultExpiryTimes ¶
SetDefaultExpiryTimes allows one to change the default expiries.
func SetTUFTypes ¶
SetTUFTypes allows one to override some or all of the default type names in TUF.
func ValidRole ¶
ValidRole only determines the name is semantically correct. For target delegated roles, it does NOT check the the appropriate parent roles exist.
func ValidTUFType ¶
ValidTUFType checks if the given type is valid for the role
Types ¶
type BaseRole ¶
BaseRole is an internal representation of a root/targets/snapshot/timestamp role, with its public keys included
func NewBaseRole ¶
NewBaseRole creates a new BaseRole object with the provided parameters
func (BaseRole) Equals ¶ added in v0.3.0
Equals returns whether this BaseRole equals another BaseRole
func (BaseRole) ListKeyIDs ¶
ListKeyIDs retrieves the list of key IDs valid for this role
type DelegationRole ¶
DelegationRole is an internal representation of a delegation role, with its public keys included
func (DelegationRole) CheckPaths ¶
func (d DelegationRole) CheckPaths(path string) bool
CheckPaths checks if a given path is valid for the role
func (DelegationRole) IsParentOf ¶
func (d DelegationRole) IsParentOf(child DelegationRole) bool
IsParentOf returns whether the passed in delegation role is the direct child of this role, determined by delegation name. Ex: targets/a is a direct parent of targets/a/b, but targets/a is not a direct parent of targets/a/b/c
func (DelegationRole) Restrict ¶
func (d DelegationRole) Restrict(child DelegationRole) (DelegationRole, error)
Restrict restricts the paths and path hash prefixes for the passed in delegation role, returning a copy of the role with validated paths as if it was a direct child
type Delegations ¶
Delegations holds a tier of targets delegations
func NewDelegations ¶
func NewDelegations() *Delegations
NewDelegations initializes an empty Delegations object
type ECDSAPrivateKey ¶
type ECDSAPrivateKey struct { PublicKey // contains filtered or unexported fields }
ECDSAPrivateKey represents a private ECDSA key
func NewECDSAPrivateKey ¶
func NewECDSAPrivateKey(public PublicKey, private []byte) (*ECDSAPrivateKey, error)
NewECDSAPrivateKey initializes a new ECDSA private key
func (ECDSAPrivateKey) CryptoSigner ¶
CryptoSigner returns the underlying crypto.Signer for use cases where we need the default signature or public key functionality (like when we generate certificates)
func (ECDSAPrivateKey) Private ¶
func (k ECDSAPrivateKey) Private() []byte
Private return the serialized private bytes of the key
func (ECDSAPrivateKey) Sign ¶
func (k ECDSAPrivateKey) Sign(rand io.Reader, msg []byte, opts crypto.SignerOpts) (signature []byte, err error)
Sign creates an ecdsa signature
func (ECDSAPrivateKey) SignatureAlgorithm ¶
func (k ECDSAPrivateKey) SignatureAlgorithm() SigAlgorithm
SignatureAlgorithm returns the SigAlgorithm for a ECDSAPrivateKey
type ECDSAPublicKey ¶
type ECDSAPublicKey struct {
TUFKey
}
ECDSAPublicKey represents an ECDSA key using a raw serialization of the public key
func NewECDSAPublicKey ¶
func NewECDSAPublicKey(public []byte) *ECDSAPublicKey
NewECDSAPublicKey initializes a new public key with the ECDSAKey type
type ECDSAx509PublicKey ¶
type ECDSAx509PublicKey struct {
TUFKey
}
ECDSAx509PublicKey represents an ECDSA key using an x509 cert as the serialized format of the public key
func NewECDSAx509PublicKey ¶
func NewECDSAx509PublicKey(public []byte) *ECDSAx509PublicKey
NewECDSAx509PublicKey initializes a new public key with the ECDSAx509Key type
type ED25519PrivateKey ¶
type ED25519PrivateKey struct { ED25519PublicKey // contains filtered or unexported fields }
ED25519PrivateKey represents a private ED25519 key
func NewED25519PrivateKey ¶
func NewED25519PrivateKey(public ED25519PublicKey, private []byte) (*ED25519PrivateKey, error)
NewED25519PrivateKey initialized a new ED25519 private key
func (ED25519PrivateKey) CryptoSigner ¶
func (k ED25519PrivateKey) CryptoSigner() crypto.Signer
CryptoSigner returns the ED25519PrivateKey which already implements crypto.Signer
func (ED25519PrivateKey) Private ¶
func (k ED25519PrivateKey) Private() []byte
Private return the serialized private bytes of the key
func (ED25519PrivateKey) Sign ¶
func (k ED25519PrivateKey) Sign(rand io.Reader, msg []byte, opts crypto.SignerOpts) (signature []byte, err error)
Sign creates an ed25519 signature
func (ED25519PrivateKey) SignatureAlgorithm ¶
func (k ED25519PrivateKey) SignatureAlgorithm() SigAlgorithm
SignatureAlgorithm returns the SigAlgorithm for a ED25519PrivateKey
type ED25519PublicKey ¶
type ED25519PublicKey struct {
TUFKey
}
ED25519PublicKey represents an ED25519 key using a raw serialization of the public key
func NewED25519PublicKey ¶
func NewED25519PublicKey(public []byte) *ED25519PublicKey
NewED25519PublicKey initializes a new public key with the ED25519Key type
type ErrInvalidChecksum ¶ added in v0.3.0
type ErrInvalidChecksum struct {
// contains filtered or unexported fields
}
ErrInvalidChecksum is the error to be returned when checksum is invalid
func (ErrInvalidChecksum) Error ¶ added in v0.3.0
func (e ErrInvalidChecksum) Error() string
type ErrInvalidMetadata ¶
type ErrInvalidMetadata struct {
// contains filtered or unexported fields
}
ErrInvalidMetadata is the error to be returned when metadata is invalid
func (ErrInvalidMetadata) Error ¶
func (e ErrInvalidMetadata) Error() string
type ErrInvalidRole ¶
ErrInvalidRole represents an error regarding a role. Typically something like a role for which sone of the public keys were not found in the TUF repo.
func (ErrInvalidRole) Error ¶
func (e ErrInvalidRole) Error() string
type ErrMismatchedChecksum ¶ added in v0.3.0
type ErrMismatchedChecksum struct {
// contains filtered or unexported fields
}
ErrMismatchedChecksum is the error to be returned when checksum is mismatched
func (ErrMismatchedChecksum) Error ¶ added in v0.3.0
func (e ErrMismatchedChecksum) Error() string
type ErrMissingMeta ¶
type ErrMissingMeta struct {
Role string
}
ErrMissingMeta - couldn't find the FileMeta object for a role or target
func (ErrMissingMeta) Error ¶
func (e ErrMissingMeta) Error() string
type ErrNoSuchRole ¶
type ErrNoSuchRole struct {
Role string
}
ErrNoSuchRole indicates the roles doesn't exist
func (ErrNoSuchRole) Error ¶
func (e ErrNoSuchRole) Error() string
type FileMeta ¶
type FileMeta struct { Length int64 `json:"length"` Hashes Hashes `json:"hashes"` Custom *json.RawMessage `json:"custom,omitempty"` }
FileMeta contains the size and hashes for a metadata or target file. Custom data can be optionally added.
type Files ¶
Files is the map of paths to file meta container in targets and delegations metadata files
type KeyList ¶
type KeyList []PublicKey
KeyList represents a list of keys
func (*KeyList) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface
type Keys ¶
Keys represents a map of key ID to PublicKey object. It's necessary to allow us to unmarshal into an interface via the json.Unmarshaller interface
func (*Keys) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface
type PrivateKey ¶
type PrivateKey interface { PublicKey Sign(rand io.Reader, msg []byte, opts crypto.SignerOpts) (signature []byte, err error) Private() []byte CryptoSigner() crypto.Signer SignatureAlgorithm() SigAlgorithm }
PrivateKey adds the ability to access the private key
func NewPrivateKey ¶
func NewPrivateKey(pubKey PublicKey, private []byte) (PrivateKey, error)
NewPrivateKey creates a new, correctly typed PrivateKey, using the UnknownPrivateKey catchall for unsupported ciphers
func UnmarshalPrivateKey ¶
func UnmarshalPrivateKey(data []byte) (PrivateKey, error)
UnmarshalPrivateKey is used to parse individual private keys in JSON
type PublicKey ¶
PublicKey is the necessary interface for public keys
func NewPublicKey ¶
NewPublicKey creates a new, correctly typed PublicKey, using the UnknownPublicKey catchall for unsupported ciphers
func PublicKeyFromPrivate ¶
func PublicKeyFromPrivate(pk PrivateKey) PublicKey
PublicKeyFromPrivate returns a new TUFKey based on a private key, with the private key bytes guaranteed to be nil.
func UnmarshalPublicKey ¶
UnmarshalPublicKey is used to parse individual public keys in JSON
type RSAPrivateKey ¶
type RSAPrivateKey struct { PublicKey // contains filtered or unexported fields }
RSAPrivateKey represents a private RSA key
func NewRSAPrivateKey ¶
func NewRSAPrivateKey(public PublicKey, private []byte) (*RSAPrivateKey, error)
NewRSAPrivateKey initialized a new RSA private key
func (RSAPrivateKey) CryptoSigner ¶
CryptoSigner returns the underlying crypto.Signer for use cases where we need the default signature or public key functionality (like when we generate certificates)
func (RSAPrivateKey) Private ¶
func (k RSAPrivateKey) Private() []byte
Private return the serialized private bytes of the key
func (RSAPrivateKey) Sign ¶
func (k RSAPrivateKey) Sign(rand io.Reader, msg []byte, opts crypto.SignerOpts) (signature []byte, err error)
Sign creates an rsa signature
func (RSAPrivateKey) SignatureAlgorithm ¶
func (k RSAPrivateKey) SignatureAlgorithm() SigAlgorithm
SignatureAlgorithm returns the SigAlgorithm for a RSAPrivateKey
type RSAPublicKey ¶
type RSAPublicKey struct {
TUFKey
}
RSAPublicKey represents an RSA key using a raw serialization of the public key
func NewRSAPublicKey ¶
func NewRSAPublicKey(public []byte) *RSAPublicKey
NewRSAPublicKey initializes a new public key with the RSA type
type RSAx509PublicKey ¶
type RSAx509PublicKey struct {
TUFKey
}
RSAx509PublicKey represents an RSA key using an x509 cert as the serialized format of the public key
func NewRSAx509PublicKey ¶
func NewRSAx509PublicKey(public []byte) *RSAx509PublicKey
NewRSAx509PublicKey initializes a new public key with the RSAx509Key type
type Role ¶
Role is a more verbose role as they appear in targets delegations Eventually should only be used for immediately before and after serialization/deserialization
func (Role) CheckPaths ¶
CheckPaths checks if a given path is valid for the role
func (*Role) RemoveKeys ¶
RemoveKeys removes the ids from the current list of key ids
func (*Role) RemovePaths ¶
RemovePaths removes the paths from the current list of role paths
type Root ¶
type Root struct { SignedCommon Keys Keys `json:"keys"` Roles map[string]*RootRole `json:"roles"` ConsistentSnapshot bool `json:"consistent_snapshot"` }
Root is the Signed component of a root.json
type RootRole ¶
RootRole is a cut down role as it appears in the root.json Eventually should only be used for immediately before and after serialization/deserialization
type SigAlgorithm ¶
type SigAlgorithm string
SigAlgorithm for types of signatures
const ( EDDSASignature SigAlgorithm = "eddsa" RSAPSSSignature SigAlgorithm = "rsapss" RSAPKCS1v15Signature SigAlgorithm = "rsapkcs1v15" ECDSASignature SigAlgorithm = "ecdsa" PyCryptoSignature SigAlgorithm = "pycrypto-pkcs#1 pss" )
Signature types
func (SigAlgorithm) String ¶
func (k SigAlgorithm) String() string
type Signature ¶
type Signature struct { KeyID string `json:"keyid"` Method SigAlgorithm `json:"method"` Signature []byte `json:"sig"` }
Signature is a signature on a piece of metadata
func (*Signature) UnmarshalJSON ¶
UnmarshalJSON does a custom unmarshalling of the signature JSON
type Signed ¶
type Signed struct { Signed *json.RawMessage `json:"signed"` Signatures []Signature `json:"signatures"` }
Signed is the high level, partially deserialized metadata object used to verify signatures before fully unpacking, or to add signatures before fully packing
type SignedCommon ¶
type SignedCommon struct { Type string `json:"_type"` Expires time.Time `json:"expires"` Version int `json:"version"` }
SignedCommon contains the fields common to the Signed component of all TUF metadata files
type SignedMeta ¶
type SignedMeta struct { Signed SignedCommon `json:"signed"` Signatures []Signature `json:"signatures"` }
SignedMeta is used in server validation where we only need signatures and common fields
type SignedRoot ¶
SignedRoot is a fully unpacked root.json
func NewRoot ¶
func NewRoot(keys map[string]PublicKey, roles map[string]*RootRole, consistent bool) (*SignedRoot, error)
NewRoot initializes a new SignedRoot with a set of keys, roles, and the consistent flag
func RootFromSigned ¶
func RootFromSigned(s *Signed) (*SignedRoot, error)
RootFromSigned fully unpacks a Signed object into a SignedRoot and ensures that it is a valid SignedRoot
func (SignedRoot) BuildBaseRole ¶
func (r SignedRoot) BuildBaseRole(roleName string) (BaseRole, error)
BuildBaseRole returns a copy of a BaseRole using the information in this SignedRoot for the specified role name. Will error for invalid role name or key metadata within this SignedRoot
func (SignedRoot) MarshalJSON ¶
func (r SignedRoot) MarshalJSON() ([]byte, error)
MarshalJSON returns the serialized form of SignedRoot as bytes
func (SignedRoot) ToSigned ¶
func (r SignedRoot) ToSigned() (*Signed, error)
ToSigned partially serializes a SignedRoot for further signing
type SignedSnapshot ¶
SignedSnapshot is a fully unpacked snapshot.json
func NewSnapshot ¶
func NewSnapshot(root *Signed, targets *Signed) (*SignedSnapshot, error)
NewSnapshot initilizes a SignedSnapshot with a given top level root and targets objects
func SnapshotFromSigned ¶
func SnapshotFromSigned(s *Signed) (*SignedSnapshot, error)
SnapshotFromSigned fully unpacks a Signed object into a SignedSnapshot
func (*SignedSnapshot) AddMeta ¶
func (sp *SignedSnapshot) AddMeta(role string, meta FileMeta)
AddMeta updates a role in the snapshot with new meta
func (*SignedSnapshot) DeleteMeta ¶
func (sp *SignedSnapshot) DeleteMeta(role string)
DeleteMeta removes a role from the snapshot. If the role doesn't exist in the snapshot, it's a noop.
func (*SignedSnapshot) GetMeta ¶
func (sp *SignedSnapshot) GetMeta(role string) (*FileMeta, error)
GetMeta gets the metadata for a particular role, returning an error if it's not found
func (*SignedSnapshot) MarshalJSON ¶
func (sp *SignedSnapshot) MarshalJSON() ([]byte, error)
MarshalJSON returns the serialized form of SignedSnapshot as bytes
func (*SignedSnapshot) ToSigned ¶
func (sp *SignedSnapshot) ToSigned() (*Signed, error)
ToSigned partially serializes a SignedSnapshot for further signing
type SignedTargets ¶
SignedTargets is a fully unpacked targets.json, or target delegation json file
func NewTargets ¶
func NewTargets() *SignedTargets
NewTargets intiializes a new empty SignedTargets object
func TargetsFromSigned ¶
func TargetsFromSigned(s *Signed, roleName string) (*SignedTargets, error)
TargetsFromSigned fully unpacks a Signed object into a SignedTargets, given a role name (so it can validate the SignedTargets object)
func (*SignedTargets) AddDelegation ¶
func (t *SignedTargets) AddDelegation(role *Role, keys []*PublicKey) error
AddDelegation will add a new delegated role with the given keys, ensuring the keys either already exist, or are added to the map of delegation keys
func (*SignedTargets) AddTarget ¶
func (t *SignedTargets) AddTarget(path string, meta FileMeta)
AddTarget adds or updates the meta for the given path
func (*SignedTargets) BuildDelegationRole ¶
func (t *SignedTargets) BuildDelegationRole(roleName string) (DelegationRole, error)
BuildDelegationRole returns a copy of a DelegationRole using the information in this SignedTargets for the specified role name. Will error for invalid role name or key metadata within this SignedTargets. Path data is not validated.
func (SignedTargets) GetMeta ¶
func (t SignedTargets) GetMeta(path string) *FileMeta
GetMeta attempts to find the targets entry for the path. It will return nil in the case of the target not being found.
func (SignedTargets) GetValidDelegations ¶
func (t SignedTargets) GetValidDelegations(parent DelegationRole) []DelegationRole
GetValidDelegations filters the delegation roles specified in the signed targets, and only returns roles that are direct children and restricts their paths
func (*SignedTargets) MarshalJSON ¶
func (t *SignedTargets) MarshalJSON() ([]byte, error)
MarshalJSON returns the serialized form of SignedTargets as bytes
func (*SignedTargets) ToSigned ¶
func (t *SignedTargets) ToSigned() (*Signed, error)
ToSigned partially serializes a SignedTargets for further signing
type SignedTimestamp ¶
SignedTimestamp is a fully unpacked timestamp.json
func NewTimestamp ¶
func NewTimestamp(snapshot *Signed) (*SignedTimestamp, error)
NewTimestamp initializes a timestamp with an existing snapshot
func TimestampFromSigned ¶
func TimestampFromSigned(s *Signed) (*SignedTimestamp, error)
TimestampFromSigned parsed a Signed object into a fully unpacked SignedTimestamp
func (*SignedTimestamp) GetSnapshot ¶
func (ts *SignedTimestamp) GetSnapshot() (*FileMeta, error)
GetSnapshot gets the expected snapshot metadata hashes in the timestamp metadata, or nil if it doesn't exist
func (*SignedTimestamp) MarshalJSON ¶
func (ts *SignedTimestamp) MarshalJSON() ([]byte, error)
MarshalJSON returns the serialized form of SignedTimestamp as bytes
func (*SignedTimestamp) ToSigned ¶
func (ts *SignedTimestamp) ToSigned() (*Signed, error)
ToSigned partially serializes a SignedTimestamp such that it can be signed
type Snapshot ¶
type Snapshot struct { SignedCommon Meta Files `json:"meta"` }
Snapshot is the Signed component of a snapshot.json
type TUFKey ¶
type TUFKey struct { Type string `json:"keytype"` Value KeyPair `json:"keyval"` // contains filtered or unexported fields }
TUFKey is the structure used for both public and private keys in TUF. Normally it would make sense to use a different structures for public and private keys, but that would change the key ID algorithm (since the canonical JSON would be different). This structure should normally be accessed through the PublicKey or PrivateKey interfaces.
type Targets ¶
type Targets struct { SignedCommon Targets Files `json:"targets"` Delegations Delegations `json:"delegations,omitempty"` }
Targets is the Signed components of a targets.json or delegation json file
type Timestamp ¶
type Timestamp struct { SignedCommon Meta Files `json:"meta"` }
Timestamp is the Signed component of a timestamp.json
type UnknownPrivateKey ¶
type UnknownPrivateKey struct { TUFKey // contains filtered or unexported fields }
UnknownPrivateKey is a catchall for unsupported key types
func (UnknownPrivateKey) CryptoSigner ¶
func (k UnknownPrivateKey) CryptoSigner() crypto.Signer
CryptoSigner returns the UnknownPrivateKey which already implements crypto.Signer
func (UnknownPrivateKey) Private ¶
func (k UnknownPrivateKey) Private() []byte
Private return the serialized private bytes of the key
func (UnknownPrivateKey) Sign ¶
func (k UnknownPrivateKey) Sign(rand io.Reader, msg []byte, opts crypto.SignerOpts) (signature []byte, err error)
Sign on an UnknownPrivateKey raises an error because the client does not know how to sign with this key type.
func (UnknownPrivateKey) SignatureAlgorithm ¶
func (k UnknownPrivateKey) SignatureAlgorithm() SigAlgorithm
SignatureAlgorithm returns the SigAlgorithm for an UnknownPrivateKey
type UnknownPublicKey ¶
type UnknownPublicKey struct {
TUFKey
}
UnknownPublicKey is a catchall for key types that are not supported