Format-SecureBootUEFI

Format-SecureBootUEFI

Formats certificates or hashes into a content object that is returned and creates a file that is ready to be signed.

Syntax

Parameter Set: FormatForCertificates
Format-SecureBootUEFI -CertificateFilePath <String[]> -Name <System.String> {PK | KEK | db | dbx} -SignatureOwner <Guid> [-AppendWrite] [-ContentFilePath <String> ] [-FormatWithCert] [-SignableFilePath <System.String> ] [-Time <System.String> ] [ <CommonParameters>]

Parameter Set: FormatForDelete
Format-SecureBootUEFI -Delete -Name <System.String> {PK | KEK | db | dbx} [-SignableFilePath <System.String> ] [-Time <System.String> ] [ <CommonParameters>]

Parameter Set: FormatForHashes
Format-SecureBootUEFI -Algorithm <String> {sha1 | sha256 | sha384 | sha512} -Hash <String[]> -Name <System.String> {PK | KEK | db | dbx} -SignatureOwner <Guid> [-AppendWrite] [-ContentFilePath <String> ] [-SignableFilePath <System.String> ] [-Time <System.String> ] [ <CommonParameters>]




Detailed Description

The Format-SecureBootUEFI cmdlet receives certificates or hashes as input and formats the input into a content object that is returned. The Set-SecureBootUEFI cmdlet uses this object to update the variable. If you specify a signable file, this cmdlet creates a file that has the specified name that has to be signed.

This cmdlet this runs on both UEFI and BIOS (non-UEFI) computers.

Parameters

-Algorithm<String>

Specifies which algorithm to use if this cmdlet is formatting hashes. The acceptable values for this parameter are: SHA1, SHA256, SHA384, and SHA512.


Aliases

alg

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AppendWrite

Indicates that the contents of the current variable are appended instead of overwritten.


Aliases

append

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CertificateFilePath<String[]>

Specifies one or more files that each contain a certificate that is used to generate the content object.

If you specify only the name, the file must be in the current working directory. Otherwise, specify the full path of the file.


Aliases

c

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ContentFilePath<String>

Specifies the name of the file that is created and contains the information for the content object that is generated by this cmdlet.


Aliases

f

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Delete

Indicates that this cmdlet creates a content object and the appropriate sign-able file that deletes the variable.


Aliases

del

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FormatWithCert

Indicates whether the certificate will be stored or just the public key. If this parameter is set, the whole certificate is stored in the content object.


Aliases

cert

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Hash<String[]>

Specifies an array of hashes that are used to generate the content.


Aliases

h

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<System.String>

Specifies the name of the UEFI environment variable. The acceptable values for this parameter are: PK, KEK, DB, and DBX.


Aliases

n

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByValue)

Accept Wildcard Characters?

false

-SignableFilePath<System.String>

Specifies the file that contains the contents of the data that is ready to be signed.

If only the name is specified, the file must be in the current working directory. Otherwise, specify the full path of the file.


Aliases

s

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SignatureOwner<Guid>

Specifies the GUID of the signature owner.


Aliases

g

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Time<System.String>

Specifies the timestamp that is used in the signature. Format this value as follows so that it is accepted as a DateTime object:

"2011-11-01T13:30:00Z"


Aliases

t

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    This cmdlet accepts a string that represents the UEFI variable name that may be output from the Get-SecureBootUEFI cmdlet.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.SecureBoot.Commands.UEFIFormattedVariable

    This cmdlet returns a UEFIFormattedVariable object that contains information about the package that is built up to be set. The following members are part of the UEFIFormattedVariable object:

    -- A string named Name.
    -- A string named Time.
    -- A Boolean named AppendWrite.
    -- An array of bytes named Content.

    The UEFIFormattedVariable object can be used to pipe to the Set-SecureBootUEFI cmdlet.


Examples

Example 1: Format a private key

This command formats the private key in PK.cer that is later piped to the Set-SecureBootUEFI cmdlet.


PS C:\> Format-SecureBootUefi -Name PK -SignatureOwner 12345678-1234-1234-1234-123456789abc -CertificateFilePath PK.cer -SignableFilePath GeneratedFileToSign.bin -Time 2011-11-01T13:30:00Z | Format-List

Example 2: Format a hash

This command formats the hash to beg appended to the DBX UEFI variable when the result is piped to the Set-SecureBootUEFI cmdlet.


PS C:\> Format-SecureBootUEFI -Name DBX -SignatureOwner 12345678-1234-1234-1234-123456789abc -Algorithm SHA256 -Hash 0011223344556677889900112233445566778899001122334455667788990011 -SignableFilePath GeneratedFileToSign.bin -Time 2011-11-01T13:30:00Z -AppendWrite | Format-List

Example 3: Format for a variable to be deleted

This command formats the KEK UEFI variable being deleted when the result is piped into the Set-SecureBootUEFI cmdlet.


PS C:\> Format-SecureBootUEFI -Name KEK -Delete -SignableFilePath GeneratedFileToSign.bin -Time 2011-11-01T13:30:00Z | Format-List

Related topics

Community Additions

ADD
Show: