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

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