X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=blobdiff_plain;f=TODO;h=e6950f06db8f133972622b978e342ba7981d623d;hp=dac3d03fd81c1fca59dd8cb80d012ef9ec4b4486;hb=HEAD;hpb=65691401931da2f4ad4473f650d42e161274e784 diff --git a/TODO b/TODO index dac3d03f..e6950f06 100644 --- a/TODO +++ b/TODO @@ -11,33 +11,6 @@ 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. -General -======= - - o Create apps/tutorial containing various Toolkit API tutorials. - - o The Toolkit split. The Toolkit is to be splitted in parts. How many - parts and what the parts are isn't decided yet. Each part is a separate - software package. Current thinking is of the following: - - SILC Toolkit SILC protocol, client and server library - SILC Runtime Toolkit runtime library - SILC Crypto Toolkit crypto, asn1, math, skr, pgp, etc. - - The rationale for this is of course that other than SILC projects - might like to use the various libraries SILC Toolkit provides, but - naturally they don't want the bloat of SILC protocol related stuff. - - The Runtime library in SILC Toolkit is a general purpose runtime library, - like Glib and APR are. The runtime library is to be developed further - to provide alternative to Glib and APR. - - The Crypto library in SILC Toolkit is a general purpose crypto library - providing pretty nice APIs compared to many other crypto libraries, - especially OpenSSL. The Crypto library is to be developed further - to include support for OpenPGP, X.509 and SSH2. - - lib/silccore ============ @@ -46,7 +19,7 @@ lib/silccore o All payload encoding routines should take SilcStack as argument. - o Remove SilcCommandCb from silccommand.h. + o Remove SilcCommandCb from silccommand.h. (***DONE) o All payload test routines into lib/silccore/tests/. @@ -54,6 +27,12 @@ lib/silccore lib/silcclient, The Client Library ================================== + o LIST command should take server name as argument, a server name whose + channels to list. This way it is possible to list channels from + any server in internet, eg. /LIST example.com. + + o UDP SILC connection support to SILC server + o Giving WHOIS for nick that doesn't exist should remove any same named entries from the client cache. @@ -66,6 +45,10 @@ lib/silcclient, The Client Library never joined the channel if this happens. What to do if message is received from user that hasn't been resolved/joined? + o Connection option that attemps to connect to remot host with various + different mechanisms: UDP 706, TCP 706, TCP 80, TCP 443, UDP 7706 and + TCP 7706. This is the so called hole punching mechanism. + o Message ACKing support. o in /cmode and /cumode with +r, maybe the public key and private key @@ -76,165 +59,12 @@ lib/silcclient, The Client Library should provide events so that application developer has a choice of developing the SILC app with callbacks or with events. + o Ability to recover from rekey errors, at least try to. -Runtime library, lib/silcutil/ -============================== - - o Fix universal time decoding (doesn't accept all formats) in silctime.c. - - o Add functions to manipulate environment variables. (***DONE) - - o Add functions to loading shared/dynamic object symbols (replaces the - SIM library (lib/silcsim) and introduces generic library). Add this - to lib/silcutil/silcdll.[ch]. (***TESTING NEEDED WIN32, TODO Symbian) - - o Add directory opening/traversing functions - - o silc_getopt routines - - o The SILC Event signals. Asynchronous events that can be created, - connected to and signalled. Either own event routines or glued into - SilcSchedule: - - SilcTask silc_schedule_task_add_event(SilcSchedule schedule, - const char *event, ...); - SilcBool silc_schedule_event_connect(SilcSchedule schedule, - const char *event, - SilcTaskCallback event_callback, - void *context); - SilcBool silc_schedule_event_signal(SilcSchedule schedule, - const char *event, ...); - - Example: - silc_schedule_task_add_event(schedule, "connected", - SILC_PARAM_UI32_INT, - SILC_PARAM_BUFFER, - SILC_PARAM_END); - silc_schedule_event_connect(schedule, "connected", connected_cb, ctx); - silc_schedule_event_signal(schedule, "connected", integer, buf, - SILC_PARAM_END); - SILC_TASK_CALLBACK(connected_cb) - { - FooCtx ctx = context; - va_list args; - SilcUInt32 integer; - SilcBuffer buf; - - va_start(args, context); - integer = va_arg(args, SilcUInt32); - buf = va_arg(args, SilcBuffer); - va_end(args); - ... - } - - Problems: Events would be SilcSchedule specific, and would not work on - multi-thread/multi-scheduler system. The events should be copyable - between schedulers. Another problem is the signal delivery. Do we - deliver them synchronously possibly from any thread to any other thread - or do we deliver them through the target schedulers. If we use the - schedulers then signalling would be asynchronous (data must be - duplicated and later freed) which is not very nice. - - o If the event signals are added, the SILC_PARAM_* stuff needs to be - moved from silcbuffmt.h to silctypes.h or something similar. - - o In case the SILC Events are done we shall create a new concept of - parent and child SilcSchedule's. When new SilcSchedule is created a - parent can be associated to it. This association could be done either - directly by the parent or by any other children. This way the signals - would in effect be global and would reach all children schedulers. - - This relationship would be associative only. The schedulers are still - independent and run independently from each other. All schedulers - would be linked and could be accessed from any of the schedulers. - It should be possible to retrieve the parent and enumate all children - from any of the schedulers. - - SilcSchedule silc_schedule_init(int max_tasks, void *app_context, - SilcSchedule parent); - SilcSchedule silc_schedule_get_parent(SilcSchedule schedule); - - o Additional scheduler changes: optimize silc_schedule_wakeup. Wakeup - only if the scheduler is actually waiting something. If it is - delivering tasks wakeup is not needed. - - o Structured log messages to Log API. Allows machine readable log - messages. Would allow sending of any kind of data in a log message. - - o Base64 to an own API - - o Timer API - - 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 silc_stringprep to non-allocating version. - - o silc_hash_table_replace -> silc_hash_table_set. Retain support for - silc_hash_table_replace as macro. (***DONE) - - o SilcStack aware SilcHashTable. (***DONE) - - o SilcStack aware SilcDList. (***DONE) - - o Thread pool API. Add this to lib/silcutil/silcthread.[ch]. (***DONE) - - o Fast mutex implementation. Fast rwlock implementation. Mutex and - rwlock implementation using atomic operations. - - o Compression routines are missing. The protocol supports packet - compression thus it must be implemented. SILC Zip API must be - defined. - - o Add new functions to SilcStack API in lib/silcutil/silcstack.[ch]. Add - silc_stack_[set|get]_alignment. It defines the default alignment used - when allocating memory from stack. It can be used to specify special - alignments too when needed (such as for hardware devices like crypto - accelerators). Move also the low level silc_stack_malloc and - silc_stack_realloc from silcstack_i.h to silcstack.h. Remove the - _ua unaligned memory allocation routines. Remove unaligned memory - allocation possibility. (***DONE) - - o Add '%@' format to silc_snprintf functions. It marks for external - rendering function of following type: - - /* Snprintf rendering function. The `data' is rendered into a string - and allocated string is returned. If NULL is returned the - rendering is skipped and ignored. If the returned string does - not fit to the destination buffer it may be truncated. */ - typedef char *(*SilcSnprintfRender)(void *data); - - It can work like following: - - char *id_renderer(void *data) - { - char tmp[32]; - id_to_str(tmp, sizeof(tmp), (SilcID *)data); - return strdup(tmp); - } - - silc_snprintf(buf, sizeof(buf), "Client ID %@", id_renderer, client_id); - - (o Generic SilcStatus or SilcResult that includes all possible status and - error conditions, including those of SILC protocol. Though, the SILC - protocol related status (currently in silcstatus.h) cannot be in - runtime library) maybe - - (o SILC specific socket creation/closing routines to silcnet.h, wrappers - to all send(), recv(), sendto() etc. Bad thing is that we'd have to - define all socket options, sockaddrs, etc.) maybe - - (o mmap) maybe - - -lib/silcutil/symbian/ -===================== - - 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. The logging currently works - by it cannot be controlled, same with debugging. + o Add the SilcStream (socket stream) from the SilcPacketStream and + SilcSocket from the socket stream to SilcClientConnection for easier + access to them for programmers. Currently these have to be digged up + from the packet stream. (***DONE) SFTP Library, lib/silcsftp/ @@ -244,184 +74,12 @@ SFTP Library, lib/silcsftp/ be done easily. -SKR Library, lib/silcskr/ -========================= - - o Add fingerprint as search constraint. - - 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?). - - 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: - - 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); - - NULL argument would be ignored and skipped. - - 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); - - // 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. - - -Crypto Library, lib/silccrypt/ -============================== - - 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 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); - - 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) - - o Add DSS support. Take implementation from Tom or make it yourself. - - 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 ECDSA and ECDH - - o All cipher, hash, hmac etc. allocation routines should take their name - in as const char * not const unsigned char *. - - -SILC Accelerator Library -======================== - - 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 Implement software accelerator. It is a thread pool system where the - public key and private key operations are executed in threads. - (***DONE) - - o Diffie-Hellman acceleration - - (o Symmetric key cryptosystem acceleration? They are always sycnhronouos - even with hardware acceleration so the crypto API shouldn't require - changes.) maybe - - -lib/silcmath -============ - - 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. - - We want TFM's speed but not TFM's memory requirements. Talk to Tom - about making the TFM mp dynamic just as it is in LTM. - - o The SILC MP API function must start returning indication of success - and failure of the operation. - - 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. - - -SILC XML Library, lib/silcxml/ -============================== - - o SILC XML API (wrapper to expat). Look at the expat API and simplify - it. The SILC XML API should have at most 8-10 API functions. It should - be possible to create full XML parser with only one function. And, it - should be possible to have a function that is able to parse an entire - XML document. It should also have a parser function to be able to - parse a stream of XML data (SilcStream). It MUST NOT have operations - that require multiple function calls to be able to execute that one - operation (like creating parser). - - lib/silcske/silcske.[ch] ======================== o Ratelimit to UDP/IP transport for incoming packets. -lib/silcasn1 -============ - - o Negative integer encoding is missing, add it. - - 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/silcpgp -=========== - - o OpenPGP certificate support, allowing the use of PGP public keys - in SILC. - - -lib/silcssh -=========== - - o SSH2 public key/private key support, allowing the use of SSH2 keys - in SILC. RFC 4716. - - -lib/silcpkix -============ - - o PKIX implementation - - apps/silcd ========== @@ -471,8 +129,12 @@ lib/silcserver o Library must have support for SERVICE command. + o Both UDP and TCP support for incoming connecetions. Maintaining long + term UDP sessions. + o The server must be able to run behind NAT device. This means that - Server ID must be based on public IP instead of private IP. + Server ID must be based on public IP instead of private IP (See + also NAT detection protocol in SILC protocol specification). o The following data must be in per-connection context: client id cache, server id cache, channel id cache, all statistics must be @@ -484,10 +146,34 @@ lib/silcserver o Do inccoming packet processing in an own FSM thread in the server-threads FSM. Same as in client library. + o Binding to other ports than 706 too. To allow easier traversing + through NATs and firewalls server should also bind to 80, 443 and 7706 + by default (at least try to bind). Connections must work normally + even if they were established to some other port other than 706. + + Connection option that attemps to connect to remot server with various + different mechanisms: UDP 706, TCP 706, TCP 80, TCP 443, UDP 7706 and + TCP 7706. This is the so called hole punching mechanism. + + o Ability to recover from rekey errors, at least try to. + o Reference count all Silc*Entry structures. + o All channel names in any command (where appropriate) must be allowed to + be in format channel@server so that the server can be connected to do + the command for the channel. Change protocol if it doesn't allow it. + + o All nicknames in any command (where appropriate) must be allowed to be + in format nick@server so that the server can be connected to do the + command for the nickname. Change protocol if it doesn't allow it. + Some issues that must be kept in mind from 1.0 and 1.1 silcd's: + o The server and router software MUST work out of the box. After + installation the server must not require any configuration to run the + most basic working configuration. No defining IP addresses, etc. + The server must work just by running it. + 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