exposure-notifications-server: github.com/google/exposure-notifications-server/internal/pb/export Index | Files

package export

import "github.com/google/exposure-notifications-server/internal/pb/export"

Index

Package Files

export.pb.go

Constants

const (
    Default_TemporaryExposureKey_RollingPeriod = int32(144)
)

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 File_internal_pb_export_export_proto protoreflect.FileDescriptor

type SignatureInfo Uses

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 Uses

func (*SignatureInfo) Descriptor() ([]byte, []int)

Deprecated: Use SignatureInfo.ProtoReflect.Descriptor instead.

func (*SignatureInfo) GetSignatureAlgorithm Uses

func (x *SignatureInfo) GetSignatureAlgorithm() string

func (*SignatureInfo) GetVerificationKeyId Uses

func (x *SignatureInfo) GetVerificationKeyId() string

func (*SignatureInfo) GetVerificationKeyVersion Uses

func (x *SignatureInfo) GetVerificationKeyVersion() string

func (*SignatureInfo) ProtoMessage Uses

func (*SignatureInfo) ProtoMessage()

func (*SignatureInfo) ProtoReflect Uses

func (x *SignatureInfo) ProtoReflect() protoreflect.Message

func (*SignatureInfo) Reset Uses

func (x *SignatureInfo) Reset()

func (*SignatureInfo) String Uses

func (x *SignatureInfo) String() string

type TEKSignature Uses

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
    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 Uses

func (*TEKSignature) Descriptor() ([]byte, []int)

Deprecated: Use TEKSignature.ProtoReflect.Descriptor instead.

func (*TEKSignature) GetBatchNum Uses

func (x *TEKSignature) GetBatchNum() int32

func (*TEKSignature) GetBatchSize Uses

func (x *TEKSignature) GetBatchSize() int32

func (*TEKSignature) GetSignature Uses

func (x *TEKSignature) GetSignature() []byte

func (*TEKSignature) GetSignatureInfo Uses

func (x *TEKSignature) GetSignatureInfo() *SignatureInfo

func (*TEKSignature) ProtoMessage Uses

func (*TEKSignature) ProtoMessage()

func (*TEKSignature) ProtoReflect Uses

func (x *TEKSignature) ProtoReflect() protoreflect.Message

func (*TEKSignature) Reset Uses

func (x *TEKSignature) Reset()

func (*TEKSignature) String Uses

func (x *TEKSignature) String() string

type TEKSignatureList Uses

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 Uses

func (*TEKSignatureList) Descriptor() ([]byte, []int)

Deprecated: Use TEKSignatureList.ProtoReflect.Descriptor instead.

func (*TEKSignatureList) GetSignatures Uses

func (x *TEKSignatureList) GetSignatures() []*TEKSignature

func (*TEKSignatureList) ProtoMessage Uses

func (*TEKSignatureList) ProtoMessage()

func (*TEKSignatureList) ProtoReflect Uses

func (x *TEKSignatureList) ProtoReflect() protoreflect.Message

func (*TEKSignatureList) Reset Uses

func (x *TEKSignatureList) Reset()

func (*TEKSignatureList) String Uses

func (x *TEKSignatureList) String() string

type TemporaryExposureKey Uses

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 `protobuf:"varint,3,opt,name=rolling_start_interval_number,json=rollingStartIntervalNumber" json:"rolling_start_interval_number,omitempty"`
    // 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 `protobuf:"zigzag32,6,opt,name=days_since_onset_of_symptoms,json=daysSinceOnsetOfSymptoms" json:"days_since_onset_of_symptoms,omitempty"`
    // contains filtered or unexported fields
}

func (*TemporaryExposureKey) Descriptor Uses

func (*TemporaryExposureKey) Descriptor() ([]byte, []int)

Deprecated: Use TemporaryExposureKey.ProtoReflect.Descriptor instead.

func (*TemporaryExposureKey) GetDaysSinceOnsetOfSymptoms Uses

func (x *TemporaryExposureKey) GetDaysSinceOnsetOfSymptoms() int32

func (*TemporaryExposureKey) GetKeyData Uses

func (x *TemporaryExposureKey) GetKeyData() []byte

func (*TemporaryExposureKey) GetReportType Uses

func (x *TemporaryExposureKey) GetReportType() TemporaryExposureKey_ReportType

