Go to file
Randall S. Becker 05ba94e705 Add explicit support in util/shlib_wrap.sh.in for NonStop DLL loading.
The NonStop platform uses a proprietary mechanism for specifying DLL
locations.

CLA: Permission is granted by the author to the OpenSSL team to use these modifications.

Fixes #14666

Signed-off-by: Randall S. Becker <rsbecker@nexbridge.com>

Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14669)
2021-03-30 19:08:32 +02:00
.github Remove the external BoringSSL test 2021-03-26 14:24:06 +01:00
Configurations Android config targets: don't include the SO version in the shlib file name 2021-03-30 15:14:55 +02:00
VMS VMS documentation fixes 2021-02-12 15:57:25 +01:00
apps apps: fix coverity 1474463, 1474465 & 1474467: resource leaks 2021-03-30 18:57:30 +02:00
crypto Increase minimum clang version requirement for rsaz-avx512.pl 2021-03-30 19:05:35 +02:00
demos Update the demos/README file because it is really old. New demos should provide best practice for API use. 2021-03-06 10:13:16 +01:00
dev Update copyright year 2021-02-18 15:05:17 +00:00
doc Fix typos in bio.pod 2021-03-30 19:01:52 +02:00
engines Update copyright year 2021-03-11 13:27:36 +00:00
external/perl Update the bundled external perl module Text-Template to version 1.56 2019-09-12 12:53:32 +02:00
fuzz Update copyright year 2021-03-11 13:27:36 +00:00
gost-engine@28a0a19354 CI: add job with external tests 2021-03-05 14:27:46 +01:00
include Fix typo in bio.h.in 2021-03-29 12:59:44 +10:00
krb5@890ca2f401 Update the krb5 submodule 2019-12-25 12:45:32 -08:00
ms Unify all assembler file generators 2019-09-16 16:29:57 +02:00
os-dep
providers Fix DH gettable OSSL_PKEY_PARAM_DH_PRIV_LEN so that it has the correct 2021-03-30 09:45:07 +10:00
pyca-cryptography@e09cd90f77 CI: add job with external tests 2021-03-05 14:27:46 +01:00
ssl ssl: fix problem where MAC IDs were globally cached. 2021-03-30 18:59:42 +02:00
test test: fix coverity 1474468: resource leak 2021-03-30 18:57:30 +02:00
tools Update copyright year 2021-03-11 13:27:36 +00:00
util Add explicit support in util/shlib_wrap.sh.in for NonStop DLL loading. 2021-03-30 19:08:32 +02:00
.gitattributes Remove the external BoringSSL test 2021-03-26 14:24:06 +01:00
.gitignore Fix some missed usage of DEFINE_LHASH_OF() 2020-10-30 14:24:30 +00:00
.gitmodules Remove the external BoringSSL test 2021-03-26 14:24:06 +01:00
.travis-apt-pin.preferences
.travis-create-release.sh Remove all 'make dist' artifacts 2018-11-23 12:40:32 +01:00
ACKNOWLEDGEMENTS.md Fix issues reported by markdownlint 2020-05-08 16:22:02 +02:00
AUTHORS.md Add some missing committers to the AUTHORS list 2021-02-02 16:45:44 +01:00
CHANGES.md Update CHANGES.md and NEWS.md for new release 2021-03-25 13:12:42 +00:00
CONTRIBUTING.md Drop Travis 2021-01-25 13:41:23 +01:00
Configure Disable fips-securitychecks if no-fips is configured. 2021-03-23 16:19:44 +00: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 Moved build instructions from the man page 2021-03-29 15:09:58 +02:00
LICENSE.txt Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt 2020-07-05 11:29:43 +02:00
NEWS.md Update CHANGES.md and NEWS.md for new release 2021-03-25 13:12:42 +00: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 Rewrite the HPE NonStop Notes file in Markdown with more explanations. 2020-10-28 17:18:26 +01:00
NOTES-PERL.md Reformat some NOTES and README files 2021-02-12 20:41:27 +01:00
NOTES-UNIX.md Unify the markdown links to the NOTES and README files 2021-02-12 20:41:32 +01: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 Reformat some NOTES and README files 2021-02-12 20:41:27 +01:00
NOTES-WINDOWS.md NOTES-WINDOWS: fix typo 2021-02-12 20:41:58 +01: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 Update README-FIPS.md 2021-03-19 13:44:32 +10:00
README-PROVIDERS.md Add a skeleton README-PROVIDERS file 2021-02-12 20:41:58 +01: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.0 alpha 14 2021-03-11 13:47:21 +00:00
appveyor.yml appveyor.yml: clarify conditions for building the plain configuration 2021-02-23 19:08:39 +01:00
build.info Configuration: ensure that 'no-tests' works correctly 2021-02-09 17:05:06 +10: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.in, util/dofile.pl: Make a HERE document stricter. 2020-10-27 10:17:19 +01:00
e_os.h Implement OpenSSL secure memory for Windows 2020-10-22 12:11:35 +10:00

README.md

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.