libcoap 4.3.5-develop-72190a8
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--2024 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
231 coap_delete_pdu(node->pdu);
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
767#ifdef WITH_LWIP
768 context->sendqueue = NULL;
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);
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);
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);
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) {
1206 coap_delete_pdu(pdu);
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)) == 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 assert(0);
1234 return 1;
1235 } else {
1236 session->delay_recursive = 1;
1237 }
1238 /*
1239 * Need to wait for first request to get out and response back before
1240 * continuing.. Response handler has to clear doing_first if not an error.
1241 */
1243 while (session->doing_first != 0) {
1244 int result = coap_io_process_lkd(session->context, 1000);
1245
1246 if (result < 0) {
1247 session->doing_first = 0;
1248 session->delay_recursive = 0;
1249 coap_session_release_lkd(session);
1250 return 0;
1251 }
1252
1253 /* coap_io_process_lkd() may have updated session state */
1254 if (session->state == COAP_SESSION_STATE_CSM &&
1255 current_state != COAP_SESSION_STATE_CSM) {
1256 /* Update timeout and restart the clock for CSM timeout */
1257 current_state = COAP_SESSION_STATE_CSM;
1258 timeout_ms = session->context->csm_timeout_ms;
1259 result = 0;
1260 }
1261
1262 if (result < timeout_ms) {
1263 timeout_ms -= result;
1264 } else {
1265 if (session->doing_first == 1) {
1266 /* Timeout failure of some sort with first request */
1267 session->doing_first = 0;
1268 if (session->state == COAP_SESSION_STATE_CSM) {
1269 coap_log_debug("** %s: timeout waiting for CSM response\n",
1270 coap_session_str(session));
1271 session->csm_not_seen = 1;
1272 coap_session_connected(session);
1273 } else {
1274 coap_log_debug("** %s: timeout waiting for first response\n",
1275 coap_session_str(session));
1276 }
1277 }
1278 }
1279 }
1280 session->delay_recursive = 0;
1281 coap_session_release_lkd(session);
1282 }
1283#else /* ! COAP_CLIENT_SUPPORT */
1284 (void)session;
1285#endif /* ! COAP_CLIENT_SUPPORT */
1286 return 1;
1287}
1288
1289/*
1290 * return 0 Invalid
1291 * 1 Valid
1292 */
1293int
1295
1296 /* Check validity of sending code */
1297 switch (COAP_RESPONSE_CLASS(pdu->code)) {
1298 case 0: /* Empty or request */
1299 case 2: /* Success */
1300 case 3: /* Reserved for future use */
1301 case 4: /* Client error */
1302 case 5: /* Server error */
1303 break;
1304 case 7: /* Reliable signalling */
1305 if (COAP_PROTO_RELIABLE(session->proto))
1306 break;
1307 /* Not valid if UDP */
1308 /* Fall through */
1309 case 1: /* Invalid */
1310 case 6: /* Invalid */
1311 default:
1312 return 0;
1313 }
1314 return 1;
1315}
1316
1317#if COAP_CLIENT_SUPPORT
1318/*
1319 * If type is CON and protocol is not reliable, there is no need to set up
1320 * lg_crcv if it can be built up based on sent PDU if there is a
1321 * (Q-)Block2 in the response. However, still need it for Observe, Oscore and
1322 * (Q-)Block1.
1323 */
1324static int
1325coap_check_send_need_lg_crcv(coap_session_t *session, coap_pdu_t *pdu) {
1326 coap_opt_iterator_t opt_iter;
1327
1328 if (
1329#if COAP_OSCORE_SUPPORT
1330 session->oscore_encryption ||
1331#endif /* COAP_OSCORE_SUPPORT */
1332 ((pdu->type == COAP_MESSAGE_NON || COAP_PROTO_RELIABLE(session->proto)) &&
1334 coap_check_option(pdu, COAP_OPTION_OBSERVE, &opt_iter) ||
1335#if COAP_Q_BLOCK_SUPPORT
1336 coap_check_option(pdu, COAP_OPTION_Q_BLOCK1, &opt_iter) ||
1337#endif /* COAP_Q_BLOCK_SUPPORT */
1338 coap_check_option(pdu, COAP_OPTION_BLOCK1, &opt_iter)) {
1339 return 1;
1340 }
1341 return 0;
1342}
1343#endif /* COAP_CLIENT_SUPPORT */
1344
1347 coap_mid_t mid;
1348
1349 coap_lock_lock(session->context, return COAP_INVALID_MID);
1350 mid = coap_send_lkd(session, pdu);
1351 coap_lock_unlock(session->context);
1352 return mid;
1353}
1354
1358#if COAP_CLIENT_SUPPORT
1359 coap_lg_crcv_t *lg_crcv = NULL;
1360 coap_opt_iterator_t opt_iter;
1361 coap_block_b_t block;
1362 int observe_action = -1;
1363 int have_block1 = 0;
1364 coap_opt_t *opt;
1365#endif /* COAP_CLIENT_SUPPORT */
1366
1367 assert(pdu);
1368
1370
1371 /* Check validity of sending code */
1372 if (!coap_check_code_class(session, pdu)) {
1373 coap_log_err("coap_send: Invalid PDU code (%d.%02d)\n",
1375 pdu->code & 0x1f);
1376 goto error;
1377 }
1378 pdu->session = session;
1379#if COAP_CLIENT_SUPPORT
1380 if (session->type == COAP_SESSION_TYPE_CLIENT &&
1381 !coap_netif_available(session)) {
1382 coap_log_debug("coap_send: Socket closed\n");
1383 goto error;
1384 }
1385 /*
1386 * If this is not the first client request and are waiting for a response
1387 * to the first client request, then drop sending out this next request
1388 * until all is properly established.
1389 */
1390 if (!coap_client_delay_first(session)) {
1391 goto error;
1392 }
1393
1394 /* Indicate support for Extended Tokens if appropriate */
1395 if (session->max_token_checked == COAP_EXT_T_NOT_CHECKED &&
1397 session->type == COAP_SESSION_TYPE_CLIENT &&
1398 COAP_PDU_IS_REQUEST(pdu)) {
1399 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1400 /*
1401 * When the pass / fail response for Extended Token is received, this PDU
1402 * will get transmitted.
1403 */
1404 if (coap_send_test_extended_token(session) == COAP_INVALID_MID) {
1405 goto error;
1406 }
1407 }
1408 /*
1409 * For reliable protocols, this will get cleared after CSM exchanged
1410 * in coap_session_connected()
1411 */
1412 session->doing_first = 1;
1413 if (!coap_client_delay_first(session)) {
1414 goto error;
1415 }
1416 }
1417
1418 /*
1419 * Check validity of token length
1420 */
1421 if (COAP_PDU_IS_REQUEST(pdu) &&
1422 pdu->actual_token.length > session->max_token_size) {
1423 coap_log_warn("coap_send: PDU dropped as token too long (%zu > %" PRIu32 ")\n",
1424 pdu->actual_token.length, session->max_token_size);
1425 goto error;
1426 }
1427
1428 /* A lot of the reliable code assumes type is CON */
1429 if (COAP_PROTO_RELIABLE(session->proto) && pdu->type != COAP_MESSAGE_CON)
1430 pdu->type = COAP_MESSAGE_CON;
1431
1432#if COAP_OSCORE_SUPPORT
1433 if (session->oscore_encryption) {
1434 if (session->recipient_ctx->initial_state == 1) {
1435 /*
1436 * Not sure if remote supports OSCORE, or is going to send us a
1437 * "4.01 + ECHO" etc. so need to hold off future coap_send()s until all
1438 * is OK. Continue sending current pdu to test things.
1439 */
1440 session->doing_first = 1;
1441 }
1442 /* Need to convert Proxy-Uri to Proxy-Scheme option if needed */
1444 goto error;
1445 }
1446 }
1447#endif /* COAP_OSCORE_SUPPORT */
1448
1449 if (!(session->block_mode & COAP_BLOCK_USE_LIBCOAP)) {
1450 return coap_send_internal(session, pdu);
1451 }
1452
1453 if (COAP_PDU_IS_REQUEST(pdu)) {
1454 uint8_t buf[4];
1455
1456 opt = coap_check_option(pdu, COAP_OPTION_OBSERVE, &opt_iter);
1457
1458 if (opt) {
1459 observe_action = coap_decode_var_bytes(coap_opt_value(opt),
1460 coap_opt_length(opt));
1461 }
1462
1463 if (coap_get_block_b(session, pdu, COAP_OPTION_BLOCK1, &block) &&
1464 (block.m == 1 || block.bert == 1)) {
1465 have_block1 = 1;
1466 }
1467#if COAP_Q_BLOCK_SUPPORT
1468 if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK1, &block) &&
1469 (block.m == 1 || block.bert == 1)) {
1470 if (have_block1) {
1471 coap_log_warn("Block1 and Q-Block1 cannot be in the same request\n");
1473 }
1474 have_block1 = 1;
1475 }
1476#endif /* COAP_Q_BLOCK_SUPPORT */
1477 if (observe_action != COAP_OBSERVE_CANCEL) {
1478 /* Warn about re-use of tokens */
1479 if (session->last_token &&
1480 coap_binary_equal(&pdu->actual_token, session->last_token)) {
1481 coap_log_debug("Token reused - see https://rfc-editor.org/rfc/rfc9175.html#section-4.2\n");
1482 }
1485 pdu->actual_token.length);
1486 } else {
1487 /* observe_action == COAP_OBSERVE_CANCEL */
1488 coap_binary_t tmp;
1489 int ret;
1490
1491 coap_log_debug("coap_send: Using coap_cancel_observe() to do OBSERVE cancellation\n");
1492 /* Unfortunately need to change the ptr type to be r/w */
1493 memcpy(&tmp.s, &pdu->actual_token.s, sizeof(tmp.s));
1494 tmp.length = pdu->actual_token.length;
1495 ret = coap_cancel_observe_lkd(session, &tmp, pdu->type);
1496 if (ret == 1) {
1497 /* Observe Cancel successfully sent */
1498 coap_delete_pdu(pdu);
1499 return ret;
1500 }
1501 /* Some mismatch somewhere - continue to send original packet */
1502 }
1503 if (!coap_check_option(pdu, COAP_OPTION_RTAG, &opt_iter) &&
1504 (session->block_mode & COAP_BLOCK_NO_PREEMPTIVE_RTAG) == 0 &&
1508 coap_encode_var_safe(buf, sizeof(buf),
1509 ++session->tx_rtag),
1510 buf);
1511 } else {
1512 memset(&block, 0, sizeof(block));
1513 }
1514
1515#if COAP_Q_BLOCK_SUPPORT
1516 /* Indicate support for Q-Block if appropriate */
1517 if (session->block_mode & COAP_BLOCK_TRY_Q_BLOCK &&
1518 session->type == COAP_SESSION_TYPE_CLIENT &&
1519 COAP_PDU_IS_REQUEST(pdu)) {
1520 if (coap_block_test_q_block(session, pdu) == COAP_INVALID_MID) {
1521 goto error;
1522 }
1523 session->doing_first = 1;
1524 if (!coap_client_delay_first(session)) {
1525 /* Q-Block test Session has failed for some reason */
1526 set_block_mode_drop_q(session->block_mode);
1527 goto error;
1528 }
1529 }
1530#endif /* COAP_Q_BLOCK_SUPPORT */
1531
1532#if COAP_Q_BLOCK_SUPPORT
1533 if (!(session->block_mode & COAP_BLOCK_HAS_Q_BLOCK))
1534#endif /* COAP_Q_BLOCK_SUPPORT */
1535 {
1536 /* Need to check if we need to reset Q-Block to Block */
1537 uint8_t buf[4];
1538
1539 if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK2, &block)) {
1542 coap_encode_var_safe(buf, sizeof(buf),
1543 (block.num << 4) | (0 << 3) | block.szx),
1544 buf);
1545 coap_log_debug("Replaced option Q-Block2 with Block2\n");
1546 /* Need to update associated lg_xmit */
1547 coap_lg_xmit_t *lg_xmit;
1548
1549 LL_FOREACH(session->lg_xmit, lg_xmit) {
1550 if (COAP_PDU_IS_REQUEST(&lg_xmit->pdu) &&
1551 lg_xmit->b.b1.app_token &&
1552 coap_binary_equal(&pdu->actual_token, lg_xmit->b.b1.app_token)) {
1553 /* Update the skeletal PDU with the block1 option */
1556 coap_encode_var_safe(buf, sizeof(buf),
1557 (block.num << 4) | (0 << 3) | block.szx),
1558 buf);
1559 break;
1560 }
1561 }
1562 }
1563 if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK1, &block)) {
1566 coap_encode_var_safe(buf, sizeof(buf),
1567 (block.num << 4) | (block.m << 3) | block.szx),
1568 buf);
1569 coap_log_debug("Replaced option Q-Block1 with Block1\n");
1570 /* Need to update associated lg_xmit */
1571 coap_lg_xmit_t *lg_xmit;
1572
1573 LL_FOREACH(session->lg_xmit, lg_xmit) {
1574 if (COAP_PDU_IS_REQUEST(&lg_xmit->pdu) &&
1575 lg_xmit->b.b1.app_token &&
1576 coap_binary_equal(&pdu->actual_token, lg_xmit->b.b1.app_token)) {
1577 /* Update the skeletal PDU with the block1 option */
1580 coap_encode_var_safe(buf, sizeof(buf),
1581 (block.num << 4) |
1582 (block.m << 3) |
1583 block.szx),
1584 buf);
1585 /* Update as this is a Request */
1586 lg_xmit->option = COAP_OPTION_BLOCK1;
1587 break;
1588 }
1589 }
1590 }
1591 }
1592
1593#if COAP_Q_BLOCK_SUPPORT
1594 if (COAP_PDU_IS_REQUEST(pdu) &&
1595 coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK2, &block)) {
1596 if (block.num == 0 && block.m == 0) {
1597 uint8_t buf[4];
1598
1599 /* M needs to be set as asking for all the blocks */
1601 coap_encode_var_safe(buf, sizeof(buf),
1602 (0 << 4) | (1 << 3) | block.szx),
1603 buf);
1604 }
1605 }
1606#endif /* COAP_Q_BLOCK_SUPPORT */
1607
1608 /*
1609 * If type is CON and protocol is not reliable, there is no need to set up
1610 * lg_crcv here as it can be built up based on sent PDU if there is a
1611 * (Q-)Block2 in the response. However, still need it for Observe, Oscore and
1612 * (Q-)Block1.
1613 */
1614 if (coap_check_send_need_lg_crcv(session, pdu)) {
1615 coap_lg_xmit_t *lg_xmit = NULL;
1616
1617 if (!session->lg_xmit && have_block1) {
1618 coap_log_debug("PDU presented by app\n");
1620 }
1621 /* See if this token is already in use for large body responses */
1622 LL_FOREACH(session->lg_crcv, lg_crcv) {
1623 if (coap_binary_equal(&pdu->actual_token, lg_crcv->app_token)) {
1624 /* Need to terminate and clean up previous response setup */
1625 LL_DELETE(session->lg_crcv, lg_crcv);
1626 coap_block_delete_lg_crcv(session, lg_crcv);
1627 break;
1628 }
1629 }
1630
1631 if (have_block1 && session->lg_xmit) {
1632 LL_FOREACH(session->lg_xmit, lg_xmit) {
1633 if (COAP_PDU_IS_REQUEST(&lg_xmit->pdu) &&
1634 lg_xmit->b.b1.app_token &&
1635 coap_binary_equal(&pdu->actual_token, lg_xmit->b.b1.app_token)) {
1636 break;
1637 }
1638 }
1639 }
1640 lg_crcv = coap_block_new_lg_crcv(session, pdu, lg_xmit);
1641 if (lg_crcv == NULL) {
1642 goto error;
1643 }
1644 if (lg_xmit) {
1645 /* Need to update the token as set up in the session->lg_xmit */
1646 lg_xmit->b.b1.state_token = lg_crcv->state_token;
1647 }
1648 }
1649 if (session->sock.flags & COAP_SOCKET_MULTICAST)
1650 coap_address_copy(&session->addr_info.remote, &session->sock.mcast_addr);
1651
1652#if COAP_Q_BLOCK_SUPPORT
1653 /* See if large xmit using Q-Block1 (but not testing Q-Block1) */
1654 if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK1, &block)) {
1655 mid = coap_send_q_block1(session, block, pdu, COAP_SEND_INC_PDU);
1656 } else
1657#endif /* COAP_Q_BLOCK_SUPPORT */
1658 mid = coap_send_internal(session, pdu);
1659#else /* !COAP_CLIENT_SUPPORT */
1660 mid = coap_send_internal(session, pdu);
1661#endif /* !COAP_CLIENT_SUPPORT */
1662#if COAP_CLIENT_SUPPORT
1663 if (lg_crcv) {
1664 if (mid != COAP_INVALID_MID) {
1665 LL_PREPEND(session->lg_crcv, lg_crcv);
1666 } else {
1667 coap_block_delete_lg_crcv(session, lg_crcv);
1668 }
1669 }
1670#endif /* COAP_CLIENT_SUPPORT */
1671 return mid;
1672
1673error:
1674 coap_delete_pdu(pdu);
1675 return COAP_INVALID_MID;
1676}
1677
1680 uint8_t r;
1681 ssize_t bytes_written;
1682 coap_opt_iterator_t opt_iter;
1683
1684 pdu->session = session;
1685 if (pdu->code == COAP_RESPONSE_CODE(508)) {
1686 /*
1687 * Need to prepend our IP identifier to the data as per
1688 * https://rfc-editor.org/rfc/rfc8768.html#section-4
1689 */
1690 char addr_str[INET6_ADDRSTRLEN + 8 + 1];
1691 coap_opt_t *opt;
1692 size_t hop_limit;
1693
1694 addr_str[sizeof(addr_str)-1] = '\000';
1695 if (coap_print_addr(&session->addr_info.local, (uint8_t *)addr_str,
1696 sizeof(addr_str) - 1)) {
1697 char *cp;
1698 size_t len;
1699
1700 if (addr_str[0] == '[') {
1701 cp = strchr(addr_str, ']');
1702 if (cp)
1703 *cp = '\000';
1704 if (memcmp(&addr_str[1], "::ffff:", 7) == 0) {
1705 /* IPv4 embedded into IPv6 */
1706 cp = &addr_str[8];
1707 } else {
1708 cp = &addr_str[1];
1709 }
1710 } else {
1711 cp = strchr(addr_str, ':');
1712 if (cp)
1713 *cp = '\000';
1714 cp = addr_str;
1715 }
1716 len = strlen(cp);
1717
1718 /* See if Hop Limit option is being used in return path */
1719 opt = coap_check_option(pdu, COAP_OPTION_HOP_LIMIT, &opt_iter);
1720 if (opt) {
1721 uint8_t buf[4];
1722
1723 hop_limit =
1725 if (hop_limit == 1) {
1726 coap_log_warn("Proxy loop detected '%s'\n",
1727 (char *)pdu->data);
1728 coap_delete_pdu(pdu);
1730 } else if (hop_limit < 1 || hop_limit > 255) {
1731 /* Something is bad - need to drop this pdu (TODO or delete option) */
1732 coap_log_warn("Proxy return has bad hop limit count '%zu'\n",
1733 hop_limit);
1734 coap_delete_pdu(pdu);
1736 }
1737 hop_limit--;
1739 coap_encode_var_safe8(buf, sizeof(buf), hop_limit),
1740 buf);
1741 }
1742
1743 /* Need to check that we are not seeing this proxy in the return loop */
1744 if (pdu->data && opt == NULL) {
1745 char *a_match;
1746 size_t data_len;
1747
1748 if (pdu->used_size + 1 > pdu->max_size) {
1749 /* No space */
1751 }
1752 if (!coap_pdu_resize(pdu, pdu->used_size + 1)) {
1753 /* Internal error */
1755 }
1756 data_len = pdu->used_size - (pdu->data - pdu->token);
1757 pdu->data[data_len] = '\000';
1758 a_match = strstr((char *)pdu->data, cp);
1759 if (a_match && (a_match == (char *)pdu->data || a_match[-1] == ' ') &&
1760 ((size_t)(a_match - (char *)pdu->data + len) == data_len ||
1761 a_match[len] == ' ')) {
1762 coap_log_warn("Proxy loop detected '%s'\n",
1763 (char *)pdu->data);
1764 coap_delete_pdu(pdu);
1766 }
1767 }
1768 if (pdu->used_size + len + 1 <= pdu->max_size) {
1769 size_t old_size = pdu->used_size;
1770 if (coap_pdu_resize(pdu, pdu->used_size + len + 1)) {
1771 if (pdu->data == NULL) {
1772 /*
1773 * Set Hop Limit to max for return path. If this libcoap is in
1774 * a proxy loop path, it will always decrement hop limit in code
1775 * above and hence timeout / drop the response as appropriate
1776 */
1777 hop_limit = 255;
1779 (uint8_t *)&hop_limit);
1780 coap_add_data(pdu, len, (uint8_t *)cp);
1781 } else {
1782 /* prepend with space separator, leaving hop limit "as is" */
1783 memmove(pdu->data + len + 1, pdu->data,
1784 old_size - (pdu->data - pdu->token));
1785 memcpy(pdu->data, cp, len);
1786 pdu->data[len] = ' ';
1787 pdu->used_size += len + 1;
1788 }
1789 }
1790 }
1791 }
1792 }
1793
1794 if (session->echo) {
1795 if (!coap_insert_option(pdu, COAP_OPTION_ECHO, session->echo->length,
1796 session->echo->s))
1797 goto error;
1798 coap_delete_bin_const(session->echo);
1799 session->echo = NULL;
1800 }
1801#if COAP_OSCORE_SUPPORT
1802 if (session->oscore_encryption) {
1803 /* Need to convert Proxy-Uri to Proxy-Scheme option if needed */
1805 goto error;
1806 }
1807#endif /* COAP_OSCORE_SUPPORT */
1808
1809 if (!coap_pdu_encode_header(pdu, session->proto)) {
1810 goto error;
1811 }
1812
1813#if !COAP_DISABLE_TCP
1814 if (COAP_PROTO_RELIABLE(session->proto) &&
1816 if (!session->csm_block_supported) {
1817 /*
1818 * Need to check that this instance is not sending any block options as
1819 * the remote end via CSM has not informed us that there is support
1820 * https://rfc-editor.org/rfc/rfc8323#section-5.3.2
1821 * This includes potential BERT blocks.
1822 */
1823 if (coap_check_option(pdu, COAP_OPTION_BLOCK1, &opt_iter) != NULL) {
1824 coap_log_debug("Remote end did not indicate CSM support for Block1 enabled\n");
1825 }
1826 if (coap_check_option(pdu, COAP_OPTION_BLOCK2, &opt_iter) != NULL) {
1827 coap_log_debug("Remote end did not indicate CSM support for Block2 enabled\n");
1828 }
1829 } else if (!session->csm_bert_rem_support) {
1830 coap_opt_t *opt;
1831
1832 opt = coap_check_option(pdu, COAP_OPTION_BLOCK1, &opt_iter);
1833 if (opt && COAP_OPT_BLOCK_SZX(opt) == 7) {
1834 coap_log_debug("Remote end did not indicate CSM support for BERT Block1\n");
1835 }
1836 opt = coap_check_option(pdu, COAP_OPTION_BLOCK2, &opt_iter);
1837 if (opt && COAP_OPT_BLOCK_SZX(opt) == 7) {
1838 coap_log_debug("Remote end did not indicate CSM support for BERT Block2\n");
1839 }
1840 }
1841 }
1842#endif /* !COAP_DISABLE_TCP */
1843
1844#if COAP_OSCORE_SUPPORT
1845 if (session->oscore_encryption &&
1846 pdu->type != COAP_MESSAGE_RST &&
1847 !(pdu->type == COAP_MESSAGE_ACK && pdu->code == COAP_EMPTY_CODE)) {
1848 /* Refactor PDU as appropriate RFC8613 */
1849 coap_pdu_t *osc_pdu = coap_oscore_new_pdu_encrypted_lkd(session, pdu, NULL,
1850 0);
1851
1852 if (osc_pdu == NULL) {
1853 coap_log_warn("OSCORE: PDU could not be encrypted\n");
1856 goto error;
1857 }
1858 bytes_written = coap_send_pdu(session, osc_pdu, NULL);
1859 coap_delete_pdu(pdu);
1860 pdu = osc_pdu;
1861 } else
1862#endif /* COAP_OSCORE_SUPPORT */
1863 bytes_written = coap_send_pdu(session, pdu, NULL);
1864
1865 if (bytes_written == COAP_PDU_DELAYED) {
1866 /* do not free pdu as it is stored with session for later use */
1867 return pdu->mid;
1868 }
1869 if (bytes_written < 0) {
1870 goto error;
1871 }
1872
1873#if !COAP_DISABLE_TCP
1874 if (COAP_PROTO_RELIABLE(session->proto) &&
1875 (size_t)bytes_written < pdu->used_size + pdu->hdr_size) {
1876 if (coap_session_delay_pdu(session, pdu, NULL) == COAP_PDU_DELAYED) {
1877 session->partial_write = (size_t)bytes_written;
1878 /* do not free pdu as it is stored with session for later use */
1879 return pdu->mid;
1880 } else {
1881 goto error;
1882 }
1883 }
1884#endif /* !COAP_DISABLE_TCP */
1885
1886 if (pdu->type != COAP_MESSAGE_CON
1887 || COAP_PROTO_RELIABLE(session->proto)) {
1888 coap_mid_t id = pdu->mid;
1889 coap_delete_pdu(pdu);
1890 return id;
1891 }
1892
1893 coap_queue_t *node = coap_new_node();
1894 if (!node) {
1895 coap_log_debug("coap_wait_ack: insufficient memory\n");
1896 goto error;
1897 }
1898
1899 node->id = pdu->mid;
1900 node->pdu = pdu;
1901 coap_prng_lkd(&r, sizeof(r));
1902 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
1903 node->timeout = coap_calc_timeout(session, r);
1904 return coap_wait_ack(session->context, session, node);
1905error:
1906 coap_delete_pdu(pdu);
1907 return COAP_INVALID_MID;
1908}
1909
1910static int send_recv_terminate = 0;
1911
1912void
1916
1917COAP_API int
1919 coap_pdu_t **response_pdu, uint32_t timeout_ms) {
1920 int ret;
1921
1922 coap_lock_lock(session->context, return 0);
1923 ret = coap_send_recv_lkd(session, request_pdu, response_pdu, timeout_ms);
1924 coap_lock_unlock(session->context);
1925 return ret;
1926}
1927
1928/*
1929 * Return 0 or +ve Time in function in ms after successful transfer
1930 * -1 Invalid timeout parameter
1931 * -2 Failed to transmit PDU
1932 * -3 Nack or Event handler invoked, cancelling request
1933 * -4 coap_io_process returned error (fail to re-lock or select())
1934 * -5 Response not received in the given time
1935 * -6 Terminated by user
1936 * -7 Client mode code not enabled
1937 */
1938int
1940 coap_pdu_t **response_pdu, uint32_t timeout_ms) {
1941#if COAP_CLIENT_SUPPORT
1943 uint32_t rem_timeout = timeout_ms;
1944 uint32_t block_mode = session->block_mode;
1945 int ret = 0;
1946 coap_tick_t now;
1947 coap_tick_t start;
1948 coap_tick_t ticks_so_far;
1949 uint32_t time_so_far_ms;
1950
1951 coap_ticks(&start);
1952 assert(request_pdu);
1953
1955
1956 session->resp_pdu = NULL;
1957 session->req_token = coap_new_bin_const(request_pdu->actual_token.s,
1958 request_pdu->actual_token.length);
1959
1960 if (timeout_ms == COAP_IO_NO_WAIT || timeout_ms == COAP_IO_WAIT) {
1961 ret = -1;
1962 goto fail;
1963 }
1964 if (session->state == COAP_SESSION_STATE_NONE) {
1965 ret = -3;
1966 goto fail;
1967 }
1968
1970 session->doing_send_recv = 1;
1971 /* So the user needs to delete the PDU */
1972 request_pdu->ref++;
1973 mid = coap_send_lkd(session, request_pdu);
1974 if (mid == COAP_INVALID_MID) {
1975 if (!session->doing_send_recv)
1976 ret = -3;
1977 else
1978 ret = -2;
1979 goto fail;
1980 }
1981
1982 /* Wait for the response to come in */
1983 while (rem_timeout > 0 && session->doing_send_recv && !session->resp_pdu) {
1984 if (send_recv_terminate) {
1985 ret = -6;
1986 goto fail;
1987 }
1988 ret = coap_io_process_lkd(session->context, rem_timeout);
1989 if (ret < 0) {
1990 ret = -4;
1991 goto fail;
1992 }
1993 /* timeout_ms is for timeout between specific request and response */
1994 coap_ticks(&now);
1995 ticks_so_far = now - session->last_rx_tx;
1996 time_so_far_ms = (uint32_t)((ticks_so_far * 1000) / COAP_TICKS_PER_SECOND);
1997 if (time_so_far_ms >= timeout_ms) {
1998 rem_timeout = 0;
1999 } else {
2000 rem_timeout = timeout_ms - time_so_far_ms;
2001 }
2002 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
2003 /* To pick up on (D)TLS setup issues */
2004 coap_ticks(&now);
2005 ticks_so_far = now - start;
2006 time_so_far_ms = (uint32_t)((ticks_so_far * 1000) / COAP_TICKS_PER_SECOND);
2007 if (time_so_far_ms >= timeout_ms) {
2008 rem_timeout = 0;
2009 } else {
2010 rem_timeout = timeout_ms - time_so_far_ms;
2011 }
2012 }
2013 }
2014
2015 if (rem_timeout) {
2016 coap_ticks(&now);
2017 ticks_so_far = now - start;
2018 time_so_far_ms = (uint32_t)((ticks_so_far * 1000) / COAP_TICKS_PER_SECOND);
2019 ret = time_so_far_ms;
2020 /* Give PDU to user */
2021 *response_pdu = session->resp_pdu;
2022 session->resp_pdu = NULL;
2023 if (*response_pdu == NULL) {
2024 ret = -3;
2025 }
2026 } else {
2027 /* If there is a resp_pdu, it will get cleared below */
2028 ret = -5;
2029 }
2030
2031fail:
2032 session->block_mode = block_mode;
2033 session->doing_send_recv = 0;
2034 if (session->resp_pdu && session->resp_pdu->ref)
2035 session->resp_pdu->ref--;
2036 coap_delete_pdu(session->resp_pdu);
2037 session->resp_pdu = NULL;
2039 session->req_token = NULL;
2040 return ret;
2041
2042#else /* !COAP_CLIENT_SUPPORT */
2043
2044 (void)session;
2045 (void)timeout_ms;
2046 (void)request_pdu;
2047 coap_log_warn("coap_send_recv: Client mode not supported\n");
2048 *response_pdu = NULL;
2049 return -7;
2050
2051#endif /* ! COAP_CLIENT_SUPPORT */
2052}
2053
2056 if (!context || !node)
2057 return COAP_INVALID_MID;
2058
2059 /* re-initialize timeout when maximum number of retransmissions are not reached yet */
2060 if (node->retransmit_cnt < node->session->max_retransmit) {
2061 ssize_t bytes_written;
2062 coap_tick_t now;
2063 coap_tick_t next_delay;
2064
2065 node->retransmit_cnt++;
2067
2068 next_delay = (coap_tick_t)node->timeout << node->retransmit_cnt;
2069 if (context->ping_timeout &&
2070 context->ping_timeout * COAP_TICKS_PER_SECOND < next_delay) {
2071 uint8_t byte;
2072
2073 coap_prng_lkd(&byte, sizeof(byte));
2074 /* Don't exceed the ping timeout value */
2075 next_delay = context->ping_timeout * COAP_TICKS_PER_SECOND - 255 + byte;
2076 }
2077
2078 coap_ticks(&now);
2079 if (context->sendqueue == NULL) {
2080 node->t = next_delay;
2081 context->sendqueue_basetime = now;
2082 } else {
2083 /* make node->t relative to context->sendqueue_basetime */
2084 node->t = (now - context->sendqueue_basetime) + next_delay;
2085 }
2086 coap_insert_node(&context->sendqueue, node);
2087
2088 if (node->is_mcast) {
2089 coap_log_debug("** %s: mid=0x%04x: mcast delayed transmission\n",
2090 coap_session_str(node->session), node->id);
2091 } else {
2092 coap_log_debug("** %s: mid=0x%04x: retransmission #%d (next %ums)\n",
2093 coap_session_str(node->session), node->id,
2094 node->retransmit_cnt,
2095 (unsigned)(next_delay * 1000 / COAP_TICKS_PER_SECOND));
2096 }
2097
2098 if (node->session->con_active)
2099 node->session->con_active--;
2100 bytes_written = coap_send_pdu(node->session, node->pdu, node);
2101
2102 if (node->is_mcast) {
2105 return COAP_INVALID_MID;
2106 }
2107 if (bytes_written == COAP_PDU_DELAYED) {
2108 /* PDU was not retransmitted immediately because a new handshake is
2109 in progress. node was moved to the send queue of the session. */
2110 return node->id;
2111 }
2112
2113 if (bytes_written < 0)
2114 return (int)bytes_written;
2115
2116 return node->id;
2117 }
2118
2119 /* no more retransmissions, remove node from system */
2120 coap_log_warn("** %s: mid=0x%04x: give up after %d attempts\n",
2121 coap_session_str(node->session), node->id, node->retransmit_cnt);
2122
2123#if COAP_SERVER_SUPPORT
2124 /* Check if subscriptions exist that should be canceled after
2125 COAP_OBS_MAX_FAIL */
2126 if (COAP_RESPONSE_CLASS(node->pdu->code) >= 2) {
2127 coap_handle_failed_notify(context, node->session, &node->pdu->actual_token);
2128 }
2129#endif /* COAP_SERVER_SUPPORT */
2130 if (node->session->con_active) {
2131 node->session->con_active--;
2133 /*
2134 * As there may be another CON in a different queue entry on the same
2135 * session that needs to be immediately released,
2136 * coap_session_connected() is called.
2137 * However, there is the possibility coap_wait_ack() may be called for
2138 * this node (queue) and re-added to context->sendqueue.
2139 * coap_delete_node_lkd(node) called shortly will handle this and
2140 * remove it.
2141 */
2143 }
2144 }
2145
2146 /* And finally delete the node */
2147 if (node->pdu->type == COAP_MESSAGE_CON) {
2149 }
2150#if COAP_CLIENT_SUPPORT
2151 node->session->doing_send_recv = 0;
2152#endif /* COAP_CLIENT_SUPPORT */
2154 return COAP_INVALID_MID;
2155}
2156
2157static int
2159 uint8_t *data;
2160 size_t data_len;
2161 int result = -1;
2162
2163 coap_packet_get_memmapped(packet, &data, &data_len);
2164 if (session->proto == COAP_PROTO_DTLS) {
2165#if COAP_SERVER_SUPPORT
2166 if (session->type == COAP_SESSION_TYPE_HELLO)
2167 result = coap_dtls_hello(session, data, data_len);
2168 else
2169#endif /* COAP_SERVER_SUPPORT */
2170 if (session->tls)
2171 result = coap_dtls_receive(session, data, data_len);
2172 } else if (session->proto == COAP_PROTO_UDP) {
2173 result = coap_handle_dgram(ctx, session, data, data_len);
2174 }
2175 return result;
2176}
2177
2178#if COAP_CLIENT_SUPPORT
2179void
2181#if COAP_DISABLE_TCP
2182 (void)now;
2183
2185#else /* !COAP_DISABLE_TCP */
2186 if (coap_netif_strm_connect2(session)) {
2187 session->last_rx_tx = now;
2189 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
2190 } else {
2193 }
2194#endif /* !COAP_DISABLE_TCP */
2195}
2196#endif /* COAP_CLIENT_SUPPORT */
2197
2198static void
2200 (void)ctx;
2201 assert(session->sock.flags & COAP_SOCKET_CONNECTED);
2202
2203 while (session->delayqueue) {
2204 ssize_t bytes_written;
2205 coap_queue_t *q = session->delayqueue;
2206 coap_log_debug("** %s: mid=0x%04x: transmitted after delay\n",
2207 coap_session_str(session), (int)q->pdu->mid);
2208 assert(session->partial_write < q->pdu->used_size + q->pdu->hdr_size);
2209 bytes_written = session->sock.lfunc[COAP_LAYER_SESSION].l_write(session,
2210 q->pdu->token - q->pdu->hdr_size + session->partial_write,
2211 q->pdu->used_size + q->pdu->hdr_size - session->partial_write);
2212 if (bytes_written > 0)
2213 session->last_rx_tx = now;
2214 if (bytes_written <= 0 ||
2215 (size_t)bytes_written < q->pdu->used_size + q->pdu->hdr_size - session->partial_write) {
2216 if (bytes_written > 0)
2217 session->partial_write += (size_t)bytes_written;
2218 break;
2219 }
2220 session->delayqueue = q->next;
2221 session->partial_write = 0;
2223 }
2224}
2225
2226void
2228#if COAP_CONSTRAINED_STACK
2229 /* payload and packet can be protected by global_lock if needed */
2230 static unsigned char payload[COAP_RXBUFFER_SIZE];
2231 static coap_packet_t s_packet;
2232#else /* ! COAP_CONSTRAINED_STACK */
2233 unsigned char payload[COAP_RXBUFFER_SIZE];
2234 coap_packet_t s_packet;
2235#endif /* ! COAP_CONSTRAINED_STACK */
2236 coap_packet_t *packet = &s_packet;
2237
2239
2240 packet->length = sizeof(payload);
2241 packet->payload = payload;
2242
2243 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
2244 ssize_t bytes_read;
2245 memcpy(&packet->addr_info, &session->addr_info, sizeof(packet->addr_info));
2246 bytes_read = coap_netif_dgrm_read(session, packet);
2247
2248 if (bytes_read < 0) {
2249 if (bytes_read == -2)
2250 /* Reset the session back to startup defaults */
2252 } else if (bytes_read > 0) {
2253 session->last_rx_tx = now;
2254 /* coap_netif_dgrm_read() updates session->addr_info from packet->addr_info */
2255 coap_handle_dgram_for_proto(ctx, session, packet);
2256 }
2257#if !COAP_DISABLE_TCP
2258 } else if (session->proto == COAP_PROTO_WS ||
2259 session->proto == COAP_PROTO_WSS) {
2260 ssize_t bytes_read = 0;
2261
2262 /* WebSocket layer passes us the whole packet */
2263 bytes_read = session->sock.lfunc[COAP_LAYER_SESSION].l_read(session,
2264 packet->payload,
2265 packet->length);
2266 if (bytes_read < 0) {
2268 } else if (bytes_read > 2) {
2269 coap_pdu_t *pdu;
2270
2271 session->last_rx_tx = now;
2272 /* Need max space incase PDU is updated with updated token etc. */
2273 pdu = coap_pdu_init(0, 0, 0, coap_session_max_pdu_rcv_size(session));
2274 if (!pdu) {
2275 return;
2276 }
2277
2278 if (!coap_pdu_parse(session->proto, packet->payload, bytes_read, pdu)) {
2280 coap_log_warn("discard malformed PDU\n");
2281 coap_delete_pdu(pdu);
2282 return;
2283 }
2284
2285 coap_dispatch(ctx, session, pdu);
2286 coap_delete_pdu(pdu);
2287 return;
2288 }
2289 } else {
2290 ssize_t bytes_read = 0;
2291 const uint8_t *p;
2292 int retry;
2293
2294 do {
2295 bytes_read = session->sock.lfunc[COAP_LAYER_SESSION].l_read(session,
2296 packet->payload,
2297 packet->length);
2298 if (bytes_read > 0) {
2299 session->last_rx_tx = now;
2300 }
2301 p = packet->payload;
2302 retry = bytes_read == (ssize_t)packet->length;
2303 while (bytes_read > 0) {
2304 if (session->partial_pdu) {
2305 size_t len = session->partial_pdu->used_size
2306 + session->partial_pdu->hdr_size
2307 - session->partial_read;
2308 size_t n = min(len, (size_t)bytes_read);
2309 memcpy(session->partial_pdu->token - session->partial_pdu->hdr_size
2310 + session->partial_read, p, n);
2311 p += n;
2312 bytes_read -= n;
2313 if (n == len) {
2314 if (coap_pdu_parse_header(session->partial_pdu, session->proto)
2315 && coap_pdu_parse_opt(session->partial_pdu)) {
2316 coap_dispatch(ctx, session, session->partial_pdu);
2317 }
2318 coap_delete_pdu(session->partial_pdu);
2319 session->partial_pdu = NULL;
2320 session->partial_read = 0;
2321 } else {
2322 session->partial_read += n;
2323 }
2324 } else if (session->partial_read > 0) {
2325 size_t hdr_size = coap_pdu_parse_header_size(session->proto,
2326 session->read_header);
2327 size_t tkl = session->read_header[0] & 0x0f;
2328 size_t tok_ext_bytes = tkl == COAP_TOKEN_EXT_1B_TKL ? 1 :
2329 tkl == COAP_TOKEN_EXT_2B_TKL ? 2 : 0;
2330 size_t len = hdr_size + tok_ext_bytes - session->partial_read;
2331 size_t n = min(len, (size_t)bytes_read);
2332 memcpy(session->read_header + session->partial_read, p, n);
2333 p += n;
2334 bytes_read -= n;
2335 if (n == len) {
2336 /* Header now all in */
2337 size_t size = coap_pdu_parse_size(session->proto, session->read_header,
2338 hdr_size + tok_ext_bytes);
2339 if (size > COAP_DEFAULT_MAX_PDU_RX_SIZE) {
2340 coap_log_warn("** %s: incoming PDU length too large (%zu > %lu)\n",
2341 coap_session_str(session),
2342 size, COAP_DEFAULT_MAX_PDU_RX_SIZE);
2343 bytes_read = -1;
2344 break;
2345 }
2346 /* Need max space incase PDU is updated with updated token etc. */
2347 session->partial_pdu = coap_pdu_init(0, 0, 0,
2349 if (session->partial_pdu == NULL) {
2350 bytes_read = -1;
2351 break;
2352 }
2353 if (session->partial_pdu->alloc_size < size && !coap_pdu_resize(session->partial_pdu, size)) {
2354 bytes_read = -1;
2355 break;
2356 }
2357 session->partial_pdu->hdr_size = (uint8_t)hdr_size;
2358 session->partial_pdu->used_size = size;
2359 memcpy(session->partial_pdu->token - hdr_size, session->read_header, hdr_size + tok_ext_bytes);
2360 session->partial_read = hdr_size + tok_ext_bytes;
2361 if (size == 0) {
2362 if (coap_pdu_parse_header(session->partial_pdu, session->proto)) {
2363 coap_dispatch(ctx, session, session->partial_pdu);
2364 }
2365 coap_delete_pdu(session->partial_pdu);
2366 session->partial_pdu = NULL;
2367 session->partial_read = 0;
2368 }
2369 } else {
2370 /* More of the header to go */
2371 session->partial_read += n;
2372 }
2373 } else {
2374 /* Get in first byte of the header */
2375 session->read_header[0] = *p++;
2376 bytes_read -= 1;
2377 if (!coap_pdu_parse_header_size(session->proto,
2378 session->read_header)) {
2379 bytes_read = -1;
2380 break;
2381 }
2382 session->partial_read = 1;
2383 }
2384 }
2385 } while (bytes_read == 0 && retry);
2386 if (bytes_read < 0)
2388#endif /* !COAP_DISABLE_TCP */
2389 }
2390}
2391
2392#if COAP_SERVER_SUPPORT
2393static int
2394coap_read_endpoint(coap_context_t *ctx, coap_endpoint_t *endpoint, coap_tick_t now) {
2395 ssize_t bytes_read = -1;
2396 int result = -1; /* the value to be returned */
2397#if COAP_CONSTRAINED_STACK
2398 /* payload and e_packet can be protected by global_lock if needed */
2399 static unsigned char payload[COAP_RXBUFFER_SIZE];
2400 static coap_packet_t e_packet;
2401#else /* ! COAP_CONSTRAINED_STACK */
2402 unsigned char payload[COAP_RXBUFFER_SIZE];
2403 coap_packet_t e_packet;
2404#endif /* ! COAP_CONSTRAINED_STACK */
2405 coap_packet_t *packet = &e_packet;
2406
2407 assert(COAP_PROTO_NOT_RELIABLE(endpoint->proto));
2408 assert(endpoint->sock.flags & COAP_SOCKET_BOUND);
2409
2410 /* Need to do this as there may be holes in addr_info */
2411 memset(&packet->addr_info, 0, sizeof(packet->addr_info));
2412 packet->length = sizeof(payload);
2413 packet->payload = payload;
2415 coap_address_copy(&packet->addr_info.local, &endpoint->bind_addr);
2416
2417 bytes_read = coap_netif_dgrm_read_ep(endpoint, packet);
2418 if (bytes_read < 0) {
2419 if (errno != EAGAIN) {
2420 coap_log_warn("* %s: read failed\n", coap_endpoint_str(endpoint));
2421 }
2422 } else if (bytes_read > 0) {
2423 coap_session_t *session = coap_endpoint_get_session(endpoint, packet, now);
2424 if (session) {
2425 coap_log_debug("* %s: netif: recv %4zd bytes\n",
2426 coap_session_str(session), bytes_read);
2427 result = coap_handle_dgram_for_proto(ctx, session, packet);
2428 if (endpoint->proto == COAP_PROTO_DTLS && session->type == COAP_SESSION_TYPE_HELLO && result == 1)
2429 coap_session_new_dtls_session(session, now);
2430 }
2431 }
2432 return result;
2433}
2434
2435static int
2436coap_write_endpoint(coap_context_t *ctx, coap_endpoint_t *endpoint, coap_tick_t now) {
2437 (void)ctx;
2438 (void)endpoint;
2439 (void)now;
2440 return 0;
2441}
2442
2443#if !COAP_DISABLE_TCP
2444static int
2445coap_accept_endpoint(coap_context_t *ctx, coap_endpoint_t *endpoint,
2446 coap_tick_t now, void *extra) {
2447 coap_session_t *session = coap_new_server_session(ctx, endpoint, extra);
2448 if (session)
2449 session->last_rx_tx = now;
2450 return session != NULL;
2451}
2452#endif /* !COAP_DISABLE_TCP */
2453#endif /* COAP_SERVER_SUPPORT */
2454
2455COAP_API void
2457 coap_lock_lock(ctx, return);
2458 coap_io_do_io_lkd(ctx, now);
2459 coap_lock_unlock(ctx);
2460}
2461
2462void
2464#ifdef COAP_EPOLL_SUPPORT
2465 (void)ctx;
2466 (void)now;
2467 coap_log_emerg("coap_io_do_io() requires libcoap not compiled for using epoll\n");
2468#else /* ! COAP_EPOLL_SUPPORT */
2469 coap_session_t *s, *rtmp;
2470
2472#if COAP_SERVER_SUPPORT
2473 coap_endpoint_t *ep, *tmp;
2474 LL_FOREACH_SAFE(ctx->endpoint, ep, tmp) {
2475 if ((ep->sock.flags & COAP_SOCKET_CAN_READ) != 0)
2476 coap_read_endpoint(ctx, ep, now);
2477 if ((ep->sock.flags & COAP_SOCKET_CAN_WRITE) != 0)
2478 coap_write_endpoint(ctx, ep, now);
2479#if !COAP_DISABLE_TCP
2480 if ((ep->sock.flags & COAP_SOCKET_CAN_ACCEPT) != 0)
2481 coap_accept_endpoint(ctx, ep, now, NULL);
2482#endif /* !COAP_DISABLE_TCP */
2483 SESSIONS_ITER_SAFE(ep->sessions, s, rtmp) {
2484 /* Make sure the session object is not deleted in one of the callbacks */
2486 if ((s->sock.flags & COAP_SOCKET_CAN_READ) != 0) {
2487 coap_read_session(ctx, s, now);
2488 }
2489 if ((s->sock.flags & COAP_SOCKET_CAN_WRITE) != 0) {
2490 coap_write_session(ctx, s, now);
2491 }
2493 }
2494 }
2495#endif /* COAP_SERVER_SUPPORT */
2496
2497#if COAP_CLIENT_SUPPORT
2498 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
2499 /* Make sure the session object is not deleted in one of the callbacks */
2501 if ((s->sock.flags & COAP_SOCKET_CAN_CONNECT) != 0) {
2502 coap_connect_session(s, now);
2503 }
2504 if ((s->sock.flags & COAP_SOCKET_CAN_READ) != 0 && s->ref > 1) {
2505 coap_read_session(ctx, s, now);
2506 }
2507 if ((s->sock.flags & COAP_SOCKET_CAN_WRITE) != 0 && s->ref > 1) {
2508 coap_write_session(ctx, s, now);
2509 }
2511 }
2512#endif /* COAP_CLIENT_SUPPORT */
2513#endif /* ! COAP_EPOLL_SUPPORT */
2514}
2515
2516COAP_API void
2517coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events, size_t nevents) {
2518 coap_lock_lock(ctx, return);
2519 coap_io_do_epoll_lkd(ctx, events, nevents);
2520 coap_lock_unlock(ctx);
2521}
2522
2523/*
2524 * While this code in part replicates coap_io_do_io_lkd(), doing the functions
2525 * directly saves having to iterate through the endpoints / sessions.
2526 */
2527void
2528coap_io_do_epoll_lkd(coap_context_t *ctx, struct epoll_event *events, size_t nevents) {
2529#ifndef COAP_EPOLL_SUPPORT
2530 (void)ctx;
2531 (void)events;
2532 (void)nevents;
2533 coap_log_emerg("coap_io_do_epoll() requires libcoap compiled for using epoll\n");
2534#else /* COAP_EPOLL_SUPPORT */
2535 coap_tick_t now;
2536 size_t j;
2537
2539 coap_ticks(&now);
2540 for (j = 0; j < nevents; j++) {
2541 coap_socket_t *sock = (coap_socket_t *)events[j].data.ptr;
2542
2543 /* Ignore 'timer trigger' ptr which is NULL */
2544 if (sock) {
2545#if COAP_SERVER_SUPPORT
2546 if (sock->endpoint) {
2547 coap_endpoint_t *endpoint = sock->endpoint;
2548 if ((sock->flags & COAP_SOCKET_WANT_READ) &&
2549 (events[j].events & EPOLLIN)) {
2550 sock->flags |= COAP_SOCKET_CAN_READ;
2551 coap_read_endpoint(endpoint->context, endpoint, now);
2552 }
2553
2554 if ((sock->flags & COAP_SOCKET_WANT_WRITE) &&
2555 (events[j].events & EPOLLOUT)) {
2556 /*
2557 * Need to update this to EPOLLIN as EPOLLOUT will normally always
2558 * be true causing epoll_wait to return early
2559 */
2560 coap_epoll_ctl_mod(sock, EPOLLIN, __func__);
2562 coap_write_endpoint(endpoint->context, endpoint, now);
2563 }
2564
2565#if !COAP_DISABLE_TCP
2566 if ((sock->flags & COAP_SOCKET_WANT_ACCEPT) &&
2567 (events[j].events & EPOLLIN)) {
2569 coap_accept_endpoint(endpoint->context, endpoint, now, NULL);
2570 }
2571#endif /* !COAP_DISABLE_TCP */
2572
2573 } else
2574#endif /* COAP_SERVER_SUPPORT */
2575 if (sock->session) {
2576 coap_session_t *session = sock->session;
2577
2578 /* Make sure the session object is not deleted
2579 in one of the callbacks */
2581#if COAP_CLIENT_SUPPORT
2582 if ((sock->flags & COAP_SOCKET_WANT_CONNECT) &&
2583 (events[j].events & (EPOLLOUT|EPOLLERR|EPOLLHUP|EPOLLRDHUP))) {
2585 coap_connect_session(session, now);
2586 if (coap_netif_available(session) &&
2587 !(sock->flags & COAP_SOCKET_WANT_WRITE)) {
2588 coap_epoll_ctl_mod(sock, EPOLLIN, __func__);
2589 }
2590 }
2591#endif /* COAP_CLIENT_SUPPORT */
2592
2593 if ((sock->flags & COAP_SOCKET_WANT_READ) &&
2594 (events[j].events & (EPOLLIN|EPOLLERR|EPOLLHUP|EPOLLRDHUP))) {
2595 sock->flags |= COAP_SOCKET_CAN_READ;
2596 coap_read_session(session->context, session, now);
2597 }
2598
2599 if ((sock->flags & COAP_SOCKET_WANT_WRITE) &&
2600 (events[j].events & (EPOLLOUT|EPOLLERR|EPOLLHUP|EPOLLRDHUP))) {
2601 /*
2602 * Need to update this to EPOLLIN as EPOLLOUT will normally always
2603 * be true causing epoll_wait to return early
2604 */
2605 coap_epoll_ctl_mod(sock, EPOLLIN, __func__);
2607 coap_write_session(session->context, session, now);
2608 }
2609 /* Now dereference session so it can go away if needed */
2610 coap_session_release_lkd(session);
2611 }
2612 } else if (ctx->eptimerfd != -1) {
2613 /*
2614 * 'timer trigger' must have fired. eptimerfd needs to be read to clear
2615 * it so that it does not set EPOLLIN in the next epoll_wait().
2616 */
2617 uint64_t count;
2618
2619 /* Check the result from read() to suppress the warning on
2620 * systems that declare read() with warn_unused_result. */
2621 if (read(ctx->eptimerfd, &count, sizeof(count)) == -1) {
2622 /* do nothing */;
2623 }
2624 }
2625 }
2626 /* And update eptimerfd as to when to next trigger */
2627 coap_ticks(&now);
2628 coap_io_prepare_epoll_lkd(ctx, now);
2629#endif /* COAP_EPOLL_SUPPORT */
2630}
2631
2632int
2634 uint8_t *msg, size_t msg_len) {
2635
2636 coap_pdu_t *pdu = NULL;
2637
2638 assert(COAP_PROTO_NOT_RELIABLE(session->proto));
2639 if (msg_len < 4) {
2640 /* Minimum size of CoAP header - ignore runt */
2641 return -1;
2642 }
2643 if ((msg[0] >> 6) != COAP_DEFAULT_VERSION) {
2644 /*
2645 * As per https://datatracker.ietf.org/doc/html/rfc7252#section-3,
2646 * this MUST be silently ignored.
2647 */
2648 coap_log_debug("coap_handle_dgram: UDP version not supported\n");
2649 return -1;
2650 }
2651
2652 /* Need max space incase PDU is updated with updated token etc. */
2653 pdu = coap_pdu_init(0, 0, 0, coap_session_max_pdu_rcv_size(session));
2654 if (!pdu)
2655 goto error;
2656
2657 if (!coap_pdu_parse(session->proto, msg, msg_len, pdu)) {
2659 coap_log_warn("discard malformed PDU\n");
2660 goto error;
2661 }
2662
2663 coap_dispatch(ctx, session, pdu);
2664 coap_delete_pdu(pdu);
2665 return 0;
2666
2667error:
2668 /*
2669 * https://rfc-editor.org/rfc/rfc7252#section-4.2 MUST send RST
2670 * https://rfc-editor.org/rfc/rfc7252#section-4.3 MAY send RST
2671 */
2672 coap_send_rst_lkd(session, pdu);
2673 coap_delete_pdu(pdu);
2674 return -1;
2675}
2676
2677int
2679 coap_queue_t **node) {
2680 coap_queue_t *p, *q;
2681
2682 if (!queue || !*queue)
2683 return 0;
2684
2685 /* replace queue head if PDU's time is less than head's time */
2686
2687 if (session == (*queue)->session && id == (*queue)->id) { /* found message id */
2688 *node = *queue;
2689 *queue = (*queue)->next;
2690 if (*queue) { /* adjust relative time of new queue head */
2691 (*queue)->t += (*node)->t;
2692 }
2693 (*node)->next = NULL;
2694 coap_log_debug("** %s: mid=0x%04x: removed (1)\n",
2695 coap_session_str(session), id);
2696 return 1;
2697 }
2698
2699 /* search message id queue to remove (only first occurence will be removed) */
2700 q = *queue;
2701 do {
2702 p = q;
2703 q = q->next;
2704 } while (q && (session != q->session || id != q->id));
2705
2706 if (q) { /* found message id */
2707 p->next = q->next;
2708 if (p->next) { /* must update relative time of p->next */
2709 p->next->t += q->t;
2710 }
2711 q->next = NULL;
2712 *node = q;
2713 coap_log_debug("** %s: mid=0x%04x: removed (2)\n",
2714 coap_session_str(session), id);
2715 return 1;
2716 }
2717
2718 return 0;
2719
2720}
2721
2722void
2724 coap_nack_reason_t reason) {
2725 coap_queue_t *p, *q;
2726
2727 while (context->sendqueue && context->sendqueue->session == session) {
2728 q = context->sendqueue;
2729 context->sendqueue = q->next;
2730 coap_log_debug("** %s: mid=0x%04x: removed (3)\n",
2731 coap_session_str(session), q->id);
2732 if (q->pdu->type == COAP_MESSAGE_CON) {
2733 coap_handle_nack(session, q->pdu, reason, q->id);
2734 }
2736 }
2737
2738 if (!context->sendqueue)
2739 return;
2740
2741 p = context->sendqueue;
2742 q = p->next;
2743
2744 while (q) {
2745 if (q->session == session) {
2746 p->next = q->next;
2747 coap_log_debug("** %s: mid=0x%04x: removed (4)\n",
2748 coap_session_str(session), q->id);
2749 if (q->pdu->type == COAP_MESSAGE_CON) {
2750 coap_handle_nack(session, q->pdu, reason, q->id);
2751 }
2753 q = p->next;
2754 } else {
2755 p = q;
2756 q = q->next;
2757 }
2758 }
2759}
2760
2761void
2763 coap_bin_const_t *token) {
2764 /* cancel all messages in sendqueue that belong to session
2765 * and use the specified token */
2766 coap_queue_t **p, *q;
2767
2768 if (!context->sendqueue)
2769 return;
2770
2771 p = &context->sendqueue;
2772 q = *p;
2773
2774 while (q) {
2775 if (q->session == session &&
2776 coap_binary_equal(&q->pdu->actual_token, token)) {
2777 *p = q->next;
2778 coap_log_debug("** %s: mid=0x%04x: removed (6)\n",
2779 coap_session_str(session), q->id);
2780 if (q->pdu->type == COAP_MESSAGE_CON && session->con_active) {
2781 session->con_active--;
2782 if (session->state == COAP_SESSION_STATE_ESTABLISHED)
2783 /* Flush out any entries on session->delayqueue */
2784 coap_session_connected(session);
2785 }
2787 } else {
2788 p = &(q->next);
2789 }
2790 q = *p;
2791 }
2792}
2793
2794coap_pdu_t *
2796 coap_opt_filter_t *opts) {
2797 coap_opt_iterator_t opt_iter;
2798 coap_pdu_t *response;
2799 size_t size = request->e_token_length;
2800 unsigned char type;
2801 coap_opt_t *option;
2802 coap_option_num_t opt_num = 0; /* used for calculating delta-storage */
2803
2804#if COAP_ERROR_PHRASE_LENGTH > 0
2805 const char *phrase;
2806 if (code != COAP_RESPONSE_CODE(508)) {
2807 phrase = coap_response_phrase(code);
2808
2809 /* Need some more space for the error phrase and payload start marker */
2810 if (phrase)
2811 size += strlen(phrase) + 1;
2812 } else {
2813 /*
2814 * Need space for IP for 5.08 response which is filled in in
2815 * coap_send_internal()
2816 * https://rfc-editor.org/rfc/rfc8768.html#section-4
2817 */
2818 phrase = NULL;
2819 size += INET6_ADDRSTRLEN;
2820 }
2821#endif
2822
2823 assert(request);
2824
2825 /* cannot send ACK if original request was not confirmable */
2826 type = request->type == COAP_MESSAGE_CON ?
2828
2829 /* Estimate how much space we need for options to copy from
2830 * request. We always need the Token, for 4.02 the unknown critical
2831 * options must be included as well. */
2832
2833 /* we do not want these */
2836 /* Unsafe to send this back */
2838
2839 coap_option_iterator_init(request, &opt_iter, opts);
2840
2841 /* Add size of each unknown critical option. As known critical
2842 options as well as elective options are not copied, the delta
2843 value might grow.
2844 */
2845 while ((option = coap_option_next(&opt_iter))) {
2846 uint16_t delta = opt_iter.number - opt_num;
2847 /* calculate space required to encode (opt_iter.number - opt_num) */
2848 if (delta < 13) {
2849 size++;
2850 } else if (delta < 269) {
2851 size += 2;
2852 } else {
2853 size += 3;
2854 }
2855
2856 /* add coap_opt_length(option) and the number of additional bytes
2857 * required to encode the option length */
2858
2859 size += coap_opt_length(option);
2860 switch (*option & 0x0f) {
2861 case 0x0e:
2862 size++;
2863 /* fall through */
2864 case 0x0d:
2865 size++;
2866 break;
2867 default:
2868 ;
2869 }
2870
2871 opt_num = opt_iter.number;
2872 }
2873
2874 /* Now create the response and fill with options and payload data. */
2875 response = coap_pdu_init(type, code, request->mid, size);
2876 if (response) {
2877 /* copy token */
2878 if (!coap_add_token(response, request->actual_token.length,
2879 request->actual_token.s)) {
2880 coap_log_debug("cannot add token to error response\n");
2881 coap_delete_pdu(response);
2882 return NULL;
2883 }
2884
2885 /* copy all options */
2886 coap_option_iterator_init(request, &opt_iter, opts);
2887 while ((option = coap_option_next(&opt_iter))) {
2888 coap_add_option_internal(response, opt_iter.number,
2889 coap_opt_length(option),
2890 coap_opt_value(option));
2891 }
2892
2893#if COAP_ERROR_PHRASE_LENGTH > 0
2894 /* note that diagnostic messages do not need a Content-Format option. */
2895 if (phrase)
2896 coap_add_data(response, (size_t)strlen(phrase), (const uint8_t *)phrase);
2897#endif
2898 }
2899
2900 return response;
2901}
2902
2903#if COAP_SERVER_SUPPORT
2904#define SZX_TO_BYTES(SZX) ((size_t)(1 << ((SZX) + 4)))
2905
2906static void
2907free_wellknown_response(coap_session_t *session COAP_UNUSED, void *app_ptr) {
2908 coap_delete_string(app_ptr);
2909}
2910
2911/*
2912 * Caution: As this handler is in libcoap space, it is called with
2913 * context locked.
2914 */
2915static void
2916hnd_get_wellknown_lkd(coap_resource_t *resource,
2917 coap_session_t *session,
2918 const coap_pdu_t *request,
2919 const coap_string_t *query,
2920 coap_pdu_t *response) {
2921 size_t len = 0;
2922 coap_string_t *data_string = NULL;
2923 coap_print_status_t result = 0;
2924 size_t wkc_len = 0;
2925 uint8_t buf[4];
2926
2927 /*
2928 * Quick hack to determine the size of the resource descriptions for
2929 * .well-known/core.
2930 */
2931 result = coap_print_wellknown_lkd(session->context, buf, &wkc_len, UINT_MAX, query);
2932 if (result & COAP_PRINT_STATUS_ERROR) {
2933 coap_log_warn("cannot determine length of /.well-known/core\n");
2934 goto error;
2935 }
2936
2937 if (wkc_len > 0) {
2938 data_string = coap_new_string(wkc_len);
2939 if (!data_string)
2940 goto error;
2941
2942 len = wkc_len;
2943 result = coap_print_wellknown_lkd(session->context, data_string->s, &len, 0, query);
2944 if ((result & COAP_PRINT_STATUS_ERROR) != 0) {
2945 coap_log_debug("coap_print_wellknown failed\n");
2946 goto error;
2947 }
2948 assert(len <= (size_t)wkc_len);
2949 data_string->length = len;
2950
2951 if (!(session->block_mode & COAP_BLOCK_USE_LIBCOAP)) {
2953 coap_encode_var_safe(buf, sizeof(buf),
2955 goto error;
2956 }
2957 if (response->used_size + len + 1 > response->max_size) {
2958 /*
2959 * Data does not fit into a packet and no libcoap block support
2960 * +1 for end of options marker
2961 */
2962 coap_log_debug(".well-known/core: truncating data length to %zu from %zu\n",
2963 len, response->max_size - response->used_size - 1);
2964 len = response->max_size - response->used_size - 1;
2965 }
2966 if (!coap_add_data(response, len, data_string->s)) {
2967 goto error;
2968 }
2969 free_wellknown_response(session, data_string);
2970 } else if (!coap_add_data_large_response_lkd(resource, session, request,
2971 response, query,
2973 -1, 0, data_string->length,
2974 data_string->s,
2975 free_wellknown_response,
2976 data_string)) {
2977 goto error_released;
2978 }
2979 } else {
2981 coap_encode_var_safe(buf, sizeof(buf),
2983 goto error;
2984 }
2985 }
2986 response->code = COAP_RESPONSE_CODE(205);
2987 return;
2988
2989error:
2990 free_wellknown_response(session, data_string);
2991error_released:
2992 if (response->code == 0) {
2993 /* set error code 5.03 and remove all options and data from response */
2994 response->code = COAP_RESPONSE_CODE(503);
2995 response->used_size = response->e_token_length;
2996 response->data = NULL;
2997 }
2998}
2999#endif /* COAP_SERVER_SUPPORT */
3000
3011static int
3013 int num_cancelled = 0; /* the number of observers cancelled */
3014
3015#ifndef COAP_SERVER_SUPPORT
3016 (void)sent;
3017#endif /* ! COAP_SERVER_SUPPORT */
3018 (void)context;
3019
3020#if COAP_SERVER_SUPPORT
3021 /* remove observer for this resource, if any
3022 * Use token from sent and try to find a matching resource. Uh!
3023 */
3024 RESOURCES_ITER(context->resources, r) {
3025 coap_cancel_all_messages(context, sent->session, &sent->pdu->actual_token);
3026 num_cancelled += coap_delete_observer(r, sent->session, &sent->pdu->actual_token);
3027 }
3028#endif /* COAP_SERVER_SUPPORT */
3029
3030 return num_cancelled;
3031}
3032
3033#if COAP_SERVER_SUPPORT
3038enum respond_t { RESPONSE_DEFAULT, RESPONSE_DROP, RESPONSE_SEND };
3039
3040/*
3041 * Checks for No-Response option in given @p request and
3042 * returns @c RESPONSE_DROP if @p response should be suppressed
3043 * according to RFC 7967.
3044 *
3045 * If the response is a confirmable piggybacked response and RESPONSE_DROP,
3046 * change it to an empty ACK and @c RESPONSE_SEND so the client does not keep
3047 * on retrying.
3048 *
3049 * Checks if the response code is 0.00 and if either the session is reliable or
3050 * non-confirmable, @c RESPONSE_DROP is also returned.
3051 *
3052 * Multicast response checking is also carried out.
3053 *
3054 * NOTE: It is the responsibility of the application to determine whether
3055 * a delayed separate response should be sent as the original requesting packet
3056 * containing the No-Response option has long since gone.
3057 *
3058 * The value of the No-Response option is encoded as
3059 * follows:
3060 *
3061 * @verbatim
3062 * +-------+-----------------------+-----------------------------------+
3063 * | Value | Binary Representation | Description |
3064 * +-------+-----------------------+-----------------------------------+
3065 * | 0 | <empty> | Interested in all responses. |
3066 * +-------+-----------------------+-----------------------------------+
3067 * | 2 | 00000010 | Not interested in 2.xx responses. |
3068 * +-------+-----------------------+-----------------------------------+
3069 * | 8 | 00001000 | Not interested in 4.xx responses. |
3070 * +-------+-----------------------+-----------------------------------+
3071 * | 16 | 00010000 | Not interested in 5.xx responses. |
3072 * +-------+-----------------------+-----------------------------------+
3073 * @endverbatim
3074 *
3075 * @param request The CoAP request to check for the No-Response option.
3076 * This parameter must not be NULL.
3077 * @param response The response that is potentially suppressed.
3078 * This parameter must not be NULL.
3079 * @param session The session this request/response are associated with.
3080 * This parameter must not be NULL.
3081 * @return RESPONSE_DEFAULT when no special treatment is requested,
3082 * RESPONSE_DROP when the response must be discarded, or
3083 * RESPONSE_SEND when the response must be sent.
3084 */
3085static enum respond_t
3086no_response(coap_pdu_t *request, coap_pdu_t *response,
3087 coap_session_t *session, coap_resource_t *resource) {
3088 coap_opt_t *nores;
3089 coap_opt_iterator_t opt_iter;
3090 unsigned int val = 0;
3091
3092 assert(request);
3093 assert(response);
3094
3095 if (COAP_RESPONSE_CLASS(response->code) > 0) {
3096 nores = coap_check_option(request, COAP_OPTION_NORESPONSE, &opt_iter);
3097
3098 if (nores) {
3100
3101 /* The response should be dropped when the bit corresponding to
3102 * the response class is set (cf. table in function
3103 * documentation). When a No-Response option is present and the
3104 * bit is not set, the sender explicitly indicates interest in
3105 * this response. */
3106 if (((1 << (COAP_RESPONSE_CLASS(response->code) - 1)) & val) > 0) {
3107 /* Should be dropping the response */
3108 if (response->type == COAP_MESSAGE_ACK &&
3109 COAP_PROTO_NOT_RELIABLE(session->proto)) {
3110 /* Still need to ACK the request */
3111 response->code = 0;
3112 /* Remove token/data from piggybacked acknowledgment PDU */
3113 response->actual_token.length = 0;
3114 response->e_token_length = 0;
3115 response->used_size = 0;
3116 response->data = NULL;
3117 return RESPONSE_SEND;
3118 } else {
3119 return RESPONSE_DROP;
3120 }
3121 } else {
3122 /* True for mcast as well RFC7967 2.1 */
3123 return RESPONSE_SEND;
3124 }
3125 } else if (resource && session->context->mcast_per_resource &&
3126 coap_is_mcast(&session->addr_info.local)) {
3127 /* Handle any mcast suppression specifics if no NoResponse option */
3128 if ((resource->flags &
3130 COAP_RESPONSE_CLASS(response->code) == 2) {
3131 return RESPONSE_DROP;
3132 } else if ((resource->flags &
3134 response->code == COAP_RESPONSE_CODE(205)) {
3135 if (response->data == NULL)
3136 return RESPONSE_DROP;
3137 } else if ((resource->flags &
3139 COAP_RESPONSE_CLASS(response->code) == 4) {
3140 return RESPONSE_DROP;
3141 } else if ((resource->flags &
3143 COAP_RESPONSE_CLASS(response->code) == 5) {
3144 return RESPONSE_DROP;
3145 }
3146 }
3147 } else if (COAP_PDU_IS_EMPTY(response) &&
3148 (response->type == COAP_MESSAGE_NON ||
3149 COAP_PROTO_RELIABLE(session->proto))) {
3150 /* response is 0.00, and this is reliable or non-confirmable */
3151 return RESPONSE_DROP;
3152 }
3153
3154 /*
3155 * Do not send error responses for requests that were received via
3156 * IP multicast. RFC7252 8.1
3157 */
3158
3159 if (coap_is_mcast(&session->addr_info.local)) {
3160 if (request->type == COAP_MESSAGE_NON &&
3161 response->type == COAP_MESSAGE_RST)
3162 return RESPONSE_DROP;
3163
3164 if ((!resource || session->context->mcast_per_resource == 0) &&
3165 COAP_RESPONSE_CLASS(response->code) > 2)
3166 return RESPONSE_DROP;
3167 }
3168
3169 /* Default behavior applies when we are not dealing with a response
3170 * (class == 0) or the request did not contain a No-Response option.
3171 */
3172 return RESPONSE_DEFAULT;
3173}
3174
3175static coap_str_const_t coap_default_uri_wellknown = {
3177 (const uint8_t *)COAP_DEFAULT_URI_WELLKNOWN
3178};
3179
3180/* Initialized in coap_startup() */
3181static coap_resource_t resource_uri_wellknown;
3182
3183static void
3184handle_request(coap_context_t *context, coap_session_t *session, coap_pdu_t *pdu) {
3185 coap_method_handler_t h = NULL;
3186 coap_pdu_t *response = NULL;
3187 coap_opt_filter_t opt_filter;
3188 coap_resource_t *resource = NULL;
3189 /* The respond field indicates whether a response must be treated
3190 * specially due to a No-Response option that declares disinterest
3191 * or interest in a specific response class. DEFAULT indicates that
3192 * No-Response has not been specified. */
3193 enum respond_t respond = RESPONSE_DEFAULT;
3194 coap_opt_iterator_t opt_iter;
3195 coap_opt_t *opt;
3196 int is_proxy_uri = 0;
3197 int is_proxy_scheme = 0;
3198 int skip_hop_limit_check = 0;
3199 int resp = 0;
3200 int send_early_empty_ack = 0;
3201 coap_string_t *query = NULL;
3202 coap_opt_t *observe = NULL;
3203 coap_string_t *uri_path = NULL;
3204 int observe_action = COAP_OBSERVE_CANCEL;
3205 coap_block_b_t block;
3206 int added_block = 0;
3207 coap_lg_srcv_t *free_lg_srcv = NULL;
3208#if COAP_Q_BLOCK_SUPPORT
3209 int lg_xmit_ctrl = 0;
3210#endif /* COAP_Q_BLOCK_SUPPORT */
3211#if COAP_ASYNC_SUPPORT
3212 coap_async_t *async;
3213#endif /* COAP_ASYNC_SUPPORT */
3214
3215 if (coap_is_mcast(&session->addr_info.local)) {
3216 if (COAP_PROTO_RELIABLE(session->proto) || pdu->type != COAP_MESSAGE_NON) {
3217 coap_log_info("Invalid multicast packet received RFC7252 8.1\n");
3218 return;
3219 }
3220 }
3221#if COAP_ASYNC_SUPPORT
3222 async = coap_find_async_lkd(session, pdu->actual_token);
3223 if (async) {
3224 coap_tick_t now;
3225
3226 coap_ticks(&now);
3227 if (async->delay == 0 || async->delay > now) {
3228 /* re-transmit missing ACK (only if CON) */
3229 coap_log_info("Retransmit async response\n");
3230 coap_send_ack_lkd(session, pdu);
3231 /* and do not pass on to the upper layers */
3232 return;
3233 }
3234 }
3235#endif /* COAP_ASYNC_SUPPORT */
3236
3237 coap_option_filter_clear(&opt_filter);
3238 opt = coap_check_option(pdu, COAP_OPTION_PROXY_SCHEME, &opt_iter);
3239 if (opt) {
3240 opt = coap_check_option(pdu, COAP_OPTION_URI_HOST, &opt_iter);
3241 if (!opt) {
3242 coap_log_debug("Proxy-Scheme requires Uri-Host\n");
3243 resp = 402;
3244 goto fail_response;
3245 }
3246 is_proxy_scheme = 1;
3247 }
3248
3249 opt = coap_check_option(pdu, COAP_OPTION_PROXY_URI, &opt_iter);
3250 if (opt)
3251 is_proxy_uri = 1;
3252
3253 if (is_proxy_scheme || is_proxy_uri) {
3254 coap_uri_t uri;
3255
3256 if (!context->proxy_uri_resource) {
3257 /* Need to return a 5.05 RFC7252 Section 5.7.2 */
3258 coap_log_debug("Proxy-%s support not configured\n",
3259 is_proxy_scheme ? "Scheme" : "Uri");
3260 resp = 505;
3261 goto fail_response;
3262 }
3263 if (((size_t)pdu->code - 1 <
3264 (sizeof(resource->handler) / sizeof(resource->handler[0]))) &&
3265 !(context->proxy_uri_resource->handler[pdu->code - 1])) {
3266 /* Need to return a 5.05 RFC7252 Section 5.7.2 */
3267 coap_log_debug("Proxy-%s code %d.%02d handler not supported\n",
3268 is_proxy_scheme ? "Scheme" : "Uri",
3269 pdu->code/100, pdu->code%100);
3270 resp = 505;
3271 goto fail_response;
3272 }
3273
3274 /* Need to check if authority is the proxy endpoint RFC7252 Section 5.7.2 */
3275 if (is_proxy_uri) {
3277 coap_opt_length(opt), &uri) < 0) {
3278 /* Need to return a 5.05 RFC7252 Section 5.7.2 */
3279 coap_log_debug("Proxy-URI not decodable\n");
3280 resp = 505;
3281 goto fail_response;
3282 }
3283 } else {
3284 memset(&uri, 0, sizeof(uri));
3285 opt = coap_check_option(pdu, COAP_OPTION_URI_HOST, &opt_iter);
3286 if (opt) {
3287 uri.host.length = coap_opt_length(opt);
3288 uri.host.s = coap_opt_value(opt);
3289 } else
3290 uri.host.length = 0;
3291 }
3292
3293 resource = context->proxy_uri_resource;
3294 if (uri.host.length && resource->proxy_name_count &&
3295 resource->proxy_name_list) {
3296 size_t i;
3297
3298 if (resource->proxy_name_count == 1 &&
3299 resource->proxy_name_list[0]->length == 0) {
3300 /* If proxy_name_list[0] is zero length, then this is the endpoint */
3301 i = 0;
3302 } else {
3303 for (i = 0; i < resource->proxy_name_count; i++) {
3304 if (coap_string_equal(&uri.host, resource->proxy_name_list[i])) {
3305 break;
3306 }
3307 }
3308 }
3309 if (i != resource->proxy_name_count) {
3310 /* This server is hosting the proxy connection endpoint */
3311 if (pdu->crit_opt) {
3312 /* Cannot handle critical option */
3313 pdu->crit_opt = 0;
3314 resp = 402;
3315 goto fail_response;
3316 }
3317 is_proxy_uri = 0;
3318 is_proxy_scheme = 0;
3319 skip_hop_limit_check = 1;
3320 }
3321 }
3322 resource = NULL;
3323 }
3324
3325 if (!skip_hop_limit_check) {
3326 opt = coap_check_option(pdu, COAP_OPTION_HOP_LIMIT, &opt_iter);
3327 if (opt) {
3328 size_t hop_limit;
3329 uint8_t buf[4];
3330
3331 hop_limit =
3333 if (hop_limit == 1) {
3334 /* coap_send_internal() will fill in the IP address for us */
3335 resp = 508;
3336 goto fail_response;
3337 } else if (hop_limit < 1 || hop_limit > 255) {
3338 /* Need to return a 4.00 RFC8768 Section 3 */
3339 coap_log_info("Invalid Hop Limit\n");
3340 resp = 400;
3341 goto fail_response;
3342 }
3343 hop_limit--;
3345 coap_encode_var_safe8(buf, sizeof(buf), hop_limit),
3346 buf);
3347 }
3348 }
3349
3350 uri_path = coap_get_uri_path(pdu);
3351 if (!uri_path)
3352 return;
3353
3354 if (!is_proxy_uri && !is_proxy_scheme) {
3355 /* try to find the resource from the request URI */
3356 coap_str_const_t uri_path_c = { uri_path->length, uri_path->s };
3357 resource = coap_get_resource_from_uri_path_lkd(context, &uri_path_c);
3358 }
3359
3360 if ((resource == NULL) || (resource->is_unknown == 1) ||
3361 (resource->is_proxy_uri == 1)) {
3362 /* The resource was not found or there is an unexpected match against the
3363 * resource defined for handling unknown or proxy URIs.
3364 */
3365 if (resource != NULL)
3366 /* Close down unexpected match */
3367 resource = NULL;
3368 /*
3369 * Check if the request URI happens to be the well-known URI, or if the
3370 * unknown resource handler is defined, a PUT or optionally other methods,
3371 * if configured, for the unknown handler.
3372 *
3373 * if a PROXY URI/Scheme request and proxy URI handler defined, call the
3374 * proxy URI handler.
3375 *
3376 * else if unknown URI handler defined and COAP_RESOURCE_HANDLE_WELLKNOWN_CORE
3377 * set, call the unknown URI handler with any unknown URI (including
3378 * .well-known/core) if the appropriate method is defined.
3379 *
3380 * else if well-known URI generate a default response.
3381 *
3382 * else if unknown URI handler defined, call the unknown
3383 * URI handler (to allow for potential generation of resource
3384 * [RFC7272 5.8.3]) if the appropriate method is defined.
3385 *
3386 * else if DELETE return 2.02 (RFC7252: 5.8.4. DELETE).
3387 *
3388 * else return 4.04.
3389 */
3390
3391 if (is_proxy_uri || is_proxy_scheme) {
3392 resource = context->proxy_uri_resource;
3393 } else if (context->unknown_resource != NULL &&
3395 ((size_t)pdu->code - 1 <
3396 (sizeof(resource->handler) / sizeof(coap_method_handler_t))) &&
3397 (context->unknown_resource->handler[pdu->code - 1])) {
3398 resource = context->unknown_resource;
3399 } else if (coap_string_equal(uri_path, &coap_default_uri_wellknown)) {
3400 /* request for .well-known/core */
3401 resource = &resource_uri_wellknown;
3402 } else if ((context->unknown_resource != NULL) &&
3403 ((size_t)pdu->code - 1 <
3404 (sizeof(resource->handler) / sizeof(coap_method_handler_t))) &&
3405 (context->unknown_resource->handler[pdu->code - 1])) {
3406 /*
3407 * The unknown_resource can be used to handle undefined resources
3408 * for a PUT request and can support any other registered handler
3409 * defined for it
3410 * Example set up code:-
3411 * r = coap_resource_unknown_init(hnd_put_unknown);
3412 * coap_register_request_handler(r, COAP_REQUEST_POST,
3413 * hnd_post_unknown);
3414 * coap_register_request_handler(r, COAP_REQUEST_GET,
3415 * hnd_get_unknown);
3416 * coap_register_request_handler(r, COAP_REQUEST_DELETE,
3417 * hnd_delete_unknown);
3418 * coap_add_resource(ctx, r);
3419 *
3420 * Note: It is not possible to observe the unknown_resource, a separate
3421 * resource must be created (by PUT or POST) which has a GET
3422 * handler to be observed
3423 */
3424 resource = context->unknown_resource;
3425 } else if (pdu->code == COAP_REQUEST_CODE_DELETE) {
3426 /*
3427 * Request for DELETE on non-existant resource (RFC7252: 5.8.4. DELETE)
3428 */
3429 coap_log_debug("request for unknown resource '%*.*s',"
3430 " return 2.02\n",
3431 (int)uri_path->length,
3432 (int)uri_path->length,
3433 uri_path->s);
3434 resp = 202;
3435 goto fail_response;
3436 } else { /* request for any another resource, return 4.04 */
3437
3438 coap_log_debug("request for unknown resource '%*.*s', return 4.04\n",
3439 (int)uri_path->length, (int)uri_path->length, uri_path->s);
3440 resp = 404;
3441 goto fail_response;
3442 }
3443
3444 }
3445
3446#if COAP_OSCORE_SUPPORT
3447 if ((resource->flags & COAP_RESOURCE_FLAGS_OSCORE_ONLY) && !session->oscore_encryption) {
3448 coap_log_debug("request for OSCORE only resource '%*.*s', return 4.04\n",
3449 (int)uri_path->length, (int)uri_path->length, uri_path->s);
3450 resp = 401;
3451 goto fail_response;
3452 }
3453#endif /* COAP_OSCORE_SUPPORT */
3454 if (resource->is_unknown == 0 && resource->is_proxy_uri == 0) {
3455 /* Check for existing resource and If-Non-Match */
3456 opt = coap_check_option(pdu, COAP_OPTION_IF_NONE_MATCH, &opt_iter);
3457 if (opt) {
3458 resp = 412;
3459 goto fail_response;
3460 }
3461 }
3462
3463 /* the resource was found, check if there is a registered handler */
3464 if ((size_t)pdu->code - 1 <
3465 sizeof(resource->handler) / sizeof(coap_method_handler_t))
3466 h = resource->handler[pdu->code - 1];
3467
3468 if (h == NULL) {
3469 resp = 405;
3470 goto fail_response;
3471 }
3472 if (pdu->code == COAP_REQUEST_CODE_FETCH) {
3473 opt = coap_check_option(pdu, COAP_OPTION_CONTENT_FORMAT, &opt_iter);
3474 if (opt == NULL) {
3475 /* RFC 8132 2.3.1 */
3476 resp = 415;
3477 goto fail_response;
3478 }
3479 }
3480 if (context->mcast_per_resource &&
3481 (resource->flags & COAP_RESOURCE_FLAGS_HAS_MCAST_SUPPORT) == 0 &&
3482 coap_is_mcast(&session->addr_info.local)) {
3483 resp = 405;
3484 goto fail_response;
3485 }
3486
3487 response = coap_pdu_init(pdu->type == COAP_MESSAGE_CON ?
3489 0, pdu->mid, coap_session_max_pdu_size_lkd(session));
3490 if (!response) {
3491 coap_log_err("could not create response PDU\n");
3492 resp = 500;
3493 goto fail_response;
3494 }
3495 response->session = session;
3496#if COAP_ASYNC_SUPPORT
3497 /* If handling a separate response, need CON, not ACK response */
3498 if (async && pdu->type == COAP_MESSAGE_CON)
3499 response->type = COAP_MESSAGE_CON;
3500#endif /* COAP_ASYNC_SUPPORT */
3501 /* A lot of the reliable code assumes type is CON */
3502 if (COAP_PROTO_RELIABLE(session->proto) && response->type != COAP_MESSAGE_CON)
3503 response->type = COAP_MESSAGE_CON;
3504
3505 if (!coap_add_token(response, pdu->actual_token.length,
3506 pdu->actual_token.s)) {
3507 resp = 500;
3508 goto fail_response;
3509 }
3510
3511 query = coap_get_query(pdu);
3512
3513 /* check for Observe option RFC7641 and RFC8132 */
3514 if (resource->observable &&
3515 (pdu->code == COAP_REQUEST_CODE_GET ||
3516 pdu->code == COAP_REQUEST_CODE_FETCH)) {
3517 observe = coap_check_option(pdu, COAP_OPTION_OBSERVE, &opt_iter);
3518 }
3519
3520 /*
3521 * See if blocks need to be aggregated or next requests sent off
3522 * before invoking application request handler
3523 */
3524 if (session->block_mode & COAP_BLOCK_USE_LIBCOAP) {
3525 uint32_t block_mode = session->block_mode;
3526
3527 if (pdu->code == COAP_REQUEST_CODE_FETCH ||
3530 if (coap_handle_request_put_block(context, session, pdu, response,
3531 resource, uri_path, observe,
3532 &added_block, &free_lg_srcv)) {
3533 session->block_mode = block_mode;
3534 goto skip_handler;
3535 }
3536 session->block_mode = block_mode;
3537
3538 if (coap_handle_request_send_block(session, pdu, response, resource,
3539 query)) {
3540#if COAP_Q_BLOCK_SUPPORT
3541 lg_xmit_ctrl = 1;
3542#endif /* COAP_Q_BLOCK_SUPPORT */
3543 goto skip_handler;
3544 }
3545 }
3546
3547 if (observe) {
3548 observe_action =
3550 coap_opt_length(observe));
3551
3552 if (observe_action == COAP_OBSERVE_ESTABLISH) {
3553 coap_subscription_t *subscription;
3554
3555 if (coap_get_block_b(session, pdu, COAP_OPTION_BLOCK2, &block)) {
3556 if (block.num != 0) {
3557 response->code = COAP_RESPONSE_CODE(400);
3558 goto skip_handler;
3559 }
3560#if COAP_Q_BLOCK_SUPPORT
3561 } else if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK2,
3562 &block)) {
3563 if (block.num != 0) {
3564 response->code = COAP_RESPONSE_CODE(400);
3565 goto skip_handler;
3566 }
3567#endif /* COAP_Q_BLOCK_SUPPORT */
3568 }
3569 subscription = coap_add_observer(resource, session, &pdu->actual_token,
3570 pdu);
3571 if (subscription) {
3572 uint8_t buf[4];
3573
3574 coap_touch_observer(context, session, &pdu->actual_token);
3576 coap_encode_var_safe(buf, sizeof(buf),
3577 resource->observe),
3578 buf);
3579 }
3580 } else if (observe_action == COAP_OBSERVE_CANCEL) {
3581 coap_delete_observer_request(resource, session, &pdu->actual_token, pdu);
3582 } else {
3583 coap_log_info("observe: unexpected action %d\n", observe_action);
3584 }
3585 }
3586
3587 /* TODO for non-proxy requests */
3588 if (resource == context->proxy_uri_resource &&
3589 COAP_PROTO_NOT_RELIABLE(session->proto) &&
3590 pdu->type == COAP_MESSAGE_CON) {
3591 /* Make the proxy response separate and fix response later */
3592 send_early_empty_ack = 1;
3593 }
3594 if (send_early_empty_ack) {
3595 coap_send_ack_lkd(session, pdu);
3596 if (pdu->mid == session->last_con_mid) {
3597 /* request has already been processed - do not process it again */
3598 coap_log_debug("Duplicate request with mid=0x%04x - not processed\n",
3599 pdu->mid);
3600 goto drop_it_no_debug;
3601 }
3602 session->last_con_mid = pdu->mid;
3603 }
3604#if COAP_WITH_OBSERVE_PERSIST
3605 /* If we are maintaining Observe persist */
3606 if (resource == context->unknown_resource) {
3607 context->unknown_pdu = pdu;
3608 context->unknown_session = session;
3609 } else
3610 context->unknown_pdu = NULL;
3611#endif /* COAP_WITH_OBSERVE_PERSIST */
3612
3613 /*
3614 * Call the request handler with everything set up
3615 */
3616 if (resource == &resource_uri_wellknown) {
3617 /* Leave context locked */
3618 coap_log_debug("call handler for pseudo resource '%*.*s' (3)\n",
3619 (int)resource->uri_path->length, (int)resource->uri_path->length,
3620 resource->uri_path->s);
3621 h(resource, session, pdu, query, response);
3622 } else {
3623 coap_log_debug("call custom handler for resource '%*.*s' (3)\n",
3624 (int)resource->uri_path->length, (int)resource->uri_path->length,
3625 resource->uri_path->s);
3627 h(resource, session, pdu, query, response),
3628 /* context is being freed off */
3629 goto finish);
3630 }
3631
3632 /* Check validity of response code */
3633 if (!coap_check_code_class(session, response)) {
3634 coap_log_warn("handle_request: Invalid PDU response code (%d.%02d)\n",
3635 COAP_RESPONSE_CLASS(response->code),
3636 response->code & 0x1f);
3637 goto drop_it_no_debug;
3638 }
3639
3640 /* Check if lg_xmit generated and update PDU code if so */
3641 coap_check_code_lg_xmit(session, pdu, response, resource, query);
3642
3643 if (free_lg_srcv) {
3644 /* Check to see if the server is doing a 4.01 + Echo response */
3645 if (response->code == COAP_RESPONSE_CODE(401) &&
3646 coap_check_option(response, COAP_OPTION_ECHO, &opt_iter)) {
3647 /* Need to keep lg_srcv around for client's response */
3648 } else {
3649 LL_DELETE(session->lg_srcv, free_lg_srcv);
3650 coap_block_delete_lg_srcv(session, free_lg_srcv);
3651 }
3652 }
3653 if (added_block && COAP_RESPONSE_CLASS(response->code) == 2) {
3654 /* Just in case, as there are more to go */
3655 response->code = COAP_RESPONSE_CODE(231);
3656 }
3657
3658skip_handler:
3659 if (send_early_empty_ack &&
3660 response->type == COAP_MESSAGE_ACK) {
3661 /* Response is now separate - convert to CON as needed */
3662 response->type = COAP_MESSAGE_CON;
3663 /* Check for empty ACK - need to drop as already sent */
3664 if (response->code == 0) {
3665 goto drop_it_no_debug;
3666 }
3667 }
3668 respond = no_response(pdu, response, session, resource);
3669 if (respond != RESPONSE_DROP) {
3670#if (COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG)
3671 coap_mid_t mid = pdu->mid;
3672#endif
3673 if (COAP_RESPONSE_CLASS(response->code) != 2) {
3674 if (observe) {
3676 }
3677 }
3678 if (COAP_RESPONSE_CLASS(response->code) > 2) {
3679 if (observe)
3680 coap_delete_observer(resource, session, &pdu->actual_token);
3681 if (response->code != COAP_RESPONSE_CODE(413))
3683 }
3684
3685 /* If original request contained a token, and the registered
3686 * application handler made no changes to the response, then
3687 * this is an empty ACK with a token, which is a malformed
3688 * PDU */
3689 if ((response->type == COAP_MESSAGE_ACK)
3690 && (response->code == 0)) {
3691 /* Remove token from otherwise-empty acknowledgment PDU */
3692 response->actual_token.length = 0;
3693 response->e_token_length = 0;
3694 response->used_size = 0;
3695 response->data = NULL;
3696 }
3697
3698 if (!coap_is_mcast(&session->addr_info.local) ||
3699 (context->mcast_per_resource &&
3700 resource &&
3702 /* No delays to response */
3703#if COAP_Q_BLOCK_SUPPORT
3704 if (session->block_mode & COAP_BLOCK_USE_LIBCOAP &&
3705 !lg_xmit_ctrl && response->code == COAP_RESPONSE_CODE(205) &&
3706 coap_get_block_b(session, response, COAP_OPTION_Q_BLOCK2, &block) &&
3707 block.m) {
3708 if (coap_send_q_block2(session, resource, query, pdu->code, block,
3709 response,
3710 COAP_SEND_INC_PDU) == COAP_INVALID_MID)
3711 coap_log_debug("cannot send response for mid=0x%x\n", mid);
3712 response = NULL;
3713 if (query)
3714 coap_delete_string(query);
3715 goto finish;
3716 }
3717#endif /* COAP_Q_BLOCK_SUPPORT */
3718 if (coap_send_internal(session, response) == COAP_INVALID_MID) {
3719 coap_log_debug("cannot send response for mid=0x%04x\n", mid);
3720 }
3721 } else {
3722 /* Need to delay mcast response */
3723 coap_queue_t *node = coap_new_node();
3724 uint8_t r;
3725 coap_tick_t delay;
3726
3727 if (!node) {
3728 coap_log_debug("mcast delay: insufficient memory\n");
3729 goto drop_it_no_debug;
3730 }
3731 if (!coap_pdu_encode_header(response, session->proto)) {
3733 goto drop_it_no_debug;
3734 }
3735
3736 node->id = response->mid;
3737 node->pdu = response;
3738 node->is_mcast = 1;
3739 coap_prng_lkd(&r, sizeof(r));
3740 delay = (COAP_DEFAULT_LEISURE_TICKS(session) * r) / 256;
3741 coap_log_debug(" %s: mid=0x%04x: mcast response delayed for %u.%03u secs\n",
3742 coap_session_str(session),
3743 response->mid,
3744 (unsigned int)(delay / COAP_TICKS_PER_SECOND),
3745 (unsigned int)((delay % COAP_TICKS_PER_SECOND) *
3746 1000 / COAP_TICKS_PER_SECOND));
3747 node->timeout = (unsigned int)delay;
3748 /* Use this to delay transmission */
3749 coap_wait_ack(session->context, session, node);
3750 }
3751 } else {
3752 coap_log_debug(" %s: mid=0x%04x: response dropped\n",
3753 coap_session_str(session),
3754 response->mid);
3755 coap_show_pdu(COAP_LOG_DEBUG, response);
3756drop_it_no_debug:
3757 coap_delete_pdu(response);
3758 }
3759 if (query)
3760 coap_delete_string(query);
3761#if COAP_Q_BLOCK_SUPPORT
3762 if (coap_get_block_b(session, pdu, COAP_OPTION_Q_BLOCK1, &block)) {
3763 if (COAP_PROTO_RELIABLE(session->proto)) {
3764 if (block.m) {
3765 /* All of the sequence not in yet */
3766 goto finish;
3767 }
3768 } else if (pdu->type == COAP_MESSAGE_NON) {
3769 /* More to go and not at a payload break */
3770 if (block.m && ((block.num + 1) % COAP_MAX_PAYLOADS(session))) {
3771 goto finish;
3772 }
3773 }
3774 }
3775#endif /* COAP_Q_BLOCK_SUPPORT */
3776
3777#if COAP_Q_BLOCK_SUPPORT || COAP_THREAD_SAFE
3778finish:
3779#endif /* COAP_Q_BLOCK_SUPPORT || COAP_THREAD_SAFE */
3780 coap_delete_string(uri_path);
3781 return;
3782
3783fail_response:
3784 coap_delete_pdu(response);
3785 response =
3787 &opt_filter);
3788 if (response)
3789 goto skip_handler;
3790 coap_delete_string(uri_path);
3791}
3792#endif /* COAP_SERVER_SUPPORT */
3793
3794#if COAP_CLIENT_SUPPORT
3795static void
3796handle_response(coap_context_t *context, coap_session_t *session,
3797 coap_pdu_t *sent, coap_pdu_t *rcvd) {
3798
3799 /* Set in case there is a later call to coap_update_token() */
3800 rcvd->session = session;
3801
3802 /* In a lossy context, the ACK of a separate response may have
3803 * been lost, so we need to stop retransmitting requests with the
3804 * same token. Matching on token potentially containing ext length bytes.
3805 */
3806 if (rcvd->type != COAP_MESSAGE_ACK)
3807 coap_cancel_all_messages(context, session, &rcvd->actual_token);
3808
3809 /* Check for message duplication */
3810 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
3811 if (rcvd->type == COAP_MESSAGE_CON) {
3812 if (rcvd->mid == session->last_con_mid) {
3813 /* Duplicate response: send ACK/RST, but don't process */
3814 if (session->last_con_handler_res == COAP_RESPONSE_OK)
3815 coap_send_ack_lkd(session, rcvd);
3816 else
3817 coap_send_rst_lkd(session, rcvd);
3818 return;
3819 }
3820 session->last_con_mid = rcvd->mid;
3821 } else if (rcvd->type == COAP_MESSAGE_ACK) {
3822 if (rcvd->mid == session->last_ack_mid) {
3823 /* Duplicate response */
3824 return;
3825 }
3826 session->last_ack_mid = rcvd->mid;
3827 }
3828 }
3829 /* Check to see if checking out extended token support */
3830 if (session->max_token_checked == COAP_EXT_T_CHECKING &&
3831 session->remote_test_mid == rcvd->mid) {
3832
3833 if (rcvd->actual_token.length != session->max_token_size ||
3834 rcvd->code == COAP_RESPONSE_CODE(400) ||
3835 rcvd->code == COAP_RESPONSE_CODE(503)) {
3836 coap_log_debug("Extended Token requested size support not available\n");
3838 } else {
3839 coap_log_debug("Extended Token support available\n");
3840 }
3842 session->doing_first = 0;
3843 return;
3844 }
3845#if COAP_Q_BLOCK_SUPPORT
3846 /* Check to see if checking out Q-Block support */
3847 if (session->block_mode & COAP_BLOCK_PROBE_Q_BLOCK &&
3848 session->remote_test_mid == rcvd->mid) {
3849 if (rcvd->code == COAP_RESPONSE_CODE(402)) {
3850 coap_log_debug("Q-Block support not available\n");
3851 set_block_mode_drop_q(session->block_mode);
3852 } else {
3853 coap_block_b_t qblock;
3854
3855 if (coap_get_block_b(session, rcvd, COAP_OPTION_Q_BLOCK2, &qblock)) {
3856 coap_log_debug("Q-Block support available\n");
3857 set_block_mode_has_q(session->block_mode);
3858 } else {
3859 coap_log_debug("Q-Block support not available\n");
3860 set_block_mode_drop_q(session->block_mode);
3861 }
3862 }
3863 session->doing_first = 0;
3864 return;
3865 }
3866#endif /* COAP_Q_BLOCK_SUPPORT */
3867
3868 if (session->block_mode & COAP_BLOCK_USE_LIBCOAP) {
3869 /* See if need to send next block to server */
3870 if (coap_handle_response_send_block(session, sent, rcvd)) {
3871 /* Next block transmitted, no need to inform app */
3872 coap_send_ack_lkd(session, rcvd);
3873 return;
3874 }
3875
3876 /* Need to see if needing to request next block */
3877 if (coap_handle_response_get_block(context, session, sent, rcvd,
3878 COAP_RECURSE_OK)) {
3879 /* Next block transmitted, ack sent no need to inform app */
3880 return;
3881 }
3882 }
3883 if (session->doing_first)
3884 session->doing_first = 0;
3885
3886 /* Call application-specific response handler when available. */
3887 if (session->doing_send_recv && session->req_token &&
3888 coap_binary_equal(session->req_token, &rcvd->actual_token)) {
3889 /* processing coap_send_recv() call */
3890 session->resp_pdu = rcvd;
3891 rcvd->ref++;
3892 coap_send_ack_lkd(session, rcvd);
3894 } else if (context->response_handler) {
3895 coap_response_t ret;
3896
3897 coap_lock_callback_ret_release(ret, context,
3898 context->response_handler(session, sent, rcvd,
3899 rcvd->mid),
3900 /* context is being freed off */
3901 return);
3902 if (ret == COAP_RESPONSE_FAIL && rcvd->type != COAP_MESSAGE_ACK) {
3903 coap_send_rst_lkd(session, rcvd);
3905 } else {
3906 coap_send_ack_lkd(session, rcvd);
3908 }
3909 } else {
3910 coap_send_ack_lkd(session, rcvd);
3912 }
3913}
3914#endif /* COAP_CLIENT_SUPPORT */
3915
3916#if !COAP_DISABLE_TCP
3917static void
3919 coap_pdu_t *pdu) {
3920 coap_opt_iterator_t opt_iter;
3921 coap_opt_t *option;
3922 int set_mtu = 0;
3923
3924 coap_option_iterator_init(pdu, &opt_iter, COAP_OPT_ALL);
3925
3926 if (pdu->code == COAP_SIGNALING_CODE_CSM) {
3927 if (session->csm_not_seen) {
3928 coap_tick_t now;
3929
3930 coap_ticks(&now);
3931 /* CSM timeout before CSM seen */
3932 coap_log_warn("***%s: CSM received after CSM timeout\n",
3933 coap_session_str(session));
3934 coap_log_warn("***%s: Increase timeout in coap_context_set_csm_timeout_ms() to > %d\n",
3935 coap_session_str(session),
3936 (int)(((now - session->csm_tx) * 1000) / COAP_TICKS_PER_SECOND));
3937 }
3938 if (session->max_token_checked == COAP_EXT_T_NOT_CHECKED) {
3940 }
3941 while ((option = coap_option_next(&opt_iter))) {
3944 coap_opt_length(option)));
3945 set_mtu = 1;
3946 } else if (opt_iter.number == COAP_SIGNALING_OPTION_BLOCK_WISE_TRANSFER) {
3947 session->csm_block_supported = 1;
3948 } else if (opt_iter.number == COAP_SIGNALING_OPTION_EXTENDED_TOKEN_LENGTH) {
3949 session->max_token_size =
3951 coap_opt_length(option));
3954 else if (session->max_token_size > COAP_TOKEN_EXT_MAX)
3957 }
3958 }
3959 if (set_mtu) {
3960 if (session->mtu > COAP_BERT_BASE && session->csm_block_supported)
3961 session->csm_bert_rem_support = 1;
3962 else
3963 session->csm_bert_rem_support = 0;
3964 }
3965 if (session->state == COAP_SESSION_STATE_CSM)
3966 coap_session_connected(session);
3967 } else if (pdu->code == COAP_SIGNALING_CODE_PING) {
3969 if (context->ping_handler) {
3970 coap_lock_callback(context,
3971 context->ping_handler(session, pdu, pdu->mid));
3972 }
3973 if (pong) {
3975 coap_send_internal(session, pong);
3976 }
3977 } else if (pdu->code == COAP_SIGNALING_CODE_PONG) {
3978 session->last_pong = session->last_rx_tx;
3979 if (context->pong_handler) {
3980 coap_lock_callback(context,
3981 context->pong_handler(session, pdu, pdu->mid));
3982 }
3983 } else if (pdu->code == COAP_SIGNALING_CODE_RELEASE
3984 || pdu->code == COAP_SIGNALING_CODE_ABORT) {
3986 }
3987}
3988#endif /* !COAP_DISABLE_TCP */
3989
3990static int
3992 if (COAP_PDU_IS_REQUEST(pdu) &&
3993 pdu->actual_token.length >
3994 (session->type == COAP_SESSION_TYPE_CLIENT ?
3995 session->max_token_size : session->context->max_token_size)) {
3996 /* https://rfc-editor.org/rfc/rfc8974#section-2.2.2 */
3997 if (session->max_token_size > COAP_TOKEN_DEFAULT_MAX) {
3998 coap_opt_filter_t opt_filter;
3999 coap_pdu_t *response;
4000
4001 memset(&opt_filter, 0, sizeof(coap_opt_filter_t));
4002 response = coap_new_error_response(pdu, COAP_RESPONSE_CODE(400),
4003 &opt_filter);
4004 if (!response) {
4005 coap_log_warn("coap_dispatch: cannot create error response\n");
4006 } else {
4007 /*
4008 * Note - have to leave in oversize token as per
4009 * https://rfc-editor.org/rfc/rfc7252#section-5.3.1
4010 */
4011 if (coap_send_internal(session, response) == COAP_INVALID_MID)
4012 coap_log_warn("coap_dispatch: error sending response\n");
4013 }
4014 } else {
4015 /* Indicate no extended token support */
4016 coap_send_rst_lkd(session, pdu);
4017 }
4018 return 0;
4019 }
4020 return 1;
4021}
4022
4023void
4025 coap_pdu_t *pdu) {
4026 coap_queue_t *sent = NULL;
4027 coap_pdu_t *response;
4028 coap_opt_filter_t opt_filter;
4029 int is_ping_rst;
4030 int packet_is_bad = 0;
4031#if COAP_OSCORE_SUPPORT
4032 coap_opt_iterator_t opt_iter;
4033 coap_pdu_t *dec_pdu = NULL;
4034#endif /* COAP_OSCORE_SUPPORT */
4035 int is_ext_token_rst;
4036
4037 pdu->session = session;
4039
4040 /* Check validity of received code */
4041 if (!coap_check_code_class(session, pdu)) {
4042 coap_log_info("coap_dispatch: Received invalid PDU code (%d.%02d)\n",
4044 pdu->code & 0x1f);
4045 packet_is_bad = 1;
4046 if (pdu->type == COAP_MESSAGE_CON) {
4048 }
4049 /* find message id in sendqueue to stop retransmission */
4050 coap_remove_from_queue(&context->sendqueue, session, pdu->mid, &sent);
4051 goto cleanup;
4052 }
4053
4054 coap_option_filter_clear(&opt_filter);
4055
4056#if COAP_OSCORE_SUPPORT
4057 if (!COAP_PDU_IS_SIGNALING(pdu) &&
4058 coap_option_check_critical(session, pdu, &opt_filter) == 0) {
4059 if (pdu->type == COAP_MESSAGE_NON) {
4060 coap_send_rst_lkd(session, pdu);
4061 goto cleanup;
4062 } else if (pdu->type == COAP_MESSAGE_CON) {
4063 if (COAP_PDU_IS_REQUEST(pdu)) {
4064 response =
4065 coap_new_error_response(pdu, COAP_RESPONSE_CODE(402), &opt_filter);
4066
4067 if (!response) {
4068 coap_log_warn("coap_dispatch: cannot create error response\n");
4069 } else {
4070 if (coap_send_internal(session, response) == COAP_INVALID_MID)
4071 coap_log_warn("coap_dispatch: error sending response\n");
4072 }
4073 } else {
4074 coap_send_rst_lkd(session, pdu);
4075 }
4076 }
4077 goto cleanup;
4078 }
4079
4080 if (coap_check_option(pdu, COAP_OPTION_OSCORE, &opt_iter) != NULL) {
4081 int decrypt = 1;
4082#if COAP_SERVER_SUPPORT
4083 coap_opt_t *opt;
4084 coap_resource_t *resource;
4085 coap_uri_t uri;
4086#endif /* COAP_SERVER_SUPPORT */
4087
4088 if (COAP_PDU_IS_RESPONSE(pdu) && !session->oscore_encryption)
4089 decrypt = 0;
4090
4091#if COAP_SERVER_SUPPORT
4092 if (decrypt && COAP_PDU_IS_REQUEST(pdu) &&
4093 coap_check_option(pdu, COAP_OPTION_PROXY_SCHEME, &opt_iter) != NULL &&
4094 (opt = coap_check_option(pdu, COAP_OPTION_URI_HOST, &opt_iter))
4095 != NULL) {
4096 /* Need to check whether this is a direct or proxy session */
4097 memset(&uri, 0, sizeof(uri));
4098 uri.host.length = coap_opt_length(opt);
4099 uri.host.s = coap_opt_value(opt);
4100 resource = context->proxy_uri_resource;
4101 if (uri.host.length && resource && resource->proxy_name_count &&
4102 resource->proxy_name_list) {
4103 size_t i;
4104 for (i = 0; i < resource->proxy_name_count; i++) {
4105 if (coap_string_equal(&uri.host, resource->proxy_name_list[i])) {
4106 break;
4107 }
4108 }
4109 if (i == resource->proxy_name_count) {
4110 /* This server is not hosting the proxy connection endpoint */
4111 decrypt = 0;
4112 }
4113 }
4114 }
4115#endif /* COAP_SERVER_SUPPORT */
4116 if (decrypt) {
4117 /* find message id in sendqueue to stop retransmission and get sent */
4118 coap_remove_from_queue(&context->sendqueue, session, pdu->mid, &sent);
4119 if ((dec_pdu = coap_oscore_decrypt_pdu(session, pdu)) == NULL) {
4120 if (session->recipient_ctx == NULL ||
4121 session->recipient_ctx->initial_state == 0) {
4122 coap_log_warn("OSCORE: PDU could not be decrypted\n");
4123 }
4125 return;
4126 } else {
4127 session->oscore_encryption = 1;
4128 pdu = dec_pdu;
4129 }
4130 coap_log_debug("Decrypted PDU\n");
4132 }
4133 }
4134#endif /* COAP_OSCORE_SUPPORT */
4135
4136 switch (pdu->type) {
4137 case COAP_MESSAGE_ACK:
4138 /* find message id in sendqueue to stop retransmission */
4139 coap_remove_from_queue(&context->sendqueue, session, pdu->mid, &sent);
4140
4141 if (sent && session->con_active) {
4142 session->con_active--;
4143 if (session->state == COAP_SESSION_STATE_ESTABLISHED)
4144 /* Flush out any entries on session->delayqueue */
4145 coap_session_connected(session);
4146 }
4147 if (coap_option_check_critical(session, pdu, &opt_filter) == 0) {
4148 packet_is_bad = 1;
4149 goto cleanup;
4150 }
4151
4152#if COAP_SERVER_SUPPORT
4153 /* if sent code was >= 64 the message might have been a
4154 * notification. Then, we must flag the observer to be alive
4155 * by setting obs->fail_cnt = 0. */
4156 if (sent && COAP_RESPONSE_CLASS(sent->pdu->code) == 2) {
4157 coap_touch_observer(context, sent->session, &sent->pdu->actual_token);
4158 }
4159#endif /* COAP_SERVER_SUPPORT */
4160
4161 if (pdu->code == 0) {
4162#if COAP_Q_BLOCK_SUPPORT
4163 if (sent) {
4164 coap_block_b_t block;
4165
4166 if (sent->pdu->type == COAP_MESSAGE_CON &&
4167 COAP_PROTO_NOT_RELIABLE(session->proto) &&
4168 coap_get_block_b(session, sent->pdu,
4169 COAP_PDU_IS_REQUEST(sent->pdu) ?
4171 &block)) {
4172 if (block.m) {
4173#if COAP_CLIENT_SUPPORT
4174 if (COAP_PDU_IS_REQUEST(sent->pdu))
4175 coap_send_q_block1(session, block, sent->pdu,
4176 COAP_SEND_SKIP_PDU);
4177#endif /* COAP_CLIENT_SUPPORT */
4178 if (COAP_PDU_IS_RESPONSE(sent->pdu))
4179 coap_send_q_blocks(session, sent->pdu->lg_xmit, block,
4180 sent->pdu, COAP_SEND_SKIP_PDU);
4181 }
4182 }
4183 }
4184#endif /* COAP_Q_BLOCK_SUPPORT */
4185#if COAP_CLIENT_SUPPORT
4186 /*
4187 * In coap_send(), lg_crcv was not set up if type is CON and protocol is not
4188 * reliable to save overhead as this can be set up on detection of a (Q)-Block2
4189 * response if the response was piggy-backed. Here, a separate response
4190 * detected and so the lg_crcv needs to be set up before the sent PDU
4191 * information is lost.
4192 *
4193 * lg_crcv was not set up if not a CoAP request or if DELETE.
4194 *
4195 * lg_crcv was always set up in coap_send() if Observe, Oscore and (Q)-Block1
4196 * options.
4197 */
4198 if (sent &&
4199 !coap_check_send_need_lg_crcv(session, pdu) &&
4200 COAP_PDU_IS_REQUEST(sent->pdu)) {
4201 /*
4202 * lg_crcv was not set up in coap_send(). It could have been set up
4203 * the first separate response.
4204 * See if there already is a lg_crcv set up.
4205 */
4206 coap_lg_crcv_t *lg_crcv;
4207 uint64_t token_match =
4209 sent->pdu->actual_token.length));
4210
4211 LL_FOREACH(session->lg_crcv, lg_crcv) {
4212 if (token_match == STATE_TOKEN_BASE(lg_crcv->state_token) ||
4213 coap_binary_equal(&sent->pdu->actual_token, lg_crcv->app_token)) {
4214 break;
4215 }
4216 }
4217 if (!lg_crcv) {
4218 /*
4219 * Need to set up a lg_crcv as it was not set up in coap_send()
4220 * to save time, but server has not sent back a piggy-back response.
4221 */
4222 lg_crcv = coap_block_new_lg_crcv(session, sent->pdu, NULL);
4223 if (lg_crcv) {
4224 LL_PREPEND(session->lg_crcv, lg_crcv);
4225 }
4226 }
4227 }
4228#endif /* COAP_CLIENT_SUPPORT */
4229 /* an empty ACK needs no further handling */
4230 goto cleanup;
4231 } else if (COAP_PDU_IS_REQUEST(pdu)) {
4232 /* This is not legitimate - Request using ACK - ignore */
4233 coap_log_debug("dropped ACK with request code (%d.%02d)\n",
4235 pdu->code & 0x1f);
4236 packet_is_bad = 1;
4237 goto cleanup;
4238 }
4239
4240 break;
4241
4242 case COAP_MESSAGE_RST:
4243 /* We have sent something the receiver disliked, so we remove
4244 * not only the message id but also the subscriptions we might
4245 * have. */
4246 is_ping_rst = 0;
4247 if (pdu->mid == session->last_ping_mid &&
4248 context->ping_timeout && session->last_ping > 0)
4249 is_ping_rst = 1;
4250
4251#if COAP_Q_BLOCK_SUPPORT
4252 /* Check to see if checking out Q-Block support */
4253 if (session->block_mode & COAP_BLOCK_PROBE_Q_BLOCK &&
4254 session->remote_test_mid == pdu->mid) {
4255 coap_log_debug("Q-Block support not available\n");
4256 set_block_mode_drop_q(session->block_mode);
4257 }
4258#endif /* COAP_Q_BLOCK_SUPPORT */
4259
4260 /* Check to see if checking out extended token support */
4261 is_ext_token_rst = 0;
4262 if (session->max_token_checked == COAP_EXT_T_CHECKING &&
4263 session->remote_test_mid == pdu->mid) {
4264 coap_log_debug("Extended Token support not available\n");
4267 session->doing_first = 0;
4268 is_ext_token_rst = 1;
4269 }
4270
4271 if (!is_ping_rst && !is_ext_token_rst)
4272 coap_log_alert("got RST for mid=0x%04x\n", pdu->mid);
4273
4274 if (session->con_active) {
4275 session->con_active--;
4276 if (session->state == COAP_SESSION_STATE_ESTABLISHED)
4277 /* Flush out any entries on session->delayqueue */
4278 coap_session_connected(session);
4279 }
4280
4281 /* find message id in sendqueue to stop retransmission */
4282 coap_remove_from_queue(&context->sendqueue, session, pdu->mid, &sent);
4283
4284 if (sent) {
4285 coap_cancel(context, sent);
4286
4287 if (!is_ping_rst && !is_ext_token_rst) {
4288 if (sent->pdu->type==COAP_MESSAGE_CON) {
4289 coap_handle_nack(sent->session, sent->pdu, COAP_NACK_RST, sent->id);
4290 }
4291 } else if (is_ping_rst) {
4292 if (context->pong_handler) {
4293 coap_lock_callback(context,
4294 context->pong_handler(session, pdu, pdu->mid));
4295 }
4296 session->last_pong = session->last_rx_tx;
4298 }
4299 } else {
4300#if COAP_SERVER_SUPPORT
4301 /* Need to check is there is a subscription active and delete it */
4302 RESOURCES_ITER(context->resources, r) {
4303 coap_subscription_t *obs, *tmp;
4304 LL_FOREACH_SAFE(r->subscribers, obs, tmp) {
4305 if (obs->pdu->mid == pdu->mid && obs->session == session) {
4306 /* Need to do this now as session may get de-referenced */
4308 coap_delete_observer(r, session, &obs->pdu->actual_token);
4309 coap_handle_nack(session, NULL, COAP_NACK_RST, pdu->mid);
4310 coap_session_release_lkd(session);
4311 goto cleanup;
4312 }
4313 }
4314 }
4315#endif /* COAP_SERVER_SUPPORT */
4316 coap_handle_nack(session, NULL, COAP_NACK_RST, pdu->mid);
4317 }
4318 goto cleanup;
4319
4320 case COAP_MESSAGE_NON:
4321 /* find transaction in sendqueue in case large response */
4322 coap_remove_from_queue(&context->sendqueue, session, pdu->mid, &sent);
4323 /* check for unknown critical options */
4324 if (coap_option_check_critical(session, pdu, &opt_filter) == 0) {
4325 packet_is_bad = 1;
4326 coap_send_rst_lkd(session, pdu);
4327 goto cleanup;
4328 }
4329 if (!check_token_size(session, pdu)) {
4330 goto cleanup;
4331 }
4332 break;
4333
4334 case COAP_MESSAGE_CON: /* check for unknown critical options */
4335 if (!COAP_PDU_IS_SIGNALING(pdu) &&
4336 coap_option_check_critical(session, pdu, &opt_filter) == 0) {
4337 packet_is_bad = 1;
4338 if (COAP_PDU_IS_REQUEST(pdu)) {
4339 response =
4340 coap_new_error_response(pdu, COAP_RESPONSE_CODE(402), &opt_filter);
4341
4342 if (!response) {
4343 coap_log_warn("coap_dispatch: cannot create error response\n");
4344 } else {
4345 if (coap_send_internal(session, response) == COAP_INVALID_MID)
4346 coap_log_warn("coap_dispatch: error sending response\n");
4347 }
4348 } else {
4349 coap_send_rst_lkd(session, pdu);
4350 }
4351 goto cleanup;
4352 }
4353 if (!check_token_size(session, pdu)) {
4354 goto cleanup;
4355 }
4356 break;
4357 default:
4358 break;
4359 }
4360
4361 /* Pass message to upper layer if a specific handler was
4362 * registered for a request that should be handled locally. */
4363#if !COAP_DISABLE_TCP
4364 if (COAP_PDU_IS_SIGNALING(pdu))
4365 handle_signaling(context, session, pdu);
4366 else
4367#endif /* !COAP_DISABLE_TCP */
4368#if COAP_SERVER_SUPPORT
4369 if (COAP_PDU_IS_REQUEST(pdu))
4370 handle_request(context, session, pdu);
4371 else
4372#endif /* COAP_SERVER_SUPPORT */
4373#if COAP_CLIENT_SUPPORT
4374 if (COAP_PDU_IS_RESPONSE(pdu))
4375 handle_response(context, session, sent ? sent->pdu : NULL, pdu);
4376 else
4377#endif /* COAP_CLIENT_SUPPORT */
4378 {
4379 if (COAP_PDU_IS_EMPTY(pdu)) {
4380 if (context->ping_handler) {
4381 coap_lock_callback(context,
4382 context->ping_handler(session, pdu, pdu->mid));
4383 }
4384 } else {
4385 packet_is_bad = 1;
4386 }
4387 coap_log_debug("dropped message with invalid code (%d.%02d)\n",
4389 pdu->code & 0x1f);
4390
4391 if (!coap_is_mcast(&session->addr_info.local)) {
4392 if (COAP_PDU_IS_EMPTY(pdu)) {
4393 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
4394 coap_tick_t now;
4395 coap_ticks(&now);
4396 if (session->last_tx_rst + COAP_TICKS_PER_SECOND/4 < now) {
4398 session->last_tx_rst = now;
4399 }
4400 }
4401 } else {
4402 if (pdu->type == COAP_MESSAGE_CON)
4404 }
4405 }
4406 }
4407
4408cleanup:
4409 if (packet_is_bad) {
4410 if (sent) {
4411 coap_handle_nack(session, sent->pdu, COAP_NACK_BAD_RESPONSE, sent->id);
4412 } else {
4414 }
4415 }
4417#if COAP_OSCORE_SUPPORT
4418 coap_delete_pdu(dec_pdu);
4419#endif /* COAP_OSCORE_SUPPORT */
4420}
4421
4422#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
4423static const char *
4425 switch (event) {
4427 return "COAP_EVENT_DTLS_CLOSED";
4429 return "COAP_EVENT_DTLS_CONNECTED";
4431 return "COAP_EVENT_DTLS_RENEGOTIATE";
4433 return "COAP_EVENT_DTLS_ERROR";
4435 return "COAP_EVENT_TCP_CONNECTED";
4437 return "COAP_EVENT_TCP_CLOSED";
4439 return "COAP_EVENT_TCP_FAILED";
4441 return "COAP_EVENT_SESSION_CONNECTED";
4443 return "COAP_EVENT_SESSION_CLOSED";
4445 return "COAP_EVENT_SESSION_FAILED";
4447 return "COAP_EVENT_PARTIAL_BLOCK";
4449 return "COAP_EVENT_XMIT_BLOCK_FAIL";
4451 return "COAP_EVENT_SERVER_SESSION_NEW";
4453 return "COAP_EVENT_SERVER_SESSION_DEL";
4455 return "COAP_EVENT_BAD_PACKET";
4457 return "COAP_EVENT_MSG_RETRANSMITTED";
4459 return "COAP_EVENT_OSCORE_DECRYPTION_FAILURE";
4461 return "COAP_EVENT_OSCORE_NOT_ENABLED";
4463 return "COAP_EVENT_OSCORE_NO_PROTECTED_PAYLOAD";
4465 return "COAP_EVENT_OSCORE_NO_SECURITY";
4467 return "COAP_EVENT_OSCORE_INTERNAL_ERROR";
4469 return "COAP_EVENT_OSCORE_DECODE_ERROR";
4471 return "COAP_EVENT_WS_PACKET_SIZE";
4473 return "COAP_EVENT_WS_CONNECTED";
4475 return "COAP_EVENT_WS_CLOSED";
4477 return "COAP_EVENT_KEEPALIVE_FAILURE";
4478 default:
4479 return "???";
4480 }
4481}
4482#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
4483
4484COAP_API int
4486 coap_session_t *session) {
4487 int ret;
4488
4489 coap_lock_lock(context, return 0);
4490 ret = coap_handle_event_lkd(context, event, session);
4491 coap_lock_unlock(context);
4492 return ret;
4493}
4494
4495int
4497 coap_session_t *session) {
4498 int ret = 0;
4499
4500 coap_log_debug("***EVENT: %s\n", coap_event_name(event));
4501
4502 if (context->handle_event) {
4503 coap_lock_callback_ret(ret, context, context->handle_event(session, event));
4504#if COAP_PROXY_SUPPORT
4505 if (event == COAP_EVENT_SERVER_SESSION_DEL)
4507#endif /* COAP_PROXY_SUPPORT */
4508#if COAP_CLIENT_SUPPORT
4509 switch (event) {
4522 /* Those that are deemed fatal to end sending a request */
4523 session->doing_send_recv = 0;
4524 break;
4539 default:
4540 break;
4541 }
4542#endif /* COAP_CLIENT_SUPPORT */
4543 }
4544 return ret;
4545}
4546
4547COAP_API int
4549 int ret;
4550
4551 coap_lock_lock(context, return 0);
4552 ret = coap_can_exit_lkd(context);
4553 coap_lock_unlock(context);
4554 return ret;
4555}
4556
4557int
4559 coap_session_t *s, *rtmp;
4560 if (!context)
4561 return 1;
4562 coap_lock_check_locked(context);
4563 if (context->sendqueue)
4564 return 0;
4565#if COAP_SERVER_SUPPORT
4566 coap_endpoint_t *ep;
4567
4568 LL_FOREACH(context->endpoint, ep) {
4569 SESSIONS_ITER(ep->sessions, s, rtmp) {
4570 if (s->delayqueue)
4571 return 0;
4572 if (s->lg_xmit)
4573 return 0;
4574 }
4575 }
4576#endif /* COAP_SERVER_SUPPORT */
4577#if COAP_CLIENT_SUPPORT
4578 SESSIONS_ITER(context->sessions, s, rtmp) {
4579 if (s->delayqueue)
4580 return 0;
4581 if (s->lg_xmit)
4582 return 0;
4583 }
4584#endif /* COAP_CLIENT_SUPPORT */
4585 return 1;
4586}
4587#if COAP_SERVER_SUPPORT
4588#if COAP_ASYNC_SUPPORT
4590coap_check_async(coap_context_t *context, coap_tick_t now) {
4591 coap_tick_t next_due = 0;
4592 coap_async_t *async, *tmp;
4593
4594 LL_FOREACH_SAFE(context->async_state, async, tmp) {
4595 if (async->delay != 0 && async->delay <= now) {
4596 /* Send off the request to the application */
4597 handle_request(context, async->session, async->pdu);
4598
4599 /* Remove this async entry as it has now fired */
4600 coap_free_async_lkd(async->session, async);
4601 } else {
4602 if (next_due == 0 || next_due > async->delay - now)
4603 next_due = async->delay - now;
4604 }
4605 }
4606 return next_due;
4607}
4608#endif /* COAP_ASYNC_SUPPORT */
4609#endif /* COAP_SERVER_SUPPORT */
4610
4612
4613#if COAP_THREAD_SAFE
4614/*
4615 * Global lock for multi-thread support
4616 */
4617coap_lock_t global_lock;
4618#endif /* COAP_THREAD_SAFE */
4619
4620void
4622 coap_tick_t now;
4623#ifndef WITH_CONTIKI
4624 uint64_t us;
4625#endif /* !WITH_CONTIKI */
4626
4627 if (coap_started)
4628 return;
4629 coap_started = 1;
4630
4631#if COAP_THREAD_SAFE
4633#endif /* COAP_THREAD_SAFE */
4634
4635#if defined(HAVE_WINSOCK2_H)
4636 WORD wVersionRequested = MAKEWORD(2, 2);
4637 WSADATA wsaData;
4638 WSAStartup(wVersionRequested, &wsaData);
4639#endif
4641 coap_ticks(&now);
4642#ifndef WITH_CONTIKI
4643 us = coap_ticks_to_rt_us(now);
4644 /* Be accurate to the nearest (approx) us */
4645 coap_prng_init_lkd((unsigned int)us);
4646#else /* WITH_CONTIKI */
4647 coap_start_io_process();
4648#endif /* WITH_CONTIKI */
4651#ifdef WITH_LWIP
4652 coap_io_lwip_init();
4653#endif /* WITH_LWIP */
4654#if COAP_SERVER_SUPPORT
4655 static coap_str_const_t well_known = { sizeof(".well-known/core")-1,
4656 (const uint8_t *)".well-known/core"
4657 };
4658 memset(&resource_uri_wellknown, 0, sizeof(resource_uri_wellknown));
4659 resource_uri_wellknown.handler[COAP_REQUEST_GET-1] = hnd_get_wellknown_lkd;
4660 resource_uri_wellknown.flags = COAP_RESOURCE_FLAGS_HAS_MCAST_SUPPORT;
4661 resource_uri_wellknown.uri_path = &well_known;
4662#endif /* COAP_SERVER_SUPPORT */
4664}
4665
4666void
4668 if (!coap_started)
4669 return;
4670 coap_started = 0;
4671#if defined(HAVE_WINSOCK2_H)
4672 WSACleanup();
4673#elif defined(WITH_CONTIKI)
4674 coap_stop_io_process();
4675#endif
4676#ifdef WITH_LWIP
4677 coap_io_lwip_cleanup();
4678#endif /* WITH_LWIP */
4680
4682}
4683
4684void
4686 coap_response_handler_t handler) {
4687#if COAP_CLIENT_SUPPORT
4688 context->response_handler = handler;
4689#else /* ! COAP_CLIENT_SUPPORT */
4690 (void)context;
4691 (void)handler;
4692#endif /* COAP_CLIENT_SUPPORT */
4693}
4694
4695void
4697 coap_nack_handler_t handler) {
4698 context->nack_handler = handler;
4699}
4700
4701void
4703 coap_ping_handler_t handler) {
4704 context->ping_handler = handler;
4705}
4706
4707void
4709 coap_pong_handler_t handler) {
4710 context->pong_handler = handler;
4711}
4712
4713COAP_API void
4715 coap_lock_lock(ctx, return);
4716 coap_register_option_lkd(ctx, type);
4717 coap_lock_unlock(ctx);
4718}
4719
4720void
4723}
4724
4725#if ! defined WITH_CONTIKI && ! defined WITH_LWIP && ! defined RIOT_VERSION
4726#if COAP_SERVER_SUPPORT
4727COAP_API int
4728coap_join_mcast_group_intf(coap_context_t *ctx, const char *group_name,
4729 const char *ifname) {
4730 int ret;
4731
4732 coap_lock_lock(ctx, return -1);
4733 ret = coap_join_mcast_group_intf_lkd(ctx, group_name, ifname);
4734 coap_lock_unlock(ctx);
4735 return ret;
4736}
4737
4738int
4739coap_join_mcast_group_intf_lkd(coap_context_t *ctx, const char *group_name,
4740 const char *ifname) {
4741#if COAP_IPV4_SUPPORT
4742 struct ip_mreq mreq4;
4743#endif /* COAP_IPV4_SUPPORT */
4744#if COAP_IPV6_SUPPORT
4745 struct ipv6_mreq mreq6;
4746#endif /* COAP_IPV6_SUPPORT */
4747 struct addrinfo *resmulti = NULL, hints, *ainfo;
4748 int result = -1;
4749 coap_endpoint_t *endpoint;
4750 int mgroup_setup = 0;
4751
4752 /* Need to have at least one endpoint! */
4753 assert(ctx->endpoint);
4754 if (!ctx->endpoint)
4755 return -1;
4756
4757 /* Default is let the kernel choose */
4758#if COAP_IPV6_SUPPORT
4759 mreq6.ipv6mr_interface = 0;
4760#endif /* COAP_IPV6_SUPPORT */
4761#if COAP_IPV4_SUPPORT
4762 mreq4.imr_interface.s_addr = INADDR_ANY;
4763#endif /* COAP_IPV4_SUPPORT */
4764
4765 memset(&hints, 0, sizeof(hints));
4766 hints.ai_socktype = SOCK_DGRAM;
4767
4768 /* resolve the multicast group address */
4769 result = getaddrinfo(group_name, NULL, &hints, &resmulti);
4770
4771 if (result != 0) {
4772 coap_log_err("coap_join_mcast_group_intf: %s: "
4773 "Cannot resolve multicast address: %s\n",
4774 group_name, gai_strerror(result));
4775 goto finish;
4776 }
4777
4778 /* Need to do a windows equivalent at some point */
4779#ifndef _WIN32
4780 if (ifname) {
4781 /* interface specified - check if we have correct IPv4/IPv6 information */
4782 int done_ip4 = 0;
4783 int done_ip6 = 0;
4784#if defined(ESPIDF_VERSION)
4785 struct netif *netif;
4786#else /* !ESPIDF_VERSION */
4787#if COAP_IPV4_SUPPORT
4788 int ip4fd;
4789#endif /* COAP_IPV4_SUPPORT */
4790 struct ifreq ifr;
4791#endif /* !ESPIDF_VERSION */
4792
4793 /* See which mcast address family types are being asked for */
4794 for (ainfo = resmulti; ainfo != NULL && !(done_ip4 == 1 && done_ip6 == 1);
4795 ainfo = ainfo->ai_next) {
4796 switch (ainfo->ai_family) {
4797#if COAP_IPV6_SUPPORT
4798 case AF_INET6:
4799 if (done_ip6)
4800 break;
4801 done_ip6 = 1;
4802#if defined(ESPIDF_VERSION)
4803 netif = netif_find(ifname);
4804 if (netif)
4805 mreq6.ipv6mr_interface = netif_get_index(netif);
4806 else
4807 coap_log_err("coap_join_mcast_group_intf: %s: "
4808 "Cannot get IPv4 address: %s\n",
4809 ifname, coap_socket_strerror());
4810#else /* !ESPIDF_VERSION */
4811 memset(&ifr, 0, sizeof(ifr));
4812 strncpy(ifr.ifr_name, ifname, IFNAMSIZ - 1);
4813 ifr.ifr_name[IFNAMSIZ - 1] = '\000';
4814
4815#ifdef HAVE_IF_NAMETOINDEX
4816 mreq6.ipv6mr_interface = if_nametoindex(ifr.ifr_name);
4817 if (mreq6.ipv6mr_interface == 0) {
4818 coap_log_warn("coap_join_mcast_group_intf: "
4819 "cannot get interface index for '%s'\n",
4820 ifname);
4821 }
4822#elif defined(__QNXNTO__)
4823#else /* !HAVE_IF_NAMETOINDEX */
4824 result = ioctl(ctx->endpoint->sock.fd, SIOCGIFINDEX, &ifr);
4825 if (result != 0) {
4826 coap_log_warn("coap_join_mcast_group_intf: "
4827 "cannot get interface index for '%s': %s\n",
4828 ifname, coap_socket_strerror());
4829 } else {
4830 /* Capture the IPv6 if_index for later */
4831 mreq6.ipv6mr_interface = ifr.ifr_ifindex;
4832 }
4833#endif /* !HAVE_IF_NAMETOINDEX */
4834#endif /* !ESPIDF_VERSION */
4835#endif /* COAP_IPV6_SUPPORT */
4836 break;
4837#if COAP_IPV4_SUPPORT
4838 case AF_INET:
4839 if (done_ip4)
4840 break;
4841 done_ip4 = 1;
4842#if defined(ESPIDF_VERSION)
4843 netif = netif_find(ifname);
4844 if (netif)
4845 mreq4.imr_interface.s_addr = netif_ip4_addr(netif)->addr;
4846 else
4847 coap_log_err("coap_join_mcast_group_intf: %s: "
4848 "Cannot get IPv4 address: %s\n",
4849 ifname, coap_socket_strerror());
4850#else /* !ESPIDF_VERSION */
4851 /*
4852 * Need an AF_INET socket to do this unfortunately to stop
4853 * "Invalid argument" error if AF_INET6 socket is used for SIOCGIFADDR
4854 */
4855 ip4fd = socket(AF_INET, SOCK_DGRAM, 0);
4856 if (ip4fd == -1) {
4857 coap_log_err("coap_join_mcast_group_intf: %s: socket: %s\n",
4858 ifname, coap_socket_strerror());
4859 continue;
4860 }
4861 memset(&ifr, 0, sizeof(ifr));
4862 strncpy(ifr.ifr_name, ifname, IFNAMSIZ - 1);
4863 ifr.ifr_name[IFNAMSIZ - 1] = '\000';
4864 result = ioctl(ip4fd, SIOCGIFADDR, &ifr);
4865 if (result != 0) {
4866 coap_log_err("coap_join_mcast_group_intf: %s: "
4867 "Cannot get IPv4 address: %s\n",
4868 ifname, coap_socket_strerror());
4869 } else {
4870 /* Capture the IPv4 address for later */
4871 mreq4.imr_interface = ((struct sockaddr_in *)&ifr.ifr_addr)->sin_addr;
4872 }
4873 close(ip4fd);
4874#endif /* !ESPIDF_VERSION */
4875 break;
4876#endif /* COAP_IPV4_SUPPORT */
4877 default:
4878 break;
4879 }
4880 }
4881 }
4882#else /* _WIN32 */
4883 /*
4884 * On Windows this function ignores the ifname variable so we unset this
4885 * variable on this platform in any case in order to enable the interface
4886 * selection from the bind address below.
4887 */
4888 ifname = 0;
4889#endif /* _WIN32 */
4890
4891 /* Add in mcast address(es) to appropriate interface */
4892 for (ainfo = resmulti; ainfo != NULL; ainfo = ainfo->ai_next) {
4893 LL_FOREACH(ctx->endpoint, endpoint) {
4894 /* Only UDP currently supported */
4895 if (endpoint->proto == COAP_PROTO_UDP) {
4896 coap_address_t gaddr;
4897
4898 coap_address_init(&gaddr);
4899#if COAP_IPV6_SUPPORT
4900 if (ainfo->ai_family == AF_INET6) {
4901 if (!ifname) {
4902 if (endpoint->bind_addr.addr.sa.sa_family == AF_INET6) {
4903 /*
4904 * Do it on the ifindex that the server is listening on
4905 * (sin6_scope_id could still be 0)
4906 */
4907 mreq6.ipv6mr_interface =
4908 endpoint->bind_addr.addr.sin6.sin6_scope_id;
4909 } else {
4910 mreq6.ipv6mr_interface = 0;
4911 }
4912 }
4913 gaddr.addr.sin6.sin6_family = AF_INET6;
4914 gaddr.addr.sin6.sin6_port = endpoint->bind_addr.addr.sin6.sin6_port;
4915 gaddr.addr.sin6.sin6_addr = mreq6.ipv6mr_multiaddr =
4916 ((struct sockaddr_in6 *)ainfo->ai_addr)->sin6_addr;
4917 result = setsockopt(endpoint->sock.fd, IPPROTO_IPV6, IPV6_JOIN_GROUP,
4918 (char *)&mreq6, sizeof(mreq6));
4919 }
4920#endif /* COAP_IPV6_SUPPORT */
4921#if COAP_IPV4_SUPPORT && COAP_IPV6_SUPPORT
4922 else
4923#endif /* COAP_IPV4_SUPPORT && COAP_IPV6_SUPPORT */
4924#if COAP_IPV4_SUPPORT
4925 if (ainfo->ai_family == AF_INET) {
4926 if (!ifname) {
4927 if (endpoint->bind_addr.addr.sa.sa_family == AF_INET) {
4928 /*
4929 * Do it on the interface that the server is listening on
4930 * (sin_addr could still be INADDR_ANY)
4931 */
4932 mreq4.imr_interface = endpoint->bind_addr.addr.sin.sin_addr;
4933 } else {
4934 mreq4.imr_interface.s_addr = INADDR_ANY;
4935 }
4936 }
4937 gaddr.addr.sin.sin_family = AF_INET;
4938 gaddr.addr.sin.sin_port = endpoint->bind_addr.addr.sin.sin_port;
4939 gaddr.addr.sin.sin_addr.s_addr = mreq4.imr_multiaddr.s_addr =
4940 ((struct sockaddr_in *)ainfo->ai_addr)->sin_addr.s_addr;
4941 result = setsockopt(endpoint->sock.fd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
4942 (char *)&mreq4, sizeof(mreq4));
4943 }
4944#endif /* COAP_IPV4_SUPPORT */
4945 else {
4946 continue;
4947 }
4948
4949 if (result == COAP_SOCKET_ERROR) {
4950 coap_log_err("coap_join_mcast_group_intf: %s: setsockopt: %s\n",
4951 group_name, coap_socket_strerror());
4952 } else {
4953 char addr_str[INET6_ADDRSTRLEN + 8 + 1];
4954
4955 addr_str[sizeof(addr_str)-1] = '\000';
4956 if (coap_print_addr(&gaddr, (uint8_t *)addr_str,
4957 sizeof(addr_str) - 1)) {
4958 if (ifname)
4959 coap_log_debug("added mcast group %s i/f %s\n", addr_str,
4960 ifname);
4961 else
4962 coap_log_debug("added mcast group %s\n", addr_str);
4963 }
4964 mgroup_setup = 1;
4965 }
4966 }
4967 }
4968 }
4969 if (!mgroup_setup) {
4970 result = -1;
4971 }
4972
4973finish:
4974 freeaddrinfo(resmulti);
4975
4976 return result;
4977}
4978
4979void
4981 context->mcast_per_resource = 1;
4982}
4983
4984#endif /* ! COAP_SERVER_SUPPORT */
4985
4986#if COAP_CLIENT_SUPPORT
4987int
4988coap_mcast_set_hops(coap_session_t *session, size_t hops) {
4989 if (session && coap_is_mcast(&session->addr_info.remote)) {
4990 switch (session->addr_info.remote.addr.sa.sa_family) {
4991#if COAP_IPV4_SUPPORT
4992 case AF_INET:
4993 if (setsockopt(session->sock.fd, IPPROTO_IP, IP_MULTICAST_TTL,
4994 (const char *)&hops, sizeof(hops)) < 0) {
4995 coap_log_info("coap_mcast_set_hops: %zu: setsockopt: %s\n",
4996 hops, coap_socket_strerror());
4997 return 0;
4998 }
4999 return 1;
5000#endif /* COAP_IPV4_SUPPORT */
5001#if COAP_IPV6_SUPPORT
5002 case AF_INET6:
5003 if (setsockopt(session->sock.fd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS,
5004 (const char *)&hops, sizeof(hops)) < 0) {
5005 coap_log_info("coap_mcast_set_hops: %zu: setsockopt: %s\n",
5006 hops, coap_socket_strerror());
5007 return 0;
5008 }
5009 return 1;
5010#endif /* COAP_IPV6_SUPPORT */
5011 default:
5012 break;
5013 }
5014 }
5015 return 0;
5016}
5017#endif /* COAP_CLIENT_SUPPORT */
5018
5019#else /* defined WITH_CONTIKI || defined WITH_LWIP */
5020COAP_API int
5022 const char *group_name COAP_UNUSED,
5023 const char *ifname COAP_UNUSED) {
5024 return -1;
5025}
5026
5027int
5029 size_t hops COAP_UNUSED) {
5030 return 0;
5031}
5032
5033void
5035}
5036#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:2040
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:1012
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:1910
#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:4667
#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:4424
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:3012
int coap_started
Definition coap_net.c:4611
static int coap_handle_dgram_for_proto(coap_context_t *ctx, coap_session_t *session, coap_packet_t *packet)
Definition coap_net.c:2158
static void coap_write_session(coap_context_t *ctx, coap_session_t *session, coap_tick_t now)
Definition coap_net.c:2199
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:3918
#define min(a, b)
Definition coap_net.c:73
void coap_startup(void)
Definition coap_net.c:4621
static int check_token_size(coap_session_t *session, const coap_pdu_t *pdu)
Definition coap_net.c:3991
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:2528
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:2463
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:1939
int coap_io_process_lkd(coap_context_t *ctx, uint32_t timeout_ms)
The main I/O processing function.
Definition coap_io.c:1736
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:1256
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:1356
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:2517
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:2456
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:89
#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_USE_LIBCOAP
Definition coap_block.h:61
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:4721
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:4496
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:2678
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:4024
coap_mid_t coap_send_internal(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:1679
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
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:4558
coap_mid_t coap_retransmit(coap_context_t *context, coap_queue_t *node)
Handles retransmissions of confirmable messages.
Definition coap_net.c:2055
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:1294
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:2723
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:2633
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:2762
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:1918
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:1346
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:1913
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:4685
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:2795
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:4714
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:4702
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:4548
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:4708
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:4485
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:4696
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)
#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:619
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:482
#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:1066
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:982
#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:576
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:1328
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:713
#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:1478
#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:1013
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:290
#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:769
#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:940
#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
void coap_delete_pdu(coap_pdu_t *pdu)
Dispose of an CoAP PDU and frees associated storage.
Definition coap_pdu.c:183
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:349
#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:1455
#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:834
@ 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:2227
#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
unsigned ref
reference count
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 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.
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_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_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:65
coap_str_const_t host
The host part of the URI.
Definition coap_uri.h:66