Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Tank Auth w/ Role-Based Access Control (RBAC) lets you create multiple roles for all your users. This is a more comprehensive version compared to the default Tank Auth release. Other features have also been added to this release. For more info, see the README below.
PHP
branch: master

This branch is 55 commits ahead of TankAuth:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
application
captcha
README.md
Tank-auth-schema-by-enchance.pdf
addon-country.sql
sample-RBAC.sql
schema.sql

README.md

UPDATE: Fork merged with main Tank Auth repo :-)

Tank Auth v2.0 will be coming out soon which will include some new features from this fork. Until full integration has been completed, this fork will be upgraded in batches taken from upstream.

Thanks for everyone who used my RBAC-powered version of Tank Auth!

Tank Auth w/ Role-Based Access Control (RBAC)

Version: Beta v2.2

This version implements a Role-Based Access Control method popular in multiuser sites. A huge portion of Tank Auth was redeveloped to get this library working. This new release is bursting with so much vitamins and minerals it's practically its own food group! Okay, maybe not.

New Features

  1. Role-Based Access Control for multi-user sites. For more info on RBAC, refer to this post.
  2. User-level permission overrides for added flexibility
  3. Add custom fields to your registration page
  4. Approve user registrations manually. Users can now register and activate but not enter until they are approved. By default, all registrants are auto-approved: $config['acct_approval'] = TRUE
  5. Now uses Cool Captcha as the default captcha (you can still switch to reCaptcha)
  6. Custom views for basic notifications (no more editing the lang file)

Feature requests:

  1. Manual approval of users - COMPLETE
  2. Custom views for easier customization of notifications - COMPLETE

How to use Tank Auth w/ RBAC

New Methods

Arguments for the methods below can be found in the Tank_auth.php library. Lift those sticky fingers and Cmd/Ctrl+F like your sex life depended on it!

  • permit(): The most important method of all! This checks if the user is allowed to do a certain permission (e.g. view a page)
  • add_permission() and remove_permission(): Add/Remove permissions of roles. All permissions are listed in the permissions.permission table.
  • new_permission(), clear_permission(), and save_permission(): Insert data in the permissions table.
  • add_override(), remove_override(), and flip_override(): Override permissions on a per-user basis. This allows you to give/take away permissions to users outside of their active role/s.
  • add_role(), remove_role(), change_role(): Basic role management for Users. If you're looking to create new roles in the roles table, I suggest you do it in SQL.

Sample use for permit():

// Controller
// The permit() method has 1 argument which is any value from the `permissions.permission` field

if($this->tank_auth->permit('edit page')){
    // Success
}
else {
    // Fail
}

Directions on first Use

Below are instructions on how to use this fork. I tried my best to be as thorough as possible but if there's anything unclear then let me know and I'll clear it up for you.

I. Empty all data

  1. Clear all table data: roles, permissions, and role_permissions table. These are values I used for testing and are also examples on how to populate these 3 tables. You may opt to keep them to familiarize yourself of its use.

You may choose to retain the data in the roles table. These include the most common roles found in every system and can be of use in your project.

II. Populate the permissions and roles table

  1. Populate the permissions table. These list down the permissions your users can take. Keep values for the permission field short and it's recommended that the first word be a verb (e.g. 'create user').
  2. Fields in permissions table: description, parent, and sort. These are recommended but are optional since they are used if you are displaying your options in HTML in case you allow certain roles to manage permissions through the use of a form. If you prefer to use SQL instead of creating a form then these can be left empty.
  3. Populate the roles table: create the roles your project will use. This RBAC setup allows users to have 1 or more roles. This prevents an influx of creating too many roles to accomodate user responsibilities.
  4. Fields in roles table: role, full, and default. Keep the role field one-word and lowercase for easy typing since this is what you will use when running the permit() method. The full field is the full name of the role and can be used if you're displaying your role permissions in HTML. The default field specifies which role is the default role when users sign up.
  5. Populate the role_permissions table. Listing of all the permissions a role can take.

Permissions are assigned to roles and not users. For special cases where a certain user needs a permission outside of their role, use the overrides table (Section IV: Give user extra permissions outside of their role).

III. Assigning roles to users

  1. Just assign the default role in the roles.default field and the system does the rest. When a user signs up, he/she will be given that role.
  2. If the user is the very first user ever, they will automatically be given a role with the role_id of 1. This is preferrably the Admin role. This action bypasses the default role.

The roles default schema:

mysql> SELECT * FROM roles;
+---------+-------+---------------+---------+
| role_id | role  | full          | default |
+---------+-------+---------------+---------+
|       1 | admin | Administrator |       0 |
|       2 | mod   | Moderator     |       0 |
|       3 | user  | User          |       1 |
+---------+-------+---------------+---------+

