cf-uaa-lib 2.0.1 → 2.1.0

data/README.md

@@ -1,5 +1,5 @@
 # CloudFoundry UAA Gem
-
+[![Build Status](https://travis-ci.org/cloudfoundry/cf-uaa-lib.png)](https://travis-ci.org/cloudfoundry/cf-uaa-lib)
 [![Gem Version](https://badge.fury.io/rb/cf-uaa-lib.png)](http://badge.fury.io/rb/cf-uaa-lib)
 
 Client gem for interacting with the [CloudFoundry UAA server](https://github.com/cloudfoundry/uaa)

data/lib/uaa/token_coder.rb

@@ -176,6 +176,18 @@ class TokenCoder
   # @param [String] auth_header (see Scim.initialize#auth_header)
   # @return (see TokenCoder.decode)
   def decode(auth_header)
+    decode_at_reference_time(auth_header, Time.now.to_i)
+  end
+
+  # Returns hash of values decoded from the token contents,
+  # taking reference_time as the comparison time for expiration. If the
+  # audience_ids were specified in the options to this instance (see #initialize)
+  # and the token does not contain one or more of those audience_ids, an
+  # AuthError will be raised. AuthError is raised if the token has expired.
+  # @param [String] auth_header (see Scim.initialize#auth_header)
+  # @param [Integer] reference_time
+  # @return (see TokenCoder.decode)
+  def decode_at_reference_time(auth_header, reference_time)
     unless auth_header && (tkn = auth_header.split(' ')).length == 2 && tkn[0] =~ /^bearer$/i
       raise InvalidTokenFormat, "invalid authentication header: #{auth_header}"
     end
@@ -185,12 +197,11 @@ class TokenCoder
       raise InvalidAudience, "invalid audience: #{auds}"
     end
     exp = reply[:exp] || reply['exp']
-    unless exp.is_a?(Integer) && exp > Time.now.to_i
+    unless exp.is_a?(Integer) && exp > reference_time
       raise TokenExpired, "token expired"
     end
     reply
   end
-
 end
 
 end

data/lib/uaa/version.rb

@@ -14,6 +14,6 @@
 # Cloud Foundry namespace
 module CF
   module UAA
-    VERSION = "2.0.1"
+    VERSION = "2.1.0"
   end
 end

data/spec/token_coder_spec.rb

@@ -156,9 +156,25 @@ describe TokenCoder do
     expect { subject.decode("bEaReR #{tkn}") }.to raise_exception(DecodeError)
   end
 
-  it "raises an error if the token has expired" do
-    tkn = subject.encode({'foo' => "bar", 'exp' => Time.now.to_i - 60 })
-    expect { subject.decode("bEaReR #{tkn}") }.to raise_exception(TokenExpired)
+  context "when the implied expiration check is now" do
+    it "raises an error if the token has expired" do
+      tkn = subject.encode({'foo' => "bar", 'exp' => Time.now.to_i - 60 })
+      expect { subject.decode("bEaReR #{tkn}") }.to raise_exception(TokenExpired)
+    end
+  end
+
+  context "when an explicit time stamp is provided for the expiration check" do
+    it "raises an error if the token was expired at the specified time" do
+      tkn = subject.encode({'foo' => "bar", 'exp' => Time.now.to_i - 30 })
+      expect { subject.decode_at_reference_time("bEaReR #{tkn}", Time.now.to_i - 20) }.to raise_exception(TokenExpired)
+    end
+
+    it "returns the decoded token if it was valid at the specified time" do
+      tkn = subject.encode({'foo' => "bar", 'exp' => Time.now.to_i - 30 })
+      result = subject.decode_at_reference_time("bEaReR #{tkn}", Time.now.to_i - 100)
+      result.should_not be_nil
+      result["foo"].should == "bar"
+    end
   end
 
   it "decodes a token without validation" do
@@ -166,10 +182,7 @@ describe TokenCoder do
     info = TokenCoder.decode(token, :verify => false)
     info["id"].should_not be_nil
     info["email"].should == "olds@vmware.com"
-    #puts Time.at(info[:exp].to_i)
-    #BaseCli.pp info
   end
-
 end
 
 end

metadata

@@ -1,10 +1,15 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: cf-uaa-lib
-version: !ruby/object:Gem::Version
-  version: 2.0.1
+version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: 
+  segments: 
+  - 2
+  - 1
+  - 0
+  version: 2.1.0
 platform: ruby
-authors:
+authors: 
 - Dave Syer
 - Dale Olds
 - Joel D'sa
@@ -13,111 +18,135 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-04-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: multi_json
-  requirement: &72034680 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *72034680
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &72046690 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *72046690
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &72043770 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *72043770
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &72573760 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *72573760
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: simplecov
-  requirement: &72570770 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *72570770
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: simplecov-rcov
-  requirement: &72569260 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *72569260
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: ci_reporter
-  requirement: &72584110 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *72584110
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: json_pure
-  requirement: &72583470 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *72583470
-description: Client library for interacting with the CloudFoundry User Account and
-  Authorization (UAA) server.  The UAA is an OAuth2 Authorization Server so it can
-  be used by webapps and command line apps to obtain access tokens to act on behalf
-  of users.  The tokens can then be used to access protected resources in a Resource
-  Server.  This library is for use by UAA client applications or resource servers.
-email:
+  version_requirements: *id008
+description: Client library for interacting with the CloudFoundry User Account and Authorization (UAA) server.  The UAA is an OAuth2 Authorization Server so it can be used by webapps and command line apps to obtain access tokens to act on behalf of users.  The tokens can then be used to access protected resources in a Resource Server.  This library is for use by UAA client applications or resource servers.
+email: 
 - dsyer@vmware.com
 - olds@vmware.com
 - jdsa@vmware.com
 - vidya@vmware.com
 - ltaylor@vmware.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - .yardopts
@@ -145,34 +174,37 @@ files:
 - spec/token_coder_spec.rb
 - spec/token_issuer_spec.rb
 homepage: https://github.com/cloudfoundry/cf-uaa-lib
-licenses:
+licenses: 
 - Apache 2.0
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 254911853
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 254911853
+      version: "0"
 requirements: []
+
 rubyforge_project: cf-uaa-lib
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Client library for CloudFoundry UAA
 test_files: []
+