5 Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
7 Copyright (C) 1997 - 2001 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; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
24 /* Amount of bytes to be read from the socket connection at once. */
25 #define SILC_PACKET_READ_SIZE 16384
27 /* Default byte size of the packet. This can be set larger if this
28 is not enough, we shall see. */
29 #define SILC_PACKET_DEFAULT_SIZE 2048
31 /* Header length without source and destination ID's. */
32 #define SILC_PACKET_HEADER_LEN 8 + 2
34 /* Minimum length of SILC Packet Header. This much is decrypted always
35 when packet is received to be able to get all the relevant data out
37 #define SILC_PACKET_MIN_HEADER_LEN 16 + 2
39 /* Maximum padding length */
40 #define SILC_PACKET_MAX_PADLEN 16
42 /* Minimum packet length */
43 #define SILC_PACKET_MIN_LEN (SILC_PACKET_HEADER_LEN + 1)
45 /* Maximum length of ID */
46 #define SILC_PACKET_MAX_ID_LEN 16
48 /* SILC packet type definition. For now, it is defined like this and I don't
49 expect it to change in any near future. If one byte as a packet type is
50 not enough we can, then, think something else. */
51 typedef unsigned char SilcPacketType;
53 /* SILC packet version type definition. */
54 typedef unsigned char SilcPacketVersion;
56 /* SILC packet flags type definition. */
57 typedef unsigned char SilcPacketFlags;
59 /* All defined packet flags */
60 #define SILC_PACKET_FLAG_NONE 0x00
61 #define SILC_PACKET_FLAG_PRIVMSG_KEY 0x01
62 #define SILC_PACKET_FLAG_LIST 0x02
63 #define SILC_PACKET_FLAG_BROADCAST 0x04
64 /* Rest of flags still available
65 #define SILC_PACKET_FLAG_XXX 0x08
66 #define SILC_PACKET_FLAG_XXX 0x10
67 #define SILC_PACKET_FLAG_XXX 0x20
68 #define SILC_PACKET_FLAG_XXX 0x40
69 #define SILC_PACKET_FLAG_XXX 0x80
75 In packet sending this is filled and sent to silc_packet_assemble
76 which then uses it to assemble new packet. In packet reception pointer
77 to this context is sent to silc_packet_parse which parses the packet
78 and returns the relevant information to this structure. On packet
79 reception returned ID's are always the hash values of the ID's from
82 Short description of the fields following:
90 Type of the packet. Types are defined below.
94 Packet flags. Flags are defined above.
98 unsigned char src_id_type
100 Source ID, its length and type. On packet reception retuned ID's
101 are always the hash values of the ID's from the packet.
103 unsigned char *dst_id;
105 unsigned char src_id_type;
107 Destination ID, its length and type. On packet reception retuned
108 ID's are always the hash values of the ID's from the packet.
112 Pointer to allocated hash object. This must be MD5 hash object.
113 This is used to calculate checksum of the packet.
119 SilcPacketFlags flags;
121 unsigned char *src_id;
123 unsigned char src_id_type;
125 unsigned char *dst_id;
127 unsigned char dst_id_type;
134 SilcSocketConnection sock;
136 /* Reference count for this context. The context is free'd only
137 after the reference count is zero. */
142 Silc Packet Parser context.
144 This context is used in packet reception when silc_packet_receive_process
145 function calls parser callback that performs the actual packet decryption
146 and parsing. This context is sent as argument to the parser function.
147 This context must be free'd by the parser callback function.
149 Following description of the fields:
151 SilcPacketContext *packet
153 The actual packet received from the network. In this phase the
154 context is not parsed, only the packet->buffer is allocated and
155 it includes the raw packet data, which is encrypted.
157 SilcSocketConnection sock
159 The associated connection.
163 The cipher to be used in the decryption.
167 The HMAC to be used in the decryption.
171 User context that is sent to the silc_packet_receive_process
172 function. This usually includes application and connection specific
178 SilcPacketContext *packet;
179 SilcSocketConnection sock;
183 } SilcPacketParserContext;
185 /* The parser callback function. */
186 typedef void (*SilcPacketParserCallback)(SilcPacketParserContext
189 /* The packet check callback in decryption phase */
190 typedef int (*SilcPacketCheckDecrypt)(SilcPacketType packet_type,
192 SilcPacketContext *packet,
195 /* SILC Packet types. */
196 #define SILC_PACKET_NONE 0 /* NULL, never sent */
197 #define SILC_PACKET_DISCONNECT 1 /* Disconnection */
198 #define SILC_PACKET_SUCCESS 2 /* Success */
199 #define SILC_PACKET_FAILURE 3 /* Failure */
200 #define SILC_PACKET_REJECT 4 /* Rejected */
201 #define SILC_PACKET_NOTIFY 5 /* Notify message */
202 #define SILC_PACKET_ERROR 6 /* Error message */
203 #define SILC_PACKET_CHANNEL_MESSAGE 7 /* Message for channel */
204 #define SILC_PACKET_CHANNEL_KEY 8 /* Key of the channel */
205 #define SILC_PACKET_PRIVATE_MESSAGE 9 /* Private message */
206 #define SILC_PACKET_PRIVATE_MESSAGE_KEY 10 /* Private message key*/
207 #define SILC_PACKET_COMMAND 11 /* Command */
208 #define SILC_PACKET_COMMAND_REPLY 12 /* Reply to a command */
209 #define SILC_PACKET_KEY_EXCHANGE 13 /* Start of KE */
210 #define SILC_PACKET_KEY_EXCHANGE_1 14 /* KE1 */
211 #define SILC_PACKET_KEY_EXCHANGE_2 15 /* KE2 */
212 #define SILC_PACKET_CONNECTION_AUTH_REQUEST 16 /* Request of auth meth */
213 #define SILC_PACKET_CONNECTION_AUTH 17 /* Connectinon auth */
214 #define SILC_PACKET_NEW_ID 18 /* Sending new ID */
215 #define SILC_PACKET_NEW_CLIENT 19 /* Client registering */
216 #define SILC_PACKET_NEW_SERVER 20 /* Server registering */
217 #define SILC_PACKET_NEW_CHANNEL 21 /* Channel registering */
218 #define SILC_PACKET_REKEY 22 /* Re-key start */
219 #define SILC_PACKET_REKEY_DONE 23 /* Re-key done */
220 #define SILC_PACKET_HEARTBEAT 24 /* Heartbeat */
221 #define SILC_PACKET_KEY_AGREEMENT 25 /* Key Agreement request */
222 #define SILC_PACKET_CELL_ROUTERS 26 /* Cell routers backup */
224 #define SILC_PACKET_PRIVATE 200 /* Private range start */
225 #define SILC_PACKET_MAX 255 /* RESERVED */
229 /* Returns true length of the packet and padded length of the packet */
230 #define SILC_PACKET_LENGTH(__packet, __ret_truelen, __ret_padlen) \
232 SILC_GET16_MSB((__ret_truelen), (__packet)->data); \
233 (__ret_padlen) = (((__ret_truelen) - 2) + \
234 SILC_PACKET_MAX_PADLEN) & ~(SILC_PACKET_MAX_PADLEN - 1); \
237 /* Returns pad length of the packet */
238 #define SILC_PACKET_PADLEN(__packetlen) \
239 SILC_PACKET_MAX_PADLEN - ((__packetlen) - 2) % SILC_PACKET_MAX_PADLEN;
242 int silc_packet_write(int sock, SilcBuffer src);
243 int silc_packet_send(SilcSocketConnection sock, int force_send);
244 void silc_packet_encrypt(SilcCipher cipher, SilcHmac hmac,
245 SilcBuffer buffer, uint32 len);
246 void silc_packet_assemble(SilcPacketContext *ctx);
247 void silc_packet_send_prepare(SilcSocketConnection sock,
251 int silc_packet_read(int sock, SilcBuffer dest);
252 int silc_packet_receive(SilcSocketConnection sock);
253 int silc_packet_decrypt(SilcCipher cipher, SilcHmac hmac,
254 SilcBuffer buffer, SilcPacketContext *packet,
255 SilcPacketCheckDecrypt check_packet,
257 void silc_packet_receive_process(SilcSocketConnection sock,
258 SilcCipher cipher, SilcHmac hmac,
259 SilcPacketParserCallback parser,
261 SilcPacketType silc_packet_parse(SilcPacketContext *ctx);
262 SilcPacketType silc_packet_parse_special(SilcPacketContext *ctx);
263 SilcPacketContext *silc_packet_context_alloc();
264 SilcPacketContext *silc_packet_context_dup(SilcPacketContext *ctx);
265 void silc_packet_context_free(SilcPacketContext *ctx);