Documentation
¶
Index ¶
- Constants
- Variables
- func BatchSaveManifests(dst string, manifestList map[string]*Manifest) error
- func CheckExpiry(fname, expires string) error
- func ComponentManifestFilename(id string) string
- func ExpiresAfter(m1, m2 ValidManifest) error
- func GenAndSaveKeys(keys map[string][]*KeyInfo, ty string, num int, dir string) error
- func Init(dst, keyDir string, initTime time.Time) (err error)
- func IsExpirationError(err error) bool
- func IsSignatureError(err error) bool
- func ReadManifestDir(dir string, roles ...string) (map[string]ValidManifest, error)
- func RenewManifest(m ValidManifest, startTime time.Time)
- func RootManifestFilename(version uint) string
- func SaveKeyInfo(key *KeyInfo, ty, dir string) error
- func SignAndWrite(out io.Writer, role ValidManifest, keys ...*KeyInfo) error
- func SignManifestData(data []byte, ki *KeyInfo) ([]byte, error)
- func WriteManifest(out io.Writer, m *Manifest) error
- func WriteManifestFile(fname string, m *Manifest) error
- type Component
- func (manifest *Component) Base() *SignedBase
- func (manifest *Component) Filename() string
- func (manifest *Component) HasNightly(platform string) bool
- func (manifest *Component) VersionItem(plat, ver string, includeYanked bool) *VersionItem
- func (manifest *Component) VersionList(platform string) map[string]VersionItem
- func (manifest *Component) VersionListWithYanked(platform string) map[string]VersionItem
- type ComponentItem
- type ExpirationError
- type FileHash
- type FileVersion
- type FsManifests
- func (ms *FsManifests) ComponentInstalled(component, version string) (bool, error)
- func (ms *FsManifests) InstallComponent(reader io.Reader, targetDir, component, version, filename string, ...) error
- func (ms *FsManifests) KeyStore() *KeyStore
- func (ms *FsManifests) LoadComponentManifest(item *ComponentItem, filename string) (*Component, error)
- func (ms *FsManifests) LoadManifest(role ValidManifest) (*Manifest, bool, error)
- func (ms *FsManifests) ManifestVersion(filename string) uint
- func (ms *FsManifests) SaveComponentManifest(manifest *Manifest, filename string) error
- func (ms *FsManifests) SaveManifest(manifest *Manifest, filename string) error
- func (ms *FsManifests) TargetRootDir() string
- type Index
- type KeyInfo
- func (ki *KeyInfo) ID() (string, error)
- func (ki *KeyInfo) IsPrivate() bool
- func (ki *KeyInfo) Public() (*KeyInfo, error)
- func (ki *KeyInfo) SignManifest(m ValidManifest) (string, error)
- func (ki *KeyInfo) Signature(payload []byte) (string, error)
- func (ki *KeyInfo) Verify(payload []byte, sig string) error
- type KeyStore
- type LocalManifests
- type Manifest
- func ReadComponentManifest(input io.Reader, com *Component, item *ComponentItem, keys *KeyStore) (*Manifest, error)
- func ReadManifest(input io.Reader, role ValidManifest, keys *KeyStore) (*Manifest, error)
- func ReadNoVerify(input io.Reader, role ValidManifest) (*Manifest, error)
- func SignManifest(role ValidManifest, keys ...*KeyInfo) (*Manifest, error)
- type MockInstalled
- type MockManifests
- func (ms *MockManifests) ComponentInstalled(component, version string) (bool, error)
- func (ms *MockManifests) InstallComponent(reader io.Reader, targetDir string, component, version, filename string, ...) error
- func (ms *MockManifests) KeyStore() *KeyStore
- func (ms *MockManifests) LoadComponentManifest(item *ComponentItem, filename string) (*Component, error)
- func (ms *MockManifests) LoadManifest(role ValidManifest) (*Manifest, bool, error)
- func (ms *MockManifests) ManifestVersion(filename string) uint
- func (ms *MockManifests) SaveComponentManifest(manifest *Manifest, filename string) error
- func (ms *MockManifests) SaveManifest(manifest *Manifest, filename string) error
- func (ms *MockManifests) TargetRootDir() string
- type Owner
- type RawManifest
- type Role
- type Root
- type Signature
- type SignatureError
- type SignedBase
- type Snapshot
- type Timestamp
- type ValidManifest
- type VersionItem
Constants ¶
const ( ManifestTypeRoot = "root" ManifestTypeIndex = "index" ManifestTypeSnapshot = "snapshot" ManifestTypeTimestamp = "timestamp" ManifestTypeComponent = "component" // Manifest URLs in a repository. ManifestURLRoot = "/root.json" ManifestURLIndex = "/index.json" ManifestURLSnapshot = "/snapshot.json" ManifestURLTimestamp = "/timestamp.json" // Manifest filenames when stored locally. ManifestFilenameRoot = "root.json" ManifestFilenameIndex = "index.json" ManifestFilenameSnapshot = "snapshot.json" ManifestFilenameTimestamp = "timestamp.json" // SpecVersion of current, maybe we could expand it later CurrentSpecVersion = "0.1.0" // AnyPlatform is the ID for platform independent components AnyPlatform = "any/any" // Acceptable values for hash kinds. SHA256 = "sha256" SHA512 = "sha512" )
Names of manifest ManifestsConfig
const ShortKeyIDLength = 16
ShortKeyIDLength is the number of bytes used for filenames
Variables ¶
var ErrorInsufficientKeys = stderrors.New("not enough keys supplied")
ErrorInsufficientKeys indicates that the key number is less than threshold
var ErrorNotPrivateKey = errors.New("not a private key")
ErrorNotPrivateKey indicate that it need a private key, but the supplied is not.
var ManifestsConfig = map[string]ty{ ManifestTypeRoot: { Filename: ManifestFilenameRoot, Versioned: true, Expire: time.Hour * 24 * 365, Threshold: 3, }, ManifestTypeIndex: { Filename: ManifestFilenameIndex, Versioned: true, Expire: time.Hour * 24 * 365, Threshold: 1, }, ManifestTypeComponent: { Filename: "", Versioned: true, Expire: time.Hour * 24 * 365 * 5, Threshold: 1, }, ManifestTypeSnapshot: { Filename: ManifestFilenameSnapshot, Versioned: false, Expire: time.Hour * 24 * 30, Threshold: 1, }, ManifestTypeTimestamp: { Filename: ManifestFilenameTimestamp, Versioned: false, Expire: time.Hour * 24 * 30, Threshold: 1, }, }
ManifestsConfig for different manifest ManifestsConfig
Functions ¶
func BatchSaveManifests ¶
BatchSaveManifests write a series of manifests to disk Manifest in the manifestList map should already be signed, they are not checked for signature again.
func CheckExpiry ¶
CheckExpiry return not nil if it's expired.
func ComponentManifestFilename ¶
ComponentManifestFilename returns the expected filename for the component manifest identified by id.
func ExpiresAfter ¶
func ExpiresAfter(m1, m2 ValidManifest) error
ExpiresAfter checks that manifest 1 expires after manifest 2 (or are equal) and returns an error otherwise.
func GenAndSaveKeys ¶
GenAndSaveKeys generate private keys to keys param and save key file to dir
func IsExpirationError ¶
IsExpirationError checks if the err is an ExpirationError.
func IsSignatureError ¶
IsSignatureError check if the err is SignatureError.
func ReadManifestDir ¶
func ReadManifestDir(dir string, roles ...string) (map[string]ValidManifest, error)
ReadManifestDir reads manifests from a dir
func RenewManifest ¶
func RenewManifest(m ValidManifest, startTime time.Time)
RenewManifest resets and extends the expire time of manifest
func RootManifestFilename ¶
RootManifestFilename returns the expected filename for the root manifest with the given version.
func SaveKeyInfo ¶
SaveKeyInfo saves a KeyInfo object to a JSON file
func SignAndWrite ¶
func SignAndWrite(out io.Writer, role ValidManifest, keys ...*KeyInfo) error
SignAndWrite creates a manifest and writes it to out.
func SignManifestData ¶ added in v1.3.0
SignManifestData add signatures to a manifest data
func WriteManifest ¶
WriteManifest writes a Manifest object to writer in JSON format
func WriteManifestFile ¶
WriteManifestFile writes a Manifest object to file in JSON format
Types ¶
type Component ¶
type Component struct { SignedBase ID string `json:"id"` Description string `json:"description"` Nightly string `json:"nightly"` // version of the latest daily build // platform -> version -> VersionItem Platforms map[string]map[string]VersionItem `json:"platforms"` }
Component manifest.
func NewComponent ¶
NewComponent creates a Component object
func (*Component) Base ¶
func (manifest *Component) Base() *SignedBase
Base implements ValidManifest
func (*Component) HasNightly ¶
HasNightly return true if the component has nightly version.
func (*Component) VersionItem ¶
func (manifest *Component) VersionItem(plat, ver string, includeYanked bool) *VersionItem
VersionItem returns VersionItem by platform and version
func (*Component) VersionList ¶ added in v1.0.9
func (manifest *Component) VersionList(platform string) map[string]VersionItem
VersionList return all versions exclude yanked versions
func (*Component) VersionListWithYanked ¶ added in v1.0.9
func (manifest *Component) VersionListWithYanked(platform string) map[string]VersionItem
VersionListWithYanked return all versions include yanked versions
type ComponentItem ¶
type ComponentItem struct { Yanked bool `json:"yanked"` Owner string `json:"owner"` URL string `json:"url"` Standalone bool `json:"standalone"` Hidden bool `json:"hidden"` }
ComponentItem object
type ExpirationError ¶
type ExpirationError struct {
// contains filtered or unexported fields
}
ExpirationError the a manifest has expired.
func (*ExpirationError) Error ¶
func (s *ExpirationError) Error() string
type FileVersion ¶
FileVersion is just a version number.
type FsManifests ¶
type FsManifests struct {
// contains filtered or unexported fields
}
FsManifests represents a collection of v1 manifests on disk. Invariant: any manifest written to disk should be valid, but may have expired. (It is also possible the manifest was ok when written and has expired since).
func NewManifests ¶
func NewManifests(profile *localdata.Profile) (*FsManifests, error)
NewManifests creates a new FsManifests with local store at root. There must exist a trusted root.json.
func (*FsManifests) ComponentInstalled ¶
func (ms *FsManifests) ComponentInstalled(component, version string) (bool, error)
ComponentInstalled implements LocalManifests.
func (*FsManifests) InstallComponent ¶
func (ms *FsManifests) InstallComponent(reader io.Reader, targetDir, component, version, filename string, noExpand bool) error
InstallComponent implements LocalManifests.
func (*FsManifests) KeyStore ¶
func (ms *FsManifests) KeyStore() *KeyStore
KeyStore implements LocalManifests.
func (*FsManifests) LoadComponentManifest ¶
func (ms *FsManifests) LoadComponentManifest(item *ComponentItem, filename string) (*Component, error)
LoadComponentManifest implements LocalManifests.
func (*FsManifests) LoadManifest ¶
func (ms *FsManifests) LoadManifest(role ValidManifest) (*Manifest, bool, error)
LoadManifest implements LocalManifests.
func (*FsManifests) ManifestVersion ¶
func (ms *FsManifests) ManifestVersion(filename string) uint
ManifestVersion implements LocalManifests.
func (*FsManifests) SaveComponentManifest ¶
func (ms *FsManifests) SaveComponentManifest(manifest *Manifest, filename string) error
SaveComponentManifest implements LocalManifests.
func (*FsManifests) SaveManifest ¶
func (ms *FsManifests) SaveManifest(manifest *Manifest, filename string) error
SaveManifest implements LocalManifests.
func (*FsManifests) TargetRootDir ¶ added in v1.2.0
func (ms *FsManifests) TargetRootDir() string
TargetRootDir implements LocalManifests.
type Index ¶
type Index struct { SignedBase Owners map[string]Owner `json:"owners"` Components map[string]ComponentItem `json:"components"` DefaultComponents []string `json:"default_components"` }
Index manifest.
func (*Index) ComponentList ¶ added in v1.0.9
func (manifest *Index) ComponentList() map[string]ComponentItem
ComponentList returns non-yanked components
func (*Index) ComponentListWithYanked ¶ added in v1.0.9
func (manifest *Index) ComponentListWithYanked() map[string]ComponentItem
ComponentListWithYanked return all components
type KeyInfo ¶
type KeyInfo struct { Type string `json:"keytype"` Value map[string]string `json:"keyval"` Scheme string `json:"scheme"` }
KeyInfo is the manifest structure of a single key
func FreshKeyInfo ¶
FreshKeyInfo generates a new key pair and wraps it in a KeyInfo. The returned string is the key id.
func NewKeyInfo ¶
NewKeyInfo make KeyInfo from private key, public key should be load from json
func (*KeyInfo) SignManifest ¶ added in v1.3.0
func (ki *KeyInfo) SignManifest(m ValidManifest) (string, error)
SignManifest wrap Signature with the param manifest
type KeyStore ¶
KeyStore tracks roles, keys, etc. and verifies signatures against this metadata. (map[string]roleKeys)
type LocalManifests ¶
type LocalManifests interface { // SaveManifest saves a manifest to disk, it will overwrite filename if it exists. SaveManifest(manifest *Manifest, filename string) error // SaveComponentManifest saves a component manifest to disk, it will overwrite filename if it exists. SaveComponentManifest(manifest *Manifest, filename string) error // LoadManifest loads and validates the most recent manifest of role's type. The returned bool is true if the file // exists. LoadManifest(role ValidManifest) (*Manifest, bool, error) // LoadComponentManifest loads and validates the most recent manifest at filename. LoadComponentManifest(item *ComponentItem, filename string) (*Component, error) // ComponentInstalled is true if the version of component is present locally. ComponentInstalled(component, version string) (bool, error) // InstallComponent installs the component from the reader. InstallComponent(reader io.Reader, targetDir, component, version, filename string, noExpand bool) error // Return the local key store. KeyStore() *KeyStore // ManifestVersion opens filename, if it exists and is a manifest, returns its manifest version number. Otherwise // returns 0. ManifestVersion(filename string) uint // TargetRootDir returns the root directory of target TargetRootDir() string }
LocalManifests methods for accessing a store of manifests.
type Manifest ¶
type Manifest struct { // Signatures value Signatures []Signature `json:"signatures"` // Signed value; any value here must have the SignedBase base. Signed ValidManifest `json:"signed"` }
Manifest representation for ser/de.
func ReadComponentManifest ¶
func ReadComponentManifest(input io.Reader, com *Component, item *ComponentItem, keys *KeyStore) (*Manifest, error)
ReadComponentManifest reads a component manifest from input and validates it.
func ReadManifest ¶
ReadManifest reads a manifest from input and validates it, the result is stored in role, which must be a pointer type.
func ReadNoVerify ¶
func ReadNoVerify(input io.Reader, role ValidManifest) (*Manifest, error)
ReadNoVerify will read role from input and will not do any validation or verification. It is very dangerous to use this function and it should only be used to read trusted data from local storage.
func SignManifest ¶
func SignManifest(role ValidManifest, keys ...*KeyInfo) (*Manifest, error)
SignManifest signs a manifest with given private key
func (*Manifest) AddSignature ¶
AddSignature adds one or more signatures to the manifest
type MockInstalled ¶
MockInstalled is used by MockManifests to remember what was installed for a component.
type MockManifests ¶
type MockManifests struct { Manifests map[string]*Manifest Saved []string Installed map[string]MockInstalled Ks *KeyStore }
MockManifests is a LocalManifests implementation for testing.
func NewMockManifests ¶
func NewMockManifests() *MockManifests
NewMockManifests creates an empty MockManifests.
func (*MockManifests) ComponentInstalled ¶
func (ms *MockManifests) ComponentInstalled(component, version string) (bool, error)
ComponentInstalled implements LocalManifests.
func (*MockManifests) InstallComponent ¶
func (ms *MockManifests) InstallComponent(reader io.Reader, targetDir string, component, version, filename string, noExpand bool) error
InstallComponent implements LocalManifests.
func (*MockManifests) KeyStore ¶
func (ms *MockManifests) KeyStore() *KeyStore
KeyStore implements LocalManifests.
func (*MockManifests) LoadComponentManifest ¶
func (ms *MockManifests) LoadComponentManifest(item *ComponentItem, filename string) (*Component, error)
LoadComponentManifest implements LocalManifests.
func (*MockManifests) LoadManifest ¶
func (ms *MockManifests) LoadManifest(role ValidManifest) (*Manifest, bool, error)
LoadManifest implements LocalManifests.
func (*MockManifests) ManifestVersion ¶
func (ms *MockManifests) ManifestVersion(filename string) uint
ManifestVersion implements LocalManifests.
func (*MockManifests) SaveComponentManifest ¶
func (ms *MockManifests) SaveComponentManifest(manifest *Manifest, filename string) error
SaveComponentManifest implements LocalManifests.
func (*MockManifests) SaveManifest ¶
func (ms *MockManifests) SaveManifest(manifest *Manifest, filename string) error
SaveManifest implements LocalManifests.
func (*MockManifests) TargetRootDir ¶ added in v1.2.0
func (ms *MockManifests) TargetRootDir() string
TargetRootDir implements LocalManifests.
type Owner ¶
type Owner struct { Name string `json:"name"` Keys map[string]*KeyInfo `json:"keys"` Threshold int `json:"threshold"` }
Owner object.
type RawManifest ¶
type RawManifest struct { // Signatures value Signatures []Signature `json:"signatures"` // Signed value; raw json message Signed json.RawMessage `json:"signed"` }
RawManifest representation for ser/de.
type Role ¶
type Role struct { URL string `json:"url"` Keys map[string]*KeyInfo `json:"keys"` Threshold uint `json:"threshold"` }
Role object.
type Root ¶
type Root struct { SignedBase Roles map[string]*Role `json:"roles"` }
Root manifest.
type SignatureError ¶
type SignatureError struct {
// contains filtered or unexported fields
}
SignatureError the signature of a file is incorrect.
func (*SignatureError) Error ¶
func (s *SignatureError) Error() string
type SignedBase ¶
type SignedBase struct { Ty string `json:"_type"` SpecVersion string `json:"spec_version"` Expires string `json:"expires"` // 0 => no version specified Version uint `json:"version"` }
SignedBase represents parts of a manifest's signed value which are shared by all manifests.
func (*SignedBase) Filename ¶
func (s *SignedBase) Filename() string
Filename returns the unversioned name that the manifest should be saved as based on the type in s.
func (*SignedBase) SetExpiresAt ¶
func (s *SignedBase) SetExpiresAt(t time.Time)
SetExpiresAt set manifest expires at the specified time.
func (*SignedBase) Versioned ¶
func (s *SignedBase) Versioned() bool
Versioned indicates whether versioned versions of a manifest are saved, e.g., 42.foo.json.
type Snapshot ¶
type Snapshot struct { SignedBase Meta map[string]FileVersion `json:"meta"` }
Snapshot manifest.
func NewSnapshot ¶
NewSnapshot creates a Snapshot object.
func (*Snapshot) SetVersions ¶
SetVersions sets file versions to the snapshot
func (*Snapshot) VersionedURL ¶
func (manifest *Snapshot) VersionedURL(url string) (string, *FileVersion, error)
VersionedURL looks up url in the snapshot and returns a modified url with the version prefix, and that file's length.
type Timestamp ¶
type Timestamp struct { SignedBase Meta map[string]FileHash `json:"meta"` }
Timestamp manifest.
func NewTimestamp ¶
NewTimestamp creates a Timestamp object
func (*Timestamp) Base ¶
func (manifest *Timestamp) Base() *SignedBase
Base implements ValidManifest
func (*Timestamp) SetSnapshot ¶
SetSnapshot hashes a snapshot manifest and update the timestamp manifest
func (*Timestamp) SnapshotHash ¶
SnapshotHash returns the hashes of the snapshot manifest as specified in the timestamp manifest.
type ValidManifest ¶
type ValidManifest interface { // Base returns this manifest's SignedBase which is values common to all manifests. Base() *SignedBase // Filename returns the unversioned name that the manifest should be saved as based on its Go type. Filename() string // contains filtered or unexported methods }
ValidManifest is a manifest which includes SignedBase and can be validated.