jnr-unixsocket: Added javadoc; Fixed: SASL mode was never set to SERVER even transport was for a listening socket

Author: hypfvieh

dbus-java/src/main/java/org/freedesktop/dbus/connections/transports/AbstractTransport.java

@@ -15,6 +15,12 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Base class for all transport types.
+ * 
+ * @author hypfvieh
+ * @since v3.2.0 - 2019-02-08
+ */
 public abstract class AbstractTransport implements Closeable {
 
     private final Logger     logger;
@@ -30,11 +36,23 @@ public abstract class AbstractTransport implements Closeable {
     AbstractTransport(BusAddress _address, int _timeout) {
         address = _address;
         timeout = _timeout;
-        saslMode = SASL.SaslMode.CLIENT;
+        
+        if (_address.isListeningSocket()) {
+            saslMode = SASL.SaslMode.SERVER;    
+        } else {
+            saslMode = SASL.SaslMode.CLIENT;
+        }
+        
         saslAuthMode = SASL.AUTH_NONE;
         logger = LoggerFactory.getLogger(getClass());
     }
 
+    /**
+     * Write a message to the underlying socket.
+     * 
+     * @param _msg message to write
+     * @throws IOException on write error or if output was already closed or null
+     */
     public void writeMessage(Message _msg) throws IOException {
         if (outputWriter != null && !outputWriter.isClosed()) {
             outputWriter.writeMessage(_msg);
@@ -43,19 +61,35 @@ public void writeMessage(Message _msg) throws IOException {
         }
     }
 
+    /**
+     * Read a message from the underlying socket.
+     * 
+     * @return read message, maybe null
+     * @throws IOException when input already close or null
+     * @throws DBusException when message could not be converted to a DBus message
+     */
     public Message readMessage() throws IOException, DBusException {
         if (inputReader != null && !inputReader.isClosed()) {
             return inputReader.readMessage();
         }
         throw new IOException("InputReader already closed or null");
     }
 
-    void start() throws IOException {
-        connect();
-    }
-    
+    /**
+     * Abstract method implemented by concrete sub classes to establish a connection 
+     * using whatever transport type (e.g. TCP/Unix socket).
+     * @throws IOException when connection fails
+     */
     abstract void connect() throws IOException;
-    
+     
+    /**
+     * Helper method to authenticate to DBus using SASL.
+     * 
+     * @param _out output stream
+     * @param _in input stream
+     * @param _sock socket
+     * @throws IOException on any error
+     */
     protected void authenticate(OutputStream _out, InputStream _in, Socket _sock) throws IOException {
         if (!(new SASL()).auth(saslMode, saslAuthMode, address.getGuid(), _out, _in, _sock)) {
             _out.close();

dbus-java/src/main/java/org/freedesktop/dbus/connections/transports/TcpTransport.java

@@ -0,0 +1,56 @@
+package org.freedesktop.dbus.connections.transports;
+
+import java.io.IOException;
+import java.net.InetSocketAddress;
+import java.net.ServerSocket;
+import java.net.Socket;
+
+import org.freedesktop.dbus.connections.BusAddress;
+import org.freedesktop.dbus.connections.SASL;
+
+/**
+ * Transport type representing a transport connection to TCP.
+ * 
+ * @author hypfvieh
+ * @since v3.2.0 - 2019-02-08
+ */
+public class TcpTransport extends AbstractTransport {
+
+    private Socket socket;
+    
+    TcpTransport(BusAddress _address, int _timeout) {
+        super(_address, _timeout);
+        setSaslAuthMode(SASL.AUTH_SHA);
+    }
+
+    /**
+     * Connect to DBus using TCP.
+     * @throws IOException on error
+     */
+    void connect() throws IOException {
+        
+        if (getAddress().isListeningSocket()) {
+            try (ServerSocket ss = new ServerSocket()) {
+                ss.bind(new InetSocketAddress(getAddress().getHost(), getAddress().getPort()));
+                socket = ss.accept();
+            }
+        } else {
+            socket = new Socket();
+            socket.connect(new InetSocketAddress(getAddress().getHost(), getAddress().getPort()));
+        }
+
+        getLogger().trace("Setting timeout to {} on Socket", getTimeout());
+        socket.setSoTimeout(getTimeout());
+
+        authenticate(socket.getOutputStream(), socket.getInputStream(), socket);
+    }
+
+    @Override
+    public void close() throws IOException {
+        if (socket != null && !socket.isClosed()) {
+            socket.close();
+        }
+        super.close();
+    }
+}
+

dbus-java/src/main/java/org/freedesktop/dbus/connections/transports/TransportFactory.java

@@ -35,16 +35,23 @@ public static AbstractTransport createTransport(BusAddress _address, int _timeou
 
         if (_address.getBusType() == AddressBusTypes.UNIX) {
             transport = new UnixSocketTransport(_address, _timeout);
-            // } else if (_address.getBusType() == AddressBusTypes.TCP) {
-            // return new TcpTransport(_address, _timeout);
+        } else if (_address.getBusType() == AddressBusTypes.TCP) {
+            transport = new TcpTransport(_address, _timeout);
         } else {
             throw new IOException("Unknown address type " + _address.getType());
         }
 
-        transport.start();
+        transport.connect();
         return transport;
     }
 
+    /**
+     * Creates a new transport encapsulating connection to a unix socket or TCP socket.
+     * 
+     * @param _address Address parameter
+     * @return {@link AbstractTransport}
+     * @throws IOException when transport could not be created
+     */
     public static AbstractTransport createTransport(BusAddress _address) throws IOException {
         return createTransport(_address, 10000);
     }

dbus-java/src/main/java/org/freedesktop/dbus/connections/transports/UnixSocketTransport.java

@@ -10,6 +10,11 @@
 import jnr.unixsocket.UnixSocketChannel;
 import jnr.unixsocket.UnixSocketOptions;
 
+/**
+ * Transport type representing a transport connection to a unix socket.
+ * @author hypfvieh
+ * @since v3.2.0 - 2019-02-08
+ */
 public class UnixSocketTransport extends AbstractTransport {
     private final UnixSocketAddress unixSocketAddress;
     private UnixServerSocketChannel unixServerSocket;
@@ -28,6 +33,10 @@ public class UnixSocketTransport extends AbstractTransport {
         setSaslAuthMode(SASL.AUTH_EXTERNAL);
     }
 
+    /**
+     * Establish a connection to DBus using unix sockets.
+     * @throws IOException on error
+     */
     void connect() throws IOException {
         UnixSocketChannel us;
         if (getAddress().isListeningSocket()) {