Summary
Creates a payload for provisioning a local access key
Syntax
New-HPSureAdminLocalAccessKeyProvisioningPayload [-SigningKeyFile] <FileInfo> [[-SigningKeyPassword] <String>] [[-Nonce] <UInt32>] [[-TargetUUID] <Guid>] [[-SingleUse]] [-LocalAccessKeyFile] <FileInfo> [[-LocalAccessKeyPassword] <String>] [[-Id] <Int32>] [[-KeyEnrollmentData] <String>] [[-OutputFile] <FileInfo>] [<CommonParameters>]
New-HPSureAdminLocalAccessKeyProvisioningPayload [-SigningKeyCertificate] <X509Certificate2> [[-Nonce] <UInt32>] [[-TargetUUID] <Guid>] [[-SingleUse]] [-LocalAccessKeyFile] <FileInfo> [[-LocalAccessKeyPassword] <String>] [[-Id] <Int32>] [[-KeyEnrollmentData] <String>] [[-OutputFile] <FileInfo>] [<CommonParameters>]
New-HPSureAdminLocalAccessKeyProvisioningPayload [[-Nonce] <UInt32>] [[-TargetUUID] <Guid>] [[-SingleUse]] [-LocalAccessKeyFile] <FileInfo> [[-LocalAccessKeyPassword] <String>] [[-Id] <Int32>] [[-KeyEnrollmentData] <String>] [[-OutputFile] <FileInfo>] [-RemoteSigningServiceKeyID] <String> [-RemoteSigningServiceURL] <String> [[-CacheAccessToken]] [<CommonParameters>]
Description
This command uses the provided key to sign and authorize updating HP Sure Admin local access keys. There are three signing options to choose from: - Signing Key File (and Password) using -SigningKeyFile and -SigningKeyPassword parameters - Signing Key Certificate using -SigningKeyCertificate parameter - Remote Signing using -RemoteSigningServiceKeyID 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.
Setting a local access key allows system administrators to authorize commands locally with the HP Sure Admin phone app. Reference the Convert-HPSureAdminCertToQRCode command to learn more about how to transfer a local access key to the HP Sure Admin phone app.
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 |
|---|---|---|
| SigningKeyFile | <FileInfo> | Specifies the path to the Secure Platform Management signing key as a PFX file. If the PFX file is protected by a password (recommended), the SigningKeyPassword parameter should also be provided. |
| SigningKeyPassword | <String> | Specifies the Secure Platform Management signing key file password, if required. |
| SigningKeyCertificate | <X509Certificate2> | Specifies the Secure Platform Management signing key certificate as an X509Certificate object |
| 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. |
| TargetUUID | <Guid> | Specifies the computer UUID on which to perform this operation. If not specified, the payload generated will work on any computer. |
| SingleUse | If specified, the payload cannot be replayed. This happens because the nonce must be higher than ActionsCounter and this counter is updated and incremented every time a command generated with SingleUse flag is accepted by the BIOS. If not specified, the payload can be replayed as many times as desired until a payload generated with a nonce higher than SettingsCounter is received. This happens because SettingsCounter is not incremented by the BIOS when accepting commands. |
|
| LocalAccessKeyFile | <FileInfo> | Specifies the path to the local access key as a PFX file. If the PFX file is protected by a password (recommended), the LocalAccessKeyPassword parameter should also be provided. |
| LocalAccessKeyPassword | <String> | Specifies the local access key file password, if required |
| Id | <Int32> | Specifies the Int Id from 1,2, or 3 that gets appended to the setting name |
| KeyEnrollmentData | <String> | Specifies the KeyEnrollmentData to use to get Sure Admin Local Access key from certificate |
| OutputFile | <FileInfo> | Specifies the file to write output to instead of writing the output to the pipeline |
| RemoteSigningServiceKeyID | <String> | Specifies the Signing 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
- Supported on Windows Power Shell v5.
- An HP BIOS with HP Sure Admin support is required for applying the payloads generated by this command.
Examples
PS C:\> $payload = New-HPSureAdminLocalAccessKeyProvisioningPayload -SigningKeyFile "$path\signing_key.pfx" -LocalAccessKeyFile "$path\local_access_key.pfx"
PS C:\> $payload | Set-HPSecurePlatformPayload
PS C:\> New-HPSureAdminLocalAccessKeyProvisioningPayload -SigningKeyFile "$path\signing_key.pfx" -SigningKeyPassword "s3cr3t" -LocalAccessKeyFile "$path\local_access_key.pfx" -LocalAccessKeyPassword "lak_s3cr3t" -OutputFile PayloadFile.dat
PS C:\> Set-HPSecurePlatformPayload -PayloadFile PayloadFile.dat