Blame doc/functions/gnutls_certificate_set_key

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_certificate_set_key} (gnutls_certificate_credentials_t @var{res}, const char ** @var{names}, int @var{names_size}, gnutls_pcert_st * @var{pcert_list}, int @var{pcert_list_size}, gnutls_privkey_t @var{key})
Packit Service 4684c1
@var{res}: is a @code{gnutls_certificate_credentials_t}  type.
Packit Service 4684c1
Packit Service 4684c1
@var{names}: is an array of DNS names belonging to the public-key (NULL if none)
Packit Service 4684c1
Packit Service 4684c1
@var{names_size}: holds the size of the names list
Packit Service 4684c1
Packit Service 4684c1
@var{pcert_list}: contains a certificate list (chain) or raw public-key
Packit Service 4684c1
Packit Service 4684c1
@var{pcert_list_size}: holds the size of the certificate list
Packit Service 4684c1
Packit Service 4684c1
@var{key}: is a @code{gnutls_privkey_t}  key corresponding to the first public-key in pcert_list
Packit Service 4684c1
Packit Service 4684c1
This function sets a public/private key pair in the
Packit Service 4684c1
gnutls_certificate_credentials_t type. The given public key may be encapsulated
Packit Service 4684c1
in a certificate or can be given as a raw key. This function may be
Packit Service 4684c1
called more than once, in case multiple key pairs exist for
Packit Service 4684c1
the server. For clients that want to send more than their own end-
Packit Service 4684c1
entity certificate (e.g., also an intermediate CA cert), the full
Packit Service 4684c1
certificate chain must be provided in  @code{pcert_list} .
Packit Service 4684c1
Packit Service 4684c1
Note that the  @code{key} will become part of the credentials structure and must
Packit Service 4684c1
not be deallocated. It will be automatically deallocated when the  @code{res} structure
Packit Service 4684c1
is deinitialized.
Packit Service 4684c1
Packit Service 4684c1
If this function fails, the  @code{res} structure is at an undefined state and 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 for other functions to refer to the added key-pair.
Packit Service 4684c1
Packit Service 4684c1
Since GnuTLS 3.6.6 this function also handles raw public keys.
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:} 3.0
Packit Service 4684c1
@end deftypefun