Fix possible realloc overflow for gpgsm and uiserver engines.
[gpgme.git] / TODO
diff --git a/TODO b/TODO
index e5841a8..0458cb5 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,13 +1,34 @@
-Hey Emacs, this is -*- outline -*- mode!
+Hey Emacs, this is -*- org -*- mode!
+
+* Document all the new stuff.
+* Fix the remaining UI Server problems:
+** VERIFY --silent support.
+** ENCRYPT/DECRYPT/VERIFY/SIGN reset the engine, shouldn't be done with UISERVER?
+
+* IMPORTANT
+** When using descriptor passing, we need to set the fd to blocking before
+   issueing simple commands, because we are mixing synchronous
+   commands into potentially asynchronous operations.
+** Might want to implement nonblock for w32 native backend!  Right now,
+   we block reading the next line with assuan.
 
 * Before release:
-** currently nothing
+** Some gpg tests fail with gpg 1.3.4-cvs (gpg/t-keylist-sig)
+   The test is currently disabled there and in gpg/t-import.
+** When gpg supports it, write binary subpackets directly,
+   and parse SUBPACKET status lines.
 
 * ABI's to break:
+** Old opassuan interface.
+** Implementation: Remove support for old style error codes in
+   conversion.c::_gpgme_map_gnupg_error.
+** gpgme_edit_cb_t: Add "processed" return argument
+   (see edit.c::command_handler).
 ** I/O and User Data could be made extensible.  But this can be done
    without breaking the ABI hopefully.
+** All enums should be replaced by ints and simple macros for
+   maximum compatibility.
 ** Compatibility interfaces that can be removed in future versions:
-*** ath compatibility modules.
 *** gpgme_data_new_from_filepart
 *** gpgme_data_new_from_file
 *** gpgme_data_new_with_read_cb
@@ -24,11 +45,24 @@ Hey Emacs, this is -*- outline -*- mode!
 *** gpgme_attr_t
 *** All Gpgme* typedefs.
 
+
 * Thread support:
 ** When GNU Pth supports sendmsg/recvmsg, wrap them properly.
 ** Without timegm (3) support our ISO time parser is not thread safe.
+   There is a configure time warning, though.
 
 * New features:
+** Flow control for data objects.
+   Currently, gpgme_data_t objects are assumed to be blocking.  To
+   break this assumption, we need either (A) a way for an user I/O
+   callback to store the current operation in a continuation that can
+   be resumed later.  While the continuation exists, file descriptors
+   associated with this operation must be removed from their
+   respective event loop.  or (B) a way for gpgme data objects to be
+   associated with a waitable object, that can be registered with the
+   user event loop.  Neither is particularly simple.
+** Extended notation support.  When gpg supports arbitrary binary
+   notation data, provide a user interface for that.
 ** notification system
    We need a simple notification system, probably a simple callback
    with a string and some optional arguments.  This is for example
@@ -36,34 +70,37 @@ Hey Emacs, this is -*- outline -*- mode!
    application can then do whatever is required.  There are other
    usages too.  This notfication system should be independent of any
    contextes of course.
+
+   Not sure whether this is still required.  GPGME_PROTOCOL_ASSUAN is
+   sufficient for this.
+
 ** --learn-code support
    This might be integrated with import. we still need to work out how
-   to learn a card when gpg and gpgsm have support for smartcards.
-** How to terminate a pending operation?  Something like gpgme_op_reset,
-   but where are you allowed to call it (think callback handlers).
-   Then gpgme_op_*list_end can go.  Update: The only place where this
-   can go is returning errors from callback handlers, and a function
-   to be called for example from the user event loop code.  The user
-   must observe the threading rules!  A blocking thread can not be
-   cancelled.
+   to learn a card when gpg and gpgsm have support for smartcards.  In
+   GPA we currently invoke gpg directly.
+
 ** Might need a stat() for data objects and use it for length param to gpg.
-** Allow to export secret keys.
 ** Implement support for photo ids.
+** Allow selection of subkeys
+** Allow to return time stamps in ISO format
+  This allows us to handle years later than 2037 properly.  With the
+  time_t interface they are all mapped to 2037-12-31
 ** New features requested by our dear users, but rejected or left for
    later consideration:
+*** Allow to export secret keys.
+    Rejected because this is conceptually flawed.  Secret keys on a
+    smart card can not be exported, for example.
+    May eventually e supproted with a keywrapping system.
 *** Selecting the key ring, setting the version or comment in output.
     Rejected because the naive implementation is engine specific, the
     configuration is part of the engine's configuration or readily
     worked around in a different way
 *** Selecting the symmetric cipher.
 *** Exchanging keys with key servers.
-** Allow selection of subkeys
-** Allow to return time stamps in ISO format
-  This allows us to handle years later than 2037 properly.  With the
-  time_t interface they are all mapped to 2037-12-31
-   
+
 * Documentation
 ** Document validity and trust issues.
+** In gpgme.texi: Register callbacks under the right letter in the index.
 
 * Engines
 ** Do not create/destroy engines, but create engine and then reset it.
@@ -72,6 +109,9 @@ Hey Emacs, this is -*- outline -*- mode!
    release everything properly at a reset and at an error.  Think hard
    about where to guarantee what (ie, what happens if start fails, are
    the fds unregistered immediately - i think so?)
+   Note that we need support in gpgsm to set include-certs to default
+   as RESET does not reset it, also for no_encrypt_to and probably
+   other options.
 ** Optimize the case where a data object has an underlying fd we can pass
    directly to the engine.  This will be automatic with socket I/O and
    descriptor passing.
