secure/lib/libcrypto/man/dh.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  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 "2007-03-28" "0.9.8e" "OpenSSL"
 133 .SH "NAME"
 134 dh \- Diffie\-Hellman key agreement
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \& #include <openssl/dh.h>
 139 \& #include <openssl/engine.h>
 140 .Ve
 141 .PP
 142 .Vb 2
 143 \& DH *   DH_new(void);
 144 \& void   DH_free(DH *dh);
 145 .Ve
 146 .PP
 147 .Vb 1
 148 \& int    DH_size(const DH *dh);
 149 .Ve
 150 .PP
 151 .Vb 3
 152 \& DH *   DH_generate_parameters(int prime_len, int generator,
 153 \&                void (*callback)(int, int, void *), void *cb_arg);
 154 \& int    DH_check(const DH *dh, int *codes);
 155 .Ve
 156 .PP
 157 .Vb 2
 158 \& int    DH_generate_key(DH *dh);
 159 \& int    DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh);
 160 .Ve
 161 .PP
 162 .Vb 5
 163 \& void DH_set_default_method(const DH_METHOD *meth);
 164 \& const DH_METHOD *DH_get_default_method(void);
 165 \& int DH_set_method(DH *dh, const DH_METHOD *meth);
 166 \& DH *DH_new_method(ENGINE *engine);
 167 \& const DH_METHOD *DH_OpenSSL(void);
 168 .Ve
 169 .PP
 170 .Vb 4
 171 \& int DH_get_ex_new_index(long argl, char *argp, int (*new_func)(),
 172 \&             int (*dup_func)(), void (*free_func)());
 173 \& int DH_set_ex_data(DH *d, int idx, char *arg);
 174 \& char *DH_get_ex_data(DH *d, int idx);
 175 .Ve
 176 .PP
 177 .Vb 2
 178 \& DH *   d2i_DHparams(DH **a, unsigned char **pp, long length);
 179 \& int    i2d_DHparams(const DH *a, unsigned char **pp);
 180 .Ve
 181 .PP
 182 .Vb 2
 183 \& int    DHparams_print_fp(FILE *fp, const DH *x);
 184 \& int    DHparams_print(BIO *bp, const DH *x);
 185 .Ve
 186 .SH "DESCRIPTION"
 187 .IX Header "DESCRIPTION"
 188 These functions implement the Diffie-Hellman key agreement protocol.
 189 The generation of shared \s-1DH\s0 parameters is described in
 190 \&\fIDH_generate_parameters\fR\|(3); \fIDH_generate_key\fR\|(3) describes how
 191 to perform a key agreement.
 192 .PP
 193 The \fB\s-1DH\s0\fR structure consists of several \s-1BIGNUM\s0 components.
 194 .PP
 195 .Vb 9
 196 \& struct
 197 \&        {
 198 \&        BIGNUM *p;              // prime number (shared)
 199 \&        BIGNUM *g;              // generator of Z_p (shared)
 200 \&        BIGNUM *priv_key;       // private DH value x
 201 \&        BIGNUM *pub_key;        // public DH value g^x
 202 \&        // ...
 203 \&        };
 204 \& DH
 205 .Ve
 206 .PP
 207 Note that \s-1DH\s0 keys may use non-standard \fB\s-1DH_METHOD\s0\fR implementations,
 208 either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
 209 \&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
 210 will not be used by the implementation or may be used for alternative data
 211 storage. For this reason, applications should generally avoid using \s-1DH\s0
 212 structure elements directly and instead use \s-1API\s0 functions to query or
 213 modify keys.
 214 .SH "SEE ALSO"
 215 .IX Header "SEE ALSO"
 216 \&\fIdhparam\fR\|(1), \fIbn\fR\|(3), \fIdsa\fR\|(3), \fIerr\fR\|(3),
 217 \&\fIrand\fR\|(3), \fIrsa\fR\|(3), \fIengine\fR\|(3),
 218 \&\fIDH_set_method\fR\|(3), \fIDH_new\fR\|(3),
 219 \&\fIDH_get_ex_new_index\fR\|(3),
 220 \&\fIDH_generate_parameters\fR\|(3),
 221 \&\fIDH_compute_key\fR\|(3), \fId2i_DHparams\fR\|(3),
 222 \&\fIRSA_print\fR\|(3)