Author: Pekka Riikonen <priikone@silcnet.org>
- 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
*/
-/****h* silccore/Packet Protocol Interface
+/****h* silccore/SILC Packet Engine Interface
*
* DESCRIPTION
*
#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
#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_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 0x12 /* Use maximum padding */
/***/
/****s* silccore/SilcPacketAPI/SilcPacketEngine
* IDs are available. The application must free the packet with the
* 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.
*
* 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 {
void *callback_context,
void *stream_context);
-/****s* silccore/SilcPacketAPI/SilcPacketStream
+/****s* silccore/SilcPacketAPI/SilcPacketCallbacks
*
* NAME
*
- * typedef struct SilcPacketStreamStruct *SilcPacketStream;
+ * typedef struct { ... } *SilcPacketCallbacks;
*
* DESCRIPTION
*
***/
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_dlist_uninit.
+ *
+ ***/
+SilcDList silc_packet_engine_get_streams(SilcPacketEngine engine);
+
/****f* silccore/SilcPacketAPI/silc_packet_stream_create
*
* SYNOPSIS
* 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
*
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
* 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_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
***/
void silc_packet_stream_set_iv_included(SilcPacketStream stream);
+/****f* silccore/SilcPacketAPI/silc_packet_stream_set_stream
+ *
+ * SYNOPSIS
+ *
+ * void silc_packet_stream_set_stream(SilcPacketStream packet_stream,
+ * 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. The `stream' will use
+ * the same scheduler as the `packet_stream'.
+ *
+ ***/
+void silc_packet_stream_set_stream(SilcPacketStream packet_stream,
+ SilcStream stream);
+
/****f* silccore/SilcPacketAPI/silc_packet_stream_get_stream
*
* SYNOPSIS
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
+ *
+ * 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
*
* SYNOPSIS
***/
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
- *
- * SYNOPSIS
- *
- * SilcBool silc_packet_get_ciphers(SilcPacketStream stream,
- * SilcCipher *send,
- * SilcCipher *receive);
+ * 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.
*
- * DESCRIPTION
+ * 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.
*
- * 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
*
*
* 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.
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
* 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,
const unsigned char *data, SilcUInt32 data_len,
SilcCipher cipher, SilcHmac hmac);
-/****f* silccore/SilcPacketAPI/silc_packet_wait
+/****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
*
- * void *silc_packet_wait_init(SilcPacketStream stream, ...);
+ * 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. 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
*
* 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
*