1adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/* 2adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 3adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 4adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this work for additional information regarding copyright ownership. 5adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 6adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (the "License"); you may not use this file except in compliance with 7adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the License. You may obtain a copy of the License at 8adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 9adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 10adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 11adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Unless required by applicable law or agreed to in writing, software 12adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 13adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * See the License for the specific language governing permissions and 15adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * limitations under the License. 16adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 17adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 18adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpackage java.security; 19adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 20adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.io.File; 21adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.io.FileInputStream; 22adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.io.IOException; 23adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.io.InputStream; 24adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.io.OutputStream; 25adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.security.cert.Certificate; 26adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.security.cert.CertificateException; 272f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughesimport java.security.cert.X509Certificate; 28adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.util.Arrays; 29adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.util.Date; 30adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.util.Enumeration; 31adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport javax.crypto.SecretKey; 32adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport javax.security.auth.DestroyFailedException; 33adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport javax.security.auth.Destroyable; 34adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport javax.security.auth.callback.CallbackHandler; 35a7a70410e26802f3ab480b08a1ab499338cb6f7eJesse Wilsonimport libcore.io.IoUtils; 36adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport org.apache.harmony.security.fortress.Engine; 37adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 38adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 39adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code KeyStore} is responsible for maintaining cryptographic keys and their 40adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * owners. 41adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 422f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * The type of the system key store can be changed by setting the {@code 43adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 'keystore.type'} property in the file named {@code 44adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * JAVA_HOME/lib/security/java.security}. 452f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 46adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see Certificate 47adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see PrivateKey 48adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 49adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpublic class KeyStore { 50adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 51adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store KeyStore SERVICE name 52f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes private static final String SERVICE = "KeyStore"; 53adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 54adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Used to access common engine functionality 550a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom private static final Engine ENGINE = new Engine(SERVICE); 56adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 57adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store KeyStore property name 58f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes private static final String PROPERTYNAME = "keystore.type"; 59adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 60adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store default KeyStore type 61f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes private static final String DEFAULT_KEYSTORE_TYPE = "jks"; 62adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 63adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store KeyStore state (initialized or not) 64adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private boolean isInit; 65adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 66adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store used KeyStoreSpi 67adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final KeyStoreSpi implSpi; 68adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 69adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store used provider 70adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final Provider provider; 71adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 72adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store used type 73adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final String type; 74adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 75adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 76adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Constructs a new instance of {@code KeyStore} with the given arguments. 772f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 78adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param keyStoreSpi 79adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the concrete key store. 80adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param provider 81adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the provider. 82adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param type 83adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the type of the {@code KeyStore} to be constructed. 84adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 85adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected KeyStore(KeyStoreSpi keyStoreSpi, Provider provider, String type) { 86adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.type = type; 87adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.provider = provider; 88adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.implSpi = keyStoreSpi; 89adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project isInit = false; 90adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 91adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 92adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 93adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Throws the standard "keystore not initialized" exception. 94adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 95adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private static void throwNotInitialized() throws KeyStoreException { 96897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new KeyStoreException("KeyStore was not initialized"); 97adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 98adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 99adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 100adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a new instance of {@code KeyStore} with the specified type. 1012f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 102adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param type 103adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the type of the returned {@code KeyStore}. 104adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a new instance of {@code KeyStore} with the specified type. 105adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 106adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if an error occurred during the creation of the new {@code 107adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * KeyStore}. 108897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes * @throws NullPointerException if {@code type == null} 109adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see #getDefaultType 110adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 111adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static KeyStore getInstance(String type) throws KeyStoreException { 112adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (type == null) { 11386acc043d3334651ee26c65467d78d6cefedd397Kenny Root throw new NullPointerException("type == null"); 114adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1156cdb6b7e6939270ccd21790ec95e42197cefc0c3Brian Carlstrom try { 1166cdb6b7e6939270ccd21790ec95e42197cefc0c3Brian Carlstrom Engine.SpiAndProvider sap = ENGINE.getInstance(type, null); 1176cdb6b7e6939270ccd21790ec95e42197cefc0c3Brian Carlstrom return new KeyStore((KeyStoreSpi) sap.spi, sap.provider, type); 1186cdb6b7e6939270ccd21790ec95e42197cefc0c3Brian Carlstrom } catch (NoSuchAlgorithmException e) { 119347b2a604114602da9bc4ae040278f74d11c2f51Brian Carlstrom throw new KeyStoreException(e); 120adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 121adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 122adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 123adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 124adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a new instance of {@code KeyStore} from the specified provider 125adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * with the given type. 1262f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 127adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param type 128adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the type of the returned {@code KeyStore}. 129adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param provider 130adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * name of the provider of the {@code KeyStore}. 131adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a new instance of {@code KeyStore} from the specified provider 132adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * with the given type. 133adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 134adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if an error occurred during the creation of the new {@code 135adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * KeyStore}. 136adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NoSuchProviderException 137adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the specified provider is not available. 138897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes * @throws IllegalArgumentException if {@code provider == null || provider.isEmpty()} 1392f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * @throws NullPointerException 1402f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * if {@code type} is {@code null} (instead of 1412f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * NoSuchAlgorithmException) as in 1.4 release 142adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see #getDefaultType 143adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 144adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static KeyStore getInstance(String type, String provider) 145adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throws KeyStoreException, NoSuchProviderException { 146897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes if (provider == null || provider.isEmpty()) { 147897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new IllegalArgumentException(); 148adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 149adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project Provider impProvider = Security.getProvider(provider); 150adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (impProvider == null) { 151adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw new NoSuchProviderException(provider); 152adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 153adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project try { 154adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return getInstance(type, impProvider); 155adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } catch (Exception e) { 156347b2a604114602da9bc4ae040278f74d11c2f51Brian Carlstrom throw new KeyStoreException(e); 157adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 158adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 159adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 160adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 161adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a new instance of {@code KeyStore} from the specified provider 162adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * with the given type. 1632f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 164adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param type 165adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the type of the returned {@code KeyStore}. 166adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param provider 167adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the provider of the {@code KeyStore}. 168adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a new instance of {@code KeyStore} from the specified provider 169adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * with the given type. 170adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 171adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if an error occurred during the creation of the new {@code 172adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * KeyStore}. 173adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalArgumentException 174adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code provider} is {@code null} or the empty string. 175897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes * @throws NullPointerException if {@code type == null} (instead of 1762f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * NoSuchAlgorithmException) as in 1.4 release 177adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see #getDefaultType 178adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 179ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes public static KeyStore getInstance(String type, Provider provider) throws KeyStoreException { 180adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // check parameters 181adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (provider == null) { 182897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new IllegalArgumentException(); 183adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 184adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (type == null) { 18586acc043d3334651ee26c65467d78d6cefedd397Kenny Root throw new NullPointerException("type == null"); 186adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 187adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // return KeyStore instance 1886cdb6b7e6939270ccd21790ec95e42197cefc0c3Brian Carlstrom try { 1896cdb6b7e6939270ccd21790ec95e42197cefc0c3Brian Carlstrom Object spi = ENGINE.getInstance(type, provider, null); 1906cdb6b7e6939270ccd21790ec95e42197cefc0c3Brian Carlstrom return new KeyStore((KeyStoreSpi) spi, provider, type); 1916cdb6b7e6939270ccd21790ec95e42197cefc0c3Brian Carlstrom } catch (Exception e) { 192adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // override exception 193347b2a604114602da9bc4ae040278f74d11c2f51Brian Carlstrom throw new KeyStoreException(e); 194adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 195adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 196adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 197adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 198adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the default type for {@code KeyStore} instances. 199ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes * 200ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes * <p>The default is specified in the {@code 'keystore.type'} property in the 201ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes * file named {@code java.security} properties file. If this property 202adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * is not set, {@code "jks"} will be used. 2032f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 204adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the default type for {@code KeyStore} instances 205adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 206adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static final String getDefaultType() { 207ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes String dt = Security.getProperty(PROPERTYNAME); 208adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return (dt == null ? DEFAULT_KEYSTORE_TYPE : dt); 209adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 210adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 211adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 212adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the provider associated with this {@code KeyStore}. 2132f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 214adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the provider associated with this {@code KeyStore}. 215adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 216adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final Provider getProvider() { 217adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return provider; 218adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 219adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 220adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 221adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the type of this {@code KeyStore}. 2222f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 223adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the type of this {@code KeyStore}. 224adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 225adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final String getType() { 226adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return type; 227adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 228adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 229adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 230adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the key with the given alias, using the password to recover the 231adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * key from the store. 2322f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 233adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 234adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the entry. 235adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param password 236adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the password used to recover the key. 237adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the key with the specified alias, or {@code null} if the 238adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * specified alias is not bound to an entry. 239adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 240adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 241adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NoSuchAlgorithmException 242adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the algorithm for recovering the key is not available. 243adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws UnrecoverableKeyException 244adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the key can not be recovered. 245adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 246adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final Key getKey(String alias, char[] password) 247adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throws KeyStoreException, NoSuchAlgorithmException, 248adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project UnrecoverableKeyException { 249adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 250adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 251adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 252adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineGetKey(alias, password); 253adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 254adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 255adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 256adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the certificate chain for the entry with the given alias. 2572f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 258adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 259adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the entry. 260adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the certificate chain for the entry with the given alias, or 261adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code null} if the specified alias is not bound to an entry. 262adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 263adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 264adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 265fb0ec0e650bf8be35acb0d47da0311a7c446aa33Elliott Hughes public final Certificate[] getCertificateChain(String alias) throws KeyStoreException { 266adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 267adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 268adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 269adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineGetCertificateChain(alias); 270adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 271adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 272adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 273adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the trusted certificate for the entry with the given alias. 2742f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 275adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 276adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the entry. 277adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the trusted certificate for the entry with the given alias, or 278adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code null} if the specified alias is not bound to an entry. 279adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 280adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 281adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 282fb0ec0e650bf8be35acb0d47da0311a7c446aa33Elliott Hughes public final Certificate getCertificate(String alias) throws KeyStoreException { 283adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 284adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 285adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 286adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineGetCertificate(alias); 287adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 288adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 289adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 290adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the creation date of the entry with the given alias. 2912f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 292adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 293adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the entry. 294adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the creation date, or {@code null} if the specified alias is not 295adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * bound to an entry. 296adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 297adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 298adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 299adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final Date getCreationDate(String alias) throws KeyStoreException { 300adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 301adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 302adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 303adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineGetCreationDate(alias); 304adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 305adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 306adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 307adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Associates the given alias with the key, password and certificate chain. 308adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 309adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If the specified alias already exists, it will be reassigned. 3102f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 311adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 312adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the key. 313adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param key 314adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the key. 315adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param password 316adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the password. 317adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param chain 318adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the certificate chain. 319adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 320adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 321adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalArgumentException 322adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code key} is a {@code PrivateKey} and {@code chain} does 323adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * not contain any certificates. 3242f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * @throws NullPointerException 3252f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * if {@code alias} is {@code null}. 326adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 327adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final void setKeyEntry(String alias, Key key, char[] password, 328adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project Certificate[] chain) throws KeyStoreException { 329adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 330adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 331adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 332adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 333adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Certificate chain is required for PrivateKey 334b46dab348e2007bc08abaf7ecae34d89a2474e50Elliott Hughes if (key != null && key instanceof PrivateKey && (chain == null || chain.length == 0)) { 335897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new IllegalArgumentException("Certificate chain is not defined for Private key"); 336adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 337adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project implSpi.engineSetKeyEntry(alias, key, password, chain); 338adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 339adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 340adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 341adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Associates the given alias with a key and a certificate chain. 342adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 343adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If the specified alias already exists, it will be reassigned. 344adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 345adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If this {@code KeyStore} is of type {@code "jks"}, {@code key} must be 346adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * encoded conform to the PKS#8 standard as an 347adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@link javax.crypto.EncryptedPrivateKeyInfo}. 3482f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 349adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 350adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the key. 351adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param key 352adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the key in an encoded format. 353adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param chain 354adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the certificate chain. 355adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 3562f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * if this {@code KeyStore} is not initialized or if {@code key} 3572f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * is null. 358adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalArgumentException 359adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code key} is a {@code PrivateKey} and {@code chain} 360adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * does. 3612f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * @throws NullPointerException 3622f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * if {@code alias} is {@code null}. 363adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 364adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final void setKeyEntry(String alias, byte[] key, Certificate[] chain) 365adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throws KeyStoreException { 366adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 367adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 368adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 369adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project implSpi.engineSetKeyEntry(alias, key, chain); 370adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 371adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 372adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 373adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Associates the given alias with a certificate. 374adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 375adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If the specified alias already exists, it will be reassigned. 3762f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 377adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 378adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the certificate. 379adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param cert 380adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the certificate. 381adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 382adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized, or an existing 383adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * alias is not associated to an entry containing a trusted 384adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * certificate, or this method fails for any other reason. 3852f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * @throws NullPointerException 3862f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * if {@code alias} is {@code null}. 387adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 388fb0ec0e650bf8be35acb0d47da0311a7c446aa33Elliott Hughes public final void setCertificateEntry(String alias, Certificate cert) throws KeyStoreException { 389adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 390adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 391adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 392adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project implSpi.engineSetCertificateEntry(alias, cert); 393adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 394adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 395adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 396adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Deletes the entry identified with the given alias from this {@code 397adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * KeyStore}. 3982f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 399adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 400adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the entry. 401adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 402adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized, or if the entry 403adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * can not be deleted. 404adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 405adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final void deleteEntry(String alias) throws KeyStoreException { 406adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 407adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 4082f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes } 409adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project implSpi.engineDeleteEntry(alias); 410adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 411adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 412adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 413adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns an {@code Enumeration} over all alias names stored in this 414adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code KeyStore}. 4152f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 416adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return an {@code Enumeration} over all alias names stored in this 417adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code KeyStore}. 418adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 419adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 420adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 421adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final Enumeration<String> aliases() throws KeyStoreException { 422adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 423adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 424adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 425adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineAliases(); 426adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 427adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 428adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 429adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Indicates whether the given alias is present in this {@code KeyStore}. 4302f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 431adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 432adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias of an entry. 433adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return {@code true} if the alias exists, {@code false} otherwise. 434adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 435adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 436adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 437adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final boolean containsAlias(String alias) throws KeyStoreException { 438adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 439adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 440adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 441adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineContainsAlias(alias); 442adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 443adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 444adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 445adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the number of entries stored in this {@code KeyStore}. 4462f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 447adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the number of entries stored in this {@code KeyStore}. 448adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 449adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 450adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 451adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final int size() throws KeyStoreException { 452adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 453adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 454adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 455adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineSize(); 456adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 457adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 458adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 459adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Indicates whether the specified alias is associated with either a 460adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@link PrivateKeyEntry} or a {@link SecretKeyEntry}. 4612f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 462adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 463adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias of an entry. 464adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return {@code true} if the given alias is associated with a key entry. 465adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 466adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 467adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 468adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final boolean isKeyEntry(String alias) throws KeyStoreException { 469adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 470adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 4712f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes } 472adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineIsKeyEntry(alias); 473adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 474adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 475adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 476adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Indicates whether the specified alias is associated with a 477adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@link TrustedCertificateEntry}. 4782f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 479adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 480adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias of an entry. 481adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return {@code true} if the given alias is associated with a certificate 482adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * entry. 483adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 484adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 485adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 486fb0ec0e650bf8be35acb0d47da0311a7c446aa33Elliott Hughes public final boolean isCertificateEntry(String alias) throws KeyStoreException { 487adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 488adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 4892f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes } 490adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineIsCertificateEntry(alias); 491adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 492adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 493adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 494adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the alias associated with the first entry whose certificate 495adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * matches the specified certificate. 4962f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 497adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param cert 498adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the certificate to find the associated entry's alias for. 499adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the alias or {@code null} if no entry with the specified 500adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * certificate can be found. 501adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 502adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 503adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 504fb0ec0e650bf8be35acb0d47da0311a7c446aa33Elliott Hughes public final String getCertificateAlias(Certificate cert) throws KeyStoreException { 505adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 506adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 507adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 508adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineGetCertificateAlias(cert); 509adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 510adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 511adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 512adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Writes this {@code KeyStore} to the specified {@code OutputStream}. The 513adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * data written to the {@code OutputStream} is protected by the specified 514adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * password. 5152f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 516adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param stream 517adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code OutputStream} to write the store's data to. 518adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param password 519adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the password to protect the data. 520adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 521adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 522adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IOException 523adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if a problem occurred while writing to the stream. 524adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NoSuchAlgorithmException 525adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the required algorithm is not available. 526adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws CertificateException 527adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if an exception occurred while storing the certificates of 528adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this {@code KeyStore}. 529adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 530adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final void store(OutputStream stream, char[] password) 531fb0ec0e650bf8be35acb0d47da0311a7c446aa33Elliott Hughes throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException { 532adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 533adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 534adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 5352f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes 5362f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes //Just delegate stream and password to implSpi 537adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project implSpi.engineStore(stream, password); 538adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 539adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 540adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 541adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Stores this {@code KeyStore} using the specified {@code 542adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * LoadStoreParameter}. 5432f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 544adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param param 545adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code LoadStoreParameter} that specifies how to store 546adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this {@code KeyStore}, maybe {@code null}. 547adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 548adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 549adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IOException 550adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if a problem occurred while writing to the stream. 551adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NoSuchAlgorithmException 552adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the required algorithm is not available. 553adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws CertificateException 554adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if an exception occurred while storing the certificates of 555adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this {@code KeyStore}. 556adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalArgumentException 557adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the given {@link LoadStoreParameter} is not recognized. 558adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 559adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final void store(LoadStoreParameter param) throws KeyStoreException, 560adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project IOException, NoSuchAlgorithmException, CertificateException { 561adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 562adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 563adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 564adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project implSpi.engineStore(param); 565adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 566adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 567adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 568adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Initializes this {@code KeyStore} from the provided {@code InputStream}. 569adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Pass {@code null} as the {@code stream} argument to initialize an empty 570adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code KeyStore} or to initialize a {@code KeyStore} which does not rely 571adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * on an {@code InputStream}. This {@code KeyStore} utilizes the given 572adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * password to verify the stored data. 5732f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 574adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param stream 575adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code InputStream} to load this {@code KeyStore}'s data 576adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * from or {@code null}. 577adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param password 578adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the password to verify the stored data, maybe {@code null}. 579adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IOException 580adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if a problem occurred while reading from the stream. 581adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NoSuchAlgorithmException 582adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the required algorithm is not available. 583adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws CertificateException 584adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if an exception occurred while loading the certificates of 585adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this {@code KeyStore}. 586adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 587adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final void load(InputStream stream, char[] password) 588adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throws IOException, NoSuchAlgorithmException, CertificateException { 589adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project implSpi.engineLoad(stream, password); 590adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project isInit = true; 591adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 592adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 593adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 594adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Loads this {@code KeyStore} using the specified {@code 595adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * LoadStoreParameter}. 5962f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 597adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param param 598adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code LoadStoreParameter} that specifies how to load this 599adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code KeyStore}, maybe {@code null}. 600adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IOException 601adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if a problem occurred while reading from the stream. 602adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NoSuchAlgorithmException 603adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the required algorithm is not available. 604adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws CertificateException 605adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if an exception occurred while loading the certificates of 606adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this {@code KeyStore}. 607adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalArgumentException 608adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the given {@link LoadStoreParameter} is not recognized. 609adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 610adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final void load(LoadStoreParameter param) throws IOException, 611adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project NoSuchAlgorithmException, CertificateException { 612adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project implSpi.engineLoad(param); 613adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project isInit = true; 614adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 615adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 616adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 617adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the {@code Entry} with the given alias, using the specified 618adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code ProtectionParameter}. 6192f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 620adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 621adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias of the requested entry. 622adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param param 623adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code ProtectionParameter} used to protect the requested 624adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * entry, maybe {@code null}. 625adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return he {@code Entry} with the given alias, using the specified 626adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code ProtectionParameter}. 627adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NoSuchAlgorithmException 628adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the required algorithm is not available. 629adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws UnrecoverableEntryException 630adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the entry can not be recovered. 631adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 632adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 6332f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * @throws NullPointerException 6342f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * if {@code alias} is {@code null}. 635adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 636adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final Entry getEntry(String alias, ProtectionParameter param) 637fb0ec0e650bf8be35acb0d47da0311a7c446aa33Elliott Hughes throws NoSuchAlgorithmException, UnrecoverableEntryException, KeyStoreException { 638adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (alias == null) { 639897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("alias == null"); 640adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 641adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 642adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 643adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 644adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineGetEntry(alias, param); 645adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 646adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 647adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 648adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Stores the given {@code Entry} in this {@code KeyStore} and associates 649adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the entry with the given {@code alias}. The entry is protected by the 650adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * specified {@code ProtectionParameter}. 651adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 652adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If the specified alias already exists, it will be reassigned. 6532f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 654adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 655adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the entry. 656adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param entry 657adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the entry to store. 658adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param param 659adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code ProtectionParameter} to protect the entry. 660adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 661adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 6622f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * @throws NullPointerException 6632f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * if {@code alias} is {@code null} or {@code entry} is {@code 6642f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * null}. 665adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 666adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public final void setEntry(String alias, Entry entry, 667adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project ProtectionParameter param) throws KeyStoreException { 668adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 669adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 670adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 671adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (alias == null) { 672897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("alias == null"); 673adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 674adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (entry == null) { 675897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("entry == null"); 676adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 677adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project implSpi.engineSetEntry(alias, entry, param); 678adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 679adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 680adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 681adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Indicates whether the entry for the given alias is assignable to the 682adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * provided {@code Class}. 6832f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 684adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 685adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the entry. 686adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param entryClass 687adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the type of the entry. 688adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return {@code true} if the {@code Entry} for the alias is assignable to 689adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the specified {@code entryClass}. 690adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 691adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code KeyStore} is not initialized. 692adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 693f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes public final boolean entryInstanceOf(String alias, 694adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project Class<? extends KeyStore.Entry> entryClass) 695adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throws KeyStoreException { 696adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (alias == null) { 697897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("alias == null"); 698adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 699adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (entryClass == null) { 700897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("entryClass == null"); 701adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 702adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 703adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isInit) { 704adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throwNotInitialized(); 705adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 706adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return implSpi.engineEntryInstanceOf(alias, entryClass); 707adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 708adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 709adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 710adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code Builder} is used to construct new instances of {@code KeyStore}. 711adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 712adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public abstract static class Builder { 713adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 714adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Constructs a new instance of {@code Builder}. 715adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 716adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected Builder() { 717adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 718adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 719adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 720adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the {@code KeyStore} created by this {@code Builder}. 7212f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 722adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the {@code KeyStore} created by this {@code Builder}. 723adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 724adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if an error occurred during construction. 725adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 726adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public abstract KeyStore getKeyStore() throws KeyStoreException; 727adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 728adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 729adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the {@code ProtectionParameter} to be used when a {@code 730adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Entry} with the specified alias is requested. Before this method is 731adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * invoked, {@link #getKeyStore()} must be called. 7322f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 733adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 734adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias for the entry. 735adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the {@code ProtectionParameter} to be used when a {@code 736adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Entry} with the specified alias is requested. 737adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws KeyStoreException 738adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if an error occurred during the lookup for the protection 739adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * parameter. 740adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalStateException 741adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@link #getKeyStore()} is not called prior the 742adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * invocation of this method. 743adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NullPointerException 744adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code alias} is {@code null}. 745adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 746adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public abstract ProtectionParameter getProtectionParameter(String alias) 747adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throws KeyStoreException; 748adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 749adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 750adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a new {@code Builder} that holds the given {@code KeyStore} 751adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * and the given {@code ProtectionParameter}. 7522f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 753adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param keyStore 754adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code KeyStore} to be held. 755adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param protectionParameter 756adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code ProtectionParameter} to be held. 757adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a new instance of {@code Builder} that holds the specified 758adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code KeyStore} and the specified {@code 759adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * ProtectionParameter}. 760adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NullPointerException 761adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code keyStore} or {@code protectionParameter} is 762adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code null}. 763adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalArgumentException 764adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the given {@code KeyStore} is not initialized. 765adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 766adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static Builder newInstance(KeyStore keyStore, 767adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project ProtectionParameter protectionParameter) { 768adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (keyStore == null) { 769897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("keyStore == null"); 770adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 771adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (protectionParameter == null) { 772897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("protectionParameter == null"); 773adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 774adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!keyStore.isInit) { 775897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new IllegalArgumentException("KeyStore was not initialized"); 776adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 777ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes return new BuilderImpl(keyStore, protectionParameter, null, null, null); 778adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 779adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 780adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 781adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a new {@code Builder} that creates a new {@code KeyStore} 782adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * based on the provided arguments. 783adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 784adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If {@code provider} is {@code null}, all installed providers are 785adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * searched, otherwise the key store from the specified provider is 786adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * used. 7872f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 788adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param type 789adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the type of the {@code KeyStore} to be constructed. 790adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param provider 791adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the provider of the {@code KeyStore} to be constructed, 792adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * maybe {@code null}. 793adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param file 794adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code File} that contains the data for the {@code 795adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * KeyStore}. 796adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param protectionParameter 797adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code ProtectionParameter} used to protect the stored 798adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * keys. 799adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a new {@code Builder} that creates a new {@code KeyStore} 800adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * based on the provided arguments. 801adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NullPointerException 802adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code type, protectionParameter} or {@code file} is 803adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code null}. 804adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalArgumentException 805adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code protectionParameter} not an instance of either 806adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code PasswordProtection} or {@code 807adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * CallbackHandlerProtection}, {@code file} is not a file or 808adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * does not exist at all. 809adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 810adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static Builder newInstance(String type, Provider provider, 811adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project File file, ProtectionParameter protectionParameter) { 812adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // check null parameters 813adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (type == null) { 814897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("type == null"); 815adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 816adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (protectionParameter == null) { 817897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("protectionParameter == null"); 818adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 819adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (file == null) { 820897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("file == null"); 821adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 822adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // protection parameter should be PasswordProtection or 823adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // CallbackHandlerProtection 824adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!(protectionParameter instanceof PasswordProtection) 825adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project && !(protectionParameter instanceof CallbackHandlerProtection)) { 8260a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom throw new IllegalArgumentException("protectionParameter is neither " 8270a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom + "PasswordProtection nor CallbackHandlerProtection instance"); 828adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 829adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // check file parameter 830adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!file.exists()) { 831897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new IllegalArgumentException("File does not exist: " + file.getName()); 832adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 833adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!file.isFile()) { 834897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new IllegalArgumentException("Not a regular file: " + file.getName()); 835adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 836adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // create new instance 837ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes return new BuilderImpl(null, protectionParameter, file, type, provider); 838adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 839adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 840adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 841adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a new {@code Builder} that creates a new {@code KeyStore} 842adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * based on the provided arguments. 843adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 844adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If {@code provider} is {@code null}, all installed providers are 845adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * searched, otherwise the key store from the specified provider is 846adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * used. 8472f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 848adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param type 849adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the type of the {@code KeyStore} to be constructed. 850adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param provider 851adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the provider of the {@code KeyStore} to be constructed, 852adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * maybe {@code null}. 853adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param protectionParameter 854adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code ProtectionParameter} used to protect the stored 855adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * keys. 856adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a new {@code Builder} that creates a new {@code KeyStore} 857adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * based on the provided arguments. 858adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NullPointerException 859adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code type} or {@code protectionParameter} is {@code 860adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * null}. 861adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalArgumentException 862adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code protectionParameter} not an instance of either 863adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code PasswordProtection} or {@code 864adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * CallbackHandlerProtection}, {@code file} is not a file or 865adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * does not exist at all. 866adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 867adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static Builder newInstance(String type, Provider provider, 868adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project ProtectionParameter protectionParameter) { 869adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (type == null) { 870897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("type == null"); 871adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 872adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (protectionParameter == null) { 873897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("protectionParameter == null"); 874adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 875ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes return new BuilderImpl(null, protectionParameter, null, type, provider); 876adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 877adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 878adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /* 879adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * This class is implementation of abstract class KeyStore.Builder 880f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 881adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @author Vera Petrashkova 882f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 883adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 884adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private static class BuilderImpl extends Builder { 885adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store used KeyStore 886adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private KeyStore keyStore; 887adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 888adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store used ProtectionParameter 889adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private ProtectionParameter protParameter; 890adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 891adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store used KeyStore type 892adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final String typeForKeyStore; 893adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 894adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store used KeyStore provider 895adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final Provider providerForKeyStore; 896adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 897adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store used file for KeyStore loading 898adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final File fileForLoad; 899adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 900adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store getKeyStore method was invoked or not for KeyStoreBuilder 901adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private boolean isGetKeyStore = false; 902adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 903adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store last Exception in getKeyStore() 904adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private KeyStoreException lastException; 905adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 9060a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom /** 9070a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * Constructor BuilderImpl initializes private fields: keyStore, 9080a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * protParameter, typeForKeyStore providerForKeyStore fileForLoad, 9090a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * isGetKeyStore 9100a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom */ 911adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project BuilderImpl(KeyStore ks, ProtectionParameter pp, File file, 912ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes String type, Provider provider) { 913adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project keyStore = ks; 914adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protParameter = pp; 915adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project fileForLoad = file; 916adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project typeForKeyStore = type; 917adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project providerForKeyStore = provider; 918adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project isGetKeyStore = false; 919adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project lastException = null; 920adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 921adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 9220a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom /** 9230a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * Implementation of abstract getKeyStore() method If 9240a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * KeyStoreBuilder encapsulates KeyStore object then this object is 9250a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * returned 9260a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * 9270a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * If KeyStoreBuilder encapsulates KeyStore type and provider then 9280a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * KeyStore is created using these parameters. If KeyStoreBuilder 9290a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * encapsulates file and ProtectionParameter then KeyStore data are 9300a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * loaded from FileInputStream that is created on file. If file is 9310a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * not defined then KeyStore object is initialized with null 9320a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * InputStream and null password. 9330a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * 9340a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * Result KeyStore object is returned. 9350a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom */ 9362f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes @Override 937adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public synchronized KeyStore getKeyStore() throws KeyStoreException { 938adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // If KeyStore was created but in final block some exception was 939adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // thrown 940adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // then it was stored in lastException variable and will be 941adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // thrown 942adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // all subsequent calls of this method. 943adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (lastException != null) { 944adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw lastException; 945adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 946adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (keyStore != null) { 947adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project isGetKeyStore = true; 948adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return keyStore; 949adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 950adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 951adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project try { 952adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // get KeyStore instance using type or type and provider 953ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes final KeyStore ks = (providerForKeyStore == null ? KeyStore 954adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project .getInstance(typeForKeyStore) : KeyStore 955adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project .getInstance(typeForKeyStore, providerForKeyStore)); 956adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // protection parameter should be PasswordProtection 957adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // or CallbackHandlerProtection 958ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes final char[] passwd; 959adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (protParameter instanceof PasswordProtection) { 960adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project passwd = ((PasswordProtection) protParameter) 961adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project .getPassword(); 962adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } else if (protParameter instanceof CallbackHandlerProtection) { 963adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project passwd = KeyStoreSpi 964adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project .getPasswordFromCallBack(protParameter); 965adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } else { 9660a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom throw new KeyStoreException("protectionParameter is neither " 9670a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom + "PasswordProtection nor CallbackHandlerProtection instance"); 968adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 969adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 970adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // load KeyStore from file 971ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes if (fileForLoad != null) { 972ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes FileInputStream fis = null; 973ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes try { 974ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes fis = new FileInputStream(fileForLoad); 975ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes ks.load(fis, passwd); 976ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes } finally { 977ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes IoUtils.closeQuietly(fis); 978ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes } 979ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes } else { 980ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes ks.load(new TmpLSParameter(protParameter)); 981ad41624e761bcf1af9c8008eb45187fc13983717Elliott Hughes } 982f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes 983adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project isGetKeyStore = true; 9842f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes return ks; 985adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } catch (KeyStoreException e) { 986adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store exception 987adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw lastException = e; 988adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } catch (Exception e) { 989adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Override exception 990adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throw lastException = new KeyStoreException(e); 991adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 992adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 993adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 9940a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom /** 9950a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * This is implementation of abstract method 9960a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * getProtectionParameter(String alias) 9970a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * 9980a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * Return: ProtectionParameter to get Entry which was saved in 9990a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom * KeyStore with defined alias 10000a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom */ 10012f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes @Override 1002adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public synchronized ProtectionParameter getProtectionParameter( 1003adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project String alias) throws KeyStoreException { 1004adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (alias == null) { 1005897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("alias == null"); 1006adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1007adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!isGetKeyStore) { 1008897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new IllegalStateException("getKeyStore() was not invoked"); 1009adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1010adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return protParameter; 1011adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1012adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1013adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1014adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /* 1015adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Implementation of LoadStoreParameter interface 1016adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1017adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private static class TmpLSParameter implements LoadStoreParameter { 1018adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1019adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store used protection parameter 1020adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final ProtectionParameter protPar; 1021adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1022adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1023adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Creates TmpLoadStoreParameter object 10242f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * @param protPar protection parameter 1025adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1026adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public TmpLSParameter(ProtectionParameter protPar) { 1027adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.protPar = protPar; 1028adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1029adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1030adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1031adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * This method returns protection parameter 1032adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1033adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public ProtectionParameter getProtectionParameter() { 1034adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return protPar; 1035adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1036adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1037adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1038adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1039adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1040adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code CallbackHandlerProtection} is a {@code ProtectionParameter} that 1041adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * encapsulates a {@link CallbackHandler}. 1042adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1043adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static class CallbackHandlerProtection implements 1044adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project ProtectionParameter { 1045adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store CallbackHandler 1046adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final CallbackHandler callbackHandler; 1047adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1048adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1049adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Constructs a new instance of {@code CallbackHandlerProtection} with 1050adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code CallbackHandler}. 10512f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1052adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param handler 1053adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the {@code CallbackHandler}. 1054adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NullPointerException 1055adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code handler} is {@code null}. 1056adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1057adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public CallbackHandlerProtection(CallbackHandler handler) { 1058adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (handler == null) { 1059897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("handler == null"); 1060adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1061adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.callbackHandler = handler; 1062adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1063adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1064adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1065adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the {@code CallbackHandler}. 10662f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1067adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the {@code CallbackHandler}. 1068adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1069adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public CallbackHandler getCallbackHandler() { 1070adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return callbackHandler; 1071adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1072adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1073adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1074adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1075adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code Entry} is the common marker interface for a {@code KeyStore} 1076adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * entry. 1077adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1078adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static interface Entry { 1079adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1080adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1081adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1082adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code LoadStoreParameter} represents a parameter that specifies how a 1083adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code KeyStore} can be loaded and stored. 10842f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1085adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see KeyStore#load(LoadStoreParameter) 1086adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see KeyStore#store(LoadStoreParameter) 1087adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1088adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static interface LoadStoreParameter { 1089adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1090adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the {@code ProtectionParameter} which is used to protect data 1091adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * in the {@code KeyStore}. 10922f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1093adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the {@code ProtectionParameter} which is used to protect data 1094adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * in the {@code KeyStore}, maybe {@code null}. 1095adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1096adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public ProtectionParameter getProtectionParameter(); 1097adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1098adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1099adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1100adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code PasswordProtection} is a {@code ProtectionParameter} that protects 1101adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * a {@code KeyStore} using a password. 1102adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1103adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static class PasswordProtection implements ProtectionParameter, 1104adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project Destroyable { 1105adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1106adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store password 1107adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private char[] password; 1108adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1109adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private boolean isDestroyed = false; 1110adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1111adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1112adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Constructs a new instance of {@code PasswordProtection} with a 1113adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * password. A copy of the password is stored in the new {@code 1114adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * PasswordProtection} object. 11152f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1116adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param password 1117adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the password, maybe {@code null}. 1118adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1119adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public PasswordProtection(char[] password) { 1120d21d78fd49a2d798218e8c8aefbddb26a0e71bbbElliott Hughes if (password != null) { 1121d21d78fd49a2d798218e8c8aefbddb26a0e71bbbElliott Hughes this.password = password.clone(); 1122d21d78fd49a2d798218e8c8aefbddb26a0e71bbbElliott Hughes } 1123adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1124adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1125adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1126adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the password. 11272f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1128adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the password. 1129adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalStateException 1130adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the password has been destroyed. 1131adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1132adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public synchronized char[] getPassword() { 1133adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (isDestroyed) { 1134897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new IllegalStateException("Password was destroyed"); 1135adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1136adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return password; 1137adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1138adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1139adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1140adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Destroys / invalidates the password. 11412f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1142adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws DestroyFailedException 1143adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the password could not be invalidated. 1144adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1145adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public synchronized void destroy() throws DestroyFailedException { 1146adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project isDestroyed = true; 1147adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (password != null) { 1148adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project Arrays.fill(password, '\u0000'); 1149adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project password = null; 1150adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1151adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1152adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1153adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1154adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Indicates whether the password is invalidated. 11552f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1156adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return {@code true} if the password is invalidated, {@code false} 1157adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * otherwise. 1158adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1159adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public synchronized boolean isDestroyed() { 1160adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return isDestroyed; 1161adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1162adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1163adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1164adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1165adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code ProtectionParameter} is a marker interface for protection 1166adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * parameters. A protection parameter is used to protect the content of a 1167adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code KeyStore}. 1168adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1169adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static interface ProtectionParameter { 1170adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1171adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1172adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1173adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code PrivateKeyEntry} represents a {@code KeyStore} entry that 1174adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * holds a private key. 1175adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1176adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static final class PrivateKeyEntry implements Entry { 1177adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store Certificate chain 1178adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private Certificate[] chain; 1179adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1180adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store PrivateKey 1181adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private PrivateKey privateKey; 1182adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1183adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1184adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Constructs a new instance of {@code PrivateKeyEntry} with the given 1185adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code PrivateKey} and the provided certificate chain. 11862f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1187adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param privateKey 1188adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the private key. 1189adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param chain 1190adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the ordered certificate chain with the certificate 1191adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * corresponding to the private key at index 0. 1192adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NullPointerException 1193adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code privateKey} or {@code chain} is {@code null}. 1194adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IllegalArgumentException 1195adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code chain.length == 0}, the algorithm of the 1196adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * private key does not match the algorithm of the public 1197adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * key of the first certificate or the certificates are not 1198adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * all of the same type. 1199adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1200adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public PrivateKeyEntry(PrivateKey privateKey, Certificate[] chain) { 1201adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (privateKey == null) { 1202897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("privateKey == null"); 1203adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1204adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (chain == null) { 1205897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("chain == null"); 1206adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1207adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1208adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (chain.length == 0) { 1209897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new IllegalArgumentException("chain.length == 0"); 1210adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1211adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Match algorithm of private key and algorithm of public key from 1212adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // the end certificate 1213adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project String s = chain[0].getType(); 1214897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes if (!(chain[0].getPublicKey().getAlgorithm()).equals(privateKey.getAlgorithm())) { 12150a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom throw new IllegalArgumentException("Algorithm of private key does not match " 12160a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom + "algorithm of public key in end certificate of entry " 12170a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom + "(with index number: 0)"); 1218adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1219adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Match certificate types 1220adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project for (int i = 1; i < chain.length; i++) { 1221adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (!s.equals(chain[i].getType())) { 12220a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom throw new IllegalArgumentException("Certificates from the given chain have " 12230a480846a9798c763b088a122ab0dcd3dc3a17b6Brian Carlstrom + "different types"); 1224adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1225adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1226adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // clone chain - this.chain = (Certificate[])chain.clone(); 12272f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes boolean isAllX509Certificates = true; 12282f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes // assert chain length > 0 12290d4daefcf389b6433a0af481ef44a84a2546541aElliott Hughes for (Certificate cert: chain) { 12300d4daefcf389b6433a0af481ef44a84a2546541aElliott Hughes if (!(cert instanceof X509Certificate)) { 12312f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes isAllX509Certificates = false; 12322f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes break; 12332f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes } 12342f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes } 1235f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes 12362f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes if(isAllX509Certificates){ 12372f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes this.chain = new X509Certificate[chain.length]; 1238e3a187163504f00c98bd75cbd8bcbdde123ae2cdBrian Carlstrom } else { 12392f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes this.chain = new Certificate[chain.length]; 12402f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes } 1241adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project System.arraycopy(chain, 0, this.chain, 0, chain.length); 1242adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.privateKey = privateKey; 1243adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1244adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1245adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1246adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the private key. 12472f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1248adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the private key. 1249adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1250adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public PrivateKey getPrivateKey() { 1251adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return privateKey; 1252adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1253adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1254adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1255adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the certificate chain. 12562f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1257adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the certificate chain. 1258adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1259adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public Certificate[] getCertificateChain() { 1260adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return chain.clone(); 1261adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1262adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1263adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1264adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the certificate corresponding to the private key. 12652f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1266adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the certificate corresponding to the private key. 1267adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1268adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public Certificate getCertificate() { 1269adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return chain[0]; 1270adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1271adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1272adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1273adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a string containing a concise, human-readable description of 1274adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this {@code PrivateKeyEntry}. 12752f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1276adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a printable representation for this {@code PrivateKeyEntry}. 1277adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 12782f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes @Override 1279adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String toString() { 12802f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes StringBuilder sb = new StringBuilder( 1281f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes "PrivateKeyEntry: number of elements in certificate chain is "); 1282adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project sb.append(Integer.toString(chain.length)); 1283f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes sb.append("\n"); 1284adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project for (int i = 0; i < chain.length; i++) { 1285adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project sb.append(chain[i].toString()); 1286f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes sb.append("\n"); 1287adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1288adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return sb.toString(); 1289adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1290adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1291adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1292adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1293adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code SecretKeyEntry} represents a {@code KeyStore} entry that 1294adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * holds a secret key. 1295adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1296adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static final class SecretKeyEntry implements Entry { 1297adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1298adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store SecretKey 1299adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final SecretKey secretKey; 1300adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1301adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1302adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Constructs a new instance of {@code SecretKeyEntry} with the given 1303adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code SecretKey}. 13042f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1305adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param secretKey 1306adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the secret key. 1307adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NullPointerException 1308adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code secretKey} is {@code null}. 1309adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1310adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public SecretKeyEntry(SecretKey secretKey) { 1311adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (secretKey == null) { 1312897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("secretKey == null"); 1313adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1314adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.secretKey = secretKey; 1315adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1316adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1317adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1318adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the secret key. 13192f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1320adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the secret key. 1321adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1322adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public SecretKey getSecretKey() { 1323adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return secretKey; 1324adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1325adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1326adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1327adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a string containing a concise, human-readable description of 1328adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this {@code SecretKeyEntry}. 13292f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1330adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a printable representation for this {@code 1331adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * SecretKeyEntry}. 1332adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 13332f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes @Override 1334adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String toString() { 1335f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes StringBuilder sb = new StringBuilder("SecretKeyEntry: algorithm - "); 1336adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project sb.append(secretKey.getAlgorithm()); 1337adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return sb.toString(); 1338adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1339adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1340adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1341adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1342adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code TrustedCertificateEntry} represents a {@code KeyStore} entry that 1343adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * holds a trusted certificate. 1344adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1345adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public static final class TrustedCertificateEntry implements Entry { 1346adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1347adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project // Store trusted Certificate 1348adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project private final Certificate trustCertificate; 1349adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1350adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1351adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Constructs a new instance of {@code TrustedCertificateEntry} with the 1352adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * given {@code Certificate}. 13532f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1354adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param trustCertificate 1355adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the trusted certificate. 1356adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NullPointerException 1357adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if {@code trustCertificate} is {@code null}. 1358adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1359adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public TrustedCertificateEntry(Certificate trustCertificate) { 1360adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project if (trustCertificate == null) { 1361897538a36c18f4db8f9f68ee566aec0bda842e9fElliott Hughes throw new NullPointerException("trustCertificate == null"); 1362adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1363adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project this.trustCertificate = trustCertificate; 1364adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1365adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1366adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1367adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the trusted certificate. 13682f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1369adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the trusted certificate. 1370adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 1371adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public Certificate getTrustedCertificate() { 1372adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project return trustCertificate; 1373adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1374adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1375adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 1376adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a string containing a concise, human-readable description of 1377adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this {@code TrustedCertificateEntry}. 13782f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 1379adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a printable representation for this {@code 1380adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * TrustedCertificateEntry}. 1381adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 13822f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes @Override 1383adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String toString() { 1384f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes return "Trusted certificate entry:\n" + trustCertificate; 1385adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1386adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project } 1387adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project} 1388