Skip to content

Usage CLI

skelsec edited this page Dec 17, 2018 · 3 revisions

The settings for responder3 and all the sub-modules are set via configuration files.
Example command that starts the servers in credential-logging mode:

python Responder3.py -I lo -4 -p examples/config.py

The CLI has three functionalities:

  • sets the config file -p -c -e
  • adds a few options for overriding some settings in the config file -4 -6 -I
  • adds options to help the user -L -h

CLI parameters

  • -p <file_path>[PYTHON config file]
    Sets the config file path and type.
  • -c <file_path>[JSON config file]
    Sets the config file path and type.
  • -e[os environment config file]
    Tells the runtime to look for the config file path in the R3CONFIG environment variable. Must be a PYTHON config file.
  • -4[Bind IPv4]
    Sets the bind IP version to 4. Can be used in conjunction with -6. Overrides the config file's bind_family parameter!
  • -6[Bind IPv6]
    Sets the bind IP version to 6. Can be used in conjunction with -4. Overrides the config file's bind_family parameter!
  • -I <iface_name>[Bind Interface]
    Sets the interface to bind all servers to. Can be stacked by specifying multiple -I <iface_name> elements. Overrides the config file's bind_iface parameter!
  • -L[List interfaces]
    List all available interface names and IP addresses then exits.
  • -h[help]
    Displays help menu and the list of interfaces then exits.
  • -v[verbose]
    Increases verbosity
Clone this wiki locally