/usr/lib/python2.7/dist-packages/txwinrm/util.py is in python-txwinrm 1.3.3-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 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 | ##############################################################################
#
# 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 os
import re
import base64
import logging
import httplib
from datetime import datetime
from collections import namedtuple
from xml.etree import cElementTree as ET
from xml.etree.ElementTree import ParseError
from twisted.internet import reactor, defer
from twisted.internet.protocol import Protocol
from twisted.web.client import Agent
from twisted.internet.error import ConnectError
from twisted.internet.ssl import ClientContextFactory
from twisted.web.http_headers import Headers
from twisted.internet.threads import deferToThread
from . import constants as c
from .krb5 import kinit, ccname, add_trusted_realm, config
# ZEN-15434 lazy import to avoid segmentation fault during install
kerberos = None
log = logging.getLogger('winrm')
_XML_WHITESPACE_PATTERN = re.compile(r'>\s+<')
_AGENT = None
_MAX_PERSISTENT_PER_HOST = 200
_CACHED_CONNECTION_TIMEOUT = 24000
_CONNECT_TIMEOUT = 500
_NANOSECONDS_PATTERN = re.compile(r'\.(\d{6})(\d{3})')
_REQUEST_TEMPLATE_NAMES = (
'enumerate', 'pull',
'create', 'command', 'send', 'receive', 'signal', 'delete',
'subscribe', 'event_pull', 'unsubscribe', 'enum_shells', 'pull_shells')
_REQUEST_TEMPLATE_DIR = os.path.join(
os.path.dirname(os.path.abspath(__file__)), 'request')
_REQUEST_TEMPLATES = {}
_CONTENT_TYPE = {'Content-Type': ['application/soap+xml;charset=UTF-8']}
_MAX_KERBEROS_RETRIES = 3
_MARKER = object()
_ENCRYPTED_CONTENT_TYPE = {
"Content-Type": [
"multipart/encrypted;"
"protocol=\"application/HTTP-Kerberos-session-encrypted\";"
"boundary=\"Encrypted Boundary\""]}
_BODY = """--Encrypted Boundary
Content-Type: application/HTTP-Kerberos-session-encrypted
OriginalContent: type=application/soap+xml;charset=UTF-8;Length={original_length}
--Encrypted Boundary
Content-Type: application/octet-stream
{emsg}--Encrypted Boundary
"""
_KRB_INTERNAL_CACHE_ERR = 'Internal credentials cache error while storing '\
'credentials while getting initial credentials'
def _has_get_attr(obj, attr_name):
attr_value = getattr(obj, attr_name, _MARKER)
if attr_value is _MARKER:
return False, None
return True, attr_value
class MyWebClientContextFactory(object):
def __init__(self):
self._options = ClientContextFactory()
def getContext(self, hostname, port):
return self._options.getContext()
def _get_agent():
context_factory = MyWebClientContextFactory()
try:
# HTTPConnectionPool has been present since Twisted version 12.1
from twisted.web.client import HTTPConnectionPool
pool = HTTPConnectionPool(reactor, persistent=True)
pool.maxPersistentPerHost = _MAX_PERSISTENT_PER_HOST
pool.cachedConnectionTimeout = _CACHED_CONNECTION_TIMEOUT
agent = Agent(reactor, context_factory,
connectTimeout=_CONNECT_TIMEOUT, pool=pool)
except ImportError:
from _zenclient import ZenAgent
agent = ZenAgent(reactor, context_factory, persistent=True, maxConnectionsPerHostName=1)
return agent
class _StringProducer(object):
"""
The length attribute must be a non-negative integer or the constant
twisted.web.iweb.UNKNOWN_LENGTH. If the length is known, it will be used to
specify the value for the Content-Length header in the request. If the
length is unknown the attribute should be set to UNKNOWN_LENGTH. Since more
servers support Content-Length, if a length can be provided it should be.
"""
def __init__(self, body):
self._body = body
self.length = len(body)
def startProducing(self, consumer):
"""
This method is used to associate a consumer with the producer. It
should return a Deferred which fires when all data has been produced.
"""
consumer.write(self._body)
return defer.succeed(None)
def pauseProducing(self):
pass
def stopProducing(self):
pass
def _parse_error_message(xml_str):
if not xml_str:
return ""
try:
elem = ET.fromstring(xml_str)
text = elem.findtext('.//{' + c.XML_NS_SOAP_1_2 + '}Text').strip()
detail = elem.findtext('.//{' + c.XML_NS_SOAP_1_2 + '}Detail/*/*').strip()
except ParseError:
return "Malformed XML: {}".format(xml_str)
except Exception:
return "Unexpected Response ({})".format(xml_str)
return "{0} {1}".format(text, detail)
class _ErrorReader(Protocol):
def __init__(self, gssclient=None):
self.d = defer.Deferred()
self._data = []
self.gssclient = gssclient
def dataReceived(self, data):
self._data.append(data)
def connectionLost(self, reason):
if self.gssclient:
try:
body = self.gssclient.decrypt_body(''.join(self._data))
except Exception as e:
body = 'There was a problem decrypting an error message: {}.'\
' Check WinRM logs on {}'.format(e.message, self.gssclient._conn_info.hostname)
else:
body = ''.join(self._data)
message = _parse_error_message(body)
self.d.callback(message)
class RequestError(Exception):
pass
class ForbiddenError(RequestError):
pass
class UnauthorizedError(RequestError):
pass
def _get_request_template(name):
if name not in _REQUEST_TEMPLATE_NAMES:
raise Exception('Invalid request template name: {0}'.format(name))
if name not in _REQUEST_TEMPLATES:
path = os.path.join(_REQUEST_TEMPLATE_DIR, '{0}.xml'.format(name))
with open(path) as f:
_REQUEST_TEMPLATES[name] = \
_XML_WHITESPACE_PATTERN.sub('><', f.read()).strip()
return _REQUEST_TEMPLATES[name]
def _get_basic_auth_header(conn_info):
authstr = "{0}:{1}".format(conn_info.username, conn_info.password)
return 'Basic {0}'.format(base64.encodestring(authstr).strip())
class AuthGSSClient(object):
"""
The Generic Security Services (GSS) API allows Kerberos implementations to
be API compatible. Instances of this class operate on a context for GSSAPI
client-side authentication with the given service principal.
GSSAPI Function Result Codes:
-1 : Error
0 : GSSAPI step continuation (only returned by 'Step' function)
1 : GSSAPI step complete, or function return OK
"""
def __init__(self, service, conn_info):
"""
@param service: a string containing the service principal in the form
'type@fqdn' (e.g. 'imap@mail.apple.com').
"""
# ZEN-15434 Lazy import. import causes segmentation fault because of
# differing versions of the kerberos.so file. Only import here
global kerberos
if not kerberos:
import kerberos
self._service = service
self._conn_info = conn_info
self._username = conn_info.username
self._password = conn_info.password
self._realm = conn_info.username.split('@')[1].upper()
self._dcip = conn_info.dcip
self._include_dir = conn_info.include_dir
gssflags = kerberos.GSS_C_CONF_FLAG | kerberos.GSS_C_MUTUAL_FLAG | kerberos.GSS_C_SEQUENCE_FLAG | kerberos.GSS_C_INTEG_FLAG
os.environ['KRB5CCNAME'] = ccname(conn_info.username)
if conn_info.trusted_realm and conn_info.trusted_kdc:
add_trusted_realm(conn_info.trusted_realm, conn_info.trusted_kdc)
if hasattr(kerberos, 'authGSSClientWrapIov'):
result_code, self._context = kerberos.authGSSClientInit(service, gssflags=gssflags)
else:
result_code, self._context = kerberos.authGSSClientInit(service)
if result_code != kerberos.AUTH_GSS_COMPLETE:
raise Exception('kerberos authGSSClientInit failed')
def __del__(self):
if self._context is not None:
result_code = kerberos.authGSSClientClean(self._context)
if result_code != kerberos.AUTH_GSS_COMPLETE:
raise Exception('kerberos authGSSClientClean failed')
def _step(self, challenge=''):
"""
Processes a single GSSAPI client-side step using the supplied server
data.
@param challenge: a string containing the base64-encoded server data
(which may be empty for the first step).
@return: a result code
"""
log.debug('GSSAPI step challenge="{0}"'.format(challenge))
return deferToThread(kerberos.authGSSClientStep, self._context, challenge)
@defer.inlineCallbacks
def get_base64_client_data(self, challenge=''):
"""
@return: a string containing the base64-encoded client data to be sent
to the server.
"""
result_code = None
for i in xrange(_MAX_KERBEROS_RETRIES):
try:
result_code = yield self._step(challenge)
break
except kerberos.GSSError as e:
msg = e.args[1][0]
if msg == 'Cannot determine realm for numeric host address':
raise Exception(msg)
elif msg == 'Server not found in Kerberos database':
raise Exception(msg + ': ' + self._service)
log.debug('{0}. Calling kinit.'.format(msg))
kinit_result = yield kinit(self._username,
self._password,
self._dcip,
includedir=self._include_dir,
disable_rdns=self._conn_info.disable_rdns)
if kinit_result:
# this error is ok. it just means more
# than one process is calling kinit
if _KRB_INTERNAL_CACHE_ERR not in kinit_result:
kinit_result = kinit_result.strip()
extra = ''
if 'Realm not local to KDC while getting initial credentials' in kinit_result:
extra = ' Make sure all KDCs are valid: {}'.format(','.join(config.realms[self._realm]))
raise Exception(kinit_result + extra)
if result_code != kerberos.AUTH_GSS_CONTINUE:
raise Exception('kerberos authGSSClientStep failed ({0}).'
.format(result_code))
base64_client_data = kerberos.authGSSClientResponse(self._context)
defer.returnValue(base64_client_data)
@defer.inlineCallbacks
def get_username(self, challenge):
"""
Get the user name of the principal authenticated via the now complete
GSSAPI client-side operations.
@param challenge: a string containing the base64-encoded server data
@return: a string containing the user name.
"""
result_code = yield self._step(challenge)
if result_code != kerberos.AUTH_GSS_COMPLETE:
raise Exception('kerberos authGSSClientStep failed ({0}). '
'challenge={1}'
.format(result_code, challenge))
defer.returnValue(kerberos.authGSSClientUserName(self._context))
def encrypt_body(self, body):
# get original length of body. wrap will encrypt in place
orig_len = len(body)
# encode before sending to wrap func
ebody = base64.b64encode(body)
# wrap it up
try:
rc, pad_len = kerberos.authGSSClientWrapIov(self._context, ebody, 1)
if rc is not kerberos.AUTH_GSS_COMPLETE:
log.debug("Unable to encrypt message body")
return
except AttributeError:
# must be on centos 5, encryption not possible
return body
except kerberos.GSSError as e:
msg = e.args[1][0]
raise Exception(msg)
# get wrapped request which is in b64 encoding
ewrap = kerberos.authGSSClientResponse(self._context)
# decode wrapped request
payload = bytes(base64.b64decode(ewrap))
# add carriage returns to body
body = _BODY.replace('\n', '\r\n')
body = bytes(body.format(original_length=orig_len + pad_len, emsg=payload))
return body
def decrypt_body(self, body):
try:
b_start = body.index("Content-Type: application/octet-stream") + \
len("Content-Type: application/octet-stream\r\n")
except ValueError:
# Unencrypted data, return body
return body
b_end = body.index("--Encrypted Boundary", b_start)
ebody = body[b_start:b_end]
ebody = base64.b64encode(ebody)
try:
rc = kerberos.authGSSClientUnwrapIov(self._context, ebody)
except kerberos.GSSError as e:
msg = e.args[1][0]
raise Exception(msg)
if rc is not kerberos.AUTH_GSS_COMPLETE:
log.debug("Unable to decrypt message body")
return
ewrap = kerberos.authGSSClientResponse(self._context)
body = base64.b64decode(ewrap)
return body
def cleanup(self):
kerberos.authGSSClientClean(self._context)
self._context = None
def get_auth_details(auth_header=''):
auth_details = ''
for field in auth_header.split(','):
try:
kind, details = field.strip().split(' ', 1)
if kind.lower() == 'kerberos':
auth_details = details.strip()
break
except ValueError:
continue
return auth_details
@defer.inlineCallbacks
def _authenticate_with_kerberos(conn_info, url, agent, gss_client=None):
service = '{0}@{1}'.format(conn_info.service.upper(), conn_info.hostname)
if gss_client is None:
gss_client = AuthGSSClient(
service,
conn_info)
base64_client_data = yield gss_client.get_base64_client_data()
auth = 'Kerberos {0}'.format(base64_client_data)
k_headers = Headers(_CONTENT_TYPE)
k_headers.addRawHeader('Authorization', auth)
k_headers.addRawHeader('Content-Length', '0')
response = yield agent.request('POST', url, k_headers, None)
auth_header = response.headers.getRawHeaders('WWW-Authenticate')[0]
auth_details = get_auth_details(auth_header)
if response.code == httplib.UNAUTHORIZED:
try:
if auth_details:
yield gss_client._step(auth_details)
except kerberos.GSSError as e:
msg = "HTTP Unauthorized received on kerberos initialization. "\
"Kerberos error code {0}: {1}.".format(e.args[1][1], e.args[1][0])
raise Exception(msg)
raise UnauthorizedError(
"HTTP Unauthorized received on initial kerberos request. Check username and password")
elif response.code == httplib.FORBIDDEN:
raise ForbiddenError(
"Forbidden. Check WinRM port and version.")
elif response.code != httplib.OK:
proto = _StringProtocol()
response.deliverBody(proto)
xml_str = yield proto.d
xml_str = gss_client.decrypt_body(xml_str)
raise Exception(
"status code {0} received on initial kerberos request {1}"
.format(response.code, xml_str))
if not auth_details:
raise Exception(
'negotiate not found in WWW-Authenticate header: {0}'
.format(auth_header))
k_username = yield gss_client.get_username(auth_details)
log.debug('kerberos auth successful for user: {0} / {1} '
.format(conn_info.username, k_username))
defer.returnValue(gss_client)
class ConnectionInfo(namedtuple(
'ConnectionInfo', [
'hostname',
'auth_type',
'username',
'password',
'scheme',
'port',
'connectiontype',
'keytab',
'dcip',
'timeout',
'trusted_realm',
'trusted_kdc',
'ipaddress',
'service',
'envelope_size',
'code_page',
'locale',
'include_dir',
'disable_rdns'])):
def __new__(cls, hostname, auth_type, username, password, scheme, port,
connectiontype, keytab, dcip, timeout=60, trusted_realm='',
trusted_kdc='', ipaddress='', service='', envelope_size=512000,
code_page=65001, locale='en-US', include_dir=None, disable_rdns=False):
if not ipaddress:
ipaddress = hostname
if not service:
service = scheme
return super(ConnectionInfo, cls).__new__(cls, hostname, auth_type,
username, password, scheme,
port, connectiontype, keytab,
dcip, timeout,
trusted_realm, trusted_kdc,
ipaddress, service,
envelope_size, code_page, locale,
include_dir, disable_rdns)
def verify_include_dir(conn_info):
has_include_dir, include_dir = _has_get_attr(conn_info, 'include_dir')
if has_include_dir and include_dir:
if not os.path.exists(include_dir):
raise Exception("includedir must be a valid location")
def verify_code_page(conn_info):
has_code_page, code_page = _has_get_attr(conn_info, 'code_page')
if not has_code_page or not isinstance(code_page, int):
raise Exception("code_page must be an integer")
def verify_envelope_size(conn_info):
has_envelope_size, envelope_size = _has_get_attr(conn_info, 'envelope_size')
if not has_envelope_size or not isinstance(envelope_size, int):
raise Exception("envelope_size must be an integer")
def verify_hostname(conn_info):
has_hostname, hostname = _has_get_attr(conn_info, 'hostname')
if not has_hostname or not hostname:
raise Exception("hostname is not resolvable")
def verify_ipaddress(conn_info):
has_ipaddress, ipaddress = _has_get_attr(conn_info, 'ipaddress')
if not has_ipaddress or not ipaddress:
raise Exception("ipaddress missing")
def verify_auth_type(conn_info):
has_auth_type, auth_type = _has_get_attr(conn_info, 'auth_type')
if not has_auth_type or auth_type not in ('basic', 'kerberos'):
raise Exception(
"auth_type must be basic or kerberos: {0}".format(auth_type))
def verify_username(conn_info):
has_username, username = _has_get_attr(conn_info, 'username')
if not has_username or not username:
raise Exception("username missing")
def verify_password(conn_info):
has_password, password = _has_get_attr(conn_info, 'password')
if not has_password or not password:
raise Exception("password missing")
def verify_scheme(conn_info):
has_scheme, scheme = _has_get_attr(conn_info, 'scheme')
if not has_scheme or scheme not in ['http', 'https']:
raise Exception(
"scheme must be http or https: {0}"
.format(scheme))
def verify_service(conn_info):
has_service, service = _has_get_attr(conn_info, 'service')
if not has_service:
# if not supplied, default to scheme
has_service, service = _has_get_attr(conn_info, 'scheme')
if not has_service or service not in ['http', 'https', 'wsman']:
raise Exception(
"service must be http, https, or wsman: {0}"
.format(service))
def verify_port(conn_info):
has_port, port = _has_get_attr(conn_info, 'port')
if not has_port or not port or not isinstance(port, int):
raise Exception("illegal value for port: {0}".format(port))
def verify_connectiontype(conn_info):
has_connectiontype, connectiontype = _has_get_attr(conn_info, 'connectiontype')
if not has_connectiontype or not connectiontype:
raise Exception("connectiontype missing")
def verify_timeout(conn_info):
has_timeout, timeout = _has_get_attr(conn_info, 'timeout')
if not has_timeout:
raise Exception("timeout missing")
if not timeout:
conn_info.timeout = 60
def verify_conn_info(conn_info):
verify_hostname(conn_info)
verify_ipaddress(conn_info)
verify_auth_type(conn_info)
verify_username(conn_info)
verify_password(conn_info)
verify_scheme(conn_info)
verify_port(conn_info)
verify_connectiontype(conn_info)
verify_timeout(conn_info)
verify_include_dir(conn_info)
class RequestSender(object):
def __init__(self, conn_info):
verify_conn_info(conn_info)
self._conn_info = conn_info
self._url = None
self._headers = None
self.gssclient = None
self.agent = _get_agent()
self.authorized = False
@defer.inlineCallbacks
def _get_url_and_headers(self):
url = "{c.scheme}://{c.ipaddress}:{c.port}/wsman".format(c=self._conn_info)
if self._conn_info.auth_type == 'basic':
headers = Headers(_CONTENT_TYPE)
headers.addRawHeader('Connection', self._conn_info.connectiontype)
if not self.authorized:
headers.addRawHeader(
'Authorization', _get_basic_auth_header(self._conn_info))
self.authorized = True
elif self.is_kerberos():
headers = Headers(_ENCRYPTED_CONTENT_TYPE)
headers.addRawHeader('Connection', self._conn_info.connectiontype)
if self.gssclient is None:
self.gssclient = yield _authenticate_with_kerberos(self._conn_info, url, self.agent)
else:
raise Exception('unknown auth type: {0}'.format(self._conn_info.auth_type))
defer.returnValue((url, headers))
@defer.inlineCallbacks
def _set_url_and_headers(self):
self._url, self._headers = yield self._get_url_and_headers()
@property
def hostname(self):
return self._conn_info.hostname
def is_kerberos(self):
return self._conn_info.auth_type == 'kerberos'
def decrypt_body(self, body):
return self.gssclient.decrypt_body(body)
@defer.inlineCallbacks
def send_request(self, request_template_name, **kwargs):
log.debug('sending request: {0} {1}'.format(
request_template_name, kwargs))
kwargs['envelope_size'] = getattr(self._conn_info, 'envelope_size', 512000)
kwargs['locale'] = getattr(self._conn_info, 'locale', 'en-US')
kwargs['code_page'] = getattr(self._conn_info, 'code_page', 65001)
if not self._url or self._conn_info.auth_type == 'kerberos':
yield self._set_url_and_headers()
request = _get_request_template(request_template_name).format(**kwargs)
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)
@defer.inlineCallbacks
def reset_agent_resend(sender, request, body_producer):
yield self.close_connections()
if sender.is_kerberos():
try:
yield sender._set_url_and_headers()
encrypted_request = sender.gssclient.encrypt_body(request)
if not encrypted_request.startswith("--Encrypted Boundary"):
sender._headers.setRawHeaders('Content-Type', _CONTENT_TYPE['Content-Type'])
body_producer = _StringProducer(encrypted_request)
except Exception as e:
raise e
try:
response = yield sender.agent.request(
'POST', sender._url, sender._headers, body_producer)
except Exception as e:
raise e
defer.returnValue(response)
try:
response = yield self.agent.request(
'POST', self._url, self._headers, body_producer)
except ConnectError:
# network timeout. could be stale connection, so let's reset
response = yield reset_agent_resend(self, request, body_producer)
except Exception as e:
raise e
log.debug('received response {0} {1}'.format(
response.code, request_template_name))
if response.code == httplib.UNAUTHORIZED or response.code == httplib.BAD_REQUEST:
# check to see if we need to re-authorize due to lost connection or bad request error
response = yield reset_agent_resend(self, request, body_producer)
if response.code == httplib.UNAUTHORIZED:
if self.is_kerberos():
auth_header = response.headers.getRawHeaders('WWW-Authenticate')[0]
auth_details = get_auth_details(auth_header)
try:
if auth_details:
yield self.gssclient._step(auth_details)
except kerberos.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 == httplib.FORBIDDEN:
raise ForbiddenError(
"Forbidden: Check WinRM port and version")
elif response.code != httplib.OK:
if self.is_kerberos():
reader = _ErrorReader(self.gssclient)
else:
reader = _ErrorReader()
response.deliverBody(reader)
message = yield reader.d
if 'maximum number of concurrent operations for this user has been exceeded' in message:
message += ' To fix this, increase the MaxConcurrentOperationsPerUser WinRM'\
' Configuration option to 4294967295 and restart the winrm service.'
raise RequestError("HTTP status: {0}. {1}".format(
response.code, message))
defer.returnValue(response)
@defer.inlineCallbacks
def close_connections(self):
# close connections
# return a Deferred()
if self.agent and hasattr(self.agent, 'closeCachedConnections'):
# twisted 11 has no return and is part of the Agent
self.agent.closeCachedConnections()
elif self.agent:
# twisted 12 returns a Deferred from the pool
yield self.agent._pool.closeCachedConnections()
if self.gssclient is not None:
self.gssclient.cleanup()
self.gssclient = None
defer.returnValue(None)
class _StringProtocol(Protocol):
def __init__(self):
self.d = defer.Deferred()
self._data = []
def dataReceived(self, data):
self._data.append(data)
def connectionLost(self, reason):
self.d.callback(''.join(self._data))
class EtreeRequestSender(object):
"""A request sender that returns an etree element"""
def __init__(self, sender):
self._sender = sender
@defer.inlineCallbacks
def send_request(self, request_template_name, **kwargs):
resp = yield self._sender.send_request(
request_template_name, **kwargs)
proto = _StringProtocol()
resp.deliverBody(proto)
body = yield proto.d
if self._sender.is_kerberos():
xml_str = self._sender.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 Exception:
log.debug('Could not prettify response XML: "{0}"'.format(xml_str))
defer.returnValue(ET.fromstring(xml_str))
@defer.inlineCallbacks
def close_connections(self):
closed = yield self._sender.close_connections()
defer.returnValue(closed)
def create_etree_request_sender(conn_info):
sender = RequestSender(conn_info)
return EtreeRequestSender(sender)
TZOFFSET_PATTERN = re.compile(r'[-+]\d+:\d\d$')
def get_datetime(text):
"""
Parse the date from a WinRM response and return a datetime object.
"""
text2 = TZOFFSET_PATTERN.sub('Z', text)
if text2.endswith('Z'):
if '.' in text2:
format = "%Y-%m-%dT%H:%M:%S.%fZ"
date_string = _NANOSECONDS_PATTERN.sub(r'.\g<1>', text2)
else:
format = "%Y-%m-%dT%H:%M:%SZ"
date_string = text2
else:
format = '%m/%d/%Y %H:%M:%S.%f'
date_string = text2
return datetime.strptime(date_string, format)
|