Merge branch 'vendor/OPENSSL'
[dragonfly.git] / secure / lib / libcrypto / man / crypto.3
CommitLineData
e257b235 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
28.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" nothing in troff, for use with C<>.
32.tr \(*W-
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb 50.\"
e257b235
PA
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
8b0cefbb
JR
55.\" If the F register is turned on, we'll generate index entries on stderr for
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion.
e257b235 59.ie \nF \{\
8b0cefbb
JR
60. de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 62..
8b0cefbb
JR
63. nr % 0
64. rr F
984263bc 65.\}
e257b235
PA
66.el \{\
67. de IX
68..
69.\}
aac4ff6f 70.\"
8b0cefbb
JR
71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72.\" Fear. Run. Save yourself. No user-serviceable parts.
73. \" fudge factors for nroff and troff
984263bc 74.if n \{\
8b0cefbb
JR
75. ds #H 0
76. ds #V .8m
77. ds #F .3m
78. ds #[ \f1
79. ds #] \fP
984263bc
MD
80.\}
81.if t \{\
8b0cefbb
JR
82. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83. ds #V .6m
84. ds #F 0
85. ds #[ \&
86. ds #] \&
984263bc 87.\}
8b0cefbb 88. \" simple accents for nroff and troff
984263bc 89.if n \{\
8b0cefbb
JR
90. ds ' \&
91. ds ` \&
92. ds ^ \&
93. ds , \&
94. ds ~ ~
95. ds /
984263bc
MD
96.\}
97.if t \{\
8b0cefbb
JR
98. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 104.\}
8b0cefbb 105. \" troff and (daisy-wheel) nroff accents
984263bc
MD
106.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113.ds ae a\h'-(\w'a'u*4/10)'e
114.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 115. \" corrections for vroff
984263bc
MD
116.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 118. \" for low resolution devices (crt and lpr)
984263bc
MD
119.if \n(.H>23 .if \n(.V>19 \
120\{\
8b0cefbb
JR
121. ds : e
122. ds 8 ss
123. ds o a
124. ds d- d\h'-1'\(ga
125. ds D- D\h'-1'\(hy
126. ds th \o'bp'
127. ds Th \o'LP'
128. ds ae ae
129. ds Ae AE
984263bc
MD
130.\}
131.rm #[ #] #H #V #F C
8b0cefbb
JR
132.\" ========================================================================
133.\"
134.IX Title "crypto 3"
fc468453 135.TH crypto 3 "2010-02-27" "0.9.8m" "OpenSSL"
e257b235
PA
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
984263bc
MD
140.SH "NAME"
141crypto \- OpenSSL cryptographic library
142.SH "SYNOPSIS"
8b0cefbb 143.IX Header "SYNOPSIS"
984263bc 144.SH "DESCRIPTION"
8b0cefbb 145.IX Header "DESCRIPTION"
984263bc
MD
146The OpenSSL \fBcrypto\fR library implements a wide range of cryptographic
147algorithms used in various Internet standards. The services provided
8b0cefbb
JR
148by this library are used by the OpenSSL implementations of \s-1SSL\s0, \s-1TLS\s0
149and S/MIME, and they have also been used to implement \s-1SSH\s0, OpenPGP, and
984263bc
MD
150other cryptographic standards.
151.SH "OVERVIEW"
8b0cefbb
JR
152.IX Header "OVERVIEW"
153\&\fBlibcrypto\fR consists of a number of sub-libraries that implement the
984263bc
MD
154individual algorithms.
155.PP
156The functionality includes symmetric encryption, public key
157cryptography and key agreement, certificate handling, cryptographic
158hash functions and a cryptographic pseudo-random number generator.
8b0cefbb
JR
159.IP "\s-1SYMMETRIC\s0 \s-1CIPHERS\s0" 4
160.IX Item "SYMMETRIC CIPHERS"
161\&\fIblowfish\fR\|(3), \fIcast\fR\|(3), \fIdes\fR\|(3),
e257b235 162\&\fIidea\fR\|(3), \fIrc2\fR\|(3), \fIrc4\fR\|(3), \fIrc5\fR\|(3)
8b0cefbb
JR
163.IP "\s-1PUBLIC\s0 \s-1KEY\s0 \s-1CRYPTOGRAPHY\s0 \s-1AND\s0 \s-1KEY\s0 \s-1AGREEMENT\s0" 4
164.IX Item "PUBLIC KEY CRYPTOGRAPHY AND KEY AGREEMENT"
165\&\fIdsa\fR\|(3), \fIdh\fR\|(3), \fIrsa\fR\|(3)
166.IP "\s-1CERTIFICATES\s0" 4
167.IX Item "CERTIFICATES"
168\&\fIx509\fR\|(3), \fIx509v3\fR\|(3)
169.IP "\s-1AUTHENTICATION\s0 \s-1CODES\s0, \s-1HASH\s0 \s-1FUNCTIONS\s0" 4
170.IX Item "AUTHENTICATION CODES, HASH FUNCTIONS"
171\&\fIhmac\fR\|(3), \fImd2\fR\|(3), \fImd4\fR\|(3),
172\&\fImd5\fR\|(3), \fImdc2\fR\|(3), \fIripemd\fR\|(3),
173\&\fIsha\fR\|(3)
174.IP "\s-1AUXILIARY\s0 \s-1FUNCTIONS\s0" 4
175.IX Item "AUXILIARY FUNCTIONS"
176\&\fIerr\fR\|(3), \fIthreads\fR\|(3), \fIrand\fR\|(3),
177\&\s-1\fIOPENSSL_VERSION_NUMBER\s0\fR\|(3)
178.IP "\s-1INPUT/OUTPUT\s0, \s-1DATA\s0 \s-1ENCODING\s0" 4
179.IX Item "INPUT/OUTPUT, DATA ENCODING"
180\&\fIasn1\fR\|(3), \fIbio\fR\|(3), \fIevp\fR\|(3), \fIpem\fR\|(3),
e257b235 181\&\fIpkcs7\fR\|(3), \fIpkcs12\fR\|(3)
8b0cefbb
JR
182.IP "\s-1INTERNAL\s0 \s-1FUNCTIONS\s0" 4
183.IX Item "INTERNAL FUNCTIONS"
184\&\fIbn\fR\|(3), \fIbuffer\fR\|(3), \fIlhash\fR\|(3),
185\&\fIobjects\fR\|(3), \fIstack\fR\|(3),
e257b235 186\&\fItxt_db\fR\|(3)
984263bc 187.SH "NOTES"
8b0cefbb 188.IX Header "NOTES"
984263bc 189Some of the newer functions follow a naming convention using the numbers
8b0cefbb 190\&\fB0\fR and \fB1\fR. For example the functions:
984263bc
MD
191.PP
192.Vb 2
193\& int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev);
194\& int X509_add1_trust_object(X509 *x, ASN1_OBJECT *obj);
195.Ve
8b0cefbb 196.PP
984263bc
MD
197The \fB0\fR version uses the supplied structure pointer directly
198in the parent and it will be freed up when the parent is freed.
199In the above example \fBcrl\fR would be freed but \fBrev\fR would not.
200.PP
201The \fB1\fR function uses a copy of the supplied structure pointer
202(or in some cases increases its link count) in the parent and
203so both (\fBx\fR and \fBobj\fR above) should be freed up.
204.SH "SEE ALSO"
74dab6c2 205.IX Header "SEE ALSO"
8b0cefbb 206\&\fIopenssl\fR\|(1), \fIssl\fR\|(3)