MachineKeySection Klasse

Referenz

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Definiert die Konfigurationseinstellungen, die die Schlüsselgenerierung und die Algorithmen steuern, die für die Verschlüsselung, Entschlüsselung, MAC (Message Authentication Code)-Operationen bei der Windows Forms-Authentifizierung, Ansichtszustandsvalidierung und die Isolierung von Sitzungszuständen zwischen Anwendungen 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: Object

ConfigurationElement

ConfigurationSection
MachineKeySection

Beispiele

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

Das folgende Beispiel aus einer Konfigurationsdatei zeigt, wie Werte für den Abschnitt machineKey deklarativ 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 veranschaulicht, wie die MachineKeySection -Klasse im Code verwendet wird.

#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 Abschnitts in der MachineKey Konfigurationsdatei zuzugreifen und diesen zu ändern. Der MachineKey Abschnitt kann auf Computer- (Machine.config) oder Anwendungsebene (Web.config) konfiguriert werden und steuert die Schlüssel und Algorithmen, die für Windows Forms Authentifizierung, Überprüfung des Ansichtszustands und Sitzungszustandsanwendungsisolation verwendet werden. Damit jedes dieser Features über ein Netzwerk von Webservern (eine Webfarm) hinweg funktioniert, müssen die DecryptionKey Attribute und ValidationKey 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 Geheimnis basiert, das mithilfe von computerlokalem Schutz beibehalten wird und nicht auf mehreren Computern identisch ist.

Hinweise für Vererber

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

Konstruktoren

MachineKeySection()

Initialisiert eine neue Instanz der MachineKeySection-Klasse mit Standardeinstellungen.

Eigenschaften

ApplicationName	Ruft den Namen der Anwendung ab oder legt diesen fest.
CompatibilityMode	Ruft einen Wert ab, der angibt, ob aktualisierte Verschlüsselungsmethoden für den Ansichtszustand verwendet werden, die nach .NET Framework 2.0 Service Pack 1 eingeführt wurden, oder legt diesen Wert fest.
CurrentConfiguration	Ruft einen Verweis auf die Configuration-Instanz der obersten Ebene ab, die die Konfigurationshierarchie darstellt, zu der die aktuelle ConfigurationElement-Instanz gehört. (Geerbt von ConfigurationElement)
DataProtectorType	Ruft den Namen der Schutzkomponenten-Typs ab oder legt diesen fest. Der Standardwert ist Empty.
Decryption	Gibt den Verschlüsselungsalgorithmus an, der zum Verschlüsseln und Entschlüsseln von Formularauthentifizierungsdaten verwendet wird.
DecryptionKey	Ruft den Schlüssel ab, mit dem Daten verschlüsselt und entschlüsselt werden, oder den Prozess, durch den der Schlüssel generiert wird, oder legt den Schlüssel bzw. den Prozess fest.
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 `null` ist. (Geerbt von ConfigurationElement)
Item[ConfigurationProperty]	Ruft eine Eigenschaft oder ein Attribut dieses Konfigurationselements ab oder legt diese bzw. dieses fest. (Geerbt von ConfigurationElement)
Item[String]	Ruft eine Eigenschaft, ein Attribut oder ein untergeordnetes Element dieses Konfigurationselements ab oder legt diese(s) fest. (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	Ruft einen Wert ab, der angibt, ob das Element gesperrt ist, oder legt diesen fest. (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 Hashalgorithmus an, der zum Überprüfen von Formularauthentifizierungs- und Anzeigezustandsdaten verwendet wird.
ValidationAlgorithm	Ruft den Namen des Algorithmus ab, der verwendet wird, um Formularauthentifizierungs- und Anzeigezustandsdaten zu überprüfen, oder legt ihn fest.
ValidationKey	Ruft den Schlüssel ab, mit dem Formularauthentifizierungs- und Ansichtszustandsdaten validiert werden, oder den Prozess, durch den der Schlüssel generiert wird, oder legt den Schlüssel bzw. den Prozess fest.

Methoden

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 den Type der aktuellen Instanz ab. (Geerbt von Object)
Init()	Legt für das ConfigurationElement-Objekt den Ausgangszustand 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 geändert wurde, seit es zuletzt gespeichert oder geladen wurde, wenn es in einer abgeleiteten Klasse implementiert wurde. (Geerbt von ConfigurationSection)
IsReadOnly()	Ruft einen Wert ab, der angibt, ob das ConfigurationElement schreibgeschützt ist. (Geerbt von ConfigurationElement)
ListErrors(IList)	Fügt die Fehler über ungültige Eigenschaften in diesem ConfigurationElement-Objekt und in allen Unterelementen der übergebenen Liste hinzu. (Geerbt von ConfigurationElement)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
OnDeserializeUnrecognizedAttribute(String, String)	Ruft einen Wert ab, der angibt, ob während der Deserialisierung ein unbekanntes Attribut aufgetreten ist. (Geerbt von ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Ruft einen Wert ab, der angibt, ob während der Deserialisierung ein unbekanntes Element aufgetreten ist. (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 Status dieses ConfigurationElement-Objekts zurück, einschließlich der Sperren und der Eigenschaftenauflistungen. (Geerbt von ConfigurationElement)
ResetModified()	Setzt bei Implementierung in einer abgeleiteten Klasse den Wert der IsModified()-Methode auf `false` zurück. (Geerbt von ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	Schreibt bei Implementierung in einer abgeleiteten Klasse den Inhalt dieses Konfigurationselements in die Konfigurationsdatei. (Geerbt von ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	Erstellt eine XML-Zeichenfolge mit einer nicht zusammengeführten Ansicht des ConfigurationSection-Objekts als einzelnem Abschnitt, der in einer Datei geschrieben werden soll. (Geerbt von ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	Schreibt bei Implementierung in einer abgeleiteten Klasse die äußeren Tags dieses Konfigurationselements in die Konfigurationsdatei. (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 instance 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: