libcoap 4.3.5-develop-2ddf01b
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-2026 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 > 0xff)
176 value = 0xff;
177 if (value > 0) {
178 session->max_retransmit = value;
179 coap_log_debug("***%s: session max_retransmit set to %u\n",
180 coap_session_str(session), session->max_retransmit);
181 }
182}
183
184void
185coap_session_set_nstart(coap_session_t *session, uint16_t value) {
186 if (value > 0) {
187 session->nstart = value;
188 coap_log_debug("***%s: session nstart set to %u\n",
189 coap_session_str(session), session->nstart);
190 }
191}
192
193void
195 coap_fixed_point_t value) {
196 if (value.integer_part > 0 && value.fractional_part < 1000) {
197 session->default_leisure = value;
198 coap_log_debug("***%s: session default_leisure set to %u.%03u\n",
201 }
202}
203
204void
206 if (value > 0) {
207 session->probing_rate = value;
208 coap_log_debug("***%s: session probing_rate set to %" PRIu32 "\n",
209 coap_session_str(session), session->probing_rate);
210 }
211}
212
213void
215#if COAP_Q_BLOCK_SUPPORT
216 if (value > 0) {
217 session->max_payloads = value;
218 coap_log_debug("***%s: session max_payloads set to %u\n",
219 coap_session_str(session), session->max_payloads);
220 coap_session_fix_non_probing_wait_base(session);
221 coap_session_fix_non_partial_timeout(session);
222 }
223#else /* ! COAP_Q_BLOCK_SUPPORT */
224 (void)session;
225 (void)value;
226#endif /* ! COAP_Q_BLOCK_SUPPORT */
227}
228
229void
231#if COAP_Q_BLOCK_SUPPORT
232 if (value > 0) {
233 session->non_max_retransmit = value;
234 coap_log_debug("***%s: session non_max_retransmit set to %u\n",
235 coap_session_str(session), session->non_max_retransmit);
236 coap_session_fix_non_probing_wait_base(session);
237 coap_session_fix_non_partial_timeout(session);
238 }
239#else /* ! COAP_Q_BLOCK_SUPPORT */
240 (void)session;
241 (void)value;
242#endif /* ! COAP_Q_BLOCK_SUPPORT */
243}
244
245void
247 coap_fixed_point_t value) {
248#if COAP_Q_BLOCK_SUPPORT
249 if (value.integer_part > 0 && value.fractional_part < 1000) {
250 session->non_timeout = value;
251 coap_log_debug("***%s: session non_timeout set to %u.%03u\n",
252 coap_session_str(session), session->non_timeout.integer_part,
253 session->non_timeout.fractional_part);
254 coap_session_fix_non_probing_wait_base(session);
255 coap_session_fix_non_partial_timeout(session);
256 }
257#else /* ! COAP_Q_BLOCK_SUPPORT */
258 (void)session;
259 (void)value;
260#endif /* ! COAP_Q_BLOCK_SUPPORT */
261}
262
263void
265 coap_fixed_point_t value) {
266#if COAP_Q_BLOCK_SUPPORT
267 if (value.integer_part > 0 && value.fractional_part < 1000)
268 session->non_receive_timeout = value;
269 coap_log_debug("***%s: session non_receive_timeout set to %u.%03u\n",
270 coap_session_str(session),
271 session->non_receive_timeout.integer_part,
272 session->non_receive_timeout.fractional_part);
273#else /* ! COAP_Q_BLOCK_SUPPORT */
274 (void)session;
275 (void)value;
276#endif /* ! COAP_Q_BLOCK_SUPPORT */
277}
278
281 return session->ack_timeout;
282}
283
286 return session->ack_random_factor;
287}
288
289uint16_t
291 return session->max_retransmit;
292}
293
294uint16_t
296 return session->nstart;
297}
298
301 return session->default_leisure;
302}
303
304uint32_t
306 return session->probing_rate;
307}
308
309uint16_t
311#if COAP_Q_BLOCK_SUPPORT
312 return session->max_payloads;
313#else /* ! COAP_Q_BLOCK_SUPPORT */
314 (void)session;
316#endif /* ! COAP_Q_BLOCK_SUPPORT */
317}
318
319uint16_t
321#if COAP_Q_BLOCK_SUPPORT
322 return session->non_max_retransmit;
323#else /* ! COAP_Q_BLOCK_SUPPORT */
324 (void)session;
326#endif /* ! COAP_Q_BLOCK_SUPPORT */
327}
328
331#if COAP_Q_BLOCK_SUPPORT
332 return session->non_timeout;
333#else /* ! COAP_Q_BLOCK_SUPPORT */
334 (void)session;
336#endif /* ! COAP_Q_BLOCK_SUPPORT */
337}
338
341#if COAP_Q_BLOCK_SUPPORT
342 return session->non_receive_timeout;
343#else /* ! COAP_Q_BLOCK_SUPPORT */
344 (void)session;
346#endif /* ! COAP_Q_BLOCK_SUPPORT */
347}
348
351 coap_lock_lock(return NULL);
354 return session;
355}
356
359 ++session->ref;
360 return session;
361}
362
363COAP_API void
365 if (session) {
366#if COAP_THREAD_SAFE
367 coap_context_t *context = session->context;
368 (void)context;
369#endif /* COAP_THREAD_SAFE */
370
371 coap_lock_lock(return);
374 }
375}
376
377void
379 if (session) {
381#ifndef __COVERITY__
382 assert(session->ref > 0);
383 if (session->ref > 0)
384 --session->ref;
385 if (session->ref == 0 && session->type == COAP_SESSION_TYPE_CLIENT)
386 coap_session_free(session);
387#else /* __COVERITY__ */
388 /* Coverity scan is fooled by the reference counter leading to
389 * false positives for USE_AFTER_FREE. */
390 --session->ref;
391 __coverity_negative_sink__(session->ref);
392 /* Indicate that resources are released properly. */
393 if (session->ref == 0 && session->type == COAP_SESSION_TYPE_CLIENT) {
394 __coverity_free__(session);
395 }
396#endif /* __COVERITY__ */
397 }
398}
399
400COAP_API void
401coap_session_set_app_data(coap_session_t *session, void *app_data) {
402 assert(session);
403 coap_lock_lock(return);
404 coap_session_set_app_data2_lkd(session, app_data, NULL);
406}
407
408void *
410 assert(session);
411 return session->app_data;
412}
413
414COAP_API void *
417 void *old_data;
418
419 coap_lock_lock(return NULL);
420 old_data = coap_session_set_app_data2_lkd(session, app_data, callback);
422 return old_data;
423}
424
425void *
428 void *old_data = session->app_data;
429
430 session->app_data = app_data;
431 session->app_cb = app_data ? callback : NULL;
432 return old_data;
433}
434
435static coap_session_t *
437 const coap_addr_hash_t *addr_hash,
438 const coap_address_t *local_addr,
439 const coap_address_t *remote_addr, int ifindex,
440 coap_context_t *context, coap_endpoint_t *endpoint) {
442 sizeof(coap_session_t));
443#if ! COAP_SERVER_SUPPORT
444 (void)endpoint;
445#endif /* ! COAP_SERVER_SUPPORT */
446 if (!session)
447 return NULL;
448 memset(session, 0, sizeof(*session));
449 session->proto = proto;
450 session->type = type;
451 if (addr_hash)
452 memcpy(&session->addr_hash, addr_hash, sizeof(session->addr_hash));
453 else
454 memset(&session->addr_hash, 0, sizeof(session->addr_hash));
455 if (local_addr) {
456 coap_address_copy(&session->addr_info.local, local_addr);
457#if COAP_CLIENT_SUPPORT
458 coap_address_copy(&session->local_reconnect, local_addr);
459#endif /* COAP_CLIENT_SUPPORT */
460 } else {
462#if COAP_CLIENT_SUPPORT
464#endif /* COAP_CLIENT_SUPPORT */
465 }
466 if (remote_addr)
467 coap_address_copy(&session->addr_info.remote, remote_addr);
468 else
470 session->ifindex = ifindex;
471 session->context = context;
472#if COAP_CLIENT_SUPPORT
473 if (type == COAP_SESSION_TYPE_CLIENT) {
474 session->client_initiated = 1;
475 }
476#endif /* COAP_CLIENT_SUPPORT */
477#if COAP_SERVER_SUPPORT
478 session->endpoint = endpoint;
479 if (endpoint)
480 session->mtu = endpoint->default_mtu;
481 else
482#endif /* COAP_SERVER_SUPPORT */
484 session->block_mode = context->block_mode;
485#if COAP_Q_BLOCK_SUPPORT
486 if (session->block_mode & COAP_BLOCK_FORCE_Q_BLOCK) {
487 set_block_mode_has_q(session->block_mode);
488 }
489#endif
490 if (proto == COAP_PROTO_DTLS) {
491 session->tls_overhead = 29;
492 if (session->tls_overhead >= session->mtu) {
493 session->tls_overhead = session->mtu;
494 coap_log_err("DTLS overhead exceeds MTU\n");
495 }
496 }
500 session->nstart = COAP_DEFAULT_NSTART;
503#if COAP_Q_BLOCK_SUPPORT
504 session->max_payloads = COAP_DEFAULT_MAX_PAYLOADS;
505 session->non_max_retransmit = COAP_DEFAULT_NON_MAX_RETRANSMIT;
506 session->non_timeout = COAP_DEFAULT_NON_TIMEOUT;
507 session->non_receive_timeout = COAP_DEFAULT_NON_RECEIVE_TIMEOUT;
508 coap_session_fix_non_probing_wait_base(session);
509 coap_session_fix_non_partial_timeout(session);
510#endif /* COAP_Q_BLOCK_SUPPORT */
511 session->dtls_event = -1;
516 session->max_token_size = context->max_token_size; /* RFC8974 */
517 if (session->type != COAP_SESSION_TYPE_CLIENT)
519
520 /* Randomly initialize */
521 /* TCP/TLS have no notion of mid */
522 if (COAP_PROTO_NOT_RELIABLE(session->proto))
523 coap_prng_lkd((unsigned char *)&session->tx_mid, sizeof(session->tx_mid));
524 coap_prng_lkd((unsigned char *)&session->tx_rtag, sizeof(session->tx_rtag));
525
526 return session;
527}
528
529void
531 coap_queue_t *q, *tmp;
532 coap_lg_xmit_t *lq, *ltmp;
533
534#if COAP_PROXY_SUPPORT
535 if (session->ref_proxy_subs)
536 coap_delete_proxy_subscriber(session, NULL, 0, COAP_PROXY_SUBS_ALL);
537#endif /* COAP_PROXY_SUPPORT */
538#if COAP_CLIENT_SUPPORT
539 coap_lg_crcv_t *lg_crcv, *etmp;
540
541 /* Need to do this before (D)TLS and socket is closed down */
542 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
543 if (lg_crcv->observe_set && session->no_observe_cancel == 0) {
544 /* Need to close down observe */
545 if (coap_cancel_observe_lkd(session, lg_crcv->app_token, COAP_MESSAGE_NON)) {
546 /* Need to delete node we set up for NON */
547 coap_queue_t *queue = session->context->sendqueue;
548
549 while (queue) {
550 if (queue->session == session) {
552 break;
553 }
554 queue = queue->next;
555 }
556 }
557 }
558 /* In case coap_cancel_observe_lkd() failure, which could clear down lg_crcv */
559 if (!session->lg_crcv)
560 break;
561 LL_DELETE(session->lg_crcv, lg_crcv);
562 coap_block_delete_lg_crcv(session, lg_crcv);
563 }
564#endif /* COAP_CLIENT_SUPPORT */
565
566 LL_FOREACH_SAFE(session->delayqueue, q, tmp) {
567 if (q->pdu->type==COAP_MESSAGE_CON) {
568 coap_handle_nack(session, q->pdu,
569 session->proto == COAP_PROTO_DTLS ?
571 q->id);
572 }
574 }
575
576#if COAP_CLIENT_SUPPORT
577 coap_pdu_t *p, *ptmp;
578
579 LL_FOREACH_SAFE(session->doing_first_pdu, p, ptmp) {
580 if (p->type==COAP_MESSAGE_CON) {
581 coap_handle_nack(session, p,
582 session->proto == COAP_PROTO_DTLS ?
584 p->mid);
585 }
587 }
588#endif /* COAP_CLIENT_SUPPORT */
589
590 if (session->partial_pdu)
592 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
593 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
594 if (session->psk_identity)
596 if (session->psk_key)
598 if (session->psk_hint)
600
601#if COAP_SERVER_SUPPORT
602 coap_cache_entry_t *cp, *ctmp;
603 HASH_ITER(hh, session->context->cache, cp, ctmp) {
604 /* cp->session is NULL if not session based */
605 if (cp->session == session) {
606 coap_delete_cache_entry(session->context, cp);
607 }
608 }
609#endif /* COAP_PROXY_SUPPORT */
610 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
611 LL_DELETE(session->lg_xmit, lq);
612 coap_block_delete_lg_xmit(session, lq);
613 }
614#if COAP_SERVER_SUPPORT
615 coap_lg_srcv_t *sq, *stmp;
616
617 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
618 LL_DELETE(session->lg_srcv, sq);
619 coap_block_delete_lg_srcv(session, sq);
620 }
621#endif /* COAP_SERVER_SUPPORT */
622#if COAP_OSCORE_SUPPORT
624#endif /* COAP_OSCORE_SUPPORT */
625#if COAP_WS_SUPPORT
626 coap_free_type(COAP_STRING, session->ws);
627 coap_delete_str_const(session->ws_host);
628#endif /* COAP_WS_SUPPORT */
629}
630
631void
633 if (!session)
634 return;
636 assert(session->ref == 0);
637 if (session->ref)
638 return;
639 /* Make sure nothing gets deleted under our feet */
641 coap_session_mfree(session);
642#if COAP_SERVER_SUPPORT
644 if (session->endpoint) {
645 if (session->endpoint->sessions)
646 SESSIONS_DELETE(session->endpoint->sessions, session);
647 } else
648#endif /* COAP_SERVER_SUPPORT */
649#if COAP_CLIENT_SUPPORT
650 if (session->context) {
651 if (session->context->sessions)
652 SESSIONS_DELETE(session->context->sessions, session);
653 }
655#endif /* COAP_CLIENT_SUPPORT */
657 coap_delete_bin_const(session->echo);
658#if COAP_SERVER_SUPPORT
660#endif /* COAP_SERVER_SUPPORT */
661
662 if (session->app_cb) {
663 coap_lock_callback(session->app_cb(session->app_data));
664 }
665 coap_log_debug("***%s: session %p: closed\n", coap_session_str(session),
666 (void *)session);
667 assert(session->ref == 1);
669}
670
671#if COAP_SERVER_SUPPORT
672void
674 int i;
675
678 coap_cancel_all_messages(session->context, session, NULL);
679 RESOURCES_ITER(session->context->resources, r) {
680 /* In case code is broken somewhere */
681 for (i = 0; i < 1000; i++) {
682 if (!coap_delete_observer(r, session, NULL))
683 break;
684 }
685 }
686 if (session->context->unknown_resource) {
687 /* In case code is broken somewhere */
688 for (i = 0; i < 1000; i++) {
689 if (!coap_delete_observer(session->context->unknown_resource, session, NULL))
690 break;
691 }
692 }
693 if (session->context->proxy_uri_resource) {
694 /* In case code is broken somewhere */
695 for (i = 0; i < 1000; i++) {
696 if (!coap_delete_observer(session->context->proxy_uri_resource, session, NULL))
697 break;
698 }
699 }
700 while (session->delayqueue) {
701 coap_queue_t *q = session->delayqueue;
702
703 session->delayqueue = q->next;
705 }
706 /* Force session to go away */
709
711}
712#endif /* COAP_SERVER_SUPPORT */
713
714static size_t
716 size_t max_with_header) {
717#if COAP_DISABLE_TCP
718 (void)session;
719 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
720 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
721 : 0;
722#else /* !COAP_DISABLE_TCP */
723 if (COAP_PROTO_NOT_RELIABLE(session->proto))
724 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
725 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
726 : 0;
727 /* we must assume there is no token to be on the safe side */
728 if (max_with_header <= 2)
729 return 0;
730 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP0 + 2)
731 return max_with_header - 2;
732 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP8 + 3)
733 return max_with_header - 3;
734 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP16 + 4)
735 return max_with_header - 4;
736 else
737 return max_with_header - COAP_PDU_MAX_TCP_HEADER_SIZE;
738#endif /* !COAP_DISABLE_TCP */
739}
740
741size_t
743 if (session->csm_rcv_mtu)
745 (size_t)(session->csm_rcv_mtu));
746
748 (size_t)(session->mtu - session->tls_overhead));
749}
750
751COAP_API size_t
753 size_t size;
754 coap_session_t *session_rw;
755
756 /*
757 * Need to do this to not get a compiler warning about const parameters
758 * but need to maintain source code backward compatibility
759 */
760 memcpy(&session_rw, &session, sizeof(session_rw));
761 coap_lock_lock(return 0);
762 size = coap_session_max_pdu_size_lkd(session_rw);
764 return size;
765}
766
767size_t
769 size_t max_with_header;
770
772#if COAP_CLIENT_SUPPORT
773 if (COAP_PROTO_RELIABLE(session->proto) &&
774 session->type == COAP_SESSION_TYPE_CLIENT &&
775 session->doing_first) {
776 /*
777 * Delay if session->doing_first is set.
778 * E.g. Reliable and CSM not in yet for checking block support
779 */
780 coap_session_t *session_rw;
781
782 /*
783 * Need to do this to not get a compiler warning about const parameters
784 * but need to maintain source code backward compatibility
785 */
786 memcpy(&session_rw, &session, sizeof(session_rw));
787 if (coap_client_delay_first(session_rw) == 0) {
788 coap_log_debug("coap_client_delay_first: timeout\n");
789 /* Have to go with the defaults */
790 }
791 }
792#endif /* COAP_CLIENT_SUPPORT */
793
794 max_with_header = (size_t)(session->mtu - session->tls_overhead);
795
796 return coap_session_max_pdu_size_internal(session, max_with_header);
797}
798
799void
800coap_session_set_mtu(coap_session_t *session, unsigned mtu) {
801 if (mtu > COAP_DEFAULT_MAX_PDU_RX_SIZE) {
802 mtu = COAP_DEFAULT_MAX_PDU_RX_SIZE;
803 coap_log_debug("* %s: Restricting MTU size to %u\n",
804 coap_session_str(session), mtu);
805 }
806 if (mtu < 64)
807 mtu = 64;
808 session->mtu = mtu;
809 if (session->tls_overhead >= session->mtu) {
810 session->tls_overhead = session->mtu;
811 coap_log_err("DTLS overhead exceeds MTU\n");
812 }
813}
814
815ssize_t
817 coap_queue_t *node) {
818 if (node) {
819 coap_queue_t *removed = NULL;
820 coap_remove_from_queue(&session->context->sendqueue, session, node->id, &removed);
821 assert(removed == node);
823 node->session = NULL;
824 node->t = 0;
825 } else {
826 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
827 coap_queue_t *q = NULL;
828 /* Check same mid is not getting re-used in violation of RFC7252 */
829 LL_FOREACH(session->delayqueue, q) {
830 if (q->id == pdu->mid) {
831 coap_log_err("** %s: mid=0x%04x: already in-use - dropped\n",
832 coap_session_str(session), pdu->mid);
833 return COAP_INVALID_MID;
834 }
835 }
836 }
837 node = coap_new_node();
838 if (node == NULL)
839 return COAP_INVALID_MID;
840 node->id = pdu->mid;
841 node->pdu = pdu;
842 if (pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
843 uint8_t r;
844 coap_prng_lkd(&r, sizeof(r));
845 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
846 node->timeout = coap_calc_timeout(session, r);
847 }
848 coap_address_copy(&node->remote, &session->addr_info.remote);
849 }
850 LL_APPEND(session->delayqueue, node);
852 coap_log_debug("** %s: mid=0x%04x: delayed\n",
853 coap_session_str(session), node->id);
854 return COAP_PDU_DELAYED;
855}
856
857#if !COAP_DISABLE_TCP
858void
860 coap_pdu_t *pdu;
861 uint8_t buf[4];
862 assert(COAP_PROTO_RELIABLE(session->proto));
863 coap_log_debug("***%s: sending CSM\n", coap_session_str(session));
864 session->state = COAP_SESSION_STATE_CSM;
865 session->partial_write = 0;
866 if (session->mtu == 0)
867 coap_session_set_mtu(session, COAP_DEFAULT_MTU); /* base value */
869 if (pdu == NULL
871 coap_encode_var_safe(buf, sizeof(buf),
872 session->context->csm_max_message_size), buf) == 0
874 coap_encode_var_safe(buf, sizeof(buf),
875 0), buf) == 0
876 || (session->max_token_size > COAP_TOKEN_DEFAULT_MAX &&
879 coap_encode_var_safe(buf, sizeof(buf),
880 session->max_token_size),
881 buf) == 0)
882 || coap_pdu_encode_header(pdu, session->proto) == 0
883 ) {
885 } else {
886 ssize_t bytes_written;
887
888 pdu->session = session;
889 bytes_written = coap_session_send_pdu(session, pdu);
890 if (bytes_written != (ssize_t)pdu->used_size + pdu->hdr_size) {
892 } else {
893 session->csm_rcv_mtu = session->context->csm_max_message_size;
894 if (session->csm_rcv_mtu > COAP_BERT_BASE)
895 session->csm_bert_loc_support = 1;
896 else
897 session->csm_bert_loc_support = 0;
898 }
899 }
900 if (pdu)
902}
903#endif /* !COAP_DISABLE_TCP */
904
907 coap_mid_t mid;
908
910 mid = coap_session_send_ping_lkd(session);
911 if (mid != COAP_INVALID_MID) {
912 coap_tick_t now;
913
914 coap_ticks(&now);
915 session->last_ping_mid = mid;
916 session->last_rx_tx = now;
917 session->last_ping = now;
918 }
920 return mid;
921}
922
925 coap_pdu_t *ping = NULL;
926
928 if (session->state != COAP_SESSION_STATE_ESTABLISHED ||
929 session->con_active)
930 return COAP_INVALID_MID;
931 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
932 uint16_t mid = coap_new_message_id_lkd(session);
933 ping = coap_pdu_init(COAP_MESSAGE_CON, 0, mid, 0);
934 }
935#if !COAP_DISABLE_TCP
936 else {
938 }
939#endif /* !COAP_DISABLE_TCP */
940 if (!ping)
941 return COAP_INVALID_MID;
942 return coap_send_internal(session, ping, NULL);
943}
944
945void
947 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
948 coap_log_debug("***%s: session connected\n",
949 coap_session_str(session));
950 if (session->state == COAP_SESSION_STATE_CSM) {
952#if COAP_CLIENT_SUPPORT
954 coap_reset_doing_first(session);
955#endif /* COAP_CLIENT_SUPPORT */
956 }
957 }
958
960 session->partial_write = 0;
961
962 if (session->proto==COAP_PROTO_DTLS) {
963 session->tls_overhead = coap_dtls_get_overhead(session);
964 if (session->tls_overhead >= session->mtu) {
965 session->tls_overhead = session->mtu;
966 coap_log_err("DTLS overhead exceeds MTU\n");
967 }
968 }
969
970 while (session->delayqueue && session->state == COAP_SESSION_STATE_ESTABLISHED) {
971 ssize_t bytes_written;
972 coap_queue_t *q = session->delayqueue;
973 coap_address_t remote;
974
975 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
976 if (session->con_active >= COAP_NSTART(session))
977 break;
978 session->con_active++;
979 }
980 /* Take entry off the queue */
981 session->delayqueue = q->next;
982 q->next = NULL;
983
984 coap_address_copy(&remote, &session->addr_info.remote);
986 coap_log_debug("** %s: mid=0x%04x: transmitted after delay (2)\n",
987 coap_session_str(session), (int)q->pdu->mid);
988 bytes_written = coap_session_send_pdu(session, q->pdu);
989 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
990 if (coap_wait_ack(session->context, session, q) >= 0)
991 q = NULL;
992 }
993 coap_address_copy(&session->addr_info.remote, &remote);
994 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
995 if (q)
997 if (bytes_written < 0)
998 break;
999 } else if (q) {
1000 if (bytes_written <= 0 || (size_t)bytes_written < q->pdu->used_size + q->pdu->hdr_size) {
1001 q->next = session->delayqueue;
1002 session->delayqueue = q;
1003 if (bytes_written > 0)
1004 session->partial_write = (size_t)bytes_written;
1005 break;
1006 } else {
1008 }
1009 }
1010 }
1011}
1012
1013#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
1014static const char *
1016 switch (reason) {
1018 return "COAP_NACK_TOO_MANY_RETRIES";
1020 return "COAP_NACK_NOT_DELIVERABLE";
1021 case COAP_NACK_RST:
1022 return "COAP_NACK_RST";
1024 return "COAP_NACK_TLS_FAILED";
1026 return "COAP_NACK_ICMP_ISSUE";
1028 return "COAP_NACK_BAD_RESPONSE";
1030 return "COAP_NACK_TLS_LAYER_FAILED";
1032 return "COAP_NACK_WS_LAYER_FAILED";
1034 return "COAP_NACK_WS_FAILED";
1035 default:
1036 return "???";
1037 }
1038}
1039#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
1040
1041void
1043 coap_pdu_t *sent,
1044 const coap_nack_reason_t reason,
1045 const coap_mid_t mid) {
1046 if (session->context->nack_cb
1048 && !session->doing_first_pdu
1049#endif /* COAP_CLIENT_SUPPORT */
1050 ) {
1051 coap_bin_const_t token = {0, NULL};
1052
1053 if (sent) {
1054 coap_check_update_token(session, sent);
1055 token = sent->actual_token;
1056 }
1057 coap_lock_callback(session->context->nack_cb(session, sent, reason, mid));
1058 if (sent) {
1059 coap_update_token(sent, token.length, token.s);
1060 }
1061 }
1062#if COAP_CLIENT_SUPPORT
1063 if (reason != COAP_NACK_ICMP_ISSUE) {
1064 session->doing_send_recv = 0;
1065 }
1066#endif /* COAP_CLIENT_SUPPORT */
1067}
1068
1069COAP_API void
1075
1076void
1078#if !COAP_DISABLE_TCP
1079 coap_session_state_t state = session->state;
1080#endif /* !COAP_DISABLE_TCP */
1081 coap_lg_xmit_t *lq, *ltmp;
1082#if COAP_SERVER_SUPPORT
1083 coap_lg_srcv_t *sq, *stmp;
1084#endif /* COAP_SERVER_SUPPORT */
1085#if COAP_CLIENT_SUPPORT
1086 coap_lg_crcv_t *cq, *etmp;
1087#endif /* COAP_CLIENT_SUPPORT */
1088 int sent_nack = 0;
1089 coap_queue_t *q;
1090
1092#if COAP_CLIENT_SUPPORT
1093 coap_session_failed(session);
1094#endif /* COAP_CLIENT_SUPPORT */
1095
1096 q = session->context->sendqueue;
1097 while (q) {
1098 if (q->session == session) {
1099 /* Take the first one */
1100 coap_handle_nack(session, q->pdu, reason, q->id);
1101 sent_nack = 1;
1102 break;
1103 }
1104 q = q->next;
1105 }
1106
1107 if (reason != COAP_NACK_ICMP_ISSUE
1109 || session->session_failed
1110#endif /* COAP_CLIENT_SUPPORT */
1111 ) {
1112 while (session->delayqueue) {
1113 q = session->delayqueue;
1114 session->delayqueue = q->next;
1115 q->next = NULL;
1116 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1117 coap_session_str(session), q->id);
1118 if (q->pdu->type == COAP_MESSAGE_CON) {
1119 coap_handle_nack(session, q->pdu, reason, q->id);
1120 sent_nack = 1;
1121 }
1122
1123#if COAP_CLIENT_SUPPORT
1124 session->doing_send_recv = 0;
1125#endif /* COAP_CLIENT_SUPPORT */
1127 }
1128 }
1129#if COAP_CLIENT_SUPPORT
1130 if (!sent_nack && session->lg_crcv) {
1131 /* Take the first one */
1132 coap_handle_nack(session, session->lg_crcv->sent_pdu, reason,
1133 session->lg_crcv->sent_pdu->mid);
1134 sent_nack = 1;
1135 }
1136#endif /* COAP_CLIENT_SUPPORT */
1137 if (!sent_nack) {
1138 /* Unable to determine which request disconnection was for */
1139 coap_handle_nack(session, NULL, reason, 0);
1140 }
1141 if (reason == COAP_NACK_ICMP_ISSUE) {
1142 coap_log_debug("***%s: session ICMP issue (%s)\n",
1143 coap_session_str(session), coap_nack_name(reason));
1144 return;
1145 }
1146 coap_log_debug("***%s: session disconnected (%s)\n",
1147 coap_session_str(session), coap_nack_name(reason));
1148#if COAP_SERVER_SUPPORT
1149 coap_delete_observers(session->context, session);
1150#endif /* COAP_SERVER_SUPPORT */
1151
1152 if (session->proto == COAP_PROTO_UDP)
1154 else
1155 session->state = COAP_SESSION_STATE_NONE;
1156
1157 session->con_active = 0;
1158
1159 if (session->partial_pdu) {
1161 session->partial_pdu = NULL;
1162 }
1163 session->partial_read = 0;
1164
1165 /* Not done if nack handler called above */
1166 while (session->delayqueue) {
1167 q = session->delayqueue;
1168 session->delayqueue = q->next;
1169 q->next = NULL;
1170 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1171 coap_session_str(session), q->id);
1172#if COAP_CLIENT_SUPPORT
1173 session->doing_send_recv = 0;
1174#endif /* COAP_CLIENT_SUPPORT */
1176 }
1177
1178#if COAP_CLIENT_SUPPORT
1179 if (!session->session_failed) {
1180 /* Need to do this before (D)TLS and socket is closed down */
1181 LL_FOREACH_SAFE(session->lg_crcv, cq, etmp) {
1182 LL_DELETE(session->lg_crcv, cq);
1183 coap_block_delete_lg_crcv(session, cq);
1184 }
1185 }
1186#endif /* COAP_CLIENT_SUPPORT */
1187 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
1188 LL_DELETE(session->lg_xmit, lq);
1189 coap_block_delete_lg_xmit(session, lq);
1190 }
1191#if COAP_SERVER_SUPPORT
1192 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
1193 LL_DELETE(session->lg_srcv, sq);
1194 coap_block_delete_lg_srcv(session, sq);
1195 }
1196#endif /* COAP_SERVER_SUPPORT */
1197 coap_cancel_session_messages(session->context, session, reason);
1198
1199#if !COAP_DISABLE_TCP
1200 if (COAP_PROTO_RELIABLE(session->proto)) {
1201 if (coap_netif_available(session)) {
1205 }
1206#if COAP_CLIENT_SUPPORT
1207 if (state != COAP_SESSION_STATE_NONE && !session->session_failed) {
1211 }
1212 coap_reset_doing_first(session);
1213#endif /* COAP_CLIENT_SUPPORT */
1214 }
1215#endif /* !COAP_DISABLE_TCP */
1216 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1217 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1218}
1219
1220#if COAP_CLIENT_SUPPORT
1221void
1223 if (session->context->reconnect_time && session->client_initiated) {
1224 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1225 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1226 session->session_failed = 1;
1228 session->retry_count++;
1229 if (session->context->retry_count && session->retry_count >= session->context->retry_count) {
1231 if (session->type != COAP_SESSION_TYPE_CLIENT) {
1233 coap_session_release_lkd(session);
1234 }
1235 }
1236 coap_ticks(&session->last_rx_tx);
1237 }
1238}
1239#endif /* COAP_CLIENT_SUPPORT */
1240
1241#if COAP_SERVER_SUPPORT
1242static void
1243coap_make_addr_hash(coap_addr_hash_t *addr_hash, coap_proto_t proto,
1244 const coap_addr_tuple_t *addr_info) {
1245 memset(addr_hash, 0, sizeof(coap_addr_hash_t));
1246 coap_address_copy(&addr_hash->remote, &addr_info->remote);
1247 addr_hash->lport = coap_address_get_port(&addr_info->local);
1248 addr_hash->proto = proto;
1249}
1250
1253 const coap_packet_t *packet, coap_tick_t now) {
1254 coap_session_t *session;
1255 coap_session_t *rtmp;
1256 unsigned int num_idle = 0;
1257 unsigned int num_hs = 0;
1258 coap_session_t *oldest = NULL;
1259 coap_session_t *oldest_hs = NULL;
1260 coap_addr_hash_t addr_hash;
1261
1262 coap_make_addr_hash(&addr_hash, endpoint->proto, &packet->addr_info);
1263 SESSIONS_FIND(endpoint->sessions, addr_hash, session);
1264 if (session) {
1265 /* Maybe mcast or unicast IP address which is not in the hash */
1266 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1267 session->ifindex = packet->ifindex;
1268 session->last_rx_tx = now;
1269 return session;
1270 }
1271
1272#if COAP_CLIENT_SUPPORT
1273 SESSIONS_FIND(endpoint->context->sessions, addr_hash, session);
1274 if (session) {
1275 /* Maybe mcast or unicast IP address which is not in the hash */
1276 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1277 session->ifindex = packet->ifindex;
1278 session->last_rx_tx = now;
1279 return session;
1280 }
1281
1282 if (coap_is_mcast(&packet->addr_info.local)) {
1283 /* Check if this a proxy client packet we sent on another socket */
1284 SESSIONS_ITER(endpoint->context->sessions, session, rtmp) {
1285 if (coap_address_equals(&session->addr_info.remote, &packet->addr_info.local) &&
1288 /* Drop looped back packet to stop recursion / confusion */
1289 return NULL;
1290 }
1291 }
1292 }
1293#endif /* COAP_CLIENT_SUPPORT */
1294 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1295 if (session->ref == 0 && session->delayqueue == NULL &&
1296 session->lg_srcv == NULL && session->lg_xmit == NULL) {
1297 if (
1299 !(session->client_initiated && endpoint->context->reconnect_time) &&
1300#endif /* COAP_CLIENT_SUPPORT */
1301 session->type == COAP_SESSION_TYPE_SERVER) {
1302 ++num_idle;
1303 if (oldest==NULL || session->last_rx_tx < oldest->last_rx_tx)
1304 oldest = session;
1305
1306 if (session->state == COAP_SESSION_STATE_HANDSHAKE) {
1307 ++num_hs;
1308 /* See if this is a partial (D)TLS session set up
1309 which needs to be cleared down to prevent DOS */
1310 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1311 if (oldest_hs == NULL ||
1312 session->last_rx_tx < oldest_hs->last_rx_tx)
1313 oldest_hs = session;
1314 }
1315 }
1316 } else if (session->type == COAP_SESSION_TYPE_HELLO) {
1317 ++num_hs;
1318 /* See if this is a partial (D)TLS session set up for Client Hello
1319 which needs to be cleared down to prevent DOS */
1320 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1321 if (oldest_hs == NULL ||
1322 session->last_rx_tx < oldest_hs->last_rx_tx)
1323 oldest_hs = session;
1324 }
1325 }
1326 }
1327 }
1328
1329 if (endpoint->context->max_idle_sessions > 0 &&
1330 num_idle >= endpoint->context->max_idle_sessions) {
1332 coap_session_free(oldest);
1333 } else if (oldest_hs) {
1334 coap_log_warn("***%s: Incomplete session timed out\n",
1335 coap_session_str(oldest_hs));
1337 coap_session_free(oldest_hs);
1338 }
1339
1340 if (num_hs > (endpoint->context->max_handshake_sessions ?
1341 endpoint->context->max_handshake_sessions :
1343 /* Maxed out on number of sessions in (D)TLS negotiation state */
1344 coap_log_debug("Oustanding sessions in COAP_SESSION_STATE_HANDSHAKE too "
1345 "large. New request ignored\n");
1346 return NULL;
1347 }
1348
1349 if (endpoint->proto == COAP_PROTO_DTLS) {
1350 /*
1351 * Need to check that this actually is a Client Hello before wasting
1352 * time allocating and then freeing off session.
1353 */
1354
1355 /*
1356 * Generic header structure of the DTLS record layer.
1357 * typedef struct __attribute__((__packed__)) {
1358 * uint8_t content_type; content type of the included message
1359 * uint16_t version; Protocol version
1360 * uint16_t epoch; counter for cipher state changes
1361 * uint8_t sequence_number[6]; sequence number
1362 * uint16_t length; length of the following fragment
1363 * uint8_t handshake; If content_type == DTLS_CT_HANDSHAKE
1364 * } dtls_record_handshake_t;
1365 */
1366#define OFF_CONTENT_TYPE 0 /* offset of content_type in dtls_record_handshake_t */
1367#define DTLS_CT_ALERT 21 /* Content Type Alert */
1368#define DTLS_CT_HANDSHAKE 22 /* Content Type Handshake */
1369#define OFF_HANDSHAKE_TYPE 13 /* offset of handshake in dtls_record_handshake_t */
1370#define DTLS_HT_CLIENT_HELLO 1 /* Client Hello handshake type */
1371#define DTLS_CT_CID 25 /* Content Type Connection ID */
1372#define OFF_CID 11 /* offset of CID in dtls_record_handshake_t */
1373#define OFF_CID_DTLS13 1 /* offset of CID in DTLS1.3 Unified Header */
1374
1375 const uint8_t *payload = (const uint8_t *)packet->payload;
1376 size_t length = packet->length;
1377 if (length < (OFF_HANDSHAKE_TYPE + 1)) {
1378 coap_log_debug("coap_dtls_hello: ContentType %d Short Packet (%" PRIuS " < %d) dropped\n",
1379 payload[OFF_CONTENT_TYPE], length,
1380 OFF_HANDSHAKE_TYPE + 1);
1381 return NULL;
1382 }
1383 if ((payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 ||
1384 payload[OFF_CONTENT_TYPE] == DTLS_CT_CID) {
1385 /* Client may have changed its IP address */
1386 int changed = 0;
1387
1388 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1389 if (session->client_cid) {
1390 if ((session->is_dtls13 && (payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 &&
1391 length > (OFF_CID_DTLS13 + session->client_cid->length) &&
1392 memcmp(session->client_cid->s, &payload[OFF_CID_DTLS13],
1393 session->client_cid->length) == 0) ||
1394 (!session->is_dtls13 && payload[OFF_CONTENT_TYPE] == DTLS_CT_CID &&
1395 length > (OFF_CID + session->client_cid->length) &&
1396 memcmp(session->client_cid->s, &payload[OFF_CID],
1397 session->client_cid->length) == 0)) {
1398 /* Updating IP address */
1399 coap_log_info("***%s: CID: Old Client Session\n", coap_session_str(session));
1400 SESSIONS_DELETE(endpoint->sessions, session);
1401 session->addr_info = packet->addr_info;
1402 memcpy(&session->addr_hash, &addr_hash, sizeof(session->addr_hash));
1403 SESSIONS_ADD(endpoint->sessions, session);
1404 coap_log_info("***%s: CID: New Client Session\n", coap_session_str(session));
1405 return session;
1406 }
1407 }
1408 }
1409 if (!changed) {
1410 coap_log_debug("coap_dtls_hello: ContentType Connection-IS dropped\n");
1411 return NULL;
1412 }
1413 } else if (payload[OFF_CONTENT_TYPE] != DTLS_CT_HANDSHAKE ||
1414 payload[OFF_HANDSHAKE_TYPE] != DTLS_HT_CLIENT_HELLO) {
1415 /* only log if not a late alert */
1416 if (payload[OFF_CONTENT_TYPE] != DTLS_CT_ALERT)
1417 coap_log_debug("coap_dtls_hello: ContentType %d Handshake %d dropped\n",
1418 payload[OFF_CONTENT_TYPE],
1419 payload[OFF_HANDSHAKE_TYPE]);
1420 return NULL;
1421 }
1422 }
1423
1425 &addr_hash, &packet->addr_info.local,
1426 &packet->addr_info.remote,
1427 packet->ifindex, endpoint->context, endpoint);
1428 if (session) {
1429 session->last_rx_tx = now;
1430 memcpy(session->sock.lfunc, endpoint->sock.lfunc,
1431 sizeof(session->sock.lfunc));
1432 if (endpoint->proto == COAP_PROTO_UDP)
1434 else if (endpoint->proto == COAP_PROTO_DTLS) {
1435 session->type = COAP_SESSION_TYPE_HELLO;
1436 }
1437 SESSIONS_ADD(endpoint->sessions, session);
1438 coap_log_debug("***%s: session %p: new incoming session\n",
1439 coap_session_str(session), (void *)session);
1441 }
1442 return session;
1443}
1444
1447 coap_tick_t now) {
1448 if (session) {
1449 session->last_rx_tx = now;
1450 session->type = COAP_SESSION_TYPE_SERVER;
1451 coap_dtls_establish(session);
1452 }
1453 return session;
1454}
1455#endif /* COAP_SERVER_SUPPORT */
1456
1457#if COAP_CLIENT_SUPPORT
1458static coap_session_t *
1459coap_session_create_client(coap_context_t *ctx,
1460 const coap_address_t *local_if,
1461 const coap_address_t *server,
1462 coap_proto_t proto,
1463 void *app_data,
1465 coap_str_const_t *ws_host) {
1466 coap_session_t *session = NULL;
1467 int default_port = COAP_DEFAULT_PORT;
1468
1469 assert(server);
1470
1471 switch (proto) {
1472 case COAP_PROTO_UDP:
1473 default_port = COAP_DEFAULT_PORT;
1474 break;
1475 case COAP_PROTO_DTLS:
1476 if (!coap_dtls_is_supported()) {
1477 coap_log_crit("coap_new_client_session*: DTLS not supported\n");
1478 return NULL;
1479 }
1480 default_port = COAPS_DEFAULT_PORT;
1481 break;
1482 case COAP_PROTO_TCP:
1483 if (!coap_tcp_is_supported()) {
1484 coap_log_crit("coap_new_client_session*: TCP not supported\n");
1485 return NULL;
1486 }
1487 default_port = COAP_DEFAULT_PORT;
1488 break;
1489 case COAP_PROTO_TLS:
1490 if (!coap_tls_is_supported()) {
1491 coap_log_crit("coap_new_client_session*: TLS not supported\n");
1492 return NULL;
1493 }
1494 default_port = COAPS_DEFAULT_PORT;
1495 break;
1496 case COAP_PROTO_WS:
1497 if (!coap_ws_is_supported()) {
1498 coap_log_crit("coap_new_client_session*: WS not supported\n");
1499 return NULL;
1500 }
1501 default_port = 80;
1502 break;
1503 case COAP_PROTO_WSS:
1504 if (!coap_wss_is_supported()) {
1505 coap_log_crit("coap_new_client_session*: WSS not supported\n");
1506 return NULL;
1507 }
1508 default_port = 443;
1509 break;
1510 case COAP_PROTO_NONE:
1511 case COAP_PROTO_LAST:
1512 default:
1513 assert(0);
1514 return NULL;
1515 }
1516 session = coap_make_session(proto, COAP_SESSION_TYPE_CLIENT, NULL,
1517 local_if, server, 0, ctx, NULL);
1518 if (!session)
1519 goto error;
1520
1522 session->sock.session = session;
1523 memcpy(&session->sock.lfunc, coap_layers_coap[proto],
1524 sizeof(session->sock.lfunc));
1525
1526 session->app_data = app_data;
1527 session->app_cb = app_data ? callback : NULL;
1528#if COAP_WS_SUPPORT
1529 if (ws_host) {
1530 session->ws_host = coap_new_str_const(ws_host->s, ws_host->length);
1531 }
1532#else /* ! COAP_WS_SUPPORT */
1533 (void)ws_host;
1534#endif /* ! COAP_WS_SUPPORT */
1535
1536 if (COAP_PROTO_NOT_RELIABLE(proto)) {
1537 coap_session_t *s, *rtmp;
1538 if (!coap_netif_dgrm_connect(session, local_if, server, default_port)) {
1539 goto error;
1540 }
1541 /* Check that this is not a duplicate 4-tuple */
1542 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
1545 &s->addr_info.local) &&
1547 &s->addr_info.remote)) {
1548 coap_log_warn("***%s: session %p: duplicate - already exists\n",
1549 coap_session_str(session), (void *)session);
1550 goto error;
1551 }
1552 }
1553#ifdef WITH_CONTIKI
1554 session->sock.context = ctx;
1555#endif /* WITH_CONTIKI */
1556#if !COAP_DISABLE_TCP
1557 } else if (COAP_PROTO_RELIABLE(proto)) {
1558 if (!coap_netif_strm_connect1(session, local_if, server, default_port)) {
1559 goto error;
1560 }
1561#endif /* !COAP_DISABLE_TCP */
1562 }
1563
1564 session->sock.session = session;
1565#ifdef COAP_EPOLL_SUPPORT
1566 coap_epoll_ctl_add(&session->sock,
1567 EPOLLIN |
1568 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1569 EPOLLOUT : 0),
1570 __func__);
1571#endif /* COAP_EPOLL_SUPPORT */
1572
1574 if (local_if)
1575 session->sock.flags |= COAP_SOCKET_BOUND;
1576#if COAP_SERVER_SUPPORT
1577 if (ctx->proxy_uri_resource)
1578 session->proxy_session = 1;
1579#endif /* COAP_SERVER_SUPPORT */
1580 SESSIONS_ADD(ctx->sessions, session);
1581 return session;
1582
1583error:
1584 /*
1585 * Need to add in the session as coap_session_release_lkd()
1586 * will call SESSIONS_DELETE in coap_session_free().
1587 */
1588 if (session)
1589 SESSIONS_ADD(ctx->sessions, session);
1590 coap_session_release_lkd(session);
1591 return NULL;
1592}
1593
1594static void
1595coap_session_check_connect(coap_session_t *session) {
1596 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1597 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1598 }
1599#if !COAP_DISABLE_TCP
1600 if (COAP_PROTO_RELIABLE(session->proto)) {
1601 if (session->sock.flags & COAP_SOCKET_WANT_CONNECT) {
1603 if (session->client_initiated) {
1604 session->doing_first = 1;
1605 }
1606 } else {
1607 /* Initial connect worked immediately */
1608 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1609 }
1610 }
1611#endif /* !COAP_DISABLE_TCP */
1612 coap_ticks(&session->last_rx_tx);
1613}
1614#endif /* COAP_CLIENT_SUPPORT */
1615
1616void
1618 if (COAP_PROTO_NOT_RELIABLE(session->proto))
1619 coap_session_connected(session);
1620#if !COAP_DISABLE_TCP
1621 if (COAP_PROTO_RELIABLE(session->proto))
1622 coap_session_send_csm(session);
1623#endif /* !COAP_DISABLE_TCP */
1624}
1625
1626#if COAP_CLIENT_SUPPORT
1627int
1629 int default_port = COAP_DEFAULT_PORT;
1630
1631 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close && !session->session_failed)
1632 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1633
1634 switch (session->proto) {
1635 case COAP_PROTO_UDP:
1636 default_port = COAP_DEFAULT_PORT;
1637 break;
1638 case COAP_PROTO_DTLS:
1639 default_port = COAPS_DEFAULT_PORT;
1640 break;
1641 case COAP_PROTO_TCP:
1642 default_port = COAP_DEFAULT_PORT;
1643 break;
1644 case COAP_PROTO_TLS:
1645 default_port = COAPS_DEFAULT_PORT;
1646 break;
1647 case COAP_PROTO_WS:
1648 default_port = 80;
1649 break;
1650 case COAP_PROTO_WSS:
1651 default_port = 443;
1652 break;
1653 case COAP_PROTO_NONE:
1654 case COAP_PROTO_LAST:
1655 default:
1656 assert(0);
1657 return 0;
1658 }
1659 session->sock.session = session;
1660 coap_log_debug("***%s: trying to reconnect\n", coap_session_str(session));
1662 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1663 session->state = COAP_SESSION_STATE_NONE;
1664 if (!coap_netif_dgrm_connect(session, &session->local_reconnect, &session->addr_info.remote,
1665 default_port)) {
1666 goto error;
1667 }
1669#ifdef WITH_CONTIKI
1670 session->sock.context = session->context;
1671#endif /* WITH_CONTIKI */
1672#if !COAP_DISABLE_TCP
1673 } else if (COAP_PROTO_RELIABLE(session->proto)) {
1674 if (!coap_netif_strm_connect1(session, &session->local_reconnect, &session->addr_info.remote,
1675 default_port)) {
1676 goto error;
1677 }
1678#endif /* !COAP_DISABLE_TCP */
1679 } else {
1680 goto error;
1681 }
1682#ifdef COAP_EPOLL_SUPPORT
1683 coap_epoll_ctl_add(&session->sock,
1684 EPOLLIN |
1685 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1686 EPOLLOUT : 0),
1687 __func__);
1688#endif /* COAP_EPOLL_SUPPORT */
1689
1691 session->sock.flags |= COAP_SOCKET_BOUND;
1692 coap_session_check_connect(session);
1693 return 1;
1694error:
1695 return 0;
1696}
1697
1698void
1700 coap_lg_crcv_t *lg_crcv, *etmp;
1701
1702 if (!session->session_failed)
1703 return;
1704 coap_log_debug("***%s: session re-established\n",
1705 coap_session_str(session));
1706 session->session_failed = 0;
1707 session->retry_count = 0;
1709 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
1711 coap_send_internal(session, lg_crcv->sent_pdu, NULL);
1712 }
1713}
1714
1717 const coap_address_t *local_if,
1718 const coap_address_t *server,
1719 coap_proto_t proto) {
1720 coap_session_t *session;
1721
1722 coap_lock_lock(return NULL);
1723 session = coap_new_client_session3_lkd(ctx, local_if, server, proto, NULL, NULL, NULL);
1725 return session;
1726}
1727
1730 const coap_address_t *local_if,
1731 const coap_address_t *server,
1732 coap_proto_t proto,
1733 void *app_data,
1735 coap_str_const_t *ws_host) {
1736 coap_session_t *session;
1737
1738 coap_lock_lock(return NULL);
1739 session = coap_new_client_session3_lkd(ctx, local_if, server, proto, app_data, callback, ws_host);
1741 return session;
1742}
1743
1746 const coap_address_t *local_if,
1747 const coap_address_t *server,
1748 coap_proto_t proto,
1749 void *app_data,
1751 coap_str_const_t *ws_host) {
1752 coap_session_t *session;
1753
1755 session = coap_session_create_client(ctx, local_if, server,
1756 proto, app_data, callback, ws_host);
1757 if (session) {
1758 coap_log_debug("***%s: session %p: created outgoing session\n",
1759 coap_session_str(session), (void *)session);
1760 coap_session_check_connect(session);
1761 }
1762 return session;
1763}
1764
1767 const coap_address_t *local_if,
1768 const coap_address_t *server,
1769 coap_proto_t proto, const char *identity,
1770 const uint8_t *key, unsigned key_len) {
1771 coap_session_t *session;
1772
1773 coap_lock_lock(return NULL);
1774 session = coap_new_client_session_psk_lkd(ctx, local_if, server, proto, identity, key, key_len);
1776 return session;
1777}
1778
1781 const coap_address_t *local_if,
1782 const coap_address_t *server,
1783 coap_proto_t proto, const char *identity,
1784 const uint8_t *key, unsigned key_len) {
1785 coap_dtls_cpsk_t setup_data;
1786
1788 memset(&setup_data, 0, sizeof(setup_data));
1790
1791 if (identity) {
1792 setup_data.psk_info.identity.s = (const uint8_t *)identity;
1793 setup_data.psk_info.identity.length = strlen(identity);
1794 }
1795
1796 if (key && key_len > 0) {
1797 setup_data.psk_info.key.s = key;
1798 setup_data.psk_info.key.length = key_len;
1799 }
1800
1801 return coap_new_client_session_psk3_lkd(ctx, local_if, server,
1802 proto, &setup_data, NULL, NULL, NULL);
1803}
1804
1805/*
1806 * Check the validity of the SNI to send to the server.
1807 *
1808 * https://datatracker.ietf.org/doc/html/rfc6066#section-3
1809 * Literal IPv4 and IPv6 addresses are not permitted in "HostName".
1810 */
1811static void
1812coap_sanitize_client_sni(char **client_sni) {
1813 char *cp;
1814
1815 if (*client_sni == NULL)
1816 return;
1817
1818 cp = *client_sni;
1819 switch (*cp) {
1820 case '0':
1821 case '1':
1822 case '2':
1823 case '3':
1824 case '4':
1825 case '5':
1826 case '6':
1827 case '7':
1828 case '8':
1829 case '9':
1830 case 'a':
1831 case 'b':
1832 case 'c':
1833 case 'd':
1834 case 'e':
1835 case 'f':
1836 case 'A':
1837 case 'B':
1838 case 'C':
1839 case 'D':
1840 case 'E':
1841 case 'F':
1842 case ':':
1843 break;
1844 case '\000':
1845 /* Empty entry invalid */
1846 *client_sni = NULL;
1847 return;
1848 default:
1849 /* Does not start with a hex digit or : - not literal IP. */
1850 return;
1851 }
1852 /* Check for IPv4 */
1853 while (*cp) {
1854 switch (*cp) {
1855 case '0':
1856 case '1':
1857 case '2':
1858 case '3':
1859 case '4':
1860 case '5':
1861 case '6':
1862 case '7':
1863 case '8':
1864 case '9':
1865 case '.':
1866 break;
1867 default:
1868 /* Not of format nnn.nnn.nnn.nnn. Could be IPv6 */
1869 goto check_ipv6;
1870 }
1871 cp++;
1872 }
1873 /* IPv4 address - not allowed. */
1874 *client_sni = NULL;
1875 return;
1876
1877check_ipv6:
1878 /* Check for IPv6 */
1879 cp = *client_sni;
1880 while (*cp) {
1881 switch (*cp) {
1882 case '0':
1883 case '1':
1884 case '2':
1885 case '3':
1886 case '4':
1887 case '5':
1888 case '6':
1889 case '7':
1890 case '8':
1891 case '9':
1892 case 'a':
1893 case 'b':
1894 case 'c':
1895 case 'd':
1896 case 'e':
1897 case 'f':
1898 case 'A':
1899 case 'B':
1900 case 'C':
1901 case 'D':
1902 case 'E':
1903 case 'F':
1904 case ':':
1905 break;
1906 case '%':
1907 /* Start of i/f specification, Previous is IPv6 */
1908 *client_sni = NULL;
1909 return;
1910 default:
1911 /* Not of format xx:xx::xx. */
1912 return;
1913 }
1914 cp++;
1915 }
1916 *client_sni = NULL;
1917 return;
1918}
1919
1922 const coap_address_t *local_if,
1923 const coap_address_t *server,
1924 coap_proto_t proto,
1925 coap_dtls_cpsk_t *setup_data) {
1926 coap_session_t *session;
1927
1928 coap_lock_lock(return NULL);
1929 session = coap_new_client_session_psk3_lkd(ctx, local_if, server, proto, setup_data,
1930 NULL, NULL, NULL);
1932 return session;
1933}
1934
1937 const coap_address_t *local_if,
1938 const coap_address_t *server,
1939 coap_proto_t proto,
1940 coap_dtls_cpsk_t *setup_data,
1941 void *app_data,
1943 coap_str_const_t *ws_host) {
1944 coap_session_t *session;
1945
1946 coap_lock_lock(return NULL);
1947 session = coap_new_client_session_psk3_lkd(ctx, local_if, server, proto,
1948 setup_data, app_data, callback, ws_host);
1950 return session;
1951}
1952
1955 const coap_address_t *local_if,
1956 const coap_address_t *server,
1957 coap_proto_t proto,
1958 coap_dtls_cpsk_t *setup_data,
1959 void *app_data,
1961 coap_str_const_t *ws_host) {
1962 coap_session_t *session;
1963
1965 session = coap_session_create_client(ctx, local_if, server, proto, app_data, callback, ws_host);
1966
1967 if (!session || !setup_data)
1968 return NULL;
1969
1970 session->cpsk_setup_data = *setup_data;
1971 if (setup_data->psk_info.identity.s) {
1972 session->psk_identity =
1974 setup_data->psk_info.identity.length);
1975 if (!session->psk_identity) {
1976 coap_log_warn("Cannot store session Identity (PSK)\n");
1977 coap_session_release_lkd(session);
1978 return NULL;
1979 }
1981 coap_log_warn("Identity (PSK) not defined\n");
1982 coap_session_release_lkd(session);
1983 return NULL;
1984 }
1985
1986 if (setup_data->psk_info.key.s && setup_data->psk_info.key.length > 0) {
1987 session->psk_key = coap_new_bin_const(setup_data->psk_info.key.s,
1988 setup_data->psk_info.key.length);
1989 if (!session->psk_key) {
1990 coap_log_warn("Cannot store session pre-shared key (PSK)\n");
1991 coap_session_release_lkd(session);
1992 return NULL;
1993 }
1995 coap_log_warn("Pre-shared key (PSK) not defined\n");
1996 coap_session_release_lkd(session);
1997 return NULL;
1998 }
1999
2000 coap_sanitize_client_sni(&session->cpsk_setup_data.client_sni);
2001
2003 if (!coap_dtls_context_set_cpsk(ctx, &session->cpsk_setup_data)) {
2004 coap_session_release_lkd(session);
2005 return NULL;
2006 }
2007 }
2008 coap_log_debug("***%s: new outgoing session\n",
2009 coap_session_str(session));
2010 coap_session_check_connect(session);
2011 return session;
2012}
2013#endif /* COAP_CLIENT_SUPPORT */
2014
2015int
2017 const coap_bin_const_t *psk_hint
2018 ) {
2019 /* We may be refreshing the hint with the same hint */
2020 coap_bin_const_t *old_psk_hint = session->psk_hint;
2021
2022 if (psk_hint && psk_hint->s) {
2023 if (session->psk_hint) {
2024 if (coap_binary_equal(session->psk_hint, psk_hint))
2025 return 1;
2026 }
2027 session->psk_hint = coap_new_bin_const(psk_hint->s,
2028 psk_hint->length);
2029 if (!session->psk_hint) {
2030 coap_log_err("No memory to store identity hint (PSK)\n");
2031 if (old_psk_hint)
2032 coap_delete_bin_const(old_psk_hint);
2033 return 0;
2034 }
2035 } else {
2036 session->psk_hint = NULL;
2037 }
2038 if (old_psk_hint)
2039 coap_delete_bin_const(old_psk_hint);
2040
2041 return 1;
2042}
2043
2044int
2046 const coap_bin_const_t *psk_key
2047 ) {
2048 /* We may be refreshing the key with the same key */
2049 coap_bin_const_t *old_psk_key = session->psk_key;
2050
2051 if (psk_key && psk_key->s) {
2052 if (session->psk_key) {
2053 if (coap_binary_equal(session->psk_key, psk_key))
2054 return 1;
2055 }
2056 session->psk_key = coap_new_bin_const(psk_key->s, psk_key->length);
2057 if (!session->psk_key) {
2058 coap_log_err("No memory to store pre-shared key (PSK)\n");
2059 if (old_psk_key)
2060 coap_delete_bin_const(old_psk_key);
2061 return 0;
2062 }
2063 } else {
2064 session->psk_key = NULL;
2065 }
2066 if (old_psk_key)
2067 coap_delete_bin_const(old_psk_key);
2068
2069 return 1;
2070}
2071
2072int
2074 const coap_bin_const_t *psk_identity
2075 ) {
2076 /* We may be refreshing the identity with the same identity */
2077 coap_bin_const_t *old_psk_identity = session->psk_identity;
2078
2079 if (psk_identity && psk_identity->s) {
2080 if (session->psk_identity) {
2081 if (coap_binary_equal(session->psk_identity, psk_identity))
2082 return 1;
2083 }
2084 session->psk_identity = coap_new_bin_const(psk_identity->s,
2085 psk_identity->length);
2086 if (!session->psk_identity) {
2087 coap_log_err("No memory to store pre-shared key identity (PSK)\n");
2088 if (old_psk_identity)
2089 coap_delete_bin_const(old_psk_identity);
2090 return 0;
2091 }
2092 } else {
2093 session->psk_identity = NULL;
2094 }
2095 if (old_psk_identity)
2096 coap_delete_bin_const(old_psk_identity);
2097
2098 return 1;
2099}
2100
2101#if COAP_SERVER_SUPPORT
2102const coap_bin_const_t *
2104 if (session)
2105 return session->psk_hint;
2106 return NULL;
2107}
2108#endif /* COAP_SERVER_SUPPORT */
2109
2110const coap_bin_const_t *
2112 const coap_bin_const_t *psk_identity = NULL;
2113 if (session) {
2114 psk_identity = session->psk_identity;
2115 if (psk_identity == NULL) {
2116 psk_identity = &session->cpsk_setup_data.psk_info.identity;
2117 }
2118 }
2119 return psk_identity;
2120}
2121
2122const coap_bin_const_t *
2124 if (session)
2125 return session->psk_key;
2126 return NULL;
2127}
2128
2129#if COAP_CLIENT_SUPPORT
2132 const coap_address_t *local_if,
2133 const coap_address_t *server,
2134 coap_proto_t proto,
2135 coap_dtls_pki_t *setup_data) {
2136 coap_session_t *session;
2137
2138 coap_lock_lock(return NULL);
2139 session = coap_new_client_session_pki3_lkd(ctx, local_if, server, proto, setup_data,
2140 NULL, NULL, NULL);
2142 return session;
2143}
2144
2147 const coap_address_t *local_if,
2148 const coap_address_t *server,
2149 coap_proto_t proto,
2150 coap_dtls_pki_t *setup_data,
2151 void *app_data,
2153 coap_str_const_t *ws_host) {
2154 coap_session_t *session;
2155
2156 coap_lock_lock(return NULL);
2157 session = coap_new_client_session_pki3_lkd(ctx, local_if, server, proto, setup_data,
2158 app_data, callback, ws_host);
2160 return session;
2161}
2162
2165 const coap_address_t *local_if,
2166 const coap_address_t *server,
2167 coap_proto_t proto,
2168 coap_dtls_pki_t *setup_data,
2169 void *app_data,
2171 coap_str_const_t *ws_host) {
2172 coap_session_t *session;
2173 coap_dtls_pki_t l_setup_data;
2174
2175 if (!setup_data)
2176 return NULL;
2177 if (setup_data->version != COAP_DTLS_PKI_SETUP_VERSION) {
2178 coap_log_err("coap_new_client_session_pki: Wrong version of setup_data\n");
2179 return NULL;
2180 }
2181
2183 l_setup_data = *setup_data;
2184 coap_sanitize_client_sni(&l_setup_data.client_sni);
2185
2186 session = coap_session_create_client(ctx, local_if, server, proto, app_data, callback, ws_host);
2187
2188 if (!session) {
2189 return NULL;
2190 }
2191
2193 /* we know that setup_data is not NULL */
2194 if (!coap_dtls_context_set_pki(ctx, &l_setup_data, COAP_DTLS_ROLE_CLIENT)) {
2195 coap_session_release_lkd(session);
2196 return NULL;
2197 }
2198 }
2199 coap_log_debug("***%s: new outgoing session\n",
2200 coap_session_str(session));
2201 coap_session_check_connect(session);
2202 return session;
2203}
2204#endif /* ! COAP_CLIENT_SUPPORT */
2205
2206#if COAP_SERVER_SUPPORT
2207#if !COAP_DISABLE_TCP
2210 coap_session_t *session;
2211 coap_tick_t now;
2212
2214 NULL, NULL, NULL, 0, ctx, ep);
2215 if (!session)
2216 goto error;
2217
2218 memcpy(session->sock.lfunc, ep->sock.lfunc, sizeof(session->sock.lfunc));
2219 if (!coap_netif_strm_accept(ep, session, extra))
2220 goto error;
2221
2222 coap_make_addr_hash(&session->addr_hash, session->proto, &session->addr_info);
2223
2224 session->sock.session = session;
2225#ifdef COAP_EPOLL_SUPPORT
2226 coap_epoll_ctl_add(&session->sock,
2227 EPOLLIN,
2228 __func__);
2229#endif /* COAP_EPOLL_SUPPORT */
2230 SESSIONS_ADD(ep->sessions, session);
2231 if (session) {
2232 coap_ticks(&now);
2233 session->last_rx_tx = now;
2234 coap_log_debug("***%s: session %p: new incoming session\n",
2235 coap_session_str(session), (void *)session);
2239 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
2240 }
2241 return session;
2242
2243error:
2244 /*
2245 * Need to add in the session as coap_session_release_lkd()
2246 * will call SESSIONS_DELETE in coap_session_free().
2247 */
2248 if (session) {
2249 SESSIONS_ADD(ep->sessions, session);
2250 coap_session_free(session);
2251 }
2252 return NULL;
2253}
2254#endif /* !COAP_DISABLE_TCP */
2255#endif /* COAP_SERVER_SUPPORT */
2256
2257void
2259 const uint8_t *data) {
2260 session->tx_token = coap_decode_var_bytes8(data, len);
2261 /*
2262 * Decrement as when first used by coap_session_new_token() it will
2263 * get incremented
2264 */
2265 session->tx_token--;
2266}
2267
2268void
2270 uint8_t *data) {
2271 *len = coap_encode_var_safe8(data,
2272 sizeof(session->tx_token), ++session->tx_token);
2273}
2274
2275COAP_API uint16_t
2277 uint16_t mid;
2278
2279 coap_lock_lock(return 0);
2280 mid = coap_new_message_id_lkd(session);
2282 return mid;
2283}
2284
2285uint16_t
2288 if (COAP_PROTO_NOT_RELIABLE(session->proto))
2289 return ++session->tx_mid;
2290 /* TCP/TLS have no notion of mid */
2291 return 0;
2292}
2293
2294const coap_address_t *
2296 if (session)
2297 return &session->addr_info.remote;
2298 return NULL;
2299}
2300
2301const coap_address_t *
2303 if (session)
2304 return &session->addr_info.local;
2305 return NULL;
2306}
2307
2308const coap_address_t *
2310#if COAP_CLIENT_SUPPORT
2311 if (session && session->type == COAP_SESSION_TYPE_CLIENT &&
2312 session->sock.flags & COAP_SOCKET_MULTICAST)
2313 return &session->sock.mcast_addr;
2314#else /* ! COAP_CLIENT_SUPPORT */
2315 (void)session;
2316#endif /* ! COAP_CLIENT_SUPPORT */
2317 return NULL;
2318}
2319
2322 if (session)
2323 return session->context;
2324 return NULL;
2325}
2326
2329 if (session)
2330 return session->proto;
2331 return 0;
2332}
2333
2336 if (session)
2337 return session->type;
2338 return 0;
2339}
2340
2341COAP_API int
2343 int ret;
2344
2345 coap_lock_lock(return 0);
2346 ret = coap_session_set_type_client_lkd(session, 1);
2348 return ret;
2349}
2350
2351int
2353#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2354 if (session && session->type == COAP_SESSION_TYPE_SERVER) {
2356 session->type = COAP_SESSION_TYPE_CLIENT;
2357 if (session->endpoint) {
2358 SESSIONS_DELETE(session->endpoint->sessions, session);
2359 SESSIONS_ADD(session->context->sessions, session);
2360 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
2361 session->sock = session->endpoint->sock;
2362 session->sock.flags |= COAP_SOCKET_SLAVE;
2363 session->sock.flags &= ~COAP_SOCKET_CAN_READ;
2364 session->sock.flags &= ~COAP_SOCKET_WANT_READ;
2365 } else {
2366 session->sock.endpoint = NULL;
2367 }
2368 session->endpoint = NULL;
2369 }
2370 if (report_changed) {
2371 coap_log_debug("***%s: session now is type Client\n",
2372 coap_session_str(session));
2373 }
2374 return 1;
2375 }
2376#else /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2377 (void)session;
2378 (void)report_changed;
2379#endif /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2380 return 0;
2381}
2382
2383COAP_API int
2385 int ret;
2386
2387 coap_lock_lock(return 0);
2388 ret = coap_session_set_type_server_lkd(session);
2390 return ret;
2391}
2392
2393int
2395#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2396 if (session && session->type == COAP_SESSION_TYPE_CLIENT) {
2397 coap_endpoint_t *ep;
2398 coap_mid_t mid;
2399 coap_pdu_t *ping = NULL;
2400
2401 LL_FOREACH(session->context->endpoint, ep) {
2402 if (session->proto == ep->proto)
2403 break;
2404 }
2405 if (!ep) {
2406 /* Need a dummy endpoint to 'hang' off as this is now a server */
2407 ep = coap_malloc_endpoint();
2408 if (!ep) {
2409 coap_log_warn("coap_new_endpoint: malloc");
2410 return 0;
2411 }
2412
2413 memset(ep, 0, sizeof(coap_endpoint_t));
2414 ep->context = session->context;
2415 ep->proto = session->proto;
2416 ep->sock.endpoint = ep;
2417 memcpy(&ep->sock.lfunc, coap_layers_coap[session->proto], sizeof(ep->sock.lfunc));
2418
2420 LL_PREPEND(session->context->endpoint, ep);
2421 }
2422 /* Need to use coap_send_lkd() here to get traffic flowing */
2423 if (session->proto == COAP_PROTO_UDP) {
2425 coap_new_message_id_lkd(session), 0);
2426 if (!ping) {
2427 session->type = COAP_SESSION_TYPE_SERVER;
2428 return 0;
2429 }
2430 mid = coap_send_lkd(session, ping);
2431 if (mid != COAP_INVALID_MID) {
2432 coap_tick_t now;
2433
2434 coap_ticks(&now);
2435 session->last_ping_mid = mid;
2436 session->last_rx_tx = now;
2437 session->last_ping = now;
2438 }
2439 }
2440 /*
2441 * (D)TLS will initiate traffic with handshake.
2442 * Reliable protocols will be sending a CSM, so no nead for Ping.
2443 */
2444 if (session->context) {
2445 if (session->context->sessions) {
2446 SESSIONS_DELETE(session->context->sessions, session);
2447 }
2448 }
2449 SESSIONS_ADD(ep->sessions, session);
2450 session->endpoint = ep;
2451 session->type = COAP_SESSION_TYPE_SERVER;
2452 coap_session_release_lkd(session);
2453 coap_log_debug("***%s: session now is type Server\n",
2454 coap_session_str(session));
2455 return 1;
2456 }
2457#else /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2458 (void)session;
2459#endif /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2460 return 0;
2461}
2462
2465 if (session)
2466 return session->state;
2467 return 0;
2468}
2469
2472#if COAP_SERVER_SUPPORT
2473 if (session)
2474 return session->endpoint;
2475#else /* ! COAP_SERVER_SUPPORT */
2476 (void)session;
2477#endif /* ! COAP_SERVER_SUPPORT */
2478 return 0;
2479}
2480
2481int
2483 if (session)
2484 return session->ifindex;
2485 return -1;
2486}
2487
2488void *
2490 coap_tls_library_t *tls_lib) {
2491 if (session)
2492 return coap_dtls_get_tls(session, tls_lib);
2493 return NULL;
2494}
2495
2496static const char *
2498 switch (proto) {
2499 case COAP_PROTO_UDP:
2500 return "UDP ";
2501 case COAP_PROTO_DTLS:
2502 return "DTLS";
2503 case COAP_PROTO_TCP:
2504 return "TCP ";
2505 case COAP_PROTO_TLS:
2506 return "TLS ";
2507 case COAP_PROTO_WS:
2508 return "WS ";
2509 case COAP_PROTO_WSS:
2510 return "WSS ";
2511 case COAP_PROTO_NONE:
2512 case COAP_PROTO_LAST:
2513 default:
2514 return "????" ;
2515 break;
2516 }
2517 return NULL;
2518}
2519
2520#if COAP_SERVER_SUPPORT
2522coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto) {
2523 coap_endpoint_t *endpoint;
2524
2525 coap_lock_lock(return NULL);
2526 endpoint = coap_new_endpoint_lkd(context, listen_addr, proto);
2528 return endpoint;
2529}
2530
2532coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr,
2533 coap_proto_t proto) {
2534 coap_endpoint_t *ep = NULL;
2535
2536 if (!context || !listen_addr) {
2537 coap_log_debug("coap_new_endpoint: Both context and listen_addr need to be defined\n");
2538 return NULL;
2539 }
2540
2542
2543 switch (proto) {
2544 case COAP_PROTO_UDP:
2545 break;
2546 case COAP_PROTO_DTLS:
2547 if (!coap_dtls_is_supported()) {
2548 coap_log_warn("coap_new_endpoint: DTLS not supported\n");
2549 return NULL;
2550 }
2551 break;
2552 case COAP_PROTO_TLS:
2553 if (!coap_tls_is_supported()) {
2554 coap_log_warn("coap_new_endpoint: TLS not supported\n");
2555 return NULL;
2556 }
2557 break;
2558 case COAP_PROTO_TCP:
2559 if (!coap_tcp_is_supported()) {
2560 coap_log_warn("coap_new_endpoint: TCP not supported\n");
2561 return NULL;
2562 }
2563 break;
2564 case COAP_PROTO_WS:
2565 if (!coap_ws_is_supported()) {
2566 coap_log_warn("coap_new_endpoint: WS not supported\n");
2567 return NULL;
2568 }
2569 break;
2570 case COAP_PROTO_WSS:
2571 if (!coap_wss_is_supported()) {
2572 coap_log_warn("coap_new_endpoint: WSS not supported\n");
2573 return NULL;
2574 }
2575 break;
2576 case COAP_PROTO_NONE:
2577 case COAP_PROTO_LAST:
2578 default:
2579 coap_log_crit("coap_new_endpoint: Unsupported protocol %d\n", proto);
2580 return NULL;
2581 }
2582
2583 if (proto == COAP_PROTO_DTLS || proto == COAP_PROTO_TLS ||
2584 proto == COAP_PROTO_WSS) {
2586 coap_log_info("coap_new_endpoint: one of coap_context_set_psk() or "
2587 "coap_context_set_pki() not called\n");
2588 return NULL;
2589 }
2590 }
2591 ep = coap_malloc_endpoint();
2592 if (!ep) {
2593 coap_log_warn("coap_new_endpoint: malloc");
2594 return NULL;
2595 }
2596
2597 memset(ep, 0, sizeof(coap_endpoint_t));
2598 ep->context = context;
2599 ep->proto = proto;
2600 ep->sock.endpoint = ep;
2601 if (proto < COAP_PROTO_LAST) {
2602 /*
2603 * Should be caught above, but come compilers realize that proto
2604 * includes COAP_PROTO_LAST, but there is no table entry for that
2605 */
2606 memcpy(&ep->sock.lfunc, coap_layers_coap[proto], sizeof(ep->sock.lfunc));
2607 }
2608
2609 if (COAP_PROTO_NOT_RELIABLE(proto)) {
2610 if (!coap_netif_dgrm_listen(ep, listen_addr))
2611 goto error;
2612#ifdef WITH_CONTIKI
2613 ep->sock.context = context;
2614#endif /* WITH_CONTIKI */
2615#if !COAP_DISABLE_TCP
2616 } else if (COAP_PROTO_RELIABLE(proto)) {
2617 if (!coap_netif_strm_listen(ep, listen_addr))
2618 goto error;
2619#endif /* !COAP_DISABLE_TCP */
2620 } else {
2621 coap_log_crit("coap_new_endpoint: Protocol type not supported %d\n", proto);
2622 goto error;
2623 }
2624
2626#ifndef INET6_ADDRSTRLEN
2627#define INET6_ADDRSTRLEN 40
2628#endif
2629 unsigned char addr_str[INET6_ADDRSTRLEN + 8];
2630
2631 if (coap_print_addr(&ep->bind_addr, addr_str, INET6_ADDRSTRLEN + 8)) {
2632 coap_log_debug("created %s endpoint %s\n", coap_proto_name(ep->proto),
2633 addr_str);
2634 }
2635 }
2636
2638
2639#ifdef COAP_EPOLL_SUPPORT
2640 ep->sock.endpoint = ep;
2642 EPOLLIN,
2643 __func__);
2644#endif /* COAP_EPOLL_SUPPORT */
2645
2646 LL_PREPEND(context->endpoint, ep);
2647 return ep;
2648
2649error:
2651 return NULL;
2652}
2653
2654void
2656 ep->default_mtu = (uint16_t)mtu;
2657}
2658
2659COAP_API void
2661 if (ep) {
2662 coap_context_t *context = ep->context;
2663 if (context) {
2664 coap_lock_lock(return);
2665 }
2667 if (context) {
2669 }
2670 }
2671}
2672
2673void
2675 if (ep) {
2676 coap_session_t *session, *rtmp;
2677
2678 if (ep->context) {
2679 /* If fully allocated and inserted */
2681 SESSIONS_ITER_SAFE(ep->sessions, session, rtmp) {
2682 if (session->ref > 0) {
2684#if COAP_CLIENT_SUPPORT
2685 if (session->client_initiated) {
2686 coap_session_release_lkd(session);
2687 }
2688#endif /* COAP_CLIENT_SUPPORT */
2689 }
2690 assert(session->ref == 0);
2691 if (session->ref == 0) {
2693 coap_session_free(session);
2694 }
2695 }
2696 if (coap_netif_available_ep(ep)) {
2697 /*
2698 * ep->sock.endpoint is set in coap_new_endpoint().
2699 * ep->sock.session is never set.
2700 *
2701 * session->sock.session is set for both clients and servers (when a
2702 * new session is accepted), but does not affect the endpoint.
2703 *
2704 * So, it is safe to call coap_netif_close_ep() after all the sessions
2705 * have been freed above as we are only working with the endpoint sock.
2706 */
2707#ifdef COAP_EPOLL_SUPPORT
2708 assert(ep->sock.session == NULL);
2709#endif /* COAP_EPOLL_SUPPORT */
2711 }
2712
2713 if (ep->context->endpoint) {
2714 LL_DELETE(ep->context->endpoint, ep);
2715 }
2716 }
2717
2718 if (ep->app_cb) {
2720 }
2721
2723 }
2724}
2725
2726void *
2728 assert(endpoint);
2729 return endpoint->app_data;
2730}
2731
2732COAP_API void *
2733coap_endpoint_set_app_data(coap_endpoint_t *endpoint, void *app_data,
2735 void *old_data;
2736
2737 coap_lock_lock(return NULL);
2738 old_data = coap_endpoint_set_app_data_lkd(endpoint, app_data, callback);
2740 return old_data;
2741}
2742
2743void *
2744coap_endpoint_set_app_data_lkd(coap_endpoint_t *endpoint, void *app_data,
2746 void *old_data = endpoint->app_data;
2747
2748 endpoint->app_data = app_data;
2749 endpoint->app_cb = app_data ? callback : NULL;
2750 return old_data;
2751}
2752
2753#endif /* COAP_SERVER_SUPPORT */
2754
2757 const coap_address_t *remote_addr,
2758 int ifindex) {
2759 coap_session_t *s, *rtmp;
2760#if COAP_CLIENT_SUPPORT
2761 SESSIONS_ITER(ctx->sessions, s, rtmp) {
2762 if (s->ifindex == ifindex) {
2763 if (s->sock.flags & COAP_SOCKET_MULTICAST) {
2764 if (coap_address_equals(&s->sock.mcast_addr, remote_addr))
2765 return s;
2766 } else if (coap_address_equals(&s->addr_info.remote, remote_addr))
2767 return s;
2768 }
2769 }
2770#endif /* COAP_CLIENT_SUPPORT */
2771#if COAP_SERVER_SUPPORT
2772 coap_endpoint_t *ep;
2773
2774 LL_FOREACH(ctx->endpoint, ep) {
2775 SESSIONS_ITER(ep->sessions, s, rtmp) {
2776 if (s->ifindex == ifindex && coap_address_equals(&s->addr_info.remote,
2777 remote_addr))
2778 return s;
2779 }
2780 }
2781#endif /* COAP_SERVER_SUPPORT */
2782 return NULL;
2783}
2784
2785#ifndef INET6_ADDRSTRLEN
2786#define INET6_ADDRSTRLEN 46
2787#endif
2788const char *
2790 static char szSession[2 * (INET6_ADDRSTRLEN + 8) + 24];
2791 char *p = szSession, *end = szSession + sizeof(szSession);
2792
2793 if (!session) {
2794 return "Session not defined";
2795 }
2796 if (coap_print_addr(&session->addr_info.local,
2797 (unsigned char *)p, end - p) > 0)
2798 p += strlen(p);
2799 if (p + 6 < end) {
2800 strcpy(p, " <-> ");
2801 p += 5;
2802 }
2803 if (p + 1 < end) {
2804 if (coap_print_addr(&session->addr_info.remote,
2805 (unsigned char *)p, end - p) > 0)
2806 p += strlen(p);
2807 }
2808 if (session->ifindex > 0 && p + 1 < end)
2809 p += snprintf(p, end - p, " (if%d)", session->ifindex);
2810 if (p + 6 < end) {
2811 strcpy(p, " ");
2812 p++;
2813 strcpy(p, coap_proto_name(session->proto));
2814 }
2815
2816 return szSession;
2817}
2818
2819#if COAP_SERVER_SUPPORT
2820const char *
2821coap_endpoint_str(const coap_endpoint_t *endpoint) {
2822 static char szEndpoint[128];
2823 char *p = szEndpoint, *end = szEndpoint + sizeof(szEndpoint);
2824 if (coap_print_addr(&endpoint->bind_addr, (unsigned char *)p, end - p) > 0)
2825 p += strlen(p);
2826 if (p + 6 < end) {
2827 if (endpoint->proto == COAP_PROTO_UDP) {
2828 strcpy(p, " UDP");
2829 } else if (endpoint->proto == COAP_PROTO_DTLS) {
2830 strcpy(p, " DTLS");
2831 } else {
2832 strcpy(p, " NONE");
2833 }
2834 }
2835
2836 return szEndpoint;
2837}
2838#endif /* COAP_SERVER_SUPPORT */
2839#if COAP_CLIENT_SUPPORT
2840void
2842 session->no_observe_cancel = 1;
2843}
2844
2845void
2847 if (session->type != COAP_SESSION_TYPE_CLIENT) {
2848 coap_lock_lock(return);
2850 coap_session_release_lkd(session);
2852 }
2853}
2854#endif /* COAP_CLIENT_SUPPORT */
2855#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 PRIuS
#define PRIu32
#define COAP_CLIENT_SUPPORT
coap_nack_reason_t
Definition coap_io.h:66
@ COAP_NACK_NOT_DELIVERABLE
Definition coap_io.h:68
@ COAP_NACK_WS_FAILED
Definition coap_io.h:75
@ COAP_NACK_TOO_MANY_RETRIES
Definition coap_io.h:67
@ COAP_NACK_TLS_FAILED
Definition coap_io.h:70
@ COAP_NACK_TLS_LAYER_FAILED
Definition coap_io.h:73
@ COAP_NACK_ICMP_ISSUE
Definition coap_io.h:71
@ COAP_NACK_WS_LAYER_FAILED
Definition coap_io.h:74
@ COAP_NACK_RST
Definition coap_io.h:69
@ COAP_NACK_BAD_RESPONSE
Definition coap_io.h:72
#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_SLAVE
socket is a slave socket - do not close
#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:46
@ COAP_STRING
Definition coap_mem.h:34
void * coap_malloc_type(coap_memory_tag_t type, size_t size)
Allocates a chunk of size bytes and returns a pointer to the newly allocated memory.
void coap_free_type(coap_memory_tag_t type, void *p)
Releases the memory that was allocated by coap_malloc_type().
int coap_dtls_context_set_pki(coap_context_t *ctx COAP_UNUSED, const coap_dtls_pki_t *setup_data COAP_UNUSED, const coap_dtls_role_t role COAP_UNUSED)
Definition coap_notls.c:108
void * coap_dtls_get_tls(const coap_session_t *c_session COAP_UNUSED, coap_tls_library_t *tls_lib)
Definition coap_notls.c:158
unsigned int coap_dtls_get_overhead(coap_session_t *session COAP_UNUSED)
Definition coap_notls.c:261
int coap_dtls_context_check_keys_enabled(coap_context_t *ctx COAP_UNUSED)
Definition coap_notls.c:147
static const char * coap_proto_name(coap_proto_t proto)
COAP_API coap_mid_t coap_session_send_ping(coap_session_t *session)
Send a ping message for the session.
static const char * coap_nack_name(coap_nack_reason_t reason)
static coap_session_t * coap_make_session(coap_proto_t proto, coap_session_type_t type, const coap_addr_hash_t *addr_hash, const coap_address_t *local_addr, const coap_address_t *remote_addr, int ifindex, coap_context_t *context, coap_endpoint_t *endpoint)
static size_t coap_session_max_pdu_size_internal(const coap_session_t *session, size_t max_with_header)
#define INET6_ADDRSTRLEN
void coap_call_home_stop_reconnecting(coap_session_t *session)
Disable CoAP Server repeating Call-Home reconnect to CoAP Client.
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_reset_doing_first(coap_session_t *session)
Reset doing the first packet state when testing for optional functionality.
coap_mid_t coap_send_lkd(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:1484
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)
#define COAP_BLOCK_FORCE_Q_BLOCK
Definition coap_block.h:74
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:151
#define COAP_TICKS_PER_SECOND
Use ms resolution on POSIX systems.
Definition coap_time.h:166
int coap_prng_lkd(void *buf, size_t len)
Fills buf with len random bytes using the default pseudo random number generator.
Definition coap_prng.c:190
#define RESOURCES_ITER(r, tmp)
int coap_handle_event_lkd(coap_context_t *context, coap_event_t event, coap_session_t *session)
Invokes the event handler of context for the given event and data.
Definition coap_net.c:5000
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:214
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:2995
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:1352
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:1232
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:1872
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition coap_net.c:1258
coap_queue_t * coap_new_node(void)
Creates a new node suitable for adding to the CoAP sendqueue.
Definition coap_net.c:243
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:3102
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:3141
void coap_ticks(coap_tick_t *t)
Returns the current value of an internal tick counter.
Definition coap_time.c:90
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:56
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:311
#define COAP_DTLS_CPSK_SETUP_VERSION
Latest CPSK setup version.
Definition coap_dtls.h:409
coap_tls_library_t
Definition coap_dtls.h:74
@ COAP_DTLS_ROLE_CLIENT
Internal function invoked for client.
Definition coap_dtls.h:49
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:70
unsigned int coap_encode_var_safe8(uint8_t *buf, size_t length, uint64_t val)
Encodes multiple-length byte sequences.
Definition coap_encode.c:80
@ COAP_EVENT_SESSION_CONNECTED
Triggered when TCP layer completes exchange of CSM information.
Definition coap_event.h:65
@ COAP_EVENT_RECONNECT_FAILED
Triggered when a session failed, and a reconnect is going to be attempted.
Definition coap_event.h:149
@ COAP_EVENT_TCP_FAILED
Triggered when TCP layer fails for some reason.
Definition coap_event.h:59
@ COAP_EVENT_SESSION_FAILED
Triggered when TCP layer fails following exchange of CSM information.
Definition coap_event.h:69
@ 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:89
@ COAP_EVENT_RECONNECT_STARTED
Triggered when a session starts to reconnect.
Definition coap_event.h:155
@ COAP_EVENT_RECONNECT_NO_MORE
Triggered when a session failed, and retry reconnect attempts failed.
Definition coap_event.h:153
@ COAP_EVENT_SESSION_CLOSED
Triggered when TCP layer closes following exchange of CSM information.
Definition coap_event.h:67
@ 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:98
@ COAP_EVENT_RECONNECT_SUCCESS
Triggered when a session failed, and a reconnect is successful.
Definition coap_event.h:151
@ COAP_EVENT_TCP_CLOSED
Triggered when TCP layer is closed.
Definition coap_event.h:57
@ COAP_EVENT_TCP_CONNECTED
Triggered when TCP layer connects.
Definition coap_event.h:55
@ COAP_EVENT_KEEPALIVE_FAILURE
Triggered when no response to a keep alive (ping) packet.
Definition coap_event.h:144
#define coap_lock_callback(func)
Dummy for no thread-safe code.
#define coap_lock_unlock()
Dummy for no thread-safe code.
#define coap_lock_check_locked()
Dummy for no thread-safe code.
#define coap_lock_lock(failed)
Dummy for no thread-safe code.
#define coap_log_debug(...)
Definition coap_debug.h:126
coap_log_t coap_get_log_level(void)
Get the current logging level.
Definition coap_debug.c:103
void coap_show_pdu(coap_log_t level, const coap_pdu_t *pdu)
Display the contents of the specified pdu.
Definition coap_debug.c:793
size_t coap_print_addr(const coap_address_t *addr, unsigned char *buf, size_t len)
Print the address into the defined buffer.
Definition coap_debug.c:241
const char * coap_endpoint_str(const coap_endpoint_t *endpoint)
Get endpoint description.
const char * coap_session_str(const coap_session_t *session)
Get session description.
#define coap_log_info(...)
Definition coap_debug.h:114
#define coap_log_warn(...)
Definition coap_debug.h:108
#define coap_log_err(...)
Definition coap_debug.h:102
#define coap_log_crit(...)
Definition coap_debug.h:96
@ COAP_LOG_DEBUG
Definition coap_debug.h:64
int coap_netif_dgrm_listen(coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
Layer function interface for Netif datagram listem (udp).
void coap_netif_close_ep(coap_endpoint_t *endpoint)
Layer function interface for Netif close for a endpoint.
int coap_netif_strm_connect1(coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
Layer function interface for Netif stream connect (tcp).
int coap_netif_strm_accept(coap_endpoint_t *endpoint, coap_session_t *session, void *extra)
Layer function interface for Netif stream accept.
int coap_netif_strm_listen(coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
Layer function interface for Netif stream listem (tcp).
int coap_netif_dgrm_connect(coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
Layer function interface for Netif datagram connect (udp).
int coap_netif_available(coap_session_t *session)
Function interface to check whether netif for session is still available.
Definition coap_netif.c:25
int coap_netif_available_ep(coap_endpoint_t *endpoint)
Function interface to check whether netif for endpoint is still available.
void coap_delete_oscore_associations(coap_session_t *session)
Cleanup all allocated OSCORE association information.
coap_pdu_t * coap_pdu_reference_lkd(coap_pdu_t *pdu)
Increment reference counter on a pdu to stop it prematurely getting freed off when coap_delete_pdu() ...
Definition coap_pdu.c:1661
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
Definition coap_pdu.c:194
int coap_update_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Updates token in pdu with length len and data.
Definition coap_pdu.c:423
#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:1523
#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:789
#define COAP_DEFAULT_PORT
Definition coap_pdu.h:41
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition coap_pdu.h:268
#define COAP_TOKEN_DEFAULT_MAX
Definition coap_pdu.h:60
#define COAP_SIGNALING_OPTION_EXTENDED_TOKEN_LENGTH
Definition coap_pdu.h:204
coap_proto_t
CoAP protocol types Note: coap_layers_coap[] needs updating if extended.
Definition coap_pdu.h:318
#define COAP_SIGNALING_OPTION_BLOCK_WISE_TRANSFER
Definition coap_pdu.h:203
#define COAPS_DEFAULT_PORT
Definition coap_pdu.h:42
coap_pdu_t * coap_pdu_init(coap_pdu_type_t type, coap_pdu_code_t code, coap_mid_t mid, size_t size)
Creates a new CoAP PDU with at least enough storage space for the given size maximum message size.
Definition coap_pdu.c:102
#define COAP_INVALID_MID
Indicates an invalid message id.
Definition coap_pdu.h:271
#define COAP_DEFAULT_MTU
Definition coap_pdu.h:45
#define COAP_BERT_BASE
Definition coap_pdu.h:48
#define COAP_SIGNALING_OPTION_MAX_MESSAGE_SIZE
Definition coap_pdu.h:202
@ COAP_PROTO_WS
Definition coap_pdu.h:324
@ COAP_PROTO_DTLS
Definition coap_pdu.h:321
@ COAP_PROTO_UDP
Definition coap_pdu.h:320
@ COAP_PROTO_NONE
Definition coap_pdu.h:319
@ COAP_PROTO_TLS
Definition coap_pdu.h:323
@ COAP_PROTO_WSS
Definition coap_pdu.h:325
@ COAP_PROTO_TCP
Definition coap_pdu.h:322
@ COAP_PROTO_LAST
Definition coap_pdu.h:326
@ COAP_SIGNALING_CODE_CSM
Definition coap_pdu.h:371
@ COAP_SIGNALING_CODE_PING
Definition coap_pdu.h:372
@ COAP_EMPTY_CODE
Definition coap_pdu.h:333
@ COAP_MESSAGE_NON
Definition coap_pdu.h:74
@ COAP_MESSAGE_CON
Definition coap_pdu.h:73
coap_session_t * coap_new_client_session_pki3_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, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PKI credentials along with app_data infor...
#define COAP_NON_PROBING_WAIT_BASE(s)
void coap_session_reestablished(coap_session_t *session)
Session has been re-connected to server.
ssize_t coap_session_delay_pdu(coap_session_t *session, coap_pdu_t *pdu, coap_queue_t *node)
int coap_session_refresh_psk_hint(coap_session_t *session, const coap_bin_const_t *psk_hint)
Refresh the session's current Identity Hint (PSK).
void coap_session_send_csm(coap_session_t *session)
Notify session transport has just connected and CSM exchange can now start.
coap_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)
int coap_session_set_type_server_lkd(coap_session_t *session)
Set the session type to server.
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.
coap_session_t * coap_new_client_session_psk3_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, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PSK credentials along with app_data infor...
int coap_session_reconnect(coap_session_t *session)
Close the current session (if not already closed) and reconnect to server (client session only).
void coap_session_server_keepalive_failed(coap_session_t *session)
Clear down a session following a keepalive failure.
void * coap_endpoint_set_app_data_lkd(coap_endpoint_t *endpoint, void *data, coap_app_data_free_callback_t callback)
Stores data with the given endpoint, returning the previously stored value or NULL.
void coap_session_establish(coap_session_t *session)
Layer function interface for layer below session accept/connect being established.
coap_fixed_point_t coap_add_fixed_fixed(coap_fixed_point_t fp1, coap_fixed_point_t fp2)
coap_tick_t coap_get_non_timeout_random_ticks(coap_session_t *session)
#define COAP_NSTART(s)
int coap_session_refresh_psk_key(coap_session_t *session, const coap_bin_const_t *psk_key)
Refresh the session's current pre-shared key (PSK).
void coap_session_connected(coap_session_t *session)
Notify session that it has just connected or reconnected.
void coap_session_failed(coap_session_t *session)
Session has failed due to a socket error.
coap_fixed_point_t coap_multi_fixed_fixed(coap_fixed_point_t fp1, coap_fixed_point_t fp2)
ssize_t coap_session_send_pdu(coap_session_t *session, coap_pdu_t *pdu)
Send a pdu according to the session's protocol.
Definition coap_net.c:1110
size_t coap_session_max_pdu_size_lkd(const coap_session_t *session)
Get maximum acceptable PDU size.
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_session_t * coap_new_client_session3_lkd(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PSK credentials along with app_data infor...
int coap_session_set_type_client_lkd(coap_session_t *session, int report_changed)
Set the session type to client.
coap_fixed_point_t coap_get_non_timeout_random(coap_session_t *session)
#define COAP_NON_MAX_RETRANSMIT(s)
coap_session_t * coap_session_reference_lkd(coap_session_t *session)
Increment reference counter on a session.
#define COAP_NON_TIMEOUT(s)
void * coap_session_set_app_data2_lkd(coap_session_t *session, void *app_data, coap_app_data_free_callback_t callback)
Stores data with the given session, returning the previously stored value or NULL.
coap_fixed_point_t coap_multi_fixed_uint(coap_fixed_point_t fp1, uint32_t u2)
#define COAP_NON_PARTIAL_TIMEOUT(s)
void coap_session_disconnected_lkd(coap_session_t *session, coap_nack_reason_t reason)
Notify session that it has failed.
coap_endpoint_t * coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto)
Create a new endpoint for communicating with peers.
coap_session_t * coap_new_server_session(coap_context_t *ctx, coap_endpoint_t *ep, void *extra)
Creates a new server session for the specified endpoint.
@ COAP_EXT_T_CHECKED
Token size valid.
COAP_API void coap_session_set_app_data(coap_session_t *session, void *app_data)
Stores data with the given session.
COAP_API coap_session_t * coap_session_reference(coap_session_t *session)
Increment reference counter on a session.
coap_session_type_t
coap_session_type_t values
COAP_API void coap_session_disconnected(coap_session_t *session, coap_nack_reason_t reason)
Notify session that it has failed.
COAP_API void * coap_endpoint_set_app_data(coap_endpoint_t *endpoint, void *data, coap_app_data_free_callback_t callback)
Stores data with the given endpoint, returning the previously stored value or NULL.
void coap_session_set_mtu(coap_session_t *session, unsigned mtu)
Set the session MTU.
coap_context_t * coap_session_get_context(const coap_session_t *session)
Get the session context.
COAP_API coap_session_t * coap_new_client_session_pki3(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, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PKI credentials along with app_data infor...
const coap_address_t * coap_session_get_addr_local(const coap_session_t *session)
Get the local IP address and port from the session.
coap_proto_t coap_session_get_proto(const coap_session_t *session)
Get the session protocol type.
COAP_API int coap_session_set_type_client(coap_session_t *session)
Set the session type to client.
const coap_bin_const_t * coap_session_get_psk_key(const coap_session_t *session)
Get the session's current pre-shared key (PSK).
void * coap_session_get_tls(const coap_session_t *session, coap_tls_library_t *tls_lib)
Get the session TLS security ptr (TLS type dependent)
coap_session_state_t coap_session_get_state(const coap_session_t *session)
Get the session state.
coap_session_state_t
coap_session_state_t values
void * coap_endpoint_get_app_data(const coap_endpoint_t *endpoint)
Returns any application-specific data that has been stored with endpoint using the function coap_endp...
coap_endpoint_t * coap_session_get_endpoint(const coap_session_t *session)
Get the endpoint of a session.
#define COAP_PROTO_NOT_RELIABLE(p)
COAP_API coap_session_t * coap_new_client_session_pki(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_pki_t *setup_data)
Creates a new client session to the designated server with PKI credentials.
void coap_session_init_token(coap_session_t *session, size_t len, const uint8_t *data)
Initializes the token value to use as a starting point.
#define COAP_PROTO_RELIABLE(p)
void coap_session_new_token(coap_session_t *session, size_t *len, uint8_t *data)
Creates a new token for use.
COAP_API coap_session_t * coap_new_client_session(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto)
Creates a new client session to the designated server.
const coap_bin_const_t * coap_session_get_psk_identity(const coap_session_t *session)
Get the server session's current PSK identity (PSK).
coap_session_t * coap_session_get_by_peer(const coap_context_t *ctx, const coap_address_t *remote_addr, int ifindex)
Get the session associated with the specified remote_addr and index.
void coap_endpoint_set_default_mtu(coap_endpoint_t *endpoint, unsigned mtu)
Set the endpoint's default MTU.
const coap_bin_const_t * coap_session_get_psk_hint(const coap_session_t *session)
Get the server session's current Identity Hint (PSK).
COAP_API coap_endpoint_t * coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto)
Create a new endpoint for communicating with peers.
const coap_address_t * coap_session_get_addr_remote(const coap_session_t *session)
Get the remote IP address and port from the session.
coap_session_t * coap_new_client_session_psk3(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, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, with PSK credentials along with app_data infor...
COAP_API void coap_free_endpoint(coap_endpoint_t *endpoint)
Release an endpoint and all the structures associated with it.
COAP_API coap_session_t * coap_new_client_session3(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, void *app_data, coap_app_data_free_callback_t callback, coap_str_const_t *ws_host)
Creates a new client session to the designated server, along with app_data information (as per coap_s...
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 int coap_session_set_type_server(coap_session_t *session)
Set the session type to server.
COAP_API coap_session_t * coap_new_client_session_psk(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, const char *identity, const uint8_t *key, unsigned key_len)
Creates a new client session to the designated server with PSK credentials.
int coap_session_get_ifindex(const coap_session_t *session)
Get the session if index.
void(* coap_app_data_free_callback_t)(void *data)
Callback to free off the app data when the entry is being deleted / freed off.
COAP_API void * coap_session_set_app_data2(coap_session_t *session, void *app_data, coap_app_data_free_callback_t callback)
Stores data with the given session, returning the previously stored value or NULL.
void * coap_session_get_app_data(const coap_session_t *session)
Returns any application-specific data that has been stored with session using the function coap_sessi...
coap_session_type_t coap_session_get_type(const coap_session_t *session)
Get the session type.
@ COAP_SESSION_TYPE_HELLO
server-side ephemeral session for responding to a client hello
@ COAP_SESSION_TYPE_SERVER
server-side
@ COAP_SESSION_TYPE_CLIENT
client-side
@ COAP_SESSION_STATE_HANDSHAKE
@ COAP_SESSION_STATE_CSM
@ COAP_SESSION_STATE_ESTABLISHED
@ COAP_SESSION_STATE_NONE
@ COAP_SESSION_STATE_CONNECTING
void coap_delete_bin_const(coap_bin_const_t *s)
Deletes the given const binary data and releases any memory allocated.
Definition coap_str.c:120
void coap_delete_str_const(coap_str_const_t *s)
Deletes the given const string and releases any memory allocated.
Definition coap_str.c:61
coap_bin_const_t * coap_new_bin_const(const uint8_t *data, size_t size)
Take the specified byte array (text) and create a coap_bin_const_t * Returns a new const binary objec...
Definition coap_str.c:110
#define coap_binary_equal(binary1, binary2)
Compares the two binary data for equality.
Definition coap_str.h:214
coap_str_const_t * coap_new_str_const(const uint8_t *data, size_t size)
Returns a new const string object with at least size+1 bytes storage allocated, and the provided data...
Definition coap_str.c:51
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.
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:934
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:939
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:60
coap_address_t local
local address and port
Definition coap_io.h:61
Multi-purpose address abstraction.
CoAP binary data definition with const data.
Definition coap_str.h:67
size_t length
length of binary data
Definition coap_str.h:68
const uint8_t * s
read-only binary data
Definition coap_str.h:69
coap_session_t * session
The CoAP stack's global state is stored in a coap_context_t object.
unsigned int reconnect_time
Time to wait before reconnecting a failed client session.
coap_nack_handler_t nack_cb
Called when a response issue has occurred.
coap_session_t * sessions
client sessions
uint8_t retry_count
Number of times to retry reconnecting a.
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:385
coap_bin_const_t identity
Definition coap_dtls.h:384
The structure used for defining the Client PSK setup data to be used.
Definition coap_dtls.h:414
char * client_sni
If not NULL, SNI to use in client TLS setup.
Definition coap_dtls.h:441
coap_dtls_cpsk_info_t psk_info
Client PSK definition.
Definition coap_dtls.h:447
The structure used for defining the PKI setup data to be used.
Definition coap_dtls.h:316
uint8_t version
Definition coap_dtls.h:317
char * client_sni
If not NULL, SNI to use in client TLS setup.
Definition coap_dtls.h:372
Abstraction of virtual endpoint that can be attached to coap_context_t.
void * app_data
application-specific data
coap_context_t * context
endpoint's context
uint16_t default_mtu
default mtu for this interface
coap_session_t * sessions
hash table or list of active sessions
coap_app_data_free_callback_t app_cb
call-back to release app_data
coap_address_t bind_addr
local interface address
coap_socket_t sock
socket object for the interface, if any
coap_proto_t proto
protocol used on this interface
Abstraction of a fixed point number that can be used where necessary instead of a float.
uint16_t fractional_part
Fractional part of fixed point variable 1/1000 (3 points) precision.
uint16_t integer_part
Integer part of fixed point variable.
coap_layer_establish_t l_establish
coap_layer_close_t l_close
Structure to hold large body (many blocks) client receive information.
coap_binary_t * app_token
app requesting PDU token
coap_pdu_t * sent_pdu
The sent pdu with all the data.
uint8_t observe_set
Set if this is an observe receive PDU.
Structure to hold large body (many blocks) server receive information.
Structure to hold large body (many blocks) transmission information.
size_t length
length of payload
coap_addr_tuple_t addr_info
local and remote addresses
unsigned char * payload
payload
int ifindex
the interface index
structure for CoAP PDUs
uint8_t hdr_size
actual size used for protocol-specific header (0 until header is encoded)
coap_bin_const_t actual_token
Actual token in pdu.
coap_mid_t mid
message id, if any, in regular host byte order
size_t used_size
used bytes of storage for token, options and payload
coap_session_t * session
Session responsible for PDU or NULL.
coap_pdu_type_t type
message type
Queue entry.
coap_address_t remote
For re-transmission - where the node is going.
coap_session_t * session
the CoAP session
coap_pdu_t * pdu
the CoAP PDU to send
unsigned int timeout
the randomized timeout value
struct coap_queue_t * next
coap_mid_t id
CoAP message id.
coap_tick_t t
when to send PDU for the next time
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
coap_lg_xmit_t * lg_xmit
list of large transmissions
volatile uint8_t max_token_checked
Check for max token size coap_ext_token_check_t.
coap_bin_const_t * psk_key
If client, this field contains the current pre-shared key for server; When this field is NULL,...
coap_endpoint_t * endpoint
session's endpoint
uint32_t block_mode
Zero or more COAP_BLOCK_ or'd options.
coap_app_data_free_callback_t app_cb
call-back to release app_data
uint8_t doing_first
Set if doing client's first request.
coap_socket_t sock
socket object for the session, if any
coap_pdu_t * partial_pdu
incomplete incoming pdu
uint32_t max_token_size
Largest token size supported RFC8974.
uint16_t nstart
maximum concurrent confirmable xmits (default 1)
coap_bin_const_t * psk_identity
If client, this field contains the current identity for server; When this field is NULL,...
coap_session_state_t state
current state of relationship with peer
uint8_t client_initiated
Session initially started as a client.
uint64_t tx_token
Next token number to use.
coap_bin_const_t * client_cid
Contains client CID or NULL.
coap_address_t local_reconnect
local address to initiate reconnect from
uint8_t csm_bert_loc_support
CSM TCP BERT blocks supported (local)
unsigned ref_proxy_subs
reference count of current proxy subscriptions
coap_addr_tuple_t addr_info
remote/local address info
coap_proto_t proto
protocol used
uint16_t tx_mid
the last message id that was used in this session
uint8_t is_dtls13
Set if session is DTLS1.3.
unsigned ref
reference count from queues
size_t csm_rcv_mtu
CSM mtu (rcv)
coap_response_t last_con_handler_res
The result of calling the response handler of the last CON.
coap_bin_const_t * psk_hint
If client, this field contains the server provided identity hint.
coap_bin_const_t * last_token
uint8_t doing_send_recv
Set if coap_send_recv() active.
coap_dtls_cpsk_t cpsk_setup_data
client provided PSK initial setup data
size_t mtu
path or CSM mtu (xmt)
uint8_t no_observe_cancel
Set if do not cancel observe on session close.
size_t partial_read
if > 0 indicates number of bytes already read for an incoming message
int dtls_event
Tracking any (D)TLS events on this session.
uint16_t max_retransmit
maximum re-transmit count (default 4)
coap_fixed_point_t ack_random_factor
ack random factor backoff (default 1.5)
uint8_t proxy_session
Set if this is an ongoing proxy session.
uint8_t con_active
Active CON request sent.
coap_queue_t * delayqueue
list of delayed messages waiting to be sent
size_t tls_overhead
overhead of TLS layer
void * app_data
application-specific data
uint32_t tx_rtag
Next Request-Tag number to use.
coap_mid_t last_ping_mid
the last keepalive message id that was used in this session
coap_lg_srcv_t * lg_srcv
Server list of expected large receives.
coap_bin_const_t * req_token
Token in request pdu of coap_send_recv()
coap_lg_crcv_t * lg_crcv
Client list of expected large receives.
coap_fixed_point_t ack_timeout
timeout waiting for ack (default 2.0 secs)
coap_fixed_point_t default_leisure
Mcast leisure time (default 5.0 secs)
coap_mid_t last_con_mid
The last CON mid that has been been processed.
coap_session_type_t type
client or server side socket
uint32_t probing_rate
Max transfer wait when remote is not respoding (default 1 byte/sec)
coap_mid_t last_ack_mid
The last ACK mid that has been been processed.
uint8_t retry_count
Number of retries trying to re-connect.
coap_pdu_t * doing_first_pdu
If doing fist, PDU to retry sending.
coap_context_t * context
session's context
uint8_t session_failed
Set if session failed and can try re-connect.
size_t partial_write
if > 0 indicates number of bytes already written from the pdu at the head of sendqueue
coap_addr_hash_t addr_hash
Address hash for server incoming packets.
coap_pdu_t * cached_pdu
Cached copy of last ACK response PDU.
int ifindex
interface index
coap_bin_const_t * echo
last token used to make a request
coap_layer_func_t lfunc[COAP_LAYER_LAST]
Layer functions to use.
coap_session_t * session
Used to determine session owner.
coap_endpoint_t * endpoint
Used by the epoll logic for a listening endpoint.
coap_address_t mcast_addr
remote address and port (multicast track)
coap_socket_flags_t flags
1 or more of COAP_SOCKET* flag values
CoAP string data definition with const data.
Definition coap_str.h:49
const uint8_t * s
read-only string data
Definition coap_str.h:51
size_t length
length of string
Definition coap_str.h:50