xml/org.freedesktop.atspi.LoginHelper.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
   3
   4
   5
   6
   7
   8 <interface name="org.freedesktop.atspi.LoginHelper">
   9   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  10     <p>@brief An interface for use by assistive technologies by which
  11       they can access system information and services on a 'need to know'
  12       basis while the screen is locked, during user authentication, or
  13       during other sensitive operations.  </p>
  14
  15     <p>This interface is intended for use by assistive technologies
  16       and related user-enabling services, and by applications and
  17       utilities which may wish to restrict access to certain system
  18       devices and services during security-sensitive states, e.g. when
  19       the screen is locked or during authentication into some secure
  20       service.  </p>
  21
  22     <p>Such 'applications' (for instance, screen lock dialogs and
  23       security-enabled web browsers) use the ::LoginHelper client
  24       interfaces, and the bonobo-activation query service, to
  25       query for assistive technologies which advertise the ::LoginHelper
  26       service.  The client then queries these assistive technologies
  27       for their device I/O requirements, via the ::getDeviceReqs call.
  28       The client may then issue the advisory request ::setSafe (TRUE),
  29       which requests that the ::LoginHelper -implementing service make a
  30       best-effort attempt to make itself more secure (for instance,
  31       an onscreen keyboard might turn off word prediction, and a
  32       screenreader may turn off keyboard echo via speech).  The return
  33       value of ::setSafe is an advisory indication of whether this attempt
  34       was successful (no specific guarantees are implied).
  35       Once the 'security sensitive' state is exited, the client should
  36       call ::setSafe (FALSE).  </p>
  37
  38     <p>The return values from ::getDeviceReqs inform the client of which
  39       services the ::LoginHelper service (e. g. assistive technology) needs
  40       in order to do its job.  The client may use this information to
  41       loosen any restrictions on access which it may currently have in
  42       place (for instance, keyboard grabs, etc.).  If it does not do so,
  43       the likely outcome is that the end-user will experience loss
  44       of access to the system.  </p>
  45   </tp:docstring>
  46   <tp:struct name="WindowInfo">
  47     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  48       <p>A structure containing info about toplevel X windows that
  49         the ::LoginHelper instance wishes to have raised.    </p>
  50     </tp:docstring>
  51     <tp:member type="i" tp:name="winID">
  52     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  53       <p>string display;
  54         short screen; </p>
  55     </tp:docstring>
  56     </tp:member>
  57   </tp:struct>
  58   <tp:enum name="DeviceReq" type="u">
  59     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  60       <p>DeviceReq:    </p>
  61
  62       <p>The system and device access and services which the LoginHelper-implementing
  63         assistive technology requires in order to enable the user to use the system.    </p>
  64     </tp:docstring>
  65     <tp:enumvalue suffix="GUI_EVENTS">
  66     <tp:docstring>
  67       !&lt;: Needs access to the GUI event subsystem (e.g. Xserver)
  68     </tp:docstring>
  69     </tp:enumvalue>
  70     <tp:enumvalue suffix="CORE_KEYBOARD" value="1">
  71     <tp:docstring>
  72       !&lt;: Needs access to the system keyboard events (read and write)
  73     </tp:docstring>
  74     </tp:enumvalue>
  75     <tp:enumvalue suffix="CORE_POINTER" value="2">
  76     <tp:docstring>
  77       !&lt;: Needs access to the onscreen pointer (e.g. mouse pointer)
  78     </tp:docstring>
  79     </tp:enumvalue>
  80     <tp:enumvalue suffix="EXT_INPUT" value="3">
  81     <tp:docstring>
  82       !&lt;: Reads XInput extended input devices
  83     </tp:docstring>
  84     </tp:enumvalue>
  85     <tp:enumvalue suffix="POST_WINDOWS" value="4">
  86     <tp:docstring>
  87       !&lt;: Posts Windows, and needs for toplevel windows to be visible
  88     </tp:docstring>
  89     </tp:enumvalue>
  90     <tp:enumvalue suffix="AUDIO_OUT" value="5">
  91     <tp:docstring>
  92       !&lt;: Writes to audio device
  93     </tp:docstring>
  94     </tp:enumvalue>
  95     <tp:enumvalue suffix="AUDIO_IN" value="6">
  96     <tp:docstring>
  97       !&lt;: Reads from audio device
  98     </tp:docstring>
  99     </tp:enumvalue>
 100     <tp:enumvalue suffix="NETWORK" value="7">
 101     <tp:docstring>
 102       !&lt;: Requires access to general network services, including remote access
 103     </tp:docstring>
 104     </tp:enumvalue>
 105     <tp:enumvalue suffix="LOCALHOST" value="8">
 106     <tp:docstring>
 107       !&lt;: Requires network services hosted on LOCALHOST only
 108     </tp:docstring>
 109     </tp:enumvalue>
 110     <tp:enumvalue suffix="SERIAL_OUT" value="9">
 111     <tp:docstring>
 112       !&lt;: Writes to a serial port
 113     </tp:docstring>
 114     </tp:enumvalue>
 115     <tp:enumvalue suffix="SERIAL_IN" value="10">
 116     <tp:docstring>
 117       !&lt;: Reads from a serial port
 118     </tp:docstring>
 119     </tp:enumvalue>
 120   </tp:enum>
 121   <method name="setSafe">
 122     <tp:docstring>
 123       setSafe:
 124     </tp:docstring>
 125     <arg direction="in" name="safe_mode" type="b" tp:type="boolean">
 126     <tp:docstring>
 127       \c TRUE if the client is requesting that 'safe mode' be initiated, \c FALSE if the client is advising that 'safe mode' may beexited, i.e. normal operation may be resumed.Request a LoginHelper to enter "safe" mode, orinform LoginHelper that "safe" mode may be exited.If \a safe_mode is \c TRUE, but the return value is \c FALSE,the requesting client may wish to deny services to the ::LoginHelper, for instance avoid raising its toplevels.The return value is purely advisory, and no guarantees are intended about what the implementing LoginHelper will do to improve security when in "safe" mode.
 128     </tp:docstring>
 129     </arg>
 130     <arg direction="out" type="b" tp:type="boolean">
 131     <tp:docstring>
 132       whether the ::LoginHelper is now "safe" or not.
 133     </tp:docstring>
 134     </arg>
 135   </method>
 136   <method name="getDeviceReqs">
 137     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 138       <p>getDeviceReqs:    </p>
 139
 140       <p>Query a ::LoginHelper for the types of
 141         device I/O it requires, in order to do its job.
 142         For instance, a ::LoginHelper which needs to receive keyboard
 143         events will include
 144         Accessibility_LoginHelper_CORE_KEYBOARD in this list.    </p>
 145     </tp:docstring>
 146     <arg direction="out" type="u" tp:type="DeviceReqList">
 147     <tp:docstring>
 148       A sequence of ::LoginHelper_DeviceReq indicatingthe device I/O required in order to facilitate end-user access to the system.
 149     </tp:docstring>
 150     </arg>
 151   </method>
 152   <method name="getRaiseWindows">
 153     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 154       <p>getRaiseWindows:    </p>
 155
 156       <p>Get a list of window IDs that need raising on login.     </p>
 157     </tp:docstring>
 158     <arg direction="out" type="ai" tp:type="WindowList">
 159     <tp:docstring>
 160       a sequence containing window IDS for toplevels whichneed to be raised/made visible during user authentication, inorder for the ::LoginHelper to facilitate end-user access to the system.
 161     </tp:docstring>
 162     </arg>
 163   </method>
 164   <method name="unImplemented">
 165     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 166       <p>\cond
 167         unImplemented:    </p>
 168
 169       <p>placeholders for future expansion.</p>
 170     </tp:docstring>
 171   </method>
 172   <method name="unImplemented2">
 173   </method>
 174   <method name="unImplemented3">
 175   </method>
 176   <method name="unImplemented4">
 177   </method>
 178 </interface>
 179 </node>