devise-multi-radius-authenticatable 0.1.1

data/lib/devise/radius_authenticatable/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module RadiusAuthenticatable
+    VERSION = "0.1.1".freeze
+  end
+end

data/lib/devise/strategies/radius_authenticatable.rb

@@ -0,0 +1,30 @@
+require 'devise/strategies/authenticatable'
+
+module Devise
+  module Strategies
+    # Strategy for authenticating users with a radius server.  If authentication with
+    # the radius server fails, allow warden to move on to the next strategy.  When
+    # authentication succeeds and Devise indicates that the resource has been
+    # successfully validated, invoke the +after_radius_authentication+ callback on the
+    # resource and let warden know we were successful and not to continue with executing
+    # further strategies.
+    class RadiusAuthenticatable < Authenticatable
+      # Invoked by warden to execute the strategy.
+      def authenticate!
+        auth_params = authentication_hash.merge(password: password)
+
+        resource = valid_password? &&
+          mapping.to.find_for_radius_authentication(auth_params)
+
+        return fail(:invalid) unless resource
+
+        if validate(resource)
+          resource.after_radius_authentication
+          success!(resource)
+        end
+      end
+    end
+  end
+end
+
+Warden::Strategies.add(:radius_authenticatable, Devise::Strategies::RadiusAuthenticatable)

data/lib/generators/devise_radius_authenticatable/install_generator.rb

