Crate concrete

Welcome to concrete documentation

The goal of this crate is to make it as easy as possible to write FHE programs by abstracting away most of the FHE details and by providing data types which are as close as possible to the native ones (bool, u8, u16) that we are used to.

Cargo Features

Data Types

This crate exposes 3 kinds of data types, each kind is enabled by activating its corresponding feature. Each kind may have multiple types:

Kind	Cargo Feature	Type(s)
Booleans	booleans	FheBool
ShortInts	shortints	FheUint2 FheUint3 FheUint4
Integers	integers	FheUint8 FheUint12 FheUint16

Dynamic types

To allow further customization, it is possible to create at runtime new data types which are based on a certain kind.

For example it is possible to create your own 10 bits integer data type.

Example

Creating a 10-bits integer by combining 5 2-bits shortints

// This requires the integers feature
#[cfg(feature = "integers")]
{
    use concrete::prelude::*;
    use concrete::{
        generate_keys, set_server_key, ConfigBuilder, DynIntegerParameters, FheUint2Parameters,
    };

    let mut config = ConfigBuilder::all_disabled();
    let uint10_type = config.add_integer_type(DynIntegerParameters {
        block_parameters: FheUint2Parameters::default().into(),
        num_block: 5,
    });

    let (client_key, server_key) = generate_keys(config);

    set_server_key(server_key);

    let a = uint10_type.encrypt(177, &client_key);
    let b = uint10_type.encrypt(100, &client_key);

    let c: u64 = (a + b).decrypt(&client_key);
    assert_eq!(c, 277);
}

Serialization

Most of the data types are Serializable and Deserializable via the serde crate and its corresponding feature: serde.

Activating features

To activate features, in your Cargo.toml add:

concrete = { version = "0.2.0-beta", features = ["booleans", "serde"] }

Re-exports

pub use errors::OutOfRangeError;

Modules

errors

parameters

prelude

The concrete prelude. The purpose of this module is to make it easier to have the most commonly needed traits of this crate.

Structs

ClientKey

Key of the client

Config

The config type

ConfigBuilder

The builder to create your config

DynFheBoolbooleans

An instance of a dynamically defined boolean type

DynFheBoolEncryptorbooleans

struct to create new values of a dynamically defined type of boolean

DynIntegerintegers

An instance of a dynamically defined integer type

DynIntegerEncryptorintegers

DynIntegerParametersintegers

DynShortIntshortints

DynShortIntEncryptorshortints

An instance of a dynamically defined shortint type

DynShortIntParametersshortints

A structure defining the set of cryptographic parameters for homomorphic integer circuit evaluation.

FheBoolbooleans

The FHE boolean data type.

FheBoolParametersbooleans

GenericIntegerintegers

A Generic FHE unsigned integer

GenericShortIntshortints

A Generic short FHE unsigned integer

KeyCacherserde

KeyCacher

ServerKey

Key of the server

Functions

generate_keys

Generates keys using the provided config.

if_then_elsebooleans

set_server_key

The function used to initialize internal keys.

Type Definitions

FheUint2shortints

An unsigned integer type with 2 bits.

FheUint2Parametersshortints

Parameters for the FheUint2 data type.

FheUint3shortints

An unsigned integer type with 3 bits.

FheUint3Parametersshortints

Parameters for the FheUint3 data type.

FheUint4shortints

An unsigned integer type with 4 bits.

FheUint4Parametersshortints

Parameters for the FheUint4 data type.

FheUint8integers

An unsigned integer type with 8 bits.

FheUint12integers

An unsigned integer type with 12 bits.

FheUint16integers

An unsigned integer type with 16 bits.