CredHygiene/CredHygiene.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 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
Set-StrictMode -Version Latest function New-AzSKTrackedCredential { <# .SYNOPSIS This command would help to set alert on expiring credentials. .DESCRIPTION This command would help to set alert on expiring credentials. .PARAMETER SubscriptionId Provide the subscription id. .PARAMETER CredentialLocation Provide the credential location. .PARAMETER CredentialName Provide the credential name. .PARAMETER CredentialGroup Provide the credential group. .PARAMETER RotationInterval Provide the rotation interval. .PARAMETER Comment Provide the comment for the credential. .LINK https://aka.ms/azskossdocs #> Param( [Parameter(Mandatory = $true, ParameterSetName = "Custom", Position=0, HelpMessage = "Provide the subscription id")] [string] [ValidateNotNullOrEmpty()] [Alias("s")] $SubscriptionId, [Parameter(Mandatory = $true, ParameterSetName = "Custom", Position=1, HelpMessage = "Provide the credential location")] [ValidateSet("Custom", "AppService", "KeyVault")] [string] [Alias("cl")] $CredentialLocation, [Parameter(Mandatory = $true, ParameterSetName = "Custom", Position=2, HelpMessage = "Provide the credential name")] [string] [Alias("cn")] $CredentialName, [Parameter(Mandatory = $true, ParameterSetName = "Custom", HelpMessage = "Provide the rotation interval in days")] [int] [Alias("rint")] $RotationIntervalInDays, [Parameter(Mandatory = $true, ParameterSetName = "Custom", HelpMessage = "Provide the next expiry due in days")] [int] [Alias("nexp")] $NextExpiryInDays, [Parameter(Mandatory = $false, ParameterSetName = "Custom", HelpMessage = "Provide the credential group for alert")] [string] [Alias("cgp")] $CredentialGroup, [Parameter(Mandatory = $true, ParameterSetName = "Custom", HelpMessage = "Provide the comment for the credential")] [string] [Alias("cmt")] $Comment ) Begin { [CommandHelper]::BeginCommand($MyInvocation); [AzListenerHelper]::RegisterListeners(); } Process { try { $cred = [CredHygiene]::new($SubscriptionId, $PSCmdlet.MyInvocation); if($cred){ $cred.credName = $CredentialName $cred.credLocation = $CredentialLocation while($RotationIntervalInDays -le 0){ Write-Host 'Rotation interval (in days) should be greater than 0' $RotationIntervalInDays = Read-Host 'Enter rotation interval (> 0 days)' } $cred.rotationInt = $RotationIntervalInDays if($NextExpiryInDays -lt 0){ $NextExpiryInDays = 0; } $cred.nextExpiry = $NextExpiryInDays $cred.comment = $Comment $cred.InvokeFunction($cred.NewAlert, @($CredentialLocation,$CredentialGroup)) } } catch { [EventBase]::PublishGenericException($_); } } End { [AzListenerHelper]::UnregisterListeners(); } } function Get-AzSKTrackedCredential { <# .SYNOPSIS This command would help to list expiring credentials. .DESCRIPTION This command would help to list expiring credentials. .PARAMETER SubscriptionId Provide the subscription id. .PARAMETER CredentialName Provide the credential name. .PARAMETER DetailedView Switch for detailed metadata information about the credential. .LINK https://aka.ms/azskossdocs #> Param( [Parameter(Mandatory = $true, HelpMessage = "Provide the subscription id")] [string] [Alias("s")] $SubscriptionId, [Parameter(Mandatory = $false, HelpMessage = "Provide the credential name")] [string] [Alias("cn")] $CredentialName, [Parameter(Mandatory = $false, HelpMessage = "Switch for printing detailed information about the credential.")] [switch] [Alias("dtl")] $DetailedView ) Begin { [CommandHelper]::BeginCommand($MyInvocation); [AzListenerHelper]::RegisterListeners(); } Process { try { $cred = [CredHygiene]::new($SubscriptionId, $PSCmdlet.MyInvocation); if($cred){ if($CredentialName){ $cred.InvokeFunction($cred.GetAlert, @($CredentialName,$DetailedView)) } else { $cred.InvokeFunction($cred.GetAlert, @($null,$DetailedView)) } } } catch { [EventBase]::PublishGenericException($_); } } End { [AzListenerHelper]::UnregisterListeners(); } } function Remove-AzSKTrackedCredential { <# .SYNOPSIS This command would help to delete the expiration details of the credential. .DESCRIPTION This command would help to delete the expiration details of the credential. .PARAMETER SubscriptionId Provide the subscription id. .PARAMETER CredentialName Provide the credential name. .LINK https://aka.ms/azskossdocs #> Param( [Parameter(Mandatory = $true, HelpMessage = "Provide the subscription id")] [string] [Alias("s")] $SubscriptionId, [Parameter(Mandatory = $true, HelpMessage = "Provide the credential name")] [string] [Alias("cn")] $CredentialName, [Parameter(Mandatory = $false, HelpMessage = "Switch for removing credential metadata without further user consent.")] [switch] [Alias("f")] $Force ) Begin { [CommandHelper]::BeginCommand($MyInvocation); [AzListenerHelper]::RegisterListeners(); } Process { try { $cred = [CredHygiene]::new($SubscriptionId, $PSCmdlet.MyInvocation); if($cred){ if($Force){ $cred.InvokeFunction($cred.RemoveAlert, @($CredentialName, $true)) } else { $cred.InvokeFunction($cred.RemoveAlert, @($CredentialName, $false)) } } } catch { [EventBase]::PublishGenericException($_); } } End { [AzListenerHelper]::UnregisterListeners(); } } function Update-AzSKTrackedCredential { <# .SYNOPSIS This command would help to update the alert on expiring credentials. .DESCRIPTION This command would help to update the alert on expiring credentials. .PARAMETER SubscriptionId Provide the subscription id. .PARAMETER CredentialName Provide the credential name. .PARAMETER CredentialGroup Provide the credential group. .PARAMETER RotationInterval Provide the rotation interval. .PARAMETER Comment Provide the comment for the credential. .LINK https://aka.ms/azskossdocs #> Param( [Parameter(Mandatory = $true, HelpMessage = "Provide the subscription id")] [string] [Alias("s")] $SubscriptionId, [Parameter(Mandatory = $true, HelpMessage = "Provide the credential name")] [string] [Alias("cn")] $CredentialName, [Parameter(Mandatory = $false, HelpMessage = "Provide the rotation interval in days")] [int] [Alias("rint")] $RotationIntervalInDays, [Parameter(Mandatory = $false, HelpMessage = "Provide the credential group for alert")] [string] [Alias("cgp")] $CredentialGroup, [Parameter(Mandatory = $false, HelpMessage = "Switch for rotating credential at source.")] [switch] [Alias("rlu")] $ResetLastUpdate, [Parameter(Mandatory = $false, HelpMessage = "Switch for rotating credential at source.")] [switch] [Alias("uc")] $UpdateCredential, [Parameter(Mandatory = $true, HelpMessage = "Provide the comment for the credential")] [string] [Alias("cmt")] $Comment ) Begin { [CommandHelper]::BeginCommand($MyInvocation); [AzListenerHelper]::RegisterListeners(); } Process { try { $cred = [CredHygiene]::new($SubscriptionId, $PSCmdlet.MyInvocation); if($cred){ $updatecred = $false; $resetcred = $false; if($UpdateCredential){ $updatecred = $true; } if($ResetLastUpdate){ $resetcred = $true; } while($RotationIntervalInDays -lt 0){ Write-Host 'Rotation interval (in days) should be greater than 0' $RotationIntervalInDays = Read-Host 'Enter rotation interval (> 0 days)' } $cred.InvokeFunction($cred.UpdateAlert, @($CredentialName,$RotationIntervalInDays,$CredentialGroup,$updatecred,$resetcred,$Comment)) } } catch { [EventBase]::PublishGenericException($_); } } End { [AzListenerHelper]::UnregisterListeners(); } } function New-AzSKTrackedCredentialGroup { <# .SYNOPSIS This command would help to update the alert on expiring credentials. .DESCRIPTION This command would help to update the alert on expiring credentials. .PARAMETER SubscriptionId Provide the subscription id. .PARAMETER AlertEmail Provide the email id for alert. .LINK https://aka.ms/azskossdocs #> Param( [Parameter(Mandatory = $true, HelpMessage = "Provide the subscription id")] [string] [Alias("s")] $SubscriptionId, [Parameter(Mandatory = $true, HelpMessage = "Provide the email id for alert")] [string] [Alias("aem")] $AlertEmail ) Begin { [CommandHelper]::BeginCommand($MyInvocation); [ListenerHelper]::RegisterListeners(); } Process { try { $cred = [CredHygiene]::new($SubscriptionId, $PSCmdlet.MyInvocation); if($cred){ $cred.InvokeFunction($cred.InstallAlert, @($AlertEmail)) } } catch { [EventBase]::PublishGenericException($_); } } End { [ListenerHelper]::UnregisterListeners(); } } |