Skip to content
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

Add instructional message to client_from_login_flow #123

Merged
merged 3 commits into from
Jun 13, 2024
Merged

Add instructional message to client_from_login_flow #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd67d20
Adds message and interactivity
alexgolec Jun 13, 2024
dbc3308
kill server using the dedicated method
alexgolec Jun 13, 2024
829e220
Switch to using a context manager
alexgolec Jun 13, 2024
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
194 changes: 129 additions & 65 deletions schwab/auth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@


from authlib.integrations.httpx_client import AsyncOAuth2Client, OAuth2Client
from prompt_toolkit import prompt

import urllib
import contextlib
import json
import logging
import multiprocessing
Expand All @@ -13,6 +11,7 @@
import requests
import sys
import time
import urllib
import urllib3
import warnings
import webbrowser
Expand Down Expand Up @@ -165,6 +164,10 @@ async def oauth_client_update_token(t, *args, **kwargs):
token_metadata=metadata_manager, enforce_enums=enforce_enums)


################################################################################
# client_from_login_flow


# This runs in a separate process and is invisible to coverage
def __run_client_from_login_flow_server(
q, callback_port, callback_path): # pragma: no cover
Expand All @@ -184,7 +187,16 @@ def handle_token():
def status():
return 'running'

app.run(port=callback_port, ssl_context='adhoc')
# Wrap this call in some hackery to suppress the flask startup messages
with open(os.devnull, 'w') as devnull:
import logging
log = logging.getLogger('werkzeug')
log.setLevel(logging.ERROR)

old_stdout = sys.stdout
sys.stdout = devnull
app.run(port=callback_port, ssl_context='adhoc')
sys.stdout = old_stdout


class RedirectTimeoutError(Exception):
Expand All @@ -193,16 +205,21 @@ class RedirectTimeoutError(Exception):
class RedirectServerExitedError(Exception):
pass

# Capture the real time.time so that we can use it in server initialization
# while simultaneously mocking it in testing
__TIME_TIME = time.time

def client_from_login_flow(api_key, app_secret, callback_url, token_path,
asyncio=False, enforce_enums=False,
token_write_func=None, callback_timeout=300.0):
token_write_func=None, callback_timeout=300.0,
interactive=True):
# TODO: documentation

# Start the server
parsed = urllib.parse.urlparse(callback_url)

