Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions test/tools/donate_cpu_lib_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

import io
import tarfile

from donate_cpu_lib import *

def _test_library_includes(tmpdir, libs, content, libinc_obj=None):
Expand Down Expand Up @@ -66,3 +69,60 @@ def test_match_multiple_time(tmpdir):
# there was a bug that we would only match each library once successfully
_test_library_includes(tmpdir, ['posix', 'gnu', 'bsd', 'zlib'], '#include <zlib.h>', libinc)
_test_library_includes(tmpdir, ['posix', 'gnu', 'bsd', 'zlib'], '#include <zlib.h>', libinc)

def _add_tar_member(tf, name, linkname=None, linktype=tarfile.SYMTYPE):
info = tarfile.TarInfo(name)
data = b''
if linkname is not None:
info.type = linktype
info.linkname = linkname
else:
data = b'int x;\n'
info.size = len(data)
tf.addfile(info, io.BytesIO(data))

def test_unpack_package_outside_temp(tmpdir):
work_path = str(tmpdir)
outside_path = os.path.join(work_path, 'outside')
os.mkdir(outside_path)
tgz = os.path.join(work_path, 'temp.tgz')
with tarfile.open(tgz, 'w:gz') as tf:
_add_tar_member(tf, 'pkg/main.c')
_add_tar_member(tf, 'pkg/../../outside/dotdot.c')
_add_tar_member(tf, 'pkg/inc.h', linkname=outside_path)
_add_tar_member(tf, 'pkg/inc.h/symlink.c')

temp_path, source_found = unpack_package(work_path, tgz)
assert source_found
assert os.path.isfile(os.path.join(temp_path, 'pkg', 'main.c'))
assert os.listdir(outside_path) == []

def test_unpack_package_duplicate_name(tmpdir):
work_path = str(tmpdir)
outside_path = os.path.join(work_path, 'outside')
os.mkdir(outside_path)
outside_file = os.path.join(outside_path, 'target.c')
with open(outside_file, 'w', encoding='utf-8') as f:
f.write('int y;\n')
tgz = os.path.join(work_path, 'temp.tgz')
with tarfile.open(tgz, 'w:gz') as tf:
# a harmless member followed by a link with the same name that points outside temp
_add_tar_member(tf, 'pkg/sym.c')
_add_tar_member(tf, 'pkg/sym.c', linkname=outside_file)
_add_tar_member(tf, 'pkg/hard.c')
_add_tar_member(tf, 'pkg/hard.c', linkname='../outside/target.c', linktype=tarfile.LNKTYPE)
# a link inside temp followed by a same-named link that only looks inside when resolved through the first one
_add_tar_member(tf, 'pkg/inc.h', linkname='a/b/c')
_add_tar_member(tf, 'pkg/inc.h', linkname='../../outside')

temp_path, source_found = unpack_package(work_path, tgz)
assert source_found
for name in ('sym.c', 'hard.c'):
path = os.path.join(temp_path, 'pkg', name)
assert os.path.isfile(path)
assert not os.path.islink(path)
assert not os.path.samefile(path, outside_file)
real_temp_path = os.path.realpath(temp_path)
inc_path = os.path.realpath(os.path.join(temp_path, 'pkg', 'inc.h'))
assert os.path.commonpath([real_temp_path, inc_path]) == real_temp_path
assert os.listdir(outside_path) == ['target.c']
30 changes: 26 additions & 4 deletions tools/donate_cpu_lib.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# Version scheme (MAJOR.MINOR.PATCH) should orientate on "Semantic Versioning" https://semver.org/
# Every change in this script should result in increasing the version number accordingly (exceptions may be cosmetic
# changes)
CLIENT_VERSION = "1.4.0"
CLIENT_VERSION = "1.4.1"

# Timeout for analysis with Cppcheck in seconds
CPPCHECK_TIMEOUT = 30 * 60
Expand Down Expand Up @@ -344,10 +344,19 @@ def download_package(work_path, package, bandwidth_limit):
return destfile


def __is_inside_path(base_path, path):
try:
return os.path.commonpath([base_path, path]) == base_path
except ValueError:
# paths are on different drives
return False


def unpack_package(work_path, tgz, cpp_only=False, c_only=False, skip_files=None):
temp_path = os.path.join(work_path, 'temp')
__remove_tree(temp_path)
os.mkdir(temp_path)
real_temp_path = os.path.realpath(temp_path)

header_endings = ('.hpp', '.h++', '.hxx', '.hh', '.h')
cpp_source_endings = ('.cpp', '.c++', '.cxx', '.cc', '.tpp', '.txx', '.ipp', '.ixx', '.qml')
Expand All @@ -367,10 +376,21 @@ def unpack_package(work_path, tgz, cpp_only=False, c_only=False, skip_files=None
total = 0
extracted = 0
skipped = 0
# Python versions with extraction filters reject members that leave temp_path as well
extract_args = {'filter': 'data'} if hasattr(tarfile, 'data_filter') else {}
for member in tf:
total += 1
if member.name.startswith(('/', '..')):
# Skip dangerous file names
member_path = os.path.realpath(os.path.join(temp_path, member.name))
link_path = None
if member.issym():
# resolve from the directory the link is created in, not through an existing link with the same name
link_parent = os.path.realpath(os.path.dirname(os.path.join(temp_path, member.name)))
link_path = os.path.realpath(os.path.join(link_parent, member.linkname))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI review

This realpath only resolves the link target as it is on disk right now. Components that don't exist yet are normalised as plain text, but a later member of the archive can make one of them a symlink. Example:

pkg/l.h -> d.h/../../outside   # d.h missing: checked as temp/outside, passes
pkg/d.h -> .                   # temp/pkg, passes

After extraction, temp/pkg/l.h resolves to work_path/outside. I reproduced this with tarfile.data_filter deleted: all 3 members were extracted, and os.listdir(temp/pkg/l.h) listed the outside folder. cppcheck follows directory symlinks when it scans temp, so files outside the package would be analysed.

Checking each member when it is extracted can't catch this, because the target can change after the check. There are two options. One is to reject symlinks whose linkname is absolute or has a .. component. The other is a pass after extraction that removes every symlink under temp whose realpath is outside temp_path. That pass needs to loop until nothing more is removed, because removing one link can change what another resolves to.

elif member.islnk():
link_path = os.path.realpath(os.path.join(temp_path, member.linkname))
if not __is_inside_path(real_temp_path, member_path) or \
(link_path is not None and not __is_inside_path(real_temp_path, link_path)):
# Skip dangerous file names and links pointing outside of temp_path
# print('skipping dangerous file: ' + member.name)
skipped += 1
continue
Expand All @@ -388,14 +408,16 @@ def unpack_package(work_path, tgz, cpp_only=False, c_only=False, skip_files=None
skipped += 1
continue
try:
tf.extract(member.name, temp_path)
tf.extract(member, temp_path, **extract_args)
if is_source:
source_found = True
extracted += 1
except OSError:
pass
except AttributeError:
pass
except tarfile.TarError:
pass
print('extracted {} of {} files (skipped {}{})'.format(extracted, total, skipped, (' / only headers' if (extracted and not source_found) else '')))
return temp_path, source_found

Expand Down
Loading