/*

 * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package javax.xml.crypto.dsig.spec;

import javax.xml.crypto.dsig.SignatureMethod;

import java.security.spec.AlgorithmParameterSpec;

import java.security.spec.MGF1ParameterSpec;

import java.security.spec.PSSParameterSpec;

import java.util.Objects;

/**

 * Parameters for the <a href="http://www.w3.org/2007/05/xmldsig-more#rsa-pss">

 * XML Signature RSASSA-PSS Algorithm</a>. The parameters are represented as a

 * {@link PSSParameterSpec} object.

 * <p>

 * The XML Schema Definition is defined as:

 * <pre><code>

 *    <xs:element name="RSAPSSParams" type="pss:RSAPSSParamsType">

 *        <xs:annotation>

 *            <xs:documentation>

 *    Top level element that can be used in xs:any namespace="#other"

 *    wildcard of ds:SignatureMethod content.

 *            </xs:documentation>

 *        </xs:annotation>

 *    </xs:element>

 *    <xs:complexType name="RSAPSSParamsType">

 *        <xs:sequence>

 *            <xs:element ref="ds:DigestMethod" minOccurs="0"/>

 *            <xs:element name="MaskGenerationFunction"

 *               type="pss:MaskGenerationFunctionType" minOccurs="0"/>

 *            <xs:element name="SaltLength" type="xs:int"

 *               minOccurs="0"/>

 *            <xs:element name="TrailerField" type="xs:int"

 *               minOccurs="0"/>

 *        </xs:sequence>

 *    </xs:complexType>

 *    <xs:complexType name="MaskGenerationFunctionType">

 *        <xs:sequence>

 *            <xs:element ref="ds:DigestMethod" minOccurs="0"/>

 *        </xs:sequence>

 *        <xs:attribute name="Algorithm" type="xs:anyURI"

 *           default="http://www.w3.org/2007/05/xmldsig-more#MGF1"/>

 *    </xs:complexType>

 * </code></pre>

 *

 * @since 17

 * @see SignatureMethod#RSA_PSS

 * @see <a href="https://www.ietf.org/rfc/rfc6931.txt">RFC 6931</a>

 */

public final class RSAPSSParameterSpec implements SignatureMethodParameterSpec {

    private final PSSParameterSpec spec;

    /**

     * Creates a new {@code RSAPSSParameterSpec} object with the specified

     * {@link PSSParameterSpec} object.

     *

     * @param spec the input {@code PSSParameterSpec} object

     *

     * @throws NullPointerException if {@code spec} is null

     */

    public RSAPSSParameterSpec(PSSParameterSpec spec) {

        this.spec = Objects.requireNonNull(spec);

    }

    /**

     * Returns the {@code PSSParameterSpec} object inside.

     *

     * @return the {@code PSSParameterSpec} object inside

     */

    public PSSParameterSpec getPSSParameterSpec() {

        return spec;

    }

}