Started implementing protocol version 1.1 and narrowing down

[silc.git] / lib / silccore / silcchannel.h

diff --git a/lib/silccore/silcchannel.h b/lib/silccore/silcchannel.h
index c615d84d9728d28d9993ee7ae0750f1caea8ef86..788ef384cbfdbf6216eb17c0faf793e53a7a85f4 100644 (file)
--- a/lib/silccore/silcchannel.h
+++ b/lib/silccore/silcchannel.h
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcChannelAPI
+/****h* silccore/SILC Channel Interface
  *
  * DESCRIPTION
  *
@@ -91,7 +91,7 @@ typedef struct SilcChannelKeyPayloadStruct *SilcChannelKeyPayload;
  *
  * NAME
  * 
- *    typedef uint16 SilcMessageFlags;
+ *    typedef SilcUInt16 SilcMessageFlags;
  *
  * DESCRIPTION
  *
@@ -101,7 +101,7 @@ typedef struct SilcChannelKeyPayloadStruct *SilcChannelKeyPayload;
  *
  * SOURCE
  */
-typedef uint16 SilcMessageFlags;
+typedef SilcUInt16 SilcMessageFlags;
 
 /* The message flags (shared by both channel and private messages) */
 #define SILC_MESSAGE_FLAG_NONE        0x0000
@@ -111,8 +111,10 @@ typedef uint16 SilcMessageFlags;
 #define SILC_MESSAGE_FLAG_NOTICE      0x0008
 #define SILC_MESSAGE_FLAG_REQUEST     0x0010
 #define SILC_MESSAGE_FLAG_SIGNED      0x0020
-#define SILC_MESSAGE_FLAG_RESERVED    0x0040 /* to 0x0200 */
-#define SILC_MESSAGE_FLAG_PRIVATE     0x0400 /* to 0x8000 */
+#define SILC_MESSAGE_FLAG_REPLY       0x0040
+#define SILC_MESSAGE_FLAG_DATA        0x0080
+#define SILC_MESSAGE_FLAG_RESERVED    0x0100 /* to 0x0800 */
+#define SILC_MESSAGE_FLAG_PRIVATE     0x1000 /* to 0x8000 */
 /***/
 
 /* Prototypes */
@@ -121,7 +123,9 @@ typedef uint16 SilcMessageFlags;
  *
  * SYNOPSIS
  *
- *    SilcChannelPayload silc_channel_payload_parse(SilcBuffer buffer);
+ *    SilcChannelPayload 
+ *    silc_channel_payload_parse(const unsigned char *payload,
+ *                               SilcUInt32 payload_len);
  *
  * DESCRIPTION
  *
