summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2019-07-22 12:43:50 +0200
committerNikos Mavrogiannopoulos <nmav@redhat.com>2019-07-22 12:50:41 +0200
commitc3083c9555296973b6dfd7b4561ebf2300815605 (patch)
tree62989fdffd675714f85247464b8e109f6f52f612 /doc
parent52553b9ec3e8df16f3dd3a19812c3a1db9b46dbf (diff)
downloadgnutls-c3083c9555296973b6dfd7b4561ebf2300815605.tar.gz
gnutls.h: mark AEAD ciphers as such in gnutls_cipher_algorithm_t description
Signed-off-by: Nikos Mavrogiannopoulos <nmav@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/cha-crypto.texi14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/cha-crypto.texi b/doc/cha-crypto.texi
index fb01b2c37b..da2ce20528 100644
--- a/doc/cha-crypto.texi
+++ b/doc/cha-crypto.texi
@@ -27,18 +27,20 @@ are listed in the sections below. The supported algorithms are the algorithms re
They are listed in @ref{gnutls_cipher_algorithm_t}. Note that there two
types of ciphers, the ones providing an authenticated-encryption with
associated data (AEAD), and the legacy ciphers which provide raw access
-to the ciphers. We recommend the use of the AEAD APIs for new applications
-as it is designed to minimize misuse of cryptography.
+to the ciphers. We recommend the use of the AEAD ciphers under the AEAD APIs
+for new applications as they are designed to minimize the misuse of
+cryptographic primitives.
@showenumdesc{gnutls_cipher_algorithm_t,The supported ciphers.}
@subheading Authenticated-encryption API
The AEAD API provides access to all ciphers supported by GnuTLS which support
-authenticated encryption with associated data. That is particularly suitable
-for message or packet-encryption as it provides authentication and
-encryption on the same API. See @code{RFC5116} for more information on
-authenticated encryption.
+authenticated encryption with associated data; these ciphers are marked with
+the AEAD keyword on the table above. The AEAD cipher API is
+particularly suitable for message or packet-encryption as it provides
+authentication and encryption on the same API. See @code{RFC5116} for more
+information on authenticated encryption.
@showfuncD{gnutls_aead_cipher_init,gnutls_aead_cipher_encrypt,gnutls_aead_cipher_decrypt,gnutls_aead_cipher_deinit}