/*

 * 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 sun.security.provider.certpath;

import java.security.AlgorithmConstraints;

import java.security.CryptoPrimitive;

import java.util.Collection;

import java.util.Collections;

import java.util.Set;

import java.util.EnumSet;

import java.math.BigInteger;

import java.security.PublicKey;

import java.security.KeyFactory;

import java.security.AlgorithmParameters;

import java.security.GeneralSecurityException;

import java.security.cert.Certificate;

import java.security.cert.X509CRL;

import java.security.cert.X509Certificate;

import java.security.cert.PKIXCertPathChecker;

import java.security.cert.TrustAnchor;

import java.security.cert.CRLException;

import java.security.cert.CertificateException;

import java.security.cert.CertPathValidatorException;

import java.security.cert.CertPathValidatorException.BasicReason;

import java.security.cert.PKIXReason;

import sun.security.util.DisabledAlgorithmConstraints;

import sun.security.x509.X509CertImpl;

import sun.security.x509.X509CRLImpl;

import sun.security.x509.AlgorithmId;

/**

 * A <code>PKIXCertPathChecker</code> implementation to check whether a

 * specified certificate contains the required algorithm constraints.

 * <p>

 * Certificate fields such as the subject public key, the signature

 * algorithm, key usage, extended key usage, etc. need to conform to

 * the specified algorithm constraints.

 *

 * @see PKIXCertPathChecker

 * @see PKIXParameters

 */

public final class AlgorithmChecker extends PKIXCertPathChecker {

    private final AlgorithmConstraints constraints;

    private final PublicKey trustedPubKey;

    private PublicKey prevPubKey;

    private static final Set<CryptoPrimitive> SIGNATURE_PRIMITIVE_SET =

        Collections.unmodifiableSet(EnumSet.of(CryptoPrimitive.SIGNATURE));

    private static final Set<CryptoPrimitive> KU_PRIMITIVE_SET =

        Collections.unmodifiableSet(EnumSet.of(

            CryptoPrimitive.SIGNATURE,

            CryptoPrimitive.KEY_ENCAPSULATION,

            CryptoPrimitive.PUBLIC_KEY_ENCRYPTION,

            CryptoPrimitive.KEY_AGREEMENT));

    private static final DisabledAlgorithmConstraints

        certPathDefaultConstraints = new DisabledAlgorithmConstraints(

            DisabledAlgorithmConstraints.PROPERTY_CERTPATH_DISABLED_ALGS);

    /**

     * Create a new <code>AlgorithmChecker</code> with the algorithm

     * constraints specified in security property

     * "jdk.certpath.disabledAlgorithms".

     *

     * @param anchor the trust anchor selected to validate the target

     *     certificate

     */

    public AlgorithmChecker(TrustAnchor anchor) {

        this(anchor, certPathDefaultConstraints);

    }

    /**

     * Create a new <code>AlgorithmChecker</code> with the

     * given {@code AlgorithmConstraints}.

     * <p>

     * Note that this constructor will be used to check a certification

     * path where the trust anchor is unknown, or a certificate list which may

     * contain the trust anchor. This constructor is used by SunJSSE.

     *

     * @param constraints the algorithm constraints (or null)

     */

    public AlgorithmChecker(AlgorithmConstraints constraints) {

        this.prevPubKey = null;

        this.trustedPubKey = null;

        this.constraints = constraints;

    }

    /**

     * Create a new <code>AlgorithmChecker</code> with the

     * given <code>TrustAnchor</code> and <code>AlgorithmConstraints</code>.

     *

     * @param anchor the trust anchor selected to validate the target

     *     certificate

     * @param constraints the algorithm constraints (or null)

     *

     * @throws IllegalArgumentException if the <code>anchor</code> is null

     */

    public AlgorithmChecker(TrustAnchor anchor,

            AlgorithmConstraints constraints) {

        if (anchor == null) {

            throw new IllegalArgumentException(

                        "The trust anchor cannot be null");

        }

        if (anchor.getTrustedCert() != null) {

            this.trustedPubKey = anchor.getTrustedCert().getPublicKey();

        } else {

            this.trustedPubKey = anchor.getCAPublicKey();

        }

        this.prevPubKey = trustedPubKey;

        this.constraints = constraints;

    }

    @Override

    public void init(boolean forward) throws CertPathValidatorException {

        //  Note that this class does not support forward mode.

        if (!forward) {

            if (trustedPubKey != null) {

                prevPubKey = trustedPubKey;

            } else {

                prevPubKey = null;

            }

        } else {

            throw new

                CertPathValidatorException("forward checking not supported");

        }

    }

    @Override

    public boolean isForwardCheckingSupported() {

        //  Note that as this class does not support forward mode, the method

        //  will always returns false.

        return false;

    }

    @Override

    public Set<String> getSupportedExtensions() {

        return null;

    }

    @Override

    public void check(Certificate cert,

            Collection<String> unresolvedCritExts)