if parsed.hostname != '127.0.0.1':
# TODO: document this error
raise ValueError(
('disallowed hostname {}. client_from_login_flow only allows '+
'callback URLs with hostname 127.0.0.1').format(
Expand All @@ -217,71 +234,110 @@ def client_from_login_flow(api_key, app_secret, callback_url, token_path,
target=__run_client_from_login_flow_server,
args=(output_queue, callback_port, callback_path))

print('Running a server to intercept the callback. Please ignore the ' +
'following debug messages:')
print()
server.start()

# Wait until the server successfully starts
while True:
# Check if the server is still alive
if server.exitcode is not None:
raise RedirectServerExitedError(
'Redirect server exited. Are you attempting to use a ' +
'callback URL without a port number specified?')
# Context manager to kill the server upon completion
@contextlib.contextmanager
def callback_server():
server.start()

import traceback

# Attempt to send a request to the server
try:
with warnings.catch_warnings():
warnings.filterwarnings(
'ignore', category=urllib3.exceptions.InsecureRequestWarning)

resp = requests.get(
'https://127.0.0.1:{}/schwab-py-internal/status'.format(
callback_port), verify=False)
break
except requests.exceptions.ConnectionError as e:
pass
yield
finally:
try:
psutil.Process(server.pid).kill()
except psutil.NoSuchProcess:
pass

with callback_server():
# Wait until the server successfully starts
while True:
# Check if the server is still alive
if server.exitcode is not None:
# TODO: document this error
raise RedirectServerExitedError(
'Redirect server exited. Are you attempting to use a ' +
'callback URL without a port number specified?')

import traceback

# Attempt to send a request to the server
try:
with warnings.catch_warnings():
warnings.filterwarnings(
'ignore',
category=urllib3.exceptions.InsecureRequestWarning)

resp = requests.get(
'https://127.0.0.1:{}/schwab-py-internal/status'.format(
callback_port), verify=False)
break
except requests.exceptions.ConnectionError as e:
pass

time.sleep(0.1)

# Open the browser
oauth = OAuth2Client(api_key, redirect_uri=callback_url)
authorization_url, state = oauth.create_authorization_url(
'https://api.schwabapi.com/v1/oauth/authorize')

if interactive:
print()
print('**************************************************************')
print()
print('This is the browser-assisted login and token creation flow for')
print('schwab-py. This flow automatically opens the login page on your')
print('browser, captures the resulting OAuth callback, and creates a token')
print('using the result.')
print()
print('IMPORTANT: Your browser will give you a security warning about an')
print('invalid certificate prior to issuing the redirect. This is because')
print('schwab-py has started a server on your machine to receive the OAuth')
print('redirect using a self-signed SSL certificate. You can ignore that')
print('warning, but make sure to first check that the URL matches your')
print('callback URL. As a reminder, your callback URL is:')
print()
print('>>',callback_url)
print()
print('See here to learn more: TODO<add a documentation URL>')
print()
print('If you encounter any issues, see here for troubleshooting:')
print('https://schwab-py.readthedocs.io/en/latest/auth.html#troubleshooting')
print('\n**************************************************************')
print()
prompt('Press ENTER to open the browser. Note you can run ' +
'client_from_login_flow with interactive=False to skip this input')

webbrowser.open(authorization_url)

# Wait for a response
now = __TIME_TIME()
timeout_time = now + callback_timeout
received_url = None
while now < timeout_time:
# Attempt to fetch from the queue
try:
received_url = output_queue.get(
timeout=min(timeout_time - now, 0.1))
break
except queue.Empty:
pass

now = __TIME_TIME()

if not received_url:
# TODO: document this error
raise RedirectTimeoutError(
'Timed out waiting for a post-authorization callback. You '+
'can set a longer timeout by passing a value of ' +
'callback_timeout to client_from_login_flow.')

time.sleep(0.1)

# Open the browser
oauth = OAuth2Client(api_key, redirect_uri=callback_url)
authorization_url, state = oauth.create_authorization_url(
'https://api.schwabapi.com/v1/oauth/authorize')

webbrowser.open(authorization_url)

# Wait for a response
now = time.time()
timeout_time = now + callback_timeout
callback_url = None
while now < timeout_time:
# Attempt to fetch from the queue
try:
callback_url = output_queue.get(
timeout=min(timeout_time - now, 0.1))
break
except queue.Empty:
pass

now = time.time()

# Clean up and create the client
psutil.Process(server.pid).kill()

if callback_url:
return __fetch_and_register_token_from_redirect(
oauth, callback_url, api_key, app_secret, token_path, token_write_func,
asyncio, enforce_enums=enforce_enums)
else:
raise RedirectTimeoutError(
'Timed out waiting for a post-authorization callback. You '+
'can set a longer timeout by passing a value of ' +
'callback_timeout to client_from_login_flow.')
oauth, received_url, api_key, app_secret, token_path,
token_write_func, asyncio, enforce_enums=enforce_enums)


################################################################################
# client_from_token_path


def client_from_token_file(token_path, api_key, app_secret, asyncio=False,
Expand Down Expand Up @@ -313,6 +369,10 @@ def client_from_token_file(token_path, api_key, app_secret, asyncio=False,
enforce_enums=enforce_enums)


################################################################################
# client_from_manual_flow


def client_from_manual_flow(api_key, app_secret, callback_url, token_path,
asyncio=False, token_write_func=None,
enforce_enums=True):
Expand Down Expand Up @@ -385,6 +445,10 @@ def client_from_manual_flow(api_key, app_secret, callback_url, token_path,
asyncio, enforce_enums=enforce_enums)


################################################################################
# client_from_access_functions


def client_from_access_functions(api_key, app_secret, token_read_func,
token_write_func, asyncio=False,
enforce_enums=True):
Expand Down
Loading
Loading