Document some more problems.
[gpgme.git] / TODO
1 Hey Emacs, this is -*- outline -*- mode!
2
3 * Before release:
4 ** Write --thread option for gpgme-config.
5 ** Have automake macros for thread option.
6 ** Document new thread support.
7
8 * ABI's to break:
9 ** I/O and User Data could be made extensible.  But this can be done
10    without breaking the ABI hopefully.
11 ** Compatibility interfaces that can be removed in future versions:
12 *** ath compatibility modules.
13 *** gpgme_data_new_from_filepart
14 *** gpgme_data_new_from_file
15 *** gpgme_data_new_with_read_cb
16 *** gpgme_data_rewind
17 *** gpgme_op_import_ext
18 *** gpgme_get_sig_key
19 *** gpgme_get_sig_ulong_attr
20 *** gpgme_get_sig_string_attr
21 *** GPGME_SIG_STAT_*
22 *** gpgme_get_sig_status
23 *** gpgme_trust_item_release
24 *** gpgme_trust_item_get_string_attr
25 *** gpgme_trust_item_get_ulong_attr
26 *** gpgme_attr_t
27 *** All Gpgme* typedefs.
28
29 * Thread support:
30 ** When GNU Pth supports sendmsg/recvmsg, wrap them properly.
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.  Update: The only place where this
47    can go is returning errors from callback handlers, and a function
48    to be called for example from the user event loop code.  The user
49    must observe the threading rules!  A blocking thread can not be
50    cancelled.
51 ** Might need a stat() for data objects and use it for length param to gpg.
52 ** Allow to export secret keys.
53 ** Implement support for photo ids.
54 ** New features requested by our dear users, but rejected or left for
55    later consideration:
56 *** Selecting the key ring, setting the version or comment in output.
57     Rejected because the naive implementation is engine specific, the
58     configuration is part of the engine's configuration or readily
59     worked around in a different way
60 *** Selecting the symmetric cipher.
61 *** Exchanging keys with key servers.
62
63 * Documentation
64 ** Document validity and trust issues.
65
66 * Engines
67 ** Do not create/destroy engines, but create engine and then reset it.
68    Internally the reset operation still spawns a new engine process,
69    but this can be replaced with a reset later.  Also, be very sure to
70    release everything properly at a reset and at an error.  Think hard
71    about where to guarantee what (ie, what happens if start fails, are
72    the fds unregistered immediately - i think so?)
73 ** Optimize the case where a data object has an underlying fd we can pass
74    directly to the engine.
75 ** Move code common to all engines up from gpg to engine.
76 ** engine operations can return General Error on unknown protocol
77    (it's an internal error, as select_protocol checks already).
78 ** When server mode is implemented properly, more care has to be taken to
79    release all resources on error (for example to free assuan_cmd).
80
81 * Operations
82 ** If an operation failed, make sure that the result functions don't return
83    corrupt partial information. !!!
84    NOTE: The EOF status handler is not called in this case !!!
85 ** If no passphrase cb is installed, status handler is not run even if
86    password is required by crypto engine. !!
87 ** Verify must not fail on NODATA premature if auto-key-retrieval failed.
88    It should not fail silently if it knows there is an error. !!!
89 ** All operations: Better error reporting. !!
90 ** Export status handler need much more work. !!!
91 ** Import should return a useful error when one happened.
92 *** Import does not take notice of NODATA status report.
93 *** When GPGSM does issue IMPORT_OK status reports, make sure to check for
94     them in tests/gpgs m/t-import.c.
95 ** Verify can include info about version/algo/class, but currently
96    this is only available for gpg, not gpgsm.
97 ** Return ENC_TO output in verify result.  Again, this is not available
98    for gpgsm.
99 ** Genkey should return something more useful than General_Error.
100 ** Decrypt:
101    On Fri, Jun 27, 2003 at 06:28:23PM +0200, Heiko Abraham wrote:
102    > I have a cipher text and I use 'gpgme_op_decrypt_verify(..)'
103    > for decrypt and get the plaintext. But also I wish a list
104    > of all reciepient, that can also decrypt this file.
105    >
106    > If I store the file and check it with 'gpg --list-packets ${filename}'
107    > then I will become also a recipient-list.
108    > It this also possible with gpgme?
109
110    Currently not, but it is easy to add this to GPGME 0.4.1.  At least the key
111    ID and a user ID hint is available from gpg (of course key IDs are not
112    necessarily unique!).  I will put it on the TODO list.
113 ** If possible, use --file-setsize to set the file size for proper progress
114    callback handling.  Write data interface for file size.
115 ** Optimize the file descriptor list, so the number of open fds is
116    always known easily.
117 ** Encryption: It should be verified that the behaviour for partially untrusted
118    recipients is correct.
119 ** When GPG issues INV_something for invalid signers, catch them.
120
121 * Error Values
122 ** Map ASSUAN/GpgSM ERR error values in a better way than is done now. !!
123 ** Some error values should identify the source more correctly (mostly error
124    values derived from status messages).
125
126 * Tests
127 ** Write a fake gpg-agent so that we can supply known passphrases to
128    gpgsm and setup the configuration files to use the agent.  Without
129    this we are testing a currently running gpg-agent which is not a
130    clever idea. !
131 ** t-data
132 *** Test gpgme_data_release_and_get_mem.
133 *** Test gpgme_data_seek for invalid types.
134
135 * Debug
136 ** Handle malloc and vasprintf errors.  But decide first if they should be
137    ignored (and logged with 255?!), or really be assertions. !
138
139 * Build suite
140 ** Make sure everything is cleaned correctly (esp. test area).
141 ** Cofnigure test for gpg and gpgsm version (as a warning).