/ 
Firebase-1.0002
River stage zero No dependents
/ Firebase::Auth

NAME

Firebase::Auth - Auth token generation for firebase.com.

VERSION

version 1.0002

SYNOPSIS

use Firebase::Auth;

my $token = Firebase::Auth->new(token => 'xxxxxxxxx', admin => 'true', data => { uid => '1' } )->create_token();

DESCRIPTION

This module provides a Perl class to generate auth tokens for http://www.firebase.com. See https://www.firebase.com/docs/security/custom-login.html for details on the spec.

METHODS

new

Constructor.

data

Optional. If you don't specify this, then you need to specify it when you call create_token(). This should be a hash reference of all the data you want to pass for user data. This data will be available as the auth object in Firebase's security rules. If you do specify it, then it must have a uid key that contain's the users unique user id, which must be a non-null string that is no longer than 256 characters.

secret

Required. The api secret token provided by firebase.com.

admin

Defaults to \0. If set to \1 (a reference to zero or one) then full access will be granted for this token.

debug

Defaults to \0. If set to \1 (a reference to zero or one) then verbose error messages will be returned from service calls.

NOTE: To access debug info, call debug on the Firebase object after making a request.

expires

An epoch date. Defaults to expiring 24 hours from the issued date.

not_before

An epoch date. The opposite of expires. Defaults to now. The token will not be valid until after this date.

token_version

Defaults to 0.

token_separator

Defaults to .

urlbase64_encode

URL base-64 encodes a string, and then does some minor translation on it to make it compatible with Firebase.

string

The string to encode.

create_token

Generates a signed token. This is probably the only method you'll ever need to call besides the constructor.

data

Required if not specified in constructor. Defaults to the data element in the constructor. A hash reference of parameters you wish to pass to the service. If specified it must have a uid key that contain's the users unique user id, which must be a non-null string that is no longer than 256 characters.

create_claims

Generates a list of claims based upon the options provided to the constructor.

data

Required. A hash reference of user data you wish to pass to the service. It must have a uid key that contain's the users unique user id, which must be a non-null string that is no longer than 256 characters.

encode_token

Encodes, signs, and formats the data into a token.

claims

Required. A list of claims as created by create_claims

sign

Generates a signature based upon a string of data.

string

A string to sign.

EXCEPTIONS

This module may Ouch exceptions.

missing param

This will be thrown if a required parameter was not set. For example the uid key in the data payload.

param out of range

This will be thrown if a parameter is outside it's acceptable range. For example the uid key in the data payload.

AUTHOR

  • Kiran Kumar, <kiran at brainturk.com>

  • JT Smith, <jt at plainblack.com>

SUPPORT

Source Code Repository

https://github.com/rizen/Firebase

Issue Tracker

https://github.com/rizen/Firebase/issues

LICENSE AND COPYRIGHT

Copyright 2013 Kiran Kumar.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.