CredentialsAuthProviderSync

Assembly: ServiceStack.dll

View Source

Declaration

public class CredentialsAuthProviderSync : AuthProviderSync, IAuthProvider, IAuthPlugin

Properties

Type

View Source

Declaration

public override string Type { get; }

SkipPasswordVerificationForInProcessRequests

View Source

Declaration

public bool SkipPasswordVerificationForInProcessRequests { get; set; }

Inherited Properties

AccountLockedValidator

View Source

Declaration

public Func<IAuthRepository, IUserAuth, IAuthTokens, bool> AccountLockedValidator { get; set; }

AuthEvents

View Source

Declaration

public IAuthEvents AuthEvents { get; }

AuthRealm

View Source

Declaration

public string AuthRealm { get; set; }

CallbackUrl

View Source

Declaration

public string CallbackUrl { get; set; }

CustomValidationFilter

View Source

Declaration

public Func<AuthContext, IHttpResult> CustomValidationFilter { get; set; }

ExcludeAuthInfoItems

View Source

Declaration

public HashSet<string> ExcludeAuthInfoItems { get; set; }

LoadUserAuthFilter

View Source

Declaration

public Action<AuthUserSession, IAuthTokens, Dictionary<string, string>> LoadUserAuthFilter { get; set; }

Meta

View Source

Declaration

public virtual Dictionary<string, string> Meta { get; }

NavItem

View Source

Declaration

public NavItem NavItem { get; set; }

PersistSession

View Source

Declaration

public bool PersistSession { get; set; }

Provider

View Source

Declaration

public string Provider { get; set; }

RedirectUrl

View Source

Declaration

public string RedirectUrl { get; set; }

RestoreSessionFromState

View Source

Declaration

public bool? RestoreSessionFromState { get; set; }

SaveExtendedUserInfo

View Source

Declaration

public bool SaveExtendedUserInfo { get; set; }

SessionExpiry

View Source

Declaration

public TimeSpan? SessionExpiry { get; set; }

Type

View Source

Declaration

public virtual string Type { get; }

Fields

Name

View Source

Declaration

public static string Name

Realm

View Source

Declaration

public static string Realm

Methods

GetUserAuthRepository(IRequest)

View Source

Declaration

public IUserAuthRepository GetUserAuthRepository(IRequest request)

Returns

ServiceStack.Auth.IUserAuthRepository

Parameters

Type	Name
ServiceStack.Web.IRequest	request

TryAuthenticate(IServiceBase, String, String)

View Source

Declaration

public virtual bool TryAuthenticate(IServiceBase authService, string userName, string password)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.IServiceBase	authService
System.String	userName
System.String	password

IsAuthorized(IAuthSession, IAuthTokens, Authenticate)

View Source

Declaration

public override bool IsAuthorized(IAuthSession session, IAuthTokens tokens, Authenticate request = null)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Auth.IAuthSession	session
ServiceStack.Auth.IAuthTokens	tokens
ServiceStack.Authenticate	request

Authenticate(IServiceBase, IAuthSession, Authenticate)

View Source

Declaration

public override object Authenticate(IServiceBase authService, IAuthSession session, Authenticate request)

Returns

System.Object

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session
ServiceStack.Authenticate	request

Authenticate(IServiceBase, IAuthSession, String, String)

View Source

Declaration

protected object Authenticate(IServiceBase authService, IAuthSession session, string userName, string password)

Returns

System.Object

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session
System.String	userName
System.String	password

ResetSessionBeforeLogin(IServiceBase, IAuthSession, String)

View Source

Declaration

protected virtual IAuthSession ResetSessionBeforeLogin(IServiceBase authService, IAuthSession session, string userName)

Returns

ServiceStack.Auth.IAuthSession

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session
System.String	userName

Authenticate(IServiceBase, IAuthSession, String, String, String)

View Source

Declaration

protected object Authenticate(IServiceBase authService, IAuthSession session, string userName, string password, string referrerUrl)

Returns

System.Object

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session
System.String	userName
System.String	password
System.String	referrerUrl

