AWS fsx: Document access-based enumeration (ABE) for FSx Windows file shares
Summary
Adds a new section explaining how to enable, disable, and verify access-based enumeration (ABE) on Amazon FSx for Windows File Server SMB shares using the FSx Remote Management PowerShell CLI (New-FSxSmbShare/Set-FSxSmbShare -FolderEnumerationMode AccessBased|Unrestricted), including the note that ABE is disabled by default and only controls visibility, not access.
Security assessment
ABE is a permission-based visibility control that reduces information disclosure of file/folder names to users lacking read permission; the doc also clarifies that ABE does not replace share/NTFS permissions, so it is security guidance rather than a fix for a specific vulnerability.
Evidence
+You can enable access-based enumeration (ABE) on file shares using the Amazon FSx CLI for Remote Management on PowerShell. With ABE enabled, your users see only the files and folders in a file share that they have permission to read. ABE is disabled by default on new file shares.
Diff
diff --git a/fsx/latest/WindowsGuide/managing-file-shares.md b/fsx/latest/WindowsGuide/managing-file-shares.md index fd5c3a1..dd88375 100644 --- a//fsx/latest/WindowsGuide/managing-file-shares.md +++ b//fsx/latest/WindowsGuide/managing-file-shares.md @@ -160,0 +161,52 @@ To enable Continuously Available on an existing file share, use the following co +You can enable access-based enumeration (ABE) on file shares using the Amazon FSx CLI for Remote Management on PowerShell. With ABE enabled, your users see only the files and folders in a file share that they have permission to read. ABE is disabled by default on new file shares. + +###### Note + +ABE changes only which files and folders your users can see. To control who can access them, use share permissions and NTFS permissions. + +If you enable ABE, you might see higher CPU utilization when your users view or list file shares, or during the optimization phase of a storage scaling job. Each time a user lists a folder, ABE checks that user's permissions on every file and folder in it. + +In the commands in this section, replace ``powershell_endpoint`` with the Windows Remote PowerShell endpoint of your file system, and ``share_name`` with the name of your file share. You can find the Windows Remote PowerShell endpoint in the Amazon FSx console, in the **Network & Security** section of the file system details page. + +### Create a file share with ABE enabled + +Use the `New-FSxSmbShare` command with the `-FolderEnumerationMode` option set to `AccessBased`. The following is an example command to create a share with ABE enabled. Replace the share name, path, and description with your own values. + + + New-FSxSmbShare -Name "New ABE Share" -Path "D:\share\new-share" -Description "ABE share" -FolderEnumerationMode AccessBased + +### Enable or disable ABE on an existing file share + +Use the `Set-FSxSmbShare` command with the `-FolderEnumerationMode` option. To enable ABE, set the option to `AccessBased`: + + + Invoke-Command -ComputerName powershell_endpoint -ConfigurationName FSxRemoteAdmin -scriptblock { set-fsxsmbshare -name share_name -FolderEnumerationMode AccessBased } + +To disable ABE, set the option to `Unrestricted`: + + + Invoke-Command -ComputerName powershell_endpoint -ConfigurationName FSxRemoteAdmin -scriptblock { set-fsxsmbshare -name share_name -FolderEnumerationMode Unrestricted } + +### Determine if access-based enumeration is enabled on an existing file share + +Use the following command to view the value of the `FolderEnumerationMode` property for an existing file share. + + + Invoke-Command -ComputerName powershell_endpoint -ConfigurationName FSxRemoteAdmin -scriptblock { get-fsxsmbshare -name share_name } + +The command returns `FolderEnumerationMode` as a number: `0` for `AccessBased` and `1` for `Unrestricted`. For more information, see [MSFT_SmbShare class](https://learn.microsoft.com/en-us/previous-versions/windows/desktop/smb/msft-smbshare) in the _Microsoft Windows Documentation_. + +If ABE is enabled, the output will include the following line: + + + [...] + FolderEnumerationMode : 0 + [...] + +If ABE is not enabled, the output will include the following line: + + + [...] + FolderEnumerationMode : 1 + [...] +