* 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.
*
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;
* 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
*
* 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 thread safe. Same context can be safely used
* in multi threaded environment.
*
SilcSchedule schedule,
SilcStream stream);
+/****f* silccore/SilcPacketAPI/silc_packet_stream_shared_create
+ *
+ * SYNOPSIS
+ *
+ * SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream,
+ * const char *remote_ip,
+ * SilcUInt16 remote_port);
+ *
+ * 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_stream_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.
+ *
+ * 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_stream_get_sender(parent, &ip, &port);
+ *
+ * // Create new packet stream for this remote location.
+ * remote = silc_packet_stream_set_remote(parent, ip, port);
+ *
+ ***/
+SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream,
+ const char *remote_ip,
+ SilcUInt16 remote_port);
+
/****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);
***/
void silc_packet_stream_set_router(SilcPacketStream stream);
-/****f* silccore/SilcPacketAPI/silc_packet_streamer_create
+/****f* silccore/SilcPacketAPI/silc_packet_stream_set_iv_included
*
* SYNOPSIS
*
- * SilcStream silc_packet_streamer_create(SilcPacketStream stream,
- * SilcPacketType packet_type,
- * SilcPacketFlags packet_flags);
+ * void silc_packet_stream_set_iv_included(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.
+ * 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 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.
- *
- * NOTES
- *
- * 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,
+ * SilcSchedule schedule);
*
* 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.
*
***/
-void silc_packet_streamer_destroy(SilcStream stream);
+void silc_packet_stream_set_stream(SilcPacketStream packet_stream,
+ SilcStream stream,
+ SilcSchedule schedule);
/****f* silccore/SilcPacketAPI/silc_packet_stream_get_stream
*
SilcPacketCallbacks *callbacks,
void *callback_context);
+/****f* silccore/SilcPacketAPI/silc_packet_stream_get_sender
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_packet_stream_get_sender(SilcPacketStream stream,
+ * const char **sender_ip,
+ * SilcUInt16 *sender_port);
+ *
+ * DESCRIPTION
+ *
+ * Returns the packet sender's IP address and port from UDP packet stream
+ * indicated by `stream'. 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_stream_get_sender(SilcPacketStream stream,
+ const char **sender_ip,
+ SilcUInt16 *sender_port);
+
/****f* silccore/SilcPacketAPI/silc_packet_stream_ref
*
* SYNOPSIS
SilcIdType src_id_type, const void *src_id,
SilcIdType dst_id_type, const void *dst_id);
+/****f* silccore/SilcPacketAPI/silc_packet_set_sid
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid);
+ *
+ * DESCRIPTION
+ *
+ * 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.
+ *
+ ***/
+SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid);
+
/****f* silccore/SilcPacketAPI/silc_packet_send
*
* SYNOPSIS
* 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'.
+ * 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_ext(SilcPacketStream stream,
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
*
* SYNOPSIS
* 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;
+ * void *waiter;
*
- * // Will wait for private message packets
- * waiter = silc_packet_wait_init(stream,
- * SILC_PACKET_PRIVATE_MESSAGE, -1);
+ * // Will wait for private message packets
+ * waiter = silc_packet_wait_init(stream,
+ * SILC_PACKET_PRIVATE_MESSAGE, -1);
*
*
***/
*
* DESCRIPTION
*
- * Uninitializes the waiting context.
+ * 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);
* }
*
* ...
- * // Wait here until packet is received
- * if ((silc_packet_wait(waiter, 0, &packet)) != -1)
+ * // Wait here until private message packet is received
+ * if ((silc_packet_wait(waiter, 0, &packet)) < 0)
* return -1;
*
* ... process packet ...
projects / silc.git / blobdiff