diff --git a/TODO b/TODO index 5087fe9..d276102 100644 --- a/TODO +++ b/TODO @@ -24,3 +24,4 @@ Add POS use case Review error cases, and possible errors +Use property instead of a GetProperties method for devices diff --git a/doc/fprintd-docs.xml b/doc/fprintd-docs.xml index 1b2e4ef..6b4cad9 100644 --- a/doc/fprintd-docs.xml +++ b/doc/fprintd-docs.xml @@ -21,7 +21,7 @@ 2008 - The DeviceKit-disks Authors + The fprintd Authors diff --git a/src/device.xml b/src/device.xml index 60cf2e5..a7ebfba 100644 --- a/src/device.xml +++ b/src/device.xml @@ -1,61 +1,452 @@ - + + + + PolicyKit integration + + + fprintd uses PolicyKit to check whether users are allowed to access fingerprint data, or the + fingerprint readers itself. + + + net.reactivated.fprint.device.verify + + Whether the user is allowed to verify fingers against saved fingerprints. + + + + net.reactivated.fprint.device.enroll + + Whether the user is allowed to enroll new fingerprints. + + + + net.reactivated.fprint.device.setusername + + Whether the user is allowed to query, verify, or enroll fingerprints for users other than itself. + + + + + + + Usernames + + + When a username argument is used for a method, a PolicyKit check is done on the + net.reactivated.fprint.device.setusername PolicyKit + action to see whether the user the client is running as is allowed to access data from other users. + + + 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". + + + See PolicyKit integration. + + + + Fingerprint names + + + 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: + + + left-thumb + + Left thumb + + + + left-index-finger + + Left index finger + + + + left-middle-finger + + Left middle finger + + + + left-ring-finger + + Left ring finger + + + + left-little-finger + + Left little finger + + + + right-thumb + + Right thumb + + + + right-index-finger + + Right index finger + + + + right-middle-finger + + Right middle finger + + + + right-ring-finger + + Right ring finger + + + + right-little-finger + + Right little finger + + + + any + + Any finger. This is only used for Device.VerifyStart + (select the first finger with a fingerprint associated, or all the fingerprints available for the user when + the device supports it) and Device::VerifyFingerSelected + (any finger with an associated fingerprint can be used). + + + + + + + Verify Statuses + + + + Possible values for the result passed through Device::VerifyResult are: + + verify-no-match + + The verification did not match, Device.VerifyStop should now be called. + + + + verify-match + + The verification succeeded, Device.VerifyStop should now be called. + + + + verify-retry-scan + + The user should retry scanning their finger, the verification is still ongoing. + + + + verify-swipe-too-short + + The user's swipe was too short. The user should retry scanning their finger, the verification is still ongoing. + + + + verify-finger-not-centered + + The user's finger was not centered on the reader. The user should retry scanning their finger, the verification is still ongoing. + + + + verify-remove-and-retry + + The user should remove their finger from the reader and retry scanning their finger, the verification is still ongoing. + + + + verify-unknown-error + + An unknown error occurred (usually a driver problem), Device.VerifyStop should now be called. + + + + + + + Enroll Statuses + + + + Possible values for the result passed through Device::EnrollResult are: + + enroll-completed + + The enrollment successfully completed, Device.EnrollStop should now be called. + + + + enroll-failed + + The enrollment failed, Device.EnrollStop should now be called. + + + + enroll-stage-passed + + One stage of the enrollment passed, the enrollment is still ongoing. + + + + enroll-retry-scan + + The user should retry scanning their finger, the enrollment is still ongoing. + + + + enroll-swipe-too-short + + The user's swipe was too short. The user should retry scanning their finger, the enrollment is still ongoing. + + + + enroll-finger-not-centered + + The user's finger was not centered on the reader. The user should retry scanning their finger, the enrollment is still ongoing. + + + + enroll-remove-and-retry + + The user should remove their finger from the reader and retry scanning their finger, the enrollment is still ongoing. + + + + enroll-unknown-error + + An unknown error occurred (usually a driver problem), Device.EnrollStop should now be called. + + + + + + + + + - - + + The username for whom to list the enrolled fingerprints. See Usernames. + + + An array of strings representing the enrolled fingerprints. See Fingerprint names. + + + + + + List all the enrolled fingerprints for the chosen user. + + + + + - + + The username for whom to delete the enrolled fingerprints. See Usernames. + + + + + + Delete all the enrolled fingerprints for the chosen user. + + + + + - + + The username for whom to claim the device. See Usernames. + + + + + + Claim the device for the chosen user. + + + + + + + + + + Release a device claimed with Device.Claim. + + + + + - + + A string representing the finger to verify. See Fingerprint names. + + + + + + Check the chosen finger against a saved fingerprint. You need to have claimed the device using + Device.Claim. + + + + + + + + + + Stop an on-going fingerprint verification started with Device.VerifyStart. + + + + + - + + + + + A string representing the finger select to be verified. + + + + + + + Fingerprint names. + + + + - - + + + + A string representing the status of the verification status. + + + + + + + + Whether the verification finished and can be stopped. + + + + + + + Verify Statuses and Device.VerifyStop. + + + + - + + A string representing the finger to enroll. See + Fingerprint names. + Note that "any" is not a valid finger name for this method. + + + + + + Start enrollemnt for the selected finger. You need to have claimed the device using + Device.Claim before calling + this method. + + + + + + + + + + Stop an on-going fingerprint enrollment started with Device.EnrollStart. + + + + + - - + + + + A string representing the status of the enrollment status. + + + + + + + + Whether the enrollment finished and can be stopped. + + + + + + + Enrollment Statuses and Device.EnrollStop. + + + + diff --git a/src/manager.xml b/src/manager.xml index d8f8383..76d289a 100644 --- a/src/manager.xml +++ b/src/manager.xml @@ -1,15 +1,39 @@ - + + + - + + An array of object paths for devices. + + + + + + Enumerate all the fingerprint readers attached to the system. + + + + + - + + The object path for the default device. + + + + + + Returns the default fingerprint reader device. + + +