[java-opensaml] 03/05: IDP-1793 Use Suppliers for HttpRequest/Response
Rod Widdowson
rdw at steadingsoftware.com
Sun Jul 31 14:33:15 UTC 2022
This is an automated email from the git hooks/post-receive script.
rdw pushed a commit to branch dev/4/IDP-1793
in repository java-opensaml.
View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=94cc0e2bc34b6cd1471d65ed547ee3a3b8c4219d
commit 94cc0e2bc34b6cd1471d65ed547ee3a3b8c4219d
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Sun Jul 31 13:35:38 2022 +0100
IDP-1793 Use Suppliers for HttpRequest/Response
https://shibboleth.atlassian.net/browse/IDP-1793
org.opensaml.saml.common.binding.security.impl.BaseSAMLSimpleSignatureSecurityHandler
loses the setter for the HttpServletRequest and gains a setter for
a Supplier<HttpServletRequest>
---
.../BaseSAMLSimpleSignatureSecurityHandler.java | 56 +++++++++++++---------
...SAML2HTTPPostSimpleSignSecurityHandlerTest.java | 5 +-
...edirectDeflateSignatureSecurityHandlerTest.java | 6 ++-
3 files changed, 43 insertions(+), 24 deletions(-)
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/BaseSAMLSimpleSignatureSecurityHandler.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/BaseSAMLSimpleSignatureSecurityHandler.java
index e09fd1904..73950684a 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/BaseSAMLSimpleSignatureSecurityHandler.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/BaseSAMLSimpleSignatureSecurityHandler.java
@@ -19,21 +19,12 @@ package org.opensaml.saml.common.binding.security.impl;
import java.util.Collections;
import java.util.List;
+import java.util.function.Supplier;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.servlet.http.HttpServletRequest;
-import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
-import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
-import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
-import net.shibboleth.utilities.java.support.codec.Base64Support;
-import net.shibboleth.utilities.java.support.codec.DecodingException;
-import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
-import net.shibboleth.utilities.java.support.logic.Constraint;
-import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
-
import org.opensaml.core.criterion.EntityIdCriterion;
import org.opensaml.messaging.context.MessageContext;
import org.opensaml.messaging.handler.AbstractMessageHandler;
@@ -54,6 +45,15 @@ import org.slf4j.LoggerFactory;
import com.google.common.base.Strings;
+import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
+import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
+import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
+import net.shibboleth.utilities.java.support.codec.Base64Support;
+import net.shibboleth.utilities.java.support.codec.DecodingException;
+import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
+import net.shibboleth.utilities.java.support.component.ComponentSupport;
+import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
+
/**
* Base class for security-oriented message handlers which verify simple "blob" signatures computed
* over some components of a request.
@@ -64,7 +64,7 @@ public abstract class BaseSAMLSimpleSignatureSecurityHandler extends AbstractMes
@Nonnull private final Logger log = LoggerFactory.getLogger(BaseSAMLSimpleSignatureSecurityHandler.class);
/** The HttpServletRequest being processed. */
- @NonnullAfterInit private HttpServletRequest httpServletRequest;
+ @NonnullAfterInit private Supplier<HttpServletRequest> httpServletRequestSupplier;
/** The context representing the SAML peer entity. */
@Nullable private SAMLPeerEntityContext peerContext;
@@ -85,23 +85,35 @@ public abstract class BaseSAMLSimpleSignatureSecurityHandler extends AbstractMes
}
/**
- * Get the HTTP servlet request being processed.
+ * Get the current HTTP request if available.
*
- * @return Returns the request.
+ * @return current HTTP request
*/
- @NonnullAfterInit public HttpServletRequest getHttpServletRequest() {
- return httpServletRequest;
+ @Nullable public HttpServletRequest getHttpServletRequest() {
+ if (httpServletRequestSupplier == null) {
+ return null;
+ }
+ return httpServletRequestSupplier.get();
}
/**
- * Set the HTTP servlet request being processed.
- *
- * @param request The to set.
+ * Get the supplier for HTTP request if available.
+ *
+ * @return current HTTP request
*/
- public void setHttpServletRequest(@Nonnull final HttpServletRequest request) {
+ @Nullable public Supplier<HttpServletRequest> getHttpServletRequestSupplier() {
+ return httpServletRequestSupplier;
+ }
+
+ /**
+ * Set the current HTTP request Supplier.
+ *
+ * @param requestSupplier Supplier for the current HTTP request
+ */
+ public void setHttpServletRequestSupplier(@Nullable final Supplier<HttpServletRequest> requestSupplier) {
ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
-
- httpServletRequest = Constraint.isNotNull(request, "HttpServletRequest cannot be null");
+
+ httpServletRequestSupplier = requestSupplier;
}
/** {@inheritDoc} */
@@ -109,7 +121,7 @@ public abstract class BaseSAMLSimpleSignatureSecurityHandler extends AbstractMes
protected void doInitialize() throws ComponentInitializationException {
super.doInitialize();
- if (httpServletRequest == null) {
+ if (getHttpServletRequest() == null) {
throw new ComponentInitializationException("HttpServletRequest cannot be null");
}
}
diff --git a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/security/impl/SAML2HTTPPostSimpleSignSecurityHandlerTest.java b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/security/impl/SAML2HTTPPostSimpleSignSecurityHandlerTest.java
index 513d8d8d4..b0381e61b 100644
--- a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/security/impl/SAML2HTTPPostSimpleSignSecurityHandlerTest.java
+++ b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/security/impl/SAML2HTTPPostSimpleSignSecurityHandlerTest.java
@@ -25,7 +25,9 @@ import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
+import java.util.function.Supplier;
+import javax.servlet.http.HttpServletRequest;
import javax.xml.XMLConstants;
import net.shibboleth.utilities.java.support.codec.DecodingException;
@@ -220,7 +222,8 @@ public class SAML2HTTPPostSimpleSignSecurityHandlerTest extends XMLObjectBaseTes
sigValParams.setSignatureTrustEngine(signatureTrustEngine);
handler = new SAML2HTTPPostSimpleSignSecurityHandler();
- handler.setHttpServletRequest(buildServletRequest());
+ final HttpServletRequest request = buildServletRequest();
+ handler.setHttpServletRequestSupplier(new Supplier<>() {public HttpServletRequest get() { return request;}});
handler.setParser(parserPool);
handler.setKeyInfoResolver(kiResolver);
handler.initialize();
diff --git a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/security/impl/SAML2HTTPRedirectDeflateSignatureSecurityHandlerTest.java b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/security/impl/SAML2HTTPRedirectDeflateSignatureSecurityHandlerTest.java
index 3f9cc0f14..ec45cda6d 100644
--- a/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/security/impl/SAML2HTTPRedirectDeflateSignatureSecurityHandlerTest.java
+++ b/opensaml-saml-impl/src/test/java/org/opensaml/saml/saml2/binding/security/impl/SAML2HTTPRedirectDeflateSignatureSecurityHandlerTest.java
@@ -25,6 +25,9 @@ import java.security.cert.X509Certificate;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
+import java.util.function.Supplier;
+
+import javax.servlet.http.HttpServletRequest;
import net.shibboleth.utilities.java.support.collection.Pair;
import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
@@ -201,7 +204,8 @@ public class SAML2HTTPRedirectDeflateSignatureSecurityHandlerTest extends XMLObj
sigValParams.setSignatureTrustEngine(signatureTrustEngine);
handler = new SAML2HTTPRedirectDeflateSignatureSecurityHandler();
- handler.setHttpServletRequest(buildServletRequest());
+ final HttpServletRequest request = buildServletRequest();
+ handler.setHttpServletRequestSupplier(new Supplier<>() {public HttpServletRequest get() { return request;}});
handler.initialize();
messageContext = new MessageContext();
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list