Functions/Accounts/Add-PASDiscoveredAccount.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
function Add-PASDiscoveredAccount {
    <#
.SYNOPSIS
Adds discovered account or SSH key as a pending account in the accounts feed.

.DESCRIPTION
Enables an account or SSH key that is discovered by an external scanner to be added
as a pending account to the Accounts Feed.
Users can identify privileged accounts and determine which are on-boarded to the vault.

.PARAMETER userName
The name of the account user.

.PARAMETER address
The name or address of the machine where the account is located.

.PARAMETER discoveryDate
The date the account was discovered.

.PARAMETER accountEnabled
The state of the account, defined in the discovery source.

.PARAMETER osGroups
The name of the group the account belongs to, such as Administrators or Operators.

.PARAMETER platformType
The platform where the discovered account is located.

.PARAMETER domain
The domain of the account.

.PARAMETER lastLogonDateTime
The date this account was last logged into, defined in the discovery source.

.PARAMETER lastPasswordSetDateTime
The date this password was last set, defined in the discovery source.

.PARAMETER passwordNeverExpires
Whether or not this password expires, defined in the discovery source.

.PARAMETER osVersion
The version of the OS where the account was discovered.

.PARAMETER privileged
Whether the discovered account is privileged or non-privileged.

.PARAMETER privilegedCriteria
The criteria that determines whether or not the discovered account is privileged. For example, the user or group name.

.PARAMETER userDisplayName
The user's display name.

.PARAMETER description
A description of the account, defined in the discovery source.

.PARAMETER passwordExpirationDateTime
The expiration date of the account, defined in the discovery source.

.PARAMETER osFamily
The type of machine where the account was discovered.

.PARAMETER additionalProperties
List of name=value pairs for additional properties added to the account.

.PARAMETER organizationalUnit
The organizational unit where the account is defined.

.PARAMETER SID
Security ID. This parameter is relevant only for Windows accounts.

.PARAMETER uid
The unique user ID. This parameter is relevant only for Unix accounts.

.PARAMETER gid
The unique group ID. This parameter is relevant only for Unix accounts.

.PARAMETER uid
The unique user ID. This parameter is relevant only for Unix SSH Key.

.PARAMETER gid
The unique group ID. This parameter is relevant only for Unix SSH Key.

.PARAMETER fingerprint
The fingerprint of the discovered SSH key. The public and private keys of the same trust have the same fingerprint. This is relevant for SSH keys only.

.PARAMETER size
The size in bits of the generated key.

.PARAMETER path
The path of the public key on the target machine.

.PARAMETER format
The format of the private SSH key.

.PARAMETER comment
Any text added when the key was created.

.PARAMETER encryption
The type of encryption used to generate the SSH key.

.EXAMPLE
Add-PASDiscoveredAccount -UserName Discovered23 -Address domain.com -discoveryDate $(Get-Date "29/10/2018") -AccountEnabled $true -platformType "Windows Domain" -SID 12355

Adds matching discovered account as pending account.

.INPUTS
All parameters can be piped by property name

.OUTPUTS
#>

    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingUserNameAndPassWordParams', '', Justification = "Username not used for authentication")]
    [CmdletBinding(DefaultParameterSetName = "Windows")]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [string]$UserName,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$Address,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [datetime]$discoveryDate,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [boolean]$AccountEnabled,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$osGroups,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateSet("Windows Server Local", "Windows Desktop Local", "Windows Domain", "Unix", "Unix SSH Key")]
        [string]$platformType,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$Domain,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [datetime]$lastLogonDateTime,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [datetime]$lastPasswordSetDateTime,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [boolean]$passwordNeverExpires,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$OSVersion,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateSet("Privileged", "Non-privileged")]
        [string]$privileged,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$privilegedCriteria,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$UserDisplayName,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$description,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [datetime]$passwordExpirationDateTime,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateSet("Workstation", "Server")]
        [string]$osFamily,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [hashtable]$additionalProperties,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$organizationalUnit,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "Windows"
        )]
        [string]$SID,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "Unix"
        )]

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "UnixSSHKey"
        )]
        [string]$uid,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "Unix"
        )]

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "UnixSSHKey"
        )]
        [string]$gid,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "UnixSSHKey"
        )]
        [string]$fingerprint,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "UnixSSHKey"
        )]
        [ValidateSet(1024, 2048, 4096, 8192)]
        [int]$size,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "UnixSSHKey"
        )]
        [string]$path,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "UnixSSHKey"
        )]
        [string]$format,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "UnixSSHKey"
        )]
        [string]$comment,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "UnixSSHKey"
        )]
        [ValidateSet("RSA", "DSA")]
        [string]$encryption
    )

    BEGIN {
        $MinimumVersion = [System.Version]"10.5"

        $AccountProperties = @("SID", "uid", "gid", "fingerprint", "size", "path", "format", "comment", "encryption")

        $DateTimes = @("discoveryDate", "lastLogonDateTime", "lastPasswordSetDateTime", "passwordExpirationDateTime")

    }#begin

    PROCESS {

        Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

        #Create URL for Request
        $URI = "$Script:BaseURI/api/DiscoveredAccounts"

        #Get all parameters that will be sent in the request
        $boundParameters = $PSBoundParameters | Get-PASParameter

        Foreach ($DateTime in $DateTimes) {

            if ($PSBoundParameters.ContainsKey($DateTime)) {

                #convert to unix time
                $boundParameters["$DateTime"] = Get-Date $PSBoundParameters["$DateTime"] -UFormat %s

            }

        }

        $platformTypeAccountProperties = @{ }
        $boundParameters.keys | Where-Object { $AccountProperties -contains $_ } | ForEach-Object {

            #add key=value to hashtable
            $platformTypeAccountProperties[$_] = $boundParameters[$_]


        }

        If ($platformTypeAccountProperties.Count -gt 0) {

            $boundParameters["platformTypeAccountProperties"] = $platformTypeAccountProperties

        }

        $body = $boundParameters |
        Get-PASParameter -ParametersToRemove $AccountProperties |
        ConvertTo-Json

        #send request to PAS web service
        $result = Invoke-PASRestMethod -Uri $URI -Method POST -Body $Body -WebSession $Script:WebSession

        if ($result) {

            #Return Results
            $result | Add-ObjectDetail -DefaultProperties id, status

        }

    }#process

    END { }#end
}