1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
//-----------------------------------------------------------------------
// <copyright file="FetchResponse.cs" company="Outercurve Foundation">
// Copyright (c) Outercurve Foundation. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace DotNetOpenAuth.OpenId.Extensions.AttributeExchange {
using System;
using System.Collections.ObjectModel;
using System.Linq;
using DotNetOpenAuth.Logging;
using DotNetOpenAuth.Messaging;
using DotNetOpenAuth.OpenId.Messages;
/// <summary>
/// The Attribute Exchange Fetch message, response leg.
/// </summary>
[Serializable]
public sealed class FetchResponse : ExtensionBase, 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 == Constants.TypeUri && !isProviderRole) {
string mode;
if (data.TryGetValue("mode", out mode) && mode == Mode) {
return new FetchResponse();
}
}
return null;
};
/// <summary>
/// The value of the 'mode' parameter.
/// </summary>
[MessagePart("mode", IsRequired = true)]
private const string Mode = "fetch_response";
/// <summary>
/// The collection of provided attributes. This field will never be null.
/// </summary>
private readonly KeyedCollection<string, AttributeValues> attributesProvided = new KeyedCollectionDelegate<string, AttributeValues>(av => av.TypeUri);
/// <summary>
/// Initializes a new instance of the <see cref="FetchResponse"/> class.
/// </summary>
public FetchResponse()
: base(new Version(1, 0), Constants.TypeUri, null) {
}
/// <summary>
/// Gets a sequence of the attributes whose values are provided by the OpenID Provider.
/// </summary>
public KeyedCollection<string, AttributeValues> Attributes {
get {
return this.attributesProvided;
}
}
/// <summary>
/// Gets a value indicating whether the OpenID Provider intends to
/// honor the request for updates.
/// </summary>
public bool UpdateUrlSupported {
get { return this.UpdateUrl != null; }
}
/// <summary>
/// Gets or sets the URL the OpenID Provider will post updates to.
/// Must be set if the Provider supports and will use this feature.
/// </summary>
[MessagePart("update_url", IsRequired = false)]
public Uri UpdateUrl { get; set; }
/// <summary>
/// Gets a value indicating whether this extension is signed by the Provider.
/// </summary>
/// <value>
/// <c>true</c> if this instance is signed by the Provider; otherwise, <c>false</c>.
/// </value>
public bool IsSignedByProvider {
get { return this.IsSignedByRemoteParty; }
}
/// <summary>
/// Gets the first attribute value provided for a given attribute Type URI.
/// </summary>
/// <param name="typeUri">
/// The type URI of the attribute.
/// Usually a constant from <see cref="WellKnownAttributes"/>.</param>
/// <returns>
/// The first value provided for the attribute, or <c>null</c> if the attribute is missing or no values were provided.
/// </returns>
/// <remarks>
/// This is meant as a helper method for the common case of just wanting one attribute value.
/// For greater flexibility or to retrieve more than just the first value for an attribute,
/// use the <see cref="Attributes"/> collection directly.
/// </remarks>
public string GetAttributeValue(string typeUri) {
if (this.Attributes.Contains(typeUri)) {
return this.Attributes[typeUri].Values.FirstOrDefault();
} else {
return null;
}
}
/// <summary>
/// Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
/// </summary>
/// <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
/// <returns>
/// true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
/// </returns>
/// <exception cref="T:System.NullReferenceException">
/// The <paramref name="obj"/> parameter is null.
/// </exception>
public override bool Equals(object obj) {
FetchResponse other = obj as FetchResponse;
if (other == null) {
return false;
}
if (this.Version != other.Version) {
return false;
}
if (this.UpdateUrl != other.UpdateUrl) {
return false;
}
if (!MessagingUtilities.AreEquivalentUnordered(this.Attributes.ToList(), other.Attributes.ToList())) {
return false;
}
return true;
}
/// <summary>
/// Serves as a hash function for a particular type.
/// </summary>
/// <returns>
/// A hash code for the current <see cref="T:System.Object"/>.
/// </returns>
public override int GetHashCode() {
unchecked {
int hashCode = this.Version.GetHashCode();
if (this.UpdateUrl != null) {
hashCode += this.UpdateUrl.GetHashCode();
}
foreach (AttributeValues value in this.Attributes) {
hashCode += value.GetHashCode();
}
return hashCode;
}
}
#region IMessageWithEvents Members
/// <summary>
/// Called when the message is about to be transmitted,
/// before it passes through the channel binding elements.
/// </summary>
void IMessageWithEvents.OnSending() {
var extraData = ((IMessage)this).ExtraData;
AXUtilities.SerializeAttributes(extraData, this.attributesProvided);
}
/// <summary>
/// Called when the message has been received,
/// after it passes through the channel binding elements.
/// </summary>
void IMessageWithEvents.OnReceiving() {
var extraData = ((IMessage)this).ExtraData;
foreach (var att in AXUtilities.DeserializeAttributes(extraData)) {
this.Attributes.Add(att);
}
}
#endregion
/// <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>
protected override void EnsureValidMessage() {
base.EnsureValidMessage();
if (this.UpdateUrl != null && !this.UpdateUrl.IsAbsoluteUri) {
this.UpdateUrl = null;
Logger.OpenId.ErrorFormat("The AX fetch response update_url parameter was not absolute ('{0}'). Ignoring value.", this.UpdateUrl);
}
}
}
}
|
