Skip to content

Latest commit

 

History

History
148 lines (118 loc) · 5.42 KB

README-alpha.md

File metadata and controls

148 lines (118 loc) · 5.42 KB

Master build status 3.4.x build status 3.3.x build status

GnuTLS -- Information for developers

This file contains instructions for developers and advanced users that want to build from version controlled sources.

We require several tools to check out and build the software, including:

The required software is typically distributed with your operating system, and the instructions for installing them differ. Here are some hints:

Debian/Ubuntu:

apt-get install -y git-core autoconf libtool gettext autopoint
apt-get install -y automake autogen nettle-dev libp11-kit-dev libtspi-dev
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

Fedora/RHEL:

yum install -y git autoconf libtool gettext-devel automake autogen
yum install -y nettle-devel p11-kit-devel autogen-libopts-devel
yum install -y trousers-devel guile-devel libtasn1-devel libidn-devel gawk gperf git2cl
yum install -y unbound-devel bison help2man gtk-doc texinfo texlive

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

Dependencies that are used during make check are listed below. Moreover, for basic interoperability testing you may want to install openssl and polarssl.

Debian/Ubuntu:

apt-get install -y valgrind libasan1 nodejs softhsm datefudge
apt-get install -y dieharder libpolarssl-runtime openssl

Fedora/RHEL:

yum install -y valgrind libasan nodejs softhsm datefudge
yum install -y dieharder mbedtls-utils openssl

To download the version controlled sources:

$ git clone https://gitlab.com/gnutls/gnutls.git
$ cd gnutls
$ git submodule update --init

The next step is to run autoreconf (etc) and then ./configure:

$ make bootstrap

When built this way, some developer defaults will be enabled. See cfg.mk for details.

Then build the project normally, and run the test suite.

$ make
$ make check

Individual tests that may require additional hardware (e.g., smart cards) are:

$ sh tests/suite/testpkcs11

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

If you wish to contribute, you may read more about our coding style. 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. 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. To automate the process use "git am -s" to produce patches.

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.