MachineKeySection Klasse

Definition

Definiert die Konfigurationseinstellungen, die die Schlüsselgenerierung und Algorithmen steuern, die in Verschlüsselungs-, Entschlüsselungs- und Nachrichtenauthentifizierungscodevorgängen (MAC) in Windows Forms Authentifizierung, Ansichtszustandsüberprüfung und Anwendungsisolation des Sitzungszustands verwendet werden. Diese Klasse kann nicht vererbt werden.

public ref class MachineKeySection sealed : System::Configuration::ConfigurationSection
public sealed class MachineKeySection : System.Configuration.ConfigurationSection
type MachineKeySection = class
    inherit ConfigurationSection
Public NotInheritable Class MachineKeySection
Inherits ConfigurationSection
Vererbung

Beispiele

Das Beispiel in diesem Abschnitt veranschaulicht, wie Werte deklarativ für mehrere Attribute des MachineKey-Abschnitts angegeben werden, auf die auch als Member der MachineKeySection Klasse zugegriffen werden kann.

Das folgende Beispiel aus einer Konfigurationsdatei zeigt, wie Werte deklarativ für den MachineKey-Abschnitt angegeben werden.

<system.web>
  <machineKey validationKey="AutoGenerate,IsolateApps"
    decryptionKey="AutoGenerate,IsolateApps"
    validation="SHA1"/>
</system.web>

In diesem Beispiel wird SHA1 verwendet. Microsoft empfiehlt aufgrund der Konflikte mit SHA1 SHA256.

Im folgenden Beispiel wird die Verwendung der MachineKeySection Klasse im Code veranschaulicht.

#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Web;
using System.Web.Configuration;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingMachineKeySection
  {
    static void Main(string[] args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";

        // Get the Web application configuration object.
        Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section related object.
        MachineKeySection configSection = 
          (MachineKeySection)config.GetSection("system.web/machineKey");

        // Display title and info.
        Console.WriteLine("ASP.NET Configuration Info");
        Console.WriteLine();

        // Display Config details.
        Console.WriteLine("File Path: {0}",
          config.FilePath);
        Console.WriteLine("Section Path: {0}",
          configSection.SectionInformation.Name);

        // Display ValidationKey property.
        Console.WriteLine("ValidationKey: {0}",
          configSection.ValidationKey);

        // Set ValidationKey property.
        configSection.ValidationKey = "AutoGenerate,IsolateApps";

        // Display DecryptionKey property.
        Console.WriteLine("DecryptionKey: {0}",
          configSection.DecryptionKey);

        // Set DecryptionKey property.
        configSection.DecryptionKey = "AutoGenerate,IsolateApps";

        // Display Validation property.
        Console.WriteLine("Validation: {0}",
          configSection.Validation);

        // Set Validation property.
        configSection.Validation = MachineKeyValidation.HMACSHA256;

        // Update if not locked.
        if (!configSection.SectionInformation.IsLocked)
        {
          config.Save();
          Console.WriteLine("** Configuration updated.");
        }
        else
        {
          Console.WriteLine("** Could not update, section is locked.");
        }
      }

      catch (Exception e)
      {
        // Unknown error.
        Console.WriteLine(e.ToString());
      }

      // Display and wait
      Console.ReadLine();
    }
  }
}
Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingMachineKeySection
    Public Shared Sub Main()
      Try
        ' Set the path of the config file.
        Dim configPath As String = ""

        ' Get the Web application configuration object.
        Dim config As System.Configuration.Configuration = _
         System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object.
        Dim configSection As System.Web.Configuration.MachineKeySection = _
         CType(config.GetSection("system.web/machineKey"), _
         System.Web.Configuration.MachineKeySection)

        ' Display title and info.
        Console.WriteLine("ASP.NET Configuration Info")
        Console.WriteLine()

        ' Display Config details.
        Console.WriteLine("File Path: {0}", config.FilePath)
        Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name)

        ' Display ValidationKey property.
        Console.WriteLine("ValidationKey: {0}", _
         configSection.ValidationKey)

        ' Set ValidationKey property.
        configSection.ValidationKey = "AutoGenerate,IsolateApps"

        ' Display DecryptionKey property.
        Console.WriteLine("DecryptionKey: {0}", configSection.DecryptionKey)

        ' Set DecryptionKey property.
        configSection.DecryptionKey = "AutoGenerate,IsolateApps"

        ' Display Validation value.
        Console.WriteLine("Validation: {0}", configSection.Validation)

        ' Set Validation value.
        configSection.Validation = MachineKeyValidation.HMACSHA256

        ' Update if not locked.
        If Not configSection.SectionInformation.IsLocked Then
          config.Save()
          Console.WriteLine("** Configuration updated.")
        Else
          Console.WriteLine("** Could not update, section is locked.")
        End If

      Catch e As Exception
        ' Unknown error.
        Console.WriteLine(e.ToString())
      End Try

      ' Display and wait
      Console.ReadLine()
    End Sub
  End Class
