Docs: install generic manpages to man section 7
[openssl.git] / doc / crypto / crypto.pod
1 =pod
2
3 =for comment openssl_manual_section:7
4
5 =head1 NAME
6
7 crypto - OpenSSL cryptographic library
8
9 =head1 SYNOPSIS
10
11 See the individual manual pages for details.
12
13 =head1 DESCRIPTION
14
15 The OpenSSL B<crypto> library implements a wide range of cryptographic
16 algorithms used in various Internet standards. The services provided
17 by this library are used by the OpenSSL implementations of SSL, TLS
18 and S/MIME, and they have also been used to implement SSH, OpenPGP, and
19 other cryptographic standards.
20
21 B<libcrypto> consists of a number of sub-libraries that implement the
22 individual algorithms.
23
24 The functionality includes symmetric encryption, public key
25 cryptography and key agreement, certificate handling, cryptographic
26 hash functions, cryptographic pseudo-random number generator, and
27 various utilities.
28
29 =head1 NOTES
30
31 Some of the newer functions follow a naming convention using the numbers
32 B<0> and B<1>. For example the functions:
33
34  int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev);
35  int X509_add1_trust_object(X509 *x, ASN1_OBJECT *obj);
36
37 The B<0> version uses the supplied structure pointer directly
38 in the parent and it will be freed up when the parent is freed.
39 In the above example B<crl> would be freed but B<rev> would not.
40
41 The B<1> function uses a copy of the supplied structure pointer
42 (or in some cases increases its link count) in the parent and
43 so both (B<x> and B<obj> above) should be freed up.
44
45 =head1 RETURN VALUES
46
47 See the individual manual pages for details.
48
49 =head1 SEE ALSO
50
51 L<openssl(1)>, L<ssl(3)>
52
53 =head1 COPYRIGHT
54
55 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
56
57 Licensed under the OpenSSL license (the "License").  You may not use
58 this file except in compliance with the License.  You can obtain a copy
59 in the file LICENSE in the source distribution or at
60 L<https://www.openssl.org/source/license.html>.
61
62 =cut