/usr/lib/python2.7/dist-packages/txwinrm/WinRMClient.py is in python-txwinrm 1.1.28-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 | ##############################################################################
#
# Copyright (C) Zenoss, Inc. 2013, all rights reserved.
#
# This content is made available according to terms specified in the LICENSE
# file at the top-level directory of this package.
#
##############################################################################
import logging
from httplib import BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, OK
from twisted.internet.defer import (
inlineCallbacks,
returnValue,
DeferredSemaphore,
succeed
)
from twisted.internet.error import TimeoutError
try:
from twisted.web.client import ResponseFailed
ResponseFailed
except ImportError:
class ResponseFailed(Exception):
pass
from . import constants as c
from kerberos import GSSError
from .util import (
_authenticate_with_kerberos,
_get_agent,
verify_conn_info,
_CONTENT_TYPE,
_ENCRYPTED_CONTENT_TYPE,
Headers,
_get_basic_auth_header,
_get_request_template,
_StringProducer,
get_auth_details,
UnauthorizedError,
ForbiddenError,
RequestError,
_ErrorReader,
_StringProtocol,
ET
)
from .shell import (
_find_shell_id,
_build_command_line_elem,
_find_command_id,
_MAX_REQUESTS_PER_COMMAND,
_find_stream,
_find_exit_code,
CommandResponse,
_stripped_lines
)
from .enumerate import (
DEFAULT_RESOURCE_URI,
SaxResponseHandler,
_MAX_REQUESTS_PER_ENUMERATION
)
from .SessionManager import SESSION_MANAGER, Session
LOG = logging.getLogger('winrm')
class WinRMSession(Session):
'''
Session class to keep track of single winrm connection
'''
def __init__(self):
super(WinRMSession, self).__init__()
# twisted agent to send http/https requests
self._agent = _get_agent()
# our kerberos context for encryption/decryption
self._gssclient = None
# url for session
self._url = None
# headers to use for requests
self._headers = None
# connection info. see util.ConnectionInfo
self._conn_info = None
# DeferredSemaphore so that we complete one transaction/conversation
# at a time. Windows cannot handle mixed transaction types on one
# connection.
self.sem = DeferredSemaphore(1)
def is_kerberos(self):
return self._conn_info.auth_type == 'kerberos'
def decrypt_body(self, body):
return self._gssclient.decrypt_body(body)
def _set_headers(self):
if self._headers:
return self._headers
if self._conn_info.auth_type == 'basic':
self._headers = Headers(_CONTENT_TYPE)
self._headers.addRawHeader('Connection', self._conn_info.connectiontype)
self._headers.addRawHeader(
'Authorization', _get_basic_auth_header(self._conn_info))
elif self.is_kerberos():
self._headers = Headers(_ENCRYPTED_CONTENT_TYPE)
self._headers.addRawHeader('Connection', self._conn_info.connectiontype)
return self._headers
@inlineCallbacks
def _deferred_login(self, client=None):
if client:
self._conn_info = client._conn_info
self._url = "{c.scheme}://{c.ipaddress}:{c.port}/wsman".format(c=self._conn_info)
if self.is_kerberos():
self._gssclient = yield _authenticate_with_kerberos(self._conn_info, self._url, self._agent)
returnValue(self._gssclient)
else:
returnValue('basic_auth_token')
@inlineCallbacks
def _deferred_logout(self):
# close connections so we do not end up with orphans
# return a Deferred()
self.loggedout = True
if self._agent and hasattr(self._agent, 'closeCachedConnections'):
# twisted 11 has no return and is part of the Agent
return succeed(self._agent.closeCachedConnections())
elif self._agent:
# twisted 12 returns a Deferred
return self._agent._pool.closeCachedConnections()
else:
# no agent
return succeed(None)
@inlineCallbacks
def handle_response(self, request, response, client):
if response.code == UNAUTHORIZED or response.code == BAD_REQUEST:
# check to see if we need to re-authorize due to lost connection or bad request error
if self._gssclient is not None:
self._gssclient.cleanup()
self._gssclient = None
self._token = None
self._agent = _get_agent()
self._login_d = None
yield SESSION_MANAGER.init_connection(client, WinRMSession)
try:
yield self._set_headers()
encrypted_request = self._gssclient.encrypt_body(request)
if not encrypted_request.startswith("--Encrypted Boundary"):
self._headers.setRawHeaders('Content-Type', _CONTENT_TYPE['Content-Type'])
body_producer = _StringProducer(encrypted_request)
response = yield self._agent.request(
'POST', self._url, self._headers, body_producer)
except Exception as e:
raise e
if response.code == UNAUTHORIZED:
if self.is_kerberos():
auth_header = response.headers.getRawHeaders('WWW-Authenticate')[0]
auth_details = get_auth_details(auth_header)
try:
if auth_details:
self._gssclient._step(auth_details)
except GSSError as e:
msg = "HTTP Unauthorized received. "
"Kerberos error code {0}: {1}.".format(e.args[1][1], e.args[1][0])
raise Exception(msg)
raise UnauthorizedError(
"HTTP Unauthorized received: Check username and password")
if response.code == FORBIDDEN:
raise ForbiddenError(
"Forbidden: Check WinRM port and version")
elif response.code != OK:
if self.is_kerberos():
reader = _ErrorReader(self._gssclient)
else:
reader = _ErrorReader()
response.deliverBody(reader)
message = yield reader.d
raise RequestError("HTTP status: {}. {}".format(
response.code, message))
returnValue(response)
@inlineCallbacks
def send_request(self, request_template_name, client, **kwargs):
response = yield self._send_request(
request_template_name, client, **kwargs)
proto = _StringProtocol()
response.deliverBody(proto)
body = yield proto.d
if self.is_kerberos():
xml_str = self._gssclient.decrypt_body(body)
else:
xml_str = yield body
if LOG.isEnabledFor(logging.DEBUG):
try:
import xml.dom.minidom
xml = xml.dom.minidom.parseString(xml_str)
LOG.debug(xml.toprettyxml())
except:
LOG.debug('Could not prettify response XML: "{0}"'.format(xml_str))
returnValue(ET.fromstring(xml_str))
@inlineCallbacks
def _send_request(self, request_template_name, client, **kwargs):
if self._login_d and not self._login_d.called:
# check for a reconnection attempt so we do not send any requests
# to a dead connection
yield self._login_d
LOG.debug('sending request: {0} {1}'.format(
request_template_name, kwargs))
request = _get_request_template(request_template_name).format(**kwargs)
self._headers = self._set_headers()
if self.is_kerberos():
encrypted_request = self._gssclient.encrypt_body(request)
if not encrypted_request.startswith("--Encrypted Boundary"):
self._headers.setRawHeaders('Content-Type', _CONTENT_TYPE['Content-Type'])
body_producer = _StringProducer(encrypted_request)
else:
body_producer = _StringProducer(request)
try:
response = yield self._agent.request(
'POST', self._url, self._headers, body_producer)
except Exception as e:
raise e
LOG.debug('received response {0} {1}'.format(
response.code, request_template_name))
response = yield self.handle_response(request, response, client)
returnValue(response)
class WinRMClient(object):
def __init__(self, conn_info):
verify_conn_info(conn_info)
self.key = None
self._conn_info = conn_info
self.session_manager = SESSION_MANAGER
self._session = None
@inlineCallbacks
def init_connection(self):
'''Initialize a connection through the session_manager'''
yield self.session_manager.init_connection(self, WinRMSession)
self._session = self.session_manager.get_connection(self.key)
returnValue(None)
def is_kerberos(self):
return self._conn_info.auth_type == 'kerberos'
def decrypt_body(self, body):
return self._session.decrypt_body(body)
@inlineCallbacks
def _create_shell(self):
elem = yield self._session.send_request('create', self)
returnValue(_find_shell_id(elem))
@inlineCallbacks
def _delete_shell(self, shell_id):
yield self._session.send_request('delete', self, shell_id=shell_id)
returnValue(None)
@inlineCallbacks
def _signal_terminate(self, shell_id, command_id):
yield self._session.send_request('signal',
self,
shell_id=shell_id,
command_id=command_id,
signal_code=c.SHELL_SIGNAL_TERMINATE)
returnValue(None)
@inlineCallbacks
def _signal_ctrl_c(self, shell_id, command_id):
yield self._session.send_request('signal',
self,
shell_id=shell_id,
command_id=command_id,
signal_code=c.SHELL_SIGNAL_CTRL_C)
returnValue(None)
@inlineCallbacks
def _send_command(self, shell_id, command_line):
command_line_elem = _build_command_line_elem(command_line)
command_elem = yield self._session.send_request(
'command', self, shell_id=shell_id, command_line_elem=command_line_elem,
timeout=self._conn_info.timeout)
returnValue(command_elem)
@inlineCallbacks
def _send_receive(self, shell_id, command_id):
receive_elem = yield self._session.send_request(
'receive', self, shell_id=shell_id, command_id=command_id)
returnValue(receive_elem)
@inlineCallbacks
def close_connection(self):
yield self.session_manager.close_connection(self)
returnValue(None)
class SingleCommandClient(WinRMClient):
def __init__(self, conn_info):
super(SingleCommandClient, self).__init__(conn_info)
self.key = (self._conn_info.ipaddress, 'short')
@inlineCallbacks
def run_command(self, command_line):
'''
Run a single command in the session's semaphore. Windows must finish
a command conversation before a new command or enumeration can start
'''
yield self.init_connection()
try:
cmd_response = yield self._session.sem.run(self.run_single_command,
command_line)
except Exception:
yield self.close_connection()
returnValue(cmd_response)
@inlineCallbacks
def run_single_command(self, command_line):
"""
Run a single command line in a remote shell like the winrs application
on Windows. Returns a dictionary with the following
structure:
CommandResponse
.stdout = [<non-empty, stripped line>, ...]
.stderr = [<non-empty, stripped line>, ...]
.exit_code = <int>
"""
shell_id = yield self._create_shell()
try:
cmd_response = yield self._run_command(shell_id, command_line)
except TimeoutError:
yield self.close_connection()
yield self._delete_shell(shell_id)
yield self.close_connection()
returnValue(cmd_response)
@inlineCallbacks
def _run_command(self, shell_id, command_line):
command_elem = yield self._send_command(shell_id, command_line)
command_id = _find_command_id(command_elem)
stdout_parts = []
stderr_parts = []
for i in xrange(_MAX_REQUESTS_PER_COMMAND):
receive_elem = yield self._send_receive(shell_id, command_id)
stdout_parts.extend(
_find_stream(receive_elem, command_id, 'stdout'))
stderr_parts.extend(
_find_stream(receive_elem, command_id, 'stderr'))
exit_code = _find_exit_code(receive_elem, command_id)
if exit_code is not None:
break
else:
raise Exception("Reached max requests per command.")
yield self._signal_terminate(shell_id, command_id)
stdout = _stripped_lines(stdout_parts)
stderr = _stripped_lines(stderr_parts)
returnValue(CommandResponse(stdout, stderr, exit_code))
class LongCommandClient(WinRMClient):
def __init__(self, conn_info):
super(LongCommandClient, self).__init__(conn_info)
self._shell_id = None
self._command_id = None
self._exit_code = None
@inlineCallbacks
def start(self, command_line):
LOG.debug("LongRunningCommand run_command: {0}".format(command_line))
self.key = (self._conn_info.ipaddress, command_line)
yield self.init_connection()
self._shell_id = yield self._create_shell()
command_line_elem = _build_command_line_elem(command_line)
LOG.debug('LongRunningCommand run_command: sending command request '
'(shell_id={0}, command_line_elem={1})'.format(
self._shell_id, command_line_elem))
try:
command_elem = yield self._send_command(self._shell_id,
command_line)
except TimeoutError:
yield self.close_connection()
raise
self._command_id = _find_command_id(command_elem)
returnValue(None)
@inlineCallbacks
def receive(self):
try:
receive_elem = yield self._send_receive(self._shell_id, self._command_id)
except TimeoutError:
yield self.close_connection()
raise
stdout_parts = _find_stream(receive_elem, self._command_id, 'stdout')
stderr_parts = _find_stream(receive_elem, self._command_id, 'stderr')
self._exit_code = _find_exit_code(receive_elem, self._command_id)
stdout = _stripped_lines(stdout_parts)
stderr = _stripped_lines(stderr_parts)
returnValue((stdout, stderr))
@inlineCallbacks
def stop(self, close=False):
yield self._signal_ctrl_c(self._shell_id, self._command_id)
try:
stdout, stderr = yield self.receive()
except TimeoutError:
pass
yield self._signal_terminate(self._shell_id, self._command_id)
yield self._delete_shell(self._shell_id)
if close:
yield self.close_connection()
returnValue(CommandResponse(stdout, stderr, self._exit_code))
class EnumerateClient(WinRMClient):
"""
Sends enumerate requests to a host running the WinRM service and returns
a list of items.
"""
def __init__(self, conn_info):
super(EnumerateClient, self).__init__(conn_info)
self._handler = SaxResponseHandler(self)
self._hostname = conn_info.ipaddress
self.key = (conn_info.ipaddress, 'short')
@inlineCallbacks
def enumerate(self, wql, resource_uri=DEFAULT_RESOURCE_URI):
"""
Runs a remote WQL query.
"""
self.init_connection()
request_template_name = 'enumerate'
enumeration_context = None
items = []
try:
for i in xrange(_MAX_REQUESTS_PER_ENUMERATION):
LOG.info('{0} "{1}" {2}'.format(
self._hostname, wql, request_template_name))
response = yield self._session._send_request(
request_template_name,
self,
resource_uri=resource_uri,
wql=wql,
enumeration_context=enumeration_context)
LOG.info("{0} {1} HTTP status: {2}".format(
self._hostname, wql, response.code))
enumeration_context, new_items = \
yield self._handler.handle_response(response)
items.extend(new_items)
if not enumeration_context:
break
request_template_name = 'pull'
else:
raise Exception("Reached max requests per enumeration.")
except (ResponseFailed, RequestError, Exception) as e:
if isinstance(e, ResponseFailed):
for reason in e.reasons:
LOG.error('{0} {1}'.format(self._hostname, reason.value))
else:
LOG.info('{0} {1}'.format(self._hostname, e))
raise
returnValue(items)
@inlineCallbacks
def do_collect(self, enum_infos):
'''
Run enumerations in the session's semaphore. Windows must finish
an enumeration before a new command or enumeration can start
'''
items = {}
yield self.init_connection()
self._session = self.session_manager.get_connection(self.key)
for enum_info in enum_infos:
try:
items[enum_info] = yield self._session.sem.run(self.enumerate,
enum_info.wql,
enum_info.resource_uri)
except (UnauthorizedError, ForbiddenError):
# Fail the collection for general errors.
raise
except RequestError:
# Store empty results for other query-specific errors.
continue
yield self.close_connection()
returnValue(items)
|