001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.q2.cli.ssm;
020
021import org.jpos.q2.CLICommand;
022import org.jpos.q2.CLIContext;
023import org.jpos.q2.cli.SSM;
024import org.jpos.security.SMException;
025import org.jpos.security.jceadapter.JCESecurityModule;
026
027/**
028 * Provides base for most SSM based commands.  The exec method wraps the processing for derived classes.
029 *
030 * @author Alwyn Schoeman - alwyn.schoeman@gmail.com
031 */
032public abstract class SsmActionBase implements CLICommand {
033    /** Default constructor; no instance state to initialise. */
034    protected SsmActionBase() {}
035
036    /**
037     * Validates the command-line arguments before any side effects, returning {@code false}
038     * to abort the command (the implementation should print its own usage message).
039     *
040     * @param cli CLI context
041     * @param strings command-line tokens
042     * @return {@code true} when the arguments are acceptable
043     */
044    protected abstract boolean checkUsage(CLIContext cli, String[] strings);
045
046    /**
047     * Performs the actual SSM operation against {@code sm}.
048     *
049     * @param cli CLI context
050     * @param sm resolved security module
051     * @param keyLength resolved key length in bits
052     * @param strings command-line tokens
053     * @throws SMException if the security module operation fails
054     */
055    protected abstract void doCommand(
056            CLIContext cli,
057            JCESecurityModule sm,
058            short keyLength,
059            String[] strings)
060            throws SMException;
061
062    @Override
063    public void exec(CLIContext cli, String[] strings) throws Exception {
064        if (!checkUsage(cli, strings)) return;
065        try {
066            short keyLength = (short) Integer.parseInt(strings[1]);
067            JCESecurityModule securityModule = SSM.getSecurityModule(cli);
068            if (securityModule == null) {
069                cli.println("No security module initialized.  Use the INIT command to initialize one.");
070                return;
071            }
072            doCommand(cli, securityModule, keyLength, strings);
073        } catch (SMException sme) {
074            cli.printThrowable(sme);
075        } catch (NumberFormatException nfe) {
076            cli.println("Invalid KeyLength");
077        }
078    }
079}