Page MenuHomeSoftware Heritage
Files F8394078

cli.py
No OneTemporary
Actions

cli.py
View Options

# Copyright (C) 2020 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information
# WARNING: do not import unnecessary things here to keep cli startup time under
# control
import click
from click.core import Context
from swh.core.cli import swh as swh_cli_group
CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
@swh_cli_group.group(name="auth", context_settings=CONTEXT_SETTINGS)
@click.option(
"--oidc-server-url",
"oidc_server_url",
default="https://auth.softwareheritage.org/auth/",
help=(
"URL of OpenID Connect server (default to "
'"https://auth.softwareheritage.org/auth/")'
),
)
@click.option(
"--realm-name",
"realm_name",
default="SoftwareHeritage",
help=(
"Name of the OpenID Connect authentication realm "
'(default to "SoftwareHeritage")'
),
)
@click.option(
"--client-id",
"client_id",
default="swh-web",
help=("OpenID Connect client identifier in the realm " '(default to "swh-web")'),
)
@click.pass_context
def auth(ctx: Context, oidc_server_url: str, realm_name: str, client_id: str):
"""
Authenticate Software Heritage users with OpenID Connect.
This CLI tool eases the retrieval of a bearer token to authenticate
a user querying the Software Heritage Web API.
"""
from swh.web.client.auth import OpenIDConnectSession
ctx.ensure_object(dict)
ctx.obj["oidc_session"] = OpenIDConnectSession(
oidc_server_url, realm_name, client_id
)
@auth.command("login")
@click.argument("username")
@click.pass_context
def login(ctx: Context, username: str):
"""
Login and create new offline OpenID Connect session.
Login with USERNAME, create a new OpenID Connect session and get
bearer token.
User will be prompted for his password and tokens will be printed
to standard output.
The created OpenID Connect session is an offline one so the provided
token has a much longer expiration time than classical OIDC
sessions (usually several dozens of days).
"""
from getpass import getpass
password = getpass()
oidc_info = ctx.obj["oidc_session"].login(username, password)
if "refresh_token" in oidc_info:
print(oidc_info["refresh_token"])
else:
print(oidc_info)
@auth.command("logout")
@click.argument("token")
@click.pass_context
def logout(ctx: Context, token: str):
"""
Logout from an offline OpenID Connect session.
Use TOKEN to logout from an offline OpenID Connect session.
The token is definitely revoked after that operation.
"""
ctx.obj["oidc_session"].logout(token)
print("Successfully logged out from OpenID Connect session")

File Metadata

Mime Type
text/x-python
Expires
Wed, Jun 4, 7:21 PM (1 w, 4 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3307952

Event Timeline

About · Developer information · Legal