Skip to content

greenbone/pypsrp-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Greenbone Logo

Pypsrp CLI

This is a simple CLI for pypsrp.

Description

Pypsrp exposes the WinRM (Windows Remote Management) API as Python library. This CLI provides the corresponding interface called by the OpenVAS Scanner.

Installing

Requirements Dependencies

  • Inherited from Pypsrp
  • Python 3.10 and later are supported
  • Forces Kerberos support in its dependency chain

Packages

Kerberos and build-dependencies

apt install -y krb5-user libkrb5-dev gcc python3-pip python3-dev

The following python packages also exist as Debian packages thus should be less conflict prone in case of system-wide installations like Docker.

apt install -y python3-cryptography python3-gssapi python3-requests
pip install .

Note: in case of system-wide installations, use --break-system-packages at your own risk

Executing program

All arguments currently supported are mandatory. Certain non-pythonic design choicies were made to ensure easier integration into the OpenVAS stack w.r.t. parsing errors.

usage: pypsrp_cli [-h] [--interpreter INTERPRETER] [-c COMMAND] [-t TARGET] [--port PORT] [--path PATH] [--ssl SSL] [--authentication AUTHENTICATION] [-u USERNAME] [-p PASSWORD]

Pypsrp CLI wrapper

options:
  -h, --help            show this help message and exit
  --interpreter INTERPRETER
                        Command interpreter. Specify as 'CMD' or 'PS'
  -c, --command COMMAND
                        Command to execute on the host
  -t, --target TARGET   Target host
  --port PORT           Port
  --path PATH           URL path
  --ssl SSL             Forces HTTPS. Specify as '0' or '1'
  --authentication AUTHENTICATION
                        Authentication algorithm. Currently supported: 'NTLM', 'Kerberos'
  -u, --username USERNAME
                        Username
  -p, --password PASSWORD
                        Password

Ensure that your target has WinRM enabled. Non-Server versions of Windows have it disabled by default.

Maintainer

This project is maintained by Greenbone AG

License

Copyright (C) 2026 Greenbone AG

Licensed under the GNU General Public License v3.0 or later.

Acknowledgments

Thanks to the authors of pypsrp for providing a WinRM-based API in Python.

About

Pypsrp CLI

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages