Firebase Auth SDK

Rust wrapper for Firebase Authentication REST API

crates.io WTFPL

Installation

Add the following to Cargo.toml:

toml firebase-auth-sdk = "0.1.5"

How to use

First you need to get a web API_KEY from firebase project settings.

```rust let api_key: String = String::from("s6FqaFcRFd...njhB8cCjN7");

let auth = firebaseauthsdk::Auth::new(API_KEY); ```


Features

  1. Sign Up (email)
  2. Sign In (email)
  3. Send OOB Code
  4. Refresh ID Token
  5. Get User Information
  6. Update Email and Password
  7. Verify ID Token

Don't see what you need? See below for unsupported features for now.


1. Sign Up (email)

```rust let email = "something@email.com"; let password = "supersecret"; let returnsecuretoken = true;

match auth.signupemail(email, password, returnsecuretoken).await { Ok(response) => ..., Err(error) => ..., }

// response structure pub struct firebaseauthsdk::api::SignUpResponse { pub idtoken: String, pub email: String, pub refreshtoken: String, pub expiresin: String, pub localid: String, } ```

2. Sign In (email)

```rust match auth.signinemail(email, password, returnsecuretoken).await { Ok(response) => ..., Err(error) => ..., }

// response structure pub struct firebaseauthsdk::api::SignInResponse { pub kind: String, pub localid: String, pub email: String, pub displayname: String, pub idtoken: String, pub registered: bool, pub refreshtoken: Option, pub expires_in: Option, } ```

3. Send OOB Code

Send verification email

```rust match auth.verifyemail(idtoken).await { Ok(sendoobcode) => ... Err(error) => ... }

// response structure pub struct firebaseauthsdk::api::SendOobCode { pub kind: String, pub email: String, } ```

Send reset password

rust match auth.reset_password(email).await { Ok(send_oob_code) => ... Err(error) => ... }

4. Refresh ID Token

```rust match auth.refreshidtoken(refreshtoken).await { Ok(refreshidtokenresponse) => ... Err(error) => ... }

// response structure pub struct firebaseauthsdk::api::RefreshIdToken { pub accesstoken: String, pub expiresin: String, pub tokentype: String, pub refreshtoken: String, pub idtoken: String, pub userid: String, pub project_id: String, } ```

5. Get User Information

```rust match auth.getuserinfo(id_token).await { Ok(user) => ..., Err(error) => ..., }

// response structure pub struct firebaseauthsdk::api::User { pub localid: String, pub email: String, pub passwordhash: String, pub emailverified: bool, pub passwordupdatedat: u64, pub provideruserinfo: Vec, pub validsince: String, pub lastloginat: String, pub createdat: String, pub lastrefresh_at: String, }

pub struct firebaseauthsdk::api::ProviderUserInfo { pub providerid: String, pub federatedid: String, pub email: String, pub raw_id: String, } ```

6. Update Email and Password

Email

```rust match auth.changeemail(idtoken, email, returnsecuretoken).await { Ok(update_user) => ... Err(error) => ... }

// response structure pub struct firebaseauthsdk::api::UpdateUser { pub kind: String, pub localid: String, pub email: String, pub provideruserinfo: Vec, pub passwordhash: String, pub emailverified: bool, pub idtoken: Option, pub refreshtoken: Option, pub expiresin: Option, }

pub struct firebaseauthsdk::api::ProviderUserInfo { pub providerid: String, pub federatedid: String, pub email: String, pub raw_id: String, } ```

Password

rust match auth.change_password(id_token, password, return_secure_token).await { Ok(update_user) => ... Err(error) => ... }

7. Verify ID Token

```rust match auth.verifyidtoken(id_token).await { Ok(decoded) => ... Err(error) => ... }

pub struct firebaseauthsdk::api::IdTokenClaims { pub exp: u64, pub iat: u64, pub iss: String, pub sub: String, pub auth_time: u64, } ```


What are not supported yet

Sign In

Password

User