ObfuscationAttribute Klasse

Definition

Namespace:

System.Reflection

Assembly:

System.Runtime.dll

Quelle:

ObfuscationAttribute.cs

Weist Verbergungstools an, die angegebenen Aktionen für eine Assembly, einen Typ oder einen Member auszuführen.

public ref class ObfuscationAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.Struct, AllowMultiple=true, Inherited=false)]
public sealed class ObfuscationAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.Struct, AllowMultiple=true, Inherited=false)>]
type ObfuscationAttribute = class
    inherit Attribute

Public NotInheritable Class ObfuscationAttribute
Inherits Attribute

Vererbung

Object

Attribute

ObfuscationAttribute

Attribute

AttributeUsageAttribute

Beispiele

Das folgende Codebeispiel zeigt eine öffentliche Assembly mit zwei Typen: Type1 und Type2. Die Assembly wird zur Verschleierung mit ObfuscateAssemblyAttributemarkiert, was die Assembly markiert, die als öffentlich behandelt werden soll (d. a. die AssemblyIsPrivate -Eigenschaft ist false).

Type1 wird zur Verschleierung markiert, da die Assembly zur Verschleierung gekennzeichnet ist. Ein Element von Type1 wird von der Verschleierung ausgeschlossen, indem die -Eigenschaft verwendet Exclude wird.

Type2 ist von der Verschleierung ausgeschlossen, ihre Member werden jedoch für die Verschleierung markiert, da die ApplyToMembers -Eigenschaft ist false.

Die MethodA -Methode von Type2 ist mit dem Wert "default" für die Feature -Eigenschaft gekennzeichnet. Es ist erforderlich, für die -Eigenschaft anzugebenfalse, um das Ausschließen MethodA von der Verschleierung zu vermeiden, da der Standardwert für die Exclude -Eigenschaft isttrue.Exclude Das Verschleierungstool sollte das Attribut nach der Verschleierung nicht entfernen, da die StripAfterObfuscation -Eigenschaft ist false. Alle anderen Attribute in diesem Codebeispiel werden nach der Verschleierung entfernt, da die StripAfterObfuscation -Eigenschaft nicht angegeben ist und daher standardmäßig auf truefestgelegt ist.

Das Codebeispiel enthält Code zum Anzeigen der Attribute und ihrer Eigenschaften. Sie können die Attribute auch untersuchen, indem Sie die DLL mit dem Ildasm.exe (IL Disassembler) öffnen.

using System;
using System.Reflection;

// Mark this public assembly for obfuscation.
[assembly:ObfuscateAssemblyAttribute(false)]

// This class is marked for obfuscation, because the assembly
// is marked.
public class Type1
{

    // Exclude this method from obfuscation. The default value
    // of the Exclude property is true, so it is not necessary
    // to specify Exclude=True, although spelling it out makes
    // your intent clearer.
    [ObfuscationAttribute(Exclude=true)]
    public void MethodA() {}

    // This member is marked for obfuscation because the class
    // is marked.
    public void MethodB() {}
}

// Exclude this type from obfuscation, but do not apply that
// exclusion to members. The default value of the Exclude
// property is true, so it is not necessary to specify
// Exclude=true, although spelling it out makes your intent
// clearer.
[ObfuscationAttribute(Exclude=true, ApplyToMembers=false)]
public class Type2
{

    // The exclusion of the type is not applied to its members,
    // however in order to mark the member with the "default"
    // feature it is necessary to specify Exclude=false,
    // because the default value of Exclude is true. The tool
    // should not strip this attribute after obfuscation.
    [ObfuscationAttribute(Exclude=false, Feature="default",
        StripAfterObfuscation=false)]
    public void MethodA() {}

    // This member is marked for obfuscation, because the
    // exclusion of the type is not applied to its members.
    public void MethodB() {}
}

// This class only exists to provide an entry point for the
// assembly and to display the attribute values.
internal class Test
{

    public static void Main()
    {

        // Display the ObfuscateAssemblyAttribute properties
        // for the assembly.
        Assembly assem = typeof(Test).Assembly;
        object[] assemAttrs = assem.GetCustomAttributes(
            typeof(ObfuscateAssemblyAttribute), false);

        foreach( Attribute a in assemAttrs )
        {
            ShowObfuscateAssembly((ObfuscateAssemblyAttribute) a);
        }

        // Display the ObfuscationAttribute properties for each
        // type that is visible to users of the assembly.
        foreach( Type t in assem.GetTypes() )
        {
            if (t.IsVisible)
            {
                object[] tAttrs = t.GetCustomAttributes(
                    typeof(ObfuscationAttribute), false);

                foreach( Attribute a in tAttrs )
                {
                    ShowObfuscation(((ObfuscationAttribute) a),
                        t.Name);
                }

                // Display the ObfuscationAttribute properties
                // for each member in the type.
                foreach( MemberInfo m in t.GetMembers() )
                {
                    object[] mAttrs = m.GetCustomAttributes(
                        typeof(ObfuscationAttribute), false);

                    foreach( Attribute a in mAttrs )
                    {
                        ShowObfuscation(((ObfuscationAttribute) a),
                            t.Name + "." + m.Name);
                    }
                }
            }
        }
    }

