Add Secure Array #59

ArseniyKholod · 2025-01-12T19:29:47Z

I introduce SecureArray and PlainArray, so that an array is stored in a vector of ciphertexts/plaintexts, enabling de facto arbitrary big arrays in fixed ring dimension. All operations should work now. 1D rotations are also now supported. The only part still missing is nD rotations for n>1. But I already have ideas, and it should not be too difficult.

Please don't merge before I introduce nD rotations.

TODO for me:

nD rotations
docs
SecureVector and SecureMatrix as SecureArray

codecov · 2025-01-12T19:31:25Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines	Coverage Δ
examples/simple_array_operations.jl	`100.00% <100.00%> (ø)`
examples/simple_matrix_operations.jl	`100.00% <100.00%> (ø)`
examples/simple_real_numbers.jl	`100.00% <100.00%> (ø)`
src/SecureArithmetic.jl	`100.00% <ø> (ø)`
src/arithmetic.jl	`100.00% <100.00%> (ø)`
src/openfhe.jl	`100.00% <100.00%> (ø)`
src/operations.jl	`100.00% <100.00%> (ø)`
src/types.jl	`100.00% <100.00%> (ø)`
src/unencrypted.jl	`98.36% <100.00%> (-1.64%)`	⬇️

src/operations.jl

src/openfhe.jl

ArseniyKholod · 2025-01-15T21:07:34Z

MacOs test failing:
JuliaInterop/CxxWrap.jl#455

sloede · 2025-01-16T05:22:57Z

Great work! Once this PR is ready, do we then still need a separate SecureVector and SecureMatrix type (and their plain counterparts), or will we be able do something similar to Julia's array implementation and just define

const SecureVector{Backend, DataT} = SecureArray{Backend, 1, DataT}
const SecureMatrix{Backend, DataT} = SecureArray{Backend, 2, DataT}

?

ArseniyKholod · 2025-01-16T08:49:39Z

Great work! Once this PR is ready, do we then still need a separate SecureVector and SecureMatrix type (and their plain counterparts), or will we be able do something similar to Julia's array implementation and just define
const SecureVector{Backend, DataT} = SecureArray{Backend, 1, DataT}
const SecureMatrix{Backend, DataT} = SecureArray{Backend, 2, DataT}
?

We can do it, but I have to adapt a bit a code.

sloede · 2025-01-16T10:37:07Z

Great work! Once this PR is ready, do we then still need a separate SecureVector and SecureMatrix type (and their plain counterparts), or will we be able do something similar to Julia's array implementation and just define
const SecureVector{Backend, DataT} = SecureArray{Backend, 1, DataT}
const SecureMatrix{Backend, DataT} = SecureArray{Backend, 2, DataT}
?
We can do it, but I have to adapt a bit a code.

Then let's maybe discuss this on Friday? I believe that if it will allow is to have just one and not three different implementations for 1D, 2D, and nD arrays, it is probably going to be worth it.

The only reason that might be against it is if the nD code is so much more difficult to understand that it becomes very hard to add new features even to 1D arrays.

ArseniyKholod · 2025-01-29T12:58:25Z

Codecov fails, because it tries to count also end lines in threaded loops, like here:

Threads.@threads for i in range(shift1+1, length(sv)-2)
    sv_new[i] = OpenFHE.EvalAdd(cc, OpenFHE.EvalMult(cc, sv[i+1], mask4),
    OpenFHE.EvalMult(cc, sv[i], mask5))
end

And counts them as missing. I don't think it is a problem, but we could also explicitly exclude such lines from codecov, but it would be dirtier.

As clear from this comment, I have also parallelized loops over ciphertexts. Since now SecureArray holds a vector of ciphertexts, it looks natural for me to speed up it's operations, but we could also remove parallelization.

sloede

First round of reviews. I haven't checked src/unencrypted.jl or src/openfhe.jl at all yet.

src/types.jl

src/arithmetic.jl

src/openfhe.jl

src/unencrypted.jl

src/openfhe.jl

Co-authored-by: Michael Schlottke-Lakemper <[email protected]>

examples/simple_real_numbers.jl

src/arithmetic.jl

sloede

I've finally taken a look at the remaining files as well, though I cannot really vouch for most of the code (since I don't fully understand the implementation for shifts/rotations). I mainly focused on getting the code look "Julian". Whether the implementation is correct or can be simplified, I don't know and I rely on you having implemented good tests :-)

sloede · 2025-01-31T16:57:34Z

examples/simple_real_numbers.jl

@@ -5,7 +5,7 @@ function simple_real_numbers(context)
    public_key, private_key = generate_keys(context)

    init_multiplication!(context, private_key)
