Skip to content

pcsclient: improvements to keyring handling #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
berrange wants to merge 2 commits into
base: main
Choose a base branch
from
Open

pcsclient: improvements to keyring handling #494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90b7385
pcsclient: make 'keyring' module optional
berrange Dec 4, 2025
8a609cb
pcsclient: ignore errors trying to clear the keyring
berrange Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions tools/PcsClientTool/lib/intelsgx/credential.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import keyring
try:
import keyring
except:
keyring = None
import getpass

class Credentials:
Expand All @@ -7,11 +10,12 @@ class Credentials:

def get_pcs_api_key(self):
pcs_api_key = ""
try:
print("Please note: A prompt may appear asking for your keyring password to access stored credentials.")
pcs_api_key = keyring.get_password(self.APPNAME, self.KEY_PCS_APIKEY)
except keyring.errors.KeyringError as ke:
pcs_api_key = ""
if keyring is not None:
try:
print("Please note: A prompt may appear asking for your keyring password to access stored credentials.")
pcs_api_key = keyring.get_password(self.APPNAME, self.KEY_PCS_APIKEY)
except keyring.errors.KeyringError as ke:
pcs_api_key = ""

while pcs_api_key is None or pcs_api_key == '':
pcs_api_key = getpass.getpass(prompt="Please input ApiKey for Intel PCS:")
Expand All @@ -24,10 +28,11 @@ def get_pcs_api_key(self):
return pcs_api_key

def set_pcs_api_key(self, apikey):
try:
print("Please note: A prompt may appear asking for your keyring password to access stored credentials.")
keyring.set_password(self.APPNAME, self.KEY_PCS_APIKEY, apikey)
except keyring.errors.PasswordSetError as ke:
print("Failed to store PCS API key.")
return False
if keyring is not None:
try:
print("Please note: A prompt may appear asking for your keyring password to access stored credentials.")
keyring.set_password(self.APPNAME, self.KEY_PCS_APIKEY, apikey)
except keyring.errors.PasswordSetError as ke:
print("Failed to store PCS API key.")
return False
return True
16 changes: 14 additions & 2 deletions tools/PcsClientTool/lib/intelsgx/pcs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,13 @@ def get_pck_cert(self, eppid, pceid, cpusvn, pcesvn, dec=None):
if response.status_code != 200:
print(str(response.content, 'utf-8'))
if response.status_code == 401:
Credentials().set_pcs_api_key('') #reset ApiKey
try:
Credentials().set_pcs_api_key('') #reset ApiKey
except:
# If keyring is unavailable, we don't want to trigger
# traceback, as the user may have declined to save
# the key in the keyring earlier
pass
return None

# Verify expected headers
Expand Down Expand Up @@ -418,7 +424,13 @@ def get_pck_certs(self, eppid, pceid, platform_manifest, dec=None):
if response.status_code != 200:
print(str(response.content, 'utf-8'))
if response.status_code == 401:
Credentials().set_pcs_api_key('') #reset ApiKey
try:
Credentials().set_pcs_api_key('') #reset ApiKey
except:
# If keyring is unavailable, we don't want to trigger
# traceback, as the user may have declined to save
# the key in the keyring earlier
pass
return None

# Verify expected headers
Expand Down