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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
|
# Copyright 2018, Rackspace US, 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.
"""NoLogPasswordsRule used with ansible-lint."""
from __future__ import annotations
import sys
from typing import TYPE_CHECKING
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import Task, convert_to_boolean
if TYPE_CHECKING:
from ansiblelint.file_utils import Lintable
class NoLogPasswordsRule(AnsibleLintRule):
"""Password should not be logged."""
id = "no-log-password"
description = (
"When passing password argument you should have no_log configured "
"to a non False value to avoid accidental leaking of secrets."
)
severity = "LOW"
tags = ["opt-in", "security", "experimental"]
version_added = "v5.0.9"
def matchtask(
self,
task: Task,
file: Lintable | None = None,
) -> bool | str:
if task["action"]["__ansible_module_original__"] == "ansible.builtin.user" and (
task["action"].get("password_lock") and not task["action"].get("password")
):
has_password = False
else:
for param in task["action"]:
if "password" in param:
has_password = True
break
else:
has_password = False
has_loop = [key for key in task if key.startswith("with_") or key == "loop"]
# No no_log and no_log: False behave the same way
# and should return a failure (return True), so we
# need to invert the boolean
no_log = task.get("no_log", False)
if (
isinstance(no_log, str)
and no_log.startswith("{{")
and no_log.endswith("}}")
):
# we cannot really evaluate jinja expressions
return False
return bool(
has_password and not convert_to_boolean(no_log) and len(has_loop) > 0,
)
if "pytest" in sys.modules:
import pytest
if TYPE_CHECKING:
from ansiblelint.testing import RunFromText # pylint: disable=ungrouped-imports
NO_LOG_UNUSED = """
- name: Test
hosts: all
tasks:
- name: Succeed when no_log is not used but no loop present
ansible.builtin.user:
name: john_doe
password: "wow"
state: absent
"""
NO_LOG_FALSE = """
- hosts: all
tasks:
- name: Use of jinja for no_log is valid
user:
name: john_doe
user_password: "{{ item }}"
state: absent
no_log: "{{ False }}"
- name: Fail when no_log is set to False
user:
name: john_doe
user_password: "{{ item }}"
state: absent
with_items:
- wow
- now
no_log: False
- name: Fail when no_log is set to False
ansible.builtin.user:
name: john_doe
user_password: "{{ item }}"
state: absent
with_items:
- wow
- now
no_log: False
"""
NO_LOG_NO = """
- hosts: all
tasks:
- name: Fail when no_log is set to no
user:
name: john_doe
password: "{{ item }}"
state: absent
no_log: no
loop:
- wow
- now
"""
PASSWORD_WITH_LOCK = """
- hosts: all
tasks:
- name: Fail when password is set and password_lock is true
user:
name: "{{ item }}"
password: "wow"
password_lock: true
with_random_choice:
- ansible
- lint
"""
NO_LOG_YES = """
- hosts: all
tasks:
- name: Succeed when no_log is set to yes
with_list:
- name: user
password: wow
- password: now
name: ansible
user:
name: "{{ item.name }}"
password: "{{ item.password }}"
state: absent
no_log: yes
"""
NO_LOG_TRUE = """
- hosts: all
tasks:
- name: Succeed when no_log is set to True
user:
name: john_doe
user_password: "{{ item }}"
state: absent
no_log: True
loop:
- wow
- now
"""
PASSWORD_LOCK_YES = """
- hosts: all
tasks:
- name: Succeed when only password locking account
user:
name: "{{ item }}"
password_lock: yes
# user_password: "this is a comment, not a password"
with_list:
- ansible
- lint
"""
PASSWORD_LOCK_YES_BUT_NO_PASSWORD = """
- hosts: all
tasks:
- name: Succeed when only password locking account
ansible.builtin.user:
name: "{{ item }}"
password_lock: yes
# user_password: "this is a comment, not a password"
with_list:
- ansible
- lint
"""
PASSWORD_LOCK_FALSE = """
- hosts: all
tasks:
- name: Succeed when password_lock is false and password is not used
user:
name: lint
password_lock: False
"""
@pytest.mark.parametrize(
"rule_runner",
(NoLogPasswordsRule,),
indirect=["rule_runner"],
)
def test_no_log_unused(rule_runner: RunFromText) -> None:
"""The task does not use no_log but also no loop."""
results = rule_runner.run_playbook(NO_LOG_UNUSED)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner",
(NoLogPasswordsRule,),
indirect=["rule_runner"],
)
def test_no_log_false(rule_runner: RunFromText) -> None:
"""The task sets no_log to false."""
results = rule_runner.run_playbook(NO_LOG_FALSE)
assert len(results) == 2
for result in results:
assert result.rule.id == "no-log-password"
@pytest.mark.parametrize(
"rule_runner",
(NoLogPasswordsRule,),
indirect=["rule_runner"],
)
def test_no_log_no(rule_runner: RunFromText) -> None:
"""The task sets no_log to no."""
results = rule_runner.run_playbook(NO_LOG_NO)
assert len(results) == 1
assert results[0].rule.id == "no-log-password"
@pytest.mark.parametrize(
"rule_runner",
(NoLogPasswordsRule,),
indirect=["rule_runner"],
)
def test_password_with_lock(rule_runner: RunFromText) -> None:
"""The task sets a password but also lock the user."""
results = rule_runner.run_playbook(PASSWORD_WITH_LOCK)
assert len(results) == 1
assert results[0].rule.id == "no-log-password"
@pytest.mark.parametrize(
"rule_runner",
(NoLogPasswordsRule,),
indirect=["rule_runner"],
)
def test_no_log_yes(rule_runner: RunFromText) -> None:
"""The task sets no_log to yes."""
results = rule_runner.run_playbook(NO_LOG_YES)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner",
(NoLogPasswordsRule,),
indirect=["rule_runner"],
)
def test_no_log_true(rule_runner: RunFromText) -> None:
"""The task sets no_log to true."""
results = rule_runner.run_playbook(NO_LOG_TRUE)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner",
(NoLogPasswordsRule,),
indirect=["rule_runner"],
)
def test_no_log_password_lock_yes(rule_runner: RunFromText) -> None:
"""The task only locks the user."""
results = rule_runner.run_playbook(PASSWORD_LOCK_YES)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner",
(NoLogPasswordsRule,),
indirect=["rule_runner"],
)
def test_no_log_password_lock_yes_but_no_password(rule_runner: RunFromText) -> None:
"""The task only locks the user."""
results = rule_runner.run_playbook(PASSWORD_LOCK_YES_BUT_NO_PASSWORD)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner",
(NoLogPasswordsRule,),
indirect=["rule_runner"],
)
def test_password_lock_false(rule_runner: RunFromText) -> None:
"""The task does not actually lock the user."""
results = rule_runner.run_playbook(PASSWORD_LOCK_FALSE)
assert len(results) == 0
|
