Access Control"

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

(New page: __TOC__ Access control is a way you to give your users different permissions while working on folders and files. The default setting in the config.php file gives permission to every user ...)
 
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__TOC__
 
__TOC__
  
−
Access control is a way you to give your users different permissions while working on folders and files. The default setting in the config.php file gives permission to every user and permits all the options. In order to change this configuration you must firstly know the basic of the '''accessControl(0)''' function placed in the config.asp file. 
+
Access control is a way you to give your users different permissions while working on folders and files. The default setting in the config.asp file gives permission to every user and permits all the options. In order to change this configuration you must firstly know the basic of the '''accessControl(0)''' function placed in the config.asp file. 
  
−
The syntax of the function:
+
=== The syntax of the ACL Items ===
 +
 
 +
The syntax of the ACL entries is as followed:
 
<pre>Set accessControl(0) = DefineAccessControlItem("*", "*", "/", true, true, true, true, true, true, true, true)</pre>  
 
<pre>Set accessControl(0) = DefineAccessControlItem("*", "*", "/", true, true, true, true, true, true, true, true)</pre>  
 
Functions are definied in the following order:
 
Functions are definied in the following order:
−
<pre>Function DefineAccessControlItem(role, resourceType, folder, folderView, folderCreate, folderRename, folderDelete, fileView, fileUpload, fileRename, fileDelete)</pre>  
+
<pre>Function DefineAccessControlItem( _ role, resourceType, folder, _ folderView, folderCreate, folderRename, folderDelete, _ fileView, fileUpload, fileRename, fileDelete )</pre>  
−
The three most important parameters of the "'''Access Control'''" function are:
+
* '''role'''<br>The role is an attribute which sets the type of the user. It is set to "*" as default and you may treat as 'every user'. You may set this parameter to other name like: 'user' or 'limited_functions'. The name of the user type will be directly connected to the function the user may use.
  
−
=== role ===
+
* '''resourceType'''<br>The resourceType defines the resources handled in CKFinder. A resource type is nothing more than a way to group files under different paths, each one having different configuration settings. e.g. ''Images, Flash, Files''.It is set to "*" as default and means that all of the resources are available.
  
−
The '''role'''is an attribute which sets the type of the user. It is set to "*" as default and you may treat as 'every user'. You may set this parameter to other name like: 'user' or 'limited_functions'. The name of the user type will be directly connected to the function the user may use.
+
* '''folder'''<br>Folder determines where your limitations will be used. By placing the folders name you specify the place you want to put your restrictions in. It is set to "/" as default so no folder is set.
  
−
=== resourceType ===
+
* '''folder and file options''' <br>The rest of the variables are bool type and can be set as '''true''' or '''false'''. True of course enables an option, false disables it.
  
−
The '''resourceType''' defines the resources handled in CKFinder. A resource type is nothing more than a way to group files under different paths, each one having different configuration settings. E.g. Images, Flash, Files.It is set to "*" as default and means that all of the resources are available.
+
* '''other information'''<br> Many "AccessControl" entries can be added. All attributes are optional.
  
−
=== folder ===
+
Subfolders inherit their default settings from their parents' definitions.
  
−
'''Folder''' determines where your limitations will be used. By placing the folders name you specify the place you want to put your restrictions in. It is set to "/" as default so no folder is set.
+
==== Example 1 ====
  
−
=== folder and file options <br> ===
+
If you want to restrict the upload, rename or delete of files in the "Logos" folder of the resource type "Images":
 +
<pre>Set accessControl(1) = DefineAccessControlItem("*", "Images", "/Logos", true, true, true, true, true, false, false, false)</pre>
 +
The above example only refers to file operations in the folder "/Logos" itself. It doesn't restrict operations on the folder so the user can delete or rename the folder. In order to limit users ability to modify the folder (not its contents) you should change permissions in the parent folder.
  
−
The rest of the variables are bool type and can be set as '''true''' or '''false'''. True of course enables an option, false disables it.<br>Example:<br>If you want to restrict the upload, rename or delete of files in the "Logos" folder of the resource type "Images":
+
==== Example 2 ====
−
<pre>Set accessControl(1) = DefineAccessControlItem("*", "Images", "/Logos", true, true, true, true, true, false, false, false)</pre>
 
