├── CHANGELOG.md ├── LICENSE ├── README.md ├── Screenshot_20250228_142832.png ├── TZSPreplay@.service ├── easyinstall.sh ├── mikrocata.py ├── mikrocata.service ├── tzsp.netdev └── tzsp.network /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog - v2.3.0 (April 2025) 2 | 3 | ## Key Features 4 | 5 | * **Advanced Whitelist Support:** Added full support for CIDR notations (e.g., `"10.0.0.0/8"`) in whitelist. 6 | * **Emoji and Special Characters Handling:** Fixed issues with rules containing emojis or Unicode characters that caused crashes. 7 | * **Debug Mode:** Added debug mode to facilitate troubleshooting. 8 | * **Optimized Logging:** More concise and informative log messages in normal mode. 9 | * **Critical Fixes:** Fixed bugs that caused some alerts to be skipped during processing. 10 | 11 | ## Technical Improvements 12 | 13 | * Implemented `is_ip_in_whitelist()` function to correctly handle all forms of whitelist entries (exact IPs, prefixes, CIDR). 14 | * Added `sanitize_text()` function to remove emojis and special characters from messages. 15 | * Fixed double JSON parsing in `read_json()`. 16 | * Replaced `break` with `continue` to ensure all alerts are processed. 17 | * Improved logging system with categorization (`BLOCKED`, `UPDATED`, `ERROR`). 18 | * Added full IPv6 support in whitelist management. 19 | 20 | ## Bug Fixes 21 | 22 | * Fixed the issue that prevented recognition of CIDR format subnets in the whitelist. 23 | * Fixed a bug that caused failure to process multiple events in a single cycle. 24 | * Fixed crashes during processing of PAW rules containing emojis. 25 | 26 | ## Upgrade Instructions 27 | 28 | 1. **Backup Existing Configurations** 29 | Backup all configuration files: 30 | 31 | ```bash 32 | sudo cp /usr/local/bin/mikrocataTZSP\*.py /usr/local/bin/mikrocataTZSP\*.py.bak 33 | sudo mkdir -p /var/lib/mikrocata/backup-$(date +%Y%m%d) 34 | sudo cp /var/lib/mikrocata/\* /var/lib/mikrocata/backup-$(date +%Y%m%d)/ 35 | ``` 36 | 37 | 2. **Update Repository Files** 38 | 39 | ```bash 40 | cd /path/to/mikrocata2selks 41 | git pull 42 | ``` 43 | 44 | 3. **Install New Files** 45 | 46 | ```bash 47 | sudo cp mikrocata.py /usr/local/bin/mikrocataTZSP0.py 48 | ``` 49 | 50 | Repeat for each instance if you have more than one Mikrotik router. 51 | 52 | ```bash 53 | sudo chmod +x /usr/local/bin/mikrocataTZSP0.py 54 | ``` 55 | 56 | 4. **Transfer Previous Configurations** 57 | Open the backup file and the new one to manually copy your custom settings: 58 | 59 | ```bash 60 | sudo nano /usr/local/bin/mikrocataTZSP0.py.bak 61 | sudo nano /usr/local/bin/mikrocataTZSP0.py 62 | ``` 63 | 64 | Make sure to transfer all of the following settings: 65 | 66 | * Mikrotik credentials (`USERNAME`, `PASSWORD`, `ROUTER_IP`) 67 | * Telegram configuration 68 | * Whitelist IPs 69 | * SSL settings 70 | * LISTEN_INTERFACE 71 | * SELKS_CONTAINER_DATA_SURICATA_LOG 72 | 73 | 5. **Restart Services** 74 | 75 | ```bash 76 | sudo systemctl restart mikrocataTZSP0.service 77 | ``` 78 | 79 | Repeat for each instance if you have more than one Mikrotik router. 80 | 81 | 6. **Verify Operation** 82 | ```bash 83 | sudo journalctl -u mikrocataTZSP0.service -f 84 | ``` 85 | 86 | ## Important Notes for Upgrading 87 | 88 | * **Debug Mode:** To activate debug mode for troubleshooting, set `DEBUG_MODE = True` in the file settings. 89 | * **CIDR Whitelist:** The new version supports CIDR notations (e.g., `"10.0.0.0/8"`) in the whitelist. 90 | * **IPv6 Compatibility:** The whitelist management now works correctly for both IPv4 and IPv6. 91 | 92 | ## What to Do in Case of Problems 93 | 94 | If you encounter issues after upgrading: 95 | 96 | * Check logs for any errors: 97 | ```bash 98 | sudo journalctl -u mikrocataTZSP0.service -n 100 99 | ``` 100 | * Enable debug mode for more detailed logs: 101 | ```bash 102 | sudo nano /usr/local/bin/mikrocataTZSP0.py 103 | ``` 104 | Set `DEBUG_MODE = True` 105 | ```bash 106 | sudo systemctl restart mikrocataTZSP0.service 107 | ``` 108 | * If necessary, restore the previous version: 109 | ```bash 110 | sudo cp /usr/local/bin/mikrocataTZSP0.py.bak /usr/local/bin/mikrocataTZSP0.py 111 | sudo systemctl restart mikrocataTZSP0.service 112 | ``` 113 | * Report the issue on GitHub with relevant logs. 114 | 115 | ### v2.2.6 (March 4, 2025) 116 | - **Performance:** Optimized Mikrotik address list saving to run every 5 minutes instead of on every alert 117 | - **Stability:** Reduced router CPU load, particularly beneficial for high-traffic networks or routers with limited resources 118 | - **System:** Added interval-based save mechanism with configurable timing (default: 300 seconds) 119 | 120 | ### v2.2.5 (January, 2025) 121 | - **Security:** Fixed SSL certificate management issues 122 | - **Reliability:** Improved handling of certificate validation 123 | 124 | ### v2.2.4 (December 2024) 125 | - **Security:** Added support for self-signed certificates 126 | - **Configuration:** Added new option `ALLOW_SELF_SIGNED_CERTS` for trusted environments 127 | 128 | ### v2.2.3 (July 2024) 129 | - **Feature:** Added IPv6 support (thanks to contributor: floridan95) 130 | - **Configuration:** Added `ENABLE_IPV6` option to enable/disable IPv6 blocking 131 | 132 | ### v2.2.2 133 | - **Fix:** Resolved issue with Telegram notifications not being delivered properly 134 | 135 | ### v2.2.1 136 | - **Bugfix:** Fixed script crash during Suricata logrotate operations 137 | - **Stability:** Improved file handling for log rotation events 138 | 139 | ### v2.2 140 | - **Compatibility:** Added support for Debian 12 141 | - **System:** Updated installation scripts for newer package versions 142 | 143 | ### v2.1 144 | - **Reliability:** Improved stability of the `read_json` function (thanks to contributor: bekhzad-khamidullaev) 145 | - **Performance:** Better handling of malformed JSON data 146 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

