README.md 7.42 KB
Newer Older
1 2
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/330/badge)](https://bestpractices.coreinfrastructure.org/projects/330)

3 4 5 6
|Branch|CI system|Status|Test suite coverage|Fuzzer coverage|
|:----:|:-------:|-----:|:------:|:-------------:|
|Master/3.6.x|Gitlab|[![build status](https://gitlab.com/gnutls/gnutls/badges/master/pipeline.svg)](https://gitlab.com/gnutls/gnutls/commits/master)|[![coverage report](https://gitlab.com/gnutls/gnutls/badges/master/coverage.svg)](https://gnutls.gitlab.io/coverage/master)|[![Fuzzer coverage report](https://gnutls.gitlab.io/coverage/master-fuzz/badge.svg)](https://gnutls.gitlab.io/coverage/master-fuzz)|
|Master/3.6.x|Travis|[![build status](https://travis-ci.org/gnutls/gnutls.svg?branch=master)](https://travis-ci.org/gnutls/gnutls)|N/A|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
GnuTLS implements the TLS/SSL (Transport Layer Security aka Secure
12
Sockets Layer) protocol.  Additional information can be found at
13
[www.gnutls.org](https://www.gnutls.org/).
Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
14

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
* [Make](https://www.gnu.org/software/make/)
* [Automake](https://www.gnu.org/software/automake/) (use 1.11.3 or later)
* [Autoconf](https://www.gnu.org/software/autoconf/)
* [Autogen](https://www.gnu.org/software/autogen/) (use 5.16 or later)
* [Libtool](https://www.gnu.org/software/libtool/)
* [Gettext](https://www.gnu.org/software/gettext/)
* [Texinfo](https://www.gnu.org/software/texinfo/)
* [Tar](https://www.gnu.org/software/tar/)
* [Gzip](https://www.gnu.org/software/gzip/)
30 31 32 33 34
* [Texlive & epsf](https://www.tug.org/texlive/) (for PDF manual)
* [GTK-DOC](https://www.gtk.org/gtk-doc/) (for API manual)
* [Git](https://git-scm.com/)
* [Perl](https://www.cpan.org/)
* [Nettle](https://www.lysator.liu.se/~nisse/nettle/)
35
* [Guile](https://www.gnu.org/software/guile/)
Tim Rühsen's avatar
Tim Rühsen committed
36
* [p11-kit](https://p11-glue.github.io/p11-glue/p11-kit.html)
37
* [gperf](https://www.gnu.org/software/gperf/)
38
* [libtasn1](https://www.gnu.org/software/libtasn1/) (optional)
39
* [Libidn2](https://www.gnu.org/software/libidn/#libidn2) (optional, for internationalization of DNS, IDNA 2008)
40 41 42
* [Libunistring](https://www.gnu.org/software/libunistring/) (optional, for internationalization)
* [AWK](https://www.gnu.org/software/awk/) (for make dist, pmccabe2html)
* [bison](https://www.gnu.org/software/bison) (for datetime parser in certtool)
43
* [libunbound](https://unbound.net/) (for DANE support)
44
* [libabigail](https://pagure.io/libabigail/) (for abi comparison in make dist)
45
* [tcsd](https://trousers.sourceforge.net/) (for TPM support; optional)
46 47
* [swtpm](https://github.com/stefanberger/swtpm) (for TPM test; optional)
* [ncat](https://nmap.org/download.html) (for TPM test; optional)
48
* [tpm-tools](https://trousers.sourceforge.net/) (for TPM test; optional)
49
* [expect](https://core.tcl.tk/expect/index) (for TPM test; optional)
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
50

51
The required software is typically distributed with your operating
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
52 53 54
system, and the instructions for installing them differ.  Here are
some hints:

55
Debian/Ubuntu:
56
```
57
apt-get install -y dash git-core autoconf libtool gettext autopoint
58
apt-get install -y automake autogen nettle-dev libp11-kit-dev libtspi-dev libunistring-dev
Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
59 60
apt-get install -y guile-2.2-dev libtasn1-6-dev libidn2-0-dev gawk gperf
apt-get install -y libunbound-dev dns-root-data bison gtk-doc-tools
61
apt-get install -y texinfo texlive texlive-generic-recommended texlive-extra-utils
62
```
63

64 65 66
__NOTE:__ Some software versions might not be available in older releases, e.g. `nettle-dev`. 
Available backport repos, APT-Pinning or source code compilating can be used to install these versions (and dependencies) from a newer release.

67 68
Fedora/RHEL:
```
69
yum install -y dash git autoconf libtool gettext-devel automake autogen patch
70
yum install -y nettle-devel p11-kit-devel autogen-libopts-devel libunistring-devel
Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
71 72
yum install -y trousers-devel guile22-devel libtasn1-devel libidn2-devel gawk gperf
yum install -y libtasn1-tools unbound-devel bison gtk-doc texinfo texlive
73 74
```

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

78 79
Dependencies that are used during make check or make dist are listed below.
Moreover, for basic interoperability testing you may want to install openssl
80
and mbedtls.
Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
81

82
* [Valgrind](https://valgrind.org/) (optional)
83
* [Libasan](https://gcc.gnu.org//) (optional)
84 85 86 87 88
* [datefudge](https://packages.debian.org/datefudge) (optional)
* [nodejs](https://nodejs.org/) (needed for certain test cases)
* [softhsm](https://www.opendnssec.org/softhsm/) (for testing smart card support)
* [dieharder](https://www.phy.duke.edu/~rgb/General/dieharder.php) (for testing PRNG)
* [lcov](https://linux-test-project.github.io/) (for code coverage)
89
* [util-linux](https://github.com/karelzak/util-linux) or just [lscpu](https://github.com/NanXiao/lscpu) (for CPU feature detection)
90

91 92
Debian/Ubuntu:
```
93
apt-get install -y valgrind nodejs softhsm2 datefudge lcov libssl-dev libcmocka-dev expect
94
apt-get install -y dieharder openssl abigail-tools socat net-tools ppp lockfile-progs util-linux
95 96 97 98 99 100
```

__NOTE:__ `libubsan0` and `libasan1` are required on older versions of Ubuntu <= 16.04. This packages must be manually added on these versions:

```
apt-get install -y v libubsan0 libasan1
101 102 103
```

Fedora/RHEL:
104
```
105
yum install -y valgrind libasan libasan-static libubsan nodejs softhsm datefudge lcov openssl-devel expect
106
yum install -y dieharder mbedtls-utils openssl libabigail libcmocka-devel socat lockfile-progs util-linux
107
```
108

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
109

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
110 111
To download the version controlled sources:

112
```
113
$ git clone https://gitlab.com/gnutls/gnutls.git
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
114
$ cd gnutls
115
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
116

Tim Rühsen's avatar
Tim Rühsen committed
117
The next step is to bootstrap and ./configure:
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
118

119
```
Tim Rühsen's avatar
Tim Rühsen committed
120 121
$ ./bootstrap
$ ./configure
122
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
123

Simon Josefsson's avatar
Simon Josefsson committed
124 125 126
When built this way, some developer defaults will be enabled.  See
cfg.mk for details.

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

129
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
130 131
$ make
$ make check
132
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
133

134 135 136 137 138 139
To test the code coverage of the test suite use the following:
```
$ ./configure --enable-code-coverage
$ make && make check && make code-coverage-capture
```

140 141
Individual tests that may require additional hardware (e.g., smart cards)
are:
142
```
143
$ sh tests/suite/testpkcs11
144
```
145

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
# 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
```

163 164 165 166 167 168 169 170 171 172 173 174
# Continuous Integration (CI)

We utilize two continuous integration systems, the gitlab-ci and travis.
Gitlab-CI is used to test most of the Linux systems (see .gitlab-ci.yml),
and is split in two phases, build image creation and compilation/test. The
build image creation is done at the gnutls/build-images subproject and
uploads the image at the gitlab.com container registry. The compilation/test
phase is on every commit to gnutls project.

The Travis based CI, is used to test compilation on MacOSX based systems.


175 176
# Contributing

177 178
See [the contributing document](CONTRIBUTING.md).

Nikos Mavrogiannopoulos's avatar
updated  
Nikos Mavrogiannopoulos committed
179

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
180 181 182 183 184 185
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.