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