AzureConnectionAssistant.psm1

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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
function Test-Session ()
{
<#
.SYNOPSIS
Function to validate a connection to an Azure RM Subscription.

.DESCRIPTION
This function initiates a check to see if you are have a current Azure Login session, if it
finds you don't, it prompts you to select credentials saved in the Registry.

.EXAMPLE
    PS C:\> Test-Session
    No session found or No local credentials stored.
    Please select from the following
    1: MyAzureCreds
    2: To enter credentials manually (Needed for any Federated credentials)
    Select: : 1

    Environment : AzureCloud
    Account : scott@examplenotreal.com
    TenantId : 123e7e65-2654-43c1-b123-caf99f844a69
    SubscriptionId : 5095e43d-2fee-4c98-bd73-b7c5c7e01012
    SubscriptionName : Pay-As-You-Go
    CurrentStorageAccount :

    PS C:\>

This example demonstrates running the function in a fresh PowerShell session, with no current
connection. The Function lists the saved credentials that are stored locally and prompts for a
selection as to which credential to use. Then proceeds to make a connection to AzureRM with
the selected credentials.

.NOTES
Created by: Scott Thomas - scott@deathbyvegemite.com
Copyright (c) 2017. All rights reserved.

THIS CODE IS MADE AVAILABLE AS IS, WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK
OF THE USE OR THE RESULTS FROM THE USE OF THIS CODE REMAINS WITH THE USER.
#>

    [CmdletBinding(SupportsShouldProcess = $true)]
    Param()
    trap{Write-Host -f Red "$($_.Exception.Message)"; return $false}
    $sesh = Get-AzureRmContext -ErrorAction SilentlyContinue
    if ($Sesh.Environment -like $null)
    {
        Write-Host -f Yellow "No session found or no local credentials stored."
        New-AzureRMLogin
    }
    else
    {
        if($pscmdlet.ShouldProcess("Test-Session is positive","Return"))
        {
            return $sesh
        }
    }
}


function New-AzureRMLogin
{
<#
.SYNOPSIS
Function to connect to an AzureRM Subscription.

.DESCRIPTION
This function is used by Test-Session to connect to Azure using credentials saved in the Registry of the current user.

.PARAMETER ConnectWithDefault
This switch will force the use of the first saved credential.

.EXAMPLE
PS C:\> New-AzureRMLogin
Please select from the following
1: MyAzureCreds
2: To enter credentials manually (Needed for any Federated credentials)
Select: : 1

Environment : AzureCloud
Account : scott@examplenotreal.com
TenantId : 123e7e65-2654-43c1-b123-caf99f844a69
SubscriptionId : 5095e43d-2fee-4c98-bd73-b7c5c7e01012
SubscriptionName : Pay-As-You-Go
CurrentStorageAccount :
    
PS C:\>

This example demonstrates connecting to an Azure RM Subscription, after being prompted and selecting the first saved credentials.

.NOTES
Created by: Scott Thomas - scott@deathbyvegemite.com
Copyright (c) 2017. All rights reserved.

THIS CODE IS MADE AVAILABLE AS IS, WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK
OF THE USE OR THE RESULTS FROM THE USE OF THIS CODE REMAINS WITH THE USER.
#>

    [CmdletBinding(SupportsShouldProcess = $true)]
    Param
    (
        [Parameter(Mandatory = $false, ValueFromPipeline = $false)][Switch]$ConnectWithDefault
    )
    trap { Write-Host -f Red "$($_.Exception.Message)"; return $false }
    if ((Test-Path -Path HKCU:\System\CurrentControlSet\SecCreds) -eq $false){return $false}
    if ($ConnectWithDefault)
    {
        $Credname = (Show-SavedCreds)[0].Name
        $creds = Get-SavedCreds $Credname
    }
    else
    {
        Write-Host "Please select from the following"
        $i = 1; Foreach ($Name in (Show-SavedCreds | select Name)) { Write-Host "$i`: $($name.name)"; $i++ }
        Write-Host "$i`: To enter credentials manually (Needed for any Federated credentials)"
        $promptvalue = Read-Host -Prompt "Select: "
        if ($promptvalue -eq $i)
        {
            if($pscmdlet.ShouldProcess("Azure - with Federated account"))
            {
                $return = Login-AzureRmAccount
                return $return
            }
        }
        else
        { 
            $CredToConnectTo = (Show-SavedCreds)[($promptvalue - 1)]
            $Credname = $CredToConnectTo.name
            $creds = Get-SavedCreds $($CredToConnectTo.name)
        }
    }    
    if($pscmdlet.ShouldProcess("Azure - with $Credname saved credentials"))
    {
        $return = Login-AzureRmAccount -Credential $creds
        return $return
    }
}


