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
77#ifndef NET_NANOCOAP_H
78#define NET_NANOCOAP_H
79
80#include <assert.h>
81#include <errno.h>
82#include <stdint.h>
83#include <stdbool.h>
84#include <stddef.h>
85#include <string.h>
86#include <unistd.h>
87
88#ifdef RIOT_VERSION
89#include "bitarithm.h"
90#include "bitfield.h"
91#include "byteorder.h"
92#include "iolist.h"
93#include "macros/utils.h"
94#include "net/coap.h"
95#include "modules.h"
96#else
97#include "coap.h"
98#include <arpa/inet.h>
99#endif
100
101#if defined(MODULE_SOCK_UDP) || defined(DOXYGEN)
102#include "net/sock/udp.h"
103#else
104typedef void sock_udp_ep_t;
105#endif
106
107#if defined(MODULE_NANOCOAP_RESOURCES)
108#include "xfa.h"
109#endif
110
111#ifdef __cplusplus
112extern "C" {
113#endif
114
120#define COAP_GET (0x01)
121#define COAP_POST (0x02)
122#define COAP_PUT (0x04)
123#define COAP_DELETE (0x08)
124#define COAP_FETCH (0x10)
125#define COAP_PATCH (0x20)
126#define COAP_IPATCH (0x40)
127#define COAP_IGNORE (0xFF)
129#define COAP_MATCH_SUBTREE (0x8000)
136#define COAP_FORMAT_NONE (UINT16_MAX)
137
145#ifndef CONFIG_NANOCOAP_NOPTS_MAX
146#define CONFIG_NANOCOAP_NOPTS_MAX (16)
147#endif
148
153#ifndef CONFIG_NANOCOAP_URI_MAX
154#define CONFIG_NANOCOAP_URI_MAX (64)
155#endif
156
160#ifndef CONFIG_NANOCOAP_BLOCK_SIZE_EXP_MAX
161#define CONFIG_NANOCOAP_BLOCK_SIZE_EXP_MAX (6)
162#endif
163
167#ifndef CONFIG_NANOCOAP_BLOCKSIZE_DEFAULT
168#define CONFIG_NANOCOAP_BLOCKSIZE_DEFAULT COAP_BLOCKSIZE_64
169#endif
170
172#ifndef CONFIG_NANOCOAP_QS_MAX
173#define CONFIG_NANOCOAP_QS_MAX (64)
174#endif
182#ifndef CONFIG_NANOCOAP_BLOCK_HEADER_MAX
183#define CONFIG_NANOCOAP_BLOCK_HEADER_MAX (80)
184#endif
185
193#define COAP_OPT_FINISH_NONE (0x0000)
195#define COAP_OPT_FINISH_PAYLOAD (0x0001)
201typedef struct __attribute__((packed)) {
202 uint8_t ver_t_tkl;
203 uint8_t code;
204 uint16_t id;
205} coap_hdr_t;
206
210typedef struct {
211 uint16_t opt_num;
212 uint16_t offset;
214
232typedef struct {
234 uint8_t *payload;
236 uint16_t payload_len;
237 uint16_t options_len;
240#ifdef MODULE_GCOAP
241 uint32_t observe_value;
242#endif
243} coap_pkt_t;
244
249
272typedef ssize_t (*coap_handler_t)(coap_pkt_t *pkt, uint8_t *buf, size_t len,
273 coap_request_ctx_t *context);
274
287typedef int (*coap_blockwise_cb_t)(void *arg, size_t offset, uint8_t *buf, size_t len, int more);
288
299typedef int (*coap_request_cb_t)(void *arg, coap_pkt_t *pkt);
300
306typedef uint16_t coap_method_flags_t;
307
317
321typedef const struct {
323 const size_t resources_numof;
325
333
341#if defined(MODULE_SOCK_AUX_LOCAL) || DOXYGEN
343#endif
344#if defined(MODULE_GCOAP) || DOXYGEN
351 uint32_t tl_type;
352#endif
353};
354
355/* forward declarations */
356static inline uint8_t *coap_hdr_data_ptr(const coap_hdr_t *hdr);
357static inline size_t coap_hdr_get_token_len(const coap_hdr_t *hdr);
358
367
376
386
396
406
410typedef struct {
411 size_t offset;
412 uint32_t blknum;
413 uint8_t szx;
414 int8_t more;
417
421typedef struct {
422 size_t start;
423 size_t end;
424 size_t cur;
425 uint8_t *opt;
427
428#if defined(MODULE_NANOCOAP_RESOURCES) || DOXYGEN
434#define NANOCOAP_RESOURCE(name) \
435 XFA_CONST(coap_resource_t, coap_resources_xfa, 0) CONCAT(coap_resource_, name) =
436#else
442extern const coap_resource_t coap_resources[];
443
449extern const unsigned coap_resources_numof;
450#endif
451
466static inline uint8_t coap_code(unsigned cls, unsigned detail)
467{
468 return (cls << 5) | detail;
469}
470
478static inline unsigned coap_get_code_class(const coap_pkt_t *pkt)
479{
480 return pkt->hdr->code >> 5;
481}
482
490static inline unsigned coap_get_code_detail(const coap_pkt_t *pkt)
491{
492 return pkt->hdr->code & 0x1f;
493}
494
502static inline unsigned coap_get_code_decimal(const coap_pkt_t *pkt)
503{
504 return (coap_get_code_class(pkt) * 100) + coap_get_code_detail(pkt);
505}
506
514static inline unsigned coap_get_code_raw(const coap_pkt_t *pkt)
515{
516 return (unsigned)pkt->hdr->code;
517}
518
526static inline coap_method_t coap_get_method(const coap_pkt_t *pkt)
527{
528 return pkt->hdr->code;
529}
530
538static inline unsigned coap_get_id(const coap_pkt_t *pkt)
539{
540 return ntohs(pkt->hdr->id);
541}
542
553static inline unsigned coap_get_token_len(const coap_pkt_t *pkt)
554{
555 return coap_hdr_get_token_len(pkt->hdr);
556}
557
565static inline void *coap_get_token(const coap_pkt_t *pkt)
566{
567 return coap_hdr_data_ptr(pkt->hdr);
568}
569
579static inline unsigned coap_get_total_len(const coap_pkt_t *pkt)
580{
581 return (uintptr_t)pkt->payload - (uintptr_t)pkt->hdr + pkt->payload_len;
582}
583
594static inline unsigned coap_get_type(const coap_pkt_t *pkt)
595{
596 return (pkt->hdr->ver_t_tkl & 0x30) >> 4;
597}
598
606static inline unsigned coap_get_ver(const coap_pkt_t *pkt)
607{
608 return (pkt->hdr->ver_t_tkl & 0x60) >> 6;
609}
610
621static inline uint8_t coap_hdr_tkl_ext_len(const coap_hdr_t *hdr)
622{
623 if (!IS_USED(MODULE_NANOCOAP_TOKEN_EXT)) {
624 return 0;
625 }
626
627 switch (hdr->ver_t_tkl & 0xf) {
628 case 13:
629 return 1;
630 case 14:
631 return 2;
632 case 15:
633 assert(0);
634 /* fall-through */
635 default:
636 return 0;
637 }
638}
639
647static inline uint8_t *coap_hdr_data_ptr(const coap_hdr_t *hdr)
648{
649 return ((uint8_t *)hdr) + sizeof(coap_hdr_t) + coap_hdr_tkl_ext_len(hdr);
650}
651
659static inline unsigned coap_get_total_hdr_len(const coap_pkt_t *pkt)
660{
661 return sizeof(coap_hdr_t) + coap_hdr_tkl_ext_len(pkt->hdr) +
663}
664
676static inline unsigned coap_get_response_hdr_len(const coap_pkt_t *pkt)
677{
678 return coap_get_total_hdr_len(pkt);
679}
680
687static inline void coap_hdr_set_code(coap_hdr_t *hdr, uint8_t code)
688{
689 hdr->code = code;
690}
691
698static inline void coap_pkt_set_code(coap_pkt_t *pkt, uint8_t code)
699{
700 coap_hdr_set_code(pkt->hdr, code);
701}
702
711static inline void coap_hdr_set_type(coap_hdr_t *hdr, unsigned type)
712{
713 /* assert correct range of type */
714 assert(!(type & ~0x3));
715
716 hdr->ver_t_tkl &= ~0x30;
717 hdr->ver_t_tkl |= type << 4;
718}
719
735static inline size_t coap_hdr_get_token_len(const coap_hdr_t *hdr)
736{
737 const uint8_t *buf = (const void *)hdr;
738 /* Regarding use unnamed magic numbers 13 and 269:
739 * - If token length is < 13 it fits into TKL field (4 bit)
740 * - If token length is < 269 it fits into 8-bit extended TKL field
741 * - Otherwise token length goes into 16-bit extended TKL field.
742 *
743 * (Not using named constants here, as RFC 8974 also has no names for those
744 * magic numbers.)
745 *
746 * See: https://www.rfc-editor.org/rfc/rfc8974#name-extended-token-length-tkl-f
747 */
748 switch (coap_hdr_tkl_ext_len(hdr)) {
749 case 0:
750 return hdr->ver_t_tkl & 0xf;
751 case 1:
752 return buf[sizeof(coap_hdr_t)] + 13;
753 case 2:
754 return byteorder_bebuftohs(buf + sizeof(coap_hdr_t)) + 269;
755 }
756
757 return 0;
758}
759
774static inline size_t coap_hdr_len(const coap_hdr_t *hdr)
775{
776 return sizeof(*hdr) + coap_hdr_tkl_ext_len(hdr) + coap_hdr_get_token_len(hdr);
777}
806uint8_t *coap_find_option(coap_pkt_t *pkt, unsigned opt_num);
807
820uint8_t *coap_iterate_option(coap_pkt_t *pkt, unsigned opt_num,
821 uint8_t **opt_pos, int *opt_len);
822
832
842
855int coap_opt_get_uint(coap_pkt_t *pkt, uint16_t optnum, uint32_t *value);
856
874ssize_t coap_opt_get_string(coap_pkt_t *pkt, uint16_t optnum,
875 uint8_t *target, size_t max_len, char separator);
876
892static inline ssize_t coap_get_location_path(coap_pkt_t *pkt,
893 uint8_t *target, size_t max_len)
894{
895 return coap_opt_get_string(pkt, COAP_OPT_LOCATION_PATH,
896 target, max_len, '/');
897}
898
914static inline ssize_t coap_get_location_query(coap_pkt_t *pkt,
915 uint8_t *target, size_t max_len)
916{
917 return coap_opt_get_string(pkt, COAP_OPT_LOCATION_QUERY,
918 target, max_len, '&');
919}
920
935static inline ssize_t coap_get_uri_path(coap_pkt_t *pkt, uint8_t *target)
936{
937 return coap_opt_get_string(pkt, COAP_OPT_URI_PATH, target,
939}
940
954static inline ssize_t coap_get_uri_query_string(coap_pkt_t *pkt, char *target,
955 size_t max_len)
956{
957 return coap_opt_get_string(pkt, COAP_OPT_URI_QUERY,
958 (uint8_t *)target, max_len, '&');
959}
960
975bool coap_find_uri_query(coap_pkt_t *pkt, const char *key,
976 const char **value, size_t *len);
977
1008 uint8_t **value, bool init_opt);
1009
1026ssize_t coap_opt_get_opaque(coap_pkt_t *pkt, unsigned opt_num, uint8_t **value);
1041static inline ssize_t coap_get_proxy_uri(coap_pkt_t *pkt, char **target)
1042{
1043 return coap_opt_get_opaque(pkt, COAP_OPT_PROXY_URI, (uint8_t **)target);
1044}
1045
1063void coap_block_object_init(coap_block1_t *block, size_t blknum, size_t blksize,
1064 int more);
1065
1081bool coap_block_finish(coap_block_slicer_t *slicer, uint16_t option);
1082
1097static inline bool coap_block1_finish(coap_block_slicer_t *slicer)
1098{
1099 return coap_block_finish(slicer, COAP_OPT_BLOCK1);
1100}
1101
1116static inline bool coap_block2_finish(coap_block_slicer_t *slicer)
1117{
1118 return coap_block_finish(slicer, COAP_OPT_BLOCK2);
1119}
1120
1131
1142 size_t blksize);
1143
1158size_t coap_blockwise_put_bytes(coap_block_slicer_t *slicer, uint8_t *bufpos,
1159 const void *c, size_t len);
1160
1174size_t coap_blockwise_put_char(coap_block_slicer_t *slicer, uint8_t *bufpos, char c);
1175
1194int coap_get_block(coap_pkt_t *pkt, coap_block1_t *block, uint16_t option);
1195
1213static inline int coap_get_block1(coap_pkt_t *pkt, coap_block1_t *block)
1214{
1215 return coap_get_block(pkt, block, COAP_OPT_BLOCK1);
1216}
1217
1227static inline int coap_get_block2(coap_pkt_t *pkt, coap_block1_t *block)
1228{
1229 return coap_get_block(pkt, block, COAP_OPT_BLOCK2);
1230}
1231
1244int coap_get_blockopt(coap_pkt_t *pkt, uint16_t option, uint32_t *blknum, uint8_t *szx);
1245
1264
1272#define coap_szx2size(szx) (1U << ((szx) + 4))
1273
1281static inline unsigned coap_size2szx(unsigned len)
1282{
1283 assert(len >= 16);
1284 return bitarithm_msb(len >> 4);
1285}
1319 bool more, uint16_t option);
1320
1339static inline ssize_t coap_opt_add_block1(coap_pkt_t *pkt,
1340 coap_block_slicer_t *slicer, bool more)
1341{
1342 return coap_opt_add_block(pkt, slicer, more, COAP_OPT_BLOCK1);
1343}
1344
1363static inline ssize_t coap_opt_add_block2(coap_pkt_t *pkt,
1364 coap_block_slicer_t *slicer, bool more)
1365{
1366 return coap_opt_add_block(pkt, slicer, more, COAP_OPT_BLOCK2);
1367}
1382ssize_t coap_opt_add_uint(coap_pkt_t *pkt, uint16_t optnum, uint32_t value);
1383
1397static inline ssize_t coap_opt_add_block1_control(coap_pkt_t *pkt, coap_block1_t *block) {
1398 return coap_opt_add_uint(pkt, COAP_OPT_BLOCK1,
1399 (block->blknum << 4) | block->szx | (block->more ? 0x8 : 0));
1400}
1401
1415static inline ssize_t coap_opt_add_block2_control(coap_pkt_t *pkt, coap_block1_t *block) {
1416 /* block.more must be zero, so no need to 'or' it in */
1417 return coap_opt_add_uint(pkt, COAP_OPT_BLOCK2,
1418 (block->blknum << 4) | block->szx);
1419}
1420
1434static inline ssize_t coap_opt_add_accept(coap_pkt_t *pkt, uint16_t format)
1435{
1436 return coap_opt_add_uint(pkt, COAP_OPT_ACCEPT, format);
1437}
1438
1452static inline ssize_t coap_opt_add_format(coap_pkt_t *pkt, uint16_t format)
1453{
1454 return coap_opt_add_uint(pkt, COAP_OPT_CONTENT_FORMAT, format);
1455}
1456
1472ssize_t coap_opt_add_opaque(coap_pkt_t *pkt, uint16_t optnum, const void *val, size_t val_len);
1473
1491ssize_t coap_opt_add_uri_query2(coap_pkt_t *pkt, const char *key, size_t key_len,
1492 const char *val, size_t val_len);
1493
1510static inline ssize_t coap_opt_add_uri_query(coap_pkt_t *pkt, const char *key,
1511 const char *val)
1512{
1513 return coap_opt_add_uri_query2(pkt, key, strlen(key), val, val ? strlen(val) : 0);
1514}
1515
1530ssize_t coap_opt_add_proxy_uri(coap_pkt_t *pkt, const char *uri);
1531
1550ssize_t coap_opt_add_chars(coap_pkt_t *pkt, uint16_t optnum, const char *chars,
1551 size_t chars_len, char separator);
1552
1570static inline ssize_t coap_opt_add_string(coap_pkt_t *pkt, uint16_t optnum,
1571 const char *string, char separator)
1572{
1573 return coap_opt_add_chars(pkt, optnum, string, strlen(string), separator);
1574}
1575
1590static inline ssize_t coap_opt_add_uri_path(coap_pkt_t *pkt, const char *path)
1591{
1592 return coap_opt_add_string(pkt, COAP_OPT_URI_PATH, path, '/');
1593}
1594
1610static inline ssize_t coap_opt_add_uri_path_buffer(coap_pkt_t *pkt,
1611 const char *path,
1612 size_t path_len)
1613{
1614 return coap_opt_add_chars(pkt, COAP_OPT_URI_PATH, path, path_len, '/');
1615}
1616
1629ssize_t coap_opt_finish(coap_pkt_t *pkt, uint16_t flags);
1630
1648ssize_t coap_opt_remove(coap_pkt_t *pkt, uint16_t optnum);
1676size_t coap_opt_put_block(uint8_t *buf, uint16_t lastonum, coap_block_slicer_t *slicer,
1677 bool more, uint16_t option);
1678
1694static inline size_t coap_opt_put_block1(uint8_t *buf, uint16_t lastonum,
1695 coap_block_slicer_t *slicer, bool more)
1696{
1697 return coap_opt_put_block(buf, lastonum, slicer, more, COAP_OPT_BLOCK1);
1698}
1699
1715static inline size_t coap_opt_put_block2(uint8_t *buf, uint16_t lastonum,
1716 coap_block_slicer_t *slicer, bool more)
1717{
1718 return coap_opt_put_block(buf, lastonum, slicer, more, COAP_OPT_BLOCK2);
1719}
1720
1732size_t coap_opt_put_uint(uint8_t *buf, uint16_t lastonum, uint16_t onum,
1733 uint32_t value);
1734
1744static inline size_t coap_opt_put_block1_control(uint8_t *buf, uint16_t lastonum,
1745 coap_block1_t *block)
1746{
1747 return coap_opt_put_uint(buf, lastonum, COAP_OPT_BLOCK1,
1748 (block->blknum << 4) | block->szx | (block->more ? 0x8 : 0));
1749}
1750
1762static inline size_t coap_opt_put_block2_control(uint8_t *buf, uint16_t lastonum,
1763 coap_block1_t *block)
1764{
1765 /* block.more must be zero, so no need to 'or' it in */
1766 return coap_opt_put_uint(buf, lastonum, COAP_OPT_BLOCK2,
1767 (block->blknum << 4) | block->szx);
1768}
1769
1783size_t coap_opt_put_string_with_len(uint8_t *buf, uint16_t lastonum, uint16_t optnum,
1784 const char *string, size_t len, char separator);
1797static inline size_t coap_opt_put_string(uint8_t *buf, uint16_t lastonum,
1798 uint16_t optnum,
1799 const char *string, char separator)
1800{
1801 return coap_opt_put_string_with_len(buf, lastonum, optnum,
1802 string, strlen(string), separator);
1803}
1804
1815static inline size_t coap_opt_put_location_path(uint8_t *buf,
1816 uint16_t lastonum,
1817 const char *location)
1818{
1819 return coap_opt_put_string(buf, lastonum, COAP_OPT_LOCATION_PATH,
1820 location, '/');
1821}
1822
1833static inline size_t coap_opt_put_location_query(uint8_t *buf,
1834 uint16_t lastonum,
1835 const char *location)
1836{
1837 return coap_opt_put_string(buf, lastonum, COAP_OPT_LOCATION_QUERY,
1838 location, '&');
1839}
1840
1851static inline size_t coap_opt_put_uri_path(uint8_t *buf, uint16_t lastonum,
1852 const char *uri)
1853{
1854 return coap_opt_put_string(buf, lastonum, COAP_OPT_URI_PATH, uri, '/');
1855}
1856
1867static inline size_t coap_opt_put_uri_query(uint8_t *buf, uint16_t lastonum,
1868 const char *uri)
1869{
1870 return coap_opt_put_string(buf, lastonum, COAP_OPT_URI_QUERY, uri, '&');
1871}
1872
1891size_t coap_opt_put_uri_pathquery(uint8_t *buf, uint16_t *lastonum, const char *uri);
1892
1903static inline size_t coap_opt_put_proxy_uri(uint8_t *buf, uint16_t lastonum,
1904 const char *uri)
1905{
1906 return coap_opt_put_string(buf, lastonum, COAP_OPT_PROXY_URI, uri, '\0');
1907}
1908
1926size_t coap_put_block1_ok(uint8_t *pkt_pos, coap_block1_t *block1, uint16_t lastonum);
1927
1944size_t coap_put_option(uint8_t *buf, uint16_t lastonum, uint16_t onum, const void *odata, size_t olen);
1945
1958static inline size_t coap_put_option_block1(uint8_t *buf, uint16_t lastonum,
1959 unsigned blknum, unsigned szx, int more)
1960{
1961 return coap_opt_put_uint(buf, lastonum, COAP_OPT_BLOCK1,
1962 (blknum << 4) | szx | (more ? 0x8 : 0));
1963}
1964
1975static inline size_t coap_put_option_ct(uint8_t *buf, uint16_t lastonum,
1976 uint16_t content_type)
1977{
1978 return coap_opt_put_uint(buf, lastonum, COAP_OPT_CONTENT_FORMAT, content_type);
1979}
2008ssize_t coap_block2_build_reply(coap_pkt_t *pkt, unsigned code,
2009 uint8_t *rbuf, unsigned rlen, unsigned payload_len,
2010 coap_block_slicer_t *slicer);
2011
2031ssize_t coap_build_hdr(coap_hdr_t *hdr, unsigned type, const void *token,
2032 size_t token_len, unsigned code, uint16_t id);
2033
2062ssize_t coap_build_reply(coap_pkt_t *pkt, unsigned code,
2063 uint8_t *rbuf, unsigned rlen, unsigned payload_len);
2064
2080
2095ssize_t coap_handle_req(coap_pkt_t *pkt, uint8_t *resp_buf, unsigned resp_buf_len,
2096 coap_request_ctx_t *ctx);
2097
2114ssize_t coap_tree_handler(coap_pkt_t *pkt, uint8_t *resp_buf,
2115 unsigned resp_buf_len, coap_request_ctx_t *ctx,
2116 const coap_resource_t *resources,
2117 size_t resources_numof);
2118
2136ssize_t coap_subtree_handler(coap_pkt_t *pkt, uint8_t *resp_buf,
2137 size_t resp_buf_len, coap_request_ctx_t *context);
2138
2146static inline coap_method_flags_t coap_method2flag(unsigned code)
2147{
2148 return (1 << (code - 1));
2149}
2150
2165int coap_parse(coap_pkt_t *pkt, uint8_t *buf, size_t len);
2166
2181void coap_pkt_init(coap_pkt_t *pkt, uint8_t *buf, size_t len, size_t header_len);
2182
2196static inline void coap_payload_advance_bytes(coap_pkt_t *pkt, size_t len)
2197{
2198 pkt->payload += len;
2199 pkt->payload_len -= len;
2200}
2201
2223ssize_t coap_payload_put_bytes(coap_pkt_t *pkt, const void *data, size_t len);
2224
2238ssize_t coap_payload_put_char(coap_pkt_t *pkt, char c);
2239
2265ssize_t coap_build_reply_header(coap_pkt_t *pkt, unsigned code,
2266 void *buf, size_t len,
2267 int ct,
2268 void **payload, size_t *payload_len_max);
2269
2292 unsigned code,
2293 uint8_t *buf, size_t len,
2294 unsigned ct,
2295 const void *payload, size_t payload_len);
2296
2302 uint8_t *buf, size_t len,
2303 coap_request_ctx_t *context);
2309#ifndef CONFIG_NANOCOAP_SERVER_WELL_KNOWN_CORE
2310#define CONFIG_NANOCOAP_SERVER_WELL_KNOWN_CORE !IS_USED(MODULE_GCOAP)
2311#endif
2312
2328int coap_match_path(const coap_resource_t *resource, const uint8_t *uri);
2329
2330#if defined(MODULE_GCOAP) || defined(DOXYGEN)
2343static inline bool coap_has_observe(coap_pkt_t *pkt)
2344{
2345 return pkt->observe_value != UINT32_MAX;
2346}
2347
2353static inline void coap_clear_observe(coap_pkt_t *pkt)
2354{
2355 pkt->observe_value = UINT32_MAX;
2356}
2357
2365static inline uint32_t coap_get_observe(coap_pkt_t *pkt)
2366{
2367 return pkt->observe_value;
2368}
2370#endif
2371
2375#define COAP_WELL_KNOWN_CORE_DEFAULT_HANDLER \
2376 { \
2377 .path = "/.well-known/core", \
2378 .methods = COAP_GET, \
2379 .handler = coap_well_known_core_default_handler \
2380 }
2381
2382#ifdef __cplusplus
2383}
2384#endif
2385#endif /* NET_NANOCOAP_H */
POSIX.1-2008 compliant version of the assert macro.
#define assert(cond)
abort the program if assertion is false
Definition assert.h:136
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:153
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:536
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:551
Various helper macros.
coap_method_t
CoAP method codes used in request.
Definition coap.h:171
#define CONFIG_NANOCOAP_NOPTS_MAX
Maximum number of Options in a message.
Definition nanocoap.h:146
#define CONFIG_NANOCOAP_URI_MAX
Maximum length of a resource path string read from or written to a message.
Definition nanocoap.h:154
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:735
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:1510
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:698
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:1867
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:1762
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:1363
static unsigned coap_get_code_raw(const coap_pkt_t *pkt)
Get a message's raw code (class + detail)
Definition nanocoap.h:514
static size_t coap_hdr_len(const coap_hdr_t *hdr)
Get the header length of a CoAP packet.
Definition nanocoap.h:774
ssize_t coap_build_reply_header(coap_pkt_t *pkt, unsigned code, void *buf, size_t len, int ct, void **payload, size_t *payload_len_max)
Create CoAP reply header (convenience function)
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:1694
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:1452
static uint8_t coap_code(unsigned cls, unsigned detail)
Encode given code class and code detail to raw code.
Definition nanocoap.h:466
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:1590
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:954
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:538
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:914
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:1851
ssize_t coap_build_reply(coap_pkt_t *pkt, unsigned code, uint8_t *rbuf, unsigned rlen, unsigned payload_len)
Build reply to CoAP request.
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:1434
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:687
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:1797
uint16_t coap_method_flags_t
Method flag type.
Definition nanocoap.h:306
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:606
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:1715
static bool coap_block2_finish(coap_block_slicer_t *slicer)
Finish a block2 response.
Definition nanocoap.h:1116
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:621
static coap_method_t coap_get_method(const coap_pkt_t *pkt)
Get a request's method type.
Definition nanocoap.h:526
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:659
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:478
static int coap_get_block2(coap_pkt_t *pkt, coap_block1_t *block)
Block2 option getter.
Definition nanocoap.h:1227
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:892
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:1570
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:490
ssize_t coap_reply_simple(coap_pkt_t *pkt, unsigned code, uint8_t *buf, size_t len, unsigned ct, const void *payload, size_t payload_len)
Create CoAP reply (convenience function)
static int coap_get_block1(coap_pkt_t *pkt, coap_block1_t *block)
Block1 option getter.
Definition nanocoap.h:1213
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:647
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:272
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:1903
static void coap_hdr_set_type(coap_hdr_t *hdr, unsigned type)
Set the message type for the given CoAP header.
Definition nanocoap.h:711
static void coap_payload_advance_bytes(coap_pkt_t *pkt, size_t len)
Advance the payload pointer.
Definition nanocoap.h:2196
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:2365
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:1958
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:1415
static unsigned coap_get_type(const coap_pkt_t *pkt)
Get the message type.
Definition nanocoap.h:594
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:502
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:676
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.
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:1610
static void * coap_get_token(const coap_pkt_t *pkt)
Get pointer to a message's token.
Definition nanocoap.h:565
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:1833
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:1815
static bool coap_block1_finish(coap_block_slicer_t *slicer)
Finish a block1 request.
Definition nanocoap.h:1097
void * coap_request_ctx_get_context(const coap_request_ctx_t *ctx)
Get resource context associated with a CoAP request.
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:1975
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:287
static unsigned coap_size2szx(unsigned len)
Helper to encode byte size into next equal or smaller SZX value.
Definition nanocoap.h:1281
int(* coap_request_cb_t)(void *arg, coap_pkt_t *pkt)
Coap request callback descriptor.
Definition nanocoap.h:299
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:1744
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:1041
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:935
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:579
static bool coap_has_observe(coap_pkt_t *pkt)
Identifies a packet containing an observe option.
Definition nanocoap.h:2343
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:1339
static coap_method_flags_t coap_method2flag(unsigned code)
Convert message code (request method) into a corresponding bit field.
Definition nanocoap.h:2146
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:1397
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:553
static void coap_clear_observe(coap_pkt_t *pkt)
Clears the observe option value from a packet.
Definition nanocoap.h:2353
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:293
Definitions for internet operations.
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:71
Generic CoAP values as defined by RFC7252.
UDP sock definitions.
CoAP resource request handler context.
Definition nanocoap.h:338
sock_udp_ep_t * local
local endpoint of the request
Definition nanocoap.h:342
const coap_resource_t * resource
resource of the request
Definition nanocoap.h:339
sock_udp_ep_t * remote
remote endpoint of the request
Definition nanocoap.h:340
uint32_t tl_type
transport the packet was received over
Definition nanocoap.h:351
Common IP-based transport layer end point.
Definition sock.h:215
Block1 helper struct.
Definition nanocoap.h:410
int8_t more
-1 for no option, 0 for last block, 1 for more blocks coming
Definition nanocoap.h:414
uint32_t blknum
block number
Definition nanocoap.h:412
size_t offset
offset of received data
Definition nanocoap.h:411
uint8_t szx
szx value
Definition nanocoap.h:413
Blockwise transfer helper struct.
Definition nanocoap.h:421
uint8_t * opt
Pointer to the placed option
Definition nanocoap.h:425
size_t end
End offset of the current block
Definition nanocoap.h:423
size_t start
Start offset of the current block
Definition nanocoap.h:422
size_t cur
Offset of the generated content
Definition nanocoap.h:424
Raw CoAP PDU header structure.
Definition nanocoap.h:201
uint8_t ver_t_tkl
version, token, token length
Definition nanocoap.h:202
uint8_t code
CoAP code (e.g.m 205)
Definition nanocoap.h:203
uint16_t id
Req/resp ID
Definition nanocoap.h:204
CoAP option array entry.
Definition nanocoap.h:210
uint16_t offset
offset in packet
Definition nanocoap.h:212
uint16_t opt_num
full CoAP option number
Definition nanocoap.h:211
CoAP PDU parsing context structure.
Definition nanocoap.h:232
uint8_t * payload
pointer to end of the header
Definition nanocoap.h:234
uint16_t payload_len
length of payload
Definition nanocoap.h:236
coap_hdr_t * hdr
pointer to raw packet
Definition nanocoap.h:233
uint16_t options_len
length of options array
Definition nanocoap.h:237
BITFIELD(opt_crit, CONFIG_NANOCOAP_NOPTS_MAX)
unhandled critical option
iolist_t * snips
payload snips (optional)
Definition nanocoap.h:235
Type for CoAP resource subtrees.
Definition nanocoap.h:321
const size_t resources_numof
number of entries in array
Definition nanocoap.h:323
const coap_resource_t * resources
ptr to resource array
Definition nanocoap.h:322
Type for CoAP resource entry.
Definition nanocoap.h:311
const char * path
URI path of resource
Definition nanocoap.h:312
coap_method_flags_t methods
OR'ed methods this resource allows.
Definition nanocoap.h:313
coap_handler_t handler
ptr to resource handler
Definition nanocoap.h:314
void * context
ptr to user defined context data
Definition nanocoap.h:315
iolist structure definition
Definition iolist.h:39
Cross File Arrays.