From: Nikos Mavrogiannopoulos <nmav@gnutls.org>
Date: Tue, 29 Jan 2013 21:59:05 +0000 (+0100)
Subject: doc update
X-Git-Tag: gnutls_3_1_7~33
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2d3306fb9c812a249e306c59a15fc369ac099cfd;p=thirdparty%2Fgnutls.git

doc update
---

diff --git a/doc/cha-gtls-examples.texi b/doc/cha-gtls-examples.texi
index 81c512e762..7233cc004c 100644
--- a/doc/cha-gtls-examples.texi
+++ b/doc/cha-gtls-examples.texi
@@ -286,7 +286,11 @@ priority string.
 
 XSSL is an experimental API available in the @code{gnutls-xssl} library
 and in @code{gnutls/xssl.h} header. It is intended to be a very simple
-to use API avoid the GnuTLS API.
+to use API avoid the GnuTLS API. The API however has the following limitations
+@itemize
+@item It is applicable to blocking sockets only.
+@item The server verification is based on its DNS name.
+@end itemize
 
 @menu
 * Example client with X.509 certificate authentication::
diff --git a/lib/includes/gnutls/xssl.h b/lib/includes/gnutls/xssl.h
index a71bec1901..badf871b71 100644
--- a/lib/includes/gnutls/xssl.h
+++ b/lib/includes/gnutls/xssl.h
@@ -84,10 +84,13 @@ typedef enum
 
 typedef enum
 {
-  GNUTLS_CINPUT_CAS = 1,
-  GNUTLS_CINPUT_CRLS = 2,
-  GNUTLS_CINPUT_TOFU_DB = 3,
-  GNUTLS_CINPUT_KEYPAIR = 4,
+  GNUTLS_CINPUT_CAS = 1, /* i1 contains the CAs */
+  GNUTLS_CINPUT_CRLS = 2,/* i1 contains the CRLs */
+  GNUTLS_CINPUT_TOFU_DB = 3, /* i1 contains the DB filename */
+  GNUTLS_CINPUT_KEYPAIR = 4, /* i1 contains the certificate, i2 the key 
+                              * or i1.pin_fn contains the pin function, 
+                              * and i2.udata the user pointer */
+                              */
 } gnutls_cinput_contents_t;
 
 typedef struct gnutls_cinput_st {