| 1 |
|
| 2 |
|
| 3 |
|
| 4 |
|
| 5 |
@deftypefun {int} {gnutls_privkey_generate2} (gnutls_privkey_t @var{pkey}, gnutls_pk_algorithm_t @var{algo}, unsigned int @var{bits}, unsigned int @var{flags}, const gnutls_keygen_data_st * @var{data}, unsigned @var{data_size}) |
| 6 |
@var{pkey}: The private key |
| 7 |
|
| 8 |
@var{algo}: is one of the algorithms in @code{gnutls_pk_algorithm_t} . |
| 9 |
|
| 10 |
@var{bits}: the size of the modulus |
| 11 |
|
| 12 |
@var{flags}: Must be zero or flags from @code{gnutls_privkey_flags_t} . |
| 13 |
|
| 14 |
@var{data}: Allow specifying @code{gnutls_keygen_data_st} types such as the seed to be used. |
| 15 |
|
| 16 |
@var{data_size}: The number of @code{data} available. |
| 17 |
|
| 18 |
This function will generate a random private key. Note that this |
| 19 |
function must be called on an initialized private key. |
| 20 |
|
| 21 |
The flag @code{GNUTLS_PRIVKEY_FLAG_PROVABLE} |
| 22 |
instructs the key generation process to use algorithms like Shawe-Taylor |
| 23 |
(from FIPS PUB186-4) which generate provable parameters out of a seed |
| 24 |
for RSA and DSA keys. On DSA keys the PQG parameters are generated using the |
| 25 |
seed, while on RSA the two primes. To specify an explicit seed |
| 26 |
(by default a random seed is used), use the @code{data} with a @code{GNUTLS_KEYGEN_SEED} |
| 27 |
type. |
| 28 |
|
| 29 |
Note that when generating an elliptic curve key, the curve |
| 30 |
can be substituted in the place of the bits parameter using the |
| 31 |
@code{GNUTLS_CURVE_TO_BITS()} macro. |
| 32 |
|
| 33 |
To export the generated keys in memory or in files it is recommended to use the |
| 34 |
PKCS@code{8} form as it can handle all key types, and can store additional parameters |
| 35 |
such as the seed, in case of provable RSA or DSA keys. |
| 36 |
Generated keys can be exported in memory using @code{gnutls_privkey_export_x509()} , |
| 37 |
and then with @code{gnutls_x509_privkey_export2_pkcs8()} . |
| 38 |
|
| 39 |
If key generation is part of your application, avoid setting the number |
| 40 |
of bits directly, and instead use @code{gnutls_sec_param_to_pk_bits()} . |
| 41 |
That way the generated keys will adapt to the security levels |
| 42 |
of the underlying GnuTLS library. |
| 43 |
|
| 44 |
@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS} (0) is returned, otherwise a |
| 45 |
negative error value. |
| 46 |
|
| 47 |
@strong{Since:} 3.5.0 |
| 48 |
@end deftypefun |