Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2017 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.security.keystore; |
| 18 | |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 19 | import android.os.Parcel; |
Rubin Xu | b3a13e1 | 2019-12-24 13:35:02 +0000 | [diff] [blame] | 20 | import android.os.Parcelable; |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 21 | |
| 22 | import java.math.BigInteger; |
| 23 | import java.security.spec.AlgorithmParameterSpec; |
| 24 | import java.security.spec.ECGenParameterSpec; |
| 25 | import java.security.spec.RSAKeyGenParameterSpec; |
| 26 | import java.util.Date; |
| 27 | |
| 28 | import javax.security.auth.x500.X500Principal; |
| 29 | |
| 30 | /** |
| 31 | * A parcelable version of KeyGenParameterSpec |
| 32 | * @hide only used for communicating with the DPMS. |
| 33 | */ |
| 34 | public final class ParcelableKeyGenParameterSpec implements Parcelable { |
| 35 | private static final int ALGORITHM_PARAMETER_SPEC_NONE = 1; |
| 36 | private static final int ALGORITHM_PARAMETER_SPEC_RSA = 2; |
| 37 | private static final int ALGORITHM_PARAMETER_SPEC_EC = 3; |
| 38 | |
| 39 | private final KeyGenParameterSpec mSpec; |
| 40 | |
| 41 | public ParcelableKeyGenParameterSpec( |
| 42 | KeyGenParameterSpec spec) { |
| 43 | mSpec = spec; |
| 44 | } |
| 45 | |
| 46 | public int describeContents() { |
| 47 | return 0; |
| 48 | } |
| 49 | |
| 50 | private static void writeOptionalDate(Parcel out, Date date) { |
| 51 | if (date != null) { |
| 52 | out.writeBoolean(true); |
| 53 | out.writeLong(date.getTime()); |
| 54 | } else { |
| 55 | out.writeBoolean(false); |
| 56 | } |
| 57 | } |
| 58 | |
| 59 | public void writeToParcel(Parcel out, int flags) { |
| 60 | out.writeString(mSpec.getKeystoreAlias()); |
| 61 | out.writeInt(mSpec.getPurposes()); |
| 62 | out.writeInt(mSpec.getUid()); |
| 63 | out.writeInt(mSpec.getKeySize()); |
| 64 | |
| 65 | // Only needs to support RSAKeyGenParameterSpec and ECGenParameterSpec. |
| 66 | AlgorithmParameterSpec algoSpec = mSpec.getAlgorithmParameterSpec(); |
| 67 | if (algoSpec == null) { |
| 68 | out.writeInt(ALGORITHM_PARAMETER_SPEC_NONE); |
| 69 | } else if (algoSpec instanceof RSAKeyGenParameterSpec) { |
| 70 | RSAKeyGenParameterSpec rsaSpec = (RSAKeyGenParameterSpec) algoSpec; |
| 71 | out.writeInt(ALGORITHM_PARAMETER_SPEC_RSA); |
| 72 | out.writeInt(rsaSpec.getKeysize()); |
| 73 | out.writeByteArray(rsaSpec.getPublicExponent().toByteArray()); |
| 74 | } else if (algoSpec instanceof ECGenParameterSpec) { |
| 75 | ECGenParameterSpec ecSpec = (ECGenParameterSpec) algoSpec; |
| 76 | out.writeInt(ALGORITHM_PARAMETER_SPEC_EC); |
| 77 | out.writeString(ecSpec.getName()); |
| 78 | } else { |
| 79 | throw new IllegalArgumentException( |
| 80 | String.format("Unknown algorithm parameter spec: %s", algoSpec.getClass())); |
| 81 | } |
| 82 | out.writeByteArray(mSpec.getCertificateSubject().getEncoded()); |
| 83 | out.writeByteArray(mSpec.getCertificateSerialNumber().toByteArray()); |
Eran Messeri | 4767054 | 2017-12-09 21:25:04 +0000 | [diff] [blame] | 84 | out.writeLong(mSpec.getCertificateNotBefore().getTime()); |
| 85 | out.writeLong(mSpec.getCertificateNotAfter().getTime()); |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 86 | writeOptionalDate(out, mSpec.getKeyValidityStart()); |
| 87 | writeOptionalDate(out, mSpec.getKeyValidityForOriginationEnd()); |
| 88 | writeOptionalDate(out, mSpec.getKeyValidityForConsumptionEnd()); |
Eran Messeri | 4767054 | 2017-12-09 21:25:04 +0000 | [diff] [blame] | 89 | if (mSpec.isDigestsSpecified()) { |
| 90 | out.writeStringArray(mSpec.getDigests()); |
| 91 | } else { |
| 92 | out.writeStringArray(null); |
| 93 | } |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 94 | out.writeStringArray(mSpec.getEncryptionPaddings()); |
| 95 | out.writeStringArray(mSpec.getSignaturePaddings()); |
| 96 | out.writeStringArray(mSpec.getBlockModes()); |
| 97 | out.writeBoolean(mSpec.isRandomizedEncryptionRequired()); |
| 98 | out.writeBoolean(mSpec.isUserAuthenticationRequired()); |
| 99 | out.writeInt(mSpec.getUserAuthenticationValidityDurationSeconds()); |
Max Bires | 04b682d | 2020-01-14 16:10:36 -0800 | [diff] [blame^] | 100 | out.writeInt(mSpec.getUserAuthenticationType()); |
Eran Messeri | 5a5c6e0 | 2018-06-28 11:20:44 +0100 | [diff] [blame] | 101 | out.writeBoolean(mSpec.isUserPresenceRequired()); |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 102 | out.writeByteArray(mSpec.getAttestationChallenge()); |
| 103 | out.writeBoolean(mSpec.isUniqueIdIncluded()); |
| 104 | out.writeBoolean(mSpec.isUserAuthenticationValidWhileOnBody()); |
| 105 | out.writeBoolean(mSpec.isInvalidatedByBiometricEnrollment()); |
Eran Messeri | 5a5c6e0 | 2018-06-28 11:20:44 +0100 | [diff] [blame] | 106 | out.writeBoolean(mSpec.isStrongBoxBacked()); |
| 107 | out.writeBoolean(mSpec.isUserConfirmationRequired()); |
| 108 | out.writeBoolean(mSpec.isUnlockedDeviceRequired()); |
Rubin Xu | b3a13e1 | 2019-12-24 13:35:02 +0000 | [diff] [blame] | 109 | out.writeBoolean(mSpec.isCriticalToDeviceEncryption()); |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | private static Date readDateOrNull(Parcel in) { |
| 113 | boolean hasDate = in.readBoolean(); |
| 114 | if (hasDate) { |
| 115 | return new Date(in.readLong()); |
| 116 | } else { |
| 117 | return null; |
| 118 | } |
| 119 | } |
| 120 | |
| 121 | private ParcelableKeyGenParameterSpec(Parcel in) { |
Eran Messeri | 5a5c6e0 | 2018-06-28 11:20:44 +0100 | [diff] [blame] | 122 | final String keystoreAlias = in.readString(); |
| 123 | final int purposes = in.readInt(); |
| 124 | final int uid = in.readInt(); |
| 125 | final int keySize = in.readInt(); |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 126 | |
Eran Messeri | 5a5c6e0 | 2018-06-28 11:20:44 +0100 | [diff] [blame] | 127 | final int keySpecType = in.readInt(); |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 128 | AlgorithmParameterSpec algorithmSpec = null; |
| 129 | if (keySpecType == ALGORITHM_PARAMETER_SPEC_NONE) { |
| 130 | algorithmSpec = null; |
| 131 | } else if (keySpecType == ALGORITHM_PARAMETER_SPEC_RSA) { |
| 132 | int rsaKeySize = in.readInt(); |
| 133 | BigInteger publicExponent = new BigInteger(in.createByteArray()); |
| 134 | algorithmSpec = new RSAKeyGenParameterSpec(rsaKeySize, publicExponent); |
| 135 | } else if (keySpecType == ALGORITHM_PARAMETER_SPEC_EC) { |
| 136 | String stdName = in.readString(); |
| 137 | algorithmSpec = new ECGenParameterSpec(stdName); |
| 138 | } else { |
| 139 | throw new IllegalArgumentException( |
Eran Messeri | 4767054 | 2017-12-09 21:25:04 +0000 | [diff] [blame] | 140 | String.format("Unknown algorithm parameter spec: %d", keySpecType)); |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 141 | } |
Eran Messeri | 5a5c6e0 | 2018-06-28 11:20:44 +0100 | [diff] [blame] | 142 | |
| 143 | final X500Principal certificateSubject = new X500Principal(in.createByteArray()); |
| 144 | final BigInteger certificateSerialNumber = new BigInteger(in.createByteArray()); |
| 145 | final Date certificateNotBefore = new Date(in.readLong()); |
| 146 | final Date certificateNotAfter = new Date(in.readLong()); |
| 147 | final Date keyValidityStartDate = readDateOrNull(in); |
| 148 | final Date keyValidityForOriginationEnd = readDateOrNull(in); |
| 149 | final Date keyValidityForConsumptionEnd = readDateOrNull(in); |
| 150 | final String[] digests = in.createStringArray(); |
| 151 | final String[] encryptionPaddings = in.createStringArray(); |
| 152 | final String[] signaturePaddings = in.createStringArray(); |
| 153 | final String[] blockModes = in.createStringArray(); |
| 154 | final boolean randomizedEncryptionRequired = in.readBoolean(); |
| 155 | final boolean userAuthenticationRequired = in.readBoolean(); |
| 156 | final int userAuthenticationValidityDurationSeconds = in.readInt(); |
Max Bires | 04b682d | 2020-01-14 16:10:36 -0800 | [diff] [blame^] | 157 | final int userAuthenticationTypes = in.readInt(); |
Eran Messeri | 5a5c6e0 | 2018-06-28 11:20:44 +0100 | [diff] [blame] | 158 | final boolean userPresenceRequired = in.readBoolean(); |
| 159 | final byte[] attestationChallenge = in.createByteArray(); |
| 160 | final boolean uniqueIdIncluded = in.readBoolean(); |
| 161 | final boolean userAuthenticationValidWhileOnBody = in.readBoolean(); |
| 162 | final boolean invalidatedByBiometricEnrollment = in.readBoolean(); |
| 163 | final boolean isStrongBoxBacked = in.readBoolean(); |
| 164 | final boolean userConfirmationRequired = in.readBoolean(); |
| 165 | final boolean unlockedDeviceRequired = in.readBoolean(); |
Rubin Xu | b3a13e1 | 2019-12-24 13:35:02 +0000 | [diff] [blame] | 166 | final boolean criticalToDeviceEncryption = in.readBoolean(); |
Eran Messeri | 5a5c6e0 | 2018-06-28 11:20:44 +0100 | [diff] [blame] | 167 | // The KeyGenParameterSpec is intentionally not constructed using a Builder here: |
| 168 | // The intention is for this class to break if new parameters are added to the |
| 169 | // KeyGenParameterSpec constructor (whereas using a builder would silently drop them). |
| 170 | mSpec = new KeyGenParameterSpec( |
| 171 | keystoreAlias, |
| 172 | uid, |
| 173 | keySize, |
| 174 | algorithmSpec, |
| 175 | certificateSubject, |
| 176 | certificateSerialNumber, |
| 177 | certificateNotBefore, |
| 178 | certificateNotAfter, |
| 179 | keyValidityStartDate, |
| 180 | keyValidityForOriginationEnd, |
| 181 | keyValidityForConsumptionEnd, |
| 182 | purposes, |
| 183 | digests, |
| 184 | encryptionPaddings, |
| 185 | signaturePaddings, |
| 186 | blockModes, |
| 187 | randomizedEncryptionRequired, |
| 188 | userAuthenticationRequired, |
| 189 | userAuthenticationValidityDurationSeconds, |
Max Bires | 04b682d | 2020-01-14 16:10:36 -0800 | [diff] [blame^] | 190 | userAuthenticationTypes, |
Eran Messeri | 5a5c6e0 | 2018-06-28 11:20:44 +0100 | [diff] [blame] | 191 | userPresenceRequired, |
| 192 | attestationChallenge, |
| 193 | uniqueIdIncluded, |
| 194 | userAuthenticationValidWhileOnBody, |
| 195 | invalidatedByBiometricEnrollment, |
| 196 | isStrongBoxBacked, |
| 197 | userConfirmationRequired, |
Rubin Xu | b3a13e1 | 2019-12-24 13:35:02 +0000 | [diff] [blame] | 198 | unlockedDeviceRequired, |
| 199 | criticalToDeviceEncryption); |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 200 | } |
| 201 | |
Jeff Sharkey | 9e8f83d | 2019-02-28 12:06:45 -0700 | [diff] [blame] | 202 | public static final @android.annotation.NonNull Creator<ParcelableKeyGenParameterSpec> CREATOR = new Creator<ParcelableKeyGenParameterSpec>() { |
Eran Messeri | 852c8f1 | 2017-11-15 05:55:52 +0000 | [diff] [blame] | 203 | @Override |
| 204 | public ParcelableKeyGenParameterSpec createFromParcel(Parcel in) { |
| 205 | return new ParcelableKeyGenParameterSpec(in); |
| 206 | } |
| 207 | |
| 208 | @Override |
| 209 | public ParcelableKeyGenParameterSpec[] newArray(int size) { |
| 210 | return new ParcelableKeyGenParameterSpec[size]; |
| 211 | } |
| 212 | }; |
| 213 | |
| 214 | public KeyGenParameterSpec getSpec() { |
| 215 | return mSpec; |
| 216 | } |
| 217 | } |