libcoap 4.3.5-develop-4c7ce99
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
398void
399coap_session_set_app_data(coap_session_t *session, void *app_data) {
400 assert(session);
401 session->app = app_data;
402}
403
404void *
406 assert(session);
407 return session->app;
408}
409
410static coap_session_t *
412 const coap_addr_hash_t *addr_hash,
413 const coap_address_t *local_addr,
414 const coap_address_t *remote_addr, int ifindex,
415 coap_context_t *context, coap_endpoint_t *endpoint) {
417 sizeof(coap_session_t));
418#if ! COAP_SERVER_SUPPORT
419 (void)endpoint;
420#endif /* ! COAP_SERVER_SUPPORT */
421 if (!session)
422 return NULL;
423 memset(session, 0, sizeof(*session));
424 session->proto = proto;
425 session->type = type;
426 if (addr_hash)
427 memcpy(&session->addr_hash, addr_hash, sizeof(session->addr_hash));
428 else
429 memset(&session->addr_hash, 0, sizeof(session->addr_hash));
430 if (local_addr)
431 coap_address_copy(&session->addr_info.local, local_addr);
432 else
434 if (remote_addr)
435 coap_address_copy(&session->addr_info.remote, remote_addr);
436 else
438 session->ifindex = ifindex;
439 session->context = context;
440#if COAP_SERVER_SUPPORT
441 session->endpoint = endpoint;
442 if (endpoint)
443 session->mtu = endpoint->default_mtu;
444 else
445#endif /* COAP_SERVER_SUPPORT */
447 session->block_mode = context->block_mode;
448 if (proto == COAP_PROTO_DTLS) {
449 session->tls_overhead = 29;
450 if (session->tls_overhead >= session->mtu) {
451 session->tls_overhead = session->mtu;
452 coap_log_err("DTLS overhead exceeds MTU\n");
453 }
454 }
458 session->nstart = COAP_DEFAULT_NSTART;
461#if COAP_Q_BLOCK_SUPPORT
462 session->max_payloads = COAP_DEFAULT_MAX_PAYLOADS;
463 session->non_max_retransmit = COAP_DEFAULT_NON_MAX_RETRANSMIT;
464 session->non_timeout = COAP_DEFAULT_NON_TIMEOUT;
465 session->non_receive_timeout = COAP_DEFAULT_NON_RECEIVE_TIMEOUT;
466 coap_session_fix_non_probing_wait_base(session);
467 coap_session_fix_non_partial_timeout(session);
468#endif /* COAP_Q_BLOCK_SUPPORT */
469 session->dtls_event = -1;
474 session->max_token_size = context->max_token_size; /* RFC8974 */
475 if (session->type != COAP_SESSION_TYPE_CLIENT)
477
478 /* Randomly initialize */
479 /* TCP/TLS have no notion of mid */
480 if (COAP_PROTO_NOT_RELIABLE(session->proto))
481 coap_prng_lkd((unsigned char *)&session->tx_mid, sizeof(session->tx_mid));
482 coap_prng_lkd((unsigned char *)&session->tx_rtag, sizeof(session->tx_rtag));
483
484 return session;
485}
486
487void
489 coap_queue_t *q, *tmp;
490 coap_lg_xmit_t *lq, *ltmp;
491
492#if COAP_CLIENT_SUPPORT
493 coap_lg_crcv_t *lg_crcv, *etmp;
494
495 /* Need to do this before (D)TLS and socket is closed down */
496 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
497 if (lg_crcv->observe_set && session->no_observe_cancel == 0) {
498 /* Need to close down observe */
499 if (coap_cancel_observe_lkd(session, lg_crcv->app_token, COAP_MESSAGE_NON)) {
500 /* Need to delete node we set up for NON */
501 coap_queue_t *queue = session->context->sendqueue;
502
503 while (queue) {
504 if (queue->session == session) {
506 break;
507 }
508 queue = queue->next;
509 }
510 }
511 }
512 LL_DELETE(session->lg_crcv, lg_crcv);
513 coap_block_delete_lg_crcv(session, lg_crcv);
514 }
515#endif /* COAP_CLIENT_SUPPORT */
516
517 if (session->partial_pdu)
519 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
520 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
521 if (session->psk_identity)
523 if (session->psk_key)
525 if (session->psk_hint)
527
528#if COAP_SERVER_SUPPORT
529 coap_cache_entry_t *cp, *ctmp;
530 HASH_ITER(hh, session->context->cache, cp, ctmp) {
531 /* cp->session is NULL if not session based */
532 if (cp->session == session) {
533 coap_delete_cache_entry(session->context, cp);
534 }
535 }
536#endif /* COAP_SERVER_SUPPORT */
537 LL_FOREACH_SAFE(session->delayqueue, q, tmp) {
538 if (q->pdu->type==COAP_MESSAGE_CON) {
539 coap_handle_nack(session, q->pdu,
540 session->proto == COAP_PROTO_DTLS ?
542 q->id);
543 }
545 }
546 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
547 LL_DELETE(session->lg_xmit, lq);
548 coap_block_delete_lg_xmit(session, lq);
549 }
550#if COAP_SERVER_SUPPORT
551 coap_lg_srcv_t *sq, *stmp;
552
553 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
554 LL_DELETE(session->lg_srcv, sq);
555 coap_block_delete_lg_srcv(session, sq);
556 }
557#endif /* COAP_SERVER_SUPPORT */
558#if COAP_OSCORE_SUPPORT
560#endif /* COAP_OSCORE_SUPPORT */
561#if COAP_WS_SUPPORT
562 coap_free_type(COAP_STRING, session->ws);
563 coap_delete_str_const(session->ws_host);
564#endif /* COAP_WS_SUPPORT */
565}
566
567void
569 if (!session)
570 return;
572 assert(session->ref == 0);
573 if (session->ref)
574 return;
575 /* Make sure nothing gets deleted under our feet */
577 coap_session_mfree(session);
578#if COAP_SERVER_SUPPORT
580 if (session->endpoint) {
581 if (session->endpoint->sessions)
582 SESSIONS_DELETE(session->endpoint->sessions, session);
583 } else
584#endif /* COAP_SERVER_SUPPORT */
585#if COAP_CLIENT_SUPPORT
586 if (session->context) {
587 if (session->context->sessions)
588 SESSIONS_DELETE(session->context->sessions, session);
589 }
591#endif /* COAP_CLIENT_SUPPORT */
593 coap_delete_bin_const(session->echo);
594#if COAP_SERVER_SUPPORT
596#endif /* COAP_SERVER_SUPPORT */
597 coap_log_debug("***%s: session %p: closed\n", coap_session_str(session),
598 (void *)session);
599
600 assert(session->ref == 1);
602}
603
604#if COAP_SERVER_SUPPORT
605void
607 int i;
608
611 coap_cancel_all_messages(session->context, session, NULL);
612 RESOURCES_ITER(session->context->resources, r) {
613 /* In case code is broken somewhere */
614 for (i = 0; i < 1000; i++) {
615 if (!coap_delete_observer(r, session, NULL))
616 break;
617 }
618 }
619 if (session->context->unknown_resource) {
620 /* In case code is broken somewhere */
621 for (i = 0; i < 1000; i++) {
622 if (!coap_delete_observer(session->context->unknown_resource, session, NULL))
623 break;
624 }
625 }
626 if (session->context->proxy_uri_resource) {
627 /* In case code is broken somewhere */
628 for (i = 0; i < 1000; i++) {
629 if (!coap_delete_observer(session->context->proxy_uri_resource, session, NULL))
630 break;
631 }
632 }
633 while (session->delayqueue) {
634 coap_queue_t *q = session->delayqueue;
635
636 session->delayqueue = q->next;
638 }
639 /* Force session to go away */
642
644}
645#endif /* COAP_SERVER_SUPPORT */
646
647static size_t
649 size_t max_with_header) {
650#if COAP_DISABLE_TCP
651 (void)session;
652 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
653 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
654 : 0;
655#else /* !COAP_DISABLE_TCP */
656 if (COAP_PROTO_NOT_RELIABLE(session->proto))
657 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
658 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
659 : 0;
660 /* we must assume there is no token to be on the safe side */
661 if (max_with_header <= 2)
662 return 0;
663 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP0 + 2)
664 return max_with_header - 2;
665 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP8 + 3)
666 return max_with_header - 3;
667 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP16 + 4)
668 return max_with_header - 4;
669 else
670 return max_with_header - COAP_PDU_MAX_TCP_HEADER_SIZE;
671#endif /* !COAP_DISABLE_TCP */
672}
673
674size_t
676 if (session->csm_rcv_mtu)
678 (size_t)(session->csm_rcv_mtu));
679
681 (size_t)(session->mtu - session->tls_overhead));
682}
683
684COAP_API size_t
686 size_t size;
687 coap_session_t *session_rw;
688
689 /*
690 * Need to do this to not get a compiler warning about const parameters
691 * but need to maintain source code backward compatibility
692 */
693 memcpy(&session_rw, &session, sizeof(session_rw));
694 coap_lock_lock(session_rw->context, return 0);
695 size = coap_session_max_pdu_size_lkd(session_rw);
696 coap_lock_unlock(session_rw->context);
697 return size;
698}
699
700size_t
702 size_t max_with_header;
703
705#if COAP_CLIENT_SUPPORT
706 /*
707 * Delay if session->doing_first is set.
708 * E.g. Reliable and CSM not in yet for checking block support
709 */
710 coap_session_t *session_rw;
711
712 /*
713 * Need to do this to not get a compiler warning about const parameters
714 * but need to maintain source code backward compatibility
715 */
716 memcpy(&session_rw, &session, sizeof(session_rw));
717 if (coap_client_delay_first(session_rw) == 0) {
718 coap_log_debug("coap_client_delay_first: timeout\n");
719 /* Have to go with the defaults */
720 }
721#endif /* COAP_CLIENT_SUPPORT */
722
723 max_with_header = (size_t)(session->mtu - session->tls_overhead);
724
725 return coap_session_max_pdu_size_internal(session, max_with_header);
726}
727
728void
729coap_session_set_mtu(coap_session_t *session, unsigned mtu) {
730#if defined(WITH_CONTIKI) || defined(WITH_LWIP)
731 if (mtu > COAP_DEFAULT_MAX_PDU_RX_SIZE)
732 mtu = COAP_DEFAULT_MAX_PDU_RX_SIZE;
733#endif
734 if (mtu < 64)
735 mtu = 64;
736 session->mtu = mtu;
737 if (session->tls_overhead >= session->mtu) {
738 session->tls_overhead = session->mtu;
739 coap_log_err("DTLS overhead exceeds MTU\n");
740 }
741}
742
743ssize_t
745 coap_queue_t *node) {
746 if (node) {
747 coap_queue_t *removed = NULL;
748 coap_remove_from_queue(&session->context->sendqueue, session, node->id, &removed);
749 assert(removed == node);
751 node->session = NULL;
752 node->t = 0;
753 } else {
754 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
755 coap_queue_t *q = NULL;
756 /* Check same mid is not getting re-used in violation of RFC7252 */
757 LL_FOREACH(session->delayqueue, q) {
758 if (q->id == pdu->mid) {
759 coap_log_err("** %s: mid=0x%04x: already in-use - dropped\n",
760 coap_session_str(session), pdu->mid);
761 return COAP_INVALID_MID;
762 }
763 }
764 }
765 node = coap_new_node();
766 if (node == NULL)
767 return COAP_INVALID_MID;
768 node->id = pdu->mid;
769 node->pdu = pdu;
770 if (pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
771 uint8_t r;
772 coap_prng_lkd(&r, sizeof(r));
773 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
774 node->timeout = coap_calc_timeout(session, r);
775 }
776 }
777 LL_APPEND(session->delayqueue, node);
778 coap_log_debug("** %s: mid=0x%04x: delayed\n",
779 coap_session_str(session), node->id);
780 return COAP_PDU_DELAYED;
781}
782
783#if !COAP_DISABLE_TCP
784void
786 coap_pdu_t *pdu;
787 uint8_t buf[4];
788 assert(COAP_PROTO_RELIABLE(session->proto));
789 coap_log_debug("***%s: sending CSM\n", coap_session_str(session));
790 session->state = COAP_SESSION_STATE_CSM;
791 session->partial_write = 0;
792 if (session->mtu == 0)
793 coap_session_set_mtu(session, COAP_DEFAULT_MTU); /* base value */
795 if (pdu == NULL
797 coap_encode_var_safe(buf, sizeof(buf),
798 session->context->csm_max_message_size), buf) == 0
800 coap_encode_var_safe(buf, sizeof(buf),
801 0), buf) == 0
802 || (session->max_token_size > COAP_TOKEN_DEFAULT_MAX &&
805 coap_encode_var_safe(buf, sizeof(buf),
806 session->max_token_size),
807 buf) == 0)
808 || coap_pdu_encode_header(pdu, session->proto) == 0
809 ) {
811 } else {
812 ssize_t bytes_written;
813
814 pdu->session = session;
815 bytes_written = coap_session_send_pdu(session, pdu);
816 if (bytes_written != (ssize_t)pdu->used_size + pdu->hdr_size) {
818 } else {
819 session->csm_rcv_mtu = session->context->csm_max_message_size;
820 if (session->csm_rcv_mtu > COAP_BERT_BASE)
821 session->csm_bert_loc_support = 1;
822 else
823 session->csm_bert_loc_support = 0;
824 }
825 }
826 if (pdu)
828}
829#endif /* !COAP_DISABLE_TCP */
830
833 coap_mid_t mid;
834
835 coap_lock_lock(session->context, return COAP_INVALID_MID);
836 mid = coap_session_send_ping_lkd(session);
837 coap_lock_unlock(session->context);
838 return mid;
839}
840
843 coap_pdu_t *ping = NULL;
844
846 if (session->state != COAP_SESSION_STATE_ESTABLISHED ||
847 session->con_active)
848 return COAP_INVALID_MID;
849 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
850 uint16_t mid = coap_new_message_id_lkd(session);
851 ping = coap_pdu_init(COAP_MESSAGE_CON, 0, mid, 0);
852 }
853#if !COAP_DISABLE_TCP
854 else {
856 }
857#endif /* !COAP_DISABLE_TCP */
858 if (!ping)
859 return COAP_INVALID_MID;
860 return coap_send_internal(session, ping, NULL);
861}
862
863void
865 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
866 coap_log_debug("***%s: session connected\n",
867 coap_session_str(session));
868 if (session->state == COAP_SESSION_STATE_CSM) {
870 if (session->doing_first)
871 session->doing_first = 0;
872 }
873 }
874
876 session->partial_write = 0;
877
878 if (session->proto==COAP_PROTO_DTLS) {
879 session->tls_overhead = coap_dtls_get_overhead(session);
880 if (session->tls_overhead >= session->mtu) {
881 session->tls_overhead = session->mtu;
882 coap_log_err("DTLS overhead exceeds MTU\n");
883 }
884 }
885
886 while (session->delayqueue && session->state == COAP_SESSION_STATE_ESTABLISHED) {
887 ssize_t bytes_written;
888 coap_queue_t *q = session->delayqueue;
889 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
890 if (session->con_active >= COAP_NSTART(session))
891 break;
892 session->con_active++;
893 }
894 /* Take entry off the queue */
895 session->delayqueue = q->next;
896 q->next = NULL;
897
898 coap_log_debug("** %s: mid=0x%04x: transmitted after delay\n",
899 coap_session_str(session), (int)q->pdu->mid);
900 bytes_written = coap_session_send_pdu(session, q->pdu);
901 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
902 if (coap_wait_ack(session->context, session, q) >= 0)
903 q = NULL;
904 }
905 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
906 if (q)
908 if (bytes_written < 0)
909 break;
910 } else if (q) {
911 if (bytes_written <= 0 || (size_t)bytes_written < q->pdu->used_size + q->pdu->hdr_size) {
912 q->next = session->delayqueue;
913 session->delayqueue = q;
914 if (bytes_written > 0)
915 session->partial_write = (size_t)bytes_written;
916 break;
917 } else {
919 }
920 }
921 }
922}
923
924#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
925static const char *
927 switch (reason) {
929 return "COAP_NACK_TOO_MANY_RETRIES";
931 return "COAP_NACK_NOT_DELIVERABLE";
932 case COAP_NACK_RST:
933 return "COAP_NACK_RST";
935 return "COAP_NACK_TLS_FAILED";
937 return "COAP_NACK_ICMP_ISSUE";
939 return "COAP_NACK_BAD_RESPONSE";
941 return "COAP_NACK_TLS_LAYER_FAILED";
943 return "COAP_NACK_WS_LAYER_FAILED";
945 return "COAP_NACK_WS_FAILED";
946 default:
947 return "???";
948 }
949}
950#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
951
952void
954 coap_pdu_t *sent,
955 const coap_nack_reason_t reason,
956 const coap_mid_t mid) {
957 if (session->context->nack_handler) {
958 coap_bin_const_t token;
959
960 if (sent) {
961 coap_check_update_token(session, sent);
962 token = sent->actual_token;
963 }
965 session->context->nack_handler(session, sent, reason, mid));
966 if (sent) {
967 coap_update_token(sent, token.length, token.s);
968 }
969 }
970#if COAP_CLIENT_SUPPORT
971 if (reason != COAP_NACK_ICMP_ISSUE) {
972 session->doing_send_recv = 0;
973 }
974#endif /* COAP_CLIENT_SUPPORT */
975}
976
977COAP_API void
979 coap_lock_lock(session->context, return);
980 coap_session_disconnected_lkd(session, reason);
981 coap_lock_unlock(session->context);
982}
983
984void
986#if !COAP_DISABLE_TCP
987 coap_session_state_t state = session->state;
988#endif /* !COAP_DISABLE_TCP */
989 coap_lg_xmit_t *lq, *ltmp;
990#if COAP_SERVER_SUPPORT
991 coap_lg_srcv_t *sq, *stmp;
992#endif /* COAP_SERVER_SUPPORT */
993#if COAP_CLIENT_SUPPORT
994 coap_lg_crcv_t *cq, *etmp;
995#endif /* COAP_CLIENT_SUPPORT */
996 int sent_nack = 0;
997 coap_queue_t *q;
998
1000 q = session->context->sendqueue;
1001
1002 while (q) {
1003 if (q->session == session) {
1004 /* Take the first one */
1005 coap_handle_nack(session, q->pdu, reason, q->id);
1006 sent_nack = 1;
1007 break;
1008 }
1009 q = q->next;
1010 }
1011
1012 if (reason != COAP_NACK_ICMP_ISSUE) {
1013 while (session->delayqueue) {
1014 q = session->delayqueue;
1015 session->delayqueue = q->next;
1016 q->next = NULL;
1017 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1018 coap_session_str(session), q->id);
1019 if (q->pdu->type == COAP_MESSAGE_CON) {
1020 coap_handle_nack(session, q->pdu, reason, q->id);
1021 sent_nack = 1;
1022 }
1023
1024#if COAP_CLIENT_SUPPORT
1025 session->doing_send_recv = 0;
1026#endif /* COAP_CLIENT_SUPPORT */
1028 }
1029 }
1030#if COAP_CLIENT_SUPPORT
1031 if (!sent_nack && session->lg_crcv) {
1032 /* Take the first one */
1033 coap_handle_nack(session, &session->lg_crcv->pdu, reason, session->lg_crcv->pdu.mid);
1034 sent_nack = 1;
1035 }
1036#endif /* COAP_CLIENT_SUPPORT */
1037 if (!sent_nack) {
1038 /* Unable to determine which request disconnection was for */
1039 coap_handle_nack(session, NULL, reason, 0);
1040 }
1041 if (reason == COAP_NACK_ICMP_ISSUE) {
1042 coap_log_debug("***%s: session ICMP issue (%s)\n",
1043 coap_session_str(session), coap_nack_name(reason));
1044 return;
1045 }
1046 coap_log_debug("***%s: session disconnected (%s)\n",
1047 coap_session_str(session), coap_nack_name(reason));
1048#if COAP_SERVER_SUPPORT
1049 coap_delete_observers(session->context, session);
1050#endif /* COAP_SERVER_SUPPORT */
1051
1052 if (session->proto == COAP_PROTO_UDP)
1054 else
1055 session->state = COAP_SESSION_STATE_NONE;
1056
1057 session->con_active = 0;
1058
1059 if (session->partial_pdu) {
1061 session->partial_pdu = NULL;
1062 }
1063 session->partial_read = 0;
1064
1065 /* Not done if nack handler called above */
1066 while (session->delayqueue) {
1067 q = session->delayqueue;
1068 session->delayqueue = q->next;
1069 q->next = NULL;
1070 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1071 coap_session_str(session), q->id);
1072#if COAP_CLIENT_SUPPORT
1073 session->doing_send_recv = 0;
1074#endif /* COAP_CLIENT_SUPPORT */
1076 }
1077
1078#if COAP_CLIENT_SUPPORT
1079 /* Need to do this before (D)TLS and socket is closed down */
1080 LL_FOREACH_SAFE(session->lg_crcv, cq, etmp) {
1081 LL_DELETE(session->lg_crcv, cq);
1082 coap_block_delete_lg_crcv(session, cq);
1083 }
1084#endif /* COAP_CLIENT_SUPPORT */
1085 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
1086 LL_DELETE(session->lg_xmit, lq);
1087 coap_block_delete_lg_xmit(session, lq);
1088 }
1089#if COAP_SERVER_SUPPORT
1090 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
1091 LL_DELETE(session->lg_srcv, sq);
1092 coap_block_delete_lg_srcv(session, sq);
1093 }
1094#endif /* COAP_SERVER_SUPPORT */
1095 coap_cancel_session_messages(session->context, session, reason);
1096
1097#if !COAP_DISABLE_TCP
1098 if (COAP_PROTO_RELIABLE(session->proto)) {
1099 if (coap_netif_available(session)) {
1103 }
1104 if (state != COAP_SESSION_STATE_NONE) {
1108 }
1109 if (session->doing_first)
1110 session->doing_first = 0;
1111 }
1112#endif /* !COAP_DISABLE_TCP */
1113 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1114}
1115
1116#if COAP_SERVER_SUPPORT
1117static void
1118coap_make_addr_hash(coap_addr_hash_t *addr_hash, coap_proto_t proto,
1119 const coap_addr_tuple_t *addr_info) {
1120 memset(addr_hash, 0, sizeof(coap_addr_hash_t));
1121 coap_address_copy(&addr_hash->remote, &addr_info->remote);
1122 addr_hash->lport = coap_address_get_port(&addr_info->local);
1123 addr_hash->proto = proto;
1124}
1125
1128 const coap_packet_t *packet, coap_tick_t now) {
1129 coap_session_t *session;
1130 coap_session_t *rtmp;
1131 unsigned int num_idle = 0;
1132 unsigned int num_hs = 0;
1133 coap_session_t *oldest = NULL;
1134 coap_session_t *oldest_hs = NULL;
1135 coap_addr_hash_t addr_hash;
1136
1137 coap_make_addr_hash(&addr_hash, endpoint->proto, &packet->addr_info);
1138 SESSIONS_FIND(endpoint->sessions, addr_hash, session);
1139 if (session) {
1140 /* Maybe mcast or unicast IP address which is not in the hash */
1141 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1142 session->ifindex = packet->ifindex;
1143 session->last_rx_tx = now;
1144 return session;
1145 }
1146
1147#if COAP_CLIENT_SUPPORT
1148 if (coap_is_mcast(&packet->addr_info.local)) {
1149 /* Check if this a proxy client packet we sent on another socket */
1150 SESSIONS_ITER(endpoint->context->sessions, session, rtmp) {
1151 if (coap_address_equals(&session->addr_info.remote, &packet->addr_info.local) &&
1154 /* Drop looped back packet to stop recursion / confusion */
1155 return NULL;
1156 }
1157 }
1158 }
1159#endif /* COAP_CLIENT_SUPPORT */
1160 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1161 if (session->ref == 0 && session->delayqueue == NULL) {
1162 if (session->type == COAP_SESSION_TYPE_SERVER) {
1163 ++num_idle;
1164 if (oldest==NULL || session->last_rx_tx < oldest->last_rx_tx)
1165 oldest = session;
1166
1167 if (session->state == COAP_SESSION_STATE_HANDSHAKE) {
1168 ++num_hs;
1169 /* See if this is a partial (D)TLS session set up
1170 which needs to be cleared down to prevent DOS */
1171 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1172 if (oldest_hs == NULL ||
1173 session->last_rx_tx < oldest_hs->last_rx_tx)
1174 oldest_hs = session;
1175 }
1176 }
1177 } else if (session->type == COAP_SESSION_TYPE_HELLO) {
1178 ++num_hs;
1179 /* See if this is a partial (D)TLS session set up for Client Hello
1180 which needs to be cleared down to prevent DOS */
1181 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1182 if (oldest_hs == NULL ||
1183 session->last_rx_tx < oldest_hs->last_rx_tx)
1184 oldest_hs = session;
1185 }
1186 }
1187 }
1188 }
1189
1190 if (endpoint->context->max_idle_sessions > 0 &&
1191 num_idle >= endpoint->context->max_idle_sessions) {
1193 coap_session_free(oldest);
1194 } else if (oldest_hs) {
1195 coap_log_warn("***%s: Incomplete session timed out\n",
1196 coap_session_str(oldest_hs));
1198 coap_session_free(oldest_hs);
1199 }
1200
1201 if (num_hs > (endpoint->context->max_handshake_sessions ?
1202 endpoint->context->max_handshake_sessions :
1204 /* Maxed out on number of sessions in (D)TLS negotiation state */
1205 coap_log_debug("Oustanding sessions in COAP_SESSION_STATE_HANDSHAKE too "
1206 "large. New request ignored\n");
1207 return NULL;
1208 }
1209
1210 if (endpoint->proto == COAP_PROTO_DTLS) {
1211 /*
1212 * Need to check that this actually is a Client Hello before wasting
1213 * time allocating and then freeing off session.
1214 */
1215
1216 /*
1217 * Generic header structure of the DTLS record layer.
1218 * typedef struct __attribute__((__packed__)) {
1219 * uint8_t content_type; content type of the included message
1220 * uint16_t version; Protocol version
1221 * uint16_t epoch; counter for cipher state changes
1222 * uint8_t sequence_number[6]; sequence number
1223 * uint16_t length; length of the following fragment
1224 * uint8_t handshake; If content_type == DTLS_CT_HANDSHAKE
1225 * } dtls_record_handshake_t;
1226 */
1227#define OFF_CONTENT_TYPE 0 /* offset of content_type in dtls_record_handshake_t */
1228#define DTLS_CT_ALERT 21 /* Content Type Alert */
1229#define DTLS_CT_HANDSHAKE 22 /* Content Type Handshake */
1230#define OFF_HANDSHAKE_TYPE 13 /* offset of handshake in dtls_record_handshake_t */
1231#define DTLS_HT_CLIENT_HELLO 1 /* Client Hello handshake type */
1232#define DTLS_CT_CID 25 /* Content Type Connection ID */
1233#define OFF_CID 11 /* offset of CID in dtls_record_handshake_t */
1234#define OFF_CID_DTLS13 1 /* offset of CID in DTLS1.3 Unified Header */
1235
1236 const uint8_t *payload = (const uint8_t *)packet->payload;
1237 size_t length = packet->length;
1238 if (length < (OFF_HANDSHAKE_TYPE + 1)) {
1239 coap_log_debug("coap_dtls_hello: ContentType %d Short Packet (%zu < %d) dropped\n",
1240 payload[OFF_CONTENT_TYPE], length,
1241 OFF_HANDSHAKE_TYPE + 1);
1242 return NULL;
1243 }
1244 if ((payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 ||
1245 payload[OFF_CONTENT_TYPE] == DTLS_CT_CID) {
1246 /* Client may have changed its IP address */
1247 int changed = 0;
1248
1249 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1250 if (session->client_cid) {
1251 if ((session->is_dtls13 && (payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 &&
1252 memcmp(session->client_cid->s, &payload[OFF_CID_DTLS13],
1253 session->client_cid->length) == 0) ||
1254 (!session->is_dtls13 && payload[OFF_CONTENT_TYPE] == DTLS_CT_CID &&
1255 memcmp(session->client_cid->s, &payload[OFF_CID],
1256 session->client_cid->length) == 0)) {
1257 /* Updating IP address */
1258 coap_log_info("***%s: CID: Old Client Session\n", coap_session_str(session));
1259 SESSIONS_DELETE(endpoint->sessions, session);
1260 session->addr_info = packet->addr_info;
1261 memcpy(&session->addr_hash, &addr_hash, sizeof(session->addr_hash));
1262 SESSIONS_ADD(endpoint->sessions, session);
1263 coap_log_info("***%s: CID: New Client Session\n", coap_session_str(session));
1264 return session;
1265 }
1266 }
1267 }
1268 if (!changed) {
1269 coap_log_debug("coap_dtls_hello: ContentType Connection-IS dropped\n");
1270 return NULL;
1271 }
1272 } else if (payload[OFF_CONTENT_TYPE] != DTLS_CT_HANDSHAKE ||
1273 payload[OFF_HANDSHAKE_TYPE] != DTLS_HT_CLIENT_HELLO) {
1274 /* only log if not a late alert */
1275 if (payload[OFF_CONTENT_TYPE] != DTLS_CT_ALERT)
1276 coap_log_debug("coap_dtls_hello: ContentType %d Handshake %d dropped\n",
1277 payload[OFF_CONTENT_TYPE],
1278 payload[OFF_HANDSHAKE_TYPE]);
1279 return NULL;
1280 }
1281 }
1282
1284 &addr_hash, &packet->addr_info.local,
1285 &packet->addr_info.remote,
1286 packet->ifindex, endpoint->context, endpoint);
1287 if (session) {
1288 session->last_rx_tx = now;
1289 memcpy(session->sock.lfunc, endpoint->sock.lfunc,
1290 sizeof(session->sock.lfunc));
1291 if (endpoint->proto == COAP_PROTO_UDP)
1293 else if (endpoint->proto == COAP_PROTO_DTLS) {
1294 session->type = COAP_SESSION_TYPE_HELLO;
1295 }
1296 SESSIONS_ADD(endpoint->sessions, session);
1297 coap_log_debug("***%s: session %p: new incoming session\n",
1298 coap_session_str(session), (void *)session);
1300 }
1301 return session;
1302}
1303
1306 coap_tick_t now) {
1307 if (session) {
1308 session->last_rx_tx = now;
1309 session->type = COAP_SESSION_TYPE_SERVER;
1310 coap_dtls_establish(session);
1311 }
1312 return session;
1313}
1314#endif /* COAP_SERVER_SUPPORT */
1315
1316#if COAP_CLIENT_SUPPORT
1317static coap_session_t *
1318coap_session_create_client(coap_context_t *ctx,
1319 const coap_address_t *local_if,
1320 const coap_address_t *server,
1321 coap_proto_t proto) {
1322 coap_session_t *session = NULL;
1323 int default_port = COAP_DEFAULT_PORT;
1324
1325 assert(server);
1326
1327 switch (proto) {
1328 case COAP_PROTO_UDP:
1329 default_port = COAP_DEFAULT_PORT;
1330 break;
1331 case COAP_PROTO_DTLS:
1332 if (!coap_dtls_is_supported()) {
1333 coap_log_crit("coap_new_client_session*: DTLS not supported\n");
1334 return NULL;
1335 }
1336 default_port = COAPS_DEFAULT_PORT;
1337 break;
1338 case COAP_PROTO_TCP:
1339 if (!coap_tcp_is_supported()) {
1340 coap_log_crit("coap_new_client_session*: TCP not supported\n");
1341 return NULL;
1342 }
1343 default_port = COAP_DEFAULT_PORT;
1344 break;
1345 case COAP_PROTO_TLS:
1346 if (!coap_tls_is_supported()) {
1347 coap_log_crit("coap_new_client_session*: TLS not supported\n");
1348 return NULL;
1349 }
1350 default_port = COAPS_DEFAULT_PORT;
1351 break;
1352 case COAP_PROTO_WS:
1353 if (!coap_ws_is_supported()) {
1354 coap_log_crit("coap_new_client_session*: WS not supported\n");
1355 return NULL;
1356 }
1357 default_port = 80;
1358 break;
1359 case COAP_PROTO_WSS:
1360 if (!coap_wss_is_supported()) {
1361 coap_log_crit("coap_new_client_session*: WSS not supported\n");
1362 return NULL;
1363 }
1364 default_port = 443;
1365 break;
1366 case COAP_PROTO_NONE:
1367 case COAP_PROTO_LAST:
1368 default:
1369 assert(0);
1370 return NULL;
1371 }
1372 session = coap_make_session(proto, COAP_SESSION_TYPE_CLIENT, NULL,
1373 local_if, server, 0, ctx, NULL);
1374 if (!session)
1375 goto error;
1376
1378 session->sock.session = session;
1379 memcpy(&session->sock.lfunc, coap_layers_coap[proto],
1380 sizeof(session->sock.lfunc));
1381
1382 if (COAP_PROTO_NOT_RELIABLE(proto)) {
1383 coap_session_t *s, *rtmp;
1384 if (!coap_netif_dgrm_connect(session, local_if, server, default_port)) {
1385 goto error;
1386 }
1387 /* Check that this is not a duplicate 4-tuple */
1388 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
1391 &s->addr_info.local) &&
1393 &s->addr_info.remote)) {
1394 coap_log_warn("***%s: session %p: duplicate - already exists\n",
1395 coap_session_str(session), (void *)session);
1396 goto error;
1397 }
1398 }
1399#ifdef WITH_CONTIKI
1400 session->sock.context = ctx;
1401#endif /* WITH_CONTIKI */
1402#if !COAP_DISABLE_TCP
1403 } else if (COAP_PROTO_RELIABLE(proto)) {
1404 if (!coap_netif_strm_connect1(session, local_if, server, default_port)) {
1405 goto error;
1406 }
1407#endif /* !COAP_DISABLE_TCP */
1408 }
1409
1410#ifdef COAP_EPOLL_SUPPORT
1411 session->sock.session = session;
1412 coap_epoll_ctl_add(&session->sock,
1413 EPOLLIN |
1414 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1415 EPOLLOUT : 0),
1416 __func__);
1417#endif /* COAP_EPOLL_SUPPORT */
1418
1420 if (local_if)
1421 session->sock.flags |= COAP_SOCKET_BOUND;
1422#if COAP_SERVER_SUPPORT
1423 if (ctx->proxy_uri_resource)
1424 session->proxy_session = 1;
1425#endif /* COAP_SERVER_SUPPORT */
1426 SESSIONS_ADD(ctx->sessions, session);
1427 return session;
1428
1429error:
1430 /*
1431 * Need to add in the session as coap_session_release_lkd()
1432 * will call SESSIONS_DELETE in coap_session_free().
1433 */
1434 if (session)
1435 SESSIONS_ADD(ctx->sessions, session);
1436 coap_session_release_lkd(session);
1437 return NULL;
1438}
1439
1440static void
1441coap_session_check_connect(coap_session_t *session) {
1442 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1443 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1444 }
1445#if !COAP_DISABLE_TCP
1446 if (COAP_PROTO_RELIABLE(session->proto)) {
1447 if (session->sock.flags & COAP_SOCKET_WANT_CONNECT) {
1449 if (session->state != COAP_SESSION_STATE_ESTABLISHED &&
1450 session->state != COAP_SESSION_STATE_NONE &&
1451 session->type == COAP_SESSION_TYPE_CLIENT) {
1452 session->doing_first = 1;
1453 }
1454 } else {
1455 /* Initial connect worked immediately */
1456 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1457 }
1458 }
1459#endif /* !COAP_DISABLE_TCP */
1460 coap_ticks(&session->last_rx_tx);
1461}
1462#endif /* COAP_CLIENT_SUPPORT */
1463
1464void
1466 if (COAP_PROTO_NOT_RELIABLE(session->proto))
1467 coap_session_connected(session);
1468#if !COAP_DISABLE_TCP
1469 if (COAP_PROTO_RELIABLE(session->proto))
1470 coap_session_send_csm(session);
1471#endif /* !COAP_DISABLE_TCP */
1472}
1473
1474#if COAP_CLIENT_SUPPORT
1477 const coap_address_t *local_if,
1478 const coap_address_t *server,
1479 coap_proto_t proto) {
1480 coap_session_t *session;
1481
1482 coap_lock_lock(ctx, return NULL);
1483 session = coap_new_client_session_lkd(ctx, local_if, server, proto);
1484 coap_lock_unlock(ctx);
1485 return session;
1486}
1487
1490 const coap_address_t *local_if,
1491 const coap_address_t *server,
1492 coap_proto_t proto) {
1493 coap_session_t *session;
1494
1496 session = coap_session_create_client(ctx, local_if, server,
1497 proto);
1498 if (session) {
1499 coap_log_debug("***%s: session %p: created outgoing session\n",
1500 coap_session_str(session), (void *)session);
1501 coap_session_check_connect(session);
1502 }
1503 return session;
1504}
1505
1508 const coap_address_t *local_if,
1509 const coap_address_t *server,
1510 coap_proto_t proto, const char *identity,
1511 const uint8_t *key, unsigned key_len) {
1512 coap_session_t *session;
1513
1514 coap_lock_lock(ctx, return NULL);
1515 session = coap_new_client_session_psk_lkd(ctx, local_if, server, proto, identity, key, key_len);
1516 coap_lock_unlock(ctx);
1517 return session;
1518}
1519
1522 const coap_address_t *local_if,
1523 const coap_address_t *server,
1524 coap_proto_t proto, const char *identity,
1525 const uint8_t *key, unsigned key_len) {
1526 coap_dtls_cpsk_t setup_data;
1527
1529 memset(&setup_data, 0, sizeof(setup_data));
1531
1532 if (identity) {
1533 setup_data.psk_info.identity.s = (const uint8_t *)identity;
1534 setup_data.psk_info.identity.length = strlen(identity);
1535 }
1536
1537 if (key && key_len > 0) {
1538 setup_data.psk_info.key.s = key;
1539 setup_data.psk_info.key.length = key_len;
1540 }
1541
1542 return coap_new_client_session_psk2_lkd(ctx, local_if, server,
1543 proto, &setup_data);
1544}
1545
1546/*
1547 * Check the validity of the SNI to send to the server.
1548 *
1549 * https://datatracker.ietf.org/doc/html/rfc6066#section-3
1550 * Literal IPv4 and IPv6 addresses are not permitted in "HostName".
1551 */
1552static void
1553coap_sanitize_client_sni(char **client_sni) {
1554 char *cp;
1555
1556 if (*client_sni == NULL)
1557 return;
1558
1559 cp = *client_sni;
1560 switch (*cp) {
1561 case '0':
1562 case '1':
1563 case '2':
1564 case '3':
1565 case '4':
1566 case '5':
1567 case '6':
1568 case '7':
1569 case '8':
1570 case '9':
1571 case 'a':
1572 case 'b':
1573 case 'c':
1574 case 'd':
1575 case 'e':
1576 case 'f':
1577 case 'A':
1578 case 'B':
1579 case 'C':
1580 case 'D':
1581 case 'E':
1582 case 'F':
1583 case ':':
1584 break;
1585 case '\000':
1586 /* Empty entry invalid */
1587 *client_sni = NULL;
1588 return;
1589 default:
1590 /* Does not start with a hex digit or : - not literal IP. */
1591 return;
1592 }
1593 /* Check for IPv4 */
1594 while (*cp) {
1595 switch (*cp) {
1596 case '0':
1597 case '1':
1598 case '2':
1599 case '3':
1600 case '4':
1601 case '5':
1602 case '6':
1603 case '7':
1604 case '8':
1605 case '9':
1606 case '.':
1607 break;
1608 default:
1609 /* Not of format nnn.nnn.nnn.nnn. Could be IPv6 */
1610 goto check_ipv6;
1611 }
1612 cp++;
1613 }
1614 /* IPv4 address - not allowed. */
1615 *client_sni = NULL;
1616 return;
1617
1618check_ipv6:
1619 /* Check for IPv6 */
1620 cp = *client_sni;
1621 while (*cp) {
1622 switch (*cp) {
1623 case '0':
1624 case '1':
1625 case '2':
1626 case '3':
1627 case '4':
1628 case '5':
1629 case '6':
1630 case '7':
1631 case '8':
1632 case '9':
1633 case 'a':
1634 case 'b':
1635 case 'c':
1636 case 'd':
1637 case 'e':
1638 case 'f':
1639 case 'A':
1640 case 'B':
1641 case 'C':
1642 case 'D':
1643 case 'E':
1644 case 'F':
1645 case ':':
1646 break;
1647 case '%':
1648 /* Start of i/f specification, Previous is IPv6 */
1649 *client_sni = NULL;
1650 return;
1651 default:
1652 /* Not of format xx:xx::xx. */
1653 return;
1654 }
1655 cp++;
1656 }
1657 *client_sni = NULL;
1658 return;
1659}
1660
1663 const coap_address_t *local_if,
1664 const coap_address_t *server,
1665 coap_proto_t proto,
1666 coap_dtls_cpsk_t *setup_data) {
1667 coap_session_t *session;
1668
1669 coap_lock_lock(ctx, return NULL);
1670 session = coap_new_client_session_psk2_lkd(ctx, local_if, server, proto, setup_data);
1671 coap_lock_unlock(ctx);
1672 return session;
1673}
1674
1677 const coap_address_t *local_if,
1678 const coap_address_t *server,
1679 coap_proto_t proto,
1680 coap_dtls_cpsk_t *setup_data) {
1681 coap_session_t *session;
1682
1684 session = coap_session_create_client(ctx, local_if, server, proto);
1685
1686 if (!session || !setup_data)
1687 return NULL;
1688
1689 session->cpsk_setup_data = *setup_data;
1690 if (setup_data->psk_info.identity.s) {
1691 session->psk_identity =
1693 setup_data->psk_info.identity.length);
1694 if (!session->psk_identity) {
1695 coap_log_warn("Cannot store session Identity (PSK)\n");
1696 coap_session_release_lkd(session);
1697 return NULL;
1698 }
1700 coap_log_warn("Identity (PSK) not defined\n");
1701 coap_session_release_lkd(session);
1702 return NULL;
1703 }
1704
1705 if (setup_data->psk_info.key.s && setup_data->psk_info.key.length > 0) {
1706 session->psk_key = coap_new_bin_const(setup_data->psk_info.key.s,
1707 setup_data->psk_info.key.length);
1708 if (!session->psk_key) {
1709 coap_log_warn("Cannot store session pre-shared key (PSK)\n");
1710 coap_session_release_lkd(session);
1711 return NULL;
1712 }
1714 coap_log_warn("Pre-shared key (PSK) not defined\n");
1715 coap_session_release_lkd(session);
1716 return NULL;
1717 }
1718
1719 coap_sanitize_client_sni(&session->cpsk_setup_data.client_sni);
1720
1722 if (!coap_dtls_context_set_cpsk(ctx, &session->cpsk_setup_data)) {
1723 coap_session_release_lkd(session);
1724 return NULL;
1725 }
1726 }
1727 coap_log_debug("***%s: new outgoing session\n",
1728 coap_session_str(session));
1729 coap_session_check_connect(session);
1730 return session;
1731}
1732#endif /* COAP_CLIENT_SUPPORT */
1733
1734int
1736 const coap_bin_const_t *psk_hint
1737 ) {
1738 /* We may be refreshing the hint with the same hint */
1739 coap_bin_const_t *old_psk_hint = session->psk_hint;
1740
1741 if (psk_hint && psk_hint->s) {
1742 if (session->psk_hint) {
1743 if (coap_binary_equal(session->psk_hint, psk_hint))
1744 return 1;
1745 }
1746 session->psk_hint = coap_new_bin_const(psk_hint->s,
1747 psk_hint->length);
1748 if (!session->psk_hint) {
1749 coap_log_err("No memory to store identity hint (PSK)\n");
1750 if (old_psk_hint)
1751 coap_delete_bin_const(old_psk_hint);
1752 return 0;
1753 }
1754 } else {
1755 session->psk_hint = NULL;
1756 }
1757 if (old_psk_hint)
1758 coap_delete_bin_const(old_psk_hint);
1759
1760 return 1;
1761}
1762
1763int
1765 const coap_bin_const_t *psk_key
1766 ) {
1767 /* We may be refreshing the key with the same key */
1768 coap_bin_const_t *old_psk_key = session->psk_key;
1769
1770 if (psk_key && psk_key->s) {
1771 if (session->psk_key) {
1772 if (coap_binary_equal(session->psk_key, psk_key))
1773 return 1;
1774 }
1775 session->psk_key = coap_new_bin_const(psk_key->s, psk_key->length);
1776 if (!session->psk_key) {
1777 coap_log_err("No memory to store pre-shared key (PSK)\n");
1778 if (old_psk_key)
1779 coap_delete_bin_const(old_psk_key);
1780 return 0;
1781 }
1782 } else {
1783 session->psk_key = NULL;
1784 }
1785 if (old_psk_key)
1786 coap_delete_bin_const(old_psk_key);
1787
1788 return 1;
1789}
1790
1791int
1793 const coap_bin_const_t *psk_identity
1794 ) {
1795 /* We may be refreshing the identity with the same identity */
1796 coap_bin_const_t *old_psk_identity = session->psk_identity;
1797
1798 if (psk_identity && psk_identity->s) {
1799 if (session->psk_identity) {
1800 if (coap_binary_equal(session->psk_identity, psk_identity))
1801 return 1;
1802 }
1803 session->psk_identity = coap_new_bin_const(psk_identity->s,
1804 psk_identity->length);
1805 if (!session->psk_identity) {
1806 coap_log_err("No memory to store pre-shared key identity (PSK)\n");
1807 if (old_psk_identity)
1808 coap_delete_bin_const(old_psk_identity);
1809 return 0;
1810 }
1811 } else {
1812 session->psk_identity = NULL;
1813 }
1814 if (old_psk_identity)
1815 coap_delete_bin_const(old_psk_identity);
1816
1817 return 1;
1818}
1819
1820#if COAP_SERVER_SUPPORT
1821const coap_bin_const_t *
1823 if (session)
1824 return session->psk_hint;
1825 return NULL;
1826}
1827#endif /* COAP_SERVER_SUPPORT */
1828
1829const coap_bin_const_t *
1831 const coap_bin_const_t *psk_identity = NULL;
1832 if (session) {
1833 psk_identity = session->psk_identity;
1834 if (psk_identity == NULL) {
1835 psk_identity = &session->cpsk_setup_data.psk_info.identity;
1836 }
1837 }
1838 return psk_identity;
1839}
1840
1841const coap_bin_const_t *
1843 if (session)
1844 return session->psk_key;
1845 return NULL;
1846}
1847
1848#if COAP_CLIENT_SUPPORT
1851 const coap_address_t *local_if,
1852 const coap_address_t *server,
1853 coap_proto_t proto,
1854 coap_dtls_pki_t *setup_data) {
1855 coap_session_t *session;
1856
1857 coap_lock_lock(ctx, return NULL);
1858 session = coap_new_client_session_pki_lkd(ctx, local_if, server, proto, setup_data);
1859 coap_lock_unlock(ctx);
1860 return session;
1861}
1862
1865 const coap_address_t *local_if,
1866 const coap_address_t *server,
1867 coap_proto_t proto,
1868 coap_dtls_pki_t *setup_data) {
1869 coap_session_t *session;
1870 coap_dtls_pki_t l_setup_data;
1871
1872 if (!setup_data)
1873 return NULL;
1874 if (setup_data->version != COAP_DTLS_PKI_SETUP_VERSION) {
1875 coap_log_err("coap_new_client_session_pki: Wrong version of setup_data\n");
1876 return NULL;
1877 }
1878
1880 l_setup_data = *setup_data;
1881 coap_sanitize_client_sni(&l_setup_data.client_sni);
1882
1883 session = coap_session_create_client(ctx, local_if, server, proto);
1884
1885 if (!session) {
1886 return NULL;
1887 }
1888
1890 /* we know that setup_data is not NULL */
1891 if (!coap_dtls_context_set_pki(ctx, &l_setup_data, COAP_DTLS_ROLE_CLIENT)) {
1892 coap_session_release_lkd(session);
1893 return NULL;
1894 }
1895 }
1896 coap_log_debug("***%s: new outgoing session\n",
1897 coap_session_str(session));
1898 coap_session_check_connect(session);
1899 return session;
1900}
1901#endif /* ! COAP_CLIENT_SUPPORT */
1902
1903#if COAP_SERVER_SUPPORT
1904#if !COAP_DISABLE_TCP
1907 coap_session_t *session;
1909 NULL, NULL, NULL, 0, ctx, ep);
1910 if (!session)
1911 goto error;
1912
1913 memcpy(session->sock.lfunc, ep->sock.lfunc, sizeof(session->sock.lfunc));
1914 if (!coap_netif_strm_accept(ep, session, extra))
1915 goto error;
1916
1917 coap_make_addr_hash(&session->addr_hash, session->proto, &session->addr_info);
1918
1919#ifdef COAP_EPOLL_SUPPORT
1920 session->sock.session = session;
1921 coap_epoll_ctl_add(&session->sock,
1922 EPOLLIN,
1923 __func__);
1924#endif /* COAP_EPOLL_SUPPORT */
1925 SESSIONS_ADD(ep->sessions, session);
1926 if (session) {
1927 coap_log_debug("***%s: session %p: new incoming session\n",
1928 coap_session_str(session), (void *)session);
1932 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1933 }
1934 return session;
1935
1936error:
1937 /*
1938 * Need to add in the session as coap_session_release_lkd()
1939 * will call SESSIONS_DELETE in coap_session_free().
1940 */
1941 if (session) {
1942 SESSIONS_ADD(ep->sessions, session);
1943 coap_session_free(session);
1944 }
1945 return NULL;
1946}
1947#endif /* !COAP_DISABLE_TCP */
1948#endif /* COAP_SERVER_SUPPORT */
1949
1950void
1952 const uint8_t *data) {
1953 session->tx_token = coap_decode_var_bytes8(data, len);
1954 /*
1955 * Decrement as when first used by coap_session_new_token() it will
1956 * get incremented
1957 */
1958 session->tx_token--;
1959}
1960
1961void
1963 uint8_t *data) {
1964 *len = coap_encode_var_safe8(data,
1965 sizeof(session->tx_token), ++session->tx_token);
1966}
1967
1968COAP_API uint16_t
1970 uint16_t mid;
1971
1972 coap_lock_lock(session->context, return 0);
1973 mid = coap_new_message_id_lkd(session);
1974 coap_lock_unlock(session->context);
1975 return mid;
1976}
1977
1978uint16_t
1981 if (COAP_PROTO_NOT_RELIABLE(session->proto))
1982 return ++session->tx_mid;
1983 /* TCP/TLS have no notion of mid */
1984 return 0;
1985}
1986
1987const coap_address_t *
1989 if (session)
1990 return &session->addr_info.remote;
1991 return NULL;
1992}
1993
1994const coap_address_t *
1996 if (session)
1997 return &session->addr_info.local;
1998 return NULL;
1999}
2000
2001const coap_address_t *
2003#if COAP_CLIENT_SUPPORT
2004 if (session && session->type == COAP_SESSION_TYPE_CLIENT &&
2005 session->sock.flags & COAP_SOCKET_MULTICAST)
2006 return &session->sock.mcast_addr;
2007#else /* ! COAP_CLIENT_SUPPORT */
2008 (void)session;
2009#endif /* ! COAP_CLIENT_SUPPORT */
2010 return NULL;
2011}
2012
2015 if (session)
2016 return session->context;
2017 return NULL;
2018}
2019
2022 if (session)
2023 return session->proto;
2024 return 0;
2025}
2026
2029 if (session)
2030 return session->type;
2031 return 0;
2032}
2033
2034COAP_API int
2036 int ret;
2037
2038 coap_lock_lock(session->context, return 0);
2039 ret = coap_session_set_type_client_lkd(session);
2040 coap_lock_unlock(session->context);
2041 return ret;
2042}
2043
2044int
2046#if COAP_SERVER_SUPPORT
2047 if (session && session->type == COAP_SESSION_TYPE_SERVER) {
2049 session->type = COAP_SESSION_TYPE_CLIENT;
2050 return 1;
2051 }
2052#else /* ! COAP_SERVER_SUPPORT */
2053 (void)session;
2054#endif /* ! COAP_SERVER_SUPPORT */
2055 return 0;
2056}
2057
2060 if (session)
2061 return session->state;
2062 return 0;
2063}
2064
2065int
2067 if (session)
2068 return session->ifindex;
2069 return -1;
2070}
2071
2072void *
2074 coap_tls_library_t *tls_lib) {
2075 if (session)
2076 return coap_dtls_get_tls(session, tls_lib);
2077 return NULL;
2078}
2079
2080static const char *
2082 switch (proto) {
2083 case COAP_PROTO_UDP:
2084 return "UDP ";
2085 case COAP_PROTO_DTLS:
2086 return "DTLS";
2087 case COAP_PROTO_TCP:
2088 return "TCP ";
2089 case COAP_PROTO_TLS:
2090 return "TLS ";
2091 case COAP_PROTO_WS:
2092 return "WS ";
2093 case COAP_PROTO_WSS:
2094 return "WSS ";
2095 case COAP_PROTO_NONE:
2096 case COAP_PROTO_LAST:
2097 default:
2098 return "????" ;
2099 break;
2100 }
2101 return NULL;
2102}
2103
2104#if COAP_SERVER_SUPPORT
2106coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto) {
2107 coap_endpoint_t *endpoint;
2108
2109 coap_lock_lock(context, return NULL);
2110 endpoint = coap_new_endpoint_lkd(context, listen_addr, proto);
2111 coap_lock_unlock(context);
2112 return endpoint;
2113}
2114
2116coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr,
2117 coap_proto_t proto) {
2118 coap_endpoint_t *ep = NULL;
2119
2120 assert(context);
2121 assert(listen_addr);
2122 assert(proto != COAP_PROTO_NONE);
2123
2124 coap_lock_check_locked(context);
2125
2126 if (proto == COAP_PROTO_DTLS && !coap_dtls_is_supported()) {
2127 coap_log_crit("coap_new_endpoint: DTLS not supported\n");
2128 goto error;
2129 }
2130
2131 if (proto == COAP_PROTO_TLS && !coap_tls_is_supported()) {
2132 coap_log_crit("coap_new_endpoint: TLS not supported\n");
2133 goto error;
2134 }
2135
2136 if (proto == COAP_PROTO_TCP && !coap_tcp_is_supported()) {
2137 coap_log_crit("coap_new_endpoint: TCP not supported\n");
2138 goto error;
2139 }
2140
2141 if (proto == COAP_PROTO_WS && !coap_ws_is_supported()) {
2142 coap_log_crit("coap_new_endpoint: WS not supported\n");
2143 goto error;
2144 }
2145
2146 if (proto == COAP_PROTO_WSS && !coap_wss_is_supported()) {
2147 coap_log_crit("coap_new_endpoint: WSS not supported\n");
2148 goto error;
2149 }
2150
2151 if (proto == COAP_PROTO_DTLS || proto == COAP_PROTO_TLS ||
2152 proto == COAP_PROTO_WSS) {
2154 coap_log_info("coap_new_endpoint: one of coap_context_set_psk() or "
2155 "coap_context_set_pki() not called\n");
2156 goto error;
2157 }
2158 }
2159
2160 ep = coap_malloc_endpoint();
2161 if (!ep) {
2162 coap_log_warn("coap_new_endpoint: malloc");
2163 goto error;
2164 }
2165
2166 memset(ep, 0, sizeof(coap_endpoint_t));
2167 ep->context = context;
2168 ep->proto = proto;
2169 ep->sock.endpoint = ep;
2170 assert(proto < COAP_PROTO_LAST);
2171 memcpy(&ep->sock.lfunc, coap_layers_coap[proto], sizeof(ep->sock.lfunc));
2172
2173 if (COAP_PROTO_NOT_RELIABLE(proto)) {
2174 if (!coap_netif_dgrm_listen(ep, listen_addr))
2175 goto error;
2176#ifdef WITH_CONTIKI
2177 ep->sock.context = context;
2178#endif /* WITH_CONTIKI */
2179#if !COAP_DISABLE_TCP
2180 } else if (COAP_PROTO_RELIABLE(proto)) {
2181 if (!coap_netif_strm_listen(ep, listen_addr))
2182 goto error;
2183#endif /* !COAP_DISABLE_TCP */
2184 } else {
2185 coap_log_crit("coap_new_endpoint: protocol not supported\n");
2186 goto error;
2187 }
2188
2190#ifndef INET6_ADDRSTRLEN
2191#define INET6_ADDRSTRLEN 40
2192#endif
2193 unsigned char addr_str[INET6_ADDRSTRLEN + 8];
2194
2195 if (coap_print_addr(&ep->bind_addr, addr_str, INET6_ADDRSTRLEN + 8)) {
2196 coap_log_debug("created %s endpoint %s\n", coap_proto_name(ep->proto),
2197 addr_str);
2198 }
2199 }
2200
2202
2203#ifdef COAP_EPOLL_SUPPORT
2204 ep->sock.endpoint = ep;
2206 EPOLLIN,
2207 __func__);
2208#endif /* COAP_EPOLL_SUPPORT */
2209
2210 LL_PREPEND(context->endpoint, ep);
2211 return ep;
2212
2213error:
2215 return NULL;
2216}
2217
2218void
2220 ep->default_mtu = (uint16_t)mtu;
2221}
2222
2223COAP_API void
2225 if (ep) {
2226 coap_context_t *context = ep->context;
2227 if (context) {
2228 coap_lock_lock(context, return);
2229 }
2231 if (context) {
2232 coap_lock_unlock(context);
2233 }
2234 }
2235}
2236
2237void
2239 if (ep) {
2240 coap_session_t *session, *rtmp;
2241
2242 if (ep->context) {
2243 /* If fully allocated and inserted */
2245 SESSIONS_ITER_SAFE(ep->sessions, session, rtmp) {
2246 assert(session->ref == 0);
2247 if (session->ref == 0) {
2249 coap_session_free(session);
2250 }
2251 }
2252 if (coap_netif_available_ep(ep)) {
2253 /*
2254 * ep->sock.endpoint is set in coap_new_endpoint().
2255 * ep->sock.session is never set.
2256 *
2257 * session->sock.session is set for both clients and servers (when a
2258 * new session is accepted), but does not affect the endpoint.
2259 *
2260 * So, it is safe to call coap_netif_close_ep() after all the sessions
2261 * have been freed above as we are only working with the endpoint sock.
2262 */
2263#ifdef COAP_EPOLL_SUPPORT
2264 assert(ep->sock.session == NULL);
2265#endif /* COAP_EPOLL_SUPPORT */
2267 }
2268
2269 if (ep->context->endpoint) {
2270 LL_DELETE(ep->context->endpoint, ep);
2271 }
2272 }
2274 }
2275}
2276#endif /* COAP_SERVER_SUPPORT */
2277
2280 const coap_address_t *remote_addr,
2281 int ifindex) {
2282 coap_session_t *s, *rtmp;
2283#if COAP_CLIENT_SUPPORT
2284 SESSIONS_ITER(ctx->sessions, s, rtmp) {
2285 if (s->ifindex == ifindex) {
2286 if (s->sock.flags & COAP_SOCKET_MULTICAST) {
2287 if (coap_address_equals(&s->sock.mcast_addr, remote_addr))
2288 return s;
2289 } else if (coap_address_equals(&s->addr_info.remote, remote_addr))
2290 return s;
2291 }
2292 }
2293#endif /* COAP_CLIENT_SUPPORT */
2294#if COAP_SERVER_SUPPORT
2295 coap_endpoint_t *ep;
2296
2297 LL_FOREACH(ctx->endpoint, ep) {
2298 SESSIONS_ITER(ep->sessions, s, rtmp) {
2299 if (s->ifindex == ifindex && coap_address_equals(&s->addr_info.remote,
2300 remote_addr))
2301 return s;
2302 }
2303 }
2304#endif /* COAP_SERVER_SUPPORT */
2305 return NULL;
2306}
2307
2308#ifndef INET6_ADDRSTRLEN
2309#define INET6_ADDRSTRLEN 46
2310#endif
2311const char *
2313 static char szSession[2 * (INET6_ADDRSTRLEN + 8) + 24];
2314 char *p = szSession, *end = szSession + sizeof(szSession);
2315 if (coap_print_addr(&session->addr_info.local,
2316 (unsigned char *)p, end - p) > 0)
2317 p += strlen(p);
2318 if (p + 6 < end) {
2319 strcpy(p, " <-> ");
2320 p += 5;
2321 }
2322 if (p + 1 < end) {
2323 if (coap_print_addr(&session->addr_info.remote,
2324 (unsigned char *)p, end - p) > 0)
2325 p += strlen(p);
2326 }
2327 if (session->ifindex > 0 && p + 1 < end)
2328 p += snprintf(p, end - p, " (if%d)", session->ifindex);
2329 if (p + 6 < end) {
2330 strcpy(p, " ");
2331 p++;
2332 strcpy(p, coap_proto_name(session->proto));
2333 }
2334
2335 return szSession;
2336}
2337
2338#if COAP_SERVER_SUPPORT
2339const char *
2340coap_endpoint_str(const coap_endpoint_t *endpoint) {
2341 static char szEndpoint[128];
2342 char *p = szEndpoint, *end = szEndpoint + sizeof(szEndpoint);
2343 if (coap_print_addr(&endpoint->bind_addr, (unsigned char *)p, end - p) > 0)
2344 p += strlen(p);
2345 if (p + 6 < end) {
2346 if (endpoint->proto == COAP_PROTO_UDP) {
2347 strcpy(p, " UDP");
2348 } else if (endpoint->proto == COAP_PROTO_DTLS) {
2349 strcpy(p, " DTLS");
2350 } else {
2351 strcpy(p, " NONE");
2352 }
2353 }
2354
2355 return szEndpoint;
2356}
2357#endif /* COAP_SERVER_SUPPORT */
2358#if COAP_CLIENT_SUPPORT
2359void
2361 session->no_observe_cancel = 1;
2362}
2363#endif /* COAP_CLIENT_SUPPORT */
2364#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:153
unsigned int coap_dtls_get_overhead(coap_session_t *session COAP_UNUSED)
Definition coap_notls.c:256
int coap_dtls_context_check_keys_enabled(coap_context_t *ctx COAP_UNUSED)
Definition coap_notls.c:142
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:4583
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:2728
int coap_client_delay_first(coap_session_t *session)
Delay the sending of the first client request until some other negotiation has completed.
Definition coap_net.c:1226
unsigned int coap_calc_timeout(coap_session_t *session, unsigned char r)
Calculates the initial timeout based on the session CoAP transmission parameters 'ack_timeout',...
Definition coap_net.c:1123
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:1708
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition coap_net.c:1149
coap_queue_t * coap_new_node(void)
Creates a new node suitable for adding to the CoAP sendqueue.
Definition coap_net.c:256
void coap_cancel_session_messages(coap_context_t *context, coap_session_t *session, coap_nack_reason_t reason)
Cancels all outstanding messages for session session.
Definition coap_net.c:2773
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:2812
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.
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)
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.
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.
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:1001
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)
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 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).
void coap_session_set_app_data(coap_session_t *session, void *app_data)
Stores data with the given session.
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_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:20
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.
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.
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.
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
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
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