gpg: Add new --auto-key-locate mechanism "dane".
[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
55 Typo fixes and documentation updates don't need a ChangeLog entry;
56 thus you would use a commit message like
57
58 #+begin_example
59 Fix typo in a comment
60
61 --
62 #+end_example
63
64 The marker line here is important; without it the first line would
65 appear in the ChangeLog.
66
67 If you exceptionally need to have longer lines in a commit log you may
68 do this after this scissor line:
69 #+begin_example
70 # ------------------------ >8 ------------------------
71 #+end_example
72 (hash, blank, 24 dashes, blank, scissor, blank, 24 dashes).
73 Note that such a comment will be removed if the git commit option
74 =--cleanup=scissor= is used.
75
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   - C99 syntax should not be used; stick to C90.
127   - Please do not use C++ =//= style comments.
128   - Try to fit lines into 80 columns.
129   - Ignore signed/unsigned pointer mismatches
130   - No arithmetic on void pointers; cast to char* first.
131
132 ** Commit log keywords
133
134   - GnuPG-bug-id :: Values are comma or space delimited bug numbers
135                     from bug.gnupg.org pertaining to this commit.
136   - Debian-bug-id :: Same as above but from the Debian bug tracker.
137   - CVE-id :: CVE id number pertaining to this commit.
138   - Regression-due-to :: Commit id of the regression fixed by this commit.
139   - Fixes-commit :: Commit id this commit fixes.
140   - Reported-by :: Value is a name or mail address of a bug reporte.
141   - Suggested-by :: Value is a name or mail address of someone how
142                     suggested this change.
143   - Co-authored-by :: Name or mail address of a co-author
144   - Some-comments-by :: Name or mail address of the author of
145                         additional comments (commit log or code).
146   - Proofread-by :: Sometimes used by translation commits.
147   - Signed-off-by :: Name or mail address of the developer
148
149 * Windows
150 ** How to build an installer for Windows
151
152    Your best bet is to use a decent Debian System for development.
153    You need to install a long list of tools for building.  This list
154    still needs to be compiled.  However, the build process will stop
155    if a tool is missing.  GNU make is required (on non GNU systems
156    often installed as "gmake").  The installer requires a couple of
157    extra software to be available either as tarballs or as local git
158    repositories.  In case this file here is part of a gnupg-w32-2.*.xz
159    complete tarball as distributed from the same place as a binary
160    installer, all such tarballs are already included.
161
162    Cd to the GnuPG source directory and use one of one of these
163    command:
164
165    - If sources are included (gnupg-w32-*.tar.xz)
166
167      make -f build-aux/speedo.mk WHAT=this installer
168
169    - To build from tarballs
170
171      make -f build-aux/speedo.mk WHAT=release TARBALLS=TARDIR installer
172
173    - To build from local GIT repos
174
175      make -f build-aux/speedo.mk WHAT=git TARBALLS=TARDIR installer
176
177    Note that also you need to supply tarballs with supporting
178    libraries even if you build from git.  The makefile expects only
179    the core GnuPG software to be available as local GIT repositories.
180    speedo.mk has the versions of the tarballs and the branch names of
181    the git repositories.  In case of problems, don't hesitate to ask
182    on the gnupg-devel mailing for help.
183
184 * Debug hints
185
186   See the manual for some hints.
187
188 * Standards
189 ** RFCs
190
191 1423  Privacy Enhancement for Internet Electronic Mail:
192       Part III: Algorithms, Modes, and Identifiers.
193
194 1489  Registration of a Cyrillic Character Set.
195
196 1750  Randomness Recommendations for Security.
197
198 1991  PGP Message Exchange Formats (obsolete)
199
200 2144  The CAST-128 Encryption Algorithm.
201
202 2279  UTF-8, a transformation format of ISO 10646.
203
204 2440  OpenPGP (obsolete).
205
206 3156  MIME Security with Pretty Good Privacy (PGP).
207
208 4880  Current OpenPGP specification.
209
210 6337  Elliptic Curve Cryptography (ECC) in OpenPGP
211
212 * Various information
213
214 ** Directory Layout
215
216   - ./        :: Readme, configure
217   - ./agent   :: Gpg-agent and related tools
218   - ./doc     :: Documentation
219   - ./g10     :: Gpg program here called gpg2
220   - ./sm      :: Gpgsm program
221   - ./jnlib   :: Not used (formerly used utility functions)
222   - ./common  :: Utility functions
223   - ./kbx     :: Keybox library
224   - ./scd     :: Smartcard daemon
225   - ./scripts :: Scripts needed by configure and others
226   - ./dirmngr :: The directory manager
227
228 ** Detailed Roadmap
229
230   This list of files is not up to date!
231
232   - g10/gpg.c :: Main module with option parsing and all the stuff you
233                  have to do on startup.  Also has the exit handler and
234                  some helper functions.
235
236   - g10/parse-packet.c ::
237   - g10/build-packet.c ::
238   - g10/free-packet.c :: Parsing and creating of OpenPGP message packets.
239
240   - g10/getkey.c   :: Key selection code
241   - g10/pkclist.c  :: Build a list of public keys
242   - g10/skclist.c  :: Build a list of secret keys
243   - g10/keyring.c  :: Keyring access functions
244   - g10/keydb.h    ::
245
246   - g10/keyid.c   :: Helper functions to get the keyid, fingerprint etc.
247
248   - g10/trustdb.c :: Web-of-Trust computations
249   - g10/trustdb.h ::
250   - g10/tdbdump.c :: Export/import/list the trustdb.gpg
251   - g10/tdbio.c   :: I/O handling for the trustdb.gpg
252   - g10/tdbio.h   ::
253
254   - g10/compress.c :: Filter to handle compression
255   - g10/filter.h   :: Declarations for all filter functions
256   - g10/delkey.c   :: Delete a key
257   - g10/kbnode.c   :: Helper for the kbnode_t linked list
258   - g10/main.h     :: Prototypes and some constants
259   - g10/mainproc.c :: Message processing
260   - g10/armor.c    :: Ascii armor filter
261   - g10/mdfilter.c :: Filter to calculate hashs
262   - g10/textfilter.c :: Filter to handle CR/LF and trailing white space
263   - g10/cipher.c   :: En-/Decryption filter
264   - g10/misc.c     :: Utlity functions
265   - g10/options.h  :: Structure with all the command line options
266                       and related constants
267   - g10/openfile.c :: Create/Open Files
268   - g10/keyserver.h :: Keyserver access dispatcher.
269   - g10/packet.h   :: Defintion of OpenPGP structures.
270   - g10/passphrase.c :: Passphrase handling code
271
272   - g10/pubkey-enc.c :: Process a public key encoded packet.
273   - g10/seckey-cert.c :: Not anymore used
274   - g10/seskey.c     :: Make sesssion keys etc.
275   - g10/import.c     :: Import keys into our key storage.
276   - g10/export.c     :: Export keys to the OpenPGP format.
277   - g10/sign.c       :: Create signature and optionally encrypt.
278   - g10/plaintext.c  :: Process plaintext packets.
279   - g10/decrypt-data.c :: Decrypt an encrypted data packet
280   - g10/encrypt.c    :: Main encryption driver
281   - g10/revoke.c     :: Create recovation certificates.
282   - g10/keylist.c    :: Print information about OpenPGP keys
283   - g10/sig-check.c  :: Check a signature
284   - g10/helptext.c   :: Show online help texts
285   - g10/verify.c     :: Verify signed data.
286   - g10/decrypt.c    :: Decrypt and verify data.
287   - g10/keyedit.c    :: Edit properties of a key.
288   - g10/dearmor.c    :: Armor utility.
289   - g10/keygen.c     :: Generate a key pair
290
291 ** Memory allocation
292
293 Use only the functions:
294
295  - xmalloc
296  - xmalloc_secure
297  - xtrymalloc
298  - xtrymalloc_secure
299  - xcalloc
300  - xcalloc_secure
301  - xtrycalloc
302  - xtrycalloc_secure
303  - xrealloc
304  - xtryrealloc
305  - xstrdup
306  - xtrystrdup
307  - xfree
308
309
310 The *secure versions allocate memory in the secure memory.  That is,
311 swapping out of this memory is avoided and is gets overwritten on
312 free.  Use this for passphrases, session keys and other sensitive
313 material.  This memory set aside for secure memory is linited to a few
314 k.  In general the function don't print a memeory message and
315 terminate the process if there is not enough memory available.  The
316 "try" versions of the functions return NULL instead.
317
318 ** Logging
319
320  TODO
321
322 ** Option parsing
323
324 GnuPG does not use getopt or GNU getopt but functions of it's own.
325 See util/argparse.c for details.  The advantage of these functions is
326 that it is more easy to display and maintain the help texts for the
327 options.  The same option table is also used to parse resource files.
328
329 ** What is an IOBUF
330
331 This is the data structure used for most I/O of gnupg. It is similar
332 to System┬áV Streams but much simpler.  Because OpenPGP messages are
333 nested in different ways; the use of such a system has big advantages.
334 Here is an example, how it works: If the parser sees a packet header
335 with a partial length, it pushes the block_filter onto the IOBUF to
336 handle these partial length packets: from now on you don't have to
337 worry about this.  When it sees a compressed packet it pushes the
338 uncompress filter and the next read byte is one which has already been
339 uncompressed by this filter. Same goes for enciphered packet,
340 plaintext packets and so on.  The file g10/encode.c might be a good
341 starting point to see how it is used - actually this is the other way:
342 constructing messages using pushed filters but it may be easier to
343 understand.
344
345