libcoap 4.3.2rc2

coap_oscore.h
Go to the documentation of this file.
1/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2
3/*
4 * coap_oscore.h -- Object Security for Constrained RESTful Environments
5 * (OSCORE) support for libcoap
6 *
7 * Copyright (C) 2019-2023 Olaf Bergmann <bergmann@tzi.org>
8 * Copyright (C) 2021-2023 Jon Shallow <supjps-libcoap@jpshallow.com>
9 *
10 * SPDX-License-Identifier: BSD-2-Clause
11 *
12 * This file is part of the CoAP library libcoap. Please see README for terms
13 * of use.
14 */
15
21#ifndef COAP_OSCORE_H_
22#define COAP_OSCORE_H_
23
36 int coap_oscore_is_supported(void);
37
57 coap_session_t *coap_new_client_session_oscore(coap_context_t *ctx,
58 const coap_address_t *local_if,
59 const coap_address_t *server,
60 coap_proto_t proto,
61 coap_oscore_conf_t *oscore_conf);
62
82 coap_session_t *coap_new_client_session_oscore_psk(coap_context_t *ctx,
83 const coap_address_t *local_if,
84 const coap_address_t *server,
85 coap_proto_t proto,
86 coap_dtls_cpsk_t *psk_data,
87 coap_oscore_conf_t *oscore_conf);
88
108 coap_session_t *coap_new_client_session_oscore_pki(coap_context_t *ctx,
109 const coap_address_t *local_if,
110 const coap_address_t *server,
111 coap_proto_t proto,
112 coap_dtls_pki_t *pki_data,
113 coap_oscore_conf_t *oscore_conf);
114
124 int coap_context_oscore_server(coap_context_t *context,
125 coap_oscore_conf_t *oscore_conf);
126
137 typedef int (*coap_oscore_save_seq_num_t)(uint64_t sender_seq_num, void *param);
138
155 coap_oscore_conf_t *coap_new_oscore_conf(coap_str_const_t conf_mem,
156 coap_oscore_save_seq_num_t save_seq_num_func,
157 void *save_seq_num_func_param,
158 uint64_t start_seq_num);
159
167 int coap_delete_oscore_conf(coap_oscore_conf_t *oscore_conf);
168
179 int coap_new_oscore_recipient(coap_context_t *context,
180 coap_bin_const_t *recipient_id);
181
193 int coap_delete_oscore_recipient(coap_context_t *context,
194 coap_bin_const_t *recipient_id);
195
198#endif /* COAP_OSCORE_H */
coap_new_oscore_conf
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)
Parse an OSCORE configuration (held in memory) and populate a OSCORE configuration structure.
Definition: coap_oscore.c:2163
coap_delete_oscore_recipient
int coap_delete_oscore_recipient(coap_context_t *context, coap_bin_const_t *recipient_id)
Release all the information associated for the specific Recipient ID (and hence and stop any further ...
Definition: coap_oscore.c:2189
coap_new_client_session_oscore_psk
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)
Creates a new client session to the designated server with PSK credentials as well as protecting the ...
Definition: coap_oscore.c:2123
coap_delete_oscore_conf
int coap_delete_oscore_conf(coap_oscore_conf_t *oscore_conf)
Release all the information associated with the OSCORE configuration.
Definition: coap_oscore.c:2175
coap_oscore_is_supported
int coap_oscore_is_supported(void)
Check whether OSCORE is available.
Definition: coap_oscore.c:2104
coap_new_client_session_oscore
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)
Creates a new client session to the designated server, protecting the data using OSCORE.
Definition: coap_oscore.c:2109
coap_new_oscore_recipient
int coap_new_oscore_recipient(coap_context_t *context, coap_bin_const_t *recipient_id)
Add in the specific Recipient ID into the OSCORE context (server only).
Definition: coap_oscore.c:2181
coap_new_client_session_oscore_pki
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)
Creates a new client session to the designated server with PKI credentials as well as protecting the ...
Definition: coap_oscore.c:2139
coap_context_oscore_server
int coap_context_oscore_server(coap_context_t *context, coap_oscore_conf_t *oscore_conf)
Set the context's default OSCORE configuration for a server.
Definition: coap_oscore.c:2155
coap_oscore_save_seq_num_t
int(* coap_oscore_save_seq_num_t)(uint64_t sender_seq_num, void *param)
Definition of the function used to save the current Sender Sequence Number.
Definition: coap_oscore.h:137
coap_proto_t
coap_proto_t
CoAP protocol types.
Definition: coap_pdu.h:304
coap_address_t
Multi-purpose address abstraction.
Definition: coap_address.h:109
coap_bin_const_t
CoAP binary data definition with const data.
Definition: coap_str.h:64
coap_context_t
The CoAP stack's global state is stored in a coap_context_t object.
Definition: coap_net_internal.h:49
coap_dtls_cpsk_t
The structure used for defining the Client PSK setup data to be used.
Definition: coap_dtls.h:378
coap_dtls_pki_t
The structure used for defining the PKI setup data to be used.
Definition: coap_dtls.h:284
coap_oscore_conf_t
The structure used to hold the OSCORE configuration information.
Definition: coap_oscore_internal.h:36
coap_session_t
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
Definition: coap_session_internal.h:68
coap_str_const_t
CoAP string data definition with const data.
Definition: coap_str.h:46