SAML RelayState

[brendony]

Does akka-http-pac4j support SAML RelayState?

I'd like to use the RelayState to redirect my SP to the appropriate page after log-in.

I see that some support for RelayState was added to pac4j here: https://github.com/pac4j/pac4j/issues/1041. My searches for documentation of this feature haven't turned up much that I can use yet!

The one thing that I did find is that relayState is used in CAS here: https://github.com/fogbeam/cas_mirror/blob/master/support/cas-server-support-pac4j-webflow/src/main/java/org/apereo/cas/web/DelegatedClientWebflowManager.java#L88

In AkkaHttpSecurity, withAuthentication() doesn't seem to have any support for setting the RelayState as it creates a new context every time: Is there some way to set the RelayState that I am missing?

(Most of my code is adapted from the demo at https://github.com/vidma/akka-http-pac4j-demo - thank you for that resource!)

Any suggestions would be very welcome!

[brendony]

Here is my suggestion for withAuthentication():

  /**
    * Authenticate using the provided pac4j configuration. Delivers an AuthenticationRequest which can be used for further authorization
    * this does not apply any authorization ofr filtering.
    */
  def withAuthentication(
                          clients: String = null /* Default null, meaning all defined clients */ ,
                          multiProfile: Boolean = true,
                          authorizers: String = "",
                          relayState: String = ""
                        ): Directive1[AuthenticatedRequest] =
    withContext().flatMap { akkaWebContext =>
      Directive[Tuple1[AuthenticatedRequest]] { inner => ctx =>
        if (relayState != "") {
          val sessionStore = akkaWebContext.getSessionStore
          sessionStore.set(akkaWebContext, SAML2StateGenerator.SAML_RELAY_STATE_ATTRIBUTE, relayState)
        }
        // TODO This is a hack to ensure that any underlying Futures are scheduled (and handled in case of errors) from here
        // TODO Fix this properly
        Future.successful(()).flatMap { _ =>
          securityLogic.perform(akkaWebContext, config, (context: AkkaHttpWebContext, profiles: util.Collection[CommonProfile], parameters: AnyRef) => {
            val authenticatedRequest = AuthenticatedRequest(context, profiles.asScala.toList)
            inner(Tuple1(authenticatedRequest))(ctx)
          }, actionAdapter, clients, authorizers, "", multiProfile)
        }
      }
    }