بروتوكول Gateway

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.

​

النقل

• WebSocket، إطارات نصية بحمولات JSON.
• يجب أن يكون الإطار الأول طلب connect.
• تُحد إطارات ما قبل الاتصال بـ 64 KiB. بعد مصافحة ناجحة، ينبغي للعملاء اتباع حدود hello-ok.policy.maxPayload و hello-ok.policy.maxBufferedBytes. عند تمكين التشخيصات، تصدر الإطارات الواردة الزائدة الحجم والمخازن الصادرة البطيئة أحداث payload.large قبل أن يغلق Gateway الإطار المتأثر أو يسقطه. تحتفظ هذه الأحداث بالأحجام والحدود والأسطح ورموز الأسباب الآمنة. ولا تحتفظ بنص الرسالة أو محتويات المرفقات أو نص الإطار الخام أو الرموز المميزة أو ملفات تعريف الارتباط أو القيم السرية.

​

المصافحة (connect)

{
  "type": "event",
  "event": "connect.challenge",
  "payload": { "nonce": "…", "ts": 1737264000000 }
}

{
  "type": "req",
  "id": "…",
  "method": "connect",
  "params": {
    "minProtocol": 3,
    "maxProtocol": 4,
    "client": {
      "id": "cli",
      "version": "1.2.3",
      "platform": "macos",
      "mode": "operator"
    },
    "role": "operator",
    "scopes": ["operator.read", "operator.write"],
    "caps": [],
    "commands": [],
    "permissions": {},
    "auth": { "token": "…" },
    "locale": "en-US",
    "userAgent": "openclaw-cli/1.2.3",
    "device": {
      "id": "device_fingerprint",
      "publicKey": "…",
      "signature": "…",
      "signedAt": 1737264000000,
      "nonce": "…"
    }
  }
}

{
  "type": "res",
  "id": "…",
  "ok": true,
  "payload": {
    "type": "hello-ok",
    "protocol": 4,
    "server": { "version": "…", "connId": "…" },
    "features": { "methods": ["…"], "events": ["…"] },
    "snapshot": { "…": "…" },
    "auth": {
      "role": "operator",
      "scopes": ["operator.read", "operator.write"]
    },
    "policy": {
      "maxPayload": 26214400,
      "maxBufferedBytes": 52428800,
      "tickIntervalMs": 15000
    }
  }
}

{
  "auth": {
    "role": "operator",
    "scopes": ["operator.read", "operator.write"]
  }
}

{
  "auth": {
    "deviceToken": "…",
    "role": "operator",
    "scopes": ["operator.read", "operator.write"]
  }
}

{
  "auth": {
    "deviceToken": "…",
    "role": "node",
    "scopes": [],
    "deviceTokens": [
      {
        "deviceToken": "…",
        "role": "operator",
        "scopes": ["operator.approvals", "operator.read", "operator.talk.secrets", "operator.write"]
      }
    ]
  }
}

​

مثال العقدة

{
  "type": "req",
  "id": "…",
  "method": "connect",
  "params": {
    "minProtocol": 3,
    "maxProtocol": 4,
    "client": {
      "id": "ios-node",
      "version": "1.2.3",
      "platform": "ios",
      "mode": "node"
    },
    "role": "node",
    "scopes": [],
    "caps": ["camera", "canvas", "screen", "location", "voice"],
    "commands": ["camera.snap", "canvas.navigate", "screen.record", "location.get"],
    "permissions": { "camera.capture": true, "screen.record": false },
    "auth": { "token": "…" },
    "locale": "en-US",
    "userAgent": "openclaw-ios/1.2.3",
    "device": {
      "id": "device_fingerprint",
      "publicKey": "…",
      "signature": "…",
      "signedAt": 1737264000000,
      "nonce": "…"
    }
  }
}

​

التأطير

• الطلب: {type:"req", id, method, params}
• الاستجابة: {type:"res", id, ok, payload|error}
• الحدث: {type:"event", event, payload, seq?, stateVersion?}

