doc/crypto/DSA_generate_parameters.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 DSA_generate_parameters - Generate DSA parameters
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/dsa.h>
  10
  11  DSA *  DSA_generate_parameters(int bits, unsigned char *seed,
  12                 int seed_len, int *counter_ret, unsigned long *h_ret,
  13                 void (*callback)(), void *cb_arg);
  14
  15 =head1 DESCRIPTION
  16
  17 DSA_generate_parameters() generates primes p and q and a generator g
  18 for use in the DSA.
  19
  20 B<bits> is the length of the prime to be generated; the DSS allows a
  21 maximum of 1024 bits.
  22
  23 If B<seed> is NULL or B<seed_len> E<lt> 20, the primes will be
  24 generated at random. Otherwise, the seed is used to generate
  25 them. If the given seed does not yield a prime q, a new random
  26 seed is chosen and placed at B<seed>.
  27
  28 DSA_generate_parameters() places the iteration count in
  29 *B<counter_ret> and a counter used for finding a generator in
  30 *B<h_ret>, unless these are NULL.
  31
  32 A callback function may be used to provide feedback about the progress
  33 of the key generation. If B<callback> is not B<NULL>, it will be
  34 called as follows:
  35
  36 =over 4
  37
  38 =item *
  39
  40 When the the m-th candidate for q is generated, B<callback(0, m,
  41 cb_arg)> is called.
  42
  43 =item *
  44
  45 B<callback(1, j++, cb_arg)> is called in the inner loop of the
  46 Miller-Rabin primality test.
  47
  48 =item *
  49
  50 When a prime q has been found, B<callback(2, 0, cb_arg)> and
  51 B<callback(3, 0, cb_arg)> are called.
  52
  53 =item *
  54
  55 While candidates for p are being tested, B<callback(1, j++, cb_arg)>
  56 is called in the inner loop of the Miller-Rabin primality test, then
  57 B<callback(0, counter, cb_arg)> is called when the next candidate
  58 is chosen.
  59
  60 =item *
  61
  62 When p has been found, B<callback(2, 1, cb_arg)> is called.
  63
  64 =item *
  65
  66 When the generator has been found, B<callback(3, 1, cb_arg)> is called.
  67
  68 =back
  69
  70 =head1 RETURN VALUE
  71
  72 DSA_generate_parameters() returns a pointer to the DSA structure, or
  73 NULL if the parameter generation fails. The error codes can be
  74 obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
  75
  76 =head1 BUGS
  77
  78 The deterministic generation of p does not follow the NIST algorithm:
  79 r0 is SHA1(s+k+1), but should be SHA1(s+j+k) with j_0=2,
  80 j_counter=j_counter-1 + n + 1.
  81
  82 Seed lengths E<gt> 20 are not supported.
  83
  84 =head1 SEE ALSO
  85
  86 L<dsa(3)|dsa(3)>, L<err(3)|err(3)>, L<rand(3)|rand(3)>,
  87 L<DSA_free(3)|DSA_free(3)>
  88
  89 =head1 HISTORY
  90
  91 DSA_generate_parameters() appeared in SSLeay 0.8. The B<cb_arg>
  92 argument was added in SSLeay 0.9.0.
  93
  94 =cut