Blame doc/functions/gnutls_x509_privkey_export_pkcs8

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_x509_privkey_export_pkcs8} (gnutls_x509_privkey_t @var{key}, gnutls_x509_crt_fmt_t @var{format}, const char * @var{password}, unsigned int @var{flags}, void * @var{output_data}, size_t * @var{output_data_size})
Packit Service 4684c1
@var{key}: Holds the key
Packit Service 4684c1
Packit Service 4684c1
@var{format}: the format of output params. One of PEM or DER.
Packit Service 4684c1
Packit Service 4684c1
@var{password}: the password that will be used to encrypt the key.
Packit Service 4684c1
Packit Service 4684c1
@var{flags}: an ORed sequence of gnutls_pkcs_encrypt_flags_t
Packit Service 4684c1
Packit Service 4684c1
@var{output_data}: will contain a private key PEM or DER encoded
Packit Service 4684c1
Packit Service 4684c1
@var{output_data_size}: holds the size of output_data (and will be
Packit Service 4684c1
replaced by the actual size of parameters)
Packit Service 4684c1
Packit Service 4684c1
This function will export the private key to a PKCS8 structure.
Packit Service 4684c1
Both RSA and DSA keys can be exported. For DSA keys we use
Packit Service 4684c1
PKCS @code{11}  definitions. If the flags do not specify the encryption
Packit Service 4684c1
cipher, then the default 3DES (PBES2) will be used.
Packit Service 4684c1
Packit Service 4684c1
The  @code{password} can be either ASCII or UTF-8 in the default PBES2
Packit Service 4684c1
encryption schemas, or ASCII for the PKCS12 schemas.
Packit Service 4684c1
Packit Service 4684c1
If the buffer provided is not long enough to hold the output, then
Packit Service 4684c1
*output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will
Packit Service 4684c1
be returned.
Packit Service 4684c1
Packit Service 4684c1
If the structure is PEM encoded, it will have a header
Packit Service 4684c1
of "BEGIN ENCRYPTED PRIVATE KEY" or "BEGIN PRIVATE KEY" if
Packit Service 4684c1
encryption is not used.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} In case of failure a negative error code will be
Packit Service 4684c1
returned, and 0 on success.
Packit Service 4684c1
@end deftypefun