Instructs obfuscation tools to take the specified actions for an assembly, type, or member.
Assembly: mscorlib (in mscorlib.dll)
<AttributeUsageAttribute(AttributeTargets.Assembly Or AttributeTargets.Class Or AttributeTargets.Struct Or AttributeTargets.Enum Or AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Field Or AttributeTargets.Event Or AttributeTargets.Interface Or AttributeTargets.Parameter Or AttributeTargets.Delegate, AllowMultiple := True, Inherited := False)> <ComVisibleAttribute(True)> Public NotInheritable Class ObfuscationAttribute Inherits Attribute
Gets or sets a Boolean value indicating whether the attribute of a type is to apply to the members of the type.
Gets or sets a Boolean value indicating whether the obfuscation tool should exclude the type or member from obfuscation.
Gets or sets a string value that is recognized by the obfuscation tool, and which specifies processing options.
Gets or sets a Boolean value indicating whether the obfuscation tool should remove this attribute after processing.
This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)
Returns the hash code for this instance.(Inherited from Attribute.)
When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)
When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)
Returns a string that represents the current object.(Inherited from Object.)
|_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)|
Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)
|_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)|
Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)
Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)
|_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)|
Provides access to properties and methods exposed by an object.(Inherited from Attribute.)
The ObfuscateAssemblyAttribute attributes allow assembly authors to annotate their binaries so that obfuscation tools can process them correctly with minimal external configuration.and
Applying this attribute does not automatically obfuscate the code entity to which you apply it. Applying the attribute is an alternative to creating a configuration file for the obfuscation tool. That is, it merely provides instructions for an obfuscation tool. Microsoft recommends that vendors of obfuscation tools follow the semantics described here. However, there is no guarantee that a particular tool follows Microsoft recommendations.
The Feature property. Obfuscation tools can map the string values of this property to features they implement, preferably by using an XML configuration file that users can access. The defines two feature strings, "default" and "all". The string "default" should map to the default obfuscation features of a tool, and "all" should map to the complete set of obfuscation features supported by a tool. The default value of the Feature property is "all", enabling the complete set of obfuscation features.attribute has a string
When applied to an assembly, ApplyToMembers property is not specified, or is set to true, the attribute applies to all members as well. does not specify whether an assembly is public or private. To specify whether an assembly is public or private, use the ObfuscateAssemblyAttribute attribute.also applies to all types within the assembly. If the
When applied to classes and structures, ApplyToMembers property is not specified, or is set to true.also applies to all members of the type if the
When applied to methods, parameters, fields, and properties, the attribute affects only the entity to which it is applied.
The following code example shows a public assembly with two types: Type1 and Type2. The assembly is marked for obfuscation with the ObfuscateAssemblyAttribute, which marks the assembly to be treated as public (that is, the AssemblyIsPrivate property is false).
Type1 is marked for obfuscation because the assembly is marked for obfuscation. One member of Type1 is excluded from obfuscation, using the Exclude property.
Type2 is excluded from obfuscation, but its members are marked for obfuscation because the ApplyToMembers property is false.
The MethodA method of Type2 is marked with the value "default" for the Feature property. It is necessary to specify false for the Exclude property to avoid excluding MethodA from obfuscation, because the default for the Exclude property is true. The obfuscation tool should not strip the attribute after obfuscation because the StripAfterObfuscation property is false. All the other attributes in this code example are stripped after obfuscation, because the StripAfterObfuscation property is not specified, and therefore defaults to true.
The code example includes code to display the attributes and their properties. You can also examine the attributes by opening the DLL with the Ildasm.exe (IL Disassembler).
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
Available since 2.0
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.