summaryrefslogtreecommitdiff
path: root/doc/API
diff options
context:
space:
mode:
Diffstat (limited to 'doc/API')
-rw-r--r--doc/API7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/API b/doc/API
index 18b4eef2ff..0af357a3f6 100644
--- a/doc/API
+++ b/doc/API
@@ -93,12 +93,15 @@ void gnutls_set_cipher_priority( GNUTLS_STATE state, int num, ...);
not use that except for disabling algorithms that were not
specified.
-int gnutls_set_kx_cred( GNUTLS_STATE state, int kx, void* cred, int cred_size);
+int gnutls_set_kx_cred( GNUTLS_STATE state, int kx, void* cred);
Sets the needed credentials for the specified (in kx) authentication
algorithm. Eg username, password - or public and private keys etc.
The (void* cred) parameter is a structure that depends on the
specified kx algorithm and on the current state (client or server).
- cred_size is the size of the structure.
+ [ In order to minimize memory usage, and share credentials between
+ several threads gnutls keeps a pointer to cred not the whole cred
+ structure. Thus you will have to keep the structure allocated until
+ the last gnutls_deinit(). ]
* For GNUTLS_KX_ANON cred should be NULL.
* For GNUTLS_KX_SRP cred should be SRP_CLIENT_CREDENTIALS