Include D-Bus sender in User-Agent http header #2329

jirihnidek · 2020-09-17T14:51:48Z

When some application call D-Bus method, then the application
can be identified using sender argument of the method.
This argument used to be unused. The sender ID (e.g. ':1:3003')
can be used for finding of PID and this PID can be used for
finding command line used for starting the application that
sent the D-Bus method. This could be e.g.: 'dbus-send',
'cockpit-bridge', etc. (note: all command line options are
stripped for security reason to not send username nor password).
The command line of D-Bus sender is stored in singleton and
then this command line is added to User-Agent http header
as 'dbus_sender=cockpit-bridge'
The sender argument is saved to singleton using decorator
dbus_handle_sender implemented in rhsmlib.dbus.util.
When it will not be desired to store sender for some method
then just don't use this decorator.
When methods of DomainSocketRegisterDBusObject are used,
then it is little bit complicated, because system bus
is not used there, but custom unix socket is used. Thus
sender argument is not available. It is necessary to save
sender, when DomainSocketRegisterDBusObject is created using
com.redha.RHSM.Register.Start method
It will be possible to do statistics of applications using
our D-Bus API
Added implementation of singleton
Modified some unit tests

jirihnidek · 2020-09-17T14:52:43Z

This PR depend on #2328

jirihnidek · 2020-09-17T15:05:43Z

The http headers could look like this:

{
    "Content-type": "application/json",
    "Accept": "application/json",
    "x-subscription-manager-version": "RPM_VERSION",
    "Accept-Language": "cs-cz",
    "X-Correlation-ID": "70859bc7ffbd4f0b836a7c1b2946414a",
    "User-Agent": "RHSM/1.0 (cmd=rhsm_service.py) subscription-manager/RPM_VERSION dbus_sender=cockpit-bridge",
    "Content-Length": "0"
}

cnsnyder · 2020-10-02T20:22:50Z

src/rhsmlib/utils.py

+    Singleton and parent for singletons
+    """
+    _instance = None
+    _initialized = False


Where is this used?

Good point. I realized that I do something wrong here and we will need to use it.

So it is used in decorator no_reinitialization.

cnsnyder · 2020-10-12T19:36:58Z

Looks like there are a few failing flake8 issues:

test/test_managercli.py:1605:37: E231 missing whitespace after ','
test/test_managercli.py:1605:45: E231 missing whitespace after ','

cnsnyder · 2020-10-12T20:22:10Z

test/rhsmlib_test/test_utils.py

+        spoiled_child = SpoiledChild()
+        self.assertEqual(id(spoiled_child), spoiled_child_id)
+
+    def test_signleton_and_treading(self):


test_signleton_and_treading -> test_singleton_and_threading

cnsnyder · 2020-10-12T21:21:51Z

src/rhsmlib/dbus/util.py

+    elif len(args) > 0:
+        sender = args[-1]
+
+    if sender is not None:


If we want to ensure that the sender isn't changed for a given call, shouldn't we acquire the lock for the DbusSender singleton here?

Good point!

cnsnyder · 2020-10-12T22:57:52Z

src/rhsmlib/dbus/util.py

+    try:
+        return func(*args, **kwargs)
+    finally:
+        dbus_reset_sender_cmd_line()


And if we acquire the lock before the function call, I'd suggest we release it here.

Admittedly this is effectively serializing all our dbus calls which may be worth more discussion.

I implemented this using __enter__() and __exit__() methods and with DBusSender as dbus_sender statement. It is more clear solution.

wottop · 2021-07-27T17:06:09Z

We need to fix the test issue and rebase if this is on track for inclusion. Otherwise, we should close the PR until is it on the path.

* When some application call D-Bus method, then the application can be identified using sender argument of the method. This argument used to be unused. The sender ID (e.g. ':1:3003') can be used for finding of PID and this PID can be used for finding command line used for starting the application that sent the D-Bus method. This could be e.g.: 'dbus-send', 'cockpit-bridge', etc. (note: all command line options are stripped for security reason to not send username nor password). The command line of D-Bus sender is stored in singleton and then this command line is added to User-Agent http header as 'dbus_sender=cockpit-bridge' * The sender argument is saved to singleton using decorator dbus_handle_sender implemented in rhsmlib.dbus.util. When it will not be desired to store sender for some method then just don't use this decorator. * When methods of DomainSocketRegisterDBusObject are used, then it is little bit complicated, because system bus is not used there, but custom unix socket is used. Thus sender argument is not available. It is necessary to save sender, when DomainSocketRegisterDBusObject is created using com.redha.RHSM.Register.Start method * Fix one issue with initialization of CPPProvider * It will be possible to do statistics of applications using our D-Bus API * Modified some unit tests * Added implementation of singleton * Added unit tests for singleton * Create new connection for GetStatus, otherwise the dbus_sender is not set correctly and value from previous call is used * Fix issue with printing traceback to the file * Do not use wild import in rhsmlib.dbus package, because it caused circular import of DBusSender

jirihnidek · 2021-08-02T16:15:21Z

@wottop I updated the PR.

jirihnidek added enhancement in progress labels Sep 17, 2020

jirihnidek force-pushed the jhnidek/dbus_sender branch 2 times, most recently from f7ac889 to b57a161 Compare September 23, 2020 14:08

jirihnidek removed the in progress label Sep 23, 2020

wottop self-assigned this Oct 2, 2020

cnsnyder reviewed Oct 2, 2020

View reviewed changes

wottop removed their assignment Oct 7, 2020

jirihnidek force-pushed the jhnidek/dbus_sender branch from 0a9bdaa to 279ceaf Compare October 8, 2020 09:21

cnsnyder reviewed Oct 12, 2020

View reviewed changes

jirihnidek force-pushed the jhnidek/dbus_sender branch 2 times, most recently from 6da5b37 to d738c64 Compare October 15, 2020 09:19

jirihnidek force-pushed the jhnidek/dbus_sender branch from d738c64 to eaf02e7 Compare August 2, 2021 14:43

jirihnidek force-pushed the jhnidek/dbus_sender branch from eaf02e7 to 81c5dea Compare August 2, 2021 14:51

cnsnyder merged commit 29167f9 into main Aug 24, 2021

m-horky deleted the jhnidek/dbus_sender branch September 30, 2021 14:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Include D-Bus sender in User-Agent http header #2329

Include D-Bus sender in User-Agent http header #2329

jirihnidek commented Sep 17, 2020

jirihnidek commented Sep 17, 2020

jirihnidek commented Sep 17, 2020

cnsnyder Oct 2, 2020

jirihnidek Oct 5, 2020

jirihnidek Nov 4, 2020

cnsnyder commented Oct 12, 2020

cnsnyder Oct 12, 2020 •

edited

jirihnidek Oct 15, 2020

cnsnyder Oct 12, 2020

jirihnidek Oct 13, 2020

cnsnyder Oct 12, 2020

jirihnidek Oct 15, 2020

wottop commented Jul 27, 2021

jirihnidek commented Aug 2, 2021

Include D-Bus sender in User-Agent http header #2329

Include D-Bus sender in User-Agent http header #2329

Conversation

jirihnidek commented Sep 17, 2020

jirihnidek commented Sep 17, 2020

jirihnidek commented Sep 17, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cnsnyder commented Oct 12, 2020

cnsnyder Oct 12, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wottop commented Jul 27, 2021

jirihnidek commented Aug 2, 2021

cnsnyder Oct 12, 2020 •

edited