tfhe 1.6.1

TFHE-rs is a fully homomorphic encryption (FHE) library that implements Zama's variant of TFHE.
Documentation
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
use crate::conformance::ParameterSetConformant;
use crate::core_crypto::algorithms::*;
use crate::core_crypto::commons::math::random::{CompressionSeed, DynamicDistribution, Uniform};
use crate::core_crypto::commons::parameters::{
    LweDimension, NoiseEstimationMeasureBound, PlaintextCount, RSigmaFactor,
};
use crate::core_crypto::commons::traits::*;
use crate::core_crypto::entities::*;
use crate::core_crypto::prelude::modulus_switch_noise_reduction::improve_lwe_ciphertext_modulus_switch_noise_for_binary_key;
use crate::core_crypto::prelude::{
    CiphertextModulus as CoreCiphertextModulus, CiphertextModulusLog, Variance,
};
use crate::shortint::backward_compatibility::server_key::modulus_switch_noise_reduction::*;
use crate::shortint::engine::ShortintEngine;
use crate::shortint::parameters::ModulusSwitchNoiseReductionParams;

use serde::{Deserialize, Serialize};
use std::borrow::Cow;
use std::fmt::Debug;
use tfhe_versionable::Versionize;

#[derive(Copy, Clone)]
pub struct ModulusSwitchNoiseReductionKeyConformanceParams {
    pub modulus_switch_noise_reduction_params: ModulusSwitchNoiseReductionParams,
    pub lwe_dimension: LweDimension,
}

/// Using a [ModulusSwitchNoiseReductionKey], it's possible do apply a modulus switch which adds
/// less noise by calling the
/// [switch_modulus](ModulusSwitchNoiseReductionKey::improve_noise_and_modulus_switch) method on the
/// target ciphertext.
///
/// The lower level primitive is
/// [improve_lwe_ciphertext_modulus_switch_noise_for_binary_key](crate::core_crypto::algorithms::modulus_switch_noise_reduction::improve_lwe_ciphertext_modulus_switch_noise_for_binary_key)
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, Versionize)]
#[versionize(ModulusSwitchNoiseReductionKeyVersions)]
pub struct ModulusSwitchNoiseReductionKey<InputScalar>
where
    InputScalar: UnsignedInteger,
{
    pub modulus_switch_zeros: LweCiphertextListOwned<InputScalar>,
    pub ms_bound: NoiseEstimationMeasureBound,
    pub ms_r_sigma_factor: RSigmaFactor,
    pub ms_input_variance: Variance,
}

impl<InputScalar> ParameterSetConformant for ModulusSwitchNoiseReductionKey<InputScalar>
where
    InputScalar: UnsignedInteger,
{
    type ParameterSet = ModulusSwitchNoiseReductionKeyConformanceParams;

    fn is_conformant(&self, parameter_set: &Self::ParameterSet) -> bool {
        let Self {
            modulus_switch_zeros,
            ms_bound,
            ms_r_sigma_factor,
            ms_input_variance,
        } = self;

        let ModulusSwitchNoiseReductionKeyConformanceParams {
            modulus_switch_noise_reduction_params,
            lwe_dimension,
        } = parameter_set;

        let ModulusSwitchNoiseReductionParams {
            modulus_switch_zeros_count: param_modulus_switch_zeros_count,
            ms_bound: param_ms_bound,
            ms_r_sigma_factor: param_ms_r_sigma_factor,
            ms_input_variance: param_ms_input_variance,
        } = modulus_switch_noise_reduction_params;

        ms_bound == param_ms_bound
            && ms_r_sigma_factor == param_ms_r_sigma_factor
            && ms_input_variance == param_ms_input_variance
            && modulus_switch_zeros.entity_count() == param_modulus_switch_zeros_count.0
            && modulus_switch_zeros.lwe_size().to_lwe_dimension() == *lwe_dimension
    }
}

