libcoap 4.3.5-develop-7370fcf
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 oscore_release_recipient_ctx(&session->recipient_ctx);
626#endif /* COAP_OSCORE_SUPPORT */
627#if COAP_WS_SUPPORT
628 coap_free_type(COAP_STRING, session->ws);
629 coap_delete_str_const(session->ws_host);
630#endif /* COAP_WS_SUPPORT */
631}
632
633void
635 if (!session)
636 return;
638 assert(session->ref == 0);
639 if (session->ref)
640 return;
641 /* Make sure nothing gets deleted under our feet */
643 coap_session_mfree(session);
644#if COAP_SERVER_SUPPORT
645 coap_delete_bin_const(session->client_cid);
646 if (session->endpoint) {
647 if (session->endpoint->sessions)
648 SESSIONS_DELETE(session->endpoint->sessions, session);
649 } else
650#endif /* COAP_SERVER_SUPPORT */
651#if COAP_CLIENT_SUPPORT
652 if (session->context) {
653 if (session->context->sessions)
654 SESSIONS_DELETE(session->context->sessions, session);
655 }
656 coap_delete_bin_const(session->req_token);
657#endif /* COAP_CLIENT_SUPPORT */
659 coap_delete_bin_const(session->echo);
660#if COAP_SERVER_SUPPORT
661 coap_delete_pdu_lkd(session->cached_pdu);
662#endif /* COAP_SERVER_SUPPORT */
663
664 if (session->app_cb) {
665 coap_lock_callback(session->app_cb(session->app_data));
666 }
667 coap_log_debug("***%s: session %p: closed\n", coap_session_str(session),
668 (void *)session);
669 assert(session->ref == 1);
671}
672
673#if COAP_SERVER_SUPPORT
674void
676 int i;
677
680 coap_cancel_all_messages(session->context, session, NULL);
681 RESOURCES_ITER(session->context->resources, r) {
682 /* In case code is broken somewhere */
683 for (i = 0; i < 1000; i++) {
684 if (!coap_delete_observer(r, session, NULL))
685 break;
686 }
687 }
688 if (session->context->unknown_resource) {
689 /* In case code is broken somewhere */
690 for (i = 0; i < 1000; i++) {
691 if (!coap_delete_observer(session->context->unknown_resource, session, NULL))
692 break;
693 }
694 }
695 if (session->context->proxy_uri_resource) {
696 /* In case code is broken somewhere */
697 for (i = 0; i < 1000; i++) {
698 if (!coap_delete_observer(session->context->proxy_uri_resource, session, NULL))
699 break;
700 }
701 }
702 while (session->delayqueue) {
703 coap_queue_t *q = session->delayqueue;
704
705 session->delayqueue = q->next;
707 }
708 /* Force session to go away */
711
713}
714#endif /* COAP_SERVER_SUPPORT */
715
716static size_t
718 size_t max_with_header) {
719#if COAP_DISABLE_TCP
720 (void)session;
721 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
722 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
723 : 0;
724#else /* !COAP_DISABLE_TCP */
725 if (COAP_PROTO_NOT_RELIABLE(session->proto))
726 return max_with_header > COAP_PDU_MAX_UDP_HEADER_SIZE
727 ? max_with_header - COAP_PDU_MAX_UDP_HEADER_SIZE
728 : 0;
729 /* we must assume there is no token to be on the safe side */
730 if (max_with_header <= 2)
731 return 0;
732 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP0 + 2)
733 return max_with_header - 2;
734 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP8 + 3)
735 return max_with_header - 3;
736 else if (max_with_header <= COAP_MAX_MESSAGE_SIZE_TCP16 + 4)
737 return max_with_header - 4;
738 else
739 return max_with_header - COAP_PDU_MAX_TCP_HEADER_SIZE;
740#endif /* !COAP_DISABLE_TCP */
741}
742
743size_t
745 if (session->csm_rcv_mtu)
747 (size_t)(session->csm_rcv_mtu));
748
750 (size_t)(session->mtu - session->tls_overhead));
751}
752
753COAP_API size_t
755 size_t size;
756 coap_session_t *session_rw;
757
758 /*
759 * Need to do this to not get a compiler warning about const parameters
760 * but need to maintain source code backward compatibility
761 */
762 memcpy(&session_rw, &session, sizeof(session_rw));
763 coap_lock_lock(return 0);
764 size = coap_session_max_pdu_size_lkd(session_rw);
766 return size;
767}
768
769size_t
771 size_t max_with_header;
772
774#if COAP_CLIENT_SUPPORT
775 if (COAP_PROTO_RELIABLE(session->proto) &&
776 session->type == COAP_SESSION_TYPE_CLIENT &&
777 session->doing_first) {
778 /*
779 * Delay if session->doing_first is set.
780 * E.g. Reliable and CSM not in yet for checking block support
781 */
782 coap_session_t *session_rw;
783
784 /*
785 * Need to do this to not get a compiler warning about const parameters
786 * but need to maintain source code backward compatibility
787 */
788 memcpy(&session_rw, &session, sizeof(session_rw));
789 if (coap_client_delay_first(session_rw) == 0) {
790 coap_log_debug("coap_client_delay_first: timeout\n");
791 /* Have to go with the defaults */
792 }
793 }
794#endif /* COAP_CLIENT_SUPPORT */
795
796 max_with_header = (size_t)(session->mtu - session->tls_overhead);
797
798 return coap_session_max_pdu_size_internal(session, max_with_header);
799}
800
801void
802coap_session_set_mtu(coap_session_t *session, unsigned mtu) {
805 coap_log_debug("* %s: Restricting MTU size to %u\n",
806 coap_session_str(session), mtu);
807 }
808 if (mtu < 64)
809 mtu = 64;
810 session->mtu = mtu;
811 if (session->tls_overhead >= session->mtu) {
812 session->tls_overhead = session->mtu;
813 coap_log_err("DTLS overhead exceeds MTU\n");
814 }
815}
816
817ssize_t
819 coap_queue_t *node) {
820 if (node) {
821 coap_queue_t *removed = NULL;
822 coap_remove_from_queue(&session->context->sendqueue, session, node->id, &removed);
823 assert(removed == node);
825 node->session = NULL;
826 node->t = 0;
827 } else {
828 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
829 coap_queue_t *q = NULL;
830 /* Check same mid is not getting re-used in violation of RFC7252 */
831 LL_FOREACH(session->delayqueue, q) {
832 if (q->id == pdu->mid) {
833 coap_log_err("** %s: mid=0x%04x: already in-use - dropped\n",
834 coap_session_str(session), pdu->mid);
835 return COAP_INVALID_MID;
836 }
837 }
838 }
839 node = coap_new_node();
840 if (node == NULL)
841 return COAP_INVALID_MID;
842 node->id = pdu->mid;
843 node->pdu = pdu;
844 if (pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
845 uint8_t r;
846 coap_prng_lkd(&r, sizeof(r));
847 /* add timeout in range [ACK_TIMEOUT...ACK_TIMEOUT * ACK_RANDOM_FACTOR] */
848 node->timeout = coap_calc_timeout(session, r);
849 }
850 coap_address_copy(&node->remote, &session->addr_info.remote);
851 }
852 LL_APPEND(session->delayqueue, node);
854 coap_log_debug("** %s: mid=0x%04x: delayed\n",
855 coap_session_str(session), node->id);
856 return COAP_PDU_DELAYED;
857}
858
859#if !COAP_DISABLE_TCP
860void
862 coap_pdu_t *pdu;
863 uint8_t buf[4];
864 assert(COAP_PROTO_RELIABLE(session->proto));
865 coap_log_debug("***%s: sending CSM\n", coap_session_str(session));
866 session->state = COAP_SESSION_STATE_CSM;
867 session->partial_write = 0;
868 if (session->mtu == 0)
869 coap_session_set_mtu(session, COAP_DEFAULT_MTU); /* base value */
871 if (pdu == NULL
873 coap_encode_var_safe(buf, sizeof(buf),
874 session->context->csm_max_message_size), buf) == 0
876 coap_encode_var_safe(buf, sizeof(buf),
877 0), buf) == 0
878 || (session->max_token_size > COAP_TOKEN_DEFAULT_MAX &&
881 coap_encode_var_safe(buf, sizeof(buf),
882 session->max_token_size),
883 buf) == 0)
884 || coap_pdu_encode_header(pdu, session->proto) == 0
885 ) {
887 } else {
888 ssize_t bytes_written;
889
890 pdu->session = session;
891 bytes_written = coap_session_send_pdu(session, pdu);
892 if (bytes_written != (ssize_t)pdu->used_size + pdu->hdr_size) {
894 } else {
895 session->csm_rcv_mtu = session->context->csm_max_message_size;
896 if (session->csm_rcv_mtu > COAP_BERT_BASE)
897 session->csm_bert_loc_support = 1;
898 else
899 session->csm_bert_loc_support = 0;
900 }
901 }
902 if (pdu)
904}
905#endif /* !COAP_DISABLE_TCP */
906
909 coap_mid_t mid;
910
912 mid = coap_session_send_ping_lkd(session);
913 if (mid != COAP_INVALID_MID) {
914 coap_tick_t now;
915
916 coap_ticks(&now);
917 session->last_ping_mid = mid;
918 session->last_rx_tx = now;
919 session->last_ping = now;
920 }
922 return mid;
923}
924
927 coap_pdu_t *ping = NULL;
928
930 if (session->state != COAP_SESSION_STATE_ESTABLISHED ||
931 session->con_active)
932 return COAP_INVALID_MID;
933 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
934 uint16_t mid = coap_new_message_id_lkd(session);
935 ping = coap_pdu_init(COAP_MESSAGE_CON, 0, mid, 0);
936 }
937#if !COAP_DISABLE_TCP
938 else {
940 }
941#endif /* !COAP_DISABLE_TCP */
942 if (!ping)
943 return COAP_INVALID_MID;
944 return coap_send_internal(session, ping, NULL);
945}
946
947void
949 if (session->state != COAP_SESSION_STATE_ESTABLISHED) {
950 coap_log_debug("***%s: session connected\n",
951 coap_session_str(session));
952 if (session->state == COAP_SESSION_STATE_CSM) {
954#if COAP_CLIENT_SUPPORT
956 coap_reset_doing_first(session);
957#endif /* COAP_CLIENT_SUPPORT */
958 }
959 }
960
962 session->partial_write = 0;
963
964 if (session->proto==COAP_PROTO_DTLS) {
965 session->tls_overhead = coap_dtls_get_overhead(session);
966 if (session->tls_overhead >= session->mtu) {
967 session->tls_overhead = session->mtu;
968 coap_log_err("DTLS overhead exceeds MTU\n");
969 }
970 }
971
972 while (session->delayqueue && session->state == COAP_SESSION_STATE_ESTABLISHED) {
973 ssize_t bytes_written;
974 coap_queue_t *q = session->delayqueue;
975 coap_address_t remote;
976
977 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
978 if (session->con_active >= COAP_NSTART(session))
979 break;
980 session->con_active++;
981 }
982 /* Take entry off the queue */
983 session->delayqueue = q->next;
984 q->next = NULL;
985
986 coap_address_copy(&remote, &session->addr_info.remote);
988 coap_log_debug("** %s: mid=0x%04x: transmitted after delay (2)\n",
989 coap_session_str(session), (int)q->pdu->mid);
990 bytes_written = coap_session_send_pdu(session, q->pdu);
991 if (q->pdu->type == COAP_MESSAGE_CON && COAP_PROTO_NOT_RELIABLE(session->proto)) {
992 if (coap_wait_ack(session->context, session, q) >= 0)
993 q = NULL;
994 }
995 coap_address_copy(&session->addr_info.remote, &remote);
996 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
997 if (q)
999 if (bytes_written < 0)
1000 break;
1001 } else if (q) {
1002 if (bytes_written <= 0 || (size_t)bytes_written < q->pdu->used_size + q->pdu->hdr_size) {
1003 q->next = session->delayqueue;
1004 session->delayqueue = q;
1005 if (bytes_written > 0)
1006 session->partial_write = (size_t)bytes_written;
1007 break;
1008 } else {
1010 }
1011 }
1012 }
1013}
1014
1015#if COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG
1016static const char *
1018 switch (reason) {
1020 return "COAP_NACK_TOO_MANY_RETRIES";
1022 return "COAP_NACK_NOT_DELIVERABLE";
1023 case COAP_NACK_RST:
1024 return "COAP_NACK_RST";
1026 return "COAP_NACK_TLS_FAILED";
1028 return "COAP_NACK_ICMP_ISSUE";
1030 return "COAP_NACK_BAD_RESPONSE";
1032 return "COAP_NACK_TLS_LAYER_FAILED";
1034 return "COAP_NACK_WS_LAYER_FAILED";
1036 return "COAP_NACK_WS_FAILED";
1037 default:
1038 return "???";
1039 }
1040}
1041#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_DEBUG */
1042
1043void
1045 coap_pdu_t *sent,
1046 const coap_nack_reason_t reason,
1047 const coap_mid_t mid) {
1048 if (session->context->nack_cb
1050 && !session->doing_first_pdu
1051#endif /* COAP_CLIENT_SUPPORT */
1052 ) {
1053 coap_bin_const_t token = {0, NULL};
1054
1055 if (sent) {
1056 coap_check_update_token(session, sent);
1057 token = sent->actual_token;
1058 }
1059 coap_lock_callback(session->context->nack_cb(session, sent, reason, mid));
1060 if (sent) {
1061 coap_update_token(sent, token.length, token.s);
1062 }
1063 }
1064#if COAP_CLIENT_SUPPORT
1065 if (reason != COAP_NACK_ICMP_ISSUE) {
1066 session->doing_send_recv = 0;
1067 }
1068#endif /* COAP_CLIENT_SUPPORT */
1069}
1070
1071COAP_API void
1077
1078void
1080#if !COAP_DISABLE_TCP
1081 coap_session_state_t state = session->state;
1082#endif /* !COAP_DISABLE_TCP */
1083 coap_lg_xmit_t *lq, *ltmp;
1084#if COAP_SERVER_SUPPORT
1085 coap_lg_srcv_t *sq, *stmp;
1086#endif /* COAP_SERVER_SUPPORT */
1087#if COAP_CLIENT_SUPPORT
1088 coap_lg_crcv_t *cq, *etmp;
1089#endif /* COAP_CLIENT_SUPPORT */
1090 int sent_nack = 0;
1091 coap_queue_t *q;
1092
1094#if COAP_CLIENT_SUPPORT
1095 coap_session_failed(session);
1096#endif /* COAP_CLIENT_SUPPORT */
1097
1098 q = session->context->sendqueue;
1099 while (q) {
1100 if (q->session == session) {
1101 /* Take the first one */
1102 coap_handle_nack(session, q->pdu, reason, q->id);
1103 sent_nack = 1;
1104 break;
1105 }
1106 q = q->next;
1107 }
1108
1109 if (reason != COAP_NACK_ICMP_ISSUE
1111 || session->session_failed
1112#endif /* COAP_CLIENT_SUPPORT */
1113 ) {
1114 while (session->delayqueue) {
1115 q = session->delayqueue;
1116 session->delayqueue = q->next;
1117 q->next = NULL;
1118 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1119 coap_session_str(session), q->id);
1120 if (q->pdu->type == COAP_MESSAGE_CON) {
1121 coap_handle_nack(session, q->pdu, reason, q->id);
1122 sent_nack = 1;
1123 }
1124
1125#if COAP_CLIENT_SUPPORT
1126 session->doing_send_recv = 0;
1127#endif /* COAP_CLIENT_SUPPORT */
1129 }
1130 }
1131#if COAP_CLIENT_SUPPORT
1132 if (!sent_nack && session->lg_crcv) {
1133 /* Take the first one */
1134 coap_handle_nack(session, session->lg_crcv->sent_pdu, reason,
1135 session->lg_crcv->sent_pdu->mid);
1136 sent_nack = 1;
1137 }
1138#endif /* COAP_CLIENT_SUPPORT */
1139 if (!sent_nack) {
1140 /* Unable to determine which request disconnection was for */
1141 coap_handle_nack(session, NULL, reason, 0);
1142 }
1143 if (reason == COAP_NACK_ICMP_ISSUE) {
1144 coap_log_debug("***%s: session ICMP issue (%s)\n",
1145 coap_session_str(session), coap_nack_name(reason));
1146 return;
1147 }
1148 coap_log_debug("***%s: session disconnected (%s)\n",
1149 coap_session_str(session), coap_nack_name(reason));
1150#if COAP_SERVER_SUPPORT
1151 coap_delete_observers(session->context, session);
1152#endif /* COAP_SERVER_SUPPORT */
1153
1154 if (session->proto == COAP_PROTO_UDP)
1156 else
1157 session->state = COAP_SESSION_STATE_NONE;
1158
1159 session->con_active = 0;
1160
1161 if (session->partial_pdu) {
1163 session->partial_pdu = NULL;
1164 }
1165 session->partial_read = 0;
1166
1167 /* Not done if nack handler called above */
1168 while (session->delayqueue) {
1169 q = session->delayqueue;
1170 session->delayqueue = q->next;
1171 q->next = NULL;
1172 coap_log_debug("** %s: mid=0x%04x: not transmitted after disconnect\n",
1173 coap_session_str(session), q->id);
1174#if COAP_CLIENT_SUPPORT
1175 session->doing_send_recv = 0;
1176#endif /* COAP_CLIENT_SUPPORT */
1178 }
1179
1180#if COAP_CLIENT_SUPPORT
1181 if (!session->session_failed) {
1182 /* Need to do this before (D)TLS and socket is closed down */
1183 LL_FOREACH_SAFE(session->lg_crcv, cq, etmp) {
1184 LL_DELETE(session->lg_crcv, cq);
1185 coap_block_delete_lg_crcv(session, cq);
1186 }
1187 }
1188#endif /* COAP_CLIENT_SUPPORT */
1189 LL_FOREACH_SAFE(session->lg_xmit, lq, ltmp) {
1190 LL_DELETE(session->lg_xmit, lq);
1191 coap_block_delete_lg_xmit(session, lq);
1192 }
1193#if COAP_SERVER_SUPPORT
1194 LL_FOREACH_SAFE(session->lg_srcv, sq, stmp) {
1195 LL_DELETE(session->lg_srcv, sq);
1196 coap_block_delete_lg_srcv(session, sq);
1197 }
1198#endif /* COAP_SERVER_SUPPORT */
1199 coap_cancel_session_messages(session->context, session, reason);
1200
1201#if !COAP_DISABLE_TCP
1202 if (COAP_PROTO_RELIABLE(session->proto)) {
1203 if (coap_netif_available(session)) {
1207 }
1208#if COAP_CLIENT_SUPPORT
1209 if (state != COAP_SESSION_STATE_NONE && !session->session_failed) {
1213 }
1214 coap_reset_doing_first(session);
1215#endif /* COAP_CLIENT_SUPPORT */
1216 }
1217#endif /* !COAP_DISABLE_TCP */
1218 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1219 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1220}
1221
1222#if COAP_CLIENT_SUPPORT
1223void
1225 if (session->context->reconnect_time && session->client_initiated) {
1226 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close)
1227 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1228 session->session_failed = 1;
1230 session->retry_count++;
1231 if (session->context->retry_count && session->retry_count >= session->context->retry_count) {
1233 if (session->type != COAP_SESSION_TYPE_CLIENT) {
1235 coap_session_release_lkd(session);
1236 }
1237 }
1238 coap_ticks(&session->last_rx_tx);
1239 }
1240}
1241#endif /* COAP_CLIENT_SUPPORT */
1242
1243#if COAP_SERVER_SUPPORT
1244static void
1245coap_make_addr_hash(coap_addr_hash_t *addr_hash, coap_proto_t proto,
1246 const coap_addr_tuple_t *addr_info) {
1247 memset(addr_hash, 0, sizeof(coap_addr_hash_t));
1248 coap_address_copy(&addr_hash->remote, &addr_info->remote);
1249 addr_hash->lport = coap_address_get_port(&addr_info->local);
1250 addr_hash->proto = proto;
1251}
1252
1253/* Aids debugging when session is created */
1254static coap_session_t *debug_session;
1255
1257coap_endpoint_get_session(coap_endpoint_t *endpoint,
1258 const coap_packet_t *packet, coap_tick_t now) {
1259 coap_session_t *session;
1260 coap_session_t *rtmp;
1261 unsigned int num_idle = 0;
1262 unsigned int num_hs = 0;
1263 coap_session_t *oldest = NULL;
1264 coap_session_t *oldest_hs = NULL;
1265 coap_addr_hash_t addr_hash;
1266
1267 coap_make_addr_hash(&addr_hash, endpoint->proto, &packet->addr_info);
1268 SESSIONS_FIND(endpoint->sessions, addr_hash, session);
1269 if (session) {
1270 /* Maybe mcast or unicast IP address which is not in the hash */
1271 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1272 session->ifindex = packet->ifindex;
1273 session->last_rx_tx = now;
1274 return session;
1275 }
1276
1277#if COAP_CLIENT_SUPPORT
1278 SESSIONS_FIND(endpoint->context->sessions, addr_hash, session);
1279 if (session) {
1280 /* Maybe mcast or unicast IP address which is not in the hash */
1281 coap_address_copy(&session->addr_info.local, &packet->addr_info.local);
1282 session->ifindex = packet->ifindex;
1283 session->last_rx_tx = now;
1284 return session;
1285 }
1286
1287 if (coap_is_mcast(&packet->addr_info.local)) {
1288 /* Check if this a proxy client packet we sent on another socket */
1289 SESSIONS_ITER(endpoint->context->sessions, session, rtmp) {
1290 if (coap_address_equals(&session->addr_info.remote, &packet->addr_info.local) &&
1293 /* Drop looped back packet to stop recursion / confusion */
1294 return NULL;
1295 }
1296 }
1297 }
1298#endif /* COAP_CLIENT_SUPPORT */
1299 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1300 if (session->ref == 0 && session->delayqueue == NULL &&
1301 session->lg_srcv == NULL && session->lg_xmit == NULL) {
1302 if (
1304 !(session->client_initiated && endpoint->context->reconnect_time) &&
1305#endif /* COAP_CLIENT_SUPPORT */
1306 session->type == COAP_SESSION_TYPE_SERVER) {
1307 ++num_idle;
1308 if (oldest==NULL || session->last_rx_tx < oldest->last_rx_tx)
1309 oldest = session;
1310
1311 if (session->state == COAP_SESSION_STATE_HANDSHAKE) {
1312 ++num_hs;
1313 /* See if this is a partial (D)TLS session set up
1314 which needs to be cleared down to prevent DOS */
1315 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1316 if (oldest_hs == NULL ||
1317 session->last_rx_tx < oldest_hs->last_rx_tx)
1318 oldest_hs = session;
1319 }
1320 }
1321 } else if (session->type == COAP_SESSION_TYPE_HELLO) {
1322 ++num_hs;
1323 /* See if this is a partial (D)TLS session set up for Client Hello
1324 which needs to be cleared down to prevent DOS */
1325 if ((session->last_rx_tx + COAP_PARTIAL_SESSION_TIMEOUT_TICKS) < now) {
1326 if (oldest_hs == NULL ||
1327 session->last_rx_tx < oldest_hs->last_rx_tx)
1328 oldest_hs = session;
1329 }
1330 }
1331 }
1332 }
1333
1334 if (endpoint->context->max_idle_sessions > 0 &&
1335 num_idle >= endpoint->context->max_idle_sessions) {
1337 coap_session_free(oldest);
1338 } else if (oldest_hs) {
1339 coap_log_warn("***%s: Incomplete session timed out\n",
1340 coap_session_str(oldest_hs));
1342 coap_session_free(oldest_hs);
1343 }
1344
1345 if (num_hs > (endpoint->context->max_handshake_sessions ?
1346 endpoint->context->max_handshake_sessions :
1348 /* Maxed out on number of sessions in (D)TLS negotiation state */
1349 coap_log_debug("Oustanding sessions in COAP_SESSION_STATE_HANDSHAKE too "
1350 "large. New request ignored\n");
1351 return NULL;
1352 }
1353
1354 if (endpoint->proto == COAP_PROTO_DTLS) {
1355 /*
1356 * Need to check that this actually is a Client Hello before wasting
1357 * time allocating and then freeing off session.
1358 */
1359
1360 /*
1361 * Generic header structure of the DTLS record layer.
1362 * typedef struct __attribute__((__packed__)) {
1363 * uint8_t content_type; content type of the included message
1364 * uint16_t version; Protocol version
1365 * uint16_t epoch; counter for cipher state changes
1366 * uint8_t sequence_number[6]; sequence number
1367 * uint16_t length; length of the following fragment
1368 * uint8_t handshake; If content_type == DTLS_CT_HANDSHAKE
1369 * } dtls_record_handshake_t;
1370 */
1371#define OFF_CONTENT_TYPE 0 /* offset of content_type in dtls_record_handshake_t */
1372#define DTLS_CT_ALERT 21 /* Content Type Alert */
1373#define DTLS_CT_HANDSHAKE 22 /* Content Type Handshake */
1374#define OFF_HANDSHAKE_TYPE 13 /* offset of handshake in dtls_record_handshake_t */
1375#define DTLS_HT_CLIENT_HELLO 1 /* Client Hello handshake type */
1376#define DTLS_CT_CID 25 /* Content Type Connection ID */
1377#define OFF_CID 11 /* offset of CID in dtls_record_handshake_t */
1378#define OFF_CID_DTLS13 1 /* offset of CID in DTLS1.3 Unified Header */
1379
1380 const uint8_t *payload = (const uint8_t *)packet->payload;
1381 size_t length = packet->length;
1382 if (length < (OFF_HANDSHAKE_TYPE + 1)) {
1383 coap_log_debug("coap_dtls_hello: ContentType %d Short Packet (%" PRIuS " < %d) dropped\n",
1384 payload[OFF_CONTENT_TYPE], length,
1385 OFF_HANDSHAKE_TYPE + 1);
1386 return NULL;
1387 }
1388 if ((payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 ||
1389 payload[OFF_CONTENT_TYPE] == DTLS_CT_CID) {
1390 /* Client may have changed its IP address */
1391 int changed = 0;
1392
1393 SESSIONS_ITER(endpoint->sessions, session, rtmp) {
1394 if (session->client_cid) {
1395 if ((session->is_dtls13 && (payload[OFF_CONTENT_TYPE] & 0x30) == 0x30 &&
1396 length > (OFF_CID_DTLS13 + session->client_cid->length) &&
1397 memcmp(session->client_cid->s, &payload[OFF_CID_DTLS13],
1398 session->client_cid->length) == 0) ||
1399 (!session->is_dtls13 && payload[OFF_CONTENT_TYPE] == DTLS_CT_CID &&
1400 length > (OFF_CID + session->client_cid->length) &&
1401 memcmp(session->client_cid->s, &payload[OFF_CID],
1402 session->client_cid->length) == 0)) {
1403 /* Updating IP address */
1404 coap_log_info("***%s: CID: Old Client Session\n", coap_session_str(session));
1405 SESSIONS_DELETE(endpoint->sessions, session);
1406 session->addr_info = packet->addr_info;
1407 memcpy(&session->addr_hash, &addr_hash, sizeof(session->addr_hash));
1408 SESSIONS_ADD(endpoint->sessions, session);
1409 coap_log_info("***%s: CID: New Client Session\n", coap_session_str(session));
1410 return session;
1411 }
1412 }
1413 }
1414 if (!changed) {
1415 coap_log_debug("coap_dtls_hello: ContentType Connection-IS dropped\n");
1416 return NULL;
1417 }
1418 } else if (payload[OFF_CONTENT_TYPE] != DTLS_CT_HANDSHAKE ||
1419 payload[OFF_HANDSHAKE_TYPE] != DTLS_HT_CLIENT_HELLO) {
1420 /* only log if not a late alert */
1421 if (payload[OFF_CONTENT_TYPE] != DTLS_CT_ALERT)
1422 coap_log_debug("coap_dtls_hello: ContentType %d Handshake %d dropped\n",
1423 payload[OFF_CONTENT_TYPE],
1424 payload[OFF_HANDSHAKE_TYPE]);
1425 return NULL;
1426 }
1427 }
1428
1429 session = coap_make_session(endpoint->proto, COAP_SESSION_TYPE_SERVER,
1430 &addr_hash, &packet->addr_info.local,
1431 &packet->addr_info.remote,
1432 packet->ifindex, endpoint->context, endpoint);
1433 /* Aids debugging endpoint created session */
1434 debug_session = session;
1435 if (session) {
1436 session->last_rx_tx = now;
1437 memcpy(session->sock.lfunc, endpoint->sock.lfunc,
1438 sizeof(session->sock.lfunc));
1439 if (endpoint->proto == COAP_PROTO_UDP)
1441 else if (endpoint->proto == COAP_PROTO_DTLS) {
1442 session->type = COAP_SESSION_TYPE_HELLO;
1443 }
1444 SESSIONS_ADD(endpoint->sessions, session);
1445 coap_log_debug("***%s: session %p: new incoming session\n",
1446 coap_session_str(session), (void *)session);
1448 }
1449 return session;
1450}
1451
1454 coap_tick_t now) {
1455 if (session) {
1456 session->last_rx_tx = now;
1457 session->type = COAP_SESSION_TYPE_SERVER;
1458 coap_dtls_establish(session);
1459 }
1460 return session;
1461}
1462#endif /* COAP_SERVER_SUPPORT */
1463
1464#if COAP_CLIENT_SUPPORT
1465static coap_session_t *
1466coap_session_create_client(coap_context_t *ctx,
1467 const coap_address_t *local_if,
1468 const coap_address_t *server,
1469 coap_proto_t proto,
1470 void *app_data,
1472 coap_str_const_t *ws_host) {
1473 coap_session_t *session = NULL;
1474 int default_port = COAP_DEFAULT_PORT;
1475
1476 assert(server);
1477
1478 switch (proto) {
1479 case COAP_PROTO_UDP:
1480 default_port = COAP_DEFAULT_PORT;
1481 break;
1482 case COAP_PROTO_DTLS:
1483 if (!coap_dtls_is_supported()) {
1484 coap_log_crit("coap_new_client_session*: DTLS not supported\n");
1485 return NULL;
1486 }
1487 default_port = COAPS_DEFAULT_PORT;
1488 break;
1489 case COAP_PROTO_TCP:
1490 if (!coap_tcp_is_supported()) {
1491 coap_log_crit("coap_new_client_session*: TCP not supported\n");
1492 return NULL;
1493 }
1494 default_port = COAP_DEFAULT_PORT;
1495 break;
1496 case COAP_PROTO_TLS:
1497 if (!coap_tls_is_supported()) {
1498 coap_log_crit("coap_new_client_session*: TLS not supported\n");
1499 return NULL;
1500 }
1501 default_port = COAPS_DEFAULT_PORT;
1502 break;
1503 case COAP_PROTO_WS:
1504 if (!coap_ws_is_supported()) {
1505 coap_log_crit("coap_new_client_session*: WS not supported\n");
1506 return NULL;
1507 }
1508 default_port = 80;
1509 break;
1510 case COAP_PROTO_WSS:
1511 if (!coap_wss_is_supported()) {
1512 coap_log_crit("coap_new_client_session*: WSS not supported\n");
1513 return NULL;
1514 }
1515 default_port = 443;
1516 break;
1517 case COAP_PROTO_NONE:
1518 case COAP_PROTO_LAST:
1519 default:
1520 assert(0);
1521 return NULL;
1522 }
1524 local_if, server, 0, ctx, NULL);
1525 if (!session)
1526 goto error;
1527
1529 session->sock.session = session;
1530 memcpy(&session->sock.lfunc, coap_layers_coap[proto],
1531 sizeof(session->sock.lfunc));
1532
1533 session->app_data = app_data;
1534 session->app_cb = app_data ? callback : NULL;
1535#if COAP_WS_SUPPORT
1536 if (ws_host) {
1537 session->ws_host = coap_new_str_const(ws_host->s, ws_host->length);
1538 }
1539#else /* ! COAP_WS_SUPPORT */
1540 (void)ws_host;
1541#endif /* ! COAP_WS_SUPPORT */
1542
1543 if (COAP_PROTO_NOT_RELIABLE(proto)) {
1544 coap_session_t *s, *rtmp;
1545 if (!coap_netif_dgrm_connect(session, local_if, server, default_port)) {
1546 goto error;
1547 }
1548 /* Check that this is not a duplicate 4-tuple */
1549 SESSIONS_ITER_SAFE(ctx->sessions, s, rtmp) {
1552 &s->addr_info.local) &&
1554 &s->addr_info.remote)) {
1555 coap_log_warn("***%s: session %p: duplicate - already exists\n",
1556 coap_session_str(session), (void *)session);
1557 goto error;
1558 }
1559 }
1560#ifdef WITH_CONTIKI
1561 session->sock.context = ctx;
1562#endif /* WITH_CONTIKI */
1563#if !COAP_DISABLE_TCP
1564 } else if (COAP_PROTO_RELIABLE(proto)) {
1565 if (!coap_netif_strm_connect1(session, local_if, server, default_port)) {
1566 goto error;
1567 }
1568#endif /* !COAP_DISABLE_TCP */
1569 }
1570
1571 session->sock.session = session;
1572#ifdef COAP_EPOLL_SUPPORT
1573 coap_epoll_ctl_add(&session->sock,
1574 EPOLLIN |
1575 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1576 EPOLLOUT : 0),
1577 __func__);
1578#endif /* COAP_EPOLL_SUPPORT */
1579
1581 if (local_if)
1582 session->sock.flags |= COAP_SOCKET_BOUND;
1583#if COAP_SERVER_SUPPORT
1584 if (ctx->proxy_uri_resource)
1585 session->proxy_session = 1;
1586#endif /* COAP_SERVER_SUPPORT */
1587 SESSIONS_ADD(ctx->sessions, session);
1588 return session;
1589
1590error:
1591 /*
1592 * Need to add in the session as coap_session_release_lkd()
1593 * will call SESSIONS_DELETE in coap_session_free().
1594 */
1595 if (session)
1596 SESSIONS_ADD(ctx->sessions, session);
1597 coap_session_release_lkd(session);
1598 return NULL;
1599}
1600
1601static void
1602coap_session_check_connect(coap_session_t *session) {
1603 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1604 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1605 }
1606#if !COAP_DISABLE_TCP
1607 if (COAP_PROTO_RELIABLE(session->proto)) {
1608 if (session->sock.flags & COAP_SOCKET_WANT_CONNECT) {
1610 if (session->client_initiated) {
1611 session->doing_first = 1;
1612 }
1613 } else {
1614 /* Initial connect worked immediately */
1615 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
1616 }
1617 }
1618#endif /* !COAP_DISABLE_TCP */
1619 coap_ticks(&session->last_rx_tx);
1620}
1621#endif /* COAP_CLIENT_SUPPORT */
1622
1623void
1625 if (COAP_PROTO_NOT_RELIABLE(session->proto))
1626 coap_session_connected(session);
1627#if !COAP_DISABLE_TCP
1628 if (COAP_PROTO_RELIABLE(session->proto))
1629 coap_session_send_csm(session);
1630#endif /* !COAP_DISABLE_TCP */
1631}
1632
1633#if COAP_CLIENT_SUPPORT
1634int
1636 int default_port = COAP_DEFAULT_PORT;
1637
1638 if (session->sock.lfunc[COAP_LAYER_SESSION].l_close && !session->session_failed)
1639 session->sock.lfunc[COAP_LAYER_SESSION].l_close(session);
1640
1641 switch (session->proto) {
1642 case COAP_PROTO_UDP:
1643 default_port = COAP_DEFAULT_PORT;
1644 break;
1645 case COAP_PROTO_DTLS:
1646 default_port = COAPS_DEFAULT_PORT;
1647 break;
1648 case COAP_PROTO_TCP:
1649 default_port = COAP_DEFAULT_PORT;
1650 break;
1651 case COAP_PROTO_TLS:
1652 default_port = COAPS_DEFAULT_PORT;
1653 break;
1654 case COAP_PROTO_WS:
1655 default_port = 80;
1656 break;
1657 case COAP_PROTO_WSS:
1658 default_port = 443;
1659 break;
1660 case COAP_PROTO_NONE:
1661 case COAP_PROTO_LAST:
1662 default:
1663 assert(0);
1664 return 0;
1665 }
1666 session->sock.session = session;
1667 coap_log_debug("***%s: trying to reconnect\n", coap_session_str(session));
1669 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
1670 session->state = COAP_SESSION_STATE_NONE;
1671 if (!coap_netif_dgrm_connect(session, &session->local_reconnect, &session->addr_info.remote,
1672 default_port)) {
1673 goto error;
1674 }
1676#ifdef WITH_CONTIKI
1677 session->sock.context = session->context;
1678#endif /* WITH_CONTIKI */
1679#if !COAP_DISABLE_TCP
1680 } else if (COAP_PROTO_RELIABLE(session->proto)) {
1681 if (!coap_netif_strm_connect1(session, &session->local_reconnect, &session->addr_info.remote,
1682 default_port)) {
1683 goto error;
1684 }
1685#endif /* !COAP_DISABLE_TCP */
1686 } else {
1687 goto error;
1688 }
1689#ifdef COAP_EPOLL_SUPPORT
1690 coap_epoll_ctl_add(&session->sock,
1691 EPOLLIN |
1692 ((session->sock.flags & COAP_SOCKET_WANT_CONNECT) ?
1693 EPOLLOUT : 0),
1694 __func__);
1695#endif /* COAP_EPOLL_SUPPORT */
1696
1698 session->sock.flags |= COAP_SOCKET_BOUND;
1699 coap_session_check_connect(session);
1700 return 1;
1701error:
1702 return 0;
1703}
1704
1705void
1707 coap_lg_crcv_t *lg_crcv, *etmp;
1708
1709 if (!session->session_failed)
1710 return;
1711 coap_log_debug("***%s: session re-established\n",
1712 coap_session_str(session));
1713 session->session_failed = 0;
1714 session->retry_count = 0;
1716 LL_FOREACH_SAFE(session->lg_crcv, lg_crcv, etmp) {
1717 coap_pdu_reference_lkd(lg_crcv->sent_pdu);
1718 coap_send_internal(session, lg_crcv->sent_pdu, NULL);
1719 }
1720}
1721
1724 const coap_address_t *local_if,
1725 const coap_address_t *server,
1726 coap_proto_t proto) {
1727 coap_session_t *session;
1728
1729 coap_lock_lock(return NULL);
1730 session = coap_new_client_session3_lkd(ctx, local_if, server, proto, NULL, NULL, NULL);
1732 return session;
1733}
1734
1737 const coap_address_t *local_if,
1738 const coap_address_t *server,
1739 coap_proto_t proto,
1740 void *app_data,
1742 coap_str_const_t *ws_host) {
1743 coap_session_t *session;
1744
1745 coap_lock_lock(return NULL);
1746 session = coap_new_client_session3_lkd(ctx, local_if, server, proto, app_data, callback, ws_host);
1748 return session;
1749}
1750
1753 const coap_address_t *local_if,
1754 const coap_address_t *server,
1755 coap_proto_t proto,
1756 void *app_data,
1758 coap_str_const_t *ws_host) {
1759 coap_session_t *session;
1760
1762 session = coap_session_create_client(ctx, local_if, server,
1763 proto, app_data, callback, ws_host);
1764 if (session) {
1765 coap_log_debug("***%s: session %p: created outgoing session\n",
1766 coap_session_str(session), (void *)session);
1767 coap_session_check_connect(session);
1768 }
1769 return session;
1770}
1771
1774 const coap_address_t *local_if,
1775 const coap_address_t *server,
1776 coap_proto_t proto, const char *identity,
1777 const uint8_t *key, unsigned key_len) {
1778 coap_session_t *session;
1779
1780 coap_lock_lock(return NULL);
1781 session = coap_new_client_session_psk_lkd(ctx, local_if, server, proto, identity, key, key_len);
1783 return session;
1784}
1785
1788 const coap_address_t *local_if,
1789 const coap_address_t *server,
1790 coap_proto_t proto, const char *identity,
1791 const uint8_t *key, unsigned key_len) {
1792 coap_dtls_cpsk_t setup_data;
1793
1795 memset(&setup_data, 0, sizeof(setup_data));
1797
1798 if (identity) {
1799 setup_data.psk_info.identity.s = (const uint8_t *)identity;
1800 setup_data.psk_info.identity.length = strlen(identity);
1801 }
1802
1803 if (key && key_len > 0) {
1804 setup_data.psk_info.key.s = key;
1805 setup_data.psk_info.key.length = key_len;
1806 }
1807
1808 return coap_new_client_session_psk3_lkd(ctx, local_if, server,
1809 proto, &setup_data, NULL, NULL, NULL);
1810}
1811
1812/*
1813 * Check the validity of the SNI to send to the server.
1814 *
1815 * https://datatracker.ietf.org/doc/html/rfc6066#section-3
1816 * Literal IPv4 and IPv6 addresses are not permitted in "HostName".
1817 */
1818static void
1819coap_sanitize_client_sni(char **client_sni) {
1820 char *cp;
1821
1822 if (*client_sni == NULL)
1823 return;
1824
1825 cp = *client_sni;
1826 switch (*cp) {
1827 case '0':
1828 case '1':
1829 case '2':
1830 case '3':
1831 case '4':
1832 case '5':
1833 case '6':
1834 case '7':
1835 case '8':
1836 case '9':
1837 case 'a':
1838 case 'b':
1839 case 'c':
1840 case 'd':
1841 case 'e':
1842 case 'f':
1843 case 'A':
1844 case 'B':
1845 case 'C':
1846 case 'D':
1847 case 'E':
1848 case 'F':
1849 case ':':
1850 break;
1851 case '\000':
1852 /* Empty entry invalid */
1853 *client_sni = NULL;
1854 return;
1855 default:
1856 /* Does not start with a hex digit or : - not literal IP. */
1857 return;
1858 }
1859 /* Check for IPv4 */
1860 while (*cp) {
1861 switch (*cp) {
1862 case '0':
1863 case '1':
1864 case '2':
1865 case '3':
1866 case '4':
1867 case '5':
1868 case '6':
1869 case '7':
1870 case '8':
1871 case '9':
1872 case '.':
1873 break;
1874 default:
1875 /* Not of format nnn.nnn.nnn.nnn. Could be IPv6 */
1876 goto check_ipv6;
1877 }
1878 cp++;
1879 }
1880 /* IPv4 address - not allowed. */
1881 *client_sni = NULL;
1882 return;
1883
1884check_ipv6:
1885 /* Check for IPv6 */
1886 cp = *client_sni;
1887 while (*cp) {
1888 switch (*cp) {
1889 case '0':
1890 case '1':
1891 case '2':
1892 case '3':
1893 case '4':
1894 case '5':
1895 case '6':
1896 case '7':
1897 case '8':
1898 case '9':
1899 case 'a':
1900 case 'b':
1901 case 'c':
1902 case 'd':
1903 case 'e':
1904 case 'f':
1905 case 'A':
1906 case 'B':
1907 case 'C':
1908 case 'D':
1909 case 'E':
1910 case 'F':
1911 case ':':
1912 break;
1913 case '%':
1914 /* Start of i/f specification, Previous is IPv6 */
1915 *client_sni = NULL;
1916 return;
1917 default:
1918 /* Not of format xx:xx::xx. */
1919 return;
1920 }
1921 cp++;
1922 }
1923 *client_sni = NULL;
1924 return;
1925}
1926
1929 const coap_address_t *local_if,
1930 const coap_address_t *server,
1931 coap_proto_t proto,
1932 coap_dtls_cpsk_t *setup_data) {
1933 coap_session_t *session;
1934
1935 coap_lock_lock(return NULL);
1936 session = coap_new_client_session_psk3_lkd(ctx, local_if, server, proto, setup_data,
1937 NULL, NULL, NULL);
1939 return session;
1940}
1941
1944 const coap_address_t *local_if,
1945 const coap_address_t *server,
1946 coap_proto_t proto,
1947 coap_dtls_cpsk_t *setup_data,
1948 void *app_data,
1950 coap_str_const_t *ws_host) {
1951 coap_session_t *session;
1952
1953 coap_lock_lock(return NULL);
1954 session = coap_new_client_session_psk3_lkd(ctx, local_if, server, proto,
1955 setup_data, app_data, callback, ws_host);
1957 return session;
1958}
1959
1962 const coap_address_t *local_if,
1963 const coap_address_t *server,
1964 coap_proto_t proto,
1965 coap_dtls_cpsk_t *setup_data,
1966 void *app_data,
1968 coap_str_const_t *ws_host) {
1969 coap_session_t *session;
1970
1972 session = coap_session_create_client(ctx, local_if, server, proto, app_data, callback, ws_host);
1973
1974 if (!session || !setup_data)
1975 return NULL;
1976
1977 session->cpsk_setup_data = *setup_data;
1978 if (setup_data->psk_info.identity.s) {
1979 session->psk_identity =
1981 setup_data->psk_info.identity.length);
1982 if (!session->psk_identity) {
1983 coap_log_warn("Cannot store session Identity (PSK)\n");
1984 coap_session_release_lkd(session);
1985 return NULL;
1986 }
1988 coap_log_warn("Identity (PSK) not defined\n");
1989 coap_session_release_lkd(session);
1990 return NULL;
1991 }
1992
1993 if (setup_data->psk_info.key.s && setup_data->psk_info.key.length > 0) {
1994 session->psk_key = coap_new_bin_const(setup_data->psk_info.key.s,
1995 setup_data->psk_info.key.length);
1996 if (!session->psk_key) {
1997 coap_log_warn("Cannot store session pre-shared key (PSK)\n");
1998 coap_session_release_lkd(session);
1999 return NULL;
2000 }
2002 coap_log_warn("Pre-shared key (PSK) not defined\n");
2003 coap_session_release_lkd(session);
2004 return NULL;
2005 }
2006
2007 coap_sanitize_client_sni(&session->cpsk_setup_data.client_sni);
2008
2010 if (!coap_dtls_context_set_cpsk(ctx, &session->cpsk_setup_data)) {
2011 coap_session_release_lkd(session);
2012 return NULL;
2013 }
2014 }
2015 coap_log_debug("***%s: new outgoing session\n",
2016 coap_session_str(session));
2017 coap_session_check_connect(session);
2018 return session;
2019}
2020#endif /* COAP_CLIENT_SUPPORT */
2021
2022int
2024 const coap_bin_const_t *psk_hint
2025 ) {
2026 /* We may be refreshing the hint with the same hint */
2027 coap_bin_const_t *old_psk_hint = session->psk_hint;
2028
2029 if (psk_hint && psk_hint->s) {
2030 if (session->psk_hint) {
2031 if (coap_binary_equal(session->psk_hint, psk_hint))
2032 return 1;
2033 }
2034 session->psk_hint = coap_new_bin_const(psk_hint->s,
2035 psk_hint->length);
2036 if (!session->psk_hint) {
2037 coap_log_err("No memory to store identity hint (PSK)\n");
2038 if (old_psk_hint)
2039 coap_delete_bin_const(old_psk_hint);
2040 return 0;
2041 }
2042 } else {
2043 session->psk_hint = NULL;
2044 }
2045 if (old_psk_hint)
2046 coap_delete_bin_const(old_psk_hint);
2047
2048 return 1;
2049}
2050
2051int
2053 const coap_bin_const_t *psk_key
2054 ) {
2055 /* We may be refreshing the key with the same key */
2056 coap_bin_const_t *old_psk_key = session->psk_key;
2057
2058 if (psk_key && psk_key->s) {
2059 if (session->psk_key) {
2060 if (coap_binary_equal(session->psk_key, psk_key))
2061 return 1;
2062 }
2063 session->psk_key = coap_new_bin_const(psk_key->s, psk_key->length);
2064 if (!session->psk_key) {
2065 coap_log_err("No memory to store pre-shared key (PSK)\n");
2066 if (old_psk_key)
2067 coap_delete_bin_const(old_psk_key);
2068 return 0;
2069 }
2070 } else {
2071 session->psk_key = NULL;
2072 }
2073 if (old_psk_key)
2074 coap_delete_bin_const(old_psk_key);
2075
2076 return 1;
2077}
2078
2079int
2081 const coap_bin_const_t *psk_identity
2082 ) {
2083 /* We may be refreshing the identity with the same identity */
2084 coap_bin_const_t *old_psk_identity = session->psk_identity;
2085
2086 if (psk_identity && psk_identity->s) {
2087 if (session->psk_identity) {
2088 if (coap_binary_equal(session->psk_identity, psk_identity))
2089 return 1;
2090 }
2091 session->psk_identity = coap_new_bin_const(psk_identity->s,
2092 psk_identity->length);
2093 if (!session->psk_identity) {
2094 coap_log_err("No memory to store pre-shared key identity (PSK)\n");
2095 if (old_psk_identity)
2096 coap_delete_bin_const(old_psk_identity);
2097 return 0;
2098 }
2099 } else {
2100 session->psk_identity = NULL;
2101 }
2102 if (old_psk_identity)
2103 coap_delete_bin_const(old_psk_identity);
2104
2105 return 1;
2106}
2107
2108#if COAP_SERVER_SUPPORT
2109const coap_bin_const_t *
2111 if (session)
2112 return session->psk_hint;
2113 return NULL;
2114}
2115#endif /* COAP_SERVER_SUPPORT */
2116
2117const coap_bin_const_t *
2119 const coap_bin_const_t *psk_identity = NULL;
2120 if (session) {
2121 psk_identity = session->psk_identity;
2122 if (psk_identity == NULL) {
2123 psk_identity = &session->cpsk_setup_data.psk_info.identity;
2124 }
2125 }
2126 return psk_identity;
2127}
2128
2129const coap_bin_const_t *
2131 if (session)
2132 return session->psk_key;
2133 return NULL;
2134}
2135
2136#if COAP_CLIENT_SUPPORT
2139 const coap_address_t *local_if,
2140 const coap_address_t *server,
2141 coap_proto_t proto,
2142 coap_dtls_pki_t *setup_data) {
2143 coap_session_t *session;
2144
2145 coap_lock_lock(return NULL);
2146 session = coap_new_client_session_pki3_lkd(ctx, local_if, server, proto, setup_data,
2147 NULL, NULL, NULL);
2149 return session;
2150}
2151
2154 const coap_address_t *local_if,
2155 const coap_address_t *server,
2156 coap_proto_t proto,
2157 coap_dtls_pki_t *setup_data,
2158 void *app_data,
2160 coap_str_const_t *ws_host) {
2161 coap_session_t *session;
2162
2163 coap_lock_lock(return NULL);
2164 session = coap_new_client_session_pki3_lkd(ctx, local_if, server, proto, setup_data,
2165 app_data, callback, ws_host);
2167 return session;
2168}
2169
2172 const coap_address_t *local_if,
2173 const coap_address_t *server,
2174 coap_proto_t proto,
2175 coap_dtls_pki_t *setup_data,
2176 void *app_data,
2178 coap_str_const_t *ws_host) {
2179 coap_session_t *session;
2180 coap_dtls_pki_t l_setup_data;
2181
2182 if (!setup_data)
2183 return NULL;
2184 if (setup_data->version != COAP_DTLS_PKI_SETUP_VERSION) {
2185 coap_log_err("coap_new_client_session_pki: Wrong version of setup_data\n");
2186 return NULL;
2187 }
2188
2190 l_setup_data = *setup_data;
2191 coap_sanitize_client_sni(&l_setup_data.client_sni);
2192
2193 session = coap_session_create_client(ctx, local_if, server, proto, app_data, callback, ws_host);
2194
2195 if (!session) {
2196 return NULL;
2197 }
2198
2200 /* we know that setup_data is not NULL */
2201 if (!coap_dtls_context_set_pki(ctx, &l_setup_data, COAP_DTLS_ROLE_CLIENT)) {
2202 coap_session_release_lkd(session);
2203 return NULL;
2204 }
2205 }
2206 coap_log_debug("***%s: new outgoing session\n",
2207 coap_session_str(session));
2208 coap_session_check_connect(session);
2209 return session;
2210}
2211#endif /* ! COAP_CLIENT_SUPPORT */
2212
2213#if COAP_SERVER_SUPPORT
2214#if !COAP_DISABLE_TCP
2216coap_new_server_session(coap_context_t *ctx, coap_endpoint_t *ep, void *extra) {
2217 coap_session_t *session;
2218 coap_tick_t now;
2219
2220 session = coap_make_session(ep->proto, COAP_SESSION_TYPE_SERVER,
2221 NULL, NULL, NULL, 0, ctx, ep);
2222 if (!session)
2223 goto error;
2224
2225 memcpy(session->sock.lfunc, ep->sock.lfunc, sizeof(session->sock.lfunc));
2226 if (!coap_netif_strm_accept(ep, session, extra))
2227 goto error;
2228
2229 coap_make_addr_hash(&session->addr_hash, session->proto, &session->addr_info);
2230
2231 session->sock.session = session;
2232#ifdef COAP_EPOLL_SUPPORT
2233 coap_epoll_ctl_add(&session->sock,
2234 EPOLLIN,
2235 __func__);
2236#endif /* COAP_EPOLL_SUPPORT */
2237 SESSIONS_ADD(ep->sessions, session);
2238 if (session) {
2239 coap_ticks(&now);
2240 session->last_rx_tx = now;
2241 coap_log_debug("***%s: session %p: new incoming session\n",
2242 coap_session_str(session), (void *)session);
2246 session->sock.lfunc[COAP_LAYER_SESSION].l_establish(session);
2247 }
2248 return session;
2249
2250error:
2251 /*
2252 * Need to add in the session as coap_session_release_lkd()
2253 * will call SESSIONS_DELETE in coap_session_free().
2254 */
2255 if (session) {
2256 SESSIONS_ADD(ep->sessions, session);
2257 coap_session_free(session);
2258 }
2259 return NULL;
2260}
2261#endif /* !COAP_DISABLE_TCP */
2262#endif /* COAP_SERVER_SUPPORT */
2263
2264void
2266 const uint8_t *data) {
2267 session->tx_token = coap_decode_var_bytes8(data, len);
2268 /*
2269 * Decrement as when first used by coap_session_new_token() it will
2270 * get incremented
2271 */
2272 session->tx_token--;
2273}
2274
2275void
2277 uint8_t *data) {
2278 *len = coap_encode_var_safe8(data,
2279 sizeof(session->tx_token), ++session->tx_token);
2280}
2281
2282COAP_API uint16_t
2284 uint16_t mid;
2285
2286 coap_lock_lock(return 0);
2287 mid = coap_new_message_id_lkd(session);
2289 return mid;
2290}
2291
2292uint16_t
2295 if (COAP_PROTO_NOT_RELIABLE(session->proto))
2296 return ++session->tx_mid;
2297 /* TCP/TLS have no notion of mid */
2298 return 0;
2299}
2300
2301const coap_address_t *
2303 if (session)
2304 return &session->addr_info.remote;
2305 return NULL;
2306}
2307
2308const coap_address_t *
2310 if (session)
2311 return &session->addr_info.local;
2312 return NULL;
2313}
2314
2315const coap_address_t *
2317#if COAP_CLIENT_SUPPORT
2318 if (session && session->type == COAP_SESSION_TYPE_CLIENT &&
2319 session->sock.flags & COAP_SOCKET_MULTICAST)
2320 return &session->sock.mcast_addr;
2321#else /* ! COAP_CLIENT_SUPPORT */
2322 (void)session;
2323#endif /* ! COAP_CLIENT_SUPPORT */
2324 return NULL;
2325}
2326
2329 if (session)
2330 return session->context;
2331 return NULL;
2332}
2333
2336 if (session)
2337 return session->proto;
2338 return 0;
2339}
2340
2343 if (session)
2344 return session->type;
2345 return 0;
2346}
2347
2348int
2350#if COAP_OSCORE_SUPPORT
2351 return (session && session->oscore_encryption != 0) ? 1 : 0;
2352#else
2353 (void)session;
2354 return 0;
2355#endif
2356}
2357
2358COAP_API int
2360 int ret;
2361
2362 coap_lock_lock(return 0);
2363 ret = coap_session_set_type_client_lkd(session, 1);
2365 return ret;
2366}
2367
2368int
2370#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2371 if (session && session->type == COAP_SESSION_TYPE_SERVER) {
2373 session->type = COAP_SESSION_TYPE_CLIENT;
2374 if (session->endpoint) {
2375 SESSIONS_DELETE(session->endpoint->sessions, session);
2376 SESSIONS_ADD(session->context->sessions, session);
2377 if (COAP_PROTO_NOT_RELIABLE(session->proto)) {
2378 session->sock = session->endpoint->sock;
2379 session->sock.flags |= COAP_SOCKET_SLAVE;
2380 session->sock.flags &= ~COAP_SOCKET_CAN_READ;
2381 session->sock.flags &= ~COAP_SOCKET_WANT_READ;
2382 } else {
2383 session->sock.endpoint = NULL;
2384 }
2385 session->endpoint = NULL;
2386 }
2387 if (report_changed) {
2388 coap_log_debug("***%s: session now is type Client\n",
2389 coap_session_str(session));
2390 }
2391 return 1;
2392 }
2393#else /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2394 (void)session;
2395 (void)report_changed;
2396#endif /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2397 return 0;
2398}
2399
2400COAP_API int
2402 int ret;
2403
2404 coap_lock_lock(return 0);
2405 ret = coap_session_set_type_server_lkd(session);
2407 return ret;
2408}
2409
2410int
2412#if COAP_CLIENT_SUPPORT && COAP_SERVER_SUPPORT
2413 if (session && session->type == COAP_SESSION_TYPE_CLIENT) {
2414 coap_endpoint_t *ep;
2415 coap_mid_t mid;
2416 coap_pdu_t *ping = NULL;
2417
2418 LL_FOREACH(session->context->endpoint, ep) {
2419 if (session->proto == ep->proto)
2420 break;
2421 }
2422 if (!ep) {
2423 /* Need a dummy endpoint to 'hang' off as this is now a server */
2424 ep = coap_malloc_endpoint();
2425 if (!ep) {
2426 coap_log_warn("coap_new_endpoint: malloc");
2427 return 0;
2428 }
2429
2430 memset(ep, 0, sizeof(coap_endpoint_t));
2431 ep->context = session->context;
2432 ep->proto = session->proto;
2433 ep->sock.endpoint = ep;
2434 memcpy(&ep->sock.lfunc, coap_layers_coap[session->proto], sizeof(ep->sock.lfunc));
2435
2436 ep->default_mtu = COAP_DEFAULT_MTU;
2437 LL_PREPEND(session->context->endpoint, ep);
2438 }
2439 /* Need to use coap_send_lkd() here to get traffic flowing */
2440 if (session->proto == COAP_PROTO_UDP) {
2442 coap_new_message_id_lkd(session), 0);
2443 if (!ping) {
2444 session->type = COAP_SESSION_TYPE_SERVER;
2445 return 0;
2446 }
2447 mid = coap_send_lkd(session, ping);
2448 if (mid != COAP_INVALID_MID) {
2449 coap_tick_t now;
2450
2451 coap_ticks(&now);
2452 session->last_ping_mid = mid;
2453 session->last_rx_tx = now;
2454 session->last_ping = now;
2455 }
2456 }
2457 /*
2458 * (D)TLS will initiate traffic with handshake.
2459 * Reliable protocols will be sending a CSM, so no nead for Ping.
2460 */
2461 if (session->context) {
2462 if (session->context->sessions) {
2463 SESSIONS_DELETE(session->context->sessions, session);
2464 }
2465 }
2466 SESSIONS_ADD(ep->sessions, session);
2467 session->endpoint = ep;
2468 session->type = COAP_SESSION_TYPE_SERVER;
2469 coap_session_release_lkd(session);
2470 coap_log_debug("***%s: session now is type Server\n",
2471 coap_session_str(session));
2472 return 1;
2473 }
2474#else /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2475 (void)session;
2476#endif /* ! COAP_CLIENT_SUPPORT || ! COAP_SERVER_SUPPORT */
2477 return 0;
2478}
2479
2482 if (session)
2483 return session->state;
2484 return 0;
2485}
2486
2489#if COAP_SERVER_SUPPORT
2490 if (session)
2491 return session->endpoint;
2492#else /* ! COAP_SERVER_SUPPORT */
2493 (void)session;
2494#endif /* ! COAP_SERVER_SUPPORT */
2495 return 0;
2496}
2497
2498int
2500 if (session)
2501 return session->ifindex;
2502 return -1;
2503}
2504
2505void *
2507 coap_tls_library_t *tls_lib) {
2508 if (session)
2509 return coap_dtls_get_tls(session, tls_lib);
2510 return NULL;
2511}
2512
2513static const char *
2515 switch (proto) {
2516 case COAP_PROTO_UDP:
2517 return "UDP ";
2518 case COAP_PROTO_DTLS:
2519 return "DTLS";
2520 case COAP_PROTO_TCP:
2521 return "TCP ";
2522 case COAP_PROTO_TLS:
2523 return "TLS ";
2524 case COAP_PROTO_WS:
2525 return "WS ";
2526 case COAP_PROTO_WSS:
2527 return "WSS ";
2528 case COAP_PROTO_NONE:
2529 case COAP_PROTO_LAST:
2530 default:
2531 return "????" ;
2532 break;
2533 }
2534 return NULL;
2535}
2536
2537#if COAP_SERVER_SUPPORT
2539coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto) {
2540 coap_endpoint_t *endpoint;
2541
2542 coap_lock_lock(return NULL);
2543 endpoint = coap_new_endpoint_lkd(context, listen_addr, proto);
2545 return endpoint;
2546}
2547
2549coap_new_endpoint_lkd(coap_context_t *context, const coap_address_t *listen_addr,
2550 coap_proto_t proto) {
2551 coap_endpoint_t *ep = NULL;
2552
2553 if (!context || !listen_addr) {
2554 coap_log_debug("coap_new_endpoint: Both context and listen_addr need to be defined\n");
2555 return NULL;
2556 }
2557
2559
2560 switch (proto) {
2561 case COAP_PROTO_UDP:
2562 break;
2563 case COAP_PROTO_DTLS:
2564 if (!coap_dtls_is_supported()) {
2565 coap_log_warn("coap_new_endpoint: DTLS not supported\n");
2566 return NULL;
2567 }
2568 break;
2569 case COAP_PROTO_TLS:
2570 if (!coap_tls_is_supported()) {
2571 coap_log_warn("coap_new_endpoint: TLS not supported\n");
2572 return NULL;
2573 }
2574 break;
2575 case COAP_PROTO_TCP:
2576 if (!coap_tcp_is_supported()) {
2577 coap_log_warn("coap_new_endpoint: TCP not supported\n");
2578 return NULL;
2579 }
2580 break;
2581 case COAP_PROTO_WS:
2582 if (!coap_ws_is_supported()) {
2583 coap_log_warn("coap_new_endpoint: WS not supported\n");
2584 return NULL;
2585 }
2586 break;
2587 case COAP_PROTO_WSS:
2588 if (!coap_wss_is_supported()) {
2589 coap_log_warn("coap_new_endpoint: WSS not supported\n");
2590 return NULL;
2591 }
2592 break;
2593 case COAP_PROTO_NONE:
2594 case COAP_PROTO_LAST:
2595 default:
2596 coap_log_crit("coap_new_endpoint: Unsupported protocol %d\n", proto);
2597 return NULL;
2598 }
2599
2600 if (proto == COAP_PROTO_DTLS || proto == COAP_PROTO_TLS ||
2601 proto == COAP_PROTO_WSS) {
2603 coap_log_info("coap_new_endpoint: one of coap_context_set_psk() or "
2604 "coap_context_set_pki() not called\n");
2605 return NULL;
2606 }
2607 }
2608 ep = coap_malloc_endpoint();
2609 if (!ep) {
2610 coap_log_warn("coap_new_endpoint: malloc");
2611 return NULL;
2612 }
2613
2614 memset(ep, 0, sizeof(coap_endpoint_t));
2615 ep->context = context;
2616 ep->proto = proto;
2617 ep->sock.endpoint = ep;
2618 if (proto < COAP_PROTO_LAST) {
2619 /*
2620 * Should be caught above, but come compilers realize that proto
2621 * includes COAP_PROTO_LAST, but there is no table entry for that
2622 */
2623 memcpy(&ep->sock.lfunc, coap_layers_coap[proto], sizeof(ep->sock.lfunc));
2624 }
2625
2626 if (COAP_PROTO_NOT_RELIABLE(proto)) {
2627 if (!coap_netif_dgrm_listen(ep, listen_addr))
2628 goto error;
2629#ifdef WITH_CONTIKI
2630 ep->sock.context = context;
2631#endif /* WITH_CONTIKI */
2632#if !COAP_DISABLE_TCP
2633 } else if (COAP_PROTO_RELIABLE(proto)) {
2634 if (!coap_netif_strm_listen(ep, listen_addr))
2635 goto error;
2636#endif /* !COAP_DISABLE_TCP */
2637 } else {
2638 coap_log_crit("coap_new_endpoint: Protocol type not supported %d\n", proto);
2639 goto error;
2640 }
2641
2643#ifndef INET6_ADDRSTRLEN
2644#define INET6_ADDRSTRLEN 40
2645#endif
2646 unsigned char addr_str[INET6_ADDRSTRLEN + 8];
2647
2648 if (coap_print_addr(&ep->bind_addr, addr_str, INET6_ADDRSTRLEN + 8)) {
2649 coap_log_debug("created %s endpoint %s\n", coap_proto_name(ep->proto),
2650 addr_str);
2651 }
2652 }
2653
2654 ep->default_mtu = COAP_DEFAULT_MTU;
2655
2656#ifdef COAP_EPOLL_SUPPORT
2657 ep->sock.endpoint = ep;
2658 coap_epoll_ctl_add(&ep->sock,
2659 EPOLLIN,
2660 __func__);
2661#endif /* COAP_EPOLL_SUPPORT */
2662
2663 LL_PREPEND(context->endpoint, ep);
2664 return ep;
2665
2666error:
2667 coap_free_endpoint_lkd(ep);
2668 return NULL;
2669}
2670
2671void
2673 ep->default_mtu = (uint16_t)mtu;
2674}
2675
2676COAP_API void
2678 if (ep) {
2679 coap_context_t *context = ep->context;
2680 if (context) {
2681 coap_lock_lock(return);
2682 }
2683 coap_free_endpoint_lkd(ep);
2684 if (context) {
2686 }
2687 }
2688}
2689
2690void
2691coap_free_endpoint_lkd(coap_endpoint_t *ep) {
2692 if (ep) {
2693 coap_session_t *session, *rtmp;
2694
2695 if (ep->context) {
2696 /* If fully allocated and inserted */
2698 SESSIONS_ITER_SAFE(ep->sessions, session, rtmp) {
2699 if (session->ref > 0) {
2701#if COAP_CLIENT_SUPPORT
2702 if (session->client_initiated) {
2703 coap_session_release_lkd(session);
2704 }
2705#endif /* COAP_CLIENT_SUPPORT */
2706 }
2707 assert(session->ref == 0);
2708 if (session->ref == 0) {
2710 coap_session_free(session);
2711 }
2712 }
2713 if (coap_netif_available_ep(ep)) {
2714 /*
2715 * ep->sock.endpoint is set in coap_new_endpoint().
2716 * ep->sock.session is never set.
2717 *
2718 * session->sock.session is set for both clients and servers (when a
2719 * new session is accepted), but does not affect the endpoint.
2720 *
2721 * So, it is safe to call coap_netif_close_ep() after all the sessions
2722 * have been freed above as we are only working with the endpoint sock.
2723 */
2724#ifdef COAP_EPOLL_SUPPORT
2725 assert(ep->sock.session == NULL);
2726#endif /* COAP_EPOLL_SUPPORT */
2728 }
2729
2730 if (ep->context->endpoint) {
2731 LL_DELETE(ep->context->endpoint, ep);
2732 }
2733 }
2734
2735 if (ep->app_cb) {
2736 coap_lock_callback(ep->app_cb(ep->app_data));
2737 }
2738
2739 coap_mfree_endpoint(ep);
2740 }
2741}
2742
2743void *
2745 assert(endpoint);
2746 return endpoint->app_data;
2747}
2748
2749COAP_API void *
2750coap_endpoint_set_app_data(coap_endpoint_t *endpoint, void *app_data,
2752 void *old_data;
2753
2754 coap_lock_lock(return NULL);
2755 old_data = coap_endpoint_set_app_data_lkd(endpoint, app_data, callback);
2757 return old_data;
2758}
2759
2760void *
2761coap_endpoint_set_app_data_lkd(coap_endpoint_t *endpoint, void *app_data,
2763 void *old_data = endpoint->app_data;
2764
2765 endpoint->app_data = app_data;
2766 endpoint->app_cb = app_data ? callback : NULL;
2767 return old_data;
2768}
2769
2770#endif /* COAP_SERVER_SUPPORT */
2771
2774 const coap_address_t *remote_addr,
2775 int ifindex) {
2776 coap_session_t *s, *rtmp;
2777#if COAP_CLIENT_SUPPORT
2778 SESSIONS_ITER(ctx->sessions, s, rtmp) {
2779 if (s->ifindex == ifindex) {
2780 if (s->sock.flags & COAP_SOCKET_MULTICAST) {
2781 if (coap_address_equals(&s->sock.mcast_addr, remote_addr))
2782 return s;
2783 } else if (coap_address_equals(&s->addr_info.remote, remote_addr))
2784 return s;
2785 }
2786 }
2787#endif /* COAP_CLIENT_SUPPORT */
2788#if COAP_SERVER_SUPPORT
2789 coap_endpoint_t *ep;
2790
2791 LL_FOREACH(ctx->endpoint, ep) {
2792 SESSIONS_ITER(ep->sessions, s, rtmp) {
2793 if (s->ifindex == ifindex && coap_address_equals(&s->addr_info.remote,
2794 remote_addr))
2795 return s;
2796 }
2797 }
2798#endif /* COAP_SERVER_SUPPORT */
2799 return NULL;
2800}
2801
2802#ifndef INET6_ADDRSTRLEN
2803#define INET6_ADDRSTRLEN 46
2804#endif
2805const char *
2807 static char szSession[2 * (INET6_ADDRSTRLEN + 8) + 24];
2808 char *p = szSession, *end = szSession + sizeof(szSession);
2809
2810 if (!session) {
2811 return "Session not defined";
2812 }
2813 if (coap_print_addr(&session->addr_info.local,
2814 (unsigned char *)p, end - p) > 0)
2815 p += strlen(p);
2816 if (p + 6 < end) {
2817 strcpy(p, " <-> ");
2818 p += 5;
2819 }
2820 if (p + 1 < end) {
2821 if (coap_print_addr(&session->addr_info.remote,
2822 (unsigned char *)p, end - p) > 0)
2823 p += strlen(p);
2824 }
2825 if (session->ifindex > 0 && p + 1 < end)
2826 p += snprintf(p, end - p, " (if%d)", session->ifindex);
2827 if (p + 6 < end) {
2828 strcpy(p, " ");
2829 p++;
2830 strcpy(p, coap_proto_name(session->proto));
2831 }
2832
2833 return szSession;
2834}
2835
2836#if COAP_SERVER_SUPPORT
2837const char *
2838coap_endpoint_str(const coap_endpoint_t *endpoint) {
2839 static char szEndpoint[128];
2840 char *p = szEndpoint, *end = szEndpoint + sizeof(szEndpoint);
2841 if (coap_print_addr(&endpoint->bind_addr, (unsigned char *)p, end - p) > 0)
2842 p += strlen(p);
2843 if (p + 6 < end) {
2844 if (endpoint->proto == COAP_PROTO_UDP) {
2845 strcpy(p, " UDP");
2846 } else if (endpoint->proto == COAP_PROTO_DTLS) {
2847 strcpy(p, " DTLS");
2848 } else {
2849 strcpy(p, " NONE");
2850 }
2851 }
2852
2853 return szEndpoint;
2854}
2855#endif /* COAP_SERVER_SUPPORT */
2856#if COAP_CLIENT_SUPPORT
2857void
2859 session->no_observe_cancel = 1;
2860}
2861
2862void
2864 if (session->type != COAP_SESSION_TYPE_CLIENT) {
2865 coap_lock_lock(return);
2867 coap_session_release_lkd(session);
2869 }
2870}
2871#endif /* COAP_CLIENT_SUPPORT */
2872#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:1510
#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:5111
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:3079
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:1378
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:1258
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:2030
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition coap_net.c:1284
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:3186
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:3225
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:812
size_t coap_print_addr(const coap_address_t *addr, unsigned char *buf, size_t len)
Print the address into the defined buffer.
Definition coap_debug.c:241
const char * coap_endpoint_str(const coap_endpoint_t *endpoint)
Get endpoint description.
const char * coap_session_str(const coap_session_t *session)
Get session description.
#define coap_log_info(...)
Definition coap_debug.h:114
#define coap_log_warn(...)
Definition coap_debug.h:108
#define coap_log_err(...)
Definition coap_debug.h:102
#define coap_log_crit(...)
Definition coap_debug.h:96
@ COAP_LOG_DEBUG
Definition coap_debug.h:64
int coap_netif_dgrm_listen(coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
Layer function interface for Netif datagram listem (udp).
void coap_netif_close_ep(coap_endpoint_t *endpoint)
Layer function interface for Netif close for a endpoint.
int coap_netif_strm_connect1(coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
Layer function interface for Netif stream connect (tcp).
int coap_netif_strm_accept(coap_endpoint_t *endpoint, coap_session_t *session, void *extra)
Layer function interface for Netif stream accept.
int coap_netif_strm_listen(coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
Layer function interface for Netif stream listem (tcp).
int coap_netif_dgrm_connect(coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
Layer function interface for Netif datagram connect (udp).
int coap_netif_available(coap_session_t *session)
Function interface to check whether netif for session is still available.
Definition coap_netif.c:25
int coap_netif_available_ep(coap_endpoint_t *endpoint)
Function interface to check whether netif for endpoint is still available.
void coap_delete_oscore_associations(coap_session_t *session)
Cleanup all allocated OSCORE association information.
void oscore_release_recipient_ctx(oscore_recipient_ctx_t **recipient_ctx)
Cleanup recipient context, including releasing the oscore context if the oscore context referenced is...
coap_pdu_t * coap_pdu_reference_lkd(coap_pdu_t *pdu)
Increment reference counter on a pdu to stop it prematurely getting freed off when coap_delete_pdu() ...
Definition coap_pdu.c:1730
void coap_delete_pdu_lkd(coap_pdu_t *pdu)
Dispose of an CoAP PDU and free off associated storage.
Definition coap_pdu.c:195
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:468
#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:1592
#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:844
#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:267
#define COAP_TOKEN_DEFAULT_MAX
Definition coap_pdu.h:58
#define COAP_SIGNALING_OPTION_EXTENDED_TOKEN_LENGTH
Definition coap_pdu.h:203
coap_proto_t
CoAP protocol types Note: coap_layers_coap[] needs updating if extended.
Definition coap_pdu.h:317
#define COAP_SIGNALING_OPTION_BLOCK_WISE_TRANSFER
Definition coap_pdu.h:202
#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:270
#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:201
@ COAP_PROTO_WS
Definition coap_pdu.h:323
@ COAP_PROTO_DTLS
Definition coap_pdu.h:320
@ COAP_PROTO_UDP
Definition coap_pdu.h:319
@ COAP_PROTO_NONE
Definition coap_pdu.h:318
@ COAP_PROTO_TLS
Definition coap_pdu.h:322
@ COAP_PROTO_WSS
Definition coap_pdu.h:324
@ COAP_PROTO_TCP
Definition coap_pdu.h:321
@ COAP_PROTO_LAST
Definition coap_pdu.h:325
@ COAP_SIGNALING_CODE_CSM
Definition coap_pdu.h:370
@ COAP_SIGNALING_CODE_PING
Definition coap_pdu.h:371
@ COAP_EMPTY_CODE
Definition coap_pdu.h:332
@ 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:1136
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