From d1884800f8b87e03566bb7f68c509f747efa2c4a Mon Sep 17 00:00:00 2001 From: AntonKueltz <7116785+AntonKueltz@users.noreply.github.com> Date: Wed, 25 Dec 2019 18:27:50 -0800 Subject: [PATCH] Update README.rst --- README.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 0ae46af..ab88a6a 100644 --- a/README.rst +++ b/README.rst @@ -42,8 +42,9 @@ Method 2 Basic API --------- -Encryption -~~~~~~~~~~ +:code:`aead.encrypt_and_tag` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Takes a key, nonce, plaintext and additional data and returns a ciphertext and MAC. .. code:: python @@ -52,11 +53,12 @@ Encryption nonce: bytes, plaintext: bytes, aad: bytes - ) -> bytes + ) -> (bytes, bytes) -Decryption -~~~~~~~~~~ +:code:`aead.verify_and_decrypt` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Takes a key, nonce, ciphertext, MAC and additional data and returns a plaintext. .. code:: python