C# Class ServiceStack.Auth.ApiKeyAuthProvider

Enable access to protected Services using API Keys
Inheritance: ServiceStack.Auth.AuthProvider, IAuthWithRequest, IAuthPlugin
Afficher le fichier Open project: ServiceStack/ServiceStack Class Usage Examples

Méthodes publiques

Свойство Type Description
DefaultEnvironments string[]
DefaultKeySizeBytes int
DefaultTypes string[]

Méthodes publiques

Méthode Description
ApiKeyAuthProvider ( ) : System
ApiKeyAuthProvider ( IAppSettings appSettings ) : System
Authenticate ( IServiceBase authService, IAuthSession session, Authenticate request ) : object
CreateApiKey ( string environment, string keyType, int sizeBytes ) : string
GenerateNewApiKeys ( string userId ) : List
GetSessionKey ( string apiKey ) : string
IsAuthorized ( IAuthSession session, IAuthTokens tokens, Authenticate request = null ) : bool
OnFailedAuthentication ( IAuthSession session, IRequest httpReq, IResponse httpRes ) : void
PreAuthenticate ( IRequest req, IResponse res ) : void
Register ( IAppHost appHost, AuthFeature feature ) : void

Méthodes protégées

Méthode Description
GetApiKey ( IRequest req, string apiKey ) : ApiKey
Init ( IAppSettings appSettings = null ) : void
ValidateApiKey ( ApiKey apiKey ) : void

Private Methods

Méthode Description
PreAuthenticateWithApiKey ( IRequest req, IResponse res, ApiKey apiKey ) : void

Method Details

ApiKeyAuthProvider() public méthode

public ApiKeyAuthProvider ( ) : System
Résultat System

ApiKeyAuthProvider() public méthode

public ApiKeyAuthProvider ( IAppSettings appSettings ) : System
appSettings IAppSettings
Résultat System

Authenticate() public méthode

public Authenticate ( IServiceBase authService, IAuthSession session, Authenticate request ) : object
authService IServiceBase
session IAuthSession
request Authenticate
Résultat object

CreateApiKey() public méthode

public CreateApiKey ( string environment, string keyType, int sizeBytes ) : string
environment string
keyType string
sizeBytes int
Résultat string

GenerateNewApiKeys() public méthode

public GenerateNewApiKeys ( string userId ) : List
userId string
Résultat List

GetApiKey() protected méthode

protected GetApiKey ( IRequest req, string apiKey ) : ApiKey
req IRequest
apiKey string
Résultat ApiKey

GetSessionKey() public static méthode

public static GetSessionKey ( string apiKey ) : string
apiKey string
Résultat string

Init() protected méthode

protected Init ( IAppSettings appSettings = null ) : void
appSettings IAppSettings
Résultat void

IsAuthorized() public méthode

public IsAuthorized ( IAuthSession session, IAuthTokens tokens, Authenticate request = null ) : bool
session IAuthSession
tokens IAuthTokens
request Authenticate
Résultat bool

OnFailedAuthentication() public méthode

public OnFailedAuthentication ( IAuthSession session, IRequest httpReq, IResponse httpRes ) : void
session IAuthSession
httpReq IRequest
httpRes IResponse
Résultat void

PreAuthenticate() public méthode

public PreAuthenticate ( IRequest req, IResponse res ) : void
req IRequest
res IResponse
Résultat void

Register() public méthode

public Register ( IAppHost appHost, AuthFeature feature ) : void
appHost IAppHost
feature AuthFeature
Résultat void

ValidateApiKey() protected méthode

protected ValidateApiKey ( ApiKey apiKey ) : void
apiKey ApiKey
Résultat void

Property Details

DefaultEnvironments public_oe static_oe property

public static string[] DefaultEnvironments
Résultat string[]

DefaultKeySizeBytes public_oe static_oe property

public static int DefaultKeySizeBytes
Résultat int

DefaultTypes public_oe static_oe property

public static string[] DefaultTypes
Résultat string[]