Class DigestAuthenticator

java.lang.Object
org.eclipse.jetty.ee8.security.authentication.LoginAuthenticator
org.eclipse.jetty.ee8.security.authentication.DigestAuthenticator
All Implemented Interfaces:
Authenticator
public class DigestAuthenticator extends LoginAuthenticator
The nonce max age in ms can be set with the SecurityHandler.setInitParameter(String, String) using the name "maxNonceAge". The nonce max count can be set with SecurityHandler.setInitParameter(String, String) using the name "maxNonceCount". When the age or count is exceeded, the nonce is considered stale.

  • Constructor Details

    • DigestAuthenticator

      public DigestAuthenticator()

  • Method Details

    • setConfiguration

      public void setConfiguration(Authenticator.AuthConfiguration configuration)
      Description copied from interface: Authenticator
      Configure the Authenticator
      Specified by:
      setConfiguration in interface Authenticator
      Overrides:
      setConfiguration in class LoginAuthenticator
      Parameters:
      configuration - the configuration

    • getMaxNonceCount

      public int getMaxNonceCount()
      Returns:
      the max number of times a nonce is used

    • setMaxNonceCount

      public void setMaxNonceCount(int maxNonceCount)
      Parameters:
      maxNonceCount - the max number of times a nonce is used

    • getMaxNonceAge

      public long getMaxNonceAge()
      Returns:
      the max age of a nonce in milliseconds

    • setMaxNonceAge

      public void setMaxNonceAge(long maxNonceAgeInMillis)
      Parameters:
      maxNonceAgeInMillis - the max age of a nonce in milliseconds

    • getAlgorithm

      public String getAlgorithm()
      Returns:
      the MessageDigest algorithm

    • setAlgorithm

      public void setAlgorithm(String algorithm)
      Parameters:
      algorithm - the MessageDigest algorithm

    • isUserHashing

      public boolean isUserHashing()
      Returns:
      whether the username is hashed

    • setUserHashing

      public void setUserHashing(boolean userHashing)
      Parameters:
      userHashing - whether the username is hashed

    • getAuthMethod

      public String getAuthMethod()
      Returns:
      The name of the authentication method

    • secureResponse

      public boolean secureResponse(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, boolean mandatory, org.eclipse.jetty.ee8.nested.Authentication.User validatedUser) throws ServerAuthException
      Description copied from interface: Authenticator
      is response secure
      Parameters:
      req - the request
      res - the response
      mandatory - if security is mandator
      validatedUser - the user that was validated
      Returns:
      true if response is secure
      Throws:
      ServerAuthException - if unable to test response

    • validateRequest

      public org.eclipse.jetty.ee8.nested.Authentication validateRequest(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, boolean mandatory) throws ServerAuthException
      Description copied from interface: Authenticator
      Validate a request
      Parameters:
      req - The request
      res - The response
      mandatory - True if authentication is mandatory.
      Returns:
      An Authentication. If Authentication is successful, this will be a Authentication.User. If a response has been sent by the Authenticator (which can be done for both successful and unsuccessful authentications), then the result will implement Authentication.ResponseSent. If Authentication is not mandatory, then a Authentication.Deferred may be returned.
      Throws:
      ServerAuthException - if unable to validate request

    • resolveHashedUserName

      protected String resolveHashedUserName(String hashedUserName)

      Resolves the hashed username received in the Authorization header.

      This method should look up the plain username from the username hash.

      By default, this method throws UnsupportedOperationException.

      Parameters:
      hashedUserName - the hashed username
      Returns:
      the plain username

    • resolveEncodedUserName

      protected String resolveEncodedUserName(String encodedUserName)

      Resolves the encoded username received in the Authorization header.

      The username is encoded with RFC-5987 and this method should decode it.

      By default, this method only decodes RFC-5987 usernames encoded with UTF-8 and no language; for example username: UTF-8''caf%E2%82%AC is decoded as caf€.

      Parameters:
      encodedUserName - the encoded username
      Returns:
      the decoded username

    • login

      public org.eclipse.jetty.security.UserIdentity login(String username, Object credentials, javax.servlet.ServletRequest request)
      Description copied from class: LoginAuthenticator
      If the UserIdentity returned from LoginService.login(String, Object, org.eclipse.jetty.server.Request, Function) is not null, it is assumed that the user is fully authenticated and we need to change the session id to prevent session fixation vulnerability. If the UserIdentity is not necessarily fully authenticated, then subclasses must override this method and determine when the UserIdentity IS fully authenticated and renew the session id.
      Overrides:
      login in class LoginAuthenticator
      Parameters:
      username - the username of the client to be authenticated
      credentials - the user's credential
      request - the inbound request that needs authentication

    • newNonce

      public String newNonce(org.eclipse.jetty.ee8.nested.Request request)