├── LICENSE ├── README.md ├── call-api-json.py ├── call-api.pl ├── call-api.py ├── cef ├── README.md └── shadowserver_cef_logger.py ├── elasticsearch ├── CHANGELOG.md ├── README.md ├── requirements.txt └── shadowserver_ecs_logger.py ├── report-manager.py └── splunk ├── README.md └── shadowserver_reports.spl /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 | # api_utils 2 | Sample programs to access the API 3 | 4 | ## call-api 5 | 6 | Here are two programs, one in Python and one in Perl to help with the execution and accessing the data through the API’s. 7 | 8 | For either of these programs to function, they expect a file called ~/.shadowserver.api to exist and to contain your API key and secret. As an example: 9 | 10 | ``` 11 | [api] 12 | key = <> 13 | secret = <> 14 | uri = https://transform.shadowserver.org/api2/ 15 | ``` 16 | 17 | If an error like this occurs, it means that the query is going through a lot of data and the timeout in the program should be increased: 18 | 19 | ``` 20 | $ ./call-api.py reports/query '{"report":"united-states", "date":"2020-10-27", "query":{"city":"ashburn"}, "limit":3}' pretty 21 | API Exception: The read operation timed out 22 | ``` 23 | 24 | Additional details can be found at https://github.com/The-Shadowserver-Foundation/api_utils/wiki. 25 | 26 | ## report-manager 27 | 28 | This program utilizes the reports API to maintain a file system tree with the option to send notifications when new reports are downloaded for processing. 29 | 30 | Queue options: 31 | 32 | - Apache Kafka 33 | - Redis 34 | - STOMP (ActiveMQ, RabbitMQ) 35 | 36 | Usage: `report-manager.py /path/to/config.ini [ days ]` 37 | 38 | The optional 'days' argument is the number of previous days to download reports for. The default is 2. 39 | 40 | Sample configuration file: 41 | 42 | ~~~ 43 | [reports] 44 | directory = /var/tmp/reports 45 | min_disk_free = 512 46 | notifier = none 47 | url_prefix = http://myserver/reports/ 48 | 49 | [stomp] 50 | server = 127.0.0.1 51 | port = 61613 52 | user = guest 53 | password = guest 54 | queue = /queue/mytest 55 | 56 | [redis] 57 | server = 127.0.0.1 58 | port = 6379 59 | ;password = guest 60 | queue = mytest 61 | 62 | [kafka] 63 | server = 127.0.0.1 64 | port = 9092 65 | queue = mytest 66 | ~~~ 67 | 68 | The [reports] section is required and must contain the 'directory' key. 69 | 70 | Settings: 71 | 72 | - directory : top level directory to store reports in 73 | - min_disk_free : minimum disk free in MB to attempt download (default 512) 74 | - notifier : specify a notification queue type [none, stomp, redis, or kafka] 75 | - url_prefix : URL prefix replacement for the top level directory for notification messages 76 | - reports : optional comma separated list of mailing list names you want to filter by 77 | - types : optional comma separated list of report types to filter by 78 | - exclude : optional comma separated list of report types to exclude 79 | 80 | If a 'notifier' is configured in the [reports] section, an additional section with a matching 81 | name is required. 82 | 83 | Settings: 84 | 85 | - server : server IP address or host name 86 | - port : server port 87 | - queue : queue identifier 88 | - user : user name (if required) 89 | - password : password (if required) 90 | 91 | 92 | The notification entry is a JSON object that contains a timestamp, report date, report type, and uri: 93 | 94 | ``` 95 | { 96 | "timestamp" : "2022-09-01 11:32:45", 97 | "report_date" : "2022-08-31", 98 | "report_type" : "scan_stun", 99 | "uri" : "http://myserver/reports/2022/08/31/2022-08-31-scan_stun_example_com-asn.csv" 100 | } 101 | ``` 102 | 103 | Example crontab to check for new downloads once per hour: 104 | 105 | 15 * * * * /opt/shadowserver/report-manager.py /opt/shadowserver/reports.ini 106 | 107 | -------------------------------------------------------------------------------- /call-api-json.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import sys 3 | import json 4 | import importlib 5 | api = importlib.import_module('call-api') 6 | 7 | if __name__ == '__main__': 8 | if len(sys.argv) < 3: 9 | sys.exit("Usage: call-api-json.py method /path/to/file.json") 10 | with open(sys.argv[2]) as fh: 11 | data = json.load(fh) 12 | result = api.api_call(sys.argv[1], data) 13 | if len(sys.argv) > 3 and sys.argv[3] == 'pretty': 14 | print(json.dumps(json.loads(result), indent=4)) 15 | else: 16 | print(result.decode('utf-8')) 17 | -------------------------------------------------------------------------------- /call-api.pl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env perl 2 | 3 | =head1 NAME 4 | 5 | call-api.pl : Shadowserver Foundation API Utility 6 | 7 | =head1 DESCRIPTION 8 | 9 | This script requires your API details to be stored in ~/.shadowserver.api 10 | with the following contents: 11 | 12 | -- 13 | [api] 14 | key = 123456798 15 | secret = MySecret 16 | uri = https://transform.shadowserver.org/api2/ 17 | -- 18 | 19 | This script may be called with two or three arguments: 20 | 21 | call-api.pl [pretty|binary] 22 | 23 | The request must be a valid JSON object. 24 | 25 | Simple usage: 26 | 27 | $ ./call-api.pl test/ping '{}' 28 | {"pong":"2020-10-26 23:06:37"} 29 | 30 | Pretty output: 31 | 32 | $ ./call-api.pl test/ping '{}' pretty 33 | { 34 | "pong": "2020-10-26 23:06:42" 35 | } 36 | 37 | =cut 38 | 39 | use Config::Simple; 40 | use JSON; 41 | use Digest::SHA qw(hmac_sha256_hex); 42 | use LWP::UserAgent; 43 | use HTTP::Request; 44 | use URI; 45 | use strict; 46 | 47 | my $config = eval { new Config::Simple($ENV{'HOME'} . "/.shadowserver.api") }; 48 | 49 | my $TIMEOUT = 45; 50 | 51 | 52 | =item api_call( $method, \%request ) 53 | 54 | Call the specified api method with a request dictionary. 55 | 56 | =cut 57 | sub api_call 58 | { 59 | my ($method, $request) = @_; 60 | 61 | my $url = $config->param("api.uri") . $method; 62 | 63 | $request->{'apikey'} = $config->param('api.key'); 64 | my $request_string = encode_json($request); 65 | my $hmac2 = hmac_sha256_hex($request_string, $config->param('api.secret')); 66 | 67 | my $ua = new LWP::UserAgent(); 68 | $ua->timeout($TIMEOUT); 69 | 70 | my $ua_request = new HTTP::Request('POST', $url, [ 'HMAC2' => $hmac2 ] ); 71 | $ua_request->content($request_string); 72 | my $response = $ua->request($ua_request); 73 | return $response->content; 74 | } 75 | 76 | unless (caller) # main 77 | { 78 | 79 | if (scalar @ARGV < 2) 80 | { 81 | print STDERR "Usage: call-api.pl method json [pretty|binary]\n"; 82 | exit(1); 83 | } 84 | 85 | my $api_request = eval { decode_json($ARGV[1]) }; 86 | if ($@) 87 | { 88 | print STDERR "JSON Exception: $@\n"; 89 | exit(1); 90 | } 91 | 92 | if (!defined($config) || $config->param('api.key') eq '') 93 | { 94 | print STDERR "Exception: api.key not defined in " . $ENV{'HOME'} 95 | . "/.shadowserver.api\n"; 96 | exit(1); 97 | } 98 | 99 | my $res = eval { api_call($ARGV[0], $api_request) }; 100 | if ($@) 101 | { 102 | print STDERR "API Exception: $@\n"; 103 | exit(1); 104 | } 105 | 106 | if (scalar @ARGV > 2) 107 | { 108 | if ($ARGV[2] eq "pretty") 109 | { 110 | eval { print to_json(decode_json($res), { pretty => 1}), "\n" }; 111 | exit(0) unless ($@); 112 | } 113 | elsif ($ARGV[2] eq "binary") 114 | { 115 | binmode(STDOUT); 116 | write(STDOUT, $res); 117 | exit(0); 118 | } 119 | else 120 | { 121 | die('Unknown option ' . $ARGV[2]); 122 | } 123 | } 124 | 125 | print $res, "\n"; 126 | } 127 | -------------------------------------------------------------------------------- /call-api.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | 4 | call-api.py : Shadowserver Foundation API Utility 5 | 6 | This script requires your API details to be stored in ~/.shadowserver.api 7 | with the following contents: 8 | 9 | -- 10 | [api] 11 | key = 123456798 12 | secret = MySecret 13 | uri = https://transform.shadowserver.org/api2/ 14 | -- 15 | 16 | This script may be called with two or three arguments: 17 | 18 | call-api.py [pretty|binary] 19 | 20 | The request must be a valid JSON object. 21 | 22 | Simple usage: 23 | 24 | $ ./call-api.py test/ping '{}' 25 | {"pong":"2020-10-26 23:06:37"} 26 | 27 | Pretty output: 28 | 29 | $ ./call-api.py test/ping '{}' pretty 30 | { 31 | "pong": "2020-10-26 23:06:42" 32 | } 33 | 34 | """ 35 | 36 | import os 37 | import sys 38 | import hmac 39 | import hashlib 40 | import json 41 | import configparser 42 | 43 | from urllib.request import urlopen, Request 44 | 45 | config = configparser.ConfigParser() 46 | config.read(os.environ['HOME'] + "/.shadowserver.api") 47 | 48 | TIMEOUT = 45 49 | 50 | 51 | def api_call(method, request): 52 | """ 53 | Call the specified api method with a request dictionary. 54 | 55 | """ 56 | 57 | url = config.get('api', 'uri') + method 58 | 59 | request['apikey'] = config.get('api', 'key') 60 | request_string = json.dumps(request) 61 | 62 | secret_bytes = bytes(str(config.get('api', 'secret')), 'utf-8') 63 | request_bytes = bytes(request_string, 'utf-8') 64 | 65 | hmac_generator = hmac.new(secret_bytes, request_bytes, hashlib.sha256) 66 | hmac2 = hmac_generator.hexdigest() 67 | 68 | ua_request = Request(url, data=request_bytes, headers={'HMAC2': hmac2}) 69 | response = urlopen(ua_request, timeout=TIMEOUT) 70 | 71 | return response.read() 72 | 73 | 74 | if __name__ == '__main__': 75 | 76 | if (len(sys.argv) < 3): 77 | exit("Usage: call-api.py method json [pretty|binary]") 78 | 79 | try: 80 | api_request = json.loads(sys.argv[2]) 81 | except Exception as e: 82 | exit("JSON Exception: " + format(e)) 83 | 84 | try: 85 | config.get('api', 'key') 86 | except configparser.NoSectionError: 87 | exit("Exception: " + os.environ['HOME'] + "/.shadowserver.api could " 88 | "not be found. Exiting.") 89 | 90 | try: 91 | res = api_call(sys.argv[1], api_request) 92 | except Exception as e: 93 | exit("API Exception: " + format(e)) 94 | 95 | if (len(sys.argv) > 3): 96 | if (sys.argv[3] == "pretty"): 97 | try: 98 | print(json.dumps(json.loads(res), indent=4)) 99 | except: 100 | print(res.decode('utf-8')) 101 | elif (sys.argv[3] == "binary"): 102 | os.write(1, res); 103 | else: 104 | exit("Unknown option " + sys.argv[3]) 105 | else: 106 | print(res.decode('utf-8')) 107 | 108 | -------------------------------------------------------------------------------- /cef/README.md: -------------------------------------------------------------------------------- 1 | # Shadowserver Reports in Common Event Format 2 | 3 | This is a CEF logging script for Shadowserver intelligence reports. 4 | 5 | The script is designed to run from cron and will download and log all events from available reports that have not yet been processed. 6 | 7 | The `shadowserver_cef_logger.py` script is run with the path to the config file: 8 | 9 | ``` 10 | $ python3 shadowserver_cef_logger.py config.ini 11 | ``` 12 | 13 | A dynamic mapping is used to map the report fields to the [Common Event Format](https://www.microfocus.com/documentation/arcsight/arcsight-smartconnectors-8.3/cef-implementation-standard/Content/CEF/Chapter%201%20What%20is%20CEF.htm) (CEF). The latest mapping will be published as reports are added or revised. 14 | 15 | With the `auto_update` option enabled, the script will check for the latest version. 16 | 17 | The mapping can be updated separately as follows: 18 | 19 | ``` 20 | $ python3 shadowserver_cef_logger.py config.ini update 21 | ``` 22 | 23 | ### Example config.ini: 24 | 25 | ``` 26 | [general] 27 | state_directory=/var/lib/cef/state 28 | apikey = 29 | secret = 30 | auto_update=true 31 | 32 | [device_id] 33 | facility=user 34 | types=device_id 35 | ``` 36 | 37 | The _general_ section contains settings common to all download groups. 38 | 39 | * state_directory : path used to store report and mapping details 40 | * apikey : your Shadowserver API key 41 | * secret : your Shadowserver API secret 42 | * auto_update : optional boolean flag to download the latest mapping at startup 43 | 44 | Each additional section defines one or more report directives. 45 | 46 | * facility : syslog facility to use for each message 47 | * types : optional comma separated list of report types to download 48 | * reports : optional comma separated list of mailing list names to query 49 | * device_event_class_id : optional value to use in each message 50 | 51 | -------------------------------------------------------------------------------- /cef/shadowserver_cef_logger.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # 3 | # Copyright 2023 The Shadowserver Foundation, Inc. 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"): you may 6 | # not use this file except in compliance with the License. You may obtain 7 | # a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 13 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 14 | # License for the specific language governing permissions and limitations 15 | # under the License. 16 | # 17 | 18 | import sys 19 | import os 20 | import json 21 | import hashlib 22 | import hmac 23 | import re 24 | import csv 25 | import time 26 | import syslog 27 | import configparser 28 | import logging 29 | from urllib.request import urlopen, urlretrieve, Request 30 | from datetime import datetime, timedelta, timezone 31 | 32 | 33 | MAPURL = 'https://interchange.shadowserver.org/cef/v1/map' 34 | APIROOT = 'https://transform.shadowserver.org/api2/' 35 | DLROOT = 'https://dl.shadowserver.org/' 36 | TIMEOUT = 45 37 | MAX_AGE = 86400 * 7 # 7 days 38 | 39 | 40 | def syslog_facility(name): 41 | """ 42 | Returns the log facility for the given name. 43 | Throws an exception if the name is not known. 44 | 45 | :param name: string 46 | """ 47 | ref = { 48 | 'kern': syslog.LOG_KERN, 49 | 'user': syslog.LOG_USER, 50 | 'mail': syslog.LOG_MAIL, 51 | 'daemon': syslog.LOG_DAEMON, 52 | 'auth': syslog.LOG_AUTH, 53 | 'lpr': syslog.LOG_LPR, 54 | 'news': syslog.LOG_NEWS, 55 | 'uucp': syslog.LOG_UUCP, 56 | 'cron': syslog.LOG_CRON, 57 | 'syslog': syslog.LOG_SYSLOG, 58 | 'local0': syslog.LOG_LOCAL0, 59 | 'local1': syslog.LOG_LOCAL1, 60 | 'local2': syslog.LOG_LOCAL2, 61 | 'local3': syslog.LOG_LOCAL3, 62 | 'local4': syslog.LOG_LOCAL4, 63 | 'local5': syslog.LOG_LOCAL5, 64 | 'local6': syslog.LOG_LOCAL6, 65 | 'local7': syslog.LOG_LOCAL7, 66 | } 67 | if name not in ref: 68 | raise ValueException("Facility %r is unkown." % (name)) 69 | return ref[name] 70 | 71 | 72 | def cef_severity(row): 73 | """ 74 | Returns the CEF severity value for the given row. 75 | 76 | :param row: dictionary 77 | """ 78 | ref = { 79 | 'info': '0', 80 | 'low': '1', 81 | 'medium': '5', 82 | 'high': '8', 83 | 'critical': '10', 84 | } 85 | level = ref['info'] 86 | if 'severity' in row and row['severity'] in ref: 87 | level = ref[row['severity']] 88 | return level 89 | 90 | 91 | class ShadowserverCEFLogger: 92 | """ 93 | Connects to the Shadowserver API to obtain and log reported events in Common Event Format. 94 | """ 95 | map_filename = 'map.json' 96 | 97 | def __init__(self, args): 98 | """ 99 | Initialize the logger. 100 | 101 | :param config_file: path to a configuration file 102 | """ 103 | if len(args) < 2: 104 | raise ValueError("Usage: %s /path/to/config.ini [ update ]" % (args[0])) 105 | if len(args) > 2: 106 | self.mode = args[2] 107 | else: 108 | self.mode = 'run' 109 | 110 | self.config = configparser.ConfigParser() 111 | self.config.read(args[1]) 112 | 113 | self.state_directory = self.config.get('general', 'state_directory') 114 | self.apikey = self.config.get('general', 'apikey') 115 | self.secret = self.config.get('general', 'secret') 116 | self.cef_version = '0' 117 | self.device_version = '1.0' 118 | 119 | if self.config.getboolean('general', 'auto_update'): 120 | self.update() 121 | 122 | map_path = os.path.join(self.state_directory, self.map_filename) 123 | with open(map_path) as fh: 124 | self.mapping = json.load(fh) 125 | 126 | def run(self): 127 | """ 128 | Stream all available events from reports not yet imported. 129 | 130 | :param inputs: an InputDefinition object 131 | :param event_writer: an EventWriter object 132 | """ 133 | if self.mode != 'run': 134 | return 135 | 136 | date = datetime.now(timezone.utc).date() 137 | begin = date - timedelta(2) 138 | date_str = f'{begin.isoformat()}:{date.isoformat()}' 139 | 140 | for input_name in self.config: 141 | input_item = self.config[input_name] 142 | if 'facility' not in input_item: 143 | continue 144 | syslog.openlog(logoption=syslog.LOG_PID, facility=syslog_facility(input_item['facility'])) 145 | types = None 146 | request = {'date': date_str} 147 | device_id = '100' 148 | if 'reports' in input_item: 149 | request['reports'] = input_item['reports'].split(',') 150 | if 'types' in input_item: 151 | types = input_item['types'].split(',') 152 | if 'device_event_class_id' in input_item: 153 | device_id = input_item['device_event_class_id'] 154 | 155 | # prepare input specific checkpoint directory 156 | name = os.path.basename(input_name) 157 | dst = os.path.join(self.state_directory, name) 158 | if not os.path.isdir(dst): 159 | os.mkdir(dst) 160 | 161 | # locate new reports 162 | reports = self._api_call('reports/list', request) 163 | if reports is not None: 164 | for report in reports: 165 | if types is not None: 166 | if report['type'] not in types: 167 | continue 168 | path = os.path.join(dst, report['file']) 169 | if not os.path.exists(path): 170 | if report['type'] not in self.mapping: 171 | print("WARN: No mapping defined for %r - skipping %r." 172 | % (report['type'], report['file'])) 173 | continue 174 | if self._download(report, path): 175 | self._stream_events(report, path, device_id) 176 | # truncate the file to conserve space 177 | fh = open(path, 'a') 178 | fh.truncate(0) 179 | fh.close() 180 | 181 | syslog.closelog() 182 | 183 | # expire old files 184 | for file in os.listdir(dst): 185 | path = os.path.join(dst, file) 186 | if os.path.isfile(path): 187 | fstat = os.stat(path) 188 | if time.time()-fstat.st_mtime > MAX_AGE: 189 | os.unlink(path) 190 | 191 | def update(self): 192 | """ 193 | Update the field mapping. 194 | """ 195 | map_tmp = os.path.join(self.state_directory, '.' + self.map_filename) 196 | map_path = os.path.join(self.state_directory, self.map_filename) 197 | 198 | status = False 199 | try: 200 | urlretrieve(MAPURL, map_tmp) 201 | if os.path.getsize(map_tmp) > 0: 202 | with open(map_tmp) as fh: 203 | mapping = json.load(fh) 204 | status = True 205 | except Exception as e: 206 | print("ERROR: Download failed: %s" % (str(e))) 207 | 208 | if status: 209 | print("INFO: Mapping downloaded successfully") 210 | os.rename(map_tmp, map_path) 211 | else: 212 | if os.path.isfile(map_tmp): 213 | os.unlink(map_tmp) 214 | 215 | return status 216 | 217 | def _stream_events(self, report, path, device_id): 218 | """ 219 | Import events from the specified report. 220 | 221 | :param report: dictionary 222 | :param path: string 223 | :param device_id: string 224 | """ 225 | count = 0 226 | with open(path, newline='') as csvfile: 227 | reader = csv.DictReader(csvfile) 228 | mapping = self.mapping[report['type']]['map'] 229 | for row in reader: 230 | count += 1 231 | parts = [] 232 | parts.append("CEF:%s|Shadowserver|Reports|%s|%s|%s|%s|start=%s" % 233 | (self.cef_version, self.device_version, device_id, report['type'], 234 | cef_severity(row), row['timestamp'].replace(' ', 'T'))) 235 | for field in row: 236 | value = row[field] 237 | if value != "": 238 | if field in mapping: 239 | # escape special characters 240 | value = value.replace("\\", "\\\\") 241 | value = value.replace("\n", "\\n") 242 | value = value.replace("\r", "\\r") 243 | value = value.replace("=", "\\=") 244 | 245 | cef = mapping[field] 246 | parts.append("%s=%s" % (cef, value)) 247 | if re.match('^(c6a|cfp|cn|cs|deviceCustomDate|flexDate|flexString)\d$', cef): 248 | parts.append("%sLabel:%s" % (cef, field)) 249 | syslog.syslog(" ".join(parts)) 250 | print("INFO: Processed %d events for %r" % (count, report['file'])) 251 | 252 | def _api_call(self, method, request): 253 | """ 254 | Call the specified api method with a request dictionary. 255 | 256 | :param method: string 257 | :param request: dictionary 258 | """ 259 | url = APIROOT + method 260 | 261 | request['apikey'] = self.apikey 262 | request_string = json.dumps(request) 263 | 264 | secret_bytes = bytes(str(self.secret), 'utf-8') 265 | request_bytes = bytes(request_string, 'utf-8') 266 | 267 | hmac_generator = hmac.new(secret_bytes, request_bytes, hashlib.sha256) 268 | hmac2 = hmac_generator.hexdigest() 269 | 270 | result = None 271 | response = None 272 | try: 273 | ua_request = Request(url, data=request_bytes, headers={'HMAC2': hmac2}) 274 | response = urlopen(ua_request, timeout=TIMEOUT) 275 | except Exception as e: 276 | raise ValueException("API Exception %" % format(e)) 277 | try: 278 | result = json.loads(response.read()) 279 | except Exception as e: 280 | raise ValueException("Exception: unable to parse output for {}: {}".format(request, format(e))) 281 | return result 282 | 283 | def _download(self, report, path): 284 | """ 285 | Download a report. Returns True on success. 286 | 287 | :param report: dictionary 288 | :param path: string 289 | """ 290 | status = False 291 | try: 292 | urlretrieve(DLROOT + report['id'], path) 293 | if os.path.getsize(path) > 0: 294 | status = True 295 | except Exception as e: 296 | print("ERROR: Download failed: %s" % (str(e))) 297 | os.unlink(path) 298 | return status 299 | 300 | 301 | if __name__ == "__main__": 302 | sys.exit(ShadowserverCEFLogger(sys.argv).run()) 303 | -------------------------------------------------------------------------------- /elasticsearch/CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ### 2025-02-11 2 | 3 | Update for issue #13: 4 | * added convert_timestamp function. 5 | 6 | ### 2024-09-27 7 | 8 | Enhancements: 9 | 10 | Each CSV report is now mapped to a corresponding ECS log file for improved visibility and management. 11 | 12 | The _log_ option is now expected to be a directory as shown in the README. 13 | 14 | -------------------------------------------------------------------------------- /elasticsearch/README.md: -------------------------------------------------------------------------------- 1 | # Shadowserver Reports for Elasticsearch 2 | 3 | This is an ECS logging script for Shadowserver intelligence reports. This works with the [Filebeat](https://www.elastic.co/beats/filebeat) shipper 4 | or a [Custom Logs integration](https://www.elastic.co/docs/current/integrations/log). 5 | 6 | The script is designed to run from cron (e.g. daily) and will download and log all events from available reports that have not yet been processed. 7 | 8 | The `shadowserver_ecs_logger.py` script is run with the path to the config file: 9 | 10 | ``` 11 | $ python3 shadowserver_ecs_logger.py config.ini 12 | ``` 13 | 14 | A dynamic mapping is used to map the report fields to the [Elastic Common Schema](https://www.elastic.co/guide/en/ecs) (ECS). The latest mapping will be published as reports are added or revised. 15 | 16 | With the `auto_update` option enabled, the script will check for the latest version. 17 | 18 | The mapping can be updated separately as follows: 19 | 20 | ``` 21 | $ python3 shadowserver_ecs_logger.py config.ini update 22 | ``` 23 | 24 | ### Example config.ini: 25 | 26 | ``` 27 | [general] 28 | state_directory=/var/lib/ecs/state 29 | apikey = 30 | secret = 31 | auto_update=true 32 | 33 | [device_id] 34 | types=device_id 35 | log=/var/lib/ecs/filebeat 36 | ``` 37 | 38 | The _general_ section contains settings common to all download groups. 39 | 40 | * state_directory : path used to store report and mapping details 41 | * apikey : your Shadowserver API key 42 | * secret : your Shadowserver API secret 43 | * auto_update : optional boolean flag to download the latest mapping at startup 44 | 45 | Each additional section defines one or more report directives. 46 | 47 | * types : optional comma separated list of report types to download 48 | * reports : optional comma separated list of mailing list names to query 49 | * log : path filebeat will read files from 50 | 51 | > The `state_directory` and `log` paths must exist and be writeable by the user setup to run the shadowserver_ecs_logger.py script as well as Filebeat or Elastic depending on your integration method. 52 | 53 | 54 | ### Example filebeat.yml 55 | 56 | ``` 57 | filebeat.inputs: 58 | 59 | - type: log 60 | id: shadowserver-feeds 61 | enabled: true 62 | paths: 63 | - /var/lib/ecs/filebeat/*.json 64 | json.keys_under_root: true 65 | json.overwrite_keys: true 66 | json.add_error_key: true 67 | json.expand_keys: true 68 | publisher_pipeline.disable_host: true 69 | harvester_limit: 8 70 | scan_frequency: 1m 71 | close_inactive: 5m 72 | ignore_older: 24h 73 | clean_inactive: 25h 74 | 75 | processors: 76 | - drop_fields: 77 | when: 78 | equals: 79 | input.type: "log" 80 | fields: 81 | - "agent.ephemeral_id" 82 | - "agent.hostname" 83 | - "agent.name" 84 | - "agent.id" 85 | - "agent.type" 86 | - "agent.version" 87 | - "ecs.version" 88 | - "input.type" 89 | - "process.name" 90 | - "process.pid" 91 | - "process.thread.id" 92 | - "process.thread.name" 93 | - "log.original" 94 | - "log.offset" 95 | - "log.level" 96 | - "log.origin.function" 97 | - "log.origin.file.name" 98 | - "log.origin.file.line" 99 | - "log.logger" 100 | - "log.file.path" 101 | 102 | setup.template.settings: 103 | index.number_of_shards: 1 104 | 105 | setup.template: 106 | name: "filebeat" 107 | pattern: "filebeat" 108 | 109 | setup.kibana: 110 | host: "http://127.0.0.1:5601" 111 | ssl.verification_mode: none 112 | 113 | output.elasticsearch: 114 | # Array of hosts to connect to. 115 | hosts: ["https://127.0.0.1:9200"] 116 | ssl.certificate_authorities: ["/opt/elasticsearch/config/certs/http_ca.crt"] 117 | 118 | # Index by report type and month 119 | index: "shadowserver-%{[data_stream.dataset]}-%{+yyyy-MM}" 120 | 121 | # Authentication credentials - either API key or username/password. 122 | #api_key: "beats:OXlsZmQ0b0JnLUTPwjbKCtrtRG06R2tXaUdxdmdURTJLa0Ytdk1Ya1pXdw==" 123 | username: "elastic" 124 | password: "YvInisCyhKtwpCkFY2F+" 125 | 126 | ``` 127 | 128 | As a default, filebeat will add all new fields it encounters to the index mapping. Please coordinate with your Elastic administrator to determine how the data should be indexed for your organization. 129 | 130 | 131 | ### Custom Logs integration 132 | 133 | Select _Change defaults_ and _Advanced options_ to fine tune the integration. 134 | 135 | The `drop_fields` settings from the filebeat example can be entered in the _Processors_ area. 136 | 137 | ``` 138 | - drop_fields: 139 | when: 140 | equals: 141 | input.type: "log" 142 | fields: 143 | - "agent.ephemeral_id" 144 | - "agent.hostname" 145 | - "agent.name" 146 | - "agent.id" 147 | - "agent.type" 148 | - "agent.version" 149 | - "ecs.version" 150 | - "input.type" 151 | - "process.name" 152 | - "process.pid" 153 | - "process.thread.id" 154 | - "process.thread.name" 155 | - "log.original" 156 | - "log.offset" 157 | - "log.level" 158 | - "log.origin.function" 159 | - "log.origin.file.name" 160 | - "log.origin.file.line" 161 | - "log.logger" 162 | - "log.file.path" 163 | ``` 164 | 165 | The top level `json` settings from the filebeat example can be entered in the _Custom configurations_ area. 166 | 167 | ``` 168 | json.keys_under_root: true 169 | json.overwrite_keys: true 170 | json.add_error_key: true 171 | json.expand_keys: true 172 | ``` 173 | -------------------------------------------------------------------------------- /elasticsearch/requirements.txt: -------------------------------------------------------------------------------- 1 | ecs_logging==2.2.0 2 | python_dateutil==2.9.0 3 | -------------------------------------------------------------------------------- /elasticsearch/shadowserver_ecs_logger.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # 3 | # Copyright 2023-2025 The Shadowserver Foundation, Inc. 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"): you may 6 | # not use this file except in compliance with the License. You may obtain 7 | # a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 13 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 14 | # License for the specific language governing permissions and limitations 15 | # under the License. 16 | # 17 | 18 | import sys 19 | import os 20 | import json 21 | import hashlib 22 | import hmac 23 | import re 24 | import csv 25 | import time 26 | import syslog 27 | import configparser 28 | import logging 29 | import ecs_logging 30 | from urllib.request import urlopen, urlretrieve, Request 31 | from datetime import datetime, timedelta, timezone 32 | import dateutil.parser 33 | 34 | MAPURL = 'https://interchange.shadowserver.org/elasticsearch/v1/map' 35 | APIROOT = 'https://transform.shadowserver.org/api2/' 36 | DLROOT = 'https://dl.shadowserver.org/' 37 | TIMEOUT = 45 38 | MAX_AGE = 86400 * 7 # 7 days 39 | 40 | 41 | def set_timestamp(event, field, value): 42 | """ 43 | Convert timestamp to isoformat. 44 | 45 | param event: An event dictionary 46 | param field: The source field name 47 | param value: The source field value 48 | """ 49 | event['timestamp'] = value.replace(' ', 'T')+'Z' 50 | 51 | 52 | def set_tags(event, field, value): 53 | """ 54 | Split tag values into a list. 55 | 56 | param event: An event dictionary 57 | param field: The source field name 58 | param value: The source field value 59 | """ 60 | event['tags'] = re.split('[,;]', value) 61 | 62 | 63 | def set_labels(event, field, value, args): 64 | """ 65 | Add a named label from a field value. 66 | 67 | param event: An event dictionary 68 | param field: The source field name 69 | param value: The source field value 70 | param args: A list of arguments 71 | """ 72 | if 'labels' not in event: 73 | event['labels'] = {} 74 | try: 75 | event['labels'][args[0]] = value 76 | except Exception: 77 | pass 78 | 79 | def convert_timestamp(event, field, value, args): 80 | """ 81 | Convert timestamp to isoformat. 82 | 83 | param event: An event dictionary 84 | param field: The source field name 85 | param value: The source field value 86 | param args: A list of field(s) to set 87 | """ 88 | try: 89 | date = dateutil.parser.parse(value, fuzzy=True) 90 | if not date.tzinfo: 91 | date = date.replace(tzinfo=timezone.utc) 92 | else: 93 | date = date.astimezone(timezone.utc) 94 | value = date.isoformat() 95 | for arg in args: 96 | event[arg] = value 97 | except Exception as e: 98 | pass 99 | 100 | class ECSFormatter(ecs_logging.StdlibFormatter): 101 | """ 102 | Work-around for "Type mismatch at key `@timestamp`: merging dicts". 103 | """ 104 | 105 | def format_to_ecs(self, record): 106 | result = super().format_to_ecs(record) 107 | del result['message'] # remove empty element 108 | result['@timestamp'] = result.pop('timestamp') 109 | return result 110 | 111 | 112 | class ShadowserverECSLogger: 113 | """ 114 | Connects to the Shadowserver API to obtain and stream reported events. 115 | """ 116 | functions = { 117 | 'timestamp': set_timestamp, 118 | 'labels': set_labels, 119 | 'tags': set_tags, 120 | 'convert_timestamp': convert_timestamp, 121 | } 122 | map_filename = 'map.json' 123 | 124 | def __init__(self, args): 125 | """ 126 | Initialize the logger. 127 | 128 | :param config_file: path to a configuration file 129 | """ 130 | if len(args) < 2: 131 | raise ValueError("Usage: %s /path/to/config.ini [ update ]" % (args[0])) 132 | if len(args) > 2: 133 | self.mode = args[2] 134 | else: 135 | self.mode = 'run' 136 | 137 | self.config = configparser.ConfigParser() 138 | self.config.read(args[1]) 139 | 140 | self.state_directory = self.config.get('general', 'state_directory') 141 | self.apikey = self.config.get('general', 'apikey') 142 | self.secret = self.config.get('general', 'secret') 143 | self.logger = logging.getLogger('app') 144 | self.logger.setLevel(logging.DEBUG) 145 | 146 | if not os.path.isdir(self.state_directory): 147 | raise ValueError('general.state_directory %r does not exist' 148 | % (self.state_directory)) 149 | 150 | if self.config.getboolean('general', 'auto_update'): 151 | self.update() 152 | 153 | map_path = os.path.join(self.state_directory, self.map_filename) 154 | with open(map_path) as fh: 155 | self.mapping = json.load(fh) 156 | 157 | def run(self): 158 | """ 159 | Stream all available events from reports not yet imported. 160 | 161 | :param inputs: an InputDefinition object 162 | :param event_writer: an EventWriter object 163 | """ 164 | if self.mode != 'run': 165 | return 166 | 167 | date = datetime.now(timezone.utc).date() 168 | begin = date - timedelta(2) 169 | date_str = f'{begin.isoformat()}:{date.isoformat()}' 170 | 171 | for input_name in self.config: 172 | input_item = self.config[input_name] 173 | if 'log' not in input_item: 174 | continue 175 | if not os.path.isdir(input_item['log']): 176 | print("ERROR: log must be a directory for %r" % (input_name)) 177 | exit(1) 178 | 179 | types = None 180 | request = {'date': date_str} 181 | if 'reports' in input_item: 182 | request['reports'] = input_item['reports'].split(',') 183 | if 'types' in input_item: 184 | types = input_item['types'].split(',') 185 | 186 | # prepare input specific checkpoint directory 187 | name = os.path.basename(input_name) 188 | dst = os.path.join(self.state_directory, name) 189 | if not os.path.isdir(dst): 190 | os.mkdir(dst) 191 | 192 | # locate new reports 193 | reports = self._api_call('reports/list', request) 194 | if reports is not None: 195 | for report in reports: 196 | if types is not None: 197 | if report['type'] not in types: 198 | continue 199 | path = os.path.join(dst, report['file']) 200 | if not os.path.exists(path): 201 | if self._download(report, path): 202 | self._stream_events(input_item['log'], report, path) 203 | # truncate the file to conserve space 204 | fh = open(path, 'a') 205 | fh.truncate(0) 206 | fh.close() 207 | 208 | # expire old files 209 | for file in os.listdir(dst): 210 | path = os.path.join(dst, file) 211 | if os.path.isfile(path): 212 | fstat = os.stat(path) 213 | if time.time()-fstat.st_mtime > MAX_AGE: 214 | os.unlink(path) 215 | 216 | def update(self): 217 | """ 218 | Update the field mapping. 219 | """ 220 | map_tmp = os.path.join(self.state_directory, '.' + self.map_filename) 221 | map_path = os.path.join(self.state_directory, self.map_filename) 222 | 223 | status = False 224 | try: 225 | urlretrieve(MAPURL, map_tmp) 226 | if os.path.getsize(map_tmp) > 0: 227 | with open(map_tmp) as fh: 228 | mapping = json.load(fh) 229 | status = True 230 | except Exception as e: 231 | print("ERROR: Download failed: %s" % (str(e))) 232 | 233 | if status: 234 | print("INFO: Mapping downloaded successfully") 235 | os.rename(map_tmp, map_path) 236 | else: 237 | if os.path.isfile(map_tmp): 238 | os.unlink(map_tmp) 239 | 240 | return status 241 | 242 | def _stream_events(self, log, report, path): 243 | """ 244 | Import events from the specified report. 245 | 246 | :param logger: a Logger object 247 | :param report: a dictonary 248 | :param path: string 249 | """ 250 | 251 | logfile = os.path.join(log, re.sub('.csv$', '.json', os.path.basename(path))) 252 | handler = logging.FileHandler(logfile) 253 | handler.setFormatter(ECSFormatter()) 254 | self.logger.addHandler(handler) 255 | 256 | count = 0 257 | with open(path, newline='') as csvfile: 258 | reader = csv.DictReader(csvfile) 259 | for row in reader: 260 | event = {} 261 | count += 1 262 | for field in row: 263 | mapped = ".".join(['extra', field]) 264 | value = row[field] 265 | name = ".".join([report['type'], field]) 266 | if value != "": 267 | if name in self.mapping['map']: 268 | mapped = self.mapping['map'][name] 269 | if field in self.mapping['map']: 270 | mapped = self.mapping['map'][field] 271 | m = re.match("^\&([^\(]+)\(([^\)]+)\)", mapped) 272 | if m: 273 | func = m.groups()[0] 274 | args = m.groups()[1].split(',') 275 | if func in self.functions: 276 | self.functions[func](event, field, value, args) 277 | continue 278 | m = re.match("^\&([^\(]+)", mapped) 279 | if m: 280 | func = m.groups()[0] 281 | if func in self.functions: 282 | self.functions[func](event, field, value) 283 | continue 284 | event[mapped] = value 285 | event['data_stream.dataset'] = report['type'] 286 | self.logger.info('', extra=event) 287 | 288 | self.logger.removeHandler(handler) 289 | print("INFO: Processed %d events for %r" % (count, report['file'])) 290 | 291 | def _api_call(self, method, request): 292 | """ 293 | Call the specified api method with a request dictionary. 294 | 295 | :param method: string 296 | :param request: dictionary 297 | """ 298 | url = APIROOT + method 299 | 300 | request['apikey'] = self.apikey 301 | request_string = json.dumps(request) 302 | 303 | secret_bytes = bytes(str(self.secret), 'utf-8') 304 | request_bytes = bytes(request_string, 'utf-8') 305 | 306 | hmac_generator = hmac.new(secret_bytes, request_bytes, hashlib.sha256) 307 | hmac2 = hmac_generator.hexdigest() 308 | 309 | result = None 310 | response = None 311 | try: 312 | ua_request = Request(url, data=request_bytes, headers={'HMAC2': hmac2}) 313 | response = urlopen(ua_request, timeout=TIMEOUT) 314 | except Exception as e: 315 | raise ValueException("API Exception %" % format(e)) 316 | try: 317 | result = json.loads(response.read()) 318 | except Exception as e: 319 | raise ValueException("Exception: unable to parse output for {}: {}".format(request, format(e))) 320 | return result 321 | 322 | def _download(self, report, path): 323 | """ 324 | Download a report. Returns True on success. 325 | 326 | :param report: dictionary 327 | :param path: string 328 | """ 329 | status = False 330 | try: 331 | urlretrieve(DLROOT + report['id'], path) 332 | if os.path.getsize(path) > 0: 333 | status = True 334 | except Exception as e: 335 | print("ERROR: Download failed: %s" % (str(e))) 336 | if os.path.exists(path): 337 | os.unlink(path) 338 | return status 339 | 340 | 341 | if __name__ == "__main__": 342 | sys.exit(ShadowserverECSLogger(sys.argv).run()) 343 | -------------------------------------------------------------------------------- /report-manager.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | 4 | report-manager.py : Shadowserver Foundation Report Utility 5 | 6 | Usage: report-manager.py /path/to/config.ini [ days ] 7 | 8 | The optional 'days' argument is the number of previous days to download reports for. The 9 | default is 2. 10 | 11 | Sample configuration file: 12 | 13 | ~~~ 14 | [reports] 15 | directory = /var/tmp/reports 16 | min_disk_free = 512 17 | notifier = none 18 | url_prefix = http://myserver/reports/ 19 | 20 | [stomp] 21 | server = 127.0.0.1 22 | port = 61613 23 | user = guest 24 | password = guest 25 | queue = /queue/mytest 26 | 27 | [redis] 28 | server = 127.0.0.1 29 | port = 6379 30 | ;password = guest 31 | queue = mytest 32 | 33 | [kafka] 34 | server = 127.0.0.1 35 | port = 9092 36 | queue = mytest 37 | ~~~ 38 | 39 | The [reports] section is required and must contain the 'directory' key. 40 | 41 | Settings: 42 | directory : top level directory to store reports in 43 | min_disk_free : minimum disk free in MB to attempt download (default 512) 44 | notifier : specify a notification queue type [none, stomp, redis, or kafka] 45 | url_prefix : URL prefix replacement for the top level directory for notification messages 46 | reports : optional comma separated list of mailing list names you want to filter by 47 | types : optional list of report types to filter by 48 | type : optional report type to filter by (deprecated) 49 | exclude : optional comma separated list of report types to exclude 50 | 51 | If a 'notifier' is configured in the [reports] section, an additional section with a matching 52 | name is required. 53 | 54 | Settings: 55 | server : server IP address or host name 56 | port : server port 57 | queue : queue identifier 58 | user : user name (if required) 59 | password : password (if required) 60 | 61 | The notification entry is a JSON object that contains a timestamp, report date, report type, and uri: 62 | 63 | ``` 64 | { 65 | "timestamp" : "2022-09-01 11:32:45", 66 | "report_date" : "2022-08-31", 67 | "report_type" : "scan_stun", 68 | "uri" : "http://myserver/reports/2022/08/31/2022-08-31-scan_stun_example_com-asn.csv" 69 | } 70 | ``` 71 | 72 | Example crontab to check for new reports once per hour: 73 | 74 | 15 * * * * /opt/shadowserver/report-manager.py /opt/shadowserver/reports.ini 75 | 76 | """ 77 | 78 | import os 79 | import sys 80 | import json 81 | import syslog 82 | import configparser 83 | import importlib 84 | import shutil 85 | from datetime import datetime, timedelta, timezone 86 | from urllib.request import urlretrieve, urljoin, pathname2url 87 | api = importlib.import_module('call-api') 88 | 89 | class StompNotifier: 90 | """Notification class for the STOMP protocol. """ 91 | def __init__(self, settings): 92 | import stomp # pip3 install stomp.py 93 | 94 | self.queue = settings['queue'] 95 | self.stomp = stomp.Connection([(settings['server'], settings['port'])]) 96 | if settings.get('username') and settings.get('password'): 97 | self.stomp.connect(settings['username'], settings['password'], wait=True) 98 | else: 99 | self.stomp.connect(wait=True) 100 | 101 | def notify(self, message): 102 | self.stomp.send(destination=self.queue, body=message) 103 | 104 | class RedisNotifier: 105 | """Notification class for Redis.""" 106 | def __init__(self, settings): 107 | import redis # pip3 install redis 108 | 109 | self.queue = settings['queue'] 110 | if settings.get('password'): 111 | self.redis = redis.Redis(host=settings['server'], port=settings['port'], password=settings['password']) 112 | else: 113 | self.redis = redis.Redis(host=settings['server'], port=settings['port']) 114 | 115 | def notify(self, message): 116 | self.redis.rpush(self.queue, message) 117 | 118 | class KafkaNotifier: 119 | """Notification class for Kafka.""" 120 | def __init__(self, settings): 121 | from kafka import KafkaProducer # pip3 install kafka 122 | 123 | self.queue = settings['queue'] 124 | self.kafka = KafkaProducer(bootstrap_servers="{}:{}".format(settings['server'], settings['port'])) 125 | 126 | def notify(self, message): 127 | self.kafka.send(self.queue, bytes(message, 'utf-8')) 128 | 129 | class ReportManager: 130 | """Report manager implementation.""" 131 | 132 | def __init__(self, config_file): 133 | """Constructor 134 | 135 | Args: 136 | config_file (str) : Path to the configuration file 137 | """ 138 | config = configparser.ConfigParser() 139 | config.read(config_file) 140 | 141 | self.notifier = None 142 | self.basedir = config.get('reports', 'directory') 143 | self.threshold = int(config.get('reports', 'min_disk_free', fallback=512)) * 1024 * 1024 144 | self.url_prefix = config.get('reports', 'url_prefix', fallback=None) 145 | self.reports = config.get('reports', 'reports', fallback=None) 146 | self.types = [] 147 | self.exclude = [] 148 | exclude = config.get('reports', 'exclude', fallback=None) 149 | if not exclude is None: 150 | self.exclude = exclude.split(',') 151 | self.count = 0 152 | 153 | for k in ['type', 'types']: 154 | v = config.get('reports', k, fallback=None) 155 | if not v is None: 156 | self.types.extend(v.split(',')) 157 | 158 | mkdir(self.basedir) 159 | 160 | queue = config.get('reports', 'notifier', fallback='none') 161 | try: 162 | if queue == 'none': 163 | pass 164 | elif queue == 'stomp': 165 | self.notifier = StompNotifier(dict(config.items(queue))) 166 | elif queue == 'redis': 167 | self.notifier = RedisNotifier(dict(config.items(queue))) 168 | elif queue == 'kafka': 169 | self.notifier = KafkaNotifier(dict(config.items(queue))) 170 | else: 171 | raise Exception('Unknown type') 172 | except Exception as e: 173 | die("Exception: failed to initialize '{}' notifier - {}".format(queue, format(e))) 174 | 175 | def run(self, days=2): 176 | """Runs the report manager. 177 | 178 | Args: 179 | days (int) : Number of previous days to process 180 | 181 | Returns: 182 | nothing 183 | """ 184 | for i in reversed(range(1,days+1)): 185 | dt = datetime.now(timezone.utc) - timedelta(days=i) 186 | self._sync(dt.strftime("%Y-%m-%d")) 187 | syslog.syslog(F"Completed - {self.count} reports downloaded") 188 | 189 | def _notify(self, report, filename): 190 | """Send a notification message. 191 | 192 | Args: 193 | report (dict) : Report details from the API 194 | filename (str) : Path to the report file 195 | 196 | Returns: 197 | nothing 198 | """ 199 | if not self.url_prefix is None: 200 | path = filename.replace(self.basedir+os.path.sep, '') 201 | uri = urljoin(self.url_prefix, pathname2url(path)) 202 | else: 203 | uri = filename 204 | dt = datetime.now(timezone.utc) 205 | msg = json.dumps({ 206 | 'timestamp': dt.strftime("%Y-%m-%d %H:%M:%S"), 207 | 'report_date': report['timestamp'], 208 | 'report_type': report['type'], 209 | 'uri': uri, 210 | }) 211 | self.notifier.notify(msg) 212 | 213 | def _download(self, report, directory): 214 | """Download a report to the specified directory. 215 | 216 | Args: 217 | report (dict) : Report details from the API 218 | directory (str) : Directory to store the report in 219 | 220 | Returns: 221 | nothing 222 | """ 223 | tmp = os.path.join(directory, "." + report['file']) 224 | dst = os.path.join(directory, report['file']) 225 | if not os.path.exists(dst): 226 | try: 227 | urlretrieve('https://dl.shadowserver.org/' + report['id'], tmp) 228 | if os.path.getsize(tmp) > 0: 229 | os.rename(tmp, dst) 230 | self.count += 1 231 | if not self.notifier is None: 232 | self._notify(report, dst) 233 | except Exception as e: 234 | syslog.syslog("Exception: unable to download {} - {}".format(report['file'], format(e))) 235 | 236 | def _sync(self, date): 237 | """Store reports in a tree structure (year/month/day). 238 | 239 | Args: 240 | date (str) : Date to obtain reports for ("YYYY-MM-DD") 241 | 242 | Returns: 243 | nothing 244 | """ 245 | # make tree folders as needed 246 | directory = self.basedir 247 | for folder in (date[0:4], date[5:7], date[8:10]): 248 | directory = os.path.join(directory, folder) 249 | mkdir(directory) 250 | 251 | # obtain report list 252 | query = { 'date':date } 253 | if self.reports is not None: 254 | query['reports'] = self.reports.split(',') 255 | if len(self.types): 256 | query['types'] = self.types 257 | 258 | try: 259 | result = api.api_call('reports/list', query) 260 | except Exception as e: 261 | die("API Exception: " + format(e)) 262 | try: 263 | reports = json.loads(result) 264 | except Exception as e: 265 | die("Exception: unable to parse output for reports/list {} - {}".format(date, format(e))) 266 | 267 | # download reports 268 | for report in reports: 269 | status = list(shutil.disk_usage(directory)) 270 | if status[2] < self.threshold: 271 | die("Exception: insufficient disk space") 272 | if not report['type'] in self.exclude: 273 | self._download(report, directory) 274 | 275 | def die(message): 276 | """Log and exit with a message." 277 | 278 | Args: 279 | message (str) : Message text 280 | 281 | Returns: 282 | nothing 283 | """ 284 | syslog.syslog(message) 285 | sys.exit(message) 286 | 287 | def mkdir(path): 288 | """Create a directory if it does not already exist. Dies on failure. 289 | 290 | Args: 291 | path (str) : Directory path to create 292 | 293 | Returns: 294 | nothing 295 | """ 296 | if not os.path.isdir(path): 297 | try: 298 | os.mkdir(path) 299 | except: 300 | die("Exception: unable to create directory '" + path + "'") 301 | return True 302 | 303 | if __name__ == '__main__': 304 | def main(): 305 | if len(sys.argv) < 2: 306 | sys.exit("Usage: report_manager.py /path/to/config.ini") 307 | 308 | if len(sys.argv) > 2: 309 | days = int(sys.argv[2]) 310 | else: 311 | days = 2 312 | 313 | syslog.openlog("report_manager.py " + os.path.basename(sys.argv[1])) 314 | manager = ReportManager(sys.argv[1]) 315 | manager.run(days) 316 | 317 | main() 318 | -------------------------------------------------------------------------------- /splunk/README.md: -------------------------------------------------------------------------------- 1 | 2 | # Shadowserver Reports for Splunk 3 | 4 | This is a Splunk Modular Input Add-On for indexing Shadowserver intelligence reports. 5 | 6 | ## Install 7 | 8 | From the _Apps_ menu, select _Manage Apps_. 9 | 10 | Click the _Install app from file_ button. 11 | 12 | Click the _Browse..._ button and select the `shadowserver_reports.spl` file. 13 | 14 | Click _Upload_. 15 | 16 | 17 | ## Add Instance 18 | 19 | From the _Settings_ menu, select **Data**|Data inputs. 20 | 21 | In the list of _Local inputs_ locate _Shadowserver Reports_ and click the **+ Add new** link to the right. 22 | 23 | ![image](https://github.com/The-Shadowserver-Foundation/api_utils/assets/16844541/b752ffcf-5c27-4001-b99c-297af16be4fa) 24 | 25 | The _name_, _API Key_, and _API secret_ fields are required. 26 | 27 | Check the _More settings_ box to set the desired interval to check for reports. If the _interval_ field is not set, the add-on will only run once. 28 | 29 | The interval can be set to `3600` for hourly or `15 * * * *` to check 15 minutes after every hour. 30 | 31 | A cron schedule has five elements (from left to right): 32 | 33 | Minute: 0-59 34 | Hour: 0-23 35 | Day of the month: 1-31 36 | Month: 1-12 37 | Day of the week: 0-6 (where 0 = Sunday) 38 | 39 | The destination index may also be set after checking the _More settings_ box. 40 | 41 | Multiple instances of the Add-on can be created to partition events into different destinations by specifying _Reports_ and/or _Types_. 42 | 43 | 44 | ## Configuration Example 45 | 46 | Instances configured from the web interface are stored in an `inputs.conf` file. The following is a sample configuration to import the [Device Identification Report](https://www.shadowserver.org/what-we-do/network-reporting/device-identification-report/): 47 | 48 | ``` 49 | [shadowserver_reports://device_id] 50 | api_key = ........-....-....-....-........... 51 | secret = .......... 52 | types = device_id 53 | disabled = 0 54 | ``` 55 | 56 | ## Manual Run 57 | 58 | The add-on can be run manually as follows: 59 | 60 | `(cd $SPLUNK_HOME;bin/splunk cmd splunkd print-modinput-config shadowserver_reports shadowserver_reports://device_id | bin/splunk cmd python etc/apps/shadowserver_reports/bin/shadowserver_reports.py)` 61 | 62 | Where `$SPLUNK_HOME` is the directory that Splunk has been installed and `shadowserver_reports://device_id` matches the name of the instance you want to run as configured in `$SPLUNK_HOME/var/run/splunk/confsnapshot/baseline_local/apps/shadowserver_reports/local/inputs.conf`. 63 | 64 | This will send the data stream that would be indexed to stdout. 65 | 66 | The list of report files processed can be seen in `$SPLUNK_HOME/var/lib/splunk/modinputs/shadowserver_reports`. The checkpoint files may be removed to re-import the given report. 67 | -------------------------------------------------------------------------------- /splunk/shadowserver_reports.spl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/The-Shadowserver-Foundation/api_utils/11bb13e91a54d8c2e37c770051d38004a495ab6f/splunk/shadowserver_reports.spl --------------------------------------------------------------------------------