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