إدارة الأسرار

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

الأهداف ونموذج وقت التشغيل

• يتم الحل مبكرًا أثناء التفعيل، وليس كسولًا في مسارات الطلبات.
• يفشل بدء التشغيل بسرعة عندما يتعذر حل SecretRef فعّال فعليًا.
• تستخدم إعادة التحميل تبديلًا ذريًا: نجاح كامل، أو الاحتفاظ بآخر لقطة سليمة معروفة.
• تؤدي مخالفات سياسة SecretRef (مثل ملفات تعريف المصادقة بوضع OAuth مع إدخال SecretRef) إلى فشل التفعيل قبل تبديل وقت التشغيل.
• تقرأ طلبات وقت التشغيل من اللقطة النشطة داخل الذاكرة فقط.
• بعد أول تفعيل/تحميل ناجح للإعدادات، تستمر مسارات كود وقت التشغيل في قراءة تلك اللقطة النشطة داخل الذاكرة إلى أن تستبدلها إعادة تحميل ناجحة.
• تقرأ مسارات التسليم الصادر أيضًا من تلك اللقطة النشطة (مثل تسليم الردود/السلاسل في Discord وإرسال إجراءات Telegram)؛ ولا تعيد حل مراجع SecretRefs عند كل إرسال.

​

تصفية السطح النشط

• الأسطح الممكّنة: تمنع المراجع غير المحلولة بدء التشغيل/إعادة التحميل.
• الأسطح غير النشطة: لا تمنع المراجع غير المحلولة بدء التشغيل/إعادة التحميل.
• تصدر المراجع غير النشطة تشخيصات غير قاتلة بالرمز SECRETS_REF_IGNORED_INACTIVE_SURFACE.

​

تشخيصات سطح مصادقة Gateway

• active: يكون SecretRef جزءًا من سطح المصادقة الفعال ويجب حله.
• inactive: يُتجاهل SecretRef في وقت التشغيل هذا لأن سطح مصادقة آخر يفوز، أو لأن المصادقة البعيدة معطلة/غير نشطة.

​

فحص مسبق لمراجع التهيئة

• مراجع البيئة: تتحقق من اسم متغير البيئة وتؤكد أن قيمة غير فارغة مرئية أثناء الإعداد.
• مراجع المزود (file أو exec): تتحقق من اختيار المزود، وتحل id، وتتحقق من نوع القيمة المحلولة.
• مسار إعادة استخدام البدء السريع: عندما يكون gateway.auth.token بالفعل SecretRef، تحله التهيئة قبل تمهيد الفحص/لوحة المعلومات (لمراجع env وfile وexec) باستخدام بوابة الفشل السريع نفسها.

​

عقد SecretRef

{ source: "env" | "file" | "exec", provider: "default", id: "..." }

{ source: "env", provider: "default", id: "OPENAI_API_KEY" }

{ source: "file", provider: "filemain", id: "/providers/openai/apiKey" }

{ source: "exec", provider: "vault", id: "providers/openai/apiKey" }

​

إعداد المزود

{
  secrets: {
    providers: {
      default: { source: "env" },
      filemain: {
        source: "file",
        path: "~/.openclaw/secrets.json",
        mode: "json", // or "singleValue"
      },
      vault: {
        source: "exec",
        command: "/usr/local/bin/openclaw-vault-resolver",
        args: ["--profile", "prod"],
        passEnv: ["PATH", "VAULT_ADDR"],
        jsonOnly: true,
      },
    },
    defaults: {
      env: "default",
      file: "filemain",
      exec: "vault",
    },
    resolution: {
      maxProviderConcurrency: 4,
      maxRefsPerProvider: 512,
      maxBatchBytes: 262144,
    },
  },
}

{ "protocolVersion": 1, "provider": "vault", "ids": ["providers/openai/apiKey"] }

{ "protocolVersion": 1, "values": { "providers/openai/apiKey": "<openai-api-key>" } } // pragma: allowlist secret

{
  "protocolVersion": 1,
  "values": {},
  "errors": { "providers/openai/apiKey": { "message": "not found" } }
}

​

أمثلة تكامل exec

