README.md 5.75 KB
Newer Older
1 2 3
Master [![build status](https://gitlab.com/gnutls/gnutls/badges/master/build.svg)](https://gitlab.com/gnutls/gnutls/commits/master)
  3.4.x [![build status](https://gitlab.com/gnutls/gnutls/badges/gnutls_3_4_x/build.svg)](https://gitlab.com/gnutls/gnutls/commits/gnutls_3_4_x)
  3.3.x [![build status](https://gitlab.com/gnutls/gnutls/badges/gnutls_3_3_x/build.svg)](https://gitlab.com/gnutls/gnutls/commits/gnutls_3_3_x)
4

5
# GnuTLS -- Information for developers
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
6 7

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

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

12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
* [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/)
29
* [libtasn1](https://www.gnu.org/software/libtasn1/) (optional)
30 31 32 33 34 35
* [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
36

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

41
Debian/Ubuntu:
42
```
43
apt-get install -y git-core autoconf libtool gettext autopoint
44
apt-get install -y automake autogen nettle-dev libp11-kit-dev libtspi-dev
45 46 47
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
48
```
49

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

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

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

65 66 67 68 69 70
* [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)
71
* [lcov](http://linux-test-project.github.io/) (for code coverage)
72

73 74
Debian/Ubuntu:
```
75
apt-get install -y valgrind libasan1 nodejs softhsm datefudge lcov
76
apt-get install -y dieharder libpolarssl-runtime openssl abi-compliance-checker
77 78 79
```

Fedora/RHEL:
80
```
81
yum install -y valgrind libasan nodejs softhsm datefudge lcov
82
yum install -y dieharder mbedtls-utils openssl abi-compliance-checker
83
```
84

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
85

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
86 87
To download the version controlled sources:

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

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

96
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
97
$ make bootstrap
98
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
99

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

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

105
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
106 107
$ make
$ make check
108
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
109

110 111 112 113 114 115
To test the code coverage of the test suite use the following:
```
$ ./configure --enable-code-coverage
$ make && make check && make code-coverage-capture
```

116 117
Individual tests that may require additional hardware (e.g., smart cards)
are:
118
```
119
$ sh tests/suite/testpkcs11
120
```
121

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
# Building for windows

It is recommended to cross compile using Fedora and the following
dependencies:

```
yum install -y wine mingw32-nettle mingw32-libtasn1 mingw32-gcc
```

and build as:

```
mingw32-configure --enable-local-libopts --disable-non-suiteb-curves --disable-doc --without-p11-kit
mingw32-make
mingw32-make check
```

# Contributing

141
If you wish to contribute, you may read more about our [coding style](CONTRIBUTING.md).
142 143 144 145 146 147
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
148 149
To automate the process use "git am -s" to produce patches.

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
150 151 152 153 154 155
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.