Zoltan Hudak / Mbed OS MQTT_Hello

MQTT client to test the ENC28J60-EMAC on NUCLEO-F446RE.

Dependencies:   ENC28J60-EMAC

MQTT/MQTTPacket/MQTTConnectServer.c@5:d9570dbf2f82, 2021-03-29 (annotated)

Committer:
hudakz
Date:
Mon Mar 29 09:32:44 2021 +0000
Revision:
5:d9570dbf2f82
Parent:
0:238f0d0c0ba3 
MQTT client to test the ENC28J60-EMAC on NUCLEO-F446RE.

Who changed what in which revision?

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