tfhe 1.6.0

TFHE-rs is a fully homomorphic encryption (FHE) library that implements Zama's variant of TFHE.
Documentation
use crate::shortint::atomic_pattern::AtomicPatternParameters;
use crate::shortint::backward_compatibility::parameters::compact_public_key_only::{
    CompactCiphertextListExpansionKindVersions, CompactPublicKeyEncryptionParametersVersions,
};
use crate::shortint::parameters::{
    AtomicPatternKind, CarryModulus, CiphertextModulus, ClassicPBSParameters, DynamicDistribution,
    LweDimension, MessageModulus, MultiBitPBSParameters, PBSParameters, ShortintParameterSet,
    SupportedCompactPkeZkScheme,
};
use crate::shortint::{KeySwitchingKeyView, PaddingBit, ShortintEncoding};
use crate::Error;
use serde::{Deserialize, Serialize};
use tfhe_versionable::Versionize;

#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, Versionize)]
#[versionize(CompactCiphertextListExpansionKindVersions)]
pub enum CompactCiphertextListExpansionKind {
    RequiresCasting,
    NoCasting(AtomicPatternKind),
}

pub type CastingFunctionsOwned<'functions> =
    Vec<Option<Vec<&'functions (dyn Fn(u64) -> u64 + Sync)>>>;
pub type CastingFunctionsView<'functions> =
    &'functions [Option<Vec<&'functions (dyn Fn(u64) -> u64 + Sync)>>];

#[derive(Clone, Copy)]
pub enum ShortintCompactCiphertextListCastingMode<'a> {
    CastIfNecessary {
        casting_key: KeySwitchingKeyView<'a>,
        functions: Option<CastingFunctionsView<'a>>,
    },
    NoCasting,
}

impl From<AtomicPatternKind> for CompactCiphertextListExpansionKind {
    fn from(value: AtomicPatternKind) -> Self {
        Self::NoCasting(value)
    }
}

#[derive(Debug, Clone, Copy, PartialEq, serde::Serialize, serde::Deserialize, Versionize)]
#[versionize(CompactPublicKeyEncryptionParametersVersions)]
pub struct CompactPublicKeyEncryptionParameters {
    pub encryption_lwe_dimension: LweDimension,
    pub encryption_noise_distribution: DynamicDistribution<u64>,
    pub message_modulus: MessageModulus,
    pub carry_modulus: CarryModulus,
    pub ciphertext_modulus: CiphertextModulus,
    pub expansion_kind: CompactCiphertextListExpansionKind,
    // Version of the PKE zk scheme compatible with these parameters
    pub zk_scheme: SupportedCompactPkeZkScheme,
}

impl CompactPublicKeyEncryptionParameters {
    pub const fn try_new(
        encryption_lwe_dimension: LweDimension,
        encryption_noise_distribution: DynamicDistribution<u64>,
        message_modulus: MessageModulus,
        carry_modulus: CarryModulus,
        ciphertext_modulus: CiphertextModulus,
        output_ciphertext_kind: CompactCiphertextListExpansionKind,
        zk_scheme: SupportedCompactPkeZkScheme,
    ) -> Result<Self, &'static str> {
        let parameters = Self {
            encryption_lwe_dimension,
            encryption_noise_distribution,
            message_modulus,
            carry_modulus,
            ciphertext_modulus,
            expansion_kind: output_ciphertext_kind,
            zk_scheme,
        };

        if !parameters.is_valid() {
            return Err("Invalid CompactPublicKeyEncryptionParameters, \
                        encryption_lwe_dimension is not a power of 2, which is required.");
        }

        Ok(parameters)
    }

    pub const fn is_valid(&self) -> bool {
        self.encryption_lwe_dimension.0.is_power_of_two()
    }

    /// This should be used while defining static parameters to verify they comply with the
    /// requirements of compact public key encryption.
    pub const fn validate(self) -> Self {
        if self.is_valid() {
            return self;
        }

        panic!(
            "Invalid CompactPublicKeyEncryptionParameters, \
            encryption_lwe_dimension is not a power of 2, which is required.",
        );
    }

    pub(crate) fn encoding(&self) -> ShortintEncoding<u64> {
        ShortintEncoding {
            ciphertext_modulus: self.ciphertext_modulus,
            message_modulus: self.message_modulus,
            carry_modulus: self.carry_modulus,
            padding_bit: PaddingBit::Yes,
        }
    }

    pub const fn from_shortint_parameter_set(
        parameters: ShortintParameterSet,
    ) -> Result<Self, &'static str> {
        if parameters.wopbs_only() {
            return Err(
                "Cannot convert Wopbs only parameters to CompactPublicKeyEncryption parameters.",
            );
        }

        let encryption_lwe_dimension = parameters.encryption_lwe_dimension();
        let encryption_noise_distribution = parameters.encryption_noise_distribution();
        let message_modulus = parameters.message_modulus();
        let carry_modulus = parameters.carry_modulus();
        let ciphertext_modulus = parameters.ciphertext_modulus();
        let output_ciphertext_kind =
            CompactCiphertextListExpansionKind::NoCasting(parameters.atomic_pattern());

        Self::try_new(
            encryption_lwe_dimension,
            encryption_noise_distribution,
            message_modulus,
            carry_modulus,
            ciphertext_modulus,
            output_ciphertext_kind,
            // Zk needs specific pke parameters
            SupportedCompactPkeZkScheme::ZkNotSupported,
        )
    }
}

impl TryFrom<ShortintParameterSet> for CompactPublicKeyEncryptionParameters {
    type Error = Error;

    #[track_caller]
    fn try_from(parameters: ShortintParameterSet) -> Result<Self, Self::Error> {
        Self::from_shortint_parameter_set(parameters).map_err(|e| crate::error!("{e}"))
    }
}

impl TryFrom<ClassicPBSParameters> for CompactPublicKeyEncryptionParameters {
    type Error = Error;

    fn try_from(value: ClassicPBSParameters) -> Result<Self, Self::Error> {
        let params: PBSParameters = value.into();
        params.try_into()
    }
}

impl TryFrom<MultiBitPBSParameters> for CompactPublicKeyEncryptionParameters {
    type Error = Error;

    fn try_from(value: MultiBitPBSParameters) -> Result<Self, Self::Error> {
        let params: PBSParameters = value.into();
        params.try_into()
    }
}

impl TryFrom<PBSParameters> for CompactPublicKeyEncryptionParameters {
    type Error = Error;

    fn try_from(value: PBSParameters) -> Result<Self, Self::Error> {
        let params: ShortintParameterSet = value.into();
        params.try_into()
    }
}

impl TryFrom<AtomicPatternParameters> for CompactPublicKeyEncryptionParameters {
    type Error = Error;

    fn try_from(value: AtomicPatternParameters) -> Result<Self, Self::Error> {
        let params: ShortintParameterSet = value.into();
        params.try_into()
    }
}