736 lines · 29.5 KB · Java
RawDownload
/* * Copyright (c) 2000, 2010, 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 java.security.cert; import java.security.InvalidAlgorithmParameterException;import java.security.KeyStore;import java.security.KeyStoreException;import java.util.ArrayList;import java.util.Collections;import java.util.Date;import java.util.Enumeration;import java.util.HashSet;import java.util.Iterator;import java.util.List;import java.util.Set; /** * Parameters used as input for the PKIX <code>CertPathValidator</code> * algorithm. * <p> * A PKIX <code>CertPathValidator</code> uses these parameters to * validate a <code>CertPath</code> according to the PKIX certification path * validation algorithm. * * <p>To instantiate a <code>PKIXParameters</code> object, an * application must specify one or more <i>most-trusted CAs</i> as defined by * the PKIX certification path validation algorithm. The most-trusted CAs * can be specified using one of two constructors. An application * can call {@link #PKIXParameters(Set) PKIXParameters(Set)}, * specifying a <code>Set</code> of <code>TrustAnchor</code> objects, each * of which identify a most-trusted CA. Alternatively, an application can call * {@link #PKIXParameters(KeyStore) PKIXParameters(KeyStore)}, specifying a * <code>KeyStore</code> instance containing trusted certificate entries, each * of which will be considered as a most-trusted CA. * <p> * Once a <code>PKIXParameters</code> object has been created, other parameters * can be specified (by calling {@link #setInitialPolicies setInitialPolicies} * or {@link #setDate setDate}, for instance) and then the * <code>PKIXParameters</code> is passed along with the <code>CertPath</code> * to be validated to {@link CertPathValidator#validate * CertPathValidator.validate}. * <p> * Any parameter that is not set (or is set to <code>null</code>) will * be set to the default value for that parameter. The default value for the * <code>date</code> parameter is <code>null</code>, which indicates * the current time when the path is validated. The default for the * remaining parameters is the least constrained. * <p> * <b>Concurrent Access</b> * <p> * Unless otherwise specified, the methods defined in this class are not * thread-safe. Multiple threads that need to access a single * object concurrently should synchronize amongst themselves and * provide the necessary locking. Multiple threads each manipulating * separate objects need not synchronize. * * @see CertPathValidator * * @since       1.4 * @author      Sean Mullan * @author      Yassir Elley */public class PKIXParameters implements CertPathParameters {     private Set<TrustAnchor> unmodTrustAnchors;    private Date date;    private List<PKIXCertPathChecker> certPathCheckers;    private String sigProvider;    private boolean revocationEnabled = true;    private Set<String> unmodInitialPolicies;    private boolean explicitPolicyRequired = false;    private boolean policyMappingInhibited = false;    private boolean anyPolicyInhibited = false;    private boolean policyQualifiersRejected = true;    private List<CertStore> certStores;    private CertSelector certSelector;     /**     * Creates an instance of <code>PKIXParameters</code> with the specified     * <code>Set</code> of most-trusted CAs. Each element of the     * set is a {@link TrustAnchor TrustAnchor}.     * <p>     * Note that the <code>Set</code> is copied to protect against     * subsequent modifications.     *     * @param trustAnchors a <code>Set</code> of <code>TrustAnchor</code>s     * @throws InvalidAlgorithmParameterException if the specified     * <code>Set</code> is empty <code>(trustAnchors.isEmpty() == true)</code>     * @throws NullPointerException if the specified <code>Set</code> is     * <code>null</code>     * @throws ClassCastException if any of the elements in the <code>Set</code>     * are not of type <code>java.security.cert.TrustAnchor</code>     */    public PKIXParameters(Set<TrustAnchor> trustAnchors)        throws InvalidAlgorithmParameterException    {        setTrustAnchors(trustAnchors);         this.unmodInitialPolicies = Collections.<String>emptySet();        this.certPathCheckers = new ArrayList<PKIXCertPathChecker>();        this.certStores = new ArrayList<CertStore>();    }     /**     * Creates an instance of <code>PKIXParameters</code> that     * populates the set of most-trusted CAs from the trusted     * certificate entries contained in the specified <code>KeyStore</code>.     * Only keystore entries that contain trusted <code>X509Certificates</code>     * are considered; all other certificate types are ignored.     *     * @param keystore a <code>KeyStore</code> from which the set of     * most-trusted CAs will be populated     * @throws KeyStoreException if the keystore has not been initialized     * @throws InvalidAlgorithmParameterException if the keystore does     * not contain at least one trusted certificate entry     * @throws NullPointerException if the keystore is <code>null</code>     */    public PKIXParameters(KeyStore keystore)        throws KeyStoreException, InvalidAlgorithmParameterException    {        if (keystore == null)            throw new NullPointerException("the keystore parameter must be " +                "non-null");        Set<TrustAnchor> hashSet = new HashSet<TrustAnchor>();        Enumeration<String> aliases = keystore.aliases();        while (aliases.hasMoreElements()) {            String alias = aliases.nextElement();            if (keystore.isCertificateEntry(alias)) {                Certificate cert = keystore.getCertificate(alias);                if (cert instanceof X509Certificate)                    hashSet.add(new TrustAnchor((X509Certificate)cert, null));            }        }        setTrustAnchors(hashSet);        this.unmodInitialPolicies = Collections.<String>emptySet();        this.certPathCheckers = new ArrayList<PKIXCertPathChecker>();        this.certStores = new ArrayList<CertStore>();    }     /**     * Returns an immutable <code>Set</code> of the most-trusted     * CAs.     *     * @return an immutable <code>Set</code> of <code>TrustAnchor</code>s     * (never <code>null</code>)     *     * @see #setTrustAnchors     */    public Set<TrustAnchor> getTrustAnchors() {        return this.unmodTrustAnchors;    }     /**     * Sets the <code>Set</code> of most-trusted CAs.     * <p>     * Note that the <code>Set</code> is copied to protect against     * subsequent modifications.     *     * @param trustAnchors a <code>Set</code> of <code>TrustAnchor</code>s     * @throws InvalidAlgorithmParameterException if the specified     * <code>Set</code> is empty <code>(trustAnchors.isEmpty() == true)</code>     * @throws NullPointerException if the specified <code>Set</code> is     * <code>null</code>     * @throws ClassCastException if any of the elements in the set     * are not of type <code>java.security.cert.TrustAnchor</code>     *     * @see #getTrustAnchors     */    public void setTrustAnchors(Set<TrustAnchor> trustAnchors)        throws InvalidAlgorithmParameterException    {        if (trustAnchors == null) {            throw new NullPointerException("the trustAnchors parameters must" +                " be non-null");        }        if (trustAnchors.isEmpty()) {            throw new InvalidAlgorithmParameterException("the trustAnchors " +                "parameter must be non-empty");        }        for (Iterator<TrustAnchor> i = trustAnchors.iterator(); i.hasNext(); ) {            if (!(i.next() instanceof TrustAnchor)) {                throw new ClassCastException("all elements of set must be "                    + "of type java.security.cert.TrustAnchor");            }        }        this.unmodTrustAnchors = Collections.unmodifiableSet                (new HashSet<TrustAnchor>(trustAnchors));    }     /**     * Returns an immutable <code>Set</code> of initial     * policy identifiers (OID strings), indicating that any one of these     * policies would be acceptable to the certificate user for the purposes of     * certification path processing. The default return value is an empty     * <code>Set</code>, which is interpreted as meaning that any policy would     * be acceptable.     *     * @return an immutable <code>Set</code> of initial policy OIDs in     * <code>String</code> format, or an empty <code>Set</code> (implying any     * policy is acceptable). Never returns <code>null</code>.     *     * @see #setInitialPolicies     */    public Set<String> getInitialPolicies() {        return this.unmodInitialPolicies;    }     /**     * Sets the <code>Set</code> of initial policy identifiers     * (OID strings), indicating that any one of these     * policies would be acceptable to the certificate user for the purposes of     * certification path processing. By default, any policy is acceptable     * (i.e. all policies), so a user that wants to allow any policy as     * acceptable does not need to call this method, or can call it     * with an empty <code>Set</code> (or <code>null</code>).     * <p>     * Note that the <code>Set</code> is copied to protect against     * subsequent modifications.     *     * @param initialPolicies a <code>Set</code> of initial policy     * OIDs in <code>String</code> format (or <code>null</code>)     * @throws ClassCastException if any of the elements in the set are     * not of type <code>String</code>     *     * @see #getInitialPolicies     */    public void setInitialPolicies(Set<String> initialPolicies) {        if (initialPolicies != null) {            for (Iterator<String> i = initialPolicies.iterator();                        i.hasNext();) {                if (!(i.next() instanceof String))                    throw new ClassCastException("all elements of set must be "                        + "of type java.lang.String");            }            this.unmodInitialPolicies =                Collections.unmodifiableSet(new HashSet<String>(initialPolicies));        } else            this.unmodInitialPolicies = Collections.<String>emptySet();    }     /**     * Sets the list of <code>CertStore</code>s to be used in finding     * certificates and CRLs. May be <code>null</code>, in which case     * no <code>CertStore</code>s will be used. The first     * <code>CertStore</code>s in the list may be preferred to those that     * appear later.     * <p>     * Note that the <code>List</code> is copied to protect against     * subsequent modifications.     *     * @param stores a <code>List</code> of <code>CertStore</code>s (or     * <code>null</code>)     * @throws ClassCastException if any of the elements in the list are     * not of type <code>java.security.cert.CertStore</code>     *     * @see #getCertStores     */    public void setCertStores(List<CertStore> stores) {        if (stores == null) {            this.certStores = new ArrayList<CertStore>();        } else {            for (Iterator<CertStore> i = stores.iterator(); i.hasNext();) {                if (!(i.next() instanceof CertStore)) {                    throw new ClassCastException("all elements of list must be "                        + "of type java.security.cert.CertStore");                }            }            this.certStores = new ArrayList<CertStore>(stores);        }    }     /**     * Adds a <code>CertStore</code> to the end of the list of     * <code>CertStore</code>s used in finding certificates and CRLs.     *     * @param store the <code>CertStore</code> to add. If <code>null</code>,     * the store is ignored (not added to list).     */    public void addCertStore(CertStore store) {        if (store != null) {            this.certStores.add(store);        }    }     /**     * Returns an immutable <code>List</code> of <code>CertStore</code>s that     * are used to find certificates and CRLs.     *     * @return an immutable <code>List</code> of <code>CertStore</code>s     * (may be empty, but never <code>null</code>)     *     * @see #setCertStores     */    public List<CertStore> getCertStores() {        return Collections.unmodifiableList                (new ArrayList<CertStore>(this.certStores));    }     /**     * Sets the RevocationEnabled flag. If this flag is true, the default     * revocation checking mechanism of the underlying PKIX service provider     * will be used. If this flag is false, the default revocation checking     * mechanism will be disabled (not used).     * <p>     * When a <code>PKIXParameters</code> object is created, this flag is set     * to true. This setting reflects the most common strategy for checking     * revocation, since each service provider must support revocation     * checking to be PKIX compliant. Sophisticated applications should set     * this flag to false when it is not practical to use a PKIX service     * provider's default revocation checking mechanism or when an alternative     * revocation checking mechanism is to be substituted (by also calling the     * {@link #addCertPathChecker addCertPathChecker} or {@link     * #setCertPathCheckers setCertPathCheckers} methods).     *     * @param val the new value of the RevocationEnabled flag     */    public void setRevocationEnabled(boolean val) {        revocationEnabled = val;    }     /**     * Checks the RevocationEnabled flag. If this flag is true, the default     * revocation checking mechanism of the underlying PKIX service provider     * will be used. If this flag is false, the default revocation checking     * mechanism will be disabled (not used). See the {@link     * #setRevocationEnabled setRevocationEnabled} method for more details on     * setting the value of this flag.     *     * @return the current value of the RevocationEnabled flag     */    public boolean isRevocationEnabled() {        return revocationEnabled;    }     /**     * Sets the ExplicitPolicyRequired flag. If this flag is true, an     * acceptable policy needs to be explicitly identified in every certificate.     * By default, the ExplicitPolicyRequired flag is false.     *     * @param val <code>true</code> if explicit policy is to be required,     * <code>false</code> otherwise     */    public void setExplicitPolicyRequired(boolean val) {        explicitPolicyRequired = val;    }     /**     * Checks if explicit policy is required. If this flag is true, an     * acceptable policy needs to be explicitly identified in every certificate.     * By default, the ExplicitPolicyRequired flag is false.     *     * @return <code>true</code> if explicit policy is required,     * <code>false</code> otherwise     */    public boolean isExplicitPolicyRequired() {        return explicitPolicyRequired;    }     /**     * Sets the PolicyMappingInhibited flag. If this flag is true, policy     * mapping is inhibited. By default, policy mapping is not inhibited (the     * flag is false).     *     * @param val <code>true</code> if policy mapping is to be inhibited,     * <code>false</code> otherwise     */    public void setPolicyMappingInhibited(boolean val) {        policyMappingInhibited = val;    }     /**     * Checks if policy mapping is inhibited. If this flag is true, policy     * mapping is inhibited. By default, policy mapping is not inhibited (the     * flag is false).     *     * @return true if policy mapping is inhibited, false otherwise     */    public boolean isPolicyMappingInhibited() {        return policyMappingInhibited;    }     /**     * Sets state to determine if the any policy OID should be processed     * if it is included in a certificate. By default, the any policy OID     * is not inhibited ({@link #isAnyPolicyInhibited isAnyPolicyInhibited()}     * returns <code>false</code>).     *     * @param val <code>true</code> if the any policy OID is to be     * inhibited, <code>false</code> otherwise     */    public void setAnyPolicyInhibited(boolean val) {        anyPolicyInhibited = val;    }     /**     * Checks whether the any policy OID should be processed if it     * is included in a certificate.     *     * @return <code>true</code> if the any policy OID is inhibited,     * <code>false</code> otherwise     */    public boolean isAnyPolicyInhibited() {        return anyPolicyInhibited;    }     /**     * Sets the PolicyQualifiersRejected flag. If this flag is true,     * certificates that include policy qualifiers in a certificate     * policies extension that is marked critical are rejected.     * If the flag is false, certificates are not rejected on this basis.     *     * <p> When a <code>PKIXParameters</code> object is created, this flag is     * set to true. This setting reflects the most common (and simplest)     * strategy for processing policy qualifiers. Applications that want to use     * a more sophisticated policy must set this flag to false.     * <p>     * Note that the PKIX certification path validation algorithm specifies     * that any policy qualifier in a certificate policies extension that is     * marked critical must be processed and validated. Otherwise the     * certification path must be rejected. If the policyQualifiersRejected flag     * is set to false, it is up to the application to validate all policy     * qualifiers in this manner in order to be PKIX compliant.     *     * @param qualifiersRejected the new value of the PolicyQualifiersRejected     * flag     * @see #getPolicyQualifiersRejected     * @see PolicyQualifierInfo     */    public void setPolicyQualifiersRejected(boolean qualifiersRejected) {        policyQualifiersRejected = qualifiersRejected;    }     /**     * Gets the PolicyQualifiersRejected flag. If this flag is true,     * certificates that include policy qualifiers in a certificate policies     * extension that is marked critical are rejected.     * If the flag is false, certificates are not rejected on this basis.     *     * <p> When a <code>PKIXParameters</code> object is created, this flag is     * set to true. This setting reflects the most common (and simplest)     * strategy for processing policy qualifiers. Applications that want to use     * a more sophisticated policy must set this flag to false.     *     * @return the current value of the PolicyQualifiersRejected flag     * @see #setPolicyQualifiersRejected     */    public boolean getPolicyQualifiersRejected() {        return policyQualifiersRejected;    }     /**     * Returns the time for which the validity of the certification path     * should be determined. If <code>null</code>, the current time is used.     * <p>     * Note that the <code>Date</code> returned is copied to protect against     * subsequent modifications.     *     * @return the <code>Date</code>, or <code>null</code> if not set     * @see #setDate     */    public Date getDate() {        if (date == null)            return null;        else            return (Date) this.date.clone();    }     /**     * Sets the time for which the validity of the certification path     * should be determined. If <code>null</code>, the current time is used.     * <p>     * Note that the <code>Date</code> supplied here is copied to protect     * against subsequent modifications.     *     * @param date the <code>Date</code>, or <code>null</code> for the     * current time     * @see #getDate

Lines 1–500 of 736.