{
  secrets: {
    providers: {
      onepassword_openai: {
        source: "exec",
        command: "/opt/homebrew/bin/op",
        allowSymlinkCommand: true, // required for Homebrew symlinked binaries
        trustedDirs: ["/opt/homebrew"],
        args: ["read", "op://Personal/OpenClaw QA API Key/password"],
        passEnv: ["HOME"],
        jsonOnly: false,
      },
    },
  },
  models: {
    providers: {
      openai: {
        baseUrl: "https://api.openai.com/v1",
        models: [{ id: "gpt-5", name: "gpt-5" }],
        apiKey: { source: "exec", provider: "onepassword_openai", id: "value" },
      },
    },
  },
}

{
  secrets: {
    providers: {
      vault_openai: {
        source: "exec",
        command: "/opt/homebrew/bin/vault",
        allowSymlinkCommand: true, // required for Homebrew symlinked binaries
        trustedDirs: ["/opt/homebrew"],
        args: ["kv", "get", "-field=OPENAI_API_KEY", "secret/openclaw"],
        passEnv: ["VAULT_ADDR", "VAULT_TOKEN"],
        jsonOnly: false,
      },
    },
  },
  models: {
    providers: {
      openai: {
        baseUrl: "https://api.openai.com/v1",
        models: [{ id: "gpt-5", name: "gpt-5" }],
        apiKey: { source: "exec", provider: "vault_openai", id: "value" },
      },
    },
  },
}

{
  secrets: {
    providers: {
      sops_openai: {
        source: "exec",
        command: "/opt/homebrew/bin/sops",
        allowSymlinkCommand: true, // required for Homebrew symlinked binaries
        trustedDirs: ["/opt/homebrew"],
        args: ["-d", "--extract", '["providers"]["openai"]["apiKey"]', "/path/to/secrets.enc.json"],
        passEnv: ["SOPS_AGE_KEY_FILE"],
        jsonOnly: false,
      },
    },
  },
  models: {
    providers: {
      openai: {
        baseUrl: "https://api.openai.com/v1",
        models: [{ id: "gpt-5", name: "gpt-5" }],
        apiKey: { source: "exec", provider: "sops_openai", id: "value" },
      },
    },
  },
}

​

متغيرات بيئة خادم MCP

{
  plugins: {
    entries: {
      acpx: {
        enabled: true,
        config: {
          mcpServers: {
            github: {
              command: "npx",
              args: ["-y", "@modelcontextprotocol/server-github"],
              env: {
                GITHUB_PERSONAL_ACCESS_TOKEN: {
                  source: "env",
                  provider: "default",
                  id: "MCP_GITHUB_PAT",
                },
              },
            },
          },
        },
      },
    },
  },
}

​

مادة مصادقة SSH في صندوق الرمل

{
  agents: {
    defaults: {
      sandbox: {
        mode: "all",
        backend: "ssh",
        ssh: {
          target: "user@gateway-host:22",
          identityData: { source: "env", provider: "default", id: "SSH_IDENTITY" },
          certificateData: { source: "env", provider: "default", id: "SSH_CERTIFICATE" },
          knownHostsData: { source: "env", provider: "default", id: "SSH_KNOWN_HOSTS" },
        },
      },
    },
  },
}

• يحل OpenClaw هذه المراجع أثناء تفعيل وضع الحماية، وليس بشكل كسول أثناء كل استدعاء SSH.
• تُكتب القيم المحلولة إلى ملفات مؤقتة بأذونات مقيّدة وتُستخدم في إعدادات SSH المُولَّدة.
• إذا لم تكن واجهة وضع الحماية الفعالة هي ssh، فتبقى هذه المراجع غير نشطة ولا تمنع بدء التشغيل.

​

سطح بيانات الاعتماد المدعوم

• سطح بيانات اعتماد SecretRef

​

السلوك المطلوب والأسبقية

• حقل بدون مرجع: دون تغيير.
• حقل مع مرجع: مطلوب على الأسطح النشطة أثناء التفعيل.
• إذا وُجد كل من النص الصريح والمرجع، تكون الأولوية للمرجع في مسارات الأسبقية المدعومة.
• علامة التنقيح __OPENCLAW_REDACTED__ محجوزة لتنقيح/استعادة الإعدادات داخليًا، وتُرفض كبيانات إعدادات مُرسلة حرفية.

