diff options
| author | Derek Jones <derek.jones@ellislab.com> | 2010-03-10 21:04:17 +0100 |
|---|---|---|
| committer | Derek Jones <derek.jones@ellislab.com> | 2010-03-10 21:04:17 +0100 |
| commit | 9898b892baed8d20f4138cb88c4f4ca3a082e444 (patch) | |
| tree | 193fa662d5dd6bd4c634324cecd4ef7d4b44c556 | |
| parent | 5034e3fe8442fcb558225f6c528497227474c9ca (diff) | |
added Security class docs, cleaned up Input class for changes to both
| -rw-r--r-- | user_guide/changelog.html | 1 | ||||
| -rw-r--r-- | user_guide/general/security.html | 2 | ||||
| -rw-r--r-- | user_guide/helpers/cookie_helper.html | 44 | ||||
| -rw-r--r-- | user_guide/libraries/input.html | 81 | ||||
| -rw-r--r-- | user_guide/libraries/security.html | 123 | ||||
| -rw-r--r-- | user_guide/libraries/sessions.html | 2 | ||||
| -rw-r--r-- | user_guide/nav/nav.js | 1 | ||||
| -rw-r--r-- | user_guide/toc.html | 1 |
8 files changed, 182 insertions, 73 deletions
diff --git a/user_guide/changelog.html b/user_guide/changelog.html index 8dcc9060f..eb5cf93cd 100644 --- a/user_guide/changelog.html +++ b/user_guide/changelog.html @@ -72,6 +72,7 @@ Hg Tag: </p> </ul> <li>Libraries <ul> + <li>Added <a href="./libraries/security.html">Security library</a>, which now contains the <dfn>xss_clean</dfn> function, <dfn>filename_security</dfn> function and other security related functions.</li> <li>Added <var>$parse_exec_vars</var> property to Output library.</li> <li>Added ability to enable / disable individual sections of the <a href="general/profiling.html">Profiler</a></li> <li>Added "is_object" into the list of unit tests capable of being run.</li> diff --git a/user_guide/general/security.html b/user_guide/general/security.html index 593ffd584..bc969f73a 100644 --- a/user_guide/general/security.html +++ b/user_guide/general/security.html @@ -112,7 +112,7 @@ XML-RPC data, or even data from the SERVER array, you are encouraged to practice <p>CodeIgniter comes with a Cross Site Scripting filter. This filter looks for commonly used techniques to embed malicious Javascript into your data, or other types of code that attempt to hijack cookies -or do other malicious things. The XSS Filter is described <a href="../libraries/input.html">here</a>. +or do other malicious things. The XSS Filter is described <a href="../libraries/security.html">here</a>. </p> </li> diff --git a/user_guide/helpers/cookie_helper.html b/user_guide/helpers/cookie_helper.html index b73daf664..d7120d511 100644 --- a/user_guide/helpers/cookie_helper.html +++ b/user_guide/helpers/cookie_helper.html @@ -70,53 +70,13 @@ Cookie Helper <h2>set_cookie()</h2> -<p>Sets a cookie containing the values you specify. There are two ways to pass information to this function so that a cookie can be set: -Array Method, and Discrete Parameters:</p> - -<h4>Array Method</h4> - -<p>Using this method, an associative array is passed to the first parameter:</p> - -<code>$cookie = array(<br /> - 'name' => 'The Cookie Name',<br /> - 'value' => 'The Value',<br /> - 'expire' => '86500',<br /> - 'domain' => '.some-domain.com',<br /> - 'path' => '/',<br /> - 'prefix' => 'myprefix_',<br /> - );<br /> -<br /> -set_cookie($cookie); -</code> - -<p><strong>Notes:</strong></p> - -<p>Only the name and value are required. To delete a cookie set it with the expiration blank.</p> - -<p>The expiration is set in <strong>seconds</strong>, which will be added to the current time. Do not include the time, but rather only the -number of seconds from <em>now</em> that you wish the cookie to be valid. If the expiration is set to -zero the cookie will only last as long as the browser is open.</p> -<p>For site-wide cookies regardless of how your site is requested, add your URL to the <strong>domain</strong> starting with a period, like this: .your-domain.com</p> -<p>The path is usually not needed since the function sets a root path.</p> -<p>The prefix is only needed if you need to avoid name collisions with other identically named cookies for your server.</p> - -<h4>Discrete Parameters</h4> - -<p>If you prefer, you can set the cookie by passing data using individual parameters:</p> - -<code>set_cookie($name, $value, $expire, $domain, $path, $prefix);</code> +<p>This helper function gives you view file friendly syntax to set browser cookies. Refer to the <a href="../libraries/input.html">Input class</a> for a description of use, as this function is an alias to $this->input->set_cookie().</p> <h2>get_cookie()</h2> -<p>Lets you fetch a cookie. The first parameter will contain the name of the cookie you are looking for (including any prefixes):</p> - -<code>get_cookie('some_cookie');</code> - -<p>The function returns FALSE (boolean) if the item you are attempting to retrieve does not exist.</p> +<p>This helper function gives you view file friendly syntax to get browser cookies. Refer to the <a href="../libraries/input.html">Input class</a> for a description of use, as this function is an alias to $this->input->cookie().</p> -<p>The second optional parameter lets you run the data through the XSS filter. It's enabled by setting the second parameter to boolean TRUE;</p> -<p><code>get_cookie('some_cookie', TRUE);</code></p> <h2>delete_cookie()</h2> <p>Lets you delete a cookie. Unless you've set a custom path or other values, only the name of the cookie is needed:</p> diff --git a/user_guide/libraries/input.html b/user_guide/libraries/input.html index 59198a245..055f12bf4 100644 --- a/user_guide/libraries/input.html +++ b/user_guide/libraries/input.html @@ -42,7 +42,7 @@ <td id="breadcrumb"> <a href="http://codeigniter.com/">CodeIgniter Home</a> › <a href="../index.html">User Guide Home</a> › -Input and Security Class +Input Class </td> <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td> </tr> @@ -83,38 +83,12 @@ Input and Security Class <h2>XSS Filtering</h2> -<p>CodeIgniter comes with a Cross Site Scripting Hack prevention filter which can either run automatically to filter -all POST and COOKIE data that is encountered, or you can run it on a per item basis. By default it does <strong>not</strong> -run globally since it requires a bit of processing overhead, and since you may not need it in all cases.</p> - -<p>The XSS filter looks for commonly used techniques to trigger Javascript or other types of code that attempt to hijack cookies -or do other malicious things. If anything disallowed is encountered it is rendered safe by converting the data to character entities.</p> - -<p> -Note: This function should only be used to deal with data upon submission. It's not something that should be used for general runtime processing since it requires a fair amount of processing overhead.</p> - - -<p>To filter data through the XSS filter use this function:</p> - -<h2>$this->input->xss_clean()</h2> - -<p>Here is an usage example:</p> - -<code>$data = $this->input->xss_clean($data);</code> - -<p>If you want the filter to run automatically every time it encounters POST or COOKIE data you can enable it by opening your +<p>The Input class has the ability to filter input automatically to prevent cross-site scripting attacks. If you want the filter to run automatically every time it encounters POST or COOKIE data you can enable it by opening your <kbd>application/config/config.php</kbd> file and setting this:</p> <code>$config['global_xss_filtering'] = TRUE;</code> -<p>Note: If you use the form validation class, it gives you the option of XSS filtering as well.</p> - -<p>An optional second parameter, <dfn>is_image</dfn>, allows this function to be used to test images for potential XSS attacks, useful for file upload security. When this second parameter is set to <dfn>TRUE</dfn>, instead of returning an altered string, the function returns TRUE if the image is safe, and FALSE if it contained potentially malicious information that a browser may attempt to execute.</p> - -<code>if ($this->input->xss_clean($file, TRUE) === FALSE)<br /> -{<br /> - // file failed the XSS test<br /> -}</code> +<p>Please refer to the <a href="security.html">Security class</a> documentation for information on using XSS Filtering in your application.</p> <h2>Using POST, COOKIE, or SERVER Data</h2> @@ -183,6 +157,55 @@ else<br /> <code>$this->input->server('some_data');</code> +<h2>$this->input->set_cookie()</h2> + +<p>Sets a cookie containing the values you specify. There are two ways to pass information to this function so that a cookie can be set: +Array Method, and Discrete Parameters:</p> + +<h4>Array Method</h4> + +<p>Using this method, an associative array is passed to the first parameter:</p> + +<code>$cookie = array(<br /> + 'name' => 'The Cookie Name',<br /> + 'value' => 'The Value',<br /> + 'expire' => '86500',<br /> + 'domain' => '.some-domain.com',<br /> + 'path' => '/',<br /> + 'prefix' => 'myprefix_',<br /> + );<br /> +<br /> +$this->input->set_cookie($cookie); +</code> + +<p><strong>Notes:</strong></p> + +<p>Only the name and value are required. To delete a cookie set it with the expiration blank.</p> + +<p>The expiration is set in <strong>seconds</strong>, which will be added to the current time. Do not include the time, but rather only the +number of seconds from <em>now</em> that you wish the cookie to be valid. If the expiration is set to +zero the cookie will only last as long as the browser is open.</p> +<p>For site-wide cookies regardless of how your site is requested, add your URL to the <strong>domain</strong> starting with a period, like this: .your-domain.com</p> +<p>The path is usually not needed since the function sets a root path.</p> +<p>The prefix is only needed if you need to avoid name collisions with other identically named cookies for your server.</p> + +<h4>Discrete Parameters</h4> + +<p>If you prefer, you can set the cookie by passing data using individual parameters:</p> + +<code>$this->input->set_cookie($name, $value, $expire, $domain, $path, $prefix);</code> + +<h2>$this->input->get_cookie()</h2> + +<p>Lets you fetch a cookie. The first parameter will contain the name of the cookie you are looking for (including any prefixes):</p> + +<code>get_cookie('some_cookie');</code> + +<p>The function returns FALSE (boolean) if the item you are attempting to retrieve does not exist.</p> + +<p>The second optional parameter lets you run the data through the XSS filter. It's enabled by setting the second parameter to boolean TRUE;</p> + +<p><code>get_cookie('some_cookie', TRUE);</code></p> <h2>$this->input->ip_address()</h2> diff --git a/user_guide/libraries/security.html b/user_guide/libraries/security.html new file mode 100644 index 000000000..d5d725381 --- /dev/null +++ b/user_guide/libraries/security.html @@ -0,0 +1,123 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title>Security Class : CodeIgniter User Guide</title> + +<style type='text/css' media='all'>@import url('../userguide.css');</style> +<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> + +<script type="text/javascript" src="../nav/nav.js"></script> +<script type="text/javascript" src="../nav/prototype.lite.js"></script> +<script type="text/javascript" src="../nav/moo.fx.js"></script> +<script type="text/javascript" src="../nav/user_guide_menu.js"></script> + +<meta http-equiv='expires' content='-1' /> +<meta http-equiv= 'pragma' content='no-cache' /> +<meta name='robots' content='all' /> +<meta name='author' content='ExpressionEngine Dev Team' /> +<meta name='description' content='CodeIgniter User Guide' /> + +</head> +<body> + +<!-- START NAVIGATION --> +<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div> +<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div> +<div id="masthead"> +<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> +<tr> +<td><h1>CodeIgniter User Guide Version 2.0.0</h1></td> +<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td> +</tr> +</table> +</div> +<!-- END NAVIGATION --> + + +<!-- START BREADCRUMB --> +<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> +<tr> +<td id="breadcrumb"> +<a href="http://codeigniter.com/">CodeIgniter Home</a> › +<a href="../index.html">User Guide Home</a> › +Security Class +</td> +<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td> +</tr> +</table> +<!-- END BREADCRUMB --> + +<br clear="all" /> + + +<!-- START CONTENT --> +<div id="content"> + + +<h1>Security Class</h1> + +<p>The Security Class contains methods that help you create a secure application, processing input data for security.</p> + +<h2>XSS Filtering</h2> + +<p>CodeIgniter comes with a Cross Site Scripting Hack prevention filter which can either run automatically to filter +all POST and COOKIE data that is encountered, or you can run it on a per item basis. By default it does <strong>not</strong> +run globally since it requires a bit of processing overhead, and since you may not need it in all cases.</p> + +<p>The XSS filter looks for commonly used techniques to trigger Javascript or other types of code that attempt to hijack cookies +or do other malicious things. If anything disallowed is encountered it is rendered safe by converting the data to character entities.</p> + +<p> +Note: This function should only be used to deal with data upon submission. It's not something that should be used for general runtime processing since it requires a fair amount of processing overhead.</p> + + +<p>To filter data through the XSS filter use this function:</p> + +<h2>$this->security->xss_clean()</h2> + +<p>Here is an usage example:</p> + +<code>$data = $this->security->xss_clean($data);</code> + +<p>If you want the filter to run automatically every time it encounters POST or COOKIE data you can enable it by opening your +<kbd>application/config/config.php</kbd> file and setting this:</p> + +<code>$config['global_xss_filtering'] = TRUE;</code> + +<p>Note: If you use the form validation class, it gives you the option of XSS filtering as well.</p> + +<p>An optional second parameter, <dfn>is_image</dfn>, allows this function to be used to test images for potential XSS attacks, useful for file upload security. When this second parameter is set to <dfn>TRUE</dfn>, instead of returning an altered string, the function returns TRUE if the image is safe, and FALSE if it contained potentially malicious information that a browser may attempt to execute.</p> + +<code>if ($this->security->xss_clean($file, TRUE) === FALSE)<br /> +{<br /> + // file failed the XSS test<br /> +}</code> + + +<h2>$this->security->sanitize_filename()</h2> + +<p>When accepting filenames from user input, it is best to sanitize them to prevent directory traversal and other security related issues. To do so, use the <dfn>sanitize_filename()</dfn> method of the Security class. Here is an example:</p> + +<code>$filename = $this->security->sanitize_filename($this->input->post('filename'));</code> + +<!-- @todo write docs for CSRF methods --> + +</div> +<!-- END CONTENT --> + + +<div id="footer"> +<p> +Previous Topic: <a href="pagination.html">Pagination Class</a> + · +<a href="#top">Top of Page</a> · +<a href="../index.html">User Guide Home</a> · +Next Topic: <a href="sessions.html">Session Class</a> +</p> +<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2010 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p> +</div> + +</body> +</html>
\ No newline at end of file diff --git a/user_guide/libraries/sessions.html b/user_guide/libraries/sessions.html index 059f6fbc6..31b4047e5 100644 --- a/user_guide/libraries/sessions.html +++ b/user_guide/libraries/sessions.html @@ -298,7 +298,7 @@ do not need to write your own routine to do it.</p> <div id="footer"> <p> -Previous Topic: <a href="pagination.html">Pagination Class</a> +Previous Topic: <a href="security.html">Security Class</a> · <a href="#top">Top of Page</a> · <a href="../index.html">User Guide Home</a> · diff --git a/user_guide/nav/nav.js b/user_guide/nav/nav.js index 52d60cb53..0e893d401 100644 --- a/user_guide/nav/nav.js +++ b/user_guide/nav/nav.js @@ -89,6 +89,7 @@ function create_menu(basepath) '<li><a href="'+base+'libraries/language.html">Language Class</a></li>' + '<li><a href="'+base+'libraries/output.html">Output Class</a></li>' + '<li><a href="'+base+'libraries/pagination.html">Pagination Class</a></li>' + + '<li><a href="'+base+'libraries/security.html">Security Class</a></li>' + '<li><a href="'+base+'libraries/sessions.html">Session Class</a></li>' + '<li><a href="'+base+'libraries/trackback.html">Trackback Class</a></li>' + '<li><a href="'+base+'libraries/parser.html">Template Parser Class</a></li>' + diff --git a/user_guide/toc.html b/user_guide/toc.html index ff07ca684..401e7e4c7 100644 --- a/user_guide/toc.html +++ b/user_guide/toc.html @@ -142,6 +142,7 @@ Table of Contents <li><a href="./libraries/language.html">Language Class</a></li> <li><a href="./libraries/output.html">Output Class</a></li> <li><a href="./libraries/pagination.html">Pagination Class</a></li> +<li><a href="./libraries/security.html">Security Class</a></li> <li><a href="./libraries/sessions.html">Session Class</a></li> <li><a href="./libraries/trackback.html">Trackback Class</a></li> <li><a href="./libraries/parser.html">Template Parser Class</a></li> |