Documentation
¶
Index ¶
- Variables
- type CertificateAuthority
- func (*CertificateAuthority) Descriptor() ([]byte, []int)deprecated
- func (x *CertificateAuthority) GetCertChain() *v1.X509CertificateChain
- func (x *CertificateAuthority) GetSubject() *v1.DistinguishedName
- func (x *CertificateAuthority) GetUri() string
- func (x *CertificateAuthority) GetValidFor() *v1.TimeRange
- func (*CertificateAuthority) ProtoMessage()
- func (x *CertificateAuthority) ProtoReflect() protoreflect.Message
- func (x *CertificateAuthority) Reset()
- func (x *CertificateAuthority) String() string
- type TransparencyLogInstance
- func (*TransparencyLogInstance) Descriptor() ([]byte, []int)deprecated
- func (x *TransparencyLogInstance) GetBaseUrl() string
- func (x *TransparencyLogInstance) GetHashAlgorithm() v1.HashAlgorithm
- func (x *TransparencyLogInstance) GetLogId() *v1.LogId
- func (x *TransparencyLogInstance) GetPublicKey() *v1.PublicKey
- func (*TransparencyLogInstance) ProtoMessage()
- func (x *TransparencyLogInstance) ProtoReflect() protoreflect.Message
- func (x *TransparencyLogInstance) Reset()
- func (x *TransparencyLogInstance) String() string
- type TrustedRoot
- func (*TrustedRoot) Descriptor() ([]byte, []int)deprecated
- func (x *TrustedRoot) GetCertificateAuthorities() []*CertificateAuthority
- func (x *TrustedRoot) GetCtlogs() []*TransparencyLogInstance
- func (x *TrustedRoot) GetMediaType() string
- func (x *TrustedRoot) GetTimestampAuthorities() []*CertificateAuthority
- func (x *TrustedRoot) GetTlogs() []*TransparencyLogInstance
- func (*TrustedRoot) ProtoMessage()
- func (x *TrustedRoot) ProtoReflect() protoreflect.Message
- func (x *TrustedRoot) Reset()
- func (x *TrustedRoot) String() string
Constants ¶
This section is empty.
Variables ¶
var File_sigstore_trustroot_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type CertificateAuthority ¶
type CertificateAuthority struct { // The root certificate MUST be self-signed, and so the subject and // issuer are the same. Subject *v1.DistinguishedName `protobuf:"bytes,1,opt,name=subject,proto3" json:"subject,omitempty"` // The URI identifies the certificate authority. // // It is RECOMMENDED that the URI is the base URL for the certificate // authority, that can be provided to any SDK/client provided // by the certificate authority to interact with the certificate // authority. Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"` // The certificate chain for this CA. CertChain *v1.X509CertificateChain `protobuf:"bytes,3,opt,name=cert_chain,json=certChain,proto3" json:"cert_chain,omitempty"` // The time the *entire* chain was valid. This is at max the // longest interval when *all* certificates in the chain were valid, // but it MAY be shorter. Clients MUST check timestamps against *both* // the `valid_for` time range *and* the entire certificate chain. // // The TimeRange should be considered valid *inclusive* of the // endpoints. ValidFor *v1.TimeRange `protobuf:"bytes,4,opt,name=valid_for,json=validFor,proto3" json:"valid_for,omitempty"` // contains filtered or unexported fields }
CertificateAuthority enlists the information required to identify which CA to use and perform signature verification.
func (*CertificateAuthority) Descriptor
deprecated
func (*CertificateAuthority) Descriptor() ([]byte, []int)
Deprecated: Use CertificateAuthority.ProtoReflect.Descriptor instead.
func (*CertificateAuthority) GetCertChain ¶
func (x *CertificateAuthority) GetCertChain() *v1.X509CertificateChain
func (*CertificateAuthority) GetSubject ¶
func (x *CertificateAuthority) GetSubject() *v1.DistinguishedName
func (*CertificateAuthority) GetUri ¶
func (x *CertificateAuthority) GetUri() string
func (*CertificateAuthority) GetValidFor ¶
func (x *CertificateAuthority) GetValidFor() *v1.TimeRange
func (*CertificateAuthority) ProtoMessage ¶
func (*CertificateAuthority) ProtoMessage()
func (*CertificateAuthority) ProtoReflect ¶
func (x *CertificateAuthority) ProtoReflect() protoreflect.Message
func (*CertificateAuthority) Reset ¶
func (x *CertificateAuthority) Reset()
func (*CertificateAuthority) String ¶
func (x *CertificateAuthority) String() string
type TransparencyLogInstance ¶
type TransparencyLogInstance struct { // The base URL at which can be used to URLs for the client. BaseUrl string `protobuf:"bytes,1,opt,name=base_url,json=baseUrl,proto3" json:"base_url,omitempty"` // The hash algorithm used for the Merkle Tree. HashAlgorithm v1.HashAlgorithm `` /* 143-byte string literal not displayed */ // The public key used to verify signatures generated by the log. // This attribute contains the signature algorithm used by the log. PublicKey *v1.PublicKey `protobuf:"bytes,3,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"` // The unique identifier for this transparency log. LogId *v1.LogId `protobuf:"bytes,4,opt,name=log_id,json=logId,proto3" json:"log_id,omitempty"` // contains filtered or unexported fields }
TransparencyLogInstance describes the immutable parameters from a transparency log. See https://www.rfc-editor.org/rfc/rfc9162.html#name-log-parameters for more details. The included parameters are the minimal set required to identify a log, and verify an inclusion proof/promise.
func (*TransparencyLogInstance) Descriptor
deprecated
func (*TransparencyLogInstance) Descriptor() ([]byte, []int)
Deprecated: Use TransparencyLogInstance.ProtoReflect.Descriptor instead.
func (*TransparencyLogInstance) GetBaseUrl ¶
func (x *TransparencyLogInstance) GetBaseUrl() string
func (*TransparencyLogInstance) GetHashAlgorithm ¶
func (x *TransparencyLogInstance) GetHashAlgorithm() v1.HashAlgorithm
func (*TransparencyLogInstance) GetLogId ¶
func (x *TransparencyLogInstance) GetLogId() *v1.LogId
func (*TransparencyLogInstance) GetPublicKey ¶
func (x *TransparencyLogInstance) GetPublicKey() *v1.PublicKey
func (*TransparencyLogInstance) ProtoMessage ¶
func (*TransparencyLogInstance) ProtoMessage()
func (*TransparencyLogInstance) ProtoReflect ¶
func (x *TransparencyLogInstance) ProtoReflect() protoreflect.Message
func (*TransparencyLogInstance) Reset ¶
func (x *TransparencyLogInstance) Reset()
func (*TransparencyLogInstance) String ¶
func (x *TransparencyLogInstance) String() string
type TrustedRoot ¶
type TrustedRoot struct { // MUST be application/vnd.dev.sigstore.trustedroot+json;version=0.1 MediaType string `protobuf:"bytes,1,opt,name=media_type,json=mediaType,proto3" json:"media_type,omitempty"` // A set of trusted Rekor servers. Tlogs []*TransparencyLogInstance `protobuf:"bytes,2,rep,name=tlogs,proto3" json:"tlogs,omitempty"` // A set of trusted certificate authorities (e.g Fulcio), and any // intermediate certificates they provide. // If a CA is issuing multiple intermediate certificate, each // combination shall be represented as separate chain. I.e, a single // root cert may appear in multiple chains but with different // intermediate and/or leaf certificates. // The certificates are intended to be used for verifying artifact // signatures. CertificateAuthorities []*CertificateAuthority `` /* 127-byte string literal not displayed */ // A set of trusted certificate transparency logs. Ctlogs []*TransparencyLogInstance `protobuf:"bytes,4,rep,name=ctlogs,proto3" json:"ctlogs,omitempty"` // A set of trusted timestamping authorities. TimestampAuthorities []*CertificateAuthority `protobuf:"bytes,5,rep,name=timestamp_authorities,json=timestampAuthorities,proto3" json:"timestamp_authorities,omitempty"` // contains filtered or unexported fields }
TrustedRoot describes the client's complete set of trusted entities. How the TrustedRoot is populated is not specified, but can be a combination of many sources such as TUF repositories, files on disk etc.
The TrustedRoot is not meant to be used for any artifact verification, only to capture the complete/global set of trusted verification materials. When verifying an artifact, based on the artifact and policies, a selection of keys/authorities are expected to be extracted and provided to the verification function. This way the set of keys/authorities can be kept to a minimal set by the policy to gain better control over what signatures that are allowed.
The embedded transparency logs, CT logs, CAs and TSAs MUST include any previously used instance -- otherwise signatures made in the past cannot be verified.
All the listed instances SHOULD be sorted by the 'valid_for' in ascending order, that is, the oldest instance first. Only the last instance is allowed to have their 'end' timestamp unset. All previous instances MUST have a closed interval of validity. The last instance MAY have a closed interval. Clients MUST accept instances that overlaps in time, if not clients may experience problems during rotations of verification materials.
To be able to manage planned rotations of either transparency logs or certificate authorities, clienst MUST accept lists of instances where the last instance have a 'valid_for' that belongs to the future. This should not be a problem as clients SHOULD first seek the trust root for a suitable instance before creating a per artifact trust root (that is, a sub-set of the complete trust root) that is used for verification.
func (*TrustedRoot) Descriptor
deprecated
func (*TrustedRoot) Descriptor() ([]byte, []int)
Deprecated: Use TrustedRoot.ProtoReflect.Descriptor instead.
func (*TrustedRoot) GetCertificateAuthorities ¶
func (x *TrustedRoot) GetCertificateAuthorities() []*CertificateAuthority
func (*TrustedRoot) GetCtlogs ¶
func (x *TrustedRoot) GetCtlogs() []*TransparencyLogInstance
func (*TrustedRoot) GetMediaType ¶
func (x *TrustedRoot) GetMediaType() string
func (*TrustedRoot) GetTimestampAuthorities ¶
func (x *TrustedRoot) GetTimestampAuthorities() []*CertificateAuthority
func (*TrustedRoot) GetTlogs ¶
func (x *TrustedRoot) GetTlogs() []*TransparencyLogInstance
func (*TrustedRoot) ProtoMessage ¶
func (*TrustedRoot) ProtoMessage()
func (*TrustedRoot) ProtoReflect ¶
func (x *TrustedRoot) ProtoReflect() protoreflect.Message
func (*TrustedRoot) Reset ¶
func (x *TrustedRoot) Reset()
func (*TrustedRoot) String ¶
func (x *TrustedRoot) String() string