|
| 1 | +#!/usr/bin/python3 |
| 2 | +# |
| 3 | +# Copyright (C) 2025 CESNET |
| 4 | +# |
| 5 | +# LICENSE TERMS |
| 6 | +# |
| 7 | +# Redistribution and use in source and binary forms, with or without |
| 8 | +# modification, are permitted provided that the following conditions |
| 9 | +# are met: |
| 10 | +# 1. Redistributions of source code must retain the above copyright |
| 11 | +# notice, this list of conditions and the following disclaimer. |
| 12 | +# 2. Redistributions in binary form must reproduce the above copyright |
| 13 | +# notice, this list of conditions and the following disclaimer in |
| 14 | +# the documentation and/or other materials provided with the |
| 15 | +# distribution. |
| 16 | +# 3. Neither the name of the Company nor the names of its contributors |
| 17 | +# may be used to endorse or promote products derived from this |
| 18 | +# software without specific prior written permission. |
| 19 | +# |
| 20 | +# ALTERNATIVELY, provided that this notice is retained in full, this |
| 21 | +# product may be distributed under the terms of the GNU General Public |
| 22 | +# License (GPL) version 2 or later, in which case the provisions |
| 23 | +# of the GPL apply INSTEAD OF those given above. |
| 24 | +# |
| 25 | +# This software is provided ``as is'', and any express or implied |
| 26 | +# warranties, including, but not limited to, the implied warranties of |
| 27 | +# merchantability and fitness for a particular purpose are disclaimed. |
| 28 | +# In no event shall the company or contributors be liable for any |
| 29 | +# direct, indirect, incidental, special, exemplary, or consequential |
| 30 | +# damages (including, but not limited to, procurement of substitute |
| 31 | +# goods or services; loss of use, data, or profits; or business |
| 32 | +# interruption) however caused and on any theory of liability, whether |
| 33 | +# in contract, strict liability, or tort (including negligence or |
| 34 | +# otherwise) arising in any way out of the use of this software, even |
| 35 | +# if advised of the possibility of such damage. |
| 36 | + |
| 37 | + |
| 38 | +import argparse |
| 39 | +from functools import lru_cache |
| 40 | +import pytrap |
| 41 | +import geoip2.database |
| 42 | + |
| 43 | + |
| 44 | +CITY_OUTPUTSPEC = "ipaddr ip, string country_name, string country_iso_code, uint32 country_geoname_id, uint32 is_in_european_union, string city_name, float latitude, float longitude, uint32 accuracy_radius" |
| 45 | +COUNTRY_OUTPUTSPEC = "ipaddr ip, string name, string iso_code, uint32 geoname_id, uint32 is_in_european_union" |
| 46 | +ASN_OUTPUTSPEC = "ipaddr ip, uint32 asn, string autonomous_system_organization" |
| 47 | + |
| 48 | + |
| 49 | +parser = argparse.ArgumentParser(description='Module for geolocation using GeoLite2 database') |
| 50 | +parser.add_argument('-i', "--ifcspec", |
| 51 | + help="select TRAP IFC specifier") |
| 52 | +parser.add_argument('-d', "--db", |
| 53 | + help="path to the GeoLite2 database file", |
| 54 | + required=True) |
| 55 | +parser.add_argument('-f', "--fields", |
| 56 | + help="input fields to use for geolocation seperated by comma", |
| 57 | + default="SRC_IP") |
| 58 | +parser.add_argument('-t', "--type", |
| 59 | + help="type of GeoLite database", |
| 60 | + choices=['country', 'city', 'asn'], |
| 61 | + default="country") |
| 62 | +parser.add_argument('-c', "--cache", |
| 63 | + type=int, |
| 64 | + help="number of cached lookups. If set to 0, caching is disabled.", |
| 65 | + default=128) |
| 66 | + |
| 67 | +# parse command line arguments |
| 68 | +args = parser.parse_args() |
| 69 | +fields = args.fields.split(',') |
| 70 | + |
| 71 | + |
| 72 | +# initialize TRAP context |
| 73 | +trap = pytrap.TrapCtx() |
| 74 | +trap.init(['-i', args.ifcspec], 1, 1) |
| 75 | + |
| 76 | +# output interface |
| 77 | +fmttype = pytrap.FMT_UNIREC |
| 78 | + |
| 79 | +# set the correct output specification based on the type of GeoLite database |
| 80 | +if args.type == 'asn': |
| 81 | + outputspec = ASN_OUTPUTSPEC |
| 82 | +elif args.type == 'city': |
| 83 | + outputspec = CITY_OUTPUTSPEC |
| 84 | +else: |
| 85 | + outputspec = COUNTRY_OUTPUTSPEC |
| 86 | + |
| 87 | +trap.setDataFmt(0, fmttype, outputspec) |
| 88 | +output = pytrap.UnirecTemplate(outputspec) |
| 89 | +output.createMessage() |
| 90 | + |
| 91 | +# input interface |
| 92 | +fmtspec = "" |
| 93 | +trap.setRequiredFmt(0, fmttype, fmtspec) |
| 94 | +rec = pytrap.UnirecTemplate(fmtspec) |
| 95 | + |
| 96 | +# open GeoLite2 database reader |
| 97 | +with geoip2.database.Reader(args.db) as reader: |
| 98 | + @lru_cache(maxsize=args.cache) |
| 99 | + def lookup_in_database(lookup_ip): |
| 100 | + #Function to look up the IP address in the GeoLite2 database. |
| 101 | + if args.type == 'city': |
| 102 | + return reader.city(lookup_ip) |
| 103 | + elif args.type == 'country': |
| 104 | + return reader.country(lookup_ip) |
| 105 | + elif args.type == 'asn': |
| 106 | + return reader.asn(lookup_ip) |
| 107 | + |
| 108 | + |
| 109 | + # main loop |
| 110 | + while True: |
| 111 | + try: |
| 112 | + data = trap.recv() |
| 113 | + except pytrap.FormatChanged as e: |
| 114 | + fmttype, fmtspec = trap.getDataFmt(0) |
| 115 | + rec = pytrap.UnirecTemplate(fmtspec) |
| 116 | + data = e.data |
| 117 | + except pytrap.Terminated: |
| 118 | + print("Terminated trap.") |
| 119 | + break |
| 120 | + except pytrap.TrapError: |
| 121 | + print("Trap error, exiting.") |
| 122 | + break |
| 123 | + if len(data) <= 1: |
| 124 | + break |
| 125 | + |
| 126 | + else: |
| 127 | + rec.setData(data) |
| 128 | + for field in fields: |
| 129 | + ip = rec.get(data, field) |
| 130 | + output.ip = ip |
| 131 | + try: |
| 132 | + geolocation = lookup_in_database(str(ip)) |
| 133 | + except: |
| 134 | + continue |
| 135 | + if geolocation is None: |
| 136 | + continue |
| 137 | + |
| 138 | + # fill output fields based on geolocation type |
| 139 | + if args.type == 'country': |
| 140 | + output.name = geolocation.country.name or "unkown" |
| 141 | + output.iso_code = geolocation.country.iso_code or "unkown" |
| 142 | + output.geoname_id = geolocation.country.geoname_id or 0 |
| 143 | + output.is_in_european_union = geolocation.country.is_in_european_union or False |
| 144 | + elif args.type == 'city': |
| 145 | + output.country_name = geolocation.country.name or "unkown" |
| 146 | + output.country_iso_code = geolocation.country.iso_code or "unkown" |
| 147 | + output.country_geoname_id = geolocation.country.geoname_id or 0 |
| 148 | + output.is_in_european_union = geolocation.country.is_in_european_union or False |
| 149 | + output.city_name = geolocation.city.name or "unknown" |
| 150 | + output.latitude = geolocation.location.latitude or 0.0 |
| 151 | + output.longitude = geolocation.location.longitude or 0.0 |
| 152 | + output.accuracy_radius = geolocation.location.accuracy_radius or 0 |
| 153 | + elif args.type == 'asn': |
| 154 | + output.asn = geolocation.autonomous_system_number or 0 |
| 155 | + output.autonomous_system_organization = geolocation.autonomous_system_organization or "unknown" |
| 156 | + |
| 157 | + # send output data |
| 158 | + trap.send(output.getData(), 0) |
| 159 | + |
| 160 | +# send end-of-stream message and exit |
| 161 | +trap.sendFlush(0) |
| 162 | +trap.finalize() |
0 commit comments