1 Copyright (c) 2009-2012 Bitcoin Developers
2 Distributed under the MIT/X11 software license, see the accompanying
3 file license.txt or http://www.opensource.org/licenses/mit-license.php.
4 This product includes software developed by the OpenSSL Project for use in
5 the OpenSSL Toolkit (http://www.openssl.org/). This product includes
6 cryptographic software written by Eric Young (eay@cryptsoft.com) and UPnP
7 software written by Thomas Bernard.
17 make -f makefile.unix # Headless bitcoin
19 See readme-qt.rst for instructions on building Bitcoin QT,
20 the graphical bitcoin.
25 Library Purpose Description
26 ------- ------- -----------
27 libssl SSL Support Secure communications
28 libdb4.8 Berkeley DB Blockchain & wallet storage
29 libboost Boost C++ Library
30 miniupnpc UPnP Support Optional firewall-jumping support
31 libqrencode QRCode generation Optional QRCode generation
33 miniupnpc may be used for UPnP port mapping. It can be downloaded from
34 http://miniupnp.tuxfamily.org/files/. UPnP support is compiled in and
35 turned off by default. Set USE_UPNP to a different value to control this:
36 USE_UPNP= No UPnP support - miniupnp not required
37 USE_UPNP=0 (the default) UPnP support turned off by default at runtime
38 USE_UPNP=1 UPnP support turned on by default at runtime
40 libqrencode may be used for QRCode image generation. It can be downloaded
41 from http://fukuchi.org/works/qrencode/index.html.en, or installed via
42 your package manager. Set USE_QRCODE to control this:
43 USE_QRCODE=0 (the default) No QRCode support - libarcode not required
44 USE_QRCODE=1 QRCode support enabled
46 Licenses of statically linked libraries:
47 Berkeley DB New BSD license with additional requirement that linked
48 software must be free open source
49 Boost MIT-like license
50 miniupnpc New (3-clause) BSD license
52 Versions used in this release:
59 Dependency Build Instructions: Ubuntu & Debian
60 ----------------------------------------------
61 sudo apt-get install build-essential
62 sudo apt-get install libssl-dev
63 sudo apt-get install libdb4.8-dev
64 sudo apt-get install libdb4.8++-dev
65 Boost 1.40+: sudo apt-get install libboost-all-dev
66 or Boost 1.37: sudo apt-get install libboost1.37-dev
67 sudo apt-get install libqrencode-dev
69 If using Boost 1.37, append -mt to the boost libraries in the makefile.
72 Dependency Build Instructions: Gentoo
73 -------------------------------------
75 Note: If you just want to install bitcoind on Gentoo, you can add the Bitcoin
76 overlay and use your package manager:
77 layman -a bitcoin && emerge bitcoind
79 emerge -av1 --noreplace boost glib openssl sys-libs/db:4.8
81 Take the following steps to build (no UPnP support):
83 make -f makefile.unix USE_UPNP= BDB_INCLUDE_PATH='/usr/include/db4.8'
89 The release is built with GCC and then "strip bitcoind" to strip the debug
90 symbols, which reduces the executable size by about 90%.
95 tar -xzvf miniupnpc-1.6.tar.gz
104 You need Berkeley DB 4.8. If you have to build Berkeley DB yourself:
105 ../dist/configure --enable-cxx
111 If you need to build Boost yourself:
119 To help make your bitcoin installation more secure by making certain attacks impossible to
120 exploit even if a vulnerability is found, you can take the following measures:
122 * Position Independent Executable
123 Build position independent code to take advantage of Address Space Layout Randomization
124 offered by some kernels. An attacker who is able to cause execution of code at an arbitrary
125 memory location is thwarted if he doesn't know where anything useful is located.
126 The stack and heap are randomly located by default but this allows the code section to be
127 randomly located as well.
129 On an Amd64 processor where a library was not compiled with -fPIC, this will cause an error
130 such as: "relocation R_X86_64_32 against `......' can not be used when making a shared object;"
132 To build with PIE, use:
133 make -f makefile.unix ... -e PIE=1
135 To test that you have built PIE executable, install scanelf, part of paxutils, and use:
138 The output should contain:
142 * Non-executable Stack
143 If the stack is executable then trivial stack based buffer overflow exploits are possible if
144 vulnerable buffers are found. By default, bitcoin should be built with a non-executable stack
145 but if one of the libraries it uses asks for an executable stack or someone makes a mistake
146 and uses a compiler extension which requires an executable stack, it will silently build an
147 executable without the non-executable stack protection.
149 To verify that the stack is non-executable after compiling use:
152 the output should contain:
156 The STK RW- means that the stack is readable and writeable but not executable.