Get-NetLocalGroup - Empire Module


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

Module Overview

Name: Get-NetLocalGroup
Module: powershell/situational_awareness/network/powerview/get_localgroup
Source code [1]: empire/server/modules/powershell/situational_awareness/network/powerview/get_localgroup.yaml
Source code [2]: empire/server/data/module_source/situational_awareness/network/powerview.ps1
MITRE ATT&CK: T1482, S0194
Language: PowerShell
Needs admin: No
OPSEC safe: Yes
Background: Yes

The get_localgroup module returns a list of all current users in a specified local group on a local or remote machine. Part of PowerView.

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 get_localgroup 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 get_localgroup module:

Agent
Agent to run module on.

Additional Module Options

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

API
Switch. Use API calls instead of the WinNT service provider. Less information, but the results are faster.

ComputerName
The hostname or IP to query for local group users.
Default value: localhost.

GroupName
The local group name to query for users, defaults to "Administrators".
Default value: Administrators.

ListGroups
Switch. List all the local groups instead of their members.

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.

Recurse
Switch. If the local member member is a domain group, recursively try to resolve its members to get a list of domain users who can access this machine.

Get_localgroup Example Usage

Here's an example of how to use the get_localgroup 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/powerview/get_localgroup

 Author       @harmj0y                                                            
 Background   True                                                                
 Comments     https://github.com/PowerShellMafia/PowerSploit/blob/dev/Recon/      
 Description  Returns a list of all current users in a specified local group on a 
              local or remote machine. Part of PowerView.                         
 Language     powershell                                                          
 Name         powershell/situational_awareness/network/powerview/get_localgroup   
 NeedsAdmin   False                                                               
 OpsecSafe    True                                                                
 Software     http://attack.mitre.org/software/S0194                              
 Techniques   http://attack.mitre.org/techniques/T1482                            


,Record Options--,----------------,----------,-------------------------------------,
| Name           | Value          | Required | Description                         |
|----------------|----------------|----------|-------------------------------------|
| API            |                | False    | Switch. Use API calls instead of    |
|                |                |          | the WinNT service provider. Less    |
|                |                |          | information, but the results are    |
|                |                |          | faster.                             |
|----------------|----------------|----------|-------------------------------------|
| Agent          |                | True     | Agent to run module on.             |
|----------------|----------------|----------|-------------------------------------|
| ComputerName   | localhost      | False    | The hostname or IP to query for     |
|                |                |          | local group users.                  |
|----------------|----------------|----------|-------------------------------------|
| GroupName      | Administrators | False    | The local group name to query for   |
|                |                |          | users, defaults to                  |
|                |                |          | "Administrators".                   |
|----------------|----------------|----------|-------------------------------------|
| ListGroups     |                | False    | Switch. List all the local groups   |
|                |                |          | instead of their members.           |
|----------------|----------------|----------|-------------------------------------|
| OutputFunction | Out-String     | False    | PowerShell's output function to use |
|                |                |          | ("Out-String", "ConvertTo-Json",    |
|                |                |          | "ConvertTo-Csv", "ConvertTo-Html",  |
|                |                |          | "ConvertTo-Xml").                   |
|----------------|----------------|----------|-------------------------------------|
| Recurse        |                | False    | Switch. If the local member member  |
|                |                |          | is a domain group, recursively try  |
|                |                |          | to resolve its members to get a     |
|                |                |          | list of domain users who can access |
|                |                |          | this machine.                       |
'----------------'----------------'----------'-------------------------------------'

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

Now wait for the results to come.

Author

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.