Attachment 107228 Details for Bug 84598 – [PATCH] GetAllMatchRules: provide an example how it could be used

[patch] [PATCH] GetAllMatchRules: provide an example how it could be used

0001-GetAllMatchRules-provide-an-example-how-it-could-be-.patch (text/plain), 5.16 KB, created by Alban Crequy on 2014-10-02 14:00:02 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Alban Crequy

Created: 2014-10-02 14:00:02 UTC

Size: 5.16 KB

patch

obsolete

>From 3fb78fbbc2293b68be1a3157f8418f5591ba8e32 Mon Sep 17 00:00:00 2001
>From: Alban Crequy <alban.crequy@collabora.co.uk>
>Date: Thu, 2 Oct 2014 14:21:24 +0100
>Subject: [PATCH] GetAllMatchRules: provide an example how it could be used
>
>FIXME: why do I need to add GetAllMatchRules.py in EXTRA_DIST?
>       "make distcheck" does not work otherwise...
>---
> tools/GetAllMatchRules.py | 112 ++++++++++++++++++++++++++++++++++++++++++++++
> tools/Makefile.am         |   7 ++-
> 2 files changed, 118 insertions(+), 1 deletion(-)
> create mode 100755 tools/GetAllMatchRules.py
>
>diff --git a/tools/GetAllMatchRules.py b/tools/GetAllMatchRules.py
>new file mode 100755
>index 0000000..6a7e4cd
>--- /dev/null
>+++ b/tools/GetAllMatchRules.py
>@@ -0,0 +1,112 @@
>+#!/usr/bin/env python
>+
>+import sys
>+import argparse
>+import dbus
>+import time
>+
>+def get_cmdline(pid):
>+  cmdline = ''
>+  if pid > 0:
>+    try:
>+      procpath = '/proc/' + str(pid) + '/cmdline'
>+      with open(procpath, 'r') as f:
>+        cmdline = " ".join(f.readline().split('\0'))
>+    except:
>+      pass
>+  return cmdline
>+
>+# Parsing parameters
>+
>+parser = argparse.ArgumentParser(description='Testing D-Bus match rules')
>+parser.add_argument('--session', help='session bus', action="store_true")
>+parser.add_argument('--system', help='system bus', action="store_true")
>+parser.add_argument('--all', help='print all match rules', action="store_true")
>+args = parser.parse_args()
>+
>+if args.system and args.session:
>+  parser.print_help()
>+  sys.exit(1)
>+
>+# Fetch data from the bus driver
>+
>+if args.system:
>+  bus = dbus.SystemBus()
>+else:
>+  bus = dbus.SessionBus()
>+
>+remote_object = bus.get_object("org.freedesktop.DBus",
>+                               "/org/freedesktop/DBus")
>+bus_iface = dbus.Interface(remote_object, "org.freedesktop.DBus")
>+stats_iface = dbus.Interface(remote_object, "org.freedesktop.DBus.Debug.Stats")
>+
>+try:
>+  match_rules = stats_iface.GetAllMatchRules()
>+except:
>+  print("GetConnectionMatchRules failed: did you enable the Stats interface?")
>+  sys.exit(1)
>+
>+names = bus_iface.ListNames()
>+unique_names = [ a for a in names if a.startswith(":") ]
>+pids = dict((name, bus_iface.GetConnectionUnixProcessID(name)) for name in unique_names)
>+cmds = dict((name, get_cmdline(pids[name])) for name in unique_names)
>+well_known_names = [ a for a in names if a not in unique_names ]
>+owners = dict((wkn, bus_iface.GetNameOwner(wkn)) for wkn in well_known_names)
>+
>+rules = dict((k_rules,
>+              dict({
>+                'wkn': [k for k, v in owners.items() if v == k_rules],
>+                'pid': pids[k_rules],
>+                'cmd': cmds[k_rules] or "",
>+                'rules': v_rules,
>+                'warnings': dict({
>+                  'not_signal': [a for a in v_rules if "type='signal'" not in a],
>+                  'no_sender': [a for a in v_rules if "sender=" not in a],
>+                  'local': [a for a in v_rules if "org.freedesktop.DBus.Local" in a],
>+                  'NameOwnerChanged_arg0': [a for a in v_rules if "member='NameOwnerChanged'" in a and "arg0" not in a]
>+                })
>+              })
>+             ) for k_rules, v_rules in match_rules.items())
>+
>+warnings = dict({
>+             'not_signal': 'Match rule without selecting signals',
>+             'no_sender': 'Match rule without a sender criteria',
>+             'local': 'Match rule on the org.freedesktop.DBus.Local interface',
>+             'NameOwnerChanged_arg0': 'Match rule on NameOwnerChanged without a arg0* criteria'
>+           })
>+
>+# Print the match rules
>+
>+# print all match rules without analysing them
>+if args.all:
>+  for name in rules:
>+    print("Connection %s with pid %d '%s' (%s): %d match rules, %d warnings"
>+          % (name, rules[name]['pid'], rules[name]['cmd'],
>+             ' '.join(rules[name]['wkn']), len(rules[name]['rules']),
>+             len(sum(rules[name]['warnings'].values(), []))))
>+    for rule in rules[name]['rules']:
>+      print("\t%s" % (rule))
>+    print("")
>+  sys.exit(0)
>+
>+# analyse match rules and print only the suspicious ones
>+for conn,data in rules.items():
>+  warnings_count = len(sum(data['warnings'].values(), []))
>+  if warnings_count == 0:
>+    continue
>+
>+  print("Connection %s with pid %d '%s' (%s): %d match rules, %d warnings"
>+        % (conn, data['pid'], data['cmd'], ' '.join(data['wkn']),
>+           len(data['rules']), warnings_count))
>+
>+  for warn_code,rule_list in [(warn_code,rule_list) \
>+                              for warn_code, rule_list \
>+                              in data['warnings'].items() \
>+                              if len(rule_list) > 0]:
>+    print("   - %s:" % (warnings[warn_code]))
>+    for rule in rule_list:
>+      print("         - %s" % (rule))
>+
>+  print("")
>+
>+sys.exit(0)
>diff --git a/tools/Makefile.am b/tools/Makefile.am
>index 73d95fc..f83b53f 100644
>--- a/tools/Makefile.am
>+++ b/tools/Makefile.am
>@@ -76,7 +76,12 @@ dbus_launch_LDADD = \
> 	$(DBUS_X_LIBS) \
> 	$(NULL)
> 
>-EXTRA_DIST = run-with-tmp-session-bus.sh strtoll.c strtoull.c
>+examplesdir = ${docdir}/examples
>+examples_SCRIPTS = \
>+	GetAllMatchRules.py \
>+	$(NULL)
>+
>+EXTRA_DIST = run-with-tmp-session-bus.sh strtoll.c strtoull.c $(examples_SCRIPTS)
> CLEANFILES = 				\
> 	run-with-tmp-session-bus.conf
> 
>-- 
>1.8.5.3
>

Actions: View | Splinter Review

Attachments on bug 84598: 107228

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.