J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2003-2005 Sun Microsystems, Inc. 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. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package sun.security.jca; |
| 27 | |
| 28 | import java.util.*; |
| 29 | |
| 30 | import java.security.Provider; |
| 31 | import java.security.Security; |
| 32 | |
| 33 | /** |
| 34 | * Collection of methods to get and set provider list. Also includes |
| 35 | * special code for the provider list during JAR verification. |
| 36 | * |
| 37 | * @author Andreas Sterbenz |
| 38 | * @since 1.5 |
| 39 | */ |
| 40 | public class Providers { |
| 41 | |
| 42 | private static final ThreadLocal<ProviderList> threadLists = |
| 43 | new InheritableThreadLocal<ProviderList>(); |
| 44 | |
| 45 | // number of threads currently using thread-local provider lists |
| 46 | // tracked to allow an optimization if == 0 |
| 47 | private static volatile int threadListsUsed; |
| 48 | |
| 49 | // current system-wide provider list |
| 50 | // Note volatile immutable object, so no synchronization needed. |
| 51 | private static volatile ProviderList providerList; |
| 52 | |
| 53 | static { |
| 54 | // set providerList to empty list first in case initialization somehow |
| 55 | // triggers a getInstance() call (although that should not happen) |
| 56 | providerList = ProviderList.EMPTY; |
| 57 | providerList = ProviderList.fromSecurityProperties(); |
| 58 | } |
| 59 | |
| 60 | private Providers() { |
| 61 | // empty |
| 62 | } |
| 63 | |
| 64 | // we need special handling to resolve circularities when loading |
| 65 | // signed JAR files during startup. The code below is part of that. |
| 66 | |
| 67 | // Basically, before we load data from a signed JAR file, we parse |
| 68 | // the PKCS#7 file and verify the signature. We need a |
| 69 | // CertificateFactory, Signatures, etc. to do that. We have to make |
| 70 | // sure that we do not try to load the implementation from the JAR |
| 71 | // file we are just verifying. |
| 72 | // |
| 73 | // To avoid that, we use different provider settings during JAR |
| 74 | // verification. However, we do not want those provider settings to |
| 75 | // interfere with other parts of the system. Therefore, we make them local |
| 76 | // to the Thread executing the JAR verification code. |
| 77 | // |
| 78 | // The code here is used by sun.security.util.SignatureFileVerifier. |
| 79 | // See there for details. |
| 80 | |
| 81 | private static final String BACKUP_PROVIDER_CLASSNAME = |
| 82 | "sun.security.provider.VerificationProvider"; |
| 83 | |
| 84 | // Hardcoded classnames of providers to use for JAR verification. |
| 85 | // MUST NOT be on the bootclasspath and not in signed JAR files. |
| 86 | private static final String[] jarVerificationProviders = { |
| 87 | "sun.security.provider.Sun", |
| 88 | "sun.security.rsa.SunRsaSign", |
| 89 | BACKUP_PROVIDER_CLASSNAME, |
| 90 | }; |
| 91 | |
| 92 | // Return to Sun provider or its backup. |
| 93 | // This method should only be called by |
| 94 | // sun.security.util.ManifestEntryVerifier and java.security.SecureRandom. |
| 95 | public static Provider getSunProvider() { |
| 96 | try { |
| 97 | Class clazz = Class.forName(jarVerificationProviders[0]); |
| 98 | return (Provider)clazz.newInstance(); |
| 99 | } catch (Exception e) { |
| 100 | try { |
| 101 | Class clazz = Class.forName(BACKUP_PROVIDER_CLASSNAME); |
| 102 | return (Provider)clazz.newInstance(); |
| 103 | } catch (Exception ee) { |
| 104 | throw new RuntimeException("Sun provider not found", e); |
| 105 | } |
| 106 | } |
| 107 | } |
| 108 | |
| 109 | /** |
| 110 | * Start JAR verification. This sets a special provider list for |
| 111 | * the current thread. You MUST save the return value from this |
| 112 | * method and you MUST call stopJarVerification() with that object |
| 113 | * once you are done. |
| 114 | */ |
| 115 | public static Object startJarVerification() { |
| 116 | ProviderList currentList = getProviderList(); |
| 117 | ProviderList jarList = currentList.getJarList(jarVerificationProviders); |
| 118 | // return the old thread-local provider list, usually null |
| 119 | return beginThreadProviderList(jarList); |
| 120 | } |
| 121 | |
| 122 | /** |
| 123 | * Stop JAR verification. Call once you have completed JAR verification. |
| 124 | */ |
| 125 | public static void stopJarVerification(Object obj) { |
| 126 | // restore old thread-local provider list |
| 127 | endThreadProviderList((ProviderList)obj); |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Return the current ProviderList. If the thread-local list is set, |
| 132 | * it is returned. Otherwise, the system wide list is returned. |
| 133 | */ |
| 134 | public static ProviderList getProviderList() { |
| 135 | ProviderList list = getThreadProviderList(); |
| 136 | if (list == null) { |
| 137 | list = getSystemProviderList(); |
| 138 | } |
| 139 | return list; |
| 140 | } |
| 141 | |
| 142 | /** |
| 143 | * Set the current ProviderList. Affects the thread-local list if set, |
| 144 | * otherwise the system wide list. |
| 145 | */ |
| 146 | public static void setProviderList(ProviderList newList) { |
| 147 | if (getThreadProviderList() == null) { |
| 148 | setSystemProviderList(newList); |
| 149 | } else { |
| 150 | changeThreadProviderList(newList); |
| 151 | } |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Get the full provider list with invalid providers (those that |
| 156 | * could not be loaded) removed. This is the list we need to |
| 157 | * present to applications. |
| 158 | */ |
| 159 | public static synchronized ProviderList getFullProviderList() { |
| 160 | ProviderList list = getThreadProviderList(); |
| 161 | if (list != null) { |
| 162 | ProviderList newList = list.removeInvalid(); |
| 163 | if (newList != list) { |
| 164 | changeThreadProviderList(newList); |
| 165 | list = newList; |
| 166 | } |
| 167 | return list; |
| 168 | } |
| 169 | list = getSystemProviderList(); |
| 170 | ProviderList newList = list.removeInvalid(); |
| 171 | if (newList != list) { |
| 172 | setSystemProviderList(newList); |
| 173 | list = newList; |
| 174 | } |
| 175 | return list; |
| 176 | } |
| 177 | |
| 178 | private static ProviderList getSystemProviderList() { |
| 179 | return providerList; |
| 180 | } |
| 181 | |
| 182 | private static void setSystemProviderList(ProviderList list) { |
| 183 | providerList = list; |
| 184 | } |
| 185 | |
| 186 | public static ProviderList getThreadProviderList() { |
| 187 | // avoid accessing the threadlocal if none are currently in use |
| 188 | // (first use of ThreadLocal.get() for a Thread allocates a Map) |
| 189 | if (threadListsUsed == 0) { |
| 190 | return null; |
| 191 | } |
| 192 | return threadLists.get(); |
| 193 | } |
| 194 | |
| 195 | // Change the thread local provider list. Use only if the current thread |
| 196 | // is already using a thread local list and you want to change it in place. |
| 197 | // In other cases, use the begin/endThreadProviderList() methods. |
| 198 | private static void changeThreadProviderList(ProviderList list) { |
| 199 | threadLists.set(list); |
| 200 | } |
| 201 | |
| 202 | /** |
| 203 | * Methods to manipulate the thread local provider list. It is for use by |
| 204 | * JAR verification (see above) and the SunJSSE FIPS mode only. |
| 205 | * |
| 206 | * It should be used as follows: |
| 207 | * |
| 208 | * ProviderList list = ...; |
| 209 | * ProviderList oldList = Providers.beginThreadProviderList(list); |
| 210 | * try { |
| 211 | * // code that needs thread local provider list |
| 212 | * } finally { |
| 213 | * Providers.endThreadProviderList(oldList); |
| 214 | * } |
| 215 | * |
| 216 | */ |
| 217 | |
| 218 | public static synchronized ProviderList beginThreadProviderList(ProviderList list) { |
| 219 | if (ProviderList.debug != null) { |
| 220 | ProviderList.debug.println("ThreadLocal providers: " + list); |
| 221 | } |
| 222 | ProviderList oldList = threadLists.get(); |
| 223 | threadListsUsed++; |
| 224 | threadLists.set(list); |
| 225 | return oldList; |
| 226 | } |
| 227 | |
| 228 | public static synchronized void endThreadProviderList(ProviderList list) { |
| 229 | if (list == null) { |
| 230 | if (ProviderList.debug != null) { |
| 231 | ProviderList.debug.println("Disabling ThreadLocal providers"); |
| 232 | } |
| 233 | threadLists.remove(); |
| 234 | } else { |
| 235 | if (ProviderList.debug != null) { |
| 236 | ProviderList.debug.println |
| 237 | ("Restoring previous ThreadLocal providers: " + list); |
| 238 | } |
| 239 | threadLists.set(list); |
| 240 | } |
| 241 | threadListsUsed--; |
| 242 | } |
| 243 | |
| 244 | } |