devise-radius-authenticatable 0.0.1 → 0.0.2

data/README.md

@@ -36,14 +36,15 @@ This will update the devise.rb initializer. The IP and SECRET parameters specify
 
 Options:
 
-    [--uid-field=UID_FIELD]  # What database column to use for the UID
-                             # Default: uid
-    [--port=PORT]            # The port to connect to the radius server on
-                             # Default: 1812
-    [--timeout=TIMEOUT]      # How long to wait for a response from the radius server
-                             # Default: 60
-    [--retries=RETRIES]      # How many times to retry a radius request
-                             # Default: 0
+    [--uid-field=UID_FIELD]              # What database column to use for the UID
+                                         # Default: uid
+    [--port=PORT]                        # The port to connect to the radius server on
+                                         # Default: 1812
+    [--timeout=TIMEOUT]                  # How long to wait for a response from the radius server
+                                         # Default: 60
+    [--retries=RETRIES]                  # How many times to retry a radius request
+                                         # Default: 0
+    [--dictionary-path=DICTIONARY_PATH]  # The path to load radius dictionary files from
 
 Documentation
 -------------
@@ -78,6 +79,4 @@ References
 * [Devise](http://github.com/plataformatec/devise)
 * [Warden](http://github.com/hassox/warden)
 
-Released under the MIT license
-
-Copyright (c) 2012 Calvin Bascom
+Copyright (c) 2012 Calvin Bascom Released under the MIT license

data/lib/devise/models/radius_authenticatable.rb

@@ -35,6 +35,7 @@ module Devise
     # * +radius_uid_field+: The database column to store the UID in
     # * +radius_uid_generator+: A proc that takes the username and server as parameters
     #   and returns a string representing the UID
+    # * +radius_dictionary_path+: The path containing the radius dictionary files to load
     #
     # == Callbacks
     #
@@ -68,6 +69,9 @@ module Devise
           :reply_timeout => self.class.radius_server_timeout,
           :retries_number => self.class.radius_server_retries
         }
+        if self.class.radius_dictionary_path
+          options[:dict] = Radiustar::Dictionary.new(self.class.radius_dictionary_path)
+        end
 
         req = Radiustar::Request.new("#{server}:#{port}", options)
         reply = req.authenticate(username, password, secret)
@@ -94,7 +98,7 @@ module Devise
         Devise::Models.config(self, :radius_server, :radius_server_port,
                               :radius_server_secret, :radius_server_timeout,
                               :radius_server_retries, :radius_uid_field,
-                              :radius_uid_generator)
+                              :radius_uid_generator, :radius_dictionary_path)
 
         # Invoked by the RadiusAuthenticatable stratgey to perform the authentication
         # against the radius server.  The username is extracted from the authentication

data/lib/devise/radius_authenticatable.rb

@@ -26,6 +26,9 @@ module Devise
   # The procedure to use to build the unique identifier for the radius user
   mattr_accessor :radius_uid_generator
   @@radius_uid_generator = Proc.new { |username, server| "#{username}@#{server}" }
+
+  # The path to load radius dictionary files from
+  mattr_accessor :radius_dictionary_path
 end
 
 Devise.add_module(:radius_authenticatable, :route => :session, :strategy => true,

data/lib/devise/radius_authenticatable/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module RadiusAuthenticatable
-    VERSION = "0.0.1".freeze
+    VERSION = "0.0.2".freeze
   end
 end

data/lib/generators/devise_radius_authenticatable/install_generator.rb

@@ -22,6 +22,8 @@ module DeviseRadiusAuthenticatable
                  :desc => 'How long to wait for a response from the radius server')
     class_option(:retries, :default => 0,
                  :desc => 'How many times to retry a radius request')
