3 # :title: User management
6 # Author:: Giuseppe Bilotta (giuseppe.bilotta@gmail.com)
12 # This would be a good idea if it was failproof, but the truth
13 # is that other methods can indirectly modify the hash. *sigh*
15 # class AuthNotifyingHash < Hash
16 # %w(clear default= delete delete_if replace invert
17 # merge! update rehash reject! replace shift []= store).each { |m|
19 # define_method(m) { |*a|
21 # Irc::Bot::Auth.manager.set_changed
33 # This module contains the actual Authentication stuff
37 Config.register Config::StringValue.new( 'auth.password',
38 :default => 'rbotauth', :wizard => true,
39 :on_change => Proc.new {|bot, v| bot.auth.botowner.password = v},
40 :desc => _('Password for the bot owner'))
41 Config.register Config::BooleanValue.new( 'auth.login_by_mask',
43 :desc => _('Set false to prevent new botusers from logging in without a password when the user netmask is known'))
44 Config.register Config::BooleanValue.new( 'auth.autologin',
46 :desc => _('Set false to prevent new botusers from recognizing IRC users without a need to manually login'))
47 Config.register Config::BooleanValue.new( 'auth.autouser',
49 :desc => _('Set true to allow new botusers to be created automatically'))
50 # Config.register Config::IntegerValue.new( 'auth.default_level',
51 # :default => 10, :wizard => true,
52 # :desc => 'The default level for new/unknown users' )
54 # Generate a random password of length _l_
56 def Auth.random_password(l=8)
59 pwd << (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr
65 # An Irc::Bot::Auth::Command defines a command by its "path":
67 # base::command::subcommand::subsubcommand::subsubsubcommand
71 attr_reader :command, :path
73 # A method that checks if a given _cmd_ is in a form that can be
74 # reduced into a canonical command path, and if so, returns it
76 def sanitize_command_path(cmd)
77 pre = cmd.to_s.downcase.gsub(/^\*?(?:::)?/,"").gsub(/::$/,"")
78 return pre if pre.empty?
79 return pre if pre =~ /^\S+(::\S+)*$/
80 raise TypeError, "#{cmd.inspect} is not a valid command"
83 # Creates a new Command from a given string; you can then access
84 # the command as a symbol with the :command method and the whole
87 # Command.new("core::auth::save").path => [:"*", :"core", :"core::auth", :"core::auth::save"]
89 # Command.new("core::auth::save").command => :"core::auth::save"
92 cmdpath = sanitize_command_path(cmd).split('::')
93 seq = cmdpath.inject(["*"]) { |list, cmd|
94 list << (list.length > 1 ? list.last + "::" : "") + cmd
100 debug "Created command #{@command.inspect} with path #{@path.pretty_inspect}"
104 def to_irc_auth_command
118 # Returns an Irc::Bot::Auth::Comand from the receiver
119 def to_irc_auth_command
120 Irc::Bot::Auth::Command.new(self)
128 # Returns an Irc::Bot::Auth::Comand from the receiver
129 def to_irc_auth_command
130 Irc::Bot::Auth::Command.new(self)
143 # This class describes a permission set
147 # Create a new (empty) PermissionSet
153 # Inspection simply inspects the internal hash
158 # Sets the permission for command _cmd_ to _val_,
160 def set_permission(str, val)
161 cmd = str.to_irc_auth_command
164 @perm[cmd.command] = val
166 @perm.delete(cmd.command)
168 raise TypeError, "#{val.inspect} must be true or false" unless [true,false].include?(val)
172 # Resets the permission for command _cmd_
174 def reset_permission(cmd)
175 set_permission(cmd, nil)
178 # Tells if command _cmd_ is permitted. We do this by returning
179 # the value of the deepest Command#path that matches.
182 cmd = str.to_irc_auth_command
183 # TODO user-configurable list of always-allowed commands,
184 # for admins that want to set permissions -* for everybody
185 return true if cmd.command == :login
187 cmd.path.reverse.each { |k|
199 # This is the error that gets raised when an invalid password is met
201 class InvalidPassword < RuntimeError
205 # This is the basic class for bot users: they have a username, a
206 # password, a list of netmasks to match against, and a list of
207 # permissions. A BotUser can be marked as 'transient', usually meaning
208 # it's not intended for permanent storage. Transient BotUsers have lower
209 # priority than nontransient ones for autologin purposes.
211 # To initialize a BotUser, you pass a _username_ and an optional
212 # hash of options. Currently, only two options are recognized:
214 # transient:: true or false, determines if the BotUser is transient or
215 # permanent (default is false, permanent BotUser).
217 # Transient BotUsers are initialized by prepending an
218 # asterisk (*) to the username, and appending a sanitized
219 # version of the object_id. The username can be empty.
220 # A random password is generated.
222 # Permanent Botusers need the username as is, and no
223 # password is generated.
225 # masks:: an array of Netmasks to initialize the NetmaskList. This
226 # list is used as-is for permanent BotUsers.
228 # Transient BotUsers will alter the list elements which are
229 # Irc::User by globbing the nick and any initial nonletter
232 # The masks option is optional for permanent BotUsers, but
233 # obligatory (non-empty) for transients.
237 attr_reader :username
238 attr_reader :password
239 attr_reader :netmasks
241 attr_reader :perm_temp
242 attr_writer :login_by_mask
243 attr_writer :transient
249 @netmasks.each { |n| Auth.manager.maskdb.remove(self, n) }
251 @netmasks.each { |n| Auth.manager.maskdb.add(self, n) }
255 # Checks if the BotUser is transient
260 # Checks if the BotUser is permanent (not transient)
265 # Sets if the BotUser is permanent or not
270 # Make the BotUser permanent
271 def make_permanent(name)
272 raise TypeError, "permanent already" if permanent?
273 @username = BotUser.sanitize_username(name)
276 reset_password # or not?
277 @netmasks.dup.each do |m|
279 add_netmask(m.generalize)
283 # Create a new BotUser with given username
284 def initialize(username, options={})
285 opts = {:transient => false}.merge(options)
286 @transient = opts[:transient]
290 @username << BotUser.sanitize_username(username) if username and not username.to_s.empty?
291 @username << BotUser.sanitize_username(object_id)
296 @username = BotUser.sanitize_username(username)
302 @netmasks = NetmaskList.new
303 if opts.key?(:masks) and opts[:masks]
305 masks = [masks] unless masks.respond_to?(:each)
307 mask = m.to_irc_netmask
308 if @transient and User === m
310 mask.host = m.host.dup
311 mask.user = "*" + m.user.sub(/^\w?[^\w]+/,'')
313 add_netmask(mask) unless mask.to_s == "*"
316 raise "must provide a usable mask for transient BotUser #{@username}" if @transient and @netmasks.empty?
324 str = self.__to_s__[0..-2]
325 str << " (transient)" if @transient
327 str << " @username=#{@username.inspect}"
328 str << " @netmasks=#{@netmasks.inspect}"
329 str << " @perm=#{@perm.inspect}"
330 str << " @perm_temp=#{@perm_temp.inspect}" unless @perm_temp.empty?
331 str << " @login_by_mask=#{@login_by_mask}"
332 str << " @autologin=#{@autologin}"
341 # Convert into a hash
344 :username => @username,
345 :password => @password,
346 :netmasks => @netmasks,
348 :login_by_mask => @login_by_mask,
349 :autologin => @autologin,
353 # Do we allow logging in without providing the password?
359 # Reset the login-by-mask option
361 def reset_login_by_mask
362 @login_by_mask = Auth.manager.bot.config['auth.login_by_mask'] unless defined?(@login_by_mask)
365 # Reset the autologin option
368 @autologin = Auth.manager.bot.config['auth.autologin'] unless defined?(@autologin)
371 # Do we allow automatic logging in?
379 @username = h[:username] if h.has_key?(:username)
380 @password = h[:password] if h.has_key?(:password)
381 @login_by_mask = h[:login_by_mask] if h.has_key?(:login_by_mask)
382 @autologin = h[:autologin] if h.has_key?(:autologin)
383 if h.has_key?(:netmasks)
384 @netmasks = h[:netmasks]
386 @netmasks.each { |n| Auth.manager.maskdb.add(self, n) } if @autologin
389 @perm = h[:perm] if h.has_key?(:perm)
392 # This method sets the password if the proposed new password
394 def password=(pwd=nil)
400 raise InvalidPassword, "#{pass} contains invalid characters" if pass !~ /^[\x21-\x7e]+$/
401 raise InvalidPassword, "#{pass} too short" if pass.length < 4
403 rescue InvalidPassword => e
406 raise InvalidPassword, "Exception #{e.inspect} while checking #{pass.inspect} (#{pwd.inspect})"
411 # Resets the password by creating a new onw
413 @password = Auth.random_password
416 # Sets the permission for command _cmd_ to _val_ on channel _chan_
418 def set_permission(cmd, val, chan="*")
420 @perm[k] = PermissionSet.new unless @perm.has_key?(k)
421 @perm[k].set_permission(cmd, val)
424 # Resets the permission for command _cmd_ on channel _chan_
426 def reset_permission(cmd, chan ="*")
427 set_permission(cmd, nil, chan)
430 # Sets the temporary permission for command _cmd_ to _val_ on channel _chan_
432 def set_temp_permission(cmd, val, chan="*")
434 @perm_temp[k] = PermissionSet.new unless @perm_temp.has_key?(k)
435 @perm_temp[k].set_permission(cmd, val)
438 # Resets the temporary permission for command _cmd_ on channel _chan_
440 def reset_temp_permission(cmd, chan ="*")
441 set_temp_permission(cmd, nil, chan)
444 # Checks if BotUser is allowed to do something on channel _chan_,
445 # or on all channels if _chan_ is nil
447 def permit?(cmd, chan=nil)
454 pt = @perm.merge @perm_temp
456 allow = pt[k].permit?(cmd)
463 def add_netmask(mask)
464 m = mask.to_irc_netmask
467 Auth.manager.maskdb.add(self, m)
468 Auth.manager.logout_transients(m) if self.permanent?
474 def delete_netmask(mask)
475 m = mask.to_irc_netmask
477 Auth.manager.maskdb.remove(self, m) if self.autologin?
480 # Reset Netmasks, clearing @netmasks
484 Auth.manager.maskdb.remove(self, m) if self.autologin?
489 # This method checks if BotUser has a Netmask that matches _user_
492 user = usr.to_irc_user
493 !!@netmasks.find { |n| user.matches? n }
496 # This method gets called when User _user_ wants to log in.
497 # It returns true or false depending on whether the password
498 # is right. If it is, the Netmask of the user is added to the
499 # list of acceptable Netmask unless it's already matched.
500 def login(user, password=nil)
501 if password == @password or (password.nil? and (@login_by_mask || @autologin) and knows?(user))
502 add_netmask(user) unless knows?(user)
503 debug "#{user} logged in as #{self.inspect}"
510 # # This method gets called when User _user_ has logged out as this BotUser
512 # delete_netmask(user) if knows?(user)
515 # This method sanitizes a username by chomping, downcasing
516 # and replacing any nonalphanumeric character with _
518 def BotUser.sanitize_username(name)
519 candidate = name.to_s.chomp.downcase.gsub(/[^a-z0-9]/,"_")
520 raise "sanitized botusername #{candidate} too short" if candidate.length < 3
526 # This is the default BotUser: it's used for all users which haven't
527 # identified with the bot
529 class DefaultBotUserClass < BotUser
531 private :add_netmask, :delete_netmask
535 # The default BotUser is named 'everyone'
541 @default_perm = PermissionSet.new
544 # This method returns without changing anything
546 def login_by_mask=(val)
547 debug "Tried to change the login-by-mask for default bot user, ignoring"
548 return @login_by_mask
551 # The default botuser allows logins by mask
553 def reset_login_by_mask
554 @login_by_mask = true
557 # This method returns without changing anything
560 debug "Tried to change the autologin for default bot user, ignoring"
564 # The default botuser doesn't allow autologin (meaningless)
570 # Sets the default permission for the default user (i.e. the ones
571 # set by the BotModule writers) on all channels
573 def set_default_permission(cmd, val)
574 @default_perm.set_permission(Command.new(cmd), val)
575 debug "Default permissions now: #{@default_perm.pretty_inspect}"
578 # default knows everybody
581 return true if user.to_irc_user
584 # We always allow logging in as the default user
585 def login(user, password)
589 # DefaultBotUser will check the default_perm after checking
591 # or on all channels if _chan_ is nil
593 def permit?(cmd, chan=nil)
594 allow = super(cmd, chan)
595 if allow.nil? && chan.nil?
596 allow = @default_perm.permit?(cmd)
603 # Returns the only instance of DefaultBotUserClass
605 def Auth.defaultbotuser
606 return DefaultBotUserClass.instance
609 # This is the BotOwner: he can do everything
611 class BotOwnerClass < BotUser
616 @login_by_mask = false
621 def permit?(cmd, chan=nil)
627 # Returns the only instance of BotOwnerClass
630 return BotOwnerClass.instance
635 # Check if the current BotUser is the default one
637 return DefaultBotUserClass === self
640 # Check if the current BotUser is the owner
642 return BotOwnerClass === self
647 # This is the ManagerClass singleton, used to manage
648 # Irc::User/Irc::Bot::Auth::BotUser connections and everything
655 attr_reader :everyone
656 attr_reader :botowner
659 # The instance manages two <code>Hash</code>es: one that maps
660 # <code>Irc::User</code>s onto <code>BotUser</code>s, and the other that maps
661 # usernames onto <code>BotUser</code>
663 @everyone = Auth::defaultbotuser
664 @botowner = Auth::botowner
668 def bot_associate(bot)
669 raise "Cannot associate with a new bot! Save first" if defined?(@has_changes) && @has_changes
676 # This variable is set to true when there have been changes
677 # to the botusers list, so that we know when to save
696 @maskdb = NetmaskDb.new
697 @allbotusers = Hash.new
698 [everyone, botowner].each do |x|
699 @allbotusers[x.username.to_sym] = x
703 def load_array(ary, forced)
705 warning "Tried to load an empty array"
708 raise "Won't load with unsaved changes" if @has_changes and not forced
711 raise TypeError, "#{x} should be a Hash" unless x.kind_of?(Hash)
716 get_botuser(u).from_hash(x)
717 get_botuser(u).transient = false
723 @allbotusers.values.map { |x|
724 x.transient? ? nil : x.to_hash
728 # checks if we know about a certain BotUser username
729 def include?(botusername)
730 @allbotusers.has_key?(botusername.to_sym)
733 # Maps <code>Irc::User</code> to BotUser
734 def irc_to_botuser(ircuser)
735 logged = @botusers[ircuser.to_irc_user]
736 return logged if logged
737 return autologin(ircuser)
740 # creates a new BotUser
741 def create_botuser(name, password=nil)
742 n = BotUser.sanitize_username(name)
744 raise "botuser #{n} exists" if include?(k)
746 bu.password = password
751 # returns the botuser with name _name_
752 def get_botuser(name)
753 @allbotusers.fetch(BotUser.sanitize_username(name).to_sym)
756 # Logs Irc::User _user_ in to BotUser _botusername_ with password _pwd_
758 # raises an error if _botusername_ is not a known BotUser username
760 # It is possible to autologin by Netmask, on request
762 def login(user, botusername, pwd=nil)
763 ircuser = user.to_irc_user
764 n = BotUser.sanitize_username(botusername)
766 raise "No such BotUser #{n}" unless include?(k)
767 if @botusers.has_key?(ircuser)
768 return true if @botusers[ircuser].username == n
770 # @botusers[ircuser].logout(ircuser)
773 if bu.login(ircuser, pwd)
774 @botusers[ircuser] = bu
780 # Tries to auto-login Irc::User _user_ by looking at the known botusers that allow autologin
781 # and trying to login without a password
784 ircuser = user.to_irc_user
785 debug "Trying to autologin #{ircuser}"
786 return @botusers[ircuser] if @botusers.has_key?(ircuser)
787 bu = maskdb.find(ircuser)
790 bu.login(ircuser) or raise '...what?!'
791 @botusers[ircuser] = bu
794 # Finally, create a transient if we're set to allow it
795 if @bot.config['auth.autouser']
796 bu = create_transient_botuser(ircuser)
797 @botusers[ircuser] = bu
803 # Creates a new transient BotUser associated with Irc::User _user_,
804 # automatically logging him in. Note that transient botuser creation can
805 # fail, typically if we don't have the complete user netmask (e.g. for
806 # messages coming in from a linkbot)
808 def create_transient_botuser(user)
809 ircuser = user.to_irc_user
812 bu = BotUser.new(ircuser, :transient => true, :masks => ircuser)
815 warning "failed to create transient for #{user}"
821 # Logs out any Irc::User matching Irc::Netmask _m_ and logged in
822 # to a transient BotUser
824 def logout_transients(m)
825 debug "to check: #{@botusers.keys.join ' '}"
826 @botusers.keys.each do |iu|
827 debug "checking #{iu.fullform} against #{m.fullform}"
829 bu.transient? or next
830 iu.matches?(m) or next
831 @botusers.delete(iu).autologin = false
835 # Makes transient BotUser _user_ into a permanent BotUser
836 # named _name_; if _user_ is an Irc::User, act on the transient
837 # BotUser (if any) it's logged in as
839 def make_permanent(user, name)
840 buname = BotUser.sanitize_username(name)
841 # TODO merge BotUser instead?
842 raise "there's already a BotUser called #{name}" if include?(buname)
846 when String, Irc::User
847 tuser = irc_to_botuser(user)
851 raise TypeError, "sorry, don't know how to make #{user.class} into a permanent BotUser"
853 return nil unless tuser
854 raise TypeError, "#{tuser} is not transient" unless tuser.transient?
856 tuser.make_permanent(buname)
857 @allbotusers[tuser.username.to_sym] = tuser
862 # Checks if User _user_ can do _cmd_ on _chan_.
864 # Permission are checked in this order, until a true or false
866 # * associated BotUser on _chan_
867 # * associated BotUser on all channels
868 # * everyone on _chan_
869 # * everyone on all channels
871 def permit?(user, cmdtxt, channel=nil)
872 if user.class <= BotUser
875 botuser = irc_to_botuser(user)
877 cmd = cmdtxt.to_irc_auth_command
889 allow = botuser.permit?(cmd, chan) if chan
890 return allow unless allow.nil?
891 allow = botuser.permit?(cmd)
892 return allow unless allow.nil?
894 unless botuser == everyone
895 allow = everyone.permit?(cmd, chan) if chan
896 return allow unless allow.nil?
897 allow = everyone.permit?(cmd)
898 return allow unless allow.nil?
901 raise "Could not check permission for user #{user.inspect} to run #{cmdtxt.inspect} on #{chan.inspect}"
904 # Checks if command _cmd_ is allowed to User _user_ on _chan_, optionally
905 # telling if the user is authorized
907 def allow?(cmdtxt, user, chan=nil)
908 if permit?(user, cmdtxt, chan)
911 # cmds = cmdtxt.split('::')
912 # @bot.say chan, "you don't have #{cmds.last} (#{cmds.first}) permissions here" if chan
913 @bot.say chan, _("%{user}, you don't have '%{command}' permissions here") %
914 {:user=>user, :command=>cmdtxt} if chan
921 # Returns the only instance of ManagerClass
924 return ManagerClass.instance
932 # A convenience method to automatically found the botuser
933 # associated with the receiver
936 Irc::Bot::Auth.manager.irc_to_botuser(self)