impl<InputScalar> ModulusSwitchNoiseReductionKey<InputScalar>
where
    InputScalar: UnsignedInteger,
{
    pub(crate) fn improve_modulus_switch_noise<Cont>(
        &self,
        input: &mut LweCiphertext<Cont>,
        log_modulus: CiphertextModulusLog,
    ) where
        Cont: ContainerMut<Element = InputScalar>,
    {
        improve_lwe_ciphertext_modulus_switch_noise_for_binary_key(
            input,
            &self.modulus_switch_zeros,
            self.ms_r_sigma_factor,
            self.ms_bound,
            self.ms_input_variance,
            log_modulus,
        );
    }

    pub fn improve_noise_and_modulus_switch<Cont, SwitchedScalar>(
        &self,
        input: &LweCiphertext<Cont>,
        log_modulus: CiphertextModulusLog,
    ) -> LazyStandardModulusSwitchedLweCiphertext<InputScalar, SwitchedScalar, Vec<InputScalar>>
    where
        InputScalar: CastInto<SwitchedScalar>,
        SwitchedScalar: UnsignedInteger,
        Cont: Container<Element = InputScalar>,
    {
        let mut input: LweCiphertext<Vec<InputScalar>> =
            LweCiphertext::from_container(input.as_ref().to_owned(), input.ciphertext_modulus());

        self.improve_modulus_switch_noise(&mut input, log_modulus);

        lwe_ciphertext_modulus_switch(input, log_modulus)
    }
}

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, Versionize)]
#[versionize(CompressedModulusSwitchNoiseReductionKeyVersions)]
pub struct CompressedModulusSwitchNoiseReductionKey<InputScalar>
where
    InputScalar: UnsignedInteger,
{
    pub modulus_switch_zeros: SeededLweCiphertextListOwned<InputScalar>,
    pub ms_bound: NoiseEstimationMeasureBound,
    pub ms_r_sigma_factor: RSigmaFactor,
    pub ms_input_variance: Variance,
}

impl<InputScalar> ParameterSetConformant for CompressedModulusSwitchNoiseReductionKey<InputScalar>
where
    InputScalar: UnsignedInteger,
{
    type ParameterSet = ModulusSwitchNoiseReductionKeyConformanceParams;

    fn is_conformant(&self, parameter_set: &Self::ParameterSet) -> bool {
        let Self {
            modulus_switch_zeros,
            ms_bound,
            ms_r_sigma_factor,
            ms_input_variance,
        } = self;

        let ModulusSwitchNoiseReductionKeyConformanceParams {
            modulus_switch_noise_reduction_params,
            lwe_dimension,
        } = parameter_set;

        let ModulusSwitchNoiseReductionParams {
            modulus_switch_zeros_count: param_modulus_switch_zeros_count,
            ms_bound: param_ms_bound,
            ms_r_sigma_factor: param_ms_r_sigma_factor,
            ms_input_variance: param_ms_input_variance,
        } = modulus_switch_noise_reduction_params;

        ms_bound == param_ms_bound
            && ms_r_sigma_factor == param_ms_r_sigma_factor
            && ms_input_variance == param_ms_input_variance
            && modulus_switch_zeros.entity_count() == param_modulus_switch_zeros_count.0
            && modulus_switch_zeros.lwe_size().to_lwe_dimension() == *lwe_dimension
    }
}

impl<InputScalar> ModulusSwitchNoiseReductionKey<InputScalar>
where
    InputScalar: Encryptable<Uniform, DynamicDistribution<InputScalar>>,
{
    pub fn new<KeyCont: Container<Element = InputScalar> + Sync>(
        modulus_switch_noise_reduction_params: ModulusSwitchNoiseReductionParams,
        secret_key: &LweSecretKey<KeyCont>,
        engine: &mut ShortintEngine,
        ciphertext_modulus: CoreCiphertextModulus<InputScalar>,
        lwe_noise_distribution: DynamicDistribution<InputScalar>,
    ) -> Self {
        let ModulusSwitchNoiseReductionParams {
            modulus_switch_zeros_count: count,
            ms_bound,
            ms_r_sigma_factor,
            ms_input_variance,
        } = modulus_switch_noise_reduction_params;

        let lwe_size = secret_key.lwe_dimension().to_lwe_size();

        let mut modulus_switch_zeros =
            LweCiphertextList::new(InputScalar::ZERO, lwe_size, count, ciphertext_modulus);

        let plaintext_list = PlaintextList::new(InputScalar::ZERO, PlaintextCount(count.0));

        par_encrypt_lwe_ciphertext_list(
            secret_key,
            &mut modulus_switch_zeros,
            &plaintext_list,
            lwe_noise_distribution,
            &mut engine.encryption_generator,
        );

        Self {
            modulus_switch_zeros,
            ms_bound,
            ms_r_sigma_factor,
            ms_input_variance,
        }
    }
}

