README.md 6.47 KB
Newer Older
1 2 3
|Branch|CI system|Status|Coverage|
|:----:|:-------:|-----:|:------:|
|Master|Gitlab|[![build status](https://gitlab.com/gnutls/gnutls/badges/master/build.svg)](https://gitlab.com/gnutls/gnutls/commits/master)|[![coverage report](https://gitlab.com/gnutls/gnutls/badges/master/coverage.svg)](https://gitlab.com/gnutls/gnutls/commits/master)|
4
|Master|Travis|[![build status](https://travis-ci.org/gnutls/gnutls.svg?branch=master)](https://travis-ci.org/gnutls/gnutls)|N/A|
5 6
|3.4.x|Gitlab|[![build status](https://gitlab.com/gnutls/gnutls/badges/gnutls_3_4_x/build.svg)](https://gitlab.com/gnutls/gnutls/commits/gnutls_3_4_x)|N/A|
|3.3.x|Gitlab|[![build status](https://gitlab.com/gnutls/gnutls/badges/gnutls_3_3_x/build.svg)](https://gitlab.com/gnutls/gnutls/commits/gnutls_3_3_x)|N/A|
7

8

9
# GnuTLS -- Information for developers
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
10

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
11 12 13 14
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
15
This file contains instructions for developers and advanced users that
Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
16 17
want to build from version controlled sources. See [INSTALL.md](INSTALL.md)
for building released versions.
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
18

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

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

46
The required software is typically distributed with your operating
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
47 48 49
system, and the instructions for installing them differ.  Here are
some hints:

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

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

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

70 71
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
72 73
and polarssl.

74 75 76 77 78 79
* [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)
80
* [lcov](http://linux-test-project.github.io/) (for code coverage)
81

82 83
Debian/Ubuntu:
```
84 85
apt-get install -y valgrind libasan1 libubsan0 nodejs softhsm2 datefudge lcov libssl-dev libcmocka-dev
apt-get install -y dieharder libpolarssl-runtime openssl abi-compliance-checker socat net-tools ppp
86 87 88
```

Fedora/RHEL:
89
```
90
yum install -y valgrind libasan libasan-static libubsan nodejs softhsm datefudge lcov openssl-devel
91
yum install -y dieharder mbedtls-utils openssl abi-compliance-checker libcmocka-devel socat
92
```
93

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
94

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
95 96
To download the version controlled sources:

97
```
98
$ git clone https://gitlab.com/gnutls/gnutls.git
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
99
$ cd gnutls
100
$ git submodule update --init
101
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
102

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

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

Simon Josefsson's avatar
Simon Josefsson committed
109 110 111
When built this way, some developer defaults will be enabled.  See
cfg.mk for details.

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

114
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
115 116
$ make
$ make check
117
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
118

119 120 121 122 123 124
To test the code coverage of the test suite use the following:
```
$ ./configure --enable-code-coverage
$ make && make check && make code-coverage-capture
```

125 126
Individual tests that may require additional hardware (e.g., smart cards)
are:
127
```
128
$ sh tests/suite/testpkcs11
129
```
130

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
# 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

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

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
159 160 161 162 163 164
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.