Invoke-ARPScan - Empire Module


This page contains detailed information about how to use the powershell/situational_awareness/network/arpscan Empire module. For list of all Empire modules, visit the Empire Module Library.

Module Overview


Name: Invoke-ARPScan
Module: powershell/situational_awareness/network/arpscan
Source code [1]: empire/server/modules/powershell/situational_awareness/network/arpscan.yaml
Source code [2]: empire/server/data/module_source/situational_awareness/network/Invoke-ARPScan.ps1
MITRE ATT&CK: T1016, S0099
Language: PowerShell
Needs admin: No
OPSEC safe: Yes
Background: Yes

The arpscan module performs an ARP scan against a given range of IPv4 IP Addresses.

This module runs in a foreground and is OPSEC unsafe as it writes on the disk and therefore could be detected by AV/EDR running on the target system.

Note that the arpscan module does not need administrative privileges to work properly which means that a normal user can run this module.

Required Module Options


This is a list of options that are required by the arpscan module:

Agent
Agent to run module on.

Additional Module Options


This is a list of additional options that are supported by the arpscan module:

CIDR
CIDR to ARP scan.

OutputFunction
PowerShell's output function to use ("Out-String", "ConvertTo-Json", "ConvertTo-Csv", "ConvertTo-Html", "ConvertTo-Xml").
Default value: Out-String.
Suggested values: Out-String, ConvertTo-Json, ConvertTo-Csv, ConvertTo-Html, ConvertTo-Xml.

Range
Range to ARP scan.

Arpscan Example Usage


Here's an example of how to use the arpscan module in the Empire client console:

[+] New agent Y4LHEV83 checked in
[*] Sending agent (stage 2) to Y4LHEV83 at 192.168.204.135
(empire usestager/windows/ducky) > usemodule powershell/situational_awareness/network/arpscan

 Author       DarkOperator                                                     
 Background   True                                                             
 Comments     https://github.com/darkoperator/Posh-                            
              SecMod/blob/master/Discovery/Discovery.psm1                      
 Description  Performs an ARP scan against a given range of IPv4 IP Addresses. 
 Language     powershell                                                       
 Name         powershell/situational_awareness/network/arpscan                 
 NeedsAdmin   False                                                            
 OpsecSafe    True                                                             
 Software     http://attack.mitre.org/software/S0099                           
 Techniques   http://attack.mitre.org/techniques/T1016                         


,Record Options--,------------,----------,-------------------------------------,
| Name           | Value      | Required | Description                         |
|----------------|------------|----------|-------------------------------------|
| Agent          |            | True     | Agent to run module on.             |
|----------------|------------|----------|-------------------------------------|
| CIDR           |            | False    | CIDR to ARP scan.                   |
|----------------|------------|----------|-------------------------------------|
| OutputFunction | Out-String | False    | PowerShell's output function to use |
|                |            |          | ("Out-String", "ConvertTo-Json",    |
|                |            |          | "ConvertTo-Csv", "ConvertTo-Html",  |
|                |            |          | "ConvertTo-Xml").                   |
|----------------|------------|----------|-------------------------------------|
| Range          |            | False    | Range to ARP scan.                  |
'----------------'------------'----------'-------------------------------------'

(Empire: usemodule/powershell/situational_awareness/network/arpscan) > set Agent Y4LHEV83
[*] Set Agent to Y4LHEV83
(Empire: usemodule/powershell/situational_awareness/network/arpscan) > execute
[*] Tasked Y4LHEV83 to run Task 1
...

Now wait for the results to come.

Author


  • DarkOperator

References


See Also


Check also the following modules related to this module:

Version


This page has been created based on Empire version 4.1.3 (BC Security Fork).
Visit Empire Module Library for more modules.