0N/A/*
2362N/A * Copyright (c) 2001, 2006, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/Apackage java.security.spec;
0N/A
0N/Aimport java.math.BigInteger;
0N/Aimport java.security.spec.MGF1ParameterSpec;
0N/A
0N/A/**
0N/A * This class specifies a parameter spec for RSA-PSS signature scheme,
0N/A * as defined in the
0N/A * <a href="http://www.ietf.org/rfc/rfc3447.txt">PKCS#1 v2.1</a>
0N/A * standard.
0N/A *
0N/A * <p>Its ASN.1 definition in PKCS#1 standard is described below:
0N/A * <pre>
0N/A * RSASSA-PSS-params ::= SEQUENCE {
0N/A * hashAlgorithm [0] OAEP-PSSDigestAlgorithms DEFAULT sha1,
0N/A * maskGenAlgorithm [1] PKCS1MGFAlgorithms DEFAULT mgf1SHA1,
0N/A * saltLength [2] INTEGER DEFAULT 20,
0N/A * trailerField [3] INTEGER DEFAULT 1
0N/A * }
0N/A * </pre>
0N/A * where
0N/A * <pre>
0N/A * OAEP-PSSDigestAlgorithms ALGORITHM-IDENTIFIER ::= {
0N/A * { OID id-sha1 PARAMETERS NULL }|
0N/A * { OID id-sha256 PARAMETERS NULL }|
0N/A * { OID id-sha384 PARAMETERS NULL }|
0N/A * { OID id-sha512 PARAMETERS NULL },
0N/A * ... -- Allows for future expansion --
0N/A * }
0N/A *
0N/A * PKCS1MGFAlgorithms ALGORITHM-IDENTIFIER ::= {
0N/A * { OID id-mgf1 PARAMETERS OAEP-PSSDigestAlgorithms },
0N/A * ... -- Allows for future expansion --
0N/A * }
0N/A * </pre>
0N/A * <p>Note: the PSSParameterSpec.DEFAULT uses the following:
0N/A * message digest -- "SHA-1"
0N/A * mask generation function (mgf) -- "MGF1"
0N/A * parameters for mgf -- MGF1ParameterSpec.SHA1
0N/A * SaltLength -- 20
0N/A * TrailerField -- 1
0N/A *
0N/A * @see MGF1ParameterSpec
0N/A * @see AlgorithmParameterSpec
0N/A * @see java.security.Signature
0N/A *
0N/A * @author Valerie Peng
0N/A *
0N/A *
0N/A * @since 1.4
0N/A */
0N/A
0N/Apublic class PSSParameterSpec implements AlgorithmParameterSpec {
0N/A
0N/A private String mdName = "SHA-1";
0N/A private String mgfName = "MGF1";
0N/A private AlgorithmParameterSpec mgfSpec = MGF1ParameterSpec.SHA1;
0N/A private int saltLen = 20;
0N/A private int trailerField = 1;
0N/A
0N/A /**
0N/A * The PSS parameter set with all default values.
0N/A * @since 1.5
0N/A */
0N/A public static final PSSParameterSpec DEFAULT = new PSSParameterSpec();
0N/A
0N/A /**
0N/A * Constructs a new <code>PSSParameterSpec</code> as defined in
0N/A * the PKCS #1 standard using the default values.
0N/A */
0N/A private PSSParameterSpec() {
0N/A }
0N/A
0N/A /**
0N/A * Creates a new <code>PSSParameterSpec</code> as defined in
0N/A * the PKCS #1 standard using the specified message digest,
0N/A * mask generation function, parameters for mask generation
0N/A * function, salt length, and trailer field values.
0N/A *
0N/A * @param mdName the algorithm name of the hash function.
0N/A * @param mgfName the algorithm name of the mask generation
0N/A * function.
0N/A * @param mgfSpec the parameters for the mask generation
0N/A * function. If null is specified, null will be returned by
0N/A * getMGFParameters().
0N/A * @param saltLen the length of salt.
0N/A * @param trailerField the value of the trailer field.
0N/A * @exception NullPointerException if <code>mdName</code>,
0N/A * or <code>mgfName</code> is null.
0N/A * @exception IllegalArgumentException if <code>saltLen</code>
0N/A * or <code>trailerField</code> is less than 0.
0N/A * @since 1.5
0N/A */
0N/A public PSSParameterSpec(String mdName, String mgfName,
0N/A AlgorithmParameterSpec mgfSpec,
0N/A int saltLen, int trailerField) {
0N/A if (mdName == null) {
0N/A throw new NullPointerException("digest algorithm is null");
0N/A }
0N/A if (mgfName == null) {
0N/A throw new NullPointerException("mask generation function " +
0N/A "algorithm is null");
0N/A }
0N/A if (saltLen < 0) {
0N/A throw new IllegalArgumentException("negative saltLen value: " +
0N/A saltLen);
0N/A }
0N/A if (trailerField < 0) {
0N/A throw new IllegalArgumentException("negative trailerField: " +
0N/A trailerField);
0N/A }
0N/A this.mdName = mdName;
0N/A this.mgfName = mgfName;
0N/A this.mgfSpec = mgfSpec;
0N/A this.saltLen = saltLen;
0N/A this.trailerField = trailerField;
0N/A }
0N/A
0N/A /**
0N/A * Creates a new <code>PSSParameterSpec</code>
0N/A * using the specified salt length and other default values as
0N/A * defined in PKCS#1.
0N/A *
0N/A * @param saltLen the length of salt in bits to be used in PKCS#1
0N/A * PSS encoding.
0N/A * @exception IllegalArgumentException if <code>saltLen</code> is
0N/A * less than 0.
0N/A */
0N/A public PSSParameterSpec(int saltLen) {
0N/A if (saltLen < 0) {
0N/A throw new IllegalArgumentException("negative saltLen value: " +
0N/A saltLen);
0N/A }
0N/A this.saltLen = saltLen;
0N/A }
0N/A
0N/A /**
0N/A * Returns the message digest algorithm name.
0N/A *
0N/A * @return the message digest algorithm name.
0N/A * @since 1.5
0N/A */
0N/A public String getDigestAlgorithm() {
0N/A return mdName;
0N/A }
0N/A
0N/A /**
0N/A * Returns the mask generation function algorithm name.
0N/A *
0N/A * @return the mask generation function algorithm name.
0N/A *
0N/A * @since 1.5
0N/A */
0N/A public String getMGFAlgorithm() {
0N/A return mgfName;
0N/A }
0N/A
0N/A /**
0N/A * Returns the parameters for the mask generation function.
0N/A *
0N/A * @return the parameters for the mask generation function.
0N/A * @since 1.5
0N/A */
0N/A public AlgorithmParameterSpec getMGFParameters() {
0N/A return mgfSpec;
0N/A }
0N/A
0N/A /**
0N/A * Returns the salt length in bits.
0N/A *
0N/A * @return the salt length.
0N/A */
0N/A public int getSaltLength() {
0N/A return saltLen;
0N/A }
0N/A
0N/A /**
0N/A * Returns the value for the trailer field, i.e. bc in PKCS#1 v2.1.
0N/A *
0N/A * @return the value for the trailer field, i.e. bc in PKCS#1 v2.1.
0N/A * @since 1.5
0N/A */
0N/A public int getTrailerField() {
0N/A return trailerField;
0N/A }
0N/A}