impl<InputScalar> CompressedModulusSwitchNoiseReductionKey<InputScalar>
where
    InputScalar: Encryptable<Uniform, DynamicDistribution<InputScalar>>,
{
    pub fn new<KeyCont: Container<Element = InputScalar> + Sync>(
        modulus_switch_noise_reduction_params: ModulusSwitchNoiseReductionParams,
        secret_key: &LweSecretKey<KeyCont>,
        engine: &mut ShortintEngine,
        ciphertext_modulus: CoreCiphertextModulus<InputScalar>,
        lwe_noise_distribution: DynamicDistribution<InputScalar>,
        compression_seed: CompressionSeed,
    ) -> Self {
        let ModulusSwitchNoiseReductionParams {
            modulus_switch_zeros_count: count,
            ms_bound,
            ms_r_sigma_factor,
            ms_input_variance,
        } = modulus_switch_noise_reduction_params;

        let lwe_size = secret_key.lwe_dimension().to_lwe_size();

        let mut modulus_switch_zeros = SeededLweCiphertextList::new(
            InputScalar::ZERO,
            lwe_size,
            count,
            compression_seed,
            ciphertext_modulus,
        );

        let plaintext_list = PlaintextList::new(InputScalar::ZERO, PlaintextCount(count.0));

        par_encrypt_seeded_lwe_ciphertext_list(
            secret_key,
            &mut modulus_switch_zeros,
            &plaintext_list,
            lwe_noise_distribution,
            &mut engine.seeder,
        );

        Self {
            modulus_switch_zeros,
            ms_bound,
            ms_r_sigma_factor,
            ms_input_variance,
        }
    }
}

impl<InputScalar> CompressedModulusSwitchNoiseReductionKey<InputScalar>
where
    InputScalar: UnsignedTorus,
{
    pub fn decompress(&self) -> ModulusSwitchNoiseReductionKey<InputScalar> {
        ModulusSwitchNoiseReductionKey {
            modulus_switch_zeros: self
                .modulus_switch_zeros
                .as_view()
                .decompress_into_lwe_ciphertext_list(),
            ms_bound: self.ms_bound,
            ms_r_sigma_factor: self.ms_r_sigma_factor,
            ms_input_variance: self.ms_input_variance,
        }
    }
}

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, Versionize)]
#[versionize(CompressedModulusSwitchConfigurationVersions)]
pub enum CompressedModulusSwitchConfiguration<Scalar>
where
    Scalar: UnsignedInteger,
{
    Standard,
    DriftTechniqueNoiseReduction(CompressedModulusSwitchNoiseReductionKey<Scalar>),
    CenteredMeanNoiseReduction,
}

impl<Scalar: UnsignedTorus> CompressedModulusSwitchConfiguration<Scalar> {
    pub fn decompress(&self) -> ModulusSwitchConfiguration<Scalar> {
        match self {
            Self::Standard => ModulusSwitchConfiguration::Standard,
            Self::DriftTechniqueNoiseReduction(compressed_modulus_switch_noise_reduction_key) => {
                ModulusSwitchConfiguration::DriftTechniqueNoiseReduction(
                    compressed_modulus_switch_noise_reduction_key.decompress(),
                )
            }
            Self::CenteredMeanNoiseReduction => {
                ModulusSwitchConfiguration::CenteredMeanNoiseReduction
            }
        }
    }
}

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, Versionize)]
#[versionize(ModulusSwitchConfigurationVersions)]
pub enum ModulusSwitchConfiguration<Scalar>
where
    Scalar: UnsignedInteger,
{
    Standard,
    DriftTechniqueNoiseReduction(ModulusSwitchNoiseReductionKey<Scalar>),
    CenteredMeanNoiseReduction,
}