@@ -0,0 +1,93 @@
+module DeviseRadiusAuthenticatable
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+
+    desc <<-DESC.gsub(/ {6}/, '')
+      Description:
+        Adds radius_authenticatable strategy to the devise initializer
+
+        <SERVER IP> - The IP address of the radius server
+        <SHARED SECRET> - The shared secret for the radius server
+    DESC
+
+    argument(:server, :banner => '<SERVER IP>',
+             :desc => 'The IP address of the radius server')
+    argument(:secret, :banner => '<SHARED SECRET>',
+             :desc => 'The shared secret for the radius server')
+    class_option(:uid_field, :default => :uid,
+                 :desc => 'What database column to use for the UID')
+    class_option(:port, :default => 1812,
+                 :desc => 'The port to connect to the radius server on')
+    class_option(:timeout, :default => 60,
+                 :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')
+    class_option(:handle_timeout_as_failure, :default => false,
+                 :desc => 'Option to handle radius timeout as authentication failure')
+
+    def install
+      inject_into_file("config/initializers/devise.rb", default_devise_settings,
+                       :before => /^\s*.*==> Scopes configuration/)
+    end
+
+    private
+
+    def default_devise_settings
+      <<-CONFIG.gsub(/ {6}/, '')
+
+        # ==> Configuration for radius_authenticatable
+        # The radius_authenticatable strategy can be used in place of the
+        # database_authenticatable strategy or alongside it.  The default order of the
+        # strategies is the reverse of how they were loaded.  You can control this
+        # order by explicitly telling warden the order in which to apply the strategies.
+        # See the Warden Configuration section for further details.
+        #
+        # Configure the hostname or IP address of the radius server to use.
+        config.radius_server = '#{server}'
+
+        # Configure the port to use when connecting to the radius server.
+        config.radius_server_port = #{options[:port]}
+
+        # Configure the shared secret needed to connect to the radius server.
+        config.radius_server_secret = '#{secret}'
+
+        # Configure the time in seconds to wait for a radius server to respond.
+        config.radius_server_timeout = #{options[:timeout]}
+
+        # Configure the number of times a request should be retried when a radius server
+        # does not immediately respond to requests.
+        config.radius_server_retries = #{options[:retries]}
+
+        # In some cases you may want to support authentication attempts against
+        # multiple radius servers.  In these cases the same username could be used on
+        # each of the servers.  In order to create unique database records, a unique
+        # username is generated by using the radius username and the radius server IP
+        # address once the authentication has succeeded.  This configuration option
+        # allows you to chose which database column this calculated UID field will be
+        # stored in.
+        config.radius_uid_field = :#{options[:uid_field]}
+
+        # If you want to control how the unique identifier is created for each radius
+        # user, this can be customized by configuring a proc that accepts the username
+        # and the radius server as parameters and returns the uid.
+        #
+        # 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]}'
+
+        # Option to handle radius timeout as authentication failure
+        #
+        config.handle_radius_timeout_as_failure = #{options[:handle_timeout_as_failure]}
+      CONFIG
+    end
+  end
+end

data/spec/devise/models/radius_authenticatable_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+class Configurable < Admin
+  devise(:radius_authenticatable, :radius_server => '1.2.3.4',
+         :radius_server_port => 1813, :radius_server_secret => 'secret',
+         :radius_server_timeout => 120, :radius_server_retries => 3,
+         :radius_uid_field => :email,
+         :radius_uid_generator => Proc.new { |username, server|
+           "#{username}_#{server}"
+         },
+         :radius_dictionary_path => Rails.root.join('config/dictionaries'),
+         :handle_radius_timeout_as_failure => true)
+end
+
+describe Devise::Models::RadiusAuthenticatable do
+  let(:auth_key) { Devise.authentication_keys.first }
+
+  it "allows configuration of the radius server IP" do
+    Configurable.radius_server.should == '1.2.3.4'
+  end
+
+  it "allows configuration of the radius server port" do
+    Configurable.radius_server_port.should == 1813
+  end
+
+  it "allows configuration of the radius server shared secret" do
+    Configurable.radius_server_secret.should == 'secret'
+  end
+
+  it "allows configuration of the radius server timeout" do
+    Configurable.radius_server_timeout.should == 120
+  end
+
+  it "allows configuration of the radius server retries" do
+    Configurable.radius_server_retries.should == 3
+  end
+
+  it "allows configuration of the radius uid field" do
+    Configurable.radius_uid_field.should == :email
+  end
+
+  it "allows configuration of the radius uid generator" 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 "allows configuration of the radius exception handling" do
+    Configurable.handle_radius_timeout_as_failure.should == true
+  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' }
+      Configurable.radius_credentials(auth_hash).should == ['cbascom', 'testing']
+    end
+  end
+
+  it "converts the username to lower case if the key is case insensitive" do
+    swap(Devise, {:authentication_keys => [:username, :domain],
+           :case_insensitive_keys => [:username]}) do
+      auth_hash = { :username => 'Cbascom', :password => 'testing' }
+      Configurable.radius_credentials(auth_hash).should == ['cbascom', 'testing']
+    end
+  end
+
+  it "does not convert the username to lower case if the key is not case insensitive" do
+    swap(Devise, {:authentication_keys => [:username, :domain],
+           :case_insensitive_keys => []}) do
+      auth_hash = { :username => 'Cbascom', :password => 'testing' }
+      Configurable.radius_credentials(auth_hash).should == ['Cbascom', 'testing']
+    end
+  end
+
+  context "when finding the user record for authentication" do
+    let(:good_auth_hash) { {auth_key => 'testuser', :password => 'password'} }
+    let(:bad_auth_hash) { {auth_key => 'testuser', :password => 'wrongpassword'} }
+
+    before do
+      @uid_field = Admin.radius_uid_field.to_sym
+      @uid = Admin.radius_uid_generator.call('testuser', Admin.radius_server)
+      create_radius_user('testuser', 'password')
+    end
+
+    it "uses the generated uid and configured uid field to find the record" do
+      Admin.should_receive(:find_for_authentication).with(@uid_field => @uid)
+      Admin.find_for_radius_authentication(good_auth_hash)
+    end
+
+    context "and authentication succeeds" do
+      it "creates a new user record if none was found" do
+        Admin.find_for_radius_authentication(good_auth_hash).should be_new_record
+      end
+
+      it "fills in the uid when creating the new record" do
+        admin = Admin.find_for_radius_authentication(good_auth_hash)
+        admin.send(@uid_field).should == @uid
+      end
+
+      it "uses the existing user record when one is found" do
+        admin = FactoryGirl.create(:admin, @uid_field => @uid)
+        Admin.find_for_radius_authentication(good_auth_hash).should == admin
+      end
+    end
+
+    context "and authentication fails" do
+      it "does not create a new user record" do
+        Admin.find_for_radius_authentication(bad_auth_hash).should be_nil
+      end
+    end
+  end
+
+  context "when validating a radius user's password" do
+    before do
+      @admin = Admin.new
+      create_radius_user('testuser', 'password')
+    end
+
+    it "passes the configured options when building the radius request" do
+      server_url = "#{Admin.radius_server}:#{Admin.radius_server_port}"
+      @admin.valid_radius_password?('testuser', 'password')
+
+      radius_server.url.should == server_url
+      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
+      @admin.valid_radius_password?('testuser', 'wrongpassword').should be_false
+    end
+
+    it "returns true when the password is correct" do
+      @admin.valid_radius_password?('testuser', 'password').should be_true
+    end
+
+    it "stores the returned attributes in the model" do
+      @admin.valid_radius_password?('testuser', 'password')
+      @admin.radius_attributes.should == radius_server.attributes('testuser')
+    end
+
+    context "when handle_radius_timeout_as_failure is false" do
+      it "does not catch the RuntimeError exception" do
+        Radiustar::Request.any_instance.stub(:authenticate).
+          and_raise(RuntimeError)
+        expect { @admin.valid_radius_password?('testuser', 'password') }.
+          to raise_error(RuntimeError)
+      end
+    end
+
+    context "when handle_radius_timeout_as_failure is true" do
+      it "returns false when the authentication times out" do
+        swap(Devise, :handle_radius_timeout_as_failure => true) do
+          Radiustar::Request.any_instance.stub(:authenticate).
+            and_raise(RuntimeError)
+          @admin.valid_radius_password?('testuser', 'password').should be_false
+        end
+      end
+    end
+  end
+end

data/spec/factories/admins.rb

@@ -0,0 +1,10 @@
+FactoryGirl.define do
+  sequence :admin_email do |n|
+    "admin#{n}@gmail.com"
+  end
+
+  factory :admin do
+    email     { FactoryGirl.generate(:admin_email) }
+    password  "password"
+  end
+end

data/spec/fixtures/devise.rb

@@ -0,0 +1,238 @@
+# Use this hook to configure devise mailer, warden hooks and so forth.
+# Many of these configuration options can be set straight in your model.
+Devise.setup do |config|
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class with default "from" parameter.
+  config.mailer_sender = "please-change-me-at-config-initializers-devise@example.com"
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = "Devise::Mailer"
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  # config.authentication_keys = [ :email ]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+  config.case_insensitive_keys = [ :email ]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+  config.strip_whitespace_keys = [ :email ]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Basic Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:token]` will
+  # enable it only for token authentication.
+  # config.http_authenticatable = false
+
+  # If http headers should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. "Application" by default.
+  # config.http_authentication_realm = "Application"
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # :http_auth and :token_auth by adding those symbols to the array below.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing :skip => :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments.
+  config.stretches = Rails.env.test? ? 1 : 10
+
+  # Setup a pepper to generate the encrypted password.
+  # config.pepper = "f71add1f76d905b20d078ddc6b517eb3228ced6c75913835875b0379829892d52f79f79ace5f42df0aa299aa894186db070ccbe678bf575d7a081b515bcfde60"
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming his account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming his account,
+  # access will be blocked just in the third day. Default is 0.days, meaning
+  # the user cannot access the website without confirming his account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed new email is stored in
+  # unconfirmed email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [ :email ]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # :secure => true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length. Default is 6..128.
+  # config.password_length = 6..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # an one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  # config.email_regexp = /\A[^@]+@[^@]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # If true, expires auth token on session timeout.
+  # config.expire_auth_token_on_timeout = false
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [ :email ]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [ :email ]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another encryption algorithm besides bcrypt (default). You can use
+  # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
+  # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
+  # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
+  # REST_AUTH_SITE_KEY to pepper)
+  # config.encryptor = :sha512
+
+  # ==> Configuration for :token_authenticatable
+  # Defines name of the authentication token params key
+  # config.token_authentication_key = :auth_token
+
+  # ==> 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
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Set this configuration to false if you want /users/sign_out to sign out
+  # only the current scope. By default, Devise signs out all scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ["*/*", :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :delete
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(:scope => :user).unshift :some_external_strategy
+  # end
+  config.warden do |warden_config|
+    warden_config.default_strategies(:token_authenticatable,
+                                     :database_authenticatable,
+                                     :radius_authenticatable,
+                                     {:scope => :administrator})
+  end
+
+  # ==> Mountable engine configurations
+  # When using Devise inside an engine, let's call it `MyEngine`, and this engine
+  # is mountable, there are some extra configurations to be taken into account.
+  # The following options are available, assuming the engine is mounted as:
+  #
+  #     mount MyEngine, at: "/my_engine"
+  #
+  # The router that invoked `devise_for`, in the example above, would be:
+  # config.router_name = :my_engine
+  #
+  # When using omniauth, Devise cannot automatically set Omniauth path,
+  # so you need to do it manually. For the users scope, it would be:
+  # config.omniauth_path_prefix = "/my_engine/users/auth"
+end