Functions/Get-AIMCredential.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
Function Get-AIMCredential {
    <#
    .SYNOPSIS
    Retrieves password from a local Credential Provider.

    .DESCRIPTION
    Sends a query via a local credential provider using the CLIPasswordSDK utility.
    Use the Set-AIMConfiguration function to set the path to the CLIPasswordSDK executable.

    .PARAMETER AppID
    Specifies the unique ID of the application issuing the password request.

    .PARAMETER Safe
    Specifies the name of the Safe where the password is stored.

    .PARAMETER Folder
    Specifies the name of the folder where the password is stored.

    .PARAMETER Object
    Specifies the name of the password object to retrieve.

    .PARAMETER UserName
    Defines search criteria according to the UserName account property.

    .PARAMETER Address
    Defines search criteria according to the Address account property.

    .PARAMETER Database
    Defines search criteria according to the Database account property.

    .PARAMETER PolicyID
    Defines search criteria according to the PolicyID account property.

    .PARAMETER QueryFormat
    Whether to search via "exact" or "regex" terms

    .PARAMETER RequiredProps
    Defines the names of the account properties you want to be returned in addition to the Password

    .PARAMETER Reason
    The reason for retrieving the password. This reason will be audited in the Credential Provider audit log

    .PARAMETER Port
    The port to communicate with the credential provider

    .PARAMETER Timeout
    Timeout value in seconds

    .EXAMPLE
    Get-AIMCredential -AppID YourApp -Safe YourSafe -Folder Root -UserName YourUser

    Returns the password found via the query definition:

    Password PasswordChangeInProcess
    -------- -----------------------
    YourPass false

    .EXAMPLE
    Get-AIMCredential -AppID YourApp -Safe YourSafe -UserName YourUser -RequiredProps Address,UserName

    Returns the password, address and username properties:

    Password PasswordChangeInProcess UserName Address
    -------- ----------------------- -------- -------
    YourPass false YourUser DOMAIN.COM

    #>

    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingConvertToSecureStringWithPlainText", "", Justification = "Suppress alert from ToSecureString ScriptMethod")]
    [CmdletBinding()]
    Param(
        # Unique ID of the application
        [Parameter(
            Mandatory = $true,
            ValueFromPipelineByPropertyName = $true
        )]
        [string]
        $AppID,

        # Safe name
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $true
        )]
        [string]
        $Safe,

        # Folder name
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [string]
        $Folder,

        # Object name
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [string]
        $Object,

        # Search username
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [string]
        $UserName,

        # Search address
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [string]
        $Address,

        # Search database
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [string]
        $Database,

        # Set PolicyID
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [string]
        $PolicyID,

        # Set QueryFormat
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [ValidateSet("exact", "regexp")]
        [string]
        $QueryFormat,

        # Required Properties
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [string[]]
        $RequiredProps,

        # Reason to record in audit log
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [string]
        $Reason,

        # Port for communication with the provider
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [int]
        $Port,

        # Number of seconds to try
        [Parameter(
            Mandatory = $false,
            ValueFromPipelineByPropertyName = $true
        )]
        [int]
        $Timeout
    )

    Begin {
        #Function Parameters which will form any query string
        $QueryParameters = @(
            "Safe",
            "Folder",
            "Object",
            "UserName",
            "Address",
            "Database"
            "PolicyID"
        )

        $ConnectionParms = @(
            "Port",
            "Timeout"
        )

        #Array to hold the Properties to return
        [array]$ReturnProps = @()
        #Hashtable to hold the Results to Output
        [hashtable]$Output = @{ }
        #Delimiter for separating the output fields
        $Separator = "#_-_#"

    }

    Process {

        #Initial Command String
        $Command = "/p AppDescs.AppID=`"$AppID`""

        #Build array of query string properties
        $PSBoundParameters.Add("Query", @())
        $QueryParameters | ForEach-Object {

            If ($PSBoundParameters.ContainsKey("$_")) {


                $PSBoundParameters["Query"] += "$_=$($PSBoundParameters["$_"])"
            }

        }

        #Build Command String
        switch ( $PSBoundParameters.Keys ) {

            "Query" {

                #Add Query to Command String
                #"Property=Value;Property=Value;Property=Value"
                $Command = "$Command /p Query=""$($PSBoundParameters["Query"] -join ";")"""

            }

            "QueryFormat" {

                #Add QueryFormat Command String
                $Command = "$Command /p QueryFormat=$QueryFormat"

            }

            "RequiredProps" {

                #Add RequiredProps to Command String
                $RequiredProps | ForEach-Object {

                    $ReturnProps += "PassProps.$_"
                }

                $Command = "$Command /p RequiredProps=$($RequiredProps -join ",")"

            }

            "Reason" {

                #Add Reason to Command String
                $Command = "$Command /p Reason=$Reason"

            }

            { $ConnectionParms -contains $PSItem } {

                #Add ConnectionParms to Command String
                $Command = "$Command /p ConnectionParms.$_=$($PSBoundParameters[$_])"

            }

        }

        #Add Password & PasswordChangeInProcess to output fields
        $ReturnProps += "Password"
        $ReturnProps += "PasswordChangeInProcess"
        #Create Output fields string PropX,PropY,PropZ, Password, PasswordChangeInProcess
        $ReturnProps = $ReturnProps -join ","

        #Build Command String
        $Command = "$Command /o $ReturnProps /d $Separator"

        #Add CommandParameters to $PSBoundParameters for Splat against Invoke-AIMClient
        $PSBoundParameters.Add("CommandParameters", "$Command")

        #Invoke Credential Provider
        $Result = Invoke-AIMClient @PSBoundParameters

        #Output on StdOut
        If ($Result.StdOut) {

            #split returned results at Separator
            $Results = ($Result.StdOut) -Split $Separator

            #use $returnProps to determine propertynames
            $ReturnProps = $ReturnProps.Split(",")

            For ($i = 0 ; $i -lt $ReturnProps.length ; $i++) {

                #PropertyName=PropertyValue
                $Output[$(($ReturnProps[$i]) -replace "PassProps.", "")] = ($Results[$i]).trim()

            }

            #Create Output Object with Property Values
            $OutputObject = New-Object -TypeName PSObject -Property $Output

            #Add ScriptMethod to output object to convert password to Secure String
            $OutputObject | Add-Member -MemberType ScriptMethod -Name ToSecureString -Value {

                $this.Password | ConvertTo-SecureString -AsPlainText -Force

            }

            #Add ScriptMethod to output object to convert username & password to Credential Object
            $OutputObject | Add-Member -MemberType ScriptMethod -Name ToCredential -Value {

                New-Object System.Management.Automation.PSCredential($this.UserName, $this.ToSecureString())

            }

            #Return the result from AIM CP
            $OutputObject

        }

    }

}