secure/lib/libcrypto/man/crypto.3

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