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.

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

Use HttpUrlOperations.probe_url() for authentication info determination #38

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
30 changes: 16 additions & 14 deletions tests/test_datalad_workflows/utils.py
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
from __future__ import annotations

import requests
import www_authenticate
from datalad_next.url_operations.http import HttpUrlOperations


def get_restricted_realm(url: str) -> str | None:
"""A very simple function to get the realm for restricted access
"""Get the realm for basic auth-restricted access
This will only work, if the server returns a 'www-authenticate'-
header, and if the authentication method is 'basic'
"""
Parameters
----------
url: str
URL to probe
r = requests.get(url)
Returns
-------
str | None
The name of the realm for basic authentication
or None, if either no authentication is required,
or if the authentication type is not "basic"
"""

auth_header_name = 'WWW-Authenticate'
auth_header = r.headers.get(auth_header_name, None)
if auth_header:
parsed = www_authenticate.parse(auth_header)
if 'Basic' in parsed:
return parsed['Basic']['realm']
return None
http_url_ops = HttpUrlOperations()
_, url_properties = http_url_ops.probe_url(url)
return url_properties.get('auth', {}).get('basic', {}).get('realm')
Loading