org.das2.util.filesystem

Class KeyChain

java.lang.Object

org.das2.util.filesystem.KeyChain

public class KeyChain
extends java.lang.Object

class that contains the credentials for websites. This is first introduced so that ftp://papco:@mrfrench.lanl.gov/ and subdirectories would just ask for credentials once. Also, this allows all the sensitive information to be stored in one class. https://datatracker.ietf.org/doc/html/rfc7617 talks about how this should be done. Presently this is done by URL and not the realm. TODO: This needs to be redone so that the keys are stored by realm as well, and once a directory is left a 401 and resending of the realm will be needed before the key is sent again.

See Also:

https://datatracker.ietf.org/doc/html/rfc7617

Constructor Summary

Constructors

Constructor and Description
KeyChain()

Method Summary

Modifier and Type	Method and Description
void	addCookie(java.lang.String url, java.lang.String cookie) Add a cookie for the URL.
java.lang.String	checkUserInfo(java.net.URL url) return null or the stored user info.
void	clearAll() clear all passwords.
void	clearUserPassword(java.net.URI uri)
void	clearUserPassword(java.net.URL url) remove the password from the list of known passwords.
protected java.lang.String	getCookie(java.net.URL url) Some servers want cookies to handle the authentication.
static KeyChain	getDefault() get the single instance of the class.
static KeyChain	getInstance(java.lang.String name) get the instance for this name.
java.lang.String	getUserInfo(java.net.URI uri) get the user credentials, maybe throwing CancelledOperationException if the user hits cancel.
java.lang.String	getUserInfo(java.net.URL url) return the user info (username:password) associated with this URL.
java.lang.String	getUserInfo(java.net.URL url, java.lang.String userInfo) get the user credentials, maybe throwing CancelledOperationException if the user hits cancel.
java.lang.String	getUserInfoBase64Encoded(java.net.URL url) return the user info but base-64 encoded.
java.lang.String	getWWWAuthenticate(java.net.URL url) return null or the WWW-Authenticate string.
java.lang.String	hideUserInfo(java.net.URI root)
static void	main(java.lang.String[] args)
java.net.URI	resolveUserInfo(java.net.URI root) plug the username and password into the URI.
void	setParentGUI(java.awt.Component c)
void	setUserInfo(java.net.URL url, java.lang.String userInfo) insert the userInfo into the table of stored passwords.
void	writeKeysFile() dump the loaded keys into the file new File( FileSystem.settings().getLocalCacheDir(), "keychain.txt" )
void	writeKeysFile(boolean toFile) format the keys file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyChain

public KeyChain()

Method Detail

getDefault

public static KeyChain getDefault()

get the single instance of the class.

Returns:

the single instance of the class.

getInstance

public static KeyChain getInstance(java.lang.String name)

get the instance for this name. This is added to support future applications, such as servlets, where multiple users are using the same process.

Parameters:

name -

Returns:

writeKeysFile

public void writeKeysFile()

dump the loaded keys into the file new File( FileSystem.settings().getLocalCacheDir(), "keychain.txt" )

writeKeysFile

public void writeKeysFile(boolean toFile)
                   throws java.io.IOException

format the keys file. Since Java 5 didn't have a way to restrict access to the file, this would simply display the keychain file contents and have the operator write the keychain file to disk. The required Java7 is able to restict access to the file properly.

Parameters:

toFile - the file should be created.

Throws:

java.io.IOException

See Also:

appendKeysFile(java.lang.String, java.lang.String)

getUserInfo

public java.lang.String getUserInfo(java.net.URI uri)
                             throws CancelledOperationException

get the user credentials, maybe throwing CancelledOperationException if the user hits cancel.

Parameters:

uri -

Returns:

Throws:

CancelledOperationException

See Also:

getUserInfo(java.net.URL)

getUserInfo

public java.lang.String getUserInfo(java.net.URL url)
                             throws CancelledOperationException

