doc/build-unix.txt

   1 Copyright (c) 2009-2010 Satoshi Nakamoto
   2 Copyright (c) 2011 Bitcoin Developers
   3 Distributed under the MIT/X11 software license, see the accompanying
   4 file license.txt or http://www.opensource.org/licenses/mit-license.php.
   5 This product includes software developed by the OpenSSL Project for use in
   6 the OpenSSL Toolkit (http://www.openssl.org/).  This product includes
   7 cryptographic software written by Eric Young (eay@cryptsoft.com) and UPnP
   8 software written by Thomas Bernard.
   9
  10
  11 UNIX BUILD NOTES
  12 ================
  13
  14 To Build
  15 --------
  16
  17 cd src/
  18 make -f makefile.unix            # Headless bitcoin
  19
  20 See readme-qt.rst for instructions on building Bitcoin QT,
  21 the graphical bitcoin.
  22
  23 Dependencies
  24 ------------
  25
  26  Library    Purpose       Description
  27  -------    -------       -----------
  28  libssl     SSL Support   Secure communications
  29  libdb4.8   Berkeley DB   Blockchain & wallet storage
  30  libboost   Boost         C++ Library
  31  miinupnpc  UPnP Support  Optional firewall-jumping support
  32
  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
  39
  40 Licenses of statically linked libraries:
  41  Berkeley DB   New BSD license with additional requirement that linked
  42                software must be free open source
  43  Boost         MIT-like license
  44  miniupnpc     New (3-clause) BSD license
  45
  46 Versions used in this release:
  47  GCC           4.3.3
  48  OpenSSL       0.9.8g
  49  Berkeley DB   4.8.30.NC
  50  Boost         1.37
  51  miniupnpc     1.6
  52
  53
  54 Dependency Build Instructions: Ubuntu & Debian
  55 ----------------------------------------------
  56 sudo apt-get install build-essential
  57 sudo apt-get install libssl-dev
  58 sudo apt-get install libdb4.8-dev
  59 sudo apt-get install libdb4.8++-dev
  60  Boost 1.40+: sudo apt-get install libboost-all-dev
  61  or Boost 1.37: sudo apt-get install libboost1.37-dev
  62
  63 If using Boost 1.37, append -mt to the boost libraries in the makefile.
  64
  65
  66 Dependency Build Instructions: Gentoo
  67 -------------------------------------
  68 emerge -av net-libs/miniupnpc boost openssl sys-libs/db
  69
  70 Then take the following steps to build:
  71  cd ${BITCOIN_DIR}/src
  72  sed -i 's/<db_cxx.h>/<db4.8\/db_cxx.h>/' *.h        # path fix
  73  sed -i 's/-Bstatic/-Bdynamic/' makefile.unix        # dynamic linking
  74  sed -i 's/^USE_UPNP:=0$/USE_UPNP:=/' makefile.unix  # disable UPnP
  75  make -f makefile.unix
  76  strip bitcoind
  77
  78
  79 Notes
  80 -----
  81 The release is built with GCC and then "strip bitcoind" to strip the debug
  82 symbols, which reduces the executable size by about 90%.
  83
  84
  85 miniupnpc
  86 ---------
  87 tar -xzvf miniupnpc-1.6.tar.gz
  88 cd miniupnpc-1.6
  89 make
  90 sudo su
  91 make install
  92
  93
  94 Berkeley DB
  95 -----------
  96 You need Berkeley DB 4.8.  If you have to build Berkeley DB yourself:
  97 ../dist/configure --enable-cxx
  98 make
  99
 100
 101 Boost
 102 -----
 103 If you need to build Boost yourself:
 104 sudo su
 105 ./bootstrap.sh
 106 ./bjam install
 107
 108
 109 Security
 110 --------
 111 To help make your bitcoin installation more secure by making certain attacks impossible to
 112 exploit even if a vulnerability is found, you can take the following measures:
 113
 114 * Position Independent Executable
 115     Build position independent code to take advantage of Address Space Layout Randomization
 116     offered by some kernels. An attacker who is able to cause execution of code at an arbitrary
 117     memory location is thwarted if he doesn't know where anything useful is located.
 118     The stack and heap are randomly located by default but this allows the code section to be
 119     randomly located as well.
 120
 121     On an Amd64 processor where a library was not compiled with -fPIC, this will cause an error
 122     such as: "relocation R_X86_64_32 against `......' can not be used when making a shared object;"
 123
 124     To build with PIE, use:
 125     make -f makefile.unix ... -e PIE=1
 126
 127     To test that you have built PIE executable, install scanelf, part of paxutils, and use:
 128     scanelf -e ./bitcoin
 129
 130     The output should contain:
 131      TYPE
 132     ET_DYN
 133
 134 * Non-executable Stack
 135     If the stack is executable then trivial stack based buffer overflow exploits are possible if
 136     vulnerable buffers are found. By default, bitcoin should be built with a non-executable stack
 137     but if one of the libraries it uses asks for an executable stack or someone makes a mistake
 138     and uses a compiler extension which requires an executable stack, it will silently build an
 139     executable without the non-executable stack protection.
 140
 141     To verify that the stack is non-executable after compiling use:
 142     scanelf -e ./bitcoin
 143
 144     the output should contain:
 145     STK/REL/PTL
 146     RW- R-- RW-
 147
 148     The STK RW- means that the stack is readable and writeable but not executable.