libwebsockets
Lightweight C library for HTML5 websockets
lws-mqtt.h
1 /*
2  * libwebsockets - protocol - mqtt
3  *
4  * Copyright (C) 2010 - 2021 Andy Green <andy@warmcat.com>
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22  * IN THE SOFTWARE.
23  *
24  * included from libwebsockets.h
25  */
26 
27 #ifndef _LWS_MQTT_H
28 #define _LWS_MQTT_H 1
29 
30 struct _lws_mqtt_related;
31 typedef struct _lws_mqtt_related lws_mqtt_related_t;
32 struct lws_mqtt_str_st;
33 typedef struct lws_mqtt_str_st lws_mqtt_str_t;
34 
35 #define MQTT_VER_3_1_1 4
36 
37 #define LWS_MQTT_FINAL_PART 1
38 
39 #define LWS_MQTT_MAX_AWSIOT_TOPICLEN 256
40 #define LWS_MQTT_MAX_TOPICLEN 65535
41 #define LWS_MQTT_MAX_CIDLEN 128
42 #define LWS_MQTT_RANDOM_CIDLEN 23 /* 3.1.3.1-5: Server MUST... between
43  1 and 23 chars... */
44 
45 typedef enum {
46  QOS0,
47  QOS1,
48  QOS2, /* not supported */
49  RESERVED_QOS_LEVEL,
50  FAILURE_QOS_LEVEL = 0x80
51 } lws_mqtt_qos_levels_t;
52 
53 typedef union {
54  struct {
55  uint8_t retain:1;
56  uint8_t qos:2;
57  uint8_t dup:1;
58  uint8_t ctrl_pkt_type:4;
59  } flags;
60  uint8_t bits;
62 
63 /*
64  * MQTT connection parameters, passed into struct
65  * lws_client_connect_info to establish a connection using
66  * lws_client_connect_via_info().
67 */
68 typedef struct lws_mqtt_client_connect_param_s {
69  const char *client_id; /* Client ID */
70  uint16_t keep_alive; /* MQTT keep alive
71  interval in
72  seconds */
73  uint8_t clean_start:1; /* MQTT clean
74  session */
75  uint8_t client_id_nofree:1;
77  struct {
78  const char *topic;
79  const char *message;
80  lws_mqtt_qos_levels_t qos;
81  uint8_t retain;
82  } will_param; /* MQTT LWT
83  parameters */
84  struct {
85  const char *topic;
86  const char *message;
87  lws_mqtt_qos_levels_t qos;
88  uint8_t retain;
89  } birth_param; /* MQTT Birth
90  parameters */
91  const char *username;
92  const char *password;
93  uint8_t aws_iot;
95 
96 /*
97  * MQTT publish parameters
98 */
99 typedef struct lws_mqtt_publish_param_s {
100  char *topic; /* Topic Name */
101  uint16_t topic_len;
102  const void *payload; /* Publish Payload */
103  uint32_t payload_len; /* Size of the
104  complete payload */
105  uint32_t payload_pos; /* where we are in payload */
106  lws_mqtt_qos_levels_t qos;
107 
108  /*--v-Following will be used by LWS-v--*/
109  uint16_t packet_id; /* Packet ID for QoS >
110  0 */
111  uint8_t dup:1; /* Retried PUBLISH,
112  for QoS > 0 */
114 
115 typedef struct topic_elem {
116  const char *name; /* Topic Name */
117  lws_mqtt_qos_levels_t qos; /* Requested QoS */
118 
119  /*--v-Following will be used by LWS-v--*/
120  uint8_t acked;
122 
123 /*
124  * MQTT publish parameters
125 */
126 typedef struct lws_mqtt_subscribe_param_s {
127  uint32_t num_topics; /* Number of topics */
128  lws_mqtt_topic_elem_t *topic; /* Array of topic elements */
129 
130  /*--v-Following will be used by LWS-v--*/
131  uint16_t packet_id;
133 
134 typedef enum {
135  LMQCP_RESERVED,
136  LMQCP_CTOS_CONNECT, /* Connection request */
137  LMQCP_STOC_CONNACK, /* Connection acknowledgment */
138  LMQCP_PUBLISH, /* Publish Message */
139  LMQCP_PUBACK, /* QoS 1: Publish acknowledgment */
140  LMQCP_PUBREC, /* QoS 2.1: Publish received */
141  LMQCP_PUBREL, /* QoS 2.2: Publish release */
142  LMQCP_PUBCOMP, /* QoS 2.3: Publish complete */
143  LMQCP_CTOS_SUBSCRIBE, /* Subscribe request */
144  LMQCP_STOC_SUBACK, /* Subscribe acknowledgment */
145  LMQCP_CTOS_UNSUBSCRIBE, /* Unsubscribe request */
146  LMQCP_STOC_UNSUBACK, /* Unsubscribe acknowledgment */
147  LMQCP_CTOS_PINGREQ, /* PING request */
148  LMQCP_STOC_PINGRESP, /* PONG response */
149  LMQCP_DISCONNECT, /* Disconnect notification */
150  LMQCP_AUTH /* Authentication exchange */
151 } lws_mqtt_control_packet_t;
152 
153 /* flags from byte 8 of C_TO_S CONNECT */
154 typedef enum {
155  LMQCFT_CLIENT_ID_NOFREE = (1 << 8),
156  /* only the low 8 are standardized and go out in the protocol */
157  LMQCFT_USERNAME = (1 << 7),
158  LMQCFT_PASSWORD = (1 << 6),
159  LMQCFT_WILL_RETAIN = (1 << 5),
160  LMQCFT_WILL_QOS = (1 << 3),
161  LMQCFT_WILL_FLAG = (1 << 2),
162  LMQCFT_CLEAN_START = (1 << 1),
163  LMQCFT_RESERVED = (1 << 0),
164 
165  LMQCFT_WILL_QOS_MASK = (3 << 3),
166 } lws_mqtt_connect_flags_t;
167 
168 /* flags for S_TO_C CONNACK */
169 typedef enum {
170  LMQCFT_SESSION_PRESENT = (1 << 0),
171 } lws_mqtt_connack_flags_t;
172 
173 typedef enum {
174  LMQCP_REASON_SUCCESS = 0x00,
175  LMQCP_REASON_NORMAL_DISCONNECTION = 0x00,
176  LMQCP_REASON_GRANTED_QOS0 = 0x00,
177  LMQCP_REASON_GRANTED_QOS1 = 0x01,
178  LMQCP_REASON_GRANTED_QOS2 = 0x02,
179  LMQCP_REASON_DISCONNECT_WILL = 0x04,
180  LMQCP_REASON_NO_MATCHING_SUBSCRIBER = 0x10,
181  LMQCP_REASON_NO_SUBSCRIPTION_EXISTED = 0x11,
182  LMQCP_REASON_CONTINUE_AUTHENTICATION = 0x18,
183  LMQCP_REASON_RE_AUTHENTICATE = 0x19,
184 
185  LMQCP_REASON_UNSPECIFIED_ERROR = 0x80,
186  LMQCP_REASON_MALFORMED_PACKET = 0x81,
187  LMQCP_REASON_PROTOCOL_ERROR = 0x82,
188  LMQCP_REASON_IMPLEMENTATION_SPECIFIC_ERROR = 0x83,
189 
190  /* Begin - Error codes for CONNACK */
191  LMQCP_REASON_UNSUPPORTED_PROTOCOL = 0x84,
192  LMQCP_REASON_CLIENT_ID_INVALID = 0x85,
193  LMQCP_REASON_BAD_CREDENTIALS = 0x86,
194  LMQCP_REASON_NOT_AUTHORIZED = 0x87,
195  /* End - Error codes for CONNACK */
196 
197  LMQCP_REASON_SERVER_UNAVAILABLE = 0x88,
198  LMQCP_REASON_SERVER_BUSY = 0x89,
199  LMQCP_REASON_BANNED = 0x8a,
200  LMQCP_REASON_SERVER_SHUTTING_DOWN = 0x8b,
201  LMQCP_REASON_BAD_AUTHENTICATION_METHOD = 0x8c,
202  LMQCP_REASON_KEEPALIVE_TIMEOUT = 0x8d,
203  LMQCP_REASON_SESSION_TAKEN_OVER = 0x8e,
204  LMQCP_REASON_TOPIC_FILTER_INVALID = 0x8f,
205  LMQCP_REASON_TOPIC_NAME_INVALID = 0x90,
206  LMQCP_REASON_PACKET_ID_IN_USE = 0x91,
207  LMQCP_REASON_PACKET_ID_NOT_FOUND = 0x92,
208  LMQCP_REASON_MAX_RX_EXCEEDED = 0x93,
209  LMQCP_REASON_TOPIC_ALIAS_INVALID = 0x94,
210  LMQCP_REASON_PACKET_TOO_LARGE = 0x95,
211  LMQCP_REASON_RATELIMIT = 0x96,
212  LMQCP_REASON_QUOTA_EXCEEDED = 0x97,
213  LMQCP_REASON_ADMINISTRATIVE_ACTION = 0x98,
214  LMQCP_REASON_PAYLOAD_FORMAT_INVALID = 0x99,
215  LMQCP_REASON_RETAIN_NOT_SUPPORTED = 0x9a,
216  LMQCP_REASON_QOS_NOT_SUPPORTED = 0x9b,
217  LMQCP_REASON_USE_ANOTHER_SERVER = 0x9c,
218  LMQCP_REASON_SERVER_MOVED = 0x9d,
219  LMQCP_REASON_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED = 0x9e,
220  LMQCP_REASON_CONNECTION_RATE_EXCEEDED = 0x9f,
221  LMQCP_REASON_MAXIMUM_CONNECT_TIME = 0xa0,
222  LMQCP_REASON_SUBSCRIPTION_IDS_NOT_SUPPORTED = 0xa1,
223  LMQCP_REASON_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED = 0xa2,
224 } lws_mqtt_reason_t;
225 
226 typedef enum {
227  LMQPROP_INVALID,
228  LMQPROP_PAYLOAD_FORMAT_INDICATOR = 0x01,
229  LMQPROP_MESSAGE_EXPIRY_INTERVAL = 0x02,
230  LMQPROP_CONTENT_TYPE = 0x03,
231  LMQPROP_RESPONSE_TOPIC = 0x08,
232  LMQPROP_CORRELATION_DATA = 0x09,
233  LMQPROP_SUBSCRIPTION_IDENTIFIER = 0x0b,
234  LMQPROP_SESSION_EXPIRY_INTERVAL = 0x11,
235  LMQPROP_ASSIGNED_CLIENT_IDENTIFIER = 0x12,
236  LMQPROP_SERVER_KEEP_ALIVE = 0x13,
237  LMQPROP_AUTHENTICATION_METHOD = 0x15,
238  LMQPROP_AUTHENTICATION_DATA = 0x16,
239  LMQPROP_REQUEST_PROBLEM_INFORMATION = 0x17,
240  LMQPROP_WILL_DELAY_INTERVAL = 0x18,
241  LMQPROP_REQUEST_RESPONSE_INFORMATION = 0x19,
242  LMQPROP_RESPONSE_INFORMATION = 0x1a,
243  LMQPROP_SERVER_REFERENCE = 0x1c,
244  LMQPROP_REASON_STRING = 0x1f,
245  LMQPROP_RECEIVE_MAXIMUM = 0x21,
246  LMQPROP_TOPIC_ALIAS_MAXIMUM = 0x22,
247  LMQPROP_TOPIC_ALIAS = 0x23,
248  LMQPROP_MAXIMUM_QOS = 0x24,
249  LMQPROP_RETAIN_AVAILABLE = 0x25,
250  LMQPROP_USER_PROPERTY = 0x26,
251  LMQPROP_MAXIMUM_PACKET_SIZE = 0x27,
252  LMQPROP_WILDCARD_SUBSCRIPTION_AVAIL = 0x28,
253  LMQPROP_SUBSCRIPTION_IDENTIFIER_AVAIL = 0x29,
254  LMQPROP_SHARED_SUBSCRIPTION_AVAIL = 0x2a
255 } lws_mqtt_property;
256 
257 int
258 lws_read_mqtt(struct lws *wsi, unsigned char *buf, lws_filepos_t len);
259 
260 /* returns 0 if bd1 and bd2 are "the same", that includes empty, else nonzero */
261 LWS_VISIBLE LWS_EXTERN int
262 lws_mqtt_bindata_cmp(const lws_mqtt_str_t *bd1, const lws_mqtt_str_t *bd2);
263 
264 LWS_VISIBLE LWS_EXTERN void
265 lws_mqtt_str_init(lws_mqtt_str_t *s, uint8_t *buf, uint16_t lim, char nf);
266 
267 LWS_VISIBLE LWS_EXTERN lws_mqtt_str_t *
268 lws_mqtt_str_create(uint16_t lim);
269 
270 LWS_VISIBLE LWS_EXTERN lws_mqtt_str_t *
271 lws_mqtt_str_create_init(uint8_t *buf, uint16_t len, uint16_t lim);
272 
273 LWS_VISIBLE LWS_EXTERN lws_mqtt_str_t *
274 lws_mqtt_str_create_cstr_dup(const char *buf, uint16_t lim);
275 
276 LWS_VISIBLE LWS_EXTERN uint8_t *
277 lws_mqtt_str_next(lws_mqtt_str_t *s, uint16_t *budget);
278 
279 LWS_VISIBLE LWS_EXTERN int
280 lws_mqtt_str_advance(lws_mqtt_str_t *s, int n);
281 
282 LWS_VISIBLE LWS_EXTERN void
283 lws_mqtt_str_free(lws_mqtt_str_t **s);
284 
285 
313 LWS_VISIBLE LWS_EXTERN int
314 lws_mqtt_client_send_publish(struct lws *wsi, lws_mqtt_publish_param_t *pub,
315  const void *buf, uint32_t len, int final);
316 
330 LWS_VISIBLE LWS_EXTERN int
331 lws_mqtt_client_send_subcribe(struct lws *wsi, lws_mqtt_subscribe_param_t *sub);
332 
347 LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
348 lws_mqtt_client_send_unsubcribe(struct lws *wsi,
349  const lws_mqtt_subscribe_param_t *unsub);
350 
351 #endif /* _LWS_MQTT_H */
Definition: lws-mqtt.h:67
uint8_t client_id_nofree
Definition: lws-mqtt.h:74
Definition: lws-mqtt.h:98
Definition: lws-mqtt.h:125
Definition: lws-mqtt.h:114
Definition: lws-mqtt.h:52