blackberrysetupwizard.cpp 16.1 KB
Newer Older
1 2
/**************************************************************************
**
3
** Copyright (C) 2013 BlackBerry Limited. All rights reserved.
4
**
5
** Contact: BlackBerry (qt@blackberry.com)
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
** Contact: KDAB (info@kdab.com)
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "blackberrysetupwizard.h"
#include "blackberrysetupwizardpages.h"
#include "blackberrydeviceconfiguration.h"
#include "blackberrycertificate.h"
36
#include "blackberryconfigurationmanager.h"
37 38 39
#include "blackberrydebugtokenrequester.h"
#include "blackberrydebugtokenuploader.h"
#include "blackberrydeviceinformation.h"
40
#include "blackberrysigningutils.h"
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
#include "qnxconstants.h"

#include <projectexplorer/devicesupport/devicemanager.h>
#include <projectexplorer/devicesupport/idevice.h>
#include <ssh/sshconnection.h>
#include <ssh/sshkeygenerator.h>
#include <utils/fileutils.h>
#include <coreplugin/icore.h>

#include <QDir>
#include <QMessageBox>
#include <QHostInfo>
#include <QAbstractButton>

using namespace ProjectExplorer;
using namespace Qnx;
using namespace Qnx::Internal;

BlackBerrySetupWizard::BlackBerrySetupWizard(QWidget *parent) :
60
    Utils::Wizard(parent),
61 62
    m_ndkPage(0),
    m_keysPage(0),
63
    m_certificatePage(0),
64 65 66 67 68
    m_devicePage(0),
    m_certificate(0),
    m_deviceInfo(0),
    m_requester(0),
    m_uploader(0),
69
    m_utils(BlackBerrySigningUtils::instance()),
70 71 72 73 74 75 76 77 78 79
    m_keyGenerator(0),
    m_currentStep(-1),
    m_stepOffset(0)
{
    setWindowTitle(tr("BlackBerry Development Environment Setup Wizard"));
    setOption(QWizard::IndependentPages, true);

    m_welcomePage = new BlackBerrySetupWizardWelcomePage(this);
    m_ndkPage = new BlackBerrySetupWizardNdkPage(this);
    m_keysPage = new BlackBerrySetupWizardKeysPage(this);
80
    m_certificatePage = new BlackBerrySetupWizardCertificatePage(this);
81 82 83 84 85 86
    m_devicePage = new BlackBerrySetupWizardDevicePage(this);
    m_finishPage = new BlackBerrySetupWizardFinishPage(this);

    setPage(WelcomePageId, m_welcomePage);
    setPage(NdkPageId, m_ndkPage);
    setPage(KeysPageId, m_keysPage);
87
    setPage(CertificatePageId, m_certificatePage);
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    setPage(DevicePageId, m_devicePage);
    setPage(FinishPageId, m_finishPage);

    m_deviceInfo = new BlackBerryDeviceInformation(this);
    m_requester = new BlackBerryDebugTokenRequester(this);
    m_uploader = new BlackBerryDebugTokenUploader(this);
    m_keyGenerator = new QSsh::SshKeyGenerator;

    connect(m_deviceInfo, SIGNAL(finished(int)),
            this, SLOT(deviceInfoFinished(int)));
    connect(m_requester, SIGNAL(finished(int)),
            this, SLOT(debugTokenArrived(int)));
    connect(m_uploader, SIGNAL(finished(int)),
            this, SLOT(uploaderFinished(int)));
    connect(this, SIGNAL(stepFinished()),
            this, SLOT(processNextStep()));

    registerStep("requestDevicePin", tr("Reading device PIN..."));
    registerStep("generateDeveloperCertificate", tr("Generating developer certificate..."));
    registerStep("generateSshKeys", tr("Generating SSH keys..."));
    registerStep("requestDebugToken", tr("Requesting a debug token for the device..."));
    registerStep("uploadDebugToken", tr("Now uploading the debug token..."));
    registerStep("writeDeviceInformation", tr("Writing device information..."));
}

BlackBerrySetupWizard::~BlackBerrySetupWizard()
{
    delete m_keyGenerator;

    foreach (Step *s, m_stepList)
        delete s;

    m_stepList.clear();
}

void BlackBerrySetupWizard::accept()
{
    setBusy(true);
    processNextStep();
}

void BlackBerrySetupWizard::processNextStep()
{
    m_currentStep++;

    if (m_currentStep >= m_stepList.size())
        return;

    const Step *step = m_stepList.at(m_currentStep);

    m_finishPage->setProgress(step->message, m_currentStep * m_stepOffset);
    QMetaObject::invokeMethod(this, step->slot);
}

void BlackBerrySetupWizard::deviceInfoFinished(int status)
{
    const QString errorString = tr("Error reading device PIN. "
            "Please make sure that the specified device IP address is correct.");

    if (status != BlackBerryDeviceInformation::Success) {
        QMessageBox::critical(this, tr("Error"), errorString);
        reset();
        return;
    }

    m_devicePin = m_deviceInfo->devicePin();

    if (m_devicePin.isEmpty()) {
        QMessageBox::critical(this, tr("Error"), errorString);
        reset();
        return;
    }

    emit stepFinished();
}

void BlackBerrySetupWizard::certificateCreated(int status)
{
    if (status == BlackBerryCertificate::Error) {
        QMessageBox::critical(this, tr("Error"), tr("Error creating developer certificate."));
        m_certificate->deleteLater();
        m_certificate = 0;
        reset();
        return;
    }

    emit stepFinished();
}

void BlackBerrySetupWizard::debugTokenArrived(int status)
{
179
    QString errorString = tr("Failed to request debug token:") + QLatin1Char(' ');
180 181 182 183 184 185

    switch (status) {
    case BlackBerryDebugTokenRequester::Success:
        emit stepFinished();
        return;
    case BlackBerryDebugTokenRequester::WrongCskPassword:
186
        m_utils.clearCskPassword();
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
        errorString += tr("Wrong CSK password.");
        break;
    case BlackBerryDebugTokenRequester::WrongKeystorePassword:
        errorString += tr("Wrong keystore password.");
        break;
    case BlackBerryDebugTokenRequester::NetworkUnreachable:
        errorString += tr("Network unreachable.");
        break;
    case BlackBerryDebugTokenRequester::IllegalPin:
        errorString += tr("Illegal device PIN.");
        break;
    case BlackBerryDebugTokenRequester::FailedToStartInferiorProcess:
        errorString += tr("Failed to start inferior process.");
        break;
    case BlackBerryDebugTokenRequester::InferiorProcessTimedOut:
        errorString += tr("Inferior processes timed out.");
        break;
    case BlackBerryDebugTokenRequester::InferiorProcessCrashed:
        errorString += tr("Inferior process has crashed.");
        break;
    case BlackBerryDebugTokenRequester::InferiorProcessReadError:
    case BlackBerryDebugTokenRequester::InferiorProcessWriteError:
        errorString += tr("Failed to communicate with the inferior process.");
        break;
    case BlackBerryDebugTokenRequester::UnknownError:
212 213
    default:
        m_utils.clearCskPassword();
214 215 216 217
        errorString += tr("An unknwon error has occurred.");
        break;
    }

218 219 220 221 222 223 224
    BlackBerryConfigurationManager &configuration = BlackBerryConfigurationManager::instance();

    QFile dt(configuration.defaultKeystorePath());

    if (dt.exists())
        dt.remove();

225 226 227 228 229 230 231
    QMessageBox::critical(this, tr("Error"), errorString);

    reset();
}

void BlackBerrySetupWizard::uploaderFinished(int status)
{
232
    QString errorString = tr("Failed to upload debug token:") + QLatin1Char(' ');
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

    switch (status) {
    case BlackBerryDebugTokenUploader::Success:
        emit stepFinished();
        return;
    case BlackBerryDebugTokenUploader::NoRouteToHost:
        errorString += tr("No route to host.");
        break;
    case BlackBerryDebugTokenUploader::AuthenticationFailed:
        errorString += tr("Authentication failed.");
        break;
    case BlackBerryDebugTokenUploader::DevelopmentModeDisabled:
        errorString += tr("Development mode is disabled on the device.");
        break;
    case BlackBerryDebugTokenUploader::FailedToStartInferiorProcess:
        errorString += tr("Failed to start inferior process.");
        break;
    case BlackBerryDebugTokenUploader::InferiorProcessTimedOut:
        errorString += tr("Inferior processes timed out.");
        break;
    case BlackBerryDebugTokenUploader::InferiorProcessCrashed:
        errorString += tr("Inferior process has crashed.");
        break;
    case BlackBerryDebugTokenUploader::InferiorProcessReadError:
    case BlackBerryDebugTokenUploader::InferiorProcessWriteError:
        errorString += tr("Failed to communicate with the inferior process.");
        break;
    case BlackBerryDebugTokenUploader::UnknownError:
        errorString += tr("An unknwon error has happened.");
        break;
    }

    QMessageBox::critical(this, tr("Error"), errorString);

    reset();
}

void BlackBerrySetupWizard::registerStep(const QByteArray &slot, const QString &message)
{
    Step *s = new Step;
    s->slot = slot;
    s->message = message;
    m_stepList << s;

    m_stepOffset = 100/m_stepList.size();
}

void BlackBerrySetupWizard::setBusy(bool busy)
{
    button(QWizard::BackButton)->setEnabled(!busy);
    button(QWizard::NextButton)->setEnabled(!busy);
    button(QWizard::FinishButton)->setEnabled(!busy);
    button(QWizard::CancelButton)->setEnabled(!busy);

    if (!busy)
        m_finishPage->setProgress(QString(), -1);
}

void BlackBerrySetupWizard::cleanupFiles() const
{
293
    BlackBerryConfigurationManager &configuration = BlackBerryConfigurationManager::instance();
294

295
    QFile f;
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318

    f.setFileName(configuration.defaultKeystorePath());
    f.remove();

    f.setFileName(configuration.defaultDebugTokenPath());
    f.remove();

    f.setFileName(privateKeyPath());
    f.remove();

    f.setFileName(publicKeyPath());
    f.remove();

    QDir::root().rmpath(storeLocation());
}

void BlackBerrySetupWizard::reset()
{
    cleanupFiles();
    setBusy(false);
    m_currentStep = -1;

    if (m_certificate) {
319
        m_certificate->deleteLater();
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
        m_certificate = 0;
    }
}

void BlackBerrySetupWizard::requestDevicePin()
{
    if (!isPhysicalDevice()) {
        emit stepFinished();
        return;
    }

    m_deviceInfo->setDeviceTarget(hostName(), devicePassword());
}

void BlackBerrySetupWizard::generateDeveloperCertificate()
{
336
    BlackBerryConfigurationManager &configuration = BlackBerryConfigurationManager::instance();
337 338

    m_certificate = new BlackBerryCertificate(configuration.defaultKeystorePath(),
339
            certificateAuthor(), certificatePassword());
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391

    connect(m_certificate, SIGNAL(finished(int)), this, SLOT(certificateCreated(int)));

    m_certificate->store();
}

void BlackBerrySetupWizard::generateSshKeys()
{
    const bool success = m_keyGenerator->generateKeys(QSsh::SshKeyGenerator::Rsa,
            QSsh::SshKeyGenerator::Mixed, 4096,
            QSsh::SshKeyGenerator::DoNotOfferEncryption);

    if (!success) {
        QMessageBox::critical(this, tr("Key Generation Failed"), m_keyGenerator->error());
        reset();
        return;
    }

    if (!QDir::root().mkpath(storeLocation())) {
        QMessageBox::critical(this, tr("Failure to Save Key File"),
                              tr("Failed to create directory: '%1'.").arg(storeLocation()));
        reset();
        return;
    }

    if (QFileInfo(privateKeyPath()).exists()) {
        QMessageBox::critical(this, tr("Failure to Save Key File"),
                              tr("Private key file already exists: '%1'").arg(privateKeyPath()));
        reset();
        return;
    }

    if (QFileInfo(publicKeyPath()).exists()) {
        QMessageBox::critical(this, tr("Failure to Save Key File"),
                              tr("Public key file already exists: '%1'").arg(publicKeyPath()));
        reset();
        return;
    }

    Utils::FileSaver privateKeySaver(privateKeyPath());
    privateKeySaver.write(m_keyGenerator->privateKey());

    if (!privateKeySaver.finalize(this)) {
        reset();
        return; // finalize shows an error message if necessary
    }

    QFile::setPermissions(privateKeyPath(), QFile::ReadOwner | QFile::WriteOwner);

    Utils::FileSaver publicKeySaver(publicKeyPath());

    // blackberry-connect requires an @ character to be included in the RSA comment
392
    const QString atHost = QLatin1Char('@') + QHostInfo::localHostName();
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
    QByteArray publicKeyContent = m_keyGenerator->publicKey();
    publicKeyContent.append(atHost.toLocal8Bit());

    publicKeySaver.write(publicKeyContent);

    if (!publicKeySaver.finalize(this)) {
        reset();
        return;
    }

    emit stepFinished();
}

void BlackBerrySetupWizard::requestDebugToken()
{
    if (!isPhysicalDevice()) {
        emit stepFinished();
        return;
    }

413
    BlackBerryConfigurationManager &configuration = BlackBerryConfigurationManager::instance();
414

415 416 417 418 419
    bool ok;
    const QString cskPassword = m_utils.cskPassword(this, &ok);
    if (!ok)
        return;

420
    m_requester->requestDebugToken(configuration.defaultDebugTokenPath(),
421
            cskPassword, configuration.defaultKeystorePath(), certificatePassword(), m_devicePin);
422 423 424 425 426 427 428 429 430
}

void BlackBerrySetupWizard::uploadDebugToken()
{
    if (!isPhysicalDevice()) {
        emit stepFinished();
        return;
    }

431
    BlackBerryConfigurationManager &configuration = BlackBerryConfigurationManager::instance();
432 433 434 435 436 437 438 439 440 441

    m_uploader->uploadDebugToken(configuration.defaultDebugTokenPath(),
            hostName(), devicePassword());
}

void BlackBerrySetupWizard::writeDeviceInformation()
{
    DeviceManager * const deviceManager = DeviceManager::instance();
    deviceManager->addDevice(device());

442 443
    m_utils.setDefaultCertificate(m_certificate);

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
    QWizard::accept();
}

QString BlackBerrySetupWizard::privateKeyPath() const
{
    return storeLocation() + QLatin1String("/id_rsa");
}

QString BlackBerrySetupWizard::publicKeyPath() const
{
    return storeLocation() + QLatin1String("/id_rsa.pub");
}

QString BlackBerrySetupWizard::deviceName() const
{
    return field(QLatin1String(BlackBerrySetupWizardDevicePage::NameField)).toString();
}

QString BlackBerrySetupWizard::storeLocation() const
{
    return Core::ICore::userResourcePath() + QLatin1String("/qnx/") + deviceName();
}

467
QString BlackBerrySetupWizard::certificatePassword() const
468
{
469
    return field(QLatin1String(BlackBerrySetupWizardCertificatePage::PasswordField)).toString();
470 471
}

472
QString BlackBerrySetupWizard::certificateAuthor() const
473
{
474
    return field(QLatin1String(BlackBerrySetupWizardCertificatePage::AuthorField)).toString();
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
}

QString BlackBerrySetupWizard::hostName() const
{
    return field(QLatin1String(BlackBerrySetupWizardDevicePage::IpAddressField)).toString();
}

QString BlackBerrySetupWizard::devicePassword() const
{
    return field(QLatin1String(BlackBerrySetupWizardDevicePage::PasswordField)).toString();
}

bool BlackBerrySetupWizard::isPhysicalDevice() const
{
    return field(QLatin1String(BlackBerrySetupWizardDevicePage::PhysicalDeviceField)).toBool();
}

IDevice::Ptr BlackBerrySetupWizard::device()
{
    QSsh::SshConnectionParameters sshParams;
    sshParams.options = QSsh::SshIgnoreDefaultProxy;
    sshParams.host = hostName();
    sshParams.password = devicePassword();
498
    sshParams.authenticationType = QSsh::SshConnectionParameters::AuthenticationTypePublicKey;
499 500 501 502 503 504 505 506 507 508 509
    sshParams.privateKeyFile = privateKeyPath();
    sshParams.userName = QLatin1String("devuser");
    sshParams.timeout = 10;
    sshParams.port = 22;

    IDevice::MachineType machineType = (isPhysicalDevice()) ? IDevice::Hardware : IDevice::Emulator;

    BlackBerryDeviceConfiguration::Ptr configuration = BlackBerryDeviceConfiguration::create(
            deviceName(), Core::Id(Constants::QNX_BB_OS_TYPE), machineType);

    configuration->setSshParameters(sshParams);
510
    configuration->setDebugToken(BlackBerryConfigurationManager::instance().defaultDebugTokenPath());
511 512 513

    return configuration;
}