Skip to content

Commit

Permalink
docs: add encryption operator
Browse files Browse the repository at this point in the history
  • Loading branch information
caitlinross committed Apr 8, 2022
1 parent c25ea81 commit aab5972
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/user_guide/source/engines/engines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ Parameters are passed at:
.. include:: dataman.rst
.. include:: inline.rst
.. include:: null.rst
.. include:: plugin.rst
5 changes: 5 additions & 0 deletions docs/user_guide/source/engines/plugin.rst
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.
20 changes: 20 additions & 0 deletions docs/user_guide/source/operators/encryption.rst
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
============================== ===================== ===========================================================
2 changes: 2 additions & 0 deletions docs/user_guide/source/operators/operators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,5 @@ Parameters are passed at:
2. :ref:`Runtime Configuration Files` in the :ref:`ADIOS` component.

.. include:: ZFPCompressor.rst
.. include:: plugin.rst
.. include:: encryption.rst
6 changes: 6 additions & 0 deletions docs/user_guide/source/operators/plugin.rst
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.

0 comments on commit aab5972

Please sign in to comment.