summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorschwarze <>2016-12-06 14:29:51 +0000
committerschwarze <>2016-12-06 14:29:51 +0000
commita9f376f6401745b2c598c1ee411f19ce8b26a17c (patch)
tree6982a07bfe0b1d71a7d5c3663ba4ab3baa91656e /src/lib
parent38728ccd4a8caf84940f64598f6c524254c34226 (diff)
downloadopenbsd-a9f376f6401745b2c598c1ee411f19ce8b26a17c.tar.gz
openbsd-a9f376f6401745b2c598c1ee411f19ce8b26a17c.tar.bz2
openbsd-a9f376f6401745b2c598c1ee411f19ce8b26a17c.zip
Add Copyright and license.
Mention AES, Chacha20, ECDSA, OCSP, OPENSSL_config. Improve many cross references. Convert the table into some real text and polish some wording. Stop talking about SSL. Drop vague references to undocumented internals (objects, stack, txt_db). Delete verbiage that says nothing or is duplicate. Ultimately, the content of this page should be merged into OPENSSL_init_crypto(3), but we don't have that function yet, so the merge has to wait.
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/libcrypto/man/crypto.3148
1 files changed, 107 insertions, 41 deletions
diff --git a/src/lib/libcrypto/man/crypto.3 b/src/lib/libcrypto/man/crypto.3
index a60b682a63..ea98bce36e 100644
--- a/src/lib/libcrypto/man/crypto.3
+++ b/src/lib/libcrypto/man/crypto.3
@@ -1,4 +1,53 @@
1.\" $OpenBSD: crypto.3,v 1.7 2016/12/06 12:24:33 schwarze Exp $ 1.\" $OpenBSD: crypto.3,v 1.8 2016/12/06 14:29:51 schwarze Exp $
2.\" OpenSSL a9c85cea Nov 11 09:33:55 2016 +0100
3.\"
4.\" This file was written by Ulf Moeller <ulf@openssl.org> and
5.\" Dr. Stephen Henson <steve@openssl.org>.
6.\" Copyright (c) 2000, 2002 The OpenSSL Project. All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\"
12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer.
14.\"
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\" notice, this list of conditions and the following disclaimer in
17.\" the documentation and/or other materials provided with the
18.\" distribution.
19.\"
20.\" 3. All advertising materials mentioning features or use of this
21.\" software must display the following acknowledgment:
22.\" "This product includes software developed by the OpenSSL Project
23.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24.\"
25.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26.\" endorse or promote products derived from this software without
27.\" prior written permission. For written permission, please contact
28.\" openssl-core@openssl.org.
29.\"
30.\" 5. Products derived from this software may not be called "OpenSSL"
31.\" nor may "OpenSSL" appear in their names without prior written
32.\" permission of the OpenSSL Project.
33.\"
34.\" 6. Redistributions of any form whatsoever must retain the following
35.\" acknowledgment:
36.\" "This product includes software developed by the OpenSSL Project
37.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38.\"
39.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE.
2.\" 51.\"
3.Dd $Mdocdate: December 6 2016 $ 52.Dd $Mdocdate: December 6 2016 $
4.Dt CRYPTO 3 53.Dt CRYPTO 3
@@ -10,65 +59,82 @@
10The OpenSSL crypto library implements a wide range of cryptographic 59The OpenSSL crypto library implements a wide range of cryptographic
11algorithms used in various Internet standards. 60algorithms used in various Internet standards.
12The services provided by this library are used by the OpenSSL 61The services provided by this library are used by the OpenSSL
13implementations of SSL, TLS and S/MIME, and they have also been used to 62implementations of TLS and S/MIME, and they have also been used to
14implement SSH, OpenPGP, and other cryptographic standards. 63implement SSH, OpenPGP, and other cryptographic standards.
15.Pp 64.Pp
16.Sy libcrypto 65.Sy Symmetric ciphers
17consists of a number of sub-libraries that implement the individual 66including AES, Blowfish, CAST, Chacha20, IDEA, DES, RC2, RC4, and
18algorithms. 67RC5 are provided by the generic interface
68.Xr EVP_EncryptInit 3 .
69Low-level stand-alone interfaces include
70.Xr BF_set_key 3 ,
71.Xr DES_set_key 3 ,
72and
73.Xr RC4 3 .
19.Pp 74.Pp
20The functionality includes symmetric encryption, public key cryptography 75.Sy Public key cryptography and key agreement
21and key agreement, certificate handling, cryptographic hash functions 76are provided by
22and a cryptographic pseudo-random number generator.
23.Bl -tag -width Ds -offset indent
24.It SYMMETRIC CIPHERS
25.Xr blowfish 3 ,
26CAST, DES, IDEA, RC2,
27.Xr RC4 3 ,
28RC5, see
29.Xr EVP_EncryptInit 3
30.It PUBLIC KEY CRYPTOGRAPHY AND KEY AGREEMENT
31.Xr dsa 3 ,
32.Xr dh 3 , 77.Xr dh 3 ,
33.Xr rsa 3 78.Xr dsa 3 ,
34.It CERTIFICATES 79.Xr ECDSA_SIG_new 3 ,
35.Xr x509 3 , 80and
36x509v3 81.Xr rsa 3 .
37.It AUTHENTICATION CODES, HASH FUNCTIONS 82.Pp
83.Sy Certificates
84are handled by
85.Xr x509 3
86and
87.Xr X509v3_add_ext 3 .
88.Pp
89.Sy Authentication codes and hash functions
90offered inlude
38.Xr HMAC 3 , 91.Xr HMAC 3 ,
39.Xr MD2 3 , 92.Xr MD2 3 ,
40.Xr MD4 3 , 93.Xr MD4 3 ,
41.Xr MD5 3 , 94.Xr MD5 3 ,
42.Xr RIPEMD160 3 , 95.Xr RIPEMD160 3 ,
43.Xr sha1 3 , 96.Xr SHA1 3 ,
44.Xr sha2 3 97and
45.It AUXILIARY FUNCTIONS 98.Xr SHA256 3 .
46.Xr ERR 3 , 99.Pp
47.Xr threads 3 , 100.Sy Input, output, and data encoding
48.Xr RAND_bytes 3 , 101facilities include ASN.1,
49.Xr OPENSSL_VERSION_NUMBER 3
50.It INPUT/OUTPUT, DATA ENCODING
51asn1,
52.Xr BIO_new 3 , 102.Xr BIO_new 3 ,
53.Xr evp 3 , 103.Xr evp 3 ,
54PEM, 104.Xr PEM_read 3 ,
55pkcs7, 105.Xr PKCS7_encrypt 3 ,
56pkcs12 106.Xr PKCS7_sign 3 ,
57.It INTERNAL FUNCTIONS 107.Xr PKCS12_create 3 ,
108and
109.Xr SMIME_write_PKCS7 3 .
110.Pp
111.Sy Auxiliary features include:
112.Bl -dash -compact
113.It
114configuration file handling, see
115.Xr OPENSSL_config 3
116.It
117error reporting, see
118.Xr ERR 3
119.It
120thread support, see
121.Xr CRYPTO_set_locking_callback 3
122.It
123.Xr OCSP_REQUEST_new 3
124.El
125.Pp
126.Sy Internal utilities
127include
58.Xr bn 3 , 128.Xr bn 3 ,
59.Xr BIO_f_buffer 3 , 129.Xr BIO_f_buffer 3 ,
60.Xr ec 3 , 130.Xr ec 3 ,
61.Xr lh_new 3 , 131.Xr lh_new 3 .
62objects,
63stack,
64txt_db
65.El
66.Pp 132.Pp
67Some of the newer functions follow a naming convention using the numbers 133Some of the newer functions follow a naming convention using the numbers
68.Sq 0 134.Sq 0
69and 135and
70.Sq 1 . 136.Sq 1 .
71For example the functions: 137For example consider the names of these functions:
72.Pp 138.Pp
73.Ft int 139.Ft int
74.Fo X509_CRL_add0_revoked 140.Fo X509_CRL_add0_revoked