X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fbotuser.rb;h=bed2b627cb59e9a36ea3a0ca1757f6771ecf88e8;hb=12906a51f698aebe1c9a5e19b15555ebbbcc4368;hp=a6a3bf4accb2c286ab31c88aab00a5a9bba35d3d;hpb=0d0f61e6e3185488c85a6805ff2f4d468d4a3935;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git
diff --git a/lib/rbot/botuser.rb b/lib/rbot/botuser.rb
index a6a3bf4a..bed2b627 100644
--- a/lib/rbot/botuser.rb
+++ b/lib/rbot/botuser.rb
@@ -21,21 +21,21 @@ module Irc
:default => 'rbotauth', :wizard => true,
:desc => 'Password for the bot owner' )
BotConfig.register BotConfigBooleanValue.new( 'auth.login_by_mask',
- :default => 'false',
- :desc => 'Set true if new botusers should allow logging in without a password when the user netmask is known')
- BotConfig.register BotConfigBooleanValue.new( 'auth.login_auto',
- :default => 'false',
- :desc => 'Set true if new botusers should try to recognize IRC users without a need to manually login')
+ :default => 'true',
+ :desc => 'Set false to prevent new botusers from logging in without a password when the user netmask is known')
+ BotConfig.register BotConfigBooleanValue.new( 'auth.autologin',
+ :default => 'true',
+ :desc => 'Set false to prevent new botusers from recognizing IRC users without a need to manually login')
# BotConfig.register BotConfigIntegerValue.new( 'auth.default_level',
# :default => 10, :wizard => true,
# :desc => 'The default level for new/unknown users' )
# Generate a random password of length _l_
#
- def random_password(l=8)
+ def Auth.random_password(l=8)
pwd = ""
- 8.times do
- pwd += (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr
+ l.times do
+ pwd << (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr
end
return pwd
end
@@ -101,6 +101,16 @@ class String
end
+class Symbol
+
+ # Returns an Irc::Auth::Comand from the receiver
+ def to_irc_auth_command
+ Irc::Auth::Command.new(self)
+ end
+
+end
+
+
module Irc
@@ -110,6 +120,7 @@ module Irc
# This class describes a permission set
class PermissionSet
+ attr_reader :perm
# Create a new (empty) PermissionSet
#
def initialize
@@ -159,6 +170,12 @@ module Irc
end
+ # This is the error that gets raised when an invalid password is met
+ #
+ class InvalidPassword < RuntimeError
+ end
+
+
# This is the basic class for bot users: they have a username, a password,
# a list of netmasks to match against, and a list of permissions.
#
@@ -167,6 +184,7 @@ module Irc
attr_reader :username
attr_reader :password
attr_reader :netmasks
+ attr_reader :perm
attr_writer :login_by_mask
attr_writer :autologin
@@ -176,8 +194,8 @@ module Irc
@password = nil
@netmasks = NetmaskList.new
@perm = {}
- @login_by_mask = Auth.manager.bot.config['auth.login_by_mask'] unless defined?(@login_by_mask)
- @autologin = Auth.manager.bot.config['auth.login_auto'] unless defined?(@autologin)
+ reset_login_by_mask
+ reset_autologin
end
# Inspection
@@ -191,6 +209,11 @@ module Irc
str << ">"
end
+ # In strings
+ def to_s
+ @username
+ end
+
# Convert into a hash
def to_hash
{
@@ -209,6 +232,18 @@ module Irc
@login_by_mask
end
+ # Reset the login-by-mask option
+ #
+ def reset_login_by_mask
+ @login_by_mask = Auth.authmanager.bot.config['auth.login_by_mask'] unless defined?(@login_by_mask)
+ end
+
+ # Reset the autologin option
+ #
+ def reset_autologin
+ @autologin = Auth.authmanager.bot.config['auth.autologin'] unless defined?(@autologin)
+ end
+
# Do we allow automatic logging in?
#
def autologin?
@@ -228,24 +263,25 @@ module Irc
# This method sets the password if the proposed new password
# is valid
def password=(pwd=nil)
- if pwd
+ pass = pwd.to_s
+ if pass.empty?
+ reset_password
+ else
begin
- raise InvalidPassword, "#{pwd} contains invalid characters" if pwd !~ /^[A-Za-z0-9]+$/
- raise InvalidPassword, "#{pwd} too short" if pwd.length < 4
- @password = pwd
+ raise InvalidPassword, "#{pass} contains invalid characters" if pass !~ /^[\x21-\x7e]+$/
+ raise InvalidPassword, "#{pass} too short" if pass.length < 4
+ @password = pass
rescue InvalidPassword => e
raise e
rescue => e
- raise InvalidPassword, "Exception #{e.inspect} while checking #{pwd}"
+ raise InvalidPassword, "Exception #{e.inspect} while checking #{pass.inspect} (#{pwd.inspect})"
end
- else
- reset_password
end
end
# Resets the password by creating a new onw
def reset_password
- @password = random_password
+ @password = Auth.random_password
end
# Sets the permission for command _cmd_ to _val_ on channel _chan_
@@ -293,7 +329,7 @@ module Irc
# Removes all Netmask
s
#
- def reset_netmask_list
+ def reset_netmasks
@netmasks = NetmaskList.new
end
@@ -316,7 +352,7 @@ module Irc
# is right. If it is, the Netmask of the user is added to the
# list of acceptable Netmask unless it's already matched.
def login(user, password)
- if password == @password or (password.nil? and @login_by_mask and knows?(user))
+ if password == @password or (password.nil? and (@login_by_mask || @autologin) and knows?(user))
add_netmask(user) unless knows?(user)
debug "#{user} logged in as #{self.inspect}"
return true
@@ -334,7 +370,9 @@ module Irc
# and replacing any nonalphanumeric character with _
#
def BotUser.sanitize_username(name)
- return name.to_s.chomp.downcase.gsub(/[^a-z0-9]/,"_")
+ candidate = name.to_s.chomp.downcase.gsub(/[^a-z0-9]/,"_")
+ raise "sanitized botusername #{candidate} too short" if candidate.length < 3
+ return candidate
end
end
@@ -345,16 +383,15 @@ module Irc
#
class DefaultBotUserClass < BotUser
- private :login, :add_netmask, :delete_netmask
+ private :add_netmask, :delete_netmask
include Singleton
- # The default BotUser is named 'everyone', it doesn't allow autologin
- # (meaningless) and it allows login-by-mask
+ # The default BotUser is named 'everyone'
#
def initialize
- @login_by_mask = true
- @autologin = false
+ reset_login_by_mask
+ reset_autologin
super("everyone")
@default_perm = PermissionSet.new
end
@@ -366,6 +403,12 @@ module Irc
return @login_by_mask
end
+ # The default botuser allows logins by mask
+ #
+ def reset_login_by_mask
+ @login_by_mask = true
+ end
+
# This method returns without changing anything
#
def autologin=(val)
@@ -373,6 +416,12 @@ module Irc
return
end
+ # The default botuser doesn't allow autologin (meaningless)
+ #
+ def reset_autologin
+ @autologin = false
+ end
+
# Sets the default permission for the default user (i.e. the ones
# set by the BotModule writers) on all channels
#
@@ -393,7 +442,7 @@ module Irc
end
# Resets the NetmaskList
- def reset_netmask_list
+ def reset_netmasks
super
add_netmask("*!*@*")
end
@@ -426,7 +475,7 @@ module Irc
def initialize
@login_by_mask = false
- @autologin = false
+ @autologin = true
super("owner")
end
@@ -452,6 +501,7 @@ module Irc
attr_reader :everyone
attr_reader :botowner
+ attr_reader :bot
# The instance manages two Hash
es: one that maps
# Irc::User
s onto BotUser
s, and the other that maps
@@ -523,18 +573,20 @@ module Irc
# Maps Irc::User
to BotUser
def irc_to_botuser(ircuser)
- # TODO check netmasks
- @botusers[ircuser.to_irc_user] || everyone
+ logged = @botusers[ircuser.to_irc_user]
+ return logged if logged
+ return autologin(ircuser)
end
# creates a new BotUser
def create_botuser(name, password=nil)
n = BotUser.sanitize_username(name)
k = n.to_sym
- raise "BotUser #{n} exists" if include?(k)
+ raise "botuser #{n} exists" if include?(k)
bu = BotUser.new(n)
bu.password = password
@allbotusers[k] = bu
+ return bu
end
# returns the botuser with name _name_
@@ -548,13 +600,13 @@ module Irc
#
# It is possible to autologin by Netmask, on request
#
- def login(user, botusername, pwd)
+ def login(user, botusername, pwd=nil)
ircuser = user.to_irc_user
n = BotUser.sanitize_username(botusername)
k = n.to_sym
raise "No such BotUser #{n}" unless include?(k)
if @botusers.has_key?(ircuser)
- return true if @botusers[ircuser].name = n
+ return true if @botusers[ircuser].username == n
# TODO
# @botusers[ircuser].logout(ircuser)
end
@@ -590,7 +642,11 @@ module Irc
# * everyone on all channels
#
def permit?(user, cmdtxt, channel=nil)
- botuser = irc_to_botuser(user)
+ if user.class <= BotUser
+ botuser = user
+ else
+ botuser = irc_to_botuser(user)
+ end
cmd = cmdtxt.to_irc_auth_command
chan = channel
@@ -618,9 +674,18 @@ module Irc
raise "Could not check permission for user #{user.inspect} to run #{cmdtxt.inspect} on #{chan.inspect}"
end
- # Checks if command _cmd_ is allowed to User _user_ on _chan_
+ # Checks if command _cmd_ is allowed to User _user_ on _chan_, optionally
+ # telling if the user is authorized
+ #
def allow?(cmdtxt, user, chan=nil)
- permit?(user, cmdtxt, chan)
+ if permit?(user, cmdtxt, chan)
+ return true
+ else
+ # cmds = cmdtxt.split('::')
+ # @bot.say chan, "you don't have #{cmds.last} (#{cmds.first}) permissions here" if chan
+ @bot.say chan, "#{user}, you don't have '#{cmdtxt}' permissions here" if chan
+ return false
+ end
end
end