Added silc_mp_format and silc_mp_unformat MP integer encoder/decoder
[crypto.git] / TODO
diff --git a/TODO b/TODO
index b455481c91a058acc5dd0fe211f196e7b2116c8b..81a3dcb857ada66d4770c2b130e800c49d96add5 100644 (file)
--- a/TODO
+++ b/TODO
-TODO for 1.1 And Beyond
+TODO for 1.2 And Beyond
 =======================
 
-lib/silccrypt                  ****PARTLY DONE****
-=============
-
- o Implement the defined SilcDH API.  The definition is in
-   lib/silccrypt/silcdh.h.
-
- o SSH2 public keys support, allowing the use of SSH2 public keys in
-   SILC.
-
- o OpenPGP certificate support, allowing the use of PGP public keys
-   in SILC.
-
- o SILC PKCS (silcpkcs.h) reorganizing when other PK supports added.
-   Move the SILC Public Key routines away from the crypto library into
-   the core library (silccore).  silc_pkcs_public/private_key_* routines
-   to silc_public/private_key_* routines.  The silc_public_key_* routines
-   should also automatically handle SILC Public Keys, and other keys
-   and certificates as well.  Add fe. silcpk.h into silccore.  It should
-   also include the Public Key Payload encoding and decoding routines.
-
- o Add DSS support.
-
- o Cipher optimizations (asm, that this) at least for i386 would be nice.
-
- o ECDSA and ECDH.
+NOTE: Any item that doesn't have (***DONE) in it, isn't done yet.  The
+(***TESTING NEEDED) means that the item has been done but not yet properly
+tested.
 
+NOTE: A TODO entry does not mean that it is ever going to be done.  Some
+of the entries may be just ideas, good, bad or ugly.  If you want to work
+on some of the TODO entries simply let us know about it by dropping a note
+to silc-devel mailing list or appear on 'silc' channel on SILCNet.
 
-lib/silccore/silcpacket.[ch]   ****DONE****
-============================
 
- o SilcPacketEngine.
+Crypto Library, lib/silccrypt/
+==============================
 
- o New SILC Packet API.
+ o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h, and
+   possibly to silcpkcs.h.
 
+   /* Return fingerprint of the `public_key'.  Returns also the algorithm
+      that has been used to make the fingerprint. */
+   const unsigned char *
+   silc_pkcs_get_fingerprint(SilcPublicKey public_key,
+                            const char **hash_algorithm,
+                            SilcUInt32 *fingerprint_len);
 
-lib/silccore/silcpacket.[ch]
-============================
+ o Add CMAC and maybe others.  Change needs rewrite of the internals of
+   the SILC Mac API, currently it's suitable only for HMACs.
 
- o IV Included flag support, UDP transport support
+ o Global RNG must be changed to use SILC Global API.
 
+ o Global cipher, hash, mac, and pkcs tables must use SILC Global API.
 
-lib/silccore/silcid.[ch]       ****DONE****
-========================
-
-  o Add silc_id_str2id to accept the destination buffer as argument
-    and thus not require any memory allocation.  Same will happen
-    with silc_id_payload_* functions.
-
-  o silc_id_str2id, silc_id2str to non-allocating routines.
+ o Add FIPS compliant RNG.
 
+ o Implement the defined SilcDH API.  The definition is in
+   lib/silccrypt/silcdh.h.  Make sure it is asynchronous so that it can
+   be accelerated.  Also take into account that it could use elliptic
+   curves.
 
-lib/silccore
-============
-
-  o All payload encoding routines should take SilcStack as argument.
-
+ o Add Elgamal.
 
-lib/silcutil                   ****PARTLY DONE****
-============
+ o Add ECDSA support.
 
- o Compression routines are missing.  The protocol supports packet
-   compression thus it must be implemented.  SILC Zip API must be
-   defined.
+ o Add ECDH support.
 
- o Add builtin SOCKS and HTTP Proxy support, well the SOCKS at least.
-   SILC currently supports SOCKS4 and SOCKS5 but it needs to be compiled
-   in separately.
+ o Add PKCS#1 RSAES-OAEP and RSASSA-PSS.
 
- o bool -> SilcBool
+ o Add GCM mode.
 
- o SilcBit, bit field:
+ o Do GCC vs ICC benchmarks of all key algorithms.
 
