Class PersistentTokenBasedRememberMeServices

All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.MessageSourceAware, LogoutHandler, RememberMeServices

public class PersistentTokenBasedRememberMeServices extends AbstractRememberMeServices
RememberMeServices implementation based on Barry Jaspan's Improved Persistent Login Cookie Best Practice. There is a slight modification to the described approach, in that the username is not stored as part of the cookie but obtained from the persistent store via an implementation of PersistentTokenRepository. The latter should place a unique constraint on the series identifier, so that it is impossible for the same identifier to be allocated to two different users.

User management such as changing passwords, removing users and setting user status should be combined with maintenance of the user's persistent tokens.

Note that while this class will use the date a token was created to check whether a presented cookie is older than the configured tokenValiditySeconds property and deny authentication in this case, it will not delete these tokens from storage. A suitable batch process should be run periodically to remove expired tokens from the database.

  • Field Details

  • Constructor Details

  • Method Details

    • processAutoLoginCookie

      protected UserDetails processAutoLoginCookie(String[] cookieTokens, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Locates the presented cookie data in the token repository, using the series id. If the data compares successfully with that in the persistent store, a new token is generated and stored with the same series. The corresponding cookie value is set on the response.
      Specified by:
      processAutoLoginCookie in class AbstractRememberMeServices
      cookieTokens - the series and token values
      request - the request
      response - the response, to allow the cookie to be modified if required.
      the UserDetails for the corresponding user account if the cookie was validated successfully.
      RememberMeAuthenticationException - if there is no stored token corresponding to the submitted cookie, or if the token in the persistent store has expired.
      InvalidCookieException - if the cookie doesn't have two tokens as expected.
      CookieTheftException - if a presented series value is found, but the stored token is different from the one presented.
    • onLoginSuccess

      protected void onLoginSuccess(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Authentication successfulAuthentication)
      Creates a new persistent login token with a new series number, stores the data in the persistent token repository and adds the corresponding cookie to the response.
      Specified by:
      onLoginSuccess in class AbstractRememberMeServices
    • logout

      public void logout(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Authentication authentication)
      Description copied from class: AbstractRememberMeServices
      Implementation of LogoutHandler. Default behaviour is to call cancelCookie().
      Specified by:
      logout in interface LogoutHandler
      logout in class AbstractRememberMeServices
      request - the HTTP request
      response - the HTTP response
      authentication - the current principal details
    • generateSeriesData

      protected String generateSeriesData()
    • generateTokenData

      protected String generateTokenData()
    • setSeriesLength

      public void setSeriesLength(int seriesLength)
    • setTokenLength

      public void setTokenLength(int tokenLength)
    • setTokenValiditySeconds

      public void setTokenValiditySeconds(int tokenValiditySeconds)
      setTokenValiditySeconds in class AbstractRememberMeServices