Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Firebase Authentication ID Tokens #9

Open
wants to merge 26 commits into
base: master
Choose a base branch
from

Conversation

Charles-Johnson
Copy link
Contributor

@Charles-Johnson Charles-Johnson commented Dec 7, 2020

Closes #8

Usage

with blocking feature

let client = Client::new_firebase("project_id");
let id_token = client.verify_id_token("token").unwrap();

with async feature

let client = Client::firebase_builder("project_id").tokio().build();
let id_token = client.verify_id_token("token").await.unwrap();

Progress

  • Generalise GoogleKeyProvider to support both Google Signin and Firebase Authentication
  • Specialise RequiredClaims for Google Signin and Firebase Authentication
  • Specialise IdPayload for Google Signin and Firebase Authentication
  • Expose new API to verify firebase tokens
  • Check that auth_time claim is in the past for firebase tokens
  • Expand FirebaseIdPayload to cover most of firebase token payload schema
  • Unit test FirebaseClient using custom key provider
  • Refactor files

Still need to check auth_time claim is before exp claim
Abstract GoogleKeyProvider to a trait that is implemented by GoogleSignKeyProvider and FirebaseAuthenticationKeyProvider. Abstract RequiredClaims and IdPayload to associated types of the Validator trait which is implemented by GoogleSigninValidator and FirebaseValidator. Still need to expose the new API, include a check for auth_time claim for FirebaseValidator, expand FirebaseIdPayload, test FirebaseClient using custom key provider and refactor.
std::sync::Mutex::lock blocks the thread so will cause deadlocks when run inside a tokio runtime. using tokio::sync::Mutex in a TokioClient fixes this deadlock as tested in test_deadlock_prevention. It seems as though each async runtime will have to be explicitly supported
Client::firebase_builder, Client::google_signin_builder, Client::new_firebase and Client::new_google_signin to construct any kind of client from Client
No need to have to explicitly import Claims trait if method is inherent
A lot of information was being lost when converting 3rd party library errors to this crate's Error type. Error::InvalidToken is particularly unhelpful for users of this library because it represented so many different underlying errors. Error has been restructured so that it contains all underlying error information. Replaced unsafe_ignore_expiration method with unsafe_mock_timestamp method that it can be used to test firebase token validation in a deterministic way. Instead of claims_are_valid method for Validator, use validate_claims method that returns the error corresponding to a failing validation condition of the claim. This allows specific error information to propogate to the library user.
Didn't include firebase claim, couldn't find documentation explaining all possible values it could be
Also add FirebaseIdPayload and FirebaseRequiredClaims to the public API
Instead of using get_payload, using move_payload prevents unnecessary cloning of the payload
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support firebase authentication ID tokens
1 participant