├── LICENSE ├── README.md ├── adAnalysis.py └── demo.gif /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 | # BloodHound CE and automating parts of AD pentests 2 | 3 | Blog Post: [BloodHound CE and automating parts of AD pentests](https://www.8com.de/cyber-security-blog/bloodhound-ce-and-automating-parts-of-ad-pentests) 4 | 5 | ![Demo](demo.gif) 6 | 7 | ## Usage 8 | 9 | 1. setup BloodHound CE using the provided [docker-compose files](https://github.com/SpecterOps/BloodHound/tree/main/examples/docker-compose) and enable the neo4j port 10 | 2. generate the API token and download the current version of SharpHound from the GUI 11 | 3. enter your API token (and the changed neo4j password, if applicable) into the script 12 | 4. run SharpHound from a domain joined host 13 | 5. extract the .zip archive 14 | 6. run the following commands 15 | 16 | ``` 17 | python -m venv adAnalysis 18 | source adAnalysis/bin/activate 19 | python -m pip install neo4j requests 20 | python adAnalysis.py -d 21 | ``` 22 | 23 | The script will print out all the findings and write the files in the current directory. The following data will be written to the csv-files: 24 | 25 | - laps.csv: computer name, computer objectid 26 | - unsupportedOs.csv: computer name, computer objectid 27 | - inactiveUsers.csv: username, user objectid, is user enabled (true or false), is user admin (true or false) 28 | - inactiveComputers.csv: computer name, computer objectid, is computer enabled (true or false) 29 | - domainAdmins.csv: username, user objectid 30 | - tierZeroUsers.csv: username, user objectid 31 | - kerberoastableUsers.csv: username, user objectid, user service principal names, user system tags (Tier Zero os NULL) 32 | - asrepRoastableUsers.csv: username, user objectid, user system tags (Tier Zero os NULL) 33 | - tierZeroSessions.csv: username, user objectid, computer name, computer objectid 34 | - dcsync.csv: username, user objectid 35 | - constrainedDelegation.csv: username, user objectid, computer name, computer objectid 36 | - unconstrainedDelegation.csv: object name, object objectid 37 | - resourcebasedConstrainedDelegation.csv: object name(allowed to act), object objectid(allowed to act), object name(target object), object objectid(target object) 38 | -------------------------------------------------------------------------------- /adAnalysis.py: -------------------------------------------------------------------------------- 1 | """ 2 | Copyright (C) 2023 Robin Meier 3 | 4 | This program is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | This program is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with this program. If not, see . 16 | """ 17 | 18 | import hmac 19 | import hashlib 20 | import base64 21 | import requests 22 | #import datetime 23 | 24 | from neo4j import GraphDatabase, RoutingControl 25 | from neo4j.exceptions import DriverError, Neo4jError 26 | from datetime import datetime, date, time, timezone 27 | import csv 28 | import time 29 | 30 | import argparse 31 | import glob 32 | 33 | from typing import Optional 34 | 35 | # this API section is taken (and modified) from the python script provided in https://support.bloodhoundenterprise.io/hc/en-us/articles/11311053342619-Working-with-the-BloodHound-API 36 | BHE_DOMAIN = "localhost" 37 | BHE_PORT = 8080 38 | BHE_SCHEME = "http" 39 | BHE_TOKEN_ID = "" 40 | BHE_TOKEN_KEY = "" 41 | 42 | PRINT_PRINCIPALS = False 43 | PRINT_ATTACK_PATH_TIMELINE_DATA = False 44 | PRINT_POSTURE_DATA = False 45 | 46 | DATA_START = "1970-01-01T00:00:00.000Z" 47 | DATA_END = datetime.now(timezone.utc).strftime('%Y-%m-%dT%H:%M:%S.%f')[:-3] + 'Z' # Now 48 | 49 | class Credentials(object): 50 | def __init__(self, token_id: str, token_key: str) -> None: 51 | self.token_id = token_id 52 | self.token_key = token_key 53 | 54 | class Domain(object): 55 | def __init__(self, name: str, id: str, collected: bool, domain_type: str) -> None: 56 | self.name = name 57 | self.id = id 58 | self.type = domain_type 59 | self.collected = collected 60 | 61 | class APIVersion(object): 62 | def __init__(self, api_version: str, server_version: str) -> None: 63 | self.api_version = api_version 64 | self.server_version = server_version 65 | 66 | class Client(object): 67 | def __init__(self, scheme: str, host: str, port: int, credentials: Credentials) -> None: 68 | self._scheme = scheme 69 | self._host = host 70 | self._port = port 71 | self._credentials = credentials 72 | 73 | def _format_url(self, uri: str) -> str: 74 | formatted_uri = uri 75 | if uri.startswith("/"): 76 | formatted_uri = formatted_uri[1:] 77 | 78 | return f"{self._scheme}://{self._host}:{self._port}/{formatted_uri}" 79 | 80 | def _request(self, method: str, uri: str, body: Optional[bytes] = None) -> requests.Response: 81 | # Digester is initialized with HMAC-SHA-256 using the token key as the HMAC digest key. 82 | digester = hmac.new(self._credentials.token_key.encode(), None, hashlib.sha256) 83 | 84 | # OperationKey is the first HMAC digest link in the signature chain. This prevents replay attacks that seek to 85 | # modify the request method or URI. It is composed of concatenating the request method and the request URI with 86 | # no delimiter and computing the HMAC digest using the token key as the digest secret. 87 | # 88 | # Example: GET /api/v1/test/resource HTTP/1.1 89 | # Signature Component: GET/api/v1/test/resource 90 | digester.update(f"{method}{uri}".encode()) 91 | 92 | # Update the digester for further chaining 93 | digester = hmac.new(digester.digest(), None, hashlib.sha256) 94 | 95 | # DateKey is the next HMAC digest link in the signature chain. This encodes the RFC3339 formatted datetime 96 | # value as part of the signature to the hour to prevent replay attacks that are older than max two hours. This 97 | # value is added to the signature chain by cutting off all values from the RFC3339 formatted datetime from the 98 | # hours value forward: 99 | # 100 | # Example: 2020-12-01T23:59:60Z 101 | # Signature Component: 2020-12-01T23 102 | datetime_formatted = datetime.now().astimezone().isoformat("T") 103 | digester.update(datetime_formatted[:13].encode()) 104 | 105 | # Update the digester for further chaining 106 | digester = hmac.new(digester.digest(), None, hashlib.sha256) 107 | 108 | # Body signing is the last HMAC digest link in the signature chain. This encodes the request body as part of 109 | # the signature to prevent replay attacks that seek to modify the payload of a signed request. In the case 110 | # where there is no body content the HMAC digest is computed anyway, simply with no values written to the 111 | # digester. 112 | if body is not None: 113 | digester.update(body) 114 | 115 | # Perform the request with the signed and expected headers 116 | return requests.request( 117 | method=method, 118 | url=self._format_url(uri), 119 | headers={ 120 | "User-Agent": "bhe-python-sdk 0001", 121 | "Authorization": f"bhesignature {self._credentials.token_id}", 122 | "RequestDate": datetime_formatted, 123 | "Signature": base64.b64encode(digester.digest()), 124 | "Content-Type": "application/json", 125 | }, 126 | data=body, 127 | ) 128 | 129 | def get_version(self) -> APIVersion: 130 | response = self._request("GET", "/api/version") 131 | payload = response.json() 132 | 133 | return APIVersion(api_version=payload["data"]["API"]["current_version"], server_version=payload["data"]["server_version"]) 134 | 135 | def connectToApi(): 136 | # This might be best loaded from a file 137 | credentials = Credentials( 138 | token_id=BHE_TOKEN_ID, 139 | token_key=BHE_TOKEN_KEY, 140 | ) 141 | 142 | # Create the client and perform an example call using token request signing 143 | client = Client(scheme=BHE_SCHEME, host=BHE_DOMAIN, port=BHE_PORT, credentials=credentials) 144 | return client 145 | 146 | def getApiVersion(client): 147 | version = client.get_version() 148 | 149 | print("BHE Python API Client Example") 150 | print(f"API version: {version.api_version} - Server version: {version.server_version}\n") 151 | 152 | def getAvailableDomains(client) -> list[Domain]: 153 | response = client._request('GET', '/api/v2/available-domains') 154 | payload = response.json()['data'] 155 | 156 | domains = list() 157 | for domain in payload: 158 | domains.append(Domain(domain["name"], domain["id"], domain["collected"], domain["type"])) 159 | for domain in domains: 160 | print(f'{domain.name} : {domain.id}') 161 | return domains 162 | 163 | # end of API section 164 | 165 | def getDomainInfo(client, dom_id): 166 | response = client._request('GET', f'/api/v2/ad-domains/{dom_id}/data-quality-stats') 167 | payload = response.json()['data'][0] 168 | return (payload['users'], payload['groups'], payload['computers'], payload['ous'], payload['gpos']) 169 | 170 | def uploadData(client, dirToJson): 171 | postfix = ['_ous.json', '_gpos.json', '_containers.json', '_computers.json', '_groups.json', '_users.json', '_domains.json'] 172 | response = client._request('POST', '/api/v2/file-upload/start') 173 | uploadId = response.json()['data']['id'] 174 | for file in postfix: 175 | filename = glob.glob(dirToJson + '/*' + file) 176 | print(f'Uploading: {filename[0]}') 177 | with open(filename[0], 'r', encoding='utf-8-sig') as f: 178 | data = f.read().encode('utf-8') 179 | response = client._request('POST', f'/api/v2/file-upload/{uploadId}', data) 180 | response = client._request('POST', f'/api/v2/file-upload/{uploadId}/end') 181 | print('Waiting for BloodHound to ingest the data.') 182 | response = client._request('GET', '/api/v2/file-upload?skip=0&limit=10&sort_by=-id') 183 | status = response.json()['data'][0] 184 | while True: 185 | if status['id'] == uploadId and status['status_message'] == "Complete": 186 | break 187 | else: 188 | time.sleep(15) 189 | response = client._request('GET', '/api/v2/file-upload?skip=0&limit=10&sort_by=-id') 190 | status = response.json()['data'][0] 191 | print('Done! Continuing now.') 192 | 193 | def collectBasicInfos(driver, apiInput): 194 | print('===+++===+++===+++===+++===') 195 | print(' Collecting Basic Information') 196 | print('===+++===+++===+++===+++===') 197 | totalUsers = apiInput[0] 198 | print(f'There is a total of {totalUsers} Users') 199 | totalComputers = apiInput[2] 200 | print(f'There is a total of {totalComputers} Computers') 201 | totalGroups = apiInput[1] 202 | print(f'There is a total of {totalGroups} Groups') 203 | totalOUs = apiInput[3] 204 | print(f'There is a total of {totalOUs} OUs') 205 | totalGPOs = apiInput[4] 206 | print(f'There is a total of {totalGPOs} GPOs') 207 | return (totalUsers, totalComputers) 208 | 209 | def writeCsvFile(filename, data): 210 | fullFilename = filename 211 | with open(fullFilename, 'w', newline='') as f: 212 | csvwriter = csv.writer(f, delimiter=',') 213 | for line in data: 214 | csvwriter.writerow(line) 215 | 216 | def writeUsersList(data, filename): 217 | with open(filename, 'w') as f: 218 | for i in data: 219 | f.write(i["u.name"] + '\n') 220 | 221 | def printBanner(title): 222 | print('===+++===+++===+++===+++===') 223 | print(f' {title}') 224 | print('===+++===+++===+++===+++===') 225 | 226 | def genUserLists(driver): 227 | printBanner('Generating User Lists') 228 | q = "MATCH (u:User) WHERE u.enabled = true RETURN u.name" 229 | enabledUsers, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 230 | q2 = "MATCH (u:User) WHERE u.enabled = true AND u.system_tags = 'admin_tier_0' RETURN u.name" 231 | enabledTierZeroUsers, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 232 | q3 = "MATCH (u:User) WHERE u.enabled = true AND u.lastlogon < (datetime().epochseconds - (90 * 86400)) AND u.lastlogontimestamp < (datetime().epochseconds - (90 * 86400)) RETURN u.name" 233 | enabledInactiveUsers, _, _ = driver.execute_query(q3, database_="neo4j", routing_=RoutingControl.READ) 234 | q4 = "MATCH (u:User) WHERE (u.name =~ '(?i).*adm.*' OR u.description =~ '(?i).*admin.*') AND u.enabled = true RETURN u.name " 235 | enabledPotentialAdminUsers, _, _ = driver.execute_query(q4, database_="neo4j", routing_=RoutingControl.READ) 236 | print(f'Writing EnabledUsersList with {len(enabledUsers)} users to: enabledUsers.txt') 237 | writeUsersList(enabledUsers, 'enabledUsers.txt') 238 | print(f'Writing EnabledTierZeroUsersList with {len(enabledTierZeroUsers)} users to: enabledTierZeroUsers.txt') 239 | writeUsersList(enabledTierZeroUsers, 'enabledTierZeroUsers.txt') 240 | print(f'Writing EnabledInactiveUsersList with {len(enabledInactiveUsers)} users to: enabledInactiveUsers.txt') 241 | writeUsersList(enabledInactiveUsers, 'enabledInactiveUsers.txt') 242 | print(f'Writing EnabledPotentialAdminUsers with {len(enabledPotentialAdminUsers)} users to: enabledPotentialAdminUsers.txt') 243 | writeUsersList(enabledPotentialAdminUsers, 'enabledPotentialAdminUsers.txt') 244 | 245 | def checkLaps(driver): 246 | printBanner('Checking LAPS') 247 | q = "MATCH (c:Computer) WHERE c.haslaps = false AND c.enabled = true RETURN count(c) " 248 | noLaps, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 249 | q2 = "MATCH (c:Computer) WHERE (c.lastlogon > (datetime().epochseconds - (90 * 86400)) OR c.lastlogontimestamp > (datetime().epochseconds - (90 * 86400))) AND c.haslaps = false AND c.enabled = true RETURN count(c)" 250 | criticalNoLaps, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 251 | print(f'There are {noLaps[0]["count(c)"]} enabled Computers without LAPS! {criticalNoLaps[0]["count(c)"]} seem to be in active use!') 252 | if noLaps[0]["count(c)"] > 0: 253 | print("Generating csv-file for: Affected Resources") 254 | affectedResourcesLaps, _, _ = driver.execute_query( 255 | "MATCH (c:Computer) " 256 | "WHERE c.haslaps = false AND c.enabled = true " 257 | "RETURN c.name, c.objectid ", 258 | database_="neo4j", routing_=RoutingControl.READ, 259 | ) 260 | writeCsvFile('laps.csv', affectedResourcesLaps) 261 | 262 | def checkUnsupportedOs(driver): 263 | printBanner('Checking Unsupported OS') 264 | q = "MATCH (c:Computer) WHERE c.operatingsystem =~ '(?i).*(2000|2003|2008|xp|vista|7|me).*' AND (c.lastlogon > (datetime().epochseconds - (90 * 86400)) OR c.lastlogontimestamp > (datetime().epochseconds - (90 * 86400))) AND c.enabled = true RETURN count(c)" 265 | unsupportedOs, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 266 | print(f'There are {unsupportedOs[0]["count(c)"]} active computers with an unsupported OS.') 267 | if unsupportedOs[0]["count(c)"] > 0: 268 | print("Generating csv-file for: Affected Resources") 269 | q2 = "MATCH (c:Computer) WHERE c.operatingsystem =~ '(?i).*(2000|2003|2008|xp|vista|7|me).*' AND (c.lastlogon > (datetime().epochseconds - (90 * 86400)) OR c.lastlogontimestamp > (datetime().epochseconds - (90 * 86400))) AND c.enabled = true RETURN c.name, c.objectid" 270 | affectedResourcesUnsupportedOs, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 271 | outfile = 'unsupportedOs.csv' 272 | writeCsvFile('unsupportedOs.csv', affectedResourcesUnsupportedOs) 273 | 274 | def checkInactiveUsersAndComputers(driver, totalUsers, totalComputers): 275 | printBanner('Checking inactive Users/Computers') 276 | q = "MATCH (u:User) WHERE u.lastlogon < (datetime().epochseconds - (90 * 86400)) AND u.lastlogontimestamp < (datetime().epochseconds - (90 * 86400)) AND u.samaccountname <> 'krbtgt' RETURN count(u) " 277 | inactiveUsers, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 278 | print(f'There are {inactiveUsers[0]["count(u)"]} users marked as inactive out of {totalUsers}!') 279 | inactiveEnabledUsers, _, _ = driver.execute_query( 280 | "MATCH (u:User) " 281 | "WHERE u.lastlogon < (datetime().epochseconds - (90 * 86400)) AND " 282 | "u.lastlogontimestamp < (datetime().epochseconds - (90 * 86400)) AND " 283 | "u.samaccountname <> 'krbtgt' AND " 284 | "u.enabled = true " 285 | "RETURN count(u) ", 286 | database_="neo4j", routing_=RoutingControl.READ, 287 | ) 288 | print(f'Out of these {inactiveUsers[0]["count(u)"]} inactive users {inactiveEnabledUsers[0]["count(u)"]} are still enabled!') 289 | print("Generating csv-file for: Affected Resources") 290 | affectedResourcesInactiveUsers, _, _ = driver.execute_query( 291 | "MATCH (u:User) " 292 | "WHERE u.lastlogon < (datetime().epochseconds - (90 * 86400)) AND " 293 | "u.lastlogontimestamp < (datetime().epochseconds - (90 * 86400)) AND " 294 | "u.samaccountname <> 'krbtgt' " 295 | "RETURN u.name, u.objectid, u.enabled, u.admincount ", 296 | database_="neo4j", routing_=RoutingControl.READ, 297 | ) 298 | writeCsvFile('inactiveUsers.csv', affectedResourcesInactiveUsers) 299 | 300 | q2 = "MATCH (c:Computer) WHERE c.lastlogon < (datetime().epochseconds - (90 * 86400)) AND c.lastlogontimestamp < (datetime().epochseconds - (90 * 86400)) RETURN count(c) " 301 | inactiveComputers, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 302 | print(f'There are {inactiveComputers[0]["count(c)"]} computers marked as inactive out of {totalComputers}!') 303 | inactiveEnabledComputers, _, _ = driver.execute_query( 304 | "MATCH (u:Computer) " 305 | "WHERE u.lastlogon < (datetime().epochseconds - (90 * 86400)) AND " 306 | "u.lastlogontimestamp < (datetime().epochseconds - (90 * 86400)) AND " 307 | "u.enabled = true " 308 | "RETURN count(u) ", 309 | database_="neo4j", routing_=RoutingControl.READ, 310 | ) 311 | print(f'Out of these {inactiveComputers[0]["count(c)"]} inactive computers {inactiveEnabledComputers[0]["count(u)"]} are still enabled!') 312 | print("Generating csv-file for: Affected Resources") 313 | affectedResourcesInactiveComputers, _, _ = driver.execute_query( 314 | "MATCH (c:Computer) " 315 | "WHERE c.lastlogon < (datetime().epochseconds - (90 * 86400)) AND " 316 | "c.lastlogontimestamp < (datetime().epochseconds - (90 * 86400)) " 317 | "RETURN c.name, c.objectid, c.enabled ", 318 | database_="neo4j", routing_=RoutingControl.READ, 319 | ) 320 | writeCsvFile('inactiveComputers.csv', affectedResourcesInactiveComputers) 321 | 322 | def checkKrbtgtPassword(driver): 323 | printBanner('Checking krbtgt Password') 324 | q = "MATCH (u:User) WHERE u.samaccountname = 'krbtgt' RETURN u.pwdlastset " 325 | krbtgtPassword, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 326 | currentTime = datetime.now() 327 | krbtgtPasswordTime = datetime.fromtimestamp(krbtgtPassword[0]["u.pwdlastset"]) 328 | krbtgtPasswordTimeStr = krbtgtPasswordTime.strftime('%d.%m.%Y %H:%M:%S') 329 | timeDiffInDays = (currentTime - krbtgtPasswordTime).days 330 | print(f'The krbtgt Password was last set on {krbtgtPasswordTimeStr} which means it is {timeDiffInDays} days old! If the password is over 180 days old it should be changed!') 331 | 332 | def checkSensitiveAccountsAndProtectedUsers(driver): 333 | printBanner('Checking DA Count') 334 | q = "MATCH p=(n:Group)<-[:MemberOf*1..]-(m:User) WHERE n.objectid ENDS WITH '-512' WITH COLLECT(m) AS das \nMATCH (u:User) WHERE u IN das RETURN count(u) " 335 | totalDAs, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 336 | q2 = "MATCH p=(n:Group)<-[:MemberOf*1..]-(m:User) WHERE n.objectid ENDS WITH '-512' WITH COLLECT(m) AS das \nMATCH (u:User) WHERE u IN das AND u.enabled = true RETURN count(u) " 337 | totalDAsEnabled, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 338 | print("Generating csv-file for: Affected Resources") 339 | affectedResourcesDas, _, _ = driver.execute_query( 340 | "MATCH p=(n:Group)<-[:MemberOf*1..]-(m:User) WHERE n.objectid ENDS WITH '-512' WITH COLLECT(m) AS das MATCH (u:User) WHERE u IN das RETURN u.name, u.objectid ", 341 | database_="neo4j", routing_=RoutingControl.READ, 342 | ) 343 | writeCsvFile('domainAdmins.csv', affectedResourcesDas) 344 | print(f'There is a total of {totalDAs[0]["count(u)"]} Domain Admin Users ({totalDAsEnabled[0]["count(u)"]} enabled). The number of Domain Admins should be kept as low as possible.') 345 | 346 | 347 | printBanner('Checking Tier Zero Count') 348 | q = "MATCH (n:User) WHERE n.system_tags='admin_tier_0' RETURN count(n) " 349 | totalTierZeroUsers, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 350 | q2 = "MATCH (n:User) WHERE n.system_tags='admin_tier_0' AND n.enabled = true RETURN count(n) " 351 | totalTierZeroUsersEnabled, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 352 | print(f'There is a total of {totalTierZeroUsers[0]["count(n)"]} Tier Zero users ({totalTierZeroUsersEnabled[0]["count(n)"]} enabled). The number of Tier Zero users should be kept as low as possible.') 353 | print("Generating csv-file for: Affected Resources") 354 | affectedResourcesTierZero, _, _ = driver.execute_query( 355 | "MATCH (n:User) WHERE n.system_tags='admin_tier_0' RETURN n.name, n.objectid ", 356 | database_="neo4j", routing_=RoutingControl.READ, 357 | ) 358 | writeCsvFile('tierZeroUsers.csv', affectedResourcesTierZero) 359 | 360 | printBanner('Checking Protected Users') 361 | q = "MATCH (u:User)-[:MemberOf]->(g:Group) WHERE g.objectid ENDS WITH '-525' RETURN count(u) " 362 | protectedUsers, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 363 | print(f'The group Protecetd Users has {protectedUsers[0]["count(u)"]} members. It is recommended that at least all Tier Zero Users (here: {totalTierZeroUsers[0]["count(n)"]}) should be in this group!') 364 | 365 | def checkActiveGuest(driver): 366 | printBanner('Checking Guest Account') 367 | q = "MATCH (u:User) WHERE u.objectid ENDS WITH '-501' RETURN u.name, u.enabled, u.lastlogon, u.lastlogontimestamp " 368 | guest, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 369 | if guest[0]["u.enabled"] == "TRUE": 370 | print('The Guest Account is enabled which is not recommended.') 371 | else: 372 | print('The Guest Account is disabled.') 373 | 374 | def checkKerberoastableUsers(driver): 375 | printBanner('Checking Kerberoastable Users') 376 | q = "MATCH (n:User) WHERE n.hasspn=true AND n.samaccountname <> 'krbtgt' RETURN count(n) " 377 | kerberoastable, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 378 | q2 = "MATCH (n:User) WHERE n.hasspn=true AND n.samaccountname <> 'krbtgt' AND n.system_tags='admin_tier_0' RETURN count(n) " 379 | kerberoastableTierZero, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 380 | print(f'There is a total of {kerberoastable[0]["count(n)"]} kerberoastable Users. This includes {kerberoastableTierZero[0]["count(n)"]} Tier Zero Accounts!') 381 | if kerberoastable[0]["count(n)"] > 0: 382 | print("Generating csv-file for: Affected Resources") 383 | q3 = "MATCH (n:User) WHERE n.hasspn=true AND n.samaccountname <> 'krbtgt' RETURN n.name, n.objectid, n.serviceprincipalnames, n.system_tags " 384 | kerberoastableData, _, _ = driver.execute_query(q3, database_="neo4j", routing_=RoutingControl.READ) 385 | writeCsvFile('kerberoastableUsers.csv', kerberoastableData) 386 | 387 | def checkAsrepRoasting(driver): 388 | printBanner('Checking AS-REP Roastable Users') 389 | q = "MATCH (u:User) WHERE u.dontreqpreauth = true RETURN count(u) " 390 | asreproastable, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 391 | print(f'There is a total of {asreproastable[0]["count(u)"]} AS-REP roastable Users') 392 | if asreproastable[0]["count(u)"] > 0: 393 | print("Generating csv-file for: Affected Resources") 394 | asreproastableData, _, _ = driver.execute_query( 395 | "MATCH (u:User) " 396 | "WHERE u.dontreqpreauth = true " 397 | "RETURN u.name, u.objectid, u.system_tags ", 398 | database_="neo4j", routing_=RoutingControl.READ, 399 | ) 400 | writeCsvFile('asrepRoastableUsers.csv', asreproastableData) 401 | 402 | def checkTierZeroSessions(driver): 403 | printBanner('Checking Tier Zero Sessions') 404 | q = "MATCH (u:User) WHERE u.system_tags='admin_tier_0' MATCH p = (c:Computer)-[:HasSession]->(u:User) RETURN count(p), count(DISTINCT u), count(DISTINCT c) " 405 | tierZeroSessions, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 406 | print(f'There is a total of {tierZeroSessions[0]["count(p)"]} active Tier Zero sessions. From {tierZeroSessions[0]["count(DISTINCT u)"]} Users on {tierZeroSessions[0]["count(DISTINCT c)"]} Systems') 407 | if tierZeroSessions[0]["count(p)"] > 0: 408 | print("Generating csv-file for: Affected Resources") 409 | q2 = "MATCH (u:User) WHERE u.system_tags='admin_tier_0' MATCH p = (c:Computer)-[:HasSession]->(u:User) RETURN u.name, u.objectid, c.name, c.objectid " 410 | tierZeroSessionsData, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 411 | writeCsvFile('tierZeroSessions.csv', tierZeroSessionsData) 412 | 413 | def checkDcSync(driver): 414 | printBanner('Checking DCSync (non Tier Zero)') 415 | q = "MATCH p=(n)-[:DCSync|AllExtendedRights|GenericAll]->(:Domain) WHERE NOT n.system_tags='admin_tier_0' RETURN count(n) " 416 | dcsync, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 417 | print(f'There is a total of {dcsync[0]["count(n)"]} objects with DCSync rights which are not Tier Zero') 418 | if dcsync[0]["count(n)"] > 0: 419 | print("Generating csv-file for: Affected Resources") 420 | q2 = "MATCH p=(n)-[:DCSync|AllExtendedRights|GenericAll]->(:Domain) WHERE NOT n.system_tags='admin_tier_0' RETURN n.name, n.objectid " 421 | dcsyncData, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 422 | writeCsvFile('dcsync.csv', dcsyncData) 423 | 424 | def checkConstrainedDelegation(driver): 425 | printBanner('Checking Constrained Delegation') 426 | q = "MATCH (u:User)-[:AllowedToDelegate]->(c:Computer) WHERE (c.lastlogon > (datetime().epochseconds - (90 * 86400)) OR c.lastlogontimestamp > (datetime().epochseconds - (90 * 86400))) AND (u.lastlogon > (datetime().epochseconds - (90 * 86400)) OR u.lastlogontimestamp > (datetime().epochseconds - (90 * 86400))) RETURN count(DISTINCT u), count(DISTINCT c) " 427 | constrainedDelegation, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 428 | print(f'There are {constrainedDelegation[0]["count(DISTINCT u)"]} users allowed to delegate to {constrainedDelegation[0]["count(DISTINCT c)"]} computers') 429 | if constrainedDelegation[0]["count(DISTINCT u)"] > 0: 430 | q2 = "MATCH (u:User)-[:AllowedToDelegate]->(c:Computer) WHERE (c.lastlogon > (datetime().epochseconds - (90 * 86400)) OR c.lastlogontimestamp > (datetime().epochseconds - (90 * 86400))) AND (u.lastlogon > (datetime().epochseconds - (90 * 86400)) OR u.lastlogontimestamp > (datetime().epochseconds - (90 * 86400))) RETURN u.name, u.objectid, c.name, c.objectid " 431 | constrainedDelegationData, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 432 | writeCsvFile('constrainedDelegation.csv', constrainedDelegationData) 433 | 434 | def checkUnconstrainedDelegation(driver): 435 | printBanner('Checking Unconstrained Delegation') 436 | q = "MATCH (u) WHERE (u.unconstraineddelegation = true) AND (u.system_tags IS NULL) AND u.enabled = true AND (u.lastlogon > (datetime().epochseconds - (90 * 86400)) OR u.lastlogontimestamp > (datetime().epochseconds - (90 * 86400))) RETURN count(u) " 437 | unconstrainedDelegation, _, _ = driver.execute_query(q, database_="neo4j", routing_=RoutingControl.READ) 438 | print(f'There are {unconstrainedDelegation[0]["count(u)"]} non Tier Zero Objects allowed for unconstrained delegation.') 439 | if unconstrainedDelegation[0]["count(u)"] > 0: 440 | q2 = "MATCH (u) WHERE (u.unconstraineddelegation = true) AND (u.system_tags IS NULL) AND u.enabled = true AND (u.lastlogon > (datetime().epochseconds - (90 * 86400)) OR u.lastlogontimestamp > (datetime().epochseconds - (90 * 86400))) RETURN u.name, u.objectid " 441 | unconstrainedDelegationData, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 442 | writeCsvFile('unconstrainedDelegation.csv', unconstrainedDelegationData) 443 | 444 | def checkResourceBasedConstrainedDelegation(driver): 445 | printBanner('Checking Resource-based Constrained Delegation') 446 | resourcebasedConstrainedDelegation, _, _ = driver.execute_query( 447 | "MATCH p=(m)-[r:AllowedToAct]->(n) WHERE (m.system_tags IS NULL) RETURN count(m) ", 448 | database_="neo4j", routing_=RoutingControl.READ, 449 | ) 450 | print(f'There are {resourcebasedConstrainedDelegation[0]["count(m)"]} non Tier Zero Object allowed for Resource-based Constrained Delegation.') 451 | if resourcebasedConstrainedDelegation[0]["count(m)"] > 0: 452 | q2 = "MATCH (u)-[r:AllowedToAct]->(n) WHERE (u.unconstraineddelegation = true) AND (u.system_tags IS NULL) AND u.enabled = true AND (u.lastlogon > (datetime().epochseconds - (90 * 86400)) OR u.lastlogontimestamp > (datetime().epochseconds - (90 * 86400))) RETURN u.name, u.objectid, n.name, n.objectid " 453 | resourcebasedConstrainedDelegationData, _, _ = driver.execute_query(q2, database_="neo4j", routing_=RoutingControl.READ) 454 | writeCsvFile('resourcebasedConstrainedDelegation.csv', resourcebasedConstrainedDelegationData) 455 | 456 | def dumpDescriptions(driver): 457 | printBanner('Dumping Descriptions') 458 | descriptions, _, _ = driver.execute_query( 459 | "MATCH (n) " 460 | "WHERE n.description IS NOT NULL " 461 | "RETURN n.name, n.description ", 462 | database_="neo4j", routing_=RoutingControl.READ, 463 | ) 464 | print(f'Dumping ALL descriptions for further manual analysis.') 465 | writeCsvFile('descriptions.csv', descriptions) 466 | 467 | def collectBloodHoundNeo4j(apiInfo): 468 | with GraphDatabase.driver('neo4j://localhost:7687', auth=("neo4j", "bloodhoundcommunityedition")) as driver: 469 | basicInfos = collectBasicInfos(driver, apiInfo) 470 | genUserLists(driver) 471 | checkLaps(driver) 472 | checkUnsupportedOs(driver) 473 | checkInactiveUsersAndComputers(driver, basicInfos[0], basicInfos[1]) 474 | checkKrbtgtPassword(driver) 475 | checkSensitiveAccountsAndProtectedUsers(driver) 476 | checkActiveGuest(driver) 477 | checkKerberoastableUsers(driver) 478 | checkAsrepRoasting(driver) 479 | checkTierZeroSessions(driver) 480 | checkConstrainedDelegation(driver) 481 | checkUnconstrainedDelegation(driver) 482 | checkResourceBasedConstrainedDelegation(driver) 483 | checkDcSync(driver) 484 | dumpDescriptions(driver) 485 | 486 | def collectBloodHoundApi(dataDir): 487 | c = connectToApi() 488 | uploadData(c, dataDir) 489 | domains = getAvailableDomains(c) 490 | data = getDomainInfo(c, domains[0].id) 491 | return data 492 | 493 | if __name__=="__main__": 494 | parser = argparse.ArgumentParser() 495 | parser.add_argument('-d', '--data') 496 | args = parser.parse_args() 497 | 498 | apiData = collectBloodHoundApi(args.data) 499 | collectBloodHoundNeo4j(apiData) 500 | -------------------------------------------------------------------------------- /demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/8com/bloodhound-adAnalysis/06837ab9704a9a190bf0e9229922c2b03c663976/demo.gif --------------------------------------------------------------------------------