System.Security.Permissions.PrincipalPermissionAttribute Class

Summary

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

C# Syntax:

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)] [Serializable] public sealed class PrincipalPermissionAttribute : CodeAccessSecurityAttribute

PrincipalPermissionAttribute can be used to declaratively demand that users running your code belong to a specified role or have been authenticated. Use of PermissionState.Unrestricted creates a PrincipalPermission with PrincipalPermissionAttribute.Authenticated set to true and PrincipalPermissionAttribute.Name and PrincipalPermissionAttribute.Role set to null.

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.

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")]

    

The following example demonstrates how to demand that the current user's identity is Bob, regardless of role membership.

 [PrincipalPermissionAttribute(SecurityAction.Demand, Name="Bob")]

    

The following example demonstrates how to demand only that the user is authenticated.

 [PrincipalPermissionAttribute(SecurityAction.Demand, Authenticated=true)]

    

System.Security.Permissions Namespace See also:
MSDN: extendingmetadatausingattributes | MSDN: principal | PrincipalPermission

System.Security.Permissions.PrincipalPermissionAttribute Member List:

Public Constructors

ctor #1

Initializes a new instance of the PrincipalPermissionAttribute class with the specified SecurityAction.

Public Properties

Action (inherited from System.Security.Permissions.SecurityAttribute)	Read-write See base class member description: System.Security.Permissions.SecurityAttribute.Action Gets or sets a security action.
Authenticated	Read-write Gets or sets a value indicating whether the current principal has been authenticated by the underlying role-based security provider.
Name	Read-write Gets or sets the name of the identity associated with the current principal.
Role	Read-write Gets or sets membership in a specified security role.
TypeId (inherited from System.Attribute)	Read-only See base class member description: System.Attribute.TypeId When implemented in a derived class, gets a unique identifier for this Attribute.
Unrestricted (inherited from System.Security.Permissions.SecurityAttribute)	Read-write See base class member description: System.Security.Permissions.SecurityAttribute.Unrestricted Gets or sets a value indicating whether full (unrestricted) permission to the resource protected by the attribute is declared.

Public Methods

CreatePermission	Overridden: Creates and returns a new PrincipalPermission.
Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Attribute)	See base class member description: System.Attribute.GetHashCode Returns the hash code for this instance.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
IsDefaultAttribute (inherited from System.Attribute)	See base class member description: System.Attribute.IsDefaultAttribute When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.
Match (inherited from System.Attribute)	See base class member description: System.Attribute.Match When overridden in a derived class, returns a value indicating whether this instance equals a specified object.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.Attribute
• System.Security.Permissions.SecurityAttribute
• System.Security.Permissions.CodeAccessSecurityAttribute
• System.Security.Permissions.PrincipalPermissionAttribute

System.Security.Permissions.PrincipalPermissionAttribute Member Details

Summary

Initializes a new instance of the PrincipalPermissionAttribute class with the specified SecurityAction.

C# Syntax:

public PrincipalPermissionAttribute(    SecurityAction action );

action

One of the SecurityAction values.

Demand, InheritanceDemand, and LinkDemand are the only values of SecurityAction that have meaning for this attribute. Other actions do not apply to permissions that are not code access permissions.

Return to top

Inherited
See base class member description: System.Security.Permissions.SecurityAttribute.Action

Summary

Gets or sets a security action.

C# Syntax:

public SecurityAction Action {get; set;}

This property is inherited by all classes implementing custom attributes for declarative security.

Return to top

Summary

Gets or sets a value indicating whether the current principal has been authenticated by the underlying role-based security provider.

C# Syntax:

public bool Authenticated {get; set;}

Return to top

Summary

Gets or sets the name of the identity associated with the current principal.

C# Syntax:

public string Name {get; set;}

If the authentication provider is Windows NT, PrincipalPermissionAttribute.Name is the same as the user's Windows NT login name (in the form "DomainName\UserName"). Check the documentation of your host to determine which authentication provider it uses and how it determines the identity of the current principal.

Return to top

Summary

Gets or sets membership in a specified security role.

C# Syntax:

public string Role {get; set;}

The available roles will differ based on the authentication provider in use by the host. If the authentication provider is Windows NT, roles are Windows NT user groups (in the form "DomainName\GroupName"). Check the documentation of your host to determine which authentication provider it uses and what roles users can belong to.

Return to top

Inherited
See base class member description: System.Attribute.TypeId

Summary

When implemented in a derived class, gets a unique identifier for this Attribute.

C# Syntax:

public virtual object TypeId {get;}

As implemented, this identifier is merely the Type of the attribute. However, it is intended that the unique identifier be used to identify two attributes of the same type.

Return to top

Inherited
See base class member description: System.Security.Permissions.SecurityAttribute.Unrestricted

Summary

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

C# Syntax:

public bool Unrestricted {get; set;}

This property is inherited by all classes implementing custom attributes for declarative security.

Return to top

Summary

Creates and returns a new PrincipalPermission.

C# Syntax:

public override IPermission CreatePermission();

Return Value:

A PrincipalPermission that corresponds to this attribute.

This method should only be called by the security system, never by application code.

At compile time, attributes convert security declarations to a serialized form in metadata. Declarative security data in metadata is created from the permission that this method returns that corresponds to this attribute.

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~PrincipalPermissionAttribute();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Attribute.GetHashCode

Summary

Returns the hash code for this instance.

C# Syntax:

public override int GetHashCode();

Return Value:

A 32-bit signed integer hash code.

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Attribute.IsDefaultAttribute

Summary

When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.

C# Syntax:

public virtual bool IsDefaultAttribute();

Return Value:

true if this instance is the default attribute for the class; otherwise, false.

The default implementation of this class returns false, and must be implemented in the derived class to be useful to that class.

The implementation of this method in a derived class compares the value of this instance to a standard, default value obtained by some means, then returns a Boolean value that indicates whether the value of this instance is equal to the standard. The standard value is typically coded as a constant in the implementation, or stored programmatically in a field used by the implementation.

Return to top

Inherited
See base class member description: System.Attribute.Match

Summary

When overridden in a derived class, returns a value indicating whether this instance equals a specified object.

C# Syntax:

public virtual bool Match(    object obj );

obj

An Object to compare with this instance of Attribute.

Return Value:

true if this instance equals obj; otherwise, false.

This method determines if one Attribute equals another. Its default implementation is the same as Attribute.Equals, which performs a value and reference comparison. Override this method to implement support for attribute values, such as flags or bitfields, that consist of components that are meaningful in themselves. For example, consider an attribute whose value is a binary field divided into a bitfield of flags. Two instances of this attribute have one flag in set in common while all the other flags differ. The Equal method cannot determine that the two instances have the same flag set, but the Match method can.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page