ProtectedConfiguration Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

System.Object
  System.Configuration.ProtectedConfiguration

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

NameDescription
System_CAPS_pubpropertySystem_CAPS_staticDefaultProvider

Gets the name of the default protected-configuration provider.

System_CAPS_pubpropertySystem_CAPS_staticProviders

Gets a collection of the installed protected-configuration providers.

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDataProtectionProviderName

The name of the data protection provider.

System_CAPS_pubfieldSystem_CAPS_staticProtectedDataSectionName

The name of the protected data section.

System_CAPS_pubfieldSystem_CAPS_staticRsaProviderName

The 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 = _
        ProtectedConfiguration.Providers

        Dim pEnum As IEnumerator = _
        providers.GetEnumerator()

        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 = _
        ProtectedConfiguration.DataProtectionProviderName
        Console.WriteLine( _
        "Data protection provider name: {0}", _
        dataProtectionProviderName)

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

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

    End Sub 'GetProviderName


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


        ' Get current and Rsa provider names.
        GetProviderName()

        ' Get the providers' collection.
        GetProviders()

    End Sub 'Main 

End Class 'UsingProtectedConfiguration 

.NET Framework
Available since 2.0

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

Return to top
Show: