ProtectedConfiguration Class (System.Configuration)

Switch View :
ScriptFree
.NET Framework Class Library
ProtectedConfiguration Class

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

Inheritance Hierarchy

System.Object
  System.Configuration.ProtectedConfiguration

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

Visual Basic
<PermissionSetAttribute(SecurityAction.LinkDemand, Name := "FullTrust")> _
Public NotInheritable Class ProtectedConfiguration
C#
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
public static class ProtectedConfiguration
Visual C++
[PermissionSetAttribute(SecurityAction::LinkDemand, Name = L"FullTrust")]
public ref class ProtectedConfiguration abstract sealed
F#
[<AbstractClass>]
[<Sealed>]
[<PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")>]
type ProtectedConfiguration =  class end

The ProtectedConfiguration type exposes the following members.

Properties

  Name Description
Public property Static member DefaultProvider Gets the name of the default protected-configuration provider.
Public property Static member Providers Gets a collection of the installed protected-configuration providers.
Top
Fields

  Name Description
Public field Static member DataProtectionProviderName The name of the data protection provider.
Public field Static member ProtectedDataSectionName The name of the protected data section.
Public field Static member RsaProviderName The name of the RSA provider.
Top
Remarks

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.

Examples

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.

Visual Basic

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 


C#

using System;
using System.Configuration;
using System.Collections;
using System.Security.Permissions;

namespace Samples.AspNet
{

    // Show how to use the ProtectedConfiguration.
    public sealed class UsingProtectedConfiguration
    {



        [PermissionSet(SecurityAction.Demand, Name="FullTrust")]    
 	 private static void GetProviders()
        {
            // Get the providers' collection.
            ProtectedConfigurationProviderCollection
                providers = ProtectedConfiguration.Providers;

            IEnumerator pEnum =
                providers.GetEnumerator();

            foreach (ProtectedConfigurationProvider provider in
                providers)
            {
                Console.WriteLine
                    ("Provider name: {0}",
                      provider.Name);
                Console.WriteLine
                         ("Provider description: {0}",
                          provider.Description);

            }

        }

       [PermissionSet(SecurityAction.Demand, Name="FullTrust")]    
	private static void GetProviderName()
        {
            // Get the current provider name.
            string dataProtectionProviderName =
               ProtectedConfiguration.DataProtectionProviderName;
            Console.WriteLine(
                "Data protection provider name: {0}",
                 dataProtectionProviderName);

            // Get the Rsa provider name.
            string rsaProviderName =
                ProtectedConfiguration.RsaProviderName;
            Console.WriteLine(
                "Rsa provider name: {0}",
                 rsaProviderName);

            // Get the protected section name.
            string protectedSectionName =
                ProtectedConfiguration.ProtectedDataSectionName;
            Console.WriteLine(
                "Protected section name: {0}",
                 protectedSectionName);


        }


        static void Main(string[] args)
        {


            // Get current and Rsa provider names.
            GetProviderName();

            // Get the providers' collection.
            GetProviders();


        }
    }    
}


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

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.
Thread Safety

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

Reference

Other Resources