gpg: New status code NOTATION_FLAGS.
[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 The one-line summary usually starts with a keyword to identify the
36 mainly affected subsystem.  If more than one keyword is required the
37 are delimited by a comma (e.g. =scd,w32:=). Commonly found keywords
38 are
39
40  - agent   :: The gpg-agent component
41  - ssh     :: The ssh-agent part of the agent
42  - common  :: Code in common
43  - iobuf   :: The IOBUF system in common
44  - gpg     :: The gpg or gpgv components
45  - gpgsm   :: The gpgsm component
46  - scd     :: The scdaemon component
47  - ccid    :: The CCID driver in scdaemon
48  - dirmngr :: The dirmngr component
49  - w32     :: Windows related code
50  - po      :: Translations
51  - build   :: Changes to the build system
52  - speedo  :: Speedo build system specific changes
53  - doc     :: Documentation changes
54  - indent  :: Indentation and similar changes
55
56 Typo fixes and documentation updates don't need a ChangeLog entry;
57 thus you would use a commit message like
58
59 #+begin_example
60 Fix typo in a comment
61
62 --
63 #+end_example
64
65 The marker line here is important; without it the first line would
66 appear in the ChangeLog.
67
68 If you exceptionally need to have longer lines in a commit log you may
69 do this after this scissor line:
70 #+begin_example
71 # ------------------------ >8 ------------------------
72 #+end_example
73 (hash, blank, 24 dashes, blank, scissor, blank, 24 dashes).
74 Note that such a comment will be removed if the git commit option
75 =--cleanup=scissor= is used.
76
77 ** License policy
78
79   GnuPG is licensed under the GPLv3+ with some files under a mixed
80   LGPLv3+/GPLv2+ license.  It is thus important, that all contributed
81   code allows for an update of the license; for example we can't
82   accept code under the GPLv2(only).
83
84   GnuPG used to have a strict policy of requiring copyright
85   assignments to the FSF.  To avoid this major organizational overhead
86   and to allow inclusion of code, not copyrighted by the FSF, this
87   policy has been relaxed on 2013-03-29.  It is now also possible to
88   contribute code by asserting that the contribution is in accordance
89   to the "Libgcrypt Developer's Certificate of Origin" as found in the
90   file "DCO".  (Except for a slight wording change, this DCO is
91   identical to the one used by the Linux kernel.)
92
93   If you want to contribute code or documentation to GnuPG and you
94   didn't sign a copyright assignment with the FSF in the past, you
95   need to take these simple steps:
96
97   - Decide which mail address you want to use.  Please have your real
98     name in the address and not a pseudonym.  Anonymous contributions
99     can only be done if you find a proxy who certifies for you.
100
101   - If your employer or school might claim ownership of code written
102     by you; you need to talk to them to make sure that you have the
103     right to contribute under the DCO.
104
105   - Send an OpenPGP signed mail to the gnupg-devel@gnupg.org mailing
106     list from your mail address.  Include a copy of the DCO as found
107     in the official master branch.  Insert your name and email address
108     into the DCO in the same way you want to use it later.  Example:
109
110       Signed-off-by: Joe R. Hacker <joe@example.org>
111
112     (If you really need it, you may perform simple transformations of
113     the mail address: Replacing "@" by " at " or "." by " dot ".)
114
115   - That's it.  From now on you only need to add a "Signed-off-by:"
116     line with your name and mail address to the commit message.  It is
117     recommended to send the patches using a PGP/MIME signed mail.
118
119 ** Coding standards
120
121   Please follow the GNU coding standards.  If you are in doubt consult
122   the existing code as an example.  Do no re-indent code without a
123   need.  If you really need to do it, use a separate commit for such a
124   change.
125
126   - Only certain C99 features may be used (see below); in general
127     stick to C90.
128   - Please do not use C++ =//= style comments.
129   - Try to fit lines into 80 columns.
130   - Ignore signed/unsigned pointer mismatches
131   - No arithmetic on void pointers; cast to char* first.
132   - We use our own printf style functions like =es_printf=, and
133     =gpgrt_asprintf= (or the =es_asprintf= macro) which implement most
134     C99 features with the exception of =wchar_t= (which should anyway
135     not be used).  Please use them always and do not resort to those
136     provided by libc.  The rationale for using them is that we know
137     that the format specifiers work on all platforms and that we do
138     not need to chase platform dependent bugs.  Note also that in
139     gnupg asprintf is a macro already evaluating to gpgrt_asprintf.
140   - It is common to have a label named "leave" for a function's
141     cleanup and return code.  This helps with freeing memory and is a
142     convenient location to set a breakpoint for debugging.
143   - Always use xfree() instead of free().  If it is not easy to see
144     that the freed variable is not anymore used, explicitly set the
145     variable to NULL.
146   - Init function local variables only if needed so that the compiler
147     can do a better job in detecting uninitialized variables which may
148     indicate a problem with the code.
149   - Never init static or file local variables to 0 to make sure they
150     end up in BSS.
151   - Use --enable-maintainer-mode with configure.
152
153 ** Variable names
154
155   Follow the GNU standards.  Here are some conventions you may want to
156   stick to (do not rename existing "wrong" uses without a goog
157   reason).
158
159   - err :: This conveys an error code of type =gpg_error_t= which is
160            compatible to an =int=.  To compare such a variable to a
161            GPG_ERR_ constant, it is necessary to map the value like
162            this: =gpg_err_code(err)=.
163   - ec  :: This is used for a gpg-error code which has no source part
164            (=gpg_err_code_t=) and will eventually be used as input to
165            =gpg_err_make=.
166   - rc  :: Used for all kind of other errors; for example system
167            calls.  The value is not compatible with gpg-error.
168
169
170 *** C99 language features
171
172   In GnuPG 2.x, but *not in 1.4* and not in most libraries, a limited
173   set of C99 features may be used:
174
175   - Variadic macros:
176     : #define foo(a,...)  bar(a, __VA_ARGS__)
177
178   - The predefined macro =__func__=:
179     : log_debug ("%s: Problem with foo\n", __func__);
180
181   - Variable declaration inside a for():
182     : for (int i = 0; i < 5; ++)
183     :   bar (i);
184
185   Although we usually make use of the =u16=, =u32=, and =u64= types,
186   it is also possible to include =<stdint.h>= and use =int16_t=,
187   =int32_t=, =int64_t=, =uint16_t=, =uint32_t=, and =uint64_t=.  But do
188   not use =int8_t= or =uint8_t=.
189
190 ** Commit log keywords
191
192   - GnuPG-bug-id :: Values are comma or space delimited bug numbers
193                     from bug.gnupg.org pertaining to this commit.
194   - Debian-bug-id :: Same as above but from the Debian bug tracker.
195   - CVE-id :: CVE id number pertaining to this commit.
196   - Regression-due-to :: Commit id of the regression fixed by this commit.
197   - Fixes-commit :: Commit id this commit fixes.
198   - Reported-by :: Value is a name or mail address of a bug reporte.
199   - Suggested-by :: Value is a name or mail address of someone how
200                     suggested this change.
201   - Co-authored-by :: Name or mail address of a co-author
202   - Some-comments-by :: Name or mail address of the author of
203                         additional comments (commit log or code).
204   - Proofread-by :: Sometimes used by translation commits.
205   - Signed-off-by :: Name or mail address of the developer
206
207 * Windows
208 ** How to build an installer for Windows
209
210    Your best bet is to use a decent Debian System for development.
211    You need to install a long list of tools for building.  This list
212    still needs to be compiled.  However, the build process will stop
213    if a tool is missing.  GNU make is required (on non GNU systems
214    often installed as "gmake").  The installer requires a couple of
215    extra software to be available either as tarballs or as local git
216    repositories.  In case this file here is part of a gnupg-w32-2.*.xz
217    complete tarball as distributed from the same place as a binary
218    installer, all such tarballs are already included.
219
220    Cd to the GnuPG source directory and use one of one of these
221    command:
222
223    - If sources are included (gnupg-w32-*.tar.xz)
224
225      make -f build-aux/speedo.mk WHAT=this installer
226
227    - To build from tarballs
228
229      make -f build-aux/speedo.mk WHAT=release TARBALLS=TARDIR installer
230
231    - To build from local GIT repos
232
233      make -f build-aux/speedo.mk WHAT=git TARBALLS=TARDIR installer
234
235    Note that also you need to supply tarballs with supporting
236    libraries even if you build from git.  The makefile expects only
237    the core GnuPG software to be available as local GIT repositories.
238    speedo.mk has the versions of the tarballs and the branch names of
239    the git repositories.  In case of problems, don't hesitate to ask
240    on the gnupg-devel mailing for help.
241
242 * Debug hints
243
244   See the manual for some hints.
245
246 * Standards
247 ** RFCs
248
249 1423  Privacy Enhancement for Internet Electronic Mail:
250       Part III: Algorithms, Modes, and Identifiers.
251
252 1489  Registration of a Cyrillic Character Set.
253
254 1750  Randomness Recommendations for Security.
255
256 1991  PGP Message Exchange Formats (obsolete)
257
258 2144  The CAST-128 Encryption Algorithm.
259
260 2279  UTF-8, a transformation format of ISO 10646.
261
262 2440  OpenPGP (obsolete).
263
264 3156  MIME Security with Pretty Good Privacy (PGP).
265
266 4880  Current OpenPGP specification.
267
268 6337  Elliptic Curve Cryptography (ECC) in OpenPGP
269
270 * Various information
271
272 ** Directory Layout
273
274   - ./        :: Readme, configure
275   - ./agent   :: Gpg-agent and related tools
276   - ./doc     :: Documentation
277   - ./g10     :: Gpg program here called gpg2
278   - ./sm      :: Gpgsm program
279   - ./jnlib   :: Not used (formerly used utility functions)
280   - ./common  :: Utility functions
281   - ./kbx     :: Keybox library
282   - ./scd     :: Smartcard daemon
283   - ./scripts :: Scripts needed by configure and others
284   - ./dirmngr :: The directory manager
285
286 ** Detailed Roadmap
287
288   This list of files is not up to date!
289
290   - g10/gpg.c :: Main module with option parsing and all the stuff you
291                  have to do on startup.  Also has the exit handler and
292                  some helper functions.
293
294   - g10/parse-packet.c ::
295   - g10/build-packet.c ::
296   - g10/free-packet.c :: Parsing and creating of OpenPGP message packets.
297
298   - g10/getkey.c   :: Key selection code
299   - g10/pkclist.c  :: Build a list of public keys
300   - g10/skclist.c  :: Build a list of secret keys
301   - g10/keyring.c  :: Keyring access functions
302   - g10/keydb.h    ::
303
304   - g10/keyid.c   :: Helper functions to get the keyid, fingerprint etc.
305
306   - g10/trustdb.c :: Web-of-Trust computations
307   - g10/trustdb.h ::
308   - g10/tdbdump.c :: Export/import/list the trustdb.gpg
309   - g10/tdbio.c   :: I/O handling for the trustdb.gpg
310   - g10/tdbio.h   ::
311
312   - g10/compress.c :: Filter to handle compression
313   - g10/filter.h   :: Declarations for all filter functions
314   - g10/delkey.c   :: Delete a key
315   - g10/kbnode.c   :: Helper for the kbnode_t linked list
316   - g10/main.h     :: Prototypes and some constants
317   - g10/mainproc.c :: Message processing
318   - g10/armor.c    :: Ascii armor filter
319   - g10/mdfilter.c :: Filter to calculate hashs
320   - g10/textfilter.c :: Filter to handle CR/LF and trailing white space
321   - g10/cipher.c   :: En-/Decryption filter
322   - g10/misc.c     :: Utlity functions
323   - g10/options.h  :: Structure with all the command line options
324                       and related constants
325   - g10/openfile.c :: Create/Open Files
326   - g10/keyserver.h :: Keyserver access dispatcher.
327   - g10/packet.h   :: Defintion of OpenPGP structures.
328   - g10/passphrase.c :: Passphrase handling code
329
330   - g10/pubkey-enc.c :: Process a public key encoded packet.
331   - g10/seckey-cert.c :: Not anymore used
332   - g10/seskey.c     :: Make sesssion keys etc.
333   - g10/import.c     :: Import keys into our key storage.
334   - g10/export.c     :: Export keys to the OpenPGP format.
335   - g10/sign.c       :: Create signature and optionally encrypt.
336   - g10/plaintext.c  :: Process plaintext packets.
337   - g10/decrypt-data.c :: Decrypt an encrypted data packet
338   - g10/encrypt.c    :: Main encryption driver
339   - g10/revoke.c     :: Create recovation certificates.
340   - g10/keylist.c    :: Print information about OpenPGP keys
341   - g10/sig-check.c  :: Check a signature
342   - g10/helptext.c   :: Show online help texts
343   - g10/verify.c     :: Verify signed data.
344   - g10/decrypt.c    :: Decrypt and verify data.
345   - g10/keyedit.c    :: Edit properties of a key.
346   - g10/dearmor.c    :: Armor utility.
347   - g10/keygen.c     :: Generate a key pair
348
349 ** Memory allocation
350
351 Use only the functions:
352
353  - xmalloc
354  - xmalloc_secure
355  - xtrymalloc
356  - xtrymalloc_secure
357  - xcalloc
358  - xcalloc_secure
359  - xtrycalloc
360  - xtrycalloc_secure
361  - xrealloc
362  - xtryrealloc
363  - xstrdup
364  - xtrystrdup
365  - xfree
366
367
368 The *secure versions allocate memory in the secure memory.  That is,
369 swapping out of this memory is avoided and is gets overwritten on
370 free.  Use this for passphrases, session keys and other sensitive
371 material.  This memory set aside for secure memory is linited to a few
372 k.  In general the function don't print a memeory message and
373 terminate the process if there is not enough memory available.  The
374 "try" versions of the functions return NULL instead.
375
376 ** Logging
377
378  TODO
379
380 ** Option parsing
381
382 GnuPG does not use getopt or GNU getopt but functions of it's own.
383 See util/argparse.c for details.  The advantage of these functions is
384 that it is more easy to display and maintain the help texts for the
385 options.  The same option table is also used to parse resource files.
386
387 ** What is an IOBUF
388
389 This is the data structure used for most I/O of gnupg. It is similar
390 to System┬áV Streams but much simpler.  Because OpenPGP messages are
391 nested in different ways; the use of such a system has big advantages.
392 Here is an example, how it works: If the parser sees a packet header
393 with a partial length, it pushes the block_filter onto the IOBUF to
394 handle these partial length packets: from now on you don't have to
395 worry about this.  When it sees a compressed packet it pushes the
396 uncompress filter and the next read byte is one which has already been
397 uncompressed by this filter. Same goes for enciphered packet,
398 plaintext packets and so on.  The file g10/encode.c might be a good
399 starting point to see how it is used - actually this is the other way:
400 constructing messages using pushed filters but it may be easier to
401 understand.
402
403