firebase_token_generator 1.0.0

data/lib/firebase_token_generator.rb

@@ -0,0 +1,82 @@
+require "json"
+require "base64"
+require "openssl"
+
+module Firebase
+
+  # This class handles generating signed authentication tokens for use with Firebase
+  class FirebaseTokenGenerator
+
+    # When creating an instance of the generator, you must provide your Firebase Application Secret
+    def initialize(secret)
+      @secret = secret
+    end
+
+    # Returns a signed Firebase Authentication Token
+    # Takes the following arguments:
+    # [auth_data] A hash of arbitrary data to be included in the token
+    # [options] An optional hash of extra claims that may be included in the token. Allowed values are:
+    #   [expires] Epoch time after which the token will no longer be valid
+    #   [notBefore] Epoch time before which the token will not be valid
+    #   [admin] If set to true, this client will bypass all security rules
+    #   [debug] If set to true, this client will receive debug information about the security rules
+    #   [simulate] (internal-only for now) Runs security rules but makes no data changes
+    #
+    # Throws ArgumentError if given an invalid option
+    def create_token(auth_data, options = {})
+      claims = create_options_claims(options)
+      claims[:v] = TOKEN_VERSION
+      claims[:iat] = Time.now.to_i
+      claims[:d] = auth_data
+      encode_token(claims)
+    end
+
+    private
+
+    TOKEN_VERSION = 0
+
+    TOKEN_SEP = "."
+
+    CLAIMS_MAP = {
+        :expires => :exp,
+        :notBefore => :nbf,
+        :admin => :admin,
+        :debug => :debug,
+        :simulate => :simulate
+    }
+
+    def create_options_claims(options)
+      opts = {}
+      options.each do |key, value|
+        if CLAIMS_MAP.include?(key.to_sym) then
+          opts[key.to_sym] = value
+        else
+          raise ArgumentError, "#{key.to_s} is not a valid option"
+        end
+      end
+      opts
+    end
+
+    def encode_token(claims)
+      encoded_header = encode_json({:typ => "JWT", :alg => "HS256"})
+      encoded_claims = encode_json(claims)
+      secure_bits = [encoded_header, encoded_claims].join(TOKEN_SEP)
+      sig = sign(secure_bits)
+      [encoded_header, encoded_claims, sig].join(TOKEN_SEP)
+    end
+
+    def encode_json(obj)
+      encode(JSON.dump(obj))
+    end
+
+    def encode(s)
+      Base64.urlsafe_encode64(s).gsub('=', '')
+    end
+
+    def sign(to_sign)
+      encode(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, @secret, to_sign))
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: firebase_token_generator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Greg Soltis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-24 00:00:00.000000000 Z
+dependencies: []
+description: A library for generating signed authentication tokens for use with Firebase.
+  Uses your app secret.
+email: greg@firebase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/firebase_token_generator.rb
+homepage: http://github.com/firebase/FirebaseTokenGenerator-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Generate Firebase Authentication Tokens
+test_files: []