-   #define SilcBit(b) unsigned int b : 1
+ o Add DSA support to SILC public key.
 
+ o The asynchronous functions to perhaps to _async to preserve backwards
+   compatibility with synchronous versions, and make easier to migrate
+   from 1.1 to 1.2. (***DONE)
 
-lib/silcutil/silcbuffer.h      ****DONE****
-=========================
+ o AES CBC is missing proper alignment code. (***DONE)
 
- o Remove the `truelen' field from SilcBuffer as it is entirely
-   redundant since we can get the true length of the buffer by
-   doing buffer->end - buffer->header.  Add silc_buffer_truelen
-   macro instead.  Consider also removing `len' field too since
-   it effectively is buffer->tail - buffer->data, and adding
-   silc_buffer_len macro can do the same.  These would save
-   totally 8 bytes of memory per buffer.
+ o silc_pkcs_public_key_alloc should accept also SILC_PKCS_ANY as argument
+   and try all supported PKCS until one succeeds. (***DONE)
 
+ o Associate a default hash function with all PKCS algorithms.  User can
+   override it in silc_pkcs_sign.  DSA with FIPS186-3 determines the
+   hash algorithm by the key length. (***DONE)
 
-lib/silcutil/silcbuffmt.[ch]   ****PARTY DONE****
-============================
+ o Document all cipher names, hash names, mac names, pkcs names. (***DONE)
 
