C# Класс ServiceStack.Auth.ApiKeyAuthProvider

Enable access to protected Services using API Keys
Наследование: ServiceStack.Auth.AuthProvider, IAuthWithRequest, IAuthPlugin
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
DefaultEnvironments string[]
DefaultKeySizeBytes int
DefaultTypes string[]

Открытые методы

Метод Описание
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

Защищенные методы

Метод Описание
GetApiKey ( IRequest req, string apiKey ) : ApiKey
Init ( IAppSettings appSettings = null ) : void
ValidateApiKey ( ApiKey apiKey ) : void

Приватные методы

Метод Описание
PreAuthenticateWithApiKey ( IRequest req, IResponse res, ApiKey apiKey ) : void

Описание методов

ApiKeyAuthProvider() публичный Метод

public ApiKeyAuthProvider ( ) : System
Результат System

ApiKeyAuthProvider() публичный Метод

public ApiKeyAuthProvider ( IAppSettings appSettings ) : System
appSettings IAppSettings
Результат System

Authenticate() публичный Метод

public Authenticate ( IServiceBase authService, IAuthSession session, Authenticate request ) : object
authService IServiceBase
session IAuthSession
request Authenticate
Результат object

CreateApiKey() публичный Метод

public CreateApiKey ( string environment, string keyType, int sizeBytes ) : string
environment string
keyType string
sizeBytes int
Результат string

GenerateNewApiKeys() публичный Метод

public GenerateNewApiKeys ( string userId ) : List
userId string
Результат List

GetApiKey() защищенный Метод

protected GetApiKey ( IRequest req, string apiKey ) : ApiKey
req IRequest
apiKey string
Результат ApiKey

GetSessionKey() публичный статический Метод

public static GetSessionKey ( string apiKey ) : string
apiKey string
Результат string

Init() защищенный Метод

protected Init ( IAppSettings appSettings = null ) : void
appSettings IAppSettings
Результат void

IsAuthorized() публичный Метод

public IsAuthorized ( IAuthSession session, IAuthTokens tokens, Authenticate request = null ) : bool
session IAuthSession
tokens IAuthTokens
request Authenticate
Результат bool

OnFailedAuthentication() публичный Метод

public OnFailedAuthentication ( IAuthSession session, IRequest httpReq, IResponse httpRes ) : void
session IAuthSession
httpReq IRequest
httpRes IResponse
Результат void

PreAuthenticate() публичный Метод

public PreAuthenticate ( IRequest req, IResponse res ) : void
req IRequest
res IResponse
Результат void

Register() публичный Метод

public Register ( IAppHost appHost, AuthFeature feature ) : void
appHost IAppHost
feature AuthFeature
Результат void

ValidateApiKey() защищенный Метод

protected ValidateApiKey ( ApiKey apiKey ) : void
apiKey ApiKey
Результат void

Описание свойств

DefaultEnvironments публичное статическое свойство

public static string[] DefaultEnvironments
Результат string[]

DefaultKeySizeBytes публичное статическое свойство

public static int DefaultKeySizeBytes
Результат int

DefaultTypes публичное статическое свойство

public static string[] DefaultTypes
Результат string[]