aboutsummaryrefslogtreecommitdiff
path: root/docs/Recon/Get-PathAcl.md
blob: 448212fd6573dbbe8236350e800e744ffbd971c4 (plain)
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
# Get-PathAcl

## SYNOPSIS
Enumerates the ACL for a given file path.

Author: Will Schroeder (@harmj0y)  
License: BSD 3-Clause  
Required Dependencies: Add-RemoteConnection, Remove-RemoteConnection, ConvertFrom-SID

## SYNTAX

```
Get-PathAcl [-Path] <String[]> [[-Credential] <PSCredential>]
```

## DESCRIPTION
Enumerates the ACL for a specified file/folder path, and translates
the access rules for each entry into readable formats.
If -Credential is passed,
Add-RemoteConnection/Remove-RemoteConnection is used to temporarily map the remote share.

## EXAMPLES

### -------------------------- EXAMPLE 1 --------------------------
```
Get-PathAcl "\\SERVER\Share\"
```

Returns ACLs for the given UNC share.

### -------------------------- EXAMPLE 2 --------------------------
```
gci .\test.txt | Get-PathAcl
```

### -------------------------- EXAMPLE 3 --------------------------
```
$SecPassword = ConvertTo-SecureString 'Password123!' -AsPlainText -Force
```

$Cred = New-Object System.Management.Automation.PSCredential('TESTLAB\dfm', $SecPassword)
Get-PathAcl -Path "\\\\SERVER\Share\" -Credential $Cred

## PARAMETERS

### -Path
Specifies the local or remote path to enumerate the ACLs for.

```yaml
Type: String[]
Parameter Sets: (All)
Aliases: FullName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```

### -Credential
A \[Management.Automation.PSCredential\] object of alternate credentials
for connection to the target path.

```yaml
Type: PSCredential
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: [Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False
```

## INPUTS

### String

One of more paths to enumerate ACLs for.

## OUTPUTS

### PowerView.FileACL

A custom object with the full path and associated ACL entries.

## NOTES

## RELATED LINKS

[https://support.microsoft.com/en-us/kb/305144](https://support.microsoft.com/en-us/kb/305144)