Post-Local sync at 2025-06-23T22:46:07Z
This commit is contained in:
Mark Randall Havens
parent
9d33b42020
commit
9f97801b0d
1387 changed files with 250216 additions and 117 deletions
|
|
@ -0,0 +1,179 @@
|
|||
"""
|
||||
ia_configure.py
|
||||
|
||||
'ia' subcommand for configuring 'ia' with your archive.org credentials.
|
||||
"""
|
||||
|
||||
# Copyright (C) 2012-2024 Internet Archive
|
||||
#
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Affero General Public License as
|
||||
# published by the Free Software Foundation, either version 3 of the
|
||||
# License, or (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU Affero General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import netrc
|
||||
import sys
|
||||
|
||||
from internetarchive import configure
|
||||
from internetarchive.exceptions import AuthenticationError
|
||||
|
||||
|
||||
def setup(subparsers):
|
||||
"""
|
||||
Setup args for configure command.
|
||||
|
||||
Args:
|
||||
subparsers: subparser object passed from ia.py
|
||||
"""
|
||||
parser = subparsers.add_parser("configure",
|
||||
aliases=["co"],
|
||||
help=("configure 'ia' with your "
|
||||
"archive.org credentials"))
|
||||
config_action_group = parser.add_mutually_exclusive_group()
|
||||
|
||||
parser.add_argument("--username", "-u",
|
||||
help=("provide username as an option rather than "
|
||||
"providing it interactively"))
|
||||
parser.add_argument("--password", "-p",
|
||||
help=("provide password as an option rather than "
|
||||
"providing it interactively"))
|
||||
parser.add_argument("--netrc", "-n",
|
||||
action="store_true",
|
||||
help="use netrc file for login")
|
||||
config_action_group.add_argument("--show", "-s",
|
||||
action="store_true",
|
||||
help=("print the current configuration in JSON format, "
|
||||
"redacting secrets and cookies"))
|
||||
config_action_group.add_argument("--check", "-C",
|
||||
action="store_true",
|
||||
help="validate IA-S3 keys (exits 0 if valid, 1 otherwise)")
|
||||
config_action_group.add_argument("--whoami", "-w",
|
||||
action="store_true",
|
||||
help=("uses your IA-S3 keys to retrieve account "
|
||||
"information from archive.org "
|
||||
"about the associated account"))
|
||||
parser.add_argument("--print-cookies", "-c",
|
||||
action="store_true",
|
||||
help="print archive.org logged-in-* cookies")
|
||||
parser.add_argument("--print-auth-header", "-a",
|
||||
action="store_true",
|
||||
help="print an Authorization header with your IA-S3 keys")
|
||||
|
||||
parser.set_defaults(func=main)
|
||||
|
||||
|
||||
def main(args: argparse.Namespace) -> None:
|
||||
"""
|
||||
Main entrypoint for 'ia configure'.
|
||||
"""
|
||||
if args.print_auth_header:
|
||||
secret = args.session.config.get("s3", {}).get("secret")
|
||||
access = args.session.config.get("s3", {}).get("access")
|
||||
if not secret or not access:
|
||||
print('hi')
|
||||
if not access:
|
||||
print("error: 'access' key not found in config file, try reconfiguring.",
|
||||
file=sys.stderr)
|
||||
elif not secret:
|
||||
print("error: 'secret' key not found in config file, try reconfiguring.",
|
||||
file=sys.stderr)
|
||||
sys.exit(1)
|
||||
print(f"Authorization: LOW {access}:{secret}")
|
||||
sys.exit()
|
||||
|
||||
if args.print_cookies:
|
||||
user = args.session.config.get("cookies", {}).get("logged-in-user")
|
||||
sig = args.session.config.get("cookies", {}).get("logged-in-sig")
|
||||
if not user or not sig:
|
||||
if not user and not sig:
|
||||
print("error: 'logged-in-user' and 'logged-in-sig' cookies "
|
||||
"not found in config file, try reconfiguring.", file=sys.stderr)
|
||||
elif not user:
|
||||
print("error: 'logged-in-user' cookie not found in config file, "
|
||||
"try reconfiguring.", file=sys.stderr)
|
||||
elif not sig:
|
||||
print("error: 'logged-in-sig' cookie not found in config file, "
|
||||
"try reconfiguring.", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
print(f"logged-in-user={user}; logged-in-sig={sig}")
|
||||
sys.exit()
|
||||
|
||||
if args.show:
|
||||
config = args.session.config.copy()
|
||||
# Redact S3 secret
|
||||
if 's3' in config:
|
||||
s3_config = config['s3'].copy()
|
||||
if 'secret' in s3_config:
|
||||
s3_config['secret'] = 'REDACTED'
|
||||
config['s3'] = s3_config
|
||||
# Redact logged-in-secret cookie
|
||||
if 'cookies' in config:
|
||||
cookies = config['cookies'].copy()
|
||||
if 'logged-in-sig' in cookies:
|
||||
cookies['logged-in-sig'] = 'REDACTED'
|
||||
config['cookies'] = cookies
|
||||
print(json.dumps(config))
|
||||
sys.exit()
|
||||
|
||||
if args.whoami:
|
||||
whoami_info = args.session.whoami()
|
||||
print(json.dumps(whoami_info))
|
||||
sys.exit()
|
||||
|
||||
if args.check:
|
||||
whoami_info = args.session.whoami()
|
||||
if whoami_info.get('success') is True:
|
||||
user = whoami_info['value']['username']
|
||||
print(f'The credentials for "{user}" are valid')
|
||||
sys.exit(0)
|
||||
else:
|
||||
print('Your credentials are invalid, check your configuration and try again')
|
||||
sys.exit(1)
|
||||
|
||||
try:
|
||||
# Netrc
|
||||
if args.netrc:
|
||||
print("Configuring 'ia' with netrc file...", file=sys.stderr)
|
||||
try:
|
||||
n = netrc.netrc()
|
||||
except netrc.NetrcParseError:
|
||||
print("error: netrc.netrc() cannot parse your .netrc file.",
|
||||
file=sys.stderr)
|
||||
sys.exit(1)
|
||||
except FileNotFoundError:
|
||||
print("error: .netrc file not found.", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
username, _, password = n.hosts["archive.org"]
|
||||
config_file_path = configure(username,
|
||||
password or "",
|
||||
config_file=args.session.config_file,
|
||||
host=args.session.host)
|
||||
print(f"Config saved to: {config_file_path}", file=sys.stderr)
|
||||
# Interactive input.
|
||||
else:
|
||||
if not (args.username and args.password):
|
||||
print("Enter your Archive.org credentials below to configure 'ia'.\n")
|
||||
config_file_path = configure(args.username,
|
||||
args.password,
|
||||
config_file=args.session.config_file,
|
||||
host=args.session.host)
|
||||
saved_msg = f"Config saved to: {config_file_path}"
|
||||
if not all([args.username, args.password]):
|
||||
saved_msg = f"\n{saved_msg}"
|
||||
print(saved_msg)
|
||||
|
||||
except AuthenticationError as exc:
|
||||
print(f"\nerror: {exc}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
Loading…
Add table
Add a link
Reference in a new issue