]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
doc updates
authorNikos Mavrogiannopoulos <nmav@gnutls.org>
Mon, 29 Aug 2011 19:02:11 +0000 (21:02 +0200)
committerNikos Mavrogiannopoulos <nmav@gnutls.org>
Mon, 29 Aug 2011 19:08:30 +0000 (21:08 +0200)
doc/cha-gtls-app.texi

index 3d115bbf0103a17a1c7833811695b60a6355487b..ea43ddeb98a1fabb6d8634e4c1c157e2a8f8381c 100644 (file)
@@ -687,13 +687,15 @@ information about it.
 Several TLS ciphersuites require additional parameters that
 need to be generated or provided by the application. The
 Diffie-Hellman based ciphersuites (ANON-DH or DHE), require
-the group information to be provided. This information can be either
+the group parameters to be provided. Those can either be
 be generated on the fly using @funcref{gnutls_dh_params_generate2}
-or imported from some pregenerated value using @funcref{gnutls_dh_params_import_pkcs3}.
-The parameters can be used in a session by calling
+or imported from pregenerated data using @funcref{gnutls_dh_params_import_pkcs3}.
+The parameters can be used in a @acronym{TLS} session by calling
 @funcref{gnutls_certificate_set_dh_params} or
 @funcref{gnutls_anon_set_server_dh_params} for anonymous sessions.
 
+@showfuncB{gnutls_dh_params_init,gnutls_dh_params_deinit}
+
 @showfuncD{gnutls_dh_params_generate2,gnutls_dh_params_import_pkcs3,gnutls_certificate_set_dh_params,gnutls_anon_set_server_dh_params}
 
 Due to the time-consuming calculations required for the generation
@@ -702,16 +704,18 @@ of them within an application. The @code{certtool} tool can be used to
 generate or export known safe values that can be stored in code
 or in a configuration file to provide the ability to replace. We also
 recommend the usage of @funcref{gnutls_sec_param_to_pk_bits} (see @ref{Selecting cryptographic key sizes}) to determine
-the bit size of the parameters to be generated.
+the bit size of the generated parameters.
 
 The ciphersuites that involve the RSA-EXPORT key exchange require
 additional parameters. Those ciphersuites are rarely used today
 because they are by design insecure, thus if you have no requirement
-for them, this section should be skipped. The RSA-EXPORT key exchange
+for them, the rest of this section can be skipped. The RSA-EXPORT key exchange
 requires 512-bit RSA keys to be generated. It is recommended those
 parameters to be refreshed (regenerated) in short intervals. The
 following functions can be used for these parameters.
 
+@showfuncB{gnutls_rsa_params_init,gnutls_rsa_params_deinit}
+
 @showfuncD{gnutls_rsa_params_generate2,gnutls_certificate_set_rsa_export_params,gnutls_rsa_params_import_pkcs1,gnutls_rsa_params_export_pkcs1}
 
 To allow renewal of the parameters within an application without