Go to file
Richard Levitte e33b132a1a DOCS: Add internal docs for EVP_PKEY and the export functions
Functions covered:

- evp_pkey_export_to_provider()
- evp_pkey_upgrade_to_provider()

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/11148)
2020-02-29 05:39:43 +01:00
.github doc: convert standard project docs to markdown 2020-02-26 21:04:38 +01:00
apps apps x509: restrict CAkeyform option to OPT_FMT_PDE 2020-02-26 17:23:53 +01:00
boringssl@2070f8ad91
Configurations Build file templates: don't set OPENSSL_{ENGINES,MODULES} 2020-02-27 08:49:14 +01:00
crypto EVP: Add evp_pkey_upgrade_to_provider(), for EVP_PKEY upgrades 2020-02-29 05:39:43 +01:00
demos
doc DOCS: Add internal docs for EVP_PKEY and the export functions 2020-02-29 05:39:43 +01:00
engines Deprecate the low level RSA functions. 2020-02-20 18:58:40 +10:00
external/perl
fuzz Deprecate the low level Diffie-Hellman functions. 2020-02-20 19:04:57 +10:00
include EVP: Add evp_pkey_upgrade_to_provider(), for EVP_PKEY upgrades 2020-02-29 05:39:43 +01:00
krb5@890ca2f401
ms
os-dep
providers Implement the ECX Serializers 2020-02-28 08:08:59 +10:00
pyca-cryptography@09403100de
ssl Deprecate the low level Diffie-Hellman functions. 2020-02-20 19:04:57 +10:00
test EVP: Add evp_pkey_upgrade_to_provider(), for EVP_PKEY upgrades 2020-02-29 05:39:43 +01:00
tools
util x509v3 subjectSignTool extention support 2020-02-28 18:01:16 +03:00
VMS
.gitattributes
.gitignore Add *.d.tmp files to .gitignore 2020-02-20 16:58:19 +00:00
.gitmodules
.travis-apt-pin.preferences
.travis-create-release.sh
.travis.yml Avoid arm64 builds timeout due to silent make taking too long time 2020-02-26 16:47:22 +01:00
ACKNOWLEDGEMENTS.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
appveyor.yml Add a minimal build target for Travis and Appveyor 2020-02-11 13:22:39 +01:00
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: Drop linux-alpha-gcc+bwx 2020-02-25 11:21:59 +01:00
config.com
configdata.pm.in
Configure Make secure-memory be a config option 2020-02-14 15:18:27 +01:00
CONTRIBUTING.md doc: introduce some minimalistic markdown without essential changes 2020-02-26 21:04:38 +01:00
e_os.h Make secure-memory be a config option 2020-02-14 15:18:27 +01:00
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

openssl logo

travis badge appveyor badge

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.

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.

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.

Copyright

Copyright (c) 1998-2020 The OpenSSL Project

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

All rights reserved.