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