summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2017-02-05 11:41:41 +0100
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2017-02-12 09:38:23 +0100
commite5a2b4c923569881b31d687254990d4dbc15d4de (patch)
treea3260740acf6f79c5943615c80e9d1123d9a5b16 /doc
parentffe90059ef5db5cd1540c63c31a5ae244b08f2b1 (diff)
downloadgnutls-e5a2b4c923569881b31d687254990d4dbc15d4de.tar.gz
doc: document the intention of the priority string usage [ci skip]
This documents the gnutls_set_default_priority() function, and how it is intended to be combined with an application that utilizes priority strings. Signed-off-by: Nikos Mavrogiannopoulos <nmav@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/cha-gtls-app.texi19
1 files changed, 17 insertions, 2 deletions
diff --git a/doc/cha-gtls-app.texi b/doc/cha-gtls-app.texi
index 627373405e..8b417d6f00 100644
--- a/doc/cha-gtls-app.texi
+++ b/doc/cha-gtls-app.texi
@@ -1050,9 +1050,24 @@ are listed in @ref{The Alert Protocol}.
@section Priority strings
@cindex Priority strings
+@subheading How to use Priority Strings
+
The GnuTLS priority strings specify the TLS session's handshake
-algorithms and options in a compact, easy-to-use format. That string
-may contain a single initial keyword such as in
+algorithms and options in a compact, easy-to-use format. These
+strings are intended as a user-specified override of the library defaults.
+
+That is, applications should use the default settings
+(c.f. @funcref{gnutls_set_default_priority}), and provide the user
+with access to priority strings for overriding the default behavior,
+on configuration files, or other UI. Following such a principle,
+makes the GnuTLS library as the default settings provider. That is
+necessary and a good practice, because TLS protocol hardening and
+phasing out of legacy algorithms, is easier to co-ordinate when happens
+in a single library.
+
+@subheading Using Priority Strings
+
+A priority string string may contain a single initial keyword such as in
@ref{tab:prio-keywords} and may be followed by additional algorithm or
special keywords. Note that their description is intentionally avoiding
specific algorithm details, as the priority strings are not constant between