−
The above example only refers to file operations in the folder "/Logos" itself. It doesn't restrict operations on the folder so the user can delete or rename the folder. In order to limit users ability to modify the folder (not its context) you should change permissions in the parent folder.<br>Example:
 
 
<pre>Set accessControl(1) = DefineAccessControlItem("*", "Images", "/", true, true, false, false, true, false, false, false)</pre>  
 
<pre>Set accessControl(1) = DefineAccessControlItem("*", "Images", "/", true, true, false, false, true, false, false, false)</pre>  
−
Now a user can view and create a folder, but he will be unable to rename or delete it. This is the best way to secure your folders from unauthorized access. '''Note''':Please, remember to adjust Dim accessControl(0) to Dim accessControl(1).
+
Now a user can view and create a folder, but he will be unable to rename or delete it.
 +
 
 +
'''Note''':Please, remember to adjust Dim accessControl(0) to Dim accessControl(1) as necessary.<br>
  
−
=== sessions ===
+
=== Sessions ===
  
−
In order to enable the access control options for different users you should initialize a session.
+
The RoleSessionVar is a session variable name that CKFinder must use to retrieve the "role" of the current user.
 
<pre>CKFinder_Config.Add "RoleSessionVar", "CKFinder_UserRole"
 
<pre>CKFinder_Config.Add "RoleSessionVar", "CKFinder_UserRole"
 
</pre>  
 
</pre>  
−
The session is a mechanism which will allow you to give different permissions to different users. <br>Example:<br>In your config.asp file you create three different roles:
+
To switch between different user roles, simply change the session variable:
 +
<pre>&lt;%
 +
Session("CKFinder_UserRole")="admin"
 +
%&gt;</pre>  
 +
==== Example 3 ====
  
−
First role '''admin''' '''(*)''':
+
In your config.asp file you can create three different roles:<br> First role, '''every user''' (wildcard "*" is used):
−
<pre>Set accessControl(1) = DefineAccessControlItem("*", "*", "/", false, false, false, false, false, false, false, false)
+
<pre>Set accessControl(1) = DefineAccessControlItem("*", "*", "/", true, false, false, false, true, false, false, false)
 
</pre>  
 
</pre>  
−
Second role '''user''':
+
Second role '''registered user''':
−
<pre>Set accessControl(1) = DefineAccessControlItem("user", "*", "/", true, true, false, false, true, true, false, false)
+
<pre>Set accessControl(2) = DefineAccessControlItem("registered", "*", "/", true, true, false, false, true, true, false, false)
 
</pre>  
 
</pre>  
−
Third role '''guest''':
+
Third role '''admin''':
−
<pre>Set accessControl(1) = DefineAccessControlItem("guest", "*", "/", true, false, false, false, true, false, false, false)
+
<pre>Set accessControl(3) = DefineAccessControlItem("admin", "*", "/", true, true, true, true, true, true, true, true)
 
</pre>  
 
</pre>  
−
You've created three different users permissions.
+
You've created three different users permissions. The default user (everybody) is allowed to browse all files and folders. Registered user has also the ability to upload files and create folders. The administrator has full permissions.
  
−
'''Important:''' Note that when the role is set to '''*''' the user always has administrative privileges even though all the options are set to '''false'''.
+
'''<br>'''
  
−
Now you must create a place where you will point out the role you want to use e.g. a file. In this file you put initialize the session and write the command which will access you pre-defined role:
+
Now let's say you have an authentication mechanism somewhere in your web application. Command and assign one of the pre-defined roles to the user:
 +
<pre>&lt;%
 +
Session("CKFinder_UserRole")="admin"
 +
%&gt;</pre>
 +
if you want to use the admin role.
 +
<pre>&lt;%
 +
Session("CKFinder_UserRole")="registered"
 +
%&gt;</pre>
 +
if you want to use the role assigned to registered users.
 +
<pre>&lt;%
 +
Session("CKFinder_UserRole")="guest"
 +
%&gt;</pre>
 +
''guest'' doesn't have assigned any specific permissions, so the default values are used (defined with "*")
 
<pre>&lt;%
 
