MQTT / MQTTPacket

Basic C library for MQTT packet serialization and deserialization

Dependents:   MQTT MQTT MQTT MQTT ... more

Fork of MQTTPacket by MQTT

This library is part of the EclipseTM Paho project; specifically the embedded client.

A basic MQTT library in C for packet serialization and deserialization

MQTTConnectServer.c@25:aedcaf7984d5, 2017-10-30 (annotated)

Committer:
Ian Craggs
Date:
Mon Oct 30 12:47:11 2017 +0000
Revision:
25:aedcaf7984d5
Parent:
17:c5bd28cc139a 
Merging mine and Jan's changes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
icraggs 0:7734401cc1b4 1 /*******************************************************************************
icraggs 0:7734401cc1b4 2 * Copyright (c) 2014 IBM Corp.
icraggs 0:7734401cc1b4 3 *
icraggs 0:7734401cc1b4 4 * All rights reserved. This program and the accompanying materials
icraggs 0:7734401cc1b4 5 * are made available under the terms of the Eclipse Public License v1.0
icraggs 0:7734401cc1b4 6 * and Eclipse Distribution License v1.0 which accompany this distribution.
icraggs 0:7734401cc1b4 7 *
icraggs 0:7734401cc1b4 8 * The Eclipse Public License is available at
icraggs 0:7734401cc1b4 9 * http://www.eclipse.org/legal/epl-v10.html
icraggs 0:7734401cc1b4 10 * and the Eclipse Distribution License is available at
icraggs 0:7734401cc1b4 11 * http://www.eclipse.org/org/documents/edl-v10.php.
icraggs 0:7734401cc1b4 12 *
icraggs 0:7734401cc1b4 13 * Contributors:
icraggs 0:7734401cc1b4 14 * Ian Craggs - initial API and implementation and/or initial documentation
icraggs 0:7734401cc1b4 15 *******************************************************************************/
icraggs 0:7734401cc1b4 16
icraggs 0:7734401cc1b4 17 #include "StackTrace.h"
icraggs 0:7734401cc1b4 18 #include "MQTTPacket.h"
icraggs 0:7734401cc1b4 19 #include <string.h>
icraggs 0:7734401cc1b4 20
Ian Craggs 12:cd99ac9cb25a 21 #define min(a, b) ((a < b) ? a : b)
icraggs 0:7734401cc1b4 22
icraggs 0:7734401cc1b4 23
icraggs 0:7734401cc1b4 24 /**
icraggs 0:7734401cc1b4 25 * Validates MQTT protocol name and version combinations
icraggs 0:7734401cc1b4 26 * @param protocol the MQTT protocol name as an MQTTString
icraggs 0:7734401cc1b4 27 * @param version the MQTT protocol version number, as in the connect packet
icraggs 0:7734401cc1b4 28 * @return correct MQTT combination? 1 is true, 0 is false
icraggs 0:7734401cc1b4 29 */
icraggs 0:7734401cc1b4 30 int MQTTPacket_checkVersion(MQTTString* protocol, int version)
icraggs 0:7734401cc1b4 31 {
icraggs 0:7734401cc1b4 32 int rc = 0;
icraggs 0:7734401cc1b4 33
icraggs 0:7734401cc1b4 34 if (version == 3 && memcmp(protocol->lenstring.data, "MQIdsp",
Ian Craggs 12:cd99ac9cb25a 35 min(6, protocol->lenstring.len)) == 0)
icraggs 0:7734401cc1b4 36 rc = 1;
Ian Craggs 12:cd99ac9cb25a 37 else if (version == 4 && memcmp(protocol->lenstring.data, "MQTT",
Ian Craggs 12:cd99ac9cb25a 38 min(4, protocol->lenstring.len)) == 0)
icraggs 0:7734401cc1b4 39 rc = 1;
icraggs 1:069ae45b7070 40 return rc;
icraggs 0:7734401cc1b4 41 }
icraggs 0:7734401cc1b4 42
icraggs 0:7734401cc1b4 43
icraggs 0:7734401cc1b4 44 /**
icraggs 0:7734401cc1b4 45 * Deserializes the supplied (wire) buffer into connect data structure
icraggs 0:7734401cc1b4 46 * @param data the connect data structure to be filled out
icraggs 0:7734401cc1b4 47 * @param buf the raw buffer data, of the correct length determined by the remaining length field
icraggs 0:7734401cc1b4 48 * @param len the length in bytes of the data in the supplied buffer
icraggs 0:7734401cc1b4 49 * @return error code. 1 is success, 0 is failure
icraggs 0:7734401cc1b4 50 */
Ian Craggs 14:c2052aee81de 51 int MQTTDeserialize_connect(MQTTPacket_connectData* data, unsigned char* buf, int len)
icraggs 0:7734401cc1b4 52 {
icraggs 17:c5bd28cc139a 53 MQTTHeader header = {0};
icraggs 17:c5bd28cc139a 54 MQTTConnectFlags flags = {0};
Ian Craggs 14:c2052aee81de 55 unsigned char* curdata = buf;
Ian Craggs 14:c2052aee81de 56 unsigned char* enddata = &buf[len];
icraggs 0:7734401cc1b4 57 int rc = 0;
icraggs 0:7734401cc1b4 58 MQTTString Protocol;
icraggs 0:7734401cc1b4 59 int version;
icraggs 0:7734401cc1b4 60 int mylen = 0;
icraggs 0:7734401cc1b4 61
icraggs 0:7734401cc1b4 62 FUNC_ENTRY;
icraggs 0:7734401cc1b4 63 header.byte = readChar(&curdata);
icraggs 16:d0b3886ada32 64 if (header.bits.type != CONNECT)
icraggs 16:d0b3886ada32 65 goto exit;
icraggs 0:7734401cc1b4 66
Ian Craggs 12:cd99ac9cb25a 67 curdata += MQTTPacket_decodeBuf(curdata, &mylen); /* read remaining length */
icraggs 0:7734401cc1b4 68
icraggs 0:7734401cc1b4 69 if (!readMQTTLenString(&Protocol, &curdata, enddata) ||
icraggs 0:7734401cc1b4 70 enddata - curdata < 0) /* do we have enough data to read the protocol version byte? */
icraggs 0:7734401cc1b4 71 goto exit;
icraggs 0:7734401cc1b4 72
icraggs 0:7734401cc1b4 73 version = (int)readChar(&curdata); /* Protocol version */
icraggs 0:7734401cc1b4 74 /* If we don't recognize the protocol version, we don't parse the connect packet on the
icraggs 0:7734401cc1b4 75 * basis that we don't know what the format will be.
icraggs 0:7734401cc1b4 76 */
icraggs 0:7734401cc1b4 77 if (MQTTPacket_checkVersion(&Protocol, version))
icraggs 0:7734401cc1b4 78 {
icraggs 0:7734401cc1b4 79 flags.all = readChar(&curdata);
icraggs 0:7734401cc1b4 80 data->cleansession = flags.bits.cleansession;
icraggs 0:7734401cc1b4 81 data->keepAliveInterval = readInt(&curdata);
icraggs 0:7734401cc1b4 82 if (!readMQTTLenString(&data->clientID, &curdata, enddata))
icraggs 0:7734401cc1b4 83 goto exit;
icraggs 0:7734401cc1b4 84 if (flags.bits.will)
icraggs 0:7734401cc1b4 85 {
icraggs 0:7734401cc1b4 86 data->willFlag = 1;
icraggs 0:7734401cc1b4 87 data->will.qos = flags.bits.willQoS;
icraggs 0:7734401cc1b4 88 data->will.retained = flags.bits.willRetain;
icraggs 0:7734401cc1b4 89 if (!readMQTTLenString(&data->will.topicName, &curdata, enddata) ||
icraggs 0:7734401cc1b4 90 !readMQTTLenString(&data->will.message, &curdata, enddata))
icraggs 0:7734401cc1b4 91 goto exit;
icraggs 0:7734401cc1b4 92 }
icraggs 0:7734401cc1b4 93 if (flags.bits.username)
icraggs 0:7734401cc1b4 94 {
icraggs 0:7734401cc1b4 95 if (enddata - curdata < 3 || !readMQTTLenString(&data->username, &curdata, enddata))
icraggs 0:7734401cc1b4 96 goto exit; /* username flag set, but no username supplied - invalid */
icraggs 0:7734401cc1b4 97 if (flags.bits.password &&
icraggs 0:7734401cc1b4 98 (enddata - curdata < 3 || !readMQTTLenString(&data->password, &curdata, enddata)))
icraggs 0:7734401cc1b4 99 goto exit; /* password flag set, but no password supplied - invalid */
icraggs 0:7734401cc1b4 100 }
icraggs 0:7734401cc1b4 101 else if (flags.bits.password)
icraggs 0:7734401cc1b4 102 goto exit; /* password flag set without username - invalid */
icraggs 0:7734401cc1b4 103 rc = 1;
icraggs 0:7734401cc1b4 104 }
icraggs 0:7734401cc1b4 105 exit:
icraggs 0:7734401cc1b4 106 FUNC_EXIT_RC(rc);
icraggs 0:7734401cc1b4 107 return rc;
icraggs 0:7734401cc1b4 108 }
icraggs 0:7734401cc1b4 109
icraggs 0:7734401cc1b4 110
icraggs 0:7734401cc1b4 111 /**
icraggs 0:7734401cc1b4 112 * Serializes the connack packet into the supplied buffer.
icraggs 0:7734401cc1b4 113 * @param buf the buffer into which the packet will be serialized
icraggs 0:7734401cc1b4 114 * @param buflen the length in bytes of the supplied buffer
icraggs 0:7734401cc1b4 115 * @param connack_rc the integer connack return code to be used
icraggs 16:d0b3886ada32 116 * @param sessionPresent the MQTT 3.1.1 sessionPresent flag
icraggs 0:7734401cc1b4 117 * @return serialized length, or error if 0
icraggs 0:7734401cc1b4 118 */
icraggs 16:d0b3886ada32 119 int MQTTSerialize_connack(unsigned char* buf, int buflen, unsigned char connack_rc, unsigned char sessionPresent)
icraggs 0:7734401cc1b4 120 {
icraggs 17:c5bd28cc139a 121 MQTTHeader header = {0};
icraggs 0:7734401cc1b4 122 int rc = 0;
Ian Craggs 14:c2052aee81de 123 unsigned char *ptr = buf;
icraggs 17:c5bd28cc139a 124 MQTTConnackFlags flags = {0};
icraggs 0:7734401cc1b4 125
icraggs 0:7734401cc1b4 126 FUNC_ENTRY;
icraggs 0:7734401cc1b4 127 if (buflen < 2)
icraggs 0:7734401cc1b4 128 {
icraggs 0:7734401cc1b4 129 rc = MQTTPACKET_BUFFER_TOO_SHORT;
icraggs 0:7734401cc1b4 130 goto exit;
icraggs 0:7734401cc1b4 131 }
icraggs 0:7734401cc1b4 132 header.byte = 0;
icraggs 0:7734401cc1b4 133 header.bits.type = CONNACK;
icraggs 0:7734401cc1b4 134 writeChar(&ptr, header.byte); /* write header */
icraggs 0:7734401cc1b4 135
icraggs 0:7734401cc1b4 136 ptr += MQTTPacket_encode(ptr, 2); /* write remaining length */
icraggs 0:7734401cc1b4 137
icraggs 16:d0b3886ada32 138 flags.all = 0;
icraggs 16:d0b3886ada32 139 flags.bits.sessionpresent = sessionPresent;
icraggs 16:d0b3886ada32 140 writeChar(&ptr, flags.all);
icraggs 0:7734401cc1b4 141 writeChar(&ptr, connack_rc);
icraggs 0:7734401cc1b4 142
icraggs 0:7734401cc1b4 143 rc = ptr - buf;
icraggs 0:7734401cc1b4 144 exit:
icraggs 0:7734401cc1b4 145 FUNC_EXIT_RC(rc);
icraggs 0:7734401cc1b4 146 return rc;
icraggs 0:7734401cc1b4 147 }
icraggs 0:7734401cc1b4 148