/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.security.store;
import com.sun.enterprise.universal.i18n.LocalStringsImpl;
import com.sun.enterprise.util.SystemPropertyConstants;
import com.sun.logging.LogDomains;
import java.io.BufferedInputStream;
import java.io.Console;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.UnrecoverableKeyException;
import java.security.cert.CertificateException;
import java.util.logging.Logger;
/**
* Various utility methods related to certificate-based security.
* <p>
* In particular, this class opens both the client-side keystore and the
* client-side truststore when either one is requested. This allows us to
* prompt only once for the master password (if necessary) without storing the
* password the user responds with which would be a security risk.
*
* @author Tim Quinn (with portions refactored from elsewhere)
*/
public class AsadminSecurityUtil {
private static AsadminSecurityUtil instance = null;
private static final Logger logger = LogDomains.getLogger(AsadminSecurityUtil.class,
LogDomains.ADMIN_LOGGER);
/**
* Returns the usable instance, creating it if needed.
* @param commandLineMasterPassword password provided via the command line
* @param isPromptable if the command requiring the object was run by a human who is present to respond to a prompt for the master password
* @return the usable instance
*/
public synchronized static AsadminSecurityUtil getInstance(
final char[] commandLineMasterPassword,
final boolean isPromptable) {
if (instance == null) {
instance = new AsadminSecurityUtil(commandLineMasterPassword, isPromptable);
}
return instance;
}
/**
* Returns the usable instance, creating it if needed.
* @param isPromptable if the command requiring the object was run by a human who is present to respond to a prompt for the master password
* @return
*/
public synchronized static AsadminSecurityUtil getInstance(
final boolean isPromptable) {
return getInstance(null, isPromptable);
}
private AsadminTruststore asadminTruststore = null;
private KeyStore asadminKeystore = null;
private static final LocalStringsImpl strmgr =
new LocalStringsImpl(AsadminSecurityUtil.class);
/**
* Returns the master password for the keystore and truststore, as set by
* the system property (defaulted if the property is not set).
* @return
*/
public static char[] getAsadminTruststorePassword()
{
return System.getProperty(SystemPropertyConstants.CLIENT_TRUSTSTORE_PASSWORD_PROPERTY,
"changeit").toCharArray();
}
private AsadminSecurityUtil(final char[] commandLineMasterPassword, final boolean isPromptable) {
try {
init(commandLineMasterPassword, isPromptable);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
/**
* If we fail to open the client database using the default password
* (changeit) or the password found in "javax.net.ssl.trustStorePassword"
* system property, then the fallback behavior is to prompt the user for
* the password by calling this method.
* @return the password to the client side truststore
*/
private char[] promptForPassword() throws IOException {
Console cons = System.console();
if (cons != null) {
return cons.readPassword(strmgr.get("certificateDbPrompt"));
}
return null;
}
/**
* Returns the opened AsadminTruststore object.
* @return the AsadminTruststore object
*/
public AsadminTruststore getAsadminTruststore() {
return asadminTruststore;
}
public KeyStore getAsadminKeystore() {
return asadminKeystore;
}
private void init(final char[] commandLineMasterPassword, final boolean isPromptable)
throws IOException, KeyStoreException, NoSuchAlgorithmException, CertificateException {
char[] passwordToUse = chooseMasterPassword(commandLineMasterPassword);
try {
/*
* Open the keystore if the user has specified one using
* the standard system property. That would allow users to add a
* key to a client-side keystore and use SSL client auth from
* asadmin to the DAS (if they have added the corresponding cert to
* the DAS truststore).
*/
asadminKeystore = openKeystore(passwordToUse);
if (asadminKeystore == null) {
logger.finer("Skipped loading keystore - location null");
} else {
logger.finer("Loaded keystore using command or default master password");
}
} catch (IOException ex) {
if (ex.getCause() instanceof UnrecoverableKeyException) {
/*
* The password did not allow access to the keystore. Prompt
* the user if possible.
*/
if ( ! isPromptable) {
throw ex;
}
passwordToUse = promptForPassword();
if (passwordToUse == null) {
throw new IllegalArgumentException();
}
asadminKeystore = openKeystore(passwordToUse);
logger.finer("Loaded keystore using prompted master password");
}
} catch (Exception e) {
throw new RuntimeException(e);
}
/*
* The keystore has been opened successfully, using passwordToUse.
* Open the truststore with that password.
*/
asadminTruststore = openTruststore(passwordToUse);
}
private AsadminTruststore openTruststore(final char[] password)
throws CertificateException, KeyStoreException, NoSuchAlgorithmException, IOException {
return new AsadminTruststore(password);
}
/**
* Open the keystore, using the password provided.
* @param candidateMasterPassword password to use in opening the keystore
* @return opened keystore
* @throws KeyStoreException
* @throws IOException
* @throws NoSuchAlgorithmException
* @throws CertificateException
*/
private KeyStore openKeystore(final char[] candidateMasterPassword)
throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException {
final KeyStore permanentKS = KeyStore.getInstance("JKS");
InputStream keyStoreStream = null;
try {
keyStoreStream = asadminKeyStoreStream();
if (keyStoreStream == null) {
return null;
}
permanentKS.load(
keyStoreStream,
candidateMasterPassword);
return permanentKS;
} finally {
if (keyStoreStream != null) {
keyStoreStream.close();
}
}
}
/**
* Returns the master password passed on the command line or, if none,
* the default master password.
* @param commandMasterPassword master password passed on the command line; null if none
* @return master password to use
*/
private char[] chooseMasterPassword(final char[] commandMasterPassword) {
return (commandMasterPassword == null ? defaultMasterPassword() : commandMasterPassword);
}
/**
* Returns an open stream to the keystore.
* @return stream to the keystore
* @throws FileNotFoundException
*/
private InputStream asadminKeyStoreStream() throws FileNotFoundException {
String location = System.getProperty(SystemPropertyConstants.KEYSTORE_PROPERTY);
if (location == null) {
return null;
}
return new BufferedInputStream(new FileInputStream(location));
}
private char[] defaultMasterPassword() {
return System.getProperty(SystemPropertyConstants.CLIENT_TRUSTSTORE_PASSWORD_PROPERTY,
"changeit").toCharArray();
}
}