SocketPermission.java 17.3 KB
Newer Older
Tom Tromey committed
1
/* SocketPermission.java -- Class modeling permissions for socket operations
2 3
   Copyright (C) 1998, 2000, 2001, 2002, 2004, 2006 Free Software
   Foundation, Inc.
Tom Tromey committed
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

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package java.net;

41 42
import gnu.java.lang.CPStringBuilder;

43 44 45
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
Tom Tromey committed
46 47 48
import java.io.Serializable;
import java.security.Permission;
import java.security.PermissionCollection;
49
import java.util.StringTokenizer;
Tom Tromey committed
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


/**
 * This class models a specific set of permssions for connecting to a
 * host.  There are two elements to this, the host/port combination and
 * the permission list.
 * <p>
 * The host/port combination is specified as followed
 * <p>
 * <pre>
 * hostname[:[-]port[-[port]]]
 * </pre>
 * <p>
 * The hostname portion can be either a hostname or IP address.  If it is
 * a hostname, a wildcard is allowed in hostnames.  This wildcard is a "*"
 * and matches one or more characters.  Only one "*" may appear in the
 * host and it must be the leftmost character.  For example,
 * "*.urbanophile.com" matches all hosts in the "urbanophile.com" domain.
 * <p>
 * The port portion can be either a single value, or a range of values
 * treated as inclusive.  The first or the last port value in the range
 * can be omitted in which case either the minimum or maximum legal
 * value for a port (respectively) is used by default.  Here are some
 * examples:
 * <p><ul>
 * <li>8080 - Represents port 8080 only</li>
 * <li>2000-3000 - Represents ports 2000 through 3000 inclusive</li>
 * <li>-4000 - Represents ports 0 through 4000 inclusive</li>
 * <li>1024- - Represents ports 1024 through 65535 inclusive</li>
 * </ul><p>
 * The permission list is a comma separated list of individual permissions.
 * These individual permissions are:
 * <p>
 * <pre>
 * accept
 * connect
 * listen
 * resolve
 * </pre>
 * <p>
 * The "listen" permission is only relevant if the host is localhost.  If
 * any permission at all is specified, then resolve permission is implied to
 * exist.
 * <p>
 * Here are a variety of examples of how to create SocketPermission's
 * <p><pre>
 * SocketPermission("www.urbanophile.com", "connect");
 *   Can connect to any port on www.urbanophile.com
 * SocketPermission("www.urbanophile.com:80", "connect,accept");
 *   Can connect to or accept connections from www.urbanophile.com on port 80
 * SocketPermission("localhost:1024-", "listen,accept,connect");
 *   Can connect to, accept from, an listen on any local port number 1024
 *   and up.
 * SocketPermission("*.edu", "connect");
 *   Can connect to any host in the edu domain
 * SocketPermission("197.197.20.1", "accept");
 *   Can accept connections from 197.197.20.1
 * </pre><p>
 *
 * This class also supports IPv6 addresses.  These should be specified
 * in either RFC 2732 format or in full uncompressed form.
 *
 * @since 1.2
 *
114 115
 * @author Written by Aaron M. Renn (arenn@urbanophile.com)
 * @author Extensively modified by Gary Benson (gbenson@redhat.com)
Tom Tromey committed
116 117 118 119 120
 */
public final class SocketPermission extends Permission implements Serializable
{
  static final long serialVersionUID = -7204263841984476862L;

121
  /**
122 123
   * A hostname (possibly wildcarded).  Will be set if and only if
   * this object was initialized with a hostname.
124
   */
125
  private transient String hostname = null;
Tom Tromey committed
126 127

  /**
128 129 130 131 132 133
   * An IP address (IPv4 or IPv6).  Will be set if and only if this
   * object was initialized with a single literal IP address.
   */  
  private transient InetAddress address = null;
  
  /**
134
   * A range of ports.
Tom Tromey committed
135
   */
136 137
  private transient int minport;
  private transient int maxport;
Tom Tromey committed
138 139

  /**
140 141 142 143 144 145 146 147 148 149 150 151 152
   * Values used for minimum and maximum ports when one or both bounds
   * are omitted.  This class is essentially independent of the
   * networking code it describes, so we do not limit ports to the
   * usual network limits of 1 and 65535.
   */
  private static final int MIN_PORT = 0;
  private static final int MAX_PORT = Integer.MAX_VALUE;

  /**
   * The actions for which we have permission.  This field is present
   * to make the serialized form correct and should not be used by
   * anything other than writeObject: everything else should use
   * actionmask.
Tom Tromey committed
153 154 155 156
   */
  private String actions;

