OAuthProvider

Assembly: ServiceStack.dll

View Source

Declaration

public abstract class OAuthProvider : AuthProvider, IAuthPlugin, IOAuthProvider, IAuthProvider

Properties

Type

View Source

Declaration

public override string Type { get; }

VerifyAccessTokenAsync

View Source

Declaration

public Func<string, AuthContext, Task<bool>> VerifyAccessTokenAsync { get; set; }

Meta

View Source

Declaration

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

AuthHttpGateway

View Source

Declaration

public IAuthHttpGateway AuthHttpGateway { get; set; }

ConsumerKey

View Source

Declaration

public string ConsumerKey { get; set; }

ConsumerSecret

View Source

Declaration

public string ConsumerSecret { get; set; }

RequestTokenUrl

View Source

Declaration

public string RequestTokenUrl { get; set; }

AuthorizeUrl

View Source

Declaration

public string AuthorizeUrl { get; set; }

AccessTokenUrl

View Source

Declaration

public string AccessTokenUrl { get; set; }

UserProfileUrl

View Source

Declaration

public string UserProfileUrl { get; set; }

VerifyTokenUrl

View Source

Declaration

public string VerifyTokenUrl { get; set; }

IssuerSigningKeysUrl

View Source

Declaration

public string IssuerSigningKeysUrl { get; set; }

OAuthUtils

View Source

Declaration

public OAuthAuthorizer OAuthUtils { 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; }

FormLayout

View Source

Declaration

public List<InputInfo> FormLayout { get; set; }

Icon

View Source

Declaration

public ImageInfo Icon { get; set; }

Label

View Source

Declaration

public string Label { 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; }

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

Sort

View Source

Declaration

public int Sort { get; set; }

Type

View Source

Declaration

public virtual string Type { get; }

Fields

ConsumerKeyName

View Source

Declaration

protected readonly string ConsumerKeyName

ConsumerSecretName

View Source

Declaration

protected readonly string ConsumerSecretName

Methods

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

AssertValidState()

View Source

Declaration

protected virtual void AssertValidState()

AssertConsumerSecret()

View Source

Declaration

protected virtual void AssertConsumerSecret()

AssertConsumerKey()

View Source

Declaration

protected virtual void AssertConsumerKey()

AuthenticateAsync(IServiceBase, IAuthSession, Authenticate, CancellationToken)

The entry point for all AuthProvider providers. Runs inside the AuthService so exceptions are treated normally. Overridable so you can provide your own Auth implementation.

View Source

Declaration

public abstract override 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

Init(IServiceBase, ref IAuthSession, Authenticate)

Sets the CallbackUrl and session.ReferrerUrl if not set and initializes the session tokens for this AuthProvider

View Source

Declaration

protected IAuthTokens Init(IServiceBase authService, ref IAuthSession session, Authenticate request)

Returns

ServiceStack.Auth.IAuthTokens

Parameters

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

LoadUserOAuthProviderAsync(IAuthSession, IAuthTokens)

View Source

Declaration

public virtual Task LoadUserOAuthProviderAsync(IAuthSession userSession, IAuthTokens tokens)

Returns

System.Threading.Tasks.Task

Parameters

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

Inherited Methods

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

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

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

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

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

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

Type	Name
ServiceStack.Auth.IAuthRepositoryAsync	authRepo
ServiceStack.Auth.IUserAuth	userAuth
ServiceStack.Auth.IAuthTokens	tokens
System.Threading.CancellationToken	token

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

GetAuthRepositoryAsync(IRequest)

View Source

Declaration

protected virtual IAuthRepositoryAsync GetAuthRepositoryAsync(IRequest req)

Returns

ServiceStack.Auth.IAuthRepositoryAsync

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

GetUserAuthRepositoryAsync(IRequest)

View Source

Declaration

public IUserAuthRepositoryAsync GetUserAuthRepositoryAsync(IRequest request)

Returns

ServiceStack.Auth.IUserAuthRepositoryAsync

Parameters

Type	Name
ServiceStack.Web.IRequest	request

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

Type	Name
ServiceStack.Auth.IAuthRepositoryAsync	authRepoAsync
ServiceStack.Auth.IUserAuth	userAuth
ServiceStack.Auth.IAuthTokens	tokens
System.Threading.CancellationToken	token

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

[Obsolete("Use LoadUserAuthInfoAsync")]
protected 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

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

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

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

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

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

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

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

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(AuthContext, String)

View Source

Declaration

public static string UrlFilter(AuthContext provider, string url)

Returns

System.String

Parameters

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

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

Type	Name
ServiceStack.Auth.IAuthRepositoryAsync	authRepo
ServiceStack.Auth.IUserAuth	userAuth
ServiceStack.Auth.IAuthTokens	tokens
System.Threading.CancellationToken	token

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

Type	Name
ServiceStack.IServiceBase	authService
ServiceStack.Auth.IAuthRepositoryAsync	authRepo
ServiceStack.Auth.IAuthSession	session
ServiceStack.Auth.IAuthTokens	tokens
System.Threading.CancellationToken	token

Implements

• ServiceStack.IAuthPlugin
• ServiceStack.Auth.IOAuthProvider
• ServiceStack.Auth.IAuthProvider