Some bug fixes of the last release
[gnupg.git] / doc / HACKING
1                       A Hacker's Guide to GNUPG
2                    ================================
3                    (Some notes on GNUPG internals.)
4
5
6                    ===> Under construction <=======
7
8
9 CVS Access
10 ==========
11 Anonymous read-only CVS access is available:
12
13   cvs -d :pserver:anonymous@ftp.guug.de:/home/koch/cvs login
14
15 use the password "anonymous".  To check out the the complete
16 archive use:
17
18   cvs -d :pserver:anonymous@ftp.guug.de:/home/koch/cvs checkout gnupg
19
20 This service is provided to help you in hunting bugs and not to deliver
21 stable snapshots; it may happen that it even does not compile, so please
22 don't complain. CVS may put a high load on a server, so please don't poll
23 poll for new updates but wait for an anouncement; to receive this you may
24 want to subscribe to:
25
26     gnupg-commit-watchers@isil.d.shuttle.de
27
28 by sending a mail with "subscribe" in the body to
29
30     gnupg-commit-watchers-request@isil.d.shuttle.de
31
32
33 Please run scripts/autogen.sh to create some required files.
34
35
36 RFCs
37 ====
38
39 1423  Privacy Enhancement for Internet Electronic Mail:
40       Part III: Algorithms, Modes, and Identifiers.
41
42 1489  Registration of a Cyrillic Character Set.
43
44 1750  Randomness Recommendations for Security.
45
46 1991  PGP Message Exchange Formats.
47
48 2015  MIME Security with Pretty Good Privacy (PGP).
49
50 2144  The CAST-128 Encryption Algorithm.
51
52 2279  UTF-8, a transformation format of ISO 10646.
53
54
55
56
57 Memory allocation
58 -----------------
59 Use only the functions:
60
61     m_alloc()
62     m_alloc_clear()
63     m_strdup()
64     m_free()
65
66 If you want to store a passphrase or some other sensitive data you may
67 want to use m_alloc_secure() instead of m_alloc(), as this puts the data
68 into a memory region which is protected from swapping (on some platforms).
69 m_free() works for both.  This functions will not return if there is not
70 enough memory available.
71
72
73
74 Logging
75 -------
76
77
78
79
80
81
82 Option parsing
83 ---------------
84 GNUPG does not use getopt or GNU getopt but functions of it's own.  See
85 util/argparse.c for details.  The advantage of these funtions is that
86 it is more easy to display and maintain the help texts for the options.
87 The same option table is also used to parse resource files.
88
89
90
91 What is an iobuf
92 ----------------
93 This is the data structure used for most I/O of gnupg.  It is similiar
94 to System V Streams but much simpler.  It should be replaced by a cleaner
95 and faster implementation.  We are doing to much copying and the semantics
96 of "filter" removing are not very clean.  EOF handling is also a problem.
97
98
99
100 How to use the message digest functions
101 ---------------------------------------
102 cipher/md.c implements an interface to hash (message diesgt functions).
103
104 a) If you have a common part of data and some variable parts
105    and you need to hash of the concatenated parts, you can use this:
106         md = md_open(...)
107         md_write( md,  common_part )
108         md1 = md_copy( md )
109         md_write(md1, part1)
110         md_final(md1);
111         digest1 = md_read(md1)
112         md2 = md_copy( md )
113         md_write(md2, part2)
114         md_final(md2);
115         digest2 = md_read(md2)
116
117    An example are key signatures; the key packet is the common part
118    and the user-id packets are the variable parts.
119
120 b) If you need a running digest you should use this:
121         md = md_open(...)
122         md_write( md, part1 )
123         digest_of_part1 = md_digest( md );
124         md_write( md, part2 )
125         digest_of_part1_cat_part2 = md_digest( md );
126         ....
127
128 Both methods may be combined. [Please see the source for the real syntax]
129
130
131
132
133 How to use the cipher functions
134 -------------------------------
135
136
137
138
139 How to use the public key functions
140 -----------------------------------
141
142