-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsecurity.html
More file actions
393 lines (377 loc) · 10.3 KB
/
security.html
File metadata and controls
393 lines (377 loc) · 10.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Security Class - Fuel Documentation</title>
<link href="../assets/css/main.css" media="screen" rel="stylesheet" />
<script type="text/javascript" src="../assets/js/jquery-1.4.4.min.js"></script>
<script type="text/javascript" src="../assets/js/nav.js"></script>
<script type="text/javascript" src="../assets/js/highlight.pack.js"></script>
<script type="text/javascript">
$(function() {
show_nav('classes', '../');
});
hljs.tabReplace = ' ';
hljs.initHighlightingOnLoad();
</script>
</head>
<body>
<header>
<h1>Fuel Documentation</h1>
</header>
<div id="main-nav"></div>
<section id="content">
<h2>Security Class</h2>
<p>The security class allows you to have CSRF protection in your application.</p>
<section>
<h2>Configuration</h2>
<p>
The security class is configured through the security section of the <kbd>app/config/config.php</kbd> configuration file.
</p>
<p>The following security configuration settings can be defined:</p>
<table class="config">
<tbody>
<tr class="header">
<th>Param</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<th>csrf_autoload</th>
<td>boolean</td>
<td><pre class="php"><code>true</code></pre></td>
<td>
When true, load and check the CSRF token using check_token() automatically.
</td>
</tr>
<tr>
<th>csrf_token_key</th>
<td>string</td>
<td><pre class="php"><code>'fuel_csrf_token'</code></pre></td>
<td>
Name used for the CSRF token cookie, and the name of the form field containing the token.
</td>
</tr>
<tr>
<th>csrf_expiration</th>
<td>integer</td>
<td><pre class="php"><code>0</code></pre></td>
<td>
Expiration time for the CRSF token cookie. Default, the cookie expires at end of browser session.
</td>
</tr>
<tr>
<th>uri_filter</th>
<td>array</td>
<td><pre class="php"><code>array('htmlentities')</code></pre></td>
<td>
Array of callable items (PHP functions, object methods, static class methods) used to filter the URI. By default, it uses PHP's htmlentities internal function.
</td>
</tr>
<tr>
<th>input_filter</th>
<td>array</td>
<td><pre class="php"><code>array()</code></pre></td>
<td>
Array of callable items (PHP functions, object methods, static class methods) used to filter $_GET, $_POST and $_COOKIE. By default, no input filters are defined.
</td>
</tr>
<tr>
<th>auto_encode_view_data</th>
<td>boolean</td>
<td><pre class="php"><code>true</code></pre></td>
<td>
When true, all variables passed on to view objects are automatically encoded.
</td>
</tr>
<tr>
<th>whitelisted_classes</th>
<td>array</td>
<td><pre class="php"><code>array('stdClass', 'Fuel\\Core\\View',<br /> 'Fuel\\Core\\ViewModel', 'Closure')</code></pre></td>
<td>
When auto encoding of view variables is enabled, you can run into issues when passing objects to the view. Classes defined in this
array will be exempt from auto encoding.
</td>
</tr>
</tbody>
</table>
</section>
<article>
<h4 id="method_check_token">check_token($value = null)</h4>
<p>The <strong>check_token</strong> method allows you to check the CSRF token.<br />
Check token also ensures a token is present and will reset the token for the next session when it receives
a value to check (no matter the result of the check).</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>CSRF token to be checked, checks value from POST when empty.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>boolean</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Security::check_token();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_fetch_token">fetch_token()</h4>
<p>The <strong>fetch_token</strong> method allows you to fetch the CSRF token from the cookie.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$csrf_token = Security::fetch_token();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_js_fetch_token">js_fetch_token()</h4>
<p>The <strong>js_fetch_token</strong> method allows you to produce JavaScript fuel_csrf_token() function that will return the current CSRF token when called. Use to fill right field on form submit for AJAX operations.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>None</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>echo Security::js_fetch_token();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_clean">clean($value, $filters)</h4>
<p>The <strong>clean</strong> method allows you clean data using the filters provided.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><i>Required</i></td>
<td>The value to be cleaned. This can be a string value, or an array of string values.</td>
</tr>
<tr>
<th><kbd>$filters</kbd></th>
<td><i>Required</i></td>
<td>
The filters to be used to clean the string(s). A filter can be a single value, or an array of values. Each value must be a valid PHP callback.
You may specify functions ('htmlentities'), objects ($this), or static methods ('Classname::method').
</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// first strip tags, convert html entities in the remaining data, and finish it off using our special cleaning solution
$filters = array('strip_tags', 'html_entities', '\\cleaners\\soap::clean');
$text = Security::clean($text, $filters);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_strip_tags">strip_tags($value)</h4>
<p>The <strong>strip_tags</strong> method allows you to strip HTML and PHP tags from a string.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><i>Required</i></td>
<td>The input string.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$text = '<p>Test paragraph.</p>';
$text = Security::strip_tags($text);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_xss_clean">xss_clean($value)</h4>
<p>The <strong>xss_clean</strong> method allows you to strip dangerous HTML tags from a string, using the HTMLawed library.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><i>Required</i></td>
<td>The input string.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>string</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$text = '<SCRIPT>alert("XSS attack!")</SCRIPT>';
$text = Security::xss_clean($text);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_htmlentities">htmlentities($value)</h4>
<p>
The <strong>htmlentities</strong> method allows you to escape HTML entities. This method operates identical to PHP's htmlentities() function
but supports array's and objects as well.
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$value</kbd></th>
<td><i>Required</i></td>
<td>The input value.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>mixed</td>
</tr>
<tr>
<th>Throws</th>
<td><strong>RuntimeException</strong>, in case an object has been passed that can't be cast as string.</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$text = '<p>Test paragraph.</p>';
$text = Security::htmlentities($text);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</section>
<section id="footer">
<p>
<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
© 2010 - 2011 Fuel Development Team
</p>
</section>
</body>
</html>