Copilot commented on code in PR #876: URL: https://github.com/apache/ranger/pull/876#discussion_r2955382959
########## kms/src/main/java/org/apache/ranger/plugin/util/AutoClosableLock.java: ########## @@ -0,0 +1,120 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 + * + * http://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. + */ + +package org.apache.ranger.plugin.util; + +import java.util.concurrent.TimeUnit; +import java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReadWriteLock; + +public class AutoClosableLock implements AutoCloseable { + private final Lock lock; + + public AutoClosableLock(Lock lock) { + this.lock = lock; + + this.lock.lock(); + } + + @Override + public void close() { + lock.unlock(); + } + + public static class AutoClosableTryLock implements AutoCloseable { + private final Lock lock; + private final boolean isLocked; + + public AutoClosableTryLock(Lock lock, long timeout, TimeUnit timeUnit) { + this.lock = lock; + + boolean isLocked = false; + + try { + isLocked = this.lock.tryLock(timeout, timeUnit); + } catch (InterruptedException excp) { + // ignored Review Comment: `AutoClosableTryLock` swallows `InterruptedException` from `tryLock(...)`. This clears the thread interrupt flag and can cause higher-level interrupt handling to misbehave; re-interrupt the thread (and consider documenting/returning `isLocked=false` explicitly) when interruption occurs. ########## kms/src/main/java/org/apache/ranger/plugin/util/XMLUtils.java: ########## @@ -0,0 +1,143 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 + * + * http://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. + */ + +package org.apache.ranger.plugin.util; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; + +import javax.xml.XMLConstants; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.InputStream; +import java.util.Map; + +public class XMLUtils { + private static final Logger LOG = LoggerFactory.getLogger(XMLUtils.class); + + private static final String XMLCONFIG_PROPERTY_TAGNAME = "property"; + private static final String XMLCONFIG_NAME_TAGNAME = "name"; + private static final String XMLCONFIG_VALUE_TAGNAME = "value"; + + private XMLUtils() { + // to block instantiation + } + + public static void loadConfig(String configFileName, Map<Object, Object> properties) { + try (InputStream input = getFileInputStream(configFileName)) { + loadConfig(input, properties); + } catch (Exception e) { + LOG.error("Error loading : {}", configFileName, e); + } + } + + public static void loadConfig(InputStream input, Map<Object, Object> properties) { + try { + DocumentBuilderFactory xmlDocumentBuilderFactory = DocumentBuilderFactory.newInstance(); + + xmlDocumentBuilderFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true); + xmlDocumentBuilderFactory.setFeature("http://xml.org/sax/features/external-general-entities";, false); + xmlDocumentBuilderFactory.setFeature("http://xml.org/sax/features/external-parameter-entities";, false); + xmlDocumentBuilderFactory.setIgnoringComments(true); + xmlDocumentBuilderFactory.setNamespaceAware(true); + + DocumentBuilder xmlDocumentBuilder = xmlDocumentBuilderFactory.newDocumentBuilder(); + Document xmlDocument = xmlDocumentBuilder.parse(input); + + xmlDocument.getDocumentElement().normalize(); + + NodeList nList = xmlDocument.getElementsByTagName(XMLCONFIG_PROPERTY_TAGNAME); + + for (int temp = 0; temp < nList.getLength(); temp++) { + Node nNode = nList.item(temp); + + if (nNode.getNodeType() == Node.ELEMENT_NODE) { + Element eElement = (Element) nNode; + + String propertyName = ""; + String propertyValue = ""; + + if (eElement.getElementsByTagName(XMLCONFIG_NAME_TAGNAME).item(0) != null) { + propertyName = eElement.getElementsByTagName(XMLCONFIG_NAME_TAGNAME).item(0).getTextContent().trim(); + } + + if (eElement.getElementsByTagName(XMLCONFIG_VALUE_TAGNAME).item(0) != null) { + propertyValue = eElement.getElementsByTagName(XMLCONFIG_VALUE_TAGNAME).item(0).getTextContent().trim(); + } + + if (properties.get(propertyName) != null) { + properties.remove(propertyName); + } + + properties.put(propertyName, propertyValue); + } + } + } catch (Exception e) { + LOG.error("Error loading : ", e); + } + } + + private static InputStream getFileInputStream(String path) throws FileNotFoundException { + InputStream ret; + + // Guard against path traversal attacks + String sanitizedPath = new File(path).getName(); + + if (sanitizedPath.isEmpty()) { + return null; Review Comment: `getFileInputStream()` returns `null` when `sanitizedPath` is empty, but callers use it in a try-with-resources (`loadConfig(String, ...)`), which will throw a `NullPointerException` before reaching the intended `FileNotFoundException` path. Prefer throwing an explicit `FileNotFoundException`/`IllegalArgumentException` instead of returning `null` so failure is deterministic and easier to diagnose. ########## embeddedwebserver/src/main/java/org/apache/ranger/plugin/util/XMLUtils.java: ########## @@ -0,0 +1,143 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 + * + * http://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. + */ + +package org.apache.ranger.plugin.util; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; + +import javax.xml.XMLConstants; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.InputStream; +import java.util.Map; + +public class XMLUtils { + private static final Logger LOG = LoggerFactory.getLogger(XMLUtils.class); + + private static final String XMLCONFIG_PROPERTY_TAGNAME = "property"; + private static final String XMLCONFIG_NAME_TAGNAME = "name"; + private static final String XMLCONFIG_VALUE_TAGNAME = "value"; + + private XMLUtils() { + // to block instantiation + } + + public static void loadConfig(String configFileName, Map<Object, Object> properties) { + try (InputStream input = getFileInputStream(configFileName)) { + loadConfig(input, properties); + } catch (Exception e) { + LOG.error("Error loading : {}", configFileName, e); + } + } + + public static void loadConfig(InputStream input, Map<Object, Object> properties) { + try { + DocumentBuilderFactory xmlDocumentBuilderFactory = DocumentBuilderFactory.newInstance(); + + xmlDocumentBuilderFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true); + xmlDocumentBuilderFactory.setFeature("http://xml.org/sax/features/external-general-entities";, false); + xmlDocumentBuilderFactory.setFeature("http://xml.org/sax/features/external-parameter-entities";, false); + xmlDocumentBuilderFactory.setIgnoringComments(true); + xmlDocumentBuilderFactory.setNamespaceAware(true); + + DocumentBuilder xmlDocumentBuilder = xmlDocumentBuilderFactory.newDocumentBuilder(); + Document xmlDocument = xmlDocumentBuilder.parse(input); + + xmlDocument.getDocumentElement().normalize(); + + NodeList nList = xmlDocument.getElementsByTagName(XMLCONFIG_PROPERTY_TAGNAME); + + for (int temp = 0; temp < nList.getLength(); temp++) { + Node nNode = nList.item(temp); + + if (nNode.getNodeType() == Node.ELEMENT_NODE) { + Element eElement = (Element) nNode; + + String propertyName = ""; + String propertyValue = ""; + + if (eElement.getElementsByTagName(XMLCONFIG_NAME_TAGNAME).item(0) != null) { + propertyName = eElement.getElementsByTagName(XMLCONFIG_NAME_TAGNAME).item(0).getTextContent().trim(); + } + + if (eElement.getElementsByTagName(XMLCONFIG_VALUE_TAGNAME).item(0) != null) { + propertyValue = eElement.getElementsByTagName(XMLCONFIG_VALUE_TAGNAME).item(0).getTextContent().trim(); + } + + if (properties.get(propertyName) != null) { + properties.remove(propertyName); + } + + properties.put(propertyName, propertyValue); + } + } + } catch (Exception e) { + LOG.error("Error loading : ", e); + } + } + + private static InputStream getFileInputStream(String path) throws FileNotFoundException { + InputStream ret; + + // Guard against path traversal attacks + String sanitizedPath = new File(path).getName(); + + if (sanitizedPath.isEmpty()) { + return null; Review Comment: `getFileInputStream()` returns `null` when `sanitizedPath` is empty, but callers use it in a try-with-resources (`loadConfig(String, ...)`), which will throw a `NullPointerException` before reaching the intended `FileNotFoundException` path. Prefer throwing an explicit `FileNotFoundException`/`IllegalArgumentException` instead of returning `null` so failure is deterministic and easier to diagnose. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
