projects / silc.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Protocol version 1.2 integrations
[silc.git] / lib / silccore / silcchannel.h
diff --git a/lib/silccore/silcchannel.h b/lib/silccore/silcchannel.h
index 1db0c7b0e491fcbb911e38272c3bbb08e007bac2..23dfccf1db2b87714e385557ba012feb8d384c1e 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,18 +101,21 @@ 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
-#define SILC_MESSAGE_FLAG_AUTOREPLY   0x0001
-#define SILC_MESSAGE_FLAG_NOREPLY     0x0002
-#define SILC_MESSAGE_FLAG_ACTION      0x0004
-#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_NONE        0x0000      /* No flags */
+#define SILC_MESSAGE_FLAG_AUTOREPLY   0x0001     /* Automatically replied */
+#define SILC_MESSAGE_FLAG_NOREPLY     0x0002     /* Send no reply to this */
+#define SILC_MESSAGE_FLAG_ACTION      0x0004     /* Action message */
+#define SILC_MESSAGE_FLAG_NOTICE      0x0008     /* Notice message */
+#define SILC_MESSAGE_FLAG_REQUEST     0x0010     /* A request */
+#define SILC_MESSAGE_FLAG_SIGNED      0x0020     /* Message is signed */
+#define SILC_MESSAGE_FLAG_REPLY       0x0040     /* A reply */
+#define SILC_MESSAGE_FLAG_DATA        0x0080     /* MIME object */
+#define SILC_MESSAGE_FLAG_UTF8        0x0100     /* UTF-8 string */
+#define SILC_MESSAGE_FLAG_RESERVED    0x0200     /* to 0x0800 */
+#define SILC_MESSAGE_FLAG_PRIVATE     0x1000     /* to 0x8000 */
 /***/
 
 /* Prototypes */
@@ -123,7 +126,7 @@ typedef uint16 SilcMessageFlags;
  *
  *    SilcChannelPayload 
  *    silc_channel_payload_parse(const unsigned char *payload,
- *                               uint32 payload_len);
+ *                               SilcUInt32 payload_len);
  *
  * DESCRIPTION
  *
@@ -132,7 +135,7 @@ typedef uint16 SilcMessageFlags;
  *
  ***/
 SilcChannelPayload silc_channel_payload_parse(const unsigned char *payload,
-                                             uint32 payload_len);
+                                             SilcUInt32 payload_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_payload_parse_list
  *
@@ -140,7 +143,7 @@ SilcChannelPayload silc_channel_payload_parse(const unsigned char *payload,
  *
  *    SilcDList
  *    silc_channel_payload_parse_list(const unsigned char *payload,
- *                                    uint32 payload_len);
+ *                                    SilcUInt32 payload_len);
  *
  * DESCRIPTION
  *
@@ -150,17 +153,17 @@ SilcChannelPayload silc_channel_payload_parse(const unsigned char *payload,
  *
  ***/
 SilcDList silc_channel_payload_parse_list(const unsigned char *payload,
-                                         uint32 payload_len);
+                                         SilcUInt32 payload_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_payload_encode
  *
  * SYNOPSIS
  *
  *    SilcBuffer silc_channel_payload_encode(const unsigned char *channel_name,
- *                                           uint16 channel_name_len,
+ *                                           SilcUInt16 channel_name_len,
  *                                           const unsigned char *channel_id,
- *                                           uint32 channel_id_len,
- *                                           uint32 mode);
+ *                                           SilcUInt32 channel_id_len,
+ *                                           SilcUInt32 mode);
  *
  * DESCRIPTION
  *
