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

Jump to bottom

Fix Authentication by handing it over to garth #114

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Fix Authentication by handing it over to garth #114

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
5d93379
Remove remaining proxy/ paths from URLs
flyingflo Feb 11, 2024
a53435a
Use garth for auth and api
flyingflo Feb 11, 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
5 changes: 2 additions & 3 deletions garminexport/cli/backup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@ def parse_args() -> argparse.Namespace:
"given Garmin Connect account. Only activities that "
"aren't already stored in the backup directory will "
"be downloaded."))
# positional args
parser.add_argument(
"username", metavar="<username>", type=str, help="Account user name.")
# optional args
parser.add_argument(
"--username", type=str, help="Account user name.")
parser.add_argument(
"--password", type=str, help="Account password.")
parser.add_argument(
Expand Down
4 changes: 2 additions & 2 deletions garminexport/cli/get_activity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ def main():
description="Downloads one particular activity for a given Garmin Connect account.")

# positional args
parser.add_argument(
"username", metavar="<username>", type=str, help="Account user name.")
parser.add_argument(
"activity", metavar="<activity>", type=int, help="Activity ID.")
parser.add_argument(
"format", metavar="<format>", type=str,
help="Export format (one of: {}).".format(garminexport.backup.supported_export_formats))

# optional args
parser.add_argument(
"--username", type=str, help="Account user name.")
parser.add_argument(
"--password", type=str, help="Account password.")
parser.add_argument(
Expand Down
4 changes: 2 additions & 2 deletions garminexport/cli/upload_activity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ def main():
description="Uploads an activity file to a Garmin Connect account.")

# positional args
parser.add_argument(
"username", metavar="<username>", type=str, help="Account user name.")
parser.add_argument(
"activity", nargs='+', metavar="<file>", type=argparse.FileType("rb"),
help="Activity file (.gpx, .tcx, or .fit).")

