Struct TrustedDevice

Source

pub struct TrustedDevice { /* private fields */ }

Expand description

An end device a relay trusts: its keys, the WOR frame counter it expects next, and how much of it the relay forwards.

Implementations§

Source §

impl TrustedDevice

Source

pub fn new( dev_addr: u32, root_wor_s_key: &[u8; 16], next_wfcnt: u32, bucket: TokenBucket, ) -> TrustedDevice

Trusts an end device, as UpdateUplinkListReq asks.

§Arguments

dev_addr - its address.
root_wor_s_key - the root relay session key the network sent for it, which its integrity and encryption keys derive from.
next_wfcnt - the WOR frame counter the network expects from it next.
bucket - how many of its uplinks the relay forwards.

§Returns

The trusted device.

Source

pub const fn with_keys( dev_addr: u32, keys: WorKeys, next_wfcnt: u32, bucket: TokenBucket, ) -> TrustedDevice

Trusts an end device whose keys are already derived.

§Arguments

dev_addr - its address.
keys - its integrity and encryption keys.
next_wfcnt - the WOR frame counter expected from it next.
bucket - how many of its uplinks the relay forwards.

§Returns

The trusted device.

Source

pub const fn dev_addr(&self) -> u32

Returns the device’s address.

§Returns

The address.

Source

pub const fn keys(&self) -> &WorKeys

Returns the device’s keys.

§Returns

The integrity and encryption keys.

Source

pub const fn next_wfcnt(&self) -> Option<u32>

Returns the WOR frame counter the relay accepts next, at the least.

§Returns

The counter, or None once a frame with the last counter there is has been accepted.

Source

pub const fn last_wfcnt(&self) -> u32

Returns the last WOR frame counter the relay accepted, which CtrlUplinkListAns reports.

§Returns

The counter. Before any frame arrives, it is one less than the counter the network said to expect, wrapping, so the network reads back what it set.

Source

pub const fn bucket(&self) -> &TokenBucket

Returns how many of the device’s uplinks the relay forwards.

§Returns

The bucket.

Source

pub fn bucket_mut(&mut self) -> &mut TokenBucket

Returns the device’s bucket to spend from or reconfigure.

§Returns

The bucket.

Source

pub fn open( &mut self, wor: &SealedWor, carrier: Carrier, ) -> Result<(u32, Carrier), LorawanError>

Checks and opens a wake-on-radio frame from the device, then moves the counter past it.

The frame carries the counter’s low sixteen bits. The relay takes the first full counter at or after the one it expects with those bits, so a frame it has seen, or an older one, does not verify.

§Arguments

wor - the frame.
carrier - the carrier it arrived on.

§Returns

The full counter the frame carried and where its uplink follows.

§Errors

Returns LorawanError::FcntMismatch for a frame addressed elsewhere or past the last counter, and LorawanError::MicMismatch when it does not verify, leaving the counter where it was.