PowerShell PKI Module Documentation

Documentation Home

Get-CertificateTrustList

Synopsis

Retrieves Certificate Trust List (CTL) object from a file or a DER-encoded byte array.

Syntax

Get-CertificateTrustList [-Path] <String> [<CommonParameters>]

Get-CertificateTrustList [-RawCTL] <Byte[]> [<CommonParameters>]

Description

Retrieves a Certificate Trust List (CTL) object from a file or a DER-encoded byte array.

A CTL is a predefined list of items signed by a trusted entity. A CTL is a list of hashes of certificates or a list of file names. All items in the list are authenticated (signed) and approved by a trusted signing entity. The primary use of CTLs is to verify signed messages, using the CTL as a source of trusted root certificates.

Parameters

-Path <String>

Specifies the path to a file.

Required? True
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? False

-RawCTL <Byte[]>

Specifies a DER-encoded byte array that represents a Certificate Trust List (CTL).

Required? True
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? False

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, InformationAction, InformationVariable,
WarningAction, WarningVariable, OutBuffer, PipelineVariable and OutVariable.
For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

Inputs

System.String


System.Byte[]

Outputs

SysadminsLV.PKI.Cryptography.X509Certificates.X509CertificateTrustList

Notes

Examples

Example 1

PS C:\> Get-CertificateTrustList -Path C:\authroot.stl

In this example, the CTL object is constructed from a CTL file. CTLs usually have an .stl extension.

Example 2

PS C:\> $Raw = [IO.FILE]::ReadAllBytes("C:\authroot.stl")
Get-CertificateTrustList -RawCTL $Raw

CTL object is constructed from a byte array.

Related links

Show-CertificateTrustList

Minimum PowerShell version support

  • Windows PowerShell 3.0

Operating System Support

  • Windows 7
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2008 R2 all editions
  • Windows Server 2012 all editions
  • Windows Server 2012 R2 all editions
  • Windows Server 2016 all editions
  • Windows Server 2019 all editions
  • Windows Server 2022 all editions