/classes/crypt.html

https://github.com/rclanan/docs · HTML · 186 lines · 174 code · 12 blank · 0 comment · 0 complexity · 78f91fa2a31008577cc5b1f1ed433764 MD5 · raw file 

    

  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<title>Crypt Class - Fuel Documentation</title>
    6. 

  6. 	<link href="../assets/css/main.css" media="screen" rel="stylesheet" />
    7. 

  7. 	<script type="text/javascript" src="../assets/js/jquery-1.4.4.min.js"></script>
    8. 

  8. 	<script type="text/javascript" src="../assets/js/nav.js"></script>
    9. 

  9. 	<script type="text/javascript" src="../assets/js/highlight.pack.js"></script>
    10. 

  10. 	<script type="text/javascript">
    11. 

  11. 		$(function() {
    12. 

  12. 			show_nav('classes', '../');
    13. 

  13. 		});
    14. 

  14. 		hljs.tabReplace = '    ';
    15. 

  15. 		hljs.initHighlightingOnLoad();
    16. 

  16. 	</script>
    17. 

  17. </head>
    18. 

  18. <body>
    19. 

  19. 

  20. 	<header>
    21. 

  21. 		<h1>Fuel Documentation</h1>
    22. 

  22. 	</header>
    23. 

  23. 

  24. 	<div id="main-nav"></div>
    25. 

  25. 

  26. 	<section id="content">
    27. 

  27. 		<h2>Crypt Class</h2>
    28. 

  28. 

  29. 		<p>
    30. 

  30. 			The Crypt class allows encrypt or decrypt a string. The Crypt class is also used internally by for example the Fuel Sessions class.
    31. 

  31. 		</p>
    32. 

  32. 		<p>It uses the encryption and hashing methods provided by PHPSecLib, so it's not dependent on external modules being available, such as mcrypt.</p>
    33. 

    34. 

  34. 		<section>
    35. 

  35. 			<h2>Configuration</h2>
    36. 

  36. 

  37. 			<p>
    38. 

  38. 				The Crypt class is configured through the <kbd>app/config/crypt.php</kbd> configuration file. It will be generated and populated with random values when you first use the Crypt class or if one of the required configuration values is missing.
    39. 

  39. 			</p>
    40. 

  40. 			<p class="note">
    41. 

  41. 				Note that this will require write access to app/config/crypt.php! If this is not possible, make sure all configuration settings are set!
    42. 

  42. 			</p>
    43. 

  43. 			<p>The following configuration settings can be defined:</p>
    44. 

  44. 			<table class="config">
    45. 

  45. 				<tbody>
    46. 

  46. 					<tr class="header">
    47. 

  47. 						<th>Param</th>
    48. 

  48. 						<th>Type</th>
    49. 

  49. 						<th>Default</th>
    50. 

  50. 						<th>Description</th>
    51. 

  51. 					</tr>
    52. 

  52. 					<tr>
    53. 

  53. 						<th>crypto_key</th>
    54. 

  54. 						<td>string</td>
    55. 

  55. 						<td>n/a</td>
    56. 

  56. 						<td>
    57. 

  57. 							Random encryption key value used in the encryption routines. Make sure you set this to something unique and random!
    58. 

  58. 						</td>
    59. 

  59. 					</tr>
    60. 

  60. 					<tr>
    61. 

  61. 						<th>crypto_iv</th>
    62. 

  62. 						<td>string</td>
    63. 

  63. 						<td>n/a</td>
    64. 

  64. 						<td>
    65. 

  65. 							Random encryption initialisation vector used in the encryption routines. Make sure you set this to something unique and random!
    66. 

  66. 						</td>
    67. 

  67. 					</tr>
    68. 

  68. 					<tr>
    69. 

  69. 						<th>crypto_hmac</th>
    70. 

  70. 						<td>string</td>
    71. 

  71. 						<td>n/a</td>
    72. 

  72. 						<td>
    73. 

  73. 							Random value used in the Hash-based Message Authentication Code (HMAC) routines. Make sure you set this to something unique and random!
    74. 

  74. 						</td>
    75. 

  75. 					</tr>
    76. 

  76. 				</tbody>
    77. 

  77. 			</table>
    78. 

  78. 			<p class="note">
    79. 

  79. 				If you assign keys manually, note that they are base64_encoded, and the length must be a multiple of 4 to be able to decode it. Make sure the length is correct!
    80. 

  80. 			</p>
    81. 

  81. 		</section>
    82. 

  82. 

  83. 		<article>
    84. 

  84. 			<h4 id="method_encode">encode($value, $key = false)</h4>
    85. 

  85. 			<p>The <strong>encode</strong> method encrypts a string value, optionally with a custom encryption key.</p>
    86. 

  86. 			<table class="method">
    87. 

  87. 				<tbody>
    88. 

  88. 				<tr>
    89. 

  89. 					<th class="legend">Static</th>
    90. 

  90. 					<td>No</td>
    91. 

  91. 				</tr>
    92. 

  92. 				<tr>
    93. 

  93. 					<th>Parameters</th>
    94. 

  94. 					<td>
    95. 

  95. 						<table class="parameters">
    96. 

  96. 							<tr>
    97. 

  97. 								<th>Param</th>
    98. 

  98. 								<th>Default</th>
    99. 

  99. 								<th class="description">Description</th>
    100. 

  100. 							</tr>
    101. 

  101. 							<tr>
    102. 

  102. 								<th><kbd>$value</kbd></th>
    103. 

  103. 								<td><i>Required</i></td>
    104. 

  104. 								<td>String value to encode.</td>
    105. 

  105. 							</tr>
    106. 

  106. 							<tr>
    107. 

  107. 								<th><kbd>$key</kbd></th>
    108. 

  108. 								<td><pre class="php"><code>false</code></pre></td>
    109. 

  109. 								<td>Optional custom key value to be used to encode the value passsed. If false, the config value '<strong>crypto_key</strong>' is used.</td>
    110. 

  110. 							</tr>
    111. 

  111. 						</table>
    112. 

  112. 					</td>
    113. 

  113. 				</tr>
    114. 

  114. 				<tr>
    115. 

  115. 					<th>Returns</th>
    116. 

  116. 					<td>string</td>
    117. 

  117. 				</tr>
    118. 

  118. 				<tr>
    119. 

  119. 					<th>Example</th>
    120. 

  120. 					<td>
    121. 

  121. <pre class="php"><code>// encode a variable with a custom key
    122. 

  122. $value = Crypt::encode($value, 'R@nd0mK~Y');</code></pre>
    123. 

  123. 					</td>
    124. 

  124. 				</tr>
    125. 

  125. 				</tbody>
    126. 

  126. 			</table>
    127. 

  127. 		</article>
    128. 

  128. 

  129. 		<article>
    130. 

  130. 			<h4 id="method_decode">decode($value, $key = false)</h4>
    131. 

  131. 			<p>The <strong>decode</strong> method decrypts a string value, optionally with a custom key.</p>
    132. 

  132. 			<table class="method">
    133. 

  133. 				<tbody>
    134. 

  134. 				<tr>
    135. 

  135. 					<th class="legend">Static</th>
    136. 

  136. 					<td>No</td>
    137. 

  137. 				</tr>
    138. 

  138. 				<tr>
    139. 

  139. 					<th>Parameters</th>
    140. 

  140. 					<td>
    141. 

  141. 						<table class="parameters">
    142. 

  142. 							<tr>
    143. 

  143. 								<th>Param</th>
    144. 

  144. 								<th>Default</th>
    145. 

  145. 								<th class="description">Description</th>
    146. 

  146. 							</tr>
    147. 

  147. 							<tr>
    148. 

  148. 								<th><kbd>$value</kbd></th>
    149. 

  149. 								<td><i>Required</i></td>
    150. 

  150. 								<td>String value to decode.</td>
    151. 

  151. 							</tr>
    152. 

  152. 							<tr>
    153. 

  153. 								<th><kbd>$key</kbd></th>
    154. 

  154. 								<td><pre class="php"><code>false</code></pre></td>
    155. 

  155. 								<td>Optional custom key value to be used to decode the value passsed. If false, the config value '<strong>crypto_key</strong>' is used.</td>
    156. 

  156. 							</tr>
    157. 

  157. 						</table>
    158. 

  158. 					</td>
    159. 

  159. 				</tr>
    160. 

  160. 				<tr>
    161. 

  161. 					<th>Returns</th>
    162. 

  162. 					<td>mixed - String value with the decoded value, or <kbd>false</kbd> if the value could not be decoded.</td>
    163. 

  163. 				</tr>
    164. 

  164. 				<tr>
    165. 

  165. 					<th>Example</th>
    166. 

  166. 					<td>
    167. 

  167. <pre class="php"><code>// decode a variable with a custom key
    168. 

  168. $value = Crypt::decode($value, 'R@nd0mK~Y');</code></pre>
    169. 

  169. 					</td>
    170. 

  170. 				</tr>
    171. 

  171. 				</tbody>
    172. 

  172. 			</table>
    173. 

  173. 		</article>
    174. 

  174. 

  175. 

  176. 	</section>
    177. 

  177. 

  178. 	<section id="footer">
    179. 

  179. 		<p>
    180. 

  180. 			<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
    181. 

  181. 			&copy; 2010 - 2011 Fuel Development Team
    182. 

  182. 		</p>
    183. 

  183. 	</section>
    184. 

  184. 

  185. </body>
    186. 

  186. </html>
    187.