Cryptonic 0.1.2

This project includes a tensor library, utilities for FHE functionality and most importantly an FHE based ML library
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

extern crate core;

#[cfg(test)]
mod test_cryptography{
    use std::time::Instant;
    use Cryptonic::cryptography::key_gen::custom_gen_keys;
    use Cryptonic::cryptography::ciphtxt;
    use Cryptonic::cryptography::ciphtxt::CipherTextType;


    #[test]
    fn test_key_gen(){
        // If throws than there is a problem.
        // We also log the time it takes for the keygen

        let now = Instant::now();

        let (rck, sk, pk) = custom_gen_keys();
        let elapsed = now.elapsed();
        println!("Elapsed: {:.2?}", elapsed);
    }

    #[test]
    fn test_cphtxttype_new_default() {
        let (rck, sk, pk) = custom_gen_keys();
        let ciphertxt = CipherTextType::new(pk.encrypt_radix(10u64, 8), pk, sk);
        let defaultedcphtxt = CipherTextType::default();
        assert!(defaultedcphtxt.is_def())
    }

    #[test]
    fn test_ciphertext_add(){
        let (rck, sk, pk) = custom_gen_keys();
        let ct_1 = CipherTextType::new(pk.encrypt_radix(10u64, 8), pk.clone(), sk.clone());
        let ct_2 = CipherTextType::new(pk.encrypt_radix(15u64, 8), pk, sk);

        let ct_3 = ct_1 + ct_2;

        assert!(!ct_3.is_def());
        assert_eq!(rck.decrypt::<u64, tfhe::shortint::ciphertext::KeyswitchBootstrap>(&ct_3.CipherTxt), 25u64);
    }

    #[test]
    fn test_ciphertext_mul(){
        let (rck, sk, pk) = custom_gen_keys();
        let ct_1 = CipherTextType::new(pk.encrypt_radix(202u64, 8), pk.clone(), sk.clone());
        let ct_2 = CipherTextType::new(pk.encrypt_radix(10u64, 8), pk, sk);

        let ct_3 = ct_1 * ct_2;

        assert!(!ct_3.is_def());
        assert_eq!(rck.decrypt::<u64, tfhe::shortint::ciphertext::KeyswitchBootstrap>(&ct_3.CipherTxt), 2020u64);
    }

    #[test]
    fn test_ciphertext_add_i32(){
        let (rck, sk, pk) = custom_gen_keys();
        let ct_1 = CipherTextType::new(pk.encrypt_radix(202u64, 8), pk.clone(), sk.clone());

        let ct_3 = ct_1 + 50i32;

        assert!(!ct_3.is_def());
        assert_eq!(rck.decrypt::<u64, tfhe::shortint::ciphertext::KeyswitchBootstrap>(&ct_3.CipherTxt), 252u64);
    }

    #[test]
    fn test_ciphertext_mul_i32(){
        let (rck, sk, pk) = custom_gen_keys();
        let ct_1 = CipherTextType::new(pk.encrypt_radix(202u64, 8), pk.clone(), sk.clone());

        let ct_3 = ct_1 * 50i32;

        assert!(!ct_3.is_def());
        assert_eq!(rck.decrypt::<u64, tfhe::shortint::ciphertext::KeyswitchBootstrap>(&ct_3.CipherTxt), 10100u64);
    }
}

#[cfg(test)]
mod test_layers {
    use ndarray::array;
    use Cryptonic::neural_network::dense_layer::DenseLayer;
    use Cryptonic::neural_network::layer_trait::Layer;
    use Cryptonic::neural_network::nnet::Nnet;

    #[test]
    fn test_layer_shape() {
        let layer : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);
        let input_shape : Vec<usize> = vec![3, 2];
        assert_eq!(layer.get_input_shape(), &input_shape);
    }
    #[test]
    fn test_change_bias() {
        let mut layer : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);
        layer.change_bias(20);
        assert_eq!(layer.get_bias(), 20);
    }
    #[test]
    fn test_change_weights() {
        let mut layer : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);
        layer.change_weights(array![10, 10, 10]);
        assert_eq!(layer.get_weights(), array![10, 10, 10]);
    }
}