  /**
157 158 159 160 161 162 163 164 165 166 167
   * A bitmask representing the actions for which we have permission.
   */
  private transient int actionmask;

  /**
   * The available actions, in the canonical order required for getActions().
   */
  private static final String[] ACTIONS = new String[] {
    "connect", "listen", "accept", "resolve"};

  /**
Tom Tromey committed
168 169 170 171 172 173 174 175
   * Initializes a new instance of <code>SocketPermission</code> with the
   * specified host/port combination and actions string.
   *
   * @param hostport The hostname/port number combination
   * @param actions The actions string
   */
  public SocketPermission(String hostport, String actions)
  {
176
    super(processHostport(hostport));
Tom Tromey committed
177

178
    setHostPort(getName());
179 180 181 182
    setActions(actions);
  }

  /**
183 184 185 186 187 188
   * There are two cases in which hostport needs rewriting before
   * being passed to the superclass constructor.  If hostport is an
   * empty string then it is substituted with "localhost".  And if
   * the host part of hostport is a literal IPv6 address in the full
   * uncompressed form not enclosed with "[" and "]" then we enclose
   * it with them.
189
   */
190
  private static String processHostport(String hostport)
191
  {
192 193 194 195
    if (hostport.length() == 0)
      return "localhost";

    if (hostport.charAt(0) == '[')
196 197
      return hostport;

198 199
    int colons = 0;
    boolean colon_allowed = true;
200 201 202 203
    for (int i = 0; i < hostport.length(); i++)
      {
	if (hostport.charAt(i) == ':')
	  {
204
	    if (!colon_allowed)
205 206
	      throw new IllegalArgumentException("Ambiguous hostport part");
	    colons++;
207
	    colon_allowed = false;
208
	  }
209 210
	else
	  colon_allowed = true;
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
      }

    switch (colons)
      {
      case 0:
      case 1:
	// a hostname or IPv4 address
	return hostport;
	
      case 7:
	// an IPv6 address with no ports
	return "[" + hostport + "]";

      case 8:
	// an IPv6 address with ports
226
	int last_colon = hostport.lastIndexOf(':');
227 228 229 230 231 232 233 234 235
	return "[" + hostport.substring(0, last_colon) + "]"
	  + hostport.substring(last_colon);

      default:
	throw new IllegalArgumentException("Ambiguous hostport part");
      }
  }
  
  /**
236 237 238 239 240
   * Parse the hostport argument to the constructor.
   */
  private void setHostPort(String hostport)
  {
    // Split into host and ports
241
    String host, ports;
242
    if (hostport.charAt(0) == '[')
243 244 245 246 247 248 249
      {
	// host is a bracketed IPv6 address
	int end = hostport.indexOf("]");
	if (end == -1)
	  throw new IllegalArgumentException("Unmatched '['");
	host = hostport.substring(1, end);

250 251 252 253
	address = InetAddress.getByLiteral(host);
	if (address == null)
	  throw new IllegalArgumentException("Bad IPv6 address");

254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
	if (end == hostport.length() - 1)
	  ports = "";
	else if (hostport.charAt(end + 1) == ':')
	  ports = hostport.substring(end + 2);
	else
	  throw new IllegalArgumentException("Bad character after ']'");
      }
    else
      {
	// host is a hostname or IPv4 address
	int sep = hostport.indexOf(":");
	if (sep == -1)
	  {
	    host = hostport;
	    ports = "";
	  }
	else
	  {
	    host = hostport.substring(0, sep);
	    ports = hostport.substring(sep + 1);
	  }
275 276 277 278 279 280 281 282 283

	address = InetAddress.getByLiteral(host);
	if (address == null)
	  {
	    if (host.lastIndexOf('*') > 0)
	      throw new IllegalArgumentException("Bad hostname");

	    hostname = host;
	  }
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
      }

    // Parse and validate the ports
    if (ports.length() == 0)
      {
	minport = MIN_PORT;
	maxport = MAX_PORT;
      }
    else
      {
	int sep = ports.indexOf("-");
	if (sep == -1)
	  {
	    // a single port
	    minport = maxport = Integer.parseInt(ports);
	  }
	else
	  {
	    if (ports.indexOf("-", sep + 1) != -1)
	      throw new IllegalArgumentException("Unexpected '-'");

	    if (sep == 0)
	      {
		// an upper bound
		minport = MIN_PORT;
		maxport = Integer.parseInt(ports.substring(1));
	      }
	    else if (sep == ports.length() - 1)
	      {
		// a lower bound
		minport =
		  Integer.parseInt(ports.substring(0, ports.length() - 1));
		maxport = MAX_PORT;
	      }
	    else
	      {
		// a range with two bounds
		minport = Integer.parseInt(ports.substring(0, sep));
		maxport = Integer.parseInt(ports.substring(sep + 1));
	      }
	  }
      }
  }
  
