VerificatumTool.java

/* Copyright 2008-2019 Douglas Wikstrom
 *
 * This file is part of Verificatum Mix-Net (VMN).
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy,
 * modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.verificatum;

import java.util.Formatter;
import java.util.Locale;

import com.verificatum.ui.Util;
import com.verificatum.ui.opt.Opt;

/*
 * In contrast to most of the source, this file contains several
 * hard-coded names and descriptions. This is needed, since this
 * provides overall descriptions.
 */

/**
 * Command line interface that collects the functionality of all
 * Verificatum commands under a single umbrella to improve the user
 * experience. It merely provides high level usage information and the
 * ability to execute each listed command indirectly.
 *
 * @author Douglas Wikstrom
 */
public final class VerificatumTool {

    /**
     * Avoid accidental instantiation.
     */
    private VerificatumTool() { }

    /**
     * Normal commands.
     */
    static final String NORMAL_COMMANDS = "vog|vmni|vmn|vmnv|vre|vmnc";

    /**
     * Commands used during development and deployment.
     */
    static final String DEVEL_COMMANDS = "vbt|vmnd";

    /**
     * All commands.
     */
    static final String COMMANDS = NORMAL_COMMANDS + "|" + DEVEL_COMMANDS;

    /**
     * Formats paragraph.
     *
     * @param sb Destination.
     * @param command Command to describe.
     * @param description Description of command.
     */
    private static void formatParagraph(final StringBuilder sb,
                                        final String command,
                                        final String description) {
        final Formatter f = new Formatter(sb, Locale.US);

        final String broken = Util.breakLines(description, Opt.LINE_WIDTH - 8);
        final String[] lines = Util.split(broken, "\n");
        f.format(" %-4s - %s", command, lines[0]);
        for (int i = 1; i < lines.length; i++) {
            f.format("%n%5s   %s", "", lines[i]);
        }
        sb.append('\n');
    }

    /**
     * Command line interface to configuration tool.
     *
     * @param args Command line arguments.
     */
    @SuppressWarnings("PMD.CyclomaticComplexity")
    public static void main(final String[] args) {

        if (args.length < 1) {
            System.err.println("Failed to pass wrapper parameters!");
            System.exit(1);
        }
        final String commandName = args[0];

        if (args.length == 2 && "-version".equals(args[1])) {
            System.out.println(Verificatum.version());
            System.exit(0);
        }

        if (args.length == 2 && "-completeversion".equals(args[1])) {
            try {
                System.out.println(Verificatum.completeVersion());
            } catch (VerificatumException ve) {
                System.out.println("ERROR: " + ve.getMessage());
            }
            System.exit(0);
        }

        if (args.length == 2 && "-h".equals(args[1])) {

            final String header =
"Usage:\n"
+ " " + commandName + " -h\n"
+ " " + commandName + " " + NORMAL_COMMANDS + " <params>...\n"
+ " " + commandName + " " + DEVEL_COMMANDS + " <params>...\n"
+ " " + commandName + " -version\n"
+ " " + commandName + " -completeversion\n"
+ "\n\n"
+ "Description:"
+ "\n\n"
+ "Executes the provided commands. Each command can be executed on its own "
+ "as well. A brief description of each command follows. Please execute "
+ "any particular command with \"-h\" to get the full usage information."
+ "\n\n"
+ "The \"-completeversion\" lists any modules used that enable native code."
+ "This does not change the functionality in any way. Installations with"
+ "native code enabled can interoperate with those without."
+ "\n\n";

            final StringBuilder sb = new StringBuilder();
            sb.append(Util.breakLines(header, Opt.LINE_WIDTH));

            formatParagraph(sb, "vog",
"Provides a uniform interface to all primitive objects that can be generated "
+ "and used in initialization files of protocols or as inputs to other calls "
+ "to this tool.");

            formatParagraph(sb, "vmni",
"Generates configuration files for the Verificatum Mix-Net.");

            formatParagraph(sb, "vmn", "Executes the Verificatum Mix-Net.");

            formatParagraph(sb, "vmnv",
"Verifies the overall correctness of an execution of the Verificatum Mix-Net.");

            formatParagraph(sb, "vre",
"Re-arranges inputs and outputs of the mix-net in various ways.");

            formatParagraph(sb, "vmnc",
"Plug-in based tool for converting public keys, ciphertexts, and plaintexts "
+ "from/to custom formats.");

            formatParagraph(sb, "vbt",
"Reads byte tree data and prints it as a nested JSON array or reads data and "
+ "verifies that it is a valid byte tree.");

            formatParagraph(sb, "vmnd",
"Generates demo ciphertexts for the given interface.");

            System.out.println(sb.toString());
            System.exit(0);
        }

        if (args.length == 1 || COMMANDS.indexOf(args[1]) == -1) {
            System.out.println("ERROR: Invalid usage form, please use "
                               + "\"" + commandName
                               + " -h\" for usage information!");
            System.exit(1);
        } else {

            // This indicates to the shell script wrapper that it
            // should drop the name of the command from the command
            // line arguments and execute the command.
            System.exit(2);
        }
    }
}