Loading...
Searching...
No Matches
nanocoap.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2016-18 Kaspar Schleiser <kaspar@schleiser.de>
3 * 2018 Freie Universität Berlin
4 * 2018 Inria
5 * 2018 Ken Bannister <kb2ma@runbox.com>
6 *
7 * This file is subject to the terms and conditions of the GNU Lesser
8 * General Public License v2.1. See the file LICENSE in the top level
9 * directory for more details.
10 */
11
12#pragma once
13
78
79#include <assert.h>
80#include <errno.h>
81#include <stdint.h>
82#include <stdbool.h>
83#include <stddef.h>
84#include <string.h>
85#include <unistd.h>
86
87#include "bitarithm.h"
88#include "bitfield.h"
89#include "byteorder.h"
90#include "iolist.h"
91#include "macros/utils.h"
92#include "modules.h"
93#include "net/coap.h"
94#include "net/sock/udp.h"
95
96#if defined(MODULE_NANOCOAP_RESOURCES)
97#include "xfa.h"
98#endif
99
100#ifdef __cplusplus
101extern "C" {
102#endif
103
109#define COAP_GET (0x01)
110#define COAP_POST (0x02)
111#define COAP_PUT (0x04)
112#define COAP_DELETE (0x08)
113#define COAP_FETCH (0x10)
114#define COAP_PATCH (0x20)
115#define COAP_IPATCH (0x40)
116#define COAP_IGNORE (0xFF)
118#define COAP_MATCH_SUBTREE (0x8000)
121
125#define COAP_FORMAT_NONE (UINT16_MAX)
126
134#ifndef CONFIG_NANOCOAP_NOPTS_MAX
135#define CONFIG_NANOCOAP_NOPTS_MAX (16)
136#endif
137
142#ifndef CONFIG_NANOCOAP_URI_MAX
143#define CONFIG_NANOCOAP_URI_MAX (64)
144#endif
145
149#ifndef CONFIG_NANOCOAP_BLOCK_SIZE_EXP_MAX
150#define CONFIG_NANOCOAP_BLOCK_SIZE_EXP_MAX (6)
151#endif
152
156#ifndef CONFIG_NANOCOAP_BLOCKSIZE_DEFAULT
157#define CONFIG_NANOCOAP_BLOCKSIZE_DEFAULT COAP_BLOCKSIZE_64
158#endif
159
161#ifndef CONFIG_NANOCOAP_QS_MAX
162#define CONFIG_NANOCOAP_QS_MAX (64)
163#endif
165
171#ifndef CONFIG_NANOCOAP_BLOCK_HEADER_MAX
172#define CONFIG_NANOCOAP_BLOCK_HEADER_MAX (80)
173#endif
174
182#define COAP_OPT_FINISH_NONE (0x0000)
184#define COAP_OPT_FINISH_PAYLOAD (0x0001)
186
190typedef struct __attribute__((packed)) {
191 uint8_t ver_t_tkl;
192 uint8_t code;
193 uint16_t id;
194} coap_hdr_t;
195
199typedef struct {
200 uint16_t opt_num;
201 uint16_t offset;
203
221typedef struct {
223 uint8_t *payload;
225 uint16_t payload_len;
226 uint16_t options_len;
229#ifdef MODULE_GCOAP
230 uint32_t observe_value;
231#endif
232} coap_pkt_t;
233
238
261typedef ssize_t (*coap_handler_t)(coap_pkt_t *pkt, uint8_t *buf, size_t len,
262 coap_request_ctx_t *context);
263
276typedef int (*coap_blockwise_cb_t)(void *arg, size_t offset, uint8_t *buf, size_t len, int more);
277
288typedef int (*coap_request_cb_t)(void *arg, coap_pkt_t *pkt);
289
295typedef uint16_t coap_method_flags_t;
296
306
310typedef const struct {
312 const size_t resources_numof;
314
322
330#if defined(MODULE_SOCK_AUX_LOCAL) || DOXYGEN
332#endif
333#if defined(MODULE_GCOAP) || DOXYGEN
340 uint32_t tl_type;
341#endif
342};
343
344/* forward declarations */
345static inline uint8_t *coap_hdr_data_ptr(const coap_hdr_t *hdr);
346static inline size_t coap_hdr_get_token_len(const coap_hdr_t *hdr);
347static inline const void * coap_hdr_get_token(const coap_hdr_t *hdr);
348
357
366
376
386
396
400typedef struct {
401 size_t offset;
402 uint32_t blknum;
403 uint8_t szx;
404 int8_t more;
407
411typedef struct {
412 size_t start;
413 size_t end;
414 size_t cur;
415 uint8_t *opt;
417
418#if defined(MODULE_NANOCOAP_RESOURCES) || DOXYGEN
424#define NANOCOAP_RESOURCE(name) \
425 XFA_CONST(coap_resource_t, coap_resources_xfa, 0) CONCAT(coap_resource_, name) =
426#else
432extern const coap_resource_t coap_resources[];
433
439extern const unsigned coap_resources_numof;
440#endif
441
456static inline uint8_t coap_code(unsigned cls, unsigned detail)
457{
458 return (cls << 5) | detail;
459}
460
468static inline unsigned coap_get_code_class(const coap_pkt_t *pkt)
469{
470 return pkt->hdr->code >> 5;
471}
472
480static inline unsigned coap_get_code_detail(const coap_pkt_t *pkt)
481{
482 return pkt->hdr->code & 0x1f;
483}
484
492static inline unsigned coap_get_code_decimal(const coap_pkt_t *pkt)
493{
494 return (coap_get_code_class(pkt) * 100) + coap_get_code_detail(pkt);
495}
496
504static inline unsigned coap_get_code_raw(const coap_pkt_t *pkt)
505{
506 return (unsigned)pkt->hdr->code;
507}
508
516static inline coap_method_t coap_get_method(const coap_pkt_t *pkt)
517{
518 return pkt->hdr->code;
519}
520
528static inline unsigned coap_get_id(const coap_pkt_t *pkt)
529{
530 return ntohs(pkt->hdr->id);
531}
532
543static inline unsigned coap_get_token_len(const coap_pkt_t *pkt)
544{
545 return coap_hdr_get_token_len(pkt->hdr);
546}
547
555static inline void *coap_get_token(const coap_pkt_t *pkt)
556{
557 return coap_hdr_data_ptr(pkt->hdr);
558}
559
569static inline unsigned coap_get_total_len(const coap_pkt_t *pkt)
570{
571 return (uintptr_t)pkt->payload - (uintptr_t)pkt->hdr + pkt->payload_len;
572}
573
584static inline unsigned coap_get_type(const coap_pkt_t *pkt)
585{
586 return (pkt->hdr->ver_t_tkl & 0x30) >> 4;
587}
588
596static inline unsigned coap_get_ver(const coap_pkt_t *pkt)
597{
598 return (pkt->hdr->ver_t_tkl & 0x60) >> 6;
599}
600
611static inline uint8_t coap_hdr_tkl_ext_len(const coap_hdr_t *hdr)
612{
613 if (!IS_USED(MODULE_NANOCOAP_TOKEN_EXT)) {
614 return 0;
615 }
616
617 switch (hdr->ver_t_tkl & 0xf) {
618 case 13:
619 return 1;
620 case 14:
621 return 2;
622 case 15:
623 assert(0);
624 /* fall-through */
625 default:
626 return 0;
627 }
628}
629
637static inline uint8_t *coap_hdr_data_ptr(const coap_hdr_t *hdr)
638{
639 return ((uint8_t *)hdr) + sizeof(coap_hdr_t) + coap_hdr_tkl_ext_len(hdr);
640}
641
649static inline unsigned coap_get_total_hdr_len(const coap_pkt_t *pkt)
650{
651 return sizeof(coap_hdr_t) + coap_hdr_tkl_ext_len(pkt->hdr) +
653}
654
666static inline unsigned coap_get_response_hdr_len(const coap_pkt_t *pkt)
667{
668 return coap_get_total_hdr_len(pkt);
669}
670
677static inline void coap_hdr_set_code(coap_hdr_t *hdr, uint8_t code)
678{
679 hdr->code = code;
680}
681
688static inline void coap_pkt_set_code(coap_pkt_t *pkt, uint8_t code)
689{
690 coap_hdr_set_code(pkt->hdr, code);
691}
692
701static inline void coap_hdr_set_type(coap_hdr_t *hdr, unsigned type)
702{
703 /* assert correct range of type */
704 assert(!(type & ~0x3));
705
706 hdr->ver_t_tkl &= ~0x30;
707 hdr->ver_t_tkl |= type << 4;
708}
709
725static inline size_t coap_hdr_get_token_len(const coap_hdr_t *hdr)
726{
727 const uint8_t *buf = (const void *)hdr;
728 /* Regarding use unnamed magic numbers 13 and 269:
729 * - If token length is < 13 it fits into TKL field (4 bit)
730 * - If token length is < 269 it fits into 8-bit extended TKL field
731 * - Otherwise token length goes into 16-bit extended TKL field.
732 *
733 * (Not using named constants here, as RFC 8974 also has no names for those
734 * magic numbers.)
735 *
736 * See: https://www.rfc-editor.org/rfc/rfc8974#name-extended-token-length-tkl-f
737 */
738 switch (coap_hdr_tkl_ext_len(hdr)) {
739 case 0:
740 return hdr->ver_t_tkl & 0xf;
741 case 1:
742 return buf[sizeof(coap_hdr_t)] + 13;
743 case 2:
744 return byteorder_bebuftohs(buf + sizeof(coap_hdr_t)) + 269;
745 }
746
747 return 0;
748}
749
765static inline const void * coap_hdr_get_token(const coap_hdr_t *hdr)
766{
767 uint8_t *token = (void *)hdr;
768 token += sizeof(*hdr) + coap_hdr_tkl_ext_len(hdr);
769 return token;
770}
771
786static inline size_t coap_hdr_len(const coap_hdr_t *hdr)
787{
788 return sizeof(*hdr) + coap_hdr_tkl_ext_len(hdr) + coap_hdr_get_token_len(hdr);
789}
790
791
808
818uint8_t *coap_find_option(coap_pkt_t *pkt, unsigned opt_num);
819
832uint8_t *coap_iterate_option(coap_pkt_t *pkt, unsigned opt_num,
833 uint8_t **opt_pos, int *opt_len);
834
844
854
867int coap_opt_get_uint(coap_pkt_t *pkt, uint16_t optnum, uint32_t *value);
868
886ssize_t coap_opt_get_string(coap_pkt_t *pkt, uint16_t optnum,
887 uint8_t *target, size_t max_len, char separator);
888
904static inline ssize_t coap_get_location_path(coap_pkt_t *pkt,
905 uint8_t *target, size_t max_len)
906{
907 return coap_opt_get_string(pkt, COAP_OPT_LOCATION_PATH,
908 target, max_len, '/');
909}
910
926static inline ssize_t coap_get_location_query(coap_pkt_t *pkt,
927 uint8_t *target, size_t max_len)
928{
929 return coap_opt_get_string(pkt, COAP_OPT_LOCATION_QUERY,
930 target, max_len, '&');
931}
932
947static inline ssize_t coap_get_uri_path(coap_pkt_t *pkt, uint8_t *target)
948{
949 return coap_opt_get_string(pkt, COAP_OPT_URI_PATH, target,
951}
952
966static inline ssize_t coap_get_uri_query_string(coap_pkt_t *pkt, char *target,
967 size_t max_len)
968{
969 return coap_opt_get_string(pkt, COAP_OPT_URI_QUERY,
970 (uint8_t *)target, max_len, '&');
971}
972
987bool coap_find_uri_query(coap_pkt_t *pkt, const char *key,
988 const char **value, size_t *len);
989
1012 char *key, size_t key_len_max,
1013 char *value, size_t value_len_max);
1014
1045 uint8_t **value, bool init_opt);
1046
1063ssize_t coap_opt_get_opaque(coap_pkt_t *pkt, unsigned opt_num, uint8_t **value);
1065
1078static inline ssize_t coap_get_proxy_uri(coap_pkt_t *pkt, char **target)
1079{
1080 return coap_opt_get_opaque(pkt, COAP_OPT_PROXY_URI, (uint8_t **)target);
1081}
1082
1100void coap_block_object_init(coap_block1_t *block, size_t blknum, size_t blksize,
1101 int more);
1102
1118bool coap_block_finish(coap_block_slicer_t *slicer, uint16_t option);
1119
1134static inline bool coap_block1_finish(coap_block_slicer_t *slicer)
1135{
1136 return coap_block_finish(slicer, COAP_OPT_BLOCK1);
1137}
1138
1153static inline bool coap_block2_finish(coap_block_slicer_t *slicer)
1154{
1155 return coap_block_finish(slicer, COAP_OPT_BLOCK2);
1156}
1157
1168
1179 size_t blksize);
1180
1195size_t coap_blockwise_put_bytes(coap_block_slicer_t *slicer, uint8_t *bufpos,
1196 const void *c, size_t len);
1197
1211size_t coap_blockwise_put_char(coap_block_slicer_t *slicer, uint8_t *bufpos, char c);
1212
1231int coap_get_block(coap_pkt_t *pkt, coap_block1_t *block, uint16_t option);
1232
1250static inline int coap_get_block1(coap_pkt_t *pkt, coap_block1_t *block)
1251{
1252 return coap_get_block(pkt, block, COAP_OPT_BLOCK1);
1253}
1254
1264static inline int coap_get_block2(coap_pkt_t *pkt, coap_block1_t *block)
1265{
1266 return coap_get_block(pkt, block, COAP_OPT_BLOCK2);
1267}
1268
1281int coap_get_blockopt(coap_pkt_t *pkt, uint16_t option, uint32_t *blknum, uint8_t *szx);
1282
1301
1309#define coap_szx2size(szx) (1U << ((szx) + 4))
1310
1318static inline unsigned coap_size2szx(unsigned len)
1319{
1320 assert(len >= 16);
1321 return bitarithm_msb(len >> 4);
1322}
1323
1324
1356 bool more, uint16_t option);
1357
1376static inline ssize_t coap_opt_add_block1(coap_pkt_t *pkt,
1377 coap_block_slicer_t *slicer, bool more)
1378{
1379 return coap_opt_add_block(pkt, slicer, more, COAP_OPT_BLOCK1);
1380}
1381
1400static inline ssize_t coap_opt_add_block2(coap_pkt_t *pkt,
1401 coap_block_slicer_t *slicer, bool more)
1402{
1403 return coap_opt_add_block(pkt, slicer, more, COAP_OPT_BLOCK2);
1404}
1405
1419ssize_t coap_opt_add_uint(coap_pkt_t *pkt, uint16_t optnum, uint32_t value);
1420
1434static inline ssize_t coap_opt_add_block1_control(coap_pkt_t *pkt, coap_block1_t *block) {
1435 return coap_opt_add_uint(pkt, COAP_OPT_BLOCK1,
1436 (block->blknum << 4) | block->szx | (block->more ? 0x8 : 0));
1437}
1438
1452static inline ssize_t coap_opt_add_block2_control(coap_pkt_t *pkt, coap_block1_t *block) {
1453 /* block.more must be zero, so no need to 'or' it in */
1454 return coap_opt_add_uint(pkt, COAP_OPT_BLOCK2,
1455 (block->blknum << 4) | block->szx);
1456}
1457
1471static inline ssize_t coap_opt_add_accept(coap_pkt_t *pkt, uint16_t format)
1472{
1473 return coap_opt_add_uint(pkt, COAP_OPT_ACCEPT, format);
1474}
1475
1489static inline ssize_t coap_opt_add_format(coap_pkt_t *pkt, uint16_t format)
1490{
1491 return coap_opt_add_uint(pkt, COAP_OPT_CONTENT_FORMAT, format);
1492}
1493
1509ssize_t coap_opt_add_opaque(coap_pkt_t *pkt, uint16_t optnum, const void *val, size_t val_len);
1510
1528ssize_t coap_opt_add_uri_query2(coap_pkt_t *pkt, const char *key, size_t key_len,
1529 const char *val, size_t val_len);
1530
1547static inline ssize_t coap_opt_add_uri_query(coap_pkt_t *pkt, const char *key,
1548 const char *val)
1549{
1550 return coap_opt_add_uri_query2(pkt, key, strlen(key), val, val ? strlen(val) : 0);
1551}
1552
1567ssize_t coap_opt_add_proxy_uri(coap_pkt_t *pkt, const char *uri);
1568
1587ssize_t coap_opt_add_chars(coap_pkt_t *pkt, uint16_t optnum, const char *chars,
1588 size_t chars_len, char separator);
1589
1607static inline ssize_t coap_opt_add_string(coap_pkt_t *pkt, uint16_t optnum,
1608 const char *string, char separator)
1609{
1610 return coap_opt_add_chars(pkt, optnum, string, strlen(string), separator);
1611}
1612
1627static inline ssize_t coap_opt_add_uri_path(coap_pkt_t *pkt, const char *path)
1628{
1629 return coap_opt_add_string(pkt, COAP_OPT_URI_PATH, path, '/');
1630}
1631
1647static inline ssize_t coap_opt_add_uri_path_buffer(coap_pkt_t *pkt,
1648 const char *path,
1649 size_t path_len)
1650{
1651 return coap_opt_add_chars(pkt, COAP_OPT_URI_PATH, path, path_len, '/');
1652}
1653
1666ssize_t coap_opt_finish(coap_pkt_t *pkt, uint16_t flags);
1667
1685ssize_t coap_opt_remove(coap_pkt_t *pkt, uint16_t optnum);
1687
1713size_t coap_opt_put_block(uint8_t *buf, uint16_t lastonum, coap_block_slicer_t *slicer,
1714 bool more, uint16_t option);
1715
1731static inline size_t coap_opt_put_block1(uint8_t *buf, uint16_t lastonum,
1732 coap_block_slicer_t *slicer, bool more)
1733{
1734 return coap_opt_put_block(buf, lastonum, slicer, more, COAP_OPT_BLOCK1);
1735}
1736
1752static inline size_t coap_opt_put_block2(uint8_t *buf, uint16_t lastonum,
1753 coap_block_slicer_t *slicer, bool more)
1754{
1755 return coap_opt_put_block(buf, lastonum, slicer, more, COAP_OPT_BLOCK2);
1756}
1757
1769size_t coap_opt_put_uint(uint8_t *buf, uint16_t lastonum, uint16_t onum,
1770 uint32_t value);
1771
1781static inline size_t coap_opt_put_block1_control(uint8_t *buf, uint16_t lastonum,
1782 coap_block1_t *block)
1783{
1784 return coap_opt_put_uint(buf, lastonum, COAP_OPT_BLOCK1,
1785 (block->blknum << 4) | block->szx | (block->more ? 0x8 : 0));
1786}
1787
1799static inline size_t coap_opt_put_block2_control(uint8_t *buf, uint16_t lastonum,
1800 coap_block1_t *block)
1801{
1802 /* block.more must be zero, so no need to 'or' it in */
1803 return coap_opt_put_uint(buf, lastonum, COAP_OPT_BLOCK2,
1804 (block->blknum << 4) | block->szx);
1805}
1806
1816static inline size_t coap_opt_put_observe(uint8_t *buf, uint16_t lastonum,
1817 uint32_t obs)
1818{
1819 obs &= COAP_OBS_MAX_VALUE_MASK; /* trim obs down to 24 bit */
1820 return coap_opt_put_uint(buf, lastonum, COAP_OPT_OBSERVE, obs);
1821}
1822
1836size_t coap_opt_put_string_with_len(uint8_t *buf, uint16_t lastonum, uint16_t optnum,
1837 const char *string, size_t len, char separator);
1850static inline size_t coap_opt_put_string(uint8_t *buf, uint16_t lastonum,
1851 uint16_t optnum,
1852 const char *string, char separator)
1853{
1854 return coap_opt_put_string_with_len(buf, lastonum, optnum,
1855 string, strlen(string), separator);
1856}
1857
1868static inline size_t coap_opt_put_location_path(uint8_t *buf,
1869 uint16_t lastonum,
1870 const char *location)
1871{
1872 return coap_opt_put_string(buf, lastonum, COAP_OPT_LOCATION_PATH,
1873 location, '/');
1874}
1875
1886static inline size_t coap_opt_put_location_query(uint8_t *buf,
1887 uint16_t lastonum,
1888 const char *location)
1889{
1890 return coap_opt_put_string(buf, lastonum, COAP_OPT_LOCATION_QUERY,
1891 location, '&');
1892}
1893
1904static inline size_t coap_opt_put_uri_path(uint8_t *buf, uint16_t lastonum,
1905 const char *uri)
1906{
1907 return coap_opt_put_string(buf, lastonum, COAP_OPT_URI_PATH, uri, '/');
1908}
1909
1920static inline size_t coap_opt_put_uri_query(uint8_t *buf, uint16_t lastonum,
1921 const char *uri)
1922{
1923 return coap_opt_put_string(buf, lastonum, COAP_OPT_URI_QUERY, uri, '&');
1924}
1925
1944size_t coap_opt_put_uri_pathquery(uint8_t *buf, uint16_t *lastonum, const char *uri);
1945
1956static inline size_t coap_opt_put_proxy_uri(uint8_t *buf, uint16_t lastonum,
1957 const char *uri)
1958{
1959 return coap_opt_put_string(buf, lastonum, COAP_OPT_PROXY_URI, uri, '\0');
1960}
1961
1979size_t coap_put_block1_ok(uint8_t *pkt_pos, coap_block1_t *block1, uint16_t lastonum);
1980
1997size_t coap_put_option(uint8_t *buf, uint16_t lastonum, uint16_t onum, const void *odata, size_t olen);
1998
2011static inline size_t coap_put_option_block1(uint8_t *buf, uint16_t lastonum,
2012 unsigned blknum, unsigned szx, int more)
2013{
2014 return coap_opt_put_uint(buf, lastonum, COAP_OPT_BLOCK1,
2015 (blknum << 4) | szx | (more ? 0x8 : 0));
2016}
2017
2028static inline size_t coap_put_option_ct(uint8_t *buf, uint16_t lastonum,
2029 uint16_t content_type)
2030{
2031 return coap_opt_put_uint(buf, lastonum, COAP_OPT_CONTENT_FORMAT, content_type);
2032}
2033
2034
2061ssize_t coap_block2_build_reply(coap_pkt_t *pkt, unsigned code,
2062 uint8_t *rbuf, unsigned rlen, unsigned payload_len,
2063 coap_block_slicer_t *slicer);
2064
2084ssize_t coap_build_hdr(coap_hdr_t *hdr, unsigned type, const void *token,
2085 size_t token_len, unsigned code, uint16_t id);
2086
2146ssize_t coap_build_reply(coap_pkt_t *pkt, unsigned code,
2147 uint8_t *rbuf, unsigned rlen, unsigned max_data_len);
2148
2164
2179ssize_t coap_handle_req(coap_pkt_t *pkt, uint8_t *resp_buf, unsigned resp_buf_len,
2180 coap_request_ctx_t *ctx);
2181
2198ssize_t coap_tree_handler(coap_pkt_t *pkt, uint8_t *resp_buf,
2199 unsigned resp_buf_len, coap_request_ctx_t *ctx,
2200 const coap_resource_t *resources,
2201 size_t resources_numof);
2202
2220ssize_t coap_subtree_handler(coap_pkt_t *pkt, uint8_t *resp_buf,
2221 size_t resp_buf_len, coap_request_ctx_t *context);
2222
2230static inline coap_method_flags_t coap_method2flag(unsigned code)
2231{
2232 return (1 << (code - 1));
2233}
2234
2249int coap_parse(coap_pkt_t *pkt, uint8_t *buf, size_t len);
2250
2265void coap_pkt_init(coap_pkt_t *pkt, uint8_t *buf, size_t len, size_t header_len);
2266
2280static inline void coap_payload_advance_bytes(coap_pkt_t *pkt, size_t len)
2281{
2282 pkt->payload += len;
2283 pkt->payload_len -= len;
2284}
2285
2307ssize_t coap_payload_put_bytes(coap_pkt_t *pkt, const void *data, size_t len);
2308
2322ssize_t coap_payload_put_char(coap_pkt_t *pkt, char c);
2323
2349ssize_t coap_build_reply_header(coap_pkt_t *pkt, unsigned code,
2350 void *buf, size_t len, uint16_t ct,
2351 void **payload, size_t *payload_len_max);
2352
2377 unsigned code,
2378 uint8_t *buf, size_t len,
2379 uint16_t ct,
2380 const void *payload, size_t payload_len);
2381
2387 uint8_t *buf, size_t len,
2388 coap_request_ctx_t *context);
2390
2394#ifndef CONFIG_NANOCOAP_SERVER_WELL_KNOWN_CORE
2395#define CONFIG_NANOCOAP_SERVER_WELL_KNOWN_CORE !IS_USED(MODULE_GCOAP)
2396#endif
2397
2413int coap_match_path(const coap_resource_t *resource, const uint8_t *uri);
2414
2415#if defined(MODULE_GCOAP) || defined(DOXYGEN)
2428static inline bool coap_has_observe(coap_pkt_t *pkt)
2429{
2430 return pkt->observe_value != UINT32_MAX;
2431}
2432
2438static inline void coap_clear_observe(coap_pkt_t *pkt)
2439{
2440 pkt->observe_value = UINT32_MAX;
2441}
2442
2450static inline uint32_t coap_get_observe(coap_pkt_t *pkt)
2451{
2452 return pkt->observe_value;
2453}
2454
2455#endif
2456
2460#define COAP_WELL_KNOWN_CORE_DEFAULT_HANDLER \
2461 { \
2462 .path = "/.well-known/core", \
2463 .methods = COAP_GET, \
2464 .handler = coap_well_known_core_default_handler \
2465 }
2466
2467#ifdef __cplusplus
2468}
2469#endif
POSIX.1-2008 compliant version of the assert macro.
#define assert(cond)
abort the program if assertion is false
Definition assert.h:146
Helper functions for bit arithmetic.
static unsigned bitarithm_msb(unsigned v)
Returns the number of the highest '1' bit in a value.
Definition bitarithm.h:152
bitfields operations on bitfields of arbitrary length
Functions to work with different byte orders.
static uint16_t ntohs(uint16_t v)
Convert from network byte order to host byte order, 16 bit.
Definition byteorder.h:535
static uint16_t byteorder_bebuftohs(const uint8_t *buf)
Read a big endian encoded unsigned integer from a buffer into host byte order encoded variable,...
Definition byteorder.h:550
Various helper macros.
#define COAP_OBS_MAX_VALUE_MASK
observe value is 24 bits
Definition coap.h:521
coap_method_t
CoAP method codes used in request.
Definition coap.h:170
#define CONFIG_NANOCOAP_NOPTS_MAX
Maximum number of Options in a message.
Definition nanocoap.h:135
#define CONFIG_NANOCOAP_URI_MAX
Maximum length of a resource path string read from or written to a message.
Definition nanocoap.h:143
static size_t coap_hdr_get_token_len(const coap_hdr_t *hdr)
Get the token length of a CoAP over UDP (DTLS) packet.
Definition nanocoap.h:725
uint32_t coap_request_ctx_get_tl_type(const coap_request_ctx_t *ctx)
Get transport the packet was received over.
uint8_t * coap_find_option(coap_pkt_t *pkt, unsigned opt_num)
Get pointer to an option field by type.
static ssize_t coap_opt_add_uri_query(coap_pkt_t *pkt, const char *key, const char *val)
Adds a single Uri-Query option in the form 'key=value' into pkt.
Definition nanocoap.h:1547
static void coap_pkt_set_code(coap_pkt_t *pkt, uint8_t code)
Write the given raw message code to given CoAP pkt.
Definition nanocoap.h:688
static size_t coap_opt_put_uri_query(uint8_t *buf, uint16_t lastonum, const char *uri)
Convenience function for inserting URI_QUERY option into buffer.
Definition nanocoap.h:1920
size_t coap_opt_put_block(uint8_t *buf, uint16_t lastonum, coap_block_slicer_t *slicer, bool more, uint16_t option)
Insert block option into buffer.
static size_t coap_opt_put_block2_control(uint8_t *buf, uint16_t lastonum, coap_block1_t *block)
Insert block2 option into buffer in control usage.
Definition nanocoap.h:1799
static ssize_t coap_opt_add_block2(coap_pkt_t *pkt, coap_block_slicer_t *slicer, bool more)
Add block2 option in descriptive use from a slicer object.
Definition nanocoap.h:1400
static unsigned coap_get_code_raw(const coap_pkt_t *pkt)
Get a message's raw code (class + detail)
Definition nanocoap.h:504
static size_t coap_hdr_len(const coap_hdr_t *hdr)
Get the header length of a CoAP packet.
Definition nanocoap.h:786
void coap_pkt_init(coap_pkt_t *pkt, uint8_t *buf, size_t len, size_t header_len)
Initialize a packet struct, to build a message buffer.
int coap_match_path(const coap_resource_t *resource, const uint8_t *uri)
Checks if a CoAP resource path matches a given URI.
static size_t coap_opt_put_block1(uint8_t *buf, uint16_t lastonum, coap_block_slicer_t *slicer, bool more)
Insert block1 option into buffer.
Definition nanocoap.h:1731
static ssize_t coap_opt_add_format(coap_pkt_t *pkt, uint16_t format)
Append a Content-Format option to the pkt buffer.
Definition nanocoap.h:1489
static uint8_t coap_code(unsigned cls, unsigned detail)
Encode given code class and code detail to raw code.
Definition nanocoap.h:456
bool coap_has_unprocessed_critical_options(const coap_pkt_t *pkt)
Check whether any of the packet's options that are critical.
static ssize_t coap_opt_add_uri_path(coap_pkt_t *pkt, const char *path)
Adds one or multiple Uri-Path options in the form '/path' into pkt.
Definition nanocoap.h:1627
static ssize_t coap_get_uri_query_string(coap_pkt_t *pkt, char *target, size_t max_len)
Convenience function for getting the packet's URI_QUERY option.
Definition nanocoap.h:966
ssize_t coap_handle_req(coap_pkt_t *pkt, uint8_t *resp_buf, unsigned resp_buf_len, coap_request_ctx_t *ctx)
Handle incoming CoAP request.
static unsigned coap_get_id(const coap_pkt_t *pkt)
Get the message ID of the given CoAP packet.
Definition nanocoap.h:528
static ssize_t coap_get_location_query(coap_pkt_t *pkt, uint8_t *target, size_t max_len)
Convenience function for getting the packet's LOCATION_QUERY option.
Definition nanocoap.h:926
static size_t coap_opt_put_uri_path(uint8_t *buf, uint16_t lastonum, const char *uri)
Convenience function for inserting URI_PATH option into buffer.
Definition nanocoap.h:1904
static ssize_t coap_opt_add_accept(coap_pkt_t *pkt, uint16_t format)
Append an Accept option to the pkt buffer.
Definition nanocoap.h:1471
ssize_t coap_opt_get_string(coap_pkt_t *pkt, uint16_t optnum, uint8_t *target, size_t max_len, char separator)
Read a full option as null terminated string into the target buffer.
size_t coap_opt_put_uint(uint8_t *buf, uint16_t lastonum, uint16_t onum, uint32_t value)
Encode the given uint option into buffer.
void coap_request_ctx_init(coap_request_ctx_t *ctx, sock_udp_ep_t *remote)
Initialize CoAP request context.
static void coap_hdr_set_code(coap_hdr_t *hdr, uint8_t code)
Write the given raw message code to given CoAP header.
Definition nanocoap.h:677
ssize_t coap_payload_put_bytes(coap_pkt_t *pkt, const void *data, size_t len)
Add payload data to the CoAP request.
uint8_t * coap_iterate_option(coap_pkt_t *pkt, unsigned opt_num, uint8_t **opt_pos, int *opt_len)
Get pointer to an option field, can be called in a loop if there are multiple options with the same n...
int coap_opt_get_uint(coap_pkt_t *pkt, uint16_t optnum, uint32_t *value)
Get a uint32 option value.
unsigned coap_get_accept(coap_pkt_t *pkt)
Get the Accept option value from a packet if present.
static size_t coap_opt_put_string(uint8_t *buf, uint16_t lastonum, uint16_t optnum, const char *string, char separator)
Encode the given string as multi-part option into buffer.
Definition nanocoap.h:1850
uint16_t coap_method_flags_t
Method flag type.
Definition nanocoap.h:295
int coap_get_block(coap_pkt_t *pkt, coap_block1_t *block, uint16_t option)
Block option getter.
static unsigned coap_get_ver(const coap_pkt_t *pkt)
Get the CoAP version number.
Definition nanocoap.h:596
ssize_t coap_opt_get_next(const coap_pkt_t *pkt, coap_optpos_t *opt, uint8_t **value, bool init_opt)
Iterate over a packet's options.
static size_t coap_opt_put_block2(uint8_t *buf, uint16_t lastonum, coap_block_slicer_t *slicer, bool more)
Insert block2 option into buffer.
Definition nanocoap.h:1752
static size_t coap_opt_put_observe(uint8_t *buf, uint16_t lastonum, uint32_t obs)
Insert an CoAP Observe Option into the buffer.
Definition nanocoap.h:1816
static bool coap_block2_finish(coap_block_slicer_t *slicer)
Finish a block2 response.
Definition nanocoap.h:1153
size_t coap_blockwise_put_bytes(coap_block_slicer_t *slicer, uint8_t *bufpos, const void *c, size_t len)
Add a byte array to a block2 reply.
static uint8_t coap_hdr_tkl_ext_len(const coap_hdr_t *hdr)
Get the size of the extended Token length field (RFC 8974)
Definition nanocoap.h:611
static coap_method_t coap_get_method(const coap_pkt_t *pkt)
Get a request's method type.
Definition nanocoap.h:516
static unsigned coap_get_total_hdr_len(const coap_pkt_t *pkt)
Get the total header length (4-byte header + token length)
Definition nanocoap.h:649
ssize_t coap_subtree_handler(coap_pkt_t *pkt, uint8_t *resp_buf, size_t resp_buf_len, coap_request_ctx_t *context)
Generic coap subtree handler.
static unsigned coap_get_code_class(const coap_pkt_t *pkt)
Get a message's code class (3 most significant bits of code)
Definition nanocoap.h:468
static int coap_get_block2(coap_pkt_t *pkt, coap_block1_t *block)
Block2 option getter.
Definition nanocoap.h:1264
ssize_t coap_build_empty_ack(coap_pkt_t *pkt, coap_hdr_t *ack)
Build empty reply to CoAP request.
ssize_t coap_block2_build_reply(coap_pkt_t *pkt, unsigned code, uint8_t *rbuf, unsigned rlen, unsigned payload_len, coap_block_slicer_t *slicer)
Build reply to CoAP block2 request.
void coap_block_slicer_init(coap_block_slicer_t *slicer, size_t blknum, size_t blksize)
Initialize a block slicer struct from content information.
static ssize_t coap_get_location_path(coap_pkt_t *pkt, uint8_t *target, size_t max_len)
Convenience function for getting the packet's LOCATION_PATH option.
Definition nanocoap.h:904
size_t coap_opt_put_string_with_len(uint8_t *buf, uint16_t lastonum, uint16_t optnum, const char *string, size_t len, char separator)
Encode the given string as multi-part option into buffer.
static ssize_t coap_opt_add_string(coap_pkt_t *pkt, uint16_t optnum, const char *string, char separator)
Encode the given string as option(s) into pkt.
Definition nanocoap.h:1607
bool coap_block_finish(coap_block_slicer_t *slicer, uint16_t option)
Finish a block request (block1 or block2)
static unsigned coap_get_code_detail(const coap_pkt_t *pkt)
Get a message's code detail (5 least significant bits of code)
Definition nanocoap.h:480
static int coap_get_block1(coap_pkt_t *pkt, coap_block1_t *block)
Block1 option getter.
Definition nanocoap.h:1250
void coap_block2_init(coap_pkt_t *pkt, coap_block_slicer_t *slicer)
Initialize a block2 slicer struct for writing the payload.
static uint8_t * coap_hdr_data_ptr(const coap_hdr_t *hdr)
Get the start of data after the header.
Definition nanocoap.h:637
ssize_t(* coap_handler_t)(coap_pkt_t *pkt, uint8_t *buf, size_t len, coap_request_ctx_t *context)
Resource handler type.
Definition nanocoap.h:261
ssize_t coap_payload_put_char(coap_pkt_t *pkt, char c)
Add a single character to the payload data of the CoAP request.
ssize_t coap_well_known_core_default_handler(coap_pkt_t *pkt, uint8_t *buf, size_t len, coap_request_ctx_t *context)
Reference to the default .well-known/core handler defined by the application.
static size_t coap_opt_put_proxy_uri(uint8_t *buf, uint16_t lastonum, const char *uri)
Convenience function for inserting PROXY_URI option into buffer.
Definition nanocoap.h:1956
static void coap_hdr_set_type(coap_hdr_t *hdr, unsigned type)
Set the message type for the given CoAP header.
Definition nanocoap.h:701
static void coap_payload_advance_bytes(coap_pkt_t *pkt, size_t len)
Advance the payload pointer.
Definition nanocoap.h:2280
bool coap_find_uri_query(coap_pkt_t *pkt, const char *key, const char **value, size_t *len)
Find a URI query option of the packet.
static uint32_t coap_get_observe(coap_pkt_t *pkt)
Get the value of the observe option from the given packet.
Definition nanocoap.h:2450
static const void * coap_hdr_get_token(const coap_hdr_t *hdr)
Get the Token of a CoAP over UDP (DTLS) packet.
Definition nanocoap.h:765
static size_t coap_put_option_block1(uint8_t *buf, uint16_t lastonum, unsigned blknum, unsigned szx, int more)
Insert block1 option into buffer.
Definition nanocoap.h:2011
static ssize_t coap_opt_add_block2_control(coap_pkt_t *pkt, coap_block1_t *block)
Encode the given block2 option in control use.
Definition nanocoap.h:1452
static unsigned coap_get_type(const coap_pkt_t *pkt)
Get the message type.
Definition nanocoap.h:584
static unsigned coap_get_code_decimal(const coap_pkt_t *pkt)
Get a message's code in decimal format ((class * 100) + detail)
Definition nanocoap.h:492
static unsigned coap_get_response_hdr_len(const coap_pkt_t *pkt)
Get the header length a response to the given packet will have.
Definition nanocoap.h:666
ssize_t coap_opt_get_opaque(coap_pkt_t *pkt, unsigned opt_num, uint8_t **value)
Retrieve the value for an option as an opaque array of bytes.
size_t coap_put_option(uint8_t *buf, uint16_t lastonum, uint16_t onum, const void *odata, size_t olen)
Insert a CoAP option into buffer.
int coap_iterate_uri_query(coap_pkt_t *pkt, void **ctx, char *key, size_t key_len_max, char *value, size_t value_len_max)
Iterate over a packet's URI Query options.
ssize_t coap_opt_add_opaque(coap_pkt_t *pkt, uint16_t optnum, const void *val, size_t val_len)
Encode the given buffer as an opaque data option into pkt.
static ssize_t coap_opt_add_uri_path_buffer(coap_pkt_t *pkt, const char *path, size_t path_len)
Adds one or multiple Uri-Path options in the form '/path' into pkt.
Definition nanocoap.h:1647
static void * coap_get_token(const coap_pkt_t *pkt)
Get pointer to a message's token.
Definition nanocoap.h:555
static size_t coap_opt_put_location_query(uint8_t *buf, uint16_t lastonum, const char *location)
Convenience function for inserting LOCATION_QUERY option into buffer.
Definition nanocoap.h:1886
int coap_get_blockopt(coap_pkt_t *pkt, uint16_t option, uint32_t *blknum, uint8_t *szx)
Generic block option getter.
size_t coap_blockwise_put_char(coap_block_slicer_t *slicer, uint8_t *bufpos, char c)
Add a single character to a block2 reply.
static size_t coap_opt_put_location_path(uint8_t *buf, uint16_t lastonum, const char *location)
Convenience function for inserting LOCATION_PATH option into buffer.
Definition nanocoap.h:1868
static bool coap_block1_finish(coap_block_slicer_t *slicer)
Finish a block1 request.
Definition nanocoap.h:1134
void * coap_request_ctx_get_context(const coap_request_ctx_t *ctx)
Get resource context associated with a CoAP request.
ssize_t coap_build_reply_header(coap_pkt_t *pkt, unsigned code, void *buf, size_t len, uint16_t ct, void **payload, size_t *payload_len_max)
Create CoAP reply header (convenience function)
static size_t coap_put_option_ct(uint8_t *buf, uint16_t lastonum, uint16_t content_type)
Insert content type option into buffer.
Definition nanocoap.h:2028
ssize_t coap_opt_add_proxy_uri(coap_pkt_t *pkt, const char *uri)
Adds a single Proxy-URI option into pkt.
int(* coap_blockwise_cb_t)(void *arg, size_t offset, uint8_t *buf, size_t len, int more)
Coap blockwise request callback descriptor.
Definition nanocoap.h:276
ssize_t coap_build_reply(coap_pkt_t *pkt, unsigned code, uint8_t *rbuf, unsigned rlen, unsigned max_data_len)
Build reply to CoAP request.
static unsigned coap_size2szx(unsigned len)
Helper to encode byte size into next equal or smaller SZX value.
Definition nanocoap.h:1318
int(* coap_request_cb_t)(void *arg, coap_pkt_t *pkt)
Coap request callback descriptor.
Definition nanocoap.h:288
static size_t coap_opt_put_block1_control(uint8_t *buf, uint16_t lastonum, coap_block1_t *block)
Insert block1 option into buffer in control usage.
Definition nanocoap.h:1781
ssize_t coap_reply_simple(coap_pkt_t *pkt, unsigned code, uint8_t *buf, size_t len, uint16_t ct, const void *payload, size_t payload_len)
Create CoAP reply (convenience function)
const char * coap_request_ctx_get_path(const coap_request_ctx_t *ctx)
Get resource path associated with a CoAP request.
ssize_t coap_opt_add_block(coap_pkt_t *pkt, coap_block_slicer_t *slicer, bool more, uint16_t option)
Add block option in descriptive use from a slicer object.
const sock_udp_ep_t * coap_request_ctx_get_remote_udp(const coap_request_ctx_t *ctx)
Get the remote endpoint from which the request was received.
int coap_parse(coap_pkt_t *pkt, uint8_t *buf, size_t len)
Parse a CoAP PDU.
const sock_udp_ep_t * coap_request_ctx_get_local_udp(const coap_request_ctx_t *ctx)
Get the local endpoint on which the request has been received.
void coap_block_object_init(coap_block1_t *block, size_t blknum, size_t blksize, int more)
Initialize a block struct from content information.
ssize_t coap_opt_add_chars(coap_pkt_t *pkt, uint16_t optnum, const char *chars, size_t chars_len, char separator)
Encode the given array of characters as option(s) into pkt.
ssize_t coap_opt_remove(coap_pkt_t *pkt, uint16_t optnum)
Removes an option previously added with function in the coap_opt_add_...() group.
unsigned coap_get_content_type(coap_pkt_t *pkt)
Get content type from packet.
static ssize_t coap_get_proxy_uri(coap_pkt_t *pkt, char **target)
Convenience function for getting the packet's Proxy-Uri option.
Definition nanocoap.h:1078
static ssize_t coap_get_uri_path(coap_pkt_t *pkt, uint8_t *target)
Convenience function for getting the packet's URI_PATH.
Definition nanocoap.h:947
ssize_t coap_opt_add_uint(coap_pkt_t *pkt, uint16_t optnum, uint32_t value)
Encode the given uint option into pkt.
static unsigned coap_get_total_len(const coap_pkt_t *pkt)
Get the total length of a CoAP packet in the packet buffer.
Definition nanocoap.h:569
struct _coap_request_ctx coap_request_ctx_t
Forward declaration of internal CoAP resource request handler context.
Definition nanocoap.h:237
static bool coap_has_observe(coap_pkt_t *pkt)
Identifies a packet containing an observe option.
Definition nanocoap.h:2428
ssize_t coap_build_hdr(coap_hdr_t *hdr, unsigned type, const void *token, size_t token_len, unsigned code, uint16_t id)
Builds a CoAP header.
size_t coap_put_block1_ok(uint8_t *pkt_pos, coap_block1_t *block1, uint16_t lastonum)
Insert block1 option into buffer (from coap_block1_t)
static ssize_t coap_opt_add_block1(coap_pkt_t *pkt, coap_block_slicer_t *slicer, bool more)
Add block1 option in descriptive use from a slicer object.
Definition nanocoap.h:1376
static coap_method_flags_t coap_method2flag(unsigned code)
Convert message code (request method) into a corresponding bit field.
Definition nanocoap.h:2230
size_t coap_opt_put_uri_pathquery(uint8_t *buf, uint16_t *lastonum, const char *uri)
Convenience function for inserting URI_PATH and URI_QUERY into buffer This function will automaticall...
static ssize_t coap_opt_add_block1_control(coap_pkt_t *pkt, coap_block1_t *block)
Encode the given block1 option in control use.
Definition nanocoap.h:1434
ssize_t coap_tree_handler(coap_pkt_t *pkt, uint8_t *resp_buf, unsigned resp_buf_len, coap_request_ctx_t *ctx, const coap_resource_t *resources, size_t resources_numof)
Pass a coap request to a matching handler.
static unsigned coap_get_token_len(const coap_pkt_t *pkt)
Get a message's token length [in byte].
Definition nanocoap.h:543
static void coap_clear_observe(coap_pkt_t *pkt)
Clears the observe option value from a packet.
Definition nanocoap.h:2438
ssize_t coap_opt_finish(coap_pkt_t *pkt, uint16_t flags)
Finalizes options as required and prepares for payload.
ssize_t coap_opt_add_uri_query2(coap_pkt_t *pkt, const char *key, size_t key_len, const char *val, size_t val_len)
Adds a single Uri-Query option in the form 'key=value' into pkt.
struct _sock_tl_ep sock_udp_ep_t
An end point for a UDP sock object.
Definition udp.h:295
struct iolist iolist_t
iolist forward declaration
Definition iolist.h:33
iolist scatter / gather IO
Common macros and compiler attributes/pragmas configuration.
#define IS_USED(module)
Checks whether a module is being used or not.
Definition modules.h:70
Generic CoAP values as defined by RFC7252.
UDP sock definitions.
CoAP resource request handler context.
Definition nanocoap.h:327
sock_udp_ep_t * local
local endpoint of the request
Definition nanocoap.h:331
const coap_resource_t * resource
resource of the request
Definition nanocoap.h:328
sock_udp_ep_t * remote
remote endpoint of the request
Definition nanocoap.h:329
uint32_t tl_type
transport the packet was received over
Definition nanocoap.h:340
Block1 helper struct.
Definition nanocoap.h:400
int8_t more
-1 for no option, 0 for last block, 1 for more blocks coming
Definition nanocoap.h:404
uint32_t blknum
block number
Definition nanocoap.h:402
size_t offset
offset of received data
Definition nanocoap.h:401
uint8_t szx
szx value
Definition nanocoap.h:403
Blockwise transfer helper struct.
Definition nanocoap.h:411
uint8_t * opt
Pointer to the placed option.
Definition nanocoap.h:415
size_t end
End offset of the current block.
Definition nanocoap.h:413
size_t start
Start offset of the current block.
Definition nanocoap.h:412
size_t cur
Offset of the generated content.
Definition nanocoap.h:414
Raw CoAP PDU header structure.
Definition nanocoap.h:190
uint8_t ver_t_tkl
version, token, token length
Definition nanocoap.h:191
uint8_t code
CoAP code (e.g.m 205)
Definition nanocoap.h:192
uint16_t id
Req/resp ID.
Definition nanocoap.h:193
CoAP option array entry.
Definition nanocoap.h:199
uint16_t offset
offset in packet
Definition nanocoap.h:201
uint16_t opt_num
full CoAP option number
Definition nanocoap.h:200
CoAP PDU parsing context structure.
Definition nanocoap.h:221
coap_optpos_t options[CONFIG_NANOCOAP_NOPTS_MAX]
option offset array
Definition nanocoap.h:227
uint8_t * payload
pointer to end of the header
Definition nanocoap.h:223
uint16_t payload_len
length of payload
Definition nanocoap.h:225
coap_hdr_t * hdr
pointer to raw packet
Definition nanocoap.h:222
uint16_t options_len
length of options array
Definition nanocoap.h:226
BITFIELD(opt_crit, CONFIG_NANOCOAP_NOPTS_MAX)
unhandled critical option
iolist_t * snips
payload snips (optional)
Definition nanocoap.h:224
Type for CoAP resource subtrees.
Definition nanocoap.h:310
const size_t resources_numof
number of entries in array
Definition nanocoap.h:312
const coap_resource_t * resources
ptr to resource array
Definition nanocoap.h:311
Type for CoAP resource entry.
Definition nanocoap.h:300
const char * path
URI path of resource.
Definition nanocoap.h:301
coap_method_flags_t methods
OR'ed methods this resource allows.
Definition nanocoap.h:302
coap_handler_t handler
ptr to resource handler
Definition nanocoap.h:303
void * context
ptr to user defined context data
Definition nanocoap.h:304
Cross File Arrays.