1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
/* * @(#)CertPathValidator.java 1.13 06/04/21 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.security.cert; import java.security.AccessController; import java.security.InvalidAlgorithmParameterException; import java.security.NoSuchAlgorithmException; import java.security.NoSuchProviderException; import java.security.PrivilegedAction; import java.security.Provider; import java.security.Security; import sun.security.util.Debug; import sun.security.jca.*; import sun.security.jca.GetInstance.Instance; /** * A class for validating certification paths (also known as certificate * chains). * <p> * This class uses a provider-based architecture. * To create a <code>CertPathValidator</code>, * call one of the static <code>getInstance</code> methods, passing in the * algorithm name of the <code>CertPathValidator</code> desired and * optionally the name of the provider desired. * <p> * Once a <code>CertPathValidator</code> object has been created, it can * be used to validate certification paths by calling the {@link #validate * validate} method and passing it the <code>CertPath</code> to be validated * and an algorithm-specific set of parameters. If successful, the result is * returned in an object that implements the * <code>CertPathValidatorResult</code> interface. * <p> * <b>Concurrent Access</b> * <p> * The static methods of this class are guaranteed to be thread-safe. * Multiple threads may concurrently invoke the static methods defined in * this class with no ill effects. * <p> * However, this is not true for the non-static methods defined by this class. * Unless otherwise documented by a specific provider, threads that need to * access a single <code>CertPathValidator</code> instance concurrently should * synchronize amongst themselves and provide the necessary locking. Multiple * threads each manipulating a different <code>CertPathValidator</code> * instance need not synchronize. * * @see CertPath * * @version 1.13 04/21/06 * @since 1.4 * @author Yassir Elley */ public class CertPathValidator { /* * Constant to lookup in the Security properties file to determine * the default certpathvalidator type. In the Security properties file, * the default certpathvalidator type is given as: * <pre> * certpathvalidator.type=PKIX * </pre> */ private static final String CPV_TYPE = "certpathvalidator.type"; private static final Debug debug = Debug.getInstance("certpath"); private CertPathValidatorSpi validatorSpi; private Provider provider; private String algorithm; /** * Creates a <code>CertPathValidator</code> object of the given algorithm, * and encapsulates the given provider implementation (SPI object) in it. * * @param validatorSpi the provider implementation * @param provider the provider * @param algorithm the algorithm name */ protected CertPathValidator(CertPathValidatorSpi validatorSpi, Provider provider, String algorithm) { this.validatorSpi = validatorSpi; this.provider = provider; this.algorithm = algorithm; } /** * Returns a <code>CertPathValidator</code> object that implements the * specified algorithm. * * <p> This method traverses the list of registered security Providers, * starting with the most preferred Provider. * A new CertPathValidator object encapsulating the * CertPathValidatorSpi implementation from the first * Provider that supports the specified algorithm is returned. * * <p> Note that the list of registered providers may be retrieved via * the {@link Security#getProviders() Security.getProviders()} method. * * @param algorithm the name of the requested <code>CertPathValidator</code> * algorithm. See Appendix A in the <a href= * "../../../../technotes/guides/security/certpath/CertPathProgGuide.html#AppA"> * Java Certification Path API Programmer's Guide </a> * for information about standard algorithm names. * * @return a <code>CertPathValidator</code> object that implements the * specified algorithm. * * @exception NoSuchAlgorithmException if no Provider supports a * CertPathValidatorSpi implementation for the * specified algorithm. * * @see java.security.Provider */ public static CertPathValidator getInstance(String algorithm) throws NoSuchAlgorithmException { Instance instance = GetInstance.getInstance("CertPathValidator", CertPathValidatorSpi.class, algorithm); return new CertPathValidator((CertPathValidatorSpi)instance.impl, instance.provider, algorithm); } /** * Returns a <code>CertPathValidator</code> object that implements the * specified algorithm. * * <p> A new CertPathValidator object encapsulating the * CertPathValidatorSpi implementation from the specified provider * is returned. The specified provider must be registered * in the security provider list. * * <p> Note that the list of registered providers may be retrieved via * the {@link Security#getProviders() Security.getProviders()} method. * * @param algorithm the name of the requested <code>CertPathValidator</code> * algorithm. See Appendix A in the <a href= * "../../../../technotes/guides/security/certpath/CertPathProgGuide.html#AppA"> * Java Certification Path API Programmer's Guide </a> * for information about standard algorithm names. * * @param provider the name of the provider. * * @return a <code>CertPathValidator</code> object that implements the * specified algorithm. * * @exception NoSuchAlgorithmException if a CertPathValidatorSpi * implementation for the specified algorithm is not * available from the specified provider. * * @exception NoSuchProviderException if the specified provider is not * registered in the security provider list. * * @exception IllegalArgumentException if the <code>provider</code> is * null or empty. * * @see java.security.Provider */ public static CertPathValidator getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException { Instance instance = GetInstance.getInstance("CertPathValidator", CertPathValidatorSpi.class, algorithm, provider); return new CertPathValidator((CertPathValidatorSpi)instance.impl, instance.provider, algorithm); } /** * Returns a <code>CertPathValidator</code> object that implements the * specified algorithm. * * <p> A new CertPathValidator object encapsulating the * CertPathValidatorSpi implementation from the specified Provider * object is returned. Note that the specified Provider object * does not have to be registered in the provider list. * * @param algorithm the name of the requested * <code>CertPathValidator</code> algorithm. * See Appendix A in the <a href= * "../../../../technotes/guides/security/certpath/CertPathProgGuide.html#AppA"> * Java Certification Path API Programmer's Guide </a> * for information about standard algorithm names. * * @param provider the provider. * * @return a <code>CertPathValidator</code> object that implements the * specified algorithm. * * @exception NoSuchAlgorithmException if a CertPathValidatorSpi * implementation for the specified algorithm is not available * from the specified Provider object. * * @exception IllegalArgumentException if the <code>provider</code> is * null. * * @see java.security.Provider */ public static CertPathValidator getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException { Instance instance = GetInstance.getInstance("CertPathValidator", CertPathValidatorSpi.class, algorithm, provider); return new CertPathValidator((CertPathValidatorSpi)instance.impl, instance.provider, algorithm); } /** * Returns the <code>Provider</code> of this * <code>CertPathValidator</code>. * * @return the <code>Provider</code> of this <code>CertPathValidator</code> */ public final Provider getProvider() { return this.provider; } /** * Returns the algorithm name of this <code>CertPathValidator</code>. * * @return the algorithm name of this <code>CertPathValidator</code> */ public final String getAlgorithm() { return this.algorithm; } /** * Validates the specified certification path using the specified * algorithm parameter set. * <p> * The <code>CertPath</code> specified must be of a type that is * supported by the validation algorithm, otherwise an * <code>InvalidAlgorithmParameterException</code> will be thrown. For * example, a <code>CertPathValidator</code> that implements the PKIX * algorithm validates <code>CertPath</code> objects of type X.509. * * @param certPath the <code>CertPath</code> to be validated * @param params the algorithm parameters * @return the result of the validation algorithm * @exception CertPathValidatorException if the <code>CertPath</code> * does not validate * @exception InvalidAlgorithmParameterException if the specified * parameters or the type of the specified <code>CertPath</code> are * inappropriate for this <code>CertPathValidator</code> */ public final CertPathValidatorResult validate(CertPath certPath, CertPathParameters params) throws CertPathValidatorException, InvalidAlgorithmParameterException { return validatorSpi.engineValidate(certPath, params); } /** * Returns the default <code>CertPathValidator</code> type as specified in * the Java security properties file, or the string "PKIX" * if no such property exists. The Java security properties file is * located in the file named <JAVA_HOME>/lib/security/java.security. * <JAVA_HOME> refers to the value of the java.home system property, * and specifies the directory where the JRE is installed. * * <p>The default <code>CertPathValidator</code> type can be used by * applications that do not want to use a hard-coded type when calling one * of the <code>getInstance</code> methods, and want to provide a default * type in case a user does not specify its own. * * <p>The default <code>CertPathValidator</code> type can be changed by * setting the value of the "certpathvalidator.type" security property * (in the Java security properties file) to the desired type. * * @return the default <code>CertPathValidator</code> type as specified * in the Java security properties file, or the string "PKIX" * if no such property exists. */ public final static String getDefaultType() { String cpvtype; cpvtype = (String)AccessController.doPrivileged(new PrivilegedAction() { public Object run() { return Security.getProperty(CPV_TYPE); } }); if (cpvtype == null) { cpvtype = "PKIX"; } return cpvtype; } }