Status: Archived
This repository has been archived and is no longer maintained., (*1)
, (*2)
Firebase Token Generator - PHP
WARNING: This token generator is compatible with versions 1.x.x and 2.x.x of the Firebase SDK. If you are using the 3.x.x SDK, please refer to the documentation here., (*3)
Firebase Custom Login
gives you complete control over user authentication by allowing you to authenticate users
with secure JSON Web Tokens (JWTs). The auth payload stored in those tokens is available
for use in your Firebase security rules.
This is a token generator library for PHP which allows you to easily create those JWTs., (*4)
Dependencies
The Firebase PHP token generator library depends on PHP-JWT., (*5)
A Note About Security
IMPORTANT: Because token generation requires your Firebase Secret, you should only generate
tokens on trusted servers. Never embed your Firebase Secret directly into your application and
never share your Firebase Secret with a connected client., (*6)
Installation
Using composer:, (*7)
composer require firebase/token-generator
Generating Tokens
To generate tokens, you'll need your Firebase Secret which you can find by entering your Firebase
URL into a browser and clicking the "Secrets" tab on the left-hand navigation menu., (*8)
Once you've downloaded the library and grabbed your Firebase Secret, you can generate a token with
this snippet of PHP code:, (*9)
use Firebase\Token\TokenException;
use Firebase\Token\TokenGenerator;
try {
$generator = new TokenGenerator('<YOUR_FIREBASE_SECRET>');
$token = $generator
->setData(array('uid' => 'exampleID'))
->create();
} catch (TokenException $e) {
echo "Error: ".$e->getMessage();
}
echo $token;
The payload passed to setData() is made available for use within your
security rules via the auth variable.
This is how you pass trusted authentication details (e.g. the client's user ID)
to your Firebase security rules. The payload can contain any data of your
choosing, however it must contain a "uid" key, which must be a string of less
than 256 characters. The generated token must be less than 1024 characters in
total., (*10)
Token Options
Token options can be set to modify how Firebase treats the token. Available options are:, (*11)
-
expires (number or DateTime) - A timestamp (as number of seconds since the epoch) or a DateTime
denoting the time after which this token should no longer be valid., (*12)
-
notBefore (number or DateTime) - A timestamp (as number of seconds since the epoch) or a DateTime
denoting the time before which this token should be rejected by the server., (*13)
-
admin (boolean) - Set to True if you want to disable all security rules for this client.
This will provide the client with read and write access to your entire Firebase database., (*14)
-
debug (boolean) - Set to True to enable debug output from your security rules. You should
generally not leave this set to True in production (as it slows down the rules implementation
and gives your users visibility into your rules), but it can be helpful for debugging., (*15)
Here is an example of how to set options:, (*16)
use Firebase\Token\TokenGenerator;
$generator = new TokenGenerator('<YOUR_FIREBASE_SECRET>');
// Using setOption()
$token = $generator
->setOption('admin', true)
->setOption('debug', true)
->setData(array('uid' => 'exampleID'))
->create();
// Using setOptions()
$token = $generator
->setOptions(array(
'admin' => true,
'debug' => true
))
->setData(array('uid' => 'exampleID'))
->create();
Changelog
3.0.0 - 2015-11-18
- Update PHP-JWT to >= 3.0
- Remove deprecated
Services_FirebaseTokenGenerator and update tests
- Thanks to @jeromegamez for the above contributions!
2.1.0 - 2015-06-22
2.0.1 - 2015-04-02
- Specifying the PHP-JWT version more specifically.
2.0.0 - 2014-09-15
- Additional validation to ensure tokens contain a "uid" field unless they have
the "admin" option set to
true.
1.0.0 - 2014-09-04
Wallogit.com
