Cleanup and add support classes

Author: cstamas

src/main/java/org/codehaus/plexus/components/secdispatcher/SecDispatcher.java

@@ -23,7 +23,7 @@
 public interface SecDispatcher {
     String DEFAULT_CONFIGURATION = "~/.m2/settings-security.xml";
     String SYSTEM_PROPERTY_CONFIGURATION_LOCATION = "settings.security";
-    String TYPE_ATTR = "type";
+    String DISPATCHER_NAME_ATTR = "dispatcher.name";
 
     /**
      * encrypt given plaintext string

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/DefaultSecDispatcher.java

@@ -17,8 +17,6 @@
 import javax.inject.Named;
 import javax.inject.Singleton;
 
-import java.net.URI;
-import java.net.URISyntaxException;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.StringTokenizer;
@@ -67,11 +65,11 @@ public String encrypt(String str, Map<String, String> attr) throws SecDispatcher
         try {
             String res;
             SettingsSecurity sec = getSec();
-            if (attr == null || attr.get(TYPE_ATTR) == null) {
+            if (attr == null || attr.get(DISPATCHER_NAME_ATTR) == null) {
                 String master = getMaster(sec);
                 res = cipher.encrypt(str, master);
             } else {
-                String type = attr.get(TYPE_ATTR);
+                String type = attr.get(DISPATCHER_NAME_ATTR);
                 Map<String, String> conf = SecUtil.getConfig(sec, type);
                 Dispatcher dispatcher = dispatchers.get(type);
                 if (dispatcher == null) throw new SecDispatcherException("no dispatcher for type " + type);
@@ -95,11 +93,11 @@ public String decrypt(String str) throws SecDispatcherException {
             String bare = cipher.unDecorate(str);
             Map<String, String> attr = stripAttributes(bare);
             SettingsSecurity sec = getSec();
-            if (attr == null || attr.get(TYPE_ATTR) == null) {
+            if (attr == null || attr.get(DISPATCHER_NAME_ATTR) == null) {
                 String master = getMaster(sec);
                 return cipher.decrypt(bare, master);
             } else {
-                String type = attr.get(TYPE_ATTR);
+                String type = attr.get(DISPATCHER_NAME_ATTR);
                 Map<String, String> conf = SecUtil.getConfig(sec, type);
                 Dispatcher dispatcher = dispatchers.get(type);
                 if (dispatcher == null) throw new SecDispatcherException("no dispatcher for type " + type);
@@ -178,14 +176,9 @@ private SettingsSecurity getSec() throws SecDispatcherException {
 
     private String getMaster(SettingsSecurity sec) throws SecDispatcherException {
         String masterSource = requireNonNull(sec.getMasterSource(), "masterSource is null");
-        try {
-            URI masterSourceUri = new URI(masterSource);
-            for (MasterPasswordSource masterPasswordSource : masterPasswordSources.values()) {
-                String master = masterPasswordSource.handle(masterSourceUri);
-                if (master != null) return master;
-            }
-        } catch (URISyntaxException e) {
-            throw new SecDispatcherException("Invalid master source URI", e);
+        for (MasterPasswordSource masterPasswordSource : masterPasswordSources.values()) {
+            String master = masterPasswordSource.handle(masterSource);
+            if (master != null) return master;
         }
         throw new SecDispatcherException("master password could not be fetched");
     }

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/MasterPasswordSource.java

@@ -13,8 +13,6 @@
 
 package org.codehaus.plexus.components.secdispatcher.internal;
 
-import java.net.URI;
-
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
 
 /**
@@ -29,5 +27,5 @@ public interface MasterPasswordSource {
      *     <li>happy path: return the master password.</li>
      * </ul>
      */
-    String handle(URI uri) throws SecDispatcherException;
+    String handle(String uri) throws SecDispatcherException;
 }

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/EnvMasterPasswordSource.java

@@ -21,27 +21,25 @@
 import javax.inject.Named;
 import javax.inject.Singleton;
 
