Chia-chi Yeh | 9b7a3f1 | 2009-09-18 12:00:12 +0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2009 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; |
| 18 | |
Brian Carlstrom | 0efca17 | 2012-09-04 23:01:07 -0700 | [diff] [blame] | 19 | import com.android.org.bouncycastle.util.io.pem.PemObject; |
| 20 | import com.android.org.bouncycastle.util.io.pem.PemReader; |
| 21 | import com.android.org.bouncycastle.util.io.pem.PemWriter; |
Shawn Willden | 8d8c747 | 2016-02-02 08:27:39 -0700 | [diff] [blame] | 22 | |
Andrei Onea | 4aa2a20 | 2019-02-27 14:22:05 +0000 | [diff] [blame] | 23 | import android.annotation.UnsupportedAppUsage; |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 24 | import java.io.ByteArrayInputStream; |
| 25 | import java.io.ByteArrayOutputStream; |
| 26 | import java.io.IOException; |
| 27 | import java.io.InputStreamReader; |
| 28 | import java.io.OutputStreamWriter; |
| 29 | import java.io.Reader; |
| 30 | import java.io.Writer; |
Elliott Hughes | d396a44 | 2013-06-28 16:24:48 -0700 | [diff] [blame] | 31 | import java.nio.charset.StandardCharsets; |
Brian Carlstrom | 0efca17 | 2012-09-04 23:01:07 -0700 | [diff] [blame] | 32 | import java.security.cert.Certificate; |
| 33 | import java.security.cert.CertificateEncodingException; |
| 34 | import java.security.cert.CertificateException; |
| 35 | import java.security.cert.CertificateFactory; |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 36 | import java.security.cert.X509Certificate; |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 37 | import java.util.ArrayList; |
| 38 | import java.util.List; |
Chia-chi Yeh | 9b7a3f1 | 2009-09-18 12:00:12 +0800 | [diff] [blame] | 39 | |
| 40 | /** |
| 41 | * {@hide} |
| 42 | */ |
| 43 | public class Credentials { |
| 44 | private static final String LOGTAG = "Credentials"; |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 45 | |
Chia-chi Yeh | 4403917 | 2009-09-21 11:53:59 +0800 | [diff] [blame] | 46 | public static final String INSTALL_ACTION = "android.credentials.INSTALL"; |
| 47 | |
Kenny Root | 3e7be43 | 2013-03-28 09:25:51 -0700 | [diff] [blame] | 48 | public static final String INSTALL_AS_USER_ACTION = "android.credentials.INSTALL_AS_USER"; |
| 49 | |
Chia-chi Yeh | 9b7a3f1 | 2009-09-18 12:00:12 +0800 | [diff] [blame] | 50 | /** Key prefix for CA certificates. */ |
| 51 | public static final String CA_CERTIFICATE = "CACERT_"; |
| 52 | |
| 53 | /** Key prefix for user certificates. */ |
| 54 | public static final String USER_CERTIFICATE = "USRCERT_"; |
| 55 | |
Janis Danisevskis | 64338c0 | 2017-04-19 09:17:17 -0700 | [diff] [blame] | 56 | /** Key prefix for user private and secret keys. */ |
Chia-chi Yeh | 9b7a3f1 | 2009-09-18 12:00:12 +0800 | [diff] [blame] | 57 | public static final String USER_PRIVATE_KEY = "USRPKEY_"; |
| 58 | |
Janis Danisevskis | 64338c0 | 2017-04-19 09:17:17 -0700 | [diff] [blame] | 59 | /** Key prefix for user secret keys. |
| 60 | * @deprecated use {@code USER_PRIVATE_KEY} for this category instead. |
| 61 | */ |
Alex Klyubin | baf2838 | 2015-03-26 14:46:55 -0700 | [diff] [blame] | 62 | public static final String USER_SECRET_KEY = "USRSKEY_"; |
| 63 | |
Chia-chi Yeh | 9b7a3f1 | 2009-09-18 12:00:12 +0800 | [diff] [blame] | 64 | /** Key prefix for VPN. */ |
| 65 | public static final String VPN = "VPN_"; |
| 66 | |
| 67 | /** Key prefix for WIFI. */ |
| 68 | public static final String WIFI = "WIFI_"; |
| 69 | |
Jeff Sharkey | 69ddab4 | 2012-08-25 00:05:46 -0700 | [diff] [blame] | 70 | /** Key containing suffix of lockdown VPN profile. */ |
| 71 | public static final String LOCKDOWN_VPN = "LOCKDOWN_VPN"; |
| 72 | |
Chia-chi Yeh | 9b7a3f1 | 2009-09-18 12:00:12 +0800 | [diff] [blame] | 73 | /** Data type for public keys. */ |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 74 | public static final String EXTRA_PUBLIC_KEY = "KEY"; |
Chia-chi Yeh | 9b7a3f1 | 2009-09-18 12:00:12 +0800 | [diff] [blame] | 75 | |
| 76 | /** Data type for private keys. */ |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 77 | public static final String EXTRA_PRIVATE_KEY = "PKEY"; |
Chia-chi Yeh | 9b7a3f1 | 2009-09-18 12:00:12 +0800 | [diff] [blame] | 78 | |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 79 | // historically used by Android |
| 80 | public static final String EXTENSION_CRT = ".crt"; |
| 81 | public static final String EXTENSION_P12 = ".p12"; |
| 82 | // commonly used on Windows |
| 83 | public static final String EXTENSION_CER = ".cer"; |
| 84 | public static final String EXTENSION_PFX = ".pfx"; |
| 85 | |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 86 | /** |
Kenny Root | 3e7be43 | 2013-03-28 09:25:51 -0700 | [diff] [blame] | 87 | * Intent extra: install the certificate bundle as this UID instead of |
| 88 | * system. |
| 89 | */ |
| 90 | public static final String EXTRA_INSTALL_AS_UID = "install_as_uid"; |
| 91 | |
| 92 | /** |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 93 | * Intent extra: name for the user's private key. |
| 94 | */ |
| 95 | public static final String EXTRA_USER_PRIVATE_KEY_NAME = "user_private_key_name"; |
| 96 | |
| 97 | /** |
| 98 | * Intent extra: data for the user's private key in PEM-encoded PKCS#8. |
| 99 | */ |
| 100 | public static final String EXTRA_USER_PRIVATE_KEY_DATA = "user_private_key_data"; |
| 101 | |
| 102 | /** |
| 103 | * Intent extra: name for the user's certificate. |
| 104 | */ |
| 105 | public static final String EXTRA_USER_CERTIFICATE_NAME = "user_certificate_name"; |
| 106 | |
| 107 | /** |
| 108 | * Intent extra: data for the user's certificate in PEM-encoded X.509. |
| 109 | */ |
| 110 | public static final String EXTRA_USER_CERTIFICATE_DATA = "user_certificate_data"; |
| 111 | |
| 112 | /** |
| 113 | * Intent extra: name for CA certificate chain |
| 114 | */ |
| 115 | public static final String EXTRA_CA_CERTIFICATES_NAME = "ca_certificates_name"; |
| 116 | |
| 117 | /** |
| 118 | * Intent extra: data for CA certificate chain in PEM-encoded X.509. |
| 119 | */ |
| 120 | public static final String EXTRA_CA_CERTIFICATES_DATA = "ca_certificates_data"; |
| 121 | |
| 122 | /** |
Brian Carlstrom | 0efca17 | 2012-09-04 23:01:07 -0700 | [diff] [blame] | 123 | * Convert objects to a PEM format which is used for |
| 124 | * CA_CERTIFICATE and USER_CERTIFICATE entries. |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 125 | */ |
Andrei Onea | 4aa2a20 | 2019-02-27 14:22:05 +0000 | [diff] [blame] | 126 | @UnsupportedAppUsage |
Brian Carlstrom | 0efca17 | 2012-09-04 23:01:07 -0700 | [diff] [blame] | 127 | public static byte[] convertToPem(Certificate... objects) |
| 128 | throws IOException, CertificateEncodingException { |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 129 | ByteArrayOutputStream bao = new ByteArrayOutputStream(); |
Elliott Hughes | d396a44 | 2013-06-28 16:24:48 -0700 | [diff] [blame] | 130 | Writer writer = new OutputStreamWriter(bao, StandardCharsets.US_ASCII); |
Brian Carlstrom | 0efca17 | 2012-09-04 23:01:07 -0700 | [diff] [blame] | 131 | PemWriter pw = new PemWriter(writer); |
| 132 | for (Certificate o : objects) { |
| 133 | pw.writeObject(new PemObject("CERTIFICATE", o.getEncoded())); |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 134 | } |
| 135 | pw.close(); |
| 136 | return bao.toByteArray(); |
| 137 | } |
| 138 | /** |
| 139 | * Convert objects from PEM format, which is used for |
Brian Carlstrom | 0efca17 | 2012-09-04 23:01:07 -0700 | [diff] [blame] | 140 | * CA_CERTIFICATE and USER_CERTIFICATE entries. |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 141 | */ |
Brian Carlstrom | 0efca17 | 2012-09-04 23:01:07 -0700 | [diff] [blame] | 142 | public static List<X509Certificate> convertFromPem(byte[] bytes) |
| 143 | throws IOException, CertificateException { |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 144 | ByteArrayInputStream bai = new ByteArrayInputStream(bytes); |
Elliott Hughes | d396a44 | 2013-06-28 16:24:48 -0700 | [diff] [blame] | 145 | Reader reader = new InputStreamReader(bai, StandardCharsets.US_ASCII); |
Brian Carlstrom | 0efca17 | 2012-09-04 23:01:07 -0700 | [diff] [blame] | 146 | PemReader pr = new PemReader(reader); |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 147 | |
Shawn Willden | 8d8c747 | 2016-02-02 08:27:39 -0700 | [diff] [blame] | 148 | try { |
| 149 | CertificateFactory cf = CertificateFactory.getInstance("X509"); |
Brian Carlstrom | 0efca17 | 2012-09-04 23:01:07 -0700 | [diff] [blame] | 150 | |
Shawn Willden | 8d8c747 | 2016-02-02 08:27:39 -0700 | [diff] [blame] | 151 | List<X509Certificate> result = new ArrayList<X509Certificate>(); |
| 152 | PemObject o; |
| 153 | while ((o = pr.readPemObject()) != null) { |
| 154 | if (o.getType().equals("CERTIFICATE")) { |
| 155 | Certificate c = cf.generateCertificate(new ByteArrayInputStream(o.getContent())); |
| 156 | result.add((X509Certificate) c); |
| 157 | } else { |
| 158 | throw new IllegalArgumentException("Unknown type " + o.getType()); |
| 159 | } |
Brian Carlstrom | 0efca17 | 2012-09-04 23:01:07 -0700 | [diff] [blame] | 160 | } |
Shawn Willden | 8d8c747 | 2016-02-02 08:27:39 -0700 | [diff] [blame] | 161 | return result; |
| 162 | } finally { |
| 163 | pr.close(); |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 164 | } |
Brian Carlstrom | 9d7faa9 | 2011-06-07 13:45:33 -0700 | [diff] [blame] | 165 | } |
| 166 | |
Kenny Root | db02671 | 2012-08-20 10:48:46 -0700 | [diff] [blame] | 167 | /** |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 168 | * Delete all types (private key, user certificate, CA certificate) for a |
Kenny Root | db02671 | 2012-08-20 10:48:46 -0700 | [diff] [blame] | 169 | * particular {@code alias}. All three can exist for any given alias. |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 170 | * Returns {@code true} if the alias no longer contains any types. |
Kenny Root | db02671 | 2012-08-20 10:48:46 -0700 | [diff] [blame] | 171 | */ |
Alex Klyubin | dcdaf87 | 2015-05-13 15:57:09 -0700 | [diff] [blame] | 172 | public static boolean deleteAllTypesForAlias(KeyStore keystore, String alias) { |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 173 | return deleteAllTypesForAlias(keystore, alias, KeyStore.UID_SELF); |
| 174 | } |
| 175 | |
| 176 | /** |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 177 | * Delete all types (private key, user certificate, CA certificate) for a |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 178 | * particular {@code alias}. All three can exist for any given alias. |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 179 | * Returns {@code true} if the alias no longer contains any types. |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 180 | */ |
| 181 | public static boolean deleteAllTypesForAlias(KeyStore keystore, String alias, int uid) { |
Kenny Root | db02671 | 2012-08-20 10:48:46 -0700 | [diff] [blame] | 182 | /* |
| 183 | * Make sure every type is deleted. There can be all three types, so |
| 184 | * don't use a conditional here. |
| 185 | */ |
Janis Danisevskis | 64338c0 | 2017-04-19 09:17:17 -0700 | [diff] [blame] | 186 | return deleteUserKeyTypeForAlias(keystore, alias, uid) |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 187 | & deleteCertificateTypesForAlias(keystore, alias, uid); |
Kenny Root | 802768d | 2012-08-21 15:23:35 -0700 | [diff] [blame] | 188 | } |
| 189 | |
| 190 | /** |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 191 | * Delete certificate types (user certificate, CA certificate) for a |
| 192 | * particular {@code alias}. Both can exist for any given alias. |
| 193 | * Returns {@code true} if the alias no longer contains either type. |
Kenny Root | 802768d | 2012-08-21 15:23:35 -0700 | [diff] [blame] | 194 | */ |
Alex Klyubin | dcdaf87 | 2015-05-13 15:57:09 -0700 | [diff] [blame] | 195 | public static boolean deleteCertificateTypesForAlias(KeyStore keystore, String alias) { |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 196 | return deleteCertificateTypesForAlias(keystore, alias, KeyStore.UID_SELF); |
| 197 | } |
| 198 | |
| 199 | /** |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 200 | * Delete certificate types (user certificate, CA certificate) for a |
| 201 | * particular {@code alias}. Both can exist for any given alias. |
| 202 | * Returns {@code true} if the alias no longer contains either type. |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 203 | */ |
| 204 | public static boolean deleteCertificateTypesForAlias(KeyStore keystore, String alias, int uid) { |
Kenny Root | 802768d | 2012-08-21 15:23:35 -0700 | [diff] [blame] | 205 | /* |
| 206 | * Make sure every certificate type is deleted. There can be two types, |
| 207 | * so don't use a conditional here. |
| 208 | */ |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 209 | return keystore.delete(Credentials.USER_CERTIFICATE + alias, uid) |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 210 | & keystore.delete(Credentials.CA_CERTIFICATE + alias, uid); |
Kenny Root | db02671 | 2012-08-20 10:48:46 -0700 | [diff] [blame] | 211 | } |
Alex Klyubin | baf2838 | 2015-03-26 14:46:55 -0700 | [diff] [blame] | 212 | |
| 213 | /** |
Janis Danisevskis | 64338c0 | 2017-04-19 09:17:17 -0700 | [diff] [blame] | 214 | * Delete user key for a particular {@code alias}. |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 215 | * Returns {@code true} if the entry no longer exists. |
Alex Klyubin | baf2838 | 2015-03-26 14:46:55 -0700 | [diff] [blame] | 216 | */ |
Janis Danisevskis | 64338c0 | 2017-04-19 09:17:17 -0700 | [diff] [blame] | 217 | public static boolean deleteUserKeyTypeForAlias(KeyStore keystore, String alias) { |
| 218 | return deleteUserKeyTypeForAlias(keystore, alias, KeyStore.UID_SELF); |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 219 | } |
| 220 | |
| 221 | /** |
Janis Danisevskis | 64338c0 | 2017-04-19 09:17:17 -0700 | [diff] [blame] | 222 | * Delete user key for a particular {@code alias}. |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 223 | * Returns {@code true} if the entry no longer exists. |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 224 | */ |
Janis Danisevskis | 64338c0 | 2017-04-19 09:17:17 -0700 | [diff] [blame] | 225 | public static boolean deleteUserKeyTypeForAlias(KeyStore keystore, String alias, int uid) { |
Janis Danisevskis | 906147c | 2018-11-06 14:14:05 -0800 | [diff] [blame] | 226 | int ret = keystore.delete2(Credentials.USER_PRIVATE_KEY + alias, uid); |
| 227 | if (ret == KeyStore.KEY_NOT_FOUND) { |
| 228 | return keystore.delete(Credentials.USER_SECRET_KEY + alias, uid); |
| 229 | } |
| 230 | return ret == KeyStore.NO_ERROR; |
Alex Klyubin | baf2838 | 2015-03-26 14:46:55 -0700 | [diff] [blame] | 231 | } |
| 232 | |
| 233 | /** |
Janis Danisevskis | 64338c0 | 2017-04-19 09:17:17 -0700 | [diff] [blame] | 234 | * Delete legacy prefixed entry for a particular {@code alias} |
Robin Lee | e4487ea | 2016-02-29 17:43:54 +0000 | [diff] [blame] | 235 | * Returns {@code true} if the entry no longer exists. |
Alex Klyubin | baf2838 | 2015-03-26 14:46:55 -0700 | [diff] [blame] | 236 | */ |
Janis Danisevskis | 64338c0 | 2017-04-19 09:17:17 -0700 | [diff] [blame] | 237 | public static boolean deleteLegacyKeyForAlias(KeyStore keystore, String alias, int uid) { |
Alex Klyubin | 3876b1b | 2015-09-09 14:55:03 -0700 | [diff] [blame] | 238 | return keystore.delete(Credentials.USER_SECRET_KEY + alias, uid); |
Alex Klyubin | baf2838 | 2015-03-26 14:46:55 -0700 | [diff] [blame] | 239 | } |
Chia-chi Yeh | 9b7a3f1 | 2009-09-18 12:00:12 +0800 | [diff] [blame] | 240 | } |