diff options
Diffstat (limited to 'src/DotNetOpenAuth/OpenId/Messages/AssociateRequest.cs')
| -rw-r--r-- | src/DotNetOpenAuth/OpenId/Messages/AssociateRequest.cs | 214 |
1 files changed, 0 insertions, 214 deletions
diff --git a/src/DotNetOpenAuth/OpenId/Messages/AssociateRequest.cs b/src/DotNetOpenAuth/OpenId/Messages/AssociateRequest.cs deleted file mode 100644 index 2a0dc7a..0000000 --- a/src/DotNetOpenAuth/OpenId/Messages/AssociateRequest.cs +++ /dev/null @@ -1,214 +0,0 @@ -//----------------------------------------------------------------------- -// <copyright file="AssociateRequest.cs" company="Andrew Arnott"> -// Copyright (c) Andrew Arnott. All rights reserved. -// </copyright> -//----------------------------------------------------------------------- - -namespace DotNetOpenAuth.OpenId.Messages { - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Diagnostics.Contracts; - using System.Linq; - using System.Text; - using DotNetOpenAuth.Messaging; - using DotNetOpenAuth.OpenId.Provider; - using DotNetOpenAuth.OpenId.RelyingParty; - - /// <summary> - /// An OpenID direct request from Relying Party to Provider to initiate an association. - /// </summary> - [DebuggerDisplay("OpenID {Version} {Mode} {AssociationType} {SessionType}")] - internal abstract class AssociateRequest : RequestBase { - /// <summary> - /// Initializes a new instance of the <see cref="AssociateRequest"/> class. - /// </summary> - /// <param name="version">The OpenID version this message must comply with.</param> - /// <param name="providerEndpoint">The OpenID Provider endpoint.</param> - protected AssociateRequest(Version version, Uri providerEndpoint) - : base(version, providerEndpoint, GetProtocolConstant(version, p => p.Args.Mode.associate), MessageTransport.Direct) { - } - - /// <summary> - /// Gets or sets the preferred association type. The association type defines the algorithm to be used to sign subsequent messages. - /// </summary> - /// <value>Value: A valid association type from Section 8.3.</value> - [MessagePart("openid.assoc_type", IsRequired = true, AllowEmpty = false)] - internal string AssociationType { get; set; } - - /// <summary> - /// Gets or sets the preferred association session type. This defines the method used to encrypt the association's MAC key in transit. - /// </summary> - /// <value>Value: A valid association session type from Section 8.4 (Association Session Types). </value> - /// <remarks>Note: Unless using transport layer encryption, "no-encryption" MUST NOT be used. </remarks> - [MessagePart("openid.session_type", IsRequired = false, AllowEmpty = true)] - [MessagePart("openid.session_type", IsRequired = true, AllowEmpty = false, MinVersion = "2.0")] - internal string SessionType { get; set; } - - /// <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 override void EnsureValidMessage() { - base.EnsureValidMessage(); - - ErrorUtilities.VerifyProtocol( - !string.Equals(this.SessionType, Protocol.Args.SessionType.NoEncryption, StringComparison.Ordinal) || this.Recipient.IsTransportSecure(), - OpenIdStrings.NoEncryptionSessionRequiresHttps, - this); - } - - /// <summary> - /// Creates an association request message that is appropriate for a given Provider. - /// </summary> - /// <param name="securityRequirements">The set of requirements the selected association type must comply to.</param> - /// <param name="provider">The provider to create an association with.</param> - /// <returns> - /// The message to send to the Provider to request an association. - /// Null if no association could be created that meet the security requirements - /// and the provider OpenID version. - /// </returns> - internal static AssociateRequest Create(SecuritySettings securityRequirements, IProviderEndpoint provider) { - Contract.Requires<ArgumentNullException>(securityRequirements != null); - Contract.Requires<ArgumentNullException>(provider != null); - - // Apply our knowledge of the endpoint's transport, OpenID version, and - // security requirements to decide the best association. - bool unencryptedAllowed = provider.Uri.IsTransportSecure(); - bool useDiffieHellman = !unencryptedAllowed; - string associationType, sessionType; - if (!HmacShaAssociation.TryFindBestAssociation(Protocol.Lookup(provider.Version), true, securityRequirements, useDiffieHellman, out associationType, out sessionType)) { - // There are no associations that meet all requirements. - Logger.OpenId.Warn("Security requirements and protocol combination knock out all possible association types. Dumb mode forced."); - return null; - } - - return Create(securityRequirements, provider, associationType, sessionType); - } - - /// <summary> - /// Creates an association request message that is appropriate for a given Provider. - /// </summary> - /// <param name="securityRequirements">The set of requirements the selected association type must comply to.</param> - /// <param name="provider">The provider to create an association with.</param> - /// <param name="associationType">Type of the association.</param> - /// <param name="sessionType">Type of the session.</param> - /// <returns> - /// The message to send to the Provider to request an association. - /// Null if no association could be created that meet the security requirements - /// and the provider OpenID version. - /// </returns> - internal static AssociateRequest Create(SecuritySettings securityRequirements, IProviderEndpoint provider, string associationType, string sessionType) { - Contract.Requires<ArgumentNullException>(securityRequirements != null); - Contract.Requires<ArgumentNullException>(provider != null); - Contract.Requires<ArgumentException>(!String.IsNullOrEmpty(associationType)); - Contract.Requires<ArgumentNullException>(sessionType != null); - - bool unencryptedAllowed = provider.Uri.IsTransportSecure(); - if (unencryptedAllowed) { - var associateRequest = new AssociateUnencryptedRequest(provider.Version, provider.Uri); - associateRequest.AssociationType = associationType; - return associateRequest; - } else { - var associateRequest = new AssociateDiffieHellmanRequest(provider.Version, provider.Uri); - associateRequest.AssociationType = associationType; - associateRequest.SessionType = sessionType; - associateRequest.InitializeRequest(); - return associateRequest; - } - } - - /// <summary> - /// Creates a Provider's response to an incoming association request. - /// </summary> - /// <param name="associationStore">The association store.</param> - /// <param name="securitySettings">The security settings on the Provider.</param> - /// <returns> - /// The appropriate association response that is ready to be sent back to the Relying Party. - /// </returns> - /// <remarks> - /// <para>If an association is created, it will be automatically be added to the provided - /// association store.</para> - /// <para>Successful association response messages will derive from <see cref="AssociateSuccessfulResponse"/>. - /// Failed association response messages will derive from <see cref="AssociateUnsuccessfulResponse"/>.</para> - /// </remarks> - internal IProtocolMessage CreateResponse(IProviderAssociationStore associationStore, ProviderSecuritySettings securitySettings) { - Contract.Requires<ArgumentNullException>(associationStore != null); - Contract.Requires<ArgumentNullException>(securitySettings != null); - - IProtocolMessage response; - if (securitySettings.IsAssociationInPermittedRange(Protocol, this.AssociationType) && - HmacShaAssociation.IsDHSessionCompatible(Protocol, this.AssociationType, this.SessionType)) { - response = this.CreateResponseCore(); - - // Create and store the association if this is a successful response. - var successResponse = response as AssociateSuccessfulResponse; - if (successResponse != null) { - successResponse.CreateAssociation(this, associationStore, securitySettings); - } - } else { - response = this.CreateUnsuccessfulResponse(securitySettings); - } - - return response; - } - - /// <summary> - /// Creates a Provider's response to an incoming association request. - /// </summary> - /// <returns> - /// The appropriate association response message. - /// </returns> - /// <remarks> - /// <para>If an association can be successfully created, the - /// <see cref="AssociateSuccessfulResponse.CreateAssociation"/> method must not be - /// called by this method.</para> - /// <para>Successful association response messages will derive from <see cref="AssociateSuccessfulResponse"/>. - /// Failed association response messages will derive from <see cref="AssociateUnsuccessfulResponse"/>.</para> - /// </remarks> - protected abstract IProtocolMessage CreateResponseCore(); - - /// <summary> - /// Creates a response that notifies the Relying Party that the requested - /// association type is not supported by this Provider, and offers - /// an alternative association type, if possible. - /// </summary> - /// <param name="securitySettings">The security settings that apply to this Provider.</param> - /// <returns>The response to send to the Relying Party.</returns> - private AssociateUnsuccessfulResponse CreateUnsuccessfulResponse(ProviderSecuritySettings securitySettings) { - Contract.Requires<ArgumentNullException>(securitySettings != null); - - var unsuccessfulResponse = new AssociateUnsuccessfulResponse(this.Version, this); - - // The strategy here is to suggest that the RP try again with the lowest - // permissible security settings, giving the RP the best chance of being - // able to match with a compatible request. - bool unencryptedAllowed = this.Recipient.IsTransportSecure(); - bool useDiffieHellman = !unencryptedAllowed; - string associationType, sessionType; - if (HmacShaAssociation.TryFindBestAssociation(Protocol, false, securitySettings, useDiffieHellman, out associationType, out sessionType)) { - ErrorUtilities.VerifyInternal(this.AssociationType != associationType, "The RP asked for an association that should have been allowed, but the OP is trying to suggest the same one as an alternative!"); - unsuccessfulResponse.AssociationType = associationType; - unsuccessfulResponse.SessionType = sessionType; - Logger.OpenId.InfoFormat( - "Association requested of type '{0}' and session '{1}', which the Provider does not support. Sending back suggested alternative of '{0}' with session '{1}'.", - this.AssociationType, - this.SessionType, - unsuccessfulResponse.AssociationType, - unsuccessfulResponse.SessionType); - } else { - Logger.OpenId.InfoFormat("Association requested of type '{0}' and session '{1}', which the Provider does not support. No alternative association type qualified for suggesting back to the Relying Party.", this.AssociationType, this.SessionType); - } - - return unsuccessfulResponse; - } - } -} |