# optional args
parser.add_argument(
"--username", type=str, help="Account user name.")
parser.add_argument(
"--password", type=str, help="Account password.")
parser.add_argument(
Expand Down
215 changes: 37 additions & 178 deletions garminexport/garminclient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,13 @@
import logging
import os
import os.path
import requests
import garth
import sys
import zipfile

from garminexport.retryer import Retryer, ExponentialBackoffDelayStrategy, MaxRetriesStopStrategy


log = logging.getLogger(__name__)
# reduce logging noise from requests library
logging.getLogger("requests").setLevel(logging.ERROR)


PORTAL_LOGIN_URL = "https://sso.garmin.com/portal/api/login"
"""Garmin Connect's Single-Sign On login URL."""
Expand All @@ -41,7 +37,7 @@ def require_session(client_function):
@wraps(client_function)
def check_session(*args, **kwargs):
client_object = args[0]
if not client_object.session:
if not client_object.gc:
raise Exception("Attempt to use GarminClient without being connected. Call connect() before first use.'")
return client_function(*args, **kwargs)

Expand All @@ -66,7 +62,7 @@ class GarminClient(object):

"""

def __init__(self, username, password):
def __init__(self, username=None, password=None):
"""Initialize a :class:`GarminClient` instance.

:param username: Garmin Connect user name or email address.
Expand All @@ -76,8 +72,9 @@ def __init__(self, username, password):
"""
self.username = username
self.password = password
self.tokenpath = "~/.garminauth"

self.session = None
self.gc = None


def __enter__(self):
Expand All @@ -88,13 +85,13 @@ def __exit__(self, exc_type, exc_value, traceback):
self.disconnect()

def connect(self):
self.session = new_http_session()
self.gc = garth.client
self._authenticate()

def disconnect(self):
if self.session:
self.session.close()
self.session = None
if self.gc:
self.gc.dump(self.tokenpath)
self.gc = None

def _authenticate(self):
"""
Expand All @@ -105,132 +102,15 @@ def _authenticate(self):
following a sign-in.
"""
log.info("authenticating user ...")

auth_ticket_url = self._login(self.username, self.password)
log.debug("auth ticket url: '%s'", auth_ticket_url)

self._claim_auth_ticket(auth_ticket_url)

# we need to touch base with the main page to complete the login ceremony.
self.session.get('https://connect.garmin.com/modern')
# This header appears to be needed on subsequent session requests or we
# end up with a 402 response from Garmin.
self.session.headers.update({'NK': 'NT'})

# We need to pass an Authorization oauth token with subsequent requests.
auth_token = self._get_oauth_token()
token_type = auth_token['token_type']
access_token = auth_token['access_token']
self.session.headers.update(
{
'Authorization': f'{token_type} {access_token}',
'Di-Backend': 'connectapi.garmin.com',
})


def _get_oauth_token(self):
"""Retrieve an OAuth token to use for the session.

Typically looks something like the following. The 'access_token'
needs to be passed in the 'Authorization' header for remaining session
requests.

{
"scope": "...",
"jti": "...",
"access_token": "...",
"token_type": "Bearer",
"refresh_token": "...",
"expires_in": 3599,
"refresh_token_expires_in": 7199
}
"""
log.info("getting oauth token ...")
headers = {
'authority': 'connect.garmin.com',
'origin': 'https://connect.garmin.com',
'referer': 'https://connect.garmin.com/modern/',
}
resp = self.session.post('https://connect.garmin.com/modern/di-oauth/exchange',
headers=headers)
if resp.status_code != 200:
raise ValueError(f'get oauth token failed with {resp.status_code}: {resp.text}')
return resp.json()


def _login(self, username, password):
"""Logs in with the supplied account credentials.
The return value is a URL where the created authentication ticket can be claimed.
For example, "https://connect.garmin.com/modern?ticket=ST-2550833-30KdiEJ3jqvFzLNGi2C7-sso"

The response message looks typically something like this:
{
"serviceURL":"https://connect.garmin.com/modern/",
"serviceTicketId":"ST-2550833-30KdiEJ3jqvFzLNGi2C7-sso",
"responseStatus":{"type":"SUCCESSFUL","message":"","httpStatus":"OK"},
"customerMfaInfo":null,
"consentTypeList":null
}
"""
headers = {
'authority': 'sso.garmin.com',
'origin': 'https://sso.garmin.com',
'referer': 'https://sso.garmin.com/portal/sso/en-US/sign-in?clientId=GarminConnect&service=https%3A%2F%2Fconnect.garmin.com%2Fmodern',
}
params = {
"clientId": "GarminConnect",
"service": "https://connect.garmin.com/modern/",
"gauthHost": "https://sso.garmin.com/sso",
}
form_data = {'username': username, 'password': password}

log.info("passing login credentials ...")
resp = self.session.post(PORTAL_LOGIN_URL, headers=headers, params=params, json=form_data)
log.debug("got auth response %d: %s", resp.status_code, resp.text)
if resp.status_code != 200:
raise ValueError(f'authentication attempt failed with {resp.status_code}: {resp.text}')
return self._extract_auth_ticket_url(resp.json())

def _claim_auth_ticket(self, auth_ticket_url):
# Note: first we bump the login URL.
p = {
'clientId': 'GarminConnect',
'service': 'https://connect.garmin.com/modern/',
'webhost': 'https://connect.garmin.com',
'gateway': 'true',
'generateExtraServiceTicket': 'true',
'generateTwoExtraServiceTickets': 'true',
}
self.session.get(SSO_LOGIN_URL, headers={}, params=p)

log.info("claiming auth ticket %s ...", auth_ticket_url)
response = self.session.get(auth_ticket_url)
if response.status_code != 200:
raise RuntimeError(
"auth failure: failed to claim auth ticket: {}: {}\n{}".format(
auth_ticket_url, response.status_code, response.text))


@staticmethod
def _extract_auth_ticket_url(auth_response):
"""Extracts an authentication ticket URL from the response of an
authentication form submission. The auth ticket URL is typically
of form:

https://connect.garmin.com/modern?ticket=ST-0123456-aBCDefgh1iJkLmN5opQ9R-cas

:param auth_response: JSON response from a login form submission.
"""
if auth_response['responseStatus']['type'] == 'INVALID_USERNAME_PASSWORD':
RuntimeError("authentication failure: did you provide a correct username/password?")
service_url = auth_response.get('serviceURL')
auth_ticket = auth_response.get('serviceTicketId')
if not service_url:
raise RuntimeError("auth failure: unable to extract serviceURL")
if not auth_ticket:
raise RuntimeError("auth failure: unable to extract serviceTicketId")
auth_ticket_url = service_url.rstrip('/') + '?ticket=' + auth_ticket
return auth_ticket_url
try:
log.info("Checking for stored tokens at %s", self.tokenpath)
self.gc.load(self.tokenpath)
log.info("Tokens loaded.")
return
except Exception as e:
log.info("No tokens loaded (%s)", str(e))
self.gc.login(self.username, self.password)
log.info("Logged in with username and password.")

@require_session
def list_activities(self):
Expand Down Expand Up @@ -268,8 +148,8 @@ def _fetch_activity_ids_and_ts(self, start_index, max_limit=100):
:rtype: tuples of (int, datetime)
"""
log.debug("fetching activities %d through %d ...", start_index, start_index + max_limit - 1)
response = self.session.get(
"https://connect.garmin.com/activitylist-service/activities/search/activities",
response = self.gc.get(
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flyingflo you can also use self.gc.connectapi()

"connectapi", "/activitylist-service/activities/search/activities", api=True,
params={"start": start_index, "limit": max_limit})
if response.status_code != 200:
raise Exception(
Expand Down Expand Up @@ -301,8 +181,8 @@ def get_activity_summary(self, activity_id):
:returns: The activity summary as a JSON dict.
:rtype: dict
"""
response = self.session.get(
"https://connect.garmin.com/activity-service/activity/{}".format(activity_id))
response = self.gc.get(
"connectapi", "/activity-service/activity/{}".format(activity_id), api=True)
if response.status_code != 200:
log.error(u"failed to fetch json summary for activity %s: %d\n%s",
activity_id, response.status_code, response.text)
Expand All @@ -322,8 +202,8 @@ def get_activity_details(self, activity_id):
:rtype: dict
"""
# mounted at xml or json depending on result encoding
response = self.session.get(
"https://connect.garmin.com/activity-service/activity/{}/details".format(activity_id))
response = self.gc.get(
"connectapi", "/activity-service/activity/{}/details".format(activity_id), api=True)
if response.status_code != 200:
raise Exception(u"failed to fetch json activityDetails for {}: {}\n{}".format(
activity_id, response.status_code, response.text))
Expand All @@ -342,12 +222,12 @@ def get_activity_gpx(self, activity_id):
or ``None`` if the activity couldn't be exported to GPX.
:rtype: str
"""
response = self.session.get(
"https://connect.garmin.com/download-service/export/gpx/activity/{}".format(activity_id))
response = self.gc.get(
"connectapi", "/download-service/export/gpx/activity/{}".format(activity_id), api=True)
# An alternate URL that seems to produce the same results
# and is the one used when exporting through the Garmin
# Connect web page.
# response = self.session.get("https://connect.garmin.com/proxy/activity-service-1.1/gpx/activity/{}?full=true".format(activity_id))
# response = self.gc.get("connectapi", "/proxy/activity-service-1.1/gpx/activity/{}?full=true".format(activity_id))

# A 404 (Not Found) or 204 (No Content) response are both indicators
# of a gpx file not being available for the activity. It may, for
Expand All @@ -374,8 +254,8 @@ def get_activity_tcx(self, activity_id):
:rtype: str
"""

response = self.session.get(
"https://connect.garmin.com/download-service/export/tcx/activity/{}".format(activity_id))
response = self.gc.get(
"connectapi", "/download-service/export/tcx/activity/{}".format(activity_id), api=True)
if response.status_code == 404:
return None
if response.status_code != 200:
Expand All @@ -395,8 +275,8 @@ def get_original_activity(self, activity_id):
its contents, or :obj:`(None,None)` if no file is found.
:rtype: (str, str)
"""
response = self.session.get(
"https://connect.garmin.com/download-service/files/activity/{}".format(activity_id))
response = self.gc.get(
"connectapi", "/download-service/files/activity/{}".format(activity_id), api=True)
# A 404 (Not Found) response is a clear indicator of a missing .fit
# file. As of lately, the endpoint appears to have started to
# respond with 500 "NullPointerException" on attempts to download a
Expand Down Expand Up @@ -452,8 +332,8 @@ def _poll_upload_completion(self, uuid, creation_date):
:obj:`None` if upload is still processing.
:rtype: int
"""
response = self.session.get("https://connect.garmin.com/proxy/activity-service/activity/status/{}/{}?_={}".format(
creation_date[:10], uuid.replace("-",""), int(datetime.now().timestamp()*1000)), headers={"nk": "NT"})
response = self.gc.get("connectapi", "/activity-service/activity/status/{}/{}?_={}".format(
creation_date[:10], uuid.replace("-",""), int(datetime.now().timestamp()*1000)), api=True)
if response.status_code == 201 and response.headers["location"]:
# location should be https://connectapi.garmin.com/activity-service/activity/ACTIVITY_ID
return int(response.headers["location"].split("/")[-1])
Expand Down Expand Up @@ -495,8 +375,8 @@ def upload_activity(self, file, format=None, name=None, description=None, activi

# upload it
files = dict(data=(fn, file))
response = self.session.post("https://connect.garmin.com/proxy/upload-service/upload/.{}".format(format),
files=files, headers={"nk": "NT"})
response = self.gc.post("connectapi", "/upload-service/upload/.{}".format(format),
files=files, api=True)

# check response and get activity ID
try:
Expand Down Expand Up @@ -547,32 +427,11 @@ def upload_activity(self, file, format=None, name=None, description=None, activi
if data:
data['activityId'] = activity_id
encoding_headers = {"Content-Type": "application/json; charset=UTF-8"} # see Tapiriik
response = self.session.put(
"https://connect.garmin.com/proxy/activity-service/activity/{}".format(activity_id),
response = self.gc.put(
"connectapi", "/activity-service/activity/{}".format(activity_id), api=True,
data=json.dumps(data), headers=encoding_headers)
if response.status_code != 204:
raise Exception(u"failed to set metadata for activity {}: {}\n{}".format(
activity_id, response.status_code, response.text))

return activity_id


def new_http_session():
"""Returns a requests-compatible HTTP Session.
See https://requests.readthedocs.io/en/latest/user/advanced/#session-objects.

By default it uses the requests library to create http sessions. If built with
the 'impersonate-browser' extra, it will use curl_cffi and a patched libcurl to
produce identical TLS fingerprints as a real web browsers to circumvent
Cloudflare's bot protection.
"""
session_factory_func = requests.session
try:
import curl_cffi.requests
# For supported browsers: see https://github.com/lwthiker/curl-impersonate#supported-browsers
browser = os.getenv("GARMINEXPORT_IMPERSONATE_BROWSER", "chrome110")
log.info("using 'curl_cffi' to create HTTP sessions that impersonate web browser '%s' ...", browser)
session_factory_func = partial(curl_cffi.requests.Session, impersonate=browser)
except (ImportError):
pass
return session_factory_func()
7 changes: 1 addition & 6 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,10 @@ packages =
garminexport.cli
python_requires = >=3.5
install_requires =
requests>=2.0,<3
garth~=0.4.44
python-dateutil~=2.4

[options.extras_require]
# Note: needed to impersonate web browsers. Garmin Connect uses Cloudflare's bot
# protection which looks at TLS fingerprints to determine if the caller is a
# script (like curl) or a web browser. curl_cffi uses a patched libcurl to
# produce identical TLS fingerprints as real web browsers.
impersonate_browser = curl_cffi==0.5.9
test = pytest~=7.3; pytest-cov~=4.0

[options.entry_points]
Expand Down
Loading