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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
#pragma once
#include "seal/context.h"
#include "seal/util/defines.h"
namespace seal
{
class Plaintext;
class Ciphertext;
class SecretKey;
class PublicKey;
class KSwitchKeys;
class RelinKeys;
class GaloisKeys;
/**
Check whether the given plaintext is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
plaintext data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function only checks the metadata and not the
plaintext data itself.
@param[in] in The plaintext to check
@param[in] context The SEALContext
@param[in] allow_pure_key_levels Determines whether pure key levels (i.e.,
non-data levels) should be considered valid
*/
SEAL_NODISCARD bool is_metadata_valid_for(
const Plaintext &in, const SEALContext &context, bool allow_pure_key_levels = false);
/**
Check whether the given ciphertext is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
ciphertext data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function only checks the metadata and not the
ciphertext data itself.
@param[in] in The ciphertext to check
@param[in] context The SEALContext
@param[in] allow_pure_key_levels Determines whether pure key levels (i.e.,
non-data levels) should be considered valid
*/
SEAL_NODISCARD bool is_metadata_valid_for(
const Ciphertext &in, const SEALContext &context, bool allow_pure_key_levels = false);
/**
Check whether the given secret key is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
secret key data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function only checks the metadata and not the
secret key data itself.
@param[in] in The secret key to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_metadata_valid_for(const SecretKey &in, const SEALContext &context);
/**
Check whether the given public key is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
public key data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function only checks the metadata and not the
public key data itself.
@param[in] in The public key to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_metadata_valid_for(const PublicKey &in, const SEALContext &context);
/**
Check whether the given KSwitchKeys is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
KSwitchKeys data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function only checks the metadata and not the
KSwitchKeys data itself.
@param[in] in The KSwitchKeys to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_metadata_valid_for(const KSwitchKeys &in, const SEALContext &context);
/**
Check whether the given RelinKeys is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
RelinKeys data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function only checks the metadata and not the
RelinKeys data itself.
@param[in] in The RelinKeys to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_metadata_valid_for(const RelinKeys &in, const SEALContext &context);
/**
Check whether the given GaloisKeys is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
GaloisKeys data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function only checks the metadata and not the
GaloisKeys data itself.
@param[in] in The GaloisKeys to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_metadata_valid_for(const GaloisKeys &in, const SEALContext &context);
/**
Check whether the given plaintext data buffer is valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the plaintext data buffer does not match the SEALContext, this function
returns false. Otherwise, returns true. This function only checks the size of
the data buffer and not the plaintext data itself.
@param[in] in The plaintext to check
*/
SEAL_NODISCARD bool is_buffer_valid(const Plaintext &in);
/**
Check whether the given ciphertext data buffer is valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the ciphertext data buffer does not match the SEALContext, this function
returns false. Otherwise, returns true. This function only checks the size of
the data buffer and not the ciphertext data itself.
@param[in] in The ciphertext to check
*/
SEAL_NODISCARD bool is_buffer_valid(const Ciphertext &in);
/**
Check whether the given secret key data buffer is valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the secret key data buffer does not match the SEALContext, this function
returns false. Otherwise, returns true. This function only checks the size of
the data buffer and not the secret key data itself.
@param[in] in The secret key to check
*/
SEAL_NODISCARD bool is_buffer_valid(const SecretKey &in);
/**
Check whether the given public key data buffer is valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the public key data buffer does not match the SEALContext, this function
returns false. Otherwise, returns true. This function only checks the size of
the data buffer and not the public key data itself.
@param[in] in The public key to check
*/
SEAL_NODISCARD bool is_buffer_valid(const PublicKey &in);
/**
Check whether the given KSwitchKeys data buffer is valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the KSwitchKeys data buffer does not match the SEALContext, this function
returns false. Otherwise, returns true. This function only checks the size of
the data buffer and not the KSwitchKeys data itself.
@param[in] in The KSwitchKeys to check
*/
SEAL_NODISCARD bool is_buffer_valid(const KSwitchKeys &in);
/**
Check whether the given RelinKeys data buffer is valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the RelinKeys data buffer does not match the SEALContext, this function
returns false. Otherwise, returns true. This function only checks the size of
the data buffer and not the RelinKeys data itself.
@param[in] in The RelinKeys to check
*/
SEAL_NODISCARD bool is_buffer_valid(const RelinKeys &in);
/**
Check whether the given GaloisKeys data buffer is valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the GaloisKeys data buffer does not match the SEALContext, this function
returns false. Otherwise, returns true. This function only checks the size of
the data buffer and not the GaloisKeys data itself.
@param[in] in The GaloisKeys to check
*/
SEAL_NODISCARD bool is_buffer_valid(const GaloisKeys &in);
/**
Check whether the given plaintext data and metadata are valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the plaintext data does not match the SEALContext, this function returns
false. Otherwise, returns true. This function can be slow, as it checks the
correctness of the entire plaintext data buffer.
@param[in] in The plaintext to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_data_valid_for(const Plaintext &in, const SEALContext &context);
/**
Check whether the given ciphertext data and metadata are valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the ciphertext data does not match the SEALContext, this function returns
false. Otherwise, returns true. This function can be slow, as it checks the
correctness of the entire ciphertext data buffer.
@param[in] in The ciphertext to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_data_valid_for(const Ciphertext &in, const SEALContext &context);
/**
Check whether the given secret key data and metadata are valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the secret key data does not match the SEALContext, this function returns
false. Otherwise, returns true. This function can be slow, as it checks the
correctness of the entire secret key data buffer.
@param[in] in The secret key to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_data_valid_for(const SecretKey &in, const SEALContext &context);
/**
Check whether the given public key data and metadata are valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the public key data does not match the SEALContext, this function returns
false. Otherwise, returns true. This function can be slow, as it checks the
correctness of the entire public key data buffer.
@param[in] in The public key to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_data_valid_for(const PublicKey &in, const SEALContext &context);
/**
Check whether the given KSwitchKeys data and metadata are valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the KSwitchKeys data does not match the SEALContext, this function returns
false. Otherwise, returns true. This function can be slow, as it checks the
correctness of the entire KSwitchKeys data buffer.
@param[in] in The KSwitchKeys to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_data_valid_for(const KSwitchKeys &in, const SEALContext &context);
/**
Check whether the given RelinKeys data and metadata are valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the RelinKeys data does not match the SEALContext, this function returns
false. Otherwise, returns true. This function can be slow, as it checks the
correctness of the entire RelinKeys data buffer.
@param[in] in The RelinKeys to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_data_valid_for(const RelinKeys &in, const SEALContext &context);
/**
Check whether the given GaloisKeys data and metadata are valid for a given SEALContext.
If the given SEALContext is not set, the encryption parameters are invalid,
or the GaloisKeys data does not match the SEALContext, this function returns
false. Otherwise, returns true. This function can be slow, as it checks the
correctness of the entire GaloisKeys data buffer.
@param[in] in The GaloisKeys to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD bool is_data_valid_for(const GaloisKeys &in, const SEALContext &context);
/**
Check whether the given plaintext is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
plaintext data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function can be slow as it checks the validity
of all metadata and of the entire plaintext data buffer.
@param[in] in The plaintext to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD inline bool is_valid_for(const Plaintext &in, const SEALContext &context)
{
return is_buffer_valid(in) && is_data_valid_for(in, context);
}
/**
Check whether the given ciphertext is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
ciphertext data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function can be slow as it checks the validity
of all metadata and of the entire ciphertext data buffer.
@param[in] in The ciphertext to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD inline bool is_valid_for(const Ciphertext &in, const SEALContext &context)
{
return is_buffer_valid(in) && is_data_valid_for(in, context);
}
/**
Check whether the given secret key is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
secret key data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function can be slow as it checks the validity
of all metadata and of the entire secret key data buffer.
@param[in] in The secret key to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD inline bool is_valid_for(const SecretKey &in, const SEALContext &context)
{
return is_buffer_valid(in) && is_data_valid_for(in, context);
}
/**
Check whether the given public key is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
public key data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function can be slow as it checks the validity
of all metadata and of the entire public key data buffer.
@param[in] in The public key to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD inline bool is_valid_for(const PublicKey &in, const SEALContext &context)
{
return is_buffer_valid(in) && is_data_valid_for(in, context);
}
/**
Check whether the given KSwitchKeys is valid for a given SEALContext. If
the given SEALContext is not set, the encryption parameters are invalid,
or the KSwitchKeys data does not match the SEALContext, this function returns
false. Otherwise, returns true. This function can be slow as it checks the validity
of all metadata and of the entire KSwitchKeys data buffer.
@param[in] in The KSwitchKeys to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD inline bool is_valid_for(const KSwitchKeys &in, const SEALContext &context)
{
return is_buffer_valid(in) && is_data_valid_for(in, context);
}
/**
Check whether the given RelinKeys is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
RelinKeys data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function can be slow as it checks the validity
of all metadata and of the entire RelinKeys data buffer.
@param[in] in The RelinKeys to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD inline bool is_valid_for(const RelinKeys &in, const SEALContext &context)
{
return is_buffer_valid(in) && is_data_valid_for(in, context);
}
/**
Check whether the given GaloisKeys is valid for a given SEALContext. If the
given SEALContext is not set, the encryption parameters are invalid, or the
GaloisKeys data does not match the SEALContext, this function returns false.
Otherwise, returns true. This function can be slow as it checks the validity
of all metadata and of the entire GaloisKeys data buffer.
@param[in] in The GaloisKeys to check
@param[in] context The SEALContext
*/
SEAL_NODISCARD inline bool is_valid_for(const GaloisKeys &in, const SEALContext &context)
{
return is_buffer_valid(in) && is_data_valid_for(in, context);
}
} // namespace seal