@@ -129,13 +133,16 @@ typedef uint16 SilcMessageFlags;
  *    `buffer' is the raw payload buffer.
  *
  ***/
-SilcChannelPayload silc_channel_payload_parse(SilcBuffer buffer);
+SilcChannelPayload silc_channel_payload_parse(const unsigned char *payload,
+                                             SilcUInt32 payload_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_payload_parse_list
  *
  * SYNOPSIS
  *
- *    SilcDList silc_channel_payload_parse_list(SilcBuffer buffer);
+ *    SilcDList
+ *    silc_channel_payload_parse_list(const unsigned char *payload,
+ *                                    SilcUInt32 payload_len);
  *
  * DESCRIPTION
  *
@@ -144,28 +151,29 @@ SilcChannelPayload silc_channel_payload_parse(SilcBuffer buffer);
  *    now includes multiple Channel Payloads one after the other.
  *
  ***/
-SilcDList silc_channel_payload_parse_list(SilcBuffer buffer);
+SilcDList silc_channel_payload_parse_list(const unsigned char *payload,
+                                         SilcUInt32 payload_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_payload_encode
  *
  * SYNOPSIS
  *
- *    SilcBuffer silc_channel_payload_encode(unsigned char *channel_name,
- *                                           uint16 channel_name_len,
- *                                           unsigned char *channel_id,
- *                                           uint32 channel_id_len,
- *                                           uint32 mode);
+ *    SilcBuffer silc_channel_payload_encode(const unsigned char *channel_name,
+ *                                           SilcUInt16 channel_name_len,
+ *                                           const unsigned char *channel_id,
+ *                                           SilcUInt32 channel_id_len,
+ *                                           SilcUInt32 mode);
  *
  * DESCRIPTION
  *
  *    Encode new channel payload and returns it as buffer.
  *
  ***/
-SilcBuffer silc_channel_payload_encode(unsigned char *channel_name,
-                                      uint16 channel_name_len,
-                                      unsigned char *channel_id,
-                                      uint32 channel_id_len,
-                                      uint32 mode);
+SilcBuffer silc_channel_payload_encode(const unsigned char *channel_name,
+                                      SilcUInt16 channel_name_len,
+                                      const unsigned char *channel_id,
+                                      SilcUInt32 channel_id_len,
+                                      SilcUInt32 mode);
 
 /****f* silccore/SilcChannelAPI/silc_channel_payload_free
  *
@@ -198,7 +206,7 @@ void silc_channel_payload_list_free(SilcDList list);
  * SYNOPSIS
  *
  *    unsigned char *silc_channel_get_name(SilcChannelPayload payload,
- *                                         uint32 *channel_name_len);
+ *                                         SilcUInt32 *channel_name_len);
  *
  * DESCRIPTION
  *
@@ -206,14 +214,14 @@ void silc_channel_payload_list_free(SilcDList list);
  *
  ***/
 unsigned char *silc_channel_get_name(SilcChannelPayload payload,
-                                    uint32 *channel_name_len);
+                                    SilcUInt32 *channel_name_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_get_id
  *
  * SYNOPSIS
  *
  *    unsigned char *silc_channel_get_id(SilcChannelPayload payload,
- *                                       uint32 *channel_id_len);
+ *                                       SilcUInt32 *channel_id_len);
  *
  * DESCRIPTION
  *
@@ -221,7 +229,7 @@ unsigned char *silc_channel_get_name(SilcChannelPayload payload,
  *
  ***/
 unsigned char *silc_channel_get_id(SilcChannelPayload payload,
-                                  uint32 *channel_id_len);
+                                  SilcUInt32 *channel_id_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_get_id_parse
  *
@@ -242,7 +250,7 @@ SilcChannelID *silc_channel_get_id_parse(SilcChannelPayload payload);
  *
  * SYNOPSIS
  *
- *    uint32 silc_channel_get_mode(SilcChannelPayload payload);
+ *    SilcUInt32 silc_channel_get_mode(SilcChannelPayload payload);
  *
  * DESCRIPTION
  *
@@ -251,16 +259,16 @@ SilcChannelID *silc_channel_get_id_parse(SilcChannelPayload payload);
  *    dictates what the usage of the mode is in different circumstances.
  *
  ***/
-uint32 silc_channel_get_mode(SilcChannelPayload payload);
+SilcUInt32 silc_channel_get_mode(SilcChannelPayload payload);
 
 /****f* silccore/SilcChannelAPI/silc_channel_message_payload_decrypt
  *
  * SYNOPSIS
  *
- *    int silc_channel_message_payload_decrypt(unsigned char *data,
- *                                             size_t data_len,
- *                                             SilcCipher cipher,
- *                                             SilcHmac hmac);
+ *    bool silc_channel_message_payload_decrypt(unsigned char *data,
+ *                                              size_t data_len,
+ *                                              SilcCipher cipher,
+ *                                              SilcHmac hmac);
  *
  * DESCRIPTION
  *
@@ -279,17 +287,18 @@ uint32 silc_channel_get_mode(SilcChannelPayload payload);
  *    not verified.
  *
  ***/
-int silc_channel_message_payload_decrypt(unsigned char *data,
-                                        size_t data_len,
-                                        SilcCipher cipher,
-                                        SilcHmac hmac);
+bool silc_channel_message_payload_decrypt(unsigned char *data,
+                                         size_t data_len,
+                                         SilcCipher cipher,
+                                         SilcHmac hmac);
 
 /****f* silccore/SilcChannelAPI/silc_channel_message_payload_parse
  *
  * SYNOPSIS
  *
  *    SilcChannelMessagePayload 
- *    silc_channel_message_payload_parse(SilcBuffer buffer,
+ *    silc_channel_message_payload_parse(const unsigned char *payload,
+ *                                       SilcUInt32 payload_len,
  *                                       SilcCipher cipher,
  *                                       SilcHmac hmac);
  *
@@ -304,21 +313,57 @@ int silc_channel_message_payload_decrypt(unsigned char *data,
  *
  ***/
 SilcChannelMessagePayload 
-silc_channel_message_payload_parse(SilcBuffer buffer,
+silc_channel_message_payload_parse(unsigned char *payload,
+                                  SilcUInt32 payload_len,
                                   SilcCipher cipher,
                                   SilcHmac hmac);
 
+/****f* silccore/SilcChannelAPI/silc_channel_message_payload_encrypt
+ *
+ * SYNOPSIS
+ *
+ *    bool silc_channel_message_payload_encrypt(unsigned char *data,
+ *                                              SilcUInt32 data_len,
+ *                                              SilcUInt32 true_len,
+ *                                              unsigned char *iv,
+ *                                              SilcUInt32 iv_len,
+ *                                              SilcCipher cipher,
+ *                                              SilcHmac hmac);
+ *
+ * DESCRIPTION
+ *
+ *    This function is used to encrypt the Channel Messsage Payload which is
+ *    the `data' and `data_len'.  The `data_len' is the data length which is
+ *    used to create MAC out of.  The `true_len' is the true length of `data'
+ *    message payload and is used assemble rest of the packet after MAC
+ *    creation. The `true_len' length packet will then be encrypted.
+ *
+ *    This is usually used by the Channel Message interface itself but can
+ *    be called by the appliation if separate encryption process is required.
+ *    For example server might need to call this directly in some 
+ *    circumstances. The `cipher' is used to encrypt the payload.
+ *
+ ***/
+bool silc_channel_message_payload_encrypt(unsigned char *data,
+                                         SilcUInt32 data_len,
+                                         SilcUInt32 true_len,
+                                         unsigned char *iv,
+                                         SilcUInt32 iv_len,
+                                         SilcCipher cipher,
+                                         SilcHmac hmac);
+
 /****f* silccore/SilcChannelAPI/silc_channel_message_payload_encode
  *
  * SYNOPSIS
  *
- *    SilcBuffer silc_channel_message_payload_encode(uint16 flags,
- *                                                   uint16 data_len,
- *                                                   unsigned char *data,
- *                                                   uint16 iv_len,
+ *    SilcBuffer silc_channel_message_payload_encode(SilcUInt16 flags,
+ *                                                   SilcUInt16 data_len,
+ *                                                   const unsigned char *data,
+ *                                                   SilcUInt16 iv_len,
  *                                                   unsigned char *iv,
  *                                                   SilcCipher cipher,
- *                                                   SilcHmac hmac);
+ *                                                   SilcHmac hmac.
+ *                                                   SilcRng rng);
  *
  * DESCRIPTION
  *
@@ -328,16 +373,18 @@ silc_channel_message_payload_parse(SilcBuffer buffer,
  *    must be applied to the payload. The function generates the padding
  *    automatically from random data.  The `cipher' is the cipher used
  *    encrypt the payload and `hmac' is used to compute the MAC for the
- *    payload.
+ *    payload.  If `rng' is NULL then global RNG is used, if non-NULL then
+ *    the `rng' is used.
  *
  ***/
