Go to file
Richard Levitte 46994f7163 Add better support for using deprecated symbols internally
OPENSSL_SUPPRESS_DEPRECATED only does half the job, in telling the
deprecation macros not to add the warning attribute.  However, with
'no-deprecated', the symbols are still removed entirely, while we
might still want to use them internally.

The solution is to permit <openssl/opensslconf.h> macros to be
modified internally, such as undefining OPENSSL_NO_DEPRECATED in this
case.

However, with the way <openssl/opensslconf.h> includes
<openssl/macros.h>, that's easier said than done.  That's solved by
generating <openssl/configuration.h> instead, and add a new
<openssl/opensslconf.h> that includes <openssl/configuration.h> as
well as <openssl/macros.h>, thus allowing to replace an inclusion of
<openssl/opensslconf.h> with this:

    #include <openssl/configuration.h>

    #undef OPENSSL_NO_DEPRECATED
    #define OPENSSL_SUPPRESS_DEPRECATED

    #include <openssl/macros.h>

Or simply add the following prior to any other openssl inclusion:

    #include <openssl/configuration.h>

    #undef OPENSSL_NO_DEPRECATED
    #define OPENSSL_SUPPRESS_DEPRECATED

Note that undefining OPENSSL_NO_DEPRECATED must never be done by
applications, since the symbols must still be exported by the
library.  Internal test programs are excempt of this rule, though.

Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/10608)
2019-12-13 10:09:49 +01:00
.github Add a GitHub issue template for documentation issues 2019-10-30 17:46:00 +01:00
apps Check return value after loading config file 2019-12-13 13:39:31 +10:00
boringssl@2070f8ad91 Update ossl_config.json for later BoringSSL commit 2017-03-14 12:12:13 +00:00
Configurations Fix some typos 2019-12-11 19:04:01 +01:00
crypto chunk 6 of CMP contribution to OpenSSL 2019-12-12 10:57:25 +00:00
demos Remove RANDFILE settings from configuration files 2019-11-24 08:35:14 +01:00
doc Various missing-link fixes 2019-12-12 16:55:02 +01:00
engines Update source files for deprecation at 3.0 2019-11-07 11:37:25 +01:00
external/perl Update the bundled external perl module Text-Template to version 1.56 2019-09-12 12:53:32 +02:00
fuzz Add support for otherName:NAIRealm in output 2019-12-11 22:29:19 +03:00
include Add better support for using deprecated symbols internally 2019-12-13 10:09:49 +01:00
krb5@b9ad6c4950 [extended tests] Enable krb5 tests in Travis 2017-04-18 19:10:25 +02:00
ms Unify all assembler file generators 2019-09-16 16:29:57 +02:00
os-dep Move Haiku configuration to separate config file to denote 2016-05-19 22:39:52 +02:00
providers mac poly1305: add missing NULL check in new function. 2019-12-13 10:31:28 +10:00
pyca-cryptography@09403100de Update the pyca-cryptography submodule 2018-09-10 12:04:03 +01:00
ssl Fix some typos 2019-12-11 19:04:01 +01:00
test test/namemap_internal_test.c: use "cookie" instead of "foo"... 2019-12-13 10:03:57 +01:00
tools Following the license change, modify the boilerplates in util/, tools/ 2018-12-06 14:17:23 +01:00
util Various missing-link fixes 2019-12-12 16:55:02 +01: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 better support for using deprecated symbols internally 2019-12-13 10:09:49 +01: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 Enrich arm64 tests in Travis matrix 2019-12-11 19:24:19 +01:00
ACKNOWLEDGEMENTS Refer to website for acknowledgements. 2015-12-08 16:07:09 -05:00
appveyor.yml Configure: Make --strict-warnings meaningful with MSVC cl 2019-11-02 11:00:13 +01:00
AUTHORS Update AUTHORS list, add commentary 2018-07-08 20:32:04 -04:00
build.info Add better support for using deprecated symbols internally 2019-12-13 10:09:49 +01:00
CHANGES Add better support for using deprecated symbols internally 2019-12-13 10:09:49 +01:00
config iOS build: Replace %20 with space in config script 2019-07-08 10:55:57 +02:00
config.com Following the license change, modify the boilerplates in last few 2018-12-06 15:40:33 +01:00
configdata.pm.in configdata.pm.in: Don't try to quotify undefined values 2019-12-04 00:19:40 +01:00
Configure Configure: use ELFv2 ABI on some ppc64 big endian systems 2019-12-11 18:31:33 +01:00
CONTRIBUTING Add a note in the contributing file about trivial commits. 2019-06-27 23:23:17 +10:00
e_os.h Move random-related defines from e_os.h to rand_unix.c 2019-10-19 00:04:27 +02:00
FAQ Move FAQ to the web. 2015-08-16 19:02:29 -04:00
HACKING A very brief explanation of how to add custom functions to OpenSSL. 2019-07-08 20:09:13 +10:00
INSTALL Add better support for using deprecated symbols internally 2019-12-13 10:09:49 +01:00
LICENSE Change license to the Apache License v2.0 2018-12-06 13:27:18 +01:00
NEWS Add NEWS and CHANGES entries about OSSL_SERIALIZER 2019-11-29 20:55:16 +01:00
NOTES.ANDROID Remove spurious space from file. 2019-12-05 07:25:52 +10: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 Remove the version number in README 2019-10-18 12:22:00 +02: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
VERSION Configure: get version from the file 'VERSION' instead of 'opensslv.h' 2019-10-18 12:22:00 +02:00

 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.