mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-04 07:55:21 +00:00
eca0141152
This is a major refactoring of the handling of the cryptographic material of both the network and transport layers. The aim is to encapsulate the key object manipulation, and improve overall modularity. Pulls Applications and Subnets out of the bt_mesh and into separate modules, with static storage types on the data. This has several side-effects: - The Config Server no longer operates directly on the bt_mesh.subs and bt_mesh.apps lists, but goes through a public configuration interface, following the pattern set in #27908. - All iteration through the keys is done through iteration APIs - Key resolution on RX and TX is centralized. - Changes to the keys triggers events the other modules can register handlers for. - Friendship credentials are stored in the lpn and friend structures. Part of #27842. Signed-off-by: Trond Einar Snekvik <Trond.Einar.Snekvik@nordicsemi.no>
82 lines
2.6 KiB
C
82 lines
2.6 KiB
C
/*
|
|
* Copyright (c) 2020 Nordic Semiconductor ASA
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef ZEPHYR_SUBSYS_BLUETOOTH_MESH_APP_KEYS_H_
|
|
#define ZEPHYR_SUBSYS_BLUETOOTH_MESH_APP_KEYS_H_
|
|
|
|
#include <bluetooth/mesh.h>
|
|
#include "subnet.h"
|
|
|
|
/** Mesh Application. */
|
|
struct bt_mesh_app_key {
|
|
uint16_t net_idx;
|
|
uint16_t app_idx;
|
|
bool updated;
|
|
struct bt_mesh_app_cred {
|
|
uint8_t id;
|
|
uint8_t val[16];
|
|
} keys[2];
|
|
};
|
|
|
|
/** @brief Reset the app keys module. */
|
|
void bt_mesh_app_keys_reset(void);
|
|
|
|
/** @brief Get the application key with the given AppIdx.
|
|
*
|
|
* @param app_idx App index.
|
|
*
|
|
* @return The matching application, or NULL if the application isn't known.
|
|
*/
|
|
struct bt_mesh_app_key *bt_mesh_app_key_get(uint16_t app_idx);
|
|
|
|
/** @brief Initialize a new application key with the given parameters.
|
|
*
|
|
* @param app_idx AppIndex.
|
|
* @param net_idx NetIndex the application is bound to.
|
|
* @param old_key Current application key.
|
|
* @param new_key Updated application key, or NULL if not known.
|
|
*
|
|
* @return 0 on success, or (negative) error code on failure.
|
|
*/
|
|
int bt_mesh_app_key_set(uint16_t app_idx, uint16_t net_idx,
|
|
const uint8_t old_key[16], const uint8_t new_key[16]);
|
|
|
|
/** @brief Resolve the message encryption keys, given a message context.
|
|
*
|
|
* Will use the @c ctx::app_idx and @c ctx::net_idx fields to find a pair of
|
|
* message encryption keys. If @c ctx::app_idx represents a device key, the
|
|
* @c ctx::net_idx will be used to determine the net key. Otherwise, the
|
|
* @c ctx::net_idx parameter will be ignored.
|
|
*
|
|
* @param ctx Message context.
|
|
* @param sub Subnet return parameter.
|
|
* @param app_key Application return parameter.
|
|
* @param aid Application ID return parameter.
|
|
*
|
|
* @return 0 on success, or (negative) error code on failure.
|
|
*/
|
|
int bt_mesh_keys_resolve(struct bt_mesh_msg_ctx *ctx,
|
|
struct bt_mesh_subnet **sub,
|
|
const uint8_t *app_key[16], uint8_t *aid);
|
|
|
|
/** @brief Iterate through all matching application keys and call @c cb on each.
|
|
*
|
|
* @param dev_key Whether to return device keys.
|
|
* @param aid 7 bit application ID to match.
|
|
* @param rx RX structure to match against.
|
|
* @param cb Callback to call for every valid app key.
|
|
* @param cb_data Callback data to pass to the callback.
|
|
*
|
|
* @return The AppIdx that yielded a 0-return from the callback.
|
|
*/
|
|
uint16_t bt_mesh_app_key_find(bool dev_key, uint8_t aid,
|
|
struct bt_mesh_net_rx *rx,
|
|
int (*cb)(struct bt_mesh_net_rx *rx,
|
|
const uint8_t key[16], void *cb_data),
|
|
void *cb_data);
|
|
|
|
#endif /* ZEPHYR_SUBSYS_BLUETOOTH_MESH_APP_KEYS_H_ */
|