From 17d6a993fc17d533460c5f40f3908c708e057c18 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Thu, 23 May 2024 18:45:17 +0200
Subject: Merging upstream version 18.2.3.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 .../ceph_node_proxy/redfish_client.py              | 123 +++++++++++++++++++++
 1 file changed, 123 insertions(+)
 create mode 100644 src/ceph-node-proxy/ceph_node_proxy/redfish_client.py

(limited to 'src/ceph-node-proxy/ceph_node_proxy/redfish_client.py')

diff --git a/src/ceph-node-proxy/ceph_node_proxy/redfish_client.py b/src/ceph-node-proxy/ceph_node_proxy/redfish_client.py
new file mode 100644
index 000000000..64a4e44df
--- /dev/null
+++ b/src/ceph-node-proxy/ceph_node_proxy/redfish_client.py
@@ -0,0 +1,123 @@
+import json
+from urllib.error import HTTPError, URLError
+from ceph_node_proxy.baseclient import BaseClient
+from ceph_node_proxy.util import get_logger, http_req
+from typing import Dict, Any, Tuple, Optional
+from http.client import HTTPMessage
+
+
+class RedFishClient(BaseClient):
+    PREFIX = '/redfish/v1/'
+
+    def __init__(self,
+                 host: str = '',
+                 port: str = '443',
+                 username: str = '',
+                 password: str = ''):
+        super().__init__(host, username, password)
+        self.log = get_logger(__name__)
+        self.log.info(f'Initializing redfish client {__name__}')
+        self.host: str = host
+        self.port: str = port
+        self.url: str = f'https://{self.host}:{self.port}'
+        self.token: str = ''
+        self.location: str = ''
+
+    def login(self) -> None:
+        if not self.is_logged_in():
+            self.log.info('Logging in to '
+                          f"{self.url} as '{self.username}'")
+            oob_credentials = json.dumps({'UserName': self.username,
+                                          'Password': self.password})
+            headers = {'Content-Type': 'application/json'}
+            location_endpoint: str = ''
+
+            try:
+                _headers, _data, _status_code = self.query(data=oob_credentials,
+                                                           headers=headers,
+                                                           endpoint='/redfish/v1/SessionService/Sessions/')
+                if _status_code != 201:
+                    self.log.error(f"Can't log in to {self.url} as '{self.username}': {_status_code}")
+                    raise RuntimeError
+            except URLError as e:
+                msg = f"Can't log in to {self.url} as '{self.username}': {e}"
+                self.log.error(msg)
+                raise RuntimeError
+            self.token = _headers['X-Auth-Token']
+            if _headers['Location'].startswith('http'):
+                # We assume the value has the following format:
+                # scheme://address:port/redfish/v1/SessionService/Session
+                location_endpoint = f"/{_headers['Location'].split('/', 3)[-1:][0]}"
+            else:
+                location_endpoint = _headers['Location']
+            self.location = location_endpoint
+            self.log.info(f'Logged in to {self.url}, Received header "Location": {self.location}')
+
+    def is_logged_in(self) -> bool:
+        self.log.debug(f'Checking token validity for {self.url}')
+        if not self.location or not self.token:
+            self.log.debug(f'No token found for {self.url}.')
+            return False
+        headers = {'X-Auth-Token': self.token}
+        try:
+            _headers, _data, _status_code = self.query(headers=headers,
+                                                       endpoint=self.location)
+        except URLError as e:
+            self.log.error("Can't check token "
+                           f'validity for {self.url}: {e}')
+            raise
+        return _status_code == 200
+
+    def logout(self) -> Dict[str, Any]:
+        result: Dict[str, Any] = {}
+        try:
+            if self.is_logged_in():
+                _, _data, _status_code = self.query(method='DELETE',
+                                                    headers={'X-Auth-Token': self.token},
+                                                    endpoint=self.location)
+                result = json.loads(_data)
+        except URLError:
+            self.log.error(f"Can't log out from {self.url}")
+
+        self.location = ''
+        self.token = ''
+
+        return result
+
+    def get_path(self, path: str) -> Dict[str, Any]:
+        if self.PREFIX not in path:
+            path = f'{self.PREFIX}{path}'
+        try:
+            _, result, _status_code = self.query(endpoint=path)
+            result_json = json.loads(result)
+            return result_json
+        except URLError as e:
+            self.log.error(f"Can't get path {path}:\n{e}")
+            raise RuntimeError
+
+    def query(self,
+              data: Optional[str] = None,
+              headers: Dict[str, str] = {},
+              method: Optional[str] = None,
+              endpoint: str = '',
+              timeout: int = 10) -> Tuple[HTTPMessage, str, int]:
+        _headers = headers.copy() if headers else {}
+        if self.token:
+            _headers['X-Auth-Token'] = self.token
+        if not _headers.get('Content-Type') and method in ['POST', 'PUT', 'PATCH']:
+            _headers['Content-Type'] = 'application/json'
+        try:
+            (response_headers,
+             response_str,
+             response_status) = http_req(hostname=self.host,
+                                         port=self.port,
+                                         endpoint=endpoint,
+                                         headers=_headers,
+                                         method=method,
+                                         data=data,
+                                         timeout=timeout)
+
+            return response_headers, response_str, response_status
+        except (HTTPError, URLError) as e:
+            self.log.debug(f'{e}')
+            raise
-- 
cgit v1.2.3