homomorpheR: Homomorphic computations in R

Description

homomorpheR is a start at a rudimentary package for homomorphic computations in R. The goal is to collect homomorphic encryption schemes in this package for privacy-preserving distributed computations; for example, applications of the sort immplemented in package distcomp.

Details

At the moment, only one scheme is implemented, the Paillier scheme. The current implementation makes no pretense at efficiency and also uses direct translations of other implementations, particularly the one in Javascript.

For a quick overview of the features, refer to the vignettes in this package.

Author(s)

Maintainer: Balasubramanian Narasimhan naras@stat.Stanford.EDU

References

Homomorphic Encryyption

Paillier Encryption

See Also

Useful links:

• https://github.com/bnaras/homomorpheR

• Report bugs at https://github.com/bnaras/homomorpheR/issues

Examples

keys <- PaillierKeyPair$new(1024) # Generate new key pair
encryptAndDecrypt <- function(x) keys$getPrivateKey()$decrypt(keys$pubkey$encrypt(x))
a <- gmp::as.bigz(1273849)
identical(a + 10L, encryptAndDecrypt(a+10L))
x <- lapply(1:100, function(x) random.bigz(nBits = 512))
edx <- lapply(x, encryptAndDecrypt)
identical(x, edx)

Construct a Paillier public and private key pair given a fixed number of bits

Description

Construct a Paillier public and private key pair given a fixed number of bits

Construct a Paillier public and private key pair given a fixed number of bits

Format

An R6::R6Class() generator object

Methods

PaillierKeyPair$getPrivateKey()

Return the private key

Public fields

Methods

Public methods

• PaillierKeyPair$new()

• PaillierKeyPair$getPrivateKey()

• PaillierKeyPair$clone()

Method new()

Create a new public private key pair with specified number of modulus bits

Usage

PaillierKeyPair$new(modulusBits)

Arguments

Returns

a PaillierKeyPair object

Method getPrivateKey()

Return the private key

Usage

PaillierKeyPair$getPrivateKey()

Returns

the private key

Method clone()

The objects of this class are cloneable with this method.

Usage

PaillierKeyPair$clone(deep = FALSE)

Arguments

See Also

PaillierPublicKey() and PaillierPrivateKey()

Examples

keys <- PaillierKeyPair$new(1024)
keys$pubkey
keys$getPrivateKey()

Construct a Paillier private key with the given secret and a public key

Description

Construct a Paillier private key with the given secret and a public key

Construct a Paillier private key with the given secret and a public key

Format

An R6::R6Class() generator object

Public fields

Methods

Public methods

• PaillierPrivateKey$new()

• PaillierPrivateKey$getLambda()

• PaillierPrivateKey$decrypt()

• PaillierPrivateKey$clone()

Method new()

Create a new private key with given secret lambda and the public key

Usage

PaillierPrivateKey$new(lambda, pubkey)

Arguments

Method getLambda()

Return the secret lambda

Usage

PaillierPrivateKey$getLambda()

Returns

lambda

Method decrypt()

Decrypt a message

Usage

PaillierPrivateKey$decrypt(c)

Arguments

Returns

the decrypted message

Method clone()

The objects of this class are cloneable with this method.

Usage

PaillierPrivateKey$clone(deep = FALSE)

Arguments

See Also

PaillierPublicKey() which goes hand-in-hand with this object

Construct a Paillier public key with the given modulus.

Description

Construct a Paillier public key with the given modulus.

Construct a Paillier public key with the given modulus.

Value

An R6::R6Class() generator object

Public fields

Methods

Public methods

• PaillierPublicKey$new()

• PaillierPublicKey$encrypt()

• PaillierPublicKey$add()

• PaillierPublicKey$sub()

• PaillierPublicKey$add_real()

• PaillierPublicKey$sub_real()

• PaillierPublicKey$mult()

• PaillierPublicKey$clone()

Method new()

Create a new public key and precompute some internal values for efficiency

Usage

PaillierPublicKey$new(bits, n)

Arguments

Returns

a new PaillierPublicKey object

Method encrypt()

Encrypt a message

Usage

PaillierPublicKey$encrypt(m)

Arguments

Returns

the encrypted message

Method add()

Add two encrypted messages

Usage

PaillierPublicKey$add(a, b)

Arguments

Returns

the sum of a and b

Method sub()

Subtract one encrypted message from another

Usage

PaillierPublicKey$sub(a, b)

Arguments

Returns

the difference a - b

Method add_real()

Return the sum a + b of an encrypted real message a, a list consisting of a encrypted integer part (named int) and an encrypted fractional part (named frac), and a real number a using den as denominator in the rational approximation.

Usage

PaillierPublicKey$add_real(den, a, b)

Arguments

Method sub_real()

Return the difference a - b of an encrypted real message a, a list consisting of a encrypted integer part (named int) and an encrypted fractional part (named frac), and a real number b using den as denominator in the rational approximation.

Usage

PaillierPublicKey$sub_real(den, a, b)

Arguments

Method mult()

Return the product of two encrypted messages a and b

Usage

PaillierPublicKey$mult(a, b)

Arguments

Returns

the product of a and b

Method clone()

The objects of this class are cloneable with this method.

Usage

PaillierPublicKey$clone(deep = FALSE)

Arguments

See Also

PaillierPrivateKey() which goes hand-in-hand with this object

Return a random big number using the cryptographically secure random number generator from in the sodium package.

Description

Return a random big number using the cryptographically secure random number generator from in the sodium package.

Usage

random.bigz(nBits)

Arguments