NTFSSecurity/README.md

NTFSSecurity

A PowerShell module for managing the permissions, audit settings, inheritance, and ownership of files and folders on NTFS volumes.

PowerShell offers only Get-Acl and Set-Acl; everything between reading and writing an access control list is up to you. NTFSSecurity closes this gap with cmdlets for everyday tasks, such as permission reports, adding or removing a single permission, repairing inheritance, and taking ownership.

Installation

Install the module from the PowerShell Gallery:

Install-Module -Name NTFSSecurity

You can also download a release from the releases page and install it without the PowerShell Gallery; see Installation.

The module runs on Windows in Windows PowerShell 5.1 and PowerShell 7.

Quick start

# Show the permissions of a folder
Get-NTFSAccess -Path C:\Data

# Give an account the Modify permission on a folder, its subfolders, and files
Add-NTFSAccess -Path C:\Data -Account 'CONTOSO\JohnDoe' -AccessRights Modify

# Remove the explicit permissions of that account again
Get-NTFSAccess -Path C:\Data -Account 'CONTOSO\JohnDoe' -ExcludeInherited |
    Remove-NTFSAccess

# List the explicit permissions in a folder tree, including long paths
Get-ChildItem2 -Path C:\Data -Recurse | Get-NTFSAccess -ExcludeInherited

Documentation

• Overview: features, requirements, and the list of cmdlets
• Concepts: security descriptors, access rights, inheritance, privileges, long paths, and module settings
• Examples: common tasks
• Cmdlet reference: one page per cmdlet
• Contributor guide

The module author's tutorials from 2014 are still a good introduction, although some cmdlet names have changed since:

• NTFSSecurity Tutorial 1 - Getting, adding and removing permissions
• NTFSSecurity Tutorial 2 - Managing NTFS Inheritance and Using Privileges

Version history

See CHANGELOG.md for changes since version 4.2.6 and the version history for 4.2.6 and earlier releases.

License

NTFSSecurity is licensed under the MIT license.