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