com.alibaba.nacos.auth

接口 ProtocolAuthService<R>

所有已知实现类:

AbstractProtocolAuthService, GrpcProtocolAuthService, HttpProtocolAuthService

public interface ProtocolAuthService<R>

Protocol auth service.

作者:

xiweng.yy

方法概要

限定符和类型	方法和说明
boolean	enableAuth(Secured secured) Judgement whether enable auth feature according to secured information.
void	initialize() Init protocol auth service.
IdentityContext	parseIdentity(R request) Parse identity context from protocol request.
Resource	parseResource(R request, Secured secured) Parse resource from protocol request and secured annotation.
boolean	validateAuthority(IdentityContext identityContext, Permission permission) Validate identity whether had permission for the resource and action.
boolean	validateIdentity(IdentityContext identityContext, Resource resource) Validate identity whether is legal.

方法详细资料

initialize

void initialize()

Init protocol auth service.

enableAuth

boolean enableAuth(Secured secured)

Judgement whether enable auth feature according to secured information.

configuration authEnabled in AuthConfigs is the main switch. If authEnabled is false, this method and other follow methods should not be called. This method is only for plugin to judge whether auth this Secured. For example, plugins can only auth for write action or only for naming type request.

参数:

secured - secured information

返回:

true if enable auth, otherwise false

parseResource

Resource parseResource(R request,
                       Secured secured)

Parse resource from protocol request and secured annotation.

参数:

request - protocol request

secured - api secured annotation

返回:

resource

parseIdentity

IdentityContext parseIdentity(R request)

Parse identity context from protocol request.

参数:

request - protocol request

返回:

identity context

validateIdentity

boolean validateIdentity(IdentityContext identityContext,
                         Resource resource)
                  throws AccessException

Validate identity whether is legal.

参数:

identityContext - identity context

resource - resource

返回:

true if legal, otherwise false

抛出:

AccessException - exception during validating

validateAuthority

boolean validateAuthority(IdentityContext identityContext,
                          Permission permission)
                   throws AccessException

Validate identity whether had permission for the resource and action.

参数:

identityContext - identity context

permission - permission include resource and action

返回:

true if legal, otherwise false

抛出:

AccessException - exception during validating