From 743f4857ede9f48def462c1ea2cee8be71356fac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ram=C5=ABnas=20Ma=C5=BEeikis?= Date: Wed, 29 May 2019 13:53:50 +0300 Subject: Protocol: renamed some files. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ramūnas Mažeikis --- include/protocol.h | 190 ------------------------------------------ include/tlv.h | 190 ++++++++++++++++++++++++++++++++++++++++++ src/common/protocol.c | 133 ----------------------------- src/common/protocol_private.h | 48 ----------- src/common/tlv.c | 133 +++++++++++++++++++++++++++++ src/common/tlv_private.h | 48 +++++++++++ 6 files changed, 371 insertions(+), 371 deletions(-) delete mode 100644 include/protocol.h create mode 100644 include/tlv.h delete mode 100644 src/common/protocol.c delete mode 100644 src/common/protocol_private.h create mode 100644 src/common/tlv.c create mode 100644 src/common/tlv_private.h diff --git a/include/protocol.h b/include/protocol.h deleted file mode 100644 index 7bfb275..0000000 --- a/include/protocol.h +++ /dev/null @@ -1,190 +0,0 @@ -/* - * Usurpataion --- client-server protocol interface. - * - * Copyright (C) 2019 Ramūnas Mažeikis - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; version 2.1 - * 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA - */ - -#ifndef USURPATION_PROTOCOL_H_INCLUDED -#define USURPATION_PROTOCOL_H_INCLUDED - -#if 0 - -How do we use this API(?), I hear you say. Well, here is a self-contained -example complete with tedious comments, allocation of buffers and cleanup: - -------------------------------------------------------------------------------- - 1 | void functy_the_function(void) - 2 | { - 3 | struct tlv tlv_packet; /* A packet made of tlv's */ - 4 | struct tlv text; /* Actually useful data */ - 5 | char *packet; /* Raw bytes to be pushed via UDP */ - 6 | size_t packet_size; /* Raw packet size */ - 7 | char message[] = "Get jacked!"; /* Duh! */ - 9 | - 10 | tlv_init(&tlv_packet, REGURAL); /* Initialise tlv_packet to regular */ - 11 | tlv_init(&text, TEXT); /* Initialise text packet */ - 12 | tlv_push_data(&text, message, sizeof(message)); /* Push text to appropriate tlv */ - 13 | tlv_push_tlv(&tlv_packet, &text); /* Push the tlv into tlv packet */ - 14 | - 15 | packet_size = tlv_raw_size(&tlv_packet); /* Get raw size required to push entire tlv_packet as bytes */ - 16 | packet = (char *)malloc(packet_size); /* Allocate buffer for outgoing packet */ - 17 | tlv_get_raw(&tlv_packet, packet); /* Flash tlv_packet to buffer */ - 19 | udp_push(packet, packet_size); /* Push packet via UDP */ - 20 | udp_flush(); /* Flush to the other side*/ - 21 | - 22 | tlv_destroy(&tlv_packet); /* Free tlv_packet */ - 23 | free(packet); /* Free packet itself */ - 24 | return; /* GTFO and save stack space */ - 25 | } -------------------------------------------------------------------------------- - -A few things to note: - * Calling tlv_destroy() on a tlv of type REGURAL or HEARTBEAT destorys - all sub-tlv's too. - * Tlv's get copies of data, which means the original buffer can be - freed immediately. - -#endif - - -#include - -#define E_TLV_OVERFLOW (1 << 0) -#define E_UNKNOWN_TYPE (1 << 1) -#define END_OF_PACKET (1 << 2) - -#define TLV_SZ_MAX_RAW (MTU - 64) - -/** - * Message sequence number since beggining of sesssion. - * - * Mainly used for identifying lost messages. - */ -typedef unsigned int msg_idx_t; - -enum tlv_type { - /** - * NULL-terminated string. To be put in a queue to display on the - * screen. - */ - TEXT, - - /** Fixed point. 1 decimal digit of precision. */ - FPI1, - - /** Literally time_t */ - TIMESTAMP, - - /** Represents a request for lost message. Data is unsigned integer - * that uniquely identifies the message. - */ - REQUEST, - - /** - * Response to request. Begins with unsigned integer that represents - * which message is being repeated and the actual null-terminated - * message after that. - */ - REPLY, - - /** - * UUID that represents a particular device. - */ - UUID, - -/* Data of the following types are other tlv's! */ - - /** - * Just a TLV container. - */ - REGURAL, - - /** - * Says "I'm not dead yet.". - */ - HEARTBEAT, - - /** - * Says "Bring out yer dead!". - */ - DISCOVERY -}; - -/** - * Literally type-length-value - * */ -struct tlv { - enum tlv_type type; - size_t length; - void *data; -}; - -/** - * Keeps state of the parsing process. - * - * Related functions return one tlv at a time. - */ -struct tlv_parser { - char *data; - size_t offset; - size_t size; -}; - -/** - * Fills tlv structure to represent the next tlv in the packet. - * - * Returns END_OF_PACKET if all tlv's were read of E_TLV_OVERFLOW, if the last - * tlv, according to its declared size should not fit in a packet. - */ -int tlv_get(struct tlv_parser *parser, struct tlv *ret); - -/** - * Initialises tlv to sane values. - */ -void tlv_init(struct tlv *t, enum tlv_type type); - -/** - * Frees data held in the tlv structure. The structure itself shall be freed as - * needed by calling code. - */ -void tlv_destroy(struct tlv *t); - -/** - * Tells amount of bytes needed to push tlv to a buffer - */ -size_t tlv_raw_size(const struct tlv *t); - -/** - * Pushes tlv to buffer as contiguous data. Check tlv size with tlv_raw_size - * beforehand. If you don't do that and overflow --- tough tiddy. - */ -int tlv_get_raw(struct tlv *t, char *buf); - -/** - * Pushes data to tlv. Returns E_TLV_OVERFLOW if pushing data would cause the - * final size to be greater than TLV_SZ_MAX_RAW. In case of such error the data is left - * untouched. - */ -int tlv_push_data(struct tlv *t, const char *data, size_t size); - -/** - * Pushes a sub-tlv into the packet. 't' can only be REGURAL, HEARTBEAT or - * DISCOVERY. - */ -int tlv_push_tlv(struct tlv *t, const struct tlv *other); - -#endif /* USURPATION_PROTOCOL_H_INCLUDED */ diff --git a/include/tlv.h b/include/tlv.h new file mode 100644 index 0000000..7bfb275 --- /dev/null +++ b/include/tlv.h @@ -0,0 +1,190 @@ +/* + * Usurpataion --- client-server protocol interface. + * + * Copyright (C) 2019 Ramūnas Mažeikis + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; version 2.1 + * 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +#ifndef USURPATION_PROTOCOL_H_INCLUDED +#define USURPATION_PROTOCOL_H_INCLUDED + +#if 0 + +How do we use this API(?), I hear you say. Well, here is a self-contained +example complete with tedious comments, allocation of buffers and cleanup: + +------------------------------------------------------------------------------- + 1 | void functy_the_function(void) + 2 | { + 3 | struct tlv tlv_packet; /* A packet made of tlv's */ + 4 | struct tlv text; /* Actually useful data */ + 5 | char *packet; /* Raw bytes to be pushed via UDP */ + 6 | size_t packet_size; /* Raw packet size */ + 7 | char message[] = "Get jacked!"; /* Duh! */ + 9 | + 10 | tlv_init(&tlv_packet, REGURAL); /* Initialise tlv_packet to regular */ + 11 | tlv_init(&text, TEXT); /* Initialise text packet */ + 12 | tlv_push_data(&text, message, sizeof(message)); /* Push text to appropriate tlv */ + 13 | tlv_push_tlv(&tlv_packet, &text); /* Push the tlv into tlv packet */ + 14 | + 15 | packet_size = tlv_raw_size(&tlv_packet); /* Get raw size required to push entire tlv_packet as bytes */ + 16 | packet = (char *)malloc(packet_size); /* Allocate buffer for outgoing packet */ + 17 | tlv_get_raw(&tlv_packet, packet); /* Flash tlv_packet to buffer */ + 19 | udp_push(packet, packet_size); /* Push packet via UDP */ + 20 | udp_flush(); /* Flush to the other side*/ + 21 | + 22 | tlv_destroy(&tlv_packet); /* Free tlv_packet */ + 23 | free(packet); /* Free packet itself */ + 24 | return; /* GTFO and save stack space */ + 25 | } +------------------------------------------------------------------------------- + +A few things to note: + * Calling tlv_destroy() on a tlv of type REGURAL or HEARTBEAT destorys + all sub-tlv's too. + * Tlv's get copies of data, which means the original buffer can be + freed immediately. + +#endif + + +#include + +#define E_TLV_OVERFLOW (1 << 0) +#define E_UNKNOWN_TYPE (1 << 1) +#define END_OF_PACKET (1 << 2) + +#define TLV_SZ_MAX_RAW (MTU - 64) + +/** + * Message sequence number since beggining of sesssion. + * + * Mainly used for identifying lost messages. + */ +typedef unsigned int msg_idx_t; + +enum tlv_type { + /** + * NULL-terminated string. To be put in a queue to display on the + * screen. + */ + TEXT, + + /** Fixed point. 1 decimal digit of precision. */ + FPI1, + + /** Literally time_t */ + TIMESTAMP, + + /** Represents a request for lost message. Data is unsigned integer + * that uniquely identifies the message. + */ + REQUEST, + + /** + * Response to request. Begins with unsigned integer that represents + * which message is being repeated and the actual null-terminated + * message after that. + */ + REPLY, + + /** + * UUID that represents a particular device. + */ + UUID, + +/* Data of the following types are other tlv's! */ + + /** + * Just a TLV container. + */ + REGURAL, + + /** + * Says "I'm not dead yet.". + */ + HEARTBEAT, + + /** + * Says "Bring out yer dead!". + */ + DISCOVERY +}; + +/** + * Literally type-length-value + * */ +struct tlv { + enum tlv_type type; + size_t length; + void *data; +}; + +/** + * Keeps state of the parsing process. + * + * Related functions return one tlv at a time. + */ +struct tlv_parser { + char *data; + size_t offset; + size_t size; +}; + +/** + * Fills tlv structure to represent the next tlv in the packet. + * + * Returns END_OF_PACKET if all tlv's were read of E_TLV_OVERFLOW, if the last + * tlv, according to its declared size should not fit in a packet. + */ +int tlv_get(struct tlv_parser *parser, struct tlv *ret); + +/** + * Initialises tlv to sane values. + */ +void tlv_init(struct tlv *t, enum tlv_type type); + +/** + * Frees data held in the tlv structure. The structure itself shall be freed as + * needed by calling code. + */ +void tlv_destroy(struct tlv *t); + +/** + * Tells amount of bytes needed to push tlv to a buffer + */ +size_t tlv_raw_size(const struct tlv *t); + +/** + * Pushes tlv to buffer as contiguous data. Check tlv size with tlv_raw_size + * beforehand. If you don't do that and overflow --- tough tiddy. + */ +int tlv_get_raw(struct tlv *t, char *buf); + +/** + * Pushes data to tlv. Returns E_TLV_OVERFLOW if pushing data would cause the + * final size to be greater than TLV_SZ_MAX_RAW. In case of such error the data is left + * untouched. + */ +int tlv_push_data(struct tlv *t, const char *data, size_t size); + +/** + * Pushes a sub-tlv into the packet. 't' can only be REGURAL, HEARTBEAT or + * DISCOVERY. + */ +int tlv_push_tlv(struct tlv *t, const struct tlv *other); + +#endif /* USURPATION_PROTOCOL_H_INCLUDED */ diff --git a/src/common/protocol.c b/src/common/protocol.c deleted file mode 100644 index 0002a96..0000000 --- a/src/common/protocol.c +++ /dev/null @@ -1,133 +0,0 @@ -/* - * Usurpataion --- clinet-server protocol implementation. - * - * Copyright (C) 2019 Ramūnas Mažeikis - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; version 2.1 - * 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA - */ - -/** - * Common parts of protocol implementation. Handling of anything that actually - * deals with connection descriptor has to be implemented by device and daemon - * separately. - */ - -#include -#include -#include -#include "protocol.h" -#include "protocol_private.h" -#include "net.h" -#include "utils.h" - -int tlv_get(struct tlv_parser *parser, struct tlv *ret) -{ - int retval = 0; - - if (parser->offset + sizeof(ret->type) + sizeof(ret->length) >= parser->size) { - retval = E_TLV_OVERFLOW; - } else if (parser -> offset == parser->size) { - retval = END_OF_PACKET; - } else { - ret->type = memcpy(&ret->type, parser->data + parser->offset, sizeof(ret->type)); - parser->size += sizeof(ret->type); - ret->length = memcpy(&ret->length, parser->data + parser->offset, sizeof(ret->length)); - parser->offset += sizeof(ret->length); - if (parser->offset + ret->length >= parser->size) { - retval = E_TLV_OVERFLOW; - } else { - memcpy(ret->data, parser->data, ret->length); - } - } - return retval; -} - -size_t tlv_data_size(struct tlv_parser *parser) -{ - size_t size; - - if (parser->offset + sizeof(enum tlv_type) + sizeof(size_t) >= parser->size) { - size = 0; - } else { - memcpy(&size, parser->data + parser->offset + sizeof(enum tlv_type), sizeof(size_t)); - } - return size; -} - -void tlv_destroy(struct tlv *t) -{ - size_t i = 0; - size_t tlv_count; - struct tlv *arr; - switch (t->type) - { - case REGURAL: - case HEARTBEAT: - case DISCOVERY: - tlv_count = t->length / sizeof(struct tlv); - arr = t->data; - for (i = 0; i < tlv_count; i++) { - tlv_destroy(&arr[i]); - } - default: - free(t->data); - t->length = 0; - break; - } -} - -size_t tlv_raw_size(const struct tlv *t) -{ - return sizeof(*t) + t->length; -} - -int tlv_push_data(struct tlv *t, const char *data, size_t size) -{ - int ret = 0; - size_t final_size = tlv_raw_size(t) + size; - if (final_size > TLV_SZ_MAX_RAW) { - ret = E_TLV_OVERFLOW; - } else { - t->data = realloc(t->data, final_size); - memcpy(t->data + t->length, data, size); - t->length = final_size; - } - return ret; -} - -void tlv_init(struct tlv *t, enum tlv_type type) -{ - t->type = type; - t->length = 0; - t->data = NULL; -} - -int tlv_push_tlv(struct tlv *t, const struct tlv *other) -{ - int ret = 0; - size_t other_size; - size_t final_size; - - other_size = tlv_raw_size(other); - final_size = tlv_raw_size(t) + other_size; - if (final_size > TLV_SZ_MAX_RAW) { - ret = E_TLV_OVERFLOW; - } else { - tlv_get_raw(other, t->data + t->length); - t->length = final_size; - } - - return ret; -} \ No newline at end of file diff --git a/src/common/protocol_private.h b/src/common/protocol_private.h deleted file mode 100644 index 51d5431..0000000 --- a/src/common/protocol_private.h +++ /dev/null @@ -1,48 +0,0 @@ -/* - * Usurpataion --- clinet-server protocol implementation. - * - * Copyright (C) 2019 Ramūnas Mažeikis - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; version 2.1 - * 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA - */ - -/** - * Common parts of protocol implementation. Handling of anything that actually - * deals with connection descriptor has to be implemented by device and daemon - * separately. - */ - -#ifndef PROTOCOL_PRIVATE_H -#define PROTOCOL_PRIVATE_H - -#include "protocol_private.h" - -/** - * Convenience function that pushes bytes to the end of a packet and reports - * potential overflow. - * - * In case of detected overflow nothing is done to the packet. - */ -int push_bytes(struct tlv_packet *packet, char *data, size_t size); - -/** - * Convenience function that forms a tlv header at the end of a packet. Reports - * potential overflow. - * - * In case of detected overflow nothing is done to the packet. - */ -int push_tlv_header(struct tlv_packet *packet, enum tlv_type type, size_t size); - -#endif /* PROTOCOL_PRIVATE_H */ diff --git a/src/common/tlv.c b/src/common/tlv.c new file mode 100644 index 0000000..0002a96 --- /dev/null +++ b/src/common/tlv.c @@ -0,0 +1,133 @@ +/* + * Usurpataion --- clinet-server protocol implementation. + * + * Copyright (C) 2019 Ramūnas Mažeikis + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; version 2.1 + * 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/** + * Common parts of protocol implementation. Handling of anything that actually + * deals with connection descriptor has to be implemented by device and daemon + * separately. + */ + +#include +#include +#include +#include "protocol.h" +#include "protocol_private.h" +#include "net.h" +#include "utils.h" + +int tlv_get(struct tlv_parser *parser, struct tlv *ret) +{ + int retval = 0; + + if (parser->offset + sizeof(ret->type) + sizeof(ret->length) >= parser->size) { + retval = E_TLV_OVERFLOW; + } else if (parser -> offset == parser->size) { + retval = END_OF_PACKET; + } else { + ret->type = memcpy(&ret->type, parser->data + parser->offset, sizeof(ret->type)); + parser->size += sizeof(ret->type); + ret->length = memcpy(&ret->length, parser->data + parser->offset, sizeof(ret->length)); + parser->offset += sizeof(ret->length); + if (parser->offset + ret->length >= parser->size) { + retval = E_TLV_OVERFLOW; + } else { + memcpy(ret->data, parser->data, ret->length); + } + } + return retval; +} + +size_t tlv_data_size(struct tlv_parser *parser) +{ + size_t size; + + if (parser->offset + sizeof(enum tlv_type) + sizeof(size_t) >= parser->size) { + size = 0; + } else { + memcpy(&size, parser->data + parser->offset + sizeof(enum tlv_type), sizeof(size_t)); + } + return size; +} + +void tlv_destroy(struct tlv *t) +{ + size_t i = 0; + size_t tlv_count; + struct tlv *arr; + switch (t->type) + { + case REGURAL: + case HEARTBEAT: + case DISCOVERY: + tlv_count = t->length / sizeof(struct tlv); + arr = t->data; + for (i = 0; i < tlv_count; i++) { + tlv_destroy(&arr[i]); + } + default: + free(t->data); + t->length = 0; + break; + } +} + +size_t tlv_raw_size(const struct tlv *t) +{ + return sizeof(*t) + t->length; +} + +int tlv_push_data(struct tlv *t, const char *data, size_t size) +{ + int ret = 0; + size_t final_size = tlv_raw_size(t) + size; + if (final_size > TLV_SZ_MAX_RAW) { + ret = E_TLV_OVERFLOW; + } else { + t->data = realloc(t->data, final_size); + memcpy(t->data + t->length, data, size); + t->length = final_size; + } + return ret; +} + +void tlv_init(struct tlv *t, enum tlv_type type) +{ + t->type = type; + t->length = 0; + t->data = NULL; +} + +int tlv_push_tlv(struct tlv *t, const struct tlv *other) +{ + int ret = 0; + size_t other_size; + size_t final_size; + + other_size = tlv_raw_size(other); + final_size = tlv_raw_size(t) + other_size; + if (final_size > TLV_SZ_MAX_RAW) { + ret = E_TLV_OVERFLOW; + } else { + tlv_get_raw(other, t->data + t->length); + t->length = final_size; + } + + return ret; +} \ No newline at end of file diff --git a/src/common/tlv_private.h b/src/common/tlv_private.h new file mode 100644 index 0000000..51d5431 --- /dev/null +++ b/src/common/tlv_private.h @@ -0,0 +1,48 @@ +/* + * Usurpataion --- clinet-server protocol implementation. + * + * Copyright (C) 2019 Ramūnas Mažeikis + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; version 2.1 + * 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/** + * Common parts of protocol implementation. Handling of anything that actually + * deals with connection descriptor has to be implemented by device and daemon + * separately. + */ + +#ifndef PROTOCOL_PRIVATE_H +#define PROTOCOL_PRIVATE_H + +#include "protocol_private.h" + +/** + * Convenience function that pushes bytes to the end of a packet and reports + * potential overflow. + * + * In case of detected overflow nothing is done to the packet. + */ +int push_bytes(struct tlv_packet *packet, char *data, size_t size); + +/** + * Convenience function that forms a tlv header at the end of a packet. Reports + * potential overflow. + * + * In case of detected overflow nothing is done to the packet. + */ +int push_tlv_header(struct tlv_packet *packet, enum tlv_type type, size_t size); + +#endif /* PROTOCOL_PRIVATE_H */ -- cgit v1.2.3