@@ -168,10 +171,10 @@ SilcDList silc_channel_payload_parse_list(const unsigned char *payload,
  *
  ***/
 SilcBuffer silc_channel_payload_encode(const unsigned char *channel_name,
-                                      uint16 channel_name_len,
+                                      SilcUInt16 channel_name_len,
                                       const unsigned char *channel_id,
-                                      uint32 channel_id_len,
-                                      uint32 mode);
+                                      SilcUInt32 channel_id_len,
+                                      SilcUInt32 mode);
 
 /****f* silccore/SilcChannelAPI/silc_channel_payload_free
  *
@@ -204,7 +207,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
  *
@@ -212,14 +215,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
  *
@@ -227,7 +230,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
  *
@@ -248,7 +251,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
  *
@@ -257,7 +260,7 @@ 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
  *
@@ -296,7 +299,7 @@ bool silc_channel_message_payload_decrypt(unsigned char *data,
  *
  *    SilcChannelMessagePayload 
  *    silc_channel_message_payload_parse(const unsigned char *payload,
- *                                       uint32 payload_len,
+ *                                       SilcUInt32 payload_len,
  *                                       SilcCipher cipher,
  *                                       SilcHmac hmac);
  *
@@ -312,21 +315,56 @@ bool silc_channel_message_payload_decrypt(unsigned char *data,
  ***/
 SilcChannelMessagePayload 
 silc_channel_message_payload_parse(unsigned char *payload,
-                                  uint32 payload_len,
+                                  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,
+ *    SilcBuffer silc_channel_message_payload_encode(SilcMessageFlags flags,
+ *                                                   SilcUInt16 data_len,
  *                                                   const unsigned char *data,
- *                                                   uint16 iv_len,
+ *                                                   SilcUInt16 iv_len,
  *                                                   unsigned char *iv,
  *                                                   SilcCipher cipher,
- *                                                   SilcHmac hmac);
+ *                                                   SilcHmac hmac.
+ *                                                   SilcRng rng);
  *
  * DESCRIPTION
  *
@@ -336,16 +374,18 @@ silc_channel_message_payload_parse(unsigned char *payload,
  *    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,
+SilcBuffer silc_channel_message_payload_encode(SilcMessageFlags flags,
+                                              SilcUInt16 data_len,
                                               const unsigned char *data,
-                                              uint16 iv_len,
+                                              SilcUInt16 iv_len,
                                               unsigned char *iv,
                                               SilcCipher cipher,
-                                              SilcHmac hmac);
+                                              SilcHmac hmac,
+                                              SilcRng rng);
 
 /****f* silccore/SilcChannelAPI/silc_channel_message_payload_free
  *
@@ -382,7 +422,7 @@ silc_channel_message_get_flags(SilcChannelMessagePayload payload);
  *
  *    unsigned char *
  *    silc_channel_message_get_data(SilcChannelMessagePayload payload,
- *                                  uint32 *data_len);
+ *                                  SilcUInt32 *data_len);
  *
  * DESCRIPTION
  *
@@ -391,7 +431,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
  *
@@ -439,17 +479,17 @@ unsigned char *silc_channel_message_get_iv(SilcChannelMessagePayload payload);
  ***/
 SilcChannelKeyPayload 
 silc_channel_key_payload_parse(const unsigned char *payload,
-                              uint32 payload_len);
+                              SilcUInt32 payload_len);
 
 /****f* silccore/SilcChannelAPI/silc_channel_key_payload_encode
  *
  * SYNOPSIS
  *
- *    SilcBuffer silc_channel_key_payload_encode(uint16 id_len,
+ *    SilcBuffer silc_channel_key_payload_encode(SilcUInt16 id_len,
  *                                               const unsigned char *id,
- *                                               uint16 cipher_len,
+ *                                               SilcUInt16 cipher_len,
  *                                               const unsigned char *cipher,
- *                                               uint16 key_len,
+ *                                               SilcUInt16 key_len,
  *                                               const unsigned char *key);
  *
  * DESCRIPTION
@@ -458,11 +498,11 @@ silc_channel_key_payload_parse(const unsigned char *payload,
  *    to add channel key payload into a packet.
  *
  ***/
-SilcBuffer silc_channel_key_payload_encode(uint16 id_len,
+SilcBuffer silc_channel_key_payload_encode(SilcUInt16 id_len,
                                           const unsigned char *id,
-                                          uint16 cipher_len,
+                                          SilcUInt16 cipher_len,
                                           const unsigned char *cipher,
-                                          uint16 key_len,
+                                          SilcUInt16 key_len,
                                           const unsigned char *key);
 
 /****f* silccore/SilcChannelAPI/silc_channel_key_payload_free
@@ -483,7 +523,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
  *
@@ -492,14 +532,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
  *
@@ -508,14 +548,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
  *
@@ -524,6 +564,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
SILC - Secure Internet Live Conferencing