diff options
Diffstat (limited to '')
| -rw-r--r-- | src/lib/libcrypto/man/crypto.3 | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/crypto.3 b/src/lib/libcrypto/man/crypto.3 new file mode 100644 index 0000000000..24d4ed1979 --- /dev/null +++ b/src/lib/libcrypto/man/crypto.3 | |||
| @@ -0,0 +1,104 @@ | |||
| 1 | .Dd $Mdocdate: November 11 2015 $ | ||
| 2 | .Dt CRYPTO 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm crypto | ||
| 6 | .Nd OpenSSL cryptographic library | ||
| 7 | .Sh DESCRIPTION | ||
| 8 | The OpenSSL crypto library implements a wide range of cryptographic | ||
| 9 | algorithms used in various Internet standards. | ||
| 10 | The services provided by this library are used by the OpenSSL | ||
| 11 | implementations of SSL, TLS and S/MIME, and they have also been used to | ||
| 12 | implement SSH, OpenPGP, and other cryptographic standards. | ||
| 13 | .Sh OVERVIEW | ||
| 14 | .Sy libcrypto | ||
| 15 | consists of a number of sub-libraries that implement the individual | ||
| 16 | algorithms. | ||
| 17 | .Pp | ||
| 18 | The functionality includes symmetric encryption, public key cryptography | ||
| 19 | and key agreement, certificate handling, cryptographic hash functions | ||
| 20 | and a cryptographic pseudo-random number generator. | ||
| 21 | .Bl -tag -width Ds | ||
| 22 | .It SYMMETRIC CIPHERS | ||
| 23 | .Xr blowfish 3 , | ||
| 24 | cast, | ||
| 25 | .Xr des 3 , | ||
| 26 | idea, | ||
| 27 | rc2, | ||
| 28 | .Xr rc4 3 , | ||
| 29 | rc5 | ||
| 30 | .It PUBLIC KEY CRYPTOGRAPHY AND KEY AGREEMENT | ||
| 31 | .Xr dsa 3 , | ||
| 32 | .Xr dh 3 , | ||
| 33 | .Xr rsa 3 | ||
| 34 | .It CERTIFICATES | ||
| 35 | .Xr x509 3 , | ||
| 36 | x509v3 | ||
| 37 | .It AUTHENTICATION CODES, HASH FUNCTIONS | ||
| 38 | .Xr hmac 3 , | ||
| 39 | .Xr MD2 3 , | ||
| 40 | .Xr MD4 3 , | ||
| 41 | .Xr MD5 3 , | ||
| 42 | .Xr ripemd 3 , | ||
| 43 | .Xr sha 3 | ||
| 44 | .It AUXILIARY FUNCTIONS | ||
| 45 | .Xr ERR 3 , | ||
| 46 | .Xr threads 3 , | ||
| 47 | .Xr rand 3 , | ||
| 48 | .Xr OPENSSL_VERSION_NUMBER 3 | ||
| 49 | .It INPUT/OUTPUT, DATA ENCODING | ||
| 50 | asn1, | ||
| 51 | .Xr bio 3 , | ||
| 52 | .Xr evp 3 , | ||
| 53 | .Xr pem 3 , | ||
| 54 | pkcs7, | ||
| 55 | pkcs12 | ||
| 56 | .It INTERNAL FUNCTIONS | ||
| 57 | .Xr bn 3 , | ||
| 58 | .Xr buffer 3 , | ||
| 59 | .Xr ec 3 , | ||
| 60 | .Xr lhash 3 , | ||
| 61 | objects, | ||
| 62 | stack, | ||
| 63 | txt_db | ||
| 64 | .El | ||
| 65 | .Sh NOTES | ||
| 66 | Some of the newer functions follow a naming convention using the numbers | ||
| 67 | .Sq 0 | ||
| 68 | and | ||
| 69 | .Sq 1 . | ||
| 70 | For example the functions: | ||
| 71 | .Pp | ||
| 72 | .Ft int | ||
| 73 | .Fo X509_CRL_add0_revoked | ||
| 74 | .Fa "X509_CRL *crl" | ||
| 75 | .Fa "X509_REVOKED *rev" | ||
| 76 | .Fc | ||
| 77 | .br | ||
| 78 | .Ft int | ||
| 79 | .Fo X509_add1_trust_object | ||
| 80 | .Fa "X509 *x" | ||
| 81 | .Fa "ASN1_OBJECT *obj" | ||
| 82 | .Fc | ||
| 83 | .Pp | ||
| 84 | The | ||
| 85 | .Sq 0 | ||
| 86 | version uses the supplied structure pointer directly in the parent and | ||
| 87 | it will be freed up when the parent is freed. | ||
| 88 | In the above example | ||
| 89 | .Fa crl | ||
| 90 | would be freed but | ||
| 91 | .Fa rev | ||
| 92 | would not. | ||
| 93 | .Pp | ||
| 94 | The | ||
| 95 | .Sq 1 | ||
| 96 | function uses a copy of the supplied structure pointer (or in some cases | ||
| 97 | increases its link count) in the parent and so both | ||
| 98 | .Pf ( Fa x | ||
| 99 | and | ||
| 100 | .Fa obj | ||
| 101 | above) should be freed up. | ||
| 102 | .Sh SEE ALSO | ||
| 103 | .Xr openssl 1 , | ||
| 104 | .Xr ssl 3 | ||
