The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | * contributor license agreements. See the NOTICE file distributed with |
| 4 | * this work for additional information regarding copyright ownership. |
| 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | * (the "License"); you may not use this file except in compliance with |
| 7 | * the License. You may obtain a copy of the License at |
| 8 | * |
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | * |
| 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | * See the License for the specific language governing permissions and |
| 15 | * limitations under the License. |
| 16 | */ |
| 17 | |
| 18 | package javax.crypto; |
| 19 | |
| 20 | import java.security.InvalidKeyException; |
| 21 | import java.security.NoSuchAlgorithmException; |
| 22 | import java.security.NoSuchProviderException; |
| 23 | import java.security.Provider; |
| 24 | import java.security.Security; |
| 25 | import java.security.spec.InvalidKeySpecException; |
| 26 | import java.security.spec.KeySpec; |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 27 | import org.apache.harmony.security.fortress.Engine; |
| 28 | |
| 29 | |
| 30 | /** |
| 31 | * The public API for {@code SecretKeyFactory} implementations. |
| 32 | * <p> |
| 33 | * Secret key factories provide the following functionality: |
| 34 | * <ul> |
| 35 | * <li>convert {@link SecretKey} objects to and from {@link KeySpec} objects</li> |
| 36 | * <li>translate {@link SecretKey} objects from one provider implementation to |
| 37 | * another</li> |
| 38 | * </ul> |
| 39 | * Which key specifications are supported by the {@link #generateSecret} and |
| 40 | * {@link #getKeySpec} is provider dependent. |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 41 | */ |
| 42 | public class SecretKeyFactory { |
| 43 | |
| 44 | // Used to access common engine functionality |
Brian Carlstrom | 0a48084 | 2010-10-18 23:00:51 -0700 | [diff] [blame] | 45 | private static final Engine ENGINE = new Engine("SecretKeyFactory"); |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 46 | |
| 47 | // Store used provider |
| 48 | private final Provider provider; |
| 49 | |
| 50 | // Store used spi implementation |
| 51 | private final SecretKeyFactorySpi spiImpl; |
| 52 | |
| 53 | // Store used algorithm name |
| 54 | private final String algorithm; |
| 55 | |
| 56 | /** |
| 57 | * Creates a new {@code SecretKeyFactory} |
Jesse Wilson | ce9ec01 | 2009-08-31 15:37:14 -0700 | [diff] [blame] | 58 | * |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 59 | * @param keyFacSpi |
| 60 | * the SPI delegate. |
| 61 | * @param provider |
| 62 | * the provider providing this key factory. |
| 63 | * @param algorithm |
| 64 | * the algorithm name for the secret key. |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 65 | */ |
| 66 | protected SecretKeyFactory(SecretKeyFactorySpi keyFacSpi, |
| 67 | Provider provider, String algorithm) { |
| 68 | this.provider = provider; |
| 69 | this.algorithm = algorithm; |
| 70 | this.spiImpl = keyFacSpi; |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Returns the name of the secret key algorithm. |
Jesse Wilson | ce9ec01 | 2009-08-31 15:37:14 -0700 | [diff] [blame] | 75 | * |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 76 | * @return the name of the secret key algorithm. |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 77 | */ |
| 78 | public final String getAlgorithm() { |
| 79 | return algorithm; |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Returns the provider for this {@code SecretKeyFactory} instance. |
Jesse Wilson | ce9ec01 | 2009-08-31 15:37:14 -0700 | [diff] [blame] | 84 | * |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 85 | * @return the provider for this {@code SecretKeyFactory} instance. |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 86 | */ |
| 87 | public final Provider getProvider() { |
| 88 | return provider; |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * Creates a new {@code SecretKeyFactory} instance for the specified key |
| 93 | * algorithm. |
Jesse Wilson | ce9ec01 | 2009-08-31 15:37:14 -0700 | [diff] [blame] | 94 | * |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 95 | * @param algorithm |
| 96 | * the name of the key algorithm. |
| 97 | * @return a secret key factory for the specified key algorithm. |
| 98 | * @throws NoSuchAlgorithmException |
| 99 | * if no installed provider can provide the requested algorithm. |
| 100 | * @throws NullPointerException |
| 101 | * if the specified algorithm is {@code null}. |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 102 | */ |
| 103 | public static final SecretKeyFactory getInstance(String algorithm) |
| 104 | throws NoSuchAlgorithmException { |
| 105 | if (algorithm == null) { |
Kenny Root | 86acc04 | 2012-09-12 10:32:58 -0700 | [diff] [blame] | 106 | throw new NullPointerException("algorithm == null"); |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 107 | } |
Brian Carlstrom | 6cdb6b7 | 2010-10-19 11:27:15 -0700 | [diff] [blame] | 108 | Engine.SpiAndProvider sap = ENGINE.getInstance(algorithm, null); |
| 109 | return new SecretKeyFactory((SecretKeyFactorySpi) sap.spi, sap.provider, algorithm); |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | /** |
| 113 | * Creates a new {@code SecretKeyFactory} instance for the specified key |
| 114 | * algorithm from the specified {@code provider}. |
Jesse Wilson | ce9ec01 | 2009-08-31 15:37:14 -0700 | [diff] [blame] | 115 | * |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 116 | * @param algorithm |
| 117 | * the name of the key algorithm. |
| 118 | * @param provider |
| 119 | * the name of the provider that provides the requested |
| 120 | * algorithm. |
| 121 | * @return a secret key factory for the specified key algorithm from the |
| 122 | * specified provider. |
| 123 | * @throws NoSuchAlgorithmException |
| 124 | * if the specified provider cannot provide the requested |
| 125 | * algorithm. |
| 126 | * @throws NoSuchProviderException |
| 127 | * if the specified provider does not exist. |
| 128 | * @throws IllegalArgumentException |
| 129 | * if the specified provider name is {@code null} or empty. |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 130 | */ |
| 131 | public static final SecretKeyFactory getInstance(String algorithm, |
| 132 | String provider) throws NoSuchAlgorithmException, |
| 133 | NoSuchProviderException { |
Elliott Hughes | 80a7fba | 2010-05-21 16:58:35 -0700 | [diff] [blame] | 134 | if (provider == null || provider.isEmpty()) { |
| 135 | throw new IllegalArgumentException("Provider is null or empty"); |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 136 | } |
| 137 | Provider impProvider = Security.getProvider(provider); |
| 138 | if (impProvider == null) { |
| 139 | throw new NoSuchProviderException(provider); |
| 140 | } |
| 141 | return getInstance(algorithm, impProvider); |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Creates a new {@code SecretKeyFactory} instance for the specified key |
| 146 | * algorithm from the specified provider. |
Jesse Wilson | ce9ec01 | 2009-08-31 15:37:14 -0700 | [diff] [blame] | 147 | * |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 148 | * @param algorithm |
| 149 | * the name of the key algorithm. |
| 150 | * @param provider |
| 151 | * the provider that provides the requested algorithm. |
| 152 | * @return a secret key factory for the specified key algorithm from the |
| 153 | * specified provider. |
| 154 | * @throws NoSuchAlgorithmException |
| 155 | * if the specified provider cannot provider the requested |
| 156 | * algorithm. |
| 157 | * @throws IllegalArgumentException |
| 158 | * if the specified provider is {@code null}. |
| 159 | * @throws NullPointerException |
| 160 | * is the specified algorithm name is {@code null}. |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 161 | */ |
| 162 | public static final SecretKeyFactory getInstance(String algorithm, |
| 163 | Provider provider) throws NoSuchAlgorithmException { |
| 164 | if (provider == null) { |
Elliott Hughes | 80a7fba | 2010-05-21 16:58:35 -0700 | [diff] [blame] | 165 | throw new IllegalArgumentException("provider == null"); |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 166 | } |
| 167 | if (algorithm == null) { |
Kenny Root | 86acc04 | 2012-09-12 10:32:58 -0700 | [diff] [blame] | 168 | throw new NullPointerException("algorithm == null"); |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 169 | } |
Brian Carlstrom | 6cdb6b7 | 2010-10-19 11:27:15 -0700 | [diff] [blame] | 170 | Object spi = ENGINE.getInstance(algorithm, provider, null); |
| 171 | return new SecretKeyFactory((SecretKeyFactorySpi) spi, provider, algorithm); |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Generate a secret key from the specified key specification. |
Jesse Wilson | ce9ec01 | 2009-08-31 15:37:14 -0700 | [diff] [blame] | 176 | * |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 177 | * @param keySpec |
| 178 | * the key specification. |
| 179 | * @return a secret key. |
| 180 | * @throws InvalidKeySpecException |
| 181 | * if the specified key specification cannot be used to generate |
| 182 | * a secret key. |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 183 | */ |
| 184 | public final SecretKey generateSecret(KeySpec keySpec) |
| 185 | throws InvalidKeySpecException { |
| 186 | return spiImpl.engineGenerateSecret(keySpec); |
| 187 | } |
| 188 | |
| 189 | /** |
| 190 | * Returns the key specification of the specified secret key. |
Jesse Wilson | ce9ec01 | 2009-08-31 15:37:14 -0700 | [diff] [blame] | 191 | * |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 192 | * @param key |
| 193 | * the secret key to get the specification from. |
| 194 | * @param keySpec |
| 195 | * the target key specification class. |
| 196 | * @return an instance of the specified key specification class. |
| 197 | * @throws InvalidKeySpecException |
| 198 | * if the specified secret key cannot be transformed into the |
| 199 | * requested key specification. |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 200 | */ |
| 201 | @SuppressWarnings("unchecked") |
| 202 | public final KeySpec getKeySpec(SecretKey key, Class keySpec) |
| 203 | throws InvalidKeySpecException { |
| 204 | return spiImpl.engineGetKeySpec(key, keySpec); |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * Translates the specified secret key into an instance of the corresponding |
| 209 | * key from the provider of this key factory. |
Jesse Wilson | ce9ec01 | 2009-08-31 15:37:14 -0700 | [diff] [blame] | 210 | * |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 211 | * @param key |
| 212 | * the secret key to translate. |
| 213 | * @return the corresponding translated key. |
| 214 | * @throws InvalidKeyException |
| 215 | * if the specified key cannot be translated using this key |
| 216 | * factory. |
The Android Open Source Project | adc854b | 2009-03-03 19:28:47 -0800 | [diff] [blame] | 217 | */ |
| 218 | public final SecretKey translateKey(SecretKey key) |
| 219 | throws InvalidKeyException { |
| 220 | return spiImpl.engineTranslateKey(key); |
| 221 | |
| 222 | } |
Elliott Hughes | 80a7fba | 2010-05-21 16:58:35 -0700 | [diff] [blame] | 223 | } |