<pre>&lt;%
−
Session("CKFinder_UserRole")="user"
+
Session("CKFinder_UserRole")="any_other_value"
−
%&gt;</pre>
+
%&gt;</pre>  
 +
same situation, default values are used.

Latest revision as of 07:46, 28 May 2010

Access control is a way you to give your users different permissions while working on folders and files. The default setting in the config.asp file gives permission to every user and permits all the options. In order to change this configuration you must firstly know the basic of the accessControl(0) function placed in the config.asp file. 

The syntax of the ACL Items

The syntax of the ACL entries is as followed: 

Set accessControl(0) = DefineAccessControlItem("*", "*", "/", true, true, true, true, true, true, true, true)

Functions are definied in the following order: 

Function DefineAccessControlItem( _ role, resourceType, folder, _ folderView, folderCreate, folderRename, folderDelete, _ fileView, fileUpload, fileRename, fileDelete )
  • role
    The role is an attribute which sets the type of the user. It is set to "*" as default and you may treat as 'every user'. You may set this parameter to other name like: 'user' or 'limited_functions'. The name of the user type will be directly connected to the function the user may use.
  • resourceType
    The resourceType defines the resources handled in CKFinder. A resource type is nothing more than a way to group files under different paths, each one having different configuration settings. e.g. Images, Flash, Files.It is set to "*" as default and means that all of the resources are available.
  • folder
    Folder determines where your limitations will be used. By placing the folders name you specify the place you want to put your restrictions in. It is set to "/" as default so no folder is set.
  • folder and file options
    The rest of the variables are bool type and can be set as true or false. True of course enables an option, false disables it.
  • other information
    Many "AccessControl" entries can be added. All attributes are optional.

Subfolders inherit their default settings from their parents' definitions.

Example 1

If you want to restrict the upload, rename or delete of files in the "Logos" folder of the resource type "Images": 

Set accessControl(1) = DefineAccessControlItem("*", "Images", "/Logos", true, true, true, true, true, false, false, false)

The above example only refers to file operations in the folder "/Logos" itself. It doesn't restrict operations on the folder so the user can delete or rename the folder. In order to limit users ability to modify the folder (not its contents) you should change permissions in the parent folder.

Example 2

Set accessControl(1) = DefineAccessControlItem("*", "Images", "/", true, true, false, false, true, false, false, false)

Now a user can view and create a folder, but he will be unable to rename or delete it.

Note:Please, remember to adjust Dim accessControl(0) to Dim accessControl(1) as necessary.

Sessions

The RoleSessionVar is a session variable name that CKFinder must use to retrieve the "role" of the current user. 

CKFinder_Config.Add "RoleSessionVar", "CKFinder_UserRole"

To switch between different user roles, simply change the session variable: 

<%
Session("CKFinder_UserRole")="admin"
%>

Example 3

In your config.asp file you can create three different roles:
First role, every user (wildcard "*" is used): 

Set accessControl(1) = DefineAccessControlItem("*", "*", "/", true, false, false, false, true, false, false, false)

Second role registered user: 

Set accessControl(2) = DefineAccessControlItem("registered", "*", "/", true, true, false, false, true, true, false, false)

Third role admin: 

Set accessControl(3) = DefineAccessControlItem("admin", "*", "/", true, true, true, true, true, true, true, true)

You've created three different users permissions. The default user (everybody) is allowed to browse all files and folders. Registered user has also the ability to upload files and create folders. The administrator has full permissions.


Now let's say you have an authentication mechanism somewhere in your web application. Command and assign one of the pre-defined roles to the user: 

<%
Session("CKFinder_UserRole")="admin"
%>

if you want to use the admin role. 

<%
Session("CKFinder_UserRole")="registered"
%>

if you want to use the role assigned to registered users. 

<%
Session("CKFinder_UserRole")="guest"
%>

guest doesn't have assigned any specific permissions, so the default values are used (defined with "*") 

<%
Session("CKFinder_UserRole")="any_other_value"
%>

same situation, default values are used.

Retrieved from "https://docs-old.ckeditor.com/index.php?title=CKFinder_1.x/Developers_Guide/ASP/Configuration/Access_Control&oldid=3439"
This page was last edited on 28 May 2010, at 07:46.