Blame doc/functions/gnutls_dh_params_export_pkcs3

Packit aea12f
Packit aea12f
Packit aea12f
Packit aea12f
Packit aea12f
@deftypefun {int} {gnutls_dh_params_export_pkcs3} (gnutls_dh_params_t @var{params}, gnutls_x509_crt_fmt_t @var{format}, unsigned char * @var{params_data}, size_t * @var{params_data_size})
Packit aea12f
@var{params}: Holds the DH parameters
Packit aea12f
Packit aea12f
@var{format}: the format of output params. One of PEM or DER.
Packit aea12f
Packit aea12f
@var{params_data}: will contain a PKCS3 DHParams structure PEM or DER encoded
Packit aea12f
Packit aea12f
@var{params_data_size}: holds the size of params_data (and will be replaced by the actual size of parameters)
Packit aea12f
Packit aea12f
This function will export the given dh parameters to a PKCS3
Packit aea12f
DHParams structure. This is the format generated by "openssl dhparam" tool.
Packit aea12f
If the buffer provided is not long enough to hold the output, then
Packit aea12f
GNUTLS_E_SHORT_MEMORY_BUFFER will be returned.
Packit aea12f
Packit aea12f
If the structure is PEM encoded, it will have a header
Packit aea12f
of "BEGIN DH PARAMETERS".
Packit aea12f
Packit aea12f
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned,
Packit aea12f
otherwise a negative error code is returned.
Packit aea12f
@end deftypefun