Axum example

[ikehz]

I've been working on an example with Axum, & would be happy to clean it up & link here along with the Actix contributed example.

I'm not a security engineer, so it would need to be reviewed with some skepticism.

[ramosbugs]

Sounds good! I'll try to find some time to review it if you submit a PR adding the contributed example link.

[thor314]

@ikehz, would love to see your example if you've time.

[pickfire]

I have added an axum example for 5.0.0-alpha.4. I find the addition of type states made it a mess, I wonder how should I pass around the type next time.

struct AppState {
    client: BasicClient<EndpointSet, EndpointNotSet, EndpointNotSet, EndpointSet, EndpointSet>,
    ...
}

https://github.com/pickfire/oauth2-axum

[ramosbugs]

I have added an axum example for 5.0.0-alpha.4. I find the addition of type states made it a mess, I wonder how should I pass around the type next time.

I'd suggest using a type alias.

[Trojanking123]

I have added an axum example for 5.0.0-alpha.4. I find the addition of type states made it a mess, I wonder how should I pass around the type next time.

I'd suggest using a type alias.

it's very hard to claim a Client varibal now.

[ramosbugs]

it's very hard to claim a Client varibal now.

What does "claim" mean in this context?

Regarding type aliases, is there some complexity I'm missing here? Something like this (applying it to @pickfire's snippet above) seems straightforward to use within application code:

pub type Oauth2ClientWithEndpoints = BasicClient<EndpointSet, _, _, EndpointSet, EndpointSet>;

struct AppState {
    client: Oauth2ClientWithEndpoints,
    ...
}

Note that _ can be used in place of EndpointNotSet since it's the default generic type for each type state generic.

This is just one additional line of code for the benefit of having the correct set of client endpoints enforced at compile time and avoiding configuration errors at runtime, which has caused issues for other users in the past.

[KevinMGranger]

Worth nothing that there's an existing example in the axum repo.

(Yes, it improperly handles csrf, but that's explicitly called out and there's a PR to fix that.)

[ulodciv]

I updated to v5 and ended up having to create two type aliases instead of one.

pub type GoogleClient = oauth2::Client<
    BasicErrorResponse,
    StandardTokenResponse<GoogleTokenExtraFields, BasicTokenType>,
    BasicTokenIntrospectionResponse,
    StandardRevocableToken,
    BasicRevocationErrorResponse,
    EndpointSet,
    EndpointNotSet,
    EndpointNotSet,
    EndpointSet,
    EndpointSet,
>;

pub type GoogleClientCreator = oauth2::Client<
    BasicErrorResponse,
    StandardTokenResponse<GoogleTokenExtraFields, BasicTokenType>,
    BasicTokenIntrospectionResponse,
    StandardRevocableToken,
    BasicRevocationErrorResponse,
>;

The first one goes in the AppState:

#[derive(Clone)]
pub struct AppState {
    pub(crate) oauth_client: GoogleClient,
    pub(crate) http_client: reqwest::Client,
}

The "creator" is used to get the new method:

    oauth_client: GoogleClientCreator::new(client_id)
        .set_client_secret(client_secret)
        .set_auth_uri(auth_url)
        .set_token_uri(token_url)
        .set_redirect_uri(redirect_url)
        .set_revocation_url(revocation_url),