1.\" $OpenBSD: crypto.3,v 1.16 2017/01/07 08:46:13 jmc 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. 51.\" 52.Dd $Mdocdate: January 7 2017 $ 53.Dt CRYPTO 3 54.Os 55.Sh NAME 56.Nm crypto 57.Nd OpenSSL cryptographic library 58.Sh DESCRIPTION 59The OpenSSL crypto library implements a wide range of cryptographic 60algorithms used in various Internet standards. 61The services provided by this library are used by the OpenSSL 62implementations of TLS and S/MIME, and they have also been used to 63implement SSH, OpenPGP, and other cryptographic standards. 64.Pp 65.Sy Symmetric ciphers 66including AES, Blowfish, CAST, Chacha20, IDEA, DES, RC2, RC4, and 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 . 74.Pp 75.Sy Public key cryptography and key agreement 76are provided by 77.Xr DH_new 3 , 78.Xr DSA_new 3 , 79.Xr ECDSA_SIG_new 3 , 80and 81.Xr RSA_new 3 . 82.Pp 83.Sy Certificates 84are handled by 85.Xr X509_new 3 86and 87.Xr X509v3_add_ext 3 . 88.Pp 89.Sy Authentication codes and hash functions 90offered include 91.Xr HMAC 3 , 92.Xr MD2 3 , 93.Xr MD4 3 , 94.Xr MD5 3 , 95.Xr RIPEMD160 3 , 96.Xr SHA1 3 , 97and 98.Xr SHA256 3 . 99.Pp 100.Sy Input, output, and data encoding 101facilities include ASN.1, 102.Xr BIO_new 3 , 103.Xr evp 3 , 104.Xr PEM_read 3 , 105.Xr PKCS7_encrypt 3 , 106.Xr PKCS7_sign 3 , 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 128.Xr BIO_f_buffer 3 , 129.Xr BN_new 3 , 130.Xr EC_GROUP_new 3 , 131.Xr lh_new 3 . 132.Pp 133Some of the newer functions follow a naming convention using the numbers 134.Sq 0 135and 136.Sq 1 . 137For example consider the names of these functions: 138.Pp 139.Ft int 140.Fo X509_CRL_add0_revoked 141.Fa "X509_CRL *crl" 142.Fa "X509_REVOKED *rev" 143.Fc 144.br 145.Ft int 146.Fo X509_add1_trust_object 147.Fa "X509 *x" 148.Fa "ASN1_OBJECT *obj" 149.Fc 150.Pp 151The 152.Sq 0 153version uses the supplied structure pointer directly in the parent and 154it will be freed up when the parent is freed. 155In the above example 156.Fa crl 157would be freed but 158.Fa rev 159would not. 160.Pp 161The 162.Sq 1 163function uses a copy of the supplied structure pointer (or in some cases 164increases its link count) in the parent and so both 165.Pf ( Fa x 166and 167.Fa obj 168above) should be freed up. 169.Sh SEE ALSO 170.Xr openssl 1 , 171.Xr ssl 3 172