libcoap 4.3.5-develop-4c7ce99
Loading...
Searching...
No Matches
coap_net.c
Go to the documentation of this file.
1/* coap_net.c -- CoAP context inteface
2 *
3 * Copyright (C) 2010--2025 Olaf Bergmann <bergmann@tzi.org> and others
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
18
19#include <ctype.h>
20#include <stdio.h>
21#ifdef HAVE_LIMITS_H
22#include <limits.h>
23#endif
24#ifdef HAVE_UNISTD_H
25#include <unistd.h>
26#else
27#ifdef HAVE_SYS_UNISTD_H
28#include <sys/unistd.h>
29#endif
30#endif
31#ifdef HAVE_SYS_TYPES_H
32#include <sys/types.h>
33#endif
34#ifdef HAVE_SYS_SOCKET_H
35#include <sys/socket.h>
36#endif
37#ifdef HAVE_SYS_IOCTL_H
38#include <sys/ioctl.h>
39#endif
40#ifdef HAVE_NETINET_IN_H
41#include <netinet/in.h>
42#endif
43#ifdef HAVE_ARPA_INET_H
44#include <arpa/inet.h>
45#endif
46#ifdef HAVE_NET_IF_H
47#include <net/if.h>
48#endif
49#ifdef COAP_EPOLL_SUPPORT
50#include <sys/epoll.h>
51#include <sys/timerfd.h>
52#endif /* COAP_EPOLL_SUPPORT */
53#ifdef HAVE_WS2TCPIP_H
54#include <ws2tcpip.h>
55#endif
56
57#ifdef HAVE_NETDB_H
58#include <netdb.h>
59#endif
60
61#ifdef WITH_LWIP
62#include <lwip/pbuf.h>
63#include <lwip/udp.h>
64#include <lwip/timeouts.h>
65#include <lwip/tcpip.h>
66#endif
67
68#ifndef INET6_ADDRSTRLEN
69#define INET6_ADDRSTRLEN 40
70#endif
71
72#ifndef min
73#define min(a,b) ((a) < (b) ? (a) : (b))
74#endif
75
80#define FRAC_BITS 6
81
86#define MAX_BITS 8
87
88#if FRAC_BITS > 8
89#error FRAC_BITS must be less or equal 8
90#endif
91
93#define Q(frac,fval) ((uint16_t)(((1 << (frac)) * fval.integer_part) + \
94 ((1 << (frac)) * fval.fractional_part + 500)/1000))
95
97#define ACK_RANDOM_FACTOR \
98 Q(FRAC_BITS, session->ack_random_factor)
99
101#define ACK_TIMEOUT Q(FRAC_BITS, session->ack_timeout)
102
103#ifndef WITH_LWIP
104
109
114#else /* !WITH_LWIP */
115
116#include <lwip/memp.h>
117
120 return (coap_queue_t *)memp_malloc(MEMP_COAP_NODE);
121}
122
125 memp_free(MEMP_COAP_NODE, node);
126}
127#endif /* WITH_LWIP */
128
129unsigned int
131 unsigned int result = 0;
132 coap_tick_diff_t delta = now - ctx->sendqueue_basetime;
133
134 if (ctx->sendqueue) {
135 /* delta < 0 means that the new time stamp is before the old. */
136 if (delta <= 0) {
137 ctx->sendqueue->t -= delta;
138 } else {
139 /* This case is more complex: The time must be advanced forward,
140 * thus possibly leading to timed out elements at the queue's
141 * start. For every element that has timed out, its relative
142 * time is set to zero and the result counter is increased. */
143
144 coap_queue_t *q = ctx->sendqueue;
145 coap_tick_t t = 0;
146 while (q && (t + q->t < (coap_tick_t)delta)) {
147 t += q->t;
148 q->t = 0;
149 result++;
150 q = q->next;
151 }
152
153 /* finally adjust the first element that has not expired */
154 if (q) {
155 q->t = (coap_tick_t)delta - t;
156 }
157 }
158 }
159
160 /* adjust basetime */
161 ctx->sendqueue_basetime += delta;
162
163 return result;
164}
165
166int
168 coap_queue_t *p, *q;
169 if (!queue || !node)
170 return 0;
171
172 /* set queue head if empty */
173 if (!*queue) {
174 *queue = node;
175 return 1;
176 }
177
178 /* replace queue head if PDU's time is less than head's time */
179 q = *queue;
180 if (node->t < q->t) {
181 node->next = q;
182 *queue = node;
183 q->t -= node->t; /* make q->t relative to node->t */
184 return 1;
185 }
186
187 /* search for right place to insert */
188 do {
189 node->t -= q->t; /* make node-> relative to q->t */
190 p = q;
191 q = q->next;
192 } while (q && q->t <= node->t);
193
194 /* insert new item */
195 if (q) {
196 q->t -= node->t; /* make q->t relative to node->t */
197 }
198 node->next = q;
199 p->next = node;
200 return 1;
201}
202
203COAP_API int
205 int ret;
206#if COAP_THREAD_SAFE
207 coap_context_t *context;
208#endif /* COAP_THREAD_SAFE */
209
210 if (!node)
211 return 0;
212 if (!node->session)
213 return coap_delete_node_lkd(node);
214
215#if COAP_THREAD_SAFE
216 /* Keep copy as node will be going away */
217 context = node->session->context;
218 (void)context;
219#endif /* COAP_THREAD_SAFE */
220 coap_lock_lock(context, return 0);
221 ret = coap_delete_node_lkd(node);
222 coap_lock_unlock(context);
223 return ret;
224}
225
226int
228 if (!node)
229 return 0;
230
232 if (node->session) {
233 /*
234 * Need to remove out of context->sendqueue as added in by coap_wait_ack()
235 */
236 if (node->session->context->sendqueue) {
237 LL_DELETE(node->session->context->sendqueue, node);
238 }
240 }
241 coap_free_node(node);
242
243 return 1;
244}
245
246void
248 if (!queue)
249 return;
250
251 coap_delete_all(queue->next);
253}
254
257 coap_queue_t *node;
258 node = coap_malloc_node();
259
260 if (!node) {
261 coap_log_warn("coap_new_node: malloc failed\n");
262 return NULL;
263 }
264
265 memset(node, 0, sizeof(*node));
266 return node;
267}
268
271 if (!context || !context->sendqueue)
272 return NULL;
273
274 return context->sendqueue;
275}
276
279 coap_queue_t *next;
280
281 if (!context || !context->sendqueue)
282 return NULL;
283
284 next = context->sendqueue;
285 context->sendqueue = context->sendqueue->next;
286 if (context->sendqueue) {
287 context->sendqueue->t += next->t;
288 }
289 next->next = NULL;
290 return next;
291}
292
293#if COAP_CLIENT_SUPPORT
294const coap_bin_const_t *
296
297 if (session->psk_key) {
298 return session->psk_key;
299 }
300 if (session->cpsk_setup_data.psk_info.key.length)
301 return &session->cpsk_setup_data.psk_info.key;
302
303 /* Not defined in coap_new_client_session_psk2() */
304 return NULL;
305}
306
307const coap_bin_const_t *
309
310 if (session->psk_identity) {
311 return session->psk_identity;
312 }
314 return &session->cpsk_setup_data.psk_info.identity;
315
316 /* Not defined in coap_new_client_session_psk2() */
317 return NULL;
318}
319#endif /* COAP_CLIENT_SUPPORT */
320
321#if COAP_SERVER_SUPPORT
322const coap_bin_const_t *
324
325 if (session->psk_key)
326 return session->psk_key;
327
329 return &session->context->spsk_setup_data.psk_info.key;
330
331 /* Not defined in coap_context_set_psk2() */
332 return NULL;
333}
334
335const coap_bin_const_t *
337
338 if (session->psk_hint)
339 return session->psk_hint;
340
342 return &session->context->spsk_setup_data.psk_info.hint;
343
344 /* Not defined in coap_context_set_psk2() */
345 return NULL;
346}
347
348COAP_API int
350 const char *hint,
351 const uint8_t *key,
352 size_t key_len) {
353 int ret;
354
355 coap_lock_lock(ctx, return 0);
356 ret = coap_context_set_psk_lkd(ctx, hint, key, key_len);
357 coap_lock_unlock(ctx);
358 return ret;
359}
360
361int
363 const char *hint,
364 const uint8_t *key,
365 size_t key_len) {
366 coap_dtls_spsk_t setup_data;
367
369 memset(&setup_data, 0, sizeof(setup_data));
370 if (hint) {
371 setup_data.psk_info.hint.s = (const uint8_t *)hint;
372 setup_data.psk_info.hint.length = strlen(hint);
373 }
374
375 if (key && key_len > 0) {
376 setup_data.psk_info.key.s = key;
377 setup_data.psk_info.key.length = key_len;
378 }
379
380 return coap_context_set_psk2_lkd(ctx, &setup_data);
381}
382
383COAP_API int
385 int ret;
386
387 coap_lock_lock(ctx, return 0);
388 ret = coap_context_set_psk2_lkd(ctx, setup_data);
389 coap_lock_unlock(ctx);
390 return ret;
391}
392
393int
395 if (!setup_data)
396 return 0;
397
399 ctx->spsk_setup_data = *setup_data;
400
402 return coap_dtls_context_set_spsk(ctx, setup_data);
403 }
404 return 0;
405}
406
407COAP_API int
409 const coap_dtls_pki_t *setup_data) {
410 int ret;
411
412 coap_lock_lock(ctx, return 0);
413 ret = coap_context_set_pki_lkd(ctx, setup_data);
414 coap_lock_unlock(ctx);
415 return ret;
416}
417
418int
420 const coap_dtls_pki_t *setup_data) {
422 if (!setup_data)
423 return 0;
424 if (setup_data->version != COAP_DTLS_PKI_SETUP_VERSION) {
425 coap_log_err("coap_context_set_pki: Wrong version of setup_data\n");
426 return 0;
427 }
429 return coap_dtls_context_set_pki(ctx, setup_data, COAP_DTLS_ROLE_SERVER);
430 }
431 return 0;
432}
433#endif /* ! COAP_SERVER_SUPPORT */
434
435COAP_API int
437 const char *ca_file,
438 const char *ca_dir) {
439 int ret;
440
441 coap_lock_lock(ctx, return 0);
442 ret = coap_context_set_pki_root_cas_lkd(ctx, ca_file, ca_dir);
443 coap_lock_unlock(ctx);
444 return ret;
445}
446
447int
449 const char *ca_file,
450 const char *ca_dir) {
452 return coap_dtls_context_set_pki_root_cas(ctx, ca_file, ca_dir);
453 }
454 return 0;
455}
456
457void
458coap_context_set_keepalive(coap_context_t *context, unsigned int seconds) {
459 context->ping_timeout = seconds;
460}
461
462int
464#if COAP_CLIENT_SUPPORT
465 return coap_dtls_set_cid_tuple_change(context, every);
466#else /* ! COAP_CLIENT_SUPPORT */
467 (void)context;
468 (void)every;
469 return 0;
470#endif /* ! COAP_CLIENT_SUPPORT */
471}
472
473void
475 size_t max_token_size) {
476 assert(max_token_size >= COAP_TOKEN_DEFAULT_MAX &&
477 max_token_size <= COAP_TOKEN_EXT_MAX);
478 context->max_token_size = (uint32_t)max_token_size;
479}
480
481void
483 unsigned int max_idle_sessions) {
484 context->max_idle_sessions = max_idle_sessions;
485}
486
487unsigned int
489 return context->max_idle_sessions;
490}
491
492void
494 unsigned int max_handshake_sessions) {
495 context->max_handshake_sessions = max_handshake_sessions;
496}
497
498unsigned int
502
503static unsigned int s_csm_timeout = 30;
504
505void
507 unsigned int csm_timeout) {
508 s_csm_timeout = csm_timeout;
509 coap_context_set_csm_timeout_ms(context, csm_timeout * 1000);
510}
511
512unsigned int
514 (void)context;
515 return s_csm_timeout;
516}
517
518void
520 unsigned int csm_timeout_ms) {
521 if (csm_timeout_ms < 10)
522 csm_timeout_ms = 10;
523 if (csm_timeout_ms > 10000)
524 csm_timeout_ms = 10000;
525 context->csm_timeout_ms = csm_timeout_ms;
526}
527
528unsigned int
530 return context->csm_timeout_ms;
531}
532
533void
535 uint32_t csm_max_message_size) {
536 assert(csm_max_message_size >= 64);
537 context->csm_max_message_size = csm_max_message_size;
538}
539
540uint32_t
544
545void
547 unsigned int session_timeout) {
548 context->session_timeout = session_timeout;
549}
550
551unsigned int
553 return context->session_timeout;
554}
555
556int
558#ifdef COAP_EPOLL_SUPPORT
559 return context->epfd;
560#else /* ! COAP_EPOLL_SUPPORT */
561 (void)context;
562 return -1;
563#endif /* ! COAP_EPOLL_SUPPORT */
564}
565
566int
568#ifdef COAP_EPOLL_SUPPORT
569 return 1;
570#else /* ! COAP_EPOLL_SUPPORT */
571 return 0;
572#endif /* ! COAP_EPOLL_SUPPORT */
573}
574
575int
577#ifdef COAP_THREAD_SAFE
578 return 1;
579#else /* ! COAP_THREAD_SAFE */
580 return 0;
581#endif /* ! COAP_THREAD_SAFE */
582}
583
584int
586#ifdef COAP_IPV4_SUPPORT
587 return 1;
588#else /* ! COAP_IPV4_SUPPORT */
589 return 0;
590#endif /* ! COAP_IPV4_SUPPORT */
591}
592
593int
595#ifdef COAP_IPV6_SUPPORT
596 return 1;
597#else /* ! COAP_IPV6_SUPPORT */
598 return 0;
599#endif /* ! COAP_IPV6_SUPPORT */
600}
601
602int
604#ifdef COAP_CLIENT_SUPPORT
605 return 1;
606#else /* ! COAP_CLIENT_SUPPORT */
607 return 0;
608#endif /* ! COAP_CLIENT_SUPPORT */
609}
610
611int
613#ifdef COAP_SERVER_SUPPORT
614 return 1;
615#else /* ! COAP_SERVER_SUPPORT */
616 return 0;
617#endif /* ! COAP_SERVER_SUPPORT */
618}
619
620int
622#ifdef COAP_AF_UNIX_SUPPORT
623 return 1;
624#else /* ! COAP_AF_UNIX_SUPPORT */
625 return 0;
626#endif /* ! COAP_AF_UNIX_SUPPORT */
627}
628
629void
630coap_context_set_app_data(coap_context_t *context, void *app_data) {
631 assert(context);
632 context->app = app_data;
633}
634
635void *
637 assert(context);
638 return context->app;
639}
640
642coap_new_context(const coap_address_t *listen_addr) {
644
645#if ! COAP_SERVER_SUPPORT
646 (void)listen_addr;
647#endif /* COAP_SERVER_SUPPORT */
648
649 if (!coap_started) {
650 coap_startup();
651 coap_log_warn("coap_startup() should be called before any other "
652 "coap_*() functions are called\n");
653 }
654
656 if (!c) {
657 coap_log_emerg("coap_init: malloc: failed\n");
658 return NULL;
659 }
660 memset(c, 0, sizeof(coap_context_t));
661
662 coap_lock_lock(c, coap_free_type(COAP_CONTEXT, c); return NULL);
663#ifdef COAP_EPOLL_SUPPORT
664 c->epfd = epoll_create1(0);
665 if (c->epfd == -1) {
666 coap_log_err("coap_new_context: Unable to epoll_create: %s (%d)\n",
668 errno);
669 goto onerror;
670 }
671 if (c->epfd != -1) {
672 c->eptimerfd = timerfd_create(CLOCK_REALTIME, TFD_NONBLOCK);
673 if (c->eptimerfd == -1) {
674 coap_log_err("coap_new_context: Unable to timerfd_create: %s (%d)\n",
676 errno);
677 goto onerror;
678 } else {
679 int ret;
680 struct epoll_event event;
681
682 /* Needed if running 32bit as ptr is only 32bit */
683 memset(&event, 0, sizeof(event));
684 event.events = EPOLLIN;
685 /* We special case this event by setting to NULL */
686 event.data.ptr = NULL;
687
688 ret = epoll_ctl(c->epfd, EPOLL_CTL_ADD, c->eptimerfd, &event);
689 if (ret == -1) {
690 coap_log_err("%s: epoll_ctl ADD failed: %s (%d)\n",
691 "coap_new_context",
692 coap_socket_strerror(), errno);
693 goto onerror;
694 }
695 }
696 }
697#endif /* COAP_EPOLL_SUPPORT */
698
701 if (!c->dtls_context) {
702 coap_log_emerg("coap_init: no DTLS context available\n");
704 return NULL;
705 }
706 }
707
708 /* set default CSM values */
709 c->csm_timeout_ms = 1000;
710 c->csm_max_message_size = COAP_DEFAULT_MAX_PDU_RX_SIZE;
711
712#if COAP_SERVER_SUPPORT
713 if (listen_addr) {
714 coap_endpoint_t *endpoint = coap_new_endpoint_lkd(c, listen_addr, COAP_PROTO_UDP);
715 if (endpoint == NULL) {
716 goto onerror;
717 }
718 }
719#endif /* COAP_SERVER_SUPPORT */
720
721 c->max_token_size = COAP_TOKEN_DEFAULT_MAX; /* RFC8974 */
722
724 return c;
725
726#if defined(COAP_EPOLL_SUPPORT) || COAP_SERVER_SUPPORT
727onerror:
729 return NULL;
730#endif /* COAP_EPOLL_SUPPORT || COAP_SERVER_SUPPORT */
731}
732
733void
734coap_set_app_data(coap_context_t *ctx, void *app_data) {
735 assert(ctx);
736 ctx->app = app_data;
737}
738
739void *
741 assert(ctx);
742 return ctx->app;
743}
744
745COAP_API void
747 if (!context)
748 return;
749 coap_lock_lock(context, return);
750 coap_free_context_lkd(context);
751 coap_lock_unlock(context);
752}
753
754void
756 if (!context)
757 return;
758
759 coap_lock_check_locked(context);
760#if COAP_SERVER_SUPPORT
761 /* Removing a resource may cause a NON unsolicited observe to be sent */
763#endif /* COAP_SERVER_SUPPORT */
764
765 coap_delete_all(context->sendqueue);
766 context->sendqueue = NULL;
767
768#ifdef WITH_LWIP
769 if (context->timer_configured) {
770 LOCK_TCPIP_CORE();
771 sys_untimeout(coap_io_process_timeout, (void *)context);
772 UNLOCK_TCPIP_CORE();
773 context->timer_configured = 0;
774 }
775#endif /* WITH_LWIP */
776
777#if COAP_ASYNC_SUPPORT
778 coap_delete_all_async(context);
779#endif /* COAP_ASYNC_SUPPORT */
780
781#if COAP_OSCORE_SUPPORT
782 coap_delete_all_oscore(context);
783#endif /* COAP_OSCORE_SUPPORT */
784
785#if COAP_SERVER_SUPPORT
786 coap_cache_entry_t *cp, *ctmp;
787
788 HASH_ITER(hh, context->cache, cp, ctmp) {
789 coap_delete_cache_entry(context, cp);
790 }
791 if (context->cache_ignore_count) {
793 }
794
795 coap_endpoint_t *ep, *tmp;
796
797 LL_FOREACH_SAFE(context->endpoint, ep, tmp) {
799 }
800#endif /* COAP_SERVER_SUPPORT */
801
802#if COAP_CLIENT_SUPPORT
803 coap_session_t *sp, *rtmp;
804
805 SESSIONS_ITER_SAFE(context->sessions, sp, rtmp) {
807 }
808#endif /* COAP_CLIENT_SUPPORT */
809
810 if (context->dtls_context)
812#ifdef COAP_EPOLL_SUPPORT
813 if (context->eptimerfd != -1) {
814 int ret;
815 struct epoll_event event;
816
817 /* Kernels prior to 2.6.9 expect non NULL event parameter */
818 ret = epoll_ctl(context->epfd, EPOLL_CTL_DEL, context->eptimerfd, &event);
819 if (ret == -1) {
820 coap_log_err("%s: epoll_ctl DEL failed: %s (%d)\n",
821 "coap_free_context",
822 coap_socket_strerror(), errno);
823 }
824 close(context->eptimerfd);
825 context->eptimerfd = -1;
826 }
827 if (context->epfd != -1) {
828 close(context->epfd);
829 context->epfd = -1;
830 }
831#endif /* COAP_EPOLL_SUPPORT */
832#if COAP_SERVER_SUPPORT
833#if COAP_WITH_OBSERVE_PERSIST
834 coap_persist_cleanup(context);
835#endif /* COAP_WITH_OBSERVE_PERSIST */
836#endif /* COAP_SERVER_SUPPORT */
837#if COAP_PROXY_SUPPORT
838 coap_proxy_cleanup(context);
839#endif /* COAP_PROXY_SUPPORT */
840
843}
844
845int
847 coap_pdu_t *pdu,
848 coap_opt_filter_t *unknown) {
849 coap_context_t *ctx = session->context;
850 coap_opt_iterator_t opt_iter;
851 int ok = 1;
852 coap_option_num_t last_number = -1;
853
855
856 while (coap_option_next(&opt_iter)) {
857 if (opt_iter.number & 0x01) {
858 /* first check the known built-in critical options */
859 switch (opt_iter.number) {
860#if COAP_Q_BLOCK_SUPPORT
863 if (!(ctx->block_mode & COAP_BLOCK_TRY_Q_BLOCK)) {
864 coap_log_debug("disabled support for critical option %u\n",
865 opt_iter.number);
866 ok = 0;
867 coap_option_filter_set(unknown, opt_iter.number);
868 }
869 break;
870#endif /* COAP_Q_BLOCK_SUPPORT */
882 break;
884 /* Valid critical if doing OSCORE */
885#if COAP_OSCORE_SUPPORT
886 if (ctx->p_osc_ctx)
887 break;
888#endif /* COAP_OSCORE_SUPPORT */
889 /* Fall Through */
890 default:
891 if (coap_option_filter_get(&ctx->known_options, opt_iter.number) <= 0) {
892#if COAP_SERVER_SUPPORT
893 if ((opt_iter.number & 0x02) == 0) {
894 coap_opt_iterator_t t_iter;
895
896 /* Safe to forward - check if proxy pdu */
897 if (session->proxy_session)
898 break;
899 if (COAP_PDU_IS_REQUEST(pdu) && ctx->proxy_uri_resource &&
902 pdu->crit_opt = 1;
903 break;
904 }
905 }
906#endif /* COAP_SERVER_SUPPORT */
907 coap_log_debug("unknown critical option %d\n", opt_iter.number);
908 ok = 0;
909
910 /* When opt_iter.number cannot be set in unknown, all of the appropriate
911 * slots have been used up and no more options can be tracked.
912 * Safe to break out of this loop as ok is already set. */
913 if (coap_option_filter_set(unknown, opt_iter.number) == 0) {
914 break;
915 }
916 }
917 }
918 }
919 if (last_number == opt_iter.number) {
920 /* Check for duplicated option RFC 5272 5.4.5 */
921 if (!coap_option_check_repeatable(opt_iter.number)) {
922 ok = 0;
923 if (coap_option_filter_set(unknown, opt_iter.number) == 0) {
924 break;
925 }
926 }
927 } else if (opt_iter.number == COAP_OPTION_BLOCK2 &&
928 COAP_PDU_IS_REQUEST(pdu)) {
929 /* Check the M Bit is not set on a GET request RFC 7959 2.2 */
930 coap_block_b_t block;
931
932 if (coap_get_block_b(session, pdu, opt_iter.number, &block)) {
933 if (block.m) {
934 size_t used_size = pdu->used_size;
935 unsigned char buf[4];
936
937 coap_log_debug("Option Block2 has invalid set M bit - cleared\n");
938 block.m = 0;
939 coap_update_option(pdu, opt_iter.number,
940 coap_encode_var_safe(buf, sizeof(buf),
941 ((block.num << 4) |
942 (block.m << 3) |
943 block.aszx)),
944 buf);
945 if (used_size != pdu->used_size) {
946 /* Unfortunately need to restart the scan */
948 last_number = -1;
949 continue;
950 }
951 }
952 }
953 }
954 last_number = opt_iter.number;
955 }
956
957 return ok;
958}
959
961coap_send_rst(coap_session_t *session, const coap_pdu_t *request) {
962 coap_mid_t mid;
963
964 coap_lock_lock(session->context, return COAP_INVALID_MID);
965 mid = coap_send_rst_lkd(session, request);
966 coap_lock_unlock(session->context);
967 return mid;
968}
969
971coap_send_rst_lkd(coap_session_t *session, const coap_pdu_t *request) {
972 return coap_send_message_type_lkd(session, request, COAP_MESSAGE_RST);
973}
974
976coap_send_ack(coap_session_t *session, const coap_pdu_t *request) {
977 coap_mid_t mid;
978
979 coap_lock_lock(session->context, return COAP_INVALID_MID);
980 mid = coap_send_ack_lkd(session, request);
981 coap_lock_unlock(session->context);
982 return mid;
983}
984
986coap_send_ack_lkd(coap_session_t *session, const coap_pdu_t *request) {
987 coap_pdu_t *response;
989
991 if (request && request->type == COAP_MESSAGE_CON &&
992 COAP_PROTO_NOT_RELIABLE(session->proto)) {
993 response = coap_pdu_init(COAP_MESSAGE_ACK, 0, request->mid, 0);
994 if (response)
995 result = coap_send_internal(session, response, NULL);
996 }
997 return result;
998}
999
1000ssize_t
1002 ssize_t bytes_written = -1;
1003 assert(pdu->hdr_size > 0);
1004
1005 /* Caller handles partial writes */
1006 bytes_written = session->sock.lfunc[COAP_LAYER_SESSION].l_write(session,
1007 pdu->token - pdu->hdr_size,
1008 pdu->used_size + pdu->hdr_size);
1010 return bytes_written;
1011}
1012
1013static ssize_t
1015 ssize_t bytes_written;
1016
1017 if (session->state == COAP_SESSION_STATE_NONE) {
1018#if ! COAP_CLIENT_SUPPORT
1019 return -1;
1020#else /* COAP_CLIENT_SUPPORT */
1021 if (session->type != COAP_SESSION_TYPE_CLIENT)
1022 return -1;
1023#endif /* COAP_CLIENT_SUPPORT */
1024 }
1025
1026 if (pdu->type == COAP_MESSAGE_CON &&
1027 (session->sock.flags & COAP_SOCKET_NOT_EMPTY) &&
1028 (session->sock.flags & COAP_SOCKET_MULTICAST)) {
1029 /* Violates RFC72522 8.1 */
1030 coap_log_err("Multicast requests cannot be Confirmable (RFC7252 8.1)\n");
1031 return -1;
1032 }
1033
1034 if (session->state != COAP_SESSION_STATE_ESTABLISHED ||
1035 (pdu->type == COAP_MESSAGE_CON &&
1036 session->con_active >= COAP_NSTART(session))) {
1037 return coap_session_delay_pdu(session, pdu, node);
1038 }
1039
1040 if ((session->sock.flags & COAP_SOCKET_NOT_EMPTY) &&
1041 (session->sock.flags & COAP_SOCKET_WANT_WRITE))
1042 return coap_session_delay_pdu(session, pdu, node);
1043
1044 bytes_written = coap_session_send_pdu(session, pdu);
1045 if (bytes_written >= 0 && pdu->type == COAP_MESSAGE_CON &&
1047 session->con_active++;
1048
1049 return bytes_written;
1050}
1051
1054 const coap_pdu_t *request,
1055 coap_pdu_code_t code,
1056 coap_opt_filter_t *opts) {
1057 coap_mid_t mid;
1058
1059 coap_lock_lock(session->context, return COAP_INVALID_MID);
1060 mid = coap_send_error_lkd(session, request, code, opts);
1061 coap_lock_unlock(session->context);
1062 return mid;
1063}
1064
1067 const coap_pdu_t *request,
1068 coap_pdu_code_t code,
1069 coap_opt_filter_t *opts) {
1070 coap_pdu_t *response;
1072
1073 assert(request);
1074 assert(session);
1075
1076 response = coap_new_error_response(request, code, opts);
1077 if (response)
1078 result = coap_send_internal(session, response, NULL);
1079
1080 return result;
1081}
1082
1085 coap_pdu_type_t type) {
1086 coap_mid_t mid;
1087
1088 coap_lock_lock(session->context, return COAP_INVALID_MID);
1089 mid = coap_send_message_type_lkd(session, request, type);
1090 coap_lock_unlock(session->context);
1091 return mid;
1092}
1093
1096 coap_pdu_type_t type) {
1097 coap_pdu_t *response;
1099
1101 if (request && COAP_PROTO_NOT_RELIABLE(session->proto)) {
1102 response = coap_pdu_init(type, 0, request->mid, 0);
1103 if (response)
1104 result = coap_send_internal(session, response, NULL);
1105 }
1106 return result;
1107}
1108
1122unsigned int
1123coap_calc_timeout(coap_session_t *session, unsigned char r) {
1124 unsigned int result;
1125
1126 /* The integer 1.0 as a Qx.FRAC_BITS */
1127#define FP1 Q(FRAC_BITS, ((coap_fixed_point_t){1,0}))
1128
1129 /* rounds val up and right shifts by frac positions */
1130#define SHR_FP(val,frac) (((val) + (1 << ((frac) - 1))) >> (frac))
1131
1132 /* Inner term: multiply ACK_RANDOM_FACTOR by Q0.MAX_BITS[r] and
1133 * make the result a rounded Qx.FRAC_BITS */
1134 result = SHR_FP((ACK_RANDOM_FACTOR - FP1) * r, MAX_BITS);
1135
1136 /* Add 1 to the inner term and multiply with ACK_TIMEOUT, then
1137 * make the result a rounded Qx.FRAC_BITS */
1138 result = SHR_FP(((result + FP1) * ACK_TIMEOUT), FRAC_BITS);
1139
1140 /* Multiply with COAP_TICKS_PER_SECOND to yield system ticks
1141 * (yields a Qx.FRAC_BITS) and shift to get an integer */
1142 return SHR_FP((COAP_TICKS_PER_SECOND * result), FRAC_BITS);
1143
1144#undef FP1
1145#undef SHR_FP
1146}
1147
1150 coap_queue_t *node) {
1151 coap_tick_t now;
1152
1153 node->session = coap_session_reference_lkd(session);
1154
1155 /* Set timer for pdu retransmission. If this is the first element in
1156 * the retransmission queue, the base time is set to the current
1157 * time and the retransmission time is node->timeout. If there is
1158 * already an entry in the sendqueue, we must check if this node is
1159 * to be retransmitted earlier. Therefore, node->timeout is first
1160 * normalized to the base time and then inserted into the queue with
1161 * an adjusted relative time.
1162 */
1163 coap_ticks(&now);
1164 if (context->sendqueue == NULL) {
1165 node->t = node->timeout << node->retransmit_cnt;
1166 context->sendqueue_basetime = now;
1167 } else {
1168 /* make node->t relative to context->sendqueue_basetime */
1169 node->t = (now - context->sendqueue_basetime) +
1170 (node->timeout << node->retransmit_cnt);
1171 }
1172
1173 coap_insert_node(&context->sendqueue, node);
1174
1175 coap_log_debug("** %s: mid=0x%04x: added to retransmit queue (%ums)\n",
1176 coap_session_str(node->session), node->id,
1177 (unsigned)((node->timeout << node->retransmit_cnt) * 1000 /
1179
1180 coap_update_io_timer(context, node->t);
1181
1182 return node->id;
1183}
1184
1185#if COAP_CLIENT_SUPPORT
1186/*
1187 * Sent out a test PDU for Extended Token
1188 */
1189static coap_mid_t
1190coap_send_test_extended_token(coap_session_t *session) {
1191 coap_pdu_t *pdu;
1193 size_t i;
1194 coap_binary_t *token;
1195
1196 coap_log_debug("Testing for Extended Token support\n");
1197 /* https://rfc-editor.org/rfc/rfc8974#section-2.2.2 */
1199 coap_new_message_id_lkd(session),
1201 if (!pdu)
1202 return COAP_INVALID_MID;
1203
1204 token = coap_new_binary(session->max_token_size);
1205 if (token == NULL) {
1207 return COAP_INVALID_MID;
1208 }
1209 for (i = 0; i < session->max_token_size; i++) {
1210 token->s[i] = (uint8_t)(i + 1);
1211 }
1212 coap_add_token(pdu, session->max_token_size, token->s);
1213 coap_delete_binary(token);
1214
1216
1217 session->max_token_checked = COAP_EXT_T_CHECKING; /* Checking out this one */
1218 if ((mid = coap_send_internal(session, pdu, NULL)) == COAP_INVALID_MID)
1219 return COAP_INVALID_MID;
1220 session->remote_test_mid = mid;
1221 return mid;
1222}
1223#endif /* COAP_CLIENT_SUPPORT */
1224
1225int
1227#if COAP_CLIENT_SUPPORT
1228 if (session->type == COAP_SESSION_TYPE_CLIENT && session->doing_first) {
1229 int timeout_ms = 5000;
1230 coap_session_state_t current_state = session->state;
1231
1232 if (session->delay_recursive) {
1233 return 0;
1234 } else {
1235 session->delay_recursive = 1;
1236 }
1237 /*
1238 * Need to wait for first request to get out and response back before
1239 * continuing.. Response handler has to clear doing_first if not an error.
1240 */
1242 while (session->doing_first != 0) {
1243 int result = coap_io_process_lkd(session->context, 1000);
1244
1245 if (result < 0) {
1246 session->doing_first = 0;
1247 session->delay_recursive = 0;
1248 coap_session_release_lkd(session);
1249 return 0;
1250 }
1251
1252 /* coap_io_process_lkd() may have updated session state */
1253 if (session->state == COAP_SESSION_STATE_CSM &&
1254 current_state != COAP_SESSION_STATE_CSM) {
1255 /* Update timeout and restart the clock for CSM timeout */
1256 current_state = COAP_SESSION_STATE_CSM;
1257 timeout_ms = session->context->csm_timeout_ms;
1258 result = 0;
1259 }
1260
1261 if (result < timeout_ms) {
1262 timeout_ms -= result;
1263 } else {
1264 if (session->doing_first == 1) {
1265 /* Timeout failure of some sort with first request */
1266 session->doing_first = 0;
1267 if (session->state == COAP_SESSION_STATE_CSM) {
1268 coap_log_debug("** %s: timeout waiting for CSM response\n",
1269 coap_session_str(session));
1270 session->csm_not_seen = 1;
1271 coap_session_connected(session);
1272 } else {
1273 coap_log_debug("** %s: timeout waiting for first response\n",
1274 coap_session_str(session));
1275 }
1276 }
1277 }
1278 }
1279 session->delay_recursive = 0;
1280 coap_session_release_lkd(session);
1281 }
1282#else /* ! COAP_CLIENT_SUPPORT */
1283 (void)session;
1284#endif /* ! COAP_CLIENT_SUPPORT */
1285 return 1;
1286}
1287
1288/*
1289 * return 0 Invalid
1290 * 1 Valid
1291 */
1292int
1294
1295 /* Check validity of sending code */
1296 switch (COAP_RESPONSE_CLASS(pdu->code)) {
1297 case 0: /* Empty or request */
1298 case 2: /* Success */
1299 case 3: /* Reserved for future use */
1300 case 4: /* Client error */
1301 case 5: /* Server error */
1302 break;
1303 case 7: /* Reliable signalling */
1304 if (COAP_PROTO_RELIABLE(session->proto))
1305 break;
1306 /* Not valid if UDP */
1307 /* Fall through */
1308 case 1: /* Invalid */
1309 case 6: /* Invalid */
1310 default:
1311 return 0;
1312 }
1313 return 1;
1314}
1315
1316#if COAP_CLIENT_SUPPORT
1317/*
1318 * If type is CON and protocol is not reliable, there is no need to set up
1319 * lg_crcv if it can be built up based on sent PDU if there is a
1320 * (Q-)Block2 in the response. However, still need it for Observe, Oscore and
1321 * (Q-)Block1.
1322 */
1323static int
1324coap_check_send_need_lg_crcv(coap_session_t *session, coap_pdu_t *pdu) {
1325 coap_opt_iterator_t opt_iter;
1326
1327 if (
1328#if COAP_OSCORE_SUPPORT
1329 session->oscore_encryption ||
1330#endif /* COAP_OSCORE_SUPPORT */
1331 ((pdu->type == COAP_MESSAGE_NON || COAP_PROTO_RELIABLE(session->proto)) &&
1333 coap_check_option(pdu, COAP_OPTION_OBSERVE, &opt_iter) ||
1334#if COAP_Q_BLOCK_SUPPORT
1335 coap_check_option(pdu, COAP_OPTION_Q_BLOCK1, &opt_iter) ||
1336#endif /* COAP_Q_BLOCK_SUPPORT */
1337 coap_check_option(pdu, COAP_OPTION_BLOCK1, &opt_iter)) {
1338 return 1;
1339 }
1340 return 0;
1341}
1342#endif /* COAP_CLIENT_SUPPORT */
1343
1346 coap_mid_t mid;
1347
1348 coap_lock_lock(session->context, return COAP_INVALID_MID);
1349 mid = coap_send_lkd(session, pdu);
1350 coap_lock_unlock(session->context);
1351 return mid;
1352}
1353
1357#if COAP_CLIENT_SUPPORT
1358 coap_lg_crcv_t *lg_crcv = NULL;
1359 coap_opt_iterator_t opt_iter;
1360 coap_block_b_t block;
1361 int observe_action = -1;
1362 int have_block1 = 0;
1363 coap_opt_t *opt;
1364#endif /* COAP_CLIENT_SUPPORT */
1365
1366 assert(pdu);
1367
1369
1370 /* Check validity of sending code */
1371 if (!coap_check_code_class(session, pdu)) {
1372 coap_log_err("coap_send: Invalid PDU code (%d.%02d)\n",
1374 pdu->code & 0x1f);
1375 goto error;
1376 }
1377 pdu->session = session;
1378#if COAP_CLIENT_SUPPORT
1379 if (session->type == COAP_SESSION_TYPE_CLIENT &&
1380 !coap_netif_available(session)) {
1381 coap_log_debug("coap_send: Socket closed\n");
1382 goto error;
1383 }
1384 /*
1385 * If this is not the first client request and are waiting for a response
1386 * to the first client request, then drop sending out this next request
1387 * until all is properly established.
1388 */
1389 if (!coap_client_delay_first(session)) {
1390 goto error;
1391 }
1392
1393 /* Indicate support for Extended Tokens if appropriate */
1394 if (session->max_token_checked == COAP_EXT_T_NOT_CHECKED &&
1396 session->type == COAP_SESSION_TYPE_CLIENT &&
1397 COAP_PDU_IS_REQUEST(pdu)) {
1398 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1399 /*
1400 * When the pass / fail response for Extended Token is received, this PDU
1401 * will get transmitted.
1402 */
1403 if (coap_send_test_extended_token(session) == COAP_INVALID_MID) {
1404 goto error;
1405 }
1406 }
1407 /*
1408 * For reliable protocols, this will get cleared after CSM exchanged
1409 * in coap_session_connected()
1410 */
1411 session->doing_first = 1;
1412 if (!coap_client_delay_first(session)) {
1413 goto error;
1414 }
1415 }
1416
1417 /*
1418 * Check validity of token length
1419 */
1420 if (COAP_PDU_IS_REQUEST(pdu) &&
1421 pdu->actual_token.length > session->max_token_size) {
1422 coap_log_warn("coap_send: PDU dropped as token too long (%zu > %" PRIu32 ")\n",
1423 pdu->actual_token.length, session->max_token_size);
1424 goto error;
1425 }
1426
1427 /* A lot of the reliable code assumes type is CON */
1428 if (COAP_PROTO_RELIABLE(session->proto) && pdu->type != COAP_MESSAGE_CON)
1429 pdu->type = COAP_MESSAGE_CON;
1430
1431#if COAP_OSCORE_SUPPORT
1432 if (session->oscore_encryption) {
1433 if (session->recipient_ctx->initial_state == 1) {
1434 /*
1435 * Not sure if remote supports OSCORE, or is going to send us a
1436 * "4.01 + ECHO" etc. so need to hold off future coap_send()s until all
1437 * is OK. Continue sending current pdu to test things.
1438 */
1439 session->doing_first = 1;
1440 }
1441 /* Need to convert Proxy-Uri to Proxy-Scheme option if needed */
1443 goto error;
1444 }
1445 }
1446#endif /* COAP_OSCORE_SUPPORT */
1447
1448 if (!(session->block_mode & COAP_BLOCK_USE_LIBCOAP)) {
1449 return coap_send_internal(session, pdu, NULL);
1450 }
1451
1452 if (COAP_PDU_IS_REQUEST(pdu)) {
1453 uint8_t buf[4];
1454
1455 opt = coap_check_option(pdu, COAP_OPTION_OBSERVE, &opt_iter);
1456
1457 if (opt) {
1458 observe_action = coap_decode_var_bytes(coap_opt_value(opt),
1459 coap_opt_length(opt));
1460 }
1461
1462 if (coap_get_block_b(session, pdu, COAP_OPTION_BLOCK1, &block) &&
1463 (block.m == 1 || block.bert == 1)) {
1464 have_block1 = 1;
1465 }
1466#if COAP_Q_BLOCK_SUPPORT
1467 if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK1, &block) &&
1468 (block.m == 1 || block.bert == 1)) {
1469 if (have_block1) {
1470 coap_log_warn("Block1 and Q-Block1 cannot be in the same request\n");
1472 }
1473 have_block1 = 1;
1474 }
1475#endif /* COAP_Q_BLOCK_SUPPORT */
1476 if (observe_action != COAP_OBSERVE_CANCEL) {
1477 /* Warn about re-use of tokens */
1478 if (session->last_token &&
1479 coap_binary_equal(&pdu->actual_token, session->last_token)) {
1480 coap_log_debug("Token reused - see https://rfc-editor.org/rfc/rfc9175.html#section-4.2\n");
1481 }
1484 pdu->actual_token.length);
1485 } else {
1486 /* observe_action == COAP_OBSERVE_CANCEL */
1487 coap_binary_t tmp;
1488 int ret;
1489
1490 coap_log_debug("coap_send: Using coap_cancel_observe() to do OBSERVE cancellation\n");
1491 /* Unfortunately need to change the ptr type to be r/w */
1492 memcpy(&tmp.s, &pdu->actual_token.s, sizeof(tmp.s));
1493 tmp.length = pdu->actual_token.length;
1494 ret = coap_cancel_observe_lkd(session, &tmp, pdu->type);
1495 if (ret == 1) {
1496 /* Observe Cancel successfully sent */
1498 return ret;
1499 }
1500 /* Some mismatch somewhere - continue to send original packet */
1501 }
1502 if (!coap_check_option(pdu, COAP_OPTION_RTAG, &opt_iter) &&
1503 (session->block_mode & COAP_BLOCK_NO_PREEMPTIVE_RTAG) == 0 &&
1507 coap_encode_var_safe(buf, sizeof(buf),
1508 ++session->tx_rtag),
1509 buf);
1510 } else {
1511 memset(&block, 0, sizeof(block));
1512 }
1513
1514#if COAP_Q_BLOCK_SUPPORT
1515 /* Indicate support for Q-Block if appropriate */
1516 if (session->block_mode & COAP_BLOCK_TRY_Q_BLOCK &&
1517 session->type == COAP_SESSION_TYPE_CLIENT &&
1518 COAP_PDU_IS_REQUEST(pdu)) {
1519 if (coap_block_test_q_block(session, pdu) == COAP_INVALID_MID) {
1520 goto error;
1521 }
1522 session->doing_first = 1;
1523 if (!coap_client_delay_first(session)) {
1524 /* Q-Block test Session has failed for some reason */
1525 set_block_mode_drop_q(session->block_mode);
1526 goto error;
1527 }
1528 }
1529#endif /* COAP_Q_BLOCK_SUPPORT */
1530
1531#if COAP_Q_BLOCK_SUPPORT
1532 if (!(session->block_mode & COAP_BLOCK_HAS_Q_BLOCK))
1533#endif /* COAP_Q_BLOCK_SUPPORT */
1534 {
1535 /* Need to check if we need to reset Q-Block to Block */
1536 uint8_t buf[4];
1537
1538 if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK2, &block)) {
1541 coap_encode_var_safe(buf, sizeof(buf),
1542 (block.num << 4) | (0 << 3) | block.szx),
1543 buf);
1544 coap_log_debug("Replaced option Q-Block2 with Block2\n");
1545 /* Need to update associated lg_xmit */
1546 coap_lg_xmit_t *lg_xmit;
1547
1548 LL_FOREACH(session->lg_xmit, lg_xmit) {
1549 if (COAP_PDU_IS_REQUEST(&lg_xmit->pdu) &&
1550 lg_xmit->b.b1.app_token &&
1551 coap_binary_equal(&pdu->actual_token, lg_xmit->b.b1.app_token)) {
1552 /* Update the skeletal PDU with the block1 option */
1555 coap_encode_var_safe(buf, sizeof(buf),
1556 (block.num << 4) | (0 << 3) | block.szx),
1557 buf);
1558 break;
1559 }
1560 }
1561 }
1562 if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK1, &block)) {
1565 coap_encode_var_safe(buf, sizeof(buf),
1566 (block.num << 4) | (block.m << 3) | block.szx),
1567 buf);
1568 coap_log_debug("Replaced option Q-Block1 with Block1\n");
1569 /* Need to update associated lg_xmit */
1570 coap_lg_xmit_t *lg_xmit;
1571
1572 LL_FOREACH(session->lg_xmit, lg_xmit) {
1573 if (COAP_PDU_IS_REQUEST(&lg_xmit->pdu) &&
1574 lg_xmit->b.b1.app_token &&
1575 coap_binary_equal(&pdu->actual_token, lg_xmit->b.b1.app_token)) {
1576 /* Update the skeletal PDU with the block1 option */
1579 coap_encode_var_safe(buf, sizeof(buf),
1580 (block.num << 4) |
1581 (block.m << 3) |
1582 block.szx),
1583 buf);
1584 /* Update as this is a Request */
1585 lg_xmit->option = COAP_OPTION_BLOCK1;
1586 break;
1587 }
1588 }
1589 }
1590 }
1591
1592#if COAP_Q_BLOCK_SUPPORT
1593 if (COAP_PDU_IS_REQUEST(pdu) &&
1594 coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK2, &block)) {
1595 if (block.num == 0 && block.m == 0) {
1596 uint8_t buf[4];
1597
1598 /* M needs to be set as asking for all the blocks */
1600 coap_encode_var_safe(buf, sizeof(buf),
1601 (0 << 4) | (1 << 3) | block.szx),
1602 buf);
1603 }
1604 }
1605#endif /* COAP_Q_BLOCK_SUPPORT */
1606
1607 /*
1608 * If type is CON and protocol is not reliable, there is no need to set up
1609 * lg_crcv here as it can be built up based on sent PDU if there is a
1610 * (Q-)Block2 in the response. However, still need it for Observe, Oscore and
1611 * (Q-)Block1.
1612 */
1613 if (coap_check_send_need_lg_crcv(session, pdu)) {
1614 coap_lg_xmit_t *lg_xmit = NULL;
1615
1616 if (!session->lg_xmit && have_block1) {
1617 coap_log_debug("PDU presented by app\n");
1619 }
1620 /* See if this token is already in use for large body responses */
1621 LL_FOREACH(session->lg_crcv, lg_crcv) {
1622 if (coap_binary_equal(&pdu->actual_token, lg_crcv->app_token)) {
1623 /* Need to terminate and clean up previous response setup */
1624 LL_DELETE(session->lg_crcv, lg_crcv);
1625 coap_block_delete_lg_crcv(session, lg_crcv);
1626 break;
1627 }
1628 }
1629
1630 if (have_block1 && session->lg_xmit) {
1631 LL_FOREACH(session->lg_xmit, lg_xmit) {
1632 if (COAP_PDU_IS_REQUEST(&lg_xmit->pdu) &&
1633 lg_xmit->b.b1.app_token &&
1634 coap_binary_equal(&pdu->actual_token, lg_xmit->b.b1.app_token)) {
1635 break;
1636 }
1637 }
1638 }
1639 lg_crcv = coap_block_new_lg_crcv(session, pdu, lg_xmit);
1640 if (lg_crcv == NULL) {
1641 goto error;
1642 }
1643 if (lg_xmit) {
1644 /* Need to update the token as set up in the session->lg_xmit */
1645 lg_xmit->b.b1.state_token = lg_crcv->state_token;
1646 }
1647 }
1648 if (session->sock.flags & COAP_SOCKET_MULTICAST)
1649 coap_address_copy(&session->addr_info.remote, &session->sock.mcast_addr);
1650
1651#if COAP_Q_BLOCK_SUPPORT
1652 /* See if large xmit using Q-Block1 (but not testing Q-Block1) */
1653 if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK1, &block)) {
1654 mid = coap_send_q_block1(session, block, pdu, COAP_SEND_INC_PDU);
1655 } else
1656#endif /* COAP_Q_BLOCK_SUPPORT */
1657 mid = coap_send_internal(session, pdu, NULL);
1658#else /* !COAP_CLIENT_SUPPORT */
1659 mid = coap_send_internal(session, pdu, NULL);
1660#endif /* !COAP_CLIENT_SUPPORT */
1661#if COAP_CLIENT_SUPPORT
1662 if (lg_crcv) {
1663 if (mid != COAP_INVALID_MID) {
1664 LL_PREPEND(session->lg_crcv, lg_crcv);
1665 } else {
1666 coap_block_delete_lg_crcv(session, lg_crcv);
1667 }
1668 }
1669#endif /* COAP_CLIENT_SUPPORT */
1670 return mid;
1671
1672error:
1674 return COAP_INVALID_MID;
1675}
1676
1677#if COAP_SERVER_SUPPORT
1678static int
1679coap_pdu_cksum(const coap_pdu_t *pdu, coap_digest_t *digest_buffer) {
1680 coap_digest_ctx_t *digest_ctx = coap_digest_setup();
1681
1682 if (!digest_ctx || !pdu) {
1683 goto fail;
1684 }
1685 if (pdu->used_size && pdu->token) {
1686 if (!coap_digest_update(digest_ctx, pdu->token, pdu->used_size)) {
1687 goto fail;
1688 }
1689 }
1690 if (!coap_digest_update(digest_ctx, (const uint8_t *)&pdu->type, sizeof(pdu->type))) {
1691 goto fail;
1692 }
1693 if (!coap_digest_update(digest_ctx, (const uint8_t *)&pdu->code, sizeof(pdu->code))) {
1694 goto fail;
1695 }
1696 if (!coap_digest_final(digest_ctx, digest_buffer))
1697 return 0;
1698
1699 return 1;
1700
1701fail:
1702 coap_digest_free(digest_ctx);
1703 return 0;
1704}
1705#endif /* COAP_SERVER_SUPPORT */
1706
1709 uint8_t r;
1710 ssize_t bytes_written;
1711 coap_opt_iterator_t opt_iter;
1712
1713#if ! COAP_SERVER_SUPPORT
1714 (void)request_pdu;
1715#endif /* COAP_SERVER_SUPPORT */
1716 pdu->session = session;
1717 if (pdu->code == COAP_RESPONSE_CODE(508)) {
1718 /*
1719 * Need to prepend our IP identifier to the data as per
1720 * https://rfc-editor.org/rfc/rfc8768.html#section-4
1721 */
1722 char addr_str[INET6_ADDRSTRLEN + 8 + 1];
1723 coap_opt_t *opt;
1724 size_t hop_limit;
1725
1726 addr_str[sizeof(addr_str)-1] = '\000';
1727 if (coap_print_addr(&session->addr_info.local, (uint8_t *)addr_str,
1728 sizeof(addr_str) - 1)) {
1729 char *cp;
1730 size_t len;
1731
1732 if (addr_str[0] == '[') {
1733 cp = strchr(addr_str, ']');
1734 if (cp)
1735 *cp = '\000';
1736 if (memcmp(&addr_str[1], "::ffff:", 7) == 0) {
1737 /* IPv4 embedded into IPv6 */
1738 cp = &addr_str[8];
1739 } else {
1740 cp = &addr_str[1];
1741 }
1742 } else {
1743 cp = strchr(addr_str, ':');
1744 if (cp)
1745 *cp = '\000';
1746 cp = addr_str;
1747 }
1748 len = strlen(cp);
1749
1750 /* See if Hop Limit option is being used in return path */
1751 opt = coap_check_option(pdu, COAP_OPTION_HOP_LIMIT, &opt_iter);
1752 if (opt) {
1753 uint8_t buf[4];
1754
1755 hop_limit =
1757 if (hop_limit == 1) {
1758 coap_log_warn("Proxy loop detected '%s'\n",
1759 (char *)pdu->data);
1762 } else if (hop_limit < 1 || hop_limit > 255) {
1763 /* Something is bad - need to drop this pdu (TODO or delete option) */
1764 coap_log_warn("Proxy return has bad hop limit count '%zu'\n",
1765 hop_limit);
1768 }
1769 hop_limit--;
1771 coap_encode_var_safe8(buf, sizeof(buf), hop_limit),
1772 buf);
1773 }
1774
1775 /* Need to check that we are not seeing this proxy in the return loop */
1776 if (pdu->data && opt == NULL) {
1777 char *a_match;
1778 size_t data_len;
1779
1780 if (pdu->used_size + 1 > pdu->max_size) {
1781 /* No space */
1783 }
1784 if (!coap_pdu_resize(pdu, pdu->used_size + 1)) {
1785 /* Internal error */
1787 }
1788 data_len = pdu->used_size - (pdu->data - pdu->token);
1789 pdu->data[data_len] = '\000';
1790 a_match = strstr((char *)pdu->data, cp);
1791 if (a_match && (a_match == (char *)pdu->data || a_match[-1] == ' ') &&
1792 ((size_t)(a_match - (char *)pdu->data + len) == data_len ||
1793 a_match[len] == ' ')) {
1794 coap_log_warn("Proxy loop detected '%s'\n",
1795 (char *)pdu->data);
1798 }
1799 }
1800 if (pdu->used_size + len + 1 <= pdu->max_size) {
1801 size_t old_size = pdu->used_size;
1802 if (coap_pdu_resize(pdu, pdu->used_size + len + 1)) {
1803 if (pdu->data == NULL) {
1804 /*
1805 * Set Hop Limit to max for return path. If this libcoap is in
1806 * a proxy loop path, it will always decrement hop limit in code
1807 * above and hence timeout / drop the response as appropriate
1808 */
1809 hop_limit = 255;
1811 (uint8_t *)&hop_limit);
1812 coap_add_data(pdu, len, (uint8_t *)cp);
1813 } else {
1814 /* prepend with space separator, leaving hop limit "as is" */
1815 memmove(pdu->data + len + 1, pdu->data,
1816 old_size - (pdu->data - pdu->token));
1817 memcpy(pdu->data, cp, len);
1818 pdu->data[len] = ' ';
1819 pdu->used_size += len + 1;
1820 }
1821 }
1822 }
1823 }
1824 }
1825
1826 if (session->echo) {
1827 if (!coap_insert_option(pdu, COAP_OPTION_ECHO, session->echo->length,
1828 session->echo->s))
1829 goto error;
1830 coap_delete_bin_const(session->echo);
1831 session->echo = NULL;
1832 }
1833#if COAP_OSCORE_SUPPORT
1834 if (session->oscore_encryption) {
1835 /* Need to convert Proxy-Uri to Proxy-Scheme option if needed */
1837 goto error;
1838 }
1839#endif /* COAP_OSCORE_SUPPORT */
1840
1841 if (!coap_pdu_encode_header(pdu, session->proto)) {
1842 goto error;
1843 }
1844
1845#if !COAP_DISABLE_TCP
1846 if (COAP_PROTO_RELIABLE(session->proto) &&
1848 if (!session->csm_block_supported) {
1849 /*
1850 * Need to check that this instance is not sending any block options as
1851 * the remote end via CSM has not informed us that there is support
1852 * https://rfc-editor.org/rfc/rfc8323#section-5.3.2
1853 * This includes potential BERT blocks.
1854 */
1855 if (coap_check_option(pdu, COAP_OPTION_BLOCK1, &opt_iter) != NULL) {
1856 coap_log_debug("Remote end did not indicate CSM support for Block1 enabled\n");
1857 }
1858 if (coap_check_option(pdu, COAP_OPTION_BLOCK2, &opt_iter) != NULL) {
1859 coap_log_debug("Remote end did not indicate CSM support for Block2 enabled\n");
1860 }
1861 } else if (!session->csm_bert_rem_support) {
1862 coap_opt_t *opt;
1863
1864 opt = coap_check_option(pdu, COAP_OPTION_BLOCK1, &opt_iter);
1865 if (opt && COAP_OPT_BLOCK_SZX(opt) == 7) {
1866 coap_log_debug("Remote end did not indicate CSM support for BERT Block1\n");
1867 }
1868 opt = coap_check_option(pdu, COAP_OPTION_BLOCK2, &opt_iter);
1869 if (opt && COAP_OPT_BLOCK_SZX(opt) == 7) {
1870 coap_log_debug("Remote end did not indicate CSM support for BERT Block2\n");
1871 }
1872 }
1873 }
1874#endif /* !COAP_DISABLE_TCP */
1875
1876#if COAP_OSCORE_SUPPORT
1877 if (session->oscore_encryption &&
1878 pdu->type != COAP_MESSAGE_RST &&
1879 !(pdu->type == COAP_MESSAGE_ACK && pdu->code == COAP_EMPTY_CODE) &&
1880 !(COAP_PROTO_RELIABLE(session->proto) && pdu->code == COAP_SIGNALING_CODE_PONG)) {
1881 /* Refactor PDU as appropriate RFC8613 */
1882 coap_pdu_t *osc_pdu = coap_oscore_new_pdu_encrypted_lkd(session, pdu, NULL, 0);
1883
1884 if (osc_pdu == NULL) {
1885 coap_log_warn("OSCORE: PDU could not be encrypted\n");
1888 goto error;
1889 }
1890 bytes_written = coap_send_pdu(session, osc_pdu, NULL);
1892 pdu = osc_pdu;
1893 } else
1894#endif /* COAP_OSCORE_SUPPORT */
1895 bytes_written = coap_send_pdu(session, pdu, NULL);
1896
1897#if COAP_SERVER_SUPPORT
1898 if ((session->block_mode & COAP_BLOCK_CACHE_RESPONSE) &&
1899 session->cached_pdu != pdu &&
1900 request_pdu && COAP_PROTO_NOT_RELIABLE(session->proto) &&
1901 COAP_PDU_IS_REQUEST(request_pdu) &&
1902 COAP_PDU_IS_RESPONSE(pdu) && pdu->type == COAP_MESSAGE_ACK) {
1904 session->cached_pdu = pdu;
1906 coap_pdu_cksum(request_pdu, &session->cached_pdu_cksum);
1907 }
1908#endif /* COAP_SERVER_SUPPORT */
1909
1910 if (bytes_written == COAP_PDU_DELAYED) {
1911 /* do not free pdu as it is stored with session for later use */
1912 return pdu->mid;
1913 }
1914 if (bytes_written < 0) {
1915 goto error;
1916 }
1917
1918#if !COAP_DISABLE_TCP
1919 if (COAP_PROTO_RELIABLE(session->proto) &&
1920 (size_t)bytes_written < pdu->used_size + pdu->hdr_size) {
1921 if (coap_session_delay_pdu(session, pdu, NULL) == COAP_PDU_DELAYED) {
1922 session->partial_write = (size_t)bytes_written;
1923 /* do not free pdu as it is stored with session for later use */
1924 return pdu->mid;
1925 } else {
1926 goto error;
1927 }
1928 }
1929#endif /* !COAP_DISABLE_TCP */
1930
1931 if (pdu->type != COAP_MESSAGE_CON
1932 || COAP_PROTO_RELIABLE(session->proto)) {
1933 coap_mid_t id = pdu->mid;
1935 return id;
1936 }
1937
1938 coap_queue_t *node = coap_new_node();
1939 if (!node) {
1940 coap_log_debug("coap_wait_ack: insufficient memory\n");
1941 goto error;
1942 }
1943
1944 node->id = pdu->mid;
1945 node->pdu = pdu;
1946 coap_prng_lkd(&r, sizeof(r));
1947 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
1948 node->timeout = coap_calc_timeout(session, r);
1949 return coap_wait_ack(session->context, session, node);
1950error:
1952 return COAP_INVALID_MID;
1953}
1954
1955static int send_recv_terminate = 0;
1956
1957void
1961
1962COAP_API int
1964 coap_pdu_t **response_pdu, uint32_t timeout_ms) {
1965 int ret;
1966
1967 coap_lock_lock(session->context, return 0);
1968 ret = coap_send_recv_lkd(session, request_pdu, response_pdu, timeout_ms);
1969 coap_lock_unlock(session->context);
1970 return ret;
1971}
1972
1973/*
1974 * Return 0 or +ve Time in function in ms after successful transfer
1975 * -1 Invalid timeout parameter
1976 * -2 Failed to transmit PDU
1977 * -3 Nack or Event handler invoked, cancelling request
1978 * -4 coap_io_process returned error (fail to re-lock or select())
1979 * -5 Response not received in the given time
1980 * -6 Terminated by user
1981 * -7 Client mode code not enabled
1982 */
1983int
1985 coap_pdu_t **response_pdu, uint32_t timeout_ms) {
1986#if COAP_CLIENT_SUPPORT
1988 uint32_t rem_timeout = timeout_ms;
1989 uint32_t block_mode = session->block_mode;
1990 int ret = 0;
1991 coap_tick_t now;
1992 coap_tick_t start;
1993 coap_tick_t ticks_so_far;
1994 uint32_t time_so_far_ms;
1995
1996 coap_ticks(&start);
1997 assert(request_pdu);
1998
2000
2001 session->resp_pdu = NULL;
2002 session->req_token = coap_new_bin_const(request_pdu->actual_token.s,
2003 request_pdu->actual_token.length);
2004
2005 if (timeout_ms == COAP_IO_NO_WAIT || timeout_ms == COAP_IO_WAIT) {
2006 ret = -1;
2007 goto fail;
2008 }
2009 if (session->state == COAP_SESSION_STATE_NONE) {
2010 ret = -3;
2011 goto fail;
2012 }
2013
2015 session->doing_send_recv = 1;
2016 /* So the user needs to delete the PDU */
2017 coap_pdu_reference_lkd(request_pdu);
2018 mid = coap_send_lkd(session, request_pdu);
2019 if (mid == COAP_INVALID_MID) {
2020 if (!session->doing_send_recv)
2021 ret = -3;
2022 else
2023 ret = -2;
2024 goto fail;
2025 }
2026
2027 /* Wait for the response to come in */
2028 while (rem_timeout > 0 && session->doing_send_recv && !session->resp_pdu) {
2029 if (send_recv_terminate) {
2030 ret = -6;
2031 goto fail;
2032 }
2033 ret = coap_io_process_lkd(session->context, rem_timeout);
2034 if (ret < 0) {
2035 ret = -4;
2036 goto fail;
2037 }
2038 /* timeout_ms is for timeout between specific request and response */
2039 coap_ticks(&now);
2040 ticks_so_far = now - session->last_rx_tx;
2041 time_so_far_ms = (uint32_t)((ticks_so_far * 1000) / COAP_TICKS_PER_SECOND);
2042 if (time_so_far_ms >= timeout_ms) {
2043 rem_timeout = 0;
2044 } else {
2045 rem_timeout = timeout_ms - time_so_far_ms;
2046 }
2047 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
2048 /* To pick up on (D)TLS setup issues */
2049 coap_ticks(&now);
2050 ticks_so_far = now - start;
2051 time_so_far_ms = (uint32_t)((ticks_so_far * 1000) / COAP_TICKS_PER_SECOND);
2052 if (time_so_far_ms >= timeout_ms) {
2053 rem_timeout = 0;
2054 } else {
2055 rem_timeout = timeout_ms - time_so_far_ms;
2056 }
2057 }
2058 }
2059
2060 if (rem_timeout) {
2061 coap_ticks(&now);
2062 ticks_so_far = now - start;
2063 time_so_far_ms = (uint32_t)((ticks_so_far * 1000) / COAP_TICKS_PER_SECOND);
2064 ret = time_so_far_ms;
2065 /* Give PDU to user who will be calling coap_delete_pdu() */
2066 *response_pdu = session->resp_pdu;
2067 session->resp_pdu = NULL;
2068 if (*response_pdu == NULL) {
2069 ret = -3;
2070 }
2071 } else {
2072 /* If there is a resp_pdu, it will get cleared below */
2073 ret = -5;
2074 }
2075
2076fail:
2077 session->block_mode = block_mode;
2078 session->doing_send_recv = 0;
2079 /* delete referenced copy */
2080 coap_delete_pdu_lkd(session->resp_pdu);
2081 session->resp_pdu = NULL;
2083 session->req_token = NULL;
2084 return ret;
2085
2086#else /* !COAP_CLIENT_SUPPORT */
2087
2088 (void)session;
2089 (void)timeout_ms;
2090 (void)request_pdu;
2091 coap_log_warn("coap_send_recv: Client mode not supported\n");
2092 *response_pdu = NULL;
2093 return -7;
2094
2095#endif /* ! COAP_CLIENT_SUPPORT */
2096}
2097
2100 if (!context || !node)
2101 return COAP_INVALID_MID;
2102
2103 /* re-initialize timeout when maximum number of retransmissions are not reached yet */
2104 if (node->retransmit_cnt < node->session->max_retransmit) {
2105 ssize_t bytes_written;
2106 coap_tick_t now;
2107 coap_tick_t next_delay;
2108
2109 node->retransmit_cnt++;
2111
2112 next_delay = (coap_tick_t)node->timeout << node->retransmit_cnt;
2113 if (context->ping_timeout &&
2114 context->ping_timeout * COAP_TICKS_PER_SECOND < next_delay) {
2115 uint8_t byte;
2116
2117 coap_prng_lkd(&byte, sizeof(byte));
2118 /* Don't exceed the ping timeout value */
2119 next_delay = context->ping_timeout * COAP_TICKS_PER_SECOND - 255 + byte;
2120 }
2121
2122 coap_ticks(&now);
2123 if (context->sendqueue == NULL) {
2124 node->t = next_delay;
2125 context->sendqueue_basetime = now;
2126 } else {
2127 /* make node->t relative to context->sendqueue_basetime */
2128 node->t = (now - context->sendqueue_basetime) + next_delay;
2129 }
2130 coap_insert_node(&context->sendqueue, node);
2131
2132 if (node->is_mcast) {
2133 coap_log_debug("** %s: mid=0x%04x: mcast delayed transmission\n",
2134 coap_session_str(node->session), node->id);
2135 } else {
2136 coap_log_debug("** %s: mid=0x%04x: retransmission #%d (next %ums)\n",
2137 coap_session_str(node->session), node->id,
2138 node->retransmit_cnt,
2139 (unsigned)(next_delay * 1000 / COAP_TICKS_PER_SECOND));
2140 }
2141
2142 if (node->session->con_active)
2143 node->session->con_active--;
2144 bytes_written = coap_send_pdu(node->session, node->pdu, node);
2145
2146 if (node->is_mcast) {
2149 return COAP_INVALID_MID;
2150 }
2151 if (bytes_written == COAP_PDU_DELAYED) {
2152 /* PDU was not retransmitted immediately because a new handshake is
2153 in progress. node was moved to the send queue of the session. */
2154 return node->id;
2155 }
2156
2157 if (bytes_written < 0)
2158 return (int)bytes_written;
2159
2160 return node->id;
2161 }
2162
2163 /* no more retransmissions, remove node from system */
2164 coap_log_warn("** %s: mid=0x%04x: give up after %d attempts\n",
2165 coap_session_str(node->session), node->id, node->retransmit_cnt);
2166
2167#if COAP_SERVER_SUPPORT
2168 /* Check if subscriptions exist that should be canceled after
2169 COAP_OBS_MAX_FAIL */
2170 if (COAP_RESPONSE_CLASS(node->pdu->code) >= 2 && node->session->ref_subscriptions) {
2171 if (context->ping_timeout) {
2174 return COAP_INVALID_MID;
2175 } else {
2176 coap_handle_failed_notify(context, node->session, &node->pdu->actual_token);
2177 }
2178 }
2179#endif /* COAP_SERVER_SUPPORT */
2180 if (node->session->con_active) {
2181 node->session->con_active--;
2183 /*
2184 * As there may be another CON in a different queue entry on the same
2185 * session that needs to be immediately released,
2186 * coap_session_connected() is called.
2187 * However, there is the possibility coap_wait_ack() may be called for
2188 * this node (queue) and re-added to context->sendqueue.
2189 * coap_delete_node_lkd(node) called shortly will handle this and
2190 * remove it.
2191 */
2193 }
2194 }
2195
2196 /* And finally delete the node */
2197 if (node->pdu->type == COAP_MESSAGE_CON) {
2199 }
2200#if COAP_CLIENT_SUPPORT
2201 node->session->doing_send_recv = 0;
2202#endif /* COAP_CLIENT_SUPPORT */
2204 return COAP_INVALID_MID;
2205}
2206
2207static int
2209 uint8_t *data;
2210 size_t data_len;
2211 int result = -1;
2212
2213 coap_packet_get_memmapped(packet, &data, &data_len);
2214 if (session->proto == COAP_PROTO_DTLS) {
2215#if COAP_SERVER_SUPPORT
2216 if (session->type == COAP_SESSION_TYPE_HELLO)
2217 result = coap_dtls_hello(session, data, data_len);
2218 else
2219#endif /* COAP_SERVER_SUPPORT */
2220 if (session->tls)
2221 result = coap_dtls_receive(session, data, data_len);
2222 } else if (session->proto == COAP_PROTO_UDP) {
2223 result = coap_handle_dgram(ctx, session, data, data_len);
2224 }
2225 return result;
2226}
2227
2228#if COAP_CLIENT_SUPPORT
2229void
2231#if COAP_DISABLE_TCP
2232 (void)now;
2233
2235#else /* !COAP_DISABLE_TCP */
2236 if (coap_netif_strm_connect2(session)) {
2237 session->last_rx_tx = now;
2239 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
2240 } else {
2243 }
2244#endif /* !COAP_DISABLE_TCP */
2245}
2246#endif /* COAP_CLIENT_SUPPORT */
2247
2248static void
2250 (void)ctx;
2251 assert(session->sock.flags & COAP_SOCKET_CONNECTED);
2252
2253 while (session->delayqueue) {
2254 ssize_t bytes_written;
2255 coap_queue_t *q = session->delayqueue;
2256 coap_log_debug("** %s: mid=0x%04x: transmitted after delay\n",
2257 coap_session_str(session), (int)q->pdu->mid);
2258 assert(session->partial_write < q->pdu->used_size + q->pdu->hdr_size);
2259 bytes_written = session->sock.lfunc[COAP_LAYER_SESSION].l_write(session,
2260 q->pdu->token - q->pdu->hdr_size + session->partial_write,
2261 q->pdu->used_size + q->pdu->hdr_size - session->partial_write);
2262 if (bytes_written > 0)
2263 session->last_rx_tx = now;
2264 if (bytes_written <= 0 ||
2265 (size_t)bytes_written < q->pdu->used_size + q->pdu->hdr_size - session->partial_write) {
2266 if (bytes_written > 0)
2267 session->partial_write += (size_t)bytes_written;
2268 break;
2269 }
2270 session->delayqueue = q->next;
2271 session->partial_write = 0;
2273 }
2274}
2275
2276void
2278#if COAP_CONSTRAINED_STACK
2279 /* payload and packet can be protected by global_lock if needed */
2280 static unsigned char payload[COAP_RXBUFFER_SIZE];
2281 static coap_packet_t s_packet;
2282#else /* ! COAP_CONSTRAINED_STACK */
2283 unsigned char payload[COAP_RXBUFFER_SIZE];
2284 coap_packet_t s_packet;
2285#endif /* ! COAP_CONSTRAINED_STACK */
2286 coap_packet_t *packet = &s_packet;
2287
2289
2290 packet->length = sizeof(payload);
2291 packet->payload = payload;
2292
2293 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
2294 ssize_t bytes_read;
2295 memcpy(&packet->addr_info, &session->addr_info, sizeof(packet->addr_info));
2296 bytes_read = coap_netif_dgrm_read(session, packet);
2297
2298 if (bytes_read < 0) {
2299 if (bytes_read == -2)
2300 /* Reset the session back to startup defaults */
2302 } else if (bytes_read > 0) {
2303 session->last_rx_tx = now;
2304 /* coap_netif_dgrm_read() updates session->addr_info from packet->addr_info */
2305 coap_handle_dgram_for_proto(ctx, session, packet);
2306 }
2307#if !COAP_DISABLE_TCP
2308 } else if (session->proto == COAP_PROTO_WS ||
2309 session->proto == COAP_PROTO_WSS) {
2310 ssize_t bytes_read = 0;
2311
2312 /* WebSocket layer passes us the whole packet */
2313 bytes_read = session->sock.lfunc[COAP_LAYER_SESSION].l_read(session,
2314 packet->payload,
2315 packet->length);
2316 if (bytes_read < 0) {
2318 } else if (bytes_read > 2) {
2319 coap_pdu_t *pdu;
2320
2321 session->last_rx_tx = now;
2322 /* Need max space incase PDU is updated with updated token etc. */
2323 pdu = coap_pdu_init(0, 0, 0, coap_session_max_pdu_rcv_size(session));
2324 if (!pdu) {
2325 return;
2326 }
2327
2328 if (!coap_pdu_parse(session->proto, packet->payload, bytes_read, pdu)) {
2330 coap_log_warn("discard malformed PDU\n");
2332 return;
2333 }
2334
2335 coap_dispatch(ctx, session, pdu);
2337 return;
2338 }
2339 } else {
2340 ssize_t bytes_read = 0;
2341 const uint8_t *p;
2342 int retry;
2343
2344 do {
2345 bytes_read = session->sock.lfunc[COAP_LAYER_SESSION].l_read(session,
2346 packet->payload,
2347 packet->length);
2348 if (bytes_read > 0) {
2349 session->last_rx_tx = now;
2350 }
2351 p = packet->payload;
2352 retry = bytes_read == (ssize_t)packet->length;
2353 while (bytes_read > 0) {
2354 if (session->partial_pdu) {
2355 size_t len = session->partial_pdu->used_size
2356 + session->partial_pdu->hdr_size
2357 - session->partial_read;
2358 size_t n = min(len, (size_t)bytes_read);
2359 memcpy(session->partial_pdu->token - session->partial_pdu->hdr_size
2360 + session->partial_read, p, n);
2361 p += n;
2362 bytes_read -= n;
2363 if (n == len) {
2364 if (coap_pdu_parse_header(session->partial_pdu, session->proto)
2365 && coap_pdu_parse_opt(session->partial_pdu)) {
2366 coap_dispatch(ctx, session, session->partial_pdu);
2367 }
2369 session->partial_pdu = NULL;
2370 session->partial_read = 0;
2371 } else {
2372 session->partial_read += n;
2373 }
2374 } else if (session->partial_read > 0) {
2375 size_t hdr_size = coap_pdu_parse_header_size(session->proto,
2376 session->read_header);
2377 size_t tkl = session->read_header[0] & 0x0f;
2378 size_t tok_ext_bytes = tkl == COAP_TOKEN_EXT_1B_TKL ? 1 :
2379 tkl == COAP_TOKEN_EXT_2B_TKL ? 2 : 0;
2380 size_t len = hdr_size + tok_ext_bytes - session->partial_read;
2381 size_t n = min(len, (size_t)bytes_read);
2382 memcpy(session->read_header + session->partial_read, p, n);
2383 p += n;
2384 bytes_read -= n;
2385 if (n == len) {
2386 /* Header now all in */
2387 size_t size = coap_pdu_parse_size(session->proto, session->read_header,
2388 hdr_size + tok_ext_bytes);
2389 if (size > COAP_DEFAULT_MAX_PDU_RX_SIZE) {
2390 coap_log_warn("** %s: incoming PDU length too large (%zu > %lu)\n",
2391 coap_session_str(session),
2392 size, COAP_DEFAULT_MAX_PDU_RX_SIZE);
2393 bytes_read = -1;
2394 break;
2395 }
2396 /* Need max space incase PDU is updated with updated token etc. */
2397 session->partial_pdu = coap_pdu_init(0, 0, 0,
2399 if (session->partial_pdu == NULL) {
2400 bytes_read = -1;
2401 break;
2402 }
2403 if (session->partial_pdu->alloc_size < size && !coap_pdu_resize(session->partial_pdu, size)) {
2404 bytes_read = -1;
2405 break;
2406 }
2407 session->partial_pdu->hdr_size = (uint8_t)hdr_size;
2408 session->partial_pdu->used_size = size;
2409 memcpy(session->partial_pdu->token - hdr_size, session->read_header, hdr_size + tok_ext_bytes);
2410 session->partial_read = hdr_size + tok_ext_bytes;
2411 if (size == 0) {
2412 if (coap_pdu_parse_header(session->partial_pdu, session->proto)) {
2413 coap_dispatch(ctx, session, session->partial_pdu);
2414 }
2416 session->partial_pdu = NULL;
2417 session->partial_read = 0;
2418 }
2419 } else {
2420 /* More of the header to go */
2421 session->partial_read += n;
2422 }
2423 } else {
2424 /* Get in first byte of the header */
2425 session->read_header[0] = *p++;
2426 bytes_read -= 1;
2427 if (!coap_pdu_parse_header_size(session->proto,
2428 session->read_header)) {
2429 bytes_read = -1;
2430 break;
2431 }
2432 session->partial_read = 1;
2433 }
2434 }
2435 } while (bytes_read == 0 && retry);
2436 if (bytes_read < 0)
2438#endif /* !COAP_DISABLE_TCP */
2439 }
2440}
2441
2442#if COAP_SERVER_SUPPORT
2443static int
2444coap_read_endpoint(coap_context_t *ctx, coap_endpoint_t *endpoint, coap_tick_t now) {
2445 ssize_t bytes_read = -1;
2446 int result = -1; /* the value to be returned */
2447#if COAP_CONSTRAINED_STACK
2448 /* payload and e_packet can be protected by global_lock if needed */
2449 static unsigned char payload[COAP_RXBUFFER_SIZE];
2450 static coap_packet_t e_packet;
2451#else /* ! COAP_CONSTRAINED_STACK */
2452 unsigned char payload[COAP_RXBUFFER_SIZE];
2453 coap_packet_t e_packet;
2454#endif /* ! COAP_CONSTRAINED_STACK */
2455 coap_packet_t *packet = &e_packet;
2456
2457 assert(COAP_PROTO_NOT_RELIABLE(endpoint->proto));
2458 assert(endpoint->sock.flags & COAP_SOCKET_BOUND);
2459
2460 /* Need to do this as there may be holes in addr_info */
2461 memset(&packet->addr_info, 0, sizeof(packet->addr_info));
2462 packet->length = sizeof(payload);
2463 packet->payload = payload;
2465 coap_address_copy(&packet->addr_info.local, &endpoint->bind_addr);
2466
2467 bytes_read = coap_netif_dgrm_read_ep(endpoint, packet);
2468 if (bytes_read < 0) {
2469 if (errno != EAGAIN) {
2470 coap_log_warn("* %s: read failed\n", coap_endpoint_str(endpoint));
2471 }
2472 } else if (bytes_read > 0) {
2473 coap_session_t *session = coap_endpoint_get_session(endpoint, packet, now);
2474 if (session) {
2475 coap_log_debug("* %s: netif: recv %4zd bytes\n",
2476 coap_session_str(session), bytes_read);
2477 result = coap_handle_dgram_for_proto(ctx, session, packet);
2478 if (endpoint->proto == COAP_PROTO_DTLS && session->type == COAP_SESSION_TYPE_HELLO && result == 1)
2479 coap_session_new_dtls_session(session, now);
2480 }
2481 }
2482 return result;
2483}
2484
2485static int
2486coap_write_endpoint(coap_context_t *ctx, coap_endpoint_t *endpoint, coap_tick_t now) {
2487 (void)ctx;
2488 (void)endpoint;
2489 (void)now;
2490 return 0;
2491}
2492
2493#if !COAP_DISABLE_TCP
2494static int
2495coap_accept_endpoint(coap_context_t *ctx, coap_endpoint_t *endpoint,
2496 coap_tick_t now, void *extra) {
2497 coap_session_t *session = coap_new_server_session(ctx, endpoint, extra);
2498 if (session)
2499 session->last_rx_tx = now;
2500 return session != NULL;
2501}
2502#endif /* !COAP_DISABLE_TCP */
2503#endif /* COAP_SERVER_SUPPORT */
2504
2505COAP_API void
2507 coap_lock_lock(ctx, return);
2508 coap_io_do_io_lkd(ctx, now);
2509 coap_lock_unlock(ctx);
2510}
2511
2512void
2514#ifdef COAP_EPOLL_SUPPORT
2515 (void)ctx;
2516 (void)now;
2517 coap_log_emerg("coap_io_do_io() requires libcoap not compiled for using epoll\n");
2518#else /* ! COAP_EPOLL_SUPPORT */
2519 coap_session_t *s, *rtmp;
2520
2522#if COAP_SERVER_SUPPORT
2523 coap_endpoint_t *ep, *tmp;
2524 LL_FOREACH_SAFE(ctx->endpoint, ep, tmp) {
2525 if ((ep->sock.flags & COAP_SOCKET_CAN_READ) != 0)
2526 coap_read_endpoint(ctx, ep, now);
2527 if ((ep->sock.flags & COAP_SOCKET_CAN_WRITE) != 0)
2528 coap_write_endpoint(ctx, ep, now);
2529#if !COAP_DISABLE_TCP
2530 if ((ep->sock.flags & COAP_SOCKET_CAN_ACCEPT) != 0)
2531 coap_accept_endpoint(ctx, ep, now, NULL);
2532#endif /* !COAP_DISABLE_TCP */
2533 SESSIONS_ITER_SAFE(ep->sessions, s, rtmp) {
2534 /* Make sure the session object is not deleted in one of the callbacks */
2536 if ((s->sock.flags & COAP_SOCKET_CAN_READ) != 0) {
2537 coap_read_session(ctx, s, now);
2538 }
2539 if ((s->sock.flags & COAP_SOCKET_CAN_WRITE) != 0) {
2540 coap_write_session(ctx, s, now);
2541 }
2543 }
2544 }
2545#endif /* COAP_SERVER_SUPPORT */
2546
2547#if COAP_CLIENT_SUPPORT
2548 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
2549 /* Make sure the session object is not deleted in one of the callbacks */
2551 if ((s->sock.flags & COAP_SOCKET_CAN_CONNECT) != 0) {
2552 coap_connect_session(s, now);
2553 }
2554 if ((s->sock.flags & COAP_SOCKET_CAN_READ) != 0 && s->ref > 1) {
2555 coap_read_session(ctx, s, now);
2556 }
2557 if ((s->sock.flags & COAP_SOCKET_CAN_WRITE) != 0 && s->ref > 1) {
2558 coap_write_session(ctx, s, now);
2559 }
2561 }
2562#endif /* COAP_CLIENT_SUPPORT */
2563#endif /* ! COAP_EPOLL_SUPPORT */
2564}
2565
2566COAP_API void
2567coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events, size_t nevents) {
2568 coap_lock_lock(ctx, return);
2569 coap_io_do_epoll_lkd(ctx, events, nevents);
2570 coap_lock_unlock(ctx);
2571}
2572
2573/*
2574 * While this code in part replicates coap_io_do_io_lkd(), doing the functions
2575 * directly saves having to iterate through the endpoints / sessions.
2576 */
2577void
2578coap_io_do_epoll_lkd(coap_context_t *ctx, struct epoll_event *events, size_t nevents) {
2579#ifndef COAP_EPOLL_SUPPORT
2580 (void)ctx;
2581 (void)events;
2582 (void)nevents;
2583 coap_log_emerg("coap_io_do_epoll() requires libcoap compiled for using epoll\n");
2584#else /* COAP_EPOLL_SUPPORT */
2585 coap_tick_t now;
2586 size_t j;
2587
2589 coap_ticks(&now);
2590 for (j = 0; j < nevents; j++) {
2591 coap_socket_t *sock = (coap_socket_t *)events[j].data.ptr;
2592
2593 /* Ignore 'timer trigger' ptr which is NULL */
2594 if (sock) {
2595#if COAP_SERVER_SUPPORT
2596 if (sock->endpoint) {
2597 coap_endpoint_t *endpoint = sock->endpoint;
2598 if ((sock->flags & COAP_SOCKET_WANT_READ) &&
2599 (events[j].events & EPOLLIN)) {
2600 sock->flags |= COAP_SOCKET_CAN_READ;
2601 coap_read_endpoint(endpoint->context, endpoint, now);
2602 }
2603
2604 if ((sock->flags & COAP_SOCKET_WANT_WRITE) &&
2605 (events[j].events & EPOLLOUT)) {
2606 /*
2607 * Need to update this to EPOLLIN as EPOLLOUT will normally always
2608 * be true causing epoll_wait to return early
2609 */
2610 coap_epoll_ctl_mod(sock, EPOLLIN, __func__);
2612 coap_write_endpoint(endpoint->context, endpoint, now);
2613 }
2614
2615#if !COAP_DISABLE_TCP
2616 if ((sock->flags & COAP_SOCKET_WANT_ACCEPT) &&
2617 (events[j].events & EPOLLIN)) {
2619 coap_accept_endpoint(endpoint->context, endpoint, now, NULL);
2620 }
2621#endif /* !COAP_DISABLE_TCP */
2622
2623 } else
2624#endif /* COAP_SERVER_SUPPORT */
2625 if (sock->session) {
2626 coap_session_t *session = sock->session;
2627
2628 /* Make sure the session object is not deleted
2629 in one of the callbacks */
2631#if COAP_CLIENT_SUPPORT
2632 if ((sock->flags & COAP_SOCKET_WANT_CONNECT) &&
2633 (events[j].events & (EPOLLOUT|EPOLLERR|EPOLLHUP|EPOLLRDHUP))) {
2635 coap_connect_session(session, now);
2636 if (coap_netif_available(session) &&
2637 !(sock->flags & COAP_SOCKET_WANT_WRITE)) {
2638 coap_epoll_ctl_mod(sock, EPOLLIN, __func__);
2639 }
2640 }
2641#endif /* COAP_CLIENT_SUPPORT */
2642
2643 if ((sock->flags & COAP_SOCKET_WANT_READ) &&
2644 (events[j].events & (EPOLLIN|EPOLLERR|EPOLLHUP|EPOLLRDHUP))) {
2645 sock->flags |= COAP_SOCKET_CAN_READ;
2646 coap_read_session(session->context, session, now);
2647 }
2648
2649 if ((sock->flags & COAP_SOCKET_WANT_WRITE) &&
2650 (events[j].events & (EPOLLOUT|EPOLLERR|EPOLLHUP|EPOLLRDHUP))) {
2651 /*
2652 * Need to update this to EPOLLIN as EPOLLOUT will normally always
2653 * be true causing epoll_wait to return early
2654 */
2655 coap_epoll_ctl_mod(sock, EPOLLIN, __func__);
2657 coap_write_session(session->context, session, now);
2658 }
2659 /* Now dereference session so it can go away if needed */
2660 coap_session_release_lkd(session);
2661 }
2662 } else if (ctx->eptimerfd != -1) {
2663 /*
2664 * 'timer trigger' must have fired. eptimerfd needs to be read to clear
2665 * it so that it does not set EPOLLIN in the next epoll_wait().
2666 */
2667 uint64_t count;
2668
2669 /* Check the result from read() to suppress the warning on
2670 * systems that declare read() with warn_unused_result. */
2671 if (read(ctx->eptimerfd, &count, sizeof(count)) == -1) {
2672 /* do nothing */;
2673 }
2674 }
2675 }
2676 /* And update eptimerfd as to when to next trigger */
2677 coap_ticks(&now);
2678 coap_io_prepare_epoll_lkd(ctx, now);
2679#endif /* COAP_EPOLL_SUPPORT */
2680}
2681
2682int
2684 uint8_t *msg, size_t msg_len) {
2685
2686 coap_pdu_t *pdu = NULL;
2687
2688 assert(COAP_PROTO_NOT_RELIABLE(session->proto));
2689 if (msg_len < 4) {
2690 /* Minimum size of CoAP header - ignore runt */
2691 return -1;
2692 }
2693 if ((msg[0] >> 6) != COAP_DEFAULT_VERSION) {
2694 /*
2695 * As per https://datatracker.ietf.org/doc/html/rfc7252#section-3,
2696 * this MUST be silently ignored.
2697 */
2698 coap_log_debug("coap_handle_dgram: UDP version not supported\n");
2699 return -1;
2700 }
2701
2702 /* Need max space incase PDU is updated with updated token etc. */
2703 pdu = coap_pdu_init(0, 0, 0, coap_session_max_pdu_rcv_size(session));
2704 if (!pdu)
2705 goto error;
2706
2707 if (!coap_pdu_parse(session->proto, msg, msg_len, pdu)) {
2709 coap_log_warn("discard malformed PDU\n");
2710 goto error;
2711 }
2712
2713 coap_dispatch(ctx, session, pdu);
2715 return 0;
2716
2717error:
2718 /*
2719 * https://rfc-editor.org/rfc/rfc7252#section-4.2 MUST send RST
2720 * https://rfc-editor.org/rfc/rfc7252#section-4.3 MAY send RST
2721 */
2722 coap_send_rst_lkd(session, pdu);
2724 return -1;
2725}
2726
2727int
2729 coap_queue_t **node) {
2730 coap_queue_t *p, *q;
2731
2732 if (!queue || !*queue)
2733 return 0;
2734
2735 /* replace queue head if PDU's time is less than head's time */
2736
2737 if (session == (*queue)->session && id == (*queue)->id) { /* found message id */
2738 *node = *queue;
2739 *queue = (*queue)->next;
2740 if (*queue) { /* adjust relative time of new queue head */
2741 (*queue)->t += (*node)->t;
2742 }
2743 (*node)->next = NULL;
2744 coap_log_debug("** %s: mid=0x%04x: removed (1)\n",
2745 coap_session_str(session), id);
2746 return 1;
2747 }
2748
2749 /* search message id queue to remove (only first occurence will be removed) */
2750 q = *queue;
2751 do {
2752 p = q;
2753 q = q->next;
2754 } while (q && (session != q->session || id != q->id));
2755
2756 if (q) { /* found message id */
2757 p->next = q->next;
2758 if (p->next) { /* must update relative time of p->next */
2759 p->next->t += q->t;
2760 }
2761 q->next = NULL;
2762 *node = q;
2763 coap_log_debug("** %s: mid=0x%04x: removed (2)\n",
2764 coap_session_str(session), id);
2765 return 1;
2766 }
2767
2768 return 0;
2769
2770}
2771
2772void
2774 coap_nack_reason_t reason) {
2775 coap_queue_t *p, *q;
2776
2777 while (context->sendqueue && context->sendqueue->session == session) {
2778 q = context->sendqueue;
2779 context->sendqueue = q->next;
2780 coap_log_debug("** %s: mid=0x%04x: removed (3)\n",
2781 coap_session_str(session), q->id);
2782 if (q->pdu->type == COAP_MESSAGE_CON) {
2783 coap_handle_nack(session, q->pdu, reason, q->id);
2784 }
2786 }
2787
2788 if (!context->sendqueue)
2789 return;
2790
2791 p = context->sendqueue;
2792 q = p->next;
2793
2794 while (q) {
2795 if (q->session == session) {
2796 p->next = q->next;
2797 coap_log_debug("** %s: mid=0x%04x: removed (4)\n",
2798 coap_session_str(session), q->id);
2799 if (q->pdu->type == COAP_MESSAGE_CON) {
2800 coap_handle_nack(session, q->pdu, reason, q->id);
2801 }
2803 q = p->next;
2804 } else {
2805 p = q;
2806 q = q->next;
2807 }
2808 }
2809}
2810
2811void
2813 coap_bin_const_t *token) {
2814 /* cancel all messages in sendqueue that belong to session
2815 * and use the specified token */
2816 coap_queue_t **p, *q;
2817
2818 if (!context->sendqueue)
2819 return;
2820
2821 p = &context->sendqueue;
2822 q = *p;
2823
2824 while (q) {
2825 if (q->session == session &&
2826 (!token || coap_binary_equal(&q->pdu->actual_token, token))) {
2827 *p = q->next;
2828 coap_log_debug("** %s: mid=0x%04x: removed (6)\n",
2829 coap_session_str(session), q->id);
2830 if (q->pdu->type == COAP_MESSAGE_CON && session->con_active) {
2831 session->con_active--;
2832 if (session->state == COAP_SESSION_STATE_ESTABLISHED)
2833 /* Flush out any entries on session->delayqueue */
2834 coap_session_connected(session);
2835 }
2837 } else {
2838 p = &(q->next);
2839 }
2840 q = *p;
2841 }
2842}
2843
2844coap_pdu_t *
2846 coap_opt_filter_t *opts) {
2847 coap_opt_iterator_t opt_iter;
2848 coap_pdu_t *response;
2849 size_t size = request->e_token_length;
2850 unsigned char type;
2851 coap_opt_t *option;
2852 coap_option_num_t opt_num = 0; /* used for calculating delta-storage */
2853
2854#if COAP_ERROR_PHRASE_LENGTH > 0
2855 const char *phrase;
2856 if (code != COAP_RESPONSE_CODE(508)) {
2857 phrase = coap_response_phrase(code);
2858
2859 /* Need some more space for the error phrase and payload start marker */
2860 if (phrase)
2861 size += strlen(phrase) + 1;
2862 } else {
2863 /*
2864 * Need space for IP for 5.08 response which is filled in in
2865 * coap_send_internal()
2866 * https://rfc-editor.org/rfc/rfc8768.html#section-4
2867 */
2868 phrase = NULL;
2869 size += INET6_ADDRSTRLEN;
2870 }
2871#endif
2872
2873 assert(request);
2874
2875 /* cannot send ACK if original request was not confirmable */
2876 type = request->type == COAP_MESSAGE_CON ?
2878
2879 /* Estimate how much space we need for options to copy from
2880 * request. We always need the Token, for 4.02 the unknown critical
2881 * options must be included as well. */
2882
2883 /* we do not want these */
2886 /* Unsafe to send this back */
2888
2889 coap_option_iterator_init(request, &opt_iter, opts);
2890
2891 /* Add size of each unknown critical option. As known critical
2892 options as well as elective options are not copied, the delta
2893 value might grow.
2894 */
2895 while ((option = coap_option_next(&opt_iter))) {
2896 uint16_t delta = opt_iter.number - opt_num;
2897 /* calculate space required to encode (opt_iter.number - opt_num) */
2898 if (delta < 13) {
2899 size++;
2900 } else if (delta < 269) {
2901 size += 2;
2902 } else {
2903 size += 3;
2904 }
2905
2906 /* add coap_opt_length(option) and the number of additional bytes
2907 * required to encode the option length */
2908
2909 size += coap_opt_length(option);
2910 switch (*option & 0x0f) {
2911 case 0x0e:
2912 size++;
2913 /* fall through */
2914 case 0x0d:
2915 size++;
2916 break;
2917 default:
2918 ;
2919 }
2920
2921 opt_num = opt_iter.number;
2922 }
2923
2924 /* Now create the response and fill with options and payload data. */
2925 response = coap_pdu_init(type, code, request->mid, size);
2926 if (response) {
2927 /* copy token */
2928 if (!coap_add_token(response, request->actual_token.length,
2929 request->actual_token.s)) {
2930 coap_log_debug("cannot add token to error response\n");
2931 coap_delete_pdu_lkd(response);
2932 return NULL;
2933 }
2934
2935 /* copy all options */
2936 coap_option_iterator_init(request, &opt_iter, opts);
2937 while ((option = coap_option_next(&opt_iter))) {
2938 coap_add_option_internal(response, opt_iter.number,
2939 coap_opt_length(option),
2940 coap_opt_value(option));
2941 }
2942
2943#if COAP_ERROR_PHRASE_LENGTH > 0
2944 /* note that diagnostic messages do not need a Content-Format option. */
2945 if (phrase)
2946 coap_add_data(response, (size_t)strlen(phrase), (const uint8_t *)phrase);
2947#endif
2948 }
2949
2950 return response;
2951}
2952
2953#if COAP_SERVER_SUPPORT
2954#define SZX_TO_BYTES(SZX) ((size_t)(1 << ((SZX) + 4)))
2955
2956static void
2957free_wellknown_response(coap_session_t *session COAP_UNUSED, void *app_ptr) {
2958 coap_delete_string(app_ptr);
2959}
2960
2961/*
2962 * Caution: As this handler is in libcoap space, it is called with
2963 * context locked.
2964 */
2965static void
2966hnd_get_wellknown_lkd(coap_resource_t *resource,
2967 coap_session_t *session,
2968 const coap_pdu_t *request,
2969 const coap_string_t *query,
2970 coap_pdu_t *response) {
2971 size_t len = 0;
2972 coap_string_t *data_string = NULL;
2973 coap_print_status_t result = 0;
2974 size_t wkc_len = 0;
2975 uint8_t buf[4];
2976
2977 /*
2978 * Quick hack to determine the size of the resource descriptions for
2979 * .well-known/core.
2980 */
2981 result = coap_print_wellknown_lkd(session->context, buf, &wkc_len, UINT_MAX, query);
2982 if (result & COAP_PRINT_STATUS_ERROR) {
2983 coap_log_warn("cannot determine length of /.well-known/core\n");
2984 goto error;
2985 }
2986
2987 if (wkc_len > 0) {
2988 data_string = coap_new_string(wkc_len);
2989 if (!data_string)
2990 goto error;
2991
2992 len = wkc_len;
2993 result = coap_print_wellknown_lkd(session->context, data_string->s, &len, 0, query);
2994 if ((result & COAP_PRINT_STATUS_ERROR) != 0) {
2995 coap_log_debug("coap_print_wellknown failed\n");
2996 goto error;
2997 }
2998 assert(len <= (size_t)wkc_len);
2999 data_string->length = len;
3000
3001 if (!(session->block_mode & COAP_BLOCK_USE_LIBCOAP)) {
3003 coap_encode_var_safe(buf, sizeof(buf),
3005 goto error;
3006 }
3007 if (response->used_size + len + 1 > response->max_size) {
3008 /*
3009 * Data does not fit into a packet and no libcoap block support
3010 * +1 for end of options marker
3011 */
3012 coap_log_debug(".well-known/core: truncating data length to %zu from %zu\n",
3013 len, response->max_size - response->used_size - 1);
3014 len = response->max_size - response->used_size - 1;
3015 }
3016 if (!coap_add_data(response, len, data_string->s)) {
3017 goto error;
3018 }
3019 free_wellknown_response(session, data_string);
3020 } else if (!coap_add_data_large_response_lkd(resource, session, request,
3021 response, query,
3023 -1, 0, data_string->length,
3024 data_string->s,
3025 free_wellknown_response,
3026 data_string)) {
3027 goto error_released;
3028 }
3029 } else {
3031 coap_encode_var_safe(buf, sizeof(buf),
3033 goto error;
3034 }
3035 }
3036 response->code = COAP_RESPONSE_CODE(205);
3037 return;
3038
3039error:
3040 free_wellknown_response(session, data_string);
3041error_released:
3042 if (response->code == 0) {
3043 /* set error code 5.03 and remove all options and data from response */
3044 response->code = COAP_RESPONSE_CODE(503);
3045 response->used_size = response->e_token_length;
3046 response->data = NULL;
3047 }
3048}
3049#endif /* COAP_SERVER_SUPPORT */
3050
3061static int
3063 int num_cancelled = 0; /* the number of observers cancelled */
3064
3065#ifndef COAP_SERVER_SUPPORT
3066 (void)sent;
3067#endif /* ! COAP_SERVER_SUPPORT */
3068 (void)context;
3069
3070#if COAP_SERVER_SUPPORT
3071 /* remove observer for this resource, if any
3072 * Use token from sent and try to find a matching resource. Uh!
3073 */
3074 RESOURCES_ITER(context->resources, r) {
3075 coap_cancel_all_messages(context, sent->session, &sent->pdu->actual_token);
3076 num_cancelled += coap_delete_observer(r, sent->session, &sent->pdu->actual_token);
3077 }
3078#endif /* COAP_SERVER_SUPPORT */
3079
3080 return num_cancelled;
3081}
3082
3083#if COAP_SERVER_SUPPORT
3088enum respond_t { RESPONSE_DEFAULT, RESPONSE_DROP, RESPONSE_SEND };
3089
3090/*
3091 * Checks for No-Response option in given @p request and
3092 * returns @c RESPONSE_DROP if @p response should be suppressed
3093 * according to RFC 7967.
3094 *
3095 * If the response is a confirmable piggybacked response and RESPONSE_DROP,
3096 * change it to an empty ACK and @c RESPONSE_SEND so the client does not keep
3097 * on retrying.
3098 *
3099 * Checks if the response code is 0.00 and if either the session is reliable or
3100 * non-confirmable, @c RESPONSE_DROP is also returned.
3101 *
3102 * Multicast response checking is also carried out.
3103 *
3104 * NOTE: It is the responsibility of the application to determine whether
3105 * a delayed separate response should be sent as the original requesting packet
3106 * containing the No-Response option has long since gone.
3107 *
3108 * The value of the No-Response option is encoded as
3109 * follows:
3110 *
3111 * @verbatim
3112 * +-------+-----------------------+-----------------------------------+
3113 * | Value | Binary Representation | Description |
3114 * +-------+-----------------------+-----------------------------------+
3115 * | 0 | <empty> | Interested in all responses. |
3116 * +-------+-----------------------+-----------------------------------+
3117 * | 2 | 00000010 | Not interested in 2.xx responses. |
3118 * +-------+-----------------------+-----------------------------------+
3119 * | 8 | 00001000 | Not interested in 4.xx responses. |
3120 * +-------+-----------------------+-----------------------------------+
3121 * | 16 | 00010000 | Not interested in 5.xx responses. |
3122 * +-------+-----------------------+-----------------------------------+
3123 * @endverbatim
3124 *
3125 * @param request The CoAP request to check for the No-Response option.
3126 * This parameter must not be NULL.
3127 * @param response The response that is potentially suppressed.
3128 * This parameter must not be NULL.
3129 * @param session The session this request/response are associated with.
3130 * This parameter must not be NULL.
3131 * @return RESPONSE_DEFAULT when no special treatment is requested,
3132 * RESPONSE_DROP when the response must be discarded, or
3133 * RESPONSE_SEND when the response must be sent.
3134 */
3135static enum respond_t
3136no_response(coap_pdu_t *request, coap_pdu_t *response,
3137 coap_session_t *session, coap_resource_t *resource) {
3138 coap_opt_t *nores;
3139 coap_opt_iterator_t opt_iter;
3140 unsigned int val = 0;
3141
3142 assert(request);
3143 assert(response);
3144
3145 if (COAP_RESPONSE_CLASS(response->code) > 0) {
3146 nores = coap_check_option(request, COAP_OPTION_NORESPONSE, &opt_iter);
3147
3148 if (nores) {
3150
3151 /* The response should be dropped when the bit corresponding to
3152 * the response class is set (cf. table in function
3153 * documentation). When a No-Response option is present and the
3154 * bit is not set, the sender explicitly indicates interest in
3155 * this response. */
3156 if (((1 << (COAP_RESPONSE_CLASS(response->code) - 1)) & val) > 0) {
3157 /* Should be dropping the response */
3158 if (response->type == COAP_MESSAGE_ACK &&
3159 COAP_PROTO_NOT_RELIABLE(session->proto)) {
3160 /* Still need to ACK the request */
3161 response->code = 0;
3162 /* Remove token/data from piggybacked acknowledgment PDU */
3163 response->actual_token.length = 0;
3164 response->e_token_length = 0;
3165 response->used_size = 0;
3166 response->data = NULL;
3167 return RESPONSE_SEND;
3168 } else {
3169 return RESPONSE_DROP;
3170 }
3171 } else {
3172 /* True for mcast as well RFC7967 2.1 */
3173 return RESPONSE_SEND;
3174 }
3175 } else if (resource && session->context->mcast_per_resource &&
3176 coap_is_mcast(&session->addr_info.local)) {
3177 /* Handle any mcast suppression specifics if no NoResponse option */
3178 if ((resource->flags &
3180 COAP_RESPONSE_CLASS(response->code) == 2) {
3181 return RESPONSE_DROP;
3182 } else if ((resource->flags &
3184 response->code == COAP_RESPONSE_CODE(205)) {
3185 if (response->data == NULL)
3186 return RESPONSE_DROP;
3187 } else if ((resource->flags &
3189 COAP_RESPONSE_CLASS(response->code) == 4) {
3190 return RESPONSE_DROP;
3191 } else if ((resource->flags &
3193 COAP_RESPONSE_CLASS(response->code) == 5) {
3194 return RESPONSE_DROP;
3195 }
3196 }
3197 } else if (COAP_PDU_IS_EMPTY(response) &&
3198 (response->type == COAP_MESSAGE_NON ||
3199 COAP_PROTO_RELIABLE(session->proto))) {
3200 /* response is 0.00, and this is reliable or non-confirmable */
3201 return RESPONSE_DROP;
3202 }
3203
3204 /*
3205 * Do not send error responses for requests that were received via
3206 * IP multicast. RFC7252 8.1
3207 */
3208
3209 if (coap_is_mcast(&session->addr_info.local)) {
3210 if (request->type == COAP_MESSAGE_NON &&
3211 response->type == COAP_MESSAGE_RST)
3212 return RESPONSE_DROP;
3213
3214 if ((!resource || session->context->mcast_per_resource == 0) &&
3215 COAP_RESPONSE_CLASS(response->code) > 2)
3216 return RESPONSE_DROP;
3217 }
3218
3219 /* Default behavior applies when we are not dealing with a response
3220 * (class == 0) or the request did not contain a No-Response option.
3221 */
3222 return RESPONSE_DEFAULT;
3223}
3224
3225static coap_str_const_t coap_default_uri_wellknown = {
3227 (const uint8_t *)COAP_DEFAULT_URI_WELLKNOWN
3228};
3229
3230/* Initialized in coap_startup() */
3231static coap_resource_t resource_uri_wellknown;
3232
3233static void
3234handle_request(coap_context_t *context, coap_session_t *session, coap_pdu_t *pdu,
3235 coap_pdu_t *orig_pdu) {
3236 coap_method_handler_t h = NULL;
3237 coap_pdu_t *response = NULL;
3238 coap_opt_filter_t opt_filter;
3239 coap_resource_t *resource = NULL;
3240 /* The respond field indicates whether a response must be treated
3241 * specially due to a No-Response option that declares disinterest
3242 * or interest in a specific response class. DEFAULT indicates that
3243 * No-Response has not been specified. */
3244 enum respond_t respond = RESPONSE_DEFAULT;
3245 coap_opt_iterator_t opt_iter;
3246 coap_opt_t *opt;
3247 int is_proxy_uri = 0;
3248 int is_proxy_scheme = 0;
3249 int skip_hop_limit_check = 0;
3250 int resp = 0;
3251 int send_early_empty_ack = 0;
3252 coap_string_t *query = NULL;
3253 coap_opt_t *observe = NULL;
3254 coap_string_t *uri_path = NULL;
3255 int observe_action = COAP_OBSERVE_CANCEL;
3256 coap_block_b_t block;
3257 int added_block = 0;
3258 coap_lg_srcv_t *free_lg_srcv = NULL;
3259#if COAP_Q_BLOCK_SUPPORT
3260 int lg_xmit_ctrl = 0;
3261#endif /* COAP_Q_BLOCK_SUPPORT */
3262#if COAP_ASYNC_SUPPORT
3263 coap_async_t *async;
3264#endif /* COAP_ASYNC_SUPPORT */
3265
3266 if (coap_is_mcast(&session->addr_info.local)) {
3267 if (COAP_PROTO_RELIABLE(session->proto) || pdu->type != COAP_MESSAGE_NON) {
3268 coap_log_info("Invalid multicast packet received RFC7252 8.1\n");
3269 return;
3270 }
3271 }
3272#if COAP_ASYNC_SUPPORT
3273 async = coap_find_async_lkd(session, pdu->actual_token);
3274 if (async) {
3275 coap_tick_t now;
3276
3277 coap_ticks(&now);
3278 if (async->delay == 0 || async->delay > now) {
3279 /* re-transmit missing ACK (only if CON) */
3280 coap_log_info("Retransmit async response\n");
3281 coap_send_ack_lkd(session, pdu);
3282 /* and do not pass on to the upper layers */
3283 return;
3284 }
3285 }
3286#endif /* COAP_ASYNC_SUPPORT */
3287
3288 coap_option_filter_clear(&opt_filter);
3289 if (!(context->unknown_resource && context->unknown_resource->is_reverse_proxy)) {
3290 opt = coap_check_option(pdu, COAP_OPTION_PROXY_SCHEME, &opt_iter);
3291 if (opt) {
3292 opt = coap_check_option(pdu, COAP_OPTION_URI_HOST, &opt_iter);
3293 if (!opt) {
3294 coap_log_debug("Proxy-Scheme requires Uri-Host\n");
3295 resp = 402;
3296 goto fail_response;
3297 }
3298 is_proxy_scheme = 1;
3299 }
3300
3301 opt = coap_check_option(pdu, COAP_OPTION_PROXY_URI, &opt_iter);
3302 if (opt)
3303 is_proxy_uri = 1;
3304 }
3305
3306 if (is_proxy_scheme || is_proxy_uri) {
3307 coap_uri_t uri;
3308
3309 if (!context->proxy_uri_resource) {
3310 /* Need to return a 5.05 RFC7252 Section 5.7.2 */
3311 coap_log_debug("Proxy-%s support not configured\n",
3312 is_proxy_scheme ? "Scheme" : "Uri");
3313 resp = 505;
3314 goto fail_response;
3315 }
3316 if (((size_t)pdu->code - 1 <
3317 (sizeof(resource->handler) / sizeof(resource->handler[0]))) &&
3318 !(context->proxy_uri_resource->handler[pdu->code - 1])) {
3319 /* Need to return a 5.05 RFC7252 Section 5.7.2 */
3320 coap_log_debug("Proxy-%s code %d.%02d handler not supported\n",
3321 is_proxy_scheme ? "Scheme" : "Uri",
3322 pdu->code/100, pdu->code%100);
3323 resp = 505;
3324 goto fail_response;
3325 }
3326
3327 /* Need to check if authority is the proxy endpoint RFC7252 Section 5.7.2 */
3328 if (is_proxy_uri) {
3330 coap_opt_length(opt), &uri) < 0) {
3331 /* Need to return a 5.05 RFC7252 Section 5.7.2 */
3332 coap_log_debug("Proxy-URI not decodable\n");
3333 resp = 505;
3334 goto fail_response;
3335 }
3336 } else {
3337 memset(&uri, 0, sizeof(uri));
3338 opt = coap_check_option(pdu, COAP_OPTION_URI_HOST, &opt_iter);
3339 if (opt) {
3340 uri.host.length = coap_opt_length(opt);
3341 uri.host.s = coap_opt_value(opt);
3342 } else
3343 uri.host.length = 0;
3344 }
3345
3346 resource = context->proxy_uri_resource;
3347 if (uri.host.length && resource->proxy_name_count &&
3348 resource->proxy_name_list) {
3349 size_t i;
3350
3351 if (resource->proxy_name_count == 1 &&
3352 resource->proxy_name_list[0]->length == 0) {
3353 /* If proxy_name_list[0] is zero length, then this is the endpoint */
3354 i = 0;
3355 } else {
3356 for (i = 0; i < resource->proxy_name_count; i++) {
3357 if (coap_string_equal(&uri.host, resource->proxy_name_list[i])) {
3358 break;
3359 }
3360 }
3361 }
3362 if (i != resource->proxy_name_count) {
3363 /* This server is hosting the proxy connection endpoint */
3364 if (pdu->crit_opt) {
3365 /* Cannot handle critical option */
3366 pdu->crit_opt = 0;
3367 resp = 402;
3368 goto fail_response;
3369 }
3370 is_proxy_uri = 0;
3371 is_proxy_scheme = 0;
3372 skip_hop_limit_check = 1;
3373 }
3374 }
3375 resource = NULL;
3376 }
3377
3378 if (!skip_hop_limit_check) {
3379 opt = coap_check_option(pdu, COAP_OPTION_HOP_LIMIT, &opt_iter);
3380 if (opt) {
3381 size_t hop_limit;
3382 uint8_t buf[4];
3383
3384 hop_limit =
3386 if (hop_limit == 1) {
3387 /* coap_send_internal() will fill in the IP address for us */
3388 resp = 508;
3389 goto fail_response;
3390 } else if (hop_limit < 1 || hop_limit > 255) {
3391 /* Need to return a 4.00 RFC8768 Section 3 */
3392 coap_log_info("Invalid Hop Limit\n");
3393 resp = 400;
3394 goto fail_response;
3395 }
3396 hop_limit--;
3398 coap_encode_var_safe8(buf, sizeof(buf), hop_limit),
3399 buf);
3400 }
3401 }
3402
3403 uri_path = coap_get_uri_path(pdu);
3404 if (!uri_path)
3405 return;
3406
3407 if (!is_proxy_uri && !is_proxy_scheme) {
3408 /* try to find the resource from the request URI */
3409 coap_str_const_t uri_path_c = { uri_path->length, uri_path->s };
3410 resource = coap_get_resource_from_uri_path_lkd(context, &uri_path_c);
3411 }
3412
3413 if ((resource == NULL) || (resource->is_unknown == 1) ||
3414 (resource->is_proxy_uri == 1)) {
3415 /* The resource was not found or there is an unexpected match against the
3416 * resource defined for handling unknown or proxy URIs.
3417 */
3418 if (resource != NULL)
3419 /* Close down unexpected match */
3420 resource = NULL;
3421 /*
3422 * Check if the request URI happens to be the well-known URI, or if the
3423 * unknown resource handler is defined, a PUT or optionally other methods,
3424 * if configured, for the unknown handler.
3425 *
3426 * if a PROXY URI/Scheme request and proxy URI handler defined, call the
3427 * proxy URI handler.
3428 *
3429 * else if unknown URI handler defined and COAP_RESOURCE_HANDLE_WELLKNOWN_CORE
3430 * set, call the unknown URI handler with any unknown URI (including
3431 * .well-known/core) if the appropriate method is defined.
3432 *
3433 * else if well-known URI generate a default response.
3434 *
3435 * else if unknown URI handler defined, call the unknown
3436 * URI handler (to allow for potential generation of resource
3437 * [RFC7272 5.8.3]) if the appropriate method is defined.
3438 *
3439 * else if DELETE return 2.02 (RFC7252: 5.8.4. DELETE).
3440 *
3441 * else return 4.04.
3442 */
3443
3444 if (is_proxy_uri || is_proxy_scheme) {
3445 resource = context->proxy_uri_resource;
3446 } else if (context->unknown_resource != NULL &&
3448 ((size_t)pdu->code - 1 <
3449 (sizeof(resource->handler) / sizeof(coap_method_handler_t))) &&
3450 (context->unknown_resource->handler[pdu->code - 1])) {
3451 resource = context->unknown_resource;
3452 } else if (coap_string_equal(uri_path, &coap_default_uri_wellknown)) {
3453 /* request for .well-known/core */
3454 resource = &resource_uri_wellknown;
3455 } else if ((context->unknown_resource != NULL) &&
3456 ((size_t)pdu->code - 1 <
3457 (sizeof(resource->handler) / sizeof(coap_method_handler_t))) &&
3458 (context->unknown_resource->handler[pdu->code - 1])) {
3459 /*
3460 * The unknown_resource can be used to handle undefined resources
3461 * for a PUT request and can support any other registered handler
3462 * defined for it
3463 * Example set up code:-
3464 * r = coap_resource_unknown_init(hnd_put_unknown);
3465 * coap_register_request_handler(r, COAP_REQUEST_POST,
3466 * hnd_post_unknown);
3467 * coap_register_request_handler(r, COAP_REQUEST_GET,
3468 * hnd_get_unknown);
3469 * coap_register_request_handler(r, COAP_REQUEST_DELETE,
3470 * hnd_delete_unknown);
3471 * coap_add_resource(ctx, r);
3472 *
3473 * Note: It is not possible to observe the unknown_resource, a separate
3474 * resource must be created (by PUT or POST) which has a GET
3475 * handler to be observed
3476 */
3477 resource = context->unknown_resource;
3478 } else if (pdu->code == COAP_REQUEST_CODE_DELETE) {
3479 /*
3480 * Request for DELETE on non-existant resource (RFC7252: 5.8.4. DELETE)
3481 */
3482 coap_log_debug("request for unknown resource '%*.*s',"
3483 " return 2.02\n",
3484 (int)uri_path->length,
3485 (int)uri_path->length,
3486 uri_path->s);
3487 resp = 202;
3488 goto fail_response;
3489 } else { /* request for any another resource, return 4.04 */
3490
3491 coap_log_debug("request for unknown resource '%*.*s', return 4.04\n",
3492 (int)uri_path->length, (int)uri_path->length, uri_path->s);
3493 resp = 404;
3494 goto fail_response;
3495 }
3496
3497 }
3498
3499#if COAP_OSCORE_SUPPORT
3500 if ((resource->flags & COAP_RESOURCE_FLAGS_OSCORE_ONLY) && !session->oscore_encryption) {
3501 coap_log_debug("request for OSCORE only resource '%*.*s', return 4.04\n",
3502 (int)uri_path->length, (int)uri_path->length, uri_path->s);
3503 resp = 401;
3504 goto fail_response;
3505 }
3506#endif /* COAP_OSCORE_SUPPORT */
3507 if (resource->is_unknown == 0 && resource->is_proxy_uri == 0) {
3508 /* Check for existing resource and If-Non-Match */
3509 opt = coap_check_option(pdu, COAP_OPTION_IF_NONE_MATCH, &opt_iter);
3510 if (opt) {
3511 resp = 412;
3512 goto fail_response;
3513 }
3514 }
3515
3516 /* the resource was found, check if there is a registered handler */
3517 if ((size_t)pdu->code - 1 <
3518 sizeof(resource->handler) / sizeof(coap_method_handler_t))
3519 h = resource->handler[pdu->code - 1];
3520
3521 if (h == NULL) {
3522 resp = 405;
3523 goto fail_response;
3524 }
3525 if (pdu->code == COAP_REQUEST_CODE_FETCH) {
3526 opt = coap_check_option(pdu, COAP_OPTION_CONTENT_FORMAT, &opt_iter);
3527 if (opt == NULL) {
3528 /* RFC 8132 2.3.1 */
3529 resp = 415;
3530 goto fail_response;
3531 }
3532 }
3533 if (context->mcast_per_resource &&
3534 (resource->flags & COAP_RESOURCE_FLAGS_HAS_MCAST_SUPPORT) == 0 &&
3535 coap_is_mcast(&session->addr_info.local)) {
3536 resp = 405;
3537 goto fail_response;
3538 }
3539
3540 response = coap_pdu_init(pdu->type == COAP_MESSAGE_CON ?
3542 0, pdu->mid, coap_session_max_pdu_size_lkd(session));
3543 if (!response) {
3544 coap_log_err("could not create response PDU\n");
3545 resp = 500;
3546 goto fail_response;
3547 }
3548 response->session = session;
3549#if COAP_ASYNC_SUPPORT
3550 /* If handling a separate response, need CON, not ACK response */
3551 if (async && pdu->type == COAP_MESSAGE_CON)
3552 response->type = COAP_MESSAGE_CON;
3553#endif /* COAP_ASYNC_SUPPORT */
3554 /* A lot of the reliable code assumes type is CON */
3555 if (COAP_PROTO_RELIABLE(session->proto) && response->type != COAP_MESSAGE_CON)
3556 response->type = COAP_MESSAGE_CON;
3557
3558 if (!coap_add_token(response, pdu->actual_token.length,
3559 pdu->actual_token.s)) {
3560 resp = 500;
3561 goto fail_response;
3562 }
3563
3564 query = coap_get_query(pdu);
3565
3566 /* check for Observe option RFC7641 and RFC8132 */
3567 if (resource->observable &&
3568 (pdu->code == COAP_REQUEST_CODE_GET ||
3569 pdu->code == COAP_REQUEST_CODE_FETCH)) {
3570 observe = coap_check_option(pdu, COAP_OPTION_OBSERVE, &opt_iter);
3571 }
3572
3573 /*
3574 * See if blocks need to be aggregated or next requests sent off
3575 * before invoking application request handler
3576 */
3577 if (session->block_mode & COAP_BLOCK_USE_LIBCOAP) {
3578 uint32_t block_mode = session->block_mode;
3579
3580 if (observe ||
3583 if (coap_handle_request_put_block(context, session, pdu, response,
3584 resource, uri_path, observe,
3585 &added_block, &free_lg_srcv)) {
3586 session->block_mode = block_mode;
3587 goto skip_handler;
3588 }
3589 session->block_mode = block_mode;
3590
3591 if (coap_handle_request_send_block(session, pdu, response, resource,
3592 query)) {
3593#if COAP_Q_BLOCK_SUPPORT
3594 lg_xmit_ctrl = 1;
3595#endif /* COAP_Q_BLOCK_SUPPORT */
3596 goto skip_handler;
3597 }
3598 }
3599
3600 if (observe) {
3601 observe_action =
3603 coap_opt_length(observe));
3604
3605 if (observe_action == COAP_OBSERVE_ESTABLISH) {
3606 coap_subscription_t *subscription;
3607
3608 if (coap_get_block_b(session, pdu, COAP_OPTION_BLOCK2, &block)) {
3609 if (block.num != 0) {
3610 response->code = COAP_RESPONSE_CODE(400);
3611 goto skip_handler;
3612 }
3613#if COAP_Q_BLOCK_SUPPORT
3614 } else if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK2,
3615 &block)) {
3616 if (block.num != 0) {
3617 response->code = COAP_RESPONSE_CODE(400);
3618 goto skip_handler;
3619 }
3620#endif /* COAP_Q_BLOCK_SUPPORT */
3621 }
3622 subscription = coap_add_observer(resource, session, &pdu->actual_token,
3623 pdu);
3624 if (subscription) {
3625 uint8_t buf[4];
3626
3627 coap_touch_observer(context, session, &pdu->actual_token);
3629 coap_encode_var_safe(buf, sizeof(buf),
3630 resource->observe),
3631 buf);
3632 }
3633 } else if (observe_action == COAP_OBSERVE_CANCEL) {
3634 coap_delete_observer_request(resource, session, &pdu->actual_token, pdu);
3635 } else {
3636 coap_log_info("observe: unexpected action %d\n", observe_action);
3637 }
3638 }
3639
3640 if (resource == context->proxy_uri_resource &&
3641 COAP_PROTO_NOT_RELIABLE(session->proto) &&
3642 pdu->type == COAP_MESSAGE_CON &&
3643 !(session->block_mode & COAP_BLOCK_CACHE_RESPONSE)) {
3644 /* Make the proxy response separate and fix response later */
3645 send_early_empty_ack = 1;
3646 }
3647 if (send_early_empty_ack) {
3648 coap_send_ack_lkd(session, pdu);
3649 if (pdu->mid == session->last_con_mid) {
3650 /* request has already been processed - do not process it again */
3651 coap_log_debug("Duplicate request with mid=0x%04x - not processed\n",
3652 pdu->mid);
3653 goto drop_it_no_debug;
3654 }
3655 session->last_con_mid = pdu->mid;
3656 }
3657#if COAP_WITH_OBSERVE_PERSIST
3658 /* If we are maintaining Observe persist */
3659 if (resource == context->unknown_resource) {
3660 context->unknown_pdu = pdu;
3661 context->unknown_session = session;
3662 } else
3663 context->unknown_pdu = NULL;
3664#endif /* COAP_WITH_OBSERVE_PERSIST */
3665
3666 /*
3667 * Call the request handler with everything set up
3668 */
3669 if (resource == &resource_uri_wellknown) {
3670 /* Leave context locked */
3671 coap_log_debug("call handler for pseudo resource '%*.*s' (3)\n",
3672 (int)resource->uri_path->length, (int)resource->uri_path->length,
3673 resource->uri_path->s);
3674 h(resource, session, pdu, query, response);
3675 } else {
3676 coap_log_debug("call custom handler for resource '%*.*s' (3)\n",
3677 (int)resource->uri_path->length, (int)resource->uri_path->length,
3678 resource->uri_path->s);
3680 h(resource, session, pdu, query, response),
3681 /* context is being freed off */
3682 goto finish);
3683 }
3684
3685 /* Check validity of response code */
3686 if (!coap_check_code_class(session, response)) {
3687 coap_log_warn("handle_request: Invalid PDU response code (%d.%02d)\n",
3688 COAP_RESPONSE_CLASS(response->code),
3689 response->code & 0x1f);
3690 goto drop_it_no_debug;
3691 }
3692
3693 /* Check if lg_xmit generated and update PDU code if so */
3694 coap_check_code_lg_xmit(session, pdu, response, resource, query);
3695
3696 if (free_lg_srcv) {
3697 /* Check to see if the server is doing a 4.01 + Echo response */
3698 if (response->code == COAP_RESPONSE_CODE(401) &&
3699 coap_check_option(response, COAP_OPTION_ECHO, &opt_iter)) {
3700 /* Need to keep lg_srcv around for client's response */
3701 } else {
3702 LL_DELETE(session->lg_srcv, free_lg_srcv);
3703 coap_block_delete_lg_srcv(session, free_lg_srcv);
3704 }
3705 }
3706 if (added_block && COAP_RESPONSE_CLASS(response->code) == 2) {
3707 /* Just in case, as there are more to go */
3708 response->code = COAP_RESPONSE_CODE(231);
3709 }
3710
3711skip_handler:
3712 if (send_early_empty_ack &&
3713 response->type == COAP_MESSAGE_ACK) {
3714 /* Response is now separate - convert to CON as needed */
3715 response->type = COAP_MESSAGE_CON;
3716 /* Check for empty ACK - need to drop as already sent */
3717 if (response->code == 0) {
3718 goto drop_it_no_debug;
3719 }
3720 }
3721 respond = no_response(pdu, response, session, resource);
3722 if (respond != RESPONSE_DROP) {
3723#if (COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG)
3724 coap_mid_t mid = pdu->mid;
3725#endif
3726 if (COAP_RESPONSE_CLASS(response->code) != 2) {
3727 if (observe) {
3729 }
3730 }
3731 if (COAP_RESPONSE_CLASS(response->code) > 2) {
3732 if (observe)
3733 coap_delete_observer(resource, session, &pdu->actual_token);
3734 if (response->code != COAP_RESPONSE_CODE(413))
3736 }
3737
3738 /* If original request contained a token, and the registered
3739 * application handler made no changes to the response, then
3740 * this is an empty ACK with a token, which is a malformed
3741 * PDU */
3742 if ((response->type == COAP_MESSAGE_ACK)
3743 && (response->code == 0)) {
3744 /* Remove token from otherwise-empty acknowledgment PDU */
3745 response->actual_token.length = 0;
3746 response->e_token_length = 0;
3747 response->used_size = 0;
3748 response->data = NULL;
3749 }
3750
3751 if (!coap_is_mcast(&session->addr_info.local) ||
3752 (context->mcast_per_resource &&
3753 resource &&
3755 /* No delays to response */
3756#if COAP_Q_BLOCK_SUPPORT
3757 if (session->block_mode & COAP_BLOCK_USE_LIBCOAP &&
3758 !lg_xmit_ctrl && response->code == COAP_RESPONSE_CODE(205) &&
3759 coap_get_block_b(session, response, COAP_OPTION_Q_BLOCK2, &block) &&
3760 block.m) {
3761 if (coap_send_q_block2(session, resource, query, pdu->code, block,
3762 response,
3763 COAP_SEND_INC_PDU) == COAP_INVALID_MID)
3764 coap_log_debug("cannot send response for mid=0x%x\n", mid);
3765 response = NULL;
3766 if (query)
3767 coap_delete_string(query);
3768 goto finish;
3769 }
3770#endif /* COAP_Q_BLOCK_SUPPORT */
3771 if (coap_send_internal(session, response, orig_pdu ? orig_pdu : pdu) == COAP_INVALID_MID) {
3772 coap_log_debug("cannot send response for mid=0x%04x\n", mid);
3773 }
3774 } else {
3775 /* Need to delay mcast response */
3776 coap_queue_t *node = coap_new_node();
3777 uint8_t r;
3778 coap_tick_t delay;
3779
3780 if (!node) {
3781 coap_log_debug("mcast delay: insufficient memory\n");
3782 goto drop_it_no_debug;
3783 }
3784 if (!coap_pdu_encode_header(response, session->proto)) {
3786 goto drop_it_no_debug;
3787 }
3788
3789 node->id = response->mid;
3790 node->pdu = response;
3791 node->is_mcast = 1;
3792 coap_prng_lkd(&r, sizeof(r));
3793 delay = (COAP_DEFAULT_LEISURE_TICKS(session) * r) / 256;
3794 coap_log_debug(" %s: mid=0x%04x: mcast response delayed for %u.%03u secs\n",
3795 coap_session_str(session),
3796 response->mid,
3797 (unsigned int)(delay / COAP_TICKS_PER_SECOND),
3798 (unsigned int)((delay % COAP_TICKS_PER_SECOND) *
3799 1000 / COAP_TICKS_PER_SECOND));
3800 node->timeout = (unsigned int)delay;
3801 /* Use this to delay transmission */
3802 coap_wait_ack(session->context, session, node);
3803 }
3804 } else {
3805 coap_log_debug(" %s: mid=0x%04x: response dropped\n",
3806 coap_session_str(session),
3807 response->mid);
3808 coap_show_pdu(COAP_LOG_DEBUG, response);
3809drop_it_no_debug:
3810 coap_delete_pdu_lkd(response);
3811 }
3812 if (query)
3813 coap_delete_string(query);
3814#if COAP_Q_BLOCK_SUPPORT
3815 if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK1, &block)) {
3816 if (COAP_PROTO_RELIABLE(session->proto)) {
3817 if (block.m) {
3818 /* All of the sequence not in yet */
3819 goto finish;
3820 }
3821 } else if (pdu->type == COAP_MESSAGE_NON) {
3822 /* More to go and not at a payload break */
3823 if (block.m && ((block.num + 1) % COAP_MAX_PAYLOADS(session))) {
3824 goto finish;
3825 }
3826 }
3827 }
3828#endif /* COAP_Q_BLOCK_SUPPORT */
3829
3830#if COAP_Q_BLOCK_SUPPORT || COAP_THREAD_SAFE
3831finish:
3832#endif /* COAP_Q_BLOCK_SUPPORT || COAP_THREAD_SAFE */
3833 coap_delete_string(uri_path);
3834 return;
3835
3836fail_response:
3837 coap_delete_pdu_lkd(response);
3838 response =
3840 &opt_filter);
3841 if (response)
3842 goto skip_handler;
3843 coap_delete_string(uri_path);
3844}
3845#endif /* COAP_SERVER_SUPPORT */
3846
3847#if COAP_CLIENT_SUPPORT
3848static void
3849handle_response(coap_context_t *context, coap_session_t *session,
3850 coap_pdu_t *sent, coap_pdu_t *rcvd) {
3851
3852 /* Set in case there is a later call to coap_update_token() */
3853 rcvd->session = session;
3854
3855 /* In a lossy context, the ACK of a separate response may have
3856 * been lost, so we need to stop retransmitting requests with the
3857 * same token. Matching on token potentially containing ext length bytes.
3858 */
3859 if (rcvd->type != COAP_MESSAGE_ACK)
3860 coap_cancel_all_messages(context, session, &rcvd->actual_token);
3861
3862 /* Check for message duplication */
3863 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
3864 if (rcvd->type == COAP_MESSAGE_CON) {
3865 if (rcvd->mid == session->last_con_mid) {
3866 /* Duplicate response: send ACK/RST, but don't process */
3867 if (session->last_con_handler_res == COAP_RESPONSE_OK)
3868 coap_send_ack_lkd(session, rcvd);
3869 else
3870 coap_send_rst_lkd(session, rcvd);
3871 return;
3872 }
3873 session->last_con_mid = rcvd->mid;
3874 } else if (rcvd->type == COAP_MESSAGE_ACK) {
3875 if (rcvd->mid == session->last_ack_mid) {
3876 /* Duplicate response */
3877 return;
3878 }
3879 session->last_ack_mid = rcvd->mid;
3880 }
3881 }
3882 /* Check to see if checking out extended token support */
3883 if (session->max_token_checked == COAP_EXT_T_CHECKING &&
3884 session->remote_test_mid == rcvd->mid) {
3885
3886 if (rcvd->actual_token.length != session->max_token_size ||
3887 rcvd->code == COAP_RESPONSE_CODE(400) ||
3888 rcvd->code == COAP_RESPONSE_CODE(503)) {
3889 coap_log_debug("Extended Token requested size support not available\n");
3891 } else {
3892 coap_log_debug("Extended Token support available\n");
3893 }
3895 session->doing_first = 0;
3896 return;
3897 }
3898#if COAP_Q_BLOCK_SUPPORT
3899 /* Check to see if checking out Q-Block support */
3900 if (session->block_mode & COAP_BLOCK_PROBE_Q_BLOCK &&
3901 session->remote_test_mid == rcvd->mid) {
3902 if (rcvd->code == COAP_RESPONSE_CODE(402)) {
3903 coap_log_debug("Q-Block support not available\n");
3904 set_block_mode_drop_q(session->block_mode);
3905 } else {
3906 coap_block_b_t qblock;
3907
3908 if (coap_get_block_b(session, rcvd, COAP_OPTION_Q_BLOCK2, &qblock)) {
3909 coap_log_debug("Q-Block support available\n");
3910 set_block_mode_has_q(session->block_mode);
3911 } else {
3912 coap_log_debug("Q-Block support not available\n");
3913 set_block_mode_drop_q(session->block_mode);
3914 }
3915 }
3916 session->doing_first = 0;
3917 return;
3918 }
3919#endif /* COAP_Q_BLOCK_SUPPORT */
3920
3921 if (session->block_mode & COAP_BLOCK_USE_LIBCOAP) {
3922 /* See if need to send next block to server */
3923 if (coap_handle_response_send_block(session, sent, rcvd)) {
3924 /* Next block transmitted, no need to inform app */
3925 coap_send_ack_lkd(session, rcvd);
3926 return;
3927 }
3928
3929 /* Need to see if needing to request next block */
3930 if (coap_handle_response_get_block(context, session, sent, rcvd,
3931 COAP_RECURSE_OK)) {
3932 /* Next block transmitted, ack sent no need to inform app */
3933 return;
3934 }
3935 }
3936 if (session->doing_first)
3937 session->doing_first = 0;
3938
3939 /* Call application-specific response handler when available. */
3940 if (session->doing_send_recv && session->req_token &&
3941 coap_binary_equal(session->req_token, &rcvd->actual_token)) {
3942 /* processing coap_send_recv() call */
3943 session->resp_pdu = rcvd;
3945 coap_send_ack_lkd(session, rcvd);
3947 } else if (context->response_handler) {
3948 coap_response_t ret;
3949
3950 coap_lock_callback_ret_release(ret, context,
3951 context->response_handler(session, sent, rcvd,
3952 rcvd->mid),
3953 /* context is being freed off */
3954 return);
3955 if (ret == COAP_RESPONSE_FAIL && rcvd->type != COAP_MESSAGE_ACK) {
3956 coap_send_rst_lkd(session, rcvd);
3958 } else {
3959 coap_send_ack_lkd(session, rcvd);
3961 }
3962 } else {
3963 coap_send_ack_lkd(session, rcvd);
3965 }
3966}
3967#endif /* COAP_CLIENT_SUPPORT */
3968
3969#if !COAP_DISABLE_TCP
3970static void
3972 coap_pdu_t *pdu) {
3973 coap_opt_iterator_t opt_iter;
3974 coap_opt_t *option;
3975 int set_mtu = 0;
3976
3977 coap_option_iterator_init(pdu, &opt_iter, COAP_OPT_ALL);
3978
3979 if (pdu->code == COAP_SIGNALING_CODE_CSM) {
3980 if (session->csm_not_seen) {
3981 coap_tick_t now;
3982
3983 coap_ticks(&now);
3984 /* CSM timeout before CSM seen */
3985 coap_log_warn("***%s: CSM received after CSM timeout\n",
3986 coap_session_str(session));
3987 coap_log_warn("***%s: Increase timeout in coap_context_set_csm_timeout_ms() to > %d\n",
3988 coap_session_str(session),
3989 (int)(((now - session->csm_tx) * 1000) / COAP_TICKS_PER_SECOND));
3990 }
3991 if (session->max_token_checked == COAP_EXT_T_NOT_CHECKED) {
3993 }
3994 while ((option = coap_option_next(&opt_iter))) {
3997 coap_opt_length(option)));
3998 set_mtu = 1;
3999 } else if (opt_iter.number == COAP_SIGNALING_OPTION_BLOCK_WISE_TRANSFER) {
4000 session->csm_block_supported = 1;
4001 } else if (opt_iter.number == COAP_SIGNALING_OPTION_EXTENDED_TOKEN_LENGTH) {
4002 session->max_token_size =
4004 coap_opt_length(option));
4007 else if (session->max_token_size > COAP_TOKEN_EXT_MAX)
4010 }
4011 }
4012 if (set_mtu) {
4013 if (session->mtu > COAP_BERT_BASE && session->csm_block_supported)
4014 session->csm_bert_rem_support = 1;
4015 else
4016 session->csm_bert_rem_support = 0;
4017 }
4018 if (session->state == COAP_SESSION_STATE_CSM)
4019 coap_session_connected(session);
4020 } else if (pdu->code == COAP_SIGNALING_CODE_PING) {
4022 if (context->ping_handler) {
4023 coap_lock_callback(context,
4024 context->ping_handler(session, pdu, pdu->mid));
4025 }
4026 if (pong) {
4028 coap_send_internal(session, pong, NULL);
4029 }
4030 } else if (pdu->code == COAP_SIGNALING_CODE_PONG) {
4031 session->last_pong = session->last_rx_tx;
4032 if (context->pong_handler) {
4033 coap_lock_callback(context,
4034 context->pong_handler(session, pdu, pdu->mid));
4035 }
4036 } else if (pdu->code == COAP_SIGNALING_CODE_RELEASE
4037 || pdu->code == COAP_SIGNALING_CODE_ABORT) {
4039 }
4040}
4041#endif /* !COAP_DISABLE_TCP */
4042
4043static int
4045 if (COAP_PDU_IS_REQUEST(pdu) &&
4046 pdu->actual_token.length >
4047 (session->type == COAP_SESSION_TYPE_CLIENT ?
4048 session->max_token_size : session->context->max_token_size)) {
4049 /* https://rfc-editor.org/rfc/rfc8974#section-2.2.2 */
4050 if (session->max_token_size > COAP_TOKEN_DEFAULT_MAX) {
4051 coap_opt_filter_t opt_filter;
4052 coap_pdu_t *response;
4053
4054 memset(&opt_filter, 0, sizeof(coap_opt_filter_t));
4055 response = coap_new_error_response(pdu, COAP_RESPONSE_CODE(400),
4056 &opt_filter);
4057 if (!response) {
4058 coap_log_warn("coap_dispatch: cannot create error response\n");
4059 } else {
4060 /*
4061 * Note - have to leave in oversize token as per
4062 * https://rfc-editor.org/rfc/rfc7252#section-5.3.1
4063 */
4064 if (coap_send_internal(session, response, NULL) == COAP_INVALID_MID)
4065 coap_log_warn("coap_dispatch: error sending response\n");
4066 }
4067 } else {
4068 /* Indicate no extended token support */
4069 coap_send_rst_lkd(session, pdu);
4070 }
4071 return 0;
4072 }
4073 return 1;
4074}
4075
4076void
4078 coap_pdu_t *pdu) {
4079 coap_queue_t *sent = NULL;
4080 coap_pdu_t *response;
4081 coap_pdu_t *orig_pdu = NULL;
4082 coap_opt_filter_t opt_filter;
4083 int is_ping_rst;
4084 int packet_is_bad = 0;
4085#if COAP_OSCORE_SUPPORT
4086 coap_opt_iterator_t opt_iter;
4087 coap_pdu_t *dec_pdu = NULL;
4088#endif /* COAP_OSCORE_SUPPORT */
4089 int is_ext_token_rst;
4090
4091 pdu->session = session;
4093
4094 /* Check validity of received code */
4095 if (!coap_check_code_class(session, pdu)) {
4096 coap_log_info("coap_dispatch: Received invalid PDU code (%d.%02d)\n",
4098 pdu->code & 0x1f);
4099 packet_is_bad = 1;
4100 if (pdu->type == COAP_MESSAGE_CON) {
4102 }
4103 /* find message id in sendqueue to stop retransmission */
4104 coap_remove_from_queue(&context->sendqueue, session, pdu->mid, &sent);
4105 goto cleanup;
4106 }
4107
4108 coap_option_filter_clear(&opt_filter);
4109
4110#if COAP_SERVER_SUPPORT
4111 /* See if this a repeat request */
4112 if (COAP_PDU_IS_REQUEST(pdu) && session->cached_pdu &&
4114 coap_digest_t digest;
4115
4116 coap_pdu_cksum(pdu, &digest);
4117 if (memcmp(&digest, &session->cached_pdu_cksum, sizeof(digest)) == 0) {
4118#if COAP_OSCORE_SUPPORT
4119 uint8_t oscore_encryption = session->oscore_encryption;
4120
4121 session->oscore_encryption = 0;
4122#endif /* COAP_OSCORE_SUPPORT */
4123 /* Account for coap_send_internal() doing a coap_delete_pdu() and
4124 cached_pdu must not be removed */
4126 coap_log_debug("Retransmit response to duplicate request\n");
4127 if (coap_send_internal(session, session->cached_pdu, NULL) != COAP_INVALID_MID) {
4128#if COAP_OSCORE_SUPPORT
4129 session->oscore_encryption = oscore_encryption;
4130#endif /* COAP_OSCORE_SUPPORT */
4131 return;
4132 }
4133#if COAP_OSCORE_SUPPORT
4134 session->oscore_encryption = oscore_encryption;
4135#endif /* COAP_OSCORE_SUPPORT */
4136 }
4137 }
4138#endif /* COAP_SERVER_SUPPORT */
4139#if COAP_OSCORE_SUPPORT
4140 if (!COAP_PDU_IS_SIGNALING(pdu) &&
4141 coap_option_check_critical(session, pdu, &opt_filter) == 0) {
4142 if (pdu->type == COAP_MESSAGE_NON) {
4143 coap_send_rst_lkd(session, pdu);
4144 goto cleanup;
4145 } else if (pdu->type == COAP_MESSAGE_CON) {
4146 if (COAP_PDU_IS_REQUEST(pdu)) {
4147 response =
4148 coap_new_error_response(pdu, COAP_RESPONSE_CODE(402), &opt_filter);
4149
4150 if (!response) {
4151 coap_log_warn("coap_dispatch: cannot create error response\n");
4152 } else {
4153 if (coap_send_internal(session, response, NULL) == COAP_INVALID_MID)
4154 coap_log_warn("coap_dispatch: error sending response\n");
4155 }
4156 } else {
4157 coap_send_rst_lkd(session, pdu);
4158 }
4159 }
4160 goto cleanup;
4161 }
4162
4163 if (coap_check_option(pdu, COAP_OPTION_OSCORE, &opt_iter) != NULL) {
4164 int decrypt = 1;
4165#if COAP_SERVER_SUPPORT
4166 coap_opt_t *opt;
4167 coap_resource_t *resource;
4168 coap_uri_t uri;
4169#endif /* COAP_SERVER_SUPPORT */
4170
4171 if (COAP_PDU_IS_RESPONSE(pdu) && !session->oscore_encryption)
4172 decrypt = 0;
4173
4174#if COAP_SERVER_SUPPORT
4175 if (decrypt && COAP_PDU_IS_REQUEST(pdu) &&
4176 coap_check_option(pdu, COAP_OPTION_PROXY_SCHEME, &opt_iter) != NULL &&
4177 (opt = coap_check_option(pdu, COAP_OPTION_URI_HOST, &opt_iter))
4178 != NULL) {
4179 /* Need to check whether this is a direct or proxy session */
4180 memset(&uri, 0, sizeof(uri));
4181 uri.host.length = coap_opt_length(opt);
4182 uri.host.s = coap_opt_value(opt);
4183 resource = context->proxy_uri_resource;
4184 if (uri.host.length && resource && resource->proxy_name_count &&
4185 resource->proxy_name_list) {
4186 size_t i;
4187 for (i = 0; i < resource->proxy_name_count; i++) {
4188 if (coap_string_equal(&uri.host, resource->proxy_name_list[i])) {
4189 break;
4190 }
4191 }
4192 if (i == resource->proxy_name_count) {
4193 /* This server is not hosting the proxy connection endpoint */
4194 decrypt = 0;
4195 }
4196 }
4197 }
4198#endif /* COAP_SERVER_SUPPORT */
4199 if (decrypt) {
4200 /* find message id in sendqueue to stop retransmission and get sent */
4201 coap_remove_from_queue(&context->sendqueue, session, pdu->mid, &sent);
4202 /* Bump ref so pdu is not freed of, and keep a pointer to it */
4203 orig_pdu = pdu;
4204 coap_pdu_reference_lkd(orig_pdu);
4205 if ((dec_pdu = coap_oscore_decrypt_pdu(session, pdu)) == NULL) {
4206 if (session->recipient_ctx == NULL ||
4207 session->recipient_ctx->initial_state == 0) {
4208 coap_log_warn("OSCORE: PDU could not be decrypted\n");
4209 }
4211 coap_delete_pdu_lkd(orig_pdu);
4212 return;
4213 } else {
4214 session->oscore_encryption = 1;
4215 pdu = dec_pdu;
4216 }
4217 coap_log_debug("Decrypted PDU\n");
4219 }
4220 }
4221#endif /* COAP_OSCORE_SUPPORT */
4222
4223 switch (pdu->type) {
4224 case COAP_MESSAGE_ACK:
4225 /* find message id in sendqueue to stop retransmission */
4226 coap_remove_from_queue(&context->sendqueue, session, pdu->mid, &sent);
4227
4228 if (sent && session->con_active) {
4229 session->con_active--;
4230 if (session->state == COAP_SESSION_STATE_ESTABLISHED)
4231 /* Flush out any entries on session->delayqueue */
4232 coap_session_connected(session);
4233 }
4234 if (coap_option_check_critical(session, pdu, &opt_filter) == 0) {
4235 packet_is_bad = 1;
4236 goto cleanup;
4237 }
4238
4239#if COAP_SERVER_SUPPORT
4240 /* if sent code was >= 64 the message might have been a
4241 * notification. Then, we must flag the observer to be alive
4242 * by setting obs->fail_cnt = 0. */
4243 if (sent && COAP_RESPONSE_CLASS(sent->pdu->code) == 2) {
4244 coap_touch_observer(context, sent->session, &sent->pdu->actual_token);
4245 }
4246#endif /* COAP_SERVER_SUPPORT */
4247
4248 if (pdu->code == 0) {
4249#if COAP_Q_BLOCK_SUPPORT
4250 if (sent) {
4251 coap_block_b_t block;
4252
4253 if (sent->pdu->type == COAP_MESSAGE_CON &&
4254 COAP_PROTO_NOT_RELIABLE(session->proto) &&
4255 coap_get_block_b(session, sent->pdu,
4256 COAP_PDU_IS_REQUEST(sent->pdu) ?
4258 &block)) {
4259 if (block.m) {
4260#if COAP_CLIENT_SUPPORT
4261 if (COAP_PDU_IS_REQUEST(sent->pdu))
4262 coap_send_q_block1(session, block, sent->pdu,
4263 COAP_SEND_SKIP_PDU);
4264#endif /* COAP_CLIENT_SUPPORT */
4265 if (COAP_PDU_IS_RESPONSE(sent->pdu))
4266 coap_send_q_blocks(session, sent->pdu->lg_xmit, block,
4267 sent->pdu, COAP_SEND_SKIP_PDU);
4268 }
4269 }
4270 }
4271#endif /* COAP_Q_BLOCK_SUPPORT */
4272#if COAP_CLIENT_SUPPORT
4273 /*
4274 * In coap_send(), lg_crcv was not set up if type is CON and protocol is not
4275 * reliable to save overhead as this can be set up on detection of a (Q)-Block2
4276 * response if the response was piggy-backed. Here, a separate response
4277 * detected and so the lg_crcv needs to be set up before the sent PDU
4278 * information is lost.
4279 *
4280 * lg_crcv was not set up if not a CoAP request or if DELETE.
4281 *
4282 * lg_crcv was always set up in coap_send() if Observe, Oscore and (Q)-Block1
4283 * options.
4284 */
4285 if (sent &&
4286 !coap_check_send_need_lg_crcv(session, pdu) &&
4287 COAP_PDU_IS_REQUEST(sent->pdu)) {
4288 /*
4289 * lg_crcv was not set up in coap_send(). It could have been set up
4290 * the first separate response.
4291 * See if there already is a lg_crcv set up.
4292 */
4293 coap_lg_crcv_t *lg_crcv;
4294 uint64_t token_match =
4296 sent->pdu->actual_token.length));
4297
4298 LL_FOREACH(session->lg_crcv, lg_crcv) {
4299 if (token_match == STATE_TOKEN_BASE(lg_crcv->state_token) ||
4300 coap_binary_equal(&sent->pdu->actual_token, lg_crcv->app_token)) {
4301 break;
4302 }
4303 }
4304 if (!lg_crcv) {
4305 /*
4306 * Need to set up a lg_crcv as it was not set up in coap_send()
4307 * to save time, but server has not sent back a piggy-back response.
4308 */
4309 lg_crcv = coap_block_new_lg_crcv(session, sent->pdu, NULL);
4310 if (lg_crcv) {
4311 LL_PREPEND(session->lg_crcv, lg_crcv);
4312 }
4313 }
4314 }
4315#endif /* COAP_CLIENT_SUPPORT */
4316 /* an empty ACK needs no further handling */
4317 goto cleanup;
4318 } else if (COAP_PDU_IS_REQUEST(pdu)) {
4319 /* This is not legitimate - Request using ACK - ignore */
4320 coap_log_debug("dropped ACK with request code (%d.%02d)\n",
4322 pdu->code & 0x1f);
4323 packet_is_bad = 1;
4324 goto cleanup;
4325 }
4326
4327 break;
4328
4329 case COAP_MESSAGE_RST:
4330 /* We have sent something the receiver disliked, so we remove
4331 * not only the message id but also the subscriptions we might
4332 * have. */
4333 is_ping_rst = 0;
4334 if (pdu->mid == session->last_ping_mid &&
4335 context->ping_timeout && session->last_ping > 0)
4336 is_ping_rst = 1;
4337
4338#if COAP_Q_BLOCK_SUPPORT
4339 /* Check to see if checking out Q-Block support */
4340 if (session->block_mode & COAP_BLOCK_PROBE_Q_BLOCK &&
4341 session->remote_test_mid == pdu->mid) {
4342 coap_log_debug("Q-Block support not available\n");
4343 set_block_mode_drop_q(session->block_mode);
4344 }
4345#endif /* COAP_Q_BLOCK_SUPPORT */
4346
4347 /* Check to see if checking out extended token support */
4348 is_ext_token_rst = 0;
4349 if (session->max_token_checked == COAP_EXT_T_CHECKING &&
4350 session->remote_test_mid == pdu->mid) {
4351 coap_log_debug("Extended Token support not available\n");
4354 session->doing_first = 0;
4355 is_ext_token_rst = 1;
4356 }
4357
4358 if (!is_ping_rst && !is_ext_token_rst)
4359 coap_log_alert("got RST for mid=0x%04x\n", pdu->mid);
4360
4361 if (session->con_active) {
4362 session->con_active--;
4363 if (session->state == COAP_SESSION_STATE_ESTABLISHED)
4364 /* Flush out any entries on session->delayqueue */
4365 coap_session_connected(session);
4366 }
4367
4368 /* find message id in sendqueue to stop retransmission */
4369 coap_remove_from_queue(&context->sendqueue, session, pdu->mid, &sent);
4370
4371 if (sent) {
4372 if (!is_ping_rst)
4373 coap_cancel(context, sent);
4374
4375 if (!is_ping_rst && !is_ext_token_rst) {
4376 if (sent->pdu->type==COAP_MESSAGE_CON) {
4377 coap_handle_nack(sent->session, sent->pdu, COAP_NACK_RST, sent->id);
4378 }
4379 } else if (is_ping_rst) {
4380 if (context->pong_handler) {
4381 coap_lock_callback(context,
4382 context->pong_handler(session, pdu, pdu->mid));
4383 }
4384 session->last_pong = session->last_rx_tx;
4386 }
4387 } else {
4388#if COAP_SERVER_SUPPORT
4389 /* Need to check is there is a subscription active and delete it */
4390 RESOURCES_ITER(context->resources, r) {
4391 coap_subscription_t *obs, *tmp;
4392 LL_FOREACH_SAFE(r->subscribers, obs, tmp) {
4393 if (obs->pdu->mid == pdu->mid && obs->session == session) {
4394 /* Need to do this now as session may get de-referenced */
4396 coap_delete_observer(r, session, &obs->pdu->actual_token);
4397 coap_handle_nack(session, NULL, COAP_NACK_RST, pdu->mid);
4398 coap_session_release_lkd(session);
4399 goto cleanup;
4400 }
4401 }
4402 }
4403#endif /* COAP_SERVER_SUPPORT */
4404 coap_handle_nack(session, NULL, COAP_NACK_RST, pdu->mid);
4405 }
4406 goto cleanup;
4407
4408 case COAP_MESSAGE_NON:
4409 /* check for unknown critical options */
4410 if (coap_option_check_critical(session, pdu, &opt_filter) == 0) {
4411 packet_is_bad = 1;
4412 coap_send_rst_lkd(session, pdu);
4413 goto cleanup;
4414 }
4415 if (!check_token_size(session, pdu)) {
4416 goto cleanup;
4417 }
4418 break;
4419
4420 case COAP_MESSAGE_CON: /* check for unknown critical options */
4421 if (!COAP_PDU_IS_SIGNALING(pdu) &&
4422 coap_option_check_critical(session, pdu, &opt_filter) == 0) {
4423 packet_is_bad = 1;
4424 if (COAP_PDU_IS_REQUEST(pdu)) {
4425 response =
4426 coap_new_error_response(pdu, COAP_RESPONSE_CODE(402), &opt_filter);
4427
4428 if (!response) {
4429 coap_log_warn("coap_dispatch: cannot create error response\n");
4430 } else {
4431 if (coap_send_internal(session, response, NULL) == COAP_INVALID_MID)
4432 coap_log_warn("coap_dispatch: error sending response\n");
4433 }
4434 } else {
4435 coap_send_rst_lkd(session, pdu);
4436 }
4437 goto cleanup;
4438 }
4439 if (!check_token_size(session, pdu)) {
4440 goto cleanup;
4441 }
4442 break;
4443 default:
4444 break;
4445 }
4446
4447 /* Pass message to upper layer if a specific handler was
4448 * registered for a request that should be handled locally. */
4449#if !COAP_DISABLE_TCP
4450 if (COAP_PDU_IS_SIGNALING(pdu))
4451 handle_signaling(context, session, pdu);
4452 else
4453#endif /* !COAP_DISABLE_TCP */
4454#if COAP_SERVER_SUPPORT
4455 if (COAP_PDU_IS_REQUEST(pdu))
4456 handle_request(context, session, pdu, orig_pdu);
4457 else
4458#endif /* COAP_SERVER_SUPPORT */
4459#if COAP_CLIENT_SUPPORT
4460 if (COAP_PDU_IS_RESPONSE(pdu))
4461 handle_response(context, session, sent ? sent->pdu : NULL, pdu);
4462 else
4463#endif /* COAP_CLIENT_SUPPORT */
4464 {
4465 if (COAP_PDU_IS_EMPTY(pdu)) {
4466 if (context->ping_handler) {
4467 coap_lock_callback(context,
4468 context->ping_handler(session, pdu, pdu->mid));
4469 }
4470 } else {
4471 packet_is_bad = 1;
4472 }
4473 coap_log_debug("dropped message with invalid code (%d.%02d)\n",
4475 pdu->code & 0x1f);
4476
4477 if (!coap_is_mcast(&session->addr_info.local)) {
4478 if (COAP_PDU_IS_EMPTY(pdu)) {
4479 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
4480 coap_tick_t now;
4481 coap_ticks(&now);
4482 if (session->last_tx_rst + COAP_TICKS_PER_SECOND/4 < now) {
4484 session->last_tx_rst = now;
4485 }
4486 }
4487 } else {
4488 if (pdu->type == COAP_MESSAGE_CON)
4490 }
4491 }
4492 }
4493
4494cleanup:
4495 if (packet_is_bad) {
4496 if (sent) {
4497 coap_handle_nack(session, sent->pdu, COAP_NACK_BAD_RESPONSE, sent->id);
4498 } else {
4500 }
4501 }
4502 coap_delete_pdu_lkd(orig_pdu);
4504#if COAP_OSCORE_SUPPORT
4505 coap_delete_pdu_lkd(dec_pdu);
4506#endif /* COAP_OSCORE_SUPPORT */
4507}
4508
4509#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
4510static const char *
4512 switch (event) {
4514 return "COAP_EVENT_DTLS_CLOSED";
4516 return "COAP_EVENT_DTLS_CONNECTED";
4518 return "COAP_EVENT_DTLS_RENEGOTIATE";
4520 return "COAP_EVENT_DTLS_ERROR";
4522 return "COAP_EVENT_TCP_CONNECTED";
4524 return "COAP_EVENT_TCP_CLOSED";
4526 return "COAP_EVENT_TCP_FAILED";
4528 return "COAP_EVENT_SESSION_CONNECTED";
4530 return "COAP_EVENT_SESSION_CLOSED";
4532 return "COAP_EVENT_SESSION_FAILED";
4534 return "COAP_EVENT_PARTIAL_BLOCK";
4536 return "COAP_EVENT_XMIT_BLOCK_FAIL";
4538 return "COAP_EVENT_SERVER_SESSION_NEW";
4540 return "COAP_EVENT_SERVER_SESSION_DEL";
4542 return "COAP_EVENT_BAD_PACKET";
4544 return "COAP_EVENT_MSG_RETRANSMITTED";
4546 return "COAP_EVENT_OSCORE_DECRYPTION_FAILURE";
4548 return "COAP_EVENT_OSCORE_NOT_ENABLED";
4550 return "COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD";
4552 return "COAP_EVENT_OSCORE_NO_SECURITY";
4554 return "COAP_EVENT_OSCORE_INTERNAL_ERROR";
4556 return "COAP_EVENT_OSCORE_DECODE_ERROR";
4558 return "COAP_EVENT_WS_PACKET_SIZE";
4560 return "COAP_EVENT_WS_CONNECTED";
4562 return "COAP_EVENT_WS_CLOSED";
4564 return "COAP_EVENT_KEEPALIVE_FAILURE";
4565 default:
4566 return "???";
4567 }
4568}
4569#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
4570
4571COAP_API int
4573 coap_session_t *session) {
4574 int ret;
4575
4576 coap_lock_lock(context, return 0);
4577 ret = coap_handle_event_lkd(context, event, session);
4578 coap_lock_unlock(context);
4579 return ret;
4580}
4581
4582int
4584 coap_session_t *session) {
4585 int ret = 0;
4586
4587 coap_log_debug("***EVENT: %s\n", coap_event_name(event));
4588
4589 if (context->handle_event) {
4590 coap_lock_callback_ret(ret, context, context->handle_event(session, event));
4591#if COAP_PROXY_SUPPORT
4592 if (event == COAP_EVENT_SERVER_SESSION_DEL)
4594#endif /* COAP_PROXY_SUPPORT */
4595#if COAP_CLIENT_SUPPORT
4596 switch (event) {
4609 /* Those that are deemed fatal to end sending a request */
4610 session->doing_send_recv = 0;
4611 break;
4626 default:
4627 break;
4628 }
4629#endif /* COAP_CLIENT_SUPPORT */
4630 }
4631 return ret;
4632}
4633
4634COAP_API int
4636 int ret;
4637
4638 coap_lock_lock(context, return 0);
4639 ret = coap_can_exit_lkd(context);
4640 coap_lock_unlock(context);
4641 return ret;
4642}
4643
4644int
4646 coap_session_t *s, *rtmp;
4647 if (!context)
4648 return 1;
4649 coap_lock_check_locked(context);
4650 if (context->sendqueue)
4651 return 0;
4652#if COAP_SERVER_SUPPORT
4653 coap_endpoint_t *ep;
4654
4655 LL_FOREACH(context->endpoint, ep) {
4656 SESSIONS_ITER(ep->sessions, s, rtmp) {
4657 if (s->delayqueue)
4658 return 0;
4659 if (s->lg_xmit)
4660 return 0;
4661 }
4662 }
4663#endif /* COAP_SERVER_SUPPORT */
4664#if COAP_CLIENT_SUPPORT
4665 SESSIONS_ITER(context->sessions, s, rtmp) {
4666 if (s->delayqueue)
4667 return 0;
4668 if (s->lg_xmit)
4669 return 0;
4670 }
4671#endif /* COAP_CLIENT_SUPPORT */
4672 return 1;
4673}
4674#if COAP_SERVER_SUPPORT
4675#if COAP_ASYNC_SUPPORT
4677coap_check_async(coap_context_t *context, coap_tick_t now) {
4678 coap_tick_t next_due = 0;
4679 coap_async_t *async, *tmp;
4680
4681 LL_FOREACH_SAFE(context->async_state, async, tmp) {
4682 if (async->delay != 0 && async->delay <= now) {
4683 /* Send off the request to the application */
4684 coap_log_debug("Async PDU presented to app.\n");
4685 coap_show_pdu(COAP_LOG_DEBUG, async->pdu);
4686 handle_request(context, async->session, async->pdu, NULL);
4687
4688 /* Remove this async entry as it has now fired */
4689 coap_free_async_lkd(async->session, async);
4690 } else {
4691 if (next_due == 0 || next_due > async->delay - now)
4692 next_due = async->delay - now;
4693 }
4694 }
4695 return next_due;
4696}
4697#endif /* COAP_ASYNC_SUPPORT */
4698#endif /* COAP_SERVER_SUPPORT */
4699
4701
4702#if COAP_THREAD_SAFE
4703/*
4704 * Global lock for multi-thread support
4705 */
4706coap_lock_t global_lock;
4707#endif /* COAP_THREAD_SAFE */
4708
4709void
4711 coap_tick_t now;
4712#ifndef WITH_CONTIKI
4713 uint64_t us;
4714#endif /* !WITH_CONTIKI */
4715
4716 if (coap_started)
4717 return;
4718 coap_started = 1;
4719
4720#if COAP_THREAD_SAFE
4722#endif /* COAP_THREAD_SAFE */
4723
4724#if defined(HAVE_WINSOCK2_H)
4725 WORD wVersionRequested = MAKEWORD(2, 2);
4726 WSADATA wsaData;
4727 WSAStartup(wVersionRequested, &wsaData);
4728#endif
4730 coap_ticks(&now);
4731#ifndef WITH_CONTIKI
4732 us = coap_ticks_to_rt_us(now);
4733 /* Be accurate to the nearest (approx) us */
4734 coap_prng_init_lkd((unsigned int)us);
4735#else /* WITH_CONTIKI */
4736 coap_start_io_process();
4737#endif /* WITH_CONTIKI */
4740#ifdef WITH_LWIP
4741 coap_io_lwip_init();
4742#endif /* WITH_LWIP */
4743#if COAP_SERVER_SUPPORT
4744 static coap_str_const_t well_known = { sizeof(".well-known/core")-1,
4745 (const uint8_t *)".well-known/core"
4746 };
4747 memset(&resource_uri_wellknown, 0, sizeof(resource_uri_wellknown));
4748 resource_uri_wellknown.handler[COAP_REQUEST_GET-1] = hnd_get_wellknown_lkd;
4749 resource_uri_wellknown.flags = COAP_RESOURCE_FLAGS_HAS_MCAST_SUPPORT;
4750 resource_uri_wellknown.uri_path = &well_known;
4751#endif /* COAP_SERVER_SUPPORT */
4753}
4754
4755void
4757 if (!coap_started)
4758 return;
4759 coap_started = 0;
4760#if defined(HAVE_WINSOCK2_H)
4761 WSACleanup();
4762#elif defined(WITH_CONTIKI)
4763 coap_stop_io_process();
4764#endif
4765#ifdef WITH_LWIP
4766 coap_io_lwip_cleanup();
4767#endif /* WITH_LWIP */
4769
4771}
4772
4773void
4775 coap_response_handler_t handler) {
4776#if COAP_CLIENT_SUPPORT
4777 context->response_handler = handler;
4778#else /* ! COAP_CLIENT_SUPPORT */
4779 (void)context;
4780 (void)handler;
4781#endif /* COAP_CLIENT_SUPPORT */
4782}
4783
4784void
4786 coap_nack_handler_t handler) {
4787 context->nack_handler = handler;
4788}
4789
4790void
4792 coap_ping_handler_t handler) {
4793 context->ping_handler = handler;
4794}
4795
4796void
4798 coap_pong_handler_t handler) {
4799 context->pong_handler = handler;
4800}
4801
4802COAP_API void
4804 coap_lock_lock(ctx, return);
4805 coap_register_option_lkd(ctx, type);
4806 coap_lock_unlock(ctx);
4807}
4808
4809void
4812}
4813
4814#if ! defined WITH_CONTIKI && ! defined WITH_LWIP && ! defined RIOT_VERSION
4815#if COAP_SERVER_SUPPORT
4816COAP_API int
4817coap_join_mcast_group_intf(coap_context_t *ctx, const char *group_name,
4818 const char *ifname) {
4819 int ret;
4820
4821 coap_lock_lock(ctx, return -1);
4822 ret = coap_join_mcast_group_intf_lkd(ctx, group_name, ifname);
4823 coap_lock_unlock(ctx);
4824 return ret;
4825}
4826
4827int
4828coap_join_mcast_group_intf_lkd(coap_context_t *ctx, const char *group_name,
4829 const char *ifname) {
4830#if COAP_IPV4_SUPPORT
4831 struct ip_mreq mreq4;
4832#endif /* COAP_IPV4_SUPPORT */
4833#if COAP_IPV6_SUPPORT
4834 struct ipv6_mreq mreq6;
4835#endif /* COAP_IPV6_SUPPORT */
4836 struct addrinfo *resmulti = NULL, hints, *ainfo;
4837 int result = -1;
4838 coap_endpoint_t *endpoint;
4839 int mgroup_setup = 0;
4840
4841 /* Need to have at least one endpoint! */
4842 assert(ctx->endpoint);
4843 if (!ctx->endpoint)
4844 return -1;
4845
4846 /* Default is let the kernel choose */
4847#if COAP_IPV6_SUPPORT
4848 mreq6.ipv6mr_interface = 0;
4849#endif /* COAP_IPV6_SUPPORT */
4850#if COAP_IPV4_SUPPORT
4851 mreq4.imr_interface.s_addr = INADDR_ANY;
4852#endif /* COAP_IPV4_SUPPORT */
4853
4854 memset(&hints, 0, sizeof(hints));
4855 hints.ai_socktype = SOCK_DGRAM;
4856
4857 /* resolve the multicast group address */
4858 result = getaddrinfo(group_name, NULL, &hints, &resmulti);
4859
4860 if (result != 0) {
4861 coap_log_err("coap_join_mcast_group_intf: %s: "
4862 "Cannot resolve multicast address: %s\n",
4863 group_name, gai_strerror(result));
4864 goto finish;
4865 }
4866
4867 /* Need to do a windows equivalent at some point */
4868#ifndef _WIN32
4869 if (ifname) {
4870 /* interface specified - check if we have correct IPv4/IPv6 information */
4871 int done_ip4 = 0;
4872 int done_ip6 = 0;
4873#if defined(ESPIDF_VERSION)
4874 struct netif *netif;
4875#else /* !ESPIDF_VERSION */
4876#if COAP_IPV4_SUPPORT
4877 int ip4fd;
4878#endif /* COAP_IPV4_SUPPORT */
4879 struct ifreq ifr;
4880#endif /* !ESPIDF_VERSION */
4881
4882 /* See which mcast address family types are being asked for */
4883 for (ainfo = resmulti; ainfo != NULL && !(done_ip4 == 1 && done_ip6 == 1);
4884 ainfo = ainfo->ai_next) {
4885 switch (ainfo->ai_family) {
4886#if COAP_IPV6_SUPPORT
4887 case AF_INET6:
4888 if (done_ip6)
4889 break;
4890 done_ip6 = 1;
4891#if defined(ESPIDF_VERSION)
4892 netif = netif_find(ifname);
4893 if (netif)
4894 mreq6.ipv6mr_interface = netif_get_index(netif);
4895 else
4896 coap_log_err("coap_join_mcast_group_intf: %s: "
4897 "Cannot get IPv4 address: %s\n",
4898 ifname, coap_socket_strerror());
4899#else /* !ESPIDF_VERSION */
4900 memset(&ifr, 0, sizeof(ifr));
4901 strncpy(ifr.ifr_name, ifname, IFNAMSIZ - 1);
4902 ifr.ifr_name[IFNAMSIZ - 1] = '\000';
4903
4904#ifdef HAVE_IF_NAMETOINDEX
4905 mreq6.ipv6mr_interface = if_nametoindex(ifr.ifr_name);
4906 if (mreq6.ipv6mr_interface == 0) {
4907 coap_log_warn("coap_join_mcast_group_intf: "
4908 "cannot get interface index for '%s'\n",
4909 ifname);
4910 }
4911#elif defined(__QNXNTO__)
4912#else /* !HAVE_IF_NAMETOINDEX */
4913 result = ioctl(ctx->endpoint->sock.fd, SIOCGIFINDEX, &ifr);
4914 if (result != 0) {
4915 coap_log_warn("coap_join_mcast_group_intf: "
4916 "cannot get interface index for '%s': %s\n",
4917 ifname, coap_socket_strerror());
4918 } else {
4919 /* Capture the IPv6 if_index for later */
4920 mreq6.ipv6mr_interface = ifr.ifr_ifindex;
4921 }
4922#endif /* !HAVE_IF_NAMETOINDEX */
4923#endif /* !ESPIDF_VERSION */
4924#endif /* COAP_IPV6_SUPPORT */
4925 break;
4926#if COAP_IPV4_SUPPORT
4927 case AF_INET:
4928 if (done_ip4)
4929 break;
4930 done_ip4 = 1;
4931#if defined(ESPIDF_VERSION)
4932 netif = netif_find(ifname);
4933 if (netif)
4934 mreq4.imr_interface.s_addr = netif_ip4_addr(netif)->addr;
4935 else
4936 coap_log_err("coap_join_mcast_group_intf: %s: "
4937 "Cannot get IPv4 address: %s\n",
4938 ifname, coap_socket_strerror());
4939#else /* !ESPIDF_VERSION */
4940 /*
4941 * Need an AF_INET socket to do this unfortunately to stop
4942 * "Invalid argument" error if AF_INET6 socket is used for SIOCGIFADDR
4943 */
4944 ip4fd = socket(AF_INET, SOCK_DGRAM, 0);
4945 if (ip4fd == -1) {
4946 coap_log_err("coap_join_mcast_group_intf: %s: socket: %s\n",
4947 ifname, coap_socket_strerror());
4948 continue;
4949 }
4950 memset(&ifr, 0, sizeof(ifr));
4951 strncpy(ifr.ifr_name, ifname, IFNAMSIZ - 1);
4952 ifr.ifr_name[IFNAMSIZ - 1] = '\000';
4953 result = ioctl(ip4fd, SIOCGIFADDR, &ifr);
4954 if (result != 0) {
4955 coap_log_err("coap_join_mcast_group_intf: %s: "
4956 "Cannot get IPv4 address: %s\n",
4957 ifname, coap_socket_strerror());
4958 } else {
4959 /* Capture the IPv4 address for later */
4960 mreq4.imr_interface = ((struct sockaddr_in *)&ifr.ifr_addr)->sin_addr;
4961 }
4962 close(ip4fd);
4963#endif /* !ESPIDF_VERSION */
4964 break;
4965#endif /* COAP_IPV4_SUPPORT */
4966 default:
4967 break;
4968 }
4969 }
4970 }
4971#else /* _WIN32 */
4972 /*
4973 * On Windows this function ignores the ifname variable so we unset this
4974 * variable on this platform in any case in order to enable the interface
4975 * selection from the bind address below.
4976 */
4977 ifname = 0;
4978#endif /* _WIN32 */
4979
4980 /* Add in mcast address(es) to appropriate interface */
4981 for (ainfo = resmulti; ainfo != NULL; ainfo = ainfo->ai_next) {
4982 LL_FOREACH(ctx->endpoint, endpoint) {
4983 /* Only UDP currently supported */
4984 if (endpoint->proto == COAP_PROTO_UDP) {
4985 coap_address_t gaddr;
4986
4987 coap_address_init(&gaddr);
4988#if COAP_IPV6_SUPPORT
4989 if (ainfo->ai_family == AF_INET6) {
4990 if (!ifname) {
4991 if (endpoint->bind_addr.addr.sa.sa_family == AF_INET6) {
4992 /*
4993 * Do it on the ifindex that the server is listening on
4994 * (sin6_scope_id could still be 0)
4995 */
4996 mreq6.ipv6mr_interface =
4997 endpoint->bind_addr.addr.sin6.sin6_scope_id;
4998 } else {
4999 mreq6.ipv6mr_interface = 0;
5000 }
5001 }
5002 gaddr.addr.sin6.sin6_family = AF_INET6;
5003 gaddr.addr.sin6.sin6_port = endpoint->bind_addr.addr.sin6.sin6_port;
5004 gaddr.addr.sin6.sin6_addr = mreq6.ipv6mr_multiaddr =
5005 ((struct sockaddr_in6 *)ainfo->ai_addr)->sin6_addr;
5006 result = setsockopt(endpoint->sock.fd, IPPROTO_IPV6, IPV6_JOIN_GROUP,
5007 (char *)&mreq6, sizeof(mreq6));
5008 }
5009#endif /* COAP_IPV6_SUPPORT */
5010#if COAP_IPV4_SUPPORT && COAP_IPV6_SUPPORT
5011 else
5012#endif /* COAP_IPV4_SUPPORT && COAP_IPV6_SUPPORT */
5013#if COAP_IPV4_SUPPORT
5014 if (ainfo->ai_family == AF_INET) {
5015 if (!ifname) {
5016 if (endpoint->bind_addr.addr.sa.sa_family == AF_INET) {
5017 /*
5018 * Do it on the interface that the server is listening on
5019 * (sin_addr could still be INADDR_ANY)
5020 */
5021 mreq4.imr_interface = endpoint->bind_addr.addr.sin.sin_addr;
5022 } else {
5023 mreq4.imr_interface.s_addr = INADDR_ANY;
5024 }
5025 }
5026 gaddr.addr.sin.sin_family = AF_INET;
5027 gaddr.addr.sin.sin_port = endpoint->bind_addr.addr.sin.sin_port;
5028 gaddr.addr.sin.sin_addr.s_addr = mreq4.imr_multiaddr.s_addr =
5029 ((struct sockaddr_in *)ainfo->ai_addr)->sin_addr.s_addr;
5030 result = setsockopt(endpoint->sock.fd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
5031 (char *)&mreq4, sizeof(mreq4));
5032 }
5033#endif /* COAP_IPV4_SUPPORT */
5034 else {
5035 continue;
5036 }
5037
5038 if (result == COAP_SOCKET_ERROR) {
5039 coap_log_err("coap_join_mcast_group_intf: %s: setsockopt: %s\n",
5040 group_name, coap_socket_strerror());
5041 } else {
5042 char addr_str[INET6_ADDRSTRLEN + 8 + 1];
5043
5044 addr_str[sizeof(addr_str)-1] = '\000';
5045 if (coap_print_addr(&gaddr, (uint8_t *)addr_str,
5046 sizeof(addr_str) - 1)) {
5047 if (ifname)
5048 coap_log_debug("added mcast group %s i/f %s\n", addr_str,
5049 ifname);
5050 else
5051 coap_log_debug("added mcast group %s\n", addr_str);
5052 }
5053 mgroup_setup = 1;
5054 }
5055 }
5056 }
5057 }
5058 if (!mgroup_setup) {
5059 result = -1;
5060 }
5061
5062finish:
5063 freeaddrinfo(resmulti);
5064
5065 return result;
5066}
5067
5068void
5070 context->mcast_per_resource = 1;
5071}
5072
5073#endif /* ! COAP_SERVER_SUPPORT */
5074
5075#if COAP_CLIENT_SUPPORT
5076int
5077coap_mcast_set_hops(coap_session_t *session, size_t hops) {
5078 if (session && coap_is_mcast(&session->addr_info.remote)) {
5079 switch (session->addr_info.remote.addr.sa.sa_family) {
5080#if COAP_IPV4_SUPPORT
5081 case AF_INET:
5082 if (setsockopt(session->sock.fd, IPPROTO_IP, IP_MULTICAST_TTL,
5083 (const char *)&hops, sizeof(hops)) < 0) {
5084 coap_log_info("coap_mcast_set_hops: %zu: setsockopt: %s\n",
5085 hops, coap_socket_strerror());
5086 return 0;
5087 }
5088 return 1;
5089#endif /* COAP_IPV4_SUPPORT */
5090#if COAP_IPV6_SUPPORT
5091 case AF_INET6:
5092 if (setsockopt(session->sock.fd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS,
5093 (const char *)&hops, sizeof(hops)) < 0) {
5094 coap_log_info("coap_mcast_set_hops: %zu: setsockopt: %s\n",
5095 hops, coap_socket_strerror());
5096 return 0;
5097 }
5098 return 1;
5099#endif /* COAP_IPV6_SUPPORT */
5100 default:
5101 break;
5102 }
5103 }
5104 return 0;
5105}
5106#endif /* COAP_CLIENT_SUPPORT */
5107
5108#else /* defined WITH_CONTIKI || defined WITH_LWIP */
5109COAP_API int
5111 const char *group_name COAP_UNUSED,
5112 const char *ifname COAP_UNUSED) {
5113 return -1;
5114}
5115
5116int
5118 size_t hops COAP_UNUSED) {
5119 return 0;
5120}
5121
5122void
5124}
5125#endif /* defined WITH_CONTIKI || defined WITH_LWIP */
void coap_address_init(coap_address_t *addr)
Resets the given coap_address_t object addr to its default values.
int coap_is_mcast(const coap_address_t *a)
Checks if given address a denotes a multicast address.
void coap_address_copy(coap_address_t *dst, const coap_address_t *src)
void coap_debug_reset(void)
Reset all the defined logging parameters.
struct coap_async_t coap_async_t
Async Entry information.
#define PRIu32
const char * coap_socket_strerror(void)
Definition coap_io.c:2067
void coap_packet_get_memmapped(coap_packet_t *packet, unsigned char **address, size_t *length)
Given a packet, set msg and msg_len to an address and length of the packet's data in memory.
Definition coap_io.c:1016
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:504
#define COAP_RXBUFFER_SIZE
Definition coap_io.h:29
#define COAP_SOCKET_ERROR
Definition coap_io.h:49
coap_nack_reason_t
Definition coap_io.h:62
@ COAP_NACK_NOT_DELIVERABLE
Definition coap_io.h:64
@ COAP_NACK_TOO_MANY_RETRIES
Definition coap_io.h:63
@ COAP_NACK_ICMP_ISSUE
Definition coap_io.h:67
@ COAP_NACK_RST
Definition coap_io.h:65
@ COAP_NACK_BAD_RESPONSE
Definition coap_io.h:68
#define COAP_SOCKET_MULTICAST
socket is used for multicast communication
#define COAP_SOCKET_WANT_ACCEPT
non blocking server socket is waiting for accept
#define COAP_SOCKET_NOT_EMPTY
the socket is not empty
#define COAP_SOCKET_CAN_WRITE
non blocking socket can now write without blocking
#define COAP_SOCKET_BOUND
the socket is bound
#define COAP_SOCKET_WANT_READ
non blocking socket is waiting for reading
#define COAP_SOCKET_CAN_ACCEPT
non blocking server socket can now accept without blocking
#define COAP_SOCKET_WANT_WRITE
non blocking socket is waiting for writing
#define COAP_SOCKET_CAN_CONNECT
non blocking client socket can now connect without blocking
void coap_epoll_ctl_mod(coap_socket_t *sock, uint32_t events, const char *func)
Epoll specific function to modify the state of events that epoll is tracking on the appropriate file ...
#define COAP_SOCKET_WANT_CONNECT
non blocking client socket is waiting for connect
#define COAP_SOCKET_CAN_READ
non blocking socket can now read without blocking
#define COAP_SOCKET_CONNECTED
the socket is connected
@ COAP_LAYER_SESSION
Library specific build wrapper for coap_internal.h.
#define COAP_API
void coap_dump_memory_type_counts(coap_log_t level)
Dumps the current usage of malloc'd memory types.
Definition coap_mem.c:670
void coap_memory_init(void)
Initializes libcoap's memory management.
@ COAP_NODE
Definition coap_mem.h:43
@ COAP_CONTEXT
Definition coap_mem.h:44
@ 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 mutex mechanism wrapper.
#define FRAC_BITS
The number of bits for the fractional part of ACK_TIMEOUT and ACK_RANDOM_FACTOR.
Definition coap_net.c:80
static ssize_t coap_send_pdu(coap_session_t *session, coap_pdu_t *pdu, coap_queue_t *node)
Definition coap_net.c:1014
static int send_recv_terminate
Definition coap_net.c:1955
#define MAX_BITS
The maximum number of bits for fixed point integers that are used for retransmission time calculation...
Definition coap_net.c:86
void coap_cleanup(void)
Definition coap_net.c:4756
#define ACK_TIMEOUT
creates a Qx.FRAC_BITS from session's 'ack_timeout'
Definition coap_net.c:101
static const char * coap_event_name(coap_event_t event)
Definition coap_net.c:4511
static int coap_cancel(coap_context_t *context, const coap_queue_t *sent)
This function cancels outstanding messages for the session and token specified in sent.
Definition coap_net.c:3062
int coap_started
Definition coap_net.c:4700
static int coap_handle_dgram_for_proto(coap_context_t *ctx, coap_session_t *session, coap_packet_t *packet)
Definition coap_net.c:2208
static void coap_write_session(coap_context_t *ctx, coap_session_t *session, coap_tick_t now)
Definition coap_net.c:2249
COAP_STATIC_INLINE void coap_free_node(coap_queue_t *node)
Definition coap_net.c:111
#define SHR_FP(val, frac)
static void handle_signaling(coap_context_t *context, coap_session_t *session, coap_pdu_t *pdu)
Definition coap_net.c:3971
#define min(a, b)
Definition coap_net.c:73
void coap_startup(void)
Definition coap_net.c:4710
static int check_token_size(coap_session_t *session, const coap_pdu_t *pdu)
Definition coap_net.c:4044
static unsigned int s_csm_timeout
Definition coap_net.c:503
COAP_STATIC_INLINE coap_queue_t * coap_malloc_node(void)
Definition coap_net.c:106
#define FP1
#define ACK_RANDOM_FACTOR
creates a Qx.FRAC_BITS from session's 'ack_random_factor'
Definition coap_net.c:97
#define INET6_ADDRSTRLEN
Definition coap_net.c:69
int coap_dtls_context_set_pki(coap_context_t *ctx COAP_UNUSED, const coap_dtls_pki_t *setup_data COAP_UNUSED, const coap_dtls_role_t role COAP_UNUSED)
Definition coap_notls.c:108
int coap_dtls_receive(coap_session_t *session COAP_UNUSED, const uint8_t *data COAP_UNUSED, size_t data_len COAP_UNUSED)
Definition coap_notls.c:238
int coap_dtls_context_set_pki_root_cas(coap_context_t *ctx COAP_UNUSED, const char *ca_file COAP_UNUSED, const char *ca_path COAP_UNUSED)
Definition coap_notls.c:116
void coap_dtls_free_context(void *handle COAP_UNUSED)
Definition coap_notls.c:181
void * coap_dtls_new_context(coap_context_t *coap_context COAP_UNUSED)
Definition coap_notls.c:176
uint16_t coap_option_num_t
Definition coap_option.h:20
uint8_t coap_opt_t
Use byte-oriented access methods here because sliding a complex struct coap_opt_t over the data buffe...
Definition coap_option.h:26
#define SESSIONS_ITER_SAFE(e, el, rtmp)
#define SESSIONS_ITER(e, el, rtmp)
void coap_proxy_cleanup(coap_context_t *context)
Close down proxy tracking, releasing any memory used.
void coap_proxy_remove_association(coap_session_t *session, int send_failure)
void coap_io_do_epoll_lkd(coap_context_t *ctx, struct epoll_event *events, size_t nevents)
Process all the epoll events.
Definition coap_net.c:2578
coap_mid_t coap_send_rst_lkd(coap_session_t *session, const coap_pdu_t *request)
Sends an RST message with code 0 for the specified request to dst.
Definition coap_net.c:971
coap_mid_t coap_send_message_type_lkd(coap_session_t *session, const coap_pdu_t *request, coap_pdu_type_t type)
Helper function to create and send a message with type (usually ACK or RST).
Definition coap_net.c:1095
coap_mid_t coap_send_error_lkd(coap_session_t *session, const coap_pdu_t *request, coap_pdu_code_t code, coap_opt_filter_t *opts)
Sends an error response with code code for request request to dst.
Definition coap_net.c:1066
void coap_io_do_io_lkd(coap_context_t *ctx, coap_tick_t now)
Processes any outstanding read, write, accept or connect I/O as indicated in the coap_socket_t struct...
Definition coap_net.c:2513
int coap_send_recv_lkd(coap_session_t *session, coap_pdu_t *request_pdu, coap_pdu_t **response_pdu, uint32_t timeout_ms)
Definition coap_net.c:1984
int coap_io_process_lkd(coap_context_t *ctx, uint32_t timeout_ms)
The main I/O processing function.
Definition coap_io.c:1763
unsigned int coap_io_prepare_epoll_lkd(coap_context_t *ctx, coap_tick_t now)
Any now timed out delayed packet is transmitted, along with any packets associated with requested obs...
Definition coap_io.c:1260
coap_mid_t coap_send_lkd(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:1355
coap_mid_t coap_send_ack_lkd(coap_session_t *session, const coap_pdu_t *request)
Sends an ACK message with code 0 for the specified request to dst.
Definition coap_net.c:986
#define COAP_IO_NO_WAIT
Definition coap_net.h:663
#define COAP_IO_WAIT
Definition coap_net.h:662
COAP_API void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events, size_t nevents)
Process all the epoll events.
Definition coap_net.c:2567
COAP_API void coap_io_do_io(coap_context_t *ctx, coap_tick_t now)
Processes any outstanding read, write, accept or connect I/O as indicated in the coap_socket_t struct...
Definition coap_net.c:2506
int coap_add_data_large_response_lkd(coap_resource_t *resource, coap_session_t *session, const coap_pdu_t *request, coap_pdu_t *response, const coap_string_t *query, uint16_t media_type, int maxage, uint64_t etag, size_t length, const uint8_t *data, coap_release_large_data_t release_func, void *app_ptr)
Associates given data with the response pdu that is passed as fourth parameter.
void coap_block_delete_lg_srcv(coap_session_t *session, coap_lg_srcv_t *lg_srcv)
void coap_block_delete_lg_crcv(coap_session_t *session, coap_lg_crcv_t *lg_crcv)
int coap_handle_response_get_block(coap_context_t *context, coap_session_t *session, coap_pdu_t *sent, coap_pdu_t *rcvd, coap_recurse_t recursive)
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_handle_response_send_block(coap_session_t *session, coap_pdu_t *sent, coap_pdu_t *rcvd)
int coap_handle_request_put_block(coap_context_t *context, coap_session_t *session, coap_pdu_t *pdu, coap_pdu_t *response, coap_resource_t *resource, coap_string_t *uri_path, coap_opt_t *observe, int *added_block, coap_lg_srcv_t **free_lg_srcv)
#define STATE_TOKEN_BASE(t)
coap_lg_crcv_t * coap_block_new_lg_crcv(coap_session_t *session, coap_pdu_t *pdu, coap_lg_xmit_t *lg_xmit)
int coap_handle_request_send_block(coap_session_t *session, coap_pdu_t *pdu, coap_pdu_t *response, coap_resource_t *resource, coap_string_t *query)
@ COAP_RECURSE_OK
#define COAP_OPT_BLOCK_SZX(opt)
Returns the value of the SZX-field of a Block option opt.
Definition coap_block.h:90
#define COAP_BLOCK_TRY_Q_BLOCK
Definition coap_block.h:63
#define COAP_BLOCK_SINGLE_BODY
Definition coap_block.h:62
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:62
#define COAP_BLOCK_NO_PREEMPTIVE_RTAG
Definition coap_block.h:65
#define COAP_BLOCK_CACHE_RESPONSE
Definition coap_block.h:69
#define COAP_BLOCK_USE_LIBCOAP
Definition coap_block.h:61
void coap_digest_free(coap_digest_ctx_t *digest_ctx)
Free off coap_digest_ctx_t.
int coap_digest_final(coap_digest_ctx_t *digest_ctx, coap_digest_t *digest_buffer)
Finalize the coap_digest information into the provided digest_buffer.
int coap_digest_update(coap_digest_ctx_t *digest_ctx, const uint8_t *data, size_t data_len)
Update the coap_digest information with the next chunk of data.
void coap_digest_ctx_t
coap_digest_ctx_t * coap_digest_setup(void)
Initialize a coap_digest.
void coap_delete_cache_entry(coap_context_t *context, coap_cache_entry_t *cache_entry)
Remove a cache-entry from the hash list and free off all the appropriate contents apart from app_data...
int64_t coap_tick_diff_t
This data type is used to represent the difference between two clock_tick_t values.
Definition coap_time.h:155
void coap_clock_init(void)
Initializes the internal clock.
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
uint64_t coap_ticks_to_rt_us(coap_tick_t t)
Helper function that converts coap ticks to POSIX wallclock time in us.
void coap_prng_init_lkd(unsigned int seed)
Seeds the default random number generation function with the given seed.
Definition coap_prng.c:166
int coap_prng_lkd(void *buf, size_t len)
Fills buf with len random bytes using the default pseudo random number generator.
Definition coap_prng.c:178
void coap_delete_all_resources(coap_context_t *context)
Deletes all resources from given context and frees their storage.
coap_print_status_t coap_print_wellknown_lkd(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.
coap_resource_t * coap_get_resource_from_uri_path_lkd(coap_context_t *context, coap_str_const_t *uri_path)
Returns the resource identified by the unique string uri_path.
#define RESOURCES_ITER(r, tmp)
#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_RESOURCE_FLAGS_HAS_MCAST_SUPPORT
This resource has support for multicast requests.
#define COAP_RESOURCE_FLAGS_LIB_DIS_MCAST_SUPPRESS_4_XX
Disable libcoap library suppressing 4.xx multicast responses (overridden by RFC7969 No-Response optio...
#define COAP_RESOURCE_FLAGS_LIB_DIS_MCAST_DELAYS
Disable libcoap library from adding in delays to multicast requests before releasing the response bac...
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.
#define COAP_RESOURCE_FLAGS_OSCORE_ONLY
Define this resource as an OSCORE enabled access only.
#define COAP_RESOURCE_FLAGS_LIB_DIS_MCAST_SUPPRESS_5_XX
Disable libcoap library suppressing 5.xx multicast responses (overridden by RFC7969 No-Response optio...
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
#define COAP_RESOURCE_FLAGS_FORCE_SINGLE_BODY
Force all large traffic to this resource to be presented as a single body to the request handler.
#define COAP_RESOURCE_FLAGS_LIB_ENA_MCAST_SUPPRESS_2_05
Enable libcoap library suppression of 205 multicast responses that are empty (overridden by RFC7969 N...
#define COAP_RESOURCE_FLAGS_LIB_ENA_MCAST_SUPPRESS_2_XX
Enable libcoap library suppressing 2.xx multicast responses (overridden by RFC7969 No-Response option...
void coap_register_option_lkd(coap_context_t *ctx, uint16_t type)
Registers the option type type with the given context object ctx.
Definition coap_net.c:4810
int coap_handle_event_lkd(coap_context_t *context, coap_event_t event, coap_session_t *session)
Invokes the event handler of context for the given event and data.
Definition coap_net.c:4583
uint16_t coap_new_message_id_lkd(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
unsigned int coap_adjust_basetime(coap_context_t *ctx, coap_tick_t now)
Set sendqueue_basetime in the given context object ctx to now.
Definition coap_net.c:130
int coap_delete_node_lkd(coap_queue_t *node)
Destroys specified node.
Definition coap_net.c:227
void coap_delete_all(coap_queue_t *queue)
Removes all items from given queue and frees the allocated storage.
Definition coap_net.c:247
int coap_context_set_psk2_lkd(coap_context_t *context, coap_dtls_spsk_t *setup_data)
Set the context's default PSK hint and/or key for a server.
int coap_remove_from_queue(coap_queue_t **queue, coap_session_t *session, coap_mid_t id, coap_queue_t **node)
This function removes the element with given id from the list given list.
Definition coap_net.c:2728
coap_queue_t * coap_peek_next(coap_context_t *context)
Returns the next pdu to send without removing from sendqeue.
Definition coap_net.c:270
COAP_API int coap_delete_node(coap_queue_t *node)
Destroys specified node.
Definition coap_net.c:204
int coap_client_delay_first(coap_session_t *session)
Delay the sending of the first client request until some other negotiation has completed.
Definition coap_net.c:1226
int coap_context_set_psk_lkd(coap_context_t *context, const char *hint, const uint8_t *key, size_t key_len)
Set the context's default PSK hint and/or key for a server.
coap_queue_t * coap_pop_next(coap_context_t *context)
Returns the next pdu to send and removes it from the sendqeue.
Definition coap_net.c:278
void coap_dispatch(coap_context_t *context, coap_session_t *session, coap_pdu_t *pdu)
Dispatches the PDUs from the receive queue in given context.
Definition coap_net.c:4077
int coap_insert_node(coap_queue_t **queue, coap_queue_t *node)
Adds node to given queue, ordered by variable t in node.
Definition coap_net.c:167
unsigned int coap_calc_timeout(coap_session_t *session, unsigned char r)
Calculates the initial timeout based on the session CoAP transmission parameters 'ack_timeout',...
Definition coap_net.c:1123
int coap_join_mcast_group_intf_lkd(coap_context_t *ctx, const char *groupname, const char *ifname)
Function interface for joining a multicast group for listening for the currently defined endpoints th...
void coap_free_context_lkd(coap_context_t *context)
CoAP stack context must be released with coap_free_context_lkd().
Definition coap_net.c:755
coap_mid_t coap_send_internal(coap_session_t *session, coap_pdu_t *pdu, coap_pdu_t *request_pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:1708
int coap_can_exit_lkd(coap_context_t *context)
Returns 1 if there are no messages to send or to dispatch in the context's queues.
Definition coap_net.c:4645
coap_mid_t coap_retransmit(coap_context_t *context, coap_queue_t *node)
Handles retransmissions of confirmable messages.
Definition coap_net.c:2099
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:1293
int coap_context_set_pki_root_cas_lkd(coap_context_t *ctx, const char *ca_file, const char *ca_dir)
Set the context's default Root CA information for a client or server.
Definition coap_net.c:448
int coap_option_check_critical(coap_session_t *session, coap_pdu_t *pdu, coap_opt_filter_t *unknown)
Verifies that pdu contains no unknown critical options.
Definition coap_net.c:846
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition coap_net.c:1149
coap_queue_t * coap_new_node(void)
Creates a new node suitable for adding to the CoAP sendqueue.
Definition coap_net.c:256
void coap_cancel_session_messages(coap_context_t *context, coap_session_t *session, coap_nack_reason_t reason)
Cancels all outstanding messages for session session.
Definition coap_net.c:2773
int coap_context_set_pki_lkd(coap_context_t *context, const coap_dtls_pki_t *setup_data)
Set the context's default PKI information for a server.
int coap_handle_dgram(coap_context_t *ctx, coap_session_t *session, uint8_t *msg, size_t msg_len)
Parses and interprets a CoAP datagram with context ctx.
Definition coap_net.c:2683
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:2812
void coap_context_set_session_timeout(coap_context_t *context, unsigned int session_timeout)
Set the session timeout value.
Definition coap_net.c:546
unsigned int coap_context_get_max_handshake_sessions(const coap_context_t *context)
Get the session timeout value.
Definition coap_net.c:499
COAP_API int coap_join_mcast_group_intf(coap_context_t *ctx, const char *groupname, const char *ifname)
Function interface for joining a multicast group for listening for the currently defined endpoints th...
void(* coap_pong_handler_t)(coap_session_t *session, const coap_pdu_t *received, const coap_mid_t mid)
Received Pong handler that is used as callback in coap_context_t.
Definition coap_net.h:100
unsigned int coap_context_get_max_idle_sessions(const coap_context_t *context)
Get the maximum idle sessions count.
Definition coap_net.c:488
COAP_API int coap_send_recv(coap_session_t *session, coap_pdu_t *request_pdu, coap_pdu_t **response_pdu, uint32_t timeout_ms)
Definition coap_net.c:1963
coap_context_t * coap_new_context(const coap_address_t *listen_addr)
Creates a new coap_context_t object that will hold the CoAP stack status.
Definition coap_net.c:642
COAP_API coap_mid_t coap_send(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:1345
COAP_API int coap_context_set_pki(coap_context_t *context, const coap_dtls_pki_t *setup_data)
Set the context's default PKI information for a server.
void coap_mcast_per_resource(coap_context_t *context)
Function interface to enable processing mcast requests on a per resource basis.
coap_response_t(* coap_response_handler_t)(coap_session_t *session, const coap_pdu_t *sent, const coap_pdu_t *received, const coap_mid_t mid)
Response handler that is used as callback in coap_context_t.
Definition coap_net.h:64
COAP_API coap_mid_t coap_send_error(coap_session_t *session, const coap_pdu_t *request, coap_pdu_code_t code, coap_opt_filter_t *opts)
Sends an error response with code code for request request to dst.
Definition coap_net.c:1053
void coap_context_set_csm_max_message_size(coap_context_t *context, uint32_t csm_max_message_size)
Set the CSM max session size value.
Definition coap_net.c:534
void coap_context_set_csm_timeout(coap_context_t *context, unsigned int csm_timeout)
Set the CSM timeout value.
Definition coap_net.c:506
void coap_send_recv_terminate(void)
Terminate any active coap_send_recv() sessions.
Definition coap_net.c:1958
void coap_register_response_handler(coap_context_t *context, coap_response_handler_t handler)
Registers a new message handler that is called whenever a response is received.
Definition coap_net.c:4774
coap_pdu_t * coap_new_error_response(const coap_pdu_t *request, coap_pdu_code_t code, coap_opt_filter_t *opts)
Creates a new ACK PDU with specified error code.
Definition coap_net.c:2845
void coap_context_set_max_handshake_sessions(coap_context_t *context, unsigned int max_handshake_sessions)
Set the maximum number of sessions in (D)TLS handshake value.
Definition coap_net.c:493
int coap_context_get_coap_fd(const coap_context_t *context)
Get the libcoap internal file descriptor for using in an application's select() or returned as an eve...
Definition coap_net.c:557
int coap_mcast_set_hops(coap_session_t *session, size_t hops)
Function interface for defining the hop count (ttl) for sending multicast traffic.
void coap_context_set_app_data(coap_context_t *context, void *app_data)
Stores data with the given context.
Definition coap_net.c:630
coap_response_t
Definition coap_net.h:48
void(* coap_ping_handler_t)(coap_session_t *session, const coap_pdu_t *received, const coap_mid_t mid)
Received Ping handler that is used as callback in coap_context_t.
Definition coap_net.h:89
void coap_ticks(coap_tick_t *)
Returns the current value of an internal tick counter.
COAP_API void coap_free_context(coap_context_t *context)
CoAP stack context must be released with coap_free_context().
Definition coap_net.c:746
void(* coap_nack_handler_t)(coap_session_t *session, const coap_pdu_t *sent, const coap_nack_reason_t reason, const coap_mid_t mid)
Negative Acknowedge handler that is used as callback in coap_context_t.
Definition coap_net.h:77
void * coap_context_get_app_data(const coap_context_t *context)
Returns any application-specific data that has been stored with context using the function coap_conte...
Definition coap_net.c:636
COAP_API int coap_context_set_pki_root_cas(coap_context_t *ctx, const char *ca_file, const char *ca_dir)
Set the context's default Root CA information for a client or server.
Definition coap_net.c:436
uint32_t coap_context_get_csm_max_message_size(const coap_context_t *context)
Get the CSM max session size value.
Definition coap_net.c:541
unsigned int coap_context_get_session_timeout(const coap_context_t *context)
Get the session timeout value.
Definition coap_net.c:552
COAP_API int coap_context_set_psk(coap_context_t *context, const char *hint, const uint8_t *key, size_t key_len)
Set the context's default PSK hint and/or key for a server.
COAP_API void coap_register_option(coap_context_t *ctx, uint16_t type)
Registers the option type type with the given context object ctx.
Definition coap_net.c:4803
COAP_API coap_mid_t coap_send_ack(coap_session_t *session, const coap_pdu_t *request)
Sends an ACK message with code 0 for the specified request to dst.
Definition coap_net.c:976
unsigned int coap_context_get_csm_timeout_ms(const coap_context_t *context)
Get the CSM timeout value.
Definition coap_net.c:529
void coap_register_ping_handler(coap_context_t *context, coap_ping_handler_t handler)
Registers a new message handler that is called whenever a CoAP Ping message is received.
Definition coap_net.c:4791
COAP_API int coap_context_set_psk2(coap_context_t *context, coap_dtls_spsk_t *setup_data)
Set the context's default PSK hint and/or key for a server.
int coap_context_set_cid_tuple_change(coap_context_t *context, uint8_t every)
Set the Connection ID client tuple frequency change for testing CIDs.
Definition coap_net.c:463
void * coap_get_app_data(const coap_context_t *ctx)
Definition coap_net.c:740
void coap_context_set_max_idle_sessions(coap_context_t *context, unsigned int max_idle_sessions)
Set the maximum idle sessions count.
Definition coap_net.c:482
COAP_API coap_mid_t coap_send_message_type(coap_session_t *session, const coap_pdu_t *request, coap_pdu_type_t type)
Helper function to create and send a message with type (usually ACK or RST).
Definition coap_net.c:1084
COAP_API coap_mid_t coap_send_rst(coap_session_t *session, const coap_pdu_t *request)
Sends an RST message with code 0 for the specified request to dst.
Definition coap_net.c:961
void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds)
Set the context keepalive timer for sessions.
Definition coap_net.c:458
void coap_set_app_data(coap_context_t *ctx, void *app_data)
Definition coap_net.c:734
COAP_API int coap_can_exit(coap_context_t *context)
Returns 1 if there are no messages to send or to dispatch in the context's queues.
Definition coap_net.c:4635
unsigned int coap_context_get_csm_timeout(const coap_context_t *context)
Get the CSM timeout value.
Definition coap_net.c:513
void coap_register_pong_handler(coap_context_t *context, coap_pong_handler_t handler)
Registers a new message handler that is called whenever a CoAP Pong message is received.
Definition coap_net.c:4797
void coap_context_set_max_token_size(coap_context_t *context, size_t max_token_size)
Set the maximum token size (RFC8974).
Definition coap_net.c:474
COAP_API int coap_handle_event(coap_context_t *context, coap_event_t event, coap_session_t *session)
Invokes the event handler of context for the given event and data.
Definition coap_net.c:4572
void coap_register_nack_handler(coap_context_t *context, coap_nack_handler_t handler)
Registers a new message handler that is called whenever a confirmable message (request or response) i...
Definition coap_net.c:4785
void coap_context_set_csm_timeout_ms(coap_context_t *context, unsigned int csm_timeout_ms)
Set the CSM timeout value.
Definition coap_net.c:519
@ COAP_RESPONSE_FAIL
Response not liked - send CoAP RST packet.
Definition coap_net.h:49
@ COAP_RESPONSE_OK
Response is fine.
Definition coap_net.h:50
const coap_bin_const_t * coap_get_session_client_psk_identity(const coap_session_t *coap_session)
Get the current client's PSK identity.
void coap_dtls_startup(void)
Initialize the underlying (D)TLS Library layer.
Definition coap_notls.c:149
coap_session_t * coap_session_new_dtls_session(coap_session_t *session, coap_tick_t now)
Create a new DTLS session for the session.
int coap_dtls_hello(coap_session_t *coap_session, const uint8_t *data, size_t data_len)
Handling client HELLO messages from a new candiate peer.
int coap_dtls_set_cid_tuple_change(coap_context_t *context, uint8_t every)
Set the Connection ID client tuple frequency change for testing CIDs.
int coap_dtls_context_set_spsk(coap_context_t *coap_context, coap_dtls_spsk_t *setup_data)
Set the DTLS context's default server PSK information.
void coap_dtls_shutdown(void)
Close down the underlying (D)TLS Library layer.
Definition coap_notls.c:161
const coap_bin_const_t * coap_get_session_client_psk_key(const coap_session_t *coap_session)
Get the current client's PSK key.
const coap_bin_const_t * coap_get_session_server_psk_key(const coap_session_t *coap_session)
Get the current server's PSK key.
const coap_bin_const_t * coap_get_session_server_psk_hint(const coap_session_t *coap_session)
Get the current server's PSK identity hint.
#define COAP_DTLS_PKI_SETUP_VERSION
Latest PKI setup version.
Definition coap_dtls.h:307
@ COAP_DTLS_ROLE_SERVER
Internal function invoked for server.
Definition coap_dtls.h:46
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
unsigned int coap_decode_var_bytes(const uint8_t *buf, size_t len)
Decodes multiple-length byte sequences.
Definition coap_encode.c:38
uint64_t coap_decode_var_bytes8(const uint8_t *buf, size_t len)
Decodes multiple-length byte sequences.
Definition coap_encode.c:67
unsigned int coap_encode_var_safe8(uint8_t *buf, size_t length, uint64_t val)
Encodes multiple-length byte sequences.
Definition coap_encode.c:77
coap_event_t
Scalar type to represent different events, e.g.
Definition coap_event.h:34
@ COAP_EVENT_OSCORE_DECODE_ERROR
Triggered when there is an OSCORE decode of OSCORE option failure.
Definition coap_event.h:118
@ COAP_EVENT_SESSION_CONNECTED
Triggered when TCP layer completes exchange of CSM information.
Definition coap_event.h:61
@ COAP_EVENT_OSCORE_INTERNAL_ERROR
Triggered when there is an OSCORE internal error i.e malloc failed.
Definition coap_event.h:116
@ COAP_EVENT_DTLS_CLOSED
Triggerred when (D)TLS session closed.
Definition coap_event.h:39
@ COAP_EVENT_TCP_FAILED
Triggered when TCP layer fails for some reason.
Definition coap_event.h:55
@ COAP_EVENT_WS_CONNECTED
Triggered when the WebSockets layer is up.
Definition coap_event.h:125
@ COAP_EVENT_DTLS_CONNECTED
Triggered when (D)TLS session connected.
Definition coap_event.h:41
@ COAP_EVENT_SESSION_FAILED
Triggered when TCP layer fails following exchange of CSM information.
Definition coap_event.h:65
@ COAP_EVENT_PARTIAL_BLOCK
Triggered when not all of a large body has been received.
Definition coap_event.h:71
@ COAP_EVENT_XMIT_BLOCK_FAIL
Triggered when not all of a large body has been transmitted.
Definition coap_event.h:73
@ COAP_EVENT_SERVER_SESSION_NEW
Called in the CoAP IO loop if a new server-side session is created due to an incoming connection.
Definition coap_event.h:85
@ COAP_EVENT_OSCORE_NOT_ENABLED
Triggered when trying to use OSCORE to decrypt, but it is not enabled.
Definition coap_event.h:110
@ COAP_EVENT_WS_CLOSED
Triggered when the WebSockets layer is closed.
Definition coap_event.h:127
@ COAP_EVENT_SESSION_CLOSED
Triggered when TCP layer closes following exchange of CSM information.
Definition coap_event.h:63
@ COAP_EVENT_SERVER_SESSION_DEL
Called in the CoAP IO loop if a server session is deleted (e.g., due to inactivity or because the max...
Definition coap_event.h:94
@ COAP_EVENT_OSCORE_NO_SECURITY
Triggered when there is no OSCORE security definition found.
Definition coap_event.h:114
@ COAP_EVENT_DTLS_RENEGOTIATE
Triggered when (D)TLS session renegotiated.
Definition coap_event.h:43
@ COAP_EVENT_BAD_PACKET
Triggered when badly formatted packet received.
Definition coap_event.h:100
@ COAP_EVENT_MSG_RETRANSMITTED
Triggered when a message is retransmitted.
Definition coap_event.h:102
@ COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD
Triggered when there is no OSCORE encrypted payload provided.
Definition coap_event.h:112
@ COAP_EVENT_TCP_CLOSED
Triggered when TCP layer is closed.
Definition coap_event.h:53
@ COAP_EVENT_WS_PACKET_SIZE
Triggered when there is an oversize WebSockets packet.
Definition coap_event.h:123
@ COAP_EVENT_TCP_CONNECTED
Triggered when TCP layer connects.
Definition coap_event.h:51
@ COAP_EVENT_OSCORE_DECRYPTION_FAILURE
Triggered when there is an OSCORE decryption failure.
Definition coap_event.h:108
@ COAP_EVENT_KEEPALIVE_FAILURE
Triggered when no response to a keep alive (ping) packet.
Definition coap_event.h:132
@ COAP_EVENT_DTLS_ERROR
Triggered when (D)TLS error occurs.
Definition coap_event.h:45
coap_mutex_t coap_lock_t
#define coap_lock_callback_ret_release(r, c, 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_callback(c, func)
Dummy for no thread-safe code.
#define coap_lock_check_locked(c)
Dummy for no thread-safe code.
#define coap_lock_init()
Dummy for no thread-safe code.
#define coap_lock_callback_ret(r, c, func)
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:101
#define coap_log_alert(...)
Definition coap_debug.h:84
void coap_show_pdu(coap_log_t level, const coap_pdu_t *pdu)
Display the contents of the specified pdu.
Definition coap_debug.c:784
#define coap_log_emerg(...)
Definition coap_debug.h:81
size_t coap_print_addr(const coap_address_t *addr, unsigned char *buf, size_t len)
Print the address into the defined buffer.
Definition coap_debug.c:239
const char * coap_endpoint_str(const coap_endpoint_t *endpoint)
Get endpoint description.
const char * coap_session_str(const coap_session_t *session)
Get session description.
#define coap_log_info(...)
Definition coap_debug.h:108
#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
@ COAP_LOG_WARN
Definition coap_debug.h:55
int coap_netif_strm_connect2(coap_session_t *session)
Layer function interface for Netif stream connect (tcp).
ssize_t coap_netif_dgrm_read(coap_session_t *session, coap_packet_t *packet)
Function interface for layer data datagram receiving for sessions.
Definition coap_netif.c:72
ssize_t coap_netif_dgrm_read_ep(coap_endpoint_t *endpoint, coap_packet_t *packet)
Function interface for layer data datagram receiving for endpoints.
int coap_netif_available(coap_session_t *session)
Function interface to check whether netif for session is still available.
Definition coap_netif.c:25
#define COAP_OBSERVE_CANCEL
The value COAP_OBSERVE_CANCEL in a GET/FETCH request option COAP_OPTION_OBSERVE indicates that the ob...
#define COAP_OBSERVE_ESTABLISH
The value COAP_OBSERVE_ESTABLISH in a GET/FETCH request option COAP_OPTION_OBSERVE indicates a new ob...
coap_opt_t * coap_option_next(coap_opt_iterator_t *oi)
Updates the iterator oi to point to the next option.
uint32_t coap_opt_length(const coap_opt_t *opt)
Returns the length of the given option.
coap_opt_iterator_t * coap_option_iterator_init(const coap_pdu_t *pdu, coap_opt_iterator_t *oi, const coap_opt_filter_t *filter)
Initializes the given option iterator oi to point to the beginning of the pdu's option list.
#define COAP_OPT_ALL
Pre-defined filter that includes all options.
int coap_option_filter_unset(coap_opt_filter_t *filter, coap_option_num_t option)
Clears the corresponding entry for number in filter.
void coap_option_filter_clear(coap_opt_filter_t *filter)
Clears filter filter.
coap_opt_t * coap_check_option(const coap_pdu_t *pdu, coap_option_num_t number, coap_opt_iterator_t *oi)
Retrieves the first option of number number from pdu.
const uint8_t * coap_opt_value(const coap_opt_t *opt)
Returns a pointer to the value of the given option.
int coap_option_filter_get(coap_opt_filter_t *filter, coap_option_num_t option)
Checks if number is contained in filter.
int coap_option_filter_set(coap_opt_filter_t *filter, coap_option_num_t option)
Sets the corresponding entry for number in filter.
coap_pdu_t * coap_oscore_new_pdu_encrypted_lkd(coap_session_t *session, coap_pdu_t *pdu, coap_bin_const_t *kid_context, oscore_partial_iv_t send_partial_iv)
Encrypts the specified pdu when OSCORE encryption is required on session.
struct coap_pdu_t * coap_oscore_decrypt_pdu(coap_session_t *session, coap_pdu_t *pdu)
Decrypts the OSCORE-encrypted parts of pdu when OSCORE is used.
int coap_rebuild_pdu_for_proxy(coap_pdu_t *pdu)
Convert PDU to use Proxy-Scheme option if Proxy-Uri option is present.
void coap_delete_all_oscore(coap_context_t *context)
Cleanup all allocated OSCORE information.
#define COAP_PDU_IS_RESPONSE(pdu)
coap_pdu_t * coap_pdu_reference_lkd(coap_pdu_t *pdu)
Increment reference counter on a pdu to stop it prematurely getting freed off when coap_delete_pdu() ...
Definition coap_pdu.c:1623
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
Definition coap_pdu.c:190
#define COAP_TOKEN_EXT_2B_TKL
size_t coap_insert_option(coap_pdu_t *pdu, coap_option_num_t number, size_t len, const uint8_t *data)
Inserts option of given number in the pdu with the appropriate data.
Definition coap_pdu.c:626
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
#define COAP_DROPPED_RESPONSE
Indicates that a response is suppressed.
int coap_pdu_parse_header(coap_pdu_t *pdu, coap_proto_t proto)
Decode the protocol specific header for the specified PDU.
Definition coap_pdu.c:1073
size_t coap_pdu_parse_header_size(coap_proto_t proto, const uint8_t *data)
Interprets data to determine the number of bytes in the header.
Definition coap_pdu.c:989
#define COAP_PDU_DELAYED
#define COAP_PDU_IS_EMPTY(pdu)
#define COAP_PDU_IS_SIGNALING(pdu)
int coap_option_check_repeatable(coap_option_num_t number)
Check whether the option is allowed to be repeated or not.
Definition coap_pdu.c:583
int coap_pdu_parse_opt(coap_pdu_t *pdu)
Verify consistency in the given CoAP PDU structure and locate the data.
Definition coap_pdu.c:1335
size_t coap_update_option(coap_pdu_t *pdu, coap_option_num_t number, size_t len, const uint8_t *data)
Updates existing first option of given number in the pdu with the new data.
Definition coap_pdu.c:720
#define COAP_TOKEN_EXT_1B_TKL
size_t coap_pdu_encode_header(coap_pdu_t *pdu, coap_proto_t proto)
Compose the protocol specific header for the specified PDU.
Definition coap_pdu.c:1485
#define COAP_DEFAULT_VERSION
size_t coap_pdu_parse_size(coap_proto_t proto, const uint8_t *data, size_t length)
Parses data to extract the message size.
Definition coap_pdu.c:1020
int coap_pdu_resize(coap_pdu_t *pdu, size_t new_size)
Dynamically grows the size of pdu to new_size.
Definition coap_pdu.c:297
#define COAP_PDU_IS_REQUEST(pdu)
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:776
#define COAP_OPTION_HOP_LIMIT
Definition coap_pdu.h:133
#define COAP_OPTION_NORESPONSE
Definition coap_pdu.h:145
#define COAP_OPTION_URI_HOST
Definition coap_pdu.h:120
#define COAP_OPTION_IF_MATCH
Definition coap_pdu.h:119
#define COAP_OPTION_BLOCK2
Definition coap_pdu.h:137
const char * coap_response_phrase(unsigned char code)
Returns a human-readable response phrase for the specified CoAP response code.
Definition coap_pdu.c:947
#define COAP_OPTION_CONTENT_FORMAT
Definition coap_pdu.h:128
#define COAP_OPTION_BLOCK1
Definition coap_pdu.h:138
#define COAP_OPTION_Q_BLOCK1
Definition coap_pdu.h:135
#define COAP_OPTION_PROXY_SCHEME
Definition coap_pdu.h:142
#define COAP_OPTION_URI_QUERY
Definition coap_pdu.h:132
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition coap_pdu.h:263
#define COAP_TOKEN_DEFAULT_MAX
Definition coap_pdu.h:56
#define COAP_OPTION_IF_NONE_MATCH
Definition coap_pdu.h:122
#define COAP_TOKEN_EXT_MAX
Definition coap_pdu.h:60
#define COAP_OPTION_URI_PATH
Definition coap_pdu.h:127
#define COAP_SIGNALING_OPTION_EXTENDED_TOKEN_LENGTH
Definition coap_pdu.h:199
#define COAP_RESPONSE_CODE(N)
Definition coap_pdu.h:160
#define COAP_RESPONSE_CLASS(C)
Definition coap_pdu.h:163
coap_pdu_code_t
Set of codes available for a PDU.
Definition coap_pdu.h:326
#define COAP_OPTION_OSCORE
Definition coap_pdu.h:126
coap_pdu_type_t
CoAP PDU message type definitions.
Definition coap_pdu.h:68
#define COAP_SIGNALING_OPTION_BLOCK_WISE_TRANSFER
Definition coap_pdu.h:198
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
#define COAP_SIGNALING_OPTION_CUSTODY
Definition coap_pdu.h:202
int coap_pdu_parse(coap_proto_t proto, const uint8_t *data, size_t length, coap_pdu_t *pdu)
Parses data into the CoAP PDU structure given in result.
Definition coap_pdu.c:1462
#define COAP_OPTION_RTAG
Definition coap_pdu.h:146
#define COAP_OPTION_URI_PORT
Definition coap_pdu.h:124
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_OPTION_ACCEPT
Definition coap_pdu.h:134
#define COAP_INVALID_MID
Indicates an invalid message id.
Definition coap_pdu.h:266
#define COAP_OPTION_PROXY_URI
Definition coap_pdu.h:141
#define COAP_OPTION_OBSERVE
Definition coap_pdu.h:123
#define COAP_DEFAULT_URI_WELLKNOWN
well-known resources URI
Definition coap_pdu.h:53
#define COAP_BERT_BASE
Definition coap_pdu.h:44
#define COAP_OPTION_ECHO
Definition coap_pdu.h:144
#define COAP_MEDIATYPE_APPLICATION_LINK_FORMAT
Definition coap_pdu.h:214
#define COAP_SIGNALING_OPTION_MAX_MESSAGE_SIZE
Definition coap_pdu.h:197
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:841
@ COAP_REQUEST_GET
Definition coap_pdu.h:79
@ COAP_PROTO_WS
Definition coap_pdu.h:318
@ COAP_PROTO_DTLS
Definition coap_pdu.h:315
@ COAP_PROTO_UDP
Definition coap_pdu.h:314
@ COAP_PROTO_WSS
Definition coap_pdu.h:319
@ COAP_SIGNALING_CODE_ABORT
Definition coap_pdu.h:369
@ COAP_SIGNALING_CODE_CSM
Definition coap_pdu.h:365
@ COAP_SIGNALING_CODE_PING
Definition coap_pdu.h:366
@ COAP_REQUEST_CODE_DELETE
Definition coap_pdu.h:332
@ COAP_SIGNALING_CODE_PONG
Definition coap_pdu.h:367
@ COAP_EMPTY_CODE
Definition coap_pdu.h:327
@ COAP_REQUEST_CODE_GET
Definition coap_pdu.h:329
@ COAP_SIGNALING_CODE_RELEASE
Definition coap_pdu.h:368
@ COAP_REQUEST_CODE_FETCH
Definition coap_pdu.h:333
@ COAP_MESSAGE_NON
Definition coap_pdu.h:70
@ COAP_MESSAGE_ACK
Definition coap_pdu.h:71
@ COAP_MESSAGE_CON
Definition coap_pdu.h:69
@ COAP_MESSAGE_RST
Definition coap_pdu.h:72
void coap_connect_session(coap_session_t *session, coap_tick_t now)
ssize_t coap_session_delay_pdu(coap_session_t *session, coap_pdu_t *pdu, coap_queue_t *node)
#define COAP_DEFAULT_LEISURE_TICKS(s)
The DEFAULT_LEISURE definition for the session (s).
void coap_handle_nack(coap_session_t *session, coap_pdu_t *sent, const coap_nack_reason_t reason, const coap_mid_t mid)
size_t coap_session_max_pdu_rcv_size(const coap_session_t *session)
Get maximum acceptable receive PDU size.
coap_session_t * coap_endpoint_get_session(coap_endpoint_t *endpoint, const coap_packet_t *packet, coap_tick_t now)
Lookup the server session for the packet received on an endpoint, or create a new one.
void coap_free_endpoint_lkd(coap_endpoint_t *endpoint)
Release an endpoint and all the structures associated with it.
void coap_read_session(coap_context_t *ctx, coap_session_t *session, coap_tick_t now)
Definition coap_net.c:2277
void coap_session_server_keepalive_failed(coap_session_t *session)
Clear down a session following a keepalive failure.
#define COAP_NSTART(s)
#define COAP_MAX_PAYLOADS(s)
void coap_session_connected(coap_session_t *session)
Notify session that it has just connected or reconnected.
ssize_t coap_session_send_pdu(coap_session_t *session, coap_pdu_t *pdu)
Send a pdu according to the session's protocol.
Definition coap_net.c:1001
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.
void coap_session_disconnected_lkd(coap_session_t *session, coap_nack_reason_t reason)
Notify session that it has failed.
coap_endpoint_t * coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto)
Create a new endpoint for communicating with peers.
coap_session_t * coap_new_server_session(coap_context_t *ctx, coap_endpoint_t *ep, void *extra)
Creates a new server session for the specified endpoint.
@ COAP_EXT_T_NOT_CHECKED
Not checked.
@ COAP_EXT_T_CHECKING
Token size check request sent.
@ COAP_EXT_T_CHECKED
Token size valid.
void coap_session_set_mtu(coap_session_t *session, unsigned mtu)
Set the session MTU.
coap_session_state_t
coap_session_state_t values
#define COAP_PROTO_NOT_RELIABLE(p)
#define COAP_PROTO_RELIABLE(p)
@ COAP_SESSION_TYPE_HELLO
server-side ephemeral session for responding to a client hello
@ COAP_SESSION_TYPE_CLIENT
client-side
@ COAP_SESSION_STATE_CSM
@ COAP_SESSION_STATE_ESTABLISHED
@ COAP_SESSION_STATE_NONE
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:120
coap_binary_t * coap_new_binary(size_t size)
Returns a new binary object with at least size bytes storage allocated.
Definition coap_str.c:77
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
void coap_delete_binary(coap_binary_t *s)
Deletes the given coap_binary_t object and releases any memory allocated.
Definition coap_str.c:105
#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_string_t * coap_new_string(size_t size)
Returns a new string object with at least size+1 bytes storage allocated.
Definition coap_str.c:21
void coap_delete_string(coap_string_t *s)
Deletes the given string and releases any memory allocated.
Definition coap_str.c:46
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.
void coap_persist_cleanup(coap_context_t *context)
Close down persist tracking, releasing any memory used.
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.
int coap_cancel_observe_lkd(coap_session_t *session, coap_binary_t *token, coap_pdu_type_t message_type)
Cancel an observe that is being tracked by the client large receive logic.
void coap_handle_failed_notify(coap_context_t *context, coap_session_t *session, const coap_bin_const_t *token)
Handles a failed observe notify.
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.
int coap_epoll_is_supported(void)
Determine whether epoll is supported or not.
Definition coap_net.c:567
int coap_tls_is_supported(void)
Check whether TLS is available.
Definition coap_notls.c:41
int coap_af_unix_is_supported(void)
Check whether socket type AF_UNIX is available.
Definition coap_net.c:621
int coap_ipv6_is_supported(void)
Check whether IPv6 is available.
Definition coap_net.c:594
int coap_threadsafe_is_supported(void)
Determine whether libcoap is threadsafe or not.
Definition coap_net.c:576
int coap_dtls_is_supported(void)
Check whether DTLS is available.
Definition coap_notls.c:36
int coap_server_is_supported(void)
Check whether Server code is available.
Definition coap_net.c:612
int coap_client_is_supported(void)
Check whether Client code is available.
Definition coap_net.c:603
int coap_ipv4_is_supported(void)
Check whether IPv4 is available.
Definition coap_net.c:585
coap_string_t * coap_get_uri_path(const coap_pdu_t *request)
Extract uri_path string from request PDU.
Definition coap_uri.c:990
int coap_split_proxy_uri(const uint8_t *str_var, size_t len, coap_uri_t *uri)
Parses a given string into URI components.
Definition coap_uri.c:281
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:939
#define COAP_UNUSED
Definition libcoap.h:70
#define COAP_STATIC_INLINE
Definition libcoap.h:53
coap_address_t remote
remote address and port
Definition coap_io.h:56
coap_address_t local
local address and port
Definition coap_io.h:57
Multi-purpose address abstraction.
struct sockaddr_in sin
struct sockaddr_in6 sin6
struct sockaddr sa
union coap_address_t::@0 addr
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
CoAP binary data definition.
Definition coap_str.h:56
size_t length
length of binary data
Definition coap_str.h:57
uint8_t * s
binary data
Definition coap_str.h:58
Structure of Block options with BERT support.
Definition coap_block.h:51
unsigned int num
block number
Definition coap_block.h:52
unsigned int bert
Operating as BERT.
Definition coap_block.h:57
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_tick_t sendqueue_basetime
The time stamp in the first element of the sendqeue is relative to sendqueue_basetime.
coap_pong_handler_t pong_handler
Called when a ping response is received.
void * app
application-specific data
coap_session_t * sessions
client sessions
coap_nack_handler_t nack_handler
Called when a response issue has occurred.
unsigned int ping_timeout
Minimum inactivity time before sending a ping message.
coap_resource_t * resources
hash table or list of known resources
uint16_t * cache_ignore_options
CoAP options to ignore when creating a cache-key.
coap_opt_filter_t known_options
coap_ping_handler_t ping_handler
Called when a CoAP ping is received.
uint32_t csm_max_message_size
Value for CSM Max-Message-Size.
size_t cache_ignore_count
The number of CoAP options to ignore when creating a cache-key.
unsigned int max_handshake_sessions
Maximum number of simultaneous negotating sessions per endpoint.
coap_queue_t * sendqueue
uint32_t max_token_size
Largest token size supported RFC8974.
coap_response_handler_t response_handler
Called when a response is received.
coap_cache_entry_t * cache
CoAP cache-entry cache.
uint8_t mcast_per_resource
Mcast controlled on a per resource basis.
coap_endpoint_t * endpoint
the endpoints used for listening
uint32_t csm_timeout_ms
Timeout for waiting for a CSM from the remote side.
coap_event_handler_t handle_event
Callback function that is used to signal events to the application.
unsigned int session_timeout
Number of seconds of inactivity after which an unused session will be closed.
uint32_t block_mode
Zero or more COAP_BLOCK_ or'd options.
coap_resource_t * proxy_uri_resource
can be used for handling proxy URI resources
coap_dtls_spsk_t spsk_setup_data
Contains the initial PSK server setup data.
coap_resource_t * unknown_resource
can be used for handling unknown resources
unsigned int max_idle_sessions
Maximum number of simultaneous unused sessions per endpoint.
coap_bin_const_t key
Definition coap_dtls.h:381
coap_bin_const_t identity
Definition coap_dtls.h:380
coap_dtls_cpsk_info_t psk_info
Client PSK definition.
Definition coap_dtls.h:443
The structure used for defining the PKI setup data to be used.
Definition coap_dtls.h:312
uint8_t version
Definition coap_dtls.h:313
coap_bin_const_t hint
Definition coap_dtls.h:451
coap_bin_const_t key
Definition coap_dtls.h:452
The structure used for defining the Server PSK setup data to be used.
Definition coap_dtls.h:501
coap_dtls_spsk_info_t psk_info
Server PSK definition.
Definition coap_dtls.h:533
Abstraction of virtual endpoint that can be attached to coap_context_t.
coap_context_t * context
endpoint's context
coap_session_t * sessions
hash table or list of active sessions
coap_address_t bind_addr
local interface address
coap_socket_t sock
socket object for the interface, if any
coap_proto_t proto
protocol used on this interface
uint64_t state_token
state token
coap_binary_t * app_token
original PDU token
coap_layer_read_t l_read
coap_layer_write_t l_write
coap_layer_establish_t l_establish
Structure to hold large body (many blocks) client receive information.
uint64_t state_token
state token
coap_binary_t * app_token
app requesting PDU token
Structure to hold large body (many blocks) server receive information.
Structure to hold large body (many blocks) transmission information.
union coap_lg_xmit_t::@1 b
coap_pdu_t pdu
skeletal PDU
coap_l_block1_t b1
uint16_t option
large block transmisson CoAP option
Iterator to run through PDU options.
coap_option_num_t number
decoded option number
size_t length
length of payload
coap_addr_tuple_t addr_info
local and remote addresses
unsigned char * payload
payload
structure for CoAP PDUs
uint8_t * token
first byte of token (or extended length bytes prefix), if any, or options
coap_lg_xmit_t * lg_xmit
Holds ptr to lg_xmit if sending a set of blocks.
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.
uint8_t * data
first byte of payload, if any
coap_mid_t mid
message id, if any, in regular host byte order
uint32_t e_token_length
length of Token space (includes leading extended bytes
size_t used_size
used bytes of storage for token, options and payload
uint8_t crit_opt
Set if unknown critical option for proxy.
size_t alloc_size
allocated storage for token, options and payload
coap_session_t * session
Session responsible for PDU or NULL.
coap_pdu_type_t type
message type
Queue entry.
coap_session_t * session
the CoAP session
coap_pdu_t * pdu
the CoAP PDU to send
unsigned int timeout
the randomized timeout value
uint8_t is_mcast
Set if this is a queued mcast response.
struct coap_queue_t * next
coap_mid_t id
CoAP message id.
coap_tick_t t
when to send PDU for the next time
unsigned char retransmit_cnt
retransmission counter, will be removed when zero
Abstraction of resource that can be attached to coap_context_t.
coap_str_const_t ** proxy_name_list
Array valid names this host is known by (proxy support)
coap_str_const_t * uri_path
Request URI Path for this resource.
unsigned int observe
The next value for the Observe option.
coap_method_handler_t handler[7]
Used to store handlers for the seven coap methods GET, POST, PUT, DELETE, FETCH, PATCH and IPATCH.
unsigned int is_proxy_uri
resource created for proxy URI handler
unsigned int is_unknown
resource created for unknown handler
unsigned int is_reverse_proxy
resource created for reverse proxy URI handler
unsigned int observable
can be observed
size_t proxy_name_count
Count of valid names this host is known by (proxy support)
int flags
zero or more COAP_RESOURCE_FLAGS_* or'd together
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
volatile uint8_t max_token_checked
Check for max token size coap_ext_token_check_t.
uint8_t csm_not_seen
Set if timeout waiting for CSM.
unsigned ref_subscriptions
reference count of current subscriptions
coap_bin_const_t * psk_key
If client, this field contains the current pre-shared key for server; When this field is NULL,...
uint32_t block_mode
Zero or more COAP_BLOCK_ or'd options.
uint8_t doing_first
Set if doing client's first request.
uint8_t delay_recursive
Set if in coap_client_delay_first()
coap_socket_t sock
socket object for the session, if any
coap_pdu_t * partial_pdu
incomplete incoming pdu
uint32_t max_token_size
Largest token size supported RFC8974.
coap_bin_const_t * psk_identity
If client, this field contains the current identity for server; When this field is NULL,...
coap_session_state_t state
current state of relationship with peer
uint8_t csm_bert_rem_support
CSM TCP BERT blocks supported (remote)
coap_digest_t cached_pdu_cksum
Checksum of last CON request PDU.
coap_mid_t remote_test_mid
mid used for checking remote support
uint8_t read_header[8]
storage space for header of incoming message header
coap_addr_tuple_t addr_info
remote/local address info
coap_proto_t proto
protocol used
unsigned ref
reference count from queues
coap_response_t last_con_handler_res
The result of calling the response handler of the last CON.
coap_bin_const_t * psk_hint
If client, this field contains the server provided identity hint.
coap_bin_const_t * last_token
uint8_t doing_send_recv
Set if coap_send_recv() active.
coap_dtls_cpsk_t cpsk_setup_data
client provided PSK initial setup data
size_t mtu
path or CSM mtu (xmt)
size_t partial_read
if > 0 indicates number of bytes already read for an incoming message
void * tls
security parameters
uint16_t max_retransmit
maximum re-transmit count (default 4)
uint8_t csm_block_supported
CSM TCP blocks supported.
uint8_t proxy_session
Set if this is an ongoing proxy session.
uint8_t con_active
Active CON request sent.
coap_queue_t * delayqueue
list of delayed messages waiting to be sent
uint32_t tx_rtag
Next Request-Tag number to use.
coap_mid_t last_ping_mid
the last keepalive message id that was used in this session
coap_lg_srcv_t * lg_srcv
Server list of expected large receives.
coap_bin_const_t * req_token
Token in request pdu of coap_send_recv()
coap_pdu_t * resp_pdu
PDU returned in coap_send_recv() call.
coap_lg_crcv_t * lg_crcv
Client list of expected large receives.
coap_mid_t last_con_mid
The last CON mid that has been been processed.
coap_session_type_t type
client or server side socket
coap_mid_t last_ack_mid
The last ACK mid that has been been processed.
coap_context_t * context
session's context
size_t partial_write
if > 0 indicates number of bytes already written from the pdu at the head of sendqueue
coap_pdu_t * cached_pdu
Cached copy of last ACK response PDU.
coap_bin_const_t * echo
last token used to make a request
coap_layer_func_t lfunc[COAP_LAYER_LAST]
Layer functions to use.
coap_session_t * session
Used to determine session owner.
coap_endpoint_t * endpoint
Used by the epoll logic for a listening endpoint.
coap_address_t mcast_addr
remote address and port (multicast track)
coap_socket_flags_t flags
1 or more of COAP_SOCKET* flag values
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...
struct coap_session_t * session
subscriber session
coap_pdu_t * pdu
cache_key to identify requester
Representation of parsed URI.
Definition coap_uri.h:68
coap_str_const_t host
The host part of the URI.
Definition coap_uri.h:69