function New-SavedCreds
{
<#
.SYNOPSIS
Function to save credentials to the HKCU.

.DESCRIPTION
This function will save an encrypted credential to the HKCU hive of the current users' context.

.PARAMETER CredName
This is the name used to save the credentials under in the registry.

.PARAMETER Creds
This is an object containing a PSCredential.

.EXAMPLE
PS C:\> $creds = Get-Credential scott@examplenotreal.com
PS C:\> New-SavedCreds -CredName MyAzureCreds -Creds $creds
True
PS C:\>

This example demonstrates saving a set of credentuals to a variable, then adding that PSCredential to the registry.

.NOTES
Created by: Scott Thomas - scott@deathbyvegemite.com
Copyright (c) 2017. All rights reserved.

THIS CODE IS MADE AVAILABLE AS IS, WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK
OF THE USE OR THE RESULTS FROM THE USE OF THIS CODE REMAINS WITH THE USER.
#>

    [CmdletBinding(SupportsShouldProcess = $true)]
    Param
    (
        [Parameter(Mandatory = $true, ValueFromPipeline = $false)][String]$CredName,
        [Parameter(Mandatory = $true, ValueFromPipeline = $false)][System.Management.Automation.PSCredential]$Creds
    )
    trap { Write-Host -f Red "$($_.Exception.Message)"; return $false }
    if ((Test-Path -Path HKCU:\System\CurrentControlSet\SecCreds) -eq $false)
    {
        $null = New-Item -Path HKCU:\System\CurrentControlSet\SecCreds
    }
    $null = New-Item -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName
    if($pscmdlet.ShouldProcess("ItemProperty: HKCU:\System\CurrentControlSet\SecCreds\$CredName\UserName","New-ItemProperty"))
    {
        $null = New-ItemProperty -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName -Name UserName -Value $creds.UserName
    }
    $password = $creds.Password | ConvertFrom-SecureString
    if($pscmdlet.ShouldProcess("ItemProperty: HKCU:\System\CurrentControlSet\SecCreds\$CredName\Password","New-ItemProperty"))
    {
        $null = New-ItemProperty -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName -Name Password -Value $password
    }
    if ((Test-Path -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName) -eq $true)
    {
        return $true
    }
    return $false
}


function Get-SavedCreds
{
<#
.SYNOPSIS
Function to save retrieve saved credentials.

.DESCRIPTION
This function will retrieve a set of credentials that are stored in the local users registry.

.PARAMETER CredName
This is the name of the credential to retrieve from the registry.

.EXAMPLE
PS C:\> $creds = Get-SavedCreds MyAzureCreds
PS C:\> $creds
UserName Password
-------- --------
scott@examplenotreal.com System.Security.SecureString

PS C:\>

This example demonstrates getting a credential from the registry and saving it to a variable.

.NOTES
Created by: Scott Thomas - scott@deathbyvegemite.com
Copyright (c) 2017. All rights reserved.

THIS CODE IS MADE AVAILABLE AS IS, WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK
OF THE USE OR THE RESULTS FROM THE USE OF THIS CODE REMAINS WITH THE USER.
#>

    [CmdletBinding(SupportsShouldProcess = $false)]
    Param
    (
        [Parameter(Mandatory = $true, ValueFromPipeline = $false)][String]$CredName
    )
    trap { Write-Host -f Red "$($_.Exception.Message)"; return $false }
    $test = Test-Path -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName
    if ($test)
    {
        $userName = (Get-ItemProperty -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName -Name UserName).UserName
        $password = (Get-ItemProperty -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName -Name Password).password | ConvertTo-SecureString
        $creds = New-Object System.Management.Automation.PSCredential $userName, $password
        return $creds
    }
    else
    {
        Write-Host -f Red "Credential $($CredName) not found on machine."
        return $false
    }
    return $true
}


