Public/Get-TppCertificateDetail.ps1
|
<#
.SYNOPSIS Get basic or detailed certificate information .DESCRIPTION Get certificate info based on a variety of attributes. Additional details can be had by passing the guid. .PARAMETER Path Starting path to search from .PARAMETER Recursive Search recursively starting from the search path. .PARAMETER Limit Limit how many items are returned. Default is 0 for no limit. It is definitely recommended to filter on another property when searching with no limit. .PARAMETER Country Find certificates by Country attribute of Subject DN. Example - US .PARAMETER CommonName Find certificates by Common name attribute of Subject DN. Example - test.venafi.com .PARAMETER Issuer Find certificates by issuer. Use the CN ,O, L, S, and C values from the certificate request. Surround the complete Issuer DN within double quotes ("). If a value DN already contains double quotes, enclose the string in a second set of double quotes. Example - CN=Example Root CA, O=Venafi,Inc., L=Salt Lake City, S=Utah, C=US .PARAMETER KeyAlgorithm Find certificates by algorithm for the public key. Example - 'RSA','DSA' .PARAMETER KeySize Find certificates by public key size. Example - 1024,2048 .PARAMETER KeySizeGreaterThan Find certificates with a key size greater than the specified value. Example - 1024 .PARAMETER KeySizeLessThan Find certificates with a key size less than the specified value. Example: 1025 .PARAMETER Locale Find certificates by Locality/City attribute of Subject Distinguished Name (DN). Example - London .PARAMETER Organization Find certificates by Organization attribute of Subject DN. Example - 'Venafi Inc.','BankABC' .PARAMETER OrganizationUnit Find certificates by Organization Unit (OU). Example - 'Quality Assurance' .PARAMETER State Find certificates by State/Province attribute of Subject DN. Example - 'New York', 'Georgia' .PARAMETER SanDns Find certificates by Subject Alternate Name (SAN) Distinguished Name Server (DNS). Example - sso.venafi.com .PARAMETER SanEmail Find certificates by SAN Email RFC822. Example - first.last@venafi.com .PARAMETER SanIP Find certificates by SAN IP Address. Example - '10.20.30.40' .PARAMETER SanUpn Find certificates by SAN User Principal Name (UPN) or OtherName. Example - My.Email@venafi.com .PARAMETER SanUri Find certificates by SAN Uniform Resource Identifier (URI). Example - https://login.venafi.com .PARAMETER SerialNumber Find certificates by Serial number. Example - 13279B74000000000053 .PARAMETER SignatureAlgorithm Find certificates by the algorithm used to sign the certificate (e.g. SHA1RSA). Example - 'sha1RSA','md5RSA','sha256RSA' .PARAMETER Thumbprint Find certificates by one or more SHA-1 thumbprints. Example - 71E8672798C03842735293EF49425EF06C7FA8AB& .PARAMETER IssueDate Find certificates by the date of issue. Example - [DateTime] '2017-10-24' .PARAMETER ExpireDate Find certificates by expiration date. Example - [DateTime] '2017-10-24' .PARAMETER ExpireAfter Find certificates that expire after a certain date. Specify YYYY-MM-DD or the ISO 8601 format, for example YYYY-MM-DDTHH:MM:SS.mmmmmmmZ. Example - [DateTime] '2017-10-24' .PARAMETER ExpireBefore Find certificates that expire before a certain date. Specify YYYY-MM-DD or the ISO 8601 format, for example YYYY-MM-DDTHH:MM:SS.mmmmmmmZ. Example - [DateTime] '2017-10-24' .PARAMETER Enabled Include only certificates that are enabled or disabled .PARAMETER InError Include only certificates by error state: No error or in an error state .PARAMETER NetworkValidationEnabled Include only certificates with network validation enabled or disabled .PARAMETER CreateDate Find certificates that were created at an exact date and time .PARAMETER CreatedAfter Find certificate created after this date and time .PARAMETER CreatedBefore Find certificate created before this date and time .PARAMETER ManagementType Find certificates with a Management type of Unassigned, Monitoring, Enrollment, or Provisioning .PARAMETER PendingWorkflow Include only certificates that have a pending workflow resolution (have an outstanding workflow ticket) .PARAMETER Stage Find certificates by one or more stages in the certificate lifecycle .PARAMETER StageGreaterThan Find certificates with a stage greater than the specified stage (does not include specified stage) .PARAMETER StageLessThan Find certificates with a stage less than the specified stage (does not include specified stage) .PARAMETER ValidationEnabled Include only certificates with validation enabled or disabled .PARAMETER ValidationState Find certificates with a validation state of Blank, Success, or Failure .PARAMETER Guid Guid representing a unique certificate in Venafi. .PARAMETER TppSession Session object created from New-TppSession method. The value defaults to the script session object $TppSession. .INPUTS Guid .OUTPUTS ByPath and NoPath parameter sets returns a PSCustomObject with the following properties: CreatedOn DN Guid Name ParentDn SchemaClass _links Guid returns a PSCustomObject with the following properties: CertificateAuthorityDN CertificateDetails Consumers Contact CreatedOn CustomFields Description DN Guid ManagementType Name ParentDn ProcessingDetails RenewalDetails SchemaClass ValidationDetails .EXAMPLE Get-TppCertificateDetail -ExpireBefore ([DateTime] "2018-01-01") Find all certificates expiring before a certain date .EXAMPLE Get-TppCertificateDetail -ExpireBefore ([DateTime] "2018-01-01") -Limit 5 Find 5 certificates expiring before a certain date .EXAMPLE Get-TppCertificateDetail -Path '\VED\Policy\My Policy' Find all certificates in a specific path .EXAMPLE Get-TppCertificateDetail -Path '\VED\Policy\My Policy' -Recursive Find all certificates in a specific path and all subfolders .EXAMPLE Get-TppCertificateDetail -ExpireBefore ([DateTime] "2018-01-01") -Limit 5 | Get-TppCertificateDetail Get detailed certificate info on the first 5 certificates expiring before a certain date .LINK http://venafitppps.readthedocs.io/en/latest/functions/Get-TppCertificateDetail/ .LINK https://github.com/gdbarron/VenafiTppPS/blob/master/VenafiTppPS/Public/Get-TppCertificateDetail.ps1 .LINK https://docs.venafi.com/Docs/18.1SDK/TopNav/Content/SDK/WebSDK/API_Reference/r-SDK-GET-Certificates.php?TocPath=REST%20API%20reference|Certificates%20module%20programming%20interfaces|_____3 .LINK https://docs.venafi.com/Docs/18.1SDK/TopNav/Content/SDK/WebSDK/API_Reference/r-SDK-GET-Certificates-guid.php?TocPath=REST%20API%20reference|Certificates%20module%20programming%20interfaces|_____5 .LINK https://msdn.microsoft.com/en-us/library/system.web.httputility(v=vs.110).aspx #> function Get-TppCertificateDetail { [CmdletBinding()] param ( [Parameter(Mandatory, ParameterSetName = 'ByPath')] [ValidateNotNullOrEmpty()] [ValidateScript( { if ( $_ | Test-TppDnPath ) { $true } else { throw "'$_' is not a valid DN path" } })] [Alias('DN')] [String] $Path, [Parameter(ParameterSetName = 'ByPath')] [Switch] $Recursive, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [int] $Limit = 0, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('C')] [String] $Country, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('CN')] [String] $CommonName, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [String] $Issuer, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [String[]] $KeyAlgorithm, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Int[]] $KeySize, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Int] $KeySizeGreaterThan, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Int] $KeySizeLessThan, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('L')] [String[]] $Locale, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('O')] [String[]] $Organization, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('OU')] [String[]] $OrganizationUnit, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('S')] [String[]] $State, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [String] $SanDns, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [String] $SanEmail, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [String] $SanIP, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [String] $SanUpn, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [String] $SanUri, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [String] $SerialNumber, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [String] $SignatureAlgorithm, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [String] $Thumbprint, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('ValidFrom')] [DateTime] $IssueDate, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('ValidTo')] [DateTime] $ExpireDate, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('ValidToGreater')] [DateTime] $ExpireAfter, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('ValidToLess')] [DateTime] $ExpireBefore, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [bool] $Enabled, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [bool] $InError, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [bool] $NetworkValidationEnabled, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [datetime] $CreateDate, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('CreatedOnGreater')] [datetime] $CreatedAfter, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('CreatedOnLess')] [datetime] $CreatedBefore, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [ValidateSet('Unassigned', 'Monitoring', 'Enrollment', 'Provisioning')] [String[]] $ManagementType, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Switch] $PendingWorkflow, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [ValidateScript( { $enumValues = Get-EnumValues -EnumName 'CertificateStage' if ( $_ -in $enumValues.Values ) { $true } else { throw "'$_' is not a valid Stage. Valid values include {0}." -f ($enumValues.Values -join ', ') } })] [int[]] $Stage, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('StageGreater')] [ValidateScript( { $enumValues = Get-EnumValues -EnumName 'CertificateStage' if ( $_ -in $enumValues.Values ) { $true } else { throw "'$_' is not a valid Stage. Valid values include {0}." -f ($enumValues.Values -join ', ') } })] [int] $StageGreaterThan, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [Alias('StageLess')] [ValidateScript( { $enumValues = Get-EnumValues -EnumName 'CertificateStage' if ( $_ -in $enumValues.Values ) { $true } else { throw "'$_' is not a valid Stage. Valid values include {0}." -f ($enumValues.Values -join ', ') } })] [int] $StageLessThan, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [bool] $ValidationEnabled, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [ValidateSet('Blank', 'Success', 'Failure')] [String[]] $ValidationState, [Parameter(ParameterSetName = 'ByPath')] [Parameter(ParameterSetName = 'NoPath')] [switch] $Full, [Parameter(Mandatory, ParameterSetName = 'Full', ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [guid[]] $Guid, [Parameter()] [TppSession] $TppSession = $Script:TppSession ) begin { $TppSession.Validate() Switch ($PsCmdlet.ParameterSetName) { {$_ -in 'NoPath', 'ByPath'} { $params = @{ TppSession = $TppSession Method = 'Get' UriLeaf = 'certificates' Body = @{ 'Limit' = $Limit } } switch ($PSBoundParameters.Keys) { 'Path' { if ( $PSBoundParameters['Recursive'] ) { $params.Body.Add( 'ParentDnRecursive', $Path ) } else { $params.Body.Add( 'ParentDn', $Path ) } } 'Country' { $params.Body.Add( 'C', $Country ) } 'CommonName' { $params.Body.Add( 'CN', $CommonName ) } 'Issuer' { $params.Body.Add( 'Issuer', $Issuer ) } 'KeyAlgorithm' { $params.Body.Add( 'KeyAlgorithm', $KeyAlgorithm -join ',' ) } 'KeySize' { $params.Body.Add( 'KeySize', $KeySize -join ',' ) } 'KeySizeGreaterThan' { $params.Body.Add( 'KeySizeGreater', $KeySizeGreaterThan ) } 'KeySizeLessThan' { $params.Body.Add( 'KeySizeLess', $KeySizeLessThan ) } 'Locale' { $params.Body.Add( 'L', $Locale -join ',' ) } 'Organization' { $params.Body.Add( 'O', $Organization -join ',' ) } 'OrganizationUnit' { $params.Body.Add( 'OU', $OrganizationUnit -join ',' ) } 'State' { $params.Body.Add( 'S', $State -join ',' ) } 'SanDns' { $params.Body.Add( 'SAN-DNS', $SanDns ) } 'SanEmail' { $params.Body.Add( 'SAN-Email', $SanEmail ) } 'SanIP' { $params.Body.Add( 'SAN-IP', $SanIP ) } 'SanUpn' { $params.Body.Add( 'SAN-UPN', $SanUpn ) } 'SanUri' { $params.Body.Add( 'SAN-URI', $SanUri ) } 'SerialNumber' { $params.Body.Add( 'Serial', $SerialNumber ) } 'SignatureAlgorithm' { $params.Body.Add( 'SignatureAlgorithm', $SignatureAlgorithm -join ',' ) } 'Thumbprint' { $params.Body.Add( 'Thumbprint', $Thumbprint ) } 'IssueDate' { $params.Body.Add( 'ValidFrom', $IssueDate.ToUniversalTime().ToString( "yyyy-MM-ddTHH:mm:ss.fffffffZ" ) ) } 'ExpireDate' { $params.Body.Add( 'ValidTo', $ExpireDate.ToUniversalTime().ToString( "yyyy-MM-ddTHH:mm:ss.fffffffZ" ) ) } 'ExpireAfter' { $params.Body.Add( 'ValidToGreater', $ExpireAfter.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ss.fffffffZ") ) } 'ExpireBefore' { $params.Body.Add( 'ValidToLess', $ExpireBefore.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ss.fffffffZ") ) } 'Enabled' { $params.Body.Add( 'Disabled', [int] (-not $Enabled) ) } 'InError' { $params.Body.Add( 'InError', [int] $InError ) } 'NetworkValidationEnabled' { $params.Body.Add( 'NetworkValidationDisabled', [int] (-not $NetworkValidationEnabled) ) } 'ManagementType' { $params.Body.Add( 'ManagementType', $ManagementType -join ',' ) } 'PendingWorkflow' { $params.Body.Add( 'PendingWorkflow', '') } 'Stage' { $params.Body.Add( 'Stage', $Stage -join ',' ) } 'StageGreaterThan' { $params.Body.Add( 'StageGreater', $StageGreaterThan ) } 'StageLessThan' { $params.Body.Add( 'StageLess', $StageLessThan ) } 'ValidationEnabled' { $params.Body.Add( 'ValidationDisabled', [int] (-not $ValidationEnabled) ) } 'ValidationState' { $params.Body.Add( 'ValidationState', $ValidationState -join ',' ) } } } 'Full' { $params = @{ TppSession = $TppSession Method = 'Get' UriLeaf = 'placeholder' } } } } process { Switch ($PsCmdlet.ParameterSetName) { {$_ -in 'NoPath', 'ByPath'} { $response = Invoke-TppRestMethod @params if ( $response ) { if ( $PSBoundParameters.ContainsKey('Full') ) { $response.Certificates | Get-TppCertificateDetail } else { $response.Certificates } } } 'Full' { $GUID.ForEach{ $params.UriLeaf = [System.Web.HttpUtility]::HtmlEncode("certificates/{$_}") Invoke-TppRestMethod @params } } } } } |