Editing Security

From Bebot Wiki 2
Jump to navigationJump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
 
BeBot's Security Management System
 
BeBot's Security Management System
 
  
'''Introduction'''
+
[b]Introduction[/b]
  
 
BeBot's Security Management System aims to provide a common interface and structure for dealing with all things security. This document describes the use of the Security system for Module (and BeBot) Developers.
 
BeBot's Security Management System aims to provide a common interface and structure for dealing with all things security. This document describes the use of the Security system for Module (and BeBot) Developers.
Line 27: Line 26:
 
In addition to the security options provided by user levels and org ranks, the bot's superadmins are able to create custom security groups and add players to these groups. When a new security group is created, it is assigned the access level ANONYMOUS. Use the Security Access Level interface to raise and lower the access of a custom group.
 
In addition to the security options provided by user levels and org ranks, the bot's superadmins are able to create custom security groups and add players to these groups. When a new security group is created, it is assigned the access level ANONYMOUS. Use the Security Access Level interface to raise and lower the access of a custom group.
 
Basic use the Security System in your modules
 
Basic use the Security System in your modules
 
 
'''Commands'''
 
 
Each core or module commands have a default access level hardcoded & that is set for obvious security : the highest sensibility worth the highest level, indeed. Those access levels are recorded into your database on first bot launch. That means changing the code for different access level on a command after first launch will have no effect. To edit this you must therefore edit your database, specifically the table named botname_access_level ... which could be done by direct request if you're easy enough with SQL language, otherwise and more visually we advice you to install PHPMyAdmin on your server and connect to database that way.
 
 
You will therefore be able to easily overview various commands access levels, with subcommand and/or originating channel. Simply click the minlevel value you want to change and select the new value in the proposed list as shown below :
 
 
http://wiki.bebot.link/images/access_level_php_admin.jpg
 
 
Once all is set as you want, simply restart your bot to see changes take effect.
 
 
 
'''Modules'''
 
  
 
To make security easy for module developers, the check_access function provides all the security checks you will need. When assigning security to commands, you should always use one of the eight access levels, not security groups. This allows the bot user full flexibility with their configuration as org ranks and custom security groups must be assigned access levels.
 
To make security easy for module developers, the check_access function provides all the security checks you will need. When assigning security to commands, you should always use one of the eight access levels, not security groups. This allows the bot user full flexibility with their configuration as org ranks and custom security groups must be assigned access levels.
Line 66: Line 51:
 
When you wish to send notification about a ban, you should always use BeBot's send_ban function. The send_ban function has built in spam control that will prevent a banned user from filling up your bot's tell queue with outgoing ban notifications.
 
When you wish to send notification about a ban, you should always use BeBot's send_ban function. The send_ban function has built in spam control that will prevent a banned user from filling up your bot's tell queue with outgoing ban notifications.
 
Advanced use the Security System in your modules
 
Advanced use the Security System in your modules
 
 
'''Functions'''
 
  
 
The Security Module provides the following functions for modifying the roster and security groups.
 
The Security Module provides the following functions for modifying the roster and security groups.

Please note that all contributions to Bebot Wiki 2 may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Bebot Wiki 2:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)