Package org.summerboot.jexpress.security.auth

Class BootAuthenticator<E>

java.lang.Object

org.summerboot.jexpress.security.auth.BootAuthenticator<E>

Type Parameters:

E - authenticate(T metaData)

All Implemented Interfaces:

io.grpc.ServerInterceptor, Authenticator<E>

Direct Known Subclasses:

LDAPAuthenticator

public abstract class BootAuthenticator<E>
extends Object
implements Authenticator<E>, io.grpc.ServerInterceptor

Author:

Changski Tie Zheng Zhang 张铁铮, 魏泽北, 杜旺财, 杜富贵

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthenticatorListener	authenticatorListener
protected AuthTokenCache	authTokenCache
protected static final String	ERROR
protected static final String	ERROR_NO_CFG

Fields inherited from interface org.summerboot.jexpress.security.auth.Authenticator

GrpcCaller, GrpcCallerId

Constructor Summary

Constructors

Constructor	Description
BootAuthenticator()

Method Summary

Modifier and Type	Method	Description
protected abstract Caller	authenticate(String usename, String password, E metaData, AuthenticatorListener listener, ServiceContext context)
boolean	customizedAuthorizationCheck(RequestProcessor processor, io.netty.handler.codec.http.HttpHeaders httpRequestHeaders, String httpRequestPath, ServiceContext context)	Extra authorization checks before processing
protected Caller	fromJwt(io.jsonwebtoken.Claims claims)	Convert Caller back from auth token, override this method to implement customized token format
protected String	getBearerToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders)	Retrieve token based on RFC 6750 - The OAuth 2.0 Authorization Framework override this method to get customized token
protected String	getBearerToken(String authHeaderValue)	Retrieve token based on RFC 6750 - The OAuth 2.0 Authorization Framework override this method to get customized token
<ReqT, RespT> io.grpc.ServerCall.Listener<ReqT>	interceptCall(io.grpc.ServerCall<ReqT,RespT> serverCall, io.grpc.Metadata metadata, io.grpc.ServerCallHandler<ReqT,RespT> serverCallHandler)	gRPC JWT verification
void	logoutToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders, AuthTokenCache cache, ServiceContext context)	Success HTTP Status: 204 No Content
void	logoutToken(String authToken, AuthTokenCache cache, ServiceContext context)	Success HTTP Status: 204 No Content
protected Integer	overrideVerifyTokenErrorCode()
protected io.jsonwebtoken.Claims	parseJWT(String jwt)
String	signJWT(String username, String pwd, E metaData, int validForMinutes, ServiceContext context)	Success HTTP Status: 201 Created
String	signJWT(Caller caller, int validForMinutes, ServiceContext context)	Success HTTP Status: 201 Created
io.jsonwebtoken.JwtBuilder	toJwt(Caller caller, String txId)	Convert Caller to auth token, override this method to implement customized token format
Caller	verifyToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders, AuthTokenCache cache, Integer errorCode, ServiceContext context)	Success HTTP Status: 200 OK
Caller	verifyToken(String authToken, AuthTokenCache cache, Integer errorCode, ServiceContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ERROR_NO_CFG

protected static final String ERROR_NO_CFG

authenticatorListener

@Inject(optional=true)
protected AuthenticatorListener authenticatorListener

authTokenCache

@Inject
protected AuthTokenCache authTokenCache

ERROR

protected static final String ERROR

See Also:

• Constant Field Values

Constructor Details

BootAuthenticator

public BootAuthenticator()

Method Details

signJWT

public String signJWT(String username,
 String pwd,
 E metaData,
 int validForMinutes,
 ServiceContext context)
               throws NamingException

Description copied from interface: Authenticator

Success HTTP Status: 201 Created

Specified by:

signJWT in interface Authenticator<E>

Parameters:

username -

pwd -

metaData -

validForMinutes -

context -

Returns:

Throws:

NamingException

signJWT

public String signJWT(Caller caller,
 int validForMinutes,
 ServiceContext context)

Description copied from interface: Authenticator

Success HTTP Status: 201 Created

Specified by:

signJWT in interface Authenticator<E>

Parameters:

caller -

validForMinutes -

context -

Returns:

authenticate

protected abstract Caller authenticate(String usename,
 String password,
 E metaData,
 AuthenticatorListener listener,
 ServiceContext context)
                                throws NamingException

Parameters:

usename -

password -

metaData -

listener -

context -

Returns:

Throws:

NamingException

toJwt

public io.jsonwebtoken.JwtBuilder toJwt(Caller caller,
 String txId)

Convert Caller to auth token, override this method to implement customized token format

Specified by:

toJwt in interface Authenticator<E>

Parameters:

caller -

txId -

Returns:

formatted auth token builder

parseJWT

protected io.jsonwebtoken.Claims parseJWT(String jwt)

fromJwt

protected Caller fromJwt(io.jsonwebtoken.Claims claims)

Convert Caller back from auth token, override this method to implement customized token format

Parameters:

claims -

Returns:

Caller

getBearerToken

protected String getBearerToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders)

