divviup_client/
task.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
use prio::vdaf::prio3::optimal_chunk_length;
use serde::{Deserialize, Serialize};
use time::OffsetDateTime;
use uuid::Uuid;

use crate::dp_strategy;

#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq)]
pub struct Task {
    pub id: String,
    pub account_id: Uuid,
    pub name: String,
    pub vdaf: Vdaf,
    pub min_batch_size: u64,
    pub max_batch_size: Option<u64>,
    pub batch_time_window_size_seconds: Option<u64>,
    #[serde(with = "time::serde::rfc3339")]
    pub created_at: OffsetDateTime,
    #[serde(with = "time::serde::rfc3339")]
    pub updated_at: OffsetDateTime,
    #[serde(with = "time::serde::rfc3339::option")]
    pub deleted_at: Option<OffsetDateTime>,
    pub time_precision_seconds: u32,
    #[deprecated = "Not populated. Will be removed in a future release."]
    pub report_count: u32,
    #[deprecated = "Not populated. Will be removed in a future release."]
    pub aggregate_collection_count: u32,
    #[serde(default, with = "time::serde::rfc3339::option")]
    pub expiration: Option<OffsetDateTime>,
    pub leader_aggregator_id: Uuid,
    pub helper_aggregator_id: Uuid,
    pub collector_credential_id: Uuid,
    pub report_counter_interval_collected: i64,
    pub report_counter_decode_failure: i64,
    pub report_counter_decrypt_failure: i64,
    pub report_counter_expired: i64,
    pub report_counter_outdated_key: i64,
    pub report_counter_success: i64,
    pub report_counter_too_early: i64,
    pub report_counter_task_expired: i64,
}

#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq)]
pub struct NewTask {
    pub name: String,
    pub leader_aggregator_id: Uuid,
    pub helper_aggregator_id: Uuid,
    pub vdaf: Vdaf,
    pub min_batch_size: u64,
    pub max_batch_size: Option<u64>,
    pub batch_time_window_size_seconds: Option<u64>,
    pub time_precision_seconds: u64,
    pub collector_credential_id: Uuid,
}

#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
#[serde(rename_all = "snake_case", tag = "type")]
pub enum Vdaf {
    #[serde(rename = "count")]
    Count,

    #[serde(rename = "histogram")]
    Histogram(Histogram),

    #[serde(rename = "sum")]
    Sum { bits: u8 },

    #[serde(rename = "count_vec")]
    CountVec {
        length: u64,
        chunk_length: Option<u64>,
    },

    #[serde(rename = "sum_vec")]
    SumVec(SumVec),
}

#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
#[serde(untagged)]
pub enum Histogram {
    Categorical {
        buckets: Vec<String>,
        chunk_length: Option<u64>,
        #[serde(default)]
        dp_strategy: dp_strategy::Prio3Histogram,
    },
    Continuous {
        buckets: Vec<u64>,
        chunk_length: Option<u64>,
        #[serde(default)]
        dp_strategy: dp_strategy::Prio3Histogram,
    },
    Length {
        length: u64,
        chunk_length: Option<u64>,
        #[serde(default)]
        dp_strategy: dp_strategy::Prio3Histogram,
    },
}

impl Histogram {
    /// The length of this histogram, i.e. the number of buckets.
    pub fn length(&self) -> usize {
        match self {
            Histogram::Categorical { buckets, .. } => buckets.len(),
            Histogram::Continuous { buckets, .. } => buckets.len() + 1,
            Histogram::Length { length, .. } => *length as usize,
        }
    }

    /// The chunk length used in the VDAF.
    pub fn chunk_length(&self) -> usize {
        match self {
            Histogram::Categorical { chunk_length, .. } => chunk_length,
            Histogram::Continuous { chunk_length, .. } => chunk_length,
            Histogram::Length { chunk_length, .. } => chunk_length,
        }
        .map(|c| c as usize)
        .unwrap_or_else(|| optimal_chunk_length(self.length()))
    }

    /// The differential privacy strategy.
    pub fn dp_strategy(&self) -> &dp_strategy::Prio3Histogram {
        match self {
            Histogram::Categorical { dp_strategy, .. }
            | Histogram::Continuous { dp_strategy, .. }
            | Histogram::Length { dp_strategy, .. } => dp_strategy,
        }
    }
}

#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
pub struct SumVec {
    pub bits: u8,
    pub length: u64,
    chunk_length: Option<u64>,
    #[serde(default)]
    pub dp_strategy: dp_strategy::Prio3SumVec,
}

impl SumVec {
    /// Create a new SumVec
    pub fn new(
        bits: u8,
        length: u64,
        chunk_length: Option<u64>,
        dp_strategy: dp_strategy::Prio3SumVec,
    ) -> Self {
        Self {
            bits,
            length,
            chunk_length,
            dp_strategy,
        }
    }

    /// The chunk length used in the VDAF.
    pub fn chunk_length(&self) -> usize {
        self.chunk_length
            .map(|c| c as usize)
            .unwrap_or_else(|| optimal_chunk_length(self.bits as usize * self.length as usize))
    }
}