Go to file
Pauli 78de5a94d8 doc: document that property names are unique
Both queries and definitions only support each individual name appearing once.
It is an error to have a name appear more than once.

Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16716)
2021-10-09 23:29:13 +10:00
.github ci: add additional operating system specific builds 2021-09-27 08:40:38 +10:00
apps Bindhost/bindport should be freed 2021-10-09 10:31:34 +02:00
Configurations Update 15-ios.conf 2021-09-24 11:03:09 +02:00
crypto property: produce error if a name is duplicated 2021-10-09 23:29:13 +10:00
demos Add config_diagnostics to our configuration files. 2021-08-04 08:15:14 +10:00
dev Update copyright year 2021-09-07 13:35:43 +02:00
doc doc: document that property names are unique 2021-10-09 23:29:13 +10:00
engines Replace the AES-128-CBC-HMAC-SHA1 cipher in e_ossltest.c 2021-10-06 15:18:10 +02:00
external/perl Update the bundled external perl module Text-Template to version 1.56 2019-09-12 12:53:32 +02:00
fuzz obj: Add SM4 GCM/CCM OID 2021-10-05 12:47:37 +02:00
gost-engine@9869058423 Update gost-engine to match new default nameopt 2021-09-21 14:08:41 +02:00
include obj: Add SM4 GCM/CCM OID 2021-10-05 12:47:37 +02:00
krb5@aa9b4a2a64 Update dependencies for krb5 external test 2021-06-23 10:26:53 +02:00
ms Update copyright year 2021-04-22 14:38:44 +01:00
os-dep
providers providers: Add SM4 GCM implementation 2021-09-28 19:27:58 +10:00
pyca-cryptography@0034926f2c update pyca-cryptography regression test suite 2021-07-02 13:05:29 +10:00
ssl Replace the AES-128-CBC-HMAC-SHA1 cipher in e_ossltest.c 2021-10-06 15:18:10 +02:00
test test: add failure testing for property parsing 2021-10-09 23:29:13 +10:00
tools convert tabs to spaces in two distributed Perl scripts 2021-09-14 07:21:22 +10:00
util Fix util/mkpod2html.pl to call pod2html with absolute paths 2021-09-21 11:05:53 +02:00
VMS VMS documentation fixes 2021-02-12 15:57:25 +01:00
wycheproof@2196000605 add wycheproof submodule 2021-04-27 19:09:03 +10:00
.gitattributes Remove the external BoringSSL test 2021-03-26 14:24:06 +01:00
.gitignore Add wrap.pl to .gitignore 2021-06-26 11:39:10 +10:00
.gitmodules add wycheproof submodule 2021-04-27 19:09:03 +10:00
ACKNOWLEDGEMENTS.md always use the same perl in $PATH 2021-09-02 12:55:39 +10:00
appveyor.yml Simplify AppVeyor configuration 2021-05-01 13:13:11 +10:00
AUTHORS.md Add some missing committers to the AUTHORS list 2021-02-02 16:45:44 +01:00
build.info Building: Add necessary dependencies for linker scripts and .rc files 2021-06-11 17:22:44 +02:00
CHANGES.md Allow cipher strings to be given using its standard name 2021-09-30 12:20:01 +02:00
config config: Turn into a simple wrapper 2020-06-28 18:34:36 +02:00
config.com Update copyright year 2020-07-16 14:47:04 +02:00
configdata.pm.in configdata.pm: Allow extra arguments when --query is given. 2021-05-29 11:02:37 +02:00
Configure Replace CONFIG_NOWAIT env var with -w option 2021-08-20 10:32:35 +10:00
CONTRIBUTING.md Drop Travis 2021-01-25 13:41:23 +01:00
e_os.h Remove I_CAN_LIVE_WITH_LNK4049 2021-06-09 18:01:22 +10:00
FAQ.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
HACKING.md Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files 2020-07-05 11:29:43 +02:00
INSTALL.md Use '[option...]' not '[[ options ]]' in text 2021-09-07 15:23:59 +02:00
LICENSE.txt Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt 2020-07-05 11:29:43 +02:00
NEWS.md NEWS and CHANGES are updated about switching to utf8 2021-09-21 14:08:41 +02:00
NOTES-ANDROID.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +01:00
NOTES-DJGPP.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +01:00
NOTES-NONSTOP.md Add multilib to the NonStop configuration definitions. 2021-08-25 16:51:47 +02:00
NOTES-PERL.md Fix issues found by md-nits 2021-05-28 11:14:46 +02:00
NOTES-UNIX.md Add a clarification to NOTES-UNIX.md 2021-08-23 15:19:31 +02:00
NOTES-VALGRIND.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +01:00
NOTES-VMS.md Fix issues found by md-nits 2021-05-28 11:14:46 +02:00
NOTES-WINDOWS.md Fix issues found by md-nits 2021-05-28 11:14:46 +02:00
README-ENGINES.md README-ENGINES: fix the link to the provider API README 2021-02-15 19:33:53 +01:00
README-FIPS.md Add migration guide for 3.0 2021-05-20 08:44:08 +01:00
README-PROVIDERS.md Fix issues found by md-nits 2021-05-28 11:14:46 +02:00
README.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +01:00
SUPPORT.md Fix SUPPORT.md for better readability 2020-11-14 16:42:41 +01:00
VERSION.dat Prepare for 3.1 2021-09-03 11:01:55 +02:00

Welcome to the OpenSSL Project

openssl logo

github actions ci badge appveyor badge

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.

Table of Contents

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.

Specific notes on upgrading to OpenSSL 3.0 from previous versions, as well as known issues are available on the OpenSSL 3.0 Wiki page.

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.txt 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.

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.

Copyright

Copyright (c) 1998-2021 The OpenSSL Project

Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson

All rights reserved.