keepassxc/src/cli/Generate.cpp

/*
 *  Copyright (C) 2018 KeePassXC Team <team@keepassxc.org>
 *
 *  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
 *  the Free Software Foundation, either version 2 or (at your option)
 *  version 3 of the License.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <cstdlib>
#include <stdio.h>

#include "Generate.h"
#include "cli/Utils.h"

#include <QCommandLineParser>
#include <QTextStream>

#include "core/PasswordGenerator.h"

Generate::Generate()
{
    name = QString("generate");
    description = QObject::tr("Generate a new random password.");
}

Generate::~Generate()
{
}

int Generate::execute(const QStringList& arguments)
{
    QTextStream in(Utils::STDIN, QIODevice::ReadOnly);
    QTextStream out(Utils::STDOUT, QIODevice::WriteOnly);
    out.setCodec("UTF-8");  // force UTF-8 to prevent ??? characters in extended-ASCII passwords

    QCommandLineParser parser;
    parser.setApplicationDescription(description);
    QCommandLineOption len(QStringList() << "L" << "length",
                           QObject::tr("Length of the generated password"),
                           QObject::tr("length"));
    parser.addOption(len);
    QCommandLineOption lower(QStringList() << "l" << "lower",
                             QObject::tr("Use lowercase characters"));
    parser.addOption(lower);
    QCommandLineOption upper(QStringList() << "u" << "upper",
                             QObject::tr("Use uppercase characters"));
    parser.addOption(upper);
    QCommandLineOption numeric(QStringList() << "n" << "numeric",
                               QObject::tr("Use numbers."));
    parser.addOption(numeric);
    QCommandLineOption special(QStringList() << "s" << "special",
                               QObject::tr("Use special characters"));
    parser.addOption(special);
    QCommandLineOption extended(QStringList() << "e" << "extended",
                                QObject::tr("Use extended ASCII"));
    parser.addOption(extended);
    QCommandLineOption exclude(QStringList() << "x" << "exclude",
                               QObject::tr("Exclude character set"),
                               QObject::tr("chars"));
    parser.addOption(exclude);
    QCommandLineOption exclude_similar(QStringList() << "exclude-similar",
                                       QObject::tr("Exclude similar looking characters"));
    parser.addOption(exclude_similar);
    QCommandLineOption every_group(QStringList() << "every-group",
                                   QObject::tr("Include characters from every selected group"));
    parser.addOption(every_group);
    parser.addHelpOption();
    parser.process(arguments);

    const QStringList args = parser.positionalArguments();
    if (!args.isEmpty()) {
        out << parser.helpText().replace("keepassxc-cli", "keepassxc-cli generate");
        return EXIT_FAILURE;
    }

    PasswordGenerator passwordGenerator;

    if (parser.value(len).isEmpty()) {
        passwordGenerator.setLength(PasswordGenerator::DefaultLength);
    } else {
        int length = parser.value(len).toInt();
        passwordGenerator.setLength(static_cast<size_t>(length));
    }

    PasswordGenerator::CharClasses classes = 0x0;

    if (parser.isSet(lower)) {
        classes |= PasswordGenerator::LowerLetters;
    }
    if (parser.isSet(upper)) {
        classes |= PasswordGenerator::UpperLetters;
    }
    if (parser.isSet(numeric)) {
        classes |= PasswordGenerator::Numbers;
    }
    if (parser.isSet(special)) {
        classes |= PasswordGenerator::SpecialCharacters;
    }
    if (parser.isSet(extended)) {
        classes |= PasswordGenerator::EASCII;
    }

    PasswordGenerator::GeneratorFlags flags = 0x0;

    if (parser.isSet(exclude_similar)) {
        flags |= PasswordGenerator::ExcludeLookAlike;
    }
    if (parser.isSet(every_group)) {
        flags |= PasswordGenerator::CharFromEveryGroup;
    }

    passwordGenerator.setCharClasses(classes);
    passwordGenerator.setFlags(flags);
    passwordGenerator.setExcludedChars(parser.value(exclude));

    if (!passwordGenerator.isValid()) {
        out << parser.helpText().replace("keepassxc-cli", "keepassxc-cli generate");
        return EXIT_FAILURE;
    }

    QString password = passwordGenerator.generatePassword();
    out << password << endl;

    return EXIT_SUCCESS;
}