doc/
[gpgme.git] / TODO
1 Hey Emacs, this is -*- outline -*- mode!
2
3 * ABI's to break:
4 ** Change gpgme_recipient_t stuff to gpgme_user_id_t (encrypt, export, ...).
5 ** Compatibility interfaces that can be removed in future versions:
6 *** gpgme_data_new_from_filepart
7 *** gpgme_data_new_from_file
8 *** gpgme_data_new_with_read_cb
9 *** gpgme_data_rewind
10 *** GPGME_Busy, GPGME_No_Request
11 *** GPGME_Invalid_Recipient, GPGME_No_Recipients
12 *** GPGME_No_Passphrase
13 *** gpgme_op_import_ext
14 *** gpgme_get_sig_key
15 *** gpgme_get_sig_ulong_attr
16 *** gpgme_get_sig_string_attr
17 *** GPGME_SIG_STAT_*
18 *** gpgme_get_sig_status
19 *** gpgme_trust_item_release
20 *** gpgme_trust_item_get_string_attr
21 *** gpgme_trust_item_get_ulong_attr
22 *** gpgme_attr_t
23 *** GPGME_Invalid_Type, GPGME_Invalid_Mode
24 *** All Gpgme* typedefs.
25
26 * Thread support:
27 ** Build thread modules for static linking (which just suck in the
28    desired symbols the hard way). !!
29 ** Ordering the libs is important, but libtool gets it wrong.  Argh.
30
31 * New features:
32 ** notification system
33    We need a simple notification system, probably a simple callback
34    with a string and some optional arguments.  This is for example
35    required to notify an application of a changed smartcard,  The
36    application can then do whatever is required.  There are other
37    usages too.  This notfication system should be independent of any
38    contextes of course.
39 ** --learn-code support
40    This might be integrated with import. we still need to work out how
41    to learn a card when gpg and gpgsm have support for smartcards.
42 ** set_locale for thread safe and env independent locale selection.
43 ** How to terminate a pending operation?  Something like gpgme_op_reset,
44    but where are you allowed to call it (think callback handlers).
45    Then gpgme_op_*list_end can go.
46 ** Might need a stat() for data objects and use it for length param to gpg.
47 ** Allow to export secret keys.
48 ** Implement support for photo ids.
49 ** New features requested by our dear users, but rejected or left for
50    later consideration:
51 *** Selecting the key ring, setting the version or comment in output.
52     Rejected because the naive implementation is engine specific, the
53     configuration is part of the engine's configuration or readily
54     worked around in a different way
55 *** Selecting the symmetric cipher.
56 *** Exchanging keys with key servers.
57
58 * Documentation
59 ** Document validity and trust issues.
60
61 * Engines
62 ** Do not create/destroy engines, but create engine and then reset it.
63    Internally the reset operation still spawns a new engine process,
64    but this can be replaced with a reset later.  Also, be very sure to
65    release everything properly at a reset and at an error.  Think hard
66    about where to guarantee what (ie, what happens if start fails, are
67    the fds unregistered immediately - i think so?)
68 ** Optimize the case where a data object has an underlying fd we can pass
69    directly to the engine.
70 ** Move code common to all engines up from gpg to engine.
71 ** engine operations can return General Error on unknown protocol
72    (it's an internal error, as select_protocol checks already).
73 ** When server mode is implemented properly, more care has to be taken to
74    release all resources on error (for example to free assuan_cmd).
75
76 * Operations
77 ** If no passphrase cb is installed, status handler is not run even if
78    password is required by crypto engine. !!
79 ** Export status handler need much more work. !!!
80 ** Import should return a useful error when one happened.
81 *** Import does not take notice of NODATA status report.
82 *** When GPGSM does issue IMPORT_OK status reports, make sure to check for them
83     in tests/gpgs m/t-import.c.
84 ** Genkey should return something more useful than General_Error.
85 ** Factor out common code in _op_*_start functions.
86 ** Optimize the file descriptor list, so the number of open fds is
87    always known easily.
88 ** Encryption: It should be verified that the behaviour for partially untrusted
89    recipients is correct.
90 ** When GPG issues INV_something for invalid signers, catch them.
91
92 * Error Values
93 ** Map ASSUAN/GpgSM ERR error values in a better way than is done now. !!
94 ** Verify (and document) if Read_Error, Write_Error, Pipe_Error set errno.
95
96 * Tests
97 ** Write a fake gpg-agent so that we can supply known passphrases to
98    gpgsm and setup the configuration files to use the agent.  Without
99    this we are testing a currently running gpg-agent which is not a
100    clever idea. !
101 ** t-data
102 *** Test gpgme_data_release_and_get_mem.
103 *** Test gpgme_data_seek for invalid types.
104
105 * Debug
106 ** Handle malloc and vasprintf errors.  But decide first if they should be
107    ignored (and logged with 255?!), or really be assertions. !
108
109 * Build suite
110 ** Make sure everything is cleaned correctly (esp. test area).
111
112 Bugs reported by Stephane Corthesy:
113 > In GpgmeRecipients, would it be possible to provide a function which  
114 > would return the validity assigned to a name contained in the  
115 > GpgmeRecipients instance?
116
117 > passphrase callback. If I use the same GpgmeContext as the one which  
118 > is currently asking for a passphrase, my app crashes: the r_hd in
119 > the  
120 > callback has become invalid; if I use a brand new one, the callback  
121 > is called recursively, when I ask to enumerate keys.