ProtectedConfiguration Class

Definition

public ref class ProtectedConfiguration abstract sealed

public static class ProtectedConfiguration

type ProtectedConfiguration = class

Public Class ProtectedConfiguration

Inheritance

Object

ProtectedConfiguration

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.

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();
        }
    }    
}

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

   <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
   
   
    Public Shared Sub Main(ByVal args() As String)

       
        ' Get current and Rsa provider names.
        GetProviderName()

        ' Get the providers' collection.
        GetProviders()
        
    End Sub

End Class

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.

See also

• ProtectedConfigurationProvider
• ProtectedConfigurationSection
• Overview of Protected Configuration
• Encrypting Configuration Information Using Protected Configuration