Struct CsrfToken

pub struct CsrfToken(/* private fields */);

Available on crate feature experimental-oidc only.

Value used for CSRF protection via the state parameter.

Implementations

impl CsrfToken

pub fn new_random() -> CsrfToken

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

pub fn new_random_len(num_bytes: u32) -> CsrfToken

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.

pub fn new(s: String) -> CsrfToken

Create a new CsrfToken to wrap the given String.

pub fn secret(&self) -> &String

Get the secret contained within this CsrfToken.

Security Warning

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

pub fn into_secret(self) -> String

Get the secret contained within this CsrfToken.

Security Warning

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

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CsrfToken

fn deserialize<__D>( __deserializer: __D, ) -> Result<CsrfToken, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CsrfToken

Available on crate feature timing-resistant-secret-traits only.

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CsrfToken

Available on crate feature timing-resistant-secret-traits only.

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CsrfToken

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CsrfToken