Blame doc/functions/gnutls_certificate_set_x509_key

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_certificate_set_x509_key} (gnutls_certificate_credentials_t @var{res}, gnutls_x509_crt_t * @var{cert_list}, int @var{cert_list_size}, gnutls_x509_privkey_t @var{key})
Packit Service 4684c1
@var{res}: is a @code{gnutls_certificate_credentials_t}  type.
Packit Service 4684c1
Packit Service 4684c1
@var{cert_list}: contains a certificate list (path) for the specified private key
Packit Service 4684c1
Packit Service 4684c1
@var{cert_list_size}: holds the size of the certificate list
Packit Service 4684c1
Packit Service 4684c1
@var{key}: is a @code{gnutls_x509_privkey_t}  key
Packit Service 4684c1
Packit Service 4684c1
This function sets a certificate/private key pair in the
Packit Service 4684c1
gnutls_certificate_credentials_t type.  This function may be
Packit Service 4684c1
called more than once, in case multiple keys/certificates exist for
Packit Service 4684c1
the server.  For clients that wants to send more than their own end
Packit Service 4684c1
entity certificate (e.g., also an intermediate CA cert) then put
Packit Service 4684c1
the certificate chain in  @code{cert_list} .
Packit Service 4684c1
Packit Service 4684c1
Note that the certificates and keys provided, can be safely deinitialized
Packit Service 4684c1
after this function is called.
Packit Service 4684c1
Packit Service 4684c1
If that function fails to load the  @code{res} type is at an undefined state, it must
Packit Service 4684c1
not be reused to load other keys or certificates.
Packit Service 4684c1
Packit Service 4684c1
Note that, this function by default returns zero on success and a negative value on error.
Packit Service 4684c1
Since 3.5.6, when the flag @code{GNUTLS_CERTIFICATE_API_V2}  is set using @code{gnutls_certificate_set_flags()} 
Packit Service 4684c1
it returns an index (greater or equal to zero). That index can be used to other functions to refer to the added key-pair.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior).
Packit Service 4684c1
Packit Service 4684c1
@strong{Since:} 2.4.0
Packit Service 4684c1
@end deftypefun