gnutls_credentials_set

Section: gnutls (3)
Updated: 2.8.5
Index Return to Main Contents
 

NAME

gnutls_credentials_set - Sets the needed credentials for the specified authentication algorithm.  

SYNOPSIS

#include <gnutls/gnutls.h>

int gnutls_credentials_set(gnutls_session_t session, gnutls_credentials_type_t type, void * cred);  

ARGUMENTS

gnutls_session_t session
is a gnutls_session_t structure.
gnutls_credentials_type_t type
is the type of the credentials
void * cred
is a pointer to a structure.
 

DESCRIPTION

Sets the needed credentials for the specified type. Eg username, password - or public and private keys etc. The cred parameter is a structure that depends on the specified type and on the current session (client or server).

In order to minimize memory usage, and share credentials between several threads gnutls keeps a pointer to cred, and not the whole cred structure. Thus you will have to keep the structure allocated until you call gnutls_deinit().

For GNUTLS_CRD_ANON, cred should be gnutls_anon_client_credentials_t in case of a client. In case of a server it should be gnutls_anon_server_credentials_t.

For GNUTLS_CRD_SRP, cred should be gnutls_srp_client_credentials_t in case of a client, and gnutls_srp_server_credentials_t, in case of a server.

For GNUTLS_CRD_CERTIFICATE, cred should be gnutls_certificate_credentials_t.  

RETURNS

On success, GNUTLS_E_SUCCESS (zero) is returned, otherwise an error code is returned.  

REPORTING BUGS

Report bugs to <bug-gnutls@gnu.org>. GnuTLS home page: http://www.gnu.org/software/gnutls/ General help using GNU software: http://www.gnu.org/gethelp/  

COPYRIGHT

Copyright © 2008 Free Software Foundation.
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.  

SEE ALSO

The full documentation for gnutls is maintained as a Texinfo manual. If the info and gnutls programs are properly installed at your site, the command
info gnutls

should give you access to the complete manual.