- o SILC_STR_APPEND, _APPEND_TAIL.
+ o SilcHmac must be replaced with generic SilcMac so that we can add
+   others than just HMAC algorithms.  Backwards support (via #define's)
+   must be preserved. (***DONE)
 
- o SILC_STR_OFFSET
+ o Change the DSA implementation to support FIPS186-3.  This means that
+   the q length is determined by the key length.  (***DONE)
 
+ o Add silc_crypto_init and silc_crypto_uninit.  The _init should take
+   SilcStack that will act as global memory pool for all of crypto
+   library.  It should not be necessary anymore to separately register
+   default ciphers, HMACs, etc, the _init would do that.  However, if
+   user after _init calls silc_pkcs_register, for example, it would take
+   preference over the default once, ie. user can always dictate the
+   order of algorithms. (***DONE)
 
-lib/silcutil/silcstack.[ch]    ****DONE****
-===========================
+ o Change SILC PKCS API to asynchronous, so that accelerators can be used.
+   All PKCS routines should now take callbacks as argument and they should
+   be delivered to SilcPKCSObject and SilcPKCSAlgorithm too. (***DONE)
 
- o Data stack implementation
+ o Change PKCS Algorithm API to take SilcPKCSAlgorithm as argument to
+   encrypt, decrypt, sign and verify functions.  We may need to for exmaple
+   check the alg->hash, supported hash functions.  Maybe deliver it also
+   to all other functions in SilcPKCSAlgorithm to be consistent. (***DONE)
 
+ o Add DSS support. (***DONE)
 
-lib/silcutil/silcstream.[ch]   ****DONE****
-============================
+ o All cipher, hash, hmac etc. allocation routines should take their name
+   in as const char * not const unsigned char *. (***DONE)
 
- o Add abstract SilcStream.
 
+SKR Library, lib/silcskr/
+=========================
 
-lib/silcutil/silcsocketstream.[ch]     ****PARTY DONE****
-==================================
+ o Add fingerprint as search constraint.
 
- o Add SilcSocketStream.
+ o Add SSH support. (***DONE, TESTING NEEDED)
 
- o Test QoS
+ o Add OpenPGP support.  Adding, removing, fetching PGP keys.  (Keyring
+   support?)
 
+ o Add support for importing public keys from a directory and/or from a
+   file.  Add support for exporting the repository (different formats for
+   different key types?).
 
-lib/silcutil/epoc/*
-===================
+ o Add find rule AND and OR.  The default is always AND.  Add
+   silc_skr_find_set_rule.
 
-  o lib/silcutil/epoc routines missing or not completed.
+ o Add silc_skr_find_add_search_file that can be used to add a file to
+   search for the public keys.  More than one can be set.  Add support
+   for searching keys from file.
 
-  o The PKCS#1 also calls global RNG (even though it is not used
-    currently in SILC, the interface allows its use).
+ o Add silc_skr_find_add_search_dir that can be used to add a directory to
+   search for the public keys.  More than one can be set.  Add support
+   for seraching keys from directory.
 
-  o Something needs to be thought to the logging globals as well,
-    like silc_debug etc.  They won't work on EPOC.  Perhaps logging
-    and debugging is to be disabled on EPOC.
+ o SilcStack to SKR API.
 
 
-lib/silcutil/silcschedule*.[ch]                ****DONE****
-===============================
+SILC Accelerator Library
+========================
 
- o Scheduler can be optimized for FD tasks by changing the fd_queue
-   to SilcHashTable instead of using linked list.  We need to do
-   one-to-one mapping of FD to task and hash table is more efficient
-   for this usage.
+ o Diffie-Hellman acceleration to SILC Accelerator API.
 
-   Also redefine the silc_select to perhaps return a separate
-   structure of the events that actually occurred, instead of
-   returning the events in the fd_list which is then traversed
-   in the generic code to find the changed events.  This can be
-   made faster by having own struct which includes only the
-   changed events, thus the tarversing is faster since the whole
-   fd_list is not traversed anymore (it is still traversed in the
-   silc_select but at least it removes one extra tarversing later
-   for the same list).
+ o Diffie-Hellman software acceleration.
 
-   Other task queues should be changed to use SilcList.
+ o Hardware acceleration through OCF (OCF-Linux,
+   http://ocf-linux.sourceforge.net).
 
- o Add SILC scheduler's internal routines into a table of implementation
-   function pointers, that the generic code then takes as extern from
-   implementation.  These are the silc_schedule_internal_* routines.
+ o VIA Padlock support. See http://www.logix.cz/michal/devel/padlock/ and
+   Gladman's code.
 
- o Change SILC_TASK_CALLBACK to non-static, and remove the macro
-   SILC_TASK_CALLBACK_GLOBAL.
+ o Implement GCM software acceleration.
 
+ o Add hash function acceleration to SILC Accelerator API.
 
-lib/silcutil/silcasync.[ch]    ****DONE****
-===========================
+ o SILC Accelerator API.  Provides generic way to use different kind of
+   accelerators.  Basically implements SILC PKCS API so that SilcPublicKey
+   and SilcPrivateKey can be used but they call the accelerators.
+   (***DONE)
 
- o Add SilcAsyncOperation to utility library.  Any function that takes
-   callback as an argument must/should return SilcAsyncOperation.
+ o Implement software accelerator.  It is a thread pool system where the
+   public key and private key operations are executed in threads.
+   (***DONE)
 
+ o Add SilcCipher support to SilcAccelerator and software accelerator.
+   Accelerate at least ciphers using CTR mode which can be done in
+   parallel.  Do it in producer/consumer fashion where threads generate
+   key stream and other thread(s) encrypt using the key stream. (***DONE)
 
-lib/silcutil/silctime.[ch]     ****DONE****
-===========================
 
- o SilcTime.
+lib/silcmath
+============
 
- o system time, universal, generalized.
+ o Prime generation progress using callback instead of printing to
+   stdout.
 
+ o All utility functions should be made non-allocating ones.
 
-lib/silcmath
-============
+ o Import TFM.  We want TFM's speed but its memory requirements are
+   just too much.  By default it uses large pre-allocated tables which
+   will eat memory when there are thousands of public keys in system.
+   We probably want to change TFM. (***DONE)
 
- o Import TFM.  Talk to Tom to add the missing functions.  Use TFM in
-   client and client library, but TMA in server, due to the significantly
-   increased memory consumption with TFM, and the rare need for public
-   key operations in server.
+ o Add AND, OR and XOR support to TFM. (***DONE)
 
  o The SILC MP API function must start returning indication of success
-   and failure of the operation.
+   and failure of the operation. (***DONE)
 
- o Do SilcStack support for silc_mp_init, silc_mp_init_size and other
-   any other MP function (including utility ones) that may allocate
-   memory.
-
- o All utility functions should be made non-allocating ones.
+ o Do SilcStack support for silc_mp_init and other MP function
+   (including utility ones) that may allocate memory. (***DONE)
 
 
-lib/silcasn1                   ****PARTLY DONE****
+lib/silcasn1
 ============
 
- o ASN.1 library
+ o Negative integer encoding is missing, add it.
 
- o Header documentation missing.
+ o SILC_ASN1_CHOICE should perhaps return an index what choice in the
+   choice list was found.  Currently it is left for caller to figure out
+   which choice was found. (***DONE)
 
- o Some string encodings missing (copy/paste matter).
+ o SILC_ASN1_NULL in decoding should return SilcBool whether or not
+   the NULL was present.  It's important when it's SILC_ASN1_OPTIONAL
+   and we need to know whether it was present or not. (***DONE)
 
 
-lib/silcpkix
-============
+lib/silcpgp
+===========
 
- o PKIX implementation
+ o OpenPGP certificate support, allowing the use of PGP public keys and
+   private keys.
 
+ o Signatures for data, public keys and private keys (Signature packet).
 
-lib/silcutil/silcfsm.[ch]      ****DONE****
-=========================
+ o Signature verification from public keys, private keys and other signed
+   data (Signature packet).
 
- o SILC Finite State Machine API.  Replaces SILC Protocol API,
+ o Encryption and decryption support (Packet tags 8 and 18 most likely).
 
+ o Retrieval of User ID from public key and private key (Used ID packet
+   and User Attribute packet).
 
-lib/silcutil/silcnet*, lib/silcutil/*/silc*net*                ****PARTLY DONE****
-===============================================
+ o Creation of OpenPGP key pairs.
 
- o Add UDP interface
+ o Trust packet handling (GNU PG compatible) from public and private keys.
 
- o New network interfaces
+ o Add option that the signature format doesn't use the OpenPGP format
+   but whatever is the default in SILC crypto library.
 
- o Other functions should remain as they are since these new functions have
-   to use them.  This way we also provide them for applications that want
-   to handle the sockets by themself.
 
+lib/silcssh
+===========
 
-lib/silcserver
-==============
+ o Add option that the signature format doesn't use the SSH2 protocol
+   but whatever is the default in SILC crypto library;
+   silc_ssh_private_key_set_signature_type, or something.
 
- o The SERVER_SIGNOFF notify handing is not optimal, because it'll
-   cause sending of multiple SIGNOFF notify's instead of the one
-   SERVER_SIGNOFF notify that the server received.  This should be
-   optimized so that the only SERVER_SIGNOFF is sent and not
-   SIGNOFF of notify at all (using SIGNOFF takes the idea about
-   SERVER_SIGNOFF away entirely).
+ o SSH2 public key/private key support, allowing the use of SSH2 keys.
+   RFC 4716.  (***DONE)
 
- o Another SERVER_SIGNOFF opt/bugfix:  Currently the signoff is
-   sent to a client if it is on same channel as the client that
-   signoffed.  However, the entire SERVER_SIGNOFF list is sent to
-   the client, ie. it may receive clients that was not on the
-   same channel.  This is actually against the specs.  It must be
-   done per channel.  It shouldn't receive the whole list just
-   because one client happened to be on same channel.
 
- o MAYBE: The SilcChannelClientEntry can be:
-       SilcUInt32 address;
-       SilcUInt32 mode;
+lib/silcpkix
+============
 
-  where address is SilcClientEntry address XOR SilcChannelEntry.
-  You can get SilcClientEntry by doing client = chl->address XOR channel,
-  and SilcChannelEntry by doing channel = chl->address XOR client.
-  As long as the other pointer is always available when accessing the
-  structure this can be done.
+ o PKIX implementation
 
- o Add reference counters to all Silc*Entry structures
 
- o SERVICEs support (plugin, SIM)
+lib/silccms
+===========
 
- o If client's public key is saved in the server (and doing public key
-   authentication) then the hostname and the username information could
-   be taken from the public key.  Should be a configuration option!
+ o Cryptographic Message Syntax (RFC 3852), the former PKCS #7
 
- o Add a timeout to handling incoming JOIN commands.  It should be
-   enforced that JOIN command is executed only once in a second or two
-   seconds.  Now it is possible to accept n incoming JOIN commands
-   and process them without any timeouts.  THis must be employed because
-   each JOIN command will create and distribute the new channel key
-   to everybody on the channel (Fix this to 0.9.x).
 
- o Related to above.  If multiple JOINs are received in sequence perhaps
-   new key should be created only once, if the JOINs are handeled at the same
-   time.  Now we create multiple keys and never end up using them because
-   many JOINs are processed at the same time in sequence.  Only the last
-   key ends up being used.
+lib/silcsmime
+=============
 
- o The CMODE cipher & hmac change problem (#101).
+ o S/MIME (RFC 3851)