aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md96
1 files changed, 96 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f1e5199
--- /dev/null
+++ b/README.md
@@ -0,0 +1,96 @@
1![LibreSSL image](http://www.libressl.org/images/libressl.jpg)
2## Official portable version of [LibreSSL](http://www.libressl.org) ##
3
4LibreSSL is a fork of [OpenSSL](https://www.openssl.org) 1.0.1g developed by the
5[OpenBSD](http://www.openbsd.org) project. Our goal is to modernize the codebase,
6improve security, and apply best practice development processes from OpenBSD.
7
8## Compatibility with OpenSSL: ##
9
10LibreSSL is API compatible with OpenSSL 1.0.1, but does not yet include all
11new APIs from OpenSSL 1.0.2 and later. LibreSSL also includes APIs not yet
12present in OpenSSL. The current common API subset is OpenSSL 1.0.1.
13
14LibreSSL it is not ABI compatible with any release of OpenSSL, or necessarily
15earlier releases of LibreSSL. You will need to relink your programs to
16LibreSSL in order to use it, just as in moving between major versions of OpenSSL.
17LibreSSL's installed library version numbers are incremented to account for
18ABI and API changes.
19
20## Compatibility with other operating systems: ##
21
22While primarily developed on and taking advantage of APIs available on OpenBSD,
23the LibreSSL portable project attempts to provide working alternatives for
24other operating systems, and assists with improving OS-native implementations
25where possible.
26
27At the time of this writing, LibreSSL is know to build and work on:
28
29* Linux (kernel 3.17 or later recommended)
30* FreeBSD (tested with 9.2 and later)
31* NetBSD (tested with 6.1.5)
32* HP-UX (11i)
33* Solaris (11 and later preferred)
34* Mac OS X (tested with 10.8 and later)
35* AIX (5.3 and later)
36
37LibreSSL also supports the following Windows environments:
38* Microsoft Windows (Vista or higher, x86 and x64)
39* Wine (32-bit and 64-bit)
40* Builds with Mingw-w64 and Cygwin
41
42Official release tarballs are available at your friendly neighborhood
43OpenBSD mirror in directory
44[LibreSSL](http://ftp.openbsd.org/pub/OpenBSD/LibreSSL/),
45although we suggest that you use a [mirror](http://www.openbsd.org/ftp.html).
46
47The LibreSSL portable build framework is also
48[mirrored](https://github.com/libressl-portable/portable) in Github.
49
50Please report bugs either to the public libressl@openbsd.org mailing list,
51or to the github
52[issue tracker](https://github.com/libressl-portable/portable/issues)
53
54Severe vulnerabilities or bugs requiring coordination with OpenSSL can be
55sent to the core team at libressl-security@openbsd.org.
56
57## Prerequisites when building from git ##
58
59If you have checked this source using Git, follow these initial steps to
60prepare the source tree for building:
61
621. Ensure you have the following packages installed:
63 automake, autoconf, bash, git, libtool, perl, pod2man
642. Run './autogen.sh' to prepare the source tree for building or
65 run './dist.sh' to prepare a tarball.
66
67## Building LibreSSL ##
68
69Once you have a source tree from Git or FTP, run these commands to build and
70install the package on most systems.
71
72```sh
73./configure # see ./configure --help for configuration options
74make check # runs builtin unit tests
75make install # set DESTDIR= to install to an alternate location
76```
77
78### OS specific build information: ###
79
80#### HP-UX (11i) ####
81
82Set the UNIX_STD environment variable to '2003' before running 'configure'
83in order to build with the HP C/aC++ compiler. See the "standards(5)" man
84page for more details.
85
86```sh
87export UNIX_STD=2003
88./configure
89make
90```
91
92#### Windows - Mingw-w64 ####
93
94LibreSSL builds against relatively recent versions of Mingw-w64, not to be
95confused with the original mingw.org project. Mingw-w64 3.2 or later
96should work. See README.windows for more information