doc/
[gpgme.git] / TODO
1 Hey Emacs, this is -*- outline -*- mode!
2
3 * ABI's to break:
4 ** All result returns will be done as structs, not as XML. !!!
5 ** Make sure that all results can be gotten in asynchronous mode (ie, avoid
6    returning information in the blocking version as function arguments).
7 ** Drop the support for finding out if an operation is pending.  After all, one
8    or two more ways for a user to shoot themselves in the foot don't matter.
9 ** Compatibility interfaces that can be removed in future versions:
10 *** gpgme_data_new_from_filepart
11 *** gpgme_data_new_from_file
12 *** gpgme_data_new_with_read_cb
13 *** gpgme_data_rewind
14 *** GPGME_Busy, GPGME_No_Request
15 *** GPGME_No_Passphrase
16 *** GPGME_Invalid_Recipient, GPGME_No_Recipients
17 *** GPGME_No_Passphrase
18 *** gpgme_op_import_ext
19 *** gpgme_get_sig_key
20 *** gpgme_get_sig_ulong_attr
21 *** gpgme_get_sig_string_attr
22 *** GPGME_SIG_STAT_*
23 *** gpgme_get_sig_status
24
25 * Thread support:
26 ** Build thread modules for static linking (which just suck in the
27    desired symbols the hard way). !!
28
29 * New features:
30 ** notification system
31    We need a simple notification system, probably a simple callback
32    with a string and some optional arguments.  This is for example
33    required to notify an application of a changed smartcard,  The
34    application can then do whatever is required.  There are other
35    usages too.  This notfication system should be independent of any
36    contextes of course.
37 ** --learn-code support
38    This might be integrated with import. we still need to work out how
39    to learn a card when gpg and gpgsm have support for smartcards.
40 ** set_locale for thread safe and env independent locale selection.
41
42 * Documentation
43 ** Add note about GPGME clearing out pointer return values.
44 ** validity/trust
45
46 * Engines
47 ** Do not create/destroy engines, but create engine and then reset it.
48    Internally the reset operation still spawns a new engine process,
49    but this can be replaced with a reset later.  Also, be very sure to
50    release everything properly at a reset and at an error.
51    Think hard about where to guarantee what (ie, what happens if start fails,
52    are the fds unregistered immediately - i think so?)
53 ** Optimize the case where a data object has an underlying fd we can pass
54    directly to the engine.
55 ** Move code common to all engines up from gpg to engine.
56 ** engine operations can return General Error on unknown protocol
57    (it's an internal error, as select_protocol checks already).
58 ** When server mode is implemented properly, more care has to be taken to
59     release all resources on error (for example to free assuan_cmd).
60
61 * Operations
62 ** Passphrase callback should not copy password. !!!
63 *** If no passphrase cb is installed, status handler is not run even if
64     password is required by crypto engine. !!
65 ** Export status handler need much more work. !!!
66 ** Import should return a useful error when one happened.
67 *** Import does not take notice of NODATA status report.
68 *** When GPGSM does issue IMPORT_OK status reports, make sure to check for them
69     in tests/gpgs m/t-import.c.
70 ** Genkey should return something more useful than General_Error.
71 ** Factor out common code in _op_*_start functions.
72 ** Add ATTR to return the number of subkeys or uids.
73 ** Optimize the file descriptor list, so the number of open fds is
74    always known easily.  This could replace the pending bit, too, with
75    the exception of keylisting operations maybe.
76
77 * Error Values
78 ** Map ASSUAN/GpgSM ERR error values in a better way than is done now. !!
79 ** Verify (and document) if Read_Error, Write_Error, Pipe_Error set errno.
80
81 * Tests
82 ** Write a fake gpg-agent so that we can supply known passphrases to
83    gpgsm and setup the configuration files to use the agent.  Without
84    this we are testing a currently running gpg-agent which is not a
85    clever idea. !
86 ** t-data
87 *** Test gpgme_data_release_and_get_mem.
88 *** Test gpgme_data_rewind for invalid types.
89 *** Test gpgme_data_read's readable feature.
90
91 * Debug
92 ** Handle malloc and vasprintf errors.  But decide first if they should be
93    ignored (and logged with 255?!), or really be assertions. !
94
95 * Build suite
96 ** Make sure everything is cleaned correctly (esp. test area).
97
98 Bugs reported by Stephane Corthesy:
99 > In GpgmeRecipients, would it be possible to provide a function which  
100 > would return the validity assigned to a name contained in the  
101 > GpgmeRecipients instance?
102
103 > passphrase callback. If I use the same GpgmeContext as the one which  
104 > is currently asking for a passphrase, my app crashes: the r_hd in
105 > the  
106 > callback has become invalid; if I use a brand new one, the callback  
107 > is called recursively, when I ask to enumerate keys.