Added support for RFC7366 (encrypt then authenticate)
[gnutls:gnutls.git] / README-alpha
1 GnuTLS README-alpha -- Information for developers.              -*- outline -*-
2 Copyright (C) 2009-2012 Free Software Foundation, Inc.
3 See the end for copying conditions.
4
5 This file contains instructions for developers and advanced users that
6 want to build from version controlled sources.
7
8 We require several tools to check out and build the software, including:
9
10 - Make <http://www.gnu.org/software/make/>
11 - Automake <http://www.gnu.org/software/automake/> (use 1.11.3 or later)
12 - Autoconf <http://www.gnu.org/software/autoconf/>
13 - Autogen <http://www.gnu.org/software/autogen/> (use 5.16 or later)
14 - Libtool <http://www.gnu.org/software/libtool/>
15 - Gettext <http://www.gnu.org/software/gettext/>
16 - Texinfo <http://www.gnu.org/software/texinfo/>
17 - Tar <http://www.gnu.org/software/tar/>
18 - Gzip <http://www.gnu.org/software/gzip/>
19 - Texlive & epsf <http://www.tug.org/texlive/> (for PDF manual)
20 - CVS <http://www.gnu.org/software/cvs/> (for gettext autopoint)
21 - GTK-DOC <http://www.gtk.org/gtk-doc/> (for API manual)
22 - Git <http://git-scm.com/>
23 - Perl <http://www.cpan.org/>
24 - Valgrind <http://valgrind.org/> (optional)
25 - Nettle <http://www.lysator.liu.se/~nisse/nettle/>
26 - Guile <http://www.gnu.org/software/guile/>
27 - p11-kit <http://p11-glue.freedesktop.org/p11-kit.html>
28 - gperf <http://www.gnu.org/software/gperf/>
29 - libtasn1 <http://josefsson.org/libtasn1/> (optional)
30 - datefudge <http://packages.debian.org/datefudge> (optional)
31 - Libidn <http://www.gnu.org/software/libidn/> (optional, for crywrap)
32 - AWK <http://www.gnu.org/software/awk/> (for make dist, pmccabe2html)
33 - git2cl <http://savannah.nongnu.org/projects/git2cl/> (for make dist, ChangeLog)
34 - softhsm <http://www.opendnssec.org/softhsm/> (for testing smart card support)
35 - dieharder <http://www.phy.duke.edu/~rgb/General/dieharder.php> (for testing PRNG)
36 - abi-compliance-checker <http://ispras.linuxbase.org/index.php/ABI_compliance_checker> (for make dist)
37
38 The required software is typically distributed with your operating
39 system, and the instructions for installing them differ.  Here are
40 some hints:
41
42 gNewSense/Debian/Ubuntu:
43 apt-get install git-core autoconf libtool gettext autopoint
44 apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils
45 apt-get install help2man gtk-doc-tools valgrind
46 apt-get install guile-1.8-dev libtasn1-3-dev
47 apt-get install datefudge libidn11-dev gawk gperf
48 apt-get install softhsm
49
50 You will sometimes need to install more recent versions of Automake,
51 Nettle, P11-kit and Autogen, which you will need to build from
52 sources.  If your system has the recent versions, you could do:
53
54 apt-get install automake autogen nettle-dev libp11-kit-dev
55
56 To download the version controlled sources:
57
58 $ git clone git://gitorious.org/gnutls/gnutls.git
59 $ cd gnutls
60
61 The next step is to run autoreconf (etc) and then ./configure:
62
63 $ make bootstrap
64
65 When built this way, some developer defaults will be enabled.  See
66 cfg.mk for details.
67
68 Then build the project normally:
69
70 $ make
71 $ make check
72
73 Individual tests that may require additional hardware (e.g., smart cards)
74 are:
75 $ sh tests/suite/testpkcs11
76
77 If you wish to contribute, you may read more about our coding style in
78 doc/README.CODING_STYLE. Note that when contributing code that is not 
79 assigned to FSF, you will need to assert that the contribution is in 
80 accordance to the "Developer's Certificate of Origin" as found in the 
81 file doc/DCO.txt. That can be done by sending a mail with your real name to 
82 the gnutls-devel mailing list. Then just make sure that your contributions 
83 (patches), contain a "Signed-off-by" line, with your name and e-mail address. 
84 To automate the process use "git am -s" to produce patches.
85
86 Happy hacking!
87
88 ----------------------------------------------------------------------
89 Copying and distribution of this file, with or without modification,
90 are permitted in any medium without royalty provided the copyright
91 notice and this notice are preserved.