summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_certificate_set_x509_key
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
commit36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch)
tree6c68e0c0097987aff85a01dabddd34b862309a7c /doc/functions/gnutls_certificate_set_x509_key
parentInitial commit. (diff)
downloadgnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.tar.xz
gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.zip
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/functions/gnutls_certificate_set_x509_key')
-rw-r--r--doc/functions/gnutls_certificate_set_x509_key34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/functions/gnutls_certificate_set_x509_key b/doc/functions/gnutls_certificate_set_x509_key
new file mode 100644
index 0000000..d26592f
--- /dev/null
+++ b/doc/functions/gnutls_certificate_set_x509_key
@@ -0,0 +1,34 @@
+
+
+
+
+@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})
+@var{res}: is a @code{gnutls_certificate_credentials_t} type.
+
+@var{cert_list}: contains a certificate list (path) for the specified private key
+
+@var{cert_list_size}: holds the size of the certificate list
+
+@var{key}: is a @code{gnutls_x509_privkey_t} key
+
+This function sets a certificate/private key pair in the
+gnutls_certificate_credentials_t type. This function may be
+called more than once, in case multiple keys/certificates exist for
+the server. For clients that wants to send more than their own end
+entity certificate (e.g., also an intermediate CA cert) then put
+the certificate chain in @code{cert_list} .
+
+Note that the certificates and keys provided, can be safely deinitialized
+after this function is called.
+
+If that function fails to load the @code{res} type is at an undefined state, it must
+not be reused to load other keys or certificates.
+
+Note that, this function by default returns zero on success and a negative value on error.
+Since 3.5.6, when the flag @code{GNUTLS_CERTIFICATE_API_V2} is set using @code{gnutls_certificate_set_flags()}
+it returns an index (greater or equal to zero). That index can be used to other functions to refer to the added key-pair.
+
+@strong{Returns:} On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior).
+
+@strong{Since:} 2.4.0
+@end deftypefun