Skip to main content

NetworkKeys

Struct NetworkKeys 

Source
pub struct NetworkKeys {
    pub s0: [u8; 16],
    pub s2_unauthenticated: [u8; 16],
    pub s2_authenticated: [u8; 16],
    pub s2_access_control: [u8; 16],
    pub ecdh_private: [u8; 32],
    pub lr_s2_authenticated: Option<[u8; 16]>,
    pub lr_s2_access_control: Option<[u8; 16]>,
}
Expand description

The network keys and the controller’s long-term S2 key pair.

Generate them once per network with NetworkKeys::generate and keep them secret: anyone with these keys can read and command the network.

Fields§

§s0: [u8; 16]

The S0 network key.

§s2_unauthenticated: [u8; 16]

S2 Unauthenticated.

§s2_authenticated: [u8; 16]

S2 Authenticated.

§s2_access_control: [u8; 16]

S2 Access Control.

§ecdh_private: [u8; 32]

The controller’s Curve25519 private key for S2 key exchange.

§lr_s2_authenticated: Option<[u8; 16]>

Long Range S2 Authenticated (Long Range nodes use their own keys).

§lr_s2_access_control: Option<[u8; 16]>

Long Range S2 Access Control.

Implementations§

Source§

impl NetworkKeys

Source

pub fn generate() -> Result<Self, Error>

Fresh random keys from the operating system’s CSPRNG.

Source

pub fn fill_long_range(&mut self) -> Result<bool, Error>

Adds the Long Range keys to keys made before they existed; true if any was added.

Source

pub fn long_range_key(&self, class: SecurityClass) -> Option<&[u8; 16]>

The Long Range key for a class (only the two authenticated S2 classes exist on Long Range).

Source

pub fn key(&self, class: SecurityClass) -> &[u8; 16]

The key for a class.

Source

pub fn controller_dsk(&self) -> Dsk

The controller’s DSK (first 16 bytes of its public key), for a controller-side QR label.

Trait Implementations§

Source§

impl Clone for NetworkKeys

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for NetworkKeys

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for NetworkKeys

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for NetworkKeys

Source§

impl PartialEq for NetworkKeys

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for NetworkKeys

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for NetworkKeys

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more