Commit fcd2d5a6 authored by Richard Levitte's avatar Richard Levitte
Browse files

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: default avatarTim Hudson <tjh@openssl.org>
Reviewed-by: default avatarMatthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/7724)
parent 0695b193

CHANGES

+9 −0
Original line number Diff line number Diff line
@@ -9,6 +9,15 @@ 














 Changes between 1.1.1 and 3.0.0 [xx XXX xxxx]



























  *) Change the possible version information given with OPENSSL_API_COMPAT.













     It may be a pre-3.0.0 style numerical version number as it was defined













     in 1.1.0, and it may also simply take the major version number.

























     Because of the version numbering of pre-3.0.0 releases, the values 0,













     1 and 2 are equivalent to 0x00908000L (0.9.8), 0x10000000L (1.0.0) and













     0x10100000L (1.1.0), respectively.













     [Richard Levitte]



























  *) Switch to a new version scheme using three numbers MAJOR.MINOR.PATCH.





























     o Major releases (indicated by incrementing the MAJOR release number)

































Configure



+13
−12






























Original line number
Diff line number
Diff line








@@ -43,9 +43,9 @@ my $usage="Usage: Configure [no-<cipher> ...] [enable-<cipher> ...] [-Dxxx] [-lx













#















# --cross-compile-prefix Add specified prefix to binutils components.















#













# --api         One of 0.9.8, 1.0.0, 1.1.0 or 3.0.0 (or 3).  Do not compile













#               support for interfaces deprecated as of the specified OpenSSL













#               version.













# --api         One of 0.9.8, 1.0.0, 1.0.1, 1.0.2, 1.1.0, 1.1.1, or 3.0.0 / 3.













#               Do not compile support for interfaces deprecated as of the













#               specified OpenSSL version.















#















# no-hw-xxx     do not compile support for specific crypto hardware.















#               Generic OpenSSL-style methods relating to this support










@@ -176,10 +176,13 @@ our $BSDthreads="-pthread -D_THREAD_SAFE -D_REENTRANT";













#















my $maxapi = "3.0.0";           # API for "no-deprecated" builds















my $apitable = {













    "3.0.0" => "0x30000000L",













    "1.1.0" => "0x10100000L",













    "1.0.0" => "0x10000000L",













    "0.9.8" => "0x00908000L",













    "3.0.0" => 3,













    "1.1.1" => 2,













    "1.1.0" => 2,













    "1.0.2" => 1,













    "1.0.1" => 1,













    "1.0.0" => 1,













    "0.9.8" => 0,















};































our %table = ();










@@ -1495,11 +1498,9 @@ $config{cflags} = [ map { (my $x = $_) =~ s/([\\\"])/\\$1/g; $x }













$config{cxxflags} = [ map { (my $x = $_) =~ s/([\\\"])/\\$1/g; $x }















                          @{$config{cxxflags}} ] if $config{CXX};





























if (defined($config{api})) {













    $config{openssl_api_defines} = [ "OPENSSL_MIN_API=".$apitable->{$config{api}} ];













    my $apiflag = sprintf("OPENSSL_API_COMPAT=%s", $apitable->{$config{api}});













    push @{$config{defines}}, $apiflag;













}













$config{openssl_api_defines} = [













    "OPENSSL_MIN_API=".($apitable->{$config{api} // ""} // -1)













];































if ($strict_warnings)















	{

































crypto/asn1/asn1_item_list.h



+2
−2






























Original line number
Diff line number
Diff line








@@ -78,7 +78,7 @@ static ASN1_ITEM_EXP *asn1_item_list[] = {













    ASN1_ITEM_ref(IPAddressRange),















#endif















    ASN1_ITEM_ref(ISSUING_DIST_POINT),













#if OPENSSL_API_COMPAT < 0x30000000L













#if !OPENSSL_API_3















    ASN1_ITEM_ref(LONG),















#endif















    ASN1_ITEM_ref(NAME_CONSTRAINTS),










@@ -164,7 +164,7 @@ static ASN1_ITEM_EXP *asn1_item_list[] = {













    ASN1_ITEM_ref(X509_SIG),















    ASN1_ITEM_ref(X509_VAL),















    ASN1_ITEM_ref(X509),













#if OPENSSL_API_COMPAT < 0x30000000L













#if !OPENSSL_API_3















    ASN1_ITEM_ref(ZLONG),















#endif















    ASN1_ITEM_ref(INT32),

































crypto/asn1/asn1_lib.c



+1
−1






























Original line number
Diff line number
Diff line








@@ -383,7 +383,7 @@ const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING *x)













    return x->data;















}





























# if OPENSSL_API_COMPAT < 0x10100000L













# if !OPENSSL_API_1_1_0















unsigned char *ASN1_STRING_data(ASN1_STRING *x)















{















    return x->data;

































crypto/asn1/x_long.c



+1
−1






























Original line number
Diff line number
Diff line








@@ -11,7 +11,7 @@













#include "internal/cryptlib.h"















#include <openssl/asn1t.h>





























#if !(OPENSSL_API_COMPAT < 0x30000000L)













#if OPENSSL_API_3















NON_EMPTY_TRANSLATION_UNIT















#else