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
|
import base64
import hashlib
import hmac
import os
import re
import sys
import time
from configparser import ConfigParser
from datetime import datetime, timedelta
from fnmatch import fnmatch
from urllib.parse import quote
import pytz
import requests
from requests.structures import CaseInsensitiveDict
try:
from . import AIOCloudStack # noqa
except ImportError:
pass
TIMEOUT = 10
PAGE_SIZE = 500
POLL_INTERVAL = 2.0
EXPIRATION = timedelta(minutes=10)
EXPIRES_FORMAT = "%Y-%m-%dT%H:%M:%S%z"
REQUIRED_CONFIG_KEYS = {"endpoint", "key", "secret", "method", "timeout"}
ALLOWED_CONFIG_KEYS = {
"verify",
"cert",
"cert_key",
"retry",
"theme",
"expiration",
"poll_interval",
"trace",
"dangerous_no_tls_verify",
"header_*",
}
DEFAULT_CONFIG = {
"timeout": 10,
"method": "get",
"retry": 0,
"verify": None,
"cert": None,
"cert_key": None,
"name": None,
"expiration": 600,
"poll_interval": POLL_INTERVAL,
"trace": None,
"dangerous_no_tls_verify": False,
}
PENDING = 0
SUCCESS = 1
FAILURE = 2
def strtobool(val):
"""Convert a string representation of truth to true (1) or false (0).
True values are 'y', 'yes', 't', 'true', 'on', and '1'; false values
are 'n', 'no', 'f', 'false', 'off', and '0'. Raises ValueError if
'val' is anything else.
This function has been borrowed from distutils.util module in order
to avoid pulling a dependency on deprecated module "imp".
"""
val = val.lower()
if val in ("y", "yes", "t", "true", "on", "1"):
return 1
elif val in ("n", "no", "f", "false", "off", "0"):
return 0
else:
raise ValueError("invalid truth value %r" % (val,))
def check_key(key, allowed):
"""
Validate that the specified key is allowed according the provided
list of patterns.
"""
if key in allowed:
return True
for pattern in allowed:
if fnmatch(key, pattern):
return True
return False
def cs_encode(s):
"""Encode URI component like CloudStack would do before signing.
java.net.URLEncoder.encode(s).replace('+', '%20')
"""
return quote(s, safe="*")
def transform(params):
"""
Transforms an heterogeneous map of params into a CloudStack
ready mapping of parameter to values.
It handles lists and dicts.
>>> p = {"a": 1, "b": "foo", "c": ["eggs", "spam"], "d": {"key": "value"}}
>>> transform(p)
>>> print(p)
{'a': '1', 'b': 'foo', 'c': 'eggs,spam', 'd[0].key': 'value'}
"""
for key, value in list(params.items()):
if value is None:
params.pop(key)
continue
if isinstance(value, (str, bytes)):
continue
if isinstance(value, int):
params[key] = str(value)
elif isinstance(value, (list, tuple, set, dict)):
if not value:
params.pop(key)
else:
if isinstance(value, dict):
value = [value]
if isinstance(value, set):
value = list(value)
if not isinstance(value[0], dict):
params[key] = ",".join(value)
else:
params.pop(key)
for index, val in enumerate(value):
for name, v in val.items():
k = "%s[%d].%s" % (key, index, name)
params[k] = str(v)
else:
raise ValueError(type(value))
class CloudStackException(Exception):
"""Exception nicely wrapping a request response."""
def __init__(self, *args, **kwargs):
self.response = kwargs.pop("response")
super(CloudStackException, self).__init__(*args, **kwargs)
class CloudStackApiException(CloudStackException):
def __init__(self, *args, **kwargs):
self.error = kwargs.pop("error")
super(CloudStackApiException, self).__init__(*args, **kwargs)
def __str__(self):
return "{0}, error: {1}".format(
super(CloudStackApiException, self).__str__(), self.error
)
ten_minutes = timedelta(minutes=10)
class CloudStack(object):
def __init__(
self,
endpoint,
key,
secret,
timeout=10,
method="get",
verify=None,
cert=None,
cert_key=None,
name=None,
retry=0,
job_timeout=None,
poll_interval=POLL_INTERVAL,
expiration=ten_minutes,
trace=False,
dangerous_no_tls_verify=False,
headers=None,
session=None,
fetch_result=False,
):
self.endpoint = endpoint
self.key = key
self.secret = secret
self.timeout = int(timeout)
self.method = method.lower()
if verify:
self.verify = verify
else:
self.verify = not dangerous_no_tls_verify
if headers is None:
headers = {}
self.headers = headers
self.session = session if session is not None else requests.Session()
if cert and cert_key:
cert = (cert, cert_key)
self.cert = cert
self.name = name
self.retry = int(retry)
self.job_timeout = int(job_timeout) if job_timeout else None
self.poll_interval = float(poll_interval)
if not hasattr(expiration, "seconds"):
expiration = timedelta(seconds=int(expiration))
self.expiration = expiration
self.trace = bool(trace)
self.fetch_result = fetch_result
def __repr__(self):
return "<CloudStack: {0}>".format(self.name or self.endpoint)
def __getattr__(self, command):
def handler(**kwargs):
return self._request(command, **kwargs)
return handler
def _prepare_request(
self,
command,
json=True,
opcode_name="command",
fetch_list=False,
**kwargs,
):
params = CaseInsensitiveDict(**kwargs)
params.update(
{
"apiKey": self.key,
opcode_name: command,
}
)
if json:
params["response"] = "json"
if "page" in kwargs or fetch_list:
params.setdefault("pagesize", PAGE_SIZE)
if "expires" not in params and self.expiration.total_seconds() >= 0:
params["signatureVersion"] = "3"
tz = pytz.utc
expires = tz.localize(datetime.utcnow() + self.expiration)
params["expires"] = expires.astimezone(tz).strftime(EXPIRES_FORMAT)
kind = "params" if self.method == "get" else "data"
return kind, dict(params.items())
def _request(
self,
command,
json=True,
opcode_name="command",
fetch_list=False,
headers=None,
**params,
):
fetch_result = params.pop("fetch_result", self.fetch_result)
kind, params = self._prepare_request(
command, json, opcode_name, fetch_list, **params
)
if headers is None:
headers = {}
headers.update(self.headers)
done = False
max_retry = self.retry
final_data = []
page = 1
while not done:
if fetch_list:
params["page"] = page
transform(params)
params.pop("signature", None)
self._sign(params)
req = requests.Request(
self.method, self.endpoint, headers=headers, **{kind: params}
)
prepped = req.prepare()
if self.trace:
print(prepped.method, prepped.url, file=sys.stderr)
if prepped.headers:
print(prepped.headers, "\n", file=sys.stderr)
if prepped.body:
print(prepped.body, file=sys.stderr)
else:
print(file=sys.stderr)
try:
with self.session as session:
response = session.send(
prepped,
timeout=self.timeout,
verify=self.verify,
cert=self.cert,
)
except requests.exceptions.ConnectionError:
max_retry -= 1
if max_retry < 0 or not command.startswith(
("list", "queryAsync")
):
raise
continue
max_retry = self.retry
if self.trace:
print(response.status_code, response.reason, file=sys.stderr)
headersTrace = "\n".join(
"{}: {}".format(k, v) for k, v in response.headers.items()
)
print(headersTrace, "\n", file=sys.stderr)
print(response.text, "\n", file=sys.stderr)
data = self._response_value(response, json)
if fetch_list:
try:
[key] = [k for k in data.keys() if k != "count"]
except ValueError:
done = True
else:
final_data.extend(data[key])
page += 1
if len(final_data) >= data.get("count", PAGE_SIZE):
done = True
elif fetch_result and "jobid" in data:
final_data = self._jobresult(
jobid=data["jobid"], headers=headers
)
done = True
else:
final_data = data
done = True
return final_data
def _response_value(self, response, json=True):
"""Parses the HTTP response as a the cloudstack value.
It throws an exception if the server didn't answer with a 200.
"""
if json:
ctype = response.headers.get("Content-Type", "")
if not ctype.startswith(("application/json", "text/javascript")):
if response.status_code == 200:
msg = (
f"JSON (application/json) was expected, got {ctype:!r}"
)
raise CloudStackException(msg, response=response)
raise CloudStackException(
"HTTP {0.status_code} {0.reason}".format(response),
"Make sure endpoint URL {!r} is correct.".format(
self.endpoint
),
response=response,
)
try:
data = response.json()
except ValueError as e:
raise CloudStackException(
"HTTP {0.status_code} {0.reason}".format(response),
"{0!s}. Malformed JSON document".format(e),
response=response,
)
[key] = data.keys()
data = data[key]
else:
data = response.text
if response.status_code != 200:
raise CloudStackApiException(
"HTTP {0} response from CloudStack".format(
response.status_code
),
error=data,
response=response,
)
return data
def _jobresult(self, jobid, json=True, headers=None):
"""Poll the async job result.
To be run via in a Thread, the result is put within
the result list which is a hack.
"""
failures = 0
total_time = self.job_timeout or 2**30
remaining = timedelta(seconds=total_time)
endtime = datetime.now() + remaining
while remaining.total_seconds() > 0:
timeout = max(min(self.timeout, remaining.total_seconds()), 1)
try:
kind, params = self._prepare_request(
"queryAsyncJobResult", jobid=jobid
)
transform(params)
self._sign(params)
req = requests.Request(
self.method,
self.endpoint,
headers=headers,
**{kind: params},
)
prepped = req.prepare()
if self.trace:
print(prepped.method, prepped.url, file=sys.stderr)
if prepped.headers:
print(prepped.headers, "\n", file=sys.stderr)
if prepped.body:
print(prepped.body, file=sys.stderr)
else:
print(file=sys.stderr)
with self.session as session:
response = session.send(
prepped,
timeout=timeout,
verify=self.verify,
cert=self.cert,
)
j = self._response_value(response, json)
if self.trace:
print(
response.status_code, response.reason, file=sys.stderr
)
headersTrace = "\n".join(
"{}: {}".format(k, v)
for k, v in response.headers.items()
)
print(headersTrace, "\n", file=sys.stderr)
print(response.text, "\n", file=sys.stderr)
failures = 0
if j["jobstatus"] != PENDING:
if j["jobresultcode"] or j["jobstatus"] != SUCCESS:
raise CloudStackApiException(
"Job failure",
error=j["jobresult"],
response=response,
)
if "jobresult" not in j:
raise CloudStackException(
"Unknown job result", response=response
)
return j["jobresult"]
except CloudStackException:
raise
except Exception:
failures += 1
if failures > 10:
raise
time.sleep(self.poll_interval)
remaining = endtime - datetime.now()
if response:
response.status_code = 408
raise CloudStackException(
"Timeout waiting for async job result", jobid, response=response
)
def _sign(self, data):
"""
Compute a signature string according to the CloudStack
signature method (hmac/sha1).
"""
# Python2/3 urlencode aren't good enough for this task.
params = "&".join(
"=".join((key, cs_encode(value)))
for key, value in sorted(data.items())
)
digest = hmac.new(
self.secret.encode("utf-8"),
msg=params.lower().encode("utf-8"),
digestmod=hashlib.sha1,
).digest()
data["signature"] = base64.b64encode(digest).decode("utf-8").strip()
def read_config_from_ini(ini_group=None):
# Config file: $PWD/cloudstack.ini or $HOME/.cloudstack.ini
# Last read wins in configparser
paths = [
os.path.join(os.path.expanduser("~"), ".cloudstack.ini"),
os.path.join(os.getcwd(), "cloudstack.ini"),
]
# Look at CLOUDSTACK_CONFIG first if present
if "CLOUDSTACK_CONFIG" in os.environ:
paths.append(os.path.expanduser(os.environ["CLOUDSTACK_CONFIG"]))
if not any([os.path.exists(c) for c in paths]):
raise SystemExit(
"Config file not found. Tried {0}".format(", ".join(paths))
)
conf = ConfigParser()
conf.read(paths)
if not ini_group:
ini_group = os.getenv("CLOUDSTACK_REGION", "cloudstack")
if not conf.has_section(ini_group):
return dict(name=None)
ini_config = {
k: v
for k, v in conf.items(ini_group)
if v and check_key(k, REQUIRED_CONFIG_KEYS.union(ALLOWED_CONFIG_KEYS))
}
ini_config["name"] = ini_group
# Convert individual header_* settings into a single dict
for k in list(ini_config):
if k.startswith("header_"):
ini_config.setdefault("headers", {})
start = len("header_")
ini_config["headers"][k[start:]] = ini_config.pop(k)
return ini_config
def read_config(ini_group=None):
"""
Read the configuration from the environment, or config.
First it try to go for the environment, then it overrides
those with the cloudstack.ini file.
"""
env_conf = dict(DEFAULT_CONFIG)
for key in REQUIRED_CONFIG_KEYS.union(ALLOWED_CONFIG_KEYS):
env_key = "CLOUDSTACK_{0}".format(key.upper())
value = os.getenv(env_key)
if value:
env_conf[key] = value
# overrides means we have a .ini to read
overrides = os.getenv("CLOUDSTACK_OVERRIDES", "").strip()
if not overrides and set(env_conf).issuperset(REQUIRED_CONFIG_KEYS):
return env_conf
ini_conf = read_config_from_ini(ini_group)
overrides = {s.lower() for s in re.split(r"\W+", overrides)}
config = dict(
dict(env_conf, **ini_conf),
**{k: v for k, v in env_conf.items() if k in overrides},
)
missings = REQUIRED_CONFIG_KEYS.difference(config)
if missings:
raise ValueError(
"the configuration is missing the following keys: "
+ ", ".join(missings)
)
# convert booleans values.
bool_keys = ("dangerous_no_tls_verify",)
for bool_key in bool_keys:
if isinstance(config[bool_key], str):
try:
config[bool_key] = strtobool(config[bool_key])
except ValueError:
pass
return config
|