5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2008 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 * Created: Fri Jul 25 18:52:14 1997
26 /************************** Types and definitions ***************************/
28 /* Per scheduler (which usually means per thread) data. We put per scheduler
29 data here for accessing without locking. SILC Schedule dictates that
30 tasks are dispatched in one thread, hence the per scheduler context. */
32 SilcSchedule schedule; /* The scheduler */
33 SilcPacketEngine engine; /* Packet engine */
34 SilcDList inbufs; /* Data inbut buffer list */
35 SilcUInt32 stream_count; /* Number of streams using this */
36 } *SilcPacketEngineContext;
39 struct SilcPacketEngineStruct {
40 SilcMutex lock; /* Engine lock */
41 SilcRng rng; /* RNG for engine */
42 SilcHashTable contexts; /* Per scheduler contexts */
43 const SilcPacketCallbacks *callbacks; /* Packet callbacks */
44 void *callback_context; /* Context for callbacks */
45 SilcList streams; /* All streams in engine */
46 SilcList packet_pool; /* Free list for received packets */
47 SilcHashTable udp_remote; /* UDP remote streams, or NULL */
48 unsigned int local_is_router : 1;
51 /* Packet processor context */
52 typedef struct SilcPacketProcessStruct {
53 SilcPacketType *types; /* Packets to process */
54 const SilcPacketCallbacks *callbacks; /* Callbacks or NULL */
55 void *callback_context;
56 SilcInt32 priority; /* Priority */
59 /* UDP remote stream tuple */
61 char *remote_ip; /* Remote IP address */
62 SilcUInt16 remote_port; /* Remote port */
63 } *SilcPacketRemoteUDP;
66 struct SilcPacketStreamStruct {
67 struct SilcPacketStreamStruct *next;
68 SilcPacketEngineContext sc; /* Per scheduler context */
69 SilcStream stream; /* Underlaying stream */
70 SilcMutex lock; /* Packet stream lock */
71 SilcDList process; /* Packet processors, or NULL */
72 SilcPacketRemoteUDP remote_udp; /* UDP remote stream tuple, or NULL */
73 void *stream_context; /* Stream context */
74 SilcBufferStruct outbuf; /* Out buffer */
75 SilcBuffer inbuf; /* Inbuf from inbuf list or NULL */
76 SilcCipher send_key[2]; /* Sending key */
77 SilcHmac send_hmac[2]; /* Sending HMAC */
78 SilcCipher receive_key[2]; /* Receiving key */
79 SilcHmac receive_hmac[2]; /* Receiving HMAC */
80 unsigned char *src_id; /* Source ID */
81 unsigned char *dst_id; /* Destination ID */
82 SilcUInt32 send_psn; /* Sending sequence */
83 SilcUInt32 receive_psn; /* Receiving sequence */
84 SilcAtomic8 refcnt; /* Reference counter */
85 SilcUInt8 sid; /* Security ID, set if IV included */
86 unsigned int src_id_len : 6;
87 unsigned int src_id_type : 2;
88 unsigned int dst_id_len : 6;
89 unsigned int dst_id_type : 2;
90 unsigned int is_router : 1; /* Set if router stream */
91 unsigned int destroyed : 1; /* Set if destroyed */
92 unsigned int iv_included : 1; /* Set if IV included */
93 unsigned int udp : 1; /* UDP remote stream */
96 /* Initial size of stream buffers */
97 #define SILC_PACKET_DEFAULT_SIZE 1024
99 /* Header length without source and destination ID's. */
100 #define SILC_PACKET_HEADER_LEN 10
102 /* Minimum length of SILC Packet Header. */
103 #define SILC_PACKET_MIN_HEADER_LEN 16
104 #define SILC_PACKET_MIN_HEADER_LEN_IV 32 + 1
106 /* Maximum padding length */
107 #define SILC_PACKET_MAX_PADLEN 128
109 /* Default padding length */
110 #define SILC_PACKET_DEFAULT_PADLEN 16
112 /* Minimum packet length */
113 #define SILC_PACKET_MIN_LEN (SILC_PACKET_HEADER_LEN + 1)
115 /* Returns true length of the packet. */
116 #define SILC_PACKET_LENGTH(__packetdata, __ret_truelen, __ret_paddedlen) \
118 SILC_GET16_MSB((__ret_truelen), (__packetdata)); \
119 (__ret_paddedlen) = (__ret_truelen) + (SilcUInt8)(__packetdata)[4]; \
122 /* Calculates the data length with given header length. This macro
123 can be used to check whether the data_len with header_len exceeds
124 SILC_PACKET_MAX_LEN. If it does, this returns the new data_len
125 so that the SILC_PACKET_MAX_LEN is not exceeded. If the data_len
126 plus header_len fits SILC_PACKET_MAX_LEN the returned data length
127 is the data_len given as argument. */
128 #define SILC_PACKET_DATALEN(data_len, header_len) \
129 ((data_len + header_len) > SILC_PACKET_MAX_LEN ? \
130 data_len - ((data_len + header_len) - SILC_PACKET_MAX_LEN) : data_len)
132 /* Calculates the length of the padding in the packet. */
133 #define SILC_PACKET_PADLEN(__packetlen, __blocklen, __padlen) \
135 __padlen = (SILC_PACKET_DEFAULT_PADLEN - (__packetlen) % \
136 ((__blocklen) ? (__blocklen) : SILC_PACKET_DEFAULT_PADLEN)); \
138 __padlen += ((__blocklen) ? (__blocklen) : SILC_PACKET_DEFAULT_PADLEN); \
141 /* Returns the length of the padding up to the maximum length, which
143 #define SILC_PACKET_PADLEN_MAX(__packetlen, __blocklen, __padlen) \
145 __padlen = (SILC_PACKET_MAX_PADLEN - (__packetlen) % \
146 ((__blocklen) ? (__blocklen) : SILC_PACKET_DEFAULT_PADLEN)); \
150 #define SILC_PACKET_CALLBACK_EOS(s) \
152 (s)->sc->engine->callbacks->eos((s)->sc->engine, s, \
153 (s)->sc->engine->callback_context, \
154 (s)->stream_context); \
158 #define SILC_PACKET_CALLBACK_ERROR(s, err) \
160 (s)->sc->engine->callbacks->error((s)->sc->engine, s, err, \
161 (s)->sc->engine->callback_context, \
162 (s)->stream_context); \
165 static SilcBool silc_packet_dispatch(SilcPacket packet);
166 static void silc_packet_read_process(SilcPacketStream stream);
167 static inline SilcBool silc_packet_send_raw(SilcPacketStream stream,
169 SilcPacketFlags flags,
170 SilcIdType src_id_type,
171 unsigned char *src_id,
172 SilcUInt32 src_id_len,
173 SilcIdType dst_id_type,
174 unsigned char *dst_id,
175 SilcUInt32 dst_id_len,
176 const unsigned char *data,
181 /************************ Static utility functions **************************/
183 /* Injects packet to new stream created with silc_packet_stream_add_remote. */
185 SILC_TASK_CALLBACK(silc_packet_stream_inject_packet)
187 SilcPacket packet = context;
188 SilcPacketStream stream = packet->stream;
190 SILC_LOG_DEBUG(("Injecting packet %p to stream %p", packet, packet->stream));
192 silc_mutex_lock(stream->lock);
193 if (!stream->destroyed)
194 silc_packet_dispatch(packet);
195 silc_mutex_unlock(stream->lock);
196 silc_packet_stream_unref(stream);
199 /* Write data to the stream. Must be called with ps->lock locked. Unlocks
200 the lock inside this function, unless no_unlock is TRUE. Unlocks always
201 in case it returns FALSE. */
203 static inline SilcBool silc_packet_stream_write(SilcPacketStream ps,
211 stream = ((SilcPacketStream)ps->stream)->stream;
215 if (ps->udp && silc_socket_stream_is_udp(stream, &connected)) {
217 /* Connectionless UDP stream */
218 while (silc_buffer_len(&ps->outbuf) > 0) {
219 i = silc_net_udp_send(stream, ps->remote_udp->remote_ip,
220 ps->remote_udp->remote_port,
221 ps->outbuf.data, silc_buffer_len(&ps->outbuf));
222 if (silc_unlikely(i == -2)) {
224 silc_buffer_reset(&ps->outbuf);
225 SILC_PACKET_CALLBACK_ERROR(ps, SILC_PACKET_ERR_WRITE);
229 if (silc_unlikely(i == -1)) {
230 /* Cannot write now, write later. */
232 silc_mutex_unlock(ps->lock);
237 silc_buffer_pull(&ps->outbuf, i);
240 silc_buffer_reset(&ps->outbuf);
242 silc_mutex_unlock(ps->lock);
248 /* Write the data to the stream */
249 while (silc_buffer_len(&ps->outbuf) > 0) {
250 i = silc_stream_write(stream, ps->outbuf.data,
251 silc_buffer_len(&ps->outbuf));
252 if (silc_unlikely(i == 0)) {
254 silc_buffer_reset(&ps->outbuf);
255 silc_mutex_unlock(ps->lock);
256 SILC_PACKET_CALLBACK_EOS(ps);
260 if (silc_unlikely(i == -2)) {
262 silc_buffer_reset(&ps->outbuf);
263 silc_mutex_unlock(ps->lock);
264 SILC_PACKET_CALLBACK_ERROR(ps, SILC_PACKET_ERR_WRITE);
268 if (silc_unlikely(i == -1)) {
269 /* Cannot write now, write later. */
271 silc_mutex_unlock(ps->lock);
276 silc_buffer_pull(&ps->outbuf, i);
279 silc_buffer_reset(&ps->outbuf);
281 silc_mutex_unlock(ps->lock);
286 /* Reads data from stream. Must be called with ps->lock locked. If this
287 returns FALSE the lock has been unlocked. If this returns packet stream
288 to `ret_ps' its lock has been acquired and `ps' lock has been unlocked.
289 It is returned if the stream is UDP and remote UDP stream exists for
290 the sender of the packet. */
292 static inline SilcBool silc_packet_stream_read(SilcPacketStream ps,
293 SilcPacketStream *ret_ps)
295 SilcStream stream = ps->stream;
300 /* Get inbuf. If there is already some data for this stream in the buffer
301 we already have it. Otherwise get the current one from list, it will
305 silc_dlist_start(ps->sc->inbufs);
306 inbuf = silc_dlist_get(ps->sc->inbufs);
308 /* Allocate new data input buffer */
309 inbuf = silc_buffer_alloc(SILC_PACKET_DEFAULT_SIZE * 65);
311 silc_mutex_unlock(ps->lock);
314 silc_buffer_reset(inbuf);
315 silc_dlist_add(ps->sc->inbufs, inbuf);
319 /* Make sure there is enough room to read */
320 if (SILC_PACKET_DEFAULT_SIZE * 2 > silc_buffer_taillen(inbuf))
321 silc_buffer_realloc(inbuf, silc_buffer_truelen(inbuf) +
322 (SILC_PACKET_DEFAULT_SIZE * 2));
324 if (silc_socket_stream_is_udp(stream, &connected)) {
326 /* Connectionless UDP stream, read one UDP packet */
327 char remote_ip[64], tuple[64];
329 SilcPacketStream remote;
331 ret = silc_net_udp_receive(stream, remote_ip, sizeof(remote_ip),
332 &remote_port, inbuf->tail,
333 silc_buffer_taillen(inbuf));
335 if (silc_unlikely(ret < 0)) {
336 silc_mutex_unlock(ps->lock);
338 /* Cannot read now, do it later. */
343 silc_buffer_reset(inbuf);
344 SILC_PACKET_CALLBACK_ERROR(ps, SILC_PACKET_ERR_READ);
348 /* See if remote packet stream exist for this sender */
349 silc_snprintf(tuple, sizeof(tuple), "%d%s", remote_port, remote_ip);
350 silc_mutex_lock(ps->sc->engine->lock);
351 if (silc_hash_table_find(ps->sc->engine->udp_remote, tuple, NULL,
353 silc_mutex_unlock(ps->sc->engine->lock);
354 SILC_LOG_DEBUG(("UDP packet from %s:%d for stream %p", remote_ip,
355 remote_port, remote));
356 silc_mutex_unlock(ps->lock);
357 silc_mutex_lock(remote->lock);
361 silc_mutex_unlock(ps->sc->engine->lock);
364 if (!ps->remote_udp) {
365 ps->remote_udp = silc_calloc(1, sizeof(*ps->remote_udp));
366 if (silc_unlikely(!ps->remote_udp)) {
367 silc_mutex_unlock(ps->lock);
368 SILC_PACKET_CALLBACK_ERROR(ps, SILC_PACKET_ERR_NO_MEMORY);
373 /* Save sender IP and port */
374 silc_free(ps->remote_udp->remote_ip);
375 ps->remote_udp->remote_ip = strdup(remote_ip);
376 ps->remote_udp->remote_port = remote_port;
378 silc_buffer_pull_tail(inbuf, ret);
383 /* Read data from the stream */
384 ret = silc_stream_read(stream, inbuf->tail, silc_buffer_taillen(inbuf));
385 if (silc_unlikely(ret <= 0)) {
386 silc_mutex_unlock(ps->lock);
389 silc_buffer_reset(inbuf);
390 SILC_PACKET_CALLBACK_EOS(ps);
395 /* Cannot read now, do it later. */
400 silc_buffer_reset(inbuf);
401 SILC_PACKET_CALLBACK_ERROR(ps, SILC_PACKET_ERR_READ);
405 silc_buffer_pull_tail(inbuf, ret);
409 /* Our stream IO notifier callback. */
411 static void silc_packet_stream_io(SilcStream stream, SilcStreamStatus status,
414 SilcPacketStream remote = NULL, ps = context;
416 silc_mutex_lock(ps->lock);
418 if (silc_unlikely(ps->destroyed)) {
419 silc_mutex_unlock(ps->lock);
424 case SILC_STREAM_CAN_READ:
425 /* Reading is locked also with stream->lock because we may be reading
426 at the same time other thread is writing to same underlaying stream. */
427 SILC_LOG_DEBUG(("Reading data from stream %p, ps %p", ps->stream, ps));
429 /* Read data from stream */
430 if (!silc_packet_stream_read(ps, &remote))
433 /* Now process the data */
434 silc_packet_stream_ref(ps);
436 silc_packet_read_process(ps);
437 silc_mutex_unlock(ps->lock);
439 silc_packet_read_process(remote);
440 silc_mutex_unlock(remote->lock);
442 silc_packet_stream_unref(ps);
445 case SILC_STREAM_CAN_WRITE:
446 SILC_LOG_DEBUG(("Writing pending data to stream %p, ps %p",
449 if (silc_unlikely(!silc_buffer_headlen(&ps->outbuf))) {
450 silc_mutex_unlock(ps->lock);
454 /* Write pending data to stream */
455 silc_packet_stream_write(ps, FALSE);
459 silc_mutex_unlock(ps->lock);
464 /* Allocate packet */
466 static SilcPacket silc_packet_alloc(SilcPacketEngine engine)
470 SILC_LOG_DEBUG(("Packet pool count %d",
471 silc_list_count(engine->packet_pool)));
473 silc_mutex_lock(engine->lock);
475 /* Get packet from freelist or allocate new one. */
476 packet = silc_list_get(engine->packet_pool);
480 silc_mutex_unlock(engine->lock);
482 packet = silc_calloc(1, sizeof(*packet));
483 if (silc_unlikely(!packet))
486 SILC_LOG_DEBUG(("Allocating new packet %p", packet));
488 tmp = silc_malloc(SILC_PACKET_DEFAULT_SIZE);
489 if (silc_unlikely(!tmp)) {
493 silc_buffer_set(&packet->buffer, tmp, SILC_PACKET_DEFAULT_SIZE);
494 silc_buffer_reset(&packet->buffer);
499 SILC_LOG_DEBUG(("Get packet %p", packet));
501 /* Delete from freelist */
502 silc_list_del(engine->packet_pool, packet);
504 silc_mutex_unlock(engine->lock);
509 /* UDP remote stream hash table destructor */
511 static void silc_packet_engine_hash_destr(void *key, void *context,
517 /* Per scheduler context hash table destructor */
519 static void silc_packet_engine_context_destr(void *key, void *context,
522 SilcPacketEngineContext sc = context;
525 silc_dlist_start(sc->inbufs);
526 while ((buffer = silc_dlist_get(sc->inbufs))) {
527 silc_buffer_clear(buffer);
528 silc_buffer_free(buffer);
529 silc_dlist_del(sc->inbufs, buffer);
532 silc_dlist_uninit(sc->inbufs);
537 /******************************** Packet API ********************************/
539 /* Allocate new packet engine */
542 silc_packet_engine_start(SilcRng rng, SilcBool router,
543 const SilcPacketCallbacks *callbacks,
544 void *callback_context)
546 SilcPacketEngine engine;
551 SILC_LOG_DEBUG(("Starting new packet engine"));
555 if (!callbacks->packet_receive || !callbacks->eos || !callbacks->error)
558 engine = silc_calloc(1, sizeof(*engine));
562 engine->contexts = silc_hash_table_alloc(0, silc_hash_ptr, NULL, NULL, NULL,
563 silc_packet_engine_context_destr,
565 if (!engine->contexts) {
571 engine->local_is_router = router;
572 engine->callbacks = callbacks;
573 engine->callback_context = callback_context;
574 silc_list_init(engine->streams, struct SilcPacketStreamStruct, next);
575 silc_mutex_alloc(&engine->lock);
577 /* Allocate packet free list */
578 silc_list_init(engine->packet_pool, struct SilcPacketStruct, next);
579 for (i = 0; i < 5; i++) {
580 packet = silc_calloc(1, sizeof(*packet));
582 silc_packet_engine_stop(engine);
586 tmp = silc_malloc(SILC_PACKET_DEFAULT_SIZE);
588 silc_packet_engine_stop(engine);
591 silc_buffer_set(&packet->buffer, tmp, SILC_PACKET_DEFAULT_SIZE);
592 silc_buffer_reset(&packet->buffer);
594 silc_list_add(engine->packet_pool, packet);
596 silc_list_start(engine->packet_pool);
601 /* Stop packet engine */
603 void silc_packet_engine_stop(SilcPacketEngine engine)
607 SILC_LOG_DEBUG(("Stopping packet engine"));
612 /* Free packet free list */
613 silc_list_start(engine->packet_pool);
614 while ((packet = silc_list_get(engine->packet_pool))) {
615 silc_buffer_purge(&packet->buffer);
619 silc_hash_table_free(engine->contexts);
620 silc_mutex_free(engine->lock);
624 static const char * const packet_error[] = {
625 "Cannot read from stream",
626 "Cannot write to stream",
628 "Packet decryption failed",
630 "Packet is malformed",
631 "System out of memory",
634 /* Return packet error string */
636 const char *silc_packet_error_string(SilcPacketError error)
638 if (error < SILC_PACKET_ERR_READ || error > SILC_PACKET_ERR_NO_MEMORY)
639 return "<invalid error code>";
640 return packet_error[error];
643 /* Return list of packet streams in the engine */
645 SilcDList silc_packet_engine_get_streams(SilcPacketEngine engine)
650 list = silc_dlist_init();
654 silc_mutex_lock(engine->lock);
655 silc_list_start(engine->streams);
656 while ((ps = silc_list_get(engine->streams))) {
657 silc_packet_stream_ref(ps);
658 silc_dlist_add(list, ps);
660 silc_mutex_unlock(engine->lock);
665 /* Free list returned by silc_packet_engine_get_streams */
667 void silc_packet_engine_free_streams_list(SilcDList streams)
671 silc_dlist_start(streams);
672 while ((ps = silc_dlist_get(streams)))
673 silc_packet_stream_unref(ps);
675 silc_dlist_uninit(streams);
678 /* Create new packet stream */
680 SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine,
681 SilcSchedule schedule,
688 SILC_LOG_DEBUG(("Creating new packet stream"));
690 if (!engine || !stream)
693 ps = silc_calloc(1, sizeof(*ps));
698 silc_atomic_init8(&ps->refcnt, 1);
699 silc_mutex_alloc(&ps->lock);
701 /* Allocate out buffer */
702 tmp = silc_malloc(SILC_PACKET_DEFAULT_SIZE);
704 silc_packet_stream_destroy(ps);
707 silc_buffer_set(&ps->outbuf, tmp, SILC_PACKET_DEFAULT_SIZE);
708 silc_buffer_reset(&ps->outbuf);
710 /* Initialize packet procesors list */
711 ps->process = silc_dlist_init();
713 silc_packet_stream_destroy(ps);
717 silc_mutex_lock(engine->lock);
719 /* Add per scheduler context */
720 if (!silc_hash_table_find(engine->contexts, schedule, NULL,
722 ps->sc = silc_calloc(1, sizeof(*ps->sc));
724 silc_mutex_unlock(engine->lock);
725 silc_packet_stream_destroy(ps);
728 ps->sc->engine = engine;
729 ps->sc->schedule = schedule;
731 /* Allocate data input buffer */
732 inbuf = silc_buffer_alloc(SILC_PACKET_DEFAULT_SIZE * 65);
736 silc_mutex_unlock(engine->lock);
737 silc_packet_stream_destroy(ps);
740 silc_buffer_reset(inbuf);
742 ps->sc->inbufs = silc_dlist_init();
743 if (!ps->sc->inbufs) {
744 silc_buffer_free(inbuf);
747 silc_mutex_unlock(engine->lock);
748 silc_packet_stream_destroy(ps);
751 silc_dlist_add(ps->sc->inbufs, inbuf);
753 /* Add to per scheduler context hash table */
754 if (!silc_hash_table_add(engine->contexts, schedule, ps->sc)) {
755 silc_buffer_free(inbuf);
756 silc_dlist_del(ps->sc->inbufs, inbuf);
759 silc_mutex_unlock(engine->lock);
760 silc_packet_stream_destroy(ps);
764 ps->sc->stream_count++;
766 /* Add the packet stream to engine */
767 silc_list_add(engine->streams, ps);
769 /* If this is UDP stream, allocate UDP remote stream hash table */
770 if (!engine->udp_remote && silc_socket_stream_is_udp(stream, NULL))
771 engine->udp_remote = silc_hash_table_alloc(0, silc_hash_string, NULL,
772 silc_hash_string_compare, NULL,
773 silc_packet_engine_hash_destr,
776 silc_mutex_unlock(engine->lock);
778 /* Set IO notifier callback. This schedules this stream for I/O. */
779 if (!silc_stream_set_notifier(ps->stream, schedule,
780 silc_packet_stream_io, ps)) {
781 SILC_LOG_DEBUG(("Cannot set stream notifier for packet stream"));
782 silc_packet_stream_destroy(ps);
786 SILC_LOG_DEBUG(("Created packet stream %p", ps));
791 /* Add new remote packet stream for UDP packet streams */
793 SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream,
794 const char *remote_ip,
795 SilcUInt16 remote_port,
798 SilcPacketEngine engine = stream->sc->engine;
803 SILC_LOG_DEBUG(("Adding UDP remote %s:%d to packet stream %p",
804 remote_ip, remote_port, stream));
806 if (!stream || !remote_ip || !remote_port)
809 if (!silc_socket_stream_is_udp(stream->stream, NULL)) {
810 SILC_LOG_ERROR(("Stream is not UDP stream, cannot add remote IP"));
814 ps = silc_calloc(1, sizeof(*ps));
819 silc_atomic_init8(&ps->refcnt, 1);
820 silc_mutex_alloc(&ps->lock);
822 /* Set the UDP packet stream as underlaying stream */
823 silc_packet_stream_ref(stream);
824 ps->stream = (SilcStream)stream;
827 /* Allocate out buffer */
828 tmp = silc_malloc(SILC_PACKET_DEFAULT_SIZE);
830 silc_packet_stream_destroy(ps);
833 silc_buffer_set(&ps->outbuf, tmp, SILC_PACKET_DEFAULT_SIZE);
834 silc_buffer_reset(&ps->outbuf);
836 /* Initialize packet procesors list */
837 ps->process = silc_dlist_init();
839 silc_packet_stream_destroy(ps);
843 /* Add to engine with this IP and port pair */
844 tuple = silc_format("%d%s", remote_port, remote_ip);
845 silc_mutex_lock(engine->lock);
846 if (!tuple || !silc_hash_table_add(engine->udp_remote, tuple, ps)) {
847 silc_mutex_unlock(engine->lock);
848 silc_packet_stream_destroy(ps);
851 silc_mutex_unlock(engine->lock);
853 /* Save remote IP and port pair */
854 ps->remote_udp = silc_calloc(1, sizeof(*ps->remote_udp));
855 if (!ps->remote_udp) {
856 silc_packet_stream_destroy(ps);
859 ps->remote_udp->remote_port = remote_port;
860 ps->remote_udp->remote_ip = strdup(remote_ip);
861 if (!ps->remote_udp->remote_ip) {
862 silc_packet_stream_destroy(ps);
867 /* Inject packet to the new stream */
869 silc_packet_stream_ref(ps);
870 silc_schedule_task_add_timeout(silc_stream_get_schedule(stream->stream),
871 silc_packet_stream_inject_packet, packet,
878 /* Destroy packet stream */
880 void silc_packet_stream_destroy(SilcPacketStream stream)
882 SilcPacketEngine engine;
887 if (silc_atomic_sub_int8(&stream->refcnt, 1) > 0) {
888 if (stream->destroyed)
890 stream->destroyed = TRUE;
892 SILC_LOG_DEBUG(("Marking packet stream %p destroyed", stream));
894 /* Close the underlaying stream */
895 if (!stream->udp && stream->stream)
896 silc_stream_close(stream->stream);
900 SILC_LOG_DEBUG(("Destroying packet stream %p", stream));
903 /* Delete from engine */
905 engine = stream->sc->engine;
906 silc_mutex_lock(engine->lock);
907 silc_list_del(engine->streams, stream);
909 /* Remove per scheduler context, if it is not used anymore */
910 stream->sc->stream_count--;
911 if (!stream->sc->stream_count)
912 silc_hash_table_del(engine->contexts, stream->sc->schedule);
914 silc_mutex_unlock(engine->lock);
917 /* Destroy the underlaying stream */
919 silc_stream_destroy(stream->stream);
921 /* Delete from UDP remote hash table */
923 engine = stream->sc->engine;
924 silc_snprintf(tuple, sizeof(tuple), "%d%s",
925 stream->remote_udp->remote_port,
926 stream->remote_udp->remote_ip);
927 silc_mutex_lock(engine->lock);
928 silc_hash_table_del(engine->udp_remote, tuple);
929 silc_mutex_unlock(engine->lock);
931 silc_free(stream->remote_udp->remote_ip);
932 silc_free(stream->remote_udp);
934 /* Unreference the underlaying packet stream */
935 silc_packet_stream_unref((SilcPacketStream)stream->stream);
938 /* Clear and free buffers */
939 silc_buffer_clear(&stream->outbuf);
940 silc_buffer_purge(&stream->outbuf);
942 if (stream->process) {
944 silc_dlist_start(stream->process);
945 while ((p = silc_dlist_get(stream->process))) {
948 silc_dlist_del(stream->process, p);
950 silc_dlist_uninit(stream->process);
953 /* Destroy ciphers and HMACs */
954 if (stream->send_key[0])
955 silc_cipher_free(stream->send_key[0]);
956 if (stream->receive_key[0])
957 silc_cipher_free(stream->receive_key[0]);
958 if (stream->send_hmac[0])
959 silc_hmac_free(stream->send_hmac[0]);
960 if (stream->receive_hmac[0])
961 silc_hmac_free(stream->receive_hmac[0]);
962 if (stream->send_key[1])
963 silc_cipher_free(stream->send_key[1]);
964 if (stream->receive_key[1])
965 silc_cipher_free(stream->receive_key[1]);
966 if (stream->send_hmac[1])
967 silc_hmac_free(stream->send_hmac[1]);
968 if (stream->receive_hmac[1])
969 silc_hmac_free(stream->receive_hmac[1]);
972 silc_free(stream->src_id);
973 silc_free(stream->dst_id);
975 silc_atomic_uninit8(&stream->refcnt);
976 silc_mutex_free(stream->lock);
980 /* Return TRUE if the stream is valid */
982 SilcBool silc_packet_stream_is_valid(SilcPacketStream stream)
984 return stream->destroyed == FALSE;
987 /* Marks as router stream */
989 void silc_packet_stream_set_router(SilcPacketStream stream)
991 stream->is_router = TRUE;
994 /* Mark to include IV in ciphertext */
996 void silc_packet_stream_set_iv_included(SilcPacketStream stream)
998 stream->iv_included = TRUE;
1001 /* Links `callbacks' to `stream' for specified packet types */
1003 static SilcBool silc_packet_stream_link_va(SilcPacketStream stream,
1004 const SilcPacketCallbacks *callbacks,
1005 void *callback_context,
1006 int priority, va_list ap)
1008 SilcPacketProcess p, e;
1009 SilcInt32 packet_type;
1012 SILC_LOG_DEBUG(("Linking callbacks %p to stream %p", callbacks, stream));
1016 if (!callbacks->packet_receive)
1019 p = silc_calloc(1, sizeof(*p));
1023 p->priority = priority;
1024 p->callbacks = callbacks;
1025 p->callback_context = callback_context;
1027 silc_mutex_lock(stream->lock);
1029 if (!stream->process) {
1030 stream->process = silc_dlist_init();
1031 if (!stream->process) {
1032 silc_mutex_unlock(stream->lock);
1037 /* According to priority set the procesor to correct position. First
1038 entry has the highest priority */
1039 silc_dlist_start(stream->process);
1040 while ((e = silc_dlist_get(stream->process)) != SILC_LIST_END) {
1041 if (p->priority > e->priority) {
1042 silc_dlist_insert(stream->process, p);
1047 silc_dlist_add(stream->process, p);
1049 /* Get packet types to process */
1052 packet_type = va_arg(ap, SilcInt32);
1054 if (packet_type == SILC_PACKET_ANY)
1057 if (packet_type == -1)
1060 p->types = silc_realloc(p->types, sizeof(*p->types) * (i + 1));
1062 silc_mutex_unlock(stream->lock);
1066 p->types[i - 1] = (SilcPacketType)packet_type;
1070 p->types[i - 1] = 0;
1072 silc_mutex_unlock(stream->lock);
1074 silc_packet_stream_ref(stream);
1079 /* Links `callbacks' to `stream' for specified packet types */
1081 SilcBool silc_packet_stream_link(SilcPacketStream stream,
1082 const SilcPacketCallbacks *callbacks,
1083 void *callback_context,
1089 va_start(ap, priority);
1090 ret = silc_packet_stream_link_va(stream, callbacks, callback_context,
1097 /* Unlinks `callbacks' from `stream'. */
1099 void silc_packet_stream_unlink(SilcPacketStream stream,
1100 const SilcPacketCallbacks *callbacks,
1101 void *callback_context)
1103 SilcPacketProcess p;
1105 SILC_LOG_DEBUG(("Unlinking callbacks %p from stream %p",
1106 callbacks, stream));
1108 silc_mutex_lock(stream->lock);
1110 silc_dlist_start(stream->process);
1111 while ((p = silc_dlist_get(stream->process)) != SILC_LIST_END)
1112 if (p->callbacks == callbacks &&
1113 p->callback_context == callback_context) {
1114 silc_dlist_del(stream->process, p);
1115 silc_free(p->types);
1120 if (!silc_dlist_count(stream->process)) {
1121 silc_dlist_uninit(stream->process);
1122 stream->process = NULL;
1125 silc_mutex_unlock(stream->lock);
1127 silc_packet_stream_unref(stream);
1130 /* Returns TRUE if stream is UDP stream */
1132 SilcBool silc_packet_stream_is_udp(SilcPacketStream stream)
1134 return stream->udp || silc_socket_stream_is_udp(stream->stream, NULL);
1137 /* Return packet sender IP and port for UDP packet stream */
1139 SilcBool silc_packet_get_sender(SilcPacket packet,
1140 const char **sender_ip,
1141 SilcUInt16 *sender_port)
1143 if (!packet->stream->remote_udp)
1146 *sender_ip = packet->stream->remote_udp->remote_ip;
1147 *sender_port = packet->stream->remote_udp->remote_port;
1152 /* Reference packet stream */
1154 void silc_packet_stream_ref(SilcPacketStream stream)
1156 silc_atomic_add_int8(&stream->refcnt, 1);
1157 SILC_LOG_DEBUG(("Stream %p, refcnt %d->%d", stream,
1158 silc_atomic_get_int8(&stream->refcnt) - 1,
1159 silc_atomic_get_int8(&stream->refcnt)));
1162 /* Unreference packet stream */
1164 void silc_packet_stream_unref(SilcPacketStream stream)
1166 SILC_LOG_DEBUG(("Stream %p, refcnt %d->%d", stream,
1167 silc_atomic_get_int8(&stream->refcnt),
1168 silc_atomic_get_int8(&stream->refcnt) - 1));
1169 if (silc_atomic_sub_int8(&stream->refcnt, 1) > 0)
1171 silc_atomic_add_int8(&stream->refcnt, 1);
1172 silc_packet_stream_destroy(stream);
1177 SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream)
1179 return stream->sc->engine;
1182 /* Set application context for packet stream */
1184 void silc_packet_set_context(SilcPacketStream stream, void *stream_context)
1186 silc_mutex_lock(stream->lock);
1187 stream->stream_context = stream_context;
1188 silc_mutex_unlock(stream->lock);
1191 /* Return application context from packet stream */
1193 void *silc_packet_get_context(SilcPacketStream stream)
1196 silc_mutex_lock(stream->lock);
1197 context = stream->stream_context;
1198 silc_mutex_unlock(stream->lock);
1202 /* Change underlaying stream */
1204 void silc_packet_stream_set_stream(SilcPacketStream ps,
1208 silc_stream_set_notifier(ps->stream, ps->sc->schedule, NULL, NULL);
1209 ps->stream = stream;
1210 silc_stream_set_notifier(ps->stream, ps->sc->schedule, silc_packet_stream_io,
1214 /* Return underlaying stream */
1216 SilcStream silc_packet_stream_get_stream(SilcPacketStream stream)
1218 return stream->stream;
1223 SilcBool silc_packet_set_keys(SilcPacketStream stream, SilcCipher send_key,
1224 SilcCipher receive_key, SilcHmac send_hmac,
1225 SilcHmac receive_hmac, SilcBool rekey)
1227 SILC_LOG_DEBUG(("Setting new keys to packet stream %p", stream));
1229 /* If doing rekey, send REKEY_DONE packet */
1231 /* This will take stream lock. */
1232 if (!silc_packet_send_raw(stream, SILC_PACKET_REKEY_DONE, 0,
1233 stream->src_id_type, stream->src_id,
1234 stream->src_id_len, stream->dst_id_type,
1235 stream->dst_id, stream->dst_id_len,
1236 NULL, 0, stream->send_key[0],
1237 stream->send_hmac[0]))
1240 /* Write the packet to the stream */
1241 if (!silc_packet_stream_write(stream, TRUE))
1244 silc_mutex_lock(stream->lock);
1247 /* In case IV Included is set, save the old keys */
1248 if (stream->iv_included) {
1249 if (stream->send_key[1] && send_key) {
1250 silc_cipher_free(stream->send_key[1]);
1251 stream->send_key[1] = stream->send_key[0];
1253 if (stream->receive_key[1] && receive_key) {
1254 silc_cipher_free(stream->receive_key[1]);
1255 stream->receive_key[1] = stream->receive_key[0];
1257 if (stream->send_hmac[1] && send_hmac) {
1258 silc_hmac_free(stream->send_hmac[1]);
1259 stream->send_hmac[1] = stream->send_hmac[0];
1261 if (stream->receive_hmac[1] && receive_hmac) {
1262 silc_hmac_free(stream->receive_hmac[1]);
1263 stream->receive_hmac[1] = stream->receive_hmac[0];
1266 if (stream->send_key[0] && send_key)
1267 silc_cipher_free(stream->send_key[0]);
1268 if (stream->receive_key[0] && receive_key)
1269 silc_cipher_free(stream->receive_key[0]);
1270 if (stream->send_hmac[0] && send_hmac)
1271 silc_hmac_free(stream->send_hmac[0]);
1272 if (stream->receive_hmac[0] && receive_hmac)
1273 silc_hmac_free(stream->receive_hmac[0]);
1278 stream->send_key[0] = send_key;
1280 stream->receive_key[0] = receive_key;
1282 stream->send_hmac[0] = send_hmac;
1284 stream->receive_hmac[0] = receive_hmac;
1286 silc_mutex_unlock(stream->lock);
1290 /* Return current ciphers from packet stream */
1292 SilcBool silc_packet_get_keys(SilcPacketStream stream,
1293 SilcCipher *send_key,
1294 SilcCipher *receive_key,
1295 SilcHmac *send_hmac,
1296 SilcHmac *receive_hmac)
1298 if (!stream->send_key[0] && !stream->receive_key[0] &&
1299 !stream->send_hmac[0] && !stream->receive_hmac[0])
1302 silc_mutex_lock(stream->lock);
1305 *send_key = stream->send_key[0];
1307 *receive_key = stream->receive_key[0];
1309 *send_hmac = stream->send_hmac[0];
1311 *receive_hmac = stream->receive_hmac[0];
1313 silc_mutex_unlock(stream->lock);
1318 /* Set SILC IDs to packet stream */
1320 SilcBool silc_packet_set_ids(SilcPacketStream stream,
1321 SilcIdType src_id_type, const void *src_id,
1322 SilcIdType dst_id_type, const void *dst_id)
1325 unsigned char tmp[32];
1327 if (!src_id && !dst_id)
1330 silc_mutex_lock(stream->lock);
1333 SILC_LOG_DEBUG(("Setting source ID to packet stream %p", stream));
1335 silc_free(stream->src_id);
1336 if (!silc_id_id2str(src_id, src_id_type, tmp, sizeof(tmp), &len)) {
1337 silc_mutex_unlock(stream->lock);
1340 stream->src_id = silc_memdup(tmp, len);
1341 if (!stream->src_id) {
1342 silc_mutex_unlock(stream->lock);
1345 stream->src_id_type = src_id_type;
1346 stream->src_id_len = len;
1350 SILC_LOG_DEBUG(("Setting destination ID to packet stream %p", stream));
1352 silc_free(stream->dst_id);
1353 if (!silc_id_id2str(dst_id, dst_id_type, tmp, sizeof(tmp), &len)) {
1354 silc_mutex_unlock(stream->lock);
1357 stream->dst_id = silc_memdup(tmp, len);
1358 if (!stream->dst_id) {
1359 silc_mutex_unlock(stream->lock);
1362 stream->dst_id_type = dst_id_type;
1363 stream->dst_id_len = len;
1366 silc_mutex_unlock(stream->lock);
1371 /* Return IDs from the packet stream */
1373 SilcBool silc_packet_get_ids(SilcPacketStream stream,
1374 SilcBool *src_id_set, SilcID *src_id,
1375 SilcBool *dst_id_set, SilcID *dst_id)
1377 if (src_id && stream->src_id)
1378 if (!silc_id_str2id2(stream->src_id, stream->src_id_len,
1379 stream->src_id_type, src_id))
1382 if (stream->src_id && src_id_set)
1385 if (dst_id && stream->dst_id)
1386 if (!silc_id_str2id2(stream->dst_id, stream->dst_id_len,
1387 stream->dst_id_type, dst_id))
1390 if (stream->dst_id && dst_id_set)
1396 /* Adds Security ID (SID) */
1398 SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid)
1400 if (!stream->iv_included)
1403 SILC_LOG_DEBUG(("Set packet stream %p SID to %d", stream, sid));
1411 void silc_packet_free(SilcPacket packet)
1413 SilcPacketStream stream = packet->stream;
1415 SILC_LOG_DEBUG(("Freeing packet %p", packet));
1417 /* Check for double free */
1418 SILC_ASSERT(packet->stream != NULL);
1420 packet->stream = NULL;
1421 packet->src_id = packet->dst_id = NULL;
1422 silc_buffer_reset(&packet->buffer);
1424 silc_mutex_lock(stream->sc->engine->lock);
1426 /* Put the packet back to freelist */
1427 silc_list_add(stream->sc->engine->packet_pool, packet);
1428 if (silc_list_count(stream->sc->engine->packet_pool) == 1)
1429 silc_list_start(stream->sc->engine->packet_pool);
1431 silc_mutex_unlock(stream->sc->engine->lock);
1434 /****************************** Packet Sending ******************************/
1436 /* Prepare outgoing data buffer for packet sending. Returns the
1437 pointer to that buffer into the `packet'. */
1439 static inline SilcBool silc_packet_send_prepare(SilcPacketStream stream,
1444 unsigned char *oldptr;
1445 unsigned int mac_len = hmac ? silc_hmac_len(hmac) : 0;
1449 /* Allocate more space if needed */
1450 if (silc_unlikely(silc_buffer_taillen(&stream->outbuf) < totlen)) {
1451 if (!silc_buffer_realloc(&stream->outbuf,
1452 silc_buffer_truelen(&stream->outbuf) + totlen))
1456 /* Pull data area for the new packet, and return pointer to the start of
1457 the data area and save the pointer in to the `packet'. MAC is pulled
1458 later after it's computed. */
1459 oldptr = silc_buffer_pull_tail(&stream->outbuf, totlen);
1460 silc_buffer_set(packet, oldptr, totlen);
1461 silc_buffer_push_tail(packet, mac_len);
1466 /* Increments counter when encrypting in counter mode. */
1468 static inline void silc_packet_send_ctr_increment(SilcPacketStream stream,
1470 unsigned char *ret_iv)
1472 unsigned char *iv = silc_cipher_get_iv(cipher);
1473 SilcUInt32 pc1, pc2;
1475 /* Reset block counter */
1476 memset(iv + 12, 0, 4);
1478 /* If IV Included flag, return the 64-bit IV for inclusion in packet */
1479 if (stream->iv_included) {
1481 ret_iv[0] = silc_rng_get_byte_fast(stream->sc->engine->rng);
1482 ret_iv[1] = ret_iv[0] + iv[4];
1483 ret_iv[2] = ret_iv[0] ^ ret_iv[1];
1484 ret_iv[3] = ret_iv[0] + ret_iv[2];
1486 /* Increment 32-bit packet counter */
1487 SILC_GET32_MSB(pc1, iv + 8);
1489 SILC_PUT32_MSB(pc1, ret_iv + 4);
1491 SILC_LOG_HEXDUMP(("IV"), ret_iv, 8);
1493 /* Set new nonce to counter block */
1494 memcpy(iv + 4, ret_iv, 8);
1496 /* Increment 64-bit packet counter */
1497 SILC_GET32_MSB(pc1, iv + 4);
1498 SILC_GET32_MSB(pc2, iv + 8);
1501 SILC_PUT32_MSB(pc1, iv + 4);
1502 SILC_PUT32_MSB(pc2, iv + 8);
1505 SILC_LOG_HEXDUMP(("Counter Block"), iv, 16);
1508 /* Internal routine to assemble outgoing packet. Assembles and encryptes
1509 the packet. The silc_packet_stream_write needs to be called to send it
1510 after this returns TRUE. */
1512 static inline SilcBool silc_packet_send_raw(SilcPacketStream stream,
1513 SilcPacketType type,
1514 SilcPacketFlags flags,
1515 SilcIdType src_id_type,
1516 unsigned char *src_id,
1517 SilcUInt32 src_id_len,
1518 SilcIdType dst_id_type,
1519 unsigned char *dst_id,
1520 SilcUInt32 dst_id_len,
1521 const unsigned char *data,
1522 SilcUInt32 data_len,
1526 unsigned char tmppad[SILC_PACKET_MAX_PADLEN], iv[33], psn[4];
1527 int block_len = (cipher ? silc_cipher_get_block_len(cipher) : 0);
1528 int i, enclen, truelen, padlen = 0, ivlen = 0, psnlen = 0;
1530 SilcBufferStruct packet;
1532 SILC_LOG_DEBUG(("Sending packet %s (%d) flags %d, src %d dst %d, "
1533 "data len %d", silc_get_packet_name(type), stream->send_psn,
1534 flags, src_id_type, dst_id_type, data_len));
1536 /* Get the true length of the packet. This is saved as payload length
1537 into the packet header. This does not include the length of the
1539 data_len = SILC_PACKET_DATALEN(data_len, (SILC_PACKET_HEADER_LEN +
1540 src_id_len + dst_id_len));
1541 enclen = truelen = (data_len + SILC_PACKET_HEADER_LEN +
1542 src_id_len + dst_id_len);
1544 /* If using CTR mode, increment the counter */
1545 ctr = (cipher && silc_cipher_get_mode(cipher) == SILC_CIPHER_MODE_CTR);
1547 silc_packet_send_ctr_increment(stream, cipher, iv + 1);
1549 /* If IV is included, the SID, IV and sequence number is added to packet */
1550 if (stream->iv_included && cipher) {
1551 psnlen = sizeof(psn);
1553 iv[0] = stream->sid;
1556 /* If IV is included, the SID, IV and sequence number is added to packet */
1557 if (stream->iv_included && cipher) {
1558 psnlen = sizeof(psn);
1559 ivlen = block_len + 1;
1560 iv[0] = stream->sid;
1561 memcpy(iv + 1, silc_cipher_get_iv(cipher), block_len);
1565 /* We automatically figure out the packet structure from the packet
1566 type and flags, and calculate correct length. Private messages with
1567 private keys and channel messages are special packets as their
1568 payload is encrypted already. */
1569 if (type == SILC_PACKET_PRIVATE_MESSAGE &&
1570 flags & SILC_PACKET_FLAG_PRIVMSG_KEY) {
1571 /* Padding is calculated from header + IDs */
1573 SILC_PACKET_PADLEN((SILC_PACKET_HEADER_LEN + src_id_len + dst_id_len +
1574 psnlen), block_len, padlen);
1576 /* Length to encrypt, header + IDs + padding. */
1577 enclen = (SILC_PACKET_HEADER_LEN + src_id_len + dst_id_len +
1580 } else if (type == SILC_PACKET_CHANNEL_MESSAGE) {
1581 if (stream->sc->engine->local_is_router && stream->is_router) {
1582 /* Channel messages between routers are encrypted as normal packets.
1583 Padding is calculated from true length of the packet. */
1585 SILC_PACKET_PADLEN(truelen + psnlen, block_len, padlen);
1587 enclen += padlen + psnlen;
1589 /* Padding is calculated from header + IDs */
1591 SILC_PACKET_PADLEN((SILC_PACKET_HEADER_LEN + src_id_len + dst_id_len +
1592 psnlen), block_len, padlen);
1594 /* Length to encrypt, header + IDs + padding. */
1595 enclen = (SILC_PACKET_HEADER_LEN + src_id_len + dst_id_len +
1599 /* Padding is calculated from true length of the packet */
1600 if (flags & SILC_PACKET_FLAG_LONG_PAD)
1601 SILC_PACKET_PADLEN_MAX(truelen + psnlen, block_len, padlen);
1603 SILC_PACKET_PADLEN(truelen + psnlen, block_len, padlen);
1605 enclen += padlen + psnlen;
1608 /* Remove implementation specific flags */
1609 flags &= ~(SILC_PACKET_FLAG_LONG_PAD);
1611 /* Get random padding */
1612 for (i = 0; i < padlen; i++) tmppad[i] =
1613 silc_rng_get_byte_fast(stream->sc->engine->rng);
1615 silc_mutex_lock(stream->lock);
1617 /* Get packet pointer from the outgoing buffer */
1618 if (silc_unlikely(!silc_packet_send_prepare(stream, truelen + padlen + ivlen
1619 + psnlen, hmac, &packet))) {
1620 silc_mutex_unlock(stream->lock);
1624 SILC_PUT32_MSB(stream->send_psn, psn);
1626 /* Create the packet. This creates the SILC header, adds padding, and
1627 the actual packet data. */
1628 i = silc_buffer_format(&packet,
1629 SILC_STR_DATA(iv, ivlen),
1630 SILC_STR_DATA(psn, psnlen),
1631 SILC_STR_UI_SHORT(truelen),
1632 SILC_STR_UI_CHAR(flags),
1633 SILC_STR_UI_CHAR(type),
1634 SILC_STR_UI_CHAR(padlen),
1635 SILC_STR_UI_CHAR(0),
1636 SILC_STR_UI_CHAR(src_id_len),
1637 SILC_STR_UI_CHAR(dst_id_len),
1638 SILC_STR_UI_CHAR(src_id_type),
1639 SILC_STR_DATA(src_id, src_id_len),
1640 SILC_STR_UI_CHAR(dst_id_type),
1641 SILC_STR_DATA(dst_id, dst_id_len),
1642 SILC_STR_DATA(tmppad, padlen),
1643 SILC_STR_DATA(data, data_len),
1645 if (silc_unlikely(i < 0)) {
1646 silc_mutex_unlock(stream->lock);
1650 SILC_LOG_HEXDUMP(("Assembled packet, len %d", silc_buffer_len(&packet)),
1651 silc_buffer_data(&packet), silc_buffer_len(&packet));
1653 /* Encrypt the packet */
1654 if (silc_likely(cipher)) {
1655 SILC_LOG_DEBUG(("Encrypting packet"));
1656 silc_cipher_set_iv(cipher, NULL);
1657 if (silc_unlikely(!silc_cipher_encrypt(cipher, packet.data + ivlen,
1658 packet.data + ivlen, enclen,
1660 SILC_LOG_ERROR(("Packet encryption failed"));
1661 silc_mutex_unlock(stream->lock);
1667 if (silc_likely(hmac)) {
1670 /* MAC is computed from the entire encrypted packet data, and put
1671 to the end of the packet. */
1672 silc_hmac_init(hmac);
1673 silc_hmac_update(hmac, psn, sizeof(psn));
1674 silc_hmac_update(hmac, packet.data, silc_buffer_len(&packet));
1675 silc_hmac_final(hmac, packet.tail, &mac_len);
1676 silc_buffer_pull_tail(&packet, mac_len);
1683 /* Sends a packet */
1685 SilcBool silc_packet_send(SilcPacketStream stream,
1686 SilcPacketType type, SilcPacketFlags flags,
1687 const unsigned char *data, SilcUInt32 data_len)
1691 ret = silc_packet_send_raw(stream, type, flags,
1692 stream->src_id_type,
1695 stream->dst_id_type,
1699 stream->send_key[0],
1700 stream->send_hmac[0]);
1702 /* Write the packet to the stream */
1703 return ret ? silc_packet_stream_write(stream, FALSE) : FALSE;
1706 /* Sends a packet, extended routine */
1708 SilcBool silc_packet_send_ext(SilcPacketStream stream,
1709 SilcPacketType type, SilcPacketFlags flags,
1710 SilcIdType src_id_type, void *src_id,
1711 SilcIdType dst_id_type, void *dst_id,
1712 const unsigned char *data, SilcUInt32 data_len,
1713 SilcCipher cipher, SilcHmac hmac)
1715 unsigned char src_id_data[32], dst_id_data[32];
1716 SilcUInt32 src_id_len, dst_id_len;
1720 if (!silc_id_id2str(src_id, src_id_type, src_id_data,
1721 sizeof(src_id_data), &src_id_len))
1724 if (!silc_id_id2str(dst_id, dst_id_type, dst_id_data,
1725 sizeof(dst_id_data), &dst_id_len))
1728 ret = silc_packet_send_raw(stream, type, flags,
1729 src_id ? src_id_type : stream->src_id_type,
1730 src_id ? src_id_data : stream->src_id,
1731 src_id ? src_id_len : stream->src_id_len,
1732 dst_id ? dst_id_type : stream->dst_id_type,
1733 dst_id ? dst_id_data : stream->dst_id,
1734 dst_id ? dst_id_len : stream->dst_id_len,
1736 cipher ? cipher : stream->send_key[0],
1737 hmac ? hmac : stream->send_hmac[0]);
1739 /* Write the packet to the stream */
1740 return ret ? silc_packet_stream_write(stream, FALSE) : FALSE;
1743 /* Sends packet after formatting the arguments to buffer */
1745 SilcBool silc_packet_send_va(SilcPacketStream stream,
1746 SilcPacketType type, SilcPacketFlags flags, ...)
1748 SilcBufferStruct buf;
1752 va_start(va, flags);
1754 memset(&buf, 0, sizeof(buf));
1755 if (silc_buffer_format_vp(&buf, va) < 0) {
1760 ret = silc_packet_send(stream, type, flags, silc_buffer_data(&buf),
1761 silc_buffer_len(&buf));
1763 silc_buffer_purge(&buf);
1769 /* Sends packet after formatting the arguments to buffer, extended routine */
1771 SilcBool silc_packet_send_va_ext(SilcPacketStream stream,
1772 SilcPacketType type, SilcPacketFlags flags,
1773 SilcIdType src_id_type, void *src_id,
1774 SilcIdType dst_id_type, void *dst_id,
1775 SilcCipher cipher, SilcHmac hmac, ...)
1777 SilcBufferStruct buf;
1783 memset(&buf, 0, sizeof(buf));
1784 if (silc_buffer_format_vp(&buf, va) < 0) {
1789 ret = silc_packet_send_ext(stream, type, flags, src_id_type, src_id,
1790 dst_id_type, dst_id, silc_buffer_data(&buf),
1791 silc_buffer_len(&buf), cipher, hmac);
1793 silc_buffer_purge(&buf);
1799 /***************************** Packet Receiving *****************************/
1801 /* Checks MAC in the packet. Returns TRUE if MAC is Ok. */
1803 static inline SilcBool silc_packet_check_mac(SilcHmac hmac,
1804 const unsigned char *data,
1805 SilcUInt32 data_len,
1806 const unsigned char *packet_mac,
1807 const unsigned char *packet_seq,
1808 SilcUInt32 sequence)
1811 if (silc_likely(hmac)) {
1812 unsigned char mac[32], psn[4];
1815 SILC_LOG_DEBUG(("Verifying MAC"));
1817 /* Compute HMAC of packet */
1818 silc_hmac_init(hmac);
1821 SILC_PUT32_MSB(sequence, psn);
1822 silc_hmac_update(hmac, psn, 4);
1824 silc_hmac_update(hmac, packet_seq, 4);
1826 silc_hmac_update(hmac, data, data_len);
1827 silc_hmac_final(hmac, mac, &mac_len);
1829 /* Compare the MAC's */
1830 if (silc_unlikely(memcmp(packet_mac, mac, mac_len))) {
1831 SILC_LOG_DEBUG(("MAC failed"));
1835 SILC_LOG_DEBUG(("MAC is Ok"));
1841 /* Increments/sets counter when decrypting in counter mode. */
1843 static inline void silc_packet_receive_ctr_increment(SilcPacketStream stream,
1845 unsigned char *packet_iv)
1847 SilcUInt32 pc1, pc2;
1849 /* If IV Included flag, set the IV from packet to block counter. */
1850 if (stream->iv_included) {
1851 memcpy(iv + 4, packet_iv, 8);
1853 /* Increment 64-bit packet counter. */
1854 SILC_GET32_MSB(pc1, iv + 4);
1855 SILC_GET32_MSB(pc2, iv + 8);
1858 SILC_PUT32_MSB(pc1, iv + 4);
1859 SILC_PUT32_MSB(pc2, iv + 8);
1862 /* Reset block counter */
1863 memset(iv + 12, 0, 4);
1865 SILC_LOG_HEXDUMP(("Counter Block"), iv, 16);
1868 /* Decrypts SILC packet. Handles both normal and special packet decryption.
1869 Return 0 when packet is normal and 1 when it it special, -1 on error. */
1871 static inline int silc_packet_decrypt(SilcCipher cipher, SilcHmac hmac,
1872 SilcUInt32 sequence, SilcBuffer buffer,
1875 if (normal == TRUE) {
1876 if (silc_likely(cipher)) {
1877 /* Decrypt rest of the packet */
1878 SILC_LOG_DEBUG(("Decrypting the packet"));
1879 if (silc_unlikely(!silc_cipher_decrypt(cipher, buffer->data,
1881 silc_buffer_len(buffer), NULL)))
1887 /* Decrypt rest of the header plus padding */
1888 if (silc_likely(cipher)) {
1890 SilcUInt32 block_len = silc_cipher_get_block_len(cipher);
1892 SILC_LOG_DEBUG(("Decrypting the header"));
1894 /* Padding length + src id len + dst id len + header length - 16
1895 bytes already decrypted, gives the rest of the encrypted packet */
1896 silc_buffer_push(buffer, block_len);
1897 len = (((SilcUInt8)buffer->data[4] + (SilcUInt8)buffer->data[6] +
1898 (SilcUInt8)buffer->data[7] + SILC_PACKET_HEADER_LEN) -
1900 silc_buffer_pull(buffer, block_len);
1902 if (silc_unlikely(len > silc_buffer_len(buffer))) {
1903 SILC_LOG_ERROR(("Garbage in header of packet, bad packet length, "
1907 if (silc_unlikely(!silc_cipher_decrypt(cipher, buffer->data,
1908 buffer->data, len, NULL)))
1916 /* Parses the packet. This is called when a whole packet is ready to be
1917 parsed. The buffer sent must be already decrypted before calling this
1920 static inline SilcBool silc_packet_parse(SilcPacket packet)
1922 SilcBuffer buffer = &packet->buffer;
1923 SilcUInt8 padlen = (SilcUInt8)buffer->data[4];
1924 SilcUInt8 src_id_len, dst_id_len, src_id_type, dst_id_type;
1927 SILC_LOG_DEBUG(("Parsing incoming packet"));
1929 /* Parse the buffer. This parses the SILC header of the packet. */
1930 ret = silc_buffer_unformat(buffer,
1933 SILC_STR_UI_CHAR(&src_id_len),
1934 SILC_STR_UI_CHAR(&dst_id_len),
1935 SILC_STR_UI_CHAR(&src_id_type),
1937 if (silc_unlikely(ret == -1)) {
1938 if (!packet->stream->udp &&
1939 !silc_socket_stream_is_udp(packet->stream->stream, NULL))
1940 SILC_LOG_ERROR(("Malformed packet header, packet dropped"));
1944 if (silc_unlikely(src_id_len > SILC_PACKET_MAX_ID_LEN ||
1945 dst_id_len > SILC_PACKET_MAX_ID_LEN)) {
1946 if (!packet->stream->udp &&
1947 !silc_socket_stream_is_udp(packet->stream->stream, NULL))
1948 SILC_LOG_ERROR(("Bad ID lengths in packet (%d and %d)",
1949 packet->src_id_len, packet->dst_id_len));
1953 ret = silc_buffer_unformat(buffer,
1955 SILC_STR_DATA(&packet->src_id, src_id_len),
1956 SILC_STR_UI_CHAR(&dst_id_type),
1957 SILC_STR_DATA(&packet->dst_id, dst_id_len),
1958 SILC_STR_OFFSET(padlen),
1960 if (silc_unlikely(ret == -1)) {
1961 if (!packet->stream->udp &&
1962 !silc_socket_stream_is_udp(packet->stream->stream, NULL))
1963 SILC_LOG_ERROR(("Malformed packet header, packet dropped"));
1967 if (silc_unlikely(src_id_type > SILC_ID_CHANNEL ||
1968 dst_id_type > SILC_ID_CHANNEL)) {
1969 if (!packet->stream->udp &&
1970 !silc_socket_stream_is_udp(packet->stream->stream, NULL))
1971 SILC_LOG_ERROR(("Bad ID types in packet (%d and %d)",
1972 src_id_type, dst_id_type));
1976 packet->src_id_len = src_id_len;
1977 packet->dst_id_len = dst_id_len;
1978 packet->src_id_type = src_id_type;
1979 packet->dst_id_type = dst_id_type;
1981 SILC_LOG_HEXDUMP(("Parsed packet, len %d", silc_buffer_headlen(buffer) +
1982 silc_buffer_len(buffer)), buffer->head,
1983 silc_buffer_headlen(buffer) + silc_buffer_len(buffer));
1985 SILC_LOG_DEBUG(("Incoming packet type: %d (%s), flags %d", packet->type,
1986 silc_get_packet_name(packet->type), packet->flags));
1991 /* Dispatch packet to application. Called with stream->lock locked.
1992 Returns FALSE if the stream was destroyed while dispatching a packet. */
1994 static SilcBool silc_packet_dispatch(SilcPacket packet)
1996 SilcPacketStream stream = packet->stream;
1997 SilcPacketProcess p;
1998 SilcBool default_sent = FALSE;
2001 /* Dispatch packet to all packet processors that want it */
2003 if (silc_likely(!stream->process)) {
2004 /* Send to default processor as no others exist */
2005 SILC_LOG_DEBUG(("Dispatching packet to default callbacks"));
2006 silc_mutex_unlock(stream->lock);
2007 if (silc_unlikely(!stream->sc->engine->callbacks->
2008 packet_receive(stream->sc->engine, stream, packet,
2009 stream->sc->engine->callback_context,
2010 stream->stream_context)))
2011 silc_packet_free(packet);
2012 silc_mutex_lock(stream->lock);
2013 return stream->destroyed == FALSE;
2016 silc_dlist_start(stream->process);
2017 while ((p = silc_dlist_get(stream->process)) != SILC_LIST_END) {
2019 /* If priority is 0 or less, we send to default processor first
2020 because default processor has 0 priority */
2021 if (!default_sent && p->priority <= 0) {
2022 SILC_LOG_DEBUG(("Dispatching packet to default callbacks"));
2023 default_sent = TRUE;
2024 silc_mutex_unlock(stream->lock);
2025 if (stream->sc->engine->callbacks->
2026 packet_receive(stream->sc->engine, stream, packet,
2027 stream->sc->engine->callback_context,
2028 stream->stream_context)) {
2029 silc_mutex_lock(stream->lock);
2030 return stream->destroyed == FALSE;
2032 silc_mutex_lock(stream->lock);
2035 /* Send to processor */
2037 /* Send all packet types */
2038 SILC_LOG_DEBUG(("Dispatching packet to %p callbacks", p->callbacks));
2039 silc_mutex_unlock(stream->lock);
2040 if (p->callbacks->packet_receive(stream->sc->engine, stream, packet,
2041 p->callback_context,
2042 stream->stream_context)) {
2043 silc_mutex_lock(stream->lock);
2044 return stream->destroyed == FALSE;
2046 silc_mutex_lock(stream->lock);
2048 /* Send specific types */
2049 for (pt = p->types; *pt; pt++) {
2050 if (*pt != packet->type)
2052 SILC_LOG_DEBUG(("Dispatching packet to %p callbacks", p->callbacks));
2053 silc_mutex_unlock(stream->lock);
2054 if (p->callbacks->packet_receive(stream->sc->engine, stream, packet,
2055 p->callback_context,
2056 stream->stream_context)) {
2057 silc_mutex_lock(stream->lock);
2058 return stream->destroyed == FALSE;
2060 silc_mutex_lock(stream->lock);
2066 if (!default_sent) {
2067 /* Send to default processor as it has not been sent yet */
2068 SILC_LOG_DEBUG(("Dispatching packet to default callbacks"));
2069 silc_mutex_unlock(stream->lock);
2070 if (stream->sc->engine->callbacks->
2071 packet_receive(stream->sc->engine, stream, packet,
2072 stream->sc->engine->callback_context,
2073 stream->stream_context)) {
2074 silc_mutex_lock(stream->lock);
2075 return stream->destroyed == FALSE;
2077 silc_mutex_lock(stream->lock);
2080 /* If we got here, no one wanted the packet, so drop it */
2081 silc_packet_free(packet);
2082 return stream->destroyed == FALSE;
2085 /* Process incoming data and parse packets. Called with stream->lock
2088 static void silc_packet_read_process(SilcPacketStream stream)
2095 SilcUInt16 packetlen;
2096 SilcUInt32 paddedlen, mac_len, block_len, ivlen, psnlen;
2097 unsigned char tmp[SILC_PACKET_MIN_HEADER_LEN], *header;
2098 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE], *packet_seq = NULL;
2102 /* Get inbuf. If there is already some data for this stream in the buffer
2103 we already have it. Otherwise get the current one from list, it will
2104 include the data. */
2105 inbuf = stream->inbuf;
2107 silc_dlist_start(stream->sc->inbufs);
2108 inbuf = silc_dlist_get(stream->sc->inbufs);
2111 /* Parse the packets from the data */
2112 while (silc_buffer_len(inbuf) > 0) {
2114 cipher = stream->receive_key[0];
2115 hmac = stream->receive_hmac[0];
2118 if (silc_unlikely(silc_buffer_len(inbuf) <
2119 (stream->iv_included ? SILC_PACKET_MIN_HEADER_LEN_IV :
2120 SILC_PACKET_MIN_HEADER_LEN))) {
2121 SILC_LOG_DEBUG(("Partial packet in queue, waiting for the rest"));
2122 silc_dlist_del(stream->sc->inbufs, inbuf);
2123 stream->inbuf = inbuf;
2127 if (silc_likely(hmac))
2128 mac_len = silc_hmac_len(hmac);
2132 /* Decrypt first block of the packet to get the length field out */
2133 if (silc_likely(cipher)) {
2134 block_len = silc_cipher_get_block_len(cipher);
2136 if (stream->iv_included) {
2137 /* SID, IV and sequence number is included in the ciphertext */
2138 sid = (SilcUInt8)inbuf->data[0];
2140 if (silc_cipher_get_mode(cipher) == SILC_CIPHER_MODE_CTR) {
2141 /* Set the CTR mode IV from packet to counter block */
2142 memcpy(iv, silc_cipher_get_iv(cipher), block_len);
2143 silc_packet_receive_ctr_increment(stream, iv, inbuf->data + 1);
2146 /* Get IV from packet */
2147 memcpy(iv, inbuf->data + 1, block_len);
2148 ivlen = block_len + 1;
2152 /* Check SID, and get correct decryption key */
2153 if (sid != stream->sid) {
2154 /* If SID is recent get the previous key and use it */
2155 if (sid > 0 && stream->sid > 0 && stream->sid - 1 == sid &&
2156 stream->receive_key[1] && !stream->receive_hmac[1]) {
2157 cipher = stream->receive_key[1];
2158 hmac = stream->receive_hmac[1];
2160 /* The SID is unknown, drop rest of the data in buffer */
2161 SILC_LOG_DEBUG(("Unknown Security ID %d in packet, expected %d",
2163 silc_mutex_unlock(stream->lock);
2164 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_UNKNOWN_SID);
2165 silc_mutex_lock(stream->lock);
2170 memcpy(iv, silc_cipher_get_iv(cipher), block_len);
2172 /* If using CTR mode, increment the counter */
2173 if (silc_cipher_get_mode(cipher) == SILC_CIPHER_MODE_CTR)
2174 silc_packet_receive_ctr_increment(stream, iv, NULL);
2177 if (silc_cipher_get_mode(cipher) == SILC_CIPHER_MODE_CTR)
2178 silc_cipher_set_iv(cipher, NULL);
2179 silc_cipher_decrypt(cipher, inbuf->data + ivlen, tmp, block_len, iv);
2182 if (stream->iv_included) {
2183 /* Take sequence number from packet */
2184 packet_seq = header;
2188 /* Unencrypted packet */
2189 block_len = SILC_PACKET_MIN_HEADER_LEN;
2190 header = inbuf->data;
2193 /* Get packet length and full packet length with padding */
2194 SILC_PACKET_LENGTH(header, packetlen, paddedlen);
2197 if (silc_unlikely(packetlen < SILC_PACKET_MIN_LEN)) {
2198 if (!stream->udp && !silc_socket_stream_is_udp(stream->stream, NULL))
2199 SILC_LOG_ERROR(("Received too short packet"));
2200 silc_mutex_unlock(stream->lock);
2201 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_MALFORMED);
2202 silc_mutex_lock(stream->lock);
2203 memset(tmp, 0, sizeof(tmp));
2207 if (silc_buffer_len(inbuf) < paddedlen + ivlen + mac_len) {
2208 SILC_LOG_DEBUG(("Received partial packet, waiting for the rest "
2210 paddedlen + mac_len - silc_buffer_len(inbuf)));
2211 memset(tmp, 0, sizeof(tmp));
2212 silc_dlist_del(stream->sc->inbufs, inbuf);
2213 stream->inbuf = inbuf;
2217 /* Check MAC of the packet */
2218 if (silc_unlikely(!silc_packet_check_mac(hmac, inbuf->data,
2220 inbuf->data + ivlen +
2221 paddedlen, packet_seq,
2222 stream->receive_psn))) {
2223 silc_mutex_unlock(stream->lock);
2224 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_MAC_FAILED);
2225 silc_mutex_lock(stream->lock);
2226 memset(tmp, 0, sizeof(tmp));
2231 packet = silc_packet_alloc(stream->sc->engine);
2232 if (silc_unlikely(!packet)) {
2233 silc_mutex_unlock(stream->lock);
2234 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_NO_MEMORY);
2235 silc_mutex_lock(stream->lock);
2236 memset(tmp, 0, sizeof(tmp));
2239 packet->stream = stream;
2241 /* Allocate more space to packet buffer, if needed */
2242 if (silc_unlikely(silc_buffer_truelen(&packet->buffer) < paddedlen)) {
2243 if (!silc_buffer_realloc(&packet->buffer,
2244 silc_buffer_truelen(&packet->buffer) +
2246 silc_buffer_truelen(&packet->buffer)))) {
2247 silc_mutex_unlock(stream->lock);
2248 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_NO_MEMORY);
2249 silc_mutex_lock(stream->lock);
2250 silc_packet_free(packet);
2251 memset(tmp, 0, sizeof(tmp));
2256 /* Parse packet header */
2257 packet->flags = (SilcPacketFlags)header[2];
2258 packet->type = (SilcPacketType)header[3];
2260 if (stream->sc->engine->local_is_router) {
2261 if (packet->type == SILC_PACKET_PRIVATE_MESSAGE &&
2262 (packet->flags & SILC_PACKET_FLAG_PRIVMSG_KEY))
2264 else if (packet->type != SILC_PACKET_CHANNEL_MESSAGE ||
2265 (packet->type == SILC_PACKET_CHANNEL_MESSAGE &&
2266 stream->is_router == TRUE))
2269 if (packet->type == SILC_PACKET_PRIVATE_MESSAGE &&
2270 (packet->flags & SILC_PACKET_FLAG_PRIVMSG_KEY))
2272 else if (packet->type != SILC_PACKET_CHANNEL_MESSAGE)
2276 SILC_LOG_HEXDUMP(("Incoming packet (%d) len %d",
2277 stream->receive_psn, paddedlen + ivlen + mac_len),
2278 inbuf->data, paddedlen + ivlen + mac_len);
2280 /* Put the decrypted part, and rest of the encrypted data, and decrypt */
2281 silc_buffer_pull_tail(&packet->buffer, paddedlen);
2282 silc_buffer_put(&packet->buffer, header, block_len - psnlen);
2283 silc_buffer_pull(&packet->buffer, block_len - psnlen);
2284 silc_buffer_put(&packet->buffer, (inbuf->data + ivlen +
2285 psnlen + (block_len - psnlen)),
2286 paddedlen - ivlen - psnlen - (block_len - psnlen));
2287 if (silc_likely(cipher)) {
2288 silc_cipher_set_iv(cipher, iv);
2289 ret = silc_packet_decrypt(cipher, hmac, stream->receive_psn,
2290 &packet->buffer, normal);
2291 if (silc_unlikely(ret < 0)) {
2292 silc_mutex_unlock(stream->lock);
2293 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_DECRYPTION_FAILED);
2294 silc_mutex_lock(stream->lock);
2295 silc_packet_free(packet);
2296 memset(tmp, 0, sizeof(tmp));
2300 stream->receive_psn++;
2302 silc_buffer_push(&packet->buffer, block_len);
2304 /* Pull the packet from inbuf thus we'll get the next one in the inbuf. */
2305 silc_buffer_pull(inbuf, paddedlen + mac_len);
2307 /* Parse the packet */
2308 if (silc_unlikely(!silc_packet_parse(packet))) {
2309 silc_mutex_unlock(stream->lock);
2310 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_MALFORMED);
2311 silc_mutex_lock(stream->lock);
2312 silc_packet_free(packet);
2313 memset(tmp, 0, sizeof(tmp));
2317 /* Dispatch the packet to application */
2318 if (!silc_packet_dispatch(packet))
2323 /* Add inbuf back to free list, if we owned it. */
2324 if (stream->inbuf) {
2325 silc_dlist_add(stream->sc->inbufs, inbuf);
2326 stream->inbuf = NULL;
2329 silc_buffer_reset(inbuf);
2332 /****************************** Packet Waiting ******************************/
2334 /* Packet wait receive callback */
2336 silc_packet_wait_packet_receive(SilcPacketEngine engine,
2337 SilcPacketStream stream,
2339 void *callback_context,
2340 void *stream_context);
2342 /* Packet waiting callbacks */
2343 static const SilcPacketCallbacks silc_packet_wait_cbs =
2345 silc_packet_wait_packet_receive, NULL, NULL
2348 /* Packet waiting context */
2350 SilcMutex wait_lock;
2352 SilcList packet_queue;
2353 unsigned char id[28];
2354 unsigned int id_type : 2;
2355 unsigned int id_len : 5;
2356 unsigned int stopped : 1;
2359 /* Packet wait receive callback */
2362 silc_packet_wait_packet_receive(SilcPacketEngine engine,
2363 SilcPacketStream stream,
2365 void *callback_context,
2366 void *stream_context)
2368 SilcPacketWait pw = callback_context;
2370 /* If source ID is specified check for it */
2372 if (pw->id_type != packet->src_id_type ||
2373 memcmp(pw->id, packet->src_id, pw->id_len))
2377 /* Signal the waiting thread for a new packet */
2378 silc_mutex_lock(pw->wait_lock);
2380 if (silc_unlikely(pw->stopped)) {
2381 silc_mutex_unlock(pw->wait_lock);
2385 silc_list_add(pw->packet_queue, packet);
2386 silc_cond_broadcast(pw->wait_cond);
2388 silc_mutex_unlock(pw->wait_lock);
2393 /* Initialize packet waiting */
2395 void *silc_packet_wait_init(SilcPacketStream stream,
2396 const SilcID *source_id, ...)
2402 pw = silc_calloc(1, sizeof(*pw));
2406 /* Allocate mutex and conditional variable */
2407 if (!silc_mutex_alloc(&pw->wait_lock)) {
2411 if (!silc_cond_alloc(&pw->wait_cond)) {
2412 silc_mutex_free(pw->wait_lock);
2417 /* Link to the packet stream for the requested packet types */
2418 va_start(ap, source_id);
2419 ret = silc_packet_stream_link_va(stream, &silc_packet_wait_cbs, pw,
2423 silc_cond_free(pw->wait_cond);
2424 silc_mutex_free(pw->wait_lock);
2429 /* Initialize packet queue */
2430 silc_list_init(pw->packet_queue, struct SilcPacketStruct, next);
2434 silc_id_id2str(SILC_ID_GET_ID(*source_id), source_id->type, pw->id,
2435 sizeof(pw->id), &id_len);
2436 pw->id_type = source_id->type;
2437 pw->id_len = id_len;
2443 /* Uninitialize packet waiting */
2445 void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream)
2447 SilcPacketWait pw = waiter;
2450 /* Signal any threads to stop waiting */
2451 silc_mutex_lock(pw->wait_lock);
2453 silc_cond_broadcast(pw->wait_cond);
2454 silc_mutex_unlock(pw->wait_lock);
2455 silc_thread_yield();
2457 /* Re-acquire lock and free resources */
2458 silc_mutex_lock(pw->wait_lock);
2459 silc_packet_stream_unlink(stream, &silc_packet_wait_cbs, pw);
2461 /* Free any remaining packets */
2462 silc_list_start(pw->packet_queue);
2463 while ((packet = silc_list_get(pw->packet_queue)) != SILC_LIST_END)
2464 silc_packet_free(packet);
2466 silc_mutex_unlock(pw->wait_lock);
2467 silc_cond_free(pw->wait_cond);
2468 silc_mutex_free(pw->wait_lock);
2472 /* Blocks thread until a packet has been received. */
2474 int silc_packet_wait(void *waiter, int timeout, SilcPacket *return_packet)
2476 SilcPacketWait pw = waiter;
2477 SilcBool ret = FALSE;
2479 silc_mutex_lock(pw->wait_lock);
2481 /* Wait here until packet has arrived */
2482 while (silc_list_count(pw->packet_queue) == 0) {
2483 if (silc_unlikely(pw->stopped)) {
2484 silc_mutex_unlock(pw->wait_lock);
2487 ret = silc_cond_timedwait(pw->wait_cond, pw->wait_lock, timeout);
2491 silc_list_start(pw->packet_queue);
2492 *return_packet = silc_list_get(pw->packet_queue);
2493 silc_list_del(pw->packet_queue, *return_packet);
2495 silc_mutex_unlock(pw->wait_lock);
2497 return ret == TRUE ? 1 : 0;
2500 /************************** Packet Stream Wrapper ***************************/
2502 /* Packet stream wrapper receive callback */
2504 silc_packet_wrap_packet_receive(SilcPacketEngine engine,
2505 SilcPacketStream stream,
2507 void *callback_context,
2508 void *stream_context);
2510 const SilcStreamOps silc_packet_stream_ops;
2512 /* Packet stream wrapper context */
2514 const SilcStreamOps *ops;
2515 SilcPacketStream stream;
2517 void *waiter; /* Waiter context in blocking mode */
2518 SilcPacketWrapCoder coder;
2519 void *coder_context;
2521 SilcStreamNotifier callback;
2524 SilcPacketType type;
2525 SilcPacketFlags flags;
2526 unsigned int closed : 1;
2527 unsigned int blocking : 1;
2528 unsigned int read_more : 1;
2529 } *SilcPacketWrapperStream;
2531 /* Packet wrapper callbacks */
2532 static const SilcPacketCallbacks silc_packet_wrap_cbs =
2534 silc_packet_wrap_packet_receive, NULL, NULL
2537 /* Packet stream wrapper receive callback, non-blocking mode */
2540 silc_packet_wrap_packet_receive(SilcPacketEngine engine,
2541 SilcPacketStream stream,
2543 void *callback_context,
2544 void *stream_context)
2546 SilcPacketWrapperStream pws = callback_context;
2548 if (pws->closed || !pws->callback)
2551 silc_mutex_lock(pws->lock);
2552 silc_list_add(pws->in_queue, packet);
2553 silc_mutex_unlock(pws->lock);
2555 /* Call notifier callback */
2556 pws->callback((SilcStream)pws, SILC_STREAM_CAN_READ, pws->context);
2561 /* Task callback to notify more data is available for reading */
2563 SILC_TASK_CALLBACK(silc_packet_wrap_read_more)
2565 SilcPacketWrapperStream pws = context;
2567 if (pws->closed || !pws->callback)
2570 /* Call notifier callback */
2571 pws->callback((SilcStream)pws, SILC_STREAM_CAN_READ, pws->context);
2574 /* Read SILC packet */
2576 int silc_packet_wrap_read(SilcStream stream, unsigned char *buf,
2579 SilcPacketWrapperStream pws = stream;
2581 SilcBool read_more = FALSE;
2587 if (pws->blocking) {
2588 /* Block until packet is received */
2589 if ((silc_packet_wait(pws->waiter, 0, &packet)) < 0)
2594 /* Non-blocking mode */
2595 silc_mutex_lock(pws->lock);
2596 if (!silc_list_count(pws->in_queue)) {
2597 silc_mutex_unlock(pws->lock);
2601 silc_list_start(pws->in_queue);
2602 packet = silc_list_get(pws->in_queue);
2603 silc_list_del(pws->in_queue, packet);
2604 silc_mutex_unlock(pws->lock);
2607 /* Call decoder if set */
2608 if (pws->coder && !pws->read_more)
2609 pws->coder(stream, SILC_STREAM_CAN_READ, &packet->buffer,
2610 pws->coder_context);
2612 len = silc_buffer_len(&packet->buffer);
2613 if (len > buf_len) {
2619 memcpy(buf, packet->buffer.data, len);
2621 if (read_more && !pws->blocking) {
2622 /* More data will be available (in blocking mode not supported). */
2623 silc_buffer_pull(&packet->buffer, len);
2624 silc_list_insert(pws->in_queue, NULL, packet);
2625 silc_schedule_task_add_timeout(pws->stream->sc->schedule,
2626 silc_packet_wrap_read_more, pws, 0, 0);
2627 pws->read_more = TRUE;
2631 pws->read_more = FALSE;
2632 silc_packet_free(packet);
2636 /* Write SILC packet */
2638 int silc_packet_wrap_write(SilcStream stream, const unsigned char *data,
2639 SilcUInt32 data_len)
2641 SilcPacketWrapperStream pws = stream;
2642 SilcBool ret = FALSE;
2644 /* Call encoder if set */
2646 silc_buffer_reset(pws->encbuf);
2647 ret = pws->coder(stream, SILC_STREAM_CAN_WRITE, pws->encbuf,
2648 pws->coder_context);
2651 /* Send the SILC packet */
2653 if (!silc_packet_send_va(pws->stream, pws->type, pws->flags,
2654 SILC_STR_DATA(silc_buffer_data(pws->encbuf),
2655 silc_buffer_len(pws->encbuf)),
2656 SILC_STR_DATA(data, data_len),
2660 if (!silc_packet_send(pws->stream, pws->type, pws->flags, data, data_len))
2669 SilcBool silc_packet_wrap_close(SilcStream stream)
2671 SilcPacketWrapperStream pws = stream;
2676 if (pws->blocking) {
2677 /* Close packet waiter */
2678 silc_packet_wait_uninit(pws->waiter, pws->stream);
2682 silc_packet_stream_unlink(pws->stream, &silc_packet_wrap_cbs, pws);
2689 /* Destroy wrapper stream */
2691 void silc_packet_wrap_destroy(SilcStream stream)
2694 SilcPacketWrapperStream pws = stream;
2697 SILC_LOG_DEBUG(("Destroying wrapped packet stream %p", pws));
2699 silc_stream_close(stream);
2700 silc_list_start(pws->in_queue);
2701 while ((packet = silc_list_get(pws->in_queue)))
2702 silc_packet_free(packet);
2704 silc_mutex_free(pws->lock);
2706 silc_buffer_free(pws->encbuf);
2707 silc_packet_stream_unref(pws->stream);
2712 /* Link stream to receive packets */
2714 SilcBool silc_packet_wrap_notifier(SilcStream stream,
2715 SilcSchedule schedule,
2716 SilcStreamNotifier callback,
2719 SilcPacketWrapperStream pws = stream;
2721 if (pws->closed || pws->blocking)
2724 /* Link to receive packets */
2726 silc_packet_stream_link(pws->stream, &silc_packet_wrap_cbs, pws,
2727 100000, pws->type, -1);
2729 silc_packet_stream_unlink(pws->stream, &silc_packet_wrap_cbs, pws);
2731 pws->callback = callback;
2732 pws->context = context;
2737 /* Return schedule */
2739 SilcSchedule silc_packet_wrap_get_schedule(SilcStream stream)
2744 /* Wraps packet stream into SilcStream. */
2746 SilcStream silc_packet_stream_wrap(SilcPacketStream stream,
2747 SilcPacketType type,
2748 SilcPacketFlags flags,
2749 SilcBool blocking_mode,
2750 SilcPacketWrapCoder coder,
2753 SilcPacketWrapperStream pws;
2755 pws = silc_calloc(1, sizeof(*pws));
2759 SILC_LOG_DEBUG(("Wrapping packet stream %p to stream %p", stream, pws));
2761 pws->ops = &silc_packet_stream_ops;
2762 pws->stream = stream;
2765 pws->blocking = blocking_mode;
2767 pws->coder_context = context;
2769 /* Allocate small amount for encoder buffer. */
2771 pws->encbuf = silc_buffer_alloc(8);
2773 if (pws->blocking) {
2774 /* Blocking mode. Use packet waiter to do the thing. */
2775 pws->waiter = silc_packet_wait_init(pws->stream, NULL, pws->type, -1);
2781 /* Non-blocking mode */
2782 silc_mutex_alloc(&pws->lock);
2783 silc_list_init(pws->in_queue, struct SilcPacketStruct, next);
2786 silc_packet_stream_ref(stream);
2788 return (SilcStream)pws;
2791 const SilcStreamOps silc_packet_stream_ops =
2793 silc_packet_wrap_read,
2794 silc_packet_wrap_write,
2795 silc_packet_wrap_close,
2796 silc_packet_wrap_destroy,
2797 silc_packet_wrap_notifier,
2798 silc_packet_wrap_get_schedule,