Add SSO Error Context and update Login Context

Author: cslzchen

src/main/java/io/cos/cas/osf/web/flow/login/OsfDefaultLoginPreparationAction.java

@@ -17,8 +17,6 @@
 import org.springframework.webflow.execution.RequestContext;
 
 import java.io.Serializable;
-import java.net.URLEncoder;
-import java.nio.charset.StandardCharsets;
 import java.util.Optional;
 import java.util.Set;
 
@@ -55,8 +53,6 @@ protected Event doExecute(RequestContext context) {
         final boolean unsupportedInstitutionLogin = isUnsupportedInstitutionLogin(context);
         final boolean orcidRedirect = isOrcidLoginAutoRedirect(context);
         final String orcidLoginUrl = getOrcidLoginUrlFromFlowScope(context);
-
-        final String encodedServiceUrl = getEncodedServiceUrlFromRequestContext(context);
         final boolean defaultService = isFromFlowlessErrorPage(context);
         final OsfUrlProperties osfUrl = Optional.of(context).map(
                 requestContext -> (OsfUrlProperties) requestContext.getFlowScope().get(OsfCasWebflowConstants.FLOW_PARAMETER_OSF_URL)
@@ -72,7 +68,6 @@ protected Event doExecute(RequestContext context) {
                 -> (OsfCasLoginContext) requestContext.getFlowScope().get(PARAMETER_LOGIN_CONTEXT)).orElse(null);
         if (loginContext == null) {
             loginContext = new OsfCasLoginContext(
-                    encodedServiceUrl,
                     institutionLogin,
                     institutionId,
                     StringUtils.EMPTY,
@@ -83,7 +78,6 @@ protected Event doExecute(RequestContext context) {
                     defaultServiceUrl
             );
         } else {
-            loginContext.setEncodedServiceUrl(encodedServiceUrl);
             loginContext.setInstitutionLogin(institutionLogin);
             loginContext.setInstitutionId(institutionId);
             loginContext.setInstitutionSupportEmail(StringUtils.EMPTY);
@@ -150,14 +144,6 @@ private String getOrcidLoginUrlFromFlowScope(final RequestContext context) {
         return null;
     }
 
-    private String getEncodedServiceUrlFromRequestContext(final RequestContext context) throws AssertionError {
-        final String serviceUrl = context.getRequestParameters().get(PARAMETER_SERVICE);
-        if (StringUtils.isBlank(serviceUrl)) {
-            return null;
-        }
-        return URLEncoder.encode(serviceUrl, StandardCharsets.UTF_8);
-    }
-
     private boolean isFromFlowlessErrorPage(final RequestContext context) {
         final String errorCode = context.getRequestParameters().get(PARAMETER_REDIRECT_SOURCE);
         return !StringUtils.isBlank(errorCode) && EXPECTED_REDIRECT_CODES.contains(errorCode);

src/main/java/io/cos/cas/osf/web/flow/login/OsfPrincipalFromNonInteractiveCredentialsAction.java

@@ -18,6 +18,7 @@
 import io.cos.cas.osf.configuration.model.OsfApiProperties;
 import io.cos.cas.osf.configuration.model.OsfUrlProperties;
 import io.cos.cas.osf.web.support.OsfApiInstitutionAuthenticationResult;
+import io.cos.cas.osf.web.support.OsfCasSsoErrorContext;
 
 import com.nimbusds.jose.crypto.DirectEncrypter;
 import com.nimbusds.jose.crypto.MACSigner;
@@ -141,6 +142,8 @@
 @Getter
 public class OsfPrincipalFromNonInteractiveCredentialsAction extends AbstractNonInteractiveCredentialsAction {
 
+    private static final String PARAMETER_SSO_ERROR_CONTEXT = "osfSsoErrorContext";
+
     private static final String USERNAME_PARAMETER_NAME = "username";
 
     private static final String VERIFICATION_KEY_PARAMETER_NAME = "verification_key";
@@ -810,4 +813,35 @@ private String retrieveDepartment(final String departmentRaw, final boolean eduP
         }
         return "";
     }
+
+    /**
+     * Prepare {@link OsfCasSsoErrorContext} and put it in flow.
+     *
+     * @param context the request context
+     * @param handleErrorName the error name
+     * @param errorMessage the error message
+     * @param ssoEmail user's SSO email
+     * @param ssoIdentity user's SSO identity
+     * @param institutionId institution ID
+     * @param institutionSupportEmail institution support email
+     */
+    private void setSsoErrorContext(
+            final RequestContext context,
+            final String handleErrorName,
+            final String errorMessage,
+            final String ssoEmail,
+            final String ssoIdentity,
+            final String institutionId,
+            final String institutionSupportEmail
+    ) {
+        OsfCasSsoErrorContext ssoErrorContext =  new OsfCasSsoErrorContext(
+                handleErrorName,
+                errorMessage,
+                ssoEmail,
+                ssoIdentity,
+                institutionId,
+                institutionSupportEmail
+        );
+        context.getFlowScope().put(PARAMETER_SSO_ERROR_CONTEXT, ssoErrorContext);
+    }
 }

src/main/java/io/cos/cas/osf/web/support/OsfCasLoginContext.java

@@ -26,16 +26,6 @@ public class OsfCasLoginContext implements Serializable  {
 
     private static final long serialVersionUID = 7523144720609509742L;
 
-    /**
-     * The encoded service URL provided by the "service=" query param in the request URL.
-     *
-     * This attribute is deprecated and should be removed since 1) ThymeLeaf handles URL building elegantly in the template and 2) both of
-     * the flow parameters "service.originalUrl" and "originalUrl" stores the current service information.
-     */
-    private String encodedServiceUrl;
-
-    private String handleErrorName;
-
     private boolean institutionLogin;
 
     private String institutionId;
@@ -56,27 +46,4 @@ public class OsfCasLoginContext implements Serializable  {
      * e.g. http(s)://[OSF Domain]/login?next=[encoded version of http(s)://[OSF Domain]/]
      */
     private String defaultServiceUrl;
-
-    public OsfCasLoginContext (
-            final String encodedServiceUrl,
-            final boolean institutionLogin,
-            final String institutionId,
-            final String institutionSupportEmail,
-            final boolean unsupportedInstitutionLogin,
-            final boolean orcidRedirect,
-            final String orcidLoginUrl,
-            final boolean defaultService,
-            final String defaultServiceUrl
-    ) {
-        this.encodedServiceUrl = encodedServiceUrl;
-        this.handleErrorName = null;
-        this.institutionLogin = institutionLogin;
-        this.institutionId = institutionId;
-        this.institutionSupportEmail = institutionSupportEmail;
-        this.unsupportedInstitutionLogin = unsupportedInstitutionLogin;
-        this.orcidRedirect = orcidRedirect;
-        this.orcidLoginUrl = orcidLoginUrl;
-        this.defaultService = defaultService;
-        this.defaultServiceUrl = defaultServiceUrl;
-    }
 }

src/main/java/io/cos/cas/osf/web/support/OsfCasSsoErrorContext.java

@@ -0,0 +1,40 @@
+package io.cos.cas.osf.web.support;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
+
+import java.io.Serializable;
+
+/**
+ * This is {@link OsfCasSsoErrorContext}.
+ *
+ * Stores detailed error information, which can be prepared and put into flow before raising an exception. Extends {@link Serializable}
+ * so that it can be put into and retrieved from the flow context conveniently.
+ *
+ * @author Longze Chen
+ * @since 23.2.0
+ */
+@AllArgsConstructor
+@Getter
+@NoArgsConstructor
+@ToString
+@Setter
+public class OsfCasSsoErrorContext implements Serializable  {
+
+    private static final long serialVersionUID = -1366351087792035267L;
+
+    private String handleErrorName;
+
+    private String errorMessage;
+
+    private String ssoEmail;
+
+    private String ssoIdentity;
+
+    private String institutionId;
+
+    private String institutionSupportEmail;
+}