Move common functions to lib/__init__.py

This commit is contained in:
Queen Vinyl Da.i'gyu-Kazotetsu committed 2025-07-07 00:18:18 -07:00
1 parent 12d59f746e
commit 81406a66fa
3 files changed
+122 -109

No files matched your search

+8 -76
View File
@@ -1,12 +1,15 @@
# -*- coding: utf-8 -*-
# Python script to extract the keys from a Bambu Lab filament RFID tag, using a Proxmark3
# Created for https://github.com/Bambu-Research-Group/RFID-Tag-Guide
import subprocess
import os
import re
import sys
from pathlib import Path
if not sys.version_info >= (3, 6):
print("Python 3.6 or higher is required!")
exit(-1)
from .lib import strip_color_codes, get_proxmark3_location, run_command, testCommands
#Global variables
#Default name of the dictionary file we create
@@ -22,6 +25,8 @@ def setup():
global pm3Location,dictionaryFilepath
pm3Location = get_proxmark3_location()
if not pm3Location:
exit(-1)
#Create a dictionary file to store keys that we discover
print(f"Creating dictionary file '{dictionaryFilename}'")
@@ -217,78 +222,5 @@ def bruteForce(args):
return "" #Not found
#Some keys come surrounded in terminal color codes such as "63654db94d97"
#We need to remove these
def strip_color_codes(input_string):
# Define the regular expression pattern to match ANSI escape sequences
ansi_escape = re.compile(r'\x1B[@-_][0-?]*[ -/]*[@-~]')
# Use the sub method to replace the escape sequences with an empty string
return ansi_escape.sub('', input_string)
def get_proxmark3_location():
# Find a "pm3" command that works from a list of OS-specific possibilities
print("Checking program: pm3")
# Check PROXMARK3_DIR environment variable
if os.environ.get('PROXMARK3_DIR'):
if run_command(os.environ['PROXMARK3_DIR'] + "/bin/pm3", "--help"):
return os.environ['PROXMARK3_DIR']
else:
print("Warning: PROXMARK3_DIR environment variable points to the wrong folder, ignoring")
# Get Homebrew installation
brew_install = run_command(["brew", "--prefix", "proxmark3"])
if brew_install:
print("Found installation via Homebrew!")
return Path(brew_install)
# Get global installation
which_pm3 = run_command(["which", "pm3"])
if which_pm3:
which_pm3 = Path(which_pm3)
pm3_location = which_pm3.parent.parent
print(f"Found global installation ({pm3_location})!")
return pm3_location
# At this point, we've tried all the paths to find it
print("Failed to find working 'pm3' command. You can set the Proxmark3 directory via the 'PROXMARK3_DIR' environment variable.")
exit(-1) # Halt program
def run_command(command):
try:
# On Windows, use the shell=True argument to run the command
result = subprocess.run(command, shell=os.name == 'nt', stdout=subprocess.PIPE, stderr=subprocess.PIPE)
# Check the return code to determine if the command was successful
if result.returncode == 0 or result.returncode == 1:
return result.stdout.decode("utf-8").strip()
return None
except Exception as e:
return None
# Test a list of commands to see which one works
# This lets us provide a list of OS-specific commands, test them
# and figure out which one works on this specific computer
# - Args:
# - commandList: An array of OS-specific commands (sometimes including absolute installation path)
# - arguments: Optional arguments to be appended to the command. Useful for programs that don't exit on their own
# This returns the command (string) of the first working command we encounter
#
def testCommands(directories, command, arguments = ""):
for directory in directories:
if directory is None:
continue
#OPTIONAL: add arguments such as "--help" to help identify programs that don't exit on their own
cmd_list = [directory+"/"+command, arguments]
#Test if this program works
print(" Trying:", directory, end=" ... ")
if run_command(cmd_list):
return Path(directory)
return None #We didn't find any program that worked
if __name__ == "__main__":
main() #Run main program