diff options
Diffstat (limited to 'doc/manual/cryptobox.rst')
| -rw-r--r-- | doc/manual/cryptobox.rst | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/manual/cryptobox.rst b/doc/manual/cryptobox.rst new file mode 100644 index 000000000..ea77eee5a --- /dev/null +++ b/doc/manual/cryptobox.rst @@ -0,0 +1,28 @@ + +Cryptobox +======================================== + +Encryption using a passphrase +---------------------------------------- + +.. versionadded:: 1.8.6 + +This is a set of simple routines that encrypt some data using a +passphrase. There are defined in the header `cryptobox.h`, inside +namespace `Botan::CryptoBox`. + + .. cpp:function:: std::string encrypt(const byte input[], size_t input_len, \ + const std::string& passphrase, \ + RandomNumberGenerator& rng) + + Encrypt the contents using *passphrase*. + + .. cpp:function:: std::string decrypt(const byte input[], size_t input_len, \ + const std::string& passphrase) + + Decrypts something encrypted with encrypt. + + .. cpp:function:: std::string decrypt(const std::string& input, \ + const std::string& passphrase) + + Decrypts something encrypted with encrypt. |