tfhe 1.8.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

use serde::{Deserialize, Serialize};
use tfhe_versionable::Versionize;

use crate::conformance::ParameterSetConformant;
use crate::high_level_api::backward_compatibility::transciphering::StreamCiphertextVersions;
use crate::integer::transciphering::{
    IntegerStreamCiphertext, IntegerStreamCiphertextConformanceParams, IntegerStreamCiphertextKind,
};
use crate::named::Named;
use crate::transciphering::StreamCipherKind;

/// A symmetric-cipher ciphertext, produced by [`HlStreamCipher::try_encrypt`]
/// and consumed by [`HlTranscipherer::transcipher`].
///
/// Its bytes are stream-cipher output, which is plaintext from the FHE point of
/// view. It therefore holds no FHE ciphertext, does not depend on the choice of parameters, carries
/// no [`Tag`], and is not bound to a device.
///
/// [`HlStreamCipher::try_encrypt`]: super::HlStreamCipher::try_encrypt
/// [`HlTranscipherer::transcipher`]: super::HlTranscipherer::transcipher
/// [`Tag`]: crate::Tag
#[derive(Clone, Debug, Serialize, Deserialize, Versionize)]
#[versionize(StreamCiphertextVersions)]
pub struct StreamCiphertext {
    inner: IntegerStreamCiphertext,
}

impl StreamCiphertext {
    /// Cipher family that produced this ciphertext. A [`TranscipherSession`]
    /// refuses inputs from another family.
    ///
    /// [`TranscipherSession`]: super::TranscipherSession
    pub fn cipher_kind(&self) -> StreamCipherKind {
        self.inner.inner().kind()
    }

    /// Shape of the value this ciphertext encrypts, which decides the type it
    /// can be transciphered into.
    pub fn kind(&self) -> IntegerStreamCiphertextKind {
        self.inner.kind()
    }

    /// Keystream bit position at which this ciphertext was encrypted.
    pub fn encryption_counter(&self) -> u64 {
        self.inner.inner().encryption_counter()
    }

    pub fn n_bits(&self) -> usize {
        self.inner.n_bits()
    }

    pub fn from_raw_parts(inner: IntegerStreamCiphertext) -> Self {
        Self { inner }
    }

    pub fn into_raw_parts(self) -> IntegerStreamCiphertext {
        self.inner
    }

    pub(super) fn integer(&self) -> &IntegerStreamCiphertext {
        &self.inner
    }
}

impl ParameterSetConformant for StreamCiphertext {
    type ParameterSet = IntegerStreamCiphertextConformanceParams;

    fn is_conformant(&self, params: &Self::ParameterSet) -> bool {
        self.inner.is_conformant(params)
    }
}

impl Named for StreamCiphertext {
    const NAME: &'static str = "high_level_api::StreamCiphertext";
}