PrincipalPermissionAttribute Class
Assembly: mscorlib (in mscorlib.dll)
'Declaration <SerializableAttribute> _ <ComVisibleAttribute(True)> _ <AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Method, AllowMultiple:=True, Inherited:=False)> _ Public NotInheritable Class PrincipalPermissionAttribute Inherits CodeAccessSecurityAttribute 'Usage Dim instance As PrincipalPermissionAttribute
/** @attribute SerializableAttribute() */ /** @attribute ComVisibleAttribute(true) */ /** @attribute AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple=true, Inherited=false) */ public final class PrincipalPermissionAttribute extends CodeAccessSecurityAttribute
SerializableAttribute ComVisibleAttribute(true) AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple=true, Inherited=false) public final class PrincipalPermissionAttribute extends CodeAccessSecurityAttribute
PrincipalPermissionAttribute can be used to declaratively demand that users running your code belong to a specified role or have been authenticated. Use of Unrestricted creates a PrincipalPermission with Authenticated set to true and Name and Role set to a null reference (Nothing in Visual Basic).
The scope of the declaration that is allowed depends on the SecurityAction that is used. PrincipalPermissionAttribute cannot be applied at the assembly level.
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.
Important Prior to a demand for principal permission it is necessary to set the current application domain's principal policy to the enumeration value WindowsPrincipal. By default, the principal policy is set to UnauthenticatedPrincipal. If you do not set the principal policy to WindowsPrincipal, a demand for principal permission will fail. The following code should be executed before the principal permission is demanded: AppDomain.CurrentDomain.SetPrincipalPolicy(PrincipalPolicy.WindowsPrincipal).
The following example demonstrates how PrincipalPermission can be used declaratively to demand that the current user is Bob and belongs to the Supervisor role.
<PrincipalPermissionAttribute(SecurityAction.Demand, _ Name := "Bob", Role := "Supervisor")> Public Class SampleClass
/** @attribute PrincipalPermissionAttribute(SecurityAction.Demand,
Name = "Bob", Role = "Supervisor")
*/
The following example demonstrates how to demand that the current user's identity is Bob, regardless of role membership.
<PrincipalPermissionAttribute(SecurityAction.Demand, _ Name := "Bob")> Public Class SampleClass
/** @attribute PrincipalPermissionAttribute(SecurityAction.Demand, Name = "Bob") */
The following example demonstrates how to demand only that the user is authenticated.
<PrincipalPermissionAttribute(SecurityAction.Demand, _ Authenticated := True)> Public Class SampleClass
/** @attribute PrincipalPermissionAttribute(SecurityAction.Demand,
Authenticated = true)
*/
System.Attribute
System.Security.Permissions.SecurityAttribute
System.Security.Permissions.CodeAccessSecurityAttribute
System.Security.Permissions.PrincipalPermissionAttribute
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.