Skip to main content

AuthProviderSync

Sync AuthProvider base class for compatibility with Sync Auth Providers

Assembly: ServiceStack.dll
View Source
Declaration
public abstract class AuthProviderSync : 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; }

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; }

AuthEvents

View Source
Declaration
public IAuthEvents AuthEvents { get; }

ExcludeAuthInfoItems

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

Fields

Log

View Source
Declaration
protected static readonly ILog Log

PreAuthUrlFilter

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

AccessTokenUrlFilter

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

SuccessRedirectUrlFilter

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

FailedRedirectUrlFilter

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

LogoutUrlFilter

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

Methods

UrlFilter(AuthProviderSync, String)

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

System.String

Parameters
TypeName
ServiceStack.Auth.AuthProviderSyncprovider
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

Logout(IServiceBase, Authenticate)

Remove the Users Session

View Source
Declaration
public virtual object Logout(IServiceBase service, Authenticate request)
Returns

System.Object

Parameters
TypeName
ServiceStack.IServiceBaseservice
ServiceStack.Authenticaterequest

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
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Auth.IAuthTokenstokens
System.Collections.Generic.Dictionary<System.String,System.String>authInfo

GetAuthRepository(IRequest)

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

ServiceStack.Auth.IAuthRepository

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
protected virtual 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

LoginMatchesSession(IAuthSession, String)

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

System.Boolean

Parameters
TypeName
ServiceStack.Auth.IAuthSessionsession
System.StringuserName

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
TypeName
ServiceStack.IServiceBaseservice
ServiceStack.Authenticaterequest
System.Threading.CancellationTokentoken

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
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Authenticaterequest
System.Threading.CancellationTokentoken

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

Authenticate(IServiceBase, IAuthSession, Authenticate)

View Source
Declaration
public abstract object Authenticate(IServiceBase authService, IAuthSession session, Authenticate request)
Returns

System.Object

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

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

UserNameAlreadyExists(IAuthRepository, IUserAuth, IAuthTokens)

View Source
Declaration
protected virtual bool UserNameAlreadyExists(IAuthRepository authRepo, IUserAuth userAuth, IAuthTokens tokens = null)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Auth.IAuthRepositoryauthRepo
ServiceStack.Auth.IUserAuthuserAuth
ServiceStack.Auth.IAuthTokenstokens

EmailAlreadyExists(IAuthRepository, IUserAuth, IAuthTokens)

View Source
Declaration
protected virtual bool EmailAlreadyExists(IAuthRepository authRepo, IUserAuth userAuth, IAuthTokens tokens = null)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Auth.IAuthRepositoryauthRepo
ServiceStack.Auth.IUserAuthuserAuth
ServiceStack.Auth.IAuthTokenstokens

GetAuthRedirectUrl(IServiceBase, IAuthSession)

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

System.String

Parameters
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession

IsAccountLocked(IAuthRepository, IUserAuth, IAuthTokens)

View Source
Declaration
public virtual bool IsAccountLocked(IAuthRepository authRepo, IUserAuth userAuth, IAuthTokens tokens = null)
Returns

System.Boolean

Parameters
TypeName
ServiceStack.Auth.IAuthRepositoryauthRepo
ServiceStack.Auth.IUserAuthuserAuth
ServiceStack.Auth.IAuthTokenstokens

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
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthRepositoryauthRepo
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Auth.IAuthTokenstokens

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

Implements