ieee802154_security.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2020 Otto-von-Guericke-Universität Magdeburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include <stdint.h>
#include "ieee802154.h"
#include "crypto/ciphers.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct ieee802154_sec_dev ieee802154_sec_dev_t;
 
typedef struct ieee802154_radio_cipher_ops {
    void (*set_key)(ieee802154_sec_dev_t *dev,
                    const uint8_t *key,
                    uint8_t key_size);
    void (*cbc)(const ieee802154_sec_dev_t *dev,
                uint8_t *cipher,
                uint8_t *iv,
                const uint8_t *plain,
                uint8_t nblocks);
    void (*ecb)(const ieee802154_sec_dev_t *dev,
                uint8_t *cipher,
                const uint8_t *plain,
                uint8_t nblocks);
} ieee802154_radio_cipher_ops_t;
 
struct ieee802154_sec_dev {
    const struct ieee802154_radio_cipher_ops *cipher_ops;
    void *ctx;
};
 
#if !defined(CONFIG_IEEE802154_SEC_DEFAULT_KEY) || defined(DOXYGEN)
#define CONFIG_IEEE802154_SEC_DEFAULT_KEY       "pizza_margherita"
#endif
 
#define IEEE802154_SEC_KEY_LENGTH               (16U)
 
#define IEEE802154_SEC_BLOCK_SIZE               (16U)
 
#define IEEE802154_SEC_MAX_AUX_HDR_LEN          (14U)
 
#define IEEE802154_SEC_MAX_MAC_SIZE             (16U)
 
#define IEEE802154_SEC_SCF_SECLEVEL_MASK        (0x07)
 
#define IEEE802154_SEC_SCF_SECLEVEL_SHIFT       (0)
 
#define IEEE802154_SEC_SCF_KEYMODE_MASK         (0x18)
 
#define IEEE802154_SEC_SCF_KEYMODE_SHIFT        (3)
 
typedef enum {
    IEEE802154_SEC_SCF_SECLEVEL_NONE            = 0x00, 
    IEEE802154_SEC_SCF_SECLEVEL_MIC32           = 0x01, 
    IEEE802154_SEC_SCF_SECLEVEL_MIC64           = 0x02, 
    IEEE802154_SEC_SCF_SECLEVEL_MIC128          = 0x03, 
    IEEE802154_SEC_SCF_SECLEVEL_ENC             = 0x04, 
    IEEE802154_SEC_SCF_SECLEVEL_ENC_MIC32       = 0x05, 
    IEEE802154_SEC_SCF_SECLEVEL_ENC_MIC64       = 0x06, 
    IEEE802154_SEC_SCF_SECLEVEL_ENC_MIC128      = 0x07  
} ieee802154_sec_scf_seclevel_t;
 
typedef enum {
    IEEE802154_SEC_SCF_KEYMODE_IMPLICIT         = 0x00, 
    IEEE802154_SEC_SCF_KEYMODE_INDEX            = 0x01, 
    IEEE802154_SEC_SCF_KEYMODE_SHORT_INDEX      = 0x02, 
    IEEE802154_SEC_SCF_KEYMODE_HW_INDEX         = 0x03  
} ieee802154_sec_scf_keymode_t;
 
typedef enum {
    IEEE802154_SEC_OK,                                  
    IEEE802154_SEC_FRAME_COUNTER_OVERFLOW,              
    IEEE802154_SEC_NO_KEY,                              
    IEEE802154_SEC_MAC_CHECK_FAILURE,                   
    IEEE802154_SEC_UNSUPORTED,                          
} ieee802154_sec_error_t;
 
typedef struct ieee802154_sec_context {
    cipher_t cipher;
    uint8_t security_level;
    uint8_t key_id_mode;
    uint8_t key_index;
    uint8_t key_source[IEEE802154_LONG_ADDRESS_LEN];
    uint32_t frame_counter;
    ieee802154_sec_dev_t dev;
} ieee802154_sec_context_t;
 
typedef struct __attribute__((packed)) {
    uint8_t scf;
    uint32_t fc;
    uint8_t key_id[];
} ieee802154_sec_aux_t;
 
typedef struct __attribute__((packed)) {
    uint8_t key_index;
} ieee802154_sec_aux_key_identifier_1_t;
 
typedef struct __attribute__((packed)) {
    uint8_t key_source[4];
    uint8_t key_index;
} ieee802154_sec_aux_key_identifier_5_t;
 
typedef struct __attribute__((packed)) {
    uint8_t key_source[IEEE802154_LONG_ADDRESS_LEN];
    uint8_t key_index;
} ieee802154_sec_aux_key_identifier_9_t;
 
typedef struct __attribute__((packed)) {
    uint8_t src_addr[IEEE802154_LONG_ADDRESS_LEN];
    uint32_t frame_counter;
    uint8_t security_level;
} ieee802154_sec_ccm_nonce_t;
 
typedef struct __attribute__((packed)) {
    uint8_t flags;
    ieee802154_sec_ccm_nonce_t nonce;
    uint16_t counter;
} ieee802154_sec_ccm_block_t;
 
void ieee802154_sec_init(ieee802154_sec_context_t *ctx);
 
int ieee802154_sec_encrypt_frame(ieee802154_sec_context_t *ctx,
                                 const uint8_t *header, uint8_t *header_size,
                                 uint8_t *payload, uint16_t payload_size,
                                 uint8_t *mic, uint8_t *mic_size,
                                 const uint8_t *src_address);
 
int ieee802154_sec_decrypt_frame(ieee802154_sec_context_t *ctx,
                                 uint16_t frame_size,
                                 uint8_t *header, uint8_t *header_size,
                                 uint8_t **payload, uint16_t *payload_size,
                                 uint8_t **mic, uint8_t *mic_size,
                                 const uint8_t *src_address);
 
extern const ieee802154_radio_cipher_ops_t ieee802154_radio_cipher_ops;
 
#ifdef __cplusplus
}
#endif