/*
- Copyright (C) 2015-2021 AsamK and contributors
+ Copyright (C) 2015-2022 AsamK and contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
package org.asamk.signal;
import net.sourceforge.argparse4j.ArgumentParsers;
+import net.sourceforge.argparse4j.DefaultSettings;
import net.sourceforge.argparse4j.impl.Arguments;
-import net.sourceforge.argparse4j.inf.ArgumentParser;
import net.sourceforge.argparse4j.inf.ArgumentParserException;
-import net.sourceforge.argparse4j.inf.MutuallyExclusiveGroup;
import net.sourceforge.argparse4j.inf.Namespace;
-import net.sourceforge.argparse4j.inf.Subparser;
-import net.sourceforge.argparse4j.inf.Subparsers;
-import org.asamk.signal.commands.Command;
-import org.asamk.signal.commands.Commands;
-import org.asamk.signal.manager.LibSignalLogger;
+import org.asamk.signal.commands.exceptions.CommandException;
+import org.asamk.signal.commands.exceptions.IOErrorException;
+import org.asamk.signal.commands.exceptions.RateLimitErrorException;
+import org.asamk.signal.commands.exceptions.UnexpectedErrorException;
+import org.asamk.signal.commands.exceptions.UntrustedKeyErrorException;
+import org.asamk.signal.commands.exceptions.UserErrorException;
+import org.asamk.signal.logging.LogConfigurator;
+import org.asamk.signal.manager.ManagerLogger;
import org.asamk.signal.util.SecurityProvider;
import org.bouncycastle.jce.provider.BouncyCastleProvider;
-import org.whispersystems.signalservice.api.util.PhoneNumberFormatter;
+import org.slf4j.bridge.SLF4JBridgeHandler;
+import java.io.File;
import java.security.Security;
-import java.util.Map;
public class Main {
public static void main(String[] args) {
+ // enable unlimited strength crypto via Policy, supported on relevant JREs
+ Security.setProperty("crypto.policy", "unlimited");
installSecurityProviderWorkaround();
// Configuring the logger needs to happen before any logger is initialized
- if (isVerbose(args)) {
- System.setProperty("org.slf4j.simpleLogger.defaultLogLevel", "debug");
- System.setProperty("org.slf4j.simpleLogger.showThreadName", "true");
- System.setProperty("org.slf4j.simpleLogger.showShortLogName", "false");
- System.setProperty("org.slf4j.simpleLogger.showDateTime", "true");
- System.setProperty("org.slf4j.simpleLogger.dateTimeFormat", "yyyy-MM-dd'T'HH:mm:ss.SSSXX");
- LibSignalLogger.initLogger();
- } else {
- System.setProperty("org.slf4j.simpleLogger.defaultLogLevel", "info");
- System.setProperty("org.slf4j.simpleLogger.showThreadName", "false");
- System.setProperty("org.slf4j.simpleLogger.showShortLogName", "true");
- System.setProperty("org.slf4j.simpleLogger.showDateTime", "false");
- }
+ final var loggingConfig = parseLoggingConfig(args);
+ configureLogging(loggingConfig);
- Namespace ns = parseArgs(args);
- if (ns == null) {
- System.exit(1);
- }
+ final var parser = App.buildArgumentParser();
+ final var ns = parser.parseArgsOrFail(args);
- int res = new Cli(ns).init();
- System.exit(res);
+ int status = 0;
+ try {
+ new App(ns).init();
+ } catch (CommandException e) {
+ System.err.println(e.getMessage());
+ if (loggingConfig.verboseLevel > 0 && e.getCause() != null) {
+ e.getCause().printStackTrace(System.err);
+ }
+ status = getStatusForError(e);
+ } catch (Throwable e) {
+ e.printStackTrace(System.err);
+ status = 2;
+ }
+ Shutdown.shutdownComplete();
+ System.exit(status);
}
private static void installSecurityProviderWorkaround() {
Security.addProvider(new BouncyCastleProvider());
}
- private static boolean isVerbose(String[] args) {
- ArgumentParser parser = buildBaseArgumentParser();
-
- Namespace ns;
- try {
- ns = parser.parseKnownArgs(args, null);
- } catch (ArgumentParserException e) {
- return false;
+ private static LoggingConfig parseLoggingConfig(final String[] args) {
+ final var nsLog = parseArgs(args);
+ if (nsLog == null) {
+ return new LoggingConfig(0, null, false);
}
- return ns.getBoolean("verbose");
+ final var verboseLevel = nsLog.getInt("verbose");
+ final var logFile = nsLog.<File>get("log-file");
+ final var scrubLog = nsLog.getBoolean("scrub-log");
+ return new LoggingConfig(verboseLevel, logFile, scrubLog);
}
+ /**
+ * This method only parses commandline args relevant for logging configuration.
+ */
private static Namespace parseArgs(String[] args) {
- ArgumentParser parser = buildArgumentParser();
+ var parser = ArgumentParsers.newFor("signal-cli", DefaultSettings.VERSION_0_9_0_DEFAULT_SETTINGS)
+ .includeArgumentNamesAsKeysInResult(true)
+ .build()
+ .defaultHelp(false);
+ parser.addArgument("-v", "--verbose").action(Arguments.count());
+ parser.addArgument("--log-file").type(File.class);
+ parser.addArgument("--scrub-log").action(Arguments.storeTrue());
- Namespace ns;
try {
- ns = parser.parseArgs(args);
+ return parser.parseKnownArgs(args, null);
} catch (ArgumentParserException e) {
- parser.handleError(e);
return null;
}
-
- if ("link".equals(ns.getString("command"))) {
- if (ns.getString("username") != null) {
- parser.printUsage();
- System.err.println("You cannot specify a username (phone number) when linking");
- System.exit(2);
- }
- } else if (!ns.getBoolean("dbus") && !ns.getBoolean("dbus_system")) {
- if (ns.getString("username") == null) {
- parser.printUsage();
- System.err.println("You need to specify a username (phone number)");
- System.exit(2);
- }
- if (!PhoneNumberFormatter.isValidNumber(ns.getString("username"), null)) {
- System.err.println("Invalid username (phone number), make sure you include the country code.");
- System.exit(2);
- }
- }
-
- if (ns.getList("recipient") != null && !ns.getList("recipient").isEmpty() && ns.getString("group") != null) {
- System.err.println("You cannot specify recipients by phone number and groups at the same time");
- System.exit(2);
- }
-
- return ns;
}
- private static ArgumentParser buildArgumentParser() {
- ArgumentParser parser = buildBaseArgumentParser();
-
- Subparsers subparsers = parser.addSubparsers()
- .title("subcommands")
- .dest("command")
- .description("valid subcommands")
- .help("additional help");
-
- final Map<String, Command> commands = Commands.getCommands();
- for (Map.Entry<String, Command> entry : commands.entrySet()) {
- Subparser subparser = subparsers.addParser(entry.getKey());
- entry.getValue().attachToSubparser(subparser);
+ private static void configureLogging(final LoggingConfig loggingConfig) {
+ LogConfigurator.setVerboseLevel(loggingConfig.verboseLevel);
+ LogConfigurator.setLogFile(loggingConfig.logFile);
+ LogConfigurator.setScrubSensitiveInformation(loggingConfig.scrubLog);
+
+ if (loggingConfig.verboseLevel > 0) {
+ java.util.logging.Logger.getLogger("")
+ .setLevel(loggingConfig.verboseLevel > 2
+ ? java.util.logging.Level.FINEST
+ : java.util.logging.Level.INFO);
+ ManagerLogger.initLogger();
}
-
- return parser;
+ SLF4JBridgeHandler.removeHandlersForRootLogger();
+ SLF4JBridgeHandler.install();
}
- private static ArgumentParser buildBaseArgumentParser() {
- ArgumentParser parser = ArgumentParsers.newFor("signal-cli")
- .build()
- .defaultHelp(true)
- .description("Commandline interface for Signal.")
- .version(BaseConfig.PROJECT_NAME + " " + BaseConfig.PROJECT_VERSION);
-
- parser.addArgument("-v", "--version").help("Show package version.").action(Arguments.version());
- parser.addArgument("--verbose")
- .help("Raise log level and include lib signal logs.")
- .action(Arguments.storeTrue());
- parser.addArgument("--config")
- .help("Set the path, where to store the config (Default: $XDG_DATA_HOME/signal-cli , $HOME/.local/share/signal-cli).");
-
- MutuallyExclusiveGroup mut = parser.addMutuallyExclusiveGroup();
- mut.addArgument("-u", "--username").help("Specify your phone number, that will be used for verification.");
- mut.addArgument("--dbus").help("Make request via user dbus.").action(Arguments.storeTrue());
- mut.addArgument("--dbus-system").help("Make request via system dbus.").action(Arguments.storeTrue());
-
- parser.addArgument("-o", "--output")
- .help("Choose to output in plain text or JSON")
- .choices("plain-text", "json")
- .setDefault("plain-text");
-
- return parser;
+ private static int getStatusForError(final CommandException e) {
+ return switch (e) {
+ case UserErrorException userErrorException -> 1;
+ case UnexpectedErrorException unexpectedErrorException -> 2;
+ case IOErrorException ioErrorException -> 3;
+ case UntrustedKeyErrorException untrustedKeyErrorException -> 4;
+ case RateLimitErrorException rateLimitErrorException -> 5;
+ case null -> 2;
+ };
}
+
+ private record LoggingConfig(int verboseLevel, File logFile, boolean scrubLog) {}
}