summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/dh.pod
diff options
context:
space:
mode:
authorschwarze <>2016-11-05 13:36:33 +0000
committerschwarze <>2016-11-05 13:36:33 +0000
commit71b431bd059aaefaa67b54a34adfaadc4014902c (patch)
tree7bf60aef63735e9638d12b0d8302b14d9860466e /src/lib/libcrypto/doc/dh.pod
parent5074288f0801a2b426584402e81b5953f706a44f (diff)
downloadopenbsd-71b431bd059aaefaa67b54a34adfaadc4014902c.tar.gz
openbsd-71b431bd059aaefaa67b54a34adfaadc4014902c.tar.bz2
openbsd-71b431bd059aaefaa67b54a34adfaadc4014902c.zip
convert the remaining manual pages from pod to mdoc
Diffstat (limited to 'src/lib/libcrypto/doc/dh.pod')
-rw-r--r--src/lib/libcrypto/doc/dh.pod79
1 files changed, 0 insertions, 79 deletions
diff --git a/src/lib/libcrypto/doc/dh.pod b/src/lib/libcrypto/doc/dh.pod
deleted file mode 100644
index 5fb9890a77..0000000000
--- a/src/lib/libcrypto/doc/dh.pod
+++ /dev/null
@@ -1,79 +0,0 @@
1=pod
2
3=head1 NAME
4
5dh - Diffie-Hellman key agreement
6
7=head1 SYNOPSIS
8
9 #include <openssl/dh.h>
10 #include <openssl/engine.h>
11
12 DH * DH_new(void);
13 void DH_free(DH *dh);
14
15 int DH_size(const DH *dh);
16
17 DH * DH_generate_parameters(int prime_len, int generator,
18 void (*callback)(int, int, void *), void *cb_arg);
19 int DH_check(const DH *dh, int *codes);
20
21 int DH_generate_key(DH *dh);
22 int DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh);
23
24 void DH_set_default_method(const DH_METHOD *meth);
25 const DH_METHOD *DH_get_default_method(void);
26 int DH_set_method(DH *dh, const DH_METHOD *meth);
27 DH *DH_new_method(ENGINE *engine);
28 const DH_METHOD *DH_OpenSSL(void);
29
30 int DH_get_ex_new_index(long argl, char *argp, int (*new_func)(),
31 int (*dup_func)(), void (*free_func)());
32 int DH_set_ex_data(DH *d, int idx, char *arg);
33 char *DH_get_ex_data(DH *d, int idx);
34
35 DH * d2i_DHparams(DH **a, unsigned char **pp, long length);
36 int i2d_DHparams(const DH *a, unsigned char **pp);
37
38 int DHparams_print_fp(FILE *fp, const DH *x);
39 int DHparams_print(BIO *bp, const DH *x);
40
41=head1 DESCRIPTION
42
43These functions implement the Diffie-Hellman key agreement protocol. The
44generation of shared DH parameters is described in
45L<DH_generate_parameters(3)|DH_generate_parameters(3)>;
46L<DH_generate_key(3)|DH_generate_key(3)> describes how to perform a key
47agreement.
48
49The B<DH> structure consists of several BIGNUM components.
50
51 struct
52 {
53 BIGNUM *p; // prime number (shared)
54 BIGNUM *g; // generator of Z_p (shared)
55 BIGNUM *priv_key; // private DH value x
56 BIGNUM *pub_key; // public DH value g^x
57 // ...
58 };
59 DH
60
61Note that DH keys may use non-standard B<DH_METHOD> implementations,
62either directly or by the use of B<ENGINE> modules. In some cases (eg. an
63ENGINE providing support for hardware-embedded keys), these BIGNUM values
64will not be used by the implementation or may be used for alternative data
65storage. For this reason, applications should generally avoid using DH
66structure elements directly and instead use API functions to query or
67modify keys.
68
69=head1 SEE ALSO
70
71L<dhparam(1)|dhparam(1)>, L<bn(3)|bn(3)>, L<dsa(3)|dsa(3)>, L<err(3)|err(3)>,
72L<rand(3)|rand(3)>, L<rsa(3)|rsa(3)>, L<engine(3)|engine(3)>,
73L<DH_set_method(3)|DH_set_method(3)>, L<DH_new(3)|DH_new(3)>,
74L<DH_get_ex_new_index(3)|DH_get_ex_new_index(3)>,
75L<DH_generate_parameters(3)|DH_generate_parameters(3)>,
76L<DH_compute_key(3)|DH_compute_key(3)>, L<d2i_DHparams(3)|d2i_DHparams(3)>,
77L<RSA_print(3)|RSA_print(3)>
78
79=cut