​

الأدوار + النطاقات

​

الأدوار

• operator = عميل مستوى التحكم (CLI/واجهة المستخدم/الأتمتة).
• node = مضيف الإمكانات (camera/screen/canvas/system.run).

​

النطاقات (المشغّل)

• operator.read
• operator.write
• operator.admin
• operator.approvals
• operator.pairing
• operator.talk.secrets

• الطلبات بلا أوامر: operator.pairing
• الطلبات مع أوامر عقدة غير تنفيذية: operator.pairing + operator.write
• الطلبات التي تتضمن system.run أو system.run.prepare أو system.which: operator.pairing + operator.admin

​

الإمكانات/الأوامر/الأذونات (العقدة)

• caps: فئات إمكانات عالية المستوى مثل camera وcanvas وscreen، وlocation وvoice وtalk.
• commands: قائمة السماح للأوامر الخاصة بالاستدعاء.
• permissions: مفاتيح تبديل تفصيلية (مثل screen.record وcamera.capture).

​

الحضور

• يعيد system-presence إدخالات مفهرسة حسب هوية الجهاز.
• تتضمن إدخالات الحضور deviceId وroles وscopes حتى تتمكن واجهات المستخدم من عرض صف واحد لكل جهاز حتى عندما يتصل بصفته مشغّلا وعقدة معا.
• يتضمن node.list الحقلين الاختياريين lastSeenAtMs وlastSeenReason. تبلّغ العقد المتصلة عن وقت اتصالها الحالي كـ lastSeenAtMs مع السبب connect؛ كما يمكن للعقد المقترنة أن تبلّغ عن حضور خلفي دائم عندما يحدّث حدث عقدة موثوق بيانات تعريف إقرانها.

​

حدث بقاء العقدة في الخلفية

{
  "event": "node.presence.alive",
  "payloadJSON": "{\"trigger\":\"silent_push\",\"sentAtMs\":1737264000000,\"displayName\":\"Peter's iPhone\",\"version\":\"2026.4.28\",\"platform\":\"iOS 18.4.0\",\"deviceFamily\":\"iPhone\",\"modelIdentifier\":\"iPhone17,1\",\"pushTransport\":\"relay\"}"
}

{
  "ok": true,
  "event": "node.presence.alive",
  "handled": true,
  "reason": "persisted"
}

​

تحديد نطاق أحداث البث

• تتطلب إطارات الدردشة والوكيل ونتائج الأدوات (بما في ذلك أحداث agent المتدفقة ونتائج استدعاء الأدوات) على الأقل operator.read. تتخطى الجلسات التي لا تملك operator.read هذه الإطارات بالكامل.
• تخضع بثوث plugin.* المعرفة من Plugin إلى operator.write أو operator.admin، حسب كيفية تسجيلها بواسطة Plugin.
• تبقى أحداث الحالة والنقل (heartbeat وpresence وtick ودورة حياة الاتصال/قطع الاتصال وما إلى ذلك) غير مقيدة حتى تبقى صحة النقل قابلة للملاحظة لكل جلسة مصادق عليها.
• تخضع عائلات أحداث البث غير المعروفة لبوابة النطاق افتراضيا (فشل مغلق) ما لم يرخّصها معالج مسجل صراحة.

​

عائلات طرق RPC الشائعة

​

عائلات الأحداث الشائعة

