nubs / pwman

src/Command/Set.php

<?php
namespace Nubs\PwMan\Command;

use Exception;
use GnuPG;
use Nubs\PwMan\PasswordFile;
use Nubs\PwMan\PasswordGenerator;
use Nubs\PwMan\PasswordManager;
use Nubs\Sensible\CommandFactory\EditorFactory;
use Nubs\Which\LocatorFactory\PlatformLocatorFactory as WhichLocatorFactory;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Process\ProcessBuilder;

/**
 * A symonfy console command to set passwords in a password file.
 */
class Set extends Command
{
    /**
     * Configures the command's options.
     *
     * @return void
     */
    protected function configure()
    {
        $this->setName('set')
            ->setDescription('Sets the password for the specified application')
            ->addArgument('password-file', InputArgument::REQUIRED, 'The path to the encrypted password file')
            ->addOption('application', 'a', InputOption::VALUE_REQUIRED, 'The application to configure')
            ->addOption('decrypt-key', 'd', InputOption::VALUE_REQUIRED, 'The uid or fingerprint for the decryption key')
            ->addOption('decrypt-passphrase', 'y', InputOption::VALUE_REQUIRED, 'The passphrase for the decryption key')
            ->addOption('encrypt-key', 'e', InputOption::VALUE_REQUIRED, 'The uid or fingerprint for the encryption key')
            ->addOption('username', 'u', InputOption::VALUE_REQUIRED, 'The username for the application')
            ->addOption('password', 'p', InputOption::VALUE_REQUIRED, 'The password for the application')
            ->addOption('length', 'l', InputOption::VALUE_REQUIRED, 'The length of the random passwords for the application')
            ->addOption('characters', 'c', InputOption::VALUE_REQUIRED, 'The allowed characters to use in randomly generated passwords')
            ->addOption('exclude-characters', 'x', InputOption::VALUE_REQUIRED, 'The characters to exclude from randomly generated passwords');
    }

    /**
     * Sets the password for the specified application.
     *
     * @param \Symfony\Component\Console\Input\InputInterface $input The command input.
     * @param \Symfony\Component\Console\Output\OutputInterface $output The command output.
     * @return int The return status
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $passwordFile = new PasswordFile($input->getArgument('password-file'), new GnuPG());
        $passwordFile->addDecryptKey($input->getOption('decrypt-key') ?: '', $input->getOption('decrypt-passphrase') ?: '');
        $passwords = $passwordFile->getPasswords();
        if ($passwords === null) {
            return $this->_error($output, 'Failed to load passwords from file!');
        }

        $application = $input->getOption('application') ?: '';

        $passwordManager = new PasswordManager($passwords);
        $existingPasswords = $passwordManager->matchingApplication($application);

        $passwordsToEdit = empty($existingPasswords) ? $this->_newPasswordTemplate($input) : $existingPasswords;

        try {
            $passwordManager->replacePasswords($existingPasswords, $this->_alterPasswords($passwordsToEdit));
        } catch (Exception $e) {
            return $this->_error($output, $e->getMessage());
        }

        $passwordFile->addEncryptKey($input->getOption('encrypt-key') ?: '');
        $passwordFile->setPasswords($passwordManager->getPasswords());
    }

    /**
     * Prints an error message and returns the given error code.
     *
     * @param \Symfony\Component\Console\Output\OutputInterface $output The command output.
     * @param string $message The message to output.
     * @param int $code The return status.
     * @return int The return status
     */
    private function _error(OutputInterface $output, $message, $code = 1)

This method seems to be duplicated in your project.

    {
        $stderr = $output instanceof ConsoleOutput ? $output->getErrorOutput() : $output;
        $stderr->writeln("<error>{$message}</error>");

        return $code;
    }

    /**
     * Generates the simple format of a new password using command-line options.
     *
     * @param \Symfony\Component\Console\Input\InputInterface $input The command input.
     * @return array The password template.
     */
    private function _newPasswordTemplate(InputInterface $input)
    {
        $application = $input->getOption('application') ?: '';
        $username = $input->getOption('username') ?: '';
        $password = $input->getOption('password') ?: $this->_generateRandomPassword($input);

        return [$application => ['application' => $application, 'username' => $username, 'password' => $password]];
    }

    /**
     * Alters the passwords with the user's changes returning the passwords to use instead.
     *
     * @param array $passwords The passwords to replace.
     * @return array The new passwords to use instead.
     */
    private function _alterPasswords(array $passwords)
    {
        $commandLocatorFactory = new WhichLocatorFactory();
        $editorFactory = new EditorFactory($commandLocatorFactory->create());
        $editor = $editorFactory->create();

        $updates = json_decode($editor->editData(new ProcessBuilder(), json_encode($passwords, JSON_PRETTY_PRINT | JSON_FORCE_OBJECT)), true);

        if ($updates === null) {
            throw new Exception('Invalid json for application!');
        }

        return $updates;
    }

    /**
     * Generates a random password using the command line options.
     *
     * @param \Symfony\Component\Console\Input\InputInterface $input The command input.
     * @return string A random password.
     */
    private function _generateRandomPassword(InputInterface $input)
    {
        $randomCharacterRange = str_split($input->getOption('characters') ?: PasswordGenerator::defaultCharacters());
        $excludeCharacters = str_split($input->getOption('exclude-characters') ?: []);
        $randomCharacterRange = array_diff($randomCharacterRange, $excludeCharacters);
        $passwordGenerator = new PasswordGenerator(join('', $randomCharacterRange), $input->getOption('length') ?: 32);

        return $passwordGenerator();
    }
}