End Namespace

Hinweise

Die MachineKeySection Klasse bietet eine Möglichkeit, programmgesteuert auf den Inhalt des MachineKey Abschnitts in der Konfigurationsdatei zuzugreifen und sie zu ändern. Der Abschnitt MachineKey kann auf Computerebene (Machine.config) oder anwendung (Web.config) konfiguriert werden und steuert die Schlüssel und Algorithmen, die für Windows Forms Authentifizierung, Ansichtsstatusüberprüfung und Anwendungsisolation mit Sitzungsstatus verwendet werden. Damit eines dieser Features über ein Netzwerk von Webservern (eine Webfarm) hinweg funktioniert, müssen die DecryptionKey Attribute ValidationKey und Attribute des MachineKey Abschnitts explizit und identisch mit gültigen Schlüsselwerten konfiguriert werden. Der AutoGenerate Wert funktioniert nicht für Webfarmen, da er auf einem kryptografisch zufälligen Geheimschlüssel basiert, der mithilfe des lokalen Computers beibehalten wird und nicht über mehrere Computer hinweg identisch ist.

Hinweise für Vererber

Wenn Sie Schlüssel in diesem Konfigurationsabschnitt angeben möchten, wie in Webfarmszenarien erforderlich, empfiehlt es sich, diesen Abschnitt mithilfe der geschützten Konfiguration zu verschlüsseln.

Konstruktoren

Name Beschreibung
MachineKeySection()

Initialisiert eine neue Instanz der MachineKeySection Klasse mithilfe von Standardeinstellungen.

Eigenschaften

Name Beschreibung
ApplicationName

Dient zum Abrufen oder Festlegen des Namens der Anwendung.

CompatibilityMode

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob aktualisierte Verschlüsselungsmethoden für den Ansichtszustand, die nach der .NET Framework Version 2.0 Service Pack 1-Version eingeführt wurden, verwendet wurden.

CurrentConfiguration

Ruft einen Verweis auf die Instanz der obersten Ebene Configuration ab, die die Konfigurationshierarchie darstellt, zu der die aktuelle ConfigurationElement Instanz gehört.

(Geerbt von ConfigurationElement)
DataProtectorType

Dient zum Abrufen oder Festlegen des Namens des Datentyps der Datenschutzkomponente. Der Standardwert lautet Empty.

Decryption

Gibt den Verschlüsselungsalgorithmus an, der zum Verschlüsseln und Entschlüsseln von Formularauthentifizierungsdaten verwendet wird.

DecryptionKey

Dient zum Abrufen oder Festlegen des Schlüssels, der zum Verschlüsseln und Entschlüsseln von Daten verwendet wird, oder den Prozess, mit dem der Schlüssel generiert wird.

ElementInformation

Ruft ein ElementInformation Objekt ab, das die nicht anpassbaren Informationen und Funktionen des ConfigurationElement Objekts enthält.

