Summary
Creates a deprovisioning payload
Syntax
New-HPSecurePlatformDeprovisioningPayload [-EndorsementKeyFile] <String> [[-EndorsementKeyPassword] <String>] [[-Nonce] <UInt32>] [[-OutputFile] <FileInfo>] [<CommonParameters>]
New-HPSecurePlatformDeprovisioningPayload [[-Nonce] <UInt32>] [[-OutputFile] <FileInfo>] [-RemoteEndorsementKeyID] <String> [-RemoteSigningServiceURL] <String> [[-CacheAccessToken]] [<CommonParameters>]
New-HPSecurePlatformDeprovisioningPayload [[-Nonce] <UInt32>] [-EndorsementKeyCertificate] <X509Certificate2> [[-OutputFile] <FileInfo>] [<CommonParameters>]
Description
This command creates a payload to deprovision the HP Secure Platform Management. The caller must have access to the Endorsement Key private key in order to create this payload.
There are three endorsement options to choose from: - Endorsement Key File (and Password) using -EndorsementKeyFile and -EndorsementKeyPassword parameters - Endorsement Key Certificate using -EndorsementKeyCertificate parameter - Remote Endorsement using -RemoteEndorsementKeyID and -RemoteSigningServiceURL parameters
Please note that using a Key File with Password in PFX format is recommended over using an X509 Certificate object because a private key in a certificate is not password protected.
This command writes the created payload to the pipeline or to the file specified in the -OutputFile parameter. This payload can then be passed to the Set-HPSecurePlatformPayload command.
Security note: Payloads should only be created on secure servers. Once created, the payload may be transferred to a client and applied via the Set-HPSecurePlatformPayload command. Creating the payload and passing it to the Set-HPSecurePlatformPayload command via the pipeline is not a recommended production pattern.
Parameters
| Name | Argument | Description |
|---|---|---|
| EndorsementKeyFile | <String> | Specifies the Key Endorsement key certificate as a PFX (PKCS #12) file |
| EndorsementKeyPassword | <String> | The password for the endorsement key certificate file. If no password was used when the PFX was created (which is not recommended), this parameter may be omitted. |
| Nonce | <UInt32> | Specifies a Nonce. If nonce is specified, the Secure Platform Management subsystem will only accept commands with a nonce greater or equal to the last nonce sent. This approach helps to prevent replay attacks. If not specified, the nonce is inferred from the current local time. The current local time as the nonce works in most cases. However, this approach has a resolution of seconds, so when performing parallel operations or a high volume of operations, it is possible for the same counter to be interpreted for more than one command. In these cases, the caller should use its own nonce derivation and provide it through this parameter. |
| EndorsementKeyCertificate | <X509Certificate2> | Specifies the endorsement key certificate as an X509Certificate object |
| OutputFile | <FileInfo> | Specifies the file to write output to instead of writing the output to the pipeline |
| RemoteEndorsementKeyID | <String> | Specifies the Endorsement Key ID to be used |
| RemoteSigningServiceURL | <String> | Specifies the (Key Management Service) KMS server URL (I.e.: https:// |
| CacheAccessToken | If specified, the access token is cached in msalcache.dat file and user credentials will not be asked again until the credentials expire. This parameter should be specified for caching the access token when performing multiple operations on the KMS server. If access token is not cached, the user must re-enter credentials on each call of this command. |
Notes
- Requires HP BIOS with Secure Platform Management support.
Examples
PS C:\> New-HPSecurePlatformDeprovisioningPayload -EndorsementKeyFile kek.pfx | Set-HPSecurePlatformPayload
PS C:\> New-HPSecurePlatformDeprovisioningPayload -EndorsementKeyFile kek.pfx -OutputFile deprovisioning_payload.dat