diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 75eece0..1fa46d3 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-02-03T16:28:32","documenter_version":"1.8.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-02-03T16:33:33","documenter_version":"1.8.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 4f3695f..2bf96e2 100644 --- a/dev/index.html +++ b/dev/index.html @@ -42,4 +42,4 @@ year={2024}, howpublished={\url{https://github.com/hpsc-lab/SecureArithmetic.jl}}, doi={10.5281/zenodo.10544790} -}

Authors

SecureArithmetic.jl was initiated by Michael Schlottke-Lakemper (University of Augsburg, Germany). Together with Arseniy Kholod (University of Augsburg, Germany), he is its principal maintainer.

License and contributing

SecureArithmetic.jl is available under the MIT license (see License). Contributions by the community are very welcome! For larger proposed changes, feel free to reach out via an issue first.

+}

Authors

SecureArithmetic.jl was initiated by Michael Schlottke-Lakemper (University of Augsburg, Germany). Together with Arseniy Kholod (University of Augsburg, Germany), he is its principal maintainer.

License and contributing

SecureArithmetic.jl is available under the MIT license (see License). Contributions by the community are very welcome! For larger proposed changes, feel free to reach out via an issue first.

diff --git a/dev/license/index.html b/dev/license/index.html index 23f892d..752d4ba 100644 --- a/dev/license/index.html +++ b/dev/license/index.html @@ -1,2 +1,2 @@ -License · SecureArithmetic.jl
GitHub

License

MIT License

Copyright (c) 2023 Michael Schlottke-Lakemper

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+License · SecureArithmetic.jl
GitHub

License

MIT License

Copyright (c) 2023 Michael Schlottke-Lakemper

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

diff --git a/dev/objects.inv b/dev/objects.inv index e4a1a65..e840ff5 100644 Binary files a/dev/objects.inv and b/dev/objects.inv differ diff --git a/dev/reference/index.html b/dev/reference/index.html index b759bb9..5cf91d3 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -1,9 +1,9 @@ -API reference · SecureArithmetic.jl
GitHub

API reference

Base.circshift — Method
circshift(sa::SecureArray, shifts)

Circularly shift, i.e., rotate the data in sa by shifts positions, similarly to Julia's circshift for regular arrays.

Note: If N is greater than one, this operation increases the multiplicative level by two, otherwise by one.

Note: To precompute all required rotation indexes, use init_rotation!.

See also: SecureArray, init_rotation!

source
SecureArithmetic.bootstrap! — Function
bootstrap!(secure_array::SecureArray{<:OpenFHEBackend}, num_iterations = 1,
-           precision = 0)

Refresh a given secure_array to increase the multiplication depth. Supported for CKKS only. Please refer to the OpenFHE documentation for details on the arguments num_iterations and precision.

See also: SecureArray, OpenFHEBackend, init_bootstrapping!

source
SecureArithmetic.init_rotation! — Method
init_rotation!(context::SecureContext{<:OpenFHEBackend}, private_key::PrivateKey,
-               shape::Union{Integer, NTuple{N, Integer}}, shifts...)

Generate all required rotation keys for applying shifts with circshift for arrays of the given shape using the private_key. The keys are stored in the given context.

See also: SecureContext, OpenFHEBackend, PrivateKey

source
SecureArithmetic.level — Method
level(a::Union{SecureArray{<:Unencrypted}, PlainArray{<:Unencrypted}})

Return the number of scalings, referred to as the level, performed over a. For data type derived from Unencrypted, the level is always equal to 0.

See also: PlainArray, SecureArray

source
SecureArithmetic.release_context_memory — Method
release_context_memory()

Release all OpenFHE.CryptoContexts and keys for multiplication, rotation, bootstrapping and OpenFHE.EvalSum generated in the functions init_multiplication!, init_rotation!, init_bootstrapping! and OpenFHE.EvalSumKeyGen.

In the source code of OpenFHE C++, all CryptoContexts and keys are stored in static objects. Without using release_context_memory, the memory allocated for these contexts and keys will only be freed after restarting the Julia REPL. It is also advisable to call GC.gc() after a call to release_context_memory to clean up all memory on the Julia side.

See also: init_multiplication!, init_rotation!, init_bootstrapping!

source
+API reference · SecureArithmetic.jl
GitHub

API reference

Base.circshift — Method
circshift(sa::SecureArray, shifts)

Circularly shift, i.e., rotate the data in sa by shifts positions, similarly to Julia's circshift for regular arrays.

Note: If N is greater than one, this operation increases the multiplicative level by two, otherwise by one.

Note: To precompute all required rotation indexes, use init_rotation!.

See also: SecureArray, init_rotation!

source
SecureArithmetic.bootstrap! — Function
bootstrap!(secure_array::SecureArray{<:OpenFHEBackend}, num_iterations = 1,
+           precision = 0)

Refresh a given secure_array to increase the multiplication depth. Supported for CKKS only. Please refer to the OpenFHE documentation for details on the arguments num_iterations and precision.

See also: SecureArray, OpenFHEBackend, init_bootstrapping!

source
SecureArithmetic.init_rotation! — Method
init_rotation!(context::SecureContext{<:OpenFHEBackend}, private_key::PrivateKey,
+               shape::Union{Integer, NTuple{N, Integer}}, shifts...)

Generate all required rotation keys for applying shifts with circshift for arrays of the given shape using the private_key. The keys are stored in the given context.

See also: SecureContext, OpenFHEBackend, PrivateKey

source
SecureArithmetic.level — Method
level(a::Union{SecureArray{<:Unencrypted}, PlainArray{<:Unencrypted}})

Return the number of scalings, referred to as the level, performed over a. For data type derived from Unencrypted, the level is always equal to 0.

See also: PlainArray, SecureArray

source
SecureArithmetic.release_context_memory — Method
release_context_memory()

Release all OpenFHE.CryptoContexts and keys for multiplication, rotation, bootstrapping and OpenFHE.EvalSum generated in the functions init_multiplication!, init_rotation!, init_bootstrapping! and OpenFHE.EvalSumKeyGen.

In the source code of OpenFHE C++, all CryptoContexts and keys are stored in static objects. Without using release_context_memory, the memory allocated for these contexts and keys will only be freed after restarting the Julia REPL. It is also advisable to call GC.gc() after a call to release_context_memory to clean up all memory on the Julia side.

See also: init_multiplication!, init_rotation!, init_bootstrapping!

source