From: W. Trevor King <wking@tremily.us>
Date: Sat, 21 Apr 2012 15:51:08 +0000 (-0400)
Subject: Add send_fds and receive_fds functions.
X-Git-Tag: v0.2~6
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=bf85529fc1fd71ce50093317f0b5a25368ccf121;p=pyassuan.git

Add send_fds and receive_fds functions.

These will need Python 3.3 for sendmsg and recvmsg, but I already
copied over the code from the Python docs, so I'm committing it now
;).
---

diff --git a/pyassuan/common.py b/pyassuan/common.py
index 8b99a45..7c979cb 100644
--- a/pyassuan/common.py
+++ b/pyassuan/common.py
@@ -17,7 +17,9 @@
 """Items common to both the client and server
 """
 
+import array as _array
 import re as _re
+import socket as _socket
 
 from . import error as _error
 
@@ -268,3 +270,40 @@ def error_response(error):
     ERR 1 General error
     """
     return Response(type='ERR', parameters=str(error))
+
+
+def send_fds(socket, msg, fds):
+    """Send a file descriptor over a Unix socket using ``sendmsg``.
+
+    ``sendmsg`` suport requires Python >= 3.3.
+
+    Code from
+    http://docs.python.org/dev/library/socket.html#socket.socket.sendmsg
+
+    Assuan equivalent is
+    http://www.gnupg.org/documentation/manuals/assuan/Client-code.html#function-assuan_005fsendfd
+    """
+    return socket.sendmsg(
+        [msg],
+        [(_socket.SOL_SOCKET, _socket.SCM_RIGHTS, _array.array('i', fds))])
+
+def receive_fds(socket, msglen, maxfds):
+    """Recieve file descriptors using ``recvmsg``.
+
+    ``recvmsg`` suport requires Python >= 3.3.
+
+    Code from http://docs.python.org/dev/library/socket.html
+
+    Assuan equivalent is
+    http://www.gnupg.org/documentation/manuals/assuan/Client-code.html#fun_002dassuan_005freceivedfd
+    """
+    fds = _array.array('i')   # Array of ints
+    msg,ancdata,flags,addr = socket.recvmsg(
+        msglen, _socket.CMSG_LEN(maxfds * fds.itemsize))
+    for cmsg_level,cmsg_type,cmsg_data in ancdata:
+        if (cmsg_level == _socket.SOL_SOCKET and
+            cmsg_type == _socket.SCM_RIGHTS):
+            # Append data, ignoring any truncated integers at the end.
+            fds.fromstring(
+                cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
+    return (msg, list(fds))