Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add parse_keylogger.py Script and Update README #3

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

IAmStoxe
Copy link

📜 Summary:

With this PR, we introduce a Python script (parse_keylogger.py) that enables users to interpret the output of the Sliver Keylogger. The script provides a way to convert special keystroke sequences into a more human-readable format, improving the usability of the keylogger output. Additionally, the README has been updated with instructions on how to utilize the new script.

🚀 Changes:

  1. Added parse_keylogger.py Script:

    • The script can interpret special sequences like [bs] for backspaces and [enter] for newline entries.
    • Users can run the script either by providing a file path or directly inputting the log content as a string.
    • The command-line interface makes it user-friendly and versatile for different use cases.
  2. Updated README.md:

    • A new section has been added detailing the usage of the parse_keylogger.py script.
    • This allows users to quickly understand and leverage the script's capabilities.

Log Interpreter Script
=======================

Description:
------------
This script provides utilities to interpret a textual log of keystrokes and convert it into human-readable text.
Specifically, it handles special sequences like `[bs]` for backspaces and `[enter]` for newline entries. Arrow keys
like `[←]` and `[↓]` are recognized but currently not interpreted for cursor movement.

Functions:
----------
- interpret_backspaces(line: str) -> str:
    Interprets and processes backspaces in the given line.
    
- interpret_enter_keys(line: str) -> str:
    Interprets and processes enter keys, replacing them with newlines.

- process_log_line(line: str) -> str:
    Calls other functions to process a single line of the log. More special sequences can be added and interpreted here.

- interpret_log_string(log_str: str) -> str:
    Processes the entire log string and returns the interpreted text.

Usage:
------
To interpret a log string, simply call the `interpret_log_string` function with the log string as an argument.

Example:
    log_content = "...(log content here)..."
    interpreted_text = interpret_log_string(log_content)
    print(interpreted_text)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant