diff options
Diffstat (limited to 'src/DotNetOpenAuth/OpenId/Extensions/UI')
4 files changed, 0 insertions, 372 deletions
diff --git a/src/DotNetOpenAuth/OpenId/Extensions/UI/UIConstants.cs b/src/DotNetOpenAuth/OpenId/Extensions/UI/UIConstants.cs deleted file mode 100644 index 1cc920a..0000000 --- a/src/DotNetOpenAuth/OpenId/Extensions/UI/UIConstants.cs +++ /dev/null @@ -1,34 +0,0 @@ -//----------------------------------------------------------------------- -// <copyright file="UIConstants.cs" company="Andrew Arnott"> -// Copyright (c) Andrew Arnott. All rights reserved. -// </copyright> -//----------------------------------------------------------------------- - -namespace DotNetOpenAuth.OpenId.Extensions.UI { - /// <summary> - /// Constants used to support the UI extension. - /// </summary> - internal static class UIConstants { - /// <summary> - /// The type URI associated with this extension. - /// </summary> - internal const string UITypeUri = "http://specs.openid.net/extensions/ui/1.0"; - - /// <summary> - /// The Type URI that appears in an XRDS document when the OP supports popups through the UI extension. - /// </summary> - internal const string PopupSupported = "http://specs.openid.net/extensions/ui/1.0/mode/popup"; - - /// <summary> - /// The Type URI that appears in an XRDS document when the OP supports the RP - /// specifying the user's preferred language through the UI extension. - /// </summary> - internal const string LangPrefSupported = "http://specs.openid.net/extensions/ui/1.0/lang-pref"; - - /// <summary> - /// The Type URI that appears in the XRDS document when the OP supports the RP - /// specifying the icon for the OP to display during authentication through the UI extension. - /// </summary> - internal const string IconSupported = "http://specs.openid.net/extensions/ui/1.0/icon"; - } -} diff --git a/src/DotNetOpenAuth/OpenId/Extensions/UI/UIModes.cs b/src/DotNetOpenAuth/OpenId/Extensions/UI/UIModes.cs deleted file mode 100644 index 8e3e20f..0000000 --- a/src/DotNetOpenAuth/OpenId/Extensions/UI/UIModes.cs +++ /dev/null @@ -1,25 +0,0 @@ -//----------------------------------------------------------------------- -// <copyright file="UIModes.cs" company="Andrew Arnott"> -// Copyright (c) Andrew Arnott. All rights reserved. -// </copyright> -//----------------------------------------------------------------------- - -namespace DotNetOpenAuth.OpenId.Extensions.UI { - /// <summary> - /// Valid values for the <c>mode</c> parameter of the OpenID User Interface extension. - /// </summary> - public static class UIModes { - /// <summary> - /// Indicates that the Provider's authentication page appears in a popup window. - /// </summary> - /// <value>The constant <c>"popup"</c>.</value> - /// <remarks> - /// <para>The RP SHOULD create the popup to be 450 pixels wide and 500 pixels tall. The popup MUST have the address bar displayed, and MUST be in a standalone browser window. The contents of the popup MUST NOT be framed by the RP. </para> - /// <para>The RP SHOULD open the popup centered above the main browser window, and SHOULD dim the contents of the parent window while the popup is active. The RP SHOULD ensure that the user is not surprised by the appearance of the popup, and understands how to interact with it. </para> - /// <para>To keep the user popup user experience consistent, it is RECOMMENDED that the OP does not resize the popup window unless the OP requires additional space to show special features that are not usually displayed as part of the default popup user experience. </para> - /// <para>The OP MAY close the popup without returning a response to the RP. Closing the popup without sending a response should be interpreted as a negative assertion. </para> - /// <para>The response to an authentication request in a popup is unchanged from [OpenID 2.0] (OpenID 2.0 Workgroup, “OpenID 2.0,” .). Relying Parties detecting that the popup was closed without receiving an authentication response SHOULD interpret the close event to be a negative assertion. </para> - /// </remarks> - public const string Popup = "popup"; - } -} diff --git a/src/DotNetOpenAuth/OpenId/Extensions/UI/UIRequest.cs b/src/DotNetOpenAuth/OpenId/Extensions/UI/UIRequest.cs deleted file mode 100644 index df36b5e..0000000 --- a/src/DotNetOpenAuth/OpenId/Extensions/UI/UIRequest.cs +++ /dev/null @@ -1,261 +0,0 @@ -//----------------------------------------------------------------------- -// <copyright file="UIRequest.cs" company="Andrew Arnott"> -// Copyright (c) Andrew Arnott. All rights reserved. -// </copyright> -//----------------------------------------------------------------------- - -namespace DotNetOpenAuth.OpenId.Extensions.UI { - using System; - using System.Collections.Generic; - using System.Diagnostics.CodeAnalysis; - using System.Diagnostics.Contracts; - using System.Globalization; - using System.Linq; - using DotNetOpenAuth.Messaging; - using DotNetOpenAuth.OpenId.Messages; - using DotNetOpenAuth.OpenId.Provider; - using DotNetOpenAuth.OpenId.RelyingParty; - using DotNetOpenAuth.Xrds; - - /// <summary> - /// OpenID User Interface extension 1.0 request message. - /// </summary> - /// <remarks> - /// <para>Implements the extension described by: http://wiki.openid.net/f/openid_ui_extension_draft01.html </para> - /// <para>This extension only applies to checkid_setup requests, since checkid_immediate requests display - /// no UI to the user. </para> - /// <para>For rules about how the popup window should be displayed, please see the documentation of - /// <see cref="UIModes.Popup"/>. </para> - /// <para>An RP may determine whether an arbitrary OP supports this extension (and thereby determine - /// whether to use a standard full window redirect or a popup) via the - /// <see cref="IdentifierDiscoveryResult.IsExtensionSupported<T>()"/> method.</para> - /// </remarks> - [Serializable] - public class UIRequest : IOpenIdMessageExtension, IMessageWithEvents { - /// <summary> - /// The factory method that may be used in deserialization of this message. - /// </summary> - internal static readonly StandardOpenIdExtensionFactory.CreateDelegate Factory = (typeUri, data, baseMessage, isProviderRole) => { - if (typeUri == UIConstants.UITypeUri && isProviderRole) { - return new UIRequest(); - } - - return null; - }; - - /// <summary> - /// Additional type URIs that this extension is sometimes known by remote parties. - /// </summary> - private static readonly string[] additionalTypeUris = new string[] { - UIConstants.LangPrefSupported, - UIConstants.PopupSupported, - UIConstants.IconSupported, - }; - - /// <summary> - /// Backing store for <see cref="ExtraData"/>. - /// </summary> - private Dictionary<string, string> extraData = new Dictionary<string, string>(); - - /// <summary> - /// Initializes a new instance of the <see cref="UIRequest"/> class. - /// </summary> - public UIRequest() { - this.LanguagePreference = new[] { CultureInfo.CurrentUICulture }; - this.Mode = UIModes.Popup; - } - - /// <summary> - /// Gets or sets the list of user's preferred languages, sorted in decreasing preferred order. - /// </summary> - /// <value>The default is the <see cref="CultureInfo.CurrentUICulture"/> of the thread that created this instance.</value> - /// <remarks> - /// The user's preferred languages as a [BCP 47] language priority list, represented as a comma-separated list of BCP 47 basic language ranges in descending priority order. For instance, the value "fr-CA,fr-FR,en-CA" represents the preference for French spoken in Canada, French spoken in France, followed by English spoken in Canada. - /// </remarks> - [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "By design.")] - [MessagePart("lang", AllowEmpty = false)] - public CultureInfo[] LanguagePreference { get; set; } - - /// <summary> - /// Gets or sets the style of UI that the RP is hosting the OP's authentication page in. - /// </summary> - /// <value>Some value from the <see cref="UIModes"/> class. Defaults to <see cref="UIModes.Popup"/>.</value> - [MessagePart("mode", AllowEmpty = false, IsRequired = true)] - public string Mode { get; set; } - - /// <summary> - /// Gets or sets a value indicating whether the Relying Party has an icon - /// it would like the Provider to display to the user while asking them - /// whether they would like to log in. - /// </summary> - /// <value><c>true</c> if the Provider should display an icon; otherwise, <c>false</c>.</value> - /// <remarks> - /// By default, the Provider displays the relying party's favicon.ico. - /// </remarks> - [MessagePart("icon", AllowEmpty = false, IsRequired = false)] - public bool? Icon { get; set; } - - #region IOpenIdMessageExtension Members - - /// <summary> - /// Gets the TypeURI the extension uses in the OpenID protocol and in XRDS advertisements. - /// </summary> - /// <value></value> - public string TypeUri { get { return UIConstants.UITypeUri; } } - - /// <summary> - /// Gets the additional TypeURIs that are supported by this extension, in preferred order. - /// May be empty if none other than <see cref="TypeUri"/> is supported, but - /// should not be null. - /// </summary> - /// <remarks> - /// Useful for reading in messages with an older version of an extension. - /// The value in the <see cref="TypeUri"/> property is always checked before - /// trying this list. - /// If you do support multiple versions of an extension using this method, - /// consider adding a CreateResponse method to your request extension class - /// so that the response can have the context it needs to remain compatible - /// given the version of the extension in the request message. - /// The <see cref="Extensions.SimpleRegistration.ClaimsRequest.CreateResponse"/> for an example. - /// </remarks> - public IEnumerable<string> AdditionalSupportedTypeUris { get { return additionalTypeUris; } } - - /// <summary> - /// Gets or sets a value indicating whether this extension was - /// signed by the sender. - /// </summary> - /// <value> - /// <c>true</c> if this instance is signed by the sender; otherwise, <c>false</c>. - /// </value> - public bool IsSignedByRemoteParty { get; set; } - - #endregion - - #region IMessage Properties - - /// <summary> - /// Gets the version of the protocol or extension this message is prepared to implement. - /// </summary> - /// <value>The value 1.0.</value> - /// <remarks> - /// Implementations of this interface should ensure that this property never returns null. - /// </remarks> - public Version Version { - get { return new Version(1, 0); } - } - - /// <summary> - /// Gets the extra, non-standard Protocol parameters included in the message. - /// </summary> - /// <remarks> - /// Implementations of this interface should ensure that this property never returns null. - /// </remarks> - public IDictionary<string, string> ExtraData { - get { return this.extraData; } - } - - #endregion - - /// <summary> - /// Gets the URL of the RP icon for the OP to display. - /// </summary> - /// <param name="realm">The realm of the RP where the authentication request originated.</param> - /// <param name="webRequestHandler">The web request handler to use for discovery. - /// Usually available via <see cref="Channel.WebRequestHandler">OpenIdProvider.Channel.WebRequestHandler</see>.</param> - /// <returns> - /// A sequence of the RP's icons it has available for the Provider to display, in decreasing preferred order. - /// </returns> - /// <value>The icon URL.</value> - /// <remarks> - /// This property is automatically set for the OP with the result of RP discovery. - /// RPs should set this value by including an entry such as this in their XRDS document. - /// <example> - /// <Service xmlns="xri://$xrd*($v*2.0)"> - /// <Type>http://specs.openid.net/extensions/ui/icon</Type> - /// <URI>http://consumer.example.com/images/image.jpg</URI> - /// </Service> - /// </example> - /// </remarks> - public static IEnumerable<Uri> GetRelyingPartyIconUrls(Realm realm, IDirectWebRequestHandler webRequestHandler) { - Contract.Requires(realm != null); - Contract.Requires(webRequestHandler != null); - ErrorUtilities.VerifyArgumentNotNull(realm, "realm"); - ErrorUtilities.VerifyArgumentNotNull(webRequestHandler, "webRequestHandler"); - - XrdsDocument xrds = realm.Discover(webRequestHandler, false); - if (xrds == null) { - return Enumerable.Empty<Uri>(); - } else { - return xrds.FindRelyingPartyIcons(); - } - } - - /// <summary> - /// Gets the URL of the RP icon for the OP to display. - /// </summary> - /// <param name="realm">The realm of the RP where the authentication request originated.</param> - /// <param name="provider">The Provider instance used to obtain the authentication request.</param> - /// <returns> - /// A sequence of the RP's icons it has available for the Provider to display, in decreasing preferred order. - /// </returns> - /// <value>The icon URL.</value> - /// <remarks> - /// This property is automatically set for the OP with the result of RP discovery. - /// RPs should set this value by including an entry such as this in their XRDS document. - /// <example> - /// <Service xmlns="xri://$xrd*($v*2.0)"> - /// <Type>http://specs.openid.net/extensions/ui/icon</Type> - /// <URI>http://consumer.example.com/images/image.jpg</URI> - /// </Service> - /// </example> - /// </remarks> - public static IEnumerable<Uri> GetRelyingPartyIconUrls(Realm realm, OpenIdProvider provider) { - Contract.Requires(realm != null); - Contract.Requires(provider != null); - ErrorUtilities.VerifyArgumentNotNull(realm, "realm"); - ErrorUtilities.VerifyArgumentNotNull(provider, "provider"); - - return GetRelyingPartyIconUrls(realm, provider.Channel.WebRequestHandler); - } - - #region IMessage methods - - /// <summary> - /// Checks the message state for conformity to the protocol specification - /// and throws an exception if the message is invalid. - /// </summary> - /// <remarks> - /// <para>Some messages have required fields, or combinations of fields that must relate to each other - /// in specialized ways. After deserializing a message, this method checks the state of the - /// message to see if it conforms to the protocol.</para> - /// <para>Note that this property should <i>not</i> check signatures or perform any state checks - /// outside this scope of this particular message.</para> - /// </remarks> - /// <exception cref="ProtocolException">Thrown if the message is invalid.</exception> - public void EnsureValidMessage() { - } - - #endregion - - #region IMessageWithEvents Members - - /// <summary> - /// Called when the message is about to be transmitted, - /// before it passes through the channel binding elements. - /// </summary> - public void OnSending() { - } - - /// <summary> - /// Called when the message has been received, - /// after it passes through the channel binding elements. - /// </summary> - public void OnReceiving() { - if (this.LanguagePreference != null) { - // TODO: see if we can change the CultureInfo.CurrentUICulture somehow - } - } - - #endregion - } -} diff --git a/src/DotNetOpenAuth/OpenId/Extensions/UI/UIUtilities.cs b/src/DotNetOpenAuth/OpenId/Extensions/UI/UIUtilities.cs deleted file mode 100644 index cee6882..0000000 --- a/src/DotNetOpenAuth/OpenId/Extensions/UI/UIUtilities.cs +++ /dev/null @@ -1,52 +0,0 @@ -//----------------------------------------------------------------------- -// <copyright file="UIUtilities.cs" company="Andrew Arnott"> -// Copyright (c) Andrew Arnott. All rights reserved. -// </copyright> -//----------------------------------------------------------------------- - -namespace DotNetOpenAuth.OpenId.Extensions.UI { - using System; - using System.Diagnostics.Contracts; - using System.Globalization; - using DotNetOpenAuth.Messaging; - using DotNetOpenAuth.OpenId.RelyingParty; - - /// <summary> - /// Constants used in implementing support for the UI extension. - /// </summary> - public static class UIUtilities { - /// <summary> - /// The required width of the popup window the relying party creates for the provider. - /// </summary> - public const int PopupWidth = 500; // UI extension calls for 450px, but Yahoo needs 500px - - /// <summary> - /// The required height of the popup window the relying party creates for the provider. - /// </summary> - public const int PopupHeight = 500; - - /// <summary> - /// Gets the <c>window.open</c> javascript snippet to use to open a popup window - /// compliant with the UI extension. - /// </summary> - /// <param name="relyingParty">The relying party.</param> - /// <param name="request">The authentication request to place in the window.</param> - /// <param name="windowName">The name to assign to the popup window.</param> - /// <returns>A string starting with 'window.open' and forming just that one method call.</returns> - internal static string GetWindowPopupScript(OpenIdRelyingParty relyingParty, IAuthenticationRequest request, string windowName) { - Contract.Requires<ArgumentNullException>(relyingParty != null); - Contract.Requires<ArgumentNullException>(request != null); - Contract.Requires<ArgumentException>(!string.IsNullOrEmpty(windowName)); - - Uri popupUrl = request.RedirectingResponse.GetDirectUriRequest(relyingParty.Channel); - - return string.Format( - CultureInfo.InvariantCulture, - "(window.showModalDialog ? window.showModalDialog({0}, {1}, 'status:0;resizable:1;scroll:1;center:1;dialogWidth:{2}px; dialogHeight:{3}') : window.open({0}, {1}, 'status=0,toolbar=0,location=1,resizable=1,scrollbars=1,left=' + ((screen.width - {2}) / 2) + ',top=' + ((screen.height - {3}) / 2) + ',width={2},height={3}'));", - MessagingUtilities.GetSafeJavascriptValue(popupUrl.AbsoluteUri), - MessagingUtilities.GetSafeJavascriptValue(windowName), - PopupWidth, - PopupHeight); - } - } -} |