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
|
# Copyright (c) 2020 Sorin Sbarnea <sorin.sbarnea@gmail.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
from ansiblelint.rules import AnsibleLintRule
# Despite documentation mentioning 'preserve' only these modules support it:
_modules_with_preserve = (
'copy',
'template',
)
class MissingFilePermissionsRule(AnsibleLintRule):
id = "208"
shortdesc = 'File permissions unset or incorrect'
description = (
"Missing or unsupported mode parameter can cause unexpected file "
"permissions based "
"on version of Ansible being used. Be explicit, like ``mode: 0644`` to "
"avoid hitting this rule. Special ``preserve`` value is accepted "
f"only by {', '.join(_modules_with_preserve)} modules. "
"See https://github.com/ansible/ansible/issues/71200"
)
severity = 'VERY_HIGH'
tags = ['unpredictability', 'experimental']
version_added = 'v4.3.0'
_modules = {
'archive',
'assemble',
'copy', # supports preserve
'file',
'replace', # implicit preserve behavior but mode: preserve is invalid
'template', # supports preserve
# 'unarchive', # disabled because .tar.gz files can have permissions inside
}
_modules_with_create = {
'blockinfile': False,
'htpasswd': True,
'ini_file': True,
'lineinfile': False,
}
def matchtask(self, file, task):
module = task["action"]["__ansible_module__"]
mode = task['action'].get('mode', None)
if module not in self._modules and \
module not in self._modules_with_create:
return False
if mode == 'preserve' and module not in _modules_with_preserve:
return True
if module in self._modules_with_create:
create = task["action"].get("create", self._modules_with_create[module])
return create and mode is None
# A file that doesn't exist cannot have a mode
if task['action'].get('state', None) == "absent":
return False
# A symlink always has mode 0o777
if task['action'].get('state', None) == "link":
return False
# The file module does not create anything when state==file (default)
if module == "file" and \
task['action'].get('state', 'file') == 'file':
return False
# replace module is the only one that has a valid default preserve
# behavior, but we want to trigger rule if user used incorrect
# documentation and put 'preserve', which is not supported.
if module == 'replace' and mode is None:
return False
return mode is None
|
