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 SilcAtomic32 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_init32(&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_init32(&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_int32(&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_uninit32(&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);
1038 /* According to priority set the procesor to correct position. First
1039 entry has the highest priority */
1040 silc_dlist_start(stream->process);
1041 while ((e = silc_dlist_get(stream->process)) != SILC_LIST_END) {
1042 if (p->priority > e->priority) {
1043 silc_dlist_insert(stream->process, p);
1048 silc_dlist_add(stream->process, p);
1050 /* Get packet types to process */
1053 packet_type = va_arg(ap, SilcInt32);
1055 if (packet_type == SILC_PACKET_ANY)
1058 if (packet_type == -1)
1061 p->types = silc_realloc(p->types, sizeof(*p->types) * (i + 1));
1063 silc_mutex_unlock(stream->lock);
1067 p->types[i - 1] = (SilcPacketType)packet_type;
1071 p->types[i - 1] = 0;
1073 silc_mutex_unlock(stream->lock);
1075 silc_packet_stream_ref(stream);
1080 /* Links `callbacks' to `stream' for specified packet types */
1082 SilcBool silc_packet_stream_link(SilcPacketStream stream,
1083 const SilcPacketCallbacks *callbacks,
1084 void *callback_context,
1090 va_start(ap, priority);
1091 ret = silc_packet_stream_link_va(stream, callbacks, callback_context,
1098 /* Unlinks `callbacks' from `stream'. */
1100 void silc_packet_stream_unlink(SilcPacketStream stream,
1101 const SilcPacketCallbacks *callbacks,
1102 void *callback_context)
1104 SilcPacketProcess p;
1106 SILC_LOG_DEBUG(("Unlinking callbacks %p from stream %p",
1107 callbacks, stream));
1109 silc_mutex_lock(stream->lock);
1111 silc_dlist_start(stream->process);
1112 while ((p = silc_dlist_get(stream->process)) != SILC_LIST_END)
1113 if (p->callbacks == callbacks &&
1114 p->callback_context == callback_context) {
1115 silc_dlist_del(stream->process, p);
1116 silc_free(p->types);
1121 if (!silc_dlist_count(stream->process)) {
1122 silc_dlist_uninit(stream->process);
1123 stream->process = NULL;
1126 silc_mutex_unlock(stream->lock);
1128 silc_packet_stream_unref(stream);
1131 /* Returns TRUE if stream is UDP stream */
1133 SilcBool silc_packet_stream_is_udp(SilcPacketStream stream)
1135 return stream->udp || silc_socket_stream_is_udp(stream->stream, NULL);
1138 /* Return packet sender IP and port for UDP packet stream */
1140 SilcBool silc_packet_get_sender(SilcPacket packet,
1141 const char **sender_ip,
1142 SilcUInt16 *sender_port)
1144 if (!packet->stream->remote_udp)
1147 *sender_ip = packet->stream->remote_udp->remote_ip;
1148 *sender_port = packet->stream->remote_udp->remote_port;
1153 /* Reference packet stream */
1155 void silc_packet_stream_ref(SilcPacketStream stream)
1157 silc_atomic_add_int32(&stream->refcnt, 1);
1158 SILC_LOG_DEBUG(("Stream %p, refcnt %d->%d", stream,
1159 silc_atomic_get_int32(&stream->refcnt) - 1,
1160 silc_atomic_get_int32(&stream->refcnt)));
1163 /* Unreference packet stream */
1165 void silc_packet_stream_unref(SilcPacketStream stream)
1167 SILC_LOG_DEBUG(("Stream %p, refcnt %d->%d", stream,
1168 silc_atomic_get_int32(&stream->refcnt),
1169 silc_atomic_get_int32(&stream->refcnt) - 1));
1170 if (silc_atomic_sub_int32(&stream->refcnt, 1) > 0)
1172 silc_atomic_add_int32(&stream->refcnt, 1);
1173 silc_packet_stream_destroy(stream);
1178 SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream)
1180 return stream->sc->engine;
1183 /* Set application context for packet stream */
1185 void silc_packet_set_context(SilcPacketStream stream, void *stream_context)
1187 silc_mutex_lock(stream->lock);
1188 stream->stream_context = stream_context;
1189 silc_mutex_unlock(stream->lock);
1192 /* Return application context from packet stream */
1194 void *silc_packet_get_context(SilcPacketStream stream)
1197 silc_mutex_lock(stream->lock);
1198 context = stream->stream_context;
1199 silc_mutex_unlock(stream->lock);
1203 /* Change underlaying stream */
1205 void silc_packet_stream_set_stream(SilcPacketStream ps,
1209 silc_stream_set_notifier(ps->stream, ps->sc->schedule, NULL, NULL);
1210 ps->stream = stream;
1211 silc_stream_set_notifier(ps->stream, ps->sc->schedule, silc_packet_stream_io,
1215 /* Return underlaying stream */
1217 SilcStream silc_packet_stream_get_stream(SilcPacketStream stream)
1219 return stream->stream;
1224 SilcBool silc_packet_set_keys(SilcPacketStream stream, SilcCipher send_key,
1225 SilcCipher receive_key, SilcHmac send_hmac,
1226 SilcHmac receive_hmac, SilcBool rekey)
1228 SILC_LOG_DEBUG(("Setting new keys to packet stream %p", stream));
1230 /* If doing rekey, send REKEY_DONE packet */
1232 /* This will take stream lock. */
1233 if (!silc_packet_send_raw(stream, SILC_PACKET_REKEY_DONE, 0,
1234 stream->src_id_type, stream->src_id,
1235 stream->src_id_len, stream->dst_id_type,
1236 stream->dst_id, stream->dst_id_len,
1237 NULL, 0, stream->send_key[0],
1238 stream->send_hmac[0]))
1241 /* Write the packet to the stream */
1242 if (!silc_packet_stream_write(stream, TRUE))
1245 silc_mutex_lock(stream->lock);
1248 /* In case IV Included is set, save the old keys */
1249 if (stream->iv_included) {
1250 if (stream->send_key[1] && send_key) {
1251 silc_cipher_free(stream->send_key[1]);
1252 stream->send_key[1] = stream->send_key[0];
1254 if (stream->receive_key[1] && receive_key) {
1255 silc_cipher_free(stream->receive_key[1]);
1256 stream->receive_key[1] = stream->receive_key[0];
1258 if (stream->send_hmac[1] && send_hmac) {
1259 silc_hmac_free(stream->send_hmac[1]);
1260 stream->send_hmac[1] = stream->send_hmac[0];
1262 if (stream->receive_hmac[1] && receive_hmac) {
1263 silc_hmac_free(stream->receive_hmac[1]);
1264 stream->receive_hmac[1] = stream->receive_hmac[0];
1267 if (stream->send_key[0] && send_key)
1268 silc_cipher_free(stream->send_key[0]);
1269 if (stream->receive_key[0] && receive_key)
1270 silc_cipher_free(stream->receive_key[0]);
1271 if (stream->send_hmac[0] && send_hmac)
1272 silc_hmac_free(stream->send_hmac[0]);
1273 if (stream->receive_hmac[0] && receive_hmac)
1274 silc_hmac_free(stream->receive_hmac[0]);
1279 stream->send_key[0] = send_key;
1281 stream->receive_key[0] = receive_key;
1283 stream->send_hmac[0] = send_hmac;
1285 stream->receive_hmac[0] = receive_hmac;
1287 silc_mutex_unlock(stream->lock);
1291 /* Return current ciphers from packet stream */
1293 SilcBool silc_packet_get_keys(SilcPacketStream stream,
1294 SilcCipher *send_key,
1295 SilcCipher *receive_key,
1296 SilcHmac *send_hmac,
1297 SilcHmac *receive_hmac)
1299 if (!stream->send_key[0] && !stream->receive_key[0] &&
1300 !stream->send_hmac[0] && !stream->receive_hmac[0])
1303 silc_mutex_lock(stream->lock);
1306 *send_key = stream->send_key[0];
1308 *receive_key = stream->receive_key[0];
1310 *send_hmac = stream->send_hmac[0];
1312 *receive_hmac = stream->receive_hmac[0];
1314 silc_mutex_unlock(stream->lock);
1319 /* Set SILC IDs to packet stream */
1321 SilcBool silc_packet_set_ids(SilcPacketStream stream,
1322 SilcIdType src_id_type, const void *src_id,
1323 SilcIdType dst_id_type, const void *dst_id)
1326 unsigned char tmp[32];
1329 if (!src_id && !dst_id)
1332 silc_mutex_lock(stream->lock);
1335 SILC_LOG_DEBUG(("Setting source ID to packet stream %p", stream));
1337 if (!silc_id_id2str(src_id, src_id_type, tmp, sizeof(tmp), &len)) {
1338 silc_mutex_unlock(stream->lock);
1341 tmp_id = silc_memdup(tmp, len);
1343 silc_mutex_unlock(stream->lock);
1346 silc_free(stream->src_id);
1347 stream->src_id = tmp_id;
1348 stream->src_id_type = src_id_type;
1349 stream->src_id_len = len;
1353 SILC_LOG_DEBUG(("Setting destination ID to packet stream %p", stream));
1355 if (!silc_id_id2str(dst_id, dst_id_type, tmp, sizeof(tmp), &len)) {
1356 silc_mutex_unlock(stream->lock);
1359 tmp_id = silc_memdup(tmp, len);
1361 silc_mutex_unlock(stream->lock);
1364 silc_free(stream->dst_id);
1365 stream->dst_id = tmp_id;
1366 stream->dst_id_type = dst_id_type;
1367 stream->dst_id_len = len;
1370 silc_mutex_unlock(stream->lock);
1375 /* Return IDs from the packet stream */
1377 SilcBool silc_packet_get_ids(SilcPacketStream stream,
1378 SilcBool *src_id_set, SilcID *src_id,
1379 SilcBool *dst_id_set, SilcID *dst_id)
1381 if (src_id && stream->src_id)
1382 if (!silc_id_str2id2(stream->src_id, stream->src_id_len,
1383 stream->src_id_type, src_id))
1386 if (stream->src_id && src_id_set)
1389 if (dst_id && stream->dst_id)
1390 if (!silc_id_str2id2(stream->dst_id, stream->dst_id_len,
1391 stream->dst_id_type, dst_id))
1394 if (stream->dst_id && dst_id_set)
1400 /* Adds Security ID (SID) */
1402 SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid)
1404 if (!stream->iv_included)
1407 SILC_LOG_DEBUG(("Set packet stream %p SID to %d", stream, sid));
1415 void silc_packet_free(SilcPacket packet)
1417 SilcPacketStream stream = packet->stream;
1419 SILC_LOG_DEBUG(("Freeing packet %p", packet));
1421 /* Check for double free */
1422 SILC_ASSERT(packet->stream != NULL);
1424 packet->stream = NULL;
1425 packet->src_id = packet->dst_id = NULL;
1426 silc_buffer_reset(&packet->buffer);
1428 silc_mutex_lock(stream->sc->engine->lock);
1430 /* Put the packet back to freelist */
1431 silc_list_add(stream->sc->engine->packet_pool, packet);
1432 if (silc_list_count(stream->sc->engine->packet_pool) == 1)
1433 silc_list_start(stream->sc->engine->packet_pool);
1435 silc_mutex_unlock(stream->sc->engine->lock);
1438 /****************************** Packet Sending ******************************/
1440 /* Prepare outgoing data buffer for packet sending. Returns the
1441 pointer to that buffer into the `packet'. */
1443 static inline SilcBool silc_packet_send_prepare(SilcPacketStream stream,
1448 unsigned char *oldptr;
1449 unsigned int mac_len = hmac ? silc_hmac_len(hmac) : 0;
1453 /* Allocate more space if needed */
1454 if (silc_unlikely(silc_buffer_taillen(&stream->outbuf) < totlen)) {
1455 if (!silc_buffer_realloc(&stream->outbuf,
1456 silc_buffer_truelen(&stream->outbuf) + totlen))
1460 /* Pull data area for the new packet, and return pointer to the start of
1461 the data area and save the pointer in to the `packet'. MAC is pulled
1462 later after it's computed. */
1463 oldptr = silc_buffer_pull_tail(&stream->outbuf, totlen);
1464 silc_buffer_set(packet, oldptr, totlen);
1465 silc_buffer_push_tail(packet, mac_len);
1470 /* Increments counter when encrypting in counter mode. */
1472 static inline void silc_packet_send_ctr_increment(SilcPacketStream stream,
1474 unsigned char *ret_iv)
1476 unsigned char *iv = silc_cipher_get_iv(cipher);
1477 SilcUInt32 pc1, pc2;
1479 /* Reset block counter */
1480 memset(iv + 12, 0, 4);
1482 /* If IV Included flag, return the 64-bit IV for inclusion in packet */
1483 if (stream->iv_included) {
1485 ret_iv[0] = silc_rng_get_byte_fast(stream->sc->engine->rng);
1486 ret_iv[1] = ret_iv[0] + iv[4];
1487 ret_iv[2] = ret_iv[0] ^ ret_iv[1];
1488 ret_iv[3] = ret_iv[0] + ret_iv[2];
1490 /* Increment 32-bit packet counter */
1491 SILC_GET32_MSB(pc1, iv + 8);
1493 SILC_PUT32_MSB(pc1, ret_iv + 4);
1495 SILC_LOG_HEXDUMP(("IV"), ret_iv, 8);
1497 /* Set new nonce to counter block */
1498 memcpy(iv + 4, ret_iv, 8);
1500 /* Increment 64-bit packet counter */
1501 SILC_GET32_MSB(pc1, iv + 4);
1502 SILC_GET32_MSB(pc2, iv + 8);
1505 SILC_PUT32_MSB(pc1, iv + 4);
1506 SILC_PUT32_MSB(pc2, iv + 8);
1509 SILC_LOG_HEXDUMP(("Counter Block"), iv, 16);
1512 /* Internal routine to assemble outgoing packet. Assembles and encryptes
1513 the packet. The silc_packet_stream_write needs to be called to send it
1514 after this returns TRUE. */
1516 static inline SilcBool silc_packet_send_raw(SilcPacketStream stream,
1517 SilcPacketType type,
1518 SilcPacketFlags flags,
1519 SilcIdType src_id_type,
1520 unsigned char *src_id,
1521 SilcUInt32 src_id_len,
1522 SilcIdType dst_id_type,
1523 unsigned char *dst_id,
1524 SilcUInt32 dst_id_len,
1525 const unsigned char *data,
1526 SilcUInt32 data_len,
1530 unsigned char tmppad[SILC_PACKET_MAX_PADLEN], iv[33], psn[4];
1531 int block_len = (cipher ? silc_cipher_get_block_len(cipher) : 0);
1532 int i, enclen, truelen, padlen = 0, ivlen = 0, psnlen = 0;
1534 SilcBufferStruct packet;
1536 SILC_LOG_DEBUG(("Sending packet %s (%d) flags %d, src %d dst %d, "
1537 "data len %d", silc_get_packet_name(type), stream->send_psn,
1538 flags, src_id_type, dst_id_type, data_len));
1540 /* Get the true length of the packet. This is saved as payload length
1541 into the packet header. This does not include the length of the
1543 data_len = SILC_PACKET_DATALEN(data_len, (SILC_PACKET_HEADER_LEN +
1544 src_id_len + dst_id_len));
1545 enclen = truelen = (data_len + SILC_PACKET_HEADER_LEN +
1546 src_id_len + dst_id_len);
1548 /* If using CTR mode, increment the counter */
1549 ctr = (cipher && silc_cipher_get_mode(cipher) == SILC_CIPHER_MODE_CTR);
1551 silc_packet_send_ctr_increment(stream, cipher, iv + 1);
1553 /* If IV is included, the SID, IV and sequence number is added to packet */
1554 if (stream->iv_included && cipher) {
1555 psnlen = sizeof(psn);
1557 iv[0] = stream->sid;
1560 /* If IV is included, the SID, IV and sequence number is added to packet */
1561 if (stream->iv_included && cipher) {
1562 psnlen = sizeof(psn);
1563 ivlen = block_len + 1;
1564 iv[0] = stream->sid;
1565 memcpy(iv + 1, silc_cipher_get_iv(cipher), block_len);
1569 /* We automatically figure out the packet structure from the packet
1570 type and flags, and calculate correct length. Private messages with
1571 private keys and channel messages are special packets as their
1572 payload is encrypted already. */
1573 if (type == SILC_PACKET_PRIVATE_MESSAGE &&
1574 flags & SILC_PACKET_FLAG_PRIVMSG_KEY) {
1575 /* Padding is calculated from header + IDs */
1577 SILC_PACKET_PADLEN((SILC_PACKET_HEADER_LEN + src_id_len + dst_id_len +
1578 psnlen), block_len, padlen);
1580 /* Length to encrypt, header + IDs + padding. */
1581 enclen = (SILC_PACKET_HEADER_LEN + src_id_len + dst_id_len +
1584 } else if (type == SILC_PACKET_CHANNEL_MESSAGE) {
1585 if (stream->sc->engine->local_is_router && stream->is_router) {
1586 /* Channel messages between routers are encrypted as normal packets.
1587 Padding is calculated from true length of the packet. */
1589 SILC_PACKET_PADLEN(truelen + psnlen, block_len, padlen);
1591 enclen += padlen + psnlen;
1593 /* Padding is calculated from header + IDs */
1595 SILC_PACKET_PADLEN((SILC_PACKET_HEADER_LEN + src_id_len + dst_id_len +
1596 psnlen), block_len, padlen);
1598 /* Length to encrypt, header + IDs + padding. */
1599 enclen = (SILC_PACKET_HEADER_LEN + src_id_len + dst_id_len +
1603 /* Padding is calculated from true length of the packet */
1604 if (flags & SILC_PACKET_FLAG_LONG_PAD)
1605 SILC_PACKET_PADLEN_MAX(truelen + psnlen, block_len, padlen);
1607 SILC_PACKET_PADLEN(truelen + psnlen, block_len, padlen);
1609 enclen += padlen + psnlen;
1612 /* Remove implementation specific flags */
1613 flags &= ~(SILC_PACKET_FLAG_LONG_PAD);
1615 /* Get random padding */
1616 for (i = 0; i < padlen; i++) tmppad[i] =
1617 silc_rng_get_byte_fast(stream->sc->engine->rng);
1619 silc_mutex_lock(stream->lock);
1621 /* Get packet pointer from the outgoing buffer */
1622 if (silc_unlikely(!silc_packet_send_prepare(stream, truelen + padlen + ivlen
1623 + psnlen, hmac, &packet))) {
1624 silc_mutex_unlock(stream->lock);
1628 SILC_PUT32_MSB(stream->send_psn, psn);
1630 /* Create the packet. This creates the SILC header, adds padding, and
1631 the actual packet data. */
1632 i = silc_buffer_format(&packet,
1633 SILC_STR_DATA(iv, ivlen),
1634 SILC_STR_DATA(psn, psnlen),
1635 SILC_STR_UI_SHORT(truelen),
1636 SILC_STR_UI_CHAR(flags),
1637 SILC_STR_UI_CHAR(type),
1638 SILC_STR_UI_CHAR(padlen),
1639 SILC_STR_UI_CHAR(0),
1640 SILC_STR_UI_CHAR(src_id_len),
1641 SILC_STR_UI_CHAR(dst_id_len),
1642 SILC_STR_UI_CHAR(src_id_type),
1643 SILC_STR_DATA(src_id, src_id_len),
1644 SILC_STR_UI_CHAR(dst_id_type),
1645 SILC_STR_DATA(dst_id, dst_id_len),
1646 SILC_STR_DATA(tmppad, padlen),
1647 SILC_STR_DATA(data, data_len),
1649 if (silc_unlikely(i < 0)) {
1650 silc_mutex_unlock(stream->lock);
1654 SILC_LOG_HEXDUMP(("Assembled packet, len %d", silc_buffer_len(&packet)),
1655 silc_buffer_data(&packet), silc_buffer_len(&packet));
1657 /* Encrypt the packet */
1658 if (silc_likely(cipher)) {
1659 SILC_LOG_DEBUG(("Encrypting packet"));
1660 silc_cipher_set_iv(cipher, NULL);
1661 if (silc_unlikely(!silc_cipher_encrypt(cipher, packet.data + ivlen,
1662 packet.data + ivlen, enclen,
1664 SILC_LOG_ERROR(("Packet encryption failed"));
1665 silc_mutex_unlock(stream->lock);
1671 if (silc_likely(hmac)) {
1674 /* MAC is computed from the entire encrypted packet data, and put
1675 to the end of the packet. */
1676 silc_hmac_init(hmac);
1677 silc_hmac_update(hmac, psn, sizeof(psn));
1678 silc_hmac_update(hmac, packet.data, silc_buffer_len(&packet));
1679 silc_hmac_final(hmac, packet.tail, &mac_len);
1680 silc_buffer_pull_tail(&packet, mac_len);
1687 /* Sends a packet */
1689 SilcBool silc_packet_send(SilcPacketStream stream,
1690 SilcPacketType type, SilcPacketFlags flags,
1691 const unsigned char *data, SilcUInt32 data_len)
1695 ret = silc_packet_send_raw(stream, type, flags,
1696 stream->src_id_type,
1699 stream->dst_id_type,
1703 stream->send_key[0],
1704 stream->send_hmac[0]);
1706 /* Write the packet to the stream */
1707 return ret ? silc_packet_stream_write(stream, FALSE) : FALSE;
1710 /* Sends a packet, extended routine */
1712 SilcBool silc_packet_send_ext(SilcPacketStream stream,
1713 SilcPacketType type, SilcPacketFlags flags,
1714 SilcIdType src_id_type, void *src_id,
1715 SilcIdType dst_id_type, void *dst_id,
1716 const unsigned char *data, SilcUInt32 data_len,
1717 SilcCipher cipher, SilcHmac hmac)
1719 unsigned char src_id_data[32], dst_id_data[32];
1720 SilcUInt32 src_id_len, dst_id_len;
1724 if (!silc_id_id2str(src_id, src_id_type, src_id_data,
1725 sizeof(src_id_data), &src_id_len))
1728 if (!silc_id_id2str(dst_id, dst_id_type, dst_id_data,
1729 sizeof(dst_id_data), &dst_id_len))
1732 ret = silc_packet_send_raw(stream, type, flags,
1733 src_id ? src_id_type : stream->src_id_type,
1734 src_id ? src_id_data : stream->src_id,
1735 src_id ? src_id_len : stream->src_id_len,
1736 dst_id ? dst_id_type : stream->dst_id_type,
1737 dst_id ? dst_id_data : stream->dst_id,
1738 dst_id ? dst_id_len : stream->dst_id_len,
1740 cipher ? cipher : stream->send_key[0],
1741 hmac ? hmac : stream->send_hmac[0]);
1743 /* Write the packet to the stream */
1744 return ret ? silc_packet_stream_write(stream, FALSE) : FALSE;
1747 /* Sends packet after formatting the arguments to buffer */
1749 SilcBool silc_packet_send_va(SilcPacketStream stream,
1750 SilcPacketType type, SilcPacketFlags flags, ...)
1752 SilcBufferStruct buf;
1756 va_start(va, flags);
1758 memset(&buf, 0, sizeof(buf));
1759 if (silc_buffer_format_vp(&buf, va) < 0) {
1764 ret = silc_packet_send(stream, type, flags, silc_buffer_data(&buf),
1765 silc_buffer_len(&buf));
1767 silc_buffer_purge(&buf);
1773 /* Sends packet after formatting the arguments to buffer, extended routine */
1775 SilcBool silc_packet_send_va_ext(SilcPacketStream stream,
1776 SilcPacketType type, SilcPacketFlags flags,
1777 SilcIdType src_id_type, void *src_id,
1778 SilcIdType dst_id_type, void *dst_id,
1779 SilcCipher cipher, SilcHmac hmac, ...)
1781 SilcBufferStruct buf;
1787 memset(&buf, 0, sizeof(buf));
1788 if (silc_buffer_format_vp(&buf, va) < 0) {
1793 ret = silc_packet_send_ext(stream, type, flags, src_id_type, src_id,
1794 dst_id_type, dst_id, silc_buffer_data(&buf),
1795 silc_buffer_len(&buf), cipher, hmac);
1797 silc_buffer_purge(&buf);
1803 /***************************** Packet Receiving *****************************/
1805 /* Checks MAC in the packet. Returns TRUE if MAC is Ok. */
1807 static inline SilcBool silc_packet_check_mac(SilcHmac hmac,
1808 const unsigned char *data,
1809 SilcUInt32 data_len,
1810 const unsigned char *packet_mac,
1811 const unsigned char *packet_seq,
1812 SilcUInt32 sequence)
1815 if (silc_likely(hmac)) {
1816 unsigned char mac[32], psn[4];
1819 SILC_LOG_DEBUG(("Verifying MAC"));
1821 /* Compute HMAC of packet */
1822 silc_hmac_init(hmac);
1825 SILC_PUT32_MSB(sequence, psn);
1826 silc_hmac_update(hmac, psn, 4);
1828 silc_hmac_update(hmac, packet_seq, 4);
1830 silc_hmac_update(hmac, data, data_len);
1831 silc_hmac_final(hmac, mac, &mac_len);
1833 /* Compare the MAC's */
1834 if (silc_unlikely(memcmp(packet_mac, mac, mac_len))) {
1835 SILC_LOG_DEBUG(("MAC failed"));
1839 SILC_LOG_DEBUG(("MAC is Ok"));
1845 /* Increments/sets counter when decrypting in counter mode. */
1847 static inline void silc_packet_receive_ctr_increment(SilcPacketStream stream,
1849 unsigned char *packet_iv)
1851 SilcUInt32 pc1, pc2;
1853 /* If IV Included flag, set the IV from packet to block counter. */
1854 if (stream->iv_included) {
1855 memcpy(iv + 4, packet_iv, 8);
1857 /* Increment 64-bit packet counter. */
1858 SILC_GET32_MSB(pc1, iv + 4);
1859 SILC_GET32_MSB(pc2, iv + 8);
1862 SILC_PUT32_MSB(pc1, iv + 4);
1863 SILC_PUT32_MSB(pc2, iv + 8);
1866 /* Reset block counter */
1867 memset(iv + 12, 0, 4);
1869 SILC_LOG_HEXDUMP(("Counter Block"), iv, 16);
1872 /* Decrypts SILC packet. Handles both normal and special packet decryption.
1873 Return 0 when packet is normal and 1 when it it special, -1 on error. */
1875 static inline int silc_packet_decrypt(SilcCipher cipher, SilcHmac hmac,
1876 SilcUInt32 sequence, SilcBuffer buffer,
1879 if (normal == TRUE) {
1880 if (silc_likely(cipher)) {
1881 /* Decrypt rest of the packet */
1882 SILC_LOG_DEBUG(("Decrypting the packet"));
1883 if (silc_unlikely(!silc_cipher_decrypt(cipher, buffer->data,
1885 silc_buffer_len(buffer), NULL)))
1891 /* Decrypt rest of the header plus padding */
1892 if (silc_likely(cipher)) {
1894 SilcUInt32 block_len = silc_cipher_get_block_len(cipher);
1896 SILC_LOG_DEBUG(("Decrypting the header"));
1898 /* Padding length + src id len + dst id len + header length - 16
1899 bytes already decrypted, gives the rest of the encrypted packet */
1900 silc_buffer_push(buffer, block_len);
1901 len = (((SilcUInt8)buffer->data[4] + (SilcUInt8)buffer->data[6] +
1902 (SilcUInt8)buffer->data[7] + SILC_PACKET_HEADER_LEN) -
1904 silc_buffer_pull(buffer, block_len);
1906 if (silc_unlikely(len > silc_buffer_len(buffer))) {
1907 SILC_LOG_ERROR(("Garbage in header of packet, bad packet length, "
1911 if (silc_unlikely(!silc_cipher_decrypt(cipher, buffer->data,
1912 buffer->data, len, NULL)))
1920 /* Parses the packet. This is called when a whole packet is ready to be
1921 parsed. The buffer sent must be already decrypted before calling this
1924 static inline SilcBool silc_packet_parse(SilcPacket packet)
1926 SilcBuffer buffer = &packet->buffer;
1927 SilcUInt8 padlen = (SilcUInt8)buffer->data[4];
1928 SilcUInt8 src_id_len, dst_id_len, src_id_type, dst_id_type;
1931 SILC_LOG_DEBUG(("Parsing incoming packet"));
1933 /* Parse the buffer. This parses the SILC header of the packet. */
1934 ret = silc_buffer_unformat(buffer,
1937 SILC_STR_UI_CHAR(&src_id_len),
1938 SILC_STR_UI_CHAR(&dst_id_len),
1939 SILC_STR_UI_CHAR(&src_id_type),
1941 if (silc_unlikely(ret == -1)) {
1942 if (!packet->stream->udp &&
1943 !silc_socket_stream_is_udp(packet->stream->stream, NULL))
1944 SILC_LOG_ERROR(("Malformed packet header, packet dropped"));
1948 if (silc_unlikely(src_id_len > SILC_PACKET_MAX_ID_LEN ||
1949 dst_id_len > SILC_PACKET_MAX_ID_LEN)) {
1950 if (!packet->stream->udp &&
1951 !silc_socket_stream_is_udp(packet->stream->stream, NULL))
1952 SILC_LOG_ERROR(("Bad ID lengths in packet (%d and %d)",
1953 packet->src_id_len, packet->dst_id_len));
1957 ret = silc_buffer_unformat(buffer,
1959 SILC_STR_DATA(&packet->src_id, src_id_len),
1960 SILC_STR_UI_CHAR(&dst_id_type),
1961 SILC_STR_DATA(&packet->dst_id, dst_id_len),
1962 SILC_STR_OFFSET(padlen),
1964 if (silc_unlikely(ret == -1)) {
1965 if (!packet->stream->udp &&
1966 !silc_socket_stream_is_udp(packet->stream->stream, NULL))
1967 SILC_LOG_ERROR(("Malformed packet header, packet dropped"));
1971 if (silc_unlikely(src_id_type > SILC_ID_CHANNEL ||
1972 dst_id_type > SILC_ID_CHANNEL)) {
1973 if (!packet->stream->udp &&
1974 !silc_socket_stream_is_udp(packet->stream->stream, NULL))
1975 SILC_LOG_ERROR(("Bad ID types in packet (%d and %d)",
1976 src_id_type, dst_id_type));
1980 packet->src_id_len = src_id_len;
1981 packet->dst_id_len = dst_id_len;
1982 packet->src_id_type = src_id_type;
1983 packet->dst_id_type = dst_id_type;
1985 SILC_LOG_HEXDUMP(("Parsed packet, len %d", silc_buffer_headlen(buffer) +
1986 silc_buffer_len(buffer)), buffer->head,
1987 silc_buffer_headlen(buffer) + silc_buffer_len(buffer));
1989 SILC_LOG_DEBUG(("Incoming packet type: %d (%s), flags %d", packet->type,
1990 silc_get_packet_name(packet->type), packet->flags));
1995 /* Dispatch packet to application. Called with stream->lock locked.
1996 Returns FALSE if the stream was destroyed while dispatching a packet. */
1998 static SilcBool silc_packet_dispatch(SilcPacket packet)
2000 SilcPacketStream stream = packet->stream;
2001 SilcPacketProcess p;
2002 SilcBool default_sent = FALSE;
2005 /* Dispatch packet to all packet processors that want it */
2007 if (silc_likely(!stream->process)) {
2008 /* Send to default processor as no others exist */
2009 SILC_LOG_DEBUG(("Dispatching packet to default callbacks"));
2010 silc_mutex_unlock(stream->lock);
2011 if (silc_unlikely(!stream->sc->engine->callbacks->
2012 packet_receive(stream->sc->engine, stream, packet,
2013 stream->sc->engine->callback_context,
2014 stream->stream_context)))
2015 silc_packet_free(packet);
2016 silc_mutex_lock(stream->lock);
2017 return stream->destroyed == FALSE;
2020 silc_dlist_start(stream->process);
2021 while ((p = silc_dlist_get(stream->process)) != SILC_LIST_END) {
2023 /* If priority is 0 or less, we send to default processor first
2024 because default processor has 0 priority */
2025 if (!default_sent && p->priority <= 0) {
2026 SILC_LOG_DEBUG(("Dispatching packet to default callbacks"));
2027 default_sent = TRUE;
2028 silc_mutex_unlock(stream->lock);
2029 if (stream->sc->engine->callbacks->
2030 packet_receive(stream->sc->engine, stream, packet,
2031 stream->sc->engine->callback_context,
2032 stream->stream_context)) {
2033 silc_mutex_lock(stream->lock);
2034 return stream->destroyed == FALSE;
2036 silc_mutex_lock(stream->lock);
2039 /* Send to processor */
2041 /* Send all packet types */
2042 SILC_LOG_DEBUG(("Dispatching packet to %p callbacks", p->callbacks));
2043 silc_mutex_unlock(stream->lock);
2044 if (p->callbacks->packet_receive(stream->sc->engine, stream, packet,
2045 p->callback_context,
2046 stream->stream_context)) {
2047 silc_mutex_lock(stream->lock);
2048 return stream->destroyed == FALSE;
2050 silc_mutex_lock(stream->lock);
2052 /* Send specific types */
2053 for (pt = p->types; *pt; pt++) {
2054 if (*pt != packet->type)
2056 SILC_LOG_DEBUG(("Dispatching packet to %p callbacks", p->callbacks));
2057 silc_mutex_unlock(stream->lock);
2058 if (p->callbacks->packet_receive(stream->sc->engine, stream, packet,
2059 p->callback_context,
2060 stream->stream_context)) {
2061 silc_mutex_lock(stream->lock);
2062 return stream->destroyed == FALSE;
2064 silc_mutex_lock(stream->lock);
2070 if (!default_sent) {
2071 /* Send to default processor as it has not been sent yet */
2072 SILC_LOG_DEBUG(("Dispatching packet to default callbacks"));
2073 silc_mutex_unlock(stream->lock);
2074 if (stream->sc->engine->callbacks->
2075 packet_receive(stream->sc->engine, stream, packet,
2076 stream->sc->engine->callback_context,
2077 stream->stream_context)) {
2078 silc_mutex_lock(stream->lock);
2079 return stream->destroyed == FALSE;
2081 silc_mutex_lock(stream->lock);
2084 /* If we got here, no one wanted the packet, so drop it */
2085 silc_packet_free(packet);
2086 return stream->destroyed == FALSE;
2089 /* Process incoming data and parse packets. Called with stream->lock
2092 static void silc_packet_read_process(SilcPacketStream stream)
2099 SilcUInt16 packetlen;
2100 SilcUInt32 paddedlen, mac_len, block_len, ivlen, psnlen;
2101 unsigned char tmp[SILC_PACKET_MIN_HEADER_LEN], *header;
2102 unsigned char iv[SILC_CIPHER_MAX_IV_SIZE], *packet_seq = NULL;
2106 /* Get inbuf. If there is already some data for this stream in the buffer
2107 we already have it. Otherwise get the current one from list, it will
2108 include the data. */
2109 inbuf = stream->inbuf;
2111 silc_dlist_start(stream->sc->inbufs);
2112 inbuf = silc_dlist_get(stream->sc->inbufs);
2115 /* Parse the packets from the data */
2116 while (silc_buffer_len(inbuf) > 0) {
2118 cipher = stream->receive_key[0];
2119 hmac = stream->receive_hmac[0];
2122 if (silc_unlikely(silc_buffer_len(inbuf) <
2123 (stream->iv_included ? SILC_PACKET_MIN_HEADER_LEN_IV :
2124 SILC_PACKET_MIN_HEADER_LEN))) {
2125 SILC_LOG_DEBUG(("Partial packet in queue, waiting for the rest"));
2126 silc_dlist_del(stream->sc->inbufs, inbuf);
2127 stream->inbuf = inbuf;
2131 if (silc_likely(hmac))
2132 mac_len = silc_hmac_len(hmac);
2136 /* Decrypt first block of the packet to get the length field out */
2137 if (silc_likely(cipher)) {
2138 block_len = silc_cipher_get_block_len(cipher);
2140 if (stream->iv_included) {
2141 /* SID, IV and sequence number is included in the ciphertext */
2142 sid = (SilcUInt8)inbuf->data[0];
2144 if (silc_cipher_get_mode(cipher) == SILC_CIPHER_MODE_CTR) {
2145 /* Set the CTR mode IV from packet to counter block */
2146 memcpy(iv, silc_cipher_get_iv(cipher), block_len);
2147 silc_packet_receive_ctr_increment(stream, iv, inbuf->data + 1);
2150 /* Get IV from packet */
2151 memcpy(iv, inbuf->data + 1, block_len);
2152 ivlen = block_len + 1;
2156 /* Check SID, and get correct decryption key */
2157 if (sid != stream->sid) {
2158 /* If SID is recent get the previous key and use it */
2159 if (sid > 0 && stream->sid > 0 && stream->sid - 1 == sid &&
2160 stream->receive_key[1] && !stream->receive_hmac[1]) {
2161 cipher = stream->receive_key[1];
2162 hmac = stream->receive_hmac[1];
2164 /* The SID is unknown, drop rest of the data in buffer */
2165 SILC_LOG_DEBUG(("Unknown Security ID %d in packet, expected %d",
2167 silc_mutex_unlock(stream->lock);
2168 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_UNKNOWN_SID);
2169 silc_mutex_lock(stream->lock);
2174 memcpy(iv, silc_cipher_get_iv(cipher), block_len);
2176 /* If using CTR mode, increment the counter */
2177 if (silc_cipher_get_mode(cipher) == SILC_CIPHER_MODE_CTR)
2178 silc_packet_receive_ctr_increment(stream, iv, NULL);
2181 if (silc_cipher_get_mode(cipher) == SILC_CIPHER_MODE_CTR)
2182 silc_cipher_set_iv(cipher, NULL);
2183 silc_cipher_decrypt(cipher, inbuf->data + ivlen, tmp, block_len, iv);
2186 if (stream->iv_included) {
2187 /* Take sequence number from packet */
2188 packet_seq = header;
2192 /* Unencrypted packet */
2193 block_len = SILC_PACKET_MIN_HEADER_LEN;
2194 header = inbuf->data;
2197 /* Get packet length and full packet length with padding */
2198 SILC_PACKET_LENGTH(header, packetlen, paddedlen);
2200 if (silc_buffer_len(inbuf) < paddedlen + ivlen + mac_len) {
2201 SILC_LOG_DEBUG(("Received partial packet, waiting for the rest "
2203 paddedlen + mac_len - silc_buffer_len(inbuf)));
2204 memset(tmp, 0, sizeof(tmp));
2205 silc_dlist_del(stream->sc->inbufs, inbuf);
2206 stream->inbuf = inbuf;
2210 /* Check MAC of the packet */
2211 if (silc_unlikely(!silc_packet_check_mac(hmac, inbuf->data,
2213 inbuf->data + ivlen +
2214 paddedlen, packet_seq,
2215 stream->receive_psn))) {
2216 silc_mutex_unlock(stream->lock);
2217 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_MAC_FAILED);
2218 silc_mutex_lock(stream->lock);
2219 memset(tmp, 0, sizeof(tmp));
2224 if (silc_unlikely(packetlen < SILC_PACKET_MIN_LEN)) {
2225 if (!stream->udp && !silc_socket_stream_is_udp(stream->stream, NULL))
2226 SILC_LOG_ERROR(("Received too short packet"));
2227 silc_mutex_unlock(stream->lock);
2228 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_MALFORMED);
2229 silc_mutex_lock(stream->lock);
2230 memset(tmp, 0, sizeof(tmp));
2235 packet = silc_packet_alloc(stream->sc->engine);
2236 if (silc_unlikely(!packet)) {
2237 silc_mutex_unlock(stream->lock);
2238 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_NO_MEMORY);
2239 silc_mutex_lock(stream->lock);
2240 memset(tmp, 0, sizeof(tmp));
2243 packet->stream = stream;
2245 /* Allocate more space to packet buffer, if needed */
2246 if (silc_unlikely(silc_buffer_truelen(&packet->buffer) < paddedlen)) {
2247 if (!silc_buffer_realloc(&packet->buffer,
2248 silc_buffer_truelen(&packet->buffer) +
2250 silc_buffer_truelen(&packet->buffer)))) {
2251 silc_mutex_unlock(stream->lock);
2252 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_NO_MEMORY);
2253 silc_mutex_lock(stream->lock);
2254 silc_packet_free(packet);
2255 memset(tmp, 0, sizeof(tmp));
2260 /* Parse packet header */
2261 packet->flags = (SilcPacketFlags)header[2];
2262 packet->type = (SilcPacketType)header[3];
2264 if (stream->sc->engine->local_is_router) {
2265 if (packet->type == SILC_PACKET_PRIVATE_MESSAGE &&
2266 (packet->flags & SILC_PACKET_FLAG_PRIVMSG_KEY))
2268 else if (packet->type != SILC_PACKET_CHANNEL_MESSAGE ||
2269 (packet->type == SILC_PACKET_CHANNEL_MESSAGE &&
2270 stream->is_router == TRUE))
2273 if (packet->type == SILC_PACKET_PRIVATE_MESSAGE &&
2274 (packet->flags & SILC_PACKET_FLAG_PRIVMSG_KEY))
2276 else if (packet->type != SILC_PACKET_CHANNEL_MESSAGE)
2280 SILC_LOG_HEXDUMP(("Incoming packet (%d) len %d",
2281 stream->receive_psn, paddedlen + ivlen + mac_len),
2282 inbuf->data, paddedlen + ivlen + mac_len);
2284 /* Put the decrypted part, and rest of the encrypted data, and decrypt */
2285 silc_buffer_pull_tail(&packet->buffer, paddedlen);
2286 silc_buffer_put(&packet->buffer, header, block_len - psnlen);
2287 silc_buffer_pull(&packet->buffer, block_len - psnlen);
2288 silc_buffer_put(&packet->buffer, (inbuf->data + ivlen +
2289 psnlen + (block_len - psnlen)),
2290 paddedlen - ivlen - psnlen - (block_len - psnlen));
2291 if (silc_likely(cipher)) {
2292 silc_cipher_set_iv(cipher, iv);
2293 ret = silc_packet_decrypt(cipher, hmac, stream->receive_psn,
2294 &packet->buffer, normal);
2295 if (silc_unlikely(ret < 0)) {
2296 silc_mutex_unlock(stream->lock);
2297 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_DECRYPTION_FAILED);
2298 silc_mutex_lock(stream->lock);
2299 silc_packet_free(packet);
2300 memset(tmp, 0, sizeof(tmp));
2304 stream->receive_psn++;
2306 silc_buffer_push(&packet->buffer, block_len);
2308 /* Pull the packet from inbuf thus we'll get the next one in the inbuf. */
2309 silc_buffer_pull(inbuf, paddedlen + mac_len);
2311 /* Parse the packet */
2312 if (silc_unlikely(!silc_packet_parse(packet))) {
2313 silc_mutex_unlock(stream->lock);
2314 SILC_PACKET_CALLBACK_ERROR(stream, SILC_PACKET_ERR_MALFORMED);
2315 silc_mutex_lock(stream->lock);
2316 silc_packet_free(packet);
2317 memset(tmp, 0, sizeof(tmp));
2321 /* Dispatch the packet to application */
2322 if (!silc_packet_dispatch(packet))
2327 /* Add inbuf back to free list, if we owned it. */
2328 if (stream->inbuf) {
2329 silc_dlist_add(stream->sc->inbufs, inbuf);
2330 stream->inbuf = NULL;
2333 silc_buffer_reset(inbuf);
2336 /****************************** Packet Waiting ******************************/
2338 /* Packet wait receive callback */
2340 silc_packet_wait_packet_receive(SilcPacketEngine engine,
2341 SilcPacketStream stream,
2343 void *callback_context,
2344 void *stream_context);
2346 /* Packet waiting callbacks */
2347 static const SilcPacketCallbacks silc_packet_wait_cbs =
2349 silc_packet_wait_packet_receive, NULL, NULL
2352 /* Packet waiting context */
2354 SilcMutex wait_lock;
2356 SilcList packet_queue;
2357 unsigned char id[28];
2358 unsigned int id_type : 2;
2359 unsigned int id_len : 5;
2360 unsigned int stopped : 1;
2363 /* Packet wait receive callback */
2366 silc_packet_wait_packet_receive(SilcPacketEngine engine,
2367 SilcPacketStream stream,
2369 void *callback_context,
2370 void *stream_context)
2372 SilcPacketWait pw = callback_context;
2374 /* If source ID is specified check for it */
2376 if (pw->id_type != packet->src_id_type ||
2377 memcmp(pw->id, packet->src_id, pw->id_len))
2381 /* Signal the waiting thread for a new packet */
2382 silc_mutex_lock(pw->wait_lock);
2384 if (silc_unlikely(pw->stopped)) {
2385 silc_mutex_unlock(pw->wait_lock);
2389 silc_list_add(pw->packet_queue, packet);
2390 silc_cond_broadcast(pw->wait_cond);
2392 silc_mutex_unlock(pw->wait_lock);
2397 /* Initialize packet waiting */
2399 void *silc_packet_wait_init(SilcPacketStream stream,
2400 const SilcID *source_id, ...)
2406 pw = silc_calloc(1, sizeof(*pw));
2410 /* Allocate mutex and conditional variable */
2411 if (!silc_mutex_alloc(&pw->wait_lock)) {
2415 if (!silc_cond_alloc(&pw->wait_cond)) {
2416 silc_mutex_free(pw->wait_lock);
2421 /* Link to the packet stream for the requested packet types */
2422 va_start(ap, source_id);
2423 ret = silc_packet_stream_link_va(stream, &silc_packet_wait_cbs, pw,
2427 silc_cond_free(pw->wait_cond);
2428 silc_mutex_free(pw->wait_lock);
2433 /* Initialize packet queue */
2434 silc_list_init(pw->packet_queue, struct SilcPacketStruct, next);
2438 silc_id_id2str(SILC_ID_GET_ID(*source_id), source_id->type, pw->id,
2439 sizeof(pw->id), &id_len);
2440 pw->id_type = source_id->type;
2441 pw->id_len = id_len;
2447 /* Uninitialize packet waiting */
2449 void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream)
2451 SilcPacketWait pw = waiter;
2454 /* Signal any threads to stop waiting */
2455 silc_mutex_lock(pw->wait_lock);
2457 silc_cond_broadcast(pw->wait_cond);
2458 silc_mutex_unlock(pw->wait_lock);
2459 silc_thread_yield();
2461 /* Re-acquire lock and free resources */
2462 silc_mutex_lock(pw->wait_lock);
2463 silc_packet_stream_unlink(stream, &silc_packet_wait_cbs, pw);
2465 /* Free any remaining packets */
2466 silc_list_start(pw->packet_queue);
2467 while ((packet = silc_list_get(pw->packet_queue)) != SILC_LIST_END)
2468 silc_packet_free(packet);
2470 silc_mutex_unlock(pw->wait_lock);
2471 silc_cond_free(pw->wait_cond);
2472 silc_mutex_free(pw->wait_lock);
2476 /* Blocks thread until a packet has been received. */
2478 int silc_packet_wait(void *waiter, int timeout, SilcPacket *return_packet)
2480 SilcPacketWait pw = waiter;
2481 SilcBool ret = FALSE;
2483 silc_mutex_lock(pw->wait_lock);
2485 /* Wait here until packet has arrived */
2486 while (silc_list_count(pw->packet_queue) == 0) {
2487 if (silc_unlikely(pw->stopped)) {
2488 silc_mutex_unlock(pw->wait_lock);
2491 ret = silc_cond_timedwait(pw->wait_cond, pw->wait_lock, timeout);
2495 silc_list_start(pw->packet_queue);
2496 *return_packet = silc_list_get(pw->packet_queue);
2497 silc_list_del(pw->packet_queue, *return_packet);
2499 silc_mutex_unlock(pw->wait_lock);
2501 return ret == TRUE ? 1 : 0;
2504 /************************** Packet Stream Wrapper ***************************/
2506 /* Packet stream wrapper receive callback */
2508 silc_packet_wrap_packet_receive(SilcPacketEngine engine,
2509 SilcPacketStream stream,
2511 void *callback_context,
2512 void *stream_context);
2514 const SilcStreamOps silc_packet_stream_ops;
2516 /* Packet stream wrapper context */
2518 const SilcStreamOps *ops;
2519 SilcPacketStream stream;
2521 void *waiter; /* Waiter context in blocking mode */
2522 SilcPacketWrapCoder coder;
2523 void *coder_context;
2525 SilcStreamNotifier callback;
2528 SilcPacketType type;
2529 SilcPacketFlags flags;
2530 unsigned int closed : 1;
2531 unsigned int blocking : 1;
2532 unsigned int read_more : 1;
2533 } *SilcPacketWrapperStream;
2535 /* Packet wrapper callbacks */
2536 static const SilcPacketCallbacks silc_packet_wrap_cbs =
2538 silc_packet_wrap_packet_receive, NULL, NULL
2541 /* Packet stream wrapper receive callback, non-blocking mode */
2544 silc_packet_wrap_packet_receive(SilcPacketEngine engine,
2545 SilcPacketStream stream,
2547 void *callback_context,
2548 void *stream_context)
2550 SilcPacketWrapperStream pws = callback_context;
2552 if (pws->closed || !pws->callback)
2555 silc_mutex_lock(pws->lock);
2556 silc_list_add(pws->in_queue, packet);
2557 silc_mutex_unlock(pws->lock);
2559 /* Call notifier callback */
2560 pws->callback((SilcStream)pws, SILC_STREAM_CAN_READ, pws->context);
2565 /* Task callback to notify more data is available for reading */
2567 SILC_TASK_CALLBACK(silc_packet_wrap_read_more)
2569 SilcPacketWrapperStream pws = context;
2571 if (pws->closed || !pws->callback)
2574 /* Call notifier callback */
2575 pws->callback((SilcStream)pws, SILC_STREAM_CAN_READ, pws->context);
2578 /* Read SILC packet */
2580 int silc_packet_wrap_read(SilcStream stream, unsigned char *buf,
2583 SilcPacketWrapperStream pws = stream;
2585 SilcBool read_more = FALSE;
2591 if (pws->blocking) {
2592 /* Block until packet is received */
2593 if ((silc_packet_wait(pws->waiter, 0, &packet)) < 0)
2598 /* Non-blocking mode */
2599 silc_mutex_lock(pws->lock);
2600 if (!silc_list_count(pws->in_queue)) {
2601 silc_mutex_unlock(pws->lock);
2605 silc_list_start(pws->in_queue);
2606 packet = silc_list_get(pws->in_queue);
2607 silc_list_del(pws->in_queue, packet);
2608 silc_mutex_unlock(pws->lock);
2611 /* Call decoder if set */
2612 if (pws->coder && !pws->read_more)
2613 pws->coder(stream, SILC_STREAM_CAN_READ, &packet->buffer,
2614 pws->coder_context);
2616 len = silc_buffer_len(&packet->buffer);
2617 if (len > buf_len) {
2623 memcpy(buf, packet->buffer.data, len);
2625 if (read_more && !pws->blocking) {
2626 /* More data will be available (in blocking mode not supported). */
2627 silc_buffer_pull(&packet->buffer, len);
2628 silc_list_insert(pws->in_queue, NULL, packet);
2629 silc_schedule_task_add_timeout(pws->stream->sc->schedule,
2630 silc_packet_wrap_read_more, pws, 0, 0);
2631 pws->read_more = TRUE;
2635 pws->read_more = FALSE;
2636 silc_packet_free(packet);
2640 /* Write SILC packet */
2642 int silc_packet_wrap_write(SilcStream stream, const unsigned char *data,
2643 SilcUInt32 data_len)
2645 SilcPacketWrapperStream pws = stream;
2646 SilcBool ret = FALSE;
2648 /* Call encoder if set */
2650 silc_buffer_reset(pws->encbuf);
2651 ret = pws->coder(stream, SILC_STREAM_CAN_WRITE, pws->encbuf,
2652 pws->coder_context);
2655 /* Send the SILC packet */
2657 if (!silc_packet_send_va(pws->stream, pws->type, pws->flags,
2658 SILC_STR_DATA(silc_buffer_data(pws->encbuf),
2659 silc_buffer_len(pws->encbuf)),
2660 SILC_STR_DATA(data, data_len),
2664 if (!silc_packet_send(pws->stream, pws->type, pws->flags, data, data_len))
2673 SilcBool silc_packet_wrap_close(SilcStream stream)
2675 SilcPacketWrapperStream pws = stream;
2680 if (pws->blocking) {
2681 /* Close packet waiter */
2682 silc_packet_wait_uninit(pws->waiter, pws->stream);
2686 silc_packet_stream_unlink(pws->stream, &silc_packet_wrap_cbs, pws);
2693 /* Destroy wrapper stream */
2695 void silc_packet_wrap_destroy(SilcStream stream)
2698 SilcPacketWrapperStream pws = stream;
2701 SILC_LOG_DEBUG(("Destroying wrapped packet stream %p", pws));
2703 silc_stream_close(stream);
2704 silc_list_start(pws->in_queue);
2705 while ((packet = silc_list_get(pws->in_queue)))
2706 silc_packet_free(packet);
2708 silc_mutex_free(pws->lock);
2710 silc_buffer_free(pws->encbuf);
2711 silc_packet_stream_unref(pws->stream);
2716 /* Link stream to receive packets */
2718 SilcBool silc_packet_wrap_notifier(SilcStream stream,
2719 SilcSchedule schedule,
2720 SilcStreamNotifier callback,
2723 SilcPacketWrapperStream pws = stream;
2725 if (pws->closed || pws->blocking)
2728 /* Link to receive packets */
2730 silc_packet_stream_link(pws->stream, &silc_packet_wrap_cbs, pws,
2731 100000, pws->type, -1);
2733 silc_packet_stream_unlink(pws->stream, &silc_packet_wrap_cbs, pws);
2735 pws->callback = callback;
2736 pws->context = context;
2741 /* Return schedule */
2743 SilcSchedule silc_packet_wrap_get_schedule(SilcStream stream)
2748 /* Wraps packet stream into SilcStream. */
2750 SilcStream silc_packet_stream_wrap(SilcPacketStream stream,
2751 SilcPacketType type,
2752 SilcPacketFlags flags,
2753 SilcBool blocking_mode,
2754 SilcPacketWrapCoder coder,
2757 SilcPacketWrapperStream pws;
2759 pws = silc_calloc(1, sizeof(*pws));
2763 SILC_LOG_DEBUG(("Wrapping packet stream %p to stream %p", stream, pws));
2765 pws->ops = &silc_packet_stream_ops;
2766 pws->stream = stream;
2769 pws->blocking = blocking_mode;
2771 pws->coder_context = context;
2773 /* Allocate small amount for encoder buffer. */
2775 pws->encbuf = silc_buffer_alloc(8);
2777 if (pws->blocking) {
2778 /* Blocking mode. Use packet waiter to do the thing. */
2779 pws->waiter = silc_packet_wait_init(pws->stream, NULL, pws->type, -1);
2785 /* Non-blocking mode */
2786 silc_mutex_alloc(&pws->lock);
2787 silc_list_init(pws->in_queue, struct SilcPacketStruct, next);
2790 silc_packet_stream_ref(stream);
2792 return (SilcStream)pws;
2795 const SilcStreamOps silc_packet_stream_ops =
2797 silc_packet_wrap_read,
2798 silc_packet_wrap_write,
2799 silc_packet_wrap_close,
2800 silc_packet_wrap_destroy,
2801 silc_packet_wrap_notifier,
2802 silc_packet_wrap_get_schedule,