From 4bf572fbf54b4a400b09be7ca63a90e376e55d77 Mon Sep 17 00:00:00 2001
From: Virtually Nick <vnick@apache.org>
Date: Tue, 26 Sep 2023 17:15:38 -0400
Subject: [PATCH] GUACAMOLE-1855: Implement property for tracking list of IP
 Addresses.

---
 guacamole-ext/pom.xml                         |  7 ++
 .../guacamole/properties/IPListProperty.java  | 81 +++++++++++++++++++
 2 files changed, 88 insertions(+)
 create mode 100644 guacamole-ext/src/main/java/org/apache/guacamole/properties/IPListProperty.java

diff --git a/guacamole-ext/pom.xml b/guacamole-ext/pom.xml
index 397e53ec0a..8967daa585 100644
--- a/guacamole-ext/pom.xml
+++ b/guacamole-ext/pom.xml
@@ -110,6 +110,13 @@
             <artifactId>jackson-databind</artifactId>
         </dependency>
 
+        <!-- Library for unified IPv4/6 parsing and validation -->
+        <dependency>
+            <groupId>com.github.seancfoley</groupId>
+            <artifactId>ipaddress</artifactId>
+            <version>5.4.0</version>
+        </dependency>
+
     </dependencies>
 
 </project>
diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/properties/IPListProperty.java b/guacamole-ext/src/main/java/org/apache/guacamole/properties/IPListProperty.java
new file mode 100644
index 0000000000..f51f9942e2
--- /dev/null
+++ b/guacamole-ext/src/main/java/org/apache/guacamole/properties/IPListProperty.java
@@ -0,0 +1,81 @@
+/*
+ * 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.guacamole.properties;
+
+import inet.ipaddr.IPAddress;
+import inet.ipaddr.IPAddressString;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.regex.Pattern;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleServerException;
+
+/**
+ * A GuacamoleProperty implementation that parses a String for a comma-separated
+ * list of IP addresses and/or IP subnets, both IPv4 and IPv6, and returns the
+ * list of those valid IP addresses/subnets.
+ */
+public abstract class IPListProperty implements GuacamoleProperty<List <IPAddress>> {
+    
+    /**
+     * A pattern which matches against the delimiters between values. This is
+     * currently simply a comma and any following whitespace. Parts of the
+     * input string which match this pattern will not be included in the parsed
+     * result.
+     */
+    private static final Pattern DELIMITER_PATTERN = Pattern.compile(",\\s*");
+    
+    @Override
+    public List<IPAddress> parseValue(String values) throws GuacamoleException {
+        
+        // Null for null
+        if (values == null)
+            return null;
+        
+        // Not null, just empty
+        if (values.isEmpty())
+            return Collections.emptyList();
+        
+        // Split the string into an array
+        List<String> addrStrings = Arrays.asList(DELIMITER_PATTERN.split(values));
+        List<IPAddress> ipAddresses = new ArrayList<>();
+        
+        // Loop through each string
+        for (String addrString : addrStrings) {
+            
+            // Convert the string to an IPAddressString for validation
+            IPAddressString ipString = new IPAddressString(addrString);
+            
+            // If this isn't a valid address, subnet, etc., throw an exception
+            if (!ipString.isIPAddress())
+                throw new GuacamoleServerException("Invalid IP address specified: " + addrString);
+            
+            // Add the address to the list.
+            ipAddresses.add(ipString.getAddress());
+        }
+        
+        // Return our list of valid IP addresses and/or subnets
+        return ipAddresses;
+        
+    }
+    
+}