advanced_security_policy
This module sets Advanced Security Policy settings on Windows.
Version information
released Jun 7th 2022
This version is compatible with:
Start using this module
Add this module to your Puppetfile:
mod 'kpn-advanced_security_policy', '3.0.0'Learn more about managing modules with a PuppetfileDocumentation
kpn/advanced_security_policy — version 3.0.0 Jun 7th 2022
advanced_security_policy
Table of Contents
- advanced_security_policy
- [Table of Contents](#table-of-contents)
Overview
This module sets and enforces the advanced security policies for windows.
Module Description
This module uses LGPO.exe (v2.2) to configure the advanced security policies on Windows. LGPO.exe is a command-line utility that is designed to help automate management of Local Group Policy. It can import and apply settings from Registry Policy (Registry.pol) files, security templates, Advanced Auditing backup files, as well as from formatted “LGPO text” files.
Setup
Setup Requirements
This module requires:
- ADMX and ADML files with the policy settings to be set (in
C:\Windows\PolicyDefinitions) - LGPO.exe needs to be installed in
C:\Windows\System32(Add the following code)include advanced_security_policy
What advanced_security_policy affects
- Advanced security policies.
C:\Windows\System32\GroupPolicy\Machine\Registry.pol- A backup is made of
C:\Windows\System32\GroupPolicy\Machine\Registry.poland is placed inC:\Management\advanced_security\Registry.pol
Beginning with advanced_security_policy
To start using advanced_security_policy, simply include the module and add the defined type statements in your profile. Then configure the policies you want to set. (for example in hiera)
Usage
When using Configure SMB v1 client driver you may also need to set Configure SMB v1 client to ['Bowser','MRxSmb20','NSI'] due to dependencies for this service
Parameters
policy(resource) name (required)
Type: 'String' Default: '$title' Values: Any valid advanced security subcategory Description: The policy name matches the name in the policy editor
ensure
Type: 'String' Default: 'present' Values: 'present' or 'absent' Description: When a policy is set, ensure will be 'present'. If a policy is to be set as 'not configured' then ensure must be set to 'absent'.
policy_value
Type: 'String' Values: 'enabled', 'disabled' or a value Description: This is the value to be set for the policy. This can be 'enabled', 'disabled' or a value to be set.
Examples
Example: Setting multiple security policies
advanced_security_policy {'Turn off Autoplay':
policy_value => '255',
}
advanced_security_policy {Configuration of wireless settings using Windows Connect Now':
policy_value => 'disabled'
}
advanced_security_policy {'MSS: (AutoAdminLogon) Enable Automatic Logon (not recommended)':
policy_value => 'enabled',
}
advanced_security_policy {'Security: Specify the maximum log file size (KB)':
ensure => 'absent',
}
Reference
Defined Types
- advanced_security_policy
Provider
- securitypolicy
Limitations
This is where you list OS compatibility, version compatibility, etc.
This module works on:
- Windows 2008 R2
- Windows 2012 R2
- Windows 2016
- Windows 2019
- Windows 2022
Development
You can contribute by submitting issues, providing feedback and joining the discussions.
Go to: https://github.com/kpn-puppet/puppet-kpn-advanced_security_policy
If you want to fix bugs, add new features etc:
- Fork it
- Create a feature branch ( git checkout -b my-new-feature )
- Apply your changes and update rspec tests
- Run rspec tests ( bundle exec rake spec )
- Commit your changes ( git commit -am 'Added some feature' )
- Push to the branch ( git push origin my-new-feature )
- Create new Pull Request
2022-05-12 Release 3.0.0
- add User configuration policies
- update 'Minimize the number of simultaneous connections to the Internet or a Windows Domain' policy
- fix 'Configure detection for potentially unwanted applications' policy (removed spaces)
- add windows 2022 extra checks
2022-05-11 Release 2.6.0
- Add Firewall settings to policy
2020-12-23 Release 2.5.3
- fix 'Turn off the offer to update to the latest version of Windows' policy
2020-06-08 Release 2.5.2
- Add new policy settings
- 'Configure SMB v1 client'
This setting may need to be set to
['Bowser','MRxSmb20','NSI']when using theConfigure SMB v1 client driverpolicy
- 'Configure SMB v1 client'
This setting may need to be set to
2020-05-26 Release 2.5.1
- fix 'Minimize the number of simultaneous connections to the Internet or a Windows Domain' enabled = 1 (was 3) was changes in previous release but needs more testing and has been rolled back.
2020-05-13 Release 2.5.0
- Add new policy settings
- Turn off Windows Error Reporting (PCHealth)
- Do not allow drive redirection
- Turn on behavior monitoring
- Scan removable drives
- Turn on e-mail scanning
- Configure Attack Surface Reduction rules
- Prevent users and apps from accessing dangerous websites
- Configure detection for potentially unwanted applications
- Minimize the number of simultaneous connections to the Internet or a Windows Domain (enabled = 3, was 1)
2019-09-25 Release 2.4.0
- Add new policy settings for windows 2019
- Turn Off notifications network usage
- Encryption Oracle Remediation
- Enumeration policy for external devices incompatible with Kernel DMA Protection
- Allow Clipboard synchronization across devices
- Allow upload of User Activities
- Require use of specific security layer for remote (RDP) connections
- Require user authentication for remote connections by using Network Level Authentication
- Prevent users from modifying settings
2018-01-31 Release 2.3.0
- make a backup of the registry.pol file
- Add new policy settings:
- Configure SMB v1 client driver
- Configure SMB v1 server
- Remote host allows delegation of non-exportable credentials
- Turn off picture password sign-in
- Turn off Windows Location Provider
- Configure local setting override for reporting to Microsoft MAPS
- Require Mutual Authentication (NETLOGON)
- Require Mutual Authentication (SYSVOL)
- Allow Online Tips
- Configure Authenticated Proxy usage for the Connected User Experience and Telemetry service
- Allow Message Service Cloud Sync
- Block all consumer Microsoft account user authentication
2018-11-15 Release 2.2.0
- Add 'gpupdate /force /n' as a scheduled task to fix 'illegal' changes to the registry
2018-04-04 Release 2.1.1
- release to puppet forge
2018-01-23 Release 2.1.0
- allows configurable result for enabled and disabled
- policy_setting has changed to policy_value (same as local_security_policy)
2017-12-19 Release 2.0.1
- unknown (domain) policies already set on the system are ignored
- trying to set an unknown/invalid policy using puppet will still result in an error
2017-12-04 Release 2.0.0
- makes advanced security policy settings ensurable
- policy names are looked up in a list
2017-11-28 Release 1.0.4
- makes the provider case-insensitive
2017-10-11 Release 1.0.3
- change permission on lgpo.exe
2017-07-06 Release 1.0.2
- changed file persmissions because of missing administrator user
2017-07-06 Release 1.0.1
- add file lgpo.exe creation
2017-07-06 Release 1.0.0
- initial commit
Dependencies
- puppetlabs/scheduled_task (>=4.6.0 <5.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.