X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=blobdiff_plain;f=lib%2Fsilccore%2Fsilcpacket.h;h=0caf10d8c21bc8b54c245e3311265b8b785e6e9a;hp=fce2ebf5e5d7883596ec2237c4510114b85e39e7;hb=1cc9af890006b0181913d4f84909442744476745;hpb=0f0340b9fbce9704cc7171f8f0104ce9103d2de6 diff --git a/lib/silccore/silcpacket.h b/lib/silccore/silcpacket.h index fce2ebf5..0caf10d8 100644 --- a/lib/silccore/silcpacket.h +++ b/lib/silccore/silcpacket.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - Copyright (C) 1997 - 2005 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,22 +17,23 @@ */ -/****h* silccore/Packet Protocol Interface +/****h* silccore/SILC Packet Engine Interface * * DESCRIPTION * - * Implementation of the packet routines for sending and receiving - * SILC Packets. These includes the data sending routines and data - * reading routines, encrypting and decrypting routines, packet assembling - * and packet parsing routines. + * The SILC secure binary packet protocol interface, provides interface for + * sending and receiving SILC packets. The interface provides a packet + * engine, that can be used to receive packets from packet streams, and + * routines for sending all kinds of SILC packets. + * + * The packet engine and packet stream are thread safe. They can be safely + * used in multi threaded environment. * ***/ #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 @@ -54,7 +55,6 @@ typedef SilcUInt8 SilcPacketType; /* SILC Packet types. */ -#define SILC_PACKET_NONE 0 /* NULL, never sent */ #define SILC_PACKET_DISCONNECT 1 /* Disconnection */ #define SILC_PACKET_SUCCESS 2 /* Success */ #define SILC_PACKET_FAILURE 3 /* Failure */ @@ -83,9 +83,13 @@ 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 */ + +#define SILC_PACKET_NONE 0 /* RESERVED */ +#define SILC_PACKET_ANY 0 /***/ /****d* silccore/SilcPacketAPI/SilcPacketFlags @@ -108,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 @@ -153,21 +158,28 @@ typedef struct SilcPacketStreamStruct *SilcPacketStream; * callback. The application can parse the data payload from the * SilcPacket. Also packet type, flags, and sender and destination * IDs are available. The application must free the packet with the - * silc_packet_free function. + * silc_packet_free function if it takes it in for processing. + * + * The `buffer' field contains the parsed packet payload and the start + * of the data area will point to the start of the packet payload. + * + * The list pointer `next' can be used by the application to put the + * packet context in a list during processing, if needed. * * SOURCE */ typedef struct SilcPacketStruct { - struct SilcPacketStruct *next; - SilcBufferStruct buffer; /* Packet data payload */ - unsigned char *src_id; /* Source ID */ - unsigned char *dst_id; /* Destination ID */ - unsigned int src_id_len : 6; /* Source ID length */ - unsigned int src_id_type : 2; /* Source ID type */ - unsigned int dst_id_len : 6; /* Destination ID length */ - unsigned int dst_id_type : 2; /* Destination ID type */ - SilcPacketType type; /* Packet type */ - SilcPacketFlags flags; /* Packet flags */ + struct SilcPacketStruct *next; /* List pointer, application may set */ + SilcPacketStream stream; /* Packet stream this packet is from */ + SilcBufferStruct buffer; /* Packet data payload */ + unsigned char *src_id; /* Source ID */ + unsigned char *dst_id; /* Destination ID */ + unsigned int src_id_len : 6; /* Source ID length */ + unsigned int src_id_type : 2; /* Source ID type */ + unsigned int dst_id_len : 6; /* Destination ID length */ + unsigned int dst_id_type : 2; /* Destination ID type */ + SilcPacketType type; /* Packet type */ + SilcPacketFlags flags; /* Packet flags */ } *SilcPacket; /***/ @@ -181,7 +193,11 @@ typedef struct SilcPacketStruct { * * Packet errors. This is returned in the error callback. If application * needs the actual lower level stream error, it needs to retrieve it - * from the actual stream. + * 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 */ @@ -190,6 +206,7 @@ typedef enum { SILC_PACKET_ERR_WRITE, /* Error while writing */ SILC_PACKET_ERR_MAC_FAILED, /* Packet MAC check failed */ SILC_PACKET_ERR_DECRYPTION_FAILED, /* Packet decryption failed */ + SILC_PACKET_ERR_UNKNOWN_SID, /* Unknown SID (with IV included) */ SILC_PACKET_ERR_MALFORMED, /* Packet is malformed */ SILC_PACKET_ERR_NO_MEMORY, /* System out of memory */ } SilcPacketError; @@ -199,25 +216,54 @@ typedef enum { * * SYNOPSIS * - * typedef void (*SilcPacketReceiveCb)(SilcPacketEngine engine, - * SilcPacketStream stream, - * SilcPacket packet, - * void *callback_context, - * void *app_context); + * typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine, + * SilcPacketStream stream, + * SilcPacket packet, + * void *callback_context, + * void *stream_context); * * DESCRIPTION * * The packet receive callback is called by the packet engine when a new * SILC Packet has arrived. The application must free the returned - * SilcPacket with silc_packet_free. This callback is set in the - * SilcPacketCallbacks structure. + * SilcPacket with silc_packet_free if it takes the packet in for + * processing. This callback is set in the SilcPacketCallbacks structure. + * The `callback_context' is the context set as argument in the + * silc_packet_engine_start function. The `stream_context' is stream + * specific context that was set by calling silc_packet_set_context. + * + * If the application takes the received packet `packet' into processing + * TRUE must be returned. If FALSE is returned the packet engine will + * pass the packet to other packet processor, if one has been linked + * to the stream with silc_packet_stream_link function. If no extra + * processor is linked the packet is dropped. + * + * EXAMPLE + * + * SilcBool + * silc_foo_packet_receive_cb(SilcPacketEngine engine, + * SilcPacketStream stream, SilcPacket packet, + * void *callback_context, void *stream_context) + * { + * Application ctx = callback_context; + * + * // If we're not up yet, let's not process the packet + * if (ctx->initialized == FALSE) + * return FALSE; + * + * // Process the incoming packet... + * ... + * + * // It's our packet now, no one else will get it + * return TRUE; + * } * ***/ -typedef void (*SilcPacketReceiveCb)(SilcPacketEngine engine, - SilcPacketStream stream, - SilcPacket packet, - void *callback_context, - void *app_context); +typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine, + SilcPacketStream stream, + SilcPacket packet, + void *callback_context, + void *stream_context); /****f* silccore/SilcPacketAPI/SilcPacketEosCb * @@ -226,7 +272,7 @@ typedef void (*SilcPacketReceiveCb)(SilcPacketEngine engine, * typedef void (*SilcPacketEosCb)(SilcPacketEngine engine, * SilcPacketStream stream, * void *callback_context, - * void *app_context); + * void *stream_context); * * DESCRIPTION * @@ -240,7 +286,7 @@ typedef void (*SilcPacketReceiveCb)(SilcPacketEngine engine, typedef void (*SilcPacketEosCb)(SilcPacketEngine engine, SilcPacketStream stream, void *callback_context, - void *app_context); + void *stream_context); /****f* silccore/SilcPacketAPI/SilcPacketErrorCb * @@ -250,7 +296,7 @@ typedef void (*SilcPacketEosCb)(SilcPacketEngine engine, * SilcPacketStream stream, * SilcPacketError error, * void *callback_context, - * void *app_context); + * void *stream_context); * * DESCRIPTION * @@ -263,13 +309,13 @@ typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine, SilcPacketStream stream, SilcPacketError error, void *callback_context, - void *app_context); + void *stream_context); -/****s* silccore/SilcPacketAPI/SilcPacketStream +/****s* silccore/SilcPacketAPI/SilcPacketCallbacks * * NAME * - * typedef struct SilcPacketStreamStruct *SilcPacketStream; + * typedef struct { ... } *SilcPacketCallbacks; * * DESCRIPTION * @@ -294,31 +340,28 @@ typedef struct { * SYNOPSIS * * SilcPacketEngine - * silc_packet_engine_start(SilcSchedule schedule, SilcRng rng, bool router, + * silc_packet_engine_start(SilcRng rng, SilcBool router, * SilcPacketCallbacks *callbacks, * void *callback_context); * * DESCRIPTION * * Create new packet engine for processing incoming and outgoing packets. - * If `rng' is non-NULL that RNG will be used to create necessary random - * numbers during packet processing. If NULL, Global RNG will be used. * If `router' is TRUE then the application is considered to be router * server, and certain packets are handled differently. Client and normal * server must set it to FALSE. The `callbacks' is a SilcPacketCallbacks * structure provided by the caller which includes the callbacks that is - * called when for example packet is received, or end of stream is called + * called when for example packet is received, or end of stream is called. * * NOTES * - * The packet engine is thread safe. Also the `schedule' and `rng' are - * thread safe. You can use one packet engine in multi threaded - * application. + * The packet engine is thread safe. You can use one packet engine in + * multi threaded application. * ***/ SilcPacketEngine -silc_packet_engine_start(SilcSchedule schedule, SilcRng rng, bool router, - SilcPacketCallbacks *callbacks, +silc_packet_engine_start(SilcRng rng, SilcBool router, + const SilcPacketCallbacks *callbacks, void *callback_context); /****f* silccore/SilcPacketAPI/silc_packet_engine_stop @@ -335,11 +378,58 @@ silc_packet_engine_start(SilcSchedule schedule, SilcRng rng, bool 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 * * SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine, + * SilcSchedule schedule, * SilcStream stream); * * DESCRIPTION @@ -347,7 +437,7 @@ void silc_packet_engine_stop(SilcPacketEngine engine); * Create new packet stream and use the `stream' as underlaying stream. * Usually the `stream' would be a socket stream, but it can be any * stream. After this function returns, packets can immediately be - * sent to or received from the stream. + * sent to and received from the stream. * * NOTES * @@ -357,18 +447,66 @@ void silc_packet_engine_stop(SilcPacketEngine engine); * To read packets you will receive the packet receive callback from * packet engine. Destroy the stream with silc_packet_stream_destroy. * - * If you need to send only one type of SILC packets, then it is possible - * to create SILC Packet Streamer with silc_packet_streamer_create, which - * can be used with silc_stream_read and silc_stream_write. - * - * The SilcPacketStream is not thread safe. If you share same stream - * with multiple threads concurrency control need to be employed. It - * is recommended to create new SilcPacketStream for every thread. + * The SilcPacketStream is thread safe. Same context can be safely used + * in multi threaded environment. * ***/ SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine, + SilcSchedule schedule, SilcStream stream); +/****f* silccore/SilcPacketAPI/silc_packet_stream_add_remote + * + * SYNOPSIS + * + * SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream, + * const char *remote_ip, + * SilcUInt16 remote_port, + * SilcPacket packet); + * + * DESCRIPTION + * + * This function is used to add remote receivers in packet stream `stream' + * that has UDP/IP socket stream as the underlaying stream. This function + * cannot be used with other type of streams. This returns new packet + * stream context that can be used to send to and receive packets from + * the specified remote IP and remote port, or NULL on error. The `stream' + * is the actual stream that is used to send and receive the data. + * + * When the parent `stream' receives packets from remote IP address + * and port that does not have its own remote packet stream, it returns + * the packet to the packet callback set for `stream'. The sender's + * IP address and port can then be retrieved by using the + * silc_packet_get_sender function and to create new packet stream by + * calling this function. After that, all packets from that IP address + * and port will be received by the new packet stream. + * + * If the `packet' is non-NULL it will be injected into the new packet + * stream as soon as the scheduler associated with `stream' schedules + * new tasks. It can be used to inject an incoming packet to the stream. + * + * This interface is for connectionless UDP streams. If it is possible + * to create connected stream it should be done for performance reasons. + * + * EXAMPLE + * + * // Create parent packet stream, it can receive packets from anywhere + * listener = silc_net_udp_connect("0.0.0.0", 500, NULL, 0, schedule); + * parent = silc_packet_stream_create(engine, schedule, listener); + * + * ... + * // Received a packet to the parent stream, get the sender information. + * silc_packet_get_sender(packet, &ip, &port); + * + * // Create new packet stream for this remote location. + * remote = silc_packet_stream_add_remote(parent, ip, port, packet); + * + ***/ +SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream, + const char *remote_ip, + SilcUInt16 remote_port, + SilcPacket packet); + /****f* silccore/SilcPacketAPI/silc_packet_stream_destroy * * SYNOPSIS @@ -378,63 +516,81 @@ SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine, * DESCRIPTION * * Destroy packet stream and the underlaying stream. This will also - * send end of stream to the underlaying stream. + * close and destroy the underlaying stream. * ***/ void silc_packet_stream_destroy(SilcPacketStream stream); -/****f* silccore/SilcPacketAPI/silc_packet_streamer_create +/****f* silccore/SilcPacketAPI/silc_packet_stream_is_valid * * SYNOPSIS * - * SilcStream silc_packet_streamer_create(SilcPacketStream stream, - * SilcPacketType packet_type, - * SilcPacketFlags packet_flags); + * SilcBool silc_packet_stream_is_valid(SilcPacketStream stream); * * DESCRIPTION * - * This function can be used to create a SILC Packet Streamer that will - * stream only one type of packet indicated by `packet_type' with packet - * flags `packet_flags'. This is special purpose function as usually - * multiple different types of packets need to be sent in application. - * There are cases however when creating streamer is simpler and more - * efficient. Cases such as file transfer stream or other data streams - * that only send and receive one type of packet. While it would be - * possible to use silc_packet_send function to send packets it is - * more efficient to create the SILC Packet Streamer and use the - * silc_stream_read and silc_stream_write functions. + * Returns TRUE if the packet stream indicated by `stream' is valid and + * has not been disconnected or destroyed. * - * The encryption and decryption keys, and other information will be - * retrieved from the packet stream indicated by `stream', which must be - * created before creating the streamer. + ***/ +SilcBool silc_packet_stream_is_valid(SilcPacketStream stream); + +/****f* silccore/SilcPacketAPI/silc_packet_stream_set_router * - * NOTES + * SYNOPSIS + * + * void silc_packet_stream_set_router(SilcPacketStream stream); + * + * DESCRIPTION + * + * When called sets the stream indicates by `stream' as SILC router + * connection stream. This causes that certain packets are handled + * differently. This must be called for router connection streams and + * must not be called for any other stream. + * + ***/ +void silc_packet_stream_set_router(SilcPacketStream stream); + +/****f* silccore/SilcPacketAPI/silc_packet_stream_set_iv_included + * + * SYNOPSIS + * + * void silc_packet_stream_set_iv_included(SilcPacketStream stream); + * + * DESCRIPTION + * + * Sets an IV Included property for the stream indicated by `stream'. + * This means that the IV used in the encryption will be included in + * the resulted ciphertext. This makes it possible to send and receive + * packets on unreliable network transport protocol, such as UDP/IP. + * This must be called if the underlaying stream in the `stream' is UDP + * stream. * - * The packet type that is assocated with the packet stream `stream' will - * only be available through the returned SilcStream. That packet type - * will not be delivered to the packet callbacks. To return to the - * normal operation destroy the streamer silc_packet_streamer_destroy. + * When this is set to the stream the silc_packet_set_sid must be called + * to set new Security ID. The Security ID will be included with the IV + * in the ciphertext. * ***/ -SilcStream silc_packet_streamer_create(SilcPacketStream stream, - SilcPacketType packet_type, - SilcPacketFlags packet_flags); +void silc_packet_stream_set_iv_included(SilcPacketStream stream); -/****f* silccore/SilcPacketAPI/silc_packet_streamer_destroy +/****f* silccore/SilcPacketAPI/silc_packet_stream_set_stream * * SYNOPSIS * - * void silc_packet_streamer_destroy(SilcStream stream); + * void silc_packet_stream_set_stream(SilcPacketStream packet_stream, + * SilcStream stream); * * DESCRIPTION * - * Destroys the created packet streamer. Use this function only for - * stream created with silc_packet_streamer_create. The packet type - * that was associated with the streamer can be received in the packet - * callbacks after the streamer is destroyed. + * 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. The `stream' will use + * the same scheduler as the `packet_stream'. * ***/ -void silc_packet_streamer_destroy(SilcStream stream); +void silc_packet_stream_set_stream(SilcPacketStream packet_stream, + SilcStream stream); /****f* silccore/SilcPacketAPI/silc_packet_stream_get_stream * @@ -447,36 +603,192 @@ void silc_packet_streamer_destroy(SilcStream stream); * Returns the actual stream that is associated with the packet stream * `stream'. The caller must not free the returned stream. The returned * stream is the same pointer that was set for silc_packet_stream_create. - * This function couled be used for example when an error callback is + * This function could be used for example when an error callback is * called by the packet engine to retrieve the actual lower level error * from the stream. * ***/ SilcStream silc_packet_stream_get_stream(SilcPacketStream stream); -/****f* silccore/SilcPacketAPI/silc_packet_stream_callbacks +/****f* silccore/SilcPacketAPI/silc_packet_stream_link + * + * SYNOPSIS + * + * SilcBool silc_packet_stream_link(SilcPacketStream stream, + * SilcPacketCallbacks *callbacks, + * void *callback_context, + * int priority, ...); + * + * DESCRIPTION + * + * Links the packet processing callbacks indicated by `callbacks' into + * the packet stream indicated by `stream' with priority `priority' for + * the packet types given in the variable argument list. This function + * can be used to link to the packet stream for specific packet types + * and receive them in the specified callbacks. This way, a third party, + * for example some library may attach itself into the packet stream + * and receive and process certain packets. The variable argument + * list is ended with -1. To link to receive all packets use + * SILC_PACKET_ANY. + * + * The default packet processing callbacks given as argument to the + * silc_packet_engine_start has the priority 0. Any priority higher + * than 0 will then take precedence over the default callbacks. Any + * priority lower than 0 (negative value) will be processed after the + * default callbacks. + * + * Note that setting only the 'packet_receive' callback in the `callbacks' + * is required. + * + * EXAMPLE + * + * // Link to this packet stream, with high priority, for + * // SILC_PACKET_CONNECTION_AUTH and SILC_PACKET_CONNECTION_AUTH_REQUEST + * // packets. We don't care about other packets. + * silc_packet_stream_link(stream, our_callbacks, our_context, + * 1000000, SILC_PACKET_CONNECTION_AUTH, + * SILC_PACKET_CONNECTION_AUTH_REQUEST, -1); + * + ***/ +SilcBool silc_packet_stream_link(SilcPacketStream stream, + const SilcPacketCallbacks *callbacks, + void *callback_context, + int priority, ...); + +/****f* silccore/SilcPacketAPI/silc_packet_stream_unlink + * + * SYNOPSIS + * + * void silc_packet_stream_unlink(SilcPacketStream stream, + * SilcPacketCallbacks *callbacks, + * void *callback_context); + * + * DESCRIPTION + * + * Unlinks the `callbacks' with `callback_context' from the packet stream + * indicated by `stream'. This function must be called for the callbacks + * that was linked to `stream' when they are not needed anymore. + * + ***/ +void silc_packet_stream_unlink(SilcPacketStream stream, + 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 * - * void silc_packet_stream_callbacks(SilcPacketStream stream, - * SilcPacketCallbacks *callbacks, - * void *callback_context); + * SilcStream silc_packet_stream_wrap(SilcPacketStream stream, + * SilcPacketType type, + * SilcPacketFlags flags, + * SilcBool blocking_mode, + * SilcPacketWrapCoder coder, + * void *context); * * DESCRIPTION * - * This is optional function which can be used to set specific callbacks - * for the packet stream indicated by `stream'. If these are set then - * `callbacks' will be used instead of the ones set for the function - * silc_packet_engine_start. To reset the normal behaviour call this - * function again with `callbacks' as NULL. Note that the responsibility - * of handling end of stream, and error conditions moves to the layer - * calling this function since the original callbacks set in the - * silc_packet_engine_start will not be called. + * 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. * ***/ -void silc_packet_stream_callbacks(SilcPacketStream stream, - SilcPacketCallbacks *callbacks, - void *callback_context); +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 + * + * SilcBool silc_packet_get_sender(SilcPacket packet, + * const char **sender_ip, + * SilcUInt16 *sender_port); + * + * DESCRIPTION + * + * Returns the packet sender's IP address and port from UDP packet + * indicated by `packet'. This can be called only from the packet + * callback to retrieve the information of the packet's sender. Returns + * FALSE if the information is not available. + * + ***/ +SilcBool silc_packet_get_sender(SilcPacket packet, + const char **sender_ip, + SilcUInt16 *sender_port); /****f* silccore/SilcPacketAPI/silc_packet_stream_ref * @@ -507,23 +819,37 @@ void silc_packet_stream_ref(SilcPacketStream stream); ***/ void silc_packet_stream_unref(SilcPacketStream stream); +/****f* silccore/SilcPacketAPI/silc_packet_get_engine + * + * SYNOPSIS + * + * SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream); + * + * DESCRIPTION + * + * Returns the packet engine from the `stream'. + * + ***/ +SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream); + /****f* silccore/SilcPacketAPI/silc_packet_set_context * * SYNOPSIS * - * void silc_packet_set_context(SilcPacketStream stream, void *app_context); + * void silc_packet_set_context(SilcPacketStream stream, + * void *stream_context); * * DESCRIPTION * - * Set an application specific context to the stream. The context will + * Sets a stream specific context to the stream. The context will * be delivered to all callback functions, and it can be retrieved by * calling silc_packet_get_context function as well. Note that this is * separate packet stream specific context, and not the same as * `callback_context' in silc_packet_engine_start. Both will be delivered - * to the callbacks. + * to the callbacks, and this context as the `stream_context' argument. * ***/ -void silc_packet_set_context(SilcPacketStream stream, void *app_context); +void silc_packet_set_context(SilcPacketStream stream, void *stream_context); /****f* silccore/SilcPacketAPI/silc_packet_get_context * @@ -538,125 +864,146 @@ void silc_packet_set_context(SilcPacketStream stream, void *app_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. + * 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. + * + * 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. + * + * 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. * ***/ -void silc_packet_set_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_get_ciphers +/****f* silccore/SilcPacketAPI/silc_packet_get_keys * * SYNOPSIS * - * bool silc_packet_get_ciphers(SilcPacketStream stream, SilcCipher *send, - * SilcCipher *receive); + * SilcBool silc_packet_get_keys(SilcPacketStream stream, + * SilcCipher *send_key, + * SilcCipher *receive_key, + * SilcHmac *send_hmac, + * SilcHmac *receive_hmac); * * DESCRIPTION * - * Returns the pointers of current ciphers from the `stream'. Returns - * FALSE if ciphers are not set. + * Returns the pointers of current ciphers and HMACs from the `stream'. + * Returns FALSE if keys are not set. * ***/ -bool silc_packet_get_ciphers(SilcPacketStream stream, SilcCipher *send, - SilcCipher *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_hmacs +/****f* silccore/SilcPacketAPI/silc_packet_set_ids * * SYNOPSIS * - * void silc_packet_set_hmacs(SilcPacketStream stream, SilcHmac send, - * SilcHmac receive); + * SilcBool silc_packet_set_ids(SilcPacketStream stream, + * SilcIdType src_id_type, const void *src_id + * SilcIdType dst_id_type, const void *dst_id); * * 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. + * 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. + * In this case they can be omitted when sending packets to the stream. + * It is also possible to set only source or destination ID. * ***/ -void silc_packet_set_hmacs(SilcPacketStream stream, SilcHmac send, - SilcHmac receive); +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_hmacs +/****f* silccore/SilcPacketAPI/silc_packet_get_ids * * SYNOPSIS * - * bool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send, - * SilcHmac *receive); + * SilcBool silc_packet_get_ids(SilcPacketStream stream, + * SilcBool *src_id_set, SilcID *src_id, + * SilcBool *dst_id_set, SilcID *dst_id); * * DESCRIPTION * - * Returns the pointers of current HMACs from the `stream'. Returns - * FALSE if HMACs are not set. + * 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. * ***/ -bool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send, - SilcHmac *receive); +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_ids +/****f* silccore/SilcPacketAPI/silc_packet_set_sid * * SYNOPSIS * - * bool silc_packet_set_ids(SilcPacketStream stream, - * SilcIdType src_id_type, const void *src_id - * SilcIdType dst_id_type, const void *dst_id); + * SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid); * * DESCRIPTION * - * Set the source ID and destinaion 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. - * In this case they can be omitted when sending packets to the stream. - * It is also possible to set only source or destination ID. + * Sets new Security ID to the packet stream indicated by `stream'. This + * is called only if the IV Included property was set to the stream + * by calling silc_packet_stream_set_iv_included. This function sets + * new Security ID to the stream which is then included in the ciphertext + * of a packet. The `sid' must be 0 when it is set for the very first + * time and must be increased by one after each rekey. This function must + * be called every time new keys are added to the stream after a rekey. + * + * If this function is called when the IV Included property has not been + * set to the stream the `sid' will be ignored. Returns FALSE if the + * IV Included has not been set, TRUE otherwise. * ***/ -bool silc_packet_set_ids(SilcPacketStream stream, - SilcIdType src_id_type, const void *src_id, - SilcIdType dst_id_type, const void *dst_id); +SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid); /****f* silccore/SilcPacketAPI/silc_packet_send * * SYNOPSIS * - * bool silc_packet_send(SilcPacketStream stream, - * SilcPacketType type, SilcPacketFlags flags, - * const unsigned char *data, SilcUInt32 data_len); + * SilcBool silc_packet_send(SilcPacketStream stream, + * SilcPacketType type, SilcPacketFlags flags, + * const unsigned char *data, + * SilcUInt32 data_len); * * 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 - * generated 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. + * `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. * ***/ -bool silc_packet_send(SilcPacketStream stream, - SilcPacketType type, SilcPacketFlags flags, - const unsigned char *data, SilcUInt32 data_len); +SilcBool silc_packet_send(SilcPacketStream stream, + SilcPacketType type, SilcPacketFlags flags, + const unsigned char *data, SilcUInt32 data_len); /****f* silccore/SilcPacketAPI/silc_packet_send_ext * * SYNOPSIS * - * bool + * SilcBool * silc_packet_send_ext(SilcPacketStream stream, * SilcPacketType type, SilcPacketFlags flags, * SilcIdType src_id_type, void *srd_id, @@ -666,38 +1013,196 @@ bool silc_packet_send(SilcPacketStream stream, * * DESCRIPTION * - * This function can be used to specificly set different parameters of - * the SILC packet to be sent to the stream indicated by `stream'. This - * function can be used to set specific IDs, cipher and HMAC to be used - * in packet creation. If `truelen' is provided that value is put to the - * SILC packet's truelen field, if it is zero the routine will calculate - * the truelen field for the packet. If `padlen' is provided that value - * will be the length of the padding for the packet, if zero the routine - * will calculate necessary amount of padding for the packet. This - * function can be used when specific ciphers, HMACs and IDs has not been - * set for the stream, or setting them for the stream is not suitable. + * Same as silc_packet_send but with this function different sending + * parameters can be sent as argument. This function can be used to + * set specific IDs, cipher and HMAC to be used in packet sending, + * instead of the ones saved in the `stream'. If any of the extra + * pointers are NULL, default values set to the stream will apply. * ***/ -bool silc_packet_send_ext(SilcPacketStream stream, - SilcPacketType type, SilcPacketFlags flags, - SilcIdType src_id_type, void *src_id, - SilcIdType dst_id_type, void *dst_id, - const unsigned char *data, SilcUInt32 data_len, - SilcCipher cipher, SilcHmac hmac); +SilcBool silc_packet_send_ext(SilcPacketStream stream, + SilcPacketType type, SilcPacketFlags flags, + SilcIdType src_id_type, void *src_id, + SilcIdType dst_id_type, void *dst_id, + const unsigned char *data, SilcUInt32 data_len, + SilcCipher cipher, SilcHmac hmac); + +/****f* silccore/SilcPacketAPI/silc_packet_send_va + * + * SYNOPSIS + * + * SilcBool silc_packet_send_va(SilcPacketStream stream, + * SilcPacketType type, + * SilcPacketFlags flags, ...); + * + * DESCRIPTION + * + * Same as silc_packet_send but takes the data in as variable argument + * formatted buffer (see silcbuffmt.h). The arguments must be ended + * with SILC_STR_END. Returns FALSE if packet could not be sent or + * the buffer could not be formatted. + * + * EXAMPLE + * + * // Send NEW_CLIENT packet + * silc_packet_send_va(stream, SILC_PACKET_NEW_CLIENT, 0, + * SILC_STR_UI_SHORT(username_len), + * SILC_STR_DATA(username, username_len), + * SILC_STR_UI_SHORT(realname_len), + * SILC_STR_DATA(realname, realname_len), + * SILC_STR_END); + * + ***/ +SilcBool silc_packet_send_va(SilcPacketStream stream, + SilcPacketType type, SilcPacketFlags flags, ...); + +/****f* silccore/SilcPacketAPI/silc_packet_send_va_ext + * + * SYNOPSIS + * + * SilcBool + * silc_packet_send_va_ext(SilcPacketStream stream, + * SilcPacketType type, SilcPacketFlags flags, + * SilcIdType src_id_type, void *srd_id, + * SilcIdType dst_id_type, void *dst_id, + * SilcCipher cipher, SilcHmac hmac, ...); + * + * DESCRIPTION + * + * Same as silc_packet_send_va but with this function different sending + * parameters can be sent as argument. This function can be used to + * set specific IDs, cipher and HMAC to be used in packet sending, + * instead of the ones saved in the `stream'. If any of the extra + * pointers are NULL, default values set to the stream will apply. + * + ***/ +SilcBool silc_packet_send_va_ext(SilcPacketStream stream, + SilcPacketType type, SilcPacketFlags flags, + SilcIdType src_id_type, void *src_id, + SilcIdType dst_id_type, void *dst_id, + SilcCipher cipher, SilcHmac hmac, ...); + +/****f* silccore/SilcPacketAPI/silc_packet_wait_init + * + * SYNOPSIS + * + * 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. + * 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 + * + * Note that packets may be available immediately after calling this + * function and they will be buffered, until silc_packet_wait is called. + * + * EXAMPLE + * + * void *waiter; + * + * // Will wait for private message packets + * waiter = silc_packet_wait_init(stream, NULL, + * SILC_PACKET_PRIVATE_MESSAGE, -1); + * + ***/ +void *silc_packet_wait_init(SilcPacketStream stream, + const SilcID *source_id, ...); + +/****f* silccore/SilcPacketAPI/silc_packet_wait_uninit + * + * SYNOPSIS + * + * void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream); + * + * DESCRIPTION + * + * Uninitializes the waiting context. This may be called also from + * another thread while other thread is waiting for packets. This will + * inform the waiting thread to stop waiting. + * + ***/ +void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream); + +/****f* silccore/SilcPacketAPI/silc_packet_wait + * + * SYNOPSIS + * + * int silc_packet_wait(void *waiter, int timeout, + * SilcPacket *return_packet) + * + * DESCRIPTION + * + * A special function that can be used to wait for a packet to arrive. + * This function will block the calling process or thread until either + * a packet is received into the `return_packet' pointer or the specified + * timeout value `timeout', which is in milliseconds, will expire. If + * the timeout is 0, no timeout exist. Before calling this function the + * silc_packet_wait_init must be called. The caller is responsible for + * freeing the returned packet with silc_packet_free. + * + * This function can be used for example from a thread that wants to + * block until SILC packet has been received. + * + * Returns 1 when packet was received, 0 if timeout occurred and -1 if + * error occurred. + * + * EXAMPLE + * + * static int foo_read_data(FooContext c) + * { + * SilcPacket packet; + * void *waiter; + * ... + * + * // Will wait for private message packets + * if (c->initialized == FALSE) { + * waiter = silc_packet_wait_init(stream, + * SILC_PACKET_PRIVATE_MESSAGE, -1); + * c->initialized = TRUE; + * } + * + * ... + * // Wait here until private message packet is received + * if ((silc_packet_wait(waiter, 0, &packet)) < 0) + * return -1; + * + * ... process packet ... + * + * return 1; + * } + * + ***/ +int silc_packet_wait(void *waiter, int timeout, SilcPacket *return_packet); /****f* silccore/SilcPacketAPI/silc_packet_free * * SYNOPSIS * - * void silc_packet_free(SilcPacketEngine engine, SilcPacket packet); + * void silc_packet_free(SilcPacket packet); * * DESCRIPTION * * This function is used to free the SilcPacket pointer that application * receives in the SilcPacketReceive callback. Application must free - * the packet. + * the packet if it takes it in to processing. * ***/ -void silc_packet_free(SilcPacketEngine engine, SilcPacket packet); +void silc_packet_free(SilcPacket packet); #endif /* SILCPACKET_H */