mirror of
https://github.com/Ultimaker/Cura.git
synced 2025-07-07 15:07:28 -06:00
72248d47e1
So there is an issue with keyring w.r.t. frozen installs (maybe also local). If you have pywin32 installed, it works fine locally. Take a note here, that a variant of this package, pywin32-ctypes, a rudimentary version of that package that works wholly within python, is already installed as its a dependency for keyring on windows. Due to an unknown reason, when running it fails to detect this, so some workaround is needed, _or_ the 'normal' pywin32 package should be installed. However, problems occurred when attempts where made to install pywin32 via cx_freeze. Then the actual workaround was encountered (https://github.com/jaraco/keyring/issues/468), which _should_ hopefully let use use the keyring on windows without needing the 'full' version of pywin32. CURA-7180
72 lines
2.9 KiB
Python
72 lines
2.9 KiB
Python
# Copyright (c) 2021 Ultimaker B.V.
|
|
# Cura is released under the terms of the LGPLv3 or higher.
|
|
from typing import Type, TYPE_CHECKING
|
|
|
|
import keyring
|
|
from keyring.backend import KeyringBackend
|
|
from keyring.errors import NoKeyringError, PasswordSetError
|
|
|
|
from UM.Logger import Logger
|
|
|
|
if TYPE_CHECKING:
|
|
from cura.OAuth2.Models import BaseModel
|
|
|
|
# Need to do some extra workarounds on windows:
|
|
import sys
|
|
from UM.Platform import Platform
|
|
if Platform.isWindows() and hasattr(sys, "frozen"):
|
|
from keyring.backends.Windows import WinVaultKeyring
|
|
keyring.set_keyring(WinVaultKeyring())
|
|
|
|
# Even if errors happen, we don't want this stored locally:
|
|
DONT_EVER_STORE_LOCALLY = ["refresh_token"]
|
|
|
|
class KeyringAttribute:
|
|
"""
|
|
Descriptor for attributes that need to be stored in the keyring. With Fallback behaviour to the preference cfg file
|
|
"""
|
|
def __get__(self, instance: Type["BaseModel"], owner: type) -> str:
|
|
if self._store_secure:
|
|
try:
|
|
return keyring.get_password("cura", self._keyring_name)
|
|
except NoKeyringError:
|
|
self._store_secure = False
|
|
Logger.logException("w", "No keyring backend present")
|
|
return getattr(instance, self._name)
|
|
else:
|
|
return getattr(instance, self._name)
|
|
|
|
def __set__(self, instance: Type["BaseModel"], value: str):
|
|
if self._store_secure:
|
|
setattr(instance, self._name, None)
|
|
try:
|
|
keyring.set_password("cura", self._keyring_name, value)
|
|
except PasswordSetError:
|
|
self._store_secure = False
|
|
if self._name not in DONT_EVER_STORE_LOCALLY:
|
|
setattr(instance, self._name, value)
|
|
Logger.logException("w", "Keyring access denied")
|
|
except NoKeyringError:
|
|
self._store_secure = False
|
|
if self._name not in DONT_EVER_STORE_LOCALLY:
|
|
setattr(instance, self._name, value)
|
|
Logger.logException("w", "No keyring backend present")
|
|
except BaseException as e:
|
|
# A BaseException can occur in Windows when the keyring attempts to write a token longer than 1024
|
|
# characters in the Windows Credentials Manager.
|
|
self._store_secure = False
|
|
if self._name not in DONT_EVER_STORE_LOCALLY:
|
|
setattr(instance, self._name, value)
|
|
Logger.log("w", "Keyring failed: {}".format(e))
|
|
else:
|
|
setattr(instance, self._name, value)
|
|
|
|
def __set_name__(self, owner: type, name: str):
|
|
self._name = "_{}".format(name)
|
|
self._keyring_name = name
|
|
self._store_secure = False
|
|
try:
|
|
self._store_secure = KeyringBackend.viable
|
|
except NoKeyringError:
|
|
Logger.logException("w", "Could not use keyring")
|
|
setattr(owner, self._name, None)
|