AuthKeySync

दूरस्थ URLs से SSH सार्वजनिक कुंजियों को स्वचालित रूप से आपके सर्वरों पर सिंक्रनाइज़ करें

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

समस्या

कई सर्वरों पर SSH एक्सेस प्रबंधित करना कष्टदायक है:

• टीम के सदस्य शामिल होते हैं या छोड़ देते हैं, और आपको हर सर्वर पर authorized_keys अपडेट करना पड़ता है
• डेवलपर अपनी SSH कुंजियाँ बदलते हैं, और अब आपके पास अपडेट करने के लिए 20 सर्वर हैं
• आप इन्फ्रास्ट्रक्चर ऐज़ कोड का उपयोग कर रहे हैं, लेकिन SSH कुंजी प्रबंधन अभी भी मैनुअल है
• कुंजी प्रबंधन के लिए घर पर बनाई गई bash स्क्रिप्ट अक्सर खराब लिखी जाती हैं, असुरक्षित होती हैं, या उनमें सूक्ष्म बग होते हैं जो आपको आपके सर्वरों से लॉक आउट कर सकते हैं
• आप GitHub/GitLab कुंजियों का उपयोग करना चाहते हैं, लेकिन उन्हें हर जगह कॉपी करना थकाऊ है

समाधान

AuthKeySync एक हल्का CLI है जो URLs (GitHub, GitLab, आपका अपना API) से SSH सार्वजनिक कुंजियाँ प्राप्त करता है और उन्हें आपके सर्वरों पर सिंक करता है। यह सुरक्षित, विश्वसनीय और स्वचालन के लिए डिज़ाइन किया गया है।

# /etc/authkeysync/config.yaml
users:
  - username: "deploy"
    sources:
      - url: "https://github.com/your-username.keys"
      - url: "https://github.com/another-username.keys"

authkeysync चलाएँ (मैन्युअल रूप से या cron के माध्यम से), और आपका authorized_keys अपडेट हो जाता है। बस इतना ही।

मुख्य विशेषताएँ

• एकल बाइनरी: कोई निर्भरता नहीं, बस डाउनलोड करें और चलाएँ
• डिफ़ॉल्ट रूप से सुरक्षित: मौजूदा स्थानीय कुंजियों को संरक्षित करता है, बैकअप बनाता है, एटॉमिक राइट्स का उपयोग करता है
• फेल-सेफ: यदि कोई स्रोत विफल होता है, तो लॉकआउट रोकने के लिए अपडेट रद्द कर दिया जाता है
• लचीले स्रोत: GitHub, GitLab, या कोई भी URL जो प्लेन टेक्स्ट SSH कुंजियाँ लौटाता है
• API समर्थन: प्रमाणित APIs के लिए कस्टम हेडर्स के साथ POST अनुरोध
• IaC-तैयार: स्टेटलेस, आइडेम्पोटेंट, Ansible/Terraform/cloud-init के लिए उपयुक्त
• क्रॉस-प्लेटफ़ॉर्म: Linux और macOS (AMD64 और ARM64) पर काम करता है

त्वरित आरंभ

1. डाउनलोड करें

releases पेज से नवीनतम बाइनरी प्राप्त करें:

# Linux AMD64
curl -Lo authkeysync https://github.com/eduardolat/authkeysync/releases/latest/download/authkeysync-linux-amd64
chmod +x authkeysync
sudo mv authkeysync /usr/local/bin/

2. कॉन्फ़िगर करें

/etc/authkeysync/config.yaml पर एक कॉन्फ़िग फ़ाइल बनाएँ:

policy:
  backup_enabled: true # Create backups before changes (default: true)
  backup_retention_count: 10 # Number of backups to keep (default: 10)
  preserve_local_keys: true # Keep keys not in remote sources (default: true)

users:
  - username: "root"
    sources:
      - url: "https://github.com/your-username.keys"

3. चलाएँ

# पहले dry-run के साथ परीक्षण करें
sudo authkeysync --dry-run

# परिवर्तन लागू करें
sudo authkeysync

4. स्वचालित करें

समय-समय पर चलाने के लिए cron जॉब या systemd टाइमर सेट करें:

# Every 5 minutes (use --quiet to reduce log noise in cron)
echo "*/5 * * * * root /usr/local/bin/authkeysync --quiet" | sudo tee /etc/cron.d/authkeysync

कॉन्फ़िगरेशन विकल्प

पॉलिसी (सभी वैकल्पिक)

Option	Type	Default	Description
backup_enabled	bool	true	authorized_keys को संशोधित करने से पहले बैकअप बनाएँ
backup_retention_count	int	10	प्रति उपयोगकर्ता रखने के लिए बैकअप फ़ाइलों की संख्या
preserve_local_keys	bool	true	मौजूदा कुंजियाँ रखें जो दूरस्थ स्रोतों में नहीं हैं

उपयोगकर्ता (आवश्यक)

Option	Type	Required	Description
username	string	Yes	सिस्टम उपयोगकर्ता नाम (जैसे, root, deploy)
sources	list	Yes	कुंजी स्रोतों की सूची

स्रोत

Option	Type	Default	Description
url	string	(required)	URL जो प्लेन टेक्स्ट SSH कुंजियाँ लौटाता है
method	string	GET	HTTP विधि: GET या POST
headers	map	{}	कस्टम HTTP हेडर्स (जैसे, प्रमाणीकरण के लिए)
body	string	""	POST अनुरोधों के लिए अनुरोध बॉडी
timeout_seconds	int	10	सेकंड में अनुरोध टाइमआउट

सभी विकल्पों के साथ उदाहरण

policy:
  backup_enabled: true
  backup_retention_count: 10
  preserve_local_keys: true

users:
  - username: "deploy"
    sources:
      # Simple GitHub keys
      - url: "https://github.com/your-username.keys"

      # Private API with authentication
      - url: "https://keys.yourcompany.com/api/keys"
        method: "POST"
        headers:
          Authorization: "Bearer your-secret-token"
          Content-Type: "application/json"
        body: '{"environment": "production"}'
        timeout_seconds: 5

CLI विकल्प

Option	Description
--config <path>	कॉन्फ़िग फ़ाइल का पथ (डिफ़ॉल्ट: /etc/authkeysync/config.yaml)
--dry-run	किसी भी फ़ाइल को संशोधित किए बिना सिंक का अनुकरण करें
--debug	डीबग लॉगिंग सक्षम करें (सबसे अधिक विस्तृत)
--quiet	केवल चेतावनियाँ और त्रुटियाँ दिखाएँ (cron के लिए अनुशंसित)
--silent	केवल त्रुटियाँ दिखाएँ (सबसे शांत)
--version	संस्करण जानकारी दिखाएँ और बाहर निकलें
--help	सहायता संदेश दिखाएँ

एग्ज़िट कोड

Code	Meaning
0	सफलता: सभी उपयोगकर्ता संसाधित या छोड़े गए
1	विफलता: कम से कम एक उपयोगकर्ता सिंक करने में विफल रहा

यह कैसे काम करता है

1. फ़ेच: कॉन्फ़िगर किए गए URLs से SSH कुंजियाँ डाउनलोड करता है
2. पार्स: सभी स्रोतों में कुंजियों को मान्य और डीडुप्लिकेट करता है
3. मर्ज: वैकल्पिक रूप से उन कुंजियों को संरक्षित करता है जो केवल स्थानीय रूप से मौजूद हैं
4. राइट: उचित अनुमतियों के साथ authorized_keys को एटॉमिक रूप से अपडेट करता है
5. बैकअप: किसी भी परिवर्तन से पहले टाइमस्टैम्प्ड बैकअप बनाता है