libcoap 4.3.5-develop-fada39d
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(session->context, return NULL);
351 coap_lock_unlock(session->context);
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(context, return);
371 coap_lock_unlock(context);
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(session->context, return);
402 coap_session_set_app_data2_lkd(session, app_data, NULL);
403 coap_lock_unlock(session->context);
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(session->context, return NULL);
418 old_data = coap_session_set_app_data2_lkd(session, app_data, callback);
419 coap_lock_unlock(session->context);
420 return old_data;
421}
422
423void *
426 void *old_data = session->app_data;
427
428 session->app_data = app_data;
429 session->app_cb = app_data ? callback : NULL;
430 return old_data;
431}
432
433static coap_session_t *
435 const coap_addr_hash_t *addr_hash,
436 const coap_address_t *local_addr,
437 const coap_address_t *remote_addr, int ifindex,
438 coap_context_t *context, coap_endpoint_t *endpoint) {
440 sizeof(coap_session_t));
441#if ! COAP_SERVER_SUPPORT
442 (void)endpoint;
443#endif /* ! COAP_SERVER_SUPPORT */
444 if (!session)
445 return NULL;
446 memset(session, 0, sizeof(*session));
447 session->proto = proto;
448 session->type = type;
449 if (addr_hash)
450 memcpy(&session->addr_hash, addr_hash, sizeof(session->addr_hash));
451 else
452 memset(&session->addr_hash, 0, sizeof(session->addr_hash));
453 if (local_addr) {
454 coap_address_copy(&session->addr_info.local, local_addr);
455#if COAP_CLIENT_SUPPORT
456 coap_address_copy(&session->local_reconnect, local_addr);
457#endif /* COAP_CLIENT_SUPPORT */
458 } else {
460#if COAP_CLIENT_SUPPORT
462#endif /* COAP_CLIENT_SUPPORT */
463 }
464 if (remote_addr)
465 coap_address_copy(&session->addr_info.remote, remote_addr);
466 else
468 session->ifindex = ifindex;
469 session->context = context;
470#if COAP_SERVER_SUPPORT
471 session->endpoint = endpoint;
472 if (endpoint)
473 session->mtu = endpoint->default_mtu;
474 else
475#endif /* COAP_SERVER_SUPPORT */
477 session->block_mode = context->block_mode;
478 if (proto == COAP_PROTO_DTLS) {
479 session->tls_overhead = 29;
480 if (session->tls_overhead >= session->mtu) {
481 session->tls_overhead = session->mtu;
482 coap_log_err("DTLS overhead exceeds MTU\n");
483 }
484 }
488 session->nstart = COAP_DEFAULT_NSTART;
491#if COAP_Q_BLOCK_SUPPORT
492 session->max_payloads = COAP_DEFAULT_MAX_PAYLOADS;
493 session->non_max_retransmit = COAP_DEFAULT_NON_MAX_RETRANSMIT;
494 session->non_timeout = COAP_DEFAULT_NON_TIMEOUT;
495 session->non_receive_timeout = COAP_DEFAULT_NON_RECEIVE_TIMEOUT;
496 coap_session_fix_non_probing_wait_base(session);
497 coap_session_fix_non_partial_timeout(session);
498#endif /* COAP_Q_BLOCK_SUPPORT */
499 session->dtls_event = -1;
504 session->max_token_size = context->max_token_size; /* RFC8974 */
505 if (session->type != COAP_SESSION_TYPE_CLIENT)
507
508 /* Randomly initialize */
509 /* TCP/TLS have no notion of mid */
510 if (COAP_PROTO_NOT_RELIABLE(session->proto))
511 coap_prng_lkd((unsigned char *)&session->tx_mid, sizeof(session->tx_mid));
512 coap_prng_lkd((unsigned char *)&session->tx_rtag, sizeof(session->tx_rtag));
513
514 return session;
515}
516
517void
519 coap_queue_t *q, *tmp;
520 coap_lg_xmit_t *lq, *ltmp;
521
522#if COAP_CLIENT_SUPPORT
523 coap_lg_crcv_t *lg_crcv, *etmp;
524
525 /* Need to do this before (D)TLS and socket is closed down */
526 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
527 if (lg_crcv->observe_set && session->no_observe_cancel == 0) {
528 /* Need to close down observe */
529 if (coap_cancel_observe_lkd(session, lg_crcv->app_token, COAP_MESSAGE_NON)) {
530 /* Need to delete node we set up for NON */
531 coap_queue_t *queue = session->context->sendqueue;
532
533 while (queue) {
534 if (queue->session == session) {
536 break;
537 }
538 queue = queue->next;
539 }
540 }
541 }
542 LL_DELETE(session->lg_crcv, lg_crcv);
543 coap_block_delete_lg_crcv(session, lg_crcv);
544 }
545#endif /* COAP_CLIENT_SUPPORT */
546
547 if (session->partial_pdu)
549 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
550 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
551 if (session->psk_identity)
553 if (session->psk_key)
555 if (session->psk_hint)
557
558#if COAP_SERVER_SUPPORT
559 coap_cache_entry_t *cp, *ctmp;
560 HASH_ITER(hh, session->context->cache, cp, ctmp) {
561 /* cp->session is NULL if not session based */
562 if (cp->session == session) {
563 coap_delete_cache_entry(session->context, cp);
564 }
565 }
566#endif /* COAP_SERVER_SUPPORT */
567 LL_FOREACH_SAFE(session->delayqueue, q, tmp) {
568 if (q->pdu->type==COAP_MESSAGE_CON) {
569 coap_handle_nack(session, q->pdu,
570 session->proto == COAP_PROTO_DTLS ?
572 q->id);
573 }
575 }
576 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
577 LL_DELETE(session->lg_xmit, lq);
578 coap_block_delete_lg_xmit(session, lq);
579 }
580#if COAP_SERVER_SUPPORT
581 coap_lg_srcv_t *sq, *stmp;
582
583 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
584 LL_DELETE(session->lg_srcv, sq);
585 coap_block_delete_lg_srcv(session, sq);
586 }
587#endif /* COAP_SERVER_SUPPORT */
588#if COAP_OSCORE_SUPPORT
590#endif /* COAP_OSCORE_SUPPORT */
591#if COAP_WS_SUPPORT
592 coap_free_type(COAP_STRING, session->ws);
593 coap_delete_str_const(session->ws_host);
594#endif /* COAP_WS_SUPPORT */
595}
596
597void
599 if (!session)
600 return;
602 assert(session->ref == 0);
603 if (session->ref)
604 return;
605 /* Make sure nothing gets deleted under our feet */
607 coap_session_mfree(session);
608#if COAP_SERVER_SUPPORT
610 if (session->endpoint) {
611 if (session->endpoint->sessions)
612 SESSIONS_DELETE(session->endpoint->sessions, session);
613 } else
614#endif /* COAP_SERVER_SUPPORT */
615#if COAP_CLIENT_SUPPORT
616 if (session->context) {
617 if (session->context->sessions)
618 SESSIONS_DELETE(session->context->sessions, session);
619 }
621#endif /* COAP_CLIENT_SUPPORT */
623 coap_delete_bin_const(session->echo);
624#if COAP_SERVER_SUPPORT
626#endif /* COAP_SERVER_SUPPORT */
627 coap_log_debug("***%s: session %p: closed\n", coap_session_str(session),
628 (void *)session);
629
630 if (session->app_cb) {
631 session->app_cb(session->app_data);
632 }
633 assert(session->ref == 1);
635}
636
637#if COAP_SERVER_SUPPORT
638void
640 int i;
641
644 coap_cancel_all_messages(session->context, session, NULL);
645 RESOURCES_ITER(session->context->resources, r) {
646 /* In case code is broken somewhere */
647 for (i = 0; i < 1000; i++) {
648 if (!coap_delete_observer(r, session, NULL))
649 break;
650 }
651 }
652 if (session->context->unknown_resource) {
653 /* In case code is broken somewhere */
654 for (i = 0; i < 1000; i++) {
655 if (!coap_delete_observer(session->context->unknown_resource, session, NULL))
656 break;
657 }
658 }
659 if (session->context->proxy_uri_resource) {
660 /* In case code is broken somewhere */
661 for (i = 0; i < 1000; i++) {
662 if (!coap_delete_observer(session->context->proxy_uri_resource, session, NULL))
663 break;
664 }
665 }
666 while (session->delayqueue) {
667 coap_queue_t *q = session->delayqueue;
668
669 session->delayqueue = q->next;
671 }
672 /* Force session to go away */
675
677}
678#endif /* COAP_SERVER_SUPPORT */
679
680static size_t
682 size_t max_with_header) {
683#if COAP_DISABLE_TCP
684 (void)session;
685 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
686 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
687 : 0;
688#else /* !COAP_DISABLE_TCP */
689 if (COAP_PROTO_NOT_RELIABLE(session->proto))
690 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
691 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
692 : 0;
693 /* we must assume there is no token to be on the safe side */
694 if (max_with_header <= 2)
695 return 0;
696 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP0 + 2)
697 return max_with_header - 2;
698 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP8 + 3)
699 return max_with_header - 3;
700 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP16 + 4)
701 return max_with_header - 4;
702 else
703 return max_with_header - COAP_PDU_MAX_TCP_HEADER_SIZE;
704#endif /* !COAP_DISABLE_TCP */
705}
706
707size_t
709 if (session->csm_rcv_mtu)
711 (size_t)(session->csm_rcv_mtu));
712
714 (size_t)(session->mtu - session->tls_overhead));
715}
716
717COAP_API size_t
719 size_t size;
720 coap_session_t *session_rw;
721
722 /*
723 * Need to do this to not get a compiler warning about const parameters
724 * but need to maintain source code backward compatibility
725 */
726 memcpy(&session_rw, &session, sizeof(session_rw));
727 coap_lock_lock(session_rw->context, return 0);
728 size = coap_session_max_pdu_size_lkd(session_rw);
729 coap_lock_unlock(session_rw->context);
730 return size;
731}
732
733size_t
735 size_t max_with_header;
736
738#if COAP_CLIENT_SUPPORT
739 /*
740 * Delay if session->doing_first is set.
741 * E.g. Reliable and CSM not in yet for checking block support
742 */
743 coap_session_t *session_rw;
744
745 /*
746 * Need to do this to not get a compiler warning about const parameters
747 * but need to maintain source code backward compatibility
748 */
749 memcpy(&session_rw, &session, sizeof(session_rw));
750 if (coap_client_delay_first(session_rw) == 0) {
751 coap_log_debug("coap_client_delay_first: timeout\n");
752 /* Have to go with the defaults */
753 }
754#endif /* COAP_CLIENT_SUPPORT */
755
756 max_with_header = (size_t)(session->mtu - session->tls_overhead);
757
758 return coap_session_max_pdu_size_internal(session, max_with_header);
759}
760
761void
762coap_session_set_mtu(coap_session_t *session, unsigned mtu) {
763#if defined(WITH_CONTIKI) || defined(WITH_LWIP)
764 if (mtu > COAP_DEFAULT_MAX_PDU_RX_SIZE)
765 mtu = COAP_DEFAULT_MAX_PDU_RX_SIZE;
766#endif
767 if (mtu < 64)
768 mtu = 64;
769 session->mtu = mtu;
770 if (session->tls_overhead >= session->mtu) {
771 session->tls_overhead = session->mtu;
772 coap_log_err("DTLS overhead exceeds MTU\n");
773 }
774}
775
776ssize_t
778 coap_queue_t *node) {
779 if (node) {
780 coap_queue_t *removed = NULL;
781 coap_remove_from_queue(&session->context->sendqueue, session, node->id, &removed);
782 assert(removed == node);
784 node->session = NULL;
785 node->t = 0;
786 } else {
787 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
788 coap_queue_t *q = NULL;
789 /* Check same mid is not getting re-used in violation of RFC7252 */
790 LL_FOREACH(session->delayqueue, q) {
791 if (q->id == pdu->mid) {
792 coap_log_err("** %s: mid=0x%04x: already in-use - dropped\n",
793 coap_session_str(session), pdu->mid);
794 return COAP_INVALID_MID;
795 }
796 }
797 }
798 node = coap_new_node();
799 if (node == NULL)
800 return COAP_INVALID_MID;
801 node->id = pdu->mid;
802 node->pdu = pdu;
803 if (pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
804 uint8_t r;
805 coap_prng_lkd(&r, sizeof(r));
806 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
807 node->timeout = coap_calc_timeout(session, r);
808 }
809 }
810 LL_APPEND(session->delayqueue, node);
811 coap_log_debug("** %s: mid=0x%04x: delayed\n",
812 coap_session_str(session), node->id);
813 return COAP_PDU_DELAYED;
814}
815
816#if !COAP_DISABLE_TCP
817void
819 coap_pdu_t *pdu;
820 uint8_t buf[4];
821 assert(COAP_PROTO_RELIABLE(session->proto));
822 coap_log_debug("***%s: sending CSM\n", coap_session_str(session));
823 session->state = COAP_SESSION_STATE_CSM;
824 session->partial_write = 0;
825 if (session->mtu == 0)
826 coap_session_set_mtu(session, COAP_DEFAULT_MTU); /* base value */
828 if (pdu == NULL
830 coap_encode_var_safe(buf, sizeof(buf),
831 session->context->csm_max_message_size), buf) == 0
833 coap_encode_var_safe(buf, sizeof(buf),
834 0), buf) == 0
835 || (session->max_token_size > COAP_TOKEN_DEFAULT_MAX &&
838 coap_encode_var_safe(buf, sizeof(buf),
839 session->max_token_size),
840 buf) == 0)
841 || coap_pdu_encode_header(pdu, session->proto) == 0
842 ) {
844 } else {
845 ssize_t bytes_written;
846
847 pdu->session = session;
848 bytes_written = coap_session_send_pdu(session, pdu);
849 if (bytes_written != (ssize_t)pdu->used_size + pdu->hdr_size) {
851 } else {
852 session->csm_rcv_mtu = session->context->csm_max_message_size;
853 if (session->csm_rcv_mtu > COAP_BERT_BASE)
854 session->csm_bert_loc_support = 1;
855 else
856 session->csm_bert_loc_support = 0;
857 }
858 }
859 if (pdu)
861}
862#endif /* !COAP_DISABLE_TCP */
863
866 coap_mid_t mid;
867
868 coap_lock_lock(session->context, return COAP_INVALID_MID);
869 mid = coap_session_send_ping_lkd(session);
870 coap_lock_unlock(session->context);
871 return mid;
872}
873
876 coap_pdu_t *ping = NULL;
877
879 if (session->state != COAP_SESSION_STATE_ESTABLISHED ||
880 session->con_active)
881 return COAP_INVALID_MID;
882 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
883 uint16_t mid = coap_new_message_id_lkd(session);
884 ping = coap_pdu_init(COAP_MESSAGE_CON, 0, mid, 0);
885 }
886#if !COAP_DISABLE_TCP
887 else {
889 }
890#endif /* !COAP_DISABLE_TCP */
891 if (!ping)
892 return COAP_INVALID_MID;
893 return coap_send_internal(session, ping, NULL);
894}
895
896void
898 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
899 coap_log_debug("***%s: session connected\n",
900 coap_session_str(session));
901 if (session->state == COAP_SESSION_STATE_CSM) {
903#if COAP_CLIENT_SUPPORT
905#endif /* COAP_CLIENT_SUPPORT */
906 if (session->doing_first)
907 session->doing_first = 0;
908 }
909 }
910
912 session->partial_write = 0;
913
914 if (session->proto==COAP_PROTO_DTLS) {
915 session->tls_overhead = coap_dtls_get_overhead(session);
916 if (session->tls_overhead >= session->mtu) {
917 session->tls_overhead = session->mtu;
918 coap_log_err("DTLS overhead exceeds MTU\n");
919 }
920 }
921
922 while (session->delayqueue && session->state == COAP_SESSION_STATE_ESTABLISHED) {
923 ssize_t bytes_written;
924 coap_queue_t *q = session->delayqueue;
925 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
926 if (session->con_active >= COAP_NSTART(session))
927 break;
928 session->con_active++;
929 }
930 /* Take entry off the queue */
931 session->delayqueue = q->next;
932 q->next = NULL;
933
934 coap_log_debug("** %s: mid=0x%04x: transmitted after delay\n",
935 coap_session_str(session), (int)q->pdu->mid);
936 bytes_written = coap_session_send_pdu(session, q->pdu);
937 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
938 if (coap_wait_ack(session->context, session, q) >= 0)
939 q = NULL;
940 }
941 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
942 if (q)
944 if (bytes_written < 0)
945 break;
946 } else if (q) {
947 if (bytes_written <= 0 || (size_t)bytes_written < q->pdu->used_size + q->pdu->hdr_size) {
948 q->next = session->delayqueue;
949 session->delayqueue = q;
950 if (bytes_written > 0)
951 session->partial_write = (size_t)bytes_written;
952 break;
953 } else {
955 }
956 }
957 }
958}
959
960#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
961static const char *
963 switch (reason) {
965 return "COAP_NACK_TOO_MANY_RETRIES";
967 return "COAP_NACK_NOT_DELIVERABLE";
968 case COAP_NACK_RST:
969 return "COAP_NACK_RST";
971 return "COAP_NACK_TLS_FAILED";
973 return "COAP_NACK_ICMP_ISSUE";
975 return "COAP_NACK_BAD_RESPONSE";
977 return "COAP_NACK_TLS_LAYER_FAILED";
979 return "COAP_NACK_WS_LAYER_FAILED";
981 return "COAP_NACK_WS_FAILED";
982 default:
983 return "???";
984 }
985}
986#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
987
988void
990 coap_pdu_t *sent,
991 const coap_nack_reason_t reason,
992 const coap_mid_t mid) {
993 if (session->context->nack_handler) {
994 coap_bin_const_t token = {0, NULL};
995
996 if (sent) {
997 coap_check_update_token(session, sent);
998 token = sent->actual_token;
999 }
1000 coap_lock_callback(session->context,
1001 session->context->nack_handler(session, sent, reason, mid));
1002 if (sent) {
1003 coap_update_token(sent, token.length, token.s);
1004 }
1005 }
1006#if COAP_CLIENT_SUPPORT
1007 if (reason != COAP_NACK_ICMP_ISSUE) {
1008 session->doing_send_recv = 0;
1009 }
1010#endif /* COAP_CLIENT_SUPPORT */
1011}
1012
1013COAP_API void
1015 coap_lock_lock(session->context, return);
1016 coap_session_disconnected_lkd(session, reason);
1017 coap_lock_unlock(session->context);
1018}
1019
1020void
1022#if !COAP_DISABLE_TCP
1023 coap_session_state_t state = session->state;
1024#endif /* !COAP_DISABLE_TCP */
1025 coap_lg_xmit_t *lq, *ltmp;
1026#if COAP_SERVER_SUPPORT
1027 coap_lg_srcv_t *sq, *stmp;
1028#endif /* COAP_SERVER_SUPPORT */
1029#if COAP_CLIENT_SUPPORT
1030 coap_lg_crcv_t *cq, *etmp;
1031#endif /* COAP_CLIENT_SUPPORT */
1032 int sent_nack = 0;
1033 coap_queue_t *q;
1034
1036#if COAP_CLIENT_SUPPORT
1037 coap_session_failed(session);
1038#endif /* COAP_CLIENT_SUPPORT */
1039
1040 q = session->context->sendqueue;
1041 while (q) {
1042 if (q->session == session) {
1043 /* Take the first one */
1044 coap_handle_nack(session, q->pdu, reason, q->id);
1045 sent_nack = 1;
1046 break;
1047 }
1048 q = q->next;
1049 }
1050
1051 if (reason != COAP_NACK_ICMP_ISSUE) {
1052 while (session->delayqueue) {
1053 q = session->delayqueue;
1054 session->delayqueue = q->next;
1055 q->next = NULL;
1056 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1057 coap_session_str(session), q->id);
1058 if (q->pdu->type == COAP_MESSAGE_CON) {
1059 coap_handle_nack(session, q->pdu, reason, q->id);
1060 sent_nack = 1;
1061 }
1062
1063#if COAP_CLIENT_SUPPORT
1064 session->doing_send_recv = 0;
1065#endif /* COAP_CLIENT_SUPPORT */
1067 }
1068 }
1069#if COAP_CLIENT_SUPPORT
1070 if (!sent_nack && session->lg_crcv) {
1071 /* Take the first one */
1072 coap_handle_nack(session, &session->lg_crcv->pdu, reason, session->lg_crcv->pdu.mid);
1073 sent_nack = 1;
1074 }
1075#endif /* COAP_CLIENT_SUPPORT */
1076 if (!sent_nack) {
1077 /* Unable to determine which request disconnection was for */
1078 coap_handle_nack(session, NULL, reason, 0);
1079 }
1080 if (reason == COAP_NACK_ICMP_ISSUE) {
1081 coap_log_debug("***%s: session ICMP issue (%s)\n",
1082 coap_session_str(session), coap_nack_name(reason));
1083 return;
1084 }
1085 coap_log_debug("***%s: session disconnected (%s)\n",
1086 coap_session_str(session), coap_nack_name(reason));
1087#if COAP_SERVER_SUPPORT
1088 coap_delete_observers(session->context, session);
1089#endif /* COAP_SERVER_SUPPORT */
1090
1091 if (session->proto == COAP_PROTO_UDP)
1093 else
1094 session->state = COAP_SESSION_STATE_NONE;
1095
1096 session->con_active = 0;
1097
1098 if (session->partial_pdu) {
1100 session->partial_pdu = NULL;
1101 }
1102 session->partial_read = 0;
1103
1104 /* Not done if nack handler called above */
1105 while (session->delayqueue) {
1106 q = session->delayqueue;
1107 session->delayqueue = q->next;
1108 q->next = NULL;
1109 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1110 coap_session_str(session), q->id);
1111#if COAP_CLIENT_SUPPORT
1112 session->doing_send_recv = 0;
1113#endif /* COAP_CLIENT_SUPPORT */
1115 }
1116
1117#if COAP_CLIENT_SUPPORT
1118 if (!session->session_failed) {
1119 /* Need to do this before (D)TLS and socket is closed down */
1120 LL_FOREACH_SAFE(session->lg_crcv, cq, etmp) {
1121 LL_DELETE(session->lg_crcv, cq);
1122 coap_block_delete_lg_crcv(session, cq);
1123 }
1124 }
1125#endif /* COAP_CLIENT_SUPPORT */
1126 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
1127 LL_DELETE(session->lg_xmit, lq);
1128 coap_block_delete_lg_xmit(session, lq);
1129 }
1130#if COAP_SERVER_SUPPORT
1131 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
1132 LL_DELETE(session->lg_srcv, sq);
1133 coap_block_delete_lg_srcv(session, sq);
1134 }
1135#endif /* COAP_SERVER_SUPPORT */
1136 coap_cancel_session_messages(session->context, session, reason);
1137
1138#if !COAP_DISABLE_TCP
1139 if (COAP_PROTO_RELIABLE(session->proto)) {
1140 if (coap_netif_available(session)) {
1144 }
1145#if COAP_CLIENT_SUPPORT
1146 if (state != COAP_SESSION_STATE_NONE && !session->session_failed) {
1150 }
1151#endif /* COAP_CLIENT_SUPPORT */
1152 if (session->doing_first)
1153 session->doing_first = 0;
1154 }
1155#endif /* !COAP_DISABLE_TCP */
1156 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1157 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1158}
1159
1160#if COAP_CLIENT_SUPPORT
1161void
1163 if (session->context->reconnect_time &&
1165 session->type == COAP_SESSION_TYPE_CLIENT) {
1166 session->session_failed = 1;
1167 coap_ticks(&session->last_rx_tx);
1168 }
1169}
1170#endif /* COAP_CLIENT_SUPPORT */
1171
1172#if COAP_SERVER_SUPPORT
1173static void
1174coap_make_addr_hash(coap_addr_hash_t *addr_hash, coap_proto_t proto,
1175 const coap_addr_tuple_t *addr_info) {
1176 memset(addr_hash, 0, sizeof(coap_addr_hash_t));
1177 coap_address_copy(&addr_hash->remote, &addr_info->remote);
1178 addr_hash->lport = coap_address_get_port(&addr_info->local);
1179 addr_hash->proto = proto;
1180}
1181
1184 const coap_packet_t *packet, coap_tick_t now) {
1185 coap_session_t *session;
1186 coap_session_t *rtmp;
1187 unsigned int num_idle = 0;
1188 unsigned int num_hs = 0;
1189 coap_session_t *oldest = NULL;
1190 coap_session_t *oldest_hs = NULL;
1191 coap_addr_hash_t addr_hash;
1192
1193 coap_make_addr_hash(&addr_hash, endpoint->proto, &packet->addr_info);
1194 SESSIONS_FIND(endpoint->sessions, addr_hash, session);
1195 if (session) {
1196 /* Maybe mcast or unicast IP address which is not in the hash */
1197 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1198 session->ifindex = packet->ifindex;
1199 session->last_rx_tx = now;
1200 return session;
1201 }
1202
1203#if COAP_CLIENT_SUPPORT
1204 if (coap_is_mcast(&packet->addr_info.local)) {
1205 /* Check if this a proxy client packet we sent on another socket */
1206 SESSIONS_ITER(endpoint->context->sessions, session, rtmp) {
1207 if (coap_address_equals(&session->addr_info.remote, &packet->addr_info.local) &&
1210 /* Drop looped back packet to stop recursion / confusion */
1211 return NULL;
1212 }
1213 }
1214 }
1215#endif /* COAP_CLIENT_SUPPORT */
1216 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1217 if (session->ref == 0 && session->delayqueue == NULL) {
1218 if (session->type == COAP_SESSION_TYPE_SERVER) {
1219 ++num_idle;
1220 if (oldest==NULL || session->last_rx_tx < oldest->last_rx_tx)
1221 oldest = session;
1222
1223 if (session->state == COAP_SESSION_STATE_HANDSHAKE) {
1224 ++num_hs;
1225 /* See if this is a partial (D)TLS session set up
1226 which needs to be cleared down to prevent DOS */
1227 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1228 if (oldest_hs == NULL ||
1229 session->last_rx_tx < oldest_hs->last_rx_tx)
1230 oldest_hs = session;
1231 }
1232 }
1233 } else if (session->type == COAP_SESSION_TYPE_HELLO) {
1234 ++num_hs;
1235 /* See if this is a partial (D)TLS session set up for Client Hello
1236 which needs to be cleared down to prevent DOS */
1237 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1238 if (oldest_hs == NULL ||
1239 session->last_rx_tx < oldest_hs->last_rx_tx)
1240 oldest_hs = session;
1241 }
1242 }
1243 }
1244 }
1245
1246 if (endpoint->context->max_idle_sessions > 0 &&
1247 num_idle >= endpoint->context->max_idle_sessions) {
1249 coap_session_free(oldest);
1250 } else if (oldest_hs) {
1251 coap_log_warn("***%s: Incomplete session timed out\n",
1252 coap_session_str(oldest_hs));
1254 coap_session_free(oldest_hs);
1255 }
1256
1257 if (num_hs > (endpoint->context->max_handshake_sessions ?
1258 endpoint->context->max_handshake_sessions :
1260 /* Maxed out on number of sessions in (D)TLS negotiation state */
1261 coap_log_debug("Oustanding sessions in COAP_SESSION_STATE_HANDSHAKE too "
1262 "large. New request ignored\n");
1263 return NULL;
1264 }
1265
1266 if (endpoint->proto == COAP_PROTO_DTLS) {
1267 /*
1268 * Need to check that this actually is a Client Hello before wasting
1269 * time allocating and then freeing off session.
1270 */
1271
1272 /*
1273 * Generic header structure of the DTLS record layer.
1274 * typedef struct __attribute__((__packed__)) {
1275 * uint8_t content_type; content type of the included message
1276 * uint16_t version; Protocol version
1277 * uint16_t epoch; counter for cipher state changes
1278 * uint8_t sequence_number[6]; sequence number
1279 * uint16_t length; length of the following fragment
1280 * uint8_t handshake; If content_type == DTLS_CT_HANDSHAKE
1281 * } dtls_record_handshake_t;
1282 */
1283#define OFF_CONTENT_TYPE 0 /* offset of content_type in dtls_record_handshake_t */
1284#define DTLS_CT_ALERT 21 /* Content Type Alert */
1285#define DTLS_CT_HANDSHAKE 22 /* Content Type Handshake */
1286#define OFF_HANDSHAKE_TYPE 13 /* offset of handshake in dtls_record_handshake_t */
1287#define DTLS_HT_CLIENT_HELLO 1 /* Client Hello handshake type */
1288#define DTLS_CT_CID 25 /* Content Type Connection ID */
1289#define OFF_CID 11 /* offset of CID in dtls_record_handshake_t */
1290#define OFF_CID_DTLS13 1 /* offset of CID in DTLS1.3 Unified Header */
1291
1292 const uint8_t *payload = (const uint8_t *)packet->payload;
1293 size_t length = packet->length;
1294 if (length < (OFF_HANDSHAKE_TYPE + 1)) {
1295 coap_log_debug("coap_dtls_hello: ContentType %d Short Packet (%zu < %d) dropped\n",
1296 payload[OFF_CONTENT_TYPE], length,
1297 OFF_HANDSHAKE_TYPE + 1);
1298 return NULL;
1299 }
1300 if ((payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 ||
1301 payload[OFF_CONTENT_TYPE] == DTLS_CT_CID) {
1302 /* Client may have changed its IP address */
1303 int changed = 0;
1304
1305 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1306 if (session->client_cid) {
1307 if ((session->is_dtls13 && (payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 &&
1308 memcmp(session->client_cid->s, &payload[OFF_CID_DTLS13],
1309 session->client_cid->length) == 0) ||
1310 (!session->is_dtls13 && payload[OFF_CONTENT_TYPE] == DTLS_CT_CID &&
1311 memcmp(session->client_cid->s, &payload[OFF_CID],
1312 session->client_cid->length) == 0)) {
1313 /* Updating IP address */
1314 coap_log_info("***%s: CID: Old Client Session\n", coap_session_str(session));
1315 SESSIONS_DELETE(endpoint->sessions, session);
1316 session->addr_info = packet->addr_info;
1317 memcpy(&session->addr_hash, &addr_hash, sizeof(session->addr_hash));
1318 SESSIONS_ADD(endpoint->sessions, session);
1319 coap_log_info("***%s: CID: New Client Session\n", coap_session_str(session));
1320 return session;
1321 }
1322 }
1323 }
1324 if (!changed) {
1325 coap_log_debug("coap_dtls_hello: ContentType Connection-IS dropped\n");
1326 return NULL;
1327 }
1328 } else if (payload[OFF_CONTENT_TYPE] != DTLS_CT_HANDSHAKE ||
1329 payload[OFF_HANDSHAKE_TYPE] != DTLS_HT_CLIENT_HELLO) {
1330 /* only log if not a late alert */
1331 if (payload[OFF_CONTENT_TYPE] != DTLS_CT_ALERT)
1332 coap_log_debug("coap_dtls_hello: ContentType %d Handshake %d dropped\n",
1333 payload[OFF_CONTENT_TYPE],
1334 payload[OFF_HANDSHAKE_TYPE]);
1335 return NULL;
1336 }
1337 }
1338
1340 &addr_hash, &packet->addr_info.local,
1341 &packet->addr_info.remote,
1342 packet->ifindex, endpoint->context, endpoint);
1343 if (session) {
1344 session->last_rx_tx = now;
1345 memcpy(session->sock.lfunc, endpoint->sock.lfunc,
1346 sizeof(session->sock.lfunc));
1347 if (endpoint->proto == COAP_PROTO_UDP)
1349 else if (endpoint->proto == COAP_PROTO_DTLS) {
1350 session->type = COAP_SESSION_TYPE_HELLO;
1351 }
1352 SESSIONS_ADD(endpoint->sessions, session);
1353 coap_log_debug("***%s: session %p: new incoming session\n",
1354 coap_session_str(session), (void *)session);
1356 }
1357 return session;
1358}
1359
1362 coap_tick_t now) {
1363 if (session) {
1364 session->last_rx_tx = now;
1365 session->type = COAP_SESSION_TYPE_SERVER;
1366 coap_dtls_establish(session);
1367 }
1368 return session;
1369}
1370#endif /* COAP_SERVER_SUPPORT */
1371
1372#if COAP_CLIENT_SUPPORT
1373static coap_session_t *
1374coap_session_create_client(coap_context_t *ctx,
1375 const coap_address_t *local_if,
1376 const coap_address_t *server,
1377 coap_proto_t proto) {
1378 coap_session_t *session = NULL;
1379 int default_port = COAP_DEFAULT_PORT;
1380
1381 assert(server);
1382
1383 switch (proto) {
1384 case COAP_PROTO_UDP:
1385 default_port = COAP_DEFAULT_PORT;
1386 break;
1387 case COAP_PROTO_DTLS:
1388 if (!coap_dtls_is_supported()) {
1389 coap_log_crit("coap_new_client_session*: DTLS not supported\n");
1390 return NULL;
1391 }
1392 default_port = COAPS_DEFAULT_PORT;
1393 break;
1394 case COAP_PROTO_TCP:
1395 if (!coap_tcp_is_supported()) {
1396 coap_log_crit("coap_new_client_session*: TCP not supported\n");
1397 return NULL;
1398 }
1399 default_port = COAP_DEFAULT_PORT;
1400 break;
1401 case COAP_PROTO_TLS:
1402 if (!coap_tls_is_supported()) {
1403 coap_log_crit("coap_new_client_session*: TLS not supported\n");
1404 return NULL;
1405 }
1406 default_port = COAPS_DEFAULT_PORT;
1407 break;
1408 case COAP_PROTO_WS:
1409 if (!coap_ws_is_supported()) {
1410 coap_log_crit("coap_new_client_session*: WS not supported\n");
1411 return NULL;
1412 }
1413 default_port = 80;
1414 break;
1415 case COAP_PROTO_WSS:
1416 if (!coap_wss_is_supported()) {
1417 coap_log_crit("coap_new_client_session*: WSS not supported\n");
1418 return NULL;
1419 }
1420 default_port = 443;
1421 break;
1422 case COAP_PROTO_NONE:
1423 case COAP_PROTO_LAST:
1424 default:
1425 assert(0);
1426 return NULL;
1427 }
1428 session = coap_make_session(proto, COAP_SESSION_TYPE_CLIENT, NULL,
1429 local_if, server, 0, ctx, NULL);
1430 if (!session)
1431 goto error;
1432
1434 session->sock.session = session;
1435 memcpy(&session->sock.lfunc, coap_layers_coap[proto],
1436 sizeof(session->sock.lfunc));
1437
1438 if (COAP_PROTO_NOT_RELIABLE(proto)) {
1439 coap_session_t *s, *rtmp;
1440 if (!coap_netif_dgrm_connect(session, local_if, server, default_port)) {
1441 goto error;
1442 }
1443 /* Check that this is not a duplicate 4-tuple */
1444 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
1447 &s->addr_info.local) &&
1449 &s->addr_info.remote)) {
1450 coap_log_warn("***%s: session %p: duplicate - already exists\n",
1451 coap_session_str(session), (void *)session);
1452 goto error;
1453 }
1454 }
1455#ifdef WITH_CONTIKI
1456 session->sock.context = ctx;
1457#endif /* WITH_CONTIKI */
1458#if !COAP_DISABLE_TCP
1459 } else if (COAP_PROTO_RELIABLE(proto)) {
1460 if (!coap_netif_strm_connect1(session, local_if, server, default_port)) {
1461 goto error;
1462 }
1463#endif /* !COAP_DISABLE_TCP */
1464 }
1465
1466 session->sock.session = session;
1467#ifdef COAP_EPOLL_SUPPORT
1468 coap_epoll_ctl_add(&session->sock,
1469 EPOLLIN |
1470 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1471 EPOLLOUT : 0),
1472 __func__);
1473#endif /* COAP_EPOLL_SUPPORT */
1474
1476 if (local_if)
1477 session->sock.flags |= COAP_SOCKET_BOUND;
1478#if COAP_SERVER_SUPPORT
1479 if (ctx->proxy_uri_resource)
1480 session->proxy_session = 1;
1481#endif /* COAP_SERVER_SUPPORT */
1482 SESSIONS_ADD(ctx->sessions, session);
1483 return session;
1484
1485error:
1486 /*
1487 * Need to add in the session as coap_session_release_lkd()
1488 * will call SESSIONS_DELETE in coap_session_free().
1489 */
1490 if (session)
1491 SESSIONS_ADD(ctx->sessions, session);
1492 coap_session_release_lkd(session);
1493 return NULL;
1494}
1495
1496static void
1497coap_session_check_connect(coap_session_t *session) {
1498 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1499 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1500 }
1501#if !COAP_DISABLE_TCP
1502 if (COAP_PROTO_RELIABLE(session->proto)) {
1503 if (session->sock.flags & COAP_SOCKET_WANT_CONNECT) {
1505 if (session->type == COAP_SESSION_TYPE_CLIENT) {
1506 session->doing_first = 1;
1507 }
1508 } else {
1509 /* Initial connect worked immediately */
1510 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1511 }
1512 }
1513#endif /* !COAP_DISABLE_TCP */
1514 coap_ticks(&session->last_rx_tx);
1515}
1516#endif /* COAP_CLIENT_SUPPORT */
1517
1518void
1520 if (COAP_PROTO_NOT_RELIABLE(session->proto))
1521 coap_session_connected(session);
1522#if !COAP_DISABLE_TCP
1523 if (COAP_PROTO_RELIABLE(session->proto))
1524 coap_session_send_csm(session);
1525#endif /* !COAP_DISABLE_TCP */
1526}
1527
1528#if COAP_CLIENT_SUPPORT
1529int
1531 int default_port = COAP_DEFAULT_PORT;
1532
1533 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close && !session->session_failed)
1534 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1535
1536 switch (session->proto) {
1537 case COAP_PROTO_UDP:
1538 default_port = COAP_DEFAULT_PORT;
1539 break;
1540 case COAP_PROTO_DTLS:
1541 default_port = COAPS_DEFAULT_PORT;
1542 break;
1543 case COAP_PROTO_TCP:
1544 default_port = COAP_DEFAULT_PORT;
1545 break;
1546 case COAP_PROTO_TLS:
1547 default_port = COAPS_DEFAULT_PORT;
1548 break;
1549 case COAP_PROTO_WS:
1550 default_port = 80;
1551 break;
1552 case COAP_PROTO_WSS:
1553 default_port = 443;
1554 break;
1555 case COAP_PROTO_NONE:
1556 case COAP_PROTO_LAST:
1557 default:
1558 assert(0);
1559 return 0;
1560 }
1561 session->sock.session = session;
1562 coap_log_debug("***%s: trying to reconnect\n", coap_session_str(session));
1563 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1564 session->state = COAP_SESSION_STATE_NONE;
1565 if (!coap_netif_dgrm_connect(session, &session->local_reconnect, &session->addr_info.remote,
1566 default_port)) {
1567 goto error;
1568 }
1570#ifdef WITH_CONTIKI
1571 session->sock.context = session->context;
1572#endif /* WITH_CONTIKI */
1573#if !COAP_DISABLE_TCP
1574 } else if (COAP_PROTO_RELIABLE(session->proto)) {
1575 if (!coap_netif_strm_connect1(session, &session->local_reconnect, &session->addr_info.remote,
1576 default_port)) {
1577 goto error;
1578 }
1579#endif /* !COAP_DISABLE_TCP */
1580 } else {
1581 goto error;
1582 }
1583#ifdef COAP_EPOLL_SUPPORT
1584 coap_epoll_ctl_add(&session->sock,
1585 EPOLLIN |
1586 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1587 EPOLLOUT : 0),
1588 __func__);
1589#endif /* COAP_EPOLL_SUPPORT */
1590
1592 session->sock.flags |= COAP_SOCKET_BOUND;
1593 coap_session_check_connect(session);
1594 return 1;
1595error:
1596 return 0;
1597}
1598
1599void
1601 coap_lg_crcv_t *lg_crcv, *etmp;
1602
1603 if (!session->session_failed)
1604 return;
1605 coap_log_debug("***%s: session re-established\n",
1606 coap_session_str(session));
1607 session->session_failed = 0;
1608 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
1609 coap_pdu_reference_lkd(&lg_crcv->pdu);
1610 coap_send_internal(session, &lg_crcv->pdu, NULL);
1611 }
1612}
1613
1616 const coap_address_t *local_if,
1617 const coap_address_t *server,
1618 coap_proto_t proto) {
1619 coap_session_t *session;
1620
1621 coap_lock_lock(ctx, return NULL);
1622 session = coap_new_client_session_lkd(ctx, local_if, server, proto);
1623 coap_lock_unlock(ctx);
1624 return session;
1625}
1626
1629 const coap_address_t *local_if,
1630 const coap_address_t *server,
1631 coap_proto_t proto) {
1632 coap_session_t *session;
1633
1635 session = coap_session_create_client(ctx, local_if, server,
1636 proto);
1637 if (session) {
1638 coap_log_debug("***%s: session %p: created outgoing session\n",
1639 coap_session_str(session), (void *)session);
1640 coap_session_check_connect(session);
1641 }
1642 return session;
1643}
1644
1647 const coap_address_t *local_if,
1648 const coap_address_t *server,
1649 coap_proto_t proto, const char *identity,
1650 const uint8_t *key, unsigned key_len) {
1651 coap_session_t *session;
1652
1653 coap_lock_lock(ctx, return NULL);
1654 session = coap_new_client_session_psk_lkd(ctx, local_if, server, proto, identity, key, key_len);
1655 coap_lock_unlock(ctx);
1656 return session;
1657}
1658
1661 const coap_address_t *local_if,
1662 const coap_address_t *server,
1663 coap_proto_t proto, const char *identity,
1664 const uint8_t *key, unsigned key_len) {
1665 coap_dtls_cpsk_t setup_data;
1666
1668 memset(&setup_data, 0, sizeof(setup_data));
1670
1671 if (identity) {
1672 setup_data.psk_info.identity.s = (const uint8_t *)identity;
1673 setup_data.psk_info.identity.length = strlen(identity);
1674 }
1675
1676 if (key && key_len > 0) {
1677 setup_data.psk_info.key.s = key;
1678 setup_data.psk_info.key.length = key_len;
1679 }
1680
1681 return coap_new_client_session_psk2_lkd(ctx, local_if, server,
1682 proto, &setup_data);
1683}
1684
1685/*
1686 * Check the validity of the SNI to send to the server.
1687 *
1688 * https://datatracker.ietf.org/doc/html/rfc6066#section-3
1689 * Literal IPv4 and IPv6 addresses are not permitted in "HostName".
1690 */
1691static void
1692coap_sanitize_client_sni(char **client_sni) {
1693 char *cp;
1694
1695 if (*client_sni == NULL)
1696 return;
1697
1698 cp = *client_sni;
1699 switch (*cp) {
1700 case '0':
1701 case '1':
1702 case '2':
1703 case '3':
1704 case '4':
1705 case '5':
1706 case '6':
1707 case '7':
1708 case '8':
1709 case '9':
1710 case 'a':
1711 case 'b':
1712 case 'c':
1713 case 'd':
1714 case 'e':
1715 case 'f':
1716 case 'A':
1717 case 'B':
1718 case 'C':
1719 case 'D':
1720 case 'E':
1721 case 'F':
1722 case ':':
1723 break;
1724 case '\000':
1725 /* Empty entry invalid */
1726 *client_sni = NULL;
1727 return;
1728 default:
1729 /* Does not start with a hex digit or : - not literal IP. */
1730 return;
1731 }
1732 /* Check for IPv4 */
1733 while (*cp) {
1734 switch (*cp) {
1735 case '0':
1736 case '1':
1737 case '2':
1738 case '3':
1739 case '4':
1740 case '5':
1741 case '6':
1742 case '7':
1743 case '8':
1744 case '9':
1745 case '.':
1746 break;
1747 default:
1748 /* Not of format nnn.nnn.nnn.nnn. Could be IPv6 */
1749 goto check_ipv6;
1750 }
1751 cp++;
1752 }
1753 /* IPv4 address - not allowed. */
1754 *client_sni = NULL;
1755 return;
1756
1757check_ipv6:
1758 /* Check for IPv6 */
1759 cp = *client_sni;
1760 while (*cp) {
1761 switch (*cp) {
1762 case '0':
1763 case '1':
1764 case '2':
1765 case '3':
1766 case '4':
1767 case '5':
1768 case '6':
1769 case '7':
1770 case '8':
1771 case '9':
1772 case 'a':
1773 case 'b':
1774 case 'c':
1775 case 'd':
1776 case 'e':
1777 case 'f':
1778 case 'A':
1779 case 'B':
1780 case 'C':
1781 case 'D':
1782 case 'E':
1783 case 'F':
1784 case ':':
1785 break;
1786 case '%':
1787 /* Start of i/f specification, Previous is IPv6 */
1788 *client_sni = NULL;
1789 return;
1790 default:
1791 /* Not of format xx:xx::xx. */
1792 return;
1793 }
1794 cp++;
1795 }
1796 *client_sni = NULL;
1797 return;
1798}
1799
1802 const coap_address_t *local_if,
1803 const coap_address_t *server,
1804 coap_proto_t proto,
1805 coap_dtls_cpsk_t *setup_data) {
1806 coap_session_t *session;
1807
1808 coap_lock_lock(ctx, return NULL);
1809 session = coap_new_client_session_psk2_lkd(ctx, local_if, server, proto, setup_data);
1810 coap_lock_unlock(ctx);
1811 return session;
1812}
1813
1816 const coap_address_t *local_if,
1817 const coap_address_t *server,
1818 coap_proto_t proto,
1819 coap_dtls_cpsk_t *setup_data) {
1820 coap_session_t *session;
1821
1823 session = coap_session_create_client(ctx, local_if, server, proto);
1824
1825 if (!session || !setup_data)
1826 return NULL;
1827
1828 session->cpsk_setup_data = *setup_data;
1829 if (setup_data->psk_info.identity.s) {
1830 session->psk_identity =
1832 setup_data->psk_info.identity.length);
1833 if (!session->psk_identity) {
1834 coap_log_warn("Cannot store session Identity (PSK)\n");
1835 coap_session_release_lkd(session);
1836 return NULL;
1837 }
1839 coap_log_warn("Identity (PSK) not defined\n");
1840 coap_session_release_lkd(session);
1841 return NULL;
1842 }
1843
1844 if (setup_data->psk_info.key.s && setup_data->psk_info.key.length > 0) {
1845 session->psk_key = coap_new_bin_const(setup_data->psk_info.key.s,
1846 setup_data->psk_info.key.length);
1847 if (!session->psk_key) {
1848 coap_log_warn("Cannot store session pre-shared key (PSK)\n");
1849 coap_session_release_lkd(session);
1850 return NULL;
1851 }
1853 coap_log_warn("Pre-shared key (PSK) not defined\n");
1854 coap_session_release_lkd(session);
1855 return NULL;
1856 }
1857
1858 coap_sanitize_client_sni(&session->cpsk_setup_data.client_sni);
1859
1861 if (!coap_dtls_context_set_cpsk(ctx, &session->cpsk_setup_data)) {
1862 coap_session_release_lkd(session);
1863 return NULL;
1864 }
1865 }
1866 coap_log_debug("***%s: new outgoing session\n",
1867 coap_session_str(session));
1868 coap_session_check_connect(session);
1869 return session;
1870}
1871#endif /* COAP_CLIENT_SUPPORT */
1872
1873int
1875 const coap_bin_const_t *psk_hint
1876 ) {
1877 /* We may be refreshing the hint with the same hint */
1878 coap_bin_const_t *old_psk_hint = session->psk_hint;
1879
1880 if (psk_hint && psk_hint->s) {
1881 if (session->psk_hint) {
1882 if (coap_binary_equal(session->psk_hint, psk_hint))
1883 return 1;
1884 }
1885 session->psk_hint = coap_new_bin_const(psk_hint->s,
1886 psk_hint->length);
1887 if (!session->psk_hint) {
1888 coap_log_err("No memory to store identity hint (PSK)\n");
1889 if (old_psk_hint)
1890 coap_delete_bin_const(old_psk_hint);
1891 return 0;
1892 }
1893 } else {
1894 session->psk_hint = NULL;
1895 }
1896 if (old_psk_hint)
1897 coap_delete_bin_const(old_psk_hint);
1898
1899 return 1;
1900}
1901
1902int
1904 const coap_bin_const_t *psk_key
1905 ) {
1906 /* We may be refreshing the key with the same key */
1907 coap_bin_const_t *old_psk_key = session->psk_key;
1908
1909 if (psk_key && psk_key->s) {
1910 if (session->psk_key) {
1911 if (coap_binary_equal(session->psk_key, psk_key))
1912 return 1;
1913 }
1914 session->psk_key = coap_new_bin_const(psk_key->s, psk_key->length);
1915 if (!session->psk_key) {
1916 coap_log_err("No memory to store pre-shared key (PSK)\n");
1917 if (old_psk_key)
1918 coap_delete_bin_const(old_psk_key);
1919 return 0;
1920 }
1921 } else {
1922 session->psk_key = NULL;
1923 }
1924 if (old_psk_key)
1925 coap_delete_bin_const(old_psk_key);
1926
1927 return 1;
1928}
1929
1930int
1932 const coap_bin_const_t *psk_identity
1933 ) {
1934 /* We may be refreshing the identity with the same identity */
1935 coap_bin_const_t *old_psk_identity = session->psk_identity;
1936
1937 if (psk_identity && psk_identity->s) {
1938 if (session->psk_identity) {
1939 if (coap_binary_equal(session->psk_identity, psk_identity))
1940 return 1;
1941 }
1942 session->psk_identity = coap_new_bin_const(psk_identity->s,
1943 psk_identity->length);
1944 if (!session->psk_identity) {
1945 coap_log_err("No memory to store pre-shared key identity (PSK)\n");
1946 if (old_psk_identity)
1947 coap_delete_bin_const(old_psk_identity);
1948 return 0;
1949 }
1950 } else {
1951 session->psk_identity = NULL;
1952 }
1953 if (old_psk_identity)
1954 coap_delete_bin_const(old_psk_identity);
1955
1956 return 1;
1957}
1958
1959#if COAP_SERVER_SUPPORT
1960const coap_bin_const_t *
1962 if (session)
1963 return session->psk_hint;
1964 return NULL;
1965}
1966#endif /* COAP_SERVER_SUPPORT */
1967
1968const coap_bin_const_t *
1970 const coap_bin_const_t *psk_identity = NULL;
1971 if (session) {
1972 psk_identity = session->psk_identity;
1973 if (psk_identity == NULL) {
1974 psk_identity = &session->cpsk_setup_data.psk_info.identity;
1975 }
1976 }
1977 return psk_identity;
1978}
1979
1980const coap_bin_const_t *
1982 if (session)
1983 return session->psk_key;
1984 return NULL;
1985}
1986
1987#if COAP_CLIENT_SUPPORT
1990 const coap_address_t *local_if,
1991 const coap_address_t *server,
1992 coap_proto_t proto,
1993 coap_dtls_pki_t *setup_data) {
1994 coap_session_t *session;
1995
1996 coap_lock_lock(ctx, return NULL);
1997 session = coap_new_client_session_pki_lkd(ctx, local_if, server, proto, setup_data);
1998 coap_lock_unlock(ctx);
1999 return session;
2000}
2001
2004 const coap_address_t *local_if,
2005 const coap_address_t *server,
2006 coap_proto_t proto,
2007 coap_dtls_pki_t *setup_data) {
2008 coap_session_t *session;
2009 coap_dtls_pki_t l_setup_data;
2010
2011 if (!setup_data)
2012 return NULL;
2013 if (setup_data->version != COAP_DTLS_PKI_SETUP_VERSION) {
2014 coap_log_err("coap_new_client_session_pki: Wrong version of setup_data\n");
2015 return NULL;
2016 }
2017
2019 l_setup_data = *setup_data;
2020 coap_sanitize_client_sni(&l_setup_data.client_sni);
2021
2022 session = coap_session_create_client(ctx, local_if, server, proto);
2023
2024 if (!session) {
2025 return NULL;
2026 }
2027
2029 /* we know that setup_data is not NULL */
2030 if (!coap_dtls_context_set_pki(ctx, &l_setup_data, COAP_DTLS_ROLE_CLIENT)) {
2031 coap_session_release_lkd(session);
2032 return NULL;
2033 }
2034 }
2035 coap_log_debug("***%s: new outgoing session\n",
2036 coap_session_str(session));
2037 coap_session_check_connect(session);
2038 return session;
2039}
2040#endif /* ! COAP_CLIENT_SUPPORT */
2041
2042#if COAP_SERVER_SUPPORT
2043#if !COAP_DISABLE_TCP
2046 coap_session_t *session;
2048 NULL, NULL, NULL, 0, ctx, ep);
2049 if (!session)
2050 goto error;
2051
2052 memcpy(session->sock.lfunc, ep->sock.lfunc, sizeof(session->sock.lfunc));
2053 if (!coap_netif_strm_accept(ep, session, extra))
2054 goto error;
2055
2056 coap_make_addr_hash(&session->addr_hash, session->proto, &session->addr_info);
2057
2058#ifdef COAP_EPOLL_SUPPORT
2059 session->sock.session = session;
2060 coap_epoll_ctl_add(&session->sock,
2061 EPOLLIN,
2062 __func__);
2063#endif /* COAP_EPOLL_SUPPORT */
2064 SESSIONS_ADD(ep->sessions, session);
2065 if (session) {
2066 coap_log_debug("***%s: session %p: new incoming session\n",
2067 coap_session_str(session), (void *)session);
2071 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
2072 }
2073 return session;
2074
2075error:
2076 /*
2077 * Need to add in the session as coap_session_release_lkd()
2078 * will call SESSIONS_DELETE in coap_session_free().
2079 */
2080 if (session) {
2081 SESSIONS_ADD(ep->sessions, session);
2082 coap_session_free(session);
2083 }
2084 return NULL;
2085}
2086#endif /* !COAP_DISABLE_TCP */
2087#endif /* COAP_SERVER_SUPPORT */
2088
2089void
2091 const uint8_t *data) {
2092 session->tx_token = coap_decode_var_bytes8(data, len);
2093 /*
2094 * Decrement as when first used by coap_session_new_token() it will
2095 * get incremented
2096 */
2097 session->tx_token--;
2098}
2099
2100void
2102 uint8_t *data) {
2103 *len = coap_encode_var_safe8(data,
2104 sizeof(session->tx_token), ++session->tx_token);
2105}
2106
2107COAP_API uint16_t
2109 uint16_t mid;
2110
2111 coap_lock_lock(session->context, return 0);
2112 mid = coap_new_message_id_lkd(session);
2113 coap_lock_unlock(session->context);
2114 return mid;
2115}
2116
2117uint16_t
2120 if (COAP_PROTO_NOT_RELIABLE(session->proto))
2121 return ++session->tx_mid;
2122 /* TCP/TLS have no notion of mid */
2123 return 0;
2124}
2125
2126const coap_address_t *
2128 if (session)
2129 return &session->addr_info.remote;
2130 return NULL;
2131}
2132
2133const coap_address_t *
2135 if (session)
2136 return &session->addr_info.local;
2137 return NULL;
2138}
2139
2140const coap_address_t *
2142#if COAP_CLIENT_SUPPORT
2143 if (session && session->type == COAP_SESSION_TYPE_CLIENT &&
2144 session->sock.flags & COAP_SOCKET_MULTICAST)
2145 return &session->sock.mcast_addr;
2146#else /* ! COAP_CLIENT_SUPPORT */
2147 (void)session;
2148#endif /* ! COAP_CLIENT_SUPPORT */
2149 return NULL;
2150}
2151
2154 if (session)
2155 return session->context;
2156 return NULL;
2157}
2158
2161 if (session)
2162 return session->proto;
2163 return 0;
2164}
2165
2168 if (session)
2169 return session->type;
2170 return 0;
2171}
2172
2173COAP_API int
2175 int ret;
2176
2177 coap_lock_lock(session->context, return 0);
2178 ret = coap_session_set_type_client_lkd(session);
2179 coap_lock_unlock(session->context);
2180 return ret;
2181}
2182
2183int
2185#if COAP_SERVER_SUPPORT
2186 if (session && session->type == COAP_SESSION_TYPE_SERVER) {
2188 session->type = COAP_SESSION_TYPE_CLIENT;
2189 return 1;
2190 }
2191#else /* ! COAP_SERVER_SUPPORT */
2192 (void)session;
2193#endif /* ! COAP_SERVER_SUPPORT */
2194 return 0;
2195}
2196
2199 if (session)
2200 return session->state;
2201 return 0;
2202}
2203
2204int
2206 if (session)
2207 return session->ifindex;
2208 return -1;
2209}
2210
2211void *
2213 coap_tls_library_t *tls_lib) {
2214 if (session)
2215 return coap_dtls_get_tls(session, tls_lib);
2216 return NULL;
2217}
2218
2219static const char *
2221 switch (proto) {
2222 case COAP_PROTO_UDP:
2223 return "UDP ";
2224 case COAP_PROTO_DTLS:
2225 return "DTLS";
2226 case COAP_PROTO_TCP:
2227 return "TCP ";
2228 case COAP_PROTO_TLS:
2229 return "TLS ";
2230 case COAP_PROTO_WS:
2231 return "WS ";
2232 case COAP_PROTO_WSS:
2233 return "WSS ";
2234 case COAP_PROTO_NONE:
2235 case COAP_PROTO_LAST:
2236 default:
2237 return "????" ;
2238 break;
2239 }
2240 return NULL;
2241}
2242
2243#if COAP_SERVER_SUPPORT
2245coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto) {
2246 coap_endpoint_t *endpoint;
2247
2248 coap_lock_lock(context, return NULL);
2249 endpoint = coap_new_endpoint_lkd(context, listen_addr, proto);
2250 coap_lock_unlock(context);
2251 return endpoint;
2252}
2253
2255coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr,
2256 coap_proto_t proto) {
2257 coap_endpoint_t *ep = NULL;
2258
2259 if (!context || !listen_addr) {
2260 coap_log_debug("coap_new_endpoint: Both context and listen_addr need to be defined\n");
2261 return NULL;
2262 }
2263
2264 coap_lock_check_locked(context);
2265
2266 switch (proto) {
2267 case COAP_PROTO_UDP:
2268 break;
2269 case COAP_PROTO_DTLS:
2270 if (!coap_dtls_is_supported()) {
2271 coap_log_warn("coap_new_endpoint: DTLS not supported\n");
2272 return NULL;
2273 }
2274 break;
2275 case COAP_PROTO_TLS:
2276 if (!coap_tls_is_supported()) {
2277 coap_log_warn("coap_new_endpoint: TLS not supported\n");
2278 return NULL;
2279 }
2280 break;
2281 case COAP_PROTO_TCP:
2282 if (!coap_tcp_is_supported()) {
2283 coap_log_warn("coap_new_endpoint: TCP not supported\n");
2284 return NULL;
2285 }
2286 break;
2287 case COAP_PROTO_WS:
2288 if (!coap_ws_is_supported()) {
2289 coap_log_warn("coap_new_endpoint: WS not supported\n");
2290 return NULL;
2291 }
2292 break;
2293 case COAP_PROTO_WSS:
2294 if (!coap_wss_is_supported()) {
2295 coap_log_warn("coap_new_endpoint: WSS not supported\n");
2296 return NULL;
2297 }
2298 break;
2299 case COAP_PROTO_NONE:
2300 case COAP_PROTO_LAST:
2301 default:
2302 coap_log_crit("coap_new_endpoint: Unsupported protocol %d\n", proto);
2303 return NULL;
2304 }
2305
2306 if (proto == COAP_PROTO_DTLS || proto == COAP_PROTO_TLS ||
2307 proto == COAP_PROTO_WSS) {
2309 coap_log_info("coap_new_endpoint: one of coap_context_set_psk() or "
2310 "coap_context_set_pki() not called\n");
2311 return NULL;
2312 }
2313 }
2314 ep = coap_malloc_endpoint();
2315 if (!ep) {
2316 coap_log_warn("coap_new_endpoint: malloc");
2317 return NULL;
2318 }
2319
2320 memset(ep, 0, sizeof(coap_endpoint_t));
2321 ep->context = context;
2322 ep->proto = proto;
2323 ep->sock.endpoint = ep;
2324 memcpy(&ep->sock.lfunc, coap_layers_coap[proto], sizeof(ep->sock.lfunc));
2325
2326 if (COAP_PROTO_NOT_RELIABLE(proto)) {
2327 if (!coap_netif_dgrm_listen(ep, listen_addr))
2328 goto error;
2329#ifdef WITH_CONTIKI
2330 ep->sock.context = context;
2331#endif /* WITH_CONTIKI */
2332#if !COAP_DISABLE_TCP
2333 } else if (COAP_PROTO_RELIABLE(proto)) {
2334 if (!coap_netif_strm_listen(ep, listen_addr))
2335 goto error;
2336#endif /* !COAP_DISABLE_TCP */
2337 } else {
2338 coap_log_crit("coap_new_endpoint: Protocol type not supported %d\n", proto);
2339 goto error;
2340 }
2341
2343#ifndef INET6_ADDRSTRLEN
2344#define INET6_ADDRSTRLEN 40
2345#endif
2346 unsigned char addr_str[INET6_ADDRSTRLEN + 8];
2347
2348 if (coap_print_addr(&ep->bind_addr, addr_str, INET6_ADDRSTRLEN + 8)) {
2349 coap_log_debug("created %s endpoint %s\n", coap_proto_name(ep->proto),
2350 addr_str);
2351 }
2352 }
2353
2355
2356#ifdef COAP_EPOLL_SUPPORT
2357 ep->sock.endpoint = ep;
2359 EPOLLIN,
2360 __func__);
2361#endif /* COAP_EPOLL_SUPPORT */
2362
2363 LL_PREPEND(context->endpoint, ep);
2364 return ep;
2365
2366error:
2368 return NULL;
2369}
2370
2371void
2373 ep->default_mtu = (uint16_t)mtu;
2374}
2375
2376COAP_API void
2378 if (ep) {
2379 coap_context_t *context = ep->context;
2380 if (context) {
2381 coap_lock_lock(context, return);
2382 }
2384 if (context) {
2385 coap_lock_unlock(context);
2386 }
2387 }
2388}
2389
2390void
2392 if (ep) {
2393 coap_session_t *session, *rtmp;
2394
2395 if (ep->context) {
2396 /* If fully allocated and inserted */
2398 SESSIONS_ITER_SAFE(ep->sessions, session, rtmp) {
2399 assert(session->ref == 0);
2400 if (session->ref == 0) {
2402 coap_session_free(session);
2403 }
2404 }
2405 if (coap_netif_available_ep(ep)) {
2406 /*
2407 * ep->sock.endpoint is set in coap_new_endpoint().
2408 * ep->sock.session is never set.
2409 *
2410 * session->sock.session is set for both clients and servers (when a
2411 * new session is accepted), but does not affect the endpoint.
2412 *
2413 * So, it is safe to call coap_netif_close_ep() after all the sessions
2414 * have been freed above as we are only working with the endpoint sock.
2415 */
2416#ifdef COAP_EPOLL_SUPPORT
2417 assert(ep->sock.session == NULL);
2418#endif /* COAP_EPOLL_SUPPORT */
2420 }
2421
2422 if (ep->context->endpoint) {
2423 LL_DELETE(ep->context->endpoint, ep);
2424 }
2425 }
2427 }
2428}
2429#endif /* COAP_SERVER_SUPPORT */
2430
2433 const coap_address_t *remote_addr,
2434 int ifindex) {
2435 coap_session_t *s, *rtmp;
2436#if COAP_CLIENT_SUPPORT
2437 SESSIONS_ITER(ctx->sessions, s, rtmp) {
2438 if (s->ifindex == ifindex) {
2439 if (s->sock.flags & COAP_SOCKET_MULTICAST) {
2440 if (coap_address_equals(&s->sock.mcast_addr, remote_addr))
2441 return s;
2442 } else if (coap_address_equals(&s->addr_info.remote, remote_addr))
2443 return s;
2444 }
2445 }
2446#endif /* COAP_CLIENT_SUPPORT */
2447#if COAP_SERVER_SUPPORT
2448 coap_endpoint_t *ep;
2449
2450 LL_FOREACH(ctx->endpoint, ep) {
2451 SESSIONS_ITER(ep->sessions, s, rtmp) {
2452 if (s->ifindex == ifindex && coap_address_equals(&s->addr_info.remote,
2453 remote_addr))
2454 return s;
2455 }
2456 }
2457#endif /* COAP_SERVER_SUPPORT */
2458 return NULL;
2459}
2460
2461#ifndef INET6_ADDRSTRLEN
2462#define INET6_ADDRSTRLEN 46
2463#endif
2464const char *
2466 static char szSession[2 * (INET6_ADDRSTRLEN + 8) + 24];
2467 char *p = szSession, *end = szSession + sizeof(szSession);
2468 if (coap_print_addr(&session->addr_info.local,
2469 (unsigned char *)p, end - p) > 0)
2470 p += strlen(p);
2471 if (p + 6 < end) {
2472 strcpy(p, " <-> ");
2473 p += 5;
2474 }
2475 if (p + 1 < end) {
2476 if (coap_print_addr(&session->addr_info.remote,
2477 (unsigned char *)p, end - p) > 0)
2478 p += strlen(p);
2479 }
2480 if (session->ifindex > 0 && p + 1 < end)
2481 p += snprintf(p, end - p, " (if%d)", session->ifindex);
2482 if (p + 6 < end) {
2483 strcpy(p, " ");
2484 p++;
2485 strcpy(p, coap_proto_name(session->proto));
2486 }
2487
2488 return szSession;
2489}
2490
2491#if COAP_SERVER_SUPPORT
2492const char *
2493coap_endpoint_str(const coap_endpoint_t *endpoint) {
2494 static char szEndpoint[128];
2495 char *p = szEndpoint, *end = szEndpoint + sizeof(szEndpoint);
2496 if (coap_print_addr(&endpoint->bind_addr, (unsigned char *)p, end - p) > 0)
2497 p += strlen(p);
2498 if (p + 6 < end) {
2499 if (endpoint->proto == COAP_PROTO_UDP) {
2500 strcpy(p, " UDP");
2501 } else if (endpoint->proto == COAP_PROTO_DTLS) {
2502 strcpy(p, " DTLS");
2503 } else {
2504 strcpy(p, " NONE");
2505 }
2506 }
2507
2508 return szEndpoint;
2509}
2510#endif /* COAP_SERVER_SUPPORT */
2511#if COAP_CLIENT_SUPPORT
2512void
2514 session->no_observe_cancel = 1;
2515}
2516#endif /* COAP_CLIENT_SUPPORT */
2517#endif /* COAP_SESSION_C_ */
void coap_address_init(coap_address_t *addr)
Resets the given coap_address_t object addr to its default values.
int coap_is_mcast(const coap_address_t *a)
Checks if given address a denotes a multicast address.
uint16_t coap_address_get_port(const coap_address_t *addr)
Returns the port from addr in host byte order.
void coap_address_copy(coap_address_t *dst, const coap_address_t *src)
int coap_address_equals(const coap_address_t *a, const coap_address_t *b)
Compares given address objects a and b.
#define PRIu32
coap_nack_reason_t
Definition coap_io.h:62
@ COAP_NACK_NOT_DELIVERABLE
Definition coap_io.h:64
@ COAP_NACK_WS_FAILED
Definition coap_io.h:71
@ COAP_NACK_TOO_MANY_RETRIES
Definition coap_io.h:63
@ COAP_NACK_TLS_FAILED
Definition coap_io.h:66
@ COAP_NACK_TLS_LAYER_FAILED
Definition coap_io.h:69
@ COAP_NACK_ICMP_ISSUE
Definition coap_io.h:67
@ COAP_NACK_WS_LAYER_FAILED
Definition coap_io.h:70
@ COAP_NACK_RST
Definition coap_io.h:65
@ COAP_NACK_BAD_RESPONSE
Definition coap_io.h:68
#define COAP_SOCKET_MULTICAST
socket is used for multicast communication
void coap_epoll_ctl_add(coap_socket_t *sock, uint32_t events, const char *func)
Epoll specific function to add the state of events that epoll is to track for the appropriate file de...
#define COAP_SOCKET_NOT_EMPTY
the socket is not empty
#define COAP_SOCKET_BOUND
the socket is bound
#define COAP_SOCKET_WANT_READ
non blocking socket is waiting for reading
coap_endpoint_t * coap_malloc_endpoint(void)
#define COAP_SOCKET_WANT_CONNECT
non blocking client socket is waiting for connect
void coap_mfree_endpoint(coap_endpoint_t *ep)
coap_layer_func_t coap_layers_coap[COAP_PROTO_LAST][COAP_LAYER_LAST]
Definition coap_layers.c:39
@ COAP_LAYER_SESSION
Library specific build wrapper for coap_internal.h.
#define COAP_API
@ COAP_SESSION
Definition coap_mem.h:51
@ COAP_STRING
Definition coap_mem.h:39
void * coap_malloc_type(coap_memory_tag_t type, size_t size)
Allocates a chunk of size bytes and returns a pointer to the newly allocated memory.
void coap_free_type(coap_memory_tag_t type, void *p)
Releases the memory that was allocated by coap_malloc_type().
int coap_dtls_context_set_pki(coap_context_t *ctx COAP_UNUSED, const coap_dtls_pki_t *setup_data COAP_UNUSED, const coap_dtls_role_t role COAP_UNUSED)
Definition coap_notls.c:108
void * coap_dtls_get_tls(const coap_session_t *c_session COAP_UNUSED, coap_tls_library_t *tls_lib)
Definition coap_notls.c:158
unsigned int coap_dtls_get_overhead(coap_session_t *session COAP_UNUSED)
Definition coap_notls.c:261
int coap_dtls_context_check_keys_enabled(coap_context_t *ctx COAP_UNUSED)
Definition coap_notls.c:147
static const char * coap_proto_name(coap_proto_t proto)
COAP_API coap_mid_t coap_session_send_ping(coap_session_t *session)
Send a ping message for the session.
static const char * coap_nack_name(coap_nack_reason_t reason)
static coap_session_t * coap_make_session(coap_proto_t proto, coap_session_type_t type, const coap_addr_hash_t *addr_hash, const coap_address_t *local_addr, const coap_address_t *remote_addr, int ifindex, coap_context_t *context, coap_endpoint_t *endpoint)
static size_t coap_session_max_pdu_size_internal(const coap_session_t *session, size_t max_with_header)
#define INET6_ADDRSTRLEN
void coap_session_set_no_observe_cancel(coap_session_t *session)
Disable client automatically sending observe cancel on session close.
#define SESSIONS_ADD(e, obj)
#define SESSIONS_ITER_SAFE(e, el, rtmp)
#define COAP_PARTIAL_SESSION_TIMEOUT_TICKS
#define SESSIONS_DELETE(e, obj)
#define COAP_DEFAULT_MAX_HANDSHAKE_SESSIONS
#define SESSIONS_ITER(e, el, rtmp)
#define SESSIONS_FIND(e, k, res)
void coap_block_delete_lg_srcv(coap_session_t *session, coap_lg_srcv_t *lg_srcv)
void coap_block_delete_lg_crcv(coap_session_t *session, coap_lg_crcv_t *lg_crcv)
void coap_check_update_token(coap_session_t *session, coap_pdu_t *pdu)
The function checks if the token needs to be updated before PDU is presented to the application (only...
void coap_block_delete_lg_xmit(coap_session_t *session, coap_lg_xmit_t *lg_xmit)
void coap_delete_cache_entry(coap_context_t *context, coap_cache_entry_t *cache_entry)
Remove a cache-entry from the hash list and free off all the appropriate contents apart from app_data...
#define COAP_DEFAULT_NON_MAX_RETRANSMIT
The number of times for requests for re-transmission of missing Q-Block1 when no response has been re...
uint16_t coap_session_get_non_max_retransmit(const coap_session_t *session)
Get the CoAP NON maximum retransmit count of missing Q-Block1 or Q-Block2 requested before there is a...
coap_fixed_point_t coap_session_get_default_leisure(const coap_session_t *session)
Get the CoAP default leisure time RFC7252 DEFAULT_LEISURE.
void coap_session_set_max_retransmit(coap_session_t *session, uint16_t value)
Set the CoAP maximum retransmit count before failure.
#define COAP_DEFAULT_NON_TIMEOUT
The delay (+ ACK_RANDOM_FACTOR) to introduce once NON MAX_PAYLOADS Q-Block1 or Q-Block2 have been sen...
coap_fixed_point_t coap_session_get_non_timeout(const coap_session_t *session)
Get the CoAP MAX_PAYLOADS limit delay timeout.
void coap_session_set_ack_random_factor(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP ack randomize factor.
#define COAP_DEFAULT_MAX_LATENCY
The MAX_LATENCY definition.
coap_fixed_point_t coap_session_get_ack_random_factor(const coap_session_t *session)
Get the CoAP ack randomize factor.
#define COAP_DEFAULT_ACK_RANDOM_FACTOR
A factor that is used to randomize the wait time before a message is retransmitted to prevent synchro...
uint16_t coap_session_get_max_retransmit(const coap_session_t *session)
Get the CoAP maximum retransmit before failure.
void coap_session_set_max_payloads(coap_session_t *session, uint16_t value)
Set the CoAP maximum payloads count of Q-Block1 or Q-Block2 before delay is introduced RFC9177 MAX_PA...
#define COAP_DEFAULT_MAX_RETRANSMIT
Number of message retransmissions before message sending is stopped.
uint32_t coap_session_get_probing_rate(const coap_session_t *session)
Get the CoAP probing rate when there is no response RFC7252 PROBING_RATE.
#define COAP_DEFAULT_ACK_TIMEOUT
Number of seconds when to expect an ACK or a response to an outstanding CON message.
#define COAP_DEFAULT_DEFAULT_LEISURE
The number of seconds to use as bounds for multicast traffic RFC 7252, Section 4.8 Default value of D...
void coap_session_set_ack_timeout(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP initial ack response timeout before the next re-transmit.
#define COAP_DEFAULT_NSTART
The number of simultaneous outstanding interactions that a client maintains to a given server.
void coap_session_set_non_receive_timeout(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP non receive timeout delay timeout.
void coap_session_set_nstart(coap_session_t *session, uint16_t value)
Set the CoAP maximum concurrent transmission count of Confirmable messages RFC7252 NSTART.
#define COAP_DEFAULT_PROBING_RATE
The number of bytes/second allowed when there is no response RFC 7252, Section 4.8 Default value of P...
void coap_session_set_non_max_retransmit(coap_session_t *session, uint16_t value)
Set the CoAP NON maximum retransmit count of missing Q-Block1 or Q-Block2 requested before there is a...
uint16_t coap_session_get_max_payloads(const coap_session_t *session)
Get the CoAP maximum payloads count of Q-Block1 or Q-Block2 before delay is introduced RFC9177 MAX_PA...
#define COAP_DEFAULT_NON_RECEIVE_TIMEOUT
The time to wait for any missing Q-Block1 or Q-Block2 packets before requesting re-transmission of mi...
void coap_session_set_probing_rate(coap_session_t *session, uint32_t value)
Set the CoAP probing rate when there is no response RFC7252 PROBING_RATE.
void coap_session_set_default_leisure(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP default leisure time (for multicast) RFC7252 DEFAULT_LEISURE.
coap_fixed_point_t coap_session_get_non_receive_timeout(const coap_session_t *session)
Get the CoAP non receive timeout delay timeout.
uint16_t coap_session_get_nstart(const coap_session_t *session)
Get the CoAP maximum concurrent transmission count of Confirmable messages RFC7252 NSTART.
#define COAP_DEFAULT_MAX_PAYLOADS
Number of Q-Block1 or Q-Block2 payloads that can be sent in a burst before a delay has to kick in.
coap_fixed_point_t coap_session_get_ack_timeout(const coap_session_t *session)
Get the CoAP initial ack response timeout before the next re-transmit.
void coap_session_set_non_timeout(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP non timeout delay timeout.
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition coap_time.h:143
#define COAP_TICKS_PER_SECOND
Use ms resolution on POSIX systems.
Definition coap_time.h:158
int coap_prng_lkd(void *buf, size_t len)
Fills buf with len random bytes using the default pseudo random number generator.
Definition coap_prng.c:178
#define RESOURCES_ITER(r, tmp)
int coap_handle_event_lkd(coap_context_t *context, coap_event_t event, coap_session_t *session)
Invokes the event handler of context for the given event and data.
Definition coap_net.c:4761
uint16_t coap_new_message_id_lkd(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
int coap_delete_node_lkd(coap_queue_t *node)
Destroys specified node.
Definition coap_net.c:227
int coap_remove_from_queue(coap_queue_t **queue, coap_session_t *session, coap_mid_t id, coap_queue_t **node)
This function removes the element with given id from the list given list.
Definition coap_net.c:2816
int coap_client_delay_first(coap_session_t *session)
Delay the sending of the first client request until some other negotiation has completed.
Definition coap_net.c:1295
unsigned int coap_calc_timeout(coap_session_t *session, unsigned char r)
Calculates the initial timeout based on the session CoAP transmission parameters 'ack_timeout',...
Definition coap_net.c:1192
coap_mid_t coap_send_internal(coap_session_t *session, coap_pdu_t *pdu, coap_pdu_t *request_pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:1780
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition coap_net.c:1218
coap_queue_t * coap_new_node(void)
Creates a new node suitable for adding to the CoAP sendqueue.
Definition coap_net.c:256
void coap_cancel_session_messages(coap_context_t *context, coap_session_t *session, coap_nack_reason_t reason)
Cancels all outstanding messages for session session.
Definition coap_net.c:2920
void coap_cancel_all_messages(coap_context_t *context, coap_session_t *session, coap_bin_const_t *token)
Cancels all outstanding messages for session session that have the specified token.
Definition coap_net.c:2959
void coap_ticks(coap_tick_t *)
Returns the current value of an internal tick counter.
COAP_API uint16_t coap_new_message_id(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
@ COAP_RESPONSE_OK
Response is fine.
Definition coap_net.h:50
void coap_dtls_establish(coap_session_t *session)
Layer function interface for layer below DTLS connect being established.
Definition coap_dtls.c:266
coap_session_t * coap_session_new_dtls_session(coap_session_t *session, coap_tick_t now)
Create a new DTLS session for the session.
int coap_dtls_context_set_cpsk(coap_context_t *coap_context, coap_dtls_cpsk_t *setup_data)
Set the DTLS context's default client PSK information.
#define COAP_DTLS_PKI_SETUP_VERSION
Latest PKI setup version.
Definition coap_dtls.h:307
#define COAP_DTLS_CPSK_SETUP_VERSION
Latest CPSK setup version.
Definition coap_dtls.h:405
coap_tls_library_t
Definition coap_dtls.h:70
@ COAP_DTLS_ROLE_CLIENT
Internal function invoked for client.
Definition coap_dtls.h:45
unsigned int coap_encode_var_safe(uint8_t *buf, size_t length, unsigned int val)
Encodes multiple-length byte sequences.
Definition coap_encode.c:47
uint64_t coap_decode_var_bytes8(const uint8_t *buf, size_t len)
Decodes multiple-length byte sequences.
Definition coap_encode.c:67
unsigned int coap_encode_var_safe8(uint8_t *buf, size_t length, uint64_t val)
Encodes multiple-length byte sequences.
Definition coap_encode.c:77
@ COAP_EVENT_SESSION_CONNECTED
Triggered when TCP layer completes exchange of CSM information.
Definition coap_event.h:61
@ COAP_EVENT_TCP_FAILED
Triggered when TCP layer fails for some reason.
Definition coap_event.h:55
@ COAP_EVENT_SESSION_FAILED
Triggered when TCP layer fails following exchange of CSM information.
Definition coap_event.h:65
@ COAP_EVENT_SERVER_SESSION_NEW
Called in the CoAP IO loop if a new server-side session is created due to an incoming connection.
Definition coap_event.h:85
@ COAP_EVENT_SESSION_CLOSED
Triggered when TCP layer closes following exchange of CSM information.
Definition coap_event.h:63
@ COAP_EVENT_SERVER_SESSION_DEL
Called in the CoAP IO loop if a server session is deleted (e.g., due to inactivity or because the max...
Definition coap_event.h:94
@ COAP_EVENT_TCP_CLOSED
Triggered when TCP layer is closed.
Definition coap_event.h:53
@ COAP_EVENT_TCP_CONNECTED
Triggered when TCP layer connects.
Definition coap_event.h:51
@ COAP_EVENT_KEEPALIVE_FAILURE
Triggered when no response to a keep alive (ping) packet.
Definition coap_event.h:132
#define coap_lock_unlock(c)
Dummy for no thread-safe code.
#define coap_lock_lock(c, failed)
Dummy for no thread-safe code.
#define coap_lock_callback(c, func)
Dummy for no thread-safe code.
#define coap_lock_check_locked(c)
Dummy for no thread-safe code.
#define coap_log_debug(...)
Definition coap_debug.h:120
coap_log_t coap_get_log_level(void)
Get the current logging level.
Definition coap_debug.c:101
size_t coap_print_addr(const coap_address_t *addr, unsigned char *buf, size_t len)
Print the address into the defined buffer.
Definition coap_debug.c:239
const char * coap_endpoint_str(const coap_endpoint_t *endpoint)
Get endpoint description.
const char * coap_session_str(const coap_session_t *session)
Get session description.
#define coap_log_info(...)
Definition coap_debug.h:108
#define coap_log_warn(...)
Definition coap_debug.h:102
#define coap_log_err(...)
Definition coap_debug.h:96
#define coap_log_crit(...)
Definition coap_debug.h:90
@ COAP_LOG_DEBUG
Definition coap_debug.h:58
int coap_netif_dgrm_listen(coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
Layer function interface for Netif datagram listem (udp).
void coap_netif_close_ep(coap_endpoint_t *endpoint)
Layer function interface for Netif close for a endpoint.
int coap_netif_strm_connect1(coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
Layer function interface for Netif stream connect (tcp).
int coap_netif_strm_accept(coap_endpoint_t *endpoint, coap_session_t *session, void *extra)
Layer function interface for Netif stream accept.
int coap_netif_strm_listen(coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
Layer function interface for Netif stream listem (tcp).
int coap_netif_dgrm_connect(coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
Layer function interface for Netif datagram connect (udp).
int coap_netif_available(coap_session_t *session)
Function interface to check whether netif for session is still available.
Definition coap_netif.c:25
int coap_netif_available_ep(coap_endpoint_t *endpoint)
Function interface to check whether netif for endpoint is still available.
void coap_delete_oscore_associations(coap_session_t *session)
Cleanup all allocated OSCORE association information.
coap_pdu_t * coap_pdu_reference_lkd(coap_pdu_t *pdu)
Increment reference counter on a pdu to stop it prematurely getting freed off when coap_delete_pdu() ...
Definition coap_pdu.c:1623
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
Definition coap_pdu.c:190
int coap_update_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Updates token in pdu with length len and data.
Definition coap_pdu.c:413
#define COAP_PDU_MAX_UDP_HEADER_SIZE
#define COAP_PDU_DELAYED
#define COAP_PDU_MAX_TCP_HEADER_SIZE
#define COAP_MAX_MESSAGE_SIZE_TCP8
#define COAP_MAX_MESSAGE_SIZE_TCP0
size_t coap_pdu_encode_header(coap_pdu_t *pdu, coap_proto_t proto)
Compose the protocol specific header for the specified PDU.
Definition coap_pdu.c:1485
#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:776
#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:263
#define COAP_TOKEN_DEFAULT_MAX
Definition coap_pdu.h:56
#define COAP_SIGNALING_OPTION_EXTENDED_TOKEN_LENGTH
Definition coap_pdu.h:199
coap_proto_t
CoAP protocol types.
Definition coap_pdu.h:312
#define COAP_SIGNALING_OPTION_BLOCK_WISE_TRANSFER
Definition coap_pdu.h:198
#define COAPS_DEFAULT_PORT
Definition coap_pdu.h:38
coap_pdu_t * coap_pdu_init(coap_pdu_type_t type, coap_pdu_code_t code, coap_mid_t mid, size_t size)
Creates a new CoAP PDU with at least enough storage space for the given size maximum message size.
Definition coap_pdu.c:99
#define COAP_INVALID_MID
Indicates an invalid message id.
Definition coap_pdu.h:266
#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:197
@ COAP_PROTO_WS
Definition coap_pdu.h:318
@ COAP_PROTO_DTLS
Definition coap_pdu.h:315
@ COAP_PROTO_UDP
Definition coap_pdu.h:314
@ COAP_PROTO_NONE
Definition coap_pdu.h:313
@ COAP_PROTO_TLS
Definition coap_pdu.h:317
@ COAP_PROTO_WSS
Definition coap_pdu.h:319
@ COAP_PROTO_TCP
Definition coap_pdu.h:316
@ COAP_PROTO_LAST
Definition coap_pdu.h:320
@ COAP_SIGNALING_CODE_CSM
Definition coap_pdu.h:365
@ COAP_SIGNALING_CODE_PING
Definition coap_pdu.h:366
@ 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_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:1070
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.
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
#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.
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_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_pdu_t pdu
skeletal PDU
coap_binary_t * app_token
app requesting PDU token
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_session_t * session
the CoAP session
coap_pdu_t * pdu
the CoAP PDU to send
unsigned int timeout
the randomized timeout value
struct coap_queue_t * next
coap_mid_t id
CoAP message id.
coap_tick_t t
when to send PDU for the next time
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
coap_lg_xmit_t * lg_xmit
list of large transmissions
volatile uint8_t max_token_checked
Check for max token size coap_ext_token_check_t.
coap_bin_const_t * psk_key
If client, this field contains the current pre-shared key for server; When this field is NULL,...
coap_endpoint_t * endpoint
session's endpoint
uint32_t block_mode
Zero or more COAP_BLOCK_ or'd options.
coap_app_data_free_callback_t app_cb
call-back to release app_data
uint8_t doing_first
Set if doing client's first request.
coap_socket_t sock
socket object for the session, if any
coap_pdu_t * partial_pdu
incomplete incoming pdu
uint32_t max_token_size
Largest token size supported RFC8974.
uint16_t nstart
maximum concurrent confirmable xmits (default 1)
coap_bin_const_t * psk_identity
If client, this field contains the current identity for server; When this field is NULL,...
coap_session_state_t state
current state of relationship with peer
uint64_t tx_token
Next token number to use.
coap_bin_const_t * client_cid
Contains client CID or NULL.
coap_address_t local_reconnect
local address to initiate reconnect from
uint8_t csm_bert_loc_support
CSM TCP BERT blocks supported (local)
coap_addr_tuple_t addr_info
remote/local address info
coap_proto_t proto
protocol used
uint16_t tx_mid
the last message id that was used in this session
uint8_t is_dtls13
Set if session is DTLS1.3.
unsigned ref
reference count from queues
size_t csm_rcv_mtu
CSM mtu (rcv)
coap_response_t last_con_handler_res
The result of calling the response handler of the last CON.
coap_bin_const_t * psk_hint
If client, this field contains the server provided identity hint.
coap_bin_const_t * last_token
uint8_t doing_send_recv
Set if coap_send_recv() active.
coap_dtls_cpsk_t cpsk_setup_data
client provided PSK initial setup data
size_t mtu
path or CSM mtu (xmt)
uint8_t no_observe_cancel
Set if do not cancel observe on session close.
size_t partial_read
if > 0 indicates number of bytes already read for an incoming message
int dtls_event
Tracking any (D)TLS events on this session.
uint16_t max_retransmit
maximum re-transmit count (default 4)
coap_fixed_point_t ack_random_factor
ack random factor backoff (default 1.5)
uint8_t proxy_session
Set if this is an ongoing proxy session.
uint8_t con_active
Active CON request sent.
coap_queue_t * delayqueue
list of delayed messages waiting to be sent
size_t tls_overhead
overhead of TLS layer
void * app_data
application-specific data
uint32_t tx_rtag
Next Request-Tag number to use.
coap_mid_t last_ping_mid
the last keepalive message id that was used in this session
coap_lg_srcv_t * lg_srcv
Server list of expected large receives.
coap_bin_const_t * req_token
Token in request pdu of coap_send_recv()
coap_lg_crcv_t * lg_crcv
Client list of expected large receives.
coap_fixed_point_t ack_timeout
timeout waiting for ack (default 2.0 secs)
coap_fixed_point_t default_leisure
Mcast leisure time (default 5.0 secs)
coap_mid_t last_con_mid
The last CON mid that has been been processed.
coap_session_type_t type
client or server side socket
uint32_t probing_rate
Max transfer wait when remote is not respoding (default 1 byte/sec)
coap_mid_t last_ack_mid
The last ACK mid that has been been processed.
coap_context_t * context
session's context
uint8_t session_failed
Set if session failed and can try re-connect.
size_t partial_write
if > 0 indicates number of bytes already written from the pdu at the head of sendqueue
coap_addr_hash_t addr_hash
Address hash for server incoming packets.
coap_pdu_t * cached_pdu
Cached copy of last ACK response PDU.
int ifindex
interface index
coap_bin_const_t * echo
last token used to make a request
coap_layer_func_t lfunc[COAP_LAYER_LAST]
Layer functions to use.
coap_session_t * session
Used to determine session owner.
coap_endpoint_t * endpoint
Used by the epoll logic for a listening endpoint.
coap_address_t mcast_addr
remote address and port (multicast track)
coap_socket_flags_t flags
1 or more of COAP_SOCKET* flag values