biboumi: init at 6.1 #30193

woffs · 2017-10-07T14:49:44Z

TODO: integrate config in NixOS

The config file referenced in the systemd service file is not existent atm and its options should be integrated into configuration.nix, but I am a newbie :-)

Motivation for this change

Provide my favourite XMPP IRC gateway.

Things done

Tested using sandboxing (nix.useSandbox on NixOS, or option build-use-sandbox in nix.conf on non-NixOS)
Built on platform(s)
- NixOS
- macOS
- Linux
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Fits CONTRIBUTING.md.

Mic92 · 2017-10-07T14:55:20Z

pkgs/servers/xmpp/biboumi/default.nix

+    description = "Modern XMPP IRC gateway";
+    platforms = platforms.unix;
+    homepage = https://lab.louiz.org/louiz/biboumi;
+    license = licenses.zlib;


Do you want to maintain this?

I'll add a maintainer line. Would be fine if I'd find a mate here.

Yes and also take a look at lib/maintainers.nix

Mic92 · 2017-10-07T14:57:15Z

pkgs/servers/xmpp/biboumi/default.nix

+  preConfigure = ''
+    grep -lr /etc/biboumi . | while read f
+    do
+      substituteInPlace $f --replace /etc/biboumi $out/etc/biboumi


Does makes biboumi reading its configuration always from $out or can this be overwritten via command line?

the config file is a cmdline argument, but "make install" fails without this adjustment.

Mic92 · 2017-10-07T14:57:40Z

pkgs/servers/xmpp/biboumi/default.nix

+  };
+
+  buildInputs = [ cmake libuuid expat sqlite git libiconv libidn botan2
+    systemd pkgconfig udns ];


How is git used during the build?

Apparently a test suite is fetched. I don't like this, too.

It will also fail to build in sandbox builds, which is what we use on hydra. So this behavior has to be prevented.

almost done :)

It seems not to download anything during build. So this having git in buildInputs is fine here.

Fine, but I already had decided to patch it away so I can enable tests. :-)

TODO: integrate config in NixOS

- fetch catch.hpp in a reproducible way - add maintainer - enable tests - remove git dep - enable parallel building - add pandoc dep for man page - nitpicks

Mic92 · 2017-10-08T10:22:23Z

Only a minor thing: /bin/kill can be replaced here by ${pkgs.procps}/bin/kill

$ cat lib/systemd/system/biboumi.service
[Unit]
Description=Biboumi, XMPP to IRC gateway
Documentation=man:biboumi(1) https://biboumi.louiz.org
After=network.target
[Service]
Type=notify
ExecStart=/nix/store/8gk42zf0pd2k3p6xbd1yfglv2jqrfl4z-biboumi-6.1/bin/biboumi /nix/store/8gk42zf0pd2k3p6xbd1yfglv2jqrfl4z-biboumi-6.1/etc/biboumi/biboumi.cfg
ExecReload=/bin/kill -s USR1 $MAINPID
WatchdogSec=20
Restart=always
User=nobody
Group=nobody
[Install]
WantedBy=multi-user.target

This service could be also changed to use the new DynamicUser, but this could actually proposed to upstream.

louiz · 2017-10-08T12:57:12Z

This service could be also changed to use the new DynamicUser, but this could actually proposed to upstream.

Would that also work for the case where the process needs to read and write into /var/lib/biboumi, to save its database?
And what are the advantages of DynamicUser?

Mic92 · 2017-10-08T14:29:18Z

@louiz no it is not suitable, if a service stores persistent data. I had the intention that biboumi was a pure network service. DynamicUser has the advantage over using nobody, that no other service/user will have the same uid/gid. Hence you cannot expose data/resources by accident. I would not recommend nobody as user, if the service stores persistent data because a different service might be able to read/write to /var/lib/biboumi.

Mic92 · 2017-10-08T14:32:30Z

For nixos it might be also interesting how many files, the daemon would store in this directory.
We chmod on startup the database directory and allocate static uid/gids for the username, if a services stores many files (to avoid recursive chmod).

louiz · 2017-10-08T15:48:47Z

At the moment, biboumi only store one file here: /var/lib/biboumi/biboumi.sqlite

It’s a file created by sqlite3, storing the whole database.

This is optional (if biboumi is compiled without the sqlite3 support), that’s why it’s nobody:nobody by default, in the case where biboumi doesn’t use any database.

In the future, biboumi might also be able to use postgresql too.

- only CMakeLists.txt has to be patched regarding /etc/biboumi - substitute /bin/kill in systemd service file - prepare for configuring policy_directory in a future cfg file

Mic92 · 2017-10-10T08:05:10Z

@louiz I just read that systemd can also change owners of directories with DynamicUser http://0pointer.net/blog/dynamic-users-with-systemd.html

louiz · 2017-10-10T18:43:51Z

Thank you, that’s very interesting! I’ll probably use that in the upstream biboumi.service file.

Mic92 reviewed Oct 7, 2017

View reviewed changes

woffs added 2 commits October 7, 2017 23:04

biboumi: init at 6.1

1d6b94a

TODO: integrate config in NixOS

biboumi: remove external buildtime dep

a6bd614

- fetch catch.hpp in a reproducible way - add maintainer - enable tests - remove git dep - enable parallel building - add pandoc dep for man page - nitpicks

woffs force-pushed the biboumi branch from 832ff73 to a6bd614 Compare October 7, 2017 21:05

biboumi: refine substitutions

ca0e39b

- only CMakeLists.txt has to be patched regarding /etc/biboumi - substitute /bin/kill in systemd service file - prepare for configuring policy_directory in a future cfg file

joachifm merged commit 916c0a6 into NixOS:master Oct 20, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

biboumi: init at 6.1 #30193

biboumi: init at 6.1 #30193

woffs commented Oct 7, 2017 •

edited

Mic92 Oct 7, 2017

woffs Oct 7, 2017

Mic92 Oct 7, 2017

Mic92 Oct 7, 2017

woffs Oct 7, 2017

Mic92 Oct 7, 2017

woffs Oct 7, 2017

Mic92 Oct 7, 2017

woffs Oct 7, 2017

Mic92 Oct 7, 2017 •

edited

woffs Oct 8, 2017

Mic92 commented Oct 8, 2017 •

edited

louiz commented Oct 8, 2017

Mic92 commented Oct 8, 2017 •

edited

Mic92 commented Oct 8, 2017 •

edited

louiz commented Oct 8, 2017

Mic92 commented Oct 10, 2017 •

edited

louiz commented Oct 10, 2017

biboumi: init at 6.1 #30193

biboumi: init at 6.1 #30193

Conversation

woffs commented Oct 7, 2017 • edited

Motivation for this change

Things done

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mic92 Oct 7, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mic92 commented Oct 8, 2017 • edited

louiz commented Oct 8, 2017

Mic92 commented Oct 8, 2017 • edited

Mic92 commented Oct 8, 2017 • edited

louiz commented Oct 8, 2017

Mic92 commented Oct 10, 2017 • edited

louiz commented Oct 10, 2017

woffs commented Oct 7, 2017 •

edited

Mic92 Oct 7, 2017 •

edited

Mic92 commented Oct 8, 2017 •

edited

Mic92 commented Oct 8, 2017 •

edited

Mic92 commented Oct 8, 2017 •

edited

Mic92 commented Oct 10, 2017 •

edited