Trait oxide_auth::code_grant::accesstoken::Request

pub trait Request {
    // Required methods
    fn valid(&self) -> bool;
    fn code(&self) -> Option<Cow<'_, str>>;
    fn authorization(&self) -> Option<(Cow<'_, str>, Cow<'_, [u8]>)>;
    fn client_id(&self) -> Option<Cow<'_, str>>;
    fn redirect_uri(&self) -> Option<Cow<'_, str>>;
    fn grant_type(&self) -> Option<Cow<'_, str>>;
    fn extension(&self, key: &str) -> Option<Cow<'_, str>>;

    // Provided method
    fn allow_credentials_in_body(&self) -> bool { ... }
}

Trait based retrieval of parameters necessary for access token request handling.

Required Methods

fn valid(&self) -> bool

Received request might not be encoded correctly. This method gives implementors the chance to signal that a request was received but its encoding was generally malformed. If this is the case, then no other attribute will be queried. This method exists mainly to make frontends straightforward by not having them handle special cases for malformed requests.

fn code(&self) -> Option<Cow<'_, str>>

The authorization code grant for which an access token is wanted.

fn authorization(&self) -> Option<(Cow<'_, str>, Cow<'_, [u8]>)>

User:password of a basic authorization header.

fn client_id(&self) -> Option<Cow<'_, str>>

The client_id, optional parameter for public clients.

fn redirect_uri(&self) -> Option<Cow<'_, str>>

Valid request have the redirect url used to request the authorization code grant.

fn grant_type(&self) -> Option<Cow<'_, str>>

Valid requests have this set to “authorization_code”

fn extension(&self, key: &str) -> Option<Cow<'_, str>>

Retrieve an additional parameter used in an extension

Provided Methods

fn allow_credentials_in_body(&self) -> bool

Credentials in body should only be enabled if use of HTTP Basic is not possible.

Allows the request body to contain the client_secret as a form parameter. This is NOT RECOMMENDED and need not be supported. The parameters MUST NOT appear in the request URI itself.

Under these considerations, support must be explicitely enabled.

Implementors