summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatt Caswell <matt@openssl.org>2023-10-25 11:10:51 +0100
committerHugo Landau <hlandau@openssl.org>2023-10-30 07:53:40 +0000
commit0181a1a49c6a63a0b23eb15558336660f5833002 (patch)
tree040f6df56d9022ac823e8e697886a4b285425790 /README.md
parent186b3f6a016de8fcf8573be111e3d174ca20f1bc (diff)
Refresh the README.md file
Reviewed-by: Hugo Landau <hlandau@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/22505)
Diffstat (limited to 'README.md')
-rw-r--r--README.md55
1 files changed, 47 insertions, 8 deletions
diff --git a/README.md b/README.md
index c620649381..3f6ea956ea 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,11 @@ Welcome to the OpenSSL Project
[![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
-Secure Sockets Layer (SSL) protocol. The protocol implementation is based
-on a full-strength general purpose cryptographic library, which can also
-be used stand-alone.
+for the TLS (formerly SSL), DTLS and QUIC (client side only) protocols.
+
+The protocol implementations are based on a full-strength general purpose
+cryptographic library, which can also be used stand-alone. Also included is a
+cryptographic module validated to conform with FIPS standards.
OpenSSL is descended from the SSLeay library developed by Eric A. Young
and Tim J. Hudson.
@@ -35,7 +36,9 @@ Overview
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]),
+ DTLS protocol versions up to DTLSv1.2 ([RFC 6347]) and
+ the QUIC (client side only) version 1 protocol ([RFC 9000]).
- **libcrypto**
a full-strength general purpose cryptographic library. It constitutes the
@@ -48,7 +51,8 @@ The OpenSSL toolkit includes:
- creation of X.509 certificates, CSRs and CRLs
- calculation of message digests
- encryption and decryption
- - SSL/TLS client and server tests
+ - SSL/TLS/DTLS and client and server tests
+ - QUIC client tests
- handling of S/MIME signed or encrypted mail
- and more...
@@ -67,6 +71,10 @@ 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.
+We also maintain a list of third parties that produce OpenSSL binaries for
+various Operating Systems (including Windows) on the [Binaries] page on our
+wiki.
+
For Testing and Development
---------------------------
@@ -113,12 +121,29 @@ document.
* [Notes on Perl](NOTES-PERL.md)
* [Notes on Valgrind](NOTES-VALGRIND.md)
-Specific notes on upgrading to OpenSSL 3.0 from previous versions can be found
+Specific notes on upgrading to OpenSSL 3.x from previous versions can be found
in the [ossl-guide-migration(7ossl)] manual page.
Documentation
=============
+README Files
+------------
+
+There are some README.md files in the top level of the source distribution
+containing additional information on specific topics.
+
+ * [Information about the OpenSSL QUIC protocol implementation](README-QUIC.md)
+ * [Information about the OpenSSL Provider architecture](README-PROVIDERS.md)
+ * [Information about using the OpenSSL FIPS validated module](README-FIPS.md)
+ * [Information about the legacy OpenSSL Engine architecture](README-ENGINES.md)
+
+The OpenSSL Guide
+-----------------
+
+There are some tutorial and introductory pages on some important OpenSSL topics
+within the [OpenSSL Guide].
+
Manual Pages
------------
@@ -127,7 +152,7 @@ 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)
+- [OpenSSL 3.1](https://www.openssl.org/docs/man3.1)
Wiki
----
@@ -201,6 +226,20 @@ All rights reserved.
[RFC 8446]:
<https://tools.ietf.org/html/rfc8446>
+[RFC 6347]:
+ <https://tools.ietf.org/html/rfc6347>
+
+[RFC 9000]:
+ <https://tools.ietf.org/html/rfc9000>
+
+[Binaries]:
+ https://wiki.openssl.org/index.php/Binaries
+ "List of third party OpenSSL binaries"
+
+[OpenSSL Guide]:
+ https://www.openssl.org/docs/manmaster/man7/ossl-guide-introduction.html
+ "An introduction to OpenSSL"
+
<!-- Logos and Badges -->
[openssl logo]: