TLS/SSL and crypto library
Find a file
Richard Levitte 6ebc2f56f0 Replumbing: re-implement error reporting for providers
The idea is that providers should only have to report a reason code.
The library code is considered to be libcrypto internal, and are
allocated dynamically and automatically for providers on creation.

We reserve the upper 8 bits of the reason code for internal OpenSSL
use.  This allows our own providers to report errors in form of a
packed number that includes library number, function number and
reason number.

With this, a provider can potentially use any reason number it wants
from 1 to 16777216, although the current error semantics really only
allow 1 to 4095 (because only the lower 12 bits are currently
considered an actual reason code by the ERR subsystem).

A provider can provide a reason string table in form of an array of
ERR_STRING_DATA, with each item containing just the reason code and
the associated string, with the dispatch function numbered
OSSL_FUNC_PROVIDER_GET_REASON_STRINGS matching the type
OSSL_provider_get_reason_strings_fn.
If available, libcrypto will call that function on provider
activation.

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9174)
2019-07-02 17:02:02 +02:00
.github Remove markdown links from HTML comments in issue templates 2018-11-13 17:01:41 +01:00
apps Fix Typos 2019-07-02 14:22:29 +02:00
boringssl@2070f8ad91 Update ossl_config.json for later BoringSSL commit 2017-03-14 12:12:13 +00:00
Configurations Fix Typos 2019-07-02 14:22:29 +02:00
crypto Replumbing: re-implement error reporting for providers 2019-07-02 17:02:02 +02:00
demos Fix Typos 2019-07-02 14:22:29 +02:00
doc ossl_provider_upref to ossl_provider_up_ref 2019-07-02 16:30:56 +02:00
engines Fix Typos 2019-07-02 14:22:29 +02:00
external/perl Following the license change, modify the boilerplates in external/ 2018-12-06 15:39:02 +01:00
fuzz Add OIDs for kmac128, kmac256 and blake2. 2019-07-01 17:41:31 +10:00
include Replumbing: re-implement error reporting for providers 2019-07-02 17:02:02 +02:00
krb5@b9ad6c4950 [extended tests] Enable krb5 tests in Travis 2017-04-18 19:10:25 +02:00
ms Windows: Call TerminateProcess, not ExitProcess 2019-02-22 21:03:45 +01:00
os-dep Move Haiku configuration to separate config file to denote 2016-05-19 22:39:52 +02:00
providers Add a nid 2 algorithm name mapping capability 2019-06-28 10:22:21 +01:00
pyca-cryptography@09403100de Update the pyca-cryptography submodule 2018-09-10 12:04:03 +01:00
ssl Move 'shared_sigalgs' from cert_st to ssl_st 2019-06-26 12:20:55 -05:00
test Fix Typos 2019-07-02 14:22:29 +02:00
tools Following the license change, modify the boilerplates in util/, tools/ 2018-12-06 14:17:23 +01:00
util Fix Typos 2019-07-02 14:22:29 +02:00
VMS Following the license change, modify the boilerplates in last few 2018-12-06 15:40:33 +01:00
.gitattributes Don't export the submodules 'boringssl', 'krb5' and 'pyca-cryptography' 2018-11-24 18:40:31 +01:00
.gitignore Add test for the provider configuration module 2019-04-03 11:42:48 +02:00
.gitmodules [extended tests] Enable krb5 tests in Travis 2017-04-18 19:10:25 +02:00
.travis-apt-pin.preferences Fix travis clang-3.9 builds 2017-06-23 17:57:02 +01:00
.travis-create-release.sh Remove all 'make dist' artifacts 2018-11-23 12:40:32 +01:00
.travis.yml Update to xenial 2019-03-16 15:53:39 +01:00
ACKNOWLEDGEMENTS Refer to website for acknowledgements. 2015-12-08 16:07:09 -05:00
appveyor.yml CI config: no need to make both install and install_docs 2018-05-14 17:51:48 +02:00
AUTHORS Update AUTHORS list, add commentary 2018-07-08 20:32:04 -04:00
build.info Move where include path for providers/common/include gets specified 2019-05-23 11:02:04 +01:00
CHANGES Fix Typos 2019-07-02 14:22:29 +02:00
config Remove NextStep support 2019-07-01 13:32:46 -04:00
config.com Following the license change, modify the boilerplates in last few 2018-12-06 15:40:33 +01:00
Configure Remove EXPORT_VAR_AS_FUNC 2019-07-01 20:13:03 -04:00
CONTRIBUTING Add a note in the contributing file about trivial commits. 2019-06-27 23:23:17 +10:00
e_os.h Remove NextStep support 2019-07-01 13:32:46 -04:00
FAQ Move FAQ to the web. 2015-08-16 19:02:29 -04:00
INSTALL Improve the Windows OneCore target support. (Add targets for building libraries for Windows Store apps.) 2019-06-10 10:22:36 +01:00
LICENSE Change license to the Apache License v2.0 2018-12-06 13:27:18 +01:00
NEWS Fix Typos 2019-07-01 10:09:22 +02:00
NOTES.ANDROID Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
NOTES.DJGPP Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
NOTES.PERL Fix typo in NOTES.PERL 2019-05-16 11:46:59 +10:00
NOTES.UNIX NOTES.UNIX: add "Linking your application" paragraph 2018-06-26 12:28:06 +02:00
NOTES.VALGRIND Add documentation for running unit tests under Valgrind 2019-05-03 17:46:28 +02:00
NOTES.VMS Remove unnecessary trailing whitespace 2019-02-05 16:25:11 +01:00
NOTES.WIN Configure: final cleanup of asm related things 2019-06-17 16:08:53 +02:00
README Change license to the Apache License v2.0 2018-12-06 13:27:18 +01:00
README.ENGINE Remove bsd_cryptodev engine 2017-06-19 09:31:45 -04:00
README.FIPS Remove more (rest?) of FIPS build stuff. 2016-01-06 12:07:26 -05:00

 OpenSSL 3.0.0-dev

 Copyright (c) 1998-2018 The OpenSSL Project
 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
 All rights reserved.

 DESCRIPTION
 -----------

 The OpenSSL Project is a collaborative effort to develop a robust,
 commercial-grade, fully featured, and Open Source toolkit implementing the
 Transport Layer Security (TLS) protocols (including SSLv3) as well as a
 full-strength general purpose cryptographic library.

 OpenSSL is descended from the SSLeay library developed by Eric A. Young
 and Tim J. Hudson.

 The OpenSSL toolkit 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.

 OVERVIEW
 --------

 The OpenSSL toolkit includes:

 libssl (with platform specific naming):
     Provides the client and server-side implementations for SSLv3 and TLS.

 libcrypto (with platform specific naming):
     Provides general cryptographic and X.509 support needed by SSL/TLS but
     not logically part of it.

 openssl:
     A command line tool that 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...

 INSTALLATION
 ------------

 See the appropriate file:
        INSTALL         Linux, Unix, Windows, OpenVMS, ...
        NOTES.*         INSTALL addendums for different platforms

 SUPPORT
 -------

 See the OpenSSL website www.openssl.org for details on how to obtain
 commercial technical support. Free community support is available through the
 openssl-users email list (see
 https://www.openssl.org/community/mailinglists.html for further details).

 If you have any problems with OpenSSL then please take the following steps
 first:

    - Download the latest version from the repository
      to see if the problem has already been addressed
    - Configure with no-asm
    - Remove compiler optimization flags

 If you wish to report a bug then please include the following information
 and create an issue on GitHub:

    - OpenSSL version: output of 'openssl version -a'
    - Configuration data: output of 'perl configdata.pm --dump'
    - OS Name, Version, Hardware platform
    - Compiler Details (name, version)
    - Application Details (name, version)
    - Problem Description (steps that will reproduce the problem, if known)
    - Stack Traceback (if the application dumps core)

 Just because something doesn't work the way you expect does not mean it
 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
 of query.

 HOW TO CONTRIBUTE TO OpenSSL
 ----------------------------

 See CONTRIBUTING

 LEGALITIES
 ----------

 A number of nations restrict the use or export of cryptography. If you
 are potentially subject to such restrictions you should seek competent
 professional legal advice before attempting to develop or distribute
 cryptographic code.