Support for no_std

Support for no_std

Further no_std compat
This commit is contained in:
ivmarkov 2023-02-02 18:22:21 +00:00
parent c2e01ee423
commit d446007f6b
103 changed files with 7513 additions and 6250 deletions

View file

@ -15,4 +15,4 @@
* limitations under the License. * limitations under the License.
*/ */
pub mod dev_att; // TODO pub mod dev_att;

View file

@ -15,40 +15,41 @@
* limitations under the License. * limitations under the License.
*/ */
mod dev_att; // TODO
use matter::core::{self, CommissioningData}; // mod dev_att;
use matter::data_model::cluster_basic_information::BasicInfoConfig; // use matter::core::{self, CommissioningData};
use matter::data_model::device_types::device_type_add_on_off_light; // use matter::data_model::cluster_basic_information::BasicInfoConfig;
use matter::secure_channel::spake2p::VerifierData; // use matter::data_model::device_types::device_type_add_on_off_light;
// use matter::secure_channel::spake2p::VerifierData;
fn main() { fn main() {
env_logger::init(); // env_logger::init();
let comm_data = CommissioningData { // let comm_data = CommissioningData {
// TODO: Hard-coded for now // // TODO: Hard-coded for now
verifier: VerifierData::new_with_pw(123456), // verifier: VerifierData::new_with_pw(123456),
discriminator: 250, // discriminator: 250,
}; // };
// vid/pid should match those in the DAC // // vid/pid should match those in the DAC
let dev_info = BasicInfoConfig { // let dev_info = BasicInfoConfig {
vid: 0xFFF1, // vid: 0xFFF1,
pid: 0x8000, // pid: 0x8000,
hw_ver: 2, // hw_ver: 2,
sw_ver: 1, // sw_ver: 1,
sw_ver_str: "1".to_string(), // sw_ver_str: "1".to_string(),
serial_no: "aabbccdd".to_string(), // serial_no: "aabbccdd".to_string(),
device_name: "OnOff Light".to_string(), // device_name: "OnOff Light".to_string(),
}; // };
let dev_att = Box::new(dev_att::HardCodedDevAtt::new()); // let dev_att = Box::new(dev_att::HardCodedDevAtt::new());
let mut matter = core::Matter::new(dev_info, dev_att, comm_data).unwrap(); // let mut matter = core::Matter::new(dev_info, dev_att, comm_data).unwrap();
let dm = matter.get_data_model(); // let dm = matter.get_data_model();
{ // {
let mut node = dm.node.write().unwrap(); // let mut node = dm.node.write().unwrap();
let endpoint = device_type_add_on_off_light(&mut node).unwrap(); // let endpoint = device_type_add_on_off_light(&mut node).unwrap();
println!("Added OnOff Light Device type at endpoint id: {}", endpoint); // println!("Added OnOff Light Device type at endpoint id: {}", endpoint);
println!("Data Model now is: {}", node); // println!("Data Model now is: {}", node);
} // }
matter.start_daemon().unwrap(); // matter.start_daemon().unwrap();
} }

View file

@ -15,4 +15,4 @@
* limitations under the License. * limitations under the License.
*/ */
pub mod dev_att; // TODO pub mod dev_att;

View file

@ -15,55 +15,56 @@
* limitations under the License. * limitations under the License.
*/ */
mod dev_att; // TODO
use matter::core::{self, CommissioningData}; // mod dev_att;
use matter::data_model::cluster_basic_information::BasicInfoConfig; // use matter::core::{self, CommissioningData};
use matter::data_model::cluster_media_playback::{Commands, MediaPlaybackCluster}; // use matter::data_model::cluster_basic_information::BasicInfoConfig;
use matter::data_model::device_types::DEV_TYPE_ON_SMART_SPEAKER; // use matter::data_model::cluster_media_playback::{Commands, MediaPlaybackCluster};
use matter::secure_channel::spake2p::VerifierData; // use matter::data_model::device_types::DEV_TYPE_ON_SMART_SPEAKER;
// use matter::secure_channel::spake2p::VerifierData;
fn main() { fn main() {
env_logger::init(); // env_logger::init();
let comm_data = CommissioningData { // let comm_data = CommissioningData {
// TODO: Hard-coded for now // // TODO: Hard-coded for now
verifier: VerifierData::new_with_pw(123456), // verifier: VerifierData::new_with_pw(123456),
discriminator: 250, // discriminator: 250,
}; // };
// vid/pid should match those in the DAC // // vid/pid should match those in the DAC
let dev_info = BasicInfoConfig { // let dev_info = BasicInfoConfig {
vid: 0xFFF1, // vid: 0xFFF1,
pid: 0x8002, // pid: 0x8002,
hw_ver: 2, // hw_ver: 2,
sw_ver: 1, // sw_ver: 1,
sw_ver_str: "1".to_string(), // sw_ver_str: "1".to_string(),
serial_no: "aabbccdd".to_string(), // serial_no: "aabbccdd".to_string(),
device_name: "Smart Speaker".to_string(), // device_name: "Smart Speaker".to_string(),
}; // };
let dev_att = Box::new(dev_att::HardCodedDevAtt::new()); // let dev_att = Box::new(dev_att::HardCodedDevAtt::new());
let mut matter = core::Matter::new(dev_info, dev_att, comm_data).unwrap(); // let mut matter = core::Matter::new(dev_info, dev_att, comm_data).unwrap();
let dm = matter.get_data_model(); // let dm = matter.get_data_model();
{ // {
let mut node = dm.node.write().unwrap(); // let mut node = dm.node.write().unwrap();
let endpoint_audio = node.add_endpoint(DEV_TYPE_ON_SMART_SPEAKER).unwrap(); // let endpoint_audio = node.add_endpoint(DEV_TYPE_ON_SMART_SPEAKER).unwrap();
let mut media_playback_cluster = MediaPlaybackCluster::new().unwrap(); // let mut media_playback_cluster = MediaPlaybackCluster::new().unwrap();
// Add some callbacks // // Add some callbacks
let play_callback = Box::new(|| log::info!("Comamnd [Play] handled with callback.")); // let play_callback = Box::new(|| log::info!("Comamnd [Play] handled with callback."));
let pause_callback = Box::new(|| log::info!("Comamnd [Pause] handled with callback.")); // let pause_callback = Box::new(|| log::info!("Comamnd [Pause] handled with callback."));
let stop_callback = Box::new(|| log::info!("Comamnd [Stop] handled with callback.")); // let stop_callback = Box::new(|| log::info!("Comamnd [Stop] handled with callback."));
let start_over_callback = // let start_over_callback =
Box::new(|| log::info!("Comamnd [StartOver] handled with callback.")); // Box::new(|| log::info!("Comamnd [StartOver] handled with callback."));
media_playback_cluster.add_callback(Commands::Play, play_callback); // media_playback_cluster.add_callback(Commands::Play, play_callback);
media_playback_cluster.add_callback(Commands::Pause, pause_callback); // media_playback_cluster.add_callback(Commands::Pause, pause_callback);
media_playback_cluster.add_callback(Commands::Stop, stop_callback); // media_playback_cluster.add_callback(Commands::Stop, stop_callback);
media_playback_cluster.add_callback(Commands::StartOver, start_over_callback); // media_playback_cluster.add_callback(Commands::StartOver, start_over_callback);
node.add_cluster(endpoint_audio, media_playback_cluster) // node.add_cluster(endpoint_audio, media_playback_cluster)
.unwrap(); // .unwrap();
println!("Added Speaker type at endpoint id: {}", endpoint_audio) // println!("Added Speaker type at endpoint id: {}", endpoint_audio)
} // }
matter.start_daemon().unwrap(); // matter.start_daemon().unwrap();
} }

View file

@ -0,0 +1,69 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
mod dev_att;
use matter::core::{self, CommissioningData};
use matter::data_model::cluster_basic_information::BasicInfoConfig;
use matter::data_model::cluster_media_playback::{Commands, MediaPlaybackCluster};
use matter::data_model::device_types::DEV_TYPE_ON_SMART_SPEAKER;
use matter::secure_channel::spake2p::VerifierData;
fn main() {
env_logger::init();
let comm_data = CommissioningData {
// TODO: Hard-coded for now
verifier: VerifierData::new_with_pw(123456),
discriminator: 250,
};
// vid/pid should match those in the DAC
let dev_info = BasicInfoConfig {
vid: 0xFFF1,
pid: 0x8002,
hw_ver: 2,
sw_ver: 1,
sw_ver_str: "1".to_string(),
serial_no: "aabbccdd".to_string(),
device_name: "Smart Speaker".to_string(),
};
let dev_att = Box::new(dev_att::HardCodedDevAtt::new());
let mut matter = core::Matter::new(dev_info, dev_att, comm_data).unwrap();
let dm = matter.get_data_model();
{
let mut node = dm.node.write().unwrap();
let endpoint_audio = node.add_endpoint(DEV_TYPE_ON_SMART_SPEAKER).unwrap();
let mut media_playback_cluster = MediaPlaybackCluster::new().unwrap();
// Add some callbacks
let play_callback = Box::new(|| log::info!("Comamnd [Play] handled with callback."));
let pause_callback = Box::new(|| log::info!("Comamnd [Pause] handled with callback."));
let stop_callback = Box::new(|| log::info!("Comamnd [Stop] handled with callback."));
let start_over_callback =
Box::new(|| log::info!("Comamnd [StartOver] handled with callback."));
media_playback_cluster.add_callback(Commands::Play, play_callback);
media_playback_cluster.add_callback(Commands::Pause, pause_callback);
media_playback_cluster.add_callback(Commands::Stop, stop_callback);
media_playback_cluster.add_callback(Commands::StartOver, start_over_callback);
node.add_cluster(endpoint_audio, media_playback_cluster)
.unwrap();
println!("Added Speaker type at endpoint id: {}", endpoint_audio)
}
matter.start_daemon().unwrap();
}

View file

@ -15,7 +15,9 @@ name = "matter"
path = "src/lib.rs" path = "src/lib.rs"
[features] [features]
default = ["crypto_mbedtls"] default = ["std", "crypto_mbedtls"]
std = []
nightly = []
crypto_openssl = ["openssl", "foreign-types", "hmac", "sha2"] crypto_openssl = ["openssl", "foreign-types", "hmac", "sha2"]
crypto_mbedtls = ["mbedtls"] crypto_mbedtls = ["mbedtls"]
crypto_esp_mbedtls = ["esp-idf-sys"] crypto_esp_mbedtls = ["esp-idf-sys"]
@ -34,7 +36,7 @@ num-traits = "0.2.15"
log = { version = "0.4.17", features = ["max_level_debug", "release_max_level_debug"] } log = { version = "0.4.17", features = ["max_level_debug", "release_max_level_debug"] }
env_logger = { version = "0.10.0", default-features = false, features = [] } env_logger = { version = "0.10.0", default-features = false, features = [] }
rand = "0.8.5" rand = "0.8.5"
esp-idf-sys = { version = "0.32", features = ["binstart"], optional = true } esp-idf-sys = { version = "0.32", optional = true }
subtle = "2.4.1" subtle = "2.4.1"
colored = "2.0.0" colored = "2.0.0"
smol = "1.3.0" smol = "1.3.0"
@ -42,6 +44,7 @@ owning_ref = "0.4.1"
safemem = "0.3.3" safemem = "0.3.3"
chrono = { version = "0.4.23", default-features = false, features = ["clock", "std"] } chrono = { version = "0.4.23", default-features = false, features = ["clock", "std"] }
async-channel = "1.8" async-channel = "1.8"
strum = { version = "0.24", features = ["derive"], no-default-feature = true }
# crypto # crypto
openssl = { git = "https://github.com/sfackler/rust-openssl", optional = true } openssl = { git = "https://github.com/sfackler/rust-openssl", optional = true }

View file

@ -15,19 +15,16 @@
* limitations under the License. * limitations under the License.
*/ */
use std::{ use core::{cell::RefCell, fmt::Display};
fmt::Display,
sync::{Arc, Mutex, MutexGuard, RwLock},
};
use crate::{ use crate::{
data_model::objects::{Access, ClusterId, EndptId, Privilege}, data_model::objects::{Access, ClusterId, EndptId, Privilege},
error::Error, error::Error,
fabric, fabric,
interaction_model::messages::GenericPath, interaction_model::messages::GenericPath,
sys::Psm, persist::Psm,
tlv::{FromTLV, TLVElement, TLVList, TLVWriter, TagType, ToTLV}, tlv::{FromTLV, TLVElement, TLVList, TLVWriter, TagType, ToTLV},
transport::session::MAX_CAT_IDS_PER_NOC, transport::session::{Session, SessionMode, MAX_CAT_IDS_PER_NOC},
utils::writebuf::WriteBuf, utils::writebuf::WriteBuf,
}; };
use log::error; use log::error;
@ -160,7 +157,7 @@ impl Display for AccessorSubjects {
} }
/// The Accessor Object /// The Accessor Object
pub struct Accessor { pub struct Accessor<'a> {
/// The fabric index of the accessor /// The fabric index of the accessor
pub fab_idx: u8, pub fab_idx: u8,
/// Accessor's subject: could be node-id, NoC CAT, group id /// Accessor's subject: could be node-id, NoC CAT, group id
@ -168,15 +165,37 @@ pub struct Accessor {
/// The Authmode of this session /// The Authmode of this session
auth_mode: AuthMode, auth_mode: AuthMode,
// TODO: Is this the right place for this though, or should we just use a global-acl-handle-get // TODO: Is this the right place for this though, or should we just use a global-acl-handle-get
acl_mgr: Arc<AclMgr>, acl_mgr: &'a RefCell<AclMgr>,
} }
impl Accessor { impl<'a> Accessor<'a> {
pub fn new( pub fn for_session(session: &Session, acl_mgr: &'a RefCell<AclMgr>) -> Self {
match session.get_session_mode() {
SessionMode::Case(c) => {
let mut subject =
AccessorSubjects::new(session.get_peer_node_id().unwrap_or_default());
for i in c.cat_ids {
if i != 0 {
let _ = subject.add_catid(i);
}
}
Accessor::new(c.fab_idx, subject, AuthMode::Case, &acl_mgr)
}
SessionMode::Pase => {
Accessor::new(0, AccessorSubjects::new(1), AuthMode::Pase, &acl_mgr)
}
SessionMode::PlainText => {
Accessor::new(0, AccessorSubjects::new(1), AuthMode::Invalid, &acl_mgr)
}
}
}
pub const fn new(
fab_idx: u8, fab_idx: u8,
subjects: AccessorSubjects, subjects: AccessorSubjects,
auth_mode: AuthMode, auth_mode: AuthMode,
acl_mgr: Arc<AclMgr>, acl_mgr: &'a RefCell<AclMgr>,
) -> Self { ) -> Self {
Self { Self {
fab_idx, fab_idx,
@ -188,9 +207,9 @@ impl Accessor {
} }
#[derive(Debug)] #[derive(Debug)]
pub struct AccessDesc<'a> { pub struct AccessDesc {
/// The object to be acted upon /// The object to be acted upon
path: &'a GenericPath, path: GenericPath,
/// The target permissions /// The target permissions
target_perms: Option<Access>, target_perms: Option<Access>,
// The operation being done // The operation being done
@ -200,8 +219,8 @@ pub struct AccessDesc<'a> {
/// Access Request Object /// Access Request Object
pub struct AccessReq<'a> { pub struct AccessReq<'a> {
accessor: &'a Accessor, accessor: &'a Accessor<'a>,
object: AccessDesc<'a>, object: AccessDesc,
} }
impl<'a> AccessReq<'a> { impl<'a> AccessReq<'a> {
@ -209,7 +228,7 @@ impl<'a> AccessReq<'a> {
/// ///
/// An access request specifies the _accessor_ attempting to access _path_ /// An access request specifies the _accessor_ attempting to access _path_
/// with _operation_ /// with _operation_
pub fn new(accessor: &'a Accessor, path: &'a GenericPath, operation: Access) -> Self { pub fn new(accessor: &'a Accessor, path: GenericPath, operation: Access) -> Self {
AccessReq { AccessReq {
accessor, accessor,
object: AccessDesc { object: AccessDesc {
@ -220,6 +239,10 @@ impl<'a> AccessReq<'a> {
} }
} }
pub fn operation(&self) -> Access {
self.object.operation
}
/// Add target's permissions to the request /// Add target's permissions to the request
/// ///
/// The permissions that are associated with the target (identified by the /// The permissions that are associated with the target (identified by the
@ -234,7 +257,7 @@ impl<'a> AccessReq<'a> {
/// _accessor_ the necessary privileges to access the target as per its /// _accessor_ the necessary privileges to access the target as per its
/// permissions /// permissions
pub fn allow(&self) -> bool { pub fn allow(&self) -> bool {
self.accessor.acl_mgr.allow(self) self.accessor.acl_mgr.borrow().allow(self)
} }
} }
@ -369,33 +392,184 @@ impl AclEntry {
const MAX_ACL_ENTRIES: usize = ENTRIES_PER_FABRIC * fabric::MAX_SUPPORTED_FABRICS; const MAX_ACL_ENTRIES: usize = ENTRIES_PER_FABRIC * fabric::MAX_SUPPORTED_FABRICS;
type AclEntries = [Option<AclEntry>; MAX_ACL_ENTRIES]; type AclEntries = [Option<AclEntry>; MAX_ACL_ENTRIES];
#[derive(ToTLV, FromTLV, Debug)]
struct AclMgrInner {
entries: AclEntries,
}
const ACL_KV_ENTRY: &str = "acl"; const ACL_KV_ENTRY: &str = "acl";
const ACL_KV_MAX_SIZE: usize = 300; const ACL_KV_MAX_SIZE: usize = 300;
impl AclMgrInner {
pub fn store(&self, psm: &MutexGuard<Psm>) -> Result<(), Error> { pub struct AclMgr {
let mut acl_tlvs = [0u8; ACL_KV_MAX_SIZE]; entries: AclEntries,
let mut wb = WriteBuf::new(&mut acl_tlvs, ACL_KV_MAX_SIZE); changed: bool,
let mut tw = TLVWriter::new(&mut wb); }
self.entries.to_tlv(&mut tw, TagType::Anonymous)?;
psm.set_kv_slice(ACL_KV_ENTRY, wb.as_slice()) impl AclMgr {
pub const fn new() -> Self {
const INIT: Option<AclEntry> = None;
Self {
entries: [INIT; MAX_ACL_ENTRIES],
changed: false,
}
} }
pub fn load(psm: &MutexGuard<Psm>) -> Result<Self, Error> { pub fn erase_all(&mut self) -> Result<(), Error> {
let mut acl_tlvs = Vec::new(); for i in 0..MAX_ACL_ENTRIES {
psm.get_kv_slice(ACL_KV_ENTRY, &mut acl_tlvs)?; self.entries[i] = None;
}
self.changed = true;
Ok(())
}
pub fn add(&mut self, entry: AclEntry) -> Result<(), Error> {
let cnt = self
.entries
.iter()
.flatten()
.filter(|a| a.fab_idx == entry.fab_idx)
.count();
if cnt >= ENTRIES_PER_FABRIC {
return Err(Error::NoSpace);
}
let index = self
.entries
.iter()
.position(|a| a.is_none())
.ok_or(Error::NoSpace)?;
self.entries[index] = Some(entry);
self.changed = true;
Ok(())
}
// Since the entries are fabric-scoped, the index is only for entries with the matching fabric index
pub fn edit(&mut self, index: u8, fab_idx: u8, new: AclEntry) -> Result<(), Error> {
let old = self.for_index_in_fabric(index, fab_idx)?;
*old = Some(new);
self.changed = true;
Ok(())
}
pub fn delete(&mut self, index: u8, fab_idx: u8) -> Result<(), Error> {
let old = self.for_index_in_fabric(index, fab_idx)?;
*old = None;
self.changed = true;
Ok(())
}
pub fn delete_for_fabric(&mut self, fab_idx: u8) -> Result<(), Error> {
for i in 0..MAX_ACL_ENTRIES {
if self.entries[i]
.filter(|e| e.fab_idx == Some(fab_idx))
.is_some()
{
self.entries[i] = None;
}
}
self.changed = true;
Ok(())
}
pub fn for_each_acl<T>(&self, mut f: T) -> Result<(), Error>
where
T: FnMut(&AclEntry) -> Result<(), Error>,
{
for entry in self.entries.iter().flatten() {
f(entry)?;
}
Ok(())
}
pub fn allow(&self, req: &AccessReq) -> bool {
// PASE Sessions have implicit access grant
if req.accessor.auth_mode == AuthMode::Pase {
return true;
}
for e in self.entries.iter().flatten() {
if e.allow(req) {
return true;
}
}
error!(
"ACL Disallow for subjects {} fab idx {}",
req.accessor.subjects, req.accessor.fab_idx
);
error!("{}", self);
false
}
pub fn store<T>(&mut self, mut psm: T) -> Result<(), Error>
where
T: Psm,
{
if self.changed {
let mut buf = [0u8; ACL_KV_MAX_SIZE];
let mut wb = WriteBuf::new(&mut buf);
let mut tw = TLVWriter::new(&mut wb);
self.entries.to_tlv(&mut tw, TagType::Anonymous)?;
psm.set_kv_slice(ACL_KV_ENTRY, wb.into_slice())?;
self.changed = false;
}
Ok(())
}
pub fn load<T>(&mut self, psm: T) -> Result<(), Error>
where
T: Psm,
{
let mut buf = [0u8; ACL_KV_MAX_SIZE];
let acl_tlvs = psm.get_kv_slice(ACL_KV_ENTRY, &mut buf)?;
let root = TLVList::new(acl_tlvs).iter().next().ok_or(Error::Invalid)?;
self.entries = AclEntries::from_tlv(&root)?;
self.changed = false;
Ok(())
}
#[cfg(feature = "nightly")]
pub async fn store_async<T>(&mut self, mut psm: T) -> Result<(), Error>
where
T: crate::persist::asynch::AsyncPsm,
{
if self.changed {
let mut buf = [0u8; ACL_KV_MAX_SIZE];
let mut wb = WriteBuf::new(&mut buf);
let mut tw = TLVWriter::new(&mut wb);
self.entries.to_tlv(&mut tw, TagType::Anonymous)?;
psm.set_kv_slice(ACL_KV_ENTRY, wb.into_slice()).await?;
self.changed = false;
}
Ok(())
}
#[cfg(feature = "nightly")]
pub async fn load_async<T>(&mut self, psm: T) -> Result<(), Error>
where
T: crate::persist::asynch::AsyncPsm,
{
let mut buf = [0u8; ACL_KV_MAX_SIZE];
let acl_tlvs = psm.get_kv_slice(ACL_KV_ENTRY, &mut buf).await?;
let root = TLVList::new(&acl_tlvs) let root = TLVList::new(&acl_tlvs)
.iter() .iter()
.next() .next()
.ok_or(Error::Invalid)?; .ok_or(Error::Invalid)?;
Ok(Self { self.entries = AclEntries::from_tlv(&root)?;
entries: AclEntries::from_tlv(&root)?, self.changed = false;
})
Ok(())
} }
/// Traverse fabric specific entries to find the index /// Traverse fabric specific entries to find the index
@ -422,169 +596,10 @@ impl AclMgrInner {
} }
} }
pub struct AclMgr { impl core::fmt::Display for AclMgr {
inner: RwLock<AclMgrInner>, fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
// The Option<> is solely because test execution is faster
// Doing this here adds the least overhead during ACL verification
psm: Option<Arc<Mutex<Psm>>>,
}
impl AclMgr {
pub fn new() -> Result<Self, Error> {
AclMgr::new_with(true)
}
pub fn new_with(psm_support: bool) -> Result<Self, Error> {
const INIT: Option<AclEntry> = None;
let mut psm = None;
let inner = if !psm_support {
AclMgrInner {
entries: [INIT; MAX_ACL_ENTRIES],
}
} else {
let psm_handle = Psm::get()?;
let inner = {
let psm_lock = psm_handle.lock().unwrap();
AclMgrInner::load(&psm_lock)
};
psm = Some(psm_handle);
inner.unwrap_or({
// Error loading from PSM
AclMgrInner {
entries: [INIT; MAX_ACL_ENTRIES],
}
})
};
Ok(Self {
inner: RwLock::new(inner),
psm,
})
}
pub fn erase_all(&self) {
let mut inner = self.inner.write().unwrap();
for i in 0..MAX_ACL_ENTRIES {
inner.entries[i] = None;
}
if let Some(psm) = self.psm.as_ref() {
let psm = psm.lock().unwrap();
let _ = inner.store(&psm).map_err(|e| {
error!("Error in storing ACLs {}", e);
});
}
}
pub fn add(&self, entry: AclEntry) -> Result<(), Error> {
let mut inner = self.inner.write().unwrap();
let cnt = inner
.entries
.iter()
.flatten()
.filter(|a| a.fab_idx == entry.fab_idx)
.count();
if cnt >= ENTRIES_PER_FABRIC {
return Err(Error::NoSpace);
}
let index = inner
.entries
.iter()
.position(|a| a.is_none())
.ok_or(Error::NoSpace)?;
inner.entries[index] = Some(entry);
if let Some(psm) = self.psm.as_ref() {
let psm = psm.lock().unwrap();
inner.store(&psm)
} else {
Ok(())
}
}
// Since the entries are fabric-scoped, the index is only for entries with the matching fabric index
pub fn edit(&self, index: u8, fab_idx: u8, new: AclEntry) -> Result<(), Error> {
let mut inner = self.inner.write().unwrap();
let old = inner.for_index_in_fabric(index, fab_idx)?;
*old = Some(new);
if let Some(psm) = self.psm.as_ref() {
let psm = psm.lock().unwrap();
inner.store(&psm)
} else {
Ok(())
}
}
pub fn delete(&self, index: u8, fab_idx: u8) -> Result<(), Error> {
let mut inner = self.inner.write().unwrap();
let old = inner.for_index_in_fabric(index, fab_idx)?;
*old = None;
if let Some(psm) = self.psm.as_ref() {
let psm = psm.lock().unwrap();
inner.store(&psm)
} else {
Ok(())
}
}
pub fn delete_for_fabric(&self, fab_idx: u8) -> Result<(), Error> {
let mut inner = self.inner.write().unwrap();
for i in 0..MAX_ACL_ENTRIES {
if inner.entries[i]
.filter(|e| e.fab_idx == Some(fab_idx))
.is_some()
{
inner.entries[i] = None;
}
}
if let Some(psm) = self.psm.as_ref() {
let psm = psm.lock().unwrap();
inner.store(&psm)
} else {
Ok(())
}
}
pub fn for_each_acl<T>(&self, mut f: T) -> Result<(), Error>
where
T: FnMut(&AclEntry),
{
let inner = self.inner.read().unwrap();
for entry in inner.entries.iter().flatten() {
f(entry)
}
Ok(())
}
pub fn allow(&self, req: &AccessReq) -> bool {
// PASE Sessions have implicit access grant
if req.accessor.auth_mode == AuthMode::Pase {
return true;
}
let inner = self.inner.read().unwrap();
for e in inner.entries.iter().flatten() {
if e.allow(req) {
return true;
}
}
error!(
"ACL Disallow for subjects {} fab idx {}",
req.accessor.subjects, req.accessor.fab_idx
);
error!("{}", self);
false
}
}
impl std::fmt::Display for AclMgr {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let inner = self.inner.read().unwrap();
write!(f, "ACLS: [")?; write!(f, "ACLS: [")?;
for i in inner.entries.iter().flatten() { for i in self.entries.iter().flatten() {
write!(f, " {{ {:?} }}, ", i)?; write!(f, " {{ {:?} }}, ", i)?;
} }
write!(f, "]") write!(f, "]")
@ -594,22 +609,23 @@ impl std::fmt::Display for AclMgr {
#[cfg(test)] #[cfg(test)]
#[allow(clippy::bool_assert_comparison)] #[allow(clippy::bool_assert_comparison)]
mod tests { mod tests {
use core::cell::RefCell;
use crate::{ use crate::{
acl::{gen_noc_cat, AccessorSubjects}, acl::{gen_noc_cat, AccessorSubjects},
data_model::objects::{Access, Privilege}, data_model::objects::{Access, Privilege},
interaction_model::messages::GenericPath, interaction_model::messages::GenericPath,
}; };
use std::sync::Arc;
use super::{AccessReq, Accessor, AclEntry, AclMgr, AuthMode, Target}; use super::{AccessReq, Accessor, AclEntry, AclMgr, AuthMode, Target};
#[test] #[test]
fn test_basic_empty_subject_target() { fn test_basic_empty_subject_target() {
let am = Arc::new(AclMgr::new_with(false).unwrap()); let am = RefCell::new(AclMgr::new());
am.erase_all(); am.borrow_mut().erase_all().unwrap();
let accessor = Accessor::new(2, AccessorSubjects::new(112233), AuthMode::Case, am.clone()); let accessor = Accessor::new(2, AccessorSubjects::new(112233), AuthMode::Case, &am);
let path = GenericPath::new(Some(1), Some(1234), None); let path = GenericPath::new(Some(1), Some(1234), None);
let mut req = AccessReq::new(&accessor, &path, Access::READ); let mut req = AccessReq::new(&accessor, path, Access::READ);
req.set_target_perms(Access::RWVA); req.set_target_perms(Access::RWVA);
// Default deny // Default deny
@ -617,46 +633,46 @@ mod tests {
// Deny for session mode mismatch // Deny for session mode mismatch
let new = AclEntry::new(1, Privilege::VIEW, AuthMode::Pase); let new = AclEntry::new(1, Privilege::VIEW, AuthMode::Pase);
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), false); assert_eq!(req.allow(), false);
// Deny for fab idx mismatch // Deny for fab idx mismatch
let new = AclEntry::new(1, Privilege::VIEW, AuthMode::Case); let new = AclEntry::new(1, Privilege::VIEW, AuthMode::Case);
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), false); assert_eq!(req.allow(), false);
// Allow // Allow
let new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), true); assert_eq!(req.allow(), true);
} }
#[test] #[test]
fn test_subject() { fn test_subject() {
let am = Arc::new(AclMgr::new_with(false).unwrap()); let am = RefCell::new(AclMgr::new());
am.erase_all(); am.borrow_mut().erase_all().unwrap();
let accessor = Accessor::new(2, AccessorSubjects::new(112233), AuthMode::Case, am.clone()); let accessor = Accessor::new(2, AccessorSubjects::new(112233), AuthMode::Case, &am);
let path = GenericPath::new(Some(1), Some(1234), None); let path = GenericPath::new(Some(1), Some(1234), None);
let mut req = AccessReq::new(&accessor, &path, Access::READ); let mut req = AccessReq::new(&accessor, path, Access::READ);
req.set_target_perms(Access::RWVA); req.set_target_perms(Access::RWVA);
// Deny for subject mismatch // Deny for subject mismatch
let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
new.add_subject(112232).unwrap(); new.add_subject(112232).unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), false); assert_eq!(req.allow(), false);
// Allow for subject match - target is wildcard // Allow for subject match - target is wildcard
let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
new.add_subject(112233).unwrap(); new.add_subject(112233).unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), true); assert_eq!(req.allow(), true);
} }
#[test] #[test]
fn test_cat() { fn test_cat() {
let am = Arc::new(AclMgr::new_with(false).unwrap()); let am = RefCell::new(AclMgr::new());
am.erase_all(); am.borrow_mut().erase_all().unwrap();
let allow_cat = 0xABCD; let allow_cat = 0xABCD;
let disallow_cat = 0xCAFE; let disallow_cat = 0xCAFE;
@ -666,35 +682,35 @@ mod tests {
let mut subjects = AccessorSubjects::new(112233); let mut subjects = AccessorSubjects::new(112233);
subjects.add_catid(gen_noc_cat(allow_cat, v2)).unwrap(); subjects.add_catid(gen_noc_cat(allow_cat, v2)).unwrap();
let accessor = Accessor::new(2, subjects, AuthMode::Case, am.clone()); let accessor = Accessor::new(2, subjects, AuthMode::Case, &am);
let path = GenericPath::new(Some(1), Some(1234), None); let path = GenericPath::new(Some(1), Some(1234), None);
let mut req = AccessReq::new(&accessor, &path, Access::READ); let mut req = AccessReq::new(&accessor, path, Access::READ);
req.set_target_perms(Access::RWVA); req.set_target_perms(Access::RWVA);
// Deny for CAT id mismatch // Deny for CAT id mismatch
let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
new.add_subject_catid(gen_noc_cat(disallow_cat, v2)) new.add_subject_catid(gen_noc_cat(disallow_cat, v2))
.unwrap(); .unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), false); assert_eq!(req.allow(), false);
// Deny of CAT version mismatch // Deny of CAT version mismatch
let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
new.add_subject_catid(gen_noc_cat(allow_cat, v3)).unwrap(); new.add_subject_catid(gen_noc_cat(allow_cat, v3)).unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), false); assert_eq!(req.allow(), false);
// Allow for CAT match // Allow for CAT match
let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
new.add_subject_catid(gen_noc_cat(allow_cat, v2)).unwrap(); new.add_subject_catid(gen_noc_cat(allow_cat, v2)).unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), true); assert_eq!(req.allow(), true);
} }
#[test] #[test]
fn test_cat_version() { fn test_cat_version() {
let am = Arc::new(AclMgr::new_with(false).unwrap()); let am = RefCell::new(AclMgr::new());
am.erase_all(); am.borrow_mut().erase_all().unwrap();
let allow_cat = 0xABCD; let allow_cat = 0xABCD;
let disallow_cat = 0xCAFE; let disallow_cat = 0xCAFE;
@ -704,32 +720,32 @@ mod tests {
let mut subjects = AccessorSubjects::new(112233); let mut subjects = AccessorSubjects::new(112233);
subjects.add_catid(gen_noc_cat(allow_cat, v3)).unwrap(); subjects.add_catid(gen_noc_cat(allow_cat, v3)).unwrap();
let accessor = Accessor::new(2, subjects, AuthMode::Case, am.clone()); let accessor = Accessor::new(2, subjects, AuthMode::Case, &am);
let path = GenericPath::new(Some(1), Some(1234), None); let path = GenericPath::new(Some(1), Some(1234), None);
let mut req = AccessReq::new(&accessor, &path, Access::READ); let mut req = AccessReq::new(&accessor, path, Access::READ);
req.set_target_perms(Access::RWVA); req.set_target_perms(Access::RWVA);
// Deny for CAT id mismatch // Deny for CAT id mismatch
let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
new.add_subject_catid(gen_noc_cat(disallow_cat, v2)) new.add_subject_catid(gen_noc_cat(disallow_cat, v2))
.unwrap(); .unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), false); assert_eq!(req.allow(), false);
// Allow for CAT match and version more than ACL version // Allow for CAT match and version more than ACL version
let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
new.add_subject_catid(gen_noc_cat(allow_cat, v2)).unwrap(); new.add_subject_catid(gen_noc_cat(allow_cat, v2)).unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), true); assert_eq!(req.allow(), true);
} }
#[test] #[test]
fn test_target() { fn test_target() {
let am = Arc::new(AclMgr::new_with(false).unwrap()); let am = RefCell::new(AclMgr::new());
am.erase_all(); am.borrow_mut().erase_all().unwrap();
let accessor = Accessor::new(2, AccessorSubjects::new(112233), AuthMode::Case, am.clone()); let accessor = Accessor::new(2, AccessorSubjects::new(112233), AuthMode::Case, &am);
let path = GenericPath::new(Some(1), Some(1234), None); let path = GenericPath::new(Some(1), Some(1234), None);
let mut req = AccessReq::new(&accessor, &path, Access::READ); let mut req = AccessReq::new(&accessor, path, Access::READ);
req.set_target_perms(Access::RWVA); req.set_target_perms(Access::RWVA);
// Deny for target mismatch // Deny for target mismatch
@ -740,7 +756,7 @@ mod tests {
device_type: None, device_type: None,
}) })
.unwrap(); .unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), false); assert_eq!(req.allow(), false);
// Allow for cluster match - subject wildcard // Allow for cluster match - subject wildcard
@ -751,11 +767,11 @@ mod tests {
device_type: None, device_type: None,
}) })
.unwrap(); .unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), true); assert_eq!(req.allow(), true);
// Clean Slate // Clean Slate
am.erase_all(); am.borrow_mut().erase_all().unwrap();
// Allow for endpoint match - subject wildcard // Allow for endpoint match - subject wildcard
let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
@ -765,11 +781,11 @@ mod tests {
device_type: None, device_type: None,
}) })
.unwrap(); .unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), true); assert_eq!(req.allow(), true);
// Clean Slate // Clean Slate
am.erase_all(); am.borrow_mut().erase_all().unwrap();
// Allow for exact match // Allow for exact match
let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
@ -780,16 +796,15 @@ mod tests {
}) })
.unwrap(); .unwrap();
new.add_subject(112233).unwrap(); new.add_subject(112233).unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
assert_eq!(req.allow(), true); assert_eq!(req.allow(), true);
} }
#[test] #[test]
fn test_privilege() { fn test_privilege() {
let am = Arc::new(AclMgr::new_with(false).unwrap()); let am = RefCell::new(AclMgr::new());
am.erase_all(); am.borrow_mut().erase_all().unwrap();
let accessor = Accessor::new(2, AccessorSubjects::new(112233), AuthMode::Case, &am);
let accessor = Accessor::new(2, AccessorSubjects::new(112233), AuthMode::Case, am.clone());
let path = GenericPath::new(Some(1), Some(1234), None); let path = GenericPath::new(Some(1), Some(1234), None);
// Create an Exact Match ACL with View privilege // Create an Exact Match ACL with View privilege
@ -801,10 +816,10 @@ mod tests {
}) })
.unwrap(); .unwrap();
new.add_subject(112233).unwrap(); new.add_subject(112233).unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
// Write on an RWVA without admin access - deny // Write on an RWVA without admin access - deny
let mut req = AccessReq::new(&accessor, &path, Access::WRITE); let mut req = AccessReq::new(&accessor, path, Access::WRITE);
req.set_target_perms(Access::RWVA); req.set_target_perms(Access::RWVA);
assert_eq!(req.allow(), false); assert_eq!(req.allow(), false);
@ -817,40 +832,40 @@ mod tests {
}) })
.unwrap(); .unwrap();
new.add_subject(112233).unwrap(); new.add_subject(112233).unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
// Write on an RWVA with admin access - allow // Write on an RWVA with admin access - allow
let mut req = AccessReq::new(&accessor, &path, Access::WRITE); let mut req = AccessReq::new(&accessor, path, Access::WRITE);
req.set_target_perms(Access::RWVA); req.set_target_perms(Access::RWVA);
assert_eq!(req.allow(), true); assert_eq!(req.allow(), true);
} }
#[test] #[test]
fn test_delete_for_fabric() { fn test_delete_for_fabric() {
let am = Arc::new(AclMgr::new_with(false).unwrap()); let am = RefCell::new(AclMgr::new());
am.erase_all(); am.borrow_mut().erase_all().unwrap();
let path = GenericPath::new(Some(1), Some(1234), None); let path = GenericPath::new(Some(1), Some(1234), None);
let accessor2 = Accessor::new(2, AccessorSubjects::new(112233), AuthMode::Case, am.clone()); let accessor2 = Accessor::new(2, AccessorSubjects::new(112233), AuthMode::Case, &am);
let mut req2 = AccessReq::new(&accessor2, &path, Access::READ); let mut req2 = AccessReq::new(&accessor2, path, Access::READ);
req2.set_target_perms(Access::RWVA); req2.set_target_perms(Access::RWVA);
let accessor3 = Accessor::new(3, AccessorSubjects::new(112233), AuthMode::Case, am.clone()); let accessor3 = Accessor::new(3, AccessorSubjects::new(112233), AuthMode::Case, &am);
let mut req3 = AccessReq::new(&accessor3, &path, Access::READ); let mut req3 = AccessReq::new(&accessor3, path, Access::READ);
req3.set_target_perms(Access::RWVA); req3.set_target_perms(Access::RWVA);
// Allow for subject match - target is wildcard - Fabric idx 2 // Allow for subject match - target is wildcard - Fabric idx 2
let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
new.add_subject(112233).unwrap(); new.add_subject(112233).unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
// Allow for subject match - target is wildcard - Fabric idx 3 // Allow for subject match - target is wildcard - Fabric idx 3
let mut new = AclEntry::new(3, Privilege::VIEW, AuthMode::Case); let mut new = AclEntry::new(3, Privilege::VIEW, AuthMode::Case);
new.add_subject(112233).unwrap(); new.add_subject(112233).unwrap();
am.add(new).unwrap(); am.borrow_mut().add(new).unwrap();
// Req for Fabric idx 2 gets denied, and that for Fabric idx 3 is allowed // Req for Fabric idx 2 gets denied, and that for Fabric idx 3 is allowed
assert_eq!(req2.allow(), true); assert_eq!(req2.allow(), true);
assert_eq!(req3.allow(), true); assert_eq!(req3.allow(), true);
am.delete_for_fabric(2).unwrap(); am.borrow_mut().delete_for_fabric(2).unwrap();
assert_eq!(req2.allow(), false); assert_eq!(req2.allow(), false);
assert_eq!(req3.allow(), true); assert_eq!(req3.allow(), true);
} }

View file

@ -18,6 +18,7 @@
use super::{CertConsumer, MAX_DEPTH}; use super::{CertConsumer, MAX_DEPTH};
use crate::error::Error; use crate::error::Error;
use chrono::{Datelike, TimeZone, Utc}; use chrono::{Datelike, TimeZone, Utc};
use core::fmt::Write;
use log::warn; use log::warn;
#[derive(Debug)] #[derive(Debug)]
@ -279,10 +280,12 @@ impl<'a> CertConsumer for ASN1Writer<'a> {
if dt.year() >= 2050 { if dt.year() >= 2050 {
// If year is >= 2050, ASN.1 requires it to be Generalised Time // If year is >= 2050, ASN.1 requires it to be Generalised Time
let time_str = format!("{}Z", dt.format("%Y%m%d%H%M%S")); let mut time_str = heapless::String::<32>::new();
write!(&mut time_str, "{}Z", dt.format("%Y%m%d%H%M%S")).unwrap();
self.write_str(0x18, time_str.as_bytes()) self.write_str(0x18, time_str.as_bytes())
} else { } else {
let time_str = format!("{}Z", dt.format("%y%m%d%H%M%S")); let mut time_str = heapless::String::<32>::new();
write!(&mut time_str, "{}Z", dt.format("%y%m%d%H%M%S")).unwrap();
self.write_str(0x17, time_str.as_bytes()) self.write_str(0x17, time_str.as_bytes())
} }
} }

View file

@ -15,14 +15,17 @@
* limitations under the License. * limitations under the License.
*/ */
use std::fmt; use core::fmt;
extern crate alloc;
use crate::{ use crate::{
crypto::{CryptoKeyPair, KeyPair}, crypto::KeyPair,
error::Error, error::Error,
tlv::{self, FromTLV, TLVArrayOwned, TLVElement, TLVWriter, TagType, ToTLV}, tlv::{self, FromTLV, TLVArrayOwned, TLVElement, TLVWriter, TagType, ToTLV},
utils::writebuf::WriteBuf, utils::writebuf::WriteBuf,
}; };
use alloc::{format, string::String, vec::Vec};
use log::error; use log::error;
use num_derive::FromPrimitive; use num_derive::FromPrimitive;
@ -591,10 +594,10 @@ impl Cert {
} }
pub fn as_tlv(&self, buf: &mut [u8]) -> Result<usize, Error> { pub fn as_tlv(&self, buf: &mut [u8]) -> Result<usize, Error> {
let mut wb = WriteBuf::new(buf, buf.len()); let mut wb = WriteBuf::new(buf);
let mut tw = TLVWriter::new(&mut wb); let mut tw = TLVWriter::new(&mut wb);
self.to_tlv(&mut tw, TagType::Anonymous)?; self.to_tlv(&mut tw, TagType::Anonymous)?;
Ok(wb.as_slice().len()) Ok(wb.into_slice().len())
} }
pub fn as_asn1(&self, buf: &mut [u8]) -> Result<usize, Error> { pub fn as_asn1(&self, buf: &mut [u8]) -> Result<usize, Error> {
@ -731,6 +734,8 @@ mod printer;
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use log::info;
use crate::cert::Cert; use crate::cert::Cert;
use crate::error::Error; use crate::error::Error;
use crate::tlv::{self, FromTLV, TLVWriter, TagType, ToTLV}; use crate::tlv::{self, FromTLV, TLVWriter, TagType, ToTLV};
@ -811,15 +816,14 @@ mod tests {
]; ];
for input in test_input.iter() { for input in test_input.iter() {
println!("Testing next input..."); info!("Testing next input...");
let root = tlv::get_root_node(input).unwrap(); let root = tlv::get_root_node(input).unwrap();
let cert = Cert::from_tlv(&root).unwrap(); let cert = Cert::from_tlv(&root).unwrap();
let mut buf = [0u8; 1024]; let mut buf = [0u8; 1024];
let buf_len = buf.len(); let mut wb = WriteBuf::new(&mut buf);
let mut wb = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut wb); let mut tw = TLVWriter::new(&mut wb);
cert.to_tlv(&mut tw, TagType::Anonymous).unwrap(); cert.to_tlv(&mut tw, TagType::Anonymous).unwrap();
assert_eq!(*input, wb.as_slice()); assert_eq!(*input, wb.into_slice());
} }
} }

View file

@ -18,8 +18,8 @@
use super::{CertConsumer, MAX_DEPTH}; use super::{CertConsumer, MAX_DEPTH};
use crate::error::Error; use crate::error::Error;
use chrono::{TimeZone, Utc}; use chrono::{TimeZone, Utc};
use core::fmt;
use log::warn; use log::warn;
use std::fmt;
pub struct CertPrinter<'a, 'b> { pub struct CertPrinter<'a, 'b> {
level: usize, level: usize,

View file

@ -17,6 +17,10 @@
//! Base38 encoding and decoding functions. //! Base38 encoding and decoding functions.
extern crate alloc;
use alloc::{string::String, vec::Vec};
use crate::error::Error; use crate::error::Error;
const BASE38_CHARS: [char; 38] = [ const BASE38_CHARS: [char; 38] = [
@ -97,7 +101,7 @@ pub fn encode(bytes: &[u8], length: Option<usize>) -> String {
while offset < length { while offset < length {
let remaining = length - offset; let remaining = length - offset;
match remaining.cmp(&2) { match remaining.cmp(&2) {
std::cmp::Ordering::Greater => { core::cmp::Ordering::Greater => {
result.push_str(&encode_base38( result.push_str(&encode_base38(
((bytes[offset + 2] as u32) << 16) ((bytes[offset + 2] as u32) << 16)
| ((bytes[offset + 1] as u32) << 8) | ((bytes[offset + 1] as u32) << 8)
@ -106,14 +110,14 @@ pub fn encode(bytes: &[u8], length: Option<usize>) -> String {
)); ));
offset += 3; offset += 3;
} }
std::cmp::Ordering::Equal => { core::cmp::Ordering::Equal => {
result.push_str(&encode_base38( result.push_str(&encode_base38(
((bytes[offset + 1] as u32) << 8) | (bytes[offset] as u32), ((bytes[offset + 1] as u32) << 8) | (bytes[offset] as u32),
4, 4,
)); ));
break; break;
} }
std::cmp::Ordering::Less => { core::cmp::Ordering::Less => {
result.push_str(&encode_base38(bytes[offset] as u32, 2)); result.push_str(&encode_base38(bytes[offset] as u32, 2));
break; break;
} }

View file

@ -15,21 +15,19 @@
* limitations under the License. * limitations under the License.
*/ */
use core::{borrow::Borrow, cell::RefCell};
use crate::{ use crate::{
acl::AclMgr, acl::AclMgr,
data_model::{ data_model::{cluster_basic_information::BasicInfoConfig, sdm::failsafe::FailSafe},
cluster_basic_information::BasicInfoConfig, core::DataModel,
sdm::dev_att::DevAttDataFetcher,
},
error::*, error::*,
fabric::FabricMgr, fabric::FabricMgr,
interaction_model::InteractionModel, mdns::{Mdns, MdnsMgr},
mdns::Mdns,
pairing::{print_pairing_code_and_qr, DiscoveryCapabilities}, pairing::{print_pairing_code_and_qr, DiscoveryCapabilities},
secure_channel::{core::SecureChannel, pake::PaseMgr, spake2p::VerifierData}, secure_channel::{pake::PaseMgr, spake2p::VerifierData},
transport, transport::udp::MATTER_PORT,
utils::{epoch::Epoch, rand::Rand},
}; };
use std::sync::Arc;
/// Device Commissioning Data /// Device Commissioning Data
pub struct CommissioningData { pub struct CommissioningData {
@ -40,13 +38,18 @@ pub struct CommissioningData {
} }
/// The primary Matter Object /// The primary Matter Object
pub struct Matter { pub struct Matter<'a> {
transport_mgr: transport::mgr::Mgr, pub fabric_mgr: RefCell<FabricMgr>,
data_model: DataModel, pub acl_mgr: RefCell<AclMgr>,
fabric_mgr: Arc<FabricMgr>, pub pase_mgr: RefCell<PaseMgr>,
pub failsafe: RefCell<FailSafe>,
pub mdns_mgr: RefCell<MdnsMgr<'a>>,
pub epoch: Epoch,
pub rand: Rand,
pub dev_det: &'a BasicInfoConfig<'a>,
} }
impl Matter { impl<'a> Matter<'a> {
/// Creates a new Matter object /// Creates a new Matter object
/// ///
/// # Parameters /// # Parameters
@ -54,57 +57,87 @@ impl Matter {
/// requires a set of device attestation certificates and keys. It is the responsibility of /// requires a set of device attestation certificates and keys. It is the responsibility of
/// this object to return the device attestation details when queried upon. /// this object to return the device attestation details when queried upon.
pub fn new( pub fn new(
dev_det: BasicInfoConfig, dev_det: &'a BasicInfoConfig,
dev_att: Box<dyn DevAttDataFetcher>, mdns: &'a mut dyn Mdns,
dev_comm: CommissioningData, epoch: Epoch,
) -> Result<Box<Matter>, Error> { rand: Rand,
let mdns = Mdns::get()?; ) -> Self {
mdns.set_values(dev_det.vid, dev_det.pid, &dev_det.device_name); Self {
fabric_mgr: RefCell::new(FabricMgr::new()),
acl_mgr: RefCell::new(AclMgr::new()),
pase_mgr: RefCell::new(PaseMgr::new(epoch, rand)),
failsafe: RefCell::new(FailSafe::new()),
mdns_mgr: RefCell::new(MdnsMgr::new(
dev_det.vid,
dev_det.pid,
dev_det.device_name,
MATTER_PORT,
mdns,
)),
epoch,
rand,
dev_det,
}
}
let fabric_mgr = Arc::new(FabricMgr::new()?); pub fn dev_det(&self) -> &BasicInfoConfig {
let open_comm_window = fabric_mgr.is_empty(); self.dev_det
}
pub fn start(&mut self, dev_comm: CommissioningData) -> Result<(), Error> {
let open_comm_window = self.fabric_mgr.borrow().is_empty();
if open_comm_window { if open_comm_window {
print_pairing_code_and_qr(&dev_det, &dev_comm, DiscoveryCapabilities::default()); print_pairing_code_and_qr(self.dev_det, &dev_comm, DiscoveryCapabilities::default());
self.pase_mgr.borrow_mut().enable_pase_session(
dev_comm.verifier,
dev_comm.discriminator,
&mut self.mdns_mgr.borrow_mut(),
)?;
} }
let acl_mgr = Arc::new(AclMgr::new()?); Ok(())
let mut pase = PaseMgr::new(); }
let data_model = }
DataModel::new(dev_det, dev_att, fabric_mgr.clone(), acl_mgr, pase.clone())?;
let mut matter = Box::new(Matter { impl<'a> Borrow<RefCell<FabricMgr>> for Matter<'a> {
transport_mgr: transport::mgr::Mgr::new()?, fn borrow(&self) -> &RefCell<FabricMgr> {
data_model, &self.fabric_mgr
fabric_mgr, }
}); }
let interaction_model =
Box::new(InteractionModel::new(Box::new(matter.data_model.clone()))); impl<'a> Borrow<RefCell<AclMgr>> for Matter<'a> {
matter.transport_mgr.register_protocol(interaction_model)?; fn borrow(&self) -> &RefCell<AclMgr> {
&self.acl_mgr
if open_comm_window { }
pase.enable_pase_session(dev_comm.verifier, dev_comm.discriminator)?; }
}
impl<'a> Borrow<RefCell<PaseMgr>> for Matter<'a> {
let secure_channel = Box::new(SecureChannel::new(pase, matter.fabric_mgr.clone())); fn borrow(&self) -> &RefCell<PaseMgr> {
matter.transport_mgr.register_protocol(secure_channel)?; &self.pase_mgr
Ok(matter) }
} }
/// Returns an Arc to [DataModel] impl<'a> Borrow<RefCell<FailSafe>> for Matter<'a> {
/// fn borrow(&self) -> &RefCell<FailSafe> {
/// The Data Model is where you express what is the type of your device. Typically &self.failsafe
/// once you gets this reference, you acquire the write lock and add your device }
/// types, clusters, attributes, commands to the data model. }
pub fn get_data_model(&self) -> DataModel {
self.data_model.clone() impl<'a> Borrow<RefCell<MdnsMgr<'a>>> for Matter<'a> {
} fn borrow(&self) -> &RefCell<MdnsMgr<'a>> {
&self.mdns_mgr
/// Starts the Matter daemon }
/// }
/// This call does NOT return
/// impl<'a> Borrow<Epoch> for Matter<'a> {
/// This call starts the Matter daemon that starts communication with other Matter fn borrow(&self) -> &Epoch {
/// devices on the network. &self.epoch
pub fn start_daemon(&mut self) -> Result<(), Error> { }
self.transport_mgr.start() }
impl<'a> Borrow<Rand> for Matter<'a> {
fn borrow(&self) -> &Rand {
&self.rand
} }
} }

View file

@ -19,39 +19,118 @@ use log::error;
use crate::error::Error; use crate::error::Error;
use super::CryptoKeyPair; pub fn hkdf_sha256(_salt: &[u8], _ikm: &[u8], _info: &[u8], _key: &mut [u8]) -> Result<(), Error> {
error!("This API should never get called");
Ok(())
}
pub struct KeyPairDummy {} #[derive(Clone)]
pub struct Sha256 {}
impl KeyPairDummy { impl Sha256 {
pub fn new() -> Result<Self, Error> { pub fn new() -> Result<Self, Error> {
Ok(Self {}) Ok(Self {})
} }
pub fn update(&mut self, _data: &[u8]) -> Result<(), Error> {
Ok(())
}
pub fn finish(self, _digest: &mut [u8]) -> Result<(), Error> {
Ok(())
}
} }
impl CryptoKeyPair for KeyPairDummy { pub struct HmacSha256 {}
fn get_csr<'a>(&self, _out_csr: &'a mut [u8]) -> Result<&'a [u8], Error> {
impl HmacSha256 {
pub fn new(_key: &[u8]) -> Result<Self, Error> {
error!("This API should never get called");
Ok(Self {})
}
pub fn update(&mut self, _data: &[u8]) -> Result<(), Error> {
error!("This API should never get called");
Ok(())
}
pub fn finish(self, _out: &mut [u8]) -> Result<(), Error> {
error!("This API should never get called");
Ok(())
}
}
pub struct KeyPair;
impl KeyPair {
pub fn new() -> Result<Self, Error> {
Ok(Self)
}
pub fn new_from_components(_pub_key: &[u8], _priv_key: &[u8]) -> Result<Self, Error> {
error!("This API should never get called");
Ok(Self {})
}
pub fn new_from_public(_pub_key: &[u8]) -> Result<Self, Error> {
error!("This API should never get called");
Ok(Self {})
}
pub fn get_csr<'a>(&self, _out_csr: &'a mut [u8]) -> Result<&'a [u8], Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }
fn get_public_key(&self, _pub_key: &mut [u8]) -> Result<usize, Error> {
pub fn get_public_key(&self, _pub_key: &mut [u8]) -> Result<usize, Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }
fn get_private_key(&self, _pub_key: &mut [u8]) -> Result<usize, Error> {
pub fn get_private_key(&self, _pub_key: &mut [u8]) -> Result<usize, Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }
fn derive_secret(self, _peer_pub_key: &[u8], _secret: &mut [u8]) -> Result<usize, Error> {
pub fn derive_secret(self, _peer_pub_key: &[u8], _secret: &mut [u8]) -> Result<usize, Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }
fn sign_msg(&self, _msg: &[u8], _signature: &mut [u8]) -> Result<usize, Error> {
pub fn sign_msg(&self, _msg: &[u8], _signature: &mut [u8]) -> Result<usize, Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }
fn verify_msg(&self, _msg: &[u8], _signature: &[u8]) -> Result<(), Error> {
pub fn verify_msg(&self, _msg: &[u8], _signature: &[u8]) -> Result<(), Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }
} }
pub fn pbkdf2_hmac(_pass: &[u8], _iter: usize, _salt: &[u8], _key: &mut [u8]) -> Result<(), Error> {
error!("This API should never get called");
Ok(())
}
pub fn encrypt_in_place(
_key: &[u8],
_nonce: &[u8],
_ad: &[u8],
_data: &mut [u8],
_data_len: usize,
) -> Result<usize, Error> {
Ok(0)
}
pub fn decrypt_in_place(
_key: &[u8],
_nonce: &[u8],
_ad: &[u8],
_data: &mut [u8],
) -> Result<usize, Error> {
Ok(0)
}

View file

@ -19,8 +19,6 @@ use log::error;
use crate::error::Error; use crate::error::Error;
use super::CryptoKeyPair;
pub fn hkdf_sha256(_salt: &[u8], _ikm: &[u8], _info: &[u8], _key: &mut [u8]) -> Result<(), Error> { pub fn hkdf_sha256(_salt: &[u8], _ikm: &[u8], _info: &[u8], _key: &mut [u8]) -> Result<(), Error> {
error!("This API should never get called"); error!("This API should never get called");
Ok(()) Ok(())
@ -82,26 +80,28 @@ impl KeyPair {
Ok(Self {}) Ok(Self {})
} }
}
impl CryptoKeyPair for KeyPair { pub fn get_csr<'a>(&self, _out_csr: &'a mut [u8]) -> Result<&'a [u8], Error> {
fn get_csr<'a>(&self, _out_csr: &'a mut [u8]) -> Result<&'a [u8], Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }
fn get_public_key(&self, _pub_key: &mut [u8]) -> Result<usize, Error> {
pub fn get_public_key(&self, _pub_key: &mut [u8]) -> Result<usize, Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }
fn derive_secret(self, _peer_pub_key: &[u8], _secret: &mut [u8]) -> Result<usize, Error> {
pub fn derive_secret(self, _peer_pub_key: &[u8], _secret: &mut [u8]) -> Result<usize, Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }
fn sign_msg(&self, _msg: &[u8], _signature: &mut [u8]) -> Result<usize, Error> {
pub fn sign_msg(&self, _msg: &[u8], _signature: &mut [u8]) -> Result<usize, Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }
fn verify_msg(&self, _msg: &[u8], _signature: &[u8]) -> Result<(), Error> {
pub fn verify_msg(&self, _msg: &[u8], _signature: &[u8]) -> Result<(), Error> {
error!("This API should never get called"); error!("This API should never get called");
Err(Error::Invalid) Err(Error::Invalid)
} }

View file

@ -15,9 +15,11 @@
* limitations under the License. * limitations under the License.
*/ */
use std::sync::Arc; extern crate alloc;
use log::error; use alloc::sync::Arc;
use log::{error, info};
use mbedtls::{ use mbedtls::{
bignum::Mpi, bignum::Mpi,
cipher::{Authenticated, Cipher}, cipher::{Authenticated, Cipher},
@ -28,7 +30,6 @@ use mbedtls::{
x509, x509,
}; };
use super::CryptoKeyPair;
use crate::{ use crate::{
// TODO: We should move ASN1Writer out of Cert, // TODO: We should move ASN1Writer out of Cert,
// so Crypto doesn't have to depend on Cert // so Crypto doesn't have to depend on Cert
@ -85,10 +86,8 @@ impl KeyPair {
key: Pk::public_from_ec_components(group, pub_key)?, key: Pk::public_from_ec_components(group, pub_key)?,
}) })
} }
}
impl CryptoKeyPair for KeyPair { pub fn get_csr<'a>(&self, out_csr: &'a mut [u8]) -> Result<&'a [u8], Error> {
fn get_csr<'a>(&self, out_csr: &'a mut [u8]) -> Result<&'a [u8], Error> {
let tmp_priv = self.key.ec_private()?; let tmp_priv = self.key.ec_private()?;
let mut tmp_key = let mut tmp_key =
Pk::private_from_ec_components(EcGroup::new(EcGroupId::SecP256R1)?, tmp_priv)?; Pk::private_from_ec_components(EcGroup::new(EcGroupId::SecP256R1)?, tmp_priv)?;
@ -112,7 +111,7 @@ impl CryptoKeyPair for KeyPair {
} }
} }
fn get_public_key(&self, pub_key: &mut [u8]) -> Result<usize, Error> { pub fn get_public_key(&self, pub_key: &mut [u8]) -> Result<usize, Error> {
let public_key = self.key.ec_public()?; let public_key = self.key.ec_public()?;
let group = EcGroup::new(EcGroupId::SecP256R1)?; let group = EcGroup::new(EcGroupId::SecP256R1)?;
let vec = public_key.to_binary(&group, false)?; let vec = public_key.to_binary(&group, false)?;
@ -122,7 +121,7 @@ impl CryptoKeyPair for KeyPair {
Ok(len) Ok(len)
} }
fn get_private_key(&self, priv_key: &mut [u8]) -> Result<usize, Error> { pub fn get_private_key(&self, priv_key: &mut [u8]) -> Result<usize, Error> {
let priv_key_mpi = self.key.ec_private()?; let priv_key_mpi = self.key.ec_private()?;
let vec = priv_key_mpi.to_binary()?; let vec = priv_key_mpi.to_binary()?;
@ -131,7 +130,7 @@ impl CryptoKeyPair for KeyPair {
Ok(len) Ok(len)
} }
fn derive_secret(self, peer_pub_key: &[u8], secret: &mut [u8]) -> Result<usize, Error> { pub fn derive_secret(self, peer_pub_key: &[u8], secret: &mut [u8]) -> Result<usize, Error> {
// mbedtls requires a 'mut' key. Instead of making a change in our Trait, // mbedtls requires a 'mut' key. Instead of making a change in our Trait,
// we just clone the key this way // we just clone the key this way
@ -149,7 +148,7 @@ impl CryptoKeyPair for KeyPair {
Ok(len) Ok(len)
} }
fn sign_msg(&self, msg: &[u8], signature: &mut [u8]) -> Result<usize, Error> { pub fn sign_msg(&self, msg: &[u8], signature: &mut [u8]) -> Result<usize, Error> {
// mbedtls requires a 'mut' key. Instead of making a change in our Trait, // mbedtls requires a 'mut' key. Instead of making a change in our Trait,
// we just clone the key this way // we just clone the key this way
let tmp_key = self.key.ec_private()?; let tmp_key = self.key.ec_private()?;
@ -175,7 +174,7 @@ impl CryptoKeyPair for KeyPair {
Ok(len) Ok(len)
} }
fn verify_msg(&self, msg: &[u8], signature: &[u8]) -> Result<(), Error> { pub fn verify_msg(&self, msg: &[u8], signature: &[u8]) -> Result<(), Error> {
// mbedtls requires a 'mut' key. Instead of making a change in our Trait, // mbedtls requires a 'mut' key. Instead of making a change in our Trait,
// we just clone the key this way // we just clone the key this way
let tmp_key = self.key.ec_public()?; let tmp_key = self.key.ec_public()?;
@ -192,7 +191,7 @@ impl CryptoKeyPair for KeyPair {
let mbedtls_sign = &mbedtls_sign[..len]; let mbedtls_sign = &mbedtls_sign[..len];
if let Err(e) = tmp_key.verify(hash::Type::Sha256, &msg_hash, mbedtls_sign) { if let Err(e) = tmp_key.verify(hash::Type::Sha256, &msg_hash, mbedtls_sign) {
println!("The error is {}", e); info!("The error is {}", e);
Err(Error::InvalidSignature) Err(Error::InvalidSignature)
} else { } else {
Ok(()) Ok(())

View file

@ -17,7 +17,6 @@
use crate::error::Error; use crate::error::Error;
use super::CryptoKeyPair;
use foreign_types::ForeignTypeRef; use foreign_types::ForeignTypeRef;
use log::error; use log::error;
use openssl::asn1::Asn1Type; use openssl::asn1::Asn1Type;
@ -112,10 +111,8 @@ impl KeyPair {
KeyType::Private(k) => Ok(&k), KeyType::Private(k) => Ok(&k),
} }
} }
}
impl CryptoKeyPair for KeyPair { pub fn get_public_key(&self, pub_key: &mut [u8]) -> Result<usize, Error> {
fn get_public_key(&self, pub_key: &mut [u8]) -> Result<usize, Error> {
let group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1)?; let group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1)?;
let mut bn_ctx = BigNumContext::new()?; let mut bn_ctx = BigNumContext::new()?;
let s = self.public_key_point().to_bytes( let s = self.public_key_point().to_bytes(
@ -128,14 +125,14 @@ impl CryptoKeyPair for KeyPair {
Ok(len) Ok(len)
} }
fn get_private_key(&self, priv_key: &mut [u8]) -> Result<usize, Error> { pub fn get_private_key(&self, priv_key: &mut [u8]) -> Result<usize, Error> {
let s = self.private_key()?.private_key().to_vec(); let s = self.private_key()?.private_key().to_vec();
let len = s.len(); let len = s.len();
priv_key[..len].copy_from_slice(s.as_slice()); priv_key[..len].copy_from_slice(s.as_slice());
Ok(len) Ok(len)
} }
fn derive_secret(self, peer_pub_key: &[u8], secret: &mut [u8]) -> Result<usize, Error> { pub fn derive_secret(self, peer_pub_key: &[u8], secret: &mut [u8]) -> Result<usize, Error> {
let self_pkey = PKey::from_ec_key(self.private_key()?.clone())?; let self_pkey = PKey::from_ec_key(self.private_key()?.clone())?;
let group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1)?; let group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1)?;
@ -149,7 +146,7 @@ impl CryptoKeyPair for KeyPair {
Ok(deriver.derive(secret)?) Ok(deriver.derive(secret)?)
} }
fn get_csr<'a>(&self, out_csr: &'a mut [u8]) -> Result<&'a [u8], Error> { pub fn get_csr<'a>(&self, out_csr: &'a mut [u8]) -> Result<&'a [u8], Error> {
let mut builder = X509ReqBuilder::new()?; let mut builder = X509ReqBuilder::new()?;
builder.set_version(0)?; builder.set_version(0)?;
@ -174,7 +171,7 @@ impl CryptoKeyPair for KeyPair {
} }
} }
fn sign_msg(&self, msg: &[u8], signature: &mut [u8]) -> Result<usize, Error> { pub fn sign_msg(&self, msg: &[u8], signature: &mut [u8]) -> Result<usize, Error> {
// First get the SHA256 of the message // First get the SHA256 of the message
let mut h = Hasher::new(MessageDigest::sha256())?; let mut h = Hasher::new(MessageDigest::sha256())?;
h.update(msg)?; h.update(msg)?;
@ -193,7 +190,7 @@ impl CryptoKeyPair for KeyPair {
Ok(64) Ok(64)
} }
fn verify_msg(&self, msg: &[u8], signature: &[u8]) -> Result<(), Error> { pub fn verify_msg(&self, msg: &[u8], signature: &[u8]) -> Result<(), Error> {
// First get the SHA256 of the message // First get the SHA256 of the message
let mut h = Hasher::new(MessageDigest::sha256())?; let mut h = Hasher::new(MessageDigest::sha256())?;
h.update(msg)?; h.update(msg)?;

View file

@ -15,8 +15,6 @@
* limitations under the License. * limitations under the License.
*/ */
use crate::error::Error;
pub const SYMM_KEY_LEN_BITS: usize = 128; pub const SYMM_KEY_LEN_BITS: usize = 128;
pub const SYMM_KEY_LEN_BYTES: usize = SYMM_KEY_LEN_BITS / 8; pub const SYMM_KEY_LEN_BYTES: usize = SYMM_KEY_LEN_BITS / 8;
@ -35,16 +33,6 @@ pub const ECDH_SHARED_SECRET_LEN_BYTES: usize = 32;
pub const EC_SIGNATURE_LEN_BYTES: usize = 64; pub const EC_SIGNATURE_LEN_BYTES: usize = 64;
// APIs particular to a KeyPair so a KeyPair object can be defined
pub trait CryptoKeyPair {
fn get_csr<'a>(&self, csr: &'a mut [u8]) -> Result<&'a [u8], Error>;
fn get_public_key(&self, pub_key: &mut [u8]) -> Result<usize, Error>;
fn get_private_key(&self, priv_key: &mut [u8]) -> Result<usize, Error>;
fn derive_secret(self, peer_pub_key: &[u8], secret: &mut [u8]) -> Result<usize, Error>;
fn sign_msg(&self, msg: &[u8], signature: &mut [u8]) -> Result<usize, Error>;
fn verify_msg(&self, msg: &[u8], signature: &[u8]) -> Result<(), Error>;
}
#[cfg(feature = "crypto_esp_mbedtls")] #[cfg(feature = "crypto_esp_mbedtls")]
mod crypto_esp_mbedtls; mod crypto_esp_mbedtls;
#[cfg(feature = "crypto_esp_mbedtls")] #[cfg(feature = "crypto_esp_mbedtls")]
@ -65,13 +53,26 @@ mod crypto_rustcrypto;
#[cfg(feature = "crypto_rustcrypto")] #[cfg(feature = "crypto_rustcrypto")]
pub use self::crypto_rustcrypto::*; pub use self::crypto_rustcrypto::*;
#[cfg(not(any(
feature = "crypto_openssl",
feature = "crypto_mbedtls",
feature = "crypto_esp_mbedtls",
feature = "crypto_rustcrypto"
)))]
pub mod crypto_dummy; pub mod crypto_dummy;
#[cfg(not(any(
feature = "crypto_openssl",
feature = "crypto_mbedtls",
feature = "crypto_esp_mbedtls",
feature = "crypto_rustcrypto"
)))]
pub use self::crypto_dummy::*;
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use crate::error::Error; use crate::error::Error;
use super::{CryptoKeyPair, KeyPair}; use super::KeyPair;
#[test] #[test]
fn test_verify_msg_success() { fn test_verify_msg_success() {

View file

@ -15,100 +15,129 @@
* limitations under the License. * limitations under the License.
*/ */
use core::convert::TryInto;
use super::objects::*; use super::objects::*;
use crate::error::*; use crate::{attribute_enum, error::Error, utils::rand::Rand};
use num_derive::FromPrimitive; use strum::{EnumDiscriminants, FromRepr};
pub const ID: u32 = 0x0028; pub const ID: u32 = 0x0028;
#[derive(FromPrimitive)] #[derive(Clone, Copy, Debug, FromRepr, EnumDiscriminants)]
#[repr(u16)]
pub enum Attributes { pub enum Attributes {
DMRevision = 0, DMRevision(AttrType<u8>) = 0,
VendorId = 2, VendorId(AttrType<u16>) = 2,
ProductId = 4, ProductId(AttrType<u16>) = 4,
HwVer = 7, HwVer(AttrType<u16>) = 7,
SwVer = 9, SwVer(AttrType<u32>) = 9,
SwVerString = 0xa, SwVerString(AttrUtfType) = 0xa,
SerialNo = 0x0f, SerialNo(AttrUtfType) = 0x0f,
} }
attribute_enum!(Attributes);
#[derive(Default)] #[derive(Default)]
pub struct BasicInfoConfig { pub struct BasicInfoConfig<'a> {
pub vid: u16, pub vid: u16,
pub pid: u16, pub pid: u16,
pub hw_ver: u16, pub hw_ver: u16,
pub sw_ver: u32, pub sw_ver: u32,
pub sw_ver_str: String, pub sw_ver_str: &'a str,
pub serial_no: String, pub serial_no: &'a str,
/// Device name; up to 32 characters /// Device name; up to 32 characters
pub device_name: String, pub device_name: &'a str,
} }
pub struct BasicInfoCluster { pub const CLUSTER: Cluster<'static> = Cluster {
base: Cluster, id: ID as _,
feature_map: 0,
attributes: &[
FEATURE_MAP,
ATTRIBUTE_LIST,
Attribute::new(
AttributesDiscriminants::DMRevision as u16,
Access::RV,
Quality::FIXED,
),
Attribute::new(
AttributesDiscriminants::VendorId as u16,
Access::RV,
Quality::FIXED,
),
Attribute::new(
AttributesDiscriminants::ProductId as u16,
Access::RV,
Quality::FIXED,
),
Attribute::new(
AttributesDiscriminants::HwVer as u16,
Access::RV,
Quality::FIXED,
),
Attribute::new(
AttributesDiscriminants::SwVer as u16,
Access::RV,
Quality::FIXED,
),
Attribute::new(
AttributesDiscriminants::SwVerString as u16,
Access::RV,
Quality::FIXED,
),
Attribute::new(
AttributesDiscriminants::SerialNo as u16,
Access::RV,
Quality::FIXED,
),
],
commands: &[],
};
pub struct BasicInfoCluster<'a> {
data_ver: Dataver,
cfg: &'a BasicInfoConfig<'a>,
} }
impl BasicInfoCluster { impl<'a> BasicInfoCluster<'a> {
pub fn new(cfg: BasicInfoConfig) -> Result<Box<Self>, Error> { pub fn new(cfg: &'a BasicInfoConfig<'a>, rand: Rand) -> Self {
let mut cluster = Box::new(BasicInfoCluster { Self {
base: Cluster::new(ID)?, data_ver: Dataver::new(rand),
}); cfg,
}
}
let attrs = [ pub fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
Attribute::new( if let Some(writer) = encoder.with_dataver(self.data_ver.get())? {
Attributes::DMRevision as u16, if attr.is_system() {
AttrValue::Uint8(1), CLUSTER.read(attr.attr_id, writer)
Access::RV, } else {
Quality::FIXED, match attr.attr_id.try_into()? {
), Attributes::DMRevision(codec) => codec.encode(writer, 1),
Attribute::new( Attributes::VendorId(codec) => codec.encode(writer, self.cfg.vid),
Attributes::VendorId as u16, Attributes::ProductId(codec) => codec.encode(writer, self.cfg.pid),
AttrValue::Uint16(cfg.vid), Attributes::HwVer(codec) => codec.encode(writer, self.cfg.hw_ver),
Access::RV, Attributes::SwVer(codec) => codec.encode(writer, self.cfg.sw_ver),
Quality::FIXED, Attributes::SwVerString(codec) => codec.encode(writer, self.cfg.sw_ver_str),
), Attributes::SerialNo(codec) => codec.encode(writer, self.cfg.serial_no),
Attribute::new( }
Attributes::ProductId as u16, }
AttrValue::Uint16(cfg.pid), } else {
Access::RV, Ok(())
Quality::FIXED, }
),
Attribute::new(
Attributes::HwVer as u16,
AttrValue::Uint16(cfg.hw_ver),
Access::RV,
Quality::FIXED,
),
Attribute::new(
Attributes::SwVer as u16,
AttrValue::Uint32(cfg.sw_ver),
Access::RV,
Quality::FIXED,
),
Attribute::new(
Attributes::SwVerString as u16,
AttrValue::Utf8(cfg.sw_ver_str),
Access::RV,
Quality::FIXED,
),
Attribute::new(
Attributes::SerialNo as u16,
AttrValue::Utf8(cfg.serial_no),
Access::RV,
Quality::FIXED,
),
];
cluster.base.add_attributes(&attrs[..])?;
Ok(cluster)
} }
} }
impl ClusterType for BasicInfoCluster { impl<'a> Handler for BasicInfoCluster<'a> {
fn base(&self) -> &Cluster { fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
&self.base BasicInfoCluster::read(self, attr, encoder)
} }
fn base_mut(&mut self) -> &mut Cluster { }
&mut self.base
impl<'a> NonBlockingHandler for BasicInfoCluster<'a> {}
impl<'a> ChangeNotifier<()> for BasicInfoCluster<'a> {
fn consume_change(&mut self) -> Option<()> {
self.data_ver.consume_change(())
} }
} }

View file

@ -15,114 +15,153 @@
* limitations under the License. * limitations under the License.
*/ */
use core::convert::TryInto;
use super::objects::*; use super::objects::*;
use crate::{ use crate::{
cmd_enter, attribute_enum, cmd_enter, command_enum, error::Error, interaction_model::core::Transaction,
error::*, tlv::TLVElement, utils::rand::Rand,
interaction_model::{command::CommandReq, core::IMStatusCode},
}; };
use log::info; use log::info;
use num_derive::FromPrimitive; use strum::{EnumDiscriminants, FromRepr};
pub const ID: u32 = 0x0006; pub const ID: u32 = 0x0006;
#[derive(FromRepr, EnumDiscriminants)]
#[repr(u16)]
pub enum Attributes { pub enum Attributes {
OnOff = 0x0, OnOff(AttrType<bool>) = 0x0,
} }
#[derive(FromPrimitive)] attribute_enum!(Attributes);
#[derive(FromRepr, EnumDiscriminants)]
#[repr(u32)]
pub enum Commands { pub enum Commands {
Off = 0x0, Off = 0x0,
On = 0x01, On = 0x01,
Toggle = 0x02, Toggle = 0x02,
} }
fn attr_on_off_new() -> Attribute { command_enum!(Commands);
// OnOff, Value: false
pub const CLUSTER: Cluster<'static> = Cluster {
id: ID as _,
feature_map: 0,
attributes: &[
FEATURE_MAP,
ATTRIBUTE_LIST,
Attribute::new( Attribute::new(
Attributes::OnOff as u16, AttributesDiscriminants::OnOff as u16,
AttrValue::Bool(false),
Access::RV, Access::RV,
Quality::PERSISTENT, Quality::PERSISTENT,
) ),
} ],
commands: &[
CommandsDiscriminants::Off as _,
CommandsDiscriminants::On as _,
CommandsDiscriminants::Toggle as _,
],
};
pub struct OnOffCluster { pub struct OnOffCluster {
base: Cluster, data_ver: Dataver,
on: bool,
} }
impl OnOffCluster { impl OnOffCluster {
pub fn new() -> Result<Box<Self>, Error> { pub fn new(rand: Rand) -> Self {
let mut cluster = Box::new(OnOffCluster { Self {
base: Cluster::new(ID)?, data_ver: Dataver::new(rand),
}); on: false,
cluster.base.add_attribute(attr_on_off_new())?;
Ok(cluster)
} }
}
impl ClusterType for OnOffCluster {
fn base(&self) -> &Cluster {
&self.base
}
fn base_mut(&mut self) -> &mut Cluster {
&mut self.base
} }
fn handle_command(&mut self, cmd_req: &mut CommandReq) -> Result<(), IMStatusCode> { pub fn set(&mut self, on: bool) {
let cmd = cmd_req if self.on != on {
.cmd self.on = on;
.path self.data_ver.changed();
.leaf }
.map(num::FromPrimitive::from_u32) }
.ok_or(IMStatusCode::UnsupportedCommand)?
.ok_or(IMStatusCode::UnsupportedCommand)?; pub fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
match cmd { if let Some(writer) = encoder.with_dataver(self.data_ver.get())? {
if attr.is_system() {
CLUSTER.read(attr.attr_id, writer)
} else {
match attr.attr_id.try_into()? {
Attributes::OnOff(codec) => codec.encode(writer, self.on),
}
}
} else {
Ok(())
}
}
pub fn write(&mut self, attr: &AttrDetails, data: AttrData) -> Result<(), Error> {
let data = data.with_dataver(self.data_ver.get())?;
match attr.attr_id.try_into()? {
Attributes::OnOff(codec) => self.set(codec.decode(data)?),
}
self.data_ver.changed();
Ok(())
}
pub fn invoke(
&mut self,
cmd: &CmdDetails,
_data: &TLVElement,
_encoder: CmdDataEncoder,
) -> Result<(), Error> {
match cmd.cmd_id.try_into()? {
Commands::Off => { Commands::Off => {
cmd_enter!("Off"); cmd_enter!("Off");
let value = self self.set(false);
.base
.read_attribute_raw(Attributes::OnOff as u16)
.unwrap();
if AttrValue::Bool(true) == *value {
self.base
.write_attribute_raw(Attributes::OnOff as u16, AttrValue::Bool(false))
.map_err(|_| IMStatusCode::Failure)?;
}
cmd_req.trans.complete();
Err(IMStatusCode::Success)
} }
Commands::On => { Commands::On => {
cmd_enter!("On"); cmd_enter!("On");
let value = self self.set(true);
.base
.read_attribute_raw(Attributes::OnOff as u16)
.unwrap();
if AttrValue::Bool(false) == *value {
self.base
.write_attribute_raw(Attributes::OnOff as u16, AttrValue::Bool(true))
.map_err(|_| IMStatusCode::Failure)?;
}
cmd_req.trans.complete();
Err(IMStatusCode::Success)
} }
Commands::Toggle => { Commands::Toggle => {
cmd_enter!("Toggle"); cmd_enter!("Toggle");
let value = match self self.set(!self.on);
.base
.read_attribute_raw(Attributes::OnOff as u16)
.unwrap()
{
&AttrValue::Bool(v) => v,
_ => false,
};
self.base
.write_attribute_raw(Attributes::OnOff as u16, AttrValue::Bool(!value))
.map_err(|_| IMStatusCode::Failure)?;
cmd_req.trans.complete();
Err(IMStatusCode::Success)
} }
} }
self.data_ver.changed();
Ok(())
}
}
impl Handler for OnOffCluster {
fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
OnOffCluster::read(self, attr, encoder)
}
fn write(&mut self, attr: &AttrDetails, data: AttrData) -> Result<(), Error> {
OnOffCluster::write(self, attr, data)
}
fn invoke(
&mut self,
_transaction: &mut Transaction,
cmd: &CmdDetails,
data: &TLVElement,
encoder: CmdDataEncoder,
) -> Result<(), Error> {
OnOffCluster::invoke(self, cmd, data, encoder)
}
}
// TODO: Might be removed once the `on` member is externalized
impl NonBlockingHandler for OnOffCluster {}
impl ChangeNotifier<()> for OnOffCluster {
fn consume_change(&mut self) -> Option<()> {
self.data_ver.consume_change(())
} }
} }

View file

@ -16,29 +16,59 @@
*/ */
use crate::{ use crate::{
data_model::objects::{Cluster, ClusterType}, data_model::objects::{Cluster, Handler},
error::Error, error::Error,
utils::rand::Rand,
};
use super::objects::{
AttrDataEncoder, AttrDetails, ChangeNotifier, Dataver, NonBlockingHandler, ATTRIBUTE_LIST,
FEATURE_MAP,
}; };
const CLUSTER_NETWORK_COMMISSIONING_ID: u32 = 0x0031; const CLUSTER_NETWORK_COMMISSIONING_ID: u32 = 0x0031;
pub struct TemplateCluster { pub const CLUSTER: Cluster<'static> = Cluster {
base: Cluster, id: CLUSTER_NETWORK_COMMISSIONING_ID as _,
} feature_map: 0,
attributes: &[FEATURE_MAP, ATTRIBUTE_LIST],
commands: &[],
};
impl ClusterType for TemplateCluster { pub struct TemplateCluster {
fn base(&self) -> &Cluster { data_ver: Dataver,
&self.base
}
fn base_mut(&mut self) -> &mut Cluster {
&mut self.base
}
} }
impl TemplateCluster { impl TemplateCluster {
pub fn new() -> Result<Box<Self>, Error> { pub fn new(rand: Rand) -> Self {
Ok(Box::new(Self { Self {
base: Cluster::new(CLUSTER_NETWORK_COMMISSIONING_ID)?, data_ver: Dataver::new(rand),
})) }
}
pub fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
if let Some(writer) = encoder.with_dataver(self.data_ver.get())? {
if attr.is_system() {
CLUSTER.read(attr.attr_id, writer)
} else {
Err(Error::AttributeNotFound)
}
} else {
Ok(())
}
}
}
impl Handler for TemplateCluster {
fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
TemplateCluster::read(self, attr, encoder)
}
}
impl NonBlockingHandler for TemplateCluster {}
impl ChangeNotifier<()> for TemplateCluster {
fn consume_change(&mut self) -> Option<()> {
self.data_ver.consume_change(())
} }
} }

View file

@ -0,0 +1,199 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use core::cell::RefCell;
use super::objects::*;
use crate::{
acl::{Accessor, AclMgr},
error::*,
interaction_model::core::{Interaction, Transaction},
tlv::TLVWriter,
transport::packet::Packet,
};
pub struct DataModel<'a, T> {
pub acl_mgr: &'a RefCell<AclMgr>,
pub node: &'a Node<'a>,
pub handler: T,
}
impl<'a, T> DataModel<'a, T> {
pub const fn new(acl_mgr: &'a RefCell<AclMgr>, node: &'a Node<'a>, handler: T) -> Self {
Self {
acl_mgr,
node,
handler,
}
}
pub fn handle(
&mut self,
interaction: &Interaction,
tx: &mut Packet,
transaction: &mut Transaction,
) -> Result<bool, Error>
where
T: Handler,
{
let accessor = Accessor::for_session(transaction.session(), self.acl_mgr);
let mut tw = TLVWriter::new(tx.get_writebuf()?);
match interaction {
Interaction::Read(req) => {
for item in self.node.read(req, &accessor) {
AttrDataEncoder::handle_read(item, &self.handler, &mut tw)?;
}
}
Interaction::Write(req) => {
for item in self.node.write(req, &accessor) {
AttrDataEncoder::handle_write(item, &mut self.handler, &mut tw)?;
}
}
Interaction::Invoke(req) => {
for item in self.node.invoke(req, &accessor) {
CmdDataEncoder::handle(item, &mut self.handler, transaction, &mut tw)?;
}
}
Interaction::Timed(_) => (),
}
interaction.complete_tx(tx, transaction)
}
#[cfg(feature = "nightly")]
pub async fn handle_async<'p>(
&mut self,
interaction: &Interaction<'_>,
tx: &'p mut Packet<'_>,
transaction: &mut Transaction<'_, '_>,
) -> Result<Option<&'p [u8]>, Error>
where
T: super::objects::asynch::AsyncHandler,
{
let accessor = Accessor::for_session(transaction.session(), self.acl_mgr);
let mut tw = TLVWriter::new(tx.get_writebuf()?);
match interaction {
Interaction::Read(req) => {
for item in self.node.read(req, &accessor) {
AttrDataEncoder::handle_read_async(item, &self.handler, &mut tw).await?;
}
}
Interaction::Write(req) => {
for item in self.node.write(req, &accessor) {
AttrDataEncoder::handle_write_async(item, &mut self.handler, &mut tw).await?;
}
}
Interaction::Invoke(req) => {
for item in self.node.invoke(req, &accessor) {
CmdDataEncoder::handle_async(item, &mut self.handler, transaction, &mut tw)
.await?;
}
}
Interaction::Timed(_) => (),
}
interaction.complete_tx(tx, transaction)
}
}
pub trait DataHandler {
fn handle(
&mut self,
interaction: &Interaction,
tx: &mut Packet,
transaction: &mut Transaction,
) -> Result<bool, Error>;
}
impl<T> DataHandler for &mut T
where
T: DataHandler,
{
fn handle(
&mut self,
interaction: &Interaction,
tx: &mut Packet,
transaction: &mut Transaction,
) -> Result<bool, Error> {
(**self).handle(interaction, tx, transaction)
}
}
impl<'a, T> DataHandler for DataModel<'a, T>
where
T: Handler,
{
fn handle(
&mut self,
interaction: &Interaction,
tx: &mut Packet,
transaction: &mut Transaction,
) -> Result<bool, Error> {
DataModel::handle(self, interaction, tx, transaction)
}
}
#[cfg(feature = "nightly")]
pub mod asynch {
use crate::{
data_model::objects::asynch::AsyncHandler,
error::Error,
interaction_model::core::{Interaction, Transaction},
transport::packet::Packet,
};
use super::DataModel;
pub trait AsyncDataHandler {
async fn handle<'p>(
&mut self,
interaction: &Interaction,
tx: &'p mut Packet,
transaction: &mut Transaction,
) -> Result<Option<&'p [u8]>, Error>;
}
impl<T> AsyncDataHandler for &mut T
where
T: AsyncDataHandler,
{
async fn handle<'p>(
&mut self,
interaction: &Interaction<'_>,
tx: &'p mut Packet<'_>,
transaction: &mut Transaction<'_, '_>,
) -> Result<Option<&'p [u8]>, Error> {
(**self).handle(interaction, tx, transaction).await
}
}
impl<'a, T> AsyncDataHandler for DataModel<'a, T>
where
T: AsyncHandler,
{
async fn handle<'p>(
&mut self,
interaction: &Interaction<'_>,
tx: &'p mut Packet<'_>,
transaction: &mut Transaction<'_, '_>,
) -> Result<Option<&'p [u8]>, Error> {
DataModel::handle_async(self, interaction, tx, transaction).await
}
}
}

View file

@ -1,394 +0,0 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use self::subscribe::SubsCtx;
use super::{
cluster_basic_information::BasicInfoConfig,
device_types::device_type_add_root_node,
objects::{self, *},
sdm::dev_att::DevAttDataFetcher,
system_model::descriptor::DescriptorCluster,
};
use crate::{
acl::{AccessReq, Accessor, AccessorSubjects, AclMgr, AuthMode},
error::*,
fabric::FabricMgr,
interaction_model::{
command::CommandReq,
core::{IMStatusCode, OpCode},
messages::{
ib::{self, AttrData, DataVersionFilter},
msg::{self, InvReq, ReadReq, WriteReq},
GenericPath,
},
InteractionConsumer, Transaction,
},
secure_channel::pake::PaseMgr,
tlv::{self, FromTLV, TLVArray, TLVWriter, TagType, ToTLV},
transport::{
proto_demux::ResponseRequired,
session::{Session, SessionMode},
},
};
use log::{error, info};
use std::sync::{Arc, RwLock};
#[derive(Clone)]
pub struct DataModel {
pub node: Arc<RwLock<Box<Node>>>,
acl_mgr: Arc<AclMgr>,
}
impl DataModel {
pub fn new(
dev_details: BasicInfoConfig,
dev_att: Box<dyn DevAttDataFetcher>,
fabric_mgr: Arc<FabricMgr>,
acl_mgr: Arc<AclMgr>,
pase_mgr: PaseMgr,
) -> Result<Self, Error> {
let dm = DataModel {
node: Arc::new(RwLock::new(Node::new()?)),
acl_mgr: acl_mgr.clone(),
};
{
let mut node = dm.node.write()?;
node.set_changes_cb(Box::new(dm.clone()));
device_type_add_root_node(
&mut node,
dev_details,
dev_att,
fabric_mgr,
acl_mgr,
pase_mgr,
)?;
}
Ok(dm)
}
// Encode a write attribute from a path that may or may not be wildcard
fn handle_write_attr_path(
node: &mut Node,
accessor: &Accessor,
attr_data: &AttrData,
tw: &mut TLVWriter,
) {
let gen_path = attr_data.path.to_gp();
let mut encoder = AttrWriteEncoder::new(tw, TagType::Anonymous);
encoder.set_path(gen_path);
// The unsupported pieces of the wildcard path
if attr_data.path.cluster.is_none() {
encoder.encode_status(IMStatusCode::UnsupportedCluster, 0);
return;
}
if attr_data.path.attr.is_none() {
encoder.encode_status(IMStatusCode::UnsupportedAttribute, 0);
return;
}
// Get the data
let write_data = match &attr_data.data {
EncodeValue::Closure(_) | EncodeValue::Value(_) => {
error!("Not supported");
return;
}
EncodeValue::Tlv(t) => t,
};
if gen_path.is_wildcard() {
// This is a wildcard path, skip error
// This is required because there could be access control errors too that need
// to be taken care of.
encoder.skip_error();
}
let mut attr = AttrDetails {
// will be udpated in the loop below
attr_id: 0,
list_index: attr_data.path.list_index,
fab_filter: false,
fab_idx: accessor.fab_idx,
};
let result = node.for_each_cluster_mut(&gen_path, |path, c| {
if attr_data.data_ver.is_some() && Some(c.base().get_dataver()) != attr_data.data_ver {
encoder.encode_status(IMStatusCode::DataVersionMismatch, 0);
return Ok(());
}
attr.attr_id = path.leaf.unwrap_or_default() as u16;
encoder.set_path(*path);
let mut access_req = AccessReq::new(accessor, path, Access::WRITE);
let r = match Cluster::write_attribute(c, &mut access_req, write_data, &attr) {
Ok(_) => IMStatusCode::Success,
Err(e) => e,
};
encoder.encode_status(r, 0);
Ok(())
});
if let Err(e) = result {
// We hit this only if this is a non-wildcard path and some parts of the path are missing
encoder.encode_status(e, 0);
}
}
// Handle command from a path that may or may not be wildcard
fn handle_command_path(node: &mut Node, cmd_req: &mut CommandReq) {
let wildcard = cmd_req.cmd.path.is_wildcard();
let path = cmd_req.cmd.path;
let result = node.for_each_cluster_mut(&path, |path, c| {
cmd_req.cmd.path = *path;
let result = c.handle_command(cmd_req);
if let Err(e) = result {
// It is likely that we might have to do an 'Access' aware traversal
// if there are other conditions in the wildcard scenario that shouldn't be
// encoded as CmdStatus
if !(wildcard && e == IMStatusCode::UnsupportedCommand) {
let invoke_resp = ib::InvResp::status_new(cmd_req.cmd, e, 0);
let _ = invoke_resp.to_tlv(cmd_req.resp, TagType::Anonymous);
}
}
Ok(())
});
if !wildcard {
if let Err(e) = result {
// We hit this only if this is a non-wildcard path
let invoke_resp = ib::InvResp::status_new(cmd_req.cmd, e, 0);
let _ = invoke_resp.to_tlv(cmd_req.resp, TagType::Anonymous);
}
}
}
fn sess_to_accessor(&self, sess: &Session) -> Accessor {
match sess.get_session_mode() {
SessionMode::Case(c) => {
let mut subject =
AccessorSubjects::new(sess.get_peer_node_id().unwrap_or_default());
for i in c.cat_ids {
if i != 0 {
let _ = subject.add_catid(i);
}
}
Accessor::new(c.fab_idx, subject, AuthMode::Case, self.acl_mgr.clone())
}
SessionMode::Pase => Accessor::new(
0,
AccessorSubjects::new(1),
AuthMode::Pase,
self.acl_mgr.clone(),
),
SessionMode::PlainText => Accessor::new(
0,
AccessorSubjects::new(1),
AuthMode::Invalid,
self.acl_mgr.clone(),
),
}
}
/// Returns true if the path matches the cluster path and the data version is a match
fn data_filter_matches(
filters: &Option<&TLVArray<DataVersionFilter>>,
path: &GenericPath,
data_ver: u32,
) -> bool {
if let Some(filters) = *filters {
for filter in filters.iter() {
// TODO: No handling of 'node' comparision yet
if Some(filter.path.endpoint) == path.endpoint
&& Some(filter.path.cluster) == path.cluster
&& filter.data_ver == data_ver
{
return true;
}
}
}
false
}
}
pub mod read;
pub mod subscribe;
/// Type of Resume Request
enum ResumeReq {
Subscribe(subscribe::SubsCtx),
Read(read::ResumeReadReq),
}
impl objects::ChangeConsumer for DataModel {
fn endpoint_added(&self, id: EndptId, endpoint: &mut Endpoint) -> Result<(), Error> {
endpoint.add_cluster(DescriptorCluster::new(id, self.clone())?)?;
Ok(())
}
}
impl InteractionConsumer for DataModel {
fn consume_write_attr(
&self,
write_req: &WriteReq,
trans: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(), Error> {
let accessor = self.sess_to_accessor(trans.session);
tw.start_array(TagType::Context(msg::WriteRespTag::WriteResponses as u8))?;
let mut node = self.node.write().unwrap();
for attr_data in write_req.write_requests.iter() {
DataModel::handle_write_attr_path(&mut node, &accessor, &attr_data, tw);
}
tw.end_container()?;
Ok(())
}
fn consume_read_attr(
&self,
rx_buf: &[u8],
trans: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(), Error> {
let mut resume_from = None;
let root = tlv::get_root_node(rx_buf)?;
let req = ReadReq::from_tlv(&root)?;
self.handle_read_req(&req, trans, tw, &mut resume_from)?;
if resume_from.is_some() {
// This is a multi-hop read transaction, remember this read request
let resume = read::ResumeReadReq::new(rx_buf, &resume_from)?;
if !trans.exch.is_data_none() {
error!("Exchange data already set, and multi-hop read");
return Err(Error::InvalidState);
}
trans.exch.set_data_boxed(Box::new(ResumeReq::Read(resume)));
}
Ok(())
}
fn consume_invoke_cmd(
&self,
inv_req_msg: &InvReq,
trans: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(), Error> {
let mut node = self.node.write().unwrap();
if let Some(inv_requests) = &inv_req_msg.inv_requests {
// Array of InvokeResponse IBs
tw.start_array(TagType::Context(msg::InvRespTag::InvokeResponses as u8))?;
for i in inv_requests.iter() {
let data = if let Some(data) = i.data.unwrap_tlv() {
data
} else {
continue;
};
info!("Invoke Commmand Handler executing: {:?}", i.path);
let mut cmd_req = CommandReq {
cmd: i.path,
data,
trans,
resp: tw,
};
DataModel::handle_command_path(&mut node, &mut cmd_req);
}
tw.end_container()?;
}
Ok(())
}
fn consume_status_report(
&self,
req: &msg::StatusResp,
trans: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(OpCode, ResponseRequired), Error> {
if let Some(mut resume) = trans.exch.take_data_boxed::<ResumeReq>() {
let result = match *resume {
ResumeReq::Read(ref mut read) => self.handle_resume_read(read, trans, tw)?,
ResumeReq::Subscribe(ref mut ctx) => ctx.handle_status_report(trans, tw, self)?,
};
trans.exch.set_data_boxed(resume);
Ok(result)
} else {
// Nothing to do for now
trans.complete();
info!("Received status report with status {:?}", req.status);
Ok((OpCode::Reserved, ResponseRequired::No))
}
}
fn consume_subscribe(
&self,
rx_buf: &[u8],
trans: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(OpCode, ResponseRequired), Error> {
if !trans.exch.is_data_none() {
error!("Exchange data already set!");
return Err(Error::InvalidState);
}
let ctx = SubsCtx::new(rx_buf, trans, tw, self)?;
trans
.exch
.set_data_boxed(Box::new(ResumeReq::Subscribe(ctx)));
Ok((OpCode::ReportData, ResponseRequired::Yes))
}
}
/// Encoder for generating a response to a write request
pub struct AttrWriteEncoder<'a, 'b, 'c> {
tw: &'a mut TLVWriter<'b, 'c>,
tag: TagType,
path: GenericPath,
skip_error: bool,
}
impl<'a, 'b, 'c> AttrWriteEncoder<'a, 'b, 'c> {
pub fn new(tw: &'a mut TLVWriter<'b, 'c>, tag: TagType) -> Self {
Self {
tw,
tag,
path: Default::default(),
skip_error: false,
}
}
pub fn skip_error(&mut self) {
self.skip_error = true;
}
pub fn set_path(&mut self, path: GenericPath) {
self.path = path;
}
}
impl<'a, 'b, 'c> Encoder for AttrWriteEncoder<'a, 'b, 'c> {
fn encode(&mut self, _value: EncodeValue) {
// Only status encodes for AttrWriteResponse
}
fn encode_status(&mut self, status: IMStatusCode, cluster_status: u16) {
if self.skip_error && status != IMStatusCode::Success {
// Don't encode errors
return;
}
let resp = ib::AttrStatus::new(&self.path, status, cluster_status);
let _ = resp.to_tlv(self.tw, self.tag);
}
}

View file

@ -1,319 +0,0 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::{
acl::{AccessReq, Accessor},
data_model::{core::DataModel, objects::*},
error::*,
interaction_model::{
core::{IMStatusCode, OpCode},
messages::{
ib::{self, DataVersionFilter},
msg::{self, ReadReq, ReportDataTag::MoreChunkedMsgs, ReportDataTag::SupressResponse},
GenericPath,
},
Transaction,
},
tlv::{self, FromTLV, TLVArray, TLVWriter, TagType, ToTLV},
transport::{packet::Packet, proto_demux::ResponseRequired},
utils::writebuf::WriteBuf,
wb_shrink, wb_unshrink,
};
use log::error;
/// Encoder for generating a response to a read request
pub struct AttrReadEncoder<'a, 'b, 'c> {
tw: &'a mut TLVWriter<'b, 'c>,
data_ver: u32,
path: GenericPath,
skip_error: bool,
data_ver_filters: Option<&'a TLVArray<'a, DataVersionFilter>>,
is_buffer_full: bool,
}
impl<'a, 'b, 'c> AttrReadEncoder<'a, 'b, 'c> {
pub fn new(tw: &'a mut TLVWriter<'b, 'c>) -> Self {
Self {
tw,
data_ver: 0,
skip_error: false,
path: Default::default(),
data_ver_filters: None,
is_buffer_full: false,
}
}
pub fn skip_error(&mut self, skip: bool) {
self.skip_error = skip;
}
pub fn set_data_ver(&mut self, data_ver: u32) {
self.data_ver = data_ver;
}
pub fn set_data_ver_filters(&mut self, filters: &'a TLVArray<'a, DataVersionFilter>) {
self.data_ver_filters = Some(filters);
}
pub fn set_path(&mut self, path: GenericPath) {
self.path = path;
}
pub fn is_buffer_full(&self) -> bool {
self.is_buffer_full
}
}
impl<'a, 'b, 'c> Encoder for AttrReadEncoder<'a, 'b, 'c> {
fn encode(&mut self, value: EncodeValue) {
let resp = ib::AttrResp::Data(ib::AttrData::new(
Some(self.data_ver),
ib::AttrPath::new(&self.path),
value,
));
let anchor = self.tw.get_tail();
if resp.to_tlv(self.tw, TagType::Anonymous).is_err() {
self.is_buffer_full = true;
self.tw.rewind_to(anchor);
}
}
fn encode_status(&mut self, status: IMStatusCode, cluster_status: u16) {
if !self.skip_error {
let resp =
ib::AttrResp::Status(ib::AttrStatus::new(&self.path, status, cluster_status));
let _ = resp.to_tlv(self.tw, TagType::Anonymous);
}
}
}
/// State to maintain when a Read Request needs to be resumed
/// resumed - the next chunk of the read needs to be returned
#[derive(Default)]
pub struct ResumeReadReq {
/// The Read Request Attribute Path that caused chunking, and this is the path
/// that needs to be resumed.
pub pending_req: Option<Packet<'static>>,
/// The Attribute that couldn't be encoded because our buffer got full. The next chunk
/// will start encoding from this attribute onwards.
/// Note that given wildcard reads, one PendingPath in the member above can generated
/// multiple encode paths. Hence this has to be maintained separately.
pub resume_from: Option<GenericPath>,
}
impl ResumeReadReq {
pub fn new(rx_buf: &[u8], resume_from: &Option<GenericPath>) -> Result<Self, Error> {
let mut packet = Packet::new_rx()?;
let dst = packet.as_borrow_slice();
let src_len = rx_buf.len();
dst[..src_len].copy_from_slice(rx_buf);
packet.get_parsebuf()?.set_len(src_len);
Ok(ResumeReadReq {
pending_req: Some(packet),
resume_from: *resume_from,
})
}
}
impl DataModel {
pub fn read_attribute_raw(
&self,
endpoint: EndptId,
cluster: ClusterId,
attr: AttrId,
) -> Result<AttrValue, IMStatusCode> {
let node = self.node.read().unwrap();
let cluster = node.get_cluster(endpoint, cluster)?;
cluster.base().read_attribute_raw(attr).map(|a| a.clone())
}
/// Encode a read attribute from a path that may or may not be wildcard
///
/// If the buffer gets full while generating the read response, we will return
/// an Err(path), where the path is the path that we should resume from, for the next chunk.
/// This facilitates chunk management
fn handle_read_attr_path(
node: &Node,
accessor: &Accessor,
attr_encoder: &mut AttrReadEncoder,
attr_details: &mut AttrDetails,
resume_from: &mut Option<GenericPath>,
) -> Result<(), Error> {
let mut status = Ok(());
let path = attr_encoder.path;
// Skip error reporting for wildcard paths, don't for concrete paths
attr_encoder.skip_error(path.is_wildcard());
let result = node.for_each_attribute(&path, |path, c| {
// Ignore processing if data filter matches.
// For a wildcard attribute, this may end happening unnecessarily for all attributes, although
// a single skip for the cluster is sufficient. That requires us to replace this for_each with a
// for_each_cluster
let cluster_data_ver = c.base().get_dataver();
if Self::data_filter_matches(&attr_encoder.data_ver_filters, path, cluster_data_ver) {
return Ok(());
}
// The resume_from indicates that this is the next chunk of a previous Read Request. In such cases, we
// need to skip until we hit this path.
if let Some(r) = resume_from {
// If resume_from is valid, and we haven't hit the resume_from yet, skip encoding
if r != path {
return Ok(());
} else {
// Else, wipe out the resume_from so subsequent paths can be encoded
*resume_from = None;
}
}
attr_details.attr_id = path.leaf.unwrap_or_default() as u16;
// Overwrite the previous path with the concrete path
attr_encoder.set_path(*path);
// Set the cluster's data version
attr_encoder.set_data_ver(cluster_data_ver);
let mut access_req = AccessReq::new(accessor, path, Access::READ);
Cluster::read_attribute(c, &mut access_req, attr_encoder, attr_details);
if attr_encoder.is_buffer_full() {
// Buffer is full, next time resume from this attribute
*resume_from = Some(*path);
status = Err(Error::NoSpace);
}
Ok(())
});
if let Err(e) = result {
// We hit this only if this is a non-wildcard path
attr_encoder.encode_status(e, 0);
}
status
}
/// Process an array of Attribute Read Requests
///
/// When the API returns the chunked read is on, if *resume_from is Some(x) otherwise
/// the read is complete
pub(super) fn handle_read_attr_array(
&self,
read_req: &ReadReq,
trans: &mut Transaction,
old_tw: &mut TLVWriter,
resume_from: &mut Option<GenericPath>,
) -> Result<(), Error> {
let old_wb = old_tw.get_buf();
// Note, this function may be called from multiple places: a) an actual read
// request, a b) resumed read request, c) subscribe request or d) resumed subscribe
// request. Hopefully 18 is sufficient to address all those scenarios.
//
// This is the amount of space we reserve for other things to be attached towards
// the end
const RESERVE_SIZE: usize = 24;
let mut new_wb = wb_shrink!(old_wb, RESERVE_SIZE);
let mut tw = TLVWriter::new(&mut new_wb);
let mut attr_encoder = AttrReadEncoder::new(&mut tw);
if let Some(filters) = &read_req.dataver_filters {
attr_encoder.set_data_ver_filters(filters);
}
if let Some(attr_requests) = &read_req.attr_requests {
let accessor = self.sess_to_accessor(trans.session);
let mut attr_details = AttrDetails::new(accessor.fab_idx, read_req.fabric_filtered);
let node = self.node.read().unwrap();
attr_encoder
.tw
.start_array(TagType::Context(msg::ReportDataTag::AttributeReports as u8))?;
let mut result = Ok(());
for attr_path in attr_requests.iter() {
attr_encoder.set_path(attr_path.to_gp());
// Extract the attr_path fields into various structures
attr_details.list_index = attr_path.list_index;
result = DataModel::handle_read_attr_path(
&node,
&accessor,
&mut attr_encoder,
&mut attr_details,
resume_from,
);
if result.is_err() {
break;
}
}
// Now that all the read reports are captured, let's use the old_tw that is
// the full writebuf, and hopefully as all the necessary space to store this
wb_unshrink!(old_wb, new_wb);
old_tw.end_container()?; // Finish the AttrReports
if result.is_err() {
// If there was an error, indicate chunking. The resume_read_req would have been
// already populated in the loop above.
old_tw.bool(TagType::Context(MoreChunkedMsgs as u8), true)?;
} else {
// A None resume_from indicates no chunking
*resume_from = None;
}
}
Ok(())
}
/// Handle a read request
///
/// This could be called from an actual read request or a resumed read request. Subscription
/// requests do not come to this function.
/// When the API returns the chunked read is on, if *resume_from is Some(x) otherwise
/// the read is complete
pub fn handle_read_req(
&self,
read_req: &ReadReq,
trans: &mut Transaction,
tw: &mut TLVWriter,
resume_from: &mut Option<GenericPath>,
) -> Result<(OpCode, ResponseRequired), Error> {
tw.start_struct(TagType::Anonymous)?;
self.handle_read_attr_array(read_req, trans, tw, resume_from)?;
if resume_from.is_none() {
tw.bool(TagType::Context(SupressResponse as u8), true)?;
// Mark transaction complete, if not chunked
trans.complete();
}
tw.end_container()?;
Ok((OpCode::ReportData, ResponseRequired::Yes))
}
/// Handle a resumed read request
pub fn handle_resume_read(
&self,
resume_read_req: &mut ResumeReadReq,
trans: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(OpCode, ResponseRequired), Error> {
if let Some(packet) = resume_read_req.pending_req.as_mut() {
let rx_buf = packet.get_parsebuf()?.as_borrow_slice();
let root = tlv::get_root_node(rx_buf)?;
let req = ReadReq::from_tlv(&root)?;
self.handle_read_req(&req, trans, tw, &mut resume_read_req.resume_from)
} else {
// No pending req, is that even possible?
error!("This shouldn't have happened");
Ok((OpCode::Reserved, ResponseRequired::No))
}
}
}

View file

@ -1,142 +0,0 @@
/*
*
* Copyright (c) 2023 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use std::sync::atomic::{AtomicU32, Ordering};
use crate::{
error::Error,
interaction_model::{
core::OpCode,
messages::{
msg::{self, SubscribeReq, SubscribeResp},
GenericPath,
},
},
tlv::{self, get_root_node_struct, FromTLV, TLVWriter, TagType, ToTLV},
transport::proto_demux::ResponseRequired,
};
use super::{read::ResumeReadReq, DataModel, Transaction};
static SUBS_ID: AtomicU32 = AtomicU32::new(1);
#[derive(PartialEq)]
enum SubsState {
Confirming,
Confirmed,
}
pub struct SubsCtx {
state: SubsState,
id: u32,
resume_read_req: Option<ResumeReadReq>,
}
impl SubsCtx {
pub fn new(
rx_buf: &[u8],
trans: &mut Transaction,
tw: &mut TLVWriter,
dm: &DataModel,
) -> Result<Self, Error> {
let root = get_root_node_struct(rx_buf)?;
let req = SubscribeReq::from_tlv(&root)?;
let mut ctx = SubsCtx {
state: SubsState::Confirming,
// TODO
id: SUBS_ID.fetch_add(1, Ordering::SeqCst),
resume_read_req: None,
};
let mut resume_from = None;
ctx.do_read(&req, trans, tw, dm, &mut resume_from)?;
if resume_from.is_some() {
// This is a multi-hop read transaction, remember this read request
ctx.resume_read_req = Some(ResumeReadReq::new(rx_buf, &resume_from)?);
}
Ok(ctx)
}
pub fn handle_status_report(
&mut self,
trans: &mut Transaction,
tw: &mut TLVWriter,
dm: &DataModel,
) -> Result<(OpCode, ResponseRequired), Error> {
if self.state != SubsState::Confirming {
// Not relevant for us
trans.complete();
return Err(Error::Invalid);
}
// Is there a previous resume read pending
if self.resume_read_req.is_some() {
let mut resume_read_req = self.resume_read_req.take().unwrap();
if let Some(packet) = resume_read_req.pending_req.as_mut() {
let rx_buf = packet.get_parsebuf()?.as_borrow_slice();
let root = tlv::get_root_node(rx_buf)?;
let req = SubscribeReq::from_tlv(&root)?;
self.do_read(&req, trans, tw, dm, &mut resume_read_req.resume_from)?;
if resume_read_req.resume_from.is_some() {
// More chunks are pending, setup resume_read_req again
self.resume_read_req = Some(resume_read_req);
}
return Ok((OpCode::ReportData, ResponseRequired::Yes));
}
}
// We are here implies that the read is now complete
self.confirm_subscription(trans, tw)
}
fn confirm_subscription(
&mut self,
trans: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(OpCode, ResponseRequired), Error> {
self.state = SubsState::Confirmed;
// TODO
let resp = SubscribeResp::new(self.id, 40);
resp.to_tlv(tw, TagType::Anonymous)?;
trans.complete();
Ok((OpCode::SubscriptResponse, ResponseRequired::Yes))
}
fn do_read(
&mut self,
req: &SubscribeReq,
trans: &mut Transaction,
tw: &mut TLVWriter,
dm: &DataModel,
resume_from: &mut Option<GenericPath>,
) -> Result<(), Error> {
let read_req = req.to_read_req();
tw.start_struct(TagType::Anonymous)?;
tw.u32(
TagType::Context(msg::ReportDataTag::SubscriptionId as u8),
self.id,
)?;
dm.handle_read_attr_array(&read_req, trans, tw, resume_from)?;
tw.end_container()?;
Ok(())
}
}

View file

@ -15,60 +15,14 @@
* limitations under the License. * limitations under the License.
*/ */
use super::cluster_basic_information::BasicInfoCluster; use super::objects::DeviceType;
use super::cluster_basic_information::BasicInfoConfig;
use super::cluster_on_off::OnOffCluster;
use super::objects::*;
use super::sdm::admin_commissioning::AdminCommCluster;
use super::sdm::dev_att::DevAttDataFetcher;
use super::sdm::general_commissioning::GenCommCluster;
use super::sdm::noc::NocCluster;
use super::sdm::nw_commissioning::NwCommCluster;
use super::system_model::access_control::AccessControlCluster;
use crate::acl::AclMgr;
use crate::error::*;
use crate::fabric::FabricMgr;
use crate::secure_channel::pake::PaseMgr;
use std::sync::Arc;
use std::sync::RwLockWriteGuard;
pub const DEV_TYPE_ROOT_NODE: DeviceType = DeviceType { pub const DEV_TYPE_ROOT_NODE: DeviceType = DeviceType {
dtype: 0x0016, dtype: 0x0016,
drev: 1, drev: 1,
}; };
type WriteNode<'a> = RwLockWriteGuard<'a, Box<Node>>; pub const DEV_TYPE_ON_OFF_LIGHT: DeviceType = DeviceType {
pub fn device_type_add_root_node(
node: &mut WriteNode,
dev_info: BasicInfoConfig,
dev_att: Box<dyn DevAttDataFetcher>,
fabric_mgr: Arc<FabricMgr>,
acl_mgr: Arc<AclMgr>,
pase_mgr: PaseMgr,
) -> Result<EndptId, Error> {
// Add the root endpoint
let endpoint = node.add_endpoint(DEV_TYPE_ROOT_NODE)?;
if endpoint != 0 {
// Somehow endpoint 0 was already added, this shouldn't be the case
return Err(Error::Invalid);
};
// Add the mandatory clusters
node.add_cluster(0, BasicInfoCluster::new(dev_info)?)?;
let general_commissioning = GenCommCluster::new()?;
let failsafe = general_commissioning.failsafe();
node.add_cluster(0, general_commissioning)?;
node.add_cluster(0, NwCommCluster::new()?)?;
node.add_cluster(0, AdminCommCluster::new(pase_mgr)?)?;
node.add_cluster(
0,
NocCluster::new(dev_att, fabric_mgr, acl_mgr.clone(), failsafe)?,
)?;
node.add_cluster(0, AccessControlCluster::new(acl_mgr)?)?;
Ok(endpoint)
}
const DEV_TYPE_ON_OFF_LIGHT: DeviceType = DeviceType {
dtype: 0x0100, dtype: 0x0100,
drev: 2, drev: 2,
}; };
@ -77,9 +31,3 @@ pub const DEV_TYPE_ON_SMART_SPEAKER: DeviceType = DeviceType {
dtype: 0x0022, dtype: 0x0022,
drev: 2, drev: 2,
}; };
pub fn device_type_add_on_off_light(node: &mut WriteNode) -> Result<EndptId, Error> {
let endpoint = node.add_endpoint(DEV_TYPE_ON_OFF_LIGHT)?;
node.add_cluster(endpoint, OnOffCluster::new()?)?;
Ok(endpoint)
}

View file

@ -20,8 +20,9 @@ pub mod device_types;
pub mod objects; pub mod objects;
pub mod cluster_basic_information; pub mod cluster_basic_information;
pub mod cluster_media_playback; // TODO pub mod cluster_media_playback;
pub mod cluster_on_off; pub mod cluster_on_off;
pub mod cluster_template; pub mod cluster_template;
pub mod root_endpoint;
pub mod sdm; pub mod sdm;
pub mod system_model; pub mod system_model;

View file

@ -15,15 +15,11 @@
* limitations under the License. * limitations under the License.
*/ */
use super::{AttrId, GlobalElements, Privilege}; use crate::data_model::objects::GlobalElements;
use crate::{
error::*, use super::{AttrId, Privilege};
// TODO: This layer shouldn't really depend on the TLV layer, should create an abstraction layer
tlv::{TLVElement, TLVWriter, TagType, ToTLV},
};
use bitflags::bitflags; use bitflags::bitflags;
use log::error; use core::fmt::{self, Debug};
use std::fmt::{self, Debug, Formatter};
bitflags! { bitflags! {
#[derive(Default)] #[derive(Default)]
@ -83,110 +79,24 @@ bitflags! {
} }
} }
/* This file needs some major revamp.
* - instead of allocating all over the heap, we should use some kind of slab/block allocator
* - instead of arrays, can use linked-lists to conserve space and avoid the internal fragmentation
*/
#[derive(PartialEq, PartialOrd, Clone)]
pub enum AttrValue {
Int64(i64),
Uint8(u8),
Uint16(u16),
Uint32(u32),
Uint64(u64),
Bool(bool),
Utf8(String),
Custom,
}
impl Debug for AttrValue {
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> {
match &self {
AttrValue::Int64(v) => write!(f, "{:?}", *v),
AttrValue::Uint8(v) => write!(f, "{:?}", *v),
AttrValue::Uint16(v) => write!(f, "{:?}", *v),
AttrValue::Uint32(v) => write!(f, "{:?}", *v),
AttrValue::Uint64(v) => write!(f, "{:?}", *v),
AttrValue::Bool(v) => write!(f, "{:?}", *v),
AttrValue::Utf8(v) => write!(f, "{:?}", *v),
AttrValue::Custom => write!(f, "custom-attribute"),
}?;
Ok(())
}
}
impl ToTLV for AttrValue {
fn to_tlv(&self, tw: &mut TLVWriter, tag_type: TagType) -> Result<(), Error> {
// What is the time complexity of such long match statements?
match self {
AttrValue::Bool(v) => tw.bool(tag_type, *v),
AttrValue::Uint8(v) => tw.u8(tag_type, *v),
AttrValue::Uint16(v) => tw.u16(tag_type, *v),
AttrValue::Uint32(v) => tw.u32(tag_type, *v),
AttrValue::Uint64(v) => tw.u64(tag_type, *v),
AttrValue::Utf8(v) => tw.utf8(tag_type, v.as_bytes()),
_ => {
error!("Attribute type not yet supported");
Err(Error::AttributeNotFound)
}
}
}
}
impl AttrValue {
pub fn update_from_tlv(&mut self, tr: &TLVElement) -> Result<(), Error> {
match self {
AttrValue::Bool(v) => *v = tr.bool()?,
AttrValue::Uint8(v) => *v = tr.u8()?,
AttrValue::Uint16(v) => *v = tr.u16()?,
AttrValue::Uint32(v) => *v = tr.u32()?,
AttrValue::Uint64(v) => *v = tr.u64()?,
_ => {
error!("Attribute type not yet supported");
return Err(Error::AttributeNotFound);
}
}
Ok(())
}
}
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct Attribute { pub struct Attribute {
pub(super) id: AttrId, pub id: AttrId,
pub(super) value: AttrValue, pub quality: Quality,
pub(super) quality: Quality, pub access: Access,
pub(super) access: Access,
}
impl Default for Attribute {
fn default() -> Attribute {
Attribute {
id: 0,
value: AttrValue::Bool(true),
quality: Default::default(),
access: Default::default(),
}
}
} }
impl Attribute { impl Attribute {
pub fn new(id: AttrId, value: AttrValue, access: Access, quality: Quality) -> Self { pub const fn new(id: AttrId, access: Access, quality: Quality) -> Self {
Attribute { Self {
id, id,
value,
access, access,
quality, quality,
} }
} }
pub fn set_value(&mut self, value: AttrValue) -> Result<(), Error> { pub fn is_system(&self) -> bool {
if !self.quality.contains(Quality::FIXED) { Self::is_system_attr(self.id)
self.value = value;
Ok(())
} else {
Err(Error::Invalid)
}
} }
pub fn is_system_attr(attr_id: AttrId) -> bool { pub fn is_system_attr(attr_id: AttrId) -> bool {
@ -194,9 +104,9 @@ impl Attribute {
} }
} }
impl std::fmt::Display for Attribute { impl core::fmt::Display for Attribute {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}: {:?}", self.id, self.value) write!(f, "{}", self.id)
} }
} }

View file

@ -15,25 +15,31 @@
* limitations under the License. * limitations under the License.
*/ */
use crate::{
acl::AccessReq,
data_model::objects::{Access, AttrValue, Attribute, EncodeValue, Quality},
error::*,
interaction_model::{command::CommandReq, core::IMStatusCode},
// TODO: This layer shouldn't really depend on the TLV layer, should create an abstraction layer
tlv::{Nullable, TLVElement, TLVWriter, TagType},
};
use log::error; use log::error;
use num_derive::FromPrimitive; use strum::FromRepr;
use rand::Rng;
use std::fmt::{self, Debug};
use super::{AttrId, ClusterId, Encoder}; use crate::{
acl::{AccessReq, Accessor},
attribute_enum,
data_model::objects::*,
error::Error,
interaction_model::{
core::IMStatusCode,
messages::{
ib::{AttrPath, AttrStatus, CmdPath, CmdStatus},
GenericPath,
},
},
// TODO: This layer shouldn't really depend on the TLV layer, should create an abstraction layer
tlv::{Nullable, TLVWriter, TagType},
};
use core::{
convert::TryInto,
fmt::{self, Debug},
};
pub const ATTRS_PER_CLUSTER: usize = 10; #[derive(Clone, Copy, Debug, Eq, PartialEq, FromRepr)]
pub const CMDS_PER_CLUSTER: usize = 8; #[repr(u16)]
#[derive(FromPrimitive, Debug)]
pub enum GlobalElements { pub enum GlobalElements {
_ClusterRevision = 0xFFFD, _ClusterRevision = 0xFFFD,
FeatureMap = 0xFFFC, FeatureMap = 0xFFFC,
@ -44,297 +50,308 @@ pub enum GlobalElements {
FabricIndex = 0xFE, FabricIndex = 0xFE,
} }
attribute_enum!(GlobalElements);
pub const FEATURE_MAP: Attribute =
Attribute::new(GlobalElements::FeatureMap as _, Access::RV, Quality::NONE);
pub const ATTRIBUTE_LIST: Attribute = Attribute::new(
GlobalElements::AttributeList as _,
Access::RV,
Quality::NONE,
);
// TODO: What if we instead of creating this, we just pass the AttrData/AttrPath to the read/write // TODO: What if we instead of creating this, we just pass the AttrData/AttrPath to the read/write
// methods? // methods?
/// The Attribute Details structure records the details about the attribute under consideration. /// The Attribute Details structure records the details about the attribute under consideration.
/// Typically this structure is progressively built as we proceed through the request processing. pub struct AttrDetails<'a> {
pub struct AttrDetails { pub node: &'a Node<'a>,
/// Fabric Filtering Activated /// The actual endpoint ID
pub fab_filter: bool, pub endpoint_id: EndptId,
/// The current Fabric Index /// The actual cluster ID
pub fab_idx: u8, pub cluster_id: ClusterId,
/// List Index, if any
pub list_index: Option<Nullable<u16>>,
/// The actual attribute ID /// The actual attribute ID
pub attr_id: AttrId, pub attr_id: AttrId,
/// List Index, if any
pub list_index: Option<Nullable<u16>>,
/// The current Fabric Index
pub fab_idx: u8,
/// Fabric Filtering Activated
pub fab_filter: bool,
pub dataver: Option<u32>,
pub wildcard: bool,
} }
impl AttrDetails { impl<'a> AttrDetails<'a> {
pub fn new(fab_idx: u8, fab_filter: bool) -> Self { pub fn is_system(&self) -> bool {
Self { Attribute::is_system_attr(self.attr_id)
fab_filter,
fab_idx,
list_index: None,
attr_id: 0,
} }
pub fn path(&self) -> AttrPath {
AttrPath {
endpoint: Some(self.endpoint_id),
cluster: Some(self.cluster_id),
attr: Some(self.attr_id),
list_index: self.list_index,
..Default::default()
}
}
pub fn status(&self, status: IMStatusCode) -> Result<Option<AttrStatus>, Error> {
if self.should_report(status) {
Ok(Some(AttrStatus::new(
&GenericPath {
endpoint: Some(self.endpoint_id),
cluster: Some(self.cluster_id),
leaf: Some(self.attr_id as _),
},
status,
0,
)))
} else {
Ok(None)
}
}
fn should_report(&self, status: IMStatusCode) -> bool {
!self.wildcard
|| !matches!(
status,
IMStatusCode::UnsupportedEndpoint
| IMStatusCode::UnsupportedCluster
| IMStatusCode::UnsupportedAttribute
| IMStatusCode::UnsupportedCommand
| IMStatusCode::UnsupportedAccess
| IMStatusCode::UnsupportedRead
| IMStatusCode::UnsupportedWrite
| IMStatusCode::DataVersionMismatch
)
} }
} }
pub trait ClusterType { pub struct CmdDetails<'a> {
// TODO: 5 methods is going to be quite expensive for vtables of all the clusters pub node: &'a Node<'a>,
fn base(&self) -> &Cluster; pub endpoint_id: EndptId,
fn base_mut(&mut self) -> &mut Cluster; pub cluster_id: ClusterId,
fn read_custom_attribute(&self, _encoder: &mut dyn Encoder, _attr: &AttrDetails) {} pub cmd_id: CmdId,
pub wildcard: bool,
fn handle_command(&mut self, cmd_req: &mut CommandReq) -> Result<(), IMStatusCode> {
let cmd = cmd_req.cmd.path.leaf.map(|a| a as u16);
println!("Received command: {:?}", cmd);
Err(IMStatusCode::UnsupportedCommand)
}
/// Write an attribute
///
/// Note that if this method is defined, you must handle the write for all the attributes. Even those
/// that are not 'custom'. This is different from how you handle the read_custom_attribute() method.
/// The reason for this being, you may want to handle an attribute write request even though it is a
/// standard attribute like u16, u32 etc.
///
/// If you wish to update the standard attribute in the data model database, you must call the
/// write_attribute_from_tlv() method from the base cluster, as is shown here in the default case
fn write_attribute(
&mut self,
attr: &AttrDetails,
data: &TLVElement,
) -> Result<(), IMStatusCode> {
self.base_mut().write_attribute_from_tlv(attr.attr_id, data)
}
} }
pub struct Cluster { impl<'a> CmdDetails<'a> {
pub(super) id: ClusterId, pub fn path(&self) -> CmdPath {
attributes: Vec<Attribute>, CmdPath::new(
data_ver: u32, Some(self.endpoint_id),
} Some(self.cluster_id),
Some(self.cmd_id),
impl Cluster { )
pub fn new(id: ClusterId) -> Result<Cluster, Error> {
let mut c = Cluster {
id,
attributes: Vec::with_capacity(ATTRS_PER_CLUSTER),
data_ver: rand::thread_rng().gen_range(0..0xFFFFFFFF),
};
c.add_default_attributes()?;
Ok(c)
} }
pub fn id(&self) -> ClusterId { pub fn success(&self, tracker: &CmdDataTracker) -> Option<CmdStatus> {
self.id if tracker.needs_status() {
self.status(IMStatusCode::Success)
} else {
None
}
} }
pub fn get_dataver(&self) -> u32 { pub fn status(&self, status: IMStatusCode) -> Option<CmdStatus> {
self.data_ver if self.should_report(status) {
} Some(CmdStatus::new(
CmdPath::new(
pub fn set_feature_map(&mut self, map: u32) -> Result<(), Error> { Some(self.endpoint_id),
self.write_attribute_raw(GlobalElements::FeatureMap as u16, AttrValue::Uint32(map)) Some(self.cluster_id),
.map_err(|_| Error::Invalid)?; Some(self.cmd_id),
Ok(()) ),
} status,
0,
fn add_default_attributes(&mut self) -> Result<(), Error> {
// Default feature map is 0
self.add_attribute(Attribute::new(
GlobalElements::FeatureMap as u16,
AttrValue::Uint32(0),
Access::RV,
Quality::NONE,
))?;
self.add_attribute(Attribute::new(
GlobalElements::AttributeList as u16,
AttrValue::Custom,
Access::RV,
Quality::NONE,
)) ))
}
pub fn add_attributes(&mut self, attrs: &[Attribute]) -> Result<(), Error> {
if self.attributes.len() + attrs.len() <= self.attributes.capacity() {
self.attributes.extend_from_slice(attrs);
Ok(())
} else { } else {
Err(Error::NoSpace) None
} }
} }
pub fn add_attribute(&mut self, attr: Attribute) -> Result<(), Error> { fn should_report(&self, status: IMStatusCode) -> bool {
if self.attributes.len() < self.attributes.capacity() { !self.wildcard
self.attributes.push(attr); || !matches!(
Ok(()) status,
} else { IMStatusCode::UnsupportedEndpoint
Err(Error::NoSpace) | IMStatusCode::UnsupportedCluster
} | IMStatusCode::UnsupportedAttribute
} | IMStatusCode::UnsupportedCommand
| IMStatusCode::UnsupportedAccess
fn get_attribute_index(&self, attr_id: AttrId) -> Option<usize> { | IMStatusCode::UnsupportedRead
self.attributes.iter().position(|c| c.id == attr_id) | IMStatusCode::UnsupportedWrite
} )
fn get_attribute(&self, attr_id: AttrId) -> Result<&Attribute, Error> {
let index = self
.get_attribute_index(attr_id)
.ok_or(Error::AttributeNotFound)?;
Ok(&self.attributes[index])
}
fn get_attribute_mut(&mut self, attr_id: AttrId) -> Result<&mut Attribute, Error> {
let index = self
.get_attribute_index(attr_id)
.ok_or(Error::AttributeNotFound)?;
Ok(&mut self.attributes[index])
}
// Returns a slice of attribute, with either a single attribute or all (wildcard)
pub fn get_wildcard_attribute(
&self,
attribute: Option<AttrId>,
) -> Result<(&[Attribute], bool), IMStatusCode> {
if let Some(a) = attribute {
if let Some(i) = self.get_attribute_index(a) {
Ok((&self.attributes[i..i + 1], false))
} else {
Err(IMStatusCode::UnsupportedAttribute)
}
} else {
Ok((&self.attributes[..], true))
}
}
pub fn read_attribute(
c: &dyn ClusterType,
access_req: &mut AccessReq,
encoder: &mut dyn Encoder,
attr: &AttrDetails,
) {
let mut error = IMStatusCode::Success;
let base = c.base();
let a = if let Ok(a) = base.get_attribute(attr.attr_id) {
a
} else {
encoder.encode_status(IMStatusCode::UnsupportedAttribute, 0);
return;
};
if !a.access.contains(Access::READ) {
error = IMStatusCode::UnsupportedRead;
}
access_req.set_target_perms(a.access);
if !access_req.allow() {
error = IMStatusCode::UnsupportedAccess;
}
if error != IMStatusCode::Success {
encoder.encode_status(error, 0);
} else if Attribute::is_system_attr(attr.attr_id) {
c.base().read_system_attribute(encoder, a)
} else if a.value != AttrValue::Custom {
encoder.encode(EncodeValue::Value(&a.value))
} else {
c.read_custom_attribute(encoder, attr)
}
}
fn encode_attribute_ids(&self, tag: TagType, tw: &mut TLVWriter) {
let _ = tw.start_array(tag);
for a in &self.attributes {
let _ = tw.u16(TagType::Anonymous, a.id);
}
let _ = tw.end_container();
}
fn read_system_attribute(&self, encoder: &mut dyn Encoder, attr: &Attribute) {
let global_attr: Option<GlobalElements> = num::FromPrimitive::from_u16(attr.id);
if let Some(global_attr) = global_attr {
match global_attr {
GlobalElements::AttributeList => {
encoder.encode(EncodeValue::Closure(&|tag, tw| {
self.encode_attribute_ids(tag, tw)
}));
return;
}
GlobalElements::FeatureMap => {
encoder.encode(EncodeValue::Value(&attr.value));
return;
}
_ => {
error!("This attribute not yet handled {:?}", global_attr);
}
}
}
encoder.encode_status(IMStatusCode::UnsupportedAttribute, 0)
}
pub fn read_attribute_raw(&self, attr_id: AttrId) -> Result<&AttrValue, IMStatusCode> {
let a = self
.get_attribute(attr_id)
.map_err(|_| IMStatusCode::UnsupportedAttribute)?;
Ok(&a.value)
}
pub fn write_attribute(
c: &mut dyn ClusterType,
access_req: &mut AccessReq,
data: &TLVElement,
attr: &AttrDetails,
) -> Result<(), IMStatusCode> {
let base = c.base_mut();
let a = if let Ok(a) = base.get_attribute_mut(attr.attr_id) {
a
} else {
return Err(IMStatusCode::UnsupportedAttribute);
};
if !a.access.contains(Access::WRITE) {
return Err(IMStatusCode::UnsupportedWrite);
}
access_req.set_target_perms(a.access);
if !access_req.allow() {
return Err(IMStatusCode::UnsupportedAccess);
}
c.write_attribute(attr, data)
}
pub fn write_attribute_from_tlv(
&mut self,
attr_id: AttrId,
data: &TLVElement,
) -> Result<(), IMStatusCode> {
let a = self.get_attribute_mut(attr_id)?;
if a.value != AttrValue::Custom {
let mut value = a.value.clone();
value
.update_from_tlv(data)
.map_err(|_| IMStatusCode::Failure)?;
a.set_value(value)
.map(|_| {
self.cluster_changed();
})
.map_err(|_| IMStatusCode::UnsupportedWrite)
} else {
Err(IMStatusCode::UnsupportedAttribute)
}
}
pub fn write_attribute_raw(&mut self, attr_id: AttrId, value: AttrValue) -> Result<(), Error> {
let a = self.get_attribute_mut(attr_id)?;
a.set_value(value).map(|_| {
self.cluster_changed();
})
}
/// This method must be called for any changes to the data model
/// Currently this only increments the data version, but we can reuse the same
/// for raising events too
pub fn cluster_changed(&mut self) {
self.data_ver = self.data_ver.wrapping_add(1);
} }
} }
impl std::fmt::Display for Cluster { #[derive(Debug, Clone)]
pub struct Cluster<'a> {
pub id: ClusterId,
pub feature_map: u32,
pub attributes: &'a [Attribute],
pub commands: &'a [CmdId],
}
impl<'a> Cluster<'a> {
pub const fn new(
id: ClusterId,
feature_map: u32,
attributes: &'a [Attribute],
commands: &'a [CmdId],
) -> Self {
Self {
id,
feature_map,
attributes,
commands,
}
}
pub(crate) fn match_attributes<'m>(
&'m self,
accessor: &'m Accessor<'m>,
ep: EndptId,
attr: Option<AttrId>,
write: bool,
) -> impl Iterator<Item = AttrId> + 'm {
self.attributes
.iter()
.filter(move |attribute| attr.map(|attr| attr == attribute.id).unwrap_or(true))
.filter(move |attribute| {
let mut access_req = AccessReq::new(
accessor,
GenericPath::new(Some(ep), Some(self.id), Some(attribute.id as _)),
if write { Access::WRITE } else { Access::READ },
);
self.check_attr_access(&mut access_req, attribute.access)
.is_ok()
})
.map(|attribute| attribute.id)
}
pub fn match_commands<'m>(
&'m self,
accessor: &'m Accessor<'m>,
ep: EndptId,
cmd: Option<CmdId>,
) -> impl Iterator<Item = CmdId> + 'm {
self.commands
.iter()
.filter(move |id| cmd.map(|cmd| **id == cmd).unwrap_or(true))
.filter(move |id| {
let mut access_req = AccessReq::new(
accessor,
GenericPath::new(Some(ep), Some(self.id), Some(**id as _)),
Access::WRITE,
);
self.check_cmd_access(&mut access_req).is_ok()
})
.copied()
}
pub(crate) fn check_attribute(
&self,
accessor: &Accessor,
ep: EndptId,
attr: AttrId,
write: bool,
) -> Result<(), IMStatusCode> {
let attribute = self
.attributes
.iter()
.find(|attribute| attribute.id == attr)
.ok_or(IMStatusCode::UnsupportedAttribute)?;
let mut access_req = AccessReq::new(
accessor,
GenericPath::new(Some(ep), Some(self.id), Some(attr as _)),
if write { Access::WRITE } else { Access::READ },
);
self.check_attr_access(&mut access_req, attribute.access)
}
pub(crate) fn check_command(
&self,
accessor: &Accessor,
ep: EndptId,
cmd: CmdId,
) -> Result<(), IMStatusCode> {
self.commands
.iter()
.find(|id| **id == cmd)
.ok_or(IMStatusCode::UnsupportedCommand)?;
let mut access_req = AccessReq::new(
accessor,
GenericPath::new(Some(ep), Some(self.id), Some(cmd as _)),
Access::WRITE,
);
self.check_cmd_access(&mut access_req)
}
fn check_attr_access(
&self,
access_req: &mut AccessReq,
target_perms: Access,
) -> Result<(), IMStatusCode> {
if !target_perms.contains(access_req.operation()) {
Err(if matches!(access_req.operation(), Access::WRITE) {
IMStatusCode::UnsupportedWrite
} else {
IMStatusCode::UnsupportedRead
})?;
}
access_req.set_target_perms(target_perms);
if access_req.allow() {
Ok(())
} else {
Err(IMStatusCode::UnsupportedAccess)
}
}
fn check_cmd_access(&self, access_req: &mut AccessReq) -> Result<(), IMStatusCode> {
access_req.set_target_perms(
Access::WRITE
.union(Access::NEED_OPERATE)
.union(Access::NEED_MANAGE)
.union(Access::NEED_ADMIN),
); // TODO
if access_req.allow() {
Ok(())
} else {
Err(IMStatusCode::UnsupportedAccess)
}
}
pub fn read(&self, attr: AttrId, mut writer: AttrDataWriter) -> Result<(), Error> {
match attr.try_into()? {
GlobalElements::AttributeList => {
self.encode_attribute_ids(AttrDataWriter::TAG, &mut writer)?;
writer.complete()
}
GlobalElements::FeatureMap => writer.set(self.feature_map),
other => {
error!("This attribute is not yet handled {:?}", other);
Err(Error::AttributeNotFound)
}
}
}
fn encode_attribute_ids(&self, tag: TagType, tw: &mut TLVWriter) -> Result<(), Error> {
tw.start_array(tag)?;
for a in self.attributes {
tw.u16(TagType::Anonymous, a.id)?;
}
tw.end_container()
}
}
impl<'a> core::fmt::Display for Cluster<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "id:{}, ", self.id)?; write!(f, "id:{}, ", self.id)?;
write!(f, "attrs[")?; write!(f, "attrs[")?;

View file

@ -0,0 +1,55 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::utils::rand::Rand;
pub struct Dataver {
ver: u32,
changed: bool,
}
impl Dataver {
pub fn new(rand: Rand) -> Self {
let mut buf = [0; 4];
rand(&mut buf);
Self {
ver: u32::from_be_bytes(buf),
changed: false,
}
}
pub fn get(&self) -> u32 {
self.ver
}
pub fn changed(&mut self) -> u32 {
(self.ver, _) = self.ver.overflowing_add(1);
self.changed = true;
self.get()
}
pub fn consume_change<T>(&mut self, change: T) -> Option<T> {
if self.changed {
self.changed = false;
Some(change)
} else {
None
}
}
}

View file

@ -15,17 +15,26 @@
* limitations under the License. * limitations under the License.
*/ */
use std::fmt::{Debug, Formatter}; use core::fmt::{Debug, Formatter};
use core::marker::PhantomData;
use core::ops::{Deref, DerefMut};
use crate::interaction_model::core::{IMStatusCode, Transaction};
use crate::interaction_model::messages::ib::{
AttrPath, AttrResp, AttrStatus, CmdDataTag, CmdPath, CmdStatus, InvResp, InvRespTag,
};
use crate::tlv::UtfStr;
use crate::{ use crate::{
error::Error, error::Error,
interaction_model::core::IMStatusCode, interaction_model::messages::ib::{AttrDataTag, AttrRespTag},
tlv::{FromTLV, TLVElement, TLVWriter, TagType, ToTLV}, tlv::{FromTLV, TLVElement, TLVWriter, TagType, ToTLV},
}; };
use log::error; use log::error;
use super::{AttrDetails, CmdDetails, Handler};
// TODO: Should this return an IMStatusCode Error? But if yes, the higher layer // TODO: Should this return an IMStatusCode Error? But if yes, the higher layer
// may have already started encoding the 'success' headers, we might not to manage // may have already started encoding the 'success' headers, we might not want to manage
// the tw.rewind() in that case, if we add this support // the tw.rewind() in that case, if we add this support
pub type EncodeValueGen<'a> = &'a dyn Fn(TagType, &mut TLVWriter); pub type EncodeValueGen<'a> = &'a dyn Fn(TagType, &mut TLVWriter);
@ -78,7 +87,7 @@ impl<'a> PartialEq for EncodeValue<'a> {
} }
impl<'a> Debug for EncodeValue<'a> { impl<'a> Debug for EncodeValue<'a> {
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> { fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), core::fmt::Error> {
match *self { match *self {
EncodeValue::Closure(_) => write!(f, "Contains closure"), EncodeValue::Closure(_) => write!(f, "Contains closure"),
EncodeValue::Tlv(t) => write!(f, "{:?}", t), EncodeValue::Tlv(t) => write!(f, "{:?}", t),
@ -107,17 +116,454 @@ impl<'a> FromTLV<'a> for EncodeValue<'a> {
} }
} }
/// An object that can encode EncodeValue into the necessary hierarchical structure pub struct AttrDataEncoder<'a, 'b, 'c> {
/// as expected by the Interaction Model dataver_filter: Option<u32>,
pub trait Encoder { path: AttrPath,
/// Encode a given value tw: &'a mut TLVWriter<'b, 'c>,
fn encode(&mut self, value: EncodeValue);
/// Encode a status report
fn encode_status(&mut self, status: IMStatusCode, cluster_status: u16);
} }
#[derive(ToTLV, Copy, Clone)] impl<'a, 'b, 'c> AttrDataEncoder<'a, 'b, 'c> {
pub struct DeviceType { pub fn handle_read<T: Handler>(
pub dtype: u16, item: Result<AttrDetails, AttrStatus>,
pub drev: u16, handler: &T,
tw: &mut TLVWriter,
) -> Result<(), Error> {
let status = match item {
Ok(attr) => {
let encoder = AttrDataEncoder::new(&attr, tw);
match handler.read(&attr, encoder) {
Ok(()) => None,
Err(error) => attr.status(error.into())?,
}
}
Err(status) => Some(status),
};
if let Some(status) = status {
AttrResp::Status(status).to_tlv(tw, TagType::Anonymous)?;
}
Ok(())
}
pub fn handle_write<T: Handler>(
item: Result<(AttrDetails, TLVElement), AttrStatus>,
handler: &mut T,
tw: &mut TLVWriter,
) -> Result<(), Error> {
let status = match item {
Ok((attr, data)) => match handler.write(&attr, AttrData::new(attr.dataver, &data)) {
Ok(()) => attr.status(IMStatusCode::Success)?,
Err(error) => attr.status(error.into())?,
},
Err(status) => Some(status),
};
if let Some(status) = status {
status.to_tlv(tw, TagType::Anonymous)?;
}
Ok(())
}
#[cfg(feature = "nightly")]
pub async fn handle_read_async<T: super::asynch::AsyncHandler>(
item: Result<AttrDetails<'_>, AttrStatus>,
handler: &T,
tw: &mut TLVWriter<'_, '_>,
) -> Result<(), Error> {
let status = match item {
Ok(attr) => {
let encoder = AttrDataEncoder::new(&attr, tw);
match handler.read(&attr, encoder).await {
Ok(()) => None,
Err(error) => attr.status(error.into())?,
}
}
Err(status) => Some(status),
};
if let Some(status) = status {
AttrResp::Status(status).to_tlv(tw, TagType::Anonymous)?;
}
Ok(())
}
#[cfg(feature = "nightly")]
pub async fn handle_write_async<T: super::asynch::AsyncHandler>(
item: Result<(AttrDetails<'_>, TLVElement<'_>), AttrStatus>,
handler: &mut T,
tw: &mut TLVWriter<'_, '_>,
) -> Result<(), Error> {
let status = match item {
Ok((attr, data)) => match handler
.write(&attr, AttrData::new(attr.dataver, &data))
.await
{
Ok(()) => attr.status(IMStatusCode::Success)?,
Err(error) => attr.status(error.into())?,
},
Err(status) => Some(status),
};
if let Some(status) = status {
AttrResp::Status(status).to_tlv(tw, TagType::Anonymous)?;
}
Ok(())
}
pub fn new(attr: &AttrDetails, tw: &'a mut TLVWriter<'b, 'c>) -> Self {
Self {
dataver_filter: attr.dataver,
path: attr.path(),
tw,
}
}
pub fn with_dataver(self, dataver: u32) -> Result<Option<AttrDataWriter<'a, 'b, 'c>>, Error> {
if self
.dataver_filter
.map(|dataver_filter| dataver_filter != dataver)
.unwrap_or(true)
{
let mut writer = AttrDataWriter::new(self.tw);
writer.start_struct(TagType::Anonymous)?;
writer.start_struct(TagType::Context(AttrRespTag::Data as _))?;
writer.u32(TagType::Context(AttrDataTag::DataVer as _), dataver)?;
self.path
.to_tlv(&mut writer, TagType::Context(AttrDataTag::Path as _))?;
Ok(Some(writer))
} else {
Ok(None)
}
}
}
pub struct AttrDataWriter<'a, 'b, 'c> {
tw: &'a mut TLVWriter<'b, 'c>,
anchor: usize,
completed: bool,
}
impl<'a, 'b, 'c> AttrDataWriter<'a, 'b, 'c> {
pub const TAG: TagType = TagType::Context(AttrDataTag::Data as _);
fn new(tw: &'a mut TLVWriter<'b, 'c>) -> Self {
let anchor = tw.get_tail();
Self {
tw,
anchor,
completed: false,
}
}
pub fn set<T: ToTLV>(self, value: T) -> Result<(), Error> {
value.to_tlv(self.tw, Self::TAG)?;
self.complete()
}
pub fn complete(mut self) -> Result<(), Error> {
self.tw.end_container()?;
self.tw.end_container()?;
self.completed = true;
Ok(())
}
fn reset(&mut self) {
self.tw.rewind_to(self.anchor);
}
}
impl<'a, 'b, 'c> Drop for AttrDataWriter<'a, 'b, 'c> {
fn drop(&mut self) {
if !self.completed {
self.reset();
}
}
}
impl<'a, 'b, 'c> Deref for AttrDataWriter<'a, 'b, 'c> {
type Target = TLVWriter<'b, 'c>;
fn deref(&self) -> &Self::Target {
self.tw
}
}
impl<'a, 'b, 'c> DerefMut for AttrDataWriter<'a, 'b, 'c> {
fn deref_mut(&mut self) -> &mut Self::Target {
self.tw
}
}
pub struct AttrData<'a> {
for_dataver: Option<u32>,
data: &'a TLVElement<'a>,
}
impl<'a> AttrData<'a> {
pub fn new(for_dataver: Option<u32>, data: &'a TLVElement<'a>) -> Self {
Self { for_dataver, data }
}
pub fn with_dataver(self, dataver: u32) -> Result<&'a TLVElement<'a>, Error> {
if let Some(req_dataver) = self.for_dataver {
if req_dataver != dataver {
return Err(Error::DataVersionMismatch);
}
}
Ok(self.data)
}
}
#[derive(Default)]
pub struct CmdDataTracker {
skip_status: bool,
}
impl CmdDataTracker {
pub const fn new() -> Self {
Self { skip_status: false }
}
pub(crate) fn complete(&mut self) {
self.skip_status = true;
}
pub fn needs_status(&self) -> bool {
!self.skip_status
}
}
pub struct CmdDataEncoder<'a, 'b, 'c> {
tracker: &'a mut CmdDataTracker,
path: CmdPath,
tw: &'a mut TLVWriter<'b, 'c>,
}
impl<'a, 'b, 'c> CmdDataEncoder<'a, 'b, 'c> {
pub fn handle<T: Handler>(
item: Result<(CmdDetails, TLVElement), CmdStatus>,
handler: &mut T,
transaction: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(), Error> {
let status = match item {
Ok((cmd, data)) => {
let mut tracker = CmdDataTracker::new();
let encoder = CmdDataEncoder::new(&cmd, &mut tracker, tw);
match handler.invoke(transaction, &cmd, &data, encoder) {
Ok(()) => cmd.success(&tracker),
Err(error) => cmd.status(error.into()),
}
}
Err(status) => Some(status),
};
if let Some(status) = status {
InvResp::Status(status).to_tlv(tw, TagType::Anonymous)?;
}
Ok(())
}
#[cfg(feature = "nightly")]
pub async fn handle_async<T: super::asynch::AsyncHandler>(
item: Result<(CmdDetails<'_>, TLVElement<'_>), CmdStatus>,
handler: &mut T,
transaction: &mut Transaction<'_, '_>,
tw: &mut TLVWriter<'_, '_>,
) -> Result<(), Error> {
let status = match item {
Ok((cmd, data)) => {
let mut tracker = CmdDataTracker::new();
let encoder = CmdDataEncoder::new(&cmd, &mut tracker, tw);
match handler.invoke(transaction, &cmd, &data, encoder).await {
Ok(()) => cmd.success(&tracker),
Err(error) => cmd.status(error.into()),
}
}
Err(status) => Some(status),
};
if let Some(status) = status {
InvResp::Status(status).to_tlv(tw, TagType::Anonymous)?;
}
Ok(())
}
pub fn new(
cmd: &CmdDetails,
tracker: &'a mut CmdDataTracker,
tw: &'a mut TLVWriter<'b, 'c>,
) -> Self {
Self {
tracker,
path: cmd.path(),
tw,
}
}
pub fn with_command(mut self, cmd: u16) -> Result<CmdDataWriter<'a, 'b, 'c>, Error> {
let mut writer = CmdDataWriter::new(self.tracker, self.tw);
writer.start_struct(TagType::Anonymous)?;
writer.start_struct(TagType::Context(InvRespTag::Cmd as _))?;
self.path.path.leaf = Some(cmd as _);
self.path
.to_tlv(&mut writer, TagType::Context(CmdDataTag::Path as _))?;
Ok(writer)
}
}
pub struct CmdDataWriter<'a, 'b, 'c> {
tracker: &'a mut CmdDataTracker,
tw: &'a mut TLVWriter<'b, 'c>,
anchor: usize,
completed: bool,
}
impl<'a, 'b, 'c> CmdDataWriter<'a, 'b, 'c> {
pub const TAG: TagType = TagType::Context(CmdDataTag::Data as _);
fn new(tracker: &'a mut CmdDataTracker, tw: &'a mut TLVWriter<'b, 'c>) -> Self {
let anchor = tw.get_tail();
Self {
tracker,
tw,
anchor,
completed: false,
}
}
pub fn set<T: ToTLV>(self, value: T) -> Result<(), Error> {
value.to_tlv(self.tw, Self::TAG)?;
self.complete()
}
pub fn complete(mut self) -> Result<(), Error> {
self.tw.end_container()?;
self.tw.end_container()?;
self.completed = true;
self.tracker.complete();
Ok(())
}
fn reset(&mut self) {
self.tw.rewind_to(self.anchor);
}
}
impl<'a, 'b, 'c> Drop for CmdDataWriter<'a, 'b, 'c> {
fn drop(&mut self) {
if !self.completed {
self.reset();
}
}
}
impl<'a, 'b, 'c> Deref for CmdDataWriter<'a, 'b, 'c> {
type Target = TLVWriter<'b, 'c>;
fn deref(&self) -> &Self::Target {
self.tw
}
}
impl<'a, 'b, 'c> DerefMut for CmdDataWriter<'a, 'b, 'c> {
fn deref_mut(&mut self) -> &mut Self::Target {
self.tw
}
}
#[derive(Copy, Clone, Debug)]
pub struct AttrType<T>(PhantomData<fn() -> T>);
impl<T> AttrType<T> {
pub const fn new() -> Self {
Self(PhantomData)
}
pub fn encode(&self, writer: AttrDataWriter, value: T) -> Result<(), Error>
where
T: ToTLV,
{
writer.set(value)
}
pub fn decode<'a>(&self, data: &'a TLVElement) -> Result<T, Error>
where
T: FromTLV<'a>,
{
T::from_tlv(data)
}
}
impl<T> Default for AttrType<T> {
fn default() -> Self {
Self::new()
}
}
#[derive(Copy, Clone, Debug, Default)]
pub struct AttrUtfType;
impl AttrUtfType {
pub const fn new() -> Self {
Self
}
pub fn encode(&self, writer: AttrDataWriter, value: &str) -> Result<(), Error> {
writer.set(UtfStr::new(value.as_bytes()))
}
pub fn decode<'a>(&self, data: &'a TLVElement) -> Result<&'a str, IMStatusCode> {
data.str().map_err(|_| IMStatusCode::InvalidDataType)
}
}
#[allow(unused_macros)]
#[macro_export]
macro_rules! attribute_enum {
($en:ty) => {
impl core::convert::TryFrom<$crate::data_model::objects::AttrId> for $en {
type Error = $crate::error::Error;
fn try_from(id: $crate::data_model::objects::AttrId) -> Result<Self, Self::Error> {
<$en>::from_repr(id).ok_or($crate::error::Error::AttributeNotFound)
}
}
};
}
#[allow(unused_macros)]
#[macro_export]
macro_rules! command_enum {
($en:ty) => {
impl core::convert::TryFrom<$crate::data_model::objects::CmdId> for $en {
type Error = $crate::error::Error;
fn try_from(id: $crate::data_model::objects::CmdId) -> Result<Self, Self::Error> {
<$en>::from_repr(id).ok_or($crate::error::Error::CommandNotFound)
}
}
};
} }

View file

@ -15,104 +15,91 @@
* limitations under the License. * limitations under the License.
*/ */
use crate::{data_model::objects::ClusterType, error::*, interaction_model::core::IMStatusCode}; use crate::{acl::Accessor, interaction_model::core::IMStatusCode};
use std::fmt; use core::fmt;
use super::{ClusterId, DeviceType}; use super::{AttrId, Cluster, ClusterId, CmdId, DeviceType, EndptId};
pub const CLUSTERS_PER_ENDPT: usize = 9; #[derive(Debug, Clone)]
pub struct Endpoint<'a> {
pub struct Endpoint { pub id: EndptId,
dev_type: DeviceType, pub device_type: DeviceType,
clusters: Vec<Box<dyn ClusterType>>, pub clusters: &'a [Cluster<'a>],
} }
pub type BoxedClusters = [Box<dyn ClusterType>]; impl<'a> Endpoint<'a> {
pub(crate) fn match_attributes<'m>(
impl Endpoint { &'m self,
pub fn new(dev_type: DeviceType) -> Result<Box<Endpoint>, Error> { accessor: &'m Accessor<'m>,
Ok(Box::new(Endpoint { cl: Option<ClusterId>,
dev_type, attr: Option<AttrId>,
clusters: Vec::with_capacity(CLUSTERS_PER_ENDPT), write: bool,
})) ) -> impl Iterator<Item = (ClusterId, AttrId)> + 'm {
self.match_clusters(cl).flat_map(move |cluster| {
cluster
.match_attributes(accessor, self.id, attr, write)
.map(move |attr| (cluster.id, attr))
})
} }
pub fn add_cluster(&mut self, cluster: Box<dyn ClusterType>) -> Result<(), Error> { pub(crate) fn match_commands<'m>(
if self.clusters.len() < self.clusters.capacity() { &'m self,
self.clusters.push(cluster); accessor: &'m Accessor<'m>,
Ok(()) cl: Option<ClusterId>,
} else { cmd: Option<CmdId>,
Err(Error::NoSpace) ) -> impl Iterator<Item = (ClusterId, CmdId)> + 'm {
} self.match_clusters(cl).flat_map(move |cluster| {
cluster
.match_commands(accessor, self.id, cmd)
.map(move |cmd| (cluster.id, cmd))
})
} }
pub fn get_dev_type(&self) -> &DeviceType { pub(crate) fn check_attribute(
&self.dev_type
}
fn get_cluster_index(&self, cluster_id: ClusterId) -> Option<usize> {
self.clusters.iter().position(|c| c.base().id == cluster_id)
}
pub fn get_cluster(&self, cluster_id: ClusterId) -> Result<&dyn ClusterType, Error> {
let index = self
.get_cluster_index(cluster_id)
.ok_or(Error::ClusterNotFound)?;
Ok(self.clusters[index].as_ref())
}
pub fn get_cluster_mut(
&mut self,
cluster_id: ClusterId,
) -> Result<&mut dyn ClusterType, Error> {
let index = self
.get_cluster_index(cluster_id)
.ok_or(Error::ClusterNotFound)?;
Ok(self.clusters[index].as_mut())
}
// Returns a slice of clusters, with either a single cluster or all (wildcard)
pub fn get_wildcard_clusters(
&self, &self,
cluster: Option<ClusterId>, accessor: &Accessor,
) -> Result<(&BoxedClusters, bool), IMStatusCode> { cl: ClusterId,
if let Some(c) = cluster { attr: AttrId,
if let Some(i) = self.get_cluster_index(c) { write: bool,
Ok((&self.clusters[i..i + 1], false)) ) -> Result<(), IMStatusCode> {
} else { self.check_cluster(cl)
Err(IMStatusCode::UnsupportedCluster) .and_then(|cluster| cluster.check_attribute(accessor, self.id, attr, write))
}
} else {
Ok((self.clusters.as_slice(), true))
}
} }
// Returns a slice of clusters, with either a single cluster or all (wildcard) pub(crate) fn check_command(
pub fn get_wildcard_clusters_mut( &self,
&mut self, accessor: &Accessor,
cluster: Option<ClusterId>, cl: ClusterId,
) -> Result<(&mut BoxedClusters, bool), IMStatusCode> { cmd: CmdId,
if let Some(c) = cluster { ) -> Result<(), IMStatusCode> {
if let Some(i) = self.get_cluster_index(c) { self.check_cluster(cl)
Ok((&mut self.clusters[i..i + 1], false)) .and_then(|cluster| cluster.check_command(accessor, self.id, cmd))
} else {
Err(IMStatusCode::UnsupportedCluster)
} }
} else {
Ok((&mut self.clusters[..], true)) fn match_clusters(&self, cl: Option<ClusterId>) -> impl Iterator<Item = &Cluster> + '_ {
self.clusters
.iter()
.filter(move |cluster| cl.map(|id| id == cluster.id).unwrap_or(true))
} }
fn check_cluster(&self, cl: ClusterId) -> Result<&Cluster, IMStatusCode> {
self.clusters
.iter()
.find(|cluster| cluster.id == cl)
.ok_or(IMStatusCode::UnsupportedCluster)
} }
} }
impl std::fmt::Display for Endpoint { impl<'a> core::fmt::Display for Endpoint<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "clusters:[")?; write!(f, "clusters:[")?;
let mut comma = ""; let mut comma = "";
for element in self.clusters.iter() { for cluster in self.clusters {
write!(f, "{} {{ {} }}", comma, element.base())?; write!(f, "{} {{ {} }}", comma, cluster)?;
comma = ", "; comma = ", ";
} }
write!(f, "]") write!(f, "]")
} }
} }

View file

@ -0,0 +1,350 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::{error::Error, interaction_model::core::Transaction, tlv::TLVElement};
use super::{AttrData, AttrDataEncoder, AttrDetails, CmdDataEncoder, CmdDetails};
pub trait ChangeNotifier<T> {
fn consume_change(&mut self) -> Option<T>;
}
pub trait Handler {
fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error>;
fn write(&mut self, _attr: &AttrDetails, _data: AttrData) -> Result<(), Error> {
Err(Error::AttributeNotFound)
}
fn invoke(
&mut self,
_transaction: &mut Transaction,
_cmd: &CmdDetails,
_data: &TLVElement,
_encoder: CmdDataEncoder,
) -> Result<(), Error> {
Err(Error::CommandNotFound)
}
}
impl<T> Handler for &mut T
where
T: Handler,
{
fn read<'a>(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
(**self).read(attr, encoder)
}
fn write(&mut self, attr: &AttrDetails, data: AttrData) -> Result<(), Error> {
(**self).write(attr, data)
}
fn invoke(
&mut self,
transaction: &mut Transaction,
cmd: &CmdDetails,
data: &TLVElement,
encoder: CmdDataEncoder,
) -> Result<(), Error> {
(**self).invoke(transaction, cmd, data, encoder)
}
}
pub trait NonBlockingHandler: Handler {}
impl<T> NonBlockingHandler for &mut T where T: NonBlockingHandler {}
pub struct EmptyHandler;
impl EmptyHandler {
pub const fn chain<H>(
self,
handler_endpoint: u16,
handler_cluster: u32,
handler: H,
) -> ChainedHandler<H, Self> {
ChainedHandler {
handler_endpoint,
handler_cluster,
handler,
next: self,
}
}
}
impl Handler for EmptyHandler {
fn read(&self, _attr: &AttrDetails, _encoder: AttrDataEncoder) -> Result<(), Error> {
Err(Error::AttributeNotFound)
}
}
impl NonBlockingHandler for EmptyHandler {}
impl ChangeNotifier<(u16, u32)> for EmptyHandler {
fn consume_change(&mut self) -> Option<(u16, u32)> {
None
}
}
pub struct ChainedHandler<H, T> {
pub handler_endpoint: u16,
pub handler_cluster: u32,
pub handler: H,
pub next: T,
}
impl<H, T> ChainedHandler<H, T> {
pub const fn chain<H2>(
self,
handler_endpoint: u16,
handler_cluster: u32,
handler: H2,
) -> ChainedHandler<H2, Self> {
ChainedHandler {
handler_endpoint,
handler_cluster,
handler,
next: self,
}
}
}
impl<H, T> Handler for ChainedHandler<H, T>
where
H: Handler,
T: Handler,
{
fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
if self.handler_endpoint == attr.endpoint_id && self.handler_cluster == attr.cluster_id {
self.handler.read(attr, encoder)
} else {
self.next.read(attr, encoder)
}
}
fn write(&mut self, attr: &AttrDetails, data: AttrData) -> Result<(), Error> {
if self.handler_endpoint == attr.endpoint_id && self.handler_cluster == attr.cluster_id {
self.handler.write(attr, data)
} else {
self.next.write(attr, data)
}
}
fn invoke(
&mut self,
transaction: &mut Transaction,
cmd: &CmdDetails,
data: &TLVElement,
encoder: CmdDataEncoder,
) -> Result<(), Error> {
if self.handler_endpoint == cmd.endpoint_id && self.handler_cluster == cmd.cluster_id {
self.handler.invoke(transaction, cmd, data, encoder)
} else {
self.next.invoke(transaction, cmd, data, encoder)
}
}
}
impl<H, T> NonBlockingHandler for ChainedHandler<H, T>
where
H: NonBlockingHandler,
T: NonBlockingHandler,
{
}
impl<H, T> ChangeNotifier<(u16, u32)> for ChainedHandler<H, T>
where
H: ChangeNotifier<()>,
T: ChangeNotifier<(u16, u32)>,
{
fn consume_change(&mut self) -> Option<(u16, u32)> {
if self.handler.consume_change().is_some() {
Some((self.handler_endpoint, self.handler_cluster))
} else {
self.next.consume_change()
}
}
}
#[allow(unused_macros)]
#[macro_export]
macro_rules! handler_chain_type {
($h:ty) => {
$crate::data_model::objects::ChainedHandler<$h, $crate::data_model::objects::EmptyHandler>
};
($h1:ty, $($rest:ty),+) => {
$crate::data_model::objects::ChainedHandler<$h1, handler_chain_type!($($rest),+)>
};
}
#[cfg(feature = "nightly")]
pub mod asynch {
use crate::{
data_model::objects::{AttrData, AttrDataEncoder, AttrDetails, CmdDataEncoder, CmdDetails},
error::Error,
interaction_model::core::Transaction,
tlv::TLVElement,
};
use super::{ChainedHandler, EmptyHandler, Handler, NonBlockingHandler};
pub trait AsyncHandler {
async fn read<'a>(
&'a self,
attr: &'a AttrDetails<'_>,
encoder: AttrDataEncoder<'a, '_, '_>,
) -> Result<(), Error>;
async fn write<'a>(
&'a mut self,
_attr: &'a AttrDetails<'_>,
_data: AttrData<'a>,
) -> Result<(), Error> {
Err(Error::AttributeNotFound)
}
async fn invoke<'a>(
&'a mut self,
_transaction: &'a mut Transaction<'_, '_>,
_cmd: &'a CmdDetails<'_>,
_data: &'a TLVElement<'_>,
_encoder: CmdDataEncoder<'a, '_, '_>,
) -> Result<(), Error> {
Err(Error::CommandNotFound)
}
}
impl<T> AsyncHandler for &mut T
where
T: AsyncHandler,
{
async fn read<'a>(
&'a self,
attr: &'a AttrDetails<'_>,
encoder: AttrDataEncoder<'a, '_, '_>,
) -> Result<(), Error> {
(**self).read(attr, encoder).await
}
async fn write<'a>(
&'a mut self,
attr: &'a AttrDetails<'_>,
data: AttrData<'a>,
) -> Result<(), Error> {
(**self).write(attr, data).await
}
async fn invoke<'a>(
&'a mut self,
transaction: &'a mut Transaction<'_, '_>,
cmd: &'a CmdDetails<'_>,
data: &'a TLVElement<'_>,
encoder: CmdDataEncoder<'a, '_, '_>,
) -> Result<(), Error> {
(**self).invoke(transaction, cmd, data, encoder).await
}
}
pub struct Asyncify<T>(pub T);
impl<T> AsyncHandler for Asyncify<T>
where
T: NonBlockingHandler,
{
async fn read<'a>(
&'a self,
attr: &'a AttrDetails<'_>,
encoder: AttrDataEncoder<'a, '_, '_>,
) -> Result<(), Error> {
Handler::read(&self.0, attr, encoder)
}
async fn write<'a>(
&'a mut self,
attr: &'a AttrDetails<'_>,
data: AttrData<'a>,
) -> Result<(), Error> {
Handler::write(&mut self.0, attr, data)
}
async fn invoke<'a>(
&'a mut self,
transaction: &'a mut Transaction<'_, '_>,
cmd: &'a CmdDetails<'_>,
data: &'a TLVElement<'_>,
encoder: CmdDataEncoder<'a, '_, '_>,
) -> Result<(), Error> {
Handler::invoke(&mut self.0, transaction, cmd, data, encoder)
}
}
impl AsyncHandler for EmptyHandler {
async fn read<'a>(
&'a self,
_attr: &'a AttrDetails<'_>,
_encoder: AttrDataEncoder<'a, '_, '_>,
) -> Result<(), Error> {
Err(Error::AttributeNotFound)
}
}
impl<H, T> AsyncHandler for ChainedHandler<H, T>
where
H: AsyncHandler,
T: AsyncHandler,
{
async fn read<'a>(
&'a self,
attr: &'a AttrDetails<'_>,
encoder: AttrDataEncoder<'a, '_, '_>,
) -> Result<(), Error> {
if self.handler_endpoint == attr.endpoint_id && self.handler_cluster == attr.cluster_id
{
self.handler.read(attr, encoder).await
} else {
self.next.read(attr, encoder).await
}
}
async fn write<'a>(
&'a mut self,
attr: &'a AttrDetails<'_>,
data: AttrData<'a>,
) -> Result<(), Error> {
if self.handler_endpoint == attr.endpoint_id && self.handler_cluster == attr.cluster_id
{
self.handler.write(attr, data).await
} else {
self.next.write(attr, data).await
}
}
async fn invoke<'a>(
&'a mut self,
transaction: &'a mut Transaction<'_, '_>,
cmd: &'a CmdDetails<'_>,
data: &'a TLVElement<'_>,
encoder: CmdDataEncoder<'a, '_, '_>,
) -> Result<(), Error> {
if self.handler_endpoint == cmd.endpoint_id && self.handler_cluster == cmd.cluster_id {
self.handler.invoke(transaction, cmd, data, encoder).await
} else {
self.next.invoke(transaction, cmd, data, encoder).await
}
}
}
}

View file

@ -14,11 +14,8 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
use crate::error::Error;
pub type EndptId = u16; use crate::tlv::{TLVWriter, TagType, ToTLV};
pub type ClusterId = u32;
pub type AttrId = u16;
pub type CmdId = u32;
mod attribute; mod attribute;
pub use attribute::*; pub use attribute::*;
@ -37,3 +34,20 @@ pub use privilege::*;
mod encoder; mod encoder;
pub use encoder::*; pub use encoder::*;
mod handler;
pub use handler::*;
mod dataver;
pub use dataver::*;
pub type EndptId = u16;
pub type ClusterId = u32;
pub type AttrId = u16;
pub type CmdId = u32;
#[derive(Debug, ToTLV, Copy, Clone)]
pub struct DeviceType {
pub dtype: u16,
pub drev: u16,
}

View file

@ -16,283 +16,379 @@
*/ */
use crate::{ use crate::{
data_model::objects::{ClusterType, Endpoint}, acl::Accessor,
error::*, data_model::objects::Endpoint,
interaction_model::{core::IMStatusCode, messages::GenericPath}, interaction_model::{
core::IMStatusCode,
messages::{
ib::{AttrStatus, CmdStatus},
msg::{InvReq, ReadReq, WriteReq},
GenericPath,
},
},
// TODO: This layer shouldn't really depend on the TLV layer, should create an abstraction layer // TODO: This layer shouldn't really depend on the TLV layer, should create an abstraction layer
tlv::TLVElement,
};
use core::{
fmt,
iter::{once, Once},
}; };
use std::fmt;
use super::{ClusterId, DeviceType, EndptId}; use super::{AttrDetails, AttrId, ClusterId, CmdDetails, CmdId, EndptId};
pub trait ChangeConsumer { enum WildcardIter<T, E> {
fn endpoint_added(&self, id: EndptId, endpoint: &mut Endpoint) -> Result<(), Error>; None,
Single(Once<E>),
Wildcard(T),
} }
pub const ENDPTS_PER_ACC: usize = 3; impl<T, E> Iterator for WildcardIter<T, E>
where
T: Iterator<Item = E>,
{
type Item = E;
pub type BoxedEndpoints = [Option<Box<Endpoint>>]; fn next(&mut self) -> Option<Self::Item> {
match self {
#[derive(Default)] Self::None => None,
pub struct Node { Self::Single(iter) => iter.next(),
endpoints: [Option<Box<Endpoint>>; ENDPTS_PER_ACC], Self::Wildcard(iter) => iter.next(),
changes_cb: Option<Box<dyn ChangeConsumer>>, }
}
} }
impl std::fmt::Display for Node { #[derive(Debug, Clone)]
pub struct Node<'a> {
pub id: u16,
pub endpoints: &'a [Endpoint<'a>],
}
impl<'a> Node<'a> {
pub fn read<'s, 'm>(
&'s self,
req: &'m ReadReq,
accessor: &'m Accessor<'m>,
) -> impl Iterator<Item = Result<AttrDetails, AttrStatus>> + 'm
where
's: 'm,
{
if let Some(attr_requests) = req.attr_requests.as_ref() {
WildcardIter::Wildcard(attr_requests.iter().flat_map(
move |path| match self.expand_attr(accessor, path.to_gp(), false) {
Ok(iter) => {
let wildcard = matches!(iter, WildcardIter::Wildcard(_));
WildcardIter::Wildcard(iter.map(move |(ep, cl, attr)| {
let dataver_filter = req
.dataver_filters
.as_ref()
.iter()
.flat_map(|array| array.iter())
.find_map(|filter| {
(filter.path.endpoint == ep && filter.path.cluster == cl)
.then_some(filter.data_ver)
});
Ok(AttrDetails {
node: self,
endpoint_id: ep,
cluster_id: cl,
attr_id: attr,
list_index: path.list_index,
fab_idx: accessor.fab_idx,
fab_filter: req.fabric_filtered,
dataver: dataver_filter,
wildcard,
})
}))
}
Err(err) => {
WildcardIter::Single(once(Err(AttrStatus::new(&path.to_gp(), err, 0))))
}
},
))
} else {
WildcardIter::None
}
}
pub fn write<'m>(
&'m self,
req: &'m WriteReq,
accessor: &'m Accessor<'m>,
) -> impl Iterator<Item = Result<(AttrDetails, TLVElement<'m>), AttrStatus>> + 'm {
req.write_requests.iter().flat_map(move |attr_data| {
if attr_data.path.cluster.is_none() {
WildcardIter::Single(once(Err(AttrStatus::new(
&attr_data.path.to_gp(),
IMStatusCode::UnsupportedCluster,
0,
))))
} else if attr_data.path.attr.is_none() {
WildcardIter::Single(once(Err(AttrStatus::new(
&attr_data.path.to_gp(),
IMStatusCode::UnsupportedAttribute,
0,
))))
} else {
match self.expand_attr(accessor, attr_data.path.to_gp(), true) {
Ok(iter) => {
let wildcard = matches!(iter, WildcardIter::Wildcard(_));
WildcardIter::Wildcard(iter.map(move |(ep, cl, attr)| {
Ok((
AttrDetails {
node: self,
endpoint_id: ep,
cluster_id: cl,
attr_id: attr,
list_index: attr_data.path.list_index,
fab_idx: accessor.fab_idx,
fab_filter: false,
dataver: attr_data.data_ver,
wildcard,
},
attr_data.data.unwrap_tlv().unwrap(),
))
}))
}
Err(err) => WildcardIter::Single(once(Err(AttrStatus::new(
&attr_data.path.to_gp(),
err,
0,
)))),
}
}
})
}
pub fn invoke<'m>(
&'m self,
req: &'m InvReq,
accessor: &'m Accessor<'m>,
) -> impl Iterator<Item = Result<(CmdDetails, TLVElement<'m>), CmdStatus>> + 'm {
if let Some(inv_requests) = req.inv_requests.as_ref() {
WildcardIter::Wildcard(inv_requests.iter().flat_map(move |cmd_data| {
match self.expand_cmd(accessor, cmd_data.path.path) {
Ok(iter) => {
let wildcard = matches!(iter, WildcardIter::Wildcard(_));
WildcardIter::Wildcard(iter.map(move |(ep, cl, cmd)| {
Ok((
CmdDetails {
node: self,
endpoint_id: ep,
cluster_id: cl,
cmd_id: cmd,
wildcard,
},
cmd_data.data.unwrap_tlv().unwrap(),
))
}))
}
Err(err) => {
WildcardIter::Single(once(Err(CmdStatus::new(cmd_data.path, err, 0))))
}
}
}))
} else {
WildcardIter::None
}
}
fn expand_attr<'m>(
&'m self,
accessor: &'m Accessor<'m>,
path: GenericPath,
write: bool,
) -> Result<
WildcardIter<
impl Iterator<Item = (EndptId, ClusterId, AttrId)> + 'm,
(EndptId, ClusterId, AttrId),
>,
IMStatusCode,
> {
if path.is_wildcard() {
Ok(WildcardIter::Wildcard(self.match_attributes(
accessor,
path.endpoint,
path.cluster,
path.leaf.map(|leaf| leaf as u16),
write,
)))
} else {
self.check_attribute(
accessor,
path.endpoint.unwrap(),
path.cluster.unwrap(),
path.leaf.unwrap() as _,
write,
)?;
Ok(WildcardIter::Single(once((
path.endpoint.unwrap(),
path.cluster.unwrap(),
path.leaf.unwrap() as _,
))))
}
}
fn expand_cmd<'m>(
&'m self,
accessor: &'m Accessor<'m>,
path: GenericPath,
) -> Result<
WildcardIter<
impl Iterator<Item = (EndptId, ClusterId, CmdId)> + 'm,
(EndptId, ClusterId, CmdId),
>,
IMStatusCode,
> {
if path.is_wildcard() {
Ok(WildcardIter::Wildcard(self.match_commands(
accessor,
path.endpoint,
path.cluster,
path.leaf,
)))
} else {
self.check_command(
accessor,
path.endpoint.unwrap(),
path.cluster.unwrap(),
path.leaf.unwrap(),
)?;
Ok(WildcardIter::Single(once((
path.endpoint.unwrap(),
path.cluster.unwrap(),
path.leaf.unwrap(),
))))
}
}
fn match_attributes<'m>(
&'m self,
accessor: &'m Accessor<'m>,
ep: Option<EndptId>,
cl: Option<ClusterId>,
attr: Option<AttrId>,
write: bool,
) -> impl Iterator<Item = (EndptId, ClusterId, AttrId)> + 'm {
self.match_endpoints(ep).flat_map(move |endpoint| {
endpoint
.match_attributes(accessor, cl, attr, write)
.map(move |(cl, attr)| (endpoint.id, cl, attr))
})
}
fn match_commands<'m>(
&'m self,
accessor: &'m Accessor<'m>,
ep: Option<EndptId>,
cl: Option<ClusterId>,
cmd: Option<CmdId>,
) -> impl Iterator<Item = (EndptId, ClusterId, CmdId)> + 'm {
self.match_endpoints(ep).flat_map(move |endpoint| {
endpoint
.match_commands(accessor, cl, cmd)
.map(move |(cl, cmd)| (endpoint.id, cl, cmd))
})
}
fn check_attribute(
&self,
accessor: &Accessor,
ep: EndptId,
cl: ClusterId,
attr: AttrId,
write: bool,
) -> Result<(), IMStatusCode> {
self.check_endpoint(ep)
.and_then(|endpoint| endpoint.check_attribute(accessor, cl, attr, write))
}
fn check_command(
&self,
accessor: &Accessor,
ep: EndptId,
cl: ClusterId,
cmd: CmdId,
) -> Result<(), IMStatusCode> {
self.check_endpoint(ep)
.and_then(|endpoint| endpoint.check_command(accessor, cl, cmd))
}
fn match_endpoints(&self, ep: Option<EndptId>) -> impl Iterator<Item = &Endpoint> + '_ {
self.endpoints
.iter()
.filter(move |endpoint| ep.map(|id| id == endpoint.id).unwrap_or(true))
}
fn check_endpoint(&self, ep: EndptId) -> Result<&Endpoint, IMStatusCode> {
self.endpoints
.iter()
.find(|endpoint| endpoint.id == ep)
.ok_or(IMStatusCode::UnsupportedEndpoint)
}
}
impl<'a> core::fmt::Display for Node<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
writeln!(f, "node:")?; writeln!(f, "node:")?;
for (i, element) in self.endpoints.iter().enumerate() { for (index, endpoint) in self.endpoints.iter().enumerate() {
if let Some(e) = element { writeln!(f, "endpoint {}: {}", index, endpoint)?;
writeln!(f, "endpoint {}: {}", i, e)?;
}
} }
write!(f, "") write!(f, "")
} }
} }
impl Node { pub struct DynamicNode<'a, const N: usize> {
pub fn new() -> Result<Box<Node>, Error> { id: u16,
let node = Box::default(); endpoints: heapless::Vec<Endpoint<'a>, N>,
Ok(node) }
impl<'a, const N: usize> DynamicNode<'a, N> {
pub const fn new(id: u16) -> Self {
Self {
id,
endpoints: heapless::Vec::new(),
}
} }
pub fn set_changes_cb(&mut self, consumer: Box<dyn ChangeConsumer>) { pub fn node(&self) -> Node<'_> {
self.changes_cb = Some(consumer); Node {
id: self.id,
endpoints: &self.endpoints,
}
} }
pub fn add_endpoint(&mut self, dev_type: DeviceType) -> Result<EndptId, Error> { pub fn add(&mut self, endpoint: Endpoint<'a>) -> Result<(), Endpoint<'a>> {
if !self.endpoints.iter().any(|ep| ep.id == endpoint.id) {
self.endpoints.push(endpoint)
} else {
Err(endpoint)
}
}
pub fn remove(&mut self, endpoint_id: u16) -> Option<Endpoint<'a>> {
let index = self let index = self
.endpoints .endpoints
.iter() .iter()
.position(|x| x.is_none()) .enumerate()
.ok_or(Error::NoSpace)?; .find_map(|(index, ep)| (ep.id == endpoint_id).then_some(index));
let mut endpoint = Endpoint::new(dev_type)?;
if let Some(cb) = &self.changes_cb {
cb.endpoint_added(index as EndptId, &mut endpoint)?;
}
self.endpoints[index] = Some(endpoint);
Ok(index as EndptId)
}
pub fn get_endpoint(&self, endpoint_id: EndptId) -> Result<&Endpoint, Error> { if let Some(index) = index {
if (endpoint_id as usize) < ENDPTS_PER_ACC { Some(self.endpoints.swap_remove(index))
let endpoint = self.endpoints[endpoint_id as usize]
.as_ref()
.ok_or(Error::EndpointNotFound)?;
Ok(endpoint)
} else { } else {
Err(Error::EndpointNotFound) None
} }
} }
}
pub fn get_endpoint_mut(&mut self, endpoint_id: EndptId) -> Result<&mut Endpoint, Error> {
if (endpoint_id as usize) < ENDPTS_PER_ACC { impl<'a, const N: usize> core::fmt::Display for DynamicNode<'a, N> {
let endpoint = self.endpoints[endpoint_id as usize] fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
.as_mut() self.node().fmt(f)
.ok_or(Error::EndpointNotFound)?; }
Ok(endpoint)
} else {
Err(Error::EndpointNotFound)
}
}
pub fn get_cluster_mut(
&mut self,
e: EndptId,
c: ClusterId,
) -> Result<&mut dyn ClusterType, Error> {
self.get_endpoint_mut(e)?.get_cluster_mut(c)
}
pub fn get_cluster(&self, e: EndptId, c: ClusterId) -> Result<&dyn ClusterType, Error> {
self.get_endpoint(e)?.get_cluster(c)
}
pub fn add_cluster(
&mut self,
endpoint_id: EndptId,
cluster: Box<dyn ClusterType>,
) -> Result<(), Error> {
let endpoint_id = endpoint_id as usize;
if endpoint_id < ENDPTS_PER_ACC {
self.endpoints[endpoint_id]
.as_mut()
.ok_or(Error::NoEndpoint)?
.add_cluster(cluster)
} else {
Err(Error::Invalid)
}
}
// Returns a slice of endpoints, with either a single endpoint or all (wildcard)
pub fn get_wildcard_endpoints(
&self,
endpoint: Option<EndptId>,
) -> Result<(&BoxedEndpoints, usize, bool), IMStatusCode> {
if let Some(e) = endpoint {
let e = e as usize;
if self.endpoints.len() <= e || self.endpoints[e].is_none() {
Err(IMStatusCode::UnsupportedEndpoint)
} else {
Ok((&self.endpoints[e..e + 1], e, false))
}
} else {
Ok((&self.endpoints[..], 0, true))
}
}
pub fn get_wildcard_endpoints_mut(
&mut self,
endpoint: Option<EndptId>,
) -> Result<(&mut BoxedEndpoints, usize, bool), IMStatusCode> {
if let Some(e) = endpoint {
let e = e as usize;
if self.endpoints.len() <= e || self.endpoints[e].is_none() {
Err(IMStatusCode::UnsupportedEndpoint)
} else {
Ok((&mut self.endpoints[e..e + 1], e, false))
}
} else {
Ok((&mut self.endpoints[..], 0, true))
}
}
/// Run a closure for all endpoints as specified in the path
///
/// Note that the path is a GenericPath and hence can be a wildcard path. The behaviour
/// of this function is to only capture the successful invocations and ignore the erroneous
/// ones. This is inline with the expected behaviour for wildcard, where it implies that
/// 'please run this operation on this wildcard path "wherever possible"'
///
/// It is expected that if the closure that you pass here returns an error it may not reach
/// out to the caller, in case there was a wildcard path specified
pub fn for_each_endpoint<T>(&self, path: &GenericPath, mut f: T) -> Result<(), IMStatusCode>
where
T: FnMut(&GenericPath, &Endpoint) -> Result<(), IMStatusCode>,
{
let mut current_path = *path;
let (endpoints, mut endpoint_id, wildcard) = self.get_wildcard_endpoints(path.endpoint)?;
for e in endpoints.iter() {
if let Some(e) = e {
current_path.endpoint = Some(endpoint_id as EndptId);
f(&current_path, e.as_ref())
.or_else(|e| if !wildcard { Err(e) } else { Ok(()) })?;
}
endpoint_id += 1;
}
Ok(())
}
/// Run a closure for all endpoints (mutable) as specified in the path
///
/// Note that the path is a GenericPath and hence can be a wildcard path. The behaviour
/// of this function is to only capture the successful invocations and ignore the erroneous
/// ones. This is inline with the expected behaviour for wildcard, where it implies that
/// 'please run this operation on this wildcard path "wherever possible"'
///
/// It is expected that if the closure that you pass here returns an error it may not reach
/// out to the caller, in case there was a wildcard path specified
pub fn for_each_endpoint_mut<T>(
&mut self,
path: &GenericPath,
mut f: T,
) -> Result<(), IMStatusCode>
where
T: FnMut(&GenericPath, &mut Endpoint) -> Result<(), IMStatusCode>,
{
let mut current_path = *path;
let (endpoints, mut endpoint_id, wildcard) =
self.get_wildcard_endpoints_mut(path.endpoint)?;
for e in endpoints.iter_mut() {
if let Some(e) = e {
current_path.endpoint = Some(endpoint_id as EndptId);
f(&current_path, e.as_mut())
.or_else(|e| if !wildcard { Err(e) } else { Ok(()) })?;
}
endpoint_id += 1;
}
Ok(())
}
/// Run a closure for all clusters as specified in the path
///
/// Note that the path is a GenericPath and hence can be a wildcard path. The behaviour
/// of this function is to only capture the successful invocations and ignore the erroneous
/// ones. This is inline with the expected behaviour for wildcard, where it implies that
/// 'please run this operation on this wildcard path "wherever possible"'
///
/// It is expected that if the closure that you pass here returns an error it may not reach
/// out to the caller, in case there was a wildcard path specified
pub fn for_each_cluster<T>(&self, path: &GenericPath, mut f: T) -> Result<(), IMStatusCode>
where
T: FnMut(&GenericPath, &dyn ClusterType) -> Result<(), IMStatusCode>,
{
self.for_each_endpoint(path, |p, e| {
let mut current_path = *p;
let (clusters, wildcard) = e.get_wildcard_clusters(p.cluster)?;
for c in clusters.iter() {
current_path.cluster = Some(c.base().id);
f(&current_path, c.as_ref())
.or_else(|e| if !wildcard { Err(e) } else { Ok(()) })?;
}
Ok(())
})
}
/// Run a closure for all clusters (mutable) as specified in the path
///
/// Note that the path is a GenericPath and hence can be a wildcard path. The behaviour
/// of this function is to only capture the successful invocations and ignore the erroneous
/// ones. This is inline with the expected behaviour for wildcard, where it implies that
/// 'please run this operation on this wildcard path "wherever possible"'
///
/// It is expected that if the closure that you pass here returns an error it may not reach
/// out to the caller, in case there was a wildcard path specified
pub fn for_each_cluster_mut<T>(
&mut self,
path: &GenericPath,
mut f: T,
) -> Result<(), IMStatusCode>
where
T: FnMut(&GenericPath, &mut dyn ClusterType) -> Result<(), IMStatusCode>,
{
self.for_each_endpoint_mut(path, |p, e| {
let mut current_path = *p;
let (clusters, wildcard) = e.get_wildcard_clusters_mut(p.cluster)?;
for c in clusters.iter_mut() {
current_path.cluster = Some(c.base().id);
f(&current_path, c.as_mut())
.or_else(|e| if !wildcard { Err(e) } else { Ok(()) })?;
}
Ok(())
})
}
/// Run a closure for all attributes as specified in the path
///
/// Note that the path is a GenericPath and hence can be a wildcard path. The behaviour
/// of this function is to only capture the successful invocations and ignore the erroneous
/// ones. This is inline with the expected behaviour for wildcard, where it implies that
/// 'please run this operation on this wildcard path "wherever possible"'
///
/// It is expected that if the closure that you pass here returns an error it may not reach
/// out to the caller, in case there was a wildcard path specified
pub fn for_each_attribute<T>(&self, path: &GenericPath, mut f: T) -> Result<(), IMStatusCode>
where
T: FnMut(&GenericPath, &dyn ClusterType) -> Result<(), IMStatusCode>,
{
self.for_each_cluster(path, |current_path, c| {
let mut current_path = *current_path;
let (attributes, wildcard) = c
.base()
.get_wildcard_attribute(path.leaf.map(|at| at as u16))?;
for a in attributes.iter() {
current_path.leaf = Some(a.id as u32);
f(&current_path, c).or_else(|e| if !wildcard { Err(e) } else { Ok(()) })?;
}
Ok(())
})
}
} }

View file

@ -0,0 +1,108 @@
use core::{borrow::Borrow, cell::RefCell};
use crate::{
acl::AclMgr,
fabric::FabricMgr,
handler_chain_type,
mdns::MdnsMgr,
secure_channel::pake::PaseMgr,
utils::{epoch::Epoch, rand::Rand},
Matter,
};
use super::{
cluster_basic_information::{self, BasicInfoCluster, BasicInfoConfig},
objects::{Cluster, EmptyHandler},
sdm::{
admin_commissioning::{self, AdminCommCluster},
dev_att::DevAttDataFetcher,
failsafe::FailSafe,
general_commissioning::{self, GenCommCluster},
noc::{self, NocCluster},
nw_commissioning::{self, NwCommCluster},
},
system_model::access_control::{self, AccessControlCluster},
};
pub type RootEndpointHandler<'a> = handler_chain_type!(
AccessControlCluster<'a>,
NocCluster<'a>,
AdminCommCluster<'a>,
NwCommCluster,
GenCommCluster,
BasicInfoCluster<'a>
);
pub const CLUSTERS: [Cluster<'static>; 6] = [
cluster_basic_information::CLUSTER,
general_commissioning::CLUSTER,
nw_commissioning::CLUSTER,
admin_commissioning::CLUSTER,
noc::CLUSTER,
access_control::CLUSTER,
];
pub fn handler<'a>(
endpoint_id: u16,
dev_att: &'a dyn DevAttDataFetcher,
matter: &'a Matter<'a>,
) -> RootEndpointHandler<'a> {
wrap(
endpoint_id,
matter.dev_det(),
dev_att,
matter.borrow(),
matter.borrow(),
matter.borrow(),
matter.borrow(),
matter.borrow(),
*matter.borrow(),
*matter.borrow(),
)
}
#[allow(clippy::too_many_arguments)]
pub fn wrap<'a>(
endpoint_id: u16,
basic_info: &'a BasicInfoConfig<'a>,
dev_att: &'a dyn DevAttDataFetcher,
pase: &'a RefCell<PaseMgr>,
fabric: &'a RefCell<FabricMgr>,
acl: &'a RefCell<AclMgr>,
failsafe: &'a RefCell<FailSafe>,
mdns_mgr: &'a RefCell<MdnsMgr<'a>>,
epoch: Epoch,
rand: Rand,
) -> RootEndpointHandler<'a> {
EmptyHandler
.chain(
endpoint_id,
cluster_basic_information::CLUSTER.id,
BasicInfoCluster::new(basic_info, rand),
)
.chain(
endpoint_id,
general_commissioning::CLUSTER.id,
GenCommCluster::new(rand),
)
.chain(
endpoint_id,
nw_commissioning::CLUSTER.id,
NwCommCluster::new(rand),
)
.chain(
endpoint_id,
admin_commissioning::CLUSTER.id,
AdminCommCluster::new(pase, mdns_mgr, rand),
)
.chain(
endpoint_id,
noc::CLUSTER.id,
NocCluster::new(dev_att, fabric, acl, failsafe, mdns_mgr, epoch, rand),
)
.chain(
endpoint_id,
access_control::CLUSTER.id,
AccessControlCluster::new(acl, rand),
)
}

View file

@ -15,15 +15,21 @@
* limitations under the License. * limitations under the License.
*/ */
use crate::cmd_enter; use core::cell::RefCell;
use core::convert::TryInto;
use crate::data_model::objects::*; use crate::data_model::objects::*;
use crate::interaction_model::core::IMStatusCode; use crate::interaction_model::core::Transaction;
use crate::mdns::MdnsMgr;
use crate::secure_channel::pake::PaseMgr; use crate::secure_channel::pake::PaseMgr;
use crate::secure_channel::spake2p::VerifierData; use crate::secure_channel::spake2p::VerifierData;
use crate::tlv::{FromTLV, Nullable, OctetStr, TLVElement}; use crate::tlv::{FromTLV, Nullable, OctetStr, TLVElement};
use crate::{error::*, interaction_model::command::CommandReq}; use crate::utils::rand::Rand;
use log::{error, info}; use crate::{attribute_enum, cmd_enter};
use crate::{command_enum, error::*};
use log::info;
use num_derive::FromPrimitive; use num_derive::FromPrimitive;
use strum::{EnumDiscriminants, FromRepr};
pub const ID: u32 = 0x003C; pub const ID: u32 = 0x003C;
@ -34,120 +40,54 @@ pub enum WindowStatus {
BasicWindowOpen = 2, BasicWindowOpen = 2,
} }
#[derive(FromPrimitive)] #[derive(Copy, Clone, Debug, FromRepr, EnumDiscriminants)]
#[repr(u16)]
pub enum Attributes { pub enum Attributes {
WindowStatus = 0, WindowStatus(AttrType<u8>) = 0,
AdminFabricIndex = 1, AdminFabricIndex(AttrType<Nullable<u8>>) = 1,
AdminVendorId = 2, AdminVendorId(AttrType<Nullable<u8>>) = 2,
} }
#[derive(FromPrimitive)] attribute_enum!(Attributes);
#[derive(FromRepr)]
#[repr(u32)]
pub enum Commands { pub enum Commands {
OpenCommWindow = 0x00, OpenCommWindow = 0x00,
OpenBasicCommWindow = 0x01, OpenBasicCommWindow = 0x01,
RevokeComm = 0x02, RevokeComm = 0x02,
} }
fn attr_window_status_new() -> Attribute { command_enum!(Commands);
pub const CLUSTER: Cluster<'static> = Cluster {
id: ID as _,
feature_map: 0,
attributes: &[
FEATURE_MAP,
ATTRIBUTE_LIST,
Attribute::new( Attribute::new(
Attributes::WindowStatus as u16, AttributesDiscriminants::WindowStatus as u16,
AttrValue::Custom,
Access::RV, Access::RV,
Quality::NONE, Quality::NONE,
) ),
}
fn attr_admin_fabid_new() -> Attribute {
Attribute::new( Attribute::new(
Attributes::AdminFabricIndex as u16, AttributesDiscriminants::AdminFabricIndex as u16,
AttrValue::Custom,
Access::RV, Access::RV,
Quality::NULLABLE, Quality::NULLABLE,
) ),
}
fn attr_admin_vid_new() -> Attribute {
Attribute::new( Attribute::new(
Attributes::AdminVendorId as u16, AttributesDiscriminants::AdminVendorId as u16,
AttrValue::Custom,
Access::RV, Access::RV,
Quality::NULLABLE, Quality::NULLABLE,
) ),
} ],
commands: &[
pub struct AdminCommCluster { Commands::OpenCommWindow as _,
pase_mgr: PaseMgr, Commands::OpenBasicCommWindow as _,
base: Cluster, Commands::RevokeComm as _,
} ],
};
impl ClusterType for AdminCommCluster {
fn base(&self) -> &Cluster {
&self.base
}
fn base_mut(&mut self) -> &mut Cluster {
&mut self.base
}
fn read_custom_attribute(&self, encoder: &mut dyn Encoder, attr: &AttrDetails) {
match num::FromPrimitive::from_u16(attr.attr_id) {
Some(Attributes::WindowStatus) => {
let status = 1_u8;
encoder.encode(EncodeValue::Value(&status))
}
Some(Attributes::AdminVendorId) => {
let vid = Nullable::NotNull(1_u8);
encoder.encode(EncodeValue::Value(&vid))
}
Some(Attributes::AdminFabricIndex) => {
let vid = Nullable::NotNull(1_u8);
encoder.encode(EncodeValue::Value(&vid))
}
_ => {
error!("Unsupported Attribute: this shouldn't happen");
}
}
}
fn handle_command(&mut self, cmd_req: &mut CommandReq) -> Result<(), IMStatusCode> {
let cmd = cmd_req
.cmd
.path
.leaf
.map(num::FromPrimitive::from_u32)
.ok_or(IMStatusCode::UnsupportedCommand)?
.ok_or(IMStatusCode::UnsupportedCommand)?;
match cmd {
Commands::OpenCommWindow => self.handle_command_opencomm_win(cmd_req),
_ => Err(IMStatusCode::UnsupportedCommand),
}
}
}
impl AdminCommCluster {
pub fn new(pase_mgr: PaseMgr) -> Result<Box<Self>, Error> {
let mut c = Box::new(AdminCommCluster {
pase_mgr,
base: Cluster::new(ID)?,
});
c.base.add_attribute(attr_window_status_new())?;
c.base.add_attribute(attr_admin_fabid_new())?;
c.base.add_attribute(attr_admin_vid_new())?;
Ok(c)
}
fn handle_command_opencomm_win(
&mut self,
cmd_req: &mut CommandReq,
) -> Result<(), IMStatusCode> {
cmd_enter!("Open Commissioning Window");
let req =
OpenCommWindowReq::from_tlv(&cmd_req.data).map_err(|_| IMStatusCode::InvalidCommand)?;
let verifier = VerifierData::new(req.verifier.0, req.iterations, req.salt.0);
self.pase_mgr
.enable_pase_session(verifier, req.discriminator)?;
Err(IMStatusCode::Success)
}
}
#[derive(FromTLV)] #[derive(FromTLV)]
#[tlvargs(lifetime = "'a")] #[tlvargs(lifetime = "'a")]
@ -158,3 +98,94 @@ pub struct OpenCommWindowReq<'a> {
iterations: u32, iterations: u32,
salt: OctetStr<'a>, salt: OctetStr<'a>,
} }
pub struct AdminCommCluster<'a> {
data_ver: Dataver,
pase_mgr: &'a RefCell<PaseMgr>,
mdns_mgr: &'a RefCell<MdnsMgr<'a>>,
}
impl<'a> AdminCommCluster<'a> {
pub fn new(
pase_mgr: &'a RefCell<PaseMgr>,
mdns_mgr: &'a RefCell<MdnsMgr<'a>>,
rand: Rand,
) -> Self {
Self {
data_ver: Dataver::new(rand),
pase_mgr,
mdns_mgr,
}
}
pub fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
if let Some(writer) = encoder.with_dataver(self.data_ver.get())? {
if attr.is_system() {
CLUSTER.read(attr.attr_id, writer)
} else {
match attr.attr_id.try_into()? {
Attributes::WindowStatus(codec) => codec.encode(writer, 1),
Attributes::AdminVendorId(codec) => codec.encode(writer, Nullable::NotNull(1)),
Attributes::AdminFabricIndex(codec) => {
codec.encode(writer, Nullable::NotNull(1))
}
}
}
} else {
Ok(())
}
}
pub fn invoke(
&mut self,
cmd: &CmdDetails,
data: &TLVElement,
_encoder: CmdDataEncoder,
) -> Result<(), Error> {
match cmd.cmd_id.try_into()? {
Commands::OpenCommWindow => self.handle_command_opencomm_win(data)?,
_ => Err(Error::CommandNotFound)?,
}
self.data_ver.changed();
Ok(())
}
fn handle_command_opencomm_win(&mut self, data: &TLVElement) -> Result<(), Error> {
cmd_enter!("Open Commissioning Window");
let req = OpenCommWindowReq::from_tlv(data)?;
let verifier = VerifierData::new(req.verifier.0, req.iterations, req.salt.0);
self.pase_mgr.borrow_mut().enable_pase_session(
verifier,
req.discriminator,
&mut self.mdns_mgr.borrow_mut(),
)?;
Ok(())
}
}
impl<'a> Handler for AdminCommCluster<'a> {
fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
AdminCommCluster::read(self, attr, encoder)
}
fn invoke(
&mut self,
_transaction: &mut Transaction,
cmd: &CmdDetails,
data: &TLVElement,
encoder: CmdDataEncoder,
) -> Result<(), Error> {
AdminCommCluster::invoke(self, cmd, data, encoder)
}
}
impl<'a> NonBlockingHandler for AdminCommCluster<'a> {}
impl<'a> ChangeNotifier<()> for AdminCommCluster<'a> {
fn consume_change(&mut self) -> Option<()> {
self.data_ver.consume_change(())
}
}

View file

@ -17,7 +17,6 @@
use crate::{error::Error, transport::session::SessionMode}; use crate::{error::Error, transport::session::SessionMode};
use log::error; use log::error;
use std::sync::RwLock;
#[derive(PartialEq)] #[derive(PartialEq)]
#[allow(dead_code)] #[allow(dead_code)]
@ -42,26 +41,19 @@ pub enum State {
Armed(ArmedCtx), Armed(ArmedCtx),
} }
pub struct FailSafeInner { pub struct FailSafe {
state: State, state: State,
} }
pub struct FailSafe {
state: RwLock<FailSafeInner>,
}
impl FailSafe { impl FailSafe {
pub fn new() -> Self { pub const fn new() -> Self {
Self { Self { state: State::Idle }
state: RwLock::new(FailSafeInner { state: State::Idle }),
}
} }
pub fn arm(&self, timeout: u8, session_mode: SessionMode) -> Result<(), Error> { pub fn arm(&mut self, timeout: u8, session_mode: SessionMode) -> Result<(), Error> {
let mut inner = self.state.write()?; match &mut self.state {
match &mut inner.state {
State::Idle => { State::Idle => {
inner.state = State::Armed(ArmedCtx { self.state = State::Armed(ArmedCtx {
session_mode, session_mode,
timeout, timeout,
noc_state: NocState::NocNotRecvd, noc_state: NocState::NocNotRecvd,
@ -78,9 +70,8 @@ impl FailSafe {
Ok(()) Ok(())
} }
pub fn disarm(&self, session_mode: SessionMode) -> Result<(), Error> { pub fn disarm(&mut self, session_mode: SessionMode) -> Result<(), Error> {
let mut inner = self.state.write()?; match &mut self.state {
match &mut inner.state {
State::Idle => { State::Idle => {
error!("Received Fail-Safe Disarm without it being armed"); error!("Received Fail-Safe Disarm without it being armed");
return Err(Error::Invalid); return Err(Error::Invalid);
@ -102,19 +93,18 @@ impl FailSafe {
} }
} }
} }
inner.state = State::Idle; self.state = State::Idle;
} }
} }
Ok(()) Ok(())
} }
pub fn is_armed(&self) -> bool { pub fn is_armed(&self) -> bool {
self.state.read().unwrap().state != State::Idle self.state != State::Idle
} }
pub fn record_add_noc(&self, fabric_index: u8) -> Result<(), Error> { pub fn record_add_noc(&mut self, fabric_index: u8) -> Result<(), Error> {
let mut inner = self.state.write()?; match &mut self.state {
match &mut inner.state {
State::Idle => Err(Error::Invalid), State::Idle => Err(Error::Invalid),
State::Armed(c) => { State::Armed(c) => {
if c.noc_state == NocState::NocNotRecvd { if c.noc_state == NocState::NocNotRecvd {
@ -128,8 +118,7 @@ impl FailSafe {
} }
pub fn allow_noc_change(&self) -> Result<bool, Error> { pub fn allow_noc_change(&self) -> Result<bool, Error> {
let mut inner = self.state.write()?; let allow = match &self.state {
let allow = match &mut inner.state {
State::Idle => false, State::Idle => false,
State::Armed(c) => c.noc_state == NocState::NocNotRecvd, State::Armed(c) => c.noc_state == NocState::NocNotRecvd,
}; };

View file

@ -15,16 +15,19 @@
* limitations under the License. * limitations under the License.
*/ */
use crate::cmd_enter; use core::cell::RefCell;
use core::convert::TryInto;
use crate::data_model::objects::*; use crate::data_model::objects::*;
use crate::data_model::sdm::failsafe::FailSafe; use crate::data_model::sdm::failsafe::FailSafe;
use crate::interaction_model::core::IMStatusCode; use crate::interaction_model::core::Transaction;
use crate::interaction_model::messages::ib; use crate::tlv::{FromTLV, TLVElement, TLVWriter, TagType, ToTLV, UtfStr};
use crate::tlv::{FromTLV, TLVElement, TLVWriter, TagType, ToTLV}; use crate::transport::session::Session;
use crate::{error::*, interaction_model::command::CommandReq}; use crate::utils::rand::Rand;
use log::{error, info}; use crate::{attribute_enum, cmd_enter};
use num_derive::FromPrimitive; use crate::{command_enum, error::*};
use std::sync::Arc; use log::info;
use strum::{EnumDiscriminants, FromRepr};
#[derive(Clone, Copy)] #[derive(Clone, Copy)]
#[allow(dead_code)] #[allow(dead_code)]
@ -38,65 +41,80 @@ enum CommissioningError {
pub const ID: u32 = 0x0030; pub const ID: u32 = 0x0030;
#[derive(FromPrimitive)] #[derive(FromRepr, EnumDiscriminants)]
#[repr(u16)]
pub enum Attributes { pub enum Attributes {
BreadCrumb = 0, BreadCrumb(AttrType<u64>) = 0,
BasicCommissioningInfo = 1, BasicCommissioningInfo(()) = 1,
RegConfig = 2, RegConfig(AttrType<u8>) = 2,
LocationCapability = 3, LocationCapability(AttrType<u8>) = 3,
} }
#[derive(FromPrimitive)] attribute_enum!(Attributes);
#[derive(FromRepr)]
#[repr(u32)]
pub enum Commands { pub enum Commands {
ArmFailsafe = 0x00, ArmFailsafe = 0x00,
ArmFailsafeResp = 0x01,
SetRegulatoryConfig = 0x02, SetRegulatoryConfig = 0x02,
SetRegulatoryConfigResp = 0x03,
CommissioningComplete = 0x04, CommissioningComplete = 0x04,
}
command_enum!(Commands);
#[repr(u16)]
pub enum RespCommands {
ArmFailsafeResp = 0x01,
SetRegulatoryConfigResp = 0x03,
CommissioningCompleteResp = 0x05, CommissioningCompleteResp = 0x05,
} }
#[derive(FromTLV, ToTLV)]
#[tlvargs(lifetime = "'a")]
struct CommonResponse<'a> {
error_code: u8,
debug_txt: UtfStr<'a>,
}
pub enum RegLocationType { pub enum RegLocationType {
Indoor = 0, Indoor = 0,
Outdoor = 1, Outdoor = 1,
IndoorOutdoor = 2, IndoorOutdoor = 2,
} }
fn attr_bread_crumb_new(bread_crumb: u64) -> Attribute { pub const CLUSTER: Cluster<'static> = Cluster {
id: ID as _,
feature_map: 0,
attributes: &[
FEATURE_MAP,
ATTRIBUTE_LIST,
Attribute::new( Attribute::new(
Attributes::BreadCrumb as u16, AttributesDiscriminants::BreadCrumb as u16,
AttrValue::Uint64(bread_crumb), Access::READ.union(Access::WRITE).union(Access::NEED_ADMIN),
Access::READ | Access::WRITE | Access::NEED_ADMIN,
Quality::NONE, Quality::NONE,
) ),
}
fn attr_reg_config_new(reg_config: RegLocationType) -> Attribute {
Attribute::new( Attribute::new(
Attributes::RegConfig as u16, AttributesDiscriminants::RegConfig as u16,
AttrValue::Uint8(reg_config as u8),
Access::RV, Access::RV,
Quality::NONE, Quality::NONE,
) ),
}
fn attr_location_capability_new(reg_config: RegLocationType) -> Attribute {
Attribute::new( Attribute::new(
Attributes::LocationCapability as u16, AttributesDiscriminants::LocationCapability as u16,
AttrValue::Uint8(reg_config as u8),
Access::RV, Access::RV,
Quality::FIXED, Quality::FIXED,
) ),
}
fn attr_comm_info_new() -> Attribute {
Attribute::new( Attribute::new(
Attributes::BasicCommissioningInfo as u16, AttributesDiscriminants::BasicCommissioningInfo as u16,
AttrValue::Custom,
Access::RV, Access::RV,
Quality::FIXED, Quality::FIXED,
) ),
} ],
commands: &[
Commands::ArmFailsafe as _,
Commands::SetRegulatoryConfig as _,
Commands::CommissioningComplete as _,
],
};
#[derive(FromTLV, ToTLV)] #[derive(FromTLV, ToTLV)]
struct FailSafeParams { struct FailSafeParams {
@ -105,143 +123,134 @@ struct FailSafeParams {
} }
pub struct GenCommCluster { pub struct GenCommCluster {
data_ver: Dataver,
expiry_len: u16, expiry_len: u16,
failsafe: Arc<FailSafe>, failsafe: RefCell<FailSafe>,
base: Cluster,
}
impl ClusterType for GenCommCluster {
fn base(&self) -> &Cluster {
&self.base
}
fn base_mut(&mut self) -> &mut Cluster {
&mut self.base
}
fn read_custom_attribute(&self, encoder: &mut dyn Encoder, attr: &AttrDetails) {
match num::FromPrimitive::from_u16(attr.attr_id) {
Some(Attributes::BasicCommissioningInfo) => {
encoder.encode(EncodeValue::Closure(&|tag, tw| {
let _ = tw.start_struct(tag);
let _ = tw.u16(TagType::Context(0), self.expiry_len);
let _ = tw.end_container();
}))
}
_ => {
error!("Unsupported Attribute: this shouldn't happen");
}
}
}
fn handle_command(&mut self, cmd_req: &mut CommandReq) -> Result<(), IMStatusCode> {
let cmd = cmd_req
.cmd
.path
.leaf
.map(num::FromPrimitive::from_u32)
.ok_or(IMStatusCode::UnsupportedCommand)?
.ok_or(IMStatusCode::UnsupportedCommand)?;
match cmd {
Commands::ArmFailsafe => self.handle_command_armfailsafe(cmd_req),
Commands::SetRegulatoryConfig => self.handle_command_setregulatoryconfig(cmd_req),
Commands::CommissioningComplete => self.handle_command_commissioningcomplete(cmd_req),
_ => Err(IMStatusCode::UnsupportedCommand),
}
}
} }
impl GenCommCluster { impl GenCommCluster {
pub fn new() -> Result<Box<Self>, Error> { pub fn new(rand: Rand) -> Self {
let failsafe = Arc::new(FailSafe::new()); Self {
data_ver: Dataver::new(rand),
let mut c = Box::new(GenCommCluster { failsafe: RefCell::new(FailSafe::new()),
// TODO: Arch-Specific // TODO: Arch-Specific
expiry_len: 120, expiry_len: 120,
failsafe, }
base: Cluster::new(ID)?,
});
c.base.add_attribute(attr_bread_crumb_new(0))?;
// TODO: Arch-Specific
c.base
.add_attribute(attr_reg_config_new(RegLocationType::IndoorOutdoor))?;
// TODO: Arch-Specific
c.base
.add_attribute(attr_location_capability_new(RegLocationType::IndoorOutdoor))?;
c.base.add_attribute(attr_comm_info_new())?;
Ok(c)
} }
pub fn failsafe(&self) -> Arc<FailSafe> { pub fn failsafe(&self) -> &RefCell<FailSafe> {
self.failsafe.clone() &self.failsafe
} }
fn handle_command_armfailsafe(&mut self, cmd_req: &mut CommandReq) -> Result<(), IMStatusCode> { pub fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
if let Some(mut writer) = encoder.with_dataver(self.data_ver.get())? {
if attr.is_system() {
CLUSTER.read(attr.attr_id, writer)
} else {
match attr.attr_id.try_into()? {
Attributes::BreadCrumb(codec) => codec.encode(writer, 0),
// TODO: Arch-Specific
Attributes::RegConfig(codec) => {
codec.encode(writer, RegLocationType::IndoorOutdoor as _)
}
// TODO: Arch-Specific
Attributes::LocationCapability(codec) => {
codec.encode(writer, RegLocationType::IndoorOutdoor as _)
}
Attributes::BasicCommissioningInfo(_) => {
writer.start_struct(AttrDataWriter::TAG)?;
writer.u16(TagType::Context(0), self.expiry_len)?;
writer.end_container()?;
writer.complete()
}
}
}
} else {
Ok(())
}
}
pub fn invoke(
&mut self,
session: &mut Session,
cmd: &CmdDetails,
data: &TLVElement,
encoder: CmdDataEncoder,
) -> Result<(), Error> {
match cmd.cmd_id.try_into()? {
Commands::ArmFailsafe => self.handle_command_armfailsafe(session, data, encoder)?,
Commands::SetRegulatoryConfig => {
self.handle_command_setregulatoryconfig(data, encoder)?
}
Commands::CommissioningComplete => {
self.handle_command_commissioningcomplete(session, encoder)?;
}
}
self.data_ver.changed();
Ok(())
}
fn handle_command_armfailsafe(
&mut self,
session: &Session,
data: &TLVElement,
encoder: CmdDataEncoder,
) -> Result<(), Error> {
cmd_enter!("ARM Fail Safe"); cmd_enter!("ARM Fail Safe");
let p = FailSafeParams::from_tlv(&cmd_req.data)?; let p = FailSafeParams::from_tlv(data)?;
let mut status = CommissioningError::Ok as u8;
if self self.failsafe
.failsafe .borrow_mut()
.arm(p.expiry_len, cmd_req.trans.session.get_session_mode()) .arm(p.expiry_len, session.get_session_mode())
.is_err() .map_err(|e| e.remap(|_| true, Error::Busy))?;
{
status = CommissioningError::ErrBusyWithOtherAdmin as u8;
}
let cmd_data = CommonResponse { let cmd_data = CommonResponse {
error_code: status, error_code: CommissioningError::ErrBusyWithOtherAdmin as u8,
debug_txt: "".to_owned(), debug_txt: UtfStr::new(b""),
}; };
let resp = ib::InvResp::cmd_new(
0, encoder
ID, .with_command(RespCommands::ArmFailsafeResp as _)?
Commands::ArmFailsafeResp as u16, .set(&cmd_data)
EncodeValue::Value(&cmd_data),
);
let _ = resp.to_tlv(cmd_req.resp, TagType::Anonymous);
cmd_req.trans.complete();
Ok(())
} }
fn handle_command_setregulatoryconfig( fn handle_command_setregulatoryconfig(
&mut self, &mut self,
cmd_req: &mut CommandReq, data: &TLVElement,
) -> Result<(), IMStatusCode> { encoder: CmdDataEncoder,
) -> Result<(), Error> {
cmd_enter!("Set Regulatory Config"); cmd_enter!("Set Regulatory Config");
let country_code = cmd_req let country_code = data
.data
.find_tag(1) .find_tag(1)
.map_err(|_| IMStatusCode::InvalidCommand)? .map_err(|_| Error::InvalidCommand)?
.slice() .slice()
.map_err(|_| IMStatusCode::InvalidCommand)?; .map_err(|_| Error::InvalidCommand)?;
info!("Received country code: {:?}", country_code); info!("Received country code: {:?}", country_code);
let cmd_data = CommonResponse { let cmd_data = CommonResponse {
error_code: 0, error_code: 0,
debug_txt: "".to_owned(), debug_txt: UtfStr::new(b""),
}; };
let resp = ib::InvResp::cmd_new(
0, encoder
ID, .with_command(RespCommands::SetRegulatoryConfigResp as _)?
Commands::SetRegulatoryConfigResp as u16, .set(&cmd_data)
EncodeValue::Value(&cmd_data),
);
let _ = resp.to_tlv(cmd_req.resp, TagType::Anonymous);
cmd_req.trans.complete();
Ok(())
} }
fn handle_command_commissioningcomplete( fn handle_command_commissioningcomplete(
&mut self, &mut self,
cmd_req: &mut CommandReq, session: &Session,
) -> Result<(), IMStatusCode> { encoder: CmdDataEncoder,
) -> Result<(), Error> {
cmd_enter!("Commissioning Complete"); cmd_enter!("Commissioning Complete");
let mut status: u8 = CommissioningError::Ok as u8; let mut status: u8 = CommissioningError::Ok as u8;
// Has to be a Case Session // Has to be a Case Session
if cmd_req.trans.session.get_local_fabric_idx().is_none() { if session.get_local_fabric_idx().is_none() {
status = CommissioningError::ErrInvalidAuth as u8; status = CommissioningError::ErrInvalidAuth as u8;
} }
@ -249,7 +258,8 @@ impl GenCommCluster {
// scope that is for this session // scope that is for this session
if self if self
.failsafe .failsafe
.disarm(cmd_req.trans.session.get_session_mode()) .borrow_mut()
.disarm(session.get_session_mode())
.is_err() .is_err()
{ {
status = CommissioningError::ErrInvalidAuth as u8; status = CommissioningError::ErrInvalidAuth as u8;
@ -257,22 +267,35 @@ impl GenCommCluster {
let cmd_data = CommonResponse { let cmd_data = CommonResponse {
error_code: status, error_code: status,
debug_txt: "".to_owned(), debug_txt: UtfStr::new(b""),
}; };
let resp = ib::InvResp::cmd_new(
0, encoder
ID, .with_command(RespCommands::CommissioningCompleteResp as _)?
Commands::CommissioningCompleteResp as u16, .set(&cmd_data)
EncodeValue::Value(&cmd_data),
);
let _ = resp.to_tlv(cmd_req.resp, TagType::Anonymous);
cmd_req.trans.complete();
Ok(())
} }
} }
#[derive(FromTLV, ToTLV)] impl Handler for GenCommCluster {
struct CommonResponse { fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
error_code: u8, GenCommCluster::read(self, attr, encoder)
debug_txt: String, }
fn invoke(
&mut self,
transaction: &mut Transaction,
cmd: &CmdDetails,
data: &TLVElement,
encoder: CmdDataEncoder,
) -> Result<(), Error> {
GenCommCluster::invoke(self, transaction.session_mut(), cmd, data, encoder)
}
}
impl NonBlockingHandler for GenCommCluster {}
impl ChangeNotifier<()> for GenCommCluster {
fn consume_change(&mut self) -> Option<()> {
self.data_ver.consume_change(())
}
} }

File diff suppressed because it is too large Load diff

View file

@ -16,38 +16,51 @@
*/ */
use crate::{ use crate::{
data_model::objects::{Cluster, ClusterType}, data_model::objects::{
AttrDataEncoder, AttrDetails, ChangeNotifier, Cluster, Dataver, Handler,
NonBlockingHandler, ATTRIBUTE_LIST, FEATURE_MAP,
},
error::Error, error::Error,
utils::rand::Rand,
}; };
pub const ID: u32 = 0x0031; pub const ID: u32 = 0x0031;
pub struct NwCommCluster {
base: Cluster,
}
impl ClusterType for NwCommCluster {
fn base(&self) -> &Cluster {
&self.base
}
fn base_mut(&mut self) -> &mut Cluster {
&mut self.base
}
}
enum FeatureMap { enum FeatureMap {
_Wifi = 0x01, _Wifi = 0x01,
_Thread = 0x02, _Thread = 0x02,
Ethernet = 0x04, Ethernet = 0x04,
} }
pub const CLUSTER: Cluster<'static> = Cluster {
id: ID as _,
feature_map: FeatureMap::Ethernet as _,
attributes: &[FEATURE_MAP, ATTRIBUTE_LIST],
commands: &[],
};
pub struct NwCommCluster {
data_ver: Dataver,
}
impl NwCommCluster { impl NwCommCluster {
pub fn new() -> Result<Box<Self>, Error> { pub fn new(rand: Rand) -> Self {
let mut c = Box::new(Self { Self {
base: Cluster::new(ID)?, data_ver: Dataver::new(rand),
}); }
// TODO: Arch-Specific }
c.base.set_feature_map(FeatureMap::Ethernet as u32)?; }
Ok(c)
impl Handler for NwCommCluster {
fn read(&self, _attr: &AttrDetails, _encoder: AttrDataEncoder) -> Result<(), Error> {
Err(Error::AttributeNotFound)
}
}
impl NonBlockingHandler for NwCommCluster {}
impl ChangeNotifier<()> for NwCommCluster {
fn consume_change(&mut self) -> Option<()> {
self.data_ver.consume_change(())
} }
} }

View file

@ -15,46 +15,130 @@
* limitations under the License. * limitations under the License.
*/ */
use std::sync::Arc; use core::cell::RefCell;
use core::convert::TryInto;
use num_derive::FromPrimitive; use strum::{EnumDiscriminants, FromRepr};
use crate::acl::{self, AclEntry, AclMgr}; use crate::acl::{AclEntry, AclMgr};
use crate::data_model::objects::*; use crate::data_model::objects::*;
use crate::error::*;
use crate::interaction_model::core::IMStatusCode;
use crate::interaction_model::messages::ib::{attr_list_write, ListOperation}; use crate::interaction_model::messages::ib::{attr_list_write, ListOperation};
use crate::tlv::{FromTLV, TLVElement, TagType, ToTLV}; use crate::tlv::{FromTLV, TLVElement, TagType, ToTLV};
use crate::utils::rand::Rand;
use crate::{attribute_enum, error::*};
use log::{error, info}; use log::{error, info};
pub const ID: u32 = 0x001F; pub const ID: u32 = 0x001F;
#[derive(FromPrimitive)] #[derive(FromRepr, EnumDiscriminants)]
#[repr(u16)]
pub enum Attributes { pub enum Attributes {
Acl = 0, Acl(()) = 0,
Extension = 1, Extension(()) = 1,
SubjectsPerEntry = 2, SubjectsPerEntry(AttrType<u16>) = 2,
TargetsPerEntry = 3, TargetsPerEntry(AttrType<u16>) = 3,
EntriesPerFabric = 4, EntriesPerFabric(AttrType<u16>) = 4,
} }
pub struct AccessControlCluster { attribute_enum!(Attributes);
base: Cluster,
acl_mgr: Arc<AclMgr>, pub const CLUSTER: Cluster<'static> = Cluster {
id: ID,
feature_map: 0,
attributes: &[
FEATURE_MAP,
ATTRIBUTE_LIST,
Attribute::new(
AttributesDiscriminants::Acl as u16,
Access::RWFA,
Quality::NONE,
),
Attribute::new(
AttributesDiscriminants::Extension as u16,
Access::RWFA,
Quality::NONE,
),
Attribute::new(
AttributesDiscriminants::SubjectsPerEntry as u16,
Access::RV,
Quality::FIXED,
),
Attribute::new(
AttributesDiscriminants::TargetsPerEntry as u16,
Access::RV,
Quality::FIXED,
),
Attribute::new(
AttributesDiscriminants::EntriesPerFabric as u16,
Access::RV,
Quality::FIXED,
),
],
commands: &[],
};
pub struct AccessControlCluster<'a> {
data_ver: Dataver,
acl_mgr: &'a RefCell<AclMgr>,
} }
impl AccessControlCluster { impl<'a> AccessControlCluster<'a> {
pub fn new(acl_mgr: Arc<AclMgr>) -> Result<Box<Self>, Error> { pub fn new(acl_mgr: &'a RefCell<AclMgr>, rand: Rand) -> Self {
let mut c = Box::new(AccessControlCluster { Self {
base: Cluster::new(ID)?, data_ver: Dataver::new(rand),
acl_mgr, acl_mgr,
}); }
c.base.add_attribute(attr_acl_new())?; }
c.base.add_attribute(attr_extension_new())?;
c.base.add_attribute(attr_subjects_per_entry_new())?; pub fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
c.base.add_attribute(attr_targets_per_entry_new())?; if let Some(mut writer) = encoder.with_dataver(self.data_ver.get())? {
c.base.add_attribute(attr_entries_per_fabric_new())?; if attr.is_system() {
Ok(c) CLUSTER.read(attr.attr_id, writer)
} else {
match attr.attr_id.try_into()? {
Attributes::Acl(_) => {
writer.start_array(AttrDataWriter::TAG)?;
self.acl_mgr.borrow().for_each_acl(|entry| {
if !attr.fab_filter || Some(attr.fab_idx) == entry.fab_idx {
entry.to_tlv(&mut writer, TagType::Anonymous)?;
}
Ok(())
})?;
writer.end_container()?;
writer.complete()
}
Attributes::Extension(_) => {
// Empty for now
writer.start_array(AttrDataWriter::TAG)?;
writer.end_container()?;
writer.complete()
}
_ => {
error!("Attribute not yet supported: this shouldn't happen");
Err(Error::AttributeNotFound)
}
}
}
} else {
Ok(())
}
}
pub fn write(&mut self, attr: &AttrDetails, data: AttrData) -> Result<(), Error> {
match attr.attr_id.try_into()? {
Attributes::Acl(_) => {
attr_list_write(attr, data.with_dataver(self.data_ver.get())?, |op, data| {
self.write_acl_attr(&op, data, attr.fab_idx)
})
}
_ => {
error!("Attribute not yet supported: this shouldn't happen");
Err(Error::AttributeNotFound)
}
}
} }
/// Write the ACL Attribute /// Write the ACL Attribute
@ -66,141 +150,59 @@ impl AccessControlCluster {
op: &ListOperation, op: &ListOperation,
data: &TLVElement, data: &TLVElement,
fab_idx: u8, fab_idx: u8,
) -> Result<(), IMStatusCode> { ) -> Result<(), Error> {
info!("Performing ACL operation {:?}", op); info!("Performing ACL operation {:?}", op);
let result = match op { match op {
ListOperation::AddItem | ListOperation::EditItem(_) => { ListOperation::AddItem | ListOperation::EditItem(_) => {
let mut acl_entry = let mut acl_entry = AclEntry::from_tlv(data)?;
AclEntry::from_tlv(data).map_err(|_| IMStatusCode::ConstraintError)?;
info!("ACL {:?}", acl_entry); info!("ACL {:?}", acl_entry);
// Overwrite the fabric index with our accessing fabric index // Overwrite the fabric index with our accessing fabric index
acl_entry.fab_idx = Some(fab_idx); acl_entry.fab_idx = Some(fab_idx);
if let ListOperation::EditItem(index) = op { if let ListOperation::EditItem(index) = op {
self.acl_mgr.edit(*index as u8, fab_idx, acl_entry) self.acl_mgr
.borrow_mut()
.edit(*index as u8, fab_idx, acl_entry)
} else { } else {
self.acl_mgr.add(acl_entry) self.acl_mgr.borrow_mut().add(acl_entry)
} }
} }
ListOperation::DeleteItem(index) => self.acl_mgr.delete(*index as u8, fab_idx), ListOperation::DeleteItem(index) => {
ListOperation::DeleteList => self.acl_mgr.delete_for_fabric(fab_idx), self.acl_mgr.borrow_mut().delete(*index as u8, fab_idx)
}; }
match result { ListOperation::DeleteList => self.acl_mgr.borrow_mut().delete_for_fabric(fab_idx),
Ok(_) => Ok(()),
Err(Error::NoSpace) => Err(IMStatusCode::ResourceExhausted),
_ => Err(IMStatusCode::ConstraintError),
} }
} }
} }
impl ClusterType for AccessControlCluster { impl<'a> Handler for AccessControlCluster<'a> {
fn base(&self) -> &Cluster { fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
&self.base AccessControlCluster::read(self, attr, encoder)
}
fn base_mut(&mut self) -> &mut Cluster {
&mut self.base
} }
fn read_custom_attribute(&self, encoder: &mut dyn Encoder, attr: &AttrDetails) { fn write(&mut self, attr: &AttrDetails, data: AttrData) -> Result<(), Error> {
match num::FromPrimitive::from_u16(attr.attr_id) { AccessControlCluster::write(self, attr, data)
Some(Attributes::Acl) => encoder.encode(EncodeValue::Closure(&|tag, tw| {
let _ = tw.start_array(tag);
let _ = self.acl_mgr.for_each_acl(|entry| {
if !attr.fab_filter || Some(attr.fab_idx) == entry.fab_idx {
let _ = entry.to_tlv(tw, TagType::Anonymous);
}
});
let _ = tw.end_container();
})),
Some(Attributes::Extension) => encoder.encode(EncodeValue::Closure(&|tag, tw| {
// Empty for now
let _ = tw.start_array(tag);
let _ = tw.end_container();
})),
_ => {
error!("Attribute not yet supported: this shouldn't happen");
}
}
}
fn write_attribute(
&mut self,
attr: &AttrDetails,
data: &TLVElement,
) -> Result<(), IMStatusCode> {
let result = if let Some(Attributes::Acl) = num::FromPrimitive::from_u16(attr.attr_id) {
attr_list_write(attr, data, |op, data| {
self.write_acl_attr(&op, data, attr.fab_idx)
})
} else {
error!("Attribute not yet supported: this shouldn't happen");
Err(IMStatusCode::NotFound)
};
if result.is_ok() {
self.base.cluster_changed();
}
result
} }
} }
fn attr_acl_new() -> Attribute { impl<'a> NonBlockingHandler for AccessControlCluster<'a> {}
Attribute::new(
Attributes::Acl as u16,
AttrValue::Custom,
Access::RWFA,
Quality::NONE,
)
}
fn attr_extension_new() -> Attribute { impl<'a> ChangeNotifier<()> for AccessControlCluster<'a> {
Attribute::new( fn consume_change(&mut self) -> Option<()> {
Attributes::Extension as u16, self.data_ver.consume_change(())
AttrValue::Custom, }
Access::RWFA,
Quality::NONE,
)
}
fn attr_subjects_per_entry_new() -> Attribute {
Attribute::new(
Attributes::SubjectsPerEntry as u16,
AttrValue::Uint16(acl::SUBJECTS_PER_ENTRY as u16),
Access::RV,
Quality::FIXED,
)
}
fn attr_targets_per_entry_new() -> Attribute {
Attribute::new(
Attributes::TargetsPerEntry as u16,
AttrValue::Uint16(acl::TARGETS_PER_ENTRY as u16),
Access::RV,
Quality::FIXED,
)
}
fn attr_entries_per_fabric_new() -> Attribute {
Attribute::new(
Attributes::EntriesPerFabric as u16,
AttrValue::Uint16(acl::ENTRIES_PER_FABRIC as u16),
Access::RV,
Quality::FIXED,
)
} }
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use std::sync::Arc; use core::cell::RefCell;
use crate::{ use crate::{
acl::{AclEntry, AclMgr, AuthMode}, acl::{AclEntry, AclMgr, AuthMode},
data_model::{ data_model::objects::{AttrDataEncoder, AttrDetails, Node, Privilege},
core::read::AttrReadEncoder,
objects::{AttrDetails, ClusterType, Privilege},
},
interaction_model::messages::ib::ListOperation, interaction_model::messages::ib::ListOperation,
tlv::{get_root_node_struct, ElementType, TLVElement, TLVWriter, TagType, ToTLV}, tlv::{get_root_node_struct, ElementType, TLVElement, TLVWriter, TagType, ToTLV},
utils::writebuf::WriteBuf, utils::{rand::dummy_rand, writebuf::WriteBuf},
}; };
use super::AccessControlCluster; use super::AccessControlCluster;
@ -209,16 +211,15 @@ mod tests {
/// Add an ACL entry /// Add an ACL entry
fn acl_cluster_add() { fn acl_cluster_add() {
let mut buf: [u8; 100] = [0; 100]; let mut buf: [u8; 100] = [0; 100];
let buf_len = buf.len(); let mut writebuf = WriteBuf::new(&mut buf);
let mut writebuf = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut writebuf); let mut tw = TLVWriter::new(&mut writebuf);
let acl_mgr = Arc::new(AclMgr::new_with(false).unwrap()); let acl_mgr = RefCell::new(AclMgr::new());
let mut acl = AccessControlCluster::new(acl_mgr.clone()).unwrap(); let mut acl = AccessControlCluster::new(&acl_mgr, dummy_rand);
let new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
new.to_tlv(&mut tw, TagType::Anonymous).unwrap(); new.to_tlv(&mut tw, TagType::Anonymous).unwrap();
let data = get_root_node_struct(writebuf.as_borrow_slice()).unwrap(); let data = get_root_node_struct(writebuf.as_slice()).unwrap();
// Test, ACL has fabric index 2, but the accessing fabric is 1 // Test, ACL has fabric index 2, but the accessing fabric is 1
// the fabric index in the TLV should be ignored and the ACL should be created with entry 1 // the fabric index in the TLV should be ignored and the ACL should be created with entry 1
@ -227,8 +228,10 @@ mod tests {
let verifier = AclEntry::new(1, Privilege::VIEW, AuthMode::Case); let verifier = AclEntry::new(1, Privilege::VIEW, AuthMode::Case);
acl_mgr acl_mgr
.borrow()
.for_each_acl(|a| { .for_each_acl(|a| {
assert_eq!(*a, verifier); assert_eq!(*a, verifier);
Ok(())
}) })
.unwrap(); .unwrap();
} }
@ -237,25 +240,24 @@ mod tests {
/// - The listindex used for edit should be relative to the current fabric /// - The listindex used for edit should be relative to the current fabric
fn acl_cluster_edit() { fn acl_cluster_edit() {
let mut buf: [u8; 100] = [0; 100]; let mut buf: [u8; 100] = [0; 100];
let buf_len = buf.len(); let mut writebuf = WriteBuf::new(&mut buf);
let mut writebuf = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut writebuf); let mut tw = TLVWriter::new(&mut writebuf);
// Add 3 ACLs, belonging to fabric index 2, 1 and 2, in that order // Add 3 ACLs, belonging to fabric index 2, 1 and 2, in that order
let acl_mgr = Arc::new(AclMgr::new_with(false).unwrap()); let acl_mgr = RefCell::new(AclMgr::new());
let mut verifier = [ let mut verifier = [
AclEntry::new(2, Privilege::VIEW, AuthMode::Case), AclEntry::new(2, Privilege::VIEW, AuthMode::Case),
AclEntry::new(1, Privilege::VIEW, AuthMode::Case), AclEntry::new(1, Privilege::VIEW, AuthMode::Case),
AclEntry::new(2, Privilege::ADMIN, AuthMode::Case), AclEntry::new(2, Privilege::ADMIN, AuthMode::Case),
]; ];
for i in verifier { for i in verifier {
acl_mgr.add(i).unwrap(); acl_mgr.borrow_mut().add(i).unwrap();
} }
let mut acl = AccessControlCluster::new(acl_mgr.clone()).unwrap(); let mut acl = AccessControlCluster::new(&acl_mgr, dummy_rand);
let new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case); let new = AclEntry::new(2, Privilege::VIEW, AuthMode::Case);
new.to_tlv(&mut tw, TagType::Anonymous).unwrap(); new.to_tlv(&mut tw, TagType::Anonymous).unwrap();
let data = get_root_node_struct(writebuf.as_borrow_slice()).unwrap(); let data = get_root_node_struct(writebuf.as_slice()).unwrap();
// Test, Edit Fabric 2's index 1 - with accessing fabring as 2 - allow // Test, Edit Fabric 2's index 1 - with accessing fabring as 2 - allow
let result = acl.write_acl_attr(&ListOperation::EditItem(1), &data, 2); let result = acl.write_acl_attr(&ListOperation::EditItem(1), &data, 2);
@ -266,9 +268,11 @@ mod tests {
// Also validate in the acl_mgr that the entries are in the right order // Also validate in the acl_mgr that the entries are in the right order
let mut index = 0; let mut index = 0;
acl_mgr acl_mgr
.borrow()
.for_each_acl(|a| { .for_each_acl(|a| {
assert_eq!(*a, verifier[index]); assert_eq!(*a, verifier[index]);
index += 1; index += 1;
Ok(())
}) })
.unwrap(); .unwrap();
} }
@ -277,16 +281,16 @@ mod tests {
/// - The listindex used for delete should be relative to the current fabric /// - The listindex used for delete should be relative to the current fabric
fn acl_cluster_delete() { fn acl_cluster_delete() {
// Add 3 ACLs, belonging to fabric index 2, 1 and 2, in that order // Add 3 ACLs, belonging to fabric index 2, 1 and 2, in that order
let acl_mgr = Arc::new(AclMgr::new_with(false).unwrap()); let acl_mgr = RefCell::new(AclMgr::new());
let input = [ let input = [
AclEntry::new(2, Privilege::VIEW, AuthMode::Case), AclEntry::new(2, Privilege::VIEW, AuthMode::Case),
AclEntry::new(1, Privilege::VIEW, AuthMode::Case), AclEntry::new(1, Privilege::VIEW, AuthMode::Case),
AclEntry::new(2, Privilege::ADMIN, AuthMode::Case), AclEntry::new(2, Privilege::ADMIN, AuthMode::Case),
]; ];
for i in input { for i in input {
acl_mgr.add(i).unwrap(); acl_mgr.borrow_mut().add(i).unwrap();
} }
let mut acl = AccessControlCluster::new(acl_mgr.clone()).unwrap(); let mut acl = AccessControlCluster::new(&acl_mgr, dummy_rand);
// data is don't-care actually // data is don't-care actually
let data = TLVElement::new(TagType::Anonymous, ElementType::True); let data = TLVElement::new(TagType::Anonymous, ElementType::True);
@ -298,9 +302,11 @@ mod tests {
// Also validate in the acl_mgr that the entries are in the right order // Also validate in the acl_mgr that the entries are in the right order
let mut index = 0; let mut index = 0;
acl_mgr acl_mgr
.borrow()
.for_each_acl(|a| { .for_each_acl(|a| {
assert_eq!(*a, verifier[index]); assert_eq!(*a, verifier[index]);
index += 1; index += 1;
Ok(())
}) })
.unwrap(); .unwrap();
} }
@ -309,84 +315,126 @@ mod tests {
/// - acl read with and without fabric filtering /// - acl read with and without fabric filtering
fn acl_cluster_read() { fn acl_cluster_read() {
let mut buf: [u8; 100] = [0; 100]; let mut buf: [u8; 100] = [0; 100];
let buf_len = buf.len(); let mut writebuf = WriteBuf::new(&mut buf);
let mut writebuf = WriteBuf::new(&mut buf, buf_len);
// Add 3 ACLs, belonging to fabric index 2, 1 and 2, in that order // Add 3 ACLs, belonging to fabric index 2, 1 and 2, in that order
let acl_mgr = Arc::new(AclMgr::new_with(false).unwrap()); let acl_mgr = RefCell::new(AclMgr::new());
let input = [ let input = [
AclEntry::new(2, Privilege::VIEW, AuthMode::Case), AclEntry::new(2, Privilege::VIEW, AuthMode::Case),
AclEntry::new(1, Privilege::VIEW, AuthMode::Case), AclEntry::new(1, Privilege::VIEW, AuthMode::Case),
AclEntry::new(2, Privilege::ADMIN, AuthMode::Case), AclEntry::new(2, Privilege::ADMIN, AuthMode::Case),
]; ];
for i in input { for i in input {
acl_mgr.add(i).unwrap(); acl_mgr.borrow_mut().add(i).unwrap();
} }
let acl = AccessControlCluster::new(acl_mgr).unwrap(); let acl = AccessControlCluster::new(&acl_mgr, dummy_rand);
// Test 1, all 3 entries are read in the response without fabric filtering // Test 1, all 3 entries are read in the response without fabric filtering
{ {
let mut tw = TLVWriter::new(&mut writebuf); let attr = AttrDetails {
let mut encoder = AttrReadEncoder::new(&mut tw); node: &Node {
let attr_details = AttrDetails { id: 0,
endpoints: &[],
},
endpoint_id: 0,
cluster_id: 0,
attr_id: 0, attr_id: 0,
list_index: None, list_index: None,
fab_idx: 1, fab_idx: 1,
fab_filter: false, fab_filter: false,
dataver: None,
wildcard: false,
}; };
acl.read_custom_attribute(&mut encoder, &attr_details);
let mut tw = TLVWriter::new(&mut writebuf);
let encoder = AttrDataEncoder::new(&attr, &mut tw);
acl.read(&attr, encoder).unwrap();
assert_eq!( assert_eq!(
// &[
// 21, 53, 1, 36, 0, 0, 55, 1, 24, 54, 2, 21, 36, 1, 1, 36, 2, 2, 54, 3, 24, 54,
// 4, 24, 36, 254, 2, 24, 21, 36, 1, 1, 36, 2, 2, 54, 3, 24, 54, 4, 24, 36, 254,
// 1, 24, 21, 36, 1, 5, 36, 2, 2, 54, 3, 24, 54, 4, 24, 36, 254, 2, 24, 24, 24,
// 24
// ],
&[ &[
21, 53, 1, 36, 0, 0, 55, 1, 24, 54, 2, 21, 36, 1, 1, 36, 2, 2, 54, 3, 24, 54, 21, 53, 1, 36, 0, 0, 55, 1, 36, 2, 0, 36, 3, 0, 36, 4, 0, 24, 54, 2, 21, 36, 1,
4, 24, 36, 254, 2, 24, 21, 36, 1, 1, 36, 2, 2, 54, 3, 24, 54, 4, 24, 36, 254, 1, 36, 2, 2, 54, 3, 24, 54, 4, 24, 36, 254, 2, 24, 21, 36, 1, 1, 36, 2, 2, 54,
1, 24, 21, 36, 1, 5, 36, 2, 2, 54, 3, 24, 54, 4, 24, 36, 254, 2, 24, 24, 24, 3, 24, 54, 4, 24, 36, 254, 1, 24, 21, 36, 1, 5, 36, 2, 2, 54, 3, 24, 54, 4, 24,
24 36, 254, 2, 24, 24, 24, 24
], ],
writebuf.as_borrow_slice() writebuf.as_slice()
); );
} }
writebuf.reset(0); writebuf.reset(0);
// Test 2, only single entry is read in the response with fabric filtering and fabric idx 1 // Test 2, only single entry is read in the response with fabric filtering and fabric idx 1
{ {
let mut tw = TLVWriter::new(&mut writebuf); let attr = AttrDetails {
let mut encoder = AttrReadEncoder::new(&mut tw); node: &Node {
id: 0,
let attr_details = AttrDetails { endpoints: &[],
},
endpoint_id: 0,
cluster_id: 0,
attr_id: 0, attr_id: 0,
list_index: None, list_index: None,
fab_idx: 1, fab_idx: 1,
fab_filter: true, fab_filter: true,
dataver: None,
wildcard: false,
}; };
acl.read_custom_attribute(&mut encoder, &attr_details);
let mut tw = TLVWriter::new(&mut writebuf);
let encoder = AttrDataEncoder::new(&attr, &mut tw);
acl.read(&attr, encoder).unwrap();
assert_eq!( assert_eq!(
// &[
// 21, 53, 1, 36, 0, 0, 55, 1, 24, 54, 2, 21, 36, 1, 1, 36, 2, 2, 54, 3, 24, 54,
// 4, 24, 36, 254, 1, 24, 24, 24, 24
// ],
&[ &[
21, 53, 1, 36, 0, 0, 55, 1, 24, 54, 2, 21, 36, 1, 1, 36, 2, 2, 54, 3, 24, 54, 21, 53, 1, 36, 0, 0, 55, 1, 36, 2, 0, 36, 3, 0, 36, 4, 0, 24, 54, 2, 21, 36, 1,
4, 24, 36, 254, 1, 24, 24, 24, 24 1, 36, 2, 2, 54, 3, 24, 54, 4, 24, 36, 254, 1, 24, 24, 24, 24
], ],
writebuf.as_borrow_slice() writebuf.as_slice()
); );
} }
writebuf.reset(0); writebuf.reset(0);
// Test 3, only single entry is read in the response with fabric filtering and fabric idx 2 // Test 3, only single entry is read in the response with fabric filtering and fabric idx 2
{ {
let mut tw = TLVWriter::new(&mut writebuf); let attr = AttrDetails {
let mut encoder = AttrReadEncoder::new(&mut tw); node: &Node {
id: 0,
let attr_details = AttrDetails { endpoints: &[],
},
endpoint_id: 0,
cluster_id: 0,
attr_id: 0, attr_id: 0,
list_index: None, list_index: None,
fab_idx: 2, fab_idx: 2,
fab_filter: true, fab_filter: true,
dataver: None,
wildcard: false,
}; };
acl.read_custom_attribute(&mut encoder, &attr_details);
let mut tw = TLVWriter::new(&mut writebuf);
let encoder = AttrDataEncoder::new(&attr, &mut tw);
acl.read(&attr, encoder).unwrap();
assert_eq!( assert_eq!(
// &[
// 21, 53, 1, 36, 0, 0, 55, 1, 24, 54, 2, 21, 36, 1, 1, 36, 2, 2, 54, 3, 24, 54,
// 4, 24, 36, 254, 2, 24, 21, 36, 1, 5, 36, 2, 2, 54, 3, 24, 54, 4, 24, 36, 254,
// 2, 24, 24, 24, 24
// ],
&[ &[
21, 53, 1, 36, 0, 0, 55, 1, 24, 54, 2, 21, 36, 1, 1, 36, 2, 2, 54, 3, 24, 54, 21, 53, 1, 36, 0, 0, 55, 1, 36, 2, 0, 36, 3, 0, 36, 4, 0, 24, 54, 2, 21, 36, 1,
4, 24, 36, 254, 2, 24, 21, 36, 1, 5, 36, 2, 2, 54, 3, 24, 54, 4, 24, 36, 254, 1, 36, 2, 2, 54, 3, 24, 54, 4, 24, 36, 254, 2, 24, 21, 36, 1, 5, 36, 2, 2, 54,
2, 24, 24, 24, 24 3, 24, 54, 4, 24, 36, 254, 2, 24, 24, 24, 24
], ],
writebuf.as_borrow_slice() writebuf.as_slice()
); );
} }
} }

View file

@ -15,18 +15,20 @@
* limitations under the License. * limitations under the License.
*/ */
use num_derive::FromPrimitive; use core::convert::TryInto;
use crate::data_model::core::DataModel; use strum::FromRepr;
use crate::attribute_enum;
use crate::data_model::objects::*; use crate::data_model::objects::*;
use crate::error::*; use crate::error::Error;
use crate::interaction_model::messages::GenericPath;
use crate::tlv::{TLVWriter, TagType, ToTLV}; use crate::tlv::{TLVWriter, TagType, ToTLV};
use log::error; use crate::utils::rand::Rand;
pub const ID: u32 = 0x001D; pub const ID: u32 = 0x001D;
#[derive(FromPrimitive)] #[derive(FromRepr)]
#[repr(u16)]
#[allow(clippy::enum_variant_names)] #[allow(clippy::enum_variant_names)]
pub enum Attributes { pub enum Attributes {
DeviceTypeList = 0, DeviceTypeList = 0,
@ -35,134 +37,155 @@ pub enum Attributes {
PartsList = 3, PartsList = 3,
} }
attribute_enum!(Attributes);
pub const CLUSTER: Cluster<'static> = Cluster {
id: ID as _,
feature_map: 0,
attributes: &[
FEATURE_MAP,
ATTRIBUTE_LIST,
Attribute::new(Attributes::DeviceTypeList as u16, Access::RV, Quality::NONE),
Attribute::new(Attributes::ServerList as u16, Access::RV, Quality::NONE),
Attribute::new(Attributes::PartsList as u16, Access::RV, Quality::NONE),
Attribute::new(Attributes::ClientList as u16, Access::RV, Quality::NONE),
],
commands: &[],
};
pub struct DescriptorCluster { pub struct DescriptorCluster {
base: Cluster, data_ver: Dataver,
endpoint_id: EndptId,
data_model: DataModel,
} }
impl DescriptorCluster { impl DescriptorCluster {
pub fn new(endpoint_id: EndptId, data_model: DataModel) -> Result<Box<Self>, Error> { pub fn new(rand: Rand) -> Self {
let mut c = Box::new(DescriptorCluster { Self {
endpoint_id, data_ver: Dataver::new(rand),
data_model, }
base: Cluster::new(ID)?,
});
let attrs = [
Attribute::new(
Attributes::DeviceTypeList as u16,
AttrValue::Custom,
Access::RV,
Quality::NONE,
),
Attribute::new(
Attributes::ServerList as u16,
AttrValue::Custom,
Access::RV,
Quality::NONE,
),
Attribute::new(
Attributes::PartsList as u16,
AttrValue::Custom,
Access::RV,
Quality::NONE,
),
Attribute::new(
Attributes::ClientList as u16,
AttrValue::Custom,
Access::RV,
Quality::NONE,
),
];
c.base.add_attributes(&attrs[..])?;
Ok(c)
} }
fn encode_devtype_list(&self, tag: TagType, tw: &mut TLVWriter) { pub fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
let path = GenericPath { if let Some(mut writer) = encoder.with_dataver(self.data_ver.get())? {
endpoint: Some(self.endpoint_id), if attr.is_system() {
cluster: None, CLUSTER.read(attr.attr_id, writer)
leaf: None, } else {
}; match attr.attr_id.try_into()? {
let _ = tw.start_array(tag); Attributes::DeviceTypeList => {
let dm = self.data_model.node.read().unwrap(); self.encode_devtype_list(attr.node, AttrDataWriter::TAG, &mut writer)?;
let _ = dm.for_each_endpoint(&path, |_, e| { writer.complete()
let dev_type = e.get_dev_type(); }
let _ = dev_type.to_tlv(tw, TagType::Anonymous); Attributes::ServerList => {
self.encode_server_list(
attr.node,
attr.endpoint_id,
AttrDataWriter::TAG,
&mut writer,
)?;
writer.complete()
}
Attributes::PartsList => {
self.encode_parts_list(
attr.node,
attr.endpoint_id,
AttrDataWriter::TAG,
&mut writer,
)?;
writer.complete()
}
Attributes::ClientList => {
self.encode_client_list(
attr.node,
attr.endpoint_id,
AttrDataWriter::TAG,
&mut writer,
)?;
writer.complete()
}
}
}
} else {
Ok(()) Ok(())
}); }
let _ = tw.end_container();
} }
fn encode_server_list(&self, tag: TagType, tw: &mut TLVWriter) { fn encode_devtype_list(
let path = GenericPath { &self,
endpoint: Some(self.endpoint_id), node: &Node,
cluster: None, tag: TagType,
leaf: None, tw: &mut TLVWriter,
}; ) -> Result<(), Error> {
let _ = tw.start_array(tag); tw.start_array(tag)?;
let dm = self.data_model.node.read().unwrap(); for endpoint in node.endpoints {
let _ = dm.for_each_cluster(&path, |_current_path, c| { let dev_type = endpoint.device_type;
let _ = tw.u32(TagType::Anonymous, c.base().id()); dev_type.to_tlv(tw, TagType::Anonymous)?;
Ok(())
});
let _ = tw.end_container();
} }
fn encode_parts_list(&self, tag: TagType, tw: &mut TLVWriter) { tw.end_container()
let path = GenericPath { }
endpoint: None,
cluster: None, fn encode_server_list(
leaf: None, &self,
}; node: &Node,
let _ = tw.start_array(tag); endpoint_id: u16,
if self.endpoint_id == 0 { tag: TagType,
tw: &mut TLVWriter,
) -> Result<(), Error> {
tw.start_array(tag)?;
for endpoint in node.endpoints {
if endpoint.id == endpoint_id {
for cluster in endpoint.clusters {
tw.u32(TagType::Anonymous, cluster.id as _)?;
}
}
}
tw.end_container()
}
fn encode_parts_list(
&self,
node: &Node,
endpoint_id: u16,
tag: TagType,
tw: &mut TLVWriter,
) -> Result<(), Error> {
tw.start_array(tag)?;
if endpoint_id == 0 {
// TODO: If endpoint is another than 0, need to figure out what to do // TODO: If endpoint is another than 0, need to figure out what to do
let dm = self.data_model.node.read().unwrap(); for endpoint in node.endpoints {
let _ = dm.for_each_endpoint(&path, |current_path, _| { if endpoint.id != 0 {
if let Some(endpoint_id) = current_path.endpoint { tw.u16(TagType::Anonymous, endpoint.id)?;
if endpoint_id != 0 {
let _ = tw.u16(TagType::Anonymous, endpoint_id);
} }
} }
Ok(())
});
}
let _ = tw.end_container();
} }
fn encode_client_list(&self, tag: TagType, tw: &mut TLVWriter) { tw.end_container()
}
fn encode_client_list(
&self,
_node: &Node,
_endpoint_id: u16,
tag: TagType,
tw: &mut TLVWriter,
) -> Result<(), Error> {
// No Clients supported // No Clients supported
let _ = tw.start_array(tag); tw.start_array(tag)?;
let _ = tw.end_container(); tw.end_container()
} }
} }
impl ClusterType for DescriptorCluster { impl Handler for DescriptorCluster {
fn base(&self) -> &Cluster { fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
&self.base DescriptorCluster::read(self, attr, encoder)
} }
fn base_mut(&mut self) -> &mut Cluster { }
&mut self.base
} impl NonBlockingHandler for DescriptorCluster {}
fn read_custom_attribute(&self, encoder: &mut dyn Encoder, attr: &AttrDetails) { impl ChangeNotifier<()> for DescriptorCluster {
match num::FromPrimitive::from_u16(attr.attr_id) { fn consume_change(&mut self) -> Option<()> {
Some(Attributes::DeviceTypeList) => encoder.encode(EncodeValue::Closure(&|tag, tw| { self.data_ver.consume_change(())
self.encode_devtype_list(tag, tw)
})),
Some(Attributes::ServerList) => encoder.encode(EncodeValue::Closure(&|tag, tw| {
self.encode_server_list(tag, tw)
})),
Some(Attributes::PartsList) => encoder.encode(EncodeValue::Closure(&|tag, tw| {
self.encode_parts_list(tag, tw)
})),
Some(Attributes::ClientList) => encoder.encode(EncodeValue::Closure(&|tag, tw| {
self.encode_client_list(tag, tw)
})),
_ => {
error!("Attribute not supported: this shouldn't happen");
}
}
} }
} }

View file

@ -15,13 +15,14 @@
* limitations under the License. * limitations under the License.
*/ */
use std::{ use alloc::string::FromUtf8Error;
array::TryFromSliceError, fmt, string::FromUtf8Error, sync::PoisonError, time::SystemTimeError, use core::{array::TryFromSliceError, fmt};
};
use async_channel::{SendError, TryRecvError}; use async_channel::{SendError, TryRecvError};
use log::error; use log::error;
extern crate alloc;
#[derive(Debug, PartialEq, Clone, Copy)] #[derive(Debug, PartialEq, Clone, Copy)]
pub enum Error { pub enum Error {
AttributeNotFound, AttributeNotFound,
@ -31,6 +32,13 @@ pub enum Error {
CommandNotFound, CommandNotFound,
Duplicate, Duplicate,
EndpointNotFound, EndpointNotFound,
InvalidAction,
InvalidCommand,
InvalidDataType,
UnsupportedAccess,
ResourceExhausted,
Busy,
DataVersionMismatch,
Crypto, Crypto,
TLSStack, TLSStack,
MdnsError, MdnsError,
@ -71,6 +79,36 @@ pub enum Error {
Utf8Fail, Utf8Fail,
} }
impl Error {
pub fn remap<F>(self, matcher: F, to: Self) -> Self
where
F: FnOnce(&Self) -> bool,
{
if matcher(&self) {
to
} else {
self
}
}
pub fn map_invalid(self, to: Self) -> Self {
self.remap(|e| matches!(e, Self::Invalid | Self::InvalidData), to)
}
pub fn map_invalid_command(self) -> Self {
self.map_invalid(Error::InvalidCommand)
}
pub fn map_invalid_action(self) -> Self {
self.map_invalid(Error::InvalidAction)
}
pub fn map_invalid_data_type(self) -> Self {
self.map_invalid(Error::InvalidDataType)
}
}
#[cfg(feature = "std")]
impl From<std::io::Error> for Error { impl From<std::io::Error> for Error {
fn from(_e: std::io::Error) -> Self { fn from(_e: std::io::Error) -> Self {
// Keep things simple for now // Keep things simple for now
@ -78,8 +116,9 @@ impl From<std::io::Error> for Error {
} }
} }
impl<T> From<PoisonError<T>> for Error { #[cfg(feature = "std")]
fn from(_e: PoisonError<T>) -> Self { impl<T> From<std::sync::PoisonError<T>> for Error {
fn from(_e: std::sync::PoisonError<T>) -> Self {
Self::RwLock Self::RwLock
} }
} }
@ -107,8 +146,9 @@ impl From<ccm::aead::Error> for Error {
} }
} }
impl From<SystemTimeError> for Error { #[cfg(feature = "std")]
fn from(_e: SystemTimeError) -> Self { impl From<std::time::SystemTimeError> for Error {
fn from(_e: std::time::SystemTimeError) -> Self {
Self::SysTimeFail Self::SysTimeFail
} }
} }

View file

@ -15,29 +15,33 @@
* limitations under the License. * limitations under the License.
*/ */
use std::sync::{Arc, Mutex, MutexGuard, RwLock}; use core::fmt::Write;
use byteorder::{BigEndian, ByteOrder, LittleEndian}; use byteorder::{BigEndian, ByteOrder, LittleEndian};
use log::{error, info}; use log::{error, info};
use owning_ref::RwLockReadGuardRef;
use crate::{ use crate::{
cert::Cert, cert::Cert,
crypto::{self, crypto_dummy::KeyPairDummy, hkdf_sha256, CryptoKeyPair, HmacSha256, KeyPair}, crypto::{self, hkdf_sha256, HmacSha256, KeyPair},
error::Error, error::Error,
group_keys::KeySet, group_keys::KeySet,
mdns::{self, Mdns}, mdns::{MdnsMgr, ServiceMode},
sys::{Psm, SysMdnsService}, persist::Psm,
tlv::{OctetStr, TLVWriter, TagType, ToTLV, UtfStr}, tlv::{OctetStr, TLVWriter, TagType, ToTLV, UtfStr},
}; };
const MAX_CERT_TLV_LEN: usize = 350; const MAX_CERT_TLV_LEN: usize = 300;
const COMPRESSED_FABRIC_ID_LEN: usize = 8; const COMPRESSED_FABRIC_ID_LEN: usize = 8;
macro_rules! fb_key { macro_rules! fb_key {
($index:ident, $key:ident) => { ($index:ident, $key:ident, $buf:expr) => {{
&format!("fb{}{}", $index, $key) use core::fmt::Write;
};
$buf = "".into();
write!(&mut $buf, "fb{}{}", $index, $key).unwrap();
&$buf
}};
} }
const ST_VID: &str = "vid"; const ST_VID: &str = "vid";
@ -50,20 +54,6 @@ const ST_PBKEY: &str = "pubkey";
const ST_PRKEY: &str = "privkey"; const ST_PRKEY: &str = "privkey";
#[allow(dead_code)] #[allow(dead_code)]
pub struct Fabric {
node_id: u64,
fabric_id: u64,
vendor_id: u16,
key_pair: Box<dyn CryptoKeyPair>,
pub root_ca: Cert,
pub icac: Option<Cert>,
pub noc: Cert,
pub ipk: KeySet,
label: String,
compressed_id: [u8; COMPRESSED_FABRIC_ID_LEN],
mdns_service: Option<SysMdnsService>,
}
#[derive(ToTLV)] #[derive(ToTLV)]
#[tlvargs(lifetime = "'a", start = 1)] #[tlvargs(lifetime = "'a", start = 1)]
pub struct FabricDescriptor<'a> { pub struct FabricDescriptor<'a> {
@ -77,6 +67,19 @@ pub struct FabricDescriptor<'a> {
pub fab_idx: Option<u8>, pub fab_idx: Option<u8>,
} }
pub struct Fabric {
node_id: u64,
fabric_id: u64,
vendor_id: u16,
key_pair: KeyPair,
pub root_ca: Cert,
pub icac: Option<Cert>,
pub noc: Cert,
pub ipk: KeySet,
label: heapless::String<32>,
mdns_service_name: heapless::String<33>,
}
impl Fabric { impl Fabric {
pub fn new( pub fn new(
key_pair: KeyPair, key_pair: KeyPair,
@ -85,56 +88,43 @@ impl Fabric {
noc: Cert, noc: Cert,
ipk: &[u8], ipk: &[u8],
vendor_id: u16, vendor_id: u16,
label: &str,
) -> Result<Self, Error> { ) -> Result<Self, Error> {
let node_id = noc.get_node_id()?; let node_id = noc.get_node_id()?;
let fabric_id = noc.get_fabric_id()?; let fabric_id = noc.get_fabric_id()?;
let mut f = Self { let mut compressed_id = [0_u8; COMPRESSED_FABRIC_ID_LEN];
node_id,
fabric_id,
vendor_id,
key_pair: Box::new(key_pair),
root_ca,
icac,
noc,
ipk: KeySet::default(),
compressed_id: [0; COMPRESSED_FABRIC_ID_LEN],
label: "".into(),
mdns_service: None,
};
Fabric::get_compressed_id(f.root_ca.get_pubkey(), fabric_id, &mut f.compressed_id)?;
f.ipk = KeySet::new(ipk, &f.compressed_id)?;
let mut mdns_service_name = String::with_capacity(33); Fabric::get_compressed_id(root_ca.get_pubkey(), fabric_id, &mut compressed_id)?;
for c in f.compressed_id { let ipk = KeySet::new(ipk, &compressed_id)?;
mdns_service_name.push_str(&format!("{:02X}", c));
let mut mdns_service_name = heapless::String::<33>::new();
for c in compressed_id {
let mut hex = heapless::String::<4>::new();
write!(&mut hex, "{:02X}", c).unwrap();
mdns_service_name.push_str(&hex).unwrap();
} }
mdns_service_name.push('-'); mdns_service_name.push('-').unwrap();
let mut node_id_be: [u8; 8] = [0; 8]; let mut node_id_be: [u8; 8] = [0; 8];
BigEndian::write_u64(&mut node_id_be, node_id); BigEndian::write_u64(&mut node_id_be, node_id);
for c in node_id_be { for c in node_id_be {
mdns_service_name.push_str(&format!("{:02X}", c)); let mut hex = heapless::String::<4>::new();
write!(&mut hex, "{:02X}", c).unwrap();
mdns_service_name.push_str(&hex).unwrap();
} }
info!("MDNS Service Name: {}", mdns_service_name); info!("MDNS Service Name: {}", mdns_service_name);
f.mdns_service = Some(
Mdns::get()?.publish_service(&mdns_service_name, mdns::ServiceMode::Commissioned)?,
);
Ok(f)
}
pub fn dummy() -> Result<Self, Error> {
Ok(Self { Ok(Self {
node_id: 0, node_id,
fabric_id: 0, fabric_id,
vendor_id: 0, vendor_id,
key_pair: Box::new(KeyPairDummy::new()?), key_pair,
root_ca: Cert::default(), root_ca,
icac: Some(Cert::default()), icac,
noc: Cert::default(), noc,
ipk: KeySet::default(), ipk,
label: "".into(), label: label.into(),
compressed_id: [0; COMPRESSED_FABRIC_ID_LEN], mdns_service_name,
mdns_service: None,
}) })
} }
@ -195,164 +185,362 @@ impl Fabric {
} }
} }
fn rm_store(&self, index: usize, psm: &MutexGuard<Psm>) { fn store<T>(&self, index: usize, mut psm: T) -> Result<(), Error>
psm.rm(fb_key!(index, ST_RCA)); where
psm.rm(fb_key!(index, ST_ICA)); T: Psm,
psm.rm(fb_key!(index, ST_NOC)); {
psm.rm(fb_key!(index, ST_IPK)); let mut _kb = heapless::String::<32>::new();
psm.rm(fb_key!(index, ST_LBL));
psm.rm(fb_key!(index, ST_PBKEY));
psm.rm(fb_key!(index, ST_PRKEY));
psm.rm(fb_key!(index, ST_VID));
}
fn store(&self, index: usize, psm: &MutexGuard<Psm>) -> Result<(), Error> { let mut buf = [0u8; MAX_CERT_TLV_LEN];
let mut key = [0u8; MAX_CERT_TLV_LEN]; let len = self.root_ca.as_tlv(&mut buf)?;
let len = self.root_ca.as_tlv(&mut key)?; psm.set_kv_slice(fb_key!(index, ST_RCA, _kb), &buf[..len])?;
psm.set_kv_slice(fb_key!(index, ST_RCA), &key[..len])?;
let len = if let Some(icac) = &self.icac { let len = if let Some(icac) = &self.icac {
icac.as_tlv(&mut key)? icac.as_tlv(&mut buf)?
} else { } else {
0 0
}; };
psm.set_kv_slice(fb_key!(index, ST_ICA), &key[..len])?; psm.set_kv_slice(fb_key!(index, ST_ICA, _kb), &buf[..len])?;
let len = self.noc.as_tlv(&mut key)?; let len = self.noc.as_tlv(&mut buf)?;
psm.set_kv_slice(fb_key!(index, ST_NOC), &key[..len])?; psm.set_kv_slice(fb_key!(index, ST_NOC, _kb), &buf[..len])?;
psm.set_kv_slice(fb_key!(index, ST_IPK), self.ipk.epoch_key())?; psm.set_kv_slice(fb_key!(index, ST_IPK, _kb), self.ipk.epoch_key())?;
psm.set_kv_slice(fb_key!(index, ST_LBL), self.label.as_bytes())?; psm.set_kv_slice(fb_key!(index, ST_LBL, _kb), self.label.as_bytes())?;
let mut key = [0_u8; crypto::EC_POINT_LEN_BYTES]; let mut buf = [0_u8; crypto::EC_POINT_LEN_BYTES];
let len = self.key_pair.get_public_key(&mut key)?; let len = self.key_pair.get_public_key(&mut buf)?;
let key = &key[..len]; let key = &buf[..len];
psm.set_kv_slice(fb_key!(index, ST_PBKEY), key)?; psm.set_kv_slice(fb_key!(index, ST_PBKEY, _kb), key)?;
let mut key = [0_u8; crypto::BIGNUM_LEN_BYTES]; let mut buf = [0_u8; crypto::BIGNUM_LEN_BYTES];
let len = self.key_pair.get_private_key(&mut key)?; let len = self.key_pair.get_private_key(&mut buf)?;
let key = &key[..len]; let key = &buf[..len];
psm.set_kv_slice(fb_key!(index, ST_PRKEY), key)?; psm.set_kv_slice(fb_key!(index, ST_PRKEY, _kb), key)?;
psm.set_kv_u64(fb_key!(index, ST_VID), self.vendor_id.into())?; psm.set_kv_u64(fb_key!(index, ST_VID, _kb), self.vendor_id.into())?;
Ok(()) Ok(())
} }
fn load(index: usize, psm: &MutexGuard<Psm>) -> Result<Self, Error> { fn load<T>(index: usize, psm: T) -> Result<Self, Error>
let mut root_ca = Vec::new(); where
psm.get_kv_slice(fb_key!(index, ST_RCA), &mut root_ca)?; T: Psm,
let root_ca = Cert::new(root_ca.as_slice())?; {
let mut _kb = heapless::String::<32>::new();
let mut icac = Vec::new(); let mut buf = [0u8; MAX_CERT_TLV_LEN];
psm.get_kv_slice(fb_key!(index, ST_ICA), &mut icac)?; let root_ca = psm.get_kv_slice(fb_key!(index, ST_RCA, _kb), &mut buf)?;
let root_ca = Cert::new(root_ca)?;
let icac = psm.get_kv_slice(fb_key!(index, ST_ICA, _kb), &mut buf)?;
let icac = if !icac.is_empty() { let icac = if !icac.is_empty() {
Some(Cert::new(icac.as_slice())?) Some(Cert::new(icac)?)
} else { } else {
None None
}; };
let mut noc = Vec::new(); let noc = psm.get_kv_slice(fb_key!(index, ST_NOC, _kb), &mut buf)?;
psm.get_kv_slice(fb_key!(index, ST_NOC), &mut noc)?; let noc = Cert::new(noc)?;
let noc = Cert::new(noc.as_slice())?;
let mut ipk = Vec::new(); let label = psm.get_kv_slice(fb_key!(index, ST_LBL, _kb), &mut buf)?;
psm.get_kv_slice(fb_key!(index, ST_IPK), &mut ipk)?; let label: heapless::String<32> = core::str::from_utf8(label)
.map_err(|_| {
let mut label = Vec::new();
psm.get_kv_slice(fb_key!(index, ST_LBL), &mut label)?;
let label = String::from_utf8(label).map_err(|_| {
error!("Couldn't read label"); error!("Couldn't read label");
Error::Invalid Error::Invalid
})?; })?
.into();
let mut pub_key = Vec::new(); let ipk = psm.get_kv_slice(fb_key!(index, ST_IPK, _kb), &mut buf)?;
psm.get_kv_slice(fb_key!(index, ST_PBKEY), &mut pub_key)?;
let mut priv_key = Vec::new();
psm.get_kv_slice(fb_key!(index, ST_PRKEY), &mut priv_key)?;
let keypair = KeyPair::new_from_components(pub_key.as_slice(), priv_key.as_slice())?;
let mut vendor_id = 0; let mut buf = [0_u8; crypto::EC_POINT_LEN_BYTES];
psm.get_kv_u64(fb_key!(index, ST_VID), &mut vendor_id)?; let pub_key = psm.get_kv_slice(fb_key!(index, ST_PBKEY, _kb), &mut buf)?;
let f = Fabric::new( let mut buf = [0_u8; crypto::BIGNUM_LEN_BYTES];
keypair, let priv_key = psm.get_kv_slice(fb_key!(index, ST_PRKEY, _kb), &mut buf)?;
root_ca, let keypair = KeyPair::new_from_components(pub_key, priv_key)?;
icac,
noc, let vendor_id = psm.get_kv_u64(fb_key!(index, ST_VID, _kb))?;
ipk.as_slice(),
vendor_id as u16, Fabric::new(keypair, root_ca, icac, noc, ipk, vendor_id as u16, &label)
); }
f.map(|mut f| {
f.label = label; fn remove<T>(index: usize, mut psm: T) -> Result<(), Error>
f where
}) T: Psm,
{
let mut _kb = heapless::String::<32>::new();
psm.remove(fb_key!(index, ST_RCA, _kb))?;
psm.remove(fb_key!(index, ST_ICA, _kb))?;
psm.remove(fb_key!(index, ST_NOC, _kb))?;
psm.remove(fb_key!(index, ST_LBL, _kb))?;
psm.remove(fb_key!(index, ST_IPK, _kb))?;
psm.remove(fb_key!(index, ST_PBKEY, _kb))?;
psm.remove(fb_key!(index, ST_PRKEY, _kb))?;
psm.remove(fb_key!(index, ST_VID, _kb))?;
Ok(())
}
#[cfg(feature = "nightly")]
async fn store_async<T>(&self, index: usize, mut psm: T) -> Result<(), Error>
where
T: crate::persist::asynch::AsyncPsm,
{
let mut _kb = heapless::String::<32>::new();
let mut buf = [0u8; MAX_CERT_TLV_LEN];
let len = self.root_ca.as_tlv(&mut buf)?;
psm.set_kv_slice(fb_key!(index, ST_RCA, _kb), &buf[..len])
.await?;
let len = if let Some(icac) = &self.icac {
icac.as_tlv(&mut buf)?
} else {
0
};
psm.set_kv_slice(fb_key!(index, ST_ICA, _kb), &buf[..len])
.await?;
let len = self.noc.as_tlv(&mut buf)?;
psm.set_kv_slice(fb_key!(index, ST_NOC, _kb), &buf[..len])
.await?;
psm.set_kv_slice(fb_key!(index, ST_IPK, _kb), self.ipk.epoch_key())
.await?;
psm.set_kv_slice(fb_key!(index, ST_LBL, _kb), self.label.as_bytes())
.await?;
let mut buf = [0_u8; crypto::EC_POINT_LEN_BYTES];
let len = self.key_pair.get_public_key(&mut buf)?;
let key = &buf[..len];
psm.set_kv_slice(fb_key!(index, ST_PBKEY, _kb), key).await?;
let mut buf = [0_u8; crypto::BIGNUM_LEN_BYTES];
let len = self.key_pair.get_private_key(&mut buf)?;
let key = &buf[..len];
psm.set_kv_slice(fb_key!(index, ST_PRKEY, _kb), key).await?;
psm.set_kv_u64(fb_key!(index, ST_VID, _kb), self.vendor_id.into())
.await?;
Ok(())
}
#[cfg(feature = "nightly")]
async fn load_async<T>(index: usize, psm: T) -> Result<Self, Error>
where
T: crate::persist::asynch::AsyncPsm,
{
let mut _kb = heapless::String::<32>::new();
let mut buf = [0u8; MAX_CERT_TLV_LEN];
let root_ca = psm
.get_kv_slice(fb_key!(index, ST_RCA, _kb), &mut buf)
.await?;
let root_ca = Cert::new(root_ca)?;
let icac = psm
.get_kv_slice(fb_key!(index, ST_ICA, _kb), &mut buf)
.await?;
let icac = if !icac.is_empty() {
Some(Cert::new(icac)?)
} else {
None
};
let noc = psm
.get_kv_slice(fb_key!(index, ST_NOC, _kb), &mut buf)
.await?;
let noc = Cert::new(noc)?;
let label = psm
.get_kv_slice(fb_key!(index, ST_LBL, _kb), &mut buf)
.await?;
let label: heapless::String<32> = core::str::from_utf8(label)
.map_err(|_| {
error!("Couldn't read label");
Error::Invalid
})?
.into();
let ipk = psm
.get_kv_slice(fb_key!(index, ST_IPK, _kb), &mut buf)
.await?;
let mut buf = [0_u8; crypto::EC_POINT_LEN_BYTES];
let pub_key = psm
.get_kv_slice(fb_key!(index, ST_PBKEY, _kb), &mut buf)
.await?;
let mut buf = [0_u8; crypto::BIGNUM_LEN_BYTES];
let priv_key = psm
.get_kv_slice(fb_key!(index, ST_PRKEY, _kb), &mut buf)
.await?;
let keypair = KeyPair::new_from_components(pub_key, priv_key)?;
let vendor_id = psm.get_kv_u64(fb_key!(index, ST_VID, _kb)).await?;
Fabric::new(keypair, root_ca, icac, noc, ipk, vendor_id as u16, &label)
}
#[cfg(feature = "nightly")]
async fn remove_async<T>(index: usize, mut psm: T) -> Result<(), Error>
where
T: crate::persist::asynch::AsyncPsm,
{
let mut _kb = heapless::String::<32>::new();
psm.remove(fb_key!(index, ST_RCA, _kb)).await?;
psm.remove(fb_key!(index, ST_ICA, _kb)).await?;
psm.remove(fb_key!(index, ST_NOC, _kb)).await?;
psm.remove(fb_key!(index, ST_LBL, _kb)).await?;
psm.remove(fb_key!(index, ST_IPK, _kb)).await?;
psm.remove(fb_key!(index, ST_PBKEY, _kb)).await?;
psm.remove(fb_key!(index, ST_PRKEY, _kb)).await?;
psm.remove(fb_key!(index, ST_VID, _kb)).await?;
Ok(())
} }
} }
pub const MAX_SUPPORTED_FABRICS: usize = 3; pub const MAX_SUPPORTED_FABRICS: usize = 3;
#[derive(Default)]
pub struct FabricMgrInner {
// The outside world expects Fabric Index to be one more than the actual one
// since 0 is not allowed. Need to handle this cleanly somehow
pub fabrics: [Option<Fabric>; MAX_SUPPORTED_FABRICS],
}
pub struct FabricMgr { pub struct FabricMgr {
inner: RwLock<FabricMgrInner>, // The outside world expects Fabric Index to be one more than the actual one
psm: Arc<Mutex<Psm>>, // since 0 is not allowed. Need to handle this cleanly somehow
fabrics: [Option<Fabric>; MAX_SUPPORTED_FABRICS],
changed: bool,
} }
impl FabricMgr { impl FabricMgr {
pub fn new() -> Result<Self, Error> { pub const fn new() -> Self {
let dummy_fabric = Fabric::dummy()?; const INIT: Option<Fabric> = None;
let mut mgr = FabricMgrInner::default();
mgr.fabrics[0] = Some(dummy_fabric); Self {
let mut fm = Self { fabrics: [INIT; MAX_SUPPORTED_FABRICS],
inner: RwLock::new(mgr), changed: false,
psm: Psm::get()?, }
};
fm.load()?;
Ok(fm)
} }
fn store(&self, index: usize, fabric: &Fabric) -> Result<(), Error> { pub fn store<T>(&mut self, mut psm: T) -> Result<(), Error>
let psm = self.psm.lock().unwrap(); where
fabric.store(index, &psm) T: Psm,
{
if self.changed {
for i in 1..MAX_SUPPORTED_FABRICS {
if let Some(fabric) = self.fabrics[i].as_mut() {
info!("Storing fabric at index {}", i);
fabric.store(i, &mut psm)?;
} else {
let _ = Fabric::remove(i, &mut psm);
}
} }
fn load(&mut self) -> Result<(), Error> { self.changed = false;
let mut mgr = self.inner.write()?;
let psm = self.psm.lock().unwrap();
for i in 0..MAX_SUPPORTED_FABRICS {
let result = Fabric::load(i, &psm);
if let Ok(fabric) = result {
info!("Adding new fabric at index {}", i);
mgr.fabrics[i] = Some(fabric);
}
} }
Ok(()) Ok(())
} }
pub fn add(&self, f: Fabric) -> Result<u8, Error> { pub fn load<T>(&mut self, mut psm: T, mdns_mgr: &mut MdnsMgr) -> Result<(), Error>
let mut mgr = self.inner.write()?; where
let index = mgr T: Psm,
{
for i in 1..MAX_SUPPORTED_FABRICS {
let result = Fabric::load(i, &mut psm);
if let Ok(fabric) = result {
info!("Adding new fabric at index {}", i);
self.fabrics[i] = Some(fabric);
mdns_mgr.publish_service(
&self.fabrics[i].as_ref().unwrap().mdns_service_name,
ServiceMode::Commissioned,
)?;
} else {
self.fabrics[i] = None;
}
}
self.changed = false;
Ok(())
}
#[cfg(feature = "nightly")]
pub async fn store_async<T>(&mut self, mut psm: T) -> Result<(), Error>
where
T: crate::persist::asynch::AsyncPsm,
{
if self.changed {
for i in 1..MAX_SUPPORTED_FABRICS {
if let Some(fabric) = self.fabrics[i].as_mut() {
info!("Storing fabric at index {}", i);
fabric.store_async(i, &mut psm).await?;
} else {
let _ = Fabric::remove_async(i, &mut psm).await;
}
}
self.changed = false;
}
Ok(())
}
#[cfg(feature = "nightly")]
pub async fn load_async<T>(&mut self, mut psm: T, mdns_mgr: &mut MdnsMgr) -> Result<(), Error>
where
T: crate::persist::asynch::AsyncPsm,
{
for i in 1..MAX_SUPPORTED_FABRICS {
let result = Fabric::load_async(i, &mut psm).await;
if let Ok(fabric) = result {
info!("Adding new fabric at index {}", i);
self.fabrics[i] = Some(fabric);
mdns_mgr.publish_service(
&self.fabrics[i].as_ref().unwrap().mdns_service_name,
ServiceMode::Commissioned,
)?;
} else {
self.fabrics[i] = None;
}
}
self.changed = false;
Ok(())
}
pub fn add(&mut self, f: Fabric, mdns_mgr: &mut MdnsMgr) -> Result<u8, Error> {
let index = self
.fabrics .fabrics
.iter() .iter()
.skip(1)
.position(|f| f.is_none()) .position(|f| f.is_none())
.ok_or(Error::NoSpace)?; .ok_or(Error::NoSpace)?;
self.store(index, &f)?; self.fabrics[index] = Some(f);
mdns_mgr.publish_service(
&self.fabrics[index].as_ref().unwrap().mdns_service_name,
ServiceMode::Commissioned,
)?;
self.changed = true;
mgr.fabrics[index] = Some(f);
Ok(index as u8) Ok(index as u8)
} }
pub fn remove(&self, fab_idx: u8) -> Result<(), Error> { pub fn remove(&mut self, fab_idx: u8, mdns_mgr: &mut MdnsMgr) -> Result<(), Error> {
let fab_idx = fab_idx as usize; if let Some(f) = self.fabrics[fab_idx as usize].take() {
let mut mgr = self.inner.write().unwrap(); mdns_mgr.unpublish_service(&f.mdns_service_name, ServiceMode::Commissioned)?;
let psm = self.psm.lock().unwrap(); self.changed = true;
if let Some(f) = &mgr.fabrics[fab_idx] {
f.rm_store(fab_idx, &psm);
mgr.fabrics[fab_idx] = None;
Ok(()) Ok(())
} else { } else {
Err(Error::NotFound) Err(Error::NotFound)
@ -360,9 +548,8 @@ impl FabricMgr {
} }
pub fn match_dest_id(&self, random: &[u8], target: &[u8]) -> Result<usize, Error> { pub fn match_dest_id(&self, random: &[u8], target: &[u8]) -> Result<usize, Error> {
let mgr = self.inner.read()?; for i in 1..MAX_SUPPORTED_FABRICS {
for i in 0..MAX_SUPPORTED_FABRICS { if let Some(fabric) = &self.fabrics[i] {
if let Some(fabric) = &mgr.fabrics[i] {
if fabric.match_dest_id(random, target).is_ok() { if fabric.match_dest_id(random, target).is_ok() {
return Ok(i); return Ok(i);
} }
@ -371,17 +558,13 @@ impl FabricMgr {
Err(Error::NotFound) Err(Error::NotFound)
} }
pub fn get_fabric<'ret, 'me: 'ret>( pub fn get_fabric(&self, idx: usize) -> Result<Option<&Fabric>, Error> {
&'me self, Ok(self.fabrics[idx].as_ref())
idx: usize,
) -> Result<RwLockReadGuardRef<'ret, FabricMgrInner, Option<Fabric>>, Error> {
Ok(RwLockReadGuardRef::new(self.inner.read()?).map(|fm| &fm.fabrics[idx]))
} }
pub fn is_empty(&self) -> bool { pub fn is_empty(&self) -> bool {
let mgr = self.inner.read().unwrap();
for i in 1..MAX_SUPPORTED_FABRICS { for i in 1..MAX_SUPPORTED_FABRICS {
if mgr.fabrics[i].is_some() { if self.fabrics[i].is_some() {
return false; return false;
} }
} }
@ -389,10 +572,9 @@ impl FabricMgr {
} }
pub fn used_count(&self) -> usize { pub fn used_count(&self) -> usize {
let mgr = self.inner.read().unwrap();
let mut count = 0; let mut count = 0;
for i in 1..MAX_SUPPORTED_FABRICS { for i in 1..MAX_SUPPORTED_FABRICS {
if mgr.fabrics[i].is_some() { if self.fabrics[i].is_some() {
count += 1; count += 1;
} }
} }
@ -402,37 +584,30 @@ impl FabricMgr {
// Parameters to T are the Fabric and its Fabric Index // Parameters to T are the Fabric and its Fabric Index
pub fn for_each<T>(&self, mut f: T) -> Result<(), Error> pub fn for_each<T>(&self, mut f: T) -> Result<(), Error>
where where
T: FnMut(&Fabric, u8), T: FnMut(&Fabric, u8) -> Result<(), Error>,
{ {
let mgr = self.inner.read().unwrap();
for i in 1..MAX_SUPPORTED_FABRICS { for i in 1..MAX_SUPPORTED_FABRICS {
if let Some(fabric) = &mgr.fabrics[i] { if let Some(fabric) = &self.fabrics[i] {
f(fabric, i as u8) f(fabric, i as u8)?;
} }
} }
Ok(()) Ok(())
} }
pub fn set_label(&self, index: u8, label: String) -> Result<(), Error> { pub fn set_label(&mut self, index: u8, label: &str) -> Result<(), Error> {
let index = index as usize; let index = index as usize;
let mut mgr = self.inner.write()?;
if !label.is_empty() { if !label.is_empty() {
for i in 1..MAX_SUPPORTED_FABRICS { for i in 1..MAX_SUPPORTED_FABRICS {
if let Some(fabric) = &mgr.fabrics[i] { if let Some(fabric) = &self.fabrics[i] {
if fabric.label == label { if fabric.label == label {
return Err(Error::Invalid); return Err(Error::Invalid);
} }
} }
} }
} }
if let Some(fabric) = &mut mgr.fabrics[index] { if let Some(fabric) = &mut self.fabrics[index] {
let old = fabric.label.clone(); fabric.label = label.into();
fabric.label = label; self.changed = true;
let psm = self.psm.lock().unwrap();
if fabric.store(index, &psm).is_err() {
fabric.label = old;
return Err(Error::StdIoError);
}
} }
Ok(()) Ok(())
} }

View file

@ -15,10 +15,13 @@
* limitations under the License. * limitations under the License.
*/ */
use std::sync::{Arc, Mutex, Once}; use alloc::sync::Arc;
use std::sync::{Mutex, Once};
use crate::{crypto, error::Error}; use crate::{crypto, error::Error};
extern crate alloc;
// This is just makeshift implementation for now, not used anywhere // This is just makeshift implementation for now, not used anywhere
pub struct GroupKeys {} pub struct GroupKeys {}

View file

@ -1,88 +0,0 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use super::core::IMStatusCode;
use super::core::OpCode;
use super::messages::ib;
use super::messages::msg;
use super::messages::msg::InvReq;
use super::InteractionModel;
use super::Transaction;
use crate::{
error::*,
tlv::{get_root_node_struct, print_tlv_list, FromTLV, TLVElement, TLVWriter, TagType},
transport::{packet::Packet, proto_demux::ResponseRequired},
};
use log::error;
#[macro_export]
macro_rules! cmd_enter {
($e:expr) => {{
use colored::Colorize;
info! {"{} {}", "Handling Command".cyan(), $e.cyan()}
}};
}
pub struct CommandReq<'a, 'b, 'c, 'd, 'e> {
pub cmd: ib::CmdPath,
pub data: TLVElement<'a>,
pub resp: &'a mut TLVWriter<'b, 'c>,
pub trans: &'a mut Transaction<'d, 'e>,
}
impl InteractionModel {
pub fn handle_invoke_req(
&mut self,
trans: &mut Transaction,
rx_buf: &[u8],
proto_tx: &mut Packet,
) -> Result<ResponseRequired, Error> {
if InteractionModel::req_timeout_handled(trans, proto_tx)? {
return Ok(ResponseRequired::Yes);
}
proto_tx.set_proto_opcode(OpCode::InvokeResponse as u8);
let mut tw = TLVWriter::new(proto_tx.get_writebuf()?);
let root = get_root_node_struct(rx_buf)?;
let inv_req = InvReq::from_tlv(&root)?;
let timed_tx = trans.get_timeout().map(|_| true);
let timed_request = inv_req.timed_request.filter(|a| *a);
// Either both should be None, or both should be Some(true)
if timed_tx != timed_request {
InteractionModel::create_status_response(proto_tx, IMStatusCode::TimedRequestMisMatch)?;
return Ok(ResponseRequired::Yes);
}
tw.start_struct(TagType::Anonymous)?;
// Suppress Response -> TODO: Need to revisit this for cases where we send a command back
tw.bool(
TagType::Context(msg::InvRespTag::SupressResponse as u8),
false,
)?;
self.consumer
.consume_invoke_cmd(&inv_req, trans, &mut tw)
.map_err(|e| {
error!("Error in handling command: {:?}", e);
print_tlv_list(rx_buf);
e
})?;
tw.end_container()?;
Ok(ResponseRequired::Yes)
}
}

View file

@ -15,212 +15,27 @@
* limitations under the License. * limitations under the License.
*/ */
use std::time::{Duration, SystemTime}; use core::time::Duration;
use crate::{ use crate::{
data_model::core::DataHandler,
error::*, error::*,
interaction_model::messages::msg::StatusResp, tlv::{get_root_node_struct, print_tlv_list, FromTLV, TLVElement, TLVWriter, TagType, ToTLV},
tlv::{self, get_root_node_struct, FromTLV, TLVElement, TLVWriter, TagType, ToTLV}, transport::{exchange::ExchangeCtx, packet::Packet, proto_ctx::ProtoCtx, session::Session},
transport::{
exchange::Exchange,
packet::Packet,
proto_demux::{self, ProtoCtx, ResponseRequired},
session::SessionHandle,
},
}; };
use colored::Colorize; use colored::Colorize;
use log::{error, info}; use log::{error, info};
use num; use num;
use num_derive::FromPrimitive; use num_derive::FromPrimitive;
use super::InteractionModel; use super::messages::msg::{self, InvReq, ReadReq, StatusResp, TimedReq, WriteReq};
use super::Transaction;
use super::TransactionState;
use super::{messages::msg::TimedReq, InteractionConsumer};
/* Handle messages related to the Interation Model #[macro_export]
*/ macro_rules! cmd_enter {
($e:expr) => {{
/* Interaction Model ID as per the Matter Spec */ use colored::Colorize;
const PROTO_ID_INTERACTION_MODEL: usize = 0x01; info! {"{} {}", "Handling Command".cyan(), $e.cyan()}
}};
#[derive(FromPrimitive, Debug, Copy, Clone, PartialEq)]
pub enum OpCode {
Reserved = 0,
StatusResponse = 1,
ReadRequest = 2,
SubscribeRequest = 3,
SubscriptResponse = 4,
ReportData = 5,
WriteRequest = 6,
WriteResponse = 7,
InvokeRequest = 8,
InvokeResponse = 9,
TimedRequest = 10,
}
impl<'a, 'b> Transaction<'a, 'b> {
pub fn new(session: &'a mut SessionHandle<'b>, exch: &'a mut Exchange) -> Self {
Self {
state: TransactionState::Ongoing,
session,
exch,
}
}
/// Terminates the transaction, no communication (even ACKs) happens hence forth
pub fn terminate(&mut self) {
self.state = TransactionState::Terminate
}
pub fn is_terminate(&self) -> bool {
self.state == TransactionState::Terminate
}
/// Marks the transaction as completed from the application's perspective
pub fn complete(&mut self) {
self.state = TransactionState::Complete
}
pub fn is_complete(&self) -> bool {
self.state == TransactionState::Complete
}
pub fn set_timeout(&mut self, timeout: u64) {
self.exch
.set_data_time(SystemTime::now().checked_add(Duration::from_millis(timeout)));
}
pub fn get_timeout(&mut self) -> Option<SystemTime> {
self.exch.get_data_time()
}
pub fn has_timed_out(&self) -> bool {
if let Some(timeout) = self.exch.get_data_time() {
if SystemTime::now() > timeout {
return true;
}
}
false
}
}
impl InteractionModel {
pub fn new(consumer: Box<dyn InteractionConsumer>) -> InteractionModel {
InteractionModel { consumer }
}
pub fn handle_subscribe_req(
&mut self,
trans: &mut Transaction,
rx_buf: &[u8],
proto_tx: &mut Packet,
) -> Result<ResponseRequired, Error> {
let mut tw = TLVWriter::new(proto_tx.get_writebuf()?);
let (opcode, resp) = self.consumer.consume_subscribe(rx_buf, trans, &mut tw)?;
proto_tx.set_proto_opcode(opcode as u8);
Ok(resp)
}
pub fn handle_status_resp(
&mut self,
trans: &mut Transaction,
rx_buf: &[u8],
proto_tx: &mut Packet,
) -> Result<ResponseRequired, Error> {
let mut tw = TLVWriter::new(proto_tx.get_writebuf()?);
let root = get_root_node_struct(rx_buf)?;
let req = StatusResp::from_tlv(&root)?;
let (opcode, resp) = self.consumer.consume_status_report(&req, trans, &mut tw)?;
proto_tx.set_proto_opcode(opcode as u8);
Ok(resp)
}
pub fn handle_timed_req(
&mut self,
trans: &mut Transaction,
rx_buf: &[u8],
proto_tx: &mut Packet,
) -> Result<ResponseRequired, Error> {
proto_tx.set_proto_opcode(OpCode::StatusResponse as u8);
let root = get_root_node_struct(rx_buf)?;
let req = TimedReq::from_tlv(&root)?;
trans.set_timeout(req.timeout.into());
let status = StatusResp {
status: IMStatusCode::Success,
};
let mut tw = TLVWriter::new(proto_tx.get_writebuf()?);
let _ = status.to_tlv(&mut tw, TagType::Anonymous);
Ok(ResponseRequired::Yes)
}
/// Handle Request Timeouts
/// This API checks if a request was a timed request, and if so, and if the timeout has
/// expired, it will generate the appropriate response as expected
pub(super) fn req_timeout_handled(
trans: &mut Transaction,
proto_tx: &mut Packet,
) -> Result<bool, Error> {
if trans.has_timed_out() {
trans.complete();
InteractionModel::create_status_response(proto_tx, IMStatusCode::Timeout)?;
Ok(true)
} else {
Ok(false)
}
}
pub(super) fn create_status_response(
proto_tx: &mut Packet,
status: IMStatusCode,
) -> Result<(), Error> {
proto_tx.set_proto_opcode(OpCode::StatusResponse as u8);
let mut tw = TLVWriter::new(proto_tx.get_writebuf()?);
let status = StatusResp { status };
status.to_tlv(&mut tw, TagType::Anonymous)
}
}
impl proto_demux::HandleProto for InteractionModel {
fn handle_proto_id(&mut self, ctx: &mut ProtoCtx) -> Result<ResponseRequired, Error> {
let mut trans = Transaction::new(&mut ctx.exch_ctx.sess, ctx.exch_ctx.exch);
let proto_opcode: OpCode =
num::FromPrimitive::from_u8(ctx.rx.get_proto_opcode()).ok_or(Error::Invalid)?;
ctx.tx.set_proto_id(PROTO_ID_INTERACTION_MODEL as u16);
let buf = ctx.rx.as_borrow_slice();
info!("{} {:?}", "Received command".cyan(), proto_opcode);
tlv::print_tlv_list(buf);
let result = match proto_opcode {
OpCode::InvokeRequest => self.handle_invoke_req(&mut trans, buf, &mut ctx.tx)?,
OpCode::ReadRequest => self.handle_read_req(&mut trans, buf, &mut ctx.tx)?,
OpCode::WriteRequest => self.handle_write_req(&mut trans, buf, &mut ctx.tx)?,
OpCode::TimedRequest => self.handle_timed_req(&mut trans, buf, &mut ctx.tx)?,
OpCode::SubscribeRequest => self.handle_subscribe_req(&mut trans, buf, &mut ctx.tx)?,
OpCode::StatusResponse => self.handle_status_resp(&mut trans, buf, &mut ctx.tx)?,
_ => {
error!("Opcode Not Handled: {:?}", proto_opcode);
return Err(Error::InvalidOpcode);
}
};
if result == ResponseRequired::Yes {
info!("Sending response");
tlv::print_tlv_list(ctx.tx.as_borrow_slice());
}
if trans.is_terminate() {
ctx.exch_ctx.exch.terminate();
} else if trans.is_complete() {
ctx.exch_ctx.exch.close();
}
Ok(result)
}
fn get_proto_id(&self) -> usize {
PROTO_ID_INTERACTION_MODEL
}
} }
#[derive(FromPrimitive, Debug, Clone, Copy, PartialEq)] #[derive(FromPrimitive, Debug, Clone, Copy, PartialEq)]
@ -260,6 +75,12 @@ impl From<Error> for IMStatusCode {
Error::ClusterNotFound => IMStatusCode::UnsupportedCluster, Error::ClusterNotFound => IMStatusCode::UnsupportedCluster,
Error::AttributeNotFound => IMStatusCode::UnsupportedAttribute, Error::AttributeNotFound => IMStatusCode::UnsupportedAttribute,
Error::CommandNotFound => IMStatusCode::UnsupportedCommand, Error::CommandNotFound => IMStatusCode::UnsupportedCommand,
Error::InvalidAction => IMStatusCode::InvalidAction,
Error::InvalidCommand => IMStatusCode::InvalidCommand,
Error::UnsupportedAccess => IMStatusCode::UnsupportedAccess,
Error::Busy => IMStatusCode::Busy,
Error::DataVersionMismatch => IMStatusCode::DataVersionMismatch,
Error::ResourceExhausted => IMStatusCode::ResourceExhausted,
_ => IMStatusCode::Failure, _ => IMStatusCode::Failure,
} }
} }
@ -276,3 +97,418 @@ impl ToTLV for IMStatusCode {
tw.u16(tag_type, *self as u16) tw.u16(tag_type, *self as u16)
} }
} }
#[derive(FromPrimitive, Debug, Copy, Clone, PartialEq)]
pub enum OpCode {
Reserved = 0,
StatusResponse = 1,
ReadRequest = 2,
SubscribeRequest = 3,
SubscriptResponse = 4,
ReportData = 5,
WriteRequest = 6,
WriteResponse = 7,
InvokeRequest = 8,
InvokeResponse = 9,
TimedRequest = 10,
}
#[derive(PartialEq)]
pub enum TransactionState {
Ongoing,
Complete,
Terminate,
}
pub struct Transaction<'a, 'b> {
state: TransactionState,
ctx: &'a mut ExchangeCtx<'b>,
}
impl<'a, 'b> Transaction<'a, 'b> {
pub fn new(ctx: &'a mut ExchangeCtx<'b>) -> Self {
Self {
state: TransactionState::Ongoing,
ctx,
}
}
pub fn session(&self) -> &Session {
self.ctx.sess.session()
}
pub fn session_mut(&mut self) -> &mut Session {
self.ctx.sess.session_mut()
}
/// Terminates the transaction, no communication (even ACKs) happens hence forth
pub fn terminate(&mut self) {
self.state = TransactionState::Terminate
}
pub fn is_terminate(&self) -> bool {
self.state == TransactionState::Terminate
}
/// Marks the transaction as completed from the application's perspective
pub fn complete(&mut self) {
self.state = TransactionState::Complete
}
pub fn is_complete(&self) -> bool {
self.state == TransactionState::Complete
}
pub fn set_timeout(&mut self, timeout: u64) {
let now = (self.ctx.epoch)();
self.ctx
.exch
.set_data_time(now.checked_add(Duration::from_millis(timeout)));
}
pub fn get_timeout(&mut self) -> Option<Duration> {
self.ctx.exch.get_data_time()
}
pub fn has_timed_out(&self) -> bool {
if let Some(timeout) = self.ctx.exch.get_data_time() {
if (self.ctx.epoch)() > timeout {
return true;
}
}
false
}
}
/* Interaction Model ID as per the Matter Spec */
const PROTO_ID_INTERACTION_MODEL: usize = 0x01;
pub enum Interaction<'a> {
Read(ReadReq<'a>),
Write(WriteReq<'a>),
Invoke(InvReq<'a>),
Timed(TimedReq),
}
impl<'a> Interaction<'a> {
pub fn new(rx: &'a Packet) -> Result<Self, Error> {
let opcode: OpCode =
num::FromPrimitive::from_u8(rx.get_proto_opcode()).ok_or(Error::Invalid)?;
let rx_data = rx.as_slice();
info!("{} {:?}", "Received command".cyan(), opcode);
print_tlv_list(rx_data);
match opcode {
OpCode::ReadRequest => Ok(Self::Read(ReadReq::from_tlv(&get_root_node_struct(
rx_data,
)?)?)),
OpCode::WriteRequest => Ok(Self::Write(WriteReq::from_tlv(&get_root_node_struct(
rx_data,
)?)?)),
OpCode::InvokeRequest => Ok(Self::Invoke(InvReq::from_tlv(&get_root_node_struct(
rx_data,
)?)?)),
OpCode::TimedRequest => Ok(Self::Timed(TimedReq::from_tlv(&get_root_node_struct(
rx_data,
)?)?)),
// TODO
// OpCode::SubscribeRequest => self.handle_subscribe_req(&mut trans, buf, &mut ctx.tx)?,
// OpCode::StatusResponse => self.handle_status_resp(&mut trans, buf, &mut ctx.tx)?,
_ => {
error!("Opcode Not Handled: {:?}", opcode);
Err(Error::InvalidOpcode)
}
}
}
pub fn initiate_tx(
&self,
tx: &mut Packet,
transaction: &mut Transaction,
) -> Result<bool, Error> {
let reply = match self {
Self::Read(request) => {
tx.set_proto_id(PROTO_ID_INTERACTION_MODEL as u16);
tx.set_proto_opcode(OpCode::ReportData as u8);
let mut tw = TLVWriter::new(tx.get_writebuf()?);
tw.start_struct(TagType::Anonymous)?;
if request.attr_requests.is_some() {
tw.start_array(TagType::Context(msg::ReportDataTag::AttributeReports as u8))?;
}
false
}
Interaction::Write(_) => {
if transaction.has_timed_out() {
Self::create_status_response(tx, IMStatusCode::Timeout)?;
transaction.complete();
transaction.ctx.exch.close();
true
} else {
tx.set_proto_id(PROTO_ID_INTERACTION_MODEL as u16);
tx.set_proto_opcode(OpCode::WriteResponse as u8);
let mut tw = TLVWriter::new(tx.get_writebuf()?);
tw.start_struct(TagType::Anonymous)?;
tw.start_array(TagType::Context(msg::WriteRespTag::WriteResponses as u8))?;
false
}
}
Interaction::Invoke(request) => {
if transaction.has_timed_out() {
Self::create_status_response(tx, IMStatusCode::Timeout)?;
transaction.complete();
transaction.ctx.exch.close();
true
} else {
let timed_tx = transaction.get_timeout().map(|_| true);
let timed_request = request.timed_request.filter(|a| *a);
// Either both should be None, or both should be Some(true)
if timed_tx != timed_request {
Self::create_status_response(tx, IMStatusCode::TimedRequestMisMatch)?;
true
} else {
tx.set_proto_id(PROTO_ID_INTERACTION_MODEL as u16);
tx.set_proto_opcode(OpCode::InvokeResponse as u8);
let mut tw = TLVWriter::new(tx.get_writebuf()?);
tw.start_struct(TagType::Anonymous)?;
// Suppress Response -> TODO: Need to revisit this for cases where we send a command back
tw.bool(
TagType::Context(msg::InvRespTag::SupressResponse as u8),
false,
)?;
if request.inv_requests.is_some() {
tw.start_array(TagType::Context(
msg::InvRespTag::InvokeResponses as u8,
))?;
}
false
}
}
}
Interaction::Timed(request) => {
tx.set_proto_id(PROTO_ID_INTERACTION_MODEL as u16);
tx.set_proto_opcode(OpCode::StatusResponse as u8);
let mut tw = TLVWriter::new(tx.get_writebuf()?);
transaction.set_timeout(request.timeout.into());
let status = StatusResp {
status: IMStatusCode::Success,
};
status.to_tlv(&mut tw, TagType::Anonymous)?;
true
}
};
Ok(!reply)
}
pub fn complete_tx(
&self,
tx: &mut Packet,
transaction: &mut Transaction,
) -> Result<bool, Error> {
let reply = match self {
Self::Read(request) => {
let mut tw = TLVWriter::new(tx.get_writebuf()?);
if request.attr_requests.is_some() {
tw.end_container()?;
}
// Suppress response always true for read interaction
tw.bool(
TagType::Context(msg::ReportDataTag::SupressResponse as u8),
true,
)?;
tw.end_container()?;
transaction.complete();
true
}
Self::Write(request) => {
let suppress = request.supress_response.unwrap_or_default();
let mut tw = TLVWriter::new(tx.get_writebuf()?);
tw.end_container()?;
tw.end_container()?;
transaction.complete();
if suppress {
error!("Supress response is set, is this the expected handling?");
false
} else {
true
}
}
Self::Invoke(request) => {
let mut tw = TLVWriter::new(tx.get_writebuf()?);
if request.inv_requests.is_some() {
tw.end_container()?;
}
tw.end_container()?;
true
}
Self::Timed(_) => false,
};
if reply {
info!("Sending response");
print_tlv_list(tx.as_slice());
}
if transaction.is_terminate() {
transaction.ctx.exch.terminate();
} else if transaction.is_complete() {
transaction.ctx.exch.close();
}
Ok(true)
}
fn create_status_response(tx: &mut Packet, status: IMStatusCode) -> Result<(), Error> {
tx.set_proto_id(PROTO_ID_INTERACTION_MODEL as u16);
tx.set_proto_opcode(OpCode::StatusResponse as u8);
let mut tw = TLVWriter::new(tx.get_writebuf()?);
let status = StatusResp { status };
status.to_tlv(&mut tw, TagType::Anonymous)
}
}
pub trait InteractionHandler {
fn handle<'a>(&mut self, ctx: &'a mut ProtoCtx) -> Result<Option<&'a [u8]>, Error>;
}
impl<T> InteractionHandler for &mut T
where
T: InteractionHandler,
{
fn handle<'a>(&mut self, ctx: &'a mut ProtoCtx) -> Result<Option<&'a [u8]>, Error> {
(**self).handle(ctx)
}
}
pub struct InteractionModel<T>(pub T);
impl<T> InteractionModel<T>
where
T: DataHandler,
{
pub fn handle<'a>(&mut self, ctx: &'a mut ProtoCtx) -> Result<Option<&'a [u8]>, Error> {
let interaction = Interaction::new(ctx.rx)?;
let mut transaction = Transaction::new(&mut ctx.exch_ctx);
let reply = if interaction.initiate_tx(ctx.tx, &mut transaction)? {
self.0.handle(&interaction, ctx.tx, &mut transaction)?;
interaction.complete_tx(ctx.tx, &mut transaction)?
} else {
true
};
Ok(reply.then_some(ctx.tx.as_slice()))
}
}
#[cfg(feature = "nightly")]
impl<T> InteractionModel<T>
where
T: crate::data_model::core::asynch::AsyncDataHandler,
{
pub async fn handle_async<'a>(
&mut self,
ctx: &'a mut ProtoCtx<'_, '_>,
) -> Result<Option<&'a [u8]>, Error> {
let interaction = Interaction::new(ctx.rx)?;
let mut transaction = Transaction::new(&mut ctx.exch_ctx);
let reply = if interaction.initiate_tx(ctx.tx, &mut transaction)? {
self.0
.handle(&interaction, ctx.tx, &mut transaction)
.await?;
interaction.complete_tx(ctx.tx, &mut transaction)?
} else {
true
};
Ok(reply.then_some(ctx.tx.as_slice()))
}
}
impl<T> InteractionHandler for InteractionModel<T>
where
T: DataHandler,
{
fn handle<'a>(&mut self, ctx: &'a mut ProtoCtx) -> Result<Option<&'a [u8]>, Error> {
InteractionModel::handle(self, ctx)
}
}
#[cfg(feature = "nightly")]
pub mod asynch {
use crate::{
data_model::core::asynch::AsyncDataHandler, error::Error, transport::proto_ctx::ProtoCtx,
};
use super::InteractionModel;
pub trait AsyncInteractionHandler {
async fn handle<'a>(
&mut self,
ctx: &'a mut ProtoCtx<'_, '_>,
) -> Result<Option<&'a [u8]>, Error>;
}
impl<T> AsyncInteractionHandler for &mut T
where
T: AsyncInteractionHandler,
{
async fn handle<'a>(
&mut self,
ctx: &'a mut ProtoCtx<'_, '_>,
) -> Result<Option<&'a [u8]>, Error> {
(**self).handle(ctx).await
}
}
impl<T> AsyncInteractionHandler for InteractionModel<T>
where
T: AsyncDataHandler,
{
async fn handle<'a>(
&mut self,
ctx: &'a mut ProtoCtx<'_, '_>,
) -> Result<Option<&'a [u8]>, Error> {
InteractionModel::handle_async(self, ctx).await
}
}
}

View file

@ -160,13 +160,6 @@ pub mod msg {
pub inv_requests: Option<TLVArray<'a, CmdData<'a>>>, pub inv_requests: Option<TLVArray<'a, CmdData<'a>>>,
} }
// This enum is helpful when we are constructing the response
// step by step in incremental manner
pub enum InvRespTag {
SupressResponse = 0,
InvokeResponses = 1,
}
#[derive(FromTLV, ToTLV, Debug)] #[derive(FromTLV, ToTLV, Debug)]
#[tlvargs(lifetime = "'a")] #[tlvargs(lifetime = "'a")]
pub struct InvResp<'a> { pub struct InvResp<'a> {
@ -174,7 +167,14 @@ pub mod msg {
pub inv_responses: Option<TLVArray<'a, ib::InvResp<'a>>>, pub inv_responses: Option<TLVArray<'a, ib::InvResp<'a>>>,
} }
#[derive(Default, ToTLV, FromTLV)] // This enum is helpful when we are constructing the response
// step by step in incremental manner
pub enum InvRespTag {
SupressResponse = 0,
InvokeResponses = 1,
}
#[derive(Default, ToTLV, FromTLV, Debug)]
#[tlvargs(lifetime = "'a")] #[tlvargs(lifetime = "'a")]
pub struct ReadReq<'a> { pub struct ReadReq<'a> {
pub attr_requests: Option<TLVArray<'a, AttrPath>>, pub attr_requests: Option<TLVArray<'a, AttrPath>>,
@ -198,17 +198,17 @@ pub mod msg {
} }
} }
#[derive(ToTLV, FromTLV)] #[derive(FromTLV, ToTLV, Debug)]
#[tlvargs(lifetime = "'b")] #[tlvargs(lifetime = "'a")]
pub struct WriteReq<'a, 'b> { pub struct WriteReq<'a> {
pub supress_response: Option<bool>, pub supress_response: Option<bool>,
timed_request: Option<bool>, timed_request: Option<bool>,
pub write_requests: TLVArray<'a, AttrData<'b>>, pub write_requests: TLVArray<'a, AttrData<'a>>,
more_chunked: Option<bool>, more_chunked: Option<bool>,
} }
impl<'a, 'b> WriteReq<'a, 'b> { impl<'a> WriteReq<'a> {
pub fn new(supress_response: bool, write_requests: &'a [AttrData<'b>]) -> Self { pub fn new(supress_response: bool, write_requests: &'a [AttrData<'a>]) -> Self {
let mut w = Self { let mut w = Self {
supress_response: None, supress_response: None,
write_requests: TLVArray::new(write_requests), write_requests: TLVArray::new(write_requests),
@ -223,7 +223,7 @@ pub mod msg {
} }
// Report Data // Report Data
#[derive(FromTLV, ToTLV)] #[derive(FromTLV, ToTLV, Debug)]
#[tlvargs(lifetime = "'a")] #[tlvargs(lifetime = "'a")]
pub struct ReportDataMsg<'a> { pub struct ReportDataMsg<'a> {
pub subscription_id: Option<u32>, pub subscription_id: Option<u32>,
@ -243,7 +243,7 @@ pub mod msg {
} }
// Write Response // Write Response
#[derive(ToTLV, FromTLV)] #[derive(ToTLV, FromTLV, Debug)]
#[tlvargs(lifetime = "'a")] #[tlvargs(lifetime = "'a")]
pub struct WriteResp<'a> { pub struct WriteResp<'a> {
pub write_responses: TLVArray<'a, AttrStatus>, pub write_responses: TLVArray<'a, AttrStatus>,
@ -255,10 +255,10 @@ pub mod msg {
} }
pub mod ib { pub mod ib {
use std::fmt::Debug; use core::fmt::Debug;
use crate::{ use crate::{
data_model::objects::{AttrDetails, AttrId, ClusterId, EncodeValue, EndptId}, data_model::objects::{AttrDetails, AttrId, ClusterId, CmdId, EncodeValue, EndptId},
error::Error, error::Error,
interaction_model::core::IMStatusCode, interaction_model::core::IMStatusCode,
tlv::{FromTLV, Nullable, TLVElement, TLVWriter, TagType, ToTLV}, tlv::{FromTLV, Nullable, TLVElement, TLVWriter, TagType, ToTLV},
@ -276,18 +276,6 @@ pub mod ib {
} }
impl<'a> InvResp<'a> { impl<'a> InvResp<'a> {
pub fn cmd_new(
endpoint: EndptId,
cluster: ClusterId,
cmd: u16,
data: EncodeValue<'a>,
) -> Self {
Self::Cmd(CmdData::new(
CmdPath::new(Some(endpoint), Some(cluster), Some(cmd)),
data,
))
}
pub fn status_new(cmd_path: CmdPath, status: IMStatusCode, cluster_status: u16) -> Self { pub fn status_new(cmd_path: CmdPath, status: IMStatusCode, cluster_status: u16) -> Self {
Self::Status(CmdStatus { Self::Status(CmdStatus {
path: cmd_path, path: cmd_path,
@ -296,6 +284,23 @@ pub mod ib {
} }
} }
impl<'a> From<CmdData<'a>> for InvResp<'a> {
fn from(value: CmdData<'a>) -> Self {
Self::Cmd(value)
}
}
pub enum InvRespTag {
Cmd = 0,
Status = 1,
}
impl<'a> From<CmdStatus> for InvResp<'a> {
fn from(value: CmdStatus) -> Self {
Self::Status(value)
}
}
#[derive(FromTLV, ToTLV, Copy, Clone, PartialEq, Debug)] #[derive(FromTLV, ToTLV, Copy, Clone, PartialEq, Debug)]
pub struct CmdStatus { pub struct CmdStatus {
path: CmdPath, path: CmdPath,
@ -327,6 +332,11 @@ pub mod ib {
} }
} }
pub enum CmdDataTag {
Path = 0,
Data = 1,
}
// Status // Status
#[derive(Debug, Clone, Copy, PartialEq, FromTLV, ToTLV)] #[derive(Debug, Clone, Copy, PartialEq, FromTLV, ToTLV)]
pub struct Status { pub struct Status {
@ -352,10 +362,6 @@ pub mod ib {
} }
impl<'a> AttrResp<'a> { impl<'a> AttrResp<'a> {
pub fn new(data_ver: u32, path: &AttrPath, data: EncodeValue<'a>) -> Self {
AttrResp::Data(AttrData::new(Some(data_ver), *path, data))
}
pub fn unwrap_data(self) -> AttrData<'a> { pub fn unwrap_data(self) -> AttrData<'a> {
match self { match self {
AttrResp::Data(d) => d, AttrResp::Data(d) => d,
@ -366,6 +372,23 @@ pub mod ib {
} }
} }
impl<'a> From<AttrData<'a>> for AttrResp<'a> {
fn from(value: AttrData<'a>) -> Self {
Self::Data(value)
}
}
impl<'a> From<AttrStatus> for AttrResp<'a> {
fn from(value: AttrStatus) -> Self {
Self::Status(value)
}
}
pub enum AttrRespTag {
Status = 0,
Data = 1,
}
// Attribute Data // Attribute Data
#[derive(Clone, Copy, PartialEq, FromTLV, ToTLV, Debug)] #[derive(Clone, Copy, PartialEq, FromTLV, ToTLV, Debug)]
#[tlvargs(lifetime = "'a")] #[tlvargs(lifetime = "'a")]
@ -385,6 +408,12 @@ pub mod ib {
} }
} }
pub enum AttrDataTag {
DataVer = 0,
Path = 1,
Data = 2,
}
#[derive(Debug)] #[derive(Debug)]
/// Operations on an Interaction Model List /// Operations on an Interaction Model List
pub enum ListOperation { pub enum ListOperation {
@ -399,13 +428,9 @@ pub mod ib {
} }
/// Attribute Lists in Attribute Data are special. Infer the correct meaning using this function /// Attribute Lists in Attribute Data are special. Infer the correct meaning using this function
pub fn attr_list_write<F>( pub fn attr_list_write<F>(attr: &AttrDetails, data: &TLVElement, mut f: F) -> Result<(), Error>
attr: &AttrDetails,
data: &TLVElement,
mut f: F,
) -> Result<(), IMStatusCode>
where where
F: FnMut(ListOperation, &TLVElement) -> Result<(), IMStatusCode>, F: FnMut(ListOperation, &TLVElement) -> Result<(), Error>,
{ {
if let Some(Nullable::NotNull(index)) = attr.list_index { if let Some(Nullable::NotNull(index)) = attr.list_index {
// If list index is valid, // If list index is valid,
@ -499,13 +524,13 @@ pub mod ib {
pub fn new( pub fn new(
endpoint: Option<EndptId>, endpoint: Option<EndptId>,
cluster: Option<ClusterId>, cluster: Option<ClusterId>,
command: Option<u16>, command: Option<CmdId>,
) -> Self { ) -> Self {
Self { Self {
path: GenericPath { path: GenericPath {
endpoint, endpoint,
cluster, cluster,
leaf: command.map(|a| a as u32), leaf: command,
}, },
} }
} }
@ -532,20 +557,20 @@ pub mod ib {
} }
} }
#[derive(FromTLV, ToTLV, Copy, Clone)] #[derive(FromTLV, ToTLV, Copy, Clone, Debug)]
pub struct ClusterPath { pub struct ClusterPath {
pub node: Option<u64>, pub node: Option<u64>,
pub endpoint: EndptId, pub endpoint: EndptId,
pub cluster: ClusterId, pub cluster: ClusterId,
} }
#[derive(FromTLV, ToTLV, Copy, Clone)] #[derive(FromTLV, ToTLV, Copy, Clone, Debug)]
pub struct DataVersionFilter { pub struct DataVersionFilter {
pub path: ClusterPath, pub path: ClusterPath,
pub data_ver: u32, pub data_ver: u32,
} }
#[derive(FromTLV, ToTLV, Copy, Clone)] #[derive(FromTLV, ToTLV, Copy, Clone, Debug)]
#[tlvargs(datatype = "list")] #[tlvargs(datatype = "list")]
pub struct EventPath { pub struct EventPath {
pub node: Option<u64>, pub node: Option<u64>,
@ -555,7 +580,7 @@ pub mod ib {
pub is_urgent: Option<bool>, pub is_urgent: Option<bool>,
} }
#[derive(FromTLV, ToTLV, Copy, Clone)] #[derive(FromTLV, ToTLV, Copy, Clone, Debug)]
pub struct EventFilter { pub struct EventFilter {
pub node: Option<u64>, pub node: Option<u64>,
pub event_min: Option<u64>, pub event_min: Option<u64>,

View file

@ -15,73 +15,5 @@
* limitations under the License. * limitations under the License.
*/ */
use crate::{
error::Error,
tlv::TLVWriter,
transport::{exchange::Exchange, proto_demux::ResponseRequired, session::SessionHandle},
};
use self::{
core::OpCode,
messages::msg::{InvReq, StatusResp, WriteReq},
};
#[derive(PartialEq)]
pub enum TransactionState {
Ongoing,
Complete,
Terminate,
}
pub struct Transaction<'a, 'b> {
pub state: TransactionState,
pub session: &'a mut SessionHandle<'b>,
pub exch: &'a mut Exchange,
}
pub trait InteractionConsumer {
fn consume_invoke_cmd(
&self,
req: &InvReq,
trans: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(), Error>;
fn consume_read_attr(
&self,
// TODO: This handling is different from the other APIs here, identify
// consistent options for this trait
req: &[u8],
trans: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(), Error>;
fn consume_write_attr(
&self,
req: &WriteReq,
trans: &mut Transaction,
tw: &mut TLVWriter,
) -> Result<(), Error>;
fn consume_status_report(
&self,
_req: &StatusResp,
_trans: &mut Transaction,
_tw: &mut TLVWriter,
) -> Result<(OpCode, ResponseRequired), Error>;
fn consume_subscribe(
&self,
_req: &[u8],
_trans: &mut Transaction,
_tw: &mut TLVWriter,
) -> Result<(OpCode, ResponseRequired), Error>;
}
pub struct InteractionModel {
consumer: Box<dyn InteractionConsumer>,
}
pub mod command;
pub mod core; pub mod core;
pub mod messages; pub mod messages;
pub mod read;
pub mod write;

View file

@ -1,42 +0,0 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::{
error::Error,
interaction_model::core::OpCode,
tlv::TLVWriter,
transport::{packet::Packet, proto_demux::ResponseRequired},
};
use super::{InteractionModel, Transaction};
impl InteractionModel {
pub fn handle_read_req(
&mut self,
trans: &mut Transaction,
rx_buf: &[u8],
proto_tx: &mut Packet,
) -> Result<ResponseRequired, Error> {
proto_tx.set_proto_opcode(OpCode::ReportData as u8);
let proto_tx_wb = proto_tx.get_writebuf()?;
let mut tw = TLVWriter::new(proto_tx_wb);
self.consumer.consume_read_attr(rx_buf, trans, &mut tw)?;
Ok(ResponseRequired::Yes)
}
}

View file

@ -1,58 +0,0 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use log::error;
use crate::{
error::Error,
tlv::{get_root_node_struct, FromTLV, TLVWriter, TagType},
transport::{packet::Packet, proto_demux::ResponseRequired},
};
use super::{core::OpCode, messages::msg::WriteReq, InteractionModel, Transaction};
impl InteractionModel {
pub fn handle_write_req(
&mut self,
trans: &mut Transaction,
rx_buf: &[u8],
proto_tx: &mut Packet,
) -> Result<ResponseRequired, Error> {
if InteractionModel::req_timeout_handled(trans, proto_tx)? {
return Ok(ResponseRequired::Yes);
}
proto_tx.set_proto_opcode(OpCode::WriteResponse as u8);
let mut tw = TLVWriter::new(proto_tx.get_writebuf()?);
let root = get_root_node_struct(rx_buf)?;
let write_req = WriteReq::from_tlv(&root)?;
let supress_response = write_req.supress_response.unwrap_or_default();
tw.start_struct(TagType::Anonymous)?;
self.consumer
.consume_write_attr(&write_req, trans, &mut tw)?;
tw.end_container()?;
trans.complete();
if supress_response {
error!("Supress response is set, is this the expected handling?");
Ok(ResponseRequired::No)
} else {
Ok(ResponseRequired::Yes)
}
}
}

View file

@ -23,7 +23,7 @@
//! Currently Ethernet based transport is supported. //! Currently Ethernet based transport is supported.
//! //!
//! # Examples //! # Examples
//! ``` //! TODO: Fix once new API has stabilized a bit
//! use matter::{Matter, CommissioningData}; //! use matter::{Matter, CommissioningData};
//! use matter::data_model::device_types::device_type_add_on_off_light; //! use matter::data_model::device_types::device_type_add_on_off_light;
//! use matter::data_model::cluster_basic_information::BasicInfoConfig; //! use matter::data_model::cluster_basic_information::BasicInfoConfig;
@ -65,8 +65,11 @@
//! } //! }
//! // Start the Matter Daemon //! // Start the Matter Daemon
//! // matter.start_daemon().unwrap(); //! // matter.start_daemon().unwrap();
//! ``` //!
//! Start off exploring by going to the [Matter] object. //! Start off exploring by going to the [Matter] object.
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(feature = "nightly", feature(async_fn_in_trait))]
#![cfg_attr(feature = "nightly", allow(incomplete_features))]
pub mod acl; pub mod acl;
pub mod cert; pub mod cert;
@ -80,6 +83,7 @@ pub mod group_keys;
pub mod interaction_model; pub mod interaction_model;
pub mod mdns; pub mod mdns;
pub mod pairing; pub mod pairing;
pub mod persist;
pub mod secure_channel; pub mod secure_channel;
pub mod sys; pub mod sys;
pub mod tlv; pub mod tlv;

View file

@ -15,34 +15,58 @@
* limitations under the License. * limitations under the License.
*/ */
use std::sync::{Arc, Mutex, Once}; use core::fmt::Write;
use crate::{ use crate::error::Error;
error::Error,
sys::{sys_publish_service, SysMdnsService},
transport::udp::MATTER_PORT,
};
#[derive(Default)] pub trait Mdns {
/// The mDNS service handler fn add(
pub struct MdnsInner { &mut self,
/// Vendor ID name: &str,
vid: u16, service_type: &str,
/// Product ID port: u16,
pid: u16, txt_kvs: &[(&str, &str)],
/// Device name ) -> Result<(), Error>;
device_name: String,
fn remove(&mut self, name: &str, service_type: &str, port: u16) -> Result<(), Error>;
} }
pub struct Mdns { impl<T> Mdns for &mut T
inner: Mutex<MdnsInner>, where
T: Mdns,
{
fn add(
&mut self,
name: &str,
service_type: &str,
port: u16,
txt_kvs: &[(&str, &str)],
) -> Result<(), Error> {
(**self).add(name, service_type, port, txt_kvs)
}
fn remove(&mut self, name: &str, service_type: &str, port: u16) -> Result<(), Error> {
(**self).remove(name, service_type, port)
}
} }
const SHORT_DISCRIMINATOR_MASK: u16 = 0xF00; pub struct DummyMdns;
const SHORT_DISCRIMINATOR_SHIFT: u16 = 8;
static mut G_MDNS: Option<Arc<Mdns>> = None; impl Mdns for DummyMdns {
static INIT: Once = Once::new(); fn add(
&mut self,
_name: &str,
_service_type: &str,
_port: u16,
_txt_kvs: &[(&str, &str)],
) -> Result<(), Error> {
Ok(())
}
fn remove(&mut self, _name: &str, _service_type: &str, _port: u16) -> Result<(), Error> {
Ok(())
}
}
pub enum ServiceMode { pub enum ServiceMode {
/// The commissioned state /// The commissioned state
@ -51,68 +75,108 @@ pub enum ServiceMode {
Commissionable(u16), Commissionable(u16),
} }
impl Mdns { /// The mDNS service handler
fn new() -> Self { pub struct MdnsMgr<'a> {
/// Vendor ID
vid: u16,
/// Product ID
pid: u16,
/// Device name
device_name: heapless::String<32>,
/// Matter port
matter_port: u16,
/// mDns service
mdns: &'a mut dyn Mdns,
}
impl<'a> MdnsMgr<'a> {
pub fn new(
vid: u16,
pid: u16,
device_name: &str,
matter_port: u16,
mdns: &'a mut dyn Mdns,
) -> Self {
Self { Self {
inner: Mutex::new(MdnsInner { vid,
..Default::default() pid,
}), device_name: device_name.chars().take(32).collect(),
matter_port,
mdns,
} }
} }
/// Get a handle to the globally unique mDNS instance /// Publish an mDNS service
pub fn get() -> Result<Arc<Self>, Error> {
unsafe {
INIT.call_once(|| {
G_MDNS = Some(Arc::new(Mdns::new()));
});
Ok(G_MDNS.as_ref().ok_or(Error::Invalid)?.clone())
}
}
/// Set mDNS service specific values
/// Values like vid, pid, discriminator etc
// TODO: More things like device-type etc can be added here
pub fn set_values(&self, vid: u16, pid: u16, device_name: &str) {
let mut inner = self.inner.lock().unwrap();
inner.vid = vid;
inner.pid = pid;
inner.device_name = device_name.chars().take(32).collect();
}
/// Publish a mDNS service
/// name - is the service name (comma separated subtypes may follow) /// name - is the service name (comma separated subtypes may follow)
/// mode - the current service mode /// mode - the current service mode
#[allow(clippy::needless_pass_by_value)] #[allow(clippy::needless_pass_by_value)]
pub fn publish_service(&self, name: &str, mode: ServiceMode) -> Result<SysMdnsService, Error> { pub fn publish_service(&mut self, name: &str, mode: ServiceMode) -> Result<(), Error> {
match mode { match mode {
ServiceMode::Commissioned => { ServiceMode::Commissioned => self.mdns.add(name, "_matter._tcp", self.matter_port, &[]),
sys_publish_service(name, "_matter._tcp", MATTER_PORT, &[])
}
ServiceMode::Commissionable(discriminator) => { ServiceMode::Commissionable(discriminator) => {
let inner = self.inner.lock().unwrap(); let discriminator_str = Self::get_discriminator_str(discriminator);
let short = compute_short_discriminator(discriminator);
let serv_type = format!("_matterc._udp,_S{},_L{}", short, discriminator); let serv_type = self.get_service_type(discriminator);
let vp = self.get_vp();
let str_discriminator = format!("{}", discriminator);
let txt_kvs = [ let txt_kvs = [
["D", &str_discriminator], ("D", discriminator_str.as_str()),
["CM", "1"], ("CM", "1"),
["DN", &inner.device_name], ("DN", self.device_name.as_str()),
["VP", &format!("{}+{}", inner.vid, inner.pid)], ("VP", &vp),
["SII", "5000"], /* Sleepy Idle Interval */ ("SII", "5000"), /* Sleepy Idle Interval */
["SAI", "300"], /* Sleepy Active Interval */ ("SAI", "300"), /* Sleepy Active Interval */
["PH", "33"], /* Pairing Hint */ ("PH", "33"), /* Pairing Hint */
["PI", ""], /* Pairing Instruction */ ("PI", ""), /* Pairing Instruction */
]; ];
sys_publish_service(name, &serv_type, MATTER_PORT, &txt_kvs) self.mdns.add(name, &serv_type, self.matter_port, &txt_kvs)
} }
} }
} }
}
fn compute_short_discriminator(discriminator: u16) -> u16 { pub fn unpublish_service(&mut self, name: &str, mode: ServiceMode) -> Result<(), Error> {
match mode {
ServiceMode::Commissioned => self.mdns.remove(name, "_matter._tcp", self.matter_port),
ServiceMode::Commissionable(discriminator) => {
let serv_type = self.get_service_type(discriminator);
self.mdns.remove(name, &serv_type, self.matter_port)
}
}
}
fn get_service_type(&self, discriminator: u16) -> heapless::String<32> {
let short = Self::compute_short_discriminator(discriminator);
let mut serv_type = heapless::String::new();
write!(
&mut serv_type,
"_matterc._udp,_S{},_L{}",
short, discriminator
)
.unwrap();
serv_type
}
fn get_vp(&self) -> heapless::String<11> {
let mut vp = heapless::String::new();
write!(&mut vp, "{}+{}", self.vid, self.pid).unwrap();
vp
}
fn get_discriminator_str(discriminator: u16) -> heapless::String<5> {
discriminator.into()
}
fn compute_short_discriminator(discriminator: u16) -> u16 {
const SHORT_DISCRIMINATOR_MASK: u16 = 0xF00;
const SHORT_DISCRIMINATOR_SHIFT: u16 = 8;
(discriminator & SHORT_DISCRIMINATOR_MASK) >> SHORT_DISCRIMINATOR_SHIFT (discriminator & SHORT_DISCRIMINATOR_MASK) >> SHORT_DISCRIMINATOR_SHIFT
}
} }
#[cfg(test)] #[cfg(test)]
@ -122,11 +186,11 @@ mod tests {
#[test] #[test]
fn can_compute_short_discriminator() { fn can_compute_short_discriminator() {
let discriminator: u16 = 0b0000_1111_0000_0000; let discriminator: u16 = 0b0000_1111_0000_0000;
let short = compute_short_discriminator(discriminator); let short = MdnsMgr::compute_short_discriminator(discriminator);
assert_eq!(short, 0b1111); assert_eq!(short, 0b1111);
let discriminator: u16 = 840; let discriminator: u16 = 840;
let short = compute_short_discriminator(discriminator); let short = MdnsMgr::compute_short_discriminator(discriminator);
assert_eq!(short, 3); assert_eq!(short, 3);
} }
} }

View file

@ -15,56 +15,66 @@
* limitations under the License. * limitations under the License.
*/ */
use core::fmt::Write;
use super::*; use super::*;
pub(super) fn compute_pairing_code(comm_data: &CommissioningData) -> String { pub(super) fn compute_pairing_code(comm_data: &CommissioningData) -> heapless::String<32> {
// 0: no Vendor ID and Product ID present in Manual Pairing Code // 0: no Vendor ID and Product ID present in Manual Pairing Code
const VID_PID_PRESENT: u8 = 0; const VID_PID_PRESENT: u8 = 0;
let passwd = passwd_from_comm_data(comm_data); let passwd = passwd_from_comm_data(comm_data);
let CommissioningData { discriminator, .. } = comm_data; let CommissioningData { discriminator, .. } = comm_data;
let mut digits = String::new(); let mut digits = heapless::String::<32>::new();
digits.push_str(&((VID_PID_PRESENT << 2) | (discriminator >> 10) as u8).to_string()); write!(
digits.push_str(&format!( &mut digits,
"{:0>5}", "{}{:0>5}{:0>4}",
((discriminator & 0x300) << 6) | (passwd & 0x3FFF) as u16 (VID_PID_PRESENT << 2) | (discriminator >> 10) as u8,
)); ((discriminator & 0x300) << 6) | (passwd & 0x3FFF) as u16,
digits.push_str(&format!("{:0>4}", passwd >> 14)); passwd >> 14
)
.unwrap();
let check_digit = digits.calculate_verhoeff_check_digit(); let mut final_digits = heapless::String::<32>::new();
digits.push_str(&check_digit.to_string()); write!(
&mut final_digits,
"{}{}",
digits,
digits.calculate_verhoeff_check_digit()
)
.unwrap();
digits final_digits
} }
pub(super) fn pretty_print_pairing_code(pairing_code: &str) { pub(super) fn pretty_print_pairing_code(pairing_code: &str) {
assert!(pairing_code.len() == 11); assert!(pairing_code.len() == 11);
let mut pretty = String::new(); let mut pretty = heapless::String::<32>::new();
pretty.push_str(&pairing_code[..4]); pretty.push_str(&pairing_code[..4]).unwrap();
pretty.push('-'); pretty.push('-').unwrap();
pretty.push_str(&pairing_code[4..8]); pretty.push_str(&pairing_code[4..8]).unwrap();
pretty.push('-'); pretty.push('-').unwrap();
pretty.push_str(&pairing_code[8..]); pretty.push_str(&pairing_code[8..]).unwrap();
info!("Pairing Code: {}", pretty); info!("Pairing Code: {}", pretty);
} }
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use crate::secure_channel::spake2p::VerifierData; use crate::{secure_channel::spake2p::VerifierData, utils::rand::dummy_rand};
#[test] #[test]
fn can_compute_pairing_code() { fn can_compute_pairing_code() {
let comm_data = CommissioningData { let comm_data = CommissioningData {
verifier: VerifierData::new_with_pw(123456), verifier: VerifierData::new_with_pw(123456, dummy_rand),
discriminator: 250, discriminator: 250,
}; };
let pairing_code = compute_pairing_code(&comm_data); let pairing_code = compute_pairing_code(&comm_data);
assert_eq!(pairing_code, "00876800071"); assert_eq!(pairing_code, "00876800071");
let comm_data = CommissioningData { let comm_data = CommissioningData {
verifier: VerifierData::new_with_pw(34567890), verifier: VerifierData::new_with_pw(34567890, dummy_rand),
discriminator: 2976, discriminator: 2976,
}; };
let pairing_code = compute_pairing_code(&comm_data); let pairing_code = compute_pairing_code(&comm_data);

View file

@ -15,7 +15,7 @@
* limitations under the License. * limitations under the License.
*/ */
use std::collections::BTreeMap; use heapless::FnvIndexMap;
use crate::{ use crate::{
tlv::{TLVWriter, TagType}, tlv::{TLVWriter, TagType},
@ -55,7 +55,7 @@ const SERIAL_NUMBER_TAG: u8 = 0x00;
// const COMMISSIONING_TIMEOUT_TAG: u8 = 0x04; // const COMMISSIONING_TIMEOUT_TAG: u8 = 0x04;
pub enum QRCodeInfoType { pub enum QRCodeInfoType {
String(String), String(heapless::String<128>), // TODO: Big enough?
Int32(i32), Int32(i32),
Int64(i64), Int64(i64),
UInt32(u32), UInt32(u32),
@ -63,7 +63,7 @@ pub enum QRCodeInfoType {
} }
pub enum SerialNumber { pub enum SerialNumber {
String(String), String(heapless::String<128>),
UInt32(u32), UInt32(u32),
} }
@ -78,10 +78,10 @@ pub struct QrSetupPayload<'data> {
version: u8, version: u8,
flow_type: CommissionningFlowType, flow_type: CommissionningFlowType,
discovery_capabilities: DiscoveryCapabilities, discovery_capabilities: DiscoveryCapabilities,
dev_det: &'data BasicInfoConfig, dev_det: &'data BasicInfoConfig<'data>,
comm_data: &'data CommissioningData, comm_data: &'data CommissioningData,
// we use a BTreeMap to keep the order of the optional data stable // we use a BTreeMap to keep the order of the optional data stable
optional_data: BTreeMap<u8, OptionalQRCodeInfo>, optional_data: heapless::FnvIndexMap<u8, OptionalQRCodeInfo, 16>,
} }
impl<'data> QrSetupPayload<'data> { impl<'data> QrSetupPayload<'data> {
@ -98,11 +98,11 @@ impl<'data> QrSetupPayload<'data> {
discovery_capabilities, discovery_capabilities,
dev_det, dev_det,
comm_data, comm_data,
optional_data: BTreeMap::new(), optional_data: FnvIndexMap::new(),
}; };
if !dev_det.serial_no.is_empty() { if !dev_det.serial_no.is_empty() {
result.add_serial_number(SerialNumber::String(dev_det.serial_no.clone())); result.add_serial_number(SerialNumber::String(dev_det.serial_no.into()));
} }
result result
@ -137,7 +137,9 @@ impl<'data> QrSetupPayload<'data> {
} }
self.optional_data self.optional_data
.insert(tag, OptionalQRCodeInfo { tag, data }); .insert(tag, OptionalQRCodeInfo { tag, data })
.map_err(|_| Error::NoSpace)?;
Ok(()) Ok(())
} }
@ -155,11 +157,13 @@ impl<'data> QrSetupPayload<'data> {
} }
self.optional_data self.optional_data
.insert(tag, OptionalQRCodeInfo { tag, data }); .insert(tag, OptionalQRCodeInfo { tag, data })
.map_err(|_| Error::NoSpace)?;
Ok(()) Ok(())
} }
pub fn get_all_optional_data(&self) -> &BTreeMap<u8, OptionalQRCodeInfo> { pub fn get_all_optional_data(&self) -> &FnvIndexMap<u8, OptionalQRCodeInfo, 16> {
&self.optional_data &self.optional_data
} }
@ -388,7 +392,7 @@ fn generate_tlv_from_optional_data(
) -> Result<(), Error> { ) -> Result<(), Error> {
let size_needed = tlv_data.max_data_length_in_bytes as usize; let size_needed = tlv_data.max_data_length_in_bytes as usize;
let mut tlv_buffer = vec![0u8; size_needed]; let mut tlv_buffer = vec![0u8; size_needed];
let mut wb = WriteBuf::new(&mut tlv_buffer, size_needed); let mut wb = WriteBuf::new(&mut tlv_buffer);
let mut tw = TLVWriter::new(&mut wb); let mut tw = TLVWriter::new(&mut wb);
tw.start_struct(TagType::Anonymous)?; tw.start_struct(TagType::Anonymous)?;
@ -532,16 +536,15 @@ fn is_common_tag(tag: u8) -> bool {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use crate::secure_channel::spake2p::VerifierData; use crate::{secure_channel::spake2p::VerifierData, utils::rand::dummy_rand};
#[test] #[test]
fn can_base38_encode() { fn can_base38_encode() {
const QR_CODE: &str = "MT:YNJV7VSC00CMVH7SR00"; const QR_CODE: &str = "MT:YNJV7VSC00CMVH7SR00";
let comm_data = CommissioningData { let comm_data = CommissioningData {
verifier: VerifierData::new_with_pw(34567890), verifier: VerifierData::new_with_pw(34567890, dummy_rand),
discriminator: 2976, discriminator: 2976,
}; };
let dev_det = BasicInfoConfig { let dev_det = BasicInfoConfig {
@ -561,13 +564,13 @@ mod tests {
const QR_CODE: &str = "MT:-24J0AFN00KA064IJ3P0IXZB0DK5N1K8SQ1RYCU1-A40"; const QR_CODE: &str = "MT:-24J0AFN00KA064IJ3P0IXZB0DK5N1K8SQ1RYCU1-A40";
let comm_data = CommissioningData { let comm_data = CommissioningData {
verifier: VerifierData::new_with_pw(20202021), verifier: VerifierData::new_with_pw(20202021, dummy_rand),
discriminator: 3840, discriminator: 3840,
}; };
let dev_det = BasicInfoConfig { let dev_det = BasicInfoConfig {
vid: 65521, vid: 65521,
pid: 32769, pid: 32769,
serial_no: "1234567890".to_string(), serial_no: "1234567890",
..Default::default() ..Default::default()
}; };
@ -588,13 +591,13 @@ mod tests {
const OPTIONAL_DEFAULT_INT_VALUE: i32 = 65550; const OPTIONAL_DEFAULT_INT_VALUE: i32 = 65550;
let comm_data = CommissioningData { let comm_data = CommissioningData {
verifier: VerifierData::new_with_pw(20202021), verifier: VerifierData::new_with_pw(20202021, dummy_rand),
discriminator: 3840, discriminator: 3840,
}; };
let dev_det = BasicInfoConfig { let dev_det = BasicInfoConfig {
vid: 65521, vid: 65521,
pid: 32769, pid: 32769,
serial_no: "1234567890".to_string(), serial_no: "1234567890",
..Default::default() ..Default::default()
}; };
@ -604,7 +607,7 @@ mod tests {
qr_code_data qr_code_data
.add_optional_vendor_data( .add_optional_vendor_data(
OPTIONAL_DEFAULT_STRING_TAG, OPTIONAL_DEFAULT_STRING_TAG,
QRCodeInfoType::String(OPTIONAL_DEFAULT_STRING_VALUE.to_string()), QRCodeInfoType::String(OPTIONAL_DEFAULT_STRING_VALUE.into()),
) )
.expect("Failed to add optional data"); .expect("Failed to add optional data");

229
matter/src/persist.rs Normal file
View file

@ -0,0 +1,229 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::error::Error;
pub trait Psm {
fn set_kv_slice(&mut self, key: &str, val: &[u8]) -> Result<(), Error>;
fn get_kv_slice<'a>(&self, key: &str, buf: &'a mut [u8]) -> Result<&'a [u8], Error>;
fn set_kv_u64(&mut self, key: &str, val: u64) -> Result<(), Error>;
fn get_kv_u64(&self, key: &str) -> Result<u64, Error>;
fn remove(&mut self, key: &str) -> Result<(), Error>;
}
impl<T> Psm for &mut T
where
T: Psm,
{
fn set_kv_slice(&mut self, key: &str, val: &[u8]) -> Result<(), Error> {
(**self).set_kv_slice(key, val)
}
fn get_kv_slice<'a>(&self, key: &str, buf: &'a mut [u8]) -> Result<&'a [u8], Error> {
(**self).get_kv_slice(key, buf)
}
fn set_kv_u64(&mut self, key: &str, val: u64) -> Result<(), Error> {
(**self).set_kv_u64(key, val)
}
fn get_kv_u64(&self, key: &str) -> Result<u64, Error> {
(**self).get_kv_u64(key)
}
fn remove(&mut self, key: &str) -> Result<(), Error> {
(**self).remove(key)
}
}
#[cfg(feature = "nightly")]
pub mod asynch {
use crate::error::Error;
use super::Psm;
pub trait AsyncPsm {
async fn set_kv_slice<'a>(&'a mut self, key: &'a str, val: &'a [u8]) -> Result<(), Error>;
async fn get_kv_slice<'a, 'b>(
&'a self,
key: &'a str,
buf: &'b mut [u8],
) -> Result<&'b [u8], Error>;
async fn set_kv_u64<'a>(&'a mut self, key: &'a str, val: u64) -> Result<(), Error>;
async fn get_kv_u64<'a>(&'a self, key: &'a str) -> Result<u64, Error>;
async fn remove<'a>(&'a mut self, key: &'a str) -> Result<(), Error>;
}
impl<T> AsyncPsm for &mut T
where
T: AsyncPsm,
{
async fn set_kv_slice<'a>(&'a mut self, key: &'a str, val: &'a [u8]) -> Result<(), Error> {
(**self).set_kv_slice(key, val).await
}
async fn get_kv_slice<'a, 'b>(
&'a self,
key: &'a str,
buf: &'b mut [u8],
) -> Result<&'b [u8], Error> {
(**self).get_kv_slice(key, buf).await
}
async fn set_kv_u64<'a>(&'a mut self, key: &'a str, val: u64) -> Result<(), Error> {
(**self).set_kv_u64(key, val).await
}
async fn get_kv_u64<'a>(&'a self, key: &'a str) -> Result<u64, Error> {
(**self).get_kv_u64(key).await
}
async fn remove<'a>(&'a mut self, key: &'a str) -> Result<(), Error> {
(**self).remove(key).await
}
}
pub struct Asyncify<T>(pub T);
impl<T> AsyncPsm for Asyncify<T>
where
T: Psm,
{
async fn set_kv_slice<'a>(&'a mut self, key: &'a str, val: &'a [u8]) -> Result<(), Error> {
self.0.set_kv_slice(key, val)
}
async fn get_kv_slice<'a, 'b>(
&'a self,
key: &'a str,
buf: &'b mut [u8],
) -> Result<&'b [u8], Error> {
self.0.get_kv_slice(key, buf)
}
async fn set_kv_u64<'a>(&'a mut self, key: &'a str, val: u64) -> Result<(), Error> {
self.0.set_kv_u64(key, val)
}
async fn get_kv_u64<'a>(&'a self, key: &'a str) -> Result<u64, Error> {
self.0.get_kv_u64(key)
}
async fn remove<'a>(&'a mut self, key: &'a str) -> Result<(), Error> {
self.0.remove(key)
}
}
}
#[cfg(feature = "std")]
pub mod std {
use std::fs::{self, DirBuilder, File};
use std::io::{Read, Write};
use crate::error::Error;
use super::Psm;
pub struct FilePsm {}
const PSM_DIR: &str = "/tmp/matter_psm";
macro_rules! psm_path {
($key:ident) => {
format!("{}/{}", PSM_DIR, $key)
};
}
impl FilePsm {
pub fn new() -> Result<Self, Error> {
let result = DirBuilder::new().create(PSM_DIR);
if let Err(e) = result {
if e.kind() != std::io::ErrorKind::AlreadyExists {
return Err(e.into());
}
}
Ok(Self {})
}
pub fn set_kv_slice(&mut self, key: &str, val: &[u8]) -> Result<(), Error> {
let mut f = File::create(psm_path!(key))?;
f.write_all(val)?;
Ok(())
}
pub fn get_kv_slice<'a>(&self, key: &str, buf: &'a mut [u8]) -> Result<&'a [u8], Error> {
let mut f = File::open(psm_path!(key))?;
let mut offset = 0;
loop {
let len = f.read(&mut buf[offset..])?;
offset += len;
if len == 0 {
break;
}
}
Ok(&buf[..offset])
}
pub fn set_kv_u64(&mut self, key: &str, val: u64) -> Result<(), Error> {
let mut f = File::create(psm_path!(key))?;
f.write_all(&val.to_be_bytes())?;
Ok(())
}
pub fn get_kv_u64(&self, key: &str) -> Result<u64, Error> {
let mut f = File::open(psm_path!(key))?;
let mut buf = [0; 8];
f.read_exact(&mut buf)?;
Ok(u64::from_be_bytes(buf))
}
pub fn remove(&self, key: &str) -> Result<(), Error> {
fs::remove_file(psm_path!(key))?;
Ok(())
}
}
impl Psm for FilePsm {
fn set_kv_slice(&mut self, key: &str, val: &[u8]) -> Result<(), Error> {
FilePsm::set_kv_slice(self, key, val)
}
fn get_kv_slice<'a>(&self, key: &str, buf: &'a mut [u8]) -> Result<&'a [u8], Error> {
FilePsm::get_kv_slice(self, key, buf)
}
fn set_kv_u64(&mut self, key: &str, val: u64) -> Result<(), Error> {
FilePsm::set_kv_u64(self, key, val)
}
fn get_kv_u64(&self, key: &str) -> Result<u64, Error> {
FilePsm::get_kv_u64(self, key)
}
fn remove(&mut self, key: &str) -> Result<(), Error> {
FilePsm::remove(self, key)
}
}
}

View file

@ -15,27 +15,25 @@
* limitations under the License. * limitations under the License.
*/ */
use std::sync::Arc; use core::cell::RefCell;
use log::{error, trace}; use log::{error, trace};
use owning_ref::RwLockReadGuardRef;
use rand::prelude::*;
use crate::{ use crate::{
cert::Cert, cert::Cert,
crypto::{self, CryptoKeyPair, KeyPair, Sha256}, crypto::{self, KeyPair, Sha256},
error::Error, error::Error,
fabric::{Fabric, FabricMgr, FabricMgrInner}, fabric::{Fabric, FabricMgr},
secure_channel::common::SCStatusCodes, secure_channel::common::SCStatusCodes,
secure_channel::common::{self, OpCode}, secure_channel::common::{self, OpCode},
tlv::{get_root_node_struct, FromTLV, OctetStr, TLVElement, TLVWriter, TagType}, tlv::{get_root_node_struct, FromTLV, OctetStr, TLVElement, TLVWriter, TagType},
transport::{ transport::{
network::Address, network::Address,
proto_demux::{ProtoCtx, ResponseRequired}, proto_ctx::ProtoCtx,
queue::{Msg, WorkQ}, queue::{Msg, WorkQ},
session::{CaseDetails, CloneData, NocCatIds, SessionMode}, session::{CaseDetails, CloneData, NocCatIds, SessionMode},
}, },
utils::writebuf::WriteBuf, utils::{rand::Rand, writebuf::WriteBuf},
}; };
#[derive(PartialEq)] #[derive(PartialEq)]
@ -54,6 +52,7 @@ pub struct CaseSession {
peer_pub_key: [u8; crypto::EC_POINT_LEN_BYTES], peer_pub_key: [u8; crypto::EC_POINT_LEN_BYTES],
local_fabric_idx: usize, local_fabric_idx: usize,
} }
impl CaseSession { impl CaseSession {
pub fn new(peer_sessid: u16, local_sessid: u16) -> Result<Self, Error> { pub fn new(peer_sessid: u16, local_sessid: u16) -> Result<Self, Error> {
Ok(Self { Ok(Self {
@ -69,40 +68,43 @@ impl CaseSession {
} }
} }
pub struct Case { pub struct Case<'a> {
fabric_mgr: Arc<FabricMgr>, fabric_mgr: &'a RefCell<FabricMgr>,
rand: Rand,
} }
impl Case { impl<'a> Case<'a> {
pub fn new(fabric_mgr: Arc<FabricMgr>) -> Self { pub fn new(fabric_mgr: &'a RefCell<FabricMgr>, rand: Rand) -> Self {
Self { fabric_mgr } Self { fabric_mgr, rand }
} }
pub fn casesigma3_handler(&mut self, ctx: &mut ProtoCtx) -> Result<ResponseRequired, Error> { pub fn casesigma3_handler(&mut self, ctx: &mut ProtoCtx) -> Result<bool, Error> {
let mut case_session = ctx let mut case_session = ctx
.exch_ctx .exch_ctx
.exch .exch
.take_data_boxed::<CaseSession>() .take_case_session::<CaseSession>()
.ok_or(Error::InvalidState)?; .ok_or(Error::InvalidState)?;
if case_session.state != State::Sigma1Rx { if case_session.state != State::Sigma1Rx {
return Err(Error::Invalid); return Err(Error::Invalid);
} }
case_session.state = State::Sigma3Rx; case_session.state = State::Sigma3Rx;
let fabric = self.fabric_mgr.get_fabric(case_session.local_fabric_idx)?; let fabric_mgr = self.fabric_mgr.borrow();
let fabric = fabric_mgr.get_fabric(case_session.local_fabric_idx)?;
if fabric.is_none() { if fabric.is_none() {
common::create_sc_status_report( common::create_sc_status_report(
&mut ctx.tx, ctx.tx,
common::SCStatusCodes::NoSharedTrustRoots, common::SCStatusCodes::NoSharedTrustRoots,
None, None,
)?; )?;
ctx.exch_ctx.exch.close(); ctx.exch_ctx.exch.close();
return Ok(ResponseRequired::Yes); return Ok(true);
} }
// Safe to unwrap here // Safe to unwrap here
let fabric = fabric.as_ref().as_ref().unwrap(); let fabric = fabric.unwrap();
let root = get_root_node_struct(ctx.rx.as_borrow_slice())?; let root = get_root_node_struct(ctx.rx.as_slice())?;
let encrypted = root.find_tag(1)?.slice()?; let encrypted = root.find_tag(1)?.slice()?;
let mut decrypted: [u8; 800] = [0; 800]; let mut decrypted: [u8; 800] = [0; 800];
@ -126,13 +128,9 @@ impl Case {
} }
if let Err(e) = Case::validate_certs(fabric, &initiator_noc, &initiator_icac) { if let Err(e) = Case::validate_certs(fabric, &initiator_noc, &initiator_icac) {
error!("Certificate Chain doesn't match: {}", e); error!("Certificate Chain doesn't match: {}", e);
common::create_sc_status_report( common::create_sc_status_report(ctx.tx, common::SCStatusCodes::InvalidParameter, None)?;
&mut ctx.tx,
common::SCStatusCodes::InvalidParameter,
None,
)?;
ctx.exch_ctx.exch.close(); ctx.exch_ctx.exch.close();
return Ok(ResponseRequired::Yes); return Ok(true);
} }
if Case::validate_sigma3_sign( if Case::validate_sigma3_sign(
@ -145,19 +143,15 @@ impl Case {
.is_err() .is_err()
{ {
error!("Sigma3 Signature doesn't match"); error!("Sigma3 Signature doesn't match");
common::create_sc_status_report( common::create_sc_status_report(ctx.tx, common::SCStatusCodes::InvalidParameter, None)?;
&mut ctx.tx,
common::SCStatusCodes::InvalidParameter,
None,
)?;
ctx.exch_ctx.exch.close(); ctx.exch_ctx.exch.close();
return Ok(ResponseRequired::Yes); return Ok(true);
} }
// Only now do we add this message to the TT Hash // Only now do we add this message to the TT Hash
let mut peer_catids: NocCatIds = Default::default(); let mut peer_catids: NocCatIds = Default::default();
initiator_noc.get_cat_ids(&mut peer_catids); initiator_noc.get_cat_ids(&mut peer_catids);
case_session.tt_hash.update(ctx.rx.as_borrow_slice())?; case_session.tt_hash.update(ctx.rx.as_slice())?;
let clone_data = Case::get_session_clone_data( let clone_data = Case::get_session_clone_data(
fabric.ipk.op_key(), fabric.ipk.op_key(),
fabric.get_node_id(), fabric.get_node_id(),
@ -169,40 +163,36 @@ impl Case {
// Queue a transport mgr request to add a new session // Queue a transport mgr request to add a new session
WorkQ::get()?.sync_send(Msg::NewSession(clone_data))?; WorkQ::get()?.sync_send(Msg::NewSession(clone_data))?;
common::create_sc_status_report( common::create_sc_status_report(ctx.tx, SCStatusCodes::SessionEstablishmentSuccess, None)?;
&mut ctx.tx, ctx.exch_ctx.exch.clear_data();
SCStatusCodes::SessionEstablishmentSuccess,
None,
)?;
ctx.exch_ctx.exch.clear_data_boxed();
ctx.exch_ctx.exch.close(); ctx.exch_ctx.exch.close();
Ok(true)
Ok(ResponseRequired::Yes)
} }
pub fn casesigma1_handler(&mut self, ctx: &mut ProtoCtx) -> Result<ResponseRequired, Error> { pub fn casesigma1_handler(&mut self, ctx: &mut ProtoCtx) -> Result<bool, Error> {
ctx.tx.set_proto_opcode(OpCode::CASESigma2 as u8); ctx.tx.set_proto_opcode(OpCode::CASESigma2 as u8);
let rx_buf = ctx.rx.as_borrow_slice(); let rx_buf = ctx.rx.as_slice();
let root = get_root_node_struct(rx_buf)?; let root = get_root_node_struct(rx_buf)?;
let r = Sigma1Req::from_tlv(&root)?; let r = Sigma1Req::from_tlv(&root)?;
let local_fabric_idx = self let local_fabric_idx = self
.fabric_mgr .fabric_mgr
.borrow_mut()
.match_dest_id(r.initiator_random.0, r.dest_id.0); .match_dest_id(r.initiator_random.0, r.dest_id.0);
if local_fabric_idx.is_err() { if local_fabric_idx.is_err() {
error!("Fabric Index mismatch"); error!("Fabric Index mismatch");
common::create_sc_status_report( common::create_sc_status_report(
&mut ctx.tx, ctx.tx,
common::SCStatusCodes::NoSharedTrustRoots, common::SCStatusCodes::NoSharedTrustRoots,
None, None,
)?; )?;
ctx.exch_ctx.exch.close(); ctx.exch_ctx.exch.close();
return Ok(ResponseRequired::Yes); return Ok(true);
} }
let local_sessid = ctx.exch_ctx.sess.reserve_new_sess_id(); let local_sessid = ctx.exch_ctx.sess.reserve_new_sess_id();
let mut case_session = Box::new(CaseSession::new(r.initiator_sessid, local_sessid)?); let mut case_session = CaseSession::new(r.initiator_sessid, local_sessid)?;
case_session.tt_hash.update(rx_buf)?; case_session.tt_hash.update(rx_buf)?;
case_session.local_fabric_idx = local_fabric_idx?; case_session.local_fabric_idx = local_fabric_idx?;
if r.peer_pub_key.0.len() != crypto::EC_POINT_LEN_BYTES { if r.peer_pub_key.0.len() != crypto::EC_POINT_LEN_BYTES {
@ -228,7 +218,7 @@ impl Case {
// println!("Derived secret: {:x?} len: {}", secret, len); // println!("Derived secret: {:x?} len: {}", secret, len);
let mut our_random: [u8; 32] = [0; 32]; let mut our_random: [u8; 32] = [0; 32];
rand::thread_rng().fill_bytes(&mut our_random); (self.rand)(&mut our_random);
// Derive the Encrypted Part // Derive the Encrypted Part
const MAX_ENCRYPTED_SIZE: usize = 800; const MAX_ENCRYPTED_SIZE: usize = 800;
@ -236,19 +226,21 @@ impl Case {
let mut encrypted: [u8; MAX_ENCRYPTED_SIZE] = [0; MAX_ENCRYPTED_SIZE]; let mut encrypted: [u8; MAX_ENCRYPTED_SIZE] = [0; MAX_ENCRYPTED_SIZE];
let encrypted_len = { let encrypted_len = {
let mut signature = [0u8; crypto::EC_SIGNATURE_LEN_BYTES]; let mut signature = [0u8; crypto::EC_SIGNATURE_LEN_BYTES];
let fabric = self.fabric_mgr.get_fabric(case_session.local_fabric_idx)?; let fabric_mgr = self.fabric_mgr.borrow();
let fabric = fabric_mgr.get_fabric(case_session.local_fabric_idx)?;
if fabric.is_none() { if fabric.is_none() {
common::create_sc_status_report( common::create_sc_status_report(
&mut ctx.tx, ctx.tx,
common::SCStatusCodes::NoSharedTrustRoots, common::SCStatusCodes::NoSharedTrustRoots,
None, None,
)?; )?;
ctx.exch_ctx.exch.close(); ctx.exch_ctx.exch.close();
return Ok(ResponseRequired::Yes); return Ok(true);
} }
let sign_len = Case::get_sigma2_sign( let sign_len = Case::get_sigma2_sign(
&fabric, fabric.unwrap(),
&case_session.our_pub_key, &case_session.our_pub_key,
&case_session.peer_pub_key, &case_session.peer_pub_key,
&mut signature, &mut signature,
@ -256,7 +248,8 @@ impl Case {
let signature = &signature[..sign_len]; let signature = &signature[..sign_len];
Case::get_sigma2_encryption( Case::get_sigma2_encryption(
&fabric, fabric.unwrap(),
self.rand,
&our_random, &our_random,
&mut case_session, &mut case_session,
signature, signature,
@ -273,9 +266,9 @@ impl Case {
tw.str8(TagType::Context(3), &case_session.our_pub_key)?; tw.str8(TagType::Context(3), &case_session.our_pub_key)?;
tw.str16(TagType::Context(4), encrypted)?; tw.str16(TagType::Context(4), encrypted)?;
tw.end_container()?; tw.end_container()?;
case_session.tt_hash.update(ctx.tx.as_borrow_slice())?; case_session.tt_hash.update(ctx.tx.as_mut_slice())?;
ctx.exch_ctx.exch.set_data_boxed(case_session); ctx.exch_ctx.exch.set_case_session(case_session);
Ok(ResponseRequired::Yes) Ok(true)
} }
fn get_session_clone_data( fn get_session_clone_data(
@ -322,8 +315,8 @@ impl Case {
case_session: &CaseSession, case_session: &CaseSession,
) -> Result<(), Error> { ) -> Result<(), Error> {
const MAX_TBS_SIZE: usize = 800; const MAX_TBS_SIZE: usize = 800;
let mut buf: [u8; MAX_TBS_SIZE] = [0; MAX_TBS_SIZE]; let mut buf = [0; MAX_TBS_SIZE];
let mut write_buf = WriteBuf::new(&mut buf, MAX_TBS_SIZE); let mut write_buf = WriteBuf::new(&mut buf);
let mut tw = TLVWriter::new(&mut write_buf); let mut tw = TLVWriter::new(&mut write_buf);
tw.start_struct(TagType::Anonymous)?; tw.start_struct(TagType::Anonymous)?;
tw.str16(TagType::Context(1), initiator_noc)?; tw.str16(TagType::Context(1), initiator_noc)?;
@ -335,7 +328,7 @@ impl Case {
tw.end_container()?; tw.end_container()?;
let key = KeyPair::new_from_public(initiator_noc_cert.get_pubkey())?; let key = KeyPair::new_from_public(initiator_noc_cert.get_pubkey())?;
key.verify_msg(write_buf.as_slice(), sign)?; key.verify_msg(write_buf.into_slice(), sign)?;
Ok(()) Ok(())
} }
@ -372,12 +365,12 @@ impl Case {
if key.len() < 48 { if key.len() < 48 {
return Err(Error::NoSpace); return Err(Error::NoSpace);
} }
let mut salt = Vec::<u8>::with_capacity(256); let mut salt = heapless::Vec::<u8, 256>::new();
salt.extend_from_slice(ipk); salt.extend_from_slice(ipk).unwrap();
let tt = tt.clone(); let tt = tt.clone();
let mut tt_hash = [0u8; crypto::SHA256_HASH_LEN_BYTES]; let mut tt_hash = [0u8; crypto::SHA256_HASH_LEN_BYTES];
tt.finish(&mut tt_hash)?; tt.finish(&mut tt_hash)?;
salt.extend_from_slice(&tt_hash); salt.extend_from_slice(&tt_hash).unwrap();
// println!("Session Key: salt: {:x?}, len: {}", salt, salt.len()); // println!("Session Key: salt: {:x?}, len: {}", salt, salt.len());
crypto::hkdf_sha256(salt.as_slice(), shared_secret, &SEKEYS_INFO, key) crypto::hkdf_sha256(salt.as_slice(), shared_secret, &SEKEYS_INFO, key)
@ -420,14 +413,14 @@ impl Case {
if key.len() < 16 { if key.len() < 16 {
return Err(Error::NoSpace); return Err(Error::NoSpace);
} }
let mut salt = Vec::<u8>::with_capacity(256); let mut salt = heapless::Vec::<u8, 256>::new();
salt.extend_from_slice(ipk); salt.extend_from_slice(ipk).unwrap();
let tt = tt.clone(); let tt = tt.clone();
let mut tt_hash = [0u8; crypto::SHA256_HASH_LEN_BYTES]; let mut tt_hash = [0u8; crypto::SHA256_HASH_LEN_BYTES];
tt.finish(&mut tt_hash)?; tt.finish(&mut tt_hash)?;
salt.extend_from_slice(&tt_hash); salt.extend_from_slice(&tt_hash).unwrap();
// println!("Sigma3Key: salt: {:x?}, len: {}", salt, salt.len()); // println!("Sigma3Key: salt: {:x?}, len: {}", salt, salt.len());
crypto::hkdf_sha256(salt.as_slice(), shared_secret, &S3K_INFO, key) crypto::hkdf_sha256(salt.as_slice(), shared_secret, &S3K_INFO, key)
@ -447,16 +440,16 @@ impl Case {
if key.len() < 16 { if key.len() < 16 {
return Err(Error::NoSpace); return Err(Error::NoSpace);
} }
let mut salt = Vec::<u8>::with_capacity(256); let mut salt = heapless::Vec::<u8, 256>::new();
salt.extend_from_slice(ipk); salt.extend_from_slice(ipk).unwrap();
salt.extend_from_slice(our_random); salt.extend_from_slice(our_random).unwrap();
salt.extend_from_slice(&case_session.our_pub_key); salt.extend_from_slice(&case_session.our_pub_key).unwrap();
let tt = case_session.tt_hash.clone(); let tt = case_session.tt_hash.clone();
let mut tt_hash = [0u8; crypto::SHA256_HASH_LEN_BYTES]; let mut tt_hash = [0u8; crypto::SHA256_HASH_LEN_BYTES];
tt.finish(&mut tt_hash)?; tt.finish(&mut tt_hash)?;
salt.extend_from_slice(&tt_hash); salt.extend_from_slice(&tt_hash).unwrap();
// println!("Sigma2Key: salt: {:x?}, len: {}", salt, salt.len()); // println!("Sigma2Key: salt: {:x?}, len: {}", salt, salt.len());
crypto::hkdf_sha256(salt.as_slice(), &case_session.shared_secret, &S2K_INFO, key) crypto::hkdf_sha256(salt.as_slice(), &case_session.shared_secret, &S2K_INFO, key)
@ -467,17 +460,15 @@ impl Case {
} }
fn get_sigma2_encryption( fn get_sigma2_encryption(
fabric: &RwLockReadGuardRef<FabricMgrInner, Option<Fabric>>, fabric: &Fabric,
rand: Rand,
our_random: &[u8], our_random: &[u8],
case_session: &mut CaseSession, case_session: &mut CaseSession,
signature: &[u8], signature: &[u8],
out: &mut [u8], out: &mut [u8],
) -> Result<usize, Error> { ) -> Result<usize, Error> {
let mut resumption_id: [u8; 16] = [0; 16]; let mut resumption_id: [u8; 16] = [0; 16];
rand::thread_rng().fill_bytes(&mut resumption_id); rand(&mut resumption_id);
// We are guaranteed this unwrap will work
let fabric = fabric.as_ref().as_ref().unwrap();
let mut sigma2_key = [0_u8; crypto::SYMM_KEY_LEN_BYTES]; let mut sigma2_key = [0_u8; crypto::SYMM_KEY_LEN_BYTES];
Case::get_sigma2_key( Case::get_sigma2_key(
@ -487,7 +478,7 @@ impl Case {
&mut sigma2_key, &mut sigma2_key,
)?; )?;
let mut write_buf = WriteBuf::new(out, out.len()); let mut write_buf = WriteBuf::new(out);
let mut tw = TLVWriter::new(&mut write_buf); let mut tw = TLVWriter::new(&mut write_buf);
tw.start_struct(TagType::Anonymous)?; tw.start_struct(TagType::Anonymous)?;
tw.str16_as(TagType::Context(1), |buf| fabric.noc.as_tlv(buf))?; tw.str16_as(TagType::Context(1), |buf| fabric.noc.as_tlv(buf))?;
@ -517,20 +508,19 @@ impl Case {
cipher_text, cipher_text,
cipher_text.len() - TAG_LEN, cipher_text.len() - TAG_LEN,
)?; )?;
Ok(write_buf.as_slice().len()) Ok(write_buf.into_slice().len())
} }
fn get_sigma2_sign( fn get_sigma2_sign(
fabric: &RwLockReadGuardRef<FabricMgrInner, Option<Fabric>>, fabric: &Fabric,
our_pub_key: &[u8], our_pub_key: &[u8],
peer_pub_key: &[u8], peer_pub_key: &[u8],
signature: &mut [u8], signature: &mut [u8],
) -> Result<usize, Error> { ) -> Result<usize, Error> {
// We are guaranteed this unwrap will work // We are guaranteed this unwrap will work
let fabric = fabric.as_ref().as_ref().unwrap();
const MAX_TBS_SIZE: usize = 800; const MAX_TBS_SIZE: usize = 800;
let mut buf: [u8; MAX_TBS_SIZE] = [0; MAX_TBS_SIZE]; let mut buf = [0; MAX_TBS_SIZE];
let mut write_buf = WriteBuf::new(&mut buf, MAX_TBS_SIZE); let mut write_buf = WriteBuf::new(&mut buf);
let mut tw = TLVWriter::new(&mut write_buf); let mut tw = TLVWriter::new(&mut write_buf);
tw.start_struct(TagType::Anonymous)?; tw.start_struct(TagType::Anonymous)?;
tw.str16_as(TagType::Context(1), |buf| fabric.noc.as_tlv(buf))?; tw.str16_as(TagType::Context(1), |buf| fabric.noc.as_tlv(buf))?;
@ -541,7 +531,7 @@ impl Case {
tw.str8(TagType::Context(4), peer_pub_key)?; tw.str8(TagType::Context(4), peer_pub_key)?;
tw.end_container()?; tw.end_container()?;
//println!("TBS is {:x?}", write_buf.as_borrow_slice()); //println!("TBS is {:x?}", write_buf.as_borrow_slice());
fabric.sign_msg(write_buf.as_slice(), signature) fabric.sign_msg(write_buf.into_slice(), signature)
} }
} }

View file

@ -15,23 +15,14 @@
* limitations under the License. * limitations under the License.
*/ */
use boxslab::Slab;
use log::info;
use num_derive::FromPrimitive; use num_derive::FromPrimitive;
use crate::{ use crate::{error::Error, transport::packet::Packet};
error::Error,
transport::{
exchange::Exchange,
packet::{Packet, PacketPool},
session::SessionHandle,
},
};
use super::status_report::{create_status_report, GeneralCode}; use super::status_report::{create_status_report, GeneralCode};
/* Interaction Model ID as per the Matter Spec */ /* Interaction Model ID as per the Matter Spec */
pub const PROTO_ID_SECURE_CHANNEL: usize = 0x00; pub const PROTO_ID_SECURE_CHANNEL: u16 = 0x00;
#[derive(FromPrimitive, Debug)] #[derive(FromPrimitive, Debug)]
pub enum OpCode { pub enum OpCode {
@ -88,14 +79,15 @@ pub fn create_sc_status_report(
} }
pub fn create_mrp_standalone_ack(proto_tx: &mut Packet) { pub fn create_mrp_standalone_ack(proto_tx: &mut Packet) {
proto_tx.set_proto_id(PROTO_ID_SECURE_CHANNEL as u16); proto_tx.set_proto_id(PROTO_ID_SECURE_CHANNEL);
proto_tx.set_proto_opcode(OpCode::MRPStandAloneAck as u8); proto_tx.set_proto_opcode(OpCode::MRPStandAloneAck as u8);
proto_tx.unset_reliable(); proto_tx.unset_reliable();
} }
pub fn send_mrp_standalone_ack(exch: &mut Exchange, sess: &mut SessionHandle) -> Result<(), Error> { // TODO
info!("Sending standalone ACK"); // pub fn send_mrp_standalone_ack(exch: &mut Exchange, sess: &mut SessionHandle) -> Result<(), Error> {
let mut ack_packet = Slab::<PacketPool>::try_new(Packet::new_tx()?).ok_or(Error::NoMemory)?; // info!("Sending standalone ACK");
create_mrp_standalone_ack(&mut ack_packet); // let mut ack_packet = Slab::<PacketPool>::try_new(Packet::new_tx()?).ok_or(Error::NoMemory)?;
exch.send(ack_packet, sess) // create_mrp_standalone_ack(&mut ack_packet);
} // exch.send(ack_packet, sess)
// }

View file

@ -15,14 +15,11 @@
* limitations under the License. * limitations under the License.
*/ */
use std::sync::Arc; use core::cell::RefCell;
use crate::{ use crate::{
error::*, error::*, fabric::FabricMgr, mdns::MdnsMgr, secure_channel::common::*, tlv,
fabric::FabricMgr, transport::proto_ctx::ProtoCtx, utils::rand::Rand,
secure_channel::common::*,
tlv,
transport::proto_demux::{self, ProtoCtx, ResponseRequired},
}; };
use log::{error, info}; use log::{error, info};
use num; use num;
@ -32,48 +29,54 @@ use super::{case::Case, pake::PaseMgr};
/* Handle messages related to the Secure Channel /* Handle messages related to the Secure Channel
*/ */
pub struct SecureChannel { pub struct SecureChannel<'a> {
case: Case, case: Case<'a>,
pase: PaseMgr, pase: &'a RefCell<PaseMgr>,
mdns: &'a RefCell<MdnsMgr<'a>>,
} }
impl SecureChannel { impl<'a> SecureChannel<'a> {
pub fn new(pase: PaseMgr, fabric_mgr: Arc<FabricMgr>) -> SecureChannel { pub fn new(
pase: &'a RefCell<PaseMgr>,
fabric_mgr: &'a RefCell<FabricMgr>,
mdns: &'a RefCell<MdnsMgr<'a>>,
rand: Rand,
) -> Self {
SecureChannel { SecureChannel {
case: Case::new(fabric_mgr, rand),
pase, pase,
case: Case::new(fabric_mgr), mdns,
} }
} }
}
impl proto_demux::HandleProto for SecureChannel { pub fn handle(&mut self, ctx: &mut ProtoCtx) -> Result<bool, Error> {
fn handle_proto_id(&mut self, ctx: &mut ProtoCtx) -> Result<ResponseRequired, Error> {
let proto_opcode: OpCode = let proto_opcode: OpCode =
num::FromPrimitive::from_u8(ctx.rx.get_proto_opcode()).ok_or(Error::Invalid)?; num::FromPrimitive::from_u8(ctx.rx.get_proto_opcode()).ok_or(Error::Invalid)?;
ctx.tx.set_proto_id(PROTO_ID_SECURE_CHANNEL as u16); ctx.tx.set_proto_id(PROTO_ID_SECURE_CHANNEL);
info!("Received Opcode: {:?}", proto_opcode); info!("Received Opcode: {:?}", proto_opcode);
info!("Received Data:"); info!("Received Data:");
tlv::print_tlv_list(ctx.rx.as_borrow_slice()); tlv::print_tlv_list(ctx.rx.as_slice());
let result = match proto_opcode { let reply = match proto_opcode {
OpCode::MRPStandAloneAck => Ok(ResponseRequired::No), OpCode::MRPStandAloneAck => Ok(true),
OpCode::PBKDFParamRequest => self.pase.pbkdfparamreq_handler(ctx), OpCode::PBKDFParamRequest => self.pase.borrow_mut().pbkdfparamreq_handler(ctx),
OpCode::PASEPake1 => self.pase.pasepake1_handler(ctx), OpCode::PASEPake1 => self.pase.borrow_mut().pasepake1_handler(ctx),
OpCode::PASEPake3 => self.pase.pasepake3_handler(ctx), OpCode::PASEPake3 => self
.pase
.borrow_mut()
.pasepake3_handler(ctx, &mut self.mdns.borrow_mut()),
OpCode::CASESigma1 => self.case.casesigma1_handler(ctx), OpCode::CASESigma1 => self.case.casesigma1_handler(ctx),
OpCode::CASESigma3 => self.case.casesigma3_handler(ctx), OpCode::CASESigma3 => self.case.casesigma3_handler(ctx),
_ => { _ => {
error!("OpCode Not Handled: {:?}", proto_opcode); error!("OpCode Not Handled: {:?}", proto_opcode);
Err(Error::InvalidOpcode) Err(Error::InvalidOpcode)
} }
}; }?;
if result == Ok(ResponseRequired::Yes) {
if reply {
info!("Sending response"); info!("Sending response");
tlv::print_tlv_list(ctx.tx.as_borrow_slice()); tlv::print_tlv_list(ctx.tx.as_mut_slice());
}
result
} }
fn get_proto_id(&self) -> usize { Ok(reply)
PROTO_ID_SECURE_CHANNEL
} }
} }

View file

@ -15,40 +15,15 @@
* limitations under the License. * limitations under the License.
*/ */
use crate::error::Error; #[cfg(not(any(
feature = "crypto_openssl",
// This trait allows us to switch between crypto providers like OpenSSL and mbedTLS for Spake2 feature = "crypto_mbedtls",
// Currently this is only validate for a verifier(responder) feature = "crypto_esp_mbedtls"
)))]
// A verifier will typically do: pub use super::crypto_dummy::CryptoSpake2;
// Step 1: w0 and L #[cfg(feature = "crypto_esp_mbedtls")]
// set_w0_from_w0s pub use super::crypto_esp_mbedtls::CryptoSpake2;
// set_L #[cfg(feature = "crypto_mbedtls")]
// Step 2: get_pB pub use super::crypto_mbedtls::CryptoSpake2;
// Step 3: get_TT_as_verifier(pA) #[cfg(feature = "crypto_openssl")]
// Step 4: Computation of cA and cB happens outside since it doesn't use either BigNum or EcPoint pub use super::crypto_openssl::CryptoSpake2;
pub trait CryptoSpake2 {
fn new() -> Result<Self, Error>
where
Self: Sized;
fn set_w0_from_w0s(&mut self, w0s: &[u8]) -> Result<(), Error>;
fn set_w1_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error>;
fn set_w0(&mut self, w0: &[u8]) -> Result<(), Error>;
fn set_w1(&mut self, w1: &[u8]) -> Result<(), Error>;
#[allow(non_snake_case)]
fn set_L(&mut self, l: &[u8]) -> Result<(), Error>;
#[allow(non_snake_case)]
fn set_L_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error>;
#[allow(non_snake_case)]
fn get_pB(&mut self, pB: &mut [u8]) -> Result<(), Error>;
#[allow(non_snake_case)]
fn get_TT_as_verifier(
&mut self,
context: &[u8],
pA: &[u8],
pB: &[u8],
out: &mut [u8],
) -> Result<(), Error>;
}

View file

@ -0,0 +1,73 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::error::Error;
#[allow(non_snake_case)]
pub struct CryptoSpake2 {}
impl CryptoSpake2 {
#[allow(non_snake_case)]
pub fn new() -> Result<Self, Error> {
Ok(Self {})
}
// Computes w0 from w0s respectively
pub fn set_w0_from_w0s(&mut self, _w0s: &[u8]) -> Result<(), Error> {
Err(Error::Invalid)
}
pub fn set_w1_from_w1s(&mut self, _w1s: &[u8]) -> Result<(), Error> {
Err(Error::Invalid)
}
pub fn set_w0(&mut self, _w0: &[u8]) -> Result<(), Error> {
Err(Error::Invalid)
}
pub fn set_w1(&mut self, _w1: &[u8]) -> Result<(), Error> {
Err(Error::Invalid)
}
#[allow(non_snake_case)]
pub fn set_L(&mut self, _l: &[u8]) -> Result<(), Error> {
Err(Error::Invalid)
}
#[allow(non_snake_case)]
#[allow(dead_code)]
pub fn set_L_from_w1s(&mut self, _w1s: &[u8]) -> Result<(), Error> {
Err(Error::Invalid)
}
#[allow(non_snake_case)]
pub fn get_pB(&mut self, _pB: &mut [u8]) -> Result<(), Error> {
Err(Error::Invalid)
}
#[allow(non_snake_case)]
pub fn get_TT_as_verifier(
&mut self,
_context: &[u8],
_pA: &[u8],
_pB: &[u8],
_out: &mut [u8],
) -> Result<(), Error> {
Err(Error::Invalid)
}
}

View file

@ -17,8 +17,6 @@
use crate::error::Error; use crate::error::Error;
use super::crypto::CryptoSpake2;
const MATTER_M_BIN: [u8; 65] = [ const MATTER_M_BIN: [u8; 65] = [
0x04, 0x88, 0x6e, 0x2f, 0x97, 0xac, 0xe4, 0x6e, 0x55, 0xba, 0x9d, 0xd7, 0x24, 0x25, 0x79, 0xf2, 0x04, 0x88, 0x6e, 0x2f, 0x97, 0xac, 0xe4, 0x6e, 0x55, 0xba, 0x9d, 0xd7, 0x24, 0x25, 0x79, 0xf2,
0x99, 0x3b, 0x64, 0xe1, 0x6e, 0xf3, 0xdc, 0xab, 0x95, 0xaf, 0xd4, 0x97, 0x33, 0x3d, 0x8f, 0xa1, 0x99, 0x3b, 0x64, 0xe1, 0x6e, 0xf3, 0xdc, 0xab, 0x95, 0xaf, 0xd4, 0x97, 0x33, 0x3d, 0x8f, 0xa1,
@ -36,16 +34,16 @@ const MATTER_N_BIN: [u8; 65] = [
#[allow(non_snake_case)] #[allow(non_snake_case)]
pub struct CryptoEspMbedTls {} pub struct CryptoSpake2 {}
impl CryptoSpake2 for CryptoEspMbedTls { impl CryptoSpake2 {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn new() -> Result<Self, Error> { pub fn new() -> Result<Self, Error> {
Ok(CryptoEspMbedTls {}) Ok(Self {})
} }
// Computes w0 from w0s respectively // Computes w0 from w0s respectively
fn set_w0_from_w0s(&mut self, w0s: &[u8]) -> Result<(), Error> { pub fn set_w0_from_w0s(&mut self, w0s: &[u8]) -> Result<(), Error> {
// From the Matter Spec, // From the Matter Spec,
// w0 = w0s mod p // w0 = w0s mod p
// where p is the order of the curve // where p is the order of the curve
@ -53,7 +51,7 @@ impl CryptoSpake2 for CryptoEspMbedTls {
Ok(()) Ok(())
} }
fn set_w1_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error> { pub fn set_w1_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error> {
// From the Matter Spec, // From the Matter Spec,
// w1 = w1s mod p // w1 = w1s mod p
// where p is the order of the curve // where p is the order of the curve
@ -61,17 +59,17 @@ impl CryptoSpake2 for CryptoEspMbedTls {
Ok(()) Ok(())
} }
fn set_w0(&mut self, w0: &[u8]) -> Result<(), Error> { pub fn set_w0(&mut self, w0: &[u8]) -> Result<(), Error> {
Ok(()) Ok(())
} }
fn set_w1(&mut self, w1: &[u8]) -> Result<(), Error> { pub fn set_w1(&mut self, w1: &[u8]) -> Result<(), Error> {
Ok(()) Ok(())
} }
#[allow(non_snake_case)] #[allow(non_snake_case)]
#[allow(dead_code)] #[allow(dead_code)]
fn set_L(&mut self, w1s: &[u8]) -> Result<(), Error> { pub fn set_L(&mut self, w1s: &[u8]) -> Result<(), Error> {
// From the Matter spec, // From the Matter spec,
// L = w1 * P // L = w1 * P
// where P is the generator of the underlying elliptic curve // where P is the generator of the underlying elliptic curve
@ -79,7 +77,7 @@ impl CryptoSpake2 for CryptoEspMbedTls {
} }
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn get_pB(&mut self, pB: &mut [u8]) -> Result<(), Error> { pub fn get_pB(&mut self, pB: &mut [u8]) -> Result<(), Error> {
// From the SPAKE2+ spec (https://datatracker.ietf.org/doc/draft-bar-cfrg-spake2plus/) // From the SPAKE2+ spec (https://datatracker.ietf.org/doc/draft-bar-cfrg-spake2plus/)
// for y // for y
// - select random y between 0 to p // - select random y between 0 to p
@ -90,7 +88,7 @@ impl CryptoSpake2 for CryptoEspMbedTls {
} }
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn get_TT_as_verifier( pub fn get_TT_as_verifier(
&mut self, &mut self,
context: &[u8], context: &[u8],
pA: &[u8], pA: &[u8],
@ -101,13 +99,10 @@ impl CryptoSpake2 for CryptoEspMbedTls {
} }
} }
impl CryptoEspMbedTls {}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::CryptoEspMbedTls; use super::CryptoSpake2;
use crate::secure_channel::crypto::CryptoSpake2;
use crate::secure_channel::spake2p_test_vectors::test_vectors::*; use crate::secure_channel::spake2p_test_vectors::test_vectors::*;
use openssl::bn::BigNum; use openssl::bn::BigNum;
use openssl::ec::{EcPoint, PointConversionForm}; use openssl::ec::{EcPoint, PointConversionForm};
@ -116,13 +111,12 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_X() { fn test_get_X() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoEspMbedTls::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let x = BigNum::from_slice(&t.x).unwrap(); let x = BigNum::from_slice(&t.x).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
let P = c.group.generator(); let P = c.group.generator();
let r = let r = CryptoSpake2::do_add_mul(P, &x, &c.M, &c.w0, &c.group, &mut c.bn_ctx).unwrap();
CryptoEspMbedTls::do_add_mul(P, &x, &c.M, &c.w0, &c.group, &mut c.bn_ctx).unwrap();
assert_eq!( assert_eq!(
t.X, t.X,
r.to_bytes(&c.group, PointConversionForm::UNCOMPRESSED, &mut c.bn_ctx) r.to_bytes(&c.group, PointConversionForm::UNCOMPRESSED, &mut c.bn_ctx)
@ -136,12 +130,11 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_Y() { fn test_get_Y() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoEspMbedTls::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let y = BigNum::from_slice(&t.y).unwrap(); let y = BigNum::from_slice(&t.y).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
let P = c.group.generator(); let P = c.group.generator();
let r = let r = CryptoSpake2::do_add_mul(P, &y, &c.N, &c.w0, &c.group, &mut c.bn_ctx).unwrap();
CryptoEspMbedTls::do_add_mul(P, &y, &c.N, &c.w0, &c.group, &mut c.bn_ctx).unwrap();
assert_eq!( assert_eq!(
t.Y, t.Y,
r.to_bytes(&c.group, PointConversionForm::UNCOMPRESSED, &mut c.bn_ctx) r.to_bytes(&c.group, PointConversionForm::UNCOMPRESSED, &mut c.bn_ctx)
@ -155,12 +148,12 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_ZV_as_prover() { fn test_get_ZV_as_prover() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoEspMbedTls::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let x = BigNum::from_slice(&t.x).unwrap(); let x = BigNum::from_slice(&t.x).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
c.set_w1(&t.w1).unwrap(); c.set_w1(&t.w1).unwrap();
let Y = EcPoint::from_bytes(&c.group, &t.Y, &mut c.bn_ctx).unwrap(); let Y = EcPoint::from_bytes(&c.group, &t.Y, &mut c.bn_ctx).unwrap();
let (Z, V) = CryptoEspMbedTls::get_ZV_as_prover( let (Z, V) = CryptoSpake2::get_ZV_as_prover(
&c.w0, &c.w0,
&c.w1, &c.w1,
&mut c.N, &mut c.N,
@ -191,12 +184,12 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_ZV_as_verifier() { fn test_get_ZV_as_verifier() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoEspMbedTls::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let y = BigNum::from_slice(&t.y).unwrap(); let y = BigNum::from_slice(&t.y).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
let X = EcPoint::from_bytes(&c.group, &t.X, &mut c.bn_ctx).unwrap(); let X = EcPoint::from_bytes(&c.group, &t.X, &mut c.bn_ctx).unwrap();
let L = EcPoint::from_bytes(&c.group, &t.L, &mut c.bn_ctx).unwrap(); let L = EcPoint::from_bytes(&c.group, &t.L, &mut c.bn_ctx).unwrap();
let (Z, V) = CryptoEspMbedTls::get_ZV_as_verifier( let (Z, V) = CryptoSpake2::get_ZV_as_verifier(
&c.w0, &c.w0,
&L, &L,
&mut c.M, &mut c.M,

View file

@ -15,14 +15,11 @@
* limitations under the License. * limitations under the License.
*/ */
use std::{ use alloc::sync::Arc;
ops::{Mul, Sub}, use core::ops::{Mul, Sub};
sync::Arc,
};
use crate::error::Error; use crate::error::Error;
use super::crypto::CryptoSpake2;
use byteorder::{ByteOrder, LittleEndian}; use byteorder::{ByteOrder, LittleEndian};
use log::error; use log::error;
use mbedtls::{ use mbedtls::{
@ -33,6 +30,8 @@ use mbedtls::{
rng::{CtrDrbg, OsEntropy}, rng::{CtrDrbg, OsEntropy},
}; };
extern crate alloc;
const MATTER_M_BIN: [u8; 65] = [ const MATTER_M_BIN: [u8; 65] = [
0x04, 0x88, 0x6e, 0x2f, 0x97, 0xac, 0xe4, 0x6e, 0x55, 0xba, 0x9d, 0xd7, 0x24, 0x25, 0x79, 0xf2, 0x04, 0x88, 0x6e, 0x2f, 0x97, 0xac, 0xe4, 0x6e, 0x55, 0xba, 0x9d, 0xd7, 0x24, 0x25, 0x79, 0xf2,
0x99, 0x3b, 0x64, 0xe1, 0x6e, 0xf3, 0xdc, 0xab, 0x95, 0xaf, 0xd4, 0x97, 0x33, 0x3d, 0x8f, 0xa1, 0x99, 0x3b, 0x64, 0xe1, 0x6e, 0xf3, 0xdc, 0xab, 0x95, 0xaf, 0xd4, 0x97, 0x33, 0x3d, 0x8f, 0xa1,
@ -50,7 +49,7 @@ const MATTER_N_BIN: [u8; 65] = [
#[allow(non_snake_case)] #[allow(non_snake_case)]
pub struct CryptoMbedTLS { pub struct CryptoSpake2 {
group: EcGroup, group: EcGroup,
order: Mpi, order: Mpi,
xy: Mpi, xy: Mpi,
@ -62,15 +61,15 @@ pub struct CryptoMbedTLS {
pB: EcPoint, pB: EcPoint,
} }
impl CryptoSpake2 for CryptoMbedTLS { impl CryptoSpake2 {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn new() -> Result<Self, Error> { pub fn new() -> Result<Self, Error> {
let group = EcGroup::new(mbedtls::pk::EcGroupId::SecP256R1)?; let group = EcGroup::new(mbedtls::pk::EcGroupId::SecP256R1)?;
let order = group.order()?; let order = group.order()?;
let M = EcPoint::from_binary(&group, &MATTER_M_BIN)?; let M = EcPoint::from_binary(&group, &MATTER_M_BIN)?;
let N = EcPoint::from_binary(&group, &MATTER_N_BIN)?; let N = EcPoint::from_binary(&group, &MATTER_N_BIN)?;
Ok(CryptoMbedTLS { Ok(Self {
group, group,
order, order,
xy: Mpi::new(0)?, xy: Mpi::new(0)?,
@ -84,7 +83,7 @@ impl CryptoSpake2 for CryptoMbedTLS {
} }
// Computes w0 from w0s respectively // Computes w0 from w0s respectively
fn set_w0_from_w0s(&mut self, w0s: &[u8]) -> Result<(), Error> { pub fn set_w0_from_w0s(&mut self, w0s: &[u8]) -> Result<(), Error> {
// From the Matter Spec, // From the Matter Spec,
// w0 = w0s mod p // w0 = w0s mod p
// where p is the order of the curve // where p is the order of the curve
@ -94,7 +93,7 @@ impl CryptoSpake2 for CryptoMbedTLS {
Ok(()) Ok(())
} }
fn set_w1_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error> { pub fn set_w1_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error> {
// From the Matter Spec, // From the Matter Spec,
// w1 = w1s mod p // w1 = w1s mod p
// where p is the order of the curve // where p is the order of the curve
@ -104,24 +103,25 @@ impl CryptoSpake2 for CryptoMbedTLS {
Ok(()) Ok(())
} }
fn set_w0(&mut self, w0: &[u8]) -> Result<(), Error> { pub fn set_w0(&mut self, w0: &[u8]) -> Result<(), Error> {
self.w0 = Mpi::from_binary(w0)?; self.w0 = Mpi::from_binary(w0)?;
Ok(()) Ok(())
} }
fn set_w1(&mut self, w1: &[u8]) -> Result<(), Error> { pub fn set_w1(&mut self, w1: &[u8]) -> Result<(), Error> {
self.w1 = Mpi::from_binary(w1)?; self.w1 = Mpi::from_binary(w1)?;
Ok(()) Ok(())
} }
fn set_L(&mut self, l: &[u8]) -> Result<(), Error> { #[allow(non_snake_case)]
pub fn set_L(&mut self, l: &[u8]) -> Result<(), Error> {
self.L = EcPoint::from_binary(&self.group, l)?; self.L = EcPoint::from_binary(&self.group, l)?;
Ok(()) Ok(())
} }
#[allow(non_snake_case)] #[allow(non_snake_case)]
#[allow(dead_code)] #[allow(dead_code)]
fn set_L_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error> { pub fn set_L_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error> {
// From the Matter spec, // From the Matter spec,
// L = w1 * P // L = w1 * P
// where P is the generator of the underlying elliptic curve // where P is the generator of the underlying elliptic curve
@ -132,7 +132,7 @@ impl CryptoSpake2 for CryptoMbedTLS {
} }
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn get_pB(&mut self, pB: &mut [u8]) -> Result<(), Error> { pub fn get_pB(&mut self, pB: &mut [u8]) -> Result<(), Error> {
// From the SPAKE2+ spec (https://datatracker.ietf.org/doc/draft-bar-cfrg-spake2plus/) // From the SPAKE2+ spec (https://datatracker.ietf.org/doc/draft-bar-cfrg-spake2plus/)
// for y // for y
// - select random y between 0 to p // - select random y between 0 to p
@ -157,7 +157,7 @@ impl CryptoSpake2 for CryptoMbedTLS {
} }
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn get_TT_as_verifier( pub fn get_TT_as_verifier(
&mut self, &mut self,
context: &[u8], context: &[u8],
pA: &[u8], pA: &[u8],
@ -166,21 +166,21 @@ impl CryptoSpake2 for CryptoMbedTLS {
) -> Result<(), Error> { ) -> Result<(), Error> {
let mut TT = Md::new(mbedtls::hash::Type::Sha256)?; let mut TT = Md::new(mbedtls::hash::Type::Sha256)?;
// context // context
CryptoMbedTLS::add_to_tt(&mut TT, context)?; Self::add_to_tt(&mut TT, context)?;
// 2 empty identifiers // 2 empty identifiers
CryptoMbedTLS::add_to_tt(&mut TT, &[])?; Self::add_to_tt(&mut TT, &[])?;
CryptoMbedTLS::add_to_tt(&mut TT, &[])?; Self::add_to_tt(&mut TT, &[])?;
// M // M
CryptoMbedTLS::add_to_tt(&mut TT, &MATTER_M_BIN)?; Self::add_to_tt(&mut TT, &MATTER_M_BIN)?;
// N // N
CryptoMbedTLS::add_to_tt(&mut TT, &MATTER_N_BIN)?; Self::add_to_tt(&mut TT, &MATTER_N_BIN)?;
// X = pA // X = pA
CryptoMbedTLS::add_to_tt(&mut TT, pA)?; Self::add_to_tt(&mut TT, pA)?;
// Y = pB // Y = pB
CryptoMbedTLS::add_to_tt(&mut TT, pB)?; Self::add_to_tt(&mut TT, pB)?;
let X = EcPoint::from_binary(&self.group, pA)?; let X = EcPoint::from_binary(&self.group, pA)?;
let (Z, V) = CryptoMbedTLS::get_ZV_as_verifier( let (Z, V) = Self::get_ZV_as_verifier(
&self.w0, &self.w0,
&self.L, &self.L,
&mut self.M, &mut self.M,
@ -193,24 +193,22 @@ impl CryptoSpake2 for CryptoMbedTLS {
// Z // Z
let tmp = Z.to_binary(&self.group, false)?; let tmp = Z.to_binary(&self.group, false)?;
let tmp = tmp.as_slice(); let tmp = tmp.as_slice();
CryptoMbedTLS::add_to_tt(&mut TT, tmp)?; Self::add_to_tt(&mut TT, tmp)?;
// V // V
let tmp = V.to_binary(&self.group, false)?; let tmp = V.to_binary(&self.group, false)?;
let tmp = tmp.as_slice(); let tmp = tmp.as_slice();
CryptoMbedTLS::add_to_tt(&mut TT, tmp)?; Self::add_to_tt(&mut TT, tmp)?;
// w0 // w0
let tmp = self.w0.to_binary()?; let tmp = self.w0.to_binary()?;
let tmp = tmp.as_slice(); let tmp = tmp.as_slice();
CryptoMbedTLS::add_to_tt(&mut TT, tmp)?; Self::add_to_tt(&mut TT, tmp)?;
TT.finish(out)?; TT.finish(out)?;
Ok(()) Ok(())
} }
}
impl CryptoMbedTLS {
fn add_to_tt(tt: &mut Md, buf: &[u8]) -> Result<(), Error> { fn add_to_tt(tt: &mut Md, buf: &[u8]) -> Result<(), Error> {
let mut len_buf: [u8; 8] = [0; 8]; let mut len_buf: [u8; 8] = [0; 8];
LittleEndian::write_u64(&mut len_buf, buf.len() as u64); LittleEndian::write_u64(&mut len_buf, buf.len() as u64);
@ -247,7 +245,7 @@ impl CryptoMbedTLS {
let mut tmp = x.mul(w0)?; let mut tmp = x.mul(w0)?;
tmp = tmp.modulo(order)?; tmp = tmp.modulo(order)?;
let inverted_N = CryptoMbedTLS::invert(group, N)?; let inverted_N = Self::invert(group, N)?;
let Z = EcPoint::muladd(group, Y, x, &inverted_N, &tmp)?; let Z = EcPoint::muladd(group, Y, x, &inverted_N, &tmp)?;
// Cofactor for P256 is 1, so that is a No-Op // Cofactor for P256 is 1, so that is a No-Op
@ -283,7 +281,7 @@ impl CryptoMbedTLS {
let mut tmp = y.mul(w0)?; let mut tmp = y.mul(w0)?;
tmp = tmp.modulo(order)?; tmp = tmp.modulo(order)?;
let inverted_M = CryptoMbedTLS::invert(group, M)?; let inverted_M = Self::invert(group, M)?;
let Z = EcPoint::muladd(group, X, y, &inverted_M, &tmp)?; let Z = EcPoint::muladd(group, X, y, &inverted_M, &tmp)?;
// Cofactor for P256 is 1, so that is a No-Op // Cofactor for P256 is 1, so that is a No-Op
@ -302,8 +300,7 @@ impl CryptoMbedTLS {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::CryptoMbedTLS; use super::CryptoSpake2;
use crate::secure_channel::crypto::CryptoSpake2;
use crate::secure_channel::spake2p_test_vectors::test_vectors::*; use crate::secure_channel::spake2p_test_vectors::test_vectors::*;
use mbedtls::bignum::Mpi; use mbedtls::bignum::Mpi;
use mbedtls::ecp::EcPoint; use mbedtls::ecp::EcPoint;
@ -312,7 +309,7 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_X() { fn test_get_X() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoMbedTLS::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let x = Mpi::from_binary(&t.x).unwrap(); let x = Mpi::from_binary(&t.x).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
let P = c.group.generator().unwrap(); let P = c.group.generator().unwrap();
@ -326,7 +323,7 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_Y() { fn test_get_Y() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoMbedTLS::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let y = Mpi::from_binary(&t.y).unwrap(); let y = Mpi::from_binary(&t.y).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
let P = c.group.generator().unwrap(); let P = c.group.generator().unwrap();
@ -339,12 +336,12 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_ZV_as_prover() { fn test_get_ZV_as_prover() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoMbedTLS::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let x = Mpi::from_binary(&t.x).unwrap(); let x = Mpi::from_binary(&t.x).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
c.set_w1(&t.w1).unwrap(); c.set_w1(&t.w1).unwrap();
let Y = EcPoint::from_binary(&c.group, &t.Y).unwrap(); let Y = EcPoint::from_binary(&c.group, &t.Y).unwrap();
let (Z, V) = CryptoMbedTLS::get_ZV_as_prover( let (Z, V) = CryptoSpake2::get_ZV_as_prover(
&c.w0, &c.w0,
&c.w1, &c.w1,
&mut c.N, &mut c.N,
@ -364,12 +361,12 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_ZV_as_verifier() { fn test_get_ZV_as_verifier() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoMbedTLS::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let y = Mpi::from_binary(&t.y).unwrap(); let y = Mpi::from_binary(&t.y).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
let X = EcPoint::from_binary(&c.group, &t.X).unwrap(); let X = EcPoint::from_binary(&c.group, &t.X).unwrap();
let L = EcPoint::from_binary(&c.group, &t.L).unwrap(); let L = EcPoint::from_binary(&c.group, &t.L).unwrap();
let (Z, V) = CryptoMbedTLS::get_ZV_as_verifier( let (Z, V) = CryptoSpake2::get_ZV_as_verifier(
&c.w0, &c.w0,
&L, &L,
&mut c.M, &mut c.M,

View file

@ -17,7 +17,6 @@
use crate::error::Error; use crate::error::Error;
use super::crypto::CryptoSpake2;
use byteorder::{ByteOrder, LittleEndian}; use byteorder::{ByteOrder, LittleEndian};
use log::error; use log::error;
use openssl::{ use openssl::{
@ -44,7 +43,7 @@ const MATTER_N_BIN: [u8; 65] = [
#[allow(non_snake_case)] #[allow(non_snake_case)]
pub struct CryptoOpenSSL { pub struct CryptoSpake2 {
group: EcGroup, group: EcGroup,
bn_ctx: BigNumContext, bn_ctx: BigNumContext,
// Stores the randomly generated x or y depending upon who we are // Stores the randomly generated x or y depending upon who we are
@ -58,9 +57,9 @@ pub struct CryptoOpenSSL {
order: BigNum, order: BigNum,
} }
impl CryptoSpake2 for CryptoOpenSSL { impl CryptoSpake2 {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn new() -> Result<Self, Error> { pub fn new() -> Result<Self, Error> {
let group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1)?; let group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1)?;
let mut bn_ctx = BigNumContext::new()?; let mut bn_ctx = BigNumContext::new()?;
let M = EcPoint::from_bytes(&group, &MATTER_M_BIN, &mut bn_ctx)?; let M = EcPoint::from_bytes(&group, &MATTER_M_BIN, &mut bn_ctx)?;
@ -70,7 +69,7 @@ impl CryptoSpake2 for CryptoOpenSSL {
let mut order = BigNum::new()?; let mut order = BigNum::new()?;
group.as_ref().order(&mut order, &mut bn_ctx)?; group.as_ref().order(&mut order, &mut bn_ctx)?;
Ok(CryptoOpenSSL { Ok(Self {
group, group,
bn_ctx, bn_ctx,
xy: BigNum::new()?, xy: BigNum::new()?,
@ -85,7 +84,7 @@ impl CryptoSpake2 for CryptoOpenSSL {
} }
// Computes w0 from w0s respectively // Computes w0 from w0s respectively
fn set_w0_from_w0s(&mut self, w0s: &[u8]) -> Result<(), Error> { pub fn set_w0_from_w0s(&mut self, w0s: &[u8]) -> Result<(), Error> {
// From the Matter Spec, // From the Matter Spec,
// w0 = w0s mod p // w0 = w0s mod p
// where p is the order of the curve // where p is the order of the curve
@ -96,7 +95,7 @@ impl CryptoSpake2 for CryptoOpenSSL {
Ok(()) Ok(())
} }
fn set_w1_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error> { pub fn set_w1_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error> {
// From the Matter Spec, // From the Matter Spec,
// w1 = w1s mod p // w1 = w1s mod p
// where p is the order of the curve // where p is the order of the curve
@ -107,24 +106,24 @@ impl CryptoSpake2 for CryptoOpenSSL {
Ok(()) Ok(())
} }
fn set_w0(&mut self, w0: &[u8]) -> Result<(), Error> { pub fn set_w0(&mut self, w0: &[u8]) -> Result<(), Error> {
self.w0 = BigNum::from_slice(w0)?; self.w0 = BigNum::from_slice(w0)?;
Ok(()) Ok(())
} }
fn set_w1(&mut self, w1: &[u8]) -> Result<(), Error> { pub fn set_w1(&mut self, w1: &[u8]) -> Result<(), Error> {
self.w1 = BigNum::from_slice(w1)?; self.w1 = BigNum::from_slice(w1)?;
Ok(()) Ok(())
} }
fn set_L(&mut self, l: &[u8]) -> Result<(), Error> { pub fn set_L(&mut self, l: &[u8]) -> Result<(), Error> {
self.L = EcPoint::from_bytes(&self.group, l, &mut self.bn_ctx)?; self.L = EcPoint::from_bytes(&self.group, l, &mut self.bn_ctx)?;
Ok(()) Ok(())
} }
#[allow(non_snake_case)] #[allow(non_snake_case)]
#[allow(dead_code)] #[allow(dead_code)]
fn set_L_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error> { pub fn set_L_from_w1s(&mut self, w1s: &[u8]) -> Result<(), Error> {
// From the Matter spec, // From the Matter spec,
// L = w1 * P // L = w1 * P
// where P is the generator of the underlying elliptic curve // where P is the generator of the underlying elliptic curve
@ -135,7 +134,7 @@ impl CryptoSpake2 for CryptoOpenSSL {
} }
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn get_pB(&mut self, pB: &mut [u8]) -> Result<(), Error> { pub fn get_pB(&mut self, pB: &mut [u8]) -> Result<(), Error> {
// From the SPAKE2+ spec (https://datatracker.ietf.org/doc/draft-bar-cfrg-spake2plus/) // From the SPAKE2+ spec (https://datatracker.ietf.org/doc/draft-bar-cfrg-spake2plus/)
// for y // for y
// - select random y between 0 to p // - select random y between 0 to p
@ -143,7 +142,7 @@ impl CryptoSpake2 for CryptoOpenSSL {
// - pB = Y // - pB = Y
self.order.rand_range(&mut self.xy)?; self.order.rand_range(&mut self.xy)?;
let P = self.group.generator(); let P = self.group.generator();
self.pB = CryptoOpenSSL::do_add_mul( self.pB = Self::do_add_mul(
P, P,
&self.xy, &self.xy,
&self.N, &self.N,
@ -166,7 +165,7 @@ impl CryptoSpake2 for CryptoOpenSSL {
} }
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn get_TT_as_verifier( pub fn get_TT_as_verifier(
&mut self, &mut self,
context: &[u8], context: &[u8],
pA: &[u8], pA: &[u8],
@ -175,21 +174,21 @@ impl CryptoSpake2 for CryptoOpenSSL {
) -> Result<(), Error> { ) -> Result<(), Error> {
let mut TT = Hasher::new(MessageDigest::sha256())?; let mut TT = Hasher::new(MessageDigest::sha256())?;
// context // context
CryptoOpenSSL::add_to_tt(&mut TT, context)?; Self::add_to_tt(&mut TT, context)?;
// 2 empty identifiers // 2 empty identifiers
CryptoOpenSSL::add_to_tt(&mut TT, &[])?; Self::add_to_tt(&mut TT, &[])?;
CryptoOpenSSL::add_to_tt(&mut TT, &[])?; Self::add_to_tt(&mut TT, &[])?;
// M // M
CryptoOpenSSL::add_to_tt(&mut TT, &MATTER_M_BIN)?; Self::add_to_tt(&mut TT, &MATTER_M_BIN)?;
// N // N
CryptoOpenSSL::add_to_tt(&mut TT, &MATTER_N_BIN)?; Self::add_to_tt(&mut TT, &MATTER_N_BIN)?;
// X = pA // X = pA
CryptoOpenSSL::add_to_tt(&mut TT, pA)?; Self::add_to_tt(&mut TT, pA)?;
// Y = pB // Y = pB
CryptoOpenSSL::add_to_tt(&mut TT, pB)?; Self::add_to_tt(&mut TT, pB)?;
let X = EcPoint::from_bytes(&self.group, pA, &mut self.bn_ctx)?; let X = EcPoint::from_bytes(&self.group, pA, &mut self.bn_ctx)?;
let (Z, V) = CryptoOpenSSL::get_ZV_as_verifier( let (Z, V) = Self::get_ZV_as_verifier(
&self.w0, &self.w0,
&self.L, &self.L,
&mut self.M, &mut self.M,
@ -207,7 +206,7 @@ impl CryptoSpake2 for CryptoOpenSSL {
&mut self.bn_ctx, &mut self.bn_ctx,
)?; )?;
let tmp = tmp.as_slice(); let tmp = tmp.as_slice();
CryptoOpenSSL::add_to_tt(&mut TT, tmp)?; Self::add_to_tt(&mut TT, tmp)?;
// V // V
let tmp = V.to_bytes( let tmp = V.to_bytes(
@ -216,20 +215,18 @@ impl CryptoSpake2 for CryptoOpenSSL {
&mut self.bn_ctx, &mut self.bn_ctx,
)?; )?;
let tmp = tmp.as_slice(); let tmp = tmp.as_slice();
CryptoOpenSSL::add_to_tt(&mut TT, tmp)?; Self::add_to_tt(&mut TT, tmp)?;
// w0 // w0
let tmp = self.w0.to_vec(); let tmp = self.w0.to_vec();
let tmp = tmp.as_slice(); let tmp = tmp.as_slice();
CryptoOpenSSL::add_to_tt(&mut TT, tmp)?; Self::add_to_tt(&mut TT, tmp)?;
let h = TT.finish()?; let h = TT.finish()?;
TT_hash.copy_from_slice(h.as_ref()); TT_hash.copy_from_slice(h.as_ref());
Ok(()) Ok(())
} }
}
impl CryptoOpenSSL {
fn add_to_tt(tt: &mut Hasher, buf: &[u8]) -> Result<(), Error> { fn add_to_tt(tt: &mut Hasher, buf: &[u8]) -> Result<(), Error> {
let mut len_buf: [u8; 8] = [0; 8]; let mut len_buf: [u8; 8] = [0; 8];
LittleEndian::write_u64(&mut len_buf, buf.len() as u64); LittleEndian::write_u64(&mut len_buf, buf.len() as u64);
@ -286,11 +283,11 @@ impl CryptoOpenSSL {
let mut tmp = BigNum::new()?; let mut tmp = BigNum::new()?;
tmp.mod_mul(x, w0, order, bn_ctx)?; tmp.mod_mul(x, w0, order, bn_ctx)?;
N.invert(group, bn_ctx)?; N.invert(group, bn_ctx)?;
let Z = CryptoOpenSSL::do_add_mul(Y, x, N, &tmp, group, bn_ctx)?; let Z = Self::do_add_mul(Y, x, N, &tmp, group, bn_ctx)?;
// Cofactor for P256 is 1, so that is a No-Op // Cofactor for P256 is 1, so that is a No-Op
tmp.mod_mul(w1, w0, order, bn_ctx)?; tmp.mod_mul(w1, w0, order, bn_ctx)?;
let V = CryptoOpenSSL::do_add_mul(Y, w1, N, &tmp, group, bn_ctx)?; let V = Self::do_add_mul(Y, w1, N, &tmp, group, bn_ctx)?;
Ok((Z, V)) Ok((Z, V))
} }
@ -321,7 +318,7 @@ impl CryptoOpenSSL {
let mut tmp = BigNum::new()?; let mut tmp = BigNum::new()?;
tmp.mod_mul(y, w0, order, bn_ctx)?; tmp.mod_mul(y, w0, order, bn_ctx)?;
M.invert(group, bn_ctx)?; M.invert(group, bn_ctx)?;
let Z = CryptoOpenSSL::do_add_mul(X, y, M, &tmp, group, bn_ctx)?; let Z = Self::do_add_mul(X, y, M, &tmp, group, bn_ctx)?;
// Cofactor for P256 is 1, so that is a No-Op // Cofactor for P256 is 1, so that is a No-Op
let mut V = EcPoint::new(group)?; let mut V = EcPoint::new(group)?;
@ -333,7 +330,7 @@ impl CryptoOpenSSL {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::CryptoOpenSSL; use super::CryptoSpake2;
use crate::secure_channel::crypto::CryptoSpake2; use crate::secure_channel::crypto::CryptoSpake2;
use crate::secure_channel::spake2p_test_vectors::test_vectors::*; use crate::secure_channel::spake2p_test_vectors::test_vectors::*;
use openssl::bn::BigNum; use openssl::bn::BigNum;
@ -343,12 +340,12 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_X() { fn test_get_X() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoOpenSSL::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let x = BigNum::from_slice(&t.x).unwrap(); let x = BigNum::from_slice(&t.x).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
let P = c.group.generator(); let P = c.group.generator();
let r = CryptoOpenSSL::do_add_mul(P, &x, &c.M, &c.w0, &c.group, &mut c.bn_ctx).unwrap(); let r = CryptoSpake2::do_add_mul(P, &x, &c.M, &c.w0, &c.group, &mut c.bn_ctx).unwrap();
assert_eq!( assert_eq!(
t.X, t.X,
r.to_bytes(&c.group, PointConversionForm::UNCOMPRESSED, &mut c.bn_ctx) r.to_bytes(&c.group, PointConversionForm::UNCOMPRESSED, &mut c.bn_ctx)
@ -362,11 +359,11 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_Y() { fn test_get_Y() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoOpenSSL::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let y = BigNum::from_slice(&t.y).unwrap(); let y = BigNum::from_slice(&t.y).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
let P = c.group.generator(); let P = c.group.generator();
let r = CryptoOpenSSL::do_add_mul(P, &y, &c.N, &c.w0, &c.group, &mut c.bn_ctx).unwrap(); let r = CryptoSpake2::do_add_mul(P, &y, &c.N, &c.w0, &c.group, &mut c.bn_ctx).unwrap();
assert_eq!( assert_eq!(
t.Y, t.Y,
r.to_bytes(&c.group, PointConversionForm::UNCOMPRESSED, &mut c.bn_ctx) r.to_bytes(&c.group, PointConversionForm::UNCOMPRESSED, &mut c.bn_ctx)
@ -380,12 +377,12 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_ZV_as_prover() { fn test_get_ZV_as_prover() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoOpenSSL::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let x = BigNum::from_slice(&t.x).unwrap(); let x = BigNum::from_slice(&t.x).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
c.set_w1(&t.w1).unwrap(); c.set_w1(&t.w1).unwrap();
let Y = EcPoint::from_bytes(&c.group, &t.Y, &mut c.bn_ctx).unwrap(); let Y = EcPoint::from_bytes(&c.group, &t.Y, &mut c.bn_ctx).unwrap();
let (Z, V) = CryptoOpenSSL::get_ZV_as_prover( let (Z, V) = CryptoSpake2::get_ZV_as_prover(
&c.w0, &c.w0,
&c.w1, &c.w1,
&mut c.N, &mut c.N,
@ -416,12 +413,12 @@ mod tests {
#[allow(non_snake_case)] #[allow(non_snake_case)]
fn test_get_ZV_as_verifier() { fn test_get_ZV_as_verifier() {
for t in RFC_T { for t in RFC_T {
let mut c = CryptoOpenSSL::new().unwrap(); let mut c = CryptoSpake2::new().unwrap();
let y = BigNum::from_slice(&t.y).unwrap(); let y = BigNum::from_slice(&t.y).unwrap();
c.set_w0(&t.w0).unwrap(); c.set_w0(&t.w0).unwrap();
let X = EcPoint::from_bytes(&c.group, &t.X, &mut c.bn_ctx).unwrap(); let X = EcPoint::from_bytes(&c.group, &t.X, &mut c.bn_ctx).unwrap();
let L = EcPoint::from_bytes(&c.group, &t.L, &mut c.bn_ctx).unwrap(); let L = EcPoint::from_bytes(&c.group, &t.L, &mut c.bn_ctx).unwrap();
let (Z, V) = CryptoOpenSSL::get_ZV_as_verifier( let (Z, V) = CryptoSpake2::get_ZV_as_verifier(
&c.w0, &c.w0,
&L, &L,
&mut c.M, &mut c.M,

View file

@ -17,10 +17,17 @@
pub mod case; pub mod case;
pub mod common; pub mod common;
#[cfg(not(any(
feature = "crypto_openssl",
feature = "crypto_mbedtls",
feature = "crypto_esp_mbedtls",
feature = "crypto_rustcrypto"
)))]
mod crypto_dummy;
#[cfg(feature = "crypto_esp_mbedtls")] #[cfg(feature = "crypto_esp_mbedtls")]
pub mod crypto_esp_mbedtls; mod crypto_esp_mbedtls;
#[cfg(feature = "crypto_mbedtls")] #[cfg(feature = "crypto_mbedtls")]
pub mod crypto_mbedtls; mod crypto_mbedtls;
#[cfg(feature = "crypto_openssl")] #[cfg(feature = "crypto_openssl")]
pub mod crypto_openssl; pub mod crypto_openssl;
#[cfg(feature = "crypto_rustcrypto")] #[cfg(feature = "crypto_rustcrypto")]

View file

@ -15,10 +15,7 @@
* limitations under the License. * limitations under the License.
*/ */
use std::{ use core::{fmt::Write, time::Duration};
sync::{Arc, Mutex},
time::{Duration, SystemTime},
};
use super::{ use super::{
common::{create_sc_status_report, SCStatusCodes}, common::{create_sc_status_report, SCStatusCodes},
@ -27,97 +24,115 @@ use super::{
use crate::{ use crate::{
crypto, crypto,
error::Error, error::Error,
mdns::{self, Mdns}, mdns::{MdnsMgr, ServiceMode},
secure_channel::common::OpCode, secure_channel::common::OpCode,
sys::SysMdnsService,
tlv::{self, get_root_node_struct, FromTLV, OctetStr, TLVElement, TLVWriter, TagType, ToTLV}, tlv::{self, get_root_node_struct, FromTLV, OctetStr, TLVElement, TLVWriter, TagType, ToTLV},
transport::{ transport::{
exchange::ExchangeCtx, exchange::ExchangeCtx,
network::Address, network::Address,
proto_demux::{ProtoCtx, ResponseRequired}, proto_ctx::ProtoCtx,
queue::{Msg, WorkQ}, queue::{Msg, WorkQ},
session::{CloneData, SessionMode}, session::{CloneData, SessionMode},
}, },
utils::{epoch::Epoch, rand::Rand},
}; };
use log::{error, info}; use log::{error, info};
use rand::prelude::*;
#[allow(clippy::large_enum_variant)]
enum PaseMgrState { enum PaseMgrState {
Enabled(PAKE, SysMdnsService), Enabled(Pake, heapless::String<16>, u16),
Disabled, Disabled,
} }
pub struct PaseMgrInternal { // Could this lock be avoided?
pub struct PaseMgr {
state: PaseMgrState, state: PaseMgrState,
epoch: Epoch,
rand: Rand,
} }
#[derive(Clone)]
// Could this lock be avoided?
pub struct PaseMgr(Arc<Mutex<PaseMgrInternal>>);
impl PaseMgr { impl PaseMgr {
pub fn new() -> Self { pub fn new(epoch: Epoch, rand: Rand) -> Self {
Self(Arc::new(Mutex::new(PaseMgrInternal { Self {
state: PaseMgrState::Disabled, state: PaseMgrState::Disabled,
}))) epoch,
rand,
}
} }
pub fn enable_pase_session( pub fn enable_pase_session(
&mut self, &mut self,
verifier: VerifierData, verifier: VerifierData,
discriminator: u16, discriminator: u16,
mdns: &mut MdnsMgr,
) -> Result<(), Error> { ) -> Result<(), Error> {
let mut s = self.0.lock().unwrap(); let mut buf = [0; 8];
let name: u64 = rand::thread_rng().gen_range(0..0xFFFFFFFFFFFFFFFF); (self.rand)(&mut buf);
let name = format!("{:016X}", name); let num = u64::from_be_bytes(buf);
let mdns = Mdns::get()?
.publish_service(&name, mdns::ServiceMode::Commissionable(discriminator))?; let mut mdns_service_name = heapless::String::<16>::new();
s.state = PaseMgrState::Enabled(PAKE::new(verifier), mdns); write!(&mut mdns_service_name, "{:016X}", num).unwrap();
mdns.publish_service(
&mdns_service_name,
ServiceMode::Commissionable(discriminator),
)?;
self.state = PaseMgrState::Enabled(
Pake::new(verifier, self.epoch, self.rand),
mdns_service_name,
discriminator,
);
Ok(()) Ok(())
} }
pub fn disable_pase_session(&mut self) { pub fn disable_pase_session(&mut self, mdns: &mut MdnsMgr) -> Result<(), Error> {
let mut s = self.0.lock().unwrap(); if let PaseMgrState::Enabled(_, mdns_service_name, discriminator) = &self.state {
s.state = PaseMgrState::Disabled; mdns.unpublish_service(
mdns_service_name,
ServiceMode::Commissionable(*discriminator),
)?;
}
self.state = PaseMgrState::Disabled;
Ok(())
} }
/// If the PASE Session is enabled, execute the closure, /// If the PASE Session is enabled, execute the closure,
/// if not enabled, generate SC Status Report /// if not enabled, generate SC Status Report
fn if_enabled<F>(&mut self, ctx: &mut ProtoCtx, f: F) -> Result<(), Error> fn if_enabled<F>(&mut self, ctx: &mut ProtoCtx, f: F) -> Result<(), Error>
where where
F: FnOnce(&mut PAKE, &mut ProtoCtx) -> Result<(), Error>, F: FnOnce(&mut Pake, &mut ProtoCtx) -> Result<(), Error>,
{ {
let mut s = self.0.lock().unwrap(); if let PaseMgrState::Enabled(pake, _, _) = &mut self.state {
if let PaseMgrState::Enabled(pake, _) = &mut s.state {
f(pake, ctx) f(pake, ctx)
} else { } else {
error!("PASE Not enabled"); error!("PASE Not enabled");
create_sc_status_report(&mut ctx.tx, SCStatusCodes::InvalidParameter, None) create_sc_status_report(ctx.tx, SCStatusCodes::InvalidParameter, None)
} }
} }
pub fn pbkdfparamreq_handler(&mut self, ctx: &mut ProtoCtx) -> Result<ResponseRequired, Error> { pub fn pbkdfparamreq_handler(&mut self, ctx: &mut ProtoCtx) -> Result<bool, Error> {
ctx.tx.set_proto_opcode(OpCode::PBKDFParamResponse as u8); ctx.tx.set_proto_opcode(OpCode::PBKDFParamResponse as u8);
self.if_enabled(ctx, |pake, ctx| pake.handle_pbkdfparamrequest(ctx))?; self.if_enabled(ctx, |pake, ctx| pake.handle_pbkdfparamrequest(ctx))?;
Ok(ResponseRequired::Yes) Ok(true)
} }
pub fn pasepake1_handler(&mut self, ctx: &mut ProtoCtx) -> Result<ResponseRequired, Error> { pub fn pasepake1_handler(&mut self, ctx: &mut ProtoCtx) -> Result<bool, Error> {
ctx.tx.set_proto_opcode(OpCode::PASEPake2 as u8); ctx.tx.set_proto_opcode(OpCode::PASEPake2 as u8);
self.if_enabled(ctx, |pake, ctx| pake.handle_pasepake1(ctx))?; self.if_enabled(ctx, |pake, ctx| pake.handle_pasepake1(ctx))?;
Ok(ResponseRequired::Yes) Ok(true)
} }
pub fn pasepake3_handler(&mut self, ctx: &mut ProtoCtx) -> Result<ResponseRequired, Error> { pub fn pasepake3_handler(
&mut self,
ctx: &mut ProtoCtx,
mdns: &mut MdnsMgr,
) -> Result<bool, Error> {
self.if_enabled(ctx, |pake, ctx| pake.handle_pasepake3(ctx))?; self.if_enabled(ctx, |pake, ctx| pake.handle_pasepake3(ctx))?;
self.disable_pase_session(); self.disable_pase_session(mdns)?;
Ok(ResponseRequired::Yes) Ok(true)
}
}
impl Default for PaseMgr {
fn default() -> Self {
Self::new()
} }
} }
@ -131,30 +146,31 @@ const PASE_DISCARD_TIMEOUT_SECS: Duration = Duration::from_secs(60);
const SPAKE2_SESSION_KEYS_INFO: [u8; 11] = *b"SessionKeys"; const SPAKE2_SESSION_KEYS_INFO: [u8; 11] = *b"SessionKeys";
struct SessionData { struct SessionData {
start_time: SystemTime, start_time: Duration,
exch_id: u16, exch_id: u16,
peer_addr: Address, peer_addr: Address,
spake2p: Box<Spake2P>, spake2p: Spake2P,
} }
impl SessionData { impl SessionData {
fn is_sess_expired(&self) -> Result<bool, Error> { fn is_sess_expired(&self, epoch: Epoch) -> Result<bool, Error> {
if SystemTime::now().duration_since(self.start_time)? > PASE_DISCARD_TIMEOUT_SECS { Ok(epoch() - self.start_time > PASE_DISCARD_TIMEOUT_SECS)
Ok(true)
} else {
Ok(false)
}
} }
} }
#[allow(clippy::large_enum_variant)]
enum PakeState { enum PakeState {
Idle, Idle,
InProgress(SessionData), InProgress(SessionData),
} }
impl PakeState { impl PakeState {
const fn new() -> Self {
Self::Idle
}
fn take(&mut self) -> Result<SessionData, Error> { fn take(&mut self) -> Result<SessionData, Error> {
let new = std::mem::replace(self, PakeState::Idle); let new = core::mem::replace(self, PakeState::Idle);
if let PakeState::InProgress(s) = new { if let PakeState::InProgress(s) = new {
Ok(s) Ok(s)
} else { } else {
@ -163,7 +179,7 @@ impl PakeState {
} }
fn is_idle(&self) -> bool { fn is_idle(&self) -> bool {
std::mem::discriminant(self) == std::mem::discriminant(&PakeState::Idle) core::mem::discriminant(self) == core::mem::discriminant(&PakeState::Idle)
} }
fn take_sess_data(&mut self, exch_ctx: &ExchangeCtx) -> Result<SessionData, Error> { fn take_sess_data(&mut self, exch_ctx: &ExchangeCtx) -> Result<SessionData, Error> {
@ -175,9 +191,9 @@ impl PakeState {
} }
} }
fn make_in_progress(&mut self, spake2p: Box<Spake2P>, exch_ctx: &ExchangeCtx) { fn make_in_progress(&mut self, epoch: Epoch, spake2p: Spake2P, exch_ctx: &ExchangeCtx) {
*self = PakeState::InProgress(SessionData { *self = PakeState::InProgress(SessionData {
start_time: SystemTime::now(), start_time: epoch(),
spake2p, spake2p,
exch_id: exch_ctx.exch.get_id(), exch_id: exch_ctx.exch.get_id(),
peer_addr: exch_ctx.sess.get_peer_addr(), peer_addr: exch_ctx.sess.get_peer_addr(),
@ -191,21 +207,25 @@ impl PakeState {
impl Default for PakeState { impl Default for PakeState {
fn default() -> Self { fn default() -> Self {
Self::Idle Self::new()
} }
} }
pub struct PAKE { struct Pake {
pub verifier: VerifierData, verifier: VerifierData,
state: PakeState, state: PakeState,
epoch: Epoch,
rand: Rand,
} }
impl PAKE { impl Pake {
pub fn new(verifier: VerifierData) -> Self { pub fn new(verifier: VerifierData, epoch: Epoch, rand: Rand) -> Self {
// TODO: Can any PBKDF2 calculation be pre-computed here // TODO: Can any PBKDF2 calculation be pre-computed here
PAKE { Self {
verifier, verifier,
state: Default::default(), state: PakeState::new(),
epoch,
rand,
} }
} }
@ -213,14 +233,14 @@ impl PAKE {
pub fn handle_pasepake3(&mut self, ctx: &mut ProtoCtx) -> Result<(), Error> { pub fn handle_pasepake3(&mut self, ctx: &mut ProtoCtx) -> Result<(), Error> {
let mut sd = self.state.take_sess_data(&ctx.exch_ctx)?; let mut sd = self.state.take_sess_data(&ctx.exch_ctx)?;
let cA = extract_pasepake_1_or_3_params(ctx.rx.as_borrow_slice())?; let cA = extract_pasepake_1_or_3_params(ctx.rx.as_slice())?;
let (status_code, Ke) = sd.spake2p.handle_cA(cA); let (status_code, ke) = sd.spake2p.handle_cA(cA);
if status_code == SCStatusCodes::SessionEstablishmentSuccess { if status_code == SCStatusCodes::SessionEstablishmentSuccess {
// Get the keys // Get the keys
let Ke = Ke.ok_or(Error::Invalid)?; let ke = ke.ok_or(Error::Invalid)?;
let mut session_keys: [u8; 48] = [0; 48]; let mut session_keys: [u8; 48] = [0; 48];
crypto::hkdf_sha256(&[], Ke, &SPAKE2_SESSION_KEYS_INFO, &mut session_keys) crypto::hkdf_sha256(&[], ke, &SPAKE2_SESSION_KEYS_INFO, &mut session_keys)
.map_err(|_x| Error::NoSpace)?; .map_err(|_x| Error::NoSpace)?;
// Create a session // Create a session
@ -245,7 +265,7 @@ impl PAKE {
WorkQ::get()?.sync_send(Msg::NewSession(clone_data))?; WorkQ::get()?.sync_send(Msg::NewSession(clone_data))?;
} }
create_sc_status_report(&mut ctx.tx, status_code, None)?; create_sc_status_report(ctx.tx, status_code, None)?;
ctx.exch_ctx.exch.close(); ctx.exch_ctx.exch.close();
Ok(()) Ok(())
} }
@ -254,7 +274,7 @@ impl PAKE {
pub fn handle_pasepake1(&mut self, ctx: &mut ProtoCtx) -> Result<(), Error> { pub fn handle_pasepake1(&mut self, ctx: &mut ProtoCtx) -> Result<(), Error> {
let mut sd = self.state.take_sess_data(&ctx.exch_ctx)?; let mut sd = self.state.take_sess_data(&ctx.exch_ctx)?;
let pA = extract_pasepake_1_or_3_params(ctx.rx.as_borrow_slice())?; let pA = extract_pasepake_1_or_3_params(ctx.rx.as_slice())?;
let mut pB: [u8; 65] = [0; 65]; let mut pB: [u8; 65] = [0; 65];
let mut cB: [u8; 32] = [0; 32]; let mut cB: [u8; 32] = [0; 32];
sd.spake2p.start_verifier(&self.verifier)?; sd.spake2p.start_verifier(&self.verifier)?;
@ -275,18 +295,18 @@ impl PAKE {
pub fn handle_pbkdfparamrequest(&mut self, ctx: &mut ProtoCtx) -> Result<(), Error> { pub fn handle_pbkdfparamrequest(&mut self, ctx: &mut ProtoCtx) -> Result<(), Error> {
if !self.state.is_idle() { if !self.state.is_idle() {
let sd = self.state.take()?; let sd = self.state.take()?;
if sd.is_sess_expired()? { if sd.is_sess_expired(self.epoch)? {
info!("Previous session expired, clearing it"); info!("Previous session expired, clearing it");
self.state = PakeState::Idle; self.state = PakeState::Idle;
} else { } else {
info!("Previous session in-progress, denying new request"); info!("Previous session in-progress, denying new request");
// little-endian timeout (here we've hardcoded 500ms) // little-endian timeout (here we've hardcoded 500ms)
create_sc_status_report(&mut ctx.tx, SCStatusCodes::Busy, Some(&[0xf4, 0x01]))?; create_sc_status_report(ctx.tx, SCStatusCodes::Busy, Some(&[0xf4, 0x01]))?;
return Ok(()); return Ok(());
} }
} }
let root = tlv::get_root_node(ctx.rx.as_borrow_slice())?; let root = tlv::get_root_node(ctx.rx.as_slice())?;
let a = PBKDFParamReq::from_tlv(&root)?; let a = PBKDFParamReq::from_tlv(&root)?;
if a.passcode_id != 0 { if a.passcode_id != 0 {
error!("Can't yet handle passcode_id != 0"); error!("Can't yet handle passcode_id != 0");
@ -294,11 +314,11 @@ impl PAKE {
} }
let mut our_random: [u8; 32] = [0; 32]; let mut our_random: [u8; 32] = [0; 32];
rand::thread_rng().fill_bytes(&mut our_random); (self.rand)(&mut our_random);
let local_sessid = ctx.exch_ctx.sess.reserve_new_sess_id(); let local_sessid = ctx.exch_ctx.sess.reserve_new_sess_id();
let spake2p_data: u32 = ((local_sessid as u32) << 16) | a.initiator_ssid as u32; let spake2p_data: u32 = ((local_sessid as u32) << 16) | a.initiator_ssid as u32;
let mut spake2p = Box::new(Spake2P::new()); let mut spake2p = Spake2P::new();
spake2p.set_app_data(spake2p_data); spake2p.set_app_data(spake2p_data);
// Generate response // Generate response
@ -318,8 +338,9 @@ impl PAKE {
} }
resp.to_tlv(&mut tw, TagType::Anonymous)?; resp.to_tlv(&mut tw, TagType::Anonymous)?;
spake2p.set_context(ctx.rx.as_borrow_slice(), ctx.tx.as_borrow_slice())?; spake2p.set_context(ctx.rx.as_slice(), ctx.tx.as_mut_slice())?;
self.state.make_in_progress(spake2p, &ctx.exch_ctx); self.state
.make_in_progress(self.epoch, spake2p, &ctx.exch_ctx);
Ok(()) Ok(())
} }

View file

@ -18,10 +18,10 @@
use crate::{ use crate::{
crypto::{self, HmacSha256}, crypto::{self, HmacSha256},
sys, sys,
utils::rand::Rand,
}; };
use byteorder::{ByteOrder, LittleEndian}; use byteorder::{ByteOrder, LittleEndian};
use log::error; use log::error;
use rand::prelude::*;
use subtle::ConstantTimeEq; use subtle::ConstantTimeEq;
use crate::{ use crate::{
@ -29,18 +29,6 @@ use crate::{
error::Error, error::Error,
}; };
#[cfg(feature = "crypto_openssl")]
use super::crypto_openssl::CryptoOpenSSL;
#[cfg(feature = "crypto_mbedtls")]
use super::crypto_mbedtls::CryptoMbedTLS;
#[cfg(feature = "crypto_esp_mbedtls")]
use super::crypto_esp_mbedtls::CryptoEspMbedTls;
#[cfg(feature = "crypto_rustcrypto")]
use super::crypto_rustcrypto::CryptoRustCrypto;
use super::{common::SCStatusCodes, crypto::CryptoSpake2}; use super::{common::SCStatusCodes, crypto::CryptoSpake2};
// This file handle Spake2+ specific instructions. In itself, this file is // This file handle Spake2+ specific instructions. In itself, this file is
@ -74,7 +62,7 @@ pub struct Spake2P {
context: Option<Sha256>, context: Option<Sha256>,
Ke: [u8; 16], Ke: [u8; 16],
cA: [u8; 32], cA: [u8; 32],
crypto_spake2: Option<Box<dyn CryptoSpake2>>, crypto_spake2: Option<CryptoSpake2>,
app_data: u32, app_data: u32,
} }
@ -87,24 +75,8 @@ const CRYPTO_PUBLIC_KEY_SIZE_BYTES: usize = (2 * CRYPTO_GROUP_SIZE_BYTES) + 1;
const MAX_SALT_SIZE_BYTES: usize = 32; const MAX_SALT_SIZE_BYTES: usize = 32;
const VERIFIER_SIZE_BYTES: usize = CRYPTO_GROUP_SIZE_BYTES + CRYPTO_PUBLIC_KEY_SIZE_BYTES; const VERIFIER_SIZE_BYTES: usize = CRYPTO_GROUP_SIZE_BYTES + CRYPTO_PUBLIC_KEY_SIZE_BYTES;
#[cfg(feature = "crypto_openssl")] fn crypto_spake2_new() -> Result<CryptoSpake2, Error> {
fn crypto_spake2_new() -> Result<Box<dyn CryptoSpake2>, Error> { CryptoSpake2::new()
Ok(Box::new(CryptoOpenSSL::new()?))
}
#[cfg(feature = "crypto_mbedtls")]
fn crypto_spake2_new() -> Result<Box<dyn CryptoSpake2>, Error> {
Ok(Box::new(CryptoMbedTLS::new()?))
}
#[cfg(feature = "crypto_esp_mbedtls")]
fn crypto_spake2_new() -> Result<Box<dyn CryptoSpake2>, Error> {
Ok(Box::new(CryptoEspMbedTls::new()?))
}
#[cfg(feature = "crypto_rustcrypto")]
fn crypto_spake2_new() -> Result<Box<dyn CryptoSpake2>, Error> {
Ok(Box::new(CryptoRustCrypto::new()?))
} }
impl Default for Spake2P { impl Default for Spake2P {
@ -129,13 +101,13 @@ pub enum VerifierOption {
} }
impl VerifierData { impl VerifierData {
pub fn new_with_pw(pw: u32) -> Self { pub fn new_with_pw(pw: u32, rand: Rand) -> Self {
let mut s = Self { let mut s = Self {
salt: [0; MAX_SALT_SIZE_BYTES], salt: [0; MAX_SALT_SIZE_BYTES],
count: sys::SPAKE2_ITERATION_COUNT, count: sys::SPAKE2_ITERATION_COUNT,
data: VerifierOption::Password(pw), data: VerifierOption::Password(pw),
}; };
rand::thread_rng().fill_bytes(&mut s.salt); rand(&mut s.salt);
s s
} }
@ -158,7 +130,7 @@ impl VerifierData {
} }
impl Spake2P { impl Spake2P {
pub fn new() -> Self { pub const fn new() -> Self {
Spake2P { Spake2P {
mode: Spake2Mode::Unknown, mode: Spake2Mode::Unknown,
context: None, context: None,
@ -198,7 +170,7 @@ impl Spake2P {
match verifier.data { match verifier.data {
VerifierOption::Password(pw) => { VerifierOption::Password(pw) => {
// Derive w0 and L from the password // Derive w0 and L from the password
let mut w0w1s: [u8; 2 * CRYPTO_W_SIZE_BYTES] = [0; 2 * CRYPTO_W_SIZE_BYTES]; let mut w0w1s: [u8; 2 * CRYPTO_W_SIZE_BYTES] = [0; (2 * CRYPTO_W_SIZE_BYTES)];
Spake2P::get_w0w1s(pw, verifier.count, &verifier.salt, &mut w0w1s); Spake2P::get_w0w1s(pw, verifier.count, &verifier.salt, &mut w0w1s);
let w0s_len = w0w1s.len() / 2; let w0s_len = w0w1s.len() / 2;
@ -317,7 +289,7 @@ mod tests {
0x4, 0xa1, 0xd2, 0xc6, 0x11, 0xf0, 0xbd, 0x36, 0x78, 0x67, 0x79, 0x7b, 0xfe, 0x82, 0x4, 0xa1, 0xd2, 0xc6, 0x11, 0xf0, 0xbd, 0x36, 0x78, 0x67, 0x79, 0x7b, 0xfe, 0x82,
0x36, 0x0, 0x36, 0x0,
]; ];
let mut w0w1s: [u8; 2 * CRYPTO_W_SIZE_BYTES] = [0; 2 * CRYPTO_W_SIZE_BYTES]; let mut w0w1s: [u8; 2 * CRYPTO_W_SIZE_BYTES] = [0; (2 * CRYPTO_W_SIZE_BYTES)];
Spake2P::get_w0w1s(123456, 2000, &salt, &mut w0w1s); Spake2P::get_w0w1s(123456, 2000, &salt, &mut w0w1s);
assert_eq!( assert_eq!(
w0w1s, w0w1s,

View file

@ -46,7 +46,7 @@ pub fn create_status_report(
proto_code: u16, proto_code: u16,
proto_data: Option<&[u8]>, proto_data: Option<&[u8]>,
) -> Result<(), Error> { ) -> Result<(), Error> {
proto_tx.set_proto_id(PROTO_ID_SECURE_CHANNEL as u16); proto_tx.set_proto_id(PROTO_ID_SECURE_CHANNEL);
proto_tx.set_proto_opcode(OpCode::StatusReport as u8); proto_tx.set_proto_opcode(OpCode::StatusReport as u8);
let wb = proto_tx.get_writebuf()?; let wb = proto_tx.get_writebuf()?;
wb.le_u16(general_code as u16)?; wb.le_u16(general_code as u16)?;

View file

@ -25,7 +25,8 @@ mod sys_linux;
#[cfg(target_os = "linux")] #[cfg(target_os = "linux")]
pub use self::sys_linux::*; pub use self::sys_linux::*;
#[cfg(any(target_os = "macos", target_os = "linux"))] pub const SPAKE2_ITERATION_COUNT: u32 = 2000;
mod posix;
#[cfg(any(target_os = "macos", target_os = "linux"))] // The Packet Pool that is allocated from. POSIX systems can use
pub use self::posix::*; // higher values unlike embedded systems
pub const MAX_PACKET_POOL_SIZE: usize = 25;

View file

@ -1,96 +0,0 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use std::{
convert::TryInto,
fs::{remove_file, DirBuilder, File},
io::{Read, Write},
sync::{Arc, Mutex, Once},
};
use crate::error::Error;
pub const SPAKE2_ITERATION_COUNT: u32 = 2000;
// The Packet Pool that is allocated from. POSIX systems can use
// higher values unlike embedded systems
pub const MAX_PACKET_POOL_SIZE: usize = 25;
pub struct Psm {}
static mut G_PSM: Option<Arc<Mutex<Psm>>> = None;
static INIT: Once = Once::new();
const PSM_DIR: &str = "/tmp/matter_psm";
macro_rules! psm_path {
($key:ident) => {
format!("{}/{}", PSM_DIR, $key)
};
}
impl Psm {
fn new() -> Result<Self, Error> {
let result = DirBuilder::new().create(PSM_DIR);
if let Err(e) = result {
if e.kind() != std::io::ErrorKind::AlreadyExists {
return Err(e.into());
}
}
Ok(Self {})
}
pub fn get() -> Result<Arc<Mutex<Self>>, Error> {
unsafe {
INIT.call_once(|| {
G_PSM = Some(Arc::new(Mutex::new(Psm::new().unwrap())));
});
Ok(G_PSM.as_ref().ok_or(Error::Invalid)?.clone())
}
}
pub fn set_kv_slice(&self, key: &str, val: &[u8]) -> Result<(), Error> {
let mut f = File::create(psm_path!(key))?;
f.write_all(val)?;
Ok(())
}
pub fn get_kv_slice(&self, key: &str, val: &mut Vec<u8>) -> Result<usize, Error> {
let mut f = File::open(psm_path!(key))?;
let len = f.read_to_end(val)?;
Ok(len)
}
pub fn set_kv_u64(&self, key: &str, val: u64) -> Result<(), Error> {
let mut f = File::create(psm_path!(key))?;
f.write_all(&val.to_be_bytes())?;
Ok(())
}
pub fn get_kv_u64(&self, key: &str, val: &mut u64) -> Result<(), Error> {
let mut f = File::open(psm_path!(key))?;
let mut vec = Vec::new();
let _ = f.read_to_end(&mut vec)?;
*val = u64::from_be_bytes(vec.as_slice().try_into()?);
Ok(())
}
pub fn rm(&self, key: &str) {
let _ = remove_file(psm_path!(key));
}
}

View file

@ -18,8 +18,8 @@
use crate::error::Error; use crate::error::Error;
use byteorder::{ByteOrder, LittleEndian}; use byteorder::{ByteOrder, LittleEndian};
use core::fmt;
use log::{error, info}; use log::{error, info};
use std::fmt;
use super::{TagType, MAX_TAG_INDEX, TAG_MASK, TAG_SHIFT_BITS, TAG_SIZE_MAP, TYPE_MASK}; use super::{TagType, MAX_TAG_INDEX, TAG_MASK, TAG_SHIFT_BITS, TAG_SIZE_MAP, TYPE_MASK};
@ -318,7 +318,7 @@ impl<'a> PartialEq for TLVElement<'a> {
loop { loop {
let ours = our_iter.next(); let ours = our_iter.next();
let theirs = their.next(); let theirs = their.next();
if std::mem::discriminant(&ours) != std::mem::discriminant(&theirs) { if core::mem::discriminant(&ours) != core::mem::discriminant(&theirs) {
// One of us reached end of list, but the other didn't, that's a mismatch // One of us reached end of list, but the other didn't, that's a mismatch
return false; return false;
} }
@ -341,8 +341,8 @@ impl<'a> PartialEq for TLVElement<'a> {
// Only compare the discriminants in case of array/list/structures, // Only compare the discriminants in case of array/list/structures,
// instead of actual element values. Those will be subsets within this same // instead of actual element values. Those will be subsets within this same
// list that will get validated anyway // list that will get validated anyway
if std::mem::discriminant(&ours.element_type) if core::mem::discriminant(&ours.element_type)
!= std::mem::discriminant(&theirs.element_type) != core::mem::discriminant(&theirs.element_type)
{ {
return false; return false;
} }
@ -438,6 +438,18 @@ impl<'a> TLVElement<'a> {
} }
} }
pub fn str(&self) -> Result<&'a str, Error> {
match self.element_type {
ElementType::Str8l(s)
| ElementType::Utf8l(s)
| ElementType::Str16l(s)
| ElementType::Utf16l(s) => {
Ok(core::str::from_utf8(s).map_err(|_| Error::InvalidData)?)
}
_ => Err(Error::TLVTypeMismatch),
}
}
pub fn bool(&self) -> Result<bool, Error> { pub fn bool(&self) -> Result<bool, Error> {
match self.element_type { match self.element_type {
ElementType::False => Ok(false), ElementType::False => Ok(false),
@ -522,7 +534,7 @@ impl<'a> fmt::Display for TLVElement<'a> {
| ElementType::Utf8l(a) | ElementType::Utf8l(a)
| ElementType::Str16l(a) | ElementType::Str16l(a)
| ElementType::Utf16l(a) => { | ElementType::Utf16l(a) => {
if let Ok(s) = std::str::from_utf8(a) { if let Ok(s) = core::str::from_utf8(a) {
write!(f, "len[{}]\"{}\"", s.len(), s) write!(f, "len[{}]\"{}\"", s.len(), s)
} else { } else {
write!(f, "len[{}]{:x?}", a.len(), a) write!(f, "len[{}]{:x?}", a.len(), a)
@ -752,7 +764,7 @@ pub fn print_tlv_list(b: &[u8]) {
match a.element_type { match a.element_type {
ElementType::Struct(_) => { ElementType::Struct(_) => {
if index < MAX_DEPTH { if index < MAX_DEPTH {
println!("{}{}", space[index], a); info!("{}{}", space[index], a);
stack[index] = '}'; stack[index] = '}';
index += 1; index += 1;
} else { } else {
@ -761,7 +773,7 @@ pub fn print_tlv_list(b: &[u8]) {
} }
ElementType::Array(_) | ElementType::List(_) => { ElementType::Array(_) | ElementType::List(_) => {
if index < MAX_DEPTH { if index < MAX_DEPTH {
println!("{}{}", space[index], a); info!("{}{}", space[index], a);
stack[index] = ']'; stack[index] = ']';
index += 1; index += 1;
} else { } else {
@ -771,19 +783,21 @@ pub fn print_tlv_list(b: &[u8]) {
ElementType::EndCnt => { ElementType::EndCnt => {
if index > 0 { if index > 0 {
index -= 1; index -= 1;
println!("{}{}", space[index], stack[index]); info!("{}{}", space[index], stack[index]);
} else { } else {
error!("Incorrect TLV List"); error!("Incorrect TLV List");
} }
} }
_ => println!("{}{}", space[index], a), _ => info!("{}{}", space[index], a),
} }
} }
println!("---------"); info!("---------");
} }
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use log::info;
use super::{ use super::{
get_root_node_list, get_root_node_struct, ElementType, Pointer, TLVElement, TLVList, get_root_node_list, get_root_node_struct, ElementType, Pointer, TLVElement, TLVList,
TagType, TagType,
@ -1105,7 +1119,7 @@ mod tests {
.unwrap() .unwrap()
.enter() .enter()
.unwrap(); .unwrap();
println!("Command list iterator: {:?}", cmd_list_iter); info!("Command list iterator: {:?}", cmd_list_iter);
// This is an array of CommandDataIB, but we'll only use the first element // This is an array of CommandDataIB, but we'll only use the first element
let cmd_data_ib = cmd_list_iter.next().unwrap(); let cmd_data_ib = cmd_list_iter.next().unwrap();
@ -1203,8 +1217,8 @@ mod tests {
Some(a) => { Some(a) => {
assert_eq!(a.tag_type, verify_matrix[index].0); assert_eq!(a.tag_type, verify_matrix[index].0);
assert_eq!( assert_eq!(
std::mem::discriminant(&a.element_type), core::mem::discriminant(&a.element_type),
std::mem::discriminant(&verify_matrix[index].1) core::mem::discriminant(&verify_matrix[index].1)
); );
} }
} }

View file

@ -17,9 +17,13 @@
use super::{ElementType, TLVContainerIterator, TLVElement, TLVWriter, TagType}; use super::{ElementType, TLVContainerIterator, TLVElement, TLVWriter, TagType};
use crate::error::Error; use crate::error::Error;
use alloc::borrow::ToOwned;
use alloc::{string::String, vec::Vec};
use core::fmt::Debug;
use core::slice::Iter; use core::slice::Iter;
use log::error; use log::error;
use std::fmt::Debug;
extern crate alloc;
pub trait FromTLV<'a> { pub trait FromTLV<'a> {
fn from_tlv(t: &TLVElement<'a>) -> Result<Self, Error> fn from_tlv(t: &TLVElement<'a>) -> Result<Self, Error>
@ -76,6 +80,15 @@ pub trait ToTLV {
fn to_tlv(&self, tw: &mut TLVWriter, tag: TagType) -> Result<(), Error>; fn to_tlv(&self, tw: &mut TLVWriter, tag: TagType) -> Result<(), Error>;
} }
impl<T> ToTLV for &T
where
T: ToTLV,
{
fn to_tlv(&self, tw: &mut TLVWriter, tag: TagType) -> Result<(), Error> {
(**self).to_tlv(tw, tag)
}
}
macro_rules! totlv_for { macro_rules! totlv_for {
($($t:ident)*) => { ($($t:ident)*) => {
$( $(
@ -116,10 +129,14 @@ totlv_for!(i8 u8 u16 u32 u64 bool);
pub struct UtfStr<'a>(pub &'a [u8]); pub struct UtfStr<'a>(pub &'a [u8]);
impl<'a> UtfStr<'a> { impl<'a> UtfStr<'a> {
pub fn new(str: &'a [u8]) -> Self { pub const fn new(str: &'a [u8]) -> Self {
Self(str) Self(str)
} }
pub fn as_str(&self) -> Result<&str, Error> {
core::str::from_utf8(self.0).map_err(|_| Error::Invalid)
}
pub fn to_string(self) -> Result<String, Error> { pub fn to_string(self) -> Result<String, Error> {
String::from_utf8(self.0.to_vec()).map_err(|_| Error::Invalid) String::from_utf8(self.0.to_vec()).map_err(|_| Error::Invalid)
} }
@ -396,7 +413,7 @@ impl<'a, T> FromTLV<'a> for TLVArray<'a, T> {
} }
impl<'a, T: Debug + ToTLV + FromTLV<'a> + Copy> Debug for TLVArray<'a, T> { impl<'a, T: Debug + ToTLV + FromTLV<'a> + Copy> Debug for TLVArray<'a, T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
for i in self.iter() { for i in self.iter() {
writeln!(f, "{:?}", i)?; writeln!(f, "{:?}", i)?;
} }
@ -442,9 +459,8 @@ mod tests {
} }
#[test] #[test]
fn test_derive_totlv() { fn test_derive_totlv() {
let mut buf: [u8; 20] = [0; 20]; let mut buf = [0; 20];
let buf_len = buf.len(); let mut writebuf = WriteBuf::new(&mut buf);
let mut writebuf = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut writebuf); let mut tw = TLVWriter::new(&mut writebuf);
let abc = TestDerive { let abc = TestDerive {
@ -525,9 +541,8 @@ mod tests {
#[test] #[test]
fn test_derive_totlv_fab_scoped() { fn test_derive_totlv_fab_scoped() {
let mut buf: [u8; 20] = [0; 20]; let mut buf = [0; 20];
let buf_len = buf.len(); let mut writebuf = WriteBuf::new(&mut buf);
let mut writebuf = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut writebuf); let mut tw = TLVWriter::new(&mut writebuf);
let abc = TestDeriveFabScoped { a: 20, fab_idx: 3 }; let abc = TestDeriveFabScoped { a: 20, fab_idx: 3 };
@ -557,9 +572,8 @@ mod tests {
enum_val = TestDeriveEnum::ValueB(10); enum_val = TestDeriveEnum::ValueB(10);
// Test ToTLV // Test ToTLV
let mut buf: [u8; 20] = [0; 20]; let mut buf = [0; 20];
let buf_len = buf.len(); let mut writebuf = WriteBuf::new(&mut buf);
let mut writebuf = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut writebuf); let mut tw = TLVWriter::new(&mut writebuf);
enum_val.to_tlv(&mut tw, TagType::Anonymous).unwrap(); enum_val.to_tlv(&mut tw, TagType::Anonymous).unwrap();

View file

@ -50,11 +50,11 @@ enum WriteElementType {
} }
pub struct TLVWriter<'a, 'b> { pub struct TLVWriter<'a, 'b> {
buf: &'b mut WriteBuf<'a>, buf: &'a mut WriteBuf<'b>,
} }
impl<'a, 'b> TLVWriter<'a, 'b> { impl<'a, 'b> TLVWriter<'a, 'b> {
pub fn new(buf: &'b mut WriteBuf<'a>) -> Self { pub fn new(buf: &'a mut WriteBuf<'b>) -> Self {
TLVWriter { buf } TLVWriter { buf }
} }
@ -265,7 +265,7 @@ impl<'a, 'b> TLVWriter<'a, 'b> {
self.buf.rewind_tail_to(anchor); self.buf.rewind_tail_to(anchor);
} }
pub fn get_buf<'c>(&'c mut self) -> &'c mut WriteBuf<'a> { pub fn get_buf(&mut self) -> &mut WriteBuf<'b> {
self.buf self.buf
} }
} }
@ -277,9 +277,8 @@ mod tests {
#[test] #[test]
fn test_write_success() { fn test_write_success() {
let mut buf: [u8; 20] = [0; 20]; let mut buf = [0; 20];
let buf_len = buf.len(); let mut writebuf = WriteBuf::new(&mut buf);
let mut writebuf = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut writebuf); let mut tw = TLVWriter::new(&mut writebuf);
tw.start_struct(TagType::Anonymous).unwrap(); tw.start_struct(TagType::Anonymous).unwrap();
@ -299,9 +298,8 @@ mod tests {
#[test] #[test]
fn test_write_overflow() { fn test_write_overflow() {
let mut buf: [u8; 6] = [0; 6]; let mut buf = [0; 6];
let buf_len = buf.len(); let mut writebuf = WriteBuf::new(&mut buf);
let mut writebuf = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut writebuf); let mut tw = TLVWriter::new(&mut writebuf);
tw.u8(TagType::Anonymous, 12).unwrap(); tw.u8(TagType::Anonymous, 12).unwrap();
@ -317,9 +315,8 @@ mod tests {
#[test] #[test]
fn test_put_str8() { fn test_put_str8() {
let mut buf: [u8; 20] = [0; 20]; let mut buf = [0; 20];
let buf_len = buf.len(); let mut writebuf = WriteBuf::new(&mut buf);
let mut writebuf = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut writebuf); let mut tw = TLVWriter::new(&mut writebuf);
tw.u8(TagType::Context(1), 13).unwrap(); tw.u8(TagType::Context(1), 13).unwrap();
@ -334,9 +331,8 @@ mod tests {
#[test] #[test]
fn test_put_str16_as() { fn test_put_str16_as() {
let mut buf: [u8; 20] = [0; 20]; let mut buf = [0; 20];
let buf_len = buf.len(); let mut writebuf = WriteBuf::new(&mut buf);
let mut writebuf = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut writebuf); let mut tw = TLVWriter::new(&mut writebuf);
tw.u8(TagType::Context(1), 13).unwrap(); tw.u8(TagType::Context(1), 13).unwrap();

View file

@ -15,43 +15,46 @@
* limitations under the License. * limitations under the License.
*/ */
use boxslab::{BoxSlab, Slab};
use colored::*; use colored::*;
use core::any::Any;
use core::fmt;
use core::time::Duration;
use log::{error, info, trace}; use log::{error, info, trace};
use std::any::Any;
use std::fmt;
use std::time::SystemTime;
use crate::error::Error; use crate::error::Error;
use crate::secure_channel; use crate::secure_channel;
use crate::secure_channel::case::CaseSession;
use crate::utils::epoch::Epoch;
use crate::utils::rand::Rand;
use heapless::LinearMap; use heapless::LinearMap;
use super::packet::PacketPool;
use super::session::CloneData; use super::session::CloneData;
use super::{mrp::ReliableMessage, packet::Packet, session::SessionHandle, session::SessionMgr}; use super::{mrp::ReliableMessage, packet::Packet, session::SessionHandle, session::SessionMgr};
pub struct ExchangeCtx<'a> { pub struct ExchangeCtx<'a> {
pub exch: &'a mut Exchange, pub exch: &'a mut Exchange,
pub sess: SessionHandle<'a>, pub sess: SessionHandle<'a>,
pub epoch: Epoch,
} }
#[derive(Debug, PartialEq, Eq, Copy, Clone)] impl<'a> ExchangeCtx<'a> {
pub fn send(&mut self, tx: &mut Packet) -> Result<(), Error> {
self.exch.send(tx, &mut self.sess)
}
}
#[derive(Debug, PartialEq, Eq, Copy, Clone, Default)]
pub enum Role { pub enum Role {
#[default]
Initiator = 0, Initiator = 0,
Responder = 1, Responder = 1,
} }
impl Default for Role { #[derive(Debug, PartialEq, Default)]
fn default() -> Self {
Role::Initiator
}
}
/// State of the exchange
#[derive(Debug, PartialEq)]
enum State { enum State {
/// The exchange is open and active /// The exchange is open and active
#[default]
Open, Open,
/// The exchange is closed, but keys are active since retransmissions/acks may be pending /// The exchange is closed, but keys are active since retransmissions/acks may be pending
Close, Close,
@ -59,28 +62,17 @@ enum State {
Terminate, Terminate,
} }
impl Default for State {
fn default() -> Self {
State::Open
}
}
// Instead of just doing an Option<>, we create some special handling // Instead of just doing an Option<>, we create some special handling
// where the commonly used higher layer data store does't have to do a Box // where the commonly used higher layer data store does't have to do a Box
#[derive(Debug)] #[derive(Default)]
pub enum DataOption { pub enum DataOption {
Boxed(Box<dyn Any>), CaseSession(CaseSession),
Time(SystemTime), Time(Duration),
#[default]
None, None,
} }
impl Default for DataOption { #[derive(Default)]
fn default() -> Self {
DataOption::None
}
}
#[derive(Debug, Default)]
pub struct Exchange { pub struct Exchange {
id: u16, id: u16,
sess_idx: usize, sess_idx: usize,
@ -136,48 +128,48 @@ impl Exchange {
matches!(self.data, DataOption::None) matches!(self.data, DataOption::None)
} }
pub fn set_data_boxed(&mut self, data: Box<dyn Any>) { pub fn set_case_session(&mut self, session: CaseSession) {
self.data = DataOption::Boxed(data); self.data = DataOption::CaseSession(session);
} }
pub fn clear_data_boxed(&mut self) { pub fn clear_data(&mut self) {
self.data = DataOption::None; self.data = DataOption::None;
} }
pub fn get_data_boxed<T: Any>(&mut self) -> Option<&mut T> { pub fn get_case_session(&mut self) -> Option<&mut CaseSession> {
if let DataOption::Boxed(a) = &mut self.data { if let DataOption::CaseSession(session) = &mut self.data {
a.downcast_mut::<T>() Some(session)
} else { } else {
None None
} }
} }
pub fn take_data_boxed<T: Any>(&mut self) -> Option<Box<T>> { pub fn take_case_session<T: Any>(&mut self) -> Option<CaseSession> {
let old = std::mem::replace(&mut self.data, DataOption::None); let old = core::mem::replace(&mut self.data, DataOption::None);
if let DataOption::Boxed(d) = old { if let DataOption::CaseSession(session) = old {
d.downcast::<T>().ok() Some(session)
} else { } else {
self.data = old; self.data = old;
None None
} }
} }
pub fn set_data_time(&mut self, expiry_ts: Option<SystemTime>) { pub fn set_data_time(&mut self, expiry_ts: Option<Duration>) {
if let Some(t) = expiry_ts { if let Some(t) = expiry_ts {
self.data = DataOption::Time(t); self.data = DataOption::Time(t);
} }
} }
pub fn get_data_time(&self) -> Option<SystemTime> { pub fn get_data_time(&self) -> Option<Duration> {
match self.data { match self.data {
DataOption::Time(t) => Some(t), DataOption::Time(t) => Some(t),
_ => None, _ => None,
} }
} }
pub fn send( pub(crate) fn send(
&mut self, &mut self,
mut proto_tx: BoxSlab<PacketPool>, tx: &mut Packet,
session: &mut SessionHandle, session: &mut SessionHandle,
) -> Result<(), Error> { ) -> Result<(), Error> {
if self.state == State::Terminate { if self.state == State::Terminate {
@ -185,22 +177,22 @@ impl Exchange {
return Ok(()); return Ok(());
} }
trace!("payload: {:x?}", proto_tx.as_borrow_slice()); trace!("payload: {:x?}", tx.as_mut_slice());
info!( info!(
"{} with proto id: {} opcode: {}", "{} with proto id: {} opcode: {}",
"Sending".blue(), "Sending".blue(),
proto_tx.get_proto_id(), tx.get_proto_id(),
proto_tx.get_proto_opcode(), tx.get_proto_opcode(),
); );
proto_tx.proto.exch_id = self.id; tx.proto.exch_id = self.id;
if self.role == Role::Initiator { if self.role == Role::Initiator {
proto_tx.proto.set_initiator(); tx.proto.set_initiator();
} }
session.pre_send(&mut proto_tx)?; session.pre_send(tx)?;
self.mrp.pre_send(&mut proto_tx)?; self.mrp.pre_send(tx)?;
session.send(proto_tx) session.send(tx)
} }
} }
@ -208,8 +200,8 @@ impl fmt::Display for Exchange {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!( write!(
f, f,
"exch_id: {:?}, sess_index: {}, role: {:?}, data: {:?}, mrp: {:?}, state: {:?}", "exch_id: {:?}, sess_index: {}, role: {:?}, mrp: {:?}, state: {:?}",
self.id, self.sess_idx, self.role, self.data, self.mrp, self.state self.id, self.sess_idx, self.role, self.mrp, self.state
) )
} }
} }
@ -232,20 +224,21 @@ pub fn get_complementary_role(is_initiator: bool) -> Role {
const MAX_EXCHANGES: usize = 8; const MAX_EXCHANGES: usize = 8;
#[derive(Default)]
pub struct ExchangeMgr { pub struct ExchangeMgr {
// keys: exch-id // keys: exch-id
exchanges: LinearMap<u16, Exchange, MAX_EXCHANGES>, exchanges: LinearMap<u16, Exchange, MAX_EXCHANGES>,
sess_mgr: SessionMgr, sess_mgr: SessionMgr,
epoch: Epoch,
} }
pub const MAX_MRP_ENTRIES: usize = 4; pub const MAX_MRP_ENTRIES: usize = 4;
impl ExchangeMgr { impl ExchangeMgr {
pub fn new(sess_mgr: SessionMgr) -> Self { pub fn new(epoch: Epoch, rand: Rand) -> Self {
Self { Self {
sess_mgr, sess_mgr: SessionMgr::new(epoch, rand),
exchanges: Default::default(), exchanges: LinearMap::new(),
epoch,
} }
} }
@ -300,45 +293,33 @@ impl ExchangeMgr {
} }
/// The Exchange Mgr receive is like a big processing function /// The Exchange Mgr receive is like a big processing function
pub fn recv(&mut self) -> Result<Option<(BoxSlab<PacketPool>, ExchangeCtx)>, Error> { pub fn recv(&mut self, rx: &mut Packet) -> Result<Option<ExchangeCtx>, Error> {
// Get the session // Get the session
let (mut proto_rx, index) = self.sess_mgr.recv()?; let index = self.sess_mgr.post_recv(rx)?;
let index = if let Some(s) = index {
s
} else {
// The sessions were full, evict one session, and re-perform post-recv
let evict_index = self.sess_mgr.get_lru();
self.evict_session(evict_index)?;
info!("Reattempting session creation");
self.sess_mgr.post_recv(&proto_rx)?.ok_or(Error::Invalid)?
};
let mut session = self.sess_mgr.get_session_handle(index); let mut session = self.sess_mgr.get_session_handle(index);
// Decrypt the message // Decrypt the message
session.recv(&mut proto_rx)?; session.recv(self.epoch, rx)?;
// Get the exchange // Get the exchange
let exch = ExchangeMgr::_get( let exch = ExchangeMgr::_get(
&mut self.exchanges, &mut self.exchanges,
index, index,
proto_rx.proto.exch_id, rx.proto.exch_id,
get_complementary_role(proto_rx.proto.is_initiator()), get_complementary_role(rx.proto.is_initiator()),
// We create a new exchange, only if the peer is the initiator // We create a new exchange, only if the peer is the initiator
proto_rx.proto.is_initiator(), rx.proto.is_initiator(),
)?; )?;
// Message Reliability Protocol // Message Reliability Protocol
exch.mrp.recv(&proto_rx)?; exch.mrp.recv(rx, self.epoch)?;
if exch.is_state_open() { if exch.is_state_open() {
Ok(Some(( Ok(Some(ExchangeCtx {
proto_rx,
ExchangeCtx {
exch, exch,
sess: session, sess: session,
}, epoch: self.epoch,
))) }))
} else { } else {
// Instead of an error, we send None here, because it is likely that // Instead of an error, we send None here, because it is likely that
// we just processed an acknowledgement that cleared the exchange // we just processed an acknowledgement that cleared the exchange
@ -346,11 +327,11 @@ impl ExchangeMgr {
} }
} }
pub fn send(&mut self, exch_id: u16, proto_tx: BoxSlab<PacketPool>) -> Result<(), Error> { pub fn send(&mut self, exch_id: u16, tx: &mut Packet) -> Result<(), Error> {
let exchange = let exchange =
ExchangeMgr::_get_with_id(&mut self.exchanges, exch_id).ok_or(Error::NoExchange)?; ExchangeMgr::_get_with_id(&mut self.exchanges, exch_id).ok_or(Error::NoExchange)?;
let mut session = self.sess_mgr.get_session_handle(exchange.sess_idx); let mut session = self.sess_mgr.get_session_handle(exchange.sess_idx);
exchange.send(proto_tx, &mut session) exchange.send(tx, &mut session)
} }
pub fn purge(&mut self) { pub fn purge(&mut self) {
@ -366,28 +347,29 @@ impl ExchangeMgr {
} }
} }
pub fn pending_acks(&mut self, expired_entries: &mut LinearMap<u16, (), MAX_MRP_ENTRIES>) { pub fn pending_ack(&mut self) -> Option<u16> {
for (exch_id, exchange) in self.exchanges.iter() { self.exchanges
if exchange.mrp.is_ack_ready() { .iter()
expired_entries.insert(*exch_id, ()).unwrap(); .find(|(_, exchange)| exchange.mrp.is_ack_ready(self.epoch))
} .map(|(exch_id, _)| *exch_id)
}
} }
pub fn evict_session(&mut self, index: usize) -> Result<(), Error> { pub fn evict_session(&mut self, tx: &mut Packet) -> Result<bool, Error> {
if let Some(index) = self.sess_mgr.get_session_for_eviction() {
info!("Sessions full, vacating session with index: {}", index); info!("Sessions full, vacating session with index: {}", index);
// If we enter here, we have an LRU session that needs to be reclaimed // If we enter here, we have an LRU session that needs to be reclaimed
// As per the spec, we need to send a CLOSE here // As per the spec, we need to send a CLOSE here
let mut session = self.sess_mgr.get_session_handle(index); let mut session = self.sess_mgr.get_session_handle(index);
let mut tx = Slab::<PacketPool>::try_new(Packet::new_tx()?).ok_or(Error::NoSpace)?;
secure_channel::common::create_sc_status_report( secure_channel::common::create_sc_status_report(
&mut tx, tx,
secure_channel::common::SCStatusCodes::CloseSession, secure_channel::common::SCStatusCodes::CloseSession,
None, None,
)?; )?;
if let Some((_, exchange)) = self.exchanges.iter_mut().find(|(_, e)| e.sess_idx == index) { if let Some((_, exchange)) =
self.exchanges.iter_mut().find(|(_, e)| e.sess_idx == index)
{
// Send Close_session on this exchange, and then close the session // Send Close_session on this exchange, and then close the session
// Should this be done for all exchanges? // Should this be done for all exchanges?
error!("Sending Close Session"); error!("Sending Close Session");
@ -395,7 +377,7 @@ impl ExchangeMgr {
// TODO: This wouldn't actually send it out, because 'transport' isn't owned yet. // TODO: This wouldn't actually send it out, because 'transport' isn't owned yet.
} }
let remove_exchanges: Vec<u16> = self let remove_exchanges: heapless::Vec<u16, MAX_EXCHANGES> = self
.exchanges .exchanges
.iter() .iter()
.filter_map(|(eid, e)| { .filter_map(|(eid, e)| {
@ -415,21 +397,16 @@ impl ExchangeMgr {
self.exchanges.remove(&exch_id); self.exchanges.remove(&exch_id);
} }
self.sess_mgr.remove(index); self.sess_mgr.remove(index);
Ok(())
Ok(true)
} else {
Ok(false)
}
} }
pub fn add_session(&mut self, clone_data: &CloneData) -> Result<SessionHandle, Error> { pub fn add_session(&mut self, clone_data: &CloneData) -> Result<SessionHandle, Error> {
let sess_idx = match self.sess_mgr.clone_session(clone_data) { let sess_idx = self.sess_mgr.clone_session(clone_data)?;
Ok(idx) => idx,
Err(Error::NoSpace) => {
let evict_index = self.sess_mgr.get_lru();
self.evict_session(evict_index)?;
self.sess_mgr.clone_session(clone_data)?
}
Err(e) => {
return Err(e);
}
};
Ok(self.sess_mgr.get_session_handle(sess_idx)) Ok(self.sess_mgr.get_session_handle(sess_idx))
} }
} }
@ -449,12 +426,16 @@ impl fmt::Display for ExchangeMgr {
#[cfg(test)] #[cfg(test)]
#[allow(clippy::bool_assert_comparison)] #[allow(clippy::bool_assert_comparison)]
mod tests { mod tests {
use crate::{ use crate::{
error::Error, error::Error,
transport::{ transport::{
network::{Address, NetworkInterface}, network::Address,
session::{CloneData, SessionMgr, SessionMode, MAX_SESSIONS}, packet::Packet,
session::{CloneData, SessionMode, MAX_SESSIONS},
},
utils::{
epoch::{dummy_epoch, sys_epoch},
rand::dummy_rand,
}, },
}; };
@ -462,8 +443,7 @@ mod tests {
#[test] #[test]
fn test_purge() { fn test_purge() {
let sess_mgr = SessionMgr::new(); let mut mgr = ExchangeMgr::new(dummy_epoch, dummy_rand);
let mut mgr = ExchangeMgr::new(sess_mgr);
let _ = ExchangeMgr::_get(&mut mgr.exchanges, 1, 2, Role::Responder, true).unwrap(); let _ = ExchangeMgr::_get(&mut mgr.exchanges, 1, 2, Role::Responder, true).unwrap();
let _ = ExchangeMgr::_get(&mut mgr.exchanges, 1, 3, Role::Responder, true).unwrap(); let _ = ExchangeMgr::_get(&mut mgr.exchanges, 1, 3, Role::Responder, true).unwrap();
@ -519,33 +499,13 @@ mod tests {
} }
} }
pub struct DummyNetwork;
impl DummyNetwork {
pub fn new() -> Self {
Self {}
}
}
impl NetworkInterface for DummyNetwork {
fn recv(&self, _in_buf: &mut [u8]) -> Result<(usize, Address), Error> {
Ok((0, Address::default()))
}
fn send(&self, _out_buf: &[u8], _addr: Address) -> Result<usize, Error> {
Ok(0)
}
}
#[test] #[test]
/// We purposefuly overflow the sessions /// We purposefuly overflow the sessions
/// and when the overflow happens, we confirm that /// and when the overflow happens, we confirm that
/// - The sessions are evicted in LRU /// - The sessions are evicted in LRU
/// - The exchanges associated with those sessions are evicted too /// - The exchanges associated with those sessions are evicted too
fn test_sess_evict() { fn test_sess_evict() {
let mut sess_mgr = SessionMgr::new(); let mut mgr = ExchangeMgr::new(sys_epoch, dummy_rand); // TODO
let transport = Box::new(DummyNetwork::new());
sess_mgr.add_network_interface(transport).unwrap();
let mut mgr = ExchangeMgr::new(sess_mgr);
fill_sessions(&mut mgr, MAX_SESSIONS + 1); fill_sessions(&mut mgr, MAX_SESSIONS + 1);
// Sessions are now full from local session id 1 to 16 // Sessions are now full from local session id 1 to 16
@ -568,6 +528,14 @@ mod tests {
for i in 1..(MAX_SESSIONS + 1) { for i in 1..(MAX_SESSIONS + 1) {
// Now purposefully overflow the sessions by adding another session // Now purposefully overflow the sessions by adding another session
let result = mgr.add_session(&get_clone_data(new_peer_sess_id, new_local_sess_id));
assert!(matches!(result, Err(Error::NoSpace)));
let mut buf = [0; 1500];
let tx = &mut Packet::new_tx(&mut buf);
let evicted = mgr.evict_session(tx).unwrap();
assert!(evicted);
let session = mgr let session = mgr
.add_session(&get_clone_data(new_peer_sess_id, new_local_sess_id)) .add_session(&get_clone_data(new_peer_sess_id, new_local_sess_id))
.unwrap(); .unwrap();

View file

@ -15,161 +15,210 @@
* limitations under the License. * limitations under the License.
*/ */
use async_channel::Receiver; use core::borrow::Borrow;
use boxslab::{BoxSlab, Slab}; use core::cell::RefCell;
use heapless::LinearMap;
use log::{debug, error, info}; use log::info;
use crate::error::*; use crate::error::*;
use crate::fabric::FabricMgr;
use crate::mdns::MdnsMgr;
use crate::secure_channel::pake::PaseMgr;
use crate::secure_channel::common::PROTO_ID_SECURE_CHANNEL;
use crate::secure_channel::core::SecureChannel;
use crate::transport::mrp::ReliableMessage; use crate::transport::mrp::ReliableMessage;
use crate::transport::packet::PacketPool; use crate::transport::{exchange, packet::Packet};
use crate::transport::{exchange, packet::Packet, proto_demux, queue, session, udp}; use crate::utils::epoch::Epoch;
use crate::utils::rand::Rand;
use super::proto_demux::ProtoCtx; use super::proto_ctx::ProtoCtx;
use super::queue::Msg;
pub struct Mgr { #[derive(Copy, Clone, Eq, PartialEq)]
exch_mgr: exchange::ExchangeMgr, enum RecvState {
proto_demux: proto_demux::ProtoDemux, New,
rx_q: Receiver<Msg>, OpenExchange,
EvictSession,
Ack,
} }
impl Mgr { pub enum RecvAction<'r, 'p> {
pub fn new() -> Result<Mgr, Error> { Send(&'r [u8]),
let mut sess_mgr = session::SessionMgr::new(); Interact(ProtoCtx<'r, 'p>),
let udp_transport = Box::new(udp::UdpListener::new()?); }
sess_mgr.add_network_interface(udp_transport)?;
Ok(Mgr {
proto_demux: proto_demux::ProtoDemux::new(),
exch_mgr: exchange::ExchangeMgr::new(sess_mgr),
rx_q: queue::WorkQ::init()?,
})
}
// Allows registration of different protocols with the Transport/Protocol Demux pub struct RecvCompletion<'r, 'a, 'p> {
pub fn register_protocol( mgr: &'r mut TransportMgr<'a>,
&mut self, rx: &'r mut Packet<'p>,
proto_id_handle: Box<dyn proto_demux::HandleProto>, tx: &'r mut Packet<'p>,
) -> Result<(), Error> { state: RecvState,
self.proto_demux.register(proto_id_handle) }
}
fn send_to_exchange( impl<'r, 'a, 'p> RecvCompletion<'r, 'a, 'p> {
&mut self, pub fn next_action(&mut self) -> Result<Option<RecvAction<'_, 'p>>, Error> {
exch_id: u16,
proto_tx: BoxSlab<PacketPool>,
) -> Result<(), Error> {
self.exch_mgr.send(exch_id, proto_tx)
}
fn handle_rxtx(&mut self) -> Result<(), Error> {
let result = self.exch_mgr.recv().map_err(|e| {
error!("Error in recv: {:?}", e);
e
})?;
if result.is_none() {
// Nothing to process, return quietly
return Ok(());
}
// result contains something worth processing, we can safely unwrap
// as we already checked for none above
let (rx, exch_ctx) = result.unwrap();
debug!("Exchange is {:?}", exch_ctx.exch);
let tx = Self::new_tx()?;
let mut proto_ctx = ProtoCtx::new(exch_ctx, rx, tx);
// Proto Dispatch
match self.proto_demux.handle(&mut proto_ctx) {
Ok(r) => {
if let proto_demux::ResponseRequired::No = r {
// We need to send the Ack if reliability is enabled, in this case
return Ok(());
}
}
Err(e) => {
error!("Error in proto_demux {:?}", e);
return Err(e);
}
}
let ProtoCtx {
exch_ctx,
rx: _,
tx,
} = proto_ctx;
// tx_ctx now contains the response payload, send the packet
let exch_id = exch_ctx.exch.get_id();
self.send_to_exchange(exch_id, tx).map_err(|e| {
error!("Error in sending msg {:?}", e);
e
})?;
Ok(())
}
fn handle_queue_msgs(&mut self) -> Result<(), Error> {
if let Ok(msg) = self.rx_q.try_recv() {
match msg {
Msg::NewSession(clone_data) => {
// If a new session was created, add it
let _ = self
.exch_mgr
.add_session(&clone_data)
.map_err(|e| error!("Error adding new session {:?}", e));
}
_ => {
error!("Queue Message Type not yet handled {:?}", msg);
}
}
}
Ok(())
}
pub fn start(&mut self) -> Result<(), Error> {
loop { loop {
// Handle network operations // Polonius will remove the need for unsafe one day
if self.handle_rxtx().is_err() { let this = unsafe { (self as *mut RecvCompletion).as_mut().unwrap() };
error!("Error in handle_rxtx");
continue; if let Some(action) = this.maybe_next_action()? {
return Ok(action);
}
}
} }
if self.handle_queue_msgs().is_err() { fn maybe_next_action(&mut self) -> Result<Option<Option<RecvAction<'_, 'p>>>, Error> {
error!("Error in handle_queue_msg"); self.mgr.exch_mgr.purge();
continue;
}
// Handle any pending acknowledgement send match self.state {
let mut acks_to_send: LinearMap<u16, (), { exchange::MAX_MRP_ENTRIES }> = RecvState::New => {
LinearMap::new(); self.mgr.exch_mgr.get_sess_mgr().decode(self.rx)?;
self.exch_mgr.pending_acks(&mut acks_to_send); self.state = RecvState::OpenExchange;
for exch_id in acks_to_send.keys() { Ok(None)
}
RecvState::OpenExchange => match self.mgr.exch_mgr.recv(self.rx) {
Ok(Some(exch_ctx)) => {
if self.rx.get_proto_id() == PROTO_ID_SECURE_CHANNEL {
let mut proto_ctx = ProtoCtx::new(exch_ctx, self.rx, self.tx);
if self.mgr.secure_channel.handle(&mut proto_ctx)? {
proto_ctx.send()?;
self.state = RecvState::Ack;
Ok(Some(Some(RecvAction::Send(self.tx.as_slice()))))
} else {
self.state = RecvState::Ack;
Ok(None)
}
} else {
let proto_ctx = ProtoCtx::new(exch_ctx, self.rx, self.tx);
self.state = RecvState::Ack;
Ok(Some(Some(RecvAction::Interact(proto_ctx))))
}
}
Ok(None) => {
self.state = RecvState::Ack;
Ok(None)
}
Err(Error::NoSpace) => {
self.state = RecvState::EvictSession;
Ok(None)
}
Err(err) => Err(err),
},
RecvState::EvictSession => {
self.mgr.exch_mgr.evict_session(self.tx)?;
self.state = RecvState::OpenExchange;
Ok(Some(Some(RecvAction::Send(self.tx.as_slice()))))
}
RecvState::Ack => {
if let Some(exch_id) = self.mgr.exch_mgr.pending_ack() {
info!("Sending MRP Standalone ACK for exch {}", exch_id); info!("Sending MRP Standalone ACK for exch {}", exch_id);
let mut proto_tx = match Self::new_tx() {
Ok(p) => p,
Err(e) => {
error!("Error creating proto_tx {:?}", e);
break;
}
};
ReliableMessage::prepare_ack(*exch_id, &mut proto_tx);
if let Err(e) = self.send_to_exchange(*exch_id, proto_tx) {
error!("Error in sending Ack {:?}", e);
}
}
// Handle exchange purging ReliableMessage::prepare_ack(exch_id, self.tx);
// This need not be done in each turn of the loop, maybe once in 5 times or so?
self.exch_mgr.purge();
info!("Exchange Mgr: {}", self.exch_mgr); self.mgr.exch_mgr.send(exch_id, self.tx)?;
Ok(Some(Some(RecvAction::Send(self.tx.as_slice()))))
} else {
Ok(Some(None))
}
} }
} }
fn new_tx() -> Result<BoxSlab<PacketPool>, Error> {
Slab::<PacketPool>::try_new(Packet::new_tx()?).ok_or(Error::PacketPoolExhaust)
} }
} }
#[derive(Copy, Clone, Eq, PartialEq)]
enum NotifyState {}
pub enum NotifyAction<'r, 'p> {
Send(&'r [u8]),
Notify(ProtoCtx<'r, 'p>),
}
pub struct NotifyCompletion<'r, 'a, 'p> {
// TODO
_mgr: &'r mut TransportMgr<'a>,
_rx: &'r mut Packet<'p>,
_tx: &'r mut Packet<'p>,
_state: NotifyState,
}
impl<'r, 'a, 'p> NotifyCompletion<'r, 'a, 'p> {
pub fn next_action(&mut self) -> Result<Option<NotifyAction<'_, 'p>>, Error> {
loop {
// Polonius will remove the need for unsafe one day
let this = unsafe { (self as *mut NotifyCompletion).as_mut().unwrap() };
if let Some(action) = this.maybe_next_action()? {
return Ok(action);
}
}
}
fn maybe_next_action(&mut self) -> Result<Option<Option<NotifyAction<'_, 'p>>>, Error> {
Ok(Some(None)) // TODO: Future
}
}
pub struct TransportMgr<'a> {
exch_mgr: exchange::ExchangeMgr,
secure_channel: SecureChannel<'a>,
}
impl<'a> TransportMgr<'a> {
pub fn new<
T: Borrow<RefCell<FabricMgr>> + Borrow<RefCell<PaseMgr>> + Borrow<Epoch> + Borrow<Rand>,
>(
matter: &'a T,
mdns_mgr: &'a RefCell<MdnsMgr<'a>>,
) -> Self {
Self::wrap(
SecureChannel::new(matter.borrow(), matter.borrow(), mdns_mgr, *matter.borrow()),
*matter.borrow(),
*matter.borrow(),
)
}
pub fn wrap(secure_channel: SecureChannel<'a>, epoch: Epoch, rand: Rand) -> Self {
Self {
exch_mgr: exchange::ExchangeMgr::new(epoch, rand),
secure_channel,
}
}
pub fn recv<'r, 'p>(
&'r mut self,
rx: &'r mut Packet<'p>,
tx: &'r mut Packet<'p>,
) -> RecvCompletion<'r, 'a, 'p> {
RecvCompletion {
mgr: self,
rx,
tx,
state: RecvState::New,
}
}
pub fn notify(&mut self, _tx: &mut Packet) -> Result<bool, Error> {
Ok(false)
}
// async fn handle_queue_msgs(&mut self) -> Result<(), Error> {
// if let Ok(msg) = self.rx_q.try_recv() {
// match msg {
// Msg::NewSession(clone_data) => {
// // If a new session was created, add it
// let _ = self
// .exch_mgr
// .add_session(&clone_data)
// .await
// .map_err(|e| error!("Error adding new session {:?}", e));
// }
// _ => {
// error!("Queue Message Type not yet handled {:?}", msg);
// }
// }
// }
// Ok(())
// }
}

View file

@ -22,7 +22,7 @@ pub mod mrp;
pub mod network; pub mod network;
pub mod packet; pub mod packet;
pub mod plain_hdr; pub mod plain_hdr;
pub mod proto_demux; pub mod proto_ctx;
pub mod proto_hdr; pub mod proto_hdr;
pub mod queue; pub mod queue;
pub mod session; pub mod session;

View file

@ -15,8 +15,8 @@
* limitations under the License. * limitations under the License.
*/ */
use std::time::Duration; use crate::utils::epoch::Epoch;
use std::time::SystemTime; use core::time::Duration;
use crate::{error::*, secure_channel, transport::packet::Packet}; use crate::{error::*, secure_channel, transport::packet::Packet};
use log::error; use log::error;
@ -46,13 +46,13 @@ pub struct AckEntry {
// The msg counter that we should acknowledge // The msg counter that we should acknowledge
msg_ctr: u32, msg_ctr: u32,
// The max time after which this entry must be ACK // The max time after which this entry must be ACK
ack_timeout: SystemTime, ack_timeout: Duration,
} }
impl AckEntry { impl AckEntry {
pub fn new(msg_ctr: u32) -> Result<Self, Error> { pub fn new(msg_ctr: u32, epoch: Epoch) -> Result<Self, Error> {
if let Some(ack_timeout) = if let Some(ack_timeout) =
SystemTime::now().checked_add(Duration::from_millis(MRP_STANDALONE_ACK_TIMEOUT)) epoch().checked_add(Duration::from_millis(MRP_STANDALONE_ACK_TIMEOUT))
{ {
Ok(Self { Ok(Self {
msg_ctr, msg_ctr,
@ -67,8 +67,8 @@ impl AckEntry {
self.msg_ctr self.msg_ctr
} }
pub fn has_timed_out(&self) -> bool { pub fn has_timed_out(&self, epoch: Epoch) -> bool {
self.ack_timeout > SystemTime::now() self.ack_timeout > epoch()
} }
} }
@ -90,10 +90,10 @@ impl ReliableMessage {
} }
// Check any pending acknowledgements / retransmissions and take action // Check any pending acknowledgements / retransmissions and take action
pub fn is_ack_ready(&self) -> bool { pub fn is_ack_ready(&self, epoch: Epoch) -> bool {
// Acknowledgements // Acknowledgements
if let Some(ack_entry) = self.ack { if let Some(ack_entry) = self.ack {
ack_entry.has_timed_out() ack_entry.has_timed_out(epoch)
} else { } else {
false false
} }
@ -132,7 +132,7 @@ impl ReliableMessage {
* - there can be only one pending retransmission per exchange (so this is per-exchange) * - there can be only one pending retransmission per exchange (so this is per-exchange)
* - duplicate detection should happen per session (obviously), so that part is per-session * - duplicate detection should happen per session (obviously), so that part is per-session
*/ */
pub fn recv(&mut self, proto_rx: &Packet) -> Result<(), Error> { pub fn recv(&mut self, proto_rx: &Packet, epoch: Epoch) -> Result<(), Error> {
if proto_rx.proto.is_ack() { if proto_rx.proto.is_ack() {
// Handle received Acks // Handle received Acks
let ack_msg_ctr = proto_rx.proto.get_ack_msg_ctr().ok_or(Error::Invalid)?; let ack_msg_ctr = proto_rx.proto.get_ack_msg_ctr().ok_or(Error::Invalid)?;
@ -153,7 +153,7 @@ impl ReliableMessage {
return Err(Error::Invalid); return Err(Error::Invalid);
} }
self.ack = Some(AckEntry::new(proto_rx.plain.ctr)?); self.ack = Some(AckEntry::new(proto_rx.plain.ctr, epoch)?);
} }
Ok(()) Ok(())
} }

View file

@ -15,12 +15,8 @@
* limitations under the License. * limitations under the License.
*/ */
use std::{ use core::fmt::{Debug, Display};
fmt::{Debug, Display}, use std::net::{IpAddr, Ipv4Addr, SocketAddr};
net::{IpAddr, Ipv4Addr, SocketAddr},
};
use crate::error::Error;
#[derive(PartialEq, Copy, Clone)] #[derive(PartialEq, Copy, Clone)]
pub enum Address { pub enum Address {
@ -34,7 +30,7 @@ impl Default for Address {
} }
impl Display for Address { impl Display for Address {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
match self { match self {
Address::Udp(addr) => writeln!(f, "{}", addr), Address::Udp(addr) => writeln!(f, "{}", addr),
} }
@ -42,14 +38,9 @@ impl Display for Address {
} }
impl Debug for Address { impl Debug for Address {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
match self { match self {
Address::Udp(addr) => writeln!(f, "{}", addr), Address::Udp(addr) => writeln!(f, "{}", addr),
} }
} }
} }
pub trait NetworkInterface {
fn recv(&self, in_buf: &mut [u8]) -> Result<(usize, Address), Error>;
fn send(&self, out_buf: &[u8], addr: Address) -> Result<usize, Error>;
}

View file

@ -99,46 +99,46 @@ pub struct Packet<'a> {
pub proto: ProtoHdr, pub proto: ProtoHdr,
pub peer: Address, pub peer: Address,
data: Direction<'a>, data: Direction<'a>,
buffer_index: usize,
} }
impl<'a> Packet<'a> { impl<'a> Packet<'a> {
const HDR_RESERVE: usize = plain_hdr::max_plain_hdr_len() + proto_hdr::max_proto_hdr_len(); const HDR_RESERVE: usize = plain_hdr::max_plain_hdr_len() + proto_hdr::max_proto_hdr_len();
pub fn new_rx() -> Result<Self, Error> { pub fn new_rx(buf: &'a mut [u8]) -> Self {
let (buffer_index, buffer) = BufferPool::alloc().ok_or(Error::NoSpace)?; Self {
let buf_len = buffer.len();
Ok(Self {
plain: Default::default(), plain: Default::default(),
proto: Default::default(), proto: Default::default(),
buffer_index,
peer: Address::default(), peer: Address::default(),
data: Direction::Rx(ParseBuf::new(buffer, buf_len), RxState::Uninit), data: Direction::Rx(ParseBuf::new(buf), RxState::Uninit),
}) }
} }
pub fn new_tx() -> Result<Self, Error> { pub fn new_tx(buf: &'a mut [u8]) -> Self {
let (buffer_index, buffer) = BufferPool::alloc().ok_or(Error::NoSpace)?; let mut wb = WriteBuf::new(buf);
let buf_len = buffer.len(); wb.reserve(Packet::HDR_RESERVE).unwrap();
let mut wb = WriteBuf::new(buffer, buf_len); // Reliability on by default
wb.reserve(Packet::HDR_RESERVE)?; let mut proto: ProtoHdr = Default::default();
proto.set_reliable();
let mut p = Self { Self {
plain: Default::default(), plain: Default::default(),
proto: Default::default(), proto,
buffer_index,
peer: Address::default(), peer: Address::default(),
data: Direction::Tx(wb), data: Direction::Tx(wb),
}; }
// Reliability on by default
p.proto.set_reliable();
Ok(p)
} }
pub fn as_borrow_slice(&mut self) -> &mut [u8] { pub fn as_slice(&self) -> &[u8] {
match &self.data {
Direction::Rx(pb, _) => pb.as_slice(),
Direction::Tx(wb) => wb.as_slice(),
}
}
pub fn as_mut_slice(&mut self) -> &mut [u8] {
match &mut self.data { match &mut self.data {
Direction::Rx(pb, _) => pb.as_borrow_slice(), Direction::Rx(pb, _) => pb.as_mut_slice(),
Direction::Tx(wb) => wb.as_mut_slice(), Direction::Tx(wb) => wb.as_mut_slice(),
} }
} }
@ -229,11 +229,4 @@ impl<'a> Packet<'a> {
} }
} }
impl<'a> Drop for Packet<'a> {
fn drop(&mut self) {
BufferPool::free(self.buffer_index);
trace!("Dropping Packet......");
}
}
box_slab!(PacketPool, Packet<'static>, MAX_PACKET_POOL_SIZE); box_slab!(PacketPool, Packet<'static>, MAX_PACKET_POOL_SIZE);

View file

@ -21,18 +21,13 @@ use crate::utils::writebuf::WriteBuf;
use bitflags::bitflags; use bitflags::bitflags;
use log::info; use log::info;
#[derive(Debug, PartialEq)] #[derive(Debug, PartialEq, Default)]
pub enum SessionType { pub enum SessionType {
#[default]
None, None,
Encrypted, Encrypted,
} }
impl Default for SessionType {
fn default() -> SessionType {
SessionType::None
}
}
bitflags! { bitflags! {
#[derive(Default)] #[derive(Default)]
pub struct MsgFlags: u8 { pub struct MsgFlags: u8 {

View file

@ -0,0 +1,43 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::error::Error;
use super::exchange::ExchangeCtx;
use super::packet::Packet;
/// This is the context in which a receive packet is being processed
pub struct ProtoCtx<'a, 'b> {
/// This is the exchange context, that includes the exchange and the session
pub exch_ctx: ExchangeCtx<'a>,
/// This is the received buffer for this transaction
pub rx: &'a Packet<'b>,
/// This is the transmit buffer for this transaction
pub tx: &'a mut Packet<'b>,
}
impl<'a, 'b> ProtoCtx<'a, 'b> {
pub fn new(exch_ctx: ExchangeCtx<'a>, rx: &'a Packet<'b>, tx: &'a mut Packet<'b>) -> Self {
Self { exch_ctx, rx, tx }
}
pub fn send(&mut self) -> Result<&[u8], Error> {
self.exch_ctx.exch.send(self.tx, &mut self.exch_ctx.sess)?;
Ok(self.tx.as_mut_slice())
}
}

View file

@ -1,95 +0,0 @@
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use boxslab::BoxSlab;
use crate::error::*;
use super::exchange::ExchangeCtx;
use super::packet::PacketPool;
const MAX_PROTOCOLS: usize = 4;
#[derive(PartialEq, Debug)]
pub enum ResponseRequired {
Yes,
No,
}
pub struct ProtoDemux {
proto_id_handlers: [Option<Box<dyn HandleProto>>; MAX_PROTOCOLS],
}
/// This is the context in which a receive packet is being processed
pub struct ProtoCtx<'a> {
/// This is the exchange context, that includes the exchange and the session
pub exch_ctx: ExchangeCtx<'a>,
/// This is the received buffer for this transaction
pub rx: BoxSlab<PacketPool>,
/// This is the transmit buffer for this transaction
pub tx: BoxSlab<PacketPool>,
}
impl<'a> ProtoCtx<'a> {
pub fn new(
exch_ctx: ExchangeCtx<'a>,
rx: BoxSlab<PacketPool>,
tx: BoxSlab<PacketPool>,
) -> Self {
Self { exch_ctx, rx, tx }
}
}
pub trait HandleProto {
fn handle_proto_id(&mut self, proto_ctx: &mut ProtoCtx) -> Result<ResponseRequired, Error>;
fn get_proto_id(&self) -> usize;
fn handle_session_event(&self) -> Result<(), Error> {
Ok(())
}
}
impl Default for ProtoDemux {
fn default() -> Self {
Self::new()
}
}
impl ProtoDemux {
pub fn new() -> ProtoDemux {
ProtoDemux {
proto_id_handlers: [None, None, None, None],
}
}
pub fn register(&mut self, proto_id_handle: Box<dyn HandleProto>) -> Result<(), Error> {
let proto_id = proto_id_handle.get_proto_id();
self.proto_id_handlers[proto_id] = Some(proto_id_handle);
Ok(())
}
pub fn handle(&mut self, proto_ctx: &mut ProtoCtx) -> Result<ResponseRequired, Error> {
let proto_id = proto_ctx.rx.get_proto_id() as usize;
if proto_id >= MAX_PROTOCOLS {
return Err(Error::Invalid);
}
return self.proto_id_handlers[proto_id]
.as_mut()
.ok_or(Error::NoHandler)?
.handle_proto_id(proto_ctx);
}
}

View file

@ -16,7 +16,7 @@
*/ */
use bitflags::bitflags; use bitflags::bitflags;
use std::fmt; use core::fmt;
use crate::transport::plain_hdr; use crate::transport::plain_hdr;
use crate::utils::parsebuf::ParseBuf; use crate::utils::parsebuf::ParseBuf;
@ -117,7 +117,7 @@ impl ProtoHdr {
if self.is_ack() { if self.is_ack() {
self.ack_msg_ctr = Some(parsebuf.le_u32()?); self.ack_msg_ctr = Some(parsebuf.le_u32()?);
} }
trace!("[rx payload]: {:x?}", parsebuf.as_borrow_slice()); trace!("[rx payload]: {:x?}", parsebuf.as_mut_slice());
Ok(()) Ok(())
} }
@ -139,21 +139,21 @@ impl ProtoHdr {
impl fmt::Display for ProtoHdr { impl fmt::Display for ProtoHdr {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut flag_str: String = "".to_owned(); let mut flag_str = heapless::String::<16>::new();
if self.is_vendor() { if self.is_vendor() {
flag_str.push_str("V|"); flag_str.push_str("V|").unwrap();
} }
if self.is_security_ext() { if self.is_security_ext() {
flag_str.push_str("SX|"); flag_str.push_str("SX|").unwrap();
} }
if self.is_reliable() { if self.is_reliable() {
flag_str.push_str("R|"); flag_str.push_str("R|").unwrap();
} }
if self.is_ack() { if self.is_ack() {
flag_str.push_str("A|"); flag_str.push_str("A|").unwrap();
} }
if self.is_initiator() { if self.is_initiator() {
flag_str.push_str("I|"); flag_str.push_str("I|").unwrap();
} }
write!( write!(
f, f,
@ -165,7 +165,7 @@ impl fmt::Display for ProtoHdr {
fn get_iv(recvd_ctr: u32, peer_nodeid: u64, iv: &mut [u8]) -> Result<(), Error> { fn get_iv(recvd_ctr: u32, peer_nodeid: u64, iv: &mut [u8]) -> Result<(), Error> {
// The IV is the source address (64-bit) followed by the message counter (32-bit) // The IV is the source address (64-bit) followed by the message counter (32-bit)
let mut write_buf = WriteBuf::new(iv, iv.len()); let mut write_buf = WriteBuf::new(iv);
// For some reason, this is 0 in the 'bypass' mode // For some reason, this is 0 in the 'bypass' mode
write_buf.le_u8(0)?; write_buf.le_u8(0)?;
write_buf.le_u32(recvd_ctr)?; write_buf.le_u32(recvd_ctr)?;
@ -224,7 +224,7 @@ fn decrypt_in_place(
let mut iv = [0_u8; crypto::AEAD_NONCE_LEN_BYTES]; let mut iv = [0_u8; crypto::AEAD_NONCE_LEN_BYTES];
get_iv(recvd_ctr, peer_nodeid, &mut iv)?; get_iv(recvd_ctr, peer_nodeid, &mut iv)?;
let cipher_text = parsebuf.as_borrow_slice(); let cipher_text = parsebuf.as_mut_slice();
//println!("AAD: {:x?}", aad); //println!("AAD: {:x?}", aad);
//println!("Cipher Text: {:x?}", cipher_text); //println!("Cipher Text: {:x?}", cipher_text);
//println!("IV: {:x?}", iv); //println!("IV: {:x?}", iv);
@ -266,8 +266,7 @@ mod tests {
0x1f, 0xb0, 0x5e, 0xbe, 0xb5, 0x10, 0xad, 0xc6, 0x78, 0x94, 0x50, 0xe5, 0xd2, 0xe0, 0x1f, 0xb0, 0x5e, 0xbe, 0xb5, 0x10, 0xad, 0xc6, 0x78, 0x94, 0x50, 0xe5, 0xd2, 0xe0,
0x80, 0xef, 0xa8, 0x3a, 0xf0, 0xa6, 0xaf, 0x1b, 0x2, 0x35, 0xa7, 0xd1, 0xc6, 0x32, 0x80, 0xef, 0xa8, 0x3a, 0xf0, 0xa6, 0xaf, 0x1b, 0x2, 0x35, 0xa7, 0xd1, 0xc6, 0x32,
]; ];
let input_buf_len = input_buf.len(); let mut parsebuf = ParseBuf::new(&mut input_buf);
let mut parsebuf = ParseBuf::new(&mut input_buf, input_buf_len);
let key = [ let key = [
0x66, 0x63, 0x31, 0x97, 0x43, 0x9c, 0x17, 0xb9, 0x7e, 0x10, 0xee, 0x47, 0xc8, 0x8, 0x66, 0x63, 0x31, 0x97, 0x43, 0x9c, 0x17, 0xb9, 0x7e, 0x10, 0xee, 0x47, 0xc8, 0x8,
0x80, 0x4a, 0x80, 0x4a,
@ -279,7 +278,7 @@ mod tests {
decrypt_in_place(recvd_ctr, 0, &mut parsebuf, &key).unwrap(); decrypt_in_place(recvd_ctr, 0, &mut parsebuf, &key).unwrap();
assert_eq!( assert_eq!(
parsebuf.as_slice(), parsebuf.into_slice(),
[ [
0x5, 0x8, 0x70, 0x0, 0x1, 0x0, 0x15, 0x28, 0x0, 0x28, 0x1, 0x36, 0x2, 0x15, 0x37, 0x5, 0x8, 0x70, 0x0, 0x1, 0x0, 0x15, 0x28, 0x0, 0x28, 0x1, 0x36, 0x2, 0x15, 0x37,
0x0, 0x24, 0x0, 0x0, 0x24, 0x1, 0x30, 0x24, 0x2, 0x2, 0x18, 0x35, 0x1, 0x24, 0x0, 0x0, 0x24, 0x0, 0x0, 0x24, 0x1, 0x30, 0x24, 0x2, 0x2, 0x18, 0x35, 0x1, 0x24, 0x0,
@ -295,8 +294,7 @@ mod tests {
let send_ctr = 41; let send_ctr = 41;
let mut main_buf: [u8; 52] = [0; 52]; let mut main_buf: [u8; 52] = [0; 52];
let main_buf_len = main_buf.len(); let mut writebuf = WriteBuf::new(&mut main_buf);
let mut writebuf = WriteBuf::new(&mut main_buf, main_buf_len);
let plain_hdr: [u8; 8] = [0x0, 0x11, 0x0, 0x0, 0x29, 0x0, 0x0, 0x0]; let plain_hdr: [u8; 8] = [0x0, 0x11, 0x0, 0x0, 0x29, 0x0, 0x0, 0x0];
@ -313,7 +311,7 @@ mod tests {
encrypt_in_place(send_ctr, 0, &plain_hdr, &mut writebuf, &key).unwrap(); encrypt_in_place(send_ctr, 0, &plain_hdr, &mut writebuf, &key).unwrap();
assert_eq!( assert_eq!(
writebuf.as_slice(), writebuf.into_slice(),
[ [
189, 83, 250, 121, 38, 87, 97, 17, 153, 78, 243, 20, 36, 11, 131, 142, 136, 165, 189, 83, 250, 121, 38, 87, 97, 17, 153, 78, 243, 20, 36, 11, 131, 142, 136, 165,
227, 107, 204, 129, 193, 153, 42, 131, 138, 254, 22, 190, 76, 244, 116, 45, 156, 227, 107, 204, 129, 193, 153, 42, 131, 138, 254, 22, 190, 76, 244, 116, 45, 156,

View file

@ -15,11 +15,14 @@
* limitations under the License. * limitations under the License.
*/ */
use crate::data_model::sdm::noc::NocData;
use crate::utils::epoch::Epoch;
use crate::utils::rand::Rand;
use core::fmt; use core::fmt;
use std::{ use core::time::Duration;
use core::{
any::Any, any::Any,
ops::{Deref, DerefMut}, ops::{Deref, DerefMut},
time::SystemTime,
}; };
use crate::{ use crate::{
@ -27,16 +30,10 @@ use crate::{
transport::{plain_hdr, proto_hdr}, transport::{plain_hdr, proto_hdr},
utils::writebuf::WriteBuf, utils::writebuf::WriteBuf,
}; };
use boxslab::{BoxSlab, Slab};
use colored::*;
use log::{info, trace}; use log::{info, trace};
use rand::Rng;
use super::{ use super::dedup::RxCtrState;
dedup::RxCtrState, use super::{network::Address, packet::Packet};
network::{Address, NetworkInterface},
packet::{Packet, PacketPool},
};
pub const MAX_CAT_IDS_PER_NOC: usize = 3; pub const MAX_CAT_IDS_PER_NOC: usize = 3;
pub type NocCatIds = [u32; MAX_CAT_IDS_PER_NOC]; pub type NocCatIds = [u32; MAX_CAT_IDS_PER_NOC];
@ -58,21 +55,15 @@ impl CaseDetails {
} }
} }
#[derive(Debug, PartialEq, Copy, Clone)] #[derive(Debug, PartialEq, Copy, Clone, Default)]
pub enum SessionMode { pub enum SessionMode {
// The Case session will capture the local fabric index // The Case session will capture the local fabric index
Case(CaseDetails), Case(CaseDetails),
Pase, Pase,
#[default]
PlainText, PlainText,
} }
impl Default for SessionMode {
fn default() -> Self {
SessionMode::PlainText
}
}
#[derive(Debug)]
pub struct Session { pub struct Session {
peer_addr: Address, peer_addr: Address,
local_nodeid: u64, local_nodeid: u64,
@ -87,8 +78,8 @@ pub struct Session {
msg_ctr: u32, msg_ctr: u32,
rx_ctr_state: RxCtrState, rx_ctr_state: RxCtrState,
mode: SessionMode, mode: SessionMode,
data: Option<Box<dyn Any>>, data: Option<NocData>,
last_use: SystemTime, last_use: Duration,
} }
#[derive(Debug)] #[derive(Debug)]
@ -103,6 +94,7 @@ pub struct CloneData {
peer_addr: Address, peer_addr: Address,
mode: SessionMode, mode: SessionMode,
} }
impl CloneData { impl CloneData {
pub fn new( pub fn new(
local_nodeid: u64, local_nodeid: u64,
@ -129,8 +121,8 @@ impl CloneData {
const MATTER_MSG_CTR_RANGE: u32 = 0x0fffffff; const MATTER_MSG_CTR_RANGE: u32 = 0x0fffffff;
impl Session { impl Session {
pub fn new(peer_addr: Address, peer_nodeid: Option<u64>) -> Session { pub fn new(peer_addr: Address, peer_nodeid: Option<u64>, epoch: Epoch, rand: Rand) -> Self {
Session { Self {
peer_addr, peer_addr,
local_nodeid: 0, local_nodeid: 0,
peer_nodeid, peer_nodeid,
@ -139,16 +131,16 @@ impl Session {
att_challenge: [0; MATTER_AES128_KEY_SIZE], att_challenge: [0; MATTER_AES128_KEY_SIZE],
peer_sess_id: 0, peer_sess_id: 0,
local_sess_id: 0, local_sess_id: 0,
msg_ctr: rand::thread_rng().gen_range(0..MATTER_MSG_CTR_RANGE), msg_ctr: Self::rand_msg_ctr(rand),
rx_ctr_state: RxCtrState::new(0), rx_ctr_state: RxCtrState::new(0),
mode: SessionMode::PlainText, mode: SessionMode::PlainText,
data: None, data: None,
last_use: SystemTime::now(), last_use: epoch(),
} }
} }
// A new encrypted session always clones from a previous 'new' session // A new encrypted session always clones from a previous 'new' session
pub fn clone(clone_from: &CloneData) -> Session { pub fn clone(clone_from: &CloneData, epoch: Epoch, rand: Rand) -> Session {
Session { Session {
peer_addr: clone_from.peer_addr, peer_addr: clone_from.peer_addr,
local_nodeid: clone_from.local_nodeid, local_nodeid: clone_from.local_nodeid,
@ -158,28 +150,28 @@ impl Session {
att_challenge: clone_from.att_challenge, att_challenge: clone_from.att_challenge,
local_sess_id: clone_from.local_sess_id, local_sess_id: clone_from.local_sess_id,
peer_sess_id: clone_from.peer_sess_id, peer_sess_id: clone_from.peer_sess_id,
msg_ctr: rand::thread_rng().gen_range(0..MATTER_MSG_CTR_RANGE), msg_ctr: Self::rand_msg_ctr(rand),
rx_ctr_state: RxCtrState::new(0), rx_ctr_state: RxCtrState::new(0),
mode: clone_from.mode, mode: clone_from.mode,
data: None, data: None,
last_use: SystemTime::now(), last_use: epoch(),
} }
} }
pub fn set_data(&mut self, data: Box<dyn Any>) { pub fn set_noc_data(&mut self, data: NocData) {
self.data = Some(data); self.data = Some(data);
} }
pub fn clear_data(&mut self) { pub fn clear_noc_data(&mut self) {
self.data = None; self.data = None;
} }
pub fn get_data<T: Any>(&mut self) -> Option<&mut T> { pub fn get_noc_data<T: Any>(&mut self) -> Option<&mut NocData> {
self.data.as_mut()?.downcast_mut::<T>() self.data.as_mut()
} }
pub fn take_data<T: Any>(&mut self) -> Option<Box<T>> { pub fn take_noc_data(&mut self) -> Option<NocData> {
self.data.take()?.downcast::<T>().ok() self.data.take()
} }
pub fn get_local_sess_id(&self) -> u16 { pub fn get_local_sess_id(&self) -> u16 {
@ -252,59 +244,65 @@ impl Session {
&self.att_challenge &self.att_challenge
} }
pub fn recv(&mut self, proto_rx: &mut Packet) -> Result<(), Error> { pub fn recv(&mut self, epoch: Epoch, rx: &mut Packet) -> Result<(), Error> {
self.last_use = SystemTime::now(); self.last_use = epoch();
proto_rx.proto_decode(self.peer_nodeid.unwrap_or_default(), self.get_dec_key()) rx.proto_decode(self.peer_nodeid.unwrap_or_default(), self.get_dec_key())
} }
pub fn pre_send(&mut self, proto_tx: &mut Packet) -> Result<(), Error> { pub fn pre_send(&mut self, tx: &mut Packet) -> Result<(), Error> {
proto_tx.plain.sess_id = self.get_peer_sess_id(); tx.plain.sess_id = self.get_peer_sess_id();
proto_tx.plain.ctr = self.get_msg_ctr(); tx.plain.ctr = self.get_msg_ctr();
if self.is_encrypted() { if self.is_encrypted() {
proto_tx.plain.sess_type = plain_hdr::SessionType::Encrypted; tx.plain.sess_type = plain_hdr::SessionType::Encrypted;
} }
Ok(()) Ok(())
} }
// TODO: Most of this can now be moved into the 'Packet' module // TODO: Most of this can now be moved into the 'Packet' module
fn do_send(&mut self, proto_tx: &mut Packet) -> Result<(), Error> { fn do_send(&mut self, epoch: Epoch, tx: &mut Packet) -> Result<(), Error> {
self.last_use = SystemTime::now(); self.last_use = epoch();
proto_tx.peer = self.peer_addr; tx.peer = self.peer_addr;
// Generate encrypted header // Generate encrypted header
let mut tmp_buf: [u8; proto_hdr::max_proto_hdr_len()] = [0; proto_hdr::max_proto_hdr_len()]; let mut tmp_buf = [0_u8; proto_hdr::max_proto_hdr_len()];
let mut write_buf = WriteBuf::new(&mut tmp_buf[..], proto_hdr::max_proto_hdr_len()); let mut write_buf = WriteBuf::new(&mut tmp_buf);
proto_tx.proto.encode(&mut write_buf)?; tx.proto.encode(&mut write_buf)?;
proto_tx.get_writebuf()?.prepend(write_buf.as_slice())?; tx.get_writebuf()?.prepend(write_buf.into_slice())?;
// Generate plain-text header // Generate plain-text header
if self.mode == SessionMode::PlainText { if self.mode == SessionMode::PlainText {
if let Some(d) = self.peer_nodeid { if let Some(d) = self.peer_nodeid {
proto_tx.plain.set_dest_u64(d); tx.plain.set_dest_u64(d);
} }
} }
let mut tmp_buf: [u8; plain_hdr::max_plain_hdr_len()] = [0; plain_hdr::max_plain_hdr_len()]; let mut tmp_buf = [0_u8; plain_hdr::max_plain_hdr_len()];
let mut write_buf = WriteBuf::new(&mut tmp_buf[..], plain_hdr::max_plain_hdr_len()); let mut write_buf = WriteBuf::new(&mut tmp_buf);
proto_tx.plain.encode(&mut write_buf)?; tx.plain.encode(&mut write_buf)?;
let plain_hdr_bytes = write_buf.as_slice(); let plain_hdr_bytes = write_buf.into_slice();
trace!("unencrypted packet: {:x?}", proto_tx.as_borrow_slice()); trace!("unencrypted packet: {:x?}", tx.as_mut_slice());
let ctr = proto_tx.plain.ctr; let ctr = tx.plain.ctr;
let enc_key = self.get_enc_key(); let enc_key = self.get_enc_key();
if let Some(e) = enc_key { if let Some(e) = enc_key {
proto_hdr::encrypt_in_place( proto_hdr::encrypt_in_place(
ctr, ctr,
self.local_nodeid, self.local_nodeid,
plain_hdr_bytes, plain_hdr_bytes,
proto_tx.get_writebuf()?, tx.get_writebuf()?,
e, e,
)?; )?;
} }
proto_tx.get_writebuf()?.prepend(plain_hdr_bytes)?; tx.get_writebuf()?.prepend(plain_hdr_bytes)?;
trace!("Full encrypted packet: {:x?}", proto_tx.as_borrow_slice()); trace!("Full encrypted packet: {:x?}", tx.as_mut_slice());
Ok(()) Ok(())
} }
fn rand_msg_ctr(rand: Rand) -> u32 {
let mut buf = [0; 4];
rand(&mut buf);
u32::from_be_bytes(buf) & MATTER_MSG_CTR_RANGE
}
} }
impl fmt::Display for Session { impl fmt::Display for Session {
@ -324,36 +322,23 @@ impl fmt::Display for Session {
} }
pub const MAX_SESSIONS: usize = 16; pub const MAX_SESSIONS: usize = 16;
pub struct SessionMgr { pub struct SessionMgr {
next_sess_id: u16, next_sess_id: u16,
sessions: [Option<Session>; MAX_SESSIONS], sessions: [Option<Session>; MAX_SESSIONS],
network: Option<Box<dyn NetworkInterface>>, epoch: Epoch,
} rand: Rand,
impl Default for SessionMgr {
fn default() -> Self {
Self::new()
}
} }
impl SessionMgr { impl SessionMgr {
pub fn new() -> SessionMgr { pub fn new(epoch: Epoch, rand: Rand) -> Self {
SessionMgr { const INIT: Option<Session> = None;
sessions: Default::default(),
next_sess_id: 1,
network: None,
}
}
pub fn add_network_interface( Self {
&mut self, sessions: [INIT; MAX_SESSIONS],
interface: Box<dyn NetworkInterface>, next_sess_id: 1,
) -> Result<(), Error> { epoch,
if self.network.is_none() { rand,
self.network = Some(interface);
Ok(())
} else {
Err(Error::Invalid)
} }
} }
@ -380,13 +365,21 @@ impl SessionMgr {
next_sess_id next_sess_id
} }
pub fn get_session_for_eviction(&self) -> Option<usize> {
if self.get_empty_slot().is_none() {
Some(self.get_lru())
} else {
None
}
}
fn get_empty_slot(&self) -> Option<usize> { fn get_empty_slot(&self) -> Option<usize> {
self.sessions.iter().position(|x| x.is_none()) self.sessions.iter().position(|x| x.is_none())
} }
pub fn get_lru(&mut self) -> usize { fn get_lru(&self) -> usize {
let mut lru_index = 0; let mut lru_index = 0;
let mut lru_ts = SystemTime::now(); let mut lru_ts = (self.epoch)();
for i in 0..MAX_SESSIONS { for i in 0..MAX_SESSIONS {
if let Some(s) = &self.sessions[i] { if let Some(s) = &self.sessions[i] {
if s.last_use < lru_ts { if s.last_use < lru_ts {
@ -399,7 +392,7 @@ impl SessionMgr {
} }
pub fn add(&mut self, peer_addr: Address, peer_nodeid: Option<u64>) -> Result<usize, Error> { pub fn add(&mut self, peer_addr: Address, peer_nodeid: Option<u64>) -> Result<usize, Error> {
let session = Session::new(peer_addr, peer_nodeid); let session = Session::new(peer_addr, peer_nodeid, self.epoch, self.rand);
self.add_session(session) self.add_session(session)
} }
@ -422,7 +415,7 @@ impl SessionMgr {
} }
pub fn clone_session(&mut self, clone_data: &CloneData) -> Result<usize, Error> { pub fn clone_session(&mut self, clone_data: &CloneData) -> Result<usize, Error> {
let session = Session::clone(clone_data); let session = Session::clone(clone_data, self.epoch, self.rand);
self.add_session(session) self.add_session(session)
} }
@ -478,68 +471,50 @@ impl SessionMgr {
// We will try to get a session for this Packet. If no session exists, we will try to add one // We will try to get a session for this Packet. If no session exists, we will try to add one
// If the session list is full we will return a None // If the session list is full we will return a None
pub fn post_recv(&mut self, rx: &Packet) -> Result<Option<usize>, Error> { pub fn post_recv(&mut self, rx: &Packet) -> Result<usize, Error> {
let sess_index = match self.get_or_add( let sess_index = self.get_or_add(
rx.plain.sess_id, rx.plain.sess_id,
rx.peer, rx.peer,
rx.plain.get_src_u64(), rx.plain.get_src_u64(),
rx.plain.is_encrypted(), rx.plain.is_encrypted(),
) { )?;
Ok(s) => {
let session = self.sessions[s].as_mut().unwrap(); let session = self.sessions[sess_index].as_mut().unwrap();
let is_encrypted = session.is_encrypted(); let is_encrypted = session.is_encrypted();
let duplicate = session.rx_ctr_state.recv(rx.plain.ctr, is_encrypted); let duplicate = session.rx_ctr_state.recv(rx.plain.ctr, is_encrypted);
if duplicate { if duplicate {
info!("Dropping duplicate packet"); info!("Dropping duplicate packet");
return Err(Error::Duplicate); Err(Error::Duplicate)
} else { } else {
Some(s)
}
}
Err(Error::NoSpace) => None,
Err(e) => {
return Err(e);
}
};
Ok(sess_index) Ok(sess_index)
} }
pub fn recv(&mut self) -> Result<(BoxSlab<PacketPool>, Option<usize>), Error> {
let mut rx =
Slab::<PacketPool>::try_new(Packet::new_rx()?).ok_or(Error::PacketPoolExhaust)?;
let network = self.network.as_ref().ok_or(Error::NoNetworkInterface)?;
let (len, src) = network.recv(rx.as_borrow_slice())?;
rx.get_parsebuf()?.set_len(len);
rx.peer = src;
info!("{} from src: {}", "Received".blue(), src);
trace!("payload: {:x?}", rx.as_borrow_slice());
// Read unencrypted packet header
rx.plain_hdr_decode()?;
// Get session
let sess_handle = self.post_recv(&rx)?;
Ok((rx, sess_handle))
} }
pub fn send( pub fn decode(&mut self, rx: &mut Packet) -> Result<(), Error> {
&mut self, // let network = self.network.as_ref().ok_or(Error::NoNetworkInterface)?;
sess_idx: usize,
mut proto_tx: BoxSlab<PacketPool>, // let (len, src) = network.recv(rx.as_borrow_slice()).await?;
) -> Result<(), Error> { // rx.get_parsebuf()?.set_len(len);
// rx.peer = src;
// info!("{} from src: {}", "Received".blue(), src);
// trace!("payload: {:x?}", rx.as_borrow_slice());
// Read unencrypted packet header
rx.plain_hdr_decode()
}
pub fn send(&mut self, sess_idx: usize, tx: &mut Packet) -> Result<(), Error> {
self.sessions[sess_idx] self.sessions[sess_idx]
.as_mut() .as_mut()
.ok_or(Error::NoSession)? .ok_or(Error::NoSession)?
.do_send(&mut proto_tx)?; .do_send(self.epoch, tx)?;
// let network = self.network.as_ref().ok_or(Error::NoNetworkInterface)?;
// let peer = proto_tx.peer;
// network.send(proto_tx.as_borrow_slice(), peer).await?;
// info!("Message Sent to {}", peer);
let network = self.network.as_ref().ok_or(Error::NoNetworkInterface)?;
let peer = proto_tx.peer;
network.send(proto_tx.as_borrow_slice(), peer)?;
println!("Message Sent to {}", peer);
Ok(()) Ok(())
} }
@ -568,40 +543,52 @@ pub struct SessionHandle<'a> {
} }
impl<'a> SessionHandle<'a> { impl<'a> SessionHandle<'a> {
pub fn session(&self) -> &Session {
self.sess_mgr.sessions[self.sess_idx].as_ref().unwrap()
}
pub fn session_mut(&mut self) -> &mut Session {
self.sess_mgr.sessions[self.sess_idx].as_mut().unwrap()
}
pub fn reserve_new_sess_id(&mut self) -> u16 { pub fn reserve_new_sess_id(&mut self) -> u16 {
self.sess_mgr.get_next_sess_id() self.sess_mgr.get_next_sess_id()
} }
pub fn send(&mut self, proto_tx: BoxSlab<PacketPool>) -> Result<(), Error> { pub fn send(&mut self, tx: &mut Packet) -> Result<(), Error> {
self.sess_mgr.send(self.sess_idx, proto_tx) self.sess_mgr.send(self.sess_idx, tx)
} }
} }
impl<'a> Deref for SessionHandle<'a> { impl<'a> Deref for SessionHandle<'a> {
type Target = Session; type Target = Session;
fn deref(&self) -> &Self::Target { fn deref(&self) -> &Self::Target {
// There is no other option but to panic if this is None // There is no other option but to panic if this is None
self.sess_mgr.sessions[self.sess_idx].as_ref().unwrap() self.session()
} }
} }
impl<'a> DerefMut for SessionHandle<'a> { impl<'a> DerefMut for SessionHandle<'a> {
fn deref_mut(&mut self) -> &mut Self::Target { fn deref_mut(&mut self) -> &mut Self::Target {
// There is no other option but to panic if this is None // There is no other option but to panic if this is None
self.sess_mgr.sessions[self.sess_idx].as_mut().unwrap() self.session_mut()
} }
} }
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use crate::transport::network::Address; use crate::{
transport::network::Address,
utils::{epoch::dummy_epoch, rand::dummy_rand},
};
use super::SessionMgr; use super::SessionMgr;
#[test] #[test]
fn test_next_sess_id_doesnt_reuse() { fn test_next_sess_id_doesnt_reuse() {
let mut sm = SessionMgr::new(); let mut sm = SessionMgr::new(dummy_epoch, dummy_rand);
let sess_idx = sm.add(Address::default(), None).unwrap(); let sess_idx = sm.add(Address::default(), None).unwrap();
let mut sess = sm.get_session_handle(sess_idx); let mut sess = sm.get_session_handle(sess_idx);
sess.set_local_sess_id(1); sess.set_local_sess_id(1);
@ -615,7 +602,7 @@ mod tests {
#[test] #[test]
fn test_next_sess_id_overflows() { fn test_next_sess_id_overflows() {
let mut sm = SessionMgr::new(); let mut sm = SessionMgr::new(dummy_epoch, dummy_rand);
let sess_idx = sm.add(Address::default(), None).unwrap(); let sess_idx = sm.add(Address::default(), None).unwrap();
let mut sess = sm.get_session_handle(sess_idx); let mut sess = sm.get_session_handle(sess_idx);
sess.set_local_sess_id(1); sess.set_local_sess_id(1);

View file

@ -16,9 +16,10 @@
*/ */
use crate::error::*; use crate::error::*;
use log::info;
use smol::net::{Ipv6Addr, UdpSocket}; use smol::net::{Ipv6Addr, UdpSocket};
use super::network::{Address, NetworkInterface}; use super::network::Address;
// We could get rid of the smol here, but keeping it around in case we have to process // We could get rid of the smol here, but keeping it around in case we have to process
// any other events in this thread's context // any other events in this thread's context
@ -33,25 +34,26 @@ pub const MAX_RX_BUF_SIZE: usize = 1583;
pub const MATTER_PORT: u16 = 5540; pub const MATTER_PORT: u16 = 5540;
impl UdpListener { impl UdpListener {
pub fn new() -> Result<UdpListener, Error> { pub async fn new() -> Result<UdpListener, Error> {
Ok(UdpListener { Ok(UdpListener {
socket: smol::block_on(UdpSocket::bind((Ipv6Addr::UNSPECIFIED, MATTER_PORT)))?, socket: UdpSocket::bind((Ipv6Addr::UNSPECIFIED, MATTER_PORT)).await?,
}) })
} }
}
impl NetworkInterface for UdpListener { pub async fn recv(&self, in_buf: &mut [u8]) -> Result<(usize, Address), Error> {
fn recv(&self, in_buf: &mut [u8]) -> Result<(usize, Address), Error> { let (size, addr) = self.socket.recv_from(in_buf).await.map_err(|e| {
let (size, addr) = smol::block_on(self.socket.recv_from(in_buf)).map_err(|e| { info!("Error on the network: {:?}", e);
println!("Error on the network: {:?}", e);
Error::Network Error::Network
})?; })?;
Ok((size, Address::Udp(addr))) Ok((size, Address::Udp(addr)))
} }
fn send(&self, out_buf: &[u8], addr: Address) -> Result<usize, Error> { pub async fn send(&self, out_buf: &[u8], addr: Address) -> Result<usize, Error> {
match addr { match addr {
Address::Udp(addr) => Ok(smol::block_on(self.socket.send_to(out_buf, addr))?), Address::Udp(addr) => self.socket.send_to(out_buf, addr).await.map_err(|e| {
info!("Error on the network: {:?}", e);
Error::Network
}),
} }
} }
} }

14
matter/src/utils/epoch.rs Normal file
View file

@ -0,0 +1,14 @@
use core::time::Duration;
pub type Epoch = fn() -> Duration;
pub fn dummy_epoch() -> Duration {
Duration::from_secs(0)
}
#[cfg(feature = "std")]
pub fn sys_epoch() -> Duration {
std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap()
}

View file

@ -15,5 +15,7 @@
* limitations under the License. * limitations under the License.
*/ */
pub mod epoch;
pub mod parsebuf; pub mod parsebuf;
pub mod rand;
pub mod writebuf; pub mod writebuf;

View file

@ -25,11 +25,13 @@ pub struct ParseBuf<'a> {
} }
impl<'a> ParseBuf<'a> { impl<'a> ParseBuf<'a> {
pub fn new(buf: &'a mut [u8], len: usize) -> ParseBuf<'a> { pub fn new(buf: &'a mut [u8]) -> Self {
ParseBuf { let left = buf.len();
buf: &mut buf[..len],
Self {
buf,
read_off: 0, read_off: 0,
left: len, left,
} }
} }
@ -38,12 +40,17 @@ impl<'a> ParseBuf<'a> {
} }
// Return the data that is valid as a slice, consume self // Return the data that is valid as a slice, consume self
pub fn as_slice(self) -> &'a mut [u8] { pub fn into_slice(self) -> &'a mut [u8] {
&mut self.buf[self.read_off..(self.read_off + self.left)] &mut self.buf[self.read_off..(self.read_off + self.left)]
} }
// Return the data that is valid as a slice // Return the data that is valid as a slice
pub fn as_borrow_slice(&mut self) -> &mut [u8] { pub fn as_slice(&self) -> &[u8] {
&self.buf[self.read_off..(self.read_off + self.left)]
}
// Return the data that is valid as a slice
pub fn as_mut_slice(&mut self) -> &mut [u8] {
&mut self.buf[self.read_off..(self.read_off + self.left)] &mut self.buf[self.read_off..(self.read_off + self.left)]
} }
@ -101,19 +108,19 @@ mod tests {
#[test] #[test]
fn test_parse_with_success() { fn test_parse_with_success() {
let mut test_slice: [u8; 11] = [0x01, 65, 0, 0xbe, 0xba, 0xfe, 0xca, 0xa, 0xb, 0xc, 0xd]; let mut test_slice = [0x01, 65, 0, 0xbe, 0xba, 0xfe, 0xca, 0xa, 0xb, 0xc, 0xd];
let mut buf = ParseBuf::new(&mut test_slice, 11); let mut buf = ParseBuf::new(&mut test_slice);
assert_eq!(buf.le_u8().unwrap(), 0x01); assert_eq!(buf.le_u8().unwrap(), 0x01);
assert_eq!(buf.le_u16().unwrap(), 65); assert_eq!(buf.le_u16().unwrap(), 65);
assert_eq!(buf.le_u32().unwrap(), 0xcafebabe); assert_eq!(buf.le_u32().unwrap(), 0xcafebabe);
assert_eq!(buf.as_slice(), [0xa, 0xb, 0xc, 0xd]); assert_eq!(buf.into_slice(), [0xa, 0xb, 0xc, 0xd]);
} }
#[test] #[test]
fn test_parse_with_overrun() { fn test_parse_with_overrun() {
let mut test_slice: [u8; 2] = [0x01, 65]; let mut test_slice = [0x01, 65];
let mut buf = ParseBuf::new(&mut test_slice, 2); let mut buf = ParseBuf::new(&mut test_slice);
assert_eq!(buf.le_u8().unwrap(), 0x01); assert_eq!(buf.le_u8().unwrap(), 0x01);
@ -131,29 +138,29 @@ mod tests {
if buf.le_u8().is_ok() { if buf.le_u8().is_ok() {
panic!("This should have returned error") panic!("This should have returned error")
} }
assert_eq!(buf.as_slice(), []); assert_eq!(buf.into_slice(), []);
} }
#[test] #[test]
fn test_tail_with_success() { fn test_tail_with_success() {
let mut test_slice: [u8; 11] = [0x01, 65, 0, 0xbe, 0xba, 0xfe, 0xca, 0xa, 0xb, 0xc, 0xd]; let mut test_slice = [0x01, 65, 0, 0xbe, 0xba, 0xfe, 0xca, 0xa, 0xb, 0xc, 0xd];
let mut buf = ParseBuf::new(&mut test_slice, 11); let mut buf = ParseBuf::new(&mut test_slice);
assert_eq!(buf.le_u8().unwrap(), 0x01); assert_eq!(buf.le_u8().unwrap(), 0x01);
assert_eq!(buf.le_u16().unwrap(), 65); assert_eq!(buf.le_u16().unwrap(), 65);
assert_eq!(buf.le_u32().unwrap(), 0xcafebabe); assert_eq!(buf.le_u32().unwrap(), 0xcafebabe);
assert_eq!(buf.tail(2).unwrap(), [0xc, 0xd]); assert_eq!(buf.tail(2).unwrap(), [0xc, 0xd]);
assert_eq!(buf.as_borrow_slice(), [0xa, 0xb]); assert_eq!(buf.as_mut_slice(), [0xa, 0xb]);
assert_eq!(buf.tail(2).unwrap(), [0xa, 0xb]); assert_eq!(buf.tail(2).unwrap(), [0xa, 0xb]);
assert_eq!(buf.as_slice(), []); assert_eq!(buf.into_slice(), []);
} }
#[test] #[test]
fn test_tail_with_overrun() { fn test_tail_with_overrun() {
let mut test_slice: [u8; 11] = [0x01, 65, 0, 0xbe, 0xba, 0xfe, 0xca, 0xa, 0xb, 0xc, 0xd]; let mut test_slice = [0x01, 65, 0, 0xbe, 0xba, 0xfe, 0xca, 0xa, 0xb, 0xc, 0xd];
let mut buf = ParseBuf::new(&mut test_slice, 11); let mut buf = ParseBuf::new(&mut test_slice);
assert_eq!(buf.le_u8().unwrap(), 0x01); assert_eq!(buf.le_u8().unwrap(), 0x01);
assert_eq!(buf.le_u16().unwrap(), 65); assert_eq!(buf.le_u16().unwrap(), 65);
@ -166,8 +173,8 @@ mod tests {
#[test] #[test]
fn test_parsed_as_slice() { fn test_parsed_as_slice() {
let mut test_slice: [u8; 11] = [0x01, 65, 0, 0xbe, 0xba, 0xfe, 0xca, 0xa, 0xb, 0xc, 0xd]; let mut test_slice = [0x01, 65, 0, 0xbe, 0xba, 0xfe, 0xca, 0xa, 0xb, 0xc, 0xd];
let mut buf = ParseBuf::new(&mut test_slice, 11); let mut buf = ParseBuf::new(&mut test_slice);
assert_eq!(buf.parsed_as_slice(), []); assert_eq!(buf.parsed_as_slice(), []);
assert_eq!(buf.le_u8().unwrap(), 0x1); assert_eq!(buf.le_u8().unwrap(), 0x1);

3
matter/src/utils/rand.rs Normal file
View file

@ -0,0 +1,3 @@
pub type Rand = fn(&mut [u8]);
pub fn dummy_rand(_buf: &mut [u8]) {}

View file

@ -53,9 +53,9 @@ pub struct WriteBuf<'a> {
} }
impl<'a> WriteBuf<'a> { impl<'a> WriteBuf<'a> {
pub fn new(buf: &'a mut [u8], len: usize) -> WriteBuf<'a> { pub fn new(buf: &'a mut [u8]) -> Self {
WriteBuf { Self {
buf: &mut buf[..len], buf,
start: 0, start: 0,
end: 0, end: 0,
} }
@ -73,11 +73,11 @@ impl<'a> WriteBuf<'a> {
self.end += new_offset self.end += new_offset
} }
pub fn as_borrow_slice(&self) -> &[u8] { pub fn into_slice(self) -> &'a [u8] {
&self.buf[self.start..self.end] &self.buf[self.start..self.end]
} }
pub fn as_slice(self) -> &'a [u8] { pub fn as_slice(&self) -> &[u8] {
&self.buf[self.start..self.end] &self.buf[self.start..self.end]
} }
@ -201,9 +201,8 @@ mod tests {
#[test] #[test]
fn test_append_le_with_success() { fn test_append_le_with_success() {
let mut test_slice: [u8; 22] = [0; 22]; let mut test_slice = [0; 22];
let test_slice_len = test_slice.len(); let mut buf = WriteBuf::new(&mut test_slice);
let mut buf = WriteBuf::new(&mut test_slice, test_slice_len);
buf.reserve(5).unwrap(); buf.reserve(5).unwrap();
buf.le_u8(1).unwrap(); buf.le_u8(1).unwrap();
@ -222,8 +221,8 @@ mod tests {
#[test] #[test]
fn test_len_param() { fn test_len_param() {
let mut test_slice: [u8; 20] = [0; 20]; let mut test_slice = [0; 20];
let mut buf = WriteBuf::new(&mut test_slice, 5); let mut buf = WriteBuf::new(&mut test_slice[..5]);
buf.reserve(5).unwrap(); buf.reserve(5).unwrap();
let _ = buf.le_u8(1); let _ = buf.le_u8(1);
@ -236,8 +235,8 @@ mod tests {
#[test] #[test]
fn test_overrun() { fn test_overrun() {
let mut test_slice: [u8; 20] = [0; 20]; let mut test_slice = [0; 20];
let mut buf = WriteBuf::new(&mut test_slice, 20); let mut buf = WriteBuf::new(&mut test_slice);
buf.reserve(4).unwrap(); buf.reserve(4).unwrap();
buf.le_u64(0xcafebabecafebabe).unwrap(); buf.le_u64(0xcafebabecafebabe).unwrap();
buf.le_u64(0xcafebabecafebabe).unwrap(); buf.le_u64(0xcafebabecafebabe).unwrap();
@ -262,8 +261,8 @@ mod tests {
#[test] #[test]
fn test_as_slice() { fn test_as_slice() {
let mut test_slice: [u8; 20] = [0; 20]; let mut test_slice = [0; 20];
let mut buf = WriteBuf::new(&mut test_slice, 20); let mut buf = WriteBuf::new(&mut test_slice);
buf.reserve(5).unwrap(); buf.reserve(5).unwrap();
buf.le_u8(1).unwrap(); buf.le_u8(1).unwrap();
@ -275,7 +274,7 @@ mod tests {
buf.prepend(&new_slice).unwrap(); buf.prepend(&new_slice).unwrap();
assert_eq!( assert_eq!(
buf.as_slice(), buf.into_slice(),
[ [
0xa, 0xb, 0xc, 1, 65, 0, 0xbe, 0xba, 0xfe, 0xca, 0xbe, 0xba, 0xfe, 0xca, 0xbe, 0xa, 0xb, 0xc, 1, 65, 0, 0xbe, 0xba, 0xfe, 0xca, 0xbe, 0xba, 0xfe, 0xca, 0xbe,
0xba, 0xfe, 0xca 0xba, 0xfe, 0xca
@ -285,8 +284,8 @@ mod tests {
#[test] #[test]
fn test_copy_as_slice() { fn test_copy_as_slice() {
let mut test_slice: [u8; 20] = [0; 20]; let mut test_slice = [0; 20];
let mut buf = WriteBuf::new(&mut test_slice, 20); let mut buf = WriteBuf::new(&mut test_slice);
buf.reserve(5).unwrap(); buf.reserve(5).unwrap();
buf.le_u16(65).unwrap(); buf.le_u16(65).unwrap();
@ -301,8 +300,8 @@ mod tests {
#[test] #[test]
fn test_copy_as_slice_overrun() { fn test_copy_as_slice_overrun() {
let mut test_slice: [u8; 20] = [0; 20]; let mut test_slice = [0; 20];
let mut buf = WriteBuf::new(&mut test_slice, 7); let mut buf = WriteBuf::new(&mut test_slice[..7]);
buf.reserve(5).unwrap(); buf.reserve(5).unwrap();
buf.le_u16(65).unwrap(); buf.le_u16(65).unwrap();
@ -314,8 +313,8 @@ mod tests {
#[test] #[test]
fn test_prepend() { fn test_prepend() {
let mut test_slice: [u8; 20] = [0; 20]; let mut test_slice = [0; 20];
let mut buf = WriteBuf::new(&mut test_slice, 20); let mut buf = WriteBuf::new(&mut test_slice);
buf.reserve(5).unwrap(); buf.reserve(5).unwrap();
buf.le_u16(65).unwrap(); buf.le_u16(65).unwrap();
@ -329,8 +328,8 @@ mod tests {
#[test] #[test]
fn test_prepend_overrun() { fn test_prepend_overrun() {
let mut test_slice: [u8; 20] = [0; 20]; let mut test_slice = [0; 20];
let mut buf = WriteBuf::new(&mut test_slice, 20); let mut buf = WriteBuf::new(&mut test_slice);
buf.reserve(5).unwrap(); buf.reserve(5).unwrap();
buf.le_u16(65).unwrap(); buf.le_u16(65).unwrap();
@ -342,8 +341,8 @@ mod tests {
#[test] #[test]
fn test_rewind_tail() { fn test_rewind_tail() {
let mut test_slice: [u8; 20] = [0; 20]; let mut test_slice = [0; 20];
let mut buf = WriteBuf::new(&mut test_slice, 20); let mut buf = WriteBuf::new(&mut test_slice);
buf.reserve(5).unwrap(); buf.reserve(5).unwrap();
buf.le_u16(65).unwrap(); buf.le_u16(65).unwrap();
@ -352,13 +351,10 @@ mod tests {
let new_slice: [u8; 5] = [0xaa, 0xbb, 0xcc, 0xdd, 0xee]; let new_slice: [u8; 5] = [0xaa, 0xbb, 0xcc, 0xdd, 0xee];
buf.copy_from_slice(&new_slice).unwrap(); buf.copy_from_slice(&new_slice).unwrap();
assert_eq!( assert_eq!(buf.as_slice(), [65, 0, 0xaa, 0xbb, 0xcc, 0xdd, 0xee,]);
buf.as_borrow_slice(),
[65, 0, 0xaa, 0xbb, 0xcc, 0xdd, 0xee,]
);
buf.rewind_tail_to(anchor); buf.rewind_tail_to(anchor);
buf.le_u16(66).unwrap(); buf.le_u16(66).unwrap();
assert_eq!(buf.as_borrow_slice(), [65, 0, 66, 0,]); assert_eq!(buf.as_slice(), [65, 0, 66, 0,]);
} }
} }

View file

@ -115,8 +115,7 @@ impl TLVHolder {
buf: [0; 100], buf: [0; 100],
used_len: 0, used_len: 0,
}; };
let buf_len = s.buf.len(); let mut wb = WriteBuf::new(&mut s.buf);
let mut wb = WriteBuf::new(&mut s.buf, buf_len);
let mut tw = TLVWriter::new(&mut wb); let mut tw = TLVWriter::new(&mut wb);
let _ = tw.start_array(TagType::Context(ctx_tag)); let _ = tw.start_array(TagType::Context(ctx_tag));
for e in data { for e in data {

View file

@ -76,7 +76,7 @@ macro_rules! echo_req {
CmdPath::new( CmdPath::new(
Some($endpoint), Some($endpoint),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Commands::EchoReq as u16), Some(echo_cluster::Commands::EchoReq as u32),
), ),
EncodeValue::Value(&($data as u32)), EncodeValue::Value(&($data as u32)),
) )
@ -90,7 +90,7 @@ macro_rules! echo_resp {
CmdPath::new( CmdPath::new(
Some($endpoint), Some($endpoint),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Commands::EchoResp as u16), Some(echo_cluster::RespCommands::EchoResp as u32),
), ),
$data, $data,
) )

View file

@ -15,31 +15,91 @@
* limitations under the License. * limitations under the License.
*/ */
use std::sync::{Arc, Mutex, Once}; use std::{
convert::TryInto,
sync::{Arc, Mutex, Once},
};
use matter::{ use matter::{
attribute_enum, command_enum,
data_model::objects::{ data_model::objects::{
Access, AttrDetails, AttrValue, Attribute, Cluster, ClusterType, EncodeValue, Encoder, Access, AttrData, AttrDataEncoder, AttrDataWriter, AttrDetails, AttrType, Attribute,
Quality, Cluster, CmdDataEncoder, CmdDataWriter, CmdDetails, Dataver, Handler, Quality,
ATTRIBUTE_LIST, FEATURE_MAP,
}, },
error::Error, error::Error,
interaction_model::{ interaction_model::{
command::CommandReq, core::Transaction,
core::IMStatusCode, messages::ib::{attr_list_write, ListOperation},
messages::ib::{self, attr_list_write, ListOperation},
}, },
tlv::{TLVElement, TLVWriter, TagType, ToTLV}, tlv::{TLVElement, TagType},
utils::rand::Rand,
}; };
use num_derive::FromPrimitive; use num_derive::FromPrimitive;
use strum::{EnumDiscriminants, FromRepr};
pub const ID: u32 = 0xABCD; pub const ID: u32 = 0xABCD;
#[derive(FromPrimitive)] #[derive(FromRepr, EnumDiscriminants)]
#[repr(u16)]
pub enum Attributes {
Att1(AttrType<u16>) = 0,
Att2(AttrType<u16>) = 1,
AttWrite(AttrType<u16>) = 2,
AttCustom(AttrType<u32>) = 3,
AttWriteList(()) = 4,
}
attribute_enum!(Attributes);
#[derive(FromRepr)]
#[repr(u32)]
pub enum Commands { pub enum Commands {
EchoReq = 0x00, EchoReq = 0x00,
}
command_enum!(Commands);
#[derive(FromPrimitive)]
pub enum RespCommands {
EchoResp = 0x01, EchoResp = 0x01,
} }
pub const CLUSTER: Cluster<'static> = Cluster {
id: ID,
feature_map: 0,
attributes: &[
FEATURE_MAP,
ATTRIBUTE_LIST,
Attribute::new(
AttributesDiscriminants::Att1 as u16,
Access::RV,
Quality::NONE,
),
Attribute::new(
AttributesDiscriminants::Att2 as u16,
Access::RV,
Quality::NONE,
),
Attribute::new(
AttributesDiscriminants::AttWrite as u16,
Access::WRITE.union(Access::NEED_ADMIN),
Quality::NONE,
),
Attribute::new(
AttributesDiscriminants::AttCustom as u16,
Access::READ.union(Access::NEED_VIEW),
Quality::NONE,
),
Attribute::new(
AttributesDiscriminants::AttWriteList as u16,
Access::WRITE.union(Access::NEED_ADMIN),
Quality::NONE,
),
],
commands: &[Commands::EchoReq as _],
};
/// This is used in the tests to validate any settings that may have happened /// This is used in the tests to validate any settings that may have happened
/// to the custom data parts of the cluster /// to the custom data parts of the cluster
pub struct TestChecker { pub struct TestChecker {
@ -68,167 +128,122 @@ impl TestChecker {
} }
pub const WRITE_LIST_MAX: usize = 5; pub const WRITE_LIST_MAX: usize = 5;
pub struct EchoCluster { pub struct EchoCluster {
pub base: Cluster, pub data_ver: Dataver,
pub multiplier: u8, pub multiplier: u8,
} pub att1: u16,
pub att2: u16,
#[derive(FromPrimitive)] pub att_write: u16,
pub enum Attributes { pub att_custom: u32,
Att1 = 0,
Att2 = 1,
AttWrite = 2,
AttCustom = 3,
AttWriteList = 4,
}
pub const ATTR_CUSTOM_VALUE: u32 = 0xcafebeef;
pub const ATTR_WRITE_DEFAULT_VALUE: u16 = 0xcafe;
impl ClusterType for EchoCluster {
fn base(&self) -> &Cluster {
&self.base
}
fn base_mut(&mut self) -> &mut Cluster {
&mut self.base
}
fn read_custom_attribute(&self, encoder: &mut dyn Encoder, attr: &AttrDetails) {
match num::FromPrimitive::from_u16(attr.attr_id) {
Some(Attributes::AttCustom) => encoder.encode(EncodeValue::Closure(&|tag, tw| {
let _ = tw.u32(tag, ATTR_CUSTOM_VALUE);
})),
Some(Attributes::AttWriteList) => {
let tc_handle = TestChecker::get().unwrap();
let tc = tc_handle.lock().unwrap();
encoder.encode(EncodeValue::Closure(&|tag, tw| {
let _ = tw.start_array(tag);
for i in tc.write_list.iter().flatten() {
let _ = tw.u16(TagType::Anonymous, *i);
}
let _ = tw.end_container();
}))
}
_ => (),
}
}
fn write_attribute(
&mut self,
attr: &AttrDetails,
data: &TLVElement,
) -> Result<(), IMStatusCode> {
match num::FromPrimitive::from_u16(attr.attr_id) {
Some(Attributes::AttWriteList) => {
attr_list_write(attr, data, |op, data| self.write_attr_list(&op, data))
}
_ => self.base.write_attribute_from_tlv(attr.attr_id, data),
}
}
fn handle_command(&mut self, cmd_req: &mut CommandReq) -> Result<(), IMStatusCode> {
let cmd = cmd_req
.cmd
.path
.leaf
.map(num::FromPrimitive::from_u32)
.ok_or(IMStatusCode::UnsupportedCommand)?
.ok_or(IMStatusCode::UnsupportedCommand)?;
match cmd {
// This will generate an echo response on the same endpoint
// with data multiplied by the multiplier
Commands::EchoReq => {
let a = cmd_req.data.u8().unwrap();
let mut echo_response = cmd_req.cmd;
echo_response.path.leaf = Some(Commands::EchoResp as u32);
let cmd_data = |tag: TagType, t: &mut TLVWriter| {
let _ = t.start_struct(tag);
// Echo = input * self.multiplier
let _ = t.u8(TagType::Context(0), a * self.multiplier);
let _ = t.end_container();
};
let invoke_resp = ib::InvResp::Cmd(ib::CmdData::new(
echo_response,
EncodeValue::Closure(&cmd_data),
));
let _ = invoke_resp.to_tlv(cmd_req.resp, TagType::Anonymous);
cmd_req.trans.complete();
}
_ => {
return Err(IMStatusCode::UnsupportedCommand);
}
}
Ok(())
}
} }
impl EchoCluster { impl EchoCluster {
pub fn new(multiplier: u8) -> Result<Box<Self>, Error> { pub fn new(multiplier: u8, rand: Rand) -> Self {
let mut c = Box::new(Self { Self {
base: Cluster::new(ID)?, data_ver: Dataver::new(rand),
multiplier, multiplier,
}); att1: 0x1234,
c.base.add_attribute(Attribute::new( att2: 0x5678,
Attributes::Att1 as u16, att_write: ATTR_WRITE_DEFAULT_VALUE,
AttrValue::Uint16(0x1234), att_custom: ATTR_CUSTOM_VALUE,
Access::RV, }
Quality::NONE,
))?;
c.base.add_attribute(Attribute::new(
Attributes::Att2 as u16,
AttrValue::Uint16(0x5678),
Access::RV,
Quality::NONE,
))?;
c.base.add_attribute(Attribute::new(
Attributes::AttWrite as u16,
AttrValue::Uint16(ATTR_WRITE_DEFAULT_VALUE),
Access::WRITE | Access::NEED_ADMIN,
Quality::NONE,
))?;
c.base.add_attribute(Attribute::new(
Attributes::AttCustom as u16,
AttrValue::Custom,
Access::READ | Access::NEED_VIEW,
Quality::NONE,
))?;
c.base.add_attribute(Attribute::new(
Attributes::AttWriteList as u16,
AttrValue::Custom,
Access::WRITE | Access::NEED_ADMIN,
Quality::NONE,
))?;
Ok(c)
} }
fn write_attr_list( pub fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
if let Some(mut writer) = encoder.with_dataver(self.data_ver.get())? {
if attr.is_system() {
CLUSTER.read(attr.attr_id, writer)
} else {
match attr.attr_id.try_into()? {
Attributes::Att1(codec) => codec.encode(writer, 0x1234),
Attributes::Att2(codec) => codec.encode(writer, 0x5678),
Attributes::AttWrite(codec) => codec.encode(writer, ATTR_WRITE_DEFAULT_VALUE),
Attributes::AttCustom(codec) => codec.encode(writer, ATTR_CUSTOM_VALUE),
Attributes::AttWriteList(_) => {
let tc_handle = TestChecker::get().unwrap();
let tc = tc_handle.lock().unwrap();
writer.start_array(AttrDataWriter::TAG)?;
for i in tc.write_list.iter().flatten() {
writer.u16(TagType::Anonymous, *i)?;
}
writer.end_container()?;
writer.complete()
}
}
}
} else {
Ok(())
}
}
pub fn write(&mut self, attr: &AttrDetails, data: AttrData) -> Result<(), Error> {
let data = data.with_dataver(self.data_ver.get())?;
match attr.attr_id.try_into()? {
Attributes::Att1(codec) => self.att1 = codec.decode(data)?,
Attributes::Att2(codec) => self.att2 = codec.decode(data)?,
Attributes::AttWrite(codec) => self.att_write = codec.decode(data)?,
Attributes::AttCustom(codec) => self.att_custom = codec.decode(data)?,
Attributes::AttWriteList(_) => {
attr_list_write(attr, data, |op, data| self.write_attr_list(&op, data))?
}
}
self.data_ver.changed();
Ok(())
}
pub fn invoke(
&mut self, &mut self,
op: &ListOperation, _transaction: &mut Transaction,
cmd: &CmdDetails,
data: &TLVElement, data: &TLVElement,
) -> Result<(), IMStatusCode> { encoder: CmdDataEncoder,
) -> Result<(), Error> {
match cmd.cmd_id.try_into()? {
// This will generate an echo response on the same endpoint
// with data multiplied by the multiplier
Commands::EchoReq => {
let a = data.u8()?;
let mut writer = encoder.with_command(RespCommands::EchoResp as _)?;
writer.start_struct(CmdDataWriter::TAG)?;
// Echo = input * self.multiplier
writer.u8(TagType::Context(0), a * self.multiplier)?;
writer.end_container()?;
writer.complete()
}
}
}
fn write_attr_list(&mut self, op: &ListOperation, data: &TLVElement) -> Result<(), Error> {
let tc_handle = TestChecker::get().unwrap(); let tc_handle = TestChecker::get().unwrap();
let mut tc = tc_handle.lock().unwrap(); let mut tc = tc_handle.lock().unwrap();
match op { match op {
ListOperation::AddItem => { ListOperation::AddItem => {
let data = data.u16().map_err(|_| IMStatusCode::Failure)?; let data = data.u16()?;
for i in 0..WRITE_LIST_MAX { for i in 0..WRITE_LIST_MAX {
if tc.write_list[i].is_none() { if tc.write_list[i].is_none() {
tc.write_list[i] = Some(data); tc.write_list[i] = Some(data);
return Ok(()); return Ok(());
} }
} }
Err(IMStatusCode::ResourceExhausted)
Err(Error::ResourceExhausted)
} }
ListOperation::EditItem(index) => { ListOperation::EditItem(index) => {
let data = data.u16().map_err(|_| IMStatusCode::Failure)?; let data = data.u16()?;
if tc.write_list[*index as usize].is_some() { if tc.write_list[*index as usize].is_some() {
tc.write_list[*index as usize] = Some(data); tc.write_list[*index as usize] = Some(data);
Ok(()) Ok(())
} else { } else {
Err(IMStatusCode::InvalidAction) Err(Error::InvalidAction)
} }
} }
ListOperation::DeleteItem(index) => { ListOperation::DeleteItem(index) => {
@ -236,7 +251,7 @@ impl EchoCluster {
tc.write_list[*index as usize] = None; tc.write_list[*index as usize] = None;
Ok(()) Ok(())
} else { } else {
Err(IMStatusCode::InvalidAction) Err(Error::InvalidAction)
} }
} }
ListOperation::DeleteList => { ListOperation::DeleteList => {
@ -248,3 +263,26 @@ impl EchoCluster {
} }
} }
} }
pub const ATTR_CUSTOM_VALUE: u32 = 0xcafebeef;
pub const ATTR_WRITE_DEFAULT_VALUE: u16 = 0xcafe;
impl Handler for EchoCluster {
fn read(&self, attr: &AttrDetails, encoder: AttrDataEncoder) -> Result<(), Error> {
EchoCluster::read(self, attr, encoder)
}
fn write(&mut self, attr: &AttrDetails, data: AttrData) -> Result<(), Error> {
EchoCluster::write(self, attr, data)
}
fn invoke(
&mut self,
transaction: &mut Transaction,
cmd: &CmdDetails,
data: &TLVElement,
encoder: CmdDataEncoder,
) -> Result<(), Error> {
EchoCluster::invoke(self, transaction, cmd, data, encoder)
}
}

View file

@ -0,0 +1,317 @@
use core::time;
use std::thread;
use log::{info, warn};
use matter::{
interaction_model::{
core::{IMStatusCode, OpCode},
messages::{
ib::{AttrData, AttrPath, AttrResp, AttrStatus, CmdData, DataVersionFilter},
msg::{
self, InvReq, ReadReq, ReportDataMsg, StatusResp, TimedReq, WriteReq, WriteResp,
WriteRespTag,
},
},
},
tlv::{self, FromTLV, TLVArray, ToTLV},
transport::{
exchange::{self, Exchange},
session::NocCatIds,
},
Matter,
};
use super::{
attributes::assert_attr_report,
commands::{assert_inv_response, ExpectedInvResp},
im_engine::{ImEngine, ImInput, IM_ENGINE_PEER_ID},
};
pub enum WriteResponse<'a> {
TransactionError,
TransactionSuccess(&'a [AttrStatus]),
}
pub enum TimedInvResponse<'a> {
TransactionError(IMStatusCode),
TransactionSuccess(&'a [ExpectedInvResp]),
}
impl<'a> ImEngine<'a> {
// Helper for handling Read Req sequences for this file
pub fn handle_read_reqs(
&mut self,
peer_node_id: u64,
input: &[AttrPath],
expected: &[AttrResp],
) {
let mut out_buf = [0u8; 400];
let received = self.gen_read_reqs_output(peer_node_id, input, None, &mut out_buf);
assert_attr_report(&received, expected)
}
pub fn new_with_read_reqs(
matter: &'a Matter<'a>,
input: &[AttrPath],
expected: &[AttrResp],
) -> Self {
let mut im = Self::new(matter);
let mut out_buf = [0u8; 400];
let received = im.gen_read_reqs_output(IM_ENGINE_PEER_ID, input, None, &mut out_buf);
assert_attr_report(&received, expected);
im
}
pub fn gen_read_reqs_output<'b>(
&mut self,
peer_node_id: u64,
input: &[AttrPath],
dataver_filters: Option<TLVArray<'b, DataVersionFilter>>,
out_buf: &'b mut [u8],
) -> ReportDataMsg<'b> {
let mut read_req = ReadReq::new(true).set_attr_requests(input);
read_req.dataver_filters = dataver_filters;
let mut input = ImInput::new(OpCode::ReadRequest, &read_req);
input.set_peer_node_id(peer_node_id);
let (_, out_buf) = self.process(&input, out_buf);
tlv::print_tlv_list(out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
ReportDataMsg::from_tlv(&root).unwrap()
}
pub fn handle_write_reqs(
&mut self,
peer_node_id: u64,
peer_cat_ids: Option<&NocCatIds>,
input: &[AttrData],
expected: &[AttrStatus],
) {
let mut out_buf = [0u8; 400];
let write_req = WriteReq::new(false, input);
let mut input = ImInput::new(OpCode::WriteRequest, &write_req);
input.set_peer_node_id(peer_node_id);
if let Some(cat_ids) = peer_cat_ids {
input.set_cat_ids(cat_ids);
}
let (_, out_buf) = self.process(&input, &mut out_buf);
tlv::print_tlv_list(out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
let mut index = 0;
let response_iter = root
.find_tag(WriteRespTag::WriteResponses as u32)
.unwrap()
.confirm_array()
.unwrap()
.enter()
.unwrap();
for response in response_iter {
info!("Validating index {}", index);
let status = AttrStatus::from_tlv(&response).unwrap();
assert_eq!(expected[index], status);
info!("Index {} success", index);
index += 1;
}
assert_eq!(index, expected.len());
}
pub fn new_with_write_reqs(
matter: &'a Matter<'a>,
input: &[AttrData],
expected: &[AttrStatus],
) -> Self {
let mut im = Self::new(matter);
im.handle_write_reqs(IM_ENGINE_PEER_ID, None, input, expected);
im
}
// Helper for handling Invoke Command sequences
pub fn handle_commands(
&mut self,
peer_node_id: u64,
input: &[CmdData],
expected: &[ExpectedInvResp],
) {
let mut out_buf = [0u8; 400];
let req = InvReq {
suppress_response: Some(false),
timed_request: Some(false),
inv_requests: Some(TLVArray::Slice(input)),
};
let mut input = ImInput::new(OpCode::InvokeRequest, &req);
input.set_peer_node_id(peer_node_id);
let (_, out_buf) = self.process(&input, &mut out_buf);
tlv::print_tlv_list(out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
let resp = msg::InvResp::from_tlv(&root).unwrap();
assert_inv_response(&resp, expected)
}
pub fn new_with_commands(
matter: &'a Matter<'a>,
input: &[CmdData],
expected: &[ExpectedInvResp],
) -> Self {
let mut im = ImEngine::new(matter);
im.handle_commands(IM_ENGINE_PEER_ID, input, expected);
im
}
fn handle_timed_reqs<'b>(
&mut self,
opcode: OpCode,
request: &dyn ToTLV,
timeout: u16,
delay: u16,
output: &'b mut [u8],
) -> (u8, &'b [u8]) {
// Use the same exchange for all parts of the transaction
self.exch = Some(Exchange::new(1, 0, exchange::Role::Responder));
if timeout != 0 {
// Send Timed Req
let mut tmp_buf = [0u8; 400];
let timed_req = TimedReq { timeout };
let im_input = ImInput::new(OpCode::TimedRequest, &timed_req);
let (_, out_buf) = self.process(&im_input, &mut tmp_buf);
tlv::print_tlv_list(out_buf);
} else {
warn!("Skipping timed request");
}
// Process any delays
let delay = time::Duration::from_millis(delay.into());
thread::sleep(delay);
// Send Write Req
let input = ImInput::new(opcode, request);
let (resp_opcode, output) = self.process(&input, output);
(resp_opcode, output)
}
// Helper for handling Write Attribute sequences
pub fn handle_timed_write_reqs(
&mut self,
input: &[AttrData],
expected: &WriteResponse,
timeout: u16,
delay: u16,
) {
let mut out_buf = [0u8; 400];
let write_req = WriteReq::new(false, input);
let (resp_opcode, out_buf) = self.handle_timed_reqs(
OpCode::WriteRequest,
&write_req,
timeout,
delay,
&mut out_buf,
);
tlv::print_tlv_list(out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
match expected {
WriteResponse::TransactionSuccess(t) => {
assert_eq!(
num::FromPrimitive::from_u8(resp_opcode),
Some(OpCode::WriteResponse)
);
let resp = WriteResp::from_tlv(&root).unwrap();
assert_eq!(resp.write_responses, t);
}
WriteResponse::TransactionError => {
assert_eq!(
num::FromPrimitive::from_u8(resp_opcode),
Some(OpCode::StatusResponse)
);
let status_resp = StatusResp::from_tlv(&root).unwrap();
assert_eq!(status_resp.status, IMStatusCode::Timeout);
}
}
}
pub fn new_with_timed_write_reqs(
matter: &'a Matter<'a>,
input: &[AttrData],
expected: &WriteResponse,
timeout: u16,
delay: u16,
) -> Self {
let mut im = ImEngine::new(matter);
im.handle_timed_write_reqs(input, expected, timeout, delay);
im
}
// Helper for handling Invoke Command sequences
pub fn handle_timed_commands(
&mut self,
input: &[CmdData],
expected: &TimedInvResponse,
timeout: u16,
delay: u16,
set_timed_request: bool,
) {
let mut out_buf = [0u8; 400];
let req = InvReq {
suppress_response: Some(false),
timed_request: Some(set_timed_request),
inv_requests: Some(TLVArray::Slice(input)),
};
let (resp_opcode, out_buf) =
self.handle_timed_reqs(OpCode::InvokeRequest, &req, timeout, delay, &mut out_buf);
tlv::print_tlv_list(out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
match expected {
TimedInvResponse::TransactionSuccess(t) => {
assert_eq!(
num::FromPrimitive::from_u8(resp_opcode),
Some(OpCode::InvokeResponse)
);
let resp = msg::InvResp::from_tlv(&root).unwrap();
assert_inv_response(&resp, t)
}
TimedInvResponse::TransactionError(e) => {
assert_eq!(
num::FromPrimitive::from_u8(resp_opcode),
Some(OpCode::StatusResponse)
);
let status_resp = StatusResp::from_tlv(&root).unwrap();
assert_eq!(status_resp.status, *e);
}
}
}
pub fn new_with_timed_commands(
matter: &'a Matter<'a>,
input: &[CmdData],
expected: &TimedInvResponse,
timeout: u16,
delay: u16,
set_timed_request: bool,
) -> Self {
let mut im = ImEngine::new(matter);
im.handle_timed_commands(input, expected, timeout, delay, set_timed_request);
im
}
}

View file

@ -16,54 +16,60 @@
*/ */
use crate::common::echo_cluster; use crate::common::echo_cluster;
use boxslab::Slab; use core::borrow::Borrow;
use matter::{ use matter::{
acl::{AclEntry, AclMgr, AuthMode}, acl::{AclEntry, AuthMode},
data_model::{ data_model::{
cluster_basic_information::BasicInfoConfig, cluster_basic_information::{self, BasicInfoConfig},
cluster_on_off::{self, OnOffCluster},
core::DataModel, core::DataModel,
device_types::device_type_add_on_off_light, device_types::{DEV_TYPE_ON_OFF_LIGHT, DEV_TYPE_ROOT_NODE},
objects::Privilege, objects::{ChainedHandler, Endpoint, Node, Privilege},
sdm::dev_att::{DataType, DevAttDataFetcher}, root_endpoint::{self, RootEndpointHandler},
sdm::{
admin_commissioning,
dev_att::{DataType, DevAttDataFetcher},
general_commissioning, noc, nw_commissioning,
},
system_model::access_control,
}, },
error::Error, error::Error,
fabric::FabricMgr, interaction_model::core::{InteractionModel, OpCode},
interaction_model::{core::OpCode, InteractionModel}, mdns::Mdns,
secure_channel::pake::PaseMgr,
tlv::{TLVWriter, TagType, ToTLV}, tlv::{TLVWriter, TagType, ToTLV},
transport::packet::Packet, transport::packet::Packet,
transport::{ transport::{
exchange::{self, Exchange, ExchangeCtx}, exchange::{self, Exchange, ExchangeCtx},
network::Address, network::Address,
packet::PacketPool, proto_ctx::ProtoCtx,
proto_demux::ProtoCtx, session::{CaseDetails, CloneData, NocCatIds, SessionMgr, SessionMode},
session::{CloneData, NocCatIds, SessionMgr, SessionMode},
}, },
transport::{proto_demux::HandleProto, session::CaseDetails}, utils::{epoch::sys_epoch, rand::dummy_rand, writebuf::WriteBuf},
utils::writebuf::WriteBuf, Matter,
}; };
use std::{ use std::net::{Ipv4Addr, SocketAddr};
net::{Ipv4Addr, SocketAddr},
sync::Arc, use super::echo_cluster::EchoCluster;
const BASIC_INFO: BasicInfoConfig<'static> = BasicInfoConfig {
vid: 10,
pid: 11,
hw_ver: 12,
sw_ver: 13,
sw_ver_str: "13",
serial_no: "aabbccdd",
device_name: "Test Device",
}; };
pub struct DummyDevAtt {} pub struct DummyDevAtt {}
impl DevAttDataFetcher for DummyDevAtt { impl DevAttDataFetcher for DummyDevAtt {
fn get_devatt_data(&self, _data_type: DataType, _data: &mut [u8]) -> Result<usize, Error> { fn get_devatt_data(&self, _data_type: DataType, _data: &mut [u8]) -> Result<usize, Error> {
Ok(2) Ok(2)
} }
} }
/// An Interaction Model Engine to facilitate easy testing pub const IM_ENGINE_PEER_ID: u64 = 445566;
pub struct ImEngine {
pub dm: DataModel,
pub acl_mgr: Arc<AclMgr>,
pub im: Box<InteractionModel>,
// By default, a new exchange is created for every run, if you wish to instead using a specific
// exchange, set this variable. This is helpful in situations where you have to run multiple
// actions in the same transaction (exchange)
pub exch: Option<Exchange>,
}
pub struct ImInput<'a> { pub struct ImInput<'a> {
action: OpCode, action: OpCode,
@ -72,7 +78,6 @@ pub struct ImInput<'a> {
cat_ids: NocCatIds, cat_ids: NocCatIds,
} }
pub const IM_ENGINE_PEER_ID: u64 = 445566;
impl<'a> ImInput<'a> { impl<'a> ImInput<'a> {
pub fn new(action: OpCode, data: &'a dyn ToTLV) -> Self { pub fn new(action: OpCode, data: &'a dyn ToTLV) -> Self {
Self { Self {
@ -92,56 +97,86 @@ impl<'a> ImInput<'a> {
} }
} }
impl ImEngine { pub type DmHandler<'a> = ChainedHandler<
/// Create the interaction model engine OnOffCluster,
pub fn new() -> Self { ChainedHandler<EchoCluster, ChainedHandler<EchoCluster, RootEndpointHandler<'a>>>,
let dev_det = BasicInfoConfig { >;
vid: 10,
pid: 11,
hw_ver: 12,
sw_ver: 13,
sw_ver_str: "13".to_string(),
serial_no: "aabbccdd".to_string(),
device_name: "Test Device".to_string(),
};
let dev_att = Box::new(DummyDevAtt {}); pub fn matter<'a>(mdns: &'a mut dyn Mdns) -> Matter<'_> {
let fabric_mgr = Arc::new(FabricMgr::new().unwrap()); Matter::new(&BASIC_INFO, mdns, sys_epoch, dummy_rand)
let acl_mgr = Arc::new(AclMgr::new_with(false).unwrap()); }
let pase_mgr = PaseMgr::new();
acl_mgr.erase_all(); /// An Interaction Model Engine to facilitate easy testing
pub struct ImEngine<'a> {
pub matter: &'a Matter<'a>,
pub im: InteractionModel<DataModel<'a, DmHandler<'a>>>,
// By default, a new exchange is created for every run, if you wish to instead using a specific
// exchange, set this variable. This is helpful in situations where you have to run multiple
// actions in the same transaction (exchange)
pub exch: Option<Exchange>,
}
impl<'a> ImEngine<'a> {
/// Create the interaction model engine
pub fn new(matter: &'a Matter<'a>) -> Self {
let mut default_acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case); let mut default_acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case);
// Only allow the standard peer node id of the IM Engine // Only allow the standard peer node id of the IM Engine
default_acl.add_subject(IM_ENGINE_PEER_ID).unwrap(); default_acl.add_subject(IM_ENGINE_PEER_ID).unwrap();
acl_mgr.add(default_acl).unwrap(); matter.acl_mgr.borrow_mut().add(default_acl).unwrap();
let dm = DataModel::new(dev_det, dev_att, fabric_mgr, acl_mgr.clone(), pase_mgr).unwrap();
{ let dm = DataModel::new(
let mut d = dm.node.write().unwrap(); matter.borrow(),
let light_endpoint = device_type_add_on_off_light(&mut d).unwrap(); &Node {
d.add_cluster(0, echo_cluster::EchoCluster::new(2).unwrap()) id: 0,
.unwrap(); endpoints: &[
d.add_cluster(light_endpoint, echo_cluster::EchoCluster::new(3).unwrap()) Endpoint {
.unwrap(); id: 0,
} clusters: &[
cluster_basic_information::CLUSTER,
let im = Box::new(InteractionModel::new(Box::new(dm.clone()))); general_commissioning::CLUSTER,
nw_commissioning::CLUSTER,
admin_commissioning::CLUSTER,
noc::CLUSTER,
access_control::CLUSTER,
echo_cluster::CLUSTER,
],
device_type: DEV_TYPE_ROOT_NODE,
},
Endpoint {
id: 1,
clusters: &[echo_cluster::CLUSTER, cluster_on_off::CLUSTER],
device_type: DEV_TYPE_ON_OFF_LIGHT,
},
],
},
root_endpoint::handler(0, &DummyDevAtt {}, matter)
.chain(0, echo_cluster::ID, EchoCluster::new(2, *matter.borrow()))
.chain(1, echo_cluster::ID, EchoCluster::new(3, *matter.borrow()))
.chain(1, cluster_on_off::ID, OnOffCluster::new(*matter.borrow())),
);
Self { Self {
dm, matter,
acl_mgr, im: InteractionModel(dm),
im,
exch: None, exch: None,
} }
} }
pub fn echo_cluster(&self, endpoint: u16) -> &EchoCluster {
match endpoint {
0 => &self.im.0.handler.next.next.handler,
1 => &self.im.0.handler.next.handler,
_ => panic!(),
}
}
/// Run a transaction through the interaction model engine /// Run a transaction through the interaction model engine
pub fn process<'a>(&mut self, input: &ImInput, data_out: &'a mut [u8]) -> (u8, &'a mut [u8]) { pub fn process<'b>(&mut self, input: &ImInput, data_out: &'b mut [u8]) -> (u8, &'b [u8]) {
let mut new_exch = Exchange::new(1, 0, exchange::Role::Responder); let mut new_exch = Exchange::new(1, 0, exchange::Role::Responder);
// Choose whether to use a new exchange, or use the one from the ImEngine configuration // Choose whether to use a new exchange, or use the one from the ImEngine configuration
let exch = self.exch.as_mut().unwrap_or(&mut new_exch); let exch = self.exch.as_mut().unwrap_or(&mut new_exch);
let mut sess_mgr: SessionMgr = Default::default(); let mut sess_mgr = SessionMgr::new(*self.matter.borrow(), *self.matter.borrow());
let clone_data = CloneData::new( let clone_data = CloneData::new(
123456, 123456,
@ -156,9 +191,15 @@ impl ImEngine {
); );
let sess_idx = sess_mgr.clone_session(&clone_data).unwrap(); let sess_idx = sess_mgr.clone_session(&clone_data).unwrap();
let sess = sess_mgr.get_session_handle(sess_idx); let sess = sess_mgr.get_session_handle(sess_idx);
let exch_ctx = ExchangeCtx { exch, sess }; let exch_ctx = ExchangeCtx {
let mut rx = Slab::<PacketPool>::try_new(Packet::new_rx().unwrap()).unwrap(); exch,
let tx = Slab::<PacketPool>::try_new(Packet::new_tx().unwrap()).unwrap(); sess,
epoch: *self.matter.borrow(),
};
let mut tx_buf = [0; 1500];
let mut rx_buf = [0; 1500];
let mut rx = Packet::new_rx(&mut rx_buf);
let mut tx = Packet::new_tx(&mut tx_buf);
// Create fake rx packet // Create fake rx packet
rx.set_proto_id(0x01); rx.set_proto_id(0x01);
rx.set_proto_opcode(input.action as u8); rx.set_proto_opcode(input.action as u8);
@ -166,36 +207,37 @@ impl ImEngine {
{ {
let mut buf = [0u8; 400]; let mut buf = [0u8; 400];
let buf_len = buf.len(); let mut wb = WriteBuf::new(&mut buf);
let mut wb = WriteBuf::new(&mut buf, buf_len);
let mut tw = TLVWriter::new(&mut wb); let mut tw = TLVWriter::new(&mut wb);
input.data.to_tlv(&mut tw, TagType::Anonymous).unwrap(); input.data.to_tlv(&mut tw, TagType::Anonymous).unwrap();
let input_data = wb.as_borrow_slice(); let input_data = wb.as_slice();
let in_data_len = input_data.len(); let in_data_len = input_data.len();
let rx_buf = rx.as_borrow_slice(); let rx_buf = rx.as_mut_slice();
rx_buf[..in_data_len].copy_from_slice(input_data); rx_buf[..in_data_len].copy_from_slice(input_data);
rx.get_parsebuf().unwrap().set_len(in_data_len); rx.get_parsebuf().unwrap().set_len(in_data_len);
} }
let mut ctx = ProtoCtx::new(exch_ctx, rx, tx); let mut ctx = ProtoCtx::new(exch_ctx, &rx, &mut tx);
self.im.handle_proto_id(&mut ctx).unwrap(); self.im.handle(&mut ctx).unwrap();
let out_data_len = ctx.tx.as_borrow_slice().len(); let out_data_len = ctx.tx.as_slice().len();
data_out[..out_data_len].copy_from_slice(ctx.tx.as_borrow_slice()); data_out[..out_data_len].copy_from_slice(ctx.tx.as_slice());
let response = ctx.tx.get_proto_opcode(); let response = ctx.tx.get_proto_opcode();
(response, &mut data_out[..out_data_len]) (response, &data_out[..out_data_len])
} }
} }
// Create an Interaction Model, Data Model and run a rx/tx transaction through it // TODO - Remove?
pub fn im_engine<'a>( // // Create an Interaction Model, Data Model and run a rx/tx transaction through it
action: OpCode, // pub fn im_engine<'a>(
data: &dyn ToTLV, // matter: &'a Matter,
data_out: &'a mut [u8], // action: OpCode,
) -> (DataModel, u8, &'a mut [u8]) { // data: &dyn ToTLV,
let mut engine = ImEngine::new(); // data_out: &'a mut [u8],
let input = ImInput::new(action, data); // ) -> (DmHandler<'a>, u8, &'a mut [u8]) {
let (response, output) = engine.process(&input, data_out); // let mut engine = ImEngine::new(matter);
(engine.dm, response, output) // let input = ImInput::new(action, data);
} // let (response, output) = engine.process(&input, data_out);
// (engine.dm.handler, response, output)
// }

View file

@ -18,4 +18,5 @@
pub mod attributes; pub mod attributes;
pub mod commands; pub mod commands;
pub mod echo_cluster; pub mod echo_cluster;
pub mod handlers;
pub mod im_engine; pub mod im_engine;

View file

@ -18,19 +18,16 @@
use matter::{ use matter::{
acl::{gen_noc_cat, AclEntry, AuthMode, Target}, acl::{gen_noc_cat, AclEntry, AuthMode, Target},
data_model::{ data_model::{
objects::{AttrValue, EncodeValue, Privilege}, objects::{EncodeValue, Privilege},
system_model::access_control, system_model::access_control,
}, },
interaction_model::{ interaction_model::{
core::{IMStatusCode, OpCode}, core::IMStatusCode,
messages::{ messages::ib::{AttrData, AttrPath, AttrResp, AttrStatus, ClusterPath, DataVersionFilter},
ib::{AttrData, AttrPath, AttrResp, AttrStatus, ClusterPath, DataVersionFilter}, messages::GenericPath,
msg::{ReadReq, ReportDataMsg, WriteReq},
}, },
messages::{msg, GenericPath}, mdns::DummyMdns,
}, tlv::{ElementType, TLVArray, TLVElement, TLVWriter, TagType},
tlv::{self, ElementType, FromTLV, TLVArray, TLVElement, TLVWriter, TagType},
transport::session::NocCatIds,
}; };
use crate::{ use crate::{
@ -38,81 +35,10 @@ use crate::{
common::{ common::{
attributes::*, attributes::*,
echo_cluster::{self, ATTR_WRITE_DEFAULT_VALUE}, echo_cluster::{self, ATTR_WRITE_DEFAULT_VALUE},
im_engine::{ImEngine, ImInput}, im_engine::{matter, ImEngine},
}, },
}; };
// Helper for handling Read Req sequences for this file
fn handle_read_reqs(
im: &mut ImEngine,
peer_node_id: u64,
input: &[AttrPath],
expected: &[AttrResp],
) {
let mut out_buf = [0u8; 400];
let received = gen_read_reqs_output(im, peer_node_id, input, None, &mut out_buf);
assert_attr_report(&received, expected)
}
fn gen_read_reqs_output<'a>(
im: &mut ImEngine,
peer_node_id: u64,
input: &[AttrPath],
dataver_filters: Option<TLVArray<'a, DataVersionFilter>>,
out_buf: &'a mut [u8],
) -> ReportDataMsg<'a> {
let mut read_req = ReadReq::new(true).set_attr_requests(input);
read_req.dataver_filters = dataver_filters;
let mut input = ImInput::new(OpCode::ReadRequest, &read_req);
input.set_peer_node_id(peer_node_id);
let (_, out_buf) = im.process(&input, out_buf);
tlv::print_tlv_list(out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
ReportDataMsg::from_tlv(&root).unwrap()
}
// Helper for handling Write Attribute sequences
fn handle_write_reqs(
im: &mut ImEngine,
peer_node_id: u64,
peer_cat_ids: Option<&NocCatIds>,
input: &[AttrData],
expected: &[AttrStatus],
) {
let mut out_buf = [0u8; 400];
let write_req = WriteReq::new(false, input);
let mut input = ImInput::new(OpCode::WriteRequest, &write_req);
input.set_peer_node_id(peer_node_id);
if let Some(cat_ids) = peer_cat_ids {
input.set_cat_ids(cat_ids);
}
let (_, out_buf) = im.process(&input, &mut out_buf);
tlv::print_tlv_list(out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
let mut index = 0;
let response_iter = root
.find_tag(msg::WriteRespTag::WriteResponses as u32)
.unwrap()
.confirm_array()
.unwrap()
.enter()
.unwrap();
for response in response_iter {
println!("Validating index {}", index);
let status = AttrStatus::from_tlv(&response).unwrap();
assert_eq!(expected[index], status);
println!("Index {} success", index);
index += 1;
}
assert_eq!(index, expected.len());
}
#[test] #[test]
/// Ensure that wildcard read attributes don't include error response /// Ensure that wildcard read attributes don't include error response
/// and silently drop the data when access is not granted /// and silently drop the data when access is not granted
@ -122,43 +48,45 @@ fn wc_read_attribute() {
let wc_att1 = GenericPath::new( let wc_att1 = GenericPath::new(
None, None,
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let ep0_att1 = GenericPath::new( let ep0_att1 = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let ep1_att1 = GenericPath::new( let ep1_att1 = GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let peer = 98765; let peer = 98765;
let mut im = ImEngine::new(); let mut mdns = DummyMdns {};
let matter = matter(&mut mdns);
let mut im = ImEngine::new(&matter);
// Test1: Empty Response as no ACL matches // Test1: Empty Response as no ACL matches
let input = &[AttrPath::new(&wc_att1)]; let input = &[AttrPath::new(&wc_att1)];
let expected = &[]; let expected = &[];
handle_read_reqs(&mut im, peer, input, expected); im.handle_read_reqs(peer, input, expected);
// Add ACL to allow our peer to only access endpoint 0 // Add ACL to allow our peer to only access endpoint 0
let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case); let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case);
acl.add_subject(peer).unwrap(); acl.add_subject(peer).unwrap();
acl.add_target(Target::new(Some(0), None, None)).unwrap(); acl.add_target(Target::new(Some(0), None, None)).unwrap();
im.acl_mgr.add(acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(acl).unwrap();
// Test2: Only Single response as only single endpoint is allowed // Test2: Only Single response as only single endpoint is allowed
let input = &[AttrPath::new(&wc_att1)]; let input = &[AttrPath::new(&wc_att1)];
let expected = &[attr_data_path!(ep0_att1, ElementType::U16(0x1234))]; let expected = &[attr_data_path!(ep0_att1, ElementType::U16(0x1234))];
handle_read_reqs(&mut im, peer, input, expected); im.handle_read_reqs(peer, input, expected);
// Add ACL to allow our peer to only access endpoint 1 // Add ACL to allow our peer to also access endpoint 1
let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case); let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case);
acl.add_subject(peer).unwrap(); acl.add_subject(peer).unwrap();
acl.add_target(Target::new(Some(1), None, None)).unwrap(); acl.add_target(Target::new(Some(1), None, None)).unwrap();
im.acl_mgr.add(acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(acl).unwrap();
// Test3: Both responses are valid // Test3: Both responses are valid
let input = &[AttrPath::new(&wc_att1)]; let input = &[AttrPath::new(&wc_att1)];
@ -166,7 +94,7 @@ fn wc_read_attribute() {
attr_data_path!(ep0_att1, ElementType::U16(0x1234)), attr_data_path!(ep0_att1, ElementType::U16(0x1234)),
attr_data_path!(ep1_att1, ElementType::U16(0x1234)), attr_data_path!(ep1_att1, ElementType::U16(0x1234)),
]; ];
handle_read_reqs(&mut im, peer, input, expected); im.handle_read_reqs(peer, input, expected);
} }
#[test] #[test]
@ -178,48 +106,33 @@ fn exact_read_attribute() {
let wc_att1 = GenericPath::new( let wc_att1 = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let ep0_att1 = GenericPath::new( let ep0_att1 = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let peer = 98765; let peer = 98765;
let mut im = ImEngine::new(); let mut mdns = DummyMdns {};
let matter = matter(&mut mdns);
let mut im = ImEngine::new(&matter);
// Test1: Unsupported Access error as no ACL matches // Test1: Unsupported Access error as no ACL matches
let input = &[AttrPath::new(&wc_att1)]; let input = &[AttrPath::new(&wc_att1)];
let expected = &[attr_status!(&ep0_att1, IMStatusCode::UnsupportedAccess)]; let expected = &[attr_status!(&ep0_att1, IMStatusCode::UnsupportedAccess)];
handle_read_reqs(&mut im, peer, input, expected); im.handle_read_reqs(peer, input, expected);
// Add ACL to allow our peer to access any endpoint // Add ACL to allow our peer to access any endpoint
let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case); let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case);
acl.add_subject(peer).unwrap(); acl.add_subject(peer).unwrap();
im.acl_mgr.add(acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(acl).unwrap();
// Test2: Only Single response as only single endpoint is allowed // Test2: Only Single response as only single endpoint is allowed
let input = &[AttrPath::new(&wc_att1)]; let input = &[AttrPath::new(&wc_att1)];
let expected = &[attr_data_path!(ep0_att1, ElementType::U16(0x1234))]; let expected = &[attr_data_path!(ep0_att1, ElementType::U16(0x1234))];
handle_read_reqs(&mut im, peer, input, expected); im.handle_read_reqs(peer, input, expected);
}
fn read_cluster_id_write_attr(im: &ImEngine, endpoint: u16) -> AttrValue {
let node = im.dm.node.read().unwrap();
let echo = node.get_cluster(endpoint, echo_cluster::ID).unwrap();
echo.base()
.read_attribute_raw(echo_cluster::Attributes::AttWrite as u16)
.unwrap()
.clone()
}
fn read_cluster_id_data_ver(im: &ImEngine, endpoint: u16) -> u32 {
let node = im.dm.node.read().unwrap();
let echo = node.get_cluster(endpoint, echo_cluster::ID).unwrap();
echo.base().get_dataver()
} }
#[test] #[test]
@ -239,17 +152,17 @@ fn wc_write_attribute() {
let wc_att = GenericPath::new( let wc_att = GenericPath::new(
None, None,
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let ep0_att = GenericPath::new( let ep0_att = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let ep1_att = GenericPath::new( let ep1_att = GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let input0 = &[AttrData::new( let input0 = &[AttrData::new(
@ -264,54 +177,41 @@ fn wc_write_attribute() {
)]; )];
let peer = 98765; let peer = 98765;
let mut im = ImEngine::new(); let mut mdns = DummyMdns {};
let matter = matter(&mut mdns);
let mut im = ImEngine::new(&matter);
// Test 1: Wildcard write to an attribute without permission should return // Test 1: Wildcard write to an attribute without permission should return
// no error // no error
handle_write_reqs(&mut im, peer, None, input0, &[]); im.handle_write_reqs(peer, None, input0, &[]);
{ assert_eq!(ATTR_WRITE_DEFAULT_VALUE, im.echo_cluster(0).att_write);
let node = im.dm.node.read().unwrap();
let echo = node.get_cluster(0, echo_cluster::ID).unwrap();
assert_eq!(
AttrValue::Uint16(ATTR_WRITE_DEFAULT_VALUE),
*echo
.base()
.read_attribute_raw(echo_cluster::Attributes::AttWrite as u16)
.unwrap()
);
}
// Add ACL to allow our peer to access one endpoint // Add ACL to allow our peer to access one endpoint
let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case); let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case);
acl.add_subject(peer).unwrap(); acl.add_subject(peer).unwrap();
acl.add_target(Target::new(Some(0), None, None)).unwrap(); acl.add_target(Target::new(Some(0), None, None)).unwrap();
im.acl_mgr.add(acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(acl).unwrap();
// Test 2: Wildcard write to attributes will only return attributes // Test 2: Wildcard write to attributes will only return attributes
// where the writes were successful // where the writes were successful
handle_write_reqs( im.handle_write_reqs(
&mut im,
peer, peer,
None, None,
input0, input0,
&[AttrStatus::new(&ep0_att, IMStatusCode::Success, 0)], &[AttrStatus::new(&ep0_att, IMStatusCode::Success, 0)],
); );
assert_eq!(AttrValue::Uint16(val0), read_cluster_id_write_attr(&im, 0)); assert_eq!(val0, im.echo_cluster(0).att_write);
assert_eq!( assert_eq!(ATTR_WRITE_DEFAULT_VALUE, im.echo_cluster(1).att_write);
AttrValue::Uint16(ATTR_WRITE_DEFAULT_VALUE),
read_cluster_id_write_attr(&im, 1)
);
// Add ACL to allow our peer to access another endpoint // Add ACL to allow our peer to access another endpoint
let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case); let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case);
acl.add_subject(peer).unwrap(); acl.add_subject(peer).unwrap();
acl.add_target(Target::new(Some(1), None, None)).unwrap(); acl.add_target(Target::new(Some(1), None, None)).unwrap();
im.acl_mgr.add(acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(acl).unwrap();
// Test 3: Wildcard write to attributes will return multiple attributes // Test 3: Wildcard write to attributes will return multiple attributes
// where the writes were successful // where the writes were successful
handle_write_reqs( im.handle_write_reqs(
&mut im,
peer, peer,
None, None,
input1, input1,
@ -320,8 +220,8 @@ fn wc_write_attribute() {
AttrStatus::new(&ep1_att, IMStatusCode::Success, 0), AttrStatus::new(&ep1_att, IMStatusCode::Success, 0),
], ],
); );
assert_eq!(AttrValue::Uint16(val1), read_cluster_id_write_attr(&im, 0)); assert_eq!(val1, im.echo_cluster(0).att_write);
assert_eq!(AttrValue::Uint16(val1), read_cluster_id_write_attr(&im, 1)); assert_eq!(val1, im.echo_cluster(1).att_write);
} }
#[test] #[test]
@ -337,7 +237,7 @@ fn exact_write_attribute() {
let ep0_att = GenericPath::new( let ep0_att = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let input = &[AttrData::new( let input = &[AttrData::new(
@ -353,25 +253,24 @@ fn exact_write_attribute() {
let expected_success = &[AttrStatus::new(&ep0_att, IMStatusCode::Success, 0)]; let expected_success = &[AttrStatus::new(&ep0_att, IMStatusCode::Success, 0)];
let peer = 98765; let peer = 98765;
let mut im = ImEngine::new(); let mut mdns = DummyMdns {};
let matter = matter(&mut mdns);
let mut im = ImEngine::new(&matter);
// Test 1: Exact write to an attribute without permission should return // Test 1: Exact write to an attribute without permission should return
// Unsupported Access Error // Unsupported Access Error
handle_write_reqs(&mut im, peer, None, input, expected_fail); im.handle_write_reqs(peer, None, input, expected_fail);
assert_eq!( assert_eq!(ATTR_WRITE_DEFAULT_VALUE, im.echo_cluster(0).att_write);
AttrValue::Uint16(ATTR_WRITE_DEFAULT_VALUE),
read_cluster_id_write_attr(&im, 0)
);
// Add ACL to allow our peer to access any endpoint // Add ACL to allow our peer to access any endpoint
let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case); let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case);
acl.add_subject(peer).unwrap(); acl.add_subject(peer).unwrap();
im.acl_mgr.add(acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(acl).unwrap();
// Test 1: Exact write to an attribute with permission should grant // Test 1: Exact write to an attribute with permission should grant
// access // access
handle_write_reqs(&mut im, peer, None, input, expected_success); im.handle_write_reqs(peer, None, input, expected_success);
assert_eq!(AttrValue::Uint16(val0), read_cluster_id_write_attr(&im, 0)); assert_eq!(val0, im.echo_cluster(0).att_write);
} }
#[test] #[test]
@ -388,7 +287,7 @@ fn exact_write_attribute_noc_cat() {
let ep0_att = GenericPath::new( let ep0_att = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let input = &[AttrData::new( let input = &[AttrData::new(
@ -408,25 +307,24 @@ fn exact_write_attribute_noc_cat() {
let noc_cat = gen_noc_cat(0xABCD, 2); let noc_cat = gen_noc_cat(0xABCD, 2);
let cat_in_acl = gen_noc_cat(0xABCD, 1); let cat_in_acl = gen_noc_cat(0xABCD, 1);
let cat_ids = [noc_cat, 0, 0]; let cat_ids = [noc_cat, 0, 0];
let mut im = ImEngine::new(); let mut mdns = DummyMdns;
let matter = matter(&mut mdns);
let mut im = ImEngine::new(&matter);
// Test 1: Exact write to an attribute without permission should return // Test 1: Exact write to an attribute without permission should return
// Unsupported Access Error // Unsupported Access Error
handle_write_reqs(&mut im, peer, Some(&cat_ids), input, expected_fail); im.handle_write_reqs(peer, Some(&cat_ids), input, expected_fail);
assert_eq!( assert_eq!(ATTR_WRITE_DEFAULT_VALUE, im.echo_cluster(0).att_write);
AttrValue::Uint16(ATTR_WRITE_DEFAULT_VALUE),
read_cluster_id_write_attr(&im, 0)
);
// Add ACL to allow our peer to access any endpoint // Add ACL to allow our peer to access any endpoint
let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case); let mut acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case);
acl.add_subject_catid(cat_in_acl).unwrap(); acl.add_subject_catid(cat_in_acl).unwrap();
im.acl_mgr.add(acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(acl).unwrap();
// Test 1: Exact write to an attribute with permission should grant // Test 1: Exact write to an attribute with permission should grant
// access // access
handle_write_reqs(&mut im, peer, Some(&cat_ids), input, expected_success); im.handle_write_reqs(peer, Some(&cat_ids), input, expected_success);
assert_eq!(AttrValue::Uint16(val0), read_cluster_id_write_attr(&im, 0)); assert_eq!(val0, im.echo_cluster(0).att_write);
} }
#[test] #[test]
@ -440,7 +338,7 @@ fn insufficient_perms_write() {
let ep0_att = GenericPath::new( let ep0_att = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let input0 = &[AttrData::new( let input0 = &[AttrData::new(
None, None,
@ -449,17 +347,18 @@ fn insufficient_perms_write() {
)]; )];
let peer = 98765; let peer = 98765;
let mut im = ImEngine::new(); let mut mdns = DummyMdns {};
let matter = matter(&mut mdns);
let mut im = ImEngine::new(&matter);
// Add ACL to allow our peer with only OPERATE permission // Add ACL to allow our peer with only OPERATE permission
let mut acl = AclEntry::new(1, Privilege::OPERATE, AuthMode::Case); let mut acl = AclEntry::new(1, Privilege::OPERATE, AuthMode::Case);
acl.add_subject(peer).unwrap(); acl.add_subject(peer).unwrap();
acl.add_target(Target::new(Some(0), None, None)).unwrap(); acl.add_target(Target::new(Some(0), None, None)).unwrap();
im.acl_mgr.add(acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(acl).unwrap();
// Test: Not enough permission should return error // Test: Not enough permission should return error
handle_write_reqs( im.handle_write_reqs(
&mut im,
peer, peer,
None, None,
input0, input0,
@ -469,10 +368,7 @@ fn insufficient_perms_write() {
0, 0,
)], )],
); );
assert_eq!( assert_eq!(ATTR_WRITE_DEFAULT_VALUE, im.echo_cluster(0).att_write);
AttrValue::Uint16(ATTR_WRITE_DEFAULT_VALUE),
read_cluster_id_write_attr(&im, 0)
);
} }
#[test] #[test]
@ -485,7 +381,9 @@ fn insufficient_perms_write() {
fn write_with_runtime_acl_add() { fn write_with_runtime_acl_add() {
let _ = env_logger::try_init(); let _ = env_logger::try_init();
let peer = 98765; let peer = 98765;
let mut im = ImEngine::new(); let mut mdns = DummyMdns {};
let matter = matter(&mut mdns);
let mut im = ImEngine::new(&matter);
let val0 = 10; let val0 = 10;
let attr_data0 = |tag, t: &mut TLVWriter| { let attr_data0 = |tag, t: &mut TLVWriter| {
@ -494,7 +392,7 @@ fn write_with_runtime_acl_add() {
let ep0_att = GenericPath::new( let ep0_att = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let input0 = AttrData::new( let input0 = AttrData::new(
None, None,
@ -509,7 +407,7 @@ fn write_with_runtime_acl_add() {
let acl_att = GenericPath::new( let acl_att = GenericPath::new(
Some(0), Some(0),
Some(access_control::ID), Some(access_control::ID),
Some(access_control::Attributes::Acl as u32), Some(access_control::AttributesDiscriminants::Acl as u32),
); );
let acl_input = AttrData::new( let acl_input = AttrData::new(
None, None,
@ -523,11 +421,10 @@ fn write_with_runtime_acl_add() {
basic_acl basic_acl
.add_target(Target::new(Some(0), Some(access_control::ID), None)) .add_target(Target::new(Some(0), Some(access_control::ID), None))
.unwrap(); .unwrap();
im.acl_mgr.add(basic_acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(basic_acl).unwrap();
// Test: deny write (with error), then ACL is added, then allow write // Test: deny write (with error), then ACL is added, then allow write
handle_write_reqs( im.handle_write_reqs(
&mut im,
peer, peer,
None, None,
// write to echo-cluster attribute, write to acl attribute, write to echo-cluster attribute // write to echo-cluster attribute, write to acl attribute, write to echo-cluster attribute
@ -538,7 +435,7 @@ fn write_with_runtime_acl_add() {
AttrStatus::new(&ep0_att, IMStatusCode::Success, 0), AttrStatus::new(&ep0_att, IMStatusCode::Success, 0),
], ],
); );
assert_eq!(AttrValue::Uint16(val0), read_cluster_id_write_attr(&im, 0)); assert_eq!(val0, im.echo_cluster(0).att_write);
} }
#[test] #[test]
@ -551,16 +448,18 @@ fn test_read_data_ver() {
// - 2 responses are expected // - 2 responses are expected
let _ = env_logger::try_init(); let _ = env_logger::try_init();
let peer = 98765; let peer = 98765;
let mut im = ImEngine::new(); let mut mdns = DummyMdns {};
let matter = matter(&mut mdns);
let mut im = ImEngine::new(&matter);
// Add ACL to allow our peer with only OPERATE permission // Add ACL to allow our peer with only OPERATE permission
let acl = AclEntry::new(1, Privilege::OPERATE, AuthMode::Case); let acl = AclEntry::new(1, Privilege::OPERATE, AuthMode::Case);
im.acl_mgr.add(acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(acl).unwrap();
let wc_ep_att1 = GenericPath::new( let wc_ep_att1 = GenericPath::new(
None, None,
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let input = &[AttrPath::new(&wc_ep_att1)]; let input = &[AttrPath::new(&wc_ep_att1)];
@ -569,7 +468,7 @@ fn test_read_data_ver() {
GenericPath::new( GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32) Some(echo_cluster::AttributesDiscriminants::Att1 as u32)
), ),
ElementType::U16(0x1234) ElementType::U16(0x1234)
), ),
@ -577,7 +476,7 @@ fn test_read_data_ver() {
GenericPath::new( GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32) Some(echo_cluster::AttributesDiscriminants::Att1 as u32)
), ),
ElementType::U16(0x1234) ElementType::U16(0x1234)
), ),
@ -585,7 +484,7 @@ fn test_read_data_ver() {
let mut out_buf = [0u8; 400]; let mut out_buf = [0u8; 400];
// Test 1: Simple read to retrieve the current Data Version of Cluster at Endpoint 0 // Test 1: Simple read to retrieve the current Data Version of Cluster at Endpoint 0
let received = gen_read_reqs_output(&mut im, peer, input, None, &mut out_buf); let received = im.gen_read_reqs_output(peer, input, None, &mut out_buf);
assert_attr_report(&received, expected); assert_attr_report(&received, expected);
let data_ver_cluster_at_0 = received let data_ver_cluster_at_0 = received
@ -607,8 +506,7 @@ fn test_read_data_ver() {
}]; }];
// Test 2: Add Dataversion filter for cluster at endpoint 0 only single entry should be retrieved // Test 2: Add Dataversion filter for cluster at endpoint 0 only single entry should be retrieved
let received = gen_read_reqs_output( let received = im.gen_read_reqs_output(
&mut im,
peer, peer,
input, input,
Some(TLVArray::Slice(&dataver_filter)), Some(TLVArray::Slice(&dataver_filter)),
@ -618,7 +516,7 @@ fn test_read_data_ver() {
GenericPath::new( GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32) Some(echo_cluster::AttributesDiscriminants::Att1 as u32)
), ),
ElementType::U16(0x1234) ElementType::U16(0x1234)
)]; )];
@ -629,11 +527,10 @@ fn test_read_data_ver() {
let ep0_att1 = GenericPath::new( let ep0_att1 = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let input = &[AttrPath::new(&ep0_att1)]; let input = &[AttrPath::new(&ep0_att1)];
let received = gen_read_reqs_output( let received = im.gen_read_reqs_output(
&mut im,
peer, peer,
input, input,
Some(TLVArray::Slice(&dataver_filter)), Some(TLVArray::Slice(&dataver_filter)),
@ -654,21 +551,23 @@ fn test_write_data_ver() {
// - 2 responses are expected // - 2 responses are expected
let _ = env_logger::try_init(); let _ = env_logger::try_init();
let peer = 98765; let peer = 98765;
let mut im = ImEngine::new(); let mut mdns = DummyMdns {};
let matter = matter(&mut mdns);
let mut im = ImEngine::new(&matter);
// Add ACL to allow our peer with only OPERATE permission // Add ACL to allow our peer with only OPERATE permission
let acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case); let acl = AclEntry::new(1, Privilege::ADMIN, AuthMode::Case);
im.acl_mgr.add(acl).unwrap(); im.matter.acl_mgr.borrow_mut().add(acl).unwrap();
let wc_ep_attwrite = GenericPath::new( let wc_ep_attwrite = GenericPath::new(
None, None,
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let ep0_attwrite = GenericPath::new( let ep0_attwrite = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let val0 = 10u16; let val0 = 10u16;
@ -676,7 +575,7 @@ fn test_write_data_ver() {
let attr_data0 = EncodeValue::Value(&val0); let attr_data0 = EncodeValue::Value(&val0);
let attr_data1 = EncodeValue::Value(&val1); let attr_data1 = EncodeValue::Value(&val1);
let initial_data_ver = read_cluster_id_data_ver(&im, 0); let initial_data_ver = im.echo_cluster(0).data_ver.get();
// Test 1: Write with correct dataversion should succeed // Test 1: Write with correct dataversion should succeed
let input_correct_dataver = &[AttrData::new( let input_correct_dataver = &[AttrData::new(
@ -684,14 +583,13 @@ fn test_write_data_ver() {
AttrPath::new(&ep0_attwrite), AttrPath::new(&ep0_attwrite),
attr_data0, attr_data0,
)]; )];
handle_write_reqs( im.handle_write_reqs(
&mut im,
peer, peer,
None, None,
input_correct_dataver, input_correct_dataver,
&[AttrStatus::new(&ep0_attwrite, IMStatusCode::Success, 0)], &[AttrStatus::new(&ep0_attwrite, IMStatusCode::Success, 0)],
); );
assert_eq!(AttrValue::Uint16(val0), read_cluster_id_write_attr(&im, 0)); assert_eq!(val0, im.echo_cluster(0).att_write);
// Test 2: Write with incorrect dataversion should fail // Test 2: Write with incorrect dataversion should fail
// Now the data version would have incremented due to the previous write // Now the data version would have incremented due to the previous write
@ -700,8 +598,7 @@ fn test_write_data_ver() {
AttrPath::new(&ep0_attwrite), AttrPath::new(&ep0_attwrite),
attr_data1, attr_data1,
)]; )];
handle_write_reqs( im.handle_write_reqs(
&mut im,
peer, peer,
None, None,
input_correct_dataver, input_correct_dataver,
@ -711,26 +608,25 @@ fn test_write_data_ver() {
0, 0,
)], )],
); );
assert_eq!(AttrValue::Uint16(val0), read_cluster_id_write_attr(&im, 0)); assert_eq!(val0, im.echo_cluster(0).att_write);
// Test 3: Wildcard write with incorrect dataversion should ignore that cluster // Test 3: Wildcard write with incorrect dataversion should ignore that cluster
// In this case, while the data version is correct for endpoint 0, the endpoint 1's // In this case, while the data version is correct for endpoint 0, the endpoint 1's
// data version would not match // data version would not match
let new_data_ver = read_cluster_id_data_ver(&im, 0); let new_data_ver = im.echo_cluster(0).data_ver.get();
let input_correct_dataver = &[AttrData::new( let input_correct_dataver = &[AttrData::new(
Some(new_data_ver), Some(new_data_ver),
AttrPath::new(&wc_ep_attwrite), AttrPath::new(&wc_ep_attwrite),
attr_data1, attr_data1,
)]; )];
handle_write_reqs( im.handle_write_reqs(
&mut im,
peer, peer,
None, None,
input_correct_dataver, input_correct_dataver,
&[AttrStatus::new(&ep0_attwrite, IMStatusCode::Success, 0)], &[AttrStatus::new(&ep0_attwrite, IMStatusCode::Success, 0)],
); );
assert_eq!(AttrValue::Uint16(val1), read_cluster_id_write_attr(&im, 0)); assert_eq!(val1, im.echo_cluster(0).att_write);
assert_eq!(initial_data_ver + 1, new_data_ver); assert_eq!(initial_data_ver + 1, new_data_ver);
} }

View file

@ -16,36 +16,22 @@
*/ */
use matter::{ use matter::{
data_model::{core::DataModel, objects::EncodeValue}, data_model::objects::EncodeValue,
interaction_model::{ interaction_model::{
core::{IMStatusCode, OpCode}, core::IMStatusCode,
messages::ib::{AttrData, AttrPath, AttrStatus},
messages::GenericPath, messages::GenericPath,
messages::{
ib::{AttrData, AttrPath, AttrStatus},
msg::{WriteReq, WriteResp},
}, },
}, mdns::DummyMdns,
tlv::{self, FromTLV, Nullable}, tlv::Nullable,
}; };
use crate::common::{ use crate::common::{
echo_cluster::{self, TestChecker}, echo_cluster::{self, TestChecker},
im_engine::im_engine, im_engine::{matter, ImEngine},
}; };
// Helper for handling Write Attribute sequences // Helper for handling Write Attribute sequences
fn handle_write_reqs(input: &[AttrData], expected: &[AttrStatus]) -> DataModel {
let mut out_buf = [0u8; 400];
let write_req = WriteReq::new(false, input);
let (dm, _, out_buf) = im_engine(OpCode::WriteRequest, &write_req, &mut out_buf);
tlv::print_tlv_list(out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
let resp = WriteResp::from_tlv(&root).unwrap();
assert_eq!(resp.write_responses, expected);
dm
}
#[test] #[test]
/// This tests all the attribute list operations /// This tests all the attribute list operations
/// add item, edit item, delete item, overwrite list, delete list /// add item, edit item, delete item, overwrite list, delete list
@ -67,14 +53,14 @@ fn attr_list_ops() {
let att_data = GenericPath::new( let att_data = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWriteList as u32), Some(echo_cluster::AttributesDiscriminants::AttWriteList as u32),
); );
let mut att_path = AttrPath::new(&att_data); let mut att_path = AttrPath::new(&att_data);
// Test 1: Add Operation - add val0 // Test 1: Add Operation - add val0
let input = &[AttrData::new(None, att_path, EncodeValue::Value(&val0))]; let input = &[AttrData::new(None, att_path, EncodeValue::Value(&val0))];
let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)]; let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)];
let _ = handle_write_reqs(input, expected); ImEngine::new_with_write_reqs(&matter(&mut DummyMdns), input, expected);
{ {
let tc = tc_handle.lock().unwrap(); let tc = tc_handle.lock().unwrap();
@ -84,7 +70,7 @@ fn attr_list_ops() {
// Test 2: Another Add Operation - add val1 // Test 2: Another Add Operation - add val1
let input = &[AttrData::new(None, att_path, EncodeValue::Value(&val1))]; let input = &[AttrData::new(None, att_path, EncodeValue::Value(&val1))];
let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)]; let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)];
let _ = handle_write_reqs(input, expected); ImEngine::new_with_write_reqs(&matter(&mut DummyMdns), input, expected);
{ {
let tc = tc_handle.lock().unwrap(); let tc = tc_handle.lock().unwrap();
@ -95,7 +81,7 @@ fn attr_list_ops() {
att_path.list_index = Some(Nullable::NotNull(1)); att_path.list_index = Some(Nullable::NotNull(1));
let input = &[AttrData::new(None, att_path, EncodeValue::Value(&val0))]; let input = &[AttrData::new(None, att_path, EncodeValue::Value(&val0))];
let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)]; let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)];
let _ = handle_write_reqs(input, expected); ImEngine::new_with_write_reqs(&matter(&mut DummyMdns), input, expected);
{ {
let tc = tc_handle.lock().unwrap(); let tc = tc_handle.lock().unwrap();
@ -106,7 +92,7 @@ fn attr_list_ops() {
att_path.list_index = Some(Nullable::NotNull(0)); att_path.list_index = Some(Nullable::NotNull(0));
let input = &[AttrData::new(None, att_path, delete_item)]; let input = &[AttrData::new(None, att_path, delete_item)];
let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)]; let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)];
let _ = handle_write_reqs(input, expected); ImEngine::new_with_write_reqs(&matter(&mut DummyMdns), input, expected);
{ {
let tc = tc_handle.lock().unwrap(); let tc = tc_handle.lock().unwrap();
@ -122,7 +108,7 @@ fn attr_list_ops() {
EncodeValue::Value(&overwrite_val), EncodeValue::Value(&overwrite_val),
)]; )];
let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)]; let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)];
let _ = handle_write_reqs(input, expected); ImEngine::new_with_write_reqs(&matter(&mut DummyMdns), input, expected);
{ {
let tc = tc_handle.lock().unwrap(); let tc = tc_handle.lock().unwrap();
@ -133,7 +119,7 @@ fn attr_list_ops() {
att_path.list_index = None; att_path.list_index = None;
let input = &[AttrData::new(None, att_path, delete_all)]; let input = &[AttrData::new(None, att_path, delete_all)];
let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)]; let expected = &[AttrStatus::new(&att_data, IMStatusCode::Success, 0)];
let _ = handle_write_reqs(input, expected); ImEngine::new_with_write_reqs(&matter(&mut DummyMdns), input, expected);
{ {
let tc = tc_handle.lock().unwrap(); let tc = tc_handle.lock().unwrap();

View file

@ -18,53 +18,26 @@
use matter::{ use matter::{
data_model::{ data_model::{
cluster_on_off, cluster_on_off,
core::DataModel, objects::{EncodeValue, GlobalElements},
objects::{AttrValue, EncodeValue, GlobalElements},
}, },
interaction_model::{ interaction_model::{
core::{IMStatusCode, OpCode}, core::IMStatusCode,
messages::ib::{AttrData, AttrPath, AttrResp, AttrStatus},
messages::GenericPath, messages::GenericPath,
messages::{
ib::{AttrData, AttrPath, AttrResp, AttrStatus},
msg::{ReadReq, ReportDataMsg, WriteReq, WriteResp},
}, },
}, mdns::DummyMdns,
tlv::{self, ElementType, FromTLV, TLVElement, TLVWriter, TagType}, tlv::{ElementType, TLVElement, TLVWriter, TagType},
}; };
use crate::{ use crate::{
attr_data, attr_data_path, attr_status, attr_data, attr_data_path, attr_status,
common::{attributes::*, echo_cluster, im_engine::im_engine}, common::{
attributes::*,
echo_cluster,
im_engine::{matter, ImEngine},
},
}; };
fn handle_read_reqs(input: &[AttrPath], expected: &[AttrResp]) {
let mut out_buf = [0u8; 400];
let received = gen_read_reqs_output(input, &mut out_buf);
assert_attr_report(&received, expected)
}
// Helper for handling Read Req sequences
fn gen_read_reqs_output<'a>(input: &[AttrPath], out_buf: &'a mut [u8]) -> ReportDataMsg<'a> {
let read_req = ReadReq::new(true).set_attr_requests(input);
let (_, _, out_buf) = im_engine(OpCode::ReadRequest, &read_req, out_buf);
tlv::print_tlv_list(out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
ReportDataMsg::from_tlv(&root).unwrap()
}
// Helper for handling Write Attribute sequences
fn handle_write_reqs(input: &[AttrData], expected: &[AttrStatus]) -> DataModel {
let mut out_buf = [0u8; 400];
let write_req = WriteReq::new(false, input);
let (dm, _, out_buf) = im_engine(OpCode::WriteRequest, &write_req, &mut out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
let response = WriteResp::from_tlv(&root).unwrap();
assert_eq!(response.write_responses, expected);
dm
}
#[test] #[test]
fn test_read_success() { fn test_read_success() {
// 3 Attr Read Requests // 3 Attr Read Requests
@ -76,17 +49,17 @@ fn test_read_success() {
let ep0_att1 = GenericPath::new( let ep0_att1 = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let ep1_att2 = GenericPath::new( let ep1_att2 = GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att2 as u32), Some(echo_cluster::AttributesDiscriminants::Att2 as u32),
); );
let ep1_attcustom = GenericPath::new( let ep1_attcustom = GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttCustom as u32), Some(echo_cluster::AttributesDiscriminants::AttCustom as u32),
); );
let input = &[ let input = &[
AttrPath::new(&ep0_att1), AttrPath::new(&ep0_att1),
@ -101,7 +74,7 @@ fn test_read_success() {
ElementType::U32(echo_cluster::ATTR_CUSTOM_VALUE) ElementType::U32(echo_cluster::ATTR_CUSTOM_VALUE)
), ),
]; ];
handle_read_reqs(input, expected); ImEngine::new_with_read_reqs(&matter(&mut DummyMdns), input, expected);
} }
#[test] #[test]
@ -118,17 +91,17 @@ fn test_read_unsupported_fields() {
let invalid_endpoint = GenericPath::new( let invalid_endpoint = GenericPath::new(
Some(2), Some(2),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let invalid_cluster = GenericPath::new( let invalid_cluster = GenericPath::new(
Some(0), Some(0),
Some(0x1234), Some(0x1234),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let invalid_cluster_wc_endpoint = GenericPath::new( let invalid_cluster_wc_endpoint = GenericPath::new(
None, None,
Some(0x1234), Some(0x1234),
Some(echo_cluster::Attributes::AttCustom as u32), Some(echo_cluster::AttributesDiscriminants::AttCustom as u32),
); );
let invalid_attribute = GenericPath::new(Some(0), Some(echo_cluster::ID), Some(0x1234)); let invalid_attribute = GenericPath::new(Some(0), Some(echo_cluster::ID), Some(0x1234));
let invalid_attribute_wc_endpoint = let invalid_attribute_wc_endpoint =
@ -148,7 +121,7 @@ fn test_read_unsupported_fields() {
attr_status!(&invalid_cluster, IMStatusCode::UnsupportedCluster), attr_status!(&invalid_cluster, IMStatusCode::UnsupportedCluster),
attr_status!(&invalid_attribute, IMStatusCode::UnsupportedAttribute), attr_status!(&invalid_attribute, IMStatusCode::UnsupportedAttribute),
]; ];
handle_read_reqs(input, expected); ImEngine::new_with_read_reqs(&matter(&mut DummyMdns), input, expected);
} }
#[test] #[test]
@ -161,7 +134,7 @@ fn test_read_wc_endpoint_all_have_clusters() {
let wc_ep_att1 = GenericPath::new( let wc_ep_att1 = GenericPath::new(
None, None,
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
); );
let input = &[AttrPath::new(&wc_ep_att1)]; let input = &[AttrPath::new(&wc_ep_att1)];
@ -169,17 +142,17 @@ fn test_read_wc_endpoint_all_have_clusters() {
attr_data!( attr_data!(
0, 0,
echo_cluster::ID, echo_cluster::ID,
echo_cluster::Attributes::Att1, echo_cluster::AttributesDiscriminants::Att1,
ElementType::U16(0x1234) ElementType::U16(0x1234)
), ),
attr_data!( attr_data!(
1, 1,
echo_cluster::ID, echo_cluster::ID,
echo_cluster::Attributes::Att1, echo_cluster::AttributesDiscriminants::Att1,
ElementType::U16(0x1234) ElementType::U16(0x1234)
), ),
]; ];
handle_read_reqs(input, expected); ImEngine::new_with_read_reqs(&matter(&mut DummyMdns), input, expected);
} }
#[test] #[test]
@ -192,7 +165,7 @@ fn test_read_wc_endpoint_only_1_has_cluster() {
let wc_ep_onoff = GenericPath::new( let wc_ep_onoff = GenericPath::new(
None, None,
Some(cluster_on_off::ID), Some(cluster_on_off::ID),
Some(cluster_on_off::Attributes::OnOff as u32), Some(cluster_on_off::AttributesDiscriminants::OnOff as u32),
); );
let input = &[AttrPath::new(&wc_ep_onoff)]; let input = &[AttrPath::new(&wc_ep_onoff)];
@ -200,11 +173,11 @@ fn test_read_wc_endpoint_only_1_has_cluster() {
GenericPath::new( GenericPath::new(
Some(1), Some(1),
Some(cluster_on_off::ID), Some(cluster_on_off::ID),
Some(cluster_on_off::Attributes::OnOff as u32) Some(cluster_on_off::AttributesDiscriminants::OnOff as u32)
), ),
ElementType::False ElementType::False
)]; )];
handle_read_reqs(input, expected); ImEngine::new_with_read_reqs(&matter(&mut DummyMdns), input, expected);
} }
#[test] #[test]
@ -221,10 +194,10 @@ fn test_read_wc_endpoint_wc_attribute() {
&[ &[
GlobalElements::FeatureMap as u16, GlobalElements::FeatureMap as u16,
GlobalElements::AttributeList as u16, GlobalElements::AttributeList as u16,
echo_cluster::Attributes::Att1 as u16, echo_cluster::AttributesDiscriminants::Att1 as u16,
echo_cluster::Attributes::Att2 as u16, echo_cluster::AttributesDiscriminants::Att2 as u16,
echo_cluster::Attributes::AttWrite as u16, echo_cluster::AttributesDiscriminants::AttWrite as u16,
echo_cluster::Attributes::AttCustom as u16, echo_cluster::AttributesDiscriminants::AttCustom as u16,
], ],
); );
let attr_list_tlv = attr_list.to_tlv(); let attr_list_tlv = attr_list.to_tlv();
@ -250,7 +223,7 @@ fn test_read_wc_endpoint_wc_attribute() {
GenericPath::new( GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
), ),
ElementType::U16(0x1234) ElementType::U16(0x1234)
), ),
@ -258,7 +231,7 @@ fn test_read_wc_endpoint_wc_attribute() {
GenericPath::new( GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att2 as u32), Some(echo_cluster::AttributesDiscriminants::Att2 as u32),
), ),
ElementType::U16(0x5678) ElementType::U16(0x5678)
), ),
@ -266,7 +239,7 @@ fn test_read_wc_endpoint_wc_attribute() {
GenericPath::new( GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttCustom as u32), Some(echo_cluster::AttributesDiscriminants::AttCustom as u32),
), ),
ElementType::U32(echo_cluster::ATTR_CUSTOM_VALUE) ElementType::U32(echo_cluster::ATTR_CUSTOM_VALUE)
), ),
@ -290,7 +263,7 @@ fn test_read_wc_endpoint_wc_attribute() {
GenericPath::new( GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att1 as u32), Some(echo_cluster::AttributesDiscriminants::Att1 as u32),
), ),
ElementType::U16(0x1234) ElementType::U16(0x1234)
), ),
@ -298,7 +271,7 @@ fn test_read_wc_endpoint_wc_attribute() {
GenericPath::new( GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::Att2 as u32), Some(echo_cluster::AttributesDiscriminants::Att2 as u32),
), ),
ElementType::U16(0x5678) ElementType::U16(0x5678)
), ),
@ -306,12 +279,12 @@ fn test_read_wc_endpoint_wc_attribute() {
GenericPath::new( GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttCustom as u32), Some(echo_cluster::AttributesDiscriminants::AttCustom as u32),
), ),
ElementType::U32(echo_cluster::ATTR_CUSTOM_VALUE) ElementType::U32(echo_cluster::ATTR_CUSTOM_VALUE)
), ),
]; ];
handle_read_reqs(input, expected); ImEngine::new_with_read_reqs(&matter(&mut DummyMdns), input, expected);
} }
#[test] #[test]
@ -332,12 +305,12 @@ fn test_write_success() {
let ep0_att = GenericPath::new( let ep0_att = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let ep1_att = GenericPath::new( let ep1_att = GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let input = &[ let input = &[
@ -357,24 +330,11 @@ fn test_write_success() {
AttrStatus::new(&ep1_att, IMStatusCode::Success, 0), AttrStatus::new(&ep1_att, IMStatusCode::Success, 0),
]; ];
let dm = handle_write_reqs(input, expected); let mut mdns = DummyMdns;
let node = dm.node.read().unwrap(); let matter = matter(&mut mdns);
let echo = node.get_cluster(0, echo_cluster::ID).unwrap(); let im = ImEngine::new_with_write_reqs(&matter, input, expected);
assert_eq!( assert_eq!(val0, im.echo_cluster(0).att_write);
AttrValue::Uint16(val0), assert_eq!(val1, im.echo_cluster(1).att_write);
*echo
.base()
.read_attribute_raw(echo_cluster::Attributes::AttWrite as u16)
.unwrap()
);
let echo = node.get_cluster(1, echo_cluster::ID).unwrap();
assert_eq!(
AttrValue::Uint16(val1),
*echo
.base()
.read_attribute_raw(echo_cluster::Attributes::AttWrite as u16)
.unwrap()
);
} }
#[test] #[test]
@ -390,7 +350,7 @@ fn test_write_wc_endpoint() {
let ep_att = GenericPath::new( let ep_att = GenericPath::new(
None, None,
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let input = &[AttrData::new( let input = &[AttrData::new(
None, None,
@ -401,38 +361,23 @@ fn test_write_wc_endpoint() {
let ep0_att = GenericPath::new( let ep0_att = GenericPath::new(
Some(0), Some(0),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let ep1_att = GenericPath::new( let ep1_att = GenericPath::new(
Some(1), Some(1),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let expected = &[ let expected = &[
AttrStatus::new(&ep0_att, IMStatusCode::Success, 0), AttrStatus::new(&ep0_att, IMStatusCode::Success, 0),
AttrStatus::new(&ep1_att, IMStatusCode::Success, 0), AttrStatus::new(&ep1_att, IMStatusCode::Success, 0),
]; ];
let dm = handle_write_reqs(input, expected); let mut mdns = DummyMdns;
assert_eq!( let matter = matter(&mut mdns);
AttrValue::Uint16(val0), let im = ImEngine::new_with_write_reqs(&matter, input, expected);
dm.read_attribute_raw( assert_eq!(val0, im.echo_cluster(0).att_write);
0,
echo_cluster::ID,
echo_cluster::Attributes::AttWrite as u16
)
.unwrap()
);
assert_eq!(
AttrValue::Uint16(val0),
dm.read_attribute_raw(
0,
echo_cluster::ID,
echo_cluster::Attributes::AttWrite as u16
)
.unwrap()
);
} }
#[test] #[test]
@ -455,25 +400,25 @@ fn test_write_unsupported_fields() {
let invalid_endpoint = GenericPath::new( let invalid_endpoint = GenericPath::new(
Some(4), Some(4),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let invalid_cluster = GenericPath::new( let invalid_cluster = GenericPath::new(
Some(0), Some(0),
Some(0x1234), Some(0x1234),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let invalid_attribute = GenericPath::new(Some(0), Some(echo_cluster::ID), Some(0x1234)); let invalid_attribute = GenericPath::new(Some(0), Some(echo_cluster::ID), Some(0x1234));
let wc_endpoint_invalid_cluster = GenericPath::new( let wc_endpoint_invalid_cluster = GenericPath::new(
None, None,
Some(0x1234), Some(0x1234),
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let wc_endpoint_invalid_attribute = let wc_endpoint_invalid_attribute =
GenericPath::new(None, Some(echo_cluster::ID), Some(0x1234)); GenericPath::new(None, Some(echo_cluster::ID), Some(0x1234));
let wc_cluster = GenericPath::new( let wc_cluster = GenericPath::new(
Some(0), Some(0),
None, None,
Some(echo_cluster::Attributes::AttWrite as u32), Some(echo_cluster::AttributesDiscriminants::AttWrite as u32),
); );
let wc_attribute = GenericPath::new(Some(0), Some(echo_cluster::ID), None); let wc_attribute = GenericPath::new(Some(0), Some(echo_cluster::ID), None);
@ -521,14 +466,11 @@ fn test_write_unsupported_fields() {
AttrStatus::new(&wc_cluster, IMStatusCode::UnsupportedCluster, 0), AttrStatus::new(&wc_cluster, IMStatusCode::UnsupportedCluster, 0),
AttrStatus::new(&wc_attribute, IMStatusCode::UnsupportedAttribute, 0), AttrStatus::new(&wc_attribute, IMStatusCode::UnsupportedAttribute, 0),
]; ];
let dm = handle_write_reqs(input, expected); let mut mdns = DummyMdns;
let matter = matter(&mut mdns);
let im = ImEngine::new_with_write_reqs(&matter, input, expected);
assert_eq!( assert_eq!(
AttrValue::Uint16(echo_cluster::ATTR_WRITE_DEFAULT_VALUE), echo_cluster::ATTR_WRITE_DEFAULT_VALUE,
dm.read_attribute_raw( im.echo_cluster(0).att_write
0,
echo_cluster::ID,
echo_cluster::Attributes::AttWrite as u16
)
.unwrap()
); );
} }

View file

@ -17,39 +17,23 @@
use crate::{ use crate::{
cmd_data, cmd_data,
common::{commands::*, echo_cluster, im_engine::im_engine}, common::{
commands::*,
echo_cluster,
im_engine::{matter, ImEngine},
},
echo_req, echo_resp, echo_req, echo_resp,
}; };
use matter::{ use matter::{
data_model::{cluster_on_off, objects::EncodeValue}, data_model::{cluster_on_off, objects::EncodeValue},
interaction_model::{ interaction_model::{
core::{IMStatusCode, OpCode}, core::IMStatusCode,
messages::{ messages::ib::{CmdData, CmdPath, CmdStatus},
ib::{CmdData, CmdPath, CmdStatus},
msg,
msg::InvReq,
}, },
}, mdns::DummyMdns,
tlv::{self, FromTLV, TLVArray},
}; };
// Helper for handling Invoke Command sequences
fn handle_commands(input: &[CmdData], expected: &[ExpectedInvResp]) {
let mut out_buf = [0u8; 400];
let req = InvReq {
suppress_response: Some(false),
timed_request: Some(false),
inv_requests: Some(TLVArray::Slice(input)),
};
let (_, _, out_buf) = im_engine(OpCode::InvokeRequest, &req, &mut out_buf);
tlv::print_tlv_list(out_buf);
let root = tlv::get_root_node_struct(out_buf).unwrap();
let resp = msg::InvResp::from_tlv(&root).unwrap();
assert_inv_response(&resp, expected)
}
#[test] #[test]
fn test_invoke_cmds_success() { fn test_invoke_cmds_success() {
// 2 echo Requests // 2 echo Requests
@ -59,7 +43,7 @@ fn test_invoke_cmds_success() {
let input = &[echo_req!(0, 5), echo_req!(1, 10)]; let input = &[echo_req!(0, 5), echo_req!(1, 10)];
let expected = &[echo_resp!(0, 10), echo_resp!(1, 30)]; let expected = &[echo_resp!(0, 10), echo_resp!(1, 30)];
handle_commands(input, expected); ImEngine::new_with_commands(&matter(&mut DummyMdns), input, expected);
} }
#[test] #[test]
@ -75,17 +59,17 @@ fn test_invoke_cmds_unsupported_fields() {
let invalid_endpoint = CmdPath::new( let invalid_endpoint = CmdPath::new(
Some(2), Some(2),
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Commands::EchoReq as u16), Some(echo_cluster::Commands::EchoReq as u32),
); );
let invalid_cluster = CmdPath::new( let invalid_cluster = CmdPath::new(
Some(0), Some(0),
Some(0x1234), Some(0x1234),
Some(echo_cluster::Commands::EchoReq as u16), Some(echo_cluster::Commands::EchoReq as u32),
); );
let invalid_cluster_wc_endpoint = CmdPath::new( let invalid_cluster_wc_endpoint = CmdPath::new(
None, None,
Some(0x1234), Some(0x1234),
Some(echo_cluster::Commands::EchoReq as u16), Some(echo_cluster::Commands::EchoReq as u32),
); );
let invalid_command = CmdPath::new(Some(0), Some(echo_cluster::ID), Some(0x1234)); let invalid_command = CmdPath::new(Some(0), Some(echo_cluster::ID), Some(0x1234));
let invalid_command_wc_endpoint = CmdPath::new(None, Some(echo_cluster::ID), Some(0x1234)); let invalid_command_wc_endpoint = CmdPath::new(None, Some(echo_cluster::ID), Some(0x1234));
@ -114,7 +98,7 @@ fn test_invoke_cmds_unsupported_fields() {
0, 0,
)), )),
]; ];
handle_commands(input, expected); ImEngine::new_with_commands(&matter(&mut DummyMdns), input, expected);
} }
#[test] #[test]
@ -125,11 +109,11 @@ fn test_invoke_cmd_wc_endpoint_all_have_clusters() {
let path = CmdPath::new( let path = CmdPath::new(
None, None,
Some(echo_cluster::ID), Some(echo_cluster::ID),
Some(echo_cluster::Commands::EchoReq as u16), Some(echo_cluster::Commands::EchoReq as u32),
); );
let input = &[cmd_data!(path, 5)]; let input = &[cmd_data!(path, 5)];
let expected = &[echo_resp!(0, 10), echo_resp!(1, 15)]; let expected = &[echo_resp!(0, 10), echo_resp!(1, 15)];
handle_commands(input, expected); ImEngine::new_with_commands(&matter(&mut DummyMdns), input, expected);
} }
#[test] #[test]
@ -141,12 +125,12 @@ fn test_invoke_cmd_wc_endpoint_only_1_has_cluster() {
let target = CmdPath::new( let target = CmdPath::new(
None, None,
Some(cluster_on_off::ID), Some(cluster_on_off::ID),
Some(cluster_on_off::Commands::On as u16), Some(cluster_on_off::CommandsDiscriminants::On as u32),
); );
let expected_path = CmdPath::new( let expected_path = CmdPath::new(
Some(1), Some(1),
Some(cluster_on_off::ID), Some(cluster_on_off::ID),
Some(cluster_on_off::Commands::On as u16), Some(cluster_on_off::CommandsDiscriminants::On as u32),
); );
let input = &[cmd_data!(target, 1)]; let input = &[cmd_data!(target, 1)];
let expected = &[ExpectedInvResp::Status(CmdStatus::new( let expected = &[ExpectedInvResp::Status(CmdStatus::new(
@ -154,5 +138,5 @@ fn test_invoke_cmd_wc_endpoint_only_1_has_cluster() {
IMStatusCode::Success, IMStatusCode::Success,
0, 0,
))]; ))];
handle_commands(input, expected); ImEngine::new_with_commands(&matter(&mut DummyMdns), input, expected);
} }

Some files were not shown because too many files have changed in this diff Show more