  /**
   * Parse the actions argument to the constructor.
   */
  private void setActions(String actionstring)
  {
    actionmask = 0;

    boolean resolve_needed = false;
    boolean resolve_present = false;
    
    StringTokenizer t = new StringTokenizer(actionstring, ",");
    while (t.hasMoreTokens())
      {
	String action = t.nextToken();
	action = action.trim().toLowerCase();
	setAction(action);

	if (action.equals("resolve"))
	  resolve_present = true;
	else
	  resolve_needed = true;
      }

    if (resolve_needed && !resolve_present)
      setAction("resolve");
  }

  /**
   * Parse one element of the actions argument to the constructor.
   */
  private void setAction(String action)
  {
    for (int i = 0; i < ACTIONS.length; i++)
      {
	if (action.equals(ACTIONS[i]))
	  {
	    actionmask |= 1 << i;
	    return;
	  }
      }
    throw new IllegalArgumentException("Unknown action " + action);
Tom Tromey committed
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
  }

  /**
   * Tests this object for equality against another.  This will be true if
   * and only if the passed object is an instance of
   * <code>SocketPermission</code> and both its hostname/port combination
   * and permissions string are identical.
   *
   * @param obj The object to test against for equality
   *
   * @return <code>true</code> if object is equal to this object,
   *         <code>false</code> otherwise.
   */
  public boolean equals(Object obj)
  {
384
    SocketPermission p;
Tom Tromey committed
385

386 387 388 389
    if (obj instanceof SocketPermission)
      p = (SocketPermission) obj;
    else
      return false;
Tom Tromey committed
390

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
    if (p.actionmask != actionmask ||
	p.minport != minport ||
	p.maxport != maxport)
      return false;

    if (address != null)
      {
	if (p.address == null)
	  return false;
	else
	  return p.address.equals(address);
      }
    else
      {
	if (p.hostname == null)
	  return false;
	else
	  return p.hostname.equals(hostname);
      }
Tom Tromey committed
410 411 412 413 414 415 416 417 418 419
  }

  /**
   * Returns a hash code value for this object.  Overrides the
   * <code>Permission.hashCode()</code>.
   *
   * @return A hash code
   */
  public int hashCode()
  {
420 421 422 423 424 425
    int code = actionmask + minport + maxport;
    if (address != null)
      code += address.hashCode();
    else
      code += hostname.hashCode();
    return code;
Tom Tromey committed
426 427 428 429 430 431 432 433 434 435
  }

  /**
   * Returns the list of permission actions in this object in canonical
   * order.  The canonical order is "connect,listen,accept,resolve"
   *
   * @return The permitted action string.
   */
  public String getActions()
  {
436
    CPStringBuilder sb = new CPStringBuilder("");
Tom Tromey committed
437

438
    for (int i = 0; i < ACTIONS.length; i++)
Tom Tromey committed
439
      {
440 441 442 443 444 445
	if ((actionmask & (1 << i)) != 0)
	  {
	    if (sb.length() != 0)
	      sb.append(",");
	    sb.append(ACTIONS[i]);
	  }
Tom Tromey committed
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
      }

    return sb.toString();
  }

  /**
   * Returns a new <code>PermissionCollection</code> object that can hold
   * <code>SocketPermission</code>'s.
   *
   * @return A new <code>PermissionCollection</code>.
   */
  public PermissionCollection newPermissionCollection()
  {
    // FIXME: Implement

    return null;
  }

  /**
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
   * Returns an array of all IP addresses represented by this object.
   */
  private InetAddress[] getAddresses()
  {
    if (address != null)
      return new InetAddress[] {address};

    try
      {
	return InetAddress.getAllByName(hostname);
      }
    catch (UnknownHostException e)
      {
	return new InetAddress[0];
      }
  }

  /**
   * Returns the canonical hostname represented by this object,
   * or null if this object represents a wildcarded domain.
   */
  private String getCanonicalHostName()
  {
    if (address != null)
      return address.internalGetCanonicalHostName();
    if (hostname.charAt(0) == '*')
      return null;
    try
      {
	return InetAddress.getByName(hostname).internalGetCanonicalHostName();
      }
    catch (UnknownHostException e)
      {
	return null;
      }
  }
  
