aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README52
1 files changed, 34 insertions, 18 deletions
diff --git a/README b/README
index 719a51e..0b5b8cd 100644
--- a/README
+++ b/README
@@ -1,34 +1,50 @@
1This package is the official portable version of LibreSSL 1This package is the official portable version of LibreSSL
2(http://www.libressl.org). 2 (http://www.libressl.org).
3 3
4LibreSSL is a fork of OpenSSL developed by the OpenBSD project 4LibreSSL is a fork of OpenSSL developed by the OpenBSD project
5(http://www.openbsd.org). LibreSSL is developed on OpenBSD. This 5(http://www.openbsd.org). LibreSSL is developed on OpenBSD. This
6package then adds portability shims for other operating systems. 6package then adds portability shims for other operating systems.
7 7
8Official release tarballs are available at your friendly neighborhood 8Official release tarballs are available at your friendly neighborhood
9OpenBSD mirror in directory LibreSSL, e.g.: 9OpenBSD mirror in directory LibreSSL, e.g.:
10http://ftp.openbsd.org/pub/OpenBSD/LibreSSL/
11although it is suggested you use a mirror.
12 10
13Development is done in the upstream OpenBSD codebase. A github clone 11 http://ftp.openbsd.org/pub/OpenBSD/LibreSSL/
14of the official repositories is kept at:
15https://github.com/libressl-portable
16We update this repository from the OpenBSD respositories
17semi-frequently, so changes may not show up in GitHub immediately.
18The GitHub repository should be used for informational purposes
19only.
20 12
21./configure && make check && make install 13although we suggest that you use a mirror:
22 14
23See crypto/compat for the bulk of the local compatibility code. 15 http://www.openbsd.org/ftp.html
24 16
25It will likely build on any reasonably modern version of Linux, Solaris, 17The LibreSSL portable build framework is also mirrored in Github:
26or OSX with a sane compiler and C library. 18
19 https://github.com/libressl-portable/portable
20
21If you have checked this source using Git, follow these initial steps to
22prepare the source tree for building:
23
24 1. ensure you have the following packages installed:
25 automake, autoconf, bash, git, libtool, perl, pod2man
26 2. run './autogen.sh' to prepare the source tree for building
27 or run './dist.sh' to prepare a tarball.
28
29Once you have a source tree from Git or FTP, run these commands to build and
30install the package:
31
32 ./configure # see ./configure --help for configuration options
33 make check # runs builtin unit tests
34 make install # set DESTDIR= to install to an alternate location
35
36The resulting library and 'openssl' utility is largely API-compatible with
37OpenSSL 1.0.1. However, it is not ABI compatible - you will need to relink your
38programs to LibreSSL in order to use it, just as in moving from OpenSSL 0.9.8
39to 1.0.1.
40
41LibreSSL portable will likely build on any reasonably modern version of Linux,
42Solaris, or OSX with a standards-compliant compiler and C library. If you are
43working a new port, most of the OS-specific compatibility code is found in
44'crypto/compat'
27 45
28Note: Our policy is generally to use your system provided intrinsics. 46Note: Our policy is generally to use your system provided intrinsics.
29If your system provides security sensitive functions (such as 47If your system provides security sensitive functions (such as
30arc4random(), issetugid(), calloc(), getentropy(), and others) we will 48arc4random(), issetugid(), calloc(), getentropy(), and others) we will
31assume they are implemented correctly and securely. If they are 49assume they are implemented correctly and securely. If they are
32not please contact your OS provider. 50not please contact your OS provider.
33
34