ProtectedConfigurationSection 类

定义

命名空间:

System.Configuration

程序集:

System.Configuration.ConfigurationManager.dll

包:

System.Configuration.ConfigurationManager v8.0.0

Source:

ProtectedConfigurationSection.cs

提供对 configProtectedData 配置节的编程访问。 此类不能被继承。

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

public sealed class ProtectedConfigurationSection : System.Configuration.ConfigurationSection

type ProtectedConfigurationSection = class
    inherit ConfigurationSection

Public NotInheritable Class ProtectedConfigurationSection
Inherits ConfigurationSection

继承

Object

ConfigurationElement

ConfigurationSection

ProtectedConfigurationSection

示例

以下配置文件摘录演示如何以声明方式指定受保护的数据提供程序。

<configProtectedData defaultProvider="RsaProtectedConfigurationProvider">
  <providers>
    <clear />
      <add keyContainerName="NetFrameworkConfigurationKey" cspProviderName="" useMachineContainer="true" useOAEP="false" description="Uses RsaCryptoServiceProvider to encrypt and decrypt" name="RsaProtectedConfigurationProvider" type="System.Configuration.RsaProtectedConfigurationProvider,System.Configuration, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />

      <add useMachineProtection="true" description="Uses CryptProtectData and CryptUnProtectData Windows APIs to encrypt and decrypt" keyEntropy="" name="DataProtectionConfigurationProvider" type="System.Configuration.DpapiProtectedConfigurationProvider,System.Configuration, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />

  </providers>
</configProtectedData>

下面的代码示例演示如何使用 ProtectedConfigurationSection 类以编程方式访问配置文件节中的 configProtectedData 值。

using System;
using System.IO;
using System.Configuration;

namespace Samples.Aspnet
{
    // Shows how to use ProtectedConfigurationSection.
    class UsingProtectedConfigurationSection
    {

        static void GetDefaultProvider()
        {
            try
            {
                // Get the application configuration.
                Configuration config =
                    ConfigurationManager.OpenExeConfiguration(
                    ConfigurationUserLevel.None);

                // Get the protected configuration section.
                ProtectedConfigurationSection pcSection =
                    (System.Configuration.ProtectedConfigurationSection)
                    config.GetSection("configProtectedData");

                // Get the current DefaultProvider.
                Console.WriteLine(
                    "Protected configuration section default provider:");
                Console.WriteLine("  {0}", pcSection.DefaultProvider);
            }
            catch (ConfigurationErrorsException e)
            {
                Console.WriteLine(e.ToString());
            }
        }

        static void GetProviderCollection()
        {

            try
            {
                // Get the application configuration.
                Configuration config =
                    ConfigurationManager.OpenExeConfiguration(
                    ConfigurationUserLevel.None);

                // Get the protected configuration section.
                ProtectedConfigurationSection pcSection =
                    (System.Configuration.ProtectedConfigurationSection)
                    config.GetSection("configProtectedData");

                Console.WriteLine(
               "Protected configuration section providers:");
                foreach (ProviderSettings ps in
                pcSection.Providers)
                {
                    Console.WriteLine("  {0}", ps.Name);
                }
            }
            catch (ConfigurationErrorsException e)
            {
                Console.WriteLine(e.ToString());
            }
        }

        public static void Main()
        {
            GetDefaultProvider();
            GetProviderCollection();
        }
    }
}

Imports System.IO
Imports System.Configuration


' Shows how to use ProtectedConfigurationSection.

Class UsingProtectedConfigurationSection
    
    
    Shared Sub GetDefaultProvider() 
        Try
            ' Get the application configuration.
            Dim config As Configuration = _
            ConfigurationManager.OpenExeConfiguration( _
            ConfigurationUserLevel.None)
            
            ' Get the protected configuration section.
            Dim pcSection _
            As ProtectedConfigurationSection = _
            CType(config.GetSection( _
            "configProtectedData"), _
            System.Configuration.ProtectedConfigurationSection)
            
            ' Get the current DefaultProvider.
            Console.WriteLine( _
            "Protected configuration section default provider:")
            Console.WriteLine("{0}", _
            pcSection.DefaultProvider)
        
        Catch e As ConfigurationErrorsException
            Console.WriteLine(e.ToString())
        End Try
    
    End Sub
     
    
    Shared Sub GetProviderCollection() 
        
        Try
            ' Get the application configuration.
            Dim config As Configuration = _
            ConfigurationManager.OpenExeConfiguration( _
            ConfigurationUserLevel.None)

            ' Get the protected configuration section.
            Dim pcSection _
            As ProtectedConfigurationSection = _
            CType(config.GetSection( _
            "configProtectedData"), _
            System.Configuration.ProtectedConfigurationSection)

            Console.WriteLine( _
            "Protected configuration section providers:")
            Dim ps As ProviderSettings
            For Each ps In  pcSection.Providers
                Console.WriteLine("  {0}", ps.Name)
            Next ps
        
        Catch e As ConfigurationErrorsException
            Console.WriteLine(e.ToString())
        End Try
    
    End Sub
     

    Public Shared Sub Main() 
        GetDefaultProvider()
        GetProviderCollection()
    
    End Sub
End Class

注解

configProtectedData配置文件部分在其providers元素中包含受保护数据提供程序的集合。

注意

可以使用 Aspnet_regiis.exe 工具来加密和解密配置部分。 请参阅使用受保护的配置来加密配置信息。

构造函数

ProtectedConfigurationSection()

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

属性

CurrentConfiguration	获取对顶级 Configuration 实例的引用，该实例表示当前 ConfigurationElement 实例所属的配置层次结构。 (继承自 ConfigurationElement)
DefaultProvider	获取或设置 ProtectedConfigurationProvider 集合属性中默认的 Providers 对象的名称。
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)
Providers	获取所有参与的配置文件中所有 ProviderSettingsCollection 对象的 ProtectedConfigurationProvider 集合。
SectionInformation	获取一个 SectionInformation 对象，该对象包含 ConfigurationSection 对象的不可自定义的信息和功能。 (继承自 ConfigurationSection)

方法

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)

另请参阅

• ProtectedConfiguration
• ProtectedConfigurationProvider
• ProtectedConfigurationProviderCollection
• ProtectedProviderSettings
• 加密服务
• 使用受保护的配置来加密配置信息
• 演练：使用受保护的配置加密配置信息