-SilcBuffer silc_channel_message_payload_encode(uint16 flags,
-                                              uint16 data_len,
-                                              unsigned char *data,
-                                              uint16 iv_len,
+SilcBuffer silc_channel_message_payload_encode(SilcUInt16 flags,
+                                              SilcUInt16 data_len,
+                                              const unsigned char *data,
+                                              SilcUInt16 iv_len,
                                               unsigned char *iv,
                                               SilcCipher cipher,
-                                              SilcHmac hmac);
+                                              SilcHmac hmac,
+                                              SilcRng rng);
 
 /****f* silccore/SilcChannelAPI/silc_channel_message_payload_free
  *
@@ -374,7 +421,7 @@ silc_channel_message_get_flags(SilcChannelMessagePayload payload);
  *
  *    unsigned char *
  *    silc_channel_message_get_data(SilcChannelMessagePayload payload,
- *                                  uint32 *data_len);
+ *                                  SilcUInt32 *data_len);
  *
  * DESCRIPTION
  *
@@ -383,7 +430,7 @@ silc_channel_message_get_flags(SilcChannelMessagePayload payload);
  *
  ***/
 unsigned char *silc_channel_message_get_data(SilcChannelMessagePayload payload,
-                                    uint32 *data_len);
+                                            SilcUInt32 *data_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_message_get_mac
  *
