1libpipewire-module-accesMsi(s7c)ellaneous Information Malniubaplipewire-module-access(7)
2
3
4
6 libpipewire-module-access - Access
7
9 The access module performs access checks on clients.
10
11 The access check is only performed once per client, subsequent checks
12 return the same resolution.
13
14 Permissions assigned to a client are configured as arguments to this
15 module, see below. Permission management beyond unrestricted access is
16 delegated to an external agent, usually the session manager.
17
18 This module sets the pipewire.access as follows:
19
20 • If access.legacy module option is not enabled:
21
22 The value defined for the socket in access.socket module option, or
23 'default' if no value is defined.
24
25 • If access.legacy is enabled, the value is:
26
27 • 'flatpak': if client is a Flatpak client
28
29 • Value of pipewire.client.access client property, if set
30
31 • 'unrestricted': otherwise
32
33 If the resulting pipewire.access value is 'unrestricted', this module
34 will give the client all permissions to access all resources.
35 Otherwise, the client will be forced to wait until an external actor,
36 such as the session manager, updates the client permissions.
37
38 For connections from applications running inside Flatpak, and not
39 mediated by other clients (eg. portal or pipewire-pulse), the
40 pipewire.access.portal.app_id property is to the Flatpak application
41 ID, if found. In addition, pipewire.sec.flatpak is set to true.
42
44 libpipewire-module-access
45
47 Options specific to the behavior of this module
48
49 • access.socket = { 'socket-name' = 'access-value', ... }:
50
51 Socket-specific access permissions. Has the default value { 'CORENAME-
52 manager': 'unrestricted' } where CORENAME is the name of the PipeWire
53 core, usually pipewire-0.
54
55 • access.legacy = true: enable backward-compatible access mode. Cannot
56 be enabled when using socket-based permissions.
57
58 If access.socket is not specified, has the default value true otherwise
59 false.
60
61 Warning
62 The legacy mode is deprecated. The default value is subject to
63 change and the legacy mode may be removed in future PipeWire
64 releases.
65
67 Options with well-known behavior:
68
69 • pipewire.access
70
71 • pipewire.client.access
72
74 context.modules = [
75 { name = libpipewire-module-access
76 args = {
77 # Use separate socket for session manager applications,
78 # and pipewire-0 for usual applications.
79 access.socket = {
80 pipewire-0 = "default",
81 pipewire-0-manager = "unrestricted",
82 }
83 }
84 }
85 ]
86
87 See also
88 pw_resource_error
89
90 pw_impl_client_update_permissions
91
92PipeWire 1.0.0 libpipewire-module-access(7)