Blame doc/functions/gnutls_privkey_generate
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
@deftypefun {int} {gnutls_privkey_generate} (gnutls_privkey_t @var{pkey}, gnutls_pk_algorithm_t @var{algo}, unsigned int @var{bits}, unsigned int @var{flags})
|
|
Packit Service |
4684c1 |
@var{pkey}: An initialized private key
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
@var{algo}: is one of the algorithms in @code{gnutls_pk_algorithm_t} .
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
@var{bits}: the size of the parameters to generate
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
@var{flags}: Must be zero or flags from @code{gnutls_privkey_flags_t} .
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
This function will generate a random private key. Note that this
|
|
Packit Service |
4684c1 |
function must be called on an initialized private key.
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
The flag @code{GNUTLS_PRIVKEY_FLAG_PROVABLE}
|
|
Packit Service |
4684c1 |
instructs the key generation process to use algorithms like Shawe-Taylor
|
|
Packit Service |
4684c1 |
(from FIPS PUB186-4) which generate provable parameters out of a seed
|
|
Packit Service |
4684c1 |
for RSA and DSA keys. See @code{gnutls_privkey_generate2()} for more
|
|
Packit Service |
4684c1 |
information.
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
Note that when generating an elliptic curve key, the curve
|
|
Packit Service |
4684c1 |
can be substituted in the place of the bits parameter using the
|
|
Packit Service |
4684c1 |
@code{GNUTLS_CURVE_TO_BITS()} macro. The input to the macro is any curve from
|
|
Packit Service |
4684c1 |
@code{gnutls_ecc_curve_t} .
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
For DSA keys, if the subgroup size needs to be specified check
|
|
Packit Service |
4684c1 |
the @code{GNUTLS_SUBGROUP_TO_BITS()} macro.
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
It is recommended to do not set the number of @code{bits} directly, use @code{gnutls_sec_param_to_pk_bits()} instead .
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
See also @code{gnutls_privkey_generate2()} .
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS} (0) is returned, otherwise a
|
|
Packit Service |
4684c1 |
negative error value.
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
@strong{Since:} 3.3.0
|
|
Packit Service |
4684c1 |
@end deftypefun
|