/*************************************************************************
 *                                                                       *
 *  EJBCA: The OpenSource Certificate Authority                          *
 *                                                                       *
 *  This software is free software; you can redistribute it and/or       *
 *  modify it under the terms of the GNU Lesser General Public           *
 *  License as published by the Free Software Foundation; either         *
 *  version 2.1 of the License, or any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/
package org.ejbca.util.keystore;

import java.io.IOException;
import java.security.Key;
import java.security.KeyStore;
import java.security.Provider;
import java.security.Security;
import java.security.KeyStore.CallbackHandlerProtection;
import java.security.cert.Certificate;

import javax.security.auth.callback.CallbackHandler;

import org.apache.log4j.Logger;

/** A keystore container for PCKS#11 keystores i.e. the java PKCS#11 wrapper
 * 
 * @version $Id: KeyStoreContainerP11.java 8202 2009-10-27 16:29:53Z anatom $
 */
public class KeyStoreContainerP11 extends KeyStoreContainerBase {
    private static final Logger log = Logger.getLogger(KeyStoreContainerP11.class);

    private KeyStoreContainerP11( KeyStore _keyStore,
                                  String _providerName ) throws Exception, IOException{
        super( _keyStore, _providerName, _providerName );
        load();
    }
    protected void load() throws Exception, IOException {
        this.keyStore.load(null, null);
    }

    /** Use KeyStoreContainer.getInstance to get an instance of this class
     * @see KeyStoreContainer#getInstance(String, String, String, String)
     */
    static KeyStoreContainer getInstance(final String slot,
                                         final String libName,
                                         final boolean isIx,
                                         final String attributesFile,
                                         final KeyStore.ProtectionParameter protectionParameter) throws Exception, IOException {
        Provider provider = KeyTools.getP11Provider(slot, libName, isIx, attributesFile);
        final String providerName = provider.getName();
        log.debug("Adding provider with name: "+providerName);
        if (Security.getProvider(providerName) == null) {
            Security.addProvider(provider);
        } else {
            log.debug("Provider already exists, not adding.");        	
        }

        return getInstance(providerName, protectionParameter);
    }
    /** Use KeyStoreContainer.getInstance to get an instance of this class
     * @see KeyStoreContainer#getInstance(String, String, String, String)
     */
    static KeyStoreContainer getInstance(final String providerName,
                                         final KeyStore.ProtectionParameter protectionParameter) throws Exception, IOException {
        // Make a default password callback handler, if we don't specify one on the command line
        KeyStore.ProtectionParameter pp = protectionParameter;
        if (pp == null) {
            CallbackHandler cbh = null;
            try {
                // We will construct the PKCS11 text callback handler (sun.security...) using reflection, because 
                // the sun class does not exist on other JDKs than sun, and we want to be able to compile everything on i.e. IBM JDK.
                //   return new SunPKCS11(new ByteArrayInputStream(baos.toByteArray()));
                //final Class<?> implClass = Class.forName(SUNTEXTCBHANDLERCLASS);
                //cbh = (CallbackHandler)implClass.newInstance();
            	
            	// Nope: we have a better approach from EJBCA 3.9, we made our own callback handler
            	cbh = new PasswordCallBackHandler();
            } catch (Exception e) {
                IOException ioe = new IOException("Error constructing pkcs11 password callback handler: "+e.getMessage());
                ioe.initCause(e);
                throw ioe;
            } 
            pp = new CallbackHandlerProtection(cbh);        	
        }
        Provider provider = Security.getProvider(providerName);
        KeyStore.Builder builder = KeyStore.Builder.newInstance("PKCS11", provider, pp);
        final KeyStore keyStore = builder.getKeyStore();
        return new KeyStoreContainerP11( keyStore, providerName );
    }

    public byte[] storeKeyStore() throws Exception, IOException {
        char[] authCode = getPassPhraseLoadSave();
        this.keyStore.store(null, authCode);
        return new byte[0];
    }
    @Override
    void setKeyEntry(String alias, Key key, Certificate chain[]) throws IOException, Exception {
        this.keyStore.setKeyEntry(alias, key, null, chain);
    }

    public Key getKey(String alias) throws Exception, IOException {
        return this.keyStore.getKey(alias, null);
    }

    public char[] getPassPhraseGetSetEntry() {
        return null;
    }

}