Blame doc/functions/gnutls_credentials_set

Packit aea12f
Packit aea12f
Packit aea12f
Packit aea12f
Packit aea12f
@deftypefun {int} {gnutls_credentials_set} (gnutls_session_t @var{session}, gnutls_credentials_type_t @var{type}, void * @var{cred})
Packit aea12f
@var{session}: is a @code{gnutls_session_t}  type.
Packit aea12f
Packit aea12f
@var{type}: is the type of the credentials
Packit aea12f
Packit aea12f
@var{cred}: the credentials to set
Packit aea12f
Packit aea12f
Sets the needed credentials for the specified type.  E.g. username,
Packit aea12f
password - or public and private keys etc.  The  @code{cred} parameter is
Packit aea12f
a structure that depends on the specified type and on the current
Packit aea12f
session (client or server).
Packit aea12f
Packit aea12f
In order to minimize memory usage, and share credentials between
Packit aea12f
several threads gnutls keeps a pointer to cred, and not the whole
Packit aea12f
cred structure.  Thus you will have to keep the structure allocated
Packit aea12f
until you call @code{gnutls_deinit()} .
Packit aea12f
Packit aea12f
For @code{GNUTLS_CRD_ANON} ,  @code{cred} should be
Packit aea12f
@code{gnutls_anon_client_credentials_t}  in case of a client.  In case of
Packit aea12f
a server it should be @code{gnutls_anon_server_credentials_t} .
Packit aea12f
Packit aea12f
For @code{GNUTLS_CRD_SRP} ,  @code{cred} should be @code{gnutls_srp_client_credentials_t} 
Packit aea12f
in case of a client, and @code{gnutls_srp_server_credentials_t} , in case
Packit aea12f
of a server.
Packit aea12f
Packit aea12f
For @code{GNUTLS_CRD_CERTIFICATE} ,  @code{cred} should be
Packit aea12f
@code{gnutls_certificate_credentials_t} .
Packit aea12f
Packit aea12f
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned,
Packit aea12f
otherwise a negative error code is returned.
Packit aea12f
@end deftypefun