android-platform-libcore/luni/src/main/java/java/security/spec/RSAKeyGenParameterSpec.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package java.security.spec;

import java.math.BigInteger;

/**
 * The parameter specification for generating an RSA key pair.
 */
public class RSAKeyGenParameterSpec implements AlgorithmParameterSpec {

    /**
     * The value of the public exponent {@code F0} = 3.
     */
    public static final BigInteger F0 = BigInteger.valueOf(3L);

    /**
     * The value of the public exponent {@code F4} = 65537.
     */
    public static final BigInteger F4 = BigInteger.valueOf(65537L);

    // Key size
    private final int keysize;
    // Public Exponent
    private final BigInteger publicExponent;

    /**
     * Creates a new {@code RSAKeyGenParameterSpec} with the specified key size
     * and public exponent.
     *
     * @param keysize
     *            the size of the modulus (number of bits).
     * @param publicExponent
     *            the value of the public exponent.
     */
    public RSAKeyGenParameterSpec(int keysize, BigInteger publicExponent) {
        this.keysize = keysize;
        this.publicExponent = publicExponent;
    }

    /**
     * Returns the size of the modulus (number of bits).
     *
     * @return the size of the modulus (number of bits).
     */
    public int getKeysize() {
        return keysize;
    }

    /**
     * Returns the value of the public exponent.
     *
     * @return the value of the public exponent.
     */
    public BigInteger getPublicExponent() {
        return publicExponent;
    }
}