================================================================================
Cryptor - AES Blob
================================================================================

.. list-table:: 
   :widths: auto
   :stub-columns: 1

   * - Class Name
     - AesBlob
   * - Implements
     - `Cryptor <https://gitlab.com/blockchainhelix/epn-dbcp/-/tree/main/src/encryption/cryptor.ts>`_
   * - Extends
     - `Logger <../common/logger.html>`_
   * - Source
     - `aes-blob.ts <https://gitlab.com/blockchainhelix/epn-api-blockchain-core/-/tree/main/src/encryption/aes-blob.ts>`_
   * - Examples
     - `aes-blob.spec.ts <https://gitlab.com/blockchainhelix/epn-api-blockchain-core/-/tree/main/src/encryption/aes-blob.spec.ts>`_

The `AES Blob <https://gitlab.com/blockchainhelix/epn-api-blockchain-core/-/tree/main/src/encryption/aes-blob.ts>`_ cryptor encodes and decodes content with aes-cbc.

------------------------------------------------------------------------------

.. _cryptor_aes_blob_constructor:

constructor
================================================================================

.. code-block:: typescript

  new AesBlob(options);

Creates a new AesBlob instance.

----------
Parameters
----------

#. ``options`` - ``AesBlobOptions``: options for AesBlob constructor.
    * ``dfs`` - |source dfsInterface|_: |source dfsInterface|_ instance
    * ``log`` - ``Function`` (optional): function to use for logging: ``(message, level) => {...}``
    * ``logLevel`` - |source logLevel|_ (optional): messages with this level will be logged with ``log``
    * ``logLog`` - |source logLogInterface|_ (optional): container for collecting log messages
    * ``logLogLevel`` - |source logLevel|_ (optional): messages with this level will be pushed to ``logLog``

-------
Returns
-------

``AesBlob`` instance

-------
Example
-------

.. code-block:: typescript
  
  const aesBlob = new AesBlob({
      dfs
    });


------------------------------------------------------------------------------

.. _cryptor_aes_blob_getCryptoInfo:

getCryptoInfo
===================

.. code-block:: javascript

    cryptor.getCryptoInfo(originator);

create new crypto info for this cryptor

----------
Parameters
----------

#. ``originator`` - ``string``: originator or context of the encryption

-------
Returns
-------

``CryptoInfo``: details about encryption for originator with this cryptor.

-------
Example
-------

.. code-block:: javascript

    const cryptor = new AesBlob();
    const cryptoInfo = cryptor.getCryptoInfo('0x123');

------------------------------------------------------------------------------

.. _cryptor_aes_blob_generateKey:

generateKey
===================

.. code-block:: javascript

    cryptor.generateKey();

generate key for cryptor/decryption

-------
Returns
-------

Promise resolves to ``string``: key used for encryption.

-------
Example
-------

.. code-block:: javascript

    const cryptor = new AesBlob();
    const cryptoInfo = cryptor.generateKey();

------------------------------------------------------------------------------

.. _cryptor_aes_blob_encrypt:

encrypt
===================

.. code-block:: javascript

    cryptor.encrypt(message, options);

'encrypt' a message (serializes message)

----------
Parameters
----------

#. ``message`` - ``string``: message which should be encrypted
#. ``options`` - ``any``: cryptor options
    * ``key``  - ``string``: key used for encryption

-------
Returns
-------

Promise resolves to ``string``: encrypted message.

-------
Example
-------

.. code-block:: javascript

    const cryptor = new AesBlob();
    const cryptoInfo = cryptor.encrypt('Hello World', { key: '0x12345' });

------------------------------------------------------------------------------

.. _cryptor_aes_blob_decrypt:

decrypt
===================

.. code-block:: javascript

    cryptor.decrypt(message, options);

'decrypt' a message (deserializes message)

----------
Parameters
----------

#. ``message`` - ``Buffer``: message which should be decrypted
#. ``options`` - ``any``: cryptor options
    * ``key``  - ``string``: key used for encryption

-------
Returns
-------

Promise resolves to ``any``: decrypted message.

-------
Example
-------

.. code-block:: javascript

    const cryptor = new AesBlob();
    const cryptoInfo = cryptor.decrypt('afeweq41f1e61e3f', { key: '0x12345' });

.. required for building markup

.. |source dfsInterface| replace:: ``DfsInterface``
.. _source dfsInterface: ../dfs/dfs-interface.html

.. |source logLevel| replace:: ``LogLevel``
.. _source logLevel: ../common/logger.html#loglevel

.. |source logLogInterface| replace:: ``LogLogInterface``
.. _source logLogInterface: ../common/logger.html#logloginterface