|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +# Copyright 2021 Damien Nguyen |
| 3 | +# |
| 4 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +# you may not use this file except in compliance with the License. |
| 6 | +# You may obtain a copy of the License at |
| 7 | +# |
| 8 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +# |
| 10 | +# Unless required by applicable law or agreed to in writing, software |
| 11 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +# See the License for the specific language governing permissions and |
| 14 | +# limitations under the License. |
| 15 | + |
| 16 | +import astroid |
| 17 | +import pylint.testutils |
| 18 | +import pytest |
| 19 | + |
| 20 | +import pylint_secure_coding_standard as pylint_scs |
| 21 | + |
| 22 | + |
| 23 | +class TestSecureCodingStandardChecker(pylint.testutils.CheckerTestCase): |
| 24 | + CHECKER_CLASS = pylint_scs.SecureCodingStandardChecker |
| 25 | + |
| 26 | + @pytest.mark.parametrize( |
| 27 | + 'arg', |
| 28 | + ('True', '0o644', '0o644,'), |
| 29 | + ) |
| 30 | + def test_os_open_ok(self, arg): |
| 31 | + nodes = astroid.extract_node( |
| 32 | + """ |
| 33 | + int(0) #@ |
| 34 | + foo() #@ |
| 35 | + os.open("file.txt") #@ |
| 36 | + os.open("file.txt", os.O_RDONLY) #@ |
| 37 | + os.open("file.txt", os.O_RDONLY, 0o644) #@ |
| 38 | + os.open("file.txt", os.O_RDONLY | os.O_NOFOLLOW) #@ |
| 39 | + os.open("file.txt", os.O_RDONLY | os.O_NOFOLLOW, 0o644) #@ |
| 40 | + bla.open("file.txt") #@ |
| 41 | + bla.open("file.txt", os.O_RDONLY) #@ |
| 42 | + bla.open("file.txt", os.O_RDONLY, 0o644) #@ |
| 43 | + bla.open("file.txt", os.O_RDONLY, 0o755) #@ |
| 44 | + bla.open("file.txt", os.O_RDONLY | os.O_NOFOLLOW) #@ |
| 45 | + bla.open("file.txt", os.O_RDONLY | os.O_NOFOLLOW, 0o644) #@ |
| 46 | + bla.open("file.txt", os.O_RDONLY | os.O_NOFOLLOW, 0o755) #@ |
| 47 | + with os.open("file.txt") as fd: fd.read() #@ |
| 48 | + with os.open("file.txt", os.O_RDONLY) as fd: fd.read() #@ |
| 49 | + with os.open("file.txt", os.O_RDONLY, 0o644) as fd: fd.read() #@ |
| 50 | + with os.open("file.txt", os.O_RDONLY | os.O_NOFOLLOW) as fd: fd.read() #@ |
| 51 | + with os.open("file.txt", os.O_RDONLY | os.O_NOFOLLOW, 0o644) as fd: fd.read() #@ |
| 52 | + with bla.open("file.txt") as fd: fd.read() #@ |
| 53 | + with bla.open("file.txt", os.O_RDONLY) as fd: fd.read() #@ |
| 54 | + with bla.open("file.txt", os.O_RDONLY, 0o644) as fd: fd.read() #@ |
| 55 | + with bla.open("file.txt", os.O_RDONLY, 0o755) as fd: fd.read() #@ |
| 56 | + with bla.open("file.txt", os.O_RDONLY | os.O_NOFOLLOW) as fd: fd.read() #@ |
| 57 | + with bla.open("file.txt", os.O_RDONLY | os.O_NOFOLLOW, 0o644) as fd: fd.read() #@ |
| 58 | + with bla.open("file.txt", os.O_RDONLY | os.O_NOFOLLOW, 0o755) as fd: fd.read() #@ |
| 59 | + """ |
| 60 | + ) |
| 61 | + |
| 62 | + self.checker.set_os_open_mode('True') |
| 63 | + assert self.checker._prefer_os_open |
| 64 | + |
| 65 | + call_nodes = nodes[:14] |
| 66 | + with_nodes = nodes[14:] |
| 67 | + |
| 68 | + with self.assertNoMessages(): |
| 69 | + for idx, node in enumerate(call_nodes): |
| 70 | + self.checker.visit_call(node) |
| 71 | + for idx, node in enumerate(with_nodes): |
| 72 | + self.checker.visit_with(node) |
| 73 | + |
| 74 | + # ========================================================================== |
| 75 | + |
| 76 | + @pytest.mark.parametrize('mode', range(0o756, 0o777 + 1), ids=lambda arg: oct(arg)) |
| 77 | + @pytest.mark.parametrize( |
| 78 | + 'arg, expected_warning', |
| 79 | + ( |
| 80 | + ('False', False), |
| 81 | + ('True', True), |
| 82 | + ), |
| 83 | + ) |
| 84 | + def test_os_open_call_default_modes(self, mode, arg, expected_warning): |
| 85 | + node = astroid.extract_node(f'os.open("file.txt", os.O_WRONLY, 0o{mode:o}) #@') |
| 86 | + self.checker.set_os_open_mode(arg) |
| 87 | + if expected_warning: |
| 88 | + with self.assertAddsMessages(pylint.testutils.Message(msg_id='os-open-unsafe-permissions', node=node)): |
| 89 | + self.checker.visit_call(node) |
| 90 | + else: |
| 91 | + with self.assertNoMessages(): |
| 92 | + self.checker.visit_call(node) |
| 93 | + |
| 94 | + # -------------------------------------------------------------------------- |
| 95 | + |
| 96 | + @pytest.mark.parametrize('mode', range(0o750, 0o761), ids=lambda arg: oct(arg)) |
| 97 | + @pytest.mark.parametrize( |
| 98 | + 'call_mode', |
| 99 | + ( |
| 100 | + 'os.open("file.txt", os.O_WRONLY, 0o{:o}) #@', |
| 101 | + 'os.open("file.txt", flags=os.O_WRONLY, mode=0o{:o}) #@', |
| 102 | + ), |
| 103 | + ids=('args', 'keyword'), |
| 104 | + ) |
| 105 | + @pytest.mark.parametrize( |
| 106 | + 'arg, expected_warning', |
| 107 | + ( |
| 108 | + ('False', False), |
| 109 | + ('0o755,', True), |
| 110 | + ), |
| 111 | + ids=('False-False', '[0o755]-True'), |
| 112 | + ) |
| 113 | + def test_os_open_call(self, mode, call_mode, arg, expected_warning): |
| 114 | + node = astroid.extract_node(call_mode.format(mode)) |
| 115 | + self.checker.set_os_open_mode(arg) |
| 116 | + if expected_warning and mode != 0o755: |
| 117 | + with self.assertAddsMessages(pylint.testutils.Message(msg_id='os-open-unsafe-permissions', node=node)): |
| 118 | + self.checker.visit_call(node) |
| 119 | + else: |
| 120 | + with self.assertNoMessages(): |
| 121 | + self.checker.visit_call(node) |
| 122 | + |
| 123 | + # ========================================================================== |
| 124 | + |
| 125 | + @pytest.mark.parametrize('mode', range(0o756, 0o777 + 1), ids=lambda arg: oct(arg)) |
| 126 | + @pytest.mark.parametrize( |
| 127 | + 'call_mode', |
| 128 | + ( |
| 129 | + 'with os.open("file.txt", os.O_WRONLY, 0o{:o}) as fd: fd.read() #@', |
| 130 | + 'with os.open("file.txt", flags=os.O_WRONLY, mode=0o{:o}) as fd: fd.read() #@', |
| 131 | + ), |
| 132 | + ids=('args', 'keyword'), |
| 133 | + ) |
| 134 | + @pytest.mark.parametrize( |
| 135 | + 'arg, expected_warning', |
| 136 | + ( |
| 137 | + ('False', False), |
| 138 | + ('True', True), |
| 139 | + ), |
| 140 | + ) |
| 141 | + def test_os_open_with_default_modes(self, mode, call_mode, arg, expected_warning): |
| 142 | + node = astroid.extract_node(call_mode.format(mode)) |
| 143 | + self.checker.set_os_open_mode(arg) |
| 144 | + if expected_warning: |
| 145 | + with self.assertAddsMessages(pylint.testutils.Message(msg_id='os-open-unsafe-permissions', node=node)): |
| 146 | + self.checker.visit_with(node) |
| 147 | + else: |
| 148 | + with self.assertNoMessages(): |
| 149 | + self.checker.visit_with(node) |
| 150 | + |
| 151 | + # -------------------------------------------------------------------------- |
| 152 | + |
| 153 | + @pytest.mark.parametrize('mode', range(0o750, 0o761), ids=lambda arg: oct(arg)) |
| 154 | + @pytest.mark.parametrize( |
| 155 | + 'arg, expected_warning', |
| 156 | + ( |
| 157 | + ('False', False), |
| 158 | + ('0o755,', True), |
| 159 | + ), |
| 160 | + ) |
| 161 | + def test_os_open_with(self, mode, arg, expected_warning): |
| 162 | + node = astroid.extract_node(f'with os.open("file.txt", os.O_WRONLY, 0o{mode:o}) as fd: fd.read() #@') |
| 163 | + self.checker.set_os_open_mode(arg) |
| 164 | + if expected_warning and mode != 0o755: |
| 165 | + with self.assertAddsMessages(pylint.testutils.Message(msg_id='os-open-unsafe-permissions', node=node)): |
| 166 | + self.checker.visit_with(node) |
| 167 | + else: |
| 168 | + with self.assertNoMessages(): |
| 169 | + self.checker.visit_with(node) |
0 commit comments