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
|
"""Implementation of risky-octal rule."""
# Copyright (c) 2013-2014 Will Thames <will@thames.id.au>
#
# 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 __future__ import annotations
import sys
from typing import TYPE_CHECKING
from ansiblelint.rules import AnsibleLintRule, RulesCollection
from ansiblelint.runner import Runner
if TYPE_CHECKING:
from ansiblelint.file_utils import Lintable
from ansiblelint.utils import Task
class OctalPermissionsRule(AnsibleLintRule):
"""Octal file permissions must contain leading zero or be a string."""
id = "risky-octal"
description = (
"Numeric file permissions without leading zero can behave "
"in unexpected ways."
)
link = "https://docs.ansible.com/ansible/latest/collections/ansible/builtin/file_module.html"
severity = "VERY_HIGH"
tags = ["formatting"]
version_added = "historic"
_modules = [
"assemble",
"copy",
"file",
"ini_file",
"lineinfile",
"replace",
"synchronize",
"template",
"unarchive",
]
@staticmethod
def is_invalid_permission(mode: int) -> bool:
"""Check if permissions are valid.
Sensible file permission modes don't have write bit set when read bit
is not set and don't have execute bit set when user execute bit is
not set.
Also, user permissions are more generous than group permissions and
user and group permissions are more generous than world permissions.
"""
other_write_without_read = (
mode % 8 and mode % 8 < 4 and not (mode % 8 == 1 and (mode >> 6) % 2 == 1)
)
group_write_without_read = (
(mode >> 3) % 8
and (mode >> 3) % 8 < 4
and not ((mode >> 3) % 8 == 1 and (mode >> 6) % 2 == 1)
)
user_write_without_read = (
(mode >> 6) % 8 and (mode >> 6) % 8 < 4 and (mode >> 6) % 8 != 1
)
other_more_generous_than_group = mode % 8 > (mode >> 3) % 8
other_more_generous_than_user = mode % 8 > (mode >> 6) % 8
group_more_generous_than_user = (mode >> 3) % 8 > (mode >> 6) % 8
return bool(
other_write_without_read
or group_write_without_read
or user_write_without_read
or other_more_generous_than_group
or other_more_generous_than_user
or group_more_generous_than_user,
)
def matchtask(
self,
task: Task,
file: Lintable | None = None,
) -> bool | str:
if task["action"]["__ansible_module__"] in self._modules:
mode = task["action"].get("mode", None)
if isinstance(mode, str):
return False
if isinstance(mode, int) and self.is_invalid_permission(mode):
return f'`mode: {mode}` should have a string value with leading zero `mode: "0{mode:o}"` or use symbolic mode.'
return False
if "pytest" in sys.modules:
import pytest
VALID_MODES = [
0o777,
0o775,
0o770,
0o755,
0o750,
0o711,
0o710,
0o700,
0o666,
0o664,
0o660,
0o644,
0o640,
0o600,
0o555,
0o551,
0o550,
0o511,
0o510,
0o500,
0o444,
0o440,
0o400,
]
INVALID_MODES = [
777,
775,
770,
755,
750,
711,
710,
700,
666,
664,
660,
644,
640,
622,
620,
600,
555,
551,
550, # 511 == 0o777, 510 == 0o776, 500 == 0o764
444,
440,
400,
]
@pytest.mark.parametrize(
("file", "failures"),
(
pytest.param("examples/playbooks/rule-risky-octal-pass.yml", 0, id="pass"),
pytest.param("examples/playbooks/rule-risky-octal-fail.yml", 4, id="fail"),
),
)
def test_octal(file: str, failures: int) -> None:
"""Test that octal permissions are valid."""
collection = RulesCollection()
collection.register(OctalPermissionsRule())
results = Runner(file, rules=collection).run()
assert len(results) == failures
for result in results:
assert result.rule.id == "risky-octal"
def test_octal_valid_modes() -> None:
"""Test that octal modes are valid."""
rule = OctalPermissionsRule()
for mode in VALID_MODES:
assert not rule.is_invalid_permission(
mode,
), f"0o{mode:o} should be a valid mode"
def test_octal_invalid_modes() -> None:
"""Test that octal modes are invalid."""
rule = OctalPermissionsRule()
for mode in INVALID_MODES:
assert rule.is_invalid_permission(
mode,
), f"{mode:d} should be an invalid mode"
|
