mirror of https://github.com/openssl/openssl
doc: revamp the README file
* Add an OpenSSL logo and CI badges * Add a table of contents * Add a lot of links Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10545)
This commit is contained in:
Dr. Matthias St. Pierre
parent
569b74a36b
commit
dac5138e13
278
README.md
278
README.md
|
|
@ -1,105 +1,243 @@
|
||||||
Description
|
[![openssl logo][]][www.openssl.org]
|
||||||
===========
|
|
||||||
|
|
||||||
The OpenSSL Project is a collaborative effort to develop a robust,
|
[![travis badge][]][travis jobs]
|
||||||
commercial-grade, fully featured, and Open Source toolkit implementing the
|
[![appveyor badge][]][appveyor jobs]
|
||||||
Transport Layer Security (TLS) protocols (including SSLv3) as well as a
|
|
||||||
full-strength general purpose cryptographic library.
|
|
||||||
|
|
||||||
|
Welcome to the OpenSSL Project
|
||||||
|
==============================
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
OpenSSL is descended from the SSLeay library developed by Eric A. Young
|
OpenSSL is descended from the SSLeay library developed by Eric A. Young
|
||||||
and Tim J. Hudson.
|
and Tim J. Hudson.
|
||||||
|
|
||||||
The OpenSSL toolkit is licensed under the Apache License 2.0, which means
|
The official Home Page of the OpenSSL Project is [www.openssl.org][].
|
||||||
that you are free to get and use it for commercial and non-commercial
|
|
||||||
purposes as long as you fulfill its conditions.
|
|
||||||
|
Table of Contents
|
||||||
|
=================
|
||||||
|
|
||||||
|
- [Overview](#overview)
|
||||||
|
- [Download](#download)
|
||||||
|
- [Build and Install](#build-and-install)
|
||||||
|
- [Documentation](#documentation)
|
||||||
|
- [License](#license)
|
||||||
|
- [Support](#support)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
- [Legalities](#legalities)
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
========
|
========
|
||||||
|
|
||||||
The OpenSSL toolkit includes:
|
The OpenSSL toolkit includes:
|
||||||
|
|
||||||
* **libssl**
|
- **libssl**
|
||||||
Provides the client and server-side implementations for SSLv3 and TLS.
|
an implementation of all TLS protocol versions up to TLSv1.3 ([RFC 8446][]).
|
||||||
|
|
||||||
* **libcrypto:**
|
- **libcrypto**
|
||||||
Provides general cryptographic and X.509 support needed by SSL/TLS but
|
a full-strength general purpose cryptographic library. It constitutes the
|
||||||
not logically part of it.
|
basis of the TLS implementation, but can also be used independently.
|
||||||
|
|
||||||
* **openssl:**
|
- **openssl**
|
||||||
A command line tool that can be used for:
|
the OpenSSL command line tool, a swiss army knife for cryptographic tasks,
|
||||||
Creation of key parameters
|
testing and analyzing. It can be used for
|
||||||
Creation of X.509 certificates, CSRs and CRLs
|
- creation of key parameters
|
||||||
Calculation of message digests
|
- creation of X.509 certificates, CSRs and CRLs
|
||||||
Encryption and decryption
|
- calculation of message digests
|
||||||
SSL/TLS client and server tests
|
- encryption and decryption
|
||||||
Handling of S/MIME signed or encrypted mail
|
- SSL/TLS client and server tests
|
||||||
And more...
|
- handling of S/MIME signed or encrypted mail
|
||||||
|
- and more...
|
||||||
|
|
||||||
Installation
|
Download
|
||||||
============
|
========
|
||||||
|
|
||||||
See the appropriate file:
|
For Production Use
|
||||||
|
------------------
|
||||||
|
|
||||||
* [INSTALL](INSTALL): General installation instructions for all platforms
|
Source code tarballs of the official releases can be downloaded from
|
||||||
* Additional instructions for specific platforms
|
[www.openssl.org/source](https://www.openssl.org/source).
|
||||||
* [NOTES.ANDROID](NOTES.ANDROID)
|
The OpenSSL project does not distribute the toolkit in binary form.
|
||||||
* [NOTES.DJGPP](NOTES.DJGPP)
|
|
||||||
* [NOTES.PERL](NOTES.PERL)
|
However, for a large variety of operating systems precompiled versions
|
||||||
* [NOTES.UNIX](NOTES.UNIX)
|
of the OpenSSL toolkit are available. In particular on Linux and other
|
||||||
* [NOTES.VALGRIND](NOTES.VALGRIND)
|
Unix operating systems it is normally recommended to link against the
|
||||||
* [NOTES.VMS](NOTES.VMS)
|
precompiled shared libraries provided by the distributor or vendor.
|
||||||
* [NOTES.WIN](NOTES.WIN)
|
|
||||||
|
|
||||||
|
For Testing and Development
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
Although testing and development could in theory also be done using
|
||||||
|
the source tarballs, having a local copy of the git repository with
|
||||||
|
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][],
|
||||||
|
which is updated automatically from the former on every commit.
|
||||||
|
|
||||||
|
A local copy of the Git Repository can be obtained by cloning it from
|
||||||
|
the original OpenSSL repository using
|
||||||
|
|
||||||
|
git clone git://git.openssl.org/openssl.git
|
||||||
|
|
||||||
|
or from the GitHub mirror using
|
||||||
|
|
||||||
|
git clone https://github.com/openssl/openssl.git
|
||||||
|
|
||||||
|
If you intend to contribute to OpenSSL, either to fix bugs or contribute
|
||||||
|
new features, you need to fork the OpenSSL repository openssl/openssl on
|
||||||
|
GitHub and clone your public fork instead.
|
||||||
|
|
||||||
|
git clone https://github.com/yourname/openssl.git
|
||||||
|
|
||||||
|
This is necessary, because all development of OpenSSL nowadays is done via
|
||||||
|
GitHub pull requests. For more details, see [Contributing](#contributing).
|
||||||
|
|
||||||
|
|
||||||
|
Build and Install
|
||||||
|
=================
|
||||||
|
|
||||||
|
After obtaining the Source, have a look at the [INSTALL](INSTALL.md) file for
|
||||||
|
detailed instructions about building and installing OpenSSL. For some
|
||||||
|
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)
|
||||||
|
|
||||||
|
|
||||||
|
Documentation
|
||||||
|
=============
|
||||||
|
|
||||||
|
Manual Pages
|
||||||
|
------------
|
||||||
|
|
||||||
|
The manual pages for the master branch and all current stable releases are
|
||||||
|
available online.
|
||||||
|
|
||||||
|
- [OpenSSL master](https://www.openssl.org/docs/manmaster)
|
||||||
|
- [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.
|
||||||
|
|
||||||
|
License
|
||||||
|
=======
|
||||||
|
|
||||||
|
OpenSSL is licensed under the Apache License 2.0, which means that
|
||||||
|
you are free to get and use it for commercial and non-commercial
|
||||||
|
purposes as long as you fulfill its conditions.
|
||||||
|
|
||||||
|
See the [LICENSE](LICENSE) file for more details.
|
||||||
|
|
||||||
Support
|
Support
|
||||||
=======
|
=======
|
||||||
|
|
||||||
See the OpenSSL website www.openssl.org for details on how to obtain
|
There are various ways to get in touch. The correct channel depends on
|
||||||
commercial technical support. Free community support is available through the
|
your requirement. see the [SUPPORT](SUPPORT.md) file for more details.
|
||||||
openssl-users email list (see
|
|
||||||
https://www.openssl.org/community/mailinglists.html for further details).
|
|
||||||
|
|
||||||
If you have any problems with OpenSSL then please take the following steps
|
Contributing
|
||||||
first:
|
============
|
||||||
|
|
||||||
- Download the latest version from the repository
|
If you are interested and willing to contribute to the OpenSSL project,
|
||||||
to see if the problem has already been addressed
|
please take a look at the [CONTRIBUTING](CONTRIBUTING.md) file.
|
||||||
- Configure with no-asm
|
|
||||||
- Remove compiler optimization flags
|
|
||||||
|
|
||||||
If you wish to report a bug then please include the following information
|
Since 2016, development takes place in public on the GitHub open source
|
||||||
and create an issue on GitHub:
|
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.
|
||||||
|
|
||||||
- OpenSSL version: output of 'openssl version -a'
|
|
||||||
- Configuration data: output of 'perl configdata.pm --dump'
|
|
||||||
- OS Name, Version, Hardware platform
|
|
||||||
- Compiler Details (name, version)
|
|
||||||
- Application Details (name, version)
|
|
||||||
- Problem Description (steps that will reproduce the problem, if known)
|
|
||||||
- Stack Traceback (if the application dumps core)
|
|
||||||
|
|
||||||
Just because something doesn't work the way you expect does not mean it
|
Legalities
|
||||||
is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
|
==========
|
||||||
of query.
|
|
||||||
|
|
||||||
How to contribute to OpenSSL
|
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
|
||||||
|
attempting to develop or distribute cryptographic code.
|
||||||
See [CONTRIBUTING](CONTRIBUTING.md)
|
|
||||||
|
|
||||||
Legalities
|
|
||||||
==========
|
|
||||||
|
|
||||||
A number of nations restrict the use or export of cryptography. If you
|
|
||||||
are potentially subject to such restrictions you should seek competent
|
|
||||||
professional legal advice before attempting to develop or distribute
|
|
||||||
cryptographic code.
|
|
||||||
|
|
||||||
|
|
||||||
Copyright
|
Copyright
|
||||||
=========
|
=========
|
||||||
|
|
||||||
Copyright (c) 1998-2018 The OpenSSL Project
|
Copyright (c) 1998-2020 The OpenSSL Project
|
||||||
|
|
||||||
Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
|
Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
|
||||||
|
|
||||||
All rights reserved.
|
All rights reserved.
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Links -->
|
||||||
|
|
||||||
|
[www.openssl.org]:
|
||||||
|
https://www.openssl.org
|
||||||
|
"OpenSSL Homepage"
|
||||||
|
|
||||||
|
[git.openssl.org]:
|
||||||
|
https://git.openssl.org
|
||||||
|
"OpenSSL Git Repository"
|
||||||
|
|
||||||
|
[git.openssl.org]:
|
||||||
|
https://git.openssl.org
|
||||||
|
"OpenSSL Git Repository"
|
||||||
|
|
||||||
|
[github.com/openssl/openssl]:
|
||||||
|
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"
|
||||||
|
|
||||||
|
|
||||||
|
[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"
|
||||||
|
|
||||||
|
[travis jobs]:
|
||||||
|
https://travis-ci.org/openssl/openssl
|
||||||
|
"Travis Jobs"
|
||||||
|
|
||||||
|
[appveyor badge]:
|
||||||
|
https://ci.appveyor.com/api/projects/status/ikn2l4u1xsume63u/branch/master?svg=true
|
||||||
|
"AppVeyor Build Status"
|
||||||
|
|
||||||
|
[appveyor jobs]:
|
||||||
|
https://ci.appveyor.com/project/openssl/openssl/branch/master
|
||||||
|
"AppVeyor Jobs"
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue