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
|
# Copyright 2017 Red Hat, Inc.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from http import client as http_client
import logging
import re
import time
from urllib import parse as urlparse
import requests
from urllib3.exceptions import InsecureRequestWarning
from sushy import exceptions
from sushy.taskmonitor import TaskMonitor
from sushy import utils
LOG = logging.getLogger(__name__)
class Connector:
def __init__(
self, url, username=None, password=None, verify=True,
response_callback=None, server_side_retries=0,
server_side_retries_delay=0,
default_request_timeout=60):
self._url = url
self._verify = verify
self._session = requests.Session()
self._response_callback = response_callback
self._auth = None
self._server_side_retries = server_side_retries
self._server_side_retries_delay = server_side_retries_delay
self._default_request_timeout = default_request_timeout
# NOTE(TheJulia): In order to help prevent recursive post operations
# by allowing us to understand that we should stop authentication.
self._sessions_uri = None
# NOTE(etingof): field studies reveal that some BMCs choke at
# long-running persistent HTTP connections (or TCP connections).
# By default, we ask HTTP server to shut down HTTP connection we've
# just used.
self._session.headers['Connection'] = 'close'
if username or password:
LOG.warning('Passing username and password to Connector is '
'deprecated. Authentication is passed through '
'set_auth now, support for these arguments will '
'be removed in the future')
self.set_http_basic_auth(username, password)
if not self._verify:
# As the user specifically needs to opt out of certificate
# validation the user is aware of the security implications
# and does not need to be overwhelmed by the urllib3 warnings
requests.packages.urllib3.disable_warnings(
category=InsecureRequestWarning)
def set_auth(self, auth):
"""Sets the authentication mechanism for our connector."""
self._auth = auth
def set_http_basic_auth(self, username, password):
"""Sets the http basic authentication information."""
self._session.auth = (username, password)
def set_http_session_auth(self, session_auth_token):
"""Sets the session authentication information."""
self._session.auth = None
self._session.headers.update({'X-Auth-Token': session_auth_token})
def close(self):
"""Close this connector and the associated HTTP session."""
self._session.close()
def check_retry_on_exception(self, exception_msg):
"""Checks whether retry on exception is required."""
retry = False
exc_str = str(exception_msg)
if 'SYS518' in exc_str:
LOG.debug('iDRAC is not yet ready after previous operation. '
'Error: %(err)s', {'err': exc_str})
retry = True
elif 'iLO' in exc_str and 'InvalidOperationForSystemState' in exc_str:
LOG.debug('iLO is not ready after previous operation. '
'Error: %(err)s', {'err': exc_str})
retry = True
return retry
def _op(self, method, path='', data=None, headers=None, blocking=False,
timeout=None, server_side_retries_left=None, allow_reauth=True,
**extra_session_req_kwargs):
"""Generic RESTful request handler.
:param method: The HTTP method to be used, e.g: GET, POST,
PUT, PATCH, etc...
:param path: The sub-URI or absolute URL path to the resource.
:param data: Optional JSON data.
:param headers: Optional dictionary of headers. Use None value
to remove a default header.
:param blocking: Whether to block for asynchronous operations.
:param timeout: Max time in seconds to wait for blocking async call or
for requests library to connect and read. Timeouts
should never be disabled: set to a large enough value
instead.
:param server_side_retries_left: Remaining retries. If not provided
will use limit provided by instance's server_side_retries
:param allow_reauth: Whether to allow refreshing the authentication
token.
:param extra_session_req_kwargs: Optional keyword argument to pass
requests library arguments which would pass on to requests session
object.
:returns: The response object from the requests library.
:raises: ConnectionError
:raises: HTTPError
"""
if server_side_retries_left is None:
server_side_retries_left = self._server_side_retries
timeout = timeout or self._default_request_timeout
url = path if urlparse.urlparse(path).netloc else urlparse.urljoin(
self._url, path)
headers = (headers or {}).copy()
lc_headers = [k.lower() for k in headers]
if data is not None and 'content-type' not in lc_headers:
headers['Content-Type'] = 'application/json'
if 'odata-version' not in lc_headers:
headers['OData-Version'] = '4.0'
# NOTE(TheJulia): Depending on the BMC, offering compression as an
# acceptable response changes the ETag behavior to offering an
# automatic "weak" ETag response, which is appropriate because the
# body content *may* not be a byte for byte match given compression.
# Overall, the value of compression is less than the value of concise
# interaction with the BMC. Setting to identity basically means
# "without modification or compression". By default, python-requests
# indicates responses can be compressed.
if 'accept-encoding' not in lc_headers:
headers['Accept-Encoding'] = 'identity'
# Allow removing default headers
headers = {k: v for k, v in headers.items() if v is not None}
# TODO(lucasagomes): We should mask the data to remove sensitive
# information
LOG.debug('HTTP request: %(method)s %(url)s; headers: %(headers)s; '
'body: %(data)s; blocking: %(blocking)s; timeout: '
'%(timeout)s; session arguments: %(session)s;',
{'method': method, 'url': url,
'headers': utils.sanitize(headers),
'data': utils.sanitize(data),
'blocking': blocking, 'timeout': timeout,
'session': extra_session_req_kwargs})
try:
response = self._session.request(method, url, json=data,
headers=headers,
verify=self._verify,
timeout=timeout,
**extra_session_req_kwargs)
except requests.exceptions.RequestException as e:
# Capture any general exception by looking for the parent
# class of exceptions in the requests library.
# Specifically this will cover cases such as transport
# failures, connection timeouts, and encoding errors.
# Raising this as sushy ConnectionError allows users to
# understand something bad has happened, and to
# allow them to respond accordingly.
raise exceptions.ConnectionError(url=url, error=e)
if self._response_callback:
self._response_callback(response)
# If we received an AccessError, and we
# previously established a redfish session
# there is a chance that the session has timed-out.
# Attempt to re-establish a session.
try:
exceptions.raise_for_response(method, url, response)
except exceptions.AccessError as e:
if (method == 'POST'
and self._sessions_uri is not None
and self._sessions_uri in url):
LOG.error('Authentication to the session service failed. '
'Please check credentials and try again.')
raise
if not allow_reauth:
LOG.error("Failure occurred while attempting to retry "
"request after refreshing the session: %s", e)
raise
if self._auth is not None:
# self._session.auth value is only set when basic auth is used
if self._session.auth is not None:
LOG.warning('We have encountered an AccessError when '
'using \'basic\' authentication. %(err)s',
{'err': str(e)})
# NOTE(TheJulia): There is no way to recover Basic auth,
# as we need the client to be re-launched with new
# credentials.
raise
try:
if self._auth.can_refresh_session():
self._auth.refresh_session()
else:
LOG.warning('Session authentication appears to have '
'been lost at some point in time. '
'Connectivity may have been lost during '
'a prior session refresh. Attempting to '
're-authenticate.')
self._auth.authenticate()
except exceptions.AccessError as refresh_exc:
LOG.error("A failure occurred while attempting to refresh "
"the session. Error: %s", refresh_exc.message)
raise
LOG.debug("Authentication refreshed successfully, "
"retrying the call.")
return self._op(
method, path, data=data, headers=headers,
blocking=blocking, timeout=timeout,
server_side_retries_left=server_side_retries_left,
allow_reauth=False,
**extra_session_req_kwargs)
else:
if method == 'GET' and url.endswith('SessionService'):
LOG.debug('HTTP GET of SessionService failed %s, '
'this is expected prior to authentication',
e.message)
else:
LOG.error("Authentication error detected. Cannot proceed: "
"%s", e.message)
raise
except exceptions.ServerSideError as e:
if ((method.lower() == 'get'
or self.check_retry_on_exception(e.message))
and server_side_retries_left > 0):
LOG.warning('Got server side error %s in response to a '
'request, retrying after %d seconds. Retries '
'left %d.',
e, self._server_side_retries_delay,
server_side_retries_left)
time.sleep(self._server_side_retries_delay)
server_side_retries_left -= 1
return self._op(
method, path, data=data, headers=headers,
blocking=blocking, timeout=timeout,
server_side_retries_left=server_side_retries_left,
**extra_session_req_kwargs)
else:
raise
except exceptions.BadRequestError as e:
if (method.lower() != 'get'
and self.check_retry_on_exception(e.message)
and server_side_retries_left > 0):
LOG.warning('Server has indicated a BadRequest for %s but '
'the response payload is a known retriable '
'condition and we will retry in %d seconds. '
'Retries left %d.',
e, self._server_side_retries_delay,
server_side_retries_left)
time.sleep(self._server_side_retries_delay)
server_side_retries_left -= 1
return self._op(
method, path, data=data, headers=headers,
blocking=blocking, timeout=timeout,
server_side_retries_left=server_side_retries_left,
**extra_session_req_kwargs)
else:
raise
except exceptions.NotAcceptableError as e:
# NOTE(dtantsur): some HPE Gen 10 Plus machines do not allow
# identity encoding when fetching registries.
if (method.lower() == 'get'
and headers.get('Accept-Encoding') == 'identity'):
LOG.warning('Server has indicated a NotAcceptable for %s, '
'retrying without identity encoding', e)
headers = dict(headers, **{'Accept-Encoding': None})
return self._op(
method, path, data=data, headers=headers,
blocking=blocking, timeout=timeout,
server_side_retries_left=server_side_retries_left,
**extra_session_req_kwargs)
else:
raise
if blocking and response.status_code == 202:
if not response.headers.get('Location'):
m = (f'HTTP response for {method} request to {url} '
'returned status 202, but no Location header')
raise exceptions.ConnectionError(url=url, error=m)
mon = TaskMonitor.from_response(self, response, path)
mon.wait(timeout)
response = mon.response
exceptions.raise_for_response(method, url, response)
LOG.debug('HTTP response for %(method)s %(url)s: '
'status code: %(code)s',
{'method': method, 'url': url,
'code': response.status_code})
return response
def get(self, path='', data=None, headers=None, blocking=False,
timeout=None, **extra_session_req_kwargs):
"""HTTP GET method.
:param path: Optional sub-URI path to the resource.
:param data: Optional JSON data.
:param headers: Optional dictionary of headers.
:param blocking: Whether to block for asynchronous operations.
:param timeout: Max time in seconds to wait for blocking async call.
Defaults to default_request_timeout on Connector.
:param extra_session_req_kwargs: Optional keyword argument to pass
requests library arguments which would pass on to requests session
object.
:returns: The response object from the requests library.
:raises: ConnectionError
:raises: HTTPError
"""
return self._op('GET', path, data=data, headers=headers,
blocking=blocking, timeout=timeout,
**extra_session_req_kwargs)
def post(self, path='', data=None, headers=None, blocking=False,
timeout=None, **extra_session_req_kwargs):
"""HTTP POST method.
:param path: Optional sub-URI path to the resource.
:param data: Optional JSON data.
:param headers: Optional dictionary of headers.
:param blocking: Whether to block for asynchronous operations.
:param timeout: Max time in seconds to wait for blocking async call.
Defaults to default_request_timeout on Connector.
:param extra_session_req_kwargs: Optional keyword argument to pass
requests library arguments which would pass on to requests session
object.
:returns: The response object from the requests library.
:raises: ConnectionError
:raises: HTTPError
"""
return self._op('POST', path, data=data, headers=headers,
blocking=blocking, timeout=timeout,
**extra_session_req_kwargs)
def _etag_handler(self, path='', data=None, headers=None, etag=None,
blocking=False, timeout=None,
**extra_session_req_kwargs):
"""eTag handler containing workarounds for PATCH requests with eTags.
:param path: Optional sub-URI path to the resource.
:param data: Optional JSON data.
:param headers: Optional dictionary of headers.
:param etag: eTag string.
:param blocking: Whether to block for asynchronous operations.
:param timeout: Max time in seconds to wait for blocking async call.
Defaults to default_request_timeout on Connector.
:param extra_session_req_kwargs: Optional keyword argument to pass
requests library arguments which would pass on to requests session
object.
:returns: The response object from the requests library.
:raises: ConnectionError
:raises: HTTPError
"""
if etag is not None:
if not headers:
headers = {}
headers['If-Match'] = etag
try:
response = self._op('PATCH', path, data=data,
headers=headers,
blocking=blocking, timeout=timeout,
**extra_session_req_kwargs)
except exceptions.HTTPError as resp:
LOG.warning("Initial request with eTag failed: %s",
resp)
if resp.status_code == http_client.PRECONDITION_FAILED:
# NOTE(janders) if there was no eTag provided AND the response
# is HTTP 412 Precondition Failed, raise the exception
if not etag:
raise
# checking for weak eTag
pattern = re.compile(r'^(W\/)("\w*")$')
match = pattern.match(etag)
if match:
LOG.info("Weak eTag provided with original request to "
"%s. Attempting to conversion to strong eTag "
"and re-trying.", path)
# trying weak eTag converted to strong
headers['If-Match'] = match.group(2)
try:
response = self._op('PATCH', path, data=data,
headers=headers,
blocking=blocking,
timeout=timeout,
**extra_session_req_kwargs)
except exceptions.HTTPError as resp:
if (resp.status_code == http_client.
PRECONDITION_FAILED):
LOG.warning("Request to %s with weak eTag "
"converted to strong eTag also "
"failed. Making the final attempt "
"with no eTag specified.", path)
response = None
if response:
return response
else:
# eTag is strong, if it failed the only other thing
# to try is removing it entirely
# info
LOG.warning("Strong eTag provided - retrying request to "
"%s with eTag removed.", path)
del headers['If-Match']
try:
response = self._op('PATCH', path, data=data,
headers=headers,
blocking=blocking, timeout=timeout,
**extra_session_req_kwargs)
except exceptions.HTTPError as resp:
LOG.error("Final re-try with eTag removed has failed, "
"raising exception %s", resp)
raise
else:
raise
return response
def patch(self, path='', data=None, headers=None, etag=None,
blocking=False, timeout=None, **extra_session_req_kwargs):
"""HTTP PATCH method.
:param path: Optional sub-URI path to the resource.
:param data: Optional JSON data.
:param headers: Optional dictionary of headers.
:param etag: Optional eTag string.
:param blocking: Whether to block for asynchronous operations.
:param timeout: Max time in seconds to wait for blocking async call.
Defaults to default_request_timeout on Connector.
:param extra_session_req_kwargs: Optional keyword argument to pass
requests library arguments which would pass on to requests session
object.
:returns: The response object from the requests library.
:raises: ConnectionError
:raises: HTTPError
"""
return self._etag_handler(path, data,
headers, etag,
blocking, timeout,
**extra_session_req_kwargs)
def put(self, path='', data=None, headers=None, blocking=False,
timeout=None, **extra_session_req_kwargs):
"""HTTP PUT method.
:param path: Optional sub-URI path to the resource.
:param data: Optional JSON data.
:param headers: Optional dictionary of headers.
:param blocking: Whether to block for asynchronous operations.
:param timeout: Max time in seconds to wait for blocking async call.
Defaults to default_request_timeout on Connector.
:param extra_session_req_kwargs: Optional keyword argument to pass
requests library arguments which would pass on to requests session
object.
:returns: The response object from the requests library.
:raises: ConnectionError
:raises: HTTPError
"""
return self._op('PUT', path, data=data, headers=headers,
blocking=blocking, timeout=timeout,
**extra_session_req_kwargs)
def delete(self, path='', data=None, headers=None, blocking=False,
timeout=None, **extra_session_req_kwargs):
"""HTTP DELETE method.
:param path: Optional sub-URI path to the resource.
:param data: Optional JSON data.
:param headers: Optional dictionary of headers.
:param blocking: Whether to block for asynchronous operations.
:param timeout: Max time in seconds to wait for blocking async call.
Defaults to default_request_timeout on Connector.
:param extra_session_req_kwargs: Optional keyword argument to pass
requests library arguments which would pass on to requests session
object.
:returns: The response object from the requests library.
:raises: ConnectionError
:raises: HTTPError
"""
return self._op('DELETE', path, data=data, headers=headers,
blocking=blocking, timeout=timeout,
**extra_session_req_kwargs)
def __enter__(self):
return self
def __exit__(self, *_args):
self.close()
|
