authkestra-providers-github 0.1.1

GitHub OAuth provider for the authkestra framework
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

# authkestra-providers-github

GitHub OAuth2 provider for [authkestra](https://github.com/marcjazz/authkestra).

This crate provides a concrete implementation of the `OAuthProvider` trait for GitHub, allowing easy integration of GitHub authentication into your application.

## Features

- Authorization Code exchange for GitHub identities.
- Token refresh support (GitHub requires specific App settings for this).
- Token revocation support.
- Automatic mapping of GitHub user profiles to `Identity`.

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
authkestra-providers-github = "0.1.1"
authkestra-core = "0.1.1"
```

### Example

```rust
use authkestra_providers_github::GithubProvider;
use authkestra_core::OAuthProvider;

#[tokio::main]
async fn main() {
    let provider = GithubProvider::new(
        "CLIENT_ID".to_string(),
        "CLIENT_SECRET".to_string(),
        "http://localhost:3000/auth/callback/github".to_string(),
    );

    // Generate the authorization URL
    let state = "random_state_string";
    let scopes = vec!["user:email", "read:user"];
    let auth_url = provider.get_authorization_url(state, &scopes, None);
    
    println!("Redirect user to: {}", auth_url);
}
```

## Configuration

The `GithubProvider` can be further configured:

```rust
let provider = GithubProvider::new(client_id, client_secret, redirect_uri)
    .with_authorization_url("https://github.com/login/oauth/authorize".to_string());
```

## Part of authkestra

This crate is part of the [authkestra](https://github.com/marcjazz/authkestra) workspace.