-import java.net.URI;
-
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
-import org.codehaus.plexus.components.secdispatcher.internal.MasterPasswordSource;
 
 /**
  * Password source that uses env.
  */
 @Singleton
 @Named(EnvMasterPasswordSource.NAME)
-public final class EnvMasterPasswordSource implements MasterPasswordSource {
+public final class EnvMasterPasswordSource extends PrefixMasterPasswordSourceSupport {
     public static final String NAME = "env";
 
+    public EnvMasterPasswordSource() {
+        super(NAME + ":");
+    }
+
     @Override
-    public String handle(URI uri) throws SecDispatcherException {
-        if (!NAME.equals(uri.getScheme())) {
-            return null;
-        }
-        String value = System.getenv(uri.getPath().substring(1));
+    protected String doHandle(String transformed) throws SecDispatcherException {
+        String value = System.getenv(transformed);
         if (value == null) {
-            throw new SecDispatcherException("Environment variable '" + uri.getPath() + "' not found");
+            throw new SecDispatcherException("Environment variable '" + transformed + "' not found");
         }
         return value;
     }

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/GpgAgentMasterPasswordSource.java

@@ -26,7 +26,6 @@
 import java.io.InputStreamReader;
 import java.io.OutputStream;
 import java.net.StandardProtocolFamily;
-import java.net.URI;
 import java.net.UnixDomainSocketAddress;
 import java.nio.channels.Channels;
 import java.nio.channels.SocketChannel;
@@ -35,23 +34,28 @@
 import java.util.HexFormat;
 
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
-import org.codehaus.plexus.components.secdispatcher.internal.MasterPasswordSource;
 
 /**
  * Password source that uses GnuPG Agent.
  */
 @Singleton
 @Named(GpgAgentMasterPasswordSource.NAME)
-public final class GpgAgentMasterPasswordSource implements MasterPasswordSource {
+public final class GpgAgentMasterPasswordSource extends PrefixMasterPasswordSourceSupport {
     public static final String NAME = "gpg-agent";
 
+    public GpgAgentMasterPasswordSource() {
+        super(NAME + ":");
+    }
+
     @Override
-    public String handle(URI uri) throws SecDispatcherException {
-        if (!NAME.equals(uri.getScheme())) {
-            return null;
+    protected String doHandle(String transformed) throws SecDispatcherException {
+        String extra = "";
+        if (transformed.contains("?")) {
+            extra = transformed.substring(transformed.indexOf("?"));
+            transformed = transformed.substring(0, transformed.indexOf("?"));
         }
-        String socketLocation = uri.getPath();
-        boolean interactive = uri.getQuery() == null || !uri.getQuery().contains("non-interactive");
+        String socketLocation = transformed;
+        boolean interactive = !extra.contains("non-interactive");
         try {
             Path socketLocationPath = Paths.get(socketLocation);
             if (!socketLocationPath.isAbsolute()) {

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/MasterPasswordSourceSupport.java

@@ -0,0 +1,50 @@
+/*
+ * 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.codehaus.plexus.components.secdispatcher.internal.sources;
+
+import java.util.function.Function;
+import java.util.function.Predicate;
+
+import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
+import org.codehaus.plexus.components.secdispatcher.internal.MasterPasswordSource;
+
+import static java.util.Objects.requireNonNull;
+
+/**
+ * Master password source support class.
+ */
+public abstract class MasterPasswordSourceSupport implements MasterPasswordSource {
+    private final Predicate<String> matcher;
+    private final Function<String, String> transformer;
+
+    public MasterPasswordSourceSupport(Predicate<String> matcher, Function<String, String> transformer) {
+        this.matcher = requireNonNull(matcher);
+        this.transformer = requireNonNull(transformer);
+    }
+
+    @Override
+    public String handle(String masterSource) throws SecDispatcherException {
+        if (matcher.test(masterSource)) {
+            return doHandle(transformer.apply(masterSource));
+        }
+        return null;
+    }
+
+    protected abstract String doHandle(String transformed) throws SecDispatcherException;
+}

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/MatchingMasterPasswordSource.java

@@ -13,7 +13,6 @@
 
 package org.codehaus.plexus.components.secdispatcher.internal.sources;
 
-import java.net.URI;
 import java.util.function.Predicate;
 
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
@@ -22,18 +21,18 @@
 import static java.util.Objects.requireNonNull;
 
 public class MatchingMasterPasswordSource implements MasterPasswordSource {
-    private final Predicate<URI> matcher;
+    private final Predicate<String> matcher;
     private final MasterPasswordSource masterPasswordSource;
 
-    public MatchingMasterPasswordSource(Predicate<URI> matcher, MasterPasswordSource masterPasswordSource) {
+    public MatchingMasterPasswordSource(Predicate<String> matcher, MasterPasswordSource masterPasswordSource) {
         this.matcher = requireNonNull(matcher);
         this.masterPasswordSource = requireNonNull(masterPasswordSource);
     }
 
     @Override
-    public String handle(URI uri) throws SecDispatcherException {
-        if (matcher.test(uri)) {
-            return masterPasswordSource.handle(uri);
+    public String handle(String masterSource) throws SecDispatcherException {
+        if (matcher.test(masterSource)) {
+            return masterPasswordSource.handle(masterSource);
         }
         return null;
     }

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/MemoizingMasterPasswordSource.java

@@ -13,7 +13,6 @@
 
 package org.codehaus.plexus.components.secdispatcher.internal.sources;
 
-import java.net.URI;
 import java.util.concurrent.ConcurrentHashMap;
 
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
@@ -23,15 +22,15 @@
 
 public class MemoizingMasterPasswordSource implements MasterPasswordSource {
     private final MasterPasswordSource masterPasswordSource;
-    private final ConcurrentHashMap<URI, String> memo;
+    private final ConcurrentHashMap<String, String> memo;
 
     public MemoizingMasterPasswordSource(MasterPasswordSource masterPasswordSource) {
         this.masterPasswordSource = requireNonNull(masterPasswordSource);
         this.memo = new ConcurrentHashMap<>();
     }
 
     @Override
-    public String handle(URI uri) throws SecDispatcherException {
-        return memo.computeIfAbsent(uri, k -> masterPasswordSource.handle(uri));
+    public String handle(String masterSource) throws SecDispatcherException {
+        return memo.computeIfAbsent(masterSource, k -> masterPasswordSource.handle(masterSource));
     }
 }

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/PrefixMasterPasswordSourceSupport.java

@@ -0,0 +1,43 @@
+/*
+ * 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.codehaus.plexus.components.secdispatcher.internal.sources;
+
+import java.util.function.Function;
+import java.util.function.Predicate;
+
+import static java.util.Objects.requireNonNull;
+
+/**
+ * Master password source support class for simple "prefix" use case.
+ */
+public abstract class PrefixMasterPasswordSourceSupport extends MasterPasswordSourceSupport {
+    public PrefixMasterPasswordSourceSupport(String prefix) {
+        super(prefixMatcher(prefix), prefixRemover(prefix));
+    }
+
+    private static Predicate<String> prefixMatcher(String prefix) {
+        requireNonNull(prefix, "prefix cannot be null");
+        return s -> s != null && s.startsWith(prefix);
+    }
+
+    private static Function<String, String> prefixRemover(String prefix) {
+        requireNonNull(prefix, "prefix cannot be null");
+        return s -> s.substring(prefix.length());
+    }
+}

src/main/java/org/codehaus/plexus/components/secdispatcher/internal/sources/StaticMasterPasswordSource.java

@@ -13,8 +13,6 @@
 
 package org.codehaus.plexus.components.secdispatcher.internal.sources;
 
-import java.net.URI;
-
 import org.codehaus.plexus.components.secdispatcher.SecDispatcherException;
 import org.codehaus.plexus.components.secdispatcher.internal.MasterPasswordSource;
 
@@ -28,7 +26,7 @@ public StaticMasterPasswordSource(String masterPassword) {
     }
 
     @Override
-    public String handle(URI uri) throws SecDispatcherException {
+    public String handle(String masterSource) throws SecDispatcherException {
         return masterPassword;
     }
 }