Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.mortbay.util
Class Password  view Password download Password.java

java.lang.Object
  extended byorg.mortbay.util.Credential
      extended byorg.mortbay.util.Password

public class Password
extends Credential

Password utility class. This utility class gets a password or pass phrase either by:

  + Password is set as a system property.
  + The password is prompted for and read from standard input
  + A program is run to get the password.
 
Passwords that begin with OBF: are de obfuscated. Passwords can be obfuscated by run org.mortbay.util.Password as a main class. Obfuscated password are required if a system needs to recover the full password (eg. so that it may be passed to another system). They are not secure, but prevent casual observation.

Passwords that begin with CRYPT: are oneway encrypted with UnixCrypt. The real password cannot be retrieved, but comparisons can be made to other passwords. A Crype can be generated by running org.mortbay.util.UnixCrypt as a main class, passing password and then the username. Checksum passwords are a secure(ish) way to store passwords that only need to be checked rather than recovered. Note that it is not strong security - specially if simple passwords are used.

Version:
$Id: Password.java,v 1.10 2003/09/18 13:29:27 gregwilkins Exp $

Nested Class Summary
 
Nested classes inherited from class org.mortbay.util.Credential
Credential.Crypt, Credential.MD5
 
Field Summary
private  java.lang.String _pw
           
private static org.apache.commons.logging.Log log
           
 
Constructor Summary
Password(java.lang.String password)
          Constructor.
 
Method Summary
 boolean check(java.lang.Object credentials)
          Check a credential
static java.lang.String deobfuscate(java.lang.String s)
           
 boolean equals(java.lang.Object o)
          Determine whether this Object is semantically equal to another Object.
static Password getPassword(java.lang.String realm, java.lang.String dft, java.lang.String promptDft)
          Get a password.
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
static void main(java.lang.String[] arg)
           
static java.lang.String obfuscate(java.lang.String s)
           
 java.lang.String toStarString()
           
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class org.mortbay.util.Credential
getCredential
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

log

private static org.apache.commons.logging.Log log

_pw

private java.lang.String _pw
Constructor Detail

Password

public Password(java.lang.String password)
Constructor.

Method Detail

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).


toStarString

public java.lang.String toStarString()

check

public boolean check(java.lang.Object credentials)
Description copied from class: Credential
Check a credential

Specified by:
check in class Credential

equals

public boolean equals(java.lang.Object o)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.


hashCode

public int hashCode()
Description copied from class: java.lang.Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)


obfuscate

public static java.lang.String obfuscate(java.lang.String s)

deobfuscate

public static java.lang.String deobfuscate(java.lang.String s)

getPassword

public static Password getPassword(java.lang.String realm,
                                   java.lang.String dft,
                                   java.lang.String promptDft)
Get a password. A password is obtained by trying
  • Calling System.getProperty(realm,dft)
  • Prompting for a password
  • Using promptDft if nothing was entered.


main

public static void main(java.lang.String[] arg)