    private static void ShowObfuscateAssembly(
        ObfuscateAssemblyAttribute ob)
    {
        Console.WriteLine("\r\nObfuscateAssemblyAttribute properties:");
        Console.WriteLine("   AssemblyIsPrivate: {0}",
            ob.AssemblyIsPrivate);
        Console.WriteLine("   StripAfterObfuscation: {0}",
            ob.StripAfterObfuscation);
    }

    private static void ShowObfuscation(
        ObfuscationAttribute ob, string target)
    {
        Console.WriteLine("\r\nObfuscationAttribute properties for: {0}",
            target);
        Console.WriteLine("   Exclude: {0}", ob.Exclude);
        Console.WriteLine("   Feature: {0}", ob.Feature);
        Console.WriteLine("   StripAfterObfuscation: {0}",
            ob.StripAfterObfuscation);
        Console.WriteLine("   ApplyToMembers: {0}", ob.ApplyToMembers);
    }
}

/* This code example produces the following output:

ObfuscateAssemblyAttribute properties:
   AssemblyIsPrivate: False
   StripAfterObfuscation: True

ObfuscationAttribute properties for: Type1.MethodA
   Exclude: True
   Feature: all
   StripAfterObfuscation: True
   ApplyToMembers: True

ObfuscationAttribute properties for: Type2
   Exclude: True
   Feature: all
   StripAfterObfuscation: True
   ApplyToMembers: False

ObfuscationAttribute properties for: Type2.MethodA
   Exclude: False
   Feature: default
   StripAfterObfuscation: False
   ApplyToMembers: True
 */

Imports System.Reflection

' Mark this public assembly for obfuscation.
<Assembly: ObfuscateAssemblyAttribute(False)>

' This class is marked for obfuscation, because the assembly
' is marked.
Public Class Type1

    ' Exclude this method from obfuscation. The default value
    ' of the Exclude property is True, so it is not necessary
    ' to specify Exclude:=True, although spelling it out makes
    ' your intent clearer.
    <ObfuscationAttribute(Exclude:=True)> _
    Public Sub MethodA()
    End Sub

    ' This member is marked for obfuscation because the class
    ' is marked.
    Public Sub MethodB()
    End Sub

End Class

' Exclude this type from obfuscation, but do not apply that
' exclusion to members. The default value of the Exclude 
' property is True, so it is not necessary to specify 
' Exclude:=True, although spelling it out makes your intent 
' clearer.
<ObfuscationAttribute(Exclude:=True, ApplyToMembers:=False)> _
Public Class Type2

    ' The exclusion of the type is not applied to its members,
    ' however in order to mark the member with the "default" 
    ' feature it is necessary to specify Exclude:=False,
    ' because the default value of Exclude is True. The tool
    ' should not strip this attribute after obfuscation.
    <ObfuscationAttribute(Exclude:=False, _
        Feature:="default", StripAfterObfuscation:=False)> _
    Public Sub MethodA()
    End Sub

    ' This member is marked for obfuscation, because the 
    ' exclusion of the type is not applied to its members.
    Public Sub MethodB()
    End Sub

End Class

' This class only exists to provide an entry point for the
' assembly and to display the attribute values.
Friend Class Test

    Public Shared Sub Main()

        ' Display the ObfuscateAssemblyAttribute properties
        ' for the assembly.        
        Dim assem As Assembly =GetType(Test).Assembly
        Dim assemAttrs() As Object = _
            assem.GetCustomAttributes( _
                GetType(ObfuscateAssemblyAttribute), _
                False)

        For Each a As Attribute In assemAttrs
            ShowObfuscateAssembly(CType(a, ObfuscateAssemblyAttribute))
        Next

        ' Display the ObfuscationAttribute properties for each
        ' type that is visible to users of the assembly.
        For Each t As Type In assem.GetTypes()
            If t.IsVisible Then
                Dim tAttrs() As Object = _
                    t.GetCustomAttributes( _
                        GetType(ObfuscationAttribute), _
                        False)

                For Each a As Attribute In tAttrs
                    ShowObfuscation(CType(a, ObfuscationAttribute), _
                        t.Name)
                Next

                ' Display the ObfuscationAttribute properties
                ' for each member in the type.
                For Each m As MemberInfo In t.GetMembers()
                    Dim mAttrs() As Object = _
                        m.GetCustomAttributes( _
                            GetType(ObfuscationAttribute), _
                            False)

                    For Each a As Attribute In mAttrs
                        ShowObfuscation(CType(a, ObfuscationAttribute), _
                            t.Name & "." & m.Name)
                    Next
                Next
            End If
        Next
    End Sub

    Private Shared Sub ShowObfuscateAssembly( _
        ByVal ob As ObfuscateAssemblyAttribute)
        
        Console.WriteLine(vbCrLf & "ObfuscateAssemblyAttribute properties:")
        Console.WriteLine("   AssemblyIsPrivate: " _
            & ob.AssemblyIsPrivate)
        Console.WriteLine("   StripAfterObfuscation: " _
            & ob.StripAfterObfuscation)

    End Sub

    Private Shared Sub ShowObfuscation( _
        ByVal ob As ObfuscationAttribute, _
        ByVal target As String)
        
        Console.WriteLine(vbCrLf _
            & "ObfuscationAttribute properties for: " _
            & target)
        Console.WriteLine("   Exclude: " & ob.Exclude)
        Console.WriteLine("   Feature: " & ob.Feature)
        Console.WriteLine("   StripAfterObfuscation: " _
            & ob.StripAfterObfuscation)
        Console.WriteLine("   ApplyToMembers: " & ob.ApplyToMembers)

    End Sub