Retrieve token based on RFC 6750 - The OAuth 2.0 Authorization Framework override this method to get customized token

Parameters:

httpRequestHeaders -

Returns:

getBearerToken

protected String getBearerToken(String authHeaderValue)

Retrieve token based on RFC 6750 - The OAuth 2.0 Authorization Framework override this method to get customized token

Parameters:

authHeaderValue - "Bearer jwt"

Returns:

verifyToken

public Caller verifyToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders,
 AuthTokenCache cache,
 Integer errorCode,
 ServiceContext context)

Description copied from interface: Authenticator

Success HTTP Status: 200 OK

Specified by:

verifyToken in interface Authenticator<E>

Parameters:

httpRequestHeaders -

cache -

errorCode -

context -

Returns:

verifyToken

public Caller verifyToken(String authToken,
 AuthTokenCache cache,
 Integer errorCode,
 ServiceContext context)

Specified by:

verifyToken in interface Authenticator<E>

Parameters:

authToken -

cache -

errorCode -

context -

Returns:

customizedAuthorizationCheck

public boolean customizedAuthorizationCheck(RequestProcessor processor,
 io.netty.handler.codec.http.HttpHeaders httpRequestHeaders,
 String httpRequestPath,
 ServiceContext context)
                                     throws Exception

Description copied from interface: Authenticator

Extra authorization checks before processing

Specified by:

customizedAuthorizationCheck in interface Authenticator<E>

Parameters:

processor -

httpRequestHeaders -

httpRequestPath -

context -

Returns:

true if good to process request, otherwise false

Throws:

Exception

overrideVerifyTokenErrorCode

protected Integer overrideVerifyTokenErrorCode()

logoutToken

public void logoutToken(io.netty.handler.codec.http.HttpHeaders httpRequestHeaders,
 AuthTokenCache cache,
 ServiceContext context)

Description copied from interface: Authenticator

Success HTTP Status: 204 No Content

Specified by:

logoutToken in interface Authenticator<E>

Parameters:

httpRequestHeaders -

cache -

context -

logoutToken

public void logoutToken(String authToken,
 AuthTokenCache cache,
 ServiceContext context)

Description copied from interface: Authenticator

Success HTTP Status: 204 No Content

Specified by:

logoutToken in interface Authenticator<E>

Parameters:

authToken -

cache -

context -

interceptCall

public <ReqT,
RespT>
io.grpc.ServerCall.Listener<ReqT> interceptCall(io.grpc.ServerCall<ReqT,RespT> serverCall,
 io.grpc.Metadata metadata,
 io.grpc.ServerCallHandler<ReqT,RespT> serverCallHandler)

gRPC JWT verification

Specified by:

interceptCall in interface io.grpc.ServerInterceptor

Type Parameters:

ReqT -

RespT -

Parameters:

serverCall -

metadata -

serverCallHandler -

Returns: