Top Description Fields Constructors Methods
org.eclipse.jetty.util.security

public Class Password

extends Credential
Class Inheritance
Imports
java.io.BufferedReader, .IOException, .InputStreamReader, java.nio.charset.StandardCharsets, java.util.Locale, org.eclipse.jetty.util.StringUtil
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.eclipse.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 Crypt can be generated by running org.eclipse.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.

Field Summary

Modifier and TypeField and Description
public static final String
__OBFUSCATE

private String
_pw

private static final long
serialVersionUID

Hides org.eclipse.jetty.util.security.Credential.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
Password(String
The String password.
password)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public boolean
check(Object
The credential to check against. This may either be another Credential object, a Password object or a String which is interpreted by this credential.
credentials)

Implements abstract org.eclipse.jetty.util.security.Credential.check.

Check a credential
public static String
deobfuscate(String s)

public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public static Password

Returns:

Password
getPassword(String
The realm name for the password, used as a SystemProperty name.
realm, String
The default password.
dft, String
The default to use if prompting for the password.
promptDft)

Get a password.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public static void
main(String[] args)

public static String
obfuscate(String s)

public String
toStarString()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from org.eclipse.jetty.util.security.Credential:
byteEqualsgetCredentialstringEquals

Field Detail

__OBFUSCATEback to summary
public static final String __OBFUSCATE
_pwback to summary
private String _pw
serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.eclipse.jetty.util.security.Credential.serialVersionUID.

Constructor Detail

Passwordback to summary
public Password(String password)

Constructor.

Parameters
password:String

The String password.

Method Detail

checkback to summary
public boolean check(Object credentials)

Implements abstract org.eclipse.jetty.util.security.Credential.check.

Doc from org.eclipse.jetty.util.security.Credential.check.

Check a credential

Parameters
credentials:Object

The credential to check against. This may either be another Credential object, a Password object or a String which is interpreted by this credential.

Returns:boolean

True if the credentials indicated that the shared secret is known to both this Credential and the passed credential.

Annotations
@Override
deobfuscateback to summary
public static String deobfuscate(String s)
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getPasswordback to summary
public static Password getPassword(String realm, String dft, 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.
Parameters
realm:String

The realm name for the password, used as a SystemProperty name.

dft:String

The default password.

promptDft:String

The default to use if prompting for the password.

Returns:Password

Password

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
mainback to summary
public static void main(String[] args) throws IOException
obfuscateback to summary
public static String obfuscate(String s)
toStarStringback to summary
public String toStarString()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override