Auth_OpenID_DiffieHellmanSHA1ServerSession.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  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_DiffieHellmanSHA1ServerSession</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_DiffieHellmanSHA1ServerSession</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 DH-SHA1 server sessions.</p>
  25. <p class="notes">
  26. Located in <a class="field" href="_Auth---OpenID---Server.php.html">/Auth/OpenID/Server.php</a> (line <span class="field">454</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_DiffieHellmanSHA256ServerSession.html">Auth_OpenID_DiffieHellmanSHA256ServerSession</a></td>
  48. <td>
  49. A class implementing DH-SHA256 server 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="#$needs_math" title="details" class="var-name">$needs_math</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_DiffieHellmanSHA1ServerSession</span>
  100. <a href="#Auth_OpenID_DiffieHellmanSHA1ServerSession" title="details" class="method-name">Auth_OpenID_DiffieHellmanSHA1ServerSession</a>
  101. (<span class="var-type"></span>&nbsp;<span class="var-name">$dh</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$consumer_pubkey</span>)
  102. </div>
  103. <div class="method-definition">
  104. <span class="method-result">void</span>
  105. <a href="#answer" title="details" class="method-name">answer</a>
  106. (<span class="var-type"></span>&nbsp;<span class="var-name">$secret</span>)
  107. </div>
  108. <div class="method-definition">
  109. <span class="method-result">void</span>
  110. <a href="#fromMessage" title="details" class="method-name">fromMessage</a>
  111. (<span class="var-type"></span>&nbsp;<span class="var-name">$message</span>)
  112. </div>
  113. <div class="method-definition">
  114. <span class="method-result">void</span>
  115. <a href="#getDH" title="details" class="method-name">getDH</a>
  116. (<span class="var-type"></span>&nbsp;<span class="var-name">$message</span>)
  117. </div>
  118. </div>
  119. </div>
  120. </div>
  121. <a name="sec-vars"></a>
  122. <div class="info-box">
  123. <div class="info-box-title">Variables</div>
  124. <div class="nav-bar">
  125. <a href="#sec-description">Description</a> |
  126. <a href="#sec-descendents">Descendents</a> |
  127. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  128. |
  129. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  130. </div>
  131. <div class="info-box-body">
  132. <a name="var$allowed_assoc_types" id="$allowed_assoc_types"><!-- --></A>
  133. <div class="oddrow">
  134. <div class="var-header">
  135. <span class="var-title">
  136. <span class="var-type">mixed</span>
  137. <span class="var-name">$allowed_assoc_types</span>
  138. = <span class="var-default">array('HMAC-SHA1')</span> (line <span class="line-number">462</span>)
  139. </span>
  140. </div>
  141. <!-- ========== Info from phpDoc block ========= -->
  142. <hr class="separator" />
  143. <div class="notes">Redefined in descendants as:</div>
  144. <ul class="redefinitions">
  145. <li>
  146. <a href="../OpenID/Auth_OpenID_DiffieHellmanSHA256ServerSession.html#var$allowed_assoc_types">Auth_OpenID_DiffieHellmanSHA256ServerSession::$allowed_assoc_types</a>
  147. </li>
  148. </ul>
  149. </div>
  150. <a name="var$hash_func" id="$hash_func"><!-- --></A>
  151. <div class="evenrow">
  152. <div class="var-header">
  153. <span class="var-title">
  154. <span class="var-type">mixed</span>
  155. <span class="var-name">$hash_func</span>
  156. = <span class="var-default"> 'Auth_OpenID_SHA1'</span> (line <span class="line-number">463</span>)
  157. </span>
  158. </div>
  159. <!-- ========== Info from phpDoc block ========= -->
  160. <hr class="separator" />
  161. <div class="notes">Redefined in descendants as:</div>
  162. <ul class="redefinitions">
  163. <li>
  164. <a href="../OpenID/Auth_OpenID_DiffieHellmanSHA256ServerSession.html#var$hash_func">Auth_OpenID_DiffieHellmanSHA256ServerSession::$hash_func</a>
  165. </li>
  166. </ul>
  167. </div>
  168. <a name="var$needs_math" id="$needs_math"><!-- --></A>
  169. <div class="oddrow">
  170. <div class="var-header">
  171. <span class="var-title">
  172. <span class="var-type">mixed</span>
  173. <span class="var-name">$needs_math</span>
  174. = <span class="var-default"> true</span> (line <span class="line-number">461</span>)
  175. </span>
  176. </div>
  177. <!-- ========== Info from phpDoc block ========= -->
  178. </div>
  179. <a name="var$session_type" id="$session_type"><!-- --></A>
  180. <div class="evenrow">
  181. <div class="var-header">
  182. <span class="var-title">
  183. <span class="var-type">mixed</span>
  184. <span class="var-name">$session_type</span>
  185. = <span class="var-default"> 'DH-SHA1'</span> (line <span class="line-number">460</span>)
  186. </span>
  187. </div>
  188. <!-- ========== Info from phpDoc block ========= -->
  189. <p class="short-description">An object that knows how to handle association requests with the Diffie-Hellman session type.</p>
  190. <hr class="separator" />
  191. <div class="notes">Redefined in descendants as:</div>
  192. <ul class="redefinitions">
  193. <li>
  194. <a href="../OpenID/Auth_OpenID_DiffieHellmanSHA256ServerSession.html#var$session_type">Auth_OpenID_DiffieHellmanSHA256ServerSession::$session_type</a>
  195. </li>
  196. </ul>
  197. </div>
  198. </div>
  199. </div>
  200. <a name="sec-methods"></a>
  201. <div class="info-box">
  202. <div class="info-box-title">Methods</div>
  203. <div class="nav-bar">
  204. <a href="#sec-description">Description</a> |
  205. <a href="#sec-descendents">Descendents</a> |
  206. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  207. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  208. </div>
  209. <div class="info-box-body">
  210. <A NAME='method_detail'></A>
  211. <a name="methodAuth_OpenID_DiffieHellmanSHA1ServerSession" id="Auth_OpenID_DiffieHellmanSHA1ServerSession"><!-- --></a>
  212. <div class="oddrow">
  213. <div class="method-header">
  214. <span class="method-title">Constructor Auth_OpenID_DiffieHellmanSHA1ServerSession</span> (line <span class="line-number">465</span>)
  215. </div>
  216. <!-- ========== Info from phpDoc block ========= -->
  217. <div class="method-signature">
  218. <span class="method-result">Auth_OpenID_DiffieHellmanSHA1ServerSession</span>
  219. <span class="method-name">
  220. Auth_OpenID_DiffieHellmanSHA1ServerSession
  221. </span>
  222. (<span class="var-type"></span>&nbsp;<span class="var-name">$dh</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$consumer_pubkey</span>)
  223. </div>
  224. <ul class="parameters">
  225. <li>
  226. <span class="var-type"></span>
  227. <span class="var-name">$dh</span> </li>
  228. <li>
  229. <span class="var-type"></span>
  230. <span class="var-name">$consumer_pubkey</span> </li>
  231. </ul>
  232. </div>
  233. <a name="methodanswer" id="answer"><!-- --></a>
  234. <div class="evenrow">
  235. <div class="method-header">
  236. <span class="method-title">answer</span> (line <span class="line-number">538</span>)
  237. </div>
  238. <!-- ========== Info from phpDoc block ========= -->
  239. <div class="method-signature">
  240. <span class="method-result">void</span>
  241. <span class="method-name">
  242. answer
  243. </span>
  244. (<span class="var-type"></span>&nbsp;<span class="var-name">$secret</span>)
  245. </div>
  246. <ul class="parameters">
  247. <li>
  248. <span class="var-type"></span>
  249. <span class="var-name">$secret</span> </li>
  250. </ul>
  251. </div>
  252. <a name="methodfromMessage" id="fromMessage"><!-- --></a>
  253. <div class="oddrow">
  254. <div class="method-header">
  255. <span class="method-title">fromMessage</span> (line <span class="line-number">525</span>)
  256. </div>
  257. <!-- ========== Info from phpDoc block ========= -->
  258. <div class="method-signature">
  259. <span class="method-result">void</span>
  260. <span class="method-name">
  261. fromMessage
  262. </span>
  263. (<span class="var-type"></span>&nbsp;<span class="var-name">$message</span>)
  264. </div>
  265. <ul class="parameters">
  266. <li>
  267. <span class="var-type"></span>
  268. <span class="var-name">$message</span> </li>
  269. </ul>
  270. <hr class="separator" />
  271. <div class="notes">Redefined in descendants as:</div>
  272. <ul class="redefinitions">
  273. <li>
  274. <a href="../OpenID/Auth_OpenID_DiffieHellmanSHA256ServerSession.html#methodfromMessage">Auth_OpenID_DiffieHellmanSHA256ServerSession::fromMessage()</a>
  275. </li>
  276. </ul>
  277. </div>
  278. <a name="methodgetDH" id="getDH"><!-- --></a>
  279. <div class="evenrow">
  280. <div class="method-header">
  281. <span class="method-title">getDH</span> (line <span class="line-number">471</span>)
  282. </div>
  283. <!-- ========== Info from phpDoc block ========= -->
  284. <div class="method-signature">
  285. <span class="method-result">void</span>
  286. <span class="method-name">
  287. getDH
  288. </span>
  289. (<span class="var-type"></span>&nbsp;<span class="var-name">$message</span>)
  290. </div>
  291. <ul class="parameters">
  292. <li>
  293. <span class="var-type"></span>
  294. <span class="var-name">$message</span> </li>
  295. </ul>
  296. </div>
  297. </div>
  298. </div>
  299. <p class="notes" id="credit">
  300. Documentation generated on Tue, 21 Apr 2009 11:31:32 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  301. </p>
  302. </div></body>
  303. </html>