crypto/external/bsd/openssl/lib/libcrypto/man/openssl_dh.3

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