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 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
use super::{CiphertextNoiseDegree, SmartCleaningOperation};
use crate::core_crypto::algorithms::*;
use crate::shortint::ciphertext::Degree;
use crate::shortint::server_key::CheckError;
use crate::shortint::{Ciphertext, ServerKey};
impl ServerKey {
/// Compute homomorphically an addition between two ciphertexts encrypting integer values.
///
/// This function, like all "default" operations (i.e. not smart, checked or unchecked), will
/// check that the input ciphertext carries are empty and clears them if it's not the case and
/// the operation requires it. It outputs a ciphertext whose carry is always empty.
///
/// This means that when using only "default" operations, a given operation (like add for
/// example) has always the same performance characteristics from one call to another and
/// guarantees correctness by pre-emptively clearing carries of output ciphertexts.
///
/// # Example
///
/// ```rust
/// use tfhe::shortint::gen_keys;
/// use tfhe::shortint::parameters::{
/// PARAM_MESSAGE_2_CARRY_2_KS_PBS, PARAM_MESSAGE_2_CARRY_2_PBS_KS,
/// };
///
/// // Generate the client key and the server key:
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_KS_PBS);
///
/// let msg = 1;
///
/// // Encrypt two messages:
/// let ct1 = cks.encrypt(msg);
/// let ct2 = cks.encrypt(msg);
///
/// // Compute homomorphically an addition:
/// let ct_res = sks.add(&ct1, &ct2);
///
/// // Decrypt:
/// let two = cks.decrypt(&ct_res);
/// assert_eq!(msg + msg, two);
///
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_PBS_KS);
///
/// // Encrypt two messages:
/// let ct1 = cks.encrypt(msg);
/// let ct2 = cks.encrypt(msg);
///
/// // Compute homomorphically an addition:
/// let ct_res = sks.add(&ct1, &ct2);
///
/// // Decrypt:
/// let two = cks.decrypt(&ct_res);
/// assert_eq!(msg + msg, two);
/// ```
pub fn add(&self, ct_left: &Ciphertext, ct_right: &Ciphertext) -> Ciphertext {
let mut ct_res = ct_left.clone();
self.add_assign(&mut ct_res, ct_right);
ct_res
}
/// Compute homomorphically an addition between two ciphertexts
///
/// The result is stored in the `ct_left` ciphertext.
///
/// This function, like all "default" operations (i.e. not smart, checked or unchecked), will
/// check that the input ciphertext carries are empty and clears them if it's not the case and
/// the operation requires it. It outputs a ciphertext whose carry is always empty.
///
/// This means that when using only "default" operations, a given operation (like add for
/// example) has always the same performance characteristics from one call to another and
/// guarantees correctness by pre-emptively clearing carries of output ciphertexts.
///
/// # Example
///
/// ```rust
/// use tfhe::shortint::gen_keys;
/// use tfhe::shortint::parameters::{
/// PARAM_MESSAGE_2_CARRY_2_KS_PBS, PARAM_MESSAGE_2_CARRY_2_PBS_KS,
/// };
///
/// // Generate the client key and the server key:
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_KS_PBS);
///
/// let msg1 = 15;
/// let msg2 = 3;
///
/// // Encrypt two messages:
/// let mut ct1 = cks.unchecked_encrypt(msg1);
/// let ct2 = cks.encrypt(msg2);
///
/// // Compute homomorphically an addition:
/// sks.add_assign(&mut ct1, &ct2);
///
/// // Decrypt:
/// let two = cks.decrypt(&ct1);
///
/// // 15 + 3 mod 4 -> 3 + 3 mod 4 -> 2 mod 4
/// let modulus = cks.parameters.message_modulus().0 as u64;
/// assert_eq!((msg2 + msg1) % modulus, two);
///
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_PBS_KS);
///
/// // Encrypt two messages:
/// let mut ct1 = cks.unchecked_encrypt(msg1);
/// let ct2 = cks.encrypt(msg2);
///
/// // Compute homomorphically an addition:
/// sks.add_assign(&mut ct1, &ct2);
///
/// // Decrypt:
/// let two = cks.decrypt(&ct1);
///
/// // 15 + 3 mod 4 -> 3 + 3 mod 4 -> 2 mod 4
/// let modulus = cks.parameters.message_modulus().0 as u64;
/// assert_eq!((msg2 + msg1) % modulus, two);
/// ```
pub fn add_assign(&self, ct_left: &mut Ciphertext, ct_right: &Ciphertext) {
let tmp_rhs: Ciphertext;
if !ct_left.carry_is_empty() {
self.message_extract_assign(ct_left);
}
let rhs = if ct_right.carry_is_empty() {
ct_right
} else {
tmp_rhs = self.message_extract(ct_right);
&tmp_rhs
};
self.unchecked_add_assign(ct_left, rhs);
self.message_extract_assign(ct_left);
}
/// Compute homomorphically an addition between two ciphertexts encrypting integer values.
///
/// The result is returned in a _new_ ciphertext.
///
/// This function computes the addition without checking if it exceeds the capacity of the
/// ciphertext.
///
/// # Example
///
/// ```rust
/// use tfhe::shortint::gen_keys;
/// use tfhe::shortint::parameters::{
/// PARAM_MESSAGE_2_CARRY_2_KS_PBS, PARAM_MESSAGE_2_CARRY_2_PBS_KS,
/// };
///
/// // Generate the client key and the server key:
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_KS_PBS);
///
/// let msg1 = 1;
/// let msg2 = 2;
/// let ct1 = cks.encrypt(msg1);
/// let ct2 = cks.encrypt(msg2);
///
/// // Compute homomorphically an addition:
/// let ct_res = sks.unchecked_add(&ct1, &ct2);
///
/// // Decrypt:
/// let res = cks.decrypt(&ct_res);
/// assert_eq!(msg1 + msg2, res);
///
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_PBS_KS);
///
/// // Same thing using the small key for encryption
/// let msg1 = 1;
/// let msg2 = 2;
/// let ct1 = cks.encrypt(msg1);
/// let ct2 = cks.encrypt(msg2);
///
/// // Compute homomorphically an addition:
/// let ct_res = sks.unchecked_add(&ct1, &ct2);
///
/// // Decrypt:
/// let res = cks.decrypt(&ct_res);
/// assert_eq!(msg1 + msg2, res);
/// ```
pub fn unchecked_add(&self, ct_left: &Ciphertext, ct_right: &Ciphertext) -> Ciphertext {
let mut result = ct_left.clone();
self.unchecked_add_assign(&mut result, ct_right);
result
}
/// Compute homomorphically an addition between two ciphertexts encrypting integer values.
///
/// The result is _stored_ in the `ct_left` ciphertext.
///
/// This function computes the addition without checking if it exceeds the capacity of the
/// ciphertext.
///
/// # Example
///
/// ```rust
/// use tfhe::shortint::gen_keys;
/// use tfhe::shortint::parameters::{
/// PARAM_MESSAGE_2_CARRY_2_KS_PBS, PARAM_MESSAGE_2_CARRY_2_PBS_KS,
/// };
///
/// // Generate the client key and the server key:
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_KS_PBS);
///
/// let msg = 1;
///
/// let mut ct_left = cks.encrypt(msg);
/// let ct_right = cks.encrypt(msg);
///
/// // Compute homomorphically an addition:
/// sks.unchecked_add_assign(&mut ct_left, &ct_right);
///
/// // Decrypt:
/// let two = cks.decrypt(&ct_left);
/// assert_eq!(msg + msg, two);
///
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_PBS_KS);
///
/// let mut ct_left = cks.encrypt(msg);
/// let ct_right = cks.encrypt(msg);
///
/// // Compute homomorphically an addition:
/// sks.unchecked_add_assign(&mut ct_left, &ct_right);
///
/// // Decrypt:
/// let two = cks.decrypt(&ct_left);
/// assert_eq!(msg + msg, two);
/// ```
pub fn unchecked_add_assign(&self, ct_left: &mut Ciphertext, ct_right: &Ciphertext) {
unchecked_add_assign(ct_left, ct_right);
}
/// Verify if ct_left and ct_right can be added together.
///
/// This checks that the sum of their degree is
/// smaller than the maximum degree.
///
/// # Example
///
///```rust
/// use tfhe::shortint::gen_keys;
/// use tfhe::shortint::parameters::{
/// PARAM_MESSAGE_2_CARRY_2_KS_PBS, PARAM_MESSAGE_2_CARRY_2_PBS_KS,
/// };
///
/// // Generate the client key and the server key:
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_KS_PBS);
///
/// let msg = 2u64;
///
/// // Encrypt two messages:
/// let ct_left = cks.encrypt(msg);
/// let ct_right = cks.encrypt(msg);
///
/// // Check if we can perform an addition
/// let can_be_added = sks
/// .is_add_possible(ct_left.noise_degree(), ct_right.noise_degree())
/// .unwrap();
///
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_PBS_KS);
///
/// // Encrypt two messages:
/// let ct_left = cks.encrypt(msg);
/// let ct_right = cks.encrypt(msg);
///
/// // Check if we can perform an addition
/// let can_be_added = sks
/// .is_add_possible(ct_left.noise_degree(), ct_right.noise_degree())
/// .unwrap();
/// ```
pub fn is_add_possible(
&self,
ct_left: CiphertextNoiseDegree,
ct_right: CiphertextNoiseDegree,
) -> Result<(), CheckError> {
self.max_degree.validate(ct_left.degree + ct_right.degree)?;
self.max_noise_level
.validate(ct_left.noise_level + ct_right.noise_level)?;
Ok(())
}
/// Compute homomorphically an addition between two ciphertexts encrypting integer values.
///
/// If the operation can be performed, the result is returned a _new_ ciphertext.
/// Otherwise a [CheckError] is returned.
///
/// # Example
///
/// ```rust
/// use tfhe::shortint::gen_keys;
/// use tfhe::shortint::parameters::{
/// PARAM_MESSAGE_2_CARRY_2_KS_PBS, PARAM_MESSAGE_2_CARRY_2_PBS_KS,
/// };
///
/// // Generate the client key and the server key:
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_KS_PBS);
///
/// let msg = 1;
///
/// // Encrypt two messages:
/// let ct1 = cks.encrypt(msg);
/// let ct2 = cks.encrypt(msg);
///
/// // Compute homomorphically an addition:
/// let ct_res = sks.checked_add(&ct1, &ct2).unwrap();
///
/// let clear_res = cks.decrypt(&ct_res);
/// assert_eq!(clear_res, msg + msg);
///
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_PBS_KS);
///
/// // Encrypt two messages:
/// let ct1 = cks.encrypt(msg);
/// let ct2 = cks.encrypt(msg);
///
/// // Compute homomorphically an addition:
/// let ct_res = sks.checked_add(&ct1, &ct2).unwrap();
///
/// let clear_res = cks.decrypt(&ct_res);
/// assert_eq!(clear_res, msg + msg);
/// ```
pub fn checked_add(
&self,
ct_left: &Ciphertext,
ct_right: &Ciphertext,
) -> Result<Ciphertext, CheckError> {
self.is_add_possible(ct_left.noise_degree(), ct_right.noise_degree())?;
let ct_result = self.unchecked_add(ct_left, ct_right);
Ok(ct_result)
}
/// Compute homomorphically an addition between two ciphertexts encrypting integer values.
///
/// If the operation can be performed, the result is stored in the `ct_left` ciphertext.
/// Otherwise a [CheckError] is returned, and `ct_left` is not modified.
///
/// # Example
///
/// ```rust
/// use tfhe::shortint::gen_keys;
/// use tfhe::shortint::parameters::{
/// PARAM_MESSAGE_2_CARRY_2_KS_PBS, PARAM_MESSAGE_2_CARRY_2_PBS_KS,
/// };
///
/// // Generate the client key and the server key:
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_KS_PBS);
///
/// let msg = 1;
///
/// // Encrypt two messages:
/// let mut ct_left = cks.encrypt(msg);
/// let ct_right = cks.encrypt(msg);
///
/// // Compute homomorphically an addition:
/// sks.checked_add_assign(&mut ct_left, &ct_right).unwrap();
///
/// let clear_res = cks.decrypt(&ct_left);
/// assert_eq!(clear_res, msg + msg);
///
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_PBS_KS);
///
/// // Encrypt two messages:
/// let mut ct_left = cks.encrypt(msg);
/// let ct_right = cks.encrypt(msg);
///
/// // Compute homomorphically an addition:
/// sks.checked_add_assign(&mut ct_left, &ct_right).unwrap();
///
/// let clear_res = cks.decrypt(&ct_left);
/// assert_eq!(clear_res, msg + msg);
/// ```
pub fn checked_add_assign(
&self,
ct_left: &mut Ciphertext,
ct_right: &Ciphertext,
) -> Result<(), CheckError> {
self.is_add_possible(ct_left.noise_degree(), ct_right.noise_degree())?;
self.unchecked_add_assign(ct_left, ct_right);
Ok(())
}
/// Compute homomorphically an addition between two ciphertexts encrypting integer values.
///
/// This checks that the addition is possible. In the case where the carry buffers are full,
/// then it is automatically cleared to allow the operation.
/// # Example
///
/// ```rust
/// use tfhe::shortint::gen_keys;
/// use tfhe::shortint::parameters::{
/// PARAM_MESSAGE_2_CARRY_2_KS_PBS, PARAM_MESSAGE_2_CARRY_2_PBS_KS,
/// };
///
/// // Generate the client key and the server key:
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_KS_PBS);
///
/// let msg = 1;
///
/// // Encrypt two messages:
/// let mut ct1 = cks.encrypt(msg);
/// let mut ct2 = cks.encrypt(msg);
///
/// // Compute homomorphically an addition:
/// let ct_res = sks.smart_add(&mut ct1, &mut ct2);
///
/// // Decrypt:
/// let two = cks.decrypt(&ct_res);
/// assert_eq!(msg + msg, two);
///
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_PBS_KS);
///
/// // Encrypt two messages:
/// let mut ct1 = cks.encrypt(msg);
/// let mut ct2 = cks.encrypt(msg);
///
/// // Compute homomorphically an addition:
/// let ct_res = sks.smart_add(&mut ct1, &mut ct2);
///
/// // Decrypt:
/// let two = cks.decrypt(&ct_res);
/// assert_eq!(msg + msg, two);
/// ```
pub fn smart_add(&self, ct_left: &mut Ciphertext, ct_right: &mut Ciphertext) -> Ciphertext {
let SmartCleaningOperation {
bootstrap_left,
bootstrap_right,
} = self
.binary_smart_op_optimal_cleaning_strategy(ct_left, ct_right, |sk, a, b| {
sk.is_add_possible(a, b).is_ok()
})
.unwrap();
if bootstrap_left {
self.message_extract_assign(ct_left)
}
if bootstrap_right {
self.message_extract_assign(ct_right)
}
self.is_add_possible(ct_left.noise_degree(), ct_right.noise_degree())
.unwrap();
self.unchecked_add(ct_left, ct_right)
}
/// Compute homomorphically an addition between two ciphertexts
///
/// The result is stored in the `ct_left` cipher text.
///
/// # Example
///
/// ```rust
/// use tfhe::shortint::gen_keys;
/// use tfhe::shortint::parameters::{
/// PARAM_MESSAGE_2_CARRY_2_KS_PBS, PARAM_MESSAGE_2_CARRY_2_PBS_KS,
/// };
///
/// // Generate the client key and the server key:
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_KS_PBS);
///
/// let msg1 = 15;
/// let msg2 = 3;
///
/// // Encrypt two messages:
/// let mut ct1 = cks.unchecked_encrypt(msg1);
/// let mut ct2 = cks.encrypt(msg2);
///
/// // Compute homomorphically an addition:
/// sks.smart_add_assign(&mut ct1, &mut ct2);
///
/// // Decrypt:
/// let two = cks.decrypt(&ct1);
///
/// // 15 + 3 mod 4 -> 3 + 3 mod 4 -> 2 mod 4
/// let modulus = cks.parameters.message_modulus().0 as u64;
/// assert_eq!((msg2 + msg1) % modulus, two);
///
/// let (cks, sks) = gen_keys(PARAM_MESSAGE_2_CARRY_2_PBS_KS);
///
/// // Encrypt two messages:
/// let mut ct1 = cks.unchecked_encrypt(msg1);
/// let mut ct2 = cks.encrypt(msg2);
///
/// // Compute homomorphically an addition:
/// sks.smart_add_assign(&mut ct1, &mut ct2);
///
/// // Decrypt:
/// let two = cks.decrypt(&ct1);
///
/// // 15 + 3 mod 4 -> 3 + 3 mod 4 -> 2 mod 4
/// let modulus = cks.parameters.message_modulus().0 as u64;
/// assert_eq!((msg2 + msg1) % modulus, two);
/// ```
pub fn smart_add_assign(&self, ct_left: &mut Ciphertext, ct_right: &mut Ciphertext) {
let SmartCleaningOperation {
bootstrap_left,
bootstrap_right,
} = self
.binary_smart_op_optimal_cleaning_strategy(ct_left, ct_right, |sk, a, b| {
sk.is_add_possible(a, b).is_ok()
})
.unwrap();
if bootstrap_left {
self.message_extract_assign(ct_left)
}
if bootstrap_right {
self.message_extract_assign(ct_right)
}
self.is_add_possible(ct_left.noise_degree(), ct_right.noise_degree())
.unwrap();
self.unchecked_add_assign(ct_left, ct_right);
}
}
pub(crate) fn unchecked_add_assign(ct_left: &mut Ciphertext, ct_right: &Ciphertext) {
lwe_ciphertext_add_assign(&mut ct_left.ct, &ct_right.ct);
ct_left.degree = Degree::new(ct_left.degree.get() + ct_right.degree.get());
ct_left.set_noise_level(ct_left.noise_level() + ct_right.noise_level());
}