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 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
/* * @(#)GSSException.java 1.12 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package org.ietf.jgss; /** * This exception is thrown whenever a GSS-API error occurs, including * any mechanism specific error. It may contain both the major and the * minor GSS-API status codes. Major error codes are those defined at the * GSS-API level in this class. Minor error codes are mechanism specific * error codes that can provide additional information. The underlying * mechanism implementation is responsible for setting appropriate minor * status codes when throwing this exception. Aside from delivering the * numeric error codes to the caller, this class performs the mapping from * their numeric values to textual representations. <p> * * @author Mayank Upadhyay * @version 1.12, 11/17/05 * @since 1.4 */ public class GSSException extends Exception { private static final long serialVersionUID = -2706218945227726672L; /** * Channel bindings mismatch. */ public static final int BAD_BINDINGS = 1; //start with 1 /** * Unsupported mechanism requested. */ public static final int BAD_MECH = 2; /** * Invalid name provided. */ public static final int BAD_NAME = 3; /** * Name of unsupported type provided. */ public static final int BAD_NAMETYPE = 4; /** * Invalid status code. */ /* * This is meant to be thrown by display_status which displays * major/minor status when an incorrect status type is passed in to it! */ public static final int BAD_STATUS = 5; /** * Token had invalid integrity check. */ public static final int BAD_MIC = 6; /** * Security context expired. */ public static final int CONTEXT_EXPIRED = 7; /** * Expired credentials. */ public static final int CREDENTIALS_EXPIRED = 8; /** * Defective credentials. * */ public static final int DEFECTIVE_CREDENTIAL = 9; /** * Defective token. * */ public static final int DEFECTIVE_TOKEN = 10; /** * General failure, unspecified at GSS-API level. */ public static final int FAILURE = 11; /** * Invalid security context. */ public static final int NO_CONTEXT = 12; /** * Invalid credentials. */ public static final int NO_CRED = 13; /** * Unsupported QOP value. */ public static final int BAD_QOP = 14; /** * Operation unauthorized. */ public static final int UNAUTHORIZED = 15; /** * Operation unavailable. */ public static final int UNAVAILABLE = 16; /** * Duplicate credential element requested. */ public static final int DUPLICATE_ELEMENT = 17; /** * Name contains multi-mechanism elements. */ public static final int NAME_NOT_MN = 18; /** * The token was a duplicate of an earlier token. * This is a fatal error code that may occur during * context establishment. It is not used to indicate * supplementary status values. The MessageProp object is * used for that purpose. */ public static final int DUPLICATE_TOKEN = 19; /** * The token's validity period has expired. This is a * fatal error code that may occur during context establishment. * It is not used to indicate supplementary status values. * The MessageProp object is used for that purpose. */ public static final int OLD_TOKEN = 20; /** * A later token has already been processed. This is a * fatal error code that may occur during context establishment. * It is not used to indicate supplementary status values. * The MessageProp object is used for that purpose. */ public static final int UNSEQ_TOKEN = 21; /** * An expected per-message token was not received. This is a * fatal error code that may occur during context establishment. * It is not used to indicate supplementary status values. * The MessageProp object is used for that purpose. */ public static final int GAP_TOKEN = 22; private static String[] messages = { "Channel binding mismatch", // BAD_BINDINGS "Unsupported mechanism requested", // BAD_MECH "Invalid name provided", // BAD_NAME "Name of unsupported type provided", //BAD_NAMETYPE "Invalid input status selector", // BAD_STATUS "Token had invalid integrity check", // BAD_SIG "Specified security context expired", // CONTEXT_EXPIRED "Expired credentials detected", // CREDENTIALS_EXPIRED "Defective credential detected", // DEFECTIVE_CREDENTIAL "Defective token detected", // DEFECTIVE_TOKEN "Failure unspecified at GSS-API level", // FAILURE "Security context init/accept not yet called or context deleted", // NO_CONTEXT "No valid credentials provided", // NO_CRED "Unsupported QOP value", // BAD_QOP "Operation unauthorized", // UNAUTHORIZED "Operation unavailable", // UNAVAILABLE "Duplicate credential element requested", //DUPLICATE_ELEMENT "Name contains multi-mechanism elements", // NAME_NOT_MN "The token was a duplicate of an earlier token", //DUPLICATE_TOKEN "The token's validity period has expired", //OLD_TOKEN "A later token has already been processed", //UNSEQ_TOKEN "An expected per-message token was not received", //GAP_TOKEN }; /** * The major code for this exception * * @serial */ private int major; /** * The minor code for this exception * * @serial */ private int minor = 0; /** * The text string for minor code * * @serial */ private String minorMessage = null; /** * Alternate text string for major code * * @serial */ private String majorString = null; /** * Creates a GSSException object with a specified major code. * * @param majorCode the The GSS error code for the problem causing this * exception to be thrown. */ public GSSException (int majorCode) { if (validateMajor(majorCode)) major = majorCode; else major = FAILURE; } /** * Construct a GSSException object with a specified major code and a * specific major string for it. * * @param majorCode the fatal error code causing this exception. * @param majorString an expicit message to be included in this exception */ GSSException (int majorCode, String majorString) { if (validateMajor(majorCode)) major = majorCode; else major = FAILURE; this.majorString = majorString; } /** * Creates a GSSException object with the specified major code, minor * code, and minor code textual explanation. This constructor is to be * used when the exception is originating from the underlying mechanism * level. It allows the setting of both the GSS code and the mechanism * code. * * @param majorCode the GSS error code for the problem causing this * exception to be thrown. * @param minorCode the mechanism level error code for the problem * causing this exception to be thrown. * @param minorString the textual explanation of the mechanism error * code. */ public GSSException (int majorCode, int minorCode, String minorString) { if (validateMajor(majorCode)) major = majorCode; else major = FAILURE; minor = minorCode; minorMessage = minorString; } /** * Returns the GSS-API level major error code for the problem causing * this exception to be thrown. Major error codes are * defined at the mechanism independent GSS-API level in this * class. Mechanism specific error codes that might provide more * information aer set as the minor error code. * * @return int the GSS-API level major error code causing this exception * @see #getMajorString * @see #getMinor * @see #getMinorString */ public int getMajor() { return major; } /** * Returns the mechanism level error code for the problem causing this * exception to be thrown. The minor code is set by the underlying * mechanism. * * @return int the mechanism error code; 0 indicates that it has not * been set. * @see #getMinorString * @see #setMinor */ public int getMinor(){ return minor; } /** * Returns a string explaining the GSS-API level major error code in * this exception. * * @return String explanation string for the major error code * @see #getMajor * @see #toString */ public String getMajorString() { if (majorString != null) return majorString; else return messages[major - 1]; } /** * Returns a string explaining the mechanism specific error code. * If the minor status code is 0, then no mechanism level error details * will be available. * * @return String a textual explanation of mechanism error code * @see #getMinor * @see #getMajorString * @see #toString */ public String getMinorString() { return minorMessage; } /** * Used by the exception thrower to set the mechanism * level minor error code and its string explanation. This is used by * mechanism providers to indicate error details. * * @param minorCode the mechanism specific error code * @param message textual explanation of the mechanism error code * @see #getMinor */ public void setMinor(int minorCode, String message) { minor = minorCode; minorMessage = message; } /** * Returns a textual representation of both the major and the minor * status codes. * * @return a String with the error descriptions */ public String toString() { return ("GSSException: " + getMessage()); } /** * Returns a textual representation of both the major and the minor * status codes. * * @return a String with the error descriptions */ public String getMessage() { if (minor == 0) return (getMajorString()); return (getMajorString() + " (Mechanism level: " + getMinorString() + ")"); } /* * Validates the major code in the proper range. */ private boolean validateMajor(int major) { if (major > 0 && major <= messages.length) return (true); return (false); } }