https://github.com/ctron/yew-oauth2

General purpose OAuth2 component for Yew
https://github.com/ctron/yew-oauth2

authentication oauth2 oidc openid-connect yew

Last synced: 3 months ago
JSON representation

General purpose OAuth2 component for Yew

• Host: GitHub
• URL: https://github.com/ctron/yew-oauth2
• Owner: ctron
• License: apache-2.0
• Created: 2022-04-07T14:59:19.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-19T07:04:08.000Z (7 months ago)
• Last Synced: 2024-05-19T05:41:59.039Z (6 months ago)
• Topics: authentication, oauth2, oidc, openid-connect, yew
• Language: Rust
• Homepage:
• Size: 189 KB
• Stars: 42
• Watchers: 3
• Forks: 17
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-yew - yew-oauth2 - A plain Yew OAuth2/OpenIDConnect component, not tied to any CSS framework. (Crates / Components)

README

        
# OAuth2 (and OIDC) component for Yew

[![crates.io](https://img.shields.io/crates/v/yew-oauth2.svg)](https://crates.io/crates/yew-oauth2)

[![docs.rs](https://docs.rs/yew-oauth2/badge.svg)](https://docs.rs/yew-oauth2)

[![CI](https://github.com/ctron/yew-oauth2/actions/workflows/ci.yaml/badge.svg)](https://github.com/ctron/yew-oauth2/actions/workflows/ci.yaml)

Add to your `Cargo.toml`:

```toml

yew-oauth2 = "0.11"

```

By default, the `yew-nested-router` integration for [`yew-nested-router`](https://github.com/ctron/yew-nested-router) is

disabled. You can enable it using:

```toml

yew-oauth2 = { version = "0.10", features = ["yew-nested-router"] }

```

## OpenID Connect

OpenID Connect requires an additional dependency and can be enabled using the feature `openid`.

## Examples

A quick example of how to use it (see below for more complete examples):

```rust

use yew::prelude::*;

use yew_oauth2::prelude::*;

use yew_oauth2::oauth2::*; // use `openid::*` when using OpenID connect

#[function_component(MyApplication)]

fn my_app() -> Html {

    let config = Config::new(

        "my-client",

        "https://my-sso/auth/realms/my-realm/protocol/openid-connect/auth",

        "https://my-sso/auth/realms/my-realm/protocol/openid-connect/token"

    );

    html!(

    

      

    

  )

}

#[function_component(MyApplicationMain)]

fn my_app_main() -> Html {

    let agent = use_auth_agent().expect("Must be nested inside an OAuth2 component");

    let login = use_callback(agent.clone(), |_, agent| {

        let _ = agent.start_login();

    });

    let logout = use_callback(agent, |_, agent| {

        let _ = agent.logout();

    });

    html!(

    <>

      

      

        { "Logout" }

      

      

        { "Login" }

      

    >

  )

}

```

This repository also has some complete examples:





[yew-oauth2-example](yew-oauth2-example/) 



A complete example, hiding everything behind a "login" page, and revealing the content once the user logged in.


Use with either OpenID Connect or OAuth2.





[yew-oauth2-redirect-example](yew-oauth2-redirect-example/) 



A complete example, showing the full menu structure, but redirecting the user automatically to the login server

when required.


Use with either OpenID Connect or OAuth2.





### Testing

Testing the example projects locally can be done using a local Keycloak instance and `trunk`.

Start the Keycloak instance using:

```shell

podman-compose -f develop/docker-compose.yaml up

```

Then start `trunk` with the local developer instance:

```shell

cd yew-oauth2-example # or yew-oauth2-redirect-example

trunk serve

```

And navigate your browser to [http://localhost:8080](http://localhost:8080).

**NOTE:** It is important to use `http://localhost:8080` instead of e.g. `http://127.0.0.1:8080`, as Keycloak is

configured by default to use `http://localhost:*` as a valid redirect URL when in dev-mode. Otherwise, you will get

an "invalid redirect" error from Keycloak.