  /**
Tom Tromey committed
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
   * Returns true if the permission object passed it is implied by the
   * this permission.  This will be true if:
   * 
   * <ul>
   * <li>The argument is of type <code>SocketPermission</code></li>
   * <li>The actions list of the argument are in this object's actions</li>
   * <li>The port range of the argument is within this objects port range</li>
   * <li>The hostname is equal to or a subset of this objects hostname</li>
   * </ul>
   *
   * <p>The argument's hostname will be a subset of this object's hostname if:</p>
   * 
   * <ul>
   * <li>The argument's hostname or IP address is equal to this object's.</li>
   * <li>The argument's canonical hostname is equal to this object's.</li>
   * <li>The argument's canonical name matches this domains hostname with
   * wildcards</li>
   * </ul>
   *
   * @param perm The <code>Permission</code> to check against
   *
   * @return <code>true</code> if the <code>Permission</code> is implied by
   * this object, <code>false</code> otherwise.
   */
  public boolean implies(Permission perm)
  {
    SocketPermission p;

    // First make sure we are the right object type
    if (perm instanceof SocketPermission)
      p = (SocketPermission) perm;
    else
      return false;

537 538 539 540 541
    // If p was initialised with an empty hostname then we do not
    // imply it. This is not part of the spec, but it seems necessary.
    if (p.hostname != null && p.hostname.length() == 0)
      return false;
    
Tom Tromey committed
542
    // Next check the actions
543 544
    if ((p.actionmask & actionmask) != p.actionmask)
	return false;
Tom Tromey committed
545

546 547
    // Then check the ports
    if ((p.minport < minport) || (p.maxport > maxport))
Tom Tromey committed
548 549
      return false;

550
    // Finally check the hosts
551
    String p_canon = null;
Tom Tromey committed
552

553 554 555
    // Return true if this object was initialized with a single
    // IP address which one of p's IP addresses is equal to.
    if (address != null)
Tom Tromey committed
556
      {
557 558 559 560 561 562
	InetAddress[] addrs = p.getAddresses();
	for (int i = 0; i < addrs.length; i++)
	  {
	    if (address.equals(addrs[i]))
	      return true;
	  }
Tom Tromey committed
563
      }
564 565 566 567

    // Return true if this object is a wildcarded domain that
    // p's canonical name matches.
    if (hostname != null && hostname.charAt(0) == '*')
Tom Tromey committed
568
      {
569 570 571 572
	p_canon = p.getCanonicalHostName();
	if (p_canon != null && p_canon.endsWith(hostname.substring(1)))
	  return true;
	
Tom Tromey committed
573 574
      }

575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
    // Return true if this one of this object's IP addresses
    // is equal to one of p's.
    if (address == null)
      {
	InetAddress[] addrs = p.getAddresses();
	InetAddress[] p_addrs = p.getAddresses();

	for (int i = 0; i < addrs.length; i++)
	  {
	    for (int j = 0; j < p_addrs.length; j++)
	      {
		if (addrs[i].equals(p_addrs[j]))
		  return true;
	      }
	  }
      }
Tom Tromey committed
591

592 593 594
    // Return true if this object's canonical name equals p's.
    String canon = getCanonicalHostName();
    if (canon != null)
Tom Tromey committed
595
      {
596 597 598
	if (p_canon == null)
	  p_canon = p.getCanonicalHostName();
	if (p_canon != null && canon.equals(p_canon))
Tom Tromey committed
599 600 601 602 603 604
	  return true;
      }

    // Didn't make it
    return false;
  }
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635

  /**
   * Deserializes a <code>SocketPermission</code> object from
   * an input stream.
   *
   * @param input the input stream.
   * @throws IOException if an I/O error occurs in the stream.
   * @throws ClassNotFoundException if the class of the
   *         serialized object could not be found.
   */
  private void readObject(ObjectInputStream input)
    throws IOException, ClassNotFoundException
  {
    input.defaultReadObject();
    setHostPort(getName());
    setActions(actions);
  }

  /**
   * Serializes a <code>SocketPermission</code> object to an
   * output stream.
   *
   * @param output the output stream.
   * @throws IOException if an I/O error occurs in the stream.
   */
  private void writeObject(ObjectOutputStream output)
    throws IOException
  {
    actions = getActions();
    output.defaultWriteObject();
  }
Tom Tromey committed
636
}