5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2006 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
20 /****h* silccore/Packet Protocol Interface
24 * The SILC secure binary packet protocol interface, provides interface for
25 * sending and receiving SILC packets. The interface provides a packet
26 * engine, that can be used to receive packets from packet streams, and
27 * routines for sending all kinds of SILC packets.
29 * The packet engine and packet stream are thread safe. They can be safely
30 * used in multi threaded environment.
37 /* XXX many of these could go to silcpacket_i.h */
39 /* Maximum packet length */
40 #define SILC_PACKET_MAX_LEN 0xffff
42 /* Maximum length of ID */
43 #define SILC_PACKET_MAX_ID_LEN 28
45 /****d* silccore/SilcPacketAPI/SilcPacketType
49 * typedef SilcUInt8 SilcPacketType;
53 * SILC packet type definition and all the packet types.
57 typedef SilcUInt8 SilcPacketType;
59 /* SILC Packet types. */
60 #define SILC_PACKET_DISCONNECT 1 /* Disconnection */
61 #define SILC_PACKET_SUCCESS 2 /* Success */
62 #define SILC_PACKET_FAILURE 3 /* Failure */
63 #define SILC_PACKET_REJECT 4 /* Rejected */
64 #define SILC_PACKET_NOTIFY 5 /* Notify message */
65 #define SILC_PACKET_ERROR 6 /* Error message */
66 #define SILC_PACKET_CHANNEL_MESSAGE 7 /* Message for channel */
67 #define SILC_PACKET_CHANNEL_KEY 8 /* Key of the channel */
68 #define SILC_PACKET_PRIVATE_MESSAGE 9 /* Private message */
69 #define SILC_PACKET_PRIVATE_MESSAGE_KEY 10 /* Private message key*/
70 #define SILC_PACKET_COMMAND 11 /* Command */
71 #define SILC_PACKET_COMMAND_REPLY 12 /* Reply to a command */
72 #define SILC_PACKET_KEY_EXCHANGE 13 /* Start of KE */
73 #define SILC_PACKET_KEY_EXCHANGE_1 14 /* KE1 */
74 #define SILC_PACKET_KEY_EXCHANGE_2 15 /* KE2 */
75 #define SILC_PACKET_CONNECTION_AUTH_REQUEST 16 /* Request of auth meth */
76 #define SILC_PACKET_CONNECTION_AUTH 17 /* Connectinon auth */
77 #define SILC_PACKET_NEW_ID 18 /* Sending new ID */
78 #define SILC_PACKET_NEW_CLIENT 19 /* Client registering */
79 #define SILC_PACKET_NEW_SERVER 20 /* Server registering */
80 #define SILC_PACKET_NEW_CHANNEL 21 /* Channel registering */
81 #define SILC_PACKET_REKEY 22 /* Re-key start */
82 #define SILC_PACKET_REKEY_DONE 23 /* Re-key done */
83 #define SILC_PACKET_HEARTBEAT 24 /* Heartbeat */
84 #define SILC_PACKET_KEY_AGREEMENT 25 /* Key Agreement request */
85 #define SILC_PACKET_RESUME_ROUTER 26 /* Backup router resume */
86 #define SILC_PACKET_FTP 27 /* File Transfer */
87 #define SILC_PACKET_RESUME_CLIENT 28 /* Client resume */
89 #define SILC_PACKET_PRIVATE 200 /* Private range start */
90 #define SILC_PACKET_MAX 255 /* RESERVED */
92 #define SILC_PACKET_NONE 0 /* RESERVED */
93 #define SILC_PACKET_ANY 0
96 /****d* silccore/SilcPacketAPI/SilcPacketFlags
100 * typedef SilcUInt8 SilcPacketFlags;
104 * SILC packet flags type definition and all the packet flags.
108 typedef SilcUInt8 SilcPacketFlags;
110 /* All defined packet flags */
111 #define SILC_PACKET_FLAG_NONE 0x00 /* No flags */
112 #define SILC_PACKET_FLAG_PRIVMSG_KEY 0x01 /* Private message key */
113 #define SILC_PACKET_FLAG_LIST 0x02 /* Packet is a list */
114 #define SILC_PACKET_FLAG_BROADCAST 0x04 /* Packet is a broadcast */
115 #define SILC_PACKET_FLAG_COMPRESSED 0x08 /* Payload is compressed */
117 /* Impelemntation specific flags */
118 #define SILC_PACKET_FLAG_LONG_PAD 0x10 /* Use maximum padding */
121 /****s* silccore/SilcPacketAPI/SilcPacketEngine
125 * typedef struct SilcPacketEngineStruct *SilcPacketEngine;
129 * The packet engine context, allocated by silc_packet_engine_start.
130 * The engine is destroyed with silc_packet_engine_stop.
133 typedef struct SilcPacketEngineStruct *SilcPacketEngine;
135 /****s* silccore/SilcPacketAPI/SilcPacketStream
139 * typedef struct SilcPacketStreamStruct *SilcPacketStream;
143 * The packet stream context, allocated by silc_packet_stream_create.
144 * The stream is destroyed with silc_packet_stream_destroy.
147 typedef struct SilcPacketStreamStruct *SilcPacketStream;
149 /****s* silccore/SilcPacketAPI/SilcPacket
153 * typedef struct SilcPacketStruct *SilcPacket;
157 * The SilcPacket is returned by the packet engine in the SilcPacketReceive
158 * callback. The application can parse the data payload from the
159 * SilcPacket. Also packet type, flags, and sender and destination
160 * IDs are available. The application must free the packet with the
161 * silc_packet_free function if it takes it in for processing.
163 * The `buffer' field contains the parsed packet payload and the start
164 * of the data area will point to the start of the packet payload.
166 * The list pointer `next' can be used by the application to put the
167 * packet context in a list during processing, if needed.
171 typedef struct SilcPacketStruct {
172 struct SilcPacketStruct *next; /* List pointer, application may set */
173 SilcPacketStream stream; /* Packet stream this packet is from */
174 SilcBufferStruct buffer; /* Packet data payload */
175 unsigned char *src_id; /* Source ID */
176 unsigned char *dst_id; /* Destination ID */
177 unsigned int src_id_len : 6; /* Source ID length */
178 unsigned int src_id_type : 2; /* Source ID type */
179 unsigned int dst_id_len : 6; /* Destination ID length */
180 unsigned int dst_id_type : 2; /* Destination ID type */
181 SilcPacketType type; /* Packet type */
182 SilcPacketFlags flags; /* Packet flags */
186 /****d* silcutil/SilcPacketAPI/SilcPacketError
190 * typedef enum { ... } SilcPacketError
194 * Packet errors. This is returned in the error callback. If application
195 * needs the actual lower level stream error, it needs to retrieve it
196 * from the actual stream. It can retrieve the underlaying stream from
197 * the packet stream by calling silc_packet_stream_get_stream function.
202 SILC_PACKET_ERR_READ, /* Error while reading */
203 SILC_PACKET_ERR_WRITE, /* Error while writing */
204 SILC_PACKET_ERR_MAC_FAILED, /* Packet MAC check failed */
205 SILC_PACKET_ERR_DECRYPTION_FAILED, /* Packet decryption failed */
206 SILC_PACKET_ERR_UNKNOWN_SID, /* Unknown SID (with IV included) */
207 SILC_PACKET_ERR_MALFORMED, /* Packet is malformed */
208 SILC_PACKET_ERR_NO_MEMORY, /* System out of memory */
212 /****f* silccore/SilcPacketAPI/SilcPacketReceiveCb
216 * typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine,
217 * SilcPacketStream stream,
219 * void *callback_context,
220 * void *stream_context);
224 * The packet receive callback is called by the packet engine when a new
225 * SILC Packet has arrived. The application must free the returned
226 * SilcPacket with silc_packet_free if it takes the packet in for
227 * processing. This callback is set in the SilcPacketCallbacks structure.
228 * The `callback_context' is the context set as argument in the
229 * silc_packet_engine_start function. The `stream_context' is stream
230 * specific context that was set by calling silc_packet_set_context.
232 * If the application takes the received packet `packet' into processing
233 * TRUE must be returned. If FALSE is returned the packet engine will
234 * pass the packet to other packet processor, if one has been linked
235 * to the stream with silc_packet_stream_link function. If no extra
236 * processor is linked the packet is dropped.
241 * silc_foo_packet_receive_cb(SilcPacketEngine engine,
242 * SilcPacketStream stream, SilcPacket packet,
243 * void *callback_context, void *stream_context)
245 * Application ctx = callback_context;
247 * // If we're not up yet, let's not process the packet
248 * if (ctx->initialized == FALSE)
251 * // Process the incoming packet...
254 * // It's our packet now, no one else will get it
259 typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine,
260 SilcPacketStream stream,
262 void *callback_context,
263 void *stream_context);
265 /****f* silccore/SilcPacketAPI/SilcPacketEosCb
269 * typedef void (*SilcPacketEosCb)(SilcPacketEngine engine,
270 * SilcPacketStream stream,
271 * void *callback_context,
272 * void *stream_context);
276 * The End Of Stream (EOS) callback, that is called by the packet engine
277 * when the underlaying stream has ended. No more data can be sent to
278 * the stream or read from it. The `stream' must be destroyed by
279 * calling the silc_packet_stream_destroy. This callback is set in the
280 * SilcPacketCallbacks structure.
283 typedef void (*SilcPacketEosCb)(SilcPacketEngine engine,
284 SilcPacketStream stream,
285 void *callback_context,
286 void *stream_context);
288 /****f* silccore/SilcPacketAPI/SilcPacketErrorCb
292 * typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine,
293 * SilcPacketStream stream,
294 * SilcPacketError error,
295 * void *callback_context,
296 * void *stream_context);
300 * The error callback that is called by the packet engine if an error
301 * occurs. The `error' will indicate the error. This callback is set
302 * in the SilcPacketCallbacks structure.
305 typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine,
306 SilcPacketStream stream,
307 SilcPacketError error,
308 void *callback_context,
309 void *stream_context);
311 /****s* silccore/SilcPacketAPI/SilcPacketStream
315 * typedef struct SilcPacketStreamStruct *SilcPacketStream;
319 * This structure is sent as argument to the silc_packet_engine_start
320 * function to set the callback functions for the packet engine. The
321 * packet engine will call the callbacks when necessary. Application
322 * must always be provided for the packet engine.
327 SilcPacketReceiveCb packet_receive; /* Called when packet is received */
328 SilcPacketEosCb eos; /* Called on end of stream */
329 SilcPacketErrorCb error; /* Called on an error */
330 } SilcPacketCallbacks;
335 /****f* silccore/SilcPacketAPI/silc_packet_engine_start
340 * silc_packet_engine_start(SilcRng rng, SilcBool router,
341 * SilcPacketCallbacks *callbacks,
342 * void *callback_context);
346 * Create new packet engine for processing incoming and outgoing packets.
347 * If `router' is TRUE then the application is considered to be router
348 * server, and certain packets are handled differently. Client and normal
349 * server must set it to FALSE. The `callbacks' is a SilcPacketCallbacks
350 * structure provided by the caller which includes the callbacks that is
351 * called when for example packet is received, or end of stream is called.
355 * The packet engine is thread safe. You can use one packet engine in
356 * multi threaded application.
360 silc_packet_engine_start(SilcRng rng, SilcBool router,
361 SilcPacketCallbacks *callbacks,
362 void *callback_context);
364 /****f* silccore/SilcPacketAPI/silc_packet_engine_stop
368 * void silc_packet_engine_stop(SilcPacketEngine engine);
372 * Stop the packet engine. No new packets can be sent or received after
373 * calling this, and the `engine' will become invalid.
376 void silc_packet_engine_stop(SilcPacketEngine engine);
378 /****f* silccore/SilcPacketAPI/silc_packet_stream_create
382 * SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine,
383 * SilcSchedule schedule,
384 * SilcStream stream);
388 * Create new packet stream and use the `stream' as underlaying stream.
389 * Usually the `stream' would be a socket stream, but it can be any
390 * stream. After this function returns, packets can immediately be
391 * sent to and received from the stream.
395 * SilcPacketStream cannot be used with silc_stream_* routines (such as
396 * silc_stream_read and silc_stream_write) because of its special nature.
397 * Use the silc_packet_send and the silc_packet_send_ext to send packets.
398 * To read packets you will receive the packet receive callback from
399 * packet engine. Destroy the stream with silc_packet_stream_destroy.
401 * The SilcPacketStream is thread safe. Same context can be safely used
402 * in multi threaded environment.
405 SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine,
406 SilcSchedule schedule,
409 /****f* silccore/SilcPacketAPI/silc_packet_stream_add_remote
413 * SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream,
414 * const char *remote_ip,
415 * SilcUInt16 remote_port,
416 * SilcPacket packet);
420 * This function is used to add remote receivers in packet stream `stream'
421 * that has UDP/IP socket stream as the underlaying stream. This function
422 * cannot be used with other type of streams. This returns new packet
423 * stream context that can be used to send to and receive packets from
424 * the specified remote IP and remote port, or NULL on error. The `stream'
425 * is the actual stream that is used to send and receive the data.
427 * When the parent `stream' receives packets from remote IP address
428 * and port that does not have its own remote packet stream, it returns
429 * the packet to the packet callback set for `stream'. The sender's
430 * IP address and port can then be retrieved by using the
431 * silc_packet_get_sender function and to create new packet stream by
432 * calling this function. After that, all packets from that IP address
433 * and port will be received by the new packet stream.
435 * If the `packet' is non-NULL it will be injected into the new packet
436 * stream as soon as the scheduler associated with `stream' schedules
437 * new tasks. It can be used to inject an incoming packet to the stream.
439 * This interface is for connectionless UDP streams. If it is possible
440 * to create connected stream it should be done for performance reasons.
444 * // Create parent packet stream, it can receive packets from anywhere
445 * listener = silc_net_udp_connect("0.0.0.0", 500, NULL, 0, schedule);
446 * parent = silc_packet_stream_create(engine, schedule, listener);
449 * // Received a packet to the parent stream, get the sender information.
450 * silc_packet_get_sender(packet, &ip, &port);
452 * // Create new packet stream for this remote location.
453 * remote = silc_packet_stream_add_remote(parent, ip, port, packet);
456 SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream,
457 const char *remote_ip,
458 SilcUInt16 remote_port,
461 /****f* silccore/SilcPacketAPI/silc_packet_stream_destroy
465 * void silc_packet_stream_destroy(SilcPacketStream stream);
469 * Destroy packet stream and the underlaying stream. This will also
470 * close and destroy the underlaying stream.
473 void silc_packet_stream_destroy(SilcPacketStream stream);
475 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_router
479 * void silc_packet_stream_set_router(SilcPacketStream stream);
483 * When called sets the stream indicates by `stream' as SILC router
484 * connection stream. This causes that certain packets are handled
485 * differently. This must be called for router connection streams and
486 * must not be called for any other stream.
489 void silc_packet_stream_set_router(SilcPacketStream stream);
491 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_iv_included
495 * void silc_packet_stream_set_iv_included(SilcPacketStream stream);
499 * Sets an IV Included property for the stream indicated by `stream'.
500 * This means that the IV used in the encryption will be included in
501 * the resulted ciphertext. This makes it possible to send and receive
502 * packets on unreliable network transport protocol, such as UDP/IP.
503 * This must be called if the underlaying stream in the `stream' is UDP
506 * When this is set to the stream the silc_packet_set_sid must be called
507 * to set new Security ID. The Security ID will be included with the IV
511 void silc_packet_stream_set_iv_included(SilcPacketStream stream);
513 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_stream
517 * void silc_packet_stream_set_stream(SilcPacketStream packet_stream,
519 * SilcSchedule schedule);
523 * This function may be used to change the underlaying stream in the
524 * packet stream indicated by `packet_stream'. Note that the old
525 * stream will not be used after calling this function. The caller is
526 * responsible destroying the old stream.
529 void silc_packet_stream_set_stream(SilcPacketStream packet_stream,
531 SilcSchedule schedule);
533 /****f* silccore/SilcPacketAPI/silc_packet_stream_get_stream
537 * SilcStream silc_packet_stream_get_stream(SilcPacketStream stream);
541 * Returns the actual stream that is associated with the packet stream
542 * `stream'. The caller must not free the returned stream. The returned
543 * stream is the same pointer that was set for silc_packet_stream_create.
544 * This function could be used for example when an error callback is
545 * called by the packet engine to retrieve the actual lower level error
549 SilcStream silc_packet_stream_get_stream(SilcPacketStream stream);
551 /****f* silccore/SilcPacketAPI/silc_packet_stream_link
555 * SilcBool silc_packet_stream_link(SilcPacketStream stream,
556 * SilcPacketCallbacks *callbacks,
557 * void *callback_context,
558 * int priority, ...);
562 * Links the packet processing callbacks indicated by `callbacks' into
563 * the packet stream indicated by `stream' with priority `priority' for
564 * the packet types given in the variable argument list. This function
565 * can be used to link to the packet stream for specific packet types
566 * and receive them in the specified callbacks. This way, a third party,
567 * for example some library may attach itself into the packet stream
568 * and receive and process certain packets. The variable argument
569 * list is ended with -1. To link to receive all packets use
572 * The default packet processing callbacks given as argument to the
573 * silc_packet_engine_start has the priority 0. Any priority higher
574 * than 0 will then take precedence over the default callbacks. Any
575 * priority lower than 0 (negative value) will be processed after the
578 * Note that setting only the 'packet_receive' callback in the `callbacks'
583 * // Link to this packet stream, with high priority, for
584 * // SILC_PACKET_CONNECTION_AUTH and SILC_PACKET_CONNECTION_AUTH_REQUEST
585 * // packets. We don't care about other packets.
586 * silc_packet_stream_link(stream, our_callbacks, our_context,
587 * 1000000, SILC_PACKET_CONNECTION_AUTH,
588 * SILC_PACKET_CONNECTION_AUTH_REQUEST, -1);
591 SilcBool silc_packet_stream_link(SilcPacketStream stream,
592 SilcPacketCallbacks *callbacks,
593 void *callback_context,
596 /****f* silccore/SilcPacketAPI/silc_packet_stream_unlink
600 * void silc_packet_stream_unlink(SilcPacketStream stream,
601 * SilcPacketCallbacks *callbacks,
602 * void *callback_context);
606 * Unlinks the `callbacks' with `callback_context' from the packet stream
607 * indicated by `stream'. This function must be called for the callbacks
608 * that was linked to `stream' when they are not needed anymore.
611 void silc_packet_stream_unlink(SilcPacketStream stream,
612 SilcPacketCallbacks *callbacks,
613 void *callback_context);
615 /****f* silccore/SilcPacketAPI/silc_packet_get_sender
619 * SilcBool silc_packet_stream_is_udp(SilcPacketStream stream);
623 * Returns TRUE if the packet stream indicated by `stream' is using
627 SilcBool silc_packet_stream_is_udp(SilcPacketStream stream);
629 /****f* silccore/SilcPacketAPI/silc_packet_get_sender
633 * SilcBool silc_packet_get_sender(SilcPacket packet,
634 * const char **sender_ip,
635 * SilcUInt16 *sender_port);
639 * Returns the packet sender's IP address and port from UDP packet
640 * indicated by `packet'. This can be called only from the packet
641 * callback to retrieve the information of the packet's sender. Returns
642 * FALSE if the information is not available.
645 SilcBool silc_packet_get_sender(SilcPacket packet,
646 const char **sender_ip,
647 SilcUInt16 *sender_port);
649 /****f* silccore/SilcPacketAPI/silc_packet_stream_ref
653 * void silc_packet_stream_ref(SilcPacketStream stream);
657 * Increase reference counter for the stream indicated by `stream'. This
658 * can be used to take a reference for the stream. To unreference the
659 * stream call silc_packet_stream_unref function.
662 void silc_packet_stream_ref(SilcPacketStream stream);
664 /****f* silccore/SilcPacketAPI/silc_packet_stream_unref
668 * void silc_packet_stream_unref(SilcPacketStream stream);
672 * Decrease reference counter for the stream indicated by `stream'. If
673 * the counter hits zero the stream will be destroyed automatically.
676 void silc_packet_stream_unref(SilcPacketStream stream);
678 /****f* silccore/SilcPacketAPI/silc_packet_get_engine
682 * SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream);
686 * Returns the packet engine from the `stream'.
689 SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream);
691 /****f* silccore/SilcPacketAPI/silc_packet_set_context
695 * void silc_packet_set_context(SilcPacketStream stream,
696 * void *stream_context);
700 * Sets a stream specific context to the stream. The context will
701 * be delivered to all callback functions, and it can be retrieved by
702 * calling silc_packet_get_context function as well. Note that this is
703 * separate packet stream specific context, and not the same as
704 * `callback_context' in silc_packet_engine_start. Both will be delivered
705 * to the callbacks, and this context as the `stream_context' argument.
708 void silc_packet_set_context(SilcPacketStream stream, void *stream_context);
710 /****f* silccore/SilcPacketAPI/silc_packet_get_context
714 * void *silc_packet_get_context(SilcPacketStream stream);
718 * Returns the current set application context, or NULL if none is set.
721 void *silc_packet_get_context(SilcPacketStream stream);
723 /****f* silccore/SilcPacketAPI/silc_packet_set_ciphers
727 * void silc_packet_set_ciphers(SilcPacketStream stream, SilcCipher send,
728 * SilcCipher receive);
732 * Set ciphers to be used to encrypt sent packets, and decrypt received
733 * packets. This can be called multiple times to change the ciphers.
734 * In this case if old cipher is set it will be freed. If ciphers are
735 * not set packets will not be encrypted or decrypted.
738 void silc_packet_set_ciphers(SilcPacketStream stream, SilcCipher send,
741 /****f* silccore/SilcPacketAPI/silc_packet_get_ciphers
745 * SilcBool silc_packet_get_ciphers(SilcPacketStream stream,
747 * SilcCipher *receive);
751 * Returns the pointers of current ciphers from the `stream'. Returns
752 * FALSE if ciphers are not set.
755 SilcBool silc_packet_get_ciphers(SilcPacketStream stream, SilcCipher *send,
756 SilcCipher *receive);
758 /****f* silccore/SilcPacketAPI/silc_packet_set_hmacs
762 * void silc_packet_set_hmacs(SilcPacketStream stream, SilcHmac send,
767 * Set HMACs to be used to create MACs for sent packets and to check
768 * MAC for received packets. This can be called multiple times to change
769 * the HMACs. In this case if old HMAC is set it will be freed. If
770 * HMACs are not set MACs are not generated or verified for packets.
773 void silc_packet_set_hmacs(SilcPacketStream stream, SilcHmac send,
776 /****f* silccore/SilcPacketAPI/silc_packet_get_hmacs
780 * SilcBool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send,
781 * SilcHmac *receive);
785 * Returns the pointers of current HMACs from the `stream'. Returns
786 * FALSE if HMACs are not set.
789 SilcBool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send,
792 /****f* silccore/SilcPacketAPI/silc_packet_set_ids
796 * SilcBool silc_packet_set_ids(SilcPacketStream stream,
797 * SilcIdType src_id_type, const void *src_id
798 * SilcIdType dst_id_type, const void *dst_id);
802 * Set the source ID and destinaion ID to be used when sending packets to
803 * this packet stream. The IDs to be used for a packet stream can be
804 * overridden when sending packets. However, if the IDs do not ever change
805 * for the packet stream it is recommended they are set using this function.
806 * In this case they can be omitted when sending packets to the stream.
807 * It is also possible to set only source or destination ID.
810 SilcBool silc_packet_set_ids(SilcPacketStream stream,
811 SilcIdType src_id_type, const void *src_id,
812 SilcIdType dst_id_type, const void *dst_id);
814 /****f* silccore/SilcPacketAPI/silc_packet_set_sid
818 * SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid);
822 * Sets new Security ID to the packet stream indicated by `stream'. This
823 * is called only if the IV Included property was set to the stream
824 * by calling silc_packet_stream_set_iv_included. This function sets
825 * new Security ID to the stream which is then included in the ciphertext
826 * of a packet. The `sid' must be 0 when it is set for the very first
827 * time and must be increased by one after each rekey. This function must
828 * be called every time new keys are added to the stream after a rekey.
830 * If this function is called when the IV Included property has not been
831 * set to the stream the `sid' will be ignored. Returns FALSE if the
832 * IV Included has not been set, TRUE otherwise.
835 SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid);
837 /****f* silccore/SilcPacketAPI/silc_packet_send
841 * SilcBool silc_packet_send(SilcPacketStream stream,
842 * SilcPacketType type, SilcPacketFlags flags,
843 * const unsigned char *data,
844 * SilcUInt32 data_len);
848 * Send `data' of length of `data_len' to the packet stream indicated by
849 * `stream'. If ciphers and HMACs were set using silc_packet_set_ciphers
850 * and silc_packet_set_hmacs the packet will be encrypted and MAC will be
851 * computed for it. If silc_packet_set_ids was used to set source and
852 * destination ID for the packet stream those IDs are used in the
853 * packet. If IDs have not been set and they need to be provided then
854 * silc_packet_send_ext function should be used. Otherwise, the packet
855 * will not have IDs set at all. Returns FALSE if packet could not be
859 SilcBool silc_packet_send(SilcPacketStream stream,
860 SilcPacketType type, SilcPacketFlags flags,
861 const unsigned char *data, SilcUInt32 data_len);
863 /****f* silccore/SilcPacketAPI/silc_packet_send_ext
868 * silc_packet_send_ext(SilcPacketStream stream,
869 * SilcPacketType type, SilcPacketFlags flags,
870 * SilcIdType src_id_type, void *srd_id,
871 * SilcIdType dst_id_type, void *dst_id,
872 * const unsigned char *data, SilcUInt32 data_len,
873 * SilcCipher cipher, SilcHmac hmac);
877 * Same as silc_packet_send but with this function different sending
878 * parameters can be sent as argument. This function can be used to
879 * set specific IDs, cipher and HMAC to be used in packet sending,
880 * instead of the ones saved in the `stream'. If any of the extra
881 * pointers are NULL, default values set to the stream will apply.
884 SilcBool silc_packet_send_ext(SilcPacketStream stream,
885 SilcPacketType type, SilcPacketFlags flags,
886 SilcIdType src_id_type, void *src_id,
887 SilcIdType dst_id_type, void *dst_id,
888 const unsigned char *data, SilcUInt32 data_len,
889 SilcCipher cipher, SilcHmac hmac);
891 /****f* silccore/SilcPacketAPI/silc_packet_send_va
895 * SilcBool silc_packet_send_va(SilcPacketStream stream,
896 * SilcPacketType type,
897 * SilcPacketFlags flags, ...);
901 * Same as silc_packet_send but takes the data in as variable argument
902 * formatted buffer (see silcbuffmt.h). The arguments must be ended
903 * with SILC_STR_END. Returns FALSE if packet could not be sent or
904 * the buffer could not be formatted.
908 * // Send NEW_CLIENT packet
909 * silc_packet_send_va(stream, SILC_PACKET_NEW_CLIENT, 0,
910 * SILC_STR_UI_SHORT(username_len),
911 * SILC_STR_DATA(username, username_len),
912 * SILC_STR_UI_SHORT(realname_len),
913 * SILC_STR_DATA(realname, realname_len),
917 SilcBool silc_packet_send_va(SilcPacketStream stream,
918 SilcPacketType type, SilcPacketFlags flags, ...);
920 /****f* silccore/SilcPacketAPI/silc_packet_send_va_ext
925 * silc_packet_send_va_ext(SilcPacketStream stream,
926 * SilcPacketType type, SilcPacketFlags flags,
927 * SilcIdType src_id_type, void *srd_id,
928 * SilcIdType dst_id_type, void *dst_id,
929 * SilcCipher cipher, SilcHmac hmac, ...);
933 * Same as silc_packet_send_va but with this function different sending
934 * parameters can be sent as argument. This function can be used to
935 * set specific IDs, cipher and HMAC to be used in packet sending,
936 * instead of the ones saved in the `stream'. If any of the extra
937 * pointers are NULL, default values set to the stream will apply.
940 SilcBool silc_packet_send_va_ext(SilcPacketStream stream,
941 SilcPacketType type, SilcPacketFlags flags,
942 SilcIdType src_id_type, void *src_id,
943 SilcIdType dst_id_type, void *dst_id,
944 SilcCipher cipher, SilcHmac hmac, ...);
946 /****f* silccore/SilcPacketAPI/silc_packet_wait
950 * void *silc_packet_wait_init(SilcPacketStream stream, ...);
954 * Initializes a packet waiter for the packet stream `stream' and
955 * for the variable argument list of packet types. The function
956 * silc_packet_wait can be used to block the thread until a packet
957 * has been received. This function is used to initialize the waiting
958 * and to give the list of packet types that caller wish to receive.
959 * The variable argument list must end with -1. To receive all
960 * packets use SILC_PACKET_ANY. Returns a context that must be given
961 * to the silc_packet_wait function as argument. Returns NULL on
962 * error. To uninitialize the waiting call silc_packet_wait_uninit.
966 * Note that packets may be available immediately after calling this
967 * function and they will be buffered, until silc_packet_wait is called.
973 * // Will wait for private message packets
974 * waiter = silc_packet_wait_init(stream,
975 * SILC_PACKET_PRIVATE_MESSAGE, -1);
979 void *silc_packet_wait_init(SilcPacketStream stream, ...);
981 /****f* silccore/SilcPacketAPI/silc_packet_wait
985 * void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream);
989 * Uninitializes the waiting context. This may be called also from
990 * another thread while other thread is waiting for packets. This will
991 * inform the waiting thread to stop waiting.
994 void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream);
996 /****f* silccore/SilcPacketAPI/silc_packet_wait
1000 * int silc_packet_wait(void *waiter, int timeout,
1001 * SilcPacket *return_packet)
1005 * A special function that can be used to wait for a packet to arrive.
1006 * This function will block the calling process or thread until either
1007 * a packet is received into the `return_packet' pointer or the specified
1008 * timeout value `timeout', which is in milliseconds, will expire. If
1009 * the timeout is 0, no timeout exist. Before calling this function the
1010 * silc_packet_wait_init must be called. The caller is responsible for
1011 * freeing the returned packet with silc_packet_free.
1013 * This function can be used for example from a thread that wants to
1014 * block until SILC packet has been received.
1016 * Returns 1 when packet was received, 0 if timeout occurred and -1 if
1021 * static int foo_read_data(FooContext c)
1023 * SilcPacket packet;
1027 * // Will wait for private message packets
1028 * if (c->initialized == FALSE) {
1029 * waiter = silc_packet_wait_init(stream,
1030 * SILC_PACKET_PRIVATE_MESSAGE, -1);
1031 * c->initialized = TRUE;
1035 * // Wait here until private message packet is received
1036 * if ((silc_packet_wait(waiter, 0, &packet)) < 0)
1039 * ... process packet ...
1045 int silc_packet_wait(void *waiter, int timeout, SilcPacket *return_packet);
1047 /****f* silccore/SilcPacketAPI/silc_packet_free
1051 * void silc_packet_free(SilcPacket packet);
1055 * This function is used to free the SilcPacket pointer that application
1056 * receives in the SilcPacketReceive callback. Application must free
1057 * the packet if it takes it in to processing.
1060 void silc_packet_free(SilcPacket packet);
1062 #endif /* SILCPACKET_H */