BreakEscape Rails Engine

एक mountable Rails Engine के रूप में साइबर सुरक्षा प्रशिक्षण एस्केप रूम गेम।

विशेषताएँ

• 24+ साइबर सुरक्षा एस्केप रूम परिदृश्य
• 2-टेबल स्कीमा के साथ सर्वर-साइड प्रगति ट्रैकिंग
• ERB के माध्यम से प्रति गेम इंस्टेंस रैंडमाइज़्ड पासवर्ड
• NPC संवाद के लिए JIT Ink स्क्रिप्ट संकलन
• बहुरूपी प्लेयर समर्थन (User/DemoUser)
• Pundit प्राधिकरण
• गेम स्थिति प्रबंधन के लिए RESTful API
• सत्र-आधारित स्थिति दृढ़ता

स्थापना

अपने Gemfile में:

gem 'break_escape', path: 'path/to/break_escape'

फिर:

bundle install
rails break_escape:install:migrations
rails db:migrate
rails db:seed  # वैकल्पिक: परिदृश्यों से मिशन बनाता है

होस्ट ऐप में माउंट करना

अपने config/routes.rb में:

mount BreakEscape::Engine => "/break_escape"

उपयोग

स्टैंडअलोन मोड (डेवलपमेंट)

export BREAK_ESCAPE_STANDALONE=true
rails server
# Visit http://localhost:3000/break_escape/

माउंटेड मोड (प्रोडक्शन)

Hacktivity या किसी अन्य Rails ऐप में माउंट करें। इंजन Devise के माध्यम से होस्ट ऐप के current_user का उपयोग करेगा।

कॉन्फ़िगरेशन

# config/initializers/break_escape.rb
BreakEscape.configure do |config|
  config.standalone_mode = false  # डेवलपमेंट के लिए true
  config.demo_user_handle = 'demo_player'
end

डेटाबेस स्कीमा

• break_escape_missions - परिदृश्य मेटाडेटा (नाम, display_name, प्रकाशित, कठिनाई)
• break_escape_games - प्लेयर स्थिति + परिदृश्य स्नैपशॉट (JSONB)
• break_escape_demo_users - केवल स्टैंडअलोन मोड (वैकल्पिक)

API एंडपॉइंट्स

• GET /games/:id/scenario - परिदृश्य JSON (ERB-जनरेटेड)
• GET /games/:id/ink?npc=X - NPC स्क्रिप्ट (.ink से JIT संकलित)
• GET /games/:id/bootstrap - प्रारंभिक गेम डेटा
• PUT /games/:id/sync_state - प्लेयर स्थिति सिंक करें
• POST /games/:id/unlock - अनलॉक प्रयास मान्य करें
• POST /games/:id/inventory - इन्वेंटरी अपडेट करें

आर्किटेक्चर

ERB परिदृश्य निर्माण

परिदृश्य .json.erb टेम्पलेट के रूप में संग्रहीत होते हैं और रैंडमाइज़्ड मानों के साथ ऑन-डिमांड रेंडर किए जाते हैं:

• <%= random_password %> - प्रति गेम अद्वितीय पासवर्ड उत्पन्न करता है
• <%= random_pin %> - अद्वितीय 4-अंकीय PIN उत्पन्न करता है
• <%= random_code %> - अद्वितीय हेक्स कोड उत्पन्न करता है

JIT Ink संकलन

NPC संवाद स्क्रिप्ट पहले अनुरोध पर संकलित होती हैं (~300ms):

1. जाँच करें कि .json मौजूद है और .ink से नया है
2. यदि आवश्यक हो, संकलित करने के लिए inklecate चलाएँ
3. बाद के अनुरोधों के लिए संकलित JSON को कैश करें

स्थिति प्रबंधन

प्लेयर स्थिति JSONB कॉलम में संग्रहीत:

• वर्तमान कक्ष और अनलॉक किए गए कक्ष
• इन्वेंटरी और एकत्रित आइटम
• NPC मुठभेड़
• वैश्विक चर (क्लाइंट के साथ सिंक)
• स्वास्थ्य और मिनीगेम स्थिति

परीक्षण

CI

परीक्षण स्वचालित रूप से GitHub Actions पर चलते हैं। कमिटेड Gemfile.lock उपयोग किए गए सटीक gem संस्करणों को पिन करता है।

स्थानीय रूप से नेटवर्क एक्सेस के साथ

bundle install
bundle exec rails db:create db:migrate RAILS_ENV=test
bundle exec rails test

स्थानीय रूप से नेटवर्क एक्सेस के बिना

इंजन के साथ एक bin/setup स्क्रिप्ट आती है जो एक सिबलिंग Hacktivity चेकआउट से बंडल को बूटस्ट्रैप करती है (जिसमें पहले से सभी आवश्यक gem वेंडर किए गए हैं):

# BreakEscape रूट से — Hacktivity ../Hacktivity पर होनी चाहिए
bin/setup
bundle exec rails test

# यदि Hacktivity कहीं और है, तो HACKTIVITY_DIR सेट करें:
HACKTIVITY_DIR=/path/to/Hacktivity bin/setup

bin/setup हल किए गए .gem फ़ाइलों को vendor/cache/ में कॉपी करता है और bundle install --local चलाता है। vendor/cache/ और vendor/bundle/ निर्देशिकाएँ gitignored हैं; केवल Gemfile.lock कमिट किया गया है।

दस्तावेज़ीकरण

एकीकरण गाइड के लिए HACKTIVITY_INTEGRATION.md देखें।

आभार

परियोजना में योगदान देने वाले सभी लोगों का बहुत-बहुत धन्यवाद। कृपया GitHub इतिहास देखें।

• इस परियोजना को CyBOK 1.1 अनुदान (2023-2024) के आसपास एक साइबर सुरक्षा ज्ञान निकाय (CyBOK) संसाधनों द्वारा समर्थित किया गया है।
• इस परियोजना को CyBOK 1.1 अनुदान (2024-2025) के आसपास एक साइबर सुरक्षा ज्ञान निकाय (CyBOK) संसाधनों द्वारा समर्थित किया गया है।
• इस परियोजना को सुरक्षा-सूचित सुरक्षा अनुदान (2025-2026) के आसपास एक साइबर सुरक्षा ज्ञान निकाय (CyBOK) संसाधनों द्वारा समर्थित किया गया है।