diff options
| -rw-r--r-- | fcp/client/attestation/README.md | 36 |
1 files changed, 29 insertions, 7 deletions
diff --git a/fcp/client/attestation/README.md b/fcp/client/attestation/README.md index 2eaa8e9..b5acdcd 100644 --- a/fcp/client/attestation/README.md +++ b/fcp/client/attestation/README.md @@ -19,28 +19,50 @@ After a successful verification, these devices will log an [attestation verification record](/fcp/protos/confidentialcompute/verification_record.proto) which can then be inspected. +**This functionality is currently only being tested on a small scale population +in the Android Gboard app**. However, for a device to successfully participate +in this population, various conditions have to be met, among which: the beta +version of the Gboard app has to be installed, the OS scheduler has to invoke +the app, a test needs to be ongoing (we may pause or restart tests at times), +and the server has to admit the device by serving a task. + +You can attempt to have a device participate in the population and thereafter +extract the attestation record logged by the device by using the following +instructions. However, note that due to the required conditions listed above, +these instructions do not guarantee that your device will actually participate +within a certain timeframe. + ## Preparing a device for verification record extraction 1. Select an Android phone to use. You must be able to enable 'Developer mode'/`adb` access on this device (see below). -2. Install the [`adb` tool](https://developer.android.com/tools/adb) on your +2. Install the app that is using this library and from which you want to gather + attestation verification records. E.g. for the ongoing test in Gboard, you + must: + + 1. Install the beta version of Gboard on your device by using + [this link](https://play.google.com/apps/testing/com.google.android.inputmethod.latin), + 2. Use the Gboard app at least once on your device. + 3. Set your primary language in Gboard to "English (United States)". + +3. Install the [`adb` tool](https://developer.android.com/tools/adb) on your computer. -3. [Enable](https://developer.android.com/tools/adb#Enabling) `adb` debugging +4. [Enable](https://developer.android.com/tools/adb#Enabling) `adb` debugging on your device. -4. Connect your computer to the phone using USB. +5. Connect your computer to the phone using USB. -5. Run the following command to turn on the logging of +6. Run the following command to turn on the logging of `AttestationVerificationRecord` entries to your device's logcat buffer, for any app that is using this library. ```sh - adb shell setprop log.tag.fcp.infra D + adb shell setprop log.tag.fcp.attest D ``` -6. Run the following command: +7. Run the following command: ```sh adb logcat 'fcp.attest:D' '*:S' | tee fcp_attestation_records.txt @@ -50,7 +72,7 @@ which can then be inspected. to the `fcp_attestation_records.txt` file, as well as to the terminal output. Leave this command running as you proceed to the next step. -7. Leave your phone connected to your computer using the USB connection, make +8. Leave your phone connected to your computer using the USB connection, make sure it is also connected to WiFi, and leave it unattended. You should not interact with the phone in any way at this point and leave the phone for at least a number of hours (see the note above). This helps create the required |