-    init_array_rotation!(context, private_key, [-1, 2], (8,))
+    init_rotation!(context, private_key, (8,), -1, 2)


Can we add a special case for 1D rotations that allow a user to pass the shape argument also just as an integer? That is, such that one can do

Suggested change

init_rotation!(context, private_key, (8,), -1, 2)

init_rotation!(context, private_key, 8, -1, 2)

in this case? or would this be too confusing/complicated to implement?

examples/simple_real_numbers.jl

src/arithmetic.jl

sloede · 2025-01-31T17:03:41Z

src/openfhe.jl

+function get_index(context::SecureContext{<:OpenFHEBackend}, shape::Tuple{Integer},
+                   rotation_index)


get_index is very close to getindex but does something completely different. Also, it is customary in Julia to not add types in a function signature unless really needed for dispatch. Thus I suggest to change this interface to something like the following:

Suggested change

function get_index(context::SecureContext{<:OpenFHEBackend}, shape::Tuple{Integer},

rotation_index)

function compute_rotation_indices(context, shape, shifts)

sloede · 2025-01-31T17:04:02Z

src/openfhe.jl

    cc = get_crypto_context(context)
-    OpenFHE.EvalRotateKeyGen(cc, private_key.private_key, -shifts)
+    # Get indexes for precompilation
+    indexes = get_index(context, shape, rotation_index)


Suggested change

indexes = get_index(context, shape, rotation_index)

indices = get_index(context, shape, rotation_index)

indices is the correct plural of index

sloede · 2025-01-31T17:08:39Z

src/openfhe.jl

+    # number of ciphertexts in array
+    n_ciphertexts = Int(ceil(array_length/capacity))
+    # store all indexes to enable
+    indexes = Int[]


Suggested change

indexes = Int[]

indices = Int[]

as above

sloede · 2025-01-31T17:09:40Z

src/openfhe.jl

