Debian Codegraph @

src/shared/userdb.h

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include "shared-forward.h"
5 #include "group-record.h"
6 #include "user-record.h"
7
8 /* Inquire local services for user/group records */
9
10 typedef struct UserDBIterator UserDBIterator;
11
12 UserDBIterator *userdb_iterator_free(UserDBIterator *iterator);
13 DEFINE_TRIVIAL_CLEANUP_FUNC(UserDBIterator*, userdb_iterator_free);
14
15 typedef enum UserDBFlags {
16 /* The main sources */
17 USERDB_EXCLUDE_NSS = 1 << 0, /* don't do client-side nor server-side NSS */
18 USERDB_EXCLUDE_VARLINK = 1 << 1, /* don't talk to any varlink services */
19 USERDB_EXCLUDE_DROPIN = 1 << 2, /* don't load drop-in user/group definitions */
20
21 /* Modifications */
22 USERDB_SUPPRESS_SHADOW = 1 << 3, /* don't do client-side shadow calls (server side might happen though) */
23 USERDB_EXCLUDE_DYNAMIC_USER = 1 << 4, /* exclude looking up in io.systemd.DynamicUser */
24 USERDB_AVOID_MULTIPLEXER = 1 << 5, /* exclude looking up via io.systemd.Multiplexer */
25 USERDB_DONT_SYNTHESIZE_INTRINSIC = 1 << 6, /* don't synthesize root/nobody */
26 USERDB_DONT_SYNTHESIZE_FOREIGN = 1 << 7, /* don't synthesize foreign UID records */
27
28 /* Combinations */
29 USERDB_NSS_ONLY = USERDB_EXCLUDE_VARLINK|USERDB_EXCLUDE_DROPIN|USERDB_DONT_SYNTHESIZE_INTRINSIC|USERDB_DONT_SYNTHESIZE_FOREIGN,
30 USERDB_DROPIN_ONLY = USERDB_EXCLUDE_NSS|USERDB_EXCLUDE_VARLINK|USERDB_DONT_SYNTHESIZE_INTRINSIC|USERDB_DONT_SYNTHESIZE_FOREIGN,
31
32 USERDB_PARSE_NUMERIC = 1 << 8, /* if a numeric UID is specified as name, parse it and look up by UID/GID */
33 USERDB_SYNTHESIZE_NUMERIC = 1 << 9, /* synthesize system UID/GID even if it does not exist */
34 } UserDBFlags;
35
36 /* Well-known errors we'll return here:
37 *
38 * -ESRCH: No such user/group
39 * -ELINK: Varlink logic turned off (and no other source available)
40 * -EOPNOTSUPP: Enumeration not supported
41 * -ETIMEDOUT: Time-out
42 */
43
44 int userdb_by_name(const char *name, const UserDBMatch *match, UserDBFlags flags, UserRecord **ret);
45 int userdb_by_uid(uid_t uid, const UserDBMatch *match, UserDBFlags flags, UserRecord **ret);
46 int userdb_all(const UserDBMatch *match, UserDBFlags flags, UserDBIterator **ret);
47 int userdb_iterator_get(UserDBIterator *iterator, const UserDBMatch *match, UserRecord **ret);
48
49 int groupdb_by_name(const char *name, const UserDBMatch *match, UserDBFlags flags, GroupRecord **ret);
50 int groupdb_by_gid(gid_t gid, const UserDBMatch *match, UserDBFlags flags, GroupRecord **ret);
51 int groupdb_all(const UserDBMatch *match, UserDBFlags flags, UserDBIterator **ret);
52 int groupdb_iterator_get(UserDBIterator *iterator, const UserDBMatch *match, GroupRecord **ret);
53
54 int membershipdb_by_user(const char *name, UserDBFlags flags, UserDBIterator **ret);
55 int membershipdb_by_group(const char *name, UserDBFlags flags, UserDBIterator **ret);
56 int membershipdb_all(UserDBFlags flags, UserDBIterator **ret);
57 int membershipdb_iterator_get(UserDBIterator *iterator, char **user, char **group);
58 int membershipdb_by_group_strv(const char *name, UserDBFlags flags, char ***ret);
59
60 int userdb_block_nss_systemd(int b);