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