@@ -80,13 +120,33 @@ Hey Emacs, this is -*- outline -*- mode!
    (it's an internal error, as select_protocol checks already).
 ** When server mode is implemented properly, more care has to be taken to
    release all resources on error (for example to free assuan_cmd).
+** op_import_keys and op_export_keys have a limit ion the number of keys.
+   This is because we pass them in gpg via the command line and gpgsm
+   via an assuan control line.  We should pipe them instead and maybe
+   change gpg/gpgsm to not put them in memory.
+
+* GPG breakage:
+** gpg 1.4.2 lacks error reporting if sign/encrypt with revoked key.
+** gpg 1.4.2 does crappy error reporting (namely none at all) when
+   smart card is missing for sign operation:
+    [GNUPG:] CARDCTRL 4
+    gpg: selecting openpgp failed: ec=6.110
+    gpg: signing failed: general error
+    [GNUPG:] BEGIN_ENCRYPTION 2 10
+    gpg: test: sign+encrypt failed: general error
+** Without agent and with wrong passphrase, gpg 1.4.2 enters into an
+   infinite loop.
+** Use correct argv[0]
+   In rungpg.c:build_argv we use
+      argv[argc] = strdup ("gpg"); /* argv[0] */
+   This should be changed to take the real file name used in account.
+
 
 * Operations
+** Include cert values -2, -1, 0 and 1 should be defined as macros.
 ** If an operation failed, make sure that the result functions don't return
    corrupt partial information. !!!
    NOTE: The EOF status handler is not called in this case !!!
-** If no passphrase cb is installed, status handler is not run even if
-   password is required by crypto engine. !!
 ** Verify must not fail on NODATA premature if auto-key-retrieval failed.
    It should not fail silently if it knows there is an error. !!!
 ** All operations: Better error reporting. !!
@@ -100,19 +160,6 @@ Hey Emacs, this is -*- outline -*- mode!
 ** Return ENC_TO output in verify result.  Again, this is not available
    for gpgsm.
 ** Genkey should return something more useful than General_Error.
-** Decrypt:
-   On Fri, Jun 27, 2003 at 06:28:23PM +0200, Heiko Abraham wrote:
-   > I have a cipher text and I use 'gpgme_op_decrypt_verify(..)'
-   > for decrypt and get the plaintext. But also I wish a list
-   > of all reciepient, that can also decrypt this file.
-   >
-   > If I store the file and check it with 'gpg --list-packets ${filename}'
-   > then I will become also a recipient-list.
-   > It this also possible with gpgme?
-
-   Currently not, but it is easy to add this to GPGME 0.4.1.  At least the key
-   ID and a user ID hint is available from gpg (of course key IDs are not
-   necessarily unique!).  I will put it on the TODO list.
 ** If possible, use --file-setsize to set the file size for proper progress
    callback handling.  Write data interface for file size.
 ** Optimize the file descriptor list, so the number of open fds is
@@ -125,6 +172,10 @@ Hey Emacs, this is -*- outline -*- mode!
 ** Map ASSUAN/GpgSM ERR error values in a better way than is done now. !!
 ** Some error values should identify the source more correctly (mostly error
    values derived from status messages).
+** In rungpg.c we need to check the version of the engine
+   This requires a way to get the cached version number from the
+   engine layer.
+
 
 * Tests
 ** Write a fake gpg-agent so that we can supply known passphrases to
@@ -134,11 +185,44 @@ Hey Emacs, this is -*- outline -*- mode!
 ** t-data
 *** Test gpgme_data_release_and_get_mem.
 *** Test gpgme_data_seek for invalid types.
+** t-keylist
+   Write a test for ext_keylist.
+** Test reading key signatures.
 
 * Debug
+** Tracepoints should be added at: Every public interface enter/leave,
+   before and in every callback, at major decision points, at every
+   internal data point which might easily be observed by the outside
+   (system handles).  We also trace handles and I/O support threads in
+   the w32 implementation because that's fragile code.
+   Files left to do:
+   data-fd.c data-mem.c data-stream.c data-user.c debug.c rungpg.c
+   engine.c engine-gpgsm.c funopen.c w32-glib-io.c wait.c
+   wait-global.c wait-private.c wait-user.c op-support.c decrypt.c
+   decrypt-verify.c delete.c edit.c encrypt.c encrypt-sign.c export.c
+   genkey.c import.c key.c keylist.c passphrase.c progress.c signers.c
+   sig-notation.c trust-item.c trustlist.c verify.c
 ** Handle malloc and vasprintf errors.  But decide first if they should be
    ignored (and logged with 255?!), or really be assertions. !
 
 * Build suite
 ** Make sure everything is cleaned correctly (esp. test area).
-** Cofnigure test for gpg and gpgsm version (as a warning).
+** Enable AC_CONFIG_MACRO_DIR and bump up autoconf version requirement.
+   (To fix "./autogen.sh; ./configure --enable-maintainer-mode; touch
+   configure.ac; make").  Currently worked around with ACLOCAL_AMFLAGS???
+
+* Error checking 
+** engine-gpgsm, with-validation
+   Add error checking some time after releasing a new gpgsm.
+
+
+Copyright 2004, 2005 g10 Code GmbH
+
+This file is free software; as a special exception the author gives
+unlimited permission to copy and/or distribute it, with or without
+modifications, as long as this notice is preserved.
+
+This file is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
+implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE.