diff options
Diffstat (limited to 'samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions')
3 files changed, 187 insertions, 0 deletions
diff --git a/samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/Acme.cs b/samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/Acme.cs new file mode 100644 index 0000000..d66bb8d --- /dev/null +++ b/samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/Acme.cs @@ -0,0 +1,80 @@ +//----------------------------------------------------------------------- +// <copyright file="Acme.cs" company="Andrew Arnott"> +// Copyright (c) Andrew Arnott. All rights reserved. +// </copyright> +//----------------------------------------------------------------------- + +namespace DotNetOpenAuth.ApplicationBlock.CustomExtensions { + using System; + using System.Collections.Generic; + using DotNetOpenAuth.Messaging; + using DotNetOpenAuth.OpenId.ChannelElements; + using DotNetOpenAuth.OpenId.Messages; + using DotNetOpenAuth.OpenId.Provider; + using DotNetOpenAuth.OpenId.RelyingParty; + + /// <summary> + /// A sample custom OpenID extension factory. + /// </summary> + /// <remarks> + /// OpenID extension factories must be registered with the library. This can be + /// done by calling <see cref="Acme.Register"/>, or by adding a snippet + /// such as the following to your web.config file: + /// <example> + /// <dotNetOpenAuth> + /// <openid> + /// <extensionFactories> + /// <add type="DotNetOpenAuth.ApplicationBlock.CustomExtensions.Acme, DotNetOpenAuth.ApplicationBlock" /> + /// </extensionFactories> + /// </openid> + /// </dotNetOpenAuth> + /// </example> + /// </remarks> + public class Acme : IOpenIdExtensionFactory { + internal const string CustomExtensionTypeUri = "testextension"; + internal static readonly Version Version = new Version(1, 0); + + public static void Register(OpenIdRelyingParty relyingParty) { + if (relyingParty == null) { + throw new ArgumentNullException("relyingParty"); + } + + relyingParty.ExtensionFactories.Add(new Acme()); + } + + public static void Register(OpenIdProvider provider) { + if (provider == null) { + throw new ArgumentNullException("provider"); + } + + provider.ExtensionFactories.Add(new Acme()); + } + + #region IOpenIdExtensionFactory Members + + /// <summary> + /// Creates a new instance of some extension based on the received extension parameters. + /// </summary> + /// <param name="typeUri">The type URI of the extension.</param> + /// <param name="data">The parameters associated specifically with this extension.</param> + /// <param name="baseMessage">The OpenID message carrying this extension.</param> + /// <param name="isProviderRole">A value indicating whether this extension is being received at the OpenID Provider.</param> + /// <returns> + /// An instance of <see cref="IOpenIdMessageExtension"/> if the factory recognizes + /// the extension described in the input parameters; <c>null</c> otherwise. + /// </returns> + /// <remarks> + /// This factory method need only initialize properties in the instantiated extension object + /// that are not bound using <see cref="MessagePartAttribute"/>. + /// </remarks> + public IOpenIdMessageExtension Create(string typeUri, IDictionary<string, string> data, IProtocolMessageWithExtensions baseMessage, bool isProviderRole) { + if (typeUri == CustomExtensionTypeUri) { + return isProviderRole ? (IOpenIdMessageExtension)new AcmeRequest() : new AcmeResponse(); + } + + return null; + } + + #endregion + } +} diff --git a/samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/AcmeRequest.cs b/samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/AcmeRequest.cs new file mode 100644 index 0000000..19a3a0e --- /dev/null +++ b/samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/AcmeRequest.cs @@ -0,0 +1,44 @@ +//----------------------------------------------------------------------- +// <copyright file="AcmeRequest.cs" company="Andrew Arnott"> +// Copyright (c) Andrew Arnott. All rights reserved. +// </copyright> +//----------------------------------------------------------------------- + +namespace DotNetOpenAuth.ApplicationBlock.CustomExtensions { + using System; + using System.Collections.Generic; + using System.Linq; + using System.Text; + using DotNetOpenAuth.OpenId.Messages; + + public class AcmeRequest : IOpenIdMessageExtension { + private IDictionary<string, string> extraData = new Dictionary<string, string>(); + + #region IOpenIdMessageExtension Members + + public string TypeUri { + get { return Acme.CustomExtensionTypeUri; } + } + + public IEnumerable<string> AdditionalSupportedTypeUris { + get { return Enumerable.Empty<string>(); } + } + + #endregion + + #region IMessage Members + + public Version Version { + get { return Acme.Version; } + } + + public IDictionary<string, string> ExtraData { + get { return this.extraData; } + } + + public void EnsureValidMessage() { + } + + #endregion + } +} diff --git a/samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/AcmeResponse.cs b/samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/AcmeResponse.cs new file mode 100644 index 0000000..38185bd --- /dev/null +++ b/samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/AcmeResponse.cs @@ -0,0 +1,63 @@ +//----------------------------------------------------------------------- +// <copyright file="AcmeResponse.cs" company="Andrew Arnott"> +// Copyright (c) Andrew Arnott. All rights reserved. +// </copyright> +//----------------------------------------------------------------------- + +namespace DotNetOpenAuth.ApplicationBlock.CustomExtensions { + using System; + using System.Collections.Generic; + using System.Linq; + using System.Text; + using DotNetOpenAuth.OpenId.Messages; + + [Serializable] + public class AcmeResponse : IOpenIdMessageExtension { + private IDictionary<string, string> extraData = new Dictionary<string, string>(); + + #region IOpenIdMessageExtension Members + + /// <summary> + /// Gets the TypeURI the extension uses in the OpenID protocol and in XRDS advertisements. + /// </summary> + public string TypeUri { + get { return Acme.CustomExtensionTypeUri; } + } + + /// <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 Enumerable.Empty<string>(); } + } + + #endregion + + #region IMessage Members + + public Version Version { + get { return Acme.Version; } + } + + public IDictionary<string, string> ExtraData { + get { return this.extraData; } + } + + public void EnsureValidMessage() { + } + + #endregion + } +} |