Crate yew_oauth2

Yew components to implement OAuth2 and OpenID Connect logins.

OAuth2 or Open ID Connect

This crate supports both plain OAuth2 and Open ID Connect (OIDC). OIDC layers a few features on top of OAuth2 (like logout URLs, discovery, …).

In order to use OIDC, you will need to enable the feature openidconnect.

Example

NOTE: Also see the readme for more examples.

Can be used like:

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

pub struct MyApplication;

impl Component for MyApplication {
  type Message = ();
  type Properties = ();

  fn create(ctx: &Context<Self>) -> Self {
    Self
  }

  fn view(&self, ctx: &Context<Self>) -> Html {
    let login = ctx.link().callback_once(|_: MouseEvent| {
      OAuth2Dispatcher::<Client>::new().start_login();
    });
    let logout = ctx.link().callback_once(|_: MouseEvent| {
      OAuth2Dispatcher::<Client>::new().logout();
    });

    let config = Config {
      client_id: "my-client".into(),
      auth_url: "https://my-sso/auth/realms/my-realm/protocol/openid-connect/auth".into(),
      token_url: "https://my-sso/auth/realms/my-realm/protocol/openid-connect/token".into(),
    };

    html!(
      <OAuth2 config={config}>
        <Failure><FailureMessage/></Failure>
        <Authenticated>
          <button onclick={logout}>{ "Logout" }</button>
        </Authenticated>
        <NotAuthenticated>
          <button onclick={login.clone()}>{ "Login" }</button>
        </NotAuthenticated>
      </OAuth2>
    )
  }
}

Modules

agent

The Yew agent, working in the background to manage the session and refresh tokens.

components

Components used when rendering HTML

config

Configuration

context

The Authentication Context

oauth2

Common used OAuth2 features

openidopenid

Common used Open ID Connect features

prelude

The prelude, includes most things you will need.