• SECRETS_REF_OVERRIDES_PLAINTEXT (تحذير وقت التشغيل)
• REF_SHADOWED (نتيجة تدقيق عندما تكون لبيانات اعتماد auth-profiles.json أسبقية على مراجع openclaw.json)

• تكون لـ serviceAccountRef أسبقية على serviceAccount بالنص الصريح.
• تُتجاهل قيمة النص الصريح عندما يكون مرجع شقيق معيّنًا.

​

محفزات التفعيل

• بدء التشغيل (الفحص المسبق بالإضافة إلى التفعيل النهائي)
• مسار التطبيق الساخن لإعادة تحميل الإعدادات
• مسار التحقق من إعادة التشغيل لإعادة تحميل الإعدادات
• إعادة التحميل اليدوية عبر secrets.reload
• الفحص المسبق لكتابة إعدادات Gateway عبر RPC (config.set / config.apply / config.patch) لقابلية حل SecretRef على السطح النشط داخل حمولة الإعدادات المُرسلة قبل حفظ التعديلات

• النجاح يستبدل اللقطة ذريًا.
• فشل بدء التشغيل يوقف بدء تشغيل Gateway.
• فشل إعادة التحميل في وقت التشغيل يُبقي آخر لقطة سليمة معروفة.
• فشل الفحص المسبق لـ RPC الكتابة يرفض الإعدادات المُرسلة ويُبقي كلًا من إعدادات القرص ولقطة وقت التشغيل النشطة دون تغيير.
• لا يؤدي تقديم رمز قناة صريح لكل استدعاء إلى استدعاء مساعد/أداة صادرة إلى تفعيل SecretRef؛ تظل نقاط التفعيل هي بدء التشغيل وإعادة التحميل وsecrets.reload الصريح.

​

إشارات التدهور والاسترداد

• SECRETS_RELOADER_DEGRADED
• SECRETS_RELOADER_RECOVERED

• متدهور: وقت التشغيل يُبقي آخر لقطة سليمة معروفة.
• مسترد: يُرسل مرة واحدة بعد التفعيل الناجح التالي.
• حالات الفشل المتكررة أثناء التدهور بالفعل تُسجل تحذيرات لكنها لا تُغرق الأحداث.
• الفشل السريع عند بدء التشغيل لا يرسل أحداث تدهور لأن وقت التشغيل لم يصبح نشطًا قط.

​

حل مسار الأوامر

• يتولى openclaw secrets reload تحديث اللقطة بعد تدوير سر الواجهة الخلفية.
• طريقة Gateway RPC التي تستخدمها مسارات الأوامر هذه: secrets.resolve.

​

سير عمل التدقيق والإعداد

openclaw secrets audit --check

openclaw secrets configure

openclaw secrets audit --check

openclaw secrets apply --from /tmp/openclaw-secrets-plan.json
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --allow-exec
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --dry-run
openclaw secrets apply --from /tmp/openclaw-secrets-plan.json --dry-run --allow-exec

​

سياسة السلامة أحادية الاتجاه

• يجب أن ينجح الفحص المسبق قبل وضع الكتابة
• يتم التحقق من تفعيل وقت التشغيل قبل الالتزام
• يحدّث التطبيق الملفات باستخدام استبدال ملفات ذري واستعادة بأفضل جهد عند الفشل

​

ملاحظات توافق المصادقة القديمة

• مصدر بيانات اعتماد وقت التشغيل هو اللقطة المحلولة في الذاكرة.
• تُنظَّف إدخالات api_key الثابتة القديمة عند اكتشافها.
• يبقى سلوك التوافق المتعلق بـ OAuth منفصلًا.

​

ملاحظة واجهة الويب

​

ذو صلة

• المصادقة — إعداد المصادقة
• CLI: الأسرار — أوامر CLI
• متغيرات البيئة — أسبقية البيئة
• سطح بيانات اعتماد SecretRef — سطح بيانات الاعتماد
• عقد خطة تطبيق الأسرار — تفاصيل عقد الخطة
• الأمان — وضع الأمان