MachineKeySection 类

定义

命名空间:

System.Web.Configuration

程序集:

System.Web.dll

定义控制密钥生成和算法的配置设置，这些密钥生成和算法在 Windows Forms 身份验证、视图状态验证和会话状态应用程序隔离中用于加密、解密和消息身份验证代码 (MAC) 操作。 此类不能被继承。

public ref class MachineKeySection sealed : System::Configuration::ConfigurationSection

public sealed class MachineKeySection : System.Configuration.ConfigurationSection

type MachineKeySection = class
    inherit ConfigurationSection

Public NotInheritable Class MachineKeySection
Inherits ConfigurationSection

继承

Object

ConfigurationElement

ConfigurationSection

MachineKeySection

示例

本节中的示例演示如何以声明方式为 machineKey 节的多个属性指定值，这些属性也可以作为 类的成员 MachineKeySection 进行访问。

配置文件中的以下示例演示如何以声明方式为 machineKey 节指定值。

<system.web>  
  <machineKey validationKey="AutoGenerate,IsolateApps"   
    decryptionKey="AutoGenerate,IsolateApps"   
    validation="SHA1"/>  
</system.web>  

此示例使用 SHA1。 由于与 SHA1 冲突，Microsoft 建议使用 SHA256。

以下示例演示如何在代码中使用 MachineKeySection 类。

#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Web;
using System.Web.Configuration;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingMachineKeySection
  {
    static void Main(string[] args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";

        // Get the Web application configuration object.
        Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section related object.
        MachineKeySection configSection = 
          (MachineKeySection)config.GetSection("system.web/machineKey");

        // Display title and info.
        Console.WriteLine("ASP.NET Configuration Info");
        Console.WriteLine();

        // Display Config details.
        Console.WriteLine("File Path: {0}",
          config.FilePath);
        Console.WriteLine("Section Path: {0}",
          configSection.SectionInformation.Name);

        // Display ValidationKey property.
        Console.WriteLine("ValidationKey: {0}",
          configSection.ValidationKey);

        // Set ValidationKey property.
        configSection.ValidationKey = "AutoGenerate,IsolateApps";

        // Display DecryptionKey property.
        Console.WriteLine("DecryptionKey: {0}",
          configSection.DecryptionKey);

        // Set DecryptionKey property.
        configSection.DecryptionKey = "AutoGenerate,IsolateApps";

        // Display Validation property.
        Console.WriteLine("Validation: {0}",
          configSection.Validation);

        // Set Validation property.
        configSection.Validation = MachineKeyValidation.HMACSHA256;

        // Update if not locked.
        if (!configSection.SectionInformation.IsLocked)
        {
          config.Save();
          Console.WriteLine("** Configuration updated.");
        }
        else
        {
          Console.WriteLine("** Could not update, section is locked.");
        }
      }

      catch (Exception e)
      {
        // Unknown error.
        Console.WriteLine(e.ToString());
      }

      // Display and wait
      Console.ReadLine();
    }
  }
}

Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingMachineKeySection
    Public Shared Sub Main()
      Try
        ' Set the path of the config file.
        Dim configPath As String = ""

        ' Get the Web application configuration object.
        Dim config As System.Configuration.Configuration = _
         System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object.
        Dim configSection As System.Web.Configuration.MachineKeySection = _
         CType(config.GetSection("system.web/machineKey"), _
         System.Web.Configuration.MachineKeySection)

        ' Display title and info.
        Console.WriteLine("ASP.NET Configuration Info")
        Console.WriteLine()

        ' Display Config details.
        Console.WriteLine("File Path: {0}", config.FilePath)
        Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name)

        ' Display ValidationKey property.
        Console.WriteLine("ValidationKey: {0}", _
         configSection.ValidationKey)

        ' Set ValidationKey property.
        configSection.ValidationKey = "AutoGenerate,IsolateApps"

        ' Display DecryptionKey property.
        Console.WriteLine("DecryptionKey: {0}", configSection.DecryptionKey)

        ' Set DecryptionKey property.
        configSection.DecryptionKey = "AutoGenerate,IsolateApps"

        ' Display Validation value.
        Console.WriteLine("Validation: {0}", configSection.Validation)

        ' Set Validation value.
        configSection.Validation = MachineKeyValidation.HMACSHA256

        ' Update if not locked.
        If Not configSection.SectionInformation.IsLocked Then
          config.Save()
          Console.WriteLine("** Configuration updated.")
        Else
          Console.WriteLine("** Could not update, section is locked.")
        End If

      Catch e As Exception
        ' Unknown error.
        Console.WriteLine(e.ToString())
      End Try

      ' Display and wait
      Console.ReadLine()
    End Sub
  End Class
