Contiki-NG
Loading...
Searching...
No Matches
ccm-star.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2013, Hasso-Plattner-Institut.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the Institute nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * This file is part of the Contiki operating system.
30 *
31 */
32
33/**
34 * \addtogroup crypto
35 * @{
36 * \file
37 * CCM* header file.
38 * \author
39 * Original: Konrad Krentz <konrad.krentz@gmail.com>
40 * Generified version: Justin King-Lacroix <justin.kinglacroix@gmail.com>
41 */
42#ifndef CCM_STAR_H_
43#define CCM_STAR_H_
44
45#include "contiki.h"
46
47#ifdef CCM_STAR_CONF
48#define CCM_STAR CCM_STAR_CONF
49#else /* CCM_STAR_CONF */
50#define CCM_STAR ccm_star_driver
51#endif /* CCM_STAR_CONF */
52
53#define CCM_STAR_NONCE_LENGTH 13
54
55/**
56 * Structure of CCM* drivers.
57 */
58struct ccm_star_driver {
59
60 /**
61 * \brief Sets the key in use.
62 * \param key The key to use.
63 *
64 * The default implementation calls AES_128.set_key().
65 */
66 void (* set_key)(const uint8_t *key);
67
68 /**
69 * \brief Combines authentication and encryption.
70 * \param nonce The nonce to use. CCM_STAR_NONCE_LENGTH bytes long.
71 * \param m message to encrypt or decrypt. Up to 0xffff
72 * \param a Additional authenticated data. Up to 0xfeff
73 * \param result The generated MIC will be put here
74 * \param mic_len The size of the MIC to be generated. <= 16.
75 * \param forward != 0 if used in forward direction.
76 */
77 void (* aead)(const uint8_t *nonce,
78 uint8_t *m, uint16_t m_len,
79 const uint8_t *a, uint16_t a_len,
80 uint8_t *result, uint8_t mic_len,
81 int forward);
82};
83
84extern const struct ccm_star_driver ccm_star_driver;
85extern const struct ccm_star_driver CCM_STAR;
86
87#endif /* CCM_STAR_H_ */
88
89/** @} */
ccm_star_driver
Structure of CCM* drivers.
Definition ccm-star.h:58
ccm_star_driver::aead
void(* aead)(const uint8_t *nonce, uint8_t *m, uint16_t m_len, const uint8_t *a, uint16_t a_len, uint8_t *result, uint8_t mic_len, int forward)
Combines authentication and encryption.
Definition ccm-star.h:77
ccm_star_driver::set_key
void(* set_key)(const uint8_t *key)
Sets the key in use.
Definition ccm-star.h:66