1 /* 2 * Copyright (c) 2000, 2015, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.security.cert; 27 28 import java.security.AccessController; 29 import java.security.InvalidAlgorithmParameterException; 30 import java.security.NoSuchAlgorithmException; 31 import java.security.NoSuchProviderException; 32 import java.security.PrivilegedAction; 33 import java.security.Provider; 34 import java.security.Security; 35 import sun.security.util.Debug; 36 37 import sun.security.jca.*; 38 import sun.security.jca.GetInstance.Instance; 39 40 /** 41 * A class for validating certification paths (also known as certificate 42 * chains). 43 * <p> 44 * This class uses a provider-based architecture. 45 * To create a {@code CertPathValidator}, 46 * call one of the static {@code getInstance} methods, passing in the 47 * algorithm name of the {@code CertPathValidator} desired and 48 * optionally the name of the provider desired. 49 * 50 * <p>Once a {@code CertPathValidator} object has been created, it can 51 * be used to validate certification paths by calling the {@link #validate 52 * validate} method and passing it the {@code CertPath} to be validated 53 * and an algorithm-specific set of parameters. If successful, the result is 54 * returned in an object that implements the 55 * {@code CertPathValidatorResult} interface. 56 * 57 * <p>The {@link #getRevocationChecker} method allows an application to specify 58 * additional algorithm-specific parameters and options used by the 59 * {@code CertPathValidator} when checking the revocation status of 60 * certificates. Here is an example demonstrating how it is used with the PKIX 61 * algorithm: 62 * 63 * <pre> 64 * CertPathValidator cpv = CertPathValidator.getInstance("PKIX"); 65 * PKIXRevocationChecker rc = (PKIXRevocationChecker)cpv.getRevocationChecker(); 66 * rc.setOptions(EnumSet.of(Option.SOFT_FAIL)); 67 * params.addCertPathChecker(rc); 68 * CertPathValidatorResult cpvr = cpv.validate(path, params); 69 * </pre> 70 * 71 * <p>Every implementation of the Java platform is required to support the 72 * following standard {@code CertPathValidator} algorithm: 73 * <ul> 74 * <li>{@code PKIX}</li> 75 * </ul> 76 * This algorithm is described in the <a href= 77 * "{@docRoot}/../technotes/guides/security/StandardNames.html#CertPathValidator"> 78 * CertPathValidator section</a> of the 79 * Java Cryptography Architecture Standard Algorithm Name Documentation. 80 * Consult the release documentation for your implementation to see if any 81 * other algorithms are supported. 82 * 83 * <p> 84 * <b>Concurrent Access</b> 85 * <p> 86 * The static methods of this class are guaranteed to be thread-safe. 87 * Multiple threads may concurrently invoke the static methods defined in 88 * this class with no ill effects. 89 * <p> 90 * However, this is not true for the non-static methods defined by this class. 91 * Unless otherwise documented by a specific provider, threads that need to 92 * access a single {@code CertPathValidator} instance concurrently should 93 * synchronize amongst themselves and provide the necessary locking. Multiple 94 * threads each manipulating a different {@code CertPathValidator} 95 * instance need not synchronize. 96 * 97 * @see CertPath 98 * 99 * @since 1.4 100 * @author Yassir Elley 101 */ 102 public class CertPathValidator { 103 104 /* 105 * Constant to lookup in the Security properties file to determine 106 * the default certpathvalidator type. In the Security properties file, 107 * the default certpathvalidator type is given as: 108 * <pre> 109 * certpathvalidator.type=PKIX 110 * </pre> 111 */ 112 private static final String CPV_TYPE = "certpathvalidator.type"; 113 private final CertPathValidatorSpi validatorSpi; 114 private final Provider provider; 115 private final String algorithm; 116 117 /** 118 * Creates a {@code CertPathValidator} object of the given algorithm, 119 * and encapsulates the given provider implementation (SPI object) in it. 120 * 121 * @param validatorSpi the provider implementation 122 * @param provider the provider 123 * @param algorithm the algorithm name 124 */ 125 protected CertPathValidator(CertPathValidatorSpi validatorSpi, 126 Provider provider, String algorithm) 127 { 128 this.validatorSpi = validatorSpi; 129 this.provider = provider; 130 this.algorithm = algorithm; 131 } 132 133 /** 134 * Returns a {@code CertPathValidator} object that implements the 135 * specified algorithm. 136 * 137 * <p> This method traverses the list of registered security Providers, 138 * starting with the most preferred Provider. 139 * A new CertPathValidator object encapsulating the 140 * CertPathValidatorSpi implementation from the first 141 * Provider that supports the specified algorithm is returned. 142 * 143 * <p> Note that the list of registered providers may be retrieved via 144 * the {@link Security#getProviders() Security.getProviders()} method. 145 * 146 * @implNote 147 * The JDK Reference Implementation additionally uses the 148 * {@code jdk.security.provider.preferred} property to determine 149 * the preferred provider order for the specified algorithm. This 150 * may be different than the order of providers returned by 151 * {@link Security#getProviders() Security.getProviders()}. 152 * 153 * @param algorithm the name of the requested {@code CertPathValidator} 154 * algorithm. See the CertPathValidator section in the <a href= 155 * "{@docRoot}/../technotes/guides/security/StandardNames.html#CertPathValidator"> 156 * Java Cryptography Architecture Standard Algorithm Name Documentation</a> 157 * for information about standard algorithm names. 158 * 159 * @return a {@code CertPathValidator} object that implements the 160 * specified algorithm. 161 * 162 * @exception NoSuchAlgorithmException if no Provider supports a 163 * CertPathValidatorSpi implementation for the 164 * specified algorithm. 165 * 166 * @see java.security.Provider 167 */ 168 public static CertPathValidator getInstance(String algorithm) 169 throws NoSuchAlgorithmException { 170 Instance instance = GetInstance.getInstance("CertPathValidator", 171 CertPathValidatorSpi.class, algorithm); 172 return new CertPathValidator((CertPathValidatorSpi)instance.impl, 173 instance.provider, algorithm); 174 } 175 176 /** 177 * Returns a {@code CertPathValidator} object that implements the 178 * specified algorithm. 179 * 180 * <p> A new CertPathValidator object encapsulating the 181 * CertPathValidatorSpi implementation from the specified provider 182 * is returned. The specified provider must be registered 183 * in the security provider list. 184 * 185 * <p> Note that the list of registered providers may be retrieved via 186 * the {@link Security#getProviders() Security.getProviders()} method. 187 * 188 * @param algorithm the name of the requested {@code CertPathValidator} 189 * algorithm. See the CertPathValidator section in the <a href= 190 * "{@docRoot}/../technotes/guides/security/StandardNames.html#CertPathValidator"> 191 * Java Cryptography Architecture Standard Algorithm Name Documentation</a> 192 * for information about standard algorithm names. 193 * 194 * @param provider the name of the provider. 195 * 196 * @return a {@code CertPathValidator} object that implements the 197 * specified algorithm. 198 * 199 * @exception NoSuchAlgorithmException if a CertPathValidatorSpi 200 * implementation for the specified algorithm is not 201 * available from the specified provider. 202 * 203 * @exception NoSuchProviderException if the specified provider is not 204 * registered in the security provider list. 205 * 206 * @exception IllegalArgumentException if the {@code provider} is 207 * null or empty. 208 * 209 * @see java.security.Provider 210 */ 211 public static CertPathValidator getInstance(String algorithm, 212 String provider) throws NoSuchAlgorithmException, 213 NoSuchProviderException { 214 Instance instance = GetInstance.getInstance("CertPathValidator", 215 CertPathValidatorSpi.class, algorithm, provider); 216 return new CertPathValidator((CertPathValidatorSpi)instance.impl, 217 instance.provider, algorithm); 218 } 219 220 /** 221 * Returns a {@code CertPathValidator} object that implements the 222 * specified algorithm. 223 * 224 * <p> A new CertPathValidator object encapsulating the 225 * CertPathValidatorSpi implementation from the specified Provider 226 * object is returned. Note that the specified Provider object 227 * does not have to be registered in the provider list. 228 * 229 * @param algorithm the name of the requested {@code CertPathValidator} 230 * algorithm. See the CertPathValidator section in the <a href= 231 * "{@docRoot}/../technotes/guides/security/StandardNames.html#CertPathValidator"> 232 * Java Cryptography Architecture Standard Algorithm Name Documentation</a> 233 * for information about standard algorithm names. 234 * 235 * @param provider the provider. 236 * 237 * @return a {@code CertPathValidator} object that implements the 238 * specified algorithm. 239 * 240 * @exception NoSuchAlgorithmException if a CertPathValidatorSpi 241 * implementation for the specified algorithm is not available 242 * from the specified Provider object. 243 * 244 * @exception IllegalArgumentException if the {@code provider} is 245 * null. 246 * 247 * @see java.security.Provider 248 */ 249 public static CertPathValidator getInstance(String algorithm, 250 Provider provider) throws NoSuchAlgorithmException { 251 Instance instance = GetInstance.getInstance("CertPathValidator", 252 CertPathValidatorSpi.class, algorithm, provider); 253 return new CertPathValidator((CertPathValidatorSpi)instance.impl, 254 instance.provider, algorithm); 255 } 256 257 /** 258 * Returns the {@code Provider} of this 259 * {@code CertPathValidator}. 260 * 261 * @return the {@code Provider} of this {@code CertPathValidator} 262 */ 263 public final Provider getProvider() { 264 return this.provider; 265 } 266 267 /** 268 * Returns the algorithm name of this {@code CertPathValidator}. 269 * 270 * @return the algorithm name of this {@code CertPathValidator} 271 */ 272 public final String getAlgorithm() { 273 return this.algorithm; 274 } 275 276 /** 277 * Validates the specified certification path using the specified 278 * algorithm parameter set. 279 * <p> 280 * The {@code CertPath} specified must be of a type that is 281 * supported by the validation algorithm, otherwise an 282 * {@code InvalidAlgorithmParameterException} will be thrown. For 283 * example, a {@code CertPathValidator} that implements the PKIX 284 * algorithm validates {@code CertPath} objects of type X.509. 285 * 286 * @param certPath the {@code CertPath} to be validated 287 * @param params the algorithm parameters 288 * @return the result of the validation algorithm 289 * @exception CertPathValidatorException if the {@code CertPath} 290 * does not validate 291 * @exception InvalidAlgorithmParameterException if the specified 292 * parameters or the type of the specified {@code CertPath} are 293 * inappropriate for this {@code CertPathValidator} 294 */ 295 public final CertPathValidatorResult validate(CertPath certPath, 296 CertPathParameters params) 297 throws CertPathValidatorException, InvalidAlgorithmParameterException 298 { 299 return validatorSpi.engineValidate(certPath, params); 300 } 301 302 /** 303 * Returns the default {@code CertPathValidator} type as specified by 304 * the {@code certpathvalidator.type} security property, or the string 305 * {@literal "PKIX"} if no such property exists. 306 * 307 * <p>The default {@code CertPathValidator} type can be used by 308 * applications that do not want to use a hard-coded type when calling one 309 * of the {@code getInstance} methods, and want to provide a default 310 * type in case a user does not specify its own. 311 * 312 * <p>The default {@code CertPathValidator} type can be changed by 313 * setting the value of the {@code certpathvalidator.type} security 314 * property to the desired type. 315 * 316 * @see java.security.Security security properties 317 * @return the default {@code CertPathValidator} type as specified 318 * by the {@code certpathvalidator.type} security property, or the string 319 * {@literal "PKIX"} if no such property exists. 320 */ 321 public static final String getDefaultType() { 322 String cpvtype = 323 AccessController.doPrivileged(new PrivilegedAction<>() { 324 public String run() { 325 return Security.getProperty(CPV_TYPE); 326 } 327 }); 328 return (cpvtype == null) ? "PKIX" : cpvtype; 329 } 330 331 /** 332 * Returns a {@code CertPathChecker} that the encapsulated 333 * {@code CertPathValidatorSpi} implementation uses to check the revocation 334 * status of certificates. A PKIX implementation returns objects of 335 * type {@code PKIXRevocationChecker}. Each invocation of this method 336 * returns a new instance of {@code CertPathChecker}. 337 * 338 * <p>The primary purpose of this method is to allow callers to specify 339 * additional input parameters and options specific to revocation checking. 340 * See the class description for an example. 341 * 342 * @return a {@code CertPathChecker} 343 * @throws UnsupportedOperationException if the service provider does not 344 * support this method 345 * @since 1.8 346 */ 347 public final CertPathChecker getRevocationChecker() { 348 return validatorSpi.engineGetRevocationChecker(); 349 } 350 }