Enum discv5::packet::Packet

pub enum Packet {
    RandomPacket {
        tag: Tag,
        auth_tag: AuthTag,
        data: Vec<u8>,
    },
    WhoAreYou {
        magic: [u8; 32],
        token: AuthTag,
        id_nonce: Nonce,
        enr_seq: u64,
    },
    AuthMessage {
        tag: Tag,
        auth_header: AuthHeader,
        message: Vec<u8>,
    },
    Message {
        tag: Tag,
        auth_tag: AuthTag,
        message: Vec<u8>,
    },
}

Variants

RandomPacket

Packet for establishing handshake.

Fields of RandomPacket

tag: Tag

The XOR(SHA256(dest-node-id), src-node-id).

auth_tag: AuthTag

Random auth_tag formatted as rlp_bytes(bytes).

data: Vec<u8>

At least 44 bytes of random data.

WhoAreYou

Handshake packet to establish identities.

Fields of WhoAreYou

magic: [u8; 32]

SHA256(dest-node-id || "WHOAREYOU").

token: AuthTag

The auth-tag of the request.

id_nonce: Nonce

The id-nonce to prevent handshake replays.

enr_seq: u64

Highest known ENR sequence number of node.

AuthMessage

Message sent with an extended authentication header.

Fields of AuthMessage

tag: Tag

The XOR(SHA256(dest-node-id), src-node-id).

auth_header: AuthHeader

Authentication header.

message: Vec<u8>

The encrypted message including the authentication header.

Message

A standard discv5 message.

Fields of Message

tag: Tag

The XOR(SHA256(dest-node-id), src-node-id).

auth_tag: AuthTag

12 byte Authentication nonce.

message: Vec<u8>

The encrypted message as raw bytes.

Implementations

impl Packet

pub fn random(tag: Tag) -> Packet

Generates a Packet::Random given a tag.

pub fn auth_tag(&self) -> Option<&AuthTag>

The authentication tag for all packets except WHOAREYOU.

pub fn is_whoareyou(&self) -> bool

Returns true if the packet is a WHOAREYOU packet.

pub fn is_random(&self) -> bool

Returns true if the packet is a RANDOM packet.

pub fn encode(&self) -> Vec<u8>

Encodes a packet to bytes.

fn decode_whoareyou(data: &[u8]) -> Result<Self, PacketError>

Decodes a WHOAREYOU packet.

fn decode_standard_message(tag: Tag, data: &[u8]) -> Result<Self, PacketError>

Decodes a regular message (or RandomPacket) into a Packet.

fn decode_auth_header(
    tag: Tag,
    data: &[u8],
    rlp_length: usize
) -> Result<Self, PacketError>

Decodes a message that contains an authentication header.

pub fn decode(data: &[u8], magic_data: &Magic) -> Result<Self, PacketError>

Decode raw bytes into a packet. The magic value (SHA2256(node-id, b"WHOAREYOU")) is passed as a parameter to check for the magic byte sequence.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl PartialEq<Packet> for Packet

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

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

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

This method tests for !=.

impl StructuralPartialEq for Packet