(Geerbt von ConfigurationElement)
ElementProperty

Ruft das ConfigurationElementProperty Objekt ab, das das ConfigurationElement Objekt selbst darstellt.

(Geerbt von ConfigurationElement)
EvaluationContext

Ruft das ContextInformation-Objekt für das ConfigurationElement-Objekt ab.

(Geerbt von ConfigurationElement)
HasContext

Ruft einen Wert ab, der angibt, ob die CurrentConfiguration Eigenschaft ist null.

(Geerbt von ConfigurationElement)
Item[ConfigurationProperty]

Dient zum Abrufen oder Festlegen einer Eigenschaft oder eines Attributs dieses Konfigurationselements.

(Geerbt von ConfigurationElement)
Item[String]

Dient zum Abrufen oder Festlegen einer Eigenschaft, eines Attributs oder eines untergeordneten Elements dieses Konfigurationselements.

(Geerbt von ConfigurationElement)
LockAllAttributesExcept

Ruft die Auflistung gesperrter Attribute ab.

(Geerbt von ConfigurationElement)
LockAllElementsExcept

Ruft die Auflistung gesperrter Elemente ab.

(Geerbt von ConfigurationElement)
LockAttributes

Ruft die Auflistung gesperrter Attribute ab.

(Geerbt von ConfigurationElement)
LockElements

Ruft die Auflistung gesperrter Elemente ab.

(Geerbt von ConfigurationElement)
LockItem

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Element gesperrt ist.

(Geerbt von ConfigurationElement)
Properties

Ruft die Auflistung von Eigenschaften ab.

(Geerbt von ConfigurationElement)
SectionInformation

Ruft ein SectionInformation Objekt ab, das die nicht anpassbaren Informationen und Funktionen des ConfigurationSection Objekts enthält.

(Geerbt von ConfigurationSection)
Validation

Gibt den Hashingalgorithmus an, der zum Überprüfen der Formularauthentifizierung und zum Anzeigen von Statusdaten verwendet wird.

ValidationAlgorithm

Ruft den Namen des Algorithmus ab, der zum Überprüfen der Formularauthentifizierung und zum Anzeigen von Statusdaten verwendet wird, oder legt diesen fest.

ValidationKey

Dient zum Abrufen oder Festlegen des Schlüssels, der zum Überprüfen der Formularauthentifizierung und Zum Anzeigen von Statusdaten oder zum Prozess verwendet wird, mit dem der Schlüssel generiert wird.

Methoden

Name Beschreibung
DeserializeElement(XmlReader, Boolean)

Liest XML aus der Konfigurationsdatei.

(Geerbt von ConfigurationElement)
DeserializeSection(XmlReader)

Liest XML aus der Konfigurationsdatei.

(Geerbt von ConfigurationSection)
Equals(Object)

Vergleicht die aktuelle ConfigurationElement Instanz mit dem angegebenen Objekt.

(Geerbt von ConfigurationElement)
GetHashCode()

Ruft einen eindeutigen Wert ab, der die aktuelle ConfigurationElement Instanz darstellt.

(Geerbt von ConfigurationElement)
GetRuntimeObject()

Gibt ein benutzerdefiniertes Objekt zurück, wenn es in einer abgeleiteten Klasse überschrieben wird.

(Geerbt von ConfigurationSection)
GetTransformedAssemblyString(String)

Gibt die transformierte Version des angegebenen Assemblynamens zurück.

(Geerbt von ConfigurationElement)
GetTransformedTypeString(String)

Gibt die transformierte Version des angegebenen Typnamens zurück.

(Geerbt von ConfigurationElement)
GetType()

Ruft die Type der aktuellen Instanz ab.

(Geerbt von Object)
Init()

Legt das ConfigurationElement Objekt auf seinen Anfangszustand fest.

(Geerbt von ConfigurationElement)
InitializeDefault()

