libcoap 4.3.5-develop-d328fc5
Loading...
Searching...
No Matches
coap_session.c
Go to the documentation of this file.
1/* coap_session.c -- Session management for libcoap
2 *
3 * Copyright (C) 2017 Jean-Claue Michelou <jcm@spinetix.com>
4 * Copyright (C) 2022-2025 Jon Shallow <supjps-libcoap@jpshallow.com>
5 *
6 * SPDX-License-Identifier: BSD-2-Clause
7 *
8 * This file is part of the CoAP library libcoap. Please see
9 * README for terms of use.
10 */
11
18
19#ifndef COAP_SESSION_C_
20#define COAP_SESSION_C_
21
22#include <stdio.h>
23
24#ifdef COAP_EPOLL_SUPPORT
25#include <sys/epoll.h>
26#include <sys/timerfd.h>
27#endif /* COAP_EPOLL_SUPPORT */
28
32 uint32_t fr = fp1.fractional_part * fp2.fractional_part;
33
34 res.integer_part = fp1.integer_part * fp2.integer_part + fr/1000;
35 res.fractional_part = fr % 1000;
36 return res;
37}
38
42 uint32_t fr = fp1.fractional_part * u2;
43
44 res.integer_part = fp1.integer_part * u2 + fr/1000;
45 res.fractional_part = fr % 1000;
46 return res;
47}
48
52 uint32_t fr = fp1.fractional_part + fp2.fractional_part;
53
54 res.integer_part = fp1.integer_part + fp2.integer_part + fr/1000;
55 res.fractional_part = fr % 1000;
56 return res;
57}
58
61 coap_fixed_point_t res = fp1;
62
63 res.integer_part += u2;
64 return res;
65}
66
69 coap_fixed_point_t res = fp1;
70
71 res.integer_part -= u2;
72 return res;
73}
74
78 uint32_t num = (fp1.integer_part * 1000 + fp1.fractional_part) / u2;
79
80 res.integer_part = num / 1000;
81 res.fractional_part = num % 1000;
82 return res;
83}
84
85#if COAP_Q_BLOCK_SUPPORT
89 uint8_t ran;
90
91 coap_prng_lkd(&ran, sizeof(ran));
93 res = coap_multi_fixed_uint(res, ran);
94 res = coap_div_fixed_uint(res, 0xff);
95 res = coap_add_fixed_fixed(COAP_NON_TIMEOUT(session), res);
96 return res;
97}
98
104
105 return ticks;
106}
107
108/*
109 * Save away derived Congestion Control parameters for speed of access.
110 * They will get updated whenever a component variable is updated.
111 */
112
113/*
114 * NON_PROBING_WAIT = NON_TIMEOUT * ((2 ** NON_MAX_RETRANSMIT) - 1) *
115 * ACK_RANDOM_FACTOR + (2 * MAX_LATENCY) + NON_TIMEOUT_RANDOM
116 *
117 * Do not include NON_TIMEOUT_RANDOM as that changes
118 */
119static void
120coap_session_fix_non_probing_wait_base(coap_session_t *s) {
122
124 ((1 << (COAP_NON_MAX_RETRANSMIT(s) + 1)) -1));
128}
129
130/*
131 * NON_PARTIAL_TIMEOUT = NON_TIMEOUT * ((2 ** NON_MAX_RETRANSMIT) - 1) *
132 * ACK_RANDOM_FACTOR + (2 * MAX_LATENCY) + NON_TIMEOUT
133 */
134static void
135coap_session_fix_non_partial_timeout(coap_session_t *s) {
137
139 ((1 << (COAP_NON_MAX_RETRANSMIT(s) + 1)) -1));
144}
145#endif /* COAP_Q_BLOCK_SUPPORT */
146
147void
149 if (value.integer_part > 0 && value.fractional_part < 1000) {
150 session->ack_timeout = value;
151 coap_log_debug("***%s: session ack_timeout set to %u.%03u\n",
152 coap_session_str(session), session->ack_timeout.integer_part,
154 }
155}
156
157void
159 coap_fixed_point_t value) {
160 if (value.integer_part > 0 && value.fractional_part < 1000) {
161 session->ack_random_factor = value;
162 coap_log_debug("***%s: session ack_random_factor set to %u.%03u\n",
165#if COAP_Q_BLOCK_SUPPORT
166 coap_session_fix_non_probing_wait_base(session);
167 coap_session_fix_non_partial_timeout(session);
168#endif /* COAP_Q_BLOCK_SUPPORT */
169 }
170 return;
171}
172
173void
175 if (value > 0) {
176 session->max_retransmit = value;
177 coap_log_debug("***%s: session max_retransmit set to %u\n",
178 coap_session_str(session), session->max_retransmit);
179 }
180}
181
182void
183coap_session_set_nstart(coap_session_t *session, uint16_t value) {
184 if (value > 0) {
185 session->nstart = value;
186 coap_log_debug("***%s: session nstart set to %u\n",
187 coap_session_str(session), session->nstart);
188 }
189}
190
191void
193 coap_fixed_point_t value) {
194 if (value.integer_part > 0 && value.fractional_part < 1000) {
195 session->default_leisure = value;
196 coap_log_debug("***%s: session default_leisure set to %u.%03u\n",
199 }
200}
201
202void
204 if (value > 0) {
205 session->probing_rate = value;
206 coap_log_debug("***%s: session probing_rate set to %" PRIu32 "\n",
207 coap_session_str(session), session->probing_rate);
208 }
209}
210
211void
213#if COAP_Q_BLOCK_SUPPORT
214 if (value > 0) {
215 session->max_payloads = value;
216 coap_log_debug("***%s: session max_payloads set to %u\n",
217 coap_session_str(session), session->max_payloads);
218 coap_session_fix_non_probing_wait_base(session);
219 coap_session_fix_non_partial_timeout(session);
220 }
221#else /* ! COAP_Q_BLOCK_SUPPORT */
222 (void)session;
223 (void)value;
224#endif /* ! COAP_Q_BLOCK_SUPPORT */
225}
226
227void
229#if COAP_Q_BLOCK_SUPPORT
230 if (value > 0) {
231 session->non_max_retransmit = value;
232 coap_log_debug("***%s: session non_max_retransmit set to %u\n",
233 coap_session_str(session), session->non_max_retransmit);
234 coap_session_fix_non_probing_wait_base(session);
235 coap_session_fix_non_partial_timeout(session);
236 }
237#else /* ! COAP_Q_BLOCK_SUPPORT */
238 (void)session;
239 (void)value;
240#endif /* ! COAP_Q_BLOCK_SUPPORT */
241}
242
243void
245 coap_fixed_point_t value) {
246#if COAP_Q_BLOCK_SUPPORT
247 if (value.integer_part > 0 && value.fractional_part < 1000) {
248 session->non_timeout = value;
249 coap_log_debug("***%s: session non_timeout set to %u.%03u\n",
250 coap_session_str(session), session->non_timeout.integer_part,
251 session->non_timeout.fractional_part);
252 coap_session_fix_non_probing_wait_base(session);
253 coap_session_fix_non_partial_timeout(session);
254 }
255#else /* ! COAP_Q_BLOCK_SUPPORT */
256 (void)session;
257 (void)value;
258#endif /* ! COAP_Q_BLOCK_SUPPORT */
259}
260
261void
263 coap_fixed_point_t value) {
264#if COAP_Q_BLOCK_SUPPORT
265 if (value.integer_part > 0 && value.fractional_part < 1000)
266 session->non_receive_timeout = value;
267 coap_log_debug("***%s: session non_receive_timeout set to %u.%03u\n",
268 coap_session_str(session),
269 session->non_receive_timeout.integer_part,
270 session->non_receive_timeout.fractional_part);
271#else /* ! COAP_Q_BLOCK_SUPPORT */
272 (void)session;
273 (void)value;
274#endif /* ! COAP_Q_BLOCK_SUPPORT */
275}
276
279 return session->ack_timeout;
280}
281
284 return session->ack_random_factor;
285}
286
287uint16_t
289 return session->max_retransmit;
290}
291
292uint16_t
294 return session->nstart;
295}
296
299 return session->default_leisure;
300}
301
302uint32_t
304 return session->probing_rate;
305}
306
307uint16_t
309#if COAP_Q_BLOCK_SUPPORT
310 return session->max_payloads;
311#else /* ! COAP_Q_BLOCK_SUPPORT */
312 (void)session;
314#endif /* ! COAP_Q_BLOCK_SUPPORT */
315}
316
317uint16_t
319#if COAP_Q_BLOCK_SUPPORT
320 return session->non_max_retransmit;
321#else /* ! COAP_Q_BLOCK_SUPPORT */
322 (void)session;
324#endif /* ! COAP_Q_BLOCK_SUPPORT */
325}
326
329#if COAP_Q_BLOCK_SUPPORT
330 return session->non_timeout;
331#else /* ! COAP_Q_BLOCK_SUPPORT */
332 (void)session;
334#endif /* ! COAP_Q_BLOCK_SUPPORT */
335}
336
339#if COAP_Q_BLOCK_SUPPORT
340 return session->non_receive_timeout;
341#else /* ! COAP_Q_BLOCK_SUPPORT */
342 (void)session;
344#endif /* ! COAP_Q_BLOCK_SUPPORT */
345}
346
349 coap_lock_lock(return NULL);
352 return session;
353}
354
357 ++session->ref;
358 return session;
359}
360
361COAP_API void
363 if (session) {
364#if COAP_THREAD_SAFE
365 coap_context_t *context = session->context;
366 (void)context;
367#endif /* COAP_THREAD_SAFE */
368
369 coap_lock_lock(return);
372 }
373}
374
375void
377 if (session) {
379#ifndef __COVERITY__
380 assert(session->ref > 0);
381 if (session->ref > 0)
382 --session->ref;
383 if (session->ref == 0 && session->type == COAP_SESSION_TYPE_CLIENT)
384 coap_session_free(session);
385#else /* __COVERITY__ */
386 /* Coverity scan is fooled by the reference counter leading to
387 * false positives for USE_AFTER_FREE. */
388 --session->ref;
389 __coverity_negative_sink__(session->ref);
390 /* Indicate that resources are released properly. */
391 if (session->ref == 0 && session->type == COAP_SESSION_TYPE_CLIENT) {
392 __coverity_free__(session);
393 }
394#endif /* __COVERITY__ */
395 }
396}
397
398COAP_API void
399coap_session_set_app_data(coap_session_t *session, void *app_data) {
400 assert(session);
401 coap_lock_lock(return);
402 coap_session_set_app_data2_lkd(session, app_data, NULL);
404}
405
406void *
408 assert(session);
409 return session->app_data;
410}
411
412COAP_API void *
415 void *old_data;
416
417 coap_lock_lock(return NULL);
418 old_data = coap_session_set_app_data2_lkd(session, app_data, callback);
420 return old_data;
421}
422
423void *
426 void *old_data = session->app_data;
427
428 session->app_data = app_data;
429 session->app_cb = app_data ? callback : NULL;
430 return old_data;
431}
432
433static coap_session_t *
435 const coap_addr_hash_t *addr_hash,
436 const coap_address_t *local_addr,
437 const coap_address_t *remote_addr, int ifindex,
438 coap_context_t *context, coap_endpoint_t *endpoint) {
440 sizeof(coap_session_t));
441#if ! COAP_SERVER_SUPPORT
442 (void)endpoint;
443#endif /* ! COAP_SERVER_SUPPORT */
444 if (!session)
445 return NULL;
446 memset(session, 0, sizeof(*session));
447 session->proto = proto;
448 session->type = type;
449 if (addr_hash)
450 memcpy(&session->addr_hash, addr_hash, sizeof(session->addr_hash));
451 else
452 memset(&session->addr_hash, 0, sizeof(session->addr_hash));
453 if (local_addr) {
454 coap_address_copy(&session->addr_info.local, local_addr);
455#if COAP_CLIENT_SUPPORT
456 coap_address_copy(&session->local_reconnect, local_addr);
457#endif /* COAP_CLIENT_SUPPORT */
458 } else {
460#if COAP_CLIENT_SUPPORT
462#endif /* COAP_CLIENT_SUPPORT */
463 }
464 if (remote_addr)
465 coap_address_copy(&session->addr_info.remote, remote_addr);
466 else
468 session->ifindex = ifindex;
469 session->context = context;
470#if COAP_SERVER_SUPPORT
471 session->endpoint = endpoint;
472 if (endpoint)
473 session->mtu = endpoint->default_mtu;
474 else
475#endif /* COAP_SERVER_SUPPORT */
477 session->block_mode = context->block_mode;
478 if (proto == COAP_PROTO_DTLS) {
479 session->tls_overhead = 29;
480 if (session->tls_overhead >= session->mtu) {
481 session->tls_overhead = session->mtu;
482 coap_log_err("DTLS overhead exceeds MTU\n");
483 }
484 }
488 session->nstart = COAP_DEFAULT_NSTART;
491#if COAP_Q_BLOCK_SUPPORT
492 session->max_payloads = COAP_DEFAULT_MAX_PAYLOADS;
493 session->non_max_retransmit = COAP_DEFAULT_NON_MAX_RETRANSMIT;
494 session->non_timeout = COAP_DEFAULT_NON_TIMEOUT;
495 session->non_receive_timeout = COAP_DEFAULT_NON_RECEIVE_TIMEOUT;
496 coap_session_fix_non_probing_wait_base(session);
497 coap_session_fix_non_partial_timeout(session);
498#endif /* COAP_Q_BLOCK_SUPPORT */
499 session->dtls_event = -1;
504 session->max_token_size = context->max_token_size; /* RFC8974 */
505 if (session->type != COAP_SESSION_TYPE_CLIENT)
507
508 /* Randomly initialize */
509 /* TCP/TLS have no notion of mid */
510 if (COAP_PROTO_NOT_RELIABLE(session->proto))
511 coap_prng_lkd((unsigned char *)&session->tx_mid, sizeof(session->tx_mid));
512 coap_prng_lkd((unsigned char *)&session->tx_rtag, sizeof(session->tx_rtag));
513
514 return session;
515}
516
517void
519 coap_queue_t *q, *tmp;
520 coap_lg_xmit_t *lq, *ltmp;
521
522#if COAP_CLIENT_SUPPORT
523 coap_lg_crcv_t *lg_crcv, *etmp;
524
525 /* Need to do this before (D)TLS and socket is closed down */
526 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
527 if (lg_crcv->observe_set && session->no_observe_cancel == 0) {
528 /* Need to close down observe */
529 if (coap_cancel_observe_lkd(session, lg_crcv->app_token, COAP_MESSAGE_NON)) {
530 /* Need to delete node we set up for NON */
531 coap_queue_t *queue = session->context->sendqueue;
532
533 while (queue) {
534 if (queue->session == session) {
536 break;
537 }
538 queue = queue->next;
539 }
540 }
541 }
542 LL_DELETE(session->lg_crcv, lg_crcv);
543 coap_block_delete_lg_crcv(session, lg_crcv);
544 }
545#endif /* COAP_CLIENT_SUPPORT */
546
547 if (session->partial_pdu)
549 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
550 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
551 if (session->psk_identity)
553 if (session->psk_key)
555 if (session->psk_hint)
557
558#if COAP_SERVER_SUPPORT
559 coap_cache_entry_t *cp, *ctmp;
560 HASH_ITER(hh, session->context->cache, cp, ctmp) {
561 /* cp->session is NULL if not session based */
562 if (cp->session == session) {
563 coap_delete_cache_entry(session->context, cp);
564 }
565 }
566#endif /* COAP_SERVER_SUPPORT */
567 LL_FOREACH_SAFE(session->delayqueue, q, tmp) {
568 if (q->pdu->type==COAP_MESSAGE_CON) {
569 coap_handle_nack(session, q->pdu,
570 session->proto == COAP_PROTO_DTLS ?
572 q->id);
573 }
575 }
576 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
577 LL_DELETE(session->lg_xmit, lq);
578 coap_block_delete_lg_xmit(session, lq);
579 }
580#if COAP_SERVER_SUPPORT
581 coap_lg_srcv_t *sq, *stmp;
582
583 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
584 LL_DELETE(session->lg_srcv, sq);
585 coap_block_delete_lg_srcv(session, sq);
586 }
587#endif /* COAP_SERVER_SUPPORT */
588#if COAP_OSCORE_SUPPORT
590#endif /* COAP_OSCORE_SUPPORT */
591#if COAP_WS_SUPPORT
592 coap_free_type(COAP_STRING, session->ws);
593 coap_delete_str_const(session->ws_host);
594#endif /* COAP_WS_SUPPORT */
595}
596
597void
599 if (!session)
600 return;
602 assert(session->ref == 0);
603 if (session->ref)
604 return;
605 /* Make sure nothing gets deleted under our feet */
607 coap_session_mfree(session);
608#if COAP_SERVER_SUPPORT
610 if (session->endpoint) {
611 if (session->endpoint->sessions)
612 SESSIONS_DELETE(session->endpoint->sessions, session);
613 } else
614#endif /* COAP_SERVER_SUPPORT */
615#if COAP_CLIENT_SUPPORT
616 if (session->context) {
617 if (session->context->sessions)
618 SESSIONS_DELETE(session->context->sessions, session);
619 }
621#endif /* COAP_CLIENT_SUPPORT */
623 coap_delete_bin_const(session->echo);
624#if COAP_SERVER_SUPPORT
626#endif /* COAP_SERVER_SUPPORT */
627 coap_log_debug("***%s: session %p: closed\n", coap_session_str(session),
628 (void *)session);
629
630 if (session->app_cb) {
631 session->app_cb(session->app_data);
632 }
633 assert(session->ref == 1);
635}
636
637#if COAP_SERVER_SUPPORT
638void
640 int i;
641
644 coap_cancel_all_messages(session->context, session, NULL);
645 RESOURCES_ITER(session->context->resources, r) {
646 /* In case code is broken somewhere */
647 for (i = 0; i < 1000; i++) {
648 if (!coap_delete_observer(r, session, NULL))
649 break;
650 }
651 }
652 if (session->context->unknown_resource) {
653 /* In case code is broken somewhere */
654 for (i = 0; i < 1000; i++) {
655 if (!coap_delete_observer(session->context->unknown_resource, session, NULL))
656 break;
657 }
658 }
659 if (session->context->proxy_uri_resource) {
660 /* In case code is broken somewhere */
661 for (i = 0; i < 1000; i++) {
662 if (!coap_delete_observer(session->context->proxy_uri_resource, session, NULL))
663 break;
664 }
665 }
666 while (session->delayqueue) {
667 coap_queue_t *q = session->delayqueue;
668
669 session->delayqueue = q->next;
671 }
672 /* Force session to go away */
675
677}
678#endif /* COAP_SERVER_SUPPORT */
679
680static size_t
682 size_t max_with_header) {
683#if COAP_DISABLE_TCP
684 (void)session;
685 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
686 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
687 : 0;
688#else /* !COAP_DISABLE_TCP */
689 if (COAP_PROTO_NOT_RELIABLE(session->proto))
690 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
691 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
692 : 0;
693 /* we must assume there is no token to be on the safe side */
694 if (max_with_header <= 2)
695 return 0;
696 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP0 + 2)
697 return max_with_header - 2;
698 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP8 + 3)
699 return max_with_header - 3;
700 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP16 + 4)
701 return max_with_header - 4;
702 else
703 return max_with_header - COAP_PDU_MAX_TCP_HEADER_SIZE;
704#endif /* !COAP_DISABLE_TCP */
705}
706
707size_t
709 if (session->csm_rcv_mtu)
711 (size_t)(session->csm_rcv_mtu));
712
714 (size_t)(session->mtu - session->tls_overhead));
715}
716
717COAP_API size_t
719 size_t size;
720 coap_session_t *session_rw;
721
722 /*
723 * Need to do this to not get a compiler warning about const parameters
724 * but need to maintain source code backward compatibility
725 */
726 memcpy(&session_rw, &session, sizeof(session_rw));
727 coap_lock_lock(return 0);
728 size = coap_session_max_pdu_size_lkd(session_rw);
730 return size;
731}
732
733size_t
735 size_t max_with_header;
736
738#if COAP_CLIENT_SUPPORT
739 /*
740 * Delay if session->doing_first is set.
741 * E.g. Reliable and CSM not in yet for checking block support
742 */
743 coap_session_t *session_rw;
744
745 /*
746 * Need to do this to not get a compiler warning about const parameters
747 * but need to maintain source code backward compatibility
748 */
749 memcpy(&session_rw, &session, sizeof(session_rw));
750 if (coap_client_delay_first(session_rw) == 0) {
751 coap_log_debug("coap_client_delay_first: timeout\n");
752 /* Have to go with the defaults */
753 }
754#endif /* COAP_CLIENT_SUPPORT */
755
756 max_with_header = (size_t)(session->mtu - session->tls_overhead);
757
758 return coap_session_max_pdu_size_internal(session, max_with_header);
759}
760
761void
762coap_session_set_mtu(coap_session_t *session, unsigned mtu) {
763#if defined(WITH_CONTIKI) || defined(WITH_LWIP)
764 if (mtu > COAP_DEFAULT_MAX_PDU_RX_SIZE)
765 mtu = COAP_DEFAULT_MAX_PDU_RX_SIZE;
766#endif
767 if (mtu < 64)
768 mtu = 64;
769 session->mtu = mtu;
770 if (session->tls_overhead >= session->mtu) {
771 session->tls_overhead = session->mtu;
772 coap_log_err("DTLS overhead exceeds MTU\n");
773 }
774}
775
776ssize_t
778 coap_queue_t *node) {
779 if (node) {
780 coap_queue_t *removed = NULL;
781 coap_remove_from_queue(&session->context->sendqueue, session, node->id, &removed);
782 assert(removed == node);
784 node->session = NULL;
785 node->t = 0;
786 } else {
787 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
788 coap_queue_t *q = NULL;
789 /* Check same mid is not getting re-used in violation of RFC7252 */
790 LL_FOREACH(session->delayqueue, q) {
791 if (q->id == pdu->mid) {
792 coap_log_err("** %s: mid=0x%04x: already in-use - dropped\n",
793 coap_session_str(session), pdu->mid);
794 return COAP_INVALID_MID;
795 }
796 }
797 }
798 node = coap_new_node();
799 if (node == NULL)
800 return COAP_INVALID_MID;
801 node->id = pdu->mid;
802 node->pdu = pdu;
803 if (pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
804 uint8_t r;
805 coap_prng_lkd(&r, sizeof(r));
806 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
807 node->timeout = coap_calc_timeout(session, r);
808 }
809 coap_address_copy(&node->remote, &session->addr_info.remote);
810 }
811 LL_APPEND(session->delayqueue, node);
812 coap_log_debug("** %s: mid=0x%04x: delayed\n",
813 coap_session_str(session), node->id);
814 return COAP_PDU_DELAYED;
815}
816
817#if !COAP_DISABLE_TCP
818void
820 coap_pdu_t *pdu;
821 uint8_t buf[4];
822 assert(COAP_PROTO_RELIABLE(session->proto));
823 coap_log_debug("***%s: sending CSM\n", coap_session_str(session));
824 session->state = COAP_SESSION_STATE_CSM;
825 session->partial_write = 0;
826 if (session->mtu == 0)
827 coap_session_set_mtu(session, COAP_DEFAULT_MTU); /* base value */
829 if (pdu == NULL
831 coap_encode_var_safe(buf, sizeof(buf),
832 session->context->csm_max_message_size), buf) == 0
834 coap_encode_var_safe(buf, sizeof(buf),
835 0), buf) == 0
836 || (session->max_token_size > COAP_TOKEN_DEFAULT_MAX &&
839 coap_encode_var_safe(buf, sizeof(buf),
840 session->max_token_size),
841 buf) == 0)
842 || coap_pdu_encode_header(pdu, session->proto) == 0
843 ) {
845 } else {
846 ssize_t bytes_written;
847
848 pdu->session = session;
849 bytes_written = coap_session_send_pdu(session, pdu);
850 if (bytes_written != (ssize_t)pdu->used_size + pdu->hdr_size) {
852 } else {
853 session->csm_rcv_mtu = session->context->csm_max_message_size;
854 if (session->csm_rcv_mtu > COAP_BERT_BASE)
855 session->csm_bert_loc_support = 1;
856 else
857 session->csm_bert_loc_support = 0;
858 }
859 }
860 if (pdu)
862}
863#endif /* !COAP_DISABLE_TCP */
864
867 coap_mid_t mid;
868
870 mid = coap_session_send_ping_lkd(session);
872 return mid;
873}
874
877 coap_pdu_t *ping = NULL;
878
880 if (session->state != COAP_SESSION_STATE_ESTABLISHED ||
881 session->con_active)
882 return COAP_INVALID_MID;
883 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
884 uint16_t mid = coap_new_message_id_lkd(session);
885 ping = coap_pdu_init(COAP_MESSAGE_CON, 0, mid, 0);
886 }
887#if !COAP_DISABLE_TCP
888 else {
890 }
891#endif /* !COAP_DISABLE_TCP */
892 if (!ping)
893 return COAP_INVALID_MID;
894 return coap_send_internal(session, ping, NULL);
895}
896
897void
899 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
900 coap_log_debug("***%s: session connected\n",
901 coap_session_str(session));
902 if (session->state == COAP_SESSION_STATE_CSM) {
904#if COAP_CLIENT_SUPPORT
906#endif /* COAP_CLIENT_SUPPORT */
907 if (session->doing_first)
908 session->doing_first = 0;
909 }
910 }
911
913 session->partial_write = 0;
914
915 if (session->proto==COAP_PROTO_DTLS) {
916 session->tls_overhead = coap_dtls_get_overhead(session);
917 if (session->tls_overhead >= session->mtu) {
918 session->tls_overhead = session->mtu;
919 coap_log_err("DTLS overhead exceeds MTU\n");
920 }
921 }
922
923 while (session->delayqueue && session->state == COAP_SESSION_STATE_ESTABLISHED) {
924 ssize_t bytes_written;
925 coap_queue_t *q = session->delayqueue;
926 coap_address_t remote;
927
928 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
929 if (session->con_active >= COAP_NSTART(session))
930 break;
931 session->con_active++;
932 }
933 /* Take entry off the queue */
934 session->delayqueue = q->next;
935 q->next = NULL;
936
937 coap_address_copy(&remote, &session->addr_info.remote);
939 coap_log_debug("** %s: mid=0x%04x: transmitted after delay (2)\n",
940 coap_session_str(session), (int)q->pdu->mid);
941 bytes_written = coap_session_send_pdu(session, q->pdu);
942 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
943 if (coap_wait_ack(session->context, session, q) >= 0)
944 q = NULL;
945 }
946 coap_address_copy(&session->addr_info.remote, &remote);
947 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
948 if (q)
950 if (bytes_written < 0)
951 break;
952 } else if (q) {
953 if (bytes_written <= 0 || (size_t)bytes_written < q->pdu->used_size + q->pdu->hdr_size) {
954 q->next = session->delayqueue;
955 session->delayqueue = q;
956 if (bytes_written > 0)
957 session->partial_write = (size_t)bytes_written;
958 break;
959 } else {
961 }
962 }
963 }
964}
965
966#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
967static const char *
969 switch (reason) {
971 return "COAP_NACK_TOO_MANY_RETRIES";
973 return "COAP_NACK_NOT_DELIVERABLE";
974 case COAP_NACK_RST:
975 return "COAP_NACK_RST";
977 return "COAP_NACK_TLS_FAILED";
979 return "COAP_NACK_ICMP_ISSUE";
981 return "COAP_NACK_BAD_RESPONSE";
983 return "COAP_NACK_TLS_LAYER_FAILED";
985 return "COAP_NACK_WS_LAYER_FAILED";
987 return "COAP_NACK_WS_FAILED";
988 default:
989 return "???";
990 }
991}
992#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
993
994void
996 coap_pdu_t *sent,
997 const coap_nack_reason_t reason,
998 const coap_mid_t mid) {
999 if (session->context->nack_handler) {
1000 coap_bin_const_t token = {0, NULL};
1001
1002 if (sent) {
1003 coap_check_update_token(session, sent);
1004 token = sent->actual_token;
1005 }
1006 coap_lock_callback(session->context->nack_handler(session, sent, reason, mid));
1007 if (sent) {
1008 coap_update_token(sent, token.length, token.s);
1009 }
1010 }
1011#if COAP_CLIENT_SUPPORT
1012 if (reason != COAP_NACK_ICMP_ISSUE) {
1013 session->doing_send_recv = 0;
1014 }
1015#endif /* COAP_CLIENT_SUPPORT */
1016}
1017
1018COAP_API void
1024
1025void
1027#if !COAP_DISABLE_TCP
1028 coap_session_state_t state = session->state;
1029#endif /* !COAP_DISABLE_TCP */
1030 coap_lg_xmit_t *lq, *ltmp;
1031#if COAP_SERVER_SUPPORT
1032 coap_lg_srcv_t *sq, *stmp;
1033#endif /* COAP_SERVER_SUPPORT */
1034#if COAP_CLIENT_SUPPORT
1035 coap_lg_crcv_t *cq, *etmp;
1036#endif /* COAP_CLIENT_SUPPORT */
1037 int sent_nack = 0;
1038 coap_queue_t *q;
1039
1041#if COAP_CLIENT_SUPPORT
1042 coap_session_failed(session);
1043#endif /* COAP_CLIENT_SUPPORT */
1044
1045 q = session->context->sendqueue;
1046 while (q) {
1047 if (q->session == session) {
1048 /* Take the first one */
1049 coap_handle_nack(session, q->pdu, reason, q->id);
1050 sent_nack = 1;
1051 break;
1052 }
1053 q = q->next;
1054 }
1055
1056 if (reason != COAP_NACK_ICMP_ISSUE) {
1057 while (session->delayqueue) {
1058 q = session->delayqueue;
1059 session->delayqueue = q->next;
1060 q->next = NULL;
1061 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1062 coap_session_str(session), q->id);
1063 if (q->pdu->type == COAP_MESSAGE_CON) {
1064 coap_handle_nack(session, q->pdu, reason, q->id);
1065 sent_nack = 1;
1066 }
1067
1068#if COAP_CLIENT_SUPPORT
1069 session->doing_send_recv = 0;
1070#endif /* COAP_CLIENT_SUPPORT */
1072 }
1073 }
1074#if COAP_CLIENT_SUPPORT
1075 if (!sent_nack && session->lg_crcv) {
1076 /* Take the first one */
1077 coap_handle_nack(session, session->lg_crcv->sent_pdu, reason,
1078 session->lg_crcv->sent_pdu->mid);
1079 sent_nack = 1;
1080 }
1081#endif /* COAP_CLIENT_SUPPORT */
1082 if (!sent_nack) {
1083 /* Unable to determine which request disconnection was for */
1084 coap_handle_nack(session, NULL, reason, 0);
1085 }
1086 if (reason == COAP_NACK_ICMP_ISSUE) {
1087 coap_log_debug("***%s: session ICMP issue (%s)\n",
1088 coap_session_str(session), coap_nack_name(reason));
1089 return;
1090 }
1091 coap_log_debug("***%s: session disconnected (%s)\n",
1092 coap_session_str(session), coap_nack_name(reason));
1093#if COAP_SERVER_SUPPORT
1094 coap_delete_observers(session->context, session);
1095#endif /* COAP_SERVER_SUPPORT */
1096
1097 if (session->proto == COAP_PROTO_UDP)
1099 else
1100 session->state = COAP_SESSION_STATE_NONE;
1101
1102 session->con_active = 0;
1103
1104 if (session->partial_pdu) {
1106 session->partial_pdu = NULL;
1107 }
1108 session->partial_read = 0;
1109
1110 /* Not done if nack handler called above */
1111 while (session->delayqueue) {
1112 q = session->delayqueue;
1113 session->delayqueue = q->next;
1114 q->next = NULL;
1115 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1116 coap_session_str(session), q->id);
1117#if COAP_CLIENT_SUPPORT
1118 session->doing_send_recv = 0;
1119#endif /* COAP_CLIENT_SUPPORT */
1121 }
1122
1123#if COAP_CLIENT_SUPPORT
1124 if (!session->session_failed) {
1125 /* Need to do this before (D)TLS and socket is closed down */
1126 LL_FOREACH_SAFE(session->lg_crcv, cq, etmp) {
1127 LL_DELETE(session->lg_crcv, cq);
1128 coap_block_delete_lg_crcv(session, cq);
1129 }
1130 }
1131#endif /* COAP_CLIENT_SUPPORT */
1132 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
1133 LL_DELETE(session->lg_xmit, lq);
1134 coap_block_delete_lg_xmit(session, lq);
1135 }
1136#if COAP_SERVER_SUPPORT
1137 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
1138 LL_DELETE(session->lg_srcv, sq);
1139 coap_block_delete_lg_srcv(session, sq);
1140 }
1141#endif /* COAP_SERVER_SUPPORT */
1142 coap_cancel_session_messages(session->context, session, reason);
1143
1144#if !COAP_DISABLE_TCP
1145 if (COAP_PROTO_RELIABLE(session->proto)) {
1146 if (coap_netif_available(session)) {
1150 }
1151#if COAP_CLIENT_SUPPORT
1152 if (state != COAP_SESSION_STATE_NONE && !session->session_failed) {
1156 }
1157#endif /* COAP_CLIENT_SUPPORT */
1158 if (session->doing_first)
1159 session->doing_first = 0;
1160 }
1161#endif /* !COAP_DISABLE_TCP */
1162 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1163 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1164}
1165
1166#if COAP_CLIENT_SUPPORT
1167void
1169 if (session->context->reconnect_time &&
1171 session->type == COAP_SESSION_TYPE_CLIENT) {
1172 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1173 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1174 session->session_failed = 1;
1175 coap_ticks(&session->last_rx_tx);
1176 }
1177}
1178#endif /* COAP_CLIENT_SUPPORT */
1179
1180#if COAP_SERVER_SUPPORT
1181static void
1182coap_make_addr_hash(coap_addr_hash_t *addr_hash, coap_proto_t proto,
1183 const coap_addr_tuple_t *addr_info) {
1184 memset(addr_hash, 0, sizeof(coap_addr_hash_t));
1185 coap_address_copy(&addr_hash->remote, &addr_info->remote);
1186 addr_hash->lport = coap_address_get_port(&addr_info->local);
1187 addr_hash->proto = proto;
1188}
1189
1192 const coap_packet_t *packet, coap_tick_t now) {
1193 coap_session_t *session;
1194 coap_session_t *rtmp;
1195 unsigned int num_idle = 0;
1196 unsigned int num_hs = 0;
1197 coap_session_t *oldest = NULL;
1198 coap_session_t *oldest_hs = NULL;
1199 coap_addr_hash_t addr_hash;
1200
1201 coap_make_addr_hash(&addr_hash, endpoint->proto, &packet->addr_info);
1202 SESSIONS_FIND(endpoint->sessions, addr_hash, session);
1203 if (session) {
1204 /* Maybe mcast or unicast IP address which is not in the hash */
1205 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1206 session->ifindex = packet->ifindex;
1207 session->last_rx_tx = now;
1208 return session;
1209 }
1210
1211#if COAP_CLIENT_SUPPORT
1212 if (coap_is_mcast(&packet->addr_info.local)) {
1213 /* Check if this a proxy client packet we sent on another socket */
1214 SESSIONS_ITER(endpoint->context->sessions, session, rtmp) {
1215 if (coap_address_equals(&session->addr_info.remote, &packet->addr_info.local) &&
1218 /* Drop looped back packet to stop recursion / confusion */
1219 return NULL;
1220 }
1221 }
1222 }
1223#endif /* COAP_CLIENT_SUPPORT */
1224 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1225 if (session->ref == 0 && session->delayqueue == NULL) {
1226 if (session->type == COAP_SESSION_TYPE_SERVER) {
1227 ++num_idle;
1228 if (oldest==NULL || session->last_rx_tx < oldest->last_rx_tx)
1229 oldest = session;
1230
1231 if (session->state == COAP_SESSION_STATE_HANDSHAKE) {
1232 ++num_hs;
1233 /* See if this is a partial (D)TLS session set up
1234 which needs to be cleared down to prevent DOS */
1235 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1236 if (oldest_hs == NULL ||
1237 session->last_rx_tx < oldest_hs->last_rx_tx)
1238 oldest_hs = session;
1239 }
1240 }
1241 } else if (session->type == COAP_SESSION_TYPE_HELLO) {
1242 ++num_hs;
1243 /* See if this is a partial (D)TLS session set up for Client Hello
1244 which needs to be cleared down to prevent DOS */
1245 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1246 if (oldest_hs == NULL ||
1247 session->last_rx_tx < oldest_hs->last_rx_tx)
1248 oldest_hs = session;
1249 }
1250 }
1251 }
1252 }
1253
1254 if (endpoint->context->max_idle_sessions > 0 &&
1255 num_idle >= endpoint->context->max_idle_sessions) {
1257 coap_session_free(oldest);
1258 } else if (oldest_hs) {
1259 coap_log_warn("***%s: Incomplete session timed out\n",
1260 coap_session_str(oldest_hs));
1262 coap_session_free(oldest_hs);
1263 }
1264
1265 if (num_hs > (endpoint->context->max_handshake_sessions ?
1266 endpoint->context->max_handshake_sessions :
1268 /* Maxed out on number of sessions in (D)TLS negotiation state */
1269 coap_log_debug("Oustanding sessions in COAP_SESSION_STATE_HANDSHAKE too "
1270 "large. New request ignored\n");
1271 return NULL;
1272 }
1273
1274 if (endpoint->proto == COAP_PROTO_DTLS) {
1275 /*
1276 * Need to check that this actually is a Client Hello before wasting
1277 * time allocating and then freeing off session.
1278 */
1279
1280 /*
1281 * Generic header structure of the DTLS record layer.
1282 * typedef struct __attribute__((__packed__)) {
1283 * uint8_t content_type; content type of the included message
1284 * uint16_t version; Protocol version
1285 * uint16_t epoch; counter for cipher state changes
1286 * uint8_t sequence_number[6]; sequence number
1287 * uint16_t length; length of the following fragment
1288 * uint8_t handshake; If content_type == DTLS_CT_HANDSHAKE
1289 * } dtls_record_handshake_t;
1290 */
1291#define OFF_CONTENT_TYPE 0 /* offset of content_type in dtls_record_handshake_t */
1292#define DTLS_CT_ALERT 21 /* Content Type Alert */
1293#define DTLS_CT_HANDSHAKE 22 /* Content Type Handshake */
1294#define OFF_HANDSHAKE_TYPE 13 /* offset of handshake in dtls_record_handshake_t */
1295#define DTLS_HT_CLIENT_HELLO 1 /* Client Hello handshake type */
1296#define DTLS_CT_CID 25 /* Content Type Connection ID */
1297#define OFF_CID 11 /* offset of CID in dtls_record_handshake_t */
1298#define OFF_CID_DTLS13 1 /* offset of CID in DTLS1.3 Unified Header */
1299
1300 const uint8_t *payload = (const uint8_t *)packet->payload;
1301 size_t length = packet->length;
1302 if (length < (OFF_HANDSHAKE_TYPE + 1)) {
1303 coap_log_debug("coap_dtls_hello: ContentType %d Short Packet (%zu < %d) dropped\n",
1304 payload[OFF_CONTENT_TYPE], length,
1305 OFF_HANDSHAKE_TYPE + 1);
1306 return NULL;
1307 }
1308 if ((payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 ||
1309 payload[OFF_CONTENT_TYPE] == DTLS_CT_CID) {
1310 /* Client may have changed its IP address */
1311 int changed = 0;
1312
1313 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1314 if (session->client_cid) {
1315 if ((session->is_dtls13 && (payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 &&
1316 memcmp(session->client_cid->s, &payload[OFF_CID_DTLS13],
1317 session->client_cid->length) == 0) ||
1318 (!session->is_dtls13 && payload[OFF_CONTENT_TYPE] == DTLS_CT_CID &&
1319 memcmp(session->client_cid->s, &payload[OFF_CID],
1320 session->client_cid->length) == 0)) {
1321 /* Updating IP address */
1322 coap_log_info("***%s: CID: Old Client Session\n", coap_session_str(session));
1323 SESSIONS_DELETE(endpoint->sessions, session);
1324 session->addr_info = packet->addr_info;
1325 memcpy(&session->addr_hash, &addr_hash, sizeof(session->addr_hash));
1326 SESSIONS_ADD(endpoint->sessions, session);
1327 coap_log_info("***%s: CID: New Client Session\n", coap_session_str(session));
1328 return session;
1329 }
1330 }
1331 }
1332 if (!changed) {
1333 coap_log_debug("coap_dtls_hello: ContentType Connection-IS dropped\n");
1334 return NULL;
1335 }
1336 } else if (payload[OFF_CONTENT_TYPE] != DTLS_CT_HANDSHAKE ||
1337 payload[OFF_HANDSHAKE_TYPE] != DTLS_HT_CLIENT_HELLO) {
1338 /* only log if not a late alert */
1339 if (payload[OFF_CONTENT_TYPE] != DTLS_CT_ALERT)
1340 coap_log_debug("coap_dtls_hello: ContentType %d Handshake %d dropped\n",
1341 payload[OFF_CONTENT_TYPE],
1342 payload[OFF_HANDSHAKE_TYPE]);
1343 return NULL;
1344 }
1345 }
1346
1348 &addr_hash, &packet->addr_info.local,
1349 &packet->addr_info.remote,
1350 packet->ifindex, endpoint->context, endpoint);
1351 if (session) {
1352 session->last_rx_tx = now;
1353 memcpy(session->sock.lfunc, endpoint->sock.lfunc,
1354 sizeof(session->sock.lfunc));
1355 if (endpoint->proto == COAP_PROTO_UDP)
1357 else if (endpoint->proto == COAP_PROTO_DTLS) {
1358 session->type = COAP_SESSION_TYPE_HELLO;
1359 }
1360 SESSIONS_ADD(endpoint->sessions, session);
1361 coap_log_debug("***%s: session %p: new incoming session\n",
1362 coap_session_str(session), (void *)session);
1364 }
1365 return session;
1366}
1367
1370 coap_tick_t now) {
1371 if (session) {
1372 session->last_rx_tx = now;
1373 session->type = COAP_SESSION_TYPE_SERVER;
1374 coap_dtls_establish(session);
1375 }
1376 return session;
1377}
1378#endif /* COAP_SERVER_SUPPORT */
1379
1380#if COAP_CLIENT_SUPPORT
1381static coap_session_t *
1382coap_session_create_client(coap_context_t *ctx,
1383 const coap_address_t *local_if,
1384 const coap_address_t *server,
1385 coap_proto_t proto) {
1386 coap_session_t *session = NULL;
1387 int default_port = COAP_DEFAULT_PORT;
1388
1389 assert(server);
1390
1391 switch (proto) {
1392 case COAP_PROTO_UDP:
1393 default_port = COAP_DEFAULT_PORT;
1394 break;
1395 case COAP_PROTO_DTLS:
1396 if (!coap_dtls_is_supported()) {
1397 coap_log_crit("coap_new_client_session*: DTLS not supported\n");
1398 return NULL;
1399 }
1400 default_port = COAPS_DEFAULT_PORT;
1401 break;
1402 case COAP_PROTO_TCP:
1403 if (!coap_tcp_is_supported()) {
1404 coap_log_crit("coap_new_client_session*: TCP not supported\n");
1405 return NULL;
1406 }
1407 default_port = COAP_DEFAULT_PORT;
1408 break;
1409 case COAP_PROTO_TLS:
1410 if (!coap_tls_is_supported()) {
1411 coap_log_crit("coap_new_client_session*: TLS not supported\n");
1412 return NULL;
1413 }
1414 default_port = COAPS_DEFAULT_PORT;
1415 break;
1416 case COAP_PROTO_WS:
1417 if (!coap_ws_is_supported()) {
1418 coap_log_crit("coap_new_client_session*: WS not supported\n");
1419 return NULL;
1420 }
1421 default_port = 80;
1422 break;
1423 case COAP_PROTO_WSS:
1424 if (!coap_wss_is_supported()) {
1425 coap_log_crit("coap_new_client_session*: WSS not supported\n");
1426 return NULL;
1427 }
1428 default_port = 443;
1429 break;
1430 case COAP_PROTO_NONE:
1431 case COAP_PROTO_LAST:
1432 default:
1433 assert(0);
1434 return NULL;
1435 }
1436 session = coap_make_session(proto, COAP_SESSION_TYPE_CLIENT, NULL,
1437 local_if, server, 0, ctx, NULL);
1438 if (!session)
1439 goto error;
1440
1442 session->sock.session = session;
1443 memcpy(&session->sock.lfunc, coap_layers_coap[proto],
1444 sizeof(session->sock.lfunc));
1445
1446 if (COAP_PROTO_NOT_RELIABLE(proto)) {
1447 coap_session_t *s, *rtmp;
1448 if (!coap_netif_dgrm_connect(session, local_if, server, default_port)) {
1449 goto error;
1450 }
1451 /* Check that this is not a duplicate 4-tuple */
1452 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
1455 &s->addr_info.local) &&
1457 &s->addr_info.remote)) {
1458 coap_log_warn("***%s: session %p: duplicate - already exists\n",
1459 coap_session_str(session), (void *)session);
1460 goto error;
1461 }
1462 }
1463#ifdef WITH_CONTIKI
1464 session->sock.context = ctx;
1465#endif /* WITH_CONTIKI */
1466#if !COAP_DISABLE_TCP
1467 } else if (COAP_PROTO_RELIABLE(proto)) {
1468 if (!coap_netif_strm_connect1(session, local_if, server, default_port)) {
1469 goto error;
1470 }
1471#endif /* !COAP_DISABLE_TCP */
1472 }
1473
1474 session->sock.session = session;
1475#ifdef COAP_EPOLL_SUPPORT
1476 coap_epoll_ctl_add(&session->sock,
1477 EPOLLIN |
1478 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1479 EPOLLOUT : 0),
1480 __func__);
1481#endif /* COAP_EPOLL_SUPPORT */
1482
1484 if (local_if)
1485 session->sock.flags |= COAP_SOCKET_BOUND;
1486#if COAP_SERVER_SUPPORT
1487 if (ctx->proxy_uri_resource)
1488 session->proxy_session = 1;
1489#endif /* COAP_SERVER_SUPPORT */
1490 SESSIONS_ADD(ctx->sessions, session);
1491 return session;
1492
1493error:
1494 /*
1495 * Need to add in the session as coap_session_release_lkd()
1496 * will call SESSIONS_DELETE in coap_session_free().
1497 */
1498 if (session)
1499 SESSIONS_ADD(ctx->sessions, session);
1500 coap_session_release_lkd(session);
1501 return NULL;
1502}
1503
1504static void
1505coap_session_check_connect(coap_session_t *session) {
1506 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1507 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1508 }
1509#if !COAP_DISABLE_TCP
1510 if (COAP_PROTO_RELIABLE(session->proto)) {
1511 if (session->sock.flags & COAP_SOCKET_WANT_CONNECT) {
1513 if (session->type == COAP_SESSION_TYPE_CLIENT) {
1514 session->doing_first = 1;
1515 }
1516 } else {
1517 /* Initial connect worked immediately */
1518 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1519 }
1520 }
1521#endif /* !COAP_DISABLE_TCP */
1522 coap_ticks(&session->last_rx_tx);
1523}
1524#endif /* COAP_CLIENT_SUPPORT */
1525
1526void
1528 if (COAP_PROTO_NOT_RELIABLE(session->proto))
1529 coap_session_connected(session);
1530#if !COAP_DISABLE_TCP
1531 if (COAP_PROTO_RELIABLE(session->proto))
1532 coap_session_send_csm(session);
1533#endif /* !COAP_DISABLE_TCP */
1534}
1535
1536#if COAP_CLIENT_SUPPORT
1537int
1539 int default_port = COAP_DEFAULT_PORT;
1540
1541 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close && !session->session_failed)
1542 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1543
1544 switch (session->proto) {
1545 case COAP_PROTO_UDP:
1546 default_port = COAP_DEFAULT_PORT;
1547 break;
1548 case COAP_PROTO_DTLS:
1549 default_port = COAPS_DEFAULT_PORT;
1550 break;
1551 case COAP_PROTO_TCP:
1552 default_port = COAP_DEFAULT_PORT;
1553 break;
1554 case COAP_PROTO_TLS:
1555 default_port = COAPS_DEFAULT_PORT;
1556 break;
1557 case COAP_PROTO_WS:
1558 default_port = 80;
1559 break;
1560 case COAP_PROTO_WSS:
1561 default_port = 443;
1562 break;
1563 case COAP_PROTO_NONE:
1564 case COAP_PROTO_LAST:
1565 default:
1566 assert(0);
1567 return 0;
1568 }
1569 session->sock.session = session;
1570 coap_log_debug("***%s: trying to reconnect\n", coap_session_str(session));
1571 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1572 session->state = COAP_SESSION_STATE_NONE;
1573 if (!coap_netif_dgrm_connect(session, &session->local_reconnect, &session->addr_info.remote,
1574 default_port)) {
1575 goto error;
1576 }
1578#ifdef WITH_CONTIKI
1579 session->sock.context = session->context;
1580#endif /* WITH_CONTIKI */
1581#if !COAP_DISABLE_TCP
1582 } else if (COAP_PROTO_RELIABLE(session->proto)) {
1583 if (!coap_netif_strm_connect1(session, &session->local_reconnect, &session->addr_info.remote,
1584 default_port)) {
1585 goto error;
1586 }
1587#endif /* !COAP_DISABLE_TCP */
1588 } else {
1589 goto error;
1590 }
1591#ifdef COAP_EPOLL_SUPPORT
1592 coap_epoll_ctl_add(&session->sock,
1593 EPOLLIN |
1594 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1595 EPOLLOUT : 0),
1596 __func__);
1597#endif /* COAP_EPOLL_SUPPORT */
1598
1600 session->sock.flags |= COAP_SOCKET_BOUND;
1601 coap_session_check_connect(session);
1602 return 1;
1603error:
1604 return 0;
1605}
1606
1607void
1609 coap_lg_crcv_t *lg_crcv, *etmp;
1610
1611 if (!session->session_failed)
1612 return;
1613 coap_log_debug("***%s: session re-established\n",
1614 coap_session_str(session));
1615 session->session_failed = 0;
1616 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
1618 coap_send_internal(session, lg_crcv->sent_pdu, NULL);
1619 }
1620}
1621
1624 const coap_address_t *local_if,
1625 const coap_address_t *server,
1626 coap_proto_t proto) {
1627 coap_session_t *session;
1628
1629 coap_lock_lock(return NULL);
1630 session = coap_new_client_session_lkd(ctx, local_if, server, proto);
1632 return session;
1633}
1634
1637 const coap_address_t *local_if,
1638 const coap_address_t *server,
1639 coap_proto_t proto) {
1640 coap_session_t *session;
1641
1643 session = coap_session_create_client(ctx, local_if, server,
1644 proto);
1645 if (session) {
1646 coap_log_debug("***%s: session %p: created outgoing session\n",
1647 coap_session_str(session), (void *)session);
1648 coap_session_check_connect(session);
1649 }
1650 return session;
1651}
1652
1655 const coap_address_t *local_if,
1656 const coap_address_t *server,
1657 coap_proto_t proto, const char *identity,
1658 const uint8_t *key, unsigned key_len) {
1659 coap_session_t *session;
1660
1661 coap_lock_lock(return NULL);
1662 session = coap_new_client_session_psk_lkd(ctx, local_if, server, proto, identity, key, key_len);
1664 return session;
1665}
1666
1669 const coap_address_t *local_if,
1670 const coap_address_t *server,
1671 coap_proto_t proto, const char *identity,
1672 const uint8_t *key, unsigned key_len) {
1673 coap_dtls_cpsk_t setup_data;
1674
1676 memset(&setup_data, 0, sizeof(setup_data));
1678
1679 if (identity) {
1680 setup_data.psk_info.identity.s = (const uint8_t *)identity;
1681 setup_data.psk_info.identity.length = strlen(identity);
1682 }
1683
1684 if (key && key_len > 0) {
1685 setup_data.psk_info.key.s = key;
1686 setup_data.psk_info.key.length = key_len;
1687 }
1688
1689 return coap_new_client_session_psk2_lkd(ctx, local_if, server,
1690 proto, &setup_data);
1691}
1692
1693/*
1694 * Check the validity of the SNI to send to the server.
1695 *
1696 * https://datatracker.ietf.org/doc/html/rfc6066#section-3
1697 * Literal IPv4 and IPv6 addresses are not permitted in "HostName".
1698 */
1699static void
1700coap_sanitize_client_sni(char **client_sni) {
1701 char *cp;
1702
1703 if (*client_sni == NULL)
1704 return;
1705
1706 cp = *client_sni;
1707 switch (*cp) {
1708 case '0':
1709 case '1':
1710 case '2':
1711 case '3':
1712 case '4':
1713 case '5':
1714 case '6':
1715 case '7':
1716 case '8':
1717 case '9':
1718 case 'a':
1719 case 'b':
1720 case 'c':
1721 case 'd':
1722 case 'e':
1723 case 'f':
1724 case 'A':
1725 case 'B':
1726 case 'C':
1727 case 'D':
1728 case 'E':
1729 case 'F':
1730 case ':':
1731 break;
1732 case '\000':
1733 /* Empty entry invalid */
1734 *client_sni = NULL;
1735 return;
1736 default:
1737 /* Does not start with a hex digit or : - not literal IP. */
1738 return;
1739 }
1740 /* Check for IPv4 */
1741 while (*cp) {
1742 switch (*cp) {
1743 case '0':
1744 case '1':
1745 case '2':
1746 case '3':
1747 case '4':
1748 case '5':
1749 case '6':
1750 case '7':
1751 case '8':
1752 case '9':
1753 case '.':
1754 break;
1755 default:
1756 /* Not of format nnn.nnn.nnn.nnn. Could be IPv6 */
1757 goto check_ipv6;
1758 }
1759 cp++;
1760 }
1761 /* IPv4 address - not allowed. */
1762 *client_sni = NULL;
1763 return;
1764
1765check_ipv6:
1766 /* Check for IPv6 */
1767 cp = *client_sni;
1768 while (*cp) {
1769 switch (*cp) {
1770 case '0':
1771 case '1':
1772 case '2':
1773 case '3':
1774 case '4':
1775 case '5':
1776 case '6':
1777 case '7':
1778 case '8':
1779 case '9':
1780 case 'a':
1781 case 'b':
1782 case 'c':
1783 case 'd':
1784 case 'e':
1785 case 'f':
1786 case 'A':
1787 case 'B':
1788 case 'C':
1789 case 'D':
1790 case 'E':
1791 case 'F':
1792 case ':':
1793 break;
1794 case '%':
1795 /* Start of i/f specification, Previous is IPv6 */
1796 *client_sni = NULL;
1797 return;
1798 default:
1799 /* Not of format xx:xx::xx. */
1800 return;
1801 }
1802 cp++;
1803 }
1804 *client_sni = NULL;
1805 return;
1806}
1807
1810 const coap_address_t *local_if,
1811 const coap_address_t *server,
1812 coap_proto_t proto,
1813 coap_dtls_cpsk_t *setup_data) {
1814 coap_session_t *session;
1815
1816 coap_lock_lock(return NULL);
1817 session = coap_new_client_session_psk2_lkd(ctx, local_if, server, proto, setup_data);
1819 return session;
1820}
1821
1824 const coap_address_t *local_if,
1825 const coap_address_t *server,
1826 coap_proto_t proto,
1827 coap_dtls_cpsk_t *setup_data) {
1828 coap_session_t *session;
1829
1831 session = coap_session_create_client(ctx, local_if, server, proto);
1832
1833 if (!session || !setup_data)
1834 return NULL;
1835
1836 session->cpsk_setup_data = *setup_data;
1837 if (setup_data->psk_info.identity.s) {
1838 session->psk_identity =
1840 setup_data->psk_info.identity.length);
1841 if (!session->psk_identity) {
1842 coap_log_warn("Cannot store session Identity (PSK)\n");
1843 coap_session_release_lkd(session);
1844 return NULL;
1845 }
1847 coap_log_warn("Identity (PSK) not defined\n");
1848 coap_session_release_lkd(session);
1849 return NULL;
1850 }
1851
1852 if (setup_data->psk_info.key.s && setup_data->psk_info.key.length > 0) {
1853 session->psk_key = coap_new_bin_const(setup_data->psk_info.key.s,
1854 setup_data->psk_info.key.length);
1855 if (!session->psk_key) {
1856 coap_log_warn("Cannot store session pre-shared key (PSK)\n");
1857 coap_session_release_lkd(session);
1858 return NULL;
1859 }
1861 coap_log_warn("Pre-shared key (PSK) not defined\n");
1862 coap_session_release_lkd(session);
1863 return NULL;
1864 }
1865
1866 coap_sanitize_client_sni(&session->cpsk_setup_data.client_sni);
1867
1869 if (!coap_dtls_context_set_cpsk(ctx, &session->cpsk_setup_data)) {
1870 coap_session_release_lkd(session);
1871 return NULL;
1872 }
1873 }
1874 coap_log_debug("***%s: new outgoing session\n",
1875 coap_session_str(session));
1876 coap_session_check_connect(session);
1877 return session;
1878}
1879#endif /* COAP_CLIENT_SUPPORT */
1880
1881int
1883 const coap_bin_const_t *psk_hint
1884 ) {
1885 /* We may be refreshing the hint with the same hint */
1886 coap_bin_const_t *old_psk_hint = session->psk_hint;
1887
1888 if (psk_hint && psk_hint->s) {
1889 if (session->psk_hint) {
1890 if (coap_binary_equal(session->psk_hint, psk_hint))
1891 return 1;
1892 }
1893 session->psk_hint = coap_new_bin_const(psk_hint->s,
1894 psk_hint->length);
1895 if (!session->psk_hint) {
1896 coap_log_err("No memory to store identity hint (PSK)\n");
1897 if (old_psk_hint)
1898 coap_delete_bin_const(old_psk_hint);
1899 return 0;
1900 }
1901 } else {
1902 session->psk_hint = NULL;
1903 }
1904 if (old_psk_hint)
1905 coap_delete_bin_const(old_psk_hint);
1906
1907 return 1;
1908}
1909
1910int
1912 const coap_bin_const_t *psk_key
1913 ) {
1914 /* We may be refreshing the key with the same key */
1915 coap_bin_const_t *old_psk_key = session->psk_key;
1916
1917 if (psk_key && psk_key->s) {
1918 if (session->psk_key) {
1919 if (coap_binary_equal(session->psk_key, psk_key))
1920 return 1;
1921 }
1922 session->psk_key = coap_new_bin_const(psk_key->s, psk_key->length);
1923 if (!session->psk_key) {
1924 coap_log_err("No memory to store pre-shared key (PSK)\n");
1925 if (old_psk_key)
1926 coap_delete_bin_const(old_psk_key);
1927 return 0;
1928 }
1929 } else {
1930 session->psk_key = NULL;
1931 }
1932 if (old_psk_key)
1933 coap_delete_bin_const(old_psk_key);
1934
1935 return 1;
1936}
1937
1938int
1940 const coap_bin_const_t *psk_identity
1941 ) {
1942 /* We may be refreshing the identity with the same identity */
1943 coap_bin_const_t *old_psk_identity = session->psk_identity;
1944
1945 if (psk_identity && psk_identity->s) {
1946 if (session->psk_identity) {
1947 if (coap_binary_equal(session->psk_identity, psk_identity))
1948 return 1;
1949 }
1950 session->psk_identity = coap_new_bin_const(psk_identity->s,
1951 psk_identity->length);
1952 if (!session->psk_identity) {
1953 coap_log_err("No memory to store pre-shared key identity (PSK)\n");
1954 if (old_psk_identity)
1955 coap_delete_bin_const(old_psk_identity);
1956 return 0;
1957 }
1958 } else {
1959 session->psk_identity = NULL;
1960 }
1961 if (old_psk_identity)
1962 coap_delete_bin_const(old_psk_identity);
1963
1964 return 1;
1965}
1966
1967#if COAP_SERVER_SUPPORT
1968const coap_bin_const_t *
1970 if (session)
1971 return session->psk_hint;
1972 return NULL;
1973}
1974#endif /* COAP_SERVER_SUPPORT */
1975
1976const coap_bin_const_t *
1978 const coap_bin_const_t *psk_identity = NULL;
1979 if (session) {
1980 psk_identity = session->psk_identity;
1981 if (psk_identity == NULL) {
1982 psk_identity = &session->cpsk_setup_data.psk_info.identity;
1983 }
1984 }
1985 return psk_identity;
1986}
1987
1988const coap_bin_const_t *
1990 if (session)
1991 return session->psk_key;
1992 return NULL;
1993}
1994
1995#if COAP_CLIENT_SUPPORT
1998 const coap_address_t *local_if,
1999 const coap_address_t *server,
2000 coap_proto_t proto,
2001 coap_dtls_pki_t *setup_data) {
2002 coap_session_t *session;
2003
2004 coap_lock_lock(return NULL);
2005 session = coap_new_client_session_pki_lkd(ctx, local_if, server, proto, setup_data);
2007 return session;
2008}
2009
2012 const coap_address_t *local_if,
2013 const coap_address_t *server,
2014 coap_proto_t proto,
2015 coap_dtls_pki_t *setup_data) {
2016 coap_session_t *session;
2017 coap_dtls_pki_t l_setup_data;
2018
2019 if (!setup_data)
2020 return NULL;
2021 if (setup_data->version != COAP_DTLS_PKI_SETUP_VERSION) {
2022 coap_log_err("coap_new_client_session_pki: Wrong version of setup_data\n");
2023 return NULL;
2024 }
2025
2027 l_setup_data = *setup_data;
2028 coap_sanitize_client_sni(&l_setup_data.client_sni);
2029
2030 session = coap_session_create_client(ctx, local_if, server, proto);
2031
2032 if (!session) {
2033 return NULL;
2034 }
2035
2037 /* we know that setup_data is not NULL */
2038 if (!coap_dtls_context_set_pki(ctx, &l_setup_data, COAP_DTLS_ROLE_CLIENT)) {
2039 coap_session_release_lkd(session);
2040 return NULL;
2041 }
2042 }
2043 coap_log_debug("***%s: new outgoing session\n",
2044 coap_session_str(session));
2045 coap_session_check_connect(session);
2046 return session;
2047}
2048#endif /* ! COAP_CLIENT_SUPPORT */
2049
2050#if COAP_SERVER_SUPPORT
2051#if !COAP_DISABLE_TCP
2054 coap_session_t *session;
2055 coap_tick_t now;
2056
2058 NULL, NULL, NULL, 0, ctx, ep);
2059 if (!session)
2060 goto error;
2061
2062 memcpy(session->sock.lfunc, ep->sock.lfunc, sizeof(session->sock.lfunc));
2063 if (!coap_netif_strm_accept(ep, session, extra))
2064 goto error;
2065
2066 coap_make_addr_hash(&session->addr_hash, session->proto, &session->addr_info);
2067
2068#ifdef COAP_EPOLL_SUPPORT
2069 session->sock.session = session;
2070 coap_epoll_ctl_add(&session->sock,
2071 EPOLLIN,
2072 __func__);
2073#endif /* COAP_EPOLL_SUPPORT */
2074 SESSIONS_ADD(ep->sessions, session);
2075 if (session) {
2076 coap_ticks(&now);
2077 session->last_rx_tx = now;
2078 coap_log_debug("***%s: session %p: new incoming session\n",
2079 coap_session_str(session), (void *)session);
2083 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
2084 }
2085 return session;
2086
2087error:
2088 /*
2089 * Need to add in the session as coap_session_release_lkd()
2090 * will call SESSIONS_DELETE in coap_session_free().
2091 */
2092 if (session) {
2093 SESSIONS_ADD(ep->sessions, session);
2094 coap_session_free(session);
2095 }
2096 return NULL;
2097}
2098#endif /* !COAP_DISABLE_TCP */
2099#endif /* COAP_SERVER_SUPPORT */
2100
2101void
2103 const uint8_t *data) {
2104 session->tx_token = coap_decode_var_bytes8(data, len);
2105 /*
2106 * Decrement as when first used by coap_session_new_token() it will
2107 * get incremented
2108 */
2109 session->tx_token--;
2110}
2111
2112void
2114 uint8_t *data) {
2115 *len = coap_encode_var_safe8(data,
2116 sizeof(session->tx_token), ++session->tx_token);
2117}
2118
2119COAP_API uint16_t
2121 uint16_t mid;
2122
2123 coap_lock_lock(return 0);
2124 mid = coap_new_message_id_lkd(session);
2126 return mid;
2127}
2128
2129uint16_t
2132 if (COAP_PROTO_NOT_RELIABLE(session->proto))
2133 return ++session->tx_mid;
2134 /* TCP/TLS have no notion of mid */
2135 return 0;
2136}
2137
2138const coap_address_t *
2140 if (session)
2141 return &session->addr_info.remote;
2142 return NULL;
2143}
2144
2145const coap_address_t *
2147 if (session)
2148 return &session->addr_info.local;
2149 return NULL;
2150}
2151
2152const coap_address_t *
2154#if COAP_CLIENT_SUPPORT
2155 if (session && session->type == COAP_SESSION_TYPE_CLIENT &&
2156 session->sock.flags & COAP_SOCKET_MULTICAST)
2157 return &session->sock.mcast_addr;
2158#else /* ! COAP_CLIENT_SUPPORT */
2159 (void)session;
2160#endif /* ! COAP_CLIENT_SUPPORT */
2161 return NULL;
2162}
2163
2166 if (session)
2167 return session->context;
2168 return NULL;
2169}
2170
2173 if (session)
2174 return session->proto;
2175 return 0;
2176}
2177
2180 if (session)
2181 return session->type;
2182 return 0;
2183}
2184
2185COAP_API int
2187 int ret;
2188
2189 coap_lock_lock(return 0);
2190 ret = coap_session_set_type_client_lkd(session);
2192 return ret;
2193}
2194
2195int
2197#if COAP_SERVER_SUPPORT
2198 if (session && session->type == COAP_SESSION_TYPE_SERVER) {
2200 session->type = COAP_SESSION_TYPE_CLIENT;
2201 return 1;
2202 }
2203#else /* ! COAP_SERVER_SUPPORT */
2204 (void)session;
2205#endif /* ! COAP_SERVER_SUPPORT */
2206 return 0;
2207}
2208
2211 if (session)
2212 return session->state;
2213 return 0;
2214}
2215
2218#if COAP_SERVER_SUPPORT
2219 if (session)
2220 return session->endpoint;
2221#else /* ! COAP_SERVER_SUPPORT */
2222 (void)session;
2223#endif /* ! COAP_SERVER_SUPPORT */
2224 return 0;
2225}
2226
2227int
2229 if (session)
2230 return session->ifindex;
2231 return -1;
2232}
2233
2234void *
2236 coap_tls_library_t *tls_lib) {
2237 if (session)
2238 return coap_dtls_get_tls(session, tls_lib);
2239 return NULL;
2240}
2241
2242static const char *
2244 switch (proto) {
2245 case COAP_PROTO_UDP:
2246 return "UDP ";
2247 case COAP_PROTO_DTLS:
2248 return "DTLS";
2249 case COAP_PROTO_TCP:
2250 return "TCP ";
2251 case COAP_PROTO_TLS:
2252 return "TLS ";
2253 case COAP_PROTO_WS:
2254 return "WS ";
2255 case COAP_PROTO_WSS:
2256 return "WSS ";
2257 case COAP_PROTO_NONE:
2258 case COAP_PROTO_LAST:
2259 default:
2260 return "????" ;
2261 break;
2262 }
2263 return NULL;
2264}
2265
2266#if COAP_SERVER_SUPPORT
2268coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto) {
2269 coap_endpoint_t *endpoint;
2270
2271 coap_lock_lock(return NULL);
2272 endpoint = coap_new_endpoint_lkd(context, listen_addr, proto);
2274 return endpoint;
2275}
2276
2278coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr,
2279 coap_proto_t proto) {
2280 coap_endpoint_t *ep = NULL;
2281
2282 if (!context || !listen_addr) {
2283 coap_log_debug("coap_new_endpoint: Both context and listen_addr need to be defined\n");
2284 return NULL;
2285 }
2286
2288
2289 switch (proto) {
2290 case COAP_PROTO_UDP:
2291 break;
2292 case COAP_PROTO_DTLS:
2293 if (!coap_dtls_is_supported()) {
2294 coap_log_warn("coap_new_endpoint: DTLS not supported\n");
2295 return NULL;
2296 }
2297 break;
2298 case COAP_PROTO_TLS:
2299 if (!coap_tls_is_supported()) {
2300 coap_log_warn("coap_new_endpoint: TLS not supported\n");
2301 return NULL;
2302 }
2303 break;
2304 case COAP_PROTO_TCP:
2305 if (!coap_tcp_is_supported()) {
2306 coap_log_warn("coap_new_endpoint: TCP not supported\n");
2307 return NULL;
2308 }
2309 break;
2310 case COAP_PROTO_WS:
2311 if (!coap_ws_is_supported()) {
2312 coap_log_warn("coap_new_endpoint: WS not supported\n");
2313 return NULL;
2314 }
2315 break;
2316 case COAP_PROTO_WSS:
2317 if (!coap_wss_is_supported()) {
2318 coap_log_warn("coap_new_endpoint: WSS not supported\n");
2319 return NULL;
2320 }
2321 break;
2322 case COAP_PROTO_NONE:
2323 case COAP_PROTO_LAST:
2324 default:
2325 coap_log_crit("coap_new_endpoint: Unsupported protocol %d\n", proto);
2326 return NULL;
2327 }
2328
2329 if (proto == COAP_PROTO_DTLS || proto == COAP_PROTO_TLS ||
2330 proto == COAP_PROTO_WSS) {
2332 coap_log_info("coap_new_endpoint: one of coap_context_set_psk() or "
2333 "coap_context_set_pki() not called\n");
2334 return NULL;
2335 }
2336 }
2337 ep = coap_malloc_endpoint();
2338 if (!ep) {
2339 coap_log_warn("coap_new_endpoint: malloc");
2340 return NULL;
2341 }
2342
2343 memset(ep, 0, sizeof(coap_endpoint_t));
2344 ep->context = context;
2345 ep->proto = proto;
2346 ep->sock.endpoint = ep;
2347 memcpy(&ep->sock.lfunc, coap_layers_coap[proto], sizeof(ep->sock.lfunc));
2348
2349 if (COAP_PROTO_NOT_RELIABLE(proto)) {
2350 if (!coap_netif_dgrm_listen(ep, listen_addr))
2351 goto error;
2352#ifdef WITH_CONTIKI
2353 ep->sock.context = context;
2354#endif /* WITH_CONTIKI */
2355#if !COAP_DISABLE_TCP
2356 } else if (COAP_PROTO_RELIABLE(proto)) {
2357 if (!coap_netif_strm_listen(ep, listen_addr))
2358 goto error;
2359#endif /* !COAP_DISABLE_TCP */
2360 } else {
2361 coap_log_crit("coap_new_endpoint: Protocol type not supported %d\n", proto);
2362 goto error;
2363 }
2364
2366#ifndef INET6_ADDRSTRLEN
2367#define INET6_ADDRSTRLEN 40
2368#endif
2369 unsigned char addr_str[INET6_ADDRSTRLEN + 8];
2370
2371 if (coap_print_addr(&ep->bind_addr, addr_str, INET6_ADDRSTRLEN + 8)) {
2372 coap_log_debug("created %s endpoint %s\n", coap_proto_name(ep->proto),
2373 addr_str);
2374 }
2375 }
2376
2378
2379#ifdef COAP_EPOLL_SUPPORT
2380 ep->sock.endpoint = ep;
2382 EPOLLIN,
2383 __func__);
2384#endif /* COAP_EPOLL_SUPPORT */
2385
2386 LL_PREPEND(context->endpoint, ep);
2387 return ep;
2388
2389error:
2391 return NULL;
2392}
2393
2394void
2396 ep->default_mtu = (uint16_t)mtu;
2397}
2398
2399COAP_API void
2401 if (ep) {
2402 coap_context_t *context = ep->context;
2403 if (context) {
2404 coap_lock_lock(return);
2405 }
2407 if (context) {
2409 }
2410 }
2411}
2412
2413void
2415 if (ep) {
2416 coap_session_t *session, *rtmp;
2417
2418 if (ep->context) {
2419 /* If fully allocated and inserted */
2421 SESSIONS_ITER_SAFE(ep->sessions, session, rtmp) {
2422 assert(session->ref == 0);
2423 if (session->ref == 0) {
2425 coap_session_free(session);
2426 }
2427 }
2428 if (coap_netif_available_ep(ep)) {
2429 /*
2430 * ep->sock.endpoint is set in coap_new_endpoint().
2431 * ep->sock.session is never set.
2432 *
2433 * session->sock.session is set for both clients and servers (when a
2434 * new session is accepted), but does not affect the endpoint.
2435 *
2436 * So, it is safe to call coap_netif_close_ep() after all the sessions
2437 * have been freed above as we are only working with the endpoint sock.
2438 */
2439#ifdef COAP_EPOLL_SUPPORT
2440 assert(ep->sock.session == NULL);
2441#endif /* COAP_EPOLL_SUPPORT */
2443 }
2444
2445 if (ep->context->endpoint) {
2446 LL_DELETE(ep->context->endpoint, ep);
2447 }
2448 }
2449
2450 if (ep->app_cb) {
2451 ep->app_cb(ep->app_data);
2452 }
2453
2455 }
2456}
2457
2458void *
2460 assert(endpoint);
2461 return endpoint->app_data;
2462}
2463
2464COAP_API void *
2465coap_endpoint_set_app_data(coap_endpoint_t *endpoint, void *app_data,
2467 void *old_data;
2468
2469 coap_lock_lock(return NULL);
2470 old_data = coap_endpoint_set_app_data_lkd(endpoint, app_data, callback);
2472 return old_data;
2473}
2474
2475void *
2476coap_endpoint_set_app_data_lkd(coap_endpoint_t *endpoint, void *app_data,
2478 void *old_data = endpoint->app_data;
2479
2480 endpoint->app_data = app_data;
2481 endpoint->app_cb = app_data ? callback : NULL;
2482 return old_data;
2483}
2484
2485#endif /* COAP_SERVER_SUPPORT */
2486
2489 const coap_address_t *remote_addr,
2490 int ifindex) {
2491 coap_session_t *s, *rtmp;
2492#if COAP_CLIENT_SUPPORT
2493 SESSIONS_ITER(ctx->sessions, s, rtmp) {
2494 if (s->ifindex == ifindex) {
2495 if (s->sock.flags & COAP_SOCKET_MULTICAST) {
2496 if (coap_address_equals(&s->sock.mcast_addr, remote_addr))
2497 return s;
2498 } else if (coap_address_equals(&s->addr_info.remote, remote_addr))
2499 return s;
2500 }
2501 }
2502#endif /* COAP_CLIENT_SUPPORT */
2503#if COAP_SERVER_SUPPORT
2504 coap_endpoint_t *ep;
2505
2506 LL_FOREACH(ctx->endpoint, ep) {
2507 SESSIONS_ITER(ep->sessions, s, rtmp) {
2508 if (s->ifindex == ifindex && coap_address_equals(&s->addr_info.remote,
2509 remote_addr))
2510 return s;
2511 }
2512 }
2513#endif /* COAP_SERVER_SUPPORT */
2514 return NULL;
2515}
2516
2517#ifndef INET6_ADDRSTRLEN
2518#define INET6_ADDRSTRLEN 46
2519#endif
2520const char *
2522 static char szSession[2 * (INET6_ADDRSTRLEN + 8) + 24];
2523 char *p = szSession, *end = szSession + sizeof(szSession);
2524 if (coap_print_addr(&session->addr_info.local,
2525 (unsigned char *)p, end - p) > 0)
2526 p += strlen(p);
2527 if (p + 6 < end) {
2528 strcpy(p, " <-> ");
2529 p += 5;
2530 }
2531 if (p + 1 < end) {
2532 if (coap_print_addr(&session->addr_info.remote,
2533 (unsigned char *)p, end - p) > 0)
2534 p += strlen(p);
2535 }
2536 if (session->ifindex > 0 && p + 1 < end)
2537 p += snprintf(p, end - p, " (if%d)", session->ifindex);
2538 if (p + 6 < end) {
2539 strcpy(p, " ");
2540 p++;
2541 strcpy(p, coap_proto_name(session->proto));
2542 }
2543
2544 return szSession;
2545}
2546
2547#if COAP_SERVER_SUPPORT
2548const char *
2549coap_endpoint_str(const coap_endpoint_t *endpoint) {
2550 static char szEndpoint[128];
2551 char *p = szEndpoint, *end = szEndpoint + sizeof(szEndpoint);
2552 if (coap_print_addr(&endpoint->bind_addr, (unsigned char *)p, end - p) > 0)
2553 p += strlen(p);
2554 if (p + 6 < end) {
2555 if (endpoint->proto == COAP_PROTO_UDP) {
2556 strcpy(p, " UDP");
2557 } else if (endpoint->proto == COAP_PROTO_DTLS) {
2558 strcpy(p, " DTLS");
2559 } else {
2560 strcpy(p, " NONE");
2561 }
2562 }
2563
2564 return szEndpoint;
2565}
2566#endif /* COAP_SERVER_SUPPORT */
2567#if COAP_CLIENT_SUPPORT
2568void
2570 session->no_observe_cancel = 1;
2571}
2572#endif /* COAP_CLIENT_SUPPORT */
2573#endif /* COAP_SESSION_C_ */
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.
uint16_t coap_address_get_port(const coap_address_t *addr)
Returns the port from addr in host byte order.
void coap_address_copy(coap_address_t *dst, const coap_address_t *src)
int coap_address_equals(const coap_address_t *a, const coap_address_t *b)
Compares given address objects a and b.
#define PRIu32
coap_nack_reason_t
Definition coap_io.h:62
@ COAP_NACK_NOT_DELIVERABLE
Definition coap_io.h:64
@ COAP_NACK_WS_FAILED
Definition coap_io.h:71
@ COAP_NACK_TOO_MANY_RETRIES
Definition coap_io.h:63
@ COAP_NACK_TLS_FAILED
Definition coap_io.h:66
@ COAP_NACK_TLS_LAYER_FAILED
Definition coap_io.h:69
@ COAP_NACK_ICMP_ISSUE
Definition coap_io.h:67
@ COAP_NACK_WS_LAYER_FAILED
Definition coap_io.h:70
@ 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
void coap_epoll_ctl_add(coap_socket_t *sock, uint32_t events, const char *func)
Epoll specific function to add the state of events that epoll is to track for the appropriate file de...
#define COAP_SOCKET_NOT_EMPTY
the socket is not empty
#define COAP_SOCKET_BOUND
the socket is bound
#define COAP_SOCKET_WANT_READ
non blocking socket is waiting for reading
coap_endpoint_t * coap_malloc_endpoint(void)
#define COAP_SOCKET_WANT_CONNECT
non blocking client socket is waiting for connect
void coap_mfree_endpoint(coap_endpoint_t *ep)
coap_layer_func_t coap_layers_coap[COAP_PROTO_LAST][COAP_LAYER_LAST]
Definition coap_layers.c:39
@ COAP_LAYER_SESSION
Library specific build wrapper for coap_internal.h.
#define COAP_API
@ COAP_SESSION
Definition coap_mem.h:51
@ 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().
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
void * coap_dtls_get_tls(const coap_session_t *c_session COAP_UNUSED, coap_tls_library_t *tls_lib)
Definition coap_notls.c:158
unsigned int coap_dtls_get_overhead(coap_session_t *session COAP_UNUSED)
Definition coap_notls.c:261
int coap_dtls_context_check_keys_enabled(coap_context_t *ctx COAP_UNUSED)
Definition coap_notls.c:147
static const char * coap_proto_name(coap_proto_t proto)
COAP_API coap_mid_t coap_session_send_ping(coap_session_t *session)
Send a ping message for the session.
static const char * coap_nack_name(coap_nack_reason_t reason)
static coap_session_t * coap_make_session(coap_proto_t proto, coap_session_type_t type, const coap_addr_hash_t *addr_hash, const coap_address_t *local_addr, const coap_address_t *remote_addr, int ifindex, coap_context_t *context, coap_endpoint_t *endpoint)
static size_t coap_session_max_pdu_size_internal(const coap_session_t *session, size_t max_with_header)
#define INET6_ADDRSTRLEN
void coap_session_set_no_observe_cancel(coap_session_t *session)
Disable client automatically sending observe cancel on session close.
#define SESSIONS_ADD(e, obj)
#define SESSIONS_ITER_SAFE(e, el, rtmp)
#define COAP_PARTIAL_SESSION_TIMEOUT_TICKS
#define SESSIONS_DELETE(e, obj)
#define COAP_DEFAULT_MAX_HANDSHAKE_SESSIONS
#define SESSIONS_ITER(e, el, rtmp)
#define SESSIONS_FIND(e, k, res)
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)
void coap_check_update_token(coap_session_t *session, coap_pdu_t *pdu)
The function checks if the token needs to be updated before PDU is presented to the application (only...
void coap_block_delete_lg_xmit(coap_session_t *session, coap_lg_xmit_t *lg_xmit)
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...
#define COAP_DEFAULT_NON_MAX_RETRANSMIT
The number of times for requests for re-transmission of missing Q-Block1 when no response has been re...
uint16_t coap_session_get_non_max_retransmit(const coap_session_t *session)
Get the CoAP NON maximum retransmit count of missing Q-Block1 or Q-Block2 requested before there is a...
coap_fixed_point_t coap_session_get_default_leisure(const coap_session_t *session)
Get the CoAP default leisure time RFC7252 DEFAULT_LEISURE.
void coap_session_set_max_retransmit(coap_session_t *session, uint16_t value)
Set the CoAP maximum retransmit count before failure.
#define COAP_DEFAULT_NON_TIMEOUT
The delay (+ ACK_RANDOM_FACTOR) to introduce once NON MAX_PAYLOADS Q-Block1 or Q-Block2 have been sen...
coap_fixed_point_t coap_session_get_non_timeout(const coap_session_t *session)
Get the CoAP MAX_PAYLOADS limit delay timeout.
void coap_session_set_ack_random_factor(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP ack randomize factor.
#define COAP_DEFAULT_MAX_LATENCY
The MAX_LATENCY definition.
coap_fixed_point_t coap_session_get_ack_random_factor(const coap_session_t *session)
Get the CoAP ack randomize factor.
#define COAP_DEFAULT_ACK_RANDOM_FACTOR
A factor that is used to randomize the wait time before a message is retransmitted to prevent synchro...
uint16_t coap_session_get_max_retransmit(const coap_session_t *session)
Get the CoAP maximum retransmit before failure.
void coap_session_set_max_payloads(coap_session_t *session, uint16_t value)
Set the CoAP maximum payloads count of Q-Block1 or Q-Block2 before delay is introduced RFC9177 MAX_PA...
#define COAP_DEFAULT_MAX_RETRANSMIT
Number of message retransmissions before message sending is stopped.
uint32_t coap_session_get_probing_rate(const coap_session_t *session)
Get the CoAP probing rate when there is no response RFC7252 PROBING_RATE.
#define COAP_DEFAULT_ACK_TIMEOUT
Number of seconds when to expect an ACK or a response to an outstanding CON message.
#define COAP_DEFAULT_DEFAULT_LEISURE
The number of seconds to use as bounds for multicast traffic RFC 7252, Section 4.8 Default value of D...
void coap_session_set_ack_timeout(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP initial ack response timeout before the next re-transmit.
#define COAP_DEFAULT_NSTART
The number of simultaneous outstanding interactions that a client maintains to a given server.
void coap_session_set_non_receive_timeout(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP non receive timeout delay timeout.
void coap_session_set_nstart(coap_session_t *session, uint16_t value)
Set the CoAP maximum concurrent transmission count of Confirmable messages RFC7252 NSTART.
#define COAP_DEFAULT_PROBING_RATE
The number of bytes/second allowed when there is no response RFC 7252, Section 4.8 Default value of P...
void coap_session_set_non_max_retransmit(coap_session_t *session, uint16_t value)
Set the CoAP NON maximum retransmit count of missing Q-Block1 or Q-Block2 requested before there is a...
uint16_t coap_session_get_max_payloads(const coap_session_t *session)
Get the CoAP maximum payloads count of Q-Block1 or Q-Block2 before delay is introduced RFC9177 MAX_PA...
#define COAP_DEFAULT_NON_RECEIVE_TIMEOUT
The time to wait for any missing Q-Block1 or Q-Block2 packets before requesting re-transmission of mi...
void coap_session_set_probing_rate(coap_session_t *session, uint32_t value)
Set the CoAP probing rate when there is no response RFC7252 PROBING_RATE.
void coap_session_set_default_leisure(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP default leisure time (for multicast) RFC7252 DEFAULT_LEISURE.
coap_fixed_point_t coap_session_get_non_receive_timeout(const coap_session_t *session)
Get the CoAP non receive timeout delay timeout.
uint16_t coap_session_get_nstart(const coap_session_t *session)
Get the CoAP maximum concurrent transmission count of Confirmable messages RFC7252 NSTART.
#define COAP_DEFAULT_MAX_PAYLOADS
Number of Q-Block1 or Q-Block2 payloads that can be sent in a burst before a delay has to kick in.
coap_fixed_point_t coap_session_get_ack_timeout(const coap_session_t *session)
Get the CoAP initial ack response timeout before the next re-transmit.
void coap_session_set_non_timeout(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP non timeout delay timeout.
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
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
#define RESOURCES_ITER(r, tmp)
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:4864
uint16_t coap_new_message_id_lkd(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
int coap_delete_node_lkd(coap_queue_t *node)
Destroys specified node.
Definition coap_net.c:227
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:2911
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:1338
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:1222
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:1823
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition coap_net.c:1248
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:3015
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:3054
void coap_ticks(coap_tick_t *)
Returns the current value of an internal tick counter.
COAP_API uint16_t coap_new_message_id(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
@ COAP_RESPONSE_OK
Response is fine.
Definition coap_net.h:50
void coap_dtls_establish(coap_session_t *session)
Layer function interface for layer below DTLS connect being established.
Definition coap_dtls.c:266
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_context_set_cpsk(coap_context_t *coap_context, coap_dtls_cpsk_t *setup_data)
Set the DTLS context's default client PSK information.
#define COAP_DTLS_PKI_SETUP_VERSION
Latest PKI setup version.
Definition coap_dtls.h:307
#define COAP_DTLS_CPSK_SETUP_VERSION
Latest CPSK setup version.
Definition coap_dtls.h:405
coap_tls_library_t
Definition coap_dtls.h:70
@ COAP_DTLS_ROLE_CLIENT
Internal function invoked for client.
Definition coap_dtls.h:45
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
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_SESSION_CONNECTED
Triggered when TCP layer completes exchange of CSM information.
Definition coap_event.h:61
@ COAP_EVENT_TCP_FAILED
Triggered when TCP layer fails for some reason.
Definition coap_event.h:55
@ COAP_EVENT_SESSION_FAILED
Triggered when TCP layer fails following exchange of CSM information.
Definition coap_event.h:65
@ 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_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_TCP_CLOSED
Triggered when TCP layer is closed.
Definition coap_event.h:53
@ COAP_EVENT_TCP_CONNECTED
Triggered when TCP layer connects.
Definition coap_event.h:51
@ COAP_EVENT_KEEPALIVE_FAILURE
Triggered when no response to a keep alive (ping) packet.
Definition coap_event.h:132
#define coap_lock_callback(func)
Dummy for no thread-safe code.
#define coap_lock_unlock()
Dummy for no thread-safe code.
#define coap_lock_check_locked()
Dummy for no thread-safe code.
#define coap_lock_lock(failed)
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
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
#define coap_log_crit(...)
Definition coap_debug.h:90
@ COAP_LOG_DEBUG
Definition coap_debug.h:58
int coap_netif_dgrm_listen(coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
Layer function interface for Netif datagram listem (udp).
void coap_netif_close_ep(coap_endpoint_t *endpoint)
Layer function interface for Netif close for a endpoint.
int coap_netif_strm_connect1(coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
Layer function interface for Netif stream connect (tcp).
int coap_netif_strm_accept(coap_endpoint_t *endpoint, coap_session_t *session, void *extra)
Layer function interface for Netif stream accept.
int coap_netif_strm_listen(coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
Layer function interface for Netif stream listem (tcp).
int coap_netif_dgrm_connect(coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
Layer function interface for Netif datagram connect (udp).
int coap_netif_available(coap_session_t *session)
Function interface to check whether netif for session is still available.
Definition coap_netif.c:25
int coap_netif_available_ep(coap_endpoint_t *endpoint)
Function interface to check whether netif for endpoint is still available.
void coap_delete_oscore_associations(coap_session_t *session)
Cleanup all allocated OSCORE association information.
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:1651
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
Definition coap_pdu.c:190
int coap_update_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Updates token in pdu with length len and data.
Definition coap_pdu.c:413
#define COAP_PDU_MAX_UDP_HEADER_SIZE
#define COAP_PDU_DELAYED
#define COAP_PDU_MAX_TCP_HEADER_SIZE
#define COAP_MAX_MESSAGE_SIZE_TCP8
#define COAP_MAX_MESSAGE_SIZE_TCP0
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:1513
#define COAP_MAX_MESSAGE_SIZE_TCP16
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:779
#define COAP_DEFAULT_PORT
Definition coap_pdu.h:37
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition coap_pdu.h:264
#define COAP_TOKEN_DEFAULT_MAX
Definition coap_pdu.h:56
#define COAP_SIGNALING_OPTION_EXTENDED_TOKEN_LENGTH
Definition coap_pdu.h:200
coap_proto_t
CoAP protocol types.
Definition coap_pdu.h:313
#define COAP_SIGNALING_OPTION_BLOCK_WISE_TRANSFER
Definition coap_pdu.h:199
#define COAPS_DEFAULT_PORT
Definition coap_pdu.h:38
coap_pdu_t * coap_pdu_init(coap_pdu_type_t type, coap_pdu_code_t code, coap_mid_t mid, size_t size)
Creates a new CoAP PDU with at least enough storage space for the given size maximum message size.
Definition coap_pdu.c:99
#define COAP_INVALID_MID
Indicates an invalid message id.
Definition coap_pdu.h:267
#define COAP_DEFAULT_MTU
Definition coap_pdu.h:41
#define COAP_BERT_BASE
Definition coap_pdu.h:44
#define COAP_SIGNALING_OPTION_MAX_MESSAGE_SIZE
Definition coap_pdu.h:198
@ COAP_PROTO_WS
Definition coap_pdu.h:319
@ COAP_PROTO_DTLS
Definition coap_pdu.h:316
@ COAP_PROTO_UDP
Definition coap_pdu.h:315
@ COAP_PROTO_NONE
Definition coap_pdu.h:314
@ COAP_PROTO_TLS
Definition coap_pdu.h:318
@ COAP_PROTO_WSS
Definition coap_pdu.h:320
@ COAP_PROTO_TCP
Definition coap_pdu.h:317
@ COAP_PROTO_LAST
Definition coap_pdu.h:321
@ COAP_SIGNALING_CODE_CSM
Definition coap_pdu.h:366
@ COAP_SIGNALING_CODE_PING
Definition coap_pdu.h:367
@ COAP_MESSAGE_NON
Definition coap_pdu.h:70
@ COAP_MESSAGE_CON
Definition coap_pdu.h:69
#define COAP_NON_PROBING_WAIT_BASE(s)
void coap_session_reestablished(coap_session_t *session)
Session has been re-connected to server.
ssize_t coap_session_delay_pdu(coap_session_t *session, coap_pdu_t *pdu, coap_queue_t *node)
int coap_session_refresh_psk_hint(coap_session_t *session, const coap_bin_const_t *psk_hint)
Refresh the session's current Identity Hint (PSK).
void coap_session_send_csm(coap_session_t *session)
Notify session transport has just connected and CSM exchange can now start.
coap_session_t * coap_new_client_session_psk2_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_cpsk_t *setup_data)
Creates a new client session to the designated server with PSK credentials.
coap_fixed_point_t coap_add_fixed_uint(coap_fixed_point_t fp1, uint32_t u2)
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_fixed_point_t coap_sub_fixed_uint(coap_fixed_point_t fp1, uint32_t u2)
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.
#define COAP_ACK_RANDOM_FACTOR(s)
void coap_free_endpoint_lkd(coap_endpoint_t *endpoint)
Release an endpoint and all the structures associated with it.
coap_session_t * coap_new_client_session_psk_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, const char *identity, const uint8_t *key, unsigned key_len)
Creates a new client session to the designated server with PSK credentials.
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.
void * coap_endpoint_set_app_data_lkd(coap_endpoint_t *endpoint, void *data, coap_app_data_free_callback_t callback)
Stores data with the given endpoint, returning the previously stored value or NULL.
void coap_session_establish(coap_session_t *session)
Layer function interface for layer below session accept/connect being established.
coap_session_t * coap_new_client_session_pki_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_pki_t *setup_data)
Creates a new client session to the designated server with PKI credentials.
coap_session_t * coap_new_client_session_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto)
Creates a new client session to the designated server.
coap_fixed_point_t coap_add_fixed_fixed(coap_fixed_point_t fp1, coap_fixed_point_t fp2)
coap_tick_t coap_get_non_timeout_random_ticks(coap_session_t *session)
#define COAP_NSTART(s)
int coap_session_refresh_psk_key(coap_session_t *session, const coap_bin_const_t *psk_key)
Refresh the session's current pre-shared key (PSK).
void coap_session_connected(coap_session_t *session)
Notify session that it has just connected or reconnected.
void coap_session_failed(coap_session_t *session)
Session has failed due to a socket error.
coap_fixed_point_t coap_multi_fixed_fixed(coap_fixed_point_t fp1, coap_fixed_point_t fp2)
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:1100
size_t coap_session_max_pdu_size_lkd(const coap_session_t *session)
Get maximum acceptable PDU size.
int coap_session_set_type_client_lkd(coap_session_t *session)
Set the session type to client.
coap_mid_t coap_session_send_ping_lkd(coap_session_t *session)
Send a ping message for the session.
coap_fixed_point_t coap_div_fixed_uint(coap_fixed_point_t fp1, uint32_t u2)
void coap_session_free(coap_session_t *session)
void coap_session_mfree(coap_session_t *session)
void coap_session_release_lkd(coap_session_t *session)
Decrement reference counter on a session.
int coap_session_refresh_psk_identity(coap_session_t *session, const coap_bin_const_t *psk_identity)
Refresh the session's current pre-shared identity (PSK).
coap_fixed_point_t coap_get_non_timeout_random(coap_session_t *session)
#define COAP_NON_MAX_RETRANSMIT(s)
coap_session_t * coap_session_reference_lkd(coap_session_t *session)
Increment reference counter on a session.
#define COAP_NON_TIMEOUT(s)
void * coap_session_set_app_data2_lkd(coap_session_t *session, void *app_data, coap_app_data_free_callback_t callback)
Stores data with the given session, returning the previously stored value or NULL.
coap_fixed_point_t coap_multi_fixed_uint(coap_fixed_point_t fp1, uint32_t u2)
#define COAP_NON_PARTIAL_TIMEOUT(s)
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_CHECKED
Token size valid.
COAP_API void coap_session_set_app_data(coap_session_t *session, void *app_data)
Stores data with the given session.
COAP_API coap_session_t * coap_session_reference(coap_session_t *session)
Increment reference counter on a session.
coap_session_type_t
coap_session_type_t values
COAP_API void coap_session_disconnected(coap_session_t *session, coap_nack_reason_t reason)
Notify session that it has failed.
COAP_API void * coap_endpoint_set_app_data(coap_endpoint_t *endpoint, void *data, coap_app_data_free_callback_t callback)
Stores data with the given endpoint, returning the previously stored value or NULL.
void coap_session_set_mtu(coap_session_t *session, unsigned mtu)
Set the session MTU.
coap_context_t * coap_session_get_context(const coap_session_t *session)
Get the session context.
const coap_address_t * coap_session_get_addr_local(const coap_session_t *session)
Get the local IP address and port from the session.
coap_proto_t coap_session_get_proto(const coap_session_t *session)
Get the session protocol type.
COAP_API int coap_session_set_type_client(coap_session_t *session)
Set the session type to client.
const coap_bin_const_t * coap_session_get_psk_key(const coap_session_t *session)
Get the session's current pre-shared key (PSK).
void * coap_session_get_tls(const coap_session_t *session, coap_tls_library_t *tls_lib)
Get the session TLS security ptr (TLS type dependent)
coap_session_state_t coap_session_get_state(const coap_session_t *session)
Get the session state.
coap_session_state_t
coap_session_state_t values
void * coap_endpoint_get_app_data(const coap_endpoint_t *endpoint)
Returns any application-specific data that has been stored with endpoint using the function coap_endp...
coap_endpoint_t * coap_session_get_endpoint(const coap_session_t *session)
Get the endpoint of a session.
#define COAP_PROTO_NOT_RELIABLE(p)
COAP_API coap_session_t * coap_new_client_session_pki(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_pki_t *setup_data)
Creates a new client session to the designated server with PKI credentials.
void coap_session_init_token(coap_session_t *session, size_t len, const uint8_t *data)
Initializes the token value to use as a starting point.
#define COAP_PROTO_RELIABLE(p)
void coap_session_new_token(coap_session_t *session, size_t *len, uint8_t *data)
Creates a new token for use.
COAP_API coap_session_t * coap_new_client_session(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto)
Creates a new client session to the designated server.
const coap_bin_const_t * coap_session_get_psk_identity(const coap_session_t *session)
Get the server session's current PSK identity (PSK).
coap_session_t * coap_session_get_by_peer(const coap_context_t *ctx, const coap_address_t *remote_addr, int ifindex)
Get the session associated with the specified remote_addr and index.
void coap_endpoint_set_default_mtu(coap_endpoint_t *endpoint, unsigned mtu)
Set the endpoint's default MTU.
const coap_bin_const_t * coap_session_get_psk_hint(const coap_session_t *session)
Get the server session's current Identity Hint (PSK).
COAP_API coap_endpoint_t * coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto)
Create a new endpoint for communicating with peers.
const coap_address_t * coap_session_get_addr_remote(const coap_session_t *session)
Get the remote IP address and port from the session.
COAP_API void coap_free_endpoint(coap_endpoint_t *endpoint)
Release an endpoint and all the structures associated with it.
COAP_API void coap_session_release(coap_session_t *session)
Decrement reference counter on a session.
COAP_API coap_session_t * coap_new_client_session_psk2(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_cpsk_t *setup_data)
Creates a new client session to the designated server with PSK credentials.
const coap_address_t * coap_session_get_addr_mcast(const coap_session_t *session)
Get the remote multicast IP address and port from the session if the original target IP was multicast...
COAP_API size_t coap_session_max_pdu_size(const coap_session_t *session)
Get maximum acceptable PDU size.
COAP_API coap_session_t * coap_new_client_session_psk(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, const char *identity, const uint8_t *key, unsigned key_len)
Creates a new client session to the designated server with PSK credentials.
int coap_session_get_ifindex(const coap_session_t *session)
Get the session if index.
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_API void * coap_session_set_app_data2(coap_session_t *session, void *app_data, coap_app_data_free_callback_t callback)
Stores data with the given session, returning the previously stored value or NULL.
void * coap_session_get_app_data(const coap_session_t *session)
Returns any application-specific data that has been stored with session using the function coap_sessi...
coap_session_type_t coap_session_get_type(const coap_session_t *session)
Get the session type.
@ COAP_SESSION_TYPE_HELLO
server-side ephemeral session for responding to a client hello
@ COAP_SESSION_TYPE_SERVER
server-side
@ COAP_SESSION_TYPE_CLIENT
client-side
@ COAP_SESSION_STATE_HANDSHAKE
@ COAP_SESSION_STATE_CSM
@ COAP_SESSION_STATE_ESTABLISHED
@ COAP_SESSION_STATE_NONE
@ COAP_SESSION_STATE_CONNECTING
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
void coap_delete_str_const(coap_str_const_t *s)
Deletes the given const string and releases any memory allocated.
Definition coap_str.c:61
coap_bin_const_t * coap_new_bin_const(const uint8_t *data, size_t size)
Take the specified byte array (text) and create a coap_bin_const_t * Returns a new const binary objec...
Definition coap_str.c:110
#define coap_binary_equal(binary1, binary2)
Compares the two binary data for equality.
Definition coap_str.h:211
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_delete_observers(coap_context_t *context, coap_session_t *session)
Removes any subscription for session and releases the allocated storage.
int coap_tcp_is_supported(void)
Check whether TCP is available.
Definition coap_tcp.c:29
int coap_tls_is_supported(void)
Check whether TLS is available.
Definition coap_notls.c:41
int coap_ws_is_supported(void)
Check whether WebSockets is available.
Definition coap_ws.c:933
int coap_dtls_is_supported(void)
Check whether DTLS is available.
Definition coap_notls.c:36
int coap_wss_is_supported(void)
Check whether Secure WebSockets is available.
Definition coap_ws.c:938
Only used for servers for hashing incoming packets.
uint16_t lport
local port
coap_address_t remote
remote address and port
coap_proto_t proto
CoAP protocol.
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.
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_session_t * session
The CoAP stack's global state is stored in a coap_context_t object.
unsigned int reconnect_time
Time to wait before reconnecting a failed client session.
coap_session_t * sessions
client sessions
coap_nack_handler_t nack_handler
Called when a response issue has occurred.
coap_resource_t * resources
hash table or list of known resources
uint32_t csm_max_message_size
Value for CSM Max-Message-Size.
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_cache_entry_t * cache
CoAP cache-entry cache.
coap_endpoint_t * endpoint
the endpoints used for listening
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_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
The structure used for defining the Client PSK setup data to be used.
Definition coap_dtls.h:410
char * client_sni
If not NULL, SNI to use in client TLS setup.
Definition coap_dtls.h:437
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
char * client_sni
If not NULL, SNI to use in client TLS setup.
Definition coap_dtls.h:368
Abstraction of virtual endpoint that can be attached to coap_context_t.
void * app_data
application-specific data
coap_context_t * context
endpoint's context
uint16_t default_mtu
default mtu for this interface
coap_session_t * sessions
hash table or list of active sessions
coap_app_data_free_callback_t app_cb
call-back to release app_data
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
Abstraction of a fixed point number that can be used where necessary instead of a float.
uint16_t fractional_part
Fractional part of fixed point variable 1/1000 (3 points) precision.
uint16_t integer_part
Integer part of fixed point variable.
coap_layer_establish_t l_establish
coap_layer_close_t l_close
Structure to hold large body (many blocks) client receive information.
coap_binary_t * app_token
app requesting PDU token
coap_pdu_t * sent_pdu
The sent pdu with all the data.
uint8_t observe_set
Set if this is an observe receive PDU.
Structure to hold large body (many blocks) server receive information.
Structure to hold large body (many blocks) transmission information.
size_t length
length of payload
coap_addr_tuple_t addr_info
local and remote addresses
unsigned char * payload
payload
int ifindex
the interface index
structure for CoAP PDUs
uint8_t hdr_size
actual size used for protocol-specific header (0 until header is encoded)
coap_bin_const_t actual_token
Actual token in pdu.
coap_mid_t mid
message id, if any, in regular host byte order
size_t used_size
used bytes of storage for token, options and payload
coap_session_t * session
Session responsible for PDU or NULL.
coap_pdu_type_t type
message type
Queue entry.
coap_address_t remote
For re-transmission - where the node is going.
coap_session_t * session
the CoAP session
coap_pdu_t * pdu
the CoAP PDU to send
unsigned int timeout
the randomized timeout value
struct coap_queue_t * next
coap_mid_t id
CoAP message id.
coap_tick_t t
when to send PDU for the next time
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.
coap_bin_const_t * psk_key
If client, this field contains the current pre-shared key for server; When this field is NULL,...
coap_endpoint_t * endpoint
session's endpoint
uint32_t block_mode
Zero or more COAP_BLOCK_ or'd options.
coap_app_data_free_callback_t app_cb
call-back to release app_data
uint8_t doing_first
Set if doing client's first request.
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.
uint16_t nstart
maximum concurrent confirmable xmits (default 1)
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
uint64_t tx_token
Next token number to use.
coap_bin_const_t * client_cid
Contains client CID or NULL.
coap_address_t local_reconnect
local address to initiate reconnect from
uint8_t csm_bert_loc_support
CSM TCP BERT blocks supported (local)
coap_addr_tuple_t addr_info
remote/local address info
coap_proto_t proto
protocol used
uint16_t tx_mid
the last message id that was used in this session
uint8_t is_dtls13
Set if session is DTLS1.3.
unsigned ref
reference count from queues
size_t csm_rcv_mtu
CSM mtu (rcv)
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)
uint8_t no_observe_cancel
Set if do not cancel observe on session close.
size_t partial_read
if > 0 indicates number of bytes already read for an incoming message
int dtls_event
Tracking any (D)TLS events on this session.
uint16_t max_retransmit
maximum re-transmit count (default 4)
coap_fixed_point_t ack_random_factor
ack random factor backoff (default 1.5)
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
size_t tls_overhead
overhead of TLS layer
void * app_data
application-specific data
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_lg_crcv_t * lg_crcv
Client list of expected large receives.
coap_fixed_point_t ack_timeout
timeout waiting for ack (default 2.0 secs)
coap_fixed_point_t default_leisure
Mcast leisure time (default 5.0 secs)
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
uint32_t probing_rate
Max transfer wait when remote is not respoding (default 1 byte/sec)
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_addr_hash_t addr_hash
Address hash for server incoming packets.
coap_pdu_t * cached_pdu
Cached copy of last ACK response PDU.
int ifindex
interface index
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