README.md 4.85 KB
Newer Older
1
[![build status](https://ci.gitlab.com/projects/684/status.png?ref=master)](https://gitlab.com/gnutls/gnutls/builds)
2 3

GnuTLS -- Information for developers
4
=================================================
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
5 6

This file contains instructions for developers and advanced users that
7
want to build from version controlled sources.
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
8

9
We require several tools to check out and build the software, including:
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
10

11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
* [Make](http://www.gnu.org/software/make/)
* [Automake](http://www.gnu.org/software/automake/) (use 1.11.3 or later)
* [Autoconf](http://www.gnu.org/software/autoconf/)
* [Autogen](http://www.gnu.org/software/autogen/) (use 5.16 or later)
* [Libtool](http://www.gnu.org/software/libtool/)
* [Gettext](http://www.gnu.org/software/gettext/)
* [Texinfo](http://www.gnu.org/software/texinfo/)
* [Tar](http://www.gnu.org/software/tar/)
* [Gzip](http://www.gnu.org/software/gzip/)
* [Texlive & epsf](http://www.tug.org/texlive/) (for PDF manual)
* [GTK-DOC](http://www.gtk.org/gtk-doc/) (for API manual)
* [Git](http://git-scm.com/)
* [Perl](http://www.cpan.org/)
* [Nettle](http://www.lysator.liu.se/~nisse/nettle/)
* [Guile](http://www.gnu.org/software/guile/)
* [p11-kit](http://p11-glue.freedesktop.org/p11-kit.html)
* [gperf](http://www.gnu.org/software/gperf/)
* [libtasn1](http://josefsson.org/libtasn1/) (optional)
* [Libidn](http://www.gnu.org/software/libidn/) (optional, for internationalization of DNS)
* [AWK](http://www.gnu.org/software/awk/) (for make dist, pmccabe2html)
* [git2cl](http://savannah.nongnu.org/projects/git2cl/) (for make dist, ChangeLog)
* [bison](http://www.gnu.org/software/bison) (for datetime parser in certtool)
* [libunbound](https://unbound.net/) (for DANE support)
* [abi-compliance-checker](http://ispras.linuxbase.org/index.php/ABI_compliance_checker) (for make dist)
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
35

36
The required software is typically distributed with your operating
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
37 38 39
system, and the instructions for installing them differ.  Here are
some hints:

40
Debian/Ubuntu:
41
```
42 43 44 45 46
apt-get install -y git-core autoconf libtool gettext autopoint
apt-get install -y automake autogen nettle-dev libp11-kit-dev
apt-get install -y guile-2.0-dev libtasn1-6-dev libidn11-dev gawk gperf git2cl
apt-get install -y libunbound-dev dns-root-data bison help2man gtk-doc-tools
apt-get install -y texinfo texlive texlive-generic-recommended texlive-extra-utils
47
```
48

49 50
Fedora/RHEL:
```
51 52 53 54
yum install -y git autoconf libtool gettext-devel automake autogen
yum install -y automake autogen nettle-devel p11-kit-devel autogen-libopts-devel
yum install -y guile-devel libtasn1-devel libidn-devel gawk gperf git2cl
yum install -y unbound-devel bison help2man gtk-doc texinfo texlive
55 56
```

57 58 59
Sometimes, you may need to install more recent versions of Automake,
Nettle, P11-kit and Autogen, which you will need to build from sources. 

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
60 61 62 63
Dependencies that are used during make check are listed below. Moreover,
for basic interoperability testing you may want to install openssl
and polarssl.

64 65 66 67 68 69
* [Valgrind](http://valgrind.org/) (optional)
* [Libasan](https://gcc.gnu.org//) (optional)
* [datefudge](http://packages.debian.org/datefudge) (optional)
* [nodejs](http://nodejs.org/) (needed for certain test cases)
* [softhsm](http://www.opendnssec.org/softhsm/) (for testing smart card support)
* [dieharder](http://www.phy.duke.edu/~rgb/General/dieharder.php) (for testing PRNG)
70

71 72
Debian/Ubuntu:
```
73 74
apt-get install -y valgrind libasan1 nodejs softhsm datefudge
apt-get install -y dieharder libpolarssl-runtime openssl
75 76 77
```

Fedora/RHEL:
78
```
79 80
yum install -y valgrind libasan nodejs softhsm datefudge
yum install -y dieharder mbedtls-utils openssl
81
```
82

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
83

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
84 85
To download the version controlled sources:

86
```
87
$ git clone git@gitlab.com:gnutls/gnutls.git
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
88
$ cd gnutls
89
$ git submodule update --init
90
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
91

Simon Josefsson's avatar
Simon Josefsson committed
92
The next step is to run autoreconf (etc) and then ./configure:
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
93

94
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
95
$ make bootstrap
96
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
97

Simon Josefsson's avatar
Simon Josefsson committed
98 99 100
When built this way, some developer defaults will be enabled.  See
cfg.mk for details.

101
Then build the project normally, and run the test suite.
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
102

103
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
104 105
$ make
$ make check
106
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
107

108 109
Individual tests that may require additional hardware (e.g., smart cards)
are:
110
```
111
$ sh tests/suite/testpkcs11
112
```
113

114 115 116 117 118 119 120
If you wish to contribute, you may read more about our [coding style](doc/README.CODING_STYLE).
Note that when contributing code that is not assigned to FSF, you will
need to assert that the contribution is in accordance to the "Developer's
Certificate of Origin" as found in the file [DCO.txt](doc/DCO.txt).
That can be done by sending a mail with your real name to the gnutls-devel
mailing list. Then just make sure that your contributions (patches),
contain a "Signed-off-by" line, with your name and e-mail address. 
Nikos Mavrogiannopoulos's avatar
updated  
Nikos Mavrogiannopoulos committed
121 122
To automate the process use "git am -s" to produce patches.

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
123 124 125 126 127 128
Happy hacking!

----------------------------------------------------------------------
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.