pangdudu-ruby-dbus 0.2.3 → 0.2.4

data/README.rdoc

@@ -0,0 +1,110 @@
+= Ruby D-Bus -> ffwd
+
+Ruby D-Bus provides an implementation of the D-Bus protocol such that the
+D-Bus system can be used in the Ruby programming language.
+
+
+This is my personal dev-fork of mvidners upstream.
+
+Things will move on quick here if I need stuff. If you'd like to contrib/maintain
+to this fork, let me know.
+
+Most of my work here is actually for another project: http://github.com/pangdudu/robots/tree/master
+
+I might also start writing a less ugly version of: http://github.com/pangdudu/ruby-dbus-daemon/tree/master 
+
+If you know of a nice custom-dbus-daemon let me know. Still thinking about writing
+a dbus spec compliant server/daemon implementation in (pure) Ruby, so that I can
+play around with the network and authentification more easily.
+
+Oki, will clean up a little now. :)
+
+Peace.
+
+== Requirements
+
+ * Ruby 1.8 (>= 1.8.6?)
+
+== Installation
+
+  sudo gem install pangdudu-ruby-dbus --source=http://gems.github.com
+
+== Features
+
+Ruby D-Bus currently supports the following features:
+
+ * Connecting to local buses.
+ * Accessing remote services, objects and interfaces.
+ * Invoking methods on remote objects synchronously and asynchronously.
+ * Catch signals on remote objects and handle them via callbacks.
+ * Remote object introspection.
+ * Walking object trees.
+ * Creating services and registering them on the bus.
+ * Exporting objects with interfaces on a bus for remote use.
+ * Rubyish D-Bus object and interface syntax support that automatically
+   allows for introspection.
+ * Emitting signals on exported objects.
+ 
+ * Connection to a local or remote bus over TCP/IP
+ * Authentification mechanisms working now: External,CookieSHA1
+
+== Usage
+
+=== Basics:
+
+View a tutorial online on http://trac.luon.net/data/ruby-dbus/tutorial/.
+
+
+=== TCP/Remote stuff:
+
+Take a look at 'config/remote.session.dbus.conf' and start 'config/start_dbus_session.sh'.
+
+You can now try and run one of the tests e.g. 'test/simple_socket_test.rb'.
+
+
+=== Problems you'll have with 'CookieSHA1' when using it remotely: 
+
+Unless we [including you :)] write a funkier SASL authentification mechanism that
+makes sense when using it over-wire, we're stuck with the cookie auth.
+
+Works like this: 
+
+There is a file in '~/.dbus-keyrings' named 'org_freedesktop_general'. 
+It is '-rw-------' so that only you can read it (if you change the permissions, 
+dbus-daemon will most likely ignore the file leaving you with 'External', which is
+even worse remotely). It's kind of a secret key you use to auth against yourself 
+later on.
+
+If you take a look at 'dbus/auth.rb line 40+' you'll see the problem:
+
+  # Search cookie file for id
+  path = File.join(ENV['HOME'], '.dbus-keyrings', context)
+  
+So if you're starting 'config/start_dbus_session.sh' on one host and 'config/start_dbus_session.sh'
+on another one, you'll need to make sure that the content in '~/.dbus-keyrings/org_freedesktop_general'
+is the same on both machines, in order for the 'CookieSHA1' auth to work.
+
+Not cool. I can think of hacks with nfs,smb or fuse:sshfs making it less
+painful to use. 
+
+The file content also get's updated every 5 minutes (when a client fails to auth etc.). 
+Making copy and paste from one shell to another very frolic.
+
+To sum it up: 
+
+Today it's acceptable to use it like this, but until next week we'll need an easy 
+auth mechanism that works on the wire. 
+
+
+more infos:
+  http://dbus.freedesktop.org/doc/dbus-specification.html#auth-mechanisms
+  http://lists.freedesktop.org/archives/dbus/2007-June/008067.html
+
+Booyaa.
+
+== License
+
+Ruby D-Bus is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as published by the
+Free Software Foundation; either version 2.1 of the License, or (at
+your option) any later version.

data/config/remote.session.dbus.conf

