Format-Secure BootUEFI

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

Syntax 

Format-SecureBootUEFI
      -Name <String>
      -SignatureOwner <Guid>
      -CertificateFilePath <String[]>
      [-FormatWithCert]
      [-SignableFilePath <String>]
      [-Time <String>]
      [-AppendWrite]
      [-ContentFilePath <String>]
      [<CommonParameters>]
Format-SecureBootUEFI
      -Name <String>
      -SignatureOwner <Guid>
      -Hash <String[]>
      -Algorithm <String>
      [-SignableFilePath <String>]
      [-Time <String>]
      [-AppendWrite]
      [-ContentFilePath <String>]
      [<CommonParameters>]
Format-SecureBootUEFI
      -Name <String>
      [-Delete]
      [-SignableFilePath <String>]
      [-Time <String>]
      [<CommonParameters>]

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.

Examples

Example 1: Format a private key 

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
Name        : PK 
Time        : 2011-11-01T13:30:00Z 
AppendWrite : False 
Content     : {232, 102, 87, 60...}

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

Example 2: Format a hash 

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
Name        : dbx 
Time        : 2011-11-01T13:30:00Z 
AppendWrite : True 
Content     : {18, 165, 108, 130...}

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

Example 3: Format for a variable to be deleted 

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

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

Required Parameters

-Algorithm

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

Type: String
Aliases: alg
Parameter Sets: sha1, sha256, sha384, sha512
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CertificateFilePath

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.

Type: String[]
Aliases: c
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.

Type: SwitchParameter
Aliases: del
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Hash

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

Type: String[]
Aliases: h
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

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

Type: String
Aliases: n
Parameter Sets: PK, KEK, db, dbx
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-SignatureOwner

Specifies the GUID of the signature owner.

Type: Guid
Aliases: g
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Optional Parameters

-AppendWrite

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

Type: SwitchParameter
Aliases: append
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ContentFilePath

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

Type: String
Aliases: f
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.

Type: SwitchParameter
Aliases: cert
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SignableFilePath

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.

Type: String
Aliases: s
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Time

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"

Type: String
Aliases: t
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Inputs

System.String

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

Outputs

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.