This documentation is archived and is not being maintained.

SectionInformation.ProtectSection Method

Marks a configuration section for protection.

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

public void ProtectSection(
	string protectionProvider
)

Parameters

protectionProvider
Type: System.String
The name of the protection provider to use.

ExceptionCondition
InvalidOperationException

The AllowLocation property is set to false.

- or -

The target section is already a protected data section.

The ProtectSection method marks the section for encryption so it will be written in encrypted form on disk.

The following protection providers are included by default:

DPAPIProtectedConfigurationProvider

RSAProtectedConfigurationProvider

NoteNote

If you call the ProtectSection method with a null parameter or an empty string, the RSAProtectedConfigurationProvider class is used as the protection provider.

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

The following example shows how to use the ProtectSection method.


static public void ProtectSection()
{

    // Get the current configuration file.
    System.Configuration.Configuration config =
            ConfigurationManager.OpenExeConfiguration(
            ConfigurationUserLevel.None);


    // Get the section.
    UrlsSection section =
        (UrlsSection)config.GetSection("MyUrls");


    // Protect (encrypt)the section.
    section.SectionInformation.ProtectSection(
        "RsaProtectedConfigurationProvider");

    // Save the encrypted section.
    section.SectionInformation.ForceSave = true;

    config.Save(ConfigurationSaveMode.Full);

    // Display decrypted configuration 
    // section. Note, the system
    // uses the Rsa provider to decrypt
    // the section transparently.
    string sectionXml =
        section.SectionInformation.GetRawXml();

    Console.WriteLine("Decrypted section:");
    Console.WriteLine(sectionXml);

}


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

Reference

DPAPIProtectedConfigurationProvider
RSAProtectedConfigurationProvider

Other Resources

Show: