Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dsccommunity/xsystemsecurity
THIS MODULE HAS BEEN DEPRECATED. See the README.md for more information.
https://github.com/dsccommunity/xsystemsecurity
dsc dsc-resources filesystem powershell uac
Last synced: about 2 months ago
JSON representation
THIS MODULE HAS BEEN DEPRECATED. See the README.md for more information.
- Host: GitHub
- URL: https://github.com/dsccommunity/xsystemsecurity
- Owner: dsccommunity
- License: mit
- Created: 2015-04-15T22:43:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-30T13:05:37.000Z (about 4 years ago)
- Last Synced: 2024-05-08T22:11:15.321Z (8 months ago)
- Topics: dsc, dsc-resources, filesystem, powershell, uac
- Language: PowerShell
- Homepage: https://github.com/dsccommunity/xSystemSecurity/blob/master/README.md
- Size: 163 KB
- Stars: 16
- Watchers: 20
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# **THIS MODULE HAS BEEN DEPRECATED**
It will no longer be released. Please use the following modules instead:
- The resource `xIEEsc` have been replaced by `IEEnhancedSecurityConfiguration`
in the module [ComputerManagementDsc](https://github.com/dsccommunity/ComputerManagementDsc).
- The resource `xUac` have been replaced by `UserAccountControl`
in the module [ComputerManagementDsc](https://github.com/dsccommunity/ComputerManagementDsc).
- The resource `xFileSystemAccessRule` have been replaced by `FileSystemAccessRule`
in the module [FileSystemDsc](https://github.com/dsccommunity/FileSystemDsc).
## xSystemSecurity
[](https://dev.azure.com/dsccommunity/xSystemSecurity/_build/latest?definitionId=17&branchName=master)
[](https://dsccommunity.visualstudio.com/xSystemSecurity/_test/analytics?definitionId=17&contextType=build)
[](https://www.powershellgallery.com/packages/xSystemSecurity/)
[](https://www.powershellgallery.com/packages/xSystemSecurity/)
This module contains DSC resources for configuring and managing computer security.
## Code of Conduct
This project has adopted this [Code of Conduct](CODE_OF_CONDUCT.md).
## Releases
For each merge to the branch `master` a preview release will be
deployed to [PowerShell Gallery](https://www.powershellgallery.com/).
Periodically a release version tag will be pushed which will deploy a
full release to [PowerShell Gallery](https://www.powershellgallery.com/).
## Contributing
Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).
## Resources
* **xUAC** handles how and when the User Account Control Windows Prompt
shows up or doesn't show up.
* **xIEEsc** enables or disables IE Enhanced Security Configuration.
* **xFileSystemAccessRule** modifies the rights of file system objects.
### xUAC
* **Setting**: The desired User Account Control Setting:
{ AlwaysNotify | NotifyChanges | NotifyChangesWithoutDimming | NeverNotify |
NeverNotifyAndDisableAll }
* **AlwaysNotify**: You will be notified before programs make changes to your
computer or to Windows settings that require the permissions of an administrator.
When you're notified, your desktop will be dimmed, and you must either approve
or deny the request in the UAC dialog box before you can do anything else on
your computer. The dimming of your desktop is referred to as the secure desktop
because other programs can't run while it's dimmed. This is the most secure
setting. When you are notified, you should carefully read the contents of each
dialog box before allowing changes to be made to your computer.
* **NotifyChanges**: You will be notified before programs make changes to your
computer that require the permissions of an administrator. You will not be notified
if you try to make changes to Windows settings that require the permissions of
an administrator. You will be notified if a program outside of Windows tries
to make changes to a Windows setting. It's usually safe to allow changes to be
made to Windows settings without you being notified. However, certain programs
that come with Windows can have commands or data passed to them, and malicious
software can take advantage of this by using these programs to install files
or change settings on your computer. You should always be careful about which
programs you allow to run on your computer.
* **NotifyChangesWithoutDimming**: You will be notified before programs make
changes to your computer that require the permissions of an administrator.
You will not be notified if you try to make changes to Windows settings that
require the permissions of an administrator. You will be notified if a program
outside of Windows tries to make changes to a Windows setting. This setting is
the same as "NotifyChanges" but you are not notified on the secure desktop.
Because the UAC dialog box isn't on the secure desktop with this setting, other
programs might be able to interfere with the dialog's visual appearance. This
is a small security risk if you already have a malicious program running on
your computer.
* **NeverNotify**: You will not be notified before any changes are made to your
computer. If you are logged on as an administrator, programs can make changes
to your computer without you knowing about it. If you are logged on as a
standard user, any changes that require the permissions of an administrator will
automatically be denied. If you select this setting, you will need to restart
the computer to complete the process of turning off UAC. Once UAC is off, people
that log on as administrator will always have the permissions of an administrator.
This is the least secure setting. When you set UAC to never notify, you open
up your computer to potential security risks. If you set UAC to never notify,
you should be careful about which programs you run, because they will have the
same access to the computer as you do. This includes reading and making changes
to protected system areas, your personal data, saved files, and anything else
stored on the computer. Programs will also be able to communicate and transfer
information to and from anything your computer connects with, including the
Internet.
* **NeverNotifyAndDisableAll**: You will not be notified before any changes are
made to your computer. If you are logged on as an administrator, programs can
make changes to your computer without you knowing about it. If you are logged
on as a standard user, any changes that require the permissions of an administrator
will automatically be denied. If you select this setting, you will need to
restart the computer to complete the process of turning off UAC. Once UAC is
off, people that log on as administrator will always have the permissions of
an administrator. This is the least secure setting same as "NeverNotify", but
in addition EnableLUA registry key is disabled. EnableLUA controls the behavior
of all UAC policy settings for the computer. If you change this policy setting,
you must restart your computer. We do not recommend using this setting, but it
can be selected for systems that use programs that are not certified for
Windows 8, Windows Server 2012, Windows 7 or Windows Server 2008 R2 because
they do not support UAC.
### xIEEsc
* **UserRole**: Enable or Disable ESC for **Administrators** or **Users**.
* **IsEnabled**: Determines if ESC is **Enabled** or **Disabled**.
### xFileSystemAccessRule
* **`[String]` Path** _(Key)_: The path to the item that should have
permissions set
* **`[String]` Identity** _(Key)_: The identity to set permissions for
* **`[String[]]` Rights** _(Write)_: The permissions to include in this
rule. Optional if Ensure is set to value 'Absent'. { ListDirectory |
ReadData | WriteData | CreateFiles | CreateDirectories | AppendData |
ReadExtendedAttributes | WriteExtendedAttributes | Traverse | ExecuteFile |
DeleteSubdirectoriesAndFiles | ReadAttributes | WriteAttributes | Write |
Delete | ReadPermissions | Read | ReadAndExecute | Modify | ChangePermissions |
TakeOwnership | Synchronize | FullControl }
* **`[String]` Ensure** _(Write)_: Present to create the rule, Absent to
remove an existing rule. Default value is 'Present'. { *Present* | Absent }
* **`[Boolean]` ProcessOnlyOnActiveNode** _(Write)_: Specifies that the resource
will only determine if a change is needed if the target node is the active host
of the filesystem object. The user the configuration is run as must have
permission to the Windows Server Failover Cluster.
* **`[Boolean]` IsActiveNode** _(Read)_: Determines if the current node
is actively hosting the filesystem object. This will always return
$true if ProcessOnlyOnActiveNode is not set or the value of
ProcessOnlyOnActiveNode is set to $false.
Please refer to [this article](http://technet.microsoft.com/en-us/library/dd883248(v=ws.10).aspx)
for the effects and security impact of Enhanced Security Configuration.
## Examples
### Disable User Account Control
This configuration will never show the UAC prompt and will disable all
User Account Control settings. This setting when changed requires a restart
of the computer.
```powershell
Configuration NeverNotifyAndDisableAll
{
Import-DSCResource -Module MSFT_xSystemSecurity -Name xUac
Node localhost
{
xUAC NeverNotifyAndDisableAll
{
Setting = "NeverNotifyAndDisableAll"
}
}
}
```
### Disable IE Enhanced Security Configuration
This configuration will disable IE Enhanced Security Configuration.
```powershell
Configuration DisableLocalIEEsc
{
Import-DSCResource -Module MSFT_xSystemSecurity -Name xIEEsc
Node localhost
{
xIEEsc DisableIEEsc
{
IsEnabled = $false
UserRole = "Users"
}
}
}
```
### Sets a permission on a specific folder
This configuration will grant the network service account full control
over the directory.
```powershell
Configuration FullControlExample
{
Import-DSCResource -Module MSFT_xSystemSecurity
Node localhost
{
xFileSystemAccessRule FullControlExample
{
Path = "$env:SystemDrive\some\path"
Identity = "NT AUTHORITY\NETWORK SERVICE"
Rights = @("FullControl")
}
}
}
```