Debian Codegraph @

src/mikrotik_plugin/fastnetmon_mikrotik.php

raw
1 #!/usr/bin/php
2 <?php
3 declare(strict_types=1);
4
5 /*****************************
6 *
7 * MikroTik RouterOS PHP API integration for FastNetMon
8 *
9 * This script connect to router MikroTik and add or remove a blackhole's rule for the IP attack
10 *
11 * Author: Maximiliano Dobladez [email protected]
12 *
13 * http://maxid.com.ar | http://www.mkesolutions.net
14 *
15 * for API MIKROTIK:
16 * http://www.mikrotik.com
17 * http://wiki.mikrotik.com/wiki/API_PHP_class
18 *
19 * LICENSE: GPLv2 GNU GENERAL PUBLIC LICENSE
20 *
21 *
22 ******************************/
23
24 error_reporting( E_ALL );
25 ini_set( 'display_errors', 'On' );
26
27 define( "_VER", '1.0' );
28
29 /* NOTE: YOU NEED TO ENABLE THE API ACCESS ON MIKROTIK */
30
31 /*
32
33 Example configuration file /etc/mikrotik_integration.json:
34
35 {
36 "ip_mikrotik": "192.168.10.1",
37 "api_user": "api",
38 "api_pass": "api123"
39 }
40
41 */
42
43 $config_path = "/etc/mikrotik_integration.json";
44
45 if ( !file_exists( $config_path ) ) {
46 $msg = "Configuration file not found: " . $config_path;
47 _log( $msg );
48 echo $msg . "\n";
49 exit( 1 );
50 }
51
52 $cfg = json_decode( file_get_contents( $config_path ), true );
53
54 if ( !is_array( $cfg ) ) {
55 $msg = "Failed to parse configuration file: " . $config_path;
56 _log( $msg );
57 echo $msg . "\n";
58 exit( 1 );
59 }
60
61 foreach ( [ 'ip_mikrotik', 'api_user', 'api_pass' ] as $key ) {
62 if ( empty( $cfg[ $key ] ) ) {
63 $msg = "Missing required config key: " . $key;
64 _log( $msg );
65 echo $msg . "\n";
66 exit( 1 );
67 }
68 }
69
70 // help
71 if ( $argc > 1 && $argv[ 1 ] == "help" ) {
72 $msg = "MikroTik's API Integration for FastNetMon - Ver: " . _VER;
73 echo $msg;
74 exit(1);
75 }
76
77 /*
78
79 This script will get following params from FastNetMon:
80 $1 client_ip_as_string
81 $2 data_direction
82 $3 pps_as_string
83 $4 action (ban or unban)
84 */
85
86 // Ensure that we got all required arguments
87 if ( $argc <= 4 ) {
88 $msg = "MikroTik's API Integration for FastNetMon - Ver: " . _VER . "\n";
89 $msg .= "missing arguments";
90 $msg .= "php fastnetmon_mikrotik.php [IP] [data_direction] [pps_as_string] [action] \n";
91
92 _log( $msg );
93 echo $msg;
94 exit( 1 );
95 }
96
97
98 // IPv4 or IPv6 address of attack
99 $IP_ATTACK = $argv[ 1 ];
100 if ( filter_var( $IP_ATTACK, FILTER_VALIDATE_IP ) === false ) {
101 $msg = "Invalid IP address: " . $IP_ATTACK;
102 _log( $msg );
103 echo $msg . "\n";
104 exit( 1 );
105 }
106
107 // incoming, outgoing or unknown
108 $DIRECTION_ATTACK = $argv[ 2 ];
109 if ( !in_array( $DIRECTION_ATTACK, [ 'incoming', 'outgoing', 'unknown' ], true ) ) {
110 $msg = "Invalid direction: " . $DIRECTION_ATTACK . ". Must be incoming, outgoing, or unknown.";
111 _log( $msg );
112 echo $msg . "\n";
113 exit( 1 );
114 }
115
116 // Power of attack in packets per second
117 $POWER_ATTACK = $argv[ 3 ];
118 if ( !ctype_digit( $POWER_ATTACK ) ) {
119 $msg = "Invalid pps value: " . $POWER_ATTACK . ". Must be a positive integer.";
120 _log( $msg );
121 echo $msg . "\n";
122 exit( 1 );
123 }
124
125 // Action: ban or unban
126 $ACTION_ATTACK = $argv[ 4 ];
127 if ( !in_array( $ACTION_ATTACK, [ 'ban', 'unban' ], true ) ) {
128 $msg = "Invalid action: " . $ACTION_ATTACK . ". Must be ban or unban.";
129 _log( $msg );
130 echo $msg . "\n";
131 exit( 1 );
132 }
133
134 require_once "routeros_api.php";
135 $API = new RouterosAPI();
136
137 // $API->debug = true;
138 if (! $API->connect( $cfg[ 'ip_mikrotik' ], $cfg[ 'api_user' ], $cfg[ 'api_pass' ] ) ) {
139 // can't connect
140 $msg = "Couldn't connect to " . $cfg[ 'ip_mikrotik' ];
141 _log( $msg );
142 echo $msg;
143 exit( 1 );
144 }
145
146 $time_now = date("Y-m-d H:i:s", time());
147
148 //add Blocking by route blackhole
149 if ( $ACTION_ATTACK == "ban" ) {
150 $comment_rule = 'FastNetMon Community: IP ' . $IP_ATTACK . ' blocked because ' . $DIRECTION_ATTACK . ' attack with power ' . $POWER_ATTACK . ' pps | at '.$time_now;
151
152 $API->write( '/ip/route/add', false );
153 $API->write( '=dst-address=' . $IP_ATTACK, false );
154 $API->write( '=type=blackhole', false );
155 $API->write( '=bgp-communities=65535:666', false );
156 $API->write( '=comment=' . $comment_rule );
157
158 // Log to router syslog. Useful for alerting and Graylog reporting
159 $API->write( '/log/info', false );
160 $API->write( '=message=' . $comment_rule );
161 $ret = $API->read();
162
163 if ($ret) _log( $comment_rule );
164 } elseif ($ACTION_ATTACK == "unban" ) {
165 // remove the blackhole rule
166 $comment_rule = 'FastNetMon Community: IP ' . $IP_ATTACK . ' remove from blacklist ';
167 $API->write( '/ip/route/print', false );
168 $API->write( '?dst-address=' . $IP_ATTACK . "/32" );
169
170 $ID_ARRAY = $API->read();
171 $API->write( '/ip/route/remove', false );
172 $API->write( '=.id=' . $ID_ARRAY[ 0 ][ '.id' ] );
173
174 // Log to router syslog. Useful for alerting and Graylog reporting
175 $API->write( '/log/info', false );
176 $API->write( '=message=' . $comment_rule );
177 $ret = $API->read();
178
179 if ($ret) _log( $comment_rule );
180 } else {
181 $msg = "Unknown action: " . $ACTION_ATTACK;
182
183 _log( $msg );
184 echo $msg;
185 exit( 1 );
186 }
187 /**
188 * [_log Write a log file]
189 * @param [type] $msg [text to log]
190 * @return [type]
191 */
192 function _log( $msg ) {
193 $FILE_LOG_TMP = "/tmp/fastnetmon_api_mikrotik.log";
194 $line = date("D M j H:i:s T Y") . " - [FASTNETMON] - " . $msg . "\n";
195 file_put_contents( $FILE_LOG_TMP, $line, FILE_APPEND );
196 }
197
198 ?>