Welcome to the OpenSSL Project
==============================
-[![openssl logo][]][www.openssl.org]
+[![openssl logo]][www.openssl.org]
-[![travis badge][]][travis jobs]
-[![appveyor badge][]][appveyor jobs]
+[![github actions ci badge]][github actions ci]
+[![appveyor badge]][appveyor jobs]
OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit
for the Transport Layer Security (TLS) protocol formerly known as the
OpenSSL is descended from the SSLeay library developed by Eric A. Young
and Tim J. Hudson.
-The official Home Page of the OpenSSL Project is [www.openssl.org][].
+The official Home Page of the OpenSSL Project is [www.openssl.org].
Table of Contents
=================
The OpenSSL toolkit includes:
- **libssl**
- an implementation of all TLS protocol versions up to TLSv1.3 ([RFC 8446][]).
+ an implementation of all TLS protocol versions up to TLSv1.3 ([RFC 8446]).
- **libcrypto**
a full-strength general purpose cryptographic library. It constitutes the
The OpenSSL project does not distribute the toolkit in binary form.
However, for a large variety of operating systems precompiled versions
-of the OpenSSL toolkit are available. In particular on Linux and other
-Unix operating systems it is normally recommended to link against the
+of the OpenSSL toolkit are available. In particular, on Linux and other
+Unix operating systems, it is normally recommended to link against the
precompiled shared libraries provided by the distributor or vendor.
For Testing and Development
the entire project history gives you much more insight into the
code base.
-The official OpenSSL Git Repository is located at [git.openssl.org][].
-There is a GitHub mirror of the repository at [github.com/openssl/openssl][],
+The official OpenSSL Git Repository is located at [git.openssl.org].
+There is a GitHub mirror of the repository at [github.com/openssl/openssl],
which is updated automatically from the former on every commit.
A local copy of the Git Repository can be obtained by cloning it from
git clone https://github.com/yourname/openssl.git
-This is necessary, because all development of OpenSSL nowadays is done via
+This is necessary because all development of OpenSSL nowadays is done via
GitHub pull requests. For more details, see [Contributing](#contributing).
Build and Install
platforms, the installation instructions are amended by a platform specific
document.
- * [NOTES.ANDROID](NOTES.ANDROID)
- * [NOTES.DJGPP](NOTES.DJGPP)
- * [NOTES.PERL](NOTES.PERL)
- * [NOTES.UNIX](NOTES.UNIX)
- * [NOTES.VALGRIND](NOTES.VALGRIND)
- * [NOTES.VMS](NOTES.VMS)
- * [NOTES.WIN](NOTES.WIN)
+ * [Notes for UNIX-like platforms](NOTES-UNIX.md)
+ * [Notes for Android platforms](NOTES-ANDROID.md)
+ * [Notes for Windows platforms](NOTES-WINDOWS.md)
+ * [Notes for the DOS platform with DJGPP](NOTES-DJGPP.md)
+ * [Notes for the OpenVMS platform](NOTES-VMS.md)
+ * [Notes on Perl](NOTES-PERL.md)
+ * [Notes on Valgrind](NOTES-VALGRIND.md)
-Specific notes on upgrading to OpenSSL 3.0 from previous versions, as well as
-known issues are available on the OpenSSL
-[wiki](https://wiki.openssl.org/index.php/OpenSSL_3.0).
+Specific notes on upgrading to OpenSSL 3.0 from previous versions can be found
+in the [migration_guide(7ossl)] manual page.
Documentation
=============
available online.
- [OpenSSL master](https://www.openssl.org/docs/manmaster)
+- [OpenSSL 3.0](https://www.openssl.org/docs/man3.0)
- [OpenSSL 1.1.1](https://www.openssl.org/docs/man1.1.1)
Wiki
----
-There is a Wiki at [wiki.openssl.org][] which is currently not very active.
-It contains a lot of useful information, not all of which is up to date.
+There is a Wiki at [wiki.openssl.org] which is currently not very active.
+It contains a lot of useful information, not all of which is up-to-date.
License
=======
=======
There are various ways to get in touch. The correct channel depends on
-your requirement. see the [SUPPORT](SUPPORT.md) file for more details.
+your requirement. See the [SUPPORT](SUPPORT.md) file for more details.
Contributing
============
If you are interested and willing to contribute to the OpenSSL project,
please take a look at the [CONTRIBUTING](CONTRIBUTING.md) file.
-Since 2016, development takes place in public on the GitHub open source
-platform. The OpenSSL Project Pages at [openssl.github.io][] are a
-valuable source of information if you want to get familiar with our
-development process on GitHub.
-
Legalities
==========
A number of nations restrict the use or export of cryptography. If you are
-potentially subject to such restrictions you should seek legal advice before
+potentially subject to such restrictions, you should seek legal advice before
attempting to develop or distribute cryptographic code.
Copyright
=========
-Copyright (c) 1998-2020 The OpenSSL Project
+Copyright (c) 1998-2022 The OpenSSL Project
Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
<https://github.com/openssl/openssl>
"OpenSSL GitHub Mirror"
-[openssl.github.io]:
- <https://mspncp.github.io>
- "OpenSSL Project Pages"
-
[wiki.openssl.org]:
<https://wiki.openssl.org>
"OpenSSL Wiki"
+[migration_guide(7ossl)]:
+ <https://www.openssl.org/docs/manmaster/man7/migration_guide.html>
+ "OpenSSL Migration Guide"
+
[RFC 8446]:
<https://tools.ietf.org/html/rfc8446>
<!-- Logos and Badges -->
-<!--
- Note: The security token for the appveyor badge (the random number in
- the URL below) was obtained for the mspncp/openssl project.
- It needs to be replaced by the correct token by some core member
- (@levitte, @mattcaswell?). It can be obtained for project members at
- https://ci.appveyor.com/project/openssl/openssl/settings/badges.
--->
[openssl logo]:
doc/images/openssl.svg
"OpenSSL Logo"
-[travis badge]:
- <https://travis-ci.org/openssl/openssl.svg?branch=master>
- "Travis Build Status"
+[github actions ci badge]:
+ <https://github.com/openssl/openssl/workflows/GitHub%20CI/badge.svg>
+ "GitHub Actions CI Status"
-[travis jobs]:
- <https://travis-ci.org/openssl/openssl>
- "Travis Jobs"
+[github actions ci]:
+ <https://github.com/openssl/openssl/actions?query=workflow%3A%22GitHub+CI%22>
+ "GitHub Actions CI"
[appveyor badge]:
- <https://ci.appveyor.com/api/projects/status/ikn2l4u1xsume63u/branch/master?svg=true>
+ <https://ci.appveyor.com/api/projects/status/8e10o7xfrg73v98f/branch/master?svg=true>
"AppVeyor Build Status"
[appveyor jobs]:
projects / openssl.git / blobdiff