C# Class GSF.Security.SecurityProviderUtility

A helper class containing methods used in the implementation of role-based security.

Show file Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Methods

Method	Description
CreateProvider ( string username ) : ISecurityProvider	Creates a new ISecurityProvider based on the settings in the config file.
EncryptPassword ( string password ) : string	Encrypts the password to a one-way hash using the SHA1 hash algorithm.
GeneratePassword ( int length ) : string	Generates a random password of the specified length with at least one uppercase letter, one lowercase letter, one special character and one digit.
IsRegexMatch ( string spec, string target ) : bool	Determines if the specified target matches the specified spec.
IsResourceAccessible ( string resource ) : bool	Determines if the current user, as defined by the Thread.CurrentPrincipal, has permission to access the specified resource based on settings in the config file.
IsResourceSecurable ( string resource ) : bool	Determines if the specified resource is to be secured based on settings in the config file.
SendNotification ( string recipient, string subject, string body ) : void	Sends email notification message to the specified recipient using settings specified in the config file.

Private Methods

Method	Description
SecurityProviderUtility ( ) : System

Method Details

CreateProvider() public static method

Creates a new ISecurityProvider based on the settings in the config file.

public static CreateProvider ( string username ) : ISecurityProvider
username	string	Username of the user for whom the is to be created.
return	ISecurityProvider

EncryptPassword() public static method

Encrypts the password to a one-way hash using the SHA1 hash algorithm.

public static EncryptPassword ( string password ) : string
password	string	Password to be encrypted.
return	string

GeneratePassword() public static method

Generates a random password of the specified length with at least one uppercase letter, one lowercase letter, one special character and one digit.

A value of less than 8 is specified for the .

public static GeneratePassword ( int length ) : string
length	int	Length of the password to generate.
return	string

IsRegexMatch() public static method

Determines if the specified target matches the specified spec.

public static IsRegexMatch ( string spec, string target ) : bool
spec	string	Spec string that can include wildcards (''). For example, .txt
target	string	Target string to be compared with the .
return	bool

IsResourceAccessible() public static method

Determines if the current user, as defined by the Thread.CurrentPrincipal, has permission to access the specified resource based on settings in the config file.

public static IsResourceAccessible ( string resource ) : bool
resource	string	Name of the resource to be checked.
return	bool

IsResourceSecurable() public static method

Determines if the specified resource is to be secured based on settings in the config file.

public static IsResourceSecurable ( string resource ) : bool
resource	string	Name of the resource to be checked.
return	bool

SendNotification() public static method

Sends email notification message to the specified recipient using settings specified in the config file.

public static SendNotification ( string recipient, string subject, string body ) : void
recipient	string	Email address of the notification recipient.
subject	string	Subject of the notification.
body	string	Content of the notification.
return	void