secure_windows

pdk
deprecated
This module hardens Windows Servers to DoD STIG compliance.

Bryan Belanger

autostructure

5,874 downloads

4,033 latest version

5.0 quality score

Version information

  • 1.0.5 (latest)
  • 1.0.4
  • 1.0.3
  • 1.0.2
  • 1.0.1
  • 1.0.0
released Jan 23rd 2019
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 6.0.0
  • windows
This module has been deprecated by its author since Oct 28th 2019.

The author has suggested fervid-secure_windows as its replacement.

Start using this module

Documentation

autostructure/secure_windows — version 1.0.5 Jan 23rd 2019

secure_windows

License Build Status Puppet Forge Puppet Forge Score Puppet Forge Downloads

Table of Contents

  1. Description
  2. Setup - Getting you started with secure_windows
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Possible Limitations - Some features may not work with certain system configurations
  6. Coverage
  7. Development - Guide for contributing to the module
  8. Copyright
  9. Additional Info

Description

This module hardens Member, Standalone, and Domain Controller Window Servers for Windows Server 2016 (Release 2) Department of Defense Security Technical Implementation Guide (STIG) specifications, which can be found here.

The benchmark dates for the Windows Server 2016 STIG is 7/28/17. The STIG vulnerabilities have been cross-referenced with the National Institute of Security and Technology 800 53 Controls, for users who desire the additional information.

This module covers most of the Windows Server 2016 STIG (Release 2) vulnerabilities. For a list of vulnerabilities we do not cover due to their nature, see Non-Applicable to the System. For a list of vulnerabilities that Puppet reports on, but does not enforce see Vulnerabilities Reported on but Not Changed.

Setup

To have Puppet harden the server to DoD STIG compliance with default settings, declare the secure_windows class:

class { '::secure_windows': }

When you declare this class with the default options, Puppet will enforce all STIG vulnerabilities that we cover and produce warnings for vulnerabilities that we report on (see Coverage).

This class applies the correct vulnerabilities for Standalone servers, Member servers, and Domain Controllers.

Domain Controllers must install the nokogiri gem due to a dependency with the ad_acl module. Perform the following on each Domain Controller, or have Puppet install the gem.

gem install nokogiri
package { 'nokogiri':
  ensure   => installed,
  provider => gem,
}

Usage

Disabling Vulnerabilities with Hiera

There are 277 vulnerabilities included in the Windows Server 2016 STIG, and each one can be turned ON or OFF, according to the needs of the system. By default, all vulnerabilities are turned ON to ensure maximum security out-of-box. This is how you would turn off a vulnerablity using your company's Hiera configuration.

# hieradata/common.yaml
secure_windows::stig::v73379::enforced: false

See Possible Limitations for a list of vulnerabilities that might not apply to certain systems.

For example, FTP servers need to have the FTP role enabled, which V-73289 removes. On those systems, that vulnerability should be disabled:

# hieradarta/role/ftp.yaml
secure_windows::stig::v73289::enforced: false

See Reference for a list of parameters that are needed to customize your security configurations.

For example, according to V-73307 systems should be synced to the appropriate time server. You can define that parameter in hiera:

# hieradata/common.yaml
secure_windows::stig::v73307::time_server: time.example.com

No-Op Mode

It is possible to run the module in "No-Op Mode", which identifies detected Configuration Drifts without implementing any actual changes. This is useful for auditing the state of your system without making any changes.

puppet agent -t --noop

Troubleshooting

Problem:
You encounter a "Duplicate declaration: Class[Windows_firewall]" error during the puppet agent run:

Error: Could not retrieve catalog from remote server: Error 500 on SERVER: Server Error: Evaluation Error: Error while evaluating a Resource Statement, Evaluation Error: Error while evaluating a Resource Statement, Duplicate declaration: Class[Windows_firewall] is already declared in file <your-filename-that-contains-windows-firewall-declaration>; cannot redeclare at /etc/puppetlabs/code/environments/production/modules/secure_windows/manifests/stig/v73279.pp:7 ...

Reason:
This occurs because the "puppet-windows_firewall" module requires a Class statement to run the firewall (shown below), which conflicts with any declarations you might have if you use the module. If you receive this error, the declaration below likely exists in one of your manifests:

class{ '::windows_firewall':
    ensure => 'running',
  }

Fix:
Simply disable vulnerability v73279 in hiera:

# hieradata/common.yaml
secure_windows::stig::v73279::enforced: false

Reference

Parameters

ftp_sites

Default value: []

Acceptable values are an array of ftp sites. This parameter should be set for FTP servers and contain an array of FTP sites that are on the server.

Used in STIG V-73303

time_server

Default value: 'tick.usno.navy.mil'

This should be the appropriate time server for your organization.

Used in STIG V-73307

lsacfgflags