#[cfg(test)]
mod test_neural_network {
    use std::fmt::format;
    use std::ptr::null;
    use ndarray::{array, Array, ArrayD, Ix1, IxDyn};
    use Cryptonic::cryptography::ciphtxt::CipherTextType;
    use Cryptonic::cryptography::key_gen::custom_gen_keys;
    use Cryptonic::neural_network::dense_layer::DenseLayer;
    use Cryptonic::neural_network::layer_trait::Layer;
    use Cryptonic::neural_network::nnet::Nnet;

    #[test]
    fn test_adding_a_new_layer() {
        let mut nn : Nnet<i32> = Nnet::new();
        let mut layer : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);
        nn.add_layer(Box::new(layer));
        assert_eq!(nn.layers.len(), 1);
    }

    #[test]
    fn test_should_throw_an_error_if_number_of_weights_is_inappropriate() {
        let mut nn : Nnet<i32> = Nnet::new();

        let mut layer1 : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);
        let mut layer2 : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);

        nn.add_layer(Box::new(layer1));
        nn.add_layer(Box::new(layer2));

        let weights = vec![array![3, 3, 3], array![3, 3, 3]];

        let expected_res: Result<(), String> =  Err(("1 sets of weights expected. Received 2!").to_string());
        assert_eq!(nn.initialise_weights(weights), expected_res);
        assert!(!nn.are_weights_initialised);
    }

    #[test]
    fn should_initialise_weights_if_they_are_in_correct_format() {
        let mut nn : Nnet<i32> = Nnet::new();

        let mut layer1 : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);
        let mut layer2 : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);

        nn.add_layer(Box::new(layer1));
        nn.add_layer(Box::new(layer2));

        let weights = vec![array![3, 3, 3]];

        _ = nn.initialise_weights(weights);

        assert_eq!(nn.layers[0].get_weights(), array![3, 3, 3]);
        assert!(nn.are_weights_initialised);
    }

    #[test]
    fn should_throw_an_error_if_number_of_biases_is_incorrect() {
        let mut nn : Nnet<i32> = Nnet::new();

        let mut layer1 : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);
        let mut layer2 : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);

        nn.add_layer(Box::new(layer1));
        nn.add_layer(Box::new(layer2));

        let biases = vec![1, 2];

        let expected_res = Err(("1 biases expected. Received 2!").to_string());

        assert_eq!(nn.initialise_biases(biases), expected_res);
        assert!(!nn.are_biases_initialised);
    }

    #[test]
    fn test_initialising_biases() {
        let mut nn : Nnet<i32> = Nnet::new();

        let mut layer1 : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);
        let mut layer2 : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);

        nn.add_layer(Box::new(layer1));
        nn.add_layer(Box::new(layer2));

        let biases = vec![1];

        _ = nn.initialise_biases(biases);

        assert!(nn.are_biases_initialised);
        assert_eq!(nn.layers[0].get_bias(), 1);
    }

    #[test]
    fn forward_should_throw_an_error_if_weights_are_not_initialised() {
        let mut nn : Nnet<i32> = Nnet::new();

        let mut layer1 : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);
        let mut layer2 : DenseLayer<i32> = DenseLayer::new(vec![3, 2]);

        nn.add_layer(Box::new(layer1));
        nn.add_layer(Box::new(layer2));

        let biases = vec![1];

        _ = nn.initialise_biases(biases);

        let expected_res = Err("You have not initialised the weights for this neural network!");

        let input : Array<i32, IxDyn> = array![1, 2, 3, 4].into_owned().into_dyn();
        assert_eq!(nn.forward(input), expected_res);
    }

    #[test]
    fn forward_test() {
        // Initialise the neural network
        let mut nn : Nnet<i32> = Nnet::new();

        // Initialise the layers
        let mut layer1 : DenseLayer<i32> = DenseLayer::new(vec![3]);
        let mut layer2 : DenseLayer<i32> = DenseLayer::new(vec![2]);

        // Add the initialised layers to the neural network
        nn.add_layer(Box::new(layer1));
        nn.add_layer(Box::new(layer2));

        // Initialise biases
        let biases = vec![0];
        _ = nn.initialise_biases(biases);

        // Initialise weights
        let weights = vec![array![5, 10, 3, 12, 7, 4]];
        _ = nn.initialise_weights(weights);

        // Test the forward method
        let input : Array<i32, IxDyn> = array![1, 5, 10].into_owned().into_dyn();
        let expected_res : ArrayD<i32> = array![85, 87].into_dyn();
        assert_eq!(nn.forward(input).unwrap(), expected_res);
    }

    #[test]
    fn forward_ciphertext_test() {
        let (rck, sk, pk) = custom_gen_keys();
        let raw_cipher_text1 = pk.encrypt_radix(1u64, 8);
        let raw_cipher_text2 = pk.encrypt_radix(5u64, 8);
        let raw_cipher_text3 = pk.encrypt_radix(10u64, 8);

        let myCipherTxt1 = CipherTextType::new(raw_cipher_text1, pk.clone(), sk.clone());
        let myCipherTxt2 = CipherTextType::new(raw_cipher_text2, pk.clone(), sk.clone());
        let myCipherTxt3 = CipherTextType::new(raw_cipher_text3, pk.clone(), sk.clone());

        // Initialise the neural network
        let mut nn : Nnet<CipherTextType> = Nnet::new();

        // Initialise the layers
        let mut layer1 : DenseLayer<CipherTextType> = DenseLayer::new(vec![3]);
        let mut layer2 : DenseLayer<CipherTextType> = DenseLayer::new(vec![2]);

        // Add the initialised layers to the neural network
        nn.add_layer(Box::new(layer1));
        nn.add_layer(Box::new(layer2));

        // Initialise biases
        let biases = vec![0];
        _ = nn.initialise_biases(biases);

        // Initialise weights
        let weights = vec![array![5, 10, 3, 12, 7, 4]];
        _ = nn.initialise_weights(weights);

        // Test the forward method
        let input : Array<CipherTextType, IxDyn> = array![myCipherTxt1, myCipherTxt2, myCipherTxt3].into_owned().into_dyn();
        let expected_res : ArrayD<u64> = array![85, 87].into_dyn();

        let res1 = &nn.forward(input.clone()).unwrap();
        for x in res1{
            println!("{:?}", rck.decrypt::<u64, tfhe::shortint::ciphertext::KeyswitchBootstrap>(&x.CipherTxt) as i32);
        }
        //let res2 = rck.decrypt::<u64, tfhe::shortint::ciphertext::KeyswitchBootstrap>( &nn.forward(input.clone()).unwrap()[1].CipherTxt);

        //assert_eq!(res1, expected_res[0]);
        //assert_eq!(res2, expected_res[1]);

    }
}


#[cfg(test)]
mod test_activation{
    use Cryptonic::cryptography::ciphtxt::CipherTextType;
    use Cryptonic::cryptography::key_gen::custom_gen_keys;
    use Cryptonic::cryptography::activations::{relu};

    #[test]
    fn test_relu(){
        let (rck, sk, pk) = custom_gen_keys();
        let ct_1 = CipherTextType::new(pk.encrypt_radix(202u64, 8), pk.clone(), sk.clone());

        //let res = relu(ct_1);
        //assert_eq!(rck.decrypt::<u64, tfhe::shortint::ciphertext::KeyswitchBootstrap>(&res), 32768u64);
    }
}