org.yamcs.security

Class BasicAuthModule

java.lang.Object

org.yamcs.security.BasicAuthModule

All Implemented Interfaces:

AuthModule

public class BasicAuthModule
extends Object
implements AuthModule

Basic authentication module that checks username/password eihter in LDAP or a password file

Author:

nm

Constructor Summary

Constructors

Constructor and Description
BasicAuthModule(Map<String,Object> config)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<AuthenticationToken>	authenticateHttp(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest req) Authenticate the request and return a CompletableFuture to indicate the completion.
String[]	getRoles(AuthenticationToken authenticationToken) Get the list of roles of the user.
User	getUser(AuthenticationToken authenticationToken) returns the user authenticated by the token
boolean	hasPrivilege(AuthenticationToken authenticationToken, Privilege.Type type, String privilege)
boolean	hasRole(AuthenticationToken authenticationToken, String role)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthModule

public BasicAuthModule(Map<String,Object> config)

Method Detail

getRoles

public String[] getRoles(AuthenticationToken authenticationToken)

Description copied from interface: AuthModule

Get the list of roles of the user.

Specified by:

getRoles in interface AuthModule

Returns:

the roles of the calling user

authenticateHttp

public CompletableFuture<AuthenticationToken> authenticateHttp(io.netty.channel.ChannelHandlerContext ctx,
                                                               io.netty.handler.codec.http.HttpRequest req)

Description copied from interface: AuthModule

Authenticate the request and return a CompletableFuture to indicate the completion. Possibly send already an answer on the ctx.

Specified by:

authenticateHttp in interface AuthModule

Returns:

an AuthenticationToken that will be passed later in the checkPrivileges methods

getUser

public User getUser(AuthenticationToken authenticationToken)

Description copied from interface: AuthModule

returns the user authenticated by the token

Specified by:

getUser in interface AuthModule

Returns:

the authenticated user

hasPrivilege

public boolean hasPrivilege(AuthenticationToken authenticationToken,
                            Privilege.Type type,
                            String privilege)

Specified by:

hasPrivilege in interface AuthModule

Parameters:

type -

privilege - a opsname of tc, tm parameter or tm packet

Returns:

true if the privilege is known and the current user has it.

hasRole

public boolean hasRole(AuthenticationToken authenticationToken,
                       String role)

Specified by:

hasRole in interface AuthModule

Returns:

true if the user identified by the token is part of the requested role