Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 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 | package android.security; |
| 17 | |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 18 | import android.app.Activity; |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 19 | import android.app.PendingIntent; |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 20 | import android.content.ComponentName; |
| 21 | import android.content.Context; |
| 22 | import android.content.Intent; |
| 23 | import android.content.ServiceConnection; |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 24 | import android.os.IBinder; |
| 25 | import android.os.Looper; |
| 26 | import android.os.RemoteException; |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 27 | import java.io.ByteArrayInputStream; |
Brian Carlstrom | d752472 | 2011-05-17 16:20:36 -0700 | [diff] [blame] | 28 | import java.io.Closeable; |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 29 | import java.security.InvalidKeyException; |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 30 | import java.security.Principal; |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 31 | import java.security.PrivateKey; |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 32 | import java.security.cert.Certificate; |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 33 | import java.security.cert.CertificateException; |
| 34 | import java.security.cert.CertificateFactory; |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 35 | import java.security.cert.X509Certificate; |
Brian Carlstrom | db93b78 | 2011-07-01 00:12:17 -0700 | [diff] [blame] | 36 | import java.util.List; |
Brian Carlstrom | 8e9929c | 2011-05-17 00:40:28 -0700 | [diff] [blame] | 37 | import java.util.concurrent.BlockingQueue; |
| 38 | import java.util.concurrent.LinkedBlockingQueue; |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 39 | |
Kenny Root | 12e7522 | 2013-04-23 22:34:24 -0700 | [diff] [blame] | 40 | import com.android.org.conscrypt.OpenSSLEngine; |
| 41 | import com.android.org.conscrypt.TrustedCertificateStore; |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 42 | |
| 43 | /** |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 44 | * The {@code KeyChain} class provides access to private keys and |
| 45 | * their corresponding certificate chains in credential storage. |
| 46 | * |
| 47 | * <p>Applications accessing the {@code KeyChain} normally go through |
| 48 | * these steps: |
| 49 | * |
| 50 | * <ol> |
| 51 | * |
| 52 | * <li>Receive a callback from an {@link javax.net.ssl.X509KeyManager |
| 53 | * X509KeyManager} that a private key is requested. |
| 54 | * |
| 55 | * <li>Call {@link #choosePrivateKeyAlias |
| 56 | * choosePrivateKeyAlias} to allow the user to select from a |
| 57 | * list of currently available private keys and corresponding |
| 58 | * certificate chains. The chosen alias will be returned by the |
| 59 | * callback {@link KeyChainAliasCallback#alias}, or null if no private |
| 60 | * key is available or the user cancels the request. |
| 61 | * |
| 62 | * <li>Call {@link #getPrivateKey} and {@link #getCertificateChain} to |
| 63 | * retrieve the credentials to return to the corresponding {@link |
| 64 | * javax.net.ssl.X509KeyManager} callbacks. |
| 65 | * |
| 66 | * </ol> |
| 67 | * |
| 68 | * <p>An application may remember the value of a selected alias to |
| 69 | * avoid prompting the user with {@link #choosePrivateKeyAlias |
| 70 | * choosePrivateKeyAlias} on subsequent connections. If the alias is |
| 71 | * no longer valid, null will be returned on lookups using that value |
Brian Carlstrom | ca43c45 | 2011-06-29 18:53:17 -0700 | [diff] [blame] | 72 | * |
| 73 | * <p>An application can request the installation of private keys and |
| 74 | * certificates via the {@code Intent} provided by {@link |
| 75 | * #createInstallIntent}. Private keys installed via this {@code |
| 76 | * Intent} will be accessible via {@link #choosePrivateKeyAlias} while |
| 77 | * Certificate Authority (CA) certificates will be trusted by all |
| 78 | * applications through the default {@code X509TrustManager}. |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 79 | */ |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 80 | // TODO reference intent for credential installation when public |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 81 | public final class KeyChain { |
| 82 | |
| 83 | private static final String TAG = "KeyChain"; |
| 84 | |
| 85 | /** |
| 86 | * @hide Also used by KeyChainService implementation |
| 87 | */ |
| 88 | public static final String ACCOUNT_TYPE = "com.android.keychain"; |
| 89 | |
| 90 | /** |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 91 | * Action to bring up the KeyChainActivity |
| 92 | */ |
| 93 | private static final String ACTION_CHOOSER = "com.android.keychain.CHOOSER"; |
| 94 | |
| 95 | /** |
| 96 | * Extra for use with {@link #ACTION_CHOOSER} |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 97 | * @hide Also used by KeyChainActivity implementation |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 98 | */ |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 99 | public static final String EXTRA_RESPONSE = "response"; |
| 100 | |
| 101 | /** |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 102 | * Extra for use with {@link #ACTION_CHOOSER} |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 103 | * @hide Also used by KeyChainActivity implementation |
| 104 | */ |
| 105 | public static final String EXTRA_HOST = "host"; |
| 106 | |
| 107 | /** |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 108 | * Extra for use with {@link #ACTION_CHOOSER} |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 109 | * @hide Also used by KeyChainActivity implementation |
| 110 | */ |
| 111 | public static final String EXTRA_PORT = "port"; |
| 112 | |
| 113 | /** |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 114 | * Extra for use with {@link #ACTION_CHOOSER} |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 115 | * @hide Also used by KeyChainActivity implementation |
| 116 | */ |
| 117 | public static final String EXTRA_ALIAS = "alias"; |
| 118 | |
| 119 | /** |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 120 | * Extra for use with {@link #ACTION_CHOOSER} |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 121 | * @hide Also used by KeyChainActivity implementation |
| 122 | */ |
| 123 | public static final String EXTRA_SENDER = "sender"; |
| 124 | |
| 125 | /** |
Selim Gurun | 93ba4fe | 2012-02-14 11:48:49 -0800 | [diff] [blame] | 126 | * Action to bring up the CertInstaller. |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 127 | */ |
| 128 | private static final String ACTION_INSTALL = "android.credentials.INSTALL"; |
| 129 | |
| 130 | /** |
| 131 | * Optional extra to specify a {@code String} credential name on |
| 132 | * the {@code Intent} returned by {@link #createInstallIntent}. |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 133 | */ |
| 134 | // Compatible with old com.android.certinstaller.CredentialHelper.CERT_NAME_KEY |
| 135 | public static final String EXTRA_NAME = "name"; |
| 136 | |
| 137 | /** |
| 138 | * Optional extra to specify an X.509 certificate to install on |
| 139 | * the {@code Intent} returned by {@link #createInstallIntent}. |
| 140 | * The extra value should be a PEM or ASN.1 DER encoded {@code |
| 141 | * byte[]}. An {@link X509Certificate} can be converted to DER |
| 142 | * encoded bytes with {@link X509Certificate#getEncoded}. |
| 143 | * |
| 144 | * <p>{@link #EXTRA_NAME} may be used to provide a default alias |
| 145 | * name for the installed certificate. |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 146 | */ |
| 147 | // Compatible with old android.security.Credentials.CERTIFICATE |
| 148 | public static final String EXTRA_CERTIFICATE = "CERT"; |
| 149 | |
| 150 | /** |
| 151 | * Optional extra for use with the {@code Intent} returned by |
| 152 | * {@link #createInstallIntent} to specify a PKCS#12 key store to |
| 153 | * install. The extra value should be a {@code byte[]}. The bytes |
| 154 | * may come from an external source or be generated with {@link |
Brian Carlstrom | ca43c45 | 2011-06-29 18:53:17 -0700 | [diff] [blame] | 155 | * java.security.KeyStore#store} on a "PKCS12" instance. |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 156 | * |
| 157 | * <p>The user will be prompted for the password to load the key store. |
| 158 | * |
| 159 | * <p>The key store will be scanned for {@link |
| 160 | * java.security.KeyStore.PrivateKeyEntry} entries and both the |
| 161 | * private key and associated certificate chain will be installed. |
| 162 | * |
| 163 | * <p>{@link #EXTRA_NAME} may be used to provide a default alias |
| 164 | * name for the installed credentials. |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 165 | */ |
| 166 | // Compatible with old android.security.Credentials.PKCS12 |
| 167 | public static final String EXTRA_PKCS12 = "PKCS12"; |
| 168 | |
Selim Gurun | 93ba4fe | 2012-02-14 11:48:49 -0800 | [diff] [blame] | 169 | |
| 170 | /** |
Selim Gurun | 93ba4fe | 2012-02-14 11:48:49 -0800 | [diff] [blame] | 171 | * Broadcast Action: Indicates the trusted storage has changed. Sent when |
| 172 | * one of this happens: |
| 173 | * |
| 174 | * <ul> |
| 175 | * <li>a new CA is added, |
| 176 | * <li>an existing CA is removed or disabled, |
| 177 | * <li>a disabled CA is enabled, |
| 178 | * <li>trusted storage is reset (all user certs are cleared), |
| 179 | * <li>when permission to access a private key is changed. |
| 180 | * </ul> |
| 181 | */ |
| 182 | public static final String ACTION_STORAGE_CHANGED = "android.security.STORAGE_CHANGED"; |
| 183 | |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 184 | /** |
| 185 | * Returns an {@code Intent} that can be used for credential |
| 186 | * installation. The intent may be used without any extras, in |
| 187 | * which case the user will be able to install credentials from |
| 188 | * their own source. |
| 189 | * |
| 190 | * <p>Alternatively, {@link #EXTRA_CERTIFICATE} or {@link |
| 191 | * #EXTRA_PKCS12} maybe used to specify the bytes of an X.509 |
| 192 | * certificate or a PKCS#12 key store for installation. These |
Brian Carlstrom | ca43c45 | 2011-06-29 18:53:17 -0700 | [diff] [blame] | 193 | * extras may be combined with {@link #EXTRA_NAME} to provide a |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 194 | * default alias name for credentials being installed. |
| 195 | * |
| 196 | * <p>When used with {@link Activity#startActivityForResult}, |
| 197 | * {@link Activity#RESULT_OK} will be returned if a credential was |
| 198 | * successfully installed, otherwise {@link |
| 199 | * Activity#RESULT_CANCELED} will be returned. |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 200 | */ |
| 201 | public static Intent createInstallIntent() { |
| 202 | Intent intent = new Intent(ACTION_INSTALL); |
| 203 | intent.setClassName("com.android.certinstaller", |
| 204 | "com.android.certinstaller.CertInstallerMain"); |
| 205 | return intent; |
| 206 | } |
| 207 | |
| 208 | /** |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 209 | * Launches an {@code Activity} for the user to select the alias |
| 210 | * for a private key and certificate pair for authentication. The |
| 211 | * selected alias or null will be returned via the |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 212 | * KeyChainAliasCallback callback. |
| 213 | * |
| 214 | * <p>{@code keyTypes} and {@code issuers} may be used to |
| 215 | * highlight suggested choices to the user, although to cope with |
| 216 | * sometimes erroneous values provided by servers, the user may be |
| 217 | * able to override these suggestions. |
| 218 | * |
| 219 | * <p>{@code host} and {@code port} may be used to give the user |
| 220 | * more context about the server requesting the credentials. |
| 221 | * |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 222 | * <p>{@code alias} allows the chooser to preselect an existing |
| 223 | * alias which will still be subject to user confirmation. |
| 224 | * |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 225 | * @param activity The {@link Activity} context to use for |
| 226 | * launching the new sub-Activity to prompt the user to select |
| 227 | * a private key; used only to call startActivity(); must not |
| 228 | * be null. |
| 229 | * @param response Callback to invoke when the request completes; |
| 230 | * must not be null |
| 231 | * @param keyTypes The acceptable types of asymmetric keys such as |
| 232 | * "RSA" or "DSA", or a null array. |
| 233 | * @param issuers The acceptable certificate issuers for the |
| 234 | * certificate matching the private key, or null. |
| 235 | * @param host The host name of the server requesting the |
| 236 | * certificate, or null if unavailable. |
| 237 | * @param port The port number of the server requesting the |
| 238 | * certificate, or -1 if unavailable. |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 239 | * @param alias The alias to preselect if available, or null if |
| 240 | * unavailable. |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 241 | */ |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 242 | public static void choosePrivateKeyAlias(Activity activity, KeyChainAliasCallback response, |
| 243 | String[] keyTypes, Principal[] issuers, |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 244 | String host, int port, |
| 245 | String alias) { |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 246 | /* |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 247 | * TODO currently keyTypes, issuers are unused. They are meant |
| 248 | * to follow the semantics and purpose of X509KeyManager |
| 249 | * method arguments. |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 250 | * |
| 251 | * keyTypes would allow the list to be filtered and typically |
| 252 | * will be set correctly by the server. In practice today, |
| 253 | * most all users will want only RSA, rarely DSA, and usually |
| 254 | * only a small number of certs will be available. |
| 255 | * |
| 256 | * issuers is typically not useful. Some servers historically |
| 257 | * will send the entire list of public CAs known to the |
| 258 | * server. Others will send none. If this is used, if there |
| 259 | * are no matches after applying the constraint, it should be |
| 260 | * ignored. |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 261 | */ |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 262 | if (activity == null) { |
| 263 | throw new NullPointerException("activity == null"); |
| 264 | } |
| 265 | if (response == null) { |
| 266 | throw new NullPointerException("response == null"); |
| 267 | } |
Brian Carlstrom | a00a2b3 | 2011-06-29 10:42:35 -0700 | [diff] [blame] | 268 | Intent intent = new Intent(ACTION_CHOOSER); |
Fred Quintana | ab8b84a | 2011-07-13 14:55:39 -0700 | [diff] [blame] | 269 | intent.putExtra(EXTRA_RESPONSE, new AliasResponse(response)); |
Brian Carlstrom | 67c30df | 2011-06-24 02:13:23 -0700 | [diff] [blame] | 270 | intent.putExtra(EXTRA_HOST, host); |
| 271 | intent.putExtra(EXTRA_PORT, port); |
| 272 | intent.putExtra(EXTRA_ALIAS, alias); |
| 273 | // the PendingIntent is used to get calling package name |
| 274 | intent.putExtra(EXTRA_SENDER, PendingIntent.getActivity(activity, 0, new Intent(), 0)); |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 275 | activity.startActivity(intent); |
| 276 | } |
| 277 | |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 278 | private static class AliasResponse extends IKeyChainAliasCallback.Stub { |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 279 | private final KeyChainAliasCallback keyChainAliasResponse; |
Fred Quintana | ab8b84a | 2011-07-13 14:55:39 -0700 | [diff] [blame] | 280 | private AliasResponse(KeyChainAliasCallback keyChainAliasResponse) { |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 281 | this.keyChainAliasResponse = keyChainAliasResponse; |
| 282 | } |
| 283 | @Override public void alias(String alias) { |
Fred Quintana | ab8b84a | 2011-07-13 14:55:39 -0700 | [diff] [blame] | 284 | keyChainAliasResponse.alias(alias); |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 285 | } |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 286 | } |
| 287 | |
| 288 | /** |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 289 | * Returns the {@code PrivateKey} for the requested alias, or null |
| 290 | * if no there is no result. |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 291 | * |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 292 | * @param alias The alias of the desired private key, typically |
| 293 | * returned via {@link KeyChainAliasCallback#alias}. |
| 294 | * @throws KeyChainException if the alias was valid but there was some problem accessing it. |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 295 | */ |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 296 | public static PrivateKey getPrivateKey(Context context, String alias) |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 297 | throws KeyChainException, InterruptedException { |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 298 | if (alias == null) { |
| 299 | throw new NullPointerException("alias == null"); |
| 300 | } |
Brian Carlstrom | d752472 | 2011-05-17 16:20:36 -0700 | [diff] [blame] | 301 | KeyChainConnection keyChainConnection = bind(context); |
Brian Carlstrom | 8e9929c | 2011-05-17 00:40:28 -0700 | [diff] [blame] | 302 | try { |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 303 | final IKeyChainService keyChainService = keyChainConnection.getService(); |
| 304 | final String keyId = keyChainService.requestPrivateKey(alias); |
| 305 | if (keyId == null) { |
| 306 | throw new KeyChainException("keystore had a problem"); |
| 307 | } |
| 308 | |
| 309 | final OpenSSLEngine engine = OpenSSLEngine.getInstance("keystore"); |
| 310 | return engine.getPrivateKeyById(keyId); |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 311 | } catch (RemoteException e) { |
| 312 | throw new KeyChainException(e); |
| 313 | } catch (RuntimeException e) { |
| 314 | // only certain RuntimeExceptions can be propagated across the IKeyChainService call |
| 315 | throw new KeyChainException(e); |
Kenny Root | 5423e68 | 2011-11-14 08:43:13 -0800 | [diff] [blame] | 316 | } catch (InvalidKeyException e) { |
| 317 | throw new KeyChainException(e); |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 318 | } finally { |
| 319 | keyChainConnection.close(); |
| 320 | } |
| 321 | } |
| 322 | |
| 323 | /** |
| 324 | * Returns the {@code X509Certificate} chain for the requested |
| 325 | * alias, or null if no there is no result. |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 326 | * |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 327 | * @param alias The alias of the desired certificate chain, typically |
| 328 | * returned via {@link KeyChainAliasCallback#alias}. |
| 329 | * @throws KeyChainException if the alias was valid but there was some problem accessing it. |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 330 | */ |
| 331 | public static X509Certificate[] getCertificateChain(Context context, String alias) |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 332 | throws KeyChainException, InterruptedException { |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 333 | if (alias == null) { |
| 334 | throw new NullPointerException("alias == null"); |
| 335 | } |
| 336 | KeyChainConnection keyChainConnection = bind(context); |
| 337 | try { |
Brian Carlstrom | ba1a667 | 2011-05-24 21:54:37 -0700 | [diff] [blame] | 338 | IKeyChainService keyChainService = keyChainConnection.getService(); |
Kenny Root | 0150e48 | 2013-02-13 15:22:50 -0800 | [diff] [blame] | 339 | |
| 340 | final byte[] certificateBytes = keyChainService.getCertificate(alias); |
| 341 | if (certificateBytes == null) { |
| 342 | return null; |
| 343 | } |
| 344 | |
Brian Carlstrom | db93b78 | 2011-07-01 00:12:17 -0700 | [diff] [blame] | 345 | TrustedCertificateStore store = new TrustedCertificateStore(); |
Kenny Root | 54e03af | 2012-08-07 10:04:26 -0700 | [diff] [blame] | 346 | List<X509Certificate> chain = store |
| 347 | .getCertificateChain(toCertificate(certificateBytes)); |
Brian Carlstrom | db93b78 | 2011-07-01 00:12:17 -0700 | [diff] [blame] | 348 | return chain.toArray(new X509Certificate[chain.size()]); |
Brian Carlstrom | 93201f5 | 2011-06-09 15:05:35 -0700 | [diff] [blame] | 349 | } catch (RemoteException e) { |
| 350 | throw new KeyChainException(e); |
| 351 | } catch (RuntimeException e) { |
| 352 | // only certain RuntimeExceptions can be propagated across the IKeyChainService call |
| 353 | throw new KeyChainException(e); |
Brian Carlstrom | 8e9929c | 2011-05-17 00:40:28 -0700 | [diff] [blame] | 354 | } finally { |
Brian Carlstrom | d752472 | 2011-05-17 16:20:36 -0700 | [diff] [blame] | 355 | keyChainConnection.close(); |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 356 | } |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 357 | } |
| 358 | |
Kenny Root | bf556ac | 2013-04-01 15:10:22 -0700 | [diff] [blame] | 359 | /** |
| 360 | * Returns {@code true} if the current device's {@code KeyChain} supports a |
| 361 | * specific {@code PrivateKey} type indicated by {@code algorithm} (e.g., |
| 362 | * "RSA"). |
| 363 | */ |
Kenny Root | 5b7e90a | 2013-04-02 11:23:41 -0700 | [diff] [blame] | 364 | public static boolean isKeyAlgorithmSupported(String algorithm) { |
Kenny Root | bf556ac | 2013-04-01 15:10:22 -0700 | [diff] [blame] | 365 | return "RSA".equals(algorithm); |
| 366 | } |
| 367 | |
| 368 | /** |
| 369 | * Returns {@code true} if the current device's {@code KeyChain} binds any |
| 370 | * {@code PrivateKey} of the given {@code algorithm} to the device once |
| 371 | * imported or generated. This can be used to tell if there is special |
| 372 | * hardware support that can be used to bind keys to the device in a way |
| 373 | * that makes it non-exportable. |
| 374 | */ |
Kenny Root | 5b7e90a | 2013-04-02 11:23:41 -0700 | [diff] [blame] | 375 | public static boolean isBoundKeyAlgorithm(String algorithm) { |
| 376 | if (!isKeyAlgorithmSupported(algorithm)) { |
Kenny Root | bf556ac | 2013-04-01 15:10:22 -0700 | [diff] [blame] | 377 | return false; |
| 378 | } |
| 379 | |
| 380 | return KeyStore.getInstance().isHardwareBacked(); |
| 381 | } |
| 382 | |
Brian Carlstrom | 8e9929c | 2011-05-17 00:40:28 -0700 | [diff] [blame] | 383 | private static X509Certificate toCertificate(byte[] bytes) { |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 384 | if (bytes == null) { |
Brian Carlstrom | 8e9929c | 2011-05-17 00:40:28 -0700 | [diff] [blame] | 385 | throw new IllegalArgumentException("bytes == null"); |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 386 | } |
| 387 | try { |
| 388 | CertificateFactory certFactory = CertificateFactory.getInstance("X.509"); |
| 389 | Certificate cert = certFactory.generateCertificate(new ByteArrayInputStream(bytes)); |
| 390 | return (X509Certificate) cert; |
| 391 | } catch (CertificateException e) { |
| 392 | throw new AssertionError(e); |
| 393 | } |
| 394 | } |
| 395 | |
Brian Carlstrom | d752472 | 2011-05-17 16:20:36 -0700 | [diff] [blame] | 396 | /** |
| 397 | * @hide for reuse by CertInstaller and Settings. |
| 398 | * @see KeyChain#bind |
| 399 | */ |
| 400 | public final static class KeyChainConnection implements Closeable { |
| 401 | private final Context context; |
| 402 | private final ServiceConnection serviceConnection; |
| 403 | private final IKeyChainService service; |
| 404 | private KeyChainConnection(Context context, |
| 405 | ServiceConnection serviceConnection, |
| 406 | IKeyChainService service) { |
| 407 | this.context = context; |
| 408 | this.serviceConnection = serviceConnection; |
| 409 | this.service = service; |
| 410 | } |
| 411 | @Override public void close() { |
| 412 | context.unbindService(serviceConnection); |
| 413 | } |
| 414 | public IKeyChainService getService() { |
| 415 | return service; |
| 416 | } |
| 417 | } |
| 418 | |
| 419 | /** |
| 420 | * @hide for reuse by CertInstaller and Settings. |
| 421 | * |
| 422 | * Caller should call unbindService on the result when finished. |
| 423 | */ |
| 424 | public static KeyChainConnection bind(Context context) throws InterruptedException { |
| 425 | if (context == null) { |
| 426 | throw new NullPointerException("context == null"); |
| 427 | } |
| 428 | ensureNotOnMainThread(context); |
| 429 | final BlockingQueue<IKeyChainService> q = new LinkedBlockingQueue<IKeyChainService>(1); |
| 430 | ServiceConnection keyChainServiceConnection = new ServiceConnection() { |
Fred Quintana | ab8b84a | 2011-07-13 14:55:39 -0700 | [diff] [blame] | 431 | volatile boolean mConnectedAtLeastOnce = false; |
Brian Carlstrom | d752472 | 2011-05-17 16:20:36 -0700 | [diff] [blame] | 432 | @Override public void onServiceConnected(ComponentName name, IBinder service) { |
Fred Quintana | ab8b84a | 2011-07-13 14:55:39 -0700 | [diff] [blame] | 433 | if (!mConnectedAtLeastOnce) { |
| 434 | mConnectedAtLeastOnce = true; |
| 435 | try { |
| 436 | q.put(IKeyChainService.Stub.asInterface(service)); |
| 437 | } catch (InterruptedException e) { |
| 438 | // will never happen, since the queue starts with one available slot |
| 439 | } |
Brian Carlstrom | d752472 | 2011-05-17 16:20:36 -0700 | [diff] [blame] | 440 | } |
| 441 | } |
| 442 | @Override public void onServiceDisconnected(ComponentName name) {} |
| 443 | }; |
| 444 | boolean isBound = context.bindService(new Intent(IKeyChainService.class.getName()), |
| 445 | keyChainServiceConnection, |
| 446 | Context.BIND_AUTO_CREATE); |
| 447 | if (!isBound) { |
| 448 | throw new AssertionError("could not bind to KeyChainService"); |
| 449 | } |
| 450 | return new KeyChainConnection(context, keyChainServiceConnection, q.take()); |
| 451 | } |
| 452 | |
Brian Carlstrom | 8e9929c | 2011-05-17 00:40:28 -0700 | [diff] [blame] | 453 | private static void ensureNotOnMainThread(Context context) { |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 454 | Looper looper = Looper.myLooper(); |
Brian Carlstrom | 8e9929c | 2011-05-17 00:40:28 -0700 | [diff] [blame] | 455 | if (looper != null && looper == context.getMainLooper()) { |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 456 | throw new IllegalStateException( |
| 457 | "calling this from your main thread can lead to deadlock"); |
| 458 | } |
| 459 | } |
Brian Carlstrom | b9a07c1 | 2011-04-11 09:03:51 -0700 | [diff] [blame] | 460 | } |