@peapodtech/firebasedeviceflow

Firebase Device Flow

Firebase authentication via OAuth2 'Device Flow' for Node.js CLI applications on limited input devices (i.e. IoT).

Provider Setup

Google

Docs

1. Create new OAuth client ID credentials in the GCP Credentials page. For the Application Type, select "TVs and Limited Input devices".
2. Copy the Client ID and Client Secret values into either an .env file, or input directly into the config object (see test.ts).

GitHub

Docs

1. Create a new GitHub OAuth app (guide).
2. Copy the Client ID and Client Secret values into either an .env file, or input directly into the config object (see test.ts).
3. Set the Client ID and Client Secret fields in the Firebase Console under Authentication > Sign-in method > Sign-in providers > GitHub
4. Finally, copy the Authorization callback URL from the Firebase Console to your GitHub OAuth app's settings.

Example Usage

See test.ts.

3. Import FirebaseDeviceFlow.
4. Initialize your Firebase app.
5. Pass Firebase app reference and OAuth config object to DeviceFlowUI constructor. If any parameters are absent from the OAuth config object, the relevant auth provider will be excluded from the UI.
6. Execute DeviceFlowUI.signIn(). This will return a Promise<UserCredential>.

How It Works

Google has a great resource on "OAuth 2.0 for TV and Limited-Input Device Applications".

Development

Build and test with the usual npm run build, npm run test. For testing, you will have to initialize your own Firebase app and provider support.

Requirements

• Node.js and npm
• Dependencies (install with npm install)

Todo

• [X] Convert to Typescript
• [X] Change package structure for easier import (currently import { DeviceFlowUI } from 'FirebaseDeviceFlow/dist/FirebaseDeviceFlow';)
• [X] Fix testing
• [ ] 'Slow down' error code handling?
• [ ] Add more providers?

FAQ

I'm getting X error, wtf is going on?

Make sure you've done the following:

1. All per-provider setup (outlined above)