docs/faq-5-misc.txt

   1 Miscellaneous
   2
   3 * Which is the current version of OpenSSL?
   4
   5 The current version is available from @@@https://www.openssl.org@@@.
   6
   7 In addition to the current stable release, you can also access daily
   8 snapshots of the OpenSSL development version at
   9 @@@https://www.openssl.org/source/snapshot/@@@,
  10 or get it by anonymous Git access.
  11
  12 * Where is the documentation?
  13
  14 OpenSSL is a library that provides cryptographic functionality to
  15 applications such as secure web servers.  Be sure to read the
  16 documentation of the application you want to use.  The INSTALL file
  17 explains how to install this library.
  18
  19 OpenSSL includes a command line utility that can be used to perform a
  20 variety of cryptographic functions.  It is described in the openssl(1)
  21 manpage.  Documentation for developers is currently being written. Many
  22 manual pages are available; overviews of libcrypto and
  23 libssl are given in the crypto(7) and
  24 ssl(7) manpages.
  25
  26 The OpenSSL manpages are installed in /usr/local/ssl/man/ (or a
  27 different directory if you specified one as described in INSTALL).
  28 In addition, you can read the most current versions at
  29 @@@https://www.openssl.org/docs/@@@. Note that the online documents refer
  30 to the very latest development versions of OpenSSL and may include features
  31 not present in released versions. If in doubt refer to the documentation
  32 that came with the version of OpenSSL you are using. The pod format
  33 documentation is included in each OpenSSL distribution under the docs
  34 directory.
  35
  36 * How can I contact the OpenSSL developers?
  37
  38 The README file describes how to submit bug reports and patches to
  39 OpenSSL.  Information on the OpenSSL mailing lists is available from
  40 @@@https://www.openssl.org/community/mailinglists.html@@@.
  41
  42 * Where can I get a compiled version of OpenSSL?
  43
  44 You can finder pointers to binary distributions in
  45 @@@https://www.openssl.org/community/binaries.html@@@ .
  46
  47 Some applications that use OpenSSL are distributed in binary form.
  48 When using such an application, you don't need to install OpenSSL
  49 yourself; the application will include the required parts (e.g. DLLs).
  50
  51 If you want to build OpenSSL on a Windows system and you don't have
  52 a C compiler, read the "Mingw32" section of INSTALL.W32 for information
  53 on how to obtain and install the free GNU C compiler.
  54
  55 A number of Linux and *BSD distributions include OpenSSL.
  56
  57 * Why aren't tools like 'autoconf' and 'libtool' or 'cmake' used?
  58
  59 A number of these tools are great and wonderful, but are usually
  60 centered around one or a few platforms.  'autoconf' and 'libtool' are
  61 Unix centric.  'cmake' is a bit more widely spread, but not enough to
  62 cover the platforms we support.
  63
  64 For OpenSSL 1.1, we decided to base our build system on perl,
  65 information files and build file (Makefile) templates, thereby
  66 covering all the systems we support.  Perl was the base language of
  67 choice because we already use it in diverse scripts, and it's one of
  68 the most widely spread scripting languages.
  69
  70 * What is an 'engine' version?
  71
  72 With version 0.9.6 OpenSSL was extended to interface to external crypto
  73 hardware. This was realized in a special release '0.9.6-engine'. With
  74 version 0.9.7 the changes were merged into the main development line,
  75 so that the special release is no longer necessary.
  76
  77 * How do I check the authenticity of the OpenSSL distribution?
  78
  79 We provide PGP signatures and a variety of digests on each release.
  80 For example, one of the following might work on your system:
  81
  82 <PRE>
  83     sha1sum TARBALL | awk '{print $1;}' | cmp - TARBALL.sha1
  84     sha256sum TARBALL | awk '{print $1;}' | cmp - TARBALL.sha256
  85 </PRE>
  86
  87 You can check authenticity using pgp or gpg. You need the OpenSSL OMC
  88 member public key used to sign it (download it from a key server or see a
  89 list of keys at @@@https://www.openssl.org/community/omc.html@@@). Then
  90 just do:
  91
  92 <PRE>
  93     pgp TARBALL.asc
  94 </PRE>
  95
  96 * How does the versioning scheme work?
  97
  98 After the release of OpenSSL 1.0.0 the versioning scheme changed. Letter
  99 releases (e.g. 1.0.1a) can only contain bug and security fixes and no
 100 new features. Minor releases change the last number (e.g. 1.0.2) and
 101 can contain new features that retain binary compatibility. Changes to
 102 the middle number are considered major releases and neither source nor
 103 binary compatibility is guaranteed.
 104
 105 Therefore the answer to the common question "when will feature X be
 106 backported to OpenSSL 1.0.0/0.9.8?" is "never" but it could appear
 107 in the next minor release.
 108
 109 * What happens when the letter release reaches z?
 110
 111 It was decided after the release of OpenSSL 0.9.8y the next version should
 112 be 0.9.8za then 0.9.8zb and so on.
 113
 114 The current version is available from @@@https://www.openssl.org@@@.
 115
 116 In addition to the current stable release, you can also access daily
 117 snapshots of the OpenSSL development version at
 118 @@@https://www.openssl.org/source/snapshot/@@@, or get
 119 it by anonymous Git access.
 120
 121 * Where is the documentation?
 122
 123 OpenSSL is a library that provides cryptographic functionality to
 124 applications such as secure web servers.  Be sure to read the
 125 documentation of the application you want to use.  The INSTALL file
 126 explains how to install this library.
 127
 128 OpenSSL includes a command line utility that can be used to perform a
 129 variety of cryptographic functions.  It is described in the openssl(1)
 130 manpage.  Documentation for developers is currently being written. Many
 131 manual pages are available; overviews over libcrypto and
 132 libssl are given in the crypto(7)
 133 and ssl(7) manpages.
 134
 135 The OpenSSL manpages are installed in /usr/local/ssl/man/ (or a
 136 different directory if you specified one as described in INSTALL).
 137 In addition, you can read the most current versions at
 138 @@@https://www.openssl.org/docs/@@@. Note that the online documents refer
 139 to the very latest development versions of OpenSSL and may include features
 140 not present in released versions. If in doubt refer to the documentation
 141 that came with the version of OpenSSL you are using. The pod format
 142 documentation is included in each OpenSSL distribution under the docs
 143 directory.
 144
 145 * How can I contact the OpenSSL developers?
 146
 147 The README file describes how to submit bug reports and patches to
 148 OpenSSL.  Information on the OpenSSL mailing lists is available from
 149 @@@https://www.openssl.org/community/mailinglists.html@@@.
 150
 151 * Where can I get a compiled version of OpenSSL?
 152
 153 You can finder pointers to binary distributions in
 154 @@@https://www.openssl.org/community/binaries.html@@@.
 155
 156 Some applications that use OpenSSL are distributed in binary form.
 157 When using such an application, you don't need to install OpenSSL
 158 yourself; the application will include the required parts (e.g. DLLs).
 159
 160 If you want to build OpenSSL on a Windows system and you don't have
 161 a C compiler, read the "Mingw32" section of INSTALL.W32 for information
 162 on how to obtain and install the free GNU C compiler.
 163
 164 A number of Linux and *BSD distributions include OpenSSL.
 165
 166 * Why aren't tools like 'autoconf' and 'libtool' or 'cmake' used?
 167
 168 A number of these tools are great and wonderful, but are usually
 169 centered around one or a few platforms.  'autoconf' and 'libtool' are
 170 Unix centric.  'cmake' is a bit more widely spread, but not enough to
 171 cover the platforms we support.
 172
 173 For OpenSSL 1.1, we decided to base our build system on perl,
 174 information files and build file (Makefile) templates, thereby
 175 covering all the systems we support.  Perl was the base language of
 176 choice because we already use it in diverse scripts, and it's one of
 177 the most widely spread scripting languages.
 178
 179 * What is an 'engine' version?
 180
 181 With version 0.9.6 OpenSSL was extended to interface to external crypto
 182 hardware. This was realized in a special release '0.9.6-engine'. With
 183 version 0.9.7 the changes were merged into the main development line,
 184 so that the special release is no longer necessary.
 185
 186 * How do I check the authenticity of the OpenSSL distribution?
 187
 188 We provide PGP signatures and a variety of digests on each release.
 189 For example, one of the following might work on your system:
 190
 191 <PRE>
 192     sha1sum TARBALL | awk '{print $1;}' | cmp - TARBALL.sha1
 193     sha256sum TARBALL | awk '{print $1;}' | cmp - TARBALL.sha256
 194 </PRE>
 195
 196 You can check authenticity using pgp or gpg. You need the OpenSSL OMC
 197 member public key used to sign it (download it from a key server or see a
 198 list of keys at @@@https://www.openssl.org/community/omc.html@@@). Then
 199 just do:
 200
 201 <PRE>
 202     pgp TARBALL.asc
 203 </PRE>
 204
 205 * How does the versioning scheme work?
 206
 207 After the release of OpenSSL 1.0.0 the versioning scheme changed. Letter
 208 releases (e.g. 1.0.1a) can only contain bug and security fixes and no
 209 new features. Minor releases change the last number (e.g. 1.0.2) and
 210 can contain new features that retain binary compatibility. Changes to
 211 the middle number are considered major releases and neither source nor
 212 binary compatibility is guaranteed.
 213
 214 Therefore the answer to the common question "when will feature X be
 215 backported to OpenSSL 1.0.0/0.9.8?" is "never" but it could appear
 216 in the next minor release.
 217
 218 * What happens when the letter release reaches z?
 219
 220 It was decided after the release of OpenSSL 0.9.8y the next version should
 221 be 0.9.8za then 0.9.8zb and so on.