git.samba.org - gd/gnutls/blob - README.md

   1 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/330/badge)](https://bestpractices.coreinfrastructure.org/projects/330)
   2
   3 |Branch|CI system|Status|Coverage|
   4 |:----:|:-------:|-----:|:------:|
   5 |Master/3.6.x|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/3.6.x|Travis|[![build status](https://travis-ci.org/gnutls/gnutls.svg?branch=master)](https://travis-ci.org/gnutls/gnutls)|N/A|
   7
   8
   9 # GnuTLS -- Information for developers
  10
  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/).
  14
  15 This file contains instructions for developers and advanced users that
  16 want to build from version controlled sources. See [INSTALL.md](INSTALL.md)
  17 for building released versions.
  18
  19 We require several tools to check out and build the software, including:
  20
  21 * [Make](https://www.gnu.org/software/make/)
  22 * [Automake](https://www.gnu.org/software/automake/) (use 1.11.3 or later)
  23 * [Autoconf](https://www.gnu.org/software/autoconf/)
  24 * [Autogen](https://www.gnu.org/software/autogen/) (use 5.16 or later)
  25 * [Libtool](https://www.gnu.org/software/libtool/)
  26 * [Gettext](https://www.gnu.org/software/gettext/)
  27 * [Texinfo](https://www.gnu.org/software/texinfo/)
  28 * [Tar](https://www.gnu.org/software/tar/)
  29 * [Gzip](https://www.gnu.org/software/gzip/)
  30 * [Texlive & epsf](https://www.tug.org/texlive/) (for PDF manual)
  31 * [GTK-DOC](https://www.gtk.org/gtk-doc/) (for API manual)
  32 * [Git](https://git-scm.com/)
  33 * [Perl](https://www.cpan.org/)
  34 * [Nettle](https://www.lysator.liu.se/~nisse/nettle/)
  35 * [Guile](https://www.gnu.org/software/guile/)
  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 * [Libunistring](https://www.gnu.org/software/libunistring/) (optional, for internationalization)
  41 * [AWK](https://www.gnu.org/software/awk/) (for make dist, pmccabe2html)
  42 * [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 * [swtpm](https://github.com/stefanberger/swtpm) (for TPM test; optional)
  47 * [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)
  50
  51 The required software is typically distributed with your operating
  52 system, and the instructions for installing them differ.  Here are
  53 some hints:
  54
  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
  59 apt-get install -y guile-2.2-dev libtasn1-6-dev libidn2-0-dev gawk gperf
  60 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 __NOTE:__ Some software versions might not be available in older releases, e.g. `nettle-dev`.
  65 Available backport repos, APT-Pinning or source code compilating can be used to install these versions (and dependencies) from a newer release.
  66
  67 Fedora/RHEL:
  68 ```
  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 guile22-devel libtasn1-devel libidn2-devel gawk gperf
  72 yum install -y libtasn1-tools unbound-devel bison gtk-doc texinfo texlive
  73 ```
  74
  75 Sometimes, you may need to install more recent versions of Automake,
  76 Nettle, P11-kit and Autogen, which you will need to build from sources.
  77
  78 Dependencies that are used during make check or make dist are listed below.
  79 Moreover, for basic interoperability testing you may want to install openssl
  80 and mbedtls.
  81
  82 * [Valgrind](https://valgrind.org/) (optional)
  83 * [Libasan](https://gcc.gnu.org//) (optional)
  84 * [datefudge](https://packages.debian.org/datefudge) (optional)
  85 * [nodejs](https://nodejs.org/) (needed for certain test cases)
  86 * [softhsm](https://www.opendnssec.org/softhsm/) (for testing smart card support)
  87 * [dieharder](https://www.phy.duke.edu/~rgb/General/dieharder.php) (for testing PRNG)
  88 * [lcov](https://linux-test-project.github.io/) (for code coverage)
  89
  90 Debian/Ubuntu:
  91 ```
  92 apt-get install -y valgrind nodejs softhsm2 datefudge lcov libssl-dev libcmocka-dev expect
  93 apt-get install -y dieharder openssl abigail-tools socat net-tools ppp lockfile-progs
  94 ```
  95
  96 __NOTE:__ `libubsan0` and `libasan1` are required on older versions of Ubuntu <= 16.04. This packages must be manually added on these versions:
  97
  98 ```
  99 apt-get install -y v libubsan0 libasan1
 100 ```
 101
 102 Fedora/RHEL:
 103 ```
 104 yum install -y valgrind libasan libasan-static libubsan nodejs softhsm datefudge lcov openssl-devel expect
 105 yum install -y dieharder mbedtls-utils openssl libabigail libcmocka-devel socat lockfile-progs
 106 ```
 107
 108
 109 To download the version controlled sources:
 110
 111 ```
 112 $ git clone https://gitlab.com/gnutls/gnutls.git
 113 $ cd gnutls
 114 ```
 115
 116 The next step is to bootstrap and ./configure:
 117
 118 ```
 119 $ ./bootstrap
 120 $ ./configure
 121 ```
 122
 123 When built this way, some developer defaults will be enabled.  See
 124 cfg.mk for details.
 125
 126 Then build the project normally, and run the test suite.
 127
 128 ```
 129 $ make
 130 $ make check
 131 ```
 132
 133 To test the code coverage of the test suite use the following:
 134 ```
 135 $ ./configure --enable-code-coverage
 136 $ make && make check && make code-coverage-capture
 137 ```
 138
 139 Individual tests that may require additional hardware (e.g., smart cards)
 140 are:
 141 ```
 142 $ sh tests/suite/testpkcs11
 143 ```
 144
 145 # Building for windows
 146
 147 It is recommended to cross compile using Fedora and the following
 148 dependencies:
 149
 150 ```
 151 yum install -y wine mingw32-nettle mingw32-libtasn1 mingw32-gcc
 152 ```
 153
 154 and build as:
 155
 156 ```
 157 mingw32-configure --enable-local-libopts --disable-non-suiteb-curves --disable-doc --without-p11-kit
 158 mingw32-make
 159 mingw32-make check
 160 ```
 161
 162 # Continuous Integration (CI)
 163
 164 We utilize two continuous integration systems, the gitlab-ci and travis.
 165 Gitlab-CI is used to test most of the Linux systems (see .gitlab-ci.yml),
 166 and is split in two phases, build image creation and compilation/test. The
 167 build image creation is done at the gnutls/build-images subproject and
 168 uploads the image at the gitlab.com container registry. The compilation/test
 169 phase is on every commit to gnutls project.
 170
 171 The Travis based CI, is used to test compilation on MacOSX based systems.
 172
 173
 174 # Contributing
 175
 176 See [the contributing document](CONTRIBUTING.md).
 177
 178
 179 Happy hacking!
 180
 181 ----------------------------------------------------------------------
 182 Copying and distribution of this file, with or without modification,
 183 are permitted in any medium without royalty provided the copyright
 184 notice and this notice are preserved.