bluez/mesh
Michał Lowas-Rzechonek 37bbe30c92 mesh: Align appkey_packet_decrypt with dev and virt variants.
Move appkey_packet_decrypt to mesh/model, rename it to
app_packet_decrypt, make it private and change arguments to be aligned
with other decryption functions.

Also, simplify the implementation using an inline loop, removing the
need of mod_decrypt struct.
2019-10-03 13:10:16 -07:00
..
agent.c mesh: Remove unnecessary includes from .c files 2019-05-17 13:14:40 -07:00
agent.h mesh: Implement Provisioning Agent D-Bus interface 2019-01-08 08:26:22 -08:00
appkey.c mesh: Align appkey_packet_decrypt with dev and virt variants. 2019-10-03 13:10:16 -07:00
appkey.h mesh: Align appkey_packet_decrypt with dev and virt variants. 2019-10-03 13:10:16 -07:00
bluetooth-mesh.conf mesh: Allow sending on org.bluez.mesh.Provisioner1 2019-07-18 09:47:14 -07:00
bluetooth-mesh.service.in build: Add support for systemd bluetooth-mesh service 2019-06-06 11:58:22 -07:00
cfgmod-server.c mesh: Fix handling of Config Relay Set message 2019-08-16 08:24:45 -07:00
cfgmod.h mesh: Rename mesh_config_srv_init() to cfgmod_server_init() 2019-07-15 14:48:04 -07:00
crypto.c mesh: Remove unused defines 2019-10-03 13:10:16 -07:00
crypto.h mesh: test AEAD at startup to check kernel support 2019-09-01 08:34:00 -07:00
dbus.c mesh: Use l_dbus_message...() APIs in more consistent fashion 2019-07-04 10:08:49 -07:00
dbus.h mesh: Use l_dbus_message...() APIs in more consistent fashion 2019-07-04 10:08:49 -07:00
error.h mesh: Update copyright dates 2019-05-17 13:14:40 -07:00
friend.c mesh: Remove unnecessary includes from .c files 2019-05-17 13:14:40 -07:00
friend.h mesh: Refactor friend.c and net.c for central key DB 2018-10-03 13:42:52 -07:00
keyring.c mesh: Automate AppKey update on KR phase 2-->3-->0 2019-09-10 09:32:40 -07:00
keyring.h mesh: Automate AppKey update on KR phase 2-->3-->0 2019-09-10 09:32:40 -07:00
main.c mesh: test AEAD at startup to check kernel support 2019-09-01 08:34:00 -07:00
manager.c mesh: Fix Key Ring permissions for local nodes 2019-10-01 10:42:02 -07:00
manager.h mesh: Add skeleton for org.bluez.mesh.Management1 interface 2019-05-15 09:12:38 -07:00
mesh-config-json.c mesh: Make mesh-config API more consistent 2019-10-01 09:51:54 -07:00
mesh-config.h mesh: Make mesh-config API more consistent 2019-10-01 09:51:54 -07:00
mesh-defs.h mesh: Handle messages sent to a fixed group address 2019-09-08 07:14:30 -07:00
mesh-io-api.h mesh: Move HCI handling to mesh-io-generic 2019-06-24 09:04:44 -07:00
mesh-io-generic.c mesh: Show error message when io initialization fails 2019-08-28 09:43:17 -07:00
mesh-io-generic.h mesh: Shared private meshd interfaces 2018-08-20 12:48:14 -07:00
mesh-io.c mesh: Add special Beacon handler for Provisioning 2019-07-14 08:32:18 -07:00
mesh-io.h mesh: Add special Beacon handler for Provisioning 2019-07-14 08:32:18 -07:00
mesh-mgmt.c mesh: Move HCI handling to mesh-io-generic 2019-06-24 09:04:44 -07:00
mesh-mgmt.h mesh: Move HCI handling to mesh-io-generic 2019-06-24 09:04:44 -07:00
mesh.c mesh: Implement Import() D-Bus API of org.bluez.mesh.Network1 interface 2019-08-01 13:26:42 -07:00
mesh.h mesh: Manage node config directory in mesh-config 2019-07-15 14:48:04 -07:00
model.c mesh: Align appkey_packet_decrypt with dev and virt variants. 2019-10-03 13:10:16 -07:00
model.h mesh: Move commonly used constants into mesh-defs.h 2019-08-12 12:49:34 -04:00
net-keys.c mesh: Fixed handling of IVI flag in app layer 2019-06-27 10:13:35 -07:00
net-keys.h mesh: Update copyright dates 2019-05-17 13:14:40 -07:00
net.c mesh: Implement properties on org.bluez.mesh.Node1 interface 2019-08-28 09:31:15 -07:00
net.h mesh: Implement properties on org.bluez.mesh.Node1 interface 2019-08-28 09:31:15 -07:00
node.c mesh: Fix Key Ring permissions for local nodes 2019-10-01 10:42:02 -07:00
node.h mesh: Move sequence number overcommit to mesh-config-json 2019-08-08 15:17:37 -04:00
org.bluez.mesh.service build: Add support for systemd bluetooth-mesh service 2019-06-06 11:58:22 -07:00
pb-adv.c mesh: Convert provisioning pkts to packed structs 2019-07-14 08:32:18 -07:00
pb-adv.h mesh: Fix support for Provisioner Initiator 2019-07-14 08:32:18 -07:00
prov-acceptor.c mesh: Convert provisioning pkts to packed structs 2019-07-14 08:32:18 -07:00
prov-initiator.c mesh: Convert provisioning pkts to packed structs 2019-07-14 08:32:18 -07:00
prov.h mesh: Convert provisioning pkts to packed structs 2019-07-14 08:32:18 -07:00
provision.h mesh: Fix implementation of Provisioner Initiator 2019-07-14 08:32:18 -07:00
README mesh: ELL encrypt dependancy README section added 2019-05-31 16:46:34 -07:00
util.c mesh: Manage node config directory in mesh-config 2019-07-15 14:48:04 -07:00
util.h mesh: Manage node config directory in mesh-config 2019-07-15 14:48:04 -07:00