func (*TemporaryExposureKey) GetRollingPeriod Uses

func (x *TemporaryExposureKey) GetRollingPeriod() int32

func (*TemporaryExposureKey) GetRollingStartIntervalNumber Uses

func (x *TemporaryExposureKey) GetRollingStartIntervalNumber() int32

func (*TemporaryExposureKey) GetTransmissionRiskLevel Uses

func (x *TemporaryExposureKey) GetTransmissionRiskLevel() int32

Deprecated: Do not use.

func (*TemporaryExposureKey) ProtoMessage Uses

func (*TemporaryExposureKey) ProtoMessage()

func (*TemporaryExposureKey) ProtoReflect Uses

func (x *TemporaryExposureKey) ProtoReflect() protoreflect.Message

func (*TemporaryExposureKey) Reset Uses

func (x *TemporaryExposureKey) Reset()

func (*TemporaryExposureKey) String Uses

func (x *TemporaryExposureKey) String() string

type TemporaryExposureKeyExport Uses

type TemporaryExposureKeyExport struct {

    // Time window of keys in this file based on arrival to server, in UTC
    // seconds
    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 Uses

func (*TemporaryExposureKeyExport) Descriptor() ([]byte, []int)

Deprecated: Use TemporaryExposureKeyExport.ProtoReflect.Descriptor instead.

func (*TemporaryExposureKeyExport) GetBatchNum Uses

func (x *TemporaryExposureKeyExport) GetBatchNum() int32

func (*TemporaryExposureKeyExport) GetBatchSize Uses

func (x *TemporaryExposureKeyExport) GetBatchSize() int32

func (*TemporaryExposureKeyExport) GetEndTimestamp Uses

func (x *TemporaryExposureKeyExport) GetEndTimestamp() uint64

func (*TemporaryExposureKeyExport) GetKeys Uses

func (x *TemporaryExposureKeyExport) GetKeys() []*TemporaryExposureKey

func (*TemporaryExposureKeyExport) GetRegion Uses

func (x *TemporaryExposureKeyExport) GetRegion() string

func (*TemporaryExposureKeyExport) GetRevisedKeys Uses

func (x *TemporaryExposureKeyExport) GetRevisedKeys() []*TemporaryExposureKey

func (*TemporaryExposureKeyExport) GetSignatureInfos Uses

func (x *TemporaryExposureKeyExport) GetSignatureInfos() []*SignatureInfo

func (*TemporaryExposureKeyExport) GetStartTimestamp Uses

func (x *TemporaryExposureKeyExport) GetStartTimestamp() uint64

func (*TemporaryExposureKeyExport) ProtoMessage Uses

func (*TemporaryExposureKeyExport) ProtoMessage()

func (*TemporaryExposureKeyExport) ProtoReflect Uses

func (x *TemporaryExposureKeyExport) ProtoReflect() protoreflect.Message

func (*TemporaryExposureKeyExport) Reset Uses

func (x *TemporaryExposureKeyExport) Reset()

func (*TemporaryExposureKeyExport) String Uses

func (x *TemporaryExposureKeyExport) String() string

type TemporaryExposureKey_ReportType Uses

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 Uses

func (TemporaryExposureKey_ReportType) Descriptor() protoreflect.EnumDescriptor

func (TemporaryExposureKey_ReportType) Enum Uses

func (x TemporaryExposureKey_ReportType) Enum() *TemporaryExposureKey_ReportType

func (TemporaryExposureKey_ReportType) EnumDescriptor Uses

func (TemporaryExposureKey_ReportType) EnumDescriptor() ([]byte, []int)

Deprecated: Use TemporaryExposureKey_ReportType.Descriptor instead.

func (TemporaryExposureKey_ReportType) Number Uses

func (x TemporaryExposureKey_ReportType) Number() protoreflect.EnumNumber

func (TemporaryExposureKey_ReportType) String Uses

func (x TemporaryExposureKey_ReportType) String() string

func (TemporaryExposureKey_ReportType) Type Uses

func (TemporaryExposureKey_ReportType) Type() protoreflect.EnumType

func (*TemporaryExposureKey_ReportType) UnmarshalJSON Uses

func (x *TemporaryExposureKey_ReportType) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

Package export imports 5 packages (graph) and is imported by 1 packages. Updated 2020-09-27. Refresh now. Tools for package owners.