├── .github └── workflows │ ├── build.yml │ ├── cla.yml │ └── publish.yml ├── .gitignore ├── FodyWeavers.xml ├── LICENSE ├── Quickstart.ipynb ├── README.md ├── Sharphound.csproj ├── Sharphound.sln ├── favicon.ico └── src ├── BaseContext.cs ├── Client ├── Context.cs ├── Enums.cs ├── Flags.cs └── Links.cs ├── CobaltRunner.cs ├── Extensions.cs ├── JsonExtensions.cs ├── Options.cs ├── PowerShell ├── Out-CompressedDLL.ps1 └── Template.ps1 ├── Producers ├── BaseProducer.cs ├── ComputerFileProducer.cs ├── LdapProducer.cs ├── StealthContext.cs └── StealthProducer.cs ├── Runtime ├── ClientHelpers.cs ├── CollectionTask.cs ├── LDAPConsumer.cs ├── LoopManager.cs ├── ObjectProcessors.cs └── OutputWriter.cs ├── Sharphound.cs └── Writers ├── BaseWriter.cs ├── CompStatusWriter.cs └── JsonDataWriter.cs /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: 4 | push: 5 | branches: [ dev ] 6 | pull_request: 7 | branches: [ dev ] 8 | 9 | jobs: 10 | build: 11 | runs-on: windows-latest 12 | defaults: 13 | run: 14 | shell: bash 15 | 16 | strategy: 17 | matrix: 18 | release: 19 | - type: Debug 20 | suffix: '-debug' 21 | - type: Release 22 | suffix: '' 23 | 24 | name: Build (${{ matrix.release.type }}) 25 | 26 | steps: 27 | - uses: actions/checkout@v2 28 | 29 | - name: Setup .NET 30 | uses: actions/setup-dotnet@v1 31 | with: 32 | dotnet-version: 5.0.x 33 | 34 | - name: Restore Dependencies 35 | run: dotnet restore 36 | 37 | - name: Build 38 | run: dotnet build -c ${{ matrix.release.type }} -p:Version=0.0.0-rolling+${{ github.sha }} 39 | 40 | - name: Zip 41 | if: "! startsWith(github.event_name, 'pull_request')" 42 | run: 7z a -tzip -mx9 SharpHound${{ matrix.release.suffix }}.zip $PWD/bin/${{ matrix.release.type }}/net462/* 43 | 44 | - name: Update Rolling Release 45 | if: "! startsWith(github.event_name, 'pull_request')" 46 | uses: softprops/action-gh-release@v1 47 | with: 48 | name: Rolling Release (unstable) 49 | tag_name: rolling 50 | prerelease: true 51 | files: SharpHound${{ matrix.release.suffix }}.zip 52 | body: | 53 | Rolling release of SharpHound compiled from source (${{ github.sha }}) 54 | This is automatically kept up-to-date with the `${{ github.ref_name }}` ${{ github.ref_type }}. 55 | -------------------------------------------------------------------------------- /.github/workflows/cla.yml: -------------------------------------------------------------------------------- 1 | name: "CLA Assistant" 2 | on: 3 | issue_comment: 4 | types: [created] 5 | pull_request_target: 6 | types: [opened,closed,synchronize] 7 | 8 | jobs: 9 | CLAssistant: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: "CLA Assistant" 13 | if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' 14 | uses: contributor-assistant/github-action@v2.2.1 15 | env: 16 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 17 | PERSONAL_ACCESS_TOKEN : ${{ secrets.REPO_SCOPE }} 18 | with: 19 | path-to-signatures: 'signatures.json' 20 | path-to-document: 'https://github.com/BloodHoundAD/CLA/blob/main/ICLA.md' 21 | branch: 'main' 22 | remote-organization-name: BloodHoundAD 23 | remote-repository-name: CLA 24 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish 2 | 3 | on: 4 | push: 5 | tags: 6 | - "v*.*.*" 7 | 8 | jobs: 9 | build: 10 | runs-on: windows-latest 11 | defaults: 12 | run: 13 | shell: bash 14 | 15 | strategy: 16 | matrix: 17 | release: 18 | - type: Debug 19 | suffix: '-debug' 20 | - type: Release 21 | suffix: '' 22 | 23 | name: Build (${{ matrix.release.type }}) 24 | 25 | steps: 26 | - uses: actions/checkout@v2 27 | 28 | - name: Setup .NET 29 | uses: actions/setup-dotnet@v1 30 | with: 31 | dotnet-version: 5.0.x 32 | 33 | - name: Restore Dependencies 34 | run: dotnet restore 35 | 36 | - name: Build 37 | run: | 38 | VERSION=${{ github.ref_name }} 39 | dotnet build -c ${{ matrix.release.type }} -p:Version=${VERSION:1} 40 | 41 | - name: Zip 42 | run: 7z a -tzip -mx9 SharpHound-${{ github.ref_name }}${{ matrix.release.suffix }}.zip $PWD/bin/${{ matrix.release.type }}/net462/* 43 | 44 | - name: Upload to Release 45 | uses: softprops/action-gh-release@v1 46 | with: 47 | files: SharpHound-${{ github.ref_name }}${{ matrix.release.suffix }}.zip 48 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ################ 2 | # Project Level Git Ignore 3 | ################################ 4 | 5 | riderModule.iml 6 | /_ReSharper.Caches/ 7 | 8 | build/ 9 | docs/ 10 | bin/ 11 | 12 | # coverage files 13 | /docfx/api/*.yml 14 | /docfx/api/.manifest 15 | /docfx/coverage/* 16 | !/docfx/coverage/*.md 17 | coverage.* 18 | 19 | # Log files 20 | logs/ 21 | *.log 22 | 23 | ################ 24 | # Boilerplate Settings (modify as needed) 25 | # (https://github.com/github/gitignore) 26 | ################################ 27 | 28 | ######## 29 | # Linux 30 | ################ 31 | 32 | # temporary files which can be created if a process still has a handle open of a deleted file 33 | .fuse_hidden* 34 | 35 | # KDE directory preferences 36 | .directory 37 | 38 | # Linux trash folder which might appear on any partition or disk 39 | .Trash-* 40 | 41 | # .nfs files are created when an open file is removed but is still being accessed 42 | .nfs* 43 | 44 | ######## 45 | # Mac OS 46 | ################ 47 | 48 | # General 49 | .DS_Store 50 | .AppleDouble 51 | .LSOverride 52 | 53 | # Icon must end with two \r 54 | Icon 55 | 56 | # Thumbnails 57 | ._* 58 | 59 | # Files that might appear in the root of a volume 60 | .DocumentRevisions-V100 61 | .fseventsd 62 | .Spotlight-V100 63 | .TemporaryItems 64 | .Trashes 65 | .VolumeIcon.icns 66 | .com.apple.timemachine.donotpresent 67 | 68 | # Directories potentially created on remote AFP share 69 | .AppleDB 70 | .AppleDesktop 71 | Network Trash Folder 72 | Temporary Items 73 | .apdisk 74 | 75 | ######## 76 | # Windows 77 | ################ 78 | 79 | # Windows thumbnail cache files 80 | Thumbs.db 81 | Thumbs.db:encryptable 82 | ehthumbs.db 83 | ehthumbs_vista.db 84 | 85 | # Dump file 86 | *.stackdump 87 | 88 | # Folder config file 89 | [Dd]esktop.ini 90 | 91 | # Recycle Bin used on file shares 92 | $RECYCLE.BIN/ 93 | 94 | # Windows Installer files 95 | *.cab 96 | *.msi 97 | *.msix 98 | *.msm 99 | *.msp 100 | 101 | # Windows shortcuts 102 | *.lnk 103 | 104 | ######## 105 | # Vim 106 | ################ 107 | 108 | # Swap 109 | [._]*.s[a-v][a-z] 110 | !*.svg # comment out if you don't need vector files 111 | [._]*.sw[a-p] 112 | [._]s[a-rt-v][a-z] 113 | [._]ss[a-gi-z] 114 | [._]sw[a-p] 115 | 116 | # Session 117 | Session.vim 118 | Sessionx.vim 119 | 120 | # Temporary 121 | .netrwhist 122 | *~ 123 | 124 | # Auto-generated tag files 125 | tags 126 | 127 | # Persistent undo 128 | [._]*.un~ 129 | 130 | ######## 131 | # Visual Studio Code 132 | ################ 133 | 134 | .vscode/* 135 | !.vscode/settings.json 136 | !.vscode/tasks.json 137 | !.vscode/launch.json 138 | !.vscode/extensions.json 139 | *.code-workspace 140 | 141 | # Local History for Visual Studio Code 142 | .history/ 143 | 144 | ######## 145 | # JetBrains (IntelliJ, Android Studio, etc.) 146 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 147 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 148 | ################ 149 | 150 | # Project files 151 | *.iml 152 | 153 | # User-specific stuff 154 | .idea/**/workspace.xml 155 | .idea/**/tasks.xml 156 | .idea/**/usage.statistics.xml 157 | .idea/**/dictionaries 158 | .idea/**/shelf 159 | 160 | # Generated files 161 | .idea/**/contentModel.xml 162 | 163 | # Sensitive or high-churn files 164 | .idea/**/dataSources/ 165 | .idea/**/dataSources.ids 166 | .idea/**/dataSources.local.xml 167 | .idea/**/sqlDataSources.xml 168 | .idea/**/dynamic.xml 169 | .idea/**/uiDesigner.xml 170 | .idea/**/dbnavigator.xml 171 | 172 | # Gradle 173 | .idea/**/gradle.xml 174 | .idea/**/libraries 175 | 176 | # Gradle and Maven with auto-import 177 | # When using Gradle or Maven with auto-import, you should exclude module files, 178 | # since they will be recreated, and may cause churn. Uncomment if using 179 | # auto-import. 180 | # .idea/artifacts 181 | # .idea/compiler.xml 182 | # .idea/jarRepositories.xml 183 | # .idea/modules.xml 184 | # .idea/*.iml 185 | # .idea/modules 186 | # *.iml 187 | # *.ipr 188 | 189 | # CMake 190 | cmake-build-*/ 191 | 192 | # Mongo Explorer plugin 193 | .idea/**/mongoSettings.xml 194 | 195 | # File-based project format 196 | *.iws 197 | 198 | # IntelliJ 199 | .idea 200 | out/ 201 | 202 | # mpeltonen/sbt-idea plugin 203 | .idea_modules/ 204 | 205 | # JIRA plugin 206 | atlassian-ide-plugin.xml 207 | 208 | # Cursive Clojure plugin 209 | .idea/replstate.xml 210 | 211 | # Crashlytics plugin (for Android Studio and IntelliJ) 212 | com_crashlytics_export_strings.xml 213 | crashlytics.properties 214 | crashlytics-build.properties 215 | fabric.properties 216 | 217 | # Editor-based Rest Client 218 | .idea/httpRequests 219 | 220 | # Android studio 3.1+ serialized cache file 221 | .idea/caches/build_file_checksums.ser 222 | 223 | ######## 224 | # VisualStudio 225 | ################ 226 | 227 | # User-specific files 228 | *.rsuser 229 | *.suo 230 | *.user 231 | *.userosscache 232 | *.sln.docstates 233 | 234 | # User-specific files (MonoDevelop/Xamarin Studio) 235 | *.userprefs 236 | 237 | # Mono auto generated files 238 | mono_crash.* 239 | 240 | # Build results 241 | [Dd]ebug/ 242 | [Dd]ebugPublic/ 243 | [Rr]elease/ 244 | [Rr]eleases/ 245 | x64/ 246 | x86/ 247 | [Ww][Ii][Nn]32/ 248 | [Aa][Rr][Mm]/ 249 | [Aa][Rr][Mm]64/ 250 | bld/ 251 | [Bb]in/ 252 | [Oo]bj/ 253 | [Ll]og/ 254 | [Ll]ogs/ 255 | 256 | # Visual Studio 2015/2017 cache/options directory 257 | .vs/ 258 | # Uncomment if you have tasks that create the project's static files in wwwroot 259 | #wwwroot/ 260 | 261 | # Visual Studio 2017 auto generated files 262 | Generated\ Files/ 263 | 264 | # MSTest test Results 265 | [Tt]est[Rr]esult*/ 266 | [Bb]uild[Ll]og.* 267 | 268 | # NUnit 269 | *.VisualState.xml 270 | TestResult.xml 271 | nunit-*.xml 272 | 273 | # Build Results of an ATL Project 274 | [Dd]ebugPS/ 275 | [Rr]eleasePS/ 276 | dlldata.c 277 | 278 | # Benchmark Results 279 | BenchmarkDotNet.Artifacts/ 280 | 281 | # .NET Core 282 | project.lock.json 283 | project.fragment.lock.json 284 | artifacts/ 285 | 286 | # ASP.NET Scaffolding 287 | ScaffoldingReadMe.txt 288 | 289 | # StyleCop 290 | StyleCopReport.xml 291 | 292 | # Files built by Visual Studio 293 | *_i.c 294 | *_p.c 295 | *_h.h 296 | *.ilk 297 | *.meta 298 | *.obj 299 | *.iobj 300 | *.pch 301 | *.pdb 302 | *.ipdb 303 | *.pgc 304 | *.pgd 305 | *.rsp 306 | *.sbr 307 | *.tlb 308 | *.tli 309 | *.tlh 310 | *.tmp 311 | *.tmp_proj 312 | *_wpftmp.csproj 313 | *.log 314 | *.tlog 315 | *.vspscc 316 | *.vssscc 317 | .builds 318 | *.pidb 319 | *.svclog 320 | *.scc 321 | 322 | # Chutzpah Test files 323 | _Chutzpah* 324 | 325 | # Visual C++ cache files 326 | ipch/ 327 | *.aps 328 | *.ncb 329 | *.opendb 330 | *.opensdf 331 | *.sdf 332 | *.cachefile 333 | *.VC.db 334 | *.VC.VC.opendb 335 | 336 | # Visual Studio profiler 337 | *.psess 338 | *.vsp 339 | *.vspx 340 | *.sap 341 | 342 | # Visual Studio Trace Files 343 | *.e2e 344 | 345 | # TFS 2012 Local Workspace 346 | $tf/ 347 | 348 | # Guidance Automation Toolkit 349 | *.gpState 350 | 351 | # ReSharper is a .NET coding add-in 352 | _ReSharper*/ 353 | *.[Rr]e[Ss]harper 354 | *.DotSettings.user 355 | 356 | # TeamCity is a build add-in 357 | _TeamCity* 358 | 359 | # DotCover is a Code Coverage Tool 360 | *.dotCover 361 | 362 | # AxoCover is a Code Coverage Tool 363 | .axoCover/* 364 | !.axoCover/settings.json 365 | 366 | # Coverlet is a free, cross platform Code Coverage Tool 367 | coverage*.json 368 | coverage*.xml 369 | coverage*.info 370 | 371 | # Visual Studio code coverage results 372 | *.coverage 373 | *.coveragexml 374 | 375 | # NCrunch 376 | _NCrunch_* 377 | .*crunch*.local.xml 378 | nCrunchTemp_* 379 | 380 | # MightyMoose 381 | *.mm.* 382 | AutoTest.Net/ 383 | 384 | # Web workbench (sass) 385 | .sass-cache/ 386 | 387 | # Installshield output folder 388 | [Ee]xpress/ 389 | 390 | # DocProject is a documentation generator add-in 391 | DocProject/buildhelp/ 392 | DocProject/Help/*.HxT 393 | DocProject/Help/*.HxC 394 | DocProject/Help/*.hhc 395 | DocProject/Help/*.hhk 396 | DocProject/Help/*.hhp 397 | DocProject/Help/Html2 398 | DocProject/Help/html 399 | 400 | # Click-Once directory 401 | publish/ 402 | 403 | # Publish Web Output 404 | *.[Pp]ublish.xml 405 | *.azurePubxml 406 | # Note: Comment the next line if you want to checkin your web deploy settings, 407 | # but database connection strings (with potential passwords) will be unencrypted 408 | *.pubxml 409 | *.publishproj 410 | 411 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 412 | # checkin your Azure Web App publish settings, but sensitive information contained 413 | # in these scripts will be unencrypted 414 | PublishScripts/ 415 | 416 | # NuGet Packages 417 | *.nupkg 418 | # NuGet Symbol Packages 419 | *.snupkg 420 | # The packages folder can be ignored because of Package Restore 421 | **/[Pp]ackages/* 422 | # except build/, which is used as an MSBuild target. 423 | !**/[Pp]ackages/build/ 424 | # Uncomment if necessary however generally it will be regenerated when needed 425 | #!**/[Pp]ackages/repositories.config 426 | # NuGet v3's project.json files produces more ignorable files 427 | *.nuget.props 428 | *.nuget.targets 429 | 430 | # Nuget personal access tokens and Credentials 431 | nuget.config 432 | 433 | # Microsoft Azure Build Output 434 | csx/ 435 | *.build.csdef 436 | 437 | # Microsoft Azure Emulator 438 | ecf/ 439 | rcf/ 440 | 441 | # Windows Store app package directories and files 442 | AppPackages/ 443 | BundleArtifacts/ 444 | Package.StoreAssociation.xml 445 | _pkginfo.txt 446 | *.appx 447 | *.appxbundle 448 | *.appxupload 449 | 450 | # Visual Studio cache files 451 | # files ending in .cache can be ignored 452 | *.[Cc]ache 453 | # but keep track of directories ending in .cache 454 | !?*.[Cc]ache/ 455 | 456 | # Others 457 | ClientBin/ 458 | ~$* 459 | *~ 460 | *.dbmdl 461 | *.dbproj.schemaview 462 | *.jfm 463 | *.pfx 464 | *.publishsettings 465 | orleans.codegen.cs 466 | 467 | # Including strong name files can present a security risk 468 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 469 | #*.snk 470 | 471 | # Since there are multiple workflows, uncomment next line to ignore bower_components 472 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 473 | #bower_components/ 474 | 475 | # RIA/Silverlight projects 476 | Generated_Code/ 477 | 478 | # Backup & report files from converting an old project file 479 | # to a newer Visual Studio version. Backup files are not needed, 480 | # because we have git ;-) 481 | _UpgradeReport_Files/ 482 | Backup*/ 483 | UpgradeLog*.XML 484 | UpgradeLog*.htm 485 | ServiceFabricBackup/ 486 | *.rptproj.bak 487 | 488 | # SQL Server files 489 | *.mdf 490 | *.ldf 491 | *.ndf 492 | 493 | # Business Intelligence projects 494 | *.rdl.data 495 | *.bim.layout 496 | *.bim_*.settings 497 | *.rptproj.rsuser 498 | *- [Bb]ackup.rdl 499 | *- [Bb]ackup ([0-9]).rdl 500 | *- [Bb]ackup ([0-9][0-9]).rdl 501 | 502 | # Microsoft Fakes 503 | FakesAssemblies/ 504 | 505 | # GhostDoc plugin setting file 506 | *.GhostDoc.xml 507 | 508 | # Node.js Tools for Visual Studio 509 | .ntvs_analysis.dat 510 | node_modules/ 511 | 512 | # Visual Studio 6 build log 513 | *.plg 514 | 515 | # Visual Studio 6 workspace options file 516 | *.opt 517 | 518 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 519 | *.vbw 520 | 521 | # Visual Studio LightSwitch build output 522 | **/*.HTMLClient/GeneratedArtifacts 523 | **/*.DesktopClient/GeneratedArtifacts 524 | **/*.DesktopClient/ModelManifest.xml 525 | **/*.Server/GeneratedArtifacts 526 | **/*.Server/ModelManifest.xml 527 | _Pvt_Extensions 528 | 529 | # Paket dependency manager 530 | .paket/paket.exe 531 | paket-files/ 532 | 533 | # FAKE - F# Make 534 | .fake/ 535 | 536 | # CodeRush personal settings 537 | .cr/personal 538 | 539 | # Python Tools for Visual Studio (PTVS) 540 | __pycache__/ 541 | *.pyc 542 | 543 | # Cake - Uncomment if you are using it 544 | # tools/** 545 | # !tools/packages.config 546 | 547 | # Tabs Studio 548 | *.tss 549 | 550 | # Telerik's JustMock configuration file 551 | *.jmconfig 552 | 553 | # BizTalk build output 554 | *.btp.cs 555 | *.btm.cs 556 | *.odx.cs 557 | *.xsd.cs 558 | 559 | # OpenCover UI analysis results 560 | OpenCover/ 561 | 562 | # Azure Stream Analytics local run output 563 | ASALocalRun/ 564 | 565 | # MSBuild Binary and Structured Log 566 | *.binlog 567 | 568 | # NVidia Nsight GPU debugger configuration file 569 | *.nvuser 570 | 571 | # MFractors (Xamarin productivity tool) working folder 572 | .mfractor/ 573 | 574 | # Local History for Visual Studio 575 | .localhistory/ 576 | 577 | # BeatPulse healthcheck temp database 578 | healthchecksdb 579 | 580 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 581 | MigrationBackup/ 582 | 583 | # Ionide (cross platform F# VS Code tools) working folder 584 | .ionide/ 585 | 586 | # Fody - auto-generated XML schema 587 | FodyWeavers.xsd 588 | 589 | # VS Code files for those working on multiple tools 590 | .vscode/* 591 | !.vscode/settings.json 592 | !.vscode/tasks.json 593 | !.vscode/launch.json 594 | !.vscode/extensions.json 595 | *.code-workspace 596 | 597 | # Local History for Visual Studio Code 598 | .history/ 599 | 600 | # Windows Installer files from build outputs 601 | *.cab 602 | *.msi 603 | *.msix 604 | *.msm 605 | *.msp 606 | 607 | # JetBrains Rider 608 | .idea/ 609 | *.sln.iml -------------------------------------------------------------------------------- /FodyWeavers.xml: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Quickstart.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "metadata": { 3 | "kernelspec": { 4 | "display_name": ".NET (C#)", 5 | "language": "C#", 6 | "name": ".net-csharp" 7 | }, 8 | "language_info": { 9 | "name": "C#" 10 | } 11 | }, 12 | "cells": [ 13 | { 14 | "cell_type": "code", 15 | "execution_count": null, 16 | "source": [], 17 | "outputs": [], 18 | "metadata": { 19 | "dotnet_interactive": { 20 | "language": "csharp" 21 | } 22 | } 23 | } 24 | ], 25 | "nbformat": 4, 26 | "nbformat_minor": 2 27 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | --- 2 | SharpHound Open Source Client version: 1.0.4 3 | --- 4 | 5 | # SharpHound4Cobalt 6 | 7 | ## Integration with Cobalt 8 | 9 | The SharpHound data (test file, json, zip, cache file) will not be written on the disk but only sent to Cobalt Strike downloads through [BOF.NET](https://github.com/CCob/BOF.NET) library. 10 | 11 | Thus, you must run it with Cobalt `bofnet` command otherwise the ingestor data will be lost. 12 | 13 | Only individual JSON files will be sent as it was the easiest way to keep this working on 'big' AD. 14 | 15 | ## Usage 16 | 17 | All the options remain the same except those related to the ZIP file as they are not anymore relevant. 18 | ``` 19 | bofnet_init 20 | bofnet_load /path/to/SharpHound4Cobalt.exe 21 | bofnet_execute Sharphound.CobaltRunner -c All,GPOLocalGroup 22 | ``` 23 | 24 | ## Credits 25 | 26 | [Williamknows](https://williamknowles.io/fetching-sharphound-data-entirely-in-memory-no-dropped-zip-or-json-files-using-bof-net-and-cobalt-strike/) 27 | [CCob](https://github.com/CCob/BOF.NET) 28 | 29 | 30 | # SharpHound 31 | 32 | ![GitHub all releases](https://img.shields.io/github/downloads/BloodHoundAD/SharpHound/total) 33 | 34 | ## Get SharpHound 35 | 36 | The latest build of SharpHound will always be in the BloodHound repository [here](https://github.com/BloodHoundAD/BloodHound/tree/master/Collectors) 37 | 38 | ## Compile Instructions 39 | 40 | To build this project, use .net 5.0 and run the following: 41 | 42 | ``` 43 | dotnet restore . 44 | dotnet build 45 | ``` 46 | 47 | ## Requirements 48 | 49 | SharpHound is designed targeting .Net 4.6.2. SharpHound must be run from the context of a domain user, either directly through a logon or through another method such as RUNAS. 50 | 51 | 52 | # SharpHound 53 | 54 | ```csharp 55 | dotnet restore . 56 | dotnet build 57 | ``` 58 | 59 | # CLI 60 | ``` 61 | -c, --collectionmethods (Default: Default) Collection Methods: Container, Group, LocalGroup, GPOLocalGroup, 62 | Session, LoggedOn, ObjectProps, ACL, ComputerOnly, Trusts, Default, RDP, DCOM, DCOnly 63 | 64 | -d, --domain Specify domain to enumerate 65 | 66 | -s, --searchforest (Default: false) Search all available domains in the forest 67 | 68 | --stealth Stealth Collection (Prefer DCOnly whenever possible!) 69 | 70 | -f Add an LDAP filter to the pregenerated filter. 71 | 72 | --distinguishedname Base DistinguishedName to start the LDAP search at 73 | 74 | --computerfile Path to file containing computer names to enumerate 75 | 76 | --outputdirectory (Default: .) Directory to output file too 77 | 78 | --outputprefix String to prepend to output file names 79 | 80 | --cachename Filename for cache (Defaults to a machine specific identifier) 81 | 82 | --memcache Keep cache in memory and don't write to disk 83 | 84 | --rebuildcache (Default: false) Rebuild cache and remove all entries 85 | 86 | --randomfilenames (Default: false) Use random filenames for output 87 | 88 | --zipfilename Filename for the zip 89 | 90 | --nozip (Default: false) Don't zip files 91 | 92 | --trackcomputercalls (Default: false) Adds a CSV tracking requests to computers 93 | 94 | --zippassword Password protects the zip with the specified password 95 | 96 | --prettyprint (Default: false) Pretty print JSON 97 | 98 | --ldapusername Username for LDAP 99 | 100 | --ldappassword Password for LDAP 101 | 102 | --domaincontroller Override domain controller to pull LDAP from. This option can result in data loss 103 | 104 | --ldapport (Default: 0) Override port for LDAP 105 | 106 | --secureldap (Default: false) Connect to LDAP SSL instead of regular LDAP 107 | 108 | --disablecertverification (Default: false) Disable certificate verification for secure LDAP 109 | 110 | --disablesigning (Default: false) Disables Kerberos Signing/Sealing 111 | 112 | --skipportcheck (Default: false) Skip checking if 445 is open 113 | 114 | --portchecktimeout (Default: 500) Timeout for port checks in milliseconds 115 | 116 | --skippasswordcheck (Default: false) Skip PwdLastSet age check when checking computers 117 | 118 | --excludedcs (Default: false) Exclude domain controllers from session/localgroup enumeration (mostly for 119 | ATA/ATP) 120 | 121 | --throttle Add a delay after computer requests in milliseconds 122 | 123 | --jitter Add jitter to throttle (percent) 124 | 125 | --threads (Default: 50) Number of threads to run enumeration with 126 | 127 | --skipregistryloggedon Skip registry session enumeration 128 | 129 | --overrideusername Override the username to filter for NetSessionEnum 130 | 131 | --realdnsname Override DNS suffix for API calls 132 | 133 | --collectallproperties Collect all LDAP properties from objects 134 | 135 | -l, --Loop Loop computer collection 136 | 137 | --loopduration Loop duration (Defaults to 2 hours - 00:02:00) 138 | 139 | --loopinterval Add delay between loops (Example - 00:00:01 is 1 minute) 140 | 141 | --statusinterval (Default: 30000) Interval in which to display status in milliseconds 142 | 143 | -v (Default: 2) Enable verbose output. Lower is more verbose 144 | 145 | --help Display this help screen. 146 | 147 | --version Display version information. 148 | ``` 149 | -------------------------------------------------------------------------------- /Sharphound.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | Exe 5 | net462 6 | latest 7 | full 8 | favicon.ico 9 | 1.1.0 10 | 1.1.0 11 | SpecterOps 12 | SharpHound 13 | SharpHound 14 | 15 | 16 | 17 | 18 | 19 | 20 | all 21 | 22 | 23 | all 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | -------------------------------------------------------------------------------- /Sharphound.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.31321.278 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sharphound", "Sharphound.csproj", "{90A6822C-4336-433D-923F-F54CE66BA98F}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {90A6822C-4336-433D-923F-F54CE66BA98F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {90A6822C-4336-433D-923F-F54CE66BA98F}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {90A6822C-4336-433D-923F-F54CE66BA98F}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {90A6822C-4336-433D-923F-F54CE66BA98F}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {E6C43CA6-C777-4E29-8338-863669ADD54B} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Hypnoze57/SharpHound4Cobalt/fb8e9a726a47596b4a29518bda73ecbf8ca6e43b/favicon.ico -------------------------------------------------------------------------------- /src/BaseContext.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using System.Threading; 4 | using System.Threading.Tasks; 5 | using Microsoft.Extensions.Logging; 6 | using Sharphound.Client; 7 | using Sharphound.Runtime; 8 | using SharpHoundCommonLib; 9 | using SharpHoundCommonLib.Enums; 10 | using Timer = System.Timers.Timer; 11 | 12 | namespace Sharphound 13 | { 14 | /// 15 | /// Console Context holds the various properties to be populated/validated by the chain of responsibility. 16 | /// 17 | public sealed class BaseContext : IDisposable, IContext 18 | { 19 | private static string CurrentLoopTime = $"{DateTime.Now:yyyyMMddHHmmss}"; 20 | private static readonly Lazy RandomGen = new(); 21 | 22 | private bool disposedValue; 23 | 24 | public BaseContext(ILogger logger, LDAPConfig ldapConfig, Flags flags) 25 | { 26 | Logger = logger; 27 | Flags = flags; 28 | LDAPUtils = new LDAPUtils(); 29 | LDAPUtils.SetLDAPConfig(ldapConfig); 30 | CancellationTokenSource = new CancellationTokenSource(); 31 | } 32 | 33 | public bool IsFaulted { get; set; } 34 | 35 | public ResolvedCollectionMethod ResolvedCollectionMethods { get; set; } 36 | public string LdapFilter { get; set; } 37 | public string SearchBase { get; set; } 38 | public string DomainName { get; set; } 39 | public string CacheFileName { get; set; } 40 | public string ComputerFile { get; set; } 41 | public string ZipFilename { get; set; } 42 | public string ZipPassword { get; set; } 43 | public string CurrentUserName { get; set; } 44 | public ILogger Logger { get; set; } 45 | public Timer Timer { get; set; } 46 | public DateTime LoopEnd { get; set; } 47 | public TimeSpan LoopDuration { get; set; } 48 | public TimeSpan LoopInterval { get; set; } 49 | public int StatusInterval { get; set; } 50 | public int Threads { get; set; } 51 | public string RealDNSName { get; set; } 52 | public string OutputPrefix { get; set; } 53 | public string OutputDirectory { get; set; } 54 | public int Throttle { get; set; } 55 | public int Jitter { get; set; } 56 | public int PortScanTimeout { get; set; } = 500; 57 | public CancellationTokenSource CancellationTokenSource { get; set; } 58 | public ILDAPUtils LDAPUtils { get; set; } 59 | public Task CollectionTask { get; set; } 60 | public Flags Flags { get; set; } 61 | 62 | public void UpdateLoopTime() 63 | { 64 | CurrentLoopTime = $"{DateTime.Now:yyyyMMddHHmmss}"; 65 | } 66 | 67 | public async Task DoDelay() 68 | { 69 | if (Throttle == 0) 70 | return; 71 | 72 | if (Jitter == 0) 73 | { 74 | await Task.Delay(Throttle); 75 | return; 76 | } 77 | 78 | var percent = (int)Math.Floor((double)(Jitter * (Throttle / 100))); 79 | var delay = Throttle + RandomGen.Value.Next(-percent, percent); 80 | await Task.Delay(delay); 81 | } 82 | 83 | public string GetCachePath() 84 | { 85 | var cacheFileName = CacheFileName ?? $"{ClientHelpers.GetBase64MachineID()}.bin"; 86 | var path = Path.Combine(OutputDirectory, cacheFileName); 87 | return path; 88 | } 89 | 90 | public ResolvedCollectionMethod SetupMethodsForLoop() 91 | { 92 | var original = ResolvedCollectionMethods; 93 | const ResolvedCollectionMethod computerCollectionMethods = 94 | ResolvedCollectionMethod.LocalGroups | ResolvedCollectionMethod.LoggedOn | 95 | ResolvedCollectionMethod.Session; 96 | return original & computerCollectionMethods; 97 | } 98 | 99 | public string ResolveFileName(string filename, string extension, bool addTimestamp) 100 | { 101 | var finalFilename = filename; 102 | if (!filename.EndsWith(extension)) 103 | finalFilename = $"{filename}.{extension}"; 104 | 105 | if (extension is "json" or "zip" && Flags.RandomizeFilenames) 106 | finalFilename = $"{Path.GetRandomFileName()}"; 107 | 108 | if (addTimestamp) finalFilename = $"{CurrentLoopTime}_{finalFilename}"; 109 | 110 | /* 111 | if (OutputPrefix != null) finalFilename = $"{OutputPrefix}_{finalFilename}"; 112 | 113 | var finalPath = Path.Combine(OutputDirectory, finalFilename); 114 | */ 115 | return finalFilename; 116 | } 117 | 118 | public string[] Domains { get; set; } 119 | 120 | // // TODO: override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources 121 | // ~Context() 122 | // { 123 | // // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method 124 | // Dispose(disposing: false); 125 | // } 126 | 127 | /// 128 | /// TODO: Implement the primary dispose pattern 129 | /// 130 | public void Dispose() 131 | { 132 | // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method 133 | Dispose(true); 134 | GC.SuppressFinalize(this); 135 | } 136 | 137 | /// 138 | /// TODO: Implement the primary dispose pattern 139 | /// 140 | /// 141 | private void Dispose(bool disposing) 142 | { 143 | if (!disposedValue) 144 | { 145 | if (disposing) 146 | { 147 | // TODO: dispose managed state (managed objects) 148 | } 149 | 150 | // TODO: free unmanaged resources (unmanaged objects) and override finalizer 151 | // TODO: set large fields to null 152 | disposedValue = true; 153 | } 154 | } 155 | } 156 | } 157 | -------------------------------------------------------------------------------- /src/Client/Context.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Threading; 5 | using System.Threading.Tasks; 6 | using Microsoft.Extensions.Logging; 7 | using SharpHoundCommonLib; 8 | using SharpHoundCommonLib.Enums; 9 | using Timer = System.Timers.Timer; 10 | 11 | namespace Sharphound.Client 12 | { 13 | internal class FileExistsException : Exception 14 | { 15 | public FileExistsException(string message) : base(message) 16 | { 17 | } 18 | } 19 | 20 | public static class ContextUtils 21 | { 22 | public static Dictionary Merge(this Dictionary dict, 23 | Dictionary delta) 24 | { 25 | return dict.Concat(delta).ToDictionary(kvp => kvp.Key, kvp => kvp.Value); 26 | } 27 | } 28 | 29 | public interface IContext 30 | { 31 | Flags Flags { get; set; } 32 | string LdapFilter { get; set; } 33 | string SearchBase { get; set; } 34 | string DomainName { get; set; } 35 | string CacheFileName { get; set; } 36 | string ZipFilename { get; set; } 37 | string ZipPassword { get; set; } 38 | Timer Timer { get; set; } 39 | TimeSpan LoopDuration { get; set; } 40 | TimeSpan LoopInterval { get; set; } 41 | DateTime LoopEnd { get; set; } 42 | string CurrentUserName { get; set; } 43 | int StatusInterval { get; set; } 44 | int Threads { get; set; } 45 | string RealDNSName { get; set; } 46 | Task CollectionTask { get; set; } 47 | CancellationTokenSource CancellationTokenSource { get; set; } 48 | 49 | ILogger Logger { get; set; } 50 | ILDAPUtils LDAPUtils { get; set; } 51 | 52 | string OutputPrefix { get; set; } 53 | string OutputDirectory { get; set; } 54 | 55 | string ComputerFile { get; set; } 56 | 57 | int Throttle { get; set; } 58 | int Jitter { get; set; } 59 | int PortScanTimeout { get; set; } 60 | 61 | ResolvedCollectionMethod ResolvedCollectionMethods { get; set; } 62 | 63 | /// 64 | /// Does throttle and jitter for computer requests 65 | /// 66 | /// 67 | Task DoDelay(); 68 | 69 | string GetCachePath(); 70 | ResolvedCollectionMethod SetupMethodsForLoop(); 71 | string ResolveFileName(string filename, string extension, bool addTimestamp); 72 | string[] Domains { get; set; } 73 | void UpdateLoopTime(); 74 | } 75 | } -------------------------------------------------------------------------------- /src/Client/Enums.cs: -------------------------------------------------------------------------------- 1 | namespace Sharphound.Client 2 | { 3 | /// 4 | /// Enums representing the possible collection methods specified in options 5 | /// 6 | public enum CollectionMethodOptions 7 | { 8 | None, 9 | Group, 10 | Session, 11 | LoggedOn, 12 | Trusts, 13 | ACL, 14 | ObjectProps, 15 | RDP, 16 | DCOM, 17 | LocalAdmin, 18 | PSRemote, 19 | SPNTargets, 20 | Container, 21 | GPOLocalGroup, 22 | LocalGroup, 23 | Default, 24 | DCOnly, 25 | ComputerOnly, 26 | All 27 | } 28 | } -------------------------------------------------------------------------------- /src/Client/Flags.cs: -------------------------------------------------------------------------------- 1 | namespace Sharphound.Client 2 | { 3 | public class Flags 4 | { 5 | public bool Stealth { get; set; } 6 | public bool InitialCompleted { get; set; } 7 | public bool NeedsCancellation { get; set; } 8 | public bool Loop { get; set; } 9 | public bool IsFaulted { get; set; } 10 | public bool NoOutput { get; set; } 11 | public bool RandomizeFilenames { get; set; } 12 | public bool MemCache { get; set; } 13 | public bool NoZip { get; set; } 14 | public bool InvalidateCache { get; set; } 15 | public bool SecureLDAP { get; set; } 16 | public bool DisableKerberosSigning { get; set; } 17 | public bool SkipPortScan { get; set; } 18 | public bool SkipPasswordAgeCheck { get; set; } 19 | public bool ExcludeDomainControllers { get; set; } 20 | public bool NoRegistryLoggedOn { get; set; } 21 | public bool DumpComputerStatus { get; set; } 22 | public bool CollectAllProperties { get; set; } 23 | public bool DCOnly { get; set; } 24 | public bool PrettyPrint { get; set; } 25 | public bool SearchForest { get; set; } 26 | } 27 | } -------------------------------------------------------------------------------- /src/Client/Links.cs: -------------------------------------------------------------------------------- 1 | using System.Threading.Tasks; 2 | using SharpHoundCommonLib; 3 | 4 | namespace Sharphound.Client 5 | { 6 | /// 7 | /// Chain of custody pattern execution steps 8 | /// 9 | /// A context to be populated. 10 | public interface Links 11 | { 12 | IContext Initialize(IContext context, LDAPConfig options); 13 | 14 | IContext 15 | TestConnection( 16 | T context); //Initial LDAP connection test. Search for the well known administrator SID to make sure we can connect successfully. 17 | 18 | IContext SetSessionUserName(string overrideUserName, T context); 19 | IContext InitCommonLib(T context); 20 | IContext GetDomainsForEnumeration(T context); 21 | IContext StartBaseCollectionTask(T context); 22 | Task AwaitBaseRunCompletion(T context); 23 | IContext StartLoopTimer(T context); 24 | IContext StartLoop(T context); 25 | Task AwaitLoopCompletion(T context); 26 | IContext DisposeTimer(T context); 27 | IContext SaveCacheFile(T context); 28 | IContext Finish(T context); 29 | } 30 | } -------------------------------------------------------------------------------- /src/CobaltRunner.cs: -------------------------------------------------------------------------------- 1 | 2 | using System; 3 | using System.Collections.Generic; 4 | using System.IO; 5 | using System.Linq; 6 | using System.Text; 7 | using System.Threading; 8 | using System.Threading.Tasks; 9 | using BOFNET; 10 | 11 | // Original idea & implementation by https://github.com/williamknows/SharpHound3/ 12 | 13 | namespace Sharphound 14 | { 15 | class CobaltRunner : BeaconObject 16 | { 17 | volatile static ProducerConsumerStream memStream = new ProducerConsumerStream(); 18 | public volatile static CobaltRunner Instance = null; 19 | public volatile static bool RunThread; 20 | public volatile static Mutex mutex = new Mutex(); 21 | 22 | public CobaltRunner(BeaconApi api) : base(api) 23 | { 24 | 25 | } 26 | 27 | public override void Go(string[] args) 28 | { 29 | try 30 | { 31 | // Redirect stdout to MemoryStream 32 | StreamWriter memStreamWriter = new StreamWriter(memStream); 33 | memStreamWriter.AutoFlush = true; 34 | Console.SetOut(memStreamWriter); 35 | Console.SetError(memStreamWriter); 36 | 37 | // Add reference to BeaconObject for OutputTasks 38 | Instance = this; 39 | 40 | // Start thread to check MemoryStream to send data to Beacon 41 | RunThread = true; 42 | Thread runtimeWriteLine = new Thread(() => RuntimeWriteLine()); 43 | runtimeWriteLine.Start(); 44 | 45 | // Run main program passing original arguments 46 | Task.Run(() => Sharphound.Program.Main(args)).GetAwaiter().GetResult(); // < .NET 4.5 47 | // Sharphound.Program.Main(args); 48 | 49 | // Trigger safe exit of thread, ensuring MemoryStream is emptied too 50 | RunThread = false; 51 | runtimeWriteLine.Join(); 52 | } 53 | catch (Exception ex) 54 | { 55 | BeaconConsole.WriteLine(String.Format("[!] BOF.NET Exception: {0}.", ex)); 56 | } 57 | //*/ 58 | } 59 | 60 | public void PassDownloadFile(string filename, ref MemoryStream fileStream) 61 | { 62 | mutex.WaitOne(); 63 | try 64 | { 65 | DownloadFile(filename, fileStream); 66 | } 67 | catch (Exception ex) 68 | { 69 | BeaconConsole.WriteLine(String.Format("[!] BOF.NET Exception during DownloadFile(): {0}.", ex)); 70 | } 71 | mutex.ReleaseMutex(); 72 | } 73 | 74 | public static void RuntimeWriteLine() 75 | { 76 | bool LastCheck = false; 77 | while (RunThread == true || LastCheck == true) 78 | { 79 | int offsetWritten = 0; 80 | int currentCycleMemstreamLength = Convert.ToInt32(memStream.Length); 81 | if (currentCycleMemstreamLength > offsetWritten) 82 | { 83 | mutex.WaitOne(); 84 | try 85 | { 86 | var byteArrayRaw = new byte[currentCycleMemstreamLength]; 87 | int count = memStream.Read(byteArrayRaw, offsetWritten, currentCycleMemstreamLength); 88 | 89 | if (count > 0) 90 | { 91 | // Need to stop at last new line otherwise it will run into encoding errors in the Beacon logs. 92 | int lastNewLine = 0; 93 | for (int i = 0; i < byteArrayRaw.Length; i++) 94 | { 95 | if (byteArrayRaw[i] == '\n') 96 | { 97 | lastNewLine = i; 98 | } 99 | } 100 | if (LastCheck) 101 | { 102 | // If last run ensure all remaining MemoryStream data is obtained. 103 | lastNewLine = currentCycleMemstreamLength; 104 | } 105 | if (lastNewLine > 0) 106 | { 107 | var byteArrayToLastNewline = new byte[lastNewLine]; 108 | Buffer.BlockCopy(byteArrayRaw, 0, byteArrayToLastNewline, 0, lastNewLine); 109 | Instance.BeaconConsole.WriteLine(Encoding.ASCII.GetString(byteArrayToLastNewline)); 110 | offsetWritten = offsetWritten + lastNewLine; 111 | } 112 | } 113 | } 114 | catch (Exception ex) 115 | { 116 | Instance.BeaconConsole.WriteLine(ex); 117 | } 118 | mutex.ReleaseMutex(); 119 | } 120 | Thread.Sleep(50); 121 | if (LastCheck) 122 | { 123 | break; 124 | } 125 | if (RunThread == false && LastCheck == false) 126 | { 127 | LastCheck = true; 128 | } 129 | } 130 | } 131 | } 132 | 133 | // Code taken from Polity at: https://stackoverflow.com/questions/12328245/memorystream-have-one-thread-write-to-it-and-another-read 134 | // Provides means to have multiple threads reading and writing from and to the same MemoryStream 135 | public class ProducerConsumerStream : Stream 136 | { 137 | private readonly MemoryStream innerStream; 138 | private long readPosition; 139 | private long writePosition; 140 | 141 | public ProducerConsumerStream() 142 | { 143 | innerStream = new MemoryStream(); 144 | } 145 | 146 | public override bool CanRead { get { return true; } } 147 | 148 | public override bool CanSeek { get { return false; } } 149 | 150 | public override bool CanWrite { get { return true; } } 151 | 152 | public override void Flush() 153 | { 154 | lock (innerStream) 155 | { 156 | innerStream.Flush(); 157 | } 158 | } 159 | 160 | public override long Length 161 | { 162 | get 163 | { 164 | lock (innerStream) 165 | { 166 | return innerStream.Length; 167 | } 168 | } 169 | } 170 | 171 | public override long Position 172 | { 173 | get { throw new NotSupportedException(); } 174 | set { throw new NotSupportedException(); } 175 | } 176 | 177 | public override int Read(byte[] buffer, int offset, int count) 178 | { 179 | lock (innerStream) 180 | { 181 | innerStream.Position = readPosition; 182 | int red = innerStream.Read(buffer, offset, count); 183 | readPosition = innerStream.Position; 184 | 185 | return red; 186 | } 187 | } 188 | 189 | public override long Seek(long offset, SeekOrigin origin) 190 | { 191 | throw new NotSupportedException(); 192 | } 193 | 194 | public override void SetLength(long value) 195 | { 196 | throw new NotImplementedException(); 197 | } 198 | 199 | public override void Write(byte[] buffer, int offset, int count) 200 | { 201 | lock (innerStream) 202 | { 203 | innerStream.Position = writePosition; 204 | innerStream.Write(buffer, offset, count); 205 | writePosition = innerStream.Position; 206 | } 207 | } 208 | } 209 | } 210 | -------------------------------------------------------------------------------- /src/Extensions.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Runtime.CompilerServices; 5 | using System.Threading; 6 | using System.Threading.Channels; 7 | using SharpHoundCommonLib; 8 | using SharpHoundCommonLib.Enums; 9 | 10 | namespace Sharphound 11 | { 12 | public static class Extensions 13 | { 14 | internal static void Merge(this Dictionary s, Dictionary other) 15 | { 16 | if (s == null || other == null) 17 | return; 18 | 19 | foreach (var k in other.Where(k => !s.ContainsKey(k.Key))) 20 | { 21 | if (s.ContainsKey(k.Key)) continue; 22 | s.Add(k.Key, k.Value); 23 | } 24 | } 25 | 26 | public static string GetDNSName(this ISearchResultEntry entry, string overrideDNSName) 27 | { 28 | var shortName = entry.GetProperty("samaccountname")?.TrimEnd('$'); 29 | var dns = entry.GetProperty("dnshostname"); 30 | var cn = entry.GetProperty("cn"); 31 | 32 | if (dns != null) 33 | return dns; 34 | if (shortName == null && cn == null) 35 | return $"UNKNOWN.{overrideDNSName}"; 36 | if (shortName != null) 37 | return $"{shortName}.{overrideDNSName}"; 38 | return $"{cn}.{overrideDNSName}"; 39 | } 40 | 41 | //Taken from https://stackoverflow.com/questions/5542816/printing-flags-enum-as-separate-flags 42 | public static IEnumerable GetFlags(this Enum value) 43 | { 44 | return GetFlags(value, Enum.GetValues(value.GetType()).Cast().ToArray()); 45 | } 46 | 47 | public static IEnumerable GetIndividualFlags(this Enum value) 48 | { 49 | return GetFlags(value, GetFlagValues(value.GetType()).ToArray()); 50 | } 51 | 52 | private static IEnumerable GetFlags(Enum value, Enum[] values) 53 | { 54 | var bits = Convert.ToUInt64(value); 55 | var results = new List(); 56 | for (var i = values.Length - 1; i >= 0; i--) 57 | { 58 | var mask = Convert.ToUInt64(values[i]); 59 | if (i == 0 && mask == 0L) 60 | break; 61 | if ((bits & mask) == mask) 62 | { 63 | results.Add(values[i]); 64 | bits -= mask; 65 | } 66 | } 67 | 68 | if (bits != 0L) 69 | return Enumerable.Empty(); 70 | if (Convert.ToUInt64(value) != 0L) 71 | return results.Reverse(); 72 | if (bits == Convert.ToUInt64(value) && values.Length > 0 && Convert.ToUInt64(values[0]) == 0L) 73 | return values.Take(1); 74 | return Enumerable.Empty(); 75 | } 76 | 77 | private static IEnumerable GetFlagValues(Type enumType) 78 | { 79 | ulong flag = 0x1; 80 | foreach (var value in Enum.GetValues(enumType).Cast()) 81 | { 82 | var bits = Convert.ToUInt64(value); 83 | if (bits == 0L) 84 | //yield return value; 85 | continue; // skip the zero value 86 | while (flag < bits) flag <<= 1; 87 | if (flag == bits) 88 | yield return value; 89 | } 90 | } 91 | 92 | internal static async IAsyncEnumerable ReadAllAsync(this ChannelReader channel, 93 | [EnumeratorCancellation] CancellationToken cancellationToken = default) 94 | { 95 | while (await channel.WaitToReadAsync(cancellationToken).ConfigureAwait(false)) 96 | while (channel.TryRead(out var item)) 97 | yield return item; 98 | } 99 | 100 | /// 101 | /// Removes non-computer collection methods from specified ones for looping 102 | /// 103 | /// 104 | internal static ResolvedCollectionMethod GetLoopCollectionMethods(this ResolvedCollectionMethod methods) 105 | { 106 | const ResolvedCollectionMethod computerCollectionMethods = ResolvedCollectionMethod.LocalGroups | ResolvedCollectionMethod.LoggedOn | 107 | ResolvedCollectionMethod.Session; 108 | return methods & computerCollectionMethods; 109 | } 110 | } 111 | } -------------------------------------------------------------------------------- /src/JsonExtensions.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Reflection; 5 | using Newtonsoft.Json; 6 | using Newtonsoft.Json.Serialization; 7 | using SharpHoundCommonLib; 8 | using SharpHoundCommonLib.Enums; 9 | 10 | namespace Sharphound 11 | { 12 | public class CacheContractResolver : DefaultContractResolver 13 | { 14 | private static readonly CacheContractResolver Instance = new(); 15 | public static readonly JsonSerializerSettings Settings = new() 16 | { 17 | ContractResolver = Instance 18 | }; 19 | 20 | protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization) 21 | { 22 | var prop = base.CreateProperty(member, memberSerialization); 23 | if (!prop.Writable && (member as PropertyInfo)?.GetSetMethod(true) != null) { 24 | prop.Writable = true; 25 | } 26 | return prop; 27 | } 28 | } 29 | 30 | public class KindConvertor : JsonConverter