return the user info (username:password) associated with this URL. Note if there is no user info in the URI, this will return null!

Parameters:

url - the URL

Returns:

null or the user info.

Throws:

CancelledOperationException

See Also:

which will always check and prompt.

checkUserInfo

public java.lang.String checkUserInfo(java.net.URL url)

return null or the stored user info. This allows clients to attempt to use stored user info without bothering the scientist if the info isn't needed.

Parameters:

url - the URL

Returns:

the user info (user:password) associated, or null if the user info isn't found.

setUserInfo

public void setUserInfo(java.net.URL url,
                        java.lang.String userInfo)

insert the userInfo into the table of stored passwords. TODO: note the path is not used in the hash, and it should be.

Parameters:

url -

userInfo -

getUserInfoBase64Encoded

public java.lang.String getUserInfoBase64Encoded(java.net.URL url)
                                          throws CancelledOperationException

return the user info but base-64 encoded. This is put in so that a future version of the software can cache these as well. This is intended to be inserted like so: connection= theUrl.getConnection(); String encode= KeyChain.getDefault().getUserInfoBase64Encoded( theUrl ); if ( encode!=null ) connection.setRequestProperty("Authorization", "Basic " + encode);

Parameters:

url - the URL which may contain user info.

Returns:

the base-64 encoded credentials.

Throws:

CancelledOperationException

setParentGUI

public void setParentGUI(java.awt.Component c)

getWWWAuthenticate

public java.lang.String getWWWAuthenticate(java.net.URL url)

return null or the WWW-Authenticate string. Note this is not correctly implemented, as two URLs with the same realm from the same host and scheme will use the same password.

Parameters:

url -

Returns:

getUserInfo

public java.lang.String getUserInfo(java.net.URL url,
                                    java.lang.String userInfo)
                             throws CancelledOperationException

get the user credentials, maybe throwing CancelledOperationException if the user hits cancel. If the password is "pass" or "password" then don't use it, prompt for it instead. The userInfo passed in can contain just "user" or the user account to log in with, then maybe a colon and "pass" or the password. So examples include:

• null, where null is returned and credentials are presumed to not be needed.
• user, where both the username and password are needed.
• user:pass where both are needed
• joe:pass there the user joe is presumed and pass is needed
• joe:JoPass1 where both the user and password are already specified, and this is returned.

Note a %40 in the username is converted to @.

Parameters:

url -

userInfo - that is available separately. (Java doesn't like user@usersHost:password@server)

Returns:

the userinfo, like "us3r:passw0rd"

Throws:

CancelledOperationException

See Also:

https://sourceforge.net/p/autoplot/bugs/1652/

clearAll

public void clearAll()

clear all passwords.

clearUserPassword

public void clearUserPassword(java.net.URI uri)

clearUserPassword

public void clearUserPassword(java.net.URL url)

remove the password from the list of known passwords. This was introduced because we needed to clear a bad password in FTP.

Parameters:

url -

resolveUserInfo

public java.net.URI resolveUserInfo(java.net.URI root)
                             throws CancelledOperationException

plug the username and password into the URI.

Parameters:

root - the URI, possibly needing a username and password.

Returns:

the URI with the username and password.

Throws:

CancelledOperationException

hideUserInfo

public java.lang.String hideUserInfo(java.net.URI root)

main

public static void main(java.lang.String[] args)
                 throws java.net.MalformedURLException,
                        CancelledOperationException

Throws:

java.net.MalformedURLException

CancelledOperationException

addCookie

public void addCookie(java.lang.String url,
                      java.lang.String cookie)

Add a cookie for the URL. This was added as a work-around to provide access to the MMS data server at LASP.

Parameters:

url -

cookie -

getCookie

protected java.lang.String getCookie(java.net.URL url)

Some servers want cookies to handle the authentication. This checks for "https://lasp.colorado.edu/mms/sdc/about/browse/" and handles logins for this server.

Parameters:

url -

Returns:

null or the cookie to include in the request header.