Welcome to Mikrocata2SELKS 👋

2 |

3 | Version 4 | 5 | License: MIT 6 | 7 |

8 | 9 | 10 | ![Selks](Screenshot_20250228_142832.png) 11 | 12 | ## 📋 Introduction 13 | 14 | Mikrocata2SELKS is a streamlined solution for integrating Mikrotik devices with Suricata IDS/IPS for packet analysis. 15 | It automates the setup process and enables efficient network traffic monitoring and threat detection. 16 | The script is compatible with latest SELKS 10. 17 | 18 | ```mermaid 19 | graph LR 20 | A[Mikrotik Router] -->|TZSP Traffic| B[Mikrocata2SELKS] 21 | B -->|Analysis| C[Suricata IDS/IPS] 22 | C -->|Alerts| D[Telegram Notifications] 23 | C -->|Blocks| E[Firewall Rules] 24 | ``` 25 | 26 | **Minimum Requirements:** 27 | - 4 CPU cores 28 | - 10 GB of free RAM 29 | - Minimum 10 GB of free disk space (actual disk usage will mainly depend on the number of rules and the amount of traffic on the network - 200GB+ SSD grade recommended). 30 | 31 | ## 📚 Documentation 32 | For a comprehensive step-by-step installation guide with detailed explanations, screenshots, and troubleshooting tips, please visit: 33 | [Complete Installation Guide](https://www.sec-ttl.com/mikrocata2selks-integrating-mikrotik-with-suricata-for-network-security/) 34 | 35 | ## 🚀 Installation 36 | 37 | 1. Set up a fresh Debian 12 installation on a dedicated machine (server or VM). 38 | 2. Log in as root. 39 | 3. Install Git: `apt install git`. 40 | 4. Clone this repository: `git clone https://github.com/angolo40/mikrocata2selks.git`. 41 | 5. Edit `easyinstall.sh` with the path where to install SELKS and the number of Mikrotik devices to handle. 42 | 6. Run `./easyinstall.sh`. 43 | 7. Wait.... 44 | 8. Once finished, edit `/usr/local/bin/mikrocataTZSP0.py` with your Mikrotik and Telegram parameters, then reload the service with `systemctl restart mikrocataTZSP0.service`. 45 | 9. Configure your Mikrotik devices. 46 | 47 | ## 📡 Mikrotik Setup 48 | 49 | 1. Enable sniffer: 50 | ```sh 51 | /tool/sniffer/set filter-stream=yes streaming-enabled=yes streaming-server=[YOURDEBIANIP]:37008 52 | /tool/sniffer/start 53 | ``` 54 | 2. Add firewall rules: 55 | ```sh 56 | /ip/firewall/raw/add action=drop chain=prerouting comment="IPS-drop_in_bad_traffic" src-address-list=Suricata 57 | /ip/firewall/raw/add action=drop chain=prerouting comment="IPS-drop_out_bad_traffic" dst-address-list=Suricata 58 | /ipv6/firewall/raw/add action=drop chain=prerouting comment="IPS-drop_in_bad_traffic" src-address-list=Suricata 59 | /ipv6/firewall/raw/add action=drop chain=prerouting comment="IPS-drop_out_bad_traffic" dst-address-list=Suricata 60 | ``` 61 | 3. Enable Mikrotik API: 62 | You have two options: 63 | - For SSL connection (recommended): 64 | ```sh 65 | /ip/service/set api-ssl address=[DEBIANIP] 66 | ``` 67 | - For non-SSL connection (default settings): 68 | ```sh 69 | /ip/service/set api address=[DEBIANIP] 70 | ``` 71 | 72 | Then configure the corresponding settings in mikrocata.py: 73 | ```python 74 | USE_SSL = True # Set to False for non-SSL connection 75 | PORT = 8728 # Default port for non-SSL. Will use 8729 if USE_SSL is True 76 | ALLOW_SELF_SIGNED_CERTS = False # Set to True only if using self-signed certificates 77 | ``` 78 | 4. Add Mikrocata user in Mikrotik: 79 | ```sh 80 | /user/add name=mikrocata2selks password=xxxxxxxxxxxxx group=full (change password) 81 | ``` 82 | 83 | ## 🛠️ Handling Multiple Mikrotik Devices 84 | 85 | By configuring the `easyinstall.sh` file to manage more than one Mikrotik device, the setup script will automatically create dedicated dummy interfaces and corresponding Mikrocata services for each device on the Debian machine. 86 | 87 | - Example configuration: 88 | - For Mikrotik0: Creates the `tzsp0` interface on port `37008` and the script `/usr/local/bin/mikrocataTZSP0.py`. 89 | - For Mikrotik1: Creates the `tzsp1` interface on port `37009` and the script `/usr/local/bin/mikrocataTZSP1.py`. 90 | - For Mikrotik2: Creates the `tzsp2` interface on port `37010` and the script `/usr/local/bin/mikrocataTZSP2.py`. 91 | 92 | You will need to edit each script with the specific Mikrotik values and enable the sniffer on each Mikrotik device to send data to the corresponding port. 93 | The system architecture for handling multiple Mikrotik devices is designed to be modular and scalable. Here's a visual representation of how the system works: 94 | 95 | ```mermaid 96 | flowchart TD 97 | subgraph Mikrotik_Devices 98 | M0[Mikrotik0 Port:37008] 99 | M1[Mikrotik1 Port:37009] 100 | M2[Mikrotik2 Port:37010] 101 | end 102 | 103 | subgraph Debian_Server ["Debian Server (SELKS)"] 104 | subgraph Interfaces 105 | I0[Interface:tzsp0 Port:37008] 106 | I1[Interface:tzsp1 Port:37009] 107 | I2[Interface:tzsp2 Port:37010] 108 | end 109 | 110 | subgraph Mikrocata_Services 111 | S0[mikrocataTZSP0.py] 112 | S1[mikrocataTZSP1.py] 113 | S2[mikrocataTZSP2.py] 114 | end 115 | 116 | subgraph Analysis 117 | suricata[Suricata IDS/IPS\nDocker Container] 118 | telegram[Telegram\nNotifications] 119 | end 120 | end 121 | 122 | M0 -->|TZSP Traffic| I0 123 | M1 -->|TZSP Traffic| I1 124 | M2 -->|TZSP Traffic| I2 125 | 126 | I0 -->|Packet Analysis| S0 127 | I1 -->|Packet Analysis| S1 128 | I2 -->|Packet Analysis| S2 129 | 130 | S0 -->|Alerts| suricata 131 | S1 -->|Alerts| suricata 132 | S2 -->|Alerts| suricata 133 | 134 | suricata -->|Block Notifications| telegram 135 | 136 | style Debian_Server fill:#f5f5f5,stroke:#333,stroke-width:2px 137 | style Mikrotik_Devices fill:#e1f5fe,stroke:#333,stroke-width:2px 138 | style Analysis fill:#e8f5e9,stroke:#333,stroke-width:2px 139 | ``` 140 | 141 | ## 💡 Features 142 | 143 | - Installs Docker and Docker Compose. 144 | - Installs Python. 145 | - Downloads and installs SELKS repository (https://github.com/StamusNetworks/SELKS). 146 | - Downloads and installs Mikrocata. 147 | - Installs TZSP interface. 148 | - Enables notifications over Telegram when an IP is blocked. 149 | 150 | ## 🔄 Changelog 151 | 152 | - View CHANGELOG.md 153 | 154 | ## 🔧 Troubleshooting 155 | 156 | - Check if packets are arriving at the VM from Mikrotik through the dummy interface: 157 | ```sh 158 | tcpdump -i tzsp0 159 | ``` 160 | - Check if mikrocata service and tzsp0 interface are up and running: 161 | ```sh 162 | systemctl status mikrocataTZSP0.service 163 | systemctl status TZSPreplay37008@tzsp0.service 164 | ``` 165 | - Check if Suricata Docker container is up and running: 166 | ```sh 167 | docker logs -f suricata 168 | ``` 169 | if suricata shows 'Fatal glibc error: CPU does not support x86-64-v2' and you are under Proxmox Ve, please set CPU processor to HOST 170 | 171 | 172 | ## 📝 Notes 173 | - Default account for SELKS: 174 | - URL: `https://[YOURDEBIANIP]` 175 | - Username: `selks-user` 176 | - Password: `selks-user` 177 | 178 | ## 👤 Author 179 | 180 | **Giuseppe Trifilio** 181 | 182 | - [Website](https://github.com/angolo40/mikrocata2selks) 183 | - [GitHub](https://github.com/angolo40) 184 | 185 | Inspired by [zzbe/mikrocata](https://github.com/zzbe/mikrocata). 186 | 187 | ## 🤝 Contributing 188 | 189 | Contributions, issues, and feature requests are welcome! Check the [issues page](https://github.com/angolo40/mikrocata2selks). 190 | 191 | ## 🌟 Show Your Support 192 | 193 | Give a ⭐️ if this project helped you! 194 | 195 | - **XMR**: `87LLkcvwm7JUZAVjusKsnwNRPfhegxe73X7X3mWXDPMnTBCb6JDFnspbN8qdKZA6StHXqnJxMp3VgRK7DcS2sgnW3wH7Xhw` 196 | -------------------------------------------------------------------------------- /Screenshot_20250228_142832.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/angolo40/mikrocata2selks/7863881f8fbcd6bf88bc71041de71381c7ada4a2/Screenshot_20250228_142832.png -------------------------------------------------------------------------------- /TZSPreplay@.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=TZSP Replay capture on dev %i 3 | After=network.target network-online.target 4 | Requires=network-online.target 5 | 6 | [Service] 7 | Type=simple 8 | Environment="SCRIPT_ARGS=%I" 9 | ExecStart=/bin/sh -c "/usr/local/bin/tzsp2pcap -f | /usr/local/bin/tcpreplay-edit --topspeed --mtu=$(cat /sys/class/net/%I/mtu) --mtu-trunc -i %I -" 10 | Restart=always 11 | RestartSec=3 12 | ProtectSystem=full 13 | ProtectHome=true 14 | 15 | [Install] 16 | WantedBy=multi-user.target 17 | -------------------------------------------------------------------------------- /easyinstall.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ### START EDIT SETTINGS 4 | 5 | # Path where to install SELKS files 6 | PATH_SELKS=$HOME/SELKS 7 | 8 | # SETUP CONFIG SCRIPT 9 | INSTALL_DUMMY_INTERFACE=true 10 | INSTALL_MIKROCATA_SERVICE=true 11 | INSTALL_SELKS=true 12 | 13 | HOW_MANY_MIKROTIK=1 #Min 1 Mikrotik 14 | 15 | ### END EDIT SETTINGS 16 | 17 | echo "--- Install required package ---" 18 | 19 | apt-get install ca-certificates curl wget unzip tcpdump gnupg lsb-release build-essential python3-pip python3-pyinotify python3-ujson python3-librouteros python3-requests git htop libpcap-dev -y 20 | 21 | PATH_GIT_MIKROCATA=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) 22 | sed -i '/SELKS_CONTAINER_DATA_SURICATA_LOG=/c\SELKS_CONTAINER_DATA_SURICATA_LOG="'$PATH_SELKS'/docker/containers-data/suricata/logs/"' "$PATH_GIT_MIKROCATA/mikrocata.py" 23 | 24 | HOW_MANY_MIKROTIK=$(( $HOW_MANY_MIKROTIK - 1 )) 25 | 26 | docker -v 27 | if [ $? -eq 128 ]; then 28 | echo "--- Installing docker ---" 29 | curl -fsSL https://get.docker.com/ | sh 30 | else 31 | echo "--- Docker already installed ---" 32 | fi 33 | 34 | if $INSTALL_DUMMY_INTERFACE 35 | then 36 | echo "--- Install packet sniffer interface ---" 37 | wget -P /opt https://github.com/thefloweringash/tzsp2pcap/archive/master.zip 38 | cd /opt 39 | unzip /opt/master.zip 40 | cd /opt/tzsp2pcap-master/ 41 | make 42 | make install 43 | 44 | wget -P /opt https://github.com/appneta/tcpreplay/releases/download/v4.4.2/tcpreplay-4.4.2.tar.gz 45 | cd /opt 46 | tar -xf /opt/tcpreplay-4.4.2.tar.gz -C /opt 47 | cd /opt/tcpreplay-4.4.2/ 48 | ./configure 49 | make 50 | make install 51 | 52 | num=0 53 | while [ $num -le $HOW_MANY_MIKROTIK ] 54 | do 55 | echo "--- Creating interface ---" 56 | cp $PATH_GIT_MIKROCATA/tzsp.netdev /etc/systemd/network/tzsp$num.netdev 57 | cp $PATH_GIT_MIKROCATA/tzsp.network /etc/systemd/network/tzsp$num.network 58 | cmd="tzsp$num" 59 | sed -i "s/tzsp0/$cmd/g" /etc/systemd/network/tzsp$num.netdev 60 | sed -i "s/tzsp*/$cmd/g" /etc/systemd/network/tzsp$num.network 61 | cmd="25$num" 62 | sed -i "s/254/$cmd/g" /etc/systemd/network/tzsp$num.network 63 | num=$(( $num + 1 )) 64 | done 65 | systemctl enable systemd-networkd 66 | systemctl restart systemd-networkd 67 | 68 | port=37008 69 | num=0 70 | while [ $num -le $HOW_MANY_MIKROTIK ] 71 | do 72 | echo "--- Create service for interface dummy ---" 73 | cp $PATH_GIT_MIKROCATA/TZSPreplay@.service /etc/systemd/system/TZSPreplay$port@.service 74 | cmd="tzsp2pcap -p $port" 75 | sed -i "s/tzsp2pcap/$cmd/g" /etc/systemd/system/TZSPreplay$port@.service 76 | systemctl enable --now TZSPreplay$port@tzsp$num.service 77 | num=$(( $num + 1 )) 78 | port=$(( $port + 1 )) 79 | done 80 | fi 81 | 82 | if $INSTALL_MIKROCATA_SERVICE 83 | then 84 | 85 | num=0 86 | while [ $num -le $HOW_MANY_MIKROTIK ] 87 | do 88 | echo "--- Installing Mikrocata and his service ---" 89 | cp $PATH_GIT_MIKROCATA/mikrocata.py /usr/local/bin/mikrocataTZSP$num.py 90 | chmod +x /usr/local/bin/mikrocataTZSP$num.py 91 | sed -i "s/tzsp0/tzsp$num/g" /usr/local/bin/mikrocataTZSP$num.py 92 | mkdir -p /var/lib/mikrocata 93 | touch /var/lib/mikrocata/savelists-tzsp$num.json 94 | touch /var/lib/mikrocata/uptime-tzsp$num.bookmark 95 | touch /var/lib/mikrocata/ignore-tzsp$num.conf 96 | cp $PATH_GIT_MIKROCATA/mikrocata.service /etc/systemd/system/mikrocataTZSP$num.service 97 | cmd="mikrocataTZSP$num.py" 98 | sed -i "s/mikrocata.py/$cmd/g" /etc/systemd/system/mikrocataTZSP$num.service 99 | systemctl enable --now mikrocataTZSP$num.service 100 | num=$(( $num + 1 )) 101 | done 102 | 103 | fi 104 | 105 | if $INSTALL_SELKS 106 | then 107 | echo "--- Start SELKS Installer ---" 108 | 109 | git clone https://github.com/StamusNetworks/SELKS.git $PATH_SELKS 110 | cd $PATH_SELKS/docker/ 111 | 112 | num=0 113 | cmd="" 114 | cmd2="" 115 | while [ $num -le $HOW_MANY_MIKROTIK ] 116 | do 117 | cmd2="$cmd2 -i tzsp$num" 118 | num=$(( $num + 1 )) 119 | done 120 | 121 | ./easy-setup.sh --non-interactive $cmd2 --iA --restart-mode always --es-memory 6G 122 | docker compose up -d 123 | 124 | fi 125 | 126 | echo "--- INSTALL COMPLETED ---" 127 | echo "--- " 128 | echo "--- " 129 | port=37008 130 | num=0 131 | while [ $num -le $HOW_MANY_MIKROTIK ] 132 | do 133 | echo "--- MIKROTIK $num" 134 | echo "--- Port: $port " 135 | echo "--- Local Interface: tzsp$num" 136 | echo "--- SERVICEs:" 137 | echo "--- --- ----: Mikrocata: Edit '/usr/local/bin/mikrocataTZSP$num.py' with your info and then reload service --> 'systemctl restart mikrocataTZSP$num.service'" 138 | echo "--- --- --- : Interface: TZSPreplay$port@tzsp$num.service --> 'systemctl status TZSPreplay$port@tzsp$num.service'" 139 | echo "--- " 140 | num=$(( $num + 1 )) 141 | port=$(( $port + 1 )) 142 | done 143 | echo "--- " 144 | echo "--- " 145 | echo "--- Remember to configure Mikrotik" 146 | echo "--- " 147 | -------------------------------------------------------------------------------- /mikrocata.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import ssl 4 | import os 5 | import socket 6 | import re 7 | import ipaddress 8 | from time import sleep 9 | from datetime import datetime as dt 10 | import pyinotify 11 | import ujson 12 | import json 13 | import librouteros 14 | from librouteros import connect 15 | from librouteros.query import Key 16 | import requests 17 | 18 | VERSION = "2.3.0" # Updated April 2025 19 | 20 | # ------------------------------------------------------------------------------ 21 | ################# START EDIT SETTINGS 22 | 23 | #Set Mikrotik login information 24 | USERNAME = "mikrocata2selks" 25 | PASSWORD = "password" 26 | ROUTER_IP = "192.168.0.1" 27 | TIMEOUT = "1d" 28 | USE_SSL = False # Set to True to use SSL connection 29 | PORT = 8728 # Default port for non-SSL connection. Will use 8729 if USE_SSL is True 30 | BLOCK_LIST_NAME = "Suricata" 31 | 32 | #Set Telegram information 33 | enable_telegram = False 34 | TELEGRAM_TOKEN = "TOKEN" 35 | TELEGRAM_CHATID = "CHATID" 36 | 37 | # You can add your WAN IP, so it doesn't get mistakenly blocked (don't leave empty string) 38 | WAN_IP = "yourpublicip" 39 | LOCAL_IP_PREFIX = "192.168.0.0/16" 40 | WHITELIST_IPS = (WAN_IP, LOCAL_IP_PREFIX, "127.0.0.1", "1.1.1.1", "8.8.8.8", "fe80:", "10.0.0.0/8", "172.16.0.0/12") 41 | COMMENT_TIME_FORMAT = "%-d %b %Y %H:%M:%S.%f" # See datetime strftime formats. 42 | ENABLE_IPV6 = False 43 | 44 | #Set comma separated value of suricata alerts severity which will be blocked in Mikrotik. All severity values are ("1","2","3") 45 | SEVERITY=("1","2") 46 | 47 | # Allow self-signed certificates 48 | # WARNING: These settings bypass certificate verification and should only be used 49 | # with self-signed certificates in trusted environments 50 | ALLOW_SELF_SIGNED_CERTS = False 51 | 52 | # Enable debug mode for verbose logging 53 | DEBUG_MODE = False 54 | 55 | ################# END EDIT SETTINGS 56 | # ------------------------------------------------------------------------------ 57 | LISTEN_INTERFACE=("tzsp0") 58 | 59 | # Suricata log file 60 | SELKS_CONTAINER_DATA_SURICATA_LOG="/root/SELKS/docker/containers-data/suricata/logs/" 61 | FILEPATH = os.path.abspath(SELKS_CONTAINER_DATA_SURICATA_LOG + "eve.json") 62 | 63 | # Save Mikrotik address lists to a file and reload them on Mikrotik reboot. 64 | # You can add additional list(s), e.g. [BLOCK_LIST_NAME, "blocklist1", "list2"] 65 | SAVE_LISTS = [BLOCK_LIST_NAME] 66 | 67 | # (!) Make sure you have privileges (!) 68 | SAVE_LISTS_LOCATION = os.path.abspath("/var/lib/mikrocata/savelists-tzsp0.json") 69 | SAVE_LISTS_LOCATION_V6 = os.path.abspath("/var/lib/mikrocata/savelists-tzsp0_v6.json") 70 | # Location for Mikrotik's uptime. (needed for re-adding lists after reboot) 71 | UPTIME_BOOKMARK = os.path.abspath("/var/lib/mikrocata/uptime-tzsp0.bookmark") 72 | 73 | # Ignored rules file location - check ignore.conf for syntax. 74 | IGNORE_LIST_LOCATION = os.path.abspath("/var/lib/mikrocata/ignore-tzsp0.conf") 75 | 76 | # Add all alerts from alerts.json on start? 77 | # Setting this to True will start reading alerts.json from beginning 78 | # and will add whole file to firewall when pyinotify is triggered. 79 | # Just for testing purposes, i.e. not good for systemd service. 80 | ADD_ON_START = False 81 | 82 | # global vars 83 | last_pos = 0 84 | api = None 85 | ignore_list = [] 86 | last_save_time = 0 87 | SAVE_INTERVAL = 300 # Save lists every 5 minutes 88 | 89 | def debug_log(message): 90 | """Print message only if DEBUG_MODE is enabled""" 91 | if DEBUG_MODE: 92 | print(f"[Mikrocata-DEBUG] {message}") 93 | 94 | def sanitize_text(text): 95 | """Remove emojis and other non-ASCII characters from text""" 96 | if not text: 97 | return "" 98 | # Keep only ASCII characters (removes all emojis and special characters) 99 | return ''.join(char for char in text if ord(char) < 128) 100 | 101 | def is_ip_in_whitelist(ip_to_check, whitelist): 102 | """ 103 | Check if an IP is in the whitelist, supporting both direct matches, 104 | prefix matches, and CIDR notation. 105 | """ 106 | try: 107 | # Convert the IP to check to an ipaddress object for CIDR matching 108 | if ':' in ip_to_check: # IPv6 109 | ip_obj = ipaddress.IPv6Address(ip_to_check) 110 | else: # IPv4 111 | ip_obj = ipaddress.IPv4Address(ip_to_check) 112 | 113 | for item in whitelist: 114 | # Direct IP match 115 | if ip_to_check == item: 116 | debug_log(f"IP {ip_to_check} matches exact whitelist entry {item}") 117 | return True 118 | 119 | # String prefix match (like "192.168.") 120 | if isinstance(item, str) and not '/' in item and ip_to_check.startswith(item): 121 | debug_log(f"IP {ip_to_check} matches prefix whitelist entry {item}") 122 | return True 123 | 124 | # CIDR notation check (like "10.0.0.0/8") 125 | if '/' in item: 126 | try: 127 | network = ipaddress.ip_network(item) 128 | if ip_obj in network: 129 | debug_log(f"IP {ip_to_check} is within CIDR whitelist range {item}") 130 | return True 131 | except ValueError: 132 | print(f"[Mikrocata] Warning: Invalid CIDR notation in whitelist: {item}") 133 | 134 | debug_log(f"IP {ip_to_check} is not in any whitelist entry") 135 | return False 136 | 137 | except ValueError as e: 138 | debug_log(f"Error checking whitelist for IP {ip_to_check}: {e}") 139 | # If we can't parse the IP, we should not whitelist it 140 | return False 141 | 142 | class EventHandler(pyinotify.ProcessEvent): 143 | def process_IN_MODIFY(self, event): 144 | if event.pathname == FILEPATH: 145 | try: 146 | add_to_tik(read_json(FILEPATH)) 147 | except ConnectionError: 148 | connect_to_tik() 149 | 150 | def process_IN_CREATE(self, event): 151 | if event.pathname == FILEPATH: 152 | print(f"[Mikrocata] New eve.json detected. Resetting last_pos.") 153 | global last_pos 154 | last_pos = 0 155 | self.process_IN_MODIFY(event) 156 | 157 | def process_IN_DELETE(self, event): 158 | if event.pathname == FILEPATH: 159 | print(f"[Mikrocata] eve.json deleted. Monitoring for new file.") 160 | 161 | def seek_to_end(fpath): 162 | global last_pos 163 | 164 | if not ADD_ON_START: 165 | while True: 166 | try: 167 | last_pos = os.path.getsize(fpath) 168 | return 169 | 170 | except FileNotFoundError: 171 | print(f"[Mikrocata] File: {fpath} not found. Retrying in 10 seconds..") 172 | sleep(10) 173 | continue 174 | 175 | def read_json(fpath): 176 | global last_pos 177 | while True: 178 | try: 179 | with open(fpath, "r") as f: 180 | f.seek(last_pos) 181 | alerts = [] 182 | for line in f.readlines(): 183 | try: 184 | alert = json.loads(line) 185 | if alert.get('event_type') == 'alert': 186 | alerts.append(alert) # Fixed: don't json.loads again 187 | else: 188 | last_pos = f.tell() 189 | continue 190 | except: 191 | continue 192 | last_pos = f.tell() 193 | return alerts 194 | except FileNotFoundError: 195 | print(f"[Mikrocata] File: {fpath} not found. Retrying in 10 seconds..") 196 | sleep(10) 197 | continue 198 | 199 | def add_to_tik(alerts): 200 | global last_pos 201 | global api 202 | global last_save_time 203 | 204 | _address = Key("address") 205 | _id = Key(".id") 206 | _list = Key("list") 207 | 208 | if DEBUG_MODE: 209 | print(f"[Mikrocata] Processing {len(alerts)} alert events") 210 | 211 | if not alerts: 212 | debug_log("No alerts to process") 213 | return 214 | 215 | try: 216 | address_list = api.path("/ip/firewall/address-list") 217 | address_list_v6 = api.path("/ipv6/firewall/address-list") 218 | resources = api.path("system/resource") 219 | debug_log("Successfully connected to Mikrotik API paths") 220 | except Exception as e: 221 | print(f"[Mikrocata] Error connecting to Mikrotik API: {str(e)}") 222 | raise 223 | 224 | # Remove duplicate src_ips 225 | unique_alerts = {item['src_ip']: item for item in alerts}.values() 226 | debug_log(f"Processing {len(unique_alerts)} unique source IPs from alerts") 227 | 228 | for event in unique_alerts: 229 | debug_log(f"Processing alert: SID={event['alert']['signature_id']}, Severity={event['alert']['severity']}") 230 | 231 | # Check alert severity 232 | if str(event["alert"]["severity"]) not in SEVERITY: 233 | print(f"[Mikrocata] Skipping alert SID={event['alert']['signature_id']} (severity {event['alert']['severity']})") 234 | continue 235 | 236 | # Check interface 237 | if str(event["in_iface"]) not in LISTEN_INTERFACE: 238 | debug_log(f"Skipping alert from interface {event['in_iface']}") 239 | continue 240 | 241 | # Check if in ignore list 242 | if in_ignore_list(ignore_list, event): 243 | print(f"[Mikrocata] Skipping alert {event['alert']['signature_id']} - in ignore list") 244 | continue 245 | 246 | debug_log(f"Alert passed all filters, preparing to add to MikroTik") 247 | 248 | try: 249 | timestamp = dt.strptime(event["timestamp"], 250 | "%Y-%m-%dT%H:%M:%S.%f%z").strftime( 251 | COMMENT_TIME_FORMAT) 252 | except Exception as e: 253 | debug_log(f"Error parsing timestamp {event['timestamp']}: {str(e)}") 254 | timestamp = dt.now().strftime(COMMENT_TIME_FORMAT) 255 | 256 | # Determine if IPv6 257 | is_v6 = ':' in event["src_ip"] 258 | curr_list = address_list 259 | if ENABLE_IPV6 and is_v6: 260 | debug_log(f"IPv6 address detected: {event['src_ip']}") 261 | curr_list = address_list_v6 262 | 263 | # Check whitelist with improved function 264 | if is_ip_in_whitelist(event["src_ip"], WHITELIST_IPS): 265 | debug_log(f"Source IP {event['src_ip']} in whitelist") 266 | if is_ip_in_whitelist(event["dest_ip"], WHITELIST_IPS): 267 | debug_log(f"Destination IP {event['dest_ip']} also in whitelist - skipping alert") 268 | continue 269 | 270 | wanted_ip, wanted_port = event["dest_ip"], event.get("src_port") 271 | src_ip, src_port = event["src_ip"], event.get("dest_port") 272 | debug_log(f"Source IP in whitelist, targeting destination: {wanted_ip}") 273 | else: 274 | wanted_ip, wanted_port = event["src_ip"], event.get("dest_port") 275 | src_ip, src_port = event["dest_ip"], event.get("src_port") 276 | debug_log(f"Targeting source IP: {wanted_ip}") 277 | 278 | # Check if target IP is in whitelist 279 | if is_ip_in_whitelist(wanted_ip, WHITELIST_IPS): 280 | print(f"[Mikrocata] Skipping: target IP {wanted_ip} is in whitelist") 281 | continue 282 | 283 | try: 284 | # Log original signature before sanitizing 285 | original_signature = event['alert']['signature'] 286 | debug_log(f"Original signature: {original_signature}") 287 | 288 | # Sanitize the signature to remove emojis and special characters 289 | signature = sanitize_text(original_signature) 290 | debug_log(f"Sanitized signature: {signature}") 291 | 292 | # If significant information was lost in sanitization, log a warning 293 | if len(signature) < len(original_signature) * 0.7: # If more than 30% of chars were removed 294 | debug_log(f"WARNING: Significant information lost during sanitization!") 295 | 296 | cmnt = f"""[{event['alert']['gid']}:{ 297 | event['alert']['signature_id']}] { 298 | signature} ::: Port: { 299 | wanted_port}/{ 300 | event['proto']} ::: timestamp: { 301 | timestamp}""" 302 | 303 | debug_log(f"Adding to list '{BLOCK_LIST_NAME}': IP={wanted_ip}, Timeout={TIMEOUT}") 304 | debug_log(f"Comment: {cmnt}") 305 | 306 | curr_list.add(list=BLOCK_LIST_NAME, 307 | address=wanted_ip, 308 | comment=cmnt, 309 | timeout=TIMEOUT) 310 | 311 | print(f"[Mikrocata] BLOCKED: {wanted_ip} - SID:{event['alert']['signature_id']} - Severity:{event['alert']['severity']}") 312 | 313 | # Telegram notifications 314 | if enable_telegram: 315 | debug_log("Telegram notifications enabled, sending message") 316 | clean_message = sanitize_text(f"From: {wanted_ip}\nTo: {src_ip}:{str(wanted_port)}\nRule: {cmnt}") 317 | response = requests.get(sendTelegram(clean_message)) 318 | debug_log(f"Telegram API response: {response.status_code}") 319 | 320 | except librouteros.exceptions.TrapError as e: 321 | debug_log(f"MikroTik TrapError: {str(e)}") 322 | 323 | if "failure: already have such entry" in str(e): 324 | debug_log(f"IP {wanted_ip} already exists in list {BLOCK_LIST_NAME}, updating entry") 325 | 326 | # Find and remove existing entry 327 | existing_entries = list(curr_list.select(_id, _list, _address).where( 328 | _address == wanted_ip, 329 | _list == BLOCK_LIST_NAME)) 330 | 331 | debug_log(f"Found {len(existing_entries)} existing entries for {wanted_ip}") 332 | 333 | for row in existing_entries: 334 | debug_log(f"Removing existing entry with ID {row['.id']}") 335 | curr_list.remove(row[".id"]) 336 | 337 | # Sanitize the signature here too 338 | signature = sanitize_text(event['alert']['signature']) 339 | 340 | # Add updated entry 341 | updated_comment = f"""[{event['alert']['gid']}:{ 342 | event['alert']['signature_id']}] { 343 | signature} ::: Port: { 344 | wanted_port}/{ 345 | event['proto']} ::: timestamp: { 346 | timestamp}""" 347 | 348 | debug_log(f"Re-adding IP {wanted_ip} with updated comment") 349 | curr_list.add(list=BLOCK_LIST_NAME, 350 | address=wanted_ip, 351 | comment=updated_comment, 352 | timeout=TIMEOUT) 353 | print(f"[Mikrocata] UPDATED: {wanted_ip} - SID:{event['alert']['signature_id']}") 354 | 355 | else: 356 | print(f"[Mikrocata] ERROR: TrapError: {str(e)}") 357 | raise 358 | 359 | except socket.timeout as e: 360 | print(f"[Mikrocata] Socket timeout: {str(e)}, reconnecting...") 361 | connect_to_tik() 362 | 363 | except Exception as e: 364 | print(f"[Mikrocata] ERROR: {type(e).__name__} while processing {wanted_ip}: {str(e)}") 365 | if DEBUG_MODE: 366 | import traceback 367 | print(f"[Mikrocata] Traceback: {traceback.format_exc()}") 368 | continue 369 | 370 | # Save lists and check uptime every x minutes 371 | current_time = int(dt.now().timestamp()) 372 | time_since_last_save = current_time - last_save_time 373 | debug_log(f"Time since last save: {time_since_last_save} seconds (interval: {SAVE_INTERVAL} seconds)") 374 | 375 | if time_since_last_save >= SAVE_INTERVAL: 376 | debug_log(f"Save interval reached, saving lists and checking router uptime") 377 | last_save_time = current_time 378 | 379 | # Check router uptime and restore lists if needed 380 | debug_log("Checking MikroTik uptime") 381 | uptime_check = check_tik_uptime(resources) 382 | 383 | if uptime_check: 384 | print("[Mikrocata] Router rebooted - restoring saved lists") 385 | try: 386 | add_saved_lists(address_list) 387 | debug_log("Successfully restored IPv4 address lists") 388 | if ENABLE_IPV6: 389 | add_saved_lists(address_list_v6, True) 390 | debug_log("Successfully restored IPv6 address lists") 391 | except Exception as e: 392 | print(f"[Mikrocata] ERROR: Failed to restore lists: {str(e)}") 393 | else: 394 | debug_log("Router has not been rebooted, no need to restore lists") 395 | 396 | # Save current lists to file 397 | try: 398 | save_lists(address_list) 399 | debug_log("Successfully saved IPv4 address lists") 400 | if ENABLE_IPV6: 401 | save_lists(address_list_v6, True) 402 | debug_log("Successfully saved IPv6 address lists") 403 | except Exception as e: 404 | print(f"[Mikrocata] ERROR: Failed to save lists: {str(e)}") 405 | 406 | debug_log("Lists saved successfully") 407 | 408 | debug_log("Alert processing completed") 409 | 410 | def check_tik_uptime(resources): 411 | 412 | for row in resources: 413 | uptime = row["uptime"] 414 | 415 | if "w" in uptime: 416 | weeks = int(re.search(r"(\A|\D)(\d*)w", uptime).group(2)) 417 | else: 418 | weeks = 0 419 | 420 | if "d" in uptime: 421 | days = int(re.search(r"(\A|\D)(\d*)d", uptime).group(2)) 422 | else: 423 | days = 0 424 | 425 | if "h" in uptime: 426 | hours = int(re.search(r"(\A|\D)(\d*)h", uptime).group(2)) 427 | else: 428 | hours = 0 429 | 430 | if "m" in uptime: 431 | minutes = int(re.search(r"(\A|\D)(\d*)m", uptime).group(2)) 432 | else: 433 | minutes = 0 434 | 435 | if "s" in uptime: 436 | seconds = int(re.search(r"(\A|\D)(\d*)s", uptime).group(2)) 437 | else: 438 | seconds = 0 439 | 440 | total_seconds = (weeks*7*24 + days*24 + hours)*3600 + minutes*60 + seconds 441 | 442 | if total_seconds < 900: 443 | total_seconds = 900 444 | 445 | with open(UPTIME_BOOKMARK, "r") as f: 446 | try: 447 | bookmark = int(f.read()) 448 | except ValueError: 449 | bookmark = 0 450 | 451 | with open(UPTIME_BOOKMARK, "w+") as f: 452 | f.write(str(total_seconds)) 453 | 454 | if total_seconds < bookmark: 455 | return True 456 | 457 | return False 458 | 459 | 460 | def connect_to_tik(): 461 | global api 462 | 463 | # Determine which port to use 464 | actual_port = 8729 if USE_SSL else 8728 465 | 466 | while True: 467 | try: 468 | if USE_SSL: 469 | # SSL connection setup 470 | if ALLOW_SELF_SIGNED_CERTS: 471 | # Settings for self-signed certificates 472 | ctx = ssl.create_default_context() 473 | ctx.check_hostname = False 474 | ctx.verify_mode = ssl.CERT_NONE 475 | ctx.set_ciphers('DEFAULT@SECLEVEL=0') 476 | else: 477 | # Settings for valid certificates 478 | ctx = ssl.create_default_context() 479 | ctx.check_hostname = True 480 | ctx.verify_mode = ssl.CERT_REQUIRED 481 | ctx.set_ciphers('DEFAULT@SECLEVEL=2') 482 | 483 | # Connect with SSL 484 | api = connect(username=USERNAME, password=PASSWORD, host=ROUTER_IP, 485 | ssl_wrapper=ctx.wrap_socket, port=actual_port) 486 | else: 487 | # Plain connection without SSL 488 | api = connect(username=USERNAME, password=PASSWORD, host=ROUTER_IP, 489 | port=actual_port) 490 | print(f"[Mikrocata] Connected to Mikrotik") 491 | break 492 | 493 | 494 | except librouteros.exceptions.TrapError as e: 495 | if "invalid user name or password" in str(e): 496 | print("[Mikrocata] Invalid username or password.") 497 | sleep(10) 498 | continue 499 | 500 | raise 501 | 502 | except socket.timeout as e: 503 | print(f"[Mikrocata] Socket timeout: {str(e)}.") 504 | sleep(30) 505 | continue 506 | 507 | except ConnectionRefusedError: 508 | print("[Mikrocata] Connection refused. (api-ssl disabled in router?)") 509 | sleep(10) 510 | continue 511 | 512 | except OSError as e: 513 | if e.errno == 113: 514 | print("[Mikrocata] No route to host. Retrying in 10 seconds..") 515 | sleep(10) 516 | continue 517 | 518 | if e.errno == 101: 519 | print("[Mikrocata] Network is unreachable. Retrying in 10 seconds..") 520 | sleep(10) 521 | continue 522 | 523 | raise 524 | 525 | def save_lists(address_list,is_v6=False): 526 | _address = Key("address") 527 | _list = Key("list") 528 | _timeout = Key("timeout") 529 | _comment = Key("comment") 530 | curr_file = SAVE_LISTS_LOCATION 531 | if is_v6: 532 | curr_file = SAVE_LISTS_LOCATION_V6 533 | with open(curr_file, "w") as f: 534 | for save_list in SAVE_LISTS: 535 | for row in address_list.select(_list, _address, _timeout, 536 | _comment).where(_list == save_list): 537 | f.write(ujson.dumps(row) + "\n") 538 | 539 | def add_saved_lists(address_list, is_v6=False): 540 | curr_file = SAVE_LISTS_LOCATION 541 | if is_v6: 542 | curr_file = SAVE_LISTS_LOCATION_V6 543 | with open(curr_file, "r") as f: 544 | addresses = [ujson.loads(line) for line in f.readlines()] 545 | for row in addresses: 546 | cmnt = row.get("comment") 547 | if cmnt is None: 548 | cmnt = "" 549 | try: 550 | address_list.add(list=row["list"], address=row["address"], 551 | comment=cmnt, timeout=row["timeout"]) 552 | 553 | except librouteros.exceptions.TrapError as e: 554 | if "failure: already have such entry" in str(e): 555 | continue 556 | 557 | raise 558 | 559 | def read_ignore_list(fpath): 560 | global ignore_list 561 | 562 | try: 563 | with open(fpath, "r") as f: 564 | 565 | for line in f: 566 | line = line.partition("#")[0].strip() 567 | 568 | if line.strip(): 569 | ignore_list.append(line) 570 | 571 | except FileNotFoundError: 572 | print(f"[Mikrocata] File: {IGNORE_LIST_LOCATION} not found. Continuing..") 573 | 574 | def in_ignore_list(ignr_list, event): 575 | for entry in ignr_list: 576 | if entry.isdigit() and int(entry) == int(event['alert']['signature_id']): 577 | sleep(1) 578 | return True 579 | 580 | if entry.startswith("re:"): 581 | entry = entry.partition("re:")[2].strip() 582 | 583 | if re.search(entry, event['alert']['signature']): 584 | sleep(1) 585 | return True 586 | 587 | return False 588 | 589 | def sendTelegram(message): 590 | if enable_telegram: 591 | telegram_url = f"https://api.telegram.org/bot{TELEGRAM_TOKEN}/sendMessage?chat_id={TELEGRAM_CHATID}&text={message}&disable_web_page_preview=true&parse_mode=html" 592 | try: 593 | response = requests.get(telegram_url) 594 | debug_log(f"Telegram response: {response.json()}") 595 | return telegram_url 596 | except Exception as e: 597 | print(f"[Mikrocata] Failed to send Telegram message: {e}") 598 | return "" 599 | 600 | 601 | def main(): 602 | 603 | print(f"[Mikrocata] Starting Mikrocata2SELKS v{VERSION}") 604 | 605 | if DEBUG_MODE: 606 | print("[Mikrocata] Starting in DEBUG mode - verbose logging enabled") 607 | else: 608 | print("[Mikrocata] Starting in normal mode") 609 | 610 | seek_to_end(FILEPATH) 611 | connect_to_tik() 612 | read_ignore_list(IGNORE_LIST_LOCATION) 613 | os.makedirs(os.path.dirname(SAVE_LISTS_LOCATION), exist_ok=True) 614 | os.makedirs(os.path.dirname(SAVE_LISTS_LOCATION_V6), exist_ok=True) 615 | os.makedirs(os.path.dirname(UPTIME_BOOKMARK), exist_ok=True) 616 | 617 | directory_to_monitor = os.path.dirname(FILEPATH) 618 | 619 | wm = pyinotify.WatchManager() 620 | handler = EventHandler() 621 | notifier = pyinotify.Notifier(wm, handler) 622 | wm.add_watch(directory_to_monitor, pyinotify.IN_CREATE | pyinotify.IN_MODIFY | pyinotify.IN_DELETE, rec=False) 623 | 624 | print(f"[Mikrocata] Monitoring {FILEPATH} for alerts") 625 | print(f"[Mikrocata] Whitelist configured for: {WHITELIST_IPS}") 626 | print(f"[Mikrocata] Configured to process alerts with severity: {SEVERITY}") 627 | 628 | while True: 629 | try: 630 | notifier.loop() 631 | 632 | except (librouteros.exceptions.ConnectionClosed, socket.timeout) as e: 633 | print(f"[Mikrocata] Connection error: {str(e)}") 634 | connect_to_tik() 635 | continue 636 | 637 | except librouteros.exceptions.TrapError as e: 638 | print(f"[Mikrocata] TrapError: {str(e)}") 639 | continue 640 | 641 | except KeyError as e: 642 | print(f"[Mikrocata] KeyError: {str(e)}") 643 | continue 644 | 645 | except Exception as e: 646 | print(f"[Mikrocata] Unexpected error: {str(e)}") 647 | if DEBUG_MODE: 648 | import traceback 649 | print(f"[Mikrocata] Traceback: {traceback.format_exc()}") 650 | sleep(5) 651 | continue 652 | 653 | if __name__ == "__main__": 654 | main() 655 | -------------------------------------------------------------------------------- /mikrocata.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Suricata to Mikrotik API in Python 3 | After=network.target network-online.target time-sync.target 4 | Wants=network-online.target 5 | 6 | [Service] 7 | Type=simple 8 | ExecStart=/usr/bin/python3 /usr/local/bin/mikrocata.py 9 | Restart=always 10 | RestartSec=3 11 | Environment=PYTHONUNBUFFERED=1 12 | 13 | [Install] 14 | WantedBy=multi-user.target 15 | -------------------------------------------------------------------------------- /tzsp.netdev: -------------------------------------------------------------------------------- 1 | [NetDev] 2 | Name=tzsp0 3 | Kind=dummy 4 | -------------------------------------------------------------------------------- /tzsp.network: -------------------------------------------------------------------------------- 1 | [Match] 2 | Name=tzsp* 3 | 4 | [Link] 5 | MTUBytes=2000 6 | 7 | [Network] 8 | Address=192.168.254.10/24 9 | DHCP=no 10 | --------------------------------------------------------------------------------