rocket-firebase-auth

Firebase Auth with Rocket, batteries included

Tiny: rocket-firebase-auth is tiny, with features allowing you to make it even tinier
Does one thing well: Encodes/decodes Firebase JWT tokens in Rocket apps, and that's it

Getting started

1. Set Firebase service account keys as env variables

If you haven't already, create a service account in Firebase for the Rocket backend you are creating. Generate a new private key and copy-paste the generated json into a firebase-credentials.json file.

{
  "type": "*********",
  "project_id": "***********",
  "private_key_id": "*************",
  "private_key": "*****************",
  "client_email": "*********",
  "client_id": "*******",
  "auth_uri": "********",
  "token_uri": "********",
  "auth_provider_x509_cert_url": "********",
  "client_x509_cert_url": "********"
}

Don't forget to add the firebase-credentials.json file to your .gitignore.

# Firebase service account's secret credentials
firebase-credentials.json

2. Create a `FirebaseAuth` instance and add to server state

Add rocket-firebase-auth to your project.

rocket_firebase_auth = "0.2.0"

Now, you can create a FirebaseAuth struct by reading the json file with a helper function included with the default import.

use rocket::{Build, Rocket};
use rocket_firebase_auth::FirebaseAuth;

pub struct ServerState {
    pub auth: FirebaseAuth
}

#[rocket::launch]
async fn rocket() -> Rocket<Build> {
    let firebase_auth = FirebaseAuth::try_from_json_file("firebase-credentials.json")
        .expect("Failed to read Firebase credentials");

    rocket::build()
        .mount("/", routes![hello_world])
        .manage(ServerState {
            auth: firebase_auth
        })
}

3. Verify the token from the endpoint function

On endpoints that we except to receive Authorization headers containing our encoded Firebase tokens from the client, we can add a field to the endpoint function. Running the Jwt::verify() function will decode the token, where you can get the Firebase uid.

#[get("/")]
async fn hello_world(
    state: &State<ServerState>,
    token: BearerToken,
) -> status::Accepted<String> {
    let uid = Jwt::verify(&token.0, &state.auth)
        .map_ok(|decoded_token| decoded_token.uid)
        .await
        .unwrap();

    status::Accepted(Some(format!("uid: {uid}")))
}

Example project

For a more detailed example with a frontend example as well, checkout the example projects .

Contribute

Any contributions (PRs, Issues) are welcomed!

License

MIT

rocket_firebase_auth 0.2.3