mirror of https://github.com/openssl/openssl.git synced 2024-12-15 06:01:37 +08:00

Go to file

Richard Levitte b16654a281 config, Configure: move the check of removed crypto/ sub-systems The 'config' script checked for a bunch of crypto/ sub-system directories, and added 'no-' options if they weren't there. We move it to 'Configure' in an effort to simplify 'config' for further work. Note: this is pretty much a historical thing. In modern OpenSSL, it's much simpler to edit the SUBDIRS statement in crypto/build.info. However, it's been claimed the there are those who still remove some of these sub-system sources. Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/11217)		2020-03-04 17:12:52 +01:00
.github
apps	Implementation of Russian GOST CMS	2020-03-03 16:34:40 +03:00
boringssl@2070f8ad91
Configurations	Build: Generate apps/progs.c and apps/progs.h in build time	2020-03-02 03:34:30 +01:00
crypto	Add Serializers for EC	2020-03-04 07:48:45 +10:00
demos
doc	Add some missing env var documentation	2020-03-04 11:41:50 +01:00
engines
external/perl
fuzz
include	Implementation of Russian GOST CMS	2020-03-03 16:34:40 +03:00
krb5@890ca2f401
ms
os-dep
providers	Add Serializers for EC	2020-03-04 07:48:45 +10:00
pyca-cryptography@09403100de
ssl
test	Add Serializers for EC	2020-03-04 07:48:45 +10:00
tools
util	Documenting newly added CMS modification	2020-03-03 16:34:40 +03:00
VMS
.gitattributes
.gitignore	.gitignore: Add /apps/progs.{c,h}	2020-03-04 10:18:56 +10:00
.gitmodules
.travis-apt-pin.preferences
.travis-create-release.sh
.travis.yml	.travis.yml: where it matters, have build and source nesting levels differ	2020-03-04 12:55:57 +01:00
ACKNOWLEDGEMENTS.md	doc: introduce some minimalistic markdown without essential changes	2020-02-26 21:04:38 +01:00
appveyor.yml
AUTHORS.md	doc: introduce some minimalistic markdown without essential changes	2020-02-26 21:04:38 +01:00
build.info
CHANGES.md	Deprecate ASN1_sign(), ASN1_verify() and ASN1_digest()	2020-02-27 23:21:14 +01:00
config	config, Configure: move the check of removed crypto/ sub-systems	2020-03-04 17:12:52 +01:00
config.com
configdata.pm.in
Configure	config, Configure: move the check of removed crypto/ sub-systems	2020-03-04 17:12:52 +01:00
CONTRIBUTING.md	doc: introduce some minimalistic markdown without essential changes	2020-02-26 21:04:38 +01:00
e_os.h
FAQ.md	doc: introduce some minimalistic markdown without essential changes	2020-02-26 21:04:38 +01:00
HACKING
INSTALL.md	Replace util/shlib_wrap.sh with util/wrap.pl in diverse docs	2020-02-27 08:49:14 +01:00
LICENSE
NEWS.md	doc: add missing NEWS entries for all versions >= 1.0.0	2020-02-26 21:06:17 +01:00
NOTES.ANDROID
NOTES.DJGPP
NOTES.PERL
NOTES.UNIX
NOTES.VALGRIND	Replace util/shlib_wrap.sh with util/wrap.pl in diverse docs	2020-02-27 08:49:14 +01:00
NOTES.VMS
NOTES.WIN
README.ENGINE
README.FIPS
README.md	doc: revamp the README file	2020-02-26 21:04:38 +01:00
SUPPORT.md	doc: revamp the SUPPORT file	2020-02-26 21:06:17 +01:00
VERSION

README.md

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 and Tim J. Hudson.

The official Home Page of the OpenSSL Project is www.openssl.org.

Overview
Download
Build and Install
Documentation
License
Support
Contributing
Legalities

Overview

The OpenSSL toolkit includes:

libssl an implementation of all TLS protocol versions up to TLSv1.3 (RFC 8446).
libcrypto a full-strength general purpose cryptographic library. It constitutes the basis of the TLS implementation, but can also be used independently.
openssl the OpenSSL command line tool, a swiss army knife for cryptographic tasks, testing and analyzing. It can be used for
- creation of key parameters
- creation of X.509 certificates, CSRs and CRLs
- calculation of message digests
- encryption and decryption
- SSL/TLS client and server tests
- handling of S/MIME signed or encrypted mail
- and more...

Download

For Production Use

Source code tarballs of the official releases can be downloaded from www.openssl.org/source. 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 precompiled shared libraries provided by the distributor or vendor.

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.

Build and Install

After obtaining the Source, have a look at the INSTALL file for detailed instructions about building and installing OpenSSL. For some platforms, the installation instructions are amended by a platform specific document.

Documentation

Manual Pages

The manual pages for the master branch and all current stable releases are available online.

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 file for more details.

Support

There are various ways to get in touch. The correct channel depends on your requirement. see the SUPPORT file for more details.

Contributing

If you are interested and willing to contribute to the OpenSSL project, please take a look at the CONTRIBUTING 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 attempting to develop or distribute cryptographic code.