fs.windows

Windows filesystem types and security descriptor access.

Types

Type	Description
DirEntry	Windows directory entries.
FsMetadata	Windows filesystem metadata.
Metadata	Windows file metadata.
Path	fs.Path using Windows path syntax.
StreamEntry	An NTFS alternate data stream of a file.

Functions

sec_desc path … -> security.windows.SecDesc

Gets selected parts of a Windows security descriptor.

Parameters

Name	Type	Description
path	(Str | Path)	Path to query.
:owner?	Bool	Load the owner SID. Defaults to true.
:group?	Bool	Load the primary group SID. Defaults to true.
:dacl?	Bool	Load the discretionary ACL. Defaults to true.
:sacl?	Bool	Load the system ACL. Defaults to false.
:resolve?	fs.Resolve	Resolution mode. Defaults to :TARGET:.

update_sec_desc path ...options …

Applies the components selected by a Windows security descriptor's mask.

Parameters

Name	Type	Description
path	(Str | Path)	Path to update.
desc?	security.windows.SecDescSpec	Descriptor to apply.
:resolve?	fs.Resolve	Resolution mode. Defaults to :TARGET:.
...options	security.windows.SecDescOptions	Components and control flags, instead of or alongside desc.