README.md 6.09 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

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
7 8 9 10
GnuTLS implements the TLS/SSL (Transport Layer Security aka Secure
Sockets Layer) protocol.  GnuTLS is a GNU project.  Additional
information can be found at <http://www.gnutls.org/>.

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
11
This file contains instructions for developers and advanced users that
Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
12 13
want to build from version controlled sources. See [INSTALL.md](INSTALL.md)
for building released versions.
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
14

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

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

42
The required software is typically distributed with your operating
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
43 44 45
system, and the instructions for installing them differ.  Here are
some hints:

46
Debian/Ubuntu:
47
```
48
apt-get install -y git-core autoconf libtool gettext autopoint
49
apt-get install -y automake autogen nettle-dev libp11-kit-dev libtspi-dev
50 51 52
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
53
```
54

55 56
Fedora/RHEL:
```
57
yum install -y git autoconf libtool gettext-devel automake autogen
58
yum install -y nettle-devel p11-kit-devel autogen-libopts-devel
59
yum install -y trousers-devel guile-devel libtasn1-devel libidn-devel gawk gperf git2cl
60
yum install -y libtasn1-tools unbound-devel bison help2man gtk-doc texinfo texlive
61 62
```

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

66 67
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
68 69
and polarssl.

70 71 72 73 74 75
* [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)
76
* [lcov](http://linux-test-project.github.io/) (for code coverage)
77

78 79
Debian/Ubuntu:
```
80
apt-get install -y valgrind libasan1 libubsan0 nodejs softhsm datefudge lcov libssl-dev libcmocka-dev
81
apt-get install -y dieharder libpolarssl-runtime openssl abi-compliance-checker
82 83 84
```

Fedora/RHEL:
85
```
86
yum install -y valgrind libasan libasan-static libubsan nodejs softhsm datefudge lcov openssl-devel
87
yum install -y dieharder mbedtls-utils openssl abi-compliance-checker libcmocka-devel
88
```
89

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
90

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
91 92
To download the version controlled sources:

93
```
94
$ git clone https://gitlab.com/gnutls/gnutls.git
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
95
$ cd gnutls
96
$ git submodule update --init
97
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
98

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

101
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
102
$ make bootstrap
103
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
104

Simon Josefsson's avatar
Simon Josefsson committed
105 106 107
When built this way, some developer defaults will be enabled.  See
cfg.mk for details.

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

110
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
111 112
$ make
$ make check
113
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
114

115 116 117 118 119 120
To test the code coverage of the test suite use the following:
```
$ ./configure --enable-code-coverage
$ make && make check && make code-coverage-capture
```

121 122
Individual tests that may require additional hardware (e.g., smart cards)
are:
123
```
124
$ sh tests/suite/testpkcs11
125
```
126

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
# 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

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

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
155 156 157 158 159 160
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.