Skip to content

Latest commit

 

History

History
198 lines (139 loc) · 6.23 KB

build-unix.md

File metadata and controls

198 lines (139 loc) · 6.23 KB
Raw

UNIX BUILD NOTES

Some notes on how to build Kryptohash in Unix/Linux.

To Build

./autogen.sh
CPPFLAGS="-Ikeccak -Ikeccak/SnP -Ikeccak/KeccakF-1600" ./configure (see below for additional config options)
make

This will build kryptohash-qt as well if the dependencies are met.

Dependencies

Library Purpose Description
libssl SSL Support Secure communications
libdb5.3 Berkeley DB Wallet storage
libboost Boost C++ Library
miniupnpc UPnP Support Optional firewall-jumping support
qt GUI GUI toolkit
protobuf Payments in GUI Data interchange format used for payment protocol
libqrencode QR codes in GUI Optional for generating QR codes

miniupnpc may be used for UPnP port mapping. It can be downloaded from here. UPnP support is compiled in and turned off by default. See the configure options for upnp behavior desired:

--without-miniupnpc      No UPnP support miniupnp not required
--disable-upnp-default   (the default) UPnP support turned off by default at runtime
--enable-upnp-default    UPnP support turned on by default at runtime

IPv6 support may be disabled by setting:

--disable-ipv6           Disable IPv6 support

Licenses of statically linked libraries: Berkeley DB New BSD license with additional requirement that linked software must be free open source Boost MIT-like license miniupnpc New (3-clause) BSD license

  • Versions used in this release:
  • GCC 4.8.2
  • OpenSSL 1.0.1j
  • Berkeley DB 5.3.28.NC
  • Boost 1.57
  • miniupnpc 1.9
  • qt 5.3.2
  • protobuf 2.5.0
  • libqrencode 3.2.0

Dependency Build Instructions: Ubuntu & Debian

Build requirements:

sudo apt-get install build-essential
sudo apt-get install libtool autotools-dev autoconf
sudo apt-get install libssl-dev
sudo apt-get install libboost-all-dev

Then, add to

for Ubuntu 12.04 and later & Debian:

sudo apt-get install libdb5.3-dev
sudo apt-get install libdb5.3++-dev

Optional:

sudo apt-get install libminiupnpc-dev (see --with-miniupnpc and --enable-upnp-default)

Dependencies for the GUI: Ubuntu & Debian

If you want to build kryptohash-Qt, make sure that the required packages for Qt development are installed. Either Qt 4 or Qt 5 are necessary to build the GUI. If both Qt 4 and Qt 5 are installed, Qt 4 will be used. Pass --with-gui=qt5 to configure to choose Qt5. To build without GUI pass --without-gui.

To build with Qt 4 you need the following:

apt-get install libqt4-dev libprotobuf-dev protobuf-compiler

For Qt 5 you need the following:

apt-get install libqt5gui5 libqt5core5a libqt5dbus5 qttools5-dev qttools5-dev-tools libprotobuf-dev protobuf-compiler

libqrencode (optional) can be installed with:

apt-get install libqrencode-dev

Once these are installed, they will be found by configure and a kryptohash-qt executable will be built by default.

Notes

The release is built with GCC and then "strip kryptohashd" to strip the debug symbols, which reduces the executable size by about 90%.

miniupnpc

tar -xzvf miniupnpc-1.9.20140911.tar.gz
cd miniupnpc-1.9.20140911
make
sudo su
make install

Berkeley DB

You need Berkeley DB 5.3. If you have to build Berkeley DB yourself:

cd build_unix/
../dist/configure --enable-cxx
make
sudo make install

Boost

If you have to build Boost yourself:

Download Boost 1.57 source code from http://sourceforge.net/projects/boost/files/boost/1.57.0/
Build boost using: 

sudo su
./bootstrap.sh
./bjam install

run ./configure using the below CPPFLAGS and LDFLAGS
CPPFLAGS="-Ikeccak -Ikeccak/SnP -Ikeccak/KeccakF-1600 -I/usr/local/include" LDFLAGS="-L/usr/local/lib -Wl,-rpath=/usr/local/lib" ./configure (additional config options)

Security

To help make your kryptohash installation more secure by making certain attacks impossible to exploit even if a vulnerability is found, binaries are hardened by default. This can be disabled with:

Hardening Flags:

./configure --enable-hardening
./configure --disable-hardening

Hardening enables the following features:

  • Position Independent Executable Build position independent code to take advantage of Address Space Layout Randomization offered by some kernels. An attacker who is able to cause execution of code at an arbitrary memory location is thwarted if he doesn't know where anything useful is located. The stack and heap are randomly located by default but this allows the code section to be randomly located as well.

    On an Amd64 processor where a library was not compiled with -fPIC, this will cause an error such as: "relocation R_X86_64_32 against `......' can not be used when making a shared object;"

    To test that you have built PIE executable, install scanelf, part of paxutils, and use:

      scanelf -e ./kryptohash

    The output should contain: TYPE ET_DYN

  • Non-executable Stack If the stack is executable then trivial stack based buffer overflow exploits are possible if vulnerable buffers are found. By default, kryptohash should be built with a non-executable stack but if one of the libraries it uses asks for an executable stack or someone makes a mistake and uses a compiler extension which requires an executable stack, it will silently build an executable without the non-executable stack protection.

    To verify that the stack is non-executable after compiling use: scanelf -e ./kryptohash

    the output should contain: STK/REL/PTL RW- R-- RW-

    The STK RW- means that the stack is readable and writeable but not executable.

Disable-wallet mode

When the intention is to run only a P2P node without a wallet, kryptohash may be compiled in disable-wallet mode with:

./configure --disable-wallet

In this case there is no dependency on Berkeley DB 4.8.

Mining is also possible in disable-wallet mode, but only using the getblocktemplate RPC call not getwork.