Default value: 'lock'

Acceptable values are 'lock' or 'no lock', which correspond to 'Enabled with UEFI lock' and 'Enabled without lock' respectively.

Used in STIG V-73515

hypervisorenforcedcodeintegrity

Default value: 'lock'

Acceptable values are 'lock' or 'no lock', which correspond to 'Enabled with UEFI lock' and 'Enabled without lock' respectively.

Used in STIG V-73517

driverloadpolicy

Default value: '1'

Acceptable values are '1', '3', or '8', which correspond to 'Good and unknown', 'Good, unknown and bad but critical', and 'Good only' respectively.

Used in STIG V-73521

allowtelemetry

Default value: 'security'

Acceptable values are 'security' and 'basic'.

Used in STIG V-73551

admin_account_name

Default value: 'adminaccount'

Acceptable values are any string. This is what Puppet will rename the Local Administrator account to.

Used in STIG V-73623

guest_account_name

Default value: 'guestaccount'

Acceptable values are any string. This is what Puppet will rename the built-in guest account to.

Used in STIG V-73625

legalnoticetext

Default value: 'I\'ve read & consent to terms in IS user agreement.'

Acceptable values are any string. This will be the legal notice displayed when users log in.

Used in STIG V-73647

legalnoticetitle

Default value: 'US Department of Defense Warning Statement'

Acceptable values are any string. This will be the legal notice title displayed when users log in.

Used in STIG V-73649

scremoveoption

Default value: '1'

Acceptable values are 1 (Lock Workstation) or 2 (Force Logoff).

Used in STIG V-73807

Possible Limitations

Below are lists of vunerabilities that can potentially break the client's application if the rights described in the listed vulnerability are essential to operation.

Potentially Application-Breaking Rights Privileges

Below is a list of vulnerabilities that require extra care and attention. By default, these vulnerabilities enforce proper user permissions on the machine. However, it is possible that an application might require one of these user rights. In that case, vendor documentation must support the requirement for having the user right and the requirement must be documented with the ISSO. In addition, you should disable this module from managing that right on that node, as it could break that application. Instead, manage that right in your own Puppet code:

  • V-73731
  • V-73733
  • V-73735
  • V-73739
  • V-73743
  • V-73747
  • V-73749
  • V-73755
  • V-73783
  • V-73785
  • V-73787
  • V-73791
  • V-73793
  • V-73801
  • V-73803

Exemptions for Systems Dedicated to the Management of Active Directory

Below is a list of vulnerabilities that should not be applied to systems dedicated to the management of Active Directory. For such systems, do not enforce these vulnerabilities:

  • V-73759
  • V-73771
  • V-73775

Registry Key ACLs

Puppet cannot enforce the default permissions on HKLM:security\ because its default permissions are too restrictive to allow Puppet to inspect them. We can enforce the permissions on all other keys. This affects:

  • V-73255

FTP Servers

The following will remove the FTP feature on all servers. This will break any server that is suppsosed to be an FTP server. Disable this vulnerability on FTP servers:

  • V-73289

Screen Savers

Applications requiring continuous, real-time screen display (e.g., network management products) must disable the following vulnerability that requires a screen saver:

  • V-73723

Audit Servers

Systems that are configured to write events directly to an audit server can disable the following vulnerabilities:

  • V-73553
  • V-73555
  • V-73557

Coverage

Vulnerabilities Reported on but Not Changed

The following vulnerabilities will be reported on, but not changed. If Puppet detects that the system is not compliant with these vulnerabilities it will produce a warning that shows in the node's report, but will not make the corrective change on the system. These vulnerabilities have been determined to need manual review before making corrective changes due to their disruptive nature.

  • V-73237
  • V-73239
  • V-73247
  • V-73259
  • V-73261
  • V-73263
  • V-73305
  • V-73379
  • V-73513
  • V-73611

Non-Applicable to the System

The following vulnerabilities are not covered by secure_windows. This is due to them being process-oriented and not possible for Puppet to configure or report on.

  • V-73217
  • V-73219
  • V-73221
  • V-73223
  • V-73227
  • V-73229
  • V-73231
  • V-73233
  • V-73241
  • V-73243
  • V-73245
  • V-73257
  • V-73265
  • V-73267
  • V-73269
  • V-73271
  • V-73273
  • V-73275
  • V-73281
  • V-73283
  • V-73285
  • V-73383
  • V-73385
  • V-73401
  • V-73403
  • V-73613
  • V-73615
  • V-73617

Development

How to Contribute

Create a pull request and we will review your change. Log issues in the issues tab.

Running Tests

This module is built on PDK, which can be used for testing. Download PDK and run the following commands:

pdk validate
pdk test unit

Alternatively, you can run the following to test the module:

bundle install
bundle exec rake rubocop
bundle exec rake syntax lint
bundle exec rake metadata_lint
bundle exec rake spec

