drgreen/android_frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

identity: Add clarifications to newly added API.

Browse Source 
Bug: 216319624
Test: Compiles
Change-Id: I9e80506cae4799c19f6ea21dc4f2b75981f1ab9d
This commit is contained in:
David Zeuthen 2022-03-03 11:12:21 -05:00
parent 200dfd387f
commit 0693727cfb
2 changed files with 28 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
identity/java/android/security/identity/CredentialDataRequest.java
View File

@ -153,7 +153,15 @@ public class CredentialDataRequest {
/**
* Sets whether to allow using an authentication key which use count has been exceeded.
*
* By default this is set to true.
* <p>This is useful in situations where the application hasn't had a chance to renew
* authentication keys, for example if the device hasn't been connected to the Internet or
* if the issuing authority server has been down.
*
* <p>The reason this could be useful is that the privacy risk of reusing an authentication
* key for a credential presentation could be significantly smaller compared to the
* inconvenience of not being able to present the credential at all.
*
* <p>By default this is set to true.
*
* @param allowUsingExhaustedKeys whether to allow using an authentication key which use
* count has been exceeded if no other key is available.
@ -167,7 +175,16 @@ public class CredentialDataRequest {
/**
* Sets whether to allow using an authentication key which is expired.
*
* By default this is set to false.
* <p>This is useful in situations where the application hasn't had a chance to renew
* authentication keys, for example if the device hasn't been connected to the Internet or
* if the issuing authority server has been down.
*
* <p>The reason this could be useful is that many verifiers are likely to accept a
* credential presentation using an expired authentication key (the credential itself
* wouldn't be expired) and it's likely better for the holder to be able to do this than
* not present their credential at all.
*
* <p>By default this is set to false.
*
* @param allowUsingExpiredKeys whether to allow using an authentication key which is
* expired if no other key is available.
@ -181,7 +198,12 @@ public class CredentialDataRequest {
/**
* Sets whether to increment the use-count for the authentication key used.
*
* By default this is set to true.
* <p>Not incrementing the use-count for an authentication key is useful in situations
* where the authentication key is known with certainty to not be leaked. For example,
* consider an application doing a credential presentation for the sole purpose of
* displaying the credential data to the user (not for verification).
*
* <p>By default this is set to true.
*
* @param incrementUseCount whether to increment the use count of the authentication
* key used.

3
identity/java/android/security/identity/PresentationSession.java
View File

@ -26,6 +26,9 @@ import java.security.PublicKey;
/**
* Class for presenting multiple documents to a remote verifier.
*
* <p>This should be used for all interactions with a remote verifier instead of the now deprecated
* {@link IdentityCredential#getEntries(byte[], Map, byte[], byte[])} method.
*
* Use {@link IdentityCredentialStore#createPresentationSession(int)} to create a {@link
* PresentationSession} instance.
*/