libcoap 4.3.5b
Loading...
Searching...
No Matches
coap_resource.c
Go to the documentation of this file.
1/* coap_resource.c -- generic resource handling
2 *
3 * Copyright (C) 2010--2025 Olaf Bergmann <bergmann@tzi.org>
4 *
5 * SPDX-License-Identifier: BSD-2-Clause
6 *
7 * This file is part of the CoAP library libcoap. Please see
8 * README for terms of use.
9 */
10
15
17
18#if COAP_SERVER_SUPPORT
19#include <stdio.h>
20
21#ifdef COAP_EPOLL_SUPPORT
22#include <sys/epoll.h>
23#include <sys/timerfd.h>
24#endif /* COAP_EPOLL_SUPPORT */
25
26#ifndef min
27#define min(a,b) ((a) < (b) ? (a) : (b))
28#endif
29
30/* Helper functions for conditional output of character sequences into
31 * a given buffer. The first Offset characters are skipped.
32 */
33
38#define PRINT_WITH_OFFSET(Buf,Offset,Char) \
39 if ((Offset) == 0) { \
40 (*(Buf)++) = (Char); \
41 } else { \
42 (Offset)--; \
43 } \
44
48#define PRINT_COND_WITH_OFFSET(Buf,Bufend,Offset,Char,Result) { \
49 if ((Buf) < (Bufend)) { \
50 PRINT_WITH_OFFSET(Buf,Offset,Char); \
51 } \
52 (Result)++; \
53 }
54
60#define COPY_COND_WITH_OFFSET(Buf,Bufend,Offset,Str,Length,Result) { \
61 size_t i; \
62 for (i = 0; i < (Length); i++) { \
63 PRINT_COND_WITH_OFFSET((Buf), (Bufend), (Offset), (Str)[i], (Result)); \
64 } \
65 }
66
67static int
68match(const coap_str_const_t *text, const coap_str_const_t *pattern,
69 int match_prefix, int match_substring) {
70 assert(text);
71 assert(pattern);
72
73 if (text->length < pattern->length || !pattern->s)
74 return 0;
75
76 if (match_substring) {
77 const uint8_t *next_token = text->s;
78 size_t remaining_length = text->length;
79 while (remaining_length) {
80 size_t token_length;
81 const uint8_t *token = next_token;
82 next_token = (unsigned char *)memchr(token, ' ', remaining_length);
83
84 if (next_token) {
85 token_length = next_token - token;
86 remaining_length -= (token_length + 1);
87 next_token++;
88 } else {
89 token_length = remaining_length;
90 remaining_length = 0;
91 }
92
93 if ((match_prefix || pattern->length == token_length) &&
94 memcmp(token, pattern->s, pattern->length) == 0)
95 return 1;
96 }
97 return 0;
98 }
99
100 return (match_prefix || pattern->length == text->length) &&
101 memcmp(text->s, pattern->s, pattern->length) == 0;
102}
103
105coap_print_wellknown(coap_context_t *context, unsigned char *buf,
106 size_t *buflen, size_t offset,
107 const coap_string_t *query_filter) {
108 coap_print_status_t result;
110 result = coap_print_wellknown_lkd(context, buf, buflen, offset, query_filter);
111 coap_lock_unlock(context);
112 return result;
113}
114
115static coap_str_const_t coap_default_uri_wellknown = {
117 (const uint8_t *)COAP_DEFAULT_URI_WELLKNOWN
118};
119
121coap_print_wellknown_lkd(coap_context_t *context, unsigned char *buf,
122 size_t *buflen, size_t offset,
123 const coap_string_t *query_filter) {
124 coap_print_status_t output_length = 0;
125 unsigned char *p = buf;
126 const uint8_t *bufend = buf + *buflen;
127 size_t left, written = 0;
128 coap_print_status_t result;
129 const size_t old_offset = offset;
130 int subsequent_resource = 0;
131#ifdef WITHOUT_QUERY_FILTER
132 (void)query_filter;
133#else
134 coap_str_const_t resource_param = { 0, NULL }, query_pattern = { 0, NULL };
135 int flags = 0; /* MATCH_SUBSTRING, MATCH_PREFIX, MATCH_URI */
136#define MATCH_URI 0x01
137#define MATCH_PREFIX 0x02
138#define MATCH_SUBSTRING 0x04
139 static const coap_str_const_t _rt_attributes[] = {
140 {2, (const uint8_t *)"rt"},
141 {2, (const uint8_t *)"if"},
142 {3, (const uint8_t *)"rel"},
143 {0, NULL}
144 };
145#endif /* WITHOUT_QUERY_FILTER */
146
147 coap_lock_check_locked(context);
148#ifndef WITHOUT_QUERY_FILTER
149 /* split query filter, if any */
150 if (query_filter) {
151 resource_param.s = query_filter->s;
152 while (resource_param.length < query_filter->length &&
153 resource_param.s[resource_param.length] != '=')
154 resource_param.length++;
155
156 if (resource_param.length < query_filter->length) {
157 const coap_str_const_t *rt_attributes;
158 if (resource_param.length == 4 &&
159 memcmp(resource_param.s, "href", 4) == 0)
160 flags |= MATCH_URI;
161
162 for (rt_attributes = _rt_attributes; rt_attributes->s; rt_attributes++) {
163 if (resource_param.length == rt_attributes->length &&
164 memcmp(resource_param.s, rt_attributes->s, rt_attributes->length) == 0) {
165 flags |= MATCH_SUBSTRING;
166 break;
167 }
168 }
169
170 /* rest is query-pattern */
171 query_pattern.s =
172 query_filter->s + resource_param.length + 1;
173
174 assert((resource_param.length + 1) <= query_filter->length);
175 query_pattern.length =
176 query_filter->length - (resource_param.length + 1);
177
178 if ((query_pattern.s[0] == '/') && ((flags & MATCH_URI) == MATCH_URI)) {
179 query_pattern.s++;
180 query_pattern.length--;
181 }
182
183 if (query_pattern.length &&
184 query_pattern.s[query_pattern.length-1] == '*') {
185 query_pattern.length--;
186 flags |= MATCH_PREFIX;
187 }
188 }
189 }
190#endif /* WITHOUT_QUERY_FILTER */
191
192 RESOURCES_ITER(context->resources, r) {
193
194 if (coap_string_equal(r->uri_path, &coap_default_uri_wellknown)) {
195 /* server app has defined a resource for .well-known/core - ignore */
196 continue;
197 }
198#ifndef WITHOUT_QUERY_FILTER
199 if (resource_param.length) { /* there is a query filter */
200
201 if (flags & MATCH_URI) { /* match resource URI */
202 if (!match(r->uri_path, &query_pattern, (flags & MATCH_PREFIX) != 0,
203 (flags & MATCH_SUBSTRING) != 0))
204 continue;
205 } else { /* match attribute */
206 coap_attr_t *attr;
207 coap_str_const_t unquoted_val;
208 attr = coap_find_attr(r, &resource_param);
209 if (!attr || !attr->value)
210 continue;
211 unquoted_val = *attr->value;
212 if (attr->value->s[0] == '"') { /* if attribute has a quoted value, remove double quotes */
213 unquoted_val.length -= 2;
214 unquoted_val.s += 1;
215 }
216 if (!(match(&unquoted_val, &query_pattern,
217 (flags & MATCH_PREFIX) != 0,
218 (flags & MATCH_SUBSTRING) != 0)))
219 continue;
220 }
221 }
222#endif /* WITHOUT_QUERY_FILTER */
223
224 if (!subsequent_resource) { /* this is the first resource */
225 subsequent_resource = 1;
226 } else {
227 PRINT_COND_WITH_OFFSET(p, bufend, offset, ',', written);
228 }
229
230 left = bufend - p; /* calculate available space */
231 result = coap_print_link(r, p, &left, &offset);
232
233 if (result & COAP_PRINT_STATUS_ERROR) {
234 break;
235 }
236
237 /* coap_print_link() returns the number of characters that
238 * where actually written to p. Now advance to its end. */
239 p += COAP_PRINT_OUTPUT_LENGTH(result);
240 written += left;
241 }
242
243 *buflen = written;
244 output_length = (coap_print_status_t)(p - buf);
245
246 if (output_length > COAP_PRINT_STATUS_MAX) {
248 }
249
250 result = (coap_print_status_t)output_length;
251
252 if (result + old_offset - offset < *buflen) {
253 result |= COAP_PRINT_STATUS_TRUNC;
254 }
255 return result;
256}
257
258static coap_str_const_t null_path_value = {0, (const uint8_t *)""};
259static coap_str_const_t *null_path = &null_path_value;
260
262coap_resource_init(coap_str_const_t *uri_path, int flags) {
264
266 if (r) {
267 memset(r, 0, sizeof(coap_resource_t));
268#if COAP_THREAD_SAFE
269 coap_lock_init(&r->lock);
270#endif /* COAP_THREAD_SAFE */
271
272 if (!(flags & COAP_RESOURCE_FLAGS_RELEASE_URI)) {
273 /* Need to take a copy if caller is not providing a release request */
274 if (uri_path)
275 uri_path = coap_new_str_const(uri_path->s, uri_path->length);
276 else
277 uri_path = coap_new_str_const(null_path->s, null_path->length);
278 } else if (!uri_path) {
279 /* Do not expect this, but ... */
280 uri_path = coap_new_str_const(null_path->s, null_path->length);
281 }
282
283 if (uri_path)
284 r->uri_path = uri_path;
285
286 r->flags = flags;
287 r->observe = 2;
288 } else {
289 coap_log_debug("coap_resource_init: no memory left\n");
290 }
291
292 return r;
293}
294
295static const uint8_t coap_unknown_resource_uri[] =
296 "- Unknown -";
297
301
303 if (r) {
304 memset(r, 0, sizeof(coap_resource_t));
305#if COAP_THREAD_SAFE
306 coap_lock_init(&r->lock);
307#endif /* COAP_THREAD_SAFE */
308 r->is_unknown = 1;
309 /* Something unlikely to be used, but it shows up in the logs */
310 r->uri_path = coap_new_str_const(coap_unknown_resource_uri, sizeof(coap_unknown_resource_uri)-1);
311 r->flags = flags & ~COAP_RESOURCE_FLAGS_RELEASE_URI;
313 } else {
314 coap_log_debug("coap_resource_unknown_init2: no memory left\n");
315 }
316
317 return r;
318}
319
322 return coap_resource_unknown_init2(put_handler, 0);
323}
324
325static const uint8_t coap_proxy_resource_uri[] =
326 "- Proxy URI -";
327
330 size_t host_name_count,
331 const char *host_name_list[], int flags) {
333
334 if (host_name_count == 0) {
335 coap_log_err("coap_resource_proxy_uri_init: Must have one or more host names defined\n");
336 return NULL;
337 }
339 if (r) {
340 size_t i;
341 memset(r, 0, sizeof(coap_resource_t));
342#if COAP_THREAD_SAFE
343 coap_lock_init(&r->lock);
344#endif /* COAP_THREAD_SAFE */
345 r->is_proxy_uri = 1;
346 /* Something unlikely to be used, but it shows up in the logs */
347 r->uri_path = coap_new_str_const(coap_proxy_resource_uri, sizeof(coap_proxy_resource_uri)-1);
348 /* Preset all the handlers */
349 for (i = 0; i < (sizeof(r->handler) / sizeof(r->handler[0])); i++) {
350 r->handler[i] = handler;
351 }
352 if (host_name_count) {
353 r->proxy_name_list = coap_malloc_type(COAP_STRING, host_name_count *
354 sizeof(coap_str_const_t *));
355 if (r->proxy_name_list) {
356 for (i = 0; i < host_name_count; i++) {
357 r->proxy_name_list[i] =
358 coap_new_str_const((const uint8_t *)host_name_list[i],
359 strlen(host_name_list[i]));
360 if (!r->proxy_name_list[i]) {
361 coap_log_err("coap_resource_proxy_uri_init: unable to add host name\n");
362 if (i == 0) {
363 coap_free_type(COAP_STRING, r->proxy_name_list);
364 r->proxy_name_list = NULL;
365 }
366 break;
367 }
368 }
369 r->proxy_name_count = i;
370 }
371 }
372 r->flags = flags & ~COAP_RESOURCE_FLAGS_RELEASE_URI;
373 } else {
374 coap_log_debug("coap_resource_proxy_uri_init2: no memory left\n");
375 }
376
377 return r;
378}
379
382 size_t host_name_count, const char *host_name_list[]) {
383 return coap_resource_proxy_uri_init2(handler, host_name_count,
384 host_name_list, 0);
385}
386
387static const uint8_t coap_rev_proxy_resource_uri[] =
388 "- Rev Proxy -";
389
393
395 if (r) {
396 memset(r, 0, sizeof(coap_resource_t));
397#if COAP_THREAD_SAFE
398 coap_lock_init(&r->lock);
399#endif /* COAP_THREAD_SAFE */
400 r->is_unknown = 1;
401 /* Something unlikely to be used, but it shows up in the logs */
402 r->uri_path = coap_new_str_const(coap_rev_proxy_resource_uri,
403 sizeof(coap_rev_proxy_resource_uri)-1);
404 r->flags = flags & ~COAP_RESOURCE_FLAGS_RELEASE_URI;
413 } else {
414 coap_log_debug("coap_resource_rev_proxy_init: no memory left\n");
415 }
416
417 return r;
418}
419
422 coap_str_const_t *name,
423 coap_str_const_t *val,
424 int flags) {
425 coap_attr_t *attr;
426
427 if (!resource || !name)
428 return NULL;
430
431 if (attr) {
432 if (!(flags & COAP_ATTR_FLAGS_RELEASE_NAME)) {
433 /* Need to take a copy if caller is not providing a release request */
434 name = coap_new_str_const(name->s, name->length);
435 }
436 attr->name = name;
437 if (val) {
438 if (!(flags & COAP_ATTR_FLAGS_RELEASE_VALUE)) {
439 /* Need to take a copy if caller is not providing a release request */
440 val = coap_new_str_const(val->s, val->length);
441 }
442 }
443 attr->value = val;
444
445 attr->flags = flags;
446
447 /* add attribute to resource list */
448 LL_PREPEND(resource->link_attr, attr);
449 } else {
450 coap_log_debug("coap_add_attr: no memory left\n");
451 }
452
453 return attr;
454}
455
458 coap_str_const_t *name) {
459 coap_attr_t *attr;
460
461 if (!resource || !name)
462 return NULL;
463
464 LL_FOREACH(resource->link_attr, attr) {
465 if (attr->name->length == name->length &&
466 memcmp(attr->name->s, name->s, name->length) == 0)
467 return attr;
468 }
469
470 return NULL;
471}
472
475 if (attr)
476 return attr->value;
477 return NULL;
478}
479
480void
481coap_delete_attr(coap_attr_t *attr) {
482 if (!attr)
483 return;
484 coap_delete_str_const(attr->name);
485 if (attr->value) {
486 coap_delete_str_const(attr->value);
487 }
488
490}
491
492typedef enum coap_deleting_resource_t {
493 COAP_DELETING_RESOURCE,
494 COAP_NOT_DELETING_RESOURCE
495} coap_deleting_resource_t;
496
497static void coap_notify_observers(coap_context_t *context, coap_resource_t *r,
498 coap_deleting_resource_t deleting);
499
500static void
501coap_free_resource(coap_resource_t *resource) {
502 coap_attr_t *attr, *tmp;
503 coap_subscription_t *obs, *otmp;
504
505 assert(resource);
506
507 if (!resource->context->observe_no_clear) {
509 coap_notify_observers(resource->context, resource, COAP_DELETING_RESOURCE);
510 }
511
512 if (resource->context->resource_deleted)
513 resource->context->resource_deleted(resource->context, resource->uri_path,
514 resource->context->observe_user_data);
515
516 if (resource->context->release_userdata && resource->user_data) {
517 coap_lock_callback(resource->context, resource->context->release_userdata(resource->user_data));
518 }
519
520 /* delete registered attributes */
521 LL_FOREACH_SAFE(resource->link_attr, attr, tmp) coap_delete_attr(attr);
522
523 /* Either the application provided or libcoap copied - need to delete it */
524 coap_delete_str_const(resource->uri_path);
525
526 /* free all elements from resource->subscribers */
527 LL_FOREACH_SAFE(resource->subscribers, obs, otmp) {
528 if (resource->context->observe_deleted)
529 resource->context->observe_deleted(obs->session, obs,
530 resource->context->observe_user_data);
535 }
536 if (resource->proxy_name_count && resource->proxy_name_list) {
537 size_t i;
538
539 for (i = 0; i < resource->proxy_name_count; i++) {
540 coap_delete_str_const(resource->proxy_name_list[i]);
541 }
542 coap_free_type(COAP_STRING, resource->proxy_name_list);
543 }
544
545 coap_free_type(COAP_RESOURCE, resource);
546}
547
548COAP_API void
550 coap_lock_lock(context, return);
551 coap_add_resource_lkd(context, resource);
552 coap_lock_unlock(context);
553}
554
555void
556coap_add_resource_lkd(coap_context_t *context, coap_resource_t *resource) {
557 coap_lock_check_locked(context);
558 if (resource->is_unknown) {
559 if (context->unknown_resource)
560 coap_free_resource(context->unknown_resource);
561 context->unknown_resource = resource;
562 } else if (resource->is_proxy_uri) {
563 if (context->proxy_uri_resource)
564 coap_free_resource(context->proxy_uri_resource);
565 context->proxy_uri_resource = resource;
566 } else {
567 coap_resource_t *r = coap_get_resource_from_uri_path_lkd(context,
568 resource->uri_path);
569
570 if (r) {
571 coap_log_warn("coap_add_resource: Duplicate uri_path '%*.*s', old resource deleted\n",
572 (int)resource->uri_path->length, (int)resource->uri_path->length,
573 resource->uri_path->s);
574 coap_delete_resource_lkd(context, r);
575 }
576 RESOURCES_ADD(context->resources, resource);
577#if COAP_WITH_OBSERVE_PERSIST
578 if (context->unknown_pdu && context->dyn_resource_save_file &&
579 context->dyn_resource_added && resource->observable) {
580 coap_bin_const_t raw_packet;
581
582 raw_packet.s = context->unknown_pdu->token -
583 context->unknown_pdu->hdr_size;
584 raw_packet.length = context->unknown_pdu->used_size +
585 context->unknown_pdu->hdr_size;
586 context->dyn_resource_added(context->unknown_session, resource->uri_path,
587 &raw_packet, context->observe_user_data);
588 }
589#endif /* COAP_WITH_OBSERVE_PERSIST */
590 }
591 assert(resource->context == NULL);
592 resource->context = context;
593}
594
595COAP_API int
597 int ret;
598
599 if (!resource)
600 return 0;
601
602 context = resource->context;
603 if (context) {
604 coap_lock_lock(context, return 0);
605 ret = coap_delete_resource_lkd(context, resource);
606 coap_lock_unlock(context);
607 } else {
608 ret = coap_delete_resource_lkd(context, resource);
609 }
610 return ret;
611}
612
613/*
614 * Input context is ignored, but param left there to keep API consistent
615 */
616int
617coap_delete_resource_lkd(coap_context_t *context, coap_resource_t *resource) {
618 if (!resource)
619 return 0;
620
621 context = resource->context;
622 if (context) {
623 coap_lock_check_locked(context);
624 }
625
626 if (resource->is_unknown) {
627 if (context && context->unknown_resource == resource) {
628 context->unknown_resource = NULL;
629 }
630 } else if (resource->is_proxy_uri) {
631 if (context && context->proxy_uri_resource == resource) {
632 context->proxy_uri_resource = NULL;
633 }
634 } else if (context) {
635 /* remove resource from list */
636 RESOURCES_DELETE(context->resources, resource);
637 }
638
639 /* and free its allocated memory */
640 coap_free_resource(resource);
641
642 return 1;
643}
644
645void
646coap_delete_all_resources(coap_context_t *context) {
647 coap_resource_t *res;
648 coap_resource_t *rtmp;
649
650 /* Cannot call RESOURCES_ITER because coap_free_resource() releases
651 * the allocated storage. */
652
653 HASH_ITER(hh, context->resources, res, rtmp) {
654 HASH_DELETE(hh, context->resources, res);
655 coap_free_resource(res);
656 }
657
658 context->resources = NULL;
659
660 if (context->unknown_resource) {
661 coap_free_resource(context->unknown_resource);
662 context->unknown_resource = NULL;
663 }
664 if (context->proxy_uri_resource) {
665 coap_free_resource(context->proxy_uri_resource);
666 context->proxy_uri_resource = NULL;
667 }
668}
669
672 coap_resource_t *result;
673
674 coap_lock_lock(context, return NULL);
675 result = coap_get_resource_from_uri_path_lkd(context, uri_path);
676 coap_lock_unlock(context);
677
678 return result;
679}
680
682coap_get_resource_from_uri_path_lkd(coap_context_t *context,
683 coap_str_const_t *uri_path) {
684 coap_resource_t *result;
685
686 coap_lock_check_locked(context);
687
688 RESOURCES_FIND(context->resources, uri_path, result);
689
690 return result;
691}
692
694coap_print_link(const coap_resource_t *resource,
695 unsigned char *buf, size_t *len, size_t *offset) {
696 unsigned char *p = buf;
697 const uint8_t *bufend = buf + *len;
698 coap_attr_t *attr;
699 coap_print_status_t result = 0;
700 coap_print_status_t output_length = 0;
701 const size_t old_offset = *offset;
702
703 *len = 0;
704 PRINT_COND_WITH_OFFSET(p, bufend, *offset, '<', *len);
705 PRINT_COND_WITH_OFFSET(p, bufend, *offset, '/', *len);
706
707 COPY_COND_WITH_OFFSET(p, bufend, *offset,
708 resource->uri_path->s, resource->uri_path->length, *len);
709
710 PRINT_COND_WITH_OFFSET(p, bufend, *offset, '>', *len);
711
712 LL_FOREACH(resource->link_attr, attr) {
713
714 PRINT_COND_WITH_OFFSET(p, bufend, *offset, ';', *len);
715
716 COPY_COND_WITH_OFFSET(p, bufend, *offset,
717 attr->name->s, attr->name->length, *len);
718
719 if (attr->value && attr->value->s) {
720 PRINT_COND_WITH_OFFSET(p, bufend, *offset, '=', *len);
721
722 COPY_COND_WITH_OFFSET(p, bufend, *offset,
723 attr->value->s, attr->value->length, *len);
724 }
725
726 }
727 if (resource->observable) {
728 COPY_COND_WITH_OFFSET(p, bufend, *offset, ";obs", 4, *len);
729 }
730
731#if COAP_OSCORE_SUPPORT
732 /* If oscore is enabled */
733 if (resource->flags & COAP_RESOURCE_FLAGS_OSCORE_ONLY)
734 COPY_COND_WITH_OFFSET(p, bufend, *offset, ";osc", 4, *len);
735#endif /* COAP_OSCORE_SUPPORT */
736
737 output_length = (coap_print_status_t)(p - buf);
738
739 if (output_length > COAP_PRINT_STATUS_MAX) {
741 }
742
743 result = (coap_print_status_t)output_length;
744
745 if (result + old_offset - *offset < *len) {
746 result |= COAP_PRINT_STATUS_TRUNC;
747 }
748
749 return result;
750}
751
752void
754 coap_request_t method,
755 coap_method_handler_t handler) {
756 coap_register_request_handler(resource, method, handler);
757}
758
759void
761 coap_request_t method,
762 coap_method_handler_t handler) {
763 assert(resource);
764 assert(method > 0 && (size_t)(method-1) <
765 sizeof(resource->handler)/sizeof(coap_method_handler_t));
766 resource->handler[method-1] = handler;
767}
768
771 const coap_bin_const_t *token) {
773
774 assert(resource);
775 assert(session);
776
777 LL_FOREACH(resource->subscribers, s) {
778 if (s->session == session &&
779 (!token || coap_binary_equal(token, &s->pdu->actual_token)))
780 return s;
781 }
782
783 return NULL;
784}
785
786static coap_subscription_t *
787coap_find_observer_cache_key(coap_resource_t *resource, coap_session_t *session,
788 const coap_cache_key_t *cache_key) {
790
791 assert(resource);
792 assert(session);
793
794 LL_FOREACH(resource->subscribers, s) {
795 if (s->session == session
796 && (memcmp(cache_key, s->cache_key, sizeof(coap_cache_key_t)) == 0))
797 return s;
798 }
799
800 return NULL;
801}
802
803/* https://rfc-editor.org/rfc/rfc7641#section-3.6 */
804static const uint16_t cache_ignore_options[] = { COAP_OPTION_ETAG,
806 };
809 coap_session_t *session,
810 const coap_bin_const_t *token,
811 const coap_pdu_t *request) {
813 coap_cache_key_t *cache_key = NULL;
814 size_t len;
815 const uint8_t *data;
816
817 assert(session);
818
819 /* Check if there is already a subscription for this peer. */
820 s = coap_find_observer(resource, session, token);
821 if (!s) {
822 /*
823 * Cannot allow a duplicate to be created for the same query as application
824 * may not be cleaning up duplicates. If duplicate found, then original
825 * observer is deleted and a new one created with the new token
826 */
827 cache_key = coap_cache_derive_key_w_ignore(session, request,
829 cache_ignore_options,
830 sizeof(cache_ignore_options)/sizeof(cache_ignore_options[0]));
831 if (cache_key) {
832 s = coap_find_observer_cache_key(resource, session, cache_key);
833 if (s) {
834 /* Delete old entry with old token */
835 coap_delete_observer(resource, session, &s->pdu->actual_token);
836 s = NULL;
837 }
838 }
839 }
840
841 /* We are done if subscription was found. */
842 if (s) {
843 return s;
844 }
845
846 /* Check if there is already maximum number of subscribers present */
847#if (COAP_RESOURCE_MAX_SUBSCRIBER > 0)
848 uint32_t subscriber_count = 0;
849 LL_COUNT(resource->subscribers, s, subscriber_count);
850 if (subscriber_count >= COAP_RESOURCE_MAX_SUBSCRIBER) {
851 return NULL; /* Signal error */
852 }
853#endif /* COAP_RESOURCE_MAX_SUBSCRIBER */
854
855 /* Create a new subscription */
857
858 if (!s) {
859 coap_delete_cache_key(cache_key);
860 return NULL;
861 }
862
864 s->pdu = coap_pdu_duplicate_lkd(request, session, token->length,
865 token->s, NULL);
866 if (s->pdu == NULL) {
867 coap_delete_cache_key(cache_key);
869 return NULL;
870 }
871 if (coap_get_data(request, &len, &data)) {
872 /* This could be a large bodied FETCH */
873 s->pdu->max_size = 0;
874 coap_add_data(s->pdu, len, data);
875 }
876 if (cache_key == NULL) {
877 cache_key = coap_cache_derive_key_w_ignore(session, request,
879 cache_ignore_options,
880 sizeof(cache_ignore_options)/sizeof(cache_ignore_options[0]));
881 if (cache_key == NULL) {
883 coap_delete_cache_key(cache_key);
885 return NULL;
886 }
887 }
888 s->cache_key = cache_key;
890
891 /* add subscriber to resource */
892 LL_PREPEND(resource->subscribers, s);
893
894 coap_log_debug("create new subscription %p key 0x%02x%02x%02x%02x\n",
895 (void *)s, s->cache_key->key[0], s->cache_key->key[1],
896 s->cache_key->key[2], s->cache_key->key[3]);
897
898 if (session->context->observe_added && session->proto == COAP_PROTO_UDP) {
899 coap_bin_const_t raw_packet;
900 coap_bin_const_t *oscore_info = NULL;
901#if COAP_OSCORE_SUPPORT
902 oscore_association_t *association;
903
904 if (session->recipient_ctx && session->recipient_ctx->recipient_id) {
905 /*
906 * Need to track the association used for tracking this observe, done as
907 * a CBOR array. Read in coap_persist_observe_add().
908 *
909 * If an entry is null, then use nil, else a set of bytes
910 *
911 * Currently tracking 5 items
912 * recipient_id
913 * id_context
914 * aad (from oscore_association_t)
915 * partial_iv (from oscore_association_t)
916 * nonce (from oscore_association_t)
917 */
918 uint8_t info_buffer[60];
919 uint8_t *info_buf = info_buffer;
920 size_t info_len = sizeof(info_buffer);
921 size_t ret = 0;
922 coap_bin_const_t ctoken = { token->length, token->s };
923
924 ret += oscore_cbor_put_array(&info_buf, &info_len, 5);
925 ret += oscore_cbor_put_bytes(&info_buf,
926 &info_len,
927 session->recipient_ctx->recipient_id->s,
928 session->recipient_ctx->recipient_id->length);
929 if (session->recipient_ctx->osc_ctx &&
930 session->recipient_ctx->osc_ctx->id_context) {
931 ret += oscore_cbor_put_bytes(&info_buf,
932 &info_len,
933 session->recipient_ctx->osc_ctx->id_context->s,
934 session->recipient_ctx->osc_ctx->id_context->length);
935 } else {
936 ret += oscore_cbor_put_nil(&info_buf, &info_len);
937 }
938 association = oscore_find_association(session, &ctoken);
939 if (association) {
940 if (association->aad) {
941 ret += oscore_cbor_put_bytes(&info_buf,
942 &info_len,
943 association->aad->s,
944 association->aad->length);
945 } else {
946 ret += oscore_cbor_put_nil(&info_buf, &info_len);
947 }
948 if (association->partial_iv) {
949 ret += oscore_cbor_put_bytes(&info_buf,
950 &info_len,
951 association->partial_iv->s,
952 association->partial_iv->length);
953 } else {
954 ret += oscore_cbor_put_nil(&info_buf, &info_len);
955 }
956 if (association->nonce) {
957 ret += oscore_cbor_put_bytes(&info_buf,
958 &info_len,
959 association->nonce->s,
960 association->nonce->length);
961 } else {
962 ret += oscore_cbor_put_nil(&info_buf, &info_len);
963 }
964 } else {
965 ret += oscore_cbor_put_nil(&info_buf, &info_len);
966 ret += oscore_cbor_put_nil(&info_buf, &info_len);
967 }
968 oscore_info = coap_new_bin_const(info_buffer, ret);
969 }
970#endif /* COAP_OSCORE_SUPPORT */
971
972 /* s->pdu header is not currently encoded */
973 memcpy(s->pdu->token - request->hdr_size,
974 request->token - request->hdr_size, request->hdr_size);
975 raw_packet.s = s->pdu->token - request->hdr_size;
976 raw_packet.length = s->pdu->used_size + request->hdr_size;
977 session->context->observe_added(session, s, session->proto,
978 &session->endpoint->bind_addr,
979 &session->addr_info,
980 &raw_packet,
981 oscore_info,
982 session->context->observe_user_data);
983#if COAP_OSCORE_SUPPORT
984 coap_delete_bin_const(oscore_info);
985#endif /* COAP_OSCORE_SUPPORT */
986 }
987 if (resource->context->track_observe_value) {
988 /* Track last used observe value (as app handler is called) */
989 resource->context->track_observe_value(resource->context,resource->uri_path,
990 resource->observe,
991 resource->context->observe_user_data);
992 }
993
994 return s;
995}
996
997void
999 const coap_bin_const_t *token) {
1001
1002 RESOURCES_ITER(context->resources, r) {
1003 s = coap_find_observer(r, session, token);
1004 if (s) {
1005 s->fail_cnt = 0;
1006 }
1007 }
1008}
1009
1010static void
1011coap_delete_observer_internal(coap_resource_t *resource, coap_session_t *session,
1013 if (!s)
1014 return;
1015
1017 char outbuf[2 * 8 + 1] = "";
1018 unsigned int i;
1019
1020 for (i = 0; i < s->pdu->actual_token.length; i++) {
1021 size_t size = strlen(outbuf);
1022
1023 snprintf(&outbuf[size], sizeof(outbuf)-size, "%02x",
1024 s->pdu->actual_token.s[i]);
1025 }
1026 coap_log_debug("removed subscription %p with token '%s' key 0x%02x%02x%02x%02x\n",
1027 (void *)s, outbuf, s->cache_key->key[0], s->cache_key->key[1],
1028 s->cache_key->key[2], s-> cache_key->key[3]);
1029 }
1030 if (session->context->observe_deleted)
1031 session->context->observe_deleted(session, s,
1032 session->context->observe_user_data);
1033
1034 if (resource->subscribers) {
1035 LL_DELETE(resource->subscribers, s);
1036 coap_session_release_lkd(session);
1040 }
1041
1042 return;
1043}
1044
1045int
1047 const coap_bin_const_t *token) {
1049
1050 s = coap_find_observer(resource, session, token);
1051 if (s)
1052 coap_delete_observer_internal(resource, session, s);
1053
1054 return s != NULL;
1055}
1056
1057int
1059 const coap_bin_const_t *token, coap_pdu_t *request) {
1061 int ret = 0;
1062
1063 s = coap_find_observer(resource, session, token);
1064 if (!s) {
1065 /*
1066 * It is possible that the client is using the wrong token.
1067 * An example being a large FETCH spanning multiple blocks.
1068 */
1069 coap_cache_key_t *cache_key;
1070
1071 cache_key = coap_cache_derive_key_w_ignore(session, request,
1073 cache_ignore_options,
1074 sizeof(cache_ignore_options)/sizeof(cache_ignore_options[0]));
1075 if (cache_key) {
1076 s = coap_find_observer_cache_key(resource, session, cache_key);
1077 if (s) {
1078 /* Delete entry with setup token */
1079 ret = coap_delete_observer(resource, session, &s->pdu->actual_token);
1080 }
1081 coap_delete_cache_key(cache_key);
1082 }
1083 } else {
1084 coap_delete_observer_internal(resource, session, s);
1085 ret = 1;
1086 }
1087 return ret;
1088}
1089
1090void
1092 RESOURCES_ITER(context->resources, resource) {
1093 coap_subscription_t *s, *tmp;
1094 LL_FOREACH_SAFE(resource->subscribers, s, tmp) {
1095 if (s->session == session) {
1096 if (context->observe_deleted)
1097 context->observe_deleted(session, s, context->observe_user_data);
1098 assert(resource->subscribers);
1099 LL_DELETE(resource->subscribers, s);
1100 coap_session_release_lkd(session);
1104 }
1105 }
1106 }
1107}
1108
1109static void
1110coap_notify_observers(coap_context_t *context, coap_resource_t *r,
1111 coap_deleting_resource_t deleting) {
1113 coap_subscription_t *obs, *otmp;
1114 coap_pdu_t *response;
1115 uint8_t buf[4];
1116 coap_string_t *query;
1117 coap_block_b_t block;
1118 coap_tick_t now;
1119 coap_session_t *obs_session;
1120
1121 coap_lock_check_locked(context);
1122
1123 if (r->observable && (r->dirty || r->partiallydirty)) {
1124 r->partiallydirty = 0;
1125
1126 LL_FOREACH_SAFE(r->subscribers, obs, otmp) {
1127 obs_session = obs->session;
1128 if (r->dirty == 0 && obs->dirty == 0) {
1129 /*
1130 * running this resource due to partiallydirty, but this observation's
1131 * notification was already enqueued
1132 */
1133 context->observe_pending = 1;
1134 continue;
1135 }
1136 if (obs->session->con_active >= COAP_NSTART(obs->session) &&
1137 ((r->flags & COAP_RESOURCE_FLAGS_NOTIFY_CON) ||
1138 (obs->non_cnt >= COAP_OBS_MAX_NON))) {
1139 /* Waiting for the previous unsolicited response to finish */
1140 r->partiallydirty = 1;
1141 obs->dirty = 1;
1142 context->observe_pending = 1;
1143 continue;
1144 }
1145 coap_ticks(&now);
1146 if (obs->session->lg_xmit && obs->session->lg_xmit->last_all_sent == 0 &&
1147 obs->session->lg_xmit->last_obs &&
1148 (obs->session->lg_xmit->last_obs + 2*COAP_TICKS_PER_SECOND) > now) {
1149 /* Waiting for the previous blocked unsolicited response to finish */
1150 r->partiallydirty = 1;
1151 obs->dirty = 1;
1152 context->observe_pending = 1;
1153 continue;
1154 }
1155
1157 obs->dirty = 0;
1158 /* initialize response */
1159 response = coap_pdu_init(COAP_MESSAGE_CON, 0, 0,
1161 if (!response) {
1162 obs->dirty = 1;
1163 r->partiallydirty = 1;
1164 context->observe_pending = 1;
1165 coap_log_debug("coap_check_notify: pdu init failed, resource stays "
1166 "partially dirty\n");
1167 continue;
1168 }
1169
1170 if (!coap_add_token(response, obs->pdu->actual_token.length,
1171 obs->pdu->actual_token.s)) {
1172 obs->dirty = 1;
1173 r->partiallydirty = 1;
1174 context->observe_pending = 1;
1175 coap_log_debug("coap_check_notify: cannot add token, resource stays "
1176 "partially dirty\n");
1177 coap_delete_pdu_lkd(response);
1178 continue;
1179 }
1180
1181 obs->pdu->mid = response->mid = coap_new_message_id_lkd(obs->session);
1182 /* A lot of the reliable code assumes type is CON */
1184 (r->flags & COAP_RESOURCE_FLAGS_NOTIFY_CON) == 0 &&
1186 obs->non_cnt < COAP_OBS_MAX_NON)) {
1187 response->type = COAP_MESSAGE_NON;
1188 } else {
1189 response->type = COAP_MESSAGE_CON;
1190 }
1191 switch (deleting) {
1192 case COAP_NOT_DELETING_RESOURCE:
1193 /* fill with observer-specific data */
1195 coap_encode_var_safe(buf, sizeof(buf),
1196 r->observe),
1197 buf);
1199 &block)) {
1200 /* Will get updated later (e.g. M bit) if appropriate */
1202 coap_encode_var_safe(buf, sizeof(buf),
1203 ((0 << 4) |
1204 (0 << 3) |
1205 block.aszx)),
1206 buf);
1207 }
1208#if COAP_Q_BLOCK_SUPPORT
1209 else if (coap_get_block_b(obs->session, obs->pdu, COAP_OPTION_Q_BLOCK2,
1210 &block)) {
1211 /* Will get updated later (e.g. M bit) if appropriate */
1213 coap_encode_var_safe(buf, sizeof(buf),
1214 ((0 << 4) |
1215 (0 << 3) |
1216 block.szx)),
1217 buf);
1218 }
1219#endif /* COAP_Q_BLOCK_SUPPORT */
1220
1221 h = r->handler[obs->pdu->code - 1];
1222 assert(h); /* we do not allow subscriptions if no
1223 * GET/FETCH handler is defined */
1224 query = coap_get_query(obs->pdu);
1225 coap_log_debug("Observe PDU presented to app.\n");
1227 coap_log_debug("call custom handler for resource '%*.*s' (4)\n",
1228 (int)r->uri_path->length, (int)r->uri_path->length,
1229 r->uri_path->s);
1230
1231 /* obs may get deleted during callback (potentially by another thread) */
1232 if (r->flags & COAP_RESOURCE_SAFE_REQUEST_HANDLER) {
1234 h(r, obs->session, obs->pdu, query, response),
1235 /* context is being freed off */
1236 coap_delete_string(query);
1237 coap_delete_pdu_lkd(response);
1238 coap_session_release_lkd(obs_session);
1239 return);
1240 } else {
1242 h(r, obs->session, obs->pdu, query, response),
1243 /* context is being freed off */
1244 coap_delete_string(query);
1245 coap_delete_pdu_lkd(response);
1246 coap_session_release_lkd(obs_session);
1247 return);
1248 }
1249
1250 /* Check validity of response code */
1251 if (!coap_check_code_class(obs->session, response)) {
1252 coap_log_warn("handle_request: Invalid PDU response code (%d.%02d)\n",
1253 COAP_RESPONSE_CLASS(response->code),
1254 response->code & 0x1f);
1255 coap_delete_pdu_lkd(response);
1256 return;
1257 }
1258
1259 /* Check if lg_xmit generated and update PDU code if so */
1260 coap_check_code_lg_xmit(obs->session, obs->pdu, response, r, query);
1261 coap_delete_string(query);
1262 if (COAP_RESPONSE_CLASS(response->code) != 2) {
1264 }
1265 if (COAP_RESPONSE_CLASS(response->code) > 2) {
1267 obs = NULL;
1268 }
1269 break;
1270 case COAP_DELETING_RESOURCE:
1271 default:
1272 /* Don't worry if it does not get there */
1273 response->type = COAP_MESSAGE_NON;
1274 response->code = COAP_RESPONSE_CODE(404);
1275 break;
1276 }
1277
1278 if (obs) {
1279 if (response->type == COAP_MESSAGE_CON ||
1281 obs->non_cnt = 0;
1282 } else {
1283 obs->non_cnt++;
1284 }
1285
1286#if COAP_Q_BLOCK_SUPPORT
1287 if (response->code == COAP_RESPONSE_CODE(205) &&
1289 &block) &&
1290 block.m) {
1291 query = coap_get_query(obs->pdu);
1292 mid = coap_send_q_block2(obs->session, r, query, obs->pdu->code,
1293 block, response, 1);
1294 coap_delete_string(query);
1295 goto finish;
1296 }
1297#endif /* COAP_Q_BLOCK_SUPPORT */
1298 }
1299 mid = coap_send_internal(obs_session, response);
1300
1301#if COAP_Q_BLOCK_SUPPORT
1302finish:
1303#endif /* COAP_Q_BLOCK_SUPPORT */
1304 if (COAP_INVALID_MID == mid) {
1305 coap_log_debug("* %s: coap_check_notify: sending failed, resource stays "
1306 "partially dirty\n", coap_session_str(obs_session));
1307 if (obs) {
1309 /*
1310 * obs may have been deleted in coap_send_internal() or
1311 * coap_send_q_block2().
1312 */
1313 LL_FOREACH(r->subscribers, s) {
1314 if (s == obs) {
1315 break;
1316 }
1317 }
1318 if (s == NULL)
1319 obs = NULL;
1320 }
1321 if (obs)
1322 obs->dirty = 1;
1323 r->partiallydirty = 1;
1324 context->observe_pending = 1;
1325 }
1326 }
1327 }
1328 r->dirty = 0;
1329}
1330
1331COAP_API int
1333 int ret;
1334
1335 coap_lock_lock(r->context, return 0);
1336 ret = coap_resource_notify_observers_lkd(r, query);
1337 coap_lock_unlock(r->context);
1338 return ret;
1339}
1340
1341COAP_API int
1343 const coap_string_t *query) {
1344 int ret;
1345
1346 coap_lock_lock(r->context, return 0);
1347 ret = coap_resource_notify_observers_lkd(r, query);
1348 coap_lock_unlock(r->context);
1349 return ret;
1350}
1351
1352int
1354 const coap_string_t *query COAP_UNUSED) {
1355 coap_lock_check_locked(r->context);
1356 if (!r->observable)
1357 return 0;
1358 if (!r->subscribers)
1359 return 0;
1360 r->dirty = 1;
1361
1362 /* Increment value for next Observe use. Observe value must be < 2^24 */
1363 r->observe = (r->observe + 1) & 0xFFFFFF;
1364
1365 assert(r->context);
1366
1367 if (r->context->track_observe_value) {
1368 /* Track last used observe value */
1369 if ((r->observe % r->context->observe_save_freq) == 0)
1370 r->context->track_observe_value(r->context, r->uri_path,
1371 r->observe,
1372 r->context->observe_user_data);
1373 }
1374
1375 r->context->observe_pending = 1;
1376 coap_update_io_timer(r->context, 0);
1377 return 1;
1378}
1379
1380void
1381coap_resource_set_mode(coap_resource_t *resource, int mode) {
1382 resource->flags = (resource->flags &
1385}
1386
1387void
1388coap_resource_set_userdata(coap_resource_t *resource, void *data) {
1389 resource->user_data = data;
1390}
1391
1392void *
1394 return resource->user_data;
1395}
1396
1397void
1400 context->release_userdata = callback;
1401}
1402
1403void
1405 resource->observable = mode ? 1 : 0;
1406}
1407
1410 if (resource)
1411 return resource->uri_path;
1412 return NULL;
1413}
1414
1415COAP_API void
1417 coap_lock_lock(context, return);
1418 coap_check_notify_lkd(context);
1419 coap_lock_unlock(context);
1420}
1421
1422void
1424
1425 coap_lock_check_locked(context);
1426 if (context->observe_pending) {
1427 context->observe_pending = 0;
1428 RESOURCES_ITER(context->resources, r) {
1429 coap_notify_observers(context, r, COAP_NOT_DELETING_RESOURCE);
1430 }
1431 }
1432}
1433
1434void
1436 uint32_t start_observe_no) {
1437 if (!resource)
1438 return;
1439
1440 resource->observe = start_observe_no & 0xffffff;
1441}
1442
1453static void
1454coap_remove_failed_observers(coap_context_t *context,
1455 coap_resource_t *resource,
1456 coap_session_t *session,
1457 const coap_bin_const_t *token) {
1458 coap_subscription_t *obs, *otmp;
1459
1460 LL_FOREACH_SAFE(resource->subscribers, obs, otmp) {
1461 if (obs->session == session &&
1462 coap_binary_equal(token, &obs->pdu->actual_token)) {
1463 /* count failed notifies and remove when
1464 * COAP_OBS_MAX_FAIL is reached */
1465 obs->fail_cnt++;
1466 if (obs->fail_cnt >= COAP_OBS_MAX_FAIL) {
1467 coap_cancel_all_messages(context, obs->session,
1468 &obs->pdu->actual_token);
1469 coap_delete_observer(resource, session, token);
1470 }
1471 break; /* break loop if observer was found */
1472 }
1473 }
1474}
1475
1476void
1478 coap_session_t *session,
1479 const coap_bin_const_t *token) {
1480
1481 RESOURCES_ITER(context->resources, r) {
1482 coap_remove_failed_observers(context, r, session, token);
1483 }
1484}
1485
1486#endif /* ! COAP_SERVER_SUPPORT */
struct coap_attr_t coap_attr_t
struct coap_resource_t coap_resource_t
void coap_update_io_timer(coap_context_t *context, coap_tick_t delay)
Update when to continue with I/O processing, unless packets come in in the meantime.
Definition coap_io.c:494
Library specific build wrapper for coap_internal.h.
#define COAP_API
@ COAP_RESOURCE
Definition coap_mem.h:48
@ COAP_RESOURCEATTR
Definition coap_mem.h:49
@ COAP_SUBSCRIPTION
Definition coap_mem.h:59
@ COAP_STRING
Definition coap_mem.h:39
void * coap_malloc_type(coap_memory_tag_t type, size_t size)
Allocates a chunk of size bytes and returns a pointer to the newly allocated memory.
void coap_free_type(coap_memory_tag_t type, void *p)
Releases the memory that was allocated by coap_malloc_type().
COAP_DEPRECATED COAP_API int coap_resource_set_dirty(coap_resource_t *r, const coap_string_t *query)
void coap_check_code_lg_xmit(const coap_session_t *session, const coap_pdu_t *request, coap_pdu_t *response, const coap_resource_t *resource, const coap_string_t *query)
The function checks that the code in a newly formed lg_xmit created by coap_add_data_large_response_l...
int coap_get_block_b(const coap_session_t *session, const coap_pdu_t *pdu, coap_option_num_t number, coap_block_b_t *block)
Initializes block from pdu.
Definition coap_block.c:54
void coap_delete_cache_key(coap_cache_key_t *cache_key)
Delete the cache-key.
coap_cache_key_t * coap_cache_derive_key_w_ignore(const coap_session_t *session, const coap_pdu_t *pdu, coap_cache_session_based_t session_based, const uint16_t *ignore_options, size_t ignore_count)
Calculates a cache-key for the given CoAP PDU.
@ COAP_CACHE_IS_SESSION_BASED
Definition coap_cache.h:39
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition coap_time.h:143
#define COAP_TICKS_PER_SECOND
Use ms resolution on POSIX systems.
Definition coap_time.h:158
COAP_API coap_resource_t * coap_get_resource_from_uri_path(coap_context_t *context, coap_str_const_t *uri_path)
Returns the resource identified by the unique string uri_path.
#define COAP_RESOURCE_FLAGS_NOTIFY_NON
Observe Notifications will be sent non-confirmable by default.
coap_resource_t * coap_resource_proxy_uri_init(coap_method_handler_t handler, size_t host_name_count, const char *host_name_list[])
Creates a new resource object for handling proxy URIs.
coap_attr_t * coap_add_attr(coap_resource_t *resource, coap_str_const_t *name, coap_str_const_t *value, int flags)
Registers a new attribute with the given resource.
#define COAP_ATTR_FLAGS_RELEASE_VALUE
coap_print_status_t coap_print_link(const coap_resource_t *resource, unsigned char *buf, size_t *len, size_t *offset)
Writes a description of this resource in link-format to given text buffer.
coap_resource_t * coap_resource_proxy_uri_init2(coap_method_handler_t handler, size_t host_name_count, const char *host_name_list[], int flags)
Creates a new resource object for handling proxy URIs with configurable control over multicast reques...
#define COAP_RESOURCE_FLAGS_NOTIFY_NON_ALWAYS
Observe Notifications will always be sent non-confirmable.
#define COAP_RESOURCE_HANDLE_WELLKNOWN_CORE
Define this when invoking coap_resource_unknown_init2() if .well-known/core is to be passed to the un...
#define COAP_ATTR_FLAGS_RELEASE_NAME
void coap_resource_set_mode(coap_resource_t *resource, int mode)
Sets the notification message type of resource resource to given mode.
#define COAP_RESOURCE_SAFE_REQUEST_HANDLER
Don't lock this resource when calling app call-back handler for requests as handler will not be manip...
#define COAP_PRINT_STATUS_TRUNC
void(* coap_method_handler_t)(coap_resource_t *resource, coap_session_t *session, const coap_pdu_t *request, const coap_string_t *query, coap_pdu_t *response)
Definition of message handler function.
void coap_resource_release_userdata_handler(coap_context_t *context, coap_resource_release_userdata_handler_t callback)
Defines the context wide callback to use to when the resource is deleted to release the data held in ...
#define COAP_RESOURCE_FLAGS_OSCORE_ONLY
Define this resource as an OSCORE enabled access only.
COAP_API coap_print_status_t coap_print_wellknown(coap_context_t *context, unsigned char *buf, size_t *buflen, size_t offset, const coap_string_t *query_filter)
Prints the names of all known resources for context to buf.
#define COAP_RESOURCE_FLAGS_NOTIFY_CON
Observe Notifications will be sent confirmable.
coap_resource_t * coap_resource_reverse_proxy_init(coap_method_handler_t handler, int flags)
Creates a new resource object for the reverse-proxy resource handler with control over multicast requ...
COAP_API int coap_delete_resource(coap_context_t *context, coap_resource_t *resource)
Deletes a resource identified by resource.
void coap_register_handler(coap_resource_t *resource, coap_request_t method, coap_method_handler_t handler)
Registers the specified handler as message handler for the request type method.
#define COAP_PRINT_STATUS_MAX
void(* coap_resource_release_userdata_handler_t)(void *user_data)
Definition of release resource user_data callback function.
void coap_register_request_handler(coap_resource_t *resource, coap_request_t method, coap_method_handler_t handler)
Registers the specified handler as message handler for the request type method.
coap_resource_t * coap_resource_init(coap_str_const_t *uri_path, int flags)
Creates a new resource object and initializes the link field to the string uri_path.
void coap_resource_set_userdata(coap_resource_t *resource, void *data)
Sets the user_data.
uint32_t coap_print_status_t
Status word to encode the result of conditional print or copy operations such as coap_print_link().
#define COAP_PRINT_STATUS_ERROR
coap_str_const_t * coap_resource_get_uri_path(coap_resource_t *resource)
Get the uri_path from a resource.
coap_resource_t * coap_resource_unknown_init2(coap_method_handler_t put_handler, int flags)
Creates a new resource object for the unknown resource handler with support for PUT and configurable ...
coap_str_const_t * coap_attr_get_value(coap_attr_t *attribute)
Returns attribute's value.
#define COAP_PRINT_OUTPUT_LENGTH(v)
coap_attr_t * coap_find_attr(coap_resource_t *resource, coap_str_const_t *name)
Returns resource's coap_attr_t object with given name if found, NULL otherwise.
void * coap_resource_get_userdata(coap_resource_t *resource)
Gets the user_data.
COAP_API void coap_add_resource(coap_context_t *context, coap_resource_t *resource)
Registers the given resource for context.
#define COAP_RESOURCE_FLAGS_RELEASE_URI
The URI passed to coap_resource_init() is free'd by coap_delete_resource().
coap_resource_t * coap_resource_unknown_init(coap_method_handler_t put_handler)
Creates a new resource object for the unknown resource handler with support for PUT.
uint16_t coap_new_message_id_lkd(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
coap_mid_t coap_send_internal(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:1677
int coap_check_code_class(coap_session_t *session, coap_pdu_t *pdu)
Check whether the pdu contains a valid code class.
Definition coap_net.c:1292
void coap_cancel_all_messages(coap_context_t *context, coap_session_t *session, coap_bin_const_t *token)
Cancels all outstanding messages for session session that have the specified token.
Definition coap_net.c:2620
void coap_ticks(coap_tick_t *)
Returns the current value of an internal tick counter.
unsigned int coap_encode_var_safe(uint8_t *buf, size_t length, unsigned int val)
Encodes multiple-length byte sequences.
Definition coap_encode.c:47
#define coap_lock_specific_callback_release(lock, func, failed)
Dummy for no thread-safe code.
#define coap_lock_callback_release(c, func, failed)
Dummy for no thread-safe code.
#define coap_lock_unlock(c)
Dummy for no thread-safe code.
#define coap_lock_lock(c, failed)
Dummy for no thread-safe code.
#define coap_lock_init(lock)
Dummy for no thread-safe code.
#define coap_lock_callback(c, func)
Dummy for no thread-safe code.
#define coap_lock_check_locked(c)
Dummy for no thread-safe code.
#define coap_log_debug(...)
Definition coap_debug.h:120
coap_log_t coap_get_log_level(void)
Get the current logging level.
Definition coap_debug.c:95
void coap_show_pdu(coap_log_t level, const coap_pdu_t *pdu)
Display the contents of the specified pdu.
Definition coap_debug.c:778
const char * coap_session_str(const coap_session_t *session)
Get session description.
#define coap_log_warn(...)
Definition coap_debug.h:102
#define coap_log_err(...)
Definition coap_debug.h:96
@ COAP_LOG_DEBUG
Definition coap_debug.h:58
void coap_persist_set_observe_num(coap_resource_t *resource, uint32_t observe_num)
Sets the current observe number value.
void coap_resource_set_get_observable(coap_resource_t *resource, int mode)
Set whether a resource is observable.
COAP_API void coap_check_notify(coap_context_t *context)
Checks all known resources to see if they are dirty and then notifies subscribed observers.
COAP_API int coap_resource_notify_observers(coap_resource_t *resource, const coap_string_t *query)
Initiate the sending of an Observe packet for all observers of resource, optionally matching query if...
size_t oscore_cbor_put_nil(uint8_t **buffer, size_t *buf_size)
Definition oscore_cbor.c:61
size_t oscore_cbor_put_bytes(uint8_t **buffer, size_t *buf_size, const uint8_t *bytes, size_t bytes_len)
size_t oscore_cbor_put_array(uint8_t **buffer, size_t *buf_size, size_t elements)
Definition oscore_cbor.c:96
oscore_association_t * oscore_find_association(coap_session_t *session, coap_bin_const_t *token)
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
Definition coap_pdu.c:188
int coap_remove_option(coap_pdu_t *pdu, coap_option_num_t number)
Removes (first) option of given number from the pdu.
Definition coap_pdu.c:489
coap_pdu_t * coap_pdu_duplicate_lkd(const coap_pdu_t *old_pdu, coap_session_t *session, size_t token_length, const uint8_t *token, coap_opt_filter_t *drop_options)
Duplicate an existing PDU.
Definition coap_pdu.c:228
size_t coap_add_option_internal(coap_pdu_t *pdu, coap_option_num_t number, size_t len, const uint8_t *data)
Adds option of given number to pdu that is passed as first parameter.
Definition coap_pdu.c:781
#define COAP_OPTION_BLOCK2
Definition coap_pdu.h:137
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition coap_pdu.h:263
coap_request_t
CoAP PDU Request methods.
Definition coap_pdu.h:78
#define COAP_RESPONSE_CODE(N)
Definition coap_pdu.h:160
#define COAP_RESPONSE_CLASS(C)
Definition coap_pdu.h:163
#define COAP_OPTION_OSCORE
Definition coap_pdu.h:126
int coap_add_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Adds token of length len to pdu.
Definition coap_pdu.c:356
#define COAP_OPTION_Q_BLOCK2
Definition coap_pdu.h:140
int coap_get_data(const coap_pdu_t *pdu, size_t *len, const uint8_t **data)
Retrieves the length and data pointer of specified PDU.
Definition coap_pdu.c:877
coap_pdu_t * coap_pdu_init(coap_pdu_type_t type, coap_pdu_code_t code, coap_mid_t mid, size_t size)
Creates a new CoAP PDU with at least enough storage space for the given size maximum message size.
Definition coap_pdu.c:99
#define COAP_INVALID_MID
Indicates an invalid message id.
Definition coap_pdu.h:266
#define COAP_OPTION_ETAG
Definition coap_pdu.h:121
#define COAP_OPTION_OBSERVE
Definition coap_pdu.h:123
#define COAP_DEFAULT_URI_WELLKNOWN
well-known resources URI
Definition coap_pdu.h:53
int coap_add_data(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Adds given data to the pdu that is passed as first parameter.
Definition coap_pdu.c:846
@ COAP_REQUEST_PUT
Definition coap_pdu.h:81
@ COAP_REQUEST_DELETE
Definition coap_pdu.h:82
@ COAP_REQUEST_GET
Definition coap_pdu.h:79
@ COAP_REQUEST_FETCH
Definition coap_pdu.h:83
@ COAP_REQUEST_PATCH
Definition coap_pdu.h:84
@ COAP_REQUEST_IPATCH
Definition coap_pdu.h:85
@ COAP_REQUEST_POST
Definition coap_pdu.h:80
@ COAP_PROTO_UDP
Definition coap_pdu.h:315
@ COAP_MESSAGE_NON
Definition coap_pdu.h:70
@ COAP_MESSAGE_CON
Definition coap_pdu.h:69
#define COAP_NSTART(s)
size_t coap_session_max_pdu_size_lkd(const coap_session_t *session)
Get maximum acceptable PDU size.
void coap_session_release_lkd(coap_session_t *session)
Decrement reference counter on a session.
coap_session_t * coap_session_reference_lkd(coap_session_t *session)
Increment reference counter on a session.
#define COAP_PROTO_NOT_RELIABLE(p)
void coap_delete_bin_const(coap_bin_const_t *s)
Deletes the given const binary data and releases any memory allocated.
Definition coap_str.c:121
void coap_delete_str_const(coap_str_const_t *s)
Deletes the given const string and releases any memory allocated.
Definition coap_str.c:61
coap_bin_const_t * coap_new_bin_const(const uint8_t *data, size_t size)
Take the specified byte array (text) and create a coap_bin_const_t * Returns a new const binary objec...
Definition coap_str.c:110
#define coap_binary_equal(binary1, binary2)
Compares the two binary data for equality.
Definition coap_str.h:211
#define coap_string_equal(string1, string2)
Compares the two strings for equality.
Definition coap_str.h:197
coap_str_const_t * coap_new_str_const(const uint8_t *data, size_t size)
Returns a new const string object with at least size+1 bytes storage allocated, and the provided data...
Definition coap_str.c:51
void coap_delete_string(coap_string_t *s)
Deletes the given string and releases any memory allocated.
Definition coap_str.c:46
void coap_check_notify_lkd(coap_context_t *context)
Checks all known resources to see if they are dirty and then notifies subscribed observers.
int coap_delete_observer_request(coap_resource_t *resource, coap_session_t *session, const coap_bin_const_t *token, coap_pdu_t *request)
Removes any subscription for session observer from resource and releases the allocated storage.
int coap_delete_observer(coap_resource_t *resource, coap_session_t *session, const coap_bin_const_t *token)
Removes any subscription for session observer from resource and releases the allocated storage.
coap_subscription_t * coap_find_observer(coap_resource_t *resource, coap_session_t *session, const coap_bin_const_t *token)
Returns a subscription object for given peer.
void coap_delete_observers(coap_context_t *context, coap_session_t *session)
Removes any subscription for session and releases the allocated storage.
void coap_handle_failed_notify(coap_context_t *context, coap_session_t *session, const coap_bin_const_t *token)
Handles a failed observe notify.
int coap_resource_notify_observers_lkd(coap_resource_t *resource, const coap_string_t *query)
Initiate the sending of an Observe packet for all observers of resource, optionally matching query if...
void coap_subscription_init(coap_subscription_t *)
coap_subscription_t * coap_add_observer(coap_resource_t *resource, coap_session_t *session, const coap_bin_const_t *token, const coap_pdu_t *pdu)
Adds the specified peer as observer for resource.
void coap_touch_observer(coap_context_t *context, coap_session_t *session, const coap_bin_const_t *token)
Flags that data is ready to be sent to observers.
coap_string_t * coap_get_query(const coap_pdu_t *request)
Extract query string from request PDU according to escape rules in 6.5.8.
Definition coap_uri.c:957
#define COAP_UNUSED
Definition libcoap.h:70
CoAP binary data definition with const data.
Definition coap_str.h:64
size_t length
length of binary data
Definition coap_str.h:65
const uint8_t * s
read-only binary data
Definition coap_str.h:66
Structure of Block options with BERT support.
Definition coap_block.h:51
unsigned int aszx
block size (0-7 including BERT
Definition coap_block.h:55
unsigned int m
1 if more blocks follow, 0 otherwise
Definition coap_block.h:53
unsigned int szx
block size (0-6)
Definition coap_block.h:54
The CoAP stack's global state is stored in a coap_context_t object.
coap_observe_added_t observe_added
Called when there is a new observe subscription request.
coap_resource_t * resources
hash table or list of known resources
coap_dyn_resource_added_t dyn_resource_added
Callback to save dynamic resource when created.
coap_resource_release_userdata_handler_t release_userdata
function to release user_data when resource is deleted
void * observe_user_data
App provided data for use in observe_added or observe_deleted.
uint8_t observe_pending
Observe response pending.
coap_resource_t * proxy_uri_resource
can be used for handling proxy URI resources
coap_observe_deleted_t observe_deleted
Called when there is a observe subscription de-register request.
coap_resource_t * unknown_resource
can be used for handling unknown resources
coap_address_t bind_addr
local interface address
coap_tick_t last_all_sent
Last time all data sent or 0.
coap_tick_t last_obs
Last time used (Observe tracking) or 0.
structure for CoAP PDUs
uint8_t * token
first byte of token (or extended length bytes prefix), if any, or options
size_t max_size
maximum size for token, options and payload, or zero for variable size pdu
coap_pdu_code_t code
request method (value 1–31) or response code (value 64-255)
uint8_t hdr_size
actual size used for protocol-specific header (0 until header is encoded)
coap_bin_const_t actual_token
Actual token in pdu.
coap_mid_t mid
message id, if any, in regular host byte order
size_t used_size
used bytes of storage for token, options and payload
coap_pdu_type_t type
message type
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
coap_lg_xmit_t * lg_xmit
list of large transmissions
coap_endpoint_t * endpoint
session's endpoint
coap_addr_tuple_t addr_info
remote/local address info
coap_proto_t proto
protocol used
uint8_t con_active
Active CON request sent.
coap_context_t * context
session's context
CoAP string data definition with const data.
Definition coap_str.h:46
const uint8_t * s
read-only string data
Definition coap_str.h:48
size_t length
length of string
Definition coap_str.h:47
CoAP string data definition.
Definition coap_str.h:38
uint8_t * s
string data
Definition coap_str.h:40
size_t length
length of string
Definition coap_str.h:39
Number of notifications that may be sent non-confirmable before a confirmable message is sent to dete...
uint8_t dirty
set if the notification temporarily could not be sent (in that case, the resource's partially dirty f...
uint8_t non_cnt
up to 255 non-confirmable notifies allowed
coap_cache_key_t * cache_key
struct coap_session_t * session
subscriber session
uint8_t fail_cnt
up to 255 confirmable notifies can fail
coap_pdu_t * pdu
cache_key to identify requester
coap_bin_const_t * partial_iv
coap_bin_const_t * aad
coap_bin_const_t * nonce