213 lines
6.4 KiB
Groff
213 lines
6.4 KiB
Groff
.\" $NetBSD: crypto.3,v 1.13 2004/03/20 21:48:46 groo Exp $
|
|
.\"
|
|
.\" Automatically generated by Pod::Man version 1.15
|
|
.\" Sat Mar 20 16:41:10 2004
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ======================================================================
|
|
.de Sh \" Subsection heading
|
|
.br
|
|
.if t .Sp
|
|
.ne 5
|
|
.PP
|
|
\fB\\$1\fR
|
|
.PP
|
|
..
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Ip \" List item
|
|
.br
|
|
.ie \\n(.$>=3 .ne \\$3
|
|
.el .ne 3
|
|
.IP "\\$1" \\$2
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. | will give a
|
|
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
|
|
.\" to do unbreakable dashes and therefore won't be available. \*(C` and
|
|
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
|
|
.tr \(*W-|\(bv\*(Tr
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr
|
|
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
|
|
.\" index entries marked with X<> in POD. Of course, you'll have to process
|
|
.\" the output yourself in some meaningful fashion.
|
|
.if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.\"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it
|
|
.\" makes way too many mistakes in technical documents.
|
|
.hy 0
|
|
.if n .na
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
.bd B 3
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ======================================================================
|
|
.\"
|
|
.IX Title "crypto 3"
|
|
.TH crypto 3 "0.9.7d" "2003-09-24" "OpenSSL"
|
|
.UC
|
|
.SH "NAME"
|
|
crypto \- OpenSSL cryptographic library
|
|
.SH "LIBRARY"
|
|
libcrypto, -lcrypto
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The OpenSSL \fBcrypto\fR library implements a wide range of cryptographic
|
|
algorithms used in various Internet standards. The services provided
|
|
by this library are used by the OpenSSL implementations of \s-1SSL\s0, \s-1TLS\s0
|
|
and S/MIME, and they have also been used to implement \s-1SSH\s0, OpenPGP, and
|
|
other cryptographic standards.
|
|
.SH "OVERVIEW"
|
|
.IX Header "OVERVIEW"
|
|
\&\fBlibcrypto\fR consists of a number of sub-libraries that implement the
|
|
individual algorithms.
|
|
.PP
|
|
The functionality includes symmetric encryption, public key
|
|
cryptography and key agreement, certificate handling, cryptographic
|
|
hash functions and a cryptographic pseudo-random number generator.
|
|
.Ip "\s-1SYMMETRIC\s0 \s-1CIPHERS\s0" 4
|
|
.IX Item "SYMMETRIC CIPHERS"
|
|
openssl_blowfish(3), cast(3), openssl_des(3),
|
|
idea(3), rc2(3), openssl_rc4(3), rc5(3)
|
|
.Ip "\s-1PUBLIC\s0 \s-1KEY\s0 \s-1CRYPTOGRAPHY\s0 \s-1AND\s0 \s-1KEY\s0 \s-1AGREEMENT\s0" 4
|
|
.IX Item "PUBLIC KEY CRYPTOGRAPHY AND KEY AGREEMENT"
|
|
openssl_dsa(3), openssl_dh(3), openssl_rsa(3)
|
|
.Ip "\s-1CERTIFICATES\s0" 4
|
|
.IX Item "CERTIFICATES"
|
|
x509(3), x509v3(3)
|
|
.Ip "\s-1AUTHENTICATION\s0 \s-1CODES\s0, \s-1HASH\s0 \s-1FUNCTIONS\s0" 4
|
|
.IX Item "AUTHENTICATION CODES, HASH FUNCTIONS"
|
|
openssl_hmac(3), md2(3), md4(3),
|
|
openssl_md5(3), openssl_mdc2(3), openssl_ripemd(3),
|
|
openssl_sha(3)
|
|
.Ip "\s-1AUXILIARY\s0 \s-1FUNCTIONS\s0" 4
|
|
.IX Item "AUXILIARY FUNCTIONS"
|
|
openssl_err(3), openssl_threads(3), openssl_rand(3),
|
|
OPENSSL_VERSION_NUMBER(3)
|
|
.Ip "\s-1INPUT/OUTPUT\s0, \s-1DATA\s0 \s-1ENCODING\s0" 4
|
|
.IX Item "INPUT/OUTPUT, DATA ENCODING"
|
|
asn1(3), openssl_bio(3), openssl_evp(3), pem(3),
|
|
pkcs7(3), pkcs12(3)
|
|
.Ip "\s-1INTERNAL\s0 \s-1FUNCTIONS\s0" 4
|
|
.IX Item "INTERNAL FUNCTIONS"
|
|
openssl_bn(3), openssl_buffer(3), openssl_lhash(3),
|
|
objects(3), stack(3),
|
|
txt_db(3)
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
Some of the newer functions follow a naming convention using the numbers
|
|
\&\fB0\fR and \fB1\fR. For example the functions:
|
|
.PP
|
|
.Vb 2
|
|
\& int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev);
|
|
\& int X509_add1_trust_object(X509 *x, ASN1_OBJECT *obj);
|
|
.Ve
|
|
The \fB0\fR version uses the supplied structure pointer directly
|
|
in the parent and it will be freed up when the parent is freed.
|
|
In the above example \fBcrl\fR would be freed but \fBrev\fR would not.
|
|
.PP
|
|
The \fB1\fR function uses a copy of the supplied structure pointer
|
|
(or in some cases increases its link count) in the parent and
|
|
so both (\fBx\fR and \fBobj\fR above) should be freed up.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
openssl(1), ssl(3)
|