summaryrefslogtreecommitdiff
path: root/doc/cha-crypto.texi
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2015-12-22 17:14:02 +0200
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2015-12-22 17:18:56 +0200
commit70810080242321cba90d09f7fc2b915f6b4dbb13 (patch)
tree4d4737595154c35d0cd27f8e1b4be325019dc552 /doc/cha-crypto.texi
parent8a776077e889b2f720d130528b2924f149545863 (diff)
downloadgnutls-70810080242321cba90d09f7fc2b915f6b4dbb13.tar.gz
updated documentation on supported algorithms [ci skip]
Diffstat (limited to 'doc/cha-crypto.texi')
-rw-r--r--doc/cha-crypto.texi20
1 files changed, 14 insertions, 6 deletions
diff --git a/doc/cha-crypto.texi b/doc/cha-crypto.texi
index 3e640c2dd2..04ec3579eb 100644
--- a/doc/cha-crypto.texi
+++ b/doc/cha-crypto.texi
@@ -11,7 +11,7 @@ to the random number generation. For a low-level crypto API the usage of nettle
@menu
* Symmetric algorithms::
* Public key algorithms::
-* Hash and HMAC functions::
+* Hash and MAC functions::
* Random number generation::
* Overriding algorithms::
@end menu
@@ -23,7 +23,9 @@ to the random number generation. For a low-level crypto API the usage of nettle
The available functions to access symmetric crypto algorithms operations
are shown below. The supported algorithms are the algorithms required by the TLS protocol.
-They are listed in @ref{tab:ciphers}.
+They are listed in @ref{gnutls_cipher_algorithm_t}.
+
+@showenumdesc{gnutls_cipher_algorithm_t,The supported ciphers.}
@showfuncE{gnutls_cipher_init,gnutls_cipher_encrypt2,gnutls_cipher_decrypt2,gnutls_cipher_set_iv,gnutls_cipher_deinit}
@@ -73,22 +75,28 @@ in the structure are listed below.
To append certificates, or CRLs in the structure the following functions are provided.
@showfuncD{gnutls_pkcs7_set_crt_raw,gnutls_pkcs7_set_crt,gnutls_pkcs7_set_crl_raw,gnutls_pkcs7_set_crl}
-@node Hash and HMAC functions
-@section Hash and HMAC functions
+@node Hash and MAC functions
+@section Hash and MAC functions
@cindex hash functions
@cindex HMAC functions
+@cindex MAC functions
The available operations to access hash functions and hash-MAC (HMAC) algorithms
-are shown below. HMAC algorithms provided keyed hash functionality. They supported HMAC algorithms are listed in @ref{tab:macs}.
+are shown below. HMAC algorithms provided keyed hash functionality. The supported MAC and HMAC
+algorithms are listed in @ref{gnutls_mac_algorithm_t}.
+
+@showenumdesc{gnutls_mac_algorithm_t,The supported MAC and HMAC algorithms.}
@showfuncF{gnutls_hmac_init,gnutls_hmac,gnutls_hmac_output,gnutls_hmac_deinit,gnutls_hmac_get_len,gnutls_hmac_fast}
The available functions to access hash functions are shown below. The supported hash functions
-are the same as the HMAC algorithms.
+are shown in @ref{gnutls_digest_algorithm_t}.
@showfuncF{gnutls_hash_init,gnutls_hash,gnutls_hash_output,gnutls_hash_deinit,gnutls_hash_get_len,gnutls_hash_fast}
@showfuncA{gnutls_fingerprint}
+@showenumdesc{gnutls_digest_algorithm_t,The supported hash algorithms.}
+
@node Random number generation
@section Random number generation
@cindex random numbers