PermissionSetAttribute Class

 

Allows security actions for a PermissionSet to be applied to code using declarative security. This class cannot be inherited.

Namespace:   System.Security.Permissions
Assembly:  mscorlib (in mscorlib.dll)

System.Object
  System.Attribute
    System.Security.Permissions.SecurityAttribute
      System.Security.Permissions.CodeAccessSecurityAttribute
        System.Security.Permissions.PermissionSetAttribute

[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Constructor | AttributeTargets.Method, 
	AllowMultiple = true, Inherited = false)]
[ComVisibleAttribute(true)]
public sealed class PermissionSetAttribute : CodeAccessSecurityAttribute

NameDescription
System_CAPS_pubmethodPermissionSetAttribute(SecurityAction)

Initializes a new instance of the PermissionSetAttribute class with the specified security action.

NameDescription
System_CAPS_pubpropertyAction

Gets or sets a security action.(Inherited from SecurityAttribute.)

System_CAPS_pubpropertyFile

Gets or sets a file containing the XML representation of a custom permission set to be declared.

System_CAPS_pubpropertyHex

Gets or sets the hexadecimal representation of the XML encoded permission set.

System_CAPS_pubpropertyName

Gets or sets the name of the permission set.

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

System_CAPS_pubpropertyUnicodeEncoded

Gets or sets a value indicating whether the file specified by File is Unicode or ASCII encoded.

System_CAPS_pubpropertyUnrestricted

Gets or sets a value indicating whether full (unrestricted) permission to the resource protected by the attribute is declared.(Inherited from SecurityAttribute.)

System_CAPS_pubpropertyXML

Gets or sets the XML representation of a permission set.

NameDescription
System_CAPS_pubmethodCreatePermission()

This method is not used.(Overrides SecurityAttribute.CreatePermission().)

System_CAPS_pubmethodCreatePermissionSet()

Creates and returns a new permission set based on this permission set attribute object.

System_CAPS_pubmethodEquals(Object)

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.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

The PermissionSetAttribute properties Name, File, and XML are mutually exclusive, meaning that a permission set can have as its source only one of the following: a named permission set, a file containing an XML representation of a permission set, or a string containing an XML representation of a permission set.

The scope of the declaration that is allowed depends on the SecurityAction that is used. A SecurityAction performed on a PermissionSet is the equivalent of performing that action on each of the permissions within the set.

The security information declared by a security attribute is stored in the metadata of the attribute target and is accessed by the system at run time. Security attributes are used only for declarative security. For imperative security, use the corresponding permission class.

The following example shows the use of the PermissionSetAttribute Class.

// The #define statement for BuildFile must be included the first time this sample is run.  
// This causes the sample to create a file named 'LocalIntranet.xml' in the c:\temp folder.  
// After creating the LocalInternet.xml file, comment out the #define statement and rerun 
// the sample to demonstrate the use of the permission set attribute.
#define BuildFile
using System;
using System.Security;
using System.Security.Permissions;
using System.Security.Policy;
using System.Collections;
using System.IO;

namespace PermissionSetAttributeDemo
{
    class Class1
    {		
        [STAThread]
        static void Main(string[] args)
        {
            // Run this sample with the BuildFile symbol defined to create the required file, then
            // comment out the #define statement to demonstrate the use of the attribute.
#if(BuildFile)
            using (StreamWriter sw = new StreamWriter("c:\\temp\\LocalIntranet.xml")) 
            {
                sw.WriteLine(GetNamedPermissionSet("LocalIntranet"));
                sw.Close();
            }
#endif
#if(!BuildFile)
            ReadFile1();
            ReadFile2();
            ReadFile3();
            Console.WriteLine("Press the Enter key to exit.");
            Console.Read();
#endif
        }
#if(!BuildFile)
        // Read the LocalIntranet.xml file.
        static void ReadFile1()
        {
            try
            {
                Console.WriteLine("Attempting to read a file using the FullTrust permission set.");
                using (StreamReader sr = new StreamReader("c:\\temp\\LocalIntranet.xml")) 
                {
                    string permissionSet = sr.ReadToEnd();
                    sr.Close();
                }
                Console.WriteLine("The file was successfully read.");
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
        [PermissionSetAttribute(SecurityAction.PermitOnly, File = "c:\\temp\\LocalIntranet.xml")]
            // Read the file with the specified security action on the file path.
        static void ReadFile2()
        {
            try
            {
                Console.WriteLine("Attempting to read a file using the LocalIntranet permission set.");
                using (StreamReader sr = new StreamReader("c:\\temp\\LocalIntranet.xml")) 
                {
                    string permissionSet = sr.ReadToEnd();
                    sr.Close();
                }
                Console.WriteLine("The file was successfully read.");
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
        [PermissionSetAttribute(SecurityAction.PermitOnly, Name = "LocalIntranet")]
            // Read the file with the specified security action on the permission set.
        static void ReadFile3()
        {
            try
            {
                Console.WriteLine("\nSecond attempt to read a file using " + 
                    "the LocalIntranet permission set.");
                using (StreamReader sr = new StreamReader("c:\\temp\\LocalIntranet.xml")) 
                {
                    string permissionSet = sr.ReadToEnd();
                    sr.Close();
                }
                Console.WriteLine("The file was successfully read.");
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }
#endif
        // Locate the named permission set at the Machine level and return it as a string value.
        private static string GetNamedPermissionSet(string name)
        {
            IEnumerator policyEnumerator = SecurityManager.PolicyHierarchy();
            // Move through the policy levels to the Machine Level.
            while(policyEnumerator.MoveNext())
            {
                PolicyLevel currentLevel = (PolicyLevel)policyEnumerator.Current;
                if(currentLevel.Label == "Machine")
                {
                    // Iterate through the permission sets at the Machine level.
                    IList namedPermissions = currentLevel.NamedPermissionSets;
                    IEnumerator namedPermission = namedPermissions.GetEnumerator();
                    // Locate the named permission set.
                    while(namedPermission.MoveNext())
                    {
                        if(((NamedPermissionSet)namedPermission.Current).Name == name)
                        {
                            return ((NamedPermissionSet)namedPermission.Current).ToString();
                        }

                    }
                }
            }
            return null;
        }
    }
}
//
// This sample produces the following output:
//
// File created at c:\temp\LocalIntranet.xml
// Uncomment the BuildFile=false line and run the sample again.
//
// This sample completed successfully; press Exit to continue.
//
//
// The second time the sample is ran (without DEBUG flag):
//
// Attempting to read a file using the FullTrust permission set.
// The file was successfully read.
// Attempting to read a file using the LocalIntranet permission set.
// Request for the permission of type
// System.Security.Permissions.FileIOPermission, mscorlib, Version=1.0.5000.0,
// Culture=neutral, PublicKeyToken=b77a5c561934e089 failed.
//
// Second attempt to read a file using the LocalIntranet permission set.
// Request for the permission of type System.Security.Permissions.FileIOPermission,
// mscorlib, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
// failed.
// Press the Enter key to exit.

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: