Skip to main content

AuthProvider

Assembly: ServiceStack.dll
View Source
Declaration
public abstract class AuthProvider : IAuthProvider, IAuthPlugin

Properties

Type

View Source
Declaration
public virtual string Type { get; }

Meta

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

SessionExpiry

View Source
Declaration
public TimeSpan? SessionExpiry { get; set; }

AuthRealm

View Source
Declaration
public string AuthRealm { get; set; }

Provider

View Source
Declaration
public string Provider { get; set; }

CallbackUrl

View Source
Declaration
public string CallbackUrl { get; set; }

RedirectUrl

View Source
Declaration
public string RedirectUrl { get; set; }

PersistSession

View Source
Declaration
public bool PersistSession { get; set; }

SaveExtendedUserInfo

View Source
Declaration
public bool SaveExtendedUserInfo { get; set; }

RestoreSessionFromState

View Source
Declaration
public bool? RestoreSessionFromState { get; set; }

LoadUserAuthFilter

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

LoadUserAuthInfoFilterAsync

View Source
Declaration
public Func<AuthUserSession, IAuthTokens, Dictionary<string, string>, CancellationToken, Task> LoadUserAuthInfoFilterAsync { get; set; }

CustomValidationFilter

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

AccountLockedValidator

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

NavItem

View Source
Declaration
public NavItem NavItem { get; set; }

Sort

View Source
Declaration
public int Sort { get; set; }

Label

View Source
Declaration
public string Label { get; set; }

Icon

View Source
Declaration
public ImageInfo Icon { get; set; }

FormLayout

View Source
Declaration
public List<InputInfo> FormLayout { get; set; }

ExcludeAuthInfoItems

View Source
Declaration
public HashSet<string> ExcludeAuthInfoItems { get; set; }

AuthEvents

View Source
Declaration
public IAuthEvents AuthEvents { get; }

Fields

Log

View Source
Declaration
protected ILog Log

PreAuthUrlFilter

View Source
Declaration
public Func<AuthContext, string, string> PreAuthUrlFilter

AccessTokenUrlFilter

View Source
Declaration
public Func<AuthContext, string, string> AccessTokenUrlFilter

SuccessRedirectUrlFilter

View Source
Declaration
public Func<AuthContext, string, string> SuccessRedirectUrlFilter

FailedRedirectUrlFilter

View Source
Declaration
public Func<AuthContext, string, string> FailedRedirectUrlFilter

LogoutUrlFilter

View Source
Declaration
public Func<AuthContext, string, string> LogoutUrlFilter

Methods

UrlFilter(AuthContext, String)

View Source
Declaration
public static string UrlFilter(AuthContext provider, string url)
Returns

System.String

Parameters
TypeName
ServiceStack.Auth.AuthContextprovider
System.Stringurl

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
TypeName
System.Stringfallback

CreateAuthContext(IServiceBase, IAuthSession, IAuthTokens)

View Source
Declaration
protected virtual AuthContext CreateAuthContext(IServiceBase authService = null, IAuthSession session = null, IAuthTokens tokens = null)
Returns

ServiceStack.Auth.AuthContext

Parameters
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Auth.IAuthTokenstokens

LogoutAsync(IServiceBase, Authenticate, CancellationToken)

Remove the Users Session

View Source
Declaration
public virtual async Task<object> LogoutAsync(IServiceBase service, Authenticate request, CancellationToken token = default(CancellationToken))
Returns

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

Parameters
TypeName
ServiceStack.IServiceBaseservice
ServiceStack.Authenticaterequest
System.Threading.CancellationTokentoken

OnAuthenticatedAsync(IServiceBase, IAuthSession, IAuthTokens, Dictionary<String, String>, CancellationToken)

