bzr branch
http://gegoxaren.bato24.eu/bzr/lenasys/trunk
|
20.1.1
by galaxyAbstractor
* Added an simple admin panel to the codeviewer-cmssy stuff |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
3 |
<head> |
|
4 |
||
5 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
6 |
<title>Security Class : CodeIgniter User Guide</title> |
|
7 |
||
8 |
<style type='text/css' media='all'>@import url('../userguide.css');</style> |
|
9 |
<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> |
|
10 |
||
11 |
<script type="text/javascript" src="../nav/nav.js"></script> |
|
12 |
<script type="text/javascript" src="../nav/prototype.lite.js"></script> |
|
13 |
<script type="text/javascript" src="../nav/moo.fx.js"></script> |
|
14 |
<script type="text/javascript" src="../nav/user_guide_menu.js"></script> |
|
15 |
||
16 |
<meta http-equiv='expires' content='-1' /> |
|
17 |
<meta http-equiv= 'pragma' content='no-cache' /> |
|
18 |
<meta name='robots' content='all' /> |
|
19 |
<meta name='author' content='ExpressionEngine Dev Team' /> |
|
20 |
<meta name='description' content='CodeIgniter User Guide' /> |
|
21 |
||
22 |
</head> |
|
23 |
<body> |
|
24 |
||
25 |
<!-- START NAVIGATION -->
|
|
26 |
<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div> |
|
27 |
<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> |
|
28 |
<div id="masthead"> |
|
29 |
<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> |
|
30 |
<tr> |
|
31 |
<td><h1>CodeIgniter User Guide Version 2.1.3</h1></td> |
|
32 |
<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td> |
|
33 |
</tr> |
|
34 |
</table> |
|
35 |
</div> |
|
36 |
<!-- END NAVIGATION -->
|
|
37 |
||
38 |
||
39 |
<!-- START BREADCRUMB -->
|
|
40 |
<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> |
|
41 |
<tr> |
|
42 |
<td id="breadcrumb"> |
|
43 |
<a href="http://codeigniter.com/">CodeIgniter Home</a> › |
|
44 |
<a href="../index.html">User Guide Home</a> › |
|
45 |
Security Class |
|
46 |
</td> |
|
47 |
<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> |
|
48 |
</tr> |
|
49 |
</table> |
|
50 |
<!-- END BREADCRUMB -->
|
|
51 |
||
52 |
<br clear="all" /> |
|
53 |
||
54 |
||
55 |
<!-- START CONTENT -->
|
|
56 |
<div id="content"> |
|
57 |
||
58 |
||
59 |
<h1>Security Class</h1> |
|
60 |
||
61 |
<p>The Security Class contains methods that help you create a secure application, processing input data for security.</p> |
|
62 |
||
63 |
<h2>XSS Filtering</h2> |
|
64 |
||
65 |
<p>CodeIgniter comes with a Cross Site Scripting Hack prevention filter which can either run automatically to filter |
|
66 |
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> |
|
67 |
run globally since it requires a bit of processing overhead, and since you may not need it in all cases.</p> |
|
68 |
||
69 |
<p>The XSS filter looks for commonly used techniques to trigger Javascript or other types of code that attempt to hijack cookies |
|
70 |
or do other malicious things. If anything disallowed is encountered it is rendered safe by converting the data to character entities.</p> |
|
71 |
||
72 |
<p> |
|
73 |
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> |
|
74 |
||
75 |
||
76 |
<p>To filter data through the XSS filter use this function:</p> |
|
77 |
||
78 |
<h2>$this->security->xss_clean()</h2> |
|
79 |
||
80 |
<p>Here is an usage example:</p> |
|
81 |
||
82 |
<code>$data = $this->security->xss_clean($data);</code> |
|
83 |
||
84 |
<p>If you want the filter to run automatically every time it encounters POST or COOKIE data you can enable it by opening your |
|
85 |
<kbd>application/config/config.php</kbd> file and setting this:</p> |
|
86 |
||
87 |
<code>$config['global_xss_filtering'] = TRUE;</code> |
|
88 |
||
89 |
<p>Note: If you use the form validation class, it gives you the option of XSS filtering as well.</p> |
|
90 |
||
91 |
<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> |
|
92 |
||
93 |
<code>if ($this->security->xss_clean($file, TRUE) === FALSE)<br /> |
|
94 |
{<br />
|
|
95 |
// file failed the XSS test<br /> |
|
96 |
}</code> |
|
97 |
||
98 |
||
99 |
<h2>$this->security->sanitize_filename()</h2> |
|
100 |
||
101 |
<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> |
|
102 |
||
103 |
<code>$filename = $this->security->sanitize_filename($this->input->post('filename'));</code> |
|
104 |
||
105 |
<p>If it is acceptable for the user input to include relative paths, e.g. <kbd>file/in/some/approved/folder.txt</kbd>, you can set the second optional parameter, |
|
106 |
<samp>$relative_path</samp> to TRUE.</p> |
|
107 |
||
108 |
<code>$filename = $this->security->sanitize_filename($this->input->post('filename'), TRUE);</code> |
|
109 |
||
110 |
<!-- @todo write docs for CSRF methods -->
|
|
111 |
||
112 |
<h2>Cross-site request forgery (CSRF)</h2> |
|
113 |
||
114 |
<p>You can enable csrf protection by opening your <kbd>application/config/config.php</kbd> file and setting this:</p> |
|
115 |
<code>$config['csrf_protection'] = TRUE;</code> |
|
116 |
||
117 |
<p>If you use the <a href="../helpers/form_helper.html">form helper</a> the <var>form_open()</var> function will automatically insert a hidden csrf field in your forms.</p> |
|
118 |
||
119 |
</div> |
|
120 |
<!-- END CONTENT -->
|
|
121 |
||
122 |
||
123 |
<div id="footer"> |
|
124 |
<p> |
|
125 |
Previous Topic: <a href="pagination.html">Pagination Class</a> |
|
126 |
·
|
|
127 |
<a href="#top">Top of Page</a> · |
|
128 |
<a href="../index.html">User Guide Home</a> · |
|
129 |
Next Topic: <a href="sessions.html">Session Class</a> |
|
130 |
</p> |
|
131 |
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
|
132 |
</div> |
|
133 |
||
134 |
</body> |
|
135 |
</html> |