omniauth-dice 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3e3c1ff7fd4f0c7142db67485b2b0703ad6b2cf
-  data.tar.gz: 26df981c24baad50882bc51060fad08f249bc1f2
+  metadata.gz: 154d96bc38ba5c4c2dfe1a7facf22892ce61ae26
+  data.tar.gz: 45e25aea48dd2454a1bf0720e8859b360e09c141
 SHA512:
-  metadata.gz: c34aa758d14625e472abaacd4172219f8dac681fc1f872a0f415b11a6fa6fe2cd75f70ef26c724785598e1b3a7fa12bac4d29a5f12160c546393d14020fa741f
-  data.tar.gz: 876d1e5bd078eb0dde3ecff94969a85365223d5e1fccddf9978ce8780d1c7724d8e9d24c65676ef80350712c0c10e91970f264979892b81689f7e36ea1855aad
+  metadata.gz: 9b876975f32c4b617ddf876371876ad3265671658b41807d00d3d6295e5ee3907b1eba5c18747929936bef112c55104034c1dd41cb706f457fc70c97c6b21d44
+  data.tar.gz: 111cd2f06332c91b1eb18230e6a650c03e358b9063add3754015c028faadd7f7467a1d10eb406acf316ffee440d0a587d193574a71dc642d4bfb6ba89f7622ff

data/README.md

@@ -10,8 +10,8 @@ a user's X509 certificate DN string to an Enterprise CAS server via REST.
 ## Installation
 
 Add this line to your application's Gemfile:
-```ruby
-gem 'omniauth-dice'
+
+    gem 'omniauth-dice', '~> 0.1'
 
 And then execute:
 
@@ -20,7 +20,6 @@ And then execute:
 Or install it yourself with:
 
     $ gem install omniauth-dice
-```
 
 ## Usage
 
@@ -80,6 +79,40 @@ Full configuration options are as follows:
   Defaults to attempting DN common name -> full name -> first & last name  
   Valid options are: :cn, :full_name, :first_last_name to override
 
+## auth_hash Results
+
+The session's omniauth['auth'] hash will resond with the following structure:
+
+```
+{
+  "provider"=>"dice",
+  "uid"=>"cn=steven haddox,ou=rails,ou=ruby,ou=a,o=developer,c=us",
+  "info"=>{
+    "dn"=>"cn=steven haddox,ou=rails,ou=ruby,ou=a,o=developer,c=us",
+    "email"=>"steven.haddox@example.org",
+    "name"=>"steven haddox",
+    "primary_visa?"=>false,
+    "likely_npe?"=>false
+    # ...<other fields dynamically inserted>...
+  },
+  "extra"=>{
+    "raw_info"=>{
+      # ...parsed response from CAS server...
+    }
+  }
+}
+```
+
+The `provider`, `uid`, `info`, and `extra` fields follow omniauth best
+practices but there are a few computed fields from omniauth-dice worth being
+aware of:
+
+* `likely_npe?`: [Boolean] This field tries to detect if the client  
+  certificate / DN comes from a non-person entity (e.g., server) or a person.
+* `primary_visa?`: [Boolean] If the CAS server responds with an array of  
+  `visas`, this attribute will indicate if a specific visa is present.
+* `name`: [String] Returns the client's name as configured or uses defaults.
+
 ### SSL Client Certificate Notes
 
 `Faraday` (the HTTP library used by OmniAuth) can accept certificate paths:

data/lib/omniauth/dice/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Dice
-    VERSION = '0.1.7'
+    VERSION = '0.1.8'
   end
 end

data/lib/omniauth/strategies/dice.rb

@@ -217,7 +217,7 @@ module OmniAuth
 
       # Identify if there's a domain w/ TLD in the common_name
       def auth_cn_with_tld?(common_name)
-        !!( common_name =~ /\w{3}\.\w+(\.\w{3,}+)?/ )
+        !!( common_name =~ /\w{2}\.\w+(\.\w{3,}+)?/ )
       end
 
       # Determine if the auth_hash does not have an email address

data/spec/omniauth/strategies/dice_spec.rb

@@ -157,6 +157,20 @@ describe OmniAuth::Strategies::Dice do
         expect(npe).to eq(false)
       end
     end
+
+    it "should identify sample DNs as NPE / non-NPE properly" do
+      samples = [
+        {dn: '/C=US/O=A.D. Velopment/OU=AaA/OU=BBB/OU=C001/CN=JACKELOPE JERRY JR. 2B3C4D', result: false},
+        {dn: '/C=US/O=A.D. Velopment/OU=AaA/OU=BBB/OU=C001/CN=AARDVARK A.ALAN-A- 1A2B3C', result: false},
+        {dn: '/C=US/O=A.D. Velopment/OU=AaA/OU=BBB/OU=C001/CN=uc-1-100-10-100.vm.openstack.example.org', result: true},
+        {dn: '/C=US/O=A.D. Velopment/OU=AaA/OU=BBB/OU=C001/CN=aa.2-200-20-200.vm.openstack.example.org', result: true},
+        {dn: '/C=US/O=A.D. Velopment/OU=AaA/OU=BBB/OU=C001/CN=go.vm', result: true}
+      ]
+      samples.each do |dn_pair|
+        npe = @dice.send( :identify_npe, @all_info.merge({'common_name' => dn_pair[:dn]}) )
+        expect(npe).to eq(dn_pair[:result])
+      end
+    end
   end
 
   context ".primary_visa?" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-dice
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Steven Haddox
@@ -30,7 +30,7 @@ cert_chain:
   42qdwEXvvkODZAD6KAIXPdmbMfBgPbcd+B/4eUA0PyKo+4dgL1NuqX4MPWToevIZ
   O8EKLF2X7NmC6FY1bOsSj/J8r1SOkx0rxgF+geRvY1P+hfNjDfxTsjU=
   -----END CERTIFICATE-----
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -407,7 +407,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: DN Interoperable Conversion Expert Strategy