-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathBloodHoundOperator.ps1
5077 lines (4725 loc) · 190 KB
/
BloodHoundOperator.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
## BloodHoundOperator
# Thursday, March 13, 2025 9:07:23 AM
# > Add NTLM Edges
# > Add Limited OwnerShip Edges
################################################################
## BloodHound Operator - BHComposer (BHCE Only)
# New-BHComposer
# Invoke-BHComposer
# Get-BHComposer
# Get-BHComposerLog
################################################ New-BHComposer
<#
.SYNOPSIS
New BloodHound Composer
.DESCRIPTION
Download BloodHound docker-compose files
.EXAMPLE
New-BHComposer $FolderLocation
#>
function New-BHComposer{
Param(
[Parameter(Mandatory=0)][String]$ComposerFolder=$pwd,
[Parameter(Mandatory=0)][Switch]$IncludeEnv,
[Parameter(Mandatory=0)][Switch]$IncludeConfig
)
if(-Not(Test-Path $ComposerFolder)){$Null = mkdir $ComposerFolder}
# Docker Compose
irm https://ghst.ly/getbhce | out-file "$ComposerFolder/docker-compose.yml"
# Docker env
if($IncludeEnv){
irm https://raw.githubusercontent.com/SpecterOps/BloodHound/main/examples/docker-compose/.env.example | out-file "$ComposerFolder/.env.example"
}
# BH Config
if($IncludeConfig){
irm https://raw.githubusercontent.com/SpecterOps/BloodHound/main/examples/docker-compose/bloodhound.config.json | out-file "$ComposerFolder/bloodhound.config.json"
}}
#####End
################################################ Invoke-BHComposer
<#
.SYNOPSIS
Invoke BloodHound Composer
.DESCRIPTION
Invoke BloodHound docker-compose commands
.EXAMPLE
Invoke-BHComposer Up
#>
function Invoke-BHComposer{
[Alias('BHComposer')]
Param(
[ValidateSet('Status','Up','Start','Pause','Resume','Stop','Down','Update','KillNeo','KillAll')]
[Parameter(Mandatory=0,Position=0,ParameterSetName='Action')][String]$Action='Status',
[Parameter(Mandatory=1,ParameterSetName='Command')][String]$Command,
[Parameter(Mandatory=0)][String]$ComposerFolder=$pwd,
[Parameter(Mandatory=0,ParameterSetName='Action')][Switch]$Force
)
# Action
if($PSCmdlet.ParameterSetName -eq 'Action'){
$Project = split-path $ComposerFolder -leaf
Switch($Action){
Status {docker compose $Composer ps --format json | Convertfrom-JSON}
Up {docker compose $Composer up}
Start {docker compose $Composer start}
Pause {docker compose $Composer pause}
Resume {docker compose $Composer unpause}
Stop {docker compose $Composer stop}
Down {if($Force -OR $(Confirm-Action "Remove $Project [Keep volumes]")){
docker compose $Composer down
}}
Update {if($Force -OR $(Confirm-Action "Update $Project to latest build - Keep volumes")){
docker compose $Composer down
docker compose $Composer pull
docker compose $Composer up
}}
KillNeo{if($Force -OR $(Confirm-Action "Remove $Project - Neo4j data only")){
$Project= $Project.ToLower()
docker volume rm ${Project}_neo4j-data
}}
KillAll{if($Force -OR $(Confirm-Action "Remove $Project - Remove volumes")){
docker compose $Composer down -v
}}}}
# Command ##
else{docker compose $Composer $Command}
}
#End
################################################ Get-BHComposer
<#
.SYNOPSIS
Get BloodHound Composer
.DESCRIPTION
View Composer status
View BloodHound docker-compose files content
.EXAMPLE
Get-BHComposer
#>
Function Get-BHComposer{
[CmdletBinding(DefaultParameterSetName='status')]
Param(
[Parameter(Mandatory=1,ParameterSetName='Composer')][Switch]$Composer,
[Parameter(Mandatory=1,ParameterSetName='Env')][Switch]$Env,
[Parameter(Mandatory=1,ParameterSetName='Config')][Switch]$Config,
[Parameter(Mandatory=0)]$ComposerFolder=$pwd
)
Switch($PSCmdlet.ParameterSetName){
status {docker compose ps --format json | Convertfrom-JSON}
Composer {get-content $ComposerFolder/docker-compose.yml}
env {get-content $ComposerFolder/.env}
Config {get-content $ComposerFolder/bloodhound.config}
}}
#####End
################################################ Get-BHComposerLog
<#
.SYNOPSIS
Get BloodHound Composer Logs
.DESCRIPTION
Get BloodHound Composer Logs
.EXAMPLE
BHLog -TraceObject | select time,status,message
#>
Function Get-BHComposerLog{
[Alias('BHLog')]
[CmdletBinding(DefaultParameterSetName='obj')]
Param(
[Parameter(Mandatory=0)][Alias('Latest')][string]$Limit='all',
[Parameter(Mandatory=1,ParameterSetName='Trace')][Switch]$Trace,
[Parameter(Mandatory=1,ParameterSetName='TraceObject')][Switch]$TraceObject,
[Parameter(Mandatory=0)]$ComposerFolder=$pwd
)
Switch($PSCmdlet.ParameterSetName){
TraceObject{$Ago = [DateTime]::utcnow.ToString('o')
while($true){
docker compose logs --since $Ago --no-log-prefix bloodhound | Convertfrom-JSON | sort-object time -descending
$Ago = [DateTime]::utcnow.ToString('o')
Start-Sleep -seconds 1
}}
Trace {docker compose logs -f bloodhound}
Default {docker compose logs -n $Limit --no-log-prefix bloodhound | Convertfrom-JSON}
}}
#####End
## BloodHound Operator - BHAPI
# Get-BHAPI
# Invoke-BHAPI
################################################ Get-BHAPI
<#
.Synopsis
Get BloodHound API Info
.DESCRIPTION
Return BloodHound API Info as objects
.EXAMPLE
Get-BHAPI
.EXAMPLE
Get-BHAPI | select-object method,route,summary | sort-object route
#>
Function Get-BHAPI{
[Alias('BHAPIInfo')]
Param()
foreach ($APIObj in (invoke-BHAPI "api/v2/swagger/doc.json").paths){
foreach($Route in ($APIObj | GM | ? MemberType -eq NoteProperty).name){
foreach($Meth in (($APIObj.$Route | gm | ? Membertype -eq Noteproperty).name | ?{$_ -ne 'parameters'})){
$RouteData = $APIObj.$Route.$Meth
[PSCustomObject]@{
Route = $Route
Method = $Meth
Deprecated = $RouteData.Deprecated
Tag = $RouteData.tags
Data = $RouteData
Summary = $RouteData.Summary
Description = $RouteData.description
Parameters = $RouteData.parameters
Consumes = $RouteData.consumes
ParamInfo = $APIObj.$Route.Parameters
}}}}}
#################End
################################################ Invoke-BHAPI
<#
function Invoke-BHAPI{
[Alias('BHAPI')]
param(
# URI
[Parameter(Mandatory=1)][String]$URI,
# Method
[ValidateSet('GET','POST','PATCH','PUT','DELETE')]
[Parameter(Mandatory=0)][String]$Method='GET',
# Body
[Parameter(Mandatory=0)][String]$Body,
# Session
[Parameter(Mandatory=0)][int[]]$SessionID=($BHSession | ? x).id,
# Timeout
[Parameter(Mandatory=0)][Alias('Prefer')][int]$Timeout,
# Expand
[Parameter(Mandatory=0)][Alias('Dot')][String]$Expand
)
begin{
if(-Not$SessionID){Write-Warning "No BHSession: Use New-BHSession or Select-BHSession";Break}
if($URI -match "^/"){$URI=$URI.trimstart('/')}
if($URI -notmatch "^api/"){$URI='api/v2/'+$URI}
}
process{foreach($SessID in $SessionID){
# Session
$Session = $BHSession | ? ID -eq $SessID
$Proto = $Session.Protocol
$Server = $Session.Server
$Port = $Session.Port
$TokenID = $Session.TokenID
$TokenKey = $Session.Token | Read-SecureString
if(-Not$TimeOut){$Timeout=($BHSession | ? id -eq $SessID).timeout}
# Signature
$Timestamp = [Datetime]::utcnow.tostring('o')
$KeyByte = [Text.Encoding]::UTF8.GetBytes($TokenKey)
$OpByte = [Text.Encoding]::UTF8.GetBytes("$Method/$URI")
$DateByte = [Text.Encoding]::UTF8.GetBytes(-join $Timestamp[0..12])
$BodyByte = [Text.Encoding]::UTF8.GetBytes("$Body")
$HMAC = [Security.Cryptography.HMACSHA256]::new($KeyByte).ComputeHash($OpByte)
$HMAC = [Security.Cryptography.HMACSHA256]::new($HMAC).ComputeHash($DateByte)
$HMAC = [Security.Cryptography.HMACSHA256]::new($HMAC).ComputeHash($BodyByte)
$Sign = [Convert]::ToBase64String($HMAC)
# Headers
$Headers = @{
Authorization = "BHESignature $TokenID"
Signature = $Sign
RequestDate = $Timestamp
}
if($Timeout){$Headers.add('Prefer',$Timeout)}
# Verbose
Write-verbose "[BH] $Method $URI"
if($Body){Write-Verbose "$Body"}
# Params
if($Port){$Server="${server}:${Port}"}
$Params = @{
Uri = "${Proto}://${Server}/${URI}"
ContentType = 'application/json'
Method = $Method
Headers = $Headers
UserAgent = 'PowerShell BloodHound Operator'
}
#Write-Verbose $Params.Uri
# Body
#if($Method -eq 'POST' -AND $uri -match 'api/v2/saml/providers'){$Param['ContentType']='multipart/form'}
if($Body){$Params.Add('Body',"$Body")}
# Call
try{$Reply = Invoke-RestMethod @Params -verbose:$false -UseBasicParsing}catch{Get-ErrorWarning;Break}
# Output
if($Expand){foreach($Dot in $Expand.split('.')){try{$Reply=$Reply.$Dot}Catch{}}}
$Reply
}}
end{}###
}
#End
#>
<#
function Invoke-BHAPI{
[Alias('BHAPI')]
param(
# URI
[Parameter(Mandatory=1)][String]$URI,
# Method
[ValidateSet('GET','POST','PATCH','PUT','DELETE')]
[Parameter(Mandatory=0)][String]$Method='GET',
# Body
[Parameter(Mandatory=0)][String]$Body,
# FIlters
[Parameter(Mandatory=0)][String[]]$Filter,
# Session
[Parameter(Mandatory=0)][int[]]$SessionID=($BHSession | ? x).id,
# Timeout
[Parameter(Mandatory=0)][Alias('Prefer')][int]$Timeout,
# Expand
[Parameter(Mandatory=0)][Alias('Dot')][String]$Expand
)
begin{
if(-Not$SessionID){Write-Warning "No BHSession found: Use New-BHSession [Help New-BHSession]";Break}
if($URI -match "^/"){$URI=$URI.trimstart('/')}
if($URI -notmatch "^api/"){$URI='api/v2/'+$URI}
if($filter){$qFilter = '?'+$($Filter.replace(' ','+')-join'&')
$qfilter=[uri]::EscapeUriString($qFilter)
$URI=$URI+$qfilter
}
}
process{foreach($SessID in $SessionID){
# Session
$Session = $BHSession | ? ID -eq $SessID
$Proto = $Session.Protocol
$Server = $Session.Server
$Port = $Session.Port
$TokenID = $Session.TokenID
$TokenKey = $Session.Token | Read-SecureString
if(-Not$TimeOut){$Timeout=($BHSession | ? id -eq $SessID).timeout}
# Signature
$Timestamp = [Datetime]::utcnow.tostring('o')
$KeyByte = [Text.Encoding]::UTF8.GetBytes($TokenKey)
$OpByte = [Text.Encoding]::UTF8.GetBytes("$Method/$URI")
$DateByte = [Text.Encoding]::UTF8.GetBytes(-join $Timestamp[0..12])
$BodyByte = [Text.Encoding]::UTF8.GetBytes("$Body")
$HMAC = [Security.Cryptography.HMACSHA256]::new($KeyByte).ComputeHash($OpByte)
$HMAC = [Security.Cryptography.HMACSHA256]::new($HMAC).ComputeHash($DateByte)
$HMAC = [Security.Cryptography.HMACSHA256]::new($HMAC).ComputeHash($BodyByte)
$Sign = [Convert]::ToBase64String($HMAC)
# Headers
$Headers = @{
Authorization = "BHESignature $TokenID"
Signature = $Sign
RequestDate = $Timestamp
}
if($Timeout -ne $Null){$Headers.add('Prefer',$Timeout)}
# Verbose
Write-verbose "[BH] $Method $URI"
if($Body){Write-Verbose "$Body"}
# Params
if($Port){$Server="${server}:${Port}"}
$Params = @{
Uri = "${Proto}://${Server}/${URI}"
ContentType = if($Method -eq 'POST' -AND $uri -match "saml/providers$"){'multipart/form-data'}else{'application/json'}
Method = $Method
Headers = $Headers
UserAgent = 'PowerShell BloodHound Operator'
}
# Body
if($Body){$Params.Add('Body',"$Body")}
# Call
try{$Reply = Invoke-RestMethod @Params -verbose:$false -UseBasicParsing}catch{Get-ErrorWarning;Break}
# Output
if($Expand){foreach($Dot in $Expand.split('.')){try{$Reply=$Reply.$Dot}Catch{}}}
if(($BHSession|? x).count -gt 1 -AND $reply.gettype().name -ne 'string'){$Reply|%{
$_|Add-Member -MemberType NoteProperty -Name SessionID -Value $SessID -PassThru | select SessionID,* -ea 0
}}
else{$Reply}
}}
end{}###
}
#End
#>
<#
.Synopsis
Invoke BloodHound API call
.DESCRIPTION
Invoke-RestMethod to Bloodhound API against BHSession
.EXAMPLE
Invoke-BHAPI /api/version | Select-Object -ExpandProperty data | Select-Object -ExpandProperty server_version
.EXAMPLE
bhapi api/version -expand data.server_version
.EXAMPLE
BHAPI bloodhound-users POST $Json
#>
function Invoke-BHAPI{
[Alias('BHAPI')]
param(
# URI
[Parameter(Mandatory=1)][String]$URI,
# Method
[ValidateSet('GET','POST','PATCH','PUT','DELETE')]
[Parameter(Mandatory=0)][String]$Method='GET',
# Body
[Parameter(Mandatory=0)][String]$Body,
# FIlters
[Parameter(Mandatory=0)][String[]]$Filter,
# Session
[Parameter(Mandatory=0)][int[]]$SessionID=($BHSession | ? x).id,
# Timeout
[Parameter(Mandatory=0)][Alias('Prefer')][int]$Timeout,
# Expand
[Parameter(Mandatory=0)][Alias('Dot')][String]$Expand
)
begin{
if(-Not$SessionID){Write-Warning "No BHSession found: Use New-BHSession [Help New-BHSession]";Break}
if($URI -match "^/"){$URI=$URI.trimstart('/')}
if($URI -notmatch "^api/"){$URI='api/v2/'+$URI}
if($filter){$qFilter = '?'+$($Filter.replace(' ','+')-join'&')
$qfilter=[uri]::EscapeUriString($qFilter)
$qFilter=$qfilter.trimend('&')
$URI=$URI+$qfilter
}
}
process{foreach($SessID in $SessionID){
# Session
$Session = $BHSession | ? ID -eq $SessID
$Proto = $Session.Protocol
$Server = $Session.Server
$Port = $Session.Port
if(-Not$TimeOut){$Timeout=($BHSession | ? id -eq $SessID).timeout}
## TokenID/TokenKey
if($Session.tokenID -ne 'JWT'){
$TokenID = $Session.TokenID
$TokenKey = $Session.Token | Read-SecureString
# Signature
$Timestamp = [Datetime]::utcnow.tostring('o')
$KeyByte = [Text.Encoding]::UTF8.GetBytes($TokenKey)
$OpByte = [Text.Encoding]::UTF8.GetBytes("$Method/$URI")
$DateByte = [Text.Encoding]::UTF8.GetBytes(-join $Timestamp[0..12])
$BodyByte = [Text.Encoding]::UTF8.GetBytes("$Body")
$HMAC = [Security.Cryptography.HMACSHA256]::new($KeyByte).ComputeHash($OpByte)
$HMAC = [Security.Cryptography.HMACSHA256]::new($HMAC).ComputeHash($DateByte)
$HMAC = [Security.Cryptography.HMACSHA256]::new($HMAC).ComputeHash($BodyByte)
$Sign = [Convert]::ToBase64String($HMAC)
# Headers
$Headers = @{
Authorization = "BHESignature $TokenID"
Signature = $Sign
RequestDate = $Timestamp
}}
## JWT
else{$Headers = @{
Authorization = "Bearer $($Session.Token)"
}}
if($Timeout -ne $Null){$Headers.add('Prefer',"wait=$Timeout")}
## DEBUG
#RETURN $Headers
# Verbose
Write-verbose "[BH] $Method $URI"
if($Body){Write-Verbose "$Body"}
# Params
if($Port){$Server="${server}:${Port}"}
$Params = @{
Uri = "${Proto}://${Server}/${URI}"
ContentType = if($Method -eq 'POST' -AND $uri -match "saml/providers$"){'multipart/form-data'}else{'application/json'}
Method = $Method
Headers = $Headers
UserAgent = 'PowerShell BloodHound Operator'
}
# Body
if($Body){$Params.Add('Body',"$Body")}
# Call
try{$Reply = Invoke-RestMethod @Params -verbose:$false -UseBasicParsing}catch{Get-ErrorWarning;Break}
# Output
if($Expand){foreach($Dot in $Expand.split('.')){try{$Reply=$Reply.$Dot}Catch{}}}
if(($BHSession|? x).count -gt 1 -AND $reply.gettype().name -ne 'string'){$Reply|%{
$_|Add-Member -MemberType NoteProperty -Name SessionID -Value $SessID -PassThru | select SessionID,* -ea 0
}}
else{$Reply}
}}
end{}###
}
#End
## BloodHound Operator - BHSession
# New-BHSession
# Remove-BHSession
# Select-BHSession
# Get-BHSession
# Set-BHSession
<#
New-BHSession -TokenID $BHTokenID -Token $BHTokenKey
#>
###############################################################>
############################################## New-BHSession
<#
.SYNOPSIS
New BloodHound API Session
.DESCRIPTION
New BloodHound API Session
.EXAMPLE
$TokenKey = Get-Clipboard | Convertto-SecureString -AsPlainText -Force
Convert plaintext token key from clipboard to secure string variable
.EXAMPLE
New-BHSession -TokenID $TokenID -Token $TokenKey
Create a BHCE session (localhost:8080).
- $TokenKey must be secure string.
.EXAMPLE
New-BHSession -Server $Instance -TokenID $TokenID -Token $TokenKey
Create a BHE session.
- $TokenKey must be secure string.
#>
function New-BHSession{
Param(
# TokenID
[Parameter(Mandatory=1)][String]$TokenID=$(Read-Host -Prompt "Enter TokenID"),
# Token
[Parameter(Mandatory=1)][Security.SecureString]$Token=$(Read-Host -AsSecureString -Prompt "Enter Token"),
# Server
[Parameter(Mandatory=0)][String]$Server='127.0.0.1',
# Port
[Parameter(Mandatory=0)][String]$Port,
# Proto
[Parameter(Mandatory=0)][String]$Protocol,
# CypherClip
[Parameter(Mandatory=0)][Switch]$CypherClip
)
# ASCII
$ASCII= @("
_____________________________________________
_______|_____________________________________
______||_________________BloodHoundOperator__
______||-________...___________________BETA__
_______||-__--||||||||-._____________________
________!||||||||||||||||||--________________
_________|||||||||||||||||||||-______________
_________!||||||||||||||||||||||.____________
________.||||||!!||||||||||||||||-___________
_______|||!||||___||||||||||||||||.__________
______|||_.||!___.|||'_!||_'||||||!._________
_____||___!||____|||____||___|||||.__________
______||___||_____||_____||!__!|||'__________
___________ ||!____||!_______________________
_____________________________________________
BloodHound Dog Whisperer - @SadProcessor 2024
")
# Port & Proto
if($Server -match "127.0.0.1|localhost" -AND -Not$Port){$Port='8080'}
if($Server -match "127.0.0.1|localhost" -AND -Not$Protocol){$Protocol='http'}
if($Server -ne 'localhost' -AND -Not$Protocol){$Protocol='https'}
# BHFilter
if(-Not$BHFilter){$Script:BHFilter = Get-BHPathFilter -ListAll | Select Platform,Group,@{n='x';e={'x'} },Edge}
# BHSession
if(-Not$BHSession){Write-Host $ASCII -ForegroundColor Blue; $Script:BHSession=[Collections.ArrayList]@()}
# Unselect all
$BHSession|? x|%{$_.x=''}
# Session ID
$SessionID = ($BHSession.id | sort-object | Select-Object -Last 1)+1
# New Session
$NewSession = [PSCustomObject]@{
x = 'x'
ID = $SessionID
Protocol = $Protocol
Server = $Server
Port = $Port
Operator = 'tbd'
Role = 'tbd'
Edition = 'tbd'
Version = 'tbd'
Timeout = 0
Limit = 1000
CypherClip = [Bool]$PSCmdlet.MyInvocation.BoundParameters.CypherClip.IsPresent
TokenID = $TokenID
Token = $Token
}
# Add New Session
$Null = $BHSession.add($NewSession)
# Version
$vers = BHAPI 'api/version' -Expand 'data.server_version' -SessionID $SessionID -verbose:$False
if(-Not$Vers){
#($Script:BHSession | ? x).Version = Try{BHAPI 'api/version' -Expand 'data.server_version' -SessionID $SessionID -verbose:$False}Catch{
$BHSession.Remove($NewSession)
Write-Warning "Invalid Session Token - No Session Selected"
RETURN
}
else{($Script:BHSession | ? x).Version = $Vers}
# Operator
($Script:BHSession | ? x).Operator = (BHAPI "api/v2/self" -Expand 'data.principal_name' -SessionID $SessionID -verbose:$False)
# Role
($Script:BHSession | ? x).Role = (BHAPI "api/v2/self" -Expand 'data.roles' -SessionID $SessionID -verbose:$False).name
# Edition
$BHEdition = if($NewSession.server -match "\.bloodhoundenterprise\.io$"){'BHE'}else{'BHCE'}
($Script:BHSession | ? x).Edition = $BHEdition
}
#End
################################################ Remove-BHSession
<#
.SYNOPSIS
Remove BloodHound API Session
.DESCRIPTION
Remove BloodHound API Session
.EXAMPLE
Remove-BHSession
#>
function Remove-BHSession{
Param(
[Parameter(Mandatory)][int[]]$ID,
[Parameter()][Switch]$Force
)
Foreach($SessID in $ID){
if($Force -OR $(Confirm-Action "Remove BHSession ID $SessID")){$BHSession.Remove(($BHSession | ? id -eq $SessID))}}
}
#End
<#
.SYNOPSIS
New BloodHound API Session
.DESCRIPTION
New BloodHound API Session
.EXAMPLE
$TokenKey = Get-Clipboard | Convertto-SecureString -AsPlainText -Force
Convert plaintext token key from clipboard to secure string variable
.EXAMPLE
New-BHSession -TokenID $TokenID -Token $TokenKey
Create a BHCE session (localhost:8080).
- $TokenKey must be secure string.
.EXAMPLE
New-BHSession -Server $Instance -TokenID $TokenID -Token $TokenKey
Create a BHE session.
- $TokenKey must be secure string.
.EXAMPLE
New-BHSession -JWT $JWT [-Server $Instance]
Create Session with JWT
#>
function New-BHSession{
[CmdletBinding(DefaultParameterSetName='JWT')]
Param(
# TokenID
[Parameter(Mandatory=1,ParameterSetName='Token')][String]$TokenID,
# Token
[Parameter(Mandatory=1,ParameterSetName='Token')][Security.SecureString]$Token,
# JWT
[Parameter(Mandatory=1,Position=0,ParameterSetName='JWT')][String]$JWT,
# Server
[Parameter(Mandatory=0)][String]$Server='127.0.0.1',
# Port
[Parameter(Mandatory=0)][String]$Port,
# Proto
[Parameter(Mandatory=0)][String]$Protocol,
# CypherClip
[Parameter(Mandatory=0)][Switch]$CypherClip
)
# ASCII
$ASCII= @("
_____________________________________________
_______|_____________________________________
______||_________________BloodHoundOperator__
______||-________...___________________BETA__
_______||-__--||||||||-._____________________
________!||||||||||||||||||--________________
_________|||||||||||||||||||||-______________
_________!||||||||||||||||||||||.____________
________.||||||!!||||||||||||||||-___________
_______|||!||||___||||||||||||||||.__________
______|||_.||!___.|||'_!||_'||||||!._________
_____||___!||____|||____||___|||||.__________
______||___||_____||_____||!__!|||'__________
___________ ||!____||!_______________________
_____________________________________________
BloodHound Dog Whisperer - @SadProcessor 2024
")
# Server, Port & Proto
if($Server -match "127.0.0.1|localhost" -AND -Not$Port){$Port='8080'}
if($Server -match "127.0.0.1|localhost" -AND -Not$Protocol){$Protocol='http'}
if($Server -ne 'localhost' -AND -Not$Protocol){$Protocol='https'}
if($Server -match "^https://"){$Server=$Server-replace"^https\:\/\/",'';$Protocol='https'}
if($Server -match "^http://"){$Server=$Server-replace"^http\:\/\/",'';$Protocol='http'}
if($Server -notmatch "^http://|^https://" -AND $Server -notmatch "\." -AND $Server -notmatch "127.0.0.1|localhost"){
$Server+='.bloodhoundenterprise.io'
}
# BHFilter
if(-Not$BHFilter){$Script:BHFilter = Get-BHPathFilter -ListAll | Select Platform,Group,@{n='x';e={'x'} },Edge}
# BHSession
if(-Not$BHSession){Write-Host $ASCII -ForegroundColor Blue; $Script:BHSession=[Collections.ArrayList]@()}
# Unselect all
$BHSession|? x|%{$_.x=''}
# Session ID
$SessionID = ($BHSession.id | sort-object | Select-Object -Last 1)+1
# New Session
$NewSession = [PSCustomObject]@{
x = 'x'
ID = $SessionID
Protocol = $Protocol
Server = $Server
Port = $Port
Operator = 'tbd'
Role = 'tbd'
Edition = 'tbd'
Version = 'tbd'
Timeout = 0
Limit = 1000
CypherClip = [Bool]$PSCmdlet.MyInvocation.BoundParameters.CypherClip.IsPresent
TokenID = if($JWT){'JWT'}else{$TokenID}
Token = if($JWT){$JWT}else{$Token}
}
# Add New Session
$Null = $BHSession.add($NewSession)
# Version
$vers = BHAPI 'api/version' -Expand 'data.server_version' -SessionID $SessionID -verbose:$False
if(-Not$Vers){
#($Script:BHSession | ? x).Version = Try{BHAPI 'api/version' -Expand 'data.server_version' -SessionID $SessionID -verbose:$False}Catch{
#$BHSession.Remove($NewSession)
Write-Warning "Invalid Session Token - No Session Selected"
RETURN
}
else{($Script:BHSession | ? x).Version = $Vers}
# Operator
($Script:BHSession | ? x).Operator = (BHAPI "api/v2/self" -Expand 'data.principal_name' -SessionID $SessionID -verbose:$False)
# Role
($Script:BHSession | ? x).Role = (BHAPI "api/v2/self" -Expand 'data.roles' -SessionID $SessionID -verbose:$False).name
# Edition
$BHEdition = if($NewSession.server -match "\.bloodhoundenterprise\.io$"){'BHE'}else{'BHCE'}
($Script:BHSession | ? x).Edition = $BHEdition
}
#End
################################################ Select-BHSession
<#
.SYNOPSIS
Select BloodHound API Session
.DESCRIPTION
Select BloodHound API Session
.EXAMPLE
Select-BHSession 1
#>
function Select-BHSession{
[CmdletBinding(DefaultParameterSetName='ID')]
[Alias('BHSelect')]
Param(
[Parameter(Mandatory,ParameterSetName='ID',Position=0)][Alias('SessionID')][int[]]$ID,
[Parameter(Mandatory,ParameterSetName='None')][Switch]$None
)
if($None){$BHSession |? x|%{$_.x = $Null}}
Else{
# Unselect
$BHSession|? x|%{$_.x = $Null}
# Select
$BHSession|? id -in @($ID)|%{$_.x='x'}
}
}
#End
################################################ Get-BHSession
<#
.SYNOPSIS
Get BloodHound API Session
.DESCRIPTION
Get BloodHound API Session
.EXAMPLE
Get-BHSession
.EXAMPLE
Get-BHSession -Selected
#>
function Get-BHSession{
[Alias('BHSession')]
Param(
[Parameter(Mandatory=0)][Alias('Current')][Switch]$Selected
)
if($Selected){$BHSession | ? x | Select * -ExcludeProperty Token,TokenID}
else{$BHSession | Select * -ExcludeProperty Token,TokenID}
}
#End
################################################ Set-BHSession
<#
.SYNOPSIS
Set BloodHound API Session
.DESCRIPTION
Set BloodHound API Session
.EXAMPLE
Set-BHSession
#>
Function Set-BHSession{
Param(
[Parameter()][int]$Limit,
[ValidateRange(0,3600)][Parameter()][int]$Timeout,
[Parameter()][Switch]$CypherClip,
[Parameter()][Switch]$NoClip
)
if($Limit){$BHSession|? x |%{$_.Limit=$Limit}}
if($PSCmdlet.MyInvocation.BoundParameters.ContainsKey("Timeout")){
#if($Timeout -eq 0){$Timeout=30}
$BHSession|? x|%{$_.Timeout=$Timeout}
}
if($NoClip){($BHSession|? x).CypherClip=$False}
elseif($CypherClip){($BHSession|? x)|%{$_.CypherClip=$True}}
}
#End
####################################################### Experimental
<#
.SYNOPSIS
Invoke BloodHound API Session Script
.DESCRIPTION
Invoke BloodHound API Session Script
.EXAMPLE
BHScript {BHOperator -self | select principal_name} -SessionID 1,2
#>
function Invoke-BHSessionScript{
[Alias('BHScript')]
Param(
[Parameter()][ScriptBlock]$Script,
[Parameter()][int[]]$SessionID=$((BHSession|? x).id)
)
Begin{$Selected = (BHSession|? x).id}
Process{
Try{Foreach($SessID in $SessionID){
Select-BHSession -id $SessID
$res = Invoke-Command $Script -NoNewScope
If($Selected.count -gt 1){$res|Add-Member -MemberType NoteProperty -Name SessionID -Value $SessID}
$res
}}
catch{}
Finally{Select-BHSession $Selected}
}
End{Select-BHSession $Selected}
}
#End
## BloodHound Operator - BHServer
# Get-BHServer <--------------------- Removed
# Get-BHServerConfig
# Set-BHServerConfig
# Get-BHServerFeature
# Set-BHServerFeature
# Get-BHServerAuditLog
## ToDo
# Get-BHServerSAMLProvider
# New-BHServerSAMLProvider
# Remove-BHServerSAMLProvider
# Get-BHServerSAMLendpoint
################################################ BHServer
<#
function Get-BHServer{
[Alias('BHServer')]
Param(
[Parameter()]$Status='running'
)
$Status=if($Status){"-f status=$Status"}else{$Null}
try{docker ps --format json $Status| ConvertFrom-Json}catch{}
}
#End
#>
<#
.SYNOPSIS
Get BloodHound Server version
.DESCRIPTION
Get BloodHound Server version
.EXAMPLE
BHVersion
#>
function Get-BHServerVersion{
[CmdletBinding()]
[Alias('BHVersion')]
Param([Parameter()][Int[]]$SessionID=$((BHSession|? x).id))
foreach($SessID in $SessionID){
$Reply = Invoke-BHAPI "api/version" -Expand data -SessionID $SessID | select -exclude API
$ShHversion = Invoke-BHAPI "api/v2/collectors/sharphound" -Expand data.latest -SessionID $SessID
$AzHversion = Invoke-BHAPI "api/v2/collectors/azurehound" -Expand data.latest -SessionID $SessID
$Reply | Add-Member -MemberType NoteProperty -Name SharpHound -Value $ShHversion
$Reply | Add-Member -MemberType NoteProperty -Name AzureHound -Value $AzHversion
$Reply
}}
#####End
<#
function Get-BHServerVersion{
[CmdletBinding()]
[Alias('BHVersion')]
Param()
[PSCustomObject]@{
BloodHound = Invoke-BHAPI "api/version" -Expand data.server_version
SharpHound = Invoke-BHAPI "api/v2/collectors/sharphound" -Expand data.latest
AzureHound = Invoke-BHAPI "api/v2/collectors/azurehound" -Expand data.latest
}
}
#End
#>
################################################ Get-BHServerConfig
<#
.SYNOPSIS
Get BloodHound Server Config
.DESCRIPTION
Get BloodHound Server Config
.EXAMPLE
BHConfig
#>
Function Get-BHServerConfig{
[CmdletBinding()]
[Alias('BHConfig')]
Param()
Invoke-BHAPI 'api/v2/config' -expand data
}
#End
################################################ Set-BHServerConfig
<#
.SYNOPSIS
Set BloodHound Server Config
.DESCRIPTION
Set BloodHound Server Config
.EXAMPLE
Set-BHConfig -key prune.ttl -value @{base_ttl="P8D";has_session_edge_ttl="P5D"}
.EXAMPLE
Set-BHConfig -key analysis.reconciliation -value @{enabled=$true}
#>
Function Set-BHServerConfig{
[Alias('Set-BHConfig')]
Param(
[Parameter(Mandatory,ValueFromPipeline,ValueFromPipelineByPropertyName)][Alias('key')][string[]]$ConfigKey,
[Parameter(Mandatory)][HashTable]$Value
)
Begin{}
Process{Foreach($key in $ConfigKey){
$Body = @{key=$key;value=$Value}|ConvertTo-Json
Invoke-BHAPI "api/v2/config" -Method PUT -Body $Body
}}
End{}
}
#End
################################################ Get-BHServerFeature
<#
.SYNOPSIS
Get BloodHound Server Feature
.DESCRIPTION
Get BloodHound Server Feature
.EXAMPLE
BHFeature
#>
Function Get-BHServerFeature{
[CmdletBinding()]
[Alias('BHFeature')]
Param()
Invoke-BHAPI 'api/v2/features' -expand data
}
#End
################################################ Set-BHServerFeature
<#
.SYNOPSIS
Set BloodHound Server Feature
.DESCRIPTION
Set BloodHound Server Feature
.EXAMPLE
Set-BHFeature -id 1 -Enabled
#>
Function Set-BHServerFeature{
[Alias('Set-BHFeature')]
Param(
[Parameter(Mandatory,ValueFromPipeline,ValueFromPipelineByPropertyName)][Alias('ID')][int[]]$FeatureID,
[Parameter(Mandatory,ParameterSetName='Enable')][Switch]$Enabled,
[Parameter(Mandatory,ParameterSetName='Disable')][Switch]$Disabled
)
Begin{}
Process{Foreach($ID in $FeatureID){
$IsEnabled = (Get-BHServerFeature | ? ID -eq $ID).enabled
if(($PSCmdlet.ParameterSetName -eq 'Enable' -AND -Not$IsEnabled) -OR ($PSCmdlet.ParameterSetName -eq 'Disable' -AND $IsEnabled)){
Invoke-BHAPI "api/v2/features/$ID/toggle" -Method PUT
}
}}
End{}
}
#End