Struct ssb_crypto::NetworkKey

#[repr(C)]pub struct NetworkKey(pub [u8; 32]);

The network key, or network identifier, used during the secret handshake to prove that both parties are participating in the same ssb network.

The main ssb network uses a publicly-known key, which is available as NetworkKey::SSB_MAIN_NET.

This is an HMAC key; specifically HMAC-SHA-512-256.

Implementations

impl NetworkKey

pub const SIZE: usize

The size of a NetworkKey, in bytes (32).

pub const SSB_MAIN_NET: NetworkKey

The NetworkKey for the primary ssb network.

pub fn from_slice(s: &[u8]) -> Option<Self>

Deserialize from a slice of bytes. Returns None if the slice length isn't 32.

pub fn generate_with_rng<R>(r: &mut R) -> NetworkKey where
    R: CryptoRng + RngCore, 

Generate a random network key using the given cryptographically-secure random number generator.

pub fn from_base64(s: &str) -> Option<Self>

Deserialize from the base-64 representation.

impl NetworkKey

pub fn authenticate(&self, b: &[u8]) -> NetworkAuth

Generate an authentication code for the given byte slice.

Examples

use ssb_crypto::NetworkKey;
let netkey = NetworkKey::SSB_MAIN_NET;
let bytes = [1, 2, 3, 4];
let auth = netkey.authenticate(&bytes);
assert!(netkey.verify(&auth, &bytes));

pub fn verify(&self, auth: &NetworkAuth, b: &[u8]) -> bool

Verify that an authentication code was generated by this key, given the same byte slice.

pub fn generate() -> NetworkKey

Generate a random network key.

Examples

use ssb_crypto::NetworkKey;
let key = NetworkKey::generate();
assert_ne!(key, NetworkKey::SSB_MAIN_NET);

Trait Implementations

impl AsBytes for NetworkKey

fn only_derive_is_allowed_to_implement_this_trait() where
    Self: Sized, 

fn as_bytes(&self) -> &[u8]

Get the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8] where
    Self: FromBytes, 

Get the bytes of this value mutably.

impl Clone for NetworkKey

fn clone(&self) -> NetworkKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkKey

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

Formats the value using the given formatter.

impl Drop for NetworkKey

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<NetworkKey> for NetworkKey

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for NetworkKey

impl Zeroize for NetworkKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not "optimized away" by the compiler.