================================================================================
Cryptor - AES CBC
================================================================================

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

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

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

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

.. _cryptor_aes_constructor:

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

.. code-block:: typescript

  new Aes(options);

Creates a new Aes instance.

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

#. ``options`` - ``AesOptions``: options for Aes constructor.
    * ``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
-------

``Aes`` instance

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

.. code-block:: typescript
  
  const aes = new Aes();


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

.. _cryptor_aes_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 Aes();
    const cryptoInfo = cryptor.getCryptoInfo('0x123');

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

.. _cryptor_aes_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 Aes();
    const cryptoInfo = cryptor.generateKey();

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

.. _cryptor_aes_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 Aes();
    const cryptoInfo = cryptor.encrypt('Hello World', { key: '0x12345' });

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

.. _cryptor_aes_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 Aes();
    const cryptoInfo = cryptor.decrypt('afeweq41f1e61e3f', { key: '0x12345' });

.. required for building markup

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

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