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.

223 lines
6.4 KiB

  1. Welcome to the OpenSSL Project
  2. ==============================
  3. [![openssl logo]][www.openssl.org]
  4. [![github actions ci badge]][github actions ci]
  5. [![appveyor badge]][appveyor jobs]
  6. OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit
  7. for the Transport Layer Security (TLS) protocol formerly known as the
  8. Secure Sockets Layer (SSL) protocol. The protocol implementation is based
  9. on a full-strength general purpose cryptographic library, which can also
  10. be used stand-alone.
  11. OpenSSL is descended from the SSLeay library developed by Eric A. Young
  12. and Tim J. Hudson.
  13. The official Home Page of the OpenSSL Project is [www.openssl.org].
  14. Table of Contents
  15. =================
  16. - [Overview](#overview)
  17. - [Download](#download)
  18. - [Build and Install](#build-and-install)
  19. - [Documentation](#documentation)
  20. - [License](#license)
  21. - [Support](#support)
  22. - [Contributing](#contributing)
  23. - [Legalities](#legalities)
  24. Overview
  25. ========
  26. The OpenSSL toolkit includes:
  27. - **libssl**
  28. an implementation of all TLS protocol versions up to TLSv1.3 ([RFC 8446]).
  29. - **libcrypto**
  30. a full-strength general purpose cryptographic library. It constitutes the
  31. basis of the TLS implementation, but can also be used independently.
  32. - **openssl**
  33. the OpenSSL command line tool, a swiss army knife for cryptographic tasks,
  34. testing and analyzing. It can be used for
  35. - creation of key parameters
  36. - creation of X.509 certificates, CSRs and CRLs
  37. - calculation of message digests
  38. - encryption and decryption
  39. - SSL/TLS client and server tests
  40. - handling of S/MIME signed or encrypted mail
  41. - and more...
  42. Download
  43. ========
  44. For Production Use
  45. ------------------
  46. Source code tarballs of the official releases can be downloaded from
  47. [www.openssl.org/source](https://www.openssl.org/source).
  48. The OpenSSL project does not distribute the toolkit in binary form.
  49. However, for a large variety of operating systems precompiled versions
  50. of the OpenSSL toolkit are available. In particular on Linux and other
  51. Unix operating systems it is normally recommended to link against the
  52. precompiled shared libraries provided by the distributor or vendor.
  53. For Testing and Development
  54. ---------------------------
  55. Although testing and development could in theory also be done using
  56. the source tarballs, having a local copy of the git repository with
  57. the entire project history gives you much more insight into the
  58. code base.
  59. The official OpenSSL Git Repository is located at [git.openssl.org].
  60. There is a GitHub mirror of the repository at [github.com/openssl/openssl],
  61. which is updated automatically from the former on every commit.
  62. A local copy of the Git Repository can be obtained by cloning it from
  63. the original OpenSSL repository using
  64. git clone git://git.openssl.org/openssl.git
  65. or from the GitHub mirror using
  66. git clone https://github.com/openssl/openssl.git
  67. If you intend to contribute to OpenSSL, either to fix bugs or contribute
  68. new features, you need to fork the OpenSSL repository openssl/openssl on
  69. GitHub and clone your public fork instead.
  70. git clone https://github.com/yourname/openssl.git
  71. This is necessary, because all development of OpenSSL nowadays is done via
  72. GitHub pull requests. For more details, see [Contributing](#contributing).
  73. Build and Install
  74. =================
  75. After obtaining the Source, have a look at the [INSTALL](INSTALL.md) file for
  76. detailed instructions about building and installing OpenSSL. For some
  77. platforms, the installation instructions are amended by a platform specific
  78. document.
  79. * [Notes for UNIX-like platforms](NOTES-UNIX.md)
  80. * [Notes for Android platforms](NOTES-ANDROID.md)
  81. * [Notes for Windows platforms](NOTES-WINDOWS.md)
  82. * [Notes for the DOS platform with DJGPP](NOTES-DJGPP.md)
  83. * [Notes for the OpenVMS platform](NOTES-VMS.md)
  84. * [Notes on Perl](NOTES-PERL.md)
  85. * [Notes on Valgrind](NOTES-VALGRIND.md)
  86. Specific notes on upgrading to OpenSSL 3.0 from previous versions, as well as
  87. known issues are available on the [OpenSSL 3.0 Wiki] page.
  88. Documentation
  89. =============
  90. Manual Pages
  91. ------------
  92. The manual pages for the master branch and all current stable releases are
  93. available online.
  94. - [OpenSSL master](https://www.openssl.org/docs/manmaster)
  95. - [OpenSSL 1.1.1](https://www.openssl.org/docs/man1.1.1)
  96. Wiki
  97. ----
  98. There is a Wiki at [wiki.openssl.org] which is currently not very active.
  99. It contains a lot of useful information, not all of which is up to date.
  100. License
  101. =======
  102. OpenSSL is licensed under the Apache License 2.0, which means that
  103. you are free to get and use it for commercial and non-commercial
  104. purposes as long as you fulfill its conditions.
  105. See the [LICENSE.txt](LICENSE.txt) file for more details.
  106. Support
  107. =======
  108. There are various ways to get in touch. The correct channel depends on
  109. your requirement. see the [SUPPORT](SUPPORT.md) file for more details.
  110. Contributing
  111. ============
  112. If you are interested and willing to contribute to the OpenSSL project,
  113. please take a look at the [CONTRIBUTING](CONTRIBUTING.md) file.
  114. Legalities
  115. ==========
  116. A number of nations restrict the use or export of cryptography. If you are
  117. potentially subject to such restrictions you should seek legal advice before
  118. attempting to develop or distribute cryptographic code.
  119. Copyright
  120. =========
  121. Copyright (c) 1998-2021 The OpenSSL Project
  122. Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
  123. All rights reserved.
  124. <!-- Links -->
  125. [www.openssl.org]:
  126. <https://www.openssl.org>
  127. "OpenSSL Homepage"
  128. [git.openssl.org]:
  129. <https://git.openssl.org>
  130. "OpenSSL Git Repository"
  131. [git.openssl.org]:
  132. <https://git.openssl.org>
  133. "OpenSSL Git Repository"
  134. [github.com/openssl/openssl]:
  135. <https://github.com/openssl/openssl>
  136. "OpenSSL GitHub Mirror"
  137. [wiki.openssl.org]:
  138. <https://wiki.openssl.org>
  139. "OpenSSL Wiki"
  140. [OpenSSL 3.0 Wiki]:
  141. <https://wiki.openssl.org/index.php/OpenSSL_3.0>
  142. "OpenSSL 3.0 Wiki"
  143. [RFC 8446]:
  144. <https://tools.ietf.org/html/rfc8446>
  145. <!-- Logos and Badges -->
  146. [openssl logo]:
  147. doc/images/openssl.svg
  148. "OpenSSL Logo"
  149. [github actions ci badge]:
  150. <https://github.com/openssl/openssl/workflows/GitHub%20CI/badge.svg>
  151. "GitHub Actions CI Status"
  152. [github actions ci]:
  153. <https://github.com/openssl/openssl/actions?query=workflow%3A%22GitHub+CI%22>
  154. "GitHub Actions CI"
  155. [appveyor badge]:
  156. <https://ci.appveyor.com/api/projects/status/8e10o7xfrg73v98f/branch/master?svg=true>
  157. "AppVeyor Build Status"
  158. [appveyor jobs]:
  159. <https://ci.appveyor.com/project/openssl/openssl/branch/master>
  160. "AppVeyor Jobs"