function Update-SavedCreds
{
<#
.SYNOPSIS
Function to update a saved credentials.

.DESCRIPTION
This function allows for the updating of an exisitng saved credential.

.PARAMETER CredName
This is the name of the credential to be updated.

.PARAMETER Creds
This is an object containing a new PSCredential.

.EXAMPLE
PS C:\> $creds = Get-Credential scott@examplenotreal.com
PS C:\> Update-SavedCreds -CredName MyAzureCreds -Creds $creds
True
PS C:\>

This example demonstrates updadting a saved credential to new values.

.NOTES
Created by: Scott Thomas - scott@deathbyvegemite.com
Copyright (c) 2017. All rights reserved.

THIS CODE IS MADE AVAILABLE AS IS, WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK
OF THE USE OR THE RESULTS FROM THE USE OF THIS CODE REMAINS WITH THE USER.
#>

    [CmdletBinding(SupportsShouldProcess = $false)]
    Param
    (
        [Parameter(Mandatory = $true, ValueFromPipeline = $false)][String]$CredName,
        [Parameter(Mandatory = $true, ValueFromPipeline = $false)][System.Management.Automation.PSCredential]$Creds
    )
    trap { Write-Host -f Red "$($_.Exception.Message)"; return $false }
    $test = Test-Path -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName
    if ($test)
    {
        if ($creds)
        {
            $password = $creds.Password | ConvertFrom-SecureString
            Set-ItemProperty -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName -Name Password -Value $password
        }
    }
    else
    {
        Write-Host -f Red "Credential $($CredName) not found on machine."
        return $false
    }
    return $true
}


function Show-SavedCreds
{
<#
.SYNOPSIS
Function to show all saved credentials.

.DESCRIPTION
This function will retrieve allcredentials that are stored in the local users registry and display them on screen.

.PARAMETER ShowPasswords
This switch will allow for the credentials to be decrypted and displayed on screen.

.EXAMPLE
PS C:\> Show-SavedCreds -ShowPasswords

Name UserName Password
---- -------- --------
MyAzureCreds scott@examplenotreal.com P@s$W0rd!

PS C:\>

This example demonstrates listing all credential from the registry and displaying passwords.

.NOTES
Created by: Scott Thomas - scott@deathbyvegemite.com
Copyright (c) 2017. All rights reserved.

THIS CODE IS MADE AVAILABLE AS IS, WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK
OF THE USE OR THE RESULTS FROM THE USE OF THIS CODE REMAINS WITH THE USER.
#>

    [CmdletBinding(SupportsShouldProcess = $false)]
    Param
    (
        [Parameter(Mandatory = $false, ValueFromPipeline = $false)][Switch]$ShowPasswords = $false
    )
    trap { Write-Host -f Red "$($_.Exception.Message)"; return $false }
    $tmpContent = @()
    $objReturn = @()
    $tmpContent = Get-ChildItem HKCU:\System\CurrentControlSet\SecCreds\
    foreach ($C in $tmpContent)
    {
        $tmp = $C.name.split("\")[-1]
        If ($ShowPasswords)
        {
            $password = $C.GetValue("Password") | ConvertTo-SecureString
            [String]$stringValue = [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($password))
        }
        else
        {
            $stringValue = "**********"
        }
        $objTemp = New-Object -TypeName PSobject
        $objTemp | Add-Member -MemberType NoteProperty -Name Name $tmp
        $objTemp | Add-Member -MemberType NoteProperty -Name UserName $C.GetValue("UserName")
        $objTemp | Add-Member -MemberType NoteProperty -Name Password $stringValue
        
        $objReturn += $objTemp
    }
    return $objReturn
}


function Remove-SavedCreds
{
<#
.SYNOPSIS
Function to remove a saved credential.

.DESCRIPTION
This function will remove a credentail that has been saved in the local users registry.

.PARAMETER CredName
This is the name of the credential to retrieve from the registry.

.EXAMPLE
PS C:\> Remove-SavedCreds -CredName MyAzureCreds

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-SavedCreds" on target "Are you sure?".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
MyAzureCreds has been removed
True
PS C:\>
    
.NOTES
Created by: Scott Thomas - scott@deathbyvegemite.com
Copyright (c) 2017. All rights reserved.

THIS CODE IS MADE AVAILABLE AS IS, WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK
OF THE USE OR THE RESULTS FROM THE USE OF THIS CODE REMAINS WITH THE USER.
#>

    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = "High")]
    Param
    (
        [Parameter(Mandatory = $true, ValueFromPipeline = $false)][String]$CredName
    )
    trap{Write-Host -f Red "$($_.Exception.Message)"; return $false}
    if ((Test-Path -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName) -eq $false)
    {
        Write-Host -f Red "Credential name not found"
        return $false
    }

    if ($PSCmdlet.ShouldProcess("Are you sure?"))
    {
        $Error.Clear()
        $toremove = Remove-Item -Path HKCU:\System\CurrentControlSet\SecCreds\$CredName -ErrorAction SilentlyContinue
        If ($Error.Count -eq 0)
        {
            Write-Host -f Yellow "$CredName has been removed"
            return $true
        }
    }
    Write-Host -f Red "Credentials were not able to be removed"
    return $false
}