libcoap 4.3.5-develop-e2463f0
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;
517 session->max_token_size = context->max_token_size; /* RFC8974 */
518 if (session->type != COAP_SESSION_TYPE_CLIENT)
520
521 /* Randomly initialize */
522 /* TCP/TLS have no notion of mid */
523 if (COAP_PROTO_NOT_RELIABLE(session->proto))
524 coap_prng_lkd((unsigned char *)&session->tx_mid, sizeof(session->tx_mid));
525 coap_prng_lkd((unsigned char *)&session->tx_rtag, sizeof(session->tx_rtag));
526
527 return session;
528}
529
530void
532 coap_queue_t *q, *tmp;
533 coap_lg_xmit_t *lq, *ltmp;
534
535#if COAP_PROXY_SUPPORT
536 if (session->ref_proxy_subs)
537 coap_delete_proxy_subscriber(session, NULL, 0, COAP_PROXY_SUBS_ALL);
538#endif /* COAP_PROXY_SUPPORT */
539#if COAP_CLIENT_SUPPORT
540 coap_lg_crcv_t *lg_crcv, *etmp;
541
542 /* Need to do this before (D)TLS and socket is closed down */
543 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
544 if (lg_crcv->observe_set && session->no_observe_cancel == 0) {
545 /* Need to close down observe */
546 if (coap_cancel_observe_lkd(session, lg_crcv->app_token, COAP_MESSAGE_NON)) {
547 /* Need to delete node we set up for NON */
548 coap_queue_t *queue = session->context->sendqueue;
549
550 while (queue) {
551 if (queue->session == session) {
553 break;
554 }
555 queue = queue->next;
556 }
557 }
558 }
559 /* In case coap_cancel_observe_lkd() failure, which could clear down lg_crcv */
560 if (!session->lg_crcv)
561 break;
562 LL_DELETE(session->lg_crcv, lg_crcv);
563 coap_block_delete_lg_crcv(session, lg_crcv);
564 }
565#endif /* COAP_CLIENT_SUPPORT */
566
567 LL_FOREACH_SAFE(session->delayqueue, q, tmp) {
568 if (q->pdu->type==COAP_MESSAGE_CON) {
569 coap_handle_nack(session, q->pdu,
570 session->proto == COAP_PROTO_DTLS ?
572 q->id);
573 }
575 }
576
577#if COAP_CLIENT_SUPPORT
578 coap_pdu_t *p, *ptmp;
579
580 LL_FOREACH_SAFE(session->doing_first_pdu, p, ptmp) {
581 if (p->type==COAP_MESSAGE_CON) {
582 coap_handle_nack(session, p,
583 session->proto == COAP_PROTO_DTLS ?
585 p->mid);
586 }
588 }
589#endif /* COAP_CLIENT_SUPPORT */
590
591 if (session->partial_pdu)
593 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
594 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
595 if (session->psk_identity)
597 if (session->psk_key)
599 if (session->psk_hint)
601
602#if COAP_SERVER_SUPPORT
603 coap_cache_entry_t *cp, *ctmp;
604 HASH_ITER(hh, session->context->cache, cp, ctmp) {
605 /* cp->session is NULL if not session based */
606 if (cp->session == session) {
607 coap_delete_cache_entry(session->context, cp);
608 }
609 }
610#endif /* COAP_PROXY_SUPPORT */
611 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
612 LL_DELETE(session->lg_xmit, lq);
613 coap_block_delete_lg_xmit(session, lq);
614 }
615#if COAP_SERVER_SUPPORT
616 coap_lg_srcv_t *sq, *stmp;
617
618 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
619 LL_DELETE(session->lg_srcv, sq);
620 coap_block_delete_lg_srcv(session, sq);
621 }
622#endif /* COAP_SERVER_SUPPORT */
623#if COAP_OSCORE_SUPPORT
625 oscore_release_recipient_ctx(&session->recipient_ctx);
626 coap_delete_str_const(session->b_2_retransmit_token);
627#endif /* COAP_OSCORE_SUPPORT */
628#if COAP_WS_SUPPORT
629 coap_free_type(COAP_STRING, session->ws);
630 coap_delete_str_const(session->ws_host);
631#endif /* COAP_WS_SUPPORT */
632}
633
634void
636 if (!session)
637 return;
639 assert(session->ref == 0);
640 if (session->ref)
641 return;
642 /* Make sure nothing gets deleted under our feet */
644 coap_session_mfree(session);
645#if COAP_SERVER_SUPPORT
646 coap_delete_bin_const(session->client_cid);
647 if (session->endpoint) {
648 if (session->endpoint->sessions)
649 SESSIONS_DELETE(session->endpoint->sessions, session);
650 } else
651#endif /* COAP_SERVER_SUPPORT */
652#if COAP_CLIENT_SUPPORT
653 if (session->context) {
654 if (session->context->sessions)
655 SESSIONS_DELETE(session->context->sessions, session);
656 }
657 coap_delete_bin_const(session->req_token);
658#endif /* COAP_CLIENT_SUPPORT */
660 coap_delete_bin_const(session->echo);
661#if COAP_SERVER_SUPPORT
662 coap_delete_pdu_lkd(session->cached_pdu);
663#endif /* COAP_SERVER_SUPPORT */
664
665 if (session->app_cb) {
666 coap_lock_callback(session->app_cb(session->app_data));
667 }
668 coap_log_debug("***%s: session %p: closed\n", coap_session_str(session),
669 (void *)session);
670 assert(session->ref == 1);
672}
673
674#if COAP_SERVER_SUPPORT
675void
677 int i;
678
681 coap_cancel_all_messages(session->context, session, NULL);
682 RESOURCES_ITER(session->context->resources, r) {
683 /* In case code is broken somewhere */
684 for (i = 0; i < 1000; i++) {
685 if (!coap_delete_observer(r, session, NULL))
686 break;
687 }
688 }
689 if (session->context->unknown_resource) {
690 /* In case code is broken somewhere */
691 for (i = 0; i < 1000; i++) {
692 if (!coap_delete_observer(session->context->unknown_resource, session, NULL))
693 break;
694 }
695 }
696 if (session->context->proxy_uri_resource) {
697 /* In case code is broken somewhere */
698 for (i = 0; i < 1000; i++) {
699 if (!coap_delete_observer(session->context->proxy_uri_resource, session, NULL))
700 break;
701 }
702 }
703 while (session->delayqueue) {
704 coap_queue_t *q = session->delayqueue;
705
706 session->delayqueue = q->next;
708 }
709 /* Force session to go away */
712
714}
715#endif /* COAP_SERVER_SUPPORT */
716
717static size_t
719 size_t max_with_header) {
720#if COAP_DISABLE_TCP
721 (void)session;
722 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
723 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
724 : 0;
725#else /* !COAP_DISABLE_TCP */
726 if (COAP_PROTO_NOT_RELIABLE(session->proto))
727 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
728 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
729 : 0;
730 /* we must assume there is no token to be on the safe side */
731 if (max_with_header <= 2)
732 return 0;
733 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP0 + 2)
734 return max_with_header - 2;
735 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP8 + 3)
736 return max_with_header - 3;
737 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP16 + 4)
738 return max_with_header - 4;
739 else
740 return max_with_header - COAP_PDU_MAX_TCP_HEADER_SIZE;
741#endif /* !COAP_DISABLE_TCP */
742}
743
744size_t
746 if (session->csm_rcv_mtu)
748 (size_t)(session->csm_rcv_mtu));
749
751 (size_t)(session->mtu - session->tls_overhead));
752}
753
754COAP_API size_t
756 size_t size;
757 coap_session_t *session_rw;
758
759 /*
760 * Need to do this to not get a compiler warning about const parameters
761 * but need to maintain source code backward compatibility
762 */
763 memcpy(&session_rw, &session, sizeof(session_rw));
764 coap_lock_lock(return 0);
765 size = coap_session_max_pdu_size_lkd(session_rw);
767 return size;
768}
769
770size_t
772 size_t max_with_header;
773
775#if COAP_CLIENT_SUPPORT
776 if (COAP_PROTO_RELIABLE(session->proto) &&
777 session->type == COAP_SESSION_TYPE_CLIENT &&
778 session->doing_first) {
779 /*
780 * Delay if session->doing_first is set.
781 * E.g. Reliable and CSM not in yet for checking block support
782 */
783 coap_session_t *session_rw;
784
785 /*
786 * Need to do this to not get a compiler warning about const parameters
787 * but need to maintain source code backward compatibility
788 */
789 memcpy(&session_rw, &session, sizeof(session_rw));
790 if (coap_client_delay_first(session_rw) == 0) {
791 coap_log_debug("coap_client_delay_first: timeout\n");
792 /* Have to go with the defaults */
793 }
794 }
795#endif /* COAP_CLIENT_SUPPORT */
796
797 max_with_header = (size_t)(session->mtu - session->tls_overhead);
798
799 return coap_session_max_pdu_size_internal(session, max_with_header);
800}
801
802void
803coap_session_set_mtu(coap_session_t *session, unsigned mtu) {
806 coap_log_debug("* %s: Restricting MTU size to %u\n",
807 coap_session_str(session), mtu);
808 }
809 if (mtu < 64)
810 mtu = 64;
811 session->mtu = mtu;
812 if (session->tls_overhead >= session->mtu) {
813 session->tls_overhead = session->mtu;
814 coap_log_err("DTLS overhead exceeds MTU\n");
815 }
816}
817
818ssize_t
820 coap_queue_t *node) {
821 if (node) {
822 coap_queue_t *removed = NULL;
823 /* Nodes are per ID, no notion of token */
824 coap_remove_from_queue(&session->context->sendqueue, session, node->id,
825 NULL, &removed);
826 assert(removed == node);
827 /* reuse node */
829 node->session = NULL;
830 node->t = 0;
831 } else {
832 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
833 coap_queue_t *q = NULL;
834 /* Check same mid is not getting re-used in violation of RFC7252 */
835 LL_FOREACH(session->delayqueue, q) {
836 if (q->id == pdu->mid) {
837 coap_log_err("** %s: mid=0x%04x: already in-use - dropped\n",
838 coap_session_str(session), pdu->mid);
839 return COAP_INVALID_MID;
840 }
841 }
842 }
843 node = coap_new_node();
844 if (node == NULL)
845 return COAP_INVALID_MID;
846 node->id = pdu->mid;
847 node->pdu = pdu;
848 if (pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
849 uint8_t r;
850 coap_prng_lkd(&r, sizeof(r));
851 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
852 node->timeout = coap_calc_timeout(session, r);
853 }
854 coap_address_copy(&node->remote, &session->addr_info.remote);
855 }
856 LL_APPEND(session->delayqueue, node);
858 coap_log_debug("** %s: mid=0x%04x: delayed\n",
859 coap_session_str(session), node->id);
860 return COAP_PDU_DELAYED;
861}
862
863#if !COAP_DISABLE_TCP
864void
866 coap_pdu_t *pdu;
867 uint8_t buf[4];
868 assert(COAP_PROTO_RELIABLE(session->proto));
869 coap_log_debug("***%s: sending CSM\n", coap_session_str(session));
870 session->state = COAP_SESSION_STATE_CSM;
871 session->partial_write = 0;
872 if (session->mtu == 0)
873 coap_session_set_mtu(session, COAP_DEFAULT_MTU); /* base value */
875 if (pdu == NULL
877 coap_encode_var_safe(buf, sizeof(buf),
878 session->context->csm_max_message_size), buf) == 0
880 coap_encode_var_safe(buf, sizeof(buf),
881 0), buf) == 0
882 || (session->max_token_size > COAP_TOKEN_DEFAULT_MAX &&
885 coap_encode_var_safe(buf, sizeof(buf),
886 session->max_token_size),
887 buf) == 0)
888 || coap_pdu_encode_header(pdu, session->proto) == 0
889 ) {
891 } else {
892 ssize_t bytes_written;
893
894 pdu->session = session;
895 bytes_written = coap_session_send_pdu(session, pdu);
896 if (bytes_written != (ssize_t)pdu->used_size + pdu->hdr_size) {
898 } else {
899 session->csm_rcv_mtu = session->context->csm_max_message_size;
900 if (session->csm_rcv_mtu > COAP_BERT_BASE)
901 session->csm_bert_loc_support = 1;
902 else
903 session->csm_bert_loc_support = 0;
904 }
905 }
906 if (pdu)
908}
909#endif /* !COAP_DISABLE_TCP */
910
913 coap_mid_t mid;
914
916 mid = coap_session_send_ping_lkd(session);
917 if (mid != COAP_INVALID_MID) {
918 coap_tick_t now;
919
920 coap_ticks(&now);
921 session->last_ping_mid = mid;
922 session->last_rx_tx = now;
923 session->last_ping = now;
924 }
926 return mid;
927}
928
931 coap_pdu_t *ping = NULL;
932
934 if (session->state != COAP_SESSION_STATE_ESTABLISHED ||
935 session->con_active)
936 return COAP_INVALID_MID;
937 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
938 uint16_t mid = coap_new_message_id_lkd(session);
939 ping = coap_pdu_init(COAP_MESSAGE_CON, 0, mid, 0);
940 }
941#if !COAP_DISABLE_TCP
942 else {
944 }
945#endif /* !COAP_DISABLE_TCP */
946 if (!ping)
947 return COAP_INVALID_MID;
948 return coap_send_internal(session, ping, NULL);
949}
950
951void
953 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
954 coap_log_debug("***%s: session connected\n",
955 coap_session_str(session));
956 if (session->state == COAP_SESSION_STATE_CSM) {
958#if COAP_CLIENT_SUPPORT
960 coap_reset_doing_first(session);
961#endif /* COAP_CLIENT_SUPPORT */
962 }
963 }
964
966 session->partial_write = 0;
967
968 if (session->proto==COAP_PROTO_DTLS) {
969 session->tls_overhead = coap_dtls_get_overhead(session);
970 if (session->tls_overhead >= session->mtu) {
971 session->tls_overhead = session->mtu;
972 coap_log_err("DTLS overhead exceeds MTU\n");
973 }
974 }
975
976 while (session->delayqueue && session->state == COAP_SESSION_STATE_ESTABLISHED) {
977 ssize_t bytes_written;
978 coap_queue_t *q = session->delayqueue;
979 coap_address_t remote;
980
981 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
982 if (session->con_active >= COAP_NSTART(session))
983 break;
984 session->con_active++;
985 }
986 /* Take entry off the queue */
987 session->delayqueue = q->next;
988 q->next = NULL;
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 q->next = session->delayqueue;
1008 session->delayqueue = q;
1009 if (bytes_written > 0)
1010 session->partial_write = (size_t)bytes_written;
1011 break;
1012 } else {
1014 }
1015 }
1016 }
1017}
1018
1019#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
1020static const char *
1022 switch (reason) {
1024 return "COAP_NACK_TOO_MANY_RETRIES";
1026 return "COAP_NACK_NOT_DELIVERABLE";
1027 case COAP_NACK_RST:
1028 return "COAP_NACK_RST";
1030 return "COAP_NACK_TLS_FAILED";
1032 return "COAP_NACK_ICMP_ISSUE";
1034 return "COAP_NACK_BAD_RESPONSE";
1036 return "COAP_NACK_TLS_LAYER_FAILED";
1038 return "COAP_NACK_WS_LAYER_FAILED";
1040 return "COAP_NACK_WS_FAILED";
1041 default:
1042 return "???";
1043 }
1044}
1045#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
1046
1047void
1049 coap_pdu_t *sent,
1050 const coap_nack_reason_t reason,
1051 const coap_mid_t mid) {
1052 if (session->context->nack_cb
1054 && !session->doing_first_pdu
1055#endif /* COAP_CLIENT_SUPPORT */
1056 ) {
1057 coap_bin_const_t token = {0, NULL};
1058
1059 if (sent) {
1060 coap_check_update_token(session, sent);
1061 token = sent->actual_token;
1062 }
1063 coap_lock_callback(session->context->nack_cb(session, sent, reason, mid));
1064 if (sent) {
1065 coap_update_token(sent, token.length, token.s);
1066 }
1067 }
1068#if COAP_CLIENT_SUPPORT
1069 if (reason != COAP_NACK_ICMP_ISSUE) {
1070 session->doing_send_recv = 0;
1071 }
1072#endif /* COAP_CLIENT_SUPPORT */
1073}
1074
1075COAP_API void
1081
1082void
1084#if !COAP_DISABLE_TCP
1085 coap_session_state_t state = session->state;
1086#endif /* !COAP_DISABLE_TCP */
1087 coap_lg_xmit_t *lq, *ltmp;
1088#if COAP_SERVER_SUPPORT
1089 coap_lg_srcv_t *sq, *stmp;
1090#endif /* COAP_SERVER_SUPPORT */
1091#if COAP_CLIENT_SUPPORT
1092 coap_lg_crcv_t *cq, *etmp;
1093#endif /* COAP_CLIENT_SUPPORT */
1094 int sent_nack = 0;
1095 coap_queue_t *q;
1096
1098#if COAP_CLIENT_SUPPORT
1099 coap_session_failed(session);
1100#endif /* COAP_CLIENT_SUPPORT */
1101
1102 q = session->context->sendqueue;
1103 while (q) {
1104 if (q->session == session) {
1105 /* Take the first one */
1106 coap_handle_nack(session, q->pdu, reason, q->id);
1107 sent_nack = 1;
1108 break;
1109 }
1110 q = q->next;
1111 }
1112
1113 if (reason != COAP_NACK_ICMP_ISSUE
1115 || session->session_failed
1116#endif /* COAP_CLIENT_SUPPORT */
1117 ) {
1118 while (session->delayqueue) {
1119 q = session->delayqueue;
1120 session->delayqueue = q->next;
1121 q->next = NULL;
1122 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1123 coap_session_str(session), q->id);
1124 if (q->pdu->type == COAP_MESSAGE_CON) {
1125 coap_handle_nack(session, q->pdu, reason, q->id);
1126 sent_nack = 1;
1127 }
1128
1129#if COAP_CLIENT_SUPPORT
1130 session->doing_send_recv = 0;
1131#endif /* COAP_CLIENT_SUPPORT */
1133 }
1134 }
1135#if COAP_CLIENT_SUPPORT
1136 if (!sent_nack && session->lg_crcv) {
1137 /* Take the first one */
1138 coap_handle_nack(session, session->lg_crcv->sent_pdu, reason,
1139 session->lg_crcv->sent_pdu->mid);
1140 sent_nack = 1;
1141 }
1142#endif /* COAP_CLIENT_SUPPORT */
1143 if (!sent_nack) {
1144 /* Unable to determine which request disconnection was for */
1145 coap_handle_nack(session, NULL, reason, 0);
1146 }
1147 if (reason == COAP_NACK_ICMP_ISSUE) {
1148 coap_log_debug("***%s: session ICMP issue (%s)\n",
1149 coap_session_str(session), coap_nack_name(reason));
1150 return;
1151 }
1152 coap_log_debug("***%s: session disconnected (%s)\n",
1153 coap_session_str(session), coap_nack_name(reason));
1154#if COAP_SERVER_SUPPORT
1155 coap_delete_observers(session->context, session);
1156#endif /* COAP_SERVER_SUPPORT */
1157
1158 if (session->proto == COAP_PROTO_UDP)
1160 else
1161 session->state = COAP_SESSION_STATE_NONE;
1162
1163 session->con_active = 0;
1164
1165 if (session->partial_pdu) {
1167 session->partial_pdu = NULL;
1168 }
1169 session->partial_read = 0;
1170
1171 /* Not done if nack handler called above */
1172 while (session->delayqueue) {
1173 q = session->delayqueue;
1174 session->delayqueue = q->next;
1175 q->next = NULL;
1176 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1177 coap_session_str(session), q->id);
1178#if COAP_CLIENT_SUPPORT
1179 session->doing_send_recv = 0;
1180#endif /* COAP_CLIENT_SUPPORT */
1182 }
1183
1184#if COAP_CLIENT_SUPPORT
1185 if (!session->session_failed) {
1186 /* Need to do this before (D)TLS and socket is closed down */
1187 LL_FOREACH_SAFE(session->lg_crcv, cq, etmp) {
1188 LL_DELETE(session->lg_crcv, cq);
1189 coap_block_delete_lg_crcv(session, cq);
1190 }
1191 }
1192#endif /* COAP_CLIENT_SUPPORT */
1193 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
1194 LL_DELETE(session->lg_xmit, lq);
1195 coap_block_delete_lg_xmit(session, lq);
1196 }
1197#if COAP_SERVER_SUPPORT
1198 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
1199 LL_DELETE(session->lg_srcv, sq);
1200 coap_block_delete_lg_srcv(session, sq);
1201 }
1202#endif /* COAP_SERVER_SUPPORT */
1203 coap_cancel_session_messages(session->context, session, reason);
1204
1205#if !COAP_DISABLE_TCP
1206 if (COAP_PROTO_RELIABLE(session->proto)) {
1207 if (coap_netif_available(session)) {
1211 }
1212#if COAP_CLIENT_SUPPORT
1213 if (state != COAP_SESSION_STATE_NONE && !session->session_failed) {
1217 }
1218 coap_reset_doing_first(session);
1219#endif /* COAP_CLIENT_SUPPORT */
1220 }
1221#endif /* !COAP_DISABLE_TCP */
1222 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1223 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1224}
1225
1226#if COAP_CLIENT_SUPPORT
1227void
1229 if (session->context->reconnect_time && session->client_initiated) {
1230 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1231 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1232 session->session_failed = 1;
1234 session->retry_count++;
1235 if (session->context->retry_count && session->retry_count >= session->context->retry_count) {
1237 if (session->type != COAP_SESSION_TYPE_CLIENT) {
1239 coap_session_release_lkd(session);
1240 }
1241 }
1242 coap_ticks(&session->last_rx_tx);
1243 }
1244}
1245#endif /* COAP_CLIENT_SUPPORT */
1246
1247#if COAP_SERVER_SUPPORT
1248static void
1249coap_make_addr_hash(coap_addr_hash_t *addr_hash, coap_proto_t proto,
1250 const coap_addr_tuple_t *addr_info) {
1251 memset(addr_hash, 0, sizeof(coap_addr_hash_t));
1252 coap_address_copy(&addr_hash->remote, &addr_info->remote);
1253 addr_hash->lport = coap_address_get_port(&addr_info->local);
1254 addr_hash->proto = proto;
1255}
1256
1257/* Aids debugging when session is created */
1258static coap_session_t *debug_session;
1259
1261coap_endpoint_get_session(coap_endpoint_t *endpoint,
1262 const coap_packet_t *packet, coap_tick_t now) {
1263 coap_session_t *session;
1264 coap_session_t *rtmp;
1265 unsigned int num_idle = 0;
1266 unsigned int num_hs = 0;
1267 coap_session_t *oldest = NULL;
1268 coap_session_t *oldest_hs = NULL;
1269 coap_addr_hash_t addr_hash;
1270
1271 coap_make_addr_hash(&addr_hash, endpoint->proto, &packet->addr_info);
1272 SESSIONS_FIND(endpoint->sessions, addr_hash, session);
1273 if (session) {
1274 /* Maybe mcast or unicast IP address which is not in the hash */
1275 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1276 session->ifindex = packet->ifindex;
1277 session->last_rx_tx = now;
1278 return session;
1279 }
1280
1281#if COAP_CLIENT_SUPPORT
1282 SESSIONS_FIND(endpoint->context->sessions, addr_hash, session);
1283 if (session) {
1284 /* Maybe mcast or unicast IP address which is not in the hash */
1285 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1286 session->ifindex = packet->ifindex;
1287 session->last_rx_tx = now;
1288 return session;
1289 }
1290
1291 if (coap_is_mcast(&packet->addr_info.local)) {
1292 /* Check if this a proxy client packet we sent on another socket */
1293 SESSIONS_ITER(endpoint->context->sessions, session, rtmp) {
1294 if (coap_address_equals(&session->addr_info.remote, &packet->addr_info.local) &&
1297 /* Drop looped back packet to stop recursion / confusion */
1298 return NULL;
1299 }
1300 }
1301 }
1302#endif /* COAP_CLIENT_SUPPORT */
1303 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1304 if (session->ref == 0 && session->delayqueue == NULL &&
1305 session->lg_srcv == NULL && session->lg_xmit == NULL) {
1306 if (
1308 !(session->client_initiated && endpoint->context->reconnect_time) &&
1309#endif /* COAP_CLIENT_SUPPORT */
1310 session->type == COAP_SESSION_TYPE_SERVER) {
1311 ++num_idle;
1312 if (oldest==NULL || session->last_rx_tx < oldest->last_rx_tx)
1313 oldest = session;
1314
1315 if (session->state == COAP_SESSION_STATE_HANDSHAKE) {
1316 ++num_hs;
1317 /* See if this is a partial (D)TLS session set up
1318 which needs to be cleared down to prevent DOS */
1319 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1320 if (oldest_hs == NULL ||
1321 session->last_rx_tx < oldest_hs->last_rx_tx)
1322 oldest_hs = session;
1323 }
1324 }
1325 } else if (session->type == COAP_SESSION_TYPE_HELLO) {
1326 ++num_hs;
1327 /* See if this is a partial (D)TLS session set up for Client Hello
1328 which needs to be cleared down to prevent DOS */
1329 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1330 if (oldest_hs == NULL ||
1331 session->last_rx_tx < oldest_hs->last_rx_tx)
1332 oldest_hs = session;
1333 }
1334 }
1335 }
1336 }
1337
1338 if (endpoint->context->max_idle_sessions > 0 &&
1339 num_idle >= endpoint->context->max_idle_sessions) {
1341 coap_session_free(oldest);
1342 } else if (oldest_hs) {
1343 coap_log_warn("***%s: Incomplete session timed out\n",
1344 coap_session_str(oldest_hs));
1346 coap_session_free(oldest_hs);
1347 }
1348
1349 if (num_hs > (endpoint->context->max_handshake_sessions ?
1350 endpoint->context->max_handshake_sessions :
1352 /* Maxed out on number of sessions in (D)TLS negotiation state */
1353 coap_log_debug("Oustanding sessions in COAP_SESSION_STATE_HANDSHAKE too "
1354 "large. New request ignored\n");
1355 return NULL;
1356 }
1357
1358 if (endpoint->proto == COAP_PROTO_DTLS) {
1359 /*
1360 * Need to check that this actually is a Client Hello before wasting
1361 * time allocating and then freeing off session.
1362 */
1363
1364 /*
1365 * Generic header structure of the DTLS record layer.
1366 * typedef struct __attribute__((__packed__)) {
1367 * uint8_t content_type; content type of the included message
1368 * uint16_t version; Protocol version
1369 * uint16_t epoch; counter for cipher state changes
1370 * uint8_t sequence_number[6]; sequence number
1371 * uint16_t length; length of the following fragment
1372 * uint8_t handshake; If content_type == DTLS_CT_HANDSHAKE
1373 * } dtls_record_handshake_t;
1374 */
1375#define OFF_CONTENT_TYPE 0 /* offset of content_type in dtls_record_handshake_t */
1376#define DTLS_CT_ALERT 21 /* Content Type Alert */
1377#define DTLS_CT_HANDSHAKE 22 /* Content Type Handshake */
1378#define OFF_HANDSHAKE_TYPE 13 /* offset of handshake in dtls_record_handshake_t */
1379#define DTLS_HT_CLIENT_HELLO 1 /* Client Hello handshake type */
1380#define DTLS_CT_CID 25 /* Content Type Connection ID */
1381#define OFF_CID 11 /* offset of CID in dtls_record_handshake_t */
1382#define OFF_CID_DTLS13 1 /* offset of CID in DTLS1.3 Unified Header */
1383
1384 const uint8_t *payload = (const uint8_t *)packet->payload;
1385 size_t length = packet->length;
1386 if (length < (OFF_HANDSHAKE_TYPE + 1)) {
1387 coap_log_debug("coap_dtls_hello: ContentType %d Short Packet (%" PRIuS " < %d) dropped\n",
1388 payload[OFF_CONTENT_TYPE], length,
1389 OFF_HANDSHAKE_TYPE + 1);
1390 return NULL;
1391 }
1392 if ((payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 ||
1393 payload[OFF_CONTENT_TYPE] == DTLS_CT_CID) {
1394 /* Client may have changed its IP address */
1395 int changed = 0;
1396
1397 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1398 if (session->client_cid) {
1399 if ((session->is_dtls13 && (payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 &&
1400 length > (OFF_CID_DTLS13 + session->client_cid->length) &&
1401 memcmp(session->client_cid->s, &payload[OFF_CID_DTLS13],
1402 session->client_cid->length) == 0) ||
1403 (!session->is_dtls13 && payload[OFF_CONTENT_TYPE] == DTLS_CT_CID &&
1404 length > (OFF_CID + session->client_cid->length) &&
1405 memcmp(session->client_cid->s, &payload[OFF_CID],
1406 session->client_cid->length) == 0)) {
1407 /* Updating IP address */
1408 coap_log_info("***%s: CID: Old Client Session\n", coap_session_str(session));
1409 SESSIONS_DELETE(endpoint->sessions, session);
1410 session->addr_info = packet->addr_info;
1411 memcpy(&session->addr_hash, &addr_hash, sizeof(session->addr_hash));
1412 SESSIONS_ADD(endpoint->sessions, session);
1413 coap_log_info("***%s: CID: New Client Session\n", coap_session_str(session));
1414 return session;
1415 }
1416 }
1417 }
1418 if (!changed) {
1419 coap_log_debug("coap_dtls_hello: ContentType Connection-IS dropped\n");
1420 return NULL;
1421 }
1422 } else if (payload[OFF_CONTENT_TYPE] != DTLS_CT_HANDSHAKE ||
1423 payload[OFF_HANDSHAKE_TYPE] != DTLS_HT_CLIENT_HELLO) {
1424 /* only log if not a late alert */
1425 if (payload[OFF_CONTENT_TYPE] != DTLS_CT_ALERT)
1426 coap_log_debug("coap_dtls_hello: ContentType %d Handshake %d dropped\n",
1427 payload[OFF_CONTENT_TYPE],
1428 payload[OFF_HANDSHAKE_TYPE]);
1429 return NULL;
1430 }
1431 }
1432
1433 session = coap_make_session(endpoint->proto, COAP_SESSION_TYPE_SERVER,
1434 &addr_hash, &packet->addr_info.local,
1435 &packet->addr_info.remote,
1436 packet->ifindex, endpoint->context, endpoint);
1437 /* Aids debugging endpoint created session */
1438 debug_session = session;
1439 if (session) {
1440 session->last_rx_tx = now;
1441 memcpy(session->sock.lfunc, endpoint->sock.lfunc,
1442 sizeof(session->sock.lfunc));
1443 if (endpoint->proto == COAP_PROTO_UDP)
1445 else if (endpoint->proto == COAP_PROTO_DTLS) {
1446 session->type = COAP_SESSION_TYPE_HELLO;
1447 }
1448 SESSIONS_ADD(endpoint->sessions, session);
1449 coap_log_debug("***%s: session %p: new incoming session\n",
1450 coap_session_str(session), (void *)session);
1452 }
1453 return session;
1454}
1455
1458 coap_tick_t now) {
1459 if (session) {
1460 session->last_rx_tx = now;
1461 session->type = COAP_SESSION_TYPE_SERVER;
1462 coap_dtls_establish(session);
1463 }
1464 return session;
1465}
1466#endif /* COAP_SERVER_SUPPORT */
1467
1468#if COAP_CLIENT_SUPPORT
1469static coap_session_t *
1470coap_session_create_client(coap_context_t *ctx,
1471 const coap_address_t *local_if,
1472 const coap_address_t *server,
1473 coap_proto_t proto,
1474 void *app_data,
1476 coap_str_const_t *ws_host) {
1477 coap_session_t *session = NULL;
1478 int default_port = COAP_DEFAULT_PORT;
1479
1480 assert(server);
1481
1482 switch (proto) {
1483 case COAP_PROTO_UDP:
1484 default_port = COAP_DEFAULT_PORT;
1485 break;
1486 case COAP_PROTO_DTLS:
1487 if (!coap_dtls_is_supported()) {
1488 coap_log_crit("coap_new_client_session*: DTLS not supported\n");
1489 return NULL;
1490 }
1491 default_port = COAPS_DEFAULT_PORT;
1492 break;
1493 case COAP_PROTO_TCP:
1494 if (!coap_tcp_is_supported()) {
1495 coap_log_crit("coap_new_client_session*: TCP not supported\n");
1496 return NULL;
1497 }
1498 default_port = COAP_DEFAULT_PORT;
1499 break;
1500 case COAP_PROTO_TLS:
1501 if (!coap_tls_is_supported()) {
1502 coap_log_crit("coap_new_client_session*: TLS not supported\n");
1503 return NULL;
1504 }
1505 default_port = COAPS_DEFAULT_PORT;
1506 break;
1507 case COAP_PROTO_WS:
1508 if (!coap_ws_is_supported()) {
1509 coap_log_crit("coap_new_client_session*: WS not supported\n");
1510 return NULL;
1511 }
1512 default_port = 80;
1513 break;
1514 case COAP_PROTO_WSS:
1515 if (!coap_wss_is_supported()) {
1516 coap_log_crit("coap_new_client_session*: WSS not supported\n");
1517 return NULL;
1518 }
1519 default_port = 443;
1520 break;
1521 case COAP_PROTO_NONE:
1522 case COAP_PROTO_LAST:
1523 default:
1524 assert(0);
1525 return NULL;
1526 }
1528 local_if, server, 0, ctx, NULL);
1529 if (!session)
1530 goto error;
1531
1533 session->sock.session = session;
1534 memcpy(&session->sock.lfunc, coap_layers_coap[proto],
1535 sizeof(session->sock.lfunc));
1536
1537 session->app_data = app_data;
1538 session->app_cb = app_data ? callback : NULL;
1539#if COAP_WS_SUPPORT
1540 if (ws_host) {
1541 session->ws_host = coap_new_str_const(ws_host->s, ws_host->length);
1542 }
1543#else /* ! COAP_WS_SUPPORT */
1544 (void)ws_host;
1545#endif /* ! COAP_WS_SUPPORT */
1546
1547 if (COAP_PROTO_NOT_RELIABLE(proto)) {
1548 coap_session_t *s, *rtmp;
1549 if (!coap_netif_dgrm_connect(session, local_if, server, default_port)) {
1550 goto error;
1551 }
1552 /* Check that this is not a duplicate 4-tuple */
1553 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
1556 &s->addr_info.local) &&
1558 &s->addr_info.remote)) {
1559 coap_log_warn("***%s: session %p: duplicate - already exists\n",
1560 coap_session_str(session), (void *)session);
1561 goto error;
1562 }
1563 }
1564#ifdef WITH_CONTIKI
1565 session->sock.context = ctx;
1566#endif /* WITH_CONTIKI */
1567#if !COAP_DISABLE_TCP
1568 } else if (COAP_PROTO_RELIABLE(proto)) {
1569 if (!coap_netif_strm_connect1(session, local_if, server, default_port)) {
1570 goto error;
1571 }
1572#endif /* !COAP_DISABLE_TCP */
1573 }
1574
1575 session->sock.session = session;
1576#ifdef COAP_EPOLL_SUPPORT
1577 coap_epoll_ctl_add(&session->sock,
1578 EPOLLIN |
1579 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1580 EPOLLOUT : 0),
1581 __func__);
1582#endif /* COAP_EPOLL_SUPPORT */
1583
1585 if (local_if)
1586 session->sock.flags |= COAP_SOCKET_BOUND;
1587#if COAP_SERVER_SUPPORT
1588 if (ctx->proxy_uri_resource)
1589 session->proxy_session = 1;
1590#endif /* COAP_SERVER_SUPPORT */
1591 SESSIONS_ADD(ctx->sessions, session);
1592 return session;
1593
1594error:
1595 /*
1596 * Need to add in the session as coap_session_release_lkd()
1597 * will call SESSIONS_DELETE in coap_session_free().
1598 */
1599 if (session)
1600 SESSIONS_ADD(ctx->sessions, session);
1601 coap_session_release_lkd(session);
1602 return NULL;
1603}
1604
1605static void
1606coap_session_check_connect(coap_session_t *session) {
1607 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1608 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1609 }
1610#if !COAP_DISABLE_TCP
1611 if (COAP_PROTO_RELIABLE(session->proto)) {
1612 if (session->sock.flags & COAP_SOCKET_WANT_CONNECT) {
1614 if (session->client_initiated) {
1615 session->doing_first = 1;
1616 }
1617 } else {
1618 /* Initial connect worked immediately */
1619 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1620 }
1621 }
1622#endif /* !COAP_DISABLE_TCP */
1623 coap_ticks(&session->last_rx_tx);
1624}
1625#endif /* COAP_CLIENT_SUPPORT */
1626
1627void
1629 if (COAP_PROTO_NOT_RELIABLE(session->proto))
1630 coap_session_connected(session);
1631#if !COAP_DISABLE_TCP
1632 if (COAP_PROTO_RELIABLE(session->proto))
1633 coap_session_send_csm(session);
1634#endif /* !COAP_DISABLE_TCP */
1635}
1636
1637#if COAP_CLIENT_SUPPORT
1638int
1640 int default_port = COAP_DEFAULT_PORT;
1641
1642 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close && !session->session_failed)
1643 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1644
1645 switch (session->proto) {
1646 case COAP_PROTO_UDP:
1647 default_port = COAP_DEFAULT_PORT;
1648 break;
1649 case COAP_PROTO_DTLS:
1650 default_port = COAPS_DEFAULT_PORT;
1651 break;
1652 case COAP_PROTO_TCP:
1653 default_port = COAP_DEFAULT_PORT;
1654 break;
1655 case COAP_PROTO_TLS:
1656 default_port = COAPS_DEFAULT_PORT;
1657 break;
1658 case COAP_PROTO_WS:
1659 default_port = 80;
1660 break;
1661 case COAP_PROTO_WSS:
1662 default_port = 443;
1663 break;
1664 case COAP_PROTO_NONE:
1665 case COAP_PROTO_LAST:
1666 default:
1667 assert(0);
1668 return 0;
1669 }
1670 session->sock.session = session;
1671 coap_log_debug("***%s: trying to reconnect\n", coap_session_str(session));
1673 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1674 session->state = COAP_SESSION_STATE_NONE;
1675 if (!coap_netif_dgrm_connect(session, &session->local_reconnect, &session->addr_info.remote,
1676 default_port)) {
1677 goto error;
1678 }
1680#ifdef WITH_CONTIKI
1681 session->sock.context = session->context;
1682#endif /* WITH_CONTIKI */
1683#if !COAP_DISABLE_TCP
1684 } else if (COAP_PROTO_RELIABLE(session->proto)) {
1685 if (!coap_netif_strm_connect1(session, &session->local_reconnect, &session->addr_info.remote,
1686 default_port)) {
1687 goto error;
1688 }
1689#endif /* !COAP_DISABLE_TCP */
1690 } else {
1691 goto error;
1692 }
1693#ifdef COAP_EPOLL_SUPPORT
1694 coap_epoll_ctl_add(&session->sock,
1695 EPOLLIN |
1696 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1697 EPOLLOUT : 0),
1698 __func__);
1699#endif /* COAP_EPOLL_SUPPORT */
1700
1702 session->sock.flags |= COAP_SOCKET_BOUND;
1703 coap_session_check_connect(session);
1704 return 1;
1705error:
1706 return 0;
1707}
1708
1709void
1711 coap_lg_crcv_t *lg_crcv, *etmp;
1712
1713 if (!session->session_failed)
1714 return;
1715 coap_log_debug("***%s: session re-established\n",
1716 coap_session_str(session));
1717 session->session_failed = 0;
1718 session->retry_count = 0;
1720 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
1721 coap_pdu_reference_lkd(lg_crcv->sent_pdu);
1722 coap_send_internal(session, lg_crcv->sent_pdu, NULL);
1723 }
1724}
1725
1728 const coap_address_t *local_if,
1729 const coap_address_t *server,
1730 coap_proto_t proto) {
1731 coap_session_t *session;
1732
1733 coap_lock_lock(return NULL);
1734 session = coap_new_client_session3_lkd(ctx, local_if, server, proto, NULL, NULL, NULL);
1736 return session;
1737}
1738
1741 const coap_address_t *local_if,
1742 const coap_address_t *server,
1743 coap_proto_t proto,
1744 void *app_data,
1746 coap_str_const_t *ws_host) {
1747 coap_session_t *session;
1748
1749 coap_lock_lock(return NULL);
1750 session = coap_new_client_session3_lkd(ctx, local_if, server, proto, app_data, callback, ws_host);
1752 return session;
1753}
1754
1757 const coap_address_t *local_if,
1758 const coap_address_t *server,
1759 coap_proto_t proto,
1760 void *app_data,
1762 coap_str_const_t *ws_host) {
1763 coap_session_t *session;
1764
1766 session = coap_session_create_client(ctx, local_if, server,
1767 proto, app_data, callback, ws_host);
1768 if (session) {
1769 coap_log_debug("***%s: session %p: created outgoing session\n",
1770 coap_session_str(session), (void *)session);
1771 coap_session_check_connect(session);
1772 }
1773 return session;
1774}
1775
1778 const coap_address_t *local_if,
1779 const coap_address_t *server,
1780 coap_proto_t proto, const char *identity,
1781 const uint8_t *key, unsigned key_len) {
1782 coap_session_t *session;
1783
1784 coap_lock_lock(return NULL);
1785 session = coap_new_client_session_psk_lkd(ctx, local_if, server, proto, identity, key, key_len);
1787 return session;
1788}
1789
1792 const coap_address_t *local_if,
1793 const coap_address_t *server,
1794 coap_proto_t proto, const char *identity,
1795 const uint8_t *key, unsigned key_len) {
1796 coap_dtls_cpsk_t setup_data;
1797
1799 memset(&setup_data, 0, sizeof(setup_data));
1801
1802 if (identity) {
1803 setup_data.psk_info.identity.s = (const uint8_t *)identity;
1804 setup_data.psk_info.identity.length = strlen(identity);
1805 }
1806
1807 if (key && key_len > 0) {
1808 setup_data.psk_info.key.s = key;
1809 setup_data.psk_info.key.length = key_len;
1810 }
1811
1812 return coap_new_client_session_psk3_lkd(ctx, local_if, server,
1813 proto, &setup_data, NULL, NULL, NULL);
1814}
1815
1816/*
1817 * Check the validity of the SNI to send to the server.
1818 *
1819 * https://datatracker.ietf.org/doc/html/rfc6066#section-3
1820 * Literal IPv4 and IPv6 addresses are not permitted in "HostName".
1821 */
1822static void
1823coap_sanitize_client_sni(char **client_sni) {
1824 char *cp;
1825
1826 if (*client_sni == NULL)
1827 return;
1828
1829 cp = *client_sni;
1830 switch (*cp) {
1831 case '0':
1832 case '1':
1833 case '2':
1834 case '3':
1835 case '4':
1836 case '5':
1837 case '6':
1838 case '7':
1839 case '8':
1840 case '9':
1841 case 'a':
1842 case 'b':
1843 case 'c':
1844 case 'd':
1845 case 'e':
1846 case 'f':
1847 case 'A':
1848 case 'B':
1849 case 'C':
1850 case 'D':
1851 case 'E':
1852 case 'F':
1853 case ':':
1854 break;
1855 case '\000':
1856 /* Empty entry invalid */
1857 *client_sni = NULL;
1858 return;
1859 default:
1860 /* Does not start with a hex digit or : - not literal IP. */
1861 return;
1862 }
1863 /* Check for IPv4 */
1864 while (*cp) {
1865 switch (*cp) {
1866 case '0':
1867 case '1':
1868 case '2':
1869 case '3':
1870 case '4':
1871 case '5':
1872 case '6':
1873 case '7':
1874 case '8':
1875 case '9':
1876 case '.':
1877 break;
1878 default:
1879 /* Not of format nnn.nnn.nnn.nnn. Could be IPv6 */
1880 goto check_ipv6;
1881 }
1882 cp++;
1883 }
1884 /* IPv4 address - not allowed. */
1885 *client_sni = NULL;
1886 return;
1887
1888check_ipv6:
1889 /* Check for IPv6 */
1890 cp = *client_sni;
1891 while (*cp) {
1892 switch (*cp) {
1893 case '0':
1894 case '1':
1895 case '2':
1896 case '3':
1897 case '4':
1898 case '5':
1899 case '6':
1900 case '7':
1901 case '8':
1902 case '9':
1903 case 'a':
1904 case 'b':
1905 case 'c':
1906 case 'd':
1907 case 'e':
1908 case 'f':
1909 case 'A':
1910 case 'B':
1911 case 'C':
1912 case 'D':
1913 case 'E':
1914 case 'F':
1915 case ':':
1916 break;
1917 case '%':
1918 /* Start of i/f specification, Previous is IPv6 */
1919 *client_sni = NULL;
1920 return;
1921 default:
1922 /* Not of format xx:xx::xx. */
1923 return;
1924 }
1925 cp++;
1926 }
1927 *client_sni = NULL;
1928 return;
1929}
1930
1933 const coap_address_t *local_if,
1934 const coap_address_t *server,
1935 coap_proto_t proto,
1936 coap_dtls_cpsk_t *setup_data) {
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, setup_data,
1941 NULL, NULL, NULL);
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
1957 coap_lock_lock(return NULL);
1958 session = coap_new_client_session_psk3_lkd(ctx, local_if, server, proto,
1959 setup_data, app_data, callback, ws_host);
1961 return session;
1962}
1963
1966 const coap_address_t *local_if,
1967 const coap_address_t *server,
1968 coap_proto_t proto,
1969 coap_dtls_cpsk_t *setup_data,
1970 void *app_data,
1972 coap_str_const_t *ws_host) {
1973 coap_session_t *session;
1974
1976 session = coap_session_create_client(ctx, local_if, server, proto, app_data, callback, ws_host);
1977
1978 if (!session || !setup_data)
1979 return NULL;
1980
1981 session->cpsk_setup_data = *setup_data;
1982 if (setup_data->psk_info.identity.s) {
1983 session->psk_identity =
1985 setup_data->psk_info.identity.length);
1986 if (!session->psk_identity) {
1987 coap_log_warn("Cannot store session Identity (PSK)\n");
1988 coap_session_release_lkd(session);
1989 return NULL;
1990 }
1992 coap_log_warn("Identity (PSK) not defined\n");
1993 coap_session_release_lkd(session);
1994 return NULL;
1995 }
1996
1997 if (setup_data->psk_info.key.s && setup_data->psk_info.key.length > 0) {
1998 session->psk_key = coap_new_bin_const(setup_data->psk_info.key.s,
1999 setup_data->psk_info.key.length);
2000 if (!session->psk_key) {
2001 coap_log_warn("Cannot store session pre-shared key (PSK)\n");
2002 coap_session_release_lkd(session);
2003 return NULL;
2004 }
2006 coap_log_warn("Pre-shared key (PSK) not defined\n");
2007 coap_session_release_lkd(session);
2008 return NULL;
2009 }
2010
2011 coap_sanitize_client_sni(&session->cpsk_setup_data.client_sni);
2012
2014 if (!coap_dtls_context_set_cpsk(ctx, &session->cpsk_setup_data)) {
2015 coap_session_release_lkd(session);
2016 return NULL;
2017 }
2018 }
2019 coap_log_debug("***%s: new outgoing session\n",
2020 coap_session_str(session));
2021 coap_session_check_connect(session);
2022 return session;
2023}
2024#endif /* COAP_CLIENT_SUPPORT */
2025
2026int
2028 const coap_bin_const_t *psk_hint
2029 ) {
2030 /* We may be refreshing the hint with the same hint */
2031 coap_bin_const_t *old_psk_hint = session->psk_hint;
2032
2033 if (psk_hint && psk_hint->s) {
2034 if (session->psk_hint) {
2035 if (coap_binary_equal(session->psk_hint, psk_hint))
2036 return 1;
2037 }
2038 session->psk_hint = coap_new_bin_const(psk_hint->s,
2039 psk_hint->length);
2040 if (!session->psk_hint) {
2041 coap_log_err("No memory to store identity hint (PSK)\n");
2042 if (old_psk_hint)
2043 coap_delete_bin_const(old_psk_hint);
2044 return 0;
2045 }
2046 } else {
2047 session->psk_hint = NULL;
2048 }
2049 if (old_psk_hint)
2050 coap_delete_bin_const(old_psk_hint);
2051
2052 return 1;
2053}
2054
2055int
2057 const coap_bin_const_t *psk_key
2058 ) {
2059 /* We may be refreshing the key with the same key */
2060 coap_bin_const_t *old_psk_key = session->psk_key;
2061
2062 if (psk_key && psk_key->s) {
2063 if (session->psk_key) {
2064 if (coap_binary_equal(session->psk_key, psk_key))
2065 return 1;
2066 }
2067 session->psk_key = coap_new_bin_const(psk_key->s, psk_key->length);
2068 if (!session->psk_key) {
2069 coap_log_err("No memory to store pre-shared key (PSK)\n");
2070 if (old_psk_key)
2071 coap_delete_bin_const(old_psk_key);
2072 return 0;
2073 }
2074 } else {
2075 session->psk_key = NULL;
2076 }
2077 if (old_psk_key)
2078 coap_delete_bin_const(old_psk_key);
2079
2080 return 1;
2081}
2082
2083int
2085 const coap_bin_const_t *psk_identity
2086 ) {
2087 /* We may be refreshing the identity with the same identity */
2088 coap_bin_const_t *old_psk_identity = session->psk_identity;
2089
2090 if (psk_identity && psk_identity->s) {
2091 if (session->psk_identity) {
2092 if (coap_binary_equal(session->psk_identity, psk_identity))
2093 return 1;
2094 }
2095 session->psk_identity = coap_new_bin_const(psk_identity->s,
2096 psk_identity->length);
2097 if (!session->psk_identity) {
2098 coap_log_err("No memory to store pre-shared key identity (PSK)\n");
2099 if (old_psk_identity)
2100 coap_delete_bin_const(old_psk_identity);
2101 return 0;
2102 }
2103 } else {
2104 session->psk_identity = NULL;
2105 }
2106 if (old_psk_identity)
2107 coap_delete_bin_const(old_psk_identity);
2108
2109 return 1;
2110}
2111
2112#if COAP_SERVER_SUPPORT
2113const coap_bin_const_t *
2115 if (session)
2116 return session->psk_hint;
2117 return NULL;
2118}
2119#endif /* COAP_SERVER_SUPPORT */
2120
2121const coap_bin_const_t *
2123 const coap_bin_const_t *psk_identity = NULL;
2124 if (session) {
2125 psk_identity = session->psk_identity;
2126 if (psk_identity == NULL) {
2127 psk_identity = &session->cpsk_setup_data.psk_info.identity;
2128 }
2129 }
2130 return psk_identity;
2131}
2132
2133const coap_bin_const_t *
2135 if (session)
2136 return session->psk_key;
2137 return NULL;
2138}
2139
2140#if COAP_CLIENT_SUPPORT
2143 const coap_address_t *local_if,
2144 const coap_address_t *server,
2145 coap_proto_t proto,
2146 coap_dtls_pki_t *setup_data) {
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 NULL, NULL, NULL);
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
2167 coap_lock_lock(return NULL);
2168 session = coap_new_client_session_pki3_lkd(ctx, local_if, server, proto, setup_data,
2169 app_data, callback, ws_host);
2171 return session;
2172}
2173
2176 const coap_address_t *local_if,
2177 const coap_address_t *server,
2178 coap_proto_t proto,
2179 coap_dtls_pki_t *setup_data,
2180 void *app_data,
2182 coap_str_const_t *ws_host) {
2183 coap_session_t *session;
2184 coap_dtls_pki_t l_setup_data;
2185
2186 if (!setup_data)
2187 return NULL;
2188 if (setup_data->version != COAP_DTLS_PKI_SETUP_VERSION) {
2189 coap_log_err("coap_new_client_session_pki: Wrong version of setup_data\n");
2190 return NULL;
2191 }
2192
2194 l_setup_data = *setup_data;
2195 coap_sanitize_client_sni(&l_setup_data.client_sni);
2196
2197 session = coap_session_create_client(ctx, local_if, server, proto, app_data, callback, ws_host);
2198
2199 if (!session) {
2200 return NULL;
2201 }
2202
2204 /* we know that setup_data is not NULL */
2205 if (!coap_dtls_context_set_pki(ctx, &l_setup_data, COAP_DTLS_ROLE_CLIENT)) {
2206 coap_session_release_lkd(session);
2207 return NULL;
2208 }
2209 }
2210 coap_log_debug("***%s: new outgoing session\n",
2211 coap_session_str(session));
2212 coap_session_check_connect(session);
2213 return session;
2214}
2215#endif /* ! COAP_CLIENT_SUPPORT */
2216
2217#if COAP_SERVER_SUPPORT
2218#if !COAP_DISABLE_TCP
2220coap_new_server_session(coap_context_t *ctx, coap_endpoint_t *ep, void *extra) {
2221 coap_session_t *session;
2222 coap_tick_t now;
2223
2224 session = coap_make_session(ep->proto, COAP_SESSION_TYPE_SERVER,
2225 NULL, NULL, NULL, 0, ctx, ep);
2226 if (!session)
2227 goto error;
2228
2229 memcpy(session->sock.lfunc, ep->sock.lfunc, sizeof(session->sock.lfunc));
2230 if (!coap_netif_strm_accept(ep, session, extra))
2231 goto error;
2232
2233 coap_make_addr_hash(&session->addr_hash, session->proto, &session->addr_info);
2234
2235 session->sock.session = session;
2236#ifdef COAP_EPOLL_SUPPORT
2237 coap_epoll_ctl_add(&session->sock,
2238 EPOLLIN,
2239 __func__);
2240#endif /* COAP_EPOLL_SUPPORT */
2241 SESSIONS_ADD(ep->sessions, session);
2242 if (session) {
2243 coap_ticks(&now);
2244 session->last_rx_tx = now;
2245 coap_log_debug("***%s: session %p: new incoming session\n",
2246 coap_session_str(session), (void *)session);
2250 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
2251 }
2252 return session;
2253
2254error:
2255 /*
2256 * Need to add in the session as coap_session_release_lkd()
2257 * will call SESSIONS_DELETE in coap_session_free().
2258 */
2259 if (session) {
2260 SESSIONS_ADD(ep->sessions, session);
2261 coap_session_free(session);
2262 }
2263 return NULL;
2264}
2265#endif /* !COAP_DISABLE_TCP */
2266#endif /* COAP_SERVER_SUPPORT */
2267
2268void
2270 const uint8_t *data) {
2271 session->tx_token = coap_decode_var_bytes8(data, len);
2272 /*
2273 * Decrement as when first used by coap_session_new_token() it will
2274 * get incremented
2275 */
2276 session->tx_token--;
2277}
2278
2279void
2281 uint8_t *data) {
2282 *len = coap_encode_var_safe8(data,
2283 sizeof(session->tx_token), ++session->tx_token);
2284}
2285
2286COAP_API uint16_t
2288 uint16_t mid;
2289
2290 coap_lock_lock(return 0);
2291 mid = coap_new_message_id_lkd(session);
2293 return mid;
2294}
2295
2296uint16_t
2299 if (COAP_PROTO_NOT_RELIABLE(session->proto))
2300 return ++session->tx_mid;
2301 /* TCP/TLS have no notion of mid */
2302 return 0;
2303}
2304
2305const coap_address_t *
2307 if (session)
2308 return &session->addr_info.remote;
2309 return NULL;
2310}
2311
2312const coap_address_t *
2314 if (session)
2315 return &session->addr_info.local;
2316 return NULL;
2317}
2318
2319const coap_address_t *
2321#if COAP_CLIENT_SUPPORT
2322 if (session && session->type == COAP_SESSION_TYPE_CLIENT &&
2323 session->sock.flags & COAP_SOCKET_MULTICAST)
2324 return &session->sock.mcast_addr;
2325#else /* ! COAP_CLIENT_SUPPORT */
2326 (void)session;
2327#endif /* ! COAP_CLIENT_SUPPORT */
2328 return NULL;
2329}
2330
2333 if (session)
2334 return session->context;
2335 return NULL;
2336}
2337
2340 if (session)
2341 return session->proto;
2342 return 0;
2343}
2344
2347 if (session)
2348 return session->type;
2349 return 0;
2350}
2351
2352int
2354#if COAP_OSCORE_SUPPORT
2355 return (session && session->oscore_encryption != 0) ? 1 : 0;
2356#else
2357 (void)session;
2358 return 0;
2359#endif
2360}
2361
2362COAP_API int
2364 int ret;
2365
2366 coap_lock_lock(return 0);
2367 ret = coap_session_set_type_client_lkd(session, 1);
2369 return ret;
2370}
2371
2372int
2374#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2375 if (session && session->type == COAP_SESSION_TYPE_SERVER) {
2377 session->type = COAP_SESSION_TYPE_CLIENT;
2378 if (session->endpoint) {
2379 SESSIONS_DELETE(session->endpoint->sessions, session);
2380 SESSIONS_ADD(session->context->sessions, session);
2381 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
2382 session->sock = session->endpoint->sock;
2383 session->sock.flags |= COAP_SOCKET_SLAVE;
2384 session->sock.flags &= ~COAP_SOCKET_CAN_READ;
2385 session->sock.flags &= ~COAP_SOCKET_WANT_READ;
2386 } else {
2387 session->sock.endpoint = NULL;
2388 }
2389 session->endpoint = NULL;
2390 }
2391 if (report_changed) {
2392 coap_log_debug("***%s: session now is type Client\n",
2393 coap_session_str(session));
2394 }
2395 return 1;
2396 }
2397#else /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2398 (void)session;
2399 (void)report_changed;
2400#endif /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2401 return 0;
2402}
2403
2404COAP_API int
2406 int ret;
2407
2408 coap_lock_lock(return 0);
2409 ret = coap_session_set_type_server_lkd(session);
2411 return ret;
2412}
2413
2414int
2416#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2417 if (session && session->type == COAP_SESSION_TYPE_CLIENT) {
2418 coap_endpoint_t *ep;
2419 coap_mid_t mid;
2420 coap_pdu_t *ping = NULL;
2421
2422 LL_FOREACH(session->context->endpoint, ep) {
2423 if (session->proto == ep->proto)
2424 break;
2425 }
2426 if (!ep) {
2427 /* Need a dummy endpoint to 'hang' off as this is now a server */
2428 ep = coap_malloc_endpoint();
2429 if (!ep) {
2430 coap_log_warn("coap_new_endpoint: malloc");
2431 return 0;
2432 }
2433
2434 memset(ep, 0, sizeof(coap_endpoint_t));
2435 ep->context = session->context;
2436 ep->proto = session->proto;
2437 ep->sock.endpoint = ep;
2438 memcpy(&ep->sock.lfunc, coap_layers_coap[session->proto], sizeof(ep->sock.lfunc));
2439
2440 ep->default_mtu = COAP_DEFAULT_MTU;
2441 LL_PREPEND(session->context->endpoint, ep);
2442 }
2443 /* Need to use coap_send_lkd() here to get traffic flowing */
2444 if (session->proto == COAP_PROTO_UDP) {
2446 coap_new_message_id_lkd(session), 0);
2447 if (!ping) {
2448 session->type = COAP_SESSION_TYPE_SERVER;
2449 return 0;
2450 }
2451 mid = coap_send_lkd(session, ping);
2452 if (mid != COAP_INVALID_MID) {
2453 coap_tick_t now;
2454
2455 coap_ticks(&now);
2456 session->last_ping_mid = mid;
2457 session->last_rx_tx = now;
2458 session->last_ping = now;
2459 }
2460 }
2461 /*
2462 * (D)TLS will initiate traffic with handshake.
2463 * Reliable protocols will be sending a CSM, so no nead for Ping.
2464 */
2465 if (session->context) {
2466 if (session->context->sessions) {
2467 SESSIONS_DELETE(session->context->sessions, session);
2468 }
2469 }
2470 SESSIONS_ADD(ep->sessions, session);
2471 session->endpoint = ep;
2472 session->type = COAP_SESSION_TYPE_SERVER;
2473 coap_session_release_lkd(session);
2474 coap_log_debug("***%s: session now is type Server\n",
2475 coap_session_str(session));
2476 return 1;
2477 }
2478#else /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2479 (void)session;
2480#endif /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2481 return 0;
2482}
2483
2486 if (session)
2487 return session->state;
2488 return 0;
2489}
2490
2493#if COAP_SERVER_SUPPORT
2494 if (session)
2495 return session->endpoint;
2496#else /* ! COAP_SERVER_SUPPORT */
2497 (void)session;
2498#endif /* ! COAP_SERVER_SUPPORT */
2499 return 0;
2500}
2501
2502int
2504 if (session)
2505 return session->ifindex;
2506 return -1;
2507}
2508
2509void *
2511 coap_tls_library_t *tls_lib) {
2512 if (session)
2513 return coap_dtls_get_tls(session, tls_lib);
2514 return NULL;
2515}
2516
2517static const char *
2519 switch (proto) {
2520 case COAP_PROTO_UDP:
2521 return "UDP ";
2522 case COAP_PROTO_DTLS:
2523 return "DTLS";
2524 case COAP_PROTO_TCP:
2525 return "TCP ";
2526 case COAP_PROTO_TLS:
2527 return "TLS ";
2528 case COAP_PROTO_WS:
2529 return "WS ";
2530 case COAP_PROTO_WSS:
2531 return "WSS ";
2532 case COAP_PROTO_NONE:
2533 case COAP_PROTO_LAST:
2534 default:
2535 return "????" ;
2536 break;
2537 }
2538 return NULL;
2539}
2540
2541#if COAP_SERVER_SUPPORT
2543coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto) {
2544 coap_endpoint_t *endpoint;
2545
2546 coap_lock_lock(return NULL);
2547 endpoint = coap_new_endpoint_lkd(context, listen_addr, proto);
2549 return endpoint;
2550}
2551
2553coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr,
2554 coap_proto_t proto) {
2555 coap_endpoint_t *ep = NULL;
2556
2557 if (!context || !listen_addr) {
2558 coap_log_debug("coap_new_endpoint: Both context and listen_addr need to be defined\n");
2559 return NULL;
2560 }
2561
2563
2564 switch (proto) {
2565 case COAP_PROTO_UDP:
2566 break;
2567 case COAP_PROTO_DTLS:
2568 if (!coap_dtls_is_supported()) {
2569 coap_log_warn("coap_new_endpoint: DTLS not supported\n");
2570 return NULL;
2571 }
2572 break;
2573 case COAP_PROTO_TLS:
2574 if (!coap_tls_is_supported()) {
2575 coap_log_warn("coap_new_endpoint: TLS not supported\n");
2576 return NULL;
2577 }
2578 break;
2579 case COAP_PROTO_TCP:
2580 if (!coap_tcp_is_supported()) {
2581 coap_log_warn("coap_new_endpoint: TCP not supported\n");
2582 return NULL;
2583 }
2584 break;
2585 case COAP_PROTO_WS:
2586 if (!coap_ws_is_supported()) {
2587 coap_log_warn("coap_new_endpoint: WS not supported\n");
2588 return NULL;
2589 }
2590 break;
2591 case COAP_PROTO_WSS:
2592 if (!coap_wss_is_supported()) {
2593 coap_log_warn("coap_new_endpoint: WSS not supported\n");
2594 return NULL;
2595 }
2596 break;
2597 case COAP_PROTO_NONE:
2598 case COAP_PROTO_LAST:
2599 default:
2600 coap_log_crit("coap_new_endpoint: Unsupported protocol %d\n", proto);
2601 return NULL;
2602 }
2603
2604 if (proto == COAP_PROTO_DTLS || proto == COAP_PROTO_TLS ||
2605 proto == COAP_PROTO_WSS) {
2607 coap_log_info("coap_new_endpoint: one of coap_context_set_psk() or "
2608 "coap_context_set_pki() not called\n");
2609 return NULL;
2610 }
2611 }
2612 ep = coap_malloc_endpoint();
2613 if (!ep) {
2614 coap_log_warn("coap_new_endpoint: malloc");
2615 return NULL;
2616 }
2617
2618 memset(ep, 0, sizeof(coap_endpoint_t));
2619 ep->context = context;
2620 ep->proto = proto;
2621 ep->sock.endpoint = ep;
2622 if (proto < COAP_PROTO_LAST) {
2623 /*
2624 * Should be caught above, but come compilers realize that proto
2625 * includes COAP_PROTO_LAST, but there is no table entry for that
2626 */
2627 memcpy(&ep->sock.lfunc, coap_layers_coap[proto], sizeof(ep->sock.lfunc));
2628 }
2629
2630 if (COAP_PROTO_NOT_RELIABLE(proto)) {
2631 if (!coap_netif_dgrm_listen(ep, listen_addr))
2632 goto error;
2633#ifdef WITH_CONTIKI
2634 ep->sock.context = context;
2635#endif /* WITH_CONTIKI */
2636#if !COAP_DISABLE_TCP
2637 } else if (COAP_PROTO_RELIABLE(proto)) {
2638 if (!coap_netif_strm_listen(ep, listen_addr))
2639 goto error;
2640#endif /* !COAP_DISABLE_TCP */
2641 } else {
2642 coap_log_crit("coap_new_endpoint: Protocol type not supported %d\n", proto);
2643 goto error;
2644 }
2645
2647#ifndef INET6_ADDRSTRLEN
2648#define INET6_ADDRSTRLEN 40
2649#endif
2650 unsigned char addr_str[INET6_ADDRSTRLEN + 8];
2651
2652 if (coap_print_addr(&ep->bind_addr, addr_str, INET6_ADDRSTRLEN + 8)) {
2653 coap_log_debug("created %s endpoint %s\n", coap_proto_name(ep->proto),
2654 addr_str);
2655 }
2656 }
2657
2658 ep->default_mtu = COAP_DEFAULT_MTU;
2659
2660#ifdef COAP_EPOLL_SUPPORT
2661 ep->sock.endpoint = ep;
2662 coap_epoll_ctl_add(&ep->sock,
2663 EPOLLIN,
2664 __func__);
2665#endif /* COAP_EPOLL_SUPPORT */
2666
2667 LL_PREPEND(context->endpoint, ep);
2668 return ep;
2669
2670error:
2671 coap_free_endpoint_lkd(ep);
2672 return NULL;
2673}
2674
2675void
2677 ep->default_mtu = (uint16_t)mtu;
2678}
2679
2680COAP_API void
2682 if (ep) {
2683 coap_context_t *context = ep->context;
2684 if (context) {
2685 coap_lock_lock(return);
2686 }
2687 coap_free_endpoint_lkd(ep);
2688 if (context) {
2690 }
2691 }
2692}
2693
2694void
2695coap_free_endpoint_lkd(coap_endpoint_t *ep) {
2696 if (ep) {
2697 coap_session_t *session, *rtmp;
2698
2699 if (ep->context) {
2700 /* If fully allocated and inserted */
2702 SESSIONS_ITER_SAFE(ep->sessions, session, rtmp) {
2703 if (session->ref > 0) {
2705#if COAP_CLIENT_SUPPORT
2706 if (session->client_initiated) {
2707 coap_session_release_lkd(session);
2708 }
2709#endif /* COAP_CLIENT_SUPPORT */
2710 }
2711 assert(session->ref == 0);
2712 if (session->ref == 0) {
2714 coap_session_free(session);
2715 }
2716 }
2717 if (coap_netif_available_ep(ep)) {
2718 /*
2719 * ep->sock.endpoint is set in coap_new_endpoint().
2720 * ep->sock.session is never set.
2721 *
2722 * session->sock.session is set for both clients and servers (when a
2723 * new session is accepted), but does not affect the endpoint.
2724 *
2725 * So, it is safe to call coap_netif_close_ep() after all the sessions
2726 * have been freed above as we are only working with the endpoint sock.
2727 */
2728#ifdef COAP_EPOLL_SUPPORT
2729 assert(ep->sock.session == NULL);
2730#endif /* COAP_EPOLL_SUPPORT */
2732 }
2733
2734 if (ep->context->endpoint) {
2735 LL_DELETE(ep->context->endpoint, ep);
2736 }
2737 }
2738
2739 if (ep->app_cb) {
2740 coap_lock_callback(ep->app_cb(ep->app_data));
2741 }
2742
2743 coap_mfree_endpoint(ep);
2744 }
2745}
2746
2747void *
2749 assert(endpoint);
2750 return endpoint->app_data;
2751}
2752
2753COAP_API void *
2754coap_endpoint_set_app_data(coap_endpoint_t *endpoint, void *app_data,
2756 void *old_data;
2757
2758 coap_lock_lock(return NULL);
2759 old_data = coap_endpoint_set_app_data_lkd(endpoint, app_data, callback);
2761 return old_data;
2762}
2763
2764void *
2765coap_endpoint_set_app_data_lkd(coap_endpoint_t *endpoint, void *app_data,
2767 void *old_data = endpoint->app_data;
2768
2769 endpoint->app_data = app_data;
2770 endpoint->app_cb = app_data ? callback : NULL;
2771 return old_data;
2772}
2773
2774#endif /* COAP_SERVER_SUPPORT */
2775
2778 const coap_address_t *remote_addr,
2779 int ifindex) {
2780 coap_session_t *s, *rtmp;
2781#if COAP_CLIENT_SUPPORT
2782 SESSIONS_ITER(ctx->sessions, s, rtmp) {
2783 if (s->ifindex == ifindex) {
2784 if (s->sock.flags & COAP_SOCKET_MULTICAST) {
2785 if (coap_address_equals(&s->sock.mcast_addr, remote_addr))
2786 return s;
2787 } else if (coap_address_equals(&s->addr_info.remote, remote_addr))
2788 return s;
2789 }
2790 }
2791#endif /* COAP_CLIENT_SUPPORT */
2792#if COAP_SERVER_SUPPORT
2793 coap_endpoint_t *ep;
2794
2795 LL_FOREACH(ctx->endpoint, ep) {
2796 SESSIONS_ITER(ep->sessions, s, rtmp) {
2797 if (s->ifindex == ifindex && coap_address_equals(&s->addr_info.remote,
2798 remote_addr))
2799 return s;
2800 }
2801 }
2802#endif /* COAP_SERVER_SUPPORT */
2803 return NULL;
2804}
2805
2806#ifndef INET6_ADDRSTRLEN
2807#define INET6_ADDRSTRLEN 46
2808#endif
2809const char *
2811 static char szSession[2 * (INET6_ADDRSTRLEN + 8) + 24];
2812 char *p = szSession, *end = szSession + sizeof(szSession);
2813
2814 if (!session) {
2815 return "Session not defined";
2816 }
2817 if (coap_print_addr(&session->addr_info.local,
2818 (unsigned char *)p, end - p) > 0)
2819 p += strlen(p);
2820 if (p + 6 < end) {
2821 strcpy(p, " <-> ");
2822 p += 5;
2823 }
2824 if (p + 1 < end) {
2825 if (coap_print_addr(&session->addr_info.remote,
2826 (unsigned char *)p, end - p) > 0)
2827 p += strlen(p);
2828 }
2829 if (session->ifindex > 0 && p + 1 < end)
2830 p += snprintf(p, end - p, " (if%d)", session->ifindex);
2831 if (p + 6 < end) {
2832 strcpy(p, " ");
2833 p++;
2834 strcpy(p, coap_proto_name(session->proto));
2835 }
2836
2837 return szSession;
2838}
2839
2840#if COAP_SERVER_SUPPORT
2841const char *
2842coap_endpoint_str(const coap_endpoint_t *endpoint) {
2843 static char szEndpoint[128];
2844 char *p = szEndpoint, *end = szEndpoint + sizeof(szEndpoint);
2845 if (coap_print_addr(&endpoint->bind_addr, (unsigned char *)p, end - p) > 0)
2846 p += strlen(p);
2847 if (p + 6 < end) {
2848 if (endpoint->proto == COAP_PROTO_UDP) {
2849 strcpy(p, " UDP");
2850 } else if (endpoint->proto == COAP_PROTO_DTLS) {
2851 strcpy(p, " DTLS");
2852 } else {
2853 strcpy(p, " NONE");
2854 }
2855 }
2856
2857 return szEndpoint;
2858}
2859#endif /* COAP_SERVER_SUPPORT */
2860#if COAP_CLIENT_SUPPORT
2861void
2863 session->no_observe_cancel = 1;
2864}
2865
2866void
2868 if (session->type != COAP_SESSION_TYPE_CLIENT) {
2869 coap_lock_lock(return);
2871 coap_session_release_lkd(session);
2873 }
2874}
2875#endif /* COAP_CLIENT_SUPPORT */
2876#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:258
void * coap_dtls_get_tls(const coap_session_t *c_session COAP_UNUSED, coap_tls_library_t *tls_lib)
Definition coap_notls.c:304
unsigned int coap_dtls_get_overhead(coap_session_t *session COAP_UNUSED)
Definition coap_notls.c:402
int coap_dtls_context_check_keys_enabled(coap_context_t *ctx COAP_UNUSED)
Definition coap_notls.c:297
#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:1614
#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:74
void coap_delete_cache_entry(coap_context_t *context, coap_cache_entry_t *cache_entry)
Remove a cache-entry from the hash list and free off all the appropriate contents apart from app_data...
#define COAP_DEFAULT_NON_MAX_RETRANSMIT
The number of times for requests for re-transmission of missing Q-Block1 when no response has been re...
uint16_t coap_session_get_non_max_retransmit(const coap_session_t *session)
Get the CoAP NON maximum retransmit count of missing Q-Block1 or Q-Block2 requested before there is a...
coap_fixed_point_t coap_session_get_default_leisure(const coap_session_t *session)
Get the CoAP default leisure time RFC7252 DEFAULT_LEISURE.
void coap_session_set_max_retransmit(coap_session_t *session, uint16_t value)
Set the CoAP maximum retransmit count before failure.
#define COAP_DEFAULT_NON_TIMEOUT
The delay (+ ACK_RANDOM_FACTOR) to introduce once NON MAX_PAYLOADS Q-Block1 or Q-Block2 have been sen...
coap_fixed_point_t coap_session_get_non_timeout(const coap_session_t *session)
Get the CoAP MAX_PAYLOADS limit delay timeout.
void coap_session_set_ack_random_factor(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP ack randomize factor.
#define COAP_DEFAULT_MAX_LATENCY
The MAX_LATENCY definition.
coap_fixed_point_t coap_session_get_ack_random_factor(const coap_session_t *session)
Get the CoAP ack randomize factor.
#define COAP_DEFAULT_ACK_RANDOM_FACTOR
A factor that is used to randomize the wait time before a message is retransmitted to prevent synchro...
uint16_t coap_session_get_max_retransmit(const coap_session_t *session)
Get the CoAP maximum retransmit before failure.
void coap_session_set_max_payloads(coap_session_t *session, uint16_t value)
Set the CoAP maximum payloads count of Q-Block1 or Q-Block2 before delay is introduced RFC9177 MAX_PA...
#define COAP_DEFAULT_MAX_RETRANSMIT
Number of message retransmissions before message sending is stopped.
uint32_t coap_session_get_probing_rate(const coap_session_t *session)
Get the CoAP probing rate when there is no response RFC7252 PROBING_RATE.
#define COAP_DEFAULT_ACK_TIMEOUT
Number of seconds when to expect an ACK or a response to an outstanding CON message.
#define COAP_DEFAULT_DEFAULT_LEISURE
The number of seconds to use as bounds for multicast traffic RFC 7252, Section 4.8 Default value of D...
void coap_session_set_ack_timeout(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP initial ack response timeout before the next re-transmit.
#define COAP_DEFAULT_NSTART
The number of simultaneous outstanding interactions that a client maintains to a given server.
void coap_session_set_non_receive_timeout(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP non receive timeout delay timeout.
void coap_session_set_nstart(coap_session_t *session, uint16_t value)
Set the CoAP maximum concurrent transmission count of Confirmable messages RFC7252 NSTART.
#define COAP_DEFAULT_PROBING_RATE
The number of bytes/second allowed when there is no response RFC 7252, Section 4.8 Default value of P...
void coap_session_set_non_max_retransmit(coap_session_t *session, uint16_t value)
Set the CoAP NON maximum retransmit count of missing Q-Block1 or Q-Block2 requested before there is a...
uint16_t coap_session_get_max_payloads(const coap_session_t *session)
Get the CoAP maximum payloads count of Q-Block1 or Q-Block2 before delay is introduced RFC9177 MAX_PA...
#define COAP_DEFAULT_NON_RECEIVE_TIMEOUT
The time to wait for any missing Q-Block1 or Q-Block2 packets before requesting re-transmission of mi...
void coap_session_set_probing_rate(coap_session_t *session, uint32_t value)
Set the CoAP probing rate when there is no response RFC7252 PROBING_RATE.
void coap_session_set_default_leisure(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP default leisure time (for multicast) RFC7252 DEFAULT_LEISURE.
coap_fixed_point_t coap_session_get_non_receive_timeout(const coap_session_t *session)
Get the CoAP non receive timeout delay timeout.
uint16_t coap_session_get_nstart(const coap_session_t *session)
Get the CoAP maximum concurrent transmission count of Confirmable messages RFC7252 NSTART.
#define COAP_DEFAULT_MAX_PAYLOADS
Number of Q-Block1 or Q-Block2 payloads that can be sent in a burst before a delay has to kick in.
coap_fixed_point_t coap_session_get_ack_timeout(const coap_session_t *session)
Get the CoAP initial ack response timeout before the next re-transmit.
void coap_session_set_non_timeout(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP non timeout delay timeout.
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition coap_time.h: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:190
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:5279
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:210
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:1482
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:1362
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:2134
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition coap_net.c:1388
coap_queue_t * coap_new_node(void)
Creates a new node suitable for adding to the CoAP sendqueue.
Definition coap_net.c:239
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:3306
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 id from the list given list.
Definition coap_net.c:3197
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:3345
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:266
coap_session_t * coap_session_new_dtls_session(coap_session_t *session, coap_tick_t now)
Create a new DTLS session for the session.
#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:1741
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:470
#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:1603
#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:851
#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:1239
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
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_mid_t last_con_mid
The last CON mid that has been been processed.
coap_session_type_t type
client or server side socket
uint32_t probing_rate
Max transfer wait when remote is not respoding (default 1 byte/sec).
coap_mid_t last_ack_mid
The last ACK mid that has been been processed.
coap_context_t * context
session's context
size_t partial_write
if > 0 indicates number of bytes already written from the pdu at the head of sendqueue
coap_addr_hash_t addr_hash
Address hash for server incoming packets.
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