X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/db756bfe10ab302d9991e68ec4b5ed34230d39e2..c0aa338d7c8e40874dbc453b3fc3916701762029:/src/main/java/org/asamk/signal/App.java diff --git a/src/main/java/org/asamk/signal/App.java b/src/main/java/org/asamk/signal/App.java index 521e453a..83c0ef56 100644 --- a/src/main/java/org/asamk/signal/App.java +++ b/src/main/java/org/asamk/signal/App.java @@ -5,79 +5,107 @@ import net.sourceforge.argparse4j.impl.Arguments; import net.sourceforge.argparse4j.inf.ArgumentParser; import net.sourceforge.argparse4j.inf.Namespace; -import org.asamk.Signal; import org.asamk.signal.commands.Command; +import org.asamk.signal.commands.CommandHandler; import org.asamk.signal.commands.Commands; -import org.asamk.signal.commands.DbusCommand; -import org.asamk.signal.commands.ExtendedDbusCommand; import org.asamk.signal.commands.LocalCommand; import org.asamk.signal.commands.MultiLocalCommand; import org.asamk.signal.commands.ProvisioningCommand; import org.asamk.signal.commands.RegistrationCommand; import org.asamk.signal.commands.exceptions.CommandException; +import org.asamk.signal.commands.exceptions.IOErrorException; import org.asamk.signal.commands.exceptions.UnexpectedErrorException; import org.asamk.signal.commands.exceptions.UserErrorException; +import org.asamk.signal.dbus.DbusCommandHandler; import org.asamk.signal.manager.Manager; -import org.asamk.signal.manager.NotRegisteredException; -import org.asamk.signal.manager.ProvisioningManager; import org.asamk.signal.manager.RegistrationManager; -import org.asamk.signal.manager.config.ServiceConfig; -import org.asamk.signal.manager.config.ServiceEnvironment; +import org.asamk.signal.manager.Settings; +import org.asamk.signal.manager.SignalAccountFiles; +import org.asamk.signal.manager.api.AccountCheckException; +import org.asamk.signal.manager.api.NotRegisteredException; +import org.asamk.signal.manager.api.ServiceEnvironment; +import org.asamk.signal.manager.api.TrustNewIdentity; +import org.asamk.signal.output.JsonWriterImpl; +import org.asamk.signal.output.OutputWriter; +import org.asamk.signal.output.PlainTextWriterImpl; import org.asamk.signal.util.IOUtils; import org.freedesktop.dbus.connections.impl.DBusConnection; +import org.freedesktop.dbus.connections.impl.DBusConnectionBuilder; +import org.freedesktop.dbus.errors.ServiceUnknown; import org.freedesktop.dbus.exceptions.DBusException; +import org.freedesktop.dbus.exceptions.DBusExecutionException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import org.whispersystems.signalservice.api.util.PhoneNumberFormatter; +import java.io.BufferedWriter; import java.io.File; import java.io.IOException; -import java.util.ArrayList; -import java.util.List; +import java.io.OutputStreamWriter; +import java.util.Set; + +import static net.sourceforge.argparse4j.DefaultSettings.VERSION_0_9_0_DEFAULT_SETTINGS; public class App { - private final static Logger logger = LoggerFactory.getLogger(App.class); + private static final Logger logger = LoggerFactory.getLogger(App.class); private final Namespace ns; static ArgumentParser buildArgumentParser() { - var parser = ArgumentParsers.newFor("signal-cli") + var parser = ArgumentParsers.newFor("signal-cli", VERSION_0_9_0_DEFAULT_SETTINGS) + .includeArgumentNamesAsKeysInResult(true) .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") + parser.addArgument("--version").help("Show package version.").action(Arguments.version()); + parser.addArgument("-v", "--verbose") + .help("Raise log level and include lib signal logs. Specify multiple times for even more logs.") + .action(Arguments.count()); + parser.addArgument("--log-file") + .type(File.class) + .help("Write log output to the given file. If --verbose is also given, the detailed logs will only be written to the log file."); + parser.addArgument("--scrub-log") + .action(Arguments.storeTrue()) + .help("Scrub possibly sensitive information from the log, like phone numbers and UUIDs."); + parser.addArgument("-c", "--config") .help("Set the path, where to store the config (Default: $XDG_DATA_HOME/signal-cli , $HOME/.local/share/signal-cli)."); - parser.addArgument("-u", "--username").help("Specify your phone number, that will be your identifier."); + parser.addArgument("-a", "--account", "-u", "--username") + .help("Specify your phone number, that will be your identifier."); var mut = parser.addMutuallyExclusiveGroup(); - 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()); + mut.addArgument("--dbus").dest("global-dbus").help("Make request via user dbus.").action(Arguments.storeTrue()); + mut.addArgument("--dbus-system") + .dest("global-dbus-system") + .help("Make request via system dbus.") + .action(Arguments.storeTrue()); parser.addArgument("-o", "--output") .help("Choose to output in plain text or JSON") - .type(Arguments.enumStringType(OutputType.class)) - .setDefault(OutputType.PLAIN_TEXT); + .type(Arguments.enumStringType(OutputType.class)); parser.addArgument("--service-environment") - .help("Choose the server environment to use, SANDBOX or LIVE.") + .help("Choose the server environment to use.") .type(Arguments.enumStringType(ServiceEnvironmentCli.class)) .setDefault(ServiceEnvironmentCli.LIVE); + parser.addArgument("--trust-new-identities") + .help("Choose when to trust new identities.") + .type(Arguments.enumStringType(TrustNewIdentityCli.class)) + .setDefault(TrustNewIdentityCli.ON_FIRST_USE); + + parser.addArgument("--disable-send-log") + .help("Disable message send log (for resending messages that recipient couldn't decrypt)") + .action(Arguments.storeTrue()); + var subparsers = parser.addSubparsers().title("subcommands").dest("command"); - final var commands = Commands.getCommands(); - for (var entry : commands.entrySet()) { - var subparser = subparsers.addParser(entry.getKey()); - entry.getValue().attachToSubparser(subparser); - } + Commands.getCommandSubparserAttachers().forEach((key, value) -> { + var subparser = subparsers.addParser(key); + value.attachToSubparser(subparser); + }); return parser; } @@ -87,115 +115,154 @@ public class App { } public void init() throws CommandException { + logger.debug("Starting {}", BaseConfig.PROJECT_NAME + " " + BaseConfig.PROJECT_VERSION); var commandKey = ns.getString("command"); var command = Commands.getCommand(commandKey); if (command == null) { throw new UserErrorException("Command not implemented!"); } - var outputType = ns.get("output"); - if (!command.getSupportedOutputTypes().contains(outputType)) { - throw new UserErrorException("Command doesn't support output type " + outputType.toString()); - } + final var outputWriter = getOutputWriter(command); + final var commandHandler = new CommandHandler(ns, outputWriter); - var username = ns.getString("username"); + var account = ns.getString("account"); - final var useDbus = ns.getBoolean("dbus"); - final var useDbusSystem = ns.getBoolean("dbus_system"); + final var useDbus = Boolean.TRUE.equals(ns.getBoolean("global-dbus")); + final var useDbusSystem = Boolean.TRUE.equals(ns.getBoolean("global-dbus-system")); if (useDbus || useDbusSystem) { - // If username is null, it will connect to the default object path - initDbusClient(command, username, useDbusSystem); + // If account is null, it will connect to the default object path + initDbusClient(command, account, useDbusSystem, commandHandler); return; } - final File dataPath; - var config = ns.getString("config"); - if (config != null) { - dataPath = new File(config); - } else { - dataPath = getDefaultDataPath(); + if (!Manager.isSignalClientAvailable()) { + throw new UserErrorException("Missing required native library dependency: libsignal-client"); } - final var serviceEnvironmentCli = ns.get("service_environment"); - final var serviceEnvironment = serviceEnvironmentCli == ServiceEnvironmentCli.LIVE - ? ServiceEnvironment.LIVE - : ServiceEnvironment.SANDBOX; - - if (!ServiceConfig.getCapabilities().isGv2()) { - logger.warn("WARNING: Support for new group V2 is disabled," - + " because the required native library dependency is missing: libzkgroup"); - } + final var signalAccountFiles = loadSignalAccountFiles(); - if (!ServiceConfig.isSignalClientAvailable()) { - throw new UserErrorException("Missing required native library dependency: libsignal-client"); - } + handleCommand(command, commandHandler, account, signalAccountFiles); + } - if (command instanceof ProvisioningCommand) { - if (username != null) { - throw new UserErrorException("You cannot specify a username (phone number) when linking"); + private void handleCommand( + final Command command, + final CommandHandler commandHandler, + String account, + final SignalAccountFiles signalAccountFiles + ) throws CommandException { + if (command instanceof ProvisioningCommand provisioningCommand) { + if (account != null) { + throw new UserErrorException("You cannot specify a account (phone number) when linking"); } - handleProvisioningCommand((ProvisioningCommand) command, dataPath, serviceEnvironment); + handleProvisioningCommand(provisioningCommand, signalAccountFiles, commandHandler); return; } - if (username == null) { - var usernames = Manager.getAllLocalUsernames(dataPath); - - if (command instanceof MultiLocalCommand) { - handleMultiLocalCommand((MultiLocalCommand) command, dataPath, serviceEnvironment, usernames); + if (account == null) { + if (command instanceof MultiLocalCommand multiLocalCommand) { + handleMultiLocalCommand(multiLocalCommand, signalAccountFiles, commandHandler); return; } - if (usernames.size() == 0) { - throw new UserErrorException("No local users found, you first need to register or link an account"); - } else if (usernames.size() > 1) { - throw new UserErrorException( - "Multiple users found, you need to specify a username (phone number) with -u"); - } + account = getAccountIfOnlyOne(signalAccountFiles); + } else if (!Manager.isValidNumber(account, null)) { + throw new UserErrorException("Invalid account (phone number), make sure you include the country code."); + } - username = usernames.get(0); - } else if (!PhoneNumberFormatter.isValidNumber(username, null)) { - throw new UserErrorException("Invalid username (phone number), make sure you include the country code."); + if (command instanceof RegistrationCommand registrationCommand) { + handleRegistrationCommand(registrationCommand, account, signalAccountFiles, commandHandler); + return; } - if (command instanceof RegistrationCommand) { - handleRegistrationCommand((RegistrationCommand) command, username, dataPath, serviceEnvironment); + if (command instanceof LocalCommand localCommand) { + handleLocalCommand(localCommand, account, signalAccountFiles, commandHandler); return; } - if (!(command instanceof LocalCommand)) { - throw new UserErrorException("Command only works via dbus"); + throw new UserErrorException("Command only works in multi-account mode"); + } + + private static String getAccountIfOnlyOne(final SignalAccountFiles signalAccountFiles) throws IOErrorException, UserErrorException { + Set accounts; + try { + accounts = signalAccountFiles.getAllLocalAccountNumbers(); + } catch (IOException e) { + throw new IOErrorException("Failed to load local accounts file", e); + } + if (accounts.isEmpty()) { + throw new UserErrorException("No local users found, you first need to register or link an account"); + } else if (accounts.size() > 1) { + throw new UserErrorException("Multiple users found, you need to specify an account (phone number) with -a"); } + return accounts.stream().findFirst().get(); + } - handleLocalCommand((LocalCommand) command, username, dataPath, serviceEnvironment); + private OutputWriter getOutputWriter(final Command command) throws UserErrorException { + final var outputTypeInput = ns.get("output"); + final var outputType = outputTypeInput == null ? command.getSupportedOutputTypes() + .stream() + .findFirst() + .orElse(null) : outputTypeInput; + final var writer = new BufferedWriter(new OutputStreamWriter(System.out, IOUtils.getConsoleCharset())); + final var outputWriter = outputType == null + ? null + : outputType == OutputType.JSON ? new JsonWriterImpl(writer) : new PlainTextWriterImpl(writer); + + if (outputWriter != null && !command.getSupportedOutputTypes().contains(outputType)) { + throw new UserErrorException("Command doesn't support output type " + outputType); + } + return outputWriter; + } + + private SignalAccountFiles loadSignalAccountFiles() throws IOErrorException { + final File configPath; + final var config = ns.getString("config"); + if (config != null) { + configPath = new File(config); + } else { + configPath = getDefaultConfigPath(); + } + + final var serviceEnvironmentCli = ns.get("service-environment"); + final var serviceEnvironment = serviceEnvironmentCli == ServiceEnvironmentCli.LIVE + ? ServiceEnvironment.LIVE + : ServiceEnvironment.STAGING; + + final var trustNewIdentityCli = ns.get("trust-new-identities"); + final var trustNewIdentity = trustNewIdentityCli == TrustNewIdentityCli.ON_FIRST_USE + ? TrustNewIdentity.ON_FIRST_USE + : trustNewIdentityCli == TrustNewIdentityCli.ALWAYS ? TrustNewIdentity.ALWAYS : TrustNewIdentity.NEVER; + + final var disableSendLog = Boolean.TRUE.equals(ns.getBoolean("disable-send-log")); + + try { + return new SignalAccountFiles(configPath, + serviceEnvironment, + BaseConfig.USER_AGENT, + new Settings(trustNewIdentity, disableSendLog)); + } catch (IOException e) { + throw new IOErrorException("Failed to read local accounts list", e); + } } private void handleProvisioningCommand( - final ProvisioningCommand command, final File dataPath, final ServiceEnvironment serviceEnvironment + final ProvisioningCommand command, + final SignalAccountFiles signalAccountFiles, + final CommandHandler commandHandler ) throws CommandException { - var pm = ProvisioningManager.init(dataPath, serviceEnvironment, BaseConfig.USER_AGENT); - command.handleCommand(ns, pm); + var pm = signalAccountFiles.initProvisioningManager(); + commandHandler.handleProvisioningCommand(command, pm); } private void handleRegistrationCommand( final RegistrationCommand command, - final String username, - final File dataPath, - final ServiceEnvironment serviceEnvironment + final String account, + final SignalAccountFiles signalAccountFiles, + final CommandHandler commandHandler ) throws CommandException { - final RegistrationManager manager; - try { - manager = RegistrationManager.init(username, dataPath, serviceEnvironment, BaseConfig.USER_AGENT); - } catch (Throwable e) { - throw new UnexpectedErrorException("Error loading or creating state file: " - + e.getMessage() - + " (" - + e.getClass().getSimpleName() - + ")"); - } - try (var m = manager) { - command.handleCommand(ns, m); + try (final var rm = loadRegistrationManager(account, signalAccountFiles)) { + commandHandler.handleRegistrationCommand(command, rm); } catch (IOException e) { logger.warn("Cleanup failed", e); } @@ -203,131 +270,89 @@ public class App { private void handleLocalCommand( final LocalCommand command, - final String username, - final File dataPath, - final ServiceEnvironment serviceEnvironment + final String account, + final SignalAccountFiles signalAccountFiles, + final CommandHandler commandHandler ) throws CommandException { - try (var m = loadManager(username, dataPath, serviceEnvironment)) { - command.handleCommand(ns, m); - } catch (IOException e) { - logger.warn("Cleanup failed", e); + try (var m = loadManager(account, signalAccountFiles)) { + commandHandler.handleLocalCommand(command, m); } } private void handleMultiLocalCommand( final MultiLocalCommand command, - final File dataPath, - final ServiceEnvironment serviceEnvironment, - final List usernames + final SignalAccountFiles signalAccountFiles, + final CommandHandler commandHandler ) throws CommandException { - final var managers = new ArrayList(); - for (String u : usernames) { - try { - managers.add(loadManager(u, dataPath, serviceEnvironment)); - } catch (CommandException e) { - logger.warn("Ignoring {}: {}", u, e.getMessage()); - } + try (var multiAccountManager = signalAccountFiles.initMultiAccountManager()) { + commandHandler.handleMultiLocalCommand(command, multiAccountManager); + } catch (IOException e) { + throw new IOErrorException("Failed to load local accounts file", e); } + } - command.handleCommand(ns, managers); - - for (var m : managers) { - try { - m.close(); - } catch (IOException e) { - logger.warn("Cleanup failed", e); - } + private RegistrationManager loadRegistrationManager( + final String account, final SignalAccountFiles signalAccountFiles + ) throws UnexpectedErrorException { + try { + return signalAccountFiles.initRegistrationManager(account); + } catch (Throwable e) { + throw new UnexpectedErrorException("Error loading or creating state file: " + + e.getMessage() + + " (" + + e.getClass().getSimpleName() + + ")", e); } } private Manager loadManager( - final String username, final File dataPath, final ServiceEnvironment serviceEnvironment + final String account, final SignalAccountFiles signalAccountFiles ) throws CommandException { - Manager manager; + logger.trace("Loading account file for {}", account); try { - manager = Manager.init(username, dataPath, serviceEnvironment, BaseConfig.USER_AGENT); + return signalAccountFiles.initManager(account); } catch (NotRegisteredException e) { - throw new UserErrorException("User " + username + " is not registered."); + throw new UserErrorException("User " + account + " is not registered."); + } catch (AccountCheckException ace) { + if (ace.getCause() instanceof IOException e) { + throw new IOErrorException("Error while checking account " + account + ": " + e.getMessage(), e); + } else { + throw new UnexpectedErrorException("Error while checking account " + account + ": " + ace.getMessage(), + ace); + } } catch (Throwable e) { - logger.debug("Loading state file failed", e); throw new UnexpectedErrorException("Error loading state file for user " - + username + + account + ": " + e.getMessage() + " (" + e.getClass().getSimpleName() - + ")"); - } - - try { - manager.checkAccountState(); - } catch (IOException e) { - throw new UnexpectedErrorException("Error while checking account " + username + ": " + e.getMessage()); + + ")", e); } - - return manager; } private void initDbusClient( - final Command command, final String username, final boolean systemBus + final Command command, final String account, final boolean systemBus, final CommandHandler commandHandler ) throws CommandException { try { - DBusConnection.DBusBusType busType; - if (systemBus) { - busType = DBusConnection.DBusBusType.SYSTEM; - } else { - busType = DBusConnection.DBusBusType.SESSION; + final var busType = systemBus ? DBusConnection.DBusBusType.SYSTEM : DBusConnection.DBusBusType.SESSION; + try (var dBusConn = DBusConnectionBuilder.forType(busType).build()) { + DbusCommandHandler.handleCommand(command, account, dBusConn, commandHandler); } - try (var dBusConn = DBusConnection.getConnection(busType)) { - var ts = dBusConn.getRemoteObject(DbusConfig.getBusname(), - DbusConfig.getObjectPath(username), - Signal.class); - - handleCommand(command, ts, dBusConn); - } - } catch (DBusException | IOException e) { - logger.error("Dbus client failed", e); - throw new UnexpectedErrorException("Dbus client failed"); - } - } - - private void handleCommand(Command command, Signal ts, DBusConnection dBusConn) throws CommandException { - if (command instanceof ExtendedDbusCommand) { - ((ExtendedDbusCommand) command).handleCommand(ns, ts, dBusConn); - } else if (command instanceof DbusCommand) { - ((DbusCommand) command).handleCommand(ns, ts); - } else { - throw new UserErrorException("Command is not yet implemented via dbus"); + } catch (ServiceUnknown e) { + throw new UserErrorException("signal-cli DBus daemon not running on " + + (systemBus ? "system" : "session") + + " bus: " + + e.getMessage(), e); + } catch (DBusExecutionException | DBusException | IOException e) { + throw new UnexpectedErrorException("Dbus client failed: " + e.getMessage(), e); } } /** - * Uses $XDG_DATA_HOME/signal-cli if it exists, or if none of the legacy directories exist: - * - $HOME/.config/signal - * - $HOME/.config/textsecure - * - * @return the data directory to be used by signal-cli. + * @return the default data directory to be used by signal-cli. */ - private static File getDefaultDataPath() { - var dataPath = new File(IOUtils.getDataHomeDir(), "signal-cli"); - if (dataPath.exists()) { - return dataPath; - } - - var configPath = new File(System.getProperty("user.home"), ".config"); - - var legacySettingsPath = new File(configPath, "signal"); - if (legacySettingsPath.exists()) { - logger.warn("Using legacy data path \"{}\", please move it to \"{}\".", legacySettingsPath, dataPath); - return legacySettingsPath; - } - - legacySettingsPath = new File(configPath, "textsecure"); - if (legacySettingsPath.exists()) { - logger.warn("Using legacy data path \"{}\", please move it to \"{}\".", legacySettingsPath, dataPath); - return legacySettingsPath; - } - - return dataPath; + private static File getDefaultConfigPath() { + return new File(IOUtils.getDataHomeDir(), "signal-cli"); } }