keystoreloginmodule.java

来自「JAVA 所有包」· Java 代码 · 共 897 行 · 第 1/2 页

	    int confirmationResult = confirmationCallback.getSelectedIndex();

	    if (confirmationResult == ConfirmationCallback.CANCEL) {
		throw new LoginException("Login cancelled");
	    }

	    saveAlias(aliasCallback);

	} else if (keyPassCallback == null) {

	    // prompt for alias and key store password

	    try {
		callbackHandler.handle(
		    new Callback[] {
			bannerCallback, aliasCallback,
			storePassCallback, confirmationCallback
		    });
	    } catch (IOException e) {
		LoginException le = new LoginException
			("Problem retrieving keystore alias and password");
		le.initCause(e);
		throw le;
	    } catch (UnsupportedCallbackException e) {
		throw new LoginException(
		    "Error: " + e.getCallback().toString() +
		    " is not available to retrieve authentication " +
		    " information from the user");
	    }

	    int confirmationResult = confirmationCallback.getSelectedIndex();

	    if (confirmationResult == ConfirmationCallback.CANCEL) {
		throw new LoginException("Login cancelled");
	    }

	    saveAlias(aliasCallback);
	    saveStorePass(storePassCallback);

	} else {

	    // prompt for alias, key store password, and key password

	    try {
		callbackHandler.handle(
		    new Callback[] {
			bannerCallback, aliasCallback,
			storePassCallback, keyPassCallback,
			confirmationCallback
		    });
	    } catch (IOException e) {
		LoginException le = new LoginException
			("Problem retrieving keystore alias and passwords");
		le.initCause(e);
		throw le;
	    } catch (UnsupportedCallbackException e) {
		throw new LoginException(
		    "Error: " + e.getCallback().toString() +
		    " is not available to retrieve authentication " +
		    " information from the user");
	    }

	    int confirmationResult = confirmationCallback.getSelectedIndex();

	    if (confirmationResult == ConfirmationCallback.CANCEL) {
		throw new LoginException("Login cancelled");
	    }

	    saveAlias(aliasCallback);
	    saveStorePass(storePassCallback);
	    saveKeyPass(keyPassCallback);
	}
    }

    private void saveAlias(NameCallback cb) {
	keyStoreAlias = cb.getName();
    }
   
    private void saveStorePass(PasswordCallback c) {
	keyStorePassword = c.getPassword();
	if (keyStorePassword == null) {
	    /* Treat a NULL password as an empty password */
	    keyStorePassword = new char[0];
	}
	c.clearPassword();
    }

    private void saveKeyPass(PasswordCallback c) {
	privateKeyPassword = c.getPassword();
	if (privateKeyPassword == null || privateKeyPassword.length == 0) {
	    /*
	     * Use keystore password if no private key password is
	     * specified.
	     */
	    privateKeyPassword = keyStorePassword;
	}
	c.clearPassword();
    }

    /** Get the credentials from the KeyStore. */
    private void getKeyStoreInfo() throws LoginException {

	/* Get KeyStore instance */
	try {
	    if (keyStoreProvider == null) {
		keyStore = KeyStore.getInstance(keyStoreType);
	    } else {
		keyStore =
		    KeyStore.getInstance(keyStoreType, keyStoreProvider);
	    }
	} catch (KeyStoreException e) {
	    LoginException le = new LoginException
		("The specified keystore type was not available");
	    le.initCause(e);
	    throw le;
	} catch (NoSuchProviderException e) {
	    LoginException le = new LoginException
		("The specified keystore provider was not available");
	    le.initCause(e);
	    throw le;
	}

	/* Load KeyStore contents from file */
	try {
	    if (nullStream) {
		// if using protected auth path, keyStorePassword will be null
		keyStore.load(null, keyStorePassword);
	    } else {
		InputStream in = new URL(keyStoreURL).openStream();
		keyStore.load(in, keyStorePassword);
		in.close();
	    }
	} catch (MalformedURLException e) {
	    LoginException le = new LoginException
				("Incorrect keyStoreURL option");
	    le.initCause(e);
	    throw le;
	} catch (GeneralSecurityException e) {
	    LoginException le = new LoginException
				("Error initializing keystore");
	    le.initCause(e);
	    throw le;
	} catch (IOException e) {
	    LoginException le = new LoginException
				("Error initializing keystore");
	    le.initCause(e);
	    throw le;
	}

	/* Get certificate chain and create a certificate path */
	try {
	    fromKeyStore =
		keyStore.getCertificateChain(keyStoreAlias);
	    if (fromKeyStore == null
		|| fromKeyStore.length == 0
		|| !(fromKeyStore[0] instanceof X509Certificate))
	    {
		throw new FailedLoginException(
		    "Unable to find X.509 certificate chain in keystore");
	    } else {
		LinkedList certList = new LinkedList();
		for (int i=0; i < fromKeyStore.length; i++) {
		    certList.add(fromKeyStore[i]);
		}
		CertificateFactory certF= 
		    CertificateFactory.getInstance("X.509");
		certP = 
		    certF.generateCertPath(certList);	
	    }
	} catch (KeyStoreException e) {
	    LoginException le = new LoginException("Error using keystore");
	    le.initCause(e);
	    throw le;
	} catch (CertificateException ce) {
	    LoginException le = new LoginException
		("Error: X.509 Certificate type unavailable");
	    le.initCause(ce);
	    throw le;
	}

	/* Get principal and keys */
	try {
	    X509Certificate certificate = (X509Certificate)fromKeyStore[0];
	    principal = new javax.security.auth.x500.X500Principal
		(certificate.getSubjectDN().getName());

	    // if token, privateKeyPassword will be null
	    Key privateKey = keyStore.getKey(keyStoreAlias, privateKeyPassword);
	    if (privateKey == null
		|| !(privateKey instanceof PrivateKey))
	    {
		throw new FailedLoginException(
		    "Unable to recover key from keystore");
	    }

	    privateCredential = new X500PrivateCredential(
		certificate, (PrivateKey) privateKey, keyStoreAlias);
	} catch (KeyStoreException e) {
	    LoginException le = new LoginException("Error using keystore");
	    le.initCause(e);
	    throw le;
	} catch (NoSuchAlgorithmException e) {
	    LoginException le = new LoginException("Error using keystore");
	    le.initCause(e);
	    throw le;
	} catch (UnrecoverableKeyException e) {
	    FailedLoginException fle = new FailedLoginException
				("Unable to recover key from keystore");
	    fle.initCause(e);
	    throw fle;
	}
	if (debug) {
	    debugPrint("principal=" + principal +
		       "\n certificate="
		       + privateCredential.getCertificate() +
		       "\n alias =" + privateCredential.getAlias());
	}
    }

    /**
     * Abstract method to commit the authentication process (phase 2).
     *
     * <p> This method is called if the LoginContext's
     * overall authentication succeeded
     * (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules
     * succeeded).
     *
     * <p> If this LoginModule's own authentication attempt
     * succeeded (checked by retrieving the private state saved by the
     * <code>login</code> method), then this method associates a
     * <code>X500Principal</code> for the subject distinguished name of the 
     * first certificate in the alias's credentials in the subject's
     * principals,the alias's certificate path in the subject's public 
     * credentials, and a<code>X500PrivateCredential</code> whose certificate
     * is the first  certificate in the alias's certificate path and whose
     * private key is the alias's private key in the subject's private
     * credentials.  If this LoginModule's own
     * authentication attempted failed, then this method removes
     * any state that was originally saved.
     *
     * <p>
     *
     * @exception LoginException if the commit fails
     *
     * @return true if this LoginModule's own login and commit
     *		attempts succeeded, or false otherwise.
     */

    public boolean commit() throws LoginException {
	switch (status) {
	case UNINITIALIZED:
	default:
	    throw new LoginException("The login module is not initialized");
	case INITIALIZED:
	    logoutInternal();
	    throw new LoginException("Authentication failed");
	case AUTHENTICATED:
	    if (commitInternal()) {
		return true;
	    } else {
		logoutInternal();
		throw new LoginException("Unable to retrieve certificates");
	    }
	case LOGGED_IN:
	    return true;
	}
    }

    private boolean commitInternal() throws LoginException {
	/* If the subject is not readonly add to the principal and credentials
	 * set; otherwise just return true
	 */
	if (subject.isReadOnly()) {
	    throw new LoginException ("Subject is set readonly");
	} else {
	    subject.getPrincipals().add(principal);
	    subject.getPublicCredentials().add(certP);
	    subject.getPrivateCredentials().add(privateCredential);
	    status = LOGGED_IN;
	    return true;
	}
    }

    /**
     * <p> This method is called if the LoginContext's
     * overall authentication failed.
     * (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules
     * did not succeed).
     *
     * <p> If this LoginModule's own authentication attempt
     * succeeded (checked by retrieving the private state saved by the
     * <code>login</code> and <code>commit</code> methods),
     * then this method cleans up any state that was originally saved.
     *
     * <p> If the loaded KeyStore's provider extends
     * <code>java.security.AuthProvider</code>,
     * then the provider's <code>logout</code> method is invoked.
     *
     * <p>
     *
     * @exception LoginException if the abort fails.
     *
     * @return false if this LoginModule's own login and/or commit attempts
     *		failed, and true otherwise.
     */
	
    public boolean abort() throws LoginException {
	switch (status) {
	case UNINITIALIZED:
	default:
	    return false;
	case INITIALIZED:
	    return false;
	case AUTHENTICATED:
	    logoutInternal();
	    return true;
	case LOGGED_IN:
	    logoutInternal();
	    return true;
	}
    }
    /**
     * Logout a user.
     *
     * <p> This method removes the Principals, public credentials and the
     * private credentials that were added by the <code>commit</code> method.
     *
     * <p> If the loaded KeyStore's provider extends
     * <code>java.security.AuthProvider</code>,
     * then the provider's <code>logout</code> method is invoked.
     *
     * <p>
     *
     * @exception LoginException if the logout fails.
     *
     * @return true in all cases since this <code>LoginModule</code>
     *		should not be ignored.
     */

    public boolean logout() throws LoginException {
	if (debug)
	    debugPrint("Entering logout " + status);
	switch (status) {
	case UNINITIALIZED:
	    throw new LoginException
		("The login module is not initialized");
	case INITIALIZED:
	case AUTHENTICATED:
	default:
	   // impossible for LoginModule to be in AUTHENTICATED 
	   // state
	   // assert status != AUTHENTICATED;
	    return false;
	case LOGGED_IN:
	    logoutInternal();
	    return true;
	}
    }

    private void logoutInternal() throws LoginException {
	if (debug) {
	    debugPrint("Entering logoutInternal");
	}

	// assumption is that KeyStore.load did a login -
	// perform explicit logout if possible
	LoginException logoutException = null;
	Provider provider = keyStore.getProvider();
	if (provider instanceof AuthProvider) {
	    AuthProvider ap = (AuthProvider)provider;
	    try {
		ap.logout();
		if (debug) {
		    debugPrint("logged out of KeyStore AuthProvider");
		}
	    } catch (LoginException le) {
		// save but continue below
		logoutException = le;
	    }
	}

	if (subject.isReadOnly()) {
	    // attempt to destroy the private credential
	    // even if the Subject is read-only
	    principal = null;
	    certP = null;
	    status = INITIALIZED;
	    // destroy the private credential
	    Iterator it = subject.getPrivateCredentials().iterator();
	    while (it.hasNext()) {
		Object obj = it.next();
		if (privateCredential.equals(obj)) {
		    privateCredential = null;
		    try {
			((Destroyable)obj).destroy();
			if (debug)
			    debugPrint("Destroyed private credential, " +
				       obj.getClass().getName());
			break;
		    } catch (DestroyFailedException dfe) {
			LoginException le = new LoginException
			    ("Unable to destroy private credential, " 
			     + obj.getClass().getName());
			le.initCause(dfe);
			throw le;
		    }
		}
	    }
	    
	    // throw an exception because we can not remove
	    // the principal and public credential from this
	    // read-only Subject
	    throw new LoginException
		("Unable to remove Principal (" 
		 + "X500Principal "
		 + ") and public credential (certificatepath) "
		 + "from read-only Subject");
	}
	if (principal != null) {
	    subject.getPrincipals().remove(principal);
	    principal = null;
	}
	if (certP != null) {
	    subject.getPublicCredentials().remove(certP);
	    certP = null;
	}
	if (privateCredential != null) {
	    subject.getPrivateCredentials().remove(privateCredential);
	    privateCredential = null;
	}

	// throw pending logout exception if there is one
	if (logoutException != null) {
	    throw logoutException;
	}
	status = INITIALIZED;
    }

    private void debugPrint(String message) {
	// we should switch to logging API
	if (message == null) {
	    System.err.println();
	} else {
	    System.err.println("Debug KeyStoreLoginModule: " + message);
	}
    }
}