simple-oauth 0.1.0-beta.3

Simple OAuth2 login and authorization
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

# simple-oauth

Simple server-side OAuth2 login and authorization with the Authorization Code Flow, including common OAuth providers. Built on top of [`oauth2`](https://docs.rs/oauth2/5.0.0/oauth2/) and [`reqwest`](https://docs.rs/reqwest/0.13.4/reqwest/).

## Example

```rust
use simple_oauth::SimpleOAuthClient;

async fn example() {
    let oauth_client = SimpleOAuthClient::builder()
        .provider(simple_oauth::common::GitHub)
        .credentials(("client-id", "client-secret"))
        .redirect_url("https://myserver/auth/github/callback")
        .build()
        .unwrap();

    // Build the authorization URL to redirect the user
    let auth_url = oauth_client
        .authorize_url()
        .scopes(&["read:user", "user:email"])
        .build()
        .unwrap();

    // Save the state and PKCE verifier in cache/session
    let initial_state = auth_url.state;
    let pkce_verifier = auth_url.pkce_verifier;

    // In the callback route, extract the `code` and `state` query parameters
    let code = "returned_code";
    let state = "returned_state";

    // Perform token exchange
    let token = oauth_client
        .exchange_code()
        .code(code)
        .pkce_verifier(pkce_verifier)
        .build()
        .await
        .unwrap();
    let _access_token = &token.access_token;
    let _id_token = token.id_token.as_deref();

    // Get basic user info
    let user = oauth_client.get_user_info(&token.access_token).await.unwrap();
    let _id = user.id;
    let _name = user.name;
}
```

## Custom providers

If you only need authorization and token exchange, implement `SimpleOAuthProvider`:

```rust
#[derive(Debug, Clone)]
struct MyProvider;

impl simple_oauth::SimpleOAuthProvider for MyProvider {
    fn authorize_url(&self) -> &str {
        "https://provider.example/oauth/authorize"
    }

    fn token_url(&self) -> &str {
        "https://provider.example/oauth/token"
    }

    fn default_scopes(&self) -> &'static [&'static str] {
        &["profile"]
    }
}
```

Providers that support normalized profile lookup can also implement `UserInfoProvider`, which enables `SimpleOAuthClient::get_user_info`.