diff options
| author | Bob Beck <beck@rocinante.obtuse.com> | 2014-07-11 02:29:53 -0600 |
|---|---|---|
| committer | Bob Beck <beck@rocinante.obtuse.com> | 2014-07-11 02:29:53 -0600 |
| commit | 3b147ed66df3637c3adf5293931d550b002b5a73 (patch) | |
| tree | 72532262471a939269c9b119cb48b09622b6f4a5 | |
| parent | faaf265e849078c99fa701facf8952a5a18e12fd (diff) | |
| download | portable-3b147ed66df3637c3adf5293931d550b002b5a73.tar.gz portable-3b147ed66df3637c3adf5293931d550b002b5a73.tar.bz2 portable-3b147ed66df3637c3adf5293931d550b002b5a73.zip | |
Fix up README to reflect LibReSSL portable
| -rw-r--r-- | README | 48 |
1 files changed, 8 insertions, 40 deletions
| @@ -1,47 +1,15 @@ | |||
| 1 | This project repackages the OpenBSD (http://www.openbsd.org/) fork of | 1 | This package is the portable version of LibReSSL (http://www.libressl.org). |
| 2 | OpenSSL (https://www.openssl.org/), LibreSSL (http://www.libressl.org/), so | ||
| 3 | it is buildable on other systems. | ||
| 4 | 2 | ||
| 5 | To build, you need autoconf, automake and libtool installed. | 3 | LibReSSL is a fork of OpenSSL developed by the OpenBSD project |
| 6 | To run all unit tests, you need python installed as well. | 4 | (http://www.openbsd.org). LibReSSL is developed on OpenBSD. This |
| 5 | package then adds portability shims for other operating systems. | ||
| 7 | 6 | ||
| 8 | Run 'autogen.sh' followed by './configure; make; make check' | 7 | ./configure make make check make install |
| 9 | 8 | ||
| 10 | To build a tarball, run 'make dist' | 9 | See crypto/compat for the bulk of the local compatibility code. |
| 11 | 10 | ||
| 12 | You may need to periodically clean/dist-clean your source tree or rerun | 11 | It will likely build on any reasonably modern version of Linux, Solaris, |
| 13 | autogen.sh/update.sh in order to import the latest source from the git | 12 | or OSX with a sane compiler and C library. |
| 14 | submodules. | ||
| 15 | 13 | ||
| 16 | Warning: | ||
| 17 | This is an alpha work-in-progress, not ready for general use. It is based on | ||
| 18 | semi-regular snapshots of the upstream code with minimal patching (see the | ||
| 19 | compat_fixes branches on the upstream import trees for current patches). | ||
| 20 | 14 | ||
| 21 | Use it this check application compatibility, security research, code auditing, | ||
| 22 | or to just see what the LibreSSL team is up to. Just don't use it in | ||
| 23 | production! | ||
| 24 | 15 | ||
| 25 | Please also read Nick Mathewson's warning on libottery. While we are not | ||
| 26 | currently incorporating this library for random numbers, the warning is still | ||
| 27 | relevant. | ||
| 28 | https://github.com/nmathewson/libottery | ||
| 29 | |||
| 30 | Caveat Emptor: | ||
| 31 | While this project uses compatibility shims and imports functions from | ||
| 32 | OpenBSD's libc, it is a continual challenge to make it work exactly the same as | ||
| 33 | if it is running on OpenBSD. Until there is an official port of LibreSSL (and | ||
| 34 | even after), please conduct your own audits and patches are always welcome. | ||
| 35 | |||
| 36 | http://insanecoding.blogspot.com/2014/04/common-libressl-porting-mistakes.html | ||
| 37 | http://insanecoding.blogspot.com/2014/05/a-good-idea-with-bad-usage-devurandom.html | ||
| 38 | |||
| 39 | See crypto/compat for the bulk of the local compatibility code. | ||
| 40 | |||
| 41 | It has been tested to build on these platforms: | ||
| 42 | Ubuntu 14.04 amd64 / armhf | ||
| 43 | Centos 6.5 i686 | ||
| 44 | FreeBSD 10 amd64 | ||
| 45 | Mac OS X 10.9.3 | ||
| 46 | |||
| 47 | Coverity Scan Status: https://scan.coverity.com/projects/2493 | ||