Files
chia-blockchain/chia/cmds/dump_keyring.py
Matt HauffandGitHub 40db4635a8 [LABS-245] Enable PEP604 Ruff rules (#20269)
* Enable PEP604 Ruff rules

* Fix harcoded signature in test

* Hack CLVMStreamable test with note to fast follow
2025-11-18 12:34:00 -08:00

94 lines
2.9 KiB
Python
Executable File

#!/usr/bin/env python3
from __future__ import annotations
import os
from io import TextIOWrapper
from pathlib import Path
from typing import Any, cast
import click
import colorama
import yaml
from cryptography.exceptions import InvalidTag
from chia.cmds.passphrase_funcs import read_passphrase_from_file
from chia.util.default_root import DEFAULT_KEYS_ROOT_PATH
from chia.util.file_keyring import FileKeyringContent
from chia.util.keyring_wrapper import DEFAULT_PASSPHRASE_IF_NO_MASTER_PASSPHRASE, KeyringWrapper, prompt_for_passphrase
DEFAULT_KEYRING_YAML = DEFAULT_KEYS_ROOT_PATH / "keyring.yaml"
def get_passphrase_prompt(keyring_file: str) -> str:
# casting since the colors are Any
prompt = cast(
str,
(
colorama.Fore.YELLOW
+ colorama.Style.BRIGHT
+ "(Unlock Keyring: "
+ colorama.Fore.MAGENTA
+ keyring_file
+ colorama.Style.RESET_ALL
+ colorama.Fore.YELLOW
+ colorama.Style.BRIGHT
+ ")"
+ colorama.Style.RESET_ALL
+ " Passphrase: "
),
)
return prompt
@click.command()
@click.argument("keyring_file", nargs=1, default=os.fspath(DEFAULT_KEYRING_YAML))
@click.option(
"--full-payload", is_flag=True, default=False, help="Print the full keyring contents, including plaintext"
)
@click.option("--passphrase-file", type=click.File("r"), help="File or descriptor to read the passphrase from")
@click.option("--pretty-print", is_flag=True, default=False)
def dump(keyring_file: str, full_payload: bool, passphrase_file: TextIOWrapper | None, pretty_print: bool) -> None:
saved_passphrase: str | None = KeyringWrapper.get_shared_instance().get_master_passphrase_from_credential_store()
passphrase: str = saved_passphrase or DEFAULT_PASSPHRASE_IF_NO_MASTER_PASSPHRASE
prompt: str = get_passphrase_prompt(keyring_file)
print(f"Attempting to dump contents of keyring file: {keyring_file}\n")
if passphrase_file is not None:
passphrase = read_passphrase_from_file(passphrase_file)
keyring_path = Path(keyring_file)
file_content = FileKeyringContent.create_from_path(keyring_path)
file_content_dict = file_content.to_dict()
for i in range(5):
try:
data_dict = file_content.get_decrypted_data_dict(passphrase)
if full_payload:
dump_content: dict[str, Any] = file_content_dict
dump_content["data"] = data_dict
else:
dump_content = data_dict
if pretty_print:
print(yaml.dump(dump_content))
else:
print(dump_content)
break
except (ValueError, InvalidTag):
passphrase = prompt_for_passphrase(prompt)
except Exception as e:
print(f"Unhandled exception: {e}")
break
def main() -> None:
colorama.init()
dump()
if __name__ == "__main__":
main()