CFLib.org – Common Function Library Project

Description:
This function is based on the secure.cfm customtag used in FuseBox 3 and authored by Hal Helms. This function validates user permissions against required permissions for code execution using either Bit, List or custom validation.

Return Values:
Returns a boolean.

Example:

<cfset objPermission="4">
<cfset userPermissions="20">
<cfoutput>
<p>
<strong>Example 1: Bit Validation</strong><br />
<cfif secure( "bit", objPermission, userPermissions )>
    Permission Granted. Execute some code...
<cfelse>
    Permission Denied.
</cfif>
</p>
<cfset objPermission="Admin">
<cfset userPermissions="User">
<p>
<strong>Example 2: List Validation</strong><br />
<cfif secure( "List", objPermission, userPermissions )>
    Permission Granted. Execute some code...
<cfelse>
    Permission Denied.
</cfif>
</p>

<cfset objPermission="objRights">
<cfset userPermissions="stUserRights">
<p>
<strong>Example 3: Custom Validation</strong><br />
<cfif secure( "customModel", objPermission, userPermissions )>
    Permission Granted. Execute some code...
<cfelse>
    Permission Denied.
</cfif>

</cfoutput>

Parameters:

Full UDF Source:

/**
 * This function validates user permissions against required permissions using Bit, List or custom validation.
 * 
 * @param model      String, "bit" or "list" (Required)
 * @param requiredPermission      Permissions required for access. (Required)
 * @param userPermissions      Permissions of the user. (Required)
 * @return Returns a boolean. 
 * @author Rob Rusher (rob@robrusher.com) 
 * @version 1, September 27, 2002 
 */
function Secure(model, requiredPermission, userPermissions) {
    var permitted = false;
    // Switch to appropriate security model
    switch( model ) {
        // Bit Validation
        case "bit":
        {
            if ( BitAnd( userPermissions, requiredPermission ) ) {
                permitted = true;
            }
            break;
        }
        // List Validation
        case "list":
        {
            if ( ListFindNoCase( userPermissions, requiredPermission ) ) {
                permitted = true;
            }
            break;
        }
        default: {
            // Define custom validation here.
            permitted = true;
        }
    }
    
    return (permitted);
}