tfhe 1.6.0

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

use super::utils::*;
use crate::c_api::utils::*;
use std::os::raw::c_int;

pub struct ClientKey(pub(crate) crate::high_level_api::ClientKey);
pub struct PublicKey(pub(crate) crate::high_level_api::PublicKey);
pub struct CompactPublicKey(pub(crate) crate::high_level_api::CompactPublicKey);
pub struct CompressedCompactPublicKey(pub(crate) crate::high_level_api::CompressedCompactPublicKey);

/// ServerKey that contains all necessary sub-keys for computations
///
/// The ServerKey uses a shared ownership model via reference counting
pub struct ServerKey(pub(crate) crate::high_level_api::ServerKey);

/// Compressed version of the ServerKey
///
/// Allows to save storage space and transfer time.
///
/// Also, the CompressedServerKey is the key format that allows to select
/// the target hardware of the actual ServerKey when decompressing it.
pub struct CompressedServerKey(pub(crate) crate::high_level_api::CompressedServerKey);

/// ServerKey that lives on a Cuda GPU
///
/// The CudaServerKey uses a shared ownership model via reference counting
#[cfg(feature = "gpu")]
pub struct CudaServerKey(pub(crate) crate::high_level_api::CudaServerKey);

impl_destroy_on_type!(ClientKey);
impl_destroy_on_type!(PublicKey);
impl_destroy_on_type!(CompactPublicKey);
impl_destroy_on_type!(CompressedCompactPublicKey);
impl_destroy_on_type!(ServerKey);
impl_destroy_on_type!(CompressedServerKey);
#[cfg(feature = "gpu")]
impl_destroy_on_type!(CudaServerKey);

impl_serialize_deserialize_on_type!(ClientKey);
impl_serialize_deserialize_on_type!(PublicKey);
impl_serialize_deserialize_on_type!(CompactPublicKey);
impl_serialize_deserialize_on_type!(CompressedCompactPublicKey);
impl_serialize_deserialize_on_type!(ServerKey);
impl_serialize_deserialize_on_type!(CompressedServerKey);

impl_safe_serialize_on_type!(ClientKey);
impl_safe_serialize_on_type!(PublicKey);
impl_safe_serialize_on_type!(CompactPublicKey);
impl_safe_serialize_on_type!(CompressedCompactPublicKey);
impl_safe_serialize_on_type!(ServerKey);
impl_safe_serialize_on_type!(CompressedServerKey);

impl_safe_deserialize_on_type!(ClientKey);
impl_safe_deserialize_on_type!(PublicKey);
impl_safe_deserialize_on_type!(CompactPublicKey);
impl_safe_deserialize_on_type!(CompressedCompactPublicKey);
impl_safe_deserialize_on_type!(ServerKey);
impl_safe_deserialize_on_type!(CompressedServerKey);

/// Generates a pair of ClientKey and ServerKey using the config
///
/// This moves/takes ownership of the config, meaning it MUST NOT
/// be used of freed after.
#[no_mangle]
pub unsafe extern "C" fn generate_keys(
    config: *mut super::config::Config,
    result_client_key: *mut *mut ClientKey,
    result_server_key: *mut *mut ServerKey,
) -> c_int {
    catch_panic(|| {
        check_ptr_is_non_null_and_aligned(result_client_key).unwrap();
        check_ptr_is_non_null_and_aligned(result_server_key).unwrap();

        *result_client_key = std::ptr::null_mut();
        *result_server_key = std::ptr::null_mut();

        let config = Box::from_raw(config);

        let (cks, sks) = crate::high_level_api::generate_keys(config.0);

        *result_client_key = Box::into_raw(Box::new(ClientKey(cks)));
        *result_server_key = Box::into_raw(Box::new(ServerKey(sks)));
    })
}

/// Sets the given ServerKey into local storage.
///
/// Computations done after this call will use the given server key
///
/// This increases the reference count of the key, so the caller should still
/// destroy the `server_key` and also use `unset_server_key` to fully delete it.
#[no_mangle]
pub unsafe extern "C" fn set_server_key(server_key: *const ServerKey) -> c_int {
    catch_panic(|| {
        let server_key = get_ref_checked(server_key).unwrap();

        let cloned = server_key.0.clone();
        crate::high_level_api::set_server_key(cloned);
    })
}

/// Sets the cuda server key.
///
/// Once a cuda server key is set in a thread, all computations done in
/// that thread will actually happen on the Cuda GPU.
///
/// Does not take ownership of the key
#[cfg(feature = "gpu")]
#[no_mangle]
pub unsafe extern "C" fn set_cuda_server_key(server_key: *const CudaServerKey) -> c_int {
    catch_panic(|| {
        let server_key = get_ref_checked(server_key).unwrap();

        let cloned = server_key.0.clone();
        crate::high_level_api::set_server_key(cloned);
    })
}

