gnutls_x509_privkey_export(3)

API function

Section 3 gnutls-doc bookworm source

Description

gnutls_x509_privkey_export

NAME

gnutls_x509_privkey_export - API function

SYNOPSIS

#include <gnutls/x509.h>

int gnutls_x509_privkey_export(gnutls_x509_privkey_t key, gnutls_x509_crt_fmt_t format, 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.

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 PKCS1 structure for RSA or RSA-PSS keys, and integer sequence for DSA keys. Other keys types will be exported in PKCS8 form.

If the structure is PEM encoded, it will have a header of "BEGIN RSA PRIVATE KEY".

It is recommended to use gnutls_x509_privkey_export_pkcs8() instead of this function, when a consistent output format is required.

RETURNS

On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a negative error value.

REPORTING BUGS

Report bugs to <bugs@gnutls.org>.
Home page: https://www.gnutls.org

COPYRIGHT

Copyright © 2001- 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.