-TODO for 1.1 And Beyond
+TODO for 1.2 And Beyond
=======================
-lib/silccrypt
-=============
+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.
- o Implement the defined SilcDH API. The definition is in
- lib/silccrypt/silcdh.h.
+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.
- 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.
+Crypto Library, lib/silccrypt/
+==============================
- 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 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 Add DSS support.
+ 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 Cipher optimizations (asm, that this) at least for i386 would be nice.
+ o AES CBC is missing proper alignment code (see silc_1_1_branch).
- o ECDSA and ECDH.
+ 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 Do GCC vs ICC benchmarks of all key algorithms.
-lib/silccore/silcpacket.[ch] ****PARTLY 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 SilcPacketEngine.
+ o Add fingerprint to SilcSILCPublicKey and retrieval to silcpk.h, and
+ possibly to silcpkcs.h.
- o New SILC Packet API.
+ /* 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 Add DSA support to SILC public key.
-lib/silccore/silcid.[ch]
-========================
+ o Global RNG must be changed to use SILC Global API.
- 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 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 silc_id_str2id, silc_id2str to non-allocating routines.
+ 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 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)
-lib/silcutil
-============
+ o Add DSS support. (***DONE)
- o Compression routines are missing. The protocol supports packet
- compression thus it must be implemented. SILC Zip API must be
- defined.
-
- 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 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 bool -> SilcBool
+ o All cipher, hash, hmac etc. allocation routines should take their name
+ in as const char * not const unsigned char *. (***DONE)
- o SilcBit, bit field:
+ o Add ECDSA support.
- #define SilcBit(b) unsigned int b : 1
+ o Add ECDH support.
-lib/silcutil/silcbuffer.h ****DONE****
+SKR Library, lib/silcskr/
=========================
- 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.
-
-
-lib/silcutil/silcbuffmt.[ch] ****PARTY DONE****
-============================
-
- o SILC_STR_APPEND, _APPEND_TAIL.
-
- o SILC_STR_OFFSET
+ o Add fingerprint as search constraint.
+ o Add SSH support. (***DONE, TESTING NEEDED)
-lib/silcutil/silcstack.[ch] ****DONE****
-===========================
+ o Add OpenPGP support. Adding, removing, fetching PGP keys. (Keyring
+ support?)
- o Data stack implementation
+ 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/silcutil/silcstream.[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 abstract SilcStream.
+ NULL argument would be ignored and skipped.
+ o Add OR logical rule in addition of the current default AND, eg:
-lib/silcutil/silcsocketstream.[ch] ****PARTY DONE****
-==================================
+ // 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);
- o Add SilcSocketStream.
+ // 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 SilcStack to SKR API.
-lib/silcutil/epoc/*
-===================
- o lib/silcutil/epoc routines missing or not completed.
-
- o The PKCS#1 also calls global RNG (even though it is not used
- currently in SILC, the interface allows its use).
-
- 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.
-
-
-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 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.
- 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 Add init options to SilcAcceleratorObject as a SilcAcceleratorOption
+ structure. Each accelerator defines the options that they support and
+ can be retrieved from the SilcAccelerator with silc_acc_get_options.
+ The format must also be machine parseable. The structure can be of the
+ following format:
- Other task queues should be changed to use SilcList.
+ typedef struct SilcAcceleratorOptionStruct {
+ const char *option; /* Option name */
+ const char *display_name; /* Option displayable name */
+ SilcParamType type; /* Option data format */
+ void *default_value; /* Option's default value */
+ SilcUInt32 default_value_len; /* Default value length */
+ } *SilcAcceleratorOption;
- 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.
+ For software accelerator it could be for example:
- o Change SILC_TASK_CALLBACK to non-static, and remove the macro
- SILC_TASK_CALLBACK_GLOBAL.
+ { "min_threads", "Minimum threads", SILC_PARAM_UINT32, (void *)2, 4 },
+ { "max_threads", "Maximum threads", SILC_PARAM_UINT32, (void *)4, 4 },
+ o Diffie-Hellman acceleration
-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)
-lib/silcutil/silctime.[ch] ****DONE****
-===========================
+lib/silcmath
+============
- o SilcTime.
+ 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:
- o system time, universal, generalized.
+ SilcBool silc_mp_init_size(SilcMPInt *mp, SilcUInt32 bit_size);
+ SilcBool silc_mp_sinit_size(SilcStack stack, SilcMPInt *mp,
+ SilcUInt32 bit_size);
+ 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.
-lib/silcmath
-============
+ o Add AND, OR and XOR support to TFM or ask Tom to do it.
o The SILC MP API function must start returning indication of success
and failure of the operation.
any other MP function (including utility ones) that may allocate
memory.
+ o Prime generation progress using callback instead of printing to
+ stdout.
+
o All utility functions should be made non-allocating ones.
-lib/silcasn1 ****PARTLY DONE****
+lib/silcasn1
============
- o ASN.1 library
-
- o Header documentation missing.
+ o Negative integer encoding is missing, add it.
- o Some string encodings missing (copy/paste matter).
+ 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/silcpkix
-============
- o PKIX implementation
-
-
-lib/silcutil/silcfsm.[ch] ****DONE****
-=========================
+lib/silcpgp
+===========
- o SILC Finite State Machine API. Replaces SILC Protocol API,
+ 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/silcnet*, lib/silcutil/*/silc*net* ****PARTLY DONE****
-===============================================
+ o Signature verification from public keys, private keys and other signed
+ data (Signature packet).
- o Add UDP interface
+ o Encryption and decryption support (Packet tags 8 and 18 most likely).
- o New network interfaces
+ o Retrieval of User ID from public key and private key (Used ID packet
+ and User Attribute packet).
- 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.
+ o Creation of OpenPGP key pairs.
+ o Trust packet handling (GNU PG compatible) from public and private keys.
-apps/silcd
-==========
+ o Add option that the signature format doesn't use the OpenPGP format
+ but whatever is the default in SILC crypto library.
- o Remove the big switch statement from the function
- silc_server_packet_parse_type and replace it with predefined
- table of function pointers where each of the slot in table
- represents the packet type value.
- Same could be done with notify packets which has big switch
- statement too. Same kind of table of notify callbacks could be
- done as well.
+lib/silcssh
+===========
- o The parser callback in the server will add a timeout task for
- all packets. It will require registering and allocating a
- new task to the SilcSchedule. Maybe, at least, for server
- and router packets the parser would be called immediately
- instead of adding it to the scheduler with 0 timeout. It
- should be analyzed too how slow the task registering process
- actually is, and find out ways to optimize it.
+ 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;
-
- 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 Add reference counters to all Silc*Entry structures
-
- o SERVICEs support (plugin, SIM)
-
- 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 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).
+lib/silcpkix
+============
- o The CMODE cipher & hmac change problem (#101).
+ o PKIX implementation