3 # :title: User management
\r
5 # rbot user management
\r
6 # Author:: Giuseppe Bilotta (giuseppe.bilotta@gmail.com)
\r
7 # Copyright:: Copyright (c) 2006 Giuseppe Bilotta
\r
16 # This module contains the actual Authentication stuff
\r
20 BotConfig.register BotConfigStringValue.new( 'auth.password',
\r
21 :default => 'rbotauth', :wizard => true,
\r
22 :desc => 'Password for the bot owner' )
\r
23 BotConfig.register BotConfigBooleanValue.new( 'auth.login_by_mask',
\r
24 :default => 'false',
\r
25 :desc => 'Set true if new botusers should allow logging in without a password when the user netmask is known')
\r
26 BotConfig.register BotConfigBooleanValue.new( 'auth.login_auto',
\r
27 :default => 'false',
\r
28 :desc => 'Set true if new botusers should try to recognize IRC users without a need to manually login')
\r
29 # BotConfig.register BotConfigIntegerValue.new( 'auth.default_level',
\r
30 # :default => 10, :wizard => true,
\r
31 # :desc => 'The default level for new/unknown users' )
\r
33 # Generate a random password of length _l_
\r
35 def random_password(l=8)
\r
38 pwd += (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr
\r
44 # An Irc::Auth::Command defines a command by its "path":
\r
46 # base::command::subcommand::subsubcommand::subsubsubcommand
\r
50 attr_reader :command, :path
\r
52 # A method that checks if a given _cmd_ is in a form that can be
\r
53 # reduced into a canonical command path, and if so, returns it
\r
55 def sanitize_command_path(cmd)
\r
56 pre = cmd.to_s.downcase.gsub(/^\*?(?:::)?/,"").gsub(/::$/,"")
\r
57 return pre if pre.empty?
\r
58 return pre if pre =~ /^\S+(::\S+)*$/
\r
59 raise TypeError, "#{cmd.inspect} is not a valid command"
\r
62 # Creates a new Command from a given string; you can then access
\r
63 # the command as a symbol with the :command method and the whole
\r
66 # Command.new("core::auth::save").path => [:"*", :"core", :"core::auth", :"core::auth::save"]
\r
68 # Command.new("core::auth::save").command => :"core::auth::save"
\r
71 cmdpath = sanitize_command_path(cmd).split('::')
\r
72 seq = cmdpath.inject(["*"]) { |list, cmd|
\r
73 list << (list.length > 1 ? list.last + "::" : "") + cmd
\r
75 @path = seq.map { |k|
\r
78 @command = path.last
\r
79 debug "Created command #{@command.inspect} with path #{@path.join(', ')}"
\r
83 def to_irc_auth_command
\r
96 # Returns an Irc::Auth::Comand from the receiver
\r
97 def to_irc_auth_command
\r
98 Irc::Auth::Command.new(self)
\r
110 # This class describes a permission set
\r
111 class PermissionSet
\r
113 # Create a new (empty) PermissionSet
\r
119 # Inspection simply inspects the internal hash
\r
124 # Sets the permission for command _cmd_ to _val_,
\r
126 def set_permission(str, val)
\r
127 cmd = str.to_irc_auth_command
\r
130 @perm[cmd.command] = val
\r
132 @perm.delete(cmd.command)
\r
134 raise TypeError, "#{val.inspect} must be true or false" unless [true,false].include?(val)
\r
138 # Resets the permission for command _cmd_
\r
140 def reset_permission(cmd)
\r
141 set_permission(cmd, nil)
\r
144 # Tells if command _cmd_ is permitted. We do this by returning
\r
145 # the value of the deepest Command#path that matches.
\r
148 cmd = str.to_irc_auth_command
\r
150 cmd.path.reverse.each { |k|
\r
151 if @perm.has_key?(k)
\r
162 # This is the basic class for bot users: they have a username, a password,
\r
163 # a list of netmasks to match against, and a list of permissions.
\r
167 attr_reader :username
\r
168 attr_reader :password
\r
169 attr_reader :netmasks
\r
170 attr_writer :login_by_mask
\r
171 attr_writer :autologin
\r
173 # Create a new BotUser with given username
\r
174 def initialize(username)
\r
175 @username = BotUser.sanitize_username(username)
\r
177 @netmasks = NetmaskList.new
\r
179 @login_by_mask = Auth.manager.bot.config['auth.login_by_mask'] unless defined?(@login_by_mask)
\r
180 @autologin = Auth.manager.bot.config['auth.login_auto'] unless defined?(@autologin)
\r
185 str = "<#{self.class}:#{'0x%08x' % self.object_id}:"
\r
186 str << " @username=#{@username.inspect}"
\r
187 str << " @netmasks=#{@netmasks.inspect}"
\r
188 str << " @perm=#{@perm.inspect}"
\r
189 str << " @login_by_mask=#{@login_by_mask}"
\r
190 str << " @autologin=#{@autologin}"
\r
194 # Convert into a hash
\r
197 :username => @username,
\r
198 :password => @password,
\r
199 :netmasks => @netmasks,
\r
201 :login_by_mask => @login_by_mask,
\r
202 :autologin => @autologin
\r
206 # Do we allow logging in without providing the password?
\r
212 # Do we allow automatic logging in?
\r
218 # Restore from hash
\r
220 @username = h[:username] if h.has_key?(:username)
\r
221 @password = h[:password] if h.has_key?(:password)
\r
222 @netmasks = h[:netmasks] if h.has_key?(:netmasks)
\r
223 @perm = h[:perm] if h.has_key?(:perm)
\r
224 @login_by_mask = h[:login_by_mask] if h.has_key?(:login_by_mask)
\r
225 @autologin = h[:autologin] if h.has_key?(:autologin)
\r
228 # This method sets the password if the proposed new password
\r
230 def password=(pwd=nil)
\r
233 raise InvalidPassword, "#{pwd} contains invalid characters" if pwd !~ /^[A-Za-z0-9]+$/
\r
234 raise InvalidPassword, "#{pwd} too short" if pwd.length < 4
\r
236 rescue InvalidPassword => e
\r
239 raise InvalidPassword, "Exception #{e.inspect} while checking #{pwd}"
\r
246 # Resets the password by creating a new onw
\r
248 @password = random_password
\r
251 # Sets the permission for command _cmd_ to _val_ on channel _chan_
\r
253 def set_permission(cmd, val, chan="*")
\r
254 k = chan.to_s.to_sym
\r
255 @perm[k] = PermissionSet.new unless @perm.has_key?(k)
\r
256 @perm[k].set_permission(cmd, val)
\r
259 # Resets the permission for command _cmd_ on channel _chan_
\r
261 def reset_permission(cmd, chan ="*")
\r
262 set_permission(cmd, nil, chan)
\r
265 # Checks if BotUser is allowed to do something on channel _chan_,
\r
266 # or on all channels if _chan_ is nil
\r
268 def permit?(cmd, chan=nil)
\r
270 k = chan.to_s.to_sym
\r
275 if @perm.has_key?(k)
\r
276 allow = @perm[k].permit?(cmd)
\r
283 def add_netmask(mask)
\r
284 @netmasks << mask.to_irc_netmask
\r
287 # Removes a Netmask
\r
289 def delete_netmask(mask)
\r
290 m = mask.to_irc_netmask
\r
291 @netmasks.delete(m)
\r
294 # Removes all <code>Netmask</code>s
\r
296 def reset_netmask_list
\r
297 @netmasks = NetmaskList.new
\r
300 # This method checks if BotUser has a Netmask that matches _user_
\r
303 user = usr.to_irc_user
\r
305 @netmasks.each { |n|
\r
306 if user.matches?(n)
\r
314 # This method gets called when User _user_ wants to log in.
\r
315 # It returns true or false depending on whether the password
\r
316 # is right. If it is, the Netmask of the user is added to the
\r
317 # list of acceptable Netmask unless it's already matched.
\r
318 def login(user, password)
\r
319 if password == @password or (@password.nil? and @login_by_mask and knows?(user))
\r
320 add_netmask(user) unless knows?(user)
\r
321 debug "#{user} logged in as #{self.inspect}"
\r
328 # # This method gets called when User _user_ has logged out as this BotUser
\r
330 # delete_netmask(user) if knows?(user)
\r
333 # This method sanitizes a username by chomping, downcasing
\r
334 # and replacing any nonalphanumeric character with _
\r
336 def BotUser.sanitize_username(name)
\r
337 return name.to_s.chomp.downcase.gsub(/[^a-z0-9]/,"_")
\r
343 # This is the default BotUser: it's used for all users which haven't
\r
344 # identified with the bot
\r
346 class DefaultBotUserClass < BotUser
\r
348 private :login, :add_netmask, :delete_netmask
\r
352 # The default BotUser is named 'everyone', it doesn't allow autologin
\r
353 # (meaningless) and it allows login-by-mask
\r
356 @login_by_mask = true
\r
359 @default_perm = PermissionSet.new
\r
362 # This method returns without changing anything
\r
364 def login_by_mask=(val)
\r
365 debug "Tried to change the login-by-mask for default bot user, ignoring"
\r
366 return @login_by_mask
\r
369 # This method returns without changing anything
\r
371 def autologin=(val)
\r
372 debug "Tried to change the autologin for default bot user, ignoring"
\r
376 # Sets the default permission for the default user (i.e. the ones
\r
377 # set by the BotModule writers) on all channels
\r
379 def set_default_permission(cmd, val)
\r
380 @default_perm.set_permission(Command.new(cmd), val)
\r
381 debug "Default permissions now:\n#{@default_perm.inspect}"
\r
384 # default knows everybody
\r
387 return true if user.to_irc_user
\r
390 # We always allow logging in as the default user
\r
391 def login(user, password)
\r
395 # Resets the NetmaskList
\r
396 def reset_netmask_list
\r
398 add_netmask("*!*@*")
\r
401 # DefaultBotUser will check the default_perm after checking
\r
403 # or on all channels if _chan_ is nil
\r
405 def permit?(cmd, chan=nil)
\r
406 allow = super(cmd, chan)
\r
407 if allow.nil? && chan.nil?
\r
408 allow = @default_perm.permit?(cmd)
\r
415 # Returns the only instance of DefaultBotUserClass
\r
417 def Auth.defaultbotuser
\r
418 return DefaultBotUserClass.instance
\r
421 # This is the BotOwner: he can do everything
\r
423 class BotOwnerClass < BotUser
\r
428 @login_by_mask = false
\r
433 def permit?(cmd, chan=nil)
\r
439 # Returns the only instance of BotOwnerClass
\r
442 return BotOwnerClass.instance
\r
446 # This is the AuthManagerClass singleton, used to manage User/BotUser connections and
\r
449 class AuthManagerClass
\r
453 attr_reader :everyone
\r
454 attr_reader :botowner
\r
456 # The instance manages two <code>Hash</code>es: one that maps
\r
457 # <code>Irc::User</code>s onto <code>BotUser</code>s, and the other that maps
\r
458 # usernames onto <code>BotUser</code>
\r
460 @everyone = Auth::defaultbotuser
\r
461 @botowner = Auth::botowner
\r
465 def bot_associate(bot)
\r
466 raise "Cannot associate with a new bot! Save first" if defined?(@has_changes) && @has_changes
\r
473 # This variable is set to true when there have been changes
\r
474 # to the botusers list, so that we know when to save
\r
475 @has_changes = false
\r
479 @has_changes = true
\r
483 @has_changes = false
\r
490 # resets the hashes
\r
492 @botusers = Hash.new
\r
493 @allbotusers = Hash.new
\r
494 [everyone, botowner].each { |x|
\r
495 @allbotusers[x.username.to_sym] = x
\r
499 def load_array(ary, forced)
\r
500 raise "Won't load with unsaved changes" if @has_changes and not forced
\r
503 raise TypeError, "#{x} should be a Hash" unless x.kind_of?(Hash)
\r
508 get_botuser(u).from_hash(x)
\r
514 @allbotusers.values.map { |x|
\r
519 # checks if we know about a certain BotUser username
\r
520 def include?(botusername)
\r
521 @allbotusers.has_key?(botusername.to_sym)
\r
524 # Maps <code>Irc::User</code> to BotUser
\r
525 def irc_to_botuser(ircuser)
\r
526 # TODO check netmasks
\r
527 @botusers[ircuser.to_irc_user] || everyone
\r
530 # creates a new BotUser
\r
531 def create_botuser(name, password=nil)
\r
532 n = BotUser.sanitize_username(name)
\r
534 raise "BotUser #{n} exists" if include?(k)
\r
535 bu = BotUser.new(n)
\r
536 bu.password = password
\r
537 @allbotusers[k] = bu
\r
540 # returns the botuser with name _name_
\r
541 def get_botuser(name)
\r
542 @allbotusers.fetch(BotUser.sanitize_username(name).to_sym)
\r
545 # Logs Irc::User _user_ in to BotUser _botusername_ with password _pwd_
\r
547 # raises an error if _botusername_ is not a known BotUser username
\r
549 # It is possible to autologin by Netmask, on request
\r
551 def login(user, botusername, pwd)
\r
552 ircuser = user.to_irc_user
\r
553 n = BotUser.sanitize_username(botusername)
\r
555 raise "No such BotUser #{n}" unless include?(k)
\r
556 if @botusers.has_key?(ircuser)
\r
557 return true if @botusers[ircuser].name = n
\r
559 # @botusers[ircuser].logout(ircuser)
\r
561 bu = @allbotusers[k]
\r
562 if bu.login(ircuser, pwd)
\r
563 @botusers[ircuser] = bu
\r
569 # Tries to auto-login Irc::User _user_ by looking at the known botusers that allow autologin
\r
570 # and trying to login without a password
\r
572 def autologin(user)
\r
573 ircuser = user.to_irc_user
\r
574 debug "Trying to autlogin #{ircuser}"
\r
575 return @botusers[ircuser] if @botusers.has_key?(ircuser)
\r
576 @allbotusers.each { |n, bu|
\r
577 debug "Checking with #{n}"
\r
578 return bu if bu.autologin? and login(ircuser, n)
\r
583 # Checks if User _user_ can do _cmd_ on _chan_.
\r
585 # Permission are checked in this order, until a true or false
\r
587 # * associated BotUser on _chan_
\r
588 # * associated BotUser on all channels
\r
589 # * everyone on _chan_
\r
590 # * everyone on all channels
\r
592 def permit?(user, cmdtxt, channel=nil)
\r
593 botuser = irc_to_botuser(user)
\r
594 cmd = cmdtxt.to_irc_auth_command
\r
606 allow = botuser.permit?(cmd, chan) if chan
\r
607 return allow unless allow.nil?
\r
608 allow = botuser.permit?(cmd)
\r
609 return allow unless allow.nil?
\r
611 unless botuser == everyone
\r
612 allow = everyone.permit?(cmd, chan) if chan
\r
613 return allow unless allow.nil?
\r
614 allow = everyone.permit?(cmd)
\r
615 return allow unless allow.nil?
\r
618 raise "Could not check permission for user #{user.inspect} to run #{cmdtxt.inspect} on #{chan.inspect}"
\r
621 # Checks if command _cmd_ is allowed to User _user_ on _chan_
\r
622 def allow?(cmdtxt, user, chan=nil)
\r
623 permit?(user, cmdtxt, chan)
\r
628 # Returns the only instance of AuthManagerClass
\r
630 def Auth.authmanager
\r
631 return AuthManagerClass.instance
\r