libcoap 4.3.5-develop-3f4d08f
Loading...
Searching...
No Matches
coap_session.c
Go to the documentation of this file.
1/* coap_session.c -- Session management for libcoap
2 *
3 * Copyright (C) 2017 Jean-Claue Michelou <jcm@spinetix.com>
4 * Copyright (C) 2022-2026 Jon Shallow <supjps-libcoap@jpshallow.com>
5 *
6 * SPDX-License-Identifier: BSD-2-Clause
7 *
8 * This file is part of the CoAP library libcoap. Please see
9 * README for terms of use.
10 */
11
18
19#ifndef COAP_SESSION_C_
20#define COAP_SESSION_C_
21
22#include <stdio.h>
23
24#ifdef COAP_EPOLL_SUPPORT
25#include <sys/epoll.h>
26#include <sys/timerfd.h>
27#endif /* COAP_EPOLL_SUPPORT */
28
32 uint32_t fr = fp1.fractional_part * fp2.fractional_part;
33
34 res.integer_part = fp1.integer_part * fp2.integer_part + fr/1000;
35 res.fractional_part = fr % 1000;
36 return res;
37}
38
42 uint32_t fr = fp1.fractional_part * u2;
43
44 res.integer_part = fp1.integer_part * u2 + fr/1000;
45 res.fractional_part = fr % 1000;
46 return res;
47}
48
52 uint32_t fr = fp1.fractional_part + fp2.fractional_part;
53
54 res.integer_part = fp1.integer_part + fp2.integer_part + fr/1000;
55 res.fractional_part = fr % 1000;
56 return res;
57}
58
61 coap_fixed_point_t res = fp1;
62
63 res.integer_part += u2;
64 return res;
65}
66
69 coap_fixed_point_t res = fp1;
70
71 res.integer_part -= u2;
72 return res;
73}
74
78 uint32_t num = (fp1.integer_part * 1000 + fp1.fractional_part) / u2;
79
80 res.integer_part = num / 1000;
81 res.fractional_part = num % 1000;
82 return res;
83}
84
85#if COAP_Q_BLOCK_SUPPORT
89 uint8_t ran;
90
91 coap_prng_lkd(&ran, sizeof(ran));
93 res = coap_multi_fixed_uint(res, ran);
94 res = coap_div_fixed_uint(res, 0xff);
95 res = coap_add_fixed_fixed(COAP_NON_TIMEOUT(session), res);
96 return res;
97}
98
104
105 return ticks;
106}
107
108/*
109 * Save away derived Congestion Control parameters for speed of access.
110 * They will get updated whenever a component variable is updated.
111 */
112
113/*
114 * NON_PROBING_WAIT = NON_TIMEOUT * ((2 ** NON_MAX_RETRANSMIT) - 1) *
115 * ACK_RANDOM_FACTOR + (2 * MAX_LATENCY) + NON_TIMEOUT_RANDOM
116 *
117 * Do not include NON_TIMEOUT_RANDOM as that changes
118 */
119static void
120coap_session_fix_non_probing_wait_base(coap_session_t *s) {
122
124 ((1 << (COAP_NON_MAX_RETRANSMIT(s) + 1)) -1));
128}
129
130/*
131 * NON_PARTIAL_TIMEOUT = NON_TIMEOUT * ((2 ** NON_MAX_RETRANSMIT) - 1) *
132 * ACK_RANDOM_FACTOR + (2 * MAX_LATENCY) + NON_TIMEOUT
133 */
134static void
135coap_session_fix_non_partial_timeout(coap_session_t *s) {
137
139 ((1 << (COAP_NON_MAX_RETRANSMIT(s) + 1)) -1));
144}
145#endif /* COAP_Q_BLOCK_SUPPORT */
146
147void
149 if (value.integer_part > 0 && value.fractional_part < 1000) {
150 session->ack_timeout = value;
151 coap_log_debug("***%s: session ack_timeout set to %u.%03u\n",
152 coap_session_str(session), session->ack_timeout.integer_part,
154 }
155}
156
157void
159 coap_fixed_point_t value) {
160 if (value.integer_part > 0 && value.fractional_part < 1000) {
161 session->ack_random_factor = value;
162 coap_log_debug("***%s: session ack_random_factor set to %u.%03u\n",
165#if COAP_Q_BLOCK_SUPPORT
166 coap_session_fix_non_probing_wait_base(session);
167 coap_session_fix_non_partial_timeout(session);
168#endif /* COAP_Q_BLOCK_SUPPORT */
169 }
170 return;
171}
172
173void
175 if (value > 0xff)
176 value = 0xff;
177 if (value > 0) {
178 session->max_retransmit = value;
179 coap_log_debug("***%s: session max_retransmit set to %u\n",
180 coap_session_str(session), session->max_retransmit);
181 }
182}
183
184void
185coap_session_set_nstart(coap_session_t *session, uint16_t value) {
186 if (value > 0) {
187 session->nstart = value;
188 coap_log_debug("***%s: session nstart set to %u\n",
189 coap_session_str(session), session->nstart);
190 }
191}
192
193void
195 coap_fixed_point_t value) {
196 if (value.integer_part > 0 && value.fractional_part < 1000) {
197 session->default_leisure = value;
198 coap_log_debug("***%s: session default_leisure set to %u.%03u\n",
201 }
202}
203
204void
206 if (value > 0) {
207 session->probing_rate = value;
208 coap_log_debug("***%s: session probing_rate set to %" PRIu32 "\n",
209 coap_session_str(session), session->probing_rate);
210 }
211}
212
213void
215#if COAP_Q_BLOCK_SUPPORT
216 if (value > 0) {
217 session->max_payloads = value;
218 coap_log_debug("***%s: session max_payloads set to %u\n",
219 coap_session_str(session), session->max_payloads);
220 coap_session_fix_non_probing_wait_base(session);
221 coap_session_fix_non_partial_timeout(session);
222 }
223#else /* ! COAP_Q_BLOCK_SUPPORT */
224 (void)session;
225 (void)value;
226#endif /* ! COAP_Q_BLOCK_SUPPORT */
227}
228
229void
231#if COAP_Q_BLOCK_SUPPORT
232 if (value > 0) {
233 session->non_max_retransmit = value;
234 coap_log_debug("***%s: session non_max_retransmit set to %u\n",
235 coap_session_str(session), session->non_max_retransmit);
236 coap_session_fix_non_probing_wait_base(session);
237 coap_session_fix_non_partial_timeout(session);
238 }
239#else /* ! COAP_Q_BLOCK_SUPPORT */
240 (void)session;
241 (void)value;
242#endif /* ! COAP_Q_BLOCK_SUPPORT */
243}
244
245void
247 coap_fixed_point_t value) {
248#if COAP_Q_BLOCK_SUPPORT
249 if (value.integer_part > 0 && value.fractional_part < 1000) {
250 session->non_timeout = value;
251 coap_log_debug("***%s: session non_timeout set to %u.%03u\n",
252 coap_session_str(session), session->non_timeout.integer_part,
253 session->non_timeout.fractional_part);
254 coap_session_fix_non_probing_wait_base(session);
255 coap_session_fix_non_partial_timeout(session);
256 }
257#else /* ! COAP_Q_BLOCK_SUPPORT */
258 (void)session;
259 (void)value;
260#endif /* ! COAP_Q_BLOCK_SUPPORT */
261}
262
263void
265 coap_fixed_point_t value) {
266#if COAP_Q_BLOCK_SUPPORT
267 if (value.integer_part > 0 && value.fractional_part < 1000)
268 session->non_receive_timeout = value;
269 coap_log_debug("***%s: session non_receive_timeout set to %u.%03u\n",
270 coap_session_str(session),
271 session->non_receive_timeout.integer_part,
272 session->non_receive_timeout.fractional_part);
273#else /* ! COAP_Q_BLOCK_SUPPORT */
274 (void)session;
275 (void)value;
276#endif /* ! COAP_Q_BLOCK_SUPPORT */
277}
278
281 return session->ack_timeout;
282}
283
286 return session->ack_random_factor;
287}
288
289uint16_t
291 return session->max_retransmit;
292}
293
294uint16_t
296 return session->nstart;
297}
298
301 return session->default_leisure;
302}
303
304uint32_t
306 return session->probing_rate;
307}
308
309uint16_t
311#if COAP_Q_BLOCK_SUPPORT
312 return session->max_payloads;
313#else /* ! COAP_Q_BLOCK_SUPPORT */
314 (void)session;
316#endif /* ! COAP_Q_BLOCK_SUPPORT */
317}
318
319uint16_t
321#if COAP_Q_BLOCK_SUPPORT
322 return session->non_max_retransmit;
323#else /* ! COAP_Q_BLOCK_SUPPORT */
324 (void)session;
326#endif /* ! COAP_Q_BLOCK_SUPPORT */
327}
328
331#if COAP_Q_BLOCK_SUPPORT
332 return session->non_timeout;
333#else /* ! COAP_Q_BLOCK_SUPPORT */
334 (void)session;
336#endif /* ! COAP_Q_BLOCK_SUPPORT */
337}
338
341#if COAP_Q_BLOCK_SUPPORT
342 return session->non_receive_timeout;
343#else /* ! COAP_Q_BLOCK_SUPPORT */
344 (void)session;
346#endif /* ! COAP_Q_BLOCK_SUPPORT */
347}
348
351 coap_lock_lock(return NULL);
354 return session;
355}
356
359 ++session->ref;
360 return session;
361}
362
363COAP_API void
365 if (session) {
366#if COAP_THREAD_SAFE
367 coap_context_t *context = session->context;
368 (void)context;
369#endif /* COAP_THREAD_SAFE */
370
371 coap_lock_lock(return);
374 }
375}
376
377void
379 if (session) {
381#ifndef __COVERITY__
382 assert(session->ref > 0);
383 if (session->ref > 0)
384 --session->ref;
385 if (session->ref == 0 && session->type == COAP_SESSION_TYPE_CLIENT)
386 coap_session_free(session);
387#else /* __COVERITY__ */
388 /* Coverity scan is fooled by the reference counter leading to
389 * false positives for USE_AFTER_FREE. */
390 --session->ref;
391 __coverity_negative_sink__(session->ref);
392 /* Indicate that resources are released properly. */
393 if (session->ref == 0 && session->type == COAP_SESSION_TYPE_CLIENT) {
394 __coverity_free__(session);
395 }
396#endif /* __COVERITY__ */
397 }
398}
399
400COAP_API void
401coap_session_set_app_data(coap_session_t *session, void *app_data) {
402 assert(session);
403 coap_lock_lock(return);
404 coap_session_set_app_data2_lkd(session, app_data, NULL);
406}
407
408void *
410 assert(session);
411 return session->app_data;
412}
413
414COAP_API void *
417 void *old_data;
418
419 coap_lock_lock(return NULL);
420 old_data = coap_session_set_app_data2_lkd(session, app_data, callback);
422 return old_data;
423}
424
425void *
428 void *old_data = session->app_data;
429
430 session->app_data = app_data;
431 session->app_cb = app_data ? callback : NULL;
432 return old_data;
433}
434
435static coap_session_t *
437 const coap_addr_hash_t *addr_hash,
438 const coap_address_t *local_addr,
439 const coap_address_t *remote_addr, int ifindex,
440 coap_context_t *context, coap_endpoint_t *endpoint) {
442 sizeof(coap_session_t));
443#if ! COAP_SERVER_SUPPORT
444 (void)endpoint;
445#endif /* ! COAP_SERVER_SUPPORT */
446 if (!session)
447 return NULL;
448 memset(session, 0, sizeof(*session));
449 session->proto = proto;
450 session->type = type;
451 if (addr_hash)
452 memcpy(&session->addr_hash, addr_hash, sizeof(session->addr_hash));
453 else
454 memset(&session->addr_hash, 0, sizeof(session->addr_hash));
455 if (local_addr) {
456 coap_address_copy(&session->addr_info.local, local_addr);
457#if COAP_CLIENT_SUPPORT
458 coap_address_copy(&session->local_reconnect, local_addr);
459#endif /* COAP_CLIENT_SUPPORT */
460 } else {
462#if COAP_CLIENT_SUPPORT
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#endif /* COAP_OSCORE_SUPPORT */
626#if COAP_WS_SUPPORT
627 coap_free_type(COAP_STRING, session->ws);
628 coap_delete_str_const(session->ws_host);
629#endif /* COAP_WS_SUPPORT */
630}
631
632void
634 if (!session)
635 return;
637 assert(session->ref == 0);
638 if (session->ref)
639 return;
640 /* Make sure nothing gets deleted under our feet */
642 coap_session_mfree(session);
643#if COAP_SERVER_SUPPORT
644 coap_delete_bin_const(session->client_cid);
645 if (session->endpoint) {
646 if (session->endpoint->sessions)
647 SESSIONS_DELETE(session->endpoint->sessions, session);
648 } else
649#endif /* COAP_SERVER_SUPPORT */
650#if COAP_CLIENT_SUPPORT
651 if (session->context) {
652 if (session->context->sessions)
653 SESSIONS_DELETE(session->context->sessions, session);
654 }
655 coap_delete_bin_const(session->req_token);
656#endif /* COAP_CLIENT_SUPPORT */
658 coap_delete_bin_const(session->echo);
659#if COAP_SERVER_SUPPORT
660 coap_delete_pdu_lkd(session->cached_pdu);
661#endif /* COAP_SERVER_SUPPORT */
662
663 if (session->app_cb) {
664 coap_lock_callback(session->app_cb(session->app_data));
665 }
666 coap_log_debug("***%s: session %p: closed\n", coap_session_str(session),
667 (void *)session);
668 assert(session->ref == 1);
670}
671
672#if COAP_SERVER_SUPPORT
673void
675 int i;
676
679 coap_cancel_all_messages(session->context, session, NULL);
680 RESOURCES_ITER(session->context->resources, r) {
681 /* In case code is broken somewhere */
682 for (i = 0; i < 1000; i++) {
683 if (!coap_delete_observer(r, session, NULL))
684 break;
685 }
686 }
687 if (session->context->unknown_resource) {
688 /* In case code is broken somewhere */
689 for (i = 0; i < 1000; i++) {
690 if (!coap_delete_observer(session->context->unknown_resource, session, NULL))
691 break;
692 }
693 }
694 if (session->context->proxy_uri_resource) {
695 /* In case code is broken somewhere */
696 for (i = 0; i < 1000; i++) {
697 if (!coap_delete_observer(session->context->proxy_uri_resource, session, NULL))
698 break;
699 }
700 }
701 while (session->delayqueue) {
702 coap_queue_t *q = session->delayqueue;
703
704 session->delayqueue = q->next;
706 }
707 /* Force session to go away */
710
712}
713#endif /* COAP_SERVER_SUPPORT */
714
715static size_t
717 size_t max_with_header) {
718#if COAP_DISABLE_TCP
719 (void)session;
720 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
721 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
722 : 0;
723#else /* !COAP_DISABLE_TCP */
724 if (COAP_PROTO_NOT_RELIABLE(session->proto))
725 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
726 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
727 : 0;
728 /* we must assume there is no token to be on the safe side */
729 if (max_with_header <= 2)
730 return 0;
731 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP0 + 2)
732 return max_with_header - 2;
733 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP8 + 3)
734 return max_with_header - 3;
735 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP16 + 4)
736 return max_with_header - 4;
737 else
738 return max_with_header - COAP_PDU_MAX_TCP_HEADER_SIZE;
739#endif /* !COAP_DISABLE_TCP */
740}
741
742size_t
744 if (session->csm_rcv_mtu)
746 (size_t)(session->csm_rcv_mtu));
747
749 (size_t)(session->mtu - session->tls_overhead));
750}
751
752COAP_API size_t
754 size_t size;
755 coap_session_t *session_rw;
756
757 /*
758 * Need to do this to not get a compiler warning about const parameters
759 * but need to maintain source code backward compatibility
760 */
761 memcpy(&session_rw, &session, sizeof(session_rw));
762 coap_lock_lock(return 0);
763 size = coap_session_max_pdu_size_lkd(session_rw);
765 return size;
766}
767
768size_t
770 size_t max_with_header;
771
773#if COAP_CLIENT_SUPPORT
774 if (COAP_PROTO_RELIABLE(session->proto) &&
775 session->type == COAP_SESSION_TYPE_CLIENT &&
776 session->doing_first) {
777 /*
778 * Delay if session->doing_first is set.
779 * E.g. Reliable and CSM not in yet for checking block support
780 */
781 coap_session_t *session_rw;
782
783 /*
784 * Need to do this to not get a compiler warning about const parameters
785 * but need to maintain source code backward compatibility
786 */
787 memcpy(&session_rw, &session, sizeof(session_rw));
788 if (coap_client_delay_first(session_rw) == 0) {
789 coap_log_debug("coap_client_delay_first: timeout\n");
790 /* Have to go with the defaults */
791 }
792 }
793#endif /* COAP_CLIENT_SUPPORT */
794
795 max_with_header = (size_t)(session->mtu - session->tls_overhead);
796
797 return coap_session_max_pdu_size_internal(session, max_with_header);
798}
799
800void
801coap_session_set_mtu(coap_session_t *session, unsigned mtu) {
804 coap_log_debug("* %s: Restricting MTU size to %u\n",
805 coap_session_str(session), mtu);
806 }
807 if (mtu < 64)
808 mtu = 64;
809 session->mtu = mtu;
810 if (session->tls_overhead >= session->mtu) {
811 session->tls_overhead = session->mtu;
812 coap_log_err("DTLS overhead exceeds MTU\n");
813 }
814}
815
816ssize_t
818 coap_queue_t *node) {
819 if (node) {
820 coap_queue_t *removed = NULL;
821 coap_remove_from_queue(&session->context->sendqueue, session, node->id, &removed);
822 assert(removed == node);
824 node->session = NULL;
825 node->t = 0;
826 } else {
827 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
828 coap_queue_t *q = NULL;
829 /* Check same mid is not getting re-used in violation of RFC7252 */
830 LL_FOREACH(session->delayqueue, q) {
831 if (q->id == pdu->mid) {
832 coap_log_err("** %s: mid=0x%04x: already in-use - dropped\n",
833 coap_session_str(session), pdu->mid);
834 return COAP_INVALID_MID;
835 }
836 }
837 }
838 node = coap_new_node();
839 if (node == NULL)
840 return COAP_INVALID_MID;
841 node->id = pdu->mid;
842 node->pdu = pdu;
843 if (pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
844 uint8_t r;
845 coap_prng_lkd(&r, sizeof(r));
846 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
847 node->timeout = coap_calc_timeout(session, r);
848 }
849 coap_address_copy(&node->remote, &session->addr_info.remote);
850 }
851 LL_APPEND(session->delayqueue, node);
853 coap_log_debug("** %s: mid=0x%04x: delayed\n",
854 coap_session_str(session), node->id);
855 return COAP_PDU_DELAYED;
856}
857
858#if !COAP_DISABLE_TCP
859void
861 coap_pdu_t *pdu;
862 uint8_t buf[4];
863 assert(COAP_PROTO_RELIABLE(session->proto));
864 coap_log_debug("***%s: sending CSM\n", coap_session_str(session));
865 session->state = COAP_SESSION_STATE_CSM;
866 session->partial_write = 0;
867 if (session->mtu == 0)
868 coap_session_set_mtu(session, COAP_DEFAULT_MTU); /* base value */
870 if (pdu == NULL
872 coap_encode_var_safe(buf, sizeof(buf),
873 session->context->csm_max_message_size), buf) == 0
875 coap_encode_var_safe(buf, sizeof(buf),
876 0), buf) == 0
877 || (session->max_token_size > COAP_TOKEN_DEFAULT_MAX &&
880 coap_encode_var_safe(buf, sizeof(buf),
881 session->max_token_size),
882 buf) == 0)
883 || coap_pdu_encode_header(pdu, session->proto) == 0
884 ) {
886 } else {
887 ssize_t bytes_written;
888
889 pdu->session = session;
890 bytes_written = coap_session_send_pdu(session, pdu);
891 if (bytes_written != (ssize_t)pdu->used_size + pdu->hdr_size) {
893 } else {
894 session->csm_rcv_mtu = session->context->csm_max_message_size;
895 if (session->csm_rcv_mtu > COAP_BERT_BASE)
896 session->csm_bert_loc_support = 1;
897 else
898 session->csm_bert_loc_support = 0;
899 }
900 }
901 if (pdu)
903}
904#endif /* !COAP_DISABLE_TCP */
905
908 coap_mid_t mid;
909
911 mid = coap_session_send_ping_lkd(session);
912 if (mid != COAP_INVALID_MID) {
913 coap_tick_t now;
914
915 coap_ticks(&now);
916 session->last_ping_mid = mid;
917 session->last_rx_tx = now;
918 session->last_ping = now;
919 }
921 return mid;
922}
923
926 coap_pdu_t *ping = NULL;
927
929 if (session->state != COAP_SESSION_STATE_ESTABLISHED ||
930 session->con_active)
931 return COAP_INVALID_MID;
932 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
933 uint16_t mid = coap_new_message_id_lkd(session);
934 ping = coap_pdu_init(COAP_MESSAGE_CON, 0, mid, 0);
935 }
936#if !COAP_DISABLE_TCP
937 else {
939 }
940#endif /* !COAP_DISABLE_TCP */
941 if (!ping)
942 return COAP_INVALID_MID;
943 return coap_send_internal(session, ping, NULL);
944}
945
946void
948 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
949 coap_log_debug("***%s: session connected\n",
950 coap_session_str(session));
951 if (session->state == COAP_SESSION_STATE_CSM) {
953#if COAP_CLIENT_SUPPORT
955 coap_reset_doing_first(session);
956#endif /* COAP_CLIENT_SUPPORT */
957 }
958 }
959
961 session->partial_write = 0;
962
963 if (session->proto==COAP_PROTO_DTLS) {
964 session->tls_overhead = coap_dtls_get_overhead(session);
965 if (session->tls_overhead >= session->mtu) {
966 session->tls_overhead = session->mtu;
967 coap_log_err("DTLS overhead exceeds MTU\n");
968 }
969 }
970
971 while (session->delayqueue && session->state == COAP_SESSION_STATE_ESTABLISHED) {
972 ssize_t bytes_written;
973 coap_queue_t *q = session->delayqueue;
974 coap_address_t remote;
975
976 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
977 if (session->con_active >= COAP_NSTART(session))
978 break;
979 session->con_active++;
980 }
981 /* Take entry off the queue */
982 session->delayqueue = q->next;
983 q->next = NULL;
984
985 coap_address_copy(&remote, &session->addr_info.remote);
987 coap_log_debug("** %s: mid=0x%04x: transmitted after delay (2)\n",
988 coap_session_str(session), (int)q->pdu->mid);
989 bytes_written = coap_session_send_pdu(session, q->pdu);
990 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
991 if (coap_wait_ack(session->context, session, q) >= 0)
992 q = NULL;
993 }
994 coap_address_copy(&session->addr_info.remote, &remote);
995 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
996 if (q)
998 if (bytes_written < 0)
999 break;
1000 } else if (q) {
1001 if (bytes_written <= 0 || (size_t)bytes_written < q->pdu->used_size + q->pdu->hdr_size) {
1002 q->next = session->delayqueue;
1003 session->delayqueue = q;
1004 if (bytes_written > 0)
1005 session->partial_write = (size_t)bytes_written;
1006 break;
1007 } else {
1009 }
1010 }
1011 }
1012}
1013
1014#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
1015static const char *
1017 switch (reason) {
1019 return "COAP_NACK_TOO_MANY_RETRIES";
1021 return "COAP_NACK_NOT_DELIVERABLE";
1022 case COAP_NACK_RST:
1023 return "COAP_NACK_RST";
1025 return "COAP_NACK_TLS_FAILED";
1027 return "COAP_NACK_ICMP_ISSUE";
1029 return "COAP_NACK_BAD_RESPONSE";
1031 return "COAP_NACK_TLS_LAYER_FAILED";
1033 return "COAP_NACK_WS_LAYER_FAILED";
1035 return "COAP_NACK_WS_FAILED";
1036 default:
1037 return "???";
1038 }
1039}
1040#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
1041
1042void
1044 coap_pdu_t *sent,
1045 const coap_nack_reason_t reason,
1046 const coap_mid_t mid) {
1047 if (session->context->nack_cb
1049 && !session->doing_first_pdu
1050#endif /* COAP_CLIENT_SUPPORT */
1051 ) {
1052 coap_bin_const_t token = {0, NULL};
1053
1054 if (sent) {
1055 coap_check_update_token(session, sent);
1056 token = sent->actual_token;
1057 }
1058 coap_lock_callback(session->context->nack_cb(session, sent, reason, mid));
1059 if (sent) {
1060 coap_update_token(sent, token.length, token.s);
1061 }
1062 }
1063#if COAP_CLIENT_SUPPORT
1064 if (reason != COAP_NACK_ICMP_ISSUE) {
1065 session->doing_send_recv = 0;
1066 }
1067#endif /* COAP_CLIENT_SUPPORT */
1068}
1069
1070COAP_API void
1076
1077void
1079#if !COAP_DISABLE_TCP
1080 coap_session_state_t state = session->state;
1081#endif /* !COAP_DISABLE_TCP */
1082 coap_lg_xmit_t *lq, *ltmp;
1083#if COAP_SERVER_SUPPORT
1084 coap_lg_srcv_t *sq, *stmp;
1085#endif /* COAP_SERVER_SUPPORT */
1086#if COAP_CLIENT_SUPPORT
1087 coap_lg_crcv_t *cq, *etmp;
1088#endif /* COAP_CLIENT_SUPPORT */
1089 int sent_nack = 0;
1090 coap_queue_t *q;
1091
1093#if COAP_CLIENT_SUPPORT
1094 coap_session_failed(session);
1095#endif /* COAP_CLIENT_SUPPORT */
1096
1097 q = session->context->sendqueue;
1098 while (q) {
1099 if (q->session == session) {
1100 /* Take the first one */
1101 coap_handle_nack(session, q->pdu, reason, q->id);
1102 sent_nack = 1;
1103 break;
1104 }
1105 q = q->next;
1106 }
1107
1108 if (reason != COAP_NACK_ICMP_ISSUE
1110 || session->session_failed
1111#endif /* COAP_CLIENT_SUPPORT */
1112 ) {
1113 while (session->delayqueue) {
1114 q = session->delayqueue;
1115 session->delayqueue = q->next;
1116 q->next = NULL;
1117 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1118 coap_session_str(session), q->id);
1119 if (q->pdu->type == COAP_MESSAGE_CON) {
1120 coap_handle_nack(session, q->pdu, reason, q->id);
1121 sent_nack = 1;
1122 }
1123
1124#if COAP_CLIENT_SUPPORT
1125 session->doing_send_recv = 0;
1126#endif /* COAP_CLIENT_SUPPORT */
1128 }
1129 }
1130#if COAP_CLIENT_SUPPORT
1131 if (!sent_nack && session->lg_crcv) {
1132 /* Take the first one */
1133 coap_handle_nack(session, session->lg_crcv->sent_pdu, reason,
1134 session->lg_crcv->sent_pdu->mid);
1135 sent_nack = 1;
1136 }
1137#endif /* COAP_CLIENT_SUPPORT */
1138 if (!sent_nack) {
1139 /* Unable to determine which request disconnection was for */
1140 coap_handle_nack(session, NULL, reason, 0);
1141 }
1142 if (reason == COAP_NACK_ICMP_ISSUE) {
1143 coap_log_debug("***%s: session ICMP issue (%s)\n",
1144 coap_session_str(session), coap_nack_name(reason));
1145 return;
1146 }
1147 coap_log_debug("***%s: session disconnected (%s)\n",
1148 coap_session_str(session), coap_nack_name(reason));
1149#if COAP_SERVER_SUPPORT
1150 coap_delete_observers(session->context, session);
1151#endif /* COAP_SERVER_SUPPORT */
1152
1153 if (session->proto == COAP_PROTO_UDP)
1155 else
1156 session->state = COAP_SESSION_STATE_NONE;
1157
1158 session->con_active = 0;
1159
1160 if (session->partial_pdu) {
1162 session->partial_pdu = NULL;
1163 }
1164 session->partial_read = 0;
1165
1166 /* Not done if nack handler called above */
1167 while (session->delayqueue) {
1168 q = session->delayqueue;
1169 session->delayqueue = q->next;
1170 q->next = NULL;
1171 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1172 coap_session_str(session), q->id);
1173#if COAP_CLIENT_SUPPORT
1174 session->doing_send_recv = 0;
1175#endif /* COAP_CLIENT_SUPPORT */
1177 }
1178
1179#if COAP_CLIENT_SUPPORT
1180 if (!session->session_failed) {
1181 /* Need to do this before (D)TLS and socket is closed down */
1182 LL_FOREACH_SAFE(session->lg_crcv, cq, etmp) {
1183 LL_DELETE(session->lg_crcv, cq);
1184 coap_block_delete_lg_crcv(session, cq);
1185 }
1186 }
1187#endif /* COAP_CLIENT_SUPPORT */
1188 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
1189 LL_DELETE(session->lg_xmit, lq);
1190 coap_block_delete_lg_xmit(session, lq);
1191 }
1192#if COAP_SERVER_SUPPORT
1193 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
1194 LL_DELETE(session->lg_srcv, sq);
1195 coap_block_delete_lg_srcv(session, sq);
1196 }
1197#endif /* COAP_SERVER_SUPPORT */
1198 coap_cancel_session_messages(session->context, session, reason);
1199
1200#if !COAP_DISABLE_TCP
1201 if (COAP_PROTO_RELIABLE(session->proto)) {
1202 if (coap_netif_available(session)) {
1206 }
1207#if COAP_CLIENT_SUPPORT
1208 if (state != COAP_SESSION_STATE_NONE && !session->session_failed) {
1212 }
1213 coap_reset_doing_first(session);
1214#endif /* COAP_CLIENT_SUPPORT */
1215 }
1216#endif /* !COAP_DISABLE_TCP */
1217 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1218 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1219}
1220
1221#if COAP_CLIENT_SUPPORT
1222void
1224 if (session->context->reconnect_time && session->client_initiated) {
1225 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1226 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1227 session->session_failed = 1;
1229 session->retry_count++;
1230 if (session->context->retry_count && session->retry_count >= session->context->retry_count) {
1232 if (session->type != COAP_SESSION_TYPE_CLIENT) {
1234 coap_session_release_lkd(session);
1235 }
1236 }
1237 coap_ticks(&session->last_rx_tx);
1238 }
1239}
1240#endif /* COAP_CLIENT_SUPPORT */
1241
1242#if COAP_SERVER_SUPPORT
1243static void
1244coap_make_addr_hash(coap_addr_hash_t *addr_hash, coap_proto_t proto,
1245 const coap_addr_tuple_t *addr_info) {
1246 memset(addr_hash, 0, sizeof(coap_addr_hash_t));
1247 coap_address_copy(&addr_hash->remote, &addr_info->remote);
1248 addr_hash->lport = coap_address_get_port(&addr_info->local);
1249 addr_hash->proto = proto;
1250}
1251
1253coap_endpoint_get_session(coap_endpoint_t *endpoint,
1254 const coap_packet_t *packet, coap_tick_t now) {
1255 coap_session_t *session;
1256 coap_session_t *rtmp;
1257 unsigned int num_idle = 0;
1258 unsigned int num_hs = 0;
1259 coap_session_t *oldest = NULL;
1260 coap_session_t *oldest_hs = NULL;
1261 coap_addr_hash_t addr_hash;
1262
1263 coap_make_addr_hash(&addr_hash, endpoint->proto, &packet->addr_info);
1264 SESSIONS_FIND(endpoint->sessions, addr_hash, session);
1265 if (session) {
1266 /* Maybe mcast or unicast IP address which is not in the hash */
1267 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1268 session->ifindex = packet->ifindex;
1269 session->last_rx_tx = now;
1270 return session;
1271 }
1272
1273#if COAP_CLIENT_SUPPORT
1274 SESSIONS_FIND(endpoint->context->sessions, addr_hash, session);
1275 if (session) {
1276 /* Maybe mcast or unicast IP address which is not in the hash */
1277 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1278 session->ifindex = packet->ifindex;
1279 session->last_rx_tx = now;
1280 return session;
1281 }
1282
1283 if (coap_is_mcast(&packet->addr_info.local)) {
1284 /* Check if this a proxy client packet we sent on another socket */
1285 SESSIONS_ITER(endpoint->context->sessions, session, rtmp) {
1286 if (coap_address_equals(&session->addr_info.remote, &packet->addr_info.local) &&
1289 /* Drop looped back packet to stop recursion / confusion */
1290 return NULL;
1291 }
1292 }
1293 }
1294#endif /* COAP_CLIENT_SUPPORT */
1295 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1296 if (session->ref == 0 && session->delayqueue == NULL &&
1297 session->lg_srcv == NULL && session->lg_xmit == NULL) {
1298 if (
1300 !(session->client_initiated && endpoint->context->reconnect_time) &&
1301#endif /* COAP_CLIENT_SUPPORT */
1302 session->type == COAP_SESSION_TYPE_SERVER) {
1303 ++num_idle;
1304 if (oldest==NULL || session->last_rx_tx < oldest->last_rx_tx)
1305 oldest = session;
1306
1307 if (session->state == COAP_SESSION_STATE_HANDSHAKE) {
1308 ++num_hs;
1309 /* See if this is a partial (D)TLS session set up
1310 which needs to be cleared down to prevent DOS */
1311 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1312 if (oldest_hs == NULL ||
1313 session->last_rx_tx < oldest_hs->last_rx_tx)
1314 oldest_hs = session;
1315 }
1316 }
1317 } else if (session->type == COAP_SESSION_TYPE_HELLO) {
1318 ++num_hs;
1319 /* See if this is a partial (D)TLS session set up for Client Hello
1320 which needs to be cleared down to prevent DOS */
1321 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1322 if (oldest_hs == NULL ||
1323 session->last_rx_tx < oldest_hs->last_rx_tx)
1324 oldest_hs = session;
1325 }
1326 }
1327 }
1328 }
1329
1330 if (endpoint->context->max_idle_sessions > 0 &&
1331 num_idle >= endpoint->context->max_idle_sessions) {
1333 coap_session_free(oldest);
1334 } else if (oldest_hs) {
1335 coap_log_warn("***%s: Incomplete session timed out\n",
1336 coap_session_str(oldest_hs));
1338 coap_session_free(oldest_hs);
1339 }
1340
1341 if (num_hs > (endpoint->context->max_handshake_sessions ?
1342 endpoint->context->max_handshake_sessions :
1344 /* Maxed out on number of sessions in (D)TLS negotiation state */
1345 coap_log_debug("Oustanding sessions in COAP_SESSION_STATE_HANDSHAKE too "
1346 "large. New request ignored\n");
1347 return NULL;
1348 }
1349
1350 if (endpoint->proto == COAP_PROTO_DTLS) {
1351 /*
1352 * Need to check that this actually is a Client Hello before wasting
1353 * time allocating and then freeing off session.
1354 */
1355
1356 /*
1357 * Generic header structure of the DTLS record layer.
1358 * typedef struct __attribute__((__packed__)) {
1359 * uint8_t content_type; content type of the included message
1360 * uint16_t version; Protocol version
1361 * uint16_t epoch; counter for cipher state changes
1362 * uint8_t sequence_number[6]; sequence number
1363 * uint16_t length; length of the following fragment
1364 * uint8_t handshake; If content_type == DTLS_CT_HANDSHAKE
1365 * } dtls_record_handshake_t;
1366 */
1367#define OFF_CONTENT_TYPE 0 /* offset of content_type in dtls_record_handshake_t */
1368#define DTLS_CT_ALERT 21 /* Content Type Alert */
1369#define DTLS_CT_HANDSHAKE 22 /* Content Type Handshake */
1370#define OFF_HANDSHAKE_TYPE 13 /* offset of handshake in dtls_record_handshake_t */
1371#define DTLS_HT_CLIENT_HELLO 1 /* Client Hello handshake type */
1372#define DTLS_CT_CID 25 /* Content Type Connection ID */
1373#define OFF_CID 11 /* offset of CID in dtls_record_handshake_t */
1374#define OFF_CID_DTLS13 1 /* offset of CID in DTLS1.3 Unified Header */
1375
1376 const uint8_t *payload = (const uint8_t *)packet->payload;
1377 size_t length = packet->length;
1378 if (length < (OFF_HANDSHAKE_TYPE + 1)) {
1379 coap_log_debug("coap_dtls_hello: ContentType %d Short Packet (%" PRIuS " < %d) dropped\n",
1380 payload[OFF_CONTENT_TYPE], length,
1381 OFF_HANDSHAKE_TYPE + 1);
1382 return NULL;
1383 }
1384 if ((payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 ||
1385 payload[OFF_CONTENT_TYPE] == DTLS_CT_CID) {
1386 /* Client may have changed its IP address */
1387 int changed = 0;
1388
1389 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1390 if (session->client_cid) {
1391 if ((session->is_dtls13 && (payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 &&
1392 length > (OFF_CID_DTLS13 + session->client_cid->length) &&
1393 memcmp(session->client_cid->s, &payload[OFF_CID_DTLS13],
1394 session->client_cid->length) == 0) ||
1395 (!session->is_dtls13 && payload[OFF_CONTENT_TYPE] == DTLS_CT_CID &&
1396 length > (OFF_CID + session->client_cid->length) &&
1397 memcmp(session->client_cid->s, &payload[OFF_CID],
1398 session->client_cid->length) == 0)) {
1399 /* Updating IP address */
1400 coap_log_info("***%s: CID: Old Client Session\n", coap_session_str(session));
1401 SESSIONS_DELETE(endpoint->sessions, session);
1402 session->addr_info = packet->addr_info;
1403 memcpy(&session->addr_hash, &addr_hash, sizeof(session->addr_hash));
1404 SESSIONS_ADD(endpoint->sessions, session);
1405 coap_log_info("***%s: CID: New Client Session\n", coap_session_str(session));
1406 return session;
1407 }
1408 }
1409 }
1410 if (!changed) {
1411 coap_log_debug("coap_dtls_hello: ContentType Connection-IS dropped\n");
1412 return NULL;
1413 }
1414 } else if (payload[OFF_CONTENT_TYPE] != DTLS_CT_HANDSHAKE ||
1415 payload[OFF_HANDSHAKE_TYPE] != DTLS_HT_CLIENT_HELLO) {
1416 /* only log if not a late alert */
1417 if (payload[OFF_CONTENT_TYPE] != DTLS_CT_ALERT)
1418 coap_log_debug("coap_dtls_hello: ContentType %d Handshake %d dropped\n",
1419 payload[OFF_CONTENT_TYPE],
1420 payload[OFF_HANDSHAKE_TYPE]);
1421 return NULL;
1422 }
1423 }
1424
1425 session = coap_make_session(endpoint->proto, COAP_SESSION_TYPE_SERVER,
1426 &addr_hash, &packet->addr_info.local,
1427 &packet->addr_info.remote,
1428 packet->ifindex, endpoint->context, endpoint);
1429 if (session) {
1430 session->last_rx_tx = now;
1431 memcpy(session->sock.lfunc, endpoint->sock.lfunc,
1432 sizeof(session->sock.lfunc));
1433 if (endpoint->proto == COAP_PROTO_UDP)
1435 else if (endpoint->proto == COAP_PROTO_DTLS) {
1436 session->type = COAP_SESSION_TYPE_HELLO;
1437 }
1438 SESSIONS_ADD(endpoint->sessions, session);
1439 coap_log_debug("***%s: session %p: new incoming session\n",
1440 coap_session_str(session), (void *)session);
1442 }
1443 return session;
1444}
1445
1448 coap_tick_t now) {
1449 if (session) {
1450 session->last_rx_tx = now;
1451 session->type = COAP_SESSION_TYPE_SERVER;
1452 coap_dtls_establish(session);
1453 }
1454 return session;
1455}
1456#endif /* COAP_SERVER_SUPPORT */
1457
1458#if COAP_CLIENT_SUPPORT
1459static coap_session_t *
1460coap_session_create_client(coap_context_t *ctx,
1461 const coap_address_t *local_if,
1462 const coap_address_t *server,
1463 coap_proto_t proto,
1464 void *app_data,
1466 coap_str_const_t *ws_host) {
1467 coap_session_t *session = NULL;
1468 int default_port = COAP_DEFAULT_PORT;
1469
1470 assert(server);
1471
1472 switch (proto) {
1473 case COAP_PROTO_UDP:
1474 default_port = COAP_DEFAULT_PORT;
1475 break;
1476 case COAP_PROTO_DTLS:
1477 if (!coap_dtls_is_supported()) {
1478 coap_log_crit("coap_new_client_session*: DTLS not supported\n");
1479 return NULL;
1480 }
1481 default_port = COAPS_DEFAULT_PORT;
1482 break;
1483 case COAP_PROTO_TCP:
1484 if (!coap_tcp_is_supported()) {
1485 coap_log_crit("coap_new_client_session*: TCP not supported\n");
1486 return NULL;
1487 }
1488 default_port = COAP_DEFAULT_PORT;
1489 break;
1490 case COAP_PROTO_TLS:
1491 if (!coap_tls_is_supported()) {
1492 coap_log_crit("coap_new_client_session*: TLS not supported\n");
1493 return NULL;
1494 }
1495 default_port = COAPS_DEFAULT_PORT;
1496 break;
1497 case COAP_PROTO_WS:
1498 if (!coap_ws_is_supported()) {
1499 coap_log_crit("coap_new_client_session*: WS not supported\n");
1500 return NULL;
1501 }
1502 default_port = 80;
1503 break;
1504 case COAP_PROTO_WSS:
1505 if (!coap_wss_is_supported()) {
1506 coap_log_crit("coap_new_client_session*: WSS not supported\n");
1507 return NULL;
1508 }
1509 default_port = 443;
1510 break;
1511 case COAP_PROTO_NONE:
1512 case COAP_PROTO_LAST:
1513 default:
1514 assert(0);
1515 return NULL;
1516 }
1518 local_if, server, 0, ctx, NULL);
1519 if (!session)
1520 goto error;
1521
1523 session->sock.session = session;
1524 memcpy(&session->sock.lfunc, coap_layers_coap[proto],
1525 sizeof(session->sock.lfunc));
1526
1527 session->app_data = app_data;
1528 session->app_cb = app_data ? callback : NULL;
1529#if COAP_WS_SUPPORT
1530 if (ws_host) {
1531 session->ws_host = coap_new_str_const(ws_host->s, ws_host->length);
1532 }
1533#else /* ! COAP_WS_SUPPORT */
1534 (void)ws_host;
1535#endif /* ! COAP_WS_SUPPORT */
1536
1537 if (COAP_PROTO_NOT_RELIABLE(proto)) {
1538 coap_session_t *s, *rtmp;
1539 if (!coap_netif_dgrm_connect(session, local_if, server, default_port)) {
1540 goto error;
1541 }
1542 /* Check that this is not a duplicate 4-tuple */
1543 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
1546 &s->addr_info.local) &&
1548 &s->addr_info.remote)) {
1549 coap_log_warn("***%s: session %p: duplicate - already exists\n",
1550 coap_session_str(session), (void *)session);
1551 goto error;
1552 }
1553 }
1554#ifdef WITH_CONTIKI
1555 session->sock.context = ctx;
1556#endif /* WITH_CONTIKI */
1557#if !COAP_DISABLE_TCP
1558 } else if (COAP_PROTO_RELIABLE(proto)) {
1559 if (!coap_netif_strm_connect1(session, local_if, server, default_port)) {
1560 goto error;
1561 }
1562#endif /* !COAP_DISABLE_TCP */
1563 }
1564
1565 session->sock.session = session;
1566#ifdef COAP_EPOLL_SUPPORT
1567 coap_epoll_ctl_add(&session->sock,
1568 EPOLLIN |
1569 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1570 EPOLLOUT : 0),
1571 __func__);
1572#endif /* COAP_EPOLL_SUPPORT */
1573
1575 if (local_if)
1576 session->sock.flags |= COAP_SOCKET_BOUND;
1577#if COAP_SERVER_SUPPORT
1578 if (ctx->proxy_uri_resource)
1579 session->proxy_session = 1;
1580#endif /* COAP_SERVER_SUPPORT */
1581 SESSIONS_ADD(ctx->sessions, session);
1582 return session;
1583
1584error:
1585 /*
1586 * Need to add in the session as coap_session_release_lkd()
1587 * will call SESSIONS_DELETE in coap_session_free().
1588 */
1589 if (session)
1590 SESSIONS_ADD(ctx->sessions, session);
1591 coap_session_release_lkd(session);
1592 return NULL;
1593}
1594
1595static void
1596coap_session_check_connect(coap_session_t *session) {
1597 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1598 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1599 }
1600#if !COAP_DISABLE_TCP
1601 if (COAP_PROTO_RELIABLE(session->proto)) {
1602 if (session->sock.flags & COAP_SOCKET_WANT_CONNECT) {
1604 if (session->client_initiated) {
1605 session->doing_first = 1;
1606 }
1607 } else {
1608 /* Initial connect worked immediately */
1609 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1610 }
1611 }
1612#endif /* !COAP_DISABLE_TCP */
1613 coap_ticks(&session->last_rx_tx);
1614}
1615#endif /* COAP_CLIENT_SUPPORT */
1616
1617void
1619 if (COAP_PROTO_NOT_RELIABLE(session->proto))
1620 coap_session_connected(session);
1621#if !COAP_DISABLE_TCP
1622 if (COAP_PROTO_RELIABLE(session->proto))
1623 coap_session_send_csm(session);
1624#endif /* !COAP_DISABLE_TCP */
1625}
1626
1627#if COAP_CLIENT_SUPPORT
1628int
1630 int default_port = COAP_DEFAULT_PORT;
1631
1632 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close && !session->session_failed)
1633 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1634
1635 switch (session->proto) {
1636 case COAP_PROTO_UDP:
1637 default_port = COAP_DEFAULT_PORT;
1638 break;
1639 case COAP_PROTO_DTLS:
1640 default_port = COAPS_DEFAULT_PORT;
1641 break;
1642 case COAP_PROTO_TCP:
1643 default_port = COAP_DEFAULT_PORT;
1644 break;
1645 case COAP_PROTO_TLS:
1646 default_port = COAPS_DEFAULT_PORT;
1647 break;
1648 case COAP_PROTO_WS:
1649 default_port = 80;
1650 break;
1651 case COAP_PROTO_WSS:
1652 default_port = 443;
1653 break;
1654 case COAP_PROTO_NONE:
1655 case COAP_PROTO_LAST:
1656 default:
1657 assert(0);
1658 return 0;
1659 }
1660 session->sock.session = session;
1661 coap_log_debug("***%s: trying to reconnect\n", coap_session_str(session));
1663 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1664 session->state = COAP_SESSION_STATE_NONE;
1665 if (!coap_netif_dgrm_connect(session, &session->local_reconnect, &session->addr_info.remote,
1666 default_port)) {
1667 goto error;
1668 }
1670#ifdef WITH_CONTIKI
1671 session->sock.context = session->context;
1672#endif /* WITH_CONTIKI */
1673#if !COAP_DISABLE_TCP
1674 } else if (COAP_PROTO_RELIABLE(session->proto)) {
1675 if (!coap_netif_strm_connect1(session, &session->local_reconnect, &session->addr_info.remote,
1676 default_port)) {
1677 goto error;
1678 }
1679#endif /* !COAP_DISABLE_TCP */
1680 } else {
1681 goto error;
1682 }
1683#ifdef COAP_EPOLL_SUPPORT
1684 coap_epoll_ctl_add(&session->sock,
1685 EPOLLIN |
1686 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1687 EPOLLOUT : 0),
1688 __func__);
1689#endif /* COAP_EPOLL_SUPPORT */
1690
1692 session->sock.flags |= COAP_SOCKET_BOUND;
1693 coap_session_check_connect(session);
1694 return 1;
1695error:
1696 return 0;
1697}
1698
1699void
1701 coap_lg_crcv_t *lg_crcv, *etmp;
1702
1703 if (!session->session_failed)
1704 return;
1705 coap_log_debug("***%s: session re-established\n",
1706 coap_session_str(session));
1707 session->session_failed = 0;
1708 session->retry_count = 0;
1710 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
1711 coap_pdu_reference_lkd(lg_crcv->sent_pdu);
1712 coap_send_internal(session, lg_crcv->sent_pdu, NULL);
1713 }
1714}
1715
1718 const coap_address_t *local_if,
1719 const coap_address_t *server,
1720 coap_proto_t proto) {
1721 coap_session_t *session;
1722
1723 coap_lock_lock(return NULL);
1724 session = coap_new_client_session3_lkd(ctx, local_if, server, proto, NULL, NULL, NULL);
1726 return session;
1727}
1728
1731 const coap_address_t *local_if,
1732 const coap_address_t *server,
1733 coap_proto_t proto,
1734 void *app_data,
1736 coap_str_const_t *ws_host) {
1737 coap_session_t *session;
1738
1739 coap_lock_lock(return NULL);
1740 session = coap_new_client_session3_lkd(ctx, local_if, server, proto, app_data, callback, ws_host);
1742 return session;
1743}
1744
1747 const coap_address_t *local_if,
1748 const coap_address_t *server,
1749 coap_proto_t proto,
1750 void *app_data,
1752 coap_str_const_t *ws_host) {
1753 coap_session_t *session;
1754
1756 session = coap_session_create_client(ctx, local_if, server,
1757 proto, app_data, callback, ws_host);
1758 if (session) {
1759 coap_log_debug("***%s: session %p: created outgoing session\n",
1760 coap_session_str(session), (void *)session);
1761 coap_session_check_connect(session);
1762 }
1763 return session;
1764}
1765
1768 const coap_address_t *local_if,
1769 const coap_address_t *server,
1770 coap_proto_t proto, const char *identity,
1771 const uint8_t *key, unsigned key_len) {
1772 coap_session_t *session;
1773
1774 coap_lock_lock(return NULL);
1775 session = coap_new_client_session_psk_lkd(ctx, local_if, server, proto, identity, key, key_len);
1777 return session;
1778}
1779
1782 const coap_address_t *local_if,
1783 const coap_address_t *server,
1784 coap_proto_t proto, const char *identity,
1785 const uint8_t *key, unsigned key_len) {
1786 coap_dtls_cpsk_t setup_data;
1787
1789 memset(&setup_data, 0, sizeof(setup_data));
1791
1792 if (identity) {
1793 setup_data.psk_info.identity.s = (const uint8_t *)identity;
1794 setup_data.psk_info.identity.length = strlen(identity);
1795 }
1796
1797 if (key && key_len > 0) {
1798 setup_data.psk_info.key.s = key;
1799 setup_data.psk_info.key.length = key_len;
1800 }
1801
1802 return coap_new_client_session_psk3_lkd(ctx, local_if, server,
1803 proto, &setup_data, NULL, NULL, NULL);
1804}
1805
1806/*
1807 * Check the validity of the SNI to send to the server.
1808 *
1809 * https://datatracker.ietf.org/doc/html/rfc6066#section-3
1810 * Literal IPv4 and IPv6 addresses are not permitted in "HostName".
1811 */
1812static void
1813coap_sanitize_client_sni(char **client_sni) {
1814 char *cp;
1815
1816 if (*client_sni == NULL)
1817 return;
1818
1819 cp = *client_sni;
1820 switch (*cp) {
1821 case '0':
1822 case '1':
1823 case '2':
1824 case '3':
1825 case '4':
1826 case '5':
1827 case '6':
1828 case '7':
1829 case '8':
1830 case '9':
1831 case 'a':
1832 case 'b':
1833 case 'c':
1834 case 'd':
1835 case 'e':
1836 case 'f':
1837 case 'A':
1838 case 'B':
1839 case 'C':
1840 case 'D':
1841 case 'E':
1842 case 'F':
1843 case ':':
1844 break;
1845 case '\000':
1846 /* Empty entry invalid */
1847 *client_sni = NULL;
1848 return;
1849 default:
1850 /* Does not start with a hex digit or : - not literal IP. */
1851 return;
1852 }
1853 /* Check for IPv4 */
1854 while (*cp) {
1855 switch (*cp) {
1856 case '0':
1857 case '1':
1858 case '2':
1859 case '3':
1860 case '4':
1861 case '5':
1862 case '6':
1863 case '7':
1864 case '8':
1865 case '9':
1866 case '.':
1867 break;
1868 default:
1869 /* Not of format nnn.nnn.nnn.nnn. Could be IPv6 */
1870 goto check_ipv6;
1871 }
1872 cp++;
1873 }
1874 /* IPv4 address - not allowed. */
1875 *client_sni = NULL;
1876 return;
1877
1878check_ipv6:
1879 /* Check for IPv6 */
1880 cp = *client_sni;
1881 while (*cp) {
1882 switch (*cp) {
1883 case '0':
1884 case '1':
1885 case '2':
1886 case '3':
1887 case '4':
1888 case '5':
1889 case '6':
1890 case '7':
1891 case '8':
1892 case '9':
1893 case 'a':
1894 case 'b':
1895 case 'c':
1896 case 'd':
1897 case 'e':
1898 case 'f':
1899 case 'A':
1900 case 'B':
1901 case 'C':
1902 case 'D':
1903 case 'E':
1904 case 'F':
1905 case ':':
1906 break;
1907 case '%':
1908 /* Start of i/f specification, Previous is IPv6 */
1909 *client_sni = NULL;
1910 return;
1911 default:
1912 /* Not of format xx:xx::xx. */
1913 return;
1914 }
1915 cp++;
1916 }
1917 *client_sni = NULL;
1918 return;
1919}
1920
1923 const coap_address_t *local_if,
1924 const coap_address_t *server,
1925 coap_proto_t proto,
1926 coap_dtls_cpsk_t *setup_data) {
1927 coap_session_t *session;
1928
1929 coap_lock_lock(return NULL);
1930 session = coap_new_client_session_psk3_lkd(ctx, local_if, server, proto, setup_data,
1931 NULL, NULL, NULL);
1933 return session;
1934}
1935
1938 const coap_address_t *local_if,
1939 const coap_address_t *server,
1940 coap_proto_t proto,
1941 coap_dtls_cpsk_t *setup_data,
1942 void *app_data,
1944 coap_str_const_t *ws_host) {
1945 coap_session_t *session;
1946
1947 coap_lock_lock(return NULL);
1948 session = coap_new_client_session_psk3_lkd(ctx, local_if, server, proto,
1949 setup_data, app_data, callback, ws_host);
1951 return session;
1952}
1953
1956 const coap_address_t *local_if,
1957 const coap_address_t *server,
1958 coap_proto_t proto,
1959 coap_dtls_cpsk_t *setup_data,
1960 void *app_data,
1962 coap_str_const_t *ws_host) {
1963 coap_session_t *session;
1964
1966 session = coap_session_create_client(ctx, local_if, server, proto, app_data, callback, ws_host);
1967
1968 if (!session || !setup_data)
1969 return NULL;
1970
1971 session->cpsk_setup_data = *setup_data;
1972 if (setup_data->psk_info.identity.s) {
1973 session->psk_identity =
1975 setup_data->psk_info.identity.length);
1976 if (!session->psk_identity) {
1977 coap_log_warn("Cannot store session Identity (PSK)\n");
1978 coap_session_release_lkd(session);
1979 return NULL;
1980 }
1982 coap_log_warn("Identity (PSK) not defined\n");
1983 coap_session_release_lkd(session);
1984 return NULL;
1985 }
1986
1987 if (setup_data->psk_info.key.s && setup_data->psk_info.key.length > 0) {
1988 session->psk_key = coap_new_bin_const(setup_data->psk_info.key.s,
1989 setup_data->psk_info.key.length);
1990 if (!session->psk_key) {
1991 coap_log_warn("Cannot store session pre-shared key (PSK)\n");
1992 coap_session_release_lkd(session);
1993 return NULL;
1994 }
1996 coap_log_warn("Pre-shared key (PSK) not defined\n");
1997 coap_session_release_lkd(session);
1998 return NULL;
1999 }
2000
2001 coap_sanitize_client_sni(&session->cpsk_setup_data.client_sni);
2002
2004 if (!coap_dtls_context_set_cpsk(ctx, &session->cpsk_setup_data)) {
2005 coap_session_release_lkd(session);
2006 return NULL;
2007 }
2008 }
2009 coap_log_debug("***%s: new outgoing session\n",
2010 coap_session_str(session));
2011 coap_session_check_connect(session);
2012 return session;
2013}
2014#endif /* COAP_CLIENT_SUPPORT */
2015
2016int
2018 const coap_bin_const_t *psk_hint
2019 ) {
2020 /* We may be refreshing the hint with the same hint */
2021 coap_bin_const_t *old_psk_hint = session->psk_hint;
2022
2023 if (psk_hint && psk_hint->s) {
2024 if (session->psk_hint) {
2025 if (coap_binary_equal(session->psk_hint, psk_hint))
2026 return 1;
2027 }
2028 session->psk_hint = coap_new_bin_const(psk_hint->s,
2029 psk_hint->length);
2030 if (!session->psk_hint) {
2031 coap_log_err("No memory to store identity hint (PSK)\n");
2032 if (old_psk_hint)
2033 coap_delete_bin_const(old_psk_hint);
2034 return 0;
2035 }
2036 } else {
2037 session->psk_hint = NULL;
2038 }
2039 if (old_psk_hint)
2040 coap_delete_bin_const(old_psk_hint);
2041
2042 return 1;
2043}
2044
2045int
2047 const coap_bin_const_t *psk_key
2048 ) {
2049 /* We may be refreshing the key with the same key */
2050 coap_bin_const_t *old_psk_key = session->psk_key;
2051
2052 if (psk_key && psk_key->s) {
2053 if (session->psk_key) {
2054 if (coap_binary_equal(session->psk_key, psk_key))
2055 return 1;
2056 }
2057 session->psk_key = coap_new_bin_const(psk_key->s, psk_key->length);
2058 if (!session->psk_key) {
2059 coap_log_err("No memory to store pre-shared key (PSK)\n");
2060 if (old_psk_key)
2061 coap_delete_bin_const(old_psk_key);
2062 return 0;
2063 }
2064 } else {
2065 session->psk_key = NULL;
2066 }
2067 if (old_psk_key)
2068 coap_delete_bin_const(old_psk_key);
2069
2070 return 1;
2071}
2072
2073int
2075 const coap_bin_const_t *psk_identity
2076 ) {
2077 /* We may be refreshing the identity with the same identity */
2078 coap_bin_const_t *old_psk_identity = session->psk_identity;
2079
2080 if (psk_identity && psk_identity->s) {
2081 if (session->psk_identity) {
2082 if (coap_binary_equal(session->psk_identity, psk_identity))
2083 return 1;
2084 }
2085 session->psk_identity = coap_new_bin_const(psk_identity->s,
2086 psk_identity->length);
2087 if (!session->psk_identity) {
2088 coap_log_err("No memory to store pre-shared key identity (PSK)\n");
2089 if (old_psk_identity)
2090 coap_delete_bin_const(old_psk_identity);
2091 return 0;
2092 }
2093 } else {
2094 session->psk_identity = NULL;
2095 }
2096 if (old_psk_identity)
2097 coap_delete_bin_const(old_psk_identity);
2098
2099 return 1;
2100}
2101
2102#if COAP_SERVER_SUPPORT
2103const coap_bin_const_t *
2105 if (session)
2106 return session->psk_hint;
2107 return NULL;
2108}
2109#endif /* COAP_SERVER_SUPPORT */
2110
2111const coap_bin_const_t *
2113 const coap_bin_const_t *psk_identity = NULL;
2114 if (session) {
2115 psk_identity = session->psk_identity;
2116 if (psk_identity == NULL) {
2117 psk_identity = &session->cpsk_setup_data.psk_info.identity;
2118 }
2119 }
2120 return psk_identity;
2121}
2122
2123const coap_bin_const_t *
2125 if (session)
2126 return session->psk_key;
2127 return NULL;
2128}
2129
2130#if COAP_CLIENT_SUPPORT
2133 const coap_address_t *local_if,
2134 const coap_address_t *server,
2135 coap_proto_t proto,
2136 coap_dtls_pki_t *setup_data) {
2137 coap_session_t *session;
2138
2139 coap_lock_lock(return NULL);
2140 session = coap_new_client_session_pki3_lkd(ctx, local_if, server, proto, setup_data,
2141 NULL, NULL, NULL);
2143 return session;
2144}
2145
2148 const coap_address_t *local_if,
2149 const coap_address_t *server,
2150 coap_proto_t proto,
2151 coap_dtls_pki_t *setup_data,
2152 void *app_data,
2154 coap_str_const_t *ws_host) {
2155 coap_session_t *session;
2156
2157 coap_lock_lock(return NULL);
2158 session = coap_new_client_session_pki3_lkd(ctx, local_if, server, proto, setup_data,
2159 app_data, callback, ws_host);
2161 return session;
2162}
2163
2166 const coap_address_t *local_if,
2167 const coap_address_t *server,
2168 coap_proto_t proto,
2169 coap_dtls_pki_t *setup_data,
2170 void *app_data,
2172 coap_str_const_t *ws_host) {
2173 coap_session_t *session;
2174 coap_dtls_pki_t l_setup_data;
2175
2176 if (!setup_data)
2177 return NULL;
2178 if (setup_data->version != COAP_DTLS_PKI_SETUP_VERSION) {
2179 coap_log_err("coap_new_client_session_pki: Wrong version of setup_data\n");
2180 return NULL;
2181 }
2182
2184 l_setup_data = *setup_data;
2185 coap_sanitize_client_sni(&l_setup_data.client_sni);
2186
2187 session = coap_session_create_client(ctx, local_if, server, proto, app_data, callback, ws_host);
2188
2189 if (!session) {
2190 return NULL;
2191 }
2192
2194 /* we know that setup_data is not NULL */
2195 if (!coap_dtls_context_set_pki(ctx, &l_setup_data, COAP_DTLS_ROLE_CLIENT)) {
2196 coap_session_release_lkd(session);
2197 return NULL;
2198 }
2199 }
2200 coap_log_debug("***%s: new outgoing session\n",
2201 coap_session_str(session));
2202 coap_session_check_connect(session);
2203 return session;
2204}
2205#endif /* ! COAP_CLIENT_SUPPORT */
2206
2207#if COAP_SERVER_SUPPORT
2208#if !COAP_DISABLE_TCP
2210coap_new_server_session(coap_context_t *ctx, coap_endpoint_t *ep, void *extra) {
2211 coap_session_t *session;
2212 coap_tick_t now;
2213
2214 session = coap_make_session(ep->proto, COAP_SESSION_TYPE_SERVER,
2215 NULL, NULL, NULL, 0, ctx, ep);
2216 if (!session)
2217 goto error;
2218
2219 memcpy(session->sock.lfunc, ep->sock.lfunc, sizeof(session->sock.lfunc));
2220 if (!coap_netif_strm_accept(ep, session, extra))
2221 goto error;
2222
2223 coap_make_addr_hash(&session->addr_hash, session->proto, &session->addr_info);
2224
2225 session->sock.session = session;
2226#ifdef COAP_EPOLL_SUPPORT
2227 coap_epoll_ctl_add(&session->sock,
2228 EPOLLIN,
2229 __func__);
2230#endif /* COAP_EPOLL_SUPPORT */
2231 SESSIONS_ADD(ep->sessions, session);
2232 if (session) {
2233 coap_ticks(&now);
2234 session->last_rx_tx = now;
2235 coap_log_debug("***%s: session %p: new incoming session\n",
2236 coap_session_str(session), (void *)session);
2240 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
2241 }
2242 return session;
2243
2244error:
2245 /*
2246 * Need to add in the session as coap_session_release_lkd()
2247 * will call SESSIONS_DELETE in coap_session_free().
2248 */
2249 if (session) {
2250 SESSIONS_ADD(ep->sessions, session);
2251 coap_session_free(session);
2252 }
2253 return NULL;
2254}
2255#endif /* !COAP_DISABLE_TCP */
2256#endif /* COAP_SERVER_SUPPORT */
2257
2258void
2260 const uint8_t *data) {
2261 session->tx_token = coap_decode_var_bytes8(data, len);
2262 /*
2263 * Decrement as when first used by coap_session_new_token() it will
2264 * get incremented
2265 */
2266 session->tx_token--;
2267}
2268
2269void
2271 uint8_t *data) {
2272 *len = coap_encode_var_safe8(data,
2273 sizeof(session->tx_token), ++session->tx_token);
2274}
2275
2276COAP_API uint16_t
2278 uint16_t mid;
2279
2280 coap_lock_lock(return 0);
2281 mid = coap_new_message_id_lkd(session);
2283 return mid;
2284}
2285
2286uint16_t
2289 if (COAP_PROTO_NOT_RELIABLE(session->proto))
2290 return ++session->tx_mid;
2291 /* TCP/TLS have no notion of mid */
2292 return 0;
2293}
2294
2295const coap_address_t *
2297 if (session)
2298 return &session->addr_info.remote;
2299 return NULL;
2300}
2301
2302const coap_address_t *
2304 if (session)
2305 return &session->addr_info.local;
2306 return NULL;
2307}
2308
2309const coap_address_t *
2311#if COAP_CLIENT_SUPPORT
2312 if (session && session->type == COAP_SESSION_TYPE_CLIENT &&
2313 session->sock.flags & COAP_SOCKET_MULTICAST)
2314 return &session->sock.mcast_addr;
2315#else /* ! COAP_CLIENT_SUPPORT */
2316 (void)session;
2317#endif /* ! COAP_CLIENT_SUPPORT */
2318 return NULL;
2319}
2320
2323 if (session)
2324 return session->context;
2325 return NULL;
2326}
2327
2330 if (session)
2331 return session->proto;
2332 return 0;
2333}
2334
2337 if (session)
2338 return session->type;
2339 return 0;
2340}
2341
2342int
2344#if COAP_OSCORE_SUPPORT
2345 return (session && session->oscore_encryption != 0) ? 1 : 0;
2346#else
2347 (void)session;
2348 return 0;
2349#endif
2350}
2351
2352COAP_API int
2354 int ret;
2355
2356 coap_lock_lock(return 0);
2357 ret = coap_session_set_type_client_lkd(session, 1);
2359 return ret;
2360}
2361
2362int
2364#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2365 if (session && session->type == COAP_SESSION_TYPE_SERVER) {
2367 session->type = COAP_SESSION_TYPE_CLIENT;
2368 if (session->endpoint) {
2369 SESSIONS_DELETE(session->endpoint->sessions, session);
2370 SESSIONS_ADD(session->context->sessions, session);
2371 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
2372 session->sock = session->endpoint->sock;
2373 session->sock.flags |= COAP_SOCKET_SLAVE;
2374 session->sock.flags &= ~COAP_SOCKET_CAN_READ;
2375 session->sock.flags &= ~COAP_SOCKET_WANT_READ;
2376 } else {
2377 session->sock.endpoint = NULL;
2378 }
2379 session->endpoint = NULL;
2380 }
2381 if (report_changed) {
2382 coap_log_debug("***%s: session now is type Client\n",
2383 coap_session_str(session));
2384 }
2385 return 1;
2386 }
2387#else /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2388 (void)session;
2389 (void)report_changed;
2390#endif /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2391 return 0;
2392}
2393
2394COAP_API int
2396 int ret;
2397
2398 coap_lock_lock(return 0);
2399 ret = coap_session_set_type_server_lkd(session);
2401 return ret;
2402}
2403
2404int
2406#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2407 if (session && session->type == COAP_SESSION_TYPE_CLIENT) {
2408 coap_endpoint_t *ep;
2409 coap_mid_t mid;
2410 coap_pdu_t *ping = NULL;
2411
2412 LL_FOREACH(session->context->endpoint, ep) {
2413 if (session->proto == ep->proto)
2414 break;
2415 }
2416 if (!ep) {
2417 /* Need a dummy endpoint to 'hang' off as this is now a server */
2418 ep = coap_malloc_endpoint();
2419 if (!ep) {
2420 coap_log_warn("coap_new_endpoint: malloc");
2421 return 0;
2422 }
2423
2424 memset(ep, 0, sizeof(coap_endpoint_t));
2425 ep->context = session->context;
2426 ep->proto = session->proto;
2427 ep->sock.endpoint = ep;
2428 memcpy(&ep->sock.lfunc, coap_layers_coap[session->proto], sizeof(ep->sock.lfunc));
2429
2430 ep->default_mtu = COAP_DEFAULT_MTU;
2431 LL_PREPEND(session->context->endpoint, ep);
2432 }
2433 /* Need to use coap_send_lkd() here to get traffic flowing */
2434 if (session->proto == COAP_PROTO_UDP) {
2436 coap_new_message_id_lkd(session), 0);
2437 if (!ping) {
2438 session->type = COAP_SESSION_TYPE_SERVER;
2439 return 0;
2440 }
2441 mid = coap_send_lkd(session, ping);
2442 if (mid != COAP_INVALID_MID) {
2443 coap_tick_t now;
2444
2445 coap_ticks(&now);
2446 session->last_ping_mid = mid;
2447 session->last_rx_tx = now;
2448 session->last_ping = now;
2449 }
2450 }
2451 /*
2452 * (D)TLS will initiate traffic with handshake.
2453 * Reliable protocols will be sending a CSM, so no nead for Ping.
2454 */
2455 if (session->context) {
2456 if (session->context->sessions) {
2457 SESSIONS_DELETE(session->context->sessions, session);
2458 }
2459 }
2460 SESSIONS_ADD(ep->sessions, session);
2461 session->endpoint = ep;
2462 session->type = COAP_SESSION_TYPE_SERVER;
2463 coap_session_release_lkd(session);
2464 coap_log_debug("***%s: session now is type Server\n",
2465 coap_session_str(session));
2466 return 1;
2467 }
2468#else /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2469 (void)session;
2470#endif /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2471 return 0;
2472}
2473
2476 if (session)
2477 return session->state;
2478 return 0;
2479}
2480
2483#if COAP_SERVER_SUPPORT
2484 if (session)
2485 return session->endpoint;
2486#else /* ! COAP_SERVER_SUPPORT */
2487 (void)session;
2488#endif /* ! COAP_SERVER_SUPPORT */
2489 return 0;
2490}
2491
2492int
2494 if (session)
2495 return session->ifindex;
2496 return -1;
2497}
2498
2499void *
2501 coap_tls_library_t *tls_lib) {
2502 if (session)
2503 return coap_dtls_get_tls(session, tls_lib);
2504 return NULL;
2505}
2506
2507static const char *
2509 switch (proto) {
2510 case COAP_PROTO_UDP:
2511 return "UDP ";
2512 case COAP_PROTO_DTLS:
2513 return "DTLS";
2514 case COAP_PROTO_TCP:
2515 return "TCP ";
2516 case COAP_PROTO_TLS:
2517 return "TLS ";
2518 case COAP_PROTO_WS:
2519 return "WS ";
2520 case COAP_PROTO_WSS:
2521 return "WSS ";
2522 case COAP_PROTO_NONE:
2523 case COAP_PROTO_LAST:
2524 default:
2525 return "????" ;
2526 break;
2527 }
2528 return NULL;
2529}
2530
2531#if COAP_SERVER_SUPPORT
2533coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto) {
2534 coap_endpoint_t *endpoint;
2535
2536 coap_lock_lock(return NULL);
2537 endpoint = coap_new_endpoint_lkd(context, listen_addr, proto);
2539 return endpoint;
2540}
2541
2543coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr,
2544 coap_proto_t proto) {
2545 coap_endpoint_t *ep = NULL;
2546
2547 if (!context || !listen_addr) {
2548 coap_log_debug("coap_new_endpoint: Both context and listen_addr need to be defined\n");
2549 return NULL;
2550 }
2551
2553
2554 switch (proto) {
2555 case COAP_PROTO_UDP:
2556 break;
2557 case COAP_PROTO_DTLS:
2558 if (!coap_dtls_is_supported()) {
2559 coap_log_warn("coap_new_endpoint: DTLS not supported\n");
2560 return NULL;
2561 }
2562 break;
2563 case COAP_PROTO_TLS:
2564 if (!coap_tls_is_supported()) {
2565 coap_log_warn("coap_new_endpoint: TLS not supported\n");
2566 return NULL;
2567 }
2568 break;
2569 case COAP_PROTO_TCP:
2570 if (!coap_tcp_is_supported()) {
2571 coap_log_warn("coap_new_endpoint: TCP not supported\n");
2572 return NULL;
2573 }
2574 break;
2575 case COAP_PROTO_WS:
2576 if (!coap_ws_is_supported()) {
2577 coap_log_warn("coap_new_endpoint: WS not supported\n");
2578 return NULL;
2579 }
2580 break;
2581 case COAP_PROTO_WSS:
2582 if (!coap_wss_is_supported()) {
2583 coap_log_warn("coap_new_endpoint: WSS not supported\n");
2584 return NULL;
2585 }
2586 break;
2587 case COAP_PROTO_NONE:
2588 case COAP_PROTO_LAST:
2589 default:
2590 coap_log_crit("coap_new_endpoint: Unsupported protocol %d\n", proto);
2591 return NULL;
2592 }
2593
2594 if (proto == COAP_PROTO_DTLS || proto == COAP_PROTO_TLS ||
2595 proto == COAP_PROTO_WSS) {
2597 coap_log_info("coap_new_endpoint: one of coap_context_set_psk() or "
2598 "coap_context_set_pki() not called\n");
2599 return NULL;
2600 }
2601 }
2602 ep = coap_malloc_endpoint();
2603 if (!ep) {
2604 coap_log_warn("coap_new_endpoint: malloc");
2605 return NULL;
2606 }
2607
2608 memset(ep, 0, sizeof(coap_endpoint_t));
2609 ep->context = context;
2610 ep->proto = proto;
2611 ep->sock.endpoint = ep;
2612 if (proto < COAP_PROTO_LAST) {
2613 /*
2614 * Should be caught above, but come compilers realize that proto
2615 * includes COAP_PROTO_LAST, but there is no table entry for that
2616 */
2617 memcpy(&ep->sock.lfunc, coap_layers_coap[proto], sizeof(ep->sock.lfunc));
2618 }
2619
2620 if (COAP_PROTO_NOT_RELIABLE(proto)) {
2621 if (!coap_netif_dgrm_listen(ep, listen_addr))
2622 goto error;
2623#ifdef WITH_CONTIKI
2624 ep->sock.context = context;
2625#endif /* WITH_CONTIKI */
2626#if !COAP_DISABLE_TCP
2627 } else if (COAP_PROTO_RELIABLE(proto)) {
2628 if (!coap_netif_strm_listen(ep, listen_addr))
2629 goto error;
2630#endif /* !COAP_DISABLE_TCP */
2631 } else {
2632 coap_log_crit("coap_new_endpoint: Protocol type not supported %d\n", proto);
2633 goto error;
2634 }
2635
2637#ifndef INET6_ADDRSTRLEN
2638#define INET6_ADDRSTRLEN 40
2639#endif
2640 unsigned char addr_str[INET6_ADDRSTRLEN + 8];
2641
2642 if (coap_print_addr(&ep->bind_addr, addr_str, INET6_ADDRSTRLEN + 8)) {
2643 coap_log_debug("created %s endpoint %s\n", coap_proto_name(ep->proto),
2644 addr_str);
2645 }
2646 }
2647
2648 ep->default_mtu = COAP_DEFAULT_MTU;
2649
2650#ifdef COAP_EPOLL_SUPPORT
2651 ep->sock.endpoint = ep;
2652 coap_epoll_ctl_add(&ep->sock,
2653 EPOLLIN,
2654 __func__);
2655#endif /* COAP_EPOLL_SUPPORT */
2656
2657 LL_PREPEND(context->endpoint, ep);
2658 return ep;
2659
2660error:
2661 coap_free_endpoint_lkd(ep);
2662 return NULL;
2663}
2664
2665void
2667 ep->default_mtu = (uint16_t)mtu;
2668}
2669
2670COAP_API void
2672 if (ep) {
2673 coap_context_t *context = ep->context;
2674 if (context) {
2675 coap_lock_lock(return);
2676 }
2677 coap_free_endpoint_lkd(ep);
2678 if (context) {
2680 }
2681 }
2682}
2683
2684void
2685coap_free_endpoint_lkd(coap_endpoint_t *ep) {
2686 if (ep) {
2687 coap_session_t *session, *rtmp;
2688
2689 if (ep->context) {
2690 /* If fully allocated and inserted */
2692 SESSIONS_ITER_SAFE(ep->sessions, session, rtmp) {
2693 if (session->ref > 0) {
2695#if COAP_CLIENT_SUPPORT
2696 if (session->client_initiated) {
2697 coap_session_release_lkd(session);
2698 }
2699#endif /* COAP_CLIENT_SUPPORT */
2700 }
2701 assert(session->ref == 0);
2702 if (session->ref == 0) {
2704 coap_session_free(session);
2705 }
2706 }
2707 if (coap_netif_available_ep(ep)) {
2708 /*
2709 * ep->sock.endpoint is set in coap_new_endpoint().
2710 * ep->sock.session is never set.
2711 *
2712 * session->sock.session is set for both clients and servers (when a
2713 * new session is accepted), but does not affect the endpoint.
2714 *
2715 * So, it is safe to call coap_netif_close_ep() after all the sessions
2716 * have been freed above as we are only working with the endpoint sock.
2717 */
2718#ifdef COAP_EPOLL_SUPPORT
2719 assert(ep->sock.session == NULL);
2720#endif /* COAP_EPOLL_SUPPORT */
2722 }
2723
2724 if (ep->context->endpoint) {
2725 LL_DELETE(ep->context->endpoint, ep);
2726 }
2727 }
2728
2729 if (ep->app_cb) {
2730 coap_lock_callback(ep->app_cb(ep->app_data));
2731 }
2732
2733 coap_mfree_endpoint(ep);
2734 }
2735}
2736
2737void *
2739 assert(endpoint);
2740 return endpoint->app_data;
2741}
2742
2743COAP_API void *
2744coap_endpoint_set_app_data(coap_endpoint_t *endpoint, void *app_data,
2746 void *old_data;
2747
2748 coap_lock_lock(return NULL);
2749 old_data = coap_endpoint_set_app_data_lkd(endpoint, app_data, callback);
2751 return old_data;
2752}
2753
2754void *
2755coap_endpoint_set_app_data_lkd(coap_endpoint_t *endpoint, void *app_data,
2757 void *old_data = endpoint->app_data;
2758
2759 endpoint->app_data = app_data;
2760 endpoint->app_cb = app_data ? callback : NULL;
2761 return old_data;
2762}
2763
2764#endif /* COAP_SERVER_SUPPORT */
2765
2768 const coap_address_t *remote_addr,
2769 int ifindex) {
2770 coap_session_t *s, *rtmp;
2771#if COAP_CLIENT_SUPPORT
2772 SESSIONS_ITER(ctx->sessions, s, rtmp) {
2773 if (s->ifindex == ifindex) {
2774 if (s->sock.flags & COAP_SOCKET_MULTICAST) {
2775 if (coap_address_equals(&s->sock.mcast_addr, remote_addr))
2776 return s;
2777 } else if (coap_address_equals(&s->addr_info.remote, remote_addr))
2778 return s;
2779 }
2780 }
2781#endif /* COAP_CLIENT_SUPPORT */
2782#if COAP_SERVER_SUPPORT
2783 coap_endpoint_t *ep;
2784
2785 LL_FOREACH(ctx->endpoint, ep) {
2786 SESSIONS_ITER(ep->sessions, s, rtmp) {
2787 if (s->ifindex == ifindex && coap_address_equals(&s->addr_info.remote,
2788 remote_addr))
2789 return s;
2790 }
2791 }
2792#endif /* COAP_SERVER_SUPPORT */
2793 return NULL;
2794}
2795
2796#ifndef INET6_ADDRSTRLEN
2797#define INET6_ADDRSTRLEN 46
2798#endif
2799const char *
2801 static char szSession[2 * (INET6_ADDRSTRLEN + 8) + 24];
2802 char *p = szSession, *end = szSession + sizeof(szSession);
2803
2804 if (!session) {
2805 return "Session not defined";
2806 }
2807 if (coap_print_addr(&session->addr_info.local,
2808 (unsigned char *)p, end - p) > 0)
2809 p += strlen(p);
2810 if (p + 6 < end) {
2811 strcpy(p, " <-> ");
2812 p += 5;
2813 }
2814 if (p + 1 < end) {
2815 if (coap_print_addr(&session->addr_info.remote,
2816 (unsigned char *)p, end - p) > 0)
2817 p += strlen(p);
2818 }
2819 if (session->ifindex > 0 && p + 1 < end)
2820 p += snprintf(p, end - p, " (if%d)", session->ifindex);
2821 if (p + 6 < end) {
2822 strcpy(p, " ");
2823 p++;
2824 strcpy(p, coap_proto_name(session->proto));
2825 }
2826
2827 return szSession;
2828}
2829
2830#if COAP_SERVER_SUPPORT
2831const char *
2832coap_endpoint_str(const coap_endpoint_t *endpoint) {
2833 static char szEndpoint[128];
2834 char *p = szEndpoint, *end = szEndpoint + sizeof(szEndpoint);
2835 if (coap_print_addr(&endpoint->bind_addr, (unsigned char *)p, end - p) > 0)
2836 p += strlen(p);
2837 if (p + 6 < end) {
2838 if (endpoint->proto == COAP_PROTO_UDP) {
2839 strcpy(p, " UDP");
2840 } else if (endpoint->proto == COAP_PROTO_DTLS) {
2841 strcpy(p, " DTLS");
2842 } else {
2843 strcpy(p, " NONE");
2844 }
2845 }
2846
2847 return szEndpoint;
2848}
2849#endif /* COAP_SERVER_SUPPORT */
2850#if COAP_CLIENT_SUPPORT
2851void
2853 session->no_observe_cancel = 1;
2854}
2855
2856void
2858 if (session->type != COAP_SESSION_TYPE_CLIENT) {
2859 coap_lock_lock(return);
2861 coap_session_release_lkd(session);
2863 }
2864}
2865#endif /* COAP_CLIENT_SUPPORT */
2866#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.
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
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:108
void * coap_dtls_get_tls(const coap_session_t *c_session COAP_UNUSED, coap_tls_library_t *tls_lib)
Definition coap_notls.c:158
unsigned int coap_dtls_get_overhead(coap_session_t *session COAP_UNUSED)
Definition coap_notls.c:265
int coap_dtls_context_check_keys_enabled(coap_context_t *ctx COAP_UNUSED)
Definition coap_notls.c:147
#define NULL
Definition coap_option.h:30
static const char * coap_proto_name(coap_proto_t proto)
COAP_API coap_mid_t coap_session_send_ping(coap_session_t *session)
Send a ping message for the session.
static const char * coap_nack_name(coap_nack_reason_t reason)
static coap_session_t * coap_make_session(coap_proto_t proto, coap_session_type_t type, const coap_addr_hash_t *addr_hash, const coap_address_t *local_addr, const coap_address_t *remote_addr, int ifindex, coap_context_t *context, coap_endpoint_t *endpoint)
static size_t coap_session_max_pdu_size_internal(const coap_session_t *session, size_t max_with_header)
#define INET6_ADDRSTRLEN
void coap_call_home_stop_reconnecting(coap_session_t *session)
Disable CoAP Server repeating Call-Home reconnect to CoAP Client.
void coap_session_set_no_observe_cancel(coap_session_t *session)
Disable client automatically sending observe cancel on session close.
#define SESSIONS_ADD(e, obj)
#define SESSIONS_ITER_SAFE(e, el, rtmp)
#define COAP_PARTIAL_SESSION_TIMEOUT_TICKS
#define SESSIONS_DELETE(e, obj)
#define COAP_DEFAULT_MAX_HANDSHAKE_SESSIONS
#define SESSIONS_ITER(e, el, rtmp)
#define SESSIONS_FIND(e, k, res)
void coap_reset_doing_first(coap_session_t *session)
Reset doing the first packet state when testing for optional functionality.
coap_mid_t coap_send_lkd(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:1508
#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:5079
uint16_t coap_new_message_id_lkd(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
int coap_delete_node_lkd(coap_queue_t *node)
Destroys specified node.
Definition coap_net.c:214
int coap_remove_from_queue(coap_queue_t **queue, coap_session_t *session, coap_mid_t id, coap_queue_t **node)
This function removes the element with given id from the list given list.
Definition coap_net.c:3055
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:1376
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:1256
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:2007
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition coap_net.c:1282
coap_queue_t * coap_new_node(void)
Creates a new node suitable for adding to the CoAP sendqueue.
Definition coap_net.c:243
void coap_cancel_session_messages(coap_context_t *context, coap_session_t *session, coap_nack_reason_t reason)
Cancels all outstanding messages for session session.
Definition coap_net.c:3162
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:3201
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:311
#define COAP_DTLS_CPSK_SETUP_VERSION
Latest CPSK setup version.
Definition coap_dtls.h:409
coap_tls_library_t
Definition coap_dtls.h:74
@ COAP_DTLS_ROLE_CLIENT
Internal function invoked for client.
Definition coap_dtls.h:49
unsigned int coap_encode_var_safe(uint8_t *buf, size_t length, unsigned int val)
Encodes multiple-length byte sequences.
Definition coap_encode.c:47
uint64_t coap_decode_var_bytes8(const uint8_t *buf, size_t len)
Decodes multiple-length byte sequences.
Definition coap_encode.c: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:793
size_t coap_print_addr(const coap_address_t *addr, unsigned char *buf, size_t len)
Print the address into the defined buffer.
Definition coap_debug.c:241
const char * coap_endpoint_str(const coap_endpoint_t *endpoint)
Get endpoint description.
const char * coap_session_str(const coap_session_t *session)
Get session description.
#define coap_log_info(...)
Definition coap_debug.h:114
#define coap_log_warn(...)
Definition coap_debug.h:108
#define coap_log_err(...)
Definition coap_debug.h:102
#define coap_log_crit(...)
Definition coap_debug.h:96
@ COAP_LOG_DEBUG
Definition coap_debug.h:64
int coap_netif_dgrm_listen(coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
Layer function interface for Netif datagram listem (udp).
void coap_netif_close_ep(coap_endpoint_t *endpoint)
Layer function interface for Netif close for a endpoint.
int coap_netif_strm_connect1(coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
Layer function interface for Netif stream connect (tcp).
int coap_netif_strm_accept(coap_endpoint_t *endpoint, coap_session_t *session, void *extra)
Layer function interface for Netif stream accept.
int coap_netif_strm_listen(coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
Layer function interface for Netif stream listem (tcp).
int coap_netif_dgrm_connect(coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
Layer function interface for Netif datagram connect (udp).
int coap_netif_available(coap_session_t *session)
Function interface to check whether netif for session is still available.
Definition coap_netif.c:25
int coap_netif_available_ep(coap_endpoint_t *endpoint)
Function interface to check whether netif for endpoint is still available.
void coap_delete_oscore_associations(coap_session_t *session)
Cleanup all allocated OSCORE association information.
coap_pdu_t * coap_pdu_reference_lkd(coap_pdu_t *pdu)
Increment reference counter on a pdu to stop it prematurely getting freed off when coap_delete_pdu() ...
Definition coap_pdu.c:1680
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
Definition coap_pdu.c:194
int coap_update_token(coap_pdu_t *pdu, size_t len, const uint8_t *data)
Updates token in pdu with length len and data.
Definition coap_pdu.c:436
#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:1542
#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:807
#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:266
#define COAP_TOKEN_DEFAULT_MAX
Definition coap_pdu.h:58
#define COAP_SIGNALING_OPTION_EXTENDED_TOKEN_LENGTH
Definition coap_pdu.h:202
coap_proto_t
CoAP protocol types Note: coap_layers_coap[] needs updating if extended.
Definition coap_pdu.h:316
#define COAP_SIGNALING_OPTION_BLOCK_WISE_TRANSFER
Definition coap_pdu.h:201
#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:102
#define COAP_INVALID_MID
Indicates an invalid message id.
Definition coap_pdu.h:269
#define COAP_DEFAULT_MTU
Definition coap_pdu.h:43
#define COAP_BERT_BASE
Definition coap_pdu.h:46
#define COAP_SIGNALING_OPTION_MAX_MESSAGE_SIZE
Definition coap_pdu.h:200
@ COAP_PROTO_WS
Definition coap_pdu.h:322
@ COAP_PROTO_DTLS
Definition coap_pdu.h:319
@ COAP_PROTO_UDP
Definition coap_pdu.h:318
@ COAP_PROTO_NONE
Definition coap_pdu.h:317
@ COAP_PROTO_TLS
Definition coap_pdu.h:321
@ COAP_PROTO_WSS
Definition coap_pdu.h:323
@ COAP_PROTO_TCP
Definition coap_pdu.h:320
@ COAP_PROTO_LAST
Definition coap_pdu.h:324
@ COAP_SIGNALING_CODE_CSM
Definition coap_pdu.h:369
@ COAP_SIGNALING_CODE_PING
Definition coap_pdu.h:370
@ COAP_EMPTY_CODE
Definition coap_pdu.h:331
@ 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:1134
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:934
int coap_dtls_is_supported(void)
Check whether DTLS is available.
Definition coap_notls.c:36
int coap_wss_is_supported(void)
Check whether Secure WebSockets is available.
Definition coap_ws.c:939
Only used for servers for hashing incoming packets.
uint16_t lport
local port
coap_address_t remote
remote address and port
coap_proto_t proto
CoAP protocol.
coap_address_t remote
remote address and port
Definition coap_io.h: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:385
coap_bin_const_t identity
Definition coap_dtls.h:384
The structure used for defining the Client PSK setup data to be used.
Definition coap_dtls.h:414
char * client_sni
If not NULL, SNI to use in client TLS setup.
Definition coap_dtls.h:441
coap_dtls_cpsk_info_t psk_info
Client PSK definition.
Definition coap_dtls.h:447
The structure used for defining the PKI setup data to be used.
Definition coap_dtls.h:316
uint8_t version
Definition coap_dtls.h:317
char * client_sni
If not NULL, SNI to use in client TLS setup.
Definition coap_dtls.h:372
Abstraction of 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