libcoap 4.3.5-develop-6884905
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
16
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
463 coap_address_init(&session->local_reconnect);
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 }
497 session->rl_ticks_per_packet = context->rl_ticks_per_packet;
501 session->nstart = COAP_DEFAULT_NSTART;
504#if COAP_Q_BLOCK_SUPPORT
505 session->max_payloads = COAP_DEFAULT_MAX_PAYLOADS;
506 session->non_max_retransmit = COAP_DEFAULT_NON_MAX_RETRANSMIT;
507 session->non_timeout = COAP_DEFAULT_NON_TIMEOUT;
508 session->non_receive_timeout = COAP_DEFAULT_NON_RECEIVE_TIMEOUT;
509 coap_session_fix_non_probing_wait_base(session);
510 coap_session_fix_non_partial_timeout(session);
511#endif /* COAP_Q_BLOCK_SUPPORT */
512 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;
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 while ((q = coap_remove_first_from_delayq(session)) != NULL) {
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#ifdef HAVE_LINUX_ERRQUEUE_H
602 coap_delete_str_const(session->last_data_write);
603#endif /* HAVE_LINUX_ERRQUEUE_H */
604
605#if COAP_SERVER_SUPPORT
606 coap_cache_entry_t *cp, *ctmp;
607 HASH_ITER(hh, session->context->cache, cp, ctmp) {
608 /* cp->session is NULL if not session based */
609 if (cp->session == session) {
610 coap_delete_cache_entry(session->context, cp);
611 }
612 }
613#endif /* COAP_PROXY_SUPPORT */
614 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
615 LL_DELETE(session->lg_xmit, lq);
616 coap_block_delete_lg_xmit(session, lq);
617 }
618#if COAP_SERVER_SUPPORT
619 coap_lg_srcv_t *sq, *stmp;
620
621 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
622 LL_DELETE(session->lg_srcv, sq);
623 coap_block_delete_lg_srcv(session, sq);
624 }
625#endif /* COAP_SERVER_SUPPORT */
626#if COAP_OSCORE_SUPPORT
628 oscore_release_recipient_ctx(&session->recipient_ctx);
629 coap_delete_str_const(session->b_2_retransmit_token);
630#endif /* COAP_OSCORE_SUPPORT */
631#if COAP_WS_SUPPORT
632 coap_free_type(COAP_STRING, session->ws);
633 coap_delete_str_const(session->ws_host);
634#endif /* COAP_WS_SUPPORT */
635}
636
637void
639 if (!session)
640 return;
642 assert(session->ref == 0);
643 if (session->ref)
644 return;
645 /* Make sure nothing gets deleted under our feet */
647 coap_session_mfree(session);
648#if COAP_SERVER_SUPPORT
649 coap_delete_bin_const(session->client_cid);
650 if (session->endpoint) {
651 if (session->endpoint->sessions)
652 SESSIONS_DELETE(session->endpoint->sessions, session);
653 } else
654#endif /* COAP_SERVER_SUPPORT */
655#if COAP_CLIENT_SUPPORT
656 if (session->context) {
657 if (session->context->sessions)
658 SESSIONS_DELETE(session->context->sessions, session);
659 }
660 coap_delete_bin_const(session->req_token);
661#endif /* COAP_CLIENT_SUPPORT */
663 coap_delete_bin_const(session->echo);
664#if COAP_SERVER_SUPPORT
665 coap_delete_pdu_lkd(session->last_resp_pdu);
666#endif /* COAP_SERVER_SUPPORT */
667
668 if (session->app_cb) {
669 coap_lock_callback(session->app_cb(session->app_data));
670 }
671 coap_log_debug("***%s: session %p: closed\n", coap_session_str(session),
672 (void *)session);
673 assert(session->ref == 1);
675}
676
677#if COAP_SERVER_SUPPORT
678void
680 int i;
681 coap_queue_t *q;
682
685 coap_cancel_all_messages(session->context, session, NULL);
686 RESOURCES_ITER(session->context->resources, r) {
687 /* In case code is broken somewhere */
688 for (i = 0; i < 1000; i++) {
689 if (!coap_delete_observer(r, session, NULL))
690 break;
691 }
692 }
693 if (session->context->unknown_resource) {
694 /* In case code is broken somewhere */
695 for (i = 0; i < 1000; i++) {
696 if (!coap_delete_observer(session->context->unknown_resource, session, NULL))
697 break;
698 }
699 }
700 if (session->context->proxy_uri_resource) {
701 /* In case code is broken somewhere */
702 for (i = 0; i < 1000; i++) {
703 if (!coap_delete_observer(session->context->proxy_uri_resource, session, NULL))
704 break;
705 }
706 }
707 while ((q = coap_remove_first_from_delayq(session)) != NULL) {
709 }
710 /* Force session to go away */
713
715}
716#endif /* COAP_SERVER_SUPPORT */
717
718static size_t
720 size_t max_with_header) {
721#if COAP_DISABLE_TCP
722 (void)session;
723 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
724 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
725 : 0;
726#else /* !COAP_DISABLE_TCP */
727 if (COAP_PROTO_NOT_RELIABLE(session->proto))
728 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
729 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
730 : 0;
731 /* we must assume there is no token to be on the safe side */
732 if (max_with_header <= 2)
733 return 0;
734 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP0 + 2)
735 return max_with_header - 2;
736 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP8 + 3)
737 return max_with_header - 3;
738 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP16 + 4)
739 return max_with_header - 4;
740 else
741 return max_with_header - COAP_PDU_MAX_TCP_HEADER_SIZE;
742#endif /* !COAP_DISABLE_TCP */
743}
744
745size_t
747 if (session->csm_rcv_mtu)
749 (size_t)(session->csm_rcv_mtu));
750
752 (size_t)(session->mtu - session->tls_overhead));
753}
754
755COAP_API size_t
757 size_t size;
758 coap_session_t *session_rw;
759
760 /*
761 * Need to do this to not get a compiler warning about const parameters
762 * but need to maintain source code backward compatibility
763 */
764 memcpy(&session_rw, &session, sizeof(session_rw));
765 coap_lock_lock(return 0);
766 size = coap_session_max_pdu_size_lkd(session_rw);
768 return size;
769}
770
771size_t
773 size_t max_with_header;
774
776#if COAP_CLIENT_SUPPORT
777 if (COAP_PROTO_RELIABLE(session->proto) &&
778 session->type == COAP_SESSION_TYPE_CLIENT &&
779 session->doing_first) {
780 /*
781 * Delay if session->doing_first is set.
782 * E.g. Reliable and CSM not in yet for checking block support
783 */
784 coap_session_t *session_rw;
785
786 /*
787 * Need to do this to not get a compiler warning about const parameters
788 * but need to maintain source code backward compatibility
789 */
790 memcpy(&session_rw, &session, sizeof(session_rw));
791 if (coap_client_delay_first(session_rw) == 0) {
792 coap_log_debug("coap_client_delay_first: timeout\n");
793 /* Have to go with the defaults */
794 }
795 }
796#endif /* COAP_CLIENT_SUPPORT */
797
798 max_with_header = (size_t)(session->mtu - session->tls_overhead);
799
800 return coap_session_max_pdu_size_internal(session, max_with_header);
801}
802
803void
804coap_session_set_mtu(coap_session_t *session, unsigned mtu) {
807 coap_log_debug("* %s: Restricting MTU size to %u\n",
808 coap_session_str(session), mtu);
809 }
810 if (mtu < 64)
811 mtu = 64;
812 session->mtu = mtu;
813 if (session->tls_overhead >= session->mtu) {
814 session->tls_overhead = session->mtu;
815 coap_log_err("DTLS overhead exceeds MTU\n");
816 }
817}
818
819ssize_t
821 coap_queue_t *node) {
822 if (node) {
823 coap_queue_t *removed = NULL;
824 /* Nodes are per ID, no notion of token */
825 coap_remove_from_queue(&session->context->sendqueue, session, node->id,
826 NULL, &removed);
827 assert(removed == node);
828 /* reuse node */
830 node->session = NULL;
831 node->t = 0;
832 } else {
833 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
834 coap_queue_t *q = NULL;
835 /* Check same mid is not getting reused in violation of RFC7252 */
836 LL_FOREACH(session->delayqueue, q) {
837 if (q->id == pdu->mid) {
838 coap_log_err("** %s: mid=0x%04x: already in-use - dropped\n",
839 coap_session_str(session), pdu->mid);
840 return COAP_INVALID_MID;
841 }
842 }
843 }
844 node = coap_new_node();
845 if (node == NULL)
846 return COAP_INVALID_MID;
847 node->id = pdu->mid;
848 node->pdu = pdu;
849 if (pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
850 uint8_t r;
851 coap_prng_lkd(&r, sizeof(r));
852 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
853 node->timeout = coap_calc_timeout(session, r);
854 }
855 coap_address_copy(&node->remote, &session->addr_info.remote);
856 }
857 coap_add_to_tail_delayq(session, node);
859 coap_log_debug("** %s: mid=0x%04x: delayed\n",
860 coap_session_str(session), node->id);
861 return COAP_PDU_DELAYED;
862}
863
864#if !COAP_DISABLE_TCP
865void
867 coap_pdu_t *pdu;
868 uint8_t buf[4];
869 assert(COAP_PROTO_RELIABLE(session->proto));
870 coap_log_debug("***%s: sending CSM\n", coap_session_str(session));
871 session->state = COAP_SESSION_STATE_CSM;
872 session->partial_write = 0;
873 if (session->mtu == 0)
874 coap_session_set_mtu(session, COAP_DEFAULT_MTU); /* base value */
876 if (pdu == NULL
878 coap_encode_var_safe(buf, sizeof(buf),
879 session->context->csm_max_message_size), buf) == 0
881 coap_encode_var_safe(buf, sizeof(buf),
882 0), buf) == 0
883 || (session->max_token_size > COAP_TOKEN_DEFAULT_MAX &&
886 coap_encode_var_safe(buf, sizeof(buf),
887 session->max_token_size),
888 buf) == 0)
889 || coap_pdu_encode_header(pdu, session->proto) == 0
890 ) {
892 } else {
893 ssize_t bytes_written;
894
895 pdu->session = session;
896 bytes_written = coap_session_send_pdu(session, pdu);
897 if (bytes_written != (ssize_t)pdu->used_size + pdu->hdr_size) {
899 } else {
900 session->csm_rcv_mtu = session->context->csm_max_message_size;
901 if (session->csm_rcv_mtu > COAP_BERT_BASE)
902 session->csm_bert_loc_support = 1;
903 else
904 session->csm_bert_loc_support = 0;
905 }
906 }
907 if (pdu)
909}
910#endif /* !COAP_DISABLE_TCP */
911
914 coap_mid_t mid;
915
917 mid = coap_session_send_ping_lkd(session);
918 if (mid != COAP_INVALID_MID) {
919 coap_tick_t now;
920
921 coap_ticks(&now);
922 session->last_ping_mid = mid;
923 session->last_rx_tx = now;
924 session->last_ping = now;
925 }
927 return mid;
928}
929
932 coap_pdu_t *ping = NULL;
933
935 if (session->state != COAP_SESSION_STATE_ESTABLISHED ||
936 session->con_active)
937 return COAP_INVALID_MID;
938 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
939 uint16_t mid = coap_new_message_id_lkd(session);
940 ping = coap_pdu_init(COAP_MESSAGE_CON, 0, mid, 0);
941 }
942#if !COAP_DISABLE_TCP
943 else {
945 }
946#endif /* !COAP_DISABLE_TCP */
947 if (!ping)
948 return COAP_INVALID_MID;
949 return coap_send_internal(session, ping, NULL);
950}
951
952void
954 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
955 coap_log_debug("***%s: session connected\n",
956 coap_session_str(session));
957 if (session->state == COAP_SESSION_STATE_CSM) {
959#if COAP_CLIENT_SUPPORT
961 coap_reset_doing_first(session);
962#endif /* COAP_CLIENT_SUPPORT */
963 }
964 }
965
967 session->partial_write = 0;
968
969 if (session->proto==COAP_PROTO_DTLS) {
970 session->tls_overhead = coap_dtls_get_overhead(session);
971 if (session->tls_overhead >= session->mtu) {
972 session->tls_overhead = session->mtu;
973 coap_log_err("DTLS overhead exceeds MTU\n");
974 }
975 }
976
977 while (session->delayqueue && session->state == COAP_SESSION_STATE_ESTABLISHED) {
978 ssize_t bytes_written;
979 coap_queue_t *q = session->delayqueue;
980 coap_address_t remote;
981
982 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
983 if (session->con_active >= COAP_NSTART(session))
984 break;
985 session->con_active++;
986 }
987 /* Take entry off the queue */
989
990 coap_address_copy(&remote, &session->addr_info.remote);
992 coap_log_debug("** %s: mid=0x%04x: transmitted after delay (2)\n",
993 coap_session_str(session), (int)q->id);
994 bytes_written = coap_session_send_pdu(session, q->pdu);
995 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
996 if (coap_wait_ack(session->context, session, q) >= 0)
997 q = NULL;
998 }
999 coap_address_copy(&session->addr_info.remote, &remote);
1000 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1001 if (q)
1003 if (bytes_written < 0)
1004 break;
1005 } else if (q) {
1006 if (bytes_written <= 0 || (size_t)bytes_written < q->pdu->used_size + q->pdu->hdr_size) {
1007 coap_add_to_head_delayq(session, q);
1008 if (bytes_written > 0)
1009 session->partial_write = (size_t)bytes_written;
1010 break;
1011 } else {
1013 }
1014 }
1015 }
1016}
1017
1018#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
1019static const char *
1021 switch (reason) {
1023 return "COAP_NACK_TOO_MANY_RETRIES";
1025 return "COAP_NACK_NOT_DELIVERABLE";
1026 case COAP_NACK_RST:
1027 return "COAP_NACK_RST";
1029 return "COAP_NACK_TLS_FAILED";
1031 return "COAP_NACK_ICMP_ISSUE";
1033 return "COAP_NACK_BAD_RESPONSE";
1035 return "COAP_NACK_TLS_LAYER_FAILED";
1037 return "COAP_NACK_WS_LAYER_FAILED";
1039 return "COAP_NACK_WS_FAILED";
1040 default:
1041 return "???";
1042 }
1043}
1044#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
1045
1046void
1048 coap_pdu_t *sent,
1049 const coap_nack_reason_t reason,
1050 const coap_mid_t mid) {
1051 if (session->context->nack_cb
1053 && !session->doing_first_pdu
1054#endif /* COAP_CLIENT_SUPPORT */
1055 ) {
1056 coap_bin_const_t token = {0, NULL};
1057
1058 if (sent) {
1059 coap_check_update_token(session, sent);
1060 token = sent->actual_token;
1061 }
1062 coap_lock_callback(session->context->nack_cb(session, sent, reason, mid));
1063 if (sent) {
1064 coap_update_token(sent, token.length, token.s);
1065 }
1066 }
1067#if COAP_CLIENT_SUPPORT
1068 if (reason != COAP_NACK_ICMP_ISSUE) {
1069 session->doing_send_recv = 0;
1070 }
1071#endif /* COAP_CLIENT_SUPPORT */
1072}
1073
1074COAP_API void
1080
1081void
1083#if !COAP_DISABLE_TCP
1084 coap_session_state_t state = session->state;
1085#endif /* !COAP_DISABLE_TCP */
1086 coap_lg_xmit_t *lq, *ltmp;
1087#if COAP_SERVER_SUPPORT
1088 coap_lg_srcv_t *sq, *stmp;
1089#endif /* COAP_SERVER_SUPPORT */
1090#if COAP_CLIENT_SUPPORT
1091 coap_lg_crcv_t *cq, *etmp;
1092#endif /* COAP_CLIENT_SUPPORT */
1093 int sent_nack = 0;
1094 coap_queue_t *q;
1095
1097#if COAP_CLIENT_SUPPORT
1098 coap_session_failed(session);
1099#endif /* COAP_CLIENT_SUPPORT */
1100
1101 q = session->context->sendqueue;
1102 while (q) {
1103 if (q->session == session) {
1104 /* Take the first one */
1105 coap_handle_nack(session, q->pdu, reason, q->id);
1106 sent_nack = 1;
1107 break;
1108 }
1109 q = q->next;
1110 }
1111
1112 while ((q = coap_remove_first_from_delayq(session)) != NULL) {
1113 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1114 coap_session_str(session), q->id);
1115 if (q->pdu->type == COAP_MESSAGE_CON) {
1116 coap_handle_nack(session, q->pdu, reason, q->id);
1117 sent_nack = 1;
1118 }
1119
1121 }
1122#if COAP_CLIENT_SUPPORT
1123 session->doing_send_recv = 0;
1124#endif /* COAP_CLIENT_SUPPORT */
1125#if COAP_CLIENT_SUPPORT
1126 if (!sent_nack && session->lg_crcv) {
1127 /* Take the first one */
1128 coap_handle_nack(session, session->lg_crcv->sent_pdu, reason,
1129 session->lg_crcv->sent_pdu->mid);
1130 sent_nack = 1;
1131 }
1132#endif /* COAP_CLIENT_SUPPORT */
1133 if (!sent_nack) {
1134 /* Unable to determine which request disconnection was for */
1135 coap_handle_nack(session, NULL, reason, 0);
1136 }
1137 coap_log_debug("***%s: session disconnected (%s)\n",
1138 coap_session_str(session), coap_nack_name(reason));
1139#if COAP_SERVER_SUPPORT
1140 coap_delete_observers(session->context, session);
1141#endif /* COAP_SERVER_SUPPORT */
1142
1143 if (session->proto == COAP_PROTO_UDP)
1145 else
1146 session->state = COAP_SESSION_STATE_NONE;
1147
1148 session->con_active = 0;
1149
1150 if (session->partial_pdu) {
1152 session->partial_pdu = NULL;
1153 }
1154 session->partial_read = 0;
1155
1156 /* Not done if nack handler called above */
1157 while ((q = coap_remove_first_from_delayq(session)) != NULL) {
1158 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1159 coap_session_str(session), q->id);
1160#if COAP_CLIENT_SUPPORT
1161 session->doing_send_recv = 0;
1162#endif /* COAP_CLIENT_SUPPORT */
1164 }
1165
1166#if COAP_CLIENT_SUPPORT
1167 if (!session->session_failed) {
1168 /* Need to do this before (D)TLS and socket is closed down */
1169 LL_FOREACH_SAFE(session->lg_crcv, cq, etmp) {
1170 LL_DELETE(session->lg_crcv, cq);
1171 coap_block_delete_lg_crcv(session, cq);
1172 }
1173 }
1174#endif /* COAP_CLIENT_SUPPORT */
1175 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
1176 LL_DELETE(session->lg_xmit, lq);
1177 coap_block_delete_lg_xmit(session, lq);
1178 }
1179#if COAP_SERVER_SUPPORT
1180 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
1181 LL_DELETE(session->lg_srcv, sq);
1182 coap_block_delete_lg_srcv(session, sq);
1183 }
1184#endif /* COAP_SERVER_SUPPORT */
1185 coap_cancel_session_messages(session->context, session, reason);
1186
1187#if !COAP_DISABLE_TCP
1188 if (COAP_PROTO_RELIABLE(session->proto)) {
1189 if (coap_netif_available(session)) {
1193 }
1194#if COAP_CLIENT_SUPPORT
1195 if (state != COAP_SESSION_STATE_NONE && !session->session_failed) {
1199 }
1200 coap_reset_doing_first(session);
1201#endif /* COAP_CLIENT_SUPPORT */
1202 }
1203#endif /* !COAP_DISABLE_TCP */
1204 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1205 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1206}
1207
1208#if COAP_CLIENT_SUPPORT
1209void
1211 if (session->context->reconnect_time && session->client_initiated) {
1212 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1213 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1214 session->session_failed = 1;
1216 session->retry_count++;
1217 if (session->context->retry_count && session->retry_count >= session->context->retry_count) {
1219 if (session->type != COAP_SESSION_TYPE_CLIENT) {
1221 coap_session_release_lkd(session);
1222 }
1223 }
1224 coap_ticks(&session->last_rx_tx);
1225 }
1226}
1227#endif /* COAP_CLIENT_SUPPORT */
1228
1229#if COAP_SERVER_SUPPORT
1230static void
1231coap_make_addr_hash(coap_addr_hash_t *addr_hash, coap_proto_t proto,
1232 const coap_addr_tuple_t *addr_info) {
1233 memset(addr_hash, 0, sizeof(coap_addr_hash_t));
1234 coap_address_copy(&addr_hash->remote, &addr_info->remote);
1235 addr_hash->lport = coap_address_get_port(&addr_info->local);
1236 addr_hash->proto = proto;
1237}
1238
1239/* Aids debugging when session is created */
1240static coap_session_t *debug_session;
1241
1243coap_endpoint_get_session(coap_endpoint_t *endpoint,
1244 const coap_packet_t *packet, coap_tick_t now) {
1245 coap_session_t *session;
1246 coap_session_t *rtmp;
1247 unsigned int num_idle = 0;
1248 unsigned int num_hs = 0;
1249 coap_session_t *oldest = NULL;
1250 coap_session_t *oldest_hs = NULL;
1251 coap_addr_hash_t addr_hash;
1252
1253 coap_make_addr_hash(&addr_hash, endpoint->proto, &packet->addr_info);
1254 SESSIONS_FIND(endpoint->sessions, addr_hash, session);
1255 if (session) {
1256 /* Maybe mcast or unicast IP address which is not in the hash */
1257 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1258 session->ifindex = packet->ifindex;
1259 session->last_rx_tx = now;
1260 return session;
1261 }
1262
1263#if COAP_CLIENT_SUPPORT
1264 SESSIONS_FIND(endpoint->context->sessions, addr_hash, session);
1265 if (session) {
1266 /* Maybe mcast or unicast IP address which is not in the hash */
1267 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1268 session->ifindex = packet->ifindex;
1269 session->last_rx_tx = now;
1270 return session;
1271 }
1272
1273 if (coap_is_mcast(&packet->addr_info.local)) {
1274 /* Check if this a proxy client packet we sent on another socket */
1275 SESSIONS_ITER(endpoint->context->sessions, session, rtmp) {
1276 if (coap_address_equals(&session->addr_info.remote, &packet->addr_info.local) &&
1279 /* Drop looped back packet to stop recursion / confusion */
1280 return NULL;
1281 }
1282 }
1283 }
1284#endif /* COAP_CLIENT_SUPPORT */
1285 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1286 if (session->ref == 0 && session->delayqueue == NULL &&
1287 session->lg_srcv == NULL && session->lg_xmit == NULL) {
1288 if (
1290 !(session->client_initiated && endpoint->context->reconnect_time) &&
1291#endif /* COAP_CLIENT_SUPPORT */
1292 session->type == COAP_SESSION_TYPE_SERVER) {
1293 ++num_idle;
1294 if (oldest==NULL || session->last_rx_tx < oldest->last_rx_tx)
1295 oldest = session;
1296
1297 if (session->state == COAP_SESSION_STATE_HANDSHAKE) {
1298 ++num_hs;
1299 /* See if this is a partial (D)TLS session set up
1300 which needs to be cleared down to prevent DOS */
1301 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1302 if (oldest_hs == NULL ||
1303 session->last_rx_tx < oldest_hs->last_rx_tx)
1304 oldest_hs = session;
1305 }
1306 }
1307 } else if (session->type == COAP_SESSION_TYPE_HELLO) {
1308 ++num_hs;
1309 /* See if this is a partial (D)TLS session set up for Client Hello
1310 which needs to be cleared down to prevent DOS */
1311 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1312 if (oldest_hs == NULL ||
1313 session->last_rx_tx < oldest_hs->last_rx_tx)
1314 oldest_hs = session;
1315 }
1316 }
1317 }
1318 }
1319
1320 if (endpoint->context->max_idle_sessions > 0 &&
1321 num_idle >= endpoint->context->max_idle_sessions) {
1323 coap_session_free(oldest);
1324 } else if (oldest_hs) {
1325 coap_log_warn("***%s: Incomplete session timed out\n",
1326 coap_session_str(oldest_hs));
1328 coap_session_free(oldest_hs);
1329 }
1330
1331 if (num_hs > (endpoint->context->max_handshake_sessions ?
1332 endpoint->context->max_handshake_sessions :
1334 /* Maxed out on number of sessions in (D)TLS negotiation state */
1335 coap_log_debug("Outstanding sessions in COAP_SESSION_STATE_HANDSHAKE too "
1336 "large. New request ignored\n");
1337 return NULL;
1338 }
1339
1340 if (endpoint->proto == COAP_PROTO_DTLS) {
1341 /*
1342 * Need to check that this actually is a Client Hello before wasting
1343 * time allocating and then freeing off session.
1344 */
1345
1346 /*
1347 * Generic header structure of the DTLS record layer.
1348 * typedef struct __attribute__((__packed__)) {
1349 * uint8_t content_type; content type of the included message
1350 * uint16_t version; Protocol version
1351 * uint16_t epoch; counter for cipher state changes
1352 * uint8_t sequence_number[6]; sequence number
1353 * uint16_t length; length of the following fragment
1354 * uint8_t handshake; If content_type == DTLS_CT_HANDSHAKE
1355 * } dtls_record_handshake_t;
1356 */
1357#define OFF_CONTENT_TYPE 0 /* offset of content_type in dtls_record_handshake_t */
1358#define DTLS_CT_ALERT 21 /* Content Type Alert */
1359#define DTLS_CT_HANDSHAKE 22 /* Content Type Handshake */
1360#define OFF_HANDSHAKE_TYPE 13 /* offset of handshake in dtls_record_handshake_t */
1361#define DTLS_HT_CLIENT_HELLO 1 /* Client Hello handshake type */
1362#define DTLS_CT_CID 25 /* Content Type Connection ID */
1363#define OFF_CID 11 /* offset of CID in dtls_record_handshake_t */
1364#define OFF_CID_DTLS13 1 /* offset of CID in DTLS1.3 Unified Header */
1365
1366 const uint8_t *payload = (const uint8_t *)packet->payload;
1367 size_t length = packet->length;
1368 if (length < (OFF_HANDSHAKE_TYPE + 1)) {
1369 coap_log_debug("coap_dtls_hello: ContentType %d Short Packet (%" PRIuS " < %d) dropped\n",
1370 payload[OFF_CONTENT_TYPE], length,
1371 OFF_HANDSHAKE_TYPE + 1);
1372 return NULL;
1373 }
1374 if ((payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 ||
1375 payload[OFF_CONTENT_TYPE] == DTLS_CT_CID) {
1376 /* Client may have changed its IP address */
1377 int changed = 0;
1378
1379 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1380 if (session->client_cid) {
1381 if ((session->is_dtls13 && (payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 &&
1382 length > (OFF_CID_DTLS13 + session->client_cid->length) &&
1383 memcmp(session->client_cid->s, &payload[OFF_CID_DTLS13],
1384 session->client_cid->length) == 0) ||
1385 (!session->is_dtls13 && payload[OFF_CONTENT_TYPE] == DTLS_CT_CID &&
1386 length > (OFF_CID + session->client_cid->length) &&
1387 memcmp(session->client_cid->s, &payload[OFF_CID],
1388 session->client_cid->length) == 0)) {
1389 /* Updating IP address */
1390 coap_log_info("***%s: CID: Old Client Session\n", coap_session_str(session));
1391 SESSIONS_DELETE(endpoint->sessions, session);
1392 session->addr_info = packet->addr_info;
1393 memcpy(&session->addr_hash, &addr_hash, sizeof(session->addr_hash));
1394 SESSIONS_ADD(endpoint->sessions, session);
1395 coap_log_info("***%s: CID: New Client Session\n", coap_session_str(session));
1396 return session;
1397 }
1398 }
1399 }
1400 if (!changed) {
1401 coap_log_debug("coap_dtls_hello: ContentType Connection-IS dropped\n");
1402 return NULL;
1403 }
1404 } else if (payload[OFF_CONTENT_TYPE] != DTLS_CT_HANDSHAKE ||
1405 payload[OFF_HANDSHAKE_TYPE] != DTLS_HT_CLIENT_HELLO) {
1406 /* only log if not a late alert */
1407 if (payload[OFF_CONTENT_TYPE] != DTLS_CT_ALERT)
1408 coap_log_debug("coap_dtls_hello: ContentType %d Handshake %d dropped\n",
1409 payload[OFF_CONTENT_TYPE],
1410 payload[OFF_HANDSHAKE_TYPE]);
1411 return NULL;
1412 }
1413 }
1414
1415 session = coap_make_session(endpoint->proto, COAP_SESSION_TYPE_SERVER,
1416 &addr_hash, &packet->addr_info.local,
1417 &packet->addr_info.remote,
1418 packet->ifindex, endpoint->context, endpoint);
1419 /* Aids debugging endpoint created session */
1420 debug_session = session;
1421 if (session) {
1422 session->last_rx_tx = now;
1423 memcpy(session->sock.lfunc, endpoint->sock.lfunc,
1424 sizeof(session->sock.lfunc));
1425 if (endpoint->proto == COAP_PROTO_UDP)
1427 else if (endpoint->proto == COAP_PROTO_DTLS) {
1428 session->type = COAP_SESSION_TYPE_HELLO;
1429 }
1430 SESSIONS_ADD(endpoint->sessions, session);
1431 coap_log_debug("***%s: session %p: new incoming session\n",
1432 coap_session_str(session), (void *)session);
1434 }
1435 return session;
1436}
1437
1440 coap_tick_t now) {
1441 if (session) {
1442 session->last_rx_tx = now;
1443 session->type = COAP_SESSION_TYPE_SERVER;
1444 coap_dtls_establish(session);
1445 }
1446 return session;
1447}
1448#endif /* COAP_SERVER_SUPPORT */
1449
1450#if COAP_CLIENT_SUPPORT
1451static coap_session_t *
1452coap_session_create_client(coap_context_t *ctx,
1453 const coap_address_t *local_if,
1454 const coap_address_t *server,
1455 coap_proto_t proto,
1456 void *app_data,
1458 coap_str_const_t *ws_host) {
1459 coap_session_t *session = NULL;
1460 int default_port = COAP_DEFAULT_PORT;
1461
1462 assert(server);
1463
1464 switch (proto) {
1465 case COAP_PROTO_UDP:
1466 default_port = COAP_DEFAULT_PORT;
1467 break;
1468 case COAP_PROTO_DTLS:
1469 if (!coap_dtls_is_supported()) {
1470 coap_log_crit("coap_new_client_session*: DTLS not supported\n");
1471 return NULL;
1472 }
1473 default_port = COAPS_DEFAULT_PORT;
1474 break;
1475 case COAP_PROTO_TCP:
1476 if (!coap_tcp_is_supported()) {
1477 coap_log_crit("coap_new_client_session*: TCP not supported\n");
1478 return NULL;
1479 }
1480 default_port = COAP_DEFAULT_PORT;
1481 break;
1482 case COAP_PROTO_TLS:
1483 if (!coap_tls_is_supported()) {
1484 coap_log_crit("coap_new_client_session*: TLS not supported\n");
1485 return NULL;
1486 }
1487 default_port = COAPS_DEFAULT_PORT;
1488 break;
1489 case COAP_PROTO_WS:
1490 if (!coap_ws_is_supported()) {
1491 coap_log_crit("coap_new_client_session*: WS not supported\n");
1492 return NULL;
1493 }
1494 default_port = 80;
1495 break;
1496 case COAP_PROTO_WSS:
1497 if (!coap_wss_is_supported()) {
1498 coap_log_crit("coap_new_client_session*: WSS not supported\n");
1499 return NULL;
1500 }
1501 default_port = 443;
1502 break;
1503 case COAP_PROTO_NONE:
1504 case COAP_PROTO_LAST:
1505 default:
1506 assert(0);
1507 return NULL;
1508 }
1510 local_if, server, 0, ctx, NULL);
1511 if (!session)
1512 goto error;
1513
1515 session->sock.session = session;
1516 memcpy(&session->sock.lfunc, coap_layers_coap[proto],
1517 sizeof(session->sock.lfunc));
1518
1519 session->app_data = app_data;
1520 session->app_cb = app_data ? callback : NULL;
1521#if COAP_WS_SUPPORT
1522 if (ws_host) {
1523 session->ws_host = coap_new_str_const(ws_host->s, ws_host->length);
1524 }
1525#else /* ! COAP_WS_SUPPORT */
1526 (void)ws_host;
1527#endif /* ! COAP_WS_SUPPORT */
1528
1529 if (COAP_PROTO_NOT_RELIABLE(proto)) {
1530 coap_session_t *s, *rtmp;
1531 if (!coap_netif_dgrm_connect(session, local_if, server, default_port)) {
1532 goto error;
1533 }
1534 /* Check that this is not a duplicate 4-tuple */
1535 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
1538 &s->addr_info.local) &&
1540 &s->addr_info.remote)) {
1541 coap_log_warn("***%s: session %p: duplicate - already exists\n",
1542 coap_session_str(session), (void *)session);
1543 goto error;
1544 }
1545 }
1546#ifdef WITH_CONTIKI
1547 session->sock.context = ctx;
1548#endif /* WITH_CONTIKI */
1549#if !COAP_DISABLE_TCP
1550 } else if (COAP_PROTO_RELIABLE(proto)) {
1551 if (!coap_netif_strm_connect1(session, local_if, server, default_port)) {
1552 goto error;
1553 }
1554#endif /* !COAP_DISABLE_TCP */
1555 }
1556
1557 session->sock.session = session;
1558#ifdef COAP_EPOLL_SUPPORT
1559 coap_epoll_ctl_add(&session->sock,
1560 EPOLLIN |
1561 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1562 EPOLLOUT : 0),
1563 __func__);
1564#endif /* COAP_EPOLL_SUPPORT */
1565
1567 if (local_if)
1568 session->sock.flags |= COAP_SOCKET_BOUND;
1569#if COAP_SERVER_SUPPORT
1570 if (ctx->proxy_uri_resource)
1571 session->proxy_session = 1;
1572#endif /* COAP_SERVER_SUPPORT */
1573 SESSIONS_ADD(ctx->sessions, session);
1574 return session;
1575
1576error:
1577 /*
1578 * Need to add in the session as coap_session_release_lkd()
1579 * will call SESSIONS_DELETE in coap_session_free().
1580 */
1581 if (session)
1582 SESSIONS_ADD(ctx->sessions, session);
1583 coap_session_release_lkd(session);
1584 return NULL;
1585}
1586
1587static void
1588coap_session_check_connect(coap_session_t *session) {
1589 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1590 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1591 }
1592#if !COAP_DISABLE_TCP
1593 if (COAP_PROTO_RELIABLE(session->proto)) {
1594 if (session->sock.flags & COAP_SOCKET_WANT_CONNECT) {
1596 if (session->client_initiated) {
1597 session->doing_first = 1;
1598 }
1599 } else {
1600 /* Initial connect worked immediately */
1601 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1602 }
1603 }
1604#endif /* !COAP_DISABLE_TCP */
1605 coap_ticks(&session->last_rx_tx);
1606}
1607#endif /* COAP_CLIENT_SUPPORT */
1608
1609void
1611 if (COAP_PROTO_NOT_RELIABLE(session->proto))
1612 coap_session_connected(session);
1613#if !COAP_DISABLE_TCP
1614 if (COAP_PROTO_RELIABLE(session->proto))
1615 coap_session_send_csm(session);
1616#endif /* !COAP_DISABLE_TCP */
1617}
1618
1619#if COAP_CLIENT_SUPPORT
1620int
1622 int default_port = COAP_DEFAULT_PORT;
1623
1624 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close && !session->session_failed)
1625 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1626
1627 switch (session->proto) {
1628 case COAP_PROTO_UDP:
1629 default_port = COAP_DEFAULT_PORT;
1630 break;
1631 case COAP_PROTO_DTLS:
1632 default_port = COAPS_DEFAULT_PORT;
1633 break;
1634 case COAP_PROTO_TCP:
1635 default_port = COAP_DEFAULT_PORT;
1636 break;
1637 case COAP_PROTO_TLS:
1638 default_port = COAPS_DEFAULT_PORT;
1639 break;
1640 case COAP_PROTO_WS:
1641 default_port = 80;
1642 break;
1643 case COAP_PROTO_WSS:
1644 default_port = 443;
1645 break;
1646 case COAP_PROTO_NONE:
1647 case COAP_PROTO_LAST:
1648 default:
1649 assert(0);
1650 return 0;
1651 }
1652 session->sock.session = session;
1653 coap_log_debug("***%s: trying to reconnect\n", coap_session_str(session));
1655 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1656 session->state = COAP_SESSION_STATE_NONE;
1657 if (!coap_netif_dgrm_connect(session, &session->local_reconnect, &session->addr_info.remote,
1658 default_port)) {
1659 goto error;
1660 }
1662#ifdef WITH_CONTIKI
1663 session->sock.context = session->context;
1664#endif /* WITH_CONTIKI */
1665#if !COAP_DISABLE_TCP
1666 } else if (COAP_PROTO_RELIABLE(session->proto)) {
1667 if (!coap_netif_strm_connect1(session, &session->local_reconnect, &session->addr_info.remote,
1668 default_port)) {
1669 goto error;
1670 }
1671#endif /* !COAP_DISABLE_TCP */
1672 } else {
1673 goto error;
1674 }
1675#ifdef COAP_EPOLL_SUPPORT
1676 coap_epoll_ctl_add(&session->sock,
1677 EPOLLIN |
1678 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1679 EPOLLOUT : 0),
1680 __func__);
1681#endif /* COAP_EPOLL_SUPPORT */
1682
1684 session->sock.flags |= COAP_SOCKET_BOUND;
1685 coap_session_check_connect(session);
1686 return 1;
1687error:
1688 return 0;
1689}
1690
1691void
1693 coap_lg_crcv_t *lg_crcv, *etmp;
1694
1695 if (!session->session_failed)
1696 return;
1697 coap_log_debug("***%s: session re-established\n",
1698 coap_session_str(session));
1699 session->session_failed = 0;
1700 session->retry_count = 0;
1702 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
1703 coap_pdu_reference_lkd(lg_crcv->sent_pdu);
1704 coap_send_internal(session, lg_crcv->sent_pdu, NULL);
1705 }
1706}
1707
1710 const coap_address_t *local_if,
1711 const coap_address_t *server,
1712 coap_proto_t proto) {
1713 coap_session_t *session;
1714
1715 coap_lock_lock(return NULL);
1716 session = coap_new_client_session3_lkd(ctx, local_if, server, proto, NULL, NULL, NULL);
1718 return session;
1719}
1720
1723 const coap_address_t *local_if,
1724 const coap_address_t *server,
1725 coap_proto_t proto,
1726 void *app_data,
1728 coap_str_const_t *ws_host) {
1729 coap_session_t *session;
1730
1731 coap_lock_lock(return NULL);
1732 session = coap_new_client_session3_lkd(ctx, local_if, server, proto, app_data, callback, ws_host);
1734 return session;
1735}
1736
1739 const coap_address_t *local_if,
1740 const coap_address_t *server,
1741 coap_proto_t proto,
1742 void *app_data,
1744 coap_str_const_t *ws_host) {
1745 coap_session_t *session;
1746
1748 session = coap_session_create_client(ctx, local_if, server,
1749 proto, app_data, callback, ws_host);
1750 if (session) {
1751 coap_log_debug("***%s: session %p: created outgoing session\n",
1752 coap_session_str(session), (void *)session);
1753 coap_session_check_connect(session);
1754 }
1755 return session;
1756}
1757
1760 const coap_address_t *local_if,
1761 const coap_address_t *server,
1762 coap_proto_t proto, const char *identity,
1763 const uint8_t *key, unsigned key_len) {
1764 coap_session_t *session;
1765
1766 coap_lock_lock(return NULL);
1767 session = coap_new_client_session_psk_lkd(ctx, local_if, server, proto, identity, key, key_len);
1769 return session;
1770}
1771
1774 const coap_address_t *local_if,
1775 const coap_address_t *server,
1776 coap_proto_t proto, const char *identity,
1777 const uint8_t *key, unsigned key_len) {
1778 coap_dtls_cpsk_t setup_data;
1779
1781 memset(&setup_data, 0, sizeof(setup_data));
1783
1784 if (identity) {
1785 setup_data.psk_info.identity.s = (const uint8_t *)identity;
1786 setup_data.psk_info.identity.length = strlen(identity);
1787 }
1788
1789 if (key && key_len > 0) {
1790 setup_data.psk_info.key.s = key;
1791 setup_data.psk_info.key.length = key_len;
1792 }
1793
1794 return coap_new_client_session_psk3_lkd(ctx, local_if, server,
1795 proto, &setup_data, NULL, NULL, NULL);
1796}
1797
1798/*
1799 * Check the validity of the SNI to send to the server.
1800 *
1801 * https://datatracker.ietf.org/doc/html/rfc6066#section-3
1802 * Literal IPv4 and IPv6 addresses are not permitted in "HostName".
1803 */
1804static void
1805coap_sanitize_client_sni(char **client_sni) {
1806 char *cp;
1807
1808 if (*client_sni == NULL)
1809 return;
1810
1811 cp = *client_sni;
1812 switch (*cp) {
1813 case '0':
1814 case '1':
1815 case '2':
1816 case '3':
1817 case '4':
1818 case '5':
1819 case '6':
1820 case '7':
1821 case '8':
1822 case '9':
1823 case 'a':
1824 case 'b':
1825 case 'c':
1826 case 'd':
1827 case 'e':
1828 case 'f':
1829 case 'A':
1830 case 'B':
1831 case 'C':
1832 case 'D':
1833 case 'E':
1834 case 'F':
1835 case ':':
1836 break;
1837 case '\000':
1838 /* Empty entry invalid */
1839 *client_sni = NULL;
1840 return;
1841 default:
1842 /* Does not start with a hex digit or : - not literal IP. */
1843 return;
1844 }
1845 /* Check for IPv4 */
1846 while (*cp) {
1847 switch (*cp) {
1848 case '0':
1849 case '1':
1850 case '2':
1851 case '3':
1852 case '4':
1853 case '5':
1854 case '6':
1855 case '7':
1856 case '8':
1857 case '9':
1858 case '.':
1859 break;
1860 default:
1861 /* Not of format nnn.nnn.nnn.nnn. Could be IPv6 */
1862 goto check_ipv6;
1863 }
1864 cp++;
1865 }
1866 /* IPv4 address - not allowed. */
1867 *client_sni = NULL;
1868 return;
1869
1870check_ipv6:
1871 /* Check for IPv6 */
1872 cp = *client_sni;
1873 while (*cp) {
1874 switch (*cp) {
1875 case '0':
1876 case '1':
1877 case '2':
1878 case '3':
1879 case '4':
1880 case '5':
1881 case '6':
1882 case '7':
1883 case '8':
1884 case '9':
1885 case 'a':
1886 case 'b':
1887 case 'c':
1888 case 'd':
1889 case 'e':
1890 case 'f':
1891 case 'A':
1892 case 'B':
1893 case 'C':
1894 case 'D':
1895 case 'E':
1896 case 'F':
1897 case ':':
1898 break;
1899 case '%':
1900 /* Start of i/f specification, Previous is IPv6 */
1901 *client_sni = NULL;
1902 return;
1903 default:
1904 /* Not of format xx:xx::xx. */
1905 return;
1906 }
1907 cp++;
1908 }
1909 *client_sni = NULL;
1910 return;
1911}
1912
1915 const coap_address_t *local_if,
1916 const coap_address_t *server,
1917 coap_proto_t proto,
1918 coap_dtls_cpsk_t *setup_data) {
1919 coap_session_t *session;
1920
1921 coap_lock_lock(return NULL);
1922 session = coap_new_client_session_psk3_lkd(ctx, local_if, server, proto, setup_data,
1923 NULL, NULL, NULL);
1925 return session;
1926}
1927
1930 const coap_address_t *local_if,
1931 const coap_address_t *server,
1932 coap_proto_t proto,
1933 coap_dtls_cpsk_t *setup_data,
1934 void *app_data,
1936 coap_str_const_t *ws_host) {
1937 coap_session_t *session;
1938
1939 coap_lock_lock(return NULL);
1940 session = coap_new_client_session_psk3_lkd(ctx, local_if, server, proto,
1941 setup_data, app_data, callback, ws_host);
1943 return session;
1944}
1945
1948 const coap_address_t *local_if,
1949 const coap_address_t *server,
1950 coap_proto_t proto,
1951 coap_dtls_cpsk_t *setup_data,
1952 void *app_data,
1954 coap_str_const_t *ws_host) {
1955 coap_session_t *session;
1956
1958 session = coap_session_create_client(ctx, local_if, server, proto, app_data, callback, ws_host);
1959
1960 if (!session || !setup_data)
1961 return NULL;
1962
1963 session->cpsk_setup_data = *setup_data;
1964 if (setup_data->psk_info.identity.s) {
1965 session->psk_identity =
1967 setup_data->psk_info.identity.length);
1968 if (!session->psk_identity) {
1969 coap_log_warn("Cannot store session Identity (PSK)\n");
1970 coap_session_release_lkd(session);
1971 return NULL;
1972 }
1974 coap_log_warn("Identity (PSK) not defined\n");
1975 coap_session_release_lkd(session);
1976 return NULL;
1977 }
1978
1979 if (setup_data->psk_info.key.s && setup_data->psk_info.key.length > 0) {
1980 session->psk_key = coap_new_bin_const(setup_data->psk_info.key.s,
1981 setup_data->psk_info.key.length);
1982 if (!session->psk_key) {
1983 coap_log_warn("Cannot store session pre-shared key (PSK)\n");
1984 coap_session_release_lkd(session);
1985 return NULL;
1986 }
1988 coap_log_warn("Pre-shared key (PSK) not defined\n");
1989 coap_session_release_lkd(session);
1990 return NULL;
1991 }
1992
1993 coap_sanitize_client_sni(&session->cpsk_setup_data.client_sni);
1994
1996 if (!coap_dtls_context_set_cpsk(ctx, &session->cpsk_setup_data)) {
1997 coap_session_release_lkd(session);
1998 return NULL;
1999 }
2000 }
2001 coap_log_debug("***%s: new outgoing session\n",
2002 coap_session_str(session));
2003 coap_session_check_connect(session);
2004 return session;
2005}
2006#endif /* COAP_CLIENT_SUPPORT */
2007
2008int
2010 const coap_bin_const_t *psk_hint
2011 ) {
2012 /* We may be refreshing the hint with the same hint */
2013 coap_bin_const_t *old_psk_hint = session->psk_hint;
2014
2015 if (psk_hint && psk_hint->s) {
2016 if (session->psk_hint) {
2017 if (coap_binary_equal(session->psk_hint, psk_hint))
2018 return 1;
2019 }
2020 session->psk_hint = coap_new_bin_const(psk_hint->s,
2021 psk_hint->length);
2022 if (!session->psk_hint) {
2023 coap_log_err("No memory to store identity hint (PSK)\n");
2024 if (old_psk_hint)
2025 coap_delete_bin_const(old_psk_hint);
2026 return 0;
2027 }
2028 } else {
2029 session->psk_hint = NULL;
2030 }
2031 if (old_psk_hint)
2032 coap_delete_bin_const(old_psk_hint);
2033
2034 return 1;
2035}
2036
2037int
2039 const coap_bin_const_t *psk_key
2040 ) {
2041 /* We may be refreshing the key with the same key */
2042 coap_bin_const_t *old_psk_key = session->psk_key;
2043
2044 if (psk_key && psk_key->s) {
2045 if (session->psk_key) {
2046 if (coap_binary_equal(session->psk_key, psk_key))
2047 return 1;
2048 }
2049 session->psk_key = coap_new_bin_const(psk_key->s, psk_key->length);
2050 if (!session->psk_key) {
2051 coap_log_err("No memory to store pre-shared key (PSK)\n");
2052 if (old_psk_key)
2053 coap_delete_bin_const(old_psk_key);
2054 return 0;
2055 }
2056 } else {
2057 session->psk_key = NULL;
2058 }
2059 if (old_psk_key)
2060 coap_delete_bin_const(old_psk_key);
2061
2062 return 1;
2063}
2064
2065int
2067 const coap_bin_const_t *psk_identity
2068 ) {
2069 /* We may be refreshing the identity with the same identity */
2070 coap_bin_const_t *old_psk_identity = session->psk_identity;
2071
2072 if (psk_identity && psk_identity->s) {
2073 if (session->psk_identity) {
2074 if (coap_binary_equal(session->psk_identity, psk_identity))
2075 return 1;
2076 }
2077 session->psk_identity = coap_new_bin_const(psk_identity->s,
2078 psk_identity->length);
2079 if (!session->psk_identity) {
2080 coap_log_err("No memory to store pre-shared key identity (PSK)\n");
2081 if (old_psk_identity)
2082 coap_delete_bin_const(old_psk_identity);
2083 return 0;
2084 }
2085 } else {
2086 session->psk_identity = NULL;
2087 }
2088 if (old_psk_identity)
2089 coap_delete_bin_const(old_psk_identity);
2090
2091 return 1;
2092}
2093
2094#if COAP_SERVER_SUPPORT
2095const coap_bin_const_t *
2097 if (session)
2098 return session->psk_hint;
2099 return NULL;
2100}
2101#endif /* COAP_SERVER_SUPPORT */
2102
2103const coap_bin_const_t *
2105 const coap_bin_const_t *psk_identity = NULL;
2106 if (session) {
2107 psk_identity = session->psk_identity;
2108 if (psk_identity == NULL) {
2109 psk_identity = &session->cpsk_setup_data.psk_info.identity;
2110 }
2111 }
2112 return psk_identity;
2113}
2114
2115const coap_bin_const_t *
2117 if (session)
2118 return session->psk_key;
2119 return NULL;
2120}
2121
2122#if COAP_CLIENT_SUPPORT
2125 const coap_address_t *local_if,
2126 const coap_address_t *server,
2127 coap_proto_t proto,
2128 coap_dtls_pki_t *setup_data) {
2129 coap_session_t *session;
2130
2131 coap_lock_lock(return NULL);
2132 session = coap_new_client_session_pki3_lkd(ctx, local_if, server, proto, setup_data,
2133 NULL, NULL, NULL);
2135 return session;
2136}
2137
2140 const coap_address_t *local_if,
2141 const coap_address_t *server,
2142 coap_proto_t proto,
2143 coap_dtls_pki_t *setup_data,
2144 void *app_data,
2146 coap_str_const_t *ws_host) {
2147 coap_session_t *session;
2148
2149 coap_lock_lock(return NULL);
2150 session = coap_new_client_session_pki3_lkd(ctx, local_if, server, proto, setup_data,
2151 app_data, callback, ws_host);
2153 return session;
2154}
2155
2158 const coap_address_t *local_if,
2159 const coap_address_t *server,
2160 coap_proto_t proto,
2161 coap_dtls_pki_t *setup_data,
2162 void *app_data,
2164 coap_str_const_t *ws_host) {
2165 coap_session_t *session;
2166 coap_dtls_pki_t l_setup_data;
2167
2168 if (!setup_data)
2169 return NULL;
2170 if (setup_data->version != COAP_DTLS_PKI_SETUP_VERSION) {
2171 coap_log_err("coap_new_client_session_pki: Wrong version of setup_data\n");
2172 return NULL;
2173 }
2174
2176 l_setup_data = *setup_data;
2177 coap_sanitize_client_sni(&l_setup_data.client_sni);
2178
2179 session = coap_session_create_client(ctx, local_if, server, proto, app_data, callback, ws_host);
2180
2181 if (!session) {
2182 return NULL;
2183 }
2184
2186 /* we know that setup_data is not NULL */
2187 if (!coap_dtls_context_set_pki(ctx, &l_setup_data, COAP_DTLS_ROLE_CLIENT)) {
2188 coap_session_release_lkd(session);
2189 return NULL;
2190 }
2191 }
2192 coap_log_debug("***%s: new outgoing session\n",
2193 coap_session_str(session));
2194 coap_session_check_connect(session);
2195 return session;
2196}
2197#endif /* ! COAP_CLIENT_SUPPORT */
2198
2199#if COAP_SERVER_SUPPORT
2200#if !COAP_DISABLE_TCP
2202coap_new_server_session(coap_context_t *ctx, coap_endpoint_t *ep, void *extra) {
2203 coap_session_t *session;
2204 coap_tick_t now;
2205
2206 session = coap_make_session(ep->proto, COAP_SESSION_TYPE_SERVER,
2207 NULL, NULL, NULL, 0, ctx, ep);
2208 if (!session)
2209 goto error;
2210
2211 memcpy(session->sock.lfunc, ep->sock.lfunc, sizeof(session->sock.lfunc));
2212 if (!coap_netif_strm_accept(ep, session, extra))
2213 goto error;
2214
2215 coap_make_addr_hash(&session->addr_hash, session->proto, &session->addr_info);
2216
2217 session->sock.session = session;
2218#ifdef COAP_EPOLL_SUPPORT
2219 coap_epoll_ctl_add(&session->sock,
2220 EPOLLIN,
2221 __func__);
2222#endif /* COAP_EPOLL_SUPPORT */
2223 SESSIONS_ADD(ep->sessions, session);
2224 if (session) {
2225 coap_ticks(&now);
2226 session->last_rx_tx = now;
2227 coap_log_debug("***%s: session %p: new incoming session\n",
2228 coap_session_str(session), (void *)session);
2232 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
2233 }
2234 return session;
2235
2236error:
2237 /*
2238 * Need to add in the session as coap_session_release_lkd()
2239 * will call SESSIONS_DELETE in coap_session_free().
2240 */
2241 if (session) {
2242 SESSIONS_ADD(ep->sessions, session);
2243 coap_session_free(session);
2244 }
2245 return NULL;
2246}
2247#endif /* !COAP_DISABLE_TCP */
2248#endif /* COAP_SERVER_SUPPORT */
2249
2250void
2252 const uint8_t *data) {
2253 session->tx_token = coap_decode_var_bytes8(data, len);
2254 /*
2255 * Decrement as when first used by coap_session_new_token() it will
2256 * get incremented
2257 */
2258 session->tx_token--;
2259}
2260
2261void
2263 uint8_t *data) {
2264 *len = coap_encode_var_safe8(data,
2265 sizeof(session->tx_token), ++session->tx_token);
2266}
2267
2268COAP_API uint16_t
2270 uint16_t mid;
2271
2272 coap_lock_lock(return 0);
2273 mid = coap_new_message_id_lkd(session);
2275 return mid;
2276}
2277
2278uint16_t
2281 if (COAP_PROTO_NOT_RELIABLE(session->proto))
2282 return ++session->tx_mid;
2283 /* TCP/TLS have no notion of mid */
2284 return 0;
2285}
2286
2287const coap_address_t *
2289 if (session)
2290 return &session->addr_info.remote;
2291 return NULL;
2292}
2293
2294const coap_address_t *
2296 if (session)
2297 return &session->addr_info.local;
2298 return NULL;
2299}
2300
2301const coap_address_t *
2303#if COAP_CLIENT_SUPPORT
2304 if (session && session->type == COAP_SESSION_TYPE_CLIENT &&
2305 session->sock.flags & COAP_SOCKET_MULTICAST)
2306 return &session->sock.mcast_addr;
2307#else /* ! COAP_CLIENT_SUPPORT */
2308 (void)session;
2309#endif /* ! COAP_CLIENT_SUPPORT */
2310 return NULL;
2311}
2312
2315 if (session)
2316 return session->context;
2317 return NULL;
2318}
2319
2322 if (session)
2323 return session->proto;
2324 return 0;
2325}
2326
2329 if (session)
2330 return session->type;
2331 return 0;
2332}
2333
2334int
2336#if COAP_OSCORE_SUPPORT
2337 return (session && session->oscore_encryption != 0) ? 1 : 0;
2338#else
2339 (void)session;
2340 return 0;
2341#endif
2342}
2343
2344COAP_API int
2346 int ret;
2347
2348 coap_lock_lock(return 0);
2349 ret = coap_session_set_type_client_lkd(session, 1);
2351 return ret;
2352}
2353
2354int
2356#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2357 if (session && session->type == COAP_SESSION_TYPE_SERVER) {
2359 session->type = COAP_SESSION_TYPE_CLIENT;
2360 if (session->endpoint) {
2361 SESSIONS_DELETE(session->endpoint->sessions, session);
2362 SESSIONS_ADD(session->context->sessions, session);
2363 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
2364 session->sock = session->endpoint->sock;
2365 session->sock.flags |= COAP_SOCKET_SLAVE;
2366 session->sock.flags &= ~COAP_SOCKET_CAN_READ;
2367 session->sock.flags &= ~COAP_SOCKET_WANT_READ;
2368 } else {
2369 session->sock.endpoint = NULL;
2370 }
2371 session->endpoint = NULL;
2372 }
2373 if (report_changed) {
2374 coap_log_debug("***%s: session now is type Client\n",
2375 coap_session_str(session));
2376 }
2377 return 1;
2378 }
2379#else /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2380 (void)session;
2381 (void)report_changed;
2382#endif /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2383 return 0;
2384}
2385
2386COAP_API int
2388 int ret;
2389
2390 coap_lock_lock(return 0);
2391 ret = coap_session_set_type_server_lkd(session);
2393 return ret;
2394}
2395
2396int
2398#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2399 if (session && session->type == COAP_SESSION_TYPE_CLIENT) {
2400 coap_endpoint_t *ep;
2401 coap_mid_t mid;
2402 coap_pdu_t *ping = NULL;
2403
2404 LL_FOREACH(session->context->endpoint, ep) {
2405 if (session->proto == ep->proto)
2406 break;
2407 }
2408 if (!ep) {
2409 /* Need a dummy endpoint to 'hang' off as this is now a server */
2410 ep = coap_malloc_endpoint();
2411 if (!ep) {
2412 coap_log_warn("coap_new_endpoint: malloc");
2413 return 0;
2414 }
2415
2416 memset(ep, 0, sizeof(coap_endpoint_t));
2417 ep->context = session->context;
2418 ep->proto = session->proto;
2419 ep->sock.endpoint = ep;
2420 memcpy(&ep->sock.lfunc, coap_layers_coap[session->proto], sizeof(ep->sock.lfunc));
2421
2422 ep->default_mtu = COAP_DEFAULT_MTU;
2423 LL_PREPEND(session->context->endpoint, ep);
2424 }
2425 /* Need to use coap_send_lkd() here to get traffic flowing */
2426 if (session->proto == COAP_PROTO_UDP) {
2428 coap_new_message_id_lkd(session), 0);
2429 if (!ping) {
2430 session->type = COAP_SESSION_TYPE_SERVER;
2431 return 0;
2432 }
2433 mid = coap_send_lkd(session, ping);
2434 if (mid != COAP_INVALID_MID) {
2435 coap_tick_t now;
2436
2437 coap_ticks(&now);
2438 session->last_ping_mid = mid;
2439 session->last_rx_tx = now;
2440 session->last_ping = now;
2441 }
2442 }
2443 /*
2444 * (D)TLS will initiate traffic with handshake.
2445 * Reliable protocols will be sending a CSM, so no need for Ping.
2446 */
2447 if (session->context) {
2448 if (session->context->sessions) {
2449 SESSIONS_DELETE(session->context->sessions, session);
2450 }
2451 }
2452 SESSIONS_ADD(ep->sessions, session);
2453 session->endpoint = ep;
2454 session->type = COAP_SESSION_TYPE_SERVER;
2455 coap_session_release_lkd(session);
2456 coap_log_debug("***%s: session now is type Server\n",
2457 coap_session_str(session));
2458 return 1;
2459 }
2460#else /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2461 (void)session;
2462#endif /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2463 return 0;
2464}
2465
2468 if (session)
2469 return session->state;
2470 return 0;
2471}
2472
2475#if COAP_SERVER_SUPPORT
2476 if (session)
2477 return session->endpoint;
2478#else /* ! COAP_SERVER_SUPPORT */
2479 (void)session;
2480#endif /* ! COAP_SERVER_SUPPORT */
2481 return 0;
2482}
2483
2484int
2486 if (session)
2487 return session->ifindex;
2488 return -1;
2489}
2490
2491void *
2493 coap_tls_library_t *tls_lib) {
2494 if (session)
2495 return coap_dtls_get_tls(session, tls_lib);
2496 return NULL;
2497}
2498
2499static const char *
2501 switch (proto) {
2502 case COAP_PROTO_UDP:
2503 return "UDP ";
2504 case COAP_PROTO_DTLS:
2505 return "DTLS";
2506 case COAP_PROTO_TCP:
2507 return "TCP ";
2508 case COAP_PROTO_TLS:
2509 return "TLS ";
2510 case COAP_PROTO_WS:
2511 return "WS ";
2512 case COAP_PROTO_WSS:
2513 return "WSS ";
2514 case COAP_PROTO_NONE:
2515 case COAP_PROTO_LAST:
2516 default:
2517 return "????" ;
2518 break;
2519 }
2520 return NULL;
2521}
2522
2523#if COAP_SERVER_SUPPORT
2525coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto) {
2526 coap_endpoint_t *endpoint;
2527
2528 coap_lock_lock(return NULL);
2529 endpoint = coap_new_endpoint_lkd(context, listen_addr, proto);
2531 return endpoint;
2532}
2533
2535coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr,
2536 coap_proto_t proto) {
2537 coap_endpoint_t *ep = NULL;
2538
2539 if (!context || !listen_addr) {
2540 coap_log_debug("coap_new_endpoint: Both context and listen_addr need to be defined\n");
2541 return NULL;
2542 }
2543
2545
2546 switch (proto) {
2547 case COAP_PROTO_UDP:
2548 break;
2549 case COAP_PROTO_DTLS:
2550 if (!coap_dtls_is_supported()) {
2551 coap_log_warn("coap_new_endpoint: DTLS not supported\n");
2552 return NULL;
2553 }
2554 break;
2555 case COAP_PROTO_TLS:
2556 if (!coap_tls_is_supported()) {
2557 coap_log_warn("coap_new_endpoint: TLS not supported\n");
2558 return NULL;
2559 }
2560 break;
2561 case COAP_PROTO_TCP:
2562 if (!coap_tcp_is_supported()) {
2563 coap_log_warn("coap_new_endpoint: TCP not supported\n");
2564 return NULL;
2565 }
2566 break;
2567 case COAP_PROTO_WS:
2568 if (!coap_ws_is_supported()) {
2569 coap_log_warn("coap_new_endpoint: WS not supported\n");
2570 return NULL;
2571 }
2572 break;
2573 case COAP_PROTO_WSS:
2574 if (!coap_wss_is_supported()) {
2575 coap_log_warn("coap_new_endpoint: WSS not supported\n");
2576 return NULL;
2577 }
2578 break;
2579 case COAP_PROTO_NONE:
2580 case COAP_PROTO_LAST:
2581 default:
2582 coap_log_crit("coap_new_endpoint: Unsupported protocol %d\n", proto);
2583 return NULL;
2584 }
2585
2586 if (proto == COAP_PROTO_DTLS || proto == COAP_PROTO_TLS ||
2587 proto == COAP_PROTO_WSS) {
2589 coap_log_info("coap_new_endpoint: one of coap_context_set_psk() or "
2590 "coap_context_set_pki() not called\n");
2591 return NULL;
2592 }
2593 }
2594 ep = coap_malloc_endpoint();
2595 if (!ep) {
2596 coap_log_warn("coap_new_endpoint: malloc");
2597 return NULL;
2598 }
2599
2600 memset(ep, 0, sizeof(coap_endpoint_t));
2601 ep->context = context;
2602 ep->proto = proto;
2603 ep->sock.endpoint = ep;
2604 if (proto < COAP_PROTO_LAST) {
2605 /*
2606 * Should be caught above, but come compilers realize that proto
2607 * includes COAP_PROTO_LAST, but there is no table entry for that
2608 */
2609 memcpy(&ep->sock.lfunc, coap_layers_coap[proto], sizeof(ep->sock.lfunc));
2610 }
2611
2612 if (COAP_PROTO_NOT_RELIABLE(proto)) {
2613 if (!coap_netif_dgrm_listen(ep, listen_addr))
2614 goto error;
2615#ifdef WITH_CONTIKI
2616 ep->sock.context = context;
2617#endif /* WITH_CONTIKI */
2618#if !COAP_DISABLE_TCP
2619 } else if (COAP_PROTO_RELIABLE(proto)) {
2620 if (!coap_netif_strm_listen(ep, listen_addr))
2621 goto error;
2622#endif /* !COAP_DISABLE_TCP */
2623 } else {
2624 coap_log_crit("coap_new_endpoint: Protocol type not supported %d\n", proto);
2625 goto error;
2626 }
2627
2629#ifndef INET6_ADDRSTRLEN
2630#define INET6_ADDRSTRLEN 40
2631#endif
2632 unsigned char addr_str[INET6_ADDRSTRLEN + 8];
2633
2634 if (coap_print_addr(&ep->bind_addr, addr_str, INET6_ADDRSTRLEN + 8)) {
2635 coap_log_debug("created %s endpoint %s\n", coap_proto_name(ep->proto),
2636 addr_str);
2637 }
2638 }
2639
2640 ep->default_mtu = COAP_DEFAULT_MTU;
2641
2642#ifdef COAP_EPOLL_SUPPORT
2643 ep->sock.endpoint = ep;
2644 coap_epoll_ctl_add(&ep->sock,
2645 EPOLLIN,
2646 __func__);
2647#endif /* COAP_EPOLL_SUPPORT */
2648
2649 LL_PREPEND(context->endpoint, ep);
2650 return ep;
2651
2652error:
2653 coap_free_endpoint_lkd(ep);
2654 return NULL;
2655}
2656
2657void
2659 ep->default_mtu = (uint16_t)mtu;
2660}
2661
2662COAP_API void
2664 if (ep) {
2665 coap_context_t *context = ep->context;
2666 if (context) {
2667 coap_lock_lock(return);
2668 }
2669 coap_free_endpoint_lkd(ep);
2670 if (context) {
2672 }
2673 }
2674}
2675
2676void
2677coap_free_endpoint_lkd(coap_endpoint_t *ep) {
2678 if (ep) {
2679 coap_session_t *session, *rtmp;
2680
2681 if (ep->context) {
2682 /* If fully allocated and inserted */
2684 SESSIONS_ITER_SAFE(ep->sessions, session, rtmp) {
2685 if (session->ref > 0) {
2687#if COAP_CLIENT_SUPPORT
2688 if (session->client_initiated) {
2689 coap_session_release_lkd(session);
2690 }
2691#endif /* COAP_CLIENT_SUPPORT */
2692 }
2693 assert(session->ref == 0);
2694 if (session->ref == 0) {
2696 coap_session_free(session);
2697 }
2698 }
2699 if (coap_netif_available_ep(ep)) {
2700 /*
2701 * ep->sock.endpoint is set in coap_new_endpoint().
2702 * ep->sock.session is never set.
2703 *
2704 * session->sock.session is set for both clients and servers (when a
2705 * new session is accepted), but does not affect the endpoint.
2706 *
2707 * So, it is safe to call coap_netif_close_ep() after all the sessions
2708 * have been freed above as we are only working with the endpoint sock.
2709 */
2710#ifdef COAP_EPOLL_SUPPORT
2711 assert(ep->sock.session == NULL);
2712#endif /* COAP_EPOLL_SUPPORT */
2714 }
2715
2716 if (ep->context->endpoint) {
2717 LL_DELETE(ep->context->endpoint, ep);
2718 }
2719 }
2720
2721 if (ep->app_cb) {
2722 coap_lock_callback(ep->app_cb(ep->app_data));
2723 }
2724
2725 coap_mfree_endpoint(ep);
2726 }
2727}
2728
2729void *
2731 assert(endpoint);
2732 return endpoint->app_data;
2733}
2734
2735COAP_API void *
2736coap_endpoint_set_app_data(coap_endpoint_t *endpoint, void *app_data,
2738 void *old_data;
2739
2740 coap_lock_lock(return NULL);
2741 old_data = coap_endpoint_set_app_data_lkd(endpoint, app_data, callback);
2743 return old_data;
2744}
2745
2746void *
2747coap_endpoint_set_app_data_lkd(coap_endpoint_t *endpoint, void *app_data,
2749 void *old_data = endpoint->app_data;
2750
2751 endpoint->app_data = app_data;
2752 endpoint->app_cb = app_data ? callback : NULL;
2753 return old_data;
2754}
2755
2756#endif /* COAP_SERVER_SUPPORT */
2757
2760 const coap_address_t *remote_addr,
2761 int ifindex) {
2762 coap_session_t *s, *rtmp;
2763#if COAP_CLIENT_SUPPORT
2764 SESSIONS_ITER(ctx->sessions, s, rtmp) {
2765 if (s->ifindex == ifindex) {
2766 if (s->sock.flags & COAP_SOCKET_MULTICAST) {
2767 if (coap_address_equals(&s->sock.mcast_addr, remote_addr))
2768 return s;
2769 } else if (coap_address_equals(&s->addr_info.remote, remote_addr))
2770 return s;
2771 }
2772 }
2773#endif /* COAP_CLIENT_SUPPORT */
2774#if COAP_SERVER_SUPPORT
2775 coap_endpoint_t *ep;
2776
2777 LL_FOREACH(ctx->endpoint, ep) {
2778 SESSIONS_ITER(ep->sessions, s, rtmp) {
2779 if (s->ifindex == ifindex && coap_address_equals(&s->addr_info.remote,
2780 remote_addr))
2781 return s;
2782 }
2783 }
2784#endif /* COAP_SERVER_SUPPORT */
2785 return NULL;
2786}
2787
2788#ifndef INET6_ADDRSTRLEN
2789#define INET6_ADDRSTRLEN 46
2790#endif
2791const char *
2793 static char szSession[2 * (INET6_ADDRSTRLEN + 8) + 24];
2794 char *p = szSession, *end = szSession + sizeof(szSession);
2795
2796 if (!session) {
2797 return "Session not defined";
2798 }
2799 if (coap_print_addr(&session->addr_info.local,
2800 (unsigned char *)p, end - p) > 0)
2801 p += strlen(p);
2802 if (p + 6 < end) {
2803 strcpy(p, " <-> ");
2804 p += 5;
2805 }
2806 if (p + 1 < end) {
2807 if (coap_print_addr(&session->addr_info.remote,
2808 (unsigned char *)p, end - p) > 0)
2809 p += strlen(p);
2810 }
2811 if (session->ifindex > 0 && p + 1 < end)
2812 p += snprintf(p, end - p, " (if%d)", session->ifindex);
2813 if (p + 6 < end) {
2814 strcpy(p, " ");
2815 p++;
2816 strcpy(p, coap_proto_name(session->proto));
2817 }
2818
2819 return szSession;
2820}
2821
2822#if COAP_SERVER_SUPPORT
2823const char *
2824coap_endpoint_str(const coap_endpoint_t *endpoint) {
2825 static char szEndpoint[128];
2826 char *p = szEndpoint, *end = szEndpoint + sizeof(szEndpoint);
2827 if (coap_print_addr(&endpoint->bind_addr, (unsigned char *)p, end - p) > 0)
2828 p += strlen(p);
2829 if (p + 6 < end) {
2830 if (endpoint->proto == COAP_PROTO_UDP) {
2831 strcpy(p, " UDP");
2832 } else if (endpoint->proto == COAP_PROTO_DTLS) {
2833 strcpy(p, " DTLS");
2834 } else {
2835 strcpy(p, " NONE");
2836 }
2837 }
2838
2839 return szEndpoint;
2840}
2841#endif /* COAP_SERVER_SUPPORT */
2842#if COAP_CLIENT_SUPPORT
2843void
2845 session->no_observe_cancel = 1;
2846}
2847
2848void
2850 if (session->type != COAP_SESSION_TYPE_CLIENT) {
2851 coap_lock_lock(return);
2853 coap_session_release_lkd(session);
2855 }
2856}
2857#endif /* COAP_CLIENT_SUPPORT */
2858#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 INET6_ADDRSTRLEN
Definition coap_debug.c:234
struct coap_lg_crcv_t coap_lg_crcv_t
struct coap_endpoint_t coap_endpoint_t
struct coap_cache_entry_t coap_cache_entry_t
struct coap_lg_srcv_t coap_lg_srcv_t
#define PRIuS
#define PRIu32
#define COAP_CLIENT_SUPPORT
coap_nack_reason_t
Definition coap_io.h:64
@ COAP_NACK_NOT_DELIVERABLE
Definition coap_io.h:66
@ COAP_NACK_WS_FAILED
Definition coap_io.h:73
@ COAP_NACK_TOO_MANY_RETRIES
Definition coap_io.h:65
@ COAP_NACK_TLS_FAILED
Definition coap_io.h:68
@ COAP_NACK_TLS_LAYER_FAILED
Definition coap_io.h:71
@ COAP_NACK_ICMP_ISSUE
Definition coap_io.h:69
@ COAP_NACK_WS_LAYER_FAILED
Definition coap_io.h:72
@ COAP_NACK_RST
Definition coap_io.h:67
@ COAP_NACK_BAD_RESPONSE
Definition coap_io.h:70
#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
#define COAP_SOCKET_WANT_CONNECT
non blocking client socket is waiting for connect
#define COAP_SOCKET_CAN_READ
non blocking socket can now read without blocking
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:45
@ COAP_STRING
Definition coap_mem.h:33
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:252
void * coap_dtls_get_tls(const coap_session_t *c_session COAP_UNUSED, coap_tls_library_t *tls_lib)
Definition coap_notls.c:298
unsigned int coap_dtls_get_overhead(coap_session_t *session COAP_UNUSED)
Definition coap_notls.c:396
int coap_dtls_context_check_keys_enabled(coap_context_t *ctx COAP_UNUSED)
Definition coap_notls.c:291
#define NULL
Definition coap_option.h:30
uint16_t coap_option_num_t
Definition coap_option.h:37
@ COAP_SIG_OPT_BLOCK_WISE_TRANSFER
@ COAP_SIG_OPT_EXTENDED_TOKEN_LENGTH
@ COAP_SIG_OPT_MAX_MESSAGE_SIZE
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)
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:1610
#define coap_check_update_token(a, b)
void coap_block_delete_lg_xmit(coap_session_t *session, coap_lg_xmit_t *lg_xmit)
Remove a lg_xmit.
#define COAP_BLOCK_FORCE_Q_BLOCK
Definition coap_block.h:73
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:149
#define COAP_TICKS_PER_SECOND
Use ms resolution on POSIX systems.
Definition coap_time.h:164
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:192
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:5324
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:206
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:1478
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:1358
void coap_add_to_head_delayq(coap_session_t *session, coap_queue_t *node)
This function adds the node to the head of the delayqueue.
Definition coap_net.c:3209
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:2097
coap_queue_t * coap_remove_first_from_delayq(coap_session_t *session)
This function removes the first node from the delayqueue.
Definition coap_net.c:3185
void coap_add_to_tail_delayq(coap_session_t *session, coap_queue_t *node)
This function adds the node to the tail of the delayqueue.
Definition coap_net.c:3198
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition coap_net.c:1384
coap_queue_t * coap_new_node(void)
Creates a new node suitable for adding to the CoAP sendqueue.
Definition coap_net.c:235
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:3326
int coap_remove_from_queue(coap_queue_t **queue, coap_session_t *session, coap_mid_t mid, coap_bin_const_t *token, coap_queue_t **node)
This function removes the element with given mid from the list given list.
Definition coap_net.c:3217
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:3365
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:53
void coap_dtls_establish(coap_session_t *session)
Layer function interface for layer below DTLS connect being established.
Definition coap_dtls.c:260
coap_session_t * coap_session_new_dtls_session(coap_session_t *session, coap_tick_t now)
Create a new DTLS session for the session.
#define COAP_DTLS_PKI_SETUP_VERSION
Latest PKI setup version.
Definition coap_dtls.h:312
#define COAP_DTLS_CPSK_SETUP_VERSION
Latest CPSK setup version.
Definition coap_dtls.h:413
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:71
unsigned int coap_encode_var_safe8(uint8_t *buf, size_t length, uint64_t val)
Encodes multiple-length byte sequences.
Definition coap_encode.c:81
@ COAP_EVENT_SESSION_CONNECTED
Triggered when TCP layer completes exchange of CSM information.
Definition coap_event.h:63
@ 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:57
@ COAP_EVENT_SESSION_FAILED
Triggered when TCP layer fails following exchange of CSM information.
Definition coap_event.h:67
@ 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:65
@ 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:55
@ COAP_EVENT_TCP_CONNECTED
Triggered when TCP layer connects.
Definition coap_event.h:53
@ 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:812
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.
void oscore_release_recipient_ctx(oscore_recipient_ctx_t **recipient_ctx)
Cleanup recipient context, including releasing the oscore context if the oscore context referenced is...
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:1760
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
Definition coap_pdu.c:197
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:474
#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_DEFAULT_MAX_PDU_RX_SIZE
#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:1622
#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:863
#define COAP_DEFAULT_PORT
Definition coap_pdu.h:39
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition coap_pdu.h:184
#define COAP_TOKEN_DEFAULT_MAX
Definition coap_pdu.h:58
coap_proto_t
CoAP protocol types Note: coap_layers_coap[] needs updating if extended.
Definition coap_pdu.h:234
#define COAPS_DEFAULT_PORT
Definition coap_pdu.h:40
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:104
#define COAP_INVALID_MID
Indicates an invalid message id.
Definition coap_pdu.h:187
#define COAP_DEFAULT_MTU
Definition coap_pdu.h:43
#define COAP_BERT_BASE
Definition coap_pdu.h:46
@ COAP_PROTO_WS
Definition coap_pdu.h:240
@ COAP_PROTO_DTLS
Definition coap_pdu.h:237
@ COAP_PROTO_UDP
Definition coap_pdu.h:236
@ COAP_PROTO_NONE
Definition coap_pdu.h:235
@ COAP_PROTO_TLS
Definition coap_pdu.h:239
@ COAP_PROTO_WSS
Definition coap_pdu.h:241
@ COAP_PROTO_TCP
Definition coap_pdu.h:238
@ COAP_PROTO_LAST
Definition coap_pdu.h:242
@ COAP_SIGNALING_CODE_CSM
Definition coap_pdu.h:287
@ COAP_SIGNALING_CODE_PING
Definition coap_pdu.h:288
@ COAP_EMPTY_CODE
Definition coap_pdu.h:249
@ COAP_MESSAGE_NON
Definition coap_pdu.h:72
@ COAP_MESSAGE_CON
Definition coap_pdu.h:71
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.
#define COAP_ACK_RANDOM_FACTOR(s)
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:1235
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_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.
int coap_session_is_oscore(const coap_session_t *session)
Check if the session is using OSCORE.
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:130
void coap_delete_str_const(coap_str_const_t *s)
Deletes the given const string and releases any memory allocated.
Definition coap_str.c:65
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:119
#define coap_binary_equal(binary1, binary2)
Compares the two binary data for equality.
Definition coap_str.h:222
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:55
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:936
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:941
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:58
coap_address_t local
local address and port
Definition coap_io.h:59
Multi-purpose address abstraction.
CoAP binary data definition with const data.
Definition coap_str.h:65
size_t length
length of binary data
Definition coap_str.h:66
const uint8_t * s
read-only binary data
Definition coap_str.h:67
The CoAP stack's global state is stored in a coap_context_t object.
uint64_t rl_ticks_per_packet
If not 0, rate limit NON to ticks per packet.
coap_nack_handler_t nack_cb
Called when a response issue has occurred.
uint32_t csm_max_message_size
Value for CSM Max-Message-Size.
coap_queue_t * sendqueue
uint32_t max_token_size
Largest token size supported RFC8974.
uint32_t block_mode
Zero or more COAP_BLOCK_ or'd options.
coap_bin_const_t key
Definition coap_dtls.h:389
coap_bin_const_t identity
Definition coap_dtls.h:388
The structure used for defining the Client PSK setup data to be used.
Definition coap_dtls.h:418
char * client_sni
If not NULL, SNI to use in client TLS setup.
Definition coap_dtls.h:445
coap_dtls_cpsk_info_t psk_info
Client PSK definition.
Definition coap_dtls.h:451
The structure used for defining the PKI setup data to be used.
Definition coap_dtls.h:317
uint8_t version
Definition coap_dtls.h:318
char * client_sni
If not NULL, SNI to use in client TLS setup.
Definition coap_dtls.h:376
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) 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,...
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
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
coap_mid_t last_resp_mid
The last response mid that has been been processed.
uint64_t tx_token
Next token number to use.
uint8_t csm_bert_loc_support
CSM TCP BERT blocks supported (local).
coap_addr_tuple_t addr_info
remote/local address info
coap_proto_t proto
protocol used
uint16_t tx_mid
the last message id that was used in this session
uint8_t is_dtls13
Set if session is DTLS1.3.
unsigned ref
reference count from queues
size_t csm_rcv_mtu
CSM mtu (rcv).
coap_response_t last_con_handler_res
The result of calling the response handler of the last CON.
coap_bin_const_t * psk_hint
If client, this field contains the server provided identity hint.
coap_bin_const_t * last_token
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_fixed_point_t ack_timeout
timeout waiting for ack (default 2.0 secs)
uint64_t rl_ticks_per_packet
If not 0, rate limit NON to ticks per packet.
coap_fixed_point_t default_leisure
Mcast leisure time (default 5.0 secs).
coap_session_type_t type
client or server side socket
uint32_t probing_rate
Max transfer wait when remote is not responding (default 1 byte/sec).
coap_context_t * context
session's context
size_t partial_write
if > 0 indicates number of bytes already written from the pdu at the head of sendqueue
coap_addr_hash_t addr_hash
Address hash for server incoming packets.
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_socket_flags_t flags
1 or more of COAP_SOCKET* flag values
CoAP string data definition with const data.
Definition coap_str.h:47
const uint8_t * s
read-only string data
Definition coap_str.h:49
size_t length
length of string
Definition coap_str.h:48