coap_oscore.h

Go to the documentation of this file.

/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
/*
 * coap_oscore.h -- Object Security for Constrained RESTful Environments
 *                  (OSCORE) support for libcoap
 *
 * Copyright (C) 2019-2026 Olaf Bergmann <bergmann@tzi.org>
 * Copyright (C) 2021-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_OSCORE_H_
#define COAP_OSCORE_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef coap_oscore_conf_t *(*coap_oscore_find_handler_t)(
    const coap_session_t    *session,
    const coap_bin_const_t  *rcpkey_id,
    const coap_bin_const_t  *ctxkey_id
);
 
typedef int (*coap_oscore_update_seq_num_handler_t)(
    const coap_session_t *session,
    const coap_bin_const_t *rcpkey_id,
    const coap_bin_const_t *ctxkey_id,
    uint64_t             receiver_seq_num,
    uint64_t             seq_num_window
);
 
COAP_API coap_session_t *coap_new_client_session_oscore(coap_context_t *ctx,
                                                        const coap_address_t *local_if,
                                                        const coap_address_t *server,
                                                        coap_proto_t proto,
                                                        coap_oscore_conf_t *oscore_conf);
 
COAP_API coap_session_t *coap_new_client_session_oscore3(coap_context_t *ctx,
                                                         const coap_address_t *local_if,
                                                         const coap_address_t *server,
                                                         coap_proto_t proto,
                                                         coap_oscore_conf_t *oscore_conf,
                                                         void *app_data,
                                                         coap_app_data_free_callback_t callback,
                                                         coap_str_const_t *ws_host);
 
COAP_API coap_session_t *coap_new_client_session_oscore_psk(coap_context_t *ctx,
                                                            const coap_address_t *local_if,
                                                            const coap_address_t *server,
                                                            coap_proto_t proto,
                                                            coap_dtls_cpsk_t *psk_data,
                                                            coap_oscore_conf_t *oscore_conf);
 
COAP_API coap_session_t *coap_new_client_session_oscore_psk3(coap_context_t *ctx,
    const coap_address_t *local_if,
    const coap_address_t *server,
    coap_proto_t proto,
    coap_dtls_cpsk_t *psk_data,
    coap_oscore_conf_t *oscore_conf,
    void *app_data,
    coap_app_data_free_callback_t callback,
    coap_str_const_t *ws_host);
 
COAP_API coap_session_t *coap_new_client_session_oscore_pki(coap_context_t *ctx,
                                                            const coap_address_t *local_if,
                                                            const coap_address_t *server,
                                                            coap_proto_t proto,
                                                            coap_dtls_pki_t *pki_data,
                                                            coap_oscore_conf_t *oscore_conf);
 
COAP_API coap_session_t *coap_new_client_session_oscore_pki3(coap_context_t *ctx,
    const coap_address_t *local_if,
    const coap_address_t *server,
    coap_proto_t proto,
    coap_dtls_pki_t *pki_data,
    coap_oscore_conf_t *oscore_conf,
    void *app_data,
    coap_app_data_free_callback_t callback,
    coap_str_const_t *ws_host);
 
COAP_API int coap_context_oscore_server(coap_context_t *context,
                                        coap_oscore_conf_t *oscore_conf);
 
typedef int (*coap_oscore_save_seq_num_t)(uint64_t sender_seq_num, void *param);
 
coap_oscore_conf_t *coap_new_oscore_conf(coap_str_const_t conf_mem,
                                         coap_oscore_save_seq_num_t save_seq_num_func,
                                         void *save_seq_num_func_param,
                                         uint64_t start_seq_num);
 
int coap_delete_oscore_conf(coap_oscore_conf_t *oscore_conf);
 
COAP_API void coap_oscore_register_external_handlers(
    coap_context_t                   *context,
    coap_oscore_find_handler_t           find_handler,
    coap_oscore_update_seq_num_handler_t update_seq_num_handler);
 
COAP_API int coap_new_oscore_recipient(coap_context_t *context,
                                       coap_bin_const_t *recipient_id);
 
COAP_API int coap_delete_oscore_recipient(coap_context_t *context,
                                          coap_bin_const_t *recipient_id);
 
COAP_API int coap_oscore_recipient_set_latest_seq(coap_oscore_conf_t *oscore_conf,
                                                  const coap_bin_const_t *recipient_id,
                                                  uint64_t last_seq,
                                                  uint64_t seq_window);
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_OSCORE_H */