silcchannel.h
- Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
+ Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 1997 - 2001 Pekka Riikonen
+ Copyright (C) 1997 - 2005 Pekka Riikonen
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
+ the Free Software Foundation; version 2 of the License.
+
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
*/
+/****h* silccore/SILC Channel Interface
+ *
+ * DESCRIPTION
+ *
+ * Implementations of the Channel Payload and Channel Key Payload. The
+ * Channel Payload represents new channel and is used to distribute the
+ * information of the new channel. The Channel Key Payload is used to
+ * distribute a new key to the channel. It is done for example every
+ * time someone joins a channel or the old key expires.
+ *
+ ***/
+
#ifndef SILCCHANNEL_H
#define SILCCHANNEL_H
#include "silcdlist.h"
-/* Forward declaration for Channel Payload parsed from packet. The
- actual structure is defined in source file and is private data. */
+/****s* silccore/SilcChannelAPI/SilcChannelPayload
+ *
+ * NAME
+ *
+ * typedef struct SilcChannelPayloadStruct *SilcChannelPayload;
+ *
+ * DESCRIPTION
+ *
+ * This context is the actual Channel Payload and is allocated
+ * by silc_channel_payload_parse and given as argument usually to
+ * all silc_channel_payload_* functions. It is freed by the
+ * silc_channel_payload_free function.
+ *
+ ***/
typedef struct SilcChannelPayloadStruct *SilcChannelPayload;
-/* Forward declaration for Channel Message Payload parsed from packet. The
- actual structure is defined in source file and is private data. */
-typedef struct SilcChannelMessagePayloadStruct *SilcChannelMessagePayload;
-
-/* Forward declaration for Channel Key Payload parsed from packet. The
- actual structure is defined in source file and is private data. */
+/****s* silccore/SilcChannelAPI/SilcChannelKeyPayload
+ *
+ * NAME
+ *
+ * typedef struct SilcChannelKeyPayloadStruct *SilcChannelKeyPayload;
+ *
+ * DESCRIPTION
+ *
+ * This context is the actual Channel Key Payload and is allocated
+ * by silc_channel_key_payload_parse and given as argument usually to
+ * all silc_channel_key_payload_* functions. It is freed by the
+ * silc_channel_key_payload_free function.
+ *
+ ***/
typedef struct SilcChannelKeyPayloadStruct *SilcChannelKeyPayload;
-/* The Message flag type */
-typedef unsigned short SilcMessageFlags;
+/* Prototypes */
-/* 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_RESERVED 0x0010 /* to 0x0200 */
-#define SILC_MESSAGE_FLAG_PRIVATE 0x0400 /* to 0x8000 */
+/****f* silccore/SilcChannelAPI/silc_channel_payload_parse
+ *
+ * SYNOPSIS
+ *
+ * SilcChannelPayload
+ * silc_channel_payload_parse(const unsigned char *payload,
+ * SilcUInt32 payload_len);
+ *
+ * DESCRIPTION
+ *
+ * Parses channel payload returning new channel payload structure. The
+ * `buffer' is the raw payload buffer.
+ *
+ ***/
+SilcChannelPayload silc_channel_payload_parse(const unsigned char *payload,
+ SilcUInt32 payload_len);
-/* Prototypes */
-SilcChannelPayload silc_channel_payload_parse(SilcBuffer buffer);
-SilcDList silc_channel_payload_parse_list(SilcBuffer buffer);
-SilcBuffer silc_channel_payload_encode(unsigned char *channel_name,
- unsigned short channel_name_len,
- unsigned char *channel_id,
- unsigned int channel_id_len,
- unsigned int mode);
+/****f* silccore/SilcChannelAPI/silc_channel_payload_parse_list
+ *
+ * SYNOPSIS
+ *
+ * SilcDList
+ * silc_channel_payload_parse_list(const unsigned char *payload,
+ * SilcUInt32 payload_len);
+ *
+ * DESCRIPTION
+ *
+ * Parses list of channel payloads returning list of payloads. This
+ * is equivalent to the silc_channel_payload_parse except that the `buffer'
+ * now includes multiple Channel Payloads one after the other.
+ *
+ ***/
+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(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(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
+ *
+ * SYNOPSIS
+ *
+ * void silc_channel_payload_free(SilcChannelPayload payload);
+ *
+ * DESCRIPTION
+ *
+ * Frees Channel Payload and all data in it.
+ *
+ ***/
void silc_channel_payload_free(SilcChannelPayload payload);
+
+/****f* silccore/SilcChannelAPI/silc_channel_payload_list_free
+ *
+ * SYNOPSIS
+ *
+ * void silc_channel_payload_list_free(SilcDList list);
+ *
+ * DESCRIPTION
+ *
+ * Frees list of Channel Payloads and all data in them.
+ *
+ ***/
void silc_channel_payload_list_free(SilcDList list);
+
+/****f* silccore/SilcChannelAPI/silc_channel_get_name
+ *
+ * SYNOPSIS
+ *
+ * unsigned char *silc_channel_get_name(SilcChannelPayload payload,
+ * SilcUInt32 *channel_name_len);
+ *
+ * DESCRIPTION
+ *
+ * Return the channel name from the payload. The caller must not free it.
+ *
+ ***/
unsigned char *silc_channel_get_name(SilcChannelPayload payload,
- unsigned int *channel_name_len);
+ SilcUInt32 *channel_name_len);
+
+/****f* silccore/SilcChannelAPI/silc_channel_get_id
+ *
+ * SYNOPSIS
+ *
+ * unsigned char *silc_channel_get_id(SilcChannelPayload payload,
+ * SilcUInt32 *channel_id_len);
+ *
+ * DESCRIPTION
+ *
+ * Return the Channel ID data from the payload. The caller must not free it.
+ *
+ ***/
unsigned char *silc_channel_get_id(SilcChannelPayload payload,
- unsigned int *channel_id_len);
-SilcChannelID *silc_channel_get_id_parse(SilcChannelPayload payload);
-unsigned int silc_channel_get_mode(SilcChannelPayload payload);
-int silc_channel_message_payload_decrypt(unsigned char *data,
- size_t data_len,
- SilcCipher cipher,
- SilcHmac hmac);
-SilcChannelMessagePayload
-silc_channel_message_payload_parse(SilcBuffer buffer,
- SilcCipher cipher,
- SilcHmac hmac);
-SilcBuffer silc_channel_message_payload_encode(unsigned short flags,
- unsigned short data_len,
- unsigned char *data,
- unsigned short iv_len,
- unsigned char *iv,
- SilcCipher cipher,
- SilcHmac hmac);
-void silc_channel_message_payload_free(SilcChannelMessagePayload payload);
-unsigned short
-silc_channel_message_get_flags(SilcChannelMessagePayload payload);
-unsigned char *silc_channel_message_get_data(SilcChannelMessagePayload payload,
- unsigned int *data_len);
-unsigned char *silc_channel_message_get_mac(SilcChannelMessagePayload payload);
-unsigned char *silc_channel_message_get_iv(SilcChannelMessagePayload payload);
-SilcChannelKeyPayload silc_channel_key_payload_parse(SilcBuffer buffer);
-SilcBuffer silc_channel_key_payload_encode(unsigned short id_len,
- unsigned char *id,
- unsigned short cipher_len,
- unsigned char *cipher,
- unsigned short key_len,
- unsigned char *key);
+ SilcUInt32 *channel_id_len);
+
+/****f* silccore/SilcChannelAPI/silc_channel_get_id_parse
+ *
+ * SYNOPSIS
+ *
+ * SilcBool silc_channel_get_id_parse(SilcChannelPayload payload,
+ * SilcChannelID *ret_channel_id);
+ *
+ * DESCRIPTION
+ *
+ * Return the Channel ID as parsed ID. This is equivalent to the
+ * silc_channel_get_id execpt that the ID is already parsed.
+ *
+ ***/
+SilcBool silc_channel_get_id_parse(SilcChannelPayload payload,
+ SilcChannelID *ret_channel_id);
+
+/****f* silccore/SilcChannelAPI/silc_channel_get_mode
+ *
+ * SYNOPSIS
+ *
+ * SilcUInt32 silc_channel_get_mode(SilcChannelPayload payload);
+ *
+ * DESCRIPTION
+ *
+ * Return the mode. The mode is arbitrary. It can be the mode of the
+ * channel or perhaps the mode of the client on the channel. The protocol
+ * dictates what the usage of the mode is in different circumstances.
+ *
+ ***/
+SilcUInt32 silc_channel_get_mode(SilcChannelPayload payload);
+
+/****f* silccore/SilcChannelAPI/silc_channel_key_payload_parse
+ *
+ * SYNOPSIS
+ *
+ * SilcChannelKeyPayload
+ * silc_channel_key_payload_parse(const unsigned char *payload,
+ * uin32 payload_len);
+ *
+ * DESCRIPTION
+ *
+ * Parses channel key payload returning new channel key payload
+ * structure.
+ *
+ ***/
+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(SilcUInt16 id_len,
+ * const unsigned char *id,
+ * SilcUInt16 cipher_len,
+ * const unsigned char *cipher,
+ * SilcUInt16 key_len,
+ * const unsigned char *key);
+ *
+ * DESCRIPTION
+ *
+ * Encodes channel key payload into a buffer and returns it. This is used
+ * to add channel key payload into a packet.
+ *
+ ***/
+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
+ *
+ * SYNOPSIS
+ *
+ * void silc_channel_key_payload_free(SilcChannelKeyPayload payload);
+ *
+ * DESCRIPTION
+ *
+ * Frees the Channel Key Payload and all data in it.
+ *
+ ***/
void silc_channel_key_payload_free(SilcChannelKeyPayload payload);
-unsigned char *silc_channel_key_get_id(SilcChannelKeyPayload payload,
- unsigned int *id_len);
+
+/****f* silccore/SilcChannelAPI/silc_channel_key_get_id
+ *
+ * SYNOPSIS
+ *
+ * unsigned char *silc_channel_key_get_id(SilcChannelKeyPayload payload,
+ * SilcUInt32 *id_len);
+ *
+ * DESCRIPTION
+ *
+ * Return the Channel ID data from the payload. The caller must not
+ * free it.
+ *
+ ***/
+unsigned char *silc_channel_key_get_id(SilcChannelKeyPayload payload,
+ SilcUInt32 *id_len);
+
+/****f* silccore/SilcChannelAPI/silc_channel_key_get_cipher
+ *
+ * SYNOPSIS
+ *
+ * unsigned char *silc_channel_key_get_cipher(SilcChannelKeyPayload payload,
+ * SilcUInt32 *cipher_len);
+ *
+ * DESCRIPTION
+ *
+ * Return the name of the cipher from the payload. The caller must not
+ * free it.
+ *
+ ***/
unsigned char *silc_channel_key_get_cipher(SilcChannelKeyPayload payload,
- unsigned int *cipher_len);
+ SilcUInt32 *cipher_len);
+
+/****f* silccore/SilcChannelAPI/silc_channel_key_get_key
+ *
+ * SYNOPSIS
+ *
+ * unsigned char *silc_channel_key_get_key(SilcChannelKeyPayload payload,
+ * SilcUInt32 *key_len);
+ *
+ * DESCRIPTION
+ *
+ * Return the raw key material from the payload. The caller must not
+ * free it.
+ *
+ ***/
unsigned char *silc_channel_key_get_key(SilcChannelKeyPayload payload,
- unsigned int *key_len);
+ SilcUInt32 *key_len);
#endif
projects / silc.git / blobdiff