This documentation is archived and is not being maintained.

ProtectedConfiguration Class

Provides access to the protected-configuration providers for the current application's configuration file.


Namespace:  System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)

<PermissionSetAttribute(SecurityAction.LinkDemand, Name := "FullTrust")> _
Public NotInheritable Class ProtectedConfiguration

The ProtectedConfiguration type exposes the following members.

Public propertyStatic memberDefaultProviderGets the name of the default protected-configuration provider.
Public propertyStatic memberProvidersGets a collection of the installed protected-configuration providers.

Public fieldStatic memberDataProtectionProviderNameThe name of the data protection provider.
Public fieldStatic memberProtectedDataSectionNameThe name of the protected data section.
Public fieldStatic memberRsaProviderNameThe name of the RSA provider.

The ProtectedConfiguration class allows you to obtain information about the providers available to protect sensitive configuration data. You typically use the standard providers, but you can also create custom providers by deriving from the ProtectedConfigurationProvider class.

For more information about protected configuration, see Encrypting Configuration Information Using Protected Configuration.

The following example shows how to use the ProtectedConfiguration class to retrieve a collection of protected-configuration providers and discover their provider name, RSA provider name, and section names.

Imports System
Imports System.Configuration
Imports System.Collections
Imports System.Security.Permissions

' Show how to use the ProtectedConfiguration.
NotInheritable Public Class UsingProtectedConfiguration

   <PermissionSet( _
    SecurityAction.Demand, Name:="FullTrust")> _
    Private Shared Sub GetProviders()
      ' Get the providers' collection.
        Dim providers _
        As ProtectedConfigurationProviderCollection = _

        Dim pEnum As IEnumerator = _

        Dim provider _
        As ProtectedConfigurationProvider

        For Each provider In providers
            Console.WriteLine( _
            "Provider name: {0}", provider.Name)
            Console.WriteLine( _
            "Provider description: {0}", provider.Description)
        Next provider
   End Sub 'GetProviders

   <PermissionSet( _
    SecurityAction.Demand, Name:="FullTrust")> _
    Private Shared Sub GetProviderName()
      ' Get the current provider name.
        Dim dataProtectionProviderName As String = _
        Console.WriteLine( _
        "Data protection provider name: {0}", _

      ' Get the Rsa provider name.
        Dim rsaProviderName As String = _
        Console.WriteLine( _
        "Rsa provider name: {0}", rsaProviderName)

        ' Get the Rsa provider name.
        Dim protectedSectionName As String = _
        Console.WriteLine( _
        "Protected section name: {0}", protectedSectionName)

    End Sub 'GetProviderName

    Public Shared Sub Main(ByVal args() As String)

        ' Get current and Rsa provider names.

        ' Get the providers' collection.

    End Sub 'Main 

End Class 'UsingProtectedConfiguration 

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.