• chat: تحديثات دردشة واجهة المستخدم مثل chat.inject وأحداث الدردشة الأخرى الخاصة بالنص فقط.
• session.message وsession.tool: تحديثات النص/تدفق الأحداث لجلسة مشترَك فيها.
• sessions.changed: تغيّر فهرس الجلسات أو بياناتها الوصفية.
• presence: تحديثات لقطات حضور النظام.
• tick: حدث keepalive / liveness دوري.
• health: تحديث لقطة صحة Gateway.
• heartbeat: تحديث تدفق أحداث Heartbeat.
• cron: حدث تغيّر تشغيل/مهمة cron.
• shutdown: إشعار إيقاف تشغيل Gateway.
• node.pair.requested / node.pair.resolved: دورة حياة إقران العقدة.
• node.invoke.request: بث طلب استدعاء العقدة.
• device.pair.requested / device.pair.resolved: دورة حياة الجهاز المقترن.
• voicewake.changed: تغيّر إعدادات محفّز كلمة التنبيه.
• exec.approval.requested / exec.approval.resolved: دورة حياة موافقة التنفيذ.
• plugin.approval.requested / plugin.approval.resolved: دورة حياة موافقة Plugin.

​

طرق مساعدة العقدة

• يمكن للعقد استدعاء skills.bins لجلب القائمة الحالية بملفات Skills التنفيذية لاستخدامها في فحوص السماح التلقائي.

​

استدعاءات RPC لسجل المهام

• يتطلب tasks.list إذن operator.read.
  • المعلمات: status اختياري ("queued" أو "running" أو "completed" أو "failed" أو "cancelled" أو "timed_out") أو مصفوفة من تلك الحالات، وagentId اختياري، وsessionKey اختياري، وlimit اختياري من 1 إلى 500، وcursor نصي اختياري.
  • النتيجة: { "tasks": TaskSummary[], "nextCursor"?: string }.
• يتطلب tasks.get إذن operator.read.
  • المعلمات: { "taskId": string }.
  • النتيجة: { "task": TaskSummary }.
  • تعيد معرّفات المهام المفقودة شكل خطأ عدم العثور في Gateway.
• يتطلب tasks.cancel إذن operator.write.
  • المعلمات: { "taskId": string, "reason"?: string }.
  • النتيجة: { "found": boolean, "cancelled": boolean, "reason"?: string, "task"?: TaskSummary }.
  • يوضّح found ما إذا كان السجل يحتوي على مهمة مطابقة. ويوضّح cancelled ما إذا كان وقت التشغيل قد قبل الإلغاء أو سجّله.

​

طرق مساعدة المشغّل

• يمكن للمشغّلين استدعاء commands.list (operator.read) لجلب مخزون أوامر وقت التشغيل لوكيل.
  • agentId اختياري؛ احذفه لقراءة مساحة عمل الوكيل الافتراضية.
  • يتحكم scope في السطح الذي يستهدفه name الأساسي:
    • يعيد text رمز أمر النص الأساسي دون / البادئة
    • يعيد native ومسار both الافتراضي الأسماء الأصلية الواعية بالمزوّد عندما تكون متاحة
  • يحمل textAliases الأسماء المستعارة المائلة الدقيقة مثل /model و/m.
  • يحمل nativeName اسم الأمر الأصلي الواعي بالمزوّد عند وجوده.
  • provider اختياري ولا يؤثر إلا في التسمية الأصلية إضافة إلى توافر أوامر Plugin الأصلية.
  • يؤدي includeArgs=false إلى حذف بيانات المعلمات المتسلسلة من الاستجابة.
• يمكن للمشغّلين استدعاء tools.catalog (operator.read) لجلب كتالوج أدوات وقت التشغيل لوكيل. تتضمن الاستجابة أدوات مجمّعة وبيانات وصفية عن المصدر:
  • source: core أو plugin
  • pluginId: مالك Plugin عندما تكون source="plugin"
  • optional: ما إذا كانت أداة Plugin اختيارية
• يمكن للمشغّلين استدعاء tools.effective (operator.read) لجلب مخزون الأدوات الفعّال في وقت التشغيل لجلسة.
  • sessionKey مطلوب.
  • يستنتج Gateway سياق وقت التشغيل الموثوق من الجلسة على جانب الخادم بدلاً من قبول سياق مصادقة أو تسليم يقدّمه المستدعي.
  • تكون الاستجابة محددة بنطاق الجلسة وتعكس ما يمكن للمحادثة النشطة استخدامه الآن، بما في ذلك أدوات النواة وPlugin والقناة.
