Z. Cliffe Schreuders bff4a6a31a docs(rfid): Add corrected scenario patterns and multi-protocol test
Created proper RFID scenario examples following project patterns
(hub structure, #exit_conversation tags, card_id format).

## Issues Found in Existing Files:

### test-rfid.json (Not modified - reference only):
 Uses legacy format (rfid_hex, rfid_facility, key_id)
 All EM4100 - no protocol variety
 Door requires not array format
 No protocol testing variety

### rfid-security-guard.ink (Not modified - reference only):
 Uses -> END instead of #exit_conversation
 Doesn't return to hub after exits
 No proper hub pattern
 Clone tag uses hex instead of card_id

## New Corrected Files:

### 1. scenarios/RFID_SCENARIO_PATTERNS.md (NEW)
Comprehensive guide showing:
-  Correct hub pattern with #exit_conversation
-  Proper card_id JSON format
-  Protocol-specific examples
-  Common mistakes to avoid
- Complete working examples

### 2. scenarios/test-rfid-multiprotocol.json (NEW)
Test scenario with ALL 4 protocols:
- EM4100 (instant clone)
- MIFARE_Classic_Weak_Defaults (dictionary)
- MIFARE_Classic_Custom_Keys (Darkside attack)
- MIFARE_DESFire (UID only)

Features:
- 4 NPCs, each with different protocol
- 4 test rooms demonstrating each security level
- Proper card_id format throughout
- Array-based door requirements
- acceptsUIDOnly flag demonstrated

### 3. scenarios/ink/rfid-security-guard-fixed.ink (NEW)
Fixed version showing:
- Proper hub structure
- #exit_conversation on choice lines
- All paths return to hub
- Card protocol variables declared
- Uses {card_card_id} in clone tags

### 4. scenarios/ink/rfid-guard-low.ink (NEW)
Simple EM4100 example:
- Instant clone pattern
- Proper exit handling
- Minimal complexity for learning

### 5. scenarios/ink/rfid-guard-custom.ink (NEW)
MIFARE Custom Keys example:
- Shows attack requirement
- Player feedback for encrypted cards
- Proper state management

## Key Patterns Documented:

### Correct Ink Pattern:
```ink
+ [Leave] #exit_conversation
  # speaker:npc
  Goodbye!
  -> hub  // Return to hub, NOT END
```

### Correct JSON Pattern:
```json
{
  "type": "keycard",
  "card_id": "employee_badge",
  "rfid_protocol": "EM4100",
  "name": "Employee Badge"
}
```

### Door Configuration:
```json
{
  "lockType": "rfid",
  "requires": ["card1", "card2"],
  "acceptsUIDOnly": false
}
```

## Testing Checklist Added:
- [ ] Uses #exit_conversation tag
- [ ] All knots return to hub
- [ ] Card variables declared
- [ ] Uses card_id format
- [ ] Door requires is array
- [ ] No manual hex entry

## Files Added:
- scenarios/RFID_SCENARIO_PATTERNS.md
- scenarios/test-rfid-multiprotocol.json
- scenarios/ink/rfid-security-guard-fixed.ink
- scenarios/ink/rfid-guard-low.ink
- scenarios/ink/rfid-guard-custom.ink

These serve as reference implementations for scenario designers.
Original files (test-rfid.json, rfid-security-guard.ink) left
unmodified as they may be in use.
2025-11-15 23:48:15 +00:00
2025-05-16 10:42:42 +01:00
2025-11-14 19:47:54 +00:00

Break Escape: Cyber-Physical Security Learning Framework

Break Escape is an escape room-inspired games-based learning framework that simulates cyber-physical security challenges. Break Escape creates immersive experiences where learners engage with both physical and digital security mechanisms within narrative-driven scenarios explicitly mapped to the Cyber Security Body of Knowledge (CyBOK). The game is inspired by retro top-down games, dungeon crawlers, escape rooms, and cyber security challenges.

Note: Break Escape is currently in development. Please report any issues or feedback via GitHub.

Live Demo -- Early Beta Playtesting

You can try Break Escape directly from your browser by visiting: https://hacktivity.co.uk/break-escape-beta/scenario_select.html

Youll choose from scenarios, each offering its own set of puzzles and challenges, ranging from cryptography to physical security.

After playing, please fill out a short survey. Your insights will be instrumental in improving the game and understanding the benefits. https://forms.gle/kiVgNUBSHu2KjcJt8

Features

  • Immersive Learning Environment: Top-down 2D game environment accessible through web browsers
  • Cyber-Physical Security Challenges: Simulations of various security mechanisms:
    • Key-based locks (with physical keys and lockpicking mini-game)
    • PIN code systems
    • Password-protected interfaces
    • Biometric authentication (fingerprints that can be dusted and spoofed)
    • Bluetooth proximity detection
  • CyberChef Integration: Embedded cryptographic tools for encryption and data analysis
  • CyBOK Mapping: Each scenario is explicitly mapped to relevant Cyber Security Body of Knowledge areas
  • Multiple Scenarios: Various pre-built scenarios focusing on different security aspects:
    • "CEO Exfil Investigation" - Corporate espionage and data exfiltration
    • "Captain Meow's Disappearance" - Encoding and cryptography
    • "Encoding and Encryption Lab" - Basic cryptographic principles
    • "Asymmetric Encryption with RSA" - Public key cryptography
    • "Symmetric Encryption with AES" - Block ciphers and encryption modes
    • "Biometric Security Breach" - Fingerprint authentication

Technical Implementation

Break Escape is implemented using:

  • Phaser.js: Core game engine
  • JavaScript/HTML5: Front-end implementation
  • JSON: Scenario specification format

Installation

Break Escape is a web-based application and requires a web server to run. You can:

Option 1: Use the hosted version

Visit the live demo at https://hacktivity.co.uk/break-escape-beta/scenario_select.html

Option 2: Use Python's built-in HTTP server

  1. Clone the repository:

    git clone https://github.com/yourusername/break-escape.git
    cd break-escape
    
  2. Start a local web server:

    python3 -m http.server
    
  3. Open your web browser and navigate to:

    http://localhost:8000
    

Option 3: Deploy to a web server

  1. Upload all files to your web server directory
  2. Access through your domain

Usage

Start Break Escape:

  • Open Break Escape in your web browser
  • Choose a scenario based on your learning objectives or difficulty preference

Play the game:

  • When you start a scenario, you will be given a brief of the scenario.
  • You can navigate through the virtual environment using mouse clicks.
  • Interact with objects by clicking on them.
  • Collect items into your inventory to use later.
  • Solve puzzles and progress through rooms to complete the scenario.

After playing, please fill out a short survey. https://forms.gle/kiVgNUBSHu2KjcJt8

Game Controls

  • Mouse Click: Move character, interact with objects
  • Inventory: Click collected items to use them
  • Notes Panel: Access important information you've discovered
  • Bluetooth Scanner: Detect nearby Bluetooth devices (when available)
  • Biometrics Panel: View collected fingerprint samples (when available)

Scenario Design

Break Escape features a flexible JSON-based scenario specification format that enables educators to create custom scenarios without programming knowledge. The scenario structure includes:

  • Rooms with connections, objects, and optional locks
  • Objects with properties like takeable, readable, observations, and lock requirements
  • Special object types for fingerprint collection, cryptographic analysis, and more

For detailed information on creating your own scenarios, refer to README_scenario_design.md.

License

Break Escape is dual licensed:

  • AGPL (GNU Affero General Public License)
  • Open Government Licence

Acknowledgements

Break Escape was developed as an educational tool to address the "reflection gap" identified in many existing cyber security games by requiring players to actively apply security knowledge rather than merely encountering security terminology during gameplay.

The project integrates CyberChef, an open-source web application for encryption and data analysis, allowing learners to interact with genuine cryptographic tools within the game environment.

Special thanks to the Cyber Security Body of Knowledge (CyBOK) for providing the knowledge framework that Break Escape scenarios are mapped to.

This project is supported by a Cyber Security Body of Knowledge (CyBOK) resources around CyBOK 1.1 grant (2024-2025).


For questions, contributions, or more information, please open an issue on the project repository.

Description
No description provided
Readme 72 MiB
Languages
JavaScript 86.5%
Ink 7%
HTML 2.9%
CSS 2.5%
Ruby 0.9%
Other 0.2%