Auth_OpenID_DiffieHellmanSHA1ConsumerSession.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs For Class Auth_OpenID_DiffieHellmanSHA1ConsumerSession</title>
  7. <link rel="stylesheet" href="../media/stylesheet.css" />
  8. <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  9. </head>
  10. <body>
  11. <div class="page-body">
  12. <h2 class="class-name">Class Auth_OpenID_DiffieHellmanSHA1ConsumerSession</h2>
  13. <a name="sec-description"></a>
  14. <div class="info-box">
  15. <div class="info-box-title">Description</div>
  16. <div class="nav-bar">
  17. <span class="disabled">Description</span> |
  18. <a href="#sec-descendents">Descendents</a>
  19. | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  20. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  21. </div>
  22. <div class="info-box-body">
  23. <!-- ========== Info from phpDoc block ========= -->
  24. <p class="short-description">A class implementing HMAC/DH-SHA1 consumer sessions.</p>
  25. <p class="notes">
  26. Located in <a class="field" href="_Auth---OpenID---Consumer.php.html">/Auth/OpenID/Consumer.php</a> (line <span class="field">453</span>)
  27. </p>
  28. <pre></pre>
  29. </div>
  30. </div>
  31. <a name="sec-descendents"></a>
  32. <div class="info-box">
  33. <div class="info-box-title">Direct descendents</div>
  34. <div class="nav-bar">
  35. <a href="#sec-description">Description</a> |
  36. <span class="disabled">Descendents</span>
  37. | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  38. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  39. </div>
  40. <div class="info-box-body">
  41. <table cellpadding="2" cellspacing="0" class="class-table">
  42. <tr>
  43. <th class="class-table-header">Class</th>
  44. <th class="class-table-header">Description</th>
  45. </tr>
  46. <tr>
  47. <td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_DiffieHellmanSHA256ConsumerSession.html">Auth_OpenID_DiffieHellmanSHA256ConsumerSession</a></td>
  48. <td>
  49. A class implementing HMAC/DH-SHA256 consumer sessions.
  50. </td>
  51. </tr>
  52. </table>
  53. </div>
  54. </div>
  55. <a name="sec-var-summary"></a>
  56. <div class="info-box">
  57. <div class="info-box-title">Variable Summary</span></div>
  58. <div class="nav-bar">
  59. <a href="#sec-description">Description</a> |
  60. <a href="#sec-descendents">Descendents</a> |
  61. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  62. |
  63. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  64. </div>
  65. <div class="info-box-body">
  66. <div class="var-summary">
  67. <div class="var-title">
  68. <span class="var-type">mixed</span>
  69. <a href="#$allowed_assoc_types" title="details" class="var-name">$allowed_assoc_types</a>
  70. </div>
  71. <div class="var-title">
  72. <span class="var-type">mixed</span>
  73. <a href="#$hash_func" title="details" class="var-name">$hash_func</a>
  74. </div>
  75. <div class="var-title">
  76. <span class="var-type">mixed</span>
  77. <a href="#$secret_size" title="details" class="var-name">$secret_size</a>
  78. </div>
  79. <div class="var-title">
  80. <span class="var-type">mixed</span>
  81. <a href="#$session_type" title="details" class="var-name">$session_type</a>
  82. </div>
  83. </div>
  84. </div>
  85. </div>
  86. <a name="sec-method-summary"></a>
  87. <div class="info-box">
  88. <div class="info-box-title">Method Summary</span></div>
  89. <div class="nav-bar">
  90. <a href="#sec-description">Description</a> |
  91. <a href="#sec-descendents">Descendents</a> |
  92. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  93. |
  94. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  95. </div>
  96. <div class="info-box-body">
  97. <div class="method-summary">
  98. <div class="method-definition">
  99. <span class="method-result">Auth_OpenID_DiffieHellmanSHA1ConsumerSession</span>
  100. <a href="#Auth_OpenID_DiffieHellmanSHA1ConsumerSession" title="details" class="method-name">Auth_OpenID_DiffieHellmanSHA1ConsumerSession</a>
  101. ([<span class="var-type"></span>&nbsp;<span class="var-name">$dh</span> = <span class="var-default">null</span>])
  102. </div>
  103. <div class="method-definition">
  104. <span class="method-result">void</span>
  105. <a href="#extractSecret" title="details" class="method-name">extractSecret</a>
  106. (<span class="var-type"></span>&nbsp;<span class="var-name">$response</span>)
  107. </div>
  108. <div class="method-definition">
  109. <span class="method-result">void</span>
  110. <a href="#getRequest" title="details" class="method-name">getRequest</a>
  111. ()
  112. </div>
  113. </div>
  114. </div>
  115. </div>
  116. <a name="sec-vars"></a>
  117. <div class="info-box">
  118. <div class="info-box-title">Variables</div>
  119. <div class="nav-bar">
  120. <a href="#sec-description">Description</a> |
  121. <a href="#sec-descendents">Descendents</a> |
  122. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  123. |
  124. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  125. </div>
  126. <div class="info-box-body">
  127. <a name="var$allowed_assoc_types" id="$allowed_assoc_types"><!-- --></A>
  128. <div class="evenrow">
  129. <div class="var-header">
  130. <span class="var-title">
  131. <span class="var-type">mixed</span>
  132. <span class="var-name">$allowed_assoc_types</span>
  133. = <span class="var-default">array('HMAC-SHA1')</span> (line <span class="line-number">457</span>)
  134. </span>
  135. </div>
  136. <!-- ========== Info from phpDoc block ========= -->
  137. <hr class="separator" />
  138. <div class="notes">Redefined in descendants as:</div>
  139. <ul class="redefinitions">
  140. <li>
  141. <a href="../OpenID/Auth_OpenID_DiffieHellmanSHA256ConsumerSession.html#var$allowed_assoc_types">Auth_OpenID_DiffieHellmanSHA256ConsumerSession::$allowed_assoc_types</a>
  142. </li>
  143. </ul>
  144. </div>
  145. <a name="var$hash_func" id="$hash_func"><!-- --></A>
  146. <div class="oddrow">
  147. <div class="var-header">
  148. <span class="var-title">
  149. <span class="var-type">mixed</span>
  150. <span class="var-name">$hash_func</span>
  151. = <span class="var-default"> 'Auth_OpenID_SHA1'</span> (line <span class="line-number">455</span>)
  152. </span>
  153. </div>
  154. <!-- ========== Info from phpDoc block ========= -->
  155. <hr class="separator" />
  156. <div class="notes">Redefined in descendants as:</div>
  157. <ul class="redefinitions">
  158. <li>
  159. <a href="../OpenID/Auth_OpenID_DiffieHellmanSHA256ConsumerSession.html#var$hash_func">Auth_OpenID_DiffieHellmanSHA256ConsumerSession::$hash_func</a>
  160. </li>
  161. </ul>
  162. </div>
  163. <a name="var$secret_size" id="$secret_size"><!-- --></A>
  164. <div class="evenrow">
  165. <div class="var-header">
  166. <span class="var-title">
  167. <span class="var-type">mixed</span>
  168. <span class="var-name">$secret_size</span>
  169. = <span class="var-default"> 20</span> (line <span class="line-number">456</span>)
  170. </span>
  171. </div>
  172. <!-- ========== Info from phpDoc block ========= -->
  173. <hr class="separator" />
  174. <div class="notes">Redefined in descendants as:</div>
  175. <ul class="redefinitions">
  176. <li>
  177. <a href="../OpenID/Auth_OpenID_DiffieHellmanSHA256ConsumerSession.html#var$secret_size">Auth_OpenID_DiffieHellmanSHA256ConsumerSession::$secret_size</a>
  178. </li>
  179. </ul>
  180. </div>
  181. <a name="var$session_type" id="$session_type"><!-- --></A>
  182. <div class="oddrow">
  183. <div class="var-header">
  184. <span class="var-title">
  185. <span class="var-type">mixed</span>
  186. <span class="var-name">$session_type</span>
  187. = <span class="var-default"> 'DH-SHA1'</span> (line <span class="line-number">454</span>)
  188. </span>
  189. </div>
  190. <!-- ========== Info from phpDoc block ========= -->
  191. <hr class="separator" />
  192. <div class="notes">Redefined in descendants as:</div>
  193. <ul class="redefinitions">
  194. <li>
  195. <a href="../OpenID/Auth_OpenID_DiffieHellmanSHA256ConsumerSession.html#var$session_type">Auth_OpenID_DiffieHellmanSHA256ConsumerSession::$session_type</a>
  196. </li>
  197. </ul>
  198. </div>
  199. </div>
  200. </div>
  201. <a name="sec-methods"></a>
  202. <div class="info-box">
  203. <div class="info-box-title">Methods</div>
  204. <div class="nav-bar">
  205. <a href="#sec-description">Description</a> |
  206. <a href="#sec-descendents">Descendents</a> |
  207. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  208. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  209. </div>
  210. <div class="info-box-body">
  211. <A NAME='method_detail'></A>
  212. <a name="methodAuth_OpenID_DiffieHellmanSHA1ConsumerSession" id="Auth_OpenID_DiffieHellmanSHA1ConsumerSession"><!-- --></a>
  213. <div class="evenrow">
  214. <div class="method-header">
  215. <span class="method-title">Constructor Auth_OpenID_DiffieHellmanSHA1ConsumerSession</span> (line <span class="line-number">459</span>)
  216. </div>
  217. <!-- ========== Info from phpDoc block ========= -->
  218. <div class="method-signature">
  219. <span class="method-result">Auth_OpenID_DiffieHellmanSHA1ConsumerSession</span>
  220. <span class="method-name">
  221. Auth_OpenID_DiffieHellmanSHA1ConsumerSession
  222. </span>
  223. ([<span class="var-type"></span>&nbsp;<span class="var-name">$dh</span> = <span class="var-default">null</span>])
  224. </div>
  225. <ul class="parameters">
  226. <li>
  227. <span class="var-type"></span>
  228. <span class="var-name">$dh</span> </li>
  229. </ul>
  230. </div>
  231. <a name="methodextractSecret" id="extractSecret"><!-- --></a>
  232. <div class="oddrow">
  233. <div class="method-header">
  234. <span class="method-title">extractSecret</span> (line <span class="line-number">487</span>)
  235. </div>
  236. <!-- ========== Info from phpDoc block ========= -->
  237. <div class="method-signature">
  238. <span class="method-result">void</span>
  239. <span class="method-name">
  240. extractSecret
  241. </span>
  242. (<span class="var-type"></span>&nbsp;<span class="var-name">$response</span>)
  243. </div>
  244. <ul class="parameters">
  245. <li>
  246. <span class="var-type"></span>
  247. <span class="var-name">$response</span> </li>
  248. </ul>
  249. </div>
  250. <a name="methodgetRequest" id="getRequest"><!-- --></a>
  251. <div class="evenrow">
  252. <div class="method-header">
  253. <span class="method-title">getRequest</span> (line <span class="line-number">468</span>)
  254. </div>
  255. <!-- ========== Info from phpDoc block ========= -->
  256. <div class="method-signature">
  257. <span class="method-result">void</span>
  258. <span class="method-name">
  259. getRequest
  260. </span>
  261. ()
  262. </div>
  263. </div>
  264. </div>
  265. </div>
  266. <p class="notes" id="credit">
  267. Documentation generated on Tue, 21 Apr 2009 11:31:30 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  268. </p>
  269. </div></body>
  270. </html>