1 /*
2 * Copyright (c) 1998, 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 sun.security.util;
27
28 import java.math.BigInteger;
29 import java.util.regex.Pattern;
30 import java.util.regex.Matcher;
31 import java.util.Locale;
32
33 /**
34 * A utility class for debuging.
35 *
36 * @author Roland Schemers
37 */
38 public class Debug {
39
40 private String prefix;
41
42 private static String args;
43
44 static {
45 args = java.security.AccessController.doPrivileged
46 (new sun.security.action.GetPropertyAction
47 ("java.security.debug"));
48
49 String args2 = java.security.AccessController.doPrivileged
50 (new sun.security.action.GetPropertyAction
51 ("java.security.auth.debug"));
52
53 if (args == null) {
54 args = args2;
55 } else {
56 if (args2 != null)
57 args = args + "," + args2;
58 }
59
60 if (args != null) {
61 args = marshal(args);
62 if (args.equals("help")) {
63 Help();
64 }
65 }
66 }
67
68 public static void Help()
69 {
70 System.err.println();
71 System.err.println("all turn on all debugging");
72 System.err.println("access print all checkPermission results");
73 System.err.println("certpath PKIX CertPathBuilder and");
74 System.err.println(" CertPathValidator debugging");
75 System.err.println("combiner SubjectDomainCombiner debugging");
76 System.err.println("gssloginconfig");
77 System.err.println(" GSS LoginConfigImpl debugging");
78 System.err.println("configfile JAAS ConfigFile loading");
79 System.err.println("configparser JAAS ConfigFile parsing");
80 System.err.println("jar jar verification");
81 System.err.println("logincontext login context results");
82 System.err.println("jca JCA engine class debugging");
83 System.err.println("keystore KeyStore debugging");
84 System.err.println("policy loading and granting");
85 System.err.println("provider security provider debugging");
86 System.err.println("pkcs11 PKCS11 session manager debugging");
87 System.err.println("pkcs11keystore");
88 System.err.println(" PKCS11 KeyStore debugging");
89 System.err.println("pkcs12 PKCS12 KeyStore debugging");
90 System.err.println("sunpkcs11 SunPKCS11 provider debugging");
91 System.err.println("scl permissions SecureClassLoader assigns");
92 System.err.println("securerandom SecureRandom");
93 System.err.println("ts timestamping");
94 System.err.println();
95 System.err.println("The following can be used with access:");
96 System.err.println();
97 System.err.println("stack include stack trace");
98 System.err.println("domain dump all domains in context");
99 System.err.println("failure before throwing exception, dump stack");
100 System.err.println(" and domain that didn't have permission");
101 System.err.println();
102 System.err.println("The following can be used with stack and domain:");
103 System.err.println();
104 System.err.println("permission=<classname>");
105 System.err.println(" only dump output if specified permission");
106 System.err.println(" is being checked");
107 System.err.println("codebase=<URL>");
108 System.err.println(" only dump output if specified codebase");
109 System.err.println(" is being checked");
110 System.err.println();
111 System.err.println("The following can be used with provider:");
112 System.err.println();
113 System.err.println("engine=<engines>");
114 System.err.println(" only dump output for the specified list");
115 System.err.println(" of JCA engines. Supported values:");
116 System.err.println(" Cipher, KeyAgreement, KeyGenerator,");
117 System.err.println(" KeyPairGenerator, KeyStore, Mac,");
118 System.err.println(" MessageDigest, SecureRandom, Signature.");
119 System.err.println();
120 System.err.println("The following can be used with certpath:");
121 System.err.println();
122 System.err.println("ocsp dump the OCSP protocol exchanges");
123 System.err.println();
124 System.err.println("Note: Separate multiple options with a comma");
125 System.exit(0);
126 }
127
128
129 /**
130 * Get a Debug object corresponding to whether or not the given
131 * option is set. Set the prefix to be the same as option.
132 */
133
134 public static Debug getInstance(String option)
135 {
136 return getInstance(option, option);
137 }
138
139 /**
140 * Get a Debug object corresponding to whether or not the given
141 * option is set. Set the prefix to be prefix.
142 */
143 public static Debug getInstance(String option, String prefix)
144 {
145 if (isOn(option)) {
146 Debug d = new Debug();
147 d.prefix = prefix;
148 return d;
149 } else {
150 return null;
151 }
152 }
153
154 /**
155 * True if the system property "security.debug" contains the
156 * string "option".
157 */
158 public static boolean isOn(String option)
159 {
160 if (args == null)
161 return false;
162 else {
163 if (args.indexOf("all") != -1)
164 return true;
165 else
166 return (args.indexOf(option) != -1);
167 }
168 }
169
170 /**
171 * print a message to stderr that is prefixed with the prefix
172 * created from the call to getInstance.
173 */
174
175 public void println(String message)
176 {
177 System.err.println(prefix + ": "+message);
178 }
179
180 /**
181 * print a blank line to stderr that is prefixed with the prefix.
182 */
183
184 public void println()
185 {
186 System.err.println(prefix + ":");
187 }
188
189 /**
190 * print a message to stderr that is prefixed with the prefix.
191 */
192
193 public static void println(String prefix, String message)
194 {
195 System.err.println(prefix + ": "+message);
196 }
197
198 /**
199 * return a hexadecimal printed representation of the specified
200 * BigInteger object. the value is formatted to fit on lines of
201 * at least 75 characters, with embedded newlines. Words are
202 * separated for readability, with eight words (32 bytes) per line.
203 */
204 public static String toHexString(BigInteger b) {
205 String hexValue = b.toString(16);
206 StringBuilder sb = new StringBuilder(hexValue.length()*2);
207
208 if (hexValue.startsWith("-")) {
209 sb.append(" -");
210 hexValue = hexValue.substring(1);
211 } else {
212 sb.append(" "); // four spaces
213 }
214 if ((hexValue.length()%2) != 0) {
215 // add back the leading 0
216 hexValue = "0" + hexValue;
217 }
218 int i=0;
219 while (i < hexValue.length()) {
220 // one byte at a time
221 sb.append(hexValue.substring(i, i + 2));
222 i+=2;
223 if (i!= hexValue.length()) {
224 if ((i%64) == 0) {
225 sb.append("\n "); // line after eight words
226 } else if (i%8 == 0) {
227 sb.append(" "); // space between words
228 }
229 }
230 }
231 return sb.toString();
232 }
233
234 /**
235 * change a string into lower case except permission classes and URLs.
236 */
237 private static String marshal(String args) {
238 if (args != null) {
239 StringBuilder target = new StringBuilder();
240 StringBuffer source = new StringBuffer(args);
241
242 // obtain the "permission=<classname>" options
243 // the syntax of classname: IDENTIFIER.IDENTIFIER
244 // the regular express to match a class name:
245 // "[a-zA-Z_$][a-zA-Z0-9_$]*([.][a-zA-Z_$][a-zA-Z0-9_$]*)*"
246 String keyReg = "[Pp][Ee][Rr][Mm][Ii][Ss][Ss][Ii][Oo][Nn]=";
247 String keyStr = "permission=";
248 String reg = keyReg +
249 "[a-zA-Z_$][a-zA-Z0-9_$]*([.][a-zA-Z_$][a-zA-Z0-9_$]*)*";
250 Pattern pattern = Pattern.compile(reg);
251 Matcher matcher = pattern.matcher(source);
252 StringBuffer left = new StringBuffer();
253 while (matcher.find()) {
254 String matched = matcher.group();
255 target.append(matched.replaceFirst(keyReg, keyStr));
256 target.append(" ");
257
258 // delete the matched sequence
259 matcher.appendReplacement(left, "");
260 }
261 matcher.appendTail(left);
262 source = left;
263
264 // obtain the "codebase=<URL>" options
265 // the syntax of URL is too flexible, and here assumes that the
266 // URL contains no space, comma(','), and semicolon(';'). That
267 // also means those characters also could be used as separator
268 // after codebase option.
269 // However, the assumption is incorrect in some special situation
270 // when the URL contains comma or semicolon
271 keyReg = "[Cc][Oo][Dd][Ee][Bb][Aa][Ss][Ee]=";
272 keyStr = "codebase=";
273 reg = keyReg + "[^, ;]*";
274 pattern = Pattern.compile(reg);
275 matcher = pattern.matcher(source);
276 left = new StringBuffer();
277 while (matcher.find()) {
278 String matched = matcher.group();
279 target.append(matched.replaceFirst(keyReg, keyStr));
280 target.append(" ");
281
282 // delete the matched sequence
283 matcher.appendReplacement(left, "");
284 }
285 matcher.appendTail(left);
286 source = left;
287
288 // convert the rest to lower-case characters
289 target.append(source.toString().toLowerCase(Locale.ENGLISH));
290
291 return target.toString();
292 }
293
294 return null;
295 }
296
297 private static final char[] hexDigits = "0123456789abcdef".toCharArray();
298
299 public static String toString(byte[] b) {
300 if (b == null) {
301 return "(null)";
302 }
303 StringBuilder sb = new StringBuilder(b.length * 3);
304 for (int i = 0; i < b.length; i++) {
305 int k = b[i] & 0xff;
306 if (i != 0) {
307 sb.append(':');
308 }
309 sb.append(hexDigits[k >>> 4]);
310 sb.append(hexDigits[k & 0xf]);
311 }
312 return sb.toString();
313 }
314
315 }