Camellia is now LGPLed
[libgcrypt.git] / TODO
1 What's left to do                                 -*- outline -*-
2
3 * Next API break:
4 ** gcry_ac_io_t
5   Remove use of anonymous union.
6
7 * udiv-qrnbd.o should get build as *.lo [HPUX]
8
9 * Allow operation using RSA keys consisting of the OpenSSL list of
10   parameters and allow for a third form where the private Exponent
11   is not given (saves space).
12
13 * Add a warning to the manual, to check that libgcrypt actually has
14   been compiled with thread support when used by a threaded
15   application.
16
17 * linker script test
18   Write an autoconf test to check whether the linker supports a
19   version script. 
20
21 * Make use of the forthcoming visibility attribute.
22
23 * Add attributes to the MPI functions.
24
25 * In case the ac interface will be more popular than the pk interface,
26   the asymmetric ciphers could be changed for convenient interaction
27   with the ac interface (i.e. by using ac's `data sets') and the pk
28   interface could be changed to be a wrapper for the ac interface.
29
30 * cipher/pubkey.c and pubkey implementaions.
31   Don't rely on the secure memory based wiping function but add an
32   extra wiping.
33   
34 * update/improve documentation
35 ** it's outdated for e.g. gcry_pk_algo_info.
36 ** document algorithm capabilities
37 ** Explain seed files and correlation
38   Multiple instances of the applications sharing the same random seed
39   file can be started in parallel, in which case they will read out
40   the same pool and then race for updating it (the last update
41   overwrites earlier updates).  They will differentiate only by the
42   weak entropy that is added in read_seed_file based on the PID and
43   clock, and up to 16 bytes of weak random non-blockingly.  The
44   consequence is that the output of these different instances is
45   correlated to some extent.  In the perfect scenario, the attacker
46   can control (or at least guess) the PID and clock of the
47   application, and drain the system's entropy pool to reduce the "up
48   to 16 bytes" above to 0.  Then the dependencies of the inital states
49   of the pools are completely known.
50 ** Init requirements for random
51    The documentation says in "Controlling the library" that some
52    functions can only be used at initialization time, but it does not
53    explain what that means.  Initialization is a multi-step procedure:
54    First the thread callbacks have to be set up (optional), then the
55    gcry_check_version() function must be called (mandatory), then
56    further functions can be used.
57
58    The manual also says that something happens when the seed file is
59    registered berfore the PRNG is initialized, but it does not say how
60    one can guarantee to call it early enough.
61
62    Suggested fix: Specify initialization time as the time after
63    gcry_check_version and before calling any other function except
64    gcry_control().
65
66    All functions which modify global state without a lock must be
67    documented as "can only be called during initialization time" (but
68    see item 1).  Then the extraneous calls to _gcry_random_initialize
69    in gcry_control() can be removed, and the comments "not thread
70    safe" in various initialization-time-only functions like
71    _gcry_use_random_daemon become superfluous.
72
73 * Use builtin bit functions of gcc 3.4
74
75 * Consider using a daemon to maintaint he random pool
76   [Partly done] The down side of this is that we can't assume that the
77   random has has always been stored in "secure memory".  And we rely
78   on that sniffing of Unix domain sockets is not possible.  We can
79   implement this simply by detecting a special prefixed random seed
80   name and divert in this case to the daemon.  There are several
81   benefits with such an approach: We keep the state of the RNG over
82   invocations of libgcrypt based applications, don't need time
83   consuming initialization of the pool and in case the entropy
84   collectros need to run that bunch of Unix utilities we don't waste
85   their precious results.
86
87 * Out of memory handler for secure memory should do proper logging
88
89   There is no shortage of standard memory, so logging is most likely
90   possible.
91
92 * mpi_print does not use secure memory
93   for internal variables.
94
95 * gcry_mpi_lshift is missing
96
97 * Add internal versions of mpi functions
98   Or make use of the visibility attribute.
99
100 * Add OAEP
101
102 * gcryptrnd.c
103   Requires a test for pth [done] as well as some other tests.
104
105 * random.c
106  If add_randomness is invoked before the pool is filled, but with a
107  weak source of entropy, for example the fast random poll, which
108  may happen from other parts of gcrypt, then the pool is filled
109  partially with weak random, defeating the purpose of pool_filled
110  and the "source > 1" check in add_randomness.
111
112  Suggestion: Count initial filling bytes with source > 1 in
113  add_randomness seperately from the pool_writepos cursor.  Only set
114  pool_filled if really POOLSIZE bytes with source > 1 have been
115  added.
116
117 * secmem.c
118   Check whether the memory block is valid before releasing it and
119   print a diagnosic, like glibc does.
120
121 * threads
122 ** We need to document fork problems
123   In particular that reinitialization is required in random.c
124   However, there is no code yet to do it.
125
126 * Tests
127   We need a lot more tests.  Lets keep an ever growing list here.
128 ** Write tests for the progress function
129 ** mpitests does no real checks yet.
130 ** pthreads
131   To catch simple errors like the one fixed on 2007-03-16.
132 ** C++ tests
133   We have some code to allow using libgcrypt from C++, so we also
134   should have a test case.