Skip to content

Added persistent flow to example #144

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

Merged
sali-ks merged 1 commit into from
Feb 27, 2026
Merged

Added persistent flow to example #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 29 additions & 3 deletions examples/sdk_examples/auth/login.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,13 +290,16 @@ def _handle_sso_token(self, step: login_auth.LoginStepSsoToken) -> None:
]
if pyperclip:
menu.append(("c", "Copy SSO Login URL to clipboard."))
else:
menu.append(("u", "Show SSO Login URL."))
try:
wb = webbrowser.get()
menu.append(("o", "Navigate to SSO Login URL with the default web browser."))
except Exception:
wb = None
if pyperclip:
menu.append(("p", "Paste SSO Token from clipboard."))
menu.append(("t", "Enter SSO Token manually."))
menu.append(("q", "Quit SSO authentication attempt and return to Commander prompt."))

lines = [
Expand All @@ -305,7 +308,7 @@ def _handle_sso_token(self, step: login_auth.LoginStepSsoToken) -> None:
step.sso_login_url,
"Navigate to SSO Login URL with your browser and complete authentication.",
"Copy a returned SSO Token into clipboard."
+ (" Paste that token into Commander." if pyperclip else " Then paste the token below (or install pyperclip for clipboard support)."),
+ (" Paste that token into Commander." if pyperclip else " Then use option 't' to enter the token manually."),
'NOTE: To copy SSO Token please click "Copy authentication token" '
'button on "SSO Connect" page.',
"",
Expand All @@ -330,6 +333,12 @@ def _handle_sso_token(self, step: login_auth.LoginStepSsoToken) -> None:
print("Failed to copy SSO Login URL to clipboard.")
else:
print("Clipboard not available (install pyperclip).")
elif token == "u":
token = None
if not pyperclip:
print("\nSSO Login URL:", step.sso_login_url, "\n")
else:
print("Unsupported menu option (use 'c' to copy URL).")
elif token == "o":
token = None
if wb:
Expand All @@ -345,8 +354,10 @@ def _handle_sso_token(self, step: login_auth.LoginStepSsoToken) -> None:
token = ""
print("Failed to paste from clipboard")
else:
token = ""
print("Clipboard not available (install pyperclip).")
token = None
print("Clipboard not available (use 't' to enter token manually).")
elif token == "t":
token = getpass.getpass("Enter SSO Token: ").strip()
else:
if len(token) < 10:
print(f"Unsupported menu option: {token}")
Expand Down Expand Up @@ -395,6 +406,19 @@ def _two_factor_code_to_duration(
return login_auth.TwoFactorDuration.EveryLogin


def enable_persistent_login(keeper_auth_context: keeper_auth.KeeperAuth) -> None:
"""
Enable persistent login and register data key for device.
Sets persistent_login to on and logout_timer to 30 days.
"""
keeper_auth.set_user_setting(keeper_auth_context, 'persistent_login', '1')
keeper_auth.register_data_key_for_device(keeper_auth_context)
mins_per_day = 60 * 24
timeout_in_minutes = mins_per_day * 30 # 30 days
keeper_auth.set_user_setting(keeper_auth_context, 'logout_timer', str(timeout_in_minutes))
print("Persistent login turned on successfully and device registered")


def login():
"""
Handle the login process including server selection, authentication,
Expand All @@ -406,6 +430,8 @@ def login():
"""
flow = LoginFlow()
keeper_auth_context = flow.run()
if keeper_auth_context:
enable_persistent_login(keeper_auth_context)
keeper_endpoint = flow.endpoint if keeper_auth_context else None
return keeper_auth_context, keeper_endpoint

Expand Down
19 changes: 15 additions & 4 deletions examples/sdk_examples/records/list_records.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,22 +287,25 @@ def _handle_sso_token(self, step: login_auth.LoginStepSsoToken) -> None:
]
if pyperclip:
menu.append(("c", "Copy SSO Login URL to clipboard."))
else:
menu.append(("u", "Show SSO Login URL."))
try:
wb = webbrowser.get()
menu.append(("o", "Navigate to SSO Login URL with the default web browser."))
except Exception:
wb = None
if pyperclip:
menu.append(("p", "Paste SSO Token from clipboard."))
menu.append(("t", "Enter SSO Token manually."))
menu.append(("q", "Quit SSO authentication attempt and return to Commander prompt."))

lines = [
"",
"SSO Login URL:",
step.sso_login_url,
"Navigate to SSO Login URL with your browser and complete authentication.",
"Copy a returned SSO Token into clipboard.",
"Paste that token into Commander",
"Copy a returned SSO Token into clipboard."
+ (" Paste that token into Commander." if pyperclip else " Then use option 't' to enter the token manually."),
'NOTE: To copy SSO Token please click "Copy authentication token" '
'button on "SSO Connect" page.',
"",
Expand All @@ -327,6 +330,12 @@ def _handle_sso_token(self, step: login_auth.LoginStepSsoToken) -> None:
print("Failed to copy SSO Login URL to clipboard.")
else:
print("Clipboard not available (install pyperclip).")
elif token == "u":
token = None
if not pyperclip:
print("\nSSO Login URL:", step.sso_login_url, "\n")
else:
print("Unsupported menu option (use 'c' to copy URL).")
elif token == "o":
token = None
if wb:
Expand All @@ -342,8 +351,10 @@ def _handle_sso_token(self, step: login_auth.LoginStepSsoToken) -> None:
token = ""
print("Failed to paste from clipboard")
else:
token = ""
print("Clipboard not available (install pyperclip).")
token = None
print("Clipboard not available (use 't' to enter token manually).")
elif token == "t":
token = getpass.getpass("Enter SSO Token: ").strip()
else:
if len(token) < 10:
print(f"Unsupported menu option: {token}")
Expand Down