X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=blobdiff_plain;f=lib%2Fsilccore%2Fsilcpacket.h;h=0caf10d8c21bc8b54c245e3311265b8b785e6e9a;hp=dfc659004a9237b5b218173c9eb79a3bbccebf9a;hb=1cc9af890006b0181913d4f84909442744476745;hpb=a48f197048c2cad8fc48062bf00c71ece3f3c9e3 diff --git a/lib/silccore/silcpacket.h b/lib/silccore/silcpacket.h index dfc65900..0caf10d8 100644 --- a/lib/silccore/silcpacket.h +++ b/lib/silccore/silcpacket.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - Copyright (C) 1997 - 2006 Pekka Riikonen + Copyright (C) 1997 - 2007 Pekka Riikonen This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -17,7 +17,7 @@ */ -/****h* silccore/Packet Protocol Interface +/****h* silccore/SILC Packet Engine Interface * * DESCRIPTION * @@ -34,8 +34,6 @@ #ifndef SILCPACKET_H #define SILCPACKET_H -/* XXX many of these could go to silcpacket_i.h */ - /* Maximum packet length */ #define SILC_PACKET_MAX_LEN 0xffff @@ -85,6 +83,7 @@ typedef SilcUInt8 SilcPacketType; #define SILC_PACKET_RESUME_ROUTER 26 /* Backup router resume */ #define SILC_PACKET_FTP 27 /* File Transfer */ #define SILC_PACKET_RESUME_CLIENT 28 /* Client resume */ +#define SILC_PACKET_ACK 29 /* Acknowledgement */ #define SILC_PACKET_PRIVATE 200 /* Private range start */ #define SILC_PACKET_MAX 255 /* RESERVED */ @@ -113,9 +112,10 @@ typedef SilcUInt8 SilcPacketFlags; #define SILC_PACKET_FLAG_LIST 0x02 /* Packet is a list */ #define SILC_PACKET_FLAG_BROADCAST 0x04 /* Packet is a broadcast */ #define SILC_PACKET_FLAG_COMPRESSED 0x08 /* Payload is compressed */ +#define SILC_PACKET_FLAG_ACK 0x10 /* Acknowledge packet */ /* Impelemntation specific flags */ -#define SILC_PACKET_FLAG_LONG_PAD 0x10 /* Use maximum padding */ +#define SILC_PACKET_FLAG_LONG_PAD 0x20 /* Use maximum padding */ /***/ /****s* silccore/SilcPacketAPI/SilcPacketEngine @@ -196,6 +196,9 @@ typedef struct SilcPacketStruct { * from the actual stream. It can retrieve the underlaying stream from * the packet stream by calling silc_packet_stream_get_stream function. * + * You may retrieve string version of the SilcPacketError by calling + * silc_packet_error_string. + * * SOURCE */ typedef enum { @@ -308,11 +311,11 @@ typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine, void *callback_context, void *stream_context); -/****s* silccore/SilcPacketAPI/SilcPacketStream +/****s* silccore/SilcPacketAPI/SilcPacketCallbacks * * NAME * - * typedef struct SilcPacketStreamStruct *SilcPacketStream; + * typedef struct { ... } *SilcPacketCallbacks; * * DESCRIPTION * @@ -358,7 +361,7 @@ typedef struct { ***/ SilcPacketEngine silc_packet_engine_start(SilcRng rng, SilcBool router, - SilcPacketCallbacks *callbacks, + const SilcPacketCallbacks *callbacks, void *callback_context); /****f* silccore/SilcPacketAPI/silc_packet_engine_stop @@ -375,6 +378,52 @@ silc_packet_engine_start(SilcRng rng, SilcBool router, ***/ void silc_packet_engine_stop(SilcPacketEngine engine); +/****f* silccore/SilcPacketAPI/silc_packet_error_string + * + * SYNOPSIS + * + * const char *silc_packet_error_string(SilcPacketError error); + * + * DESCRIPTION + * + * Return the packet error as string. + * + ***/ +const char *silc_packet_error_string(SilcPacketError error); + +/****f* silccore/SilcPacketAPI/silc_packet_engine_get_streams + * + * SYNOPSIS + * + * SilcDList silc_packet_engine_get_streams(SilcPacketEngine engine); + * + * DESCRIPTION + * + * Returns list of packet streams added to the packet engine. The caller + * must free the list with silc_packet_engine_free_streams_list. + * + * NOTES + * + * This function may also return disconnected and destroyed streams. The + * caller should use silc_packet_stream_is_valid to check if the stream + * is valid. + * + ***/ +SilcDList silc_packet_engine_get_streams(SilcPacketEngine engine); + +/****f* silccore/SilcPacketAPI/silc_packet_engine_free_streams_list + * + * SYNOPSIS + * + * void silc_packet_engine_free_streams_list(SilcDList streams); + * + * DESCRIPTION + * + * Free's the streams list returned by silc_packet_engine_get_streams. + * + ***/ +void silc_packet_engine_free_streams_list(SilcDList streams); + /****f* silccore/SilcPacketAPI/silc_packet_stream_create * * SYNOPSIS @@ -472,6 +521,20 @@ SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream, ***/ void silc_packet_stream_destroy(SilcPacketStream stream); +/****f* silccore/SilcPacketAPI/silc_packet_stream_is_valid + * + * SYNOPSIS + * + * SilcBool silc_packet_stream_is_valid(SilcPacketStream stream); + * + * DESCRIPTION + * + * Returns TRUE if the packet stream indicated by `stream' is valid and + * has not been disconnected or destroyed. + * + ***/ +SilcBool silc_packet_stream_is_valid(SilcPacketStream stream); + /****f* silccore/SilcPacketAPI/silc_packet_stream_set_router * * SYNOPSIS @@ -515,20 +578,19 @@ void silc_packet_stream_set_iv_included(SilcPacketStream stream); * SYNOPSIS * * void silc_packet_stream_set_stream(SilcPacketStream packet_stream, - * SilcStream stream, - * SilcSchedule schedule); + * SilcStream stream); * * DESCRIPTION * * This function may be used to change the underlaying stream in the * packet stream indicated by `packet_stream'. Note that the old * stream will not be used after calling this function. The caller is - * responsible destroying the old stream. + * responsible destroying the old stream. The `stream' will use + * the same scheduler as the `packet_stream'. * ***/ void silc_packet_stream_set_stream(SilcPacketStream packet_stream, - SilcStream stream, - SilcSchedule schedule); + SilcStream stream); /****f* silccore/SilcPacketAPI/silc_packet_stream_get_stream * @@ -589,7 +651,7 @@ SilcStream silc_packet_stream_get_stream(SilcPacketStream stream); * ***/ SilcBool silc_packet_stream_link(SilcPacketStream stream, - SilcPacketCallbacks *callbacks, + const SilcPacketCallbacks *callbacks, void *callback_context, int priority, ...); @@ -609,9 +671,105 @@ SilcBool silc_packet_stream_link(SilcPacketStream stream, * ***/ void silc_packet_stream_unlink(SilcPacketStream stream, - SilcPacketCallbacks *callbacks, + const SilcPacketCallbacks *callbacks, void *callback_context); +/****f* silccore/SilcPacketAPI/SilcPacketWrapCoder + * + * SYNOPSIS + * + * typedef SilcBool (*SilcPacketWrapCoder)(SilcStream stream, + * SilcStreamStatus status, + * SilcBuffer buffer, + * void *context); + * + * DESCRIPTION + * + * The encoder/decoder callback for silc_packet_stream_wrap. If the + * `status' is SILC_STREAM_CAN_WRITE then additional data can be added + * to `buffer'. It is added before the data that is written with + * silc_stream_write. The silc_buffer_enlarge should be called to verify + * there is enough room in `buffer' before adding data to it. The `buffer' + * must not be freed. + * + * If the `status' is SILC_STREAM_CAN_READ then data from the `buffer' + * may be read before it is passed to readed when silc_stream_read is + * called. The `buffer' may be advanced also to hide data in it. + * + * This function returns FALSE in case of error. + * + ***/ +typedef SilcBool (*SilcPacketWrapCoder)(SilcStream stream, + SilcStreamStatus status, + SilcBuffer buffer, + void *context); + +/****f* silccore/SilcPacketAPI/silc_packet_stream_wrap + * + * SYNOPSIS + * + * SilcStream silc_packet_stream_wrap(SilcPacketStream stream, + * SilcPacketType type, + * SilcPacketFlags flags, + * SilcBool blocking_mode, + * SilcPacketWrapCoder coder, + * void *context); + * + * DESCRIPTION + * + * Wraps the packet stream indicated by `stream' into a SilcStream for + * the packet type indicated by `type' with packet flags indicated by + * `flags'. The returned SilcStream can be used to read and write the + * specified SILC packets with the specified packet flags, by calling + * silc_stream_read and silc_stream_write, respectively. The returned + * stream can be destroyed by calling silc_stream_destroy. It does not + * destroy the wrapped packet stream. + * + * If the `blocking_mode' mode is TRUE then the silc_stream_read and + * silc_stream_write may block the calling process or thread until SILC + * packet is read or written. If it is FALSE the stream is in non-blocking + * mode and the calls never block. The returned stream is thread-safe and + * packets may be read and written in multi-threaded environment. + * + * In non-blocking mode the silc_stream_set_notifier must be called before + * the returned stream can be used to read packets. The stream status + * SILC_STREAM_CAN_READ will be returned to the notifier callback to + * indicate that a packet is ready for reading. Calling silc_stream_read + * once returns one complete SILC packet data payload (which is of type of + * `type'). + * + * The `coder' is optional encoder/decoder callback which the packet engine + * will call if it is non-NULL. It can be used to encode additional data + * into each packet when silc_stream_write is called or decode data before + * it is passed to reader when silc_stream_read is called. The `context' + * is passed to `coder'. + * + * The returned SilcStream can be used as any normal stream and all + * SilcStream API functions may be used with the stream. This returns + * NULL on error. + * + ***/ +SilcStream silc_packet_stream_wrap(SilcPacketStream stream, + SilcPacketType type, + SilcPacketFlags flags, + SilcBool blocking_mode, + SilcPacketWrapCoder coder, + void *context); + +/****f* silccore/SilcPacketAPI/silc_packet_stream_is_udp + * + * SYNOPSIS + * + * SilcBool silc_packet_stream_is_udp(SilcPacketStream stream); + * + * DESCRIPTION + * + * Returns TRUE if the packet stream indicated by `stream' is using + * UDP transport. + * + ***/ +SilcBool silc_packet_stream_is_udp(SilcPacketStream stream); + /****f* silccore/SilcPacketAPI/silc_packet_get_sender * * SYNOPSIS @@ -706,74 +864,51 @@ void silc_packet_set_context(SilcPacketStream stream, void *stream_context); ***/ void *silc_packet_get_context(SilcPacketStream stream); -/****f* silccore/SilcPacketAPI/silc_packet_set_ciphers +/****f* silccore/SilcPacketAPI/silc_packet_set_keys * * SYNOPSIS * - * void silc_packet_set_ciphers(SilcPacketStream stream, SilcCipher send, - * SilcCipher receive); + * void silc_packet_set_keys(SilcPacketStream stream, SilcCipher send_key, + * SilcCipher receive_key, SilcHmac send_hmac, + * SilcHmac receive_hmac, SilcBool rekey); * * DESCRIPTION * - * Set ciphers to be used to encrypt sent packets, and decrypt received - * packets. This can be called multiple times to change the ciphers. - * In this case if old cipher is set it will be freed. If ciphers are - * not set packets will not be encrypted or decrypted. - * - ***/ -void silc_packet_set_ciphers(SilcPacketStream stream, SilcCipher send, - SilcCipher receive); - -/****f* silccore/SilcPacketAPI/silc_packet_get_ciphers + * Set ciphers and HMACs to be used to encrypt sent packets, and decrypt + * received packets. This can be called multiple times to change the + * ciphers and HMACs. * - * SYNOPSIS + * If the `rekey' is TRUE this function will send SILC_PACKET_REKEY_DONE + * to the `stream' and will set the new keys. If it is FALSE the keys + * are changed but the packet is not changed. * - * SilcBool silc_packet_get_ciphers(SilcPacketStream stream, - * SilcCipher *send, - * SilcCipher *receive); - * - * DESCRIPTION - * - * Returns the pointers of current ciphers from the `stream'. Returns - * FALSE if ciphers are not set. + * When changing keys the old cipher and HMACs will be freed. If the keys + * are not set at all, packets will not be encrypted or decrypted. * ***/ -SilcBool silc_packet_get_ciphers(SilcPacketStream stream, SilcCipher *send, - SilcCipher *receive); +SilcBool silc_packet_set_keys(SilcPacketStream stream, SilcCipher send_key, + SilcCipher receive_key, SilcHmac send_hmac, + SilcHmac receive_hmac, SilcBool rekey); -/****f* silccore/SilcPacketAPI/silc_packet_set_hmacs +/****f* silccore/SilcPacketAPI/silc_packet_get_keys * * SYNOPSIS * - * void silc_packet_set_hmacs(SilcPacketStream stream, SilcHmac send, - * SilcHmac receive); + * SilcBool silc_packet_get_keys(SilcPacketStream stream, + * SilcCipher *send_key, + * SilcCipher *receive_key, + * SilcHmac *send_hmac, + * SilcHmac *receive_hmac); * * DESCRIPTION * - * Set HMACs to be used to create MACs for sent packets and to check - * MAC for received packets. This can be called multiple times to change - * the HMACs. In this case if old HMAC is set it will be freed. If - * HMACs are not set MACs are not generated or verified for packets. + * Returns the pointers of current ciphers and HMACs from the `stream'. + * Returns FALSE if keys are not set. * ***/ -void silc_packet_set_hmacs(SilcPacketStream stream, SilcHmac send, - SilcHmac receive); - -/****f* silccore/SilcPacketAPI/silc_packet_get_hmacs - * - * SYNOPSIS - * - * SilcBool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send, - * SilcHmac *receive); - * - * DESCRIPTION - * - * Returns the pointers of current HMACs from the `stream'. Returns - * FALSE if HMACs are not set. - * - ***/ -SilcBool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send, - SilcHmac *receive); +SilcBool silc_packet_get_keys(SilcPacketStream stream, + SilcCipher *send_key, SilcCipher *receive_key, + SilcHmac *send_hmac, SilcHmac *receive_hmac); /****f* silccore/SilcPacketAPI/silc_packet_set_ids * @@ -785,7 +920,7 @@ SilcBool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send, * * DESCRIPTION * - * Set the source ID and destinaion ID to be used when sending packets to + * Set the source ID and destination ID to be used when sending packets to * this packet stream. The IDs to be used for a packet stream can be * overridden when sending packets. However, if the IDs do not ever change * for the packet stream it is recommended they are set using this function. @@ -797,6 +932,25 @@ SilcBool silc_packet_set_ids(SilcPacketStream stream, SilcIdType src_id_type, const void *src_id, SilcIdType dst_id_type, const void *dst_id); +/****f* silccore/SilcPacketAPI/silc_packet_get_ids + * + * SYNOPSIS + * + * SilcBool silc_packet_get_ids(SilcPacketStream stream, + * SilcBool *src_id_set, SilcID *src_id, + * SilcBool *dst_id_set, SilcID *dst_id); + * + * DESCRIPTION + * + * Returns source and destination IDs from the packet stream. The + * `src_id_set' is set to TRUE if the source ID was returned. The + * `dst_id_set' is set to TRUE if the destination ID was returned. + * + ***/ +SilcBool silc_packet_get_ids(SilcPacketStream stream, + SilcBool *src_id_set, SilcID *src_id, + SilcBool *dst_id_set, SilcID *dst_id); + /****f* silccore/SilcPacketAPI/silc_packet_set_sid * * SYNOPSIS @@ -832,14 +986,13 @@ SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid); * DESCRIPTION * * Send `data' of length of `data_len' to the packet stream indicated by - * `stream'. If ciphers and HMACs were set using silc_packet_set_ciphers - * and silc_packet_set_hmacs the packet will be encrypted and MAC will be - * computed for it. If silc_packet_set_ids was used to set source and - * destination ID for the packet stream those IDs are used in the - * packet. If IDs have not been set and they need to be provided then - * silc_packet_send_ext function should be used. Otherwise, the packet - * will not have IDs set at all. Returns FALSE if packet could not be - * sent. + * `stream'. If ciphers and HMACs were set using silc_packet_set_keys + * the packet will be encrypted and MAC will be computed for it. If + * silc_packet_set_ids was used to set source and destination ID for the + * packet stream those IDs are used in the packet. If IDs have not been + * set and they need to be provided then silc_packet_send_ext function + * should be used. Otherwise, the packet will not have IDs set at all. + * Returns FALSE if packet could not be sent. * ***/ SilcBool silc_packet_send(SilcPacketStream stream, @@ -929,23 +1082,30 @@ SilcBool silc_packet_send_va_ext(SilcPacketStream stream, SilcIdType dst_id_type, void *dst_id, SilcCipher cipher, SilcHmac hmac, ...); -/****f* silccore/SilcPacketAPI/silc_packet_wait +/****f* silccore/SilcPacketAPI/silc_packet_wait_init * * SYNOPSIS * - * void *silc_packet_wait_init(SilcPacketStream stream, ...); + * void *silc_packet_wait_init(SilcPacketStream stream, + * const SilcID *source_id, ...); * * DESCRIPTION * * Initializes a packet waiter for the packet stream `stream' and * for the variable argument list of packet types. The function * silc_packet_wait can be used to block the thread until a packet - * has been received. This function is used to initialize the waiting - * and to give the list of packet types that caller wish to receive. - * The variable argument list must end with -1. To receive all - * packets use SILC_PACKET_ANY. Returns a context that must be given - * to the silc_packet_wait function as argument. Returns NULL on - * error. To uninitialize the waiting call silc_packet_wait_uninit. + * has been received. + * + * This function is used to initialize the waiting and to give the list + * of packet types that caller wish to receive. The variable argument + * list must end with -1. To receive all packets use SILC_PACKET_ANY. + * If the `source_id' is non-NULL then only packets of the specified + * type from the specified `source_id' are received. If it is NULL + * then the packet source is ignored. + * + * Returns a context that must be given to the silc_packet_wait function + * as argument. Returns NULL on error. To uninitialize the waiting + * call silc_packet_wait_uninit. * * NOTES * @@ -957,14 +1117,14 @@ SilcBool silc_packet_send_va_ext(SilcPacketStream stream, * void *waiter; * * // Will wait for private message packets - * waiter = silc_packet_wait_init(stream, + * waiter = silc_packet_wait_init(stream, NULL, * SILC_PACKET_PRIVATE_MESSAGE, -1); * - * ***/ -void *silc_packet_wait_init(SilcPacketStream stream, ...); +void *silc_packet_wait_init(SilcPacketStream stream, + const SilcID *source_id, ...); -/****f* silccore/SilcPacketAPI/silc_packet_wait +/****f* silccore/SilcPacketAPI/silc_packet_wait_uninit * * SYNOPSIS *