summaryrefslogtreecommitdiff
path: root/secure/lib/libcrypto/man/DH_generate_parameters.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/DH_generate_parameters.3')
-rw-r--r--secure/lib/libcrypto/man/DH_generate_parameters.3207
1 files changed, 0 insertions, 207 deletions
diff --git a/secure/lib/libcrypto/man/DH_generate_parameters.3 b/secure/lib/libcrypto/man/DH_generate_parameters.3
deleted file mode 100644
index 7dfbba987d8c..000000000000
--- a/secure/lib/libcrypto/man/DH_generate_parameters.3
+++ /dev/null
@@ -1,207 +0,0 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Feb 19 16:42:49 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_generate_parameters 3"
-.TH DH_generate_parameters 3 "0.9.7a" "2003-02-19" "OpenSSL"
-.UC
-.SH "NAME"
-DH_generate_parameters, DH_check \- generate and check Diffie-Hellman parameters
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
-.Vb 1
-\& #include <openssl/dh.h>
-.Ve
-.Vb 2
-\& DH *DH_generate_parameters(int prime_len, int generator,
-\& void (*callback)(int, int, void *), void *cb_arg);
-.Ve
-.Vb 1
-\& int DH_check(DH *dh, int *codes);
-.Ve
-.SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
-\&\fIDH_generate_parameters()\fR generates Diffie-Hellman parameters that can
-be shared among a group of users, and returns them in a newly
-allocated \fB\s-1DH\s0\fR structure. The pseudo-random number generator must be
-seeded prior to calling \fIDH_generate_parameters()\fR.
-.PP
-\&\fBprime_len\fR is the length in bits of the safe prime to be generated.
-\&\fBgenerator\fR is a small number > 1, typically 2 or 5.
-.PP
-A callback function may be used to provide feedback about the progress
-of the key generation. If \fBcallback\fR is not \fB\s-1NULL\s0\fR, it will be
-called as described in BN_generate_prime(3) while a random prime
-number is generated, and when a prime has been found, \fBcallback(3,
-0, cb_arg)\fR is called.
-.PP
-\&\fIDH_check()\fR validates Diffie-Hellman parameters. It checks that \fBp\fR is
-a safe prime, and that \fBg\fR is a suitable generator. In the case of an
-error, the bit flags \s-1DH_CHECK_P_NOT_SAFE_PRIME\s0 or
-\&\s-1DH_NOT_SUITABLE_GENERATOR\s0 are set in \fB*codes\fR.
-\&\s-1DH_UNABLE_TO_CHECK_GENERATOR\s0 is set if the generator cannot be
-checked, i.e. it does not equal 2 or 5.
-.SH "RETURN VALUES"
-.IX Header "RETURN VALUES"
-\&\fIDH_generate_parameters()\fR returns a pointer to the \s-1DH\s0 structure, or
-\&\s-1NULL\s0 if the parameter generation fails. The error codes can be
-obtained by ERR_get_error(3).
-.PP
-\&\fIDH_check()\fR returns 1 if the check could be performed, 0 otherwise.
-.SH "NOTES"
-.IX Header "NOTES"
-\&\fIDH_generate_parameters()\fR may run for several hours before finding a
-suitable prime.
-.PP
-The parameters generated by \fIDH_generate_parameters()\fR are not to be
-used in signature schemes.
-.SH "BUGS"
-.IX Header "BUGS"
-If \fBgenerator\fR is not 2 or 5, \fBdh->g\fR=\fBgenerator\fR is not
-a usable generator.
-.SH "SEE ALSO"
-.IX Header "SEE ALSO"
-dh(3), ERR_get_error(3), rand(3),
-DH_free(3)
-.SH "HISTORY"
-.IX Header "HISTORY"
-\&\fIDH_check()\fR is available in all versions of SSLeay and OpenSSL.
-The \fBcb_arg\fR argument to \fIDH_generate_parameters()\fR was added in SSLeay 0.9.0.
-.PP
-In versions before OpenSSL 0.9.5, \s-1DH_CHECK_P_NOT_STRONG_PRIME\s0 is used
-instead of \s-1DH_CHECK_P_NOT_SAFE_PRIME\s0.