Allow sending and receiving Unix file descriptors. #65
Conversation
| @@ -297,3 +309,9 @@ assertThrows check f = do | |||
| case result of | |||
| Left ex -> assertBool ("unexpected exception " ++ show ex) (check ex) | |||
| Right _ -> assertFailure "expected exception not thrown" | |||
|
|
|||
| nonWindowsTestCase :: TestName -> Assertion -> TestTree | |||
There was a problem hiding this comment.
Unix file descriptor passing should not work on Windows, so this is a hack to stop running the tests there.
I have not actually tested on anything other than Linux, though.
|
|
||
| -- | An authenticator that implements the D-Bus @EXTERNAL@ mechanism, which uses | ||
| -- credential passing over a Unix socket, with support for Unix file descriptor passing. | ||
| authenticatorWithUnixFds :: Authenticator SocketTransport |
There was a problem hiding this comment.
Usage looks something like:
let socketAuthenticator = DBus.authenticatorWithUnixFds
clientSocketOptions = DBus.defaultSocketOptions {DBus.socketAuthenticator}
clientOptions = DBus.defaultClientOptions {DBus.clientSocketOptions}
(dbusClient, clientName) <- DBus.connectWithName clientOptions addr
lib/DBus.hs
Outdated
| -- mentioned in the message (the marshaled bytes will contain indices into | ||
| -- this list). Although unusual, it is possible for marshaling to fail; if this | ||
| -- occurs, an error will be returned instead. | ||
| marshal :: Message msg => Endianness -> Serial -> msg -> Either MarshalError (Char8.ByteString, [Fd]) |
There was a problem hiding this comment.
Is there a way to avoid changing public API functions? Maybe add marshalWithFds here and in all other methods?
I prefer to avoid breaking existing API and releasing a new major version.
There was a problem hiding this comment.
Thanks for reviewing @rblaze
I have pushed a commit to make the API backwards compatible in general (except for internal modules).
The library will change behaviour in a backwards incompatible way when it comes to file descriptors, of course. If someone was calling marshal and unmarshal directly and relying on the previous behaviour then their code will now break (likely with an exception during unmarshal when the list of file descriptors is not supplied but is now expected). However, I think the previous behaviour was clearly not how dbus is intended to work, and people relying on a bug should probably not be surprised when their code breaks 😉
| -- | ||
| -- Throws a 'TransportError' if an error occurs. | ||
| transportPutWithFds :: t -> ByteString -> [Fd] -> IO () | ||
| transportPutWithFds t bs _fds = transportPut t bs |
There was a problem hiding this comment.
Default implementation for backwards compatibility. The SocketTransport instance overrides this with an implementation that actually sends the Fds over the socket.
| -- | ||
| -- Throws a 'TransportError' if an error occurs. | ||
| transportGetWithFds :: t -> Int -> IO (ByteString, [Fd]) | ||
| transportGetWithFds t n = do |
There was a problem hiding this comment.
Default implementation for backwards compatibility.
|
|
||
| unmarshalUnixFd :: Unmarshal Fd | ||
| unmarshalUnixFd = do | ||
| x <- unmarshalWord32 | ||
| when (toInteger x > toInteger (maxBound :: CInt)) |
There was a problem hiding this comment.
You can remove import Foreign.C.Types (CInt) now
Fixes issue #64