@@ -419,7 +466,9 @@ unsigned char *silc_channel_message_get_iv(SilcChannelMessagePayload payload);
  *
  * SYNOPSIS
  *
- *    SilcChannelKeyPayload silc_channel_key_payload_parse(SilcBuffer buffer);
+ *    SilcChannelKeyPayload 
+ *    silc_channel_key_payload_parse(const unsigned char *payload,
+ *                                   uin32 payload_len);
  *
  * DESCRIPTION
  *
@@ -427,18 +476,20 @@ unsigned char *silc_channel_message_get_iv(SilcChannelMessagePayload payload);
  *     structure.
  *
  ***/
-SilcChannelKeyPayload silc_channel_key_payload_parse(SilcBuffer buffer);
+SilcChannelKeyPayload 
+silc_channel_key_payload_parse(const unsigned char *payload,
+                              SilcUInt32 payload_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_key_payload_encode
  *
  * SYNOPSIS
  *
- *    SilcBuffer silc_channel_key_payload_encode(uint16 id_len,
- *                                               unsigned char *id,
- *                                               uint16 cipher_len,
- *                                               unsigned char *cipher,
- *                                               uint16 key_len,
- *                                               unsigned char *key);
+ *    SilcBuffer silc_channel_key_payload_encode(SilcUInt16 id_len,
+ *                                               const unsigned char *id,
+ *                                               SilcUInt16 cipher_len,
+ *                                               const unsigned char *cipher,
+ *                                               SilcUInt16 key_len,
+ *                                               const unsigned char *key);
  *
  * DESCRIPTION
  *
@@ -446,12 +497,12 @@ SilcChannelKeyPayload silc_channel_key_payload_parse(SilcBuffer buffer);
  *    to add channel key payload into a packet.
  *
  ***/
-SilcBuffer silc_channel_key_payload_encode(uint16 id_len,
-                                          unsigned char *id,
-                                          uint16 cipher_len,
-                                          unsigned char *cipher,
-                                          uint16 key_len,
-                                          unsigned char *key);
+SilcBuffer silc_channel_key_payload_encode(SilcUInt16 id_len,
+                                          const unsigned char *id,
+                                          SilcUInt16 cipher_len,
+                                          const unsigned char *cipher,
+                                          SilcUInt16 key_len,
+                                          const unsigned char *key);
 
 /****f* silccore/SilcChannelAPI/silc_channel_key_payload_free
  *
@@ -471,7 +522,7 @@ void silc_channel_key_payload_free(SilcChannelKeyPayload payload);
  * SYNOPSIS
  *
  *    unsigned char *silc_channel_key_get_id(SilcChannelKeyPayload payload, 
- *                                           uint32 *id_len);
+ *                                           SilcUInt32 *id_len);
  *
  * DESCRIPTION
  *
@@ -480,14 +531,14 @@ void silc_channel_key_payload_free(SilcChannelKeyPayload payload);
  *
  ***/
 unsigned char *silc_channel_key_get_id(SilcChannelKeyPayload payload, 
-                                      uint32 *id_len);
+                                      SilcUInt32 *id_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_key_get_cipher
  *
  * SYNOPSIS
  *
  *    unsigned char *silc_channel_key_get_cipher(SilcChannelKeyPayload payload,
- *                                               uint32 *cipher_len);
+ *                                               SilcUInt32 *cipher_len);
  *
  * DESCRIPTION
  *
@@ -496,14 +547,14 @@ unsigned char *silc_channel_key_get_id(SilcChannelKeyPayload payload,
  *
  ***/
 unsigned char *silc_channel_key_get_cipher(SilcChannelKeyPayload payload,
-                                          uint32 *cipher_len);
+                                          SilcUInt32 *cipher_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_key_get_key
  *
  * SYNOPSIS
  *
  *    unsigned char *silc_channel_key_get_key(SilcChannelKeyPayload payload,
- *                                            uint32 *key_len);
+ *                                            SilcUInt32 *key_len);
  *
  * DESCRIPTION
  *
@@ -512,6 +563,6 @@ unsigned char *silc_channel_key_get_cipher(SilcChannelKeyPayload payload,
  *
  ***/
 unsigned char *silc_channel_key_get_key(SilcChannelKeyPayload payload,
-                                       uint32 *key_len);
+                                       SilcUInt32 *key_len);
 
 #endif