151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 219b88cdf6c245d9a7d1e4996d494be4e14f546a6Sergio Giro * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. 351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.security; 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.spec.AlgorithmParameterSpec; 2951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This class defines the <i>Service Provider Interface</i> (<b>SPI</b>) 3219b88cdf6c245d9a7d1e4996d494be4e14f546a6Sergio Giro * for the {@code KeyPairGenerator} class, which is used to generate 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * pairs of public and private keys. 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> All the abstract methods in this class must be implemented by each 3651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cryptographic service provider who wishes to supply the implementation 3751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of a key pair generator for a particular algorithm. 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> In case the client does not explicitly initialize the KeyPairGenerator 4019b88cdf6c245d9a7d1e4996d494be4e14f546a6Sergio Giro * (via a call to an {@code initialize} method), each provider must 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * supply (and document) a default initialization. 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * For example, the <i>Sun</i> provider uses a default modulus size (keysize) 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of 1024 bits. 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author Benjamin Renaud 4651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see KeyPairGenerator 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see java.security.spec.AlgorithmParameterSpec 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic abstract class KeyPairGeneratorSpi { 5351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 5551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Initializes the key pair generator for a certain keysize, using 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the default parameter set. 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param keysize the keysize. This is an 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * algorithm-specific metric, such as modulus length, specified in 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * number of bits. 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param random the source of randomness for this generator. 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6419b88cdf6c245d9a7d1e4996d494be4e14f546a6Sergio Giro * @exception InvalidParameterException if the {@code keysize} is not 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * supported by this KeyPairGeneratorSpi object. 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract void initialize(int keysize, SecureRandom random); 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Initializes the key pair generator using the specified parameter 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * set and user-provided source of randomness. 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This concrete method has been added to this previously-defined 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * abstract class. (For backwards compatibility, it cannot be abstract.) 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * It may be overridden by a provider to initialize the key pair 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * generator. Such an override 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is expected to throw an InvalidAlgorithmParameterException if 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a parameter is inappropriate for this key pair generator. 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If this method is not overridden, it always throws an 8051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * UnsupportedOperationException. 8151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param params the parameter set used to generate the keys. 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param random the source of randomness for this generator. 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception InvalidAlgorithmParameterException if the given parameters 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * are inappropriate for this key pair generator. 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.2 9051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 9151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void initialize(AlgorithmParameterSpec params, 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski SecureRandom random) 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throws InvalidAlgorithmParameterException { 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new UnsupportedOperationException(); 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Generates a key pair. Unless an initialization method is called 9951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * using a KeyPairGenerator interface, algorithm-specific defaults 10051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * will be used. This will generate a new key pair every time it 10151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is called. 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10319b88cdf6c245d9a7d1e4996d494be4e14f546a6Sergio Giro * @return the newly generated {@code KeyPair} 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract KeyPair generateKeyPair(); 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 107