src/DotNetOpenAuth/OpenId/Extensions/IClientScriptExtensionResponse.cs

   1 //-----------------------------------------------------------------------
   2 // <copyright file="IClientScriptExtensionResponse.cs" company="Andrew Arnott">
   3 //     Copyright (c) Andrew Arnott. All rights reserved.
   4 // </copyright>
   5 //-----------------------------------------------------------------------
   6
   7 namespace DotNetOpenAuth.OpenId.Extensions {
   8         using System.Collections.Generic;
   9         using DotNetOpenAuth.Messaging;
  10         using DotNetOpenAuth.OpenId.Messages;
  11         using DotNetOpenAuth.OpenId.RelyingParty;
  12
  13         /// <summary>
  14         /// An interface that OpenID extensions can implement to allow authentication response
  15         /// messages with included extensions to be processed by Javascript on the user agent.
  16         /// </summary>
  17         public interface IClientScriptExtensionResponse : IExtensionMessage {
  18                 /// <summary>
  19                 /// Reads the extension information on an authentication response from the provider.
  20                 /// </summary>
  21                 /// <param name="response">The incoming OpenID response carrying the extension.</param>
  22                 /// <returns>
  23                 /// A Javascript snippet that when executed on the user agent returns an object with
  24                 /// the information deserialized from the extension response.
  25                 /// </returns>
  26                 /// <remarks>
  27                 /// This method is called <b>before</b> the signature on the assertion response has been
  28                 /// verified.  Therefore all information in these fields should be assumed unreliable
  29                 /// and potentially falsified.
  30                 /// </remarks>
  31                 string InitializeJavaScriptData(IProtocolMessageWithExtensions response);
  32         }
  33 }