diff --git a/docs/index.rst b/docs/index.rst index a48527841c5dc7cfd1e6cd750384d93970bc4b9b..e3830ef53cb9eb546aa97ce6f663b1732b4ee2cf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ Support Features encoding exceptions + utils Api Documentation diff --git a/docs/utils.rst b/docs/utils.rst new file mode 100644 index 0000000000000000000000000000000000000000..dfd2b7c7b5a72bb71c9ac9c236b55acdb76af6c2 --- /dev/null +++ b/docs/utils.rst @@ -0,0 +1,17 @@ +Utility Classes +=============== + +.. class:: EncryptedMessage + + A ``bytes`` subclass that holds a message that has been encrypted by a + :class:`~nacl.secret.SecretBox` or :class:`~nacl.public.Box`. The full + content of the ``bytes`` object is the combined ``nonce`` and + ``ciphertext``. + + .. attribute:: nonce + + The nonce used during the encryption of the :class:`EncryptedMessage`. + + .. attribute:: ciphertext + + The ciphertext contained within the :class:`EncryptedMessage`.