Spaces:
Running
Running
File size: 30,545 Bytes
507acad |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 |
ο»Ώ# modules/storage.py
__version__ = "0.1.5"
import os
import urllib.parse
import tempfile
import shutil
import json
import base64
import logging
from datetime import datetime, timezone
from huggingface_hub import login, upload_folder, hf_hub_download, HfApi
from huggingface_hub.utils import RepositoryNotFoundError, EntryNotFoundError
from .constants import HF_API_TOKEN, upload_file_types, model_extensions, image_extensions, audio_extensions, video_extensions, doc_extensions, HF_REPO_ID, SHORTENER_JSON_FILE
from typing import Any, Dict, List, Tuple, Union, Optional
# Configure professional logging
logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
logger = logging.getLogger(__name__)
# see storage.md for detailed information about the storage module and its functions.
def generate_permalink(valid_files, base_url_external, permalink_viewer_url="surn-3d-viewer.hf.space"):
"""
Given a list of valid files, checks if they contain exactly 1 model file and 2 image files.
Constructs and returns a permalink URL with query parameters if the criteria is met.
Otherwise, returns None.
"""
model_link = None
images_links = []
audio_links = []
video_links = []
doc_links = []
for f in valid_files:
filename = os.path.basename(f)
ext = os.path.splitext(filename)[1].lower()
if ext in model_extensions:
if model_link is None:
model_link = f"{base_url_external}/{filename}"
elif ext in image_extensions:
images_links.append(f"{base_url_external}/{filename}")
elif ext in audio_extensions:
audio_links.append(f"{base_url_external}/{filename}")
elif ext in video_extensions:
video_links.append(f"{base_url_external}/{filename}")
elif ext in doc_extensions:
doc_links.append(f"{base_url_external}/{filename}")
if model_link and len(images_links) == 2:
# Construct a permalink to the viewer project with query parameters.
permalink_viewer_url = f"https://{permalink_viewer_url}/"
params = {"3d": model_link, "hm": images_links[0], "image": images_links[1]}
query_str = urllib.parse.urlencode(params)
return f"{permalink_viewer_url}?{query_str}"
return None
def generate_permalink_from_urls(model_url, hm_url, img_url, permalink_viewer_url="surn-3d-viewer.hf.space"):
"""
Constructs and returns a permalink URL with query string parameters for the viewer.
Each parameter is passed separately so that the image positions remain consistent.
Parameters:
model_url (str): Processed URL for the 3D model.
hm_url (str): Processed URL for the height map image.
img_url (str): Processed URL for the main image.
permalink_viewer_url (str): The base viewer URL.
Returns:
str: The generated permalink URL.
"""
import urllib.parse
params = {"3d": model_url, "hm": hm_url, "image": img_url}
query_str = urllib.parse.urlencode(params)
return f"https://{permalink_viewer_url}/?{query_str}"
def upload_files_to_repo(
files: List[Any],
repo_id: str,
folder_name: str,
create_permalink: bool = False,
repo_type: str = "dataset",
permalink_viewer_url: str = "surn-3d-viewer.hf.space"
) -> Union[Dict[str, Any], List[Tuple[Any, str]]]:
"""
Uploads multiple files to a Hugging Face repository using a batch upload approach via upload_folder.
Parameters:
files (list): A list of file paths (str) to upload.
repo_id (str): The repository ID on Hugging Face for storage, e.g. "Surn/Storage".
folder_name (str): The subfolder within the repository where files will be saved.
create_permalink (bool): If True and if exactly three files are uploaded (1 model and 2 images),
returns a single permalink to the project with query parameters.
Otherwise, returns individual permalinks for each file.
repo_type (str): Repository type ("space", "dataset", etc.). Default is "dataset".
permalink_viewer_url (str): The base viewer URL.
Returns:
Union[Dict[str, Any], List[Tuple[Any, str]]]:
If create_permalink is True and files match the criteria:
dict: {
"response": <upload response>,
"permalink": <full_permalink URL>,
"short_permalink": <shortened permalink URL>
}
Otherwise:
list: A list of tuples (response, permalink) for each file.
"""
logger.info(f"π€ Starting batch upload to repository: {repo_id}")
logger.debug(f"π Target folder: {folder_name}")
logger.debug(f"π Create permalink: {create_permalink}")
# Log in using the HF API token.
try:
login(token=HF_API_TOKEN)
logger.debug("π Authenticated with Hugging Face")
except Exception as e:
logger.error(f"π« Authentication failed: {e}")
return {"response": "Authentication failed", "permalink": None, "short_permalink": None} if create_permalink else []
valid_files = []
permalink_short = None
# Ensure folder_name does not have a trailing slash.
folder_name = folder_name.rstrip("/")
# Filter for valid files based on allowed extensions.
logger.debug("π Filtering valid files...")
for f in files:
file_name = f if isinstance(f, str) else f.name if hasattr(f, "name") else None
if file_name is None:
continue
ext = os.path.splitext(file_name)[1].lower()
if ext in upload_file_types:
valid_files.append(f)
logger.debug(f"β
Valid file: {os.path.basename(file_name)}")
else:
logger.debug(f"β οΈ Skipped file with invalid extension: {os.path.basename(file_name)}")
logger.info(f"π Found {len(valid_files)} valid files out of {len(files)} total")
if not valid_files:
logger.warning("β οΈ No valid files to upload")
if create_permalink:
return {
"response": "No valid files to upload.",
"permalink": None,
"short_permalink": None
}
return []
# Create a temporary directory and copy valid files
logger.debug("π Creating temporary directory for batch upload...")
with tempfile.TemporaryDirectory(dir=os.getenv("TMPDIR", "/tmp")) as temp_dir:
for file_path in valid_files:
filename = os.path.basename(file_path)
dest_path = os.path.join(temp_dir, filename)
shutil.copy(file_path, dest_path)
logger.debug(f"π Copied: {filename}")
logger.info("π Starting batch upload to Hugging Face...")
# Batch upload all files in the temporary folder.
try:
response = upload_folder(
folder_path=temp_dir,
repo_id=repo_id,
repo_type=repo_type,
path_in_repo=folder_name,
commit_message="Batch upload files"
)
logger.info("β
Batch upload completed successfully")
except Exception as e:
logger.error(f"β Batch upload failed: {e}")
return {"response": f"Upload failed: {e}", "permalink": None, "short_permalink": None} if create_permalink else []
# Construct external URLs for each uploaded file.
base_url_external = f"https://huggingface.co/datasets/{repo_id}/resolve/main/{folder_name}"
individual_links = []
for file_path in valid_files:
filename = os.path.basename(file_path)
link = f"{base_url_external}/{filename}"
individual_links.append(link)
logger.debug(f"π Generated link: {link}")
# Handle permalink creation if requested
if create_permalink:
logger.info("π Attempting to create permalink...")
permalink = generate_permalink(valid_files, base_url_external, permalink_viewer_url)
if permalink:
logger.info(f"β
Generated permalink: {permalink}")
logger.debug("π Creating short URL...")
status, short_id = gen_full_url(
full_url=permalink,
repo_id=HF_REPO_ID,
json_file=SHORTENER_JSON_FILE
)
if status in ["created_short", "success_retrieved_short", "exists_match"]:
permalink_short = f"https://{permalink_viewer_url}/?sid={short_id}"
logger.info(f"β
Created short permalink: {permalink_short}")
else:
permalink_short = None
logger.warning(f"β οΈ URL shortening failed: {status} for {permalink}")
return {
"response": response,
"permalink": permalink,
"short_permalink": permalink_short
}
else:
logger.warning("β οΈ Permalink generation failed (criteria not met)")
return {
"response": response,
"permalink": None,
"short_permalink": None
}
# Return individual tuples for each file
logger.info(f"π Returning individual links for {len(individual_links)} files")
return [(response, link) for link in individual_links]
def _generate_short_id(length=8):
"""Generates a random base64 URL-safe string."""
return base64.urlsafe_b64encode(os.urandom(length * 2))[:length].decode('utf-8')
def _get_json_from_repo(repo_id, json_file_name, repo_type="dataset"):
"""Downloads and loads the JSON file from the repo. Returns empty list if not found or error."""
try:
login(token=HF_API_TOKEN)
json_path = hf_hub_download(
repo_id=repo_id,
filename=json_file_name,
repo_type=repo_type,
token=HF_API_TOKEN
)
with open(json_path, 'r') as f:
data = json.load(f)
os.remove(json_path)
return data
except RepositoryNotFoundError:
logger.warning(f"Repository {repo_id} not found.")
return []
except EntryNotFoundError:
logger.warning(f"JSON file {json_file_name} not found in {repo_id}. Initializing with empty list.")
return []
except json.JSONDecodeError:
logger.error(f"Error decoding JSON from {json_file_name}. Returning empty list.")
return []
except Exception as e:
logger.error(f"An unexpected error occurred while fetching {json_file_name}: {e}")
return []
def _get_files_from_repo(repo_id, file_name, repo_type="dataset"):
"""Downloads and loads the file from the repo. File must be in upload_file_types. Returns empty list if not found or error."""
filename = os.path.basename(file_name)
ext = os.path.splitext(file_name)[1].lower()
if ext not in upload_file_types:
logger.error(f"File {filename} with extension {ext} is not allowed for upload.")
return None
else:
try:
login(token=HF_API_TOKEN)
file_path = hf_hub_download(
repo_id=repo_id,
filename=file_name,
repo_type=repo_type,
token=HF_API_TOKEN
)
if not file_path:
return None
return file_path
except RepositoryNotFoundError:
logger.warning(f"Repository {repo_id} not found.")
return None
except EntryNotFoundError:
logger.warning(f"file {file_name} not found in {repo_id}. Initializing with empty list.")
return None
except Exception as e:
logger.error(f"Error fetching {file_name} from {repo_id}: {e}")
return None
def _upload_json_to_repo(data, repo_id, json_file_name, repo_type="dataset"):
"""Uploads the JSON data to the specified file in the repo."""
try:
login(token=HF_API_TOKEN)
api = HfApi()
# Use a temporary directory specified by TMPDIR or default to system temp
temp_dir_for_json = os.getenv("TMPDIR", tempfile.gettempdir())
os.makedirs(temp_dir_for_json, exist_ok=True)
with tempfile.NamedTemporaryFile(mode="w+", delete=False, suffix=".json", dir=temp_dir_for_json) as tmp_file:
json.dump(data, tmp_file, indent=2)
tmp_file_path = tmp_file.name
logger.info(f"π€ Uploading JSON data to {json_file_name}...")
api.upload_file(
path_or_fileobj=tmp_file_path,
path_in_repo=json_file_name,
repo_id=repo_id,
repo_type=repo_type,
commit_message=f"Update {json_file_name}"
)
os.remove(tmp_file_path) # Clean up temporary file
logger.info("β
JSON data uploaded successfully")
return True
except Exception as e:
logger.error(f"Failed to upload {json_file_name} to {repo_id}: {e}")
if 'tmp_file_path' in locals() and os.path.exists(tmp_file_path):
os.remove(tmp_file_path) # Ensure cleanup on error too
return False
def _find_url_in_json(data, short_url=None, full_url=None):
"""
Searches the JSON data.
If short_url is provided, returns the corresponding full_url or None.
If full_url is provided, returns the corresponding short_url or None.
"""
if not data: # Handles cases where data might be None or empty
return None
if short_url:
for item in data:
if item.get("short_url") == short_url:
return item.get("full_url")
if full_url:
for item in data:
if item.get("full_url") == full_url:
return item.get("short_url")
return None
def _add_url_to_json(data, short_url, full_url):
"""Adds a new short_url/full_url pair to the data. Returns updated data."""
if data is None:
data = []
data.append({"short_url": short_url, "full_url": full_url})
return data
def gen_full_url(short_url=None, full_url=None, repo_id=None, repo_type="dataset", permalink_viewer_url="surn-3d-viewer.hf.space", json_file="shortener.json"):
"""
Manages short URLs and their corresponding full URLs in a JSON file stored in a Hugging Face repository.
- If short_url is provided, attempts to retrieve and return the full_url.
- If full_url is provided, attempts to retrieve an existing short_url or creates a new one, stores it, and returns the short_url.
- If both are provided, checks for consistency or creates a new entry.
- If neither is provided, or repo_id is missing, returns an error status.
Returns:
tuple: (status_message, result_url)
status_message can be "success", "created", "exists", "error", "not_found".
result_url is the relevant URL (short or full) or None if an error occurs or not found.
"""
if not repo_id:
return "error_repo_id_missing", None
if not short_url and not full_url:
return "error_no_input", None
login(token=HF_API_TOKEN) # Ensure login at the beginning
url_data = _get_json_from_repo(repo_id, json_file, repo_type)
# Case 1: Only short_url provided (lookup full_url)
if short_url and not full_url:
found_full_url = _find_url_in_json(url_data, short_url=short_url)
return ("success_retrieved_full", found_full_url) if found_full_url else ("not_found_short", None)
# Case 2: Only full_url provided (lookup or create short_url)
if full_url and not short_url:
existing_short_url = _find_url_in_json(url_data, full_url=full_url)
if existing_short_url:
return "success_retrieved_short", existing_short_url
else:
# Create new short_url
new_short_id = _generate_short_id()
url_data = _add_url_to_json(url_data, new_short_id, full_url)
if _upload_json_to_repo(url_data, repo_id, json_file, repo_type):
return "created_short", new_short_id
else:
return "error_upload", None
# Case 3: Both short_url and full_url provided
if short_url and full_url:
found_full_for_short = _find_url_in_json(url_data, short_url=short_url)
found_short_for_full = _find_url_in_json(url_data, full_url=full_url)
if found_full_for_short == full_url:
return "exists_match", short_url
if found_full_for_short is not None and found_full_for_short != full_url:
return "error_conflict_short_exists_different_full", short_url
if found_short_for_full is not None and found_short_for_full != short_url:
return "error_conflict_full_exists_different_short", found_short_for_full
# If short_url is provided and not found, or full_url is provided and not found,
# or neither is found, then create a new entry with the provided short_url and full_url.
# This effectively allows specifying a custom short_url if it's not already taken.
url_data = _add_url_to_json(url_data, short_url, full_url)
if _upload_json_to_repo(url_data, repo_id, json_file, repo_type):
return "created_specific_pair", short_url
else:
return "error_upload", None
return "error_unhandled_case", None # Should not be reached
def _encrypt_private_key(private_key: str, password: str = None) -> str:
"""
Basic encryption for private keys. In production, use proper encryption like Fernet.
Note: This is a simplified encryption for demonstration. In production environments,
use proper encryption libraries like cryptography.fernet.Fernet with secure key derivation.
Args:
private_key (str): The private key to encrypt
password (str, optional): Password for encryption. If None, uses a default method.
Returns:
str: Base64 encoded encrypted private key
"""
# WARNING: This is a basic XOR encryption for demo purposes only
# In production, use proper encryption like Fernet from cryptography library
if not password:
password = "default_encryption_key" # In production, use secure key derivation
encrypted_bytes = []
for i, char in enumerate(private_key):
encrypted_bytes.append(ord(char) ^ ord(password[i % len(password)]))
encrypted_data = bytes(encrypted_bytes)
return base64.b64encode(encrypted_data).decode('utf-8')
def _decrypt_private_key(encrypted_private_key: str, password: str = None) -> str:
"""
Basic decryption for private keys. In production, use proper decryption like Fernet.
Args:
encrypted_private_key (str): Base64 encoded encrypted private key
password (str, optional): Password for decryption. If None, uses a default method.
Returns:
str: Decrypted private key
"""
# WARNING: This is a basic XOR decryption for demo purposes only
if not password:
password = "default_encryption_key" # In production, use secure key derivation
encrypted_data = base64.b64decode(encrypted_private_key)
decrypted_chars = []
for i, byte in enumerate(encrypted_data):
decrypted_chars.append(chr(byte ^ ord(password[i % len(password)])))
return ''.join(decrypted_chars)
def store_issuer_keypair(issuer_id: str, public_key: str, private_key: str, repo_id: str = None) -> bool:
"""
Store cryptographic keys for an issuer in the private Hugging Face repository.
**IMPORTANT: This function requires a PRIVATE Hugging Face repository to ensure
the security of stored private keys. Never use this with public repositories.**
The keys are stored in the following structure:
keys/issuers/{issuer_id}/
βββ private_key.json (encrypted)
βββ public_key.json
Args:
issuer_id (str): Unique identifier for the issuer (e.g., "https://example.edu/issuers/565049")
public_key (str): Multibase-encoded public key
private_key (str): Multibase-encoded private key (will be encrypted before storage)
repo_id (str, optional): Repository ID. If None, uses HF_REPO_ID from constants.
Returns:
bool: True if keys were stored successfully, False otherwise
Raises:
ValueError: If issuer_id, public_key, or private_key are empty
Exception: If repository operations fail
Example:
>>> public_key = "z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"
>>> private_key = "z3u2MQhLnQw7nvJRGJCdKdqfXHV4N7BLKuEGFWnJqsVSdgYv"
>>> success = store_issuer_keypair("https://example.edu/issuers/565049", public_key, private_key)
>>> print(f"Keys stored: {success}")
"""
if not issuer_id or not public_key or not private_key:
logger.error("β Missing required parameters: issuer_id, public_key, and private_key are required")
raise ValueError("issuer_id, public_key, and private_key are required")
if not repo_id:
repo_id = HF_REPO_ID
logger.debug(f"π§ Using default repository: {repo_id}")
# Sanitize issuer_id for use as folder name
safe_issuer_id = issuer_id.replace("https://", "").replace("http://", "").replace("/", "_").replace(":", "_")
logger.info(f"π Storing keypair for issuer: {issuer_id}")
logger.debug(f"ποΈ Safe issuer ID: {safe_issuer_id}")
try:
# Encrypt the private key before storage
encrypted_private_key = _encrypt_private_key(private_key)
logger.debug("π Private key encrypted successfully")
# Prepare key data structures
private_key_data = {
"issuer_id": issuer_id,
"encrypted_private_key": encrypted_private_key,
"key_type": "Ed25519VerificationKey2020",
"created_at": datetime.now(timezone.utc).isoformat(),
"encryption_method": "basic_xor" # In production, use proper encryption
}
public_key_data = {
"issuer_id": issuer_id,
"public_key": public_key,
"key_type": "Ed25519VerificationKey2020",
"created_at": datetime.now(timezone.utc).isoformat()
}
logger.info("π€ Uploading private key...")
# Store private key
private_key_path = f"keys/issuers/{safe_issuer_id}/private_key.json"
private_key_success = _upload_json_to_repo(private_key_data, repo_id, private_key_path, "dataset")
logger.info("π€ Uploading public key...")
# Store public key
public_key_path = f"keys/issuers/{safe_issuer_id}/public_key.json"
public_key_success = _upload_json_to_repo(public_key_data, repo_id, public_key_path, "dataset")
# Update global verification methods registry
if private_key_success and public_key_success:
logger.info("π Updating verification methods registry...")
_update_verification_methods_registry(issuer_id, safe_issuer_id, public_key, repo_id)
logger.info("β
Keypair stored successfully and registry updated")
else:
logger.error("β Failed to store one or both keys")
return private_key_success and public_key_success
except Exception as e:
logger.error(f"π₯ Error storing issuer keypair for {issuer_id}: {e}")
return False
def get_issuer_keypair(issuer_id: str, repo_id: str = None) -> Tuple[Optional[str], Optional[str]]:
"""
Retrieve stored cryptographic keys for an issuer from the private Hugging Face repository.
**IMPORTANT: This function accesses a PRIVATE Hugging Face repository containing
encrypted private keys. Ensure proper access control and security measures.**
Args:
issuer_id (str): Unique identifier for the issuer
repo_id (str, optional): Repository ID. If None, uses HF_REPO_ID from constants.
Returns:
Tuple[Optional[str], Optional[str]]: (public_key, private_key) or (None, None) if not found
Raises:
ValueError: If issuer_id is empty
Exception: If repository operations fail or decryption fails
Example:
>>> public_key, private_key = get_issuer_keypair("https://example.edu/issuers/565049")
>>> if public_key and private_key:
... print("Keys retrieved successfully")
... else:
... print("Keys not found")
"""
if not issuer_id:
logger.error("β issuer_id is required")
raise ValueError("issuer_id is required")
if not repo_id:
repo_id = HF_REPO_ID
logger.debug(f"π§ Using default repository: {repo_id}")
# Sanitize issuer_id for use as folder name
safe_issuer_id = issuer_id.replace("https://", "").replace("http://", "").replace("/", "_").replace(":", "_")
logger.info(f"π Retrieving keypair for issuer: {issuer_id}")
logger.debug(f"ποΈ Safe issuer ID: {safe_issuer_id}")
try:
logger.debug("π₯ Retrieving public key...")
# Retrieve public key
public_key_path = f"keys/issuers/{safe_issuer_id}/public_key.json"
public_key_data = _get_json_from_repo(repo_id, public_key_path, "dataset")
logger.debug("π₯ Retrieving private key...")
# Retrieve private key
private_key_path = f"keys/issuers/{safe_issuer_id}/private_key.json"
private_key_data = _get_json_from_repo(repo_id, private_key_path, "dataset")
if not public_key_data or not private_key_data:
logger.warning(f"β οΈ Keys not found for issuer {issuer_id}")
return None, None
# Extract and decrypt private key
encrypted_private_key = private_key_data.get("encrypted_private_key")
if not encrypted_private_key:
logger.error(f"β No encrypted private key found for issuer {issuer_id}")
return None, None
logger.debug("π Decrypting private key...")
decrypted_private_key = _decrypt_private_key(encrypted_private_key)
public_key = public_key_data.get("public_key")
logger.info(f"β
Successfully retrieved keypair for issuer {issuer_id}")
return public_key, decrypted_private_key
except Exception as e:
logger.error(f"π₯ Error retrieving issuer keypair for {issuer_id}: {e}")
return None, None
def _update_verification_methods_registry(issuer_id: str, safe_issuer_id: str, public_key: str, repo_id: str):
"""
Update the global verification methods registry with new issuer public key.
Args:
issuer_id (str): Original issuer ID
safe_issuer_id (str): Sanitized issuer ID for file system
public_key (str): Public key to register
repo_id (str): Repository ID
"""
try:
registry_path = "keys/global/verification_methods.json"
registry_data = _get_json_from_repo(repo_id, registry_path, "dataset")
if not registry_data:
registry_data = {"verification_methods": []}
# Check if issuer already exists in registry
existing_entry = None
for i, method in enumerate(registry_data.get("verification_methods", [])):
if method.get("issuer_id") == issuer_id:
existing_entry = i
break
# Create new verification method entry
verification_method = {
"issuer_id": issuer_id,
"safe_issuer_id": safe_issuer_id,
"public_key": public_key,
"key_type": "Ed25519VerificationKey2020",
"updated_at": datetime.now(timezone.utc).isoformat()
}
if existing_entry is not None:
# Update existing entry
registry_data["verification_methods"][existing_entry] = verification_method
logger.info(f"β»οΈ Updated verification method for issuer {issuer_id}")
else:
# Add new entry
registry_data["verification_methods"].append(verification_method)
logger.info(f"β Added new verification method for issuer {issuer_id}")
# Upload updated registry
_upload_json_to_repo(registry_data, repo_id, registry_path, "dataset")
logger.info("β
Verification methods registry updated successfully")
except Exception as e:
logger.error(f"Error updating verification methods registry: {e}")
def get_verification_methods_registry(repo_id: str = None) -> Dict[str, Any]:
"""
Retrieve the global verification methods registry.
Args:
repo_id (str, optional): Repository ID. If None, uses HF_REPO_ID from constants.
Returns:
Dict[str, Any]: Registry data containing all verification methods
"""
if not repo_id:
repo_id = HF_REPO_ID
try:
registry_path = "keys/global/verification_methods.json"
registry_data = _get_json_from_repo(repo_id, registry_path, "dataset")
return registry_data if registry_data else {"verification_methods": []}
except Exception as e:
logger.error(f"Error retrieving verification methods registry: {e}")
return {"verification_methods": []}
def list_issuer_ids(repo_id: str = None) -> List[str]:
"""
List all issuer IDs that have stored keys in the repository.
Args:
repo_id (str, optional): Repository ID. If None, uses HF_REPO_ID from constants.
Returns:
List[str]: List of issuer IDs
"""
if not repo_id:
repo_id = HF_REPO_ID
try:
registry = get_verification_methods_registry(repo_id)
return [method["issuer_id"] for method in registry.get("verification_methods", [])]
except Exception as e:
logger.error(f"Error listing issuer IDs: {e}")
return []
if __name__ == "__main__":
issuer_id = "https://example.edu/issuers/565049"
# Example usage
public_key, private_key = get_issuer_keypair(issuer_id)
print(f"Public Key: {public_key}")
print(f"Private Key: {private_key}")
# Example to store keys
store_issuer_keypair(issuer_id, public_key, private_key)
# Example to list issuer IDs
issuer_ids = list_issuer_ids()
print(f"Issuer IDs: {issuer_ids}")
|