f4401cd869
alter des.h to be friendly with openssl/des.h (you can include both in the same file) make libkrb to depend on libdes. bump major. massage various portioin of heimdal to be friendly with openssl 0.9.7b.
228 lines
6.5 KiB
Groff
228 lines
6.5 KiB
Groff
.\" $NetBSD: openssl_dh.3,v 1.8 2003/07/24 14:16:50 itojun Exp $
|
|
.\"
|
|
.\" Automatically generated by Pod::Man version 1.02
|
|
.\" Thu Jul 24 13:08:05 2003
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ======================================================================
|
|
.de Sh \" Subsection heading
|
|
.br
|
|
.if t .Sp
|
|
.ne 5
|
|
.PP
|
|
\fB\\$1\fR
|
|
.PP
|
|
..
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Ip \" List item
|
|
.br
|
|
.ie \\n(.$>=3 .ne \\$3
|
|
.el .ne 3
|
|
.IP "\\$1" \\$2
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. | will give a
|
|
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
|
|
.\" to do unbreakable dashes and therefore won't be available. \*(C` and
|
|
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
|
|
.tr \(*W-|\(bv\*(Tr
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` `
|
|
. ds C' '
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr
|
|
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
|
|
.\" index entries marked with X<> in POD. Of course, you'll have to process
|
|
.\" the output yourself in some meaningful fashion.
|
|
.if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
. .
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.\"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it
|
|
.\" makes way too many mistakes in technical documents.
|
|
.hy 0
|
|
.if n .na
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
.bd B 3
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ======================================================================
|
|
.\"
|
|
.IX Title "dh 3"
|
|
.TH dh 3 "0.9.7b" "2002-08-06" "OpenSSL"
|
|
.UC
|
|
.SH "NAME"
|
|
dh \- Diffie-Hellman key agreement
|
|
.SH "LIBRARY"
|
|
libcrypto, -lcrypto
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 2
|
|
\& #include <openssl/dh.h>
|
|
\& #include <openssl/engine.h>
|
|
.Ve
|
|
.Vb 2
|
|
\& DH * DH_new(void);
|
|
\& void DH_free(DH *dh);
|
|
.Ve
|
|
.Vb 1
|
|
\& int DH_size(const DH *dh);
|
|
.Ve
|
|
.Vb 3
|
|
\& DH * DH_generate_parameters(int prime_len, int generator,
|
|
\& void (*callback)(int, int, void *), void *cb_arg);
|
|
\& int DH_check(const DH *dh, int *codes);
|
|
.Ve
|
|
.Vb 2
|
|
\& int DH_generate_key(DH *dh);
|
|
\& int DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh);
|
|
.Ve
|
|
.Vb 5
|
|
\& void DH_set_default_method(const DH_METHOD *meth);
|
|
\& const DH_METHOD *DH_get_default_method(void);
|
|
\& int DH_set_method(DH *dh, const DH_METHOD *meth);
|
|
\& DH *DH_new_method(ENGINE *engine);
|
|
\& const DH_METHOD *DH_OpenSSL(void);
|
|
.Ve
|
|
.Vb 4
|
|
\& int DH_get_ex_new_index(long argl, char *argp, int (*new_func)(),
|
|
\& int (*dup_func)(), void (*free_func)());
|
|
\& int DH_set_ex_data(DH *d, int idx, char *arg);
|
|
\& char *DH_get_ex_data(DH *d, int idx);
|
|
.Ve
|
|
.Vb 2
|
|
\& DH * d2i_DHparams(DH **a, unsigned char **pp, long length);
|
|
\& int i2d_DHparams(const DH *a, unsigned char **pp);
|
|
.Ve
|
|
.Vb 2
|
|
\& int DHparams_print_fp(FILE *fp, const DH *x);
|
|
\& int DHparams_print(BIO *bp, const DH *x);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
These functions implement the Diffie-Hellman key agreement protocol.
|
|
The generation of shared \s-1DH\s0 parameters is described in
|
|
DH_generate_parameters(3); DH_generate_key(3) describes how
|
|
to perform a key agreement.
|
|
.PP
|
|
The \fB\s-1DH\s0\fR structure consists of several \s-1BIGNUM\s0 components.
|
|
.PP
|
|
.Vb 9
|
|
\& struct
|
|
\& {
|
|
\& BIGNUM *p; // prime number (shared)
|
|
\& BIGNUM *g; // generator of Z_p (shared)
|
|
\& BIGNUM *priv_key; // private DH value x
|
|
\& BIGNUM *pub_key; // public DH value g^x
|
|
\& // ...
|
|
\& };
|
|
\& DH
|
|
.Ve
|
|
Note that \s-1DH\s0 keys may use non-standard \fB\s-1DH_METHOD\s0\fR implementations,
|
|
either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
|
|
\&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
|
|
will not be used by the implementation or may be used for alternative data
|
|
storage. For this reason, applications should generally avoid using \s-1DH\s0
|
|
structure elements directly and instead use \s-1API\s0 functions to query or
|
|
modify keys.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
openssl_dhparam(1), openssl_bn(3), openssl_dsa(3), openssl_err(3),
|
|
openssl_rand(3), openssl_rsa(3), engine(3),
|
|
DH_set_method(3), DH_new(3),
|
|
DH_get_ex_new_index(3),
|
|
DH_generate_parameters(3),
|
|
DH_compute_key(3), d2i_DHparams(3),
|
|
RSA_print(3)
|