mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
9b4fcdb564
- Added the lint to examples - README format moved from Restructuredtext to Markdown - Removed the [INFO] and [ERROR] from output, to avoid confundint with logging structure Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
140 lines
3.4 KiB
Python
Executable file
140 lines
3.4 KiB
Python
Executable file
#!/usr/bin/env python
|
|
"""Python Client Example."""
|
|
|
|
# Copyright 2012 - 2017, New York University and the TUF contributors
|
|
# SPDX-License-Identifier: MIT OR Apache-2.0
|
|
|
|
import argparse
|
|
import os
|
|
import shutil
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
from tuf.ngclient import Updater
|
|
|
|
# define directory constants
|
|
HOME_DIR = Path.home() # user home dir
|
|
DOWNLOAD_DIR = "./downloads" # download dir
|
|
METADATA_DIR = f"{HOME_DIR}/.local/share/tuf_metadata_example" # metadata dir
|
|
CLIENT_EXAMPLE_DIR = os.path.dirname(os.path.abspath(__file__)) # example dir
|
|
|
|
|
|
def init():
|
|
"""
|
|
Initialize the TUF Client infrastructure
|
|
|
|
This function initializes the creation of the download and TUF metadata
|
|
directory.
|
|
"""
|
|
|
|
if not os.path.isdir(DOWNLOAD_DIR):
|
|
os.mkdir(DOWNLOAD_DIR)
|
|
|
|
print(f"Download directory [{DOWNLOAD_DIR}] is created.")
|
|
|
|
if not os.path.isdir(METADATA_DIR):
|
|
os.makedirs(METADATA_DIR)
|
|
|
|
print(f"Metadata folder [{METADATA_DIR}] is created.")
|
|
|
|
if not os.path.isfile(f"{METADATA_DIR}/root.json"):
|
|
shutil.copy(
|
|
f"{CLIENT_EXAMPLE_DIR}/1.root.json", f"{METADATA_DIR}/root.json"
|
|
)
|
|
print("Bootstrap initial root metadata.")
|
|
|
|
|
|
def tuf_updater():
|
|
"""
|
|
This function implement the ``tuf.ngclient.Updater`` and returns
|
|
the updater.
|
|
"""
|
|
url = "http://127.0.0.1:8000"
|
|
|
|
updater = Updater(
|
|
repository_dir=METADATA_DIR,
|
|
metadata_base_url=f"{url}/metadata/",
|
|
target_base_url=f"{url}/targets/",
|
|
target_dir=DOWNLOAD_DIR,
|
|
)
|
|
|
|
return updater
|
|
|
|
|
|
def download(target):
|
|
"""
|
|
Download the target file using the TUF ``nglcient`` Updater process.
|
|
|
|
The Updater refreshes the top-level metadata, get the target information,
|
|
verifies if the target is already cached, and in case it is not cached,
|
|
downloads the target file.
|
|
"""
|
|
|
|
try:
|
|
updater = tuf_updater()
|
|
|
|
except ConnectionError:
|
|
print("Failed to connect http://127.0.0.1:8000")
|
|
sys.exit(1)
|
|
|
|
updater.refresh()
|
|
print("Top-level metadata is refreshed.")
|
|
|
|
info = updater.get_targetinfo(target)
|
|
print("Target info gotten.")
|
|
|
|
if info is None:
|
|
print("Target file not found.")
|
|
sys.exit(1)
|
|
|
|
path = updater.find_cached_target(info)
|
|
if path:
|
|
print(f"File is already available in {DOWNLOAD_DIR}/{info.path}.")
|
|
sys.exit(0)
|
|
|
|
path = updater.download_target(info)
|
|
|
|
print(f"File downloaded available in {DOWNLOAD_DIR}/{info.path}.")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
client_args = argparse.ArgumentParser(
|
|
description="TUF Python Client Example"
|
|
)
|
|
|
|
# Global arguments
|
|
client_args.add_argument(
|
|
"--init",
|
|
default=False,
|
|
help="Initializes the Client structure.",
|
|
action="store_true",
|
|
)
|
|
|
|
# Sub commands
|
|
sub_commands = client_args.add_subparsers(dest="sub_commands")
|
|
|
|
# Download
|
|
download_parser = sub_commands.add_parser(
|
|
"download",
|
|
help="Download a target file",
|
|
)
|
|
|
|
download_parser.add_argument(
|
|
"target",
|
|
metavar="TARGET",
|
|
help="Target file",
|
|
)
|
|
|
|
command_args = vars(client_args.parse_args())
|
|
sub_commands_args = command_args.get("sub_commands")
|
|
|
|
if command_args.get("init") is True:
|
|
init()
|
|
|
|
elif not sub_commands_args:
|
|
client_args.print_help()
|
|
|
|
if sub_commands_args == "download":
|
|
target_download = command_args.get("target")
|
|
download(target_download)
|