End Namespace

注解

类 MachineKeySection 提供了一种以编程方式访问和修改配置文件中 节内容 MachineKey 的方法。 MachineKey可以在计算机 (Machine.config) 或应用程序 (Web.config) 级别配置节，并控制用于Windows 窗体身份验证、视图状态验证和会话状态应用程序隔离的密钥和算法。 若要在 Web 服务器网络 (Web 场) 中运行这些功能，DecryptionKey必须使用有效的键值显式配置 节的 MachineKey 和 ValidationKey 属性。 该值 AutoGenerate 不适用于 Web 场，因为它依赖于加密随机机密，该机密使用计算机本地保护持久保存，并且不会在多台计算机上相同。

继承者说明

如果要按照 Web 场方案中的要求在此配置节中指定密钥，建议使用受保护的配置来加密此部分。

构造函数

MachineKeySection()

使用默认设置初始化 MachineKeySection 类的新实例。

属性

ApplicationName	获取或设置应用程序的名称。
CompatibilityMode	获取或设置一个值，该值指定视图状态的升级加密方法是否在使用 .NET Framework 2.0 版 Service Pack 1 发行版后引入。
CurrentConfiguration	获取对顶级 Configuration 实例的引用，该实例表示当前 ConfigurationElement 实例所属的配置层次结构。 (继承自 ConfigurationElement)
DataProtectorType	获取或设置数据保护器类型名称。 默认值为 Empty。
Decryption	指定用于加密和解密 Forms 身份验证数据的加密算法。
DecryptionKey	获取或设置用来加密和解密数据的密钥，或生成密钥的过程。
ElementInformation	获取包含 ConfigurationElement 对象的不可自定义的信息和功能的 ElementInformation 对象。 (继承自 ConfigurationElement)
ElementProperty	获取表示 ConfigurationElement 对象本身的 ConfigurationElementProperty 对象。 (继承自 ConfigurationElement)
EvaluationContext	获取 ConfigurationElement 对象的 ContextInformation 对象。 (继承自 ConfigurationElement)
HasContext	获取一个值，该值指示 CurrentConfiguration 属性是否为 null。 (继承自 ConfigurationElement)
Item[ConfigurationProperty]	获取或设置此配置元素的属性或特性。 (继承自 ConfigurationElement)
Item[String]	获取或设置此配置元素的属性、特性或子元素。 (继承自 ConfigurationElement)
LockAllAttributesExcept	获取被锁定的特性的集合。 (继承自 ConfigurationElement)
LockAllElementsExcept	获取被锁定的元素的集合。 (继承自 ConfigurationElement)
LockAttributes	获取被锁定的特性的集合。 (继承自 ConfigurationElement)
LockElements	获取被锁定的元素的集合。 (继承自 ConfigurationElement)
LockItem	获取或设置一个值，该值指示是否已锁定该元素。 (继承自 ConfigurationElement)
Properties	获取属性的集合。 (继承自 ConfigurationElement)
SectionInformation	获取一个 SectionInformation 对象，该对象包含 ConfigurationSection 对象的不可自定义的信息和功能。 (继承自 ConfigurationSection)
Validation	指定用于验证 Forms 身份验证和视图状态数据的哈希算法。
ValidationAlgorithm	获取或设置指示用于验证 Forms 身份验证和视图状态数据的算法的名称。
ValidationKey	获取或设置键，用来验证 Forms 身份验证和视图状态数据的代码，或生成密钥的过程。

