Debian Codegraph @

docs/rst/daemon/configuration/access.rst

raw
1 .. _config_access:
2
3 Access configuration
4 ====================
5
6 WirePlumber includes a "client access" policy which defines access control
7 rules for PipeWire clients.
8
9 Rules
10 -----
11
12 This policy can be configured with rules that can be used to match clients and
13 apply default permissions to them.
14
15 Example:
16
17 .. code-block::
18
19 access.rules = [
20 {
21 matches = [
22 {
23 access = "flatpak"
24 media.category = "Manager"
25 }
26 ]
27 actions = {
28 update-props = {
29 access = "flatpak-manager"
30 default_permissions = "all",
31 }
32 }
33 }
34 {
35 matches = [
36 {
37 access = "flatpak"
38 }
39 ]
40 actions = {
41 update-props = {
42 default_permissions = "rx"
43 }
44 }
45 }
46 ]
47
48 Possible permissions are any combination of:
49
50 * ``r``: client is allowed to **read** objects, i.e. "see" them on the registry
51 and list their properties
52 * ``w``: client is allowed to **write** objects, i.e. call methods that modify
53 their state
54 * ``x``: client is allowed to **execute** methods on objects; the ``w`` flag
55 must also be present to call methods that modify the object
56 * ``m``: client is allowed to set **metadata** on objects
57 * ``l``: nodes of this client are allowed to **link** to other nodes that the
58 client can't "see" (i.e. the client doesn't have ``r`` permission on them)
59
60 The special value ``all`` is also supported and it is synonym for ``rwxm``