OPENSSL_VERSION_NUMBER.pod 2.8 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4
=pod

=head1 NAME

5
OPENSSL_VERSION_NUMBER, OPENSSL_VERSION_TEXT, OpenSSL_version,
R
Rich Salz 已提交
6
OpenSSL_version_num - get OpenSSL version number
U
Ulf Möller 已提交
7 8 9 10 11

=head1 SYNOPSIS

 #include <openssl/opensslv.h>
 #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
12
 #define OPENSSL_VERSION_TEXT "OpenSSL x.y.z xx XXX xxxx"
U
Ulf Möller 已提交
13 14

 #include <openssl/crypto.h>
R
Rich Salz 已提交
15 16

 unsigned long OpenSSL_version_num();
R
Rich Salz 已提交
17
 const char *OpenSSL_version(int t);
U
Ulf Möller 已提交
18 19 20 21 22

=head1 DESCRIPTION

OPENSSL_VERSION_NUMBER is a numeric release version identifier:

23
 MNNFFPPS: major minor fix patch status
24 25 26 27 28 29 30 31 32 33 34 35 36 37

The status nibble has one of the values 0 for development, 1 to e for betas
1 to 14, and f for release.

for example

 0x000906000 == 0.9.6 dev
 0x000906023 == 0.9.6b beta 3
 0x00090605f == 0.9.6e release

Versions prior to 0.9.3 have identifiers E<lt> 0x0930.
Versions between 0.9.3 and 0.9.5 had a version identifier with this
interpretation:

U
Ulf Möller 已提交
38 39 40 41 42 43 44
 MMNNFFRBB major minor fix final beta/patch

for example

 0x000904100 == 0.9.4 release
 0x000905000 == 0.9.5 dev

U
ispell.  
Ulf Möller 已提交
45
Version 0.9.5a had an interim interpretation that is like the current one,
46 47 48
except the patch level got the highest bit set, to keep continuity.  The
number was therefore 0x0090581f.

49 50 51 52
OPENSSL_VERSION_TEXT is the text variant of the version number and the
release date.  For example,
"OpenSSL 1.0.1a 15 Oct 2015".

R
Rich Salz 已提交
53
OpenSSL_version_num() returns the version number.
U
Ulf Möller 已提交
54

R
Rich Salz 已提交
55
OpenSSL_version() returns different strings depending on B<t>:
56 57 58

=over 4

R
Rich Salz 已提交
59
=item OPENSSL_VERSION
60

61
The text variant of the version number and the release date.  For example,
R
Rich Salz 已提交
62
"OpenSSL 1.0.1a 15 Oct 2015".
63

R
Rich Salz 已提交
64
=item OPENSSL_CFLAGS
65 66 67 68 69

The compiler flags set for the compilation process in the form
"compiler: ..."  if available or "compiler: information not available"
otherwise.

R
Rich Salz 已提交
70
=item OPENSSL_BUILT_ON
71 72 73

The date of the build process in the form "built on: ..." if available
or "built on: date not available" otherwise.
74

R
Rich Salz 已提交
75
=item OPENSSL_PLATFORM
76

77 78 79
The "Configure" target of the library build in the form "platform: ..."
if available or "platform: information not available" otherwise.

R
Rich Salz 已提交
80
=item OPENSSL_DIR
81

82 83
The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "...""
if available or "OPENSSLDIR: N/A" otherwise.
84

85 86 87 88 89
=item OPENSSL_ENGINES_DIR

The "ENGINESDIR" setting of the library build in the form "ENGINESDIR: "...""
if available or "ENGINESDIR: N/A" otherwise.

90
=back
91

92 93
For an unknown B<t>, the text "not available" is returned.

94
=head1 RETURN VALUES
U
Ulf Möller 已提交
95

96 97 98
OpenSSL_version_num() returns the version number.

OpenSSL_version() returns requested version strings.
U
Ulf Möller 已提交
99 100 101

=head1 SEE ALSO

102
L<crypto(7)>
U
Ulf Möller 已提交
103

R
Rich Salz 已提交
104 105
=head1 COPYRIGHT

106
Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
R
Rich Salz 已提交
107 108 109 110 111 112 113

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut