Class Irc::IrcAuth
In: lib/rbot/auth.rb
Parent: Object

User-level authentication to allow/disallow access to bot commands based on hostmask and userlevel.

Methods

allow?   help   identify   matchingUser   new   privmsg   save   setlevel   showdetails   showlevels   showusers   useradd   userdel   usermod  

Public Class methods

new(bot)

create a new IrcAuth instance.

bot:associated bot class

Public Instance methods

allow?( command, mask, tell=nil )
command:command user wishes to perform
mask:hostmask of user
tell:optional recipient for "insufficient auth" message

returns true if user with hostmask mask is permitted to perform command optionally pass tell as the target for the "insufficient auth" message, if the user is not authorised

help(topic='')

module help

privmsg(m)

privmsg handler

save()

save current users and levels to files. levels are written to #{botclass}/levels.rbot users are written to #{botclass}/users.yaml

setlevel(command, level)
command:command to adjust
level:new auth level for the command

set required auth level of command to level

showlevels()

return all currently defined commands (for which auth is required) and their required authlevels

showusers()

return all currently defined users and their authlevels

useradd( username, level=@bot.config['auth.default_level'], password='', hostmask='*!*@*' )

add user with hostmask matching mask with initial auth level level

userdel( username )
mask:mask of user to remove

remove user with mask mask

[Validate]