secure/lib/libcrypto/man/dh.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "dh 3"
 132 .TH dh 3 "2018-08-14" "1.0.2p" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 dh \- Diffie\-Hellman key agreement
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 2
 142 \& #include <openssl/dh.h>
 143 \& #include <openssl/engine.h>
 144 \&
 145 \& DH *   DH_new(void);
 146 \& void   DH_free(DH *dh);
 147 \&
 148 \& int    DH_size(const DH *dh);
 149 \&
 150 \& DH *   DH_generate_parameters(int prime_len, int generator,
 151 \&                void (*callback)(int, int, void *), void *cb_arg);
 152 \& int    DH_check(const DH *dh, int *codes);
 153 \&
 154 \& int    DH_generate_key(DH *dh);
 155 \& int    DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh);
 156 \&
 157 \& void DH_set_default_method(const DH_METHOD *meth);
 158 \& const DH_METHOD *DH_get_default_method(void);
 159 \& int DH_set_method(DH *dh, const DH_METHOD *meth);
 160 \& DH *DH_new_method(ENGINE *engine);
 161 \& const DH_METHOD *DH_OpenSSL(void);
 162 \&
 163 \& int DH_get_ex_new_index(long argl, char *argp, int (*new_func)(),
 164 \&             int (*dup_func)(), void (*free_func)());
 165 \& int DH_set_ex_data(DH *d, int idx, char *arg);
 166 \& char *DH_get_ex_data(DH *d, int idx);
 167 \&
 168 \& DH *   d2i_DHparams(DH **a, unsigned char **pp, long length);
 169 \& int    i2d_DHparams(const DH *a, unsigned char **pp);
 170 \&
 171 \& int    DHparams_print_fp(FILE *fp, const DH *x);
 172 \& int    DHparams_print(BIO *bp, const DH *x);
 173 .Ve
 174 .SH "DESCRIPTION"
 175 .IX Header "DESCRIPTION"
 176 These functions implement the Diffie-Hellman key agreement protocol.
 177 The generation of shared \s-1DH\s0 parameters is described in
 178 \&\fIDH_generate_parameters\fR\|(3); \fIDH_generate_key\fR\|(3) describes how
 179 to perform a key agreement.
 180 .PP
 181 The \fB\s-1DH\s0\fR structure consists of several \s-1BIGNUM\s0 components.
 182 .PP
 183 .Vb 9
 184 \& struct
 185 \&        {
 186 \&        BIGNUM *p;              // prime number (shared)
 187 \&        BIGNUM *g;              // generator of Z_p (shared)
 188 \&        BIGNUM *priv_key;       // private DH value x
 189 \&        BIGNUM *pub_key;        // public DH value g^x
 190 \&        // ...
 191 \&        };
 192 \& DH
 193 .Ve
 194 .PP
 195 Note that \s-1DH\s0 keys may use non-standard \fB\s-1DH_METHOD\s0\fR implementations,
 196 either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
 197 \&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
 198 will not be used by the implementation or may be used for alternative data
 199 storage. For this reason, applications should generally avoid using \s-1DH\s0
 200 structure elements directly and instead use \s-1API\s0 functions to query or
 201 modify keys.
 202 .SH "SEE ALSO"
 203 .IX Header "SEE ALSO"
 204 \&\fIdhparam\fR\|(1), \fIbn\fR\|(3), \fIdsa\fR\|(3), \fIerr\fR\|(3),
 205 \&\fIrand\fR\|(3), \fIrsa\fR\|(3), \fIengine\fR\|(3),
 206 \&\fIDH_set_method\fR\|(3), \fIDH_new\fR\|(3),
 207 \&\fIDH_get_ex_new_index\fR\|(3),
 208 \&\fIDH_generate_parameters\fR\|(3),
 209 \&\fIDH_compute_key\fR\|(3), \fId2i_DHparams\fR\|(3),
 210 \&\fIRSA_print\fR\|(3)