From 3b147ed66df3637c3adf5293931d550b002b5a73 Mon Sep 17 00:00:00 2001 From: Bob Beck Date: Fri, 11 Jul 2014 02:29:53 -0600 Subject: Fix up README to reflect LibReSSL portable --- README | 48 ++++++++---------------------------------------- 1 file changed, 8 insertions(+), 40 deletions(-) diff --git a/README b/README index 939d2a6..e543a86 100644 --- a/README +++ b/README @@ -1,47 +1,15 @@ -This project repackages the OpenBSD (http://www.openbsd.org/) fork of -OpenSSL (https://www.openssl.org/), LibreSSL (http://www.libressl.org/), so -it is buildable on other systems. +This package is the portable version of LibReSSL (http://www.libressl.org). -To build, you need autoconf, automake and libtool installed. -To run all unit tests, you need python installed as well. +LibReSSL is a fork of OpenSSL developed by the OpenBSD project +(http://www.openbsd.org). LibReSSL is developed on OpenBSD. This +package then adds portability shims for other operating systems. -Run 'autogen.sh' followed by './configure; make; make check' +./configure make make check make install -To build a tarball, run 'make dist' +See crypto/compat for the bulk of the local compatibility code. -You may need to periodically clean/dist-clean your source tree or rerun -autogen.sh/update.sh in order to import the latest source from the git -submodules. +It will likely build on any reasonably modern version of Linux, Solaris, +or OSX with a sane compiler and C library. -Warning: -This is an alpha work-in-progress, not ready for general use. It is based on -semi-regular snapshots of the upstream code with minimal patching (see the -compat_fixes branches on the upstream import trees for current patches). -Use it this check application compatibility, security research, code auditing, -or to just see what the LibreSSL team is up to. Just don't use it in -production! -Please also read Nick Mathewson's warning on libottery. While we are not -currently incorporating this library for random numbers, the warning is still -relevant. - https://github.com/nmathewson/libottery - -Caveat Emptor: -While this project uses compatibility shims and imports functions from -OpenBSD's libc, it is a continual challenge to make it work exactly the same as -if it is running on OpenBSD. Until there is an official port of LibreSSL (and -even after), please conduct your own audits and patches are always welcome. - -http://insanecoding.blogspot.com/2014/04/common-libressl-porting-mistakes.html -http://insanecoding.blogspot.com/2014/05/a-good-idea-with-bad-usage-devurandom.html - -See crypto/compat for the bulk of the local compatibility code. - -It has been tested to build on these platforms: - Ubuntu 14.04 amd64 / armhf - Centos 6.5 i686 - FreeBSD 10 amd64 - Mac OS X 10.9.3 - -Coverity Scan Status: https://scan.coverity.com/projects/2493 -- cgit v1.2.3-55-g6feb