Skip to content

Add powershell 7 support (#402) #403

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.

Sign up for GitHub

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

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

Add powershell 7 support (#402) #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d58ab58
Add powershell 7 support (#402)
X8invisible Dec 23, 2025
e1ffef4
Add powershell 7 support (#402)
X8invisible Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions winrm/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,14 @@ def run_cmd(self, command: str, args: collections.abc.Iterable[str | bytes] = ()
self.protocol.close_shell(shell_id)
return rs

def run_ps(self, script: str) -> Response:
def run_ps(self, script: str, pwsh=False) -> Response:
"""base64 encodes a Powershell script and executes the powershell
encoded script command
"""
# must use utf16 little endian on windows
encoded_ps = b64encode(script.encode("utf_16_le")).decode("ascii")
rs = self.run_cmd("powershell -encodedcommand {0}".format(encoded_ps))
ps_arg = 'pwsh' if pwsh else 'powershell'
rs = self.run_cmd(f"{ps_arg} -encodedcommand {encoded_ps}")
if len(rs.std_err):
# if there was an error message, clean it it up and make it human
# readable
Expand Down
57 changes: 56 additions & 1 deletion winrm/tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,36 @@
</env:Body>
</env:Envelope>"""

run_ps_pwsh_request = """\
<?xml version="1.0" encoding="utf-8"?>
<env:Envelope xmlns:x="http://schemas.xmlsoap.org/ws/2004/09/transfer" xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd" xmlns:cfg="http://schemas.microsoft.com/wbem/wsman/1/config" xmlns:p="http://schemas.microsoft.com/wbem/wsman/1/wsman.xsd" xmlns:n="http://schemas.xmlsoap.org/ws/2004/09/enumeration" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rsp="http://schemas.microsoft.com/wbem/wsman/1/windows/shell" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:b="http://schemas.dmtf.org/wbem/wsman/1/cimbinding.xsd" xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing">
<env:Header>
<a:To>http://windows-host:5985/wsman</a:To>
<a:ReplyTo>
<a:Address mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address>
</a:ReplyTo>
<w:MaxEnvelopeSize mustUnderstand="true">153600</w:MaxEnvelopeSize>
<a:MessageID>uuid:11111111-1111-1111-1111-111111111111</a:MessageID>
<w:Locale mustUnderstand="false" xml:lang="en-US" />
<p:DataLocale mustUnderstand="false" xml:lang="en-US" />
<w:OperationTimeout>PT20S</w:OperationTimeout>
<w:ResourceURI mustUnderstand="true">http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd</w:ResourceURI>
<a:Action mustUnderstand="true">http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Command</a:Action>
<w:SelectorSet>
<w:Selector Name="ShellId">11111111-1111-1111-1111-111111111113</w:Selector>
</w:SelectorSet>
<w:OptionSet>
<w:Option Name="WINRS_CONSOLEMODE_STDIN">TRUE</w:Option>
<w:Option Name="WINRS_SKIP_CMD_SHELL">FALSE</w:Option>
</w:OptionSet>
</env:Header>
<env:Body>
<rsp:CommandLine>
<rsp:Command>pwsh -encodedcommand VwByAGkAdABlAC0ASABvAHMAdAAgACIAcAB3AHMAaAA3ACAAdABlAHMAdAAiAA==</rsp:Command>
</rsp:CommandLine>
</env:Body>
</env:Envelope>"""

cleanup_cmd_request = """\
<?xml version="1.0" encoding="utf-8"?>
<env:Envelope xmlns:x="http://schemas.xmlsoap.org/ws/2004/09/transfer" xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd" xmlns:cfg="http://schemas.microsoft.com/wbem/wsman/1/config" xmlns:p="http://schemas.microsoft.com/wbem/wsman/1/wsman.xsd" xmlns:n="http://schemas.xmlsoap.org/ws/2004/09/enumeration" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rsp="http://schemas.microsoft.com/wbem/wsman/1/windows/shell" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:b="http://schemas.dmtf.org/wbem/wsman/1/cimbinding.xsd" xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing">
Expand Down Expand Up @@ -310,6 +340,27 @@
</s:Body>
</s:Envelope>"""

get_ps_pwsh_output_response = """\
<?xml version="1.0" ?>
<s:Envelope xml:lang="en-US" xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:p="http://schemas.microsoft.com/wbem/wsman/1/wsman.xsd" xmlns:rsp="http://schemas.microsoft.com/wbem/wsman/1/windows/shell" xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">
<s:Header>
<a:Action>http://schemas.microsoft.com/wbem/wsman/1/windows/shell/ReceiveResponse</a:Action>
<a:MessageID>uuid:11111111-1111-1111-1111-111111111112</a:MessageID>
<a:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:To>
<a:RelatesTo>uuid:11111111-1111-1111-1111-111111111111</a:RelatesTo>
</s:Header>
<s:Body>
<rsp:ReceiveResponse>
<rsp:Stream CommandId="11111111-1111-1111-1111-111111111134" Name="stdout">V3JpdGUtSG9zdCAicHdzaDcgdGVzdCI=</rsp:Stream>
<rsp:Stream CommandId="11111111-1111-1111-1111-111111111134" End="true" Name="stdout"/>
<rsp:Stream CommandId="11111111-1111-1111-1111-111111111134" End="true" Name="stderr"/>
<rsp:CommandState CommandId="11111111-1111-1111-1111-111111111134" State="http://schemas.microsoft.com/wbem/wsman/1/windows/shell/CommandState/Done">
<rsp:ExitCode>0</rsp:ExitCode>
</rsp:CommandState>
</rsp:ReceiveResponse>
</s:Body>
</s:Envelope>"""


run_cmd_req_input = """\
<?xml version="1.0" encoding="utf-8"?>
Expand Down Expand Up @@ -521,12 +572,16 @@ def send_message(self, message):
return run_cmd_ps_response % "1"
elif xml_str_compare(message, run_ps_request):
return run_cmd_ps_response % "2"
elif xml_str_compare(message, cleanup_cmd_request % "1") or xml_str_compare(message, cleanup_cmd_request % "2"):
elif xml_str_compare(message, run_ps_pwsh_request):
return run_cmd_ps_response % "3"
elif xml_str_compare(message, cleanup_cmd_request % "1") or xml_str_compare(message, cleanup_cmd_request % "2") or xml_str_compare(message, cleanup_cmd_request % "3"):
return cleanup_cmd_response
elif xml_str_compare(message, get_cmd_ps_output_request % "1"):
return get_cmd_output_response
elif xml_str_compare(message, get_cmd_ps_output_request % "2"):
return get_ps_output_response
elif xml_str_compare(message, get_cmd_ps_output_request % "3"):
return get_ps_pwsh_output_response
elif xml_str_compare(message, run_cmd_req_input):
return run_cmd_req_input_response
elif xml_str_compare(message, run_cmd_send_input):
Expand Down
11 changes: 11 additions & 0 deletions winrm/tests/test_session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ def test_run_ps_with_error(protocol_fake):
assert len(r.std_out) == 0


def test_run_ps_with_pwsh(protocol_fake):
s = Session("windows-host", auth=("john.smith", "secret"))
s.protocol = protocol_fake

r = s.run_ps('Write-Host "pwsh7 test"', pwsh=True)

assert r.status_code == 0
assert b'Write-Host "pwsh7 test"' in r.std_out
assert len(r.std_err) == 0


def test_target_as_hostname():
s = Session("windows-host", auth=("john.smith", "secret"))
assert s.url == "http://windows-host:5985/wsman"
Expand Down