impl<'a, Scalar: UnsignedInteger> ModulusSwitchConfiguration<Scalar> {
    pub fn lwe_ciphertext_modulus_switch<SwitchedScalar, Cont>(
        &self,
        lwe_in: &'a LweCiphertext<Cont>,
        log_modulus: CiphertextModulusLog,
    ) -> LazyStandardModulusSwitchedLweCiphertext<Scalar, SwitchedScalar, Cow<'a, [Scalar]>>
    where
        Scalar: UnsignedInteger + CastInto<SwitchedScalar>,
        SwitchedScalar: UnsignedInteger,
        Cont: Container<Element = Scalar>,
    {
        let lwe_in = LweCiphertext::from_container(
            Cow::Borrowed(lwe_in.as_ref()),
            lwe_in.ciphertext_modulus(),
        );

        match self {
            Self::Standard => lwe_ciphertext_modulus_switch(lwe_in, log_modulus),
            Self::DriftTechniqueNoiseReduction(modulus_switch_noise_reduction_key) => {
                let lazy_msed_ct: LazyStandardModulusSwitchedLweCiphertext<
                    Scalar,
                    SwitchedScalar,
                    Vec<Scalar>,
                > = modulus_switch_noise_reduction_key
                    .improve_noise_and_modulus_switch(&lwe_in, log_modulus);

                let (lwe_ct, body_correction_to_add_before_switching, log_modulus) =
                    lazy_msed_ct.into_raw_parts();

                let ciphertext_modulus = lwe_ct.ciphertext_modulus();

                // Change lwe_ct container from Vec<Scalar> to Cow<'_, [Scalar]>
                let lwe_ct = LweCiphertext::from_container(
                    Cow::Owned(lwe_ct.into_container()),
                    ciphertext_modulus,
                );

                LazyStandardModulusSwitchedLweCiphertext::from_raw_parts(
                    lwe_ct,
                    body_correction_to_add_before_switching,
                    log_modulus,
                )
            }
            Self::CenteredMeanNoiseReduction => {
                lwe_ciphertext_centered_binary_modulus_switch(lwe_in, log_modulus)
            }
        }
    }

    pub fn modulus_switch_noise_reduction_key(
        &self,
    ) -> Option<&ModulusSwitchNoiseReductionKey<Scalar>> {
        match self {
            Self::Standard | Self::CenteredMeanNoiseReduction => None,
            Self::DriftTechniqueNoiseReduction(modulus_switch_noise_reduction_key) => {
                Some(modulus_switch_noise_reduction_key)
            }
        }
    }
}

// ============== Noise measurement trait implementations ============== //
use crate::core_crypto::commons::noise_formulas::noise_simulation::traits::{
    AllocateDriftTechniqueStandardModSwitchResult, AllocateStandardModSwitchResult,
    DriftTechniqueStandardModSwitch, StandardModSwitch,
};

impl<Scalar: UnsignedInteger> AllocateDriftTechniqueStandardModSwitchResult
    for ModulusSwitchNoiseReductionKey<Scalar>
{
    type AfterDriftOutput = LweCiphertextOwned<Scalar>;
    type AfterMsOutput = LweCiphertextOwned<Scalar>;
    type SideResources = ();

    fn allocate_drift_technique_standard_mod_switch_result(
        &self,
        side_resources: &mut Self::SideResources,
    ) -> (Self::AfterDriftOutput, Self::AfterMsOutput) {
        let after_drift = Self::AfterDriftOutput::new(
            Scalar::ZERO,
            self.modulus_switch_zeros.lwe_size(),
            self.modulus_switch_zeros.ciphertext_modulus(),
        );
        let after_ms = after_drift.allocate_standard_mod_switch_result(side_resources);
        (after_drift, after_ms)
    }
}

impl<
        Scalar: UnsignedInteger,
        InputCont: Container<Element = Scalar>,
        AfterDriftCont: ContainerMut<Element = Scalar>,
        AfterMsCont: ContainerMut<Element = Scalar>,
    >
    DriftTechniqueStandardModSwitch<
        LweCiphertext<InputCont>,
        LweCiphertext<AfterDriftCont>,
        LweCiphertext<AfterMsCont>,
    > for ModulusSwitchNoiseReductionKey<Scalar>
{
    type SideResources = ();

    fn drift_technique_and_standard_mod_switch(
        &self,
        output_modulus_log: CiphertextModulusLog,
        input: &LweCiphertext<InputCont>,
        after_drift_technique: &mut LweCiphertext<AfterDriftCont>,
        after_mod_switch: &mut LweCiphertext<AfterMsCont>,
        side_resources: &mut Self::SideResources,
    ) {
        after_drift_technique
            .as_mut()
            .copy_from_slice(input.as_ref());
        self.improve_modulus_switch_noise(after_drift_technique, output_modulus_log);

        after_drift_technique.standard_mod_switch(
            output_modulus_log,
            after_mod_switch,
            side_resources,
        );
    }
}