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
|
//-----------------------------------------------------------------------
// <copyright file="MessageBase.cs" company="Andrew Arnott">
// Copyright (c) Andrew Arnott. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
namespace DotNetOAuth.Messages {
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Text;
using DotNetOAuth.ChannelElements;
using DotNetOAuth.Messaging;
using DotNetOAuth.Messaging.Reflection;
/// <summary>
/// A base class for all OAuth messages.
/// </summary>
public abstract class MessageBase : IOAuthDirectedMessage {
/// <summary>
/// A store for extra name/value data pairs that are attached to this message.
/// </summary>
private Dictionary<string, string> extraData = new Dictionary<string, string>();
/// <summary>
/// Gets a value indicating whether signing this message is required.
/// </summary>
private MessageProtection protectionRequired;
/// <summary>
/// Gets a value indicating whether this is a direct or indirect message.
/// </summary>
private MessageTransport transport;
/// <summary>
/// The URI to the remote endpoint to send this message to.
/// </summary>
private MessageReceivingEndpoint recipient;
#if DEBUG
/// <summary>
/// Initializes static members of the <see cref="MessageBase"/> class.
/// </summary>
static MessageBase() {
LowSecurityMode = true;
}
#endif
/// <summary>
/// Initializes a new instance of the <see cref="MessageBase"/> class.
/// </summary>
/// <param name="protectionRequired">The level of protection the message requires.</param>
/// <param name="transport">A value indicating whether this message requires a direct or indirect transport.</param>
protected MessageBase(MessageProtection protectionRequired, MessageTransport transport) {
this.protectionRequired = protectionRequired;
this.transport = transport;
}
/// <summary>
/// Initializes a new instance of the <see cref="MessageBase"/> class.
/// </summary>
/// <param name="protectionRequired">The level of protection the message requires.</param>
/// <param name="transport">A value indicating whether this message requires a direct or indirect transport.</param>
/// <param name="recipient">The URI that a directed message will be delivered to.</param>
protected MessageBase(MessageProtection protectionRequired, MessageTransport transport, MessageReceivingEndpoint recipient) {
if (recipient == null) {
throw new ArgumentNullException("recipient");
}
this.protectionRequired = protectionRequired;
this.transport = transport;
this.recipient = recipient;
}
#region IProtocolMessage Properties
/// <summary>
/// Gets the version of the protocol this message is prepared to implement.
/// </summary>
Version IProtocolMessage.ProtocolVersion {
get { return new Version(1, 0); }
}
/// <summary>
/// Gets the level of protection this message requires.
/// </summary>
MessageProtection IProtocolMessage.RequiredProtection {
get { return this.protectionRequired; }
}
/// <summary>
/// Gets a value indicating whether this is a direct or indirect message.
/// </summary>
MessageTransport IProtocolMessage.Transport {
get { return this.transport; }
}
/// <summary>
/// Gets the dictionary of additional name/value fields tacked on to this message.
/// </summary>
IDictionary<string, string> IProtocolMessage.ExtraData {
get { return this.extraData; }
}
#endregion
#region IDirectedProtocolMessage Members
/// <summary>
/// Gets the URI to the Service Provider endpoint to send this message to.
/// </summary>
Uri IDirectedProtocolMessage.Recipient {
get { return this.recipient.Location; }
}
#endregion
#region IOAuthDirectedMessage Properties
/// <summary>
/// Gets the preferred method of transport for the message.
/// </summary>
HttpDeliveryMethod IOAuthDirectedMessage.HttpMethods {
get { return this.recipient != null ? this.recipient.AllowedMethods : HttpDeliveryMethod.None; }
}
/// <summary>
/// Gets or sets the URI to the Service Provider endpoint to send this message to.
/// </summary>
Uri IOAuthDirectedMessage.Recipient {
get {
return this.recipient != null ? this.recipient.Location : null;
}
set {
if (this.recipient != null) {
this.recipient = new MessageReceivingEndpoint(value, this.recipient.AllowedMethods);
} else if (value != null) {
throw new InvalidOperationException();
}
}
}
#endregion
/// <summary>
/// Gets or sets a value indicating whether security sensitive strings are
/// emitted from the ToString() method.
/// </summary>
internal static bool LowSecurityMode { get; set; }
#region IProtocolMessage Methods
/// <summary>
/// Checks the message state for conformity to the protocol specification
/// and throws an exception if the message is invalid.
/// </summary>
void IProtocolMessage.EnsureValidMessage() {
this.EnsureValidMessage();
}
#endregion
/// <summary>
/// Returns a human-friendly string describing the message and all serializable properties.
/// </summary>
/// <returns>The string representation of this object.</returns>
public override string ToString() {
StringBuilder builder = new StringBuilder();
builder.AppendFormat(CultureInfo.InvariantCulture, "{0} message", GetType().Name);
if (this.recipient != null) {
builder.AppendFormat(CultureInfo.InvariantCulture, " as {0} to {1}", this.recipient.AllowedMethods, this.recipient.Location);
}
builder.AppendLine();
MessageDictionary dictionary = new MessageDictionary(this);
foreach (var pair in dictionary) {
string value = pair.Value;
if (pair.Key == "oauth_signature" && !LowSecurityMode) {
value = "xxxxxxxxxxxxx (not shown)";
}
builder.Append('\t');
builder.Append(pair.Key);
builder.Append(": ");
builder.AppendLine(value);
}
return builder.ToString();
}
/// <summary>
/// Checks the message state for conformity to the protocol specification
/// and throws an exception if the message is invalid.
/// </summary>
protected virtual void EnsureValidMessage() { }
}
}
|
