diff options
Diffstat (limited to '')
| -rw-r--r-- | src/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3 | 159 |
1 files changed, 125 insertions, 34 deletions
diff --git a/src/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3 b/src/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3 index 7c792f745a..e5a66c58db 100644 --- a/src/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3 +++ b/src/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3 | |||
| @@ -1,9 +1,28 @@ | |||
| 1 | .\" $OpenBSD: OPENSSL_VERSION_NUMBER.3,v 1.3 2016/11/28 14:51:03 schwarze Exp $ | 1 | .\" $OpenBSD: OPENSSL_VERSION_NUMBER.3,v 1.4 2018/02/17 18:00:59 schwarze Exp $ |
| 2 | .\" OpenSSL 9b86974e Aug 17 15:21:33 2015 -0400 | 2 | .\" full merge up to: OpenSSL 1f13ad31 Dec 25 17:50:39 2017 +0800 |
| 3 | .\" | 3 | .\" |
| 4 | .\" This file was written by Ulf Moeller <ulf@openssl.org> and | 4 | .\" This file is a derived work. |
| 5 | .\" Richard Levitte <levitte@openssl.org>. | 5 | .\" The changes are covered by the following Copyright and license: |
| 6 | .\" Copyright (c) 2000, 2002, 2014 The OpenSSL Project. All rights reserved. | 6 | .\" |
| 7 | .\" Copyright (c) 2017, 2018 Ingo Schwarze <schwarze@openbsd.org> | ||
| 8 | .\" | ||
| 9 | .\" Permission to use, copy, modify, and distribute this software for any | ||
| 10 | .\" purpose with or without fee is hereby granted, provided that the above | ||
| 11 | .\" copyright notice and this permission notice appear in all copies. | ||
| 12 | .\" | ||
| 13 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
| 14 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
| 15 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
| 16 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| 17 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
| 18 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
| 19 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
| 20 | .\" | ||
| 21 | .\" The original file was written by Ulf Moeller <ulf@openssl.org>, | ||
| 22 | .\" Richard Levitte <levitte@openssl.org>, and | ||
| 23 | .\" Bodo Moeller <bodo@openssl.org>. | ||
| 24 | .\" Copyright (c) 2000, 2002, 2015, 2016, 2017 The OpenSSL Project. | ||
| 25 | .\" All rights reserved. | ||
| 7 | .\" | 26 | .\" |
| 8 | .\" Redistribution and use in source and binary forms, with or without | 27 | .\" Redistribution and use in source and binary forms, with or without |
| 9 | .\" modification, are permitted provided that the following conditions | 28 | .\" modification, are permitted provided that the following conditions |
| @@ -49,18 +68,26 @@ | |||
| 49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 68 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 69 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
| 51 | .\" | 70 | .\" |
| 52 | .Dd $Mdocdate: November 28 2016 $ | 71 | .Dd $Mdocdate: February 17 2018 $ |
| 53 | .Dt OPENSSL_VERSION_NUMBER 3 | 72 | .Dt OPENSSL_VERSION_NUMBER 3 |
| 54 | .Os | 73 | .Os |
| 55 | .Sh NAME | 74 | .Sh NAME |
| 56 | .Nm OPENSSL_VERSION_NUMBER , | 75 | .Nm OPENSSL_VERSION_NUMBER , |
| 76 | .Nm OpenSSL_version_num , | ||
| 77 | .Nm OpenSSL_version , | ||
| 57 | .Nm SSLeay , | 78 | .Nm SSLeay , |
| 58 | .Nm SSLeay_version | 79 | .Nm SSLeay_version |
| 59 | .Nd get OpenSSL version number | 80 | .Nd get OpenSSL version number |
| 60 | .Sh SYNOPSIS | 81 | .Sh SYNOPSIS |
| 61 | .In openssl/opensslv.h | 82 | .In openssl/opensslv.h |
| 62 | .Fd #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL | 83 | .Fd #define OPENSSL_VERSION_NUMBER 0x020000000L |
| 63 | .In openssl/crypto.h | 84 | .In openssl/crypto.h |
| 85 | .Ft unsigned long | ||
| 86 | .Fn OpenSSL_version_num void | ||
| 87 | .Ft const char * | ||
| 88 | .Fo OpenSSL_version | ||
| 89 | .Fa "int t" | ||
| 90 | .Fc | ||
| 64 | .Ft long | 91 | .Ft long |
| 65 | .Fn SSLeay void | 92 | .Fn SSLeay void |
| 66 | .Ft const char * | 93 | .Ft const char * |
| @@ -70,21 +97,23 @@ | |||
| 70 | .Sh DESCRIPTION | 97 | .Sh DESCRIPTION |
| 71 | .Dv OPENSSL_VERSION_NUMBER | 98 | .Dv OPENSSL_VERSION_NUMBER |
| 72 | is a numeric release version identifier. | 99 | is a numeric release version identifier. |
| 73 | The first two digits contain the major release number, | 100 | For OpenSSL, the first two digits contain the major release number, |
| 74 | the third and fourth digits the minor release number, | 101 | the third and fourth digits the minor release number, |
| 75 | the fifth and sixth digits the fix release number, | 102 | the fifth and sixth digits the fix release number, |
| 76 | the seventh and eight digits the patch release number. | 103 | the seventh and eight digits the patch release number. |
| 77 | The final digit is 0 for development, 1 to e for betas 1 to 14, or f | 104 | The final digit is 0 for development, 1 to e for betas 1 to 14, or f |
| 78 | for release. | 105 | for release. |
| 106 | For LibreSSL, this number is always 0x020000000. | ||
| 79 | .Pp | 107 | .Pp |
| 80 | For example: | 108 | For example: |
| 81 | .Bd -literal -offset indent | 109 | .Bd -literal -offset indent |
| 82 | 0x000906000 == 0.9.6 dev | 110 | 0x000906000 == 0.9.6 dev |
| 83 | 0x000906023 == 0.9.6b beta 3 | 111 | 0x000906023 == 0.9.6b beta 3 |
| 84 | 0x00090605f == 0.9.6e release | 112 | 0x00090605f == 0.9.6e release |
| 113 | 0x020000000 == 2.0.0 for any version of LibreSSL | ||
| 85 | .Ed | 114 | .Ed |
| 86 | .Pp | 115 | .Pp |
| 87 | Versions prior to 0.9.3 had identifiers < 0x0930. | 116 | OpenSSL versions prior to 0.9.3 had identifiers < 0x0930. |
| 88 | For versions between 0.9.3 and 0.9.5, | 117 | For versions between 0.9.3 and 0.9.5, |
| 89 | the seventh digit was 1 for release and 0 otherwise, | 118 | the seventh digit was 1 for release and 0 otherwise, |
| 90 | and the eighth and ninth digits were the patch release number. | 119 | and the eighth and ninth digits were the patch release number. |
| @@ -95,45 +124,107 @@ For example: | |||
| 95 | 0x000905000 == 0.9.5 dev | 124 | 0x000905000 == 0.9.5 dev |
| 96 | .Ed | 125 | .Ed |
| 97 | .Pp | 126 | .Pp |
| 98 | Version 0.9.5a had an interim interpretation that is like the current | 127 | OpenSSL version 0.9.5a had an interim interpretation that is like the current |
| 99 | one, except the patch level got the highest bit set, to keep continuity. | 128 | one, except the patch level got the highest bit set, to keep continuity. |
| 100 | The number was therefore 0x0090581f. | 129 | The number was therefore 0x0090581f. |
| 101 | .Pp | 130 | .Pp |
| 102 | For backward compatibility, SSLEAY_VERSION_NUMBER is also defined. | 131 | .Fn OpenSSL_version_num |
| 132 | returns this version number. | ||
| 103 | .Pp | 133 | .Pp |
| 104 | .Fn SSLeay | 134 | .Fn OpenSSL_version |
| 105 | returns this number. | ||
| 106 | The return value can be compared to the macro to make sure that the | ||
| 107 | correct version of the library has been loaded, especially when using | ||
| 108 | DLLs on Windows systems. | ||
| 109 | .Pp | ||
| 110 | .Fn SSLeay_version | ||
| 111 | returns different strings depending on | 135 | returns different strings depending on |
| 112 | .Fa t : | 136 | .Fa t : |
| 113 | .Bl -tag -width Ds | 137 | .Bl -tag -width Ds |
| 114 | .It Dv SSLEAY_VERSION | 138 | .It Dv OPENSSL_VERSION |
| 115 | The text variant of the version number and the release date. | 139 | The text variant of the version number. |
| 116 | For example, "OpenSSL 0.9.5a 1 Apr 2000". | 140 | For OpenSSL, it is followed by the release date. |
| 117 | .It Dv SSLEAY_CFLAGS | 141 | For example, |
| 142 | .Qq OpenSSL 0.9.5a 1 Apr 2000 | ||
| 143 | or | ||
| 144 | .Qq LibreSSL 2.7.0 . | ||
| 145 | .It Dv OPENSSL_CFLAGS | ||
| 118 | The compiler flags set for the compilation process in the form | 146 | The compiler flags set for the compilation process in the form |
| 119 | "compiler: ..." if available or "compiler: information not available" | 147 | .Qq compiler: ... |
| 148 | if available or | ||
| 149 | .Qq compiler: information not available | ||
| 150 | otherwise. | ||
| 151 | LibreSSL never provides compiler information. | ||
| 152 | .It Dv OPENSSL_BUILT_ON | ||
| 153 | The date of the build process in the form | ||
| 154 | .Qq built on: ... | ||
| 155 | if available or | ||
| 156 | .Qq built on: date not available | ||
| 157 | otherwise. | ||
| 158 | LibreSSL never provides information on the build date. | ||
| 159 | .It Dv OPENSSL_PLATFORM | ||
| 160 | The Configure target of the library build in the form | ||
| 161 | .Qq platform: ... | ||
| 162 | if available or | ||
| 163 | .Qq platform: information not available | ||
| 164 | otherwise. | ||
| 165 | LibreSSL never provides platform information. | ||
| 166 | .It Dv OPENSSL_DIR | ||
| 167 | The | ||
| 168 | .Dv OPENSSLDIR | ||
| 169 | setting of the library build in the form | ||
| 170 | .Qq OPENSSLDIR: Qq ... | ||
| 171 | if available or | ||
| 172 | .Qq OPENSSLDIR: N/A | ||
| 173 | otherwise. | ||
| 174 | For LibreSSL, the default is | ||
| 175 | .Qq OPENSSLDIR: Qq /etc/ssl . | ||
| 176 | .It Dv OPENSSL_ENGINES_DIR | ||
| 177 | The | ||
| 178 | .Dv ENGINESDIR | ||
| 179 | setting of the library build in the form | ||
| 180 | .Qq ENGINESDIR: Qq ... | ||
| 181 | if available or | ||
| 182 | .Qq ENGINESDIR: N/A | ||
| 120 | otherwise. | 183 | otherwise. |
| 121 | .It Dv SSLEAY_BUILT_ON | 184 | LibreSSL never provides or uses an |
| 122 | The date of the build process in the form "built on: ..." if available | 185 | .Dv ENGINESDIR . |
| 123 | or "built on: date not available" otherwise. | ||
| 124 | .It Dv SSLEAY_PLATFORM | ||
| 125 | The "Configure" target of the library build in the form "platform: ..." | ||
| 126 | if available or "platform: information not available" otherwise. | ||
| 127 | .It Dv SSLEAY_DIR | ||
| 128 | The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: | ||
| 129 | "..."" if available or "OPENSSLDIR: N/A" otherwise. | ||
| 130 | .El | 186 | .El |
| 131 | .Pp | 187 | .Pp |
| 132 | For an unknown | 188 | For an unknown |
| 133 | .Fa t , | 189 | .Fa t , |
| 134 | the text "not available" is returned. | 190 | the text |
| 191 | .Qq not available | ||
| 192 | is returned. | ||
| 193 | .Pp | ||
| 194 | For backward compatibility, | ||
| 195 | .Dv SSLEAY_VERSION_NUMBER | ||
| 196 | is an alias for | ||
| 197 | .Dv OPENSSL_VERSION_NUMBER | ||
| 198 | and | ||
| 199 | .Fn SSLeay | ||
| 200 | for | ||
| 201 | .Dv OpenSSL_version_num . | ||
| 202 | The legacy function | ||
| 203 | .Fn SSLeay_version | ||
| 204 | is similar to | ||
| 205 | .Fn OpenSSL_version | ||
| 206 | except that it takes arguments | ||
| 207 | .Dv SSLEAY_VERSION , | ||
| 208 | .Dv SSLEAY_CFLAGS , | ||
| 209 | .Dv SSLEAY_BUILT_ON , | ||
| 210 | .Dv SSLEAY_PLATFORM , | ||
| 211 | and | ||
| 212 | .Dv SSLEAY_DIR | ||
| 213 | which expand to | ||
| 214 | .Em other | ||
| 215 | numerical values than the corresponding | ||
| 216 | .Dv OPENSSL_* | ||
| 217 | macros. | ||
| 135 | .Sh RETURN VALUES | 218 | .Sh RETURN VALUES |
| 136 | The version number. | 219 | .Fn OpenSSL_version_num |
| 220 | and | ||
| 221 | .Fn SSLeay | ||
| 222 | return a constant version number. | ||
| 223 | .Pp | ||
| 224 | .Fn OpenSSL_version | ||
| 225 | and | ||
| 226 | .Fn SSLeay_version | ||
| 227 | return pointers to static strings. | ||
| 137 | .Sh SEE ALSO | 228 | .Sh SEE ALSO |
| 138 | .Xr crypto 3 | 229 | .Xr crypto 3 |
| 139 | .Sh HISTORY | 230 | .Sh HISTORY |