/// Removes the current server key that is in the local storage
///
/// No-op if no server key is present
#[no_mangle]
pub unsafe extern "C" fn unset_server_key() -> c_int {
    catch_panic(|| {
        crate::high_level_api::unset_server_key();
    })
}

/// Creates a new compressed server key
#[no_mangle]
pub unsafe extern "C" fn compressed_server_key_new(
    client_key: *const ClientKey,
    result_server_key: *mut *mut CompressedServerKey,
) -> c_int {
    catch_panic(|| {
        check_ptr_is_non_null_and_aligned(result_server_key).unwrap();
        *result_server_key = std::ptr::null_mut();

        let cks = get_ref_checked(client_key).unwrap();

        let sks = crate::high_level_api::CompressedServerKey::new(&cks.0);

        *result_server_key = Box::into_raw(Box::new(CompressedServerKey(sks)));
    })
}

/// Decompresses the CompressedServerKey to a ServerKey that lives on CPU
#[no_mangle]
pub unsafe extern "C" fn compressed_server_key_decompress(
    compressed_server_key: *const CompressedServerKey,
    result_server_key: *mut *mut ServerKey,
) -> c_int {
    catch_panic(|| {
        check_ptr_is_non_null_and_aligned(result_server_key).unwrap();
        *result_server_key = std::ptr::null_mut();

        let c_sks = get_ref_checked(compressed_server_key).unwrap();

        let sks = c_sks.0.decompress();

        *result_server_key = Box::into_raw(Box::new(ServerKey(sks)));
    })
}

/// Decompresses the CompressedServerKey to a CudaServerKey that lives on GPU
#[cfg(feature = "gpu")]
#[no_mangle]
pub unsafe extern "C" fn compressed_server_key_decompress_to_gpu(
    compressed_server_key: *const CompressedServerKey,
    result_server_key: *mut *mut CudaServerKey,
) -> c_int {
    catch_panic(|| {
        check_ptr_is_non_null_and_aligned(result_server_key).unwrap();
        *result_server_key = std::ptr::null_mut();

        let c_sks = get_ref_checked(compressed_server_key).unwrap();

        let sks = c_sks.0.decompress_to_gpu();

        *result_server_key = Box::into_raw(Box::new(CudaServerKey(sks)));
    })
}

/// Generates a client key with the given config
///
/// This function takes ownership of the config,
/// thus the given config pointer should not be used/freed after.
#[no_mangle]
pub unsafe extern "C" fn client_key_generate(
    config: *mut super::config::Config,
    result_client_key: *mut *mut ClientKey,
) -> c_int {
    catch_panic(|| {
        check_ptr_is_non_null_and_aligned(result_client_key).unwrap();

        *result_client_key = std::ptr::null_mut();

        let config = Box::from_raw(config);

        let cks = crate::high_level_api::ClientKey::generate(config.0);

        *result_client_key = Box::into_raw(Box::new(ClientKey(cks)));
    })
}

#[no_mangle]
pub unsafe extern "C" fn public_key_new(
    client_key: *const ClientKey,
    result_public_key: *mut *mut PublicKey,
) -> c_int {
    catch_panic(|| {
        let client_key = get_ref_checked(client_key).unwrap();
        let inner = crate::high_level_api::PublicKey::new(&client_key.0);

        *result_public_key = Box::into_raw(Box::new(PublicKey(inner)));
    })
}

#[no_mangle]
pub unsafe extern "C" fn compact_public_key_new(
    client_key: *const ClientKey,
    result_public_key: *mut *mut CompactPublicKey,
) -> c_int {
    catch_panic(|| {
        let client_key = get_ref_checked(client_key).unwrap();
        let inner = crate::high_level_api::CompactPublicKey::new(&client_key.0);

        *result_public_key = Box::into_raw(Box::new(CompactPublicKey(inner)));
    })
}

#[no_mangle]
pub unsafe extern "C" fn compressed_compact_public_key_new(
    client_key: *const ClientKey,
    result_public_key: *mut *mut CompressedCompactPublicKey,
) -> c_int {
    catch_panic(|| {
        let client_key = get_ref_checked(client_key).unwrap();
        let inner = crate::high_level_api::CompressedCompactPublicKey::new(&client_key.0);

        *result_public_key = Box::into_raw(Box::new(CompressedCompactPublicKey(inner)));
    })
}

#[no_mangle]
pub unsafe extern "C" fn compressed_compact_public_key_decompress(
    public_key: *const CompressedCompactPublicKey,
    result_public_key: *mut *mut CompactPublicKey,
) -> c_int {
    catch_panic(|| {
        let public_key = get_ref_checked(public_key).unwrap();

        *result_public_key = Box::into_raw(Box::new(CompactPublicKey(public_key.0.decompress())));
    })
}