Skip to content

Commit

Permalink
addressing Willi's feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
mr-tz committed Oct 22, 2020
1 parent fbe104d commit 6793169
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 14 deletions.
9 changes: 8 additions & 1 deletion capa/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,12 @@ def main(argv=None):
description=desc, epilog=epilog, formatter_class=argparse.RawDescriptionHelpFormatter
)
parser.add_argument(
"sample", type=lambda s: s.decode(sys.getfilesystemencoding()), help="path to sample to analyze"
# in #328 we noticed that the sample path is not handled correctly if it contains non-ASCII characters
# https://stackoverflow.com/a/22947334/ offers a solution and decoding using getfilesystemencoding works
# in our testing, however other sources suggest `sys.stdin.encoding` (https://stackoverflow.com/q/4012571/)
"sample",
type=lambda s: s.decode(sys.getfilesystemencoding()),
help="path to sample to analyze",
)
parser.add_argument("--version", action="version", version="%(prog)s {:s}".format(capa.version.__version__))
parser.add_argument(
Expand Down Expand Up @@ -495,6 +500,8 @@ def main(argv=None):
try:
taste = get_file_taste(args.sample)
except IOError as e:
# per our research there's not a programmatic way to render the IOError with non-ASCII filename unless we
# handle the IOError separately and reach into the args
logger.error("%s", e.args[0])
return -1

Expand Down
9 changes: 5 additions & 4 deletions tests/fixtures.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# -*- coding: utf-8 -*-
# Copyright (C) 2020 FireEye, Inc. All Rights Reserved.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -146,8 +147,8 @@ def get_data_path_by_name(name):
return os.path.join(CD, "data", "64d9f7d96b99467f36e22fada623c3bb.dll_")
elif name.startswith("82bf6"):
return os.path.join(CD, "data", "82BF6347ACF15E5D883715DC289D8A2B.exe_")
elif name.startswith("ping"):
return os.path.join(CD, "data", "ping.exe_")
elif name.startswith("pingtaest"):
return os.path.join(CD, "data", "ping_täst.exe_")
else:
raise ValueError("unexpected sample fixture")

Expand Down Expand Up @@ -537,5 +538,5 @@ def al_khaser_x86_extractor():


@pytest.fixture
def ping_extractor():
return get_extractor(get_data_path_by_name("ping"))
def pingtaest_extractor():
return get_extractor(get_data_path_by_name("pingtaest"))
13 changes: 4 additions & 9 deletions tests/test_main.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,29 +59,24 @@ def test_main_single_rule(z9324d_extractor, tmpdir):


@pytest.mark.xfail(sys.version_info >= (3, 0), reason="vivsect only works on py2")
def test_main_non_ascii_filename(ping_extractor, tmpdir, capsys):
def test_main_non_ascii_filename(pingtaest_extractor, tmpdir, capsys):
# on py2.7, need to be careful about str (which can hold bytes)
# vs unicode (which is only unicode characters).
# on py3, this should not be needed.
#
# here we print a string with unicode characters in it
# (specifically, a byte string with utf-8 bytes in it, see file encoding)
NON_ASCII_FILENAME = "täst1.exe"
tmp_file_kernel32_copy = tmpdir.mkdir("capa").join(NON_ASCII_FILENAME)
import shutil

shutil.copy(ping_extractor.path, tmp_file_kernel32_copy.strpath)
assert capa.main.main(["-q", tmp_file_kernel32_copy.strpath]) == 0
assert capa.main.main(["-q", pingtaest_extractor.path]) == 0

std = capsys.readouterr()
# but here, we have to use a unicode instance,
# because capsys has decoded the output for us.
assert NON_ASCII_FILENAME.decode("utf-8") in std.out
assert pingtaest_extractor.path.decode("utf-8") in std.out


@pytest.mark.xfail(sys.version_info >= (3, 0), reason="vivsect only works on py2")
def test_main_non_ascii_filename_nonexistent(tmpdir, caplog):
NON_ASCII_FILENAME = "täst1.exe"
NON_ASCII_FILENAME = "täst_not_there.exe"
assert capa.main.main(["-q", NON_ASCII_FILENAME]) == -1

assert NON_ASCII_FILENAME.decode("utf-8") in caplog.text
Expand Down

0 comments on commit 6793169

Please sign in to comment.