|
Packit |
549fdc |
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
|
|
Packit |
549fdc |
.TH "gnutls_certificate_get_x509_key" 3 "3.6.2" "gnutls" "gnutls"
|
|
Packit |
549fdc |
.SH NAME
|
|
Packit |
549fdc |
gnutls_certificate_get_x509_key \- API function
|
|
Packit |
549fdc |
.SH SYNOPSIS
|
|
Packit |
549fdc |
.B #include <gnutls/gnutls.h>
|
|
Packit |
549fdc |
.sp
|
|
Packit |
549fdc |
.BI "int gnutls_certificate_get_x509_key(gnutls_certificate_credentials_t " res ", unsigned " index ", gnutls_x509_privkey_t * " key ");"
|
|
Packit |
549fdc |
.SH ARGUMENTS
|
|
Packit |
549fdc |
.IP "gnutls_certificate_credentials_t res" 12
|
|
Packit |
549fdc |
is a \fBgnutls_certificate_credentials_t\fP type.
|
|
Packit |
549fdc |
.IP "unsigned index" 12
|
|
Packit |
549fdc |
The index of the key to obtain.
|
|
Packit |
549fdc |
.IP "gnutls_x509_privkey_t * key" 12
|
|
Packit |
549fdc |
Location to store the key.
|
|
Packit |
549fdc |
.SH "DESCRIPTION"
|
|
Packit |
549fdc |
Obtains a X.509 private key that has been stored in \fIres\fP with one of
|
|
Packit |
549fdc |
\fBgnutls_certificate_set_x509_key()\fP, \fBgnutls_certificate_set_key()\fP,
|
|
Packit |
549fdc |
\fBgnutls_certificate_set_x509_key_file()\fP,
|
|
Packit |
549fdc |
\fBgnutls_certificate_set_x509_key_file2()\fP,
|
|
Packit |
549fdc |
\fBgnutls_certificate_set_x509_key_mem()\fP, or
|
|
Packit |
549fdc |
\fBgnutls_certificate_set_x509_key_mem2()\fP. The returned key must be deallocated
|
|
Packit |
549fdc |
with \fBgnutls_x509_privkey_deinit()\fP when no longer needed.
|
|
Packit |
549fdc |
|
|
Packit |
549fdc |
The \fIindex\fP matches the return value of \fBgnutls_certificate_set_x509_key()\fP and friends
|
|
Packit |
549fdc |
functions, when the \fBGNUTLS_CERTIFICATE_API_V2\fP flag is set.
|
|
Packit |
549fdc |
|
|
Packit |
549fdc |
If there is no key with the given index,
|
|
Packit |
549fdc |
\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. If the key with the
|
|
Packit |
549fdc |
given index is not a X.509 key, \fBGNUTLS_E_INVALID_REQUEST\fP is returned.
|
|
Packit |
549fdc |
.SH "RETURNS"
|
|
Packit |
549fdc |
\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code.
|
|
Packit |
549fdc |
.SH "SINCE"
|
|
Packit |
549fdc |
3.4.0
|
|
Packit |
549fdc |
.SH "REPORTING BUGS"
|
|
Packit |
549fdc |
Report bugs to <bugs@gnutls.org>.
|
|
Packit |
549fdc |
.br
|
|
Packit |
549fdc |
Home page: http://www.gnutls.org
|
|
Packit |
549fdc |
|
|
Packit |
549fdc |
.SH COPYRIGHT
|
|
Packit |
549fdc |
Copyright \(co 2001-2018 Free Software Foundation, Inc., and others.
|
|
Packit |
549fdc |
.br
|
|
Packit |
549fdc |
Copying and distribution of this file, with or without modification,
|
|
Packit |
549fdc |
are permitted in any medium without royalty provided the copyright
|
|
Packit |
549fdc |
notice and this notice are preserved.
|
|
Packit |
549fdc |
.SH "SEE ALSO"
|
|
Packit |
549fdc |
The full documentation for
|
|
Packit |
549fdc |
.B gnutls
|
|
Packit |
549fdc |
is maintained as a Texinfo manual.
|
|
Packit |
549fdc |
If the /usr/share/doc/gnutls/
|
|
Packit |
549fdc |
directory does not contain the HTML form visit
|
|
Packit |
549fdc |
.B
|
|
Packit |
549fdc |
.IP http://www.gnutls.org/manual/
|
|
Packit |
549fdc |
.PP
|