ProtectKeyWithTPMAndPIN method of the Win32_EncryptableVolume class
The ProtectKeyWithTPMAndPIN method of the Win32_EncryptableVolume class secures the volume's encryption key by using the Trusted Platform Module (TPM) Security Hardware on the computer, if available, enhanced by a user-specified personal identification number (PIN) that must be provided to the computer at startup.
Both validation by the TPM and input of the personal identification string are necessary to access the volume's encryption key and unlock volume contents.
This method is only applicable for the volume that contains the currently running operating system.
A key protector of type "TPM And PIN" is created for the volume, if one does not already exist.
Syntax
uint32 ProtectKeyWithTPMAndPIN(
[in, optional] string FriendlyName,
[in, optional] uint8 PlatformValidationProfile[],
[in] string PIN,
[out] string VolumeKeyProtectorID
);
Parameters
-
FriendlyName [in, optional]
-
Type: string
A user-assigned string identifier for this key protector. If this parameter is not specified, a blank value is used.
-
PlatformValidationProfile [in, optional]
-
Type: uint8[]
An array of integers that specifies how the computer's Trusted Platform Module (TPM) Security Hardware secures the disk volume's encryption key.
A platform validation profile consists of a set of Platform Configuration Register (PCR) indices ranging from 0 to 23, inclusive. Repeat values in the parameter are ignored. Each PCR index is associated with services that run when the operating system starts. Each time the computer starts, the TPM will check that the services you specified in the platform validation profile have not changed. If any of these services change while BitLocker Drive Encryption (BDE) protection remains on, the TPM will not release the encryption key to unlock the disk volume, and the computer will enter into recovery mode.
If this parameter is specified while the corresponding Group Policy setting has been enabled, it must match the Group Policy setting.
If this parameter is not specified, the default of 0, 2, 4, 5, 8, 9, 10, and 11 is used. The default platform validation profile secures the encryption key against changes to the following elements:
- Core Root of Trust of Measurement (CRTM)
- BIOS
- Platform Extensions (PCR 0)
- Option ROM Code (PCR 2)
- Master Boot Record (MBR) Code (PCR 4)
- Master Boot Record (MBR) Partition Table (PCR 5)
- NTFS Boot Sector (PCR 8)
- NTFS Boot Block (PCR 9)
- Boot Manager (PCR 10)
- BitLocker Access Control (PCR 11)
For the security of your computer, we recommend the default profile. For additional protection against early startup configuration changes, use a profile of PCRs 0, 1, 2, 3, 4, 5, 8, 9, 10, 11. Unified Extensible Firmware Interface (UEFI)–based computers do not use PCR 5 by default.
Changing from the default profile affects the security and manageability of your computer. The sensitivity of BitLocker to platform modifications (malicious or authorized) is increased or decreased depending upon the inclusion or exclusion, respectively, of the PCRs. For BitLocker protection to be enabled, the platform validation profile must include PCR 11.
Value Meaning - 0
Core Root of Trust of Measurement (CRTM), BIOS, and Platform Extensions - 1
Platform and Motherboard Configuration and Data - 2
Option ROM Code - 3
Option ROM Configuration and Data - 4
Master Boot Record (MBR) Code - 5
Master Boot Record (MBR) Partition Table - 6
State Transition and Wake Events - 7
Computer Manufacturer-Specific - 8
NTFS Boot Sector - 9
NTFS Boot Block - 10
Boot Manager - 11
BitLocker Access Control - 12
Defined for use by the static operating system - 13
Defined for use by the static operating system - 14
Defined for use by the static operating system - 15
Defined for use by the static operating system - 16
Used for debugging - 17
Dynamic CRTM - 18
Platform defined - 19
Used by a trusted operating system - 20
Used by a trusted operating system - 21
Used by a trusted operating system - 22
Used by a trusted operating system - 23
Application support -
PIN [in]
-
Type: string
A user-specified personal identification string. This string must consist of a sequence of 6 to 20 digits or, if the "Allow enhanced PINs for startup" group policy is enabled, 6 to 20 letters, symbols, spaces, or numbers.
-
VolumeKeyProtectorID [out]
-
Type: string
The updated unique string identifier used to manage an encrypted volume key protector.
If the drive supports hardware encryption and BitLocker has not taken band ownership, the ID string is set to "BitLocker" and the key protector is written to per band metadata.
Return value
Type: uint32
This method returns one of the following codes or another error code if it fails.
| Return code/value | Description |
|---|---|
|
The method was successful. |
|
The PlatformValidationProfile parameter is provided, but its values are not within the known range, or it does not match the Group Policy setting currently in effect. |
|
A bootable CD/DVD is found in this computer. Remove the CD/DVD and restart the computer. |
|
The TPM cannot secure the volume's encryption key because the volume does not contain the currently running operating system. |
|
The NewPIN parameter contains characters that are not valid. When the "Allow enhanced PINs for startup" Group Policy is disabled, only numbers are supported. |
|
The volume is locked. |
|
The NewPIN parameter supplied is either longer than 20 characters, shorter than 6 characters, or shorter than the minimum length specified by Group Policy. |
|
A key protector of this type already exists. |
|
No compatible TPM is found on this computer. |
Security Considerations
For the security of your computer, we recommend the default profile. For additional protection against early startup code changes, use a profile of PCRs 0, 2, 4, 5, 8, 9, 10, and 11. For additional protection against early startup configuration changes, use a profile of PCRs 0, 1, 2, 3, 4, 5, 8, 9, 10, 11.
Changing from the default profile affects the security or usability of your computer.
Remarks
At most one key protector of type "TPM And PIN" can exist for a volume at any time. If you want to change the display name or the platform validation profile used by an existing "TPM And PIN" key protector, you must first remove the existing key protector and then call ProtectKeyWithTPMAndPIN to create a new one.
Additional key protectors should be specified to unlock the volume in recovery scenarios where access to the volume's encryption key cannot be obtained; for example, when the TPM cannot successfully validate against the platform validation profile or when the PIN is lost.
Use ProtectKeyWithExternalKey or ProtectKeyWithNumericalPassword to create one or more key protectors for recovering an otherwise locked volume.
While it is possible to have both a key protector of the type "TPM" and another of the type "TPM And PIN", the presence of the "TPM" key protector type negates the effects of other TPM-based key protectors.
Managed Object Format (MOF) files contain the definitions for Windows Management Instrumentation (WMI) classes. MOF files are not installed as part of the Windows SDK. They are installed on the server when you add the associated role by using the Server Manager. For more information about MOF files, see Managed Object Format (MOF).
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista Enterprise, Windows Vista Ultimate [desktop apps only] |
| Minimum supported server |
Windows Server 2008 [desktop apps only] |
| Namespace |
Root\CIMV2\Security\MicrosoftVolumeEncryption |
| MOF |
|
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for