Add item about result structures.
[gpgme.git] / TODO
1 Hey Emacs, this is -*- outline -*- mode!
2
3 * Before release:
4 ** Return ENC_TO output in verify result.
5 ** stat call for data objects (see ABI's to break).
6
7 * ABI's to break:
8 ** I/O and User Data could be made extensible.
9 ** In gpgme_signature_t, split key ID and subkey.
10 ** Compatibility interfaces that can be removed in future versions:
11 *** gpgme_data_new_from_filepart
12 *** gpgme_data_new_from_file
13 *** gpgme_data_new_with_read_cb
14 *** gpgme_data_rewind
15 *** gpgme_op_import_ext
16 *** gpgme_get_sig_key
17 *** gpgme_get_sig_ulong_attr
18 *** gpgme_get_sig_string_attr
19 *** GPGME_SIG_STAT_*
20 *** gpgme_get_sig_status
21 *** gpgme_trust_item_release
22 *** gpgme_trust_item_get_string_attr
23 *** gpgme_trust_item_get_ulong_attr
24 *** gpgme_attr_t
25 *** All Gpgme* typedefs.
26
27 * Thread support:
28 ** Build thread modules for static linking (which just suck in the
29    desired symbols the hard way). !!
30 ** Ordering the libs is important, but libtool gets it wrong.  Argh.
31
32 * New features:
33 ** notification system
34    We need a simple notification system, probably a simple callback
35    with a string and some optional arguments.  This is for example
36    required to notify an application of a changed smartcard,  The
37    application can then do whatever is required.  There are other
38    usages too.  This notfication system should be independent of any
39    contextes of course.
40 ** --learn-code support
41    This might be integrated with import. we still need to work out how
42    to learn a card when gpg and gpgsm have support for smartcards.
43 ** set_locale for thread safe and env independent locale selection.
44 ** How to terminate a pending operation?  Something like gpgme_op_reset,
45    but where are you allowed to call it (think callback handlers).
46    Then gpgme_op_*list_end can go.
47 ** Might need a stat() for data objects and use it for length param to gpg.
48 ** Allow to export secret keys.
49 ** Implement support for photo ids.
50 ** New features requested by our dear users, but rejected or left for
51    later consideration:
52 *** Selecting the key ring, setting the version or comment in output.
53     Rejected because the naive implementation is engine specific, the
54     configuration is part of the engine's configuration or readily
55     worked around in a different way
56 *** Selecting the symmetric cipher.
57 *** Exchanging keys with key servers.
58
59 * Documentation
60 ** Document validity and trust issues.
61
62 * Engines
63 ** Do not create/destroy engines, but create engine and then reset it.
64    Internally the reset operation still spawns a new engine process,
65    but this can be replaced with a reset later.  Also, be very sure to
66    release everything properly at a reset and at an error.  Think hard
67    about where to guarantee what (ie, what happens if start fails, are
68    the fds unregistered immediately - i think so?)
69 ** Optimize the case where a data object has an underlying fd we can pass
70    directly to the engine.
71 ** Move code common to all engines up from gpg to engine.
72 ** engine operations can return General Error on unknown protocol
73    (it's an internal error, as select_protocol checks already).
74 ** When server mode is implemented properly, more care has to be taken to
75    release all resources on error (for example to free assuan_cmd).
76
77 * Operations
78 ** If an operation failed, make sure that the result functions don't return
79    corrupt partial information. !!!
80 ** If no passphrase cb is installed, status handler is not run even if
81    password is required by crypto engine. !!
82 ** Export status handler need much more work. !!!
83 ** Import should return a useful error when one happened.
84 *** Import does not take notice of NODATA status report.
85 *** When GPGSM does issue IMPORT_OK status reports, make sure to check for them
86     in tests/gpgs m/t-import.c.
87 ** Genkey should return something more useful than General_Error.
88 ** Decrypt:
89    On Fri, Jun 27, 2003 at 06:28:23PM +0200, Heiko Abraham wrote:
90    > I have a cipher text and I use 'gpgme_op_decrypt_verify(..)'
91    > for decrypt and get the plaintext. But also I wish a list
92    > of all reciepient, that can also decrypt this file.
93    >
94    > If I store the file and check it with 'gpg --list-packets ${filename}'
95    > then I will become also a recipient-list.
96    > It this also possible with gpgme?
97
98    Currently not, but it is easy to add this to GPGME 0.4.1.  At least the key
99    ID and a user ID hint is available from gpg (of course key IDs are not
100    necessarily unique!).  I will put it on the TODO list.
101 ** If possible, use --file-setsize to set the file size for proper progress
102    callback handling.
103 ** Optimize the file descriptor list, so the number of open fds is
104    always known easily.
105 ** Encryption: It should be verified that the behaviour for partially untrusted
106    recipients is correct.
107 ** When GPG issues INV_something for invalid signers, catch them.
108
109 * Error Values
110 ** Map ASSUAN/GpgSM ERR error values in a better way than is done now. !!
111 ** Some error values should identify the source more correctly (mostly error
112    values derived from status messages).
113
114 * Tests
115 ** Write a fake gpg-agent so that we can supply known passphrases to
116    gpgsm and setup the configuration files to use the agent.  Without
117    this we are testing a currently running gpg-agent which is not a
118    clever idea. !
119 ** t-data
120 *** Test gpgme_data_release_and_get_mem.
121 *** Test gpgme_data_seek for invalid types.
122
123 * Debug
124 ** Handle malloc and vasprintf errors.  But decide first if they should be
125    ignored (and logged with 255?!), or really be assertions. !
126
127 * Build suite
128 ** Make sure everything is cleaned correctly (esp. test area).