libcoap 4.3.5-develop-4fa3dfa
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_PROXY_SUPPORT
523 if (session->ref_proxy_subs)
524 coap_delete_proxy_subscriber(session, NULL, 0, COAP_PROXY_SUBS_ALL);
525#endif /* COAP_PROXY_SUPPORT */
526#if COAP_CLIENT_SUPPORT
527 coap_lg_crcv_t *lg_crcv, *etmp;
528
529 /* Need to do this before (D)TLS and socket is closed down */
530 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
531 if (lg_crcv->observe_set && session->no_observe_cancel == 0) {
532 /* Need to close down observe */
533 if (coap_cancel_observe_lkd(session, lg_crcv->app_token, COAP_MESSAGE_NON)) {
534 /* Need to delete node we set up for NON */
535 coap_queue_t *queue = session->context->sendqueue;
536
537 while (queue) {
538 if (queue->session == session) {
540 break;
541 }
542 queue = queue->next;
543 }
544 }
545 }
546 /* In case coap_cancel_observe_lkd() failure, which could clear down lg_crcv */
547 if (!session->lg_crcv)
548 break;
549 LL_DELETE(session->lg_crcv, lg_crcv);
550 coap_block_delete_lg_crcv(session, lg_crcv);
551 }
552#endif /* COAP_CLIENT_SUPPORT */
553
554 if (session->partial_pdu)
556 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
557 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
558 if (session->psk_identity)
560 if (session->psk_key)
562 if (session->psk_hint)
564
565#if COAP_SERVER_SUPPORT
566 coap_cache_entry_t *cp, *ctmp;
567 HASH_ITER(hh, session->context->cache, cp, ctmp) {
568 /* cp->session is NULL if not session based */
569 if (cp->session == session) {
570 coap_delete_cache_entry(session->context, cp);
571 }
572 }
573#endif /* COAP_PROXY_SUPPORT */
574 LL_FOREACH_SAFE(session->delayqueue, q, tmp) {
575 if (q->pdu->type==COAP_MESSAGE_CON) {
576 coap_handle_nack(session, q->pdu,
577 session->proto == COAP_PROTO_DTLS ?
579 q->id);
580 }
582 }
583 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
584 LL_DELETE(session->lg_xmit, lq);
585 coap_block_delete_lg_xmit(session, lq);
586 }
587#if COAP_SERVER_SUPPORT
588 coap_lg_srcv_t *sq, *stmp;
589
590 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
591 LL_DELETE(session->lg_srcv, sq);
592 coap_block_delete_lg_srcv(session, sq);
593 }
594#endif /* COAP_SERVER_SUPPORT */
595#if COAP_OSCORE_SUPPORT
597#endif /* COAP_OSCORE_SUPPORT */
598#if COAP_WS_SUPPORT
599 coap_free_type(COAP_STRING, session->ws);
600 coap_delete_str_const(session->ws_host);
601#endif /* COAP_WS_SUPPORT */
602}
603
604void
606 if (!session)
607 return;
609 assert(session->ref == 0);
610 if (session->ref)
611 return;
612 /* Make sure nothing gets deleted under our feet */
614 coap_session_mfree(session);
615#if COAP_SERVER_SUPPORT
617 if (session->endpoint) {
618 if (session->endpoint->sessions)
619 SESSIONS_DELETE(session->endpoint->sessions, session);
620 } else
621#endif /* COAP_SERVER_SUPPORT */
622#if COAP_CLIENT_SUPPORT
623 if (session->context) {
624 if (session->context->sessions)
625 SESSIONS_DELETE(session->context->sessions, session);
626 }
628#endif /* COAP_CLIENT_SUPPORT */
630 coap_delete_bin_const(session->echo);
631#if COAP_SERVER_SUPPORT
633#endif /* COAP_SERVER_SUPPORT */
634 coap_log_debug("***%s: session %p: closed\n", coap_session_str(session),
635 (void *)session);
636
637 if (session->app_cb) {
638 session->app_cb(session->app_data);
639 }
640 assert(session->ref == 1);
642}
643
644#if COAP_SERVER_SUPPORT
645void
647 int i;
648
651 coap_cancel_all_messages(session->context, session, NULL);
652 RESOURCES_ITER(session->context->resources, r) {
653 /* In case code is broken somewhere */
654 for (i = 0; i < 1000; i++) {
655 if (!coap_delete_observer(r, session, NULL))
656 break;
657 }
658 }
659 if (session->context->unknown_resource) {
660 /* In case code is broken somewhere */
661 for (i = 0; i < 1000; i++) {
662 if (!coap_delete_observer(session->context->unknown_resource, session, NULL))
663 break;
664 }
665 }
666 if (session->context->proxy_uri_resource) {
667 /* In case code is broken somewhere */
668 for (i = 0; i < 1000; i++) {
669 if (!coap_delete_observer(session->context->proxy_uri_resource, session, NULL))
670 break;
671 }
672 }
673 while (session->delayqueue) {
674 coap_queue_t *q = session->delayqueue;
675
676 session->delayqueue = q->next;
678 }
679 /* Force session to go away */
682
684}
685#endif /* COAP_SERVER_SUPPORT */
686
687static size_t
689 size_t max_with_header) {
690#if COAP_DISABLE_TCP
691 (void)session;
692 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
693 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
694 : 0;
695#else /* !COAP_DISABLE_TCP */
696 if (COAP_PROTO_NOT_RELIABLE(session->proto))
697 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
698 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
699 : 0;
700 /* we must assume there is no token to be on the safe side */
701 if (max_with_header <= 2)
702 return 0;
703 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP0 + 2)
704 return max_with_header - 2;
705 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP8 + 3)
706 return max_with_header - 3;
707 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP16 + 4)
708 return max_with_header - 4;
709 else
710 return max_with_header - COAP_PDU_MAX_TCP_HEADER_SIZE;
711#endif /* !COAP_DISABLE_TCP */
712}
713
714size_t
716 if (session->csm_rcv_mtu)
718 (size_t)(session->csm_rcv_mtu));
719
721 (size_t)(session->mtu - session->tls_overhead));
722}
723
724COAP_API size_t
726 size_t size;
727 coap_session_t *session_rw;
728
729 /*
730 * Need to do this to not get a compiler warning about const parameters
731 * but need to maintain source code backward compatibility
732 */
733 memcpy(&session_rw, &session, sizeof(session_rw));
734 coap_lock_lock(return 0);
735 size = coap_session_max_pdu_size_lkd(session_rw);
737 return size;
738}
739
740size_t
742 size_t max_with_header;
743
745#if COAP_CLIENT_SUPPORT
746 /*
747 * Delay if session->doing_first is set.
748 * E.g. Reliable and CSM not in yet for checking block support
749 */
750 coap_session_t *session_rw;
751
752 /*
753 * Need to do this to not get a compiler warning about const parameters
754 * but need to maintain source code backward compatibility
755 */
756 memcpy(&session_rw, &session, sizeof(session_rw));
757 if (coap_client_delay_first(session_rw) == 0) {
758 coap_log_debug("coap_client_delay_first: timeout\n");
759 /* Have to go with the defaults */
760 }
761#endif /* COAP_CLIENT_SUPPORT */
762
763 max_with_header = (size_t)(session->mtu - session->tls_overhead);
764
765 return coap_session_max_pdu_size_internal(session, max_with_header);
766}
767
768void
769coap_session_set_mtu(coap_session_t *session, unsigned mtu) {
770 if (mtu > COAP_DEFAULT_MAX_PDU_RX_SIZE) {
771 mtu = COAP_DEFAULT_MAX_PDU_RX_SIZE;
772 coap_log_debug("* %s: Restricting MTU size to %u\n",
773 coap_session_str(session), mtu);
774 }
775 if (mtu < 64)
776 mtu = 64;
777 session->mtu = mtu;
778 if (session->tls_overhead >= session->mtu) {
779 session->tls_overhead = session->mtu;
780 coap_log_err("DTLS overhead exceeds MTU\n");
781 }
782}
783
784ssize_t
786 coap_queue_t *node) {
787 if (node) {
788 coap_queue_t *removed = NULL;
789 coap_remove_from_queue(&session->context->sendqueue, session, node->id, &removed);
790 assert(removed == node);
792 node->session = NULL;
793 node->t = 0;
794 } else {
795 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
796 coap_queue_t *q = NULL;
797 /* Check same mid is not getting re-used in violation of RFC7252 */
798 LL_FOREACH(session->delayqueue, q) {
799 if (q->id == pdu->mid) {
800 coap_log_err("** %s: mid=0x%04x: already in-use - dropped\n",
801 coap_session_str(session), pdu->mid);
802 return COAP_INVALID_MID;
803 }
804 }
805 }
806 node = coap_new_node();
807 if (node == NULL)
808 return COAP_INVALID_MID;
809 node->id = pdu->mid;
810 node->pdu = pdu;
811 if (pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
812 uint8_t r;
813 coap_prng_lkd(&r, sizeof(r));
814 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
815 node->timeout = coap_calc_timeout(session, r);
816 }
817 coap_address_copy(&node->remote, &session->addr_info.remote);
818 }
819 LL_APPEND(session->delayqueue, node);
820 coap_log_debug("** %s: mid=0x%04x: delayed\n",
821 coap_session_str(session), node->id);
822 return COAP_PDU_DELAYED;
823}
824
825#if !COAP_DISABLE_TCP
826void
828 coap_pdu_t *pdu;
829 uint8_t buf[4];
830 assert(COAP_PROTO_RELIABLE(session->proto));
831 coap_log_debug("***%s: sending CSM\n", coap_session_str(session));
832 session->state = COAP_SESSION_STATE_CSM;
833 session->partial_write = 0;
834 if (session->mtu == 0)
835 coap_session_set_mtu(session, COAP_DEFAULT_MTU); /* base value */
837 if (pdu == NULL
839 coap_encode_var_safe(buf, sizeof(buf),
840 session->context->csm_max_message_size), buf) == 0
842 coap_encode_var_safe(buf, sizeof(buf),
843 0), buf) == 0
844 || (session->max_token_size > COAP_TOKEN_DEFAULT_MAX &&
847 coap_encode_var_safe(buf, sizeof(buf),
848 session->max_token_size),
849 buf) == 0)
850 || coap_pdu_encode_header(pdu, session->proto) == 0
851 ) {
853 } else {
854 ssize_t bytes_written;
855
856 pdu->session = session;
857 bytes_written = coap_session_send_pdu(session, pdu);
858 if (bytes_written != (ssize_t)pdu->used_size + pdu->hdr_size) {
860 } else {
861 session->csm_rcv_mtu = session->context->csm_max_message_size;
862 if (session->csm_rcv_mtu > COAP_BERT_BASE)
863 session->csm_bert_loc_support = 1;
864 else
865 session->csm_bert_loc_support = 0;
866 }
867 }
868 if (pdu)
870}
871#endif /* !COAP_DISABLE_TCP */
872
875 coap_mid_t mid;
876
878 mid = coap_session_send_ping_lkd(session);
880 return mid;
881}
882
885 coap_pdu_t *ping = NULL;
886
888 if (session->state != COAP_SESSION_STATE_ESTABLISHED ||
889 session->con_active)
890 return COAP_INVALID_MID;
891 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
892 uint16_t mid = coap_new_message_id_lkd(session);
893 ping = coap_pdu_init(COAP_MESSAGE_CON, 0, mid, 0);
894 }
895#if !COAP_DISABLE_TCP
896 else {
898 }
899#endif /* !COAP_DISABLE_TCP */
900 if (!ping)
901 return COAP_INVALID_MID;
902 return coap_send_internal(session, ping, NULL);
903}
904
905void
907 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
908 coap_log_debug("***%s: session connected\n",
909 coap_session_str(session));
910 if (session->state == COAP_SESSION_STATE_CSM) {
912#if COAP_CLIENT_SUPPORT
914#endif /* COAP_CLIENT_SUPPORT */
915 if (session->doing_first)
916 session->doing_first = 0;
917 }
918 }
919
921 session->partial_write = 0;
922
923 if (session->proto==COAP_PROTO_DTLS) {
924 session->tls_overhead = coap_dtls_get_overhead(session);
925 if (session->tls_overhead >= session->mtu) {
926 session->tls_overhead = session->mtu;
927 coap_log_err("DTLS overhead exceeds MTU\n");
928 }
929 }
930
931 while (session->delayqueue && session->state == COAP_SESSION_STATE_ESTABLISHED) {
932 ssize_t bytes_written;
933 coap_queue_t *q = session->delayqueue;
934 coap_address_t remote;
935
936 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
937 if (session->con_active >= COAP_NSTART(session))
938 break;
939 session->con_active++;
940 }
941 /* Take entry off the queue */
942 session->delayqueue = q->next;
943 q->next = NULL;
944
945 coap_address_copy(&remote, &session->addr_info.remote);
947 coap_log_debug("** %s: mid=0x%04x: transmitted after delay (2)\n",
948 coap_session_str(session), (int)q->pdu->mid);
949 bytes_written = coap_session_send_pdu(session, q->pdu);
950 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
951 if (coap_wait_ack(session->context, session, q) >= 0)
952 q = NULL;
953 }
954 coap_address_copy(&session->addr_info.remote, &remote);
955 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
956 if (q)
958 if (bytes_written < 0)
959 break;
960 } else if (q) {
961 if (bytes_written <= 0 || (size_t)bytes_written < q->pdu->used_size + q->pdu->hdr_size) {
962 q->next = session->delayqueue;
963 session->delayqueue = q;
964 if (bytes_written > 0)
965 session->partial_write = (size_t)bytes_written;
966 break;
967 } else {
969 }
970 }
971 }
972}
973
974#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
975static const char *
977 switch (reason) {
979 return "COAP_NACK_TOO_MANY_RETRIES";
981 return "COAP_NACK_NOT_DELIVERABLE";
982 case COAP_NACK_RST:
983 return "COAP_NACK_RST";
985 return "COAP_NACK_TLS_FAILED";
987 return "COAP_NACK_ICMP_ISSUE";
989 return "COAP_NACK_BAD_RESPONSE";
991 return "COAP_NACK_TLS_LAYER_FAILED";
993 return "COAP_NACK_WS_LAYER_FAILED";
995 return "COAP_NACK_WS_FAILED";
996 default:
997 return "???";
998 }
999}
1000#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
1001
1002void
1004 coap_pdu_t *sent,
1005 const coap_nack_reason_t reason,
1006 const coap_mid_t mid) {
1007 if (session->context->nack_handler) {
1008 coap_bin_const_t token = {0, NULL};
1009
1010 if (sent) {
1011 coap_check_update_token(session, sent);
1012 token = sent->actual_token;
1013 }
1014 coap_lock_callback(session->context->nack_handler(session, sent, reason, mid));
1015 if (sent) {
1016 coap_update_token(sent, token.length, token.s);
1017 }
1018 }
1019#if COAP_CLIENT_SUPPORT
1020 if (reason != COAP_NACK_ICMP_ISSUE) {
1021 session->doing_send_recv = 0;
1022 }
1023#endif /* COAP_CLIENT_SUPPORT */
1024}
1025
1026COAP_API void
1032
1033void
1035#if !COAP_DISABLE_TCP
1036 coap_session_state_t state = session->state;
1037#endif /* !COAP_DISABLE_TCP */
1038 coap_lg_xmit_t *lq, *ltmp;
1039#if COAP_SERVER_SUPPORT
1040 coap_lg_srcv_t *sq, *stmp;
1041#endif /* COAP_SERVER_SUPPORT */
1042#if COAP_CLIENT_SUPPORT
1043 coap_lg_crcv_t *cq, *etmp;
1044#endif /* COAP_CLIENT_SUPPORT */
1045 int sent_nack = 0;
1046 coap_queue_t *q;
1047
1049#if COAP_CLIENT_SUPPORT
1050 coap_session_failed(session);
1051#endif /* COAP_CLIENT_SUPPORT */
1052
1053 q = session->context->sendqueue;
1054 while (q) {
1055 if (q->session == session) {
1056 /* Take the first one */
1057 coap_handle_nack(session, q->pdu, reason, q->id);
1058 sent_nack = 1;
1059 break;
1060 }
1061 q = q->next;
1062 }
1063
1064 if (reason != COAP_NACK_ICMP_ISSUE) {
1065 while (session->delayqueue) {
1066 q = session->delayqueue;
1067 session->delayqueue = q->next;
1068 q->next = NULL;
1069 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1070 coap_session_str(session), q->id);
1071 if (q->pdu->type == COAP_MESSAGE_CON) {
1072 coap_handle_nack(session, q->pdu, reason, q->id);
1073 sent_nack = 1;
1074 }
1075
1076#if COAP_CLIENT_SUPPORT
1077 session->doing_send_recv = 0;
1078#endif /* COAP_CLIENT_SUPPORT */
1080 }
1081 }
1082#if COAP_CLIENT_SUPPORT
1083 if (!sent_nack && session->lg_crcv) {
1084 /* Take the first one */
1085 coap_handle_nack(session, session->lg_crcv->sent_pdu, reason,
1086 session->lg_crcv->sent_pdu->mid);
1087 sent_nack = 1;
1088 }
1089#endif /* COAP_CLIENT_SUPPORT */
1090 if (!sent_nack) {
1091 /* Unable to determine which request disconnection was for */
1092 coap_handle_nack(session, NULL, reason, 0);
1093 }
1094 if (reason == COAP_NACK_ICMP_ISSUE) {
1095 coap_log_debug("***%s: session ICMP issue (%s)\n",
1096 coap_session_str(session), coap_nack_name(reason));
1097 return;
1098 }
1099 coap_log_debug("***%s: session disconnected (%s)\n",
1100 coap_session_str(session), coap_nack_name(reason));
1101#if COAP_SERVER_SUPPORT
1102 coap_delete_observers(session->context, session);
1103#endif /* COAP_SERVER_SUPPORT */
1104
1105 if (session->proto == COAP_PROTO_UDP)
1107 else
1108 session->state = COAP_SESSION_STATE_NONE;
1109
1110 session->con_active = 0;
1111
1112 if (session->partial_pdu) {
1114 session->partial_pdu = NULL;
1115 }
1116 session->partial_read = 0;
1117
1118 /* Not done if nack handler called above */
1119 while (session->delayqueue) {
1120 q = session->delayqueue;
1121 session->delayqueue = q->next;
1122 q->next = NULL;
1123 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1124 coap_session_str(session), q->id);
1125#if COAP_CLIENT_SUPPORT
1126 session->doing_send_recv = 0;
1127#endif /* COAP_CLIENT_SUPPORT */
1129 }
1130
1131#if COAP_CLIENT_SUPPORT
1132 if (!session->session_failed) {
1133 /* Need to do this before (D)TLS and socket is closed down */
1134 LL_FOREACH_SAFE(session->lg_crcv, cq, etmp) {
1135 LL_DELETE(session->lg_crcv, cq);
1136 coap_block_delete_lg_crcv(session, cq);
1137 }
1138 }
1139#endif /* COAP_CLIENT_SUPPORT */
1140 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
1141 LL_DELETE(session->lg_xmit, lq);
1142 coap_block_delete_lg_xmit(session, lq);
1143 }
1144#if COAP_SERVER_SUPPORT
1145 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
1146 LL_DELETE(session->lg_srcv, sq);
1147 coap_block_delete_lg_srcv(session, sq);
1148 }
1149#endif /* COAP_SERVER_SUPPORT */
1150 coap_cancel_session_messages(session->context, session, reason);
1151
1152#if !COAP_DISABLE_TCP
1153 if (COAP_PROTO_RELIABLE(session->proto)) {
1154 if (coap_netif_available(session)) {
1158 }
1159#if COAP_CLIENT_SUPPORT
1160 if (state != COAP_SESSION_STATE_NONE && !session->session_failed) {
1164 }
1165#endif /* COAP_CLIENT_SUPPORT */
1166 if (session->doing_first)
1167 session->doing_first = 0;
1168 }
1169#endif /* !COAP_DISABLE_TCP */
1170 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1171 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1172}
1173
1174#if COAP_CLIENT_SUPPORT
1175void
1177 if (session->context->reconnect_time &&
1179 session->type == COAP_SESSION_TYPE_CLIENT) {
1180 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1181 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1182 session->session_failed = 1;
1183 coap_ticks(&session->last_rx_tx);
1184 }
1185}
1186#endif /* COAP_CLIENT_SUPPORT */
1187
1188#if COAP_SERVER_SUPPORT
1189static void
1190coap_make_addr_hash(coap_addr_hash_t *addr_hash, coap_proto_t proto,
1191 const coap_addr_tuple_t *addr_info) {
1192 memset(addr_hash, 0, sizeof(coap_addr_hash_t));
1193 coap_address_copy(&addr_hash->remote, &addr_info->remote);
1194 addr_hash->lport = coap_address_get_port(&addr_info->local);
1195 addr_hash->proto = proto;
1196}
1197
1200 const coap_packet_t *packet, coap_tick_t now) {
1201 coap_session_t *session;
1202 coap_session_t *rtmp;
1203 unsigned int num_idle = 0;
1204 unsigned int num_hs = 0;
1205 coap_session_t *oldest = NULL;
1206 coap_session_t *oldest_hs = NULL;
1207 coap_addr_hash_t addr_hash;
1208
1209 coap_make_addr_hash(&addr_hash, endpoint->proto, &packet->addr_info);
1210 SESSIONS_FIND(endpoint->sessions, addr_hash, session);
1211 if (session) {
1212 /* Maybe mcast or unicast IP address which is not in the hash */
1213 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1214 session->ifindex = packet->ifindex;
1215 session->last_rx_tx = now;
1216 return session;
1217 }
1218
1219#if COAP_CLIENT_SUPPORT
1220 if (coap_is_mcast(&packet->addr_info.local)) {
1221 /* Check if this a proxy client packet we sent on another socket */
1222 SESSIONS_ITER(endpoint->context->sessions, session, rtmp) {
1223 if (coap_address_equals(&session->addr_info.remote, &packet->addr_info.local) &&
1226 /* Drop looped back packet to stop recursion / confusion */
1227 return NULL;
1228 }
1229 }
1230 }
1231#endif /* COAP_CLIENT_SUPPORT */
1232 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1233 if (session->ref == 0 && session->delayqueue == NULL) {
1234 if (session->type == COAP_SESSION_TYPE_SERVER) {
1235 ++num_idle;
1236 if (oldest==NULL || session->last_rx_tx < oldest->last_rx_tx)
1237 oldest = session;
1238
1239 if (session->state == COAP_SESSION_STATE_HANDSHAKE) {
1240 ++num_hs;
1241 /* See if this is a partial (D)TLS session set up
1242 which needs to be cleared down to prevent DOS */
1243 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1244 if (oldest_hs == NULL ||
1245 session->last_rx_tx < oldest_hs->last_rx_tx)
1246 oldest_hs = session;
1247 }
1248 }
1249 } else if (session->type == COAP_SESSION_TYPE_HELLO) {
1250 ++num_hs;
1251 /* See if this is a partial (D)TLS session set up for Client Hello
1252 which needs to be cleared down to prevent DOS */
1253 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1254 if (oldest_hs == NULL ||
1255 session->last_rx_tx < oldest_hs->last_rx_tx)
1256 oldest_hs = session;
1257 }
1258 }
1259 }
1260 }
1261
1262 if (endpoint->context->max_idle_sessions > 0 &&
1263 num_idle >= endpoint->context->max_idle_sessions) {
1265 coap_session_free(oldest);
1266 } else if (oldest_hs) {
1267 coap_log_warn("***%s: Incomplete session timed out\n",
1268 coap_session_str(oldest_hs));
1270 coap_session_free(oldest_hs);
1271 }
1272
1273 if (num_hs > (endpoint->context->max_handshake_sessions ?
1274 endpoint->context->max_handshake_sessions :
1276 /* Maxed out on number of sessions in (D)TLS negotiation state */
1277 coap_log_debug("Oustanding sessions in COAP_SESSION_STATE_HANDSHAKE too "
1278 "large. New request ignored\n");
1279 return NULL;
1280 }
1281
1282 if (endpoint->proto == COAP_PROTO_DTLS) {
1283 /*
1284 * Need to check that this actually is a Client Hello before wasting
1285 * time allocating and then freeing off session.
1286 */
1287
1288 /*
1289 * Generic header structure of the DTLS record layer.
1290 * typedef struct __attribute__((__packed__)) {
1291 * uint8_t content_type; content type of the included message
1292 * uint16_t version; Protocol version
1293 * uint16_t epoch; counter for cipher state changes
1294 * uint8_t sequence_number[6]; sequence number
1295 * uint16_t length; length of the following fragment
1296 * uint8_t handshake; If content_type == DTLS_CT_HANDSHAKE
1297 * } dtls_record_handshake_t;
1298 */
1299#define OFF_CONTENT_TYPE 0 /* offset of content_type in dtls_record_handshake_t */
1300#define DTLS_CT_ALERT 21 /* Content Type Alert */
1301#define DTLS_CT_HANDSHAKE 22 /* Content Type Handshake */
1302#define OFF_HANDSHAKE_TYPE 13 /* offset of handshake in dtls_record_handshake_t */
1303#define DTLS_HT_CLIENT_HELLO 1 /* Client Hello handshake type */
1304#define DTLS_CT_CID 25 /* Content Type Connection ID */
1305#define OFF_CID 11 /* offset of CID in dtls_record_handshake_t */
1306#define OFF_CID_DTLS13 1 /* offset of CID in DTLS1.3 Unified Header */
1307
1308 const uint8_t *payload = (const uint8_t *)packet->payload;
1309 size_t length = packet->length;
1310 if (length < (OFF_HANDSHAKE_TYPE + 1)) {
1311 coap_log_debug("coap_dtls_hello: ContentType %d Short Packet (%zu < %d) dropped\n",
1312 payload[OFF_CONTENT_TYPE], length,
1313 OFF_HANDSHAKE_TYPE + 1);
1314 return NULL;
1315 }
1316 if ((payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 ||
1317 payload[OFF_CONTENT_TYPE] == DTLS_CT_CID) {
1318 /* Client may have changed its IP address */
1319 int changed = 0;
1320
1321 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1322 if (session->client_cid) {
1323 if ((session->is_dtls13 && (payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 &&
1324 memcmp(session->client_cid->s, &payload[OFF_CID_DTLS13],
1325 session->client_cid->length) == 0) ||
1326 (!session->is_dtls13 && payload[OFF_CONTENT_TYPE] == DTLS_CT_CID &&
1327 memcmp(session->client_cid->s, &payload[OFF_CID],
1328 session->client_cid->length) == 0)) {
1329 /* Updating IP address */
1330 coap_log_info("***%s: CID: Old Client Session\n", coap_session_str(session));
1331 SESSIONS_DELETE(endpoint->sessions, session);
1332 session->addr_info = packet->addr_info;
1333 memcpy(&session->addr_hash, &addr_hash, sizeof(session->addr_hash));
1334 SESSIONS_ADD(endpoint->sessions, session);
1335 coap_log_info("***%s: CID: New Client Session\n", coap_session_str(session));
1336 return session;
1337 }
1338 }
1339 }
1340 if (!changed) {
1341 coap_log_debug("coap_dtls_hello: ContentType Connection-IS dropped\n");
1342 return NULL;
1343 }
1344 } else if (payload[OFF_CONTENT_TYPE] != DTLS_CT_HANDSHAKE ||
1345 payload[OFF_HANDSHAKE_TYPE] != DTLS_HT_CLIENT_HELLO) {
1346 /* only log if not a late alert */
1347 if (payload[OFF_CONTENT_TYPE] != DTLS_CT_ALERT)
1348 coap_log_debug("coap_dtls_hello: ContentType %d Handshake %d dropped\n",
1349 payload[OFF_CONTENT_TYPE],
1350 payload[OFF_HANDSHAKE_TYPE]);
1351 return NULL;
1352 }
1353 }
1354
1356 &addr_hash, &packet->addr_info.local,
1357 &packet->addr_info.remote,
1358 packet->ifindex, endpoint->context, endpoint);
1359 if (session) {
1360 session->last_rx_tx = now;
1361 memcpy(session->sock.lfunc, endpoint->sock.lfunc,
1362 sizeof(session->sock.lfunc));
1363 if (endpoint->proto == COAP_PROTO_UDP)
1365 else if (endpoint->proto == COAP_PROTO_DTLS) {
1366 session->type = COAP_SESSION_TYPE_HELLO;
1367 }
1368 SESSIONS_ADD(endpoint->sessions, session);
1369 coap_log_debug("***%s: session %p: new incoming session\n",
1370 coap_session_str(session), (void *)session);
1372 }
1373 return session;
1374}
1375
1378 coap_tick_t now) {
1379 if (session) {
1380 session->last_rx_tx = now;
1381 session->type = COAP_SESSION_TYPE_SERVER;
1382 coap_dtls_establish(session);
1383 }
1384 return session;
1385}
1386#endif /* COAP_SERVER_SUPPORT */
1387
1388#if COAP_CLIENT_SUPPORT
1389static coap_session_t *
1390coap_session_create_client(coap_context_t *ctx,
1391 const coap_address_t *local_if,
1392 const coap_address_t *server,
1393 coap_proto_t proto) {
1394 coap_session_t *session = NULL;
1395 int default_port = COAP_DEFAULT_PORT;
1396
1397 assert(server);
1398
1399 switch (proto) {
1400 case COAP_PROTO_UDP:
1401 default_port = COAP_DEFAULT_PORT;
1402 break;
1403 case COAP_PROTO_DTLS:
1404 if (!coap_dtls_is_supported()) {
1405 coap_log_crit("coap_new_client_session*: DTLS not supported\n");
1406 return NULL;
1407 }
1408 default_port = COAPS_DEFAULT_PORT;
1409 break;
1410 case COAP_PROTO_TCP:
1411 if (!coap_tcp_is_supported()) {
1412 coap_log_crit("coap_new_client_session*: TCP not supported\n");
1413 return NULL;
1414 }
1415 default_port = COAP_DEFAULT_PORT;
1416 break;
1417 case COAP_PROTO_TLS:
1418 if (!coap_tls_is_supported()) {
1419 coap_log_crit("coap_new_client_session*: TLS not supported\n");
1420 return NULL;
1421 }
1422 default_port = COAPS_DEFAULT_PORT;
1423 break;
1424 case COAP_PROTO_WS:
1425 if (!coap_ws_is_supported()) {
1426 coap_log_crit("coap_new_client_session*: WS not supported\n");
1427 return NULL;
1428 }
1429 default_port = 80;
1430 break;
1431 case COAP_PROTO_WSS:
1432 if (!coap_wss_is_supported()) {
1433 coap_log_crit("coap_new_client_session*: WSS not supported\n");
1434 return NULL;
1435 }
1436 default_port = 443;
1437 break;
1438 case COAP_PROTO_NONE:
1439 case COAP_PROTO_LAST:
1440 default:
1441 assert(0);
1442 return NULL;
1443 }
1444 session = coap_make_session(proto, COAP_SESSION_TYPE_CLIENT, NULL,
1445 local_if, server, 0, ctx, NULL);
1446 if (!session)
1447 goto error;
1448
1450 session->sock.session = session;
1451 memcpy(&session->sock.lfunc, coap_layers_coap[proto],
1452 sizeof(session->sock.lfunc));
1453
1454 if (COAP_PROTO_NOT_RELIABLE(proto)) {
1455 coap_session_t *s, *rtmp;
1456 if (!coap_netif_dgrm_connect(session, local_if, server, default_port)) {
1457 goto error;
1458 }
1459 /* Check that this is not a duplicate 4-tuple */
1460 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
1463 &s->addr_info.local) &&
1465 &s->addr_info.remote)) {
1466 coap_log_warn("***%s: session %p: duplicate - already exists\n",
1467 coap_session_str(session), (void *)session);
1468 goto error;
1469 }
1470 }
1471#ifdef WITH_CONTIKI
1472 session->sock.context = ctx;
1473#endif /* WITH_CONTIKI */
1474#if !COAP_DISABLE_TCP
1475 } else if (COAP_PROTO_RELIABLE(proto)) {
1476 if (!coap_netif_strm_connect1(session, local_if, server, default_port)) {
1477 goto error;
1478 }
1479#endif /* !COAP_DISABLE_TCP */
1480 }
1481
1482 session->sock.session = session;
1483#ifdef COAP_EPOLL_SUPPORT
1484 coap_epoll_ctl_add(&session->sock,
1485 EPOLLIN |
1486 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1487 EPOLLOUT : 0),
1488 __func__);
1489#endif /* COAP_EPOLL_SUPPORT */
1490
1492 if (local_if)
1493 session->sock.flags |= COAP_SOCKET_BOUND;
1494#if COAP_SERVER_SUPPORT
1495 if (ctx->proxy_uri_resource)
1496 session->proxy_session = 1;
1497#endif /* COAP_SERVER_SUPPORT */
1498 SESSIONS_ADD(ctx->sessions, session);
1499 return session;
1500
1501error:
1502 /*
1503 * Need to add in the session as coap_session_release_lkd()
1504 * will call SESSIONS_DELETE in coap_session_free().
1505 */
1506 if (session)
1507 SESSIONS_ADD(ctx->sessions, session);
1508 coap_session_release_lkd(session);
1509 return NULL;
1510}
1511
1512static void
1513coap_session_check_connect(coap_session_t *session) {
1514 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1515 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1516 }
1517#if !COAP_DISABLE_TCP
1518 if (COAP_PROTO_RELIABLE(session->proto)) {
1519 if (session->sock.flags & COAP_SOCKET_WANT_CONNECT) {
1521 if (session->type == COAP_SESSION_TYPE_CLIENT) {
1522 session->doing_first = 1;
1523 }
1524 } else {
1525 /* Initial connect worked immediately */
1526 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1527 }
1528 }
1529#endif /* !COAP_DISABLE_TCP */
1530 coap_ticks(&session->last_rx_tx);
1531}
1532#endif /* COAP_CLIENT_SUPPORT */
1533
1534void
1536 if (COAP_PROTO_NOT_RELIABLE(session->proto))
1537 coap_session_connected(session);
1538#if !COAP_DISABLE_TCP
1539 if (COAP_PROTO_RELIABLE(session->proto))
1540 coap_session_send_csm(session);
1541#endif /* !COAP_DISABLE_TCP */
1542}
1543
1544#if COAP_CLIENT_SUPPORT
1545int
1547 int default_port = COAP_DEFAULT_PORT;
1548
1549 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close && !session->session_failed)
1550 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1551
1552 switch (session->proto) {
1553 case COAP_PROTO_UDP:
1554 default_port = COAP_DEFAULT_PORT;
1555 break;
1556 case COAP_PROTO_DTLS:
1557 default_port = COAPS_DEFAULT_PORT;
1558 break;
1559 case COAP_PROTO_TCP:
1560 default_port = COAP_DEFAULT_PORT;
1561 break;
1562 case COAP_PROTO_TLS:
1563 default_port = COAPS_DEFAULT_PORT;
1564 break;
1565 case COAP_PROTO_WS:
1566 default_port = 80;
1567 break;
1568 case COAP_PROTO_WSS:
1569 default_port = 443;
1570 break;
1571 case COAP_PROTO_NONE:
1572 case COAP_PROTO_LAST:
1573 default:
1574 assert(0);
1575 return 0;
1576 }
1577 session->sock.session = session;
1578 coap_log_debug("***%s: trying to reconnect\n", coap_session_str(session));
1579 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1580 session->state = COAP_SESSION_STATE_NONE;
1581 if (!coap_netif_dgrm_connect(session, &session->local_reconnect, &session->addr_info.remote,
1582 default_port)) {
1583 goto error;
1584 }
1586#ifdef WITH_CONTIKI
1587 session->sock.context = session->context;
1588#endif /* WITH_CONTIKI */
1589#if !COAP_DISABLE_TCP
1590 } else if (COAP_PROTO_RELIABLE(session->proto)) {
1591 if (!coap_netif_strm_connect1(session, &session->local_reconnect, &session->addr_info.remote,
1592 default_port)) {
1593 goto error;
1594 }
1595#endif /* !COAP_DISABLE_TCP */
1596 } else {
1597 goto error;
1598 }
1599#ifdef COAP_EPOLL_SUPPORT
1600 coap_epoll_ctl_add(&session->sock,
1601 EPOLLIN |
1602 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1603 EPOLLOUT : 0),
1604 __func__);
1605#endif /* COAP_EPOLL_SUPPORT */
1606
1608 session->sock.flags |= COAP_SOCKET_BOUND;
1609 coap_session_check_connect(session);
1610 return 1;
1611error:
1612 return 0;
1613}
1614
1615void
1617 coap_lg_crcv_t *lg_crcv, *etmp;
1618
1619 if (!session->session_failed)
1620 return;
1621 coap_log_debug("***%s: session re-established\n",
1622 coap_session_str(session));
1623 session->session_failed = 0;
1624 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
1626 coap_send_internal(session, lg_crcv->sent_pdu, NULL);
1627 }
1628}
1629
1632 const coap_address_t *local_if,
1633 const coap_address_t *server,
1634 coap_proto_t proto) {
1635 coap_session_t *session;
1636
1637 coap_lock_lock(return NULL);
1638 session = coap_new_client_session_lkd(ctx, local_if, server, proto);
1640 return session;
1641}
1642
1645 const coap_address_t *local_if,
1646 const coap_address_t *server,
1647 coap_proto_t proto) {
1648 coap_session_t *session;
1649
1651 session = coap_session_create_client(ctx, local_if, server,
1652 proto);
1653 if (session) {
1654 coap_log_debug("***%s: session %p: created outgoing session\n",
1655 coap_session_str(session), (void *)session);
1656 coap_session_check_connect(session);
1657 }
1658 return session;
1659}
1660
1663 const coap_address_t *local_if,
1664 const coap_address_t *server,
1665 coap_proto_t proto, const char *identity,
1666 const uint8_t *key, unsigned key_len) {
1667 coap_session_t *session;
1668
1669 coap_lock_lock(return NULL);
1670 session = coap_new_client_session_psk_lkd(ctx, local_if, server, proto, identity, key, key_len);
1672 return session;
1673}
1674
1677 const coap_address_t *local_if,
1678 const coap_address_t *server,
1679 coap_proto_t proto, const char *identity,
1680 const uint8_t *key, unsigned key_len) {
1681 coap_dtls_cpsk_t setup_data;
1682
1684 memset(&setup_data, 0, sizeof(setup_data));
1686
1687 if (identity) {
1688 setup_data.psk_info.identity.s = (const uint8_t *)identity;
1689 setup_data.psk_info.identity.length = strlen(identity);
1690 }
1691
1692 if (key && key_len > 0) {
1693 setup_data.psk_info.key.s = key;
1694 setup_data.psk_info.key.length = key_len;
1695 }
1696
1697 return coap_new_client_session_psk2_lkd(ctx, local_if, server,
1698 proto, &setup_data);
1699}
1700
1701/*
1702 * Check the validity of the SNI to send to the server.
1703 *
1704 * https://datatracker.ietf.org/doc/html/rfc6066#section-3
1705 * Literal IPv4 and IPv6 addresses are not permitted in "HostName".
1706 */
1707static void
1708coap_sanitize_client_sni(char **client_sni) {
1709 char *cp;
1710
1711 if (*client_sni == NULL)
1712 return;
1713
1714 cp = *client_sni;
1715 switch (*cp) {
1716 case '0':
1717 case '1':
1718 case '2':
1719 case '3':
1720 case '4':
1721 case '5':
1722 case '6':
1723 case '7':
1724 case '8':
1725 case '9':
1726 case 'a':
1727 case 'b':
1728 case 'c':
1729 case 'd':
1730 case 'e':
1731 case 'f':
1732 case 'A':
1733 case 'B':
1734 case 'C':
1735 case 'D':
1736 case 'E':
1737 case 'F':
1738 case ':':
1739 break;
1740 case '\000':
1741 /* Empty entry invalid */
1742 *client_sni = NULL;
1743 return;
1744 default:
1745 /* Does not start with a hex digit or : - not literal IP. */
1746 return;
1747 }
1748 /* Check for IPv4 */
1749 while (*cp) {
1750 switch (*cp) {
1751 case '0':
1752 case '1':
1753 case '2':
1754 case '3':
1755 case '4':
1756 case '5':
1757 case '6':
1758 case '7':
1759 case '8':
1760 case '9':
1761 case '.':
1762 break;
1763 default:
1764 /* Not of format nnn.nnn.nnn.nnn. Could be IPv6 */
1765 goto check_ipv6;
1766 }
1767 cp++;
1768 }
1769 /* IPv4 address - not allowed. */
1770 *client_sni = NULL;
1771 return;
1772
1773check_ipv6:
1774 /* Check for IPv6 */
1775 cp = *client_sni;
1776 while (*cp) {
1777 switch (*cp) {
1778 case '0':
1779 case '1':
1780 case '2':
1781 case '3':
1782 case '4':
1783 case '5':
1784 case '6':
1785 case '7':
1786 case '8':
1787 case '9':
1788 case 'a':
1789 case 'b':
1790 case 'c':
1791 case 'd':
1792 case 'e':
1793 case 'f':
1794 case 'A':
1795 case 'B':
1796 case 'C':
1797 case 'D':
1798 case 'E':
1799 case 'F':
1800 case ':':
1801 break;
1802 case '%':
1803 /* Start of i/f specification, Previous is IPv6 */
1804 *client_sni = NULL;
1805 return;
1806 default:
1807 /* Not of format xx:xx::xx. */
1808 return;
1809 }
1810 cp++;
1811 }
1812 *client_sni = NULL;
1813 return;
1814}
1815
1818 const coap_address_t *local_if,
1819 const coap_address_t *server,
1820 coap_proto_t proto,
1821 coap_dtls_cpsk_t *setup_data) {
1822 coap_session_t *session;
1823
1824 coap_lock_lock(return NULL);
1825 session = coap_new_client_session_psk2_lkd(ctx, local_if, server, proto, setup_data);
1827 return session;
1828}
1829
1832 const coap_address_t *local_if,
1833 const coap_address_t *server,
1834 coap_proto_t proto,
1835 coap_dtls_cpsk_t *setup_data) {
1836 coap_session_t *session;
1837
1839 session = coap_session_create_client(ctx, local_if, server, proto);
1840
1841 if (!session || !setup_data)
1842 return NULL;
1843
1844 session->cpsk_setup_data = *setup_data;
1845 if (setup_data->psk_info.identity.s) {
1846 session->psk_identity =
1848 setup_data->psk_info.identity.length);
1849 if (!session->psk_identity) {
1850 coap_log_warn("Cannot store session Identity (PSK)\n");
1851 coap_session_release_lkd(session);
1852 return NULL;
1853 }
1855 coap_log_warn("Identity (PSK) not defined\n");
1856 coap_session_release_lkd(session);
1857 return NULL;
1858 }
1859
1860 if (setup_data->psk_info.key.s && setup_data->psk_info.key.length > 0) {
1861 session->psk_key = coap_new_bin_const(setup_data->psk_info.key.s,
1862 setup_data->psk_info.key.length);
1863 if (!session->psk_key) {
1864 coap_log_warn("Cannot store session pre-shared key (PSK)\n");
1865 coap_session_release_lkd(session);
1866 return NULL;
1867 }
1869 coap_log_warn("Pre-shared key (PSK) not defined\n");
1870 coap_session_release_lkd(session);
1871 return NULL;
1872 }
1873
1874 coap_sanitize_client_sni(&session->cpsk_setup_data.client_sni);
1875
1877 if (!coap_dtls_context_set_cpsk(ctx, &session->cpsk_setup_data)) {
1878 coap_session_release_lkd(session);
1879 return NULL;
1880 }
1881 }
1882 coap_log_debug("***%s: new outgoing session\n",
1883 coap_session_str(session));
1884 coap_session_check_connect(session);
1885 return session;
1886}
1887#endif /* COAP_CLIENT_SUPPORT */
1888
1889int
1891 const coap_bin_const_t *psk_hint
1892 ) {
1893 /* We may be refreshing the hint with the same hint */
1894 coap_bin_const_t *old_psk_hint = session->psk_hint;
1895
1896 if (psk_hint && psk_hint->s) {
1897 if (session->psk_hint) {
1898 if (coap_binary_equal(session->psk_hint, psk_hint))
1899 return 1;
1900 }
1901 session->psk_hint = coap_new_bin_const(psk_hint->s,
1902 psk_hint->length);
1903 if (!session->psk_hint) {
1904 coap_log_err("No memory to store identity hint (PSK)\n");
1905 if (old_psk_hint)
1906 coap_delete_bin_const(old_psk_hint);
1907 return 0;
1908 }
1909 } else {
1910 session->psk_hint = NULL;
1911 }
1912 if (old_psk_hint)
1913 coap_delete_bin_const(old_psk_hint);
1914
1915 return 1;
1916}
1917
1918int
1920 const coap_bin_const_t *psk_key
1921 ) {
1922 /* We may be refreshing the key with the same key */
1923 coap_bin_const_t *old_psk_key = session->psk_key;
1924
1925 if (psk_key && psk_key->s) {
1926 if (session->psk_key) {
1927 if (coap_binary_equal(session->psk_key, psk_key))
1928 return 1;
1929 }
1930 session->psk_key = coap_new_bin_const(psk_key->s, psk_key->length);
1931 if (!session->psk_key) {
1932 coap_log_err("No memory to store pre-shared key (PSK)\n");
1933 if (old_psk_key)
1934 coap_delete_bin_const(old_psk_key);
1935 return 0;
1936 }
1937 } else {
1938 session->psk_key = NULL;
1939 }
1940 if (old_psk_key)
1941 coap_delete_bin_const(old_psk_key);
1942
1943 return 1;
1944}
1945
1946int
1948 const coap_bin_const_t *psk_identity
1949 ) {
1950 /* We may be refreshing the identity with the same identity */
1951 coap_bin_const_t *old_psk_identity = session->psk_identity;
1952
1953 if (psk_identity && psk_identity->s) {
1954 if (session->psk_identity) {
1955 if (coap_binary_equal(session->psk_identity, psk_identity))
1956 return 1;
1957 }
1958 session->psk_identity = coap_new_bin_const(psk_identity->s,
1959 psk_identity->length);
1960 if (!session->psk_identity) {
1961 coap_log_err("No memory to store pre-shared key identity (PSK)\n");
1962 if (old_psk_identity)
1963 coap_delete_bin_const(old_psk_identity);
1964 return 0;
1965 }
1966 } else {
1967 session->psk_identity = NULL;
1968 }
1969 if (old_psk_identity)
1970 coap_delete_bin_const(old_psk_identity);
1971
1972 return 1;
1973}
1974
1975#if COAP_SERVER_SUPPORT
1976const coap_bin_const_t *
1978 if (session)
1979 return session->psk_hint;
1980 return NULL;
1981}
1982#endif /* COAP_SERVER_SUPPORT */
1983
1984const coap_bin_const_t *
1986 const coap_bin_const_t *psk_identity = NULL;
1987 if (session) {
1988 psk_identity = session->psk_identity;
1989 if (psk_identity == NULL) {
1990 psk_identity = &session->cpsk_setup_data.psk_info.identity;
1991 }
1992 }
1993 return psk_identity;
1994}
1995
1996const coap_bin_const_t *
1998 if (session)
1999 return session->psk_key;
2000 return NULL;
2001}
2002
2003#if COAP_CLIENT_SUPPORT
2006 const coap_address_t *local_if,
2007 const coap_address_t *server,
2008 coap_proto_t proto,
2009 coap_dtls_pki_t *setup_data) {
2010 coap_session_t *session;
2011
2012 coap_lock_lock(return NULL);
2013 session = coap_new_client_session_pki_lkd(ctx, local_if, server, proto, setup_data);
2015 return session;
2016}
2017
2020 const coap_address_t *local_if,
2021 const coap_address_t *server,
2022 coap_proto_t proto,
2023 coap_dtls_pki_t *setup_data) {
2024 coap_session_t *session;
2025 coap_dtls_pki_t l_setup_data;
2026
2027 if (!setup_data)
2028 return NULL;
2029 if (setup_data->version != COAP_DTLS_PKI_SETUP_VERSION) {
2030 coap_log_err("coap_new_client_session_pki: Wrong version of setup_data\n");
2031 return NULL;
2032 }
2033
2035 l_setup_data = *setup_data;
2036 coap_sanitize_client_sni(&l_setup_data.client_sni);
2037
2038 session = coap_session_create_client(ctx, local_if, server, proto);
2039
2040 if (!session) {
2041 return NULL;
2042 }
2043
2045 /* we know that setup_data is not NULL */
2046 if (!coap_dtls_context_set_pki(ctx, &l_setup_data, COAP_DTLS_ROLE_CLIENT)) {
2047 coap_session_release_lkd(session);
2048 return NULL;
2049 }
2050 }
2051 coap_log_debug("***%s: new outgoing session\n",
2052 coap_session_str(session));
2053 coap_session_check_connect(session);
2054 return session;
2055}
2056#endif /* ! COAP_CLIENT_SUPPORT */
2057
2058#if COAP_SERVER_SUPPORT
2059#if !COAP_DISABLE_TCP
2062 coap_session_t *session;
2063 coap_tick_t now;
2064
2066 NULL, NULL, NULL, 0, ctx, ep);
2067 if (!session)
2068 goto error;
2069
2070 memcpy(session->sock.lfunc, ep->sock.lfunc, sizeof(session->sock.lfunc));
2071 if (!coap_netif_strm_accept(ep, session, extra))
2072 goto error;
2073
2074 coap_make_addr_hash(&session->addr_hash, session->proto, &session->addr_info);
2075
2076#ifdef COAP_EPOLL_SUPPORT
2077 session->sock.session = session;
2078 coap_epoll_ctl_add(&session->sock,
2079 EPOLLIN,
2080 __func__);
2081#endif /* COAP_EPOLL_SUPPORT */
2082 SESSIONS_ADD(ep->sessions, session);
2083 if (session) {
2084 coap_ticks(&now);
2085 session->last_rx_tx = now;
2086 coap_log_debug("***%s: session %p: new incoming session\n",
2087 coap_session_str(session), (void *)session);
2091 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
2092 }
2093 return session;
2094
2095error:
2096 /*
2097 * Need to add in the session as coap_session_release_lkd()
2098 * will call SESSIONS_DELETE in coap_session_free().
2099 */
2100 if (session) {
2101 SESSIONS_ADD(ep->sessions, session);
2102 coap_session_free(session);
2103 }
2104 return NULL;
2105}
2106#endif /* !COAP_DISABLE_TCP */
2107#endif /* COAP_SERVER_SUPPORT */
2108
2109void
2111 const uint8_t *data) {
2112 session->tx_token = coap_decode_var_bytes8(data, len);
2113 /*
2114 * Decrement as when first used by coap_session_new_token() it will
2115 * get incremented
2116 */
2117 session->tx_token--;
2118}
2119
2120void
2122 uint8_t *data) {
2123 *len = coap_encode_var_safe8(data,
2124 sizeof(session->tx_token), ++session->tx_token);
2125}
2126
2127COAP_API uint16_t
2129 uint16_t mid;
2130
2131 coap_lock_lock(return 0);
2132 mid = coap_new_message_id_lkd(session);
2134 return mid;
2135}
2136
2137uint16_t
2140 if (COAP_PROTO_NOT_RELIABLE(session->proto))
2141 return ++session->tx_mid;
2142 /* TCP/TLS have no notion of mid */
2143 return 0;
2144}
2145
2146const coap_address_t *
2148 if (session)
2149 return &session->addr_info.remote;
2150 return NULL;
2151}
2152
2153const coap_address_t *
2155 if (session)
2156 return &session->addr_info.local;
2157 return NULL;
2158}
2159
2160const coap_address_t *
2162#if COAP_CLIENT_SUPPORT
2163 if (session && session->type == COAP_SESSION_TYPE_CLIENT &&
2164 session->sock.flags & COAP_SOCKET_MULTICAST)
2165 return &session->sock.mcast_addr;
2166#else /* ! COAP_CLIENT_SUPPORT */
2167 (void)session;
2168#endif /* ! COAP_CLIENT_SUPPORT */
2169 return NULL;
2170}
2171
2174 if (session)
2175 return session->context;
2176 return NULL;
2177}
2178
2181 if (session)
2182 return session->proto;
2183 return 0;
2184}
2185
2188 if (session)
2189 return session->type;
2190 return 0;
2191}
2192
2193COAP_API int
2195 int ret;
2196
2197 coap_lock_lock(return 0);
2198 ret = coap_session_set_type_client_lkd(session);
2200 return ret;
2201}
2202
2203int
2205#if COAP_SERVER_SUPPORT
2206 if (session && session->type == COAP_SESSION_TYPE_SERVER) {
2208 session->type = COAP_SESSION_TYPE_CLIENT;
2209 return 1;
2210 }
2211#else /* ! COAP_SERVER_SUPPORT */
2212 (void)session;
2213#endif /* ! COAP_SERVER_SUPPORT */
2214 return 0;
2215}
2216
2219 if (session)
2220 return session->state;
2221 return 0;
2222}
2223
2226#if COAP_SERVER_SUPPORT
2227 if (session)
2228 return session->endpoint;
2229#else /* ! COAP_SERVER_SUPPORT */
2230 (void)session;
2231#endif /* ! COAP_SERVER_SUPPORT */
2232 return 0;
2233}
2234
2235int
2237 if (session)
2238 return session->ifindex;
2239 return -1;
2240}
2241
2242void *
2244 coap_tls_library_t *tls_lib) {
2245 if (session)
2246 return coap_dtls_get_tls(session, tls_lib);
2247 return NULL;
2248}
2249
2250static const char *
2252 switch (proto) {
2253 case COAP_PROTO_UDP:
2254 return "UDP ";
2255 case COAP_PROTO_DTLS:
2256 return "DTLS";
2257 case COAP_PROTO_TCP:
2258 return "TCP ";
2259 case COAP_PROTO_TLS:
2260 return "TLS ";
2261 case COAP_PROTO_WS:
2262 return "WS ";
2263 case COAP_PROTO_WSS:
2264 return "WSS ";
2265 case COAP_PROTO_NONE:
2266 case COAP_PROTO_LAST:
2267 default:
2268 return "????" ;
2269 break;
2270 }
2271 return NULL;
2272}
2273
2274#if COAP_SERVER_SUPPORT
2276coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto) {
2277 coap_endpoint_t *endpoint;
2278
2279 coap_lock_lock(return NULL);
2280 endpoint = coap_new_endpoint_lkd(context, listen_addr, proto);
2282 return endpoint;
2283}
2284
2286coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr,
2287 coap_proto_t proto) {
2288 coap_endpoint_t *ep = NULL;
2289
2290 if (!context || !listen_addr) {
2291 coap_log_debug("coap_new_endpoint: Both context and listen_addr need to be defined\n");
2292 return NULL;
2293 }
2294
2296
2297 switch (proto) {
2298 case COAP_PROTO_UDP:
2299 break;
2300 case COAP_PROTO_DTLS:
2301 if (!coap_dtls_is_supported()) {
2302 coap_log_warn("coap_new_endpoint: DTLS not supported\n");
2303 return NULL;
2304 }
2305 break;
2306 case COAP_PROTO_TLS:
2307 if (!coap_tls_is_supported()) {
2308 coap_log_warn("coap_new_endpoint: TLS not supported\n");
2309 return NULL;
2310 }
2311 break;
2312 case COAP_PROTO_TCP:
2313 if (!coap_tcp_is_supported()) {
2314 coap_log_warn("coap_new_endpoint: TCP not supported\n");
2315 return NULL;
2316 }
2317 break;
2318 case COAP_PROTO_WS:
2319 if (!coap_ws_is_supported()) {
2320 coap_log_warn("coap_new_endpoint: WS not supported\n");
2321 return NULL;
2322 }
2323 break;
2324 case COAP_PROTO_WSS:
2325 if (!coap_wss_is_supported()) {
2326 coap_log_warn("coap_new_endpoint: WSS not supported\n");
2327 return NULL;
2328 }
2329 break;
2330 case COAP_PROTO_NONE:
2331 case COAP_PROTO_LAST:
2332 default:
2333 coap_log_crit("coap_new_endpoint: Unsupported protocol %d\n", proto);
2334 return NULL;
2335 }
2336
2337 if (proto == COAP_PROTO_DTLS || proto == COAP_PROTO_TLS ||
2338 proto == COAP_PROTO_WSS) {
2340 coap_log_info("coap_new_endpoint: one of coap_context_set_psk() or "
2341 "coap_context_set_pki() not called\n");
2342 return NULL;
2343 }
2344 }
2345 ep = coap_malloc_endpoint();
2346 if (!ep) {
2347 coap_log_warn("coap_new_endpoint: malloc");
2348 return NULL;
2349 }
2350
2351 memset(ep, 0, sizeof(coap_endpoint_t));
2352 ep->context = context;
2353 ep->proto = proto;
2354 ep->sock.endpoint = ep;
2355 memcpy(&ep->sock.lfunc, coap_layers_coap[proto], sizeof(ep->sock.lfunc));
2356
2357 if (COAP_PROTO_NOT_RELIABLE(proto)) {
2358 if (!coap_netif_dgrm_listen(ep, listen_addr))
2359 goto error;
2360#ifdef WITH_CONTIKI
2361 ep->sock.context = context;
2362#endif /* WITH_CONTIKI */
2363#if !COAP_DISABLE_TCP
2364 } else if (COAP_PROTO_RELIABLE(proto)) {
2365 if (!coap_netif_strm_listen(ep, listen_addr))
2366 goto error;
2367#endif /* !COAP_DISABLE_TCP */
2368 } else {
2369 coap_log_crit("coap_new_endpoint: Protocol type not supported %d\n", proto);
2370 goto error;
2371 }
2372
2374#ifndef INET6_ADDRSTRLEN
2375#define INET6_ADDRSTRLEN 40
2376#endif
2377 unsigned char addr_str[INET6_ADDRSTRLEN + 8];
2378
2379 if (coap_print_addr(&ep->bind_addr, addr_str, INET6_ADDRSTRLEN + 8)) {
2380 coap_log_debug("created %s endpoint %s\n", coap_proto_name(ep->proto),
2381 addr_str);
2382 }
2383 }
2384
2386
2387#ifdef COAP_EPOLL_SUPPORT
2388 ep->sock.endpoint = ep;
2390 EPOLLIN,
2391 __func__);
2392#endif /* COAP_EPOLL_SUPPORT */
2393
2394 LL_PREPEND(context->endpoint, ep);
2395 return ep;
2396
2397error:
2399 return NULL;
2400}
2401
2402void
2404 ep->default_mtu = (uint16_t)mtu;
2405}
2406
2407COAP_API void
2409 if (ep) {
2410 coap_context_t *context = ep->context;
2411 if (context) {
2412 coap_lock_lock(return);
2413 }
2415 if (context) {
2417 }
2418 }
2419}
2420
2421void
2423 if (ep) {
2424 coap_session_t *session, *rtmp;
2425
2426 if (ep->context) {
2427 /* If fully allocated and inserted */
2429 SESSIONS_ITER_SAFE(ep->sessions, session, rtmp) {
2430 assert(session->ref == 0);
2431 if (session->ref == 0) {
2433 coap_session_free(session);
2434 }
2435 }
2436 if (coap_netif_available_ep(ep)) {
2437 /*
2438 * ep->sock.endpoint is set in coap_new_endpoint().
2439 * ep->sock.session is never set.
2440 *
2441 * session->sock.session is set for both clients and servers (when a
2442 * new session is accepted), but does not affect the endpoint.
2443 *
2444 * So, it is safe to call coap_netif_close_ep() after all the sessions
2445 * have been freed above as we are only working with the endpoint sock.
2446 */
2447#ifdef COAP_EPOLL_SUPPORT
2448 assert(ep->sock.session == NULL);
2449#endif /* COAP_EPOLL_SUPPORT */
2451 }
2452
2453 if (ep->context->endpoint) {
2454 LL_DELETE(ep->context->endpoint, ep);
2455 }
2456 }
2457
2458 if (ep->app_cb) {
2459 ep->app_cb(ep->app_data);
2460 }
2461
2463 }
2464}
2465
2466void *
2468 assert(endpoint);
2469 return endpoint->app_data;
2470}
2471
2472COAP_API void *
2473coap_endpoint_set_app_data(coap_endpoint_t *endpoint, void *app_data,
2475 void *old_data;
2476
2477 coap_lock_lock(return NULL);
2478 old_data = coap_endpoint_set_app_data_lkd(endpoint, app_data, callback);
2480 return old_data;
2481}
2482
2483void *
2484coap_endpoint_set_app_data_lkd(coap_endpoint_t *endpoint, void *app_data,
2486 void *old_data = endpoint->app_data;
2487
2488 endpoint->app_data = app_data;
2489 endpoint->app_cb = app_data ? callback : NULL;
2490 return old_data;
2491}
2492
2493#endif /* COAP_SERVER_SUPPORT */
2494
2497 const coap_address_t *remote_addr,
2498 int ifindex) {
2499 coap_session_t *s, *rtmp;
2500#if COAP_CLIENT_SUPPORT
2501 SESSIONS_ITER(ctx->sessions, s, rtmp) {
2502 if (s->ifindex == ifindex) {
2503 if (s->sock.flags & COAP_SOCKET_MULTICAST) {
2504 if (coap_address_equals(&s->sock.mcast_addr, remote_addr))
2505 return s;
2506 } else if (coap_address_equals(&s->addr_info.remote, remote_addr))
2507 return s;
2508 }
2509 }
2510#endif /* COAP_CLIENT_SUPPORT */
2511#if COAP_SERVER_SUPPORT
2512 coap_endpoint_t *ep;
2513
2514 LL_FOREACH(ctx->endpoint, ep) {
2515 SESSIONS_ITER(ep->sessions, s, rtmp) {
2516 if (s->ifindex == ifindex && coap_address_equals(&s->addr_info.remote,
2517 remote_addr))
2518 return s;
2519 }
2520 }
2521#endif /* COAP_SERVER_SUPPORT */
2522 return NULL;
2523}
2524
2525#ifndef INET6_ADDRSTRLEN
2526#define INET6_ADDRSTRLEN 46
2527#endif
2528const char *
2530 static char szSession[2 * (INET6_ADDRSTRLEN + 8) + 24];
2531 char *p = szSession, *end = szSession + sizeof(szSession);
2532 if (coap_print_addr(&session->addr_info.local,
2533 (unsigned char *)p, end - p) > 0)
2534 p += strlen(p);
2535 if (p + 6 < end) {
2536 strcpy(p, " <-> ");
2537 p += 5;
2538 }
2539 if (p + 1 < end) {
2540 if (coap_print_addr(&session->addr_info.remote,
2541 (unsigned char *)p, end - p) > 0)
2542 p += strlen(p);
2543 }
2544 if (session->ifindex > 0 && p + 1 < end)
2545 p += snprintf(p, end - p, " (if%d)", session->ifindex);
2546 if (p + 6 < end) {
2547 strcpy(p, " ");
2548 p++;
2549 strcpy(p, coap_proto_name(session->proto));
2550 }
2551
2552 return szSession;
2553}
2554
2555#if COAP_SERVER_SUPPORT
2556const char *
2557coap_endpoint_str(const coap_endpoint_t *endpoint) {
2558 static char szEndpoint[128];
2559 char *p = szEndpoint, *end = szEndpoint + sizeof(szEndpoint);
2560 if (coap_print_addr(&endpoint->bind_addr, (unsigned char *)p, end - p) > 0)
2561 p += strlen(p);
2562 if (p + 6 < end) {
2563 if (endpoint->proto == COAP_PROTO_UDP) {
2564 strcpy(p, " UDP");
2565 } else if (endpoint->proto == COAP_PROTO_DTLS) {
2566 strcpy(p, " DTLS");
2567 } else {
2568 strcpy(p, " NONE");
2569 }
2570 }
2571
2572 return szEndpoint;
2573}
2574#endif /* COAP_SERVER_SUPPORT */
2575#if COAP_CLIENT_SUPPORT
2576void
2578 session->no_observe_cancel = 1;
2579}
2580#endif /* COAP_CLIENT_SUPPORT */
2581#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:190
#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:4880
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:230
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:2943
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:1347
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:1231
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:1845
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition coap_net.c:1257
coap_queue_t * coap_new_node(void)
Creates a new node suitable for adding to the CoAP sendqueue.
Definition coap_net.c:259
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:3047
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:3086
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:55
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:103
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:241
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:1655
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
Definition coap_pdu.c:194
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:417
#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:1517
#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:783
#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:102
#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:1109
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)
unsigned ref_proxy_subs
reference count of current proxy subscriptions
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