gnutls_x509_privkey_export_pkcs8(3) — Linux manual page
gnutls_x509_p..._export_pkcs8(3) gnutls gnutls_x509_p..._export_pkcs8(3)
NAME
gnutls_x509_privkey_export_pkcs8 - API function
SYNOPSIS
#include <gnutls/x509.h>
int gnutls_x509_privkey_export_pkcs8(gnutls_x509_privkey_t key,
gnutls_x509_crt_fmt_t format, const char * password, unsigned int
flags, void * output_data, size_t * output_data_size);
ARGUMENTS
gnutls_x509_privkey_t key
Holds the key
gnutls_x509_crt_fmt_t format
the format of output params. One of PEM or DER.
const char * password
the password that will be used to encrypt the key.
unsigned int flags
an ORed sequence of gnutls_pkcs_encrypt_flags_t
void * output_data
will contain a private key PEM or DER encoded
size_t * output_data_size
holds the size of output_data (and will be replaced
by the actual size of parameters)
DESCRIPTION
This function will export the private key to a PKCS8 structure.
Both RSA and DSA keys can be exported. For DSA keys we use PKCS
11 definitions. If the flags do not specify the encryption
cipher, then the default 3DES (PBES2) will be used.
The password can be either ASCII or UTF-8 in the default PBES2
encryption schemas, or ASCII for the PKCS12 schemas.
If the buffer provided is not long enough to hold the output,
then *output_data_size is updated and
GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
If the structure is PEM encoded, it will have a header of "BEGIN
ENCRYPTED PRIVATE KEY" or "BEGIN PRIVATE KEY" if encryption is
not used.
RETURNS
In case of failure a negative error code will be returned, and 0
on success.
REPORTING BUGS
Report bugs to <bugs@gnutls.org>.
Home page: https://www.gnutls.org
COPYRIGHT
Copyright © 2001-2023 Free Software Foundation, Inc., and others.
Copying and distribution of this file, with or without
modification, are permitted in any medium without royalty
provided the copyright notice and this notice are preserved.
SEE ALSO
The full documentation for gnutls is maintained as a Texinfo
manual. If the /usr/share/doc/gnutls/ directory does not contain
the HTML form visit
https://www.gnutls.org/manual/
COLOPHON
This page is part of the GnuTLS (GnuTLS Transport Layer Security
Library) project. Information about the project can be found at
⟨http://www.gnutls.org/⟩. If you have a bug report for this
manual page, send it to bugs@gnutls.org. This page was obtained
from the tarball gnutls-3.8.5.tar.xz fetched from
⟨http://www.gnutls.org/download.html⟩ on 2024-06-14. If you
discover any rendering problems in this HTML version of the page,
or you believe there is a better or more up-to-date source for
the page, or you have corrections or improvements to the
information in this COLOPHON (which is not part of the original
manual page), send a mail to man-pages@man7.org