cinch-authentication 0.1.0

data/lib/cinch/configuration/authentication.rb

@@ -0,0 +1,14 @@
+module Cinch
+  class Configuration
+    class Authentication < Configuration
+      KnownOptions = [:strategy, :level, :channel, :logged_in, :registration,
+        :fetch_user]
+
+      def self.default_config
+        {
+          :logged_in => {}
+        }
+      end
+    end
+  end
+end

data/lib/cinch/extensions/authentication.rb

@@ -0,0 +1,154 @@
+require 'cinch/configuration/authentication'
+
+module Cinch
+  module Extensions
+    module Authentication
+      module ClassMethods
+        # Public: Enables authentication for the full plugin.
+        def enable_authentication
+          hook :pre, :for => [:match], :method => :authenticated?
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Public: Checks if the user is authorized to run the command.
+      #
+      # m      - The Cinch::Message.
+      # levels - The level(s) of authentication Symbol(s) the user must have
+      #          (default: nil).
+      #
+      # Examples
+      # 
+      #   # The :channel_status strategy
+      #   authenticated? m, :h # => true for :q, :a, :o and :h
+      #   authenticated? m, :o # => true for :q, :a and :o
+      #   
+      #   # The :user_list and :user_login strategy
+      #   authenticated? m, [:admins, :users]
+      #   authenticated? m, :admins
+      #
+      # Returns a Boolean.
+      def authenticated?(m, levels = nil)
+        strategy = config[:authentication_strategy] || 
+          bot.config.authentication.strategy
+        levels   = levels || config[:authentication_level] ||
+          bot.config.authentication.level
+
+        case strategy
+          when :channel_status then return channel_status_strategy m, levels
+          when :list then return list_strategy m, levels
+          when :login then return login_strategy m, levels
+        end
+
+        raise StandardError, 'You have not configured an authentication ' +
+          'strategy.'
+      end
+
+      # Internal: Checks if the user is an operator on the channel.
+      #
+      # m     - The Cinch::Message.
+      # level - The level Symbol.
+      def channel_status_strategy(m, level)
+        if config.has_key? :authentication_channel
+          channel = Channel channel[:authentication_channel]
+        elsif bot.config.authentication.channel
+          channel = Channel bot.config.authentication.channel
+        else
+          channel = m.channel
+        end
+
+        if level.nil?
+          raise StandardError, "You haven't configured an authentication level."
+        end
+
+        bot.loggers.debug level.inspect
+
+        user_modes = channel.users[m.user]
+        modes      = { q: 'founder', a: 'admin', o: 'operator',
+          h: 'half-operator', v: 'voice' }
+
+        modes.keys.take(modes.keys.find_index(level) + 1).each do |mode|
+          return true if user_modes.include? mode.to_s
+        end
+
+        m.user.notice "This command requires at least #{modes[level]} status " +
+          "on #{channel}."
+        
+        return false
+      rescue => e
+        m.user.notice 'Something went wrong.'
+        raise
+      end
+
+      # Internal: Checks if the user sending the message is on the user list.
+      #
+      # m      - The Cinch::Message.
+      # levels - The level Symbol(s).
+      #
+      # Returns a Boolean.
+      def list_strategy(m, levels)
+        m.user.refresh
+
+        unless m.user.authed?
+          m.user.notice "This command requires you to be authenticated."
+          return false
+        end
+
+        user_list = Array(levels).each_with_object [] do |level, list|
+          list.concat(config[level] || bot.config.authentication.send(level))
+        end
+        
+        if user_list.nil?
+          bot.loggers.debug "You have not configured any user lists."
+        end
+
+        unless user_list.include? m.user.authname
+          m.user.notice "You are not authorized to run this command."
+          return false
+        end
+
+        return true
+      end
+
+      # Internal: Checks if the user sending the message has logged in.
+      #
+      # m- The Cinch::Message.
+      # levels - The level Symbol(s).
+      def login_strategy(m, levels)
+        if current_user(m).nil?
+          m.user.notice "You are not authorized to run this command. Please " +
+            "log in using !login [<username>] <password>."
+          return false
+        end
+
+        levels = Array(levels)
+
+        levels.each do |level|
+          level_lambda = config[level] || bot.config.authentication.send(level)
+
+          return true if level_lambda.call current_user(m)
+        end
+
+        # The previous check will fail if no level is given.
+        return true if levels.nil?
+
+        m.user.notice 'You are not authorized to run this command.'
+        return false
+      end
+
+      # Public: Returns the nickname of the currently logged in user.
+      #
+      # Returns a String.
+      # Returns nil when a user is not logged in.
+      def current_user(m)
+        bot.config.authentication.logged_in[m.user]
+      end
+    end
+  end
+end
+
+require 'cinch/plugins/user_login'
+require 'cinch/plugins/user_list'

