doc/crypto/DH_generate_parameters.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5
   6 DH_generate_parameters_ex, DH_generate_parameters,
   7 DH_check - generate and check Diffie-Hellman parameters
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/dh.h>
  12
  13  int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
  14
  15  int DH_check(DH *dh, int *codes);
  16
  17 Deprecated:
  18
  19  #if OPENSSL_API_COMPAT < 0x00908000L
  20  DH *DH_generate_parameters(int prime_len, int generator,
  21      void (*callback)(int, int, void *), void *cb_arg);
  22  #endif
  23
  24 =head1 DESCRIPTION
  25
  26 DH_generate_parameters_ex() generates Diffie-Hellman parameters that can
  27 be shared among a group of users, and stores them in the provided B<DH>
  28 structure. The pseudo-random number generator must be
  29 seeded prior to calling DH_generate_parameters().
  30
  31 B<prime_len> is the length in bits of the safe prime to be generated.
  32 B<generator> is a small number E<gt> 1, typically 2 or 5.
  33
  34 A callback function may be used to provide feedback about the progress
  35 of the key generation. If B<cb> is not B<NULL>, it will be
  36 called as described in L<BN_generate_prime(3)> while a random prime
  37 number is generated, and when a prime has been found, B<BN_GENCB_call(cb, 3, 0)>
  38 is called. See L<BN_generate_prime(3)> for information on
  39 the BN_GENCB_call() function.
  40
  41 DH_check() validates Diffie-Hellman parameters. It checks that B<p> is
  42 a safe prime, and that B<g> is a suitable generator. In the case of an
  43 error, the bit flags DH_CHECK_P_NOT_SAFE_PRIME or
  44 DH_NOT_SUITABLE_GENERATOR are set in B<*codes>.
  45 DH_UNABLE_TO_CHECK_GENERATOR is set if the generator cannot be
  46 checked, i.e. it does not equal 2 or 5.
  47
  48 =head1 RETURN VALUES
  49
  50 DH_generate_parameters_ex() and DH_check() return 1 if the check could be
  51 performed, 0 otherwise.
  52
  53 DH_generate_parameters() (deprecated) returns a pointer to the DH structure, or
  54 NULL if the parameter generation fails.
  55
  56 The error codes can be obtained by L<ERR_get_error(3)>.
  57
  58 =head1 NOTES
  59
  60 DH_generate_parameters_ex() and DH_generate_parameters() may run for several
  61 hours before finding a suitable prime.
  62
  63 The parameters generated by DH_generate_parameters_ex() and DH_generate_parameters()
  64 are not to be used in signature schemes.
  65
  66 =head1 BUGS
  67
  68 If B<generator> is not 2 or 5, B<dh-E<gt>g>=B<generator> is not
  69 a usable generator.
  70
  71 =head1 SEE ALSO
  72
  73 L<dh(3)>, L<ERR_get_error(3)>, L<rand(3)>,
  74 L<DH_free(3)>
  75
  76 =cut