Go to file
Richard Levitte fcd2d5a612 Refactor the computation of API version limits
Previously, the API version limit was indicated with a numeric version
number.  This was "natural" in the pre-3.0.0 because the version was
this simple number.

With 3.0.0, the version is divided into three separate numbers, and
it's only the major number that counts, but we still need to be able
to support pre-3.0.0 version limits.

Therefore, we allow OPENSSL_API_COMPAT to be defined with a pre-3.0.0
style numeric version number or with a simple major number, i.e. can
be defined like this for any application:

    -D OPENSSL_API_COMPAT=0x10100000L
    -D OPENSSL_API_COMPAT=3

Since the pre-3.0.0 numerical version numbers are high, it's easy to
distinguish between a simple major number and a pre-3.0.0 numerical
version number and to thereby support both forms at the same time.

Internally, we define the following macros depending on the value of
OPENSSL_API_COMPAT:

    OPENSSL_API_0_9_8
    OPENSSL_API_1_0_0
    OPENSSL_API_1_1_0
    OPENSSL_API_3

They indicate that functions marked for deprecation in the
corresponding major release shall not be built if defined.

Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/7724)
2018-12-06 12:24:48 +01:00
.github Remove markdown links from HTML comments in issue templates 2018-11-13 17:01:41 +01:00
Configurations Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-dev 2018-12-06 12:24:47 +01:00
VMS Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-dev 2018-12-06 12:24:47 +01:00
apps Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-dev 2018-12-06 12:24:47 +01:00
boringssl@2070f8ad91
crypto Refactor the computation of API version limits 2018-12-06 12:24:48 +01:00
demos Remove outdated e_chil.txt file 2018-11-06 22:23:37 -05:00
doc Refactor the computation of API version limits 2018-12-06 12:24:48 +01:00
engines Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-dev 2018-12-06 12:24:47 +01:00
external/perl Update copyright year 2018-09-11 13:45:17 +01:00
fuzz Refactor the computation of API version limits 2018-12-06 12:24:48 +01:00
include Refactor the computation of API version limits 2018-12-06 12:24:48 +01:00
krb5@b9ad6c4950
ms
os-dep
pyca-cryptography@09403100de Update the pyca-cryptography submodule 2018-09-10 12:04:03 +01:00
ssl Refactor the computation of API version limits 2018-12-06 12:24:48 +01:00
test Refactor the computation of API version limits 2018-12-06 12:24:48 +01:00
tools
util Refactor the computation of API version limits 2018-12-06 12:24:48 +01:00
.gitattributes Don't export the submodules 'boringssl', 'krb5' and 'pyca-cryptography' 2018-11-24 18:40:31 +01:00
.gitignore Ignore an auto-generated documentation file 2018-12-04 08:38:53 +00:00
.gitmodules
.travis-apt-pin.preferences
.travis-create-release.sh Remove all 'make dist' artifacts 2018-11-23 12:40:32 +01:00
.travis.yml Travis CI: Use flake8 to find Python syntax errors or undefined names 2018-11-20 19:02:12 +01:00
ACKNOWLEDGEMENTS
AUTHORS Update AUTHORS list, add commentary 2018-07-08 20:32:04 -04:00
CHANGES Refactor the computation of API version limits 2018-12-06 12:24:48 +01:00
CONTRIBUTING Add a note on CHANGES and NEWS in CONTRIBUTING 2018-05-17 13:51:11 +02:00
Configure Refactor the computation of API version limits 2018-12-06 12:24:48 +01:00
FAQ
INSTALL typo-fixes: miscellaneous typo fixes 2018-09-21 23:55:22 +02:00
LICENSE
NEWS Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-dev 2018-12-06 12:24:47 +01:00
NOTES.ANDROID Configurations/15-android.conf: add support for "standalone toolchain". 2018-10-19 10:35:36 +02:00
NOTES.DJGPP
NOTES.PERL
NOTES.UNIX NOTES.UNIX: add "Linking your application" paragraph 2018-06-26 12:28:06 +02:00
NOTES.VMS
NOTES.WIN INSTALL,NOTES.WIN: classify no-asm as non-production option. 2018-07-25 15:47:12 +02:00
README Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-dev 2018-12-06 12:24:47 +01:00
README.ENGINE
README.FIPS
appveyor.yml CI config: no need to make both install and install_docs 2018-05-14 17:51:48 +02:00
build.info Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-dev 2018-12-06 12:24:47 +01:00
config
config.com
e_os.h test/secmemtest: test secure memory only if it is implemented 2018-10-05 12:19:48 +02:00

README

 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 a dual-license (the
 OpenSSL license plus the SSLeay license), which means that you are free to
 get and use it for commercial and non-commercial purposes as long as you
 fulfill the conditions of both licenses.

 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.