structure memory optimizations.
[silc.git] / lib / silccore / silcpacket.h
1 /*
2
3   silcpacket.h 
4
5   Author: Pekka Riikonen <priikone@silcnet.org>
6
7   Copyright (C) 1997 - 2001 Pekka Riikonen
8
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.
12
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.
17
18 */
19
20 /****h* silccore/Packet Protocol Interface
21  *
22  * DESCRIPTION
23  *
24  * Implementation of the packet routines for sending and receiving
25  * SILC Packets. These includes the data sending routines and data
26  * reading routines, encrypting and decrypting routines, packet assembling
27  * and packet parsing routines.
28  *
29  ***/
30
31 #ifndef SILCPACKET_H
32 #define SILCPACKET_H
33
34 /* Default byte size of the packet. */
35 #define SILC_PACKET_DEFAULT_SIZE SILC_SOCKET_BUF_SIZE
36
37 /* Header length without source and destination ID's. */
38 #define SILC_PACKET_HEADER_LEN 10
39
40 /* Minimum length of SILC Packet Header. This much is decrypted always
41    when packet is received to be able to get all the relevant data out
42    from the header. */
43 #define SILC_PACKET_MIN_HEADER_LEN 16
44
45 /* Maximum padding length */
46 #define SILC_PACKET_MAX_PADLEN 128
47
48 /* Default padding length */
49 #define SILC_PACKET_DEFAULT_PADLEN 16
50
51 /* Minimum packet length */
52 #define SILC_PACKET_MIN_LEN (SILC_PACKET_HEADER_LEN + 1)
53
54 /* Maximum packet length */
55 #define SILC_PACKET_MAX_LEN 0xffff
56
57 /* Maximum length of ID */
58 #define SILC_PACKET_MAX_ID_LEN 28
59
60 /****d* silccore/SilcPacketAPI/SilcPacketType
61  *
62  * NAME
63  * 
64  *    typedef unsigned char SilcPacketType;
65  *
66  * DESCRIPTION
67  *
68  *    SILC packet type definition and all the packet types.
69  *
70  * SOURCE
71  */
72 typedef unsigned char SilcPacketType;
73
74 /* SILC Packet types. */
75 #define SILC_PACKET_NONE                 0       /* NULL, never sent */
76 #define SILC_PACKET_DISCONNECT           1       /* Disconnection */
77 #define SILC_PACKET_SUCCESS              2       /* Success */
78 #define SILC_PACKET_FAILURE              3       /* Failure */
79 #define SILC_PACKET_REJECT               4       /* Rejected */
80 #define SILC_PACKET_NOTIFY               5       /* Notify message */
81 #define SILC_PACKET_ERROR                6       /* Error message */
82 #define SILC_PACKET_CHANNEL_MESSAGE      7       /* Message for channel */
83 #define SILC_PACKET_CHANNEL_KEY          8       /* Key of the channel */
84 #define SILC_PACKET_PRIVATE_MESSAGE      9       /* Private message */
85 #define SILC_PACKET_PRIVATE_MESSAGE_KEY  10      /* Private message key*/
86 #define SILC_PACKET_COMMAND              11      /* Command */
87 #define SILC_PACKET_COMMAND_REPLY        12      /* Reply to a command */
88 #define SILC_PACKET_KEY_EXCHANGE         13      /* Start of KE */
89 #define SILC_PACKET_KEY_EXCHANGE_1       14      /* KE1 */
90 #define SILC_PACKET_KEY_EXCHANGE_2       15      /* KE2 */
91 #define SILC_PACKET_CONNECTION_AUTH_REQUEST 16   /* Request of auth meth */
92 #define SILC_PACKET_CONNECTION_AUTH      17      /* Connectinon auth */
93 #define SILC_PACKET_NEW_ID               18      /* Sending new ID */
94 #define SILC_PACKET_NEW_CLIENT           19      /* Client registering */
95 #define SILC_PACKET_NEW_SERVER           20      /* Server registering */
96 #define SILC_PACKET_NEW_CHANNEL          21      /* Channel registering */
97 #define SILC_PACKET_REKEY                22      /* Re-key start */
98 #define SILC_PACKET_REKEY_DONE           23      /* Re-key done */
99 #define SILC_PACKET_HEARTBEAT            24      /* Heartbeat */
100 #define SILC_PACKET_KEY_AGREEMENT        25      /* Key Agreement request */
101 #define SILC_PACKET_RESUME_ROUTER        26      /* Backup router resume */
102 #define SILC_PACKET_FTP                  27      /* File Transfer */
103
104 #define SILC_PACKET_PRIVATE              200     /* Private range start  */
105 #define SILC_PACKET_MAX                  255     /* RESERVED */
106 /***/
107
108 /****d* silccore/SilcPacketAPI/SilcPacketVersion
109  *
110  * NAME
111  * 
112  *    typedef unsigned char SilcPacketVersion;
113  *
114  * DESCRIPTION
115  *
116  *    SILC packet version type definition.
117  *
118  ***/
119 typedef unsigned char SilcPacketVersion;
120
121 /****d* silccore/SilcPacketAPI/SilcPacketFlags
122  *
123  * NAME
124  * 
125  *    typedef unsigned char SilcPacketFlags;
126  *
127  * DESCRIPTION
128  *
129  *    SILC packet flags type definition and all the packet flags.
130  *
131  * SOURCE
132  */
133 typedef unsigned char SilcPacketFlags;
134
135 /* All defined packet flags */
136 #define SILC_PACKET_FLAG_NONE             0x00    /* No flags */
137 #define SILC_PACKET_FLAG_PRIVMSG_KEY      0x01    /* Private message key */
138 #define SILC_PACKET_FLAG_LIST             0x02    /* Packet is a list */
139 #define SILC_PACKET_FLAG_BROADCAST        0x04    /* Packet is a broadcast */
140 /***/
141
142 /* Rest of flags still available
143 #define SILC_PACKET_FLAG_XXX              0x08
144 #define SILC_PACKET_FLAG_XXX              0x10
145 #define SILC_PACKET_FLAG_XXX              0x20
146 #define SILC_PACKET_FLAG_XXX              0x40
147 #define SILC_PACKET_FLAG_XXX              0x80
148 */
149
150 /****s* silccore/SilcPacketAPI/SilcPacketContext
151  *
152  * NAME
153  * 
154  *    typedef struct { ... } SilcPacketContext;
155  *
156  * DESCRIPTION
157  *
158  *    In packet sending this is filled and sent to silc_packet_assemble 
159  *    which then uses it to assemble new packet. In packet reception pointer 
160  *    to this context is sent to silc_packet_parse which parses the packet 
161  *    and returns the relevant information to this structure. On packet 
162  *    reception returned ID's are always the hash values of the ID's from 
163  *    the packet. 
164  *
165  *    Short description of the fields following:
166  *
167  *    SilcUInt16 truelen
168  *
169  *      True length of the packet.  This may be set by the caller before
170  *      calling any of the silc_packet_* routines.  If not provided the
171  *      library will calculate the values.
172  *
173  *    SilcPacketFlags flags
174  *
175  *      Packet flags. Flags are defined above.
176  *
177  *    SilcPacketType type
178  *
179  *      Type of the packet. Types are defined below.
180  *
181  *    unsigned char *src_id
182  *    SilcUInt8 src_id_len
183  *    unsigned char src_id_type
184  *
185  *      Source ID, its length and type. On packet reception retuned ID's
186  *      are always the hash values of the ID's from the packet.
187  *
188  *    unsigned char *dst_id;
189  *    SilcUInt8 dst_id_len;
190  *    unsigned char src_id_type;
191  *
192  *      Destination ID, its length and type. On packet reception retuned
193  *      ID's are always the hash values of the ID's from the packet.
194  *
195  *    SilcUInt8 padlen
196  *
197  *      The padded length of the packet.  This may be set by the caller
198  *      before calling any of the silc_packet_* routines. If not provided
199  *      the library will calculate the values.
200  *
201  *    unsigned int long_pad
202  * 
203  *      If set to TRUE the packet will include the maximum padding allowed
204  *      in SILC packet, which is 128 bytes.  If FALSE only the amount of
205  *      padding needed will be applied.
206  *
207  *    unsigned int users;
208  *
209  *      Reference counter for this context. The context is freed only 
210  *      after the reference counter hits zero. The counter is added
211  *      calling silc_packet_context_dup and decreased by calling the
212  *      silc_packet_context_free.
213  *
214  *    SilcUInt32 sequence;
215  *
216  *      Packet sequence number.
217  *
218  *    SilcBuffer buffer
219  *
220  *      The actual packet data.
221  *
222  ***/
223 typedef struct {
224   SilcUInt16 truelen;
225   SilcPacketFlags flags;
226   SilcPacketType type;
227
228   unsigned char *src_id;
229   unsigned char *dst_id;
230   SilcUInt8 src_id_len;
231   SilcUInt8 src_id_type;
232   SilcUInt8 dst_id_len;
233   SilcUInt8 dst_id_type;
234
235   SilcUInt8 padlen;
236   unsigned int long_pad : 1;    /* Set when maximum padding in packet */
237   unsigned int users : 23;      /* Reference counter */
238
239   SilcUInt32 sequence;
240   SilcBuffer buffer;
241 } SilcPacketContext;
242
243 /****s* silccore/SilcPacketAPI/SilcPacketParserContext
244  *
245  * NAME
246  * 
247  *    typedef struct { ... } SilcPacketParserContext;
248  *
249  * DESCRIPTION
250  *
251  *    This context is used in packet reception when the function
252  *    silc_packet_receive_process calls parser callback that performs
253  *    the actual packet decryption and parsing. This context is sent as
254  *    argument to the parser function. This context must be free'd by
255  *    the parser callback function.
256  *
257  *    Following description of the fields:
258  *
259  *    SilcPacketContext *packet
260  *
261  *      The actual packet received from the network. In this phase the
262  *      context is not parsed, only the packet->buffer is allocated and
263  *      it includes the raw packet data, which is encrypted.
264  *
265  *    bool normal
266  *
267  *      Indicates whether the received packet is normal or special packet.
268  *      If special the parsing process is special also.
269  *
270  *    SilcSocketConnection sock
271  *
272  *      The associated connection.
273  *
274  *    void *context
275  *
276  *      User context that is sent to the silc_packet_receive_process
277  *      function. This usually includes application and connection specific
278  *      data.
279  *
280  ***/
281 typedef struct {
282   SilcPacketContext *packet;
283   bool normal;
284   SilcSocketConnection sock;
285   void *context;
286 } SilcPacketParserContext;
287
288 /****f* silccore/SilcPacketAPI/SilcPacketParserCallback
289  *
290  * SYNOPSIS
291  *
292  *    typedef bool (*SilcPacketParserCallback)(SilcPacketParserContext 
293  *                                             *parse_context);
294  *
295  * DESCRIPTION
296  *
297  *    This callback is given to the silc_packet_receive_process function.
298  *    The callback is called by the library every time a packet is
299  *    received from the network. After the packet has been decrypted
300  *    and at least partially parsed it is passed to the application
301  *    for further parsing using this callback and the SilcPacketParserContext
302  *    context. The application receiving the SilcPacketParserContext
303  *    must free it.
304  *
305  *    This returns TRUE if the library should continue packet processing
306  *    (assuming there is more data to be processed), and FALSE if the
307  *    upper layer does not want the library to continue but to leave the
308  *    rest of the data is the packet queue untouched.  Application may
309  *    want to do this for example if the cipher is not ready before 
310  *    processing a certain packet.  In this case the application wants
311  *    to recall the processing function with the correct cipher.
312  *
313  ***/
314 typedef bool (*SilcPacketParserCallback)(SilcPacketParserContext 
315                                          *parse_context, void *context);
316
317 /* Macros */
318
319 /****d* silccore/SilcPacketAPI/SILC_PACKET_LENGTH
320  *
321  * NAME
322  * 
323  *    #define SILC_PACKET_LENGTH ...
324  *
325  * DESCRIPTION
326  *
327  *    Returns true length of the packet. This is primarily used by the
328  *    libary in packet parsing phase but the application may use it as
329  *    well if needed.
330  *
331  * SOURCE
332  */
333 #define SILC_PACKET_LENGTH(__packet, __ret_truelen, __ret_paddedlen)    \
334 do {                                                                    \
335   SILC_GET16_MSB((__ret_truelen), (__packet)->data);                    \
336   (__ret_paddedlen) = (__ret_truelen) + (__packet)->data[4];            \
337 } while(0)
338 /***/
339
340 /****d* silccore/SilcPacketAPI/SILC_PACKET_DATALEN
341  *
342  * NAME
343  * 
344  *    #define SILC_PACKET_DATALEN ...
345  *
346  * DESCRIPTION
347  *
348  *    Calculates the data length with given header length.  This macro
349  *    can be used to check whether the data_len with header_len exceeds
350  *    SILC_PACKET_MAX_LEN.  If it does, this returns the new data_len
351  *    so that the SILC_PACKET_MAX_LEN is not exceeded.  If the data_len
352  *    plus header_len fits SILC_PACKET_MAX_LEN the returned data length
353  *    is the data_len given as argument.  This macro can be used when
354  *    assembling packet.
355  *
356  * SOURCE
357  */
358 #define SILC_PACKET_DATALEN(data_len, header_len)                         \
359   ((data_len + header_len) > SILC_PACKET_MAX_LEN ?                        \
360    data_len - ((data_len + header_len) - SILC_PACKET_MAX_LEN) : data_len)
361 /***/
362
363 /****d* silccore/SilcPacketAPI/SILC_PACKET_PADLEN
364  *
365  * NAME
366  * 
367  *    #define SILC_PACKET_PADLEN ...
368  *
369  * DESCRIPTION
370  *
371  *    Returns the length of the padding in the packet. This is used
372  *    by various library routines to determine needed padding length.
373  *
374  * SOURCE
375  */
376 #define SILC_PACKET_PADLEN(__packetlen, __blocklen)             \
377   SILC_PACKET_DEFAULT_PADLEN - (__packetlen) %                  \
378     ((__blocklen) ? (__blocklen) : SILC_PACKET_DEFAULT_PADLEN)
379 /***/
380
381 /****d* silccore/SilcPacketAPI/SILC_PACKET_PADLEN_MAX
382  *
383  * NAME
384  * 
385  *    #define SILC_PACKET_PADLEN_MAX ...
386  *
387  * DESCRIPTION
388  *
389  *    Returns the length of the padding up to the maximum length, which
390  *    is 128 butes. This is used by various library routines to determine
391  *    needed padding length.
392  *
393  * SOURCE
394  */
395 #define SILC_PACKET_PADLEN_MAX(__packetlen)                             \
396   SILC_PACKET_MAX_PADLEN - (__packetlen) % SILC_PACKET_MAX_PADLEN
397 /***/
398
399 /* Prototypes */
400
401 /****f* silccore/SilcPacketAPI/silc_packet_send
402  *
403  * SYNOPSIS
404  *
405  *    int silc_packet_send(SilcSocketConnection sock, bool force_send);
406  *
407  * DESCRIPTION
408  *
409  *    Actually sends the packet. This flushes the connections outgoing data
410  *    buffer. If data is sent directly to the network this returns the bytes
411  *    written, if error occured this returns -1 and if the data could not
412  *    be written directly to the network at this time this returns -2, in
413  *    which case the data should be queued by the caller and sent at some
414  *    later time. If `force_send' is TRUE this attempts to write the data
415  *    directly to the network, if FALSE, this returns -2.
416  *
417  ***/
418 int silc_packet_send(SilcSocketConnection sock, bool force_send);
419
420 /****f* silccore/SilcPacketAPI/silc_packet_encrypt
421  *
422  * SYNOPSIS
423  *
424  *    void silc_packet_encrypt(SilcCipher cipher, SilcHmac hmac, 
425  *                             SilcBuffer buffer, SilcUInt32 len);
426  *
427  * DESCRIPTION
428  *
429  *    Encrypts a packet. This also creates HMAC of the packet before 
430  *    encryption and adds the HMAC at the end of the buffer. This assumes
431  *    that there is enough free space at the end of the buffer to add the
432  *    computed HMAC. This is the normal way of encrypting packets, if some
433  *    other process of HMAC computing and encryption is needed this function
434  *    cannot be used. 
435  *
436  ***/
437 void silc_packet_encrypt(SilcCipher cipher, SilcHmac hmac, SilcUInt32 sequence,
438                          SilcBuffer buffer, SilcUInt32 len);
439
440 /****f* silccore/SilcPacketAPI/silc_packet_assemble
441  *
442  * SYNOPSIS
443  *
444  *    bool silc_packet_assemble(SilcPacketContext *packet, SilcRng rng,
445  *                              SilcCipher cipher, SilcHmac hmac,
446  *                              SilcSocketConnection sock,
447  *                              const unsigned char *data, SilcUInt32 data_len,
448  *                              const SilcBuffer assembled_packet);
449  *
450  * DESCRIPTION
451  *
452  *    Assembles new packet to be ready for encrypting and sending out.
453  *    The `packet' is filled by caller to include the packet header specific
454  *    values.  This prepares the socket connection's `sock' outoing buffer
455  *    for sending data, and returns the assembled packet to the 
456  *    `assembled_packet' pointer sent by the caller.  The `assembled_packet'
457  *    is a reference to the socket connection's outgoing buffer.  The
458  *    returned packet can be encrypted, and then sent to network by calling
459  *    silc_packet_send function.  The `assembled_packet' may be freely
460  *    modified (like encrypted etc.) but it must not be freed, since it is
461  *    reference from `sock' outgoing buffer, and it is const.
462  *
463  ***/
464 bool silc_packet_assemble(SilcPacketContext *packet, SilcRng rng,
465                           SilcCipher cipher, SilcHmac hmac,
466                           SilcSocketConnection sock,
467                           const unsigned char *data, SilcUInt32 data_len,
468                           const SilcBuffer assembled_packet);
469
470 /****f* silccore/SilcPacketAPI/silc_packet_send_prepare
471  *
472  * SYNOPSIS
473  *
474  *    bool silc_packet_send_prepare(SilcSocketConnection sock,
475  *                                  SilcUInt32 header_len,
476  *                                  SilcUInt32 pad_len,
477  *                                  SilcUInt32 data_len,
478  *                                  SilcHmac hmac,
479  *                                  const SilcBuffer packet);
480  *
481  * DESCRIPTION
482  *
483  *    This function can be used to prepare the outgoing data buffer in
484  *    the socket connection specified by `sock' for packet sending.
485  *    This is used internally by packet sending routines, but application
486  *    may call this if it doesn't call silc_packet_assemble function.
487  *    If that function is called then application must not call this since
488  *    that function calls this internally.
489  *
490  *    This returns the prepared data area into the `packet' pointer provided
491  *    caller, which can be used then to add data to it, and later encrypt
492  *    it.  The `packet' includes reference to the socket connection's
493  *    outgoing buffer.  The `packet' may be freely modified (like 
494  *    encrypted etc.) but it must not be freed, since it is reference from 
495  *    `sock' outgoing buffer, and it is const.
496  *
497  ***/
498 bool silc_packet_send_prepare(SilcSocketConnection sock,
499                               SilcUInt32 header_len,
500                               SilcUInt32 pad_len,
501                               SilcUInt32 data_len,
502                               SilcHmac hmac,
503                               const SilcBuffer packet);
504
505 /****f* silccore/SilcPacketAPI/silc_packet_receive
506  *
507  * SYNOPSIS
508  *
509  *    int silc_packet_receive(SilcSocketConnection sock);
510  *
511  * DESCRIPTION
512  *
513  *    Receives packet from network and reads the data into connection's
514  *    incoming data buffer. If the data was read directly this returns the
515  *    read bytes, if error occured this returns -1, if the data could not
516  *    be read directly at this time this returns -2 in which case the data
517  *    should be read again at some later time, or If EOF occured this returns
518  *    0.
519  *
520  ***/
521 int silc_packet_receive(SilcSocketConnection sock);
522
523 /****f* silccore/SilcPacketAPI/silc_packet_receive_process
524  *
525  * SYNOPSIS
526  *
527  *    bool silc_packet_receive_process(SilcSocketConnection sock,
528  *                                     bool local_is_router,
529  *                                     SilcCipher cipher, SilcHmac hmac,
530  *                                     SilcPacketParserCallback parser,
531  *                                     void *parser_context);
532  *
533  * DESCRIPTION
534  *
535  *    Processes and decrypts the incoming data, and calls parser callback
536  *    for each received packet that will handle the actual packet parsing.
537  *    If more than one packet was received this calls the parser multiple
538  *    times.  The parser callback will get context SilcPacketParserContext
539  *    that includes the packet and the `parser_context' sent to this
540  *    function. 
541  *
542  *    The `local_is_router' indicates whether the caller is router server
543  *    in which case the receiving process of a certain packet types may
544  *    be special.  Normal server and client must set it to FALSE.  The
545  *    SilcPacketParserContext will indicate also whether the received
546  *    packet was normal or special packet.
547  *
548  ***/
549 bool silc_packet_receive_process(SilcSocketConnection sock,
550                                  bool local_is_router,
551                                  SilcCipher cipher, SilcHmac hmac,
552                                  SilcUInt32 sequence,
553                                  SilcPacketParserCallback parser,
554                                  void *parser_context);
555
556 /****f* silccore/SilcPacketAPI/silc_packet_parse
557  *
558  * SYNOPSIS
559  *
560  *    SilcPacketType silc_packet_parse(SilcPacketContext *ctx);
561  *
562  * DESCRIPTION
563  *
564  *    Parses the packet. This is called when a whole packet is ready to be
565  *    parsed. The buffer sent must be already decrypted before calling this 
566  *    function. The len argument must be the true length of the packet. This 
567  *    function returns the type of the packet. The data section of the 
568  *    buffer is parsed, not head or tail sections.
569  *
570  ***/
571 SilcPacketType silc_packet_parse(SilcPacketContext *ctx, SilcCipher cipher);
572
573 /****f* silccore/SilcPacketAPI/silc_packet_parse_special
574  *
575  * SYNOPSIS
576  *
577  *    SilcPacketType silc_packet_parse_special(SilcPacketContext *ctx);
578  *
579  * DESCRIPTION
580  *
581  *    Perform special SILC Packet header parsing. This is required to some
582  *    packet types that have the data payload encrypted with different key
583  *    than the header area plus padding of the packet. Hence, this parses
584  *    the header in a way that it does not take the data area into account
585  *    and parses the header and padding area only.
586  *
587  ***/
588 SilcPacketType silc_packet_parse_special(SilcPacketContext *ctx,
589                                          SilcCipher cipher);
590
591 /****f* silccore/SilcPacketAPI/silc_packet_context_alloc
592  *
593  * SYNOPSIS
594  *
595  *    SilcPacketContext *silc_packet_context_alloc();
596  *
597  * DESCRIPTION
598  *
599  *    Allocates a packet context. Packet contexts are used when 
600  *    packets are assembled and parsed. The context is freed by the
601  *    silc_packet_context_free function.
602  *
603  ***/
604 SilcPacketContext *silc_packet_context_alloc(void);
605
606 /****f* silccore/SilcPacketAPI/silc_packet_context_dup
607  *
608  * SYNOPSIS
609  *
610  *    SilcPacketContext *silc_packet_context_dup(SilcPacketContext *ctx);
611  *
612  * DESCRIPTION
613  *
614  *    Duplicates the packet context. It actually does not duplicate
615  *    any data, instead a reference counter is increased.
616  *
617  ***/
618 SilcPacketContext *silc_packet_context_dup(SilcPacketContext *ctx);
619
620 /****f* silccore/SilcPacketAPI/silc_packet_context_free
621  *
622  * SYNOPSIS
623  *
624  *    void silc_packet_context_free(SilcPacketContext *ctx);
625  *
626  * DESCRIPTION
627  *
628  *    Frees the packet context. The context is actually freed when the
629  *    reference counter hits zero.
630  *
631  ***/
632 void silc_packet_context_free(SilcPacketContext *ctx);
633
634 #endif