Contributors

This module is an open source project that was created and maintained by Autostructure. For a list of contributors, see the list of contributors.

Disclaimer

This Work is provided "as is." Any express or implied warranties, including but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the authors be liable for any direct, indirect, incidental, special, exemplary or consequential damages (including, but not limited to, procurement of substitute goods or services, loss of use, data or profits, or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this Guidance, even if advised of the possibility of such damage.

The User of this Work agrees to hold harmless and indemnify Autostructure, its agents, parent company, and employees from every claim or liability (whether in tort or in contract), including attorneys' fees, court costs, and expenses, arising in direct consequence of Recipient's use of the item, including, but not limited to, claims or liabilities made for injury to or death of personnel of User or third parties, damage to or destruction of property of User or third parties, and infringement or other violations of intellectual property or technical data rights.

Nothing in this Work is intended to constitute an endorsement, explicit or implied, by Autostructure of any particular manufacturer's product or service.

Copyrights

All materials are copyright by their respective owners unless otherwise noted.

Released under the Apache License, Version 2.

NIST 800 53 Controls

Each of the controls listed below are classified as either Low, Moderate, or High, based on the potential impact a security breach could have on an organization's systems. This is based on the Windows Server 2012 and 2016 STIGs.

Low Covered (x) Moderate Covered (x) High Covered (x)
AC-1 AC-1 AC-1
AC-2 AC-2 (2) (4) AC-2
AC-3 x AC-3 x AC-3 x
AC-4 AC-4
AC-5 AC-5
AC-6 (1) (2) (5) (9) (10) (9) (10) AC-6 (1) (2) (3) (5) (9) (10)
AC-7 x AC-7 x AC-7 x
AC-8 x AC-8 x AC-8 x
AC-10
AC-11 (1) x AC-11 (1) x
AC-12 x AC-12 x
AC-14 AC-14 AC-14
AC-17 AC-17 (1) (2) (3) (4) (1) (2) AC-17 (1) (2) (3) (4)
AC-18 N/A AC-18 (1) N/A AC-18 (1) (4) (5) N/A
AC-19 N/A AC-19 (5) N/A AC-19 (5) N/A
AC-20 AC-20 (1) (2) AC-20 (1) (2)
AC-21 x AC-21 x
AC-22 AC-22 AC-22
AT-1 AT-1 AT-1
AT-2 AT-2 (2) AT-2 (2)
AT-3 AT-3 AT-3
AT-4 AT-4 AT-4
AU-1 AU-1 AU-1
AU-2 AU-2 (3) AU-2 (3)
AU-3 AU-3 (1) x AU-3 (1) (2)
AU-4 x AU-4 x AU-4 x
AU-5 AU-5 AU-5 (1) (2)
AU-6 AU-6 (1) (3) AU-6 (1) (3) (5) (6)
AU-7 (1) AU-7 (1)
AU-8 AU-8 (1) a AU-8 (1)
AU-9 x AU-9 (4) AU-9 (2) (3) (4)
AU-10
AU-11 AU-11 AU-11
AU-12 x AU-12 x AU-12 (1) (3) (3)
CA-1 CA-1 CA-1
CA-2 CA-2 (1) CA-2 (1) (2)
CA-3 CA-3 (5) x CA-3 (5) x
CA-5 CA-5 CA-5
CA-6 CA-6 CA-6
CA-7 CA-7 (1) CA-7 (1)
CA-8
CA-9 CA-9 CA-9
CM-1 CM-1 CM-1
CM-2 CM-2 (1) (3) (7) CM-2 (1) (2) (3) (7)
CM-3 (2) CM-3 (1) (2)
CM-4 x CM-4 x CM-4 (1)
CM-5 CM-5 (1) (2) (3)
CM-6 b CM-6 CM-6 (1) (2)
CM-7 x CM-7 (1) (2) (4) (2) CM-7 (1) (2) (5)
CM-8 CM-8 (1) (3) (5) CM-8 (1) (2) (3) (4) (5)
CM-9 CM-9
CM-10 x CM-10 x CM-10 x
CM-11 CM-11 CM-11
CP-1 CP-1 CP-1
CP-2 CP-2 (1) (3) (8) CP-2 (1) (2) (3) (4) (5) (8)
CP-3 CP-3 CP-3 (1)
CP-4 CP-4 (1) CP-4 (1) (2)
CP-6 (1) (3) CP-6 (1) (2) (3)
CP-7 (1) (2) (3) CP-7 (1) (2) (3) (4)
CP-8 (1) (2) CP-8 (1) (2) (3) (4)
CP-9 CP-9 (1) CP-9 (1) (2) (3) (5)
CP-10 CP-10 (2) CP-10 (2) (4)
IA-1 IA-1 IA-1
IA-2(1) (12) (1) IA-2 (1) (2) (3) (8) (11) (12) (1) (2) (3) (8) (11) IA-2 (1) (2) (3) (4) (8) (9) (11) (12) (1) (2) (3) (4) (8) (9) (11)
IA-3 IA-3
IA-4 e IA-4 IA-4
IA-5(1) (11) IA-5 (1) (2) (3) (11) 2a IA-5 (1) (2) (3) (11)
IA-6 IA-6 IA-6
IA-7 x IA-7 x IA-7 x
IA-8(1) (2) (3) (4) x IA-8 (1) (2) (3) (4) x IA-8 (1) (2) (3) (4) x
IR-1 IR-1 IR-1
IR-2 IR-2 IR-2 (1) (2)
IR-3 (2) IR-3 (2)
IR-4 IR-4 (1) IR-4 (1) (4)
IR-5 IR-5 IR-5 (1)
IR-6 IR-6 (1) IR-6 (1)
IR-7 IR-7 (1) IR-7 (1)
IR-8 IR-8 IR-8
MA-1 MA-1 MA-1
MA-2 c,d MA-2 MA-2 (2)
MA-3 (1) (2) MA-3 (1) (2) (3)
MA-4 c MA-4 (2) MA-4 (2) (3)
MA-5 MA-5 MA-5 (1)
MA-6 MA-6
MP-1 MP-1 MP-1
MP-2 MP-2 MP-2
MP-3 MP-3
MP-4 MP-4
MP-5 (4) MP-5 (4)
MP-6 MP-6 MP-6 (1) (2) (3)
MP-7 MP-7 (1) MP-7 (1)
PE-1 PE-1 PE-1
PE-2 PE-2 PE-2
PE-3 PE-3 PE-3 (1)
PE-4 PE-4
PE-5 PE-5
PE-6 PE-6 (1) PE-6 (1) (4)
PE-8 PE-8 PE-8 (1)
PE-9 PE-9
PE-10 PE-10
PE-11 PE-11 (1)
PE-12 PE-12 PE-12
PE-13 PE-13 (3) PE-13 (1) (2) (3)
PE-14 PE-14 PE-14
PE-15 PE-15 PE-15 (1)
PE-16 PE-16 PE-16
PE-17 PE-17
PE-18
PL-1 PL-1 PL-1
PL-2 PL-2 (3) PL-2 (3)
PL-4 PL-4 (1) PL-4 (1)
PL-8 PL-8
PS-1 PS-1 PS-1
PS-2 PS-2 PS-2
PS-3 PS-3 PS-3
PS-4 PS-4 PS-4 (2)
PS-5 PS-5 PS-5
PS-6 PS-6 PS-6
PS-7 PS-7 PS-7
PS-8 PS-8 PS-8
RA-1 RA-1 RA-1
RA-2 RA-2 RA-2
RA-3 RA-3 RA-3
RA-5 RA-5 (1) (2) (5) RA-5 (1) (2) (4) (5)
SA-1 SA-1 SA-1
SA-2 SA-2 SA-2
SA-3 SA-3 SA-3
SA-4(10) SA-4 (1) (2) (9) (10) SA-4 (1) (2) (9) (10)
SA-5 SA-5 SA-5
SA-8 SA-8
SA-9 SA-9 (2) SA-9 (2)
SA-10 SA-10
SA-11 SA-11
SA-12
SA-15
SA-16
SA-17
SC-1 SC-1 SC-1
SC-2 SC-2
SC-3 x
SC-4 x SC-4 x
SC-5 x SC-5 x SC-5 x
SC-7 SC-7 (3) (4) (5) (7) SC-7 (3) (4) (5) (7) (8) (18) (21)
SC-8 (1) x SC-8 (1) x
SC-10 x SC-10 x
SC-12 SC-12 SC-12 (1)
SC-13 x SC-13 x SC-13 x
SC-15 SC-15 SC-15
SC-17 SC-17
SC-18 SC-18
SC-19 SC-19
SC-20 SC-20 SC-20
SC-21 SC-21 SC-21
SC-22 SC-22 SC-22
SC-23 SC-23
SC-24
SC-28 x SC-28 x
SC-39 x SC-39 x SC-39 x
SI-1 SI-1 SI-1
SI-2 SI-2 (2) x SI-2 (1) (2)
SI-3 SI-3 (1) (2) SI-3 (1) (2)
SI-4 SI-4 (2) (4) (5) SI-4 (2) (4) (5)
SI-5 SI-5 SI-5 (1)
SI-6
SI-7 (1) (7) SI-7 (1) (2) (5) (7) (14)
SI-8 (1) (2) SI-8 (1) (2)
SI-10 SI-10
SI-11 SI-11
SI-12 SI-12 SI-12
SI-16 x SI-16 x