aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aead.rst
diff options
context:
space:
mode:
authorlloyd <[email protected]>2013-12-10 03:30:24 +0000
committerlloyd <[email protected]>2013-12-10 03:30:24 +0000
commit748d7fd4b622ee3c9d95343e02ed945c217507f7 (patch)
treed2d1d58147b5b723b37f02133735ebca9bebd6ad /doc/aead.rst
parent4874b0727843bba925bcd3b5c0659c5f1cb059d9 (diff)
s/default_nonce_size/default_nonce_length/
Diffstat (limited to 'doc/aead.rst')
-rw-r--r--doc/aead.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/aead.rst b/doc/aead.rst
index cb49f8a51..dbd06bbe1 100644
--- a/doc/aead.rst
+++ b/doc/aead.rst
@@ -81,3 +81,9 @@ AEAD modes currently available include GCM, OCB, and EAX. All three use a
Returns true if *nonce_len* is a valid nonce length for this scheme. For
EAX and GCM, any length nonces are allowed. OCB allows any value between
8 and 15 bytes.
+
+ .. cpp:function:: size_t default_nonce_length() const
+
+ Returns a reasonable length for the nonce, typically either 96
+ bits, or the only supported length for modes which don't
+ support 96 bit nonces.