You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

3568 lines
220 KiB

10 years ago
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DotNetOpenAuth.OpenId.RelyingParty</name>
  5. </assembly>
  6. <members>
  7. <member name="T:DotNetOpenAuth.OpenId.Interop.IOpenIdRelyingParty">
  8. <summary>
  9. The COM interface describing the DotNetOpenAuth functionality available to
  10. COM client OpenID relying parties.
  11. </summary>
  12. </member>
  13. <member name="M:DotNetOpenAuth.OpenId.Interop.IOpenIdRelyingParty.CreateRequest(System.String,System.String,System.String)">
  14. <summary>
  15. Creates an authentication request to verify that a user controls
  16. some given Identifier.
  17. </summary>
  18. <param name="userSuppliedIdentifier">
  19. The Identifier supplied by the user. This may be a URL, an XRI or i-name.
  20. </param>
  21. <param name="realm">
  22. The shorest URL that describes this relying party web site's address.
  23. For example, if your login page is found at https://www.example.com/login.aspx,
  24. your realm would typically be https://www.example.com/.
  25. </param>
  26. <param name="returnToUrl">
  27. The URL of the login page, or the page prepared to receive authentication
  28. responses from the OpenID Provider.
  29. </param>
  30. <returns>
  31. An authentication request object that describes the HTTP response to
  32. send to the user agent to initiate the authentication.
  33. </returns>
  34. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if no OpenID endpoint could be found.</exception>
  35. </member>
  36. <member name="M:DotNetOpenAuth.OpenId.Interop.IOpenIdRelyingParty.CreateRequestWithSimpleRegistration(System.String,System.String,System.String,System.String,System.String)">
  37. <summary>
  38. Creates an authentication request to verify that a user controls
  39. some given Identifier.
  40. </summary>
  41. <param name="userSuppliedIdentifier">The Identifier supplied by the user. This may be a URL, an XRI or i-name.</param>
  42. <param name="realm">The shorest URL that describes this relying party web site's address.
  43. For example, if your login page is found at https://www.example.com/login.aspx,
  44. your realm would typically be https://www.example.com/.</param>
  45. <param name="returnToUrl">The URL of the login page, or the page prepared to receive authentication
  46. responses from the OpenID Provider.</param>
  47. <param name="optionalSreg">A comma-delimited list of simple registration fields to request as optional.</param>
  48. <param name="requiredSreg">A comma-delimited list of simple registration fields to request as required.</param>
  49. <returns>
  50. An authentication request object that describes the HTTP response to
  51. send to the user agent to initiate the authentication.
  52. </returns>
  53. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if no OpenID endpoint could be found.</exception>
  54. </member>
  55. <member name="M:DotNetOpenAuth.OpenId.Interop.IOpenIdRelyingParty.ProcessAuthentication(System.String,System.String)">
  56. <summary>
  57. Gets the result of a user agent's visit to his OpenId provider in an
  58. authentication attempt. Null if no response is available.
  59. </summary>
  60. <param name="url">The incoming request URL .</param>
  61. <param name="form">The form data that may have been included in the case of a POST request.</param>
  62. <returns>The Provider's response to a previous authentication request, or null if no response is present.</returns>
  63. </member>
  64. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.AXFetchAsSregTransform">
  65. <summary>
  66. An Attribute Exchange and Simple Registration filter to make all incoming attribute
  67. requests look like Simple Registration requests, and to convert the response
  68. to the originally requested extension and format.
  69. </summary>
  70. </member>
  71. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.AXFetchAsSregTransform.#ctor">
  72. <summary>
  73. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.AXFetchAsSregTransform"/> class.
  74. </summary>
  75. </member>
  76. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.AXFetchAsSregTransform.DotNetOpenAuth#OpenId#RelyingParty#IRelyingPartyBehavior#ApplySecuritySettings(DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings)">
  77. <summary>
  78. Applies a well known set of security requirements to a default set of security settings.
  79. </summary>
  80. <param name="securitySettings">The security settings to enhance with the requirements of this profile.</param>
  81. <remarks>
  82. Care should be taken to never decrease security when applying a profile.
  83. Profiles should only enhance security requirements to avoid being
  84. incompatible with each other.
  85. </remarks>
  86. </member>
  87. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.AXFetchAsSregTransform.DotNetOpenAuth#OpenId#RelyingParty#IRelyingPartyBehavior#OnOutgoingAuthenticationRequest(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest)">
  88. <summary>
  89. Called when an authentication request is about to be sent.
  90. </summary>
  91. <param name="request">The request.</param>
  92. <remarks>
  93. Implementations should be prepared to be called multiple times on the same outgoing message
  94. without malfunctioning.
  95. </remarks>
  96. </member>
  97. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.AXFetchAsSregTransform.DotNetOpenAuth#OpenId#RelyingParty#IRelyingPartyBehavior#OnIncomingPositiveAssertion(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse)">
  98. <summary>
  99. Called when an incoming positive assertion is received.
  100. </summary>
  101. <param name="assertion">The positive assertion.</param>
  102. </member>
  103. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.GsaIcamProfile">
  104. <summary>
  105. Implements the Identity, Credential, &amp; Access Management (ICAM) OpenID 2.0 Profile
  106. for the General Services Administration (GSA).
  107. </summary>
  108. <remarks>
  109. <para>Relying parties that include this profile are always held to the terms required by the profile,
  110. but Providers are only affected by the special behaviors of the profile when the RP specifically
  111. indicates that they want to use this profile. </para>
  112. </remarks>
  113. </member>
  114. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.GsaIcamProfile.#ctor">
  115. <summary>
  116. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.GsaIcamProfile"/> class.
  117. </summary>
  118. </member>
  119. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.GsaIcamProfile.DotNetOpenAuth#OpenId#RelyingParty#IRelyingPartyBehavior#ApplySecuritySettings(DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings)">
  120. <summary>
  121. Applies a well known set of security requirements.
  122. </summary>
  123. <param name="securitySettings">The security settings to enhance with the requirements of this profile.</param>
  124. <remarks>
  125. Care should be taken to never decrease security when applying a profile.
  126. Profiles should only enhance security requirements to avoid being
  127. incompatible with each other.
  128. </remarks>
  129. </member>
  130. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.GsaIcamProfile.DotNetOpenAuth#OpenId#RelyingParty#IRelyingPartyBehavior#OnOutgoingAuthenticationRequest(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest)">
  131. <summary>
  132. Called when an authentication request is about to be sent.
  133. </summary>
  134. <param name="request">The request.</param>
  135. </member>
  136. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Behaviors.GsaIcamProfile.DotNetOpenAuth#OpenId#RelyingParty#IRelyingPartyBehavior#OnIncomingPositiveAssertion(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse)">
  137. <summary>
  138. Called when an incoming positive assertion is received.
  139. </summary>
  140. <param name="assertion">The positive assertion.</param>
  141. </member>
  142. <member name="T:DotNetOpenAuth.OpenId.ChannelElements.ExtensionsBindingElementRelyingParty">
  143. <summary>
  144. The OpenID binding element responsible for reading/writing OpenID extensions
  145. at the Relying Party.
  146. </summary>
  147. </member>
  148. <member name="F:DotNetOpenAuth.OpenId.ChannelElements.ExtensionsBindingElementRelyingParty.relyingPartySecuritySettings">
  149. <summary>
  150. The security settings that apply to this relying party, if it is a relying party.
  151. </summary>
  152. </member>
  153. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.ExtensionsBindingElementRelyingParty.#ctor(DotNetOpenAuth.OpenId.ChannelElements.IOpenIdExtensionFactory,DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings)">
  154. <summary>
  155. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.ChannelElements.ExtensionsBindingElementRelyingParty"/> class.
  156. </summary>
  157. <param name="extensionFactory">The extension factory.</param>
  158. <param name="securitySettings">The security settings.</param>
  159. </member>
  160. <member name="T:DotNetOpenAuth.OpenId.ChannelElements.OpenIdRelyingPartyChannel">
  161. <summary>
  162. The messaging channel for OpenID relying parties.
  163. </summary>
  164. </member>
  165. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.OpenIdRelyingPartyChannel.#ctor(DotNetOpenAuth.Messaging.Bindings.ICryptoKeyStore,DotNetOpenAuth.Messaging.Bindings.INonceStore,DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings)">
  166. <summary>
  167. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.ChannelElements.OpenIdRelyingPartyChannel"/> class.
  168. </summary>
  169. <param name="cryptoKeyStore">The association store to use.</param>
  170. <param name="nonceStore">The nonce store to use.</param>
  171. <param name="securitySettings">The security settings to apply.</param>
  172. </member>
  173. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.OpenIdRelyingPartyChannel.#ctor(DotNetOpenAuth.Messaging.Bindings.ICryptoKeyStore,DotNetOpenAuth.Messaging.Bindings.INonceStore,DotNetOpenAuth.Messaging.IMessageFactory,DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings,System.Boolean)">
  174. <summary>
  175. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.ChannelElements.OpenIdRelyingPartyChannel"/> class.
  176. </summary>
  177. <param name="cryptoKeyStore">The association store to use.</param>
  178. <param name="nonceStore">The nonce store to use.</param>
  179. <param name="messageTypeProvider">An object that knows how to distinguish the various OpenID message types for deserialization purposes.</param>
  180. <param name="securitySettings">The security settings to apply.</param>
  181. <param name="nonVerifying">A value indicating whether the channel is set up with no functional security binding elements.</param>
  182. </member>
  183. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.OpenIdRelyingPartyChannel.CreateNonVerifyingChannel">
  184. <summary>
  185. A value indicating whether the channel is set up
  186. with no functional security binding elements.
  187. </summary>
  188. <returns>A new <see cref="T:DotNetOpenAuth.OpenId.ChannelElements.OpenIdChannel"/> instance that will not perform verification on incoming messages or apply any security to outgoing messages.</returns>
  189. <remarks>
  190. <para>A value of <c>true</c> allows the relying party to preview incoming
  191. messages without invalidating nonces or checking signatures.</para>
  192. <para>Setting this to <c>true</c> poses a great security risk and is only
  193. present to support the OpenIdAjaxTextBox which needs to preview
  194. messages, and will validate them later.</para>
  195. </remarks>
  196. </member>
  197. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.OpenIdRelyingPartyChannel.InitializeBindingElements(DotNetOpenAuth.Messaging.Bindings.ICryptoKeyStore,DotNetOpenAuth.Messaging.Bindings.INonceStore,DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings,System.Boolean)">
  198. <summary>
  199. Initializes the binding elements.
  200. </summary>
  201. <param name="cryptoKeyStore">The crypto key store.</param>
  202. <param name="nonceStore">The nonce store to use.</param>
  203. <param name="securitySettings">The security settings to apply. Must be an instance of either <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings"/> or ProviderSecuritySettings.</param>
  204. <param name="nonVerifying">A value indicating whether the channel is set up with no functional security binding elements.</param>
  205. <returns>
  206. An array of binding elements which may be used to construct the channel.
  207. </returns>
  208. </member>
  209. <member name="T:DotNetOpenAuth.OpenId.ChannelElements.OpenIdRelyingPartyMessageFactory">
  210. <summary>
  211. Message factory for OpenID Relying Parties.
  212. </summary>
  213. </member>
  214. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.OpenIdRelyingPartyMessageFactory.GetNewRequestMessage(DotNetOpenAuth.Messaging.MessageReceivingEndpoint,System.Collections.Generic.IDictionary{System.String,System.String})">
  215. <summary>
  216. Analyzes an incoming request message payload to discover what kind of
  217. message is embedded in it and returns the type, or null if no match is found.
  218. </summary>
  219. <param name="recipient">The intended or actual recipient of the request message.</param>
  220. <param name="fields">The name/value pairs that make up the message payload.</param>
  221. <returns>
  222. A newly instantiated <see cref="T:DotNetOpenAuth.Messaging.IProtocolMessage"/>-derived object that this message can
  223. deserialize to. Null if the request isn't recognized as a valid protocol message.
  224. </returns>
  225. </member>
  226. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.OpenIdRelyingPartyMessageFactory.GetNewResponseMessage(DotNetOpenAuth.Messaging.IDirectedProtocolMessage,System.Collections.Generic.IDictionary{System.String,System.String})">
  227. <summary>
  228. Analyzes an incoming request message payload to discover what kind of
  229. message is embedded in it and returns the type, or null if no match is found.
  230. </summary>
  231. <param name="request">The message that was sent as a request that resulted in the response.</param>
  232. <param name="fields">The name/value pairs that make up the message payload.</param>
  233. <returns>
  234. A newly instantiated <see cref="T:DotNetOpenAuth.Messaging.IProtocolMessage"/>-derived object that this message can
  235. deserialize to. Null if the request isn't recognized as a valid protocol message.
  236. </returns>
  237. </member>
  238. <member name="T:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySecurityOptions">
  239. <summary>
  240. Helps ensure compliance to some properties in the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings"/>.
  241. </summary>
  242. </member>
  243. <member name="F:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySecurityOptions.securitySettings">
  244. <summary>
  245. The security settings that are active on the relying party.
  246. </summary>
  247. </member>
  248. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySecurityOptions.#ctor(DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings)">
  249. <summary>
  250. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySecurityOptions"/> class.
  251. </summary>
  252. <param name="securitySettings">The security settings.</param>
  253. </member>
  254. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySecurityOptions.ProcessOutgoingMessage(DotNetOpenAuth.Messaging.IProtocolMessage)">
  255. <summary>
  256. Prepares a message for sending based on the rules of this channel binding element.
  257. </summary>
  258. <param name="message">The message to prepare for sending.</param>
  259. <returns>
  260. The protections (if any) that this binding element applied to the message.
  261. Null if this binding element did not even apply to this binding element.
  262. </returns>
  263. <remarks>
  264. Implementations that provide message protection must honor the
  265. <see cref="P:DotNetOpenAuth.Messaging.MessagePartAttribute.RequiredProtection"/> properties where applicable.
  266. </remarks>
  267. </member>
  268. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySecurityOptions.ProcessIncomingMessage(DotNetOpenAuth.Messaging.IProtocolMessage)">
  269. <summary>
  270. Performs any transformation on an incoming message that may be necessary and/or
  271. validates an incoming message based on the rules of this channel binding element.
  272. </summary>
  273. <param name="message">The incoming message to process.</param>
  274. <returns>
  275. The protections (if any) that this binding element applied to the message.
  276. Null if this binding element did not even apply to this binding element.
  277. </returns>
  278. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">
  279. Thrown when the binding element rules indicate that this message is invalid and should
  280. NOT be processed.
  281. </exception>
  282. <remarks>
  283. Implementations that provide message protection must honor the
  284. <see cref="P:DotNetOpenAuth.Messaging.MessagePartAttribute.RequiredProtection"/> properties where applicable.
  285. </remarks>
  286. </member>
  287. <member name="P:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySecurityOptions.Channel">
  288. <summary>
  289. Gets or sets the channel that this binding element belongs to.
  290. </summary>
  291. <remarks>
  292. This property is set by the channel when it is first constructed.
  293. </remarks>
  294. </member>
  295. <member name="P:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySecurityOptions.Protection">
  296. <summary>
  297. Gets the protection commonly offered (if any) by this binding element.
  298. </summary>
  299. <remarks>
  300. This value is used to assist in sorting binding elements in the channel stack.
  301. </remarks>
  302. </member>
  303. <member name="T:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySigningBindingElement">
  304. <summary>
  305. The signing binding element for OpenID Relying Parties.
  306. </summary>
  307. </member>
  308. <member name="F:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySigningBindingElement.rpAssociations">
  309. <summary>
  310. The association store used by Relying Parties to look up the secrets needed for signing.
  311. </summary>
  312. </member>
  313. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySigningBindingElement.#ctor(DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStore)">
  314. <summary>
  315. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySigningBindingElement"/> class.
  316. </summary>
  317. <param name="associationStore">The association store used to look up the secrets needed for signing. May be null for dumb Relying Parties.</param>
  318. </member>
  319. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySigningBindingElement.GetSpecificAssociation(DotNetOpenAuth.OpenId.ChannelElements.ITamperResistantOpenIdMessage)">
  320. <summary>
  321. Gets a specific association referenced in a given message's association handle.
  322. </summary>
  323. <param name="signedMessage">The signed message whose association handle should be used to lookup the association to return.</param>
  324. <returns>
  325. The referenced association; or <c>null</c> if such an association cannot be found.
  326. </returns>
  327. </member>
  328. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySigningBindingElement.GetAssociation(DotNetOpenAuth.OpenId.ChannelElements.ITamperResistantOpenIdMessage)">
  329. <summary>
  330. Gets the association to use to sign or verify a message.
  331. </summary>
  332. <param name="signedMessage">The message to sign or verify.</param>
  333. <returns>
  334. The association to use to sign or verify the message.
  335. </returns>
  336. </member>
  337. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.RelyingPartySigningBindingElement.VerifySignatureByUnrecognizedHandle(DotNetOpenAuth.Messaging.IProtocolMessage,DotNetOpenAuth.OpenId.ChannelElements.ITamperResistantOpenIdMessage,DotNetOpenAuth.Messaging.MessageProtections)">
  338. <summary>
  339. Verifies the signature by unrecognized handle.
  340. </summary>
  341. <param name="message">The message.</param>
  342. <param name="signedMessage">The signed message.</param>
  343. <param name="protectionsApplied">The protections applied.</param>
  344. <returns>
  345. The applied protections.
  346. </returns>
  347. </member>
  348. <member name="T:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement">
  349. <summary>
  350. This binding element adds a nonce to a Relying Party's outgoing
  351. authentication request when working against an OpenID 1.0 Provider
  352. in order to protect against replay attacks or on all authentication
  353. requests to distinguish solicited from unsolicited assertions.
  354. </summary>
  355. <remarks>
  356. <para>This nonce goes beyond the OpenID 1.x spec, but adds to security.
  357. Since this library's Provider implementation also provides special nonce
  358. protection for 1.0 messages, this security feature overlaps with that one.
  359. This means that if an RP from this library were talking to an OP from this
  360. library, but the Identifier being authenticated advertised the OP as a 1.x
  361. OP, then both RP and OP might try to use a nonce for protecting the assertion.
  362. There's no problem with that--it will still all work out. And it would be a
  363. very rare combination of elements anyway.
  364. </para>
  365. <para>
  366. This binding element deactivates itself for OpenID 2.0 (or later) messages
  367. since they are automatically protected in the protocol by the Provider's
  368. openid.response_nonce parameter. The exception to this is when
  369. <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings.RejectUnsolicitedAssertions"/> is
  370. set to <c>true</c>, which will not only add a request nonce to every outgoing
  371. authentication request but also require that it be present in positive
  372. assertions, effectively disabling unsolicited assertions.
  373. </para>
  374. <para>In the messaging stack, this binding element looks like an ordinary
  375. transform-type of binding element rather than a protection element,
  376. due to its required order in the channel stack and that it exists
  377. only on the RP side and only on some messages.</para>
  378. </remarks>
  379. </member>
  380. <member name="F:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.ReturnToNonceContext">
  381. <summary>
  382. The context within which return_to nonces must be unique -- they all go into the same bucket.
  383. </summary>
  384. </member>
  385. <member name="F:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.NonceByteLength">
  386. <summary>
  387. The length of the generated nonce's random part.
  388. </summary>
  389. </member>
  390. <member name="F:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.nonceStore">
  391. <summary>
  392. The nonce store that will allow us to recall which nonces we've seen before.
  393. </summary>
  394. </member>
  395. <member name="F:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.securitySettings">
  396. <summary>
  397. The security settings at the RP.
  398. </summary>
  399. </member>
  400. <member name="F:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.channel">
  401. <summary>
  402. Backing field for the <see cref="P:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.Channel"/> property.
  403. </summary>
  404. </member>
  405. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.#ctor(DotNetOpenAuth.Messaging.Bindings.INonceStore,DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings)">
  406. <summary>
  407. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement"/> class.
  408. </summary>
  409. <param name="nonceStore">The nonce store to use.</param>
  410. <param name="securitySettings">The security settings of the RP.</param>
  411. </member>
  412. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.ProcessOutgoingMessage(DotNetOpenAuth.Messaging.IProtocolMessage)">
  413. <summary>
  414. Prepares a message for sending based on the rules of this channel binding element.
  415. </summary>
  416. <param name="message">The message to prepare for sending.</param>
  417. <returns>
  418. The protections (if any) that this binding element applied to the message.
  419. Null if this binding element did not even apply to this binding element.
  420. </returns>
  421. <remarks>
  422. Implementations that provide message protection must honor the
  423. <see cref="P:DotNetOpenAuth.Messaging.MessagePartAttribute.RequiredProtection"/> properties where applicable.
  424. </remarks>
  425. </member>
  426. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.ProcessIncomingMessage(DotNetOpenAuth.Messaging.IProtocolMessage)">
  427. <summary>
  428. Performs any transformation on an incoming message that may be necessary and/or
  429. validates an incoming message based on the rules of this channel binding element.
  430. </summary>
  431. <param name="message">The incoming message to process.</param>
  432. <returns>
  433. The protections (if any) that this binding element applied to the message.
  434. Null if this binding element did not even apply to this binding element.
  435. </returns>
  436. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">
  437. Thrown when the binding element rules indicate that this message is invalid and should
  438. NOT be processed.
  439. </exception>
  440. <remarks>
  441. Implementations that provide message protection must honor the
  442. <see cref="P:DotNetOpenAuth.Messaging.MessagePartAttribute.RequiredProtection"/> properties where applicable.
  443. </remarks>
  444. </member>
  445. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.UseRequestNonce(DotNetOpenAuth.Messaging.IMessage)">
  446. <summary>
  447. Determines whether a request nonce should be applied the request
  448. or should be expected in the response.
  449. </summary>
  450. <param name="message">The authentication request or the positive assertion response.</param>
  451. <returns>
  452. <c>true</c> if the message exchanged with an OpenID 1.x provider
  453. or if unsolicited assertions should be rejected at the RP; otherwise <c>false</c>.
  454. </returns>
  455. </member>
  456. <member name="P:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.Channel">
  457. <summary>
  458. Gets or sets the channel that this binding element belongs to.
  459. </summary>
  460. <remarks>
  461. This property is set by the channel when it is first constructed.
  462. </remarks>
  463. </member>
  464. <member name="P:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.Protection">
  465. <summary>
  466. Gets the protection offered (if any) by this binding element.
  467. </summary>
  468. </member>
  469. <member name="P:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.MaximumMessageAge">
  470. <summary>
  471. Gets the maximum message age from the standard expiration binding element.
  472. </summary>
  473. </member>
  474. <member name="T:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.CustomNonce">
  475. <summary>
  476. A special DotNetOpenAuth-only nonce used by the RP when talking to 1.0 OPs in order
  477. to protect against replay attacks.
  478. </summary>
  479. </member>
  480. <member name="F:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.CustomNonce.randomPart">
  481. <summary>
  482. The random bits generated for the nonce.
  483. </summary>
  484. </member>
  485. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.CustomNonce.#ctor(System.DateTime,System.Byte[])">
  486. <summary>
  487. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.CustomNonce"/> class.
  488. </summary>
  489. <param name="creationDate">The creation date of the nonce.</param>
  490. <param name="randomPart">The random bits that help make the nonce unique.</param>
  491. </member>
  492. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.CustomNonce.NewNonce">
  493. <summary>
  494. Creates a new nonce.
  495. </summary>
  496. <returns>The newly instantiated instance.</returns>
  497. </member>
  498. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.CustomNonce.Deserialize(System.String)">
  499. <summary>
  500. Deserializes a nonce from the return_to parameter.
  501. </summary>
  502. <param name="value">The base64-encoded value of the nonce.</param>
  503. <returns>The instantiated and initialized nonce.</returns>
  504. </member>
  505. <member name="M:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.CustomNonce.Serialize">
  506. <summary>
  507. Serializes the entire nonce for adding to the return_to URL.
  508. </summary>
  509. <returns>The base64-encoded string representing the nonce.</returns>
  510. </member>
  511. <member name="P:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.CustomNonce.CreationDateUtc">
  512. <summary>
  513. Gets the creation date.
  514. </summary>
  515. </member>
  516. <member name="P:DotNetOpenAuth.OpenId.ChannelElements.ReturnToNonceBindingElement.CustomNonce.RandomPartAsString">
  517. <summary>
  518. Gets the random part of the nonce as a base64 encoded string.
  519. </summary>
  520. </member>
  521. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.Extensions.ExtensionsInteropHelper">
  522. <summary>
  523. A set of methods designed to assist in improving interop across different
  524. OpenID implementations and their extensions.
  525. </summary>
  526. </member>
  527. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Extensions.ExtensionsInteropHelper.SpreadSregToAX(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest,DotNetOpenAuth.OpenId.Extensions.AttributeExchange.AXAttributeFormats)">
  528. <summary>
  529. Adds an Attribute Exchange (AX) extension to the authentication request
  530. that asks for the same attributes as the Simple Registration (sreg) extension
  531. that is already applied.
  532. </summary>
  533. <param name="request">The authentication request.</param>
  534. <param name="attributeFormats">The attribute formats to use in the AX request.</param>
  535. <remarks>
  536. <para>If discovery on the user-supplied identifier yields hints regarding which
  537. extensions and attribute formats the Provider supports, this method MAY ignore the
  538. <paramref name="attributeFormats"/> argument and accomodate the Provider to minimize
  539. the size of the request.</para>
  540. <para>If the request does not carry an sreg extension, the method logs a warning but
  541. otherwise quietly returns doing nothing.</para>
  542. </remarks>
  543. </member>
  544. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Extensions.ExtensionsInteropHelper.UnifyExtensionsAsSreg(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse,System.Boolean)">
  545. <summary>
  546. Looks for Simple Registration and Attribute Exchange (all known formats)
  547. response extensions and returns them as a Simple Registration extension.
  548. </summary>
  549. <param name="response">The authentication response.</param>
  550. <param name="allowUnsigned">if set to <c>true</c> unsigned extensions will be included in the search.</param>
  551. <returns>
  552. The Simple Registration response if found,
  553. or a fabricated one based on the Attribute Exchange extension if found,
  554. or just an empty <see cref="T:DotNetOpenAuth.OpenId.Extensions.SimpleRegistration.ClaimsResponse"/> if there was no data.
  555. Never <c>null</c>.</returns>
  556. </member>
  557. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Extensions.ExtensionsInteropHelper.GetAttributeValue(DotNetOpenAuth.OpenId.Extensions.AttributeExchange.FetchResponse,System.String,DotNetOpenAuth.OpenId.Extensions.AttributeExchange.AXAttributeFormats)">
  558. <summary>
  559. Gets the attribute value if available.
  560. </summary>
  561. <param name="fetchResponse">The AX fetch response extension to look for the attribute value.</param>
  562. <param name="typeUri">The type URI of the attribute, using the axschema.org format of <see cref="T:DotNetOpenAuth.OpenId.Extensions.AttributeExchange.WellKnownAttributes"/>.</param>
  563. <param name="formats">The AX type URI formats to search.</param>
  564. <returns>
  565. The first value of the attribute, if available.
  566. </returns>
  567. </member>
  568. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Extensions.ExtensionsInteropHelper.TryDetectOPAttributeFormat(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest,DotNetOpenAuth.OpenId.Extensions.AttributeExchange.AXAttributeFormats@)">
  569. <summary>
  570. Tries to find the exact format of AX attribute Type URI supported by the Provider.
  571. </summary>
  572. <param name="request">The authentication request.</param>
  573. <param name="attributeFormat">The attribute formats the RP will try if this discovery fails.</param>
  574. <returns>The AX format(s) to use based on the Provider's advertised AX support.</returns>
  575. </member>
  576. <member name="T:DotNetOpenAuth.OpenId.HostMetaDiscoveryService">
  577. <summary>
  578. The discovery service to support host-meta based discovery, such as Google Apps for Domains.
  579. </summary>
  580. <remarks>
  581. The spec for this discovery mechanism can be found at:
  582. http://groups.google.com/group/google-federated-login-api/web/openid-discovery-for-hosted-domains
  583. and the XMLDSig spec referenced in that spec can be found at:
  584. http://wiki.oasis-open.org/xri/XrdOne/XmlDsigProfile
  585. </remarks>
  586. </member>
  587. <member name="F:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.LocalHostMetaPath">
  588. <summary>
  589. Path to the well-known location of the host-meta document at a domain.
  590. </summary>
  591. </member>
  592. <member name="F:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.GoogleHostedHostMeta">
  593. <summary>
  594. The URI template for discovery host-meta on domains hosted by
  595. Google Apps for Domains.
  596. </summary>
  597. </member>
  598. <member name="F:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.HostMetaLink">
  599. <summary>
  600. The pattern within a host-meta file to look for to obtain the URI to the XRDS document.
  601. </summary>
  602. </member>
  603. <member name="F:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.ApprovedCertificateThumbprintCache">
  604. <summary>
  605. A set of certificate thumbprints that have been verified.
  606. </summary>
  607. </member>
  608. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.#ctor">
  609. <summary>
  610. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.HostMetaDiscoveryService"/> class.
  611. </summary>
  612. </member>
  613. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.Discover(DotNetOpenAuth.OpenId.Identifier,DotNetOpenAuth.Messaging.IDirectWebRequestHandler,System.Boolean@)">
  614. <summary>
  615. Performs discovery on the specified identifier.
  616. </summary>
  617. <param name="identifier">The identifier to perform discovery on.</param>
  618. <param name="requestHandler">The means to place outgoing HTTP requests.</param>
  619. <param name="abortDiscoveryChain">if set to <c>true</c>, no further discovery services will be called for this identifier.</param>
  620. <returns>
  621. A sequence of service endpoints yielded by discovery. Must not be null, but may be empty.
  622. </returns>
  623. </member>
  624. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.GetXrdElements(DotNetOpenAuth.Xrds.XrdsDocument,System.String)">
  625. <summary>
  626. Gets the XRD elements that have a given CanonicalID.
  627. </summary>
  628. <param name="document">The XRDS document.</param>
  629. <param name="canonicalId">The CanonicalID to match on.</param>
  630. <returns>A sequence of XRD elements.</returns>
  631. </member>
  632. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.GetDescribedByServices(System.Collections.Generic.IEnumerable{DotNetOpenAuth.Xrds.XrdElement})">
  633. <summary>
  634. Gets the described-by services in XRD elements.
  635. </summary>
  636. <param name="xrds">The XRDs to search.</param>
  637. <returns>A sequence of services.</returns>
  638. </member>
  639. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.GetExternalServices(System.Collections.Generic.IEnumerable{DotNetOpenAuth.Xrds.XrdElement},DotNetOpenAuth.OpenId.UriIdentifier,DotNetOpenAuth.Messaging.IDirectWebRequestHandler)">
  640. <summary>
  641. Gets the services for an identifier that are described by an external XRDS document.
  642. </summary>
  643. <param name="xrds">The XRD elements to search for described-by services.</param>
  644. <param name="identifier">The identifier under discovery.</param>
  645. <param name="requestHandler">The request handler.</param>
  646. <returns>The discovered services.</returns>
  647. </member>
  648. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.ValidateXmlDSig(DotNetOpenAuth.Xrds.XrdsDocument,DotNetOpenAuth.OpenId.UriIdentifier,DotNetOpenAuth.Messaging.IncomingWebResponse,System.String)">
  649. <summary>
  650. Validates the XML digital signature on an XRDS document.
  651. </summary>
  652. <param name="document">The XRDS document whose signature should be validated.</param>
  653. <param name="identifier">The identifier under discovery.</param>
  654. <param name="response">The response.</param>
  655. <param name="signingHost">The host name on the certificate that should be used to verify the signature in the XRDS.</param>
  656. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if the XRDS document has an invalid or a missing signature.</exception>
  657. </member>
  658. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.VerifyCertChain(System.Collections.Generic.IEnumerable{System.Security.Cryptography.X509Certificates.X509Certificate2})">
  659. <summary>
  660. Verifies the cert chain.
  661. </summary>
  662. <param name="certs">The certs.</param>
  663. <remarks>
  664. This must be in a method of its own because there is a LinkDemand on the <see cref="M:System.Security.Cryptography.X509Certificates.X509Chain.Build(System.Security.Cryptography.X509Certificates.X509Certificate2)"/>
  665. method. By being in a method of its own, the caller of this method may catch a
  666. <see cref="T:System.Security.SecurityException"/> that is thrown if we're not running with full trust and execute
  667. an alternative plan.
  668. </remarks>
  669. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if the certificate chain is invalid or unverifiable.</exception>
  670. </member>
  671. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.GetXrdsResponse(DotNetOpenAuth.OpenId.UriIdentifier,DotNetOpenAuth.Messaging.IDirectWebRequestHandler,System.Uri)">
  672. <summary>
  673. Gets the XRDS HTTP response for a given identifier.
  674. </summary>
  675. <param name="identifier">The identifier.</param>
  676. <param name="requestHandler">The request handler.</param>
  677. <param name="xrdsLocation">The location of the XRDS document to retrieve.</param>
  678. <returns>
  679. A HTTP response carrying an XRDS document.
  680. </returns>
  681. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if the XRDS document could not be obtained.</exception>
  682. </member>
  683. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.VerifyCertificateChain(System.Collections.Generic.IList{System.Security.Cryptography.X509Certificates.X509Certificate2})">
  684. <summary>
  685. Verifies that a certificate chain is trusted.
  686. </summary>
  687. <param name="certificates">The chain of certificates to verify.</param>
  688. </member>
  689. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.GetXrdsResponse(DotNetOpenAuth.OpenId.UriIdentifier,DotNetOpenAuth.Messaging.IDirectWebRequestHandler,System.String@)">
  690. <summary>
  691. Gets the XRDS HTTP response for a given identifier.
  692. </summary>
  693. <param name="identifier">The identifier.</param>
  694. <param name="requestHandler">The request handler.</param>
  695. <param name="signingHost">The host name on the certificate that should be used to verify the signature in the XRDS.</param>
  696. <returns>A HTTP response carrying an XRDS document, or <c>null</c> if one could not be obtained.</returns>
  697. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if the XRDS document could not be obtained.</exception>
  698. </member>
  699. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.GetXrdsLocation(DotNetOpenAuth.OpenId.UriIdentifier,DotNetOpenAuth.Messaging.IDirectWebRequestHandler,System.String@)">
  700. <summary>
  701. Gets the location of the XRDS document that describes a given identifier.
  702. </summary>
  703. <param name="identifier">The identifier under discovery.</param>
  704. <param name="requestHandler">The request handler.</param>
  705. <param name="signingHost">The host name on the certificate that should be used to verify the signature in the XRDS.</param>
  706. <returns>An absolute URI, or <c>null</c> if one could not be determined.</returns>
  707. </member>
  708. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.GetHostMeta(DotNetOpenAuth.OpenId.UriIdentifier,DotNetOpenAuth.Messaging.IDirectWebRequestHandler,System.String@)">
  709. <summary>
  710. Gets the host-meta for a given identifier.
  711. </summary>
  712. <param name="identifier">The identifier.</param>
  713. <param name="requestHandler">The request handler.</param>
  714. <param name="signingHost">The host name on the certificate that should be used to verify the signature in the XRDS.</param>
  715. <returns>
  716. The host-meta response, or <c>null</c> if no host-meta document could be obtained.
  717. </returns>
  718. </member>
  719. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.GetHostMetaLocations(DotNetOpenAuth.OpenId.UriIdentifier)">
  720. <summary>
  721. Gets the URIs authorized to host host-meta documents on behalf of a given domain.
  722. </summary>
  723. <param name="identifier">The identifier.</param>
  724. <returns>A sequence of URIs that MAY provide the host-meta for a given identifier.</returns>
  725. </member>
  726. <member name="P:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.TrustedHostMetaProxies">
  727. <summary>
  728. Gets the set of URI templates to use to contact host-meta hosting proxies
  729. for domain discovery.
  730. </summary>
  731. </member>
  732. <member name="P:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.UseGoogleHostedHostMeta">
  733. <summary>
  734. Gets or sets a value indicating whether to trust Google to host domains' host-meta documents.
  735. </summary>
  736. <remarks>
  737. This property is just a convenient mechanism for checking or changing the set of
  738. trusted host-meta proxies in the <see cref="P:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.TrustedHostMetaProxies"/> property.
  739. </remarks>
  740. </member>
  741. <member name="T:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.HostMetaProxy">
  742. <summary>
  743. A description of a web server that hosts host-meta documents.
  744. </summary>
  745. </member>
  746. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.HostMetaProxy.#ctor(System.String,System.String)">
  747. <summary>
  748. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.HostMetaProxy"/> class.
  749. </summary>
  750. <param name="proxyFormat">The proxy formatting string.</param>
  751. <param name="signingHostFormat">The signing host formatting string.</param>
  752. </member>
  753. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.HostMetaProxy.GetProxy(DotNetOpenAuth.OpenId.UriIdentifier)">
  754. <summary>
  755. Gets the absolute proxy URI.
  756. </summary>
  757. <param name="identifier">The identifier being discovered.</param>
  758. <returns>The an absolute URI.</returns>
  759. </member>
  760. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.HostMetaProxy.GetSigningHost(DotNetOpenAuth.OpenId.UriIdentifier)">
  761. <summary>
  762. Gets the signing host URI.
  763. </summary>
  764. <param name="identifier">The identifier being discovered.</param>
  765. <returns>A host name.</returns>
  766. </member>
  767. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.HostMetaProxy.Equals(System.Object)">
  768. <summary>
  769. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  770. </summary>
  771. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  772. <returns>
  773. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  774. </returns>
  775. <exception cref="T:System.NullReferenceException">
  776. The <paramref name="obj"/> parameter is null.
  777. </exception>
  778. </member>
  779. <member name="M:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.HostMetaProxy.GetHashCode">
  780. <summary>
  781. Serves as a hash function for a particular type.
  782. </summary>
  783. <returns>
  784. A hash code for the current <see cref="T:System.Object"/>.
  785. </returns>
  786. </member>
  787. <member name="P:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.HostMetaProxy.ProxyFormat">
  788. <summary>
  789. Gets the URL of the host-meta proxy.
  790. </summary>
  791. <value>The absolute proxy URL, which may include {0} to be replaced with the host of the identifier to be discovered.</value>
  792. </member>
  793. <member name="P:DotNetOpenAuth.OpenId.HostMetaDiscoveryService.HostMetaProxy.SigningHostFormat">
  794. <summary>
  795. Gets the formatting string to determine the expected host name on the certificate
  796. that is expected to be used to sign the XRDS document.
  797. </summary>
  798. <value>
  799. Either a string literal, or a formatting string where these placeholders may exist:
  800. {0} the host on the identifier discovery was originally performed on;
  801. {1} the host on this proxy.
  802. </value>
  803. </member>
  804. <member name="T:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim">
  805. <summary>
  806. The COM type used to provide details of an authentication result to a relying party COM client.
  807. </summary>
  808. </member>
  809. <member name="F:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.response">
  810. <summary>
  811. The response read in by the Relying Party.
  812. </summary>
  813. </member>
  814. <member name="M:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.#ctor(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse)">
  815. <summary>
  816. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim"/> class.
  817. </summary>
  818. <param name="response">The response.</param>
  819. </member>
  820. <member name="P:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.ClaimedIdentifier">
  821. <summary>
  822. Gets an Identifier that the end user claims to own. For use with user database storage and lookup.
  823. May be null for some failed authentications (i.e. failed directed identity authentications).
  824. </summary>
  825. <remarks>
  826. <para>
  827. This is the secure identifier that should be used for database storage and lookup.
  828. It is not always friendly (i.e. =Arnott becomes =!9B72.7DD1.50A9.5CCD), but it protects
  829. user identities against spoofing and other attacks.
  830. </para>
  831. <para>
  832. For user-friendly identifiers to display, use the
  833. <see cref="P:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.FriendlyIdentifierForDisplay"/> property.
  834. </para>
  835. </remarks>
  836. </member>
  837. <member name="P:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.FriendlyIdentifierForDisplay">
  838. <summary>
  839. Gets a user-friendly OpenID Identifier for display purposes ONLY.
  840. </summary>
  841. <remarks>
  842. <para>
  843. This <i>should</i> be put through <see cref="M:System.Web.HttpUtility.HtmlEncode(System.String)"/> before
  844. sending to a browser to secure against javascript injection attacks.
  845. </para>
  846. <para>
  847. This property retains some aspects of the user-supplied identifier that get lost
  848. in the <see cref="P:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.ClaimedIdentifier"/>. For example, XRIs used as user-supplied
  849. identifiers (i.e. =Arnott) become unfriendly unique strings (i.e. =!9B72.7DD1.50A9.5CCD).
  850. For display purposes, such as text on a web page that says "You're logged in as ...",
  851. this property serves to provide the =Arnott string, or whatever else is the most friendly
  852. string close to what the user originally typed in.
  853. </para>
  854. <para>
  855. If the user-supplied identifier is a URI, this property will be the URI after all
  856. redirects, and with the protocol and fragment trimmed off.
  857. If the user-supplied identifier is an XRI, this property will be the original XRI.
  858. If the user-supplied identifier is an OpenID Provider identifier (i.e. yahoo.com),
  859. this property will be the Claimed Identifier, with the protocol stripped if it is a URI.
  860. </para>
  861. <para>
  862. It is <b>very</b> important that this property <i>never</i> be used for database storage
  863. or lookup to avoid identity spoofing and other security risks. For database storage
  864. and lookup please use the <see cref="P:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.ClaimedIdentifier"/> property.
  865. </para>
  866. </remarks>
  867. </member>
  868. <member name="P:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.ProviderEndpoint">
  869. <summary>
  870. Gets the provider endpoint that sent the assertion.
  871. </summary>
  872. </member>
  873. <member name="P:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.Successful">
  874. <summary>
  875. Gets a value indicating whether the authentication attempt succeeded.
  876. </summary>
  877. </member>
  878. <member name="P:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.ClaimsResponse">
  879. <summary>
  880. Gets the Simple Registration response.
  881. </summary>
  882. </member>
  883. <member name="P:DotNetOpenAuth.OpenId.Interop.AuthenticationResponseShim.ExceptionMessage">
  884. <summary>
  885. Gets details regarding a failed authentication attempt, if available.
  886. </summary>
  887. </member>
  888. <member name="T:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim">
  889. <summary>
  890. A struct storing Simple Registration field values describing an
  891. authenticating user.
  892. </summary>
  893. </member>
  894. <member name="F:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.response">
  895. <summary>
  896. The Simple Registration claims response message that this shim wraps.
  897. </summary>
  898. </member>
  899. <member name="M:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.#ctor(DotNetOpenAuth.OpenId.Extensions.SimpleRegistration.ClaimsResponse)">
  900. <summary>
  901. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim"/> class.
  902. </summary>
  903. <param name="response">The Simple Registration response to wrap.</param>
  904. </member>
  905. <member name="P:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.Nickname">
  906. <summary>
  907. Gets the nickname the user goes by.
  908. </summary>
  909. </member>
  910. <member name="P:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.Email">
  911. <summary>
  912. Gets the user's email address.
  913. </summary>
  914. </member>
  915. <member name="P:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.FullName">
  916. <summary>
  917. Gets the full name of a user as a single string.
  918. </summary>
  919. </member>
  920. <member name="P:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.BirthDate">
  921. <summary>
  922. Gets the raw birth date string given by the extension.
  923. </summary>
  924. <value>A string in the format yyyy-MM-dd.</value>
  925. </member>
  926. <member name="P:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.Gender">
  927. <summary>
  928. Gets the gender of the user.
  929. </summary>
  930. </member>
  931. <member name="P:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.PostalCode">
  932. <summary>
  933. Gets the zip code / postal code of the user.
  934. </summary>
  935. </member>
  936. <member name="P:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.Country">
  937. <summary>
  938. Gets the country of the user.
  939. </summary>
  940. </member>
  941. <member name="P:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.Language">
  942. <summary>
  943. Gets the primary/preferred language of the user.
  944. </summary>
  945. </member>
  946. <member name="P:DotNetOpenAuth.OpenId.Interop.ClaimsResponseShim.TimeZone">
  947. <summary>
  948. Gets the user's timezone.
  949. </summary>
  950. </member>
  951. <member name="T:DotNetOpenAuth.OpenId.Interop.OpenIdRelyingPartyShim">
  952. <summary>
  953. Implementation of <see cref="T:DotNetOpenAuth.OpenId.Interop.IOpenIdRelyingParty"/>, providing a subset of the
  954. functionality available to .NET clients.
  955. </summary>
  956. </member>
  957. <member name="F:DotNetOpenAuth.OpenId.Interop.OpenIdRelyingPartyShim.relyingParty">
  958. <summary>
  959. The OpenIdRelyingParty instance to use for requests.
  960. </summary>
  961. </member>
  962. <member name="M:DotNetOpenAuth.OpenId.Interop.OpenIdRelyingPartyShim.#cctor">
  963. <summary>
  964. Initializes static members of the <see cref="T:DotNetOpenAuth.OpenId.Interop.OpenIdRelyingPartyShim"/> class.
  965. </summary>
  966. </member>
  967. <member name="M:DotNetOpenAuth.OpenId.Interop.OpenIdRelyingPartyShim.#ctor">
  968. <summary>
  969. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.Interop.OpenIdRelyingPartyShim"/> class.
  970. </summary>
  971. </member>
  972. <member name="M:DotNetOpenAuth.OpenId.Interop.OpenIdRelyingPartyShim.CreateRequest(System.String,System.String,System.String)">
  973. <summary>
  974. Creates an authentication request to verify that a user controls
  975. some given Identifier.
  976. </summary>
  977. <param name="userSuppliedIdentifier">
  978. The Identifier supplied by the user. This may be a URL, an XRI or i-name.
  979. </param>
  980. <param name="realm">
  981. The shorest URL that describes this relying party web site's address.
  982. For example, if your login page is found at https://www.example.com/login.aspx,
  983. your realm would typically be https://www.example.com/.
  984. </param>
  985. <param name="returnToUrl">
  986. The URL of the login page, or the page prepared to receive authentication
  987. responses from the OpenID Provider.
  988. </param>
  989. <returns>
  990. An authentication request object that describes the HTTP response to
  991. send to the user agent to initiate the authentication.
  992. </returns>
  993. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if no OpenID endpoint could be found.</exception>
  994. </member>
  995. <member name="M:DotNetOpenAuth.OpenId.Interop.OpenIdRelyingPartyShim.CreateRequestWithSimpleRegistration(System.String,System.String,System.String,System.String,System.String)">
  996. <summary>
  997. Creates an authentication request to verify that a user controls
  998. some given Identifier.
  999. </summary>
  1000. <param name="userSuppliedIdentifier">The Identifier supplied by the user. This may be a URL, an XRI or i-name.</param>
  1001. <param name="realm">The shorest URL that describes this relying party web site's address.
  1002. For example, if your login page is found at https://www.example.com/login.aspx,
  1003. your realm would typically be https://www.example.com/.</param>
  1004. <param name="returnToUrl">The URL of the login page, or the page prepared to receive authentication
  1005. responses from the OpenID Provider.</param>
  1006. <param name="optionalSreg">A comma-delimited list of simple registration fields to request as optional.</param>
  1007. <param name="requiredSreg">A comma-delimited list of simple registration fields to request as required.</param>
  1008. <returns>
  1009. An authentication request object that describes the HTTP response to
  1010. send to the user agent to initiate the authentication.
  1011. </returns>
  1012. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if no OpenID endpoint could be found.</exception>
  1013. </member>
  1014. <member name="M:DotNetOpenAuth.OpenId.Interop.OpenIdRelyingPartyShim.ProcessAuthentication(System.String,System.String)">
  1015. <summary>
  1016. Gets the result of a user agent's visit to his OpenId provider in an
  1017. authentication attempt. Null if no response is available.
  1018. </summary>
  1019. <param name="url">The incoming request URL.</param>
  1020. <param name="form">The form data that may have been included in the case of a POST request.</param>
  1021. <returns>The Provider's response to a previous authentication request, or null if no response is present.</returns>
  1022. </member>
  1023. <member name="T:DotNetOpenAuth.OpenId.Messages.AssociateDiffieHellmanRelyingPartyResponse">
  1024. <summary>
  1025. The successful Diffie-Hellman association response message.
  1026. </summary>
  1027. <remarks>
  1028. Association response messages are described in OpenID 2.0 section 8.2. This type covers section 8.2.3.
  1029. </remarks>
  1030. </member>
  1031. <member name="T:DotNetOpenAuth.OpenId.Messages.IAssociateSuccessfulResponseRelyingParty">
  1032. <summary>
  1033. A successful association response as it is received by the relying party.
  1034. </summary>
  1035. </member>
  1036. <member name="M:DotNetOpenAuth.OpenId.Messages.IAssociateSuccessfulResponseRelyingParty.CreateAssociationAtRelyingParty(DotNetOpenAuth.OpenId.Messages.AssociateRequest)">
  1037. <summary>
  1038. Called to create the Association based on a request previously given by the Relying Party.
  1039. </summary>
  1040. <param name="request">The prior request for an association.</param>
  1041. <returns>The created association.</returns>
  1042. </member>
  1043. <member name="M:DotNetOpenAuth.OpenId.Messages.AssociateDiffieHellmanRelyingPartyResponse.#ctor(System.Version,DotNetOpenAuth.OpenId.Messages.AssociateDiffieHellmanRequest)">
  1044. <summary>
  1045. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.Messages.AssociateDiffieHellmanRelyingPartyResponse"/> class.
  1046. </summary>
  1047. <param name="responseVersion">The OpenID version of the response message.</param>
  1048. <param name="originatingRequest">The originating request.</param>
  1049. </member>
  1050. <member name="M:DotNetOpenAuth.OpenId.Messages.AssociateDiffieHellmanRelyingPartyResponse.CreateAssociationAtRelyingParty(DotNetOpenAuth.OpenId.Messages.AssociateRequest)">
  1051. <summary>
  1052. Creates the association at relying party side after the association response has been received.
  1053. </summary>
  1054. <param name="request">The original association request that was already sent and responded to.</param>
  1055. <returns>The newly created association.</returns>
  1056. <remarks>
  1057. The resulting association is <i>not</i> added to the association store and must be done by the caller.
  1058. </remarks>
  1059. </member>
  1060. <member name="T:DotNetOpenAuth.OpenId.Messages.AssociateRequestRelyingParty">
  1061. <summary>
  1062. Utility methods for requesting associations from the relying party.
  1063. </summary>
  1064. </member>
  1065. <member name="M:DotNetOpenAuth.OpenId.Messages.AssociateRequestRelyingParty.Create(DotNetOpenAuth.OpenId.SecuritySettings,DotNetOpenAuth.OpenId.RelyingParty.IProviderEndpoint)">
  1066. <summary>
  1067. Creates an association request message that is appropriate for a given Provider.
  1068. </summary>
  1069. <param name="securityRequirements">The set of requirements the selected association type must comply to.</param>
  1070. <param name="provider">The provider to create an association with.</param>
  1071. <returns>
  1072. The message to send to the Provider to request an association.
  1073. Null if no association could be created that meet the security requirements
  1074. and the provider OpenID version.
  1075. </returns>
  1076. </member>
  1077. <member name="M:DotNetOpenAuth.OpenId.Messages.AssociateRequestRelyingParty.Create(DotNetOpenAuth.OpenId.SecuritySettings,DotNetOpenAuth.OpenId.RelyingParty.IProviderEndpoint,System.String,System.String)">
  1078. <summary>
  1079. Creates an association request message that is appropriate for a given Provider.
  1080. </summary>
  1081. <param name="securityRequirements">The set of requirements the selected association type must comply to.</param>
  1082. <param name="provider">The provider to create an association with.</param>
  1083. <param name="associationType">Type of the association.</param>
  1084. <param name="sessionType">Type of the session.</param>
  1085. <returns>
  1086. The message to send to the Provider to request an association.
  1087. Null if no association could be created that meet the security requirements
  1088. and the provider OpenID version.
  1089. </returns>
  1090. </member>
  1091. <member name="T:DotNetOpenAuth.IAssociateSuccessfulResponseRelyingPartyContract">
  1092. <summary>
  1093. Code contract for the <see cref="T:DotNetOpenAuth.OpenId.Messages.IAssociateSuccessfulResponseRelyingParty"/> interface.
  1094. </summary>
  1095. </member>
  1096. <member name="M:DotNetOpenAuth.IAssociateSuccessfulResponseRelyingPartyContract.DotNetOpenAuth#Messaging#IMessage#EnsureValidMessage">
  1097. <summary>
  1098. Checks the message state for conformity to the protocol specification
  1099. and throws an exception if the message is invalid.
  1100. </summary>
  1101. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if the message is invalid.</exception>
  1102. </member>
  1103. <member name="M:DotNetOpenAuth.IAssociateSuccessfulResponseRelyingPartyContract.DotNetOpenAuth#OpenId#Messages#IAssociateSuccessfulResponseRelyingParty#CreateAssociationAtRelyingParty(DotNetOpenAuth.OpenId.Messages.AssociateRequest)">
  1104. <summary>
  1105. Called to create the Association based on a request previously given by the Relying Party.
  1106. </summary>
  1107. <param name="request">The prior request for an association.</param>
  1108. <returns>
  1109. The created association.
  1110. </returns>
  1111. </member>
  1112. <member name="P:DotNetOpenAuth.IAssociateSuccessfulResponseRelyingPartyContract.DotNetOpenAuth#Messaging#IProtocolMessage#RequiredProtection">
  1113. <summary>
  1114. Gets the level of protection this message requires.
  1115. </summary>
  1116. </member>
  1117. <member name="P:DotNetOpenAuth.IAssociateSuccessfulResponseRelyingPartyContract.DotNetOpenAuth#Messaging#IProtocolMessage#Transport">
  1118. <summary>
  1119. Gets a value indicating whether this is a direct or indirect message.
  1120. </summary>
  1121. </member>
  1122. <member name="P:DotNetOpenAuth.IAssociateSuccessfulResponseRelyingPartyContract.DotNetOpenAuth#Messaging#IMessage#Version">
  1123. <summary>
  1124. Gets the version of the protocol or extension this message is prepared to implement.
  1125. </summary>
  1126. </member>
  1127. <member name="P:DotNetOpenAuth.IAssociateSuccessfulResponseRelyingPartyContract.DotNetOpenAuth#Messaging#IMessage#ExtraData">
  1128. <summary>
  1129. Gets the extra, non-standard Protocol parameters included in the message.
  1130. </summary>
  1131. </member>
  1132. <member name="T:DotNetOpenAuth.OpenId.Messages.AssociateUnencryptedResponseRelyingParty">
  1133. <summary>
  1134. A response to an unencrypted assocation request, as it is received by the relying party.
  1135. </summary>
  1136. </member>
  1137. <member name="M:DotNetOpenAuth.OpenId.Messages.AssociateUnencryptedResponseRelyingParty.#ctor(System.Version,DotNetOpenAuth.OpenId.Messages.AssociateUnencryptedRequest)">
  1138. <summary>
  1139. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.Messages.AssociateUnencryptedResponseRelyingParty"/> class.
  1140. </summary>
  1141. <param name="version">The version.</param>
  1142. <param name="request">The request.</param>
  1143. </member>
  1144. <member name="M:DotNetOpenAuth.OpenId.Messages.AssociateUnencryptedResponseRelyingParty.CreateAssociationAtRelyingParty(DotNetOpenAuth.OpenId.Messages.AssociateRequest)">
  1145. <summary>
  1146. Called to create the Association based on a request previously given by the Relying Party.
  1147. </summary>
  1148. <param name="request">The prior request for an association.</param>
  1149. <returns>The created association.</returns>
  1150. </member>
  1151. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.CryptoKeyStoreAsRelyingPartyAssociationStore">
  1152. <summary>
  1153. Wraps a standard <see cref="T:DotNetOpenAuth.Messaging.Bindings.ICryptoKeyStore"/> so that it behaves as an association store.
  1154. </summary>
  1155. </member>
  1156. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStore">
  1157. <summary>
  1158. Stores <see cref="T:DotNetOpenAuth.OpenId.Association"/>s for lookup by their handle, keeping
  1159. associations separated by a given OP Endpoint.
  1160. </summary>
  1161. <remarks>
  1162. Expired associations should be periodically cleared out of an association store.
  1163. This should be done frequently enough to avoid a memory leak, but sparingly enough
  1164. to not be a performance drain. Because this balance can vary by host, it is the
  1165. responsibility of the host to initiate this cleaning.
  1166. </remarks>
  1167. </member>
  1168. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStore.StoreAssociation(System.Uri,DotNetOpenAuth.OpenId.Association)">
  1169. <summary>
  1170. Saves an <see cref="T:DotNetOpenAuth.OpenId.Association"/> for later recall.
  1171. </summary>
  1172. <param name="providerEndpoint">The OP Endpoint with which the association is established.</param>
  1173. <param name="association">The association to store.</param>
  1174. <remarks>
  1175. If the new association conflicts (in OP endpoint and association handle) with an existing association,
  1176. (which should never happen by the way) implementations may overwrite the previously saved association.
  1177. </remarks>
  1178. </member>
  1179. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStore.GetAssociation(System.Uri,DotNetOpenAuth.OpenId.SecuritySettings)">
  1180. <summary>
  1181. Gets the best association (the one with the longest remaining life) for a given key.
  1182. </summary>
  1183. <param name="providerEndpoint">The OP Endpoint with which the association is established.</param>
  1184. <param name="securityRequirements">The security requirements that the returned association must meet.</param>
  1185. <returns>
  1186. The requested association, or null if no unexpired <see cref="T:DotNetOpenAuth.OpenId.Association"/>s exist for the given key.
  1187. </returns>
  1188. <remarks>
  1189. In the event that multiple associations exist for the given
  1190. <paramref name="providerEndpoint"/>, it is important for the
  1191. implementation for this method to use the <paramref name="securityRequirements"/>
  1192. to pick the best (highest grade or longest living as the host's policy may dictate)
  1193. association that fits the security requirements.
  1194. Associations that are returned that do not meet the security requirements will be
  1195. ignored and a new association created.
  1196. </remarks>
  1197. </member>
  1198. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStore.GetAssociation(System.Uri,System.String)">
  1199. <summary>
  1200. Gets the association for a given key and handle.
  1201. </summary>
  1202. <param name="providerEndpoint">The OP Endpoint with which the association is established.</param>
  1203. <param name="handle">The handle of the specific association that must be recalled.</param>
  1204. <returns>The requested association, or null if no unexpired <see cref="T:DotNetOpenAuth.OpenId.Association"/>s exist for the given key and handle.</returns>
  1205. </member>
  1206. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStore.RemoveAssociation(System.Uri,System.String)">
  1207. <summary>Removes a specified handle that may exist in the store.</summary>
  1208. <param name="providerEndpoint">The OP Endpoint with which the association is established.</param>
  1209. <param name="handle">The handle of the specific association that must be deleted.</param>
  1210. <returns>
  1211. Deprecated. The return value is insignificant.
  1212. Previously: True if the association existed in this store previous to this call.
  1213. </returns>
  1214. <remarks>
  1215. No exception should be thrown if the association does not exist in the store
  1216. before this call.
  1217. </remarks>
  1218. </member>
  1219. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.CryptoKeyStoreAsRelyingPartyAssociationStore.keyStore">
  1220. <summary>
  1221. The underlying key store.
  1222. </summary>
  1223. </member>
  1224. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.CryptoKeyStoreAsRelyingPartyAssociationStore.#ctor(DotNetOpenAuth.Messaging.Bindings.ICryptoKeyStore)">
  1225. <summary>
  1226. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.CryptoKeyStoreAsRelyingPartyAssociationStore"/> class.
  1227. </summary>
  1228. <param name="keyStore">The key store.</param>
  1229. </member>
  1230. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.CryptoKeyStoreAsRelyingPartyAssociationStore.StoreAssociation(System.Uri,DotNetOpenAuth.OpenId.Association)">
  1231. <summary>
  1232. Saves an <see cref="T:DotNetOpenAuth.OpenId.Association"/> for later recall.
  1233. </summary>
  1234. <param name="providerEndpoint">The OP Endpoint with which the association is established.</param>
  1235. <param name="association">The association to store.</param>
  1236. </member>
  1237. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.CryptoKeyStoreAsRelyingPartyAssociationStore.GetAssociation(System.Uri,DotNetOpenAuth.OpenId.SecuritySettings)">
  1238. <summary>
  1239. Gets the best association (the one with the longest remaining life) for a given key.
  1240. </summary>
  1241. <param name="providerEndpoint">The OP Endpoint with which the association is established.</param>
  1242. <param name="securityRequirements">The security requirements that the returned association must meet.</param>
  1243. <returns>
  1244. The requested association, or null if no unexpired <see cref="T:DotNetOpenAuth.OpenId.Association"/>s exist for the given key.
  1245. </returns>
  1246. </member>
  1247. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.CryptoKeyStoreAsRelyingPartyAssociationStore.GetAssociation(System.Uri,System.String)">
  1248. <summary>
  1249. Gets the association for a given key and handle.
  1250. </summary>
  1251. <param name="providerEndpoint">The OP Endpoint with which the association is established.</param>
  1252. <param name="handle">The handle of the specific association that must be recalled.</param>
  1253. <returns>
  1254. The requested association, or null if no unexpired <see cref="T:DotNetOpenAuth.OpenId.Association"/>s exist for the given key and handle.
  1255. </returns>
  1256. </member>
  1257. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.CryptoKeyStoreAsRelyingPartyAssociationStore.RemoveAssociation(System.Uri,System.String)">
  1258. <summary>
  1259. Removes a specified handle that may exist in the store.
  1260. </summary>
  1261. <param name="providerEndpoint">The OP Endpoint with which the association is established.</param>
  1262. <param name="handle">The handle of the specific association that must be deleted.</param>
  1263. <returns>
  1264. True if the association existed in this store previous to this call.
  1265. </returns>
  1266. </member>
  1267. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.Extensions.UI.UIUtilities">
  1268. <summary>
  1269. Constants used in implementing support for the UI extension.
  1270. </summary>
  1271. </member>
  1272. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Extensions.UI.UIUtilities.GetWindowPopupScript(DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty,DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest,System.String)">
  1273. <summary>
  1274. Gets the <c>window.open</c> javascript snippet to use to open a popup window
  1275. compliant with the UI extension.
  1276. </summary>
  1277. <param name="relyingParty">The relying party.</param>
  1278. <param name="request">The authentication request to place in the window.</param>
  1279. <param name="windowName">The name to assign to the popup window.</param>
  1280. <returns>A string starting with 'window.open' and forming just that one method call.</returns>
  1281. </member>
  1282. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStoreContract">
  1283. <summary>
  1284. Code Contract for the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStore"/> class.
  1285. </summary>
  1286. </member>
  1287. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStoreContract.DotNetOpenAuth#OpenId#RelyingParty#IRelyingPartyAssociationStore#StoreAssociation(System.Uri,DotNetOpenAuth.OpenId.Association)">
  1288. <summary>
  1289. Saves an <see cref="T:DotNetOpenAuth.OpenId.Association"/> for later recall.
  1290. </summary>
  1291. <param name="providerEndpoint">The Uri (for relying parties) or Smart/Dumb (for providers).</param>
  1292. <param name="association">The association to store.</param>
  1293. <remarks>
  1294. TODO: what should implementations do on association handle conflict?
  1295. </remarks>
  1296. </member>
  1297. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStoreContract.DotNetOpenAuth#OpenId#RelyingParty#IRelyingPartyAssociationStore#GetAssociation(System.Uri,DotNetOpenAuth.OpenId.SecuritySettings)">
  1298. <summary>
  1299. Gets the best association (the one with the longest remaining life) for a given key.
  1300. </summary>
  1301. <param name="providerEndpoint">The Uri (for relying parties) or Smart/Dumb (for Providers).</param>
  1302. <param name="securityRequirements">The security requirements that the returned association must meet.</param>
  1303. <returns>
  1304. The requested association, or null if no unexpired <see cref="T:DotNetOpenAuth.OpenId.Association"/>s exist for the given key.
  1305. </returns>
  1306. <remarks>
  1307. In the event that multiple associations exist for the given
  1308. <paramref name="providerEndpoint"/>, it is important for the
  1309. implementation for this method to use the <paramref name="securityRequirements"/>
  1310. to pick the best (highest grade or longest living as the host's policy may dictate)
  1311. association that fits the security requirements.
  1312. Associations that are returned that do not meet the security requirements will be
  1313. ignored and a new association created.
  1314. </remarks>
  1315. </member>
  1316. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStoreContract.DotNetOpenAuth#OpenId#RelyingParty#IRelyingPartyAssociationStore#GetAssociation(System.Uri,System.String)">
  1317. <summary>
  1318. Gets the association for a given key and handle.
  1319. </summary>
  1320. <param name="providerEndpoint">The Uri (for relying parties) or Smart/Dumb (for Providers).</param>
  1321. <param name="handle">The handle of the specific association that must be recalled.</param>
  1322. <returns>
  1323. The requested association, or null if no unexpired <see cref="T:DotNetOpenAuth.OpenId.Association"/>s exist for the given key and handle.
  1324. </returns>
  1325. </member>
  1326. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStoreContract.DotNetOpenAuth#OpenId#RelyingParty#IRelyingPartyAssociationStore#RemoveAssociation(System.Uri,System.String)">
  1327. <summary>
  1328. Removes a specified handle that may exist in the store.
  1329. </summary>
  1330. <param name="providerEndpoint">The Uri (for relying parties) or Smart/Dumb (for Providers).</param>
  1331. <param name="handle">The handle of the specific association that must be deleted.</param>
  1332. <returns>
  1333. True if the association existed in this store previous to this call.
  1334. </returns>
  1335. <remarks>
  1336. No exception should be thrown if the association does not exist in the store
  1337. before this call.
  1338. </remarks>
  1339. </member>
  1340. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.Associations">
  1341. <summary>
  1342. A dictionary of handle/Association pairs.
  1343. </summary>
  1344. <remarks>
  1345. Each method is locked, even if it is only one line, so that they are thread safe
  1346. against each other, particularly the ones that enumerate over the list, since they
  1347. can break if the collection is changed by another thread during enumeration.
  1348. </remarks>
  1349. </member>
  1350. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.Associations.associations">
  1351. <summary>
  1352. The lookup table where keys are the association handles and values are the associations themselves.
  1353. </summary>
  1354. </member>
  1355. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Associations.#ctor">
  1356. <summary>
  1357. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.Associations"/> class.
  1358. </summary>
  1359. </member>
  1360. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Associations.Set(DotNetOpenAuth.OpenId.Association)">
  1361. <summary>
  1362. Stores an <see cref="T:DotNetOpenAuth.OpenId.Association"/> in the collection.
  1363. </summary>
  1364. <param name="association">The association to add to the collection.</param>
  1365. </member>
  1366. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Associations.Get(System.String)">
  1367. <summary>
  1368. Returns the <see cref="T:DotNetOpenAuth.OpenId.Association"/> with the given handle. Null if not found.
  1369. </summary>
  1370. <param name="handle">The handle to the required association.</param>
  1371. <returns>The desired association, or null if none with the given handle could be found.</returns>
  1372. </member>
  1373. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Associations.Remove(System.String)">
  1374. <summary>
  1375. Removes the <see cref="T:DotNetOpenAuth.OpenId.Association"/> with the given handle.
  1376. </summary>
  1377. <param name="handle">The handle to the required association.</param>
  1378. <returns>Whether an <see cref="T:DotNetOpenAuth.OpenId.Association"/> with the given handle was in the collection for removal.</returns>
  1379. </member>
  1380. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.Associations.ClearExpired">
  1381. <summary>
  1382. Removes all expired associations from the collection.
  1383. </summary>
  1384. </member>
  1385. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.Associations.Best">
  1386. <summary>
  1387. Gets the <see cref="T:DotNetOpenAuth.OpenId.Association"/>s ordered in order of descending issue date
  1388. (most recently issued comes first). An empty sequence if no valid associations exist.
  1389. </summary>
  1390. <remarks>
  1391. This property is used by relying parties that are initiating authentication requests.
  1392. It does not apply to Providers, which always need a specific association by handle.
  1393. </remarks>
  1394. </member>
  1395. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager">
  1396. <summary>
  1397. Manages the establishment, storage and retrieval of associations at the relying party.
  1398. </summary>
  1399. </member>
  1400. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.associationStore">
  1401. <summary>
  1402. The storage to use for saving and retrieving associations. May be null.
  1403. </summary>
  1404. </member>
  1405. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.channel">
  1406. <summary>
  1407. Backing field for the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.Channel"/> property.
  1408. </summary>
  1409. </member>
  1410. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.securitySettings">
  1411. <summary>
  1412. Backing field for the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.SecuritySettings"/> property.
  1413. </summary>
  1414. </member>
  1415. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.#ctor(DotNetOpenAuth.Messaging.Channel,DotNetOpenAuth.OpenId.RelyingParty.IRelyingPartyAssociationStore,DotNetOpenAuth.OpenId.RelyingParty.RelyingPartySecuritySettings)">
  1416. <summary>
  1417. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager"/> class.
  1418. </summary>
  1419. <param name="channel">The channel the relying party is using.</param>
  1420. <param name="associationStore">The association store. May be null for dumb mode relying parties.</param>
  1421. <param name="securitySettings">The security settings.</param>
  1422. </member>
  1423. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.GetExistingAssociation(DotNetOpenAuth.OpenId.RelyingParty.IProviderEndpoint)">
  1424. <summary>
  1425. Gets an association between this Relying Party and a given Provider
  1426. if it already exists in the association store.
  1427. </summary>
  1428. <param name="provider">The provider to create an association with.</param>
  1429. <returns>The association if one exists and has useful life remaining. Otherwise <c>null</c>.</returns>
  1430. </member>
  1431. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.GetOrCreateAssociation(DotNetOpenAuth.OpenId.RelyingParty.IProviderEndpoint)">
  1432. <summary>
  1433. Gets an existing association with the specified Provider, or attempts to create
  1434. a new association of one does not already exist.
  1435. </summary>
  1436. <param name="provider">The provider to get an association for.</param>
  1437. <returns>The existing or new association; <c>null</c> if none existed and one could not be created.</returns>
  1438. </member>
  1439. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.CreateNewAssociation(DotNetOpenAuth.OpenId.RelyingParty.IProviderEndpoint)">
  1440. <summary>
  1441. Creates a new association with a given Provider.
  1442. </summary>
  1443. <param name="provider">The provider to create an association with.</param>
  1444. <returns>
  1445. The newly created association, or null if no association can be created with
  1446. the given Provider given the current security settings.
  1447. </returns>
  1448. <remarks>
  1449. A new association is created and returned even if one already exists in the
  1450. association store.
  1451. Any new association is automatically added to the <see cref="F:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.associationStore"/>.
  1452. </remarks>
  1453. </member>
  1454. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.CreateNewAssociation(DotNetOpenAuth.OpenId.RelyingParty.IProviderEndpoint,DotNetOpenAuth.OpenId.Messages.AssociateRequest,System.Int32)">
  1455. <summary>
  1456. Creates a new association with a given Provider.
  1457. </summary>
  1458. <param name="provider">The provider to create an association with.</param>
  1459. <param name="associateRequest">The associate request. May be <c>null</c>, which will always result in a <c>null</c> return value..</param>
  1460. <param name="retriesRemaining">The number of times to try the associate request again if the Provider suggests it.</param>
  1461. <returns>
  1462. The newly created association, or null if no association can be created with
  1463. the given Provider given the current security settings.
  1464. </returns>
  1465. </member>
  1466. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.Channel">
  1467. <summary>
  1468. Gets or sets the channel to use for establishing associations.
  1469. </summary>
  1470. <value>The channel.</value>
  1471. </member>
  1472. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.SecuritySettings">
  1473. <summary>
  1474. Gets or sets the security settings to apply in choosing association types to support.
  1475. </summary>
  1476. </member>
  1477. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.HasAssociationStore">
  1478. <summary>
  1479. Gets a value indicating whether this instance has an association store.
  1480. </summary>
  1481. <value>
  1482. <c>true</c> if the relying party can act in 'smart' mode;
  1483. <c>false</c> if the relying party must always act in 'dumb' mode.
  1484. </value>
  1485. </member>
  1486. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AssociationManager.AssociationStoreTestHook">
  1487. <summary>
  1488. Gets the storage to use for saving and retrieving associations. May be null.
  1489. </summary>
  1490. </member>
  1491. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.AssociationPreference">
  1492. <summary>
  1493. Preferences regarding creation and use of an association between a relying party
  1494. and provider for authentication.
  1495. </summary>
  1496. </member>
  1497. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AssociationPreference.IfPossible">
  1498. <summary>
  1499. Indicates that an association should be created for use in authentication
  1500. if one has not already been established between the relying party and the
  1501. selected provider.
  1502. </summary>
  1503. <remarks>
  1504. Even with this value, if an association attempt fails or the relying party
  1505. has no application store to recall associations, the authentication may
  1506. proceed without an association.
  1507. </remarks>
  1508. </member>
  1509. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AssociationPreference.IfAlreadyEstablished">
  1510. <summary>
  1511. Indicates that an association should be used for authentication only if
  1512. it happens to already exist.
  1513. </summary>
  1514. </member>
  1515. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AssociationPreference.Never">
  1516. <summary>
  1517. Indicates that an authentication attempt should NOT use an OpenID association
  1518. between the relying party and the provider, even if an association was previously
  1519. created.
  1520. </summary>
  1521. </member>
  1522. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest">
  1523. <summary>
  1524. Facilitates customization and creation and an authentication request
  1525. that a Relying Party is preparing to send.
  1526. </summary>
  1527. </member>
  1528. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.UserSuppliedIdentifierParameterName">
  1529. <summary>
  1530. The name of the internal callback parameter to use to store the user-supplied identifier.
  1531. </summary>
  1532. </member>
  1533. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.RelyingParty">
  1534. <summary>
  1535. The relying party that created this request object.
  1536. </summary>
  1537. </member>
  1538. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.associationPreference">
  1539. <summary>
  1540. How an association may or should be created or used in the formulation of the
  1541. authentication request.
  1542. </summary>
  1543. </member>
  1544. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.extensions">
  1545. <summary>
  1546. The extensions that have been added to this authentication request.
  1547. </summary>
  1548. </member>
  1549. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.returnToArgs">
  1550. <summary>
  1551. Arguments to add to the return_to part of the query string, so that
  1552. these values come back to the consumer when the user agent returns.
  1553. </summary>
  1554. </member>
  1555. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.returnToArgsMustBeSigned">
  1556. <summary>
  1557. A value indicating whether the return_to callback arguments must be signed.
  1558. </summary>
  1559. <remarks>
  1560. This field defaults to false, but is set to true as soon as the first callback argument
  1561. is added that indicates it must be signed. At which point, all arguments are signed
  1562. even if individual ones did not need to be.
  1563. </remarks>
  1564. </member>
  1565. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.#ctor(DotNetOpenAuth.OpenId.IdentifierDiscoveryResult,DotNetOpenAuth.OpenId.Realm,System.Uri,DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty)">
  1566. <summary>
  1567. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest"/> class.
  1568. </summary>
  1569. <param name="discoveryResult">The endpoint that describes the OpenID Identifier and Provider that will complete the authentication.</param>
  1570. <param name="realm">The realm, or root URL, of the host web site.</param>
  1571. <param name="returnToUrl">The base return_to URL that the Provider should return the user to to complete authentication. This should not include callback parameters as these should be added using the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.AddCallbackArguments(System.String,System.String)"/> method.</param>
  1572. <param name="relyingParty">The relying party that created this instance.</param>
  1573. </member>
  1574. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.AddCallbackArguments(System.Collections.Generic.IDictionary{System.String,System.String})">
  1575. <summary>
  1576. Makes a dictionary of key/value pairs available when the authentication is completed.
  1577. </summary>
  1578. <param name="arguments">The arguments to add to the request's return_to URI.</param>
  1579. <remarks>
  1580. <para>Note that these values are NOT protected against eavesdropping in transit. No
  1581. privacy-sensitive data should be stored using this method.</para>
  1582. <para>The values stored here can be retrieved using
  1583. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse.GetCallbackArguments"/>, which will only return the value
  1584. if it hasn't been tampered with in transit.</para>
  1585. <para>Since the data set here is sent in the querystring of the request and some
  1586. servers place limits on the size of a request URL, this data should be kept relatively
  1587. small to ensure successful authentication. About 1.5KB is about all that should be stored.</para>
  1588. </remarks>
  1589. </member>
  1590. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.AddCallbackArguments(System.String,System.String)">
  1591. <summary>
  1592. Makes a key/value pair available when the authentication is completed.
  1593. </summary>
  1594. <param name="key">The parameter name.</param>
  1595. <param name="value">The value of the argument.</param>
  1596. <remarks>
  1597. <para>Note that these values are NOT protected against eavesdropping in transit. No
  1598. privacy-sensitive data should be stored using this method.</para>
  1599. <para>The value stored here can be retrieved using
  1600. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse.GetCallbackArgument(System.String)"/>, which will only return the value
  1601. if it hasn't been tampered with in transit.</para>
  1602. <para>Since the data set here is sent in the querystring of the request and some
  1603. servers place limits on the size of a request URL, this data should be kept relatively
  1604. small to ensure successful authentication. About 1.5KB is about all that should be stored.</para>
  1605. </remarks>
  1606. </member>
  1607. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.SetCallbackArgument(System.String,System.String)">
  1608. <summary>
  1609. Makes a key/value pair available when the authentication is completed.
  1610. </summary>
  1611. <param name="key">The parameter name.</param>
  1612. <param name="value">The value of the argument. Must not be null.</param>
  1613. <remarks>
  1614. <para>Note that these values are NOT protected against tampering in transit. No
  1615. security-sensitive data should be stored using this method.</para>
  1616. <para>The value stored here can be retrieved using
  1617. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse.GetCallbackArgument(System.String)"/>.</para>
  1618. <para>Since the data set here is sent in the querystring of the request and some
  1619. servers place limits on the size of a request URL, this data should be kept relatively
  1620. small to ensure successful authentication. About 1.5KB is about all that should be stored.</para>
  1621. </remarks>
  1622. </member>
  1623. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.SetUntrustedCallbackArgument(System.String,System.String)">
  1624. <summary>
  1625. Makes a key/value pair available when the authentication is completed without
  1626. requiring a return_to signature to protect against tampering of the callback argument.
  1627. </summary>
  1628. <param name="key">The parameter name.</param>
  1629. <param name="value">The value of the argument. Must not be null.</param>
  1630. <remarks>
  1631. <para>Note that these values are NOT protected against eavesdropping or tampering in transit. No
  1632. security-sensitive data should be stored using this method. </para>
  1633. <para>The value stored here can be retrieved using
  1634. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse.GetCallbackArgument(System.String)"/>.</para>
  1635. <para>Since the data set here is sent in the querystring of the request and some
  1636. servers place limits on the size of a request URL, this data should be kept relatively
  1637. small to ensure successful authentication. About 1.5KB is about all that should be stored.</para>
  1638. </remarks>
  1639. </member>
  1640. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.AddExtension(DotNetOpenAuth.OpenId.Messages.IOpenIdMessageExtension)">
  1641. <summary>
  1642. Adds an OpenID extension to the request directed at the OpenID provider.
  1643. </summary>
  1644. <param name="extension">The initialized extension to add to the request.</param>
  1645. </member>
  1646. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.RedirectToProvider">
  1647. <summary>
  1648. Redirects the user agent to the provider for authentication.
  1649. </summary>
  1650. <remarks>
  1651. This method requires an ASP.NET HttpContext.
  1652. </remarks>
  1653. </member>
  1654. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.Create(DotNetOpenAuth.OpenId.Identifier,DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty,DotNetOpenAuth.OpenId.Realm,System.Uri,System.Boolean)">
  1655. <summary>
  1656. Performs identifier discovery, creates associations and generates authentication requests
  1657. on-demand for as long as new ones can be generated based on the results of Identifier discovery.
  1658. </summary>
  1659. <param name="userSuppliedIdentifier">The user supplied identifier.</param>
  1660. <param name="relyingParty">The relying party.</param>
  1661. <param name="realm">The realm.</param>
  1662. <param name="returnToUrl">The return_to base URL.</param>
  1663. <param name="createNewAssociationsAsNeeded">if set to <c>true</c>, associations that do not exist between this Relying Party and the asserting Providers are created before the authentication request is created.</param>
  1664. <returns>
  1665. A sequence of authentication requests, any of which constitutes a valid identity assertion on the Claimed Identifier.
  1666. Never null, but may be empty.
  1667. </returns>
  1668. </member>
  1669. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.CreateForTest(DotNetOpenAuth.OpenId.IdentifierDiscoveryResult,DotNetOpenAuth.OpenId.Realm,System.Uri,DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty)">
  1670. <summary>
  1671. Creates an instance of <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest"/> FOR TESTING PURPOSES ONLY.
  1672. </summary>
  1673. <param name="discoveryResult">The discovery result.</param>
  1674. <param name="realm">The realm.</param>
  1675. <param name="returnTo">The return to.</param>
  1676. <param name="rp">The relying party.</param>
  1677. <returns>The instantiated <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest"/>.</returns>
  1678. </member>
  1679. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.CreateRequestMessageTestHook">
  1680. <summary>
  1681. Creates the request message to send to the Provider,
  1682. based on the properties in this instance.
  1683. </summary>
  1684. <returns>The message to send to the Provider.</returns>
  1685. </member>
  1686. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.CreateInternal(DotNetOpenAuth.OpenId.Identifier,DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty,DotNetOpenAuth.OpenId.Realm,System.Uri,System.Collections.Generic.IEnumerable{DotNetOpenAuth.OpenId.IdentifierDiscoveryResult},System.Boolean)">
  1687. <summary>
  1688. Performs deferred request generation for the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.Create(DotNetOpenAuth.OpenId.Identifier,DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty,DotNetOpenAuth.OpenId.Realm,System.Uri,System.Boolean)"/> method.
  1689. </summary>
  1690. <param name="userSuppliedIdentifier">The user supplied identifier.</param>
  1691. <param name="relyingParty">The relying party.</param>
  1692. <param name="realm">The realm.</param>
  1693. <param name="returnToUrl">The return_to base URL.</param>
  1694. <param name="serviceEndpoints">The discovered service endpoints on the Claimed Identifier.</param>
  1695. <param name="createNewAssociationsAsNeeded">if set to <c>true</c>, associations that do not exist between this Relying Party and the asserting Providers are created before the authentication request is created.</param>
  1696. <returns>
  1697. A sequence of authentication requests, any of which constitutes a valid identity assertion on the Claimed Identifier.
  1698. Never null, but may be empty.
  1699. </returns>
  1700. <remarks>
  1701. All data validation and cleansing steps must have ALREADY taken place
  1702. before calling this method.
  1703. </remarks>
  1704. </member>
  1705. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.FilterAndSortEndpoints(System.Collections.Generic.IEnumerable{DotNetOpenAuth.OpenId.IdentifierDiscoveryResult},DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty)">
  1706. <summary>
  1707. Returns a filtered and sorted list of the available OP endpoints for a discovered Identifier.
  1708. </summary>
  1709. <param name="endpoints">The endpoints.</param>
  1710. <param name="relyingParty">The relying party.</param>
  1711. <returns>A filtered and sorted list of endpoints; may be empty if the input was empty or the filter removed all endpoints.</returns>
  1712. </member>
  1713. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.CreateRequestMessage">
  1714. <summary>
  1715. Creates the request message to send to the Provider,
  1716. based on the properties in this instance.
  1717. </summary>
  1718. <returns>The message to send to the Provider.</returns>
  1719. </member>
  1720. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.GetAssociation">
  1721. <summary>
  1722. Gets the association to use for this authentication request.
  1723. </summary>
  1724. <returns>The association to use; <c>null</c> to use 'dumb mode'.</returns>
  1725. </member>
  1726. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.Mode">
  1727. <summary>
  1728. Gets or sets the mode the Provider should use during authentication.
  1729. </summary>
  1730. <value></value>
  1731. </member>
  1732. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.RedirectingResponse">
  1733. <summary>
  1734. Gets the HTTP response the relying party should send to the user agent
  1735. to redirect it to the OpenID Provider to start the OpenID authentication process.
  1736. </summary>
  1737. <value></value>
  1738. </member>
  1739. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.ReturnToUrl">
  1740. <summary>
  1741. Gets the URL that the user agent will return to after authentication
  1742. completes or fails at the Provider.
  1743. </summary>
  1744. <value></value>
  1745. </member>
  1746. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.Realm">
  1747. <summary>
  1748. Gets the URL that identifies this consumer web application that
  1749. the Provider will display to the end user.
  1750. </summary>
  1751. </member>
  1752. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.ClaimedIdentifier">
  1753. <summary>
  1754. Gets the Claimed Identifier that the User Supplied Identifier
  1755. resolved to. Null if the user provided an OP Identifier
  1756. (directed identity).
  1757. </summary>
  1758. <value></value>
  1759. <remarks>
  1760. Null is returned if the user is using the directed identity feature
  1761. of OpenID 2.0 to make it nearly impossible for a relying party site
  1762. to improperly store the reserved OpenID URL used for directed identity
  1763. as a user's own Identifier.
  1764. However, to test for the Directed Identity feature, please test the
  1765. <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.IsDirectedIdentity"/> property rather than testing this
  1766. property for a null value.
  1767. </remarks>
  1768. </member>
  1769. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.IsDirectedIdentity">
  1770. <summary>
  1771. Gets a value indicating whether the authenticating user has chosen to let the Provider
  1772. determine and send the ClaimedIdentifier after authentication.
  1773. </summary>
  1774. </member>
  1775. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.IsExtensionOnly">
  1776. <summary>
  1777. Gets or sets a value indicating whether this request only carries extensions
  1778. and is not a request to verify that the user controls some identifier.
  1779. </summary>
  1780. <value>
  1781. <c>true</c> if this request is merely a carrier of extensions and is not
  1782. about an OpenID identifier; otherwise, <c>false</c>.
  1783. </value>
  1784. </member>
  1785. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.Provider">
  1786. <summary>
  1787. Gets information about the OpenId Provider, as advertised by the
  1788. OpenId discovery documents found at the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.ClaimedIdentifier"/>
  1789. location.
  1790. </summary>
  1791. </member>
  1792. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.DiscoveryResult">
  1793. <summary>
  1794. Gets the discovery result leading to the formulation of this request.
  1795. </summary>
  1796. <value>The discovery result.</value>
  1797. </member>
  1798. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.AssociationPreference">
  1799. <summary>
  1800. Gets or sets how an association may or should be created or used
  1801. in the formulation of the authentication request.
  1802. </summary>
  1803. </member>
  1804. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.AppliedExtensions">
  1805. <summary>
  1806. Gets the extensions that have been added to the request.
  1807. </summary>
  1808. </member>
  1809. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationRequest.Extensions">
  1810. <summary>
  1811. Gets the list of extensions for this request.
  1812. </summary>
  1813. </member>
  1814. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.DuplicateRequestedHostsComparer">
  1815. <summary>
  1816. An authentication request comparer that judges equality solely on the OP endpoint hostname.
  1817. </summary>
  1818. </member>
  1819. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.DuplicateRequestedHostsComparer.instance">
  1820. <summary>
  1821. The singleton instance of this comparer.
  1822. </summary>
  1823. </member>
  1824. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.DuplicateRequestedHostsComparer.#ctor">
  1825. <summary>
  1826. Prevents a default instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.DuplicateRequestedHostsComparer"/> class from being created.
  1827. </summary>
  1828. </member>
  1829. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.DuplicateRequestedHostsComparer.Equals(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest,DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest)">
  1830. <summary>
  1831. Determines whether the specified objects are equal.
  1832. </summary>
  1833. <param name="x">The first object to compare.</param>
  1834. <param name="y">The second object to compare.</param>
  1835. <returns>
  1836. true if the specified objects are equal; otherwise, false.
  1837. </returns>
  1838. </member>
  1839. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.DuplicateRequestedHostsComparer.GetHashCode(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest)">
  1840. <summary>
  1841. Returns a hash code for the specified object.
  1842. </summary>
  1843. <param name="obj">The <see cref="T:System.Object"/> for which a hash code is to be returned.</param>
  1844. <returns>A hash code for the specified object.</returns>
  1845. <exception cref="T:System.ArgumentNullException">
  1846. The type of <paramref name="obj"/> is a reference type and <paramref name="obj"/> is null.
  1847. </exception>
  1848. </member>
  1849. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.DuplicateRequestedHostsComparer.Instance">
  1850. <summary>
  1851. Gets the singleton instance of this comparer.
  1852. </summary>
  1853. </member>
  1854. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse">
  1855. <summary>
  1856. Wraps a negative assertion response in an <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse"/> instance
  1857. for public consumption by the host web site.
  1858. </summary>
  1859. </member>
  1860. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.ISetupRequiredAuthenticationResponse">
  1861. <summary>
  1862. An interface to expose useful properties and functionality for handling
  1863. authentication responses that are returned from Immediate authentication
  1864. requests that require a subsequent request to be made in non-immediate mode.
  1865. </summary>
  1866. </member>
  1867. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.ISetupRequiredAuthenticationResponse.UserSuppliedIdentifier">
  1868. <summary>
  1869. Gets the <see cref="T:DotNetOpenAuth.OpenId.Identifier"/> to pass to <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CreateRequest(DotNetOpenAuth.OpenId.Identifier)"/>
  1870. in a subsequent authentication attempt.
  1871. </summary>
  1872. </member>
  1873. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.response">
  1874. <summary>
  1875. The negative assertion message that was received by the RP that was used
  1876. to create this instance.
  1877. </summary>
  1878. </member>
  1879. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.#ctor(DotNetOpenAuth.OpenId.Messages.NegativeAssertionResponse)">
  1880. <summary>
  1881. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse"/> class.
  1882. </summary>
  1883. <param name="response">The negative assertion response received by the Relying Party.</param>
  1884. </member>
  1885. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetCallbackArgument(System.String)">
  1886. <summary>
  1887. Gets a callback argument's value that was previously added using
  1888. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.
  1889. </summary>
  1890. <param name="key">The name of the parameter whose value is sought.</param>
  1891. <returns>
  1892. The value of the argument, or null if the named parameter could not be found.
  1893. </returns>
  1894. <remarks>
  1895. <para>This may return any argument on the querystring that came with the authentication response,
  1896. which may include parameters not explicitly added using
  1897. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.</para>
  1898. <para>Note that these values are NOT protected against tampering in transit.</para>
  1899. </remarks>
  1900. </member>
  1901. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetUntrustedCallbackArgument(System.String)">
  1902. <summary>
  1903. Gets a callback argument's value that was previously added using
  1904. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.
  1905. </summary>
  1906. <param name="key">The name of the parameter whose value is sought.</param>
  1907. <returns>
  1908. The value of the argument, or null if the named parameter could not be found.
  1909. </returns>
  1910. <remarks>
  1911. Callback parameters are only available even if the RP is in stateless mode,
  1912. or the callback parameters are otherwise unverifiable as untampered with.
  1913. Therefore, use this method only when the callback argument is not to be
  1914. used to make a security-sensitive decision.
  1915. </remarks>
  1916. </member>
  1917. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetCallbackArguments">
  1918. <summary>
  1919. Gets all the callback arguments that were previously added using
  1920. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/> or as a natural part
  1921. of the return_to URL.
  1922. </summary>
  1923. <returns>A name-value dictionary. Never null.</returns>
  1924. <remarks>
  1925. <para>This MAY return any argument on the querystring that came with the authentication response,
  1926. which may include parameters not explicitly added using
  1927. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.</para>
  1928. <para>Note that these values are NOT protected against tampering in transit.</para>
  1929. </remarks>
  1930. </member>
  1931. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetUntrustedCallbackArguments">
  1932. <summary>
  1933. Gets all the callback arguments that were previously added using
  1934. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/> or as a natural part
  1935. of the return_to URL.
  1936. </summary>
  1937. <returns>A name-value dictionary. Never null.</returns>
  1938. <remarks>
  1939. Callback parameters are only available even if the RP is in stateless mode,
  1940. or the callback parameters are otherwise unverifiable as untampered with.
  1941. Therefore, use this method only when the callback argument is not to be
  1942. used to make a security-sensitive decision.
  1943. </remarks>
  1944. </member>
  1945. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetExtension``1">
  1946. <summary>
  1947. Tries to get an OpenID extension that may be present in the response.
  1948. </summary>
  1949. <typeparam name="T">The type of extension to look for in the response message.</typeparam>
  1950. <returns>
  1951. The extension, if it is found. Null otherwise.
  1952. </returns>
  1953. <remarks>
  1954. <para>Extensions are returned only if the Provider signed them.
  1955. Relying parties that do not care if the values were modified in
  1956. transit should use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetUntrustedExtension``1"/> method
  1957. in order to allow the Provider to not sign the extension. </para>
  1958. <para>Unsigned extensions are completely unreliable and should be
  1959. used only to prefill user forms since the user or any other third
  1960. party may have tampered with the data carried by the extension.</para>
  1961. <para>Signed extensions are only reliable if the relying party
  1962. trusts the OpenID Provider that signed them. Signing does not mean
  1963. the relying party can trust the values -- it only means that the values
  1964. have not been tampered with since the Provider sent the message.</para>
  1965. </remarks>
  1966. </member>
  1967. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetExtension(System.Type)">
  1968. <summary>
  1969. Tries to get an OpenID extension that may be present in the response.
  1970. </summary>
  1971. <param name="extensionType">Type of the extension to look for in the response.</param>
  1972. <returns>
  1973. The extension, if it is found. Null otherwise.
  1974. </returns>
  1975. <remarks>
  1976. <para>Extensions are returned only if the Provider signed them.
  1977. Relying parties that do not care if the values were modified in
  1978. transit should use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetUntrustedExtension(System.Type)"/> method
  1979. in order to allow the Provider to not sign the extension. </para>
  1980. <para>Unsigned extensions are completely unreliable and should be
  1981. used only to prefill user forms since the user or any other third
  1982. party may have tampered with the data carried by the extension.</para>
  1983. <para>Signed extensions are only reliable if the relying party
  1984. trusts the OpenID Provider that signed them. Signing does not mean
  1985. the relying party can trust the values -- it only means that the values
  1986. have not been tampered with since the Provider sent the message.</para>
  1987. </remarks>
  1988. </member>
  1989. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetUntrustedExtension``1">
  1990. <summary>
  1991. Tries to get an OpenID extension that may be present in the response, without
  1992. requiring it to be signed by the Provider.
  1993. </summary>
  1994. <typeparam name="T">The type of extension to look for in the response message.</typeparam>
  1995. <returns>
  1996. The extension, if it is found. Null otherwise.
  1997. </returns>
  1998. <remarks>
  1999. <para>Extensions are returned whether they are signed or not.
  2000. Use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetExtension``1"/> method to retrieve
  2001. extension responses only if they are signed by the Provider to
  2002. protect against tampering. </para>
  2003. <para>Unsigned extensions are completely unreliable and should be
  2004. used only to prefill user forms since the user or any other third
  2005. party may have tampered with the data carried by the extension.</para>
  2006. <para>Signed extensions are only reliable if the relying party
  2007. trusts the OpenID Provider that signed them. Signing does not mean
  2008. the relying party can trust the values -- it only means that the values
  2009. have not been tampered with since the Provider sent the message.</para>
  2010. </remarks>
  2011. </member>
  2012. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetUntrustedExtension(System.Type)">
  2013. <summary>
  2014. Tries to get an OpenID extension that may be present in the response.
  2015. </summary>
  2016. <param name="extensionType">Type of the extension to look for in the response.</param>
  2017. <returns>
  2018. The extension, if it is found. Null otherwise.
  2019. </returns>
  2020. <remarks>
  2021. <para>Extensions are returned whether they are signed or not.
  2022. Use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.GetExtension(System.Type)"/> method to retrieve
  2023. extension responses only if they are signed by the Provider to
  2024. protect against tampering. </para>
  2025. <para>Unsigned extensions are completely unreliable and should be
  2026. used only to prefill user forms since the user or any other third
  2027. party may have tampered with the data carried by the extension.</para>
  2028. <para>Signed extensions are only reliable if the relying party
  2029. trusts the OpenID Provider that signed them. Signing does not mean
  2030. the relying party can trust the values -- it only means that the values
  2031. have not been tampered with since the Provider sent the message.</para>
  2032. </remarks>
  2033. </member>
  2034. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.ClaimedIdentifier">
  2035. <summary>
  2036. Gets the Identifier that the end user claims to own. For use with user database storage and lookup.
  2037. May be null for some failed authentications (i.e. failed directed identity authentications).
  2038. </summary>
  2039. <value></value>
  2040. <remarks>
  2041. <para>
  2042. This is the secure identifier that should be used for database storage and lookup.
  2043. It is not always friendly (i.e. =Arnott becomes =!9B72.7DD1.50A9.5CCD), but it protects
  2044. user identities against spoofing and other attacks.
  2045. </para>
  2046. <para>
  2047. For user-friendly identifiers to display, use the
  2048. <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.FriendlyIdentifierForDisplay"/> property.
  2049. </para>
  2050. </remarks>
  2051. </member>
  2052. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.FriendlyIdentifierForDisplay">
  2053. <summary>
  2054. Gets a user-friendly OpenID Identifier for display purposes ONLY.
  2055. </summary>
  2056. <value></value>
  2057. <remarks>
  2058. <para>
  2059. This <i>should</i> be put through <see cref="M:System.Web.HttpUtility.HtmlEncode(System.String)"/> before
  2060. sending to a browser to secure against javascript injection attacks.
  2061. </para>
  2062. <para>
  2063. This property retains some aspects of the user-supplied identifier that get lost
  2064. in the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.ClaimedIdentifier"/>. For example, XRIs used as user-supplied
  2065. identifiers (i.e. =Arnott) become unfriendly unique strings (i.e. =!9B72.7DD1.50A9.5CCD).
  2066. For display purposes, such as text on a web page that says "You're logged in as ...",
  2067. this property serves to provide the =Arnott string, or whatever else is the most friendly
  2068. string close to what the user originally typed in.
  2069. </para>
  2070. <para>
  2071. If the user-supplied identifier is a URI, this property will be the URI after all
  2072. redirects, and with the protocol and fragment trimmed off.
  2073. If the user-supplied identifier is an XRI, this property will be the original XRI.
  2074. If the user-supplied identifier is an OpenID Provider identifier (i.e. yahoo.com),
  2075. this property will be the Claimed Identifier, with the protocol stripped if it is a URI.
  2076. </para>
  2077. <para>
  2078. It is <b>very</b> important that this property <i>never</i> be used for database storage
  2079. or lookup to avoid identity spoofing and other security risks. For database storage
  2080. and lookup please use the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.ClaimedIdentifier"/> property.
  2081. </para>
  2082. </remarks>
  2083. </member>
  2084. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.Status">
  2085. <summary>
  2086. Gets the detailed success or failure status of the authentication attempt.
  2087. </summary>
  2088. <value></value>
  2089. </member>
  2090. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.Provider">
  2091. <summary>
  2092. Gets information about the OpenId Provider, as advertised by the
  2093. OpenID discovery documents found at the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.ClaimedIdentifier"/>
  2094. location.
  2095. </summary>
  2096. <value>
  2097. The Provider endpoint that issued the positive assertion;
  2098. or <c>null</c> if information about the Provider is unavailable.
  2099. </value>
  2100. </member>
  2101. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.Exception">
  2102. <summary>
  2103. Gets the details regarding a failed authentication attempt, if available.
  2104. This will be set if and only if <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.Status"/> is <see cref="F:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationStatus.Failed"/>.
  2105. </summary>
  2106. <value></value>
  2107. </member>
  2108. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.NegativeAuthenticationResponse.UserSuppliedIdentifier">
  2109. <summary>
  2110. Gets the <see cref="T:DotNetOpenAuth.OpenId.Identifier"/> to pass to <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CreateRequest(DotNetOpenAuth.OpenId.Identifier)"/>
  2111. in a subsequent authentication attempt.
  2112. </summary>
  2113. <value></value>
  2114. </member>
  2115. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse">
  2116. <summary>
  2117. Wraps an extension-only response from the OP in an <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse"/> instance
  2118. for public consumption by the host web site.
  2119. </summary>
  2120. </member>
  2121. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.response">
  2122. <summary>
  2123. Backin field for the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.Response"/> property.
  2124. </summary>
  2125. </member>
  2126. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.provider">
  2127. <summary>
  2128. Information about the OP endpoint that issued this assertion.
  2129. </summary>
  2130. </member>
  2131. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.#ctor(DotNetOpenAuth.OpenId.Messages.IndirectSignedResponse)">
  2132. <summary>
  2133. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse"/> class.
  2134. </summary>
  2135. <param name="response">The response message.</param>
  2136. </member>
  2137. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetCallbackArgument(System.String)">
  2138. <summary>
  2139. Gets a callback argument's value that was previously added using
  2140. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.
  2141. </summary>
  2142. <param name="key">The name of the parameter whose value is sought.</param>
  2143. <returns>
  2144. The value of the argument, or null if the named parameter could not be found.
  2145. </returns>
  2146. <remarks>
  2147. Callback parameters are only available if they are complete and untampered with
  2148. since the original request message (as proven by a signature).
  2149. If the relying party is operating in stateless mode <c>null</c> is always
  2150. returned since the callback arguments could not be signed to protect against
  2151. tampering.
  2152. </remarks>
  2153. </member>
  2154. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetUntrustedCallbackArgument(System.String)">
  2155. <summary>
  2156. Gets a callback argument's value that was previously added using
  2157. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.
  2158. </summary>
  2159. <param name="key">The name of the parameter whose value is sought.</param>
  2160. <returns>
  2161. The value of the argument, or null if the named parameter could not be found.
  2162. </returns>
  2163. <remarks>
  2164. Callback parameters are only available even if the RP is in stateless mode,
  2165. or the callback parameters are otherwise unverifiable as untampered with.
  2166. Therefore, use this method only when the callback argument is not to be
  2167. used to make a security-sensitive decision.
  2168. </remarks>
  2169. </member>
  2170. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetCallbackArguments">
  2171. <summary>
  2172. Gets all the callback arguments that were previously added using
  2173. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/> or as a natural part
  2174. of the return_to URL.
  2175. </summary>
  2176. <returns>A name-value dictionary. Never null.</returns>
  2177. <remarks>
  2178. Callback parameters are only available if they are complete and untampered with
  2179. since the original request message (as proven by a signature).
  2180. If the relying party is operating in stateless mode an empty dictionary is always
  2181. returned since the callback arguments could not be signed to protect against
  2182. tampering.
  2183. </remarks>
  2184. </member>
  2185. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetUntrustedCallbackArguments">
  2186. <summary>
  2187. Gets all the callback arguments that were previously added using
  2188. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/> or as a natural part
  2189. of the return_to URL.
  2190. </summary>
  2191. <returns>A name-value dictionary. Never null.</returns>
  2192. <remarks>
  2193. Callback parameters are only available if they are complete and untampered with
  2194. since the original request message (as proven by a signature).
  2195. If the relying party is operating in stateless mode an empty dictionary is always
  2196. returned since the callback arguments could not be signed to protect against
  2197. tampering.
  2198. </remarks>
  2199. </member>
  2200. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetExtension``1">
  2201. <summary>
  2202. Tries to get an OpenID extension that may be present in the response.
  2203. </summary>
  2204. <typeparam name="T">The type of extension to look for in the response message.</typeparam>
  2205. <returns>
  2206. The extension, if it is found. Null otherwise.
  2207. </returns>
  2208. <remarks>
  2209. <para>Extensions are returned only if the Provider signed them.
  2210. Relying parties that do not care if the values were modified in
  2211. transit should use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetUntrustedExtension``1"/> method
  2212. in order to allow the Provider to not sign the extension. </para>
  2213. <para>Unsigned extensions are completely unreliable and should be
  2214. used only to prefill user forms since the user or any other third
  2215. party may have tampered with the data carried by the extension.</para>
  2216. <para>Signed extensions are only reliable if the relying party
  2217. trusts the OpenID Provider that signed them. Signing does not mean
  2218. the relying party can trust the values -- it only means that the values
  2219. have not been tampered with since the Provider sent the message.</para>
  2220. </remarks>
  2221. </member>
  2222. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetExtension(System.Type)">
  2223. <summary>
  2224. Tries to get an OpenID extension that may be present in the response.
  2225. </summary>
  2226. <param name="extensionType">Type of the extension to look for in the response.</param>
  2227. <returns>
  2228. The extension, if it is found. Null otherwise.
  2229. </returns>
  2230. <remarks>
  2231. <para>Extensions are returned only if the Provider signed them.
  2232. Relying parties that do not care if the values were modified in
  2233. transit should use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetUntrustedExtension(System.Type)"/> method
  2234. in order to allow the Provider to not sign the extension. </para>
  2235. <para>Unsigned extensions are completely unreliable and should be
  2236. used only to prefill user forms since the user or any other third
  2237. party may have tampered with the data carried by the extension.</para>
  2238. <para>Signed extensions are only reliable if the relying party
  2239. trusts the OpenID Provider that signed them. Signing does not mean
  2240. the relying party can trust the values -- it only means that the values
  2241. have not been tampered with since the Provider sent the message.</para>
  2242. </remarks>
  2243. </member>
  2244. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetUntrustedExtension``1">
  2245. <summary>
  2246. Tries to get an OpenID extension that may be present in the response, without
  2247. requiring it to be signed by the Provider.
  2248. </summary>
  2249. <typeparam name="T">The type of extension to look for in the response message.</typeparam>
  2250. <returns>
  2251. The extension, if it is found. Null otherwise.
  2252. </returns>
  2253. <remarks>
  2254. <para>Extensions are returned whether they are signed or not.
  2255. Use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetExtension``1"/> method to retrieve
  2256. extension responses only if they are signed by the Provider to
  2257. protect against tampering. </para>
  2258. <para>Unsigned extensions are completely unreliable and should be
  2259. used only to prefill user forms since the user or any other third
  2260. party may have tampered with the data carried by the extension.</para>
  2261. <para>Signed extensions are only reliable if the relying party
  2262. trusts the OpenID Provider that signed them. Signing does not mean
  2263. the relying party can trust the values -- it only means that the values
  2264. have not been tampered with since the Provider sent the message.</para>
  2265. </remarks>
  2266. </member>
  2267. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetUntrustedExtension(System.Type)">
  2268. <summary>
  2269. Tries to get an OpenID extension that may be present in the response.
  2270. </summary>
  2271. <param name="extensionType">Type of the extension to look for in the response.</param>
  2272. <returns>
  2273. The extension, if it is found. Null otherwise.
  2274. </returns>
  2275. <remarks>
  2276. <para>Extensions are returned whether they are signed or not.
  2277. Use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.GetExtension(System.Type)"/> method to retrieve
  2278. extension responses only if they are signed by the Provider to
  2279. protect against tampering. </para>
  2280. <para>Unsigned extensions are completely unreliable and should be
  2281. used only to prefill user forms since the user or any other third
  2282. party may have tampered with the data carried by the extension.</para>
  2283. <para>Signed extensions are only reliable if the relying party
  2284. trusts the OpenID Provider that signed them. Signing does not mean
  2285. the relying party can trust the values -- it only means that the values
  2286. have not been tampered with since the Provider sent the message.</para>
  2287. </remarks>
  2288. </member>
  2289. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.ClaimedIdentifier">
  2290. <summary>
  2291. Gets the Identifier that the end user claims to own. For use with user database storage and lookup.
  2292. May be null for some failed authentications (i.e. failed directed identity authentications).
  2293. </summary>
  2294. <remarks>
  2295. <para>
  2296. This is the secure identifier that should be used for database storage and lookup.
  2297. It is not always friendly (i.e. =Arnott becomes =!9B72.7DD1.50A9.5CCD), but it protects
  2298. user identities against spoofing and other attacks.
  2299. </para>
  2300. <para>
  2301. For user-friendly identifiers to display, use the
  2302. <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.FriendlyIdentifierForDisplay"/> property.
  2303. </para>
  2304. </remarks>
  2305. </member>
  2306. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.FriendlyIdentifierForDisplay">
  2307. <summary>
  2308. Gets a user-friendly OpenID Identifier for display purposes ONLY.
  2309. </summary>
  2310. <value></value>
  2311. <remarks>
  2312. <para>
  2313. This <i>should</i> be put through <see cref="M:System.Web.HttpUtility.HtmlEncode(System.String)"/> before
  2314. sending to a browser to secure against javascript injection attacks.
  2315. </para>
  2316. <para>
  2317. This property retains some aspects of the user-supplied identifier that get lost
  2318. in the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.ClaimedIdentifier"/>. For example, XRIs used as user-supplied
  2319. identifiers (i.e. =Arnott) become unfriendly unique strings (i.e. =!9B72.7DD1.50A9.5CCD).
  2320. For display purposes, such as text on a web page that says "You're logged in as ...",
  2321. this property serves to provide the =Arnott string, or whatever else is the most friendly
  2322. string close to what the user originally typed in.
  2323. </para>
  2324. <para>
  2325. If the user-supplied identifier is a URI, this property will be the URI after all
  2326. redirects, and with the protocol and fragment trimmed off.
  2327. If the user-supplied identifier is an XRI, this property will be the original XRI.
  2328. If the user-supplied identifier is an OpenID Provider identifier (i.e. yahoo.com),
  2329. this property will be the Claimed Identifier, with the protocol stripped if it is a URI.
  2330. </para>
  2331. <para>
  2332. It is <b>very</b> important that this property <i>never</i> be used for database storage
  2333. or lookup to avoid identity spoofing and other security risks. For database storage
  2334. and lookup please use the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.ClaimedIdentifier"/> property.
  2335. </para>
  2336. </remarks>
  2337. </member>
  2338. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.Status">
  2339. <summary>
  2340. Gets the detailed success or failure status of the authentication attempt.
  2341. </summary>
  2342. </member>
  2343. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.Provider">
  2344. <summary>
  2345. Gets information about the OpenId Provider, as advertised by the
  2346. OpenID discovery documents found at the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.ClaimedIdentifier"/>
  2347. location.
  2348. </summary>
  2349. <value>
  2350. The Provider endpoint that issued the positive assertion;
  2351. or <c>null</c> if information about the Provider is unavailable.
  2352. </value>
  2353. </member>
  2354. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.Exception">
  2355. <summary>
  2356. Gets the details regarding a failed authentication attempt, if available.
  2357. This will be set if and only if <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.Status"/> is <see cref="F:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationStatus.Failed"/>.
  2358. </summary>
  2359. <value></value>
  2360. </member>
  2361. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.TrustedCallbackArgumentsAvailable">
  2362. <summary>
  2363. Gets a value indicating whether trusted callback arguments are available.
  2364. </summary>
  2365. <remarks>
  2366. We use this internally to avoid logging a warning during a standard snapshot creation.
  2367. </remarks>
  2368. </member>
  2369. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAnonymousResponse.Response">
  2370. <summary>
  2371. Gets the positive extension-only message the Relying Party received that this instance wraps.
  2372. </summary>
  2373. </member>
  2374. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse">
  2375. <summary>
  2376. Wraps a positive assertion response in an <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse"/> instance
  2377. for public consumption by the host web site.
  2378. </summary>
  2379. </member>
  2380. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse.#ctor(DotNetOpenAuth.OpenId.Messages.PositiveAssertionResponse,DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty)">
  2381. <summary>
  2382. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse"/> class.
  2383. </summary>
  2384. <param name="response">The positive assertion response that was just received by the Relying Party.</param>
  2385. <param name="relyingParty">The relying party.</param>
  2386. </member>
  2387. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse.VerifyDiscoveryMatchesAssertion(DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty)">
  2388. <summary>
  2389. Verifies that the positive assertion data matches the results of
  2390. discovery on the Claimed Identifier.
  2391. </summary>
  2392. <param name="relyingParty">The relying party.</param>
  2393. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">
  2394. Thrown when the Provider is asserting that a user controls an Identifier
  2395. when discovery on that Identifier contradicts what the Provider says.
  2396. This would be an indication of either a misconfigured Provider or
  2397. an attempt by someone to spoof another user's identity with a rogue Provider.
  2398. </exception>
  2399. </member>
  2400. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse.ClaimedIdentifier">
  2401. <summary>
  2402. Gets the Identifier that the end user claims to own. For use with user database storage and lookup.
  2403. May be null for some failed authentications (i.e. failed directed identity authentications).
  2404. </summary>
  2405. <value></value>
  2406. <remarks>
  2407. <para>
  2408. This is the secure identifier that should be used for database storage and lookup.
  2409. It is not always friendly (i.e. =Arnott becomes =!9B72.7DD1.50A9.5CCD), but it protects
  2410. user identities against spoofing and other attacks.
  2411. </para>
  2412. <para>
  2413. For user-friendly identifiers to display, use the
  2414. <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse.FriendlyIdentifierForDisplay"/> property.
  2415. </para>
  2416. </remarks>
  2417. </member>
  2418. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse.FriendlyIdentifierForDisplay">
  2419. <summary>
  2420. Gets a user-friendly OpenID Identifier for display purposes ONLY.
  2421. </summary>
  2422. <remarks>
  2423. <para>
  2424. This <i>should</i> be put through <see cref="M:System.Web.HttpUtility.HtmlEncode(System.String)"/> before
  2425. sending to a browser to secure against javascript injection attacks.
  2426. </para>
  2427. <para>
  2428. This property retains some aspects of the user-supplied identifier that get lost
  2429. in the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse.ClaimedIdentifier"/>. For example, XRIs used as user-supplied
  2430. identifiers (i.e. =Arnott) become unfriendly unique strings (i.e. =!9B72.7DD1.50A9.5CCD).
  2431. For display purposes, such as text on a web page that says "You're logged in as ...",
  2432. this property serves to provide the =Arnott string, or whatever else is the most friendly
  2433. string close to what the user originally typed in.
  2434. </para>
  2435. <para>
  2436. If the user-supplied identifier is a URI, this property will be the URI after all
  2437. redirects, and with the protocol and fragment trimmed off.
  2438. If the user-supplied identifier is an XRI, this property will be the original XRI.
  2439. If the user-supplied identifier is an OpenID Provider identifier (i.e. yahoo.com),
  2440. this property will be the Claimed Identifier, with the protocol stripped if it is a URI.
  2441. </para>
  2442. <para>
  2443. It is <b>very</b> important that this property <i>never</i> be used for database storage
  2444. or lookup to avoid identity spoofing and other security risks. For database storage
  2445. and lookup please use the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse.ClaimedIdentifier"/> property.
  2446. </para>
  2447. </remarks>
  2448. </member>
  2449. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse.Status">
  2450. <summary>
  2451. Gets the detailed success or failure status of the authentication attempt.
  2452. </summary>
  2453. </member>
  2454. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse.Endpoint">
  2455. <summary>
  2456. Gets the OpenID service endpoint reconstructed from the assertion message.
  2457. </summary>
  2458. <remarks>
  2459. This information is straight from the Provider, and therefore must not
  2460. be trusted until verified as matching the discovery information for
  2461. the claimed identifier to avoid a Provider asserting an Identifier
  2462. for which it has no authority.
  2463. </remarks>
  2464. </member>
  2465. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponse.Response">
  2466. <summary>
  2467. Gets the positive assertion response message.
  2468. </summary>
  2469. </member>
  2470. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse">
  2471. <summary>
  2472. Wraps a failed authentication response in an <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse"/> instance
  2473. for public consumption by the host web site.
  2474. </summary>
  2475. </member>
  2476. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.#ctor(System.Exception)">
  2477. <summary>
  2478. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse"/> class.
  2479. </summary>
  2480. <param name="exception">The exception that resulted in the failed authentication.</param>
  2481. </member>
  2482. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetCallbackArguments">
  2483. <summary>
  2484. Gets all the callback arguments that were previously added using
  2485. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/> or as a natural part
  2486. of the return_to URL.
  2487. </summary>
  2488. <returns>A name-value dictionary. Never null.</returns>
  2489. <remarks>
  2490. <para>This MAY return any argument on the querystring that came with the authentication response,
  2491. which may include parameters not explicitly added using
  2492. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.</para>
  2493. <para>Note that these values are NOT protected against tampering in transit.</para>
  2494. </remarks>
  2495. </member>
  2496. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetUntrustedCallbackArguments">
  2497. <summary>
  2498. Gets all the callback arguments that were previously added using
  2499. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/> or as a natural part
  2500. of the return_to URL.
  2501. </summary>
  2502. <returns>A name-value dictionary. Never null.</returns>
  2503. <remarks>
  2504. Callback parameters are only available even if the RP is in stateless mode,
  2505. or the callback parameters are otherwise unverifiable as untampered with.
  2506. Therefore, use this method only when the callback argument is not to be
  2507. used to make a security-sensitive decision.
  2508. </remarks>
  2509. </member>
  2510. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetCallbackArgument(System.String)">
  2511. <summary>
  2512. Gets a callback argument's value that was previously added using
  2513. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.
  2514. </summary>
  2515. <param name="key">The name of the parameter whose value is sought.</param>
  2516. <returns>
  2517. The value of the argument, or null if the named parameter could not be found.
  2518. </returns>
  2519. <remarks>
  2520. <para>This may return any argument on the querystring that came with the authentication response,
  2521. which may include parameters not explicitly added using
  2522. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.</para>
  2523. <para>Note that these values are NOT protected against tampering in transit.</para>
  2524. </remarks>
  2525. </member>
  2526. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetUntrustedCallbackArgument(System.String)">
  2527. <summary>
  2528. Gets a callback argument's value that was previously added using
  2529. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.
  2530. </summary>
  2531. <param name="key">The name of the parameter whose value is sought.</param>
  2532. <returns>
  2533. The value of the argument, or null if the named parameter could not be found.
  2534. </returns>
  2535. <remarks>
  2536. Callback parameters are only available even if the RP is in stateless mode,
  2537. or the callback parameters are otherwise unverifiable as untampered with.
  2538. Therefore, use this method only when the callback argument is not to be
  2539. used to make a security-sensitive decision.
  2540. </remarks>
  2541. </member>
  2542. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetExtension``1">
  2543. <summary>
  2544. Tries to get an OpenID extension that may be present in the response.
  2545. </summary>
  2546. <typeparam name="T">The type of extension to look for in the response message.</typeparam>
  2547. <returns>
  2548. The extension, if it is found. Null otherwise.
  2549. </returns>
  2550. <remarks>
  2551. <para>Extensions are returned only if the Provider signed them.
  2552. Relying parties that do not care if the values were modified in
  2553. transit should use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetUntrustedExtension``1"/> method
  2554. in order to allow the Provider to not sign the extension. </para>
  2555. <para>Unsigned extensions are completely unreliable and should be
  2556. used only to prefill user forms since the user or any other third
  2557. party may have tampered with the data carried by the extension.</para>
  2558. <para>Signed extensions are only reliable if the relying party
  2559. trusts the OpenID Provider that signed them. Signing does not mean
  2560. the relying party can trust the values -- it only means that the values
  2561. have not been tampered with since the Provider sent the message.</para>
  2562. </remarks>
  2563. </member>
  2564. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetExtension(System.Type)">
  2565. <summary>
  2566. Tries to get an OpenID extension that may be present in the response.
  2567. </summary>
  2568. <param name="extensionType">Type of the extension to look for in the response.</param>
  2569. <returns>
  2570. The extension, if it is found. Null otherwise.
  2571. </returns>
  2572. <remarks>
  2573. <para>Extensions are returned only if the Provider signed them.
  2574. Relying parties that do not care if the values were modified in
  2575. transit should use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetUntrustedExtension(System.Type)"/> method
  2576. in order to allow the Provider to not sign the extension. </para>
  2577. <para>Unsigned extensions are completely unreliable and should be
  2578. used only to prefill user forms since the user or any other third
  2579. party may have tampered with the data carried by the extension.</para>
  2580. <para>Signed extensions are only reliable if the relying party
  2581. trusts the OpenID Provider that signed them. Signing does not mean
  2582. the relying party can trust the values -- it only means that the values
  2583. have not been tampered with since the Provider sent the message.</para>
  2584. </remarks>
  2585. </member>
  2586. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetUntrustedExtension``1">
  2587. <summary>
  2588. Tries to get an OpenID extension that may be present in the response, without
  2589. requiring it to be signed by the Provider.
  2590. </summary>
  2591. <typeparam name="T">The type of extension to look for in the response message.</typeparam>
  2592. <returns>
  2593. The extension, if it is found. Null otherwise.
  2594. </returns>
  2595. <remarks>
  2596. <para>Extensions are returned whether they are signed or not.
  2597. Use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetExtension``1"/> method to retrieve
  2598. extension responses only if they are signed by the Provider to
  2599. protect against tampering. </para>
  2600. <para>Unsigned extensions are completely unreliable and should be
  2601. used only to prefill user forms since the user or any other third
  2602. party may have tampered with the data carried by the extension.</para>
  2603. <para>Signed extensions are only reliable if the relying party
  2604. trusts the OpenID Provider that signed them. Signing does not mean
  2605. the relying party can trust the values -- it only means that the values
  2606. have not been tampered with since the Provider sent the message.</para>
  2607. </remarks>
  2608. </member>
  2609. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetUntrustedExtension(System.Type)">
  2610. <summary>
  2611. Tries to get an OpenID extension that may be present in the response.
  2612. </summary>
  2613. <param name="extensionType">Type of the extension to look for in the response.</param>
  2614. <returns>
  2615. The extension, if it is found. Null otherwise.
  2616. </returns>
  2617. <remarks>
  2618. <para>Extensions are returned whether they are signed or not.
  2619. Use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.GetExtension(System.Type)"/> method to retrieve
  2620. extension responses only if they are signed by the Provider to
  2621. protect against tampering. </para>
  2622. <para>Unsigned extensions are completely unreliable and should be
  2623. used only to prefill user forms since the user or any other third
  2624. party may have tampered with the data carried by the extension.</para>
  2625. <para>Signed extensions are only reliable if the relying party
  2626. trusts the OpenID Provider that signed them. Signing does not mean
  2627. the relying party can trust the values -- it only means that the values
  2628. have not been tampered with since the Provider sent the message.</para>
  2629. </remarks>
  2630. </member>
  2631. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.ClaimedIdentifier">
  2632. <summary>
  2633. Gets the Identifier that the end user claims to own. For use with user database storage and lookup.
  2634. May be null for some failed authentications (i.e. failed directed identity authentications).
  2635. </summary>
  2636. <value></value>
  2637. <remarks>
  2638. <para>
  2639. This is the secure identifier that should be used for database storage and lookup.
  2640. It is not always friendly (i.e. =Arnott becomes =!9B72.7DD1.50A9.5CCD), but it protects
  2641. user identities against spoofing and other attacks.
  2642. </para>
  2643. <para>
  2644. For user-friendly identifiers to display, use the
  2645. <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.FriendlyIdentifierForDisplay"/> property.
  2646. </para>
  2647. </remarks>
  2648. </member>
  2649. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.FriendlyIdentifierForDisplay">
  2650. <summary>
  2651. Gets a user-friendly OpenID Identifier for display purposes ONLY.
  2652. </summary>
  2653. <value></value>
  2654. <remarks>
  2655. <para>
  2656. This <i>should</i> be put through <see cref="M:System.Web.HttpUtility.HtmlEncode(System.String)"/> before
  2657. sending to a browser to secure against javascript injection attacks.
  2658. </para>
  2659. <para>
  2660. This property retains some aspects of the user-supplied identifier that get lost
  2661. in the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.ClaimedIdentifier"/>. For example, XRIs used as user-supplied
  2662. identifiers (i.e. =Arnott) become unfriendly unique strings (i.e. =!9B72.7DD1.50A9.5CCD).
  2663. For display purposes, such as text on a web page that says "You're logged in as ...",
  2664. this property serves to provide the =Arnott string, or whatever else is the most friendly
  2665. string close to what the user originally typed in.
  2666. </para>
  2667. <para>
  2668. If the user-supplied identifier is a URI, this property will be the URI after all
  2669. redirects, and with the protocol and fragment trimmed off.
  2670. If the user-supplied identifier is an XRI, this property will be the original XRI.
  2671. If the user-supplied identifier is an OpenID Provider identifier (i.e. yahoo.com),
  2672. this property will be the Claimed Identifier, with the protocol stripped if it is a URI.
  2673. </para>
  2674. <para>
  2675. It is <b>very</b> important that this property <i>never</i> be used for database storage
  2676. or lookup to avoid identity spoofing and other security risks. For database storage
  2677. and lookup please use the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.ClaimedIdentifier"/> property.
  2678. </para>
  2679. </remarks>
  2680. </member>
  2681. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.Status">
  2682. <summary>
  2683. Gets the detailed success or failure status of the authentication attempt.
  2684. </summary>
  2685. <value></value>
  2686. </member>
  2687. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.Provider">
  2688. <summary>
  2689. Gets information about the OpenId Provider, as advertised by the
  2690. OpenID discovery documents found at the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.ClaimedIdentifier"/>
  2691. location.
  2692. </summary>
  2693. <value>
  2694. The Provider endpoint that issued the positive assertion;
  2695. or <c>null</c> if information about the Provider is unavailable.
  2696. </value>
  2697. </member>
  2698. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.Exception">
  2699. <summary>
  2700. Gets the details regarding a failed authentication attempt, if available.
  2701. This will be set if and only if <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.FailedAuthenticationResponse.Status"/> is <see cref="F:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationStatus.Failed"/>.
  2702. </summary>
  2703. </member>
  2704. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.ISetupRequiredAuthenticationResponseContract">
  2705. <summary>
  2706. Code contract class for the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.ISetupRequiredAuthenticationResponse"/> type.
  2707. </summary>
  2708. </member>
  2709. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.ISetupRequiredAuthenticationResponseContract.#ctor">
  2710. <summary>
  2711. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.ISetupRequiredAuthenticationResponseContract"/> class.
  2712. </summary>
  2713. </member>
  2714. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.ISetupRequiredAuthenticationResponseContract.DotNetOpenAuth#OpenId#RelyingParty#ISetupRequiredAuthenticationResponse#UserSuppliedIdentifier">
  2715. <summary>
  2716. Gets the <see cref="T:DotNetOpenAuth.OpenId.Identifier"/> to pass to <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CreateRequest(DotNetOpenAuth.OpenId.Identifier)"/>
  2717. in a subsequent authentication attempt.
  2718. </summary>
  2719. </member>
  2720. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.EndpointSelector">
  2721. <summary>
  2722. A delegate that decides whether a given OpenID Provider endpoint may be
  2723. considered for authenticating a user.
  2724. </summary>
  2725. <param name="endpoint">The endpoint for consideration.</param>
  2726. <returns>
  2727. <c>True</c> if the endpoint should be considered.
  2728. <c>False</c> to remove it from the pool of acceptable providers.
  2729. </returns>
  2730. </member>
  2731. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty">
  2732. <summary>
  2733. Provides the programmatic facilities to act as an OpenID relying party.
  2734. </summary>
  2735. </member>
  2736. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.ApplicationStoreKey">
  2737. <summary>
  2738. The name of the key to use in the HttpApplication cache to store the
  2739. instance of <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore"/> to use.
  2740. </summary>
  2741. </member>
  2742. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.behaviors">
  2743. <summary>
  2744. Backing store for the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.Behaviors"/> property.
  2745. </summary>
  2746. </member>
  2747. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.discoveryServices">
  2748. <summary>
  2749. The discovery services to use for identifiers.
  2750. </summary>
  2751. </member>
  2752. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.nonVerifyingRelyingParty">
  2753. <summary>
  2754. Backing field for the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.NonVerifyingRelyingParty"/> property.
  2755. </summary>
  2756. </member>
  2757. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.nonVerifyingRelyingPartyInitLock">
  2758. <summary>
  2759. The lock to obtain when initializing the <see cref="F:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.nonVerifyingRelyingParty"/> member.
  2760. </summary>
  2761. </member>
  2762. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.clientScriptExtensions">
  2763. <summary>
  2764. A dictionary of extension response types and the javascript member
  2765. name to map them to on the user agent.
  2766. </summary>
  2767. </member>
  2768. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.securitySettings">
  2769. <summary>
  2770. Backing field for the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.SecuritySettings"/> property.
  2771. </summary>
  2772. </member>
  2773. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.endpointOrder">
  2774. <summary>
  2775. Backing store for the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.EndpointOrder"/> property.
  2776. </summary>
  2777. </member>
  2778. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.channel">
  2779. <summary>
  2780. Backing field for the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.Channel"/> property.
  2781. </summary>
  2782. </member>
  2783. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.#ctor">
  2784. <summary>
  2785. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty"/> class.
  2786. </summary>
  2787. </member>
  2788. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.#ctor(DotNetOpenAuth.OpenId.IOpenIdApplicationStore)">
  2789. <summary>
  2790. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty"/> class.
  2791. </summary>
  2792. <param name="applicationStore">The application store. If <c>null</c>, the relying party will always operate in "stateless/dumb mode".</param>
  2793. </member>
  2794. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.#ctor(DotNetOpenAuth.Messaging.Bindings.ICryptoKeyStore,DotNetOpenAuth.Messaging.Bindings.INonceStore)">
  2795. <summary>
  2796. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty"/> class.
  2797. </summary>
  2798. <param name="cryptoKeyStore">The association store. If <c>null</c>, the relying party will always operate in "stateless/dumb mode".</param>
  2799. <param name="nonceStore">The nonce store to use. If <c>null</c>, the relying party will always operate in "stateless/dumb mode".</param>
  2800. </member>
  2801. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CreateRequest(DotNetOpenAuth.OpenId.Identifier,DotNetOpenAuth.OpenId.Realm,System.Uri)">
  2802. <summary>
  2803. Creates an authentication request to verify that a user controls
  2804. some given Identifier.
  2805. </summary>
  2806. <param name="userSuppliedIdentifier">
  2807. The Identifier supplied by the user. This may be a URL, an XRI or i-name.
  2808. </param>
  2809. <param name="realm">
  2810. The shorest URL that describes this relying party web site's address.
  2811. For example, if your login page is found at https://www.example.com/login.aspx,
  2812. your realm would typically be https://www.example.com/.
  2813. </param>
  2814. <param name="returnToUrl">
  2815. The URL of the login page, or the page prepared to receive authentication
  2816. responses from the OpenID Provider.
  2817. </param>
  2818. <returns>
  2819. An authentication request object to customize the request and generate
  2820. an object to send to the user agent to initiate the authentication.
  2821. </returns>
  2822. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if no OpenID endpoint could be found.</exception>
  2823. </member>
  2824. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CreateRequest(DotNetOpenAuth.OpenId.Identifier,DotNetOpenAuth.OpenId.Realm)">
  2825. <summary>
  2826. Creates an authentication request to verify that a user controls
  2827. some given Identifier.
  2828. </summary>
  2829. <param name="userSuppliedIdentifier">
  2830. The Identifier supplied by the user. This may be a URL, an XRI or i-name.
  2831. </param>
  2832. <param name="realm">
  2833. The shorest URL that describes this relying party web site's address.
  2834. For example, if your login page is found at https://www.example.com/login.aspx,
  2835. your realm would typically be https://www.example.com/.
  2836. </param>
  2837. <returns>
  2838. An authentication request object that describes the HTTP response to
  2839. send to the user agent to initiate the authentication.
  2840. </returns>
  2841. <remarks>
  2842. <para>Requires an <see cref="P:System.Web.HttpContext.Current">HttpContext.Current</see> context.</para>
  2843. </remarks>
  2844. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if no OpenID endpoint could be found.</exception>
  2845. <exception cref="T:System.InvalidOperationException">Thrown if <see cref="P:System.Web.HttpContext.Current">HttpContext.Current</see> == <c>null</c>.</exception>
  2846. </member>
  2847. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CreateRequest(DotNetOpenAuth.OpenId.Identifier)">
  2848. <summary>
  2849. Creates an authentication request to verify that a user controls
  2850. some given Identifier.
  2851. </summary>
  2852. <param name="userSuppliedIdentifier">
  2853. The Identifier supplied by the user. This may be a URL, an XRI or i-name.
  2854. </param>
  2855. <returns>
  2856. An authentication request object that describes the HTTP response to
  2857. send to the user agent to initiate the authentication.
  2858. </returns>
  2859. <remarks>
  2860. <para>Requires an <see cref="P:System.Web.HttpContext.Current">HttpContext.Current</see> context.</para>
  2861. </remarks>
  2862. <exception cref="T:DotNetOpenAuth.Messaging.ProtocolException">Thrown if no OpenID endpoint could be found.</exception>
  2863. <exception cref="T:System.InvalidOperationException">Thrown if <see cref="P:System.Web.HttpContext.Current">HttpContext.Current</see> == <c>null</c>.</exception>
  2864. </member>
  2865. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CreateRequests(DotNetOpenAuth.OpenId.Identifier,DotNetOpenAuth.OpenId.Realm,System.Uri)">
  2866. <summary>
  2867. Generates the authentication requests that can satisfy the requirements of some OpenID Identifier.
  2868. </summary>
  2869. <param name="userSuppliedIdentifier">
  2870. The Identifier supplied by the user. This may be a URL, an XRI or i-name.
  2871. </param>
  2872. <param name="realm">
  2873. The shorest URL that describes this relying party web site's address.
  2874. For example, if your login page is found at https://www.example.com/login.aspx,
  2875. your realm would typically be https://www.example.com/.
  2876. </param>
  2877. <param name="returnToUrl">
  2878. The URL of the login page, or the page prepared to receive authentication
  2879. responses from the OpenID Provider.
  2880. </param>
  2881. <returns>
  2882. A sequence of authentication requests, any of which constitutes a valid identity assertion on the Claimed Identifier.
  2883. Never null, but may be empty.
  2884. </returns>
  2885. <remarks>
  2886. <para>Any individual generated request can satisfy the authentication.
  2887. The generated requests are sorted in preferred order.
  2888. Each request is generated as it is enumerated to. Associations are created only as
  2889. <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.RedirectingResponse"/> is called.</para>
  2890. <para>No exception is thrown if no OpenID endpoints were discovered.
  2891. An empty enumerable is returned instead.</para>
  2892. </remarks>
  2893. </member>
  2894. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CreateRequests(DotNetOpenAuth.OpenId.Identifier,DotNetOpenAuth.OpenId.Realm)">
  2895. <summary>
  2896. Generates the authentication requests that can satisfy the requirements of some OpenID Identifier.
  2897. </summary>
  2898. <param name="userSuppliedIdentifier">
  2899. The Identifier supplied by the user. This may be a URL, an XRI or i-name.
  2900. </param>
  2901. <param name="realm">
  2902. The shorest URL that describes this relying party web site's address.
  2903. For example, if your login page is found at https://www.example.com/login.aspx,
  2904. your realm would typically be https://www.example.com/.
  2905. </param>
  2906. <returns>
  2907. A sequence of authentication requests, any of which constitutes a valid identity assertion on the Claimed Identifier.
  2908. Never null, but may be empty.
  2909. </returns>
  2910. <remarks>
  2911. <para>Any individual generated request can satisfy the authentication.
  2912. The generated requests are sorted in preferred order.
  2913. Each request is generated as it is enumerated to. Associations are created only as
  2914. <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.RedirectingResponse"/> is called.</para>
  2915. <para>No exception is thrown if no OpenID endpoints were discovered.
  2916. An empty enumerable is returned instead.</para>
  2917. <para>Requires an <see cref="P:System.Web.HttpContext.Current">HttpContext.Current</see> context.</para>
  2918. </remarks>
  2919. <exception cref="T:System.InvalidOperationException">Thrown if <see cref="P:System.Web.HttpContext.Current">HttpContext.Current</see> == <c>null</c>.</exception>
  2920. </member>
  2921. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CreateRequests(DotNetOpenAuth.OpenId.Identifier)">
  2922. <summary>
  2923. Generates the authentication requests that can satisfy the requirements of some OpenID Identifier.
  2924. </summary>
  2925. <param name="userSuppliedIdentifier">
  2926. The Identifier supplied by the user. This may be a URL, an XRI or i-name.
  2927. </param>
  2928. <returns>
  2929. A sequence of authentication requests, any of which constitutes a valid identity assertion on the Claimed Identifier.
  2930. Never null, but may be empty.
  2931. </returns>
  2932. <remarks>
  2933. <para>Any individual generated request can satisfy the authentication.
  2934. The generated requests are sorted in preferred order.
  2935. Each request is generated as it is enumerated to. Associations are created only as
  2936. <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.RedirectingResponse"/> is called.</para>
  2937. <para>No exception is thrown if no OpenID endpoints were discovered.
  2938. An empty enumerable is returned instead.</para>
  2939. <para>Requires an <see cref="P:System.Web.HttpContext.Current">HttpContext.Current</see> context.</para>
  2940. </remarks>
  2941. <exception cref="T:System.InvalidOperationException">Thrown if <see cref="P:System.Web.HttpContext.Current">HttpContext.Current</see> == <c>null</c>.</exception>
  2942. </member>
  2943. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.GetResponse">
  2944. <summary>
  2945. Gets an authentication response from a Provider.
  2946. </summary>
  2947. <returns>The processed authentication response if there is any; <c>null</c> otherwise.</returns>
  2948. <remarks>
  2949. <para>Requires an <see cref="P:System.Web.HttpContext.Current">HttpContext.Current</see> context.</para>
  2950. </remarks>
  2951. </member>
  2952. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.GetResponse(System.Web.HttpRequestBase)">
  2953. <summary>
  2954. Gets an authentication response from a Provider.
  2955. </summary>
  2956. <param name="httpRequestInfo">The HTTP request that may be carrying an authentication response from the Provider.</param>
  2957. <returns>The processed authentication response if there is any; <c>null</c> otherwise.</returns>
  2958. </member>
  2959. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.ProcessResponseFromPopup">
  2960. <summary>
  2961. Processes the response received in a popup window or iframe to an AJAX-directed OpenID authentication.
  2962. </summary>
  2963. <returns>The HTTP response to send to this HTTP request.</returns>
  2964. <remarks>
  2965. <para>Requires an <see cref="P:System.Web.HttpContext.Current">HttpContext.Current</see> context.</para>
  2966. </remarks>
  2967. </member>
  2968. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.ProcessResponseFromPopup(System.Web.HttpRequestBase)">
  2969. <summary>
  2970. Processes the response received in a popup window or iframe to an AJAX-directed OpenID authentication.
  2971. </summary>
  2972. <param name="request">The incoming HTTP request that is expected to carry an OpenID authentication response.</param>
  2973. <returns>The HTTP response to send to this HTTP request.</returns>
  2974. </member>
  2975. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.RegisterClientScriptExtension``1(System.String)">
  2976. <summary>
  2977. Allows an OpenID extension to read data out of an unverified positive authentication assertion
  2978. and send it down to the client browser so that Javascript running on the page can perform
  2979. some preprocessing on the extension data.
  2980. </summary>
  2981. <typeparam name="T">The extension <i>response</i> type that will read data from the assertion.</typeparam>
  2982. <param name="propertyName">The property name on the openid_identifier input box object that will be used to store the extension data. For example: sreg</param>
  2983. <remarks>
  2984. This method should be called before <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.ProcessResponseFromPopup"/>.
  2985. </remarks>
  2986. </member>
  2987. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.Dispose">
  2988. <summary>
  2989. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  2990. </summary>
  2991. </member>
  2992. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.IsOpenIdSupportingParameter(System.String)">
  2993. <summary>
  2994. Determines whether some parameter name belongs to OpenID or this library
  2995. as a protocol or internal parameter name.
  2996. </summary>
  2997. <param name="parameterName">Name of the parameter.</param>
  2998. <returns>
  2999. <c>true</c> if the named parameter is a library- or protocol-specific parameter; otherwise, <c>false</c>.
  3000. </returns>
  3001. </member>
  3002. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CreateNonVerifying">
  3003. <summary>
  3004. Creates a relying party that does not verify incoming messages against
  3005. nonce or association stores.
  3006. </summary>
  3007. <returns>The instantiated <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty"/>.</returns>
  3008. <remarks>
  3009. Useful for previewing messages while
  3010. allowing them to be fully processed and verified later.
  3011. </remarks>
  3012. </member>
  3013. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.ProcessResponseFromPopup(System.Web.HttpRequestBase,System.Action{DotNetOpenAuth.OpenId.RelyingParty.AuthenticationStatus})">
  3014. <summary>
  3015. Processes the response received in a popup window or iframe to an AJAX-directed OpenID authentication.
  3016. </summary>
  3017. <param name="request">The incoming HTTP request that is expected to carry an OpenID authentication response.</param>
  3018. <param name="callback">The callback fired after the response status has been determined but before the Javascript response is formulated.</param>
  3019. <returns>
  3020. The HTTP response to send to this HTTP request.
  3021. </returns>
  3022. </member>
  3023. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.Discover(DotNetOpenAuth.OpenId.Identifier)">
  3024. <summary>
  3025. Performs discovery on the specified identifier.
  3026. </summary>
  3027. <param name="identifier">The identifier to discover services for.</param>
  3028. <returns>A non-null sequence of services discovered for the identifier.</returns>
  3029. </member>
  3030. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.FilterEndpoint(DotNetOpenAuth.OpenId.RelyingParty.IProviderEndpoint)">
  3031. <summary>
  3032. Checks whether a given OP Endpoint is permitted by the host relying party.
  3033. </summary>
  3034. <param name="endpoint">The OP endpoint.</param>
  3035. <returns><c>true</c> if the OP Endpoint is allowed; <c>false</c> otherwise.</returns>
  3036. </member>
  3037. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.Dispose(System.Boolean)">
  3038. <summary>
  3039. Releases unmanaged and - optionally - managed resources
  3040. </summary>
  3041. <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  3042. </member>
  3043. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.InvokeParentPageScript(System.String)">
  3044. <summary>
  3045. Invokes a method on a parent frame or window and closes the calling popup window if applicable.
  3046. </summary>
  3047. <param name="methodCall">The method to call on the parent window, including
  3048. parameters. (i.e. "callback('arg1', 2)"). No escaping is done by this method.</param>
  3049. <returns>The entire HTTP response to send to the popup window or iframe to perform the invocation.</returns>
  3050. </member>
  3051. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.OnBehaviorsChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)">
  3052. <summary>
  3053. Called by derived classes when behaviors are added or removed.
  3054. </summary>
  3055. <param name="sender">The collection being modified.</param>
  3056. <param name="e">The <see cref="T:System.Collections.Specialized.NotifyCollectionChangedEventArgs"/> instance containing the event data.</param>
  3057. </member>
  3058. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.DefaultEndpointOrder">
  3059. <summary>
  3060. Gets an XRDS sorting routine that uses the XRDS Service/@Priority
  3061. attribute to determine order.
  3062. </summary>
  3063. <remarks>
  3064. Endpoints lacking any priority value are sorted to the end of the list.
  3065. </remarks>
  3066. </member>
  3067. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.HttpApplicationStore">
  3068. <summary>
  3069. Gets the standard state storage mechanism that uses ASP.NET's
  3070. HttpApplication state dictionary to store associations and nonces.
  3071. </summary>
  3072. </member>
  3073. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.Channel">
  3074. <summary>
  3075. Gets or sets the channel to use for sending/receiving messages.
  3076. </summary>
  3077. </member>
  3078. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.SecuritySettings">
  3079. <summary>
  3080. Gets the security settings used by this Relying Party.
  3081. </summary>
  3082. </member>
  3083. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.DotNetOpenAuth#OpenId#IOpenIdHost#SecuritySettings">
  3084. <summary>
  3085. Gets the security settings.
  3086. </summary>
  3087. </member>
  3088. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.EndpointFilter">
  3089. <summary>
  3090. Gets or sets the optional Provider Endpoint filter to use.
  3091. </summary>
  3092. <remarks>
  3093. Provides a way to optionally filter the providers that may be used in authenticating a user.
  3094. If provided, the delegate should return true to accept an endpoint, and false to reject it.
  3095. If null, all identity providers will be accepted. This is the default.
  3096. </remarks>
  3097. </member>
  3098. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.EndpointOrder">
  3099. <summary>
  3100. Gets or sets the ordering routine that will determine which XRDS
  3101. Service element to try first
  3102. </summary>
  3103. <value>Default is <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.DefaultEndpointOrder"/>.</value>
  3104. <remarks>
  3105. This may never be null. To reset to default behavior this property
  3106. can be set to the value of <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.DefaultEndpointOrder"/>.
  3107. </remarks>
  3108. </member>
  3109. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.ExtensionFactories">
  3110. <summary>
  3111. Gets the extension factories.
  3112. </summary>
  3113. </member>
  3114. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.Behaviors">
  3115. <summary>
  3116. Gets a list of custom behaviors to apply to OpenID actions.
  3117. </summary>
  3118. <remarks>
  3119. Adding behaviors can impact the security settings of this <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty"/>
  3120. instance in ways that subsequently removing the behaviors will not reverse.
  3121. </remarks>
  3122. </member>
  3123. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.DiscoveryServices">
  3124. <summary>
  3125. Gets the list of services that can perform discovery on identifiers given to this relying party.
  3126. </summary>
  3127. </member>
  3128. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.DotNetOpenAuth#OpenId#IOpenIdHost#WebRequestHandler">
  3129. <summary>
  3130. Gets the web request handler to use for discovery and the part of
  3131. authentication where direct messages are sent to an untrusted remote party.
  3132. </summary>
  3133. </member>
  3134. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.CanSignCallbackArguments">
  3135. <summary>
  3136. Gets a value indicating whether this Relying Party can sign its return_to
  3137. parameter in outgoing authentication requests.
  3138. </summary>
  3139. </member>
  3140. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.WebRequestHandler">
  3141. <summary>
  3142. Gets the web request handler to use for discovery and the part of
  3143. authentication where direct messages are sent to an untrusted remote party.
  3144. </summary>
  3145. </member>
  3146. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.AssociationManager">
  3147. <summary>
  3148. Gets the association manager.
  3149. </summary>
  3150. </member>
  3151. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty.NonVerifyingRelyingParty">
  3152. <summary>
  3153. Gets the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.OpenIdRelyingParty"/> instance used to process authentication responses
  3154. without verifying the assertion or consuming nonces.
  3155. </summary>
  3156. </member>
  3157. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot">
  3158. <summary>
  3159. A serializable snapshot of a verified authentication message.
  3160. </summary>
  3161. </member>
  3162. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.callbackArguments">
  3163. <summary>
  3164. The callback arguments that came with the authentication response.
  3165. </summary>
  3166. </member>
  3167. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.untrustedCallbackArguments">
  3168. <summary>
  3169. The untrusted callback arguments that came with the authentication response.
  3170. </summary>
  3171. </member>
  3172. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.#ctor(DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationResponse)">
  3173. <summary>
  3174. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot"/> class.
  3175. </summary>
  3176. <param name="copyFrom">The authentication response to copy from.</param>
  3177. </member>
  3178. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetExtension``1">
  3179. <summary>
  3180. Tries to get an OpenID extension that may be present in the response.
  3181. </summary>
  3182. <typeparam name="T">The type of extension to look for in the response message.</typeparam>
  3183. <returns>
  3184. The extension, if it is found. Null otherwise.
  3185. </returns>
  3186. <remarks>
  3187. <para>Extensions are returned only if the Provider signed them.
  3188. Relying parties that do not care if the values were modified in
  3189. transit should use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetUntrustedExtension``1"/> method
  3190. in order to allow the Provider to not sign the extension. </para>
  3191. <para>Unsigned extensions are completely unreliable and should be
  3192. used only to prefill user forms since the user or any other third
  3193. party may have tampered with the data carried by the extension.</para>
  3194. <para>Signed extensions are only reliable if the relying party
  3195. trusts the OpenID Provider that signed them. Signing does not mean
  3196. the relying party can trust the values -- it only means that the values
  3197. have not been tampered with since the Provider sent the message.</para>
  3198. </remarks>
  3199. </member>
  3200. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetExtension(System.Type)">
  3201. <summary>
  3202. Tries to get an OpenID extension that may be present in the response.
  3203. </summary>
  3204. <param name="extensionType">Type of the extension to look for in the response.</param>
  3205. <returns>
  3206. The extension, if it is found. Null otherwise.
  3207. </returns>
  3208. <remarks>
  3209. <para>Extensions are returned only if the Provider signed them.
  3210. Relying parties that do not care if the values were modified in
  3211. transit should use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetUntrustedExtension(System.Type)"/> method
  3212. in order to allow the Provider to not sign the extension. </para>
  3213. <para>Unsigned extensions are completely unreliable and should be
  3214. used only to prefill user forms since the user or any other third
  3215. party may have tampered with the data carried by the extension.</para>
  3216. <para>Signed extensions are only reliable if the relying party
  3217. trusts the OpenID Provider that signed them. Signing does not mean
  3218. the relying party can trust the values -- it only means that the values
  3219. have not been tampered with since the Provider sent the message.</para>
  3220. </remarks>
  3221. </member>
  3222. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetUntrustedExtension``1">
  3223. <summary>
  3224. Tries to get an OpenID extension that may be present in the response, without
  3225. requiring it to be signed by the Provider.
  3226. </summary>
  3227. <typeparam name="T">The type of extension to look for in the response message.</typeparam>
  3228. <returns>
  3229. The extension, if it is found. Null otherwise.
  3230. </returns>
  3231. <remarks>
  3232. <para>Extensions are returned whether they are signed or not.
  3233. Use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetExtension``1"/> method to retrieve
  3234. extension responses only if they are signed by the Provider to
  3235. protect against tampering. </para>
  3236. <para>Unsigned extensions are completely unreliable and should be
  3237. used only to prefill user forms since the user or any other third
  3238. party may have tampered with the data carried by the extension.</para>
  3239. <para>Signed extensions are only reliable if the relying party
  3240. trusts the OpenID Provider that signed them. Signing does not mean
  3241. the relying party can trust the values -- it only means that the values
  3242. have not been tampered with since the Provider sent the message.</para>
  3243. </remarks>
  3244. </member>
  3245. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetUntrustedExtension(System.Type)">
  3246. <summary>
  3247. Tries to get an OpenID extension that may be present in the response.
  3248. </summary>
  3249. <param name="extensionType">Type of the extension to look for in the response.</param>
  3250. <returns>
  3251. The extension, if it is found. Null otherwise.
  3252. </returns>
  3253. <remarks>
  3254. <para>Extensions are returned whether they are signed or not.
  3255. Use the <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetExtension(System.Type)"/> method to retrieve
  3256. extension responses only if they are signed by the Provider to
  3257. protect against tampering. </para>
  3258. <para>Unsigned extensions are completely unreliable and should be
  3259. used only to prefill user forms since the user or any other third
  3260. party may have tampered with the data carried by the extension.</para>
  3261. <para>Signed extensions are only reliable if the relying party
  3262. trusts the OpenID Provider that signed them. Signing does not mean
  3263. the relying party can trust the values -- it only means that the values
  3264. have not been tampered with since the Provider sent the message.</para>
  3265. </remarks>
  3266. </member>
  3267. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetCallbackArguments">
  3268. <summary>
  3269. Gets all the callback arguments that were previously added using
  3270. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/> or as a natural part
  3271. of the return_to URL.
  3272. </summary>
  3273. <returns>A name-value dictionary. Never null.</returns>
  3274. <remarks>
  3275. <para>This MAY return any argument on the querystring that came with the authentication response,
  3276. which may include parameters not explicitly added using
  3277. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.</para>
  3278. <para>Note that these values are NOT protected against tampering in transit.</para>
  3279. </remarks>
  3280. </member>
  3281. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetUntrustedCallbackArguments">
  3282. <summary>
  3283. Gets all the callback arguments that were previously added using
  3284. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/> or as a natural part
  3285. of the return_to URL.
  3286. </summary>
  3287. <returns>A name-value dictionary. Never null.</returns>
  3288. <remarks>
  3289. Callback parameters are only available even if the RP is in stateless mode,
  3290. or the callback parameters are otherwise unverifiable as untampered with.
  3291. Therefore, use this method only when the callback argument is not to be
  3292. used to make a security-sensitive decision.
  3293. </remarks>
  3294. </member>
  3295. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetCallbackArgument(System.String)">
  3296. <summary>
  3297. Gets a callback argument's value that was previously added using
  3298. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.
  3299. </summary>
  3300. <param name="key">The name of the parameter whose value is sought.</param>
  3301. <returns>
  3302. The value of the argument, or null if the named parameter could not be found.
  3303. </returns>
  3304. <remarks>
  3305. <para>This may return any argument on the querystring that came with the authentication response,
  3306. which may include parameters not explicitly added using
  3307. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.</para>
  3308. <para>Note that these values are NOT protected against tampering in transit.</para>
  3309. </remarks>
  3310. </member>
  3311. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.GetUntrustedCallbackArgument(System.String)">
  3312. <summary>
  3313. Gets a callback argument's value that was previously added using
  3314. <see cref="M:DotNetOpenAuth.OpenId.RelyingParty.IAuthenticationRequest.AddCallbackArguments(System.String,System.String)"/>.
  3315. </summary>
  3316. <param name="key">The name of the parameter whose value is sought.</param>
  3317. <returns>
  3318. The value of the argument, or null if the named parameter could not be found.
  3319. </returns>
  3320. <remarks>
  3321. Callback parameters are only available even if the RP is in stateless mode,
  3322. or the callback parameters are otherwise unverifiable as untampered with.
  3323. Therefore, use this method only when the callback argument is not to be
  3324. used to make a security-sensitive decision.
  3325. </remarks>
  3326. </member>
  3327. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.ClaimedIdentifier">
  3328. <summary>
  3329. Gets the Identifier that the end user claims to own. For use with user database storage and lookup.
  3330. May be null for some failed authentications (i.e. failed directed identity authentications).
  3331. </summary>
  3332. <value></value>
  3333. <remarks>
  3334. <para>
  3335. This is the secure identifier that should be used for database storage and lookup.
  3336. It is not always friendly (i.e. =Arnott becomes =!9B72.7DD1.50A9.5CCD), but it protects
  3337. user identities against spoofing and other attacks.
  3338. </para>
  3339. <para>
  3340. For user-friendly identifiers to display, use the
  3341. <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.FriendlyIdentifierForDisplay"/> property.
  3342. </para>
  3343. </remarks>
  3344. </member>
  3345. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.FriendlyIdentifierForDisplay">
  3346. <summary>
  3347. Gets a user-friendly OpenID Identifier for display purposes ONLY.
  3348. </summary>
  3349. <value></value>
  3350. <remarks>
  3351. <para>
  3352. This <i>should</i> be put through <see cref="M:System.Web.HttpUtility.HtmlEncode(System.String)"/> before
  3353. sending to a browser to secure against javascript injection attacks.
  3354. </para>
  3355. <para>
  3356. This property retains some aspects of the user-supplied identifier that get lost
  3357. in the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.ClaimedIdentifier"/>. For example, XRIs used as user-supplied
  3358. identifiers (i.e. =Arnott) become unfriendly unique strings (i.e. =!9B72.7DD1.50A9.5CCD).
  3359. For display purposes, such as text on a web page that says "You're logged in as ...",
  3360. this property serves to provide the =Arnott string, or whatever else is the most friendly
  3361. string close to what the user originally typed in.
  3362. </para>
  3363. <para>
  3364. If the user-supplied identifier is a URI, this property will be the URI after all
  3365. redirects, and with the protocol and fragment trimmed off.
  3366. If the user-supplied identifier is an XRI, this property will be the original XRI.
  3367. If the user-supplied identifier is an OpenID Provider identifier (i.e. yahoo.com),
  3368. this property will be the Claimed Identifier, with the protocol stripped if it is a URI.
  3369. </para>
  3370. <para>
  3371. It is <b>very</b> important that this property <i>never</i> be used for database storage
  3372. or lookup to avoid identity spoofing and other security risks. For database storage
  3373. and lookup please use the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.ClaimedIdentifier"/> property.
  3374. </para>
  3375. </remarks>
  3376. </member>
  3377. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.Status">
  3378. <summary>
  3379. Gets the detailed success or failure status of the authentication attempt.
  3380. </summary>
  3381. <value></value>
  3382. </member>
  3383. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.Provider">
  3384. <summary>
  3385. Gets information about the OpenId Provider, as advertised by the
  3386. OpenID discovery documents found at the <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.ClaimedIdentifier"/>
  3387. location.
  3388. </summary>
  3389. <value>
  3390. The Provider endpoint that issued the positive assertion;
  3391. or <c>null</c> if information about the Provider is unavailable.
  3392. </value>
  3393. </member>
  3394. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.Exception">
  3395. <summary>
  3396. Gets the details regarding a failed authentication attempt, if available.
  3397. This will be set if and only if <see cref="P:DotNetOpenAuth.OpenId.RelyingParty.PositiveAuthenticationResponseSnapshot.Status"/> is <see cref="F:DotNetOpenAuth.OpenId.RelyingParty.AuthenticationStatus.Failed"/>.
  3398. </summary>
  3399. <value></value>
  3400. </member>
  3401. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.SimpleXrdsProviderEndpoint">
  3402. <summary>
  3403. A very simple IXrdsProviderEndpoint implementation for verifying that all positive
  3404. assertions (particularly unsolicited ones) are received from OP endpoints that
  3405. are deemed permissible by the host RP.
  3406. </summary>
  3407. </member>
  3408. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.SimpleXrdsProviderEndpoint.#ctor(DotNetOpenAuth.OpenId.Messages.PositiveAssertionResponse)">
  3409. <summary>
  3410. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.SimpleXrdsProviderEndpoint"/> class.
  3411. </summary>
  3412. <param name="positiveAssertion">The positive assertion.</param>
  3413. </member>
  3414. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.SimpleXrdsProviderEndpoint.DotNetOpenAuth#OpenId#RelyingParty#IProviderEndpoint#IsExtensionSupported``1">
  3415. <summary>
  3416. Checks whether the OpenId Identifier claims support for a given extension.
  3417. </summary>
  3418. <typeparam name="T">The extension whose support is being queried.</typeparam>
  3419. <returns>
  3420. True if support for the extension is advertised. False otherwise.
  3421. </returns>
  3422. <remarks>
  3423. Note that a true or false return value is no guarantee of a Provider's
  3424. support for or lack of support for an extension. The return value is
  3425. determined by how the authenticating user filled out his/her XRDS document only.
  3426. The only way to be sure of support for a given extension is to include
  3427. the extension in the request and see if a response comes back for that extension.
  3428. </remarks>
  3429. </member>
  3430. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.SimpleXrdsProviderEndpoint.DotNetOpenAuth#OpenId#RelyingParty#IProviderEndpoint#IsExtensionSupported(System.Type)">
  3431. <summary>
  3432. Checks whether the OpenId Identifier claims support for a given extension.
  3433. </summary>
  3434. <param name="extensionType">The extension whose support is being queried.</param>
  3435. <returns>
  3436. True if support for the extension is advertised. False otherwise.
  3437. </returns>
  3438. <remarks>
  3439. Note that a true or false return value is no guarantee of a Provider's
  3440. support for or lack of support for an extension. The return value is
  3441. determined by how the authenticating user filled out his/her XRDS document only.
  3442. The only way to be sure of support for a given extension is to include
  3443. the extension in the request and see if a response comes back for that extension.
  3444. </remarks>
  3445. </member>
  3446. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.SimpleXrdsProviderEndpoint.Version">
  3447. <summary>
  3448. Gets the detected version of OpenID implemented by the Provider.
  3449. </summary>
  3450. </member>
  3451. <member name="P:DotNetOpenAuth.OpenId.RelyingParty.SimpleXrdsProviderEndpoint.Uri">
  3452. <summary>
  3453. Gets the URL that the OpenID Provider receives authentication requests at.
  3454. </summary>
  3455. </member>
  3456. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore">
  3457. <summary>
  3458. An in-memory store for Relying Parties, suitable for single server, single process
  3459. ASP.NET web sites.
  3460. </summary>
  3461. </member>
  3462. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore.nonceStore">
  3463. <summary>
  3464. The nonce store to use.
  3465. </summary>
  3466. </member>
  3467. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore.keyStore">
  3468. <summary>
  3469. The association store to use.
  3470. </summary>
  3471. </member>
  3472. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore.#ctor">
  3473. <summary>
  3474. Initializes a new instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore"/> class.
  3475. </summary>
  3476. </member>
  3477. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore.GetKey(System.String,System.String)">
  3478. <summary>
  3479. Gets the key in a given bucket and handle.
  3480. </summary>
  3481. <param name="bucket">The bucket name. Case sensitive.</param>
  3482. <param name="handle">The key handle. Case sensitive.</param>
  3483. <returns>
  3484. The cryptographic key, or <c>null</c> if no matching key was found.
  3485. </returns>
  3486. </member>
  3487. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore.GetKeys(System.String)">
  3488. <summary>
  3489. Gets a sequence of existing keys within a given bucket.
  3490. </summary>
  3491. <param name="bucket">The bucket name. Case sensitive.</param>
  3492. <returns>
  3493. A sequence of handles and keys, ordered by descending <see cref="P:DotNetOpenAuth.Messaging.Bindings.CryptoKey.ExpiresUtc"/>.
  3494. </returns>
  3495. </member>
  3496. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore.StoreKey(System.String,System.String,DotNetOpenAuth.Messaging.Bindings.CryptoKey)">
  3497. <summary>
  3498. Stores a cryptographic key.
  3499. </summary>
  3500. <param name="bucket">The name of the bucket to store the key in. Case sensitive.</param>
  3501. <param name="handle">The handle to the key, unique within the bucket. Case sensitive.</param>
  3502. <param name="key">The key to store.</param>
  3503. <exception cref="T:DotNetOpenAuth.Messaging.Bindings.CryptoKeyCollisionException">Thrown in the event of a conflict with an existing key in the same bucket and with the same handle.</exception>
  3504. </member>
  3505. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore.RemoveKey(System.String,System.String)">
  3506. <summary>
  3507. Removes the key.
  3508. </summary>
  3509. <param name="bucket">The bucket name. Case sensitive.</param>
  3510. <param name="handle">The key handle. Case sensitive.</param>
  3511. </member>
  3512. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.StandardRelyingPartyApplicationStore.StoreNonce(System.String,System.String,System.DateTime)">
  3513. <summary>
  3514. Stores a given nonce and timestamp.
  3515. </summary>
  3516. <param name="context">The context, or namespace, within which the <paramref name="nonce"/> must be unique.</param>
  3517. <param name="nonce">A series of random characters.</param>
  3518. <param name="timestampUtc">The timestamp that together with the nonce string make it unique.
  3519. The timestamp may also be used by the data store to clear out old nonces.</param>
  3520. <returns>
  3521. True if the nonce+timestamp (combination) was not previously in the database.
  3522. False if the nonce was stored previously with the same timestamp.
  3523. </returns>
  3524. <remarks>
  3525. The nonce must be stored for no less than the maximum time window a message may
  3526. be processed within before being discarded as an expired message.
  3527. If the binding element is applicable to your channel, this expiration window
  3528. is retrieved or set using the
  3529. <see cref="P:DotNetOpenAuth.Messaging.Bindings.StandardExpirationBindingElement.MaximumMessageAge"/> property.
  3530. </remarks>
  3531. </member>
  3532. <member name="T:DotNetOpenAuth.OpenId.RelyingParty.WellKnownProviders">
  3533. <summary>
  3534. Common OpenID Provider Identifiers.
  3535. </summary>
  3536. </member>
  3537. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.WellKnownProviders.Yahoo">
  3538. <summary>
  3539. The Yahoo OP Identifier.
  3540. </summary>
  3541. </member>
  3542. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.WellKnownProviders.Google">
  3543. <summary>
  3544. The Google OP Identifier.
  3545. </summary>
  3546. </member>
  3547. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.WellKnownProviders.MyOpenId">
  3548. <summary>
  3549. The MyOpenID OP Identifier.
  3550. </summary>
  3551. </member>
  3552. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.WellKnownProviders.Verisign">
  3553. <summary>
  3554. The Verisign OP Identifier.
  3555. </summary>
  3556. </member>
  3557. <member name="F:DotNetOpenAuth.OpenId.RelyingParty.WellKnownProviders.MyVidoop">
  3558. <summary>
  3559. The MyVidoop OP Identifier.
  3560. </summary>
  3561. </member>
  3562. <member name="M:DotNetOpenAuth.OpenId.RelyingParty.WellKnownProviders.#ctor">
  3563. <summary>
  3564. Prevents a default instance of the <see cref="T:DotNetOpenAuth.OpenId.RelyingParty.WellKnownProviders"/> class from being created.
  3565. </summary>
  3566. </member>
  3567. </members>
  3568. </doc>