CKFinder 2.x/Developers Guide/ASP.NET/Configuration/Quick Start - Revision history

Sebstefanov at 08:59, 24 March 2014

2014-03-24T08:59:34Z

Sebstefanov: /* License */

2012-08-16T09:57:54Z

‎License

Wiktor: /* The CheckAuthentication() function */ corrected code

2011-11-03T08:11:19Z

‎The CheckAuthentication() function: corrected code

Anna: Code formatting added

2011-03-31T10:51:32Z

Code formatting added

Wiktor: Created page with '== The CheckAuthentication() function
== By default, CKFinder will not work due to authentication restrictions. You must first be sure that you have configured it properly, …'

2010-05-14T18:27:57Z

Created page with '== The CheckAuthentication() function<br> == By default, CKFinder will not work due to authentication restrictions. You must first be sure that you have configured it properly, …'

New page

== The CheckAuthentication() function<br> ==

By default, CKFinder will not work due to authentication restrictions. You must first be sure that you have configured it properly, and then enable it.

Once you have completely configured CKFinder, you are ready to enable it for use. The CheckAuthentication() function is used for that. In this function, you must implement the code that ensures that the requests are coming from an authenticated user. This is usually done by assigning a session variable when the user logs on your system.

Return "true" if the user is properly authenticated. We strongly recommend you to NOT simply return "true" from this function without implementing authentication checks. Anonymous users would be able to use CKFinder, including uploading and deleting files from your server.

The following is a sample implementation for it:
<pre>public override bool CheckAuthentication()
{
if ( Session[ "IsAuthenticated" ] && (bool)Session[ "IsAuthenticated" ] == true )
{
return true;
}

return false;
}
</pre>

== License ==

The license information for CKFinder must be pasted inside the LicenseName and LicenseKey variables:
<pre>LicenseName = "put your license name here";
LicenseKey = "put your license key here";</pre>
If these fields are blank or an invalid license key information is set, CKFinder will still be fully functional but it will be ruining in demo mode.

== Base URL and Directory ==

The '''BaseUrl''' setting is the base path used to build the final URL for the resources handled in CKFinder. For example:
<pre>BaseUrl = "/ckfinder/userfiles/";</pre>
Notice that the trailing slash is required.

The '''BaseDir''' is the path to the local directory (in the server) which points to the above '''URL'''. This is the path used by CKFinder to handle the files in the server. Full write permissions must be granted to this directory.

You may point it to a directory directly. For example:
<pre>BaseDir = "C:/SiteDir/CKFinder/userfiles/";</pre>
By leaving BaseDir empty, CKFinder will automatically attempt to resolve the path, based on '''BaseUrl''' (like Server.MapPath). For example:
<pre>BaseDir = "";</pre>

=== Full URLs<br> ===

CKFinder is able to resolve the BaseUrl path only when setting it to an absolute URL path, starting from the document root. For example:
<pre>BaseUrl = "/userfiles/";
BaseDir = "";
</pre>
If you need CKFinder to return full URL address for the resources, the you are explicetelly required to set the BaseDir setting. For example:<br>
<pre>// THIS IS WRONG:
BaseUrl = "http://example.com/ckfinder/files/";
BaseDir = "";

// THIS IS GOOD:
BaseUrl = "http://example.com/ckfinder/files/";
BaseDir = "C:/InetPub/MySite/ckfinder/files/";
</pre>

@@ Line 45: / Line 45: @@
 BaseDir = "";
 </source>
-If you need CKFinder to return full URL address for the resources, the you are explicetelly required to set the BaseDir setting. For example:<br>
+If you need CKFinder to return full URL address for the resources, then you are explicitly required to set the BaseDir setting. For example:<br>
 <source lang="asp">// THIS IS WRONG:
 BaseUrl = "http://example.com/ckfinder/files/";

@@ Line 21: / Line 21: @@
 == License ==
-The license information for CKFinder must be pasted inside the LicenseName and LicenseKey variables:
+The license information for CKFinder must be pasted in the config.ascx file, inside the LicenseName and LicenseKey variables:
 <source lang="asp">LicenseName = "put your license name here";
 LicenseKey = "put your license key here";</source>

@@ Line 10: / Line 10: @@
 <source lang="asp">public override bool CheckAuthentication()
+{
-     if ( Session[ "IsAuthenticated" ] &amp;&amp; (bool)Session[ "IsAuthenticated" ] == true )
+     if ( Session[ "IsAuthenticated" ] && (bool)Session[ "IsAuthenticated" ] == true )
+     {
          return true;