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