ezsp 7.3.1

Ember ZNet Serial Protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

use le_stream::{FromLeStream, ToLeStream};

use crate::ember::key::Data;
use crate::ember::zll::KeyIndex;

/// Describes the initial security features and requirements
/// that will be used when forming or joining ZLL networks.
#[derive(Clone, Debug, Eq, PartialEq, FromLeStream, ToLeStream)]
pub struct InitialSecurityState {
    bitmask: u32,
    key_index: u8,
    encryption_key: Data,
    preconfigured_key: Data,
}

impl InitialSecurityState {
    /// Create a new initial security state.
    #[must_use]
    pub fn new(
        bitmask: u32,
        key_index: KeyIndex,
        encryption_key: Data,
        preconfigured_key: Data,
    ) -> Self {
        Self {
            bitmask,
            key_index: key_index.into(),
            encryption_key,
            preconfigured_key,
        }
    }

    /// Return the bitmask.
    ///
    /// This is currently unused and reserved for future use.
    #[must_use]
    pub const fn bitmask(&self) -> u32 {
        self.bitmask
    }

    /// Return the key encryption algorithm advertised by the application.
    ///
    /// # Errors
    /// Returns the [`u8`] value of the key index if it is not a valid [`KeyIndex`].
    pub fn key_index(&self) -> Result<KeyIndex, u8> {
        KeyIndex::try_from(self.key_index)
    }

    /// Return the encryption key for use by algorithms that require it.
    #[must_use]
    pub const fn encryption_key(&self) -> &Data {
        &self.encryption_key
    }

    /// Return the pre-configured link key used during classical Zigbee commissioning.
    #[must_use]
    pub const fn preconfigured_key(&self) -> &Data {
        &self.preconfigured_key
    }
}