doc/man3/DH_generate_parameters.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 DH_generate_parameters_ex, DH_generate_parameters,
   6 DH_check, DH_check_params - generate and check Diffie-Hellman
   7 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  int DH_check_params(DH *dh, int *codes);
  17
  18 Deprecated:
  19
  20  #if OPENSSL_API_COMPAT < 0x00908000L
  21  DH *DH_generate_parameters(int prime_len, int generator,
  22                             void (*callback)(int, int, void *), void *cb_arg);
  23  #endif
  24
  25 =head1 DESCRIPTION
  26
  27 DH_generate_parameters_ex() generates Diffie-Hellman parameters that can
  28 be shared among a group of users, and stores them in the provided B<DH>
  29 structure. The pseudo-random number generator must be
  30 seeded prior to calling DH_generate_parameters().
  31
  32 B<prime_len> is the length in bits of the safe prime to be generated.
  33 B<generator> is a small number E<gt> 1, typically 2 or 5.
  34
  35 A callback function may be used to provide feedback about the progress
  36 of the key generation. If B<cb> is not B<NULL>, it will be
  37 called as described in L<BN_generate_prime(3)> while a random prime
  38 number is generated, and when a prime has been found, B<BN_GENCB_call(cb, 3, 0)>
  39 is called. See L<BN_generate_prime(3)> for information on
  40 the BN_GENCB_call() function.
  41
  42 DH_check_params() confirms that the B<p> and B<g> are likely enough to
  43 be valid.
  44 This is a lightweight check, if a more thorough check is needed, use
  45 DH_check().
  46 The value of B<*codes> is updated with any problems found.
  47 If B<*codes> is zero then no problems were found, otherwise the
  48 following bits may be set:
  49
  50 =over 4
  51
  52 =item DH_CHECK_P_NOT_PRIME
  53
  54 The parameter B<p> has been determined to not being an odd prime.
  55 Note that the lack of this bit doesn't guarantee that B<p> is a
  56 prime.
  57
  58 =item DH_NOT_SUITABLE_GENERATOR
  59
  60 The generator B<g> is not suitable.
  61 Note that the lack of this bit doesn't guarantee that B<g> is
  62 suitable, unless B<p> is known to be a strong prime.
  63
  64 =back
  65
  66 DH_check() confirms that the Diffie-Hellman parameters B<dh> are valid. The
  67 value of B<*codes> is updated with any problems found. If B<*codes> is zero then
  68 no problems were found, otherwise the following bits may be set:
  69
  70 =over 4
  71
  72 =item DH_CHECK_P_NOT_PRIME
  73
  74 The parameter B<p> is not prime.
  75
  76 =item DH_CHECK_P_NOT_SAFE_PRIME
  77
  78 The parameter B<p> is not a safe prime and no B<q> value is present.
  79
  80 =item DH_UNABLE_TO_CHECK_GENERATOR
  81
  82 The generator B<g> cannot be checked for suitability.
  83
  84 =item DH_NOT_SUITABLE_GENERATOR
  85
  86 The generator B<g> is not suitable.
  87
  88 =item DH_CHECK_Q_NOT_PRIME
  89
  90 The parameter B<q> is not prime.
  91
  92 =item DH_CHECK_INVALID_Q_VALUE
  93
  94 The parameter B<q> is invalid.
  95
  96 =item DH_CHECK_INVALID_J_VALUE
  97
  98 The parameter B<j> is invalid.
  99
 100 =back
 101
 102 =head1 RETURN VALUES
 103
 104 DH_generate_parameters_ex(), DH_check() and DH_check_params() return 1
 105 if the check could be performed, 0 otherwise.
 106
 107 DH_generate_parameters() (deprecated) returns a pointer to the DH structure, or
 108 NULL if the parameter generation fails.
 109
 110 The error codes can be obtained by L<ERR_get_error(3)>.
 111
 112 =head1 NOTES
 113
 114 DH_generate_parameters_ex() and DH_generate_parameters() may run for several
 115 hours before finding a suitable prime.
 116
 117 The parameters generated by DH_generate_parameters_ex() and DH_generate_parameters()
 118 are not to be used in signature schemes.
 119
 120 =head1 SEE ALSO
 121
 122 L<DH_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>,
 123 L<DH_free(3)>
 124
 125 =head1 COPYRIGHT
 126
 127 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 128
 129 Licensed under the OpenSSL license (the "License").  You may not use
 130 this file except in compliance with the License.  You can obtain a copy
 131 in the file LICENSE in the source distribution or at
 132 L<https://www.openssl.org/source/license.html>.
 133
 134 =cut