Plugin Commands
This section lists plugin-based commands available via the REST API, their parameters, and usage examples.
connect-smb
Purpose: Connect to an SMB agent using a parent agent trigger.
Parameters:
- host: IP address or domain of the SMB agent.
- pipename: Name of the SMB pipe.
Example:
connect-tcp
Purpose: Establish a connection for a TCP-BIND agent.
Parameters:
- host: IP address or domain to connect to.
- port: TCP port number.
Example:
cp
Purpose: Copy a file or directory on the target filesystem.
Parameters:
- source: Source file/directory path.
- destination: Destination file/directory path.
Example:
download
Purpose: Download a file from the agent’s filesystem.
Parameters:
- filepath: File path to read (supports environment variables).
Example:
execute-assembly
Purpose: Execute a .NET assembly in memory.
Parameters:
- @files.executable: .NET executable file content (base64 encoded if provided via API).
- parameters: Command line arguments for the .NET executable.
Note: Requires a multipart/form-data request if using @files.
Example:
inject
Purpose: Inject and execute shellcode.
Parameters:
- @files.shellcode: Shellcode content.
Example:
jump-service
Purpose: Copy a payload and create a service for lateral movement.
Parameters:
- payloadId: Service executable payload ID.
- copyMethod: Method for copying payload (SMB, NONE).
- copyPath: Destination path for the copied file.
- target: Target machine IP/name.
- servicePath: Path for the created service.
- serviceName: Service name.
- serviceDisplayName: Display name for the service.
- cleanup: Should service be deleted after execution.
- username: Username (if needed).
- password: Password (if needed).
Example:
jump-ssh
Purpose: Execute commands or copy payloads via SSH for lateral movement.
Parameters:
- payloadId: Executable payload ID.
- copyMethod: Copy method (SMB, NONE).
- copyPath: Destination path.
- target: Target machine IP/name.
- cmdline: Command line to execute.
- username: Username.
- password: Password.
- @files.privateKeyPEM: Private key PEM file
- privateKeyPassword: Password for the private key file.
Example:
jump-winrm
Purpose: Execute commands or run an executable via WinRM.
Parameters:
- payloadId: Executable payload ID.
- copyMethod: Copy method (SMB, NONE).
- copyPath: Destination path.
- target: Target machine IP/name.
- executablePath: Path of the executable to run.
- customPowershell: Custom PowerShell script.
- username: Username (if needed).
- password: Password (if needed).
Example:
jump-wmi
Purpose: Execute commands via WMI for lateral movement.
Parameters:
- payloadId: Executable payload ID.
- copyMethod: Copy method (SMB, NONE).
- copyPath: Destination path.
- target: Target machine IP/name.
- cmdline: Command line to execute.
- username: Username (if needed).
- password: Password (if needed).
Example:
mkdir
Purpose: Create a new directory on the target system.
Parameters:
- dirpath: Directory path to create (supports recursive creation).
Example:
mv
Purpose: Move a file or directory on the target system.
Parameters:
- source: Source file/directory path.
- destination: Destination path.
- overwrite: Allow to overwrite the destination file.
Example:
portscan
Purpose: Perform a TCP port scan and log discovered hosts and ports.
Parameters:
- ips: IP addresses or ranges (comma-separated).
- ports: Ports or ranges (comma-separated).
- hostDiscovery: Host discovery method (ICMP default, ARP, NONE).
- timeout: Connection timeout in milliseconds.
- threads: Number of concurrent ARP threads.
Example:
procinfo
Purpose: Retrieve additional information about the agent’s process.
Parameters: None
Example:
rm
Purpose: Remove a file from the target filesystem.
Parameters:
- filepath: File path to delete (supports environment variables).
Example:
screenshot
Purpose: Capture a screenshot of the target machine.
Parameters: None
Example:
socks5
Purpose: Create a SOCKS5 proxy on the agent’s network.
Parameters:
- port: Port that C2 opens for the SOCKS5 proxy.
Example:
spawn
Purpose: Spawn a new agent with provided configuration.
Parameters:
- payloadId: Listener payload ID.
- encryptedCommunication: Whether to encrypt communication.
Example:
upload
Purpose: Upload a file to the target filesystem.
Parameters:
- filepath: Destination file path (supports environment variables).
- @files.file: File content.
Example: