%PDF-
%PDF-
Mini Shell
Mini Shell
import json
import logging
import os
from datetime import datetime
from typing import Any, Dict, Optional # noqa: F401
from uaclient import (
defaults,
event_logger,
exceptions,
secret_manager,
system,
util,
)
from uaclient.contract_data_types import PublicMachineTokenData
event = event_logger.get_event_logger()
LOG = logging.getLogger(util.replace_top_level_logger_name(__name__))
class UAFile:
def __init__(
self,
name: str,
directory: str = defaults.DEFAULT_DATA_DIR,
private: bool = True,
):
self._directory = directory
self._file_name = name
self._is_private = private
self._path = os.path.join(self._directory, self._file_name)
@property
def path(self) -> str:
return self._path
@property
def is_private(self) -> bool:
return self._is_private
@property
def is_present(self):
return os.path.exists(self.path)
def write(self, content: str):
file_mode = (
defaults.ROOT_READABLE_MODE
if self.is_private
else defaults.WORLD_READABLE_MODE
)
# try/except-ing here avoids race conditions the best
try:
if os.path.basename(self._directory) == defaults.PRIVATE_SUBDIR:
os.makedirs(self._directory, mode=0o700)
else:
os.makedirs(self._directory)
except OSError:
pass
system.write_file(self.path, content, file_mode)
def read(self) -> Optional[str]:
content = None
try:
content = system.load_file(self.path)
except FileNotFoundError:
LOG.debug("Tried to load %s but file does not exist", self.path)
return content
def delete(self):
system.ensure_file_absent(self.path)
class ProJSONFile:
def __init__(
self,
pro_file: UAFile,
):
self.pro_file = pro_file
def write(self, content: Dict[str, Any]):
self.pro_file.write(
content=json.dumps(content, cls=util.DatetimeAwareJSONEncoder)
)
def read(self) -> Optional[Dict[str, Any]]:
content = self.pro_file.read()
if content:
try:
return json.loads(content, cls=util.DatetimeAwareJSONDecoder)
except json.JSONDecodeError as e:
raise exceptions.InvalidJson(
source=self.pro_file.path, out="\n" + str(e)
)
return None
def delete(self):
return self.pro_file.delete()
@property
def is_present(self):
return self.pro_file.is_present
class UserCacheFile(UAFile):
def __init__(self, name: str):
super().__init__(
name, directory=system.get_user_cache_dir(), private=False
)
class MachineTokenFile:
def __init__(
self,
directory: str = defaults.DEFAULT_DATA_DIR,
machine_token_overlay_path: Optional[str] = None,
):
file_name = defaults.MACHINE_TOKEN_FILE
self.private_file = ProJSONFile(
pro_file=UAFile(
file_name, os.path.join(directory, defaults.PRIVATE_SUBDIR)
),
)
self.public_file = ProJSONFile(
pro_file=UAFile(file_name, directory, False)
)
self.machine_token_overlay_path = machine_token_overlay_path
self._machine_token = None # type: Optional[Dict[str, Any]]
self._entitlements = None
self._contract_expiry_datetime = None
def write(self, private_content: Dict[str, Any]):
"""Update the machine_token file for both pub/private files"""
if util.we_are_currently_root():
self.private_file.write(private_content)
# PublicMachineTokenData only has public fields defined and
# ignores all other (private) fields in from_dict
public_content = PublicMachineTokenData.from_dict(
private_content
).to_dict(keep_none=False)
self.public_file.write(public_content)
self._machine_token = None
self._entitlements = None
self._contract_expiry_datetime = None
else:
raise exceptions.NonRootUserError()
def delete(self):
"""Delete both pub and private files"""
if util.we_are_currently_root():
self.public_file.delete()
self.private_file.delete()
self._machine_token = None
self._entitlements = None
self._contract_expiry_datetime = None
else:
raise exceptions.NonRootUserError()
def read(self) -> Optional[dict]:
if util.we_are_currently_root():
file_handler = self.private_file
else:
file_handler = self.public_file
content = file_handler.read()
if content:
secret_manager.secrets.add_secret(content.get("machineToken", ""))
for token in content.get("resourceTokens", []):
secret_manager.secrets.add_secret(token.get("token", ""))
return content
@property
def is_present(self):
if util.we_are_currently_root():
return self.public_file.is_present and self.private_file.is_present
else:
return self.public_file.is_present
@property
def machine_token(self):
"""Return the machine-token if cached in the machine token response."""
if not self._machine_token:
content = self.read()
if content and self.machine_token_overlay_path:
machine_token_overlay = self.parse_machine_token_overlay(
self.machine_token_overlay_path
)
if machine_token_overlay:
util.depth_first_merge_overlay_dict(
base_dict=content,
overlay_dict=machine_token_overlay,
)
self._machine_token = content
return self._machine_token
def parse_machine_token_overlay(self, machine_token_overlay_path):
machine_token_overlay_content = system.load_file(
machine_token_overlay_path
)
return json.loads(
machine_token_overlay_content,
cls=util.DatetimeAwareJSONDecoder,
)
@property
def account(self) -> Optional[dict]:
if bool(self.machine_token):
return self.machine_token["machineTokenInfo"]["accountInfo"]
return None
@property
def entitlements(self):
"""Return configured entitlements keyed by entitlement named"""
if self._entitlements:
return self._entitlements
if not self.machine_token:
return {}
self._entitlements = self.get_entitlements_from_token(
self.machine_token
)
return self._entitlements
@staticmethod
def get_entitlements_from_token(machine_token: Dict):
"""Return a dictionary of entitlements keyed by entitlement name.
Return an empty dict if no entitlements are present.
"""
from uaclient.contract import apply_contract_overrides
if not machine_token:
return {}
entitlements = {}
contractInfo = machine_token.get("machineTokenInfo", {}).get(
"contractInfo"
)
if not contractInfo:
return {}
tokens_by_name = dict(
(e.get("type"), e.get("token"))
for e in machine_token.get("resourceTokens", [])
)
ent_by_name = dict(
(e.get("type"), e)
for e in contractInfo.get("resourceEntitlements", [])
)
for entitlement_name, ent_value in ent_by_name.items():
entitlement_cfg = {"entitlement": ent_value}
if entitlement_name in tokens_by_name:
entitlement_cfg["resourceToken"] = tokens_by_name[
entitlement_name
]
apply_contract_overrides(entitlement_cfg)
entitlements[entitlement_name] = entitlement_cfg
return entitlements
@property
def contract_expiry_datetime(self) -> Optional[datetime]:
"""Return a datetime of the attached contract expiration."""
if not self._contract_expiry_datetime:
self._contract_expiry_datetime = (
self.machine_token.get("machineTokenInfo", {})
.get("contractInfo", {})
.get("effectiveTo", None)
)
return self._contract_expiry_datetime
@property
def is_attached(self):
"""Report whether this machine configuration is attached to UA."""
return bool(self.machine_token) # machine_token is removed on detach
@property
def contract_remaining_days(self) -> Optional[int]:
"""Report num days until contract expiration based on effectiveTo
:return: A positive int representing the number of days the attached
contract remains in effect. Return a negative int for the number
of days beyond contract's effectiveTo date.
"""
if self.contract_expiry_datetime is None:
return None
delta = self.contract_expiry_datetime.date() - datetime.utcnow().date()
return delta.days
@property
def activity_token(self) -> "Optional[str]":
if self.machine_token:
return self.machine_token.get("activityInfo", {}).get(
"activityToken"
)
return None
@property
def activity_id(self) -> "Optional[str]":
if self.machine_token:
return self.machine_token.get("activityInfo", {}).get("activityID")
return None
@property
def activity_ping_interval(self) -> "Optional[int]":
if self.machine_token:
return self.machine_token.get("activityInfo", {}).get(
"activityPingInterval"
)
return None
@property
def contract_id(self):
if self.machine_token:
return (
self.machine_token.get("machineTokenInfo", {})
.get("contractInfo", {})
.get("id")
)
return None
@property
def resource_tokens(self):
if self.machine_token:
return self.machine_token.get("resourceTokens", [])
return None
Zerion Mini Shell 1.0