diff --git a/doc/licenses/spring-web-5.3.25/LICENSE b/doc/licenses/spring-web-5.3.25/LICENSE
new file mode 100644
index 0000000000..ff77379631
--- /dev/null
+++ b/doc/licenses/spring-web-5.3.25/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ https://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "{}"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright {yyyy} {name of copyright owner}
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/doc/licenses/spring-web-5.3.25/README b/doc/licenses/spring-web-5.3.25/README
new file mode 100644
index 0000000000..f719e88ff7
--- /dev/null
+++ b/doc/licenses/spring-web-5.3.25/README
@@ -0,0 +1,7 @@
+Spring Framework (https://spring.io/projects/spring-framework)
+--------------------------------------------------------------
+
+ Version: 5.3.25
+ From: 'Spring' (https://spring.io/)
+ License(s):
+ Apache v2.0
diff --git a/doc/licenses/spring-web-5.3.25/dep-coordinates.txt b/doc/licenses/spring-web-5.3.25/dep-coordinates.txt
new file mode 100644
index 0000000000..0670c0fa8d
--- /dev/null
+++ b/doc/licenses/spring-web-5.3.25/dep-coordinates.txt
@@ -0,0 +1,4 @@
+org.springframework:spring-web:jar:5.3.25
+org.springframework:spring-beans:jar:5.3.25
+org.springframework:spring-core:jar:5.3.25
+org.springframework:spring-jcl:jar:5.3.25
diff --git a/extensions/guacamole-auth-duo/pom.xml b/extensions/guacamole-auth-duo/pom.xml
index 0614cb47d0..f7f49563c2 100644
--- a/extensions/guacamole-auth-duo/pom.xml
+++ b/extensions/guacamole-auth-duo/pom.xml
@@ -39,9 +39,33 @@
UTF-8
- true
+
+
+
+
+ com.squareup.okhttp3
+ okhttp
+ 4.9.1
+
+
+
+
+ org.jetbrains.kotlin
+ kotlin-stdlib-common
+ 1.4.10
+
+
+
+ org.jetbrains.kotlin
+ kotlin-stdlib
+ 1.4.10
+
+
+
+
+
@@ -79,11 +103,11 @@
1.1.3
-
+
- org.jetbrains.kotlin
- kotlin-stdlib-common
- 1.4.10
+ org.springframework
+ spring-web
+ 5.3.25
diff --git a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProvider.java b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProvider.java
index 0b1a33dfbc..dc9999c984 100644
--- a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProvider.java
+++ b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProvider.java
@@ -33,6 +33,13 @@
*/
public class DuoAuthenticationProvider extends AbstractAuthenticationProvider {
+ /**
+ * The unique identifier for this authentication provider. This is used in
+ * various parts of the Guacamole client to distinguish this provider from
+ * others, particularly when multiple authentication providers are used.
+ */
+ public static String PROVIDER_IDENTIFER = "duo";
+
/**
* Injector which will manage the object graph of this authentication
* provider.
@@ -58,7 +65,7 @@ public DuoAuthenticationProvider() throws GuacamoleException {
@Override
public String getIdentifier() {
- return "duo";
+ return PROVIDER_IDENTIFER;
}
@Override
diff --git a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProviderModule.java b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProviderModule.java
index b9a37b0708..372bbcc39b 100644
--- a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProviderModule.java
+++ b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/DuoAuthenticationProviderModule.java
@@ -73,7 +73,6 @@ protected void configure() {
// Bind Duo-specific services
bind(ConfigurationService.class);
bind(UserVerificationService.class);
-
}
}
diff --git a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/UserVerificationService.java b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/UserVerificationService.java
index 5606836868..efd8a43572 100644
--- a/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/UserVerificationService.java
+++ b/extensions/guacamole-auth-duo/src/main/java/org/apache/guacamole/auth/duo/UserVerificationService.java
@@ -39,6 +39,7 @@
import org.apache.guacamole.net.auth.credentials.CredentialsInfo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import org.springframework.web.util.UriComponentsBuilder;
/**
* Service for verifying the identity of a user against Duo.
@@ -51,13 +52,13 @@ public class UserVerificationService {
* The name of the parameter which Duo will return in it's GET call-back
* that contains the code that the client will use to generate a token.
*/
- private static final String DUO_CODE_PARAMETER_NAME = "duo_code";
+ public static final String DUO_CODE_PARAMETER_NAME = "duo_code";
/**
* The name of the parameter that will be used in the GET call-back that
* contains the session state.
*/
- private static final String DUO_STATE_PARAMETER_NAME = "state";
+ public static final String DUO_STATE_PARAMETER_NAME = "state";
/**
* The value that will be returned in the token if Duo authentication
@@ -101,12 +102,20 @@ public void verifyAuthenticatedUser(AuthenticatedUser authenticatedUser)
try {
+ String redirectUrl = confService.getRedirectUrl().toString();
+
+ String builtUrl = UriComponentsBuilder
+ .fromUriString(redirectUrl)
+ .queryParam(Credentials.RESUME_QUERY, DuoAuthenticationProvider.PROVIDER_IDENTIFER)
+ .build()
+ .toUriString();
+
// Set up the Duo Client
Client duoClient = new Client.Builder(
confService.getClientId(),
confService.getClientSecret(),
confService.getAPIHostname(),
- confService.getRedirectUrl().toString())
+ builtUrl)
.build();
duoClient.healthCheck();
@@ -133,8 +142,8 @@ public void verifyAuthenticatedUser(AuthenticatedUser authenticatedUser)
new TranslatableMessage("LOGIN.INFO_DUO_REDIRECT_PENDING")
)
)),
- duoState,
- expirationTimestamp
+ duoState, DuoAuthenticationProvider.PROVIDER_IDENTIFER,
+ DUO_STATE_PARAMETER_NAME, expirationTimestamp
);
}
diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/language/TranslatableGuacamoleInsufficientCredentialsException.java b/guacamole-ext/src/main/java/org/apache/guacamole/language/TranslatableGuacamoleInsufficientCredentialsException.java
index 648e15007c..f0c27bc365 100644
--- a/guacamole-ext/src/main/java/org/apache/guacamole/language/TranslatableGuacamoleInsufficientCredentialsException.java
+++ b/guacamole-ext/src/main/java/org/apache/guacamole/language/TranslatableGuacamoleInsufficientCredentialsException.java
@@ -157,15 +157,23 @@ public TranslatableGuacamoleInsufficientCredentialsException(String message,
* @param state
* An opaque value that may be used by a client to maintain state across requests which are part
* of the same authentication transaction.
+ *
+ * @param providerIdentifier
+ * The identifier of the authentication provider that this exception pertains to.
+ *
+ * @param queryIdentifier
+ * The identifier of the specific query parameter within the
+ * authentication process that this exception pertains to.
*
* @param expires
* The timestamp after which the state token associated with the authentication process expires,
* specified as the number of milliseconds since the UNIX epoch.
*/
public TranslatableGuacamoleInsufficientCredentialsException(String message,
- String key, CredentialsInfo credentialsInfo, String state, long expires) {
- super(message, credentialsInfo, state, expires);
- this.translatableMessage = new TranslatableMessage(key);
+ String key, CredentialsInfo credentialsInfo, String state, String providerIdentifier,
+ String queryIdentifier, long expires) {
+ super(message, credentialsInfo, state, providerIdentifier, queryIdentifier, expires);
+ this.translatableMessage = new TranslatableMessage(key);
}
@Override
diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/Credentials.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/Credentials.java
index 6ad0e240b3..45eebe80df 100644
--- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/Credentials.java
+++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/Credentials.java
@@ -34,6 +34,16 @@
*/
public class Credentials implements Serializable {
+ /**
+ * The RESUME_QUERY is a query parameter key used to determine which
+ * authentication provider's process should be resumed during multi-step
+ * authentication. The auth provider will set this parameter before
+ * redirecting to an external service, and it is checked upon return to
+ * Guacamole to ensure the correct authentication state is continued
+ * without starting over.
+ */
+ public static final String RESUME_QUERY = "provider_id";
+
/**
* Unique identifier associated with this specific version of Credentials.
*/
diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/credentials/GuacamoleInsufficientCredentialsException.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/credentials/GuacamoleInsufficientCredentialsException.java
index c7a903c959..def5350b6e 100644
--- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/credentials/GuacamoleInsufficientCredentialsException.java
+++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/credentials/GuacamoleInsufficientCredentialsException.java
@@ -33,6 +33,20 @@ public class GuacamoleInsufficientCredentialsException extends GuacamoleCredenti
*/
private static final String DEFAULT_STATE = "";
+/**
+ * The default provider identifier to use when no specific provider is identified.
+ * This serves as a placeholder indicating that either no specific provider is
+ * responsible for the exception or the responsible provider has not been identified.
+ */
+private static final String DEFAULT_PROVIDER_IDENTIFIER = "";
+
+/**
+ * The default query identifier to use when no specific query is identified.
+ * This serves as a placeholder and indicates that the specific query related to
+ * the provider's state resume operation has not been provided.
+ */
+private static final String DEFAULT_QUERY_IDENTIFIER = "";
+
/**
* The default expiration timestamp to use when no specific expiration is provided,
* effectively indicating that the state token does not expire.
@@ -45,6 +59,20 @@ public class GuacamoleInsufficientCredentialsException extends GuacamoleCredenti
*/
protected final String state;
+ /**
+ * The identifier for the authentication provider that threw this exception.
+ * This is used to link the exception back to the originating source of the
+ * authentication attempt, allowing clients to determine which provider's
+ * authentication process should be resumed.
+ */
+ protected final String providerIdentifier;
+
+ /**
+ * An identifier for the specific query within the URL for this provider that can
+ * be checked to resume the authentication state.
+ */
+ protected final String queryIdentifier;
+
/**
* The timestamp after which the state token associated with the authentication process
* should no longer be considered valid, expressed as the number of milliseconds since
@@ -67,15 +95,25 @@ public class GuacamoleInsufficientCredentialsException extends GuacamoleCredenti
* An opaque value that may be used by a client to maintain state
* across requests which are part of the same authentication transaction.
*
+ * @param providerIdentifier
+ * The identifier of the authentication provider that this exception pertains to.
+ *
+ * @param queryIdentifier
+ * The identifier of the specific query parameter within the
+ * authentication process that this exception pertains to.
+ *
* @param expires
* The timestamp after which the state token associated with the
* authentication process should no longer be considered valid, expressed
* as the number of milliseconds since UNIX epoch.
*/
public GuacamoleInsufficientCredentialsException(String message,
- CredentialsInfo credentialsInfo, String state, long expires) {
+ CredentialsInfo credentialsInfo, String state, String providerIdentifier, String queryIdentifier,
+ long expires) {
super(message, credentialsInfo);
this.state = state;
+ this.providerIdentifier = providerIdentifier;
+ this.queryIdentifier = queryIdentifier;
this.expires = expires;
}
@@ -96,6 +134,8 @@ public GuacamoleInsufficientCredentialsException(String message, Throwable cause
CredentialsInfo credentialsInfo) {
super(message, cause, credentialsInfo);
this.state = DEFAULT_STATE;
+ this.providerIdentifier = DEFAULT_PROVIDER_IDENTIFIER;
+ this.queryIdentifier = DEFAULT_QUERY_IDENTIFIER;
this.expires = DEFAULT_EXPIRES;
}
@@ -112,6 +152,8 @@ public GuacamoleInsufficientCredentialsException(String message, Throwable cause
public GuacamoleInsufficientCredentialsException(String message, CredentialsInfo credentialsInfo) {
super(message, credentialsInfo);
this.state = DEFAULT_STATE;
+ this.providerIdentifier = DEFAULT_PROVIDER_IDENTIFIER;
+ this.queryIdentifier = DEFAULT_QUERY_IDENTIFIER;
this.expires = DEFAULT_EXPIRES;
}
@@ -128,6 +170,8 @@ public GuacamoleInsufficientCredentialsException(String message, CredentialsInfo
public GuacamoleInsufficientCredentialsException(Throwable cause, CredentialsInfo credentialsInfo) {
super(cause, credentialsInfo);
this.state = DEFAULT_STATE;
+ this.providerIdentifier = DEFAULT_PROVIDER_IDENTIFIER;
+ this.queryIdentifier = DEFAULT_QUERY_IDENTIFIER;
this.expires = DEFAULT_EXPIRES;
}
@@ -141,6 +185,27 @@ public String getState() {
return state;
}
+ /**
+ * Retrieves the identifier of the authentication provider responsible for this exception.
+ *
+ * @return The identifier of the authentication provider, allowing clients to know
+ * which provider's process should be resumed in response to this exception.
+ */
+ public String getProviderIdentifier() {
+ return providerIdentifier;
+ }
+
+ /**
+ * Retrieves the specific query identifier associated with the URL for the provider
+ * that can be checked to resume the authentication state.
+ *
+ * @return The query identifier that serves as a reference to a specific point or
+ * transaction within the provider's authentication process.
+ */
+ public String getQueryIdentifier() {
+ return queryIdentifier;
+ }
+
/**
* Retrieves the expiration timestamp of the state token, specified as the
* number of milliseconds since the UNIX epoch.
diff --git a/guacamole/src/main/java/org/apache/guacamole/rest/auth/AuthenticationService.java b/guacamole/src/main/java/org/apache/guacamole/rest/auth/AuthenticationService.java
index 2946b12763..1fafa4a300 100644
--- a/guacamole/src/main/java/org/apache/guacamole/rest/auth/AuthenticationService.java
+++ b/guacamole/src/main/java/org/apache/guacamole/rest/auth/AuthenticationService.java
@@ -47,6 +47,7 @@
import org.slf4j.LoggerFactory;
import com.google.inject.Singleton;
+import java.util.Iterator;
/**
* A service for performing authentication checks in REST endpoints.
@@ -325,12 +326,15 @@ private List getUserContexts(GuacamoleSession existingSess
// Store state and expiration
String state = e.getState();
long expiration = e.getExpires();
+ String queryIdentifier = e.getQueryIdentifier();
+ String providerIdentifier = e.getProviderIdentifier();
- resumableStateMap.put(state, new ResumableAuthenticationState(expiration, credentials));
+ resumableStateMap.put(state, new ResumableAuthenticationState(providerIdentifier,
+ queryIdentifier, expiration, credentials));
throw new GuacamoleAuthenticationProcessException("User "
- + "authentication aborted during initial "
- + "UserContext creation.", authProvider, e);
+ + "authentication aborted during initial "
+ + "UserContext creation.", authProvider, e);
}
catch (GuacamoleException | RuntimeException | Error e) {
throw new GuacamoleAuthenticationProcessException("User "
@@ -350,6 +354,82 @@ private List getUserContexts(GuacamoleSession existingSess
return userContexts;
}
+
+ /**
+ * Resumes authentication using given credentials if a matching resumable
+ * state is found.
+ *
+ * @param credentials
+ * The initial credentials containing the request object.
+ *
+ * @return
+ * Resumed credentials if a valid resumable state is found; otherwise,
+ * returns {@code null}.
+ */
+ private Credentials resumeAuthentication(Credentials credentials) {
+
+ Credentials resumedCredentials = null;
+
+ // Retrieve signed State from the request
+ HttpServletRequest request = credentials.getRequest();
+
+ // Retrieve the provider id from the query parameters.
+ String resumableProviderId = request.getParameter(Credentials.RESUME_QUERY);
+ // Check if a provider id is set.
+ if (resumableProviderId == null || resumableProviderId.isEmpty()) {
+ // return if a provider id is not set.
+ return null;
+ }
+
+ // Use an iterator to safely remove entries while iterating
+ Iterator> iterator = resumableStateMap.entrySet().iterator();
+ while (iterator.hasNext()) {
+ Map.Entry entry = iterator.next();
+ ResumableAuthenticationState resumableState = entry.getValue();
+
+ // Check if the provider ID from the request matches the one in the map entry.
+ boolean providerMatches = resumableProviderId.equals(resumableState.getProviderIdentifier());
+ if (!providerMatches) {
+ // If the provider doesn't match, skip to the next entry.
+ continue;
+ }
+
+ // Use the query identifier from the entry to retrieve the corresponding state parameter.
+ String stateQueryParameter = resumableState.getQueryIdentifier();
+ String stateFromParameter = request.getParameter(stateQueryParameter);
+
+ // Check if the `state` parameter is set.
+ if (stateFromParameter == null || stateFromParameter.isEmpty()) {
+ // Remove and continue if `state` is not provided or is empty.
+ iterator.remove();
+ continue;
+ }
+
+ // If the key in the entry (state) matches the state parameter provided in the request.
+ if (entry.getKey().equals(stateFromParameter)) {
+
+ // Remove the current entry from the map.
+ iterator.remove();
+
+ // Check if the resumableState has expired
+ if (!resumableState.isExpired()) {
+
+ // Set the actualCredentials to the credentials from the matched entry.
+ resumedCredentials = resumableState.getCredentials();
+
+ if (resumedCredentials != null) {
+ resumedCredentials.setRequest(request);
+ }
+
+ }
+
+ // Exit the loop since we've found the matching state and it's unique.
+ break;
+ }
+ }
+
+ return resumedCredentials;
+ }
/**
* Authenticates a user using the given credentials and optional
@@ -388,24 +468,11 @@ public String authenticate(Credentials credentials, String token)
AuthenticatedUser authenticatedUser;
String authToken;
- Credentials actualCredentials = credentials;
- String state;
- ResumableAuthenticationState resumableState = null;
-
- // Retrieve signed State from the request
- HttpServletRequest request = credentials.getRequest();
-
- // If state is provided, attempt to resume authentication
- if ((state = request.getParameter("state")) != null && (resumableState = resumableStateMap.get(state)) != null) {
- // The resumableState is removed as it should be a single-use token
- resumableStateMap.remove(state);
- // Check if the resumableState has expired
- if (!resumableState.isExpired()) {
- actualCredentials = resumableState.getCredentials();
- actualCredentials.setRequest(request);
- }
- }
+ // Retrieve credentials if resuming authentication
+ Credentials actualCredentials = resumeAuthentication(credentials);
+ if (actualCredentials == null)
+ actualCredentials = credentials;
try {
diff --git a/guacamole/src/main/java/org/apache/guacamole/rest/auth/ResumableAuthenticationState.java b/guacamole/src/main/java/org/apache/guacamole/rest/auth/ResumableAuthenticationState.java
index 3e24f4f042..f295a82088 100644
--- a/guacamole/src/main/java/org/apache/guacamole/rest/auth/ResumableAuthenticationState.java
+++ b/guacamole/src/main/java/org/apache/guacamole/rest/auth/ResumableAuthenticationState.java
@@ -39,10 +39,31 @@ public class ResumableAuthenticationState {
*/
private Credentials credentials;
+ /**
+ * A unique string identifying the authentication provider related to the state.
+ * This field allows the client to know which provider's authentication process
+ * should be resumed using this state.
+ */
+ private String providerIdentifier;
+
+ /**
+ * A unique string that can be used to identify a specific query within the
+ * authentication process for the identified provider. This identifier can
+ * help the resumption of an authentication process.
+ */
+ private String queryIdentifier;
+
/**
* Constructs a new ResumableAuthenticationState object with the specified
* expiration timestamp and user credentials.
*
+ * @param providerIdentifier
+ * The identifier of the authentication provider to which this resumable state pertains.
+ *
+ * @param queryIdenifier
+ * The identifier of the specific query within the provider's
+ * authentication process that this state corresponds to.
+ *
* @param expirationTimestamp
* The timestamp in milliseconds since the Unix epoch when this state
* expires and can no longer be used to resume authentication.
@@ -51,9 +72,12 @@ public class ResumableAuthenticationState {
* The Credentials object initially submitted by the user and associated
* with this resumable state.
*/
- public ResumableAuthenticationState(long expirationTimestamp, Credentials credentials) {
+ public ResumableAuthenticationState(String providerIdentifier, String queryIdentifier,
+ long expirationTimestamp, Credentials credentials) {
this.expirationTimestamp = expirationTimestamp;
this.credentials = credentials;
+ this.providerIdentifier = providerIdentifier;
+ this.queryIdentifier = queryIdentifier;
}
/**
@@ -78,4 +102,27 @@ public boolean isExpired() {
public Credentials getCredentials() {
return this.credentials;
}
+
+ /**
+ * Retrieves the identifier of the authentication provider associated with this state.
+ *
+ * @return
+ * The identifier of the authentication provider, providing context for this state
+ * within the overall authentication sequence.
+ */
+ public String getProviderIdentifier() {
+ return this.providerIdentifier;
+ }
+
+ /**
+ * Retrieves the identifier for a specific query in the authentication
+ * process that is associated with this state.
+ *
+ * @return
+ * The query identifier used for retrieving a value representing the state within
+ * the provider's authentication process that should be resumed.
+ */
+ public String getQueryIdentifier() {
+ return this.queryIdentifier;
+ }
}