org.jpos.security.SimpleKeyFile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jpos Show documentation
jPOS is an ISO-8583 based financial transaction library/framework that can be customized and extended in order to implement financial interchanges.
There is a newer version: 2.1.9
Show newest version
/*
 * jPOS Project [http://jpos.org]
 * Copyright (C) 2000-2020 jPOS Software SRL
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */

package  org.jpos.security;

import java.io.BufferedInputStream;
import org.jpos.core.Configurable;
import org.jpos.core.Configuration;
import org.jpos.core.ConfigurationException;
import org.jpos.iso.ISOUtil;
import org.jpos.util.LogEvent;
import org.jpos.util.LogSource;
import org.jpos.util.Logger;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;


/**
 * Implements SecureKeyStore using a properties file.
 * @author Hani S. Kirollos
 * @version $Revision$ $Date$
 * @see java.util.Properties
 */
public class SimpleKeyFile
        implements SecureKeyStore, Configurable, LogSource  {
    Properties props = new Properties();
    File file;
    String header = "Key File";
    protected Logger logger = null;
    protected String realm = null;

    public SimpleKeyFile () {
    }

    public SimpleKeyFile (String keyFileName) throws SecureKeyStoreException
    {
        init(keyFileName);
    }

    public void init (String keyFileName) throws SecureKeyStoreException {
        file = new File(keyFileName);
        try {
            if (!file.exists())
                file.createNewFile();
            load();
        } catch (Exception e) {
            throw  new SecureKeyStoreException(e);
        }
    }

    @Override
    public void setLogger (Logger logger, String realm) {
        this.logger = logger;
        this.realm = realm;
    }

    @Override
    public Logger getLogger () {
        return  logger;
    }

    @Override
    public String getRealm () {
        return  realm;
    }

    /**
     *
     * @param cfg configuration object
     * @throws ConfigurationException
     */
    @Override
    public void setConfiguration (Configuration cfg) throws ConfigurationException {
        try {
            init(cfg.get("key-file"));
            header = cfg.get("file-header", header);
        } catch (Exception e) {
            throw  new ConfigurationException(e);
        }
    }

    @Override
    public synchronized SecureKey getKey (String alias) throws SecureKeyStoreException {
        SecureKey secureKey = null;
        LogEvent evt = logger != null ? new LogEvent(this, "get-key") : null;
        if (evt != null)
            evt.addMessage("alias", alias);
        try {
            load();
            String keyClassName = getProperty(alias, "class");
            Class c = Class.forName(keyClassName);
            secureKey = (SecureKey)c.newInstance();
            if (!(secureKey instanceof SecureDESKey))
                throw  new SecureKeyStoreException("Unsupported SecureKey class: " +
                        secureKey.getClass().getName());
            byte[] keyBytes = ISOUtil.hex2byte(getProperty(alias, "key"));
            short keyLength = Short.parseShort(getProperty(alias, "length"));
            String keyType = getProperty(alias, "type");
            byte[] KeyCheckValue = ISOUtil.hex2byte(getProperty(alias, "checkvalue"));
            secureKey = new SecureDESKey(keyLength, keyType, keyBytes, KeyCheckValue);
            if (evt != null)
                evt.addMessage(secureKey);
        } catch (Exception e) {
            if (evt == null) // this is an exception, we want to log it, even if we don't have an assigned logger
                evt = new LogEvent(this, "get-key-error", alias);
            evt.addMessage(e);
            throw  e instanceof SecureKeyStoreException ? (SecureKeyStoreException) e : new SecureKeyStoreException(e);
        } finally {
            if (evt != null)
                Logger.log(evt);
        }
        return  secureKey;
    }

    @Override
    public synchronized void setKey (String alias, SecureKey secureKey) throws SecureKeyStoreException {
        LogEvent evt = new LogEvent(this, "set-key");
        evt.addMessage("alias", alias);
        evt.addMessage(secureKey);
        try {
            if (!(secureKey instanceof SecureDESKey))
                throw  new SecureKeyStoreException("Unsupported SecureKey class: " +
                        secureKey.getClass().getName());
            load();                 // load new changes (possibly made manually on the file)
            setProperty(alias, "class", secureKey.getClass().getName());
            setProperty(alias, "key", ISOUtil.hexString(secureKey.getKeyBytes()));
            setProperty(alias, "length",  Short.toString(secureKey.getKeyLength()));
            setProperty(alias, "type", secureKey.getKeyType());
            String keyCheckValueHexString = ISOUtil.hexString(((SecureDESKey)secureKey).getKeyCheckValue());
            setProperty(alias, "checkvalue", keyCheckValueHexString);
            store();
        } catch (Exception e) {
            evt.addMessage(e);
            throw  e instanceof SecureKeyStoreException ? (SecureKeyStoreException) e : new SecureKeyStoreException(e);
        } finally {
            Logger.log(evt);
        }
    }

    void load () throws SecureKeyStoreException {
        InputStream in;
        try {
            if (!file.canRead())
                throw  new SecureKeyStoreException("Can't read from file: " + file.getCanonicalPath());
            in = new BufferedInputStream(new FileInputStream(file));
            try {
                props.load(in);
            } finally {
                in.close();
            }
        } catch (Exception e) {
            throw  new SecureKeyStoreException(e);
        }
    }

    void store () throws SecureKeyStoreException {
        FileOutputStream out;
        try {
            if (!file.canWrite())
                throw  new SecureKeyStoreException("Can't write to file: " + file.getCanonicalPath());
            out = new FileOutputStream(file);
            props.store(out, header);
            out.flush();
            out.close();
        } catch (Exception e) {
            throw  new SecureKeyStoreException(e);
        }
    }

    public String getProperty (String alias, String subName) throws SecureKeyStoreException {
        // key here has nothing to do with cryptographic keys
        String key = alias + "." + subName;
        String value = props.getProperty(key);
        if (value == null)
            throw  new SecureKeyStoreException("Key can't be retrieved. Can't get property: " + key);
        return value.trim();
    }

    public void setProperty (String alias, String subName, String value) {
        // key here has nothing to do with cryptographic keys
        String key = alias + "." + subName;
        props.setProperty(key, value);
    }

    @Override
    public Map getKeys() throws SecureKeyStoreException {
        Map keys = new HashMap<>();
        for (Object k : props.keySet()) {
            String keyStr = (String) k;
            String alias = keyStr.substring(0, keyStr.lastIndexOf('.'));
            if (!keys.containsKey(alias)) {
                keys.put(alias, getKey(alias));
            }
        }
        return keys;
    }
}