方法

DeserializeElement(XmlReader, Boolean)	从配置文件读取 XML。 (继承自 ConfigurationElement)
DeserializeSection(XmlReader)	从配置文件读取 XML。 (继承自 ConfigurationSection)
Equals(Object)	将当前的 ConfigurationElement 实例与指定的对象进行比较。 (继承自 ConfigurationElement)
GetHashCode()	获取表示当前 ConfigurationElement 实例的唯一值。 (继承自 ConfigurationElement)
GetRuntimeObject()	在派生的类中重写时返回自定义对象。 (继承自 ConfigurationSection)
GetTransformedAssemblyString(String)	返回指定程序集名称的转换版本。 (继承自 ConfigurationElement)
GetTransformedTypeString(String)	返回指定类型名称的转换版本。 (继承自 ConfigurationElement)
GetType()	获取当前实例的 Type。 (继承自 Object)
Init()	将 ConfigurationElement 对象设置为其初始状态。 (继承自 ConfigurationElement)
InitializeDefault()	用于初始化 ConfigurationElement 对象的默认值集。 (继承自 ConfigurationElement)
IsModified()	指示自上次在派生类中实现此配置元素时保存或加载以来是否对其进行过修改。 (继承自 ConfigurationSection)
IsReadOnly()	获取一个值，该值指示 ConfigurationElement 对象是否为只读。 (继承自 ConfigurationElement)
ListErrors(IList)	将此 ConfigurationElement 对象以及所有子元素中无效属性的错误添加到传递的列表中。 (继承自 ConfigurationElement)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
OnDeserializeUnrecognizedAttribute(String, String)	获取一个值，该值指示反序列化过程中是否遇到未知特性。 (继承自 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	获取一个值，该值指示反序列化过程中是否遇到未知元素。 (继承自 ConfigurationElement)
OnRequiredPropertyNotFound(String)	找不到所需属性时引发异常。 (继承自 ConfigurationElement)
PostDeserialize()	反序列化后调用。 (继承自 ConfigurationElement)
PreSerialize(XmlWriter)	在序列化之前调用。 (继承自 ConfigurationElement)
Reset(ConfigurationElement)	重置 ConfigurationElement 对象的内部状态，包括锁和属性集合。 (继承自 ConfigurationElement)
ResetModified()	在派生类中实现时，将 IsModified() 方法的值重置为 false。 (继承自 ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	当在派生类中实现后，将此配置元素的内容写入配置文件。 (继承自 ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	创建一个包含 ConfigurationSection 对象的分离视图的 XML 字符串，作为单独的节写入到文件中。 (继承自 ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	当在派生类中实现后，将此配置元素的外部标记写入配置文件。 (继承自 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	将属性设置为指定值。 (继承自 ConfigurationElement)
SetReadOnly()	设置 ConfigurationElement 对象及所有子元素的 IsReadOnly() 属性。 (继承自 ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	指示在为.NET Framework的指定目标版本序列化配置对象层次结构时，是否应序列化指定的元素。 (继承自 ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	指示在为.NET Framework的指定目标版本序列化配置对象层次结构时，是否应序列化指定的属性。 (继承自 ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)	指示在为.NET Framework的指定目标版本序列化配置对象层次结构时，是否应序列化当前ConfigurationSection实例。 (继承自 ConfigurationSection)
ToString()	返回表示当前对象的字符串。 (继承自 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	修改 ConfigurationElement 对象以移除所有不应该保存的值。 (继承自 ConfigurationElement)

另请参阅

• ConfigurationSection
• Forms 身份验证凭据