Struct dpmaster_proto::messages::Challenge

pub struct Challenge(_);

“Password” to authenticate messages

Contained in a getinfo message and infoResponse message.

The dpmaster protocol uses UDP which is spoofable so, to authenticate datagrams and prevent denial-of-service in the (heartbeat →) getinfo → infoResponse chain, a “password” is used that should only be known to the game server and the master server.

Implementations

impl Challenge

pub fn new<T: Into<Vec<u8>>>(t: T) -> Result<Self, InvalidChallengeError>

Creates a new Challenge from a container of bytes.

Examples

let challenge = Challenge::new(*b"A_ch4Lleng3")?;

Errors

Will return an EmptyError if the supplied bytes are empty.

assert!(matches!(Challenge::new(*b"").unwrap_err(), InvalidChallengeError::Empty(..)));

Will return InvalidByteError if a supplied byte is not ASCII printable (code 33 to 126) or is one of the disallowed characters \, /, ;, " or %.

assert!(matches!(Challenge::new(*b"\xFF").unwrap_err(), InvalidChallengeError::InvalidByte(..)));
assert!(matches!(Challenge::new(*b"uhoh;").unwrap_err(), InvalidChallengeError::InvalidByte(..)));

Trait Implementations

impl Debug for Challenge

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

Formats the value using the given formatter.

impl<I: SliceIndex<[u8]>> Index<I> for Challenge

type Output = <I as SliceIndex<[u8]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq<Challenge> for Challenge

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Challenge

impl StructuralEq for Challenge

impl StructuralPartialEq for Challenge