secure/lib/libcrypto/man/dh.3

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