This file is indexed.

/usr/share/dbus-1/interfaces/net.reactivated.Fprint.Device.xml is in fprintd 0.5.1-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
<!ENTITY ERROR_CLAIM_DEVICE "net.reactivated.Fprint.Error.ClaimDevice">
<!ENTITY ERROR_ALREADY_IN_USE "net.reactivated.Fprint.Error.AlreadyInUse">
<!ENTITY ERROR_INTERNAL "net.reactivated.Fprint.Error.Internal">
<!ENTITY ERROR_PERMISSION_DENIED "net.reactivated.Fprint.Error.PermissionDenied">
<!ENTITY ERROR_NO_ENROLLED_PRINTS "net.reactivated.Fprint.Error.NoEnrolledPrints">
<!ENTITY ERROR_NO_ACTION_IN_PROGRESS "net.reactivated.Fprint.Error.NoActionInProgress">
<!ENTITY ERROR_INVALID_FINGERNAME "net.reactivated.Fprint.Error.InvalidFingername">
]>

<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
	<interface name="net.reactivated.Fprint.Device">
		<annotation name="org.freedesktop.DBus.GLib.CSymbol"
			value="fprint_device" />

		<doc:doc>
			<doc:title id="polkit-integration">
				PolicyKit integration
			</doc:title>
			<doc:para>
				fprintd uses PolicyKit to check whether users are allowed to access fingerprint data, or the
				fingerprint readers itself.
				<doc:list>
					<doc:item>
						<doc:term>net.reactivated.fprint.device.verify</doc:term>
						<doc:definition>
							Whether the user is allowed to verify fingers against saved fingerprints.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>net.reactivated.fprint.device.enroll</doc:term>
						<doc:definition>
							Whether the user is allowed to enroll new fingerprints.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>net.reactivated.fprint.device.setusername</doc:term>
						<doc:definition>
							Whether the user is allowed to query, verify, or enroll fingerprints for users other than itself.
						</doc:definition>
					</doc:item>
				</doc:list>
			</doc:para>

			<doc:title id="usernames">
				Usernames
			</doc:title>
			<doc:para>
				When a username argument is used for a method, a PolicyKit check is done on the
				<doc:tt>net.reactivated.fprint.device.setusername</doc:tt> PolicyKit
				action to see whether the user the client is running as is allowed to access data from other users.
			</doc:para>
			<doc:para>
				By default, only root is allowed to access fingerprint data for users other than itself. For a normal user,
				it is recommended that you use an empty string for the username, which will mean "the client the user is
				running as".
			</doc:para>
			<doc:para>
				See <doc:ref type="description" to="polkit-integration">PolicyKit integration</doc:ref>.
			</doc:para>

			<doc:title id="fingerprint-names">
				Fingerprint names
			</doc:title>
			<doc:para>
				When a finger name argument is used for a method, it refers to either a single finger, or
				"any" finger. See the list of possible values below:
				<doc:list>
					<doc:item>
						<doc:term>left-thumb</doc:term>
						<doc:definition>
							Left thumb
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>left-index-finger</doc:term>
						<doc:definition>
							Left index finger
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>left-middle-finger</doc:term>
						<doc:definition>
							Left middle finger
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>left-ring-finger</doc:term>
						<doc:definition>
							Left ring finger
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>left-little-finger</doc:term>
						<doc:definition>
							Left little finger
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>right-thumb</doc:term>
						<doc:definition>
							Right thumb
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>right-index-finger</doc:term>
						<doc:definition>
							Right index finger
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>right-middle-finger</doc:term>
						<doc:definition>
							Right middle finger
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>right-ring-finger</doc:term>
						<doc:definition>
							Right ring finger
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>right-little-finger</doc:term>
						<doc:definition>
							Right little finger
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>any</doc:term>
						<doc:definition>
							Any finger. This is only used for <doc:ref type="method" to="Device.VerifyStart">Device.VerifyStart</doc:ref>
							(select the first finger with a fingerprint associated, or all the fingerprints available for the user when
							the device supports it) and <doc:ref type="signal" to="Device::VerifyFingerSelected">Device::VerifyFingerSelected</doc:ref>
							(any finger with an associated fingerprint can be used).
						</doc:definition>
					</doc:item>
				</doc:list>
			</doc:para>

			<doc:title id="verify-statuses">
				Verify Statuses
			</doc:title>
			<doc:para>
				<doc:list>
					Possible values for the result passed through <doc:ref type="signal" to="Device::VerifyResult">Device::VerifyResult</doc:ref> are:
					<doc:item>
						<doc:term>verify-no-match</doc:term>
						<doc:definition>
							The verification did not match, <doc:ref type="method" to="Device.VerifyStop">Device.VerifyStop</doc:ref> should now be called.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>verify-match</doc:term>
						<doc:definition>
							The verification succeeded, <doc:ref type="method" to="Device.VerifyStop">Device.VerifyStop</doc:ref> should now be called.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>verify-retry-scan</doc:term>
						<doc:definition>
							The user should retry scanning their finger, the verification is still ongoing.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>verify-swipe-too-short</doc:term>
						<doc:definition>
							The user's swipe was too short. The user should retry scanning their finger, the verification is still ongoing.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>verify-finger-not-centered</doc:term>
						<doc:definition>
							The user's finger was not centered on the reader. The user should retry scanning their finger, the verification is still ongoing.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>verify-remove-and-retry</doc:term>
						<doc:definition>
							The user should remove their finger from the reader and retry scanning their finger, the verification is still ongoing.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>verify-disconnected</doc:term>
						<doc:definition>
							The device was disconnected during the verification, no other actions should be taken, and you shouldn't use the device any more.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>verify-unknown-error</doc:term>
						<doc:definition>
							An unknown error occurred (usually a driver problem), <doc:ref type="method" to="Device.VerifyStop">Device.VerifyStop</doc:ref> should now be called.
						</doc:definition>
					</doc:item>
				</doc:list>
			</doc:para>

			<doc:title id="enroll-statuses">
				Enroll Statuses
			</doc:title>
			<doc:para>
				<doc:list>
					Possible values for the result passed through <doc:ref type="signal" to="Device::EnrollResult">Device::EnrollResult</doc:ref> are:
					<doc:item>
						<doc:term>enroll-completed</doc:term>
						<doc:definition>
							The enrollment successfully completed, <doc:ref type="method" to="Device.EnrollStop">Device.EnrollStop</doc:ref> should now be called.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>enroll-failed</doc:term>
						<doc:definition>
							The enrollment failed, <doc:ref type="method" to="Device.EnrollStop">Device.EnrollStop</doc:ref> should now be called.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>enroll-stage-passed</doc:term>
						<doc:definition>
							One stage of the enrollment passed, the enrollment is still ongoing.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>enroll-retry-scan</doc:term>
						<doc:definition>
							The user should retry scanning their finger, the enrollment is still ongoing.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>enroll-swipe-too-short</doc:term>
						<doc:definition>
							The user's swipe was too short. The user should retry scanning their finger, the enrollment is still ongoing.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>enroll-finger-not-centered</doc:term>
						<doc:definition>
							The user's finger was not centered on the reader. The user should retry scanning their finger, the enrollment is still ongoing.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>enroll-remove-and-retry</doc:term>
						<doc:definition>
							The user should remove their finger from the reader and retry scanning their finger, the enrollment is still ongoing.
						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>enroll-disconnected</doc:term>
						<doc:definition>
							The device was disconnected during the enrollment, no other actions should be taken, and you shouldn't use the device any more.

						</doc:definition>
					</doc:item>
					<doc:item>
						<doc:term>enroll-unknown-error</doc:term>
						<doc:definition>
							An unknown error occurred (usually a driver problem), <doc:ref type="method" to="Device.EnrollStop">Device.EnrollStop</doc:ref> should now be called.

						</doc:definition>
					</doc:item>
				</doc:list>
			</doc:para>
		</doc:doc>

		<!-- ************************************************************ -->

		<method name="ListEnrolledFingers">
			<arg type="s" name="username" direction="in">
				<doc:doc><doc:summary>The username for whom to list the enrolled fingerprints. See <doc:ref type="description" to="usernames">Usernames</doc:ref>.</doc:summary></doc:doc>
			</arg>
			<arg type="as" name="enrolled_fingers" direction="out">
				<doc:doc><doc:summary>An array of strings representing the enrolled fingerprints. See <doc:ref type="description" to="fingerprint-names">Fingerprint names</doc:ref>.</doc:summary></doc:doc>
			</arg>
			<annotation name="org.freedesktop.DBus.GLib.Async" value="" />

			<doc:doc>
				<doc:description>
					<doc:para>
						List all the enrolled fingerprints for the chosen user.
					</doc:para>
				</doc:description>

				<doc:errors>
					<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error>
					<doc:error name="&ERROR_NO_ENROLLED_PRINTS;">if the chosen user doesn't have any fingerprints enrolled</doc:error>
				</doc:errors>
			</doc:doc>
		</method>

		<!-- ************************************************************ -->

		<method name="DeleteEnrolledFingers">
			<arg type="s" name="username" direction="in">
				<doc:doc><doc:summary>The username for whom to delete the enrolled fingerprints. See <doc:ref type="description" to="usernames">Usernames</doc:ref>.</doc:summary></doc:doc>
			</arg>
			<annotation name="org.freedesktop.DBus.GLib.Async" value="" />

			<doc:doc>
				<doc:description>
					<doc:para>
						Delete all the enrolled fingerprints for the chosen user.
					</doc:para>
				</doc:description>

				<doc:errors>
					<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error>
				</doc:errors>
			</doc:doc>
		</method>

		<!-- ************************************************************ -->

		<method name="Claim">
			<arg type="s" name="username" direction="in">
				<doc:doc><doc:summary>The username for whom to claim the device. See <doc:ref type="description" to="usernames">Usernames</doc:ref>.</doc:summary></doc:doc>
			</arg>
			<annotation name="org.freedesktop.DBus.GLib.Async" value="" />

			<doc:doc>
				<doc:description>
					<doc:para>
						Claim the device for the chosen user.
					</doc:para>
				</doc:description>

				<doc:errors>
					<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error>
					<doc:error name="&ERROR_ALREADY_IN_USE;">if the device is already claimed</doc:error>
					<doc:error name="&ERROR_INTERNAL;">if the device couldn't be claimed</doc:error>
				</doc:errors>
			</doc:doc>
		</method>

		<!-- ************************************************************ -->

		<method name="Release">
			<annotation name="org.freedesktop.DBus.GLib.Async" value="" />

			<doc:doc>
				<doc:description>
					<doc:para>
						Release a device claimed with <doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref>.
					</doc:para>
				</doc:description>

				<doc:errors>
					<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error>
					<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error>
				</doc:errors>
			</doc:doc>
		</method>

		<!-- ************************************************************ -->

		<method name="VerifyStart">
			<arg type="s" name="finger_name" direction="in">
				<doc:doc><doc:summary>A string representing the finger to verify. See <doc:ref type="description" to="fingerprint-names">Fingerprint names</doc:ref>.</doc:summary></doc:doc>
			</arg>
			<annotation name="org.freedesktop.DBus.GLib.Async" value="" />

			<doc:doc>
				<doc:description>
					<doc:para>
						Check the chosen finger against a saved fingerprint. You need to have claimed the device using
						<doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref>. The finger selected is sent to the front-end
						using <doc:ref type="signal" to="Device::VerifyFingerSelected">Device::VerifyFingerSelected</doc:ref> and
						verification status through <doc:ref type="signal" to="Device::VerifyStatus">Device::VerifyStatus</doc:ref>.
					</doc:para>
				</doc:description>

				<doc:errors>
					<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error>
					<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error>
					<doc:error name="&ERROR_ALREADY_IN_USE;">if the device was already being used</doc:error>
					<doc:error name="&ERROR_NO_ENROLLED_PRINTS;">if there are no enrolled prints for the chosen user</doc:error>
					<doc:error name="&ERROR_INTERNAL;">if there was an internal error</doc:error>
				</doc:errors>
			</doc:doc>
		</method>

		<!-- ************************************************************ -->

		<method name="VerifyStop">
			<annotation name="org.freedesktop.DBus.GLib.Async" value="" />

			<doc:doc>
				<doc:description>
					<doc:para>
						Stop an on-going fingerprint verification started with <doc:ref type="method" to="Device.VerifyStart">Device.VerifyStart</doc:ref>.
					</doc:para>
				</doc:description>

				<doc:errors>
					<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error>
					<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error>
					<doc:error name="&ERROR_NO_ACTION_IN_PROGRESS;">if there was no ongoing verification</doc:error>
					<doc:error name="&ERROR_INTERNAL;">if there was an internal error</doc:error>
				</doc:errors>
			</doc:doc>
		</method>

		<!-- ************************************************************ -->

		<signal name="VerifyFingerSelected">
			<arg type="s" name="finger_name">
				<doc:doc>
					<doc:summary>
						<doc:para>
							A string representing the finger select to be verified.
						</doc:para>
					</doc:summary>
				</doc:doc>
			</arg>
			<doc:doc>
				<doc:seealso>
					<doc:ref type="description" to="fingerprint-names">Fingerprint names</doc:ref>.
				</doc:seealso>
			</doc:doc>
		</signal>

		<!-- ************************************************************ -->

		<signal name="VerifyStatus">
			<arg type="s" name="result">
				<doc:doc>
					<doc:summary>
						A string representing the status of the verification.
					</doc:summary>
				</doc:doc>
			</arg>

			<arg type="b" name="done">
				<doc:doc>
					<doc:summary>
						Whether the verification finished and can be stopped.
					</doc:summary>
				</doc:doc>
			</arg>

			<doc:doc>
				<doc:seealso>
					<doc:ref type="description" to="verify-statuses">Verify Statuses</doc:ref> and <doc:ref type="method" to="Device.VerifyStop">Device.VerifyStop</doc:ref>.
				</doc:seealso>
			</doc:doc>
		</signal>

		<!-- ************************************************************ -->

		<method name="EnrollStart">
			<arg type="s" name="finger_name" direction="in">
				<doc:doc><doc:summary>A string representing the finger to enroll. See
				<doc:ref type="description" to="fingerprint-names">Fingerprint names</doc:ref>.
				Note that "any" is not a valid finger name for this method.</doc:summary></doc:doc>
			</arg>
			<annotation name="org.freedesktop.DBus.GLib.Async" value="" />

			<doc:doc>
				<doc:description>
					<doc:para>
						Start enrollemnt for the selected finger. You need to have claimed the device using
						<doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref> before calling
						this method. Enrollment status is sent through <doc:ref type="signal" to="Device::EnrollStatus">Device::EnrollStatus</doc:ref>.
					</doc:para>
				</doc:description>

				<doc:errors>
					<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error>
					<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error>
					<doc:error name="&ERROR_ALREADY_IN_USE;">if the device was already being used</doc:error>
					<doc:error name="&ERROR_INVALID_FINGERNAME;">if there are no enrolled prints for the chosen user</doc:error>
					<doc:error name="&ERROR_INTERNAL;">if there was an internal error</doc:error>
				</doc:errors>

			</doc:doc>
		</method>

		<!-- ************************************************************ -->

		<method name="EnrollStop">
			<annotation name="org.freedesktop.DBus.GLib.Async" value="" />

			<doc:doc>
				<doc:description>
					<doc:para>
						Stop an on-going fingerprint enrollment started with <doc:ref type="method" to="Device.EnrollStart">Device.EnrollStart</doc:ref>.
					</doc:para>
				</doc:description>

				<doc:errors>
					<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error>
					<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error>
					<doc:error name="&ERROR_NO_ACTION_IN_PROGRESS;">if there was no ongoing verification</doc:error>
					<doc:error name="&ERROR_INTERNAL;">if there was an internal error</doc:error>
				</doc:errors>
			</doc:doc>
		</method>

		<!-- ************************************************************ -->

		<signal name="EnrollStatus">
			<arg type="s" name="result">
				<doc:doc>
					<doc:summary>
						A string representing the status of the enrollment.
					</doc:summary>
				</doc:doc>
			</arg>

			<arg type="b" name="done">
				<doc:doc>
					<doc:summary>
						Whether the enrollment finished and can be stopped.
					</doc:summary>
				</doc:doc>
			</arg>

			<doc:doc>
				<doc:seealso>
					<doc:ref type="description" to="enroll-statuses">Enrollment Statuses</doc:ref> and <doc:ref type="method" to="Device.EnrollStop">Device.EnrollStop</doc:ref>.
				</doc:seealso>
			</doc:doc>
		</signal>

		<!-- ************************************************************ -->

		<property name="name" type="s" access="read">
			<doc:doc>
				<doc:description>
					<doc:para>
						The product name of the device.
					</doc:para>
				</doc:description>
			</doc:doc>
		</property>

		<!-- ************************************************************ -->

		<property name="num-enroll-stages" type="i" access="read">
			<doc:doc>
				<doc:description>
					<doc:para>
						The number of enrollment stages for the device. This is only available when the device has been claimed, otherwise it will be undefined (-1).
					</doc:para>
					<doc:seealso>
						<doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref> and <doc:ref type="method" to="Device.EnrollStart">Device.EnrollStart</doc:ref>.
					</doc:seealso>
				</doc:description>
			</doc:doc>
		</property>

		<!-- ************************************************************ -->

		<property name="scan-type" type="s" access="read">
			<doc:doc>
				<doc:description>
					<doc:para>
						The scan type of the device, either "press" if you place your finger on the device, or "swipe" if you have to swipe your finger.
					</doc:para>
				</doc:description>
			</doc:doc>
		</property>

	</interface>
</node>