Extract ScopedTestNSSDB from nss_util.

crypto/nss_util_internal.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CRYPTO_NSS_UTIL_INTERNAL_H_
 #define CRYPTO_NSS_UTIL_INTERNAL_H_
 
 #include <secmodt.h>
 
 #include "base/callback.h"
 #include "base/compiler_specific.h"
 #include "crypto/crypto_export.h"
 #include "crypto/scoped_nss_types.h"
 
 namespace base {
 class FilePath;
 }
 
 // These functions return a type defined in an NSS header, and so cannot be
 // declared in nss_util.h.  Hence, they are declared here.
 
 namespace crypto {
 
+// Opens an NSS software database in folder |path|, with the (potentially)
+// user-visible description |description|. Returns the slot for the opened
+// database, or NULL if the database could not be opened.
+CRYPTO_EXPORT_PRIVATE ScopedPK11Slot
+    OpenSoftwareNSSDB(const base::FilePath& path,
+                      const std::string& description);
+
+#if !defined(OS_CHROMEOS)
 // Returns a reference to the default NSS key slot for storing persistent data.
 // Caller must release returned reference with PK11_FreeSlot.
-// TODO(mattm): this should be if !defined(OS_CHROMEOS), but some tests need to
-// be fixed first.
 CRYPTO_EXPORT PK11SlotInfo* GetPersistentNSSKeySlot() WARN_UNUSED_RESULT;
+#endif
 
 // A helper class that acquires the SECMOD list read lock while the
 // AutoSECMODListReadLock is in scope.
 class CRYPTO_EXPORT AutoSECMODListReadLock {
  public:
   AutoSECMODListReadLock();
   ~AutoSECMODListReadLock();
 
  private:
   SECMODListLock* lock_;
   DISALLOW_COPY_AND_ASSIGN(AutoSECMODListReadLock);
 };
 
 #if defined(OS_CHROMEOS)
-// Returns a reference to the system-wide TPM slot.  Caller must release
-// returned reference with PK11_FreeSlot.
+// Returns a reference to the system-wide TPM slot. Caller must release returned
+// reference with PK11_FreeSlot.
 CRYPTO_EXPORT PK11SlotInfo* GetSystemNSSKeySlot() WARN_UNUSED_RESULT;
 
+// Sets the test system slot. If this was called before
+// InitializeTPMTokenAndSystemSlot and no system token is provided by the Chaps
+// module, then this test slot will be used and the initialization continues as
+// if Chaps had provided this test slot. In particular, |slot| will be exposed
+// by |GetSystemNSSKeySlot| and |IsTPMTokenReady| will return true.
+// This must must not be called consecutively with a |slot| != NULL. If |slot|
+// is NULL, the test system slot is unset.

[Ryan Sleevi, 2014/07/24 23:14:02]

To confirm:

Is the following valid

Set(!=NULL)
Set(NULL)
Set(!=NULL) ?

[pneubeck (no reviews), 2014/07/25 08:35:14]

In principal yes. Although, in tests nobody should ever have need for this.
The Scoped helper should be used anyways.

+CRYPTO_EXPORT_PRIVATE void SetSystemKeySlotForTesting(ScopedPK11Slot slot);
+
 // Prepare per-user NSS slot mapping. It is safe to call this function multiple
 // times. Returns true if the user was added, or false if it already existed.
 CRYPTO_EXPORT bool InitializeNSSForChromeOSUser(
     const std::string& email,
     const std::string& username_hash,
     const base::FilePath& path);
 
 // Returns whether TPM for ChromeOS user still needs initialization. If
 // true is returned, the caller can proceed to initialize TPM slot for the
 // user, but should call |WillInitializeTPMForChromeOSUser| first.
@@ skipping 21 matching lines @@
 // Returns a reference to the public slot for user.
 CRYPTO_EXPORT ScopedPK11Slot GetPublicSlotForChromeOSUser(
     const std::string& username_hash) WARN_UNUSED_RESULT;
 
 // Returns the private slot for |username_hash| if it is loaded. If it is not
 // loaded and |callback| is non-null, the |callback| will be run once the slot
 // is loaded.
 CRYPTO_EXPORT ScopedPK11Slot GetPrivateSlotForChromeOSUser(
     const std::string& username_hash,
     const base::Callback<void(ScopedPK11Slot)>& callback) WARN_UNUSED_RESULT;
+
+// Closes the NSS DB for |username_hash| that was previously opened by the
+// *Initialize*ForChromeOSUser functions.
+CRYPTO_EXPORT_PRIVATE void CloseChromeOSUserForTesting(
+    const std::string& username_hash);
 #endif  // defined(OS_CHROMEOS)
 
 }  // namespace crypto
 
 #endif  // CRYPTO_NSS_UTIL_INTERNAL_H_