@@ -0,0 +1,39 @@
+<!-- This configuration file controls the per-user-login-session message bus.
+     Add a session-local.conf and edit that rather than changing this 
+     file directly. -->
+
+<!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-Bus Bus Configuration 1.0//EN"
+ "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd">
+<busconfig>
+  <!-- Our well-known bus type, don't change this -->
+  <type>session</type>
+
+  <!-- If we fork, keep the user's original umask to avoid affecting
+       the behavior of child processes. -->
+  <keep_umask/>
+
+<!--  <allow_anonymous/> -->
+  
+  <!-- Listen to everything on tcp! -->
+  <listen>tcp:host=0.0.0.0,port=2687,family=ipv4</listen>
+  <!-- Listen on socket at this file location -->
+  <listen>unix:path=/tmp/socket_test_session_bus_socket</listen>
+  
+  <standard_session_servicedirs /> 
+
+  <policy context="default">
+    <!-- Allow everything to be sent -->
+    <allow send_destination="*" eavesdrop="true"/>
+    <!-- Allow everything to be received -->
+    <allow eavesdrop="true"/>
+    <!-- Allow anyone to own anything -->
+    <allow own="*"/>
+  </policy>
+
+  <!-- raise the service start timeout to 40 seconds as it can timeout
+       on the live cd on slow machines -->
+  <limit name="service_start_timeout">60000</limit>
+
+  <include if_selinux_enabled="yes" selinux_root_relative="yes">contexts/dbus_contexts</include>
+
+</busconfig>

data/config/start_dbus_session.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+dbus-daemon --print-address --config-file=remote.session.dbus.conf

data/lib/dbus.rb

@@ -7,11 +7,15 @@
 # modify it under the terms of the GNU Lesser General Public
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
+require 'rubygems'
+require 'rofl' #http://github.com/pangdudu/rofl/tree/master makes the debug/tracing easy
+#comes from the Rofl logger/tracer module
+@logger.level = Logger::DEBUG
 
 require 'dbus/type'
 require 'dbus/introspect'
 require 'dbus/export'
-require 'dbus/bus.rb'
+require 'dbus/bus'
 require 'dbus/marshall'
 require 'dbus/message'
 require 'dbus/matchrule'
@@ -26,7 +30,7 @@ module DBus
   # Default socket name for the system bus.
   SystemSocketName = "unix:path=/var/run/dbus/system_bus_socket"
 
-  # Socket name for the session bus.
+  # Socket name for the session bus, not pretty.
   SessionSocketName = ENV["DBUS_SESSION_BUS_ADDRESS"]
 
   # Byte signifying big endianness.
@@ -82,5 +86,3 @@ module DBus
   class InvalidIntrospectionData < Exception
   end
 end # module DBus
-#just for my info
-puts "pangdudus ruby-dbus fork."

data/lib/dbus/auth.rb

@@ -29,7 +29,7 @@ module DBus
       # each character and determin hex value "1" => 0x31, "0" => 0x30. You
       # obtain for "1000" => 31303030 This is what the server is expecting.
       # Why? I dunno. How did I come to that conclusion? by looking at rbus
