org.jpos.security.jceadapter.Console 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-2016 Alejandro P. Revilla
 *
 * 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.jceadapter;

import org.jpos.core.ConfigurationException;
import org.jpos.core.SimpleConfiguration;
import org.jpos.iso.ISOUtil;
import org.jpos.security.SMException;
import org.jpos.security.SecureDESKey;
import org.jpos.util.Logger;
import org.jpos.util.SimpleLogListener;

import java.io.PrintStream;
import java.util.Properties;

/**
 * A simple application for sending critical commands to the JCE Security Module.
 * The functionalities available from this console, are not available programmatically (via API's),
 * for security reasons, because most of them involve clear (non encrypted) keys.
 * Those commands are package protected in the JCE Security Module.
 * @author Hani Samuel Kirollos
 * @version $Revision$ $Date$
 */
public class Console {

    public Console () {
    }

    /**
     * @param args
     */
    public static void main (String[] args) {
        new Console().exec(System.out,System.err,args);
    }

    public void exec(PrintStream outPS,PrintStream errPS,String[] args)
    {
        JCESecurityModule sm = new JCESecurityModule();
        Logger logger = new Logger();
        logger.addListener(new SimpleLogListener(outPS));
        sm.setLogger(logger, "jce-security-module");
        Properties cfgProps = new Properties();
        SimpleConfiguration cfg = new SimpleConfiguration(cfgProps);
        String commandName = null;
        String[] commandParams = new String[10];                 // 10 is Maximum number of paramters for a command
        outPS.println("Welcome to JCE Security Module console commander!");
        if (args.length == 0) {
            outPS.println("Usage: Console [-options] command [commandparameters...]");
            outPS.println("\nwhere options include:");
            outPS.println("    -lmk ");
            outPS.println("                  to specify the Local Master Keys file");
            outPS.println("    -rebuildlmk   to rebuild new Local Master Keys");
            outPS.println("                  WARNING: old Local Master Keys gets overwritten");
            outPS.println("    -jce ");
            outPS.println("                  to specify a JavaTM Cryptography Extension 1.2.1 provider");
            outPS.println("\nWhere command include: ");
            outPS.println("    GC ");
            outPS.println("                  to generate a clear key component.");
            outPS.println("    FK     ");
            outPS.println("                  to form a key from three clear components.");
            outPS.println("                  and returns the key encrypted under LMK");
            outPS.println("                  Odd parity is be forced before encryption under LMK");
            outPS.println("    CK   ");
            outPS.println("                  to generate a key check value for a key encrypted under LMK.");
            outPS.println("    IK    ");
            outPS.println("          ");
            outPS.println("                  to import a key from encryption under KEK (eg. ZMK,TMK) to encryption under LMK");
            outPS.println("                  Odd parity is be forced before encryption under LMK");
            outPS.println("    KE     ");
            outPS.println("           ");
            outPS.println("                  to translate (export) a key from encryption under LMK");
            outPS.println("                  to encryption under KEK (eg. ZMK,TMK)");
        }
        else {
            int argsCounter = 0;
            for (int j = 0; j < 10; j++) {
                if (argsCounter < args.length &&
                        args[argsCounter].toLowerCase().compareTo("-lmk") == 0
                ) {
                    argsCounter++;
                    cfgProps.setProperty("lmk", args[argsCounter++]);
                }
                if (argsCounter < args.length &&
                        args[argsCounter].toLowerCase().compareTo("-jce") == 0
                ) {
                    argsCounter++;
                    cfgProps.setProperty("provider", args[argsCounter++]);
                }
                if (argsCounter < args.length &&
                        args[argsCounter].toLowerCase().compareTo("-rebuildlmk") == 0
                ) {
                    argsCounter++;
                    cfgProps.setProperty("rebuildlmk", "true");
                }
            }
            if (argsCounter < args.length) {
                commandName = args[argsCounter++];
                int i = 0;
                while (argsCounter < args.length) {
                    commandParams[i++] = args[argsCounter++];
                }
            }
            // Configure JCE Security Module
            try {
                sm.setConfiguration(cfg);
            } catch (ConfigurationException e) {
                e.printStackTrace(errPS);
                return;
            }
            // Execute Command
            if (commandName != null) {
                try {
                    short keyLength = (short)Integer.parseInt(commandParams[0]);
                    if (commandName.toUpperCase().compareTo("GC") == 0) {
                        String clearKeyComponenetHexString = sm.generateClearKeyComponent(keyLength);
                    }
                    else if (commandName.toUpperCase().compareTo("FK") == 0) {
                        SecureDESKey KEYunderLMK = sm.formKEYfromThreeClearComponents(keyLength,
                                commandParams[1].toUpperCase(), commandParams[2], commandParams[3], commandParams[4]);
                    }
                    else if (commandName.toUpperCase().compareTo("CK") == 0) {
                        byte[] keyCheckValue = sm.generateKeyCheckValue(
                                new SecureDESKey(keyLength,commandParams[1].toUpperCase(), commandParams[2],""));
                    }
                    else if (commandName.toUpperCase().compareTo("IK") == 0) {
                        SecureDESKey KEKunderLMK = new SecureDESKey((short)Integer.parseInt(commandParams[3]),
                                commandParams[4].toUpperCase(), commandParams[5], commandParams[6]);
                        sm.importKey(keyLength, commandParams[1].toUpperCase(),
                                ISOUtil.hex2byte(commandParams[2]), KEKunderLMK, true);
                    }
                    else if (commandName.toUpperCase().compareTo("KE") == 0) {
                        SecureDESKey KEKunderLMK = new SecureDESKey((short)Integer.parseInt(commandParams[4]),
                                commandParams[5].toUpperCase(), commandParams[6], commandParams[7]);
                        SecureDESKey KEYunderLMK = new SecureDESKey(keyLength, commandParams[1].toUpperCase(),
                                commandParams[2], commandParams[3] );
                        sm.exportKey(KEYunderLMK, KEKunderLMK);
                    }
                    else {
                        System.err.println("Unknown command: " + commandName);
                    }
                } catch (SMException e) {
                    e.printStackTrace(errPS);
                } catch (java.lang.NumberFormatException e) {
                    errPS.println("Invalid KeyLength");
                }
            }
            else {
                errPS.println("No command specified");
            }
        }
    }
}