crypto.pod 1.8 KB

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