user_guide/helpers/security_helper.html

   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 Helper : 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.0.2</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> &nbsp;&#8250;&nbsp;
  44 <a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
  45 Security Helper
  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&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<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 Helper</h1>
  60
  61 <p>The Security Helper file contains security related functions.</p>
  62
  63
  64 <h2>Loading this Helper</h2>
  65
  66 <p>This helper is loaded using the following code:</p>
  67 <code>$this->load->helper('security');</code>
  68
  69 <p>The following functions are available:</p>
  70
  71
  72 <h2>xss_clean()</h2>
  73
  74 <p>Provides Cross Site Script Hack filtering.  This function is an alias to the one in the
  75 <a href="../libraries/input.html">Input class</a>.  More info can be found there.</p>
  76
  77
  78 <h2>sanitize_filename()</h2>
  79
  80 <p>Provides protection against directory traversal.  This function is an alias to the one in the
  81 <a href="../libraries/security.html">Security class</a>.  More info can be found there.</p>
  82
  83
  84 <h2>do_hash()</h2>
  85
  86 <p>Permits you to create SHA1 or MD5 one way hashes suitable for encrypting passwords.  Will create SHA1 by default. Examples:</p>
  87
  88 <code>
  89 $str = do_hash($str); // SHA1<br />
  90 <br />
  91 $str = do_hash($str, 'md5'); // MD5
  92 </code>
  93
  94 <p class="important"><strong>Note:</strong>  This function was formerly named <kbd>dohash()</kbd>, which has been deprecated in favour of <kbd>do_hash()</kbd>.</p>
  95
  96
  97
  98 <h2>strip_image_tags()</h2>
  99
 100 <p>This is a security function that will strip image tags from a string.  It leaves the image URL as plain text.</p>
 101
 102 <code>$string = strip_image_tags($string);</code>
 103
 104
 105 <h2>encode_php_tags()</h2>
 106
 107 <p>This is a security function that converts PHP tags to entities. Note: If you use the XSS filtering function it does this automatically.</p>
 108
 109 <code>$string = encode_php_tags($string);</code>
 110
 111
 112
 113
 114
 115
 116
 117 </div>
 118 <!-- END CONTENT -->
 119
 120
 121 <div id="footer">
 122 <p>
 123 Previous Topic:&nbsp;&nbsp;<a href="path_helper.html"> Path Helper</a>
 124 &nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 125 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 126 <a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 127 Next Topic:&nbsp;&nbsp;<a href="smiley_helper.html">Smiley Helper</a></p>
 128 <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
 129 </div>
 130
 131 </body>
 132 </html>