Add item about docs.
[gpgme.git] / TODO
1 Hey Emacs, this is -*- outline -*- mode!
2
3 * Before release:
4 ** Some gpg tests fail with gpg 1.3.4-cvs (gpg/t-keylist-sig)
5    The test is currently disabled there and in gpg/t-import.
6 ** Add notation data to key signatures.
7 ** In gpgme.texi: Register callbacks under the right letter in the index.
8
9 * ABI's to break:
10 ** gpgme_edit_cb_t: Add "processed" return argument
11    (see edit.c::command_handler).
12 ** I/O and User Data could be made extensible.  But this can be done
13    without breaking the ABI hopefully.
14 *  All enums that should be enums need to have a maximum value to ensure
15    a certain minimum width for extensibility.
16 ** Compatibility interfaces that can be removed in future versions:
17 *** gpgme_data_new_from_filepart
18 *** gpgme_data_new_from_file
19 *** gpgme_data_new_with_read_cb
20 *** gpgme_data_rewind
21 *** gpgme_op_import_ext
22 *** gpgme_get_sig_key
23 *** gpgme_get_sig_ulong_attr
24 *** gpgme_get_sig_string_attr
25 *** GPGME_SIG_STAT_*
26 *** gpgme_get_sig_status
27 *** gpgme_trust_item_release
28 *** gpgme_trust_item_get_string_attr
29 *** gpgme_trust_item_get_ulong_attr
30 *** gpgme_attr_t
31 *** All Gpgme* typedefs.
32
33
34 * Thread support:
35 ** When GNU Pth supports sendmsg/recvmsg, wrap them properly.
36 ** Without timegm (3) support our ISO time parser is not thread safe.
37    There is a configure time warning, though.
38
39 * New features:
40 ** Extended notation support.  When gpg supports arbitrary binary
41    notation data, provide a user interface for that.
42 ** notification system
43    We need a simple notification system, probably a simple callback
44    with a string and some optional arguments.  This is for example
45    required to notify an application of a changed smartcard, The
46    application can then do whatever is required.  There are other
47    usages too.  This notfication system should be independent of any
48    contextes of course.
49 ** --learn-code support
50    This might be integrated with import. we still need to work out how
51    to learn a card when gpg and gpgsm have support for smartcards.
52 ** Might need a stat() for data objects and use it for length param to gpg.
53 ** Implement support for photo ids.
54 ** Allow selection of subkeys
55 ** Allow to return time stamps in ISO format
56   This allows us to handle years later than 2037 properly.  With the
57   time_t interface they are all mapped to 2037-12-31
58 ** New features requested by our dear users, but rejected or left for
59    later consideration:
60 *** Allow to export secret keys.
61     Rejected because this is conceptually flawed.  Secret keys on a
62     smart card can not be exported, for example.
63 *** Selecting the key ring, setting the version or comment in output.
64     Rejected because the naive implementation is engine specific, the
65     configuration is part of the engine's configuration or readily
66     worked around in a different way
67 *** Selecting the symmetric cipher.
68 *** Exchanging keys with key servers.
69
70 * Documentation
71 ** Document validity and trust issues.
72
73 * Engines
74 ** Do not create/destroy engines, but create engine and then reset it.
75    Internally the reset operation still spawns a new engine process,
76    but this can be replaced with a reset later.  Also, be very sure to
77    release everything properly at a reset and at an error.  Think hard
78    about where to guarantee what (ie, what happens if start fails, are
79    the fds unregistered immediately - i think so?)
80 ** Optimize the case where a data object has an underlying fd we can pass
81    directly to the engine.  This will be automatic with socket I/O and
82    descriptor passing.
83 ** Move code common to all engines up from gpg to engine.
84 ** engine operations can return General Error on unknown protocol
85    (it's an internal error, as select_protocol checks already).
86 ** When server mode is implemented properly, more care has to be taken to
87    release all resources on error (for example to free assuan_cmd).
88
89 * Operations
90 ** If an operation failed, make sure that the result functions don't return
91    corrupt partial information. !!!
92    NOTE: The EOF status handler is not called in this case !!!
93 ** Verify must not fail on NODATA premature if auto-key-retrieval failed.
94    It should not fail silently if it knows there is an error. !!!
95 ** All operations: Better error reporting. !!
96 ** Export status handler need much more work. !!!
97 ** Import should return a useful error when one happened.
98 *** Import does not take notice of NODATA status report.
99 *** When GPGSM does issue IMPORT_OK status reports, make sure to check for
100     them in tests/gpgs m/t-import.c.
101 ** Verify can include info about version/algo/class, but currently
102    this is only available for gpg, not gpgsm.
103 ** Return ENC_TO output in verify result.  Again, this is not available
104    for gpgsm.
105 ** Genkey should return something more useful than General_Error.
106 ** If possible, use --file-setsize to set the file size for proper progress
107    callback handling.  Write data interface for file size.
108 ** Optimize the file descriptor list, so the number of open fds is
109    always known easily.
110 ** Encryption: It should be verified that the behaviour for partially untrusted
111    recipients is correct.
112 ** When GPG issues INV_something for invalid signers, catch them.
113
114 * Error Values
115 ** Map ASSUAN/GpgSM ERR error values in a better way than is done now. !!
116 ** Some error values should identify the source more correctly (mostly error
117    values derived from status messages).
118
119 * Tests
120 ** Write a fake gpg-agent so that we can supply known passphrases to
121    gpgsm and setup the configuration files to use the agent.  Without
122    this we are testing a currently running gpg-agent which is not a
123    clever idea. !
124 ** t-data
125 *** Test gpgme_data_release_and_get_mem.
126 *** Test gpgme_data_seek for invalid types.
127 ** t-keylist
128    Write a test for ext_keylist.
129
130
131 * Debug
132 ** Handle malloc and vasprintf errors.  But decide first if they should be
133    ignored (and logged with 255?!), or really be assertions. !
134
135 * Build suite
136 ** Make sure everything is cleaned correctly (esp. test area).
137 ** Enable AC_CONFIG_MACRO_DIR and bump up autoconf version requirement.
138    (To fix "./autogen.sh; ./configure --enable-maintainer-mode; touch
139    configure.ac; make").  Currently worked around with ACLOCAL_AMFLAGS???
140
141 * Error checking 
142 ** engine-gpgsm, with-validation
143    Add error checking some time after releasing a new gpgsm.
144
145
146 Copyright 2004, 2005 g10 Code GmbH
147
148 This file is free software; as a special exception the author gives
149 unlimited permission to copy and/or distribute it, with or without
150 modifications, as long as this notice is preserved.
151
152 This file is distributed in the hope that it will be useful, but
153 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
154 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
155 PURPOSE.