java.lang.Object

com.gmt2001.httpwsserver.auth.HttpBasicAuthenticationHandler

All Implemented Interfaces:: HttpAuthenticationHandler

public class HttpBasicAuthenticationHandler extends Object implements HttpAuthenticationHandler

Provides a HttpAuthenticationHandler that implements HTTP Basic authentication, as well as allowing the same format to be provided in a cookie

Author:: gmt2001

Constructor Summary

Constructors

Constructor

Description

HttpBasicAuthenticationHandler(String realm, String user, String pass, String loginUri)

Constructor

HttpBasicAuthenticationHandler(String realm, String user, String pass, String loginUri, boolean allowPaneluser)

Constructor
Method Summary

Modifier and Type

Method

Description

boolean

checkAuthorization(ChannelHandlerContext ctx, FullHttpRequest req)

Checks if the given FullHttpRequest has the correct header with valid credentials

boolean

equals(Object obj)

static String

getAuthorizationString(HttpHeaders headers)

Checks the given HttpHeaders for either an Authorization Basic, or a cookie named panellogin

int

hashCode()

void

invalidateAuthorization(ChannelHandlerContext ctx, FullHttpRequest req)

Invalidates the authentication of the specified ChannelHandlerContext, if supported by the authentication handler

boolean

isAuthorized(ChannelHandlerContext ctx, FullHttpRequest req)

Checks if the given FullHttpRequest is a valid authentication request, or if the underlying Channel has already been authenticated When returning false, this method MUST NOT send a response to the client

boolean

isAuthorized(ChannelHandlerContext ctx, HttpHeaders headers)

Checks if the given HttpHeaders contain a valid authorization, or if the underlying Channel has already been authenticated When returning false, this method MUST NOT send a response to the client

boolean

isAuthorized(String user, String pass)

Checks if the given username and password is a valid When returning false, this method MUST NOT send a response to the client

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- HttpBasicAuthenticationHandler
  
  public HttpBasicAuthenticationHandler(String realm, String user, String pass, String loginUri)
  
  Constructor
  
  Parameters:
  
  realm - The realm to present to the user
  
  user - The username required for valid authentication
  
  pass - The password required for valid authentication
  
  loginUri - The login page URI
  
  Throws:
  
  IllegalArgumentException - If realm contains any double quotes or user contains any colons
- HttpBasicAuthenticationHandler
  
  public HttpBasicAuthenticationHandler(String realm, String user, String pass, String loginUri, boolean allowPaneluser)
  
  Constructor
  
  Parameters:
  
  realm - The realm to present to the user
  
  user - The username required for valid authentication
  
  pass - The password required for valid authentication
  
  loginUri - The login page URI
  
  allowPanelUser - Whether this instance is allow to authenticate headers against PanelUser
  
  Throws:
  
  IllegalArgumentException - If realm contains any double quotes or user contains any colons
Method Details
- checkAuthorization
  
  public boolean checkAuthorization(ChannelHandlerContext ctx, FullHttpRequest req)
  
  Checks if the given FullHttpRequest has the correct header with valid credentials
  
  Specified by:
  
  checkAuthorization in interface HttpAuthenticationHandler
  
  Parameters:
  
  ctx - The ChannelHandlerContext of the session
  
  req - The FullHttpRequest to check
  
  Returns:
  
  , this method will also reply with 401 Unauthorized and then close the channel
- invalidateAuthorization
  
  public void invalidateAuthorization(ChannelHandlerContext ctx, FullHttpRequest req)
  
  Description copied from interface: HttpAuthenticationHandler
  
  Invalidates the authentication of the specified ChannelHandlerContext, if supported by the authentication handler
  
  Specified by:
  
  invalidateAuthorization in interface HttpAuthenticationHandler
  
  Parameters:
  
  ctx - The ChannelHandlerContext of the session
  
  req - The FullHttpRequest
- isAuthorized
  
  public boolean isAuthorized(ChannelHandlerContext ctx, FullHttpRequest req)
  
  Description copied from interface: HttpAuthenticationHandler
  
  Checks if the given FullHttpRequest is a valid authentication request, or if the underlying Channel has already been authenticated When returning false, this method MUST NOT send a response to the client
  
  Specified by:
  
  isAuthorized in interface HttpAuthenticationHandler
  
  Parameters:
  
  ctx - The ChannelHandlerContext of the session
  
  req - The FullHttpRequest to check
  
  Returns:
  
  otherwise
- isAuthorized
  
  public boolean isAuthorized(String user, String pass)
  
  Description copied from interface: HttpAuthenticationHandler
  
  Checks if the given username and password is a valid When returning false, this method MUST NOT send a response to the client
  
  Specified by:
  
  isAuthorized in interface HttpAuthenticationHandler
  
  Parameters:
  
  user - The username
  
  pass - The password
  
  Returns:
  
  otherwise
- isAuthorized
  
  public boolean isAuthorized(ChannelHandlerContext ctx, HttpHeaders headers)
  
  Description copied from interface: HttpAuthenticationHandler
  
  Checks if the given HttpHeaders contain a valid authorization, or if the underlying Channel has already been authenticated When returning false, this method MUST NOT send a response to the client
  
  Specified by:
  
  isAuthorized in interface HttpAuthenticationHandler
  
  Parameters:
  
  ctx - The ChannelHandlerContext of the session
  
  headers - The HttpHeaders to check
  
  Returns:
  
  otherwise
- getAuthorizationString
  
  public static String getAuthorizationString(HttpHeaders headers)
  
  Checks the given HttpHeaders for either an Authorization Basic, or a cookie named panellogin
  
  Parameters:
  
  headers - The HttpHeaders to check
  
  Returns:
  
  The authorization string, still encoded with Base64, giving preference to Authorization Basic; null if neither is found
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- equals
  
  public boolean equals(Object obj)
  
  Overrides:
  
  equals in class Object

Class HttpBasicAuthenticationHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

HttpBasicAuthenticationHandler

HttpBasicAuthenticationHandler

Method Details

checkAuthorization

invalidateAuthorization

isAuthorized

isAuthorized

isAuthorized

getAuthorizationString

hashCode

equals