def cleanup(self):
"""
Cleans up any old services or payloads that may have been left behind
on a previous failure. This will search C:\\Windows for any files
starting with PAExec-*.exe and delete them. It will also stop and
remove any services that start with PAExec-* if they exist.
Before calling this function, the connect() function must have already
been called.
"""
scmr = self._service._scmr
services = scmr.enum_services_status_w(
self._service._scmr_handle, ServiceType.SERVICE_WIN32_OWN_PROCESS,
EnumServiceState.SERVICE_STATE_ALL)
for service in services:
if service['service_name'].lower().startswith("paexec"):
svc = Service(service['service_name'], self.session)
svc.open()
svc.delete()
smb_tree = TreeConnect(self.session,
r"\\%s\ADMIN$" % self.connection.server_name)
smb_tree.connect()
share = Open(smb_tree, "")
query_msgs = [
share.create(ImpersonationLevel.Impersonation,
DirectoryAccessMask.FILE_READ_ATTRIBUTES
| DirectoryAccessMask.SYNCHRONIZE
| DirectoryAccessMask.FILE_LIST_DIRECTORY,
FileAttributes.FILE_ATTRIBUTE_DIRECTORY,
ShareAccess.FILE_SHARE_READ
| ShareAccess.FILE_SHARE_WRITE
| ShareAccess.FILE_SHARE_DELETE,
CreateDisposition.FILE_OPEN,
CreateOptions.FILE_DIRECTORY_FILE,
send=False),
share.query_directory("PAExec-*.exe",
FileInformationClass.FILE_NAMES_INFORMATION,
send=False),
share.close(False, send=False)
]
query_reqs = self.connection.send_compound([x[0] for x in query_msgs],
self.session.session_id,
smb_tree.tree_connect_id,
related=True)
# receive response for open and close
query_msgs[0][1](query_reqs[0])
query_msgs[2][1](query_reqs[2])
try:
# receive the response for query_directory
files = query_msgs[1][1](query_reqs[1])
except SMBResponseException as exc:
if exc.status != NtStatus.STATUS_NO_SUCH_FILE:
raise exc
files = []
for file in files:
file_name = file['file_name'].get_value().decode('utf-16-le')
self._delete_file(smb_tree, file_name)
def test_open_service_with_invalid_name(self, session):
service = Service(b"\x00 a service".decode('utf-8'), session)
service.open()
with pytest.raises(SCMRException) as exc:
service.stop()
service.close()
assert str(exc.value) == "Exception calling ROpenServiceW. " \
"Code: 123, Msg: ERROR_INVALID_NAME"
def test_open_service_missing(self, session):
service = Service("missing-service", session)
service.open()
assert service._handle is None
with pytest.raises(PypsexecException) as exc:
service.start()
assert str(exc.value) == "Cannot start service missing-service as " \
"it does not exist"
with pytest.raises(PypsexecException) as exc:
service.stop()
assert str(exc.value) == "Cannot stop service missing-service as " \
"it does not exist"
service.close()
def _create_dummy_stopped_service(self, session):
service = Service("pypsexectest", session)
service.open()
service.create("C:\\Windows\\PAExec.exe -service")
service.close()
return service
class Client(object):
def __init__(self,
server,
username=None,
password=None,
port=445,
encrypt=True,
obscure=True,
sharename="ADMIN$"):
self.server = server
self.port = port
self.pid = os.getpid()
self.current_host = socket.gethostname()
self.connection = Connection(uuid.uuid4(), server, port)
self.session = Session(self.connection,
username,
password,
require_encryption=encrypt)
self.service_name = ""
#added
if obscure: #added
self.service_name = Client.obscure_service_name()
#added
else: #added
self.service_name = "PAExec"
# This doesn't need a new name everytime the service is created; makes a mess in the directories # OLD = "PAExec-%d-%s" % (self.pid, self.current_host)
log.info("Creating PyPsexec Client with unique name: %s" %
self.service_name)
self._exe_file = "%s.exe" % self.service_name
self._stdout_pipe_name = "PaExecOut%s%d" % (self.current_host,
self.pid)
self._stderr_pipe_name = "PaExecErr%s%d" % (self.current_host,
self.pid)
self._stdin_pipe_name = "PaExecIn%s%d" % (self.current_host, self.pid)
self._unique_id = get_unique_id(self.pid, self.current_host)
log.info("Generated unique ID for PyPsexec Client: %d" %
self._unique_id)
self._service = Service(self.service_name, self.session)
self._share = sharename
@staticmethod #added-----------------------------------------------------------------------
def obscure_service_name():
selection = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0987654321_- "
stringbuilder = []
for iter in range(0, random.randint(4, 16)):
stringbuilder.append(random.choice(selection))
return "".join(stringbuilder)
def connect(self, timeout=60):
log.info("Setting up SMB Connection to %s:%d" %
(self.server, self.port))
self.connection.connect(timeout=timeout)
log.info("Authenticating SMB Session")
self.session.connect()
log.info("Opening handle to SCMR and PAExec service")
self._service.open()
def disconnect(self):
log.info("Closing handle of PAExec service and SCMR")
self._service.close()
log.info("Closing SMB Connection")
self.connection.disconnect(close=False)
def create_service(self):
# check if the service exists and delete it
log.debug("Ensuring service is deleted before starting")
self._service.delete()
# copy across the PAExec payload to C:\Windows\
smb_tree = TreeConnect(
self.session,
r"\\%s\%s" % (self.connection.server_name, self._share))
log.info("Connecting to SMB Tree %s" % smb_tree.share_name)
smb_tree.connect()
paexec_file = Open(smb_tree, self._exe_file)
log.debug("Creating open to PAExec file")
paexec_file.create(ImpersonationLevel.Impersonation,
FilePipePrinterAccessMask.FILE_WRITE_DATA,
FileAttributes.FILE_ATTRIBUTE_NORMAL,
ShareAccess.FILE_SHARE_READ,
CreateDisposition.FILE_OVERWRITE_IF,
CreateOptions.FILE_NON_DIRECTORY_FILE)
log.info("Creating PAExec executable at %s\\%s" %
(smb_tree.share_name, self._exe_file))
for (data, o) in paexec_out_stream(self.connection.max_write_size):
paexec_file.write(data, o)
log.debug("Closing open to PAExec file")
paexec_file.close(False)
log.info("Disconnecting from SMB Tree %s" % smb_tree.share_name)
smb_tree.disconnect()
# create the PAExec service
# added ---------------------------------------------------------------
path_root = r"%SystemRoot%"
path_root = dir_map.get(self._share.strip("$\n\r\t"), r"%SystemRoot%")
# added ---------------------------------------------------------------
service_path = r'"{}\{}" -service'.format(path_root,
self._exe_file) # added
log.info("Creating PAExec service %s" % self.service_name)
self._service.create(service_path)
def remove_service(self):
"""
Removes the PAExec service and executable that was created as part of
the create_service function. This does not remove any older executables
or services from previous runs, use cleanup() instead for that purpose.
"""
# Stops/remove the PAExec service and removes the executable
log.debug("Deleting PAExec service at the end of the process")
self._service.delete()
# delete the PAExec executable
smb_tree = TreeConnect(
self.session,
r"\\%s\%s" % (self.connection.server_name, self._share))
log.info("Connecting to SMB Tree %s" % smb_tree.share_name)
smb_tree.connect()
log.info("Creating open to PAExec file with delete on close flags")
self._delete_file(smb_tree, self._exe_file)
log.info("Disconnecting from SMB Tree %s" % smb_tree.share_name)
smb_tree.disconnect()
def cleanup(self):
"""
Cleans up any old services or payloads that may have been left behind
on a previous failure. This will search C:\Windows for any files
starting with PAExec-*.exe and delete them. It will also stop and
remove any services that start with PAExec-* if they exist.
Before calling this function, the connect() function must have already
been called.
"""
scmr = self._service._scmr
services = scmr.enum_services_status_w(
self._service._scmr_handle, ServiceType.SERVICE_WIN32_OWN_PROCESS,
EnumServiceState.SERVICE_STATE_ALL)
for service in services:
if service['service_name'].lower().startswith("paexec"):
svc = Service(service['service_name'], self.session)
svc.open()
svc.delete()
smb_tree = TreeConnect(
self.session,
r"\\%s\%s" % (self.connection.server_name, self._share))
smb_tree.connect()
share = Open(smb_tree, "")
query_msgs = [
share.create(ImpersonationLevel.Impersonation,
DirectoryAccessMask.FILE_READ_ATTRIBUTES
| DirectoryAccessMask.SYNCHRONIZE
| DirectoryAccessMask.FILE_LIST_DIRECTORY,
FileAttributes.FILE_ATTRIBUTE_DIRECTORY,
ShareAccess.FILE_SHARE_READ
| ShareAccess.FILE_SHARE_WRITE
| ShareAccess.FILE_SHARE_DELETE,
CreateDisposition.FILE_OPEN,
CreateOptions.FILE_DIRECTORY_FILE,
send=False),
share.query_directory("PAExec-*.exe",
FileInformationClass.FILE_NAMES_INFORMATION,
send=False),
share.close(False, send=False)
]
query_reqs = self.connection.send_compound([x[0] for x in query_msgs],
self.session.session_id,
smb_tree.tree_connect_id,
related=True)
# receive response for open and close
query_msgs[0][1](query_reqs[0])
query_msgs[2][1](query_reqs[2])
try:
# receive the response for query_directory
files = query_msgs[1][1](query_reqs[1])
except SMBResponseException as exc:
if exc.status != NtStatus.STATUS_NO_SUCH_FILE:
raise exc
files = []
for file in files:
file_name = file['file_name'].get_value().decode('utf-16-le')
self._delete_file(smb_tree, file_name)
def run_executable(self,
executable,
arguments=None,
processors=None,
asynchronous=False,
load_profile=True,
interactive_session=0,
interactive=False,
run_elevated=False,
run_limited=False,
username=None,
password=None,
use_system_account=False,
working_dir=None,
show_ui_on_win_logon=False,
priority=ProcessPriority.NORMAL_PRIORITY_CLASS,
remote_log_path=None,
timeout_seconds=0,
stdout=OutputPipeBytes,
stderr=OutputPipeBytes,
stdin=None):
"""
Runs a command over the PAExec/PSExec interface based on the options
provided. At a minimum the executable argument is required and the
rest can stay as the defaults.
The default configuration for a process (with no changes) is;
User: The user that authenticated the SMB Session
Elevation: Highest possible
Working Dir: %SYSTEM_ROOT%\System32
Interactive: False
Priority: Normal
:param executable: (String) The executable to be run
:param arguments: (String) Arguments to run with the executable
:param processors: (List<Int>) The processors that the process can run
on, default is all the processors
:param asynchronous: (Bool) Whether to run the process and not wait for
the output, it will continue to run in the background. The stdout
and stderr return value will be None and the rc is not reflective
of the running process
:param load_profile: (Bool) Whether to load the user profile, default
is True
:param interactive_session: (Int) The session id that an
interactive process will run on, use with interactive=True to
run a process on an existing session
:param interactive: (Bool) Whether to run on an interative session or
not, default is False. The stdout and stderr will be None
:param run_elevated: (Bool) Whether to run as an elevated process or
not, default is False (This only applies when username is supplied)
:param run_limited: (Bool) Whether to run as a limited user context,
admin rights are removed, or not, default is False (This only
applied when username is applied)
:param username: (String) The username to run the process as, if not
set then either the SMB Session account is used or
NT AUTHORITY\SYSTEM (use_system_account=True) is used
:param password: (String) The password for the username account
:param use_system_account: (Bool) Whether to use the
NT AUTHORITY\SYSTEM account isn't of a normal user
:param working_dir: (String) The working directory that is used when
spawning the process
:param show_ui_on_win_logon: (Bool) Whether to display the UI on the
Winlogon secure desktop (use_system_account=True only), default is
False
:param priority: (paexec.ProcessPriority) The process priority level,
default is NORMAL_PRIORITY_CLASS
:param remote_log_path: (String) A path on the remote host to output
log files for the PAExec service process (for debugging purposes)
:param timeout_seconds: (Int) A timeout that will force the PAExec
process to stop once reached, default is 0 (no timeout)
:param stdout: (pipe.OutputPipe) An class that implements of
pipe.OutputPipe that handles the Named Pipe stdout output. The
default is pipe.OutputPipeBytes which returns a byte string of the
stdout
:param stderr: (pipe.OutputPipe) An class that implements of
pipe.OutputPipe that handles the Named Pipe stderr output. The
default is pipe.OutputPipeBytes which returns a byte string of the
stderr
:param stdin: Either a byte string of generator that yields multiple
byte strings to send over the stdin pipe.
:return: Tuple(stdout, stderr, rc)
stdout: (Bytes) The stdout.get_bytes() return result
stderr: (Bytes) The stderr.get_bytes() return result
rc: (Int) The return code of the process (The pid of the async
process when async=True)
"""
if run_elevated and run_limited:
raise PypsexecException("Both run_elevated and run_limited are "
"set, only 1 of these can be true")
if stdin is not None and (asynchronous or interactive):
raise PypsexecException("Cannot send stdin data on an interactive "
"or asynchronous process")
log.debug("Making sure PAExec service is running")
self._service.start()
smb_tree = TreeConnect(self.session,
r"\\%s\IPC$" % self.connection.server_name)
log.info("Connecting to SMB Tree %s" % smb_tree.share_name)
smb_tree.connect()
settings = PAExecSettingsBuffer()
settings['processors'] = processors if processors else []
settings['asynchronous'] = asynchronous
settings['dont_load_profile'] = not load_profile
settings['interactive_session'] = interactive_session
settings['interactive'] = interactive
settings['run_elevated'] = run_elevated
settings['run_limited'] = run_limited
settings['username'] = self._encode_string(username)
settings['password'] = self._encode_string(password)
settings['use_system_account'] = use_system_account
settings['working_dir'] = self._encode_string(working_dir)
settings['show_ui_on_win_logon'] = show_ui_on_win_logon
settings['priority'] = priority
settings['executable'] = self._encode_string(executable)
settings['arguments'] = self._encode_string(arguments)
settings['remote_log_path'] = self._encode_string(remote_log_path)
settings['timeout_seconds'] = timeout_seconds
input_data = PAExecSettingsMsg()
input_data['unique_id'] = self._unique_id
input_data['buffer'] = settings
# write the settings to the main PAExec pipe
pipe_access_mask = FilePipePrinterAccessMask.GENERIC_READ | \
FilePipePrinterAccessMask.GENERIC_WRITE | \
FilePipePrinterAccessMask.FILE_APPEND_DATA | \
FilePipePrinterAccessMask.READ_CONTROL | \
FilePipePrinterAccessMask.SYNCHRONIZE
for i in range(0, 3):
try:
main_pipe = open_pipe(smb_tree, self._exe_file,
pipe_access_mask)
except SMBResponseException as exc:
if exc.status != NtStatus.STATUS_OBJECT_NAME_NOT_FOUND:
raise exc
elif i == 2:
raise PypsexecException("Failed to open main PAExec pipe "
"%s, no more attempts remaining" %
self._exe_file)
log.warning("Main pipe %s does not exist yet on attempt %d. "
"Trying again in 5 seconds" %
(self._exe_file, i + 1))
time.sleep(5)
else:
break
log.info("Writing PAExecSettingsMsg to the main PAExec pipe")
log.info(str(input_data))
main_pipe.write(input_data.pack(), 0)
log.info("Reading PAExecMsg from the PAExec pipe")
settings_resp_raw = main_pipe.read(0, 1024)
settings_resp = PAExecMsg()
settings_resp.unpack(settings_resp_raw)
log.debug(str(settings_resp))
settings_resp.check_resp()
# start the process now
start_msg = PAExecMsg()
start_msg['msg_id'] = PAExecMsgId.MSGID_START_APP
start_msg['unique_id'] = self._unique_id
start_msg['buffer'] = PAExecStartBuffer()
start_buffer = PAExecStartBuffer()
start_buffer['process_id'] = self.pid
start_buffer['comp_name'] = self.current_host.encode('utf-16-le')
start_msg['buffer'] = start_buffer
log.info("Writing PAExecMsg with PAExecStartBuffer to start the "
"remote process")
log.debug(str(start_msg))
main_pipe.write(start_msg.pack(), 0)
if not interactive and not asynchronous:
# create a pipe for stdout, stderr, and stdin and run in a separate
# thread
log.info("Connecting to remote pipes to retrieve output")
stdout_pipe = stdout(smb_tree, self._stdout_pipe_name)
stdout_pipe.start()
stderr_pipe = stderr(smb_tree, self._stderr_pipe_name)
stderr_pipe.start()
stdin_pipe = InputPipe(smb_tree, self._stdin_pipe_name)
# wait until the stdout and stderr pipes have sent their first
# response
log.debug("Waiting for stdout pipe to send first request")
while not stdout_pipe.sent_first:
pass
log.debug("Waiting for stderr pipe to send first request")
while not stderr_pipe.sent_first:
pass
# send any input if there was any
try:
if stdin and isinstance(stdin, bytes):
log.info("Sending stdin bytes over stdin pipe: %s" %
self._stdin_pipe_name)
stdin_pipe.write(stdin)
elif stdin:
log.info("Sending stdin generator bytes over stdin pipe: "
"%s" % self._stdin_pipe_name)
for stdin_data in stdin():
stdin_pipe.write(stdin_data)
except SMBResponseException as exc:
# if it fails with a STATUS_PIPE_BROKEN exception, continue as
# the actual error will be in the response (process failed)
if exc.status != NtStatus.STATUS_PIPE_BROKEN:
raise exc
log.warning("Failed to send data through stdin: %s" % str(exc))
# read the final response from the process
log.info("Reading result of PAExec process")
exe_result_raw = main_pipe.read(0, 1024)
log.info("Results read of PAExec process")
if not interactive and not asynchronous:
log.info("Closing PAExec std* pipes")
stdout_pipe.close()
stderr_pipe.close()
stdin_pipe.close()
log.info("Gettings stdout and stderr from pipe buffer queue")
stdout_out = stdout_pipe.get_output()
stderr_bytes = stderr_pipe.get_output()
else:
stdout_out = None
stderr_bytes = None
log.info("Closing main PAExec pipe")
main_pipe.close()
log.info("Disconnecting from SMB Tree %s" % smb_tree.share_name)
smb_tree.disconnect()
log.info("Unpacking PAExecMsg data from process result")
exe_result = PAExecMsg()
exe_result.unpack(exe_result_raw)
log.debug(str(exe_result))
exe_result.check_resp()
log.debug("Unpacking PAExecReturnBuffer from main PAExecMsg")
rc = PAExecReturnBuffer()
rc.unpack(exe_result['buffer'].get_value())
log.debug(str(rc))
return_code = rc['return_code'].get_value()
log.info("Process finished with exit code: %d" % return_code)
log.debug("RC: %d" % return_code)
return stdout_out, stderr_bytes, return_code
def _encode_string(self, string):
return string.encode('utf-16-le') if string else None
def _empty_queue(self, queue):
data = b""
while True:
try:
data += queue.get(block=False)
except Empty:
break
return data
def _delete_file(self, tree, name):
file_open = Open(tree, name)
msgs = [
file_open.create(ImpersonationLevel.Impersonation,
FilePipePrinterAccessMask.DELETE,
FileAttributes.FILE_ATTRIBUTE_NORMAL,
0,
CreateDisposition.FILE_OPEN_IF,
CreateOptions.FILE_NON_DIRECTORY_FILE
| CreateOptions.FILE_DELETE_ON_CLOSE,
send=False),
file_open.close(get_attributes=False, send=False)
]
reqs = self.connection.send_compound([x[0] for x in msgs],
sid=self.session.session_id,
tid=tree.tree_connect_id,
related=True)
# remove the responses from the SMB outstanding requests
msgs[0][1](reqs[0])
msgs[1][1](reqs[1])