diff options
| author | Brent Cook <busterb@gmail.com> | 2015-06-05 05:36:59 -0500 |
|---|---|---|
| committer | Brent Cook <bcook@openbsd.org> | 2015-06-05 05:37:59 -0500 |
| commit | a224727702c2a85361deffa47a536be4373ac0ed (patch) | |
| tree | ba2d9ad1a0743ce8874fa6334b744ae66f106e2c | |
| parent | b4a6a615134b59435efbecdd8c5b5407b6af8e8f (diff) | |
| download | portable-a224727702c2a85361deffa47a536be4373ac0ed.tar.gz portable-a224727702c2a85361deffa47a536be4373ac0ed.tar.bz2 portable-a224727702c2a85361deffa47a536be4373ac0ed.zip | |
update readme with supported OSes
| -rw-r--r-- | README | 53 |
1 files changed, 37 insertions, 16 deletions
| @@ -1,9 +1,42 @@ | |||
| 1 | This package is the official portable version of LibreSSL | 1 | This package is the official portable version of LibreSSL |
| 2 | (http://www.libressl.org). | 2 | (http://www.libressl.org). |
| 3 | 3 | ||
| 4 | LibreSSL is a fork of OpenSSL developed by the OpenBSD project | 4 | LibreSSL is a fork of OpenSSL 1.0.1 developed by the OpenBSD project. |
| 5 | (http://www.openbsd.org). LibreSSL is developed on OpenBSD. This | 5 | (http://www.openbsd.org). |
| 6 | package then adds portability shims for other operating systems. | 6 | |
| 7 | Compatibility with OpenSSL: | ||
| 8 | |||
| 9 | LibreSSL is API compatible with OpenSSL 1.0.1, but does not yet include all | ||
| 10 | new APIs from OpenSSL 1.0.2 and later. LibreSSL also includes APIs not yet | ||
| 11 | present in OpenSSL. The current common API subset is OpenSSL 1.0.1. | ||
| 12 | |||
| 13 | LibreSSL it is not ABI compatible with any release of OpenSSL, or necessarily | ||
| 14 | earlier releases of LibreSSL. You will need to relink your programs to | ||
| 15 | LibreSSL in order to use it, just as in moving between major versions of OpenSSL. | ||
| 16 | LibreSSL's installed library version numbers are incremented to account for | ||
| 17 | ABI and API changes. | ||
| 18 | |||
| 19 | Compatibility with other operating systems: | ||
| 20 | |||
| 21 | While primarily developed on and taking advantage of APIs available on OpenBSD, | ||
| 22 | the LibreSSL portable project attempts to provide working alternatives for | ||
| 23 | other operating systems, and assists with improving OS-native implementations | ||
| 24 | where possible. | ||
| 25 | |||
| 26 | At the time of this writing, LibreSSL is know to build and work on: | ||
| 27 | |||
| 28 | - Linux (kernel 3.17 or later recommended) | ||
| 29 | - FreeBSD (tested with 9.2 and later) | ||
| 30 | - NetBSD (tested with 6.1.5) | ||
| 31 | - HP-UX (11i) | ||
| 32 | - Solaris (11 and later preferred) | ||
| 33 | - Mac OS X (tested with 10.8 and later) | ||
| 34 | - AIX (5.3 and later) | ||
| 35 | |||
| 36 | LibreSSL also supports the following Windows environments: | ||
| 37 | - Microsoft Windows (Vista or higher, x86 and x64) | ||
| 38 | - Wine (32-bit and 64-bit) | ||
| 39 | - Builds with Mingw-w64 and Cygwin | ||
| 7 | 40 | ||
| 8 | Official release tarballs are available at your friendly neighborhood | 41 | Official release tarballs are available at your friendly neighborhood |
| 9 | OpenBSD mirror in directory LibreSSL, e.g.: | 42 | OpenBSD mirror in directory LibreSSL, e.g.: |
| @@ -31,20 +64,8 @@ prepare the source tree for building: | |||
| 31 | or run './dist.sh' to prepare a tarball. | 64 | or run './dist.sh' to prepare a tarball. |
| 32 | 65 | ||
| 33 | Once you have a source tree from Git or FTP, run these commands to build and | 66 | Once you have a source tree from Git or FTP, run these commands to build and |
| 34 | install the package: | 67 | install the package on most systems. |
| 35 | 68 | ||
| 36 | ./configure # see ./configure --help for configuration options | 69 | ./configure # see ./configure --help for configuration options |
| 37 | make check # runs builtin unit tests | 70 | make check # runs builtin unit tests |
| 38 | make install # set DESTDIR= to install to an alternate location | 71 | make install # set DESTDIR= to install to an alternate location |
| 39 | |||
| 40 | The resulting library and 'openssl' utility is largely API-compatible with | ||
| 41 | OpenSSL 1.0.1. However, it is not ABI compatible - you will need to relink your | ||
| 42 | programs to LibreSSL in order to use it, just as in moving from OpenSSL 0.9.8 | ||
| 43 | to 1.0.1. | ||
| 44 | |||
| 45 | The project attempts to provide working alternatives for operating systems with | ||
| 46 | limited or broken security primitives (e.g. arc4random(3)) and assists with | ||
| 47 | improving OS-native implementations where possible. | ||
| 48 | |||
| 49 | LibreSSL portable will build on any reasonably modern version of Linux, | ||
| 50 | Solaris, or OSX with a standards-compliant compiler and C library. | ||
