A local copy of OpenSSL from GitHub
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

105 lines
3.2 KiB

  1. Description
  2. ===========
  3. The OpenSSL Project is a collaborative effort to develop a robust,
  4. commercial-grade, fully featured, and Open Source toolkit implementing the
  5. Transport Layer Security (TLS) protocols (including SSLv3) as well as a
  6. full-strength general purpose cryptographic library.
  7. OpenSSL is descended from the SSLeay library developed by Eric A. Young
  8. and Tim J. Hudson.
  9. The OpenSSL toolkit is licensed under the Apache License 2.0, which means
  10. that you are free to get and use it for commercial and non-commercial
  11. purposes as long as you fulfill its conditions.
  12. Overview
  13. ========
  14. The OpenSSL toolkit includes:
  15. * **libssl**
  16. Provides the client and server-side implementations for SSLv3 and TLS.
  17. * **libcrypto:**
  18. Provides general cryptographic and X.509 support needed by SSL/TLS but
  19. not logically part of it.
  20. * **openssl:**
  21. A command line tool that can be used for:
  22. Creation of key parameters
  23. Creation of X.509 certificates, CSRs and CRLs
  24. Calculation of message digests
  25. Encryption and decryption
  26. SSL/TLS client and server tests
  27. Handling of S/MIME signed or encrypted mail
  28. And more...
  29. Installation
  30. ============
  31. See the appropriate file:
  32. * [INSTALL](INSTALL): General installation instructions for all platforms
  33. * Additional instructions for specific platforms
  34. * [NOTES.ANDROID](NOTES.ANDROID)
  35. * [NOTES.DJGPP](NOTES.DJGPP)
  36. * [NOTES.PERL](NOTES.PERL)
  37. * [NOTES.UNIX](NOTES.UNIX)
  38. * [NOTES.VALGRIND](NOTES.VALGRIND)
  39. * [NOTES.VMS](NOTES.VMS)
  40. * [NOTES.WIN](NOTES.WIN)
  41. Support
  42. =======
  43. See the OpenSSL website www.openssl.org for details on how to obtain
  44. commercial technical support. Free community support is available through the
  45. openssl-users email list (see
  46. https://www.openssl.org/community/mailinglists.html for further details).
  47. If you have any problems with OpenSSL then please take the following steps
  48. first:
  49. - Download the latest version from the repository
  50. to see if the problem has already been addressed
  51. - Configure with no-asm
  52. - Remove compiler optimization flags
  53. If you wish to report a bug then please include the following information
  54. and create an issue on GitHub:
  55. - OpenSSL version: output of 'openssl version -a'
  56. - Configuration data: output of 'perl configdata.pm --dump'
  57. - OS Name, Version, Hardware platform
  58. - Compiler Details (name, version)
  59. - Application Details (name, version)
  60. - Problem Description (steps that will reproduce the problem, if known)
  61. - Stack Traceback (if the application dumps core)
  62. Just because something doesn't work the way you expect does not mean it
  63. is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
  64. of query.
  65. How to contribute to OpenSSL
  66. ============================
  67. See [CONTRIBUTING](CONTRIBUTING.md)
  68. Legalities
  69. ==========
  70. A number of nations restrict the use or export of cryptography. If you
  71. are potentially subject to such restrictions you should seek competent
  72. professional legal advice before attempting to develop or distribute
  73. cryptographic code.
  74. Copyright
  75. =========
  76. Copyright (c) 1998-2018 The OpenSSL Project
  77. Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
  78. All rights reserved.