mirror of https://github.com/raandree/NTFSSecurity
Raimund Andrée
1 week ago
committed by
GitHub
GitHub
16 changed files with 376 additions and 236 deletions
@ -0,0 +1,25 @@ |
|||||
|
--- |
||||
|
status: accepted |
||||
|
date: 2026-10-04 |
||||
|
last-verified: 2026-10-04 |
||||
|
owner: shared |
||||
|
source: maintainer decision in work package 3 |
||||
|
--- |
||||
|
|
||||
|
# Decision 9: Keep the documentation on GitHub |
||||
|
|
||||
|
- Choice: The documentation lives in `Docs` and `README.md`, and GitHub |
||||
|
renders it. There is no documentation site: the Read the Docs and MkDocs |
||||
|
configuration is removed. The GitHub wiki is retired: its version history |
||||
|
and installation steps moved to `Docs/Version-History.md` and |
||||
|
`Docs/README.md`, and the maintainer turns the wiki off. |
||||
|
- Rationale: One source of truth that is versioned with the code, reviewed |
||||
|
in pull requests, and checked by AppVeyor. The Read the Docs project |
||||
|
`ntfssecurity` belongs to `Sup3rlativ3` and points to a fork that no |
||||
|
longer exists; a wiki is edited outside pull requests and CI. |
||||
|
- Consequences: `online version` links stay on GitHub (Decision 4). Section |
||||
|
anchors follow GitHub's rules. `Docs/index.md` became `Docs/README.md`, so |
||||
|
that GitHub shows it when you open the `Docs` folder. |
||||
|
- Rejected: taking over or re-importing the Read the Docs project with a |
||||
|
strict MkDocs build (prepared on the local branch `ai/read-the-docs`, not |
||||
|
merged), and publishing `Docs` to the wiki. |
||||
@ -1,21 +0,0 @@ |
|||||
# .readthedocs.yml |
|
||||
# Read the Docs configuration file |
|
||||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details |
|
||||
|
|
||||
# Required |
|
||||
version: 2 |
|
||||
|
|
||||
# Required: the build image and the Python version |
|
||||
build: |
|
||||
os: ubuntu-24.04 |
|
||||
tools: |
|
||||
python: "3.12" |
|
||||
|
|
||||
# Build documentation with MkDocs |
|
||||
mkdocs: |
|
||||
configuration: mkdocs.yml |
|
||||
|
|
||||
# Install the MkDocs version that the site is built with |
|
||||
python: |
|
||||
install: |
|
||||
- requirements: Docs/requirements.txt |
|
||||
@ -0,0 +1,152 @@ |
|||||
|
# Version history |
||||
|
|
||||
|
This page lists the changes in NTFSSecurity 4.2.6 and earlier. It replaces |
||||
|
the version history in the former GitHub wiki. For the changes since 4.2.6, |
||||
|
see the [changelog](../CHANGELOG.md). |
||||
|
|
||||
|
## 4.2.5 and 4.2.6 |
||||
|
|
||||
|
The PowerShell Gallery published 4.2.5 on 2019-07-11 and 4.2.6 on |
||||
|
2019-07-12. The wiki listed no changes for these versions, so this list is |
||||
|
reconstructed from the commit history. |
||||
|
|
||||
|
- Removed `Show-NTFSSimpleAccess`, which used Windows Forms, for |
||||
|
compatibility with PowerShell Core. |
||||
|
- Fixed parameter alias definitions that made importing the module fail, |
||||
|
for example in Service Management Automation |
||||
|
([#18](https://github.com/raandree/NTFSSecurity/issues/18), |
||||
|
[#36](https://github.com/raandree/NTFSSecurity/issues/36)). |
||||
|
- Fixed the `ToSimpleFileSystemAccessRule2` method of the access entries |
||||
|
that `Get-NTFSAccess` returns |
||||
|
([#48](https://github.com/raandree/NTFSSecurity/issues/48)). |
||||
|
- Fixed the `ApplyTo` column in the output of `Get-NTFSAccess`. |
||||
|
- Added the MIT license. |
||||
|
|
||||
|
## 4.2.4 |
||||
|
|
||||
|
- Bug fixes. |
||||
|
|
||||
|
## 4.2.3 |
||||
|
|
||||
|
- Added the cmdlet `Get-FileHash2`. |
||||
|
- Bug fixes. |
||||
|
|
||||
|
## 4.2.1 |
||||
|
|
||||
|
- Added the cmdlets `Get-NTFSHardLink`, `New-NTFSHardLink`, and |
||||
|
`New-NTFSSymbolicLink`. |
||||
|
|
||||
|
## 4.2 |
||||
|
|
||||
|
- Added the cmdlets `Move-Item2` and `Copy-Item2`. |
||||
|
- `Remove-Item2`, `Move-Item2`, and `Copy-Item2` now support `-WhatIf` and |
||||
|
`-Confirm`. |
||||
|
|
||||
|
## 4.1 |
||||
|
|
||||
|
- The `-Attributes` parameter of `Get-ChildItem2` works like the one of the |
||||
|
standard cmdlet `Get-ChildItem`, as requested. |
||||
|
- `Remove-NTFSAccess` can now remove access from existing access control |
||||
|
entries. The old behavior is still available with the `-RemoveSpecific` |
||||
|
switch parameter. |
||||
|
|
||||
|
## 4.0 |
||||
|
|
||||
|
- The `*-NTFSAccess` cmdlets can now work on security descriptors to allow |
||||
|
bulk processes. |
||||
|
- Code cleanup for better performance and maintainability. |
||||
|
- Bug fixes. |
||||
|
|
||||
|
## 3.2.3 |
||||
|
|
||||
|
- Fixed a bug in `GetInheritedFrom` that resulted in "Invalid Path" or "Path |
||||
|
not found" errors. |
||||
|
|
||||
|
## 3.2 |
||||
|
|
||||
|
- Bug fixes for managing auditing. |
||||
|
- Fixed various bugs reported on CodePlex. |
||||
|
|
||||
|
## 3.1 |
||||
|
|
||||
|
- All cmdlets have the prefix `NTFS` now. There are aliases for backward |
||||
|
compatibility. |
||||
|
- The new version of `Get-NTFSEffectivePermission` uses `AuthzAccessCheck` |
||||
|
instead of `GetEffectiveRightsFromAcl`. |
||||
|
- The previous `Get-NTFSEffectivePermission` cmdlet has been renamed to |
||||
|
`Get-NTFSEffectivePermissionOld`. |
||||
|
- Added `FileSystemAuditRule2` to the PowerShell formatters. |
||||
|
- Added the `InheritedFrom` information to `FileSystemAuditRule2`. |
||||
|
|
||||
|
## 3.0 |
||||
|
|
||||
|
- This version uses [AlphaFS](https://github.com/alphaleonis/AlphaFS) to |
||||
|
work around the `MAX_PATH` limit of 260 characters. |
||||
|
- New `*-Item2` cmdlets discover items with a long path: |
||||
|
- `Get-ChildItem2` (`dir2`) |
||||
|
- `Get-Item2` (`gi2`) |
||||
|
- `Remove-Item2` (`del2`, `rm2`) |
||||
|
- For inherited access control entries, `InheritedFrom` is displayed. |
||||
|
- Generic access rights are supported. |
||||
|
- Performance improvements. |
||||
|
- Bug fixes. |
||||
|
|
||||
|
## 2.4 |
||||
|
|
||||
|
- `Remove-Access` did not remove deny entries when using the pipeline, for |
||||
|
example `Import-Csv .\access.txt | Remove-Access`. |
||||
|
- `Add-Access` did not remove deny entries when using the pipeline, for |
||||
|
example `Import-Csv .\access.txt | Add-Access`. |
||||
|
- The parameter `-Account` was undiscoverable when using the pipeline. |
||||
|
|
||||
|
## 2.3 |
||||
|
|
||||
|
- The module now makes full use of the Backup, Restore, and Take Ownership |
||||
|
privileges, so as an administrator you can edit permissions on objects |
||||
|
that you don't have explicit access to. Privileges are enabled by default |
||||
|
if the value `EnablePrivileges` is `$true` in `NTFSSecurity.psd1`. The new |
||||
|
cmdlets `Get-Privileges`, `Disable-Privileges`, and `Enable-Privileges` |
||||
|
are for manual control. |
||||
|
- The `-Path` parameter now works consistently. |
||||
|
|
||||
|
## 2.1 |
||||
|
|
||||
|
- Fixed bugs with `Set-Owner`. |
||||
|
- Added support for managing auditing (SACL). |
||||
|
|
||||
|
## 2.0 (beta) |
||||
|
|
||||
|
- New commands: `Get-SimpleAccess`, `Get-SimpleEffectiveAccess`, |
||||
|
`Show-SimpleAccess`, `Show-SimpleEffectiveAccess`, and `Copy-Access`. |
||||
|
- All cmdlets are now written in C#. |
||||
|
- Fixed a number of bugs. |
||||
|
|
||||
|
## 1.3 |
||||
|
|
||||
|
- Fixed an issue with parameter handling. |
||||
|
- Now works with PowerShell 3.0. |
||||
|
|
||||
|
## 1.2 |
||||
|
|
||||
|
- Fixed some issues with path validation. |
||||
|
- Fixed documentation bugs. |
||||
|
|
||||
|
## 1.1 |
||||
|
|
||||
|
- Fixed the issue with square brackets in paths. |
||||
|
- Performance improvements. |
||||
|
|
||||
|
## 1.0 |
||||
|
|
||||
|
- The last tests didn't reveal any issue. PowerShell has a problem handling |
||||
|
files that have square brackets in the file name, and this module inherits |
||||
|
the issue. |
||||
|
|
||||
|
## 0.9 (beta) |
||||
|
|
||||
|
- Fixed some bugs. |
||||
|
- Updated documentation. |
||||
|
|
||||
|
## 0.8 (beta) |
||||
|
|
||||
|
- Initial release. |
||||
@ -1 +0,0 @@ |
|||||
mkdocs==1.6.1 |
|
||||
@ -1,57 +0,0 @@ |
|||||
copyright: "The NTFSSecurity module is licensed under the <a href='https://github.com/raandree/NTFSSecurity/blob/master/LICENSE'>MIT license</a>." |
|
||||
repo_url: https://github.com/raandree/NTFSSecurity |
|
||||
edit_uri: edit/master/Docs/ |
|
||||
nav: |
|
||||
- Home: ./index.md |
|
||||
- Concepts: ./Concepts.md |
|
||||
- Examples: ./Examples.md |
|
||||
- Cmdlets: |
|
||||
- Add-NTFSAccess: Cmdlets/Add-NTFSAccess.md |
|
||||
- Add-NTFSAudit: Cmdlets/Add-NTFSAudit.md |
|
||||
- Clear-NTFSAccess: Cmdlets/Clear-NTFSAccess.md |
|
||||
- Clear-NTFSAudit: Cmdlets/Clear-NTFSAudit.md |
|
||||
- Copy-Item2: Cmdlets/Copy-Item2.md |
|
||||
- Disable-NTFSAccessInheritance: Cmdlets/Disable-NTFSAccessInheritance.md |
|
||||
- Disable-NTFSAuditInheritance: Cmdlets/Disable-NTFSAuditInheritance.md |
|
||||
- Disable-Privileges: Cmdlets/Disable-Privileges.md |
|
||||
- Enable-NTFSAccessInheritance: Cmdlets/Enable-NTFSAccessInheritance.md |
|
||||
- Enable-NTFSAuditInheritance: Cmdlets/Enable-NTFSAuditInheritance.md |
|
||||
- Enable-Privileges: Cmdlets/Enable-Privileges.md |
|
||||
- Get-ChildItem2: Cmdlets/Get-ChildItem2.md |
|
||||
- Get-DiskSpace: Cmdlets/Get-DiskSpace.md |
|
||||
- Get-FileHash2: Cmdlets/Get-FileHash2.md |
|
||||
- Get-Item2: Cmdlets/Get-Item2.md |
|
||||
- Get-NTFSAccess: Cmdlets/Get-NTFSAccess.md |
|
||||
- Get-NTFSAudit: Cmdlets/Get-NTFSAudit.md |
|
||||
- Get-NTFSEffectiveAccess: Cmdlets/Get-NTFSEffectiveAccess.md |
|
||||
- Get-NTFSHardLink: Cmdlets/Get-NTFSHardLink.md |
|
||||
- Get-NTFSInheritance: Cmdlets/Get-NTFSInheritance.md |
|
||||
- Get-NTFSOrphanedAccess: Cmdlets/Get-NTFSOrphanedAccess.md |
|
||||
- Get-NTFSOrphanedAudit: Cmdlets/Get-NTFSOrphanedAudit.md |
|
||||
- Get-NTFSOwner: Cmdlets/Get-NTFSOwner.md |
|
||||
- Get-NTFSSecurityDescriptor: Cmdlets/Get-NTFSSecurityDescriptor.md |
|
||||
- Get-NTFSSimpleAccess: Cmdlets/Get-NTFSSimpleAccess.md |
|
||||
- Get-Privileges: Cmdlets/Get-Privileges.md |
|
||||
- Move-Item2: Cmdlets/Move-Item2.md |
|
||||
- New-NTFSHardLink: Cmdlets/New-NTFSHardLink.md |
|
||||
- New-NTFSSymbolicLink: Cmdlets/New-NTFSSymbolicLink.md |
|
||||
- Remove-Item2: Cmdlets/Remove-Item2.md |
|
||||
- Remove-NTFSAccess: Cmdlets/Remove-NTFSAccess.md |
|
||||
- Remove-NTFSAudit: Cmdlets/Remove-NTFSAudit.md |
|
||||
- Set-NTFSInheritance: Cmdlets/Set-NTFSInheritance.md |
|
||||
- Set-NTFSOwner: Cmdlets/Set-NTFSOwner.md |
|
||||
- Set-NTFSSecurityDescriptor: Cmdlets/Set-NTFSSecurityDescriptor.md |
|
||||
- Test-Path2: Cmdlets/Test-Path2.md |
|
||||
- Contributing: |
|
||||
- Overview: Contributing.md |
|
||||
- Getting Started: Contributing/01-Getting-Started.md |
|
||||
- Writing: Contributing/02-Writing.md |
|
||||
- Style Guide: Contributing/03-Style-Guide.md |
|
||||
- Markdown Specifics: Contributing/04-Markdown-Specifics.md |
|
||||
site_name: NTFSSecurity |
|
||||
site_description: PowerShell module for managing NTFS permissions, auditing, inheritance, and ownership |
|
||||
theme: readthedocs |
|
||||
site_author: Raimund Andrée, James Smith |
|
||||
docs_dir: ./Docs |
|
||||
exclude_docs: | |
|
||||
/requirements.txt |
|
||||
Loading…
Reference in new issue