Struct oauth2::CsrfToken

pub struct CsrfToken(_);

Value used for CSRF protection via the state parameter.

Implementations

impl CsrfToken

pub fn new_random() -> Self

Generate a new random, base64-encoded 128-bit CSRF token.

pub fn new_random_len(num_bytes: u32) -> Self

Generate a new random, base64-encoded CSRF token of the specified length.

Arguments

• num_bytes - Number of random bytes to generate, prior to base64-encoding.

Trait Implementations

impl Clone for CsrfToken

fn clone(&self) -> CsrfToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CsrfToken

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

Formats the value using the given formatter.

impl PartialEq<CsrfToken> for CsrfToken

fn eq(&self, other: &CsrfToken) -> 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 SecretNewType<String> for CsrfToken

fn new(s: String) -> Self

Create a new CsrfToken to wrap the given String.

fn secret(&self) -> &String

Get the secret contained within this CsrfToken.

Security Warning

Leaking this value may compromise the security of the OAuth2 flow.

impl StructuralPartialEq for CsrfToken