Welcome to mirror list, hosted at ThFree Co, Russian Federation.

FileNameAnalyzer.php « Analyzer « lib - github.com/undo-ransomware/ransomware_detection.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 81239038e91849ba200d02c27a9822dd3332c5be (plain)
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
<?php

/**
 * @copyright Copyright (c) 2017 Matthias Held <matthias.held@uni-konstanz.de>
 * @author Matthias Held <matthias.held@uni-konstanz.de>
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

namespace OCA\RansomwareDetection\Analyzer;

use OCA\RansomwareDetection\FileSignatureList;
use OCA\RansomwareDetection\Entropy\Entropy;
use OCP\ILogger;

class FileNameAnalyzer
{
    /**
     * File name entropy cut-off point between normal and suspicious.
     *
     * @var float
     */
    const ENTROPY_CUT_OFF = 4.0;

    /** @var ILogger */
    private $logger;

    /** @var Entropy */
    private $entropy;

    /**
     * @param ILogger $logger
     * @param Entropy $entropy
     */
    public function __construct(
        ILogger $logger,
        Entropy $entropy
    ) {
        $this->logger = $logger;
        $this->entropy = $entropy;
    }

    /**
     * Classifies a file name in NORMAL, SUSPICIOUS_FILE_NAME,
     * SUSPICIOUS_FILE_EXTENSION or SUSPICIOUS, if the file name
     * and file extension are suspicious.
     *
     * @param string $path
     *
     * @return FileNameResult
     */
    public function analyze($path)
    {
        $fileName = $this->getFileName($path);
        $extension = $this->getFileExtension($path);
        $class = FileNameResult::NORMAL;

        $isFileExtensionKnown = $this->isFileExtensionKnown($extension);
        if (!$isFileExtensionKnown) {
            $class += FileNameResult::SUSPICIOUS_FILE_EXTENSION;
        }
        $entropyOfFileName = $this->calculateEntropyOfFileName($fileName);
        if ($entropyOfFileName > self::ENTROPY_CUT_OFF) {
            $class += FileNameResult::SUSPICIOUS_FILE_NAME;
        }

        return new FileNameResult($class, $isFileExtensionKnown, $entropyOfFileName);
    }

    /**
     * Checks if the file extension is known.
     *
     * @param string $extension
     *
     * @return bool
     */
    private function isFileExtensionKnown($extension)
    {
        $signatures = FileSignatureList::getSignatures();
        foreach ($signatures as $signature) {
            if (in_array(strtolower($extension), $signature['extension'])) {
                return true;
            }
        }

        return false;
    }

    /**
     * Returns the file name of a path.
     *
     * @param string $path
     *
     * @return string
     */
    private function getFileName($path)
    {
        $file = pathinfo($path);

        return $file['basename'];
    }

    /**
     * Returns the file extension of a file name.
     *
     * @param string $fileName
     *
     * @return string
     */
    private function getFileExtension($fileName)
    {
        $file = pathinfo($fileName);

        return $file['extension'];
    }

    /**
     * Calculates the entropy of the a file name.
     *
     * @param string $fileName
     *
     * @return float
     */
    private function calculateEntropyOfFileName($fileName)
    {
        return $this->entropy->calculateEntropy($fileName);
    }
}