Updated Docs and added OpenAPI by Cx01N · Pull Request #806 · BC-SECURITY/Empire

Cx01N · 2026-01-25T19:00:11Z

Describe your changes

Issue ticket number and link (if there is one)

Checklist before requesting a review

I have performed a self-review of my code
If it is a core feature, I have added thorough tests.
I have added an entry to CHANGELOG.md
I have updated the documentation in docs/ (if applicable)

docs/.gitbook/assets/Continuous.svg

docs/.gitbook/assets/completed.svg

docs/.gitbook/assets/continious.svg

docs/.gitbook/assets/error.svg

docs/.gitbook/assets/pulled.svg

docs/.gitbook/assets/queued.svg

Co-authored-by: Vincent Rose <[email protected]>

github-actions · 2026-01-26T02:14:20Z

Coverage Report

File	Stmts	Miss	Cover	Missing
empire/server
server.py	85	59	31%	29–31, 35, 43–49, 56–69, 73–77, 81–86, 90–144
empire/server/api
app.py	112	25	78%	40–42, 46, 51–58, 64–73, 94–100, 162, 165–176
jwt_auth.py	87	10	89%	56, 58, 60, 69, 107, 111–113, 116, 135, 146
middleware.py	12	2	83%	39–40
empire/server/api/v2
shared_dto.py	62	2	97%	91, 97
empire/server/api/v2/admin
admin_api.py	15	1	93%	37
empire/server/api/v2/agent
agent_api.py	51	1	98%	97
agent_file_api.py	35	1	97%	86
agent_task_api.py	158	16	90%	218, 298–299, 330, 339, 357, 373, 393, 411, 429, 449, 469, 485, 500, 516, 522
empire/server/api/v2/listener
listener_api.py	69	4	94%	101, 106, 120, 132
listener_dto.py	52	2	96%	342, 345
listener_template_api.py	20	1	95%	60
empire/server/api/v2/obfuscation
obfuscation_api.py	72	1	99%	161
empire/server/api/v2/plugin
plugin_api.py	78	2	97%	64, 127
plugin_registry_api.py	23	1	96%	23
plugin_task_api.py	44	3	93%	35, 39, 170
empire/server/api/v2/profile
profile_api.py	47	2	96%	74, 90
empire/server/api/v2/stager
stager_dto.py	44	2	95%	248, 251
stager_template_api.py	20	1	95%	57
empire/server/api/v2/tag
tag_api.py	37	1	97%	84
empire/server/api/v2/user
user_api.py	68	3	96%	65, 148, 173
empire/server/api/v2/websocket
socketio.py	92	47	49%	34–39, 42–46, 50–62, 66–68, 80–85, 101–106, 123–128, 140–143, 155, 158, 161, 166
empire/server/common
encryption.py	248	87	65%	33, 37, 56–60, 83–89, 97–105, 110–112, 117–118, 146–166, 172–187, 193–204, 210, 216, 223, 234–236, 242–255, 261, 300, 330, 334, 356–358, 368, 382, 408–409, 419–420, 450–451, 459–463
helpers.py	317	157	50%	76–80, 87–88, 103, 186–187, 227, 234–236, 382–416, 426–552, 573, 580–590, 603–604, 618–626, 632–633, 635–636, 638–639, 662, 674–675, 697–699, 706, 729, 732–734, 737–739
packets.py	114	71	38%	160, 211–248, 256–294, 328–393, 458–461
socks.py	43	30	30%	12–13, 17–19, 25–31, 35–42, 46–57, 60
templating.py	28	7	75%	61–63, 72, 81–83
empire/server/common/malleable
implementation.py	236	26	89%	162, 164, 347, 351, 356, 476–495, 527
profile.py	127	17	87%	103–104, 144–145, 154, 195, 206, 220, 226, 237, 250, 261, 293, 316–319
transaction.py	374	80	79%	167–186, 199, 214–218, 261, 270, 286–290, 294, 304, 353, 404, 430, 441–442, 448, 469–497, 606–612, 631, 644–646, 753–760, 773, 784, 879, 881, 892, 894, 896
transformation.py	373	121	68%	184, 186, 188, 213, 224–225, 227, 235–236, 238, 284, 290, 294, 325–351, 356–396, 404–441, 456, 467–468, 470, 478–479, 481, 683, 685, 687, 689, 699–700, 724–728, 732, 736, 760, 773, 778, 790, 792–794, 796, 811, 813–815, 817, 835–840, 856, 861, 877–884, 900, 905
utility.py	43	13	70%	29, 45–48, 60–66, 120, 128
empire/server/core
agent_communication_service.py	681	504	26%	58, 61, 67, 70–82, 123, 154–155, 169–202, 226, 367–368, 382–384, 391–392, 396–398, 419–845, 865–947, 954–956, 965, 984–987, 1009, 1016–1062, 1103–1146, 1152–1161, 1165–1222, 1227–1237, 1242, 1245–1247, 1250–1251, 1256, 1260–1261, 1282–1511, 1516–1530, 1533
agent_service.py	121	9	93%	33, 88, 91, 173, 176, 179, 228, 260–261
agent_socks_service.py	46	21	54%	42, 45–65, 68–69, 73–76
agent_task_service.py	195	22	89%	70–73, 91, 97, 103, 111, 113, 115, 120, 125, 226, 235–236, 248, 250, 280–297
bypass_service.py	71	4	94%	39, 74–75, 81
credential_service.py	50	3	94%	37–38, 46
dotnet.py	50	7	86%	41, 52, 57–58, 99, 104–105
download_service.py	101	15	85%	49, 55, 61, 65, 71–74, 77, 97, 99, 101, 103, 108, 113
go.py	42	12	71%	26–57, 98
hooks.py	67	8	88%	77–79, 88–90, 124, 127
hooks_internal.py	115	66	43%	29, 32, 42–46, 115–145, 155–190, 203–222, 232–256
ip_service.py	72	5	93%	57, 108–114
listener_service.py	167	21	87%	72, 113, 143–144, 153, 163, 173–175, 184–185, 204–207, 224, 230–231, 291–295
module_service.py	475	117	75%	16–17, 182, 189–204, 214–217, 233, 237–265, 272–274, 379–381, 394–395, 402, 413, 472–513, 530–566, 591, 616, 618, 697–698, 709–713, 724–726, 744–745, 810, 820, 827, 829, 833, 861, 864, 870, 888–899, 905–906, 916–918, 931, 944, 948–950, 966–970, 1006, 1034
obfuscation_service.py	77	5	94%	94–97, 140–143
plugin_registry_service.py	103	9	91%	34, 69, 77–78, 83–85, 88–91
plugin_service.py	233	24	90%	77, 109, 175–180, 236–246, 284–299, 341, 345
plugin_task_service.py	63	13	79%	49–52, 68, 74, 77, 80, 88, 90, 92, 97, 102
plugins.py	90	7	92%	134–136, 139–141, 145
profile_service.py	56	1	98%	79
stager_generation_service.py	326	76	77%	12–13, 51, 88–89, 106, 140–141, 180–182, 196–198, 240–242, 311–313, 324–365, 373–376, 378, 386–387, 426–427, 447–451, 460–461, 500–506, 515–516, 589–590, 599–601, 632–642, 671, 694, 714
stager_service.py	96	5	95%	57, 92, 134, 139, 162
stager_template_service.py	53	1	98%	64
tag_service.py	72	17	76%	50, 52, 54, 56, 58, 60, 64–67, 70, 73, 81–84, 89, 92
user_service.py	41	1	98%	55
empire/server/core/config
config_manager.py	187	15	92%	206, 209, 231, 238, 250–253, 270–271, 289–293
data_manager.py	72	17	76%	34, 38–39, 43–47, 112–126
empire/server/core/db
base.py	99	22	78%	29–31, 39–44, 62, 77–80, 89–98, 171, 178–184
defaults.py	55	2	96%	80, 83
models.py	352	11	97%	165, 326–330, 342, 345, 389, 413, 416, 482, 485
empire/server/listeners
http.py	531	294	45%	236–239, 269, 280, 288–299, 322–329, 362, 372–374, 402–405, 411–412, 421–435, 445, 450–455, 512–515, 530–531, 592–598, 603, 608, 636, 639, 643–646, 661–662, 692, 722, 725–732, 741–742, 783–786, 794–1254
http_foreign.py	165	72	56%	132, 139–149, 171–174, 187–191, 202, 214–216, 223–228, 234–237, 259, 268, 276, 280–283, 307–308, 320–336, 346, 351–356, 359–362, 377–378, 387–388, 396–434, 440, 446
http_hop.py	228	139	39%	96, 103, 125–126, 140–144, 154, 166–168, 175–180, 211, 220, 230, 238–241, 269–270, 279–292, 302, 307–310, 313–316, 331–460, 469–470, 478–524, 532–576, 582
http_malleable.py	634	466	26%	177–178, 211, 223, 265–270, 296–297, 315–321, 374, 384–387, 394–405, 415, 424, 434–439, 446, 471–472, 476, 485–486, 497–513, 550–552, 559, 567, 572–577, 580–583, 598–738, 752–834, 843–1332, 1340–1740
port_forward_pivot.py	338	242	28%	76–77, 83, 105–106, 118–122, 133, 145–146, 153–164, 191–199, 215, 224, 234, 238–241, 271–275, 281–282, 294–310, 320–323, 328–331, 334–363, 378–478, 492–580, 589–627, 635–780, 787–877
smb.py	195	168	14%	67–68, 74, 93–218, 233–288, 302–351, 360–390, 398–454, 461
empire/server/modules/bof
clipboard_window_inject.py	23	16	30%	17–52
secinject.py	23	16	30%	17–52
tgtdelegation.py	9	3	67%	16–25
empire/server/modules/bof/situational_awareness
netGroupList.py	7	2	71%	14–21
netGroupListMembers.py	7	2	71%	14–21
netLocalGroupList.py	7	2	71%	14–21
netLocalGroupListMembers.py	7	2	71%	14–21
netloggedon.py	7	2	71%	14–20
netshares.py	7	2	71%	14–20
windowlist.py	7	2	71%	14–19
wmi_query.py	8	3	62%	14–25
empire/server/modules/csharp/code_execution
RunCoff.py	16	8	50%	18–35
empire/server/modules/csharp/management
ProcessInjection.py	50	40	20%	5–6, 24–108
ThreadlessInject.py	43	33	23%	7–8, 27–89
empire/server/modules/powershell/code_execution
invoke_ntsd.py	54	48	11%	15–97
invoke_reflectivepeinjection.py	32	24	25%	19–62
invoke_script.py	14	9	36%	14–30
invoke_shellcode.py	20	3	85%	34–35, 41
invoke_shellcodemsil.py	15	9	40%	16–38
empire/server/modules/powershell/collection
SharpChromium.py	26	16	38%	22–48
WireTap.py	18	10	44%	18–34
get_sql_column_sample_data.py	39	33	15%	15–70
minidump.py	19	11	42%	18–34
packet_capture.py	17	12	29%	14–31
screenshot.py	22	16	27%	16–43
empire/server/modules/powershell/credentials
credential_injection.py	35	25	29%	20–70
tokens.py	29	21	28%	18–65
empire/server/modules/powershell/credentials/mimikatz
dcsync_hashdump.py	21	15	29%	16–42
golden_ticket.py	34	25	26%	21–66
lsadump.py	15	9	40%	16–34
mimitokens.py	34	28	18%	16–58
pth.py	34	25	26%	21–64
silver_ticket.py	39	31	21%	18–73
trust_keys.py	14	8	43%	16–31
empire/server/modules/powershell/exfiltration
PSRansom.py	22	16	27%	17–42
empire/server/modules/powershell/exploitation
exploit_eternalblue.py	17	11	35%	16–37
empire/server/modules/powershell/lateral_movement
inveigh_relay.py	32	26	19%	16–81
invoke_dcom.py	33	27	18%	16–80
invoke_executemsbuild.py	52	45	13%	17–108
invoke_psexec.py	46	40	13%	16–120
invoke_psremoting.py	41	34	17%	17–92
invoke_smbexec.py	37	31	16%	16–88
invoke_sqloscmd.py	44	37	16%	16–80
invoke_sshcommand.py	31	24	23%	17–64
invoke_wmi.py	46	39	15%	17–101
invoke_wmi_debugger.py	57	49	14%	17–157
jenkins_script_console.py	25	18	28%	17–58
new_gpo_immediate_task.py	33	26	21%	17–93
empire/server/modules/powershell/management
invoke_bypass.py	13	7	46%	15–23
logoff.py	10	5	50%	14–21
psinject.py	33	27	18%	16–72
reflective_inject.py	42	34	19%	18–84
runas.py	33	26	21%	17–71
shinject.py	29	22	24%	17–63
spawn.py	28	22	21%	15–73
spawnas.py	44	37	16%	16–69
switch_listener.py	14	8	43%	16–35
user_to_sid.py	7	2	71%	14–18
empire/server/modules/powershell/management/mailraider
disable_security.py	23	17	26%	15–59
get_emailitems.py	16	10	38%	15–39
empire/server/modules/powershell/persistence/elevated
registry.py	64	56	12%	19–157
schtasks.py	78	70	10%	19–197
wmi.py	87	79	9%	19–251
wmi_updater.py	73	65	11%	19–213
empire/server/modules/powershell/persistence/misc
add_sid_history.py	15	9	40%	16–33
debugger.py	35	29	17%	16–108
empire/server/modules/powershell/persistence/powerbreach
deaduser.py	37	29	22%	18–138
eventlog.py	34	26	24%	18–115
resolver.py	37	29	22%	18–124
empire/server/modules/powershell/persistence/userland
backdoor_lnk.py	48	40	17%	19–112
registry.py	74	66	11%	19–197
schtasks.py	75	67	11%	19–190
empire/server/modules/powershell/privesc
ask.py	20	14	30%	16–61
bypassuac.py	22	16	27%	16–54
bypassuac_env.py	23	17	26%	16–54
bypassuac_eventvwr.py	23	17	26%	16–55
bypassuac_fodhelper.py	37	31	16%	15–88
bypassuac_sdctlbypass.py	23	17	26%	16–55
bypassuac_tokenmanipulation.py	28	20	29%	19–57
bypassuac_wscript.py	22	16	27%	16–54
ms16-032.py	18	12	33%	16–46
ms16-135.py	18	12	33%	16–46
empire/server/modules/powershell/privesc/powerup
service_exe_stager.py	30	24	20%	16–61
service_stager.py	25	19	24%	16–52
write_dllhijacker.py	26	20	23%	16–67
empire/server/modules/powershell/recon
fetch_brute_local.py	25	19	24%	15–42
find_fruit.py	22	16	27%	16–57
get_sql_server_login_default_pw.py	22	17	23%	14–44
empire/server/modules/powershell/situational_awareness/host
computerdetails.py	46	40	13%	16–104
empire/server/modules/powershell/situational_awareness/network
get_sql_server_info.py	29	24	17%	14–58
empire/server/modules/powershell/situational_awareness/network/powerview
get_gpo_computer.py	38	31	18%	18–95
get_subnet_ranges.py	35	28	20%	17–78
empire/server/modules/python/code_execution
invoke_script.py	16	11	31%	14–31
empire/server/modules/python/collection/osx
imessage_dump.py	15	10	33%	14–176
native_screenshot_mss.py	11	5	55%	16–20
prompt.py	14	9	36%	14–43
search_email.py	12	1	92%	19
sniffer.py	23	18	22%	14–151
empire/server/modules/python/lateral_movement/multi
ssh_launcher.py	17	11	35%	15–32
empire/server/modules/python/management/multi
spawn.py	13	7	46%	16–28
empire/server/modules/python/management/osx
shellcodeinject64.py	17	9	47%	18–136
empire/server/modules/python/persistence/multi
desktopfile.py	13	8	38%	14–29
empire/server/modules/python/persistence/osx
CreateHijacker.py	19	13	32%	22–43
LaunchAgent.py	20	14	30%	16–52
LaunchAgentUserLandPersistence.py	15	10	33%	14–46
loginhook.py	12	7	42%	14–20
mail.py	29	21	28%	18–131
empire/server/modules/python/privesc/multi
CVE-2021-3560.py	16	9	44%	18–41
CVE-2021-4034.py	21	13	38%	19–47
bashdoor.py	11	6	45%	15–27
sudo_spawn.py	18	12	33%	16–37
empire/server/modules/python/privesc/osx
dyld_print_to_file.py	17	10	41%	24–39
piggyback.py	17	11	35%	16–35
empire/server/modules/python/situational_awareness/host/osx
situational_awareness.py	14	9	36%	14–196
empire/server/plugins/basic_reporting
basic_reporting.py	67	1	99%	114
empire/server/plugins/example
example.py	35	35	0%	3–110
empire/server/stagers/linux
bash.py	22	14	36%	61–84
pyinstaller.py	49	5	90%	91–93, 103–104
empire/server/stagers/multi
generate_agent.py	37	10	73%	121–122, 124–125, 128–136
go_exe.py	11	5	55%	51–57
launcher.py	39	10	74%	122–130, 138–146, 169–170
macro.py	51	41	20%	120–196
empire/server/stagers/osx
applescript.py	18	10	44%	62–81
application.py	24	16	33%	73–96
ducky.py	25	18	28%	60–88
dylib.py	26	17	35%	73–98
jar.py	17	10	41%	54–72
macho.py	17	10	41%	60–80
macro.py	39	31	21%	85–182
safari_launcher.py	22	15	32%	67–92
shellcode.py	23	16	30%	68–157
teensy.py	76	69	9%	61–143
empire/server/stagers/windows
bunny.py	48	39	19%	107–176
cmd_exec.py	45	34	24%	104–161, 164–174
csharp_exe.py	47	16	66%	120, 125–130, 146, 148, 151–155, 160–168
dll.py	40	11	72%	107–108, 112, 115–118, 121–132, 156–157
ducky.py	42	34	19%	94–161
hta.py	37	29	22%	86–145
launcher_bat.py	54	12	78%	87–88, 107, 121–140, 150–151
launcher_vbs.py	34	26	24%	82–138
launcher_xml.py	83	75	10%	82–191
macro.py	79	19	76%	159, 163, 166–177, 200–201, 227–239
shellcode.py	56	45	20%	5–6, 107–180
teensy.py	113	105	7%	82–218
war.py	44	34	23%	85–170
wmic.py	42	34	19%	93–156
empire/server/utils
bof_packer.py	49	11	78%	27–28, 51–53, 56, 62–63, 65, 69, 75
data_util.py	46	8	83%	34–43, 56–57, 59
file_util.py	24	3	88%	33, 55, 57
git_util.py	22	2	91%	37–38
listener_util.py	46	32	30%	13–19, 43–52, 57–68, 76, 95–106
math_util.py	5	3	40%	9–11
option_util.py	104	18	83%	26, 178–192, 201–209, 219
string_util.py	15	1	93%	26
TOTAL	15519	6491	58%

Tests	Skipped	Failures	Errors	Time
523	0 💤	0 ❌	0 🔥	4m 40s ⏱️

* GitBook: No commit message * GitBook: No commit message * Update docs/.gitbook/assets/Continuous.svg Co-authored-by: Vincent Rose <[email protected]> * Update docs/.gitbook/assets/completed.svg Co-authored-by: Vincent Rose <[email protected]> * Update docs/.gitbook/assets/continious.svg Co-authored-by: Vincent Rose <[email protected]> * Update docs/.gitbook/assets/pulled.svg Co-authored-by: Vincent Rose <[email protected]> * Update docs/.gitbook/assets/queued.svg Co-authored-by: Vincent Rose <[email protected]> * Update docs/.gitbook/assets/error.svg Co-authored-by: Vincent Rose <[email protected]> * fixed markdown files --------- Co-authored-by: Vincent Rose <[email protected]>

…y-pick-803-806 Cherry-pick: Updated Docs and added OpenAPI (#806)

Cx01N added 2 commits January 25, 2026 18:15

GitBook: No commit message

6c01828

GitBook: No commit message

4e3997b