2009-10-20 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / TODO
1 Hey Emacs, this is -*- org -*- mode!
2
3 * IMPORTANT
4 ** When using descriptor passing, we need to set the fd to blocking before
5    issueing simple commands, because we are mixing synchronous
6    commands into potentially asynchronous operations.
7 ** Might want to implement nonblock for w32 native backend!  Right now,
8    we block reading the next line with assuan.
9
10 * Before release:
11 ** Some gpg tests fail with gpg 1.3.4-cvs (gpg/t-keylist-sig)
12    The test is currently disabled there and in gpg/t-import.
13 ** When gpg supports it, write binary subpackets directly,
14    and parse SUBPACKET status lines.
15
16 * ABI's to break:
17 ** Implementation: Remove support for old style error codes in
18    conversion.c::_gpgme_map_gnupg_error.
19 ** gpgme_edit_cb_t: Add "processed" return argument
20    (see edit.c::command_handler).
21 ** I/O and User Data could be made extensible.  But this can be done
22    without breaking the ABI hopefully.
23 ** All enums should be replaced by ints and simple macros for
24    maximum compatibility.
25 ** Compatibility interfaces that can be removed in future versions:
26 *** gpgme_data_new_from_filepart
27 *** gpgme_data_new_from_file
28 *** gpgme_data_new_with_read_cb
29 *** gpgme_data_rewind
30 *** gpgme_op_import_ext
31 *** gpgme_get_sig_key
32 *** gpgme_get_sig_ulong_attr
33 *** gpgme_get_sig_string_attr
34 *** GPGME_SIG_STAT_*
35 *** gpgme_get_sig_status
36 *** gpgme_trust_item_release
37 *** gpgme_trust_item_get_string_attr
38 *** gpgme_trust_item_get_ulong_attr
39 *** gpgme_attr_t
40 *** All Gpgme* typedefs.
41
42
43 * Thread support:
44 ** When GNU Pth supports sendmsg/recvmsg, wrap them properly.
45 ** Without timegm (3) support our ISO time parser is not thread safe.
46    There is a configure time warning, though.
47
48 * New features:
49 ** Flow control for data objects.
50    Currently, gpgme_data_t objects are assumed to be blocking.  To
51    break this assumption, we need either (A) a way for an user I/O
52    callback to store the current operation in a continuation that can
53    be resumed later.  While the continuation exists, file descriptors
54    associated with this operation must be removed from their
55    respective event loop.  or (B) a way for gpgme data objects to be
56    associated with a waitable object, that can be registered with the
57    user event loop.  Neither is particularly simple.
58 ** Extended notation support.  When gpg supports arbitrary binary
59    notation data, provide a user interface for that.
60 ** notification system
61    We need a simple notification system, probably a simple callback
62    with a string and some optional arguments.  This is for example
63    required to notify an application of a changed smartcard, The
64    application can then do whatever is required.  There are other
65    usages too.  This notfication system should be independent of any
66    contextes of course.
67
68    Not sure whether this is still required.  GPGME_PROTOCOL_ASSUAN is
69    sufficient for this.
70
71 ** --learn-code support
72    This might be integrated with import. we still need to work out how
73    to learn a card when gpg and gpgsm have support for smartcards.  In
74    GPA we currently invoke gpg directly.
75
76 ** Might need a stat() for data objects and use it for length param to gpg.
77 ** Implement support for photo ids.
78 ** Allow selection of subkeys
79 ** Allow to return time stamps in ISO format
80   This allows us to handle years later than 2037 properly.  With the
81   time_t interface they are all mapped to 2037-12-31
82 ** New features requested by our dear users, but rejected or left for
83    later consideration:
84 *** Allow to export secret keys.
85     Rejected because this is conceptually flawed.  Secret keys on a
86     smart card can not be exported, for example.
87     May eventually e supproted with a keywrapping system.
88 *** Selecting the key ring, setting the version or comment in output.
89     Rejected because the naive implementation is engine specific, the
90     configuration is part of the engine's configuration or readily
91     worked around in a different way
92 *** Selecting the symmetric cipher.
93 *** Exchanging keys with key servers.
94
95 * Documentation
96 ** Document validity and trust issues.
97 ** In gpgme.texi: Register callbacks under the right letter in the index.
98
99 * Engines
100 ** Do not create/destroy engines, but create engine and then reset it.
101    Internally the reset operation still spawns a new engine process,
102    but this can be replaced with a reset later.  Also, be very sure to
103    release everything properly at a reset and at an error.  Think hard
104    about where to guarantee what (ie, what happens if start fails, are
105    the fds unregistered immediately - i think so?)
106    Note that we need support in gpgsm to set include-certs to default
107    as RESET does not reset it.
108 ** Optimize the case where a data object has an underlying fd we can pass
109    directly to the engine.  This will be automatic with socket I/O and
110    descriptor passing.
111 ** Move code common to all engines up from gpg to engine.
112 ** engine operations can return General Error on unknown protocol
113    (it's an internal error, as select_protocol checks already).
114 ** When server mode is implemented properly, more care has to be taken to
115    release all resources on error (for example to free assuan_cmd).
116 ** op_import_keys and op_export_keys have a limit ion the number of keys.
117    This is because we pass them in gpg via the command line and gpgsm
118    via an assuan control line.  We should pipe them instead and maybe
119    change gpg/gpgsm to not put them in memory.
120
121 * GPG breakage:
122 ** gpg 1.4.2 lacks error reporting if sign/encrypt with revoked key.
123 ** gpg 1.4.2 does crappy error reporting (namely none at all) when
124    smart card is missing for sign operation:
125     [GNUPG:] CARDCTRL 4
126     gpg: selecting openpgp failed: ec=6.110
127     gpg: signing failed: general error
128     [GNUPG:] BEGIN_ENCRYPTION 2 10
129     gpg: test: sign+encrypt failed: general error
130 ** Without agent and with wrong passphrase, gpg 1.4.2 enters into an
131    infinite loop.
132 ** Use correct argv[0]
133    In rungpg.c:build_argv we use
134       argv[argc] = strdup ("gpg"); /* argv[0] */
135    This should be changed to take the real file name used in account.
136
137
138 * Operations
139 ** Include cert values -2, -1, 0 and 1 should be defined as macros.
140 ** If an operation failed, make sure that the result functions don't return
141    corrupt partial information. !!!
142    NOTE: The EOF status handler is not called in this case !!!
143 ** Verify must not fail on NODATA premature if auto-key-retrieval failed.
144    It should not fail silently if it knows there is an error. !!!
145 ** All operations: Better error reporting. !!
146 ** Export status handler need much more work. !!!
147 ** Import should return a useful error when one happened.
148 *** Import does not take notice of NODATA status report.
149 *** When GPGSM does issue IMPORT_OK status reports, make sure to check for
150     them in tests/gpgs m/t-import.c.
151 ** Verify can include info about version/algo/class, but currently
152    this is only available for gpg, not gpgsm.
153 ** Return ENC_TO output in verify result.  Again, this is not available
154    for gpgsm.
155 ** Genkey should return something more useful than General_Error.
156 ** If possible, use --file-setsize to set the file size for proper progress
157    callback handling.  Write data interface for file size.
158 ** Optimize the file descriptor list, so the number of open fds is
159    always known easily.
160 ** Encryption: It should be verified that the behaviour for partially untrusted
161    recipients is correct.
162 ** When GPG issues INV_something for invalid signers, catch them.
163
164 * Error Values
165 ** Map ASSUAN/GpgSM ERR error values in a better way than is done now. !!
166 ** Some error values should identify the source more correctly (mostly error
167    values derived from status messages).
168 ** In rungpg.c we need to check the version of the engine
169    This requires a way to get the cached version number from the
170    engine layer.
171
172
173 * Tests
174 ** Write a fake gpg-agent so that we can supply known passphrases to
175    gpgsm and setup the configuration files to use the agent.  Without
176    this we are testing a currently running gpg-agent which is not a
177    clever idea. !
178 ** t-data
179 *** Test gpgme_data_release_and_get_mem.
180 *** Test gpgme_data_seek for invalid types.
181 ** t-keylist
182    Write a test for ext_keylist.
183 ** Test reading key signatures.
184
185 * Debug
186 ** Tracepoints should be added at: Every public interface enter/leave,
187    before and in every callback, at major decision points, at every
188    internal data point which might easily be observed by the outside
189    (system handles).  We also trace handles and I/O support threads in
190    the w32 implementation because that's fragile code.
191    Files left to do:
192    data-fd.c data-mem.c data-stream.c data-user.c debug.c rungpg.c
193    engine.c engine-gpgsm.c funopen.c w32-glib-io.c wait.c
194    wait-global.c wait-private.c wait-user.c op-support.c decrypt.c
195    decrypt-verify.c delete.c edit.c encrypt.c encrypt-sign.c export.c
196    genkey.c import.c key.c keylist.c passphrase.c progress.c signers.c
197    sig-notation.c trust-item.c trustlist.c verify.c
198 ** Handle malloc and vasprintf errors.  But decide first if they should be
199    ignored (and logged with 255?!), or really be assertions. !
200
201 * Build suite
202 ** Make sure everything is cleaned correctly (esp. test area).
203 ** Enable AC_CONFIG_MACRO_DIR and bump up autoconf version requirement.
204    (To fix "./autogen.sh; ./configure --enable-maintainer-mode; touch
205    configure.ac; make").  Currently worked around with ACLOCAL_AMFLAGS???
206
207 * Error checking 
208 ** engine-gpgsm, with-validation
209    Add error checking some time after releasing a new gpgsm.
210
211
212 Copyright 2004, 2005 g10 Code GmbH
213
214 This file is free software; as a special exception the author gives
215 unlimited permission to copy and/or distribute it, with or without
216 modifications, as long as this notice is preserved.
217
218 This file is distributed in the hope that it will be useful, but
219 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
220 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
221 PURPOSE.