-TODO for 1.1
-============
+TODO for 1.2 And Beyond
+=======================
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.
-apps/silcd, The SILC Server ****PARTLY DONE****
-===========================
-
- o Port all code to use SILC Toolkit 1.1 APIs.
-
- o Fix/test GETKEY.
-
- o Fix/test MOTD.
-
- o Remove protocol.[ch]. (***DONE)
-
- o Rewrite connecting accepting. (***TESTING NEEDED)
-
- o Rewrite async connecting. (***TESTING NEEDED)
-
- o Connecting from SILC router to SILC server.
-
- o Rewrite rehash, HUP.
-
- o Heartbeat-keepalive.
-
- o Test backup router resuming protocol.
-
- o Check all packet receive routines that they call silc_packet_free.
-
- o Add Web statistics module using lib/silchttp. Give out server
- statistics. (***DONE)
-
-
-SILC Client ****PARTLY DONE****
-===========
-
- o Porting to new Toolkit API and new Client Library API (***TESTING NEEDED)
-
- o Improve help files, especially /cmode, /cumode and /key.
-
-
-lib/silcclient, The Client Library ***PARTLY DONE****
-==================================
-
- o silcclient.h clean up and API rewrites.
- o silcclient_entry.h finishing, all entry relates APIs to this header.
+Crypto Library, lib/silccrypt/
+==============================
- o SilcChannelEntry, SilcServerEntry, SilcChannelUser, allocating,
- freeing, finding, etc. rewrite. Also making them reference counted for
- multi threads use. (***DONE)
+ 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.
- o Rewrite silc_client_get_clients_by_channel.
+ o Change the DSA implementation to support FIPS186-3. This means that
+ the q length is determined by the key length. Also note that specific
+ hash functions must be used with different q lengths.
- o Rewrite client side WHOIS command (for whois -details). (***DONE)
+ o AES CBC is missing proper alignment code (see silc_1_1_branch).
- o Finish all the missing SILC packet processings, rewrites. (***DONE)
+ 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.
- o The client_notify.c rewrite. (***DONE)
+ o Do GCC vs ICC benchmarks of all key algorithms.
- o Resuming to client_register.c (remove client_resume.c) (***DONE)
+ o silc_pkcs_public_key_alloc should accept also SILC_PKCS_ANY as argument
+ and try all supported PKCS until one succeeds (ala load_public_key).
- o Rekey rewrite. (***DONE)
+ o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h, and
+ possibly to silcpkcs.h.
- o Remove protocol.[ch]. (***DONE)
+ /* 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);
- o File transfer rewrite. (***DONE)
+ o Add DSA support to SILC public key.
- o File transfer API documentation.
+ o Global RNG must be changed to use SILC Global API.
- o Connection auth request. (***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)
- o Password auth test, public key auth test.
+ 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 Starting key exchange directly, rewrite. (***DONE)
+ 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 Channel messages, channel private keys, channel entires, channel
- search, etc. rewrite. (***TESTING NEEDED)
+ o Add DSS support. (***DONE)
- o For many APIs leave the hash context allocations to the caller instead
- of using client->sha1hash and client->md5hash, or some kind of thread
- safe (no locking) concept. (***DONE)
+ 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.
- o Key agreement rewrite. (***TESTING NEEDED)
+ o All cipher, hash, hmac etc. allocation routines should take their name
+ in as const char * not const unsigned char *. (***DONE)
- o Connecting to remote client (***DONE)
+ o Add ECDSA support.
- o peer-to-peer private messages
+ o Add ECDH support.
- o Private message waiting API (in threads) (***TESING NEEDED)
- o client_attrs.c, attributes rewrite. (***TESTING NEEDED)
-
- o No SilcBuffer lists back to application in command_reply operations.
- Convert them all to real lists and/or structures for easier use.
- (***DONE)
-
- o Nickname formatting rewrite. (***TESTING NEEDED)
-
- o UDP connections. (***TESTING NEEDED)
-
-
-lib/silcsftp ****DONE****
-============
-
- o Porting to use the new util library. (***DONE)
-
-
-lib/silccore/silcpacket.[ch] ****PARTLY DONE****
-============================
+SKR Library, lib/silcskr/
+=========================
- o SilcPacketEngine. (***DONE)
+ o Add fingerprint as search constraint.
- o New SILC Packet API. (***DONE)
+ o Add SSH support. (***DONE, TESTING NEEDED)
- o Implement silc_packet_engine_stop and silc_packet_stream_destroy. (***DONE)
+ o Add OpenPGP support. Adding, removing, fetching PGP keys. (Keyring
+ support?)
- o IV Included flag support, UDP transport support (***TESTING NEEDED)
+ 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?).
+ o Change the entire silc_skr_find API. Remove SilcSKRFind and just simply
+ add the find constraints as variable argument list to silc_skr_find, eg:
-lib/silccore/silcid.[ch] ****DONE****
-========================
+ silc_skr_find(skr, schedule, callback, context,
+ SILC_SKR_FIND_PUBLIC_KEY, public_key,
+ SILC_SKR_FIND_COUNTRY, "FI",
+ SILC_SKR_FIND_USAGE, SILC_SKR_USAGE_AUTH,
+ SILC_SKR_FIND_END);
- 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. (***DONE)
+ NULL argument would be ignored and skipped.
- o silc_id_str2id, silc_id2str to non-allocating routines. (***DONE)
+ o Add OR logical rule in addition of the current default AND, eg:
+ // Found key(s) MUST have this public key AND this country.
+ silc_skr_find(skr, schedule, callback, context,
+ SILC_SKR_FIND_RULE_AND,
+ SILC_SKR_FIND_PUBLIC_KEY, public_key,
+ SILC_SKR_FIND_COUNTRY, "FI",
+ SILC_SKR_FIND_END);
-lib/silcskr ****PARTLY DONE****
-===========
+ // Found key(s) MUST have this public key OR this key context
+ silc_skr_find(skr, schedule, callback, context,
+ SILC_SKR_FIND_RULE_OR,
+ SILC_SKR_FIND_PUBLIC_KEY, public_key,
+ SILC_SKR_FIND_CONTEXT, key_context,
+ SILC_SKR_FIND_END);
- o Removing key from the repository is not possible currently. It should
- be. (***DONE)
+ o SilcStack to SKR API.
-lib/silcske/silcske.[ch] ***PARTLY DONE****
+SILC Accelerator Library
========================
- o Responder rekey (***TESTING NEEDED)
-
- o IV Included flag support in SKE (***DONE)
-
- o UDP transport changes; retransmission support by using exponential
- backoff algorithm. (***DONE)
-
- o SilcConnAuth header file documentation. (***DONE)
-
-
-lib/silccrypt ****PARTLY DONE****
-=============
-
- o Implement PKCS #1 sign/verify with hash OID. (***TESTING NEEDED)
-
- o Implement SILC Public Key Version 2 handling in sign/verify. Implement
- Version (V) identifier (***DONE)
+ o Diffie-Hellman acceleration
- o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h.
+ 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 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 Implement software accelerator. It is a thread pool system where the
+ public key and private key operations are executed in threads.
(***DONE)
- o Assembler AES (***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 ****PARTLY DONE****
+lib/silcmath
============
- o The regex code from lib/contrib might compile fine on all platforms.
- No need to make it silcutil/unix/ specific. Add them to generic
- silcutil.c. (***TESTNG NEEDED)
-
- o Silc FD Stream to WIN32 (lib/silcutil/silcfdstream.h) (***TESTING NEEDED)
-
- o bool -> SilcBool (***DONE)
-
-
-lib/silcutil/silcbuffer.h ****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. (***DONE)
-
-
-lib/silcutil/silcbuffmt.[ch] ****DONE****
-============================
-
- o SilcStack aware silc_buffer_unformat (***DONE)
-
- o SilcStack aware silc_buffer_format (***DONE)
-
- o silc_buffer_format reallocates automatically (***DONE)
-
- o SILC_STR_OFFSET (***DONE)
-
-
-lib/silcutil/silcstack.[ch] ****DONE****
-===========================
-
- o Data stack implementation (***DONE)
-
-
-lib/silcutil/silcstream.[ch] ****DONE****
-============================
-
- o Add abstract SilcStream. (***DONE)
+ 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's fp_int dynamic so that a specific
+ size can be allocated for the int. We could have two new functions:
+ SilcBool silc_mp_init_size(SilcMPInt *mp, SilcUInt32 bit_size);
+ SilcBool silc_mp_sinit_size(SilcStack stack, SilcMPInt *mp,
+ SilcUInt32 bit_size);
-lib/silcutil/silcsocketstream.[ch] ****PARTY DONE****
-==================================
+ Which by default allocates `bit_size' bits instead of some default
+ value. silc_mp_init would allocate the default FP_SIZE with TFM
+ and do normal init with TMA and GMP. _init_size with TMA and GMP
+ would be same as _init.
- o Add SilcSocketStream (***DONE)
+ o Add AND, OR and XOR support to TFM or ask Tom to do it.
- o Add SilcSocketStream for WIN32 (***TESTING NEEDED)
+ o The SILC MP API function must start returning indication of success
+ and failure of the operation.
- o Test QoS after the changes made to socket stream
+ 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 Prime generation progress using callback instead of printing to
+ stdout.
-lib/silcutil/silcschedule*.[ch] ****PARTLY DONE****
-===============================
+ o All utility functions should be made non-allocating ones.
- 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.
- 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).
-
- Other task queues should be changed to use SilcList. (***DONE)
-
- 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.
- (***DONE)
-
- o Change SILC_TASK_CALLBACK to non-static, and remove the macro
- SILC_TASK_CALLBACK_GLOBAL. (***DONE)
-
- o SILC Schedule API changes to WIN32. (***TESTING NEEDED)
-
-
-lib/silcutil/silcasync.[ch] ****DONE****
-===========================
-
- o Add SilcAsyncOperation to utility library. Any function that takes
- callback as an argument must/should return SilcAsyncOperation.
- (***DONE)
-
-
-lib/silcutil/silctime.[ch] ****PARTLY DONE****
-===========================
+lib/silcasn1
+============
- o SilcTime. (***DONE)
+ o Negative integer encoding is missing, add it.
- o system time, universal, generalized. (***DONE)
+ 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 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/silcutil/silcfsm.[ch] ****DONE****
-=========================
-
- o SILC Finite State Machine API. Replaces SILC Protocol API (***DONE)
+lib/silcpgp
+===========
-lib/silcutil/silcnet*, lib/silcutil/*/silc*net* ****PARTLY DONE****
-===============================================
+ o OpenPGP certificate support, allowing the use of PGP public keys and
+ private keys.
- o Add UDP interface (***DONE)
+ o Signatures for data, public keys and private keys (Signature packet).
- o Add UDP interface for WIN32 (***TESTING NEEDED)
+ o Signature verification from public keys, private keys and other signed
+ data (Signature packet).
- o New network interfaces (***DONE)
+ 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/silcmath
-============
+ o Creation of OpenPGP key pairs.
- o Test on x86_64.
+ o Trust packet handling (GNU PG compatible) from public and private keys.
- o Change LTM and TFM function names when importing to SILC tree to avoid
- rare linking problems on system that has same named symbols already in
- the system.
+ o Add option that the signature format doesn't use the OpenPGP format
+ but whatever is the default in SILC crypto library.
-lib/silcutil/symbian/ ****PARTLY DONE****
-=====================
+lib/silcssh
+===========
- o lib/silcutil/symbian routines missing or not completed.
- (****TESTING NEEDED)
+ 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 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 SSH2 public key/private key support, allowing the use of SSH2 keys.
+ RFC 4716. (***DONE)
-lib/silcasn1 ****PARTLY DONE****
+lib/silcpkix
============
- o ASN.1 library (***DONE)
-
- o Header documentation missing. (***DONE)
-
- o Some string encodings missing (copy/paste matter). (***DONE)
+ o PKIX implementation