doc: Some typo fixes.
[gnupg.git] / doc / HACKING
1 # HACKING                                                       -*- org -*-
2 #+TITLE: A Hacker's Guide to GnuPG
3 #+TEXT: Some notes on GnuPG internals
4 #+STARTUP: showall
5 #+OPTIONS: ^:{}
6
7 * How to contribute
8
9   The following stuff explains some basic procedures you need to
10   follow if you want to contribute code or documentation.
11
12 ** No more ChangeLog files
13
14 Do not modify any of the ChangeLog files in GnuPG.  Starting on
15 December 1st, 2011 we put change information only in the GIT commit
16 log, and generate a top-level ChangeLog file from logs at "make dist"
17 time.  As such, there are strict requirements on the form of the
18 commit log messages.  The old ChangeLog files have all be renamed to
19 ChangeLog-2011
20
21 ** Commit log requirements
22
23 Your commit log should always start with a one-line summary, the
24 second line should be blank, and the remaining lines are usually
25 ChangeLog-style entries for all affected files.  However, it's fine
26 --- even recommended --- to write a few lines of prose describing the
27 change, when the summary and ChangeLog entries don't give enough of
28 the big picture.  Omit the leading TABs that you are seeing in a
29 "real" ChangeLog file, but keep the maximum line length at 72 or
30 smaller, so that the generated ChangeLog lines, each with its leading
31 TAB, will not exceed 80 columns.  If you want to add text which shall
32 not be copied to the ChangeLog, separate it by a line consisting of
33 two dashes at the begin of a line.
34
35 Typo fixes and documentation updates don't need a ChangeLog Entry,
36 thus you would use a commit message like
37
38 #+begin_example
39 Fix type in a comment
40
41 --
42 #+end_example
43
44 The marker line here is important; without it the first line would
45 appear in the ChangeLog.
46
47 ** License policy
48
49   GnuPG is licensed under the GPLv3+ with some files under a mixed
50   LGPLv3+/GPLv2+ license.  It is thus important, that all contributed
51   code allows for an update of the license; for example we can't
52   accept code under the GPLv2(only).
53
54   GnuPG used to have a strict policy of requiring copyright
55   assignments to the FSF.  To avoid this major organizational overhead
56   and to allow inclusion of code, not copyrighted by the FSF, this
57   policy has been relaxed on 2013-03-29.  It is now also possible to
58   contribute code by asserting that the contribution is in accordance
59   to the "Libgcrypt Developer's Certificate of Origin" as found in the
60   file "DCO".  (Except for a slight wording change, this DCO is
61   identical to the one used by the Linux kernel.)
62
63   If your want to contribute code or documentation to GnuPG and you
64   didn't signed a copyright assignment with the FSF in the past, you
65   need to take these simple steps:
66
67   - Decide which mail address you want to use.  Please have your real
68     name in the address and not a pseudonym.  Anonymous contributions
69     can only be done if you find a proxy who certifies for you.
70
71   - If your employer or school might claim ownership of code written
72     by you; you need to talk to them to make sure that you have the
73     right to contribute under the DCO.
74
75   - Send an OpenPGP signed mail to the gnupg-devel@gnupg.org mailing
76     list from your mail address.  Include a copy of the DCO as found
77     in the official master branch.  Insert your name and email address
78     into the DCO in the same way you want to use it later.  Example:
79
80       Signed-off-by: Joe R. Hacker <joe@example.org>
81
82     (If you really need it, you may perform simple transformations of
83     the mail address: Replacing "@" by " at " or "." by " dot ".)
84
85   - That's it.  From now on you only need to add a "Signed-off-by:"
86     line with your name and mail address to the commit message.  It is
87     recommended to send the patches using a PGP/MIME signed mail.
88
89 ** Coding standards
90
91   Please follow the GNU coding standards.  If you are in doubt consult
92   the existing code as an example.  Do no re-indent code without a
93   need.  If you really need to do it, use a separate commit for such a
94   change.
95
96 * Windows
97 ** How to build an installer for Windows
98
99    Your best bet is to use a decent Debian System for development.
100    You need to install a long list of tools for building.  This list
101    still needs to be compiled.  However, the build process will stop
102    if a tool is missing.  GNU make is required (on non GNU systems
103    often installed as "gmake").  The installer requires a couple of
104    extra software to be available either as tarballs or as local git
105    repositories.  In case this file here is part of a gnupg-w32-2.*.xz
106    complete tarball as distributed from the same place as a binary
107    installer, all such tarballs are already included.
108
109    Cd to the GnuPG source directory and use one of one of these
110    command:
111
112    - If sources are included (gnupg-w32-*.tar.xz)
113
114      make -f build-aux/speedo.mk WHAT=this installer
115
116    - To build from tarballs
117
118      make -f build-aux/speedo.mk WHAT=release TARBALLS=TARDIR installer
119
120    - To build from local GIT repos
121
122      make -f build-aux/speedo.mk WHAT=git TARBALLS=TARDIR installer
123
124    Note that also you need to supply tarballs with supporting
125    libraries even if you build from git.  The makefile expects only
126    the core GnuPG software to be available as local GIT repositories.
127    speedo.mk has the versions of the tarballs and the branch names of
128    the git repositories.  In case of problems, don't hesitate to ask
129    on the gnupg-devel mailing for help.
130
131
132 * Debug hints
133
134   See the manual for some hints.
135
136 * Standards
137 ** RFCs
138
139 1423  Privacy Enhancement for Internet Electronic Mail:
140       Part III: Algorithms, Modes, and Identifiers.
141
142 1489  Registration of a Cyrillic Character Set.
143
144 1750  Randomness Recommendations for Security.
145
146 1991  PGP Message Exchange Formats (obsolete)
147
148 2144  The CAST-128 Encryption Algorithm.
149
150 2279  UTF-8, a transformation format of ISO 10646.
151
152 2440  OpenPGP (obsolete).
153
154 3156  MIME Security with Pretty Good Privacy (PGP).
155
156 4880  Current OpenPGP specification.
157
158 6337  Elliptic Curve Cryptography (ECC) in OpenPGP
159
160 * Various information
161
162 ** Directory Layout
163
164   - ./        :: Readme, configure
165   - ./agent   :: Gpg-agent and related tools
166   - ./doc     :: Documentation
167   - ./g10     :: Gpg program here called gpg2
168   - ./sm      :: Gpgsm program
169   - ./jnlib   :: Not used (formerly used utility functions)
170   - ./common  :: Utility functions
171   - ./kbx     :: Keybox library
172   - ./scd     :: Smartcard daemon
173   - ./scripts :: Scripts needed by configure and others
174   - ./dirmngr :: The directory manager
175
176 ** Detailed Roadmap
177
178   This list of file is not up to date!
179
180   - g10/gpg.c :: Main module with option parsing and all the stuff you
181                  have to do on startup.  Also has the exout handler
182                  and some helper functions.
183
184   - g10/sign.c :: Create signature and optionally encrypt
185
186   - g10/parse-packet.c ::
187   - g10/build-packet.c ::
188   - g10/free-packet.c :: Parsing and creating of OpenPGP message packets.
189
190   - g10/getkey.c   :: Key selection code
191   - g10/pkclist.c  :: Build a list of public keys
192   - g10/skclist.c  :: Build a list of secret keys
193   - g10/ringedit.c :: Keyring I/O
194   - g10/keydb.h    ::
195
196   - g10/keyid.c :: Helper functions to get the keyid, fingerprint etc.
197
198
199   - g10/trustdb.c ::
200   - g10/trustdb.h ::
201   - g10/tdbdump.c :: Management of the trustdb.gpg
202   - g10/tdbio.c   ::
203   - g10/tdbio.h   :: I/O handling for the trustdb.gpg
204
205   - g10/compress.c :: Filter to handle compression
206   - g10/filter.h   :: Declarations for all filter functions
207   - g10/delkey.c   :: Delete a key
208   - g10/kbnode.c   :: Helper for the KBNODE linked list
209   - g10/main.h     :: Prototypes and some constants
210   - g10/mainproc.c :: Message processing
211   - g10/armor.c    :: Ascii armor filter
212   - g10/mdfilter.c :: Filter to calculate hashs
213   - g10/textfilter.c :: Filter to handle CR/LF and trailing white space
214   - g10/cipher.c   :: En-/Decryption filter
215   - g10/misc.c     :: Utlity functions
216   - g10/options.h  :: Structure with all the command line options
217                       and related constants
218   - g10/openfile.c :: Create/Open Files
219   - g10/hkp.h      :: Keyserver access
220   - g10/hkp.c      :: Ditto.
221   - g10/packet.h   :: Defintion of OpenPGP structures.
222   - g10/passphrase.c :: Passphrase handling code
223
224   - g10/pubkey-enc.c ::
225   - g10/seckey-cert.c ::
226   - g10/seskey.c     ::
227   - g10/import.c     ::
228   - g10/export.c     ::
229   - g10/comment.c    ::
230   - g10/status.c     ::
231   - g10/status.h     ::
232   - g10/sign.c       ::
233   - g10/plaintext.c  ::
234   - g10/encr-data.c  ::
235   - g10/encode.c     ::
236   - g10/revoke.c     ::
237   - g10/keylist.c    ::
238   - g10/sig-check.c  ::
239   - g10/signal.c     ::
240   - g10/helptext.c   ::
241   - g10/verify.c     ::
242   - g10/decrypt.c    ::
243   - g10/keyedit.c    ::
244   - g10/dearmor.c    ::
245   - g10/keygen.c     ::
246
247 ** Memory allocation
248
249 Use only the functions:
250
251  - xmalloc
252  - xmalloc_secure
253  - xtrymalloc
254  - xtrymalloc_secure
255  - xcalloc
256  - xcalloc_secure
257  - xtrycalloc
258  - xtrycalloc_secure
259  - xrealloc
260  - xtryrealloc
261  - xstrdup
262  - xtrystrdup
263  - xfree
264
265
266 The *secure versions allocated memory in the secure memory. That is,
267 swapping out of this memory is avoided and is gets overwritten on
268 free.  Use this for passphrases, session keys and other sensitive
269 material.  This memory set aside for secure memory is linited to a few
270 k.  In general the function don't print a memeory message and
271 terminate the process if there is not enough memory available.  The
272 "try" versions of the functions return NULL instead.
273
274 ** Logging
275
276  TODO
277
278 ** Option parsing
279
280 GnuPG does not use getopt or GNU getopt but functions of it's own.
281 See util/argparse.c for details.  The advantage of these functions is
282 that it is more easy to display and maintain the help texts for the
283 options.  The same option table is also used to parse resource files.
284
285 ** What is an IOBUF
286
287 This is the data structure used for most I/O of gnupg. It is similar
288 to System┬áV Streams but much simpler.  Because OpenPGP messages are
289 nested in different ways; the use of such a system has big advantages.
290 Here is an example, how it works: If the parser sees a packet header
291 with a partial length, it pushes the block_filter onto the IOBUF to
292 handle these partial length packets: from now on you don't have to
293 worry about this.  When it sees a compressed packet it pushes the
294 uncompress filter and the next read byte is one which has already been
295 uncompressed by this filter. Same goes for enciphered packet,
296 plaintext packets and so on.  The file g10/encode.c might be a good
297 staring point to see how it is used - actually this is the other way:
298 constructing messages using pushed filters but it may be easier to
299 understand.
300
301