OLD | NEW |
---|---|
(Empty) | |
1 <?xml version="1.0" encoding="UTF-8"?> | |
2 <protocol name="secure_contents_unstable_v1"> | |
3 | |
4 <copyright> | |
5 Copyright 2015 The Chromium Authors. | |
6 | |
7 Permission is hereby granted, free of charge, to any person obtaining a | |
8 copy of this software and associated documentation files (the "Software"), | |
9 to deal in the Software without restriction, including without limitation | |
10 the rights to use, copy, modify, merge, publish, distribute, sublicense, | |
11 and/or sell copies of the Software, and to permit persons to whom the | |
12 Software is furnished to do so, subject to the following conditions: | |
13 | |
14 The above copyright notice and this permission notice (including the next | |
15 paragraph) shall be included in all copies or substantial portions of the | |
16 Software. | |
17 | |
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
21 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | |
23 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | |
24 DEALINGS IN THE SOFTWARE. | |
25 </copyright> | |
26 | |
27 <description summary="Protocol for securing surface contents"> | |
Daniele Castagna
2016/03/16 18:15:00
nit: the other summaries seem to start with a lowe
| |
28 This protocol specifies a set of interfaces used to prevent surface | |
29 contents from appearing in screenshots or from being viewed on non-secure | |
Daniele Castagna
2016/03/16 18:15:00
Maybe displayed instead of viewed? Also, non-secur
| |
30 outputs. | |
31 | |
32 In order to secure surface contents, a client must first bind the global | |
33 interface "wp_secure_contents" which, if a compositor supports secure | |
34 contents, is exposed by the registry. Using the bound global object, the | |
35 client uses the "get_secure" request to instantiate an interface extension | |
36 for a wl_surface object. This extended interface will then allow surfaces | |
37 to be marked as having sensitive contents. | |
38 | |
39 Warning! The protocol described in this file is experimental and backward | |
40 incompatible changes may be made. Backward compatible changes may be added | |
41 together with the corresponding interface version bump. Backward | |
42 incompatible changes are done by bumping the version number in the protocol | |
43 and interface names and resetting the interface version. Once the protocol | |
44 is to be declared stable, the 'z' prefix and the version number in the | |
45 protocol and interface names are removed and the interface version number is | |
46 reset. | |
47 </description> | |
48 | |
49 <interface name="zwp_secure_contents_v1" version="1"> | |
50 <description summary="secure contents"> | |
51 The global interface exposing secure contents capabilities is used | |
52 to instantiate an interface extension for a wl_surface object. | |
53 This extended interface will then allow surfaces to be marked as | |
54 having sensitive contents, effectively preventing the surface from | |
55 from appearing in screenshots or from being viewed on non-secure | |
56 outputs. | |
57 </description> | |
58 | |
59 <request name="destroy" type="destructor"> | |
60 <description summary="unbind from the secure contents interface"> | |
61 Informs the server that the client will not be using this | |
Daniele Castagna
2016/03/16 18:15:00
Is the indentation correct?
| |
62 protocol object anymore. This does not affect any other objects, | |
63 secure objects included. | |
64 </description> | |
65 </request> | |
66 | |
67 <enum name="error"> | |
68 <entry name="secure_exists" value="0" | |
69 summary="the surface already has a secure object associated"/> | |
70 </enum> | |
71 | |
72 <request name="get_secure"> | |
73 <description summary="extend surface interface for secure contents"> | |
74 Instantiate an interface extension for the given wl_surface to | |
Daniele Castagna
2016/03/16 18:15:00
Indentation?
| |
75 provide securing of contents. If the given wl_surface already has | |
76 a secure object associated, the secure_exists protocol error | |
77 is raised. | |
78 </description> | |
79 | |
80 <arg name="id" type="new_id" interface="zwp_secure_v1" | |
81 summary="the new secure interface id"/> | |
82 <arg name="surface" type="object" interface="wl_surface" | |
83 summary="the surface"/> | |
84 </request> | |
85 </interface> | |
86 | |
87 <interface name="zwp_secure_v1" version="1"> | |
88 <description summary="secure interface to a wl_surface"> | |
89 An additional interface to a wl_surface object, which allows the | |
90 client to specify that a surface has sensitive surface contents. | |
91 | |
92 If the wl_surface associated with the secure object is destroyed, | |
93 the secure object becomes inert. | |
94 | |
95 If the secure object is destroyed, the sensitive contents | |
96 state is removed from the wl_surface. The change will be applied | |
97 on the next wl_surface.commit. | |
98 </description> | |
99 | |
100 <request name="destroy" type="destructor"> | |
101 <description summary="remove sensitive contents from the surface"> | |
102 The associated wl_surface's senstaive contents state is removed. | |
103 The change is applied on the next wl_surface.commit. | |
104 </description> | |
105 </request> | |
106 | |
107 <request name="enable_sensitive_contents"> | |
108 <description summary="set the sensitive contents state"> | |
109 Enable sensitive contents for wl_surface. See wp_secure_contents for | |
110 the description. | |
111 | |
112 The sensitive contents state is double-buffered state, and will be | |
113 applied on the next wl_surface.commit. | |
114 </description> | |
115 </request> | |
116 | |
117 </interface> | |
118 </protocol> | |
OLD | NEW |