AuthenticatePrivateRequest(IServiceBase, IAuthSession, String, String, String)

View Source

Declaration

protected virtual object AuthenticatePrivateRequest(IServiceBase authService, IAuthSession session, string userName, string password, string referrerUrl)

Returns

System.Object

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session
System.String	userName
System.String	password
System.String	referrerUrl

OnAuthenticated(IServiceBase, IAuthSession, IAuthTokens, Dictionary<String, String>)

View Source

Declaration

public override IHttpResult OnAuthenticated(IServiceBase authService, IAuthSession session, IAuthTokens tokens, Dictionary<string, string> authInfo)

Returns

ServiceStack.Web.IHttpResult

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session
ServiceStack.Auth.IAuthTokens	tokens
System.Collections.Generic.Dictionary<System.String,System.String>	authInfo

Inherited Methods

Authenticate(IServiceBase, IAuthSession, Authenticate)

View Source

Declaration

public abstract object Authenticate(IServiceBase authService, IAuthSession session, Authenticate request)

Returns

System.Object

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session
ServiceStack.Authenticate	request

AuthenticateAsync(IServiceBase, IAuthSession, Authenticate, CancellationToken)

View Source

Declaration

public Task<object> AuthenticateAsync(IServiceBase authService, IAuthSession session, Authenticate request, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task<System.Object>

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session
ServiceStack.Authenticate	request
System.Threading.CancellationToken	token

ConvertToClientError(Object, Boolean)

View Source

Declaration

protected virtual object ConvertToClientError(object failedResult, bool isHtml)

Returns

System.Object

Parameters

Type	Name
System.Object	failedResult
System.Boolean	isHtml

CreateOrMergeAuthSession(IAuthSession, IAuthTokens)

View Source

Declaration

public virtual string CreateOrMergeAuthSession(IAuthSession session, IAuthTokens tokens)

Returns

System.String

Parameters

Type	Name
ServiceStack.Auth.IAuthSession	session
ServiceStack.Auth.IAuthTokens	tokens

EmailAlreadyExists(IAuthRepository, IUserAuth, IAuthTokens)

View Source

Declaration

protected virtual bool EmailAlreadyExists(IAuthRepository authRepo, IUserAuth userAuth, IAuthTokens tokens = null)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Auth.IAuthRepository	authRepo
ServiceStack.Auth.IUserAuth	userAuth
ServiceStack.Auth.IAuthTokens	tokens

FallbackConfig(String)

Allows specifying a global fallback config that if exists is formatted with the Provider as the first arg. E.g. this appSetting with the TwitterAuthProvider: oauth.CallbackUrl="http://localhost:11001/auth/{0}" Would result in: oauth.CallbackUrl="http://localhost:11001/auth/twitter"

View Source

Declaration

protected string FallbackConfig(string fallback)

Returns

System.String

Parameters

Type	Name
System.String	fallback

GetAuthRedirectUrl(IServiceBase, IAuthSession)

View Source

Declaration

protected virtual string GetAuthRedirectUrl(IServiceBase authService, IAuthSession session)

Returns

System.String

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session

GetAuthRepository(IRequest)

View Source

Declaration

protected virtual IAuthRepository GetAuthRepository(IRequest req)

Returns

ServiceStack.Auth.IAuthRepository

Parameters

Type	Name
ServiceStack.Web.IRequest	req

GetReferrerUrl(IServiceBase, IAuthSession, Authenticate)

View Source

Declaration

protected virtual string GetReferrerUrl(IServiceBase authService, IAuthSession session, Authenticate request = null)

Returns

System.String

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session
ServiceStack.Authenticate	request

IsAccountLocked(IAuthRepository, IUserAuth, IAuthTokens)

View Source

Declaration

public virtual bool IsAccountLocked(IAuthRepository authRepo, IUserAuth userAuth, IAuthTokens tokens = null)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Auth.IAuthRepository	authRepo
ServiceStack.Auth.IUserAuth	userAuth
ServiceStack.Auth.IAuthTokens	tokens

IsAuthorized(IAuthSession, IAuthTokens, Authenticate)

View Source

Declaration

public abstract bool IsAuthorized(IAuthSession session, IAuthTokens tokens, Authenticate request = null)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Auth.IAuthSession	session
ServiceStack.Auth.IAuthTokens	tokens
ServiceStack.Authenticate	request

LoadUserAuthInfo(AuthUserSession, IAuthTokens, Dictionary<String, String>)

View Source

Declaration

protected virtual void LoadUserAuthInfo(AuthUserSession userSession, IAuthTokens tokens, Dictionary<string, string> authInfo)

Parameters

Type	Name
ServiceStack.AuthUserSession	userSession
ServiceStack.Auth.IAuthTokens	tokens
System.Collections.Generic.Dictionary<System.String,System.String>	authInfo

LoginMatchesSession(IAuthSession, String)

View Source

Declaration

protected static bool LoginMatchesSession(IAuthSession session, string userName)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Auth.IAuthSession	session
System.String	userName

Logout(IServiceBase, Authenticate)

Remove the Users Session

View Source

Declaration

public virtual object Logout(IServiceBase service, Authenticate request)

Returns

System.Object

Parameters

Type	Name
ServiceStack.IServiceBase	service
ServiceStack.Authenticate	request

LogoutAsync(IServiceBase, Authenticate, CancellationToken)

View Source

Declaration

public Task<object> LogoutAsync(IServiceBase service, Authenticate request, CancellationToken token = default(CancellationToken))

Returns

System.Threading.Tasks.Task<System.Object>

Parameters

Type	Name
ServiceStack.IServiceBase	service
ServiceStack.Authenticate	request
System.Threading.CancellationToken	token

OnAuthenticated(IServiceBase, IAuthSession, IAuthTokens, Dictionary<String, String>)

View Source

Declaration

public virtual IHttpResult OnAuthenticated(IServiceBase authService, IAuthSession session, IAuthTokens tokens, Dictionary<string, string> authInfo)

Returns

ServiceStack.Web.IHttpResult

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthSession	session
ServiceStack.Auth.IAuthTokens	tokens
System.Collections.Generic.Dictionary<System.String,System.String>	authInfo

OnFailedAuthentication(IAuthSession, IRequest, IResponse)

View Source

Declaration

public virtual Task OnFailedAuthentication(IAuthSession session, IRequest httpReq, IResponse httpRes)

Returns

System.Threading.Tasks.Task

Parameters

Type	Name
ServiceStack.Auth.IAuthSession	session
ServiceStack.Web.IRequest	httpReq
ServiceStack.Web.IResponse	httpRes

Register(IAppHost, AuthFeature)

View Source

Declaration

public virtual void Register(IAppHost appHost, AuthFeature feature)

Parameters

Type	Name
ServiceStack.IAppHost	appHost
ServiceStack.AuthFeature	feature

UrlFilter(AuthProviderSync, String)

View Source

Declaration

public static string UrlFilter(AuthProviderSync provider, string url)

Returns

System.String

Parameters

Type	Name
ServiceStack.Auth.AuthProviderSync	provider
System.String	url

UserNameAlreadyExists(IAuthRepository, IUserAuth, IAuthTokens)

View Source

Declaration

protected virtual bool UserNameAlreadyExists(IAuthRepository authRepo, IUserAuth userAuth, IAuthTokens tokens = null)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Auth.IAuthRepository	authRepo
ServiceStack.Auth.IUserAuth	userAuth
ServiceStack.Auth.IAuthTokens	tokens

ValidateAccount(IServiceBase, IAuthRepository, IAuthSession, IAuthTokens)

View Source

Declaration

protected virtual IHttpResult ValidateAccount(IServiceBase authService, IAuthRepository authRepo, IAuthSession session, IAuthTokens tokens)

Returns

ServiceStack.Web.IHttpResult

Parameters

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthRepository	authRepo
ServiceStack.Auth.IAuthSession	session
ServiceStack.Auth.IAuthTokens	tokens

Implements

• ServiceStack.Auth.IAuthProvider
• ServiceStack.IAuthPlugin