ObfuscationAttribute Klasa

Definicja

Przestrzeń nazw:

System.Reflection

Zestaw:

System.Runtime.dll

Źródło:

ObfuscationAttribute.cs

Instruuje narzędzia zaciemniania w celu wykonania określonych akcji dla zestawu, typu lub elementu członkowskiego.

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

Dziedziczenie

Object

Attribute

ObfuscationAttribute

Atrybuty

AttributeUsageAttribute

Przykłady

Poniższy przykład kodu przedstawia zestaw publiczny z dwoma typami: Type1 i Type2. Zestaw jest oznaczony do zaciemnienia ObfuscateAssemblyAttributeza pomocą elementu , który oznacza zestaw do traktowania jako publiczny (czyli AssemblyIsPrivate właściwość to false).

Type1 jest oznaczony do zaciemnienia, ponieważ zestaw jest oznaczony do zaciemnienia. Jeden element członkowski Type1 jest wykluczony z zaciemnienia przy użyciu Exclude właściwości .

Type2 jest wykluczony z zaciemnienia, ale jego elementy członkowskie są oznaczone do zaciemnienia, ponieważ ApplyToMembers właściwość ma wartość false.

Metoda MethodA klasy Type2 jest oznaczona wartością "default"Feature właściwości . Należy określić false dla Exclude właściwości , aby uniknąć wykluczenia MethodA z zaciemnienia, ponieważ wartość domyślna dla Exclude właściwości to true. Narzędzie zaciemniania nie powinno usuwać atrybutu po zaciemnianiu, ponieważ StripAfterObfuscation właściwość ma wartość false. Wszystkie inne atrybuty w tym przykładzie kodu są usuwane po zaciemnianiu, ponieważ StripAfterObfuscation właściwość nie jest określona, a w związku z tym wartość domyślna to true.

Przykładowy kod zawiera kod do wyświetlania atrybutów i ich właściwości. Możesz również zbadać atrybuty, otwierając bibliotekę DLL za pomocą Ildasm.exe (dezasembler IL).

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

Uwagi

Atrybuty ObfuscationAttribute i ObfuscateAssemblyAttribute umożliwiają autorom zestawów dodawanie adnotacji do swoich plików binarnych, dzięki czemu narzędzia zaciemniające mogą przetwarzać je poprawnie przy minimalnej konfiguracji zewnętrznej.

Ważne

Zastosowanie tego atrybutu nie powoduje automatycznego zaciemniania jednostki kodu, do której jest on stosowany. Zastosowanie atrybutu jest alternatywą dla tworzenia pliku konfiguracji dla narzędzia zaciemniania. Oznacza to, że jedynie udostępnia instrukcje dotyczące narzędzia zaciemniania. Firma Microsoft zaleca, aby dostawcy narzędzi zaciemniających postępowali zgodnie z semantykami opisanymi tutaj. Nie ma jednak gwarancji, że określone narzędzie jest zgodne z zaleceniami firmy Microsoft.

Atrybut ObfuscationAttribute ma właściwość string Feature . Narzędzia zaciemniające mogą mapować wartości ciągów tej właściwości na funkcje implementowane, najlepiej przy użyciu pliku konfiguracji XML, do którego użytkownicy mogą uzyskiwać dostęp. Element ObfuscationAttribute definiuje dwa ciągi cech: "default" i "all". Ciąg "default" powinien być mapowany na domyślne funkcje zaciemniania narzędzia, a "wszystkie" powinny być mapowane na pełny zestaw funkcji zaciemniania obsługiwanych przez narzędzie. Wartość Feature domyślna właściwości to "all", umożliwiając pełny zestaw funkcji zaciemniania.

W przypadku zastosowania do zestawu ObfuscationAttribute dotyczy również wszystkich typów w zestawie. ApplyToMembers Jeśli właściwość nie jest określona lub jest ustawiona na truewartość , atrybut ma również zastosowanie do wszystkich elementów członkowskich. ObfuscationAttribute nie określa, czy zestaw jest publiczny, czy prywatny. Aby określić, czy zestaw jest publiczny, czy prywatny, użyj atrybutu ObfuscateAssemblyAttribute .

W przypadku zastosowania do klas i struktur dotyczy również wszystkich składowych typu, ObfuscationAttribute jeśli ApplyToMembers właściwość nie jest określona lub jest ustawiona na truewartość .

Po zastosowaniu do metod, parametrów, pól i właściwości atrybut wpływa tylko na jednostkę, do której jest stosowany.

Konstruktory

ObfuscationAttribute()

Inicjuje nowe wystąpienie klasy ObfuscationAttribute.

Właściwości

ApplyToMembers	Pobiera lub ustawia wartość wskazującą Boolean , czy atrybut typu ma być stosowany do elementów członkowskich typu.
Exclude	Pobiera lub ustawia wartość wskazującą Boolean , czy narzędzie zaciemniania powinno wykluczyć typ lub element członkowski z zaciemniania.
Feature	Pobiera lub ustawia wartość ciągu rozpoznawaną przez narzędzie zaciemniania i określającą opcje przetwarzania.
StripAfterObfuscation	Pobiera lub ustawia wartość wskazującą Boolean , czy narzędzie zaciemniania powinno usunąć ten atrybut po przetworzeniu.
TypeId	Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attributeelementu . (Odziedziczone po Attribute)

Metody

Equals(Object)	Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi. (Odziedziczone po Attribute)
GetHashCode()	Zwraca wartość skrótu dla tego wystąpienia. (Odziedziczone po Attribute)
GetType()	Type Pobiera wartość bieżącego wystąpienia. (Odziedziczone po Object)
IsDefaultAttribute()	Podczas zastępowania w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną dla klasy pochodnej. (Odziedziczone po Attribute)
Match(Object)	Po przesłonięciu w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Zobacz też

• ObfuscateAssemblyAttribute