Documentation ¶
Index ¶
- Constants
- Variables
- type SignatureInfo
- func (*SignatureInfo) Descriptor() ([]byte, []int)deprecated
- func (x *SignatureInfo) GetSignatureAlgorithm() string
- func (x *SignatureInfo) GetVerificationKeyId() string
- func (x *SignatureInfo) GetVerificationKeyVersion() string
- func (*SignatureInfo) ProtoMessage()
- func (x *SignatureInfo) ProtoReflect() protoreflect.Message
- func (x *SignatureInfo) Reset()
- func (x *SignatureInfo) String() string
- type TEKSignature
- func (*TEKSignature) Descriptor() ([]byte, []int)deprecated
- func (x *TEKSignature) GetBatchNum() int32
- func (x *TEKSignature) GetBatchSize() int32
- func (x *TEKSignature) GetSignature() []byte
- func (x *TEKSignature) GetSignatureInfo() *SignatureInfo
- func (*TEKSignature) ProtoMessage()
- func (x *TEKSignature) ProtoReflect() protoreflect.Message
- func (x *TEKSignature) Reset()
- func (x *TEKSignature) String() string
- type TEKSignatureList
- func (*TEKSignatureList) Descriptor() ([]byte, []int)deprecated
- func (x *TEKSignatureList) GetSignatures() []*TEKSignature
- func (*TEKSignatureList) ProtoMessage()
- func (x *TEKSignatureList) ProtoReflect() protoreflect.Message
- func (x *TEKSignatureList) Reset()
- func (x *TEKSignatureList) String() string
- type TemporaryExposureKey
- func (*TemporaryExposureKey) Descriptor() ([]byte, []int)deprecated
- func (x *TemporaryExposureKey) GetDaysSinceOnsetOfSymptoms() int32
- func (x *TemporaryExposureKey) GetKeyData() []byte
- func (x *TemporaryExposureKey) GetReportType() TemporaryExposureKey_ReportType
- func (x *TemporaryExposureKey) GetRollingPeriod() int32
- func (x *TemporaryExposureKey) GetRollingStartIntervalNumber() int32
- func (x *TemporaryExposureKey) GetTransmissionRiskLevel() int32deprecated
- func (x *TemporaryExposureKey) GetVariantOfConcern() TemporaryExposureKey_VariantOfConcern
- func (*TemporaryExposureKey) ProtoMessage()
- func (x *TemporaryExposureKey) ProtoReflect() protoreflect.Message
- func (x *TemporaryExposureKey) Reset()
- func (x *TemporaryExposureKey) String() string
- type TemporaryExposureKeyExport
- func (*TemporaryExposureKeyExport) Descriptor() ([]byte, []int)deprecated
- func (x *TemporaryExposureKeyExport) GetBatchNum() int32
- func (x *TemporaryExposureKeyExport) GetBatchSize() int32
- func (x *TemporaryExposureKeyExport) GetEndTimestamp() uint64
- func (x *TemporaryExposureKeyExport) GetKeys() []*TemporaryExposureKey
- func (x *TemporaryExposureKeyExport) GetRegion() string
- func (x *TemporaryExposureKeyExport) GetRevisedKeys() []*TemporaryExposureKey
- func (x *TemporaryExposureKeyExport) GetSignatureInfos() []*SignatureInfo
- func (x *TemporaryExposureKeyExport) GetStartTimestamp() uint64
- func (*TemporaryExposureKeyExport) ProtoMessage()
- func (x *TemporaryExposureKeyExport) ProtoReflect() protoreflect.Message
- func (x *TemporaryExposureKeyExport) Reset()
- func (x *TemporaryExposureKeyExport) String() string
- type TemporaryExposureKey_ReportType
- func (TemporaryExposureKey_ReportType) Descriptor() protoreflect.EnumDescriptor
- func (x TemporaryExposureKey_ReportType) Enum() *TemporaryExposureKey_ReportType
- func (TemporaryExposureKey_ReportType) EnumDescriptor() ([]byte, []int)deprecated
- func (x TemporaryExposureKey_ReportType) Number() protoreflect.EnumNumber
- func (x TemporaryExposureKey_ReportType) String() string
- func (TemporaryExposureKey_ReportType) Type() protoreflect.EnumType
- func (x *TemporaryExposureKey_ReportType) UnmarshalJSON(b []byte) errordeprecated
- type TemporaryExposureKey_VariantOfConcern
- func (TemporaryExposureKey_VariantOfConcern) Descriptor() protoreflect.EnumDescriptor
- func (x TemporaryExposureKey_VariantOfConcern) Enum() *TemporaryExposureKey_VariantOfConcern
- func (TemporaryExposureKey_VariantOfConcern) EnumDescriptor() ([]byte, []int)deprecated
- func (x TemporaryExposureKey_VariantOfConcern) Number() protoreflect.EnumNumber
- func (x TemporaryExposureKey_VariantOfConcern) String() string
- func (TemporaryExposureKey_VariantOfConcern) Type() protoreflect.EnumType
- func (x *TemporaryExposureKey_VariantOfConcern) UnmarshalJSON(b []byte) errordeprecated
Constants ¶
const ( Default_TemporaryExposureKey_RollingPeriod = int32(144) Default_TemporaryExposureKey_VariantOfConcern = TemporaryExposureKey_VARIANT_TYPE_UNKNOWN )
Default values for TemporaryExposureKey fields.
Variables ¶
var ( TemporaryExposureKey_ReportType_name = map[int32]string{ 0: "UNKNOWN", 1: "CONFIRMED_TEST", 2: "CONFIRMED_CLINICAL_DIAGNOSIS", 3: "SELF_REPORT", 4: "RECURSIVE", 5: "REVOKED", } TemporaryExposureKey_ReportType_value = map[string]int32{ "UNKNOWN": 0, "CONFIRMED_TEST": 1, "CONFIRMED_CLINICAL_DIAGNOSIS": 2, "SELF_REPORT": 3, "RECURSIVE": 4, "REVOKED": 5, } )
Enum value maps for TemporaryExposureKey_ReportType.
var ( TemporaryExposureKey_VariantOfConcern_name = map[int32]string{ 0: "VARIANT_TYPE_UNKNOWN", 1: "VARIANT_TYPE_1", 2: "VARIANT_TYPE_2", 3: "VARIANT_TYPE_3", 4: "VARIANT_TYPE_4", } TemporaryExposureKey_VariantOfConcern_value = map[string]int32{ "VARIANT_TYPE_UNKNOWN": 0, "VARIANT_TYPE_1": 1, "VARIANT_TYPE_2": 2, "VARIANT_TYPE_3": 3, "VARIANT_TYPE_4": 4, } )
Enum value maps for TemporaryExposureKey_VariantOfConcern.
var File_internal_pb_export_export_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type SignatureInfo ¶
type SignatureInfo struct { // Key version for rollovers // Must be in character class [a-zA-Z0-9_]. E.g., 'v1' VerificationKeyVersion *string `protobuf:"bytes,3,opt,name=verification_key_version,json=verificationKeyVersion" json:"verification_key_version,omitempty"` // Alias with which to identify public key to be used for verification // Must be in character class [a-zA-Z0-9_] // For cross-compatibility with Apple, use MCC // (https://en.wikipedia.org/wiki/Mobile_country_code). VerificationKeyId *string `protobuf:"bytes,4,opt,name=verification_key_id,json=verificationKeyId" json:"verification_key_id,omitempty"` // ASN.1 OID for Algorithm Identifier. Supported algorithms are // either 1.2.840.10045.4.3.2 or 1.2.840.10045.4.3.4 SignatureAlgorithm *string `protobuf:"bytes,5,opt,name=signature_algorithm,json=signatureAlgorithm" json:"signature_algorithm,omitempty"` // contains filtered or unexported fields }
func (*SignatureInfo) Descriptor
deprecated
func (*SignatureInfo) Descriptor() ([]byte, []int)
Deprecated: Use SignatureInfo.ProtoReflect.Descriptor instead.
func (*SignatureInfo) GetSignatureAlgorithm ¶
func (x *SignatureInfo) GetSignatureAlgorithm() string
func (*SignatureInfo) GetVerificationKeyId ¶
func (x *SignatureInfo) GetVerificationKeyId() string
func (*SignatureInfo) GetVerificationKeyVersion ¶
func (x *SignatureInfo) GetVerificationKeyVersion() string
func (*SignatureInfo) ProtoMessage ¶
func (*SignatureInfo) ProtoMessage()
func (*SignatureInfo) ProtoReflect ¶
func (x *SignatureInfo) ProtoReflect() protoreflect.Message
func (*SignatureInfo) Reset ¶
func (x *SignatureInfo) Reset()
func (*SignatureInfo) String ¶
func (x *SignatureInfo) String() string
type TEKSignature ¶
type TEKSignature struct { // Info about the signing key, version, algorithm, etc. SignatureInfo *SignatureInfo `protobuf:"bytes,1,opt,name=signature_info,json=signatureInfo" json:"signature_info,omitempty"` // E.g., Batch 2 of 10 // Must match fields from TemporaryExposureKeyExport, see // documentation on that message. BatchNum *int32 `protobuf:"varint,2,opt,name=batch_num,json=batchNum" json:"batch_num,omitempty"` BatchSize *int32 `protobuf:"varint,3,opt,name=batch_size,json=batchSize" json:"batch_size,omitempty"` // Signature in X9.62 format (ASN.1 SEQUENCE of two INTEGER fields) Signature []byte `protobuf:"bytes,4,opt,name=signature" json:"signature,omitempty"` // contains filtered or unexported fields }
func (*TEKSignature) Descriptor
deprecated
func (*TEKSignature) Descriptor() ([]byte, []int)
Deprecated: Use TEKSignature.ProtoReflect.Descriptor instead.
func (*TEKSignature) GetBatchNum ¶
func (x *TEKSignature) GetBatchNum() int32
func (*TEKSignature) GetBatchSize ¶
func (x *TEKSignature) GetBatchSize() int32
func (*TEKSignature) GetSignature ¶
func (x *TEKSignature) GetSignature() []byte
func (*TEKSignature) GetSignatureInfo ¶
func (x *TEKSignature) GetSignatureInfo() *SignatureInfo
func (*TEKSignature) ProtoMessage ¶
func (*TEKSignature) ProtoMessage()
func (*TEKSignature) ProtoReflect ¶
func (x *TEKSignature) ProtoReflect() protoreflect.Message
func (*TEKSignature) Reset ¶
func (x *TEKSignature) Reset()
func (*TEKSignature) String ¶
func (x *TEKSignature) String() string
type TEKSignatureList ¶
type TEKSignatureList struct { // When there are multiple signatures, they must be sorted in time order // by first effective date for the signing key in descending order. // The most recent effective signing key must appear first. // There is a limit of 10 signature infos per export file (mobile OS may // not check anything after that). Signatures []*TEKSignature `protobuf:"bytes,1,rep,name=signatures" json:"signatures,omitempty"` // contains filtered or unexported fields }
func (*TEKSignatureList) Descriptor
deprecated
func (*TEKSignatureList) Descriptor() ([]byte, []int)
Deprecated: Use TEKSignatureList.ProtoReflect.Descriptor instead.
func (*TEKSignatureList) GetSignatures ¶
func (x *TEKSignatureList) GetSignatures() []*TEKSignature
func (*TEKSignatureList) ProtoMessage ¶
func (*TEKSignatureList) ProtoMessage()
func (*TEKSignatureList) ProtoReflect ¶
func (x *TEKSignatureList) ProtoReflect() protoreflect.Message
func (*TEKSignatureList) Reset ¶
func (x *TEKSignatureList) Reset()
func (*TEKSignatureList) String ¶
func (x *TEKSignatureList) String() string
type TemporaryExposureKey ¶
type TemporaryExposureKey struct { // Key of infected user KeyData []byte `protobuf:"bytes,1,opt,name=key_data,json=keyData" json:"key_data,omitempty"` // Varying risks associated with exposure depending on type of verification // Ignored by the v1.5 client API when report_type is set. // // Deprecated: Do not use. TransmissionRiskLevel *int32 `protobuf:"varint,2,opt,name=transmission_risk_level,json=transmissionRiskLevel" json:"transmission_risk_level,omitempty"` // The interval number since epoch for which a key starts RollingStartIntervalNumber *int32 `` /* 137-byte string literal not displayed */ // Increments of 10 minutes describing how long a key is valid RollingPeriod *int32 `protobuf:"varint,4,opt,name=rolling_period,json=rollingPeriod,def=144" json:"rolling_period,omitempty"` // defaults to 24 hours // Type of diagnosis associated with a key. ReportType *TemporaryExposureKey_ReportType `protobuf:"varint,5,opt,name=report_type,json=reportType,enum=TemporaryExposureKey_ReportType" json:"report_type,omitempty"` // Number of days elapsed between symptom onset and the TEK being used. // E.g. 2 means TEK is 2 days after onset of symptoms. DaysSinceOnsetOfSymptoms *int32 `` /* 135-byte string literal not displayed */ // Type of variant of concern associated with a key. VariantOfConcern *TemporaryExposureKey_VariantOfConcern `` /* 154-byte string literal not displayed */ // contains filtered or unexported fields }
func (*TemporaryExposureKey) Descriptor
deprecated
func (*TemporaryExposureKey) Descriptor() ([]byte, []int)
Deprecated: Use TemporaryExposureKey.ProtoReflect.Descriptor instead.
func (*TemporaryExposureKey) GetDaysSinceOnsetOfSymptoms ¶
func (x *TemporaryExposureKey) GetDaysSinceOnsetOfSymptoms() int32
func (*TemporaryExposureKey) GetKeyData ¶
func (x *TemporaryExposureKey) GetKeyData() []byte
func (*TemporaryExposureKey) GetReportType ¶
func (x *TemporaryExposureKey) GetReportType() TemporaryExposureKey_ReportType
func (*TemporaryExposureKey) GetRollingPeriod ¶
func (x *TemporaryExposureKey) GetRollingPeriod() int32
func (*TemporaryExposureKey) GetRollingStartIntervalNumber ¶
func (x *TemporaryExposureKey) GetRollingStartIntervalNumber() int32
func (*TemporaryExposureKey) GetTransmissionRiskLevel
deprecated
func (x *TemporaryExposureKey) GetTransmissionRiskLevel() int32
Deprecated: Do not use.
func (*TemporaryExposureKey) GetVariantOfConcern ¶ added in v0.36.0
func (x *TemporaryExposureKey) GetVariantOfConcern() TemporaryExposureKey_VariantOfConcern
func (*TemporaryExposureKey) ProtoMessage ¶
func (*TemporaryExposureKey) ProtoMessage()
func (*TemporaryExposureKey) ProtoReflect ¶
func (x *TemporaryExposureKey) ProtoReflect() protoreflect.Message
func (*TemporaryExposureKey) Reset ¶
func (x *TemporaryExposureKey) Reset()
func (*TemporaryExposureKey) String ¶
func (x *TemporaryExposureKey) String() string
type TemporaryExposureKeyExport ¶
type TemporaryExposureKeyExport struct { // Time window of keys in this file based on arrival to server, in UTC // seconds. start_timestamp, end_timestamp, and batch_num must be unique // at any given snapshot of the index for a server. If multiple // files are used for a specific time period, and batch_num/batch_size // are both 1 (See below), then offsetting the end_timestamp is the // suggested method for forcing uniqueness. StartTimestamp *uint64 `protobuf:"fixed64,1,opt,name=start_timestamp,json=startTimestamp" json:"start_timestamp,omitempty"` EndTimestamp *uint64 `protobuf:"fixed64,2,opt,name=end_timestamp,json=endTimestamp" json:"end_timestamp,omitempty"` // Region for which these keys came from (e.g., country) Region *string `protobuf:"bytes,3,opt,name=region" json:"region,omitempty"` // E.g., Batch 2 of 10. Ordinal, 1-based numbering. // Note: Not yet supported on iOS. Use values of 1 for both. BatchNum *int32 `protobuf:"varint,4,opt,name=batch_num,json=batchNum" json:"batch_num,omitempty"` BatchSize *int32 `protobuf:"varint,5,opt,name=batch_size,json=batchSize" json:"batch_size,omitempty"` // Information about signatures // If there are multiple entries, they must be ordered in descending // time order by signing key effective time (most recent one first). // There is a limit of 10 signature infos per export file (mobile OS may // not check anything after that). SignatureInfos []*SignatureInfo `protobuf:"bytes,6,rep,name=signature_infos,json=signatureInfos" json:"signature_infos,omitempty"` // The TemporaryExposureKeys for initial release of keys. // Keys should be included in this list for initial release, // whereas revised or revoked keys should go in revised_keys. Keys []*TemporaryExposureKey `protobuf:"bytes,7,rep,name=keys" json:"keys,omitempty"` // TemporaryExposureKeys that have changed status. // Keys should be included in this list if they have changed status // or have been revoked. RevisedKeys []*TemporaryExposureKey `protobuf:"bytes,8,rep,name=revised_keys,json=revisedKeys" json:"revised_keys,omitempty"` // contains filtered or unexported fields }
Protobuf definition for exports of confirmed temporary exposure keys.
The full file format is documented under "Exposure Key Export File Format and Verification" at https://www.google.com/covid19/exposurenotifications/
These files have a 16-byte, space-padded header before the protobuf data starts. They will be contained in a zip archive, alongside a signature file verifying the contents.
func (*TemporaryExposureKeyExport) Descriptor
deprecated
func (*TemporaryExposureKeyExport) Descriptor() ([]byte, []int)
Deprecated: Use TemporaryExposureKeyExport.ProtoReflect.Descriptor instead.
func (*TemporaryExposureKeyExport) GetBatchNum ¶
func (x *TemporaryExposureKeyExport) GetBatchNum() int32
func (*TemporaryExposureKeyExport) GetBatchSize ¶
func (x *TemporaryExposureKeyExport) GetBatchSize() int32
func (*TemporaryExposureKeyExport) GetEndTimestamp ¶
func (x *TemporaryExposureKeyExport) GetEndTimestamp() uint64
func (*TemporaryExposureKeyExport) GetKeys ¶
func (x *TemporaryExposureKeyExport) GetKeys() []*TemporaryExposureKey
func (*TemporaryExposureKeyExport) GetRegion ¶
func (x *TemporaryExposureKeyExport) GetRegion() string
func (*TemporaryExposureKeyExport) GetRevisedKeys ¶
func (x *TemporaryExposureKeyExport) GetRevisedKeys() []*TemporaryExposureKey
func (*TemporaryExposureKeyExport) GetSignatureInfos ¶
func (x *TemporaryExposureKeyExport) GetSignatureInfos() []*SignatureInfo
func (*TemporaryExposureKeyExport) GetStartTimestamp ¶
func (x *TemporaryExposureKeyExport) GetStartTimestamp() uint64
func (*TemporaryExposureKeyExport) ProtoMessage ¶
func (*TemporaryExposureKeyExport) ProtoMessage()
func (*TemporaryExposureKeyExport) ProtoReflect ¶
func (x *TemporaryExposureKeyExport) ProtoReflect() protoreflect.Message
func (*TemporaryExposureKeyExport) Reset ¶
func (x *TemporaryExposureKeyExport) Reset()
func (*TemporaryExposureKeyExport) String ¶
func (x *TemporaryExposureKeyExport) String() string
type TemporaryExposureKey_ReportType ¶
type TemporaryExposureKey_ReportType int32
Data type representing why this key was published.
const ( TemporaryExposureKey_UNKNOWN TemporaryExposureKey_ReportType = 0 // Never returned by the client API. TemporaryExposureKey_CONFIRMED_TEST TemporaryExposureKey_ReportType = 1 TemporaryExposureKey_CONFIRMED_CLINICAL_DIAGNOSIS TemporaryExposureKey_ReportType = 2 TemporaryExposureKey_SELF_REPORT TemporaryExposureKey_ReportType = 3 TemporaryExposureKey_RECURSIVE TemporaryExposureKey_ReportType = 4 TemporaryExposureKey_REVOKED TemporaryExposureKey_ReportType = 5 // Used to revoke a key, never returned by client API. )
func (TemporaryExposureKey_ReportType) Descriptor ¶
func (TemporaryExposureKey_ReportType) Descriptor() protoreflect.EnumDescriptor
func (TemporaryExposureKey_ReportType) Enum ¶
func (x TemporaryExposureKey_ReportType) Enum() *TemporaryExposureKey_ReportType
func (TemporaryExposureKey_ReportType) EnumDescriptor
deprecated
func (TemporaryExposureKey_ReportType) EnumDescriptor() ([]byte, []int)
Deprecated: Use TemporaryExposureKey_ReportType.Descriptor instead.
func (TemporaryExposureKey_ReportType) Number ¶
func (x TemporaryExposureKey_ReportType) Number() protoreflect.EnumNumber
func (TemporaryExposureKey_ReportType) String ¶
func (x TemporaryExposureKey_ReportType) String() string
func (TemporaryExposureKey_ReportType) Type ¶
func (TemporaryExposureKey_ReportType) Type() protoreflect.EnumType
func (*TemporaryExposureKey_ReportType) UnmarshalJSON
deprecated
func (x *TemporaryExposureKey_ReportType) UnmarshalJSON(b []byte) error
Deprecated: Do not use.
type TemporaryExposureKey_VariantOfConcern ¶ added in v0.36.0
type TemporaryExposureKey_VariantOfConcern int32
Data type representing a variant of concern.
const ( TemporaryExposureKey_VARIANT_TYPE_UNKNOWN TemporaryExposureKey_VariantOfConcern = 0 TemporaryExposureKey_VARIANT_TYPE_1 TemporaryExposureKey_VariantOfConcern = 1 // Vaccine is effective TemporaryExposureKey_VARIANT_TYPE_2 TemporaryExposureKey_VariantOfConcern = 2 // Highly transmissive TemporaryExposureKey_VARIANT_TYPE_3 TemporaryExposureKey_VariantOfConcern = 3 // High severity TemporaryExposureKey_VARIANT_TYPE_4 TemporaryExposureKey_VariantOfConcern = 4 // Vaccine breakthrough )
func (TemporaryExposureKey_VariantOfConcern) Descriptor ¶ added in v0.36.0
func (TemporaryExposureKey_VariantOfConcern) Descriptor() protoreflect.EnumDescriptor
func (TemporaryExposureKey_VariantOfConcern) EnumDescriptor
deprecated
added in
v0.36.0
func (TemporaryExposureKey_VariantOfConcern) EnumDescriptor() ([]byte, []int)
Deprecated: Use TemporaryExposureKey_VariantOfConcern.Descriptor instead.
func (TemporaryExposureKey_VariantOfConcern) Number ¶ added in v0.36.0
func (x TemporaryExposureKey_VariantOfConcern) Number() protoreflect.EnumNumber
func (TemporaryExposureKey_VariantOfConcern) String ¶ added in v0.36.0
func (x TemporaryExposureKey_VariantOfConcern) String() string
func (TemporaryExposureKey_VariantOfConcern) Type ¶ added in v0.36.0
func (TemporaryExposureKey_VariantOfConcern) Type() protoreflect.EnumType
func (*TemporaryExposureKey_VariantOfConcern) UnmarshalJSON
deprecated
added in
v0.36.0
func (x *TemporaryExposureKey_VariantOfConcern) UnmarshalJSON(b []byte) error
Deprecated: Do not use.