-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathGet-CertificateReport.ps1
263 lines (241 loc) · 12.4 KB
/
Get-CertificateReport.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
function Get-CertificateReport {
param (
[CmdletBinding()]
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
[PKI.CertificateServices.CertificateAuthority]$CertificateAuthority,
[string]$CertificateTemplateOID,
[datetime]$NotBeforeDate = (Get-Date "1970-01-01"),
[string]$NotBeforeRequestID = 0,
[Parameter(ParameterSetName='Issued')]
[switch]$Issued,
[Parameter(ParameterSetName='Revoked')]
[switch]$Revoked,
[Parameter(ParameterSetName='Pending')]
[switch]$Pending,
[Parameter(ParameterSetName='Failed')]
[switch]$Failed
)
#======================================================================
# Variables to customize for your environment
#======================================================================
$logPath = "$PSScriptRoot\Logs\Get-CertificateReport.log"
#======================================================================
# Define logging function
#======================================================================
Function Write-Log {
param(
$Message,
$LogPath,
$Color = "Yellow",
$Encoding = "Unicode"
)
Write-Host "$Message" -ForegroundColor $Color
If ($LogPath -ne $null)
{
$logTime = Get-Date -format "yyyy-MM-dd HH:mm:ss zzz"
Write-Output "[$logTime][$env:COMPUTERNAME] $Message" | Out-File -Append $LogPath -Encoding $Encoding
}
}
#======================================================================
# Creating new Event source on server
#======================================================================
try
{
$eventSource = 'TestPKISource'
if (!([System.Diagnostics.EventLog]::SourceExists($eventSource)))
{
New-EventLog -LogName Application -Source $eventSource -ErrorAction Stop
}
}
catch
{
$errorMsg = $_.Exception.Message
Write-Log "Failed to create new event log: $errorMsg" -LogPath $logPath
Exit
}
#======================================================================
# Import PowerShell PKI module
#======================================================================
Import-Module PSPKI -ErrorAction SilentlyContinue
try
{
# Verify PSPKI module is installed
if (!(Get-Module PSPKI -ErrorAction Stop))
{
Install-Module PSPKI -ErrorAction Stop -Force
Import-Module PSPKI -ErrorAction Stop
}
else
{
# Do nothing - module already imported
}
# Logging
$outcome = "Successfully imported PowerShell PKI module"
Write-Log $outcome -LogPath $logPath
}
catch
{
# Logging
$errorMsg = $_.Exception.Message
$outcome = "Failed to import PowerShell PKI module. Exception: $errorMsg"
Write-Log $outcome -LogPath $logPath
Write-EventLog -Message $outcome -LogName Application -Source $eventSource -EntryType Error -EventId 9000
Exit
}
#======================================================================
# Get issued certs
#======================================================================
if (!$Revoked -and !$Pending -and !$Failed)
{
try
{
Write-Log "[$($CA.Name)] Searching for issued certificates" -LogPath $logPath
$DateFilter = "NotBefore -ge $NotBeforeDate"
$RequestIDFilter = "RequestID -ge $NotBeforeRequestID"
If ($CertificateTemplateOID)
{
$TemplateFilter = "CertificateTemplate -eq $CertificateTemplateOID"
Get-IssuedRequest -CertificationAuthority $CertificateAuthority -Filter $TemplateFilter,$DateFilter,$RequestIDFilter -ErrorAction Stop | ForEach-Object {
Write-Verbose "[$($CA.Name)] Processing issued request ID: $($_.RequestID)"
$_ | Select-Object *,
@{n='TemplateFriendlyName';e={ if($_.CertificateTemplateOid.Value -match "[a-z]"){ $_.CertificateTemplate} elseif ($_.CertificateTemplateOid.FriendlyName -eq $null){$_.CertificateTemplateOid.Value} else { $_.CertificateTemplateOid.FriendlyName }}},
@{n='Status';e={ 'Issued' }}
}
}
Else
{
Get-IssuedRequest -CertificationAuthority $CertificateAuthority -Filter $DateFilter,$RequestIDFilter -ErrorAction Stop | ForEach-Object {
Write-Verbose "[$($CA.Name)] Processing issued request ID: $($_.RequestID)"
$_ | Select-Object *,
@{n='TemplateFriendlyName';e={ if($_.CertificateTemplateOid.Value -match "[a-z]"){ $_.CertificateTemplate} elseif ($_.CertificateTemplateOid.FriendlyName -eq $null){$_.CertificateTemplateOid.Value} else { $_.CertificateTemplateOid.FriendlyName }}},
@{n='Status';e={ 'Issued' }}
}
}
}
catch
{
$errorMsg = $_.Exception.Message
$outcome = "Failed to query issued requests from CA. Exception: $errorMsg"
Write-Log $outcome -LogPath $logPath
Write-EventLog -Message $outcome -LogName Application -Source $eventSource -EntryType Error -EventId 9000
Exit
}
}
#======================================================================
# Get revoked certs
#======================================================================
if ($Revoked)
{
Write-Log "[$($CA.Name)] Searching for revoked certificates" -LogPath $logPath
try
{
$DateFilter = "Request.RevokedWhen -ge $NotBeforeDate"
$RequestIDFilter = "RequestID -ge $NotBeforeRequestID"
If ($CertificateTemplateOID)
{
$TemplateFilter = "CertificateTemplate -eq $CertificateTemplateOID"
Get-RevokedRequest -CertificationAuthority $CertificateAuthority -Filter $TemplateFilter,$DateFilter,$RequestIDFilter -ErrorAction Stop | ForEach-Object {
Write-Verbose "[$($CA.Name)] Processing revoked request ID: $($_.RequestID)"
$_ | Select-Object *,
@{n='TemplateFriendlyName';e={ if($_.CertificateTemplateOid.Value -match "[a-z]"){ $_.CertificateTemplate} elseif ($_.CertificateTemplateOid.FriendlyName -eq $null){$_.CertificateTemplateOid.Value} else { $_.CertificateTemplateOid.FriendlyName }}},
@{n='Status';e={ 'Revoked' }}
}
}
Else
{
Get-RevokedRequest -CertificationAuthority $CertificateAuthority -Filter $DateFilter,$RequestIDFilter -ErrorAction Stop | ForEach-Object {
Write-Verbose "[$($CA.Name)] Processing revoked request ID: $($_.RequestID)"
$_ | Select-Object *,
@{n='TemplateFriendlyName';e={ if($_.CertificateTemplateOid.Value -match "[a-z]"){ $_.CertificateTemplate} elseif ($_.CertificateTemplateOid.FriendlyName -eq $null){$_.CertificateTemplateOid.Value} else { $_.CertificateTemplateOid.FriendlyName }}},
@{n='Status';e={ 'Revoked' }}
}
}
}
catch
{
$errorMsg = $_.Exception.Message
$outcome = "Failed to query revoked requests from CA. Exception: $errorMsg"
Write-Log $outcome -LogPath $logPath
Write-EventLog -Message $outcome -LogName Application -Source $eventSource -EntryType Error -EventId 9000
Exit
}
}
#======================================================================
# Get pending certs
#======================================================================
if ($Pending)
{
Write-Log "[$($CA.Name)] Searching for pending certificate requests" -LogPath $logPath
try
{
$DateFilter = "Request.SubmittedWhen -ge $NotBeforeDate"
$RequestIDFilter = "RequestID -ge $NotBeforeRequestID"
If ($CertificateTemplateOID)
{
$TemplateFilter = "CertificateTemplate -eq $CertificateTemplateOID"
Get-PendingRequest -CertificationAuthority $CertificateAuthority -Filter $TemplateFilter,$DateFilter,$RequestIDFilter -ErrorAction Stop | ForEach-Object {
Write-Verbose "[$($CA.Name)] Processing pending request ID: $($_.RequestID)"
$_ | Select-Object *,
@{n='TemplateFriendlyName';e={ if($_.CertificateTemplateOid.Value -match "[a-z]"){ $_.CertificateTemplate} elseif ($_.CertificateTemplateOid.FriendlyName -eq $null){$_.CertificateTemplateOid.Value} else { $_.CertificateTemplateOid.FriendlyName }}},
@{n='Status';e={ 'Pending' }}
}
}
Else
{
Get-PendingRequest -CertificationAuthority $CertificateAuthority -Filter $DateFilter,$RequestIDFilter -ErrorAction Stop | ForEach-Object {
Write-Verbose "[$($CA.Name)] Processing pending request ID: $($_.RequestID)"
$_ | Select-Object *,
@{n='TemplateFriendlyName';e={ if($_.CertificateTemplateOid.Value -match "[a-z]"){ $_.CertificateTemplate} elseif ($_.CertificateTemplateOid.FriendlyName -eq $null){$_.CertificateTemplateOid.Value} else { $_.CertificateTemplateOid.FriendlyName }}},
@{n='Status';e={ 'Pending' }}
}
}
}
catch
{
$errorMsg = $_.Exception.Message
$outcome = "Failed to query pending requests from CA. Exception: $errorMsg"
Write-Log $outcome -LogPath $logPath
Write-EventLog -Message $outcome -LogName Application -Source $eventSource -EntryType Error -EventId 9000
Exit
}
}
#======================================================================
# Get failed certs
#======================================================================
if ($Failed)
{
Write-Log "[$($CA.Name)] Searching for failed certificate requests" -LogPath $logPath
try
{
$DateFilter = "Request.SubmittedWhen -ge $NotBeforeDate"
$RequestIDFilter = "RequestID -ge $NotBeforeRequestID"
If ($CertificateTemplateOID)
{
$TemplateFilter = "CertificateTemplate -eq $CertificateTemplateOID"
Get-AdcsDatabaseRow -CertificationAuthority $CertificateAuthority -Table Failed -Filter $TemplateFilter,$DateFilter,$RequestIDFilter -ErrorAction Stop | ForEach-Object {
Write-Verbose "[$($CA.Name)] Processing failed request ID: $($_.RequestID)"
$_ | Select-Object *,
@{n='TemplateFriendlyName';e={ if($_.CertificateTemplateOid.Value -match "[a-z]"){ $_.CertificateTemplate} elseif ($_.CertificateTemplateOid.FriendlyName -eq $null){$_.CertificateTemplateOid.Value} else { $_.CertificateTemplateOid.FriendlyName }}},
@{n='Status';e={ 'Failed' }}
}
}
Else
{
Get-AdcsDatabaseRow -CertificationAuthority $CertificateAuthority -Table Failed -Filter $DateFilter,$RequestIDFilter -ErrorAction Stop | ForEach-Object {
Write-Verbose "[$($CA.Name)] Processing failed request ID: $($_.RequestID)"
$_ | Select-Object *,
@{n='TemplateFriendlyName';e={ if($_.CertificateTemplateOid.Value -match "[a-z]"){ $_.CertificateTemplate} elseif ($_.CertificateTemplateOid.FriendlyName -eq $null){$_.CertificateTemplateOid.Value} else { $_.CertificateTemplateOid.FriendlyName }}},
@{n='Status';e={ 'Failed' }}
}
}
}
catch
{
$errorMsg = $_.Exception.Message
$outcome = "Failed to query failed requests from CA. Exception: $errorMsg"
Write-Log $outcome -LogPath $logPath
Write-EventLog -Message $outcome -LogName Application -Source $eventSource -EntryType Error -EventId 9000
Exit
}
}
}