Roles are only given once a user has been activated and not before. This keeps your tables clean and free from any unnecessary inserts. Users are only given 1 role upon registration but if you want to add more roles to a user, you'll have to do it after they're activated using the add_role() method to do so.

IV. Give user extra permissions outside of their role (Optional)

Developer's note: This is used on a case-to-case basis only. It allows for extended flexibility on how you manage your users.

  1. Customize your user's permissions. If you want to give certain user's extra power outside of their role, you can use the overrides table for that. This table allows you to add permissions outside of a user's role as well as remove permissions already within their role.
  2. Fields in overrides table: allow. This says whether a user can or cannot do a certain permission. Use add_override() to add to a user's permissions. The flip_override() method flips the allow field from a 1 to a 0 and vice versa.

When using the permit() method, this checks your existing permissions from your role/s as well as any overrides you may have on certain permissions. Cool!

Custom Registration Fields

Before you add any custom registration fields, make sure you've created a field for it in the user_profiles table. That's where your user's data will be transferred once they've been activated. Do this and the sky won't fall on your head.

Assign custom fields using the $config['registration_fields'] array.

How it works: Field data is serialized in the users.meta field until the account is activated. After that, all data is transferred to the user_profiles table where it stays for the duration of the account.

1. Text input format: array(Name, Label, Rules, 'text', Attributes)

How to use:

// Sample 1
$config['registration_fields'][] = array('name', 'Full name', 'trim|required', 'text');

// Sample 2 w/ optional attribute
$attr = array(
    'class'=>'bigfont'
);
$config['registration_fields'][] = array('name', 'Full name', 'trim|required', 'text', $attr);

2. Radio format: array(Name, Label, Rules, 'radio', Selection, Opening tag, Closing tag)

How to use:

$selection = array(
    'm'=>'Male',
    'f'=>'Female'
);

// Sample 1
$config['registration_fields'][] = array('gender', 'Gender', 'trim|required|alpha|max_length[1]', 'radio', $selection);

// Sample 2 w/ <p> tags separating each radio item
$config['registration_fields'][] = array('gender', 'Gender', 'trim|required|alpha|max_length[1]', 'radio', $selection, '<p>', '</p>');

Radio fields do not have any assigned default value (unlike checkbox fields).

3. Dropdown format: array(Name, Label, Rules, 'dropdown', Selection, Default)

How to use:

// Sample 1: Manual dropdown creation
// Make the initial value '0' so the field will fail if selected
$selection = array(
    '0'=>'- choose -',
    'US'=>'USA',
    'PH'=>'Philippines',
    'JP'=>'Japan'
);
$config['registration_fields'][] = array('country', 'Country', 'trim|required|callback__not_zero', 'dropdown', $selection);

// Sample 2: Manual w/ default value
$config['registration_fields'][] = array('country', 'Country', 'trim|required|callback__not_zero', 'dropdown', $selection, 'default_value');

// Sample 3: Get data for select from db
$config['registration_fields'][] = array('country', 'Country', 'trim|required|callback__not_zero', 'dropdown', '[table.field1, table.field2]');

// Sample 4: DB w/ default value
$config['registration_fields'][] = array('country', 'Country', 'trim|required|callback__not_zero', 'dropdown', '[table.field1, table.field2]', 'default_value');

When getting data from the db with '[table.field1, table.field2]', field1 is the key, and field2 the value.

The callback _not_zero simply returns FALSE if the value is 0.

4. Checkbox format: array(Name, Label, Rules, 'checkbox', Checkbox Label, Default Checked)

How to use:

// Sample 1
$config['registration_fields'][] = array('money', 'Money', 'trim|numeric', 'checkbox', 'I want money');

// Sample 2: checkbox is checked by default
$config['registration_fields'][] = array('money', 'Money', 'trim|numeric', 'checkbox', 'I want money', TRUE);

Changelog

  1. Place more than one custom dropdown field in your registration page and use db data for it - Sep 17, 2012
  2. Added views for each basic notification instead of using the lang file - Sep 16, 2012
  3. Wrote the How to use Tank Auth w/ RBAC directives (whew!) - Sep 15, 2012
  4. Initial RBAC functionality achieved: Add/Remove/Change roles - Sep 12, 2012
  5. Check permissions with the permit() method which allows you to override permissions on a user-level scope - Sep 11, 2012
  6. Add custom fields to the registration page - Sep 10, 2012
  7. Implement Cool Captcha instead of the default captcha - Aug 29, 2012
Something went wrong with that request. Please try again.