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

use crate::core_crypto::prelude::LweBskGroupingFactor;
use crate::shortint::backward_compatibility::parameters::noise_squashing::*;
use crate::shortint::backward_compatibility::parameters::MetaNoiseSquashingParametersVersions;
use crate::shortint::parameters::{
    CarryModulus, CoreCiphertextModulus, DecompositionBaseLog, DecompositionLevelCount,
    DynamicDistribution, GlweDimension, LweCiphertextCount, MessageModulus, ModulusSwitchType,
    PolynomialSize,
};
use serde::{Deserialize, Serialize};
use tfhe_versionable::Versionize;

#[derive(Copy, Clone, Debug, PartialEq, Serialize, Deserialize, Versionize)]
#[versionize(NoiseSquashingParametersVersions)]
pub enum NoiseSquashingParameters {
    Classic(NoiseSquashingClassicParameters),
    MultiBit(NoiseSquashingMultiBitParameters),
}

impl NoiseSquashingParameters {
    pub fn polynomial_size(&self) -> PolynomialSize {
        match self {
            Self::Classic(noise_squashing_classic_parameters) => {
                noise_squashing_classic_parameters.polynomial_size
            }
            Self::MultiBit(noise_squashing_multi_bit_parameters) => {
                noise_squashing_multi_bit_parameters.polynomial_size
            }
        }
    }

    pub fn glwe_dimension(&self) -> GlweDimension {
        match self {
            Self::Classic(noise_squashing_classic_parameters) => {
                noise_squashing_classic_parameters.glwe_dimension
            }
            Self::MultiBit(noise_squashing_multi_bit_parameters) => {
                noise_squashing_multi_bit_parameters.glwe_dimension
            }
        }
    }

    pub fn message_modulus(&self) -> MessageModulus {
        match self {
            Self::Classic(noise_squashing_classic_parameters) => {
                noise_squashing_classic_parameters.message_modulus
            }
            Self::MultiBit(noise_squashing_multi_bit_parameters) => {
                noise_squashing_multi_bit_parameters.message_modulus
            }
        }
    }
    pub fn carry_modulus(&self) -> CarryModulus {
        match self {
            Self::Classic(noise_squashing_classic_parameters) => {
                noise_squashing_classic_parameters.carry_modulus
            }
            Self::MultiBit(noise_squashing_multi_bit_parameters) => {
                noise_squashing_multi_bit_parameters.carry_modulus
            }
        }
    }
    pub fn decomp_base_log(&self) -> DecompositionBaseLog {
        match self {
            Self::Classic(noise_squashing_classic_parameters) => {
                noise_squashing_classic_parameters.decomp_base_log
            }
            Self::MultiBit(noise_squashing_multi_bit_parameters) => {
                noise_squashing_multi_bit_parameters.decomp_base_log
            }
        }
    }
    pub fn decomp_level_count(&self) -> DecompositionLevelCount {
        match self {
            Self::Classic(noise_squashing_classic_parameters) => {
                noise_squashing_classic_parameters.decomp_level_count
            }
            Self::MultiBit(noise_squashing_multi_bit_parameters) => {
                noise_squashing_multi_bit_parameters.decomp_level_count
            }
        }
    }
    pub fn glwe_noise_distribution(&self) -> DynamicDistribution<u128> {
        match self {
            Self::Classic(noise_squashing_classic_parameters) => {
                noise_squashing_classic_parameters.glwe_noise_distribution
            }
            Self::MultiBit(noise_squashing_multi_bit_parameters) => {
                noise_squashing_multi_bit_parameters.glwe_noise_distribution
            }
        }
    }
    pub fn ciphertext_modulus(&self) -> CoreCiphertextModulus<u128> {
        match self {
            Self::Classic(noise_squashing_classic_parameters) => {
                noise_squashing_classic_parameters.ciphertext_modulus
            }
            Self::MultiBit(noise_squashing_multi_bit_parameters) => {
                noise_squashing_multi_bit_parameters.ciphertext_modulus
            }
        }
    }
    pub fn set_deterministic_execution(&mut self, do_it: bool) {
        match self {
            Self::Classic(_) => (),
            Self::MultiBit(noise_squashing_multi_bit_parameters) => {
                noise_squashing_multi_bit_parameters.deterministic_execution = do_it
            }
        }
    }
    pub fn with_deterministic_execution(mut self) -> Self {
        self.set_deterministic_execution(true);

        self
    }
}

#[derive(Copy, Clone, Debug, PartialEq, Serialize, Deserialize, Versionize)]
#[versionize(NoiseSquashingClassicParametersVersions)]
pub struct NoiseSquashingClassicParameters {
    pub glwe_dimension: GlweDimension,
    pub polynomial_size: PolynomialSize,
    pub glwe_noise_distribution: DynamicDistribution<u128>,
    pub decomp_base_log: DecompositionBaseLog,
    pub decomp_level_count: DecompositionLevelCount,
    pub modulus_switch_noise_reduction_params: ModulusSwitchType,
    pub message_modulus: MessageModulus,
    pub carry_modulus: CarryModulus,
    pub ciphertext_modulus: CoreCiphertextModulus<u128>,
}

#[derive(Copy, Clone, Debug, PartialEq, Serialize, Deserialize, Versionize)]
#[versionize(NoiseSquashingMultiBitParametersVersions)]
pub struct NoiseSquashingMultiBitParameters {
    pub glwe_dimension: GlweDimension,
    pub polynomial_size: PolynomialSize,
    pub glwe_noise_distribution: DynamicDistribution<u128>,
    pub decomp_base_log: DecompositionBaseLog,
    pub decomp_level_count: DecompositionLevelCount,
    pub grouping_factor: LweBskGroupingFactor,
    pub message_modulus: MessageModulus,
    pub carry_modulus: CarryModulus,
    pub ciphertext_modulus: CoreCiphertextModulus<u128>,
    pub deterministic_execution: bool,
}

#[derive(Copy, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize, Versionize)]
#[versionize(NoiseSquashingCompressionParametersVersions)]
pub struct NoiseSquashingCompressionParameters {
    pub packing_ks_level: DecompositionLevelCount,
    pub packing_ks_base_log: DecompositionBaseLog,
    pub packing_ks_polynomial_size: PolynomialSize,
    pub packing_ks_glwe_dimension: GlweDimension,
    pub lwe_per_glwe: LweCiphertextCount,
    pub packing_ks_key_noise_distribution: DynamicDistribution<u128>,
    pub message_modulus: MessageModulus,
    pub carry_modulus: CarryModulus,
    pub ciphertext_modulus: CoreCiphertextModulus<u128>,
}

#[derive(Debug, Copy, Clone, PartialEq, serde::Serialize, serde::Deserialize, Versionize)]
#[versionize(MetaNoiseSquashingParametersVersions)]
pub struct MetaNoiseSquashingParameters {
    /// Parameters to do the actual noise squashing
    pub parameters: NoiseSquashingParameters,
    /// Parameters for compression of noise squashed ciphertexts aka
    /// CompressedSquashedNoiseCiphertextList
    pub compression_parameters: Option<NoiseSquashingCompressionParameters>,
}