• يمكن للمشغّلين استدعاء tools.invoke (operator.write) لاستدعاء أداة واحدة متاحة عبر مسار سياسة Gateway نفسه مثل /tools/invoke.
  • name مطلوب. args وsessionKey وagentId وconfirm و idempotencyKey اختيارية.
  • إذا كان كل من sessionKey وagentId موجودين، فيجب أن يطابق وكيل الجلسة المحلول agentId.
  • الاستجابة غلاف موجّه إلى SDK يحتوي على ok وtoolName وoutput اختياري وحقول error ذات أنواع. تعيد حالات رفض الموافقة أو السياسة ok:false في الحمولة بدلاً من تجاوز مسار سياسة أدوات Gateway.
• يمكن للمشغّلين استدعاء skills.status (operator.read) لجلب مخزون Skills المرئي لوكيل.
  • agentId اختياري؛ احذفه لقراءة مساحة عمل الوكيل الافتراضية.
  • تتضمن الاستجابة الأهلية والمتطلبات المفقودة وفحوص الإعدادات وخيارات التثبيت المنقّحة دون كشف قيم الأسرار الخام.
• يمكن للمشغّلين استدعاء skills.search وskills.detail (operator.read) للحصول على بيانات وصفية لاكتشاف ClawHub.
• يمكن للمشغّلين استدعاء skills.upload.begin وskills.upload.chunk و skills.upload.commit (operator.admin) لتجهيز أرشيف skill خاص قبل تثبيته. هذا مسار رفع إداري منفصل للعملاء الموثوقين، وليس تدفق تثبيت skill العادي من ClawHub، وهو معطّل افتراضياً ما لم يكن skills.install.allowUploadedArchives مفعّلاً.
  • ينشئ skills.upload.begin({ kind: "skill-archive", slug, sizeBytes, sha256?, force?, idempotencyKey? }) رفعاً مرتبطاً بتلك قيمة slug وقيمة force.
  • يضيف skills.upload.chunk({ uploadId, offset, dataBase64 }) بايتات عند الإزاحة المفككة الدقيقة.
  • يتحقق skills.upload.commit({ uploadId, sha256? }) من الحجم النهائي و SHA-256. لا يؤدي commit إلا إلى إنهاء الرفع؛ ولا يثبّت skill.
  • أرشيفات skill المرفوعة هي أرشيفات zip تحتوي على جذر SKILL.md. ولا يحدد اسم الدليل الداخلي للأرشيف هدف التثبيت أبداً.
• يمكن للمشغّلين استدعاء skills.install (operator.admin) بثلاثة أوضاع:
  • وضع ClawHub: يثبّت { source: "clawhub", slug, version?, force? } مجلد skill في دليل skills/ ضمن مساحة عمل الوكيل الافتراضية.
  • وضع الرفع: يثبّت { source: "upload", uploadId, slug, force?, sha256?, timeoutMs? } رفعاً مكتمل commit في دليل skills/<slug> ضمن مساحة عمل الوكيل الافتراضية. يجب أن تطابق قيمة slug وقيمة force طلب skills.upload.begin الأصلي. يُرفض هذا الوضع ما لم يكن skills.install.allowUploadedArchives مفعّلاً. لا يؤثر الإعداد في تثبيتات ClawHub.
  • وضع مثبّت Gateway: يشغّل { name, installId, dangerouslyForceUnsafeInstall?, timeoutMs? } إجراء metadata.openclaw.install معلناً على مضيف Gateway.
• يمكن للمشغّلين استدعاء skills.update (operator.admin) بوضعين:
  • يحدّث وضع ClawHub قيمة slug واحدة متتبعة أو جميع تثبيتات ClawHub المتتبعة في مساحة عمل الوكيل الافتراضية.
  • يطبّق وضع الإعدادات تصحيحات على قيم skills.entries.<skillKey> مثل enabled وapiKey وenv.

​

