AUTOPAY-26733: Add Servlet-friendly methods to http-signatures library (

#66) * AUTOPAY-26733: Add Servlet-friendly methods to http-signatures library * AUTOPAY-26733: Add Servlet-friendly methods to http-signatures library * AUTOPAY-26733: Add Servlet-friendly methods to http-signatures library License header updated * AUTOPAY-26733: Add Servlet-friendly methods to http-signatures library JavaDoc and Readme updated --------- Co-authored-by: Robert Borys <[email protected]>
Visma-AutoPay · Jan 9, 2024 · 8c86de7 · 8c86de7
1 parent 47d54b5
commit 8c86de7
Show file tree

Hide file tree

Showing 82 changed files with 283 additions and 81 deletions.
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2023 Visma Autopay AS
+Copyright (c) 2022-2024 Visma Autopay AS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -254,6 +254,8 @@ var requestContext = SignatureContext.builder()
         .method("POST")
         // Can be provided as a String or URI
         .targetUri("https://example.com/foo")
+        // Or from HttpServletRequest object
+        .targetUri(request.getRequestURL(), request.getQueryString())
         // Status for response signature
         .status(200)
 
@@ -264,6 +266,10 @@ var requestContext = SignatureContext.builder()
         .headers(Map.of("Header-One", "valueOne", "Header-Two", "valueTwo"))
         // Or as a "MultivaluedMap", often used in frameworks
         .headers(Map.of("Header-One", List.of("valueOne", "valueTwo")))
+        // Or from HttpServletRequest object
+        .headers(request.getHeaderNames(), request::getHeaders)
+        // Or from HttpServletResponse object
+        .headers(response.getHeaderNames(), response::getHeaders)
 
         // Context of related request if used in response signature
         .relatedRequest(relatedRequestContext)

diff --git a/pom.xml b/pom.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  Copyright (c) 2022-2023 Visma Autopay AS
+  Copyright (c) 2022-2024 Visma Autopay AS
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/digest/DigestAlgorithm.java b/src/main/java/net/visma/autopay/http/digest/DigestAlgorithm.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/digest/DigestCalculator.java b/src/main/java/net/visma/autopay/http/digest/DigestCalculator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/digest/DigestException.java b/src/main/java/net/visma/autopay/http/digest/DigestException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/digest/DigestHeaders.java b/src/main/java/net/visma/autopay/http/digest/DigestHeaders.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/digest/DigestVerifier.java b/src/main/java/net/visma/autopay/http/digest/DigestVerifier.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/CheckedFunction.java b/src/main/java/net/visma/autopay/http/signature/CheckedFunction.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/Component.java b/src/main/java/net/visma/autopay/http/signature/Component.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/ComponentFactory.java b/src/main/java/net/visma/autopay/http/signature/ComponentFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/DataSigner.java b/src/main/java/net/visma/autopay/http/signature/DataSigner.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/DataVerifier.java b/src/main/java/net/visma/autopay/http/signature/DataVerifier.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/DerivedComponent.java b/src/main/java/net/visma/autopay/http/signature/DerivedComponent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/DerivedComponentType.java b/src/main/java/net/visma/autopay/http/signature/DerivedComponentType.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/EllipticCurveValidator.java b/src/main/java/net/visma/autopay/http/signature/EllipticCurveValidator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/HeaderComponent.java b/src/main/java/net/visma/autopay/http/signature/HeaderComponent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/PublicKeyInfo.java b/src/main/java/net/visma/autopay/http/signature/PublicKeyInfo.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureAlgorithm.java b/src/main/java/net/visma/autopay/http/signature/SignatureAlgorithm.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureComponents.java b/src/main/java/net/visma/autopay/http/signature/SignatureComponents.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureContext.java b/src/main/java/net/visma/autopay/http/signature/SignatureContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -23,10 +23,13 @@
 
 import java.net.URI;
 import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.function.Function;
 import java.util.stream.Collectors;
 
 
@@ -162,6 +165,8 @@ public Builder method(String method) {
 
         /**
          * Sets target URI
+         * <p>
+         * {@code targetUri} is not the same as servlet's {@code requestUri}
          *
          * @param targetUri Target URI given as {@link URI} object
          * @return This builder
@@ -173,6 +178,8 @@ public Builder targetUri(URI targetUri) {
 
         /**
          * Sets target URI
+         * <p>
+         * {@code targetUri} is not the same as servlet's {@code requestUri}.
          *
          * @param targetUri Target URI given as {@link String}
          * @return This builder
@@ -182,6 +189,38 @@ public Builder targetUri(String targetUri) {
             return this;
         }
 
+        /**
+         * Sets target URI
+         * <p>
+         * Method offers compatibility with {@code HttpServletRequest} methods.
+         * {@code targetUri} is not the same as servlet's {@code requestUri}.
+         * <p>
+         * Example:
+         * <pre>
+         * SignatureContext.builder()
+         *     ...
+         *     .targetUri(request.getRequestURL(), request.getQueryString())
+         *     ...
+         *     .build();
+         * </pre>
+         *
+         * @param requestUrl  request URL
+         * @param queryString query string
+         * @return This builder
+         */
+        @SuppressWarnings("java:S1149")
+        public Builder targetUri(StringBuffer requestUrl, String queryString) {
+            var targetUriTmp = requestUrl.toString();
+
+            if (queryString != null) {
+                targetUriTmp += "?" + queryString;
+            }
+
+            this.targetUri = URI.create(targetUriTmp);
+
+            return this;
+        }
+
         /**
          * Adds an HTTP header of given name and value
          * <p>
@@ -220,6 +259,66 @@ public Builder headers(Map<String, ?> headers) {
             return this;
         }
 
+        /**
+         * Adds HTTP headers.
+         * <p>
+         * Method offers compatibility with {@code HttpServletRequest} methods.
+         * <p>
+         * Example:
+         * <pre>
+         * SignatureContext.builder()
+         *     ...
+         *     .headers(request.getHeaderNames(), request::getHeaders)
+         *     ...
+         *     .build();
+         * </pre>
+         *
+         * @param headerNames   enumeration of HTTP servlet request header names
+         * @param headersGetter getter of HTTP servlet request headers enumeration
+         * @return This builder
+         */
+        public Builder headers(Enumeration<String> headerNames, Function<String, Enumeration<String>> headersGetter) {
+            while (headerNames.hasMoreElements()) {
+                var headerName = headerNames.nextElement();
+                var headerValues = headersGetter.apply(headerName);
+
+                while (headerValues.hasMoreElements()) {
+                    populateHeaderOrTrailer(headers, headerName, headerValues.nextElement());
+                }
+            }
+            return this;
+        }
+
+        /**
+         * Adds HTTP headers.
+         * <p>
+         * Method offers compatibility with {@code HttpServletResponse} methods.
+         * <p>
+         * Example:
+         * <pre>
+         * SignatureContext.builder()
+         *     ...
+         *     .headers(response.getHeaderNames(), response::getHeaders)
+         *     ...
+         *     .build();
+         * </pre>
+         *
+         * @param headerNames   collection of HTTP servlet response header names
+         * @param headersGetter getter of HTTP servlet response headers collection
+         * @return This builder
+         */
+        public Builder headers(Collection<String> headerNames, Function<String, Collection<String>> headersGetter) {
+            for (String headerName : headerNames) {
+                var headerValues = headersGetter.apply(headerName);
+
+                for (String headerValue : headerValues) {
+                    populateHeaderOrTrailer(headers, headerName, headerValue);
+                }
+            }
+
+            return this;
+        }
+
         /**
          * Adds an HTTP trailer of given name and value
          * <p>

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureException.java b/src/main/java/net/visma/autopay/http/signature/SignatureException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureHeaders.java b/src/main/java/net/visma/autopay/http/signature/SignatureHeaders.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureKeyAlgorithm.java b/src/main/java/net/visma/autopay/http/signature/SignatureKeyAlgorithm.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureKeyFactory.java b/src/main/java/net/visma/autopay/http/signature/SignatureKeyFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureParameterType.java b/src/main/java/net/visma/autopay/http/signature/SignatureParameterType.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureParameters.java b/src/main/java/net/visma/autopay/http/signature/SignatureParameters.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureResult.java b/src/main/java/net/visma/autopay/http/signature/SignatureResult.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureSigner.java b/src/main/java/net/visma/autopay/http/signature/SignatureSigner.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureSpec.java b/src/main/java/net/visma/autopay/http/signature/SignatureSpec.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/SignatureVerifier.java b/src/main/java/net/visma/autopay/http/signature/SignatureVerifier.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/signature/VerificationSpec.java b/src/main/java/net/visma/autopay/http/signature/VerificationSpec.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/structured/CharacterValidator.java b/src/main/java/net/visma/autopay/http/structured/CharacterValidator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

diff --git a/src/main/java/net/visma/autopay/http/structured/StructuredBoolean.java b/src/main/java/net/visma/autopay/http/structured/StructuredBoolean.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022-2023 Visma Autopay AS
+ * Copyright (c) 2022-2024 Visma Autopay AS
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal