diff options
Diffstat (limited to 'samples')
| -rw-r--r-- | samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/Acme.cs | 80 | ||||
| -rw-r--r-- | samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/AcmeRequest.cs | 44 | ||||
| -rw-r--r-- | samples/DotNetOpenAuth.ApplicationBlock/CustomExtensions/AcmeResponse.cs | 63 | ||||
| -rw-r--r-- | samples/DotNetOpenAuth.ApplicationBlock/DotNetOpenAuth.ApplicationBlock.csproj | 3 | ||||
| -rw-r--r-- | samples/InfoCardRelyingParty/Bin/DotNetOpenAuth.dll.refresh | bin | 0 -> 58 bytes | |||
| -rw-r--r-- | samples/OAuthConsumer/Bin/DotNetOpenAuth.dll.refresh | bin | 0 -> 58 bytes | |||
| -rw-r--r-- | samples/OAuthServiceProvider/Bin/DotNetOpenAuth.dll.refresh | bin | 0 -> 58 bytes | |||
| -rw-r--r-- | samples/README.html | 156 |
8 files changed, 346 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 + } +} diff --git a/samples/DotNetOpenAuth.ApplicationBlock/DotNetOpenAuth.ApplicationBlock.csproj b/samples/DotNetOpenAuth.ApplicationBlock/DotNetOpenAuth.ApplicationBlock.csproj index 626dbaa..976a325 100644 --- a/samples/DotNetOpenAuth.ApplicationBlock/DotNetOpenAuth.ApplicationBlock.csproj +++ b/samples/DotNetOpenAuth.ApplicationBlock/DotNetOpenAuth.ApplicationBlock.csproj @@ -55,6 +55,9 @@ <Reference Include="System.Xml" /> </ItemGroup> <ItemGroup> + <Compile Include="CustomExtensions\Acme.cs" /> + <Compile Include="CustomExtensions\AcmeRequest.cs" /> + <Compile Include="CustomExtensions\AcmeResponse.cs" /> <Compile Include="GoogleConsumer.cs" /> <Compile Include="Properties\AssemblyInfo.cs" /> <Compile Include="TwitterConsumer.cs" /> diff --git a/samples/InfoCardRelyingParty/Bin/DotNetOpenAuth.dll.refresh b/samples/InfoCardRelyingParty/Bin/DotNetOpenAuth.dll.refresh Binary files differnew file mode 100644 index 0000000..946bd4b --- /dev/null +++ b/samples/InfoCardRelyingParty/Bin/DotNetOpenAuth.dll.refresh diff --git a/samples/OAuthConsumer/Bin/DotNetOpenAuth.dll.refresh b/samples/OAuthConsumer/Bin/DotNetOpenAuth.dll.refresh Binary files differnew file mode 100644 index 0000000..946bd4b --- /dev/null +++ b/samples/OAuthConsumer/Bin/DotNetOpenAuth.dll.refresh diff --git a/samples/OAuthServiceProvider/Bin/DotNetOpenAuth.dll.refresh b/samples/OAuthServiceProvider/Bin/DotNetOpenAuth.dll.refresh Binary files differnew file mode 100644 index 0000000..946bd4b --- /dev/null +++ b/samples/OAuthServiceProvider/Bin/DotNetOpenAuth.dll.refresh diff --git a/samples/README.html b/samples/README.html new file mode 100644 index 0000000..287942a --- /dev/null +++ b/samples/README.html @@ -0,0 +1,156 @@ +<html> +<body> + <h1>DotNetOpenAuth samples </h1> + <h3>Prerequisites:</h3> + <ul> + <li>Microsoft .NET 3.5</li> + <li>Visual Studio 2008 or IIS (Visual Studio 2005 is reported to work, however)</li> + <li>Microsoft Windows (XP or Vista, or 2003 Server or later)</li> + <li>See the tools section further below for some helpful software </li> + </ul> + <h2>Getting the samples running</h2> + <h3>Testing the relying party/provider samples with each other</h3> + <p>In this scenario you can use the Personal Web Server (PWS) that is included in Visual + Studio 2008.</p> + <ol> + <li>Open the DotNetOpenAuth.sln or Samples.sln file in VS2008.</li> + <li>Right-click on each web project under the Samples folder and click "View in Browser" + to start PWS for each web site.</li> + <li>Each web project will be dynamicly assigned a port number. Find the port number + on the URL of the browser window for the Provider. </li> + <li>Now log into the Relying Party sample web site with this OpenID: http://localhost:<i>providerport</i>/user/bob. + </li> + <li>When the provider prompts you for a password, type in 'test'.</li> + </ol> + <h3>Testing with other relying party/provider sites on the Internet</h3> + <ul> + <li>You need to have a public IP address to test the Provider sample with other Relying + Party web sites out on the Internet so they can find your Provider. </li> + <li>You might need to configure your firewall and/or router to forward traffic to your + computer.</li> + <li>Note that some OpenID-enabled sites block URLs that use just IP addresses. + You may need to get a DNS name to point at your public IP address in order for your + scenario to work.</li> + <li>Ensure your firewall is configured to allow inbound and outbound TCP port 80 connections.</li> + <li>Since VS2008 Personal Web Server (PWS) does not allow web requests from other servers + (as required by OpenID relying parties trying to log into your server), testing + with external relying parties requires you to use IIS to host your server.</li> + </ul> + <h3>Setting up the IIS Applications</h3> + <ul> + <li>Create an IIS web application for each sample. </li> + <li>Check that IIS is responding to requests on the port that your router will be forwarding + requests to you on, if applicable.</li> + <li>Enable anonymous access to each site.</li> + </ul> + <p>Configure VS2008 to use IIS rather than PWS</p> + <ol> + <li>Right-click on one of the web projects within Solution Explorer.</li> + <li>Select Property Pages.</li> + <li>Select Start Options on the left.</li> + <li>Under the Server section on the right, select Use Custom Server and fill in the + Base URL.</li> + </ol> + <h2>The demos</h2> + <p>These will illustrate OpenID in action. You can debug the code to get a good idea + of what's going on. The implementations are built on top of ASP.NET's forms authentication. + So basically if you're unauthenticated and get to page requiring authentication, + it takes you through the OpenID identity provider, tracks in session that you've + left and then recognizes the user when they return to the relying party and only + then logs them into FormsAuth and redirects them to their originally requested page. + </p> + <h3>The Relying Party Demo </h3> + <ol> + <li>Kill all session cookies</li> + <li>Create an OpenID account with one of the Open Servers listed below OR use the demo + Server as the identity provider - using http://[EXTERNAL IP]/OpenIdProviderWebForms/user/bob + with the password 'test'</li> + <li>Go to http://[EXTERNAL IP]/OpenIdRelyingPartyWebForms/default.aspx and enter the + OpenIDURL</li> + <li>You are required to authenticate with the provider. Some fields (eg Name, DoB, Country + etc.) are requested, some required and some omitted. Your OpenID provider should + prompt you for the relevant fields, or at least make you aware which fields its + passing back. The exact page flow and auhentication mechanism will be implemented + differently by different identity providers.</li> + <li>After providing the required info and loggin in, you are taken back to the http://[EXTERNAL + IP]/OpenIdRelyingPartyWebForms/default.aspx and the available profile information + is displayed</li> + </ol> + <h3>The Provider Demo </h3> + <ol> + <li>Kill all session cookies</li> + <li>Get the full openID url for a user based on whats in web.config. By default you + can use http://[EXTERNAL IP]/OpenIdProviderWebForms/user/bob with the password 'test'</li> + <li>Go to http://[EXTERNAL IP]/OpenIdRelyingPartyWebForms/default.aspx and enter the + OpenIDURL of the local server</li> + <li>The user is prompted for their password. The username field is propulated from the + openid url and grayed out.</li> + <li>The user is presentend with their identity url, a trust root (the site requiring + authentication) and set of fields to complete. Only the requested or required fields + are presented. Fields with * means the consumer requires it. </li> + <li>The user completes the fields and clicks Yes and are taken to http://[EXTERNAL IP]/OpenIdRelyingPartyWebForms/default.aspx + with their available profile information.</li> + </ol> + <h3>Interesting classes and methods</h3> + <h4>Relying party</h4> + <ul> + <li>DotNetOpenId.RelyingParty.<b>OpenIdRelyingParty</b> - programmatic access to everything + a relying party web site needs.</li> + <li>DotNetOpenId.RelyingParty.<b>OpenIdTextBox</b> - An ASP.NET control that is a bare-bones + text input box with a LogOn method that automatically does all the OpenId stuff + for you.</li> + <li>DotNetOpenId.RelyingParty.<b>OpenIdLogin</b> - Like the OpenIdTextBox, but has a + Login button and some other end user-friendly UI built-in. Drop this onto + your web form and you're all done!</li> + </ul> + <h4>Provider</h4> + <ul> + <li>DotNetOpenId.Provider.<b>OpenIdProvider</b> - programmatic access to everything + a provider web site needs.</li> + <li>DotNetOpenId.Provider.<b>ProviderEndpoint</b> - An ASP.NET control that you can + drop in and have an instant provider endpoint on your page.</li> + <li>DotNetOpenId.Provider.<b>IdentityEndpoint</b> - An ASP.NET control that you can + drop onto the page for your own or your customers' individual identity pages + for discovery by Relying Parties.</li> + </ul> + <h3>Development tips / Issues I found:</h3> + <p>Here is a growing list of <a href="http://openiddirectory.com/allcats.html">OpenID + enabled sites</a> to test with. </p> + <p>Good sites to test with if you're developing a relying party:<ul> + <li><a href="http://www.myopenid.com/">http://www.myopenid.com/</a></li> + <li><a href="http://claimid.com/">http://claimid.com/</a> (supports registration extensions)</li> + <li><a href="http://www.freeyourid.com/">http://www.freeyourid.com/</a> (supports registration + extensions)</li> + </ul> + <p>Good sites to test with if you're developing a server:<ul> + <li><a href="http://beta.zooomr.com/home">http://beta.zooomr.com/home</a> *</li> + <li><a href="http://cr.unchy.com/">http://cr.unchy.com/</a> (supports registration + extensions)</li> + <li><a href="http://blog.identity20.eu">http://blog.identity20.eu</a> *</li> + <li><a href="http://openiddirectory.com">http://openiddirectory.com</a> *</li> + <li><a href="http://www.centernetworks.com/">http://www.centernetworks.com/</a> + (supports registration extensions)</li> + <li><a href="http://www.loudisrelative.com">http://www.loudisrelative.com</a> + (supports registration extensions)</li> + <li><a href="http://rssarchive.com/index.html">http://rssarchive.com/index.html</a> + </li> + <li><a href="http://www.jyte.com">http://www.jyte.com</a> (supports registration + extensions)</li> + <li><a href="http://dis.covr.us/">http://dis.covr.us/</a> </li> + </ul> + * These sites seem to block outgoing traffic that is not on a non standard HTTP + port like 80 and 443. Therefore you'll need to host on a proper internet domain + before doing any testing with them. + <p>Useful tools: + <ul> + <li><a href="http://www.fiddlertool.com/fiddler/">Fiddler</a> - this will allow you + to monitor HTTP traffic when using IE</li> + <li><a href="http://www.bayden.com/Other/">TamperIE</a> - allows you to change form + data before posting it</li> + <li><a href="http://www.microsoft.com/downloads/details.aspx?familyid=E59C3964-672D-4511-BB3E-2D5E1DB91038&displaylang=en"> + IE Developer toolbar</a> - good tool for general IE UI development. Has some neat + features for quickly clearing cookies etc.</li> + <li><a href="http://www.iopus.com/download/">iMacros</a> - good for automating web testing</li> + </ul> +</body> +</html> |