End Class

' This code example produces the following output:
'
'ObfuscateAssemblyAttribute properties:
'   AssemblyIsPrivate: False
'   StripAfterObfuscation: True
'
'ObfuscationAttribute properties for: Type1.MethodA
'   Exclude: True
'   Feature: all
'   StripAfterObfuscation: True
'   ApplyToMembers: True
'
'ObfuscationAttribute properties for: Type2
'   Exclude: True
'   Feature: all
'   StripAfterObfuscation: True
'   ApplyToMembers: False
'
'ObfuscationAttribute properties for: Type2.MethodA
'   Exclude: False
'   Feature: default
'   StripAfterObfuscation: False
'   ApplyToMembers: True

Hinweise

Die ObfuscationAttribute Attribute und ObfuscateAssemblyAttribute ermöglichen es Assemblyautoren, ihre Binärdateien mit Anmerkungen zu versehen, sodass Verschleierungstools sie mit minimaler externer Konfiguration ordnungsgemäß verarbeiten können.

Wichtig

Durch das Anwenden dieses Attributs wird die Codeentität, auf die Sie es anwenden, nicht automatisch verschleiert. Das Anwenden des Attributs ist eine Alternative zum Erstellen einer Konfigurationsdatei für das Verschleierungstool. Das heißt, es enthält lediglich Anweisungen für ein Verschleierungstool. Microsoft empfiehlt, dass Anbieter von Verschleierungstools die hier beschriebene Semantik befolgen. Es gibt jedoch keine Garantie dafür, dass ein bestimmtes Tool den Empfehlungen von Microsoft folgt.

Das ObfuscationAttribute Attribut verfügt über eine Zeichenfolgeneigenschaft Feature . Verschleierungstools können die Zeichenfolgenwerte dieser Eigenschaft features zuordnen, die sie implementieren, vorzugsweise mithilfe einer XML-Konfigurationsdatei, auf die Benutzer zugreifen können. Der ObfuscationAttribute definiert zwei Featurezeichenfolgen, "default" und "all". Die Zeichenfolge "standard" sollte den Standardverschleierungsfeatures eines Tools zugeordnet werden, und "all" sollte dem vollständigen Satz von Verschleierungsfeatures zugeordnet werden, die von einem Tool unterstützt werden. Der Standardwert der Feature Eigenschaft ist "all", wodurch der vollständige Satz von Verschleierungsfeatures aktiviert wird.

Gilt bei Anwendung auf eine Assembly ObfuscationAttribute auch für alle Typen innerhalb der Assembly. Wenn die ApplyToMembers -Eigenschaft nicht angegeben oder auf truefestgelegt ist, gilt das Attribut auch für alle Member. ObfuscationAttribute gibt nicht an, ob eine Assembly öffentlich oder privat ist. Verwenden Sie das ObfuscateAssemblyAttribute -Attribut, um anzugeben, ob eine Assembly öffentlich oder privat ist.

Gilt bei Anwendung auf Klassen und Strukturen ObfuscationAttribute auch für alle Member des Typs, wenn die ApplyToMembers -Eigenschaft nicht angegeben oder auf truefestgelegt ist.

Wenn es auf Methoden, Parameter, Felder und Eigenschaften angewendet wird, wirkt sich das Attribut nur auf die Entität aus, auf die es angewendet wird.

Konstruktoren

ObfuscationAttribute()

Initialisiert eine neue Instanz der ObfuscationAttribute-Klasse.

Eigenschaften

ApplyToMembers	Ruft einen Boolean-Wert ab, der angibt, ob das Attribut eines Typs auf die Member des Typs angewendet wird, oder legt diesen Wert fest.
Exclude	Ruft einen Boolean-Wert ab, der angibt, ob das Verbergungstool den Typ oder Member vom Verbergen ausschließen soll, oder legt diesen Wert fest.
Feature	Ruft einen Zeichenfolgenwert ab, der vom Verbergungstool erkannt wird und der Verarbeitungsoptionen angibt, oder legt diesen fest.
StripAfterObfuscation	Ruft einen Boolean-Wert ab, der angibt, ob das Verbergungstool dieses Attribut nach der Verarbeitung entfernen soll, oder legt diesen Wert fest.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• ObfuscateAssemblyAttribute