├── LICENSE ├── Makefile ├── README.md ├── customrules ├── es.yml └── splunk.yml ├── dockerfiles └── suricata.dockerfile ├── dredd-cli ├── dredd ├── __init__.py ├── backends │ ├── __init__.py │ ├── base.py │ ├── docker.py │ ├── es.py │ └── suricata.py ├── cli │ ├── __init__.py │ ├── es.py │ └── suricata.py ├── rules │ ├── __init__.py │ ├── custom.py │ └── sigma.py └── utils │ ├── __init__.py │ └── common.py └── requirements.txt /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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | message="changes" 2 | 3 | bandit: 4 | bandit -q -s B112 -r ./dredd-cli dredd/ 5 | 6 | format: 7 | black -l 120 dredd-cli dredd/ 8 | 9 | update: 10 | git add . 11 | git commit -a -m "$(message)" 12 | git push 13 | 14 | push-master: bandit format update 15 | 16 | push: format update 17 | 18 | test: 19 | python -m unittest discover -v 20 | 21 | build-suricata: 22 | cat dockerfiles/suricata.dockerfile | docker build -t 2xxesra/suricata - 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Dredd : Automated Detection Rule Analysis 2 | 3 | Dredd primarily supports the process of evaluating [Sigma](https://github.com/Neo23x0/sigma) against [Mordor](https://github.com/hunters-forge/mordor) datasets. 4 | 5 | Dredd also supports the evaluation of IDS rules against packet captures. 6 | 7 | See the release blog post and video for more information: https://sra.io/blog/automated-detection-rule-analysis-with-dredd/ & https://youtu.be/FUxcKR-HaOM 8 | 9 | ## Supported Backends 10 | 11 | Currently, Dredd supports the following Sigma backend/configs (though extending it isn't terribly difficult): 12 | 13 | - Elasticsearch DSL + Winlogbeat 14 | 15 | For PCAP analysis, Dredd supports the following IDS backends: 16 | 17 | - Suricata 18 | 19 | ## Command-line Usage 20 | 21 | ### Elasticsearch 22 | 23 | ``` 24 | Usage: dredd-cli es [OPTIONS] 25 | 26 | Options: 27 | -r, --rules TEXT directory of rules [required] 28 | -f, --format [custom|sigma] rule format (default=sigma) 29 | -a, --archives TEXT directory of Mordor archives [required] 30 | -m, --merge evaluate rules against merged archives vs 31 | individually 32 | -i, --ignore-exit-code ignore the exit code and exit 0 33 | --help Show this message and exit. 34 | ``` 35 | 36 | **Merged Logs** 37 | 38 | Ingests all mordor data at once then evaluates each rule against the merged data 39 | 40 | ``` 41 | dredd-cli es -r /path/to/sigma/rules -a /path/to/mordor/data -m 42 | ``` 43 | 44 | 45 | Example output 46 | 47 | ``` 48 | { 49 | "skipped": [], 50 | "unsupported": [], 51 | "all": { 52 | "results": { 53 | "sigma/win_mmc20_lateral_movement.yml[0]": 0, 54 | "sigma/schtasks.yml[0]": 1 55 | }, 56 | "errors": [] 57 | } 58 | } 59 | ``` 60 | 61 | **Unmerged Logs** 62 | 63 | Ingests all mordor data at once then evaluates each rule against each dataset 64 | 65 | ``` 66 | dredd-cli es -r /path/to/sigma/rules -a /path/to/mordor/data 67 | ``` 68 | 69 | 70 | Example output 71 | 72 | ``` 73 | { 74 | "skipped": [], 75 | "unsupported": [], 76 | "mordor/covenant_dcsync_all.tar.gz": { 77 | "results": { 78 | "sigma/win_mmc20_lateral_movement.yml[0]": 0, 79 | "sigma/schtasks.yml[0]": 0 80 | }, 81 | "errors": [] 82 | }, 83 | "mordor/empire_userland_schtasks.tar.gz": { 84 | "results": { 85 | "sigma/win_mmc20_lateral_movement.yml[0]": 0, 86 | "sigma/schtasks.yml[0]": 1 87 | }, 88 | "errors": [] 89 | } 90 | } 91 | ``` 92 | 93 | **Custom Rule** 94 | 95 | Use an Elasticsearch DSL query against mordor data. 96 | See below for custom rule format 97 | 98 | ``` 99 | dredd-cli es -r /path/to/custom/rules -f custom -a /path/to/mordor/data -m 100 | ``` 101 | 102 | 103 | Example output 104 | 105 | ``` 106 | { 107 | "skipped": [ 108 | "Word + cmd", 109 | "Word + PowerShell" 110 | ], 111 | "unsupported": [], 112 | "all": { 113 | "results": { 114 | "Scheduled Task[0]": 1 115 | }, 116 | "errors": [] 117 | } 118 | } 119 | ``` 120 | 121 | **Note: Output** 122 | 123 | In Dredd output, rules have "\[#\]" appended to the rule path/name. 124 | This is primarily included to support Sigma rules with multiple detections since these translate to multiple queries. 125 | The number within the brackets indicate the query number within the rule (starting with 0). 126 | 127 | **Note: Skipped/Unsupported** 128 | 129 | Skipped and unsupported are both top-level keys in the results dict. 130 | Skipped rules are rules that are in-compatible with the backend. For example: supplying a Splunk rule to an ES backed). 131 | Unsupported rules are rules that use features not supported by the backend. For example: using "near" with an Elasticsearch backend. 132 | 133 | **Note: Log archives** 134 | 135 | This tool assumes imported log data is from a trusted source. Do not process untrusted data. 136 | 137 | ### Suricata 138 | 139 | ``` 140 | Usage: dredd-cli suricata [OPTIONS] 141 | 142 | Options: 143 | -r, --rules TEXT directory of rules [required] 144 | -p, --pcaps TEXT directory of PCAPs [required] 145 | -m, --merge evaluate rules against merged archives vs individually 146 | --help Show this message and exit. 147 | ``` 148 | 149 | **Merged Logs** 150 | 151 | Merges all rule files together then evaluates against all PCAPs at once 152 | 153 | ``` 154 | dredd-cli suricata -r /path/to/ids/rules -p /path/to/pcaps -m 155 | ``` 156 | 157 | Example output 158 | 159 | ``` 160 | { 161 | "all": { 162 | "ET NETBIOS DCERPC SVCCTL - Remote Service Control Manager Access": 10, 163 | "ET POLICY PsExec service created": 58, 164 | "ET USER_AGENTS WinRM User Agent Detected - Possible Lateral Movement": 73 165 | } 166 | } 167 | ``` 168 | 169 | **Unmerged Logs** 170 | 171 | Merges all rule files together then evaluates against each PCAP individually 172 | 173 | ``` 174 | dredd-cli suricata -r /path/to/ids/rules -p /path/to/pcaps 175 | ``` 176 | 177 | Example output 178 | 179 | ``` 180 | { 181 | "/home/ubuntu/pcaps/all/cap1.pcap": { 182 | "ET NETBIOS DCERPC SVCCTL - Remote Service Control Manager Access": 4, 183 | "ET USER_AGENTS WinRM User Agent Detected - Possible Lateral Movement": 16 184 | }, 185 | "/home/ubuntu/pcaps/all/cap2.cap": { 186 | "ET POLICY WinRM wsman Access - Possible Lateral Movement": 26, 187 | "ET USER_AGENTS WinRM User Agent Detected - Possible Lateral Movement": 26 188 | } 189 | } 190 | ``` 191 | 192 | **Note: Suricata container** 193 | 194 | Suricata rule analysis uses a custom container. 195 | The Dockerfile can be found [here](dockerfiles/suricata.dockerfile). 196 | The Docker Hub page can be found [here](https://hub.docker.com/r/securityriskadvisors/suricata). 197 | 198 | ## Custom Rules (Sigma only) 199 | 200 | Custom rules allow for the use of platform specific formats such as Splunk SPL and Elasticsearch DSL directly. 201 | 202 | The format for this is extremely simple YAML. There are three required fields: 203 | 204 | - name (string): rule name 205 | - backend (string): backend name (e.g "elasticsearch") 206 | - rule (string): the rule content 207 | 208 | You can also provide an optional dictionary of metadata as a field. 209 | 210 | **Example Splunk custom rule** 211 | 212 | ``` 213 | --- 214 | name: My rule 215 | backend: splunk 216 | metadata: 217 | foo: bar 218 | rule: | 219 | (index="windows" ParentImage="*\\winword.exe" Image="*\\cmd.exe") 220 | ``` 221 | 222 | These rules are used directly and not translated to different platforms. 223 | For example, if your custom rules include a Splunk query but Elasticsearch is in use, the rule will be skipped. 224 | Elasticsearch is currently the only supported Dredd backend so only Elasticsearch DSL custom rules will be processed 225 | 226 | ## Exit Codes (Sigma only) 227 | 228 | By default, Dredd will exit with an exit code of 1 if any of the rules have 0 hits against the logs. 229 | This can be ignored by specifying the "-i" option. "-i" will cause Dredd to always exit 0 (save for exceptions). 230 | 231 | ## Installation 232 | 233 | **Pre-requisites** 234 | 235 | - Python3 (virtualenv recommended) 236 | - Docker 237 | 238 | **Steps** 239 | 240 | ``` 241 | pip install -r requirements.txt 242 | ``` 243 | 244 | ## To-dos 245 | 246 | - fine-grained analysis configurations 247 | 248 | ## Changelog 249 | 250 | **8/25/2020** 251 | 252 | - initial commit 253 | -------------------------------------------------------------------------------- /customrules/es.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Scheduled Task 3 | backend: elasticsearch 4 | rule: | 5 | { 6 | "query": { 7 | "constant_score": { 8 | "filter": { 9 | "bool": { 10 | "must": [ 11 | { 12 | "match_phrase": { 13 | "winlog.channel": "Microsoft-Windows-Sysmon/Operational" 14 | } 15 | }, 16 | { 17 | "match_phrase": { 18 | "winlog.event_id": "1" 19 | } 20 | }, 21 | { 22 | "wildcard": { 23 | "winlog.event_data.Image.keyword": "*\\\\schtasks.exe" 24 | } 25 | } 26 | ] 27 | } 28 | } 29 | } 30 | } 31 | } -------------------------------------------------------------------------------- /customrules/splunk.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Word + cmd 3 | backend: splunk 4 | metadata: 5 | foo: bar 6 | rule: | 7 | (index="windows" ParentImage="*\\winword.exe" Image="*\\cmd.exe") 8 | --- 9 | name: Word + PowerShell 10 | backend: splunk 11 | metadata: 12 | foo: baz 13 | rule: | 14 | (index="windows" ParentImage="*\\winword.exe" Image="*\\powershell.exe") -------------------------------------------------------------------------------- /dockerfiles/suricata.dockerfile: -------------------------------------------------------------------------------- 1 | from ubuntu:20.04 2 | 3 | RUN apt update && \ 4 | apt-get install -y software-properties-common 5 | RUN add-apt-repository -y ppa:oisf/suricata-stable && \ 6 | apt-get update && \ 7 | apt-get install -y suricata 8 | RUN mkdir -p /var/lib/suricata/rules/ 9 | 10 | -------------------------------------------------------------------------------- /dredd-cli: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | from dredd.cli import cli 3 | 4 | 5 | if __name__ == "__main__": 6 | cli() 7 | -------------------------------------------------------------------------------- /dredd/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SecurityRiskAdvisors/dredd/479e1dc2917ac19d26e6743bb22277856ec459dc/dredd/__init__.py -------------------------------------------------------------------------------- /dredd/backends/__init__.py: -------------------------------------------------------------------------------- 1 | from .docker import docker_client 2 | from .es import DreddES 3 | from .suricata import DreddSuricata 4 | -------------------------------------------------------------------------------- /dredd/backends/base.py: -------------------------------------------------------------------------------- 1 | from .docker import docker_client 2 | 3 | 4 | class DreddBackend: 5 | def __init__(self, rule_directory: str, archive_directory: str, image: str = None, env: dict = None): 6 | self.rule_directory = rule_directory 7 | self.archive_directory = archive_directory 8 | self.image = image 9 | self.env = env 10 | self.index = "dredd" 11 | 12 | self.container = None # Docker container object 13 | 14 | def launch(self, pull: bool = False, **kwargs): 15 | """ 16 | launch container based on Backend's image property 17 | sets the container object to self.container 18 | :param pull: pull the image before running 19 | :param kwargs: kwargs for docker.containers.run 20 | """ 21 | if pull: 22 | docker_client.images.pull(self.image) # if exists, will just return image 23 | 24 | self.container = docker_client.containers.run( 25 | image=self.image, detach=True, environment=self.env, network_mode="host", remove=True, **kwargs 26 | ) 27 | 28 | def kill(self): 29 | """kill Backend's container""" 30 | self.container.kill() 31 | -------------------------------------------------------------------------------- /dredd/backends/docker.py: -------------------------------------------------------------------------------- 1 | import docker 2 | 3 | docker_client = docker.from_env() 4 | -------------------------------------------------------------------------------- /dredd/backends/es.py: -------------------------------------------------------------------------------- 1 | from dredd.rules import DreddESSigma, CustomRulesLoader 2 | from dredd.utils import glob_directory 3 | from .base import DreddBackend 4 | from elasticsearch import Elasticsearch 5 | from elasticsearch.helpers import bulk 6 | import tarfile 7 | import json 8 | 9 | 10 | class DreddES(DreddBackend): 11 | def __init__(self, rule_directory: str, archive_directory: str): 12 | super().__init__( 13 | rule_directory=rule_directory, 14 | archive_directory=archive_directory, 15 | image="elasticsearch:7.6.0", 16 | env={"discovery.type": "single-node"}, 17 | ) 18 | self.launch() 19 | self._wait_for_es() 20 | self.backend = Elasticsearch(hosts=["127.0.0.1:9200"]) # make the host/port configureable? 21 | self.backend.indices.create(self.index) 22 | 23 | def _wait_for_es(self): 24 | """loop over connecting to ES until it responds 25 | this is used after launching the container but before log ingestion to ensure connectivity""" 26 | while True: 27 | try: 28 | Elasticsearch(hosts=["127.0.0.1:9200"]).cluster.health() 29 | except Exception: 30 | continue 31 | else: 32 | break 33 | 34 | def evaluate(self, custom_rules: bool = False, merge_logs: bool = True, exitcheck: int = 0) -> tuple: 35 | """ 36 | Evaluate the rules against the datasets 37 | :param custom_rules: true/false whether using custom rules (true) or Sigma (false) 38 | :param merge_logs: true/false whether to ingest all logs into the same index or use one index per log set 39 | :param exitcheck: exit code criteria; 0 for exit 1 on no hits, 1 for exit 1 on any hits 40 | :return: tuple of the results dict and exit code 41 | """ 42 | 43 | # ES index names are a bit restrictive so rather than convert the archive name to a suitable format, 44 | # just store the index <-> archive relationship 45 | index_map = {} 46 | 47 | # load data into ES 48 | indices = [] 49 | index_ct = 1 50 | mordor_archives = glob_directory(directory=self.archive_directory, extensions=["tar.gz"]) 51 | if merge_logs: 52 | for mordor_archive in mordor_archives: 53 | self.ingest(archive=mordor_archive) 54 | indices.append(self.index) 55 | index_map[self.index] = "all" 56 | else: 57 | for mordor_archive in mordor_archives: 58 | index = f"{self.index}{index_ct}" 59 | self.ingest(archive=mordor_archive, index=index) 60 | indices.append(index) 61 | index_ct += 1 62 | index_map[index] = mordor_archive 63 | # sometimes need to refresh index after ingestion 64 | # https://elasticsearch-py.readthedocs.io/en/master/api.html#elasticsearch.client.IndicesClient.refresh 65 | # https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html 66 | self.backend.indices.refresh("") 67 | 68 | # result dict 69 | # skipped = rule doesnt support backend (e.g. supplying a Splunk rule to ES) 70 | # unsupported = Sigma rule uses feature not available in backend (e.g. using "near" with ES) 71 | results = {"skipped": [], "unsupported": []} 72 | 73 | # load rules 74 | rules = [] 75 | # TODO: should standardize on file name vs rule name in output 76 | # Dredd uses path for Sigma rules but name for custom rules 77 | # however, Sigma only provides one name for all queries whereas custom rules have one name per query 78 | if custom_rules: 79 | for rule in CustomRulesLoader.from_directory(directory=self.rule_directory): 80 | if rule.backend == "elasticsearch": 81 | rules.append((rule.name, [rule.rule])) 82 | else: 83 | results["skipped"].append(rule.name) 84 | else: 85 | for sigma in glob_directory(directory=self.rule_directory, extensions=["yaml", "yml"]): 86 | try: 87 | rule = DreddESSigma.sigma_to_query(sigma) 88 | rules.append((sigma, rule)) 89 | except NotImplementedError: 90 | results["unsupported"].append(sigma) 91 | 92 | # run queries 93 | exitres = 0 94 | for index in indices: 95 | result = {"results": {}, "errors": []} 96 | for rule in rules: 97 | q = 0 98 | for query in rule[1]: 99 | # each Sigma rule can contain multiple "detections" (queries). 100 | # Example: https://github.com/Neo23x0/sigma/blob/master/rules/windows/builtin/win_invoke_obfuscation_obfuscated_iex_services.yml 101 | # the qname gives an indication as to which detection had the result 102 | # ex: "win_rare_service_installs.yml[0] : 1" means the first detection in the Sigma rule had a hit 103 | qname = f"{rule[0]}[{q}]" 104 | try: 105 | hits = self.search(query=query, index=index) 106 | # exit checks 107 | # if 0 -> check if any results are 0 and return 1 if so 108 | # if 1 -> check if any results are >0 and return 1 if so 109 | if exitcheck == 0 and hits == 0: 110 | exitres = 1 111 | if exitcheck == 1 and hits > 0: 112 | exitres = 1 113 | result["results"][qname] = hits 114 | except: 115 | result["errors"].append(qname) 116 | q += 1 117 | archive = index_map[index] 118 | results[archive] = result.copy() 119 | 120 | # cleanup 121 | self.kill() 122 | 123 | # returns the dict of results + the exit code 124 | return results, exitres 125 | 126 | def ingest(self, archive: str, index: str = None): 127 | """ 128 | Load a log archive into the backend 129 | :param archive: the tar'd archive file 130 | :param index: the ES index to load the data into; defaults to Backend's index property 131 | """ 132 | index = self.index if index is None else index 133 | tarf = tarfile.open(archive) 134 | for member in tarf.getmembers(): 135 | if member.isfile(): 136 | logfile = f"{archive}/{member.name}" 137 | memberf = tarf.extractfile(member) 138 | 139 | # TODO: handle/log errors 140 | bulk( 141 | self.backend, normalize(mordor_file=memberf, logfile=logfile, index=index), raise_on_error=False, 142 | ) 143 | 144 | tarf.close() 145 | 146 | def reset_index(self, index: str = None): 147 | """ 148 | deletes then recreates an existing index 149 | :param index: the ES index to reset; defaults to Backend's index property 150 | """ 151 | index = self.index if not "index" else index 152 | if self.backend.indices.exists(index): 153 | self.backend.indices.delete(index) 154 | self.backend.indices.create(index) 155 | 156 | def search(self, query, index: str) -> int: 157 | """ 158 | perform a search against the Backend 159 | :param query: the query - as string or dict 160 | :param index: the ES index to search; defaults to Backend's index property 161 | :return: number of hits for the query 162 | """ 163 | index = self.index if not "index" else index 164 | res = self.backend.search(index=index, body=query) 165 | # maybe include some identifiers for document hits? 166 | # -> ES only returns 10 results by default 167 | # -> how to handle high # of hits 168 | return res["hits"]["total"]["value"] 169 | 170 | 171 | def normalize(mordor_file: str, logfile: str, index: str): 172 | # see: https://github.com/hunters-forge/mordor/blob/master/scripts/es-import.py 173 | for line in mordor_file: 174 | source = json.loads(line) 175 | source["log"] = {"file": {"name": logfile}} 176 | source.setdefault("winlog", dict()) 177 | 178 | if "EventID" in source: 179 | source["winlog"]["event_id"] = source["EventID"] 180 | del source["EventID"] 181 | 182 | try: 183 | del source["type"] 184 | except KeyError: 185 | pass 186 | 187 | try: 188 | del source["host"] 189 | except KeyError: 190 | pass 191 | 192 | source["winlog"]["event_data"] = { 193 | k: v 194 | for k, v in source.items() 195 | if k not in ("winlog", "log", "Channel", "Hostname", "@timestamp", "@version",) 196 | } 197 | 198 | for k in source["winlog"]["event_data"].keys(): 199 | del source[k] 200 | 201 | try: 202 | source["winlog"]["computer_name"] = source["Hostname"] 203 | del source["Hostname"] 204 | except KeyError: 205 | pass 206 | 207 | try: 208 | source["winlog"]["channel"] = source["Channel"] 209 | del source["Channel"] 210 | except KeyError: 211 | pass 212 | 213 | if "event_data" in source: 214 | source["winlog"]["event_data"] = source["event_data"] 215 | del source["event_data"] 216 | 217 | if "log_name" in source: 218 | source["winlog"]["channel"] = source["log_name"] 219 | del source["log_name"] 220 | 221 | try: 222 | if source["winlog"]["channel"] == "security": 223 | source["winlog"]["channel"] = "Security" 224 | except KeyError: 225 | pass 226 | 227 | if "event_id" in source: 228 | source["winlog"]["event_id"] = source["event_id"] 229 | del source["event_id"] 230 | 231 | source.setdefault("event", dict())["code"] = source["winlog"]["event_id"] 232 | 233 | yield {"_index": index, "_source": source} 234 | -------------------------------------------------------------------------------- /dredd/backends/suricata.py: -------------------------------------------------------------------------------- 1 | from .base import DreddBackend 2 | from dredd.utils import glob_directory 3 | import tempfile 4 | import tarfile 5 | import json 6 | import os 7 | 8 | 9 | class ExecRunException(Exception): 10 | """raised when Docker exec command exits with non-zero exit code""" 11 | 12 | pass 13 | 14 | 15 | class DreddSuricata(DreddBackend): 16 | def __init__(self, rule_directory: str, archive_directory: str, image: str = "securityriskadvisors/suricata"): 17 | super().__init__(rule_directory=rule_directory, archive_directory=archive_directory, image=image) 18 | self.mergedrulefile = "" 19 | self.ct_mounts = [] 20 | 21 | self.merge_rules() 22 | 23 | def merge_rules(self): 24 | """recursively get all .rule/.rules files in the rule directory then merge them into one file""" 25 | rule_files = glob_directory(directory=self.rule_directory, extensions=["rule", "rules"]) 26 | _, tmpf = tempfile.mkstemp(suffix=".rules", dir=self.rule_directory) 27 | with open(tmpf, "w") as mergedfile: 28 | for rule_file in rule_files: 29 | with open(rule_file) as f: 30 | mergedfile.write(f.read()) 31 | mergedfile.write("\n") 32 | 33 | self.mergedrulefile = tmpf 34 | 35 | def evaluate(self, merged: bool = True): 36 | """ 37 | Evaluate the rules against the datasets 38 | :param merged: true/false whether to ingest all logs into the same index or use one index per log set 39 | :return: the results dict 40 | """ 41 | if merged: 42 | pcap_files = [self.archive_directory] 43 | else: 44 | pcap_files = glob_directory(directory=self.archive_directory, extensions=["pcap", "cap"]) 45 | 46 | results = {} 47 | for pcap_file in pcap_files: 48 | # NOTE: will not work with tmpfs 49 | volumes = { 50 | self.mergedrulefile: {"bind": "/var/lib/suricata/rules/suricata.rules", "mode": "ro"}, 51 | os.path.abspath(pcap_file): {"bind": "/opt/pcaps", "mode": "ro"}, 52 | } 53 | self.launch(volumes=volumes, tty=True) 54 | exitcode, _ = self.container.exec_run(cmd="suricata -k none -r /opt/pcaps", workdir="/opt") 55 | if exitcode != 0: 56 | raise ExecRunException(f"command exited with {exitcode}") 57 | 58 | # pull back eve.json (is tar'd beforehand) and format as list of JSON 59 | bits, stats = self.container.get_archive("/opt/eve.json") 60 | eve_json = eve_to_json(eve=bits_to_eve(bits=bits)) 61 | 62 | # check for alerts 63 | res = summarize_eve_results(results=eve_json) 64 | if merged: 65 | results["all"] = res 66 | else: 67 | results[pcap_file] = res 68 | 69 | # kill container 70 | self.container.kill() 71 | 72 | # delete merged rules 73 | os.remove(self.mergedrulefile) 74 | return results 75 | 76 | 77 | def bits_to_eve(bits) -> list: 78 | """ 79 | convert the bits from the Docker client get_archive to a readable format 80 | :param bits: file bits 81 | :return: list of lines from file. each line is a JSON object as a string 82 | """ 83 | 84 | # write bits to tempfile 85 | _, tmpf = tempfile.mkstemp() 86 | with open(tmpf, "wb") as f: 87 | for chunk in bits: 88 | f.write(chunk) 89 | 90 | # untar tempfile and extract eve.json 91 | tarf = tarfile.open(tmpf) 92 | member = tarf.getmember("eve.json") 93 | memberf = tarf.extractfile(member) 94 | os.remove(tmpf) 95 | 96 | # convert to list of JSON results 97 | eve = memberf.read().decode().split("\n") 98 | 99 | return eve 100 | 101 | 102 | def eve_to_json(eve: list) -> list: 103 | """ 104 | convert a list of JSON strings to a list of dicts 105 | input is meant to be from bits_to_eve 106 | :param eve: list of JSON strings 107 | :return: list of dicts 108 | """ 109 | eve_json = [] 110 | for eve_line in eve: 111 | try: 112 | eve_json.append(json.loads(eve_line)) 113 | except json.decoder.JSONDecodeError: 114 | pass 115 | 116 | return eve_json 117 | 118 | 119 | def summarize_eve_results(results: list) -> dict: 120 | """ 121 | given an eve results list, summarize the outcomes to provide a count of hits for each rules 122 | :param results: eve dict list 123 | :return: dict where key is the rule name and value is the count of hits 124 | """ 125 | res = {} 126 | for entry in results: 127 | if entry["event_type"] == "alert": 128 | signature = entry["alert"]["signature"] 129 | if signature in res: 130 | res[signature] += 1 131 | else: 132 | res[signature] = 1 133 | 134 | return res 135 | -------------------------------------------------------------------------------- /dredd/cli/__init__.py: -------------------------------------------------------------------------------- 1 | from .es import es 2 | from .suricata import suricata 3 | import click 4 | 5 | # TODO: make --ignore a gloval option 6 | 7 | 8 | @click.group() 9 | def cli(): 10 | pass 11 | 12 | 13 | cli.add_command(es) 14 | cli.add_command(suricata) 15 | -------------------------------------------------------------------------------- /dredd/cli/es.py: -------------------------------------------------------------------------------- 1 | from dredd.backends import DreddES 2 | from dredd.utils import json_print 3 | import click 4 | import sys 5 | 6 | 7 | @click.command() 8 | @click.option( 9 | "-r", "--rules", help="directory of rules", required=True, 10 | ) 11 | @click.option( 12 | "-f", 13 | "--format", 14 | "rule_format", 15 | type=click.Choice(["custom", "sigma"], case_sensitive=False), 16 | default="sigma", 17 | help="rule format (default=sigma)", 18 | ) 19 | @click.option("-a", "--archives", help="directory of Mordor archives", required=True) 20 | @click.option( 21 | "-m", "--merge", help="evaluate rules against merged archives vs individually", is_flag=True, default=False 22 | ) # needs to be the inverse if intent is default = True 23 | @click.option( 24 | "-i", "--ignore-exit-code", "ignore", help="ignore the exit code and exit 0", is_flag=True, default=False, 25 | ) 26 | def es(rules: str, rule_format: str, archives: str, merge: bool, ignore: bool): 27 | dredd_es = DreddES(rule_directory=rules, archive_directory=archives) 28 | custom = True if rule_format == "custom" else False 29 | res, exitcode = dredd_es.evaluate(custom_rules=custom, merge_logs=merge) 30 | 31 | json_print(res) 32 | 33 | if not ignore: 34 | sys.exit(exitcode) 35 | else: 36 | sys.exit(0) 37 | -------------------------------------------------------------------------------- /dredd/cli/suricata.py: -------------------------------------------------------------------------------- 1 | from dredd.backends import DreddSuricata 2 | from dredd.utils import json_print 3 | import click 4 | import sys 5 | 6 | 7 | @click.command() 8 | @click.option( 9 | "-r", "--rules", help="directory of rules", required=True, 10 | ) 11 | @click.option("-p", "--pcaps", help="directory of PCAPs", required=True) 12 | @click.option( 13 | "-m", "--merge", help="evaluate rules against merged archives vs individually", is_flag=True, default=False 14 | ) 15 | def suricata(rules: str, pcaps: str, merge: bool): 16 | dredd_suricata = DreddSuricata(rule_directory=rules, archive_directory=pcaps) 17 | res = dredd_suricata.evaluate(merged=merge) 18 | 19 | json_print(res) 20 | -------------------------------------------------------------------------------- /dredd/rules/__init__.py: -------------------------------------------------------------------------------- 1 | from .sigma import DreddESSigma 2 | from .custom import CustomRulesLoader, PlatformRule 3 | -------------------------------------------------------------------------------- /dredd/rules/custom.py: -------------------------------------------------------------------------------- 1 | from dredd.utils import glob_directory 2 | from yaml import safe_load_all 3 | 4 | """ 5 | Cutstom rules format 6 | 7 | Required fields: 8 | - name (string) 9 | - backend (string) 10 | - rule (string) 11 | 12 | Optional fields 13 | - metadata (dict) 14 | 15 | Splunk example 16 | --- 17 | name: Rule name 18 | backend: splunk 19 | metadata: 20 | foo: bar 21 | rule: | 22 | (index="windows" ParentImage="*\\winword.exe" Image="*\\cmd.exe") 23 | 24 | The purpose of this rule format is to allow loading of platform specific rules 25 | """ 26 | 27 | 28 | class PlatformRule: 29 | # TODO: schema validation 30 | def __init__(self, backend: str, name: str, rule: str, metadata: dict = None): 31 | self.backend = backend 32 | self.name = name 33 | self.rule = rule 34 | self.metadata = metadata 35 | 36 | def __repr__(self): 37 | return "<{} ({})>".format(self.__class__.__name__, self.name) 38 | 39 | 40 | class CustomRulesLoader: 41 | @staticmethod 42 | def from_file(path: str) -> list: 43 | """loads a custom rule(s) from a file""" 44 | with open(path) as f: 45 | yamlstr = f.read() 46 | 47 | rules = safe_load_all(yamlstr) 48 | 49 | return [PlatformRule(**rule) for rule in rules] 50 | 51 | @staticmethod 52 | def from_directory(directory: str) -> list: 53 | """loads custom rules from a directory of files (only reads .yaml/.yml files)""" 54 | yamlfiles = glob_directory(directory=directory, extensions=["yaml", "yml"]) 55 | allrules = [] 56 | 57 | [allrules.extend(CustomRulesLoader.from_file(path=yamlfile)) for yamlfile in yamlfiles] 58 | 59 | return allrules 60 | -------------------------------------------------------------------------------- /dredd/rules/sigma.py: -------------------------------------------------------------------------------- 1 | from sigma.parser.collection import SigmaCollectionParser 2 | from sigma.configuration import SigmaConfigurationChain 3 | import sigma.backends.discovery as backends 4 | from sigma.config.collection import SigmaConfigurationManager 5 | import json 6 | 7 | 8 | class SigmaCommon: 9 | def __init__(self, backend: str, config: str): 10 | self.backend = backend 11 | self.config = config 12 | 13 | def sigma_to_query(self, sigma_file: str): 14 | """convert a Sigma rule file to query using the backend/config properties""" 15 | 16 | # initialize config manager to retrieve config 17 | scm = SigmaConfigurationManager() 18 | sigmaconfigs = SigmaConfigurationChain() 19 | sigmaconfig = scm.get(self.config) 20 | sigmaconfigs.append(sigmaconfig) 21 | 22 | # dynamically grab backend and pair to config 23 | backend_class = backends.getBackend(self.backend) 24 | backend = backend_class(sigmaconfigs) 25 | 26 | with open(sigma_file) as f: 27 | parser = SigmaCollectionParser(f, sigmaconfigs) 28 | parser.generate(backend) 29 | 30 | return json.loads(backend.finalize()) 31 | 32 | 33 | class DreddESSigma: 34 | @staticmethod 35 | def sigma_to_query(sigma_file: str, backend: str = "es-dsl", config: str = "winlogbeat") -> list: 36 | """ 37 | Convert a Sigma rule file to an Elasticserch query. 38 | Default behavior is to generate an ES DSL query with a Winlogbeat config 39 | :param sigma_file: path to the Sigma file 40 | :param backend: Sigma backend; defaults to "es-dsl" 41 | :param config: Sigma backend config; defaults to "winlogbeat" 42 | :return: list of queries (as dicts) 43 | """ 44 | 45 | queries = SigmaCommon(backend=backend, config=config).sigma_to_query(sigma_file=sigma_file) 46 | # Sigma allows rules to contain multiple detections, so converting the Sigma rule to the backend will return 47 | # either a single query as a dict or multiple queries in a list 48 | # this function standardizes on returning a list 49 | queries = [queries] if type(queries) == dict else queries 50 | return queries 51 | -------------------------------------------------------------------------------- /dredd/utils/__init__.py: -------------------------------------------------------------------------------- 1 | from .common import glob_directory, json_print 2 | -------------------------------------------------------------------------------- /dredd/utils/common.py: -------------------------------------------------------------------------------- 1 | import glob 2 | import json 3 | 4 | 5 | def _glob_ext(directory: str, extension: str) -> list: 6 | """recursively get all files of a certain extension in a directory""" 7 | return glob.glob(f"{directory}/**/*.{extension}", recursive=True) 8 | 9 | 10 | def glob_directory(directory: str, extensions: list) -> list: 11 | """recursively get all files of a certain extension in a directory""" 12 | files = [] 13 | for extension in extensions: 14 | files.extend(_glob_ext(directory=directory, extension=extension)) 15 | 16 | return files 17 | 18 | 19 | def json_print(toprint: dict, **kwargs): 20 | """convert a dict to string then print formatted""" 21 | print(json.dumps(toprint, indent=4, sort_keys=True, **kwargs)) 22 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | elasticsearch 2 | docker 3 | sigmatools 4 | click 5 | pyyaml --------------------------------------------------------------------------------