File: encryption.rst

package info (click to toggle)
adios2 2.10.2%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 33,764 kB
  • sloc: cpp: 175,964; ansic: 160,510; f90: 14,630; yacc: 12,668; python: 7,275; perl: 7,126; sh: 2,825; lisp: 1,106; xml: 1,049; makefile: 579; lex: 557
file content (20 lines) | stat: -rw-r--r-- 1,422 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
**********
Encryption
**********

The Encryption Operator uses the :ref:`Plugins` interface.
This operator uses `libsodium <https://doc.libsodium.org/>`_ for encrypting and decrypting data.
If ADIOS can find libsodium at configure time, this plugin will be built.

This operator will generate a secret key and encrypts the data with the key and a nonce as described in the libsodium `secret key cryptography docs <https://doc.libsodium.org/secret-key_cryptography/secretbox>`_.
The key is saved to the specified ``SecretKeyFile`` and will be used for decryption. The key should be kept confidential since it is used to both encrypt and decrypt the data.

Parameters to use with the Encryption operator:

============================== ===================== ===========================================================
 **Key**                       **Value Format**       **Explanation**
============================== ===================== ===========================================================
 PluginName                     string                Required. Name to refer to plugin, e.g., ``MyOperator``
 PluginLibrary                  string                Required. Name of shared library, ``EncryptionOperator``
 SecretKeyFile                  string                Required. Path to secret key file
============================== ===================== ===========================================================