1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="security_context_v1">
<copyright>
Copyright © 2021 Simon Ser
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
</copyright>
<interface name="wp_security_context_manager_v1" version="1">
<description summary="client security context manager">
This interface allows a client to register a new Wayland connection to
the compositor and attach a security context to it.
This is intended to be used by sandboxes. Sandbox engines attach a
security context to all connections coming from inside the sandbox. The
compositor can then restrict the features that the sandboxed connections
can use.
Compositors should forbid nesting multiple security contexts by not
exposing wp_security_context_manager_v1 global to clients with a security
context attached, or by sending the nested protocol error. Nested
security contexts are dangerous because they can potentially allow
privilege escalation of a sandboxed client.
Warning! The protocol described in this file is currently in the testing
phase. Backward compatible changes may be added together with the
corresponding interface version bump. Backward incompatible changes can
only be done by creating a new major version of the extension.
</description>
<enum name="error">
<entry name="invalid_listen_fd" value="1"
summary="listening socket FD is invalid"/>
<entry name="nested" value="2"
summary="nested security contexts are forbidden"/>
</enum>
<request name="destroy" type="destructor">
<description summary="destroy the manager object">
Destroy the manager. This doesn't destroy objects created with the
manager.
</description>
</request>
<request name="create_listener">
<description summary="create a new security context">
Creates a new security context with a socket listening FD.
The compositor will accept new client connections on listen_fd.
listen_fd must be ready to accept new connections when this request is
sent by the client. In other words, the client must call bind(2) and
listen(2) before sending the FD.
close_fd is a FD that will signal hangup when the compositor should stop
accepting new connections on listen_fd.
The compositor must continue to accept connections on listen_fd when
the Wayland client which created the security context disconnects.
After sending this request, closing listen_fd and close_fd remains the
only valid operation on them.
</description>
<arg name="id" type="new_id" interface="wp_security_context_v1"/>
<arg name="listen_fd" type="fd" summary="listening socket FD"/>
<arg name="close_fd" type="fd" summary="FD signaling when done"/>
</request>
</interface>
<interface name="wp_security_context_v1" version="1">
<description summary="client security context">
The security context allows a client to register a new client and attach
security context metadata to the connections.
When both are set, the combination of the application ID and the sandbox
engine must uniquely identify an application. The same application ID
will be used across instances (e.g. if the application is restarted, or
if the application is started multiple times).
When both are set, the combination of the instance ID and the sandbox
engine must uniquely identify a running instance of an application.
</description>
<enum name="error">
<entry name="already_used" value="1"
summary="security context has already been committed"/>
<entry name="already_set" value="2"
summary="metadata has already been set"/>
<entry name="invalid_metadata" value="3"
summary="metadata is invalid"/>
</enum>
<request name="destroy" type="destructor">
<description summary="destroy the security context object">
Destroy the security context object.
</description>
</request>
<request name="set_sandbox_engine">
<description summary="set the sandbox engine">
Attach a unique sandbox engine name to the security context. The name
should follow the reverse-DNS style (e.g. "org.flatpak").
A list of well-known engines is maintained at:
https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/staging/security-context/engines.md
It is a protocol error to call this request twice. The already_set
error is sent in this case.
</description>
<arg name="name" type="string" summary="the sandbox engine name"/>
</request>
<request name="set_app_id">
<description summary="set the application ID">
Attach an application ID to the security context.
The application ID is an opaque, sandbox-specific identifier for an
application. See the well-known engines document for more details:
https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/staging/security-context/engines.md
The compositor may use the application ID to group clients belonging to
the same security context application.
Whether this request is optional or not depends on the sandbox engine used.
It is a protocol error to call this request twice. The already_set
error is sent in this case.
</description>
<arg name="app_id" type="string" summary="the application ID"/>
</request>
<request name="set_instance_id">
<description summary="set the instance ID">
Attach an instance ID to the security context.
The instance ID is an opaque, sandbox-specific identifier for a running
instance of an application. See the well-known engines document for
more details:
https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/staging/security-context/engines.md
Whether this request is optional or not depends on the sandbox engine used.
It is a protocol error to call this request twice. The already_set
error is sent in this case.
</description>
<arg name="instance_id" type="string" summary="the instance ID"/>
</request>
<request name="commit">
<description summary="register the security context">
Atomically register the new client and attach the security context
metadata.
If the provided metadata is inconsistent or does not match with out of
band metadata (see
https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/staging/security-context/engines.md),
the invalid_metadata error may be sent eventually.
It's a protocol error to send any request other than "destroy" after
this request. In this case, the already_used error is sent.
</description>
</request>
</interface>
</protocol>
|
