Skip to content

Add reference to revocation list to example. #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add reference to revocation list to example. #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ A Kotlin library for verifying Android key attestation certificate chains.

```kotlin
// Create a verifier with default, Google-rooted trust anchors, revocation
// info, and time source
// info, and time source.
val verifier = Verifier(
GoogleTrustAnchors, // Trust anchors source
{ setOf<String>() }, // Revoked serials source
{ Instant.now() } // Time source
GoogleTrustAnchors, // Trust anchors source
::getGoogleRevocationStatusFromWeb, // Revoked serials source
{ Instant.now() } // Time source
)

// Verify an attestation certificate chain
Expand Down Expand Up @@ -100,7 +100,15 @@ Android Key Attestation root certificates are documented

## Getting Revoked Serials

The revoked serials may be retrieved from https://android.googleapis.com/attestation/status.
It's important to check the revoked serials list to prevent allowing accepting
fraudulent attestations from known leaked keys. The revoked serials may be
retrieved from https://android.googleapis.com/attestation/status. This list is
updated relatively frequently so it's important to use a fresh copy of the
revocation list.

The above example will make a network call and parse the revoked serials list
every time `verify` is called. For regularly updated binaries, it may make sense
to build the revoked serial list into the binary.

See [here](https://developer.android.com/privacy-and-security/security-key-attestation#certificate_status)
for more information about the format of the data.
Expand Down
Loading