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 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
|
//
// System.Web.Configuration.MachineKeySection
//
// Authors:
// Chris Toshok (toshok@ximian.com)
// Sebastien Pouliot <sebastien@ximian.com>
//
// (c) Copyright 2005, 2010 Novell, Inc (http://www.novell.com)
//
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.ComponentModel;
using System.Configuration;
using System.Security.Cryptography;
using System.Web.Util;
namespace System.Web.Configuration {
public sealed class MachineKeySection : ConfigurationSection
{
static ConfigurationProperty decryptionProp;
static ConfigurationProperty decryptionKeyProp;
static ConfigurationProperty validationProp;
static ConfigurationProperty validationKeyProp;
static ConfigurationPropertyCollection properties;
static MachineKeyValidationConverter converter = new MachineKeyValidationConverter ();
MachineKeyValidation validation;
static MachineKeySection ()
{
decryptionProp = new ConfigurationProperty ("decryption", typeof (string), "Auto",
PropertyHelper.WhiteSpaceTrimStringConverter,
PropertyHelper.NonEmptyStringValidator,
ConfigurationPropertyOptions.None);
decryptionKeyProp = new ConfigurationProperty ("decryptionKey", typeof (string), "AutoGenerate,IsolateApps",
PropertyHelper.WhiteSpaceTrimStringConverter,
PropertyHelper.NonEmptyStringValidator,
ConfigurationPropertyOptions.None);
validationProp = new ConfigurationProperty ("validation", typeof (string), "HMACSHA256",
PropertyHelper.WhiteSpaceTrimStringConverter,
PropertyHelper.NonEmptyStringValidator,
ConfigurationPropertyOptions.None);
validationKeyProp = new ConfigurationProperty ("validationKey", typeof (string), "AutoGenerate,IsolateApps",
PropertyHelper.WhiteSpaceTrimStringConverter,
PropertyHelper.NonEmptyStringValidator,
ConfigurationPropertyOptions.None);
properties = new ConfigurationPropertyCollection ();
properties.Add (decryptionProp);
properties.Add (decryptionKeyProp);
properties.Add (validationProp);
properties.Add (validationKeyProp);
Config.AutoGenerate (MachineKeyRegistryStorage.KeyType.Encryption);
Config.AutoGenerate (MachineKeyRegistryStorage.KeyType.Validation);
}
public MachineKeySection ()
{
// get DefaultValue from ValidationAlgorithm
validation = (MachineKeyValidation) converter.ConvertFrom (null, null, ValidationAlgorithm);
}
[MonoTODO]
public MachineKeyCompatibilityMode CompatibilityMode {
get; set;
}
protected internal override void Reset (ConfigurationElement parentElement)
{
base.Reset (parentElement);
decryption_key = null;
validation_key = null;
decryption_template = null;
validation_template = null;
}
[TypeConverter (typeof (WhiteSpaceTrimStringConverter))]
[StringValidator (MinLength = 1)]
[ConfigurationProperty ("decryption", DefaultValue = "Auto")]
public string Decryption {
get { return (string) base [decryptionProp];}
set {
decryption_template = MachineKeySectionUtils.GetDecryptionAlgorithm (value);
base[decryptionProp] = value;
}
}
[TypeConverter (typeof (WhiteSpaceTrimStringConverter))]
[StringValidator (MinLength = 1)]
[ConfigurationProperty ("decryptionKey", DefaultValue = "AutoGenerate,IsolateApps")]
public string DecryptionKey {
get { return (string) base [decryptionKeyProp];}
set {
base[decryptionKeyProp] = value;
SetDecryptionKey (value);
}
}
// property exists for backward compatibility
public MachineKeyValidation Validation {
get { return validation; }
set {
if (value == MachineKeyValidation.Custom)
throw new ArgumentException ();
string algo = value.ToString ();
// enum and accept values differs for TripleDES
ValidationAlgorithm = (algo == "TripleDES") ? "3DES" : algo;
}
}
[StringValidator (MinLength = 1)]
[TypeConverter (typeof (WhiteSpaceTrimStringConverter))]
[ConfigurationProperty ("validation", DefaultValue = "HMACSHA256")]
public string ValidationAlgorithm {
get { return (string) base [validationProp];}
set {
if (value == null)
return;
if (value.StartsWith ("alg:"))
validation = MachineKeyValidation.Custom;
else
validation = (MachineKeyValidation) converter.ConvertFrom (null, null, value);
base[validationProp] = value;
}
}
[TypeConverter (typeof (WhiteSpaceTrimStringConverter))]
[StringValidator (MinLength = 1)]
[ConfigurationProperty ("validationKey", DefaultValue = "AutoGenerate,IsolateApps")]
public string ValidationKey {
get { return (string) base [validationKeyProp];}
set {
base[validationKeyProp] = value;
SetValidationKey (value);
}
}
protected internal override ConfigurationPropertyCollection Properties {
get { return properties; }
}
internal static MachineKeySection Config {
get { return WebConfigurationManager.GetSection ("system.web/machineKey") as MachineKeySection; }
}
byte[] decryption_key;
byte[] validation_key;
SymmetricAlgorithm decryption_template;
KeyedHashAlgorithm validation_template;
internal SymmetricAlgorithm GetDecryptionAlgorithm ()
{
// code location to help with unit testing the code
return MachineKeySectionUtils.GetDecryptionAlgorithm (Decryption);
}
// not to be reused outside algorithm and key validation purpose
SymmetricAlgorithm DecryptionTemplate {
get {
if (decryption_template == null)
decryption_template = GetDecryptionAlgorithm ();
return decryption_template;
}
}
internal byte [] GetDecryptionKey ()
{
if (decryption_key == null)
SetDecryptionKey (DecryptionKey);
return decryption_key;
}
void SetDecryptionKey (string key)
{
if ((key == null) || key.StartsWith ("AutoGenerate")) {
decryption_key = AutoGenerate (MachineKeyRegistryStorage.KeyType.Encryption);
} else {
try {
decryption_key = MachineKeySectionUtils.GetBytes (key, key.Length);
DecryptionTemplate.Key = decryption_key;
}
catch {
decryption_key = null;
throw new ArgumentException ("Invalid key length");
}
}
}
internal KeyedHashAlgorithm GetValidationAlgorithm ()
{
// code location to help with unit testing the code
return MachineKeySectionUtils.GetValidationAlgorithm (this);
}
// not to be reused outside algorithm and key validation purpose
KeyedHashAlgorithm ValidationTemplate {
get {
if (validation_template == null)
validation_template = GetValidationAlgorithm ();
return validation_template;
}
}
internal byte [] GetValidationKey ()
{
if (validation_key == null)
SetValidationKey (ValidationKey);
return validation_key;
}
// key can be expended for HMAC - i.e. a small key, e.g. 32 bytes, is still accepted as valid
// the HMAC class already deals with keys larger than what it can use (digested to right size)
void SetValidationKey (string key)
{
if ((key == null) || key.StartsWith ("AutoGenerate")) {
validation_key = AutoGenerate (MachineKeyRegistryStorage.KeyType.Validation);
} else {
try {
validation_key = MachineKeySectionUtils.GetBytes (key, key.Length);
ValidationTemplate.Key = validation_key;
}
catch (CryptographicException) {
// second chance, use the key length that the HMAC really wants
try {
byte[] expanded_key = new byte [ValidationTemplate.Key.Length];
Array.Copy (validation_key, 0, expanded_key, 0, validation_key.Length);
ValidationTemplate.Key = expanded_key;
validation_key = expanded_key;
}
catch {
validation_key = null;
throw new ArgumentException ("Invalid key length");
}
}
}
}
byte[] AutoGenerate (MachineKeyRegistryStorage.KeyType type)
{
byte[] key = null;
try {
key = MachineKeyRegistryStorage.Retrieve (type);
// ensure the stored key is usable with the selection algorithm
if (type == MachineKeyRegistryStorage.KeyType.Encryption)
DecryptionTemplate.Key = key;
else if (type == MachineKeyRegistryStorage.KeyType.Validation)
ValidationTemplate.Key = key;
} catch (Exception) {
key = null;
}
// some algorithms have special needs for key (e.g. length, parity, weak keys...)
// so we better ask them to provide a default key (than to generate/use bad ones)
if (key == null) {
if (type == MachineKeyRegistryStorage.KeyType.Encryption)
key = DecryptionTemplate.Key;
else if (type == MachineKeyRegistryStorage.KeyType.Validation)
key = ValidationTemplate.Key;
MachineKeyRegistryStorage.Store (key, type);
}
return key;
}
}
}
|