Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up build-unix.md with better readability #484

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clean up build-unix.md with better readability #484

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 77 additions & 63 deletions doc/build-unix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
Copyright (c) 2009-2012 Bitcoin Developers
Distributed under the MIT software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by the OpenSSL Project for use in
the OpenSSL Toolkit (https://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([email protected]) and UPnP
software written by Thomas Bernard.


UNIX BUILD NOTES
================
====================
Some notes on how to build Paycoin in Unix.

To Build
--------
---------------------

cd src/
make -f makefile.unix # Headless bitcoin
cd src/
make -f makefile.unix # Headless paycoin

See readme-qt.md for instructions on building Bitcoin QT,
the graphical bitcoin.
See [readme-qt.md](readme-qt.md) for instructions on building Paycoin-Qt, the graphical user interface.

Dependencies
------------
---------------------

Library Purpose Description
------- ------- -----------
Expand All @@ -30,61 +21,80 @@ Dependencies
miniupnpc UPnP Support Optional firewall-jumping support
libqrencode QRCode generation Optional QRCode generation

miniupnpc may be used for UPnP port mapping. It can be downloaded from
http://miniupnp.tuxfamily.org/files/. UPnP support is compiled in and
[miniupnpc](http://miniupnp.free.fr/) may be used for UPnP port mapping. It can be downloaded from [here](
http://miniupnp.tuxfamily.org/files/). UPnP support is compiled in and
turned off by default. Set USE_UPNP to a different value to control this:
USE_UPNP=- No UPnP support - miniupnp not required
USE_UPNP=0 (the default) UPnP support turned off by default at runtime
USE_UPNP=1 UPnP support turned on by default at runtime

USE_UPNP= No UPnP support miniupnp not required
USE_UPNP=0 (the default) UPnP support turned off by default at runtime
USE_UPNP=1 UPnP support turned on by default at runtime

libqrencode may be used for QRCode image generation. It can be downloaded
from http://fukuchi.org/works/qrencode/index.html.en, or installed via
your package manager. Set USE_QRCODE to control this:
USE_QRCODE=0 (the default) No QRCode support - libqrcode not required
USE_QRCODE=1 QRCode support enabled

IPv6 support may be enabled by setting
USE_IPV6=1 Enable IPv6 support
USE_QRCODE=0 (the default) No QRCode support - libqrcode not required
USE_QRCODE=1 QRCode support enabled

IPv6 support may be disabled by setting:

USE_IPV6=0 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.3.3
OpenSSL 1.0.1h
Berkeley DB 4.8.30.NC
Boost 1.37
miniupnpc 1.6
- Versions used in this release:
- GCC 4.3.3
- OpenSSL 1.0.1h
- Berkeley DB 4.8.30.NC
- Boost 1.37
- miniupnpc 1.6

Dependency Build Instructions: Ubuntu & Debian
----------------------------------------------
sudo apt-get install build-essential
sudo apt-get install libssl-dev
sudo apt-get install libdb4.8-dev
sudo apt-get install libdb4.8++-dev
Boost 1.40+: sudo apt-get install libboost-all-dev
or Boost 1.37: sudo apt-get install libboost1.37-dev
sudo apt-get install libqrencode-dev
Build requirements:

sudo apt-get install build-essential
sudo apt-get install libssl-dev

for Ubuntu 12.04:

sudo apt-get install libboost-all-dev

db4.8 packages are available [here](https://launchpad.net/~bitcoin/+archive/bitcoin).

If using Boost 1.37, append -mt to the boost libraries in the makefile.
Ubuntu precise has packages for libdb5.1-dev and libdb5.1++-dev,
but using these will break binary wallet compatibility, and is not recommended.

for other Ubuntu & Debian:

sudo apt-get install libdb4.8-dev
sudo apt-get install libdb4.8++-dev
sudo apt-get install libboost1.37-dev
(If using Boost 1.37, append -mt to the boost libraries in the makefile)

Optional:

sudo apt-get install libminiupnpc-dev (see USE_UPNP compile flag)


Dependency Build Instructions: Gentoo
-------------------------------------

Note: Currently, there is no paycoin ebuild available in overlay

emerge -av1 --noreplace dev-libs/boost dev-libs/glib dev-libs/openssl sys-libs/db:4.8
emerge -av1 --noreplace dev-libs/boost dev-libs/glib dev-libs/openssl sys-libs/db:4.8

Note: If you like to have UPnP support, you need to install net-libs/miniupnpc.

Take the following steps to build (no UPnP support):
cd paycoin/src
make -f makefile.unix USE_UPNP= BDB_INCLUDE_PATH='/usr/include/db4.8'
strip paycoind

cd paycoin/src
make -f makefile.unix USE_UPNP= BDB_INCLUDE_PATH='/usr/include/db4.8'
strip paycoind


Notes
Expand All @@ -95,65 +105,69 @@ symbols, which reduces the executable size by about 90%.

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


Berkeley DB
-----------
You need Berkeley DB 4.8. If you have to build Berkeley DB yourself:
../dist/configure --enable-cxx
make

../dist/configure --enable-cxx
make


Boost
-----
If you need to build Boost yourself:
sudo su
./bootstrap.sh
./bjam install

sudo su
./bootstrap.sh
./bjam install


Security
--------
To help make your bitcoin installation more secure by making certain attacks impossible to
To help make your paycoin installation more secure by making certain attacks impossible to
exploit even if a vulnerability is found, you can take the following measures:

* Position Independent Executable
Build position independent code to take advantage of Address Space Layout Randomization
offered by some kernels. Attackers who can cause execution of code at an arbitrary memory
location are thwarted if they don't know where anything useful is located.
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
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 build with PIE, use:
make -f makefile.unix ... -e PIE=1

make -f makefile.unix ... -e PIE=1

To test that you have built PIE executable, install scanelf, part of paxutils, and use:
scanelf -e ./bitcoin

scanelf -e ./paycoin

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, bitcoin should be built with a non-executable stack
vulnerable buffers are found. By default, paycoin 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 ./bitcoin
`scanelf -e ./paycoin`

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

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