1<?xml version="1.0" encoding="UTF-8"?> 2<protocol name="secure_output_unstable_v1"> 3 4 <copyright> 5 Copyright 2016 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 providing secure output"> 28 This protocol specifies a set of interfaces used to prevent surface 29 contents from appearing in screenshots or from being visible on non-secure 30 outputs. 31 32 In order to prevent surface contents from appearing in screenshots or from 33 being visible on non-secure outputs, a client must first bind the global 34 interface "wp_secure_output" which, if a compositor supports secure output, 35 is exposed by the registry. Using the bound global object, the client uses 36 the "get_security" request to instantiate an interface extension for a 37 wl_surface object. This extended interface will then allow surfaces 38 to be marked as only visible on secure outputs. 39 40 Warning! The protocol described in this file is experimental and backward 41 incompatible changes may be made. Backward compatible changes may be added 42 together with the corresponding interface version bump. Backward 43 incompatible changes are done by bumping the version number in the protocol 44 and interface names and resetting the interface version. Once the protocol 45 is to be declared stable, the 'z' prefix and the version number in the 46 protocol and interface names are removed and the interface version number is 47 reset. 48 </description> 49 50 <interface name="zcr_secure_output_v1" version="1"> 51 <description summary="secure output"> 52 The global interface exposing secure output capabilities is used 53 to instantiate an interface extension for a wl_surface object. 54 This extended interface will then allow surfaces to be marked as 55 as only visible on secure outputs. 56 </description> 57 58 <request name="destroy" type="destructor"> 59 <description summary="unbind from the secure output interface"> 60 Informs the server that the client will not be using this 61 protocol object anymore. This does not affect any other objects, 62 security objects included. 63 </description> 64 </request> 65 66 <enum name="error"> 67 <entry name="security_exists" value="0" 68 summary="the surface already has a security object associated"/> 69 </enum> 70 71 <request name="get_security"> 72 <description summary="extend surface interface for security"> 73 Instantiate an interface extension for the given wl_surface to 74 provide surface security. If the given wl_surface already has 75 a security object associated, the security_exists protocol error 76 is raised. 77 </description> 78 79 <arg name="id" type="new_id" interface="zcr_security_v1" 80 summary="the new security interface id"/> 81 <arg name="surface" type="object" interface="wl_surface" 82 summary="the surface"/> 83 </request> 84 </interface> 85 86 <interface name="zcr_security_v1" version="1"> 87 <description summary="security interface to a wl_surface"> 88 An additional interface to a wl_surface object, which allows the 89 client to specify that a surface should not appear in screenshots 90 or be visible on non-secure outputs. 91 92 If the wl_surface associated with the security object is destroyed, 93 the security object becomes inert. 94 95 If the security object is destroyed, the security state is removed 96 from the wl_surface. The change will be applied on the next 97 wl_surface.commit. 98 </description> 99 100 <request name="destroy" type="destructor"> 101 <description summary="remove security from the surface"> 102 The associated wl_surface's security state is removed. 103 The change is applied on the next wl_surface.commit. 104 </description> 105 </request> 106 107 <request name="only_visible_on_secure_output"> 108 <description summary="set the only visible on secure output state"> 109 Constrain visibility of wl_surface contents to secure outputs. 110 See wp_secure_output for the description. 111 112 The only visible on secure output state is double-buffered state, 113 and will be applied on the next wl_surface.commit. 114 </description> 115 </request> 116 </interface> 117 118</protocol> 119