This repository has been archived by the owner on Mar 20, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 732
/
Protocol.cs
245 lines (238 loc) · 10.1 KB
/
Protocol.cs
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
using System;
using System.Collections.Generic;
using System.Text;
namespace DotNetOpenId {
/// <summary>
/// Tracks the several versions of OpenID this library supports and the unique
/// constants to each version used in the protocol.
/// </summary>
internal partial class Protocol {
Protocol(QueryParameters queryBits) {
openidnp = queryBits;
openid = new QueryParameters(queryBits);
}
// Well-known, supported versions of the OpenID spec.
public static readonly Protocol v10 = new Protocol(new QueryParameters()) {
Version = new Version(1, 0),
XmlNamespace = "http://openid.net/xmlns/1.0",
QueryDeclaredNamespaceVersion = null,
ClaimedIdentifierServiceTypeURI = "http://openid.net/signon/1.0",
OPIdentifierServiceTypeURI = null, // not supported
ClaimedIdentifierForOPIdentifier = null, // not supported
HtmlDiscoveryProviderKey = "openid.server",
HtmlDiscoveryLocalIdKey = "openid.delegate",
};
public static readonly Protocol v11 = new Protocol(new QueryParameters()) {
Version = new Version(1, 1),
XmlNamespace = "http://openid.net/xmlns/1.0",
QueryDeclaredNamespaceVersion = null,
ClaimedIdentifierServiceTypeURI = "http://openid.net/signon/1.1",
OPIdentifierServiceTypeURI = null, // not supported
ClaimedIdentifierForOPIdentifier = null, // not supported
HtmlDiscoveryProviderKey = "openid.server",
HtmlDiscoveryLocalIdKey = "openid.delegate",
};
public static readonly Protocol v20 = new Protocol(new QueryParameters() {
Realm = "realm",
op_endpoint = "op_endpoint",
response_nonce = "response_nonce",
}) {
Version = new Version(2, 0),
XmlNamespace = null, // no longer applicable
QueryDeclaredNamespaceVersion = "http://specs.openid.net/auth/2.0",
ClaimedIdentifierServiceTypeURI = "http://specs.openid.net/auth/2.0/signon",
OPIdentifierServiceTypeURI = "http://specs.openid.net/auth/2.0/server",
ClaimedIdentifierForOPIdentifier = "http://specs.openid.net/auth/2.0/identifier_select",
HtmlDiscoveryProviderKey = "openid2.provider",
HtmlDiscoveryLocalIdKey = "openid2.local_id",
Args = new QueryArguments() {
SessionType = new QueryArguments.SessionTypes() {
NoEncryption = "no-encryption",
},
},
};
/// <summary>
/// A list of all supported OpenID versions, in order starting from newest version.
/// </summary>
public readonly static List<Protocol> AllVersions = new List<Protocol>() { v20, v11, v10 };
/// <summary>
/// The default (or most recent) supported version of the OpenID protocol.
/// </summary>
public readonly static Protocol Default = AllVersions[0];
/// <summary>
/// Attempts to detect the right OpenID protocol version based on the contents
/// of an incoming query string.
/// </summary>
internal static Protocol Detect(IDictionary<string, string> Query) {
return Query.ContainsKey(v20.openid.ns) ? v20 : v11;
}
/// <summary>
/// The OpenID version that this <see cref="Protocol"/> instance describes.
/// </summary>
public Version Version;
/// <summary>
/// The namespace of OpenId 1.x elements in XRDS documents.
/// </summary>
public string XmlNamespace;
/// <summary>
/// The value of the openid.ns parameter that appears on the query string
/// whenever data is passed between relying party and provider for OpenID 2.0
/// and later.
/// </summary>
public string QueryDeclaredNamespaceVersion;
/// <summary>
/// The XRD/Service/Type value discovered in an XRDS document when
/// "discovering" on a Claimed Identifier (http://andrewarnott.yahoo.com)
/// </summary>
public string ClaimedIdentifierServiceTypeURI;
/// <summary>
/// The XRD/Service/Type value discovered in an XRDS document when
/// "discovering" on an OP Identifier rather than a Claimed Identifier.
/// (http://yahoo.com)
/// </summary>
public string OPIdentifierServiceTypeURI;
/// <summary>
/// Used as the Claimed Identifier and the OP Local Identifier when
/// the User Supplied Identifier is an OP Identifier.
/// </summary>
public string ClaimedIdentifierForOPIdentifier;
/// <summary>
/// The value of the 'rel' attribute in an HTML document's LINK tag
/// when the same LINK tag's HREF attribute value contains the URL to an
/// OP Endpoint URL.
/// </summary>
public string HtmlDiscoveryProviderKey;
/// <summary>
/// The value of the 'rel' attribute in an HTML document's LINK tag
/// when the same LINK tag's HREF attribute value contains the URL to use
/// as the OP Local Identifier.
/// </summary>
public string HtmlDiscoveryLocalIdKey;
/// <summary>
/// Parts of the protocol that define parameter names that appear in the
/// query string. Each parameter name is prefixed with 'openid.'.
/// </summary>
public readonly QueryParameters openid;
/// <summary>
/// Parts of the protocol that define parameter names that appear in the
/// query string. Each parameter name is NOT prefixed with 'openid.'.
/// </summary>
public readonly QueryParameters openidnp;
/// <summary>
/// The various 'constants' that appear as parameter arguments (values).
/// </summary>
public QueryArguments Args = new QueryArguments();
internal class QueryParameters {
public string Prefix = "openid.";
public QueryParameters() { }
public QueryParameters(QueryParameters addPrefixTo) {
ns = Prefix + addPrefixTo.ns;
return_to = Prefix + addPrefixTo.return_to;
Realm = Prefix + addPrefixTo.Realm;
mode = Prefix + addPrefixTo.mode;
error = Prefix + addPrefixTo.error;
identity = Prefix + addPrefixTo.identity;
op_endpoint = Prefix + addPrefixTo.op_endpoint;
response_nonce = Prefix + addPrefixTo.response_nonce;
claimed_id = Prefix + addPrefixTo.claimed_id;
expires_in = Prefix + addPrefixTo.expires_in;
assoc_type = Prefix + addPrefixTo.assoc_type;
assoc_handle = Prefix + addPrefixTo.assoc_handle;
session_type = Prefix + addPrefixTo.session_type;
is_valid = Prefix + addPrefixTo.is_valid;
sig = Prefix + addPrefixTo.sig;
signed = Prefix + addPrefixTo.signed;
user_setup_url = Prefix + addPrefixTo.user_setup_url;
invalidate_handle = Prefix + addPrefixTo.invalidate_handle;
dh_modulus = Prefix + addPrefixTo.dh_modulus;
dh_gen = Prefix + addPrefixTo.dh_gen;
dh_consumer_public = Prefix + addPrefixTo.dh_consumer_public;
dh_server_public = Prefix + addPrefixTo.dh_server_public;
enc_mac_key = Prefix + addPrefixTo.enc_mac_key;
mac_key = Prefix + addPrefixTo.mac_key;
}
// These fields default to 1.x specifications, and are overridden
// as necessary by later versions in the Protocol class initializers.
public string ns = "ns";
public string return_to = "return_to";
public string Realm = "trust_root";
public string mode = "mode";
public string error = "error";
public string identity = "identity";
public string op_endpoint = null;
public string response_nonce = null;
public string claimed_id = "claimed_id";
public string expires_in = "expires_in";
public string assoc_type = "assoc_type";
public string assoc_handle = "assoc_handle";
public string session_type = "session_type";
public string is_valid = "is_valid";
public string sig = "sig";
public string signed = "signed";
public string user_setup_url = "user_setup_url";
public string invalidate_handle = "invalidate_handle";
public string dh_modulus = "dh_modulus";
public string dh_gen = "dh_gen";
public string dh_consumer_public = "dh_consumer_public";
public string dh_server_public = "dh_server_public";
public string enc_mac_key = "enc_mac_key";
public string mac_key = "mac_key";
}
internal class QueryArguments {
public SessionTypes SessionType = new SessionTypes();
public SignatureAlgorithms SignatureAlgorithm = new SignatureAlgorithms();
public Modes Mode = new Modes();
public IsValidValues IsValid = new IsValidValues();
internal class SessionTypes {
public string DH_SHA1 = "DH-SHA1";
public string DH_SHA256 = "DH-SHA256";
public string NoEncryption = "";
}
internal class SignatureAlgorithms {
public string HMAC_SHA1 = "HMAC-SHA1";
public string HMAC_SHA256 = "HMAC-SHA256";
}
internal class Modes {
public string cancel = "cancel";
public string error = "error";
public string id_res = "id_res";
public string checkid_immediate = "checkid_immediate";
public string checkid_setup = "checkid_setup";
public string check_authentication = "check_authentication";
public string associate = "associate";
}
internal class IsValidValues {
public string True = "true";
}
}
/// <summary>
/// The maximum time a user can be allowed to take to complete authentication.
/// </summary>
/// <remarks>
/// This is used to calculate the length of time that nonces are stored.
/// This is internal until we can decide whether to leave this static, or make
/// it an instance member, or put it inside the IConsumerAppliationStore interface.
/// </remarks>
internal static TimeSpan MaximumUserAgentAuthenticationTime = TimeSpan.FromMinutes(5);
/// <summary>
/// The maximum permissible difference in clocks between relying party and
/// provider web servers, discounting time zone differences.
/// </summary>
/// <remarks>
/// This is used when storing/validating nonces from the provider.
/// If it is conceivable that a server's clock could be up to five minutes
/// off from true UTC time, then the maximum time skew should be set to
/// ten minutes to allow one server to be five minutes ahead and the remote
/// server to be five minutes behind and still be able to communicate.
/// </remarks>
internal static TimeSpan MaximumAllowableTimeSkew = TimeSpan.FromMinutes(10);
public override bool Equals(object obj) {
Protocol other = obj as Protocol;
if (other == null) return false;
return this.Version == other.Version;
}
public override int GetHashCode() {
return Version.GetHashCode();
}
}
}