Expand description
Messages defined by the Distributed Aggregation Protocol with serialization and deserialization support.
Modules§
- codec
- Support for encoding and decoding messages to or from the TLS wire encoding, as specified in RFC 8446, Section 3.
- problem_
type - query_
type - taskprov
- Data structures as defined in extension draft-wang-ppm-dap-taskprov.
Structs§
- Aggregate
Share - DAP protocol message representing a helper’s response to the leader’s request to provide an encrypted aggregate of its share of data for a given batch interval.
- Aggregate
Share Aad - DAP message representing the additional associated data for an aggregate share encryption operation.
- Aggregate
Share Req - DAP protocol message representing a request from the leader to a helper to provide an encrypted aggregate of its share of data for a given batch interval.
- Aggregation
JobContinue Req - DAP protocol message representing a request to continue an aggregation job.
- Aggregation
JobId - DAP protocol message representing an identifier for an aggregation job.
- Aggregation
JobInitialize Req - DAP protocol message representing an aggregation job initialization request from leader to helper.
- Aggregation
JobResp - DAP protocol message representing the response to an aggregation job initialization or continuation request.
- Aggregation
JobStep - Type representing the step of an aggregation job.
- BatchId
- DAP protocol message representing an ID uniquely identifying a batch, for fixed-size tasks.
- Batch
Selector - DAP protocol message identifying a batch of interest.
- Collection
- DAP protocol message representing a leader’s response to the collector’s request to provide aggregate shares for a given query.
- Collection
JobId - DAP protocol message representing an identifier for a collection.
- Collection
Req - DAP protocol message representing a request from the collector to the leader to provide aggregate shares for a given batch.
- Duration
- DAP protocol message representing a duration with a resolution of seconds.
- Extension
- DAP protocol message representing an arbitrary extension included in a client report.
- Hpke
Ciphertext - DAP protocol message representing an HPKE ciphertext.
- Hpke
Config - DAP protocol message representing an HPKE config.
- Hpke
Config Id - DAP protocol message representing an identifier for an HPKE config.
- Hpke
Config List - DAP protocol message representing a list of HPKE configurations.
- Hpke
Public Key - DAP protocol message representing an HPKE public key.
- Input
Share Aad - DAP message representing the additional associated data for an input share encryption operation.
- Interval
- DAP protocol message representing a half-open interval of time with a resolution of seconds; the start of the interval is included while the end of the interval is excluded.
- Partial
Batch Selector - DAP protocol message representing a partial batch selector, identifying a batch of interest in cases where some query types can infer the selector.
- Plaintext
Input Share - DAP protocol message representing the plaintext of an input share.
- Prepare
Continue - DAP protocol message representing a request to continue preparation of a report share for aggregation.
- Prepare
Init - DAP protocol message representing information required to initialize preparation of a report for aggregation.
- Prepare
Resp - DAP protocol message representing the response to a preparation step in a VDAF evaluation.
- Query
- Represents a query for a specific batch identifier, received from a Collector as part of the collection flow.
- Report
- DAP protocol message representing a client report.
- Report
Id - DAP protocol message representing an ID uniquely identifying a client report.
- Report
IdChecksum - Checksum over DAP report IDs, defined in §4.4.4.3.
- Report
Metadata - DAP protocol message representing client report metadata.
- Report
Share - DAP protocol message representing one aggregator’s share of a single client report.
- Role
Parse Error - TaskId
- DAP protocol message representing an identifier for a DAP task.
- Time
- DAP protocol message representing an instant in time with a resolution of seconds.
- Url
- Wire-representation of an ASCII-encoded URL with minimum length 1 and maximum length 2^16 - 1.
Enums§
- Error
- Errors returned by functions and methods in this module
- Extension
Type - DAP protocol message representing the type of an extension included in a client report.
- Fixed
Size Query - DAP protocol message representing a fixed-size query.
- Hpke
Aead Id - DAP protocol message representing an HPKE AEAD.
- Hpke
KdfId - DAP protocol message representing an HPKE key derivation function.
- Hpke
KemId - DAP protocol message representing an HPKE key encapsulation mechanism.
- Prepare
Error - DAP protocol message representing an error while preparing a report share for aggregation.
- Prepare
Step Result - DAP protocol message representing result-type-specific data associated with a preparation step in a VDAF evaluation. Included in a PrepareResp message.
- Role
- DAP protocol message representing the different roles that participants can adopt.