Skip to content

interface IAuthenticationService

cangjie
public interface IAuthenticationService

功能:定义身份验证服务的统一入口。

成员概览

成员功能
func authenticate(HttpContext, ?String)对当前请求执行身份验证。
func challenge(HttpContext, ?String, ?AuthenticationProperties)对当前请求发起质询。
func forbid(HttpContext, ?String, ?AuthenticationProperties)对当前请求执行禁止访问处理。
func signIn(HttpContext, ?String, ClaimsPrincipal, ?AuthenticationProperties)使用指定方案执行登录。
func signOut(HttpContext, ?String, ?AuthenticationProperties)使用指定方案执行登出。

func authenticate(HttpContext, ?String)

cangjie
func authenticate(context: HttpContext, scheme: ?String): AuthenticateResult

功能:对当前请求执行身份验证。

参数:

  • context: HttpContext - 当前 HTTP 上下文。
  • scheme: ?String - 指定的方案名称;为空时使用默认方案。

返回值:

func challenge(HttpContext, ?String, ?AuthenticationProperties)

cangjie
func challenge(context: HttpContext, scheme: ?String, properties: ?AuthenticationProperties): Unit

功能:对当前请求发起质询。

参数:

  • context: HttpContext - 当前 HTTP 上下文。
  • scheme: ?String - 指定的方案名称;为空时使用默认方案。
  • properties: ?AuthenticationProperties - 质询时附带的属性。

返回值:

  • Unit

func forbid(HttpContext, ?String, ?AuthenticationProperties)

cangjie
func forbid(context: HttpContext, scheme: ?String, properties: ?AuthenticationProperties): Unit

功能:对当前请求执行禁止访问处理。

参数:

  • context: HttpContext - 当前 HTTP 上下文。
  • scheme: ?String - 指定的方案名称;为空时使用默认方案。
  • properties: ?AuthenticationProperties - 禁止访问时附带的属性。

返回值:

  • Unit

func signIn(HttpContext, ?String, ClaimsPrincipal, ?AuthenticationProperties)

cangjie
func signIn(context: HttpContext, scheme: ?String, principal: ClaimsPrincipal, properties: ?AuthenticationProperties): Unit

功能:使用指定方案执行登录。

参数:

返回值:

  • Unit

func signOut(HttpContext, ?String, ?AuthenticationProperties)

cangjie
func signOut(context: HttpContext, scheme: ?String, properties: ?AuthenticationProperties): Unit

功能:使用指定方案执行登出。

参数:

  • context: HttpContext - 当前 HTTP 上下文。
  • scheme: ?String - 指定的方案名称;为空时使用默认方案。
  • properties: ?AuthenticationProperties - 登出时附带的属性。

返回值:

  • Unit