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

3 4
|Branch|CI system|Status|Coverage|
|:----:|:-------:|-----:|:------:|
5
|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://gnutls.gitlab.io/coverage/master)|
6
|Master|Travis|[![build status](https://travis-ci.org/gnutls/gnutls.svg?branch=master)](https://travis-ci.org/gnutls/gnutls)|N/A|
7
|3.5.x|Gitlab|[![build status](https://gitlab.com/gnutls/gnutls/badges/gnutls_3_5_x/build.svg)](https://gitlab.com/gnutls/gnutls/commits/gnutls_3_5_x)|[![coverage report](https://gitlab.com/gnutls/gnutls/badges/gnutls_3_5_x/coverage.svg)](https://gnutls.gitlab.io/coverage/3.5.x)|
8
|3.5.x|Travis|[![build status](https://travis-ci.org/gnutls/gnutls.svg?branch=gnutls_3_5_x)](https://travis-ci.org/gnutls/gnutls)|N/A|
9
|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|
10

11

12
# GnuTLS -- Information for developers
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
13

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
14
GnuTLS implements the TLS/SSL (Transport Layer Security aka Secure
15
Sockets Layer) protocol.  Additional information can be found at
16
[www.gnutls.org](https://www.gnutls.org/).
Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
17

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

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

24 25 26 27 28 29 30 31 32
* [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/)
33 34 35 36 37
* [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/)
38
* [Guile](https://www.gnu.org/software/guile/)
39
* [p11-kit](https://p11-glue.freedesktop.org/p11-kit.html)
40
* [gperf](https://www.gnu.org/software/gperf/)
41
* [libtasn1](https://www.gnu.org/software/libtasn1/) (optional)
42
* [Libidn2](https://www.gnu.org/software/libidn/#libidn2) (optional, for internationalization of DNS, IDNA 2008)
43 44 45
* [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)
46
* [libunbound](https://unbound.net/) (for DANE support)
47 48
* [abi-compliance-checker](https://ispras.linuxbase.org/index.php/ABI_compliance_checker) (for make dist)
* [tcsd](https://trousers.sourceforge.net/) (for TPM support; optional)
49 50
* [swtpm](https://github.com/stefanberger/swtpm) (for TPM test; optional)
* [ncat](https://nmap.org/download.html) (for TPM test; optional)
51
* [tpm-tools](https://trousers.sourceforge.net/) (for TPM test; optional)
52
* [expect](https://core.tcl.tk/expect/index) (for TPM test; optional)
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
53

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

58
Debian/Ubuntu:
59
```
60
apt-get install -y dash git-core autoconf libtool gettext autopoint
61
apt-get install -y automake autogen nettle-dev libp11-kit-dev libtspi-dev libunistring-dev
62
apt-get install -y guile-2.0-dev libtasn1-6-dev libidn2-0-dev gawk gperf
63 64
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
65
```
66

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
71
yum install -y trousers-devel guile-devel libtasn1-devel libidn2-devel gawk gperf
72
yum install -y libtasn1-tools unbound-devel bison help2man 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

90 91
Debian/Ubuntu:
```
92
apt-get install -y valgrind libasan1 libubsan0 nodejs softhsm2 datefudge lcov libssl-dev libcmocka-dev expect
93
apt-get install -y dieharder libpolarssl-runtime openssl abi-compliance-checker socat net-tools ppp lockfile-progs
94 95 96
```

Fedora/RHEL:
97
```
98
yum install -y valgrind libasan libasan-static libubsan nodejs softhsm datefudge lcov openssl-devel expect
99
yum install -y dieharder mbedtls-utils openssl abi-compliance-checker libcmocka-devel socat lockfile-progs
100
```
101

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
102

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
103 104
To download the version controlled sources:

105
```
106
$ git clone https://gitlab.com/gnutls/gnutls.git
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
107
$ cd gnutls
108
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
109

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

112
```
Tim Rühsen's avatar
Tim Rühsen committed
113 114
$ ./bootstrap
$ ./configure
115
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
116

Simon Josefsson's avatar
Simon Josefsson committed
117 118 119
When built this way, some developer defaults will be enabled.  See
cfg.mk for details.

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

122
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
123 124
$ make
$ make check
125
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
126

127 128 129 130 131 132
To test the code coverage of the test suite use the following:
```
$ ./configure --enable-code-coverage
$ make && make check && make code-coverage-capture
```

133 134
Individual tests that may require additional hardware (e.g., smart cards)
are:
135
```
136
$ sh tests/suite/testpkcs11
137
```
138

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
# 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
```

156 157 158 159 160 161 162 163 164 165 166 167
# 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.


168 169
# Contributing

170 171
See [the contributing document](CONTRIBUTING.md).

Nikos Mavrogiannopoulos's avatar
updated  
Nikos Mavrogiannopoulos committed
172

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
173 174 175 176 177 178
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.