C# Class Rock.Security.AuthenticationComponent

Base class for components that perform authentication based on a username and password entered by the user

Inheritance: Rock.Extension.Component

Mostra file Open project: NewSpring/Rock

Public Methods

Method	Description
Authenticate ( HttpRequest request, string &userName, string &returnUrl ) : System.Boolean	Authenticates the user based on a request from a third-party provider. Will set the username and returnUrl values.
Authenticate ( UserLogin user, string password ) : System.Boolean	Authenticates the user based on user name and password
ChangePassword ( UserLogin user, string oldPassword, string newPassword, string &warningMessage ) : bool	Changes the password.
EncodePassword ( UserLogin user, string password ) : String	Encodes the password.
GenerateLoginUrl ( HttpRequest request ) : Uri	Generates the login URL.
ImageUrl ( ) : String	Gets the URL of an image that should be displayed.
IsReturningFromAuthentication ( HttpRequest request ) : System.Boolean	Tests the Http Request to determine if authentication should be tested by this authentication provider.
SetPassword ( UserLogin user, string password ) : void	Sets the password.

Authenticates the user based on a request from a third-party provider. Will set the username and returnUrl values.

public abstract Authenticate ( HttpRequest request, string &userName, string &returnUrl ) : System.Boolean
request	System.Web.HttpRequest	The request.
userName	string	Name of the user.
returnUrl	string	The return URL.
return	System.Boolean

Authenticates the user based on user name and password

public abstract Authenticate ( UserLogin user, string password ) : System.Boolean
user	UserLogin	The user.
password	string	The password.
return	System.Boolean

Changes the password.

public abstract ChangePassword ( UserLogin user, string oldPassword, string newPassword, string &warningMessage ) : bool
user	UserLogin	The user.
oldPassword	string	The old password.
newPassword	string	The new password.
warningMessage	string	The warning message.
return	bool

Encodes the password.

public abstract EncodePassword ( UserLogin user, string password ) : String
user	UserLogin	The user.
password	string	The password.
return	String

Generates the login URL.

public abstract GenerateLoginUrl ( HttpRequest request ) : Uri
request	System.Web.HttpRequest	The request.
return	System.Uri

Gets the URL of an image that should be displayed.

public abstract ImageUrl ( ) : String
return	String

Tests the Http Request to determine if authentication should be tested by this authentication provider.

public abstract IsReturningFromAuthentication ( HttpRequest request ) : System.Boolean
request	System.Web.HttpRequest	The request.
return	System.Boolean

Sets the password.

public abstract SetPassword ( UserLogin user, string password ) : void
user	UserLogin	The user.
password	string	The password.
return	void