Source for javax.net.ssl.TrustManagerFactory

   1: /* TrustManagerFactory.java -- factory for trust managers.
   2:    Copyright (C) 2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.net.ssl;
  40: 
  41: import gnu.java.security.Engine;
  42: 
  43: import java.lang.reflect.InvocationTargetException;
  44: import java.security.AccessController;
  45: import java.security.InvalidAlgorithmParameterException;
  46: import java.security.KeyStore;
  47: import java.security.KeyStoreException;
  48: import java.security.NoSuchAlgorithmException;
  49: import java.security.NoSuchProviderException;
  50: import java.security.PrivilegedAction;
  51: import java.security.Provider;
  52: import java.security.Security;
  53: 
  54: /**
  55:  * A factory for creating trust manager objects.
  56:  */
  57: public class TrustManagerFactory
  58: {
  59: 
  60:   // Constants and fields.
  61:   // -------------------------------------------------------------------------
  62: 
  63:   /** The service name for trust manager factories. */
  64:   private static final String TRUST_MANAGER_FACTORY = "TrustManagerFactory";
  65: 
  66:   /** The system default trust manager algorithm. */
  67:   private static final String DEFAULT_ALGORITHM = "JessieX509";
  68: 
  69:   /** The underlying engine class. */
  70:   private final TrustManagerFactorySpi tmfSpi;
  71: 
  72:   /** The provider of the engine class. */
  73:   private final Provider provider;
  74: 
  75:   /** The name of this trust manager algorithm. */
  76:   private final String algorithm;
  77: 
  78:   // Constructor.
  79:   // -------------------------------------------------------------------------
  80: 
  81:   /**
  82:    * Creates a new trust manager factory.
  83:    *
  84:    * @param tmfSpi The underlying engine class.
  85:    * @param provider The provider of the engine class.
  86:    * @param algorithm The trust manager algorithm name.
  87:    */
  88:   protected TrustManagerFactory(TrustManagerFactorySpi tmfSpi,
  89:                                 Provider provider, String algorithm)
  90:   {
  91:     this.tmfSpi = tmfSpi;
  92:     this.provider = provider;
  93:     this.algorithm = algorithm;
  94:   }
  95: 
  96:   /**
  97:    * Returns an instance of a trust manager factory for the given algorithm from
  98:    * the first provider that implements it.
  99:    * 
 100:    * @param algorithm The name of the algorithm to get.
 101:    * @return The instance of the trust manager factory.
 102:    * @throws NoSuchAlgorithmException If no provider implements the given
 103:    *           algorithm.
 104:    * @throws IllegalArgumentException if <code>algorithm</code> is
 105:    *           <code>null</code> or is an empty string.
 106:    */
 107:   public static final TrustManagerFactory getInstance(String algorithm)
 108:       throws NoSuchAlgorithmException
 109:   {
 110:     Provider[] p = Security.getProviders();
 111:     NoSuchAlgorithmException lastException = null;
 112:     for (int i = 0; i < p.length; i++)
 113:       try
 114:         {
 115:           return getInstance(algorithm, p[i]);
 116:         }
 117:       catch (NoSuchAlgorithmException x)
 118:         {
 119:           lastException = x;
 120:         }
 121:     if (lastException != null)
 122:       throw lastException;
 123:     throw new NoSuchAlgorithmException(algorithm);
 124:   }
 125: 
 126:   /**
 127:    * Returns an instance of a trust manager factory for the given algorithm from
 128:    * the named provider.
 129:    * 
 130:    * @param algorithm The name of the algorithm to get.
 131:    * @param provider The name of the provider to get the instance from.
 132:    * @return The instance of the trust manager factory.
 133:    * @throws NoSuchAlgorithmException If the provider does not implement the
 134:    *           given algorithm.
 135:    * @throws NoSuchProviderException If there is no such named provider.
 136:    * @throws IllegalArgumentException if either <code>algorithm</code> or
 137:    *           <code>provider</code> is <code>null</code>, or if
 138:    *           <code>algorithm</code> is an empty string.
 139:    */
 140:   public static final TrustManagerFactory getInstance(String algorithm,
 141:                                                       String provider)
 142:     throws NoSuchAlgorithmException, NoSuchProviderException
 143:   {
 144:     if (provider == null)
 145:       throw new IllegalArgumentException("provider MUST NOT be null");
 146:     Provider p = Security.getProvider(provider);
 147:     if (p == null)
 148:       throw new NoSuchProviderException(provider);
 149:     return getInstance(algorithm, p);
 150:   }
 151: 
 152:   /**
 153:    * Returns an instance of a trust manager factory for the given algorithm from
 154:    * the specified provider.
 155:    * 
 156:    * @param algorithm The name of the algorithm to get.
 157:    * @param provider The provider to get the instance from.
 158:    * @return The instance of the trust manager factory.
 159:    * @throws NoSuchAlgorithmException If the provider does not implement the
 160:    *           given algorithm.
 161:    * @throws IllegalArgumentException if either <code>algorithm</code> or
 162:    *           <code>provider</code> is <code>null</code>, or if
 163:    *           <code>algorithm</code> is an empty string.
 164:    */
 165:   public static final TrustManagerFactory getInstance(String algorithm,
 166:                                                       Provider provider)
 167:       throws NoSuchAlgorithmException
 168:   {
 169:     StringBuilder sb = new StringBuilder("TrustManagerFactory algorithm [")
 170:         .append(algorithm).append("] from provider[")
 171:         .append(provider).append("] could not be created");
 172:     Throwable cause;
 173:     try
 174:       {
 175:         Object spi = Engine.getInstance(TRUST_MANAGER_FACTORY, algorithm, provider);
 176:         return new TrustManagerFactory((TrustManagerFactorySpi) spi,
 177:                                        provider,
 178:                                        algorithm);
 179:       }
 180:     catch (InvocationTargetException x)
 181:       {
 182:         cause = x.getCause();
 183:         if (cause instanceof NoSuchAlgorithmException)
 184:           throw (NoSuchAlgorithmException) cause;
 185:         if (cause == null)
 186:           cause = x;
 187:       }
 188:     catch (ClassCastException x)
 189:       {
 190:         cause = x;
 191:       }
 192:     NoSuchAlgorithmException x = new NoSuchAlgorithmException(sb.toString());
 193:     x.initCause(cause);
 194:     throw x;
 195:   }
 196: 
 197:   /**
 198:    * Returns the default algorithm for trust manager factories. The value
 199:    * returned is either the value of the security property
 200:    * "ssl.TrustManagerFactory.algorithm" if it is set, or the value "JessieX509"
 201:    * if not.
 202:    *
 203:    * @return The default algorithm name.
 204:    * @see Security.getProperty(java.lang.String)
 205:    */
 206:   public static final String getDefaultAlgorithm()
 207:   {
 208:     String alg = null;
 209:     try
 210:       {
 211:         alg = (String) AccessController.doPrivileged(
 212:           new PrivilegedAction()
 213:           {
 214:             public Object run()
 215:             {
 216:               return Security.getProperty("ssl.TrustManagerFactory.algorithm");
 217:             }
 218:           }
 219:         );
 220:       }
 221:     catch (SecurityException se)
 222:       {
 223:       }
 224:     if (alg == null)
 225:       alg = DEFAULT_ALGORITHM;
 226:     return alg;
 227:   }
 228: 
 229:   // Instance methods.
 230:   // -------------------------------------------------------------------------
 231: 
 232:   /**
 233:    * Returns the name of this trust manager algorithm.
 234:    *
 235:    * @return The algorithm name.
 236:    */
 237:   public final String getAlgorithm()
 238:   {
 239:     return algorithm;
 240:   }
 241: 
 242:   /**
 243:    * Returns the provider of the underlying implementation.
 244:    *
 245:    * @return The provider.
 246:    */
 247:   public final Provider getProvider()
 248:   {
 249:     return provider;
 250:   }
 251: 
 252:   /**
 253:    * Returns the trust managers created by this factory.
 254:    *
 255:    * @return The trust managers.
 256:    */
 257:   public final TrustManager[] getTrustManagers()
 258:   {
 259:     return tmfSpi.engineGetTrustManagers();
 260:   }
 261: 
 262:   /**
 263:    * Initialize this instance with some algorithm-specific parameters.
 264:    *
 265:    * @param params The parameters.
 266:    * @throws InvalidAlgorithmParameterException If the supplied parameters
 267:    *   are inappropriate for this instance.
 268:    */
 269:   public final void init(ManagerFactoryParameters params)
 270:     throws InvalidAlgorithmParameterException
 271:   {
 272:     tmfSpi.engineInit(params);
 273:   }
 274: 
 275:   /**
 276:    * Initialize this instance with a key store. The key store may be null,
 277:    * in which case a default will be used.
 278:    *
 279:    * @param store The key store.
 280:    * @throws KeyStoreException If there is a problem reading from the
 281:    *   key store.
 282:    */
 283:   public final void init(KeyStore store) throws KeyStoreException
 284:   {
 285:     tmfSpi.engineInit(store);
 286:   }
 287: }