flipper-zero-tonies/scripts/validate_files.sh

#!/usr/bin/env bash

ERROR_FOUND=0

REQUIRED_PATTERNS=(
  "^Filetype: Flipper NFC device$"
  "^Version: 4$"
  "^Device type: SLIX$"
  "^UID:( [A-F0-9]{2}){8}$"
  "^DSFID: 00$"
  "^AFI: 00$"
  "^IC Reference: 03$"
  "^Lock DSFID: false$"
  "^Lock AFI: false$"
  "^Block Count: 8$"
  "^Block Size: 04$"
  "^Data Content:( [A-F0-9]{2}){32}$"
  "^Security Status: 00 00 00 00 00 00 00 00$"
  "^Capabilities: Default$"
  "^Password Privacy: 7F FD 6E 5B$"
  "^Password Destroy: 0F 0F 0F 0F$"
  "^Password EAS: 00 00 00 00$"
  "^Privacy Mode: false$"
  "^Lock EAS: false$"
)

FORBIDDEN_PATTERNS=(
  # This showed up in Unleashed firmware, see https://github.com/nortakales/flipper-zero-tonies/pull/82
  "Subtype: ([0-9]){2}"
)

FILE_AND_DIR_ALLOWED_CHARACTERS="A-Za-z0-9().,!%&+ -";
# Not the most elegant regex, but ensure files are at least 2 directories deep
FILE_AND_DIR_REGEX="^\.\/(English|German|French)\/[$FILE_AND_DIR_ALLOWED_CHARACTERS/]+\/[$FILE_AND_DIR_ALLOWED_CHARACTERS]+\.nfc$"

# Use process substitution so that ERROR_FOUND is updated in the main shell.
while read -r filename; do
  content=$(cat "$filename")

  if ! echo "$filename" | awk "/$FILE_AND_DIR_REGEX/ { found=1 } END { exit !found }"; then
    echo "$filename"
    echo "    Filename has invalid characters, missing .nfc extension, or is not at least 2 directories deep (e.g. English/Paw Patrol/). Allowed characters are $FILE_AND_DIR_ALLOWED_CHARACTERS"
    ERROR_FOUND=1
  fi

  for pattern in "${REQUIRED_PATTERNS[@]}"; do
    if ! echo "$content" | awk "/$pattern/ { found=1 } END { exit !found }"; then
      echo "$filename"
      echo "    Missing pattern: $pattern"
      ERROR_FOUND=1
    fi
  done

  for pattern in "${FORBIDDEN_PATTERNS[@]}"; do
    if echo "$content" | awk "/$pattern/ { found=1 } END { exit !found }"; then
      echo "$filename"
      echo "    Forbidden pattern found: $pattern"
      ERROR_FOUND=1
    fi
  done

  # It turns out that there is at least one valid Tonies with `00 00 00 00` in the data
  # so now we can just check for one more `00` block than that one and hope it still catches
  # partially read Tonies
  if echo "$content" | awk '/Data Content:( [A-F0-9]{2})* 00 00 00 00 00( [A-F0-9]{2})*/ { found=1 } END { exit !found }'; then
    echo "$filename"
    echo "    Full data not read"
    ERROR_FOUND=1
  fi

  # Not necessarily going to cause issues, but keep line endings the same for consistency
  if echo "$content" | awk '/\r/ { found=1 } END { exit !found }'; then
    echo "$filename"
    echo "    Has carriage return characters"
    ERROR_FOUND=1
  fi

done < <(find . -type f \
  -not -path './scripts/*' \
  -not -path './.github/*' \
  -not -path './.git/*' \
  -not -path './.gitignore' \
  -not -path './README.md' \
  -not -path './*/README.md')

exit $ERROR_FOUND