lib/silccore/silcpacket.h

   1 /*
   2
   3   silcpacket.h
   4
   5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
   6
   7   Copyright (C) 1997 - 2000 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; either version 2 of the License, or
  12   (at your option) any later version.
  13
  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.
  18
  19 */
  20
  21 #ifndef SILCPACKET_H
  22 #define SILCPACKET_H
  23
  24 /* Amount of bytes to be read from the socket connection at once. */
  25 #define SILC_PACKET_READ_SIZE 16384
  26
  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
  30
  31 /* Header length without source and destination ID's. */
  32 #define SILC_PACKET_HEADER_LEN 8 + 2
  33
  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
  36    from the header. */
  37 #define SILC_PACKET_MIN_HEADER_LEN 16 + 2
  38
  39 /* Maximum padding length */
  40 #define SILC_PACKET_MAX_PADLEN 16
  41
  42 /* Minimum packet length */
  43 #define SILC_PACKET_MIN_LEN (SILC_PACKET_HEADER_LEN + 1)
  44
  45 /* Maximum length of ID */
  46 #define SILC_PACKET_MAX_ID_LEN 16
  47
  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;
  52
  53 /* SILC packet version type definition. */
  54 typedef unsigned char SilcPacketVersion;
  55
  56 /* SILC packet flags type definition. */
  57 typedef unsigned char SilcPacketFlags;
  58
  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_FORWARDED        0x02
  63 #define SILC_PACKET_FLAG_BROADCAST        0x04
  64 #define SILC_PACKET_FLAG_TUNNELED         0x08
  65 /* Rest of flags still available
  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
  70 */
  71
  72 /*
  73    SILC packet context.
  74
  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
  80    the packet.
  81
  82    Short description of the fields following:
  83
  84    SilcBuffer buffer
  85
  86        The data buffer.
  87
  88    SilcPacketType type
  89
  90        Type of the packet. Types are defined below.
  91
  92    SilcPacketFlags flags
  93
  94        Packet flags. Flags are defined above.
  95
  96    unsigned char *src_id
  97    unsigned int src_id_len
  98    SilcIdType src_id_type
  99
 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.
 102
 103    SilcHash hash
 104
 105        Pointer to allocated hash object. This must be MD5 hash object.
 106        This is used to calculate checksum of the packet.
 107
 108 */
 109 typedef struct {
 110   SilcBuffer buffer;
 111   SilcPacketType type;
 112   SilcPacketFlags flags;
 113
 114   unsigned char *src_id;
 115   unsigned int src_id_len;
 116   SilcIdType src_id_type;
 117
 118   unsigned char *dst_id;
 119   unsigned int dst_id_len;
 120   SilcIdType dst_id_type;
 121
 122   unsigned int truelen;
 123   unsigned int padlen;
 124
 125   /* For padding generation */
 126   SilcRng rng;
 127 } SilcPacketContext;
 128
 129 /* SILC Packet types. */
 130 #define SILC_PACKET_NONE                 0       /* NULL, never sent */
 131 #define SILC_PACKET_DISCONNECT           1       /* Disconnection */
 132 #define SILC_PACKET_SUCCESS              2       /* Success */
 133 #define SILC_PACKET_FAILURE              3       /* Failure */
 134 #define SILC_PACKET_REJECT               4       /* Rejected */
 135 #define SILC_PACKET_NOTIFY               5       /* Notify message */
 136 #define SILC_PACKET_ERROR                6       /* Error message */
 137 #define SILC_PACKET_CHANNEL_MESSAGE      7       /* Message for channel */
 138 #define SILC_PACKET_CHANNEL_KEY          8       /* Key of the channel */
 139 #define SILC_PACKET_PRIVATE_MESSAGE      9       /* Private message */
 140 #define SILC_PACKET_PRIVATE_MESSAGE_KEY  10      /* Private message key*/
 141 #define SILC_PACKET_COMMAND              11      /* Command */
 142 #define SILC_PACKET_COMMAND_REPLY        12      /* Reply to a command */
 143 #define SILC_PACKET_KEY_EXCHANGE         13      /* Start of KE */
 144 #define SILC_PACKET_KEY_EXCHANGE_1       14      /* KE1 */
 145 #define SILC_PACKET_KEY_EXCHANGE_2       15      /* KE2 */
 146 #define SILC_PACKET_CONNECTION_AUTH_REQUEST 16   /* Request of auth meth */
 147 #define SILC_PACKET_CONNECTION_AUTH      17      /* Connectinon auth */
 148 #define SILC_PACKET_NEW_ID               18      /* Sending new ID */
 149 #define SILC_PACKET_NEW_ID_LIST          19      /* Sending list of them */
 150 #define SILC_PACKET_NEW_CLIENT           20      /* Registering client */
 151 #define SILC_PACKET_NEW_SERVER           21      /* Registering server */
 152 #define SILC_PACKET_NEW_CHANNEL          22      /* Registering channel */
 153 #define SILC_PACKET_NEW_CHANNEL_USER     23      /*   "" user on channel */
 154 #define SILC_PACKET_NEW_CHANNEL_LIST     24      /* List of new channels */
 155 #define SILC_PACKET_NEW_CHANNEL_USER_LIST 25     /* List of users on "" */
 156 #define SILC_PACKET_REPLACE_ID           26      /* To replace old ID */
 157 #define SILC_PACKET_REMOVE_ID            27      /* To remove ID */
 158 /* #define SILC_PACKET_MAX               255 */
 159
 160 /* Macros */
 161
 162 /* Returns true length of the packet and padded length of the packet */
 163 #define SILC_PACKET_LENGTH(__packet, __ret_truelen, __ret_padlen)            \
 164 do {                                                                         \
 165   SILC_GET16_MSB((__ret_truelen), (__packet)->data);                         \
 166   (__ret_padlen) = (((__ret_truelen) - 2) +                                  \
 167                     SILC_PACKET_MAX_PADLEN) & ~(SILC_PACKET_MAX_PADLEN - 1); \
 168 } while(0)
 169
 170 /* Returns pad length of the packet */
 171 #define SILC_PACKET_PADLEN(__packetlen)                                  \
 172   SILC_PACKET_MAX_PADLEN - ((__packetlen) - 2) % SILC_PACKET_MAX_PADLEN;
 173
 174 /* Prototypes */
 175 int silc_packet_write(int sock, SilcBuffer src);
 176 int silc_packet_read(int sock, SilcBuffer dest);
 177 void silc_packet_encrypt(SilcCipher cipher, SilcBuffer buffer,
 178                          unsigned int len);
 179 void silc_packet_decrypt(SilcCipher cipher, SilcBuffer buffer,
 180                          unsigned int len);
 181 SilcPacketType silc_packet_parse(SilcPacketContext *ctx);
 182 SilcPacketType silc_packet_parse_special(SilcPacketContext *ctx);
 183 void silc_packet_assemble(SilcPacketContext *ctx);
 184
 185 #endif