+    class_option(:dictionary_path, :default => nil,
+                 :desc => 'The path to load radius dictionary files from')
 
     def install
       inject_into_file("config/initializers/devise.rb", default_devise_settings,
@@ -72,6 +74,13 @@ module DeviseRadiusAuthenticatable
         # config.radius_uid_generator = Proc.new do |username, server|
         #  "\#{username}@\#{server}"
         # end
+
+        # There is a very basic radius dictionary provided by default.  Most of the time
+        # this will not be sufficient, so this configuration option allows you to
+        # specify the path that contains all of the radius dictionary files that should
+        # be loaded.
+        #
+        # config.radius_dictionary_path = '#{options[:dictionary_path]}'
       CONFIG
     end
   end

data/spec/devise/models/radius_authenticatable_spec.rb

@@ -7,7 +7,8 @@ class Configurable < Admin
          :radius_uid_field => :email,
          :radius_uid_generator => Proc.new { |username, server|
            "#{username}_#{server}"
-         })
+         },
+         :radius_dictionary_path => Rails.root.join('config/dictionaries'))
 end
 
 describe Devise::Models::RadiusAuthenticatable do
@@ -41,6 +42,10 @@ describe Devise::Models::RadiusAuthenticatable do
     Configurable.radius_uid_generator.call('test', '1.2.3.4').should == 'test_1.2.3.4'
   end
 
+  it "allows configuration of the radius dictionary path" do
+    Configurable.radius_dictionary_path.should == Rails.root.join('config/dictionaries')
+  end
+
   it "extracts radius credentials based on the configured authentication keys" do
     swap(Devise, :authentication_keys => [:username, :domain]) do
       auth_hash = { :username => 'cbascom', :password => 'testing' }
@@ -110,14 +115,19 @@ describe Devise::Models::RadiusAuthenticatable do
 
     it "passes the configured options when building the radius request" do
       server_url = "#{Admin.radius_server}:#{Admin.radius_server_port}"
-      server_options = {
-        :reply_timeout => Admin.radius_server_timeout,
-        :retries_number => Admin.radius_server_retries
-      }
       @admin.valid_radius_password?('testuser', 'password')
 
       radius_server.url.should == server_url
-      radius_server.options.should == server_options
+      radius_server.options[:reply_timeout].should == Admin.radius_server_timeout
+      radius_server.options[:retries_number].should == Admin.radius_server_retries
+      radius_server.options[:dict].should be_a(Radiustar::Dictionary)
+    end
+
+    it "does not add the :dict option if no dictionary path is configured" do
+      swap(Admin, :radius_dictionary_path => nil) do
+        @admin.valid_radius_password?('testuser', 'password')
+        radius_server.options.should_not have_key(:dict)
+      end
     end
 
     it "returns false when the password is incorrect" do

data/spec/generators/install_generator_spec.rb

@@ -27,11 +27,13 @@ describe DeviseRadiusAuthenticatable::InstallGenerator do
       it { should contain("config.radius_server_retries = 0") }
       it { should contain("config.radius_uid_field = :uid") }
       it { should contain("config.radius_uid_generator =") }
+      it { should contain("config.radius_dictionary_path =") }
     end
 
     context "with custom options" do
       before { run_generator ['1.1.1.2', 'password', '--port=1813', '--timeout=120',
-                              '--retries=3', '--uid_field=email'] }
+                              '--retries=3', '--uid_field=email',
+                              '--dictionary_path=/tmp/dictionaries'] }
 
       it { should contain('==> Configuration for radius_authenticatable') }
       it { should contain("config.radius_server = '1.1.1.2'") }
@@ -41,6 +43,7 @@ describe DeviseRadiusAuthenticatable::InstallGenerator do
       it { should contain("config.radius_server_retries = 3") }
       it { should contain("config.radius_uid_field = :email") }
       it { should contain("config.radius_uid_generator =") }
+      it { should contain("config.radius_dictionary_path = '/tmp/dictionaries'") }
     end
   end
 end

data/spec/rails_app/config/initializers/devise.rb

@@ -214,6 +214,13 @@ Devise.setup do |config|
   #  "#{username}@#{server}"
   # end
 
+  # There is a very basic radius dictionary provided by default.  Most of the time
+  # this will not be sufficient, so this configuration option allows you to
+  # specify the path that contains all of the radius dictionary files that should
+  # be loaded.
+  #
+  config.radius_dictionary_path = Rails.root.join('config/dictionaries')
+
   # ==> Scopes configuration
   # Turn scoped views on. Before rendering "sessions/new", it will first check for
   # "users/sessions/new". It's turned off by default because it's slower if you

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise-radius-authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-05 00:00:00.000000000 Z
+date: 2012-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise