DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Header

Mercurial (6863f516ba38)

VCS Links

Line Code
1 2 3 4 5 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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 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 179 180 181 182 183 184 185 186 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 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsKeygenThread.h"

#include "mozilla/Assertions.h"
#include "mozilla/DebugOnly.h"

#include "GeckoProfiler.h"
#include "PSMRunnable.h"
#include "nsCOMPtr.h"
#include "nsIObserver.h"
#include "nsThreadUtils.h"
#include "pk11func.h"

using namespace mozilla;
using namespace mozilla::psm;

NS_IMPL_ISUPPORTS(nsKeygenThread, nsIKeygenThread)

nsKeygenThread::nsKeygenThread()
    : mutex("nsKeygenThread.mutex"),
      iAmRunning(false),
      keygenReady(false),
      statusDialogClosed(false),
      alreadyReceivedParams(false),
      privateKey(nullptr),
      publicKey(nullptr),
      slot(nullptr),
      flags(0),
      altSlot(nullptr),
      altFlags(0),
      usedSlot(nullptr),
      keyGenMechanism(0),
      params(nullptr),
      wincx(nullptr),
      threadHandle(nullptr) {}

nsKeygenThread::~nsKeygenThread() {
  // clean up in the unlikely case that nobody consumed our results

  if (privateKey) SECKEY_DestroyPrivateKey(privateKey);

  if (publicKey) SECKEY_DestroyPublicKey(publicKey);

  if (usedSlot) PK11_FreeSlot(usedSlot);
}

void nsKeygenThread::SetParams(PK11SlotInfo* a_slot, PK11AttrFlags a_flags,
                               PK11SlotInfo* a_alternative_slot,
                               PK11AttrFlags a_alternative_flags,
                               uint32_t a_keyGenMechanism, void* a_params,
                               void* a_wincx) {
  MutexAutoLock lock(mutex);

  if (!alreadyReceivedParams) {
    alreadyReceivedParams = true;
    slot = (a_slot) ? PK11_ReferenceSlot(a_slot) : nullptr;
    flags = a_flags;
    altSlot =
        (a_alternative_slot) ? PK11_ReferenceSlot(a_alternative_slot) : nullptr;
    altFlags = a_alternative_flags;
    keyGenMechanism = a_keyGenMechanism;
    params = a_params;
    wincx = a_wincx;
  }
}

nsresult nsKeygenThread::ConsumeResult(PK11SlotInfo** a_used_slot,
                                       SECKEYPrivateKey** a_privateKey,
                                       SECKEYPublicKey** a_publicKey) {
  if (!a_used_slot || !a_privateKey || !a_publicKey) {
    return NS_ERROR_FAILURE;
  }

  nsresult rv;

  MutexAutoLock lock(mutex);

  // GetParams must not be called until thread creator called
  // Join on this thread.
  MOZ_ASSERT(keygenReady, "Logic error in nsKeygenThread::GetParams");

  if (keygenReady) {
    *a_privateKey = privateKey;
    *a_publicKey = publicKey;
    *a_used_slot = usedSlot;

    privateKey = 0;
    publicKey = 0;
    usedSlot = 0;

    rv = NS_OK;
  } else {
    rv = NS_ERROR_FAILURE;
  }

  return rv;
}

static void nsKeygenThreadRunner(void* arg) {
  AUTO_PROFILER_REGISTER_THREAD("Keygen");
  NS_SetCurrentThreadName("Keygen");
  nsKeygenThread* self = static_cast<nsKeygenThread*>(arg);
  self->Run();
}

nsresult nsKeygenThread::StartKeyGeneration(nsIObserver* aObserver) {
  if (!NS_IsMainThread()) {
    NS_ERROR("nsKeygenThread::StartKeyGeneration called off the main thread");
    return NS_ERROR_NOT_SAME_THREAD;
  }

  if (!aObserver) return NS_OK;

  MutexAutoLock lock(mutex);

  if (iAmRunning || keygenReady) {
    return NS_OK;
  }

  // We must AddRef aObserver only here on the main thread, because it
  // probably does not implement a thread-safe AddRef.
  mNotifyObserver = new NotifyObserverRunnable(aObserver, "keygen-finished");

  iAmRunning = true;

  threadHandle = PR_CreateThread(PR_USER_THREAD, nsKeygenThreadRunner,
                                 static_cast<void*>(this), PR_PRIORITY_NORMAL,
                                 PR_GLOBAL_THREAD, PR_JOINABLE_THREAD, 0);

  // bool thread_started_ok = (threadHandle != nullptr);
  // we might want to return "thread started ok" to caller in the future
  MOZ_ASSERT(threadHandle, "Could not create nsKeygenThreadRunner thread");
  return NS_OK;
}

nsresult nsKeygenThread::UserCanceled(bool* threadAlreadyClosedDialog) {
  if (!threadAlreadyClosedDialog) return NS_OK;

  *threadAlreadyClosedDialog = false;

  MutexAutoLock lock(mutex);

  if (keygenReady) *threadAlreadyClosedDialog = statusDialogClosed;

  // User somehow closed the dialog, but we will not cancel.
  // Bad luck, we told him not do, and user still has to wait.
  // However, we remember that it's closed and will not close
  // it again to avoid problems.
  statusDialogClosed = true;

  return NS_OK;
}

void nsKeygenThread::Run(void) {
  bool canGenerate = false;

  {
    MutexAutoLock lock(mutex);
    if (alreadyReceivedParams) {
      canGenerate = true;
      keygenReady = false;
    }
  }

  if (canGenerate) {
    privateKey = PK11_GenerateKeyPairWithFlags(slot, keyGenMechanism, params,
                                               &publicKey, flags, wincx);

    if (privateKey) {
      usedSlot = PK11_ReferenceSlot(slot);
    } else if (altSlot) {
      privateKey = PK11_GenerateKeyPairWithFlags(
          altSlot, keyGenMechanism, params, &publicKey, altFlags, wincx);
      if (privateKey) {
        usedSlot = PK11_ReferenceSlot(altSlot);
      }
    }
  }

  // This call gave us ownership over privateKey and publicKey.
  // But as the params structure is owner by our caller,
  // we effectively transferred ownership to the caller.
  // As long as key generation can't be canceled, we don't need
  // to care for cleaning this up.

  nsCOMPtr<nsIRunnable> notifyObserver;
  {
    MutexAutoLock lock(mutex);

    keygenReady = true;
    iAmRunning = false;

    // forget our parameters
    if (slot) {
      PK11_FreeSlot(slot);
      slot = 0;
    }
    if (altSlot) {
      PK11_FreeSlot(altSlot);
      altSlot = 0;
    }
    keyGenMechanism = 0;
    params = 0;
    wincx = 0;

    if (!statusDialogClosed && mNotifyObserver)
      notifyObserver = mNotifyObserver;

    mNotifyObserver = nullptr;
  }

  if (notifyObserver) {
    DebugOnly<nsresult> rv = NS_DispatchToMainThread(notifyObserver);
    MOZ_ASSERT(NS_SUCCEEDED(rv),
               "Failed to dispatch keygen thread observer to main thread");
  }
}

void nsKeygenThread::Join() {
  if (!threadHandle) return;

  PR_JoinThread(threadHandle);
  threadHandle = nullptr;
}