1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
#
# Author:: Jared Kauppila (<jared@kauppi.la>)
# Author:: Vasundhara Jagdale(<vasundhara.jagdale@chef.io>)
# Copyright:: Copyright (c) Chef Software Inc.
# 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.
#
require_relative "../resource"
class Chef
class Resource
class WindowsUserPrivilege < Chef::Resource
unified_mode true
provides :windows_user_privilege
description "The windows_user_privilege resource allows to add and set principal (User/Group) to the specified privilege.\n Ref: https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/user-rights-assignment"
introduced "16.0"
examples <<~DOC
**Set the SeNetworkLogonRight Privilege for the Builtin Administrators Group and Authenticated Users**:
```ruby
windows_user_privilege 'Network Logon Rights' do
privilege 'SeNetworkLogonRight'
users ['BUILTIN\\Administrators', 'NT AUTHORITY\\Authenticated Users']
action :set
end
```
**Add the SeDenyRemoteInteractiveLogonRight Privilege to the Builtin Guests and Local Accounts User Groups**:
```ruby
windows_user_privilege 'Remote interactive logon' do
privilege 'SeDenyRemoteInteractiveLogonRight'
users ['Builtin\\Guests', 'NT AUTHORITY\\Local Account']
action :add
end
```
**Provide only the Builtin Guests and Administrator Groups with the SeCreatePageFile Privilege**:
```ruby
windows_user_privilege 'Create Pagefile' do
privilege 'SeCreatePagefilePrivilege'
users ['BUILTIN\\Guests', 'BUILTIN\\Administrators']
action :set
end
```
**Remove the SeCreatePageFile Privilege from the Builtin Guests Group**:
```ruby
windows_user_privilege 'Create Pagefile' do
privilege 'SeCreatePagefilePrivilege'
users ['BUILTIN\\Guests']
action :remove
end
```
**Clear all users from the SeDenyNetworkLogonRight Privilege**:
```ruby
windows_user_privilege 'Allow any user the Network Logon right' do
privilege 'SeDenyNetworkLogonRight'
action :clear
end
```
DOC
PRIVILEGE_OPTS = %w{ SeAssignPrimaryTokenPrivilege
SeAuditPrivilege
SeBackupPrivilege
SeBatchLogonRight
SeChangeNotifyPrivilege
SeCreateGlobalPrivilege
SeCreatePagefilePrivilege
SeCreatePermanentPrivilege
SeCreateSymbolicLinkPrivilege
SeCreateTokenPrivilege
SeDebugPrivilege
SeDenyBatchLogonRight
SeDenyInteractiveLogonRight
SeDenyNetworkLogonRight
SeDenyRemoteInteractiveLogonRight
SeDenyServiceLogonRight
SeEnableDelegationPrivilege
SeImpersonatePrivilege
SeIncreaseBasePriorityPrivilege
SeIncreaseQuotaPrivilege
SeIncreaseWorkingSetPrivilege
SeInteractiveLogonRight
SeLoadDriverPrivilege
SeLockMemoryPrivilege
SeMachineAccountPrivilege
SeManageVolumePrivilege
SeNetworkLogonRight
SeProfileSingleProcessPrivilege
SeRelabelPrivilege
SeRemoteInteractiveLogonRight
SeRemoteShutdownPrivilege
SeRestorePrivilege
SeSecurityPrivilege
SeServiceLogonRight
SeShutdownPrivilege
SeSyncAgentPrivilege
SeSystemEnvironmentPrivilege
SeSystemProfilePrivilege
SeSystemtimePrivilege
SeTakeOwnershipPrivilege
SeTcbPrivilege
SeTimeZonePrivilege
SeTrustedCredManAccessPrivilege
SeUndockPrivilege
}.freeze
property :principal, String,
description: "An optional property to add the user to the given privilege. Use only with add and remove action.",
name_property: true
property :users, [Array, String],
description: "An optional property to set the privilege for given users. Use only with set action.",
coerce: proc { |v| Array(v) }
property :privilege, [Array, String],
description: "One or more privileges to set for users.",
required: true,
coerce: proc { |v| Array(v) },
callbacks: {
"Option privilege must include any of the: #{PRIVILEGE_OPTS}" => lambda { |n| (n - PRIVILEGE_OPTS).empty? },
}
load_current_value do |new_resource|
if new_resource.principal && (new_resource.action.include?(:add) || new_resource.action.include?(:remove))
privilege Chef::ReservedNames::Win32::Security.get_account_right(new_resource.principal)
end
end
action :add do
([*new_resource.privilege] - [*current_resource.privilege]).each do |user_right|
converge_by("adding user '#{new_resource.principal}' privilege #{user_right}") do
Chef::ReservedNames::Win32::Security.add_account_right(new_resource.principal, user_right)
end
end
end
action :set do
if new_resource.users.nil? || new_resource.users.empty?
raise Chef::Exceptions::ValidationFailed, "Users are required property with set action."
end
users = []
# Getting users with its domain for comparison
new_resource.users.each do |user|
user = Chef::ReservedNames::Win32::Security.lookup_account_name(user)
users << user[1].account_name if user
end
new_resource.privilege.each do |privilege|
accounts = Chef::ReservedNames::Win32::Security.get_account_with_user_rights(privilege)
# comparing the existing accounts for privilege with users
unless users == accounts
# Removing only accounts which is not matching with users in new_resource
(accounts - users).each do |account|
converge_by("removing user '#{account}' from privilege #{privilege}") do
Chef::ReservedNames::Win32::Security.remove_account_right(account, privilege)
end
end
# Adding only users which is not already exist
(users - accounts).each do |user|
converge_by("adding user '#{user}' to privilege #{privilege}") do
Chef::ReservedNames::Win32::Security.add_account_right(user, privilege)
end
end
end
end
end
action :clear do
new_resource.privilege.each do |privilege|
accounts = Chef::ReservedNames::Win32::Security.get_account_with_user_rights(privilege)
# comparing the existing accounts for privilege with users
# Removing only accounts which is not matching with users in new_resource
accounts.each do |account|
converge_by("removing user '#{account}' from privilege #{privilege}") do
Chef::ReservedNames::Win32::Security.remove_account_right(account, privilege)
end
end
end
end
action :remove do
curr_res_privilege = current_resource.privilege
missing_res_privileges = (new_resource.privilege - curr_res_privilege)
if missing_res_privileges
Chef::Log.info("User \'#{new_resource.principal}\' for Privilege: #{missing_res_privileges.join(", ")} not found. Nothing to remove.")
end
(new_resource.privilege - missing_res_privileges).each do |user_right|
converge_by("removing user #{new_resource.principal} from privilege #{user_right}") do
Chef::ReservedNames::Win32::Security.remove_account_right(new_resource.principal, user_right)
end
end
end
end
end
end
|
