coap_dtls_internal.h

Go to the documentation of this file.

/*
 * coap_dtls_internal.h -- (Datagram) Transport Layer Support for libcoap
 *
 * Copyright (C) 2016      Olaf Bergmann <bergmann@tzi.org>
 * Copyright (C) 2017      Jean-Claude Michelou <jcm@spinetix.com>
 * Copyright (C) 2023-2026 Jon Shallow <supjps-libcoap@jpshallow.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of the CoAP library libcoap. Please see README for terms
 * of use.
 */
 
#ifndef COAP_DTLS_INTERNAL_H_
#define COAP_DTLS_INTERNAL_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* https://rfc-editor.org/rfc/rfc6347#section-4.2.4.1 */
#ifndef COAP_DTLS_RETRANSMIT_MS
#define COAP_DTLS_RETRANSMIT_MS 1000
#endif
#ifndef COAP_DTLS_RETRANSMIT_TOTAL_MS
#define COAP_DTLS_RETRANSMIT_TOTAL_MS 60000
#endif
 
#define COAP_DTLS_RETRANSMIT_COAP_TICKS (COAP_DTLS_RETRANSMIT_MS * COAP_TICKS_PER_SECOND / 1000)
 
/* For RFC9146 Connection ID support */
#ifndef COAP_DTLS_CID_LENGTH
#define COAP_DTLS_CID_LENGTH 8
#endif
 
typedef enum {
  COAP_DEFINE_KEY_CA,
  COAP_DEFINE_KEY_ROOT_CA,
  COAP_DEFINE_KEY_PUBLIC,
  COAP_DEFINE_KEY_PRIVATE
} coap_define_issue_key_t;
 
typedef enum {
  COAP_DEFINE_FAIL_BAD,
  COAP_DEFINE_FAIL_NOT_SUPPORTED,
  COAP_DEFINE_FAIL_NONE
} coap_define_issue_fail_t;
 
void *coap_dtls_new_context(coap_context_t *coap_context);
 
#if COAP_SERVER_SUPPORT
int coap_dtls_context_set_spsk(coap_context_t *coap_context,
                               coap_dtls_spsk_t *setup_data);
#endif /* COAP_SERVER_SUPPORT */
 
#if COAP_CLIENT_SUPPORT
int coap_dtls_context_set_cpsk(coap_context_t *coap_context,
                               coap_dtls_cpsk_t *setup_data);
#endif /* COAP_CLIENT_SUPPORT */
 
int coap_dtls_context_set_pki(coap_context_t *coap_context,
                              const coap_dtls_pki_t *setup_data,
                              const coap_dtls_role_t role);
 
int coap_dtls_context_set_pki_root_cas(coap_context_t *coap_context,
                                       const char *ca_file,
                                       const char *ca_dir);
 
int coap_dtls_context_load_pki_trust_store(coap_context_t *coap_context);
 
int coap_dtls_context_check_keys_enabled(coap_context_t *coap_context);
 
void coap_dtls_free_context(void *dtls_context);
 
#if COAP_CLIENT_SUPPORT
void *coap_dtls_new_client_session(coap_session_t *coap_session);
#endif /* COAP_CLIENT_SUPPORT */
 
#if COAP_SERVER_SUPPORT
void *coap_dtls_new_server_session(coap_session_t *coap_session);
#endif /* COAP_SERVER_SUPPORT */
 
void coap_dtls_free_session(coap_session_t *coap_session);
 
void coap_dtls_session_update_mtu(coap_session_t *coap_session);
 
ssize_t coap_dtls_send(coap_session_t *coap_session,
                       const uint8_t *data,
                       size_t data_len);
 
int coap_dtls_is_context_timeout(void);
 
coap_tick_t coap_dtls_get_context_timeout(void *dtls_context);
 
coap_tick_t coap_dtls_get_timeout(coap_session_t *coap_session,
                                  coap_tick_t now);
 
int coap_dtls_handle_timeout(coap_session_t *coap_session);
 
int coap_dtls_receive(coap_session_t *coap_session,
                      const uint8_t *data,
                      size_t data_len);
 
#if COAP_SERVER_SUPPORT
int coap_dtls_hello(coap_session_t *coap_session,
                    const uint8_t *data,
                    size_t data_len);
#endif /* COAP_SERVER_SUPPORT */
 
void coap_dtls_establish(coap_session_t *session);
 
void coap_dtls_close(coap_session_t *session);
 
unsigned int coap_dtls_get_overhead(coap_session_t *coap_session);
 
#if COAP_CLIENT_SUPPORT
void *coap_tls_new_client_session(coap_session_t *coap_session);
#endif /* COAP_CLIENT_SUPPORT */
 
#if COAP_SERVER_SUPPORT
void *coap_tls_new_server_session(coap_session_t *coap_session);
#endif /* COAP_SERVER_SUPPORT */
 
void coap_tls_free_session(coap_session_t *coap_session);
 
ssize_t coap_tls_write(coap_session_t *coap_session,
                       const uint8_t *data,
                       size_t data_len
                      );
 
ssize_t coap_tls_read(coap_session_t *coap_session,
                      uint8_t *data,
                      size_t data_len
                     );
 
void coap_tls_establish(coap_session_t *session);
 
void coap_tls_close(coap_session_t *session);
 
const coap_bin_const_t *coap_get_session_client_psk_key(
    const coap_session_t *coap_session);
 
const coap_bin_const_t *coap_get_session_client_psk_identity(
    const coap_session_t *coap_session);
 
const coap_bin_const_t *coap_get_session_server_psk_key(
    const coap_session_t *coap_session);
 
const coap_bin_const_t *coap_get_session_server_psk_hint(
    const coap_session_t *coap_session);
 
void coap_dtls_startup(void);
 
void coap_dtls_shutdown(void);
 
void *coap_dtls_get_tls(const coap_session_t *session,
                        coap_tls_library_t *tls_lib);
 
void coap_dtls_map_key_type_to_define(const coap_dtls_pki_t *setup_data,
                                      coap_dtls_key_t *key);
 
int coap_dtls_define_issue(coap_define_issue_key_t type,
                           coap_define_issue_fail_t fail,
                           coap_dtls_key_t *key,
                           const coap_dtls_role_t role,
                           int ret);
 
int coap_dtls_set_cid_tuple_change(coap_context_t *context, uint8_t every);
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_DTLS_INTERNAL_H */