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