coap_oscore_internal.h

Go to the documentation of this file.

/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
/*
 * coap_oscore_internal.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_INTERNAL_H_
#define COAP_OSCORE_INTERNAL_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct coap_oscore_snd_conf_t {
  coap_bin_const_t *sender_id;     
};
 
struct coap_oscore_rcp_conf_t {
  struct coap_oscore_rcp_conf_t *next_recipient; 
  coap_bin_const_t *recipient_id;  
  /* Silent Server */
  int silent_server;       
  /* SSN handling for rfc8613 B.1.2 */
  uint8_t window_initialized; 
  uint64_t last_seq; 
  uint64_t sliding_window; 
};
 
struct coap_oscore_conf_t {
  coap_bin_const_t *master_secret; 
  coap_bin_const_t *master_salt;   
  coap_bin_const_t *id_context;    
  coap_oscore_snd_conf_t *sender;  
  coap_oscore_rcp_conf_t *recipient_chain; 
  uint32_t replay_window;          
  uint32_t ssn_freq;               
  cose_alg_t aead_alg;             
  cose_hkdf_alg_t hkdf_alg;        
  uint32_t rfc8613_b_1_2;          
  uint32_t rfc8613_b_2;            
  /* General Testing */
  uint32_t break_sender_key;     
  uint32_t break_recipient_key;  
  /* SSN handling (not in oscore_config[]) */
  coap_oscore_save_seq_num_t save_seq_num_func; 
  void *save_seq_num_func_param; 
  uint64_t start_seq_num;        
};
 
typedef enum oscore_partial_iv_t {
  OSCORE_SEND_NO_IV,  
  OSCORE_SEND_PARTIAL_IV 
} oscore_partial_iv_t;
 
COAP_API coap_pdu_t *coap_oscore_new_pdu_encrypted(coap_session_t *session,
                                                   coap_pdu_t *pdu,
                                                   coap_bin_const_t *kid_context,
                                                   oscore_partial_iv_t send_partial_iv);
 
coap_pdu_t *coap_oscore_new_pdu_encrypted_lkd(coap_session_t *session,
                                              coap_pdu_t *pdu,
                                              coap_bin_const_t *kid_context,
                                              oscore_partial_iv_t send_partial_iv);
 
struct coap_pdu_t *coap_oscore_decrypt_pdu(coap_session_t *session,
                                           coap_pdu_t *pdu);
 
void coap_delete_all_oscore(coap_context_t *context);
 
void coap_oscore_session_set_recipient_ctx(coap_session_t *session,
                                           oscore_recipient_ctx_t *recipient_ctx);
 
void coap_oscore_association_set_recipient_ctx(oscore_association_t *association,
                                               oscore_recipient_ctx_t *recipient_ctx);
 
int coap_oscore_is_attached(coap_context_t *c_context, oscore_ctx_t *oscore_ctx);
 
void coap_delete_oscore_associations(coap_session_t *session);
 
size_t coap_oscore_overhead(coap_session_t *session, coap_pdu_t *pdu);
 
int coap_rebuild_pdu_for_proxy(coap_pdu_t *pdu);
 
int coap_oscore_initiate(coap_session_t *session,
                         coap_oscore_conf_t *oscore_conf);
int coap_context_oscore_server_lkd(coap_context_t *context,
                                   coap_oscore_conf_t *oscore_conf);
 
int coap_delete_oscore_recipient_lkd(coap_context_t *context,
                                     coap_bin_const_t *recipient_id);
 
int coap_delete_oscore_snd_conf(coap_oscore_snd_conf_t *oscore_snd_conf);
 
int coap_delete_oscore_rcp_conf(coap_oscore_rcp_conf_t *oscore_rcp_conf);
 
coap_session_t *coap_new_client_session_oscore3_lkd(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);
 
oscore_ctx_t *coap_init_oscore_context_from_conf(coap_oscore_conf_t *oscore_conf);
 
coap_session_t *coap_new_client_session_oscore_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 *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_session_t *coap_new_client_session_oscore_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 *psk_data,
                                                        coap_oscore_conf_t *oscore_conf,
                                                        void *app_data,
                                                        coap_app_data_free_callback_t callback,
                                                        coap_str_const_t *ws_host);
 
int coap_new_oscore_recipient_lkd(coap_context_t *context,
                                  coap_bin_const_t *recipient_id);
 
int coap_oscore_recipient_set_latest_seq_lkd(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_INTERNAL_H */