data/lib/cinch/plugins/user_list.rb

@@ -0,0 +1,41 @@
+require 'cinch/extensions/authentication'
+
+module Cinch
+  module Plugins
+    class UserList
+      include Cinch::Plugin
+      include Cinch::Extensions::Authentication
+
+      set :plugin_name, 'userlists'
+      set :help, <<-USAGE.gsub(/^ {6}/, '')
+        Allows you to add/delete users from user lists used for authentication.
+        Usage:
+        - !add_to_<level> <nickname>: Adds a user to the <level> list.
+        - !delete_from_<level> <nickname>: Deletes a user from the <level> list.
+        - !show_<level>_list: Shows the <level> list.
+      USAGE
+
+      match /add_to_(\S+) (\S+)/s, :method => :add
+      match /delete_from_(\S+) (\S)/s, :method => :delete
+      match /show_(\S+)_list/s, :method => :show
+
+      enable_authentication
+
+      def add(m, level, nickname)
+        if bot.config.send(level) << nickname
+          m.user.notice "#{nickname} has been added to the #{level} list."
+        end
+      end
+
+      def delete(m, level, nickname)
+        if bot.config.send(level).delete nickname
+          m.user.notice "#{nickname} has been deleted from the #{level} list."
+        end
+      end
+
+      def show(m, level)
+        m.user.notice bot.config.send(level).join ', '
+      end
+    end
+  end
+end

data/lib/cinch/plugins/user_login.rb

@@ -0,0 +1,82 @@
+require 'cinch/extensions/authentication'
+
+module Cinch
+  module Plugins
+    class UserLogin
+      include Cinch::Plugin
+      include Cinch::Extensions::Authentication
+
+      set :plugin_name, 'account'
+      set :help, <<-USAGE.gsub(/^ {6}/, '')
+        Allows you to login to run commands that require authorization.
+        Usage:
+        - !register [<nickname>] <password>: Registration (note: <nickname> defauts to your current nickname if ommited).
+        - !login [<nickname>] <password>: Logging in (note: <nickname> defaults to your current nickname if ommited).
+        - !logout: Logout. Nickname defaults to the current nickname.
+      USAGE
+
+      match /register (?:(\S+) )?(\S+)/s, :method => :register
+      match /login (?:(\S+) )?(\S+)/s, :method => :login
+      match /logout/s, :method => :logout
+
+      # Admin-only commands. Perhaps in a later version.
+      #match /add_to_(\S+) (\S+)/s => :method => :add_to
+      #match /remove_from_(\S+) (\S+)/s, :method => :remove_from
+
+      def register(m, nickname, password)
+        registration = config[:registration] || 
+          bot.config.authentication.registration
+
+        if registration.nil?
+          raise StandardError, 'You have not configured a registration lambda.'
+        elsif registration.call(nickname || m.user.nick, password)
+          m.user.notice "You have been registered as #{nickname||m.user.nick}."
+          login m, nickname, password
+        else
+          m.user.notice "An account with nickname #{nickname || m.user.nick} " +
+            'already exists.'
+        end
+      rescue => e
+        m.user.notice 'Something went wrong.'
+        raise
+      end
+
+      def login(m, nickname, password)
+        fetch_user = config[:fetch_user] || bot.config.authentication.fetch_user
+
+        if fetch_user.nil?
+          raise StandardError, 'You have not configured an fetch_user lambda.'
+        end
+
+        user = fetch_user.call(nickname || m.user.nick)
+
+        if user.nil?
+          m.user.notice 'You have not registered or mistyped your nickname.'
+          return
+        end
+
+        unless user.respond_to? :authenticate
+          raise StandardError, "Please implement #{user.class}#authenticate."
+        end
+
+        if user.authenticate(password)
+          bot.config.authentication.logged_in[m.user] = user
+          m.user.notice "You have been logged in as #{nickname || m.user.nick}."
+        else
+          m.user.notice 'Unknown username/password combination.'
+        end
+      rescue => e
+        m.user.notice 'Something went wrong.'
+        raise
+      end
+
+      def logout(m)
+        if bot.config.authentication.logged_in.delete m.user
+          m.user.notice 'You have been logged out.'
+        else
+          m.user.notice 'You are not logged in.'
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: cinch-authentication
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Paul Brickfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+description: An authentication system with multiple strategies for the Cinch IRC framework.
+email:
+- paulbrickfeld@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cinch/configuration/authentication.rb
+- lib/cinch/extensions/authentication.rb
+- lib/cinch/plugins/user_list.rb
+- lib/cinch/plugins/user_login.rb
+homepage: https://github.com/britishtea/cinch-authentication
+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: ! '[none]'
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Authentication for Cinch.
+test_files: []
+has_rdoc: