-/****h* silccore/silcpacket.h
- *
- * NAME
- *
- * silcpacket.h
- *
- * COPYRIGHT
- *
- * Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
- *
- * Copyright (C) 1997 - 2001 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.
- *
- * 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
- * GNU General Public License for more details.
+/*
+
+ silcpacket.h
+
+ Author: Pekka Riikonen <priikone@silcnet.org>
+
+ Copyright (C) 1997 - 2001 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; 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
+ GNU General Public License for more details.
+
+*/
+
+/****h* silccore/SilcPacketAPI
*
* DESCRIPTION
*
#ifndef SILCPACKET_H
#define SILCPACKET_H
-/* Amount of bytes to be read from the socket connection at once. */
-#define SILC_PACKET_READ_SIZE 16384
-
/* Default byte size of the packet. */
-#define SILC_PACKET_DEFAULT_SIZE 1024
+#define SILC_PACKET_DEFAULT_SIZE SILC_SOCKET_BUF_SIZE
/* Header length without source and destination ID's. */
-#define SILC_PACKET_HEADER_LEN 8 + 2
+#define SILC_PACKET_HEADER_LEN 10
/* Minimum length of SILC Packet Header. This much is decrypted always
when packet is received to be able to get all the relevant data out
from the header. */
-#define SILC_PACKET_MIN_HEADER_LEN 16 + 2
+#define SILC_PACKET_MIN_HEADER_LEN 16
/* Maximum padding length */
-#define SILC_PACKET_MAX_PADLEN 16
+#define SILC_PACKET_MAX_PADLEN 128
+
+/* Default padding length */
+#define SILC_PACKET_DEFAULT_PADLEN 16
/* Minimum packet length */
#define SILC_PACKET_MIN_LEN (SILC_PACKET_HEADER_LEN + 1)
#define SILC_PACKET_REKEY_DONE 23 /* Re-key done */
#define SILC_PACKET_HEARTBEAT 24 /* Heartbeat */
#define SILC_PACKET_KEY_AGREEMENT 25 /* Key Agreement request */
-#define SILC_PACKET_CELL_ROUTERS 26 /* Cell routers backup */
+#define SILC_PACKET_RESUME_ROUTER 26 /* Backup router resume */
+#define SILC_PACKET_FTP 27 /* File Transfer */
#define SILC_PACKET_PRIVATE 200 /* Private range start */
#define SILC_PACKET_MAX 255 /* RESERVED */
* silc_packet_* routines. If not provided the library will calculate
* the values.
*
- * in users;
+ * int users;
*
* Reference counter for this context. The context is freed only
* after the reference counter hits zero. The counter is added
* calling silc_packet_context_dup and decreased by calling the
* silc_packet_context_free.
*
+ * uint32 sequence;
+ *
+ * Packet sequence number.
+ *
***/
typedef struct {
SilcBuffer buffer;
- SilcPacketType type;
+
+ uint16 truelen;
SilcPacketFlags flags;
+ SilcPacketType type;
+ uint8 padlen;
unsigned char *src_id;
- uint16 src_id_len;
- unsigned char src_id_type;
+ uint8 src_id_len;
+ uint8 src_id_type;
unsigned char *dst_id;
- uint16 dst_id_len;
- unsigned char dst_id_type;
-
- uint16 truelen;
- uint16 padlen;
+ uint8 dst_id_len;
+ uint8 dst_id_type;
/* Back pointers */
void *context;
SilcSocketConnection sock;
int users;
+ bool long_pad; /* Set to TRUE to use maximum padding
+ in packet (up to 256 bytes). */
+
+ uint32 sequence;
} SilcPacketContext;
/****s* silccore/SilcPacketAPI/SilcPacketParserContext
*
* DESCRIPTION
*
- * This context is used in packet reception when silc_packet_receive_process
- * function calls parser callback that performs the actual packet decryption
- * and parsing. This context is sent as argument to the parser function.
- * This context must be free'd by the parser callback function.
+ * This context is used in packet reception when the function
+ * silc_packet_receive_process calls parser callback that performs
+ * the actual packet decryption and parsing. This context is sent as
+ * argument to the parser function. This context must be free'd by
+ * the parser callback function.
*
* Following description of the fields:
*
* context is not parsed, only the packet->buffer is allocated and
* it includes the raw packet data, which is encrypted.
*
+ * bool normal
+ *
+ * Indicates whether the received packet is normal or special packet.
+ * If special the parsing process is special also.
+ *
* SilcSocketConnection sock
*
* The associated connection.
***/
typedef struct {
SilcPacketContext *packet;
+ bool normal;
SilcSocketConnection sock;
void *context;
} SilcPacketParserContext;
*
***/
typedef void (*SilcPacketParserCallback)(SilcPacketParserContext
- *parse_context);
-
-/****f* silccore/SilcPacketAPI/SilcPacketCheckDecrypt
- *
- * SYNOPSIS
- *
- * typedef int (*SilcPacketCheckDecrypt)(SilcPacketType packet_type,
- * SilcBuffer buffer,
- * SilcPacketContext *packet,
- * void *context);
- *
- * DESCRIPTION
- *
- * This callback function relates to the checking whether the packet is
- * normal packet or special packet and how it should be processed. If
- * the callback returns TRUE the packet is normal and FALSE if the packet
- * is special and requires special procesing. Some of the packets in
- * SILC are special (like channel message packets that are encrypted
- * using channel specific keys) and requires special processing. That
- * is the reason for this callback function.
- *
- * The library will call this function if provided for the
- * silc_packet_decrypt function. The `packet_type' is the type of
- * packet received (this is also actually the first time application
- * receives information of the received packet, next time it receives
- * it is when the SilcPacketParserCallback function is called),
- * the `buffer' is the raw packet data the `packet' the allocated
- * SilcPacketContext that is filled when parsing the packet and `context'
- * is application specific user context.
- *
- ***/
-typedef int (*SilcPacketCheckDecrypt)(SilcPacketType packet_type,
- SilcBuffer buffer,
- SilcPacketContext *packet,
- void *context);
+ *parse_context, void *context);
/* Macros */
*
* DESCRIPTION
*
- * Returns true length of the packet and padded length of the packet.
- * This is primarily used by the libary in packet parsing phase but
- * the application may use it as well if needed.
+ * Returns true length of the packet. This is primarily used by the
+ * libary in packet parsing phase but the application may use it as
+ * well if needed.
*
* SOURCE
*/
-#define SILC_PACKET_LENGTH(__packet, __ret_truelen, __ret_padlen) \
-do { \
- SILC_GET16_MSB((__ret_truelen), (__packet)->data); \
- (__ret_padlen) = (((__ret_truelen) - 2) + \
- SILC_PACKET_MAX_PADLEN) & ~(SILC_PACKET_MAX_PADLEN - 1); \
+#define SILC_PACKET_LENGTH(__packet, __ret_truelen, __ret_paddedlen) \
+do { \
+ SILC_GET16_MSB((__ret_truelen), (__packet)->data); \
+ (__ret_paddedlen) = (__ret_truelen) + (__packet)->data[4]; \
} while(0)
/***/
*
* SOURCE
*/
-#define SILC_PACKET_PADLEN(__packetlen) \
- SILC_PACKET_MAX_PADLEN - ((__packetlen) - 2) % SILC_PACKET_MAX_PADLEN;
+#define SILC_PACKET_PADLEN(__packetlen, __blocklen) \
+ SILC_PACKET_DEFAULT_PADLEN - (__packetlen) % \
+ ((__blocklen) ? (__blocklen) : SILC_PACKET_DEFAULT_PADLEN)
/***/
-/* Prototypes */
-
-/****f* silccore/SilcPacketAPI/silc_packet_write
+/****d* silccore/SilcPacketAPI/SILC_PACKET_PADLEN_MAX
*
- * SYNOPSIS
- *
- * int silc_packet_write(int sock, SilcBuffer src);
+ * NAME
+ *
+ * #define SILC_PACKET_PADLEN_MAX ...
*
* DESCRIPTION
*
- * Writes data from encrypted buffer to the socket connection. If the
- * data cannot be written at once, it will be written later with a timeout.
- * The data is written from the data section of the buffer, not from head
- * or tail section. This automatically pulls the data section towards end
- * after writing the data.
+ * Returns the length of the padding up to the maximum length, which
+ * is 128 butes. This is used by various library routines to determine
+ * needed padding length.
*
- ***/
-int silc_packet_write(int sock, SilcBuffer src);
+ * SOURCE
+ */
+#define SILC_PACKET_PADLEN_MAX(__packetlen) \
+ SILC_PACKET_MAX_PADLEN - (__packetlen) % SILC_PACKET_MAX_PADLEN
+/***/
+
+/* Prototypes */
/****f* silccore/SilcPacketAPI/silc_packet_send
*
* SYNOPSIS
*
- * int silc_packet_send(SilcSocketConnection sock, int force_send);
+ * int silc_packet_send(SilcSocketConnection sock, bool force_send);
*
* DESCRIPTION
*
* directly to the network, if FALSE, this returns -2.
*
***/
-int silc_packet_send(SilcSocketConnection sock, int force_send);
+int silc_packet_send(SilcSocketConnection sock, bool force_send);
/****f* silccore/SilcPacketAPI/silc_packet_encrypt
*
* cannot be used.
*
***/
-void silc_packet_encrypt(SilcCipher cipher, SilcHmac hmac,
+void silc_packet_encrypt(SilcCipher cipher, SilcHmac hmac, uint32 sequence,
SilcBuffer buffer, uint32 len);
/****f* silccore/SilcPacketAPI/silc_packet_assemble
* the packet.
*
***/
-void silc_packet_assemble(SilcPacketContext *ctx);
+void silc_packet_assemble(SilcPacketContext *ctx, SilcCipher cipher);
/****f* silccore/SilcPacketAPI/silc_packet_send_prepare
*
uint32 padlen,
uint32 data_len);
-/****f* silccore/SilcPacketAPI/silc_packet_read
- *
- * SYNOPSIS
- *
- * int silc_packet_read(int fd, SilcSocketConnection sock);
- *
- * DESCRIPTION
- *
- * Reads data from the socket connection into the incoming data buffer.
- * However, this does not parse the packet, it only reads some amount from
- * the network. If there are more data available that can be read at a time
- * the rest of the data will be read later with a timeout and only after
- * that the packet is ready to be parsed.
- *
- * The destination buffer sent as argument must be initialized before
- * calling this function, and, the data section and the start of the tail
- * section must be same. Ie. we add the read data to the tail section of
- * the buffer hence the data section is the start of the buffer.
- *
- * This returns amount of bytes read or -1 on error or -2 on case where
- * all of the data could not be read at once.
- *
- ***/
-int silc_packet_read(int fd, SilcSocketConnection sock);
-
/****f* silccore/SilcPacketAPI/silc_packet_receive
*
* SYNOPSIS
***/
int silc_packet_receive(SilcSocketConnection sock);
-/****f* silccore/SilcPacketAPI/silc_packet_decrypt
- *
- * SYNOPSIS
- *
- * int silc_packet_decrypt(SilcCipher cipher, SilcHmac hmac,
- * SilcBuffer buffer, SilcPacketContext *packet,
- * SilcPacketCheckDecrypt check_packet,
- * void *context);
- *
- * DESCRIPTION
- *
- * Decrypts a packet. This assumes that typical SILC packet is the
- * packet to be decrypted and thus checks for normal and special SILC
- * packets and can handle both of them. This also computes and checks
- * the HMAC of the packet. If any other special or customized decryption
- * processing is required this function cannot be used. This returns
- * -1 on error, 0 when packet is normal packet and 1 when the packet
- * is special and requires special processing.
- *
- * The `check_packet' is a callback funtion that this function will
- * call. The callback relates to the checking whether the packet is
- * normal packet or special packet and how it should be processed. If
- * the callback return TRUE the packet is normal and FALSE if the packet
- * is special and requires special procesing.
- *
- ***/
-int silc_packet_decrypt(SilcCipher cipher, SilcHmac hmac,
- SilcBuffer buffer, SilcPacketContext *packet,
- SilcPacketCheckDecrypt check_packet,
- void *context);
-
/****f* silccore/SilcPacketAPI/silc_packet_receive_process
*
* SYNOPSIS
*
* void silc_packet_receive_process(SilcSocketConnection sock,
+ * bool local_is_router,
* SilcCipher cipher, SilcHmac hmac,
* SilcPacketParserCallback parser,
- * void *context);
+ * void *parser_context);
*
* DESCRIPTION
*
- * Processes the received data. This checks the received data and
- * calls parser callback that handles the actual packet decryption
- * and parsing. If more than one packet was received this calls the
- * parser multiple times. The parser callback will get context
- * SilcPacketParserContext that includes the packet and the `context'
- * sent to this function.
+ * Processes and decrypts the incmoing data, and calls parser callback
+ * for each received packet that will handle the actual packet parsing.
+ * If more than one packet was received this calls the parser multiple
+ * times. The parser callback will get context SilcPacketParserContext
+ * that includes the packet and the `parser_context' sent to this
+ * function.
+ *
+ * The `local_is_router' indicates whether the caller is router server
+ * in which case the receiving process of a certain packet types may
+ * be special. Normal server and client must set it to FALSE. The
+ * SilcPacketParserContext will indicate also whether the received
+ * packet was normal or special packet.
*
***/
void silc_packet_receive_process(SilcSocketConnection sock,
+ bool local_is_router,
SilcCipher cipher, SilcHmac hmac,
+ uint32 sequence,
SilcPacketParserCallback parser,
- void *context);
+ void *parser_context);
/****f* silccore/SilcPacketAPI/silc_packet_parse
*
* buffer is parsed, not head or tail sections.
*
***/
-SilcPacketType silc_packet_parse(SilcPacketContext *ctx);
+SilcPacketType silc_packet_parse(SilcPacketContext *ctx, SilcCipher cipher);
/****f* silccore/SilcPacketAPI/silc_packet_parse_special
*
* and parses the header and padding area only.
*
***/
-SilcPacketType silc_packet_parse_special(SilcPacketContext *ctx);
+SilcPacketType silc_packet_parse_special(SilcPacketContext *ctx,
+ SilcCipher cipher);
/****f* silccore/SilcPacketAPI/silc_packet_context_alloc
*
* silc_packet_context_free function.
*
***/
-SilcPacketContext *silc_packet_context_alloc();
+SilcPacketContext *silc_packet_context_alloc(void);
/****f* silccore/SilcPacketAPI/silc_packet_context_dup
*
projects / silc.git / blobdiff