CKFinder 2.x/Developers Guide/ASP/Configuration/Access Control - Revision history

J.swiderski at 15:02, 7 March 2013

2013-03-07T15:02:14Z

J.swiderski at 14:56, 7 March 2013

2013-03-07T14:56:10Z

Anna: Article content moved to a template

2011-03-31T10:06:55Z

Article content moved to a template

Wiktor at 18:34, 14 May 2010

2010-05-14T18:34:00Z

Wiktor: Created page with '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.asp file gives permission to e…'

2010-05-14T18:22:28Z

Created page with '__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.asp file gives permission to e…'

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.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:
<pre>Set accessControl(0) = DefineAccessControlItem("*", "*", "/", true, true, true, true, true, true, true, true)</pre>
Functions are definied in the following order:
<pre>Function DefineAccessControlItem( _ role, resourceType, folder, _ folderView, folderCreate, folderRename, folderDelete, _ fileView, fileUpload, fileRename, fileDelete )</pre>
* '''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":
<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.

==== Example 2 ====
<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.

'''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.
<pre>CKFinder_Config.Add "RoleSessionVar", "CKFinder_UserRole"
</pre>
To switch between different user roles, simply change the session variable:
<pre><%
Session("CKFinder_UserRole")="admin"
%></pre>
==== Example 3 ====

In your config.asp file you can create three different roles: First role, '''every user''' (wildcard "*" is used):
<pre>Set accessControl(1) = DefineAccessControlItem("*", "*", "/", true, false, false, false, true, false, false, false)
</pre>
Second role '''registered user''':
<pre>Set accessControl(2) = DefineAccessControlItem("registered", "*", "/", true, true, false, false, true, true, false, false)
</pre>
Third role '''admin''':
<pre>Set accessControl(3) = DefineAccessControlItem("admin", "*", "/", true, true, true, true, true, true, true, true)
</pre>
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:
<pre><%
Session("CKFinder_UserRole")="admin"
%></pre>
if you want to use the admin role.
<pre><%
Session("CKFinder_UserRole")="registered"
%></pre>
if you want to use the role assigned to registered users.
<pre><%
Session("CKFinder_UserRole")="guest"
%></pre>
''guest'' doesn't have assigned any specific permissions, so the default values are used (defined with "*")
<pre><%
Session("CKFinder_UserRole")="any_other_value"
%></pre>
same situation, default values are used.

@@ Line 9: / Line 9: @@
 {{Ckfinder_2.x_ACL_Examples|example1=
 <source lang="asp">Set accessControl(1) = DefineAccessControlItem("*", "Images", "/Logos", true, true, true, true, true, false, false, false)</source>|example2=
-<source lang="asp">Set accessControl(1) = DefineAccessControlItem("*", "Images", "/", true, true, false, false, true, false, false, false)</source>|wildcard_resource=DefineAccessControlItem("*"...)}}
+<source lang="asp">Set accessControl(1) = DefineAccessControlItem("*", "Images", "/", true, true, false, false, true, false, false, false)</source>|wildcard_resource=(DefineAccessControlItem("*"...))}}
 <note>Remember to adjust <code>Dim accessControl(0)</code> to <code>Dim accessControl(1)</code> as necessary.

@@ Line 9: / Line 9: @@
 {{Ckfinder_2.x_ACL_Examples|example1=
 <source lang="asp">Set accessControl(1) = DefineAccessControlItem("*", "Images", "/Logos", true, true, true, true, true, false, false, false)</source>|example2=
-<source lang="asp">Set accessControl(1) = DefineAccessControlItem("*", "Images", "/", true, true, false, false, true, false, false, false)</source>}}
+<source lang="asp">Set accessControl(1) = DefineAccessControlItem("*", "Images", "/", true, true, false, false, true, false, false, false)</source>|wildcard_resource=DefineAccessControlItem("*"...)}}
 <note>Remember to adjust <code>Dim accessControl(0)</code> to <code>Dim accessControl(1)</code> as necessary.

@@ Line 1: / Line 1: @@
-__TOC__
+{{Ckfinder_2.x_Access_Control_Description|file=<code>config.asp</code>|AccessControl=accessControl(0)}}
-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.&nbsp;
+{{ckfinder_acl_explanation}}
-=== The syntax of the ACL Items ===
+{{Ckfinder_2.x_ACL_Examples|example1=
-The syntax of the ACL entries is as followed:
+<note>Remember to adjust <code>Dim accessControl(0)</code> to <code>Dim accessControl(1)</code> as necessary.
-<pre>Set accessControl(0) = DefineAccessControlItem("*", "*", "/", true, true, true, true, true, true, true, true)</pre>
+</note>
-* '''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.
+{{CKFinder_2.x Sessions|lang=ASP|roleSessionVar=RoleSessionVar|file=<code>config.asp</code>|code1=
+<source lang="asp">CKFinder_Config.Add "RoleSessionVar", "CKFinder_UserRole"</source>|code2=
-* '''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.
+<source lang="asp"><% Session("CKFinder_UserRole")="admin" %></source>|code3=
+<source lang="asp">Set accessControl(1) = DefineAccessControlItem("*", "*", "/", true, false, false, false, true, false, false, false)</source>|code4=
-* '''other information'''<br> Many "AccessControl" entries can be added. All attributes are optional.
+<source lang="asp">Set accessControl(2) = DefineAccessControlItem("registered", "*", "/", true, true, false, false, true, true, false, false)</source>|code5=
+<source lang="asp">Set accessControl(3) = DefineAccessControlItem("admin", "*", "/", true, true, true, true, true, true, true, true)</source>}} You can assign one of the pre-defined roles to the user  &mdash; using the admin role:
-Subfolders inherit their default settings from their parents' definitions.
+{{CKFinder_2.x Sessions_Details|code1=
+<source lang="asp"><% Session("CKFinder_UserRole")="admin" %></source>|code2=
-==== Example 1 ====
+<source lang="asp"><% Session("CKFinder_UserRole")="registered" %></source>|code3=
+<source lang="asp"><% Session("CKFinder_UserRole")="guest" %></source>|code4=
-If you want to restrict the upload, rename or delete of files in the "Logos" folder of the resource type "Images":
+<source lang="asp"><% Session("CKFinder_UserRole")="any_other_value" %></source>}}