Turreta Rust Keycloak Crate

Turreta Rust Keycloak is a crate that enables Rust codes to work with Keycloak. Moreover, it supports multiple recent versions of Keycloak. It is a Rust library (aka crate) that provides API to work with Keycloak for user authentication, authorization, and access token validation. We have developed the crate as one of the essential components for our future projects that use the Rust programming language. As we develop those future projects, we get to test and improve the crate over time.

Rust Keycloak Crate Quickstart

There are two ways to use the crate as a dependency in a Rust codebase. Supposed the current version of the crate is 1.0.0, we could craft our Cargo.toml in one of the following ways.

First, we could use a published version of the library. As a published crate, it is available on crates.io which the Rust community’s crate registry.

[package]
name = "MyRustApp"
version = "0.1.0"
...

[dependencies]
...
turreta-rust-keycloak = { version = "1.0.0" }
...

[package]

name = "MyRustApp"

version = "0.1.0"

...

[dependencies]

...

turreta-rust-keycloak = { version = "1.0.0" }

...

Alternatively, we could use a release version from its online Git repository on GitHub. In this case, we specify the GitHub repository URL for the Turreta Rust Keycloak crate.

[package]
name = "MyRustApp"
version = "0.1.0"
...

[dependencies]
...
turreta-rust-keycloak = { version = "1.0.0", git = "https://github.com/turretadotcom/turreta-rust-keycloak", branch="master" }
...

[package]

name = "MyRustApp"

version = "0.1.0"

...

[dependencies]

...

turreta-rust-keycloak = { version = "1.0.0", git = "https://github.com/turretadotcom/turreta-rust-keycloak", branch="master" }

...

Contexts and Credentials

The Turreta Rust Keycloak crate uses the idea of context whenever our Rust codes authenticates, validates, or performs operations on behalf of a user. A context is specific to a Keycloak client (i.e., client_id and client_secret). Within a context, we work with user credentials, roles, and permissions.

Consider the following codes.

use turreta_rust_keycloak::abra;
use turreta_rust_keycloak::abra::keycloak_commons::KeycloakOpenIdConnectClientContext;

...
    KeycloakOpenIdConnectClientContext::new(String::from("my-realm"),
                                            String::from("kc-16.1.1"),
                                            String::from("kc-16.1.1-client-confidential"));
    let auth_token = abra::keycloak_openid_service::KeycloakOpenIdConnectService::authenticate(
            "http://localhost:8280/auth/",
            "kc-16.1.1-user-1",
            "password123",
            &context);

    let result = auth_token.await;
...

use turreta_rust_keycloak::abra;

use turreta_rust_keycloak::abra::keycloak_commons::KeycloakOpenIdConnectClientContext;

...

KeycloakOpenIdConnectClientContext::new(String::from("my-realm"),

String::from("kc-16.1.1"),

String::from("kc-16.1.1-client-confidential"));

let auth_token = abra::keycloak_openid_service::KeycloakOpenIdConnectService::authenticate(

"http://localhost:8280/auth/",

"kc-16.1.1-user-1",

"password123",

&context);

let result = auth_token.await;

...

Rust Keycloak Crate Quickstart

Contexts and Credentials

Search the site