| 1 |
|
| 2 |
|
| 3 |
|
| 4 |
@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}) |
| 5 |
@var{res}: is a @code{gnutls_certificate_credentials_t} type. |
| 6 |
|
| 7 |
@var{names}: is an array of DNS names belonging to the public-key (NULL if none) |
| 8 |
|
| 9 |
@var{names_size}: holds the size of the names list |
| 10 |
|
| 11 |
@var{pcert_list}: contains a certificate list (chain) or raw public-key |
| 12 |
|
| 13 |
@var{pcert_list_size}: holds the size of the certificate list |
| 14 |
|
| 15 |
@var{key}: is a @code{gnutls_privkey_t} key corresponding to the first public-key in pcert_list |
| 16 |
|
| 17 |
This function sets a public/private key pair in the |
| 18 |
gnutls_certificate_credentials_t type. The given public key may be encapsulated |
| 19 |
in a certificate or can be given as a raw key. This function may be |
| 20 |
called more than once, in case multiple key pairs exist for |
| 21 |
the server. For clients that want to send more than their own end- |
| 22 |
entity certificate (e.g., also an intermediate CA cert), the full |
| 23 |
certificate chain must be provided in @code{pcert_list} . |
| 24 |
|
| 25 |
Note that the @code{key} will become part of the credentials structure and must |
| 26 |
not be deallocated. It will be automatically deallocated when the @code{res} structure |
| 27 |
is deinitialized. |
| 28 |
|
| 29 |
If this function fails, the @code{res} structure is at an undefined state and it must |
| 30 |
not be reused to load other keys or certificates. |
| 31 |
|
| 32 |
Note that, this function by default returns zero on success and a negative value on error. |
| 33 |
Since 3.5.6, when the flag @code{GNUTLS_CERTIFICATE_API_V2} is set using @code{gnutls_certificate_set_flags()} |
| 34 |
it returns an index (greater or equal to zero). That index can be used for other functions to refer to the added key-pair. |
| 35 |
|
| 36 |
Since GnuTLS 3.6.6 this function also handles raw public keys. |
| 37 |
|
| 38 |
@strong{Returns:} On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior). |
| 39 |
|
| 40 |
@strong{Since:} 3.0 |
| 41 |
@end deftypefun |