Removed some trash
[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 1750  Randomness Recommendations for Security.
43
44 1991  PGP Message Exchange Formats.
45
46 2015  MIME Security with Pretty Good Privacy (PGP).
47
48 2144  The CAST-128 Encryption Algorithm.
49
50
51
52
53 Memory allocation
54 -----------------
55 Use only the functions:
56
57     m_alloc()
58     m_alloc_clear()
59     m_strdup()
60     m_free()
61
62 If you want to store a passphrase or some other sensitive data you may
63 want to use m_alloc_secure() instead of m_alloc(), as this puts the data
64 into a memory region which is protected from swapping (on some platforms).
65 m_free() works for both.  This functions will not return if there is not
66 enough memory available.
67
68
69
70 Logging
71 -------
72
73
74
75
76
77
78 Option parsing
79 ---------------
80 GNUPG does not use getopt or GNU getopt but functions of it's own.  See
81 util/argparse.c for details.  The advantage of these funtions is that
82 it is more easy to display and maintain the help texts for the options.
83 The same option table is also used to parse resource files.
84
85
86
87 What is an iobuf
88 ----------------
89 This is the data structure used for most I/O of gnupg.  It is similiar
90 to System V Streams but much simpler.  It should be replaced by a cleaner
91 and faster implementation.  We are doing to much copying and the semantics
92 of "filter" removing are not very clean.  EOF handling is also a problem.
93
94
95
96 How to use the message digest functions
97 ---------------------------------------
98 cipher/md.c implements an interface to hash (message diesgt functions).
99
100 a) If you have a common part of data and some variable parts
101    and you need to hash of the concatenated parts, you can use this:
102         md = md_open(...)
103         md_write( md,  common_part )
104         md1 = md_copy( md )
105         md_write(md1, part1)
106         md_final(md1);
107         digest1 = md_read(md1)
108         md2 = md_copy( md )
109         md_write(md2, part2)
110         md_final(md2);
111         digest2 = md_read(md2)
112
113    An example are key signatures; the key packet is the common part
114    and the user-id packets are the variable parts.
115
116 b) If you need a running digest you should use this:
117         md = md_open(...)
118         md_write( md, part1 )
119         digest_of_part1 = md_digest( md );
120         md_write( md, part2 )
121         digest_of_part1_cat_part2 = md_digest( md );
122         ....
123
124 Both methods may be combined. [Please see the source for the real syntax]
125
126
127
128
129 How to use the cipher functions
130 -------------------------------
131
132
133
134
135 How to use the public key functions
136 -----------------------------------
137
138