client: add AssuanClient.send_fds() and .receive_fds().

[pyassuan.git] / pyassuan / client.py

diff --git a/pyassuan/client.py b/pyassuan/client.py
index ccedff81ad790e9fd0d789cc2c85c347851d7497..84136336de3ca85c7c3b25f27f027f78b9a3b6a8 100644 (file)
--- a/pyassuan/client.py
+++ b/pyassuan/client.py
@@ -1,6 +1,21 @@
-# Copyright
+# Copyright (C) 2012 W. Trevor King <wking@drexel.edu>
+#
+# This file is part of pyassuan.
+#
+# pyassuan is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# pyassuan is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# pyassuan.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging as _logging
+import socket as _socket
 import sys as _sys
 
 from . import LOG as _LOG
@@ -9,7 +24,7 @@ from . import error as _error
 
 
 class AssuanClient (object):
-    """A single-threaded Assuan client based on the `devolpment suggestions`_
+    """A single-threaded Assuan client based on the `development suggestions`_
 
     .. _development suggestions:
       http://www.gnupg.org/documentation/manuals/assuan/Client-code.html
@@ -21,21 +36,37 @@ class AssuanClient (object):
             logger = _logging.getLogger('{}.{}'.format(logger.name, self.name))
         self.logger = logger
         self.close_on_disconnect = close_on_disconnect
-        self.input = self.output = None
+        self.input = self.output = self.socket = None
 
-    def connect(self):
-        if not self.input:
-            self.logger.info('read from stdin')
-            self.input = _sys.stdin
-        if not self.output:
-            self.logger.info('write to stdout')
-            self.output = _sys.stdout
+    def connect(self, socket_path=None):
+        if socket_path:
+            self.logger.info(
+                'connect to Unix socket at {}'.format(socket_path))
+            self.socket = _socket.socket(_socket.AF_UNIX, _socket.SOCK_STREAM)
+            self.socket.connect(socket_path)
+            self.input = self.socket.makefile('rb')
+            self.output = self.socket.makefile('wb')
+        else:
+            if not self.input:
+                self.logger.info('read from stdin')
+                self.input = _sys.stdin.buffer
+            if not self.output:
+                self.logger.info('write to stdout')
+                self.output = _sys.stdout.buffer
 
     def disconnect(self):
         if self.close_on_disconnect:
             self.logger.info('disconnecting')
-            self.input = None
-            self.output = None
+            if self.input is not None:
+                self.input.close()
+                self.input = None
+            if self.output is not None:
+                self.output.close()
+                self.output = None
+            if self.socket is not None:
+                self.socket.shutdown(_socket.SHUT_RDWR)
+                self.socket.close()
+                self.socket = None
 
     def raise_error(self, error):
         self.logger.error(str(error))
@@ -46,14 +77,17 @@ class AssuanClient (object):
         if not line:
             self.raise_error(
                 _error.AssuanError(message='IPC accept call failed'))
-        if not line.endswith('\n'):
+        if len(line) > _common.LINE_LENGTH:
+            self.raise_error(
+                _error.AssuanError(message='Line too long'))
+        if not line.endswith(b'\n'):
+            self.logger.info('S: {}'.format(line))
             self.raise_error(
                 _error.AssuanError(message='Invalid response'))
         line = line[:-1]  # remove trailing newline
-        # TODO, line length?
         response = _common.Response()
         try:
-            response.from_string(line)
+            response.from_bytes(line)
         except _error.AssuanError as e:
             self.logger.error(str(e))
             raise
@@ -61,10 +95,9 @@ class AssuanClient (object):
         return response
 
     def _write_request(self, request):
-        rstring = str(request)
-        self.logger.info('C: {}'.format(rstring))
-        self.output.write(rstring)
-        self.output.write('\n')
+        self.logger.info('C: {}'.format(request))
+        self.output.write(bytes(request))
+        self.output.write(b'\n')
         try:
             self.output.flush()
         except IOError:
@@ -97,7 +130,7 @@ class AssuanClient (object):
             if response.type == 'D':
                 data.append(response.parameters)
         if data:
-            data = ''.join(data)
+            data = b''.join(data)
         else:
             data = None
         return (responses, data)
@@ -137,3 +170,21 @@ class AssuanClient (object):
         self._write_request(request=request)
         if response:
             return self.get_responses(requests=requests, expect=expect)
+
+    def send_fds(self, fds):
+        """Send a file descriptor over a Unix socket.
+        """
+        msg = '# descriptors in flight: {}\n'.format(fds)
+        self.logger.info('C: {}'.format(msg.rstrip('\n')))
+        msg = msg.encode('ascii')
+        return _common.send_fds(
+            socket=self.socket, msg=msg, fds=fds, logger=None)
+
+    def receive_fds(self, msglen=200, maxfds=10):
+        """Receive file descriptors over a Unix socket.
+        """
+        msg,fds = _common.receive_fds(
+            socket=self.socket, msglen=msglen, maxfds=maxfds, logger=None)
+        msg = str(msg, 'utf-8')
+        self.logger.info('S: {}'.format(msg.rstrip('\n')))
+        return fds