README 3.0 KB

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