summaryrefslogtreecommitdiff
path: root/detection/vpnservices/hotspotvpn.py
blob: d28976dba1ed8eedcc567f47b9e1347fa0dd2152 (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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time    : 2024/1/11 15:45
# @author    : yinjinagyi
# @File    : hotspotvpn.py
# @Function:

from vpn_detector import VpnDetector, ServerGroup
import pandas as pd


class Hotspotvpn(VpnDetector):
    """

    This class is used to detect hotspotvpn server ip
    """

    def __init__(self, start_time, end_time):
        super().__init__(start_time, end_time)
        self.plugin_config = self.load_config()['hotspotvpn']
        self.plugin_id = self.plugin_config['plugin_id']
        self.plugin_name = self.plugin_config['plugin_name']
        self.object_type = self.plugin_config['object_type']
        self.vpn_service_name = self.plugin_config['vpn_service_name']
        self.confidence = self.plugin_config['confidence']
        self.output_file_name = self.plugin_name + '-' + self.object_type + '_' + str(self.start_time).replace(' ', '_').replace(':', '')[:13] + '.csv'
        self.start_time = start_time
        self.end_time = end_time

        self.sql = self.plugin_config['sql']
        self.masquerede_domains = ["'"+i.strip()+"'" for i in self.plugin_config['domains'].split(',')]

    def find_server(self):
        """
        Get hotspotvpn server ip from clickhouse database
        :return: hotspotvpn server group
        """
        self.logger.info('[{}] - Start to query server ip from session records'.format(self.plugin_name))

        # construct query sql
        TIME_FILTER_PATTERN = self.config['common']['time_filter_pattern'].replace('recv_time_columnname', self.config['common']['recv_time_columnname'])
        time_filter = TIME_FILTER_PATTERN.replace("{$start_time}", str(self.start_time)).replace("{$end_time}", str(
            self.end_time)).replace("{$time_zone}", self.time_zone)
        self.sql = self.sql.replace("{$db_name}", self.dbname).replace("{$table_name}", self.table_name)
        self.sql = self.sql.replace("{$time_filter}", time_filter)
        self.sql = self.sql.replace("{$domain_list}", ','.join(self.masquerede_domains))

        self.logger.info("[{}] - Sql for {}: {}".format(self.plugin_name, self.plugin_name, self.sql))

        # query data from clickhouse database
        try:
            hotspotvpn_serverip_df = pd.DataFrame(self.client.execute(self.sql))
        finally:
            self.client.disconnect()

        if hotspotvpn_serverip_df.empty:
            self.logger.info('[{}] - No server ip found from session records'.format(self.plugin_name))
            return []
        hotspotvpn_serverip_list = hotspotvpn_serverip_df[0].drop_duplicates().tolist()
        self.logger.info('[{}] - Query server ip from clickhouse database successfully. {} items found'
                         .format(self.plugin_name, len(hotspotvpn_serverip_list)))


        return [ServerGroup(object_type='ip', server_list=hotspotvpn_serverip_list, output_file_name=self.output_file_name)]