Struct SecureAggregationConfig 

pub struct SecureAggregationConfig {
    pub enabled: bool,
    pub min_clients: usize,
    pub max_dropouts: usize,
    pub masking_dimension: usize,
    pub seed_sharing: SeedSharingMethod,
    pub quantization_bits: Option<u8>,
    pub quantization_scale: f64,
    pub max_update_magnitude: f64,
    pub aggregate_dp: bool,
}

Secure aggregation configuration

Fields

enabled: bool

Whether the protocol is active. Protocol operations error when this is false rather than quietly aggregating in the clear.

min_clients: usize

Minimum number of received submissions required to aggregate.

max_dropouts: usize

Maximum number of dropouts a round may tolerate. A round with more dropouts than this is refused.

masking_dimension: usize

Dimension of the update vectors being aggregated.

seed_sharing: SeedSharingMethod

How pairwise seeds are established.

quantization_bits: Option<u8>

Width, in bits, of the additive group Z_(2^bits) used for masking. None selects DEFAULT_MODULUS_BITS.

quantization_scale: f64

Fixed-point scale: an update coordinate g is encoded as round(g * quantization_scale).

max_update_magnitude: f64

Declared per-coordinate bound on client updates. Enforced when a client masks its update, and used to prove that the cohort’s summed fixed-point value cannot wrap the group.

aggregate_dp: bool

Add differential privacy noise to the aggregate. Not implemented here; setting it is an error (see the module documentation).

Implementations

impl SecureAggregationConfig

pub fn validate_protocol(&self) -> Result<i64>

Validate the protocol parameters and return the modulus they select.

This is the single source of truth for “is this secure-aggregation configuration deliverable?”. SecureAggregator::new calls it, and so does the federated-privacy configuration validator (SecureAggregationConfig::validate_for_federation), so a federation cannot be accepted at the configuration layer and then rejected when the aggregator is built.

Trait Implementations

impl Clone for SecureAggregationConfig

fn clone(&self) -> SecureAggregationConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecureAggregationConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SecureAggregationConfig

fn default() -> Self

Returns the “default value” for a type.