-      # code. I have no idea how he found that out.
+      # code. I have no idea how he found that out. 
       return Process.uid.to_s.split(//).collect { |a| "%x" % a[0] }.join
     end
   end
@@ -61,10 +61,12 @@ module DBus
       c_challenge = Array.new(s_challenge.length/2).map{|obj|obj=rand(255).to_s}.join
       # Search cookie file for id
       path = File.join(ENV['HOME'], '.dbus-keyrings', context)
+      dlog "path: #{path.inspect}"
       File.foreach(path) do |line|
         if line.index(id) == 0
           # Right line of file, read cookie
           cookie = line.split(' ')[2].chomp
+          dlog "cookie: #{cookie.inspect}"
           # Concatenate and encrypt
           to_encrypt = [s_challenge, c_challenge, cookie].join(':')
           sha = Digest::SHA1.hexdigest(to_encrypt)
@@ -75,7 +77,7 @@ module DBus
           return response
         end
       end
-      raise AuthException, 'Unable to locate cookie'
+      elog "Unable to locate cookie"
     end  
     
     # encode plain to hex
@@ -126,9 +128,16 @@ module DBus
 
     # Try authentication using the next authenticator.
     def next_authenticator
-      raise AuthenticationFailed if @auth_list.size == 0
-      @authenticator = @auth_list.shift.new
-      send("AUTH", @authenticator.name, @authenticator.authenticate)
+      begin
+        raise AuthException if @auth_list.size == 0
+        @authenticator = @auth_list.shift.new
+        auth_msg = ["AUTH", @authenticator.name, @authenticator.authenticate]
+        dlog "auth_msg: #{auth_msg.inspect}"
+        send(auth_msg)
+      rescue AuthException
+        @socket.close
+        raise
+      end
     end
 
 
@@ -142,32 +151,36 @@ module DBus
         break if buf.nil?
         left -= buf.size
         data += buf
-        break if data.include? crlf
+        break if data.include? crlf #crlf means line finished, the TCP socket keeps on listening, so we break 
       end
       readline = data.chomp.split(" ")
+      dlog "readline: #{readline.inspect}"
       return readline
-      #return @socket.readline.chomp.split(" ")
     end
 
     # Try to reach the next state based on the current state.
     def next_state
       msg = next_msg
       if @state == :Starting
+        dlog ":Starting msg: #{msg[0].inspect}"
         case msg[0]
         when "OK"
           @state = :WaitingForOk    
         when "CONTINUE"
           @state = :WaitingForData
-        when "REJECTED" #needed by tcp, unix-path/abstract don't get here
+        when "REJECTED" #needed by tcp, unix-path/abstract doesn't get here
           @state = :WaitingForData
         end
       end
+      dlog "state: #{@state}"
       case @state
       when :WaitingForData
+        dlog ":WaitingForData msg: #{msg[0].inspect}"
         case msg[0]
         when "DATA"
           chall = msg[1]
           resp, chall = @authenticator.data(chall)
+          dlog ":WaitingForData/DATA resp: #{resp.inspect}"
           case resp
           when :AuthContinue
             send("DATA", chall)
@@ -193,6 +206,7 @@ module DBus
           @state = :WaitingForData
         end
       when :WaitingForOk
+        dlog ":WaitingForOk msg: #{msg[0].inspect}"
         case msg[0]
         when "OK"
           send("BEGIN")
@@ -208,6 +222,7 @@ module DBus
           @state = :WaitingForOk
         end
       when :WaitingForReject
+        dlog ":WaitingForReject msg: #{msg[0].inspect}"
         case msg[0]
         when "REJECT"
           next_authenticator

data/lib/dbus/bus.rb

@@ -7,7 +7,6 @@
 # modify it under the terms of the GNU Lesser General Public
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
-
 require 'socket'
 require 'thread'
 require 'singleton'
@@ -78,7 +77,7 @@ module DBus
         n = n[elem]
       end
       if n.nil?
-        puts "Warning, unknown object #{path}" if $DEBUG
+        wlog "Unknown object #{path.inspect}"
       end
       n
     end
@@ -124,10 +123,9 @@ module DBus
 
     # Return an XML string representation of the node.
     def to_xml
-      xml = '<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
-"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
-<node>
-'
+      xml = '<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+      <node>'
+
       self.each_pair do |k, v|
         xml += "<node name=\"#{k}\" />"
       end
@@ -140,7 +138,7 @@ module DBus
         end
       end
       xml += '</node>'
-      xml
+      return xml
     end
 
     # Return inspect information of the node.
@@ -176,11 +174,7 @@ module DBus
       # http://dbus.freedesktop.org/doc/dbus-specification.html#addresses
     # and is something like:
     # "transport1:key1=value1,key2=value2;transport2:key1=value1,key2=value2"
-    # e.g. "unix:path=/tmp/dbus-test"
-    #
-    # Current implementation of ruby-dbus supports only a single server
-    # address and only "unix:path=...,guid=..." and
-    # "unix:abstract=...,guid=..." forms
+    # e.g. "unix:path=/tmp/dbus-test" or "tcp:host=localhost,port=2687"
     def initialize(path)
       @path = path
       @unique_name = nil
@@ -194,8 +188,8 @@ module DBus
 
     # Connect to the bus and initialize the connection.
     def connect
-      connect_to_tcp if @path.include? "tcp:" #testing
-      connect_to_unix_abstract if @path.include? "unix:" #supposed stable
+      connect_to_tcp if @path.include? "tcp:" #connect to tcp socket
+      connect_to_unix if @path.include? "unix:" #connect to unix socket
     end
 
     # Connect to a bus over tcp and initialize the connection.
@@ -209,18 +203,23 @@ module DBus
           port = para.sub("port=","").to_i if para.include? "port="
           family = para.sub("family=","") if para.include? "family="
         end
-        #puts "host,port,family : #{host},#{port},#{family}"      
-        #initialize the tcp socket
-        @socket = TCPSocket.new(host,port)
-        init_connection
+        dlog "host,port,family : #{host},#{port},#{family}"      
+        begin
+          #initialize the tcp socket
+          @socket = TCPSocket.new(host,port)
+          init_connection
+        rescue
+          elog "Could not establish connection to: #{@path}, will now exit."
+          exit(0) #a little harsh
+        end
       else
         #Danger, Will Robinson: the specified "path" is not usable
-        puts "ERROR:dbus/bus.rb/Connection.connect_to_tcp: supplied path: #{@path}, unasable! sry" if $DEBUG
+        elog "supplied path: #{@path}, unusable! sorry."
       end
     end
 
     # Connect to an abstract unix bus and initialize the connection.
-    def connect_to_unix_abstract
+    def connect_to_unix
       @socket = Socket.new(Socket::Constants::PF_UNIX,Socket::Constants::SOCK_STREAM, 0)
       parse_session_string
       if @transport == "unix" and @type == "abstract"
@@ -260,7 +259,7 @@ module DBus
 
     # Send the buffer _buf_ to the bus using Connection#writel.
     def send(buf)
-      @socket.write(buf)
+      @socket.write(buf) unless @socket.nil?
     end
 
     # Tell a bus to register itself on the glib main loop
@@ -447,7 +446,7 @@ module DBus
     # Fill (append) the buffer from data that might be available on the
     # socket.
     def update_buffer
-      @buffer += @socket.read_nonblock(MSG_BUF_SIZE)
+      @buffer += @socket.read_nonblock(MSG_BUF_SIZE) unless @socket.nil?
     end
 
     # Get one message from the bus and remove it from the buffer.
@@ -488,6 +487,10 @@ module DBus
 
     # Wait for a message to arrive. Return it once it is available.
     def wait_for_message
+      if @socket.nil?
+        elog "Can't wait for messages, @socket is nil."
+        return
+      end
       ret = pop_message
       while ret == nil
         r, d, d = IO.select([@socket])
@@ -502,11 +505,15 @@ module DBus
     # Send a message _m_ on to the bus. This is done synchronously, thus
     # the call will block until a reply message arrives.
     def send_sync(m, &retc) # :yields: reply/return message
+      return if m.nil? #check if somethings wrong
       send(m.marshall)
       @method_call_msgs[m.serial] = m
       @method_call_replies[m.serial] = retc
 
       retm = wait_for_message
+      
+      return if retm.nil? #check if somethings wrong
+      
       process(retm)
       until [DBus::Message::ERROR,
           DBus::Message::METHOD_RETURN].include?(retm.message_type) and
@@ -521,6 +528,7 @@ module DBus
     def on_return(m, &retc)
       # Have a better exception here
       if m.message_type != Message::METHOD_CALL
+        elog "Funky exception, occured."
         raise "on_return should only get method_calls"
       end
       @method_call_msgs[m.serial] = m
@@ -536,17 +544,14 @@ module DBus
     end
 
     # Process a message _m_ based on its type.
-    # method call:: FIXME...
-    # method call return value:: FIXME...
-    # signal:: FIXME...
-    # error:: FIXME...
     def process(m)
+      return if m.nil? #check if somethings wrong
       case m.message_type
       when Message::ERROR, Message::METHOD_RETURN
         raise InvalidPacketException if m.reply_serial == nil
         mcs = @method_call_replies[m.reply_serial]
         if not mcs
-          puts "no return code for #{mcs.inspect} (#{m.inspect})" if $DEBUG
+          dlog "no return code for mcs: #{mcs.inspect} m: #{m.inspect}"
         else
           if m.message_type == Message::ERROR
             mcs.call(Error.new(m))
@@ -558,7 +563,7 @@ module DBus
         end
       when DBus::Message::METHOD_CALL
         if m.path == "/org/freedesktop/DBus"
-          puts "Got method call on /org/freedesktop/DBus" if $DEBUG
+          dlog "Got method call on /org/freedesktop/DBus"
         end
         # handle introspectable as an exception:
         if m.interface == "org.freedesktop.DBus.Introspectable" and
@@ -586,7 +591,7 @@ module DBus
           end
         end
       else
-        puts "Unknown message type: #{m.message_type}" if $DEBUG
+        dlog "Unknown message type: #{m.message_type}"
       end
     end
 
@@ -626,7 +631,7 @@ module DBus
       m.member = "Hello"
       send_sync(m) do |rmsg|
         @unique_name = rmsg.destination
-        puts "Got hello reply. Our unique_name is #{@unique_name}" if $DEBUG
+        dlog "Got hello reply. Our unique_name is #{@unique_name}, i feel special."
       end
     end