kumquat-buildroot/package/dbus-broker/dbus-broker.mk
Norbert Lange bd3cf3fb5b package/dbus-broker: new package
dbus-broker is an alternate implementation of a dbus daemon. It can be
used as a drop-in replacement for the system bus daemon, as well as the
session bus daemon.

dbus-broker is (basically, and as far as we're concerned in Buildroot)
split in two components:

  - the actual message bus daemon, that relays messages across clients

  - a launcher, which is responsible for setting various aspects of the
    bus, like setting the policy et al. and opening the socket(s) the
    message bus daemon will have to listen on...

The launcher can only be used in a systemd setup (it makes heavy use of
systemd facilities), while the message bus is generic. However, the
message bus daemon is useless without a launcher. There does not exist a
non-systemd launcher, which makes dbus-broker actually a systemd-only
package; this can be revisited when/if a non-systemd launcher appears.

Note, however, that libdbus is not provided by dbus-broker. People who
want to use dbus-broker as the bus daemon, and need libdbus, will have
to enable both.

If only original dbus is enabled, things stay as they are now. This is
for the moment still the default, though we should change that once
dbus-broker has proven to work.

If only dbus-broker is enabled, it installs the necessary socket
activation units and dbus configuration files. The daemon is not
launched at boot time; instead it is socket-activated when a client
connects to the bus the first time.

If both original dbus and dbus-broker are enabled, we have a conflict
with the configuration files, the socket activation file. Also, original
dbus activates the daemon as a service in multi-user.target.wants, so it
is not socket-activated and dbus-broker would never get the opportunity
to start.

Therefore, original dbus is updated to remove the conflicting files and
the activation of dbus-daemon. Since dbus-broker installs some of the
same file that original dbus removes, we have to add a dependency to
make sure that the ones installed by dbus-broker aren't removed.

If both are installed, it is still possible to revert back to using
original dbus as system bus:
      - at build-time: by calling systemctl enable/disable from a
        post-build script (preferred), or by providing drop-in units
        or presets in an overlay (less preferred) or custom skeleton
        (as a last resort),
      - at runtime (on a RW filesystem): by calling systemctl
        enable/disable

Note about the user: the path to the system bus socket is a so-called
"well-known location": it is expected to be there, by spec. Moving it
elsewhere is going to break existing programs. So, the user running the
system bus daemon must be able to create that socket.

As we may have two packages providing a system bus daemon, they have to
be both able to create the socket, and thus must both be able to write
in the directory containing the socket. And since they can be switched
at runtime, they must be running as the same user.

We can't just reference the original dbus user, so we duplicate the
entry. What is important, is that the user be named 'dbus', as that's
what we use in both cases.

If both original dbus and dbus-broker are selected, the dbus user is
included twice, but the specifications are identical so that's fine.
mkusers will create the user only once.

Finally, the licensing terms are pretty trivial for dbus-broker itself,
but it makes use of third-party code that it inherits as git submodules
(that are bundled in the release archive). Thus the licensing is a bit
convoluted... The third-party codes claim to be licensed as "Apache-2.0
and LGP-2.1+" in their AUTHORS files, but at the same time claim
"**Apache-2.0** OR **LGPL-2.1-or-later**" in their README files. The
individual source files (that are used) do not seem to have any
licensing header to clarify the situation. So we represent the situation
with "Apache-2.0 and/or LGPL-2.1+".

Signed-off-by: Norbert Lange <nolange79@gmail.com>
[yann.morin.1998@free.fr:
  - don't select systemd; depend on it instead
  - only install config files and systemd units without original dbus
  - install a user to run the message bus as
  - fix licensing info
  - entirely reword and extend the commit log
  - add myself to DEVELOPERS as well
]
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
[Arnout:
 - Use dbus-broker as system bus if both are selected.
 - Remove conflicting files from dbus installation.
 - Simplify symbolic link creation.
 - Add comment to remind update of session.conf and system.conf.
]
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2022-07-28 00:48:53 +02:00

68 lines
2.4 KiB
Makefile

################################################################################
#
# dbus-broker
#
################################################################################
DBUS_BROKER_VERSION = 29
DBUS_BROKER_SOURCE = dbus-broker-$(DBUS_BROKER_VERSION).tar.xz
DBUS_BROKER_SITE = https://github.com/bus1/dbus-broker/releases/download/v$(DBUS_BROKER_VERSION)
DBUS_BROKER_LICENSE = \
Apache-2.0, \
Apache-2.0 and/or LGPL-2.1+ (c-dvar, c-ini, c-list, c-rbtree, c-shquote, c-stdaux, c-utf8)
# For the third-party code, the licensing legal-info is inconsistent between
# the AUTHORS and README, so keep both
DBUS_BROKER_LICENSE_FILES = \
LICENSE \
subprojects/c-dvar/AUTHORS subprojects/c-dvar/README.md \
subprojects/c-ini/AUTHORS subprojects/c-ini/README.md \
subprojects/c-list/AUTHORS subprojects/c-list/README.md \
subprojects/c-rbtree/AUTHORS subprojects/c-rbtree/README.md \
subprojects/c-shquote/AUTHORS subprojects/c-shquote/README.md \
subprojects/c-stdaux/AUTHORS subprojects/c-stdaux/README.md \
subprojects/c-utf8/AUTHORS subprojects/c-utf8/README.md
DBUS_BROKER_DEPENDENCIES = expat systemd
DBUS_BROKER_CONF_OPTS = -Dlauncher=true
ifeq ($(BR2_PACKAGE_AUDIT),y)
DBUS_BROKER_DEPENDENCIES += audit
DBUS_BROKER_CONF_OPTS += -Daudit=true
else
DBUS_BROKER_CONF_OPTS += -Daudit=false
endif
ifeq ($(BR2_PACKAGE_LIBSELINUX),y)
DBUS_BROKER_DEPENDENCIES += libselinux
DBUS_BROKER_CONF_OPTS += -Dselinux=true
else
DBUS_BROKER_CONF_OPTS += -Dselinux=false
endif
# We must be using the same user as the original dbus, so we can share
# the home directory and create a socket there. As a consequence, the
# username and groupname must be dbus:dbus, and they both need to have
# the same home.
define DBUS_BROKER_USERS
dbus -1 dbus -1 * /run/dbus - dbus DBus messagebus user
endef
# We overwrite some files from dbus, so add a dependency.
ifeq ($(BR2_PACKAGE_DBUS),y)
DBUS_BROKER_DEPENDENCIES += dbus
endif
define DBUS_BROKER_INSTALL_INIT_SYSTEMD
$(INSTALL) -D -m 0644 $(DBUS_BROKER_PKGDIR)/session.conf \
$(TARGET_DIR)/usr/share/dbus-1/session.conf
$(INSTALL) -D -m 0644 $(DBUS_BROKER_PKGDIR)/system.conf \
$(TARGET_DIR)/usr/share/dbus-1/system.conf
$(INSTALL) -D -m 0644 $(DBUS_BROKER_PKGDIR)/dbus.socket \
$(TARGET_DIR)/usr/lib/systemd/system/dbus.socket
$(HOST_MAKE_ENV) ln -sf ../dbus.socket \
$(TARGET_DIR)/usr/lib/systemd/system/sockets.target.wants/dbus.socket
endef
$(eval $(meson-package))