+    indexes
+end
+
+function get_index(context::SecureContext{<:OpenFHEBackend}, shape::NTuple{N, Integer},


What's different to the get_index from above? IMHO it would be good to comment on that, especially since some of the code seems to be duplicated here

sloede · 2025-01-31T17:13:16Z

src/openfhe.jl

+function PlainArray(data::Vector{<:Real}, context::SecureContext{<:OpenFHEBackend},
+                    shape::Tuple)


I lost track, but is there also a

function PlainArray(data::Array{<:Real, N}, context) where {N} ... end

constructor that allows one to just pass in an array and the shape is figured out automatically?

sloede · 2025-01-31T17:18:10Z

src/openfhe.jl

+function subtract(sa::SecureArray{<:OpenFHEBackend}, pa::PlainArray{<:OpenFHEBackend})
+    cc = get_crypto_context(sa)
+    ciphertexts = Vector{OpenFHE.Ciphertext}(undef, length(sa.data))
+    for i in range(1, length(sa.data))


This is a highly unusual style for loop iterations. Can you please use

Suggested change

for i in range(1, length(sa.data))

for i in 1:length(sa.data)

here and everywhere else? Even more Julian would be to use

Suggested change

for i in range(1, length(sa.data))

for i in eachindex(sa.data)

But please do not iterate over ranges, this is not Python 😅

sloede · 2025-01-31T17:20:44Z

src/openfhe.jl

-            first = abs(shift) + 1
-            last = length(sv)
-            mask_rotated[first:last] .= 1
+function rotate(sa::SecureArray{<:OpenFHEBackend, 1}, shift)


Here you use shift again. I suggest to use a consistent way of differentiating between the user-visible "shift" and the internal, FHE ciphertext "shift". Maybe "shift" or "shifts" for everything that behaves like the "shift" in Base.circshfit and "rotation_index" for everything related to the actual ciphertext shift (or whatever OpenFHE is using for this).

ArseniyKholod added 6 commits January 10, 2025 12:47

Start working on arrays

bf9c883

add rotation alg 1d (didn't test it yet)

d9c8fb9

Test and fix bugs, add unit test, alg works!!!

d659d30

fix a bit coverage

2c4f66c

improve coverage

62a5157

spell check

ff9ba83

ArseniyKholod added 3 commits January 15, 2025 13:38

first implementation of nd rotation, not optimal

6c34a82

"better" implementation of nD rotation

cc4486a

spell check

57cf46e

ArseniyKholod commented Jan 15, 2025

View reviewed changes

src/operations.jl Outdated Show resolved Hide resolved

ArseniyKholod commented Jan 15, 2025

View reviewed changes

src/openfhe.jl Outdated Show resolved Hide resolved

ArseniyKholod added 14 commits January 22, 2025 20:53

replace Vectors amd Matricies with aliases for Array

a4b9c59

spell check

ba59d91

add docs to types

c4221c5

add docs to arithmetic.jl

a3eb83f

add docs in openfhe.jl and unencrypted.jl

7d2a607

Merge branch 'main' into Add-SecureArray

6582c62

Introduce multithreading

8a1485f

correct unittests and add array example

3a05988

improve convergence

fb76c84

update compat

657503a

try new openfhe_julia_jll

e862234

update OpenFHE.jl version

486d1c8

julia requirements 1.10

c96c6ce

clear unnecessary code and make small corrections

6082198

get back init_matrix_rotation

83dd735

ArseniyKholod marked this pull request as ready for review January 29, 2025 13:26

sloede requested changes Jan 29, 2025

View reviewed changes

src/types.jl Outdated Show resolved Hide resolved

src/types.jl Outdated Show resolved Hide resolved

src/types.jl Outdated Show resolved Hide resolved

src/arithmetic.jl Outdated Show resolved Hide resolved

src/arithmetic.jl Outdated Show resolved Hide resolved

sloede reviewed Jan 29, 2025

View reviewed changes

src/openfhe.jl Outdated Show resolved Hide resolved

ArseniyKholod commented Jan 29, 2025

View reviewed changes

src/unencrypted.jl Outdated Show resolved Hide resolved

src/openfhe.jl Outdated Show resolved Hide resolved

src/openfhe.jl Outdated Show resolved Hide resolved

ArseniyKholod and others added 3 commits January 29, 2025 19:53

Apply suggestions from code review

4155862

Co-authored-by: Michael Schlottke-Lakemper <[email protected]>

apply some suggestions

ad526c4

apply some suggestions

8dddbaa

sloede reviewed Jan 30, 2025

View reviewed changes

examples/simple_real_numbers.jl Outdated Show resolved Hide resolved

src/arithmetic.jl Outdated Show resolved Hide resolved

src/arithmetic.jl Outdated Show resolved Hide resolved

remove threaded

1877020

ArseniyKholod mentioned this pull request Jan 31, 2025

Add parallelization to SecureArray's operations #60

Open

ArseniyKholod added 2 commits January 31, 2025 11:15

change init_rotation! api

35a2aa8

update circshift

cfd42ef

sloede requested changes Jan 31, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Secure Array #59

Add Secure Array #59

ArseniyKholod commented Jan 12, 2025 •

edited

Loading

codecov bot commented Jan 12, 2025 •

edited

Loading

ArseniyKholod commented Jan 15, 2025

sloede commented Jan 16, 2025

ArseniyKholod commented Jan 16, 2025

sloede commented Jan 16, 2025

ArseniyKholod commented Jan 29, 2025 •

edited

Loading

sloede left a comment

sloede left a comment

sloede Jan 31, 2025

sloede Jan 31, 2025

sloede Jan 31, 2025

sloede Jan 31, 2025

sloede Jan 31, 2025

sloede Jan 31, 2025

sloede Jan 31, 2025

sloede Jan 31, 2025

	init_rotation!(context, private_key, (8,), -1, 2)
	init_rotation!(context, private_key, 8, -1, 2)

		function get_index(context::SecureContext{<:OpenFHEBackend}, shape::Tuple{Integer},
		rotation_index)

	function get_index(context::SecureContext{<:OpenFHEBackend}, shape::Tuple{Integer},
	rotation_index)
	function compute_rotation_indices(context, shape, shifts)

	indexes = get_index(context, shape, rotation_index)
	indices = get_index(context, shape, rotation_index)

		function PlainArray(data::Vector{<:Real}, context::SecureContext{<:OpenFHEBackend},
		shape::Tuple)

	for i in range(1, length(sa.data))
	for i in 1:length(sa.data)

	for i in range(1, length(sa.data))
	for i in eachindex(sa.data)

Add Secure Array #59

Are you sure you want to change the base?

Add Secure Array #59

Conversation

ArseniyKholod commented Jan 12, 2025 • edited Loading

codecov bot commented Jan 12, 2025 • edited Loading

Codecov Report

ArseniyKholod commented Jan 15, 2025

sloede commented Jan 16, 2025

ArseniyKholod commented Jan 16, 2025

sloede commented Jan 16, 2025

ArseniyKholod commented Jan 29, 2025 • edited Loading

sloede left a comment

Choose a reason for hiding this comment

sloede left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArseniyKholod commented Jan 12, 2025 •

edited

Loading

codecov bot commented Jan 12, 2025 •

edited

Loading

ArseniyKholod commented Jan 29, 2025 •

edited

Loading