-
Notifications
You must be signed in to change notification settings - Fork 128
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c25ea81
commit aab5972
Showing
5 changed files
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
************* | ||
Plugin Engine | ||
************* | ||
|
||
For details on using the Plugin Engine, see the :ref:`Plugins` documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,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 | ||
============================== ===================== =========================================================== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
*************** | ||
Plugin Operator | ||
*************** | ||
|
||
For details on using the Plugin Operator, see the :ref:`Plugins` documentation. | ||
|