|
Packit |
aea12f |
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
|
|
Packit Service |
991b93 |
.TH "gnutls_x509_privkey_export" 3 "3.6.14" "gnutls" "gnutls"
|
|
Packit |
aea12f |
.SH NAME
|
|
Packit |
aea12f |
gnutls_x509_privkey_export \- API function
|
|
Packit |
aea12f |
.SH SYNOPSIS
|
|
Packit |
aea12f |
.B #include <gnutls/x509.h>
|
|
Packit |
aea12f |
.sp
|
|
Packit |
aea12f |
.BI "int gnutls_x509_privkey_export(gnutls_x509_privkey_t " key ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");"
|
|
Packit |
aea12f |
.SH ARGUMENTS
|
|
Packit |
aea12f |
.IP "gnutls_x509_privkey_t key" 12
|
|
Packit |
aea12f |
Holds the key
|
|
Packit |
aea12f |
.IP "gnutls_x509_crt_fmt_t format" 12
|
|
Packit |
aea12f |
the format of output params. One of PEM or DER.
|
|
Packit |
aea12f |
.IP "void * output_data" 12
|
|
Packit |
aea12f |
will contain a private key PEM or DER encoded
|
|
Packit |
aea12f |
.IP "size_t * output_data_size" 12
|
|
Packit |
aea12f |
holds the size of output_data (and will be
|
|
Packit |
aea12f |
replaced by the actual size of parameters)
|
|
Packit |
aea12f |
.SH "DESCRIPTION"
|
|
Packit |
aea12f |
This function will export the private key to a PKCS\fB1\fP structure for
|
|
Packit |
aea12f |
RSA or RSA\-PSS keys, and integer sequence for DSA keys. Other keys types
|
|
Packit |
aea12f |
will be exported in PKCS\fB8\fP form.
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
If the structure is PEM encoded, it will have a header
|
|
Packit |
aea12f |
of "BEGIN RSA PRIVATE KEY".
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
It is recommended to use \fBgnutls_x509_privkey_export_pkcs8()\fP instead
|
|
Packit |
aea12f |
of this function, when a consistent output format is required.
|
|
Packit |
aea12f |
.SH "RETURNS"
|
|
Packit |
aea12f |
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a
|
|
Packit |
aea12f |
negative error value.
|
|
Packit |
aea12f |
.SH "REPORTING BUGS"
|
|
Packit |
aea12f |
Report bugs to <bugs@gnutls.org>.
|
|
Packit |
aea12f |
.br
|
|
Packit |
aea12f |
Home page: https://www.gnutls.org
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
.SH COPYRIGHT
|
|
Packit Service |
991b93 |
Copyright \(co 2001- Free Software Foundation, Inc., and others.
|
|
Packit |
aea12f |
.br
|
|
Packit |
aea12f |
Copying and distribution of this file, with or without modification,
|
|
Packit |
aea12f |
are permitted in any medium without royalty provided the copyright
|
|
Packit |
aea12f |
notice and this notice are preserved.
|
|
Packit |
aea12f |
.SH "SEE ALSO"
|
|
Packit |
aea12f |
The full documentation for
|
|
Packit |
aea12f |
.B gnutls
|
|
Packit |
aea12f |
is maintained as a Texinfo manual.
|
|
Packit |
aea12f |
If the /usr/share/doc/gnutls/
|
|
Packit |
aea12f |
directory does not contain the HTML form visit
|
|
Packit |
aea12f |
.B
|
|
Packit |
aea12f |
.IP https://www.gnutls.org/manual/
|
|
Packit |
aea12f |
.PP
|