PageRenderTime 53ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

/plugins/openid/php-openid-2.0.0/doc/OpenID/Auth_OpenID_DumbStore.html

https://github.com/AlexChien/EY_BBS
HTML | 318 lines | 252 code | 57 blank | 9 comment | 0 complexity | cc35dbe11a41efee614613c5cceb283a MD5 | raw file
Possible License(s): Apache-2.0 
    

  1. <?xml version="1.0" encoding="iso-8859-1"?>

    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

    3. 

  3.   <html xmlns="http://www.w3.org/1999/xhtml">

    4. 

  4. 		<head>

    5. 

  5. 			<!-- template designed by Marco Von Ballmoos -->

    6. 

  6. 			<title>Docs For Class Auth_OpenID_DumbStore</title>

    7. 

  7. 			<link rel="stylesheet" href="../media/stylesheet.css" />

    8. 

  8. 			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>

    9. 

  9. 		</head>

    10. 

  10. 		<body>

    11. 

  11. 			<div class="page-body">			


    12. 

  12. <h2 class="class-name">Class Auth_OpenID_DumbStore</h2>

    13. 

  13. 

    14. 

  14. <a name="sec-description"></a>

    15. 

  15. <div class="info-box">

    16. 

  16. 	<div class="info-box-title">Description</div>

    17. 

  17. 	<div class="nav-bar">

    18. 

  18. 					<span class="disabled">Description</span> |

    19. 

  19. 															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

    20. 

  20. 						

    21. 

  21. 					</div>

    22. 

  22. 	<div class="info-box-body">

    23. 

  23.         		<!-- ========== Info from phpDoc block ========= -->

    24. 

  24. <p class="short-description">This is a store for use in the worst case, when you have no way of  saving state on the consumer site. Using this store makes the  consumer vulnerable to replay attacks, as it's unable to use  nonces. Avoid using this store if it is at all possible.</p>

    25. 

  25. <p class="description"><p>Most of the methods of this class are implementation details.  Users of this class need to worry only about the constructor.</p></p>

    26. 

  26. 	<ul class="tags">

    27. 

  27. 				<li><span class="field">author:</span> JanRain, Inc. &lt;<a href="mailto:openid@janrain.com">openid@janrain.com</a>&gt;</li>

    28. 

  28. 			</ul>

    29. 

  29. 		<p class="notes">

    30. 

  30. 			Located in <a class="field" href="_Auth---OpenID---DumbStore.php.html">/Auth/OpenID/DumbStore.php</a> (line <span class="field">34</span>)

    31. 

  31. 		</p>

    32. 

  32. 		

    33. 

  33. 				

    34. 

  34. 		<pre><a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a>
    35. 

  35.    |
    36. 

  36.    --Auth_OpenID_DumbStore</pre>

    37. 

  37. 	

    38. 

  38. 			</div>

    39. 

  39. </div>

    40. 

  40. 

    41. 

  41. 

    42. 

  42. 

    43. 

  43. 

    44. 

  44. 	<a name="sec-method-summary"></a>

    45. 

  45. 	<div class="info-box">

    46. 

  46. 		<div class="info-box-title">Method Summary</span></div>

    47. 

  47. 		<div class="nav-bar">

    48. 

  48. 			<a href="#sec-description">Description</a> |

    49. 

  49. 												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)

    50. 

  50. 		</div>

    51. 

  51. 		<div class="info-box-body">			

    52. 

  52. 			<div class="method-summary">

    53. 

  53. 																																																														

    54. 

  54. 				<div class="method-definition">

    55. 

  55. 											<span class="method-result">Auth_OpenID_DumbStore</span>

    56. 

  56. 										<a href="#Auth_OpenID_DumbStore" title="details" class="method-name">Auth_OpenID_DumbStore</a>

    57. 

  57. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$secret_phrase</span>)

    58. 

  58. 									</div>

    59. 

  59. 														

    60. 

  60. 				<div class="method-definition">

    61. 

  61. 											<span class="method-result">void</span>

    62. 

  62. 										<a href="#getAssociation" title="details" class="method-name">getAssociation</a>

    63. 

  63. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$handle</span> = <span class="var-default">null</span>])

    64. 

  64. 									</div>

    65. 

  65. 														

    66. 

  66. 				<div class="method-definition">

    67. 

  67. 											<span class="method-result">void</span>

    68. 

  68. 										<a href="#getAuthKey" title="details" class="method-name">getAuthKey</a>

    69. 

  69. 										()

    70. 

  70. 									</div>

    71. 

  71. 														

    72. 

  72. 				<div class="method-definition">

    73. 

  73. 											<span class="method-result">void</span>

    74. 

  74. 										<a href="#removeAssociation" title="details" class="method-name">removeAssociation</a>

    75. 

  75. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$handle</span>)

    76. 

  76. 									</div>

    77. 

  77. 														

    78. 

  78. 				<div class="method-definition">

    79. 

  79. 											<span class="method-result">void</span>

    80. 

  80. 										<a href="#storeAssociation" title="details" class="method-name">storeAssociation</a>

    81. 

  81. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$association</span>)

    82. 

  82. 									</div>

    83. 

  83. 														

    84. 

  84. 				<div class="method-definition">

    85. 

  85. 											<span class="method-result">void</span>

    86. 

  86. 										<a href="#useNonce" title="details" class="method-name">useNonce</a>

    87. 

  87. 											(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$timestamp</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$salt</span>)

    88. 

  88. 									</div>

    89. 

  89. 											</div>

    90. 

  90. 		</div>

    91. 

  91. 	</div>		

    92. 

  92. 

    93. 

  93. 	

    94. 

  94. 	<a name="sec-methods"></a>

    95. 

  95. 	<div class="info-box">

    96. 

  96. 		<div class="info-box-title">Methods</div>

    97. 

  97. 		<div class="nav-bar">

    98. 

  98. 			<a href="#sec-description">Description</a> |

    99. 

  99. 																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)

    100. 

  100. 						

    101. 

  101. 		</div>

    102. 

  102. 		<div class="info-box-body">

    103. 

  103. 			<A NAME='method_detail'></A>

    104. 

  104. <a name="methodAuth_OpenID_DumbStore" id="Auth_OpenID_DumbStore"><!-- --></a>

    105. 

  105. <div class="evenrow">

    106. 

  106. 	

    107. 

  107. 	<div class="method-header">

    108. 

  108. 		<span class="method-title">Constructor Auth_OpenID_DumbStore</span> (line <span class="line-number">53</span>)

    109. 

  109. 	</div> 

    110. 

  110. 	

    111. 

  111. 	<!-- ========== Info from phpDoc block ========= -->

    112. 

  112. <p class="short-description">Creates a new <a href="../OpenID/Auth_OpenID_DumbStore.html">Auth_OpenID_DumbStore</a> instance. For the security  of the tokens generated by the library, this class attempts to  at least have a secure implementation of getAuthKey.</p>

    113. 

  113. <p class="description"><p>When you create an instance of this class, pass in a secret  phrase. The phrase is hashed with sha1 to make it the correct  length and form for an auth key. That allows you to use a long  string as the secret phrase, which means you can make it very  difficult to guess.</p><p>Each <a href="../OpenID/Auth_OpenID_DumbStore.html">Auth_OpenID_DumbStore</a> instance that is created for use by  your consumer site needs to use the same $secret_phrase.</p></p>

    114. 

  114. 	

    115. 

  115. 	<div class="method-signature">

    116. 

  116. 		<span class="method-result">Auth_OpenID_DumbStore</span>

    117. 

  117. 		<span class="method-name">

    118. 

  118. 			Auth_OpenID_DumbStore

    119. 

  119. 		</span>

    120. 

  120. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$secret_phrase</span>)

    121. 

  121. 			</div>

    122. 

  122. 	

    123. 

  123. 			<ul class="parameters">

    124. 

  124. 					<li>

    125. 

  125. 				<span class="var-type">string</span>

    126. 

  126. 				<span class="var-name">$secret_phrase</span><span class="var-description">: secret_phrase The phrase used to create the auth  key returned by getAuthKey</span>			</li>

    127. 

  127. 				</ul>

    128. 

  128. 		

    129. 

  129. 			

    130. 

  130. 	</div>

    131. 

  131. <a name="methodgetAssociation" id="getAssociation"><!-- --></a>

    132. 

  132. <div class="oddrow">

    133. 

  133. 	

    134. 

  134. 	<div class="method-header">

    135. 

  135. 		<span class="method-title">getAssociation</span> (line <span class="line-number">68</span>)

    136. 

  136. 	</div> 

    137. 

  137. 	

    138. 

  138. 	<!-- ========== Info from phpDoc block ========= -->

    139. 

  139. <p class="short-description">This implementation always returns null.</p>

    140. 

  140. 	

    141. 

  141. 	<div class="method-signature">

    142. 

  142. 		<span class="method-result">void</span>

    143. 

  143. 		<span class="method-name">

    144. 

  144. 			getAssociation

    145. 

  145. 		</span>

    146. 

  146. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$handle</span> = <span class="var-default">null</span>])

    147. 

  147. 			</div>

    148. 

  148. 	

    149. 

  149. 			<ul class="parameters">

    150. 

  150. 					<li>

    151. 

  151. 				<span class="var-type"></span>

    152. 

  152. 				<span class="var-name">$server_url</span>			</li>

    153. 

  153. 					<li>

    154. 

  154. 				<span class="var-type"></span>

    155. 

  155. 				<span class="var-name">$handle</span>			</li>

    156. 

  156. 				</ul>

    157. 

  157. 		

    158. 

  158. 			<hr class="separator" />

    159. 

  159. 		<div class="notes">Redefinition of:</div>

    160. 

  160. 		<dl>

    161. 

  161. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodgetAssociation">Auth_OpenID_OpenIDStore::getAssociation()</a></dt>

    162. 

  162. 						<dd>This method returns an Association object from storage that  matches the server URL and, if specified, handle. It returns  null if no such association is found or if the matching  association is expired.</dd>

    163. 

  163. 					</dl>

    164. 

  164. 			

    165. 

  165. 	</div>

    166. 

  166. <a name="methodgetAuthKey" id="getAuthKey"><!-- --></a>

    167. 

  167. <div class="evenrow">

    168. 

  168. 	

    169. 

  169. 	<div class="method-header">

    170. 

  170. 		<span class="method-title">getAuthKey</span> (line <span class="line-number">94</span>)

    171. 

  171. 	</div> 

    172. 

  172. 	

    173. 

  173. 	<!-- ========== Info from phpDoc block ========= -->

    174. 

  174. <p class="short-description">This method returns the auth key generated by the constructor.</p>

    175. 

  175. 	

    176. 

  176. 	<div class="method-signature">

    177. 

  177. 		<span class="method-result">void</span>

    178. 

  178. 		<span class="method-name">

    179. 

  179. 			getAuthKey

    180. 

  180. 		</span>

    181. 

  181. 				()

    182. 

  182. 			</div>

    183. 

  183. 	

    184. 

  184. 		

    185. 

  185. 			

    186. 

  186. 	</div>

    187. 

  187. <a name="methodremoveAssociation" id="removeAssociation"><!-- --></a>

    188. 

  188. <div class="oddrow">

    189. 

  189. 	

    190. 

  190. 	<div class="method-header">

    191. 

  191. 		<span class="method-title">removeAssociation</span> (line <span class="line-number">76</span>)

    192. 

  192. 	</div> 

    193. 

  193. 	

    194. 

  194. 	<!-- ========== Info from phpDoc block ========= -->

    195. 

  195. <p class="short-description">This implementation always returns false.</p>

    196. 

  196. 	

    197. 

  197. 	<div class="method-signature">

    198. 

  198. 		<span class="method-result">void</span>

    199. 

  199. 		<span class="method-name">

    200. 

  200. 			removeAssociation

    201. 

  201. 		</span>

    202. 

  202. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$handle</span>)

    203. 

  203. 			</div>

    204. 

  204. 	

    205. 

  205. 			<ul class="parameters">

    206. 

  206. 					<li>

    207. 

  207. 				<span class="var-type"></span>

    208. 

  208. 				<span class="var-name">$server_url</span>			</li>

    209. 

  209. 					<li>

    210. 

  210. 				<span class="var-type"></span>

    211. 

  211. 				<span class="var-name">$handle</span>			</li>

    212. 

  212. 				</ul>

    213. 

  213. 		

    214. 

  214. 			<hr class="separator" />

    215. 

  215. 		<div class="notes">Redefinition of:</div>

    216. 

  216. 		<dl>

    217. 

  217. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodremoveAssociation">Auth_OpenID_OpenIDStore::removeAssociation()</a></dt>

    218. 

  218. 						<dd>This method removes the matching association if it's found, and  returns whether the association was removed or not.</dd>

    219. 

  219. 					</dl>

    220. 

  220. 			

    221. 

  221. 	</div>

    222. 

  222. <a name="methodstoreAssociation" id="storeAssociation"><!-- --></a>

    223. 

  223. <div class="evenrow">

    224. 

  224. 	

    225. 

  225. 	<div class="method-header">

    226. 

  226. 		<span class="method-title">storeAssociation</span> (line <span class="line-number">61</span>)

    227. 

  227. 	</div> 

    228. 

  228. 	

    229. 

  229. 	<!-- ========== Info from phpDoc block ========= -->

    230. 

  230. <p class="short-description">This implementation does nothing.</p>

    231. 

  231. 	

    232. 

  232. 	<div class="method-signature">

    233. 

  233. 		<span class="method-result">void</span>

    234. 

  234. 		<span class="method-name">

    235. 

  235. 			storeAssociation

    236. 

  236. 		</span>

    237. 

  237. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$association</span>)

    238. 

  238. 			</div>

    239. 

  239. 	

    240. 

  240. 			<ul class="parameters">

    241. 

  241. 					<li>

    242. 

  242. 				<span class="var-type"></span>

    243. 

  243. 				<span class="var-name">$server_url</span>			</li>

    244. 

  244. 					<li>

    245. 

  245. 				<span class="var-type"></span>

    246. 

  246. 				<span class="var-name">$association</span>			</li>

    247. 

  247. 				</ul>

    248. 

  248. 		

    249. 

  249. 			<hr class="separator" />

    250. 

  250. 		<div class="notes">Redefinition of:</div>

    251. 

  251. 		<dl>

    252. 

  252. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodstoreAssociation">Auth_OpenID_OpenIDStore::storeAssociation()</a></dt>

    253. 

  253. 						<dd>This method puts an Association object into storage,  retrievable by server URL and handle.</dd>

    254. 

  254. 					</dl>

    255. 

  255. 			

    256. 

  256. 	</div>

    257. 

  257. <a name="methoduseNonce" id="useNonce"><!-- --></a>

    258. 

  258. <div class="oddrow">

    259. 

  259. 	

    260. 

  260. 	<div class="method-header">

    261. 

  261. 		<span class="method-title">useNonce</span> (line <span class="line-number">86</span>)

    262. 

  262. 	</div> 

    263. 

  263. 	

    264. 

  264. 	<!-- ========== Info from phpDoc block ========= -->

    265. 

  265. <p class="short-description">In a system truly limited to dumb mode, nonces must all be  accepted. This therefore always returns true, which makes  replay attacks feasible.</p>

    266. 

  266. 	

    267. 

  267. 	<div class="method-signature">

    268. 

  268. 		<span class="method-result">void</span>

    269. 

  269. 		<span class="method-name">

    270. 

  270. 			useNonce

    271. 

  271. 		</span>

    272. 

  272. 					(<span class="var-type"></span>&nbsp;<span class="var-name">$server_url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$timestamp</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$salt</span>)

    273. 

  273. 			</div>

    274. 

  274. 	

    275. 

  275. 			<ul class="parameters">

    276. 

  276. 					<li>

    277. 

  277. 				<span class="var-type"></span>

    278. 

  278. 				<span class="var-name">$server_url</span>			</li>

    279. 

  279. 					<li>

    280. 

  280. 				<span class="var-type"></span>

    281. 

  281. 				<span class="var-name">$timestamp</span>			</li>

    282. 

  282. 					<li>

    283. 

  283. 				<span class="var-type"></span>

    284. 

  284. 				<span class="var-name">$salt</span>			</li>

    285. 

  285. 				</ul>

    286. 

  286. 		

    287. 

  287. 			<hr class="separator" />

    288. 

  288. 		<div class="notes">Redefinition of:</div>

    289. 

  289. 		<dl>

    290. 

  290. 			<dt><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methoduseNonce">Auth_OpenID_OpenIDStore::useNonce()</a></dt>

    291. 

  291. 						<dd>Called when using a nonce.</dd>

    292. 

  292. 					</dl>

    293. 

  293. 			

    294. 

  294. 	</div>

    295. 

  295. 							<h4>Inherited Methods</h4>

    296. 

  296. 				<a name='inherited_methods'><!-- --></a>	

    297. 

  297. 									<!-- =========== Summary =========== -->

    298. 

  298. 					<p>Inherited From <span class="classname"><a href="../OpenID/Auth_OpenID_OpenIDStore.html">Auth_OpenID_OpenIDStore</a></span></p>

    299. 

  299. 					<blockquote>

    300. 

  300. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanup">Auth_OpenID_OpenIDStore::cleanup()</a></span><br>

    301. 

  301. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanupAssociations">Auth_OpenID_OpenIDStore::cleanupAssociations()</a></span><br>

    302. 

  302. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodcleanupNonces">Auth_OpenID_OpenIDStore::cleanupNonces()</a></span><br>

    303. 

  303. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodgetAssociation">Auth_OpenID_OpenIDStore::getAssociation()</a></span><br>

    304. 

  304. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodremoveAssociation">Auth_OpenID_OpenIDStore::removeAssociation()</a></span><br>

    305. 

  305. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodreset">Auth_OpenID_OpenIDStore::reset()</a></span><br>

    306. 

  306. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methodstoreAssociation">Auth_OpenID_OpenIDStore::storeAssociation()</a></span><br>

    307. 

  307. 													<span class="method-name"><a href="../OpenID/Auth_OpenID_OpenIDStore.html#methoduseNonce">Auth_OpenID_OpenIDStore::useNonce()</a></span><br>

    308. 

  308. 											</blockquote>

    309. 

  309. 										

    310. 

  310. 		</div>

    311. 

  311. 	</div>

    312. 

  312. 

    313. 

  313. 

    314. 

  314. 	<p class="notes" id="credit">

    315. 

  315. 		Documentation generated on Wed, 05 Dec 2007 14:02:12 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>

    316. 

  316. 	</p>

    317. 

  317. 	</div></body>

    318. 

  318. </html>

    319.