Skip to content

ScanPhp

Collects metadata from PHP files.

Pygments is used as a lexer and the tokenized data is appended as metadata.

Attributes:

Name Type Description
lexer

Pygments lexer ('php') used to parse the file.
Source code in strelka/src/python/strelka/scanners/scan_php.py 
 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
class ScanPhp(strelka.Scanner):
    """Collects metadata from PHP files.

    Pygments is used as a lexer and the tokenized data is appended as metadata.

    Attributes:
        lexer: Pygments lexer ('php') used to parse the file.
    """

    def init(self):
        self.lexer = lexers.get_lexer_by_name("php")

    def scan(self, data, file, options, expire_at):
        highlight = pygments.highlight(
            data,
            self.lexer,
            formatters.RawTokenFormatter(),
        )
        highlight_list = highlight.split(b"\n")

        ordered_highlights = []
        for hl in highlight_list:
            split_highlight = hl.split(b"\t")
            if len(split_highlight) == 2:
                token = split_highlight[0].decode()
                value = split_highlight[1].decode().strip("'\"").strip()
                highlight_entry = {"token": token, "value": value}
                if highlight_entry["value"]:
                    ordered_highlights.append(highlight_entry)

        self.event.setdefault("tokens", [])
        self.event.setdefault("builtins", [])
        self.event.setdefault("operators", [])
        self.event.setdefault("strings", [])
        self.event.setdefault("variables", [])

        position = 0
        while position < len(ordered_highlights):
            ohlp = ordered_highlights[position]
            if ohlp["token"] not in self.event["tokens"]:
                self.event["tokens"].append(ohlp["token"])
            if ohlp["token"] == "Token.Name.Builtin":
                if ohlp["value"] not in self.event["builtins"]:
                    self.event["builtins"].append(ohlp["value"])
            elif ohlp["token"] == "Token.Operator":
                if ohlp["value"] not in self.event["operators"]:
                    self.event["operators"].append(ohlp["value"])
            elif ohlp["token"] in [
                "Token.Literal.String.Single",
                "Token.Literal.String.Double",
                "Token.Literal.String.Backtick",
                "Token.Literal.String.Doc",
            ]:
                if ohlp["value"] not in self.event["strings"]:
                    self.event["strings"].append(ohlp["value"])
            elif ohlp["token"] == "Token.Name.Variable":
                if ohlp["value"] not in self.event["variables"]:
                    self.event["variables"].append(ohlp["value"])

            position += 1

Features

The features of this scanner are detailed below. These features represent the capabilities and the type of analysis the scanner can perform. This may include support for Indicators of Compromise (IOC), the ability to emit files for further analysis, and the presence of extended documentation for complex analysis techniques.

Feature
Support
IOC Support
Emit Files
Extended Docs
Malware Scanner
Image Thumbnails

Tastes

Strelka's file distribution system assigns scanners to files based on 'flavors' and 'tastes'. Flavors describe the type of file, typically determined by MIME types from libmagic, matches from YARA rules, or characteristics of parent files. Tastes are the criteria used within Strelka to determine which scanners are applied to which files, with positive and negative tastes defining files to be included or excluded respectively.

Source Filetype
Include / Exclude
php_file
text/x-php

Scanner Fields

This section provides a list of fields that are extracted from the files processed by this scanner. These fields include the data elements that the scanner extracts from each file, representing the analytical results produced by the scanner. If the test file is missing or cannot be parsed, this section will not contain any data.

Failure

No fields to display. The test file may not exist or could not be processed.

Sample Event

Below is a sample event generated by this scanner, demonstrating the kind of output that can be expected when it processes a file. This sample is derived from a mock scan event configured in the scanner's test file. If no test file is available, this section will not display a sample event.

Failure

Test file not found for scanner php