ts_disco_protocol 0.2.0

tailscale disco protocol definition
Documentation
use core::{
    fmt::{Debug, Formatter},
    hash::{Hash, Hasher},
};

use ts_keys::NodePublicKey;

use crate::{Message, MessageType};

/// A ping message from one node to another.
#[derive(
    zerocopy::Immutable,
    zerocopy::FromBytes,
    zerocopy::IntoBytes,
    zerocopy::Unaligned,
    zerocopy::KnownLayout,
)]
#[repr(C, packed)]
pub struct Ping {
    /// Random client-generated per-ping transaction id.
    pub tx_id: [u8; 12],

    /// Allegedly the ping sender's wireguard public key.
    ///
    /// Old clients (~1.16.0 and earlier) don't send this field.
    ///
    /// It shouldn't be trusted by itself, but can be combined with netmap data to reduce
    /// the discokey:nodekey relation from 1:N to 1:1.
    pub node_key: NodePublicKey,

    /// Zero bytes at the end of the message used to probe path MTU.
    pub padding: [u8],
}

impl Message for Ping {
    const TYPE: MessageType = MessageType::Ping;
}

impl Ping {
    /// The size of a ping message with `n` bytes of padding.
    pub const fn size_with_padding(n: usize) -> usize {
        12 + size_of::<NodePublicKey>() + n
    }
}

impl Debug for &Ping {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        f.debug_struct("Ping")
            .field("tx_id", &self.tx_id)
            .field("node_key", &self.node_key)
            .field("padding", &&self.padding)
            .finish()
    }
}

impl PartialEq for &Ping {
    fn eq(&self, other: &Self) -> bool {
        self.tx_id == other.tx_id
            && self.node_key == other.node_key
            && self.padding == other.padding
    }
}

impl Eq for &Ping {}

impl Hash for &Ping {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.tx_id.hash(state);
        self.node_key.hash(state);
        self.padding.hash(state);
    }
}