├── new_beacon_info.png ├── beacon_health_status.png ├── .gitignore ├── readme.md ├── beaconhealth.cna └── LICENSE /new_beacon_info.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Cobalt-Strike/beacon_health_check/HEAD/new_beacon_info.png -------------------------------------------------------------------------------- /beacon_health_status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Cobalt-Strike/beacon_health_check/HEAD/beacon_health_status.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # MacOS 3 | 4 | # General 5 | .DS_Store 6 | .AppleDouble 7 | .LSOverride 8 | 9 | # Icon must end with two \r 10 | Icon 11 | 12 | 13 | # Thumbnails 14 | ._* 15 | 16 | # Files that might appear in the root of a volume 17 | .DocumentRevisions-V100 18 | .fseventsd 19 | .Spotlight-V100 20 | .TemporaryItems 21 | .Trashes 22 | .VolumeIcon.icns 23 | .com.apple.timemachine.donotpresent 24 | 25 | # Directories potentially created on remote AFP share 26 | .AppleDB 27 | .AppleDesktop 28 | Network Trash Folder 29 | Temporary Items 30 | .apdisk 31 | 32 | # Linux 33 | 34 | *~ 35 | 36 | # temporary files which can be created if a process still has a handle open of a deleted file 37 | .fuse_hidden* 38 | 39 | # KDE directory preferences 40 | .directory 41 | 42 | # Linux trash folder which might appear on any partition or disk 43 | .Trash-* 44 | 45 | # .nfs files are created when an open file is removed but is still being accessed 46 | .nfs* -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # Beacon Health Check Aggressor Script 2 | 3 | Joe Vest (Twitter: @joevest) 4 | 5 | ## Description 6 | 7 | This aggressor script uses a beacon's note field to indicate the health status of a beacon. This is done by ... 8 | 9 | - Tracking each beacon's current sleep/jitter time 10 | - Calculating health based on a "max expected check in time" 11 | - Updating the note field with an appropriate icon every minute using the event `heartbeat_1m` 12 | - Labeling new beacons as "NEW" with the time of arrival 13 | - Adding beacon id and PID to the initial beacon event log message 14 | 15 | ## Demo 16 | 17 | [Demo on YouTube](https://www.youtube.com/watch?v=97mCumYTo7Y) 18 | 19 | ## Heath Checks and Icons 20 | 21 | ### ☑ - symbol indicates beacon as active and working 22 | 23 | Calculated as last checkin is less than max expected check-in time `(sleep + (sleep * .01 * jitter))` 24 | 25 | i.e., A beacon with `sleep 300 20` would have a max expected check-in time of `360` calculated as `300 + (300 * .01 * 20)`. 26 | 27 | ### 💀 - symbol indicates beacon has died 28 | 29 | Calculated as last checkin time is greater then max expected check-in time * 2. This is known as the "dead time". 30 | 31 | i.e., A beacon with `sleep 300 20` would have a dead time of `720`. 32 | 33 | ### ❎ - symbol indicates beacon has been killed by an operator. 34 | 35 | If `beacon['alive']` is false, then an opertor killed/exited this beacon and the beacon acknowleded the exit command. 36 | 37 | ### ⚠ - symbol indicates beacon as dying 38 | 39 | Calculated as last checkin is greater than the max expected check-in time and less than the dead time. 40 | 41 | ### ⏸ - symbol indicates the beacon as paused. 42 | 43 | This is a linked beacon that has been disconnected but is still considered alive. These beacons depend on a parent for communication. Instead of marking these dead, they are marked paused. There is no great way to track processes of disconnected beacons. 44 | 45 | The following shows what these icons look like in the Cobalt Strike client. 46 | 47 | ![Beacon Health Status Icons](beacon_health_status.png) 48 | 49 | The beacon Id and PID has been added to the initial beacon event log message. 50 | 51 | ![Additional info in the event log for new beacons](new_beacon_info.png) 52 | 53 | ## Usage 54 | 55 | Load the beaconhealth.cna file through the script manager. 56 | 57 | Use the `get_BeaconHealthCheck_settings` function in the script console to view the beacon sleep/jitter tracker. 58 | 59 | ## What you should know about the script 60 | 61 | - It uses the Note field. You are free to edit as you like. The first character of the note will be updated during a health check with the appropriate symbol. 62 | - Linked beacons do not have a sleep. Sleeps are tracked by the parent of the linked beacon 63 | - Sleep settings are not verified before tracked. Setting sleep on a dead beacon may cause the symbol to change before the actual sleep has been processed by the beacon. 64 | - The health check is designed to monitor longer running beacons. 65 | - Health is measured every minute 66 | - This may still be too aggressive 67 | - You can adjust the timing by changing the heartbeat event that kicks off a check. 68 | - The tracking database is not persistent. If you close the Cobalt Strike client and reconnect, the database will be refreshed and beacons may be marked as **NEW** -------------------------------------------------------------------------------- /beaconhealth.cna: -------------------------------------------------------------------------------- 1 | # beaconhealth.cna 2 | # Joe Vest 3 | # Twitter: @joevest 4 | # Description: This aggressor script adds tracking of a beacon's healthe by tracking sleep and jitter times to calculate a status based on an expected checkin time. 5 | 6 | 7 | # Log script start to the console 8 | println("BeaconHealthCheck: Script loaded"); 9 | 10 | # symbol marks beacon as active and working 11 | # Calculated as last checkin is less than sleep + (sleep * jitter). This is considerd the expected return time 12 | # (i.e., "sleep 10 1" would have a max expected time of 10 + (10 * .01 * 1) or 11). Anything below this value is considered good 13 | $good = "☑"; 14 | 15 | # symbol marks beacon has died 16 | # Calculated as last checkin time is greater then expected return * 2 17 | $bad = "💀"; 18 | 19 | # symbol marks beacon has been killed by an operator 20 | # If beacon['alive'] is false, then an opertor killed this beacon and the beacon acknowleded this command 21 | $dead = "❎"; 22 | 23 | # symbol marks beacon as dying 24 | # Calculated as last checkin is greater than the expected return time and less than the bad time. 25 | $dying = "⚠"; 26 | 27 | # symbol marks the beacon as paused. This is a linked beacon that has been disconnected but still considered alive. These beacons depend on a parent for communication. There is no great way to track disconnected beacons. 28 | $pause = '⏸'; 29 | 30 | local('$profile $initialsleep $initialjitter %beaconsleeps'); 31 | # $profile, contents of c2 profile 32 | # $initialsleep, value of sleep in profile 33 | # $initialjitter, value of jitter in profile 34 | # %beaconsleeps, tracks beacon sleep times 35 | 36 | sub health_check { 37 | local ('$beaconid $beaconpbid $beaconsleep $beaconjitter $cautiontime $deadtime') 38 | foreach $beacon (beacons()) { 39 | $beaconid = $beacon['id']; 40 | $beaconpbid = $beacon['pbid']; 41 | 42 | # Is this beacon tracked? 43 | # if beaconid is in beaconsleep then continue 44 | # else run set_initial_sleep on this beacon and continue 45 | if ($beaconpbid) { 46 | # This is a linked beacon, No need to track. 47 | } else if ($beaconid in %beaconsleeps) { 48 | # Skip, this beacon is being tracked 49 | } else { 50 | println("[!] BeaconHealthCheck, " . $beaconid . " is not being tracked. Tracking based on c2 profile settings."); 51 | set_initial_sleep($beaconid); 52 | } 53 | 54 | # Calculate times based on tracked sleep and last checkin time 55 | 56 | $beaconsleep = %beaconsleeps[$beaconid][0]; 57 | $beaconjitter = %beaconsleeps[$beaconid][1]; 58 | $cautiontime = int($beaconsleep) * 0.01 * int($beaconjitter) + int($beaconsleep); 59 | $deadtime = $cautiontime * 2; 60 | 61 | # println("Last checkin: " . $beacon['last']); 62 | # println("Sleep Time: " . $beaconsleep); 63 | # println("Jitter: " . $beaconjitter); 64 | # println("Cautiontime: " . $cautiontime); # sleep + sleep * 0.01 * jitter 65 | # println("Deadtime: " . $deadtime); 66 | 67 | # Remove old symbols from note 68 | $newnote = replace($beacon['note'],'☑|❎|💀|⚠|⏸',""); 69 | 70 | # Update beacon health with current symbol 71 | if ($beacon['alive'] eq 'false') { # Is beacon alive? 72 | bnote($beacon['id'],$dead . $newnote); 73 | } else if (find($beacon['external'],"⚯ ⚯") > 0) { # Is beacon a linked beacon that's disconnected? 74 | bnote($beacon['id'],$pause . $newnote); 75 | } else if (find($beacon['external'],"⚯⚯") > 0) { # Is beacon a linked beacon that's connected? 76 | bnote($beacon['id'],$good . $newnote); 77 | } else if ($beacon['last'] < $cautiontime) { # Is last less than caution time? Mark GOOD. 78 | bnote($beacon['id'],$good . $newnote); 79 | } else if ($beacon['last'] > $deadtime) { # last is greater than deadtime, Mark BAD. 80 | bnote($beacon['id'],$bad . $newnote); 81 | } else { # Beacon is fading 82 | bnote($beacon['id'],$dying . $newnote); 83 | } 84 | } 85 | } 86 | 87 | # on heartbeat_10s { 88 | # println("[*] BeaconHealthCheck, Updating Status every 10s..."); 89 | # health_check(); 90 | # } 91 | 92 | on heartbeat_1m { 93 | println("[*] BeaconHealthCheck, Updating Status every 1m..."); 94 | health_check(); 95 | } 96 | 97 | # Update the beacon sleep tracker (%beaconsleeps) with the inital value set in the profile 98 | sub set_initial_sleep { 99 | local('$beaconid'); 100 | 101 | $beaconid = $1; 102 | 103 | # Read the intial sleep time set in the c2 profile 104 | $profile = data_query("metadata")["c2profile"]; 105 | $initialsleep = [$profile getString: ".sleeptime"]; 106 | $initialjitter = [$profile getString: ".jitter"]; 107 | 108 | # Update tracker with sleep and jitter 109 | track_sleep($beaconid,$initialsleep,$initialjitter); 110 | 111 | } 112 | 113 | # Update the beacon sleep tracker (%beaconsleeps) when the sleep command is run 114 | sub track_sleep { 115 | local('$beaconid $sleeptime $jitter'); 116 | $beaconid = $1; 117 | $sleeptime = $2; 118 | $jitter = $3; 119 | 120 | # Update tracker with sleep and jitter 121 | %beaconsleeps[$beaconid] = @($sleeptime,$jitter); 122 | } 123 | 124 | 125 | on beacon_initial { 126 | 127 | local('$beaconid'); 128 | 129 | 130 | # Mark the beacon a new 131 | $beaconid = beacon_info($1,"id"); 132 | 133 | if (beacon_info($1,"pbid")) { # This is a linked beacon, include parent pid 134 | # Update beacon note with NEW status 135 | bnote($beaconid, "NEW BEACON - " . formatDate("yyyy.MM.dd HH:mm:ss z") . "; " . "Parent " . beacon_info(beacon_info($1,"pbid"),"pid")); 136 | 137 | # Send details to the event log 138 | elog(" \c8BeaconID: " . $1 . " - PID: " . beacon_info($1,"pid")); 139 | 140 | } else { 141 | # Update beacon note with NEW status 142 | bnote($beaconid, "NEW BEACON - " . formatDate("yyyy.MM.dd HH:mm:ss z") . "; "); 143 | elog(" \c8BeaconID: " . $1 . " - PID: " . beacon_info($1,"pid")); 144 | 145 | # Track the initial sleep/jitter of new beacons 146 | set_initial_sleep($beaconid); 147 | } 148 | 149 | 150 | } 151 | 152 | # Use the beacon_input event to determine if the command was a sleep 153 | # Capture Sleep setting in beaconsleeps 154 | # beaconid, sleep, jitter 155 | on beacon_input { 156 | 157 | # Was the last command a 'sleep' command? 158 | local('@result @command $beaconid $sleeptime $jittertime'); 159 | 160 | @result = @_; 161 | 162 | # get beacon id 163 | $beaconid = @result[0]; 164 | 165 | # get beacon parentid 166 | $beaconpbid = beacon_info($beaconid,"pbid"); 167 | 168 | # get the command to determine if it is 'sleep' and parse out the time and jitter parameters 169 | @command = split(" ", @result[2]); 170 | $commandsize = size(@command); 171 | 172 | if (@command[0] eq "sleep") { # is this a sleep command? 173 | 174 | if (int($commandsize) == 2 ) { # is this sleep with no jitter? 175 | 176 | if ($beaconpbid) { # Update parent beacon id. Sleeps are submitted to parent beacons. 177 | println("[*] BeaconHealthCheck, Sleep command issued child beacon. Updating parent sleep tracking " . $beaconpbid . ": " . @command[0] . " " . @command[1]); 178 | 179 | track_sleep($beaconpbid,int(@command[1]) * 1000,0); 180 | } else { # Track sleeps of beacon id 181 | println("[*] BeaconHealthCheck, Sleep command issued. tracking sleep for " . $beaconid . ": " . @command[0] . " " . @command[1]); 182 | track_sleep($beaconid,int(@command[1]) * 1000,0); 183 | } 184 | 185 | } else if (int($commandsize) == 3 ) { # is this sleep with jitter? 186 | if ($beaconpbid) { # Update parent beacon id. Sleeps are submitted to parent beacons. 187 | println("[*] BeaconHealthCheck, Sleep command issued to chiled beacon. Updating parent sleep tracking " . $beaconpbid . ": " . @command[0] . " " . @command[1] . " " . @command[2]); 188 | track_sleep($beaconpbid,int(@command[1]) * 1000,@command[2]); 189 | } else { 190 | println("[*] BeaconHealthCheck, Sleep command issued. Tracking sleep for " . $beaconid . ": " . @command[0] . " " . @command[1] . " " . @command[2]); 191 | track_sleep($beaconid,int(@command[1]) * 1000,@command[2]); 192 | } 193 | 194 | } 195 | 196 | } 197 | 198 | } 199 | 200 | command get_BeaconHealthCheck_settings { 201 | println(%beaconsleeps); 202 | } 203 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------