crypto/external/bsd/openssl/lib/libcrypto/man/crypto.3

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