convert LDAP authorization plugin configuration to YAML

Author: vladak

plugins/pom.xml

@@ -18,7 +18,7 @@ information: Portions Copyright [yyyy] [name of copyright owner]
 
 CDDL HEADER END
 
-Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
 Portions Copyright (c) 2020, Chris Fraire <cfraire@me.com>.
 
 -->
@@ -75,6 +75,11 @@ Portions Copyright (c) 2020, Chris Fraire <cfraire@me.com>.
             <artifactId>jersey-media-json-jackson</artifactId>
             <version>${jersey.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.dataformat</groupId>
+            <artifactId>jackson-dataformat-yaml</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.glassfish.jersey.inject</groupId>
             <artifactId>jersey-hk2</artifactId>

plugins/src/main/java/opengrok/auth/plugin/configuration/Configuration.java

@@ -18,15 +18,10 @@
  */
 
 /*
- * Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin.configuration;
 
-import java.beans.XMLDecoder;
-import java.beans.XMLEncoder;
-import java.io.BufferedInputStream;
-import java.io.BufferedOutputStream;
-import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.FileInputStream;
@@ -35,24 +30,46 @@
 import java.io.OutputStream;
 import java.io.Serializable;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonAutoDetect;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
 import opengrok.auth.plugin.ldap.LdapServer;
 import opengrok.auth.plugin.util.WebHooks;
 
 /**
  * Encapsulates configuration for LDAP plugins.
  */
+@JsonAutoDetect(
+        fieldVisibility = JsonAutoDetect.Visibility.NONE,
+        setterVisibility = JsonAutoDetect.Visibility.NONE,
+        getterVisibility = JsonAutoDetect.Visibility.NONE,
+        isGetterVisibility = JsonAutoDetect.Visibility.NONE,
+        creatorVisibility = JsonAutoDetect.Visibility.NONE
+)
 public class Configuration implements Serializable {
 
     private static final long serialVersionUID = -1;
 
+    @JsonProperty
     private List<LdapServer> servers = new ArrayList<>();
+    @JsonProperty
     private int interval;
+    @JsonProperty
     private String searchBase;
+    @JsonProperty
     private WebHooks webHooks;
+    @JsonProperty
     private int searchTimeout;
+    @JsonProperty
     private int connectTimeout;
+    @JsonProperty
     private int readTimeout;
+    @JsonProperty
     private int countLimit;
 
     public void setServers(List<LdapServer> servers) {
@@ -119,20 +136,19 @@ public void setSearchBase(String base) {
         this.searchBase = base;
     }
 
-    public String getXMLRepresentationAsString() {
+    String getObjectRepresentationAsString() throws IOException {
         ByteArrayOutputStream bos = new ByteArrayOutputStream();
         this.encodeObject(bos);
         return bos.toString();
     }
 
-    private void encodeObject(OutputStream out) {
-        try (XMLEncoder e = new XMLEncoder(new BufferedOutputStream(out))) {
-            e.writeObject(this);
-        }
+    void encodeObject(OutputStream out) throws IOException {
+        var mapper = new ObjectMapper(new YAMLFactory().disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER));
+        mapper.writeValue(out, this);
     }
 
     /**
-     * Read a configuration from a file in XML format.
+     * Read a configuration from a file.
      *
      * @param file input file
      * @return the new configuration object
@@ -144,32 +160,8 @@ public static Configuration read(File file) throws IOException {
         }
     }
 
-    /**
-     * Read a configuration from a string in xml format.
-     *
-     * @param xmlconfig input string
-     * @return the new configuration object
-     * @throws IOException if any error occurs
-     */
-    public static Configuration makeXMLStringAsConfiguration(String xmlconfig) throws IOException {
-        final Configuration ret;
-        final ByteArrayInputStream in = new ByteArrayInputStream(xmlconfig.getBytes());
-        ret = decodeObject(in);
-        return ret;
-    }
-
-    private static Configuration decodeObject(InputStream in) throws IOException {
-        final Object ret;
-
-        try (XMLDecoder d = new XMLDecoder(new BufferedInputStream(in), null, null,
-                new PluginConfigurationClassLoader())) {
-            ret = d.readObject();
-        }
-
-        if (!(ret instanceof Configuration)) {
-            throw new IOException("Not a valid configuration file");
-        }
-
-        return (Configuration) ret;
+    static Configuration decodeObject(InputStream in) throws IOException {
+        var mapper = new ObjectMapper(new YAMLFactory().disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER));
+        return mapper.readValue(in, Configuration.class);
     }
 }

plugins/src/main/java/opengrok/auth/plugin/configuration/PluginConfigurationClassLoader.java

@@ -18,10 +18,15 @@
  */
 
 /*
- * Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin.ldap;
 
+import com.fasterxml.jackson.annotation.JsonAutoDetect;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import org.jetbrains.annotations.Nullable;
+
 import java.io.IOException;
 import java.io.Serializable;
 import java.net.InetAddress;
@@ -44,6 +49,13 @@
 import javax.naming.ldap.InitialLdapContext;
 import javax.naming.ldap.LdapContext;
 
+@JsonAutoDetect(
+        fieldVisibility = JsonAutoDetect.Visibility.NONE,
+        setterVisibility = JsonAutoDetect.Visibility.NONE,
+        getterVisibility = JsonAutoDetect.Visibility.NONE,
+        isGetterVisibility = JsonAutoDetect.Visibility.NONE,
+        creatorVisibility = JsonAutoDetect.Visibility.NONE
+)
 public class LdapServer implements Serializable {
 
     private static final long serialVersionUID = -1;
@@ -55,17 +67,22 @@ public class LdapServer implements Serializable {
     private static final String LDAP_CONTEXT_FACTORY = "com.sun.jndi.ldap.LdapCtxFactory";
 
     // default connectTimeout value in milliseconds
-    private static final int LDAP_CONNECT_TIMEOUT = 5000;
+    private static final int DEFAULT_LDAP_CONNECT_TIMEOUT = 5000;
     // default readTimeout value in milliseconds
-    private static final int LDAP_READ_TIMEOUT = 3000;
+    private static final int DEFAULT_LDAP_READ_TIMEOUT = 3000;
 
+    @JsonProperty
     private String url;
+    @JsonProperty
     private String username;
+    @JsonProperty
     private String password;
+    @JsonProperty
     private int connectTimeout;
+    @JsonProperty
     private int readTimeout;
-    private int interval = 10 * 1000;
 
+    private int interval = 10 * 1000;
     private final Map<String, String> env;
     private transient LdapContext ctx;
     private long errorTimestamp = 0;
@@ -166,6 +183,7 @@ public int getPort() throws URISyntaxException {
         }
     }
 
+    @JsonIgnore
     private boolean isReachable(InetAddress addr, int port, int timeOutMillis) {
         try (Socket soc = new Socket()) {
             soc.connect(new InetSocketAddress(addr, port), timeOutMillis);
@@ -190,6 +208,7 @@ public InetAddress[] getAddresses(String hostname) throws UnknownHostException {
      * Go through all IP addresses and find out if they are reachable.
      * @return true if all IP addresses are reachable, false otherwise
      */
+    @JsonIgnore
     public boolean isReachable() {
         try {
             InetAddress[] addresses = getAddresses(urlToHostname(getUrl()));
@@ -224,6 +243,7 @@ public boolean isReachable() {
      *
      * @return true if it is working
      */
+    @JsonIgnore
     public synchronized boolean isWorking() {
         if (ctx == null) {
             if (!isReachable()) {
@@ -240,6 +260,7 @@ public synchronized boolean isWorking() {
      *
      * @return the new connection or null
      */
+    @Nullable
     private synchronized LdapContext connect() {
         LOGGER.log(Level.INFO, "Connecting to LDAP server {0} ", this);
 
@@ -354,8 +375,8 @@ private static Map<String, String> prepareEnv() {
         var e = new HashMap<String, String>();
 
         e.put(Context.INITIAL_CONTEXT_FACTORY, LDAP_CONTEXT_FACTORY);
-        e.put(LDAP_CONNECT_TIMEOUT_PARAMETER, Integer.toString(LDAP_CONNECT_TIMEOUT));
-        e.put(LDAP_READ_TIMEOUT_PARAMETER, Integer.toString(LDAP_READ_TIMEOUT));
+        e.put(LDAP_CONNECT_TIMEOUT_PARAMETER, Integer.toString(DEFAULT_LDAP_CONNECT_TIMEOUT));
+        e.put(LDAP_READ_TIMEOUT_PARAMETER, Integer.toString(DEFAULT_LDAP_READ_TIMEOUT));
 
         return e;
     }