crypto/crypto_module_blocking_password_delegate.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CRYPTO_CRYPTO_MODULE_BLOCKING_PASSWORD_DELEGATE_H_
   6 #define CRYPTO_CRYPTO_MODULE_BLOCKING_PASSWORD_DELEGATE_H_
   7
   8 #include <string>
   9
  10 namespace crypto {
  11
  12 // PK11_SetPasswordFunc is a global setting.  An implementation of
  13 // CryptoModuleBlockingPasswordDelegate should be passed as the user data
  14 // argument (|wincx|) to relevant NSS functions, which the global password
  15 // handler will call to do the actual work.
  16 class CryptoModuleBlockingPasswordDelegate {
  17  public:
  18   virtual ~CryptoModuleBlockingPasswordDelegate() {}
  19
  20   // Requests a password to unlock |slot_name|. The interface is
  21   // synchronous because NSS cannot issue an asynchronous
  22   // request. |retry| is true if this is a request for the retry
  23   // and we previously returned the wrong password.
  24   // The implementation should set |*cancelled| to true if the user cancelled
  25   // instead of entering a password, otherwise it should return the password the
  26   // user entered.
  27   virtual std::string RequestPassword(const std::string& slot_name, bool retry,
  28                                       bool* cancelled) = 0;
  29 };
  30
  31 }  // namespace crypto
  32
  33 #endif  // CRYPTO_CRYPTO_MODULE_BLOCKING_PASSWORD_DELEGATE_H_