This patchset streamlines app validation by creating a temporary node
during Join, CreateNetwork and ImportLocalNode calls and then
comparing temporary composition data with one generated for already
existing node.
In case of Attach call, the temporary node is simply added to the list.
TODO: Composition data generation needs to validate node structure,
checking that:
- primary element exists
- mandatory models are where they should be
- there are no gaps in element indexes
- ... possibly a few more things
Michał Lowas-Rzechonek (2):
mesh: Keep model list sorted and unique
mesh: Validate application by comparing composition data
mesh/cfgmod-server.c | 14 +-
mesh/mesh-defs.h | 2 +
mesh/node.c | 453 ++++++++++++++++++-------------------------
3 files changed, 198 insertions(+), 271 deletions(-)
--
2.22.0
Instead of validating application by enumerating D-Bus objects, create a
temporary node instance and check if composition data generated for the
temporary matches the node loaded from storage.
This allows node validation logic (primary element, mandatory models etc)
to be confined in node_generate_comp() function.
This also streamlines code implementing Attach(), Join(),
CreateNetwork() and ImportLocalNode() calls.
---
mesh/cfgmod-server.c | 14 +-
mesh/mesh-defs.h | 2 +
mesh/node.c | 400 ++++++++++++++++---------------------------
3 files changed, 157 insertions(+), 259 deletions(-)
diff --git a/mesh/cfgmod-server.c b/mesh/cfgmod-server.c
index 71d59fd40..9a1f4e229 100644
--- a/mesh/cfgmod-server.c
+++ b/mesh/cfgmod-server.c
@@ -32,8 +32,6 @@
#include "mesh/mesh-config.h"
#include "mesh/cfgmod.h"
-#define CFG_MAX_MSG_LEN 380
-
static void send_pub_status(struct mesh_node *node, uint16_t src, uint16_t dst,
uint8_t status, uint16_t ele_addr, uint16_t pub_addr,
uint32_t mod_id, uint16_t idx, bool cred_flag,
@@ -783,11 +781,11 @@ static bool cfg_srv_pkt(uint16_t src, uint32_t dst,
l_debug("Unsupported page number %d", pkt[0]);
l_debug("Returning page number 0");
}
- long_msg = l_malloc(CFG_MAX_MSG_LEN);
+ long_msg = l_malloc(MAX_MSG_LEN);
n = mesh_model_opcode_set(OP_DEV_COMP_STATUS, long_msg);
long_msg[n++] = 0;
n += node_generate_comp(node, long_msg + n,
- CFG_MAX_MSG_LEN - n);
+ MAX_MSG_LEN - n);
break;
@@ -1053,11 +1051,11 @@ static bool cfg_srv_pkt(uint16_t src, uint32_t dst,
return true;
net_idx = l_get_le16(pkt);
- long_msg = l_malloc(CFG_MAX_MSG_LEN);
+ long_msg = l_malloc(MAX_MSG_LEN);
n = mesh_model_opcode_set(OP_APPKEY_LIST, long_msg);
status = appkey_list(net, net_idx, long_msg + n + 3,
- CFG_MAX_MSG_LEN - n - 3, &size);
+ MAX_MSG_LEN - n - 3, &size);
long_msg[n] = status;
l_put_le16(net_idx, long_msg + n + 1);
@@ -1101,9 +1099,9 @@ static bool cfg_srv_pkt(uint16_t src, uint32_t dst,
break;
case OP_NETKEY_GET:
- long_msg = l_malloc(CFG_MAX_MSG_LEN);
+ long_msg = l_malloc(MAX_MSG_LEN);
n = mesh_model_opcode_set(OP_NETKEY_LIST, long_msg);
- size = CFG_MAX_MSG_LEN - n;
+ size = MAX_MSG_LEN - n;
if (mesh_net_key_list_get(net, long_msg + n, &size))
n += size;
diff --git a/mesh/mesh-defs.h b/mesh/mesh-defs.h
index 79b38c56c..5192a5240 100644
--- a/mesh/mesh-defs.h
+++ b/mesh/mesh-defs.h
@@ -82,6 +82,8 @@
#define MAX_MODEL_COUNT 0xff
#define MAX_ELE_COUNT 0xff
+#define MAX_MSG_LEN 380
+
#define IS_UNASSIGNED(x) ((x) == UNASSIGNED_ADDRESS)
#define IS_UNICAST(x) (((x) > UNASSIGNED_ADDRESS) && \
((x) < VIRTUAL_ADDRESS_LOW))
diff --git a/mesh/node.c b/mesh/node.c
index 3cf82e63c..188b0ef0e 100644
--- a/mesh/node.c
+++ b/mesh/node.c
@@ -112,17 +112,18 @@ struct mesh_node {
};
struct managed_obj_request {
- union {
- const uint8_t *uuid;
- struct mesh_node *node;
- };
+ struct mesh_node *node;
union {
node_ready_func_t ready_cb;
node_join_ready_func_t join_ready_cb;
};
struct l_dbus_message *pending_msg;
enum request_type type;
- struct mesh_config_import *import;
+
+ union {
+ struct mesh_config_import *import;
+ struct mesh_node *attach;
+ };
};
static struct l_queue *nodes;
@@ -161,14 +162,6 @@ static bool match_element_idx(const void *a, const void *b)
return (element->idx == index);
}
-static bool match_model_id(const void *a, const void *b)
-{
- const struct mesh_model *mod = a;
- uint32_t mod_id = L_PTR_TO_UINT(b);
-
- return mod_id == mesh_model_get_model_id(mod);
-}
-
static bool match_element_path(const void *a, const void *b)
{
const struct node_element *element = a;
@@ -236,11 +229,6 @@ static struct mesh_node *node_new(const uint8_t uuid[16])
node->net = mesh_net_new(node);
memcpy(node->uuid, uuid, sizeof(node->uuid));
- if (!nodes)
- nodes = l_queue_new();
-
- l_queue_push_tail(nodes, node);
-
return node;
}
@@ -448,6 +436,11 @@ static bool init_from_storage(struct mesh_config_node *db_node,
struct mesh_node *node = node_new(uuid);
+ if (!nodes)
+ nodes = l_queue_new();
+
+ l_queue_push_tail(nodes, node);
+
node->comp = l_new(struct node_composition, 1);
node->comp->cid = db_node->cid;
node->comp->pid = db_node->pid;
@@ -472,7 +465,7 @@ static bool init_from_storage(struct mesh_config_node *db_node,
memcpy(node->token, db_node->token, 8);
num_ele = l_queue_length(db_node->elements);
- if (num_ele > 0xff)
+ if (num_ele > MAX_ELE_COUNT)
goto fail;
node->num_ele = num_ele;
@@ -1174,58 +1167,6 @@ static void app_disc_cb(struct l_dbus *bus, void *user_data)
free_node_dbus_resources(node);
}
-static bool validate_model_property(struct node_element *ele,
- struct l_dbus_message_iter *property,
- uint8_t *num_models, bool vendor)
-{
- struct l_dbus_message_iter ids;
- uint16_t mod_id, vendor_id;
- uint8_t count;
- const char *signature = !vendor ? "aq" : "a(qq)";
-
- if (!l_dbus_message_iter_get_variant(property, signature, &ids)) {
- /* Allow empty elements */
- if (l_queue_length(ele->models) == 0) {
- *num_models = 0;
- return true;
- } else
- return false;
- }
-
- count = 0;
- if (!vendor) {
- /* Bluetooth SIG defined models */
- while (l_dbus_message_iter_next_entry(&ids, &mod_id)) {
- struct mesh_model *mod;
-
- /* Skip internally implemented models */
- if ((VENDOR_ID_MASK | mod_id) == CONFIG_SRV_MODEL)
- continue;
-
- mod = l_queue_find(ele->models, match_model_id,
- L_UINT_TO_PTR(VENDOR_ID_MASK | mod_id));
- if (!mod)
- return false;
- count++;
- }
- } else {
- /* Vendor defined models */
- while (l_dbus_message_iter_next_entry(&ids, &vendor_id,
- &mod_id)) {
- struct mesh_model *mod;
-
- mod = l_queue_find(ele->models, match_model_id,
- L_UINT_TO_PTR((vendor_id << 16) | mod_id));
- if (!mod)
- return false;
- count++;
- }
- }
-
- *num_models = count;
- return true;
-}
-
static void get_models_from_properties(struct node_element *ele,
struct l_dbus_message_iter *property,
bool vendor)
@@ -1261,94 +1202,57 @@ static void get_models_from_properties(struct node_element *ele,
}
static bool get_element_properties(struct mesh_node *node, const char *path,
- struct l_dbus_message_iter *properties,
- bool is_new)
+ struct l_dbus_message_iter *properties)
{
- struct node_element *ele;
+ struct node_element *ele = l_new(struct node_element, 1);
const char *key;
struct l_dbus_message_iter var;
- bool have_index = false;
- uint8_t idx, mod_cnt, vendor_cnt;
+ bool idx = false;
+ bool loc = false;
+ bool mods = false;
+ bool vendor_mods = false;
l_debug("path %s", path);
while (l_dbus_message_iter_next_entry(properties, &key, &var)) {
- if (!strcmp(key, "Index")) {
- if (!l_dbus_message_iter_get_variant(&var, "y", &idx))
- return false;
- have_index = true;
- break;
+ if (!idx && !strcmp(key, "Index")) {
+ if (!l_dbus_message_iter_get_variant(&var, "y",
+ &ele->idx))
+ goto fail;
+ idx = true;
+ continue;
}
- }
-
- if (!have_index) {
- l_debug("Mandatory property \"Index\" not found");
- return false;
- }
- if (!is_new) {
- /* Validate composition: check the element index */
- ele = l_queue_find(node->elements, match_element_idx,
- L_UINT_TO_PTR(idx));
- if (!ele) {
- l_debug("Element with index %u not found", idx);
- return false;
+ if (!loc && !strcmp(key, "Location")) {
+ if (!l_dbus_message_iter_get_variant(&var, "q",
+ &ele->location))
+ goto fail;
+ loc = true;
+ continue;
}
- } else {
- ele = l_new(struct node_element, 1);
- ele->location = DEFAULT_LOCATION;
- ele->idx = idx;
- }
- mod_cnt = 0;
- vendor_cnt = 0;
-
- while (l_dbus_message_iter_next_entry(properties, &key, &var)) {
- if (!strcmp(key, "Location")) {
- uint16_t loc;
-
- l_dbus_message_iter_get_variant(&var, "q", &loc);
-
- /* Validate composition: location match */
- if (!is_new && (ele->location != loc))
- return false;
-
- ele->location = loc;
-
- } else if (!strcmp(key, "Models")) {
-
- if (is_new)
- get_models_from_properties(ele, &var, false);
- else if (!validate_model_property(ele, &var, &mod_cnt,
- false))
- return false;
-
- } else if (!strcmp(key, "VendorModels")) {
-
- if (is_new)
- get_models_from_properties(ele, &var, true);
- else if (!validate_model_property(ele, &var,
- &vendor_cnt, true))
- return false;
+ if (!mods && !strcmp(key, "Models")) {
+ get_models_from_properties(ele, &var, false);
+ mods = true;
+ continue;
+ }
+ if (!vendor_mods && !strcmp(key, "VendorModels")) {
+ get_models_from_properties(ele, &var, true);
+ vendor_mods = true;
+ continue;
}
}
- if (is_new) {
- l_queue_push_tail(node->elements, ele);
- } else {
- /* Account for internal Configuration Server model */
- if (idx == 0)
- mod_cnt += 1;
-
- /* Validate composition: number of models must match */
- if (l_queue_length(ele->models) != (mod_cnt + vendor_cnt))
- return false;
-
- ele->path = l_strdup(path);
- }
+ if (!idx || !loc || !mods || !vendor_mods)
+ goto fail;
+ l_queue_push_tail(node->elements, ele);
return true;
+fail:
+ l_free(ele);
+
+ return false;
}
static void convert_node_to_storage(struct mesh_node *node,
@@ -1445,65 +1349,59 @@ static void set_defaults(struct mesh_node *node)
}
static bool get_app_properties(struct mesh_node *node, const char *path,
- struct l_dbus_message_iter *properties,
- bool is_new)
+ struct l_dbus_message_iter *properties)
{
const char *key;
struct l_dbus_message_iter variant;
- uint16_t value;
+ bool cid = false;
+ bool pid = false;
+ bool vid = false;
l_debug("path %s", path);
- if (is_new) {
- node->comp = l_new(struct node_composition, 1);
- node->comp->crpl = DEFAULT_CRPL;
- }
+ node->comp = l_new(struct node_composition, 1);
+ node->comp->crpl = DEFAULT_CRPL;
while (l_dbus_message_iter_next_entry(properties, &key, &variant)) {
-
- if (!strcmp(key, "CompanyID")) {
+ if (!cid && !strcmp(key, "CompanyID")) {
if (!l_dbus_message_iter_get_variant(&variant, "q",
- &value))
- return false;
-
- if (!is_new && node->comp->cid != value)
- return false;
-
- node->comp->cid = value;
+ &node->comp->cid))
+ goto fail;
+ cid = true;
+ continue;
+ }
- } else if (!strcmp(key, "ProductID")) {
+ if (!pid && !strcmp(key, "ProductID")) {
if (!l_dbus_message_iter_get_variant(&variant, "q",
- &value))
- return false;
-
- if (!is_new && node->comp->pid != value)
- return false;
-
- node->comp->pid = value;
+ &node->comp->pid))
+ goto fail;
+ pid = true;
+ continue;
+ }
- } else if (!strcmp(key, "VersionID")) {
+ if (!vid && !strcmp(key, "VersionID")) {
if (!l_dbus_message_iter_get_variant(&variant, "q",
- &value))
- return false;
-
- if (!is_new && node->comp->vid != value)
+ &node->comp->vid))
return false;
+ vid = true;
+ continue;
+ }
- node->comp->vid = value;
-
- } else if (!strcmp(key, "CRPL")) {
+ if (!strcmp(key, "CRPL"))
if (!l_dbus_message_iter_get_variant(&variant, "q",
- &value))
- return false;
-
- if (!is_new && node->comp->crpl != value)
- return false;
-
- node->comp->crpl = value;
- }
+ &node->comp->crpl))
+ goto fail;
}
+ if (!vid || !pid || !vid)
+ goto fail;
+
return true;
+fail:
+ l_free(node->comp);
+ node->comp = NULL;
+
+ return false;
}
static bool add_local_node(struct mesh_node *node, uint16_t unicast, bool kr,
@@ -1582,18 +1480,42 @@ static bool init_storage_dir(struct mesh_node *node)
return true;
}
+static bool check_req_node(struct managed_obj_request *req)
+{
+ uint8_t node_comp[MAX_MSG_LEN - 2];
+ uint8_t attach_comp[MAX_MSG_LEN - 2];
+
+ uint16_t node_len = node_generate_comp(req->node, node_comp,
+ sizeof(node_comp));
+
+ if (!node_len)
+ return false;
+
+ // TODO: validate
+
+ if (req->type == REQUEST_TYPE_ATTACH) {
+ uint16_t attach_len = node_generate_comp(req->attach,
+ attach_comp, sizeof(attach_comp));
+
+ if (node_len != attach_len ||
+ memcmp(node_comp, attach_comp, node_len)) {
+ l_debug("Failed to verify app's composition data");
+ return false;
+ }
+ }
+
+ return true;
+}
+
static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data)
{
struct l_dbus_message_iter objects, interfaces;
struct managed_obj_request *req = user_data;
const char *path;
- struct mesh_node *node = NULL;
+ struct mesh_node *node = req->node;
void *agent = NULL;
bool have_app = false;
- bool is_new;
- uint8_t num_ele;
-
- is_new = (req->type != REQUEST_TYPE_ATTACH);
+ unsigned int num_ele;
if (l_dbus_message_is_error(msg)) {
l_error("Failed to get app's dbus objects");
@@ -1605,14 +1527,9 @@ static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data)
goto fail;
}
- if (is_new) {
- node = node_new(req->uuid);
+ if (!node->elements)
node->elements = l_queue_new();
- } else {
- node = req->node;
- }
- num_ele = 0;
while (l_dbus_message_iter_next_entry(&objects, &path, &interfaces)) {
struct l_dbus_message_iter properties;
const char *interface;
@@ -1622,21 +1539,14 @@ static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data)
bool res;
if (!strcmp(MESH_ELEMENT_INTERFACE, interface)) {
-
- if (num_ele == MAX_ELE_COUNT)
- goto fail;
-
res = get_element_properties(node, path,
- &properties, is_new);
+ &properties);
if (!res)
goto fail;
-
- num_ele++;
-
} else if (!strcmp(MESH_APPLICATION_INTERFACE,
interface)) {
res = get_app_properties(node, path,
- &properties, is_new);
+ &properties);
if (!res)
goto fail;
@@ -1666,7 +1576,7 @@ static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data)
goto fail;
}
- if (num_ele == 0) {
+ if (l_queue_isempty(node->elements)) {
l_error("Interface %s not found", MESH_ELEMENT_INTERFACE);
goto fail;
}
@@ -1678,35 +1588,37 @@ static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data)
goto fail;
}
+ set_defaults(node);
+ num_ele = l_queue_length(node->elements);
+
+ if (num_ele > MAX_ELE_COUNT)
+ goto fail;
+
+ node->num_ele = num_ele;
+
+ if (!check_req_node(req))
+ goto fail;
+
if (req->type == REQUEST_TYPE_ATTACH) {
- if (num_ele != node->num_ele)
- goto fail;
+ struct l_dbus *bus = dbus_get_bus();
- if (register_node_object(node)) {
- struct l_dbus *bus = dbus_get_bus();
+ node_remove(node);
+ node = req->attach;
- node->disc_watch = l_dbus_add_disconnect_watch(bus,
- node->owner, app_disc_cb, node, NULL);
- req->ready_cb(req->pending_msg, MESH_ERROR_NONE, node);
- } else
+ if (!register_node_object(node))
goto fail;
+ node->disc_watch = l_dbus_add_disconnect_watch(bus,
+ node->owner, app_disc_cb, node, NULL);
} else if (req->type == REQUEST_TYPE_JOIN) {
- if (!agent) {
+ if (!node->agent) {
l_error("Interface %s not found",
MESH_PROVISION_AGENT_INTERFACE);
goto fail;
}
- node->num_ele = num_ele;
- set_defaults(node);
- memcpy(node->uuid, req->uuid, 16);
-
if (!create_node_config(node, node->uuid))
goto fail;
-
- req->join_ready_cb(node, agent);
-
} else if (req->type == REQUEST_TYPE_IMPORT) {
struct mesh_config_import *import = req->import;
struct keyring_net_key net_key;
@@ -1717,14 +1629,9 @@ static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data)
goto fail;
}
- node->num_ele = num_ele;
- set_defaults(node);
-
if (node->seq_number != import->node->seq_number)
node->seq_number = import->node->seq_number;
- memcpy(node->uuid, req->uuid, 16);
-
if (!create_node_config(node, node->uuid))
goto fail;
@@ -1742,23 +1649,16 @@ static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data)
init_storage_dir(node);
if (!keyring_put_remote_dev_key(node, import->node->unicast,
- num_ele, import->dev_key))
+ node->num_ele, import->dev_key))
goto fail;
if (!keyring_put_net_key(node, import->net_key.idx, &net_key))
goto fail;
-
- req->ready_cb(req->pending_msg, MESH_ERROR_NONE, node);
-
} else {
/* Callback for create node request */
struct keyring_net_key net_key;
uint8_t dev_key[16];
- node->num_ele = num_ele;
- set_defaults(node);
- memcpy(node->uuid, req->uuid, 16);
-
if (!create_node_config(node, node->uuid))
goto fail;
@@ -1778,34 +1678,31 @@ static void get_managed_objects_cb(struct l_dbus_message *msg, void *user_data)
init_storage_dir(node);
if (!keyring_put_remote_dev_key(node, DEFAULT_NEW_UNICAST,
- num_ele, dev_key))
+ node->num_ele, dev_key))
goto fail;
if (!keyring_put_net_key(node, PRIMARY_NET_IDX, &net_key))
goto fail;
+ }
+ if (req->type == REQUEST_TYPE_JOIN)
+ req->join_ready_cb(node, node->agent);
+ else
req->ready_cb(req->pending_msg, MESH_ERROR_NONE, node);
- }
return;
fail:
if (agent)
mesh_agent_remove(agent);
- if (!is_new) {
- free_node_dbus_resources(node);
+ /* Handle failed requests */
+ if (node)
+ node_remove(node);
- req->ready_cb(req->pending_msg, MESH_ERROR_FAILED, node);
- } else {
- /* Handle failed Join, Create and Import requests */
- if (node)
- node_remove(node);
-
- if (req->type == REQUEST_TYPE_JOIN)
- req->join_ready_cb(NULL, NULL);
- else
- req->ready_cb(req->pending_msg, MESH_ERROR_FAILED, NULL);
- }
+ if (req->type == REQUEST_TYPE_JOIN)
+ req->join_ready_cb(NULL, NULL);
+ else
+ req->ready_cb(req->pending_msg, MESH_ERROR_FAILED, NULL);
}
/* Establish relationship between application and mesh node */
@@ -1829,9 +1726,10 @@ int node_attach(const char *app_path, const char *sender, uint64_t token,
node->owner = l_strdup(sender);
req = l_new(struct managed_obj_request, 1);
- req->node = node;
+ req->node = node_new(node->uuid);
req->ready_cb = cb;
req->pending_msg = user_data;
+ req->attach = node;
req->type = REQUEST_TYPE_ATTACH;
l_dbus_method_call(dbus_get_bus(), sender, app_path,
@@ -1853,7 +1751,7 @@ void node_join(const char *app_path, const char *sender, const uint8_t *uuid,
l_debug("");
req = l_new(struct managed_obj_request, 1);
- req->uuid = uuid;
+ req->node = node_new(uuid);
req->join_ready_cb = cb;
req->type = REQUEST_TYPE_JOIN;
@@ -1879,7 +1777,7 @@ bool node_import(const char *app_path, const char *sender,
req = l_new(struct managed_obj_request, 1);
- req->uuid = uuid;
+ req->node = node_new(uuid);
req->ready_cb = cb;
req->pending_msg = user_data;
req->import = import;
@@ -1901,7 +1799,7 @@ void node_create(const char *app_path, const char *sender, const uint8_t *uuid,
l_debug("");
req = l_new(struct managed_obj_request, 1);
- req->uuid = uuid;
+ req->node = node_new(uuid);
req->ready_cb = cb;
req->pending_msg = user_data;
req->type = REQUEST_TYPE_CREATE;
--
2.22.0