]>
Commit | Line | Data |
---|---|---|
7d9ad0e5 LP |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
db9ecf05 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
7d9ad0e5 LP |
5 | |
6 | <refentry id="systemd-userdbd.service" conditional='ENABLE_USERDB'> | |
7 | ||
8 | <refentryinfo> | |
9 | <title>systemd-userdbd.service</title> | |
10 | <productname>systemd</productname> | |
11 | </refentryinfo> | |
12 | ||
13 | <refmeta> | |
14 | <refentrytitle>systemd-userdbd.service</refentrytitle> | |
15 | <manvolnum>8</manvolnum> | |
16 | </refmeta> | |
17 | ||
18 | <refnamediv> | |
19 | <refname>systemd-userdbd.service</refname> | |
20 | <refname>systemd-userdbd</refname> | |
21 | <refpurpose>JSON User/Group Record Query Multiplexer/NSS Compatibility</refpurpose> | |
22 | </refnamediv> | |
23 | ||
24 | <refsynopsisdiv> | |
25 | <para><filename>systemd-userdbd.service</filename></para> | |
26 | <para><filename>/usr/lib/systemd/systemd-userdbd</filename></para> | |
27 | </refsynopsisdiv> | |
28 | ||
29 | <refsect1> | |
30 | <title>Description</title> | |
31 | ||
32 | <para><command>systemd-userdbd</command> is a system service that multiplexes user/group lookups to all | |
33 | local services that provide JSON user/group record definitions to the system. In addition it synthesizes | |
34 | JSON user/group records from classic UNIX/glibc NSS user/group records in order to provide full backwards | |
35 | compatibility.</para> | |
36 | ||
37 | <para>Most of <command>systemd-userdbd</command>'s functionality is accessible through the | |
38 | <citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
39 | command.</para> | |
40 | ||
41 | <para>The user and group records this service provides access to follow the <ulink | |
42 | url="https://systemd.io/USER_RECORD">JSON User Record</ulink> and <ulink | |
43 | url="https://systemd.io/GROUP_RECORD">JSON Group Record</ulink> definitions. This service implements the | |
44 | <ulink url="https://systemd.io/USER_GROUP_API">User/Group Record Lookup API via Varlink</ulink>, and | |
45 | multiplexes access other services implementing this API, too. It is thus both server and client of this | |
46 | API.</para> | |
47 | ||
48 | <para>This service provides two distinct <ulink url="https://varlink.org/">Varlink</ulink> services: | |
49 | <constant>io.systemd.Multiplexer</constant> provides a single, unified API for querying JSON user and | |
50 | group records. Internally it talks to all other user/group record services running on the system in | |
51 | parallel and forwards any information discovered. This simplifies clients substantially since they need | |
52 | to talk to a single service only instead of all of them in | |
53 | parallel. <constant>io.systemd.NameSeviceSwitch</constant> provides compatibility with classic UNIX/glibc | |
54 | NSS user records, i.e. converts <type>struct passwd</type> and <type>struct group</type> records as | |
55 | acquired with APIs such as <citerefentry | |
56 | project='man-pages'><refentrytitle>getpwnam</refentrytitle><manvolnum>1</manvolnum></citerefentry> to JSON | |
57 | user/group records, thus hiding the differences between the services as much as possible.</para> | |
58 | </refsect1> | |
59 | ||
60 | <refsect1> | |
61 | <title>See Also</title> | |
62 | <para> | |
63 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
64 | <citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
65 | <citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
66 | <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
67 | </para> | |
68 | </refsect1> | |
69 | </refentry> |