README.md 6.89 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
|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://gitlab.com/gnutls/gnutls/commits/gnutls_3_5_x)|
6 7
|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|
8

9

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

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

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

22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
* [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/)
39
* [libtasn1](https://www.gnu.org/software/libtasn1/) (optional)
40
* [Libidn](http://www.gnu.org/software/libidn/) (optional, for internationalization of DNS)
41
* [Libunistring](http://www.gnu.org/software/libunistring/) (optional, for internationalization)
42 43 44 45 46
* [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
47

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

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

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

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

72 73
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
74 75
and polarssl.

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

84 85
Debian/Ubuntu:
```
86 87
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
88 89 90
```

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

Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
96

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
97 98
To download the version controlled sources:

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

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

107
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
108
$ make bootstrap
109
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
110

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

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

116
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
117 118
$ make
$ make check
119
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
120

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

127 128
Individual tests that may require additional hardware (e.g., smart cards)
are:
129
```
130
$ sh tests/suite/testpkcs11
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
```

150 151 152 153 154 155 156 157 158 159 160 161
# 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.


162 163
# Contributing

164 165
See [the contributing document](CONTRIBUTING.md).

Nikos Mavrogiannopoulos's avatar
updated  
Nikos Mavrogiannopoulos committed
166

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
167 168 169 170 171 172
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.