libcoap 4.3.2rc2

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 * Copyright (c) 2018, SICS, RISE AB
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the Institute nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 */
32
47#ifndef _OSCORE_H
48#define _OSCORE_H
49
50#include <coap3/coap_internal.h>
51#include "oscore_cose.h"
52#include "oscore_context.h"
53
60/* Estimate your header size, especially when using Proxy-Uri. */
61#define COAP_MAX_HEADER_SIZE 70
62
63/* OSCORE error messages (to be moved elsewhere */
64#define OSCORE_DECRYPTION_ERROR 100
65#define PACKET_SERIALIZATION_ERROR 102
66
67/* oscore_cs_params
68 * returns cbor array [[param_type], [paramtype, param]]
69 */
70uint8_t *oscore_cs_params(int8_t param, int8_t param_type, size_t *len);
71
72/* oscore_cs_key_params
73 * returns cbor array [paramtype, param]
74 */
75uint8_t *oscore_cs_key_params(cose_curve_t param, int8_t param_type, size_t *len);
76
77/*
78 * oscore_encode_option_value
79 */
80 size_t oscore_encode_option_value(uint8_t *option_buffer,
81 size_t option_buf_len,
82 cose_encrypt0_t *cose,
83 uint8_t group,
84 uint8_t appendix_b_2);
85
86/*
87 * Decodes the OSCORE option value and places decoded values into the provided
88 * cose structure */
89 int oscore_decode_option_value(const uint8_t *option_value,
90 size_t option_len,
91 cose_encrypt0_t *cose);
92
93/* Creates AAD, creates External AAD and serializes it into the complete AAD
94 * structure. Returns serialized size. */
95 size_t oscore_prepare_aad(const uint8_t *external_aad_buffer,
96 size_t external_aad_len,
97 uint8_t *aad_buffer,
98 size_t aad_size);
99
100 size_t oscore_prepare_e_aad(oscore_ctx_t *ctx,
101 cose_encrypt0_t *cose,
102 const uint8_t *oscore_option,
103 size_t oscore_option_len,
104 coap_bin_const_t *sender_public_key,
105 uint8_t *external_aad_ptr,
106 size_t external_aad_size);
107
108/* Creates Nonce */
109 void oscore_generate_nonce(cose_encrypt0_t *ptr,
110 oscore_ctx_t *ctx,
111 uint8_t *buffer,
112 uint8_t size);
113
114/*Return 1 if OK, Error code otherwise */
115uint8_t oscore_validate_sender_seq(oscore_recipient_ctx_t *ctx,
116 cose_encrypt0_t *cose);
117
118/* Return 0 if SEQ MAX, return 1 if OK */
119uint8_t oscore_increment_sender_seq(oscore_ctx_t *ctx);
120
121/* Restore the sequence number and replay-window to the previous state. This is
122 * to be used when decryption fail. */
123 void oscore_roll_back_seq(oscore_recipient_ctx_t *ctx);
124
127#endif /* _OSCORE_H */
coap_internal.h
Pulls together all the internal only header files.
cose_curve_t
cose_curve_t
Definition: oscore_cose.h:60
oscore_prepare_aad
size_t oscore_prepare_aad(const uint8_t *external_aad_buffer, size_t external_aad_len, uint8_t *aad_buffer, size_t aad_size)
Definition: oscore.c:312
oscore_encode_option_value
size_t oscore_encode_option_value(uint8_t *option_buffer, size_t option_buf_len, cose_encrypt0_t *cose, uint8_t group, uint8_t appendix_b_2)
Definition: oscore.c:170
oscore_validate_sender_seq
uint8_t oscore_validate_sender_seq(oscore_recipient_ctx_t *ctx, cose_encrypt0_t *cose)
Definition: oscore.c:366
oscore_decode_option_value
int oscore_decode_option_value(const uint8_t *option_value, size_t option_len, cose_encrypt0_t *cose)
Definition: oscore.c:246
oscore_increment_sender_seq
uint8_t oscore_increment_sender_seq(oscore_ctx_t *ctx)
Definition: oscore.c:430
oscore_roll_back_seq
void oscore_roll_back_seq(oscore_recipient_ctx_t *ctx)
Definition: oscore.c:447
oscore_prepare_e_aad
size_t oscore_prepare_e_aad(oscore_ctx_t *ctx, cose_encrypt0_t *cose, const uint8_t *oscore_option, size_t oscore_option_len, coap_bin_const_t *sender_public_key, uint8_t *external_aad_ptr, size_t external_aad_size)
Definition: oscore.c:119
oscore_cs_key_params
uint8_t * oscore_cs_key_params(cose_curve_t param, int8_t param_type, size_t *len)
Definition: oscore.c:74
oscore_generate_nonce
void oscore_generate_nonce(cose_encrypt0_t *ptr, oscore_ctx_t *ctx, uint8_t *buffer, uint8_t size)
Definition: oscore.c:343
oscore_cs_params
uint8_t * oscore_cs_params(int8_t param, int8_t param_type, size_t *len)
Definition: oscore.c:53
oscore_context.h
An implementation of the Object Security for Constrained RESTful Enviornments (RFC 8613).
oscore_cose.h
An implementation of the CBOR Object Signing and Encryption (RFC).
coap_bin_const_t
CoAP binary data definition with const data.
Definition: coap_str.h:64
cose_encrypt0_t
Definition: oscore_cose.h:197
oscore_ctx_t
Definition: oscore_context.h:84
oscore_recipient_ctx_t
Definition: oscore_context.h:112