/usr/lib/python3/dist-packages/pepper/libpepper.py is in salt-pepper 0.5.2-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 | '''
A Python library for working with Salt's REST API
(Specifically the rest_cherrypy netapi module.)
'''
import json
import logging
import ssl
try:
ssl._create_default_https_context = ssl._create_stdlib_context
except:
pass
try:
from urllib.request import HTTPHandler, Request, urlopen, \
install_opener, build_opener
from urllib.error import HTTPError, URLError
import urllib.parse as urlparse
except ImportError:
from urllib2 import HTTPHandler, Request, urlopen, install_opener, build_opener, \
HTTPError, URLError
import urlparse
logger = logging.getLogger('pepper')
class PepperException(Exception):
pass
class Pepper(object):
'''
A thin wrapper for making HTTP calls to the salt-api rest_cherrpy REST
interface
>>> api = Pepper('https://localhost:8000')
>>> api.login('saltdev', 'saltdev', 'pam')
{"return": [
{
"eauth": "pam",
"expire": 1370434219.714091,
"perms": [
"test.*"
],
"start": 1370391019.71409,
"token": "c02a6f4397b5496ba06b70ae5fd1f2ab75de9237",
"user": "saltdev"
}
]
}
>>> api.low([{'client': 'local', 'tgt': '*', 'fun': 'test.ping'}])
{u'return': [{u'ms-0': True,
u'ms-1': True,
u'ms-2': True,
u'ms-3': True,
u'ms-4': True}]}
'''
def __init__(self, api_url='https://localhost:8000', debug_http=False, ignore_ssl_errors=False):
'''
Initialize the class with the URL of the API
:param api_url: Host or IP address of the salt-api URL;
include the port number
:param debug_http: Add a flag to urllib2 to output the HTTP exchange
:param ignore_ssl_errors: Add a flag to urllib2 to ignore invalid SSL certificates
:raises PepperException: if the api_url is misformed
'''
split = urlparse.urlsplit(api_url)
if split.scheme not in ['http', 'https']:
raise PepperException("salt-api URL missing HTTP(s) protocol: {0}"
.format(api_url))
self.api_url = api_url
self.debug_http = int(debug_http)
self._ssl_verify = not ignore_ssl_errors
self.auth = {}
def req_stream(self, path):
'''
A thin wrapper to get a response from saltstack api.
The body of the response will not be downloaded immediately.
Make sure to close the connection after use.
api = Pepper('http://ipaddress/api/')
print(api.login('salt','salt','pam'))
response = api.req_stream('/events')
:param path: The path to the salt api resource
:return: :class:`Response <Response>` object
:rtype: requests.Response
'''
import requests
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
'X-Requested-With': 'XMLHttpRequest',
}
if self.auth and 'token' in self.auth and self.auth['token']:
headers.setdefault('X-Auth-Token', self.auth['token'])
else:
raise PepperException('Authentication required')
return
# Optionally toggle SSL verification
#self._ssl_verify = self.ignore_ssl_errors
params = {'url': self._construct_url(path),
'headers': headers,
'verify': self._ssl_verify == True,
'stream': True
}
try:
resp = requests.get(**params)
if resp.status_code == 401:
raise PepperException(str(resp.status_code) + ':Authentication denied')
return
if resp.status_code == 500:
raise PepperException(str(resp.status_code) + ':Server error.')
return
if resp.status_code == 404:
raise PepperException(str(resp.status_code) +' :This request returns nothing.')
return
except PepperException as e:
print(e)
return
return resp
def req_get(self, path):
'''
A thin wrapper from get http method of saltstack api
api = Pepper('http://ipaddress/api/')
print(api.login('salt','salt','pam'))
print(api.req_get('/keys'))
'''
import requests
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
'X-Requested-With': 'XMLHttpRequest',
}
if self.auth and 'token' in self.auth and self.auth['token']:
headers.setdefault('X-Auth-Token', self.auth['token'])
else:
raise PepperException('Authentication required')
return
# Optionally toggle SSL verification
#self._ssl_verify = self.ignore_ssl_errors
params = {'url': self._construct_url(path),
'headers': headers,
'verify': self._ssl_verify == True,
}
try:
resp = requests.get(**params)
if resp.status_code == 401:
raise PepperException(str(resp.status_code) + ':Authentication denied')
return
if resp.status_code == 500:
raise PepperException(str(resp.status_code) + ':Server error.')
return
if resp.status_code == 404:
raise PepperException(str(resp.status_code) +' :This request returns nothing.')
return
except PepperException as e:
print(e)
return
return resp.json()
def req(self, path, data=None):
'''
A thin wrapper around urllib2 to send requests and return the response
If the current instance contains an authentication token it will be
attached to the request as a custom header.
:rtype: dictionary
'''
if (hasattr(data, 'get') and data.get('eauth') == 'kerberos') or self.auth.get('eauth') == 'kerberos':
return self.req_requests(path, data)
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
'X-Requested-With': 'XMLHttpRequest',
}
handler = HTTPHandler(debuglevel=self.debug_http)
opener = build_opener(handler)
install_opener(opener)
# Build POST data
if data is not None:
postdata = json.dumps(data).encode()
clen = len(postdata)
else:
postdata = None
# Create request object
url = self._construct_url(path)
req = Request(url, postdata, headers)
# Add POST data to request
if data is not None:
req.add_header('Content-Length', clen)
# Add auth header to request
if self.auth and 'token' in self.auth and self.auth['token']:
req.add_header('X-Auth-Token', self.auth['token'])
# Send request
try:
if not (self._ssl_verify):
con = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
#con.check_hostname = False
#con.verify_mode = ssl.CERT_NONE
f = urlopen(req, context=con)
else:
f = urlopen(req)
ret = json.loads(f.read().decode('utf-8'))
except (HTTPError, URLError) as exc:
logger.debug('Error with request', exc_info=True)
status = getattr(exc, 'code', None)
if status == 401:
raise PepperException('Authentication denied')
if status == 500:
raise PepperException('Server error.')
logger.error('Error with request: {0}'.format(exc))
raise
except AttributeError:
logger.debug('Error converting response from JSON', exc_info=True)
raise PepperException('Unable to parse the server response.')
return ret
def req_requests(self, path, data=None):
'''
A thin wrapper around request and request_kerberos to send
requests and return the response
If the current instance contains an authentication token it will be
attached to the request as a custom header.
:rtype: dictionary
'''
import requests
from requests_kerberos import HTTPKerberosAuth, OPTIONAL
auth = HTTPKerberosAuth(mutual_authentication=OPTIONAL)
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
'X-Requested-With': 'XMLHttpRequest',
}
if self.auth and 'token' in self.auth and self.auth['token']:
headers.setdefault('X-Auth-Token', self.auth['token'])
# Optionally toggle SSL verification
params = {'url': self._construct_url(path),
'headers': headers,
'verify': self._ssl_verify is True,
'auth': auth,
'data': json.dumps(data),
}
logger.debug('postdata {0}'.format(params))
resp = requests.post(**params)
if resp.status_code == 401:
# TODO should be resp.raise_from_status
raise PepperException('Authentication denied')
if resp.status_code == 500:
# TODO should be resp.raise_from_status
raise PepperException('Server error.')
return resp.json()
def low(self, lowstate, path='/'):
'''
Execute a command through salt-api and return the response
:param string path: URL path to be joined with the API hostname
:param list lowstate: a list of lowstate dictionaries
'''
return self.req(path, lowstate)
def local(self, tgt, fun, arg=None, kwarg=None, expr_form='glob',
timeout=None, ret=None):
'''
Run a single command using the ``local`` client
Wraps :meth:`low`.
'''
low = {
'client': 'local',
'tgt': tgt,
'fun': fun,
}
if arg:
low['arg'] = arg
if kwarg:
low['kwarg'] = kwarg
if expr_form:
low['expr_form'] = expr_form
if timeout:
low['timeout'] = timeout
if ret:
low['ret'] = ret
return self.low([low], path='/')
def local_async(self, tgt, fun, arg=None, kwarg=None, expr_form='glob',
timeout=None, ret=None):
'''
Run a single command using the ``local_async`` client
Wraps :meth:`low`.
'''
low = {
'client': 'local_async',
'tgt': tgt,
'fun': fun,
}
if arg:
low['arg'] = arg
if kwarg:
low['kwarg'] = kwarg
if expr_form:
low['expr_form'] = expr_form
if timeout:
low['timeout'] = timeout
if ret:
low['ret'] = ret
return self.low([low], path='/')
def local_batch(self, tgt, fun, arg=None, kwarg=None, expr_form='glob',
batch='50%', ret=None):
'''
Run a single command using the ``local_batch`` client
Wraps :meth:`low`.
'''
low = {
'client': 'local_batch',
'tgt': tgt,
'fun': fun,
}
if arg:
low['arg'] = arg
if kwarg:
low['kwarg'] = kwarg
if expr_form:
low['expr_form'] = expr_form
if batch:
low['batch'] = batch
if ret:
low['ret'] = ret
return self.low([low], path='/')
def lookup_jid(self, jid):
'''
Get job results
Wraps :meth:`runner`.
'''
return self.runner('jobs.lookup_jid', jid='{0}'.format(jid))
def runner(self, fun, arg=None, **kwargs):
'''
Run a single command using the ``runner`` client
Usage::
runner('jobs.lookup_jid', jid=12345)
'''
low = {
'client': 'runner',
'fun': fun,
}
if arg:
low['arg'] = arg
low.update(kwargs)
return self.low([low], path='/')
def wheel(self, fun, arg=None, kwarg=None, **kwargs):
'''
Run a single command using the ``wheel`` client
Usage::
wheel('key.accept', match='myminion')
'''
low = {
'client': 'wheel',
'fun': fun,
}
if arg:
low['arg'] = arg
if kwarg:
low['kwarg'] = kwarg
low.update(kwargs)
return self.low([low], path='/')
def login(self, username, password, eauth):
'''
Authenticate with salt-api and return the user permissions and
authentication token or an empty dict
'''
self.auth = self.req('/login', {
'username': username,
'password': password,
'eauth': eauth}).get('return', [{}])[0]
return self.auth
def _construct_url(self, path):
'''
Construct the url to salt-api for the given path
Args:
path: the path to the salt-api resource
>>> api = Pepper('https://localhost:8000/salt-api/')
>>> api._construct_url('/login')
'https://localhost:8000/salt-api/login'
'''
relative_path = path.lstrip('/')
return urlparse.urljoin(self.api_url, relative_path)
|