Merge changes from topic "ic-android14"

* changes:
  identity: Add support for setting minimum validity period for AuthKey.
  identity: Add support for ECDSA auth and don't require session encryption.
  Replace LinkedList by a more performant collection
This commit is contained in:
Treehugger Robot
2022-12-12 23:06:06 +00:00
committed by Gerrit Code Review
13 changed files with 262 additions and 36 deletions

View File

@@ -37652,6 +37652,11 @@ package android.security.identity {
ctor public AlreadyPersonalizedException(@NonNull String, @NonNull Throwable); ctor public AlreadyPersonalizedException(@NonNull String, @NonNull Throwable);
} }
public class AuthenticationKeyMetadata {
method @NonNull public java.time.Instant getExpirationDate();
method @IntRange(from=0) public int getUsageCount();
}
public class CipherSuiteNotSupportedException extends android.security.identity.IdentityCredentialException { public class CipherSuiteNotSupportedException extends android.security.identity.IdentityCredentialException {
ctor public CipherSuiteNotSupportedException(@NonNull String); ctor public CipherSuiteNotSupportedException(@NonNull String);
ctor public CipherSuiteNotSupportedException(@NonNull String, @NonNull Throwable); ctor public CipherSuiteNotSupportedException(@NonNull String, @NonNull Throwable);
@@ -37682,6 +37687,7 @@ package android.security.identity {
public abstract class CredentialDataResult { public abstract class CredentialDataResult {
method @Nullable public abstract byte[] getDeviceMac(); method @Nullable public abstract byte[] getDeviceMac();
method @NonNull public abstract byte[] getDeviceNameSpaces(); method @NonNull public abstract byte[] getDeviceNameSpaces();
method @Nullable public byte[] getDeviceSignature();
method @NonNull public abstract android.security.identity.CredentialDataResult.Entries getDeviceSignedEntries(); method @NonNull public abstract android.security.identity.CredentialDataResult.Entries getDeviceSignedEntries();
method @NonNull public abstract android.security.identity.CredentialDataResult.Entries getIssuerSignedEntries(); method @NonNull public abstract android.security.identity.CredentialDataResult.Entries getIssuerSignedEntries();
method @NonNull public abstract byte[] getStaticAuthenticationData(); method @NonNull public abstract byte[] getStaticAuthenticationData();
@@ -37718,13 +37724,15 @@ package android.security.identity {
method @NonNull public byte[] delete(@NonNull byte[]); method @NonNull public byte[] delete(@NonNull byte[]);
method @Deprecated @NonNull public abstract byte[] encryptMessageToReader(@NonNull byte[]); method @Deprecated @NonNull public abstract byte[] encryptMessageToReader(@NonNull byte[]);
method @NonNull public abstract java.util.Collection<java.security.cert.X509Certificate> getAuthKeysNeedingCertification(); method @NonNull public abstract java.util.Collection<java.security.cert.X509Certificate> getAuthKeysNeedingCertification();
method @NonNull public abstract int[] getAuthenticationDataUsageCount(); method @Deprecated @NonNull public abstract int[] getAuthenticationDataUsageCount();
method @NonNull public java.util.List<android.security.identity.AuthenticationKeyMetadata> getAuthenticationKeyMetadata();
method @NonNull public abstract java.util.Collection<java.security.cert.X509Certificate> getCredentialKeyCertificateChain(); method @NonNull public abstract java.util.Collection<java.security.cert.X509Certificate> getCredentialKeyCertificateChain();
method @Deprecated @NonNull public abstract android.security.identity.ResultData getEntries(@Nullable byte[], @NonNull java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>, @Nullable byte[], @Nullable byte[]) throws android.security.identity.EphemeralPublicKeyNotFoundException, android.security.identity.InvalidReaderSignatureException, android.security.identity.InvalidRequestMessageException, android.security.identity.NoAuthenticationKeyAvailableException, android.security.identity.SessionTranscriptMismatchException; method @Deprecated @NonNull public abstract android.security.identity.ResultData getEntries(@Nullable byte[], @NonNull java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>, @Nullable byte[], @Nullable byte[]) throws android.security.identity.EphemeralPublicKeyNotFoundException, android.security.identity.InvalidReaderSignatureException, android.security.identity.InvalidRequestMessageException, android.security.identity.NoAuthenticationKeyAvailableException, android.security.identity.SessionTranscriptMismatchException;
method @NonNull public byte[] proveOwnership(@NonNull byte[]); method @NonNull public byte[] proveOwnership(@NonNull byte[]);
method @Deprecated public abstract void setAllowUsingExhaustedKeys(boolean); method @Deprecated public abstract void setAllowUsingExhaustedKeys(boolean);
method @Deprecated public void setAllowUsingExpiredKeys(boolean); method @Deprecated public void setAllowUsingExpiredKeys(boolean);
method public abstract void setAvailableAuthenticationKeys(int, int); method @Deprecated public abstract void setAvailableAuthenticationKeys(int, int);
method public void setAvailableAuthenticationKeys(@IntRange(from=0) int, @IntRange(from=1) int, @IntRange(from=0) long);
method @Deprecated public abstract void setReaderEphemeralPublicKey(@NonNull java.security.PublicKey) throws java.security.InvalidKeyException; method @Deprecated public abstract void setReaderEphemeralPublicKey(@NonNull java.security.PublicKey) throws java.security.InvalidKeyException;
method @Deprecated public abstract void storeStaticAuthenticationData(@NonNull java.security.cert.X509Certificate, @NonNull byte[]) throws android.security.identity.UnknownAuthenticationKeyException; method @Deprecated public abstract void storeStaticAuthenticationData(@NonNull java.security.cert.X509Certificate, @NonNull byte[]) throws android.security.identity.UnknownAuthenticationKeyException;
method public void storeStaticAuthenticationData(@NonNull java.security.cert.X509Certificate, @NonNull java.time.Instant, @NonNull byte[]) throws android.security.identity.UnknownAuthenticationKeyException; method public void storeStaticAuthenticationData(@NonNull java.security.cert.X509Certificate, @NonNull java.time.Instant, @NonNull byte[]) throws android.security.identity.UnknownAuthenticationKeyException;

View File

@@ -0,0 +1,53 @@
/*
* Copyright 2019 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.security.identity;
import android.annotation.IntRange;
import android.annotation.NonNull;
import java.time.Instant;
/**
* Data about authentication keys.
*/
public class AuthenticationKeyMetadata {
private int mUsageCount;
private Instant mExpirationDate;
AuthenticationKeyMetadata(int usageCount, Instant expirationDate) {
mUsageCount = usageCount;
mExpirationDate = expirationDate;
}
/**
* Gets usage count for the authentication key.
*
* @return the usage count
*/
public @IntRange(from = 0) int getUsageCount() {
return mUsageCount;
}
/**
* Gets expiration date for the authentication key.
*
* @return the expiration date of the authentication key.
*/
public @NonNull Instant getExpirationDate() {
return mExpirationDate;
}
}

View File

@@ -105,6 +105,30 @@ public abstract class CredentialDataResult {
*/ */
public abstract @Nullable byte[] getDeviceMac(); public abstract @Nullable byte[] getDeviceMac();
/**
* Returns a signature over the {@code DeviceAuthenticationBytes} CBOR
* specified in {@link #getDeviceNameSpaces()}, to prove to the reader that the data
* is from a trusted credential.
*
* <p>The signature is made using the authentication private key. See section 9.1.3.4 of
* ISO/IEC 18013-5:2021 for details of this operation.
*
* <p>If the session transcript or reader ephemeral key wasn't set on the {@link
* PresentationSession} used to obtain this data no signature will be produced and this method
* will return {@code null}.
*
* <p>This is only implemented in feature version 202301 or later. If not implemented, the call
* fails with {@link UnsupportedOperationException}. See
* {@link android.content.pm.PackageManager#FEATURE_IDENTITY_CREDENTIAL_HARDWARE} for known
* feature versions.
*
* @return A COSE_Sign1 structure as described above or {@code null} if the conditions
* specified above are not met.
*/
public @Nullable byte[] getDeviceSignature() {
throw new UnsupportedOperationException();
}
/** /**
* Returns the static authentication data associated with the dynamic authentication * Returns the static authentication data associated with the dynamic authentication
* key used to MAC the data returned by {@link #getDeviceNameSpaces()}. * key used to MAC the data returned by {@link #getDeviceNameSpaces()}.

View File

@@ -46,6 +46,11 @@ class CredstoreCredentialDataResult extends CredentialDataResult {
return mDeviceSignedResult.getMessageAuthenticationCode(); return mDeviceSignedResult.getMessageAuthenticationCode();
} }
@Override
public @Nullable byte[] getDeviceSignature() {
return mDeviceSignedResult.getSignature();
}
@Override @Override
public @NonNull byte[] getStaticAuthenticationData() { public @NonNull byte[] getStaticAuthenticationData() {
return mDeviceSignedResult.getStaticAuthenticationData(); return mDeviceSignedResult.getStaticAuthenticationData();

View File

@@ -38,8 +38,9 @@ import java.security.cert.CertificateException;
import java.security.cert.CertificateFactory; import java.security.cert.CertificateFactory;
import java.security.cert.X509Certificate; import java.security.cert.X509Certificate;
import java.time.Instant; import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import java.util.LinkedList; import java.util.List;
import java.util.Map; import java.util.Map;
import javax.crypto.BadPaddingException; import javax.crypto.BadPaddingException;
@@ -59,16 +60,19 @@ class CredstoreIdentityCredential extends IdentityCredential {
private Context mContext; private Context mContext;
private ICredential mBinder; private ICredential mBinder;
private CredstorePresentationSession mSession; private CredstorePresentationSession mSession;
private int mFeatureVersion;
CredstoreIdentityCredential(Context context, String credentialName, CredstoreIdentityCredential(Context context, String credentialName,
@IdentityCredentialStore.Ciphersuite int cipherSuite, @IdentityCredentialStore.Ciphersuite int cipherSuite,
ICredential binder, ICredential binder,
@Nullable CredstorePresentationSession session) { @Nullable CredstorePresentationSession session,
int featureVersion) {
mContext = context; mContext = context;
mCredentialName = credentialName; mCredentialName = credentialName;
mCipherSuite = cipherSuite; mCipherSuite = cipherSuite;
mBinder = binder; mBinder = binder;
mSession = session; mSession = session;
mFeatureVersion = featureVersion;
} }
private KeyPair mEphemeralKeyPair = null; private KeyPair mEphemeralKeyPair = null;
@@ -227,7 +231,7 @@ class CredstoreIdentityCredential extends IdentityCredential {
throw new RuntimeException("Error decoding certificates", e); throw new RuntimeException("Error decoding certificates", e);
} }
LinkedList<X509Certificate> x509Certs = new LinkedList<>(); ArrayList<X509Certificate> x509Certs = new ArrayList<>();
for (Certificate cert : certs) { for (Certificate cert : certs) {
x509Certs.add((X509Certificate) cert); x509Certs.add((X509Certificate) cert);
} }
@@ -346,12 +350,18 @@ class CredstoreIdentityCredential extends IdentityCredential {
} }
} }
byte[] signature = resultParcel.signature;
if (signature != null && signature.length == 0) {
signature = null;
}
byte[] mac = resultParcel.mac; byte[] mac = resultParcel.mac;
if (mac != null && mac.length == 0) { if (mac != null && mac.length == 0) {
mac = null; mac = null;
} }
CredstoreResultData.Builder resultDataBuilder = new CredstoreResultData.Builder( CredstoreResultData.Builder resultDataBuilder = new CredstoreResultData.Builder(
resultParcel.staticAuthenticationData, resultParcel.deviceNameSpaces, mac); mFeatureVersion, resultParcel.staticAuthenticationData,
resultParcel.deviceNameSpaces, mac, signature);
for (ResultNamespaceParcel resultNamespaceParcel : resultParcel.resultNamespaces) { for (ResultNamespaceParcel resultNamespaceParcel : resultParcel.resultNamespaces) {
for (ResultEntryParcel resultEntryParcel : resultNamespaceParcel.entries) { for (ResultEntryParcel resultEntryParcel : resultNamespaceParcel.entries) {
@@ -370,8 +380,14 @@ class CredstoreIdentityCredential extends IdentityCredential {
@Override @Override
public void setAvailableAuthenticationKeys(int keyCount, int maxUsesPerKey) { public void setAvailableAuthenticationKeys(int keyCount, int maxUsesPerKey) {
setAvailableAuthenticationKeys(keyCount, maxUsesPerKey, 0);
}
@Override
public void setAvailableAuthenticationKeys(int keyCount, int maxUsesPerKey,
long minValidTimeMillis) {
try { try {
mBinder.setAvailableAuthenticationKeys(keyCount, maxUsesPerKey); mBinder.setAvailableAuthenticationKeys(keyCount, maxUsesPerKey, minValidTimeMillis);
} catch (android.os.RemoteException e) { } catch (android.os.RemoteException e) {
throw new RuntimeException("Unexpected RemoteException ", e); throw new RuntimeException("Unexpected RemoteException ", e);
} catch (android.os.ServiceSpecificException e) { } catch (android.os.ServiceSpecificException e) {
@@ -384,7 +400,7 @@ class CredstoreIdentityCredential extends IdentityCredential {
public @NonNull Collection<X509Certificate> getAuthKeysNeedingCertification() { public @NonNull Collection<X509Certificate> getAuthKeysNeedingCertification() {
try { try {
AuthKeyParcel[] authKeyParcels = mBinder.getAuthKeysNeedingCertification(); AuthKeyParcel[] authKeyParcels = mBinder.getAuthKeysNeedingCertification();
LinkedList<X509Certificate> x509Certs = new LinkedList<>(); ArrayList<X509Certificate> x509Certs = new ArrayList<>();
CertificateFactory factory = CertificateFactory.getInstance("X.509"); CertificateFactory factory = CertificateFactory.getInstance("X.509");
for (AuthKeyParcel authKeyParcel : authKeyParcels) { for (AuthKeyParcel authKeyParcel : authKeyParcels) {
Collection<? extends Certificate> certs = null; Collection<? extends Certificate> certs = null;
@@ -470,6 +486,34 @@ class CredstoreIdentityCredential extends IdentityCredential {
} }
} }
@Override
public @NonNull List<AuthenticationKeyMetadata> getAuthenticationKeyMetadata() {
try {
int[] usageCount = mBinder.getAuthenticationDataUsageCount();
long[] expirationsMillis = mBinder.getAuthenticationDataExpirations();
if (usageCount.length != expirationsMillis.length) {
throw new IllegalStateException("Size og usageCount and expirationMillis differ");
}
List<AuthenticationKeyMetadata> mds = new ArrayList<>();
for (int n = 0; n < expirationsMillis.length; n++) {
AuthenticationKeyMetadata md = null;
long expirationMillis = expirationsMillis[n];
if (expirationMillis != Long.MAX_VALUE) {
md = new AuthenticationKeyMetadata(
usageCount[n],
Instant.ofEpochMilli(expirationMillis));
}
mds.add(md);
}
return mds;
} catch (android.os.RemoteException e) {
throw new IllegalStateException("Unexpected RemoteException ", e);
} catch (android.os.ServiceSpecificException e) {
throw new IllegalStateException("Unexpected ServiceSpecificException with code "
+ e.errorCode, e);
}
}
@Override @Override
public @NonNull byte[] proveOwnership(@NonNull byte[] challenge) { public @NonNull byte[] proveOwnership(@NonNull byte[] challenge) {
try { try {

View File

@@ -19,6 +19,8 @@ package android.security.identity;
import android.annotation.NonNull; import android.annotation.NonNull;
import android.annotation.Nullable; import android.annotation.Nullable;
import android.content.Context; import android.content.Context;
import android.content.pm.FeatureInfo;
import android.content.pm.PackageManager;
import android.os.RemoteException; import android.os.RemoteException;
import android.os.ServiceManager; import android.os.ServiceManager;
import android.security.GenerateRkpKey; import android.security.GenerateRkpKey;
@@ -30,10 +32,28 @@ class CredstoreIdentityCredentialStore extends IdentityCredentialStore {
private Context mContext = null; private Context mContext = null;
private ICredentialStore mStore = null; private ICredentialStore mStore = null;
private int mFeatureVersion;
static int getFeatureVersion(@NonNull Context context) {
PackageManager pm = context.getPackageManager();
if (pm.hasSystemFeature(PackageManager.FEATURE_IDENTITY_CREDENTIAL_HARDWARE)) {
FeatureInfo[] infos = pm.getSystemAvailableFeatures();
for (int n = 0; n < infos.length; n++) {
FeatureInfo info = infos[n];
if (info.name.equals(PackageManager.FEATURE_IDENTITY_CREDENTIAL_HARDWARE)) {
return info.version;
}
}
}
// Use of the system feature is not required since Android 12. So for Android 11
// return 202009 which is the feature version shipped with Android 11.
return 202009;
}
private CredstoreIdentityCredentialStore(@NonNull Context context, ICredentialStore store) { private CredstoreIdentityCredentialStore(@NonNull Context context, ICredentialStore store) {
mContext = context; mContext = context;
mStore = store; mStore = store;
mFeatureVersion = getFeatureVersion(mContext);
} }
static CredstoreIdentityCredentialStore getInstanceForType(@NonNull Context context, static CredstoreIdentityCredentialStore getInstanceForType(@NonNull Context context,
@@ -139,8 +159,7 @@ class CredstoreIdentityCredentialStore extends IdentityCredentialStore {
ICredential credstoreCredential; ICredential credstoreCredential;
credstoreCredential = mStore.getCredentialByName(credentialName, cipherSuite); credstoreCredential = mStore.getCredentialByName(credentialName, cipherSuite);
return new CredstoreIdentityCredential(mContext, credentialName, cipherSuite, return new CredstoreIdentityCredential(mContext, credentialName, cipherSuite,
credstoreCredential, credstoreCredential, null, mFeatureVersion);
null);
} catch (android.os.RemoteException e) { } catch (android.os.RemoteException e) {
throw new RuntimeException("Unexpected RemoteException ", e); throw new RuntimeException("Unexpected RemoteException ", e);
} catch (android.os.ServiceSpecificException e) { } catch (android.os.ServiceSpecificException e) {
@@ -182,7 +201,8 @@ class CredstoreIdentityCredentialStore extends IdentityCredentialStore {
throws CipherSuiteNotSupportedException { throws CipherSuiteNotSupportedException {
try { try {
ISession credstoreSession = mStore.createPresentationSession(cipherSuite); ISession credstoreSession = mStore.createPresentationSession(cipherSuite);
return new CredstorePresentationSession(mContext, cipherSuite, this, credstoreSession); return new CredstorePresentationSession(mContext, cipherSuite, this, credstoreSession,
mFeatureVersion);
} catch (android.os.RemoteException e) { } catch (android.os.RemoteException e) {
throw new RuntimeException("Unexpected RemoteException ", e); throw new RuntimeException("Unexpected RemoteException ", e);
} catch (android.os.ServiceSpecificException e) { } catch (android.os.ServiceSpecificException e) {

View File

@@ -48,15 +48,18 @@ class CredstorePresentationSession extends PresentationSession {
private byte[] mSessionTranscript = null; private byte[] mSessionTranscript = null;
private boolean mOperationHandleSet = false; private boolean mOperationHandleSet = false;
private long mOperationHandle = 0; private long mOperationHandle = 0;
private int mFeatureVersion = 0;
CredstorePresentationSession(Context context, CredstorePresentationSession(Context context,
@IdentityCredentialStore.Ciphersuite int cipherSuite, @IdentityCredentialStore.Ciphersuite int cipherSuite,
CredstoreIdentityCredentialStore store, CredstoreIdentityCredentialStore store,
ISession binder) { ISession binder,
int featureVersion) {
mContext = context; mContext = context;
mCipherSuite = cipherSuite; mCipherSuite = cipherSuite;
mStore = store; mStore = store;
mBinder = binder; mBinder = binder;
mFeatureVersion = featureVersion;
} }
private void ensureEphemeralKeyPair() { private void ensureEphemeralKeyPair() {
@@ -147,7 +150,7 @@ class CredstorePresentationSession extends PresentationSession {
mBinder.getCredentialForPresentation(credentialName); mBinder.getCredentialForPresentation(credentialName);
credential = new CredstoreIdentityCredential(mContext, credentialName, credential = new CredstoreIdentityCredential(mContext, credentialName,
mCipherSuite, credstoreCredential, mCipherSuite, credstoreCredential,
this); this, mFeatureVersion);
mCredentialCache.put(credentialName, credential); mCredentialCache.put(credentialName, credential);
credential.setAllowUsingExhaustedKeys(request.isAllowUsingExhaustedKeys()); credential.setAllowUsingExhaustedKeys(request.isAllowUsingExhaustedKeys());

View File

@@ -30,10 +30,11 @@ import java.util.Map;
* data requested from a {@link IdentityCredential}. * data requested from a {@link IdentityCredential}.
*/ */
class CredstoreResultData extends ResultData { class CredstoreResultData extends ResultData {
int mFeatureVersion = 0;
byte[] mStaticAuthenticationData = null; byte[] mStaticAuthenticationData = null;
byte[] mAuthenticatedData = null; byte[] mAuthenticatedData = null;
byte[] mMessageAuthenticationCode = null; byte[] mMessageAuthenticationCode = null;
byte[] mSignature = null;
private Map<String, Map<String, EntryData>> mData = new LinkedHashMap<>(); private Map<String, Map<String, EntryData>> mData = new LinkedHashMap<>();
@@ -60,6 +61,14 @@ class CredstoreResultData extends ResultData {
return mMessageAuthenticationCode; return mMessageAuthenticationCode;
} }
@Override
@Nullable byte[] getSignature() {
if (mFeatureVersion < 202301) {
throw new UnsupportedOperationException();
}
return mSignature;
}
@Override @Override
public @NonNull byte[] getStaticAuthenticationData() { public @NonNull byte[] getStaticAuthenticationData() {
return mStaticAuthenticationData; return mStaticAuthenticationData;
@@ -124,13 +133,17 @@ class CredstoreResultData extends ResultData {
static class Builder { static class Builder {
private CredstoreResultData mResultData; private CredstoreResultData mResultData;
Builder(byte[] staticAuthenticationData, Builder(int featureVersion,
byte[] staticAuthenticationData,
byte[] authenticatedData, byte[] authenticatedData,
byte[] messageAuthenticationCode) { byte[] messageAuthenticationCode,
byte[] signature) {
this.mResultData = new CredstoreResultData(); this.mResultData = new CredstoreResultData();
this.mResultData.mFeatureVersion = featureVersion;
this.mResultData.mStaticAuthenticationData = staticAuthenticationData; this.mResultData.mStaticAuthenticationData = staticAuthenticationData;
this.mResultData.mAuthenticatedData = authenticatedData; this.mResultData.mAuthenticatedData = authenticatedData;
this.mResultData.mMessageAuthenticationCode = messageAuthenticationCode; this.mResultData.mMessageAuthenticationCode = messageAuthenticationCode;
this.mResultData.mSignature = signature;
} }
private Map<String, EntryData> getOrCreateInnerMap(String namespaceName) { private Map<String, EntryData> getOrCreateInnerMap(String namespaceName) {

View File

@@ -25,8 +25,9 @@ import java.security.cert.Certificate;
import java.security.cert.CertificateException; import java.security.cert.CertificateException;
import java.security.cert.CertificateFactory; import java.security.cert.CertificateFactory;
import java.security.cert.X509Certificate; import java.security.cert.X509Certificate;
import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import java.util.LinkedList; import java.util.List;
class CredstoreWritableIdentityCredential extends WritableIdentityCredential { class CredstoreWritableIdentityCredential extends WritableIdentityCredential {
@@ -61,7 +62,7 @@ class CredstoreWritableIdentityCredential extends WritableIdentityCredential {
throw new RuntimeException("Error decoding certificates", e); throw new RuntimeException("Error decoding certificates", e);
} }
LinkedList<X509Certificate> x509Certs = new LinkedList<>(); ArrayList<X509Certificate> x509Certs = new ArrayList<>();
for (Certificate cert : certs) { for (Certificate cert : certs) {
x509Certs.add((X509Certificate) cert); x509Certs.add((X509Certificate) cert);
} }

View File

@@ -16,6 +16,7 @@
package android.security.identity; package android.security.identity;
import android.annotation.IntRange;
import android.annotation.NonNull; import android.annotation.NonNull;
import android.annotation.Nullable; import android.annotation.Nullable;
@@ -25,6 +26,7 @@ import java.security.PublicKey;
import java.security.cert.X509Certificate; import java.security.cert.X509Certificate;
import java.time.Instant; import java.time.Instant;
import java.util.Collection; import java.util.Collection;
import java.util.List;
import java.util.Map; import java.util.Map;
/** /**
@@ -236,14 +238,15 @@ public abstract class IdentityCredential {
* IntentToRetain = bool * IntentToRetain = bool
* </pre> * </pre>
* *
* <p>If the {@code sessionTranscript} parameter is not {@code null}, the X and Y coordinates * <p>If mdoc session encryption is used (e.g. if {@link #createEphemeralKeyPair()} has been
* of the public part of the key-pair previously generated by {@link #createEphemeralKeyPair()} * called) and if the {@code sessionTranscript} parameter is not {@code null}, the X and Y
* must appear somewhere in the bytes of the CBOR. Each of these coordinates must appear * coordinates of the public part of the key-pair previously generated by
* encoded with the most significant bits first and use the exact amount of bits indicated by * {@link #createEphemeralKeyPair()} must appear somewhere in the bytes of the CBOR. Each of
* the key size of the ephemeral keys. For example, if the ephemeral key is using the P-256 * these coordinates must appear encoded with the most significant bits first and use the
* curve then the 32 bytes for the X coordinate encoded with the most significant bits first * exact amount of bits indicated by the key size of the ephemeral keys. For example, if the
* must appear somewhere in {@code sessionTranscript} and ditto for the 32 bytes for the Y * ephemeral key is using the P-256 curve then the 32 bytes for the X coordinate encoded with
* coordinate. * the most significant bits first must appear somewhere in {@code sessionTranscript} and
* ditto for the 32 bytes for the Y coordinate.
* *
* <p>If {@code readerSignature} is not {@code null} it must be the bytes of a * <p>If {@code readerSignature} is not {@code null} it must be the bytes of a
* {@code COSE_Sign1} structure as defined in RFC 8152. For the payload nil shall be used and * {@code COSE_Sign1} structure as defined in RFC 8152. For the payload nil shall be used and
@@ -296,7 +299,7 @@ public abstract class IdentityCredential {
* session transcripts. * session transcripts.
* @throws NoAuthenticationKeyAvailableException if authentication keys were never * @throws NoAuthenticationKeyAvailableException if authentication keys were never
* provisioned, the method * provisioned, the method
* {@link #setAvailableAuthenticationKeys(int, int)} * {@link #setAvailableAuthenticationKeys(int, int, long)}
* was called with {@code keyCount} set to 0, * was called with {@code keyCount} set to 0,
* the method * the method
* {@link #setAllowUsingExhaustedKeys(boolean)} * {@link #setAllowUsingExhaustedKeys(boolean)}
@@ -330,19 +333,25 @@ public abstract class IdentityCredential {
* for which this method has not been called behave as though it had been called wit * for which this method has not been called behave as though it had been called wit
* {@code keyCount} 0 and {@code maxUsesPerKey} 1. * {@code keyCount} 0 and {@code maxUsesPerKey} 1.
* *
* <p>The effect of this method is like calling
* {@link #setAvailableAuthenticationKeys(int, int, long)} with the last parameter is set to 0.
*
* @param keyCount The number of active, certified dynamic authentication keys the * @param keyCount The number of active, certified dynamic authentication keys the
* {@code IdentityCredential} will try to keep available. This value * {@code IdentityCredential} will try to keep available. This value
* must be non-negative. * must be non-negative.
* @param maxUsesPerKey The maximum number of times each of the keys will be used before it's * @param maxUsesPerKey The maximum number of times each of the keys will be used before it's
* eligible for replacement. This value must be greater than zero. * eligible for replacement. This value must be greater than zero.
* @deprecated Use {@link #setAvailableAuthenticationKeys(int, int, long)} instead.
*/ */
@Deprecated
public abstract void setAvailableAuthenticationKeys(int keyCount, int maxUsesPerKey); public abstract void setAvailableAuthenticationKeys(int keyCount, int maxUsesPerKey);
/** /**
* Gets a collection of dynamic authentication keys that need certification. * Gets a collection of dynamic authentication keys that need certification.
* *
* <p>When there aren't enough certified dynamic authentication keys, either because the key * <p>When there aren't enough certified dynamic authentication keys, either because the key
* count has been increased or because one or more keys have reached their usage count, this * count has been increased or because one or more keys have reached their usage count or
* it if a key is too close to its expiration date, this
* method will generate replacement keys and certificates and return them for issuer * method will generate replacement keys and certificates and return them for issuer
* certification. The issuer certificates and associated static authentication data must then * certification. The issuer certificates and associated static authentication data must then
* be provided back to the Identity Credential using * be provided back to the Identity Credential using
@@ -400,11 +409,6 @@ public abstract class IdentityCredential {
* This should only be called for an authenticated key returned by * This should only be called for an authenticated key returned by
* {@link #getAuthKeysNeedingCertification()}. * {@link #getAuthKeysNeedingCertification()}.
* *
* <p>This is only implemented in feature version 202101 or later. If not implemented, the call
* fails with {@link UnsupportedOperationException}. See
* {@link android.content.pm.PackageManager#FEATURE_IDENTITY_CREDENTIAL_HARDWARE} for known
* feature versions.
*
* @param authenticationKey The dynamic authentication key for which certification and * @param authenticationKey The dynamic authentication key for which certification and
* associated static * associated static
* authentication data is being provided. * authentication data is being provided.
@@ -426,7 +430,9 @@ public abstract class IdentityCredential {
* Get the number of times the dynamic authentication keys have been used. * Get the number of times the dynamic authentication keys have been used.
* *
* @return int array of dynamic authentication key usage counts. * @return int array of dynamic authentication key usage counts.
* @deprecated Use {@link #getAuthenticationKeyMetadata()} instead.
*/ */
@Deprecated
public @NonNull abstract int[] getAuthenticationDataUsageCount(); public @NonNull abstract int[] getAuthenticationDataUsageCount();
/** /**
@@ -519,4 +525,47 @@ public abstract class IdentityCredential {
public @NonNull byte[] update(@NonNull PersonalizationData personalizationData) { public @NonNull byte[] update(@NonNull PersonalizationData personalizationData) {
throw new UnsupportedOperationException(); throw new UnsupportedOperationException();
} }
/**
* Sets the number of dynamic authentication keys the {@code IdentityCredential} will maintain,
* the number of times each should be used, and the minimum amount of time it's valid for.
*
* <p>The Identity Credential system will select the least-used dynamic authentication key each
* time {@link #getEntries(byte[], Map, byte[], byte[])} is called. Identity Credentials
* for which this method has not been called behave as though it had been called wit
* {@code keyCount} 0, {@code maxUsesPerKey} 1, and {@code minValidTimeMillis} 0.
*
* <p>Applications can use {@link #getAuthenticationKeyMetadata()} to get a picture of the
* usage andtime left of each configured authentication key. This can be used to determine
* how urgent it is recertify new authentication keys via the
* {@link #getAuthKeysNeedingCertification()} method.
*
* @param keyCount The number of active, certified dynamic authentication keys the
* {@code IdentityCredential} will try to keep available. This value
* must be non-negative.
* @param maxUsesPerKey The maximum number of times each of the keys will be used before it's
* eligible for replacement. This value must be greater than zero.
* @param minValidTimeMillis If a key has less time left than this value it will be eliglible
* for replacement. This value must be non-negative.
*/
public void setAvailableAuthenticationKeys(
@IntRange(from = 0) int keyCount,
@IntRange(from = 1) int maxUsesPerKey,
@IntRange(from = 0) long minValidTimeMillis) {
throw new UnsupportedOperationException();
}
/**
* Get information about dynamic authentication keys.
*
* <p>The returned list may have <code>null</code> values if certification for the dynamic
* authentication key is pending.
*
* <p>The list is always <code>keyCount</code> elements long.
*
* @return list of authentication key metadata objects.
*/
public @NonNull List<AuthenticationKeyMetadata> getAuthenticationKeyMetadata() {
throw new UnsupportedOperationException();
}
} }

View File

@@ -18,10 +18,11 @@ package android.security.identity;
import android.annotation.NonNull; import android.annotation.NonNull;
import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import java.util.LinkedHashMap; import java.util.LinkedHashMap;
import java.util.LinkedList; import java.util.List;
/** /**
* An object that holds personalization data. * An object that holds personalization data.
@@ -38,7 +39,7 @@ public class PersonalizationData {
private PersonalizationData() { private PersonalizationData() {
} }
private LinkedList<AccessControlProfile> mProfiles = new LinkedList<>(); private ArrayList<AccessControlProfile> mProfiles = new ArrayList<>();
private LinkedHashMap<String, NamespaceData> mNamespaces = new LinkedHashMap<>(); private LinkedHashMap<String, NamespaceData> mNamespaces = new LinkedHashMap<>();

View File

@@ -73,7 +73,8 @@ public abstract class PresentationSession {
* <p>If called, this must be called before any calls to * <p>If called, this must be called before any calls to
* {@link #getCredentialData(String, CredentialDataRequest)}. * {@link #getCredentialData(String, CredentialDataRequest)}.
* *
* <p>The X and Y coordinates of the public part of the key-pair returned by {@link * <p>If mdoc session encryption is used (e.g. if {@link #getEphemeralKeyPair()} has been
* called) then the X and Y coordinates of the public part of the key-pair returned by {@link
* #getEphemeralKeyPair()} must appear somewhere in the bytes of the passed in CBOR. Each of * #getEphemeralKeyPair()} must appear somewhere in the bytes of the passed in CBOR. Each of
* these coordinates must appear encoded with the most significant bits first and use the exact * these coordinates must appear encoded with the most significant bits first and use the exact
* amount of bits indicated by the key size of the ephemeral keys. For example, if the * amount of bits indicated by the key size of the ephemeral keys. For example, if the

View File

@@ -134,6 +134,10 @@ public abstract class ResultData {
*/ */
public abstract @Nullable byte[] getMessageAuthenticationCode(); public abstract @Nullable byte[] getMessageAuthenticationCode();
@Nullable byte[] getSignature() {
throw new UnsupportedOperationException();
}
/** /**
* Returns the static authentication data associated with the dynamic authentication * Returns the static authentication data associated with the dynamic authentication
* key used to sign or MAC the data returned by {@link #getAuthenticatedData()}. * key used to sign or MAC the data returned by {@link #getAuthenticatedData()}.