            throws CertPathValidatorException {

        if (!(cert instanceof X509Certificate) || constraints == null) {

            // ignore the check for non-x.509 certificate or null constraints

            return;

        }

        // check the key usage and key size

        if (keyUsage != null && keyUsage.length < 9) {

            throw new CertPathValidatorException(

                "incorrect KeyUsage extension",

                null, null, -1, PKIXReason.INVALID_KEY_USAGE);

        }

        // Assume all key usage bits are set if key usage is not present

        Set<CryptoPrimitive> primitives = KU_PRIMITIVE_SET;

        if (keyUsage != null) {

                primitives = EnumSet.noneOf(CryptoPrimitive.class);

            if (keyUsage[0] || keyUsage[1] || keyUsage[5] || keyUsage[6]) {

                // keyUsage[0]: KeyUsage.digitalSignature

                // keyUsage[1]: KeyUsage.nonRepudiation

                // keyUsage[5]: KeyUsage.keyCertSign

                // keyUsage[6]: KeyUsage.cRLSign

                primitives.add(CryptoPrimitive.SIGNATURE);

            }

            if (keyUsage[2]) {      // KeyUsage.keyEncipherment

                primitives.add(CryptoPrimitive.KEY_ENCAPSULATION);

            }

            if (keyUsage[3]) {      // KeyUsage.dataEncipherment

                primitives.add(CryptoPrimitive.PUBLIC_KEY_ENCRYPTION);

            }

            if (keyUsage[4]) {      // KeyUsage.keyAgreement

                primitives.add(CryptoPrimitive.KEY_AGREEMENT);

            }

            // KeyUsage.encipherOnly and KeyUsage.decipherOnly are

            // undefined in the absence of the keyAgreement bit.

            if (primitives.isEmpty()) {

                throw new CertPathValidatorException(

                    null, null, -1, PKIXReason.INVALID_KEY_USAGE);

            }

        }

        }

        // Check with previous cert for signature algorithm and public key

        if (prevPubKey != null) {

            }

            // Inherit key parameters from previous key

            if (PKIX.isDSAPublicKeyWithoutParams(currPubKey)) {

                // Inherit DSA parameters from previous key

                if (!(prevPubKey instanceof DSAPublicKey)) {

                    throw new CertPathValidatorException("Input key is not " +

                        "of a appropriate type for inheriting parameters");

                }

                DSAParams params = ((DSAPublicKey)prevPubKey).getParams();

                if (params == null) {

                    throw new CertPathValidatorException(

                }

                try {

                    BigInteger y = ((DSAPublicKey)currPubKey).getY();

                    KeyFactory kf = KeyFactory.getInstance("DSA");

                    DSAPublicKeySpec ks = new DSAPublicKeySpec(y,

                                                       params.getP(),

                                                       params.getQ(),

                                                       params.getG());

                    currPubKey = kf.generatePublic(ks);

                } catch (GeneralSecurityException e) {

                    throw new CertPathValidatorException("Unable to generate " +

                        "key with inherited parameters: " + e.getMessage(), e);

                }

            }

        }

        // reset the previous public key

        prevPubKey = currPubKey;

        // check the extended key usage, ignore the check now

        // List<String> extendedKeyUsages = x509Cert.getExtendedKeyUsage();

        // DO NOT remove any unresolved critical extensions

    }

    /**

     * Try to set the trust anchor of the checker.

     * <p>

     * If there is no trust anchor specified and the checker has not started,

     * set the trust anchor.

     *

     * @param anchor the trust anchor selected to validate the target

     *     certificate

     */

    void trySetTrustAnchor(TrustAnchor anchor) {

        // Don't bother if the check has started or trust anchor has already

        // specified.

        if (prevPubKey == null) {

            if (anchor == null) {

                throw new IllegalArgumentException(

                        "The trust anchor cannot be null");

            }

            // Don't bother to change the trustedPubKey.

            if (anchor.getTrustedCert() != null) {

                prevPubKey = anchor.getTrustedCert().getPublicKey();

            } else {

                prevPubKey = anchor.getCAPublicKey();

            }

        }

    }

    /**

     * Check the signature algorithm with the specified public key.

     *

     * @param key the public key to verify the CRL signature

     * @param crl the target CRL

     */

    static void check(PublicKey key, X509CRL crl)

                        throws CertPathValidatorException {

        X509CRLImpl x509CRLImpl = null;

        try {

            x509CRLImpl = X509CRLImpl.toImpl(crl);

        } catch (CRLException ce) {

            throw new CertPathValidatorException(ce);

        }

        AlgorithmId algorithmId = x509CRLImpl.getSigAlgId();

        check(key, algorithmId);

    }

    /**

     * Check the signature algorithm with the specified public key.

     *

     * @param key the public key to verify the CRL signature

     * @param crl the target CRL

     */

    static void check(PublicKey key, AlgorithmId algorithmId)

                        throws CertPathValidatorException {

        String sigAlgName = algorithmId.getName();

        AlgorithmParameters sigAlgParams = algorithmId.getParameters();

        if (!certPathDefaultConstraints.permits(

                SIGNATURE_PRIMITIVE_SET, sigAlgName, key, sigAlgParams)) {

            throw new CertPathValidatorException(

                null, null, -1, BasicReason.ALGORITHM_CONSTRAINED);

        }

    }

}