عروض models.list

• محذوفة أو "default": سلوك وقت التشغيل الحالي. إذا كان agents.defaults.models مهيأً، فستكون الاستجابة هي الكتالوج المسموح، بما في ذلك النماذج المكتشفة ديناميكياً لإدخالات provider/*. وإلا تكون الاستجابة هي كتالوج Gateway الكامل.
• "configured": سلوك بحجم المنتقي. إذا كان agents.defaults.models مهيأً، فإنه يظل صاحب الأولوية، بما في ذلك الاكتشاف المحدد بنطاق المزوّد لإدخالات provider/*. ومن دون قائمة سماح، تستخدم الاستجابة إدخالات models.providers.*.models الصريحة، مع الرجوع إلى الكتالوج الكامل فقط عندما لا توجد صفوف نماذج مهيأة.
• "all": كتالوج Gateway الكامل، مع تجاوز agents.defaults.models. استخدم هذا لواجهات التشخيص والاكتشاف، لا لمنتقيات النماذج العادية.

​

موافقات التنفيذ

• عندما يحتاج طلب تنفيذ إلى موافقة، يبث Gateway الحدث exec.approval.requested.
• يحل عملاء المشغّل ذلك باستدعاء exec.approval.resolve (يتطلب نطاق operator.approvals).
• بالنسبة إلى host=node، يجب أن يتضمن exec.approval.request قيمة systemRunPlan (الحقول القانونية argv/cwd/rawCommand/بيانات الجلسة الوصفية). تُرفض الطلبات التي تفتقد systemRunPlan.
• بعد الموافقة، تعيد استدعاءات node.invoke system.run المعاد توجيهها استخدام systemRunPlan القانونية تلك كسياق موثوق للأمر/cwd/الجلسة.
• إذا عدّل مستدعٍ command أو rawCommand أو cwd أو agentId أو sessionKey بين التحضير والتوجيه النهائي الموافق عليه إلى system.run، فإن Gateway يرفض التشغيل بدلاً من الوثوق بالحمولة المعدّلة.

​

رجوع تسليم الوكيل

• يمكن أن تتضمن طلبات agent القيمة deliver=true لطلب تسليم صادر.
• يحافظ bestEffortDeliver=false على السلوك الصارم: أهداف التسليم غير المحلولة أو الداخلية فقط تعيد INVALID_REQUEST.
• يسمح bestEffortDeliver=true بالرجوع إلى التنفيذ الخاص بالجلسة فقط عندما يتعذر حل مسار خارجي قابل للتسليم (على سبيل المثال جلسات داخلية/دردشة ويب أو إعدادات متعددة القنوات مبهمة).
• قد تتضمن نتائج agent النهائية result.deliveryStatus عندما يكون التسليم مطلوباً، باستخدام حالات sent وsuppressed وpartial_failed وfailed نفسها الموثقة لـ openclaw agent --json --deliver.

​

تحديد الإصدارات

• يوجد PROTOCOL_VERSION في src/gateway/protocol/version.ts.
• يرسل العملاء minProtocol + maxProtocol؛ ويرفض الخادم النطاقات التي لا تتضمن بروتوكوله الحالي. تستخدم العملاء الأصلية حداً أدنى v3 حتى تتمكن عملاء v4 الإضافية من الوصول إلى بوابات v3.
• تُولَّد المخططات + النماذج من تعريفات TypeBox:
  • pnpm protocol:gen
  • pnpm protocol:gen:swift
  • pnpm protocol:check

​

ثوابت العميل

​

المصادقة

• تستخدم مصادقة Gateway بالسر المشترك connect.params.auth.token أو connect.params.auth.password، حسب وضع المصادقة المكوَّن.
• أوضاع حاملة الهوية مثل Tailscale Serve (gateway.auth.allowTailscale: true) أو gateway.auth.mode: "trusted-proxy" غير المعتمدة على local loopback تفي بفحص مصادقة الاتصال من ترويسات الطلب بدلا من connect.params.auth.*.
• يتجاوز gateway.auth.mode: "none" للإدخال الخاص مصادقة الاتصال بالسر المشترك بالكامل؛ لا تعرض هذا الوضع على إدخال عام/غير موثوق.
• بعد الاقتران، يصدر Gateway رمز جهاز مقيَّدا بدور الاتصال + النطاقات. يُعاد في hello-ok.auth.deviceToken وينبغي أن يحفظه العميل لاستخدامه في الاتصالات المستقبلية.
• ينبغي للعملاء حفظ hello-ok.auth.deviceToken الأساسي بعد أي اتصال ناجح.
• ينبغي أن تعيد إعادة الاتصال باستخدام رمز الجهاز المخزَّن استخدام مجموعة النطاقات الموافق عليها والمخزنة لذلك الرمز أيضا. يحافظ هذا على وصول القراءة/الفحص/الحالة الذي مُنح مسبقا، ويتجنب تضييق إعادة الاتصالات بصمت إلى نطاق ضمني مقتصر على المدير فقط.
• تجميع مصادقة الاتصال من جانب العميل (selectConnectAuth في src/gateway/client.ts):
  • auth.password مستقل، ويُمرَّر دائما عند ضبطه.
  • يُملأ auth.token حسب ترتيب الأولوية: الرمز المشترك الصريح أولا، ثم deviceToken صريح، ثم رمز مخزن لكل جهاز (مفهرس حسب deviceId + role).
  • لا يُرسل auth.bootstrapToken إلا عندما لا ينتج أي مما سبق auth.token. يمنعه الرمز المشترك أو أي رمز جهاز محلول.
  • تخضع الترقية التلقائية لرمز جهاز مخزن عند إعادة محاولة AUTH_TOKEN_MISMATCH لمرة واحدة لـ نقاط النهاية الموثوقة فقط — loopback، أو wss:// مع tlsFingerprint مثبت. لا يتأهل wss:// العام دون تثبيت.
• إدخالات hello-ok.auth.deviceTokens الإضافية هي رموز تسليم bootstrap. احفظها فقط عندما يستخدم الاتصال مصادقة bootstrap على نقل موثوق مثل wss:// أو الاقتران عبر loopback/محلي.
• إذا قدّم العميل deviceToken صريحا أو scopes صريحة، فإن مجموعة النطاقات التي طلبها المستدعي تبقى المرجع؛ لا يُعاد استخدام النطاقات المخزنة مؤقتا إلا عندما يعيد العميل استخدام الرمز المخزن لكل جهاز.
• يمكن تدوير/إبطال رموز الأجهزة عبر device.token.rotate و device.token.revoke (يتطلب نطاق operator.pairing).
• يعيد device.token.rotate بيانات وصفية للتدوير. يعكس رمز الحامل البديل فقط للاستدعاءات من الجهاز نفسه التي تمت مصادقتها بالفعل باستخدام رمز ذلك الجهاز، بحيث يمكن للعملاء المعتمدين على الرمز فقط حفظ البديل قبل إعادة الاتصال. لا تعكس تدويرات السر المشترك/المدير رمز الحامل.
• يبقى إصدار الرموز وتدويرها وإبطالها محصورا في مجموعة الأدوار الموافق عليها والمسجلة في إدخال اقتران ذلك الجهاز؛ لا يمكن لتعديل الرمز توسيع أو استهداف دور جهاز لم تمنحه موافقة الاقتران مطلقا.
• بالنسبة إلى جلسات رموز الأجهزة المقترنة، تكون إدارة الجهاز ذاتية النطاق ما لم يكن لدى المستدعي أيضا operator.admin: يستطيع المستدعون غير المديرين إزالة/إبطال/تدوير إدخال جهازهم الخاص فقط.
• يتحقق device.token.rotate وdevice.token.revoke أيضا من مجموعة نطاقات رمز المشغل الهدف مقابل نطاقات جلسة المستدعي الحالية. لا يستطيع المستدعون غير المديرين تدوير أو إبطال رمز مشغل أوسع مما لديهم بالفعل.
• تتضمن إخفاقات المصادقة error.details.code إضافة إلى تلميحات الاسترداد:
  • error.details.canRetryWithDeviceToken (boolean)
  • error.details.recommendedNextStep (retry_with_device_token, update_auth_configuration, update_auth_credentials, wait_then_retry, review_auth_configuration)
• سلوك العميل عند AUTH_TOKEN_MISMATCH:
  • يمكن للعملاء الموثوقين محاولة إعادة محاولة واحدة محدودة باستخدام رمز مخزن لكل جهاز.
  • إذا فشلت تلك المحاولة، ينبغي للعملاء إيقاف حلقات إعادة الاتصال التلقائية وإظهار إرشادات إجراء للمشغل.
• يعني AUTH_SCOPE_MISMATCH أن رمز الجهاز تم التعرف عليه لكنه لا يغطي الدور/النطاقات المطلوبة. ينبغي ألا يقدّم العملاء هذا على أنه رمز سيئ؛ اطلب من المشغل إعادة الاقتران أو الموافقة على عقد نطاق أضيق/أوسع.

​

هوية الجهاز + الاقتران

• ينبغي أن تتضمن Nodes هوية جهاز مستقرة (device.id) مشتقة من بصمة زوج مفاتيح.
• تصدر Gateways رموزا لكل جهاز + دور.
• موافقات الاقتران مطلوبة لمعرّفات الأجهزة الجديدة ما لم تكن الموافقة التلقائية المحلية مفعّلة.
• تتمحور الموافقة التلقائية على الاقتران حول اتصالات local loopback المباشرة.
• يمتلك OpenClaw أيضا مسار اتصال ذاتي ضيق للخلفية/الحاوية المحلية من أجل تدفقات المساعد الموثوقة بالسر المشترك.
• ما تزال اتصالات tailnet أو LAN على المضيف نفسه تُعامل كاتصالات بعيدة للاقتران وتتطلب موافقة.
• عادةً ما يتضمن عملاء WS هوية device أثناء connect (المشغل + node). استثناءات المشغل دون جهاز الوحيدة هي مسارات الثقة الصريحة:
  • gateway.controlUi.allowInsecureAuth=true لتوافق HTTP غير الآمن المقتصر على localhost.
  • نجاح مصادقة واجهة Control UI للمشغل عبر gateway.auth.mode: "trusted-proxy".
  • gateway.controlUi.dangerouslyDisableDeviceAuth=true (كسر طارئ، خفض أمني شديد).
  • استدعاءات RPC الخلفية المباشرة عبر loopback لـ gateway-client والمصادق عليها باستخدام رمز/كلمة مرور Gateway المشتركة.
• يجب على جميع الاتصالات توقيع nonce في connect.challenge المقدم من الخادم.

​

تشخيصات ترحيل مصادقة الجهاز

• انتظر دائما connect.challenge.
• وقّع حمولة v2 التي تتضمن nonce الخادم.
• أرسل nonce نفسه في connect.params.device.nonce.
• حمولة التوقيع المفضلة هي v3، والتي تربط platform وdeviceFamily إضافة إلى حقول الجهاز/العميل/الدور/النطاقات/الرمز/nonce.
• تظل توقيعات v2 القديمة مقبولة للتوافق، لكن تثبيت البيانات الوصفية للأجهزة المقترنة ما يزال يتحكم في سياسة الأوامر عند إعادة الاتصال.

​

TLS + التثبيت

• TLS مدعوم لاتصالات WS.
• يمكن للعملاء اختياريا تثبيت بصمة شهادة Gateway (راجع إعداد gateway.tls إضافة إلى gateway.remote.tlsFingerprint أو CLI --tls-fingerprint).

​

النطاق

​

ذات صلة

• بروتوكول الجسر
• دليل تشغيل Gateway