Wird verwendet, um einen Standardsatz von Werten für das ConfigurationElement Objekt zu initialisieren.

(Geerbt von ConfigurationElement)
IsModified()

Gibt an, ob dieses Konfigurationselement seit dem letzten Speichern oder Laden geändert wurde, wenn es in einer abgeleiteten Klasse implementiert wurde.

(Geerbt von ConfigurationSection)
IsReadOnly()

Ruft einen Wert ab, der angibt, ob das ConfigurationElement Objekt schreibgeschützt ist.

(Geerbt von ConfigurationElement)
ListErrors(IList)

Fügt der übergebenen Liste die Fehler der ungültigen Eigenschaft in diesem ConfigurationElement Objekt und in allen Unterelementen hinzu.

(Geerbt von ConfigurationElement)
MemberwiseClone()

Erstellt eine flache Kopie der aktuellen Object.

(Geerbt von Object)
OnDeserializeUnrecognizedAttribute(String, String)

Ruft einen Wert ab, der angibt, ob während der Deserialisierung ein unbekanntes Attribut gefunden wird.

(Geerbt von ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

Ruft einen Wert ab, der angibt, ob während der Deserialisierung ein unbekanntes Element auftritt.

(Geerbt von ConfigurationElement)
OnRequiredPropertyNotFound(String)

Löst eine Ausnahme aus, wenn eine erforderliche Eigenschaft nicht gefunden wird.

(Geerbt von ConfigurationElement)
PostDeserialize()

Wird nach der Deserialisierung aufgerufen.

(Geerbt von ConfigurationElement)
PreSerialize(XmlWriter)

Wird vor der Serialisierung aufgerufen.

(Geerbt von ConfigurationElement)
Reset(ConfigurationElement)

Setzt den internen Zustand des ConfigurationElement Objekts zurück, einschließlich der Sperren und der Eigenschaftenauflistungen.

(Geerbt von ConfigurationElement)
ResetModified()

Setzt den Wert der IsModified() Methode zurück, wenn false sie in einer abgeleiteten Klasse implementiert wird.

(Geerbt von ConfigurationSection)
SerializeElement(XmlWriter, Boolean)

Schreibt den Inhalt dieses Konfigurationselements in die Konfigurationsdatei, wenn es in einer abgeleiteten Klasse implementiert wird.

(Geerbt von ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)

Erstellt eine XML-Zeichenfolge, die eine nicht zusammengeführte Ansicht des ConfigurationSection Objekts als einzelner Abschnitt enthält, um in eine Datei zu schreiben.

(Geerbt von ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)

Schreibt die äußeren Tags dieses Konfigurationselements in die Konfigurationsdatei, wenn sie in einer abgeleiteten Klasse implementiert wird.

(Geerbt von ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

Legt eine Eigenschaft auf den angegebenen Wert fest.

(Geerbt von ConfigurationElement)
SetReadOnly()

Legt die IsReadOnly() Eigenschaft für das ConfigurationElement Objekt und alle Unterelemente fest.

(Geerbt von ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)

Gibt an, ob das angegebene Element serialisiert werden soll, wenn die Konfigurationsobjekthierarchie für die angegebene Zielversion des .NET Framework serialisiert wird.

(Geerbt von ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)

Gibt an, ob die angegebene Eigenschaft serialisiert werden soll, wenn die Konfigurationsobjekthierarchie für die angegebene Zielversion des .NET Framework serialisiert wird.

(Geerbt von ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)

Gibt an, ob die aktuelle ConfigurationSection-Instanz serialisiert werden soll, wenn die Konfigurationsobjekthierarchie für die angegebene Zielversion des .NET Framework serialisiert wird.

(Geerbt von ConfigurationSection)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Ändert das ConfigurationElement Objekt, um alle Werte zu entfernen, die nicht gespeichert werden sollen.

(Geerbt von ConfigurationElement)

Gilt für:

Weitere Informationen