mirror of https://github.com/openssl/openssl.git synced 2024-11-27 05:21:51 +08:00

Go to file

Simo Sorce 96e678087d Allow to pass a passprase callback at store open Some PKCS11 modules require authentication early on to be able to preload objects, which we want to do to avoid costly roundtrips when the HSM is actually reached over a network (Cloud HSM). Unfortunately at open time we can't interact with the user becaue the callbacks are only passed at object load time. later on. This patch corrects this issue by providing a more feature rich open call for providers. Signed-off-by: Simo Sorce <simo@redhat.com> Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20131)		2023-09-19 12:24:07 +02:00
.ctags.d
.github	coveralls.yml: Improve coverage mapping and remove 1.1.1	2023-09-17 22:13:16 +10:00
apps	APPS: remove duplicate definition of `trace_data_stack`	2023-09-18 09:06:47 +10:00
cloudflare-quiche@7ab6a55cfe
Configurations	Regexp modifier "r" needs perl 5.14; OpenSSL should build with 5.11, so do not use the "r" shortcut.	2023-09-11 07:45:38 +10:00
crypto	Allow to pass a passprase callback at store open	2023-09-19 12:24:07 +02:00
demos	Bad function definition	2023-09-11 10:15:30 +02:00
dev
doc	Fix new typos found by codespell	2023-09-18 09:04:22 +10:00
engines	"foo * bar" should be "foo *bar"	2023-09-11 10:15:30 +02:00
external/perl
fuzz	Copyright year updates	2023-09-07 09:59:15 +01:00
gost-engine@2a8a5e0eca
include	Allow to pass a passprase callback at store open	2023-09-19 12:24:07 +02:00
krb5@aa9b4a2a64
ms	Copyright year updates	2023-09-07 09:59:15 +01:00
oqs-provider@8c746d7e29
os-dep
providers	Fix new typos found by codespell	2023-09-18 09:04:22 +10:00
pyca-cryptography@7e33b0e773
python-ecdsa@4de8d5bf89
ssl	Enhance code safety and readability in SSL_get_shared_ciphers()	2023-09-18 14:10:17 +02:00
test	Postponed further context duplication support for ciphers	2023-09-19 14:37:17 +10:00
tlsfuzzer@dbd56c1490
tlslite-ng@771e9f59d6
tools
util	Store: API for deletion - make update	2023-09-15 10:18:36 +02:00
VMS
wycheproof@2196000605
.gitattributes
.gitignore
.gitmodules
ACKNOWLEDGEMENTS.md
AUTHORS.md
build.info
CHANGES.md	Add CVE-2023-4807 fix to CHANGES.md and NEWS.md	2023-09-11 10:55:51 +02:00
CODE-OF-CONDUCT.md
config
config.com
configdata.pm.in
Configure	Copyright year updates	2023-09-07 09:59:15 +01:00
CONTRIBUTING.md
FAQ.md
HACKING.md
INSTALL.md
LICENSE.txt
NEWS.md	Fix new typos found by codespell	2023-09-18 09:04:22 +10:00
NOTES-ANDROID.md
NOTES-DJGPP.md
NOTES-NONSTOP.md
NOTES-PERL.md
NOTES-UNIX.md
NOTES-VALGRIND.md
NOTES-VMS.md
NOTES-WINDOWS.md
README-ENGINES.md
README-FIPS.md
README-PROVIDERS.md
README.md
SUPPORT.md
VERSION.dat	Prepare for 3.2 alpha 2	2023-09-07 10:00:46 +01:00

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.

Specific notes on upgrading to OpenSSL 3.0 from previous versions can be found in the ossl-guide-migration(7ossl) manual 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.