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