View Source
Declaration
public virtual async Task<IHttpResult> OnAuthenticatedAsync(IServiceBase authService, IAuthSession session, IAuthTokens tokens, Dictionary<string, string> authInfo, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<ServiceStack.Web.IHttpResult>

Parameters
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Auth.IAuthTokenstokens
System.Collections.Generic.Dictionary<System.String,System.String>authInfo
System.Threading.CancellationTokentoken

GetAuthRepository(IRequest)

View Source
Declaration
protected virtual IAuthRepository GetAuthRepository(IRequest req)
Returns

ServiceStack.Auth.IAuthRepository

Parameters
TypeName
ServiceStack.Web.IRequestreq

GetAuthRepositoryAsync(IRequest)

View Source
Declaration
protected virtual IAuthRepositoryAsync GetAuthRepositoryAsync(IRequest req)
Returns

ServiceStack.Auth.IAuthRepositoryAsync

Parameters
TypeName
ServiceStack.Web.IRequestreq

CreateOrMergeAuthSession(IAuthSession, IAuthTokens)

View Source
Declaration
public virtual string CreateOrMergeAuthSession(IAuthSession session, IAuthTokens tokens)
Returns

System.String

Parameters
TypeName
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Auth.IAuthTokenstokens

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

View Source
Declaration
[Obsolete("Use LoadUserAuthInfoAsync")]
protected void LoadUserAuthInfo(AuthUserSession userSession, IAuthTokens tokens, Dictionary<string, string> authInfo)
Parameters
TypeName
ServiceStack.AuthUserSessionuserSession
ServiceStack.Auth.IAuthTokenstokens
System.Collections.Generic.Dictionary<System.String,System.String>authInfo

LoadUserAuthInfoAsync(AuthUserSession, IAuthTokens, Dictionary<String, String>, CancellationToken)

View Source
Declaration
protected virtual Task LoadUserAuthInfoAsync(AuthUserSession userSession, IAuthTokens tokens, Dictionary<string, string> authInfo, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task

Parameters
TypeName
ServiceStack.AuthUserSessionuserSession
ServiceStack.Auth.IAuthTokenstokens
System.Collections.Generic.Dictionary<System.String,System.String>authInfo
System.Threading.CancellationTokentoken

LoginMatchesSession(IAuthSession, String)

View Source
Declaration
protected static bool LoginMatchesSession(IAuthSession session, string userName)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Auth.IAuthSessionsession
System.StringuserName

IsAuthorized(IAuthSession, IAuthTokens, Authenticate)

View Source
Declaration
public abstract bool IsAuthorized(IAuthSession session, IAuthTokens tokens, Authenticate request = null)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Auth.IAuthTokenstokens
ServiceStack.Authenticaterequest

AuthenticateAsync(IServiceBase, IAuthSession, Authenticate, CancellationToken)

View Source
Declaration
public abstract Task<object> AuthenticateAsync(IServiceBase authService, IAuthSession session, Authenticate request, CancellationToken token = default(CancellationToken))
Returns

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

Parameters
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Authenticaterequest
System.Threading.CancellationTokentoken

OnFailedAuthentication(IAuthSession, IRequest, IResponse)

View Source
Declaration
public virtual Task OnFailedAuthentication(IAuthSession session, IRequest httpReq, IResponse httpRes)
Returns

System.Threading.Tasks.Task

Parameters
TypeName
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Web.IRequesthttpReq
ServiceStack.Web.IResponsehttpRes

UserNameAlreadyExistsAsync(IAuthRepositoryAsync, IUserAuth, IAuthTokens, CancellationToken)

View Source
Declaration
protected virtual async Task<bool> UserNameAlreadyExistsAsync(IAuthRepositoryAsync authRepo, IUserAuth userAuth, IAuthTokens tokens = null, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<System.Boolean>

Parameters
TypeName
ServiceStack.Auth.IAuthRepositoryAsyncauthRepo
ServiceStack.Auth.IUserAuthuserAuth
ServiceStack.Auth.IAuthTokenstokens
System.Threading.CancellationTokentoken

EmailAlreadyExistsAsync(IAuthRepositoryAsync, IUserAuth, IAuthTokens, CancellationToken)

View Source
Declaration
protected virtual async Task<bool> EmailAlreadyExistsAsync(IAuthRepositoryAsync authRepo, IUserAuth userAuth, IAuthTokens tokens = null, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<System.Boolean>

Parameters
TypeName
ServiceStack.Auth.IAuthRepositoryAsyncauthRepo
ServiceStack.Auth.IUserAuthuserAuth
ServiceStack.Auth.IAuthTokenstokens
System.Threading.CancellationTokentoken

GetAuthRedirectUrl(IServiceBase, IAuthSession)

View Source
Declaration
protected virtual string GetAuthRedirectUrl(IServiceBase authService, IAuthSession session)
Returns

System.String

Parameters
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession

IsAccountLockedAsync(IAuthRepositoryAsync, IUserAuth, IAuthTokens, CancellationToken)

View Source
Declaration
public virtual Task<bool> IsAccountLockedAsync(IAuthRepositoryAsync authRepoAsync, IUserAuth userAuth, IAuthTokens tokens = null, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<System.Boolean>

Parameters
TypeName
ServiceStack.Auth.IAuthRepositoryAsyncauthRepoAsync
ServiceStack.Auth.IUserAuthuserAuth
ServiceStack.Auth.IAuthTokenstokens
System.Threading.CancellationTokentoken

ValidateAccountAsync(IServiceBase, IAuthRepositoryAsync, IAuthSession, IAuthTokens, CancellationToken)

View Source
Declaration
protected virtual async Task<IHttpResult> ValidateAccountAsync(IServiceBase authService, IAuthRepositoryAsync authRepo, IAuthSession session, IAuthTokens tokens, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<ServiceStack.Web.IHttpResult>

Parameters
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthRepositoryAsyncauthRepo
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Auth.IAuthTokenstokens
System.Threading.CancellationTokentoken

GetReferrerUrl(IServiceBase, IAuthSession, Authenticate)

View Source
Declaration
protected virtual string GetReferrerUrl(IServiceBase authService, IAuthSession session, Authenticate request = null)
Returns

System.String

Parameters
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Authenticaterequest

ConvertToClientError(Object, Boolean)

View Source
Declaration
protected virtual object ConvertToClientError(object failedResult, bool isHtml)
Returns

System.Object

Parameters
TypeName
System.ObjectfailedResult
System.BooleanisHtml

Register(IAppHost, AuthFeature)

View Source
Declaration
public virtual void Register(IAppHost appHost, AuthFeature feature)
Parameters
TypeName
ServiceStack.IAppHostappHost
ServiceStack.AuthFeaturefeature

GetUserAuthRepositoryAsync(IRequest)

View Source
Declaration
public IUserAuthRepositoryAsync GetUserAuthRepositoryAsync(IRequest request)
Returns

ServiceStack.Auth.IUserAuthRepositoryAsync

Parameters
TypeName
ServiceStack.Web.IRequestrequest

Implements