Crate sunscreen

Expand description

This crate contains the frontend compiler for Sunscreen fhe_program and the types and algorithms that support it.

Examples

This example is further annotated in examples/simple_multiply.


#[fhe_program(scheme = "bfv")]
fn simple_multiply(a: Cipher<Signed>, b: Cipher<Signed>) -> Cipher<Signed> {
    a * b
}

fn main() {
  let app = Compiler::new()
      .fhe_program(simple_multiply)
      .plain_modulus_constraint(PlainModulusConstraint::Raw(600))
      .additional_noise_budget(5)
      .compile()
      .unwrap();

  let runtime = Runtime::new(app.params()).unwrap();

  let (public_key, private_key) = runtime.generate_keys().unwrap();

  let a = runtime.encrypt(Signed::from(15), &public_key).unwrap();
  let b = runtime.encrypt(Signed::from(5), &public_key).unwrap();

  let results = runtime.run(app.get_program(simple_multiply).unwrap(), vec![a, b], &public_key).unwrap();

  let c: Signed = runtime.decrypt(&results[0], &private_key).unwrap();

  assert_eq!(c, 75.into());
}

Modules

types

This module contains types used during fhe_program construction.

Structs

Application

The outcome of successful compilation. Contains one or more CompiledFheProgram.

CallSignature

Indicates the type signatures of an Fhe Program. Serves as a piece of the FheProgramMetadata.

Ciphertext

An encryption of the given data type. Note, the data type is stored in plaintext and is considered part of Sunscreen’s runtime protocol.

CompiledFheProgram

An FHE program with its associated metadata.

Compiler

A frontend compiler for Sunscreen FHE programs.

Context

The context for constructing the fhe_program graph during compilation.

FheProgramMetadata

A serializable list of requirements for an Fhe Program.

FrontendCompilation

Contains the frontend compilation graph.

Params

The parameter set required for a given FHE program to run efficiently and correctly.

Plaintext

Represents an encoded plaintext suitable for use in the underlying scheme.

PrivateKey

The private key used to decrypt ciphertexts.

PublicKey

A bundle of public keys. These may be freely shared with other parties without risk of compromising data security.

Runtime

Contains all the elements needed to encrypt, decrypt, generate keys, and evaluate FHE programs.

SealPlaintext

Class to store a plaintext element. The data for the plaintext is a polynomial with coefficients modulo the plaintext modulus. The degree of the plaintext polynomial must be one less than the degree of the polynomial modulus. The backing array always allocates one 64-bit word per each coefficient of the polynomial.

WithContext

A data type that contains parameters for reconstructing a context during deserialization (needed by SEAL).

Enums

Error

Represents an error that can occur in this crate.

FheProgramInput

An input argument to an Fhe Program. See crate::Runtime::run.

InnerCiphertext

The underlying backend implementation of a ciphertext (e.g SEAL’s Ciphertext).

InnerPlaintext

The underlying backend implementation of a plaintext (e.g. SEAL’s Plaintext).

Literal

Represents a literal node’s data.

OperandInfo

Information about an edge in the frontend IR.

Operation

Represents an operation occurring in the frontend AST.

PlainModulusConstraint

A constraint on the plaintext

RequiredKeys

A key type required for an Fhe Program to function correctly.

RuntimeError

Represents an error that can occur in this crate.

SchemeType

Sunscreen supports the BFV scheme.

SecurityLevel

Represents a standard security level according to the HomomorphicEncryption.org security standard. The value SecLevelType.None signals that no standard security level should be imposed. The value SecLevelType.TC128 provides a very high level of security and is the default security level enforced by Microsoft SEAL when constructing a SEALContext object. Normal users should not have to specify the security level explicitly anywhere.