summaryrefslogtreecommitdiffstats
path: root/src/DotNetOpenAuth.OAuth/Configuration/OAuthServiceProviderSecuritySettingsElement.cs
blob: 723b60786a3c657967fbc76d4086f437260cb4f9 (plain)
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
//-----------------------------------------------------------------------
// <copyright file="OAuthServiceProviderSecuritySettingsElement.cs" company="Andrew Arnott">
//     Copyright (c) Andrew Arnott. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------

namespace DotNetOpenAuth.Configuration {
	using System;
	using System.Collections.Generic;
	using System.Configuration;
	using System.Linq;
	using System.Text;
	using DotNetOpenAuth.OAuth;

	/// <summary>
	/// Security settings that are applicable to service providers.
	/// </summary>
	internal class OAuthServiceProviderSecuritySettingsElement : ConfigurationElement {
		/// <summary>
		/// Gets the name of the @minimumRequiredOAuthVersion attribute.
		/// </summary>
		private const string MinimumRequiredOAuthVersionConfigName = "minimumRequiredOAuthVersion";

		/// <summary>
		/// Gets the name of the @maxAuthorizationTime attribute.
		/// </summary>
		private const string MaximumRequestTokenTimeToLiveConfigName = "maxAuthorizationTime";

		/// <summary>
		/// Initializes a new instance of the <see cref="OAuthServiceProviderSecuritySettingsElement"/> class.
		/// </summary>
		internal OAuthServiceProviderSecuritySettingsElement() {
		}

		/// <summary>
		/// Gets or sets the minimum OAuth version a Consumer is required to support in order for this library to interoperate with it.
		/// </summary>
		/// <remarks>
		/// Although the earliest versions of OAuth are supported, for security reasons it may be desirable to require the
		/// remote party to support a later version of OAuth.
		/// </remarks>
		[ConfigurationProperty(MinimumRequiredOAuthVersionConfigName, DefaultValue = "V10")]
		public ProtocolVersion MinimumRequiredOAuthVersion {
			get { return (ProtocolVersion)this[MinimumRequiredOAuthVersionConfigName]; }
			set { this[MinimumRequiredOAuthVersionConfigName] = value; }
		}

		/// <summary>
		/// Gets or sets the maximum time a user can take to complete authorization.
		/// </summary>
		/// <remarks>
		/// This time limit serves as a security mitigation against brute force attacks to
		/// compromise (unauthorized or authorized) request tokens.
		/// Longer time limits is more friendly to slow users or consumers, while shorter
		/// time limits provide better security.
		/// </remarks>
		[ConfigurationProperty(MaximumRequestTokenTimeToLiveConfigName, DefaultValue = "0:05")] // 5 minutes
		[PositiveTimeSpanValidator]
		public TimeSpan MaximumRequestTokenTimeToLive {
			get { return (TimeSpan)this[MaximumRequestTokenTimeToLiveConfigName]; }
			set { this[MaximumRequestTokenTimeToLiveConfigName] = value; }
		}

		/// <summary>
		/// Initializes a programmatically manipulatable bag of these security settings with the settings from the config file.
		/// </summary>
		/// <returns>The newly created security settings object.</returns>
		internal ServiceProviderSecuritySettings CreateSecuritySettings() {
			return new ServiceProviderSecuritySettings {
				MinimumRequiredOAuthVersion = this.MinimumRequiredOAuthVersion,
				MaximumRequestTokenTimeToLive = this.MaximumRequestTokenTimeToLive,
			};
		}
	}
}