GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

TODO updates

Browse Source 
* Updated TODO with tags to make everything appear properly when
  exported to HTML or PDF.
* Added a couple more items, mainly to do with docs or future bindings.
* Marked some, but not all as actual TODO items.
* Some items should probably be removed, but haven't been yet.
* Some have probably been completed already.
This commit is contained in:
Ben McGinnes 2018-03-04 08:32:31 +11:00
parent 85bdca3b2b
commit 12a87af1df
1 changed files with 80 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

152
TODO
View File

@ -158,25 +158,25 @@ Hey Emacs, this is -*- org -*- mode!
* Thread support: * Thread support:
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: threads
:END: :END:
** When GNU Pth supports sendmsg/recvmsg, wrap them properly. ** When GNU Pth supports sendmsg/recvmsg, wrap them properly.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: wrap-oth
:END: :END:
** Without timegm (3) support our ISO time parser is not thread safe. ** Without timegm (3) support our ISO time parser is not thread safe.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: time-threads
:END: :END:
There is a configure time warning, though. There is a configure time warning, though.
* New features: * New features:
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: new-features
:END: :END:
** Flow control for data objects. ** Flow control for data objects.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: flow-control-is-not-a-euphemism-for-an-s-bend
:END: :END:
Currently, gpgme_data_t objects are assumed to be blocking. To 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 break this assumption, we need either (A) a way for an user I/O
@ -188,12 +188,12 @@ Hey Emacs, this is -*- org -*- mode!
user event loop. Neither is particularly simple. user event loop. Neither is particularly simple.
** Extended notation support. When gpg supports arbitrary binary ** Extended notation support. When gpg supports arbitrary binary
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: extended-notation
:END: :END:
notation data, provide a user interface for that. notation data, provide a user interface for that.
** notification system ** notification system
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: notification-system
:END: :END:
We need a simple notification system, probably a simple callback We need a simple notification system, probably a simple callback
with a string and some optional arguments. This is for example with a string and some optional arguments. This is for example
@ -207,7 +207,7 @@ Hey Emacs, this is -*- org -*- mode!
** --learn-code support ** --learn-code support
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: learn-code
:END: :END:
This might be integrated with import. we still need to work out how 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. In to learn a card when gpg and gpgsm have support for smartcards. In
@ -215,72 +215,72 @@ Hey Emacs, this is -*- org -*- mode!
** Might need a stat() for data objects and use it for length param to gpg. ** Might need a stat() for data objects and use it for length param to gpg.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: stat-data
:END: :END:
** Implement support for photo ids. ** Implement support for photo ids.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: photo-id
:END: :END:
** Allow selection of subkeys ** Allow selection of subkeys
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: subkey-selection
:END: :END:
** Allow to return time stamps in ISO format ** Allow to return time stamps in ISO format
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: iso-format-datetime
:END: :END:
This allows us to handle years later than 2037 properly. With the This allows us to handle years later than 2037 properly. With the
time_t interface they are all mapped to 2037-12-31 time_t interface they are all mapped to 2037-12-31
** New features requested by our dear users, but rejected or left for ** New features requested by our dear users, but rejected or left for
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: feature-requests
:END: :END:
later consideration: later consideration:
*** Allow to export secret keys. *** Allow to export secret keys.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: export-secret-keys
:END: :END:
Rejected because this is conceptually flawed. Secret keys on a Rejected because this is conceptually flawed. Secret keys on a
smart card can not be exported, for example. smart card can not be exported, for example.
May eventually e supproted with a keywrapping system. May eventually e supproted with a keywrapping system.
*** Selecting the key ring, setting the version or comment in output. *** Selecting the key ring, setting the version or comment in output.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: select-keyring-version
:END: :END:
Rejected because the naive implementation is engine specific, the Rejected because the naive implementation is engine specific, the
configuration is part of the engine's configuration or readily configuration is part of the engine's configuration or readily
worked around in a different way worked around in a different way
*** Selecting the symmetric cipher. *** Selecting the symmetric cipher.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: symmetric-cipher-selection
:END: :END:
*** Exchanging keys with key servers. *** Exchanging keys with key servers.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: key-server-exchange
:END: :END:
* Documentation * Documentation
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: documentation
:END: :END:
** Document validity and trust issues. ** TODO Document validity and trust issues.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: valid-trust-issues
:END: :END:
** In gpgme.texi: Register callbacks under the right letter in the index. ** In gpgme.texi: Register callbacks under the right letter in the index.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: gpgme-texi
:END: :END:
* Engines * Engines
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: engines
:END: :END:
** Do not create/destroy engines, but create engine and then reset it. ** Do not create/destroy engines, but create engine and then reset it.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: reset-engine-is-not-quite-just-ignition
:END: :END:
Internally the reset operation still spawns a new engine process, Internally the reset operation still spawns a new engine process,
but this can be replaced with a reset later. Also, be very sure to but this can be replaced with a reset later. Also, be very sure to
@ -292,27 +292,27 @@ Hey Emacs, this is -*- org -*- mode!
other options. other options.
** Optimize the case where a data object has an underlying fd we can pass ** Optimize the case where a data object has an underlying fd we can pass
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: optimus-data-cousin-of-optimus-prime
:END: :END:
directly to the engine. This will be automatic with socket I/O and directly to the engine. This will be automatic with socket I/O and
descriptor passing. descriptor passing.
** Move code common to all engines up from gpg to engine. ** Move code common to all engines up from gpg to engine.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: move-code-common-to-engines-out-of-gpg
:END: :END:
** engine operations can return General Error on unknown protocol ** engine operations can return General Error on unknown protocol
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: general-error-looking-to-be-court-martialled
:END: :END:
(it's an internal error, as select_protocol checks already). (it's an internal error, as select_protocol checks already).
** When server mode is implemented properly, more care has to be taken to ** When server mode is implemented properly, more care has to be taken to
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: server-mode
:END: :END:
release all resources on error (for example to free assuan_cmd). 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. ** op_import_keys and op_export_keys have a limit in the number of keys.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: import-export-problems
:END: :END:
This is because we pass them in gpg via the command line and gpgsm 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 via an assuan control line. We should pipe them instead and maybe
@ -321,15 +321,15 @@ Hey Emacs, this is -*- org -*- mode!
* GPG breakage: * GPG breakage:
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: gpg-breakage
:END: :END:
** gpg 1.4.2 lacks error reporting if sign/encrypt with revoked key. ** gpg 1.4.2 lacks error reporting if sign/encrypt with revoked key.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: gpg-classic-lacks-stuff
:END: :END:
** gpg 1.4.2 does crappy error reporting (namely none at all) when ** gpg 1.4.2 does crappy error reporting (namely none at all) when
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: gpg-classic-problems-but-do-we-care
:END: :END:
smart card is missing for sign operation: smart card is missing for sign operation:
[GNUPG:] CARDCTRL 4 [GNUPG:] CARDCTRL 4
@ -339,12 +339,12 @@ Hey Emacs, this is -*- org -*- mode!
gpg: test: sign+encrypt failed: general error gpg: test: sign+encrypt failed: general error
** Without agent and with wrong passphrase, gpg 1.4.2 enters into an ** Without agent and with wrong passphrase, gpg 1.4.2 enters into an
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: recursive-gpg-classic
:END: :END:
infinite loop. infinite loop.
** Use correct argv[0] ** Use correct argv[0]
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: correct-argv
:END: :END:
In rungpg.c:build_argv we use In rungpg.c:build_argv we use
argv[argc] = strdup ("gpg"); /* argv[0] */ argv[argc] = strdup ("gpg"); /* argv[0] */
@ -353,95 +353,95 @@ Hey Emacs, this is -*- org -*- mode!
* Operations * Operations
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: operations-are-not-surgical
:END: :END:
** Include cert values -2, -1, 0 and 1 should be defined as macros. ** Include cert values -2, -1, 0 and 1 should be defined as macros.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: certified-macros
:END: :END:
** If an operation failed, make sure that the result functions don't return ** If an operation failed, make sure that the result functions don't return
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: operation-failure
:END: :END:
corrupt partial information. !!! corrupt partial information. !!!
NOTE: The EOF status handler is not called in this case !!! NOTE: The EOF status handler is not called in this case !!!
** Verify must not fail on NODATA premature if auto-key-retrieval failed. ** Verify must not fail on NODATA premature if auto-key-retrieval failed.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: autobot-key-retrieval
:END: :END:
It should not fail silently if it knows there is an error. !!! It should not fail silently if it knows there is an error. !!!
** All operations: Better error reporting. !! ** All operations: Better error reporting. !!
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: better-reporting-not-like-fox-news
:END: :END:
** Export status handler need much more work. !!! ** Export status handler need much more work. !!!
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: export-status-handler
:END: :END:
** Import should return a useful error when one happened. ** Import should return a useful error when one happened.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: import-useful-stuff-even-wrong-stuff
:END: :END:
*** Import does not take notice of NODATA status report. *** Import does not take notice of NODATA status report.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: import-no-data
:END: :END:
*** When GPGSM does issue IMPORT_OK status reports, make sure to check for *** When GPGSM does issue IMPORT_OK status reports, make sure to check for
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: gpgsm-import-ok
:END: :END:
them in tests/gpgs m/t-import.c. them in tests/gpgs m/t-import.c.
** Verify can include info about version/algo/class, but currently ** Verify can include info about version/algo/class, but currently
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: verify-class
:END: :END:
this is only available for gpg, not gpgsm. this is only available for gpg, not gpgsm.
** Return ENC_TO output in verify result. Again, this is not available ** Return ENC_TO output in verify result. Again, this is not available
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: return-to-enc
:END: :END:
for gpgsm. for gpgsm.
** Genkey should return something more useful than General_Error. ** Genkey should return something more useful than General_Error.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: general-key-assumed-command-from-general-error
:END: :END:
** If possible, use --file-setsize to set the file size for proper progress ** If possible, use --file-setsize to set the file size for proper progress
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: file-setsize
:END: :END:
callback handling. Write data interface for file size. callback handling. Write data interface for file size.
** Optimize the file descriptor list, so the number of open fds is ** Optimize the file descriptor list, so the number of open fds is
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: optimus-descriptus-younger-brother-of-optimus-prime
:END: :END:
always known easily. always known easily.
** Encryption: It should be verified that the behaviour for partially untrusted ** Encryption: It should be verified that the behaviour for partially untrusted
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: only-mostly-dead-means-partially-alive
:END: :END:
recipients is correct. recipients is correct.
** When GPG issues INV_something for invalid signers, catch them. ** When GPG issues INV_something for invalid signers, catch them.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: invalid-sig
:END: :END:
* Error Values * Error Values
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: error-value
:END: :END:
** Map ASSUAN/GpgSM ERR error values in a better way than is done now. !! ** Map ASSUAN/GpgSM ERR error values in a better way than is done now. !!
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: map-ass-error
:END: :END:
** Some error values should identify the source more correctly (mostly error ** Some error values should identify the source more correctly (mostly error
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: source-errors
:END: :END:
values derived from status messages). values derived from status messages).
** In rungpg.c we need to check the version of the engine ** In rungpg.c we need to check the version of the engine
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: rungpg-c-engine-ver
:END: :END:
This requires a way to get the cached version number from the This requires a way to get the cached version number from the
engine layer. engine layer.
@ -449,35 +449,35 @@ Hey Emacs, this is -*- org -*- mode!
* Tests * Tests
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: tests
:END: :END:
** Write a fake gpg-agent so that we can supply known passphrases to ** TODO Write a fake gpg-agent so that we can supply known passphrases to
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: test-fake-gpg-agent
:END: :END:
gpgsm and setup the configuration files to use the agent. Without gpgsm and setup the configuration files to use the agent. Without
this we are testing a currently running gpg-agent which is not a this we are testing a currently running gpg-agent which is not a
clever idea. ! clever idea. !
** t-data ** t-data
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: test-data
:END: :END:
*** Test gpgme_data_release_and_get_mem. *** Test gpgme_data_release_and_get_mem.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: test-gpgme-data-release-mem
:END: :END:
*** Test gpgme_data_seek for invalid types. *** Test gpgme_data_seek for invalid types.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: test-gpgme-data-seek
:END: :END:
** t-keylist ** t-keylist
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: test-keylist
:END: :END:
Write a test for ext_keylist. Write a test for ext_keylist.
** Test reading key signatures. ** Test reading key signatures.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: test-key-sig
:END: :END:
@ -487,7 +487,7 @@ Hey Emacs, this is -*- org -*- mode!
:END: :END:
** Tracepoints should be added at: Every public interface enter/leave, ** Tracepoints should be added at: Every public interface enter/leave,
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: tracepoint-pub-int
:END: :END:
before and in every callback, at major decision points, at every before and in every callback, at major decision points, at every
internal data point which might easily be observed by the outside internal data point which might easily be observed by the outside
@ -500,10 +500,11 @@ Hey Emacs, this is -*- org -*- mode!
decrypt-verify.c delete.c edit.c encrypt.c encrypt-sign.c export.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 genkey.c import.c key.c keylist.c passphrase.c progress.c signers.c
sig-notation.c trust-item.c trustlist.c verify.c sig-notation.c trust-item.c trustlist.c verify.c
** Handle malloc and vasprintf errors. But decide first if they should be ** TODO Handle malloc and vasprintf errors. But decide first if they should be
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: malloc-vasprintf
:END: :END:
ignored (and logged with 255?!), or really be assertions. ! ignored (and logged with 255?!), or really be assertions. !
@ -511,13 +512,13 @@ Hey Emacs, this is -*- org -*- mode!
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID:
:END: :END:
** Make sure everything is cleaned correctly (esp. test area). ** TODO Make sure everything is cleaned correctly (esp. test area).
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: clean-tests
:END: :END:
** Enable AC_CONFIG_MACRO_DIR and bump up autoconf version requirement. ** TODO Enable AC_CONFIG_MACRO_DIR and bump up autoconf version requirement.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: autoconf-macros
:END: :END:
(To fix "./autogen.sh; ./configure --enable-maintainer-mode; touch (To fix "./autogen.sh; ./configure --enable-maintainer-mode; touch
configure.ac; make"). Currently worked around with ACLOCAL_AMFLAGS??? configure.ac; make"). Currently worked around with ACLOCAL_AMFLAGS???
@ -525,11 +526,11 @@ Hey Emacs, this is -*- org -*- mode!
* Error checking * Error checking
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: error-checking
:END: :END:
** engine-gpgsm, with-validation ** TODO engine-gpgsm, with-validation
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: :CUSTOM_ID: gpgsm-validation
:END: :END:
Add error checking some time after releasing a new gpgsm. Add error checking some time after releasing a new gpgsm.
@ -559,6 +560,13 @@ Hey Emacs, this is -*- org -*- mode!
See the more detailed notes on this in the [[lang/python/docs/TODO.org][python TODO]]. See the more detailed notes on this in the [[lang/python/docs/TODO.org][python TODO]].
** TODO GPGME installation and package management guide
:PROPERTIES:
:CUSTOM_ID: package-management
:END:
Write a guide/best practices for maintainers of GPGME packages with
third party package management systems.
Copyright 2004, 2005, 2018 g10 Code GmbH Copyright 2004, 2005, 2018 g10 Code GmbH