summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2014-11-28 13:18:49 +0100
committerNikos Mavrogiannopoulos <nmav@redhat.com>2014-11-28 13:18:49 +0100
commitf89b4818b328bf3ac811b2c44ab689ff43a5d3e5 (patch)
tree2d9dbc6b85c382a5663909e1cacaaae5e314078c
parent91472921689d799cb991db84af7e04fba6b049f1 (diff)
downloadgnutls-f89b4818b328bf3ac811b2c44ab689ff43a5d3e5.tar.gz
doc: added recommendation to use the higher level functions to load keys
-rw-r--r--doc/cha-gtls-app.texi13
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/cha-gtls-app.texi b/doc/cha-gtls-app.texi
index 488ac180ef..4ba450b48c 100644
--- a/doc/cha-gtls-app.texi
+++ b/doc/cha-gtls-app.texi
@@ -469,15 +469,16 @@ certificate certifies the one before it. The trusted authority's
certificate need not to be included since the peer should possess it
already.
-@showfuncC{gnutls_certificate_set_x509_key_mem2,gnutls_certificate_set_x509_key,gnutls_certificate_set_x509_key_file2}
+@showfuncC{gnutls_certificate_set_x509_key_file2,gnutls_certificate_set_x509_key_mem2,gnutls_certificate_set_x509_key}
-@showfuncC{gnutls_certificate_set_openpgp_key_mem,gnutls_certificate_set_openpgp_key,gnutls_certificate_set_openpgp_key_file}
+@showfuncC{gnutls_certificate_set_openpgp_key_file,gnutls_certificate_set_openpgp_key_mem,gnutls_certificate_set_openpgp_key}
-Note however, that since functions like @funcref{gnutls_certificate_set_x509_key_file2}
-may accept URLs that specify objects stored in token, another important
-function is @funcref{gnutls_certificate_set_pin_function}. That
+It is recommended to use the higher level functions such as @funcref{gnutls_certificate_set_x509_key_file2}
+which accept not only file names but URLs that specify objects stored in token,
+or system certificates and keys (see @ref{Application-specific keys}). For these cases, another important
+function is @funcref{gnutls_certificate_set_pin_function}, that
allows setting a callback function to retrieve a PIN if the input keys are
-protected by PIN by the token.
+protected by PIN.
@showfuncdesc{gnutls_certificate_set_pin_function}