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

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
```
Simon Josefsson's avatar
Simon Josefsson committed
42
apt-get install git-core autoconf libtool gettext autopoint
43
apt-get install guile-2.0-dev libtasn1-6-dev
Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
44
apt-get install libidn11-dev gawk gperf git2cl
45
apt-get install libunbound-dev dns-root-data bison
46
apt-get install automake autogen nettle-dev libp11-kit-dev
47 48
apt-get install help2man gtk-doc-tools
apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils
49
```
50

51 52 53
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
54 55 56 57
Dependencies that are used during make check are listed below. Moreover,
for basic interoperability testing you may want to install openssl
and polarssl.

58 59 60 61 62 63
* [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)
64

65
```
66
apt-get install valgrind libasan1
Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
67
apt-get install nodejs softhsm datefudge dieharder
68
apt-get install libpolarssl-runtime openssl
69
```
70

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
71

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
72 73
To download the version controlled sources:

74
```
75
$ git clone git@gitlab.com:gnutls/gnutls.git
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
76
$ cd gnutls
77
$ git submodule update --init
78
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
79

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

82
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
83
$ make bootstrap
84
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
85

Simon Josefsson's avatar
Simon Josefsson committed
86 87 88
When built this way, some developer defaults will be enabled.  See
cfg.mk for details.

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

91
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
92 93
$ make
$ make check
94
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
95

96 97
Individual tests that may require additional hardware (e.g., smart cards)
are:
98
```
99
$ sh tests/suite/testpkcs11
100
```
101

102 103 104 105 106 107 108
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
109 110
To automate the process use "git am -s" to produce patches.

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
111 112 113 114 115 116
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.