You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ws.apache.org by co...@apache.org on 2022/06/13 14:33:28 UTC

[ws-wss4j] branch master updated: Finished pmd upgrade of ws-security-stax

This is an automated email from the ASF dual-hosted git repository.

coheigea pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ws-wss4j.git


The following commit(s) were added to refs/heads/master by this push:
     new fbf412987 Finished pmd upgrade of ws-security-stax
fbf412987 is described below

commit fbf41298704da5f7a2f640d658d181f33461eda6
Author: Colm O hEigeartaigh <co...@apache.org>
AuthorDate: Mon Jun 13 15:33:04 2022 +0100

    Finished pmd upgrade of ws-security-stax
---
 .../output/CustomTokenOutputProcessor.java         |  2 +-
 .../output/EncryptEndingOutputProcessor.java       | 44 ++++++++++------------
 .../output/SecurityHeaderOutputProcessor.java      |  2 +-
 .../output/SecurityHeaderReorderProcessor.java     | 36 ++++++++----------
 .../output/WSSSignatureEndingOutputProcessor.java  | 38 +++++++++----------
 .../output/WSSSignatureOutputProcessor.java        |  4 +-
 .../securityToken/UsernameSecurityTokenImpl.java   |  2 +-
 .../AttachmentCompleteSignatureTransform.java      |  4 +-
 .../AttachmentContentSignatureTransform.java       |  2 +-
 .../securityEvent/KerberosTokenSecurityEvent.java  | 14 ++-----
 .../securityEvent/WSSecurityEventConstants.java    |  2 +-
 .../wss4j/stax/setup/ConfigurationConverter.java   |  6 +--
 12 files changed, 69 insertions(+), 87 deletions(-)

diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/CustomTokenOutputProcessor.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/CustomTokenOutputProcessor.java
index 56df538e3..6a4001830 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/CustomTokenOutputProcessor.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/CustomTokenOutputProcessor.java
@@ -135,7 +135,7 @@ public class CustomTokenOutputProcessor extends AbstractOutputProcessor {
             createStartElementAndOutputAsEvent(outputProcessorChain, elementName, namespaces, attributes);
             Node firstChild = element.getFirstChild();
             while (firstChild != null) {
-                switch (firstChild.getNodeType()) {
+                switch (firstChild.getNodeType()) { //NOPMD
                     case Node.ELEMENT_NODE:
                         outputToken((Element) firstChild, outputProcessorChain);
                         break;
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/EncryptEndingOutputProcessor.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/EncryptEndingOutputProcessor.java
index eaa653ffa..16d9b9af4 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/EncryptEndingOutputProcessor.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/EncryptEndingOutputProcessor.java
@@ -66,32 +66,28 @@ public class EncryptEndingOutputProcessor extends AbstractEncryptEndingOutputPro
         loop:
         while (!xmlSecEventDeque.isEmpty()) {
             XMLSecEvent xmlSecEvent = xmlSecEventDeque.pop();
-            switch (xmlSecEvent.getEventType()) {
-                case XMLStreamConstants.START_ELEMENT:
-                    if (WSSUtils.isSecurityHeaderElement(xmlSecEvent, actor)) {
+            if (XMLStreamConstants.START_ELEMENT == xmlSecEvent.getEventType()
+                    && WSSUtils.isSecurityHeaderElement(xmlSecEvent, actor)) {
+                int attachmentCount = attachmentCount(outputProcessorChain);
+                for (int i = 0; i < attachmentCount; i++) {
+                    OutputProcessorUtils.updateSecurityHeaderOrder(
+                            outputProcessorChain, WSSConstants.TAG_xenc_EncryptedData, getAction(), true);
+                }
+                List<SecurityHeaderOrder> securityHeaderOrderList =
+                        outputProcessorChain.getSecurityContext().getAsList(SecurityHeaderOrder.class);
+                List<SecurityHeaderOrder> tmpList = null;
+                if (securityHeaderOrderList != null) {
+                    tmpList = new ArrayList<>(securityHeaderOrderList);
+                    securityHeaderOrderList.clear();
+                }
 
-                        int attachmentCount = attachmentCount(outputProcessorChain);
-                        for (int i = 0; i < attachmentCount; i++) {
-                            OutputProcessorUtils.updateSecurityHeaderOrder(
-                                    outputProcessorChain, WSSConstants.TAG_xenc_EncryptedData, getAction(), true);
-                        }
-                        List<SecurityHeaderOrder> securityHeaderOrderList =
-                                outputProcessorChain.getSecurityContext().getAsList(SecurityHeaderOrder.class);
-                        List<SecurityHeaderOrder> tmpList = null;
-                        if (securityHeaderOrderList != null) {
-                            tmpList = new ArrayList<>(securityHeaderOrderList);
-                            securityHeaderOrderList.clear();
-                        }
+                outputProcessorChain.reset();
+                outputProcessorChain.processEvent(xmlSecEvent);
 
-                        outputProcessorChain.reset();
-                        outputProcessorChain.processEvent(xmlSecEvent);
-
-                        if (securityHeaderOrderList != null) {
-                            securityHeaderOrderList.addAll(tmpList);
-                        }
-                        break loop;
-                    }
-                    break;
+                if (securityHeaderOrderList != null) {
+                    securityHeaderOrderList.addAll(tmpList);
+                }
+                break loop;
             }
             outputProcessorChain.reset();
             outputProcessorChain.processEvent(xmlSecEvent);
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/SecurityHeaderOutputProcessor.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/SecurityHeaderOutputProcessor.java
index 784fbf5f0..9878996e1 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/SecurityHeaderOutputProcessor.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/SecurityHeaderOutputProcessor.java
@@ -54,7 +54,7 @@ public class SecurityHeaderOutputProcessor extends AbstractOutputProcessor {
 
         boolean eventHandled = false;
 
-        switch (xmlSecEvent.getEventType()) {
+        switch (xmlSecEvent.getEventType()) {   //NOPMD
             case XMLStreamConstants.START_ELEMENT:
                 XMLSecStartElement xmlSecStartElement = xmlSecEvent.asStartElement();
                 final String soapMessageVersion = WSSUtils.getSOAPMessageVersionNamespace(xmlSecStartElement);
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/SecurityHeaderReorderProcessor.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/SecurityHeaderReorderProcessor.java
index a0fd0cb55..2f7d65ff4 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/SecurityHeaderReorderProcessor.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/SecurityHeaderReorderProcessor.java
@@ -153,30 +153,26 @@ public class SecurityHeaderReorderProcessor extends AbstractOutputProcessor {
             }
             outputProcessorChain.processEvent(xmlSecEvent);
             return;
-        } else if (documentLevel == 4) {
-            switch (xmlSecEvent.getEventType()) {
-                case XMLStreamConstants.START_ELEMENT:
-                    XMLSecStartElement xmlSecStartElement = xmlSecEvent.asStartElement();
-
-                    List<SecurityHeaderOrder> securityHeaderOrderList =
-                        outputProcessorChain.getSecurityContext().getAsList(SecurityHeaderOrder.class);
-                    SecurityHeaderOrder securityHeaderOrder = securityHeaderOrderList.get(securityHeaderIndex);
-                    if (!xmlSecStartElement.getName().equals(WSSConstants.TAG_xenc_EncryptedData)
-                        && !xmlSecStartElement.getName().equals(securityHeaderOrder.getSecurityHeaderElementName())) {
-                        throw new WSSecurityException(
-                                WSSecurityException.ErrorCode.FAILURE, "empty",
-                                new Object[] {"Invalid security header order. Expected "
+        } else if (documentLevel == 4 && XMLStreamConstants.START_ELEMENT == xmlSecEvent.getEventType()) {
+            XMLSecStartElement xmlSecStartElement = xmlSecEvent.asStartElement();
+
+            List<SecurityHeaderOrder> securityHeaderOrderList =
+                    outputProcessorChain.getSecurityContext().getAsList(SecurityHeaderOrder.class);
+            SecurityHeaderOrder securityHeaderOrder = securityHeaderOrderList.get(securityHeaderIndex);
+            if (!xmlSecStartElement.getName().equals(WSSConstants.TAG_xenc_EncryptedData)
+                    && !xmlSecStartElement.getName().equals(securityHeaderOrder.getSecurityHeaderElementName())) {
+                throw new WSSecurityException(
+                        WSSecurityException.ErrorCode.FAILURE, "empty",
+                        new Object[]{"Invalid security header order. Expected "
                                 + securityHeaderOrder.getSecurityHeaderElementName()
                                 + " but got " + xmlSecStartElement.getName()});
-                    }
+            }
 
-                    Map<SecurityHeaderOrder, Deque<XMLSecEvent>> map = actionEventMap.get(securityHeaderOrder.getAction());
-                    currentDeque = new ArrayDeque<>();
-                    map.put(securityHeaderOrder, currentDeque);
+            Map<SecurityHeaderOrder, Deque<XMLSecEvent>> map = actionEventMap.get(securityHeaderOrder.getAction());
+            currentDeque = new ArrayDeque<>();
+            map.put(securityHeaderOrder, currentDeque);
 
-                    securityHeaderIndex++;
-                    break;
-            }
+            securityHeaderIndex++;
         }
         currentDeque.offer(xmlSecEvent);
     }
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/WSSSignatureEndingOutputProcessor.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/WSSSignatureEndingOutputProcessor.java
index 23dad4084..5941d6242 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/WSSSignatureEndingOutputProcessor.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/WSSSignatureEndingOutputProcessor.java
@@ -257,30 +257,26 @@ public class WSSSignatureEndingOutputProcessor extends AbstractSignatureEndingOu
         loop:
         while (!xmlSecEventDeque.isEmpty()) {
             XMLSecEvent xmlSecEvent = xmlSecEventDeque.pop();
-            switch (xmlSecEvent.getEventType()) {
-                case XMLStreamConstants.START_ELEMENT:
-                    if (WSSUtils.isSecurityHeaderElement(xmlSecEvent, actor)) {
+            if (XMLStreamConstants.START_ELEMENT == xmlSecEvent.getEventType()
+                    && WSSUtils.isSecurityHeaderElement(xmlSecEvent, actor)) {
+                OutputProcessorUtils.updateSecurityHeaderOrder(
+                        outputProcessorChain, WSSConstants.TAG_dsig_Signature, getAction(), true);
 
-                        OutputProcessorUtils.updateSecurityHeaderOrder(
-                                outputProcessorChain, WSSConstants.TAG_dsig_Signature, getAction(), true);
-
-                        List<SecurityHeaderOrder> securityHeaderOrderList =
-                                outputProcessorChain.getSecurityContext().getAsList(SecurityHeaderOrder.class);
-                        List<SecurityHeaderOrder> tmpList = null;
-                        if (securityHeaderOrderList != null) {
-                            tmpList = new ArrayList<>(securityHeaderOrderList);
-                            securityHeaderOrderList.clear();
-                        }
+                List<SecurityHeaderOrder> securityHeaderOrderList =
+                        outputProcessorChain.getSecurityContext().getAsList(SecurityHeaderOrder.class);
+                List<SecurityHeaderOrder> tmpList = null;
+                if (securityHeaderOrderList != null) {
+                    tmpList = new ArrayList<>(securityHeaderOrderList);
+                    securityHeaderOrderList.clear();
+                }
 
-                        outputProcessorChain.reset();
-                        outputProcessorChain.processEvent(xmlSecEvent);
+                outputProcessorChain.reset();
+                outputProcessorChain.processEvent(xmlSecEvent);
 
-                        if (securityHeaderOrderList != null) {
-                            securityHeaderOrderList.addAll(tmpList);
-                        }
-                        break loop;
-                    }
-                    break;
+                if (securityHeaderOrderList != null) {
+                    securityHeaderOrderList.addAll(tmpList);
+                }
+                break loop;
             }
             outputProcessorChain.reset();
             outputProcessorChain.processEvent(xmlSecEvent);
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/WSSSignatureOutputProcessor.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/WSSSignatureOutputProcessor.java
index ea98e3243..ae42c2dd9 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/WSSSignatureOutputProcessor.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/processor/output/WSSSignatureOutputProcessor.java
@@ -198,8 +198,8 @@ public class WSSSignatureOutputProcessor extends AbstractSignatureOutputProcesso
                         signaturePartDef.setDigestAlgo(getSecurityProperties().getSignatureDigestAlgorithm());
                     }
 
-                    DigestOutputStream digestOutputStream = createMessageDigestOutputStream(signaturePartDef.getDigestAlgo());
-                    InputStream inputStream = attachment.getSourceStream();
+                    DigestOutputStream digestOutputStream = createMessageDigestOutputStream(signaturePartDef.getDigestAlgo());  //NOPMD
+                    InputStream inputStream = attachment.getSourceStream(); //NOPMD
                     if (!inputStream.markSupported()) {
                         inputStream = new BufferedInputStream(inputStream);
                     }
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/securityToken/UsernameSecurityTokenImpl.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/securityToken/UsernameSecurityTokenImpl.java
index 3ac3bc5d2..e83a831f1 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/securityToken/UsernameSecurityTokenImpl.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/securityToken/UsernameSecurityTokenImpl.java
@@ -52,7 +52,7 @@ public class UsernameSecurityTokenImpl extends AbstractInboundSecurityToken impl
     private Subject subject;
     private Principal principal;
 
-    public UsernameSecurityTokenImpl(WSSConstants.UsernameTokenPasswordType usernameTokenPasswordType,
+    public UsernameSecurityTokenImpl(WSSConstants.UsernameTokenPasswordType usernameTokenPasswordType,  //NOPMD
                                      String username, String password, String createdTime, byte[] nonce,
                                      byte[] salt, Long iteration,
                                      WSInboundSecurityContext wsInboundSecurityContext, String id,
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/transformer/AttachmentCompleteSignatureTransform.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/transformer/AttachmentCompleteSignatureTransform.java
index 973d87721..28d5b8a33 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/transformer/AttachmentCompleteSignatureTransform.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/transformer/AttachmentCompleteSignatureTransform.java
@@ -35,10 +35,10 @@ public class AttachmentCompleteSignatureTransform extends AttachmentContentSigna
     public void transform(InputStream inputStream) throws XMLStreamException {
         InputStream is = inputStream;
         try {
-            OutputStream outputStream = getOutputStream();
+            OutputStream outputStream = getOutputStream();  //NOPMD
             if (outputStream == null) {
                 outputStream = new ByteArrayOutputStream();
-                is = new MultiInputStream(
+                is = new MultiInputStream(//NOPMD
                         new ByteArrayInputStream(
                                 ((ByteArrayOutputStream) outputStream).toByteArray()),
                         inputStream
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/transformer/AttachmentContentSignatureTransform.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/transformer/AttachmentContentSignatureTransform.java
index 497aa614b..57a363e70 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/transformer/AttachmentContentSignatureTransform.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/impl/transformer/AttachmentContentSignatureTransform.java
@@ -99,7 +99,7 @@ public class AttachmentContentSignatureTransform extends TransformIdentity {
             canon.transform(inputStream);
 
         } else if (mimeType != null && mimeType.matches("(?i)(text/).*")) {
-            CRLFOutputStream crlfOutputStream = new CRLFOutputStream(getOutputStream());
+            CRLFOutputStream crlfOutputStream = new CRLFOutputStream(getOutputStream());    //NOPMD
             try {
                 setOutputStream(crlfOutputStream);
             } catch (XMLSecurityException e) {
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/securityEvent/KerberosTokenSecurityEvent.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/securityEvent/KerberosTokenSecurityEvent.java
index 7327ecec6..7fb1bf3a0 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/securityEvent/KerberosTokenSecurityEvent.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/securityEvent/KerberosTokenSecurityEvent.java
@@ -39,22 +39,16 @@ public class KerberosTokenSecurityEvent extends IssuedTokenSecurityEvent<Kerbero
 
     public boolean isKerberosV5ApReqToken11() {
         String type = getSecurityToken().getKerberosTokenValueType();
-        if (WSSConstants.NS_KERBEROS5_AP_REQ.equals(type)
+        return WSSConstants.NS_KERBEROS5_AP_REQ.equals(type)
                 || WSSConstants.NS_KERBEROS5_AP_REQ1510.equals(type)
-                || WSSConstants.NS_KERBEROS5_AP_REQ4120.equals(type)) {
-            return true;
-        }
-        return false;
+                || WSSConstants.NS_KERBEROS5_AP_REQ4120.equals(type);
     }
 
     public boolean isGssKerberosV5ApReqToken11() {
         String type = getSecurityToken().getKerberosTokenValueType();
-        if (WSSConstants.NS_GSS_KERBEROS5_AP_REQ.equals(type)
+        return WSSConstants.NS_GSS_KERBEROS5_AP_REQ.equals(type)
                 || WSSConstants.NS_GSS_KERBEROS5_AP_REQ1510.equals(type)
-                || WSSConstants.NS_GSS_KERBEROS5_AP_REQ4120.equals(type)) {
-            return true;
-        }
-        return false;
+                || WSSConstants.NS_GSS_KERBEROS5_AP_REQ4120.equals(type);
     }
 
     public String getKerberosTokenValueType() {
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/securityEvent/WSSecurityEventConstants.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/securityEvent/WSSecurityEventConstants.java
index 92c511649..21ad83dc3 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/securityEvent/WSSecurityEventConstants.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/securityEvent/WSSecurityEventConstants.java
@@ -20,7 +20,7 @@ package org.apache.wss4j.stax.securityEvent;
 
 import org.apache.xml.security.stax.securityEvent.SecurityEventConstants;
 
-public abstract class WSSecurityEventConstants extends SecurityEventConstants {
+public abstract class WSSecurityEventConstants extends SecurityEventConstants { //NOPMD
 
     public static final Event NO_SECURITY = new Event("NoSecurity");
     public static final Event OPERATION = new Event("Operation");
diff --git a/ws-security-stax/src/main/java/org/apache/wss4j/stax/setup/ConfigurationConverter.java b/ws-security-stax/src/main/java/org/apache/wss4j/stax/setup/ConfigurationConverter.java
index c223d01f6..6e7bbe50a 100644
--- a/ws-security-stax/src/main/java/org/apache/wss4j/stax/setup/ConfigurationConverter.java
+++ b/ws-security-stax/src/main/java/org/apache/wss4j/stax/setup/ConfigurationConverter.java
@@ -576,19 +576,19 @@ public final class ConfigurationConverter {
             }
         }
 
-        ReplayCache nonceCache =
+        ReplayCache nonceCache =    //NOPMD
             (ReplayCache)config.get(ConfigurationConstants.NONCE_CACHE_INSTANCE);
         if (nonceCache != null) {
             properties.setNonceReplayCache(nonceCache);
         }
 
-        ReplayCache timestampCache =
+        ReplayCache timestampCache = //NOPMD
             (ReplayCache)config.get(ConfigurationConstants.TIMESTAMP_CACHE_INSTANCE);
         if (timestampCache != null) {
             properties.setTimestampReplayCache(timestampCache);
         }
 
-        ReplayCache samlOneTimeUseCache =
+        ReplayCache samlOneTimeUseCache = //NOPMD
             (ReplayCache)config.get(ConfigurationConstants.SAML_ONE_TIME_USE_CACHE_INSTANCE);
         if (samlOneTimeUseCache != null) {
             properties.setSamlOneTimeUseReplayCache(samlOneTimeUseCache);