HSMUtils.java

/*
 * GovWay - A customizable API Gateway 
 * https://govway.org
 * 
 * Copyright (c) 2005-2025 Link.it srl (https://link.it). 
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3, as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package org.openspcoop2.utils.certificate.hsm;

import java.util.List;

import org.openspcoop2.utils.UtilsException;
import org.openspcoop2.utils.certificate.KeyStore;

/**
 * HSMUtils
 *
 * @author Poli Andrea (apoli@link.it)
 * @author $Author$
 * @version $Rev$, $Date$
 */
public class HSMUtils {
    
    private HSMUtils() {}

    public static final String KEYSTORE_HSM_PREFIX = "HSM-";
    public static final String KEYSTORE_HSM_STORE_PASSWORD_UNDEFINED = "-";
    public static final String KEYSTORE_HSM_PRIVATE_KEY_PASSWORD_UNDEFINED = "-";
    
    private static boolean hsmConfigurableKeyPassword = false;
    public static boolean isHsmConfigurableKeyPassword() {
        return hsmConfigurableKeyPassword;
    }
    public static void setHsmConfigurableKeyPassword(boolean hsmConfigurableKeyPassword) {
        HSMUtils.hsmConfigurableKeyPassword = hsmConfigurableKeyPassword;
    }
    
    public static void fillTipologieKeystore(boolean trustStore, boolean secretKeyStore, List<String> l){
        HSMManager hsmManager = HSMManager.getInstance();
        if(hsmManager!=null) {
            List<String> typeHsm = hsmManager.getKeystoreTypes();
            if(typeHsm!=null && !typeHsm.isEmpty()) {
                if(secretKeyStore) {
                    initSecretKeyStore(typeHsm, hsmManager, l);
                }
                else if(trustStore) {
                    initTrustStore(typeHsm, hsmManager, l);
                }
                else {
                    l.addAll(typeHsm);
                }
            }
        }
    }
    private static void initSecretKeyStore(List<String> typeHsm, HSMManager hsmManager, List<String> l) {
        for (String type : typeHsm) {
            try {
                if(hsmManager.isUsableAsSecretKeyStore(type)) {
                    l.add(type);
                }
            }catch(Exception e) { // ignore 
            }
        }
    }
    private static void initTrustStore(List<String> typeHsm, HSMManager hsmManager, List<String> l) {
        for (String type : typeHsm) {
            try {
                if(hsmManager.isUsableAsTrustStore(type)) {
                    l.add(type);
                }
            }catch(Exception e) { // ignore 
            }
        }
    }
    public static boolean existsTipologieKeystoreHSM(boolean trustStore, boolean secretKeyStore){
        HSMManager hsmManager = HSMManager.getInstance();
        if(hsmManager!=null) {
            List<String> typeHsm = hsmManager.getKeystoreTypes();
            if(existsTipologieKeystoreHSM(typeHsm, hsmManager,
                    trustStore, secretKeyStore)) {
                return true;
            }
        }
        return false;
    }
    private static boolean existsTipologieKeystoreHSM(List<String> typeHsm, HSMManager hsmManager,
            boolean trustStore, boolean secretKeyStore) {
        if(typeHsm!=null && !typeHsm.isEmpty()) {
            if(secretKeyStore) {
                if(existsSecretKeyStore(typeHsm, hsmManager)) {
                    return true;
                }
            }
            else if(trustStore) {
                if(existsTrustStore(typeHsm, hsmManager)) {
                    return true;
                }
            }
            else {
                return true;
            }
        }
        return false;
    }
    private static boolean existsSecretKeyStore(List<String> typeHsm, HSMManager hsmManager) {
        for (String type : typeHsm) {
            try {
                if(hsmManager.isUsableAsSecretKeyStore(type)) {
                    return true;
                }
            }catch(Exception e) { // ignore 
            }
        }
        return false;
    }
    private static boolean existsTrustStore(List<String> typeHsm, HSMManager hsmManager) {
        for (String type : typeHsm) {
            try {
                if(hsmManager.isUsableAsTrustStore(type)) {
                    return true;
                }
            }catch(Exception e) { // ignore 
            }
        }
        return false;
    }
    
    public static boolean isKeystoreHSM(String tipo) {
        if(HSMManager.getInstance()!=null) {
            return HSMManager.getInstance().existsKeystoreType(tipo);
        }
        return false;
    }
    
    public static KeyStore getKeystoreHSM(String tipo) throws UtilsException {
        if(HSMManager.getInstance()!=null) {
            return HSMManager.getInstance().getKeystore(tipo);
        }
        return null;
    }
    
}