Bluetooth Mesh Daemon
*********************

Copyright (C) 2019  Intel Corporation. All rights reserved.

Compilation and installation
============================

In addition to main BlueZ requirements, MeshCtl needs the following:
	- json-c library

Configuration and options
=========================

	--enable-mesh

		Build mesh daemon and other Bluetooth Mesh based tools

Current implementation of the mesh daemon requires exclusive access to
a Bluetooth controller.
The AutoEnable option in the installed main.conf should be set to "false".

Storage
=======

Default storage directory is /var/lib/bluetooth/mesh.

The directory contains the provisioned nodes configurations.
Each node has its own subdirectory, named after node's Device UUID (32-digit
hexadecimal string) that is generated by the application that created a node.

Each subdirectory contains the following files:
	- node.json:
		node configuration and is populated by the
		daemon based on the configuration commands from a
		provisioner/configuration client
	- node.json.bak:
		a backup that the last known good node configuration.
	- seq_num:
		File containing next sequence number to use
	- seq_num.bak:
		Backup of the sequence number. This may be larger than the
		actual sequence number being used at runtime, to prevent re-use
		of sequence numbers in the event of an unexpected restart.
	- ./rpl/:
		Directory to store the sequence numbers of remote nodes, as
		required by Replay Protection List (RPL) parameters.
		- xxxx:
			Files named for remote Unicast addresses, and contain
			last received iv_index + seq_num from each SRC address.
	- ./dev_keys/:
		Directory to store remote Device keys. This is only created/used
		by Configuration Client (Network administration) nodes.
		- xxxx:
			Files named for remote Unicast addresses, and contains
			16 octet key.
	- ./net_keys/:
		Directory to store network subnet keys. This is only
		created/used by Configuration Client (Network administration)
		nodes.
		- xxx:
			Files named for subnet index, and contains key refresh
			phase, and old/new versions of the key.
	- ./app_keys/:
		Directory to store application keys. This is only created/used
		by Configuration Client (Network administration) nodes.
		- xxx:
			Files named for application index, and contains bound
			subnet index, and old/new versions of the key.

The node.json and node.json.bak are in JSON format. All other files are stored
in little endian binary format.

Known Issues
============

Bluetooth Mesh makes heavy usage of AEAD-AES_CCM encryption, which is
implemented in the Linux kernel on most platforms. Some platforms, including
those with kernel versions including and prior to v4.8, did *not* correctly
implement the AEAD encryption routines. If Mesh is to be ported to such a
system, it will be the responsibility of the vendor to provide support for
AEAD-AES_CCM encryption by some other method.

Support for the required AEAD routines can be determined by running the unit
tests provided with the ELL libraries used by Mesh. Specifically, the tests
found in .../ell/unit/test-cipher.c

Information
===========

Mailing lists:
	linux-bluetooth@vger.kernel.org

For additional information about the project visit BlueZ web site:
	http://www.bluez.org