Strengthen OpenClaw onboarding auth-token requirements
This commit is contained in:
@@ -46,6 +46,8 @@ describe("buildInviteOnboardingTextDocument", () => {
|
|||||||
expect(text).toContain("http://localhost:3100");
|
expect(text).toContain("http://localhost:3100");
|
||||||
expect(text).toContain("host.docker.internal");
|
expect(text).toContain("host.docker.internal");
|
||||||
expect(text).toContain("paperclipApiUrl");
|
expect(text).toContain("paperclipApiUrl");
|
||||||
|
expect(text).toContain("You MUST include agentDefaultsPayload.headers.x-openclaw-auth");
|
||||||
|
expect(text).toContain("will fail with 401 Unauthorized");
|
||||||
expect(text).toContain("set the first reachable candidate as agentDefaultsPayload.paperclipApiUrl");
|
expect(text).toContain("set the first reachable candidate as agentDefaultsPayload.paperclipApiUrl");
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -427,6 +427,22 @@ function normalizeAgentDefaultsForJoin(input: {
|
|||||||
normalized.webhookAuthHeader = defaults.webhookAuthHeader.trim();
|
normalized.webhookAuthHeader = defaults.webhookAuthHeader.trim();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const openClawAuthHeader = headers ? headerMapGetIgnoreCase(headers, "x-openclaw-auth") : null;
|
||||||
|
if (openClawAuthHeader) {
|
||||||
|
diagnostics.push({
|
||||||
|
code: "openclaw_auth_header_configured",
|
||||||
|
level: "info",
|
||||||
|
message: "Gateway auth token received via headers.x-openclaw-auth.",
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
diagnostics.push({
|
||||||
|
code: "openclaw_auth_header_missing",
|
||||||
|
level: "warn",
|
||||||
|
message: "Gateway auth token is missing from agent defaults.",
|
||||||
|
hint: "Set agentDefaultsPayload.headers.x-openclaw-auth to the token your OpenClaw /v1/responses endpoint requires.",
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
if (isPlainObject(defaults.payloadTemplate)) {
|
if (isPlainObject(defaults.payloadTemplate)) {
|
||||||
normalized.payloadTemplate = defaults.payloadTemplate;
|
normalized.payloadTemplate = defaults.payloadTemplate;
|
||||||
}
|
}
|
||||||
@@ -646,7 +662,7 @@ function buildInviteOnboardingManifest(
|
|||||||
invite: toInviteSummaryResponse(req, token, invite),
|
invite: toInviteSummaryResponse(req, token, invite),
|
||||||
onboarding: {
|
onboarding: {
|
||||||
instructions:
|
instructions:
|
||||||
"Join as an agent, save your one-time claim secret, wait for board approval, then claim your API key and install the Paperclip skill before starting heartbeat loops.",
|
"Join as an OpenClaw agent, save your one-time claim secret, wait for board approval, then claim your API key and install the Paperclip skill before starting heartbeat loops. You MUST include agentDefaultsPayload.headers.x-openclaw-auth in your join request so Paperclip can authenticate callback requests.",
|
||||||
inviteMessage: extractInviteMessage(invite),
|
inviteMessage: extractInviteMessage(invite),
|
||||||
recommendedAdapterType: "openclaw",
|
recommendedAdapterType: "openclaw",
|
||||||
requiredFields: {
|
requiredFields: {
|
||||||
@@ -655,7 +671,7 @@ function buildInviteOnboardingManifest(
|
|||||||
adapterType: "Use 'openclaw' for OpenClaw streaming agents",
|
adapterType: "Use 'openclaw' for OpenClaw streaming agents",
|
||||||
capabilities: "Optional capability summary",
|
capabilities: "Optional capability summary",
|
||||||
agentDefaultsPayload:
|
agentDefaultsPayload:
|
||||||
"Optional adapter config such as url/method/headers/webhookAuthHeader and paperclipApiUrl for OpenClaw SSE endpoint",
|
"Adapter config for OpenClaw SSE endpoint. MUST include headers.x-openclaw-auth; also include url/method/paperclipApiUrl (and optional webhookAuthHeader/timeoutSec/payloadTemplate).",
|
||||||
},
|
},
|
||||||
registrationEndpoint: {
|
registrationEndpoint: {
|
||||||
method: "POST",
|
method: "POST",
|
||||||
@@ -754,6 +770,9 @@ export function buildInviteOnboardingTextDocument(
|
|||||||
"## Step 1: Submit agent join request",
|
"## Step 1: Submit agent join request",
|
||||||
`${onboarding.registrationEndpoint.method} ${onboarding.registrationEndpoint.url}`,
|
`${onboarding.registrationEndpoint.method} ${onboarding.registrationEndpoint.url}`,
|
||||||
"",
|
"",
|
||||||
|
"IMPORTANT: You MUST include agentDefaultsPayload.headers.x-openclaw-auth with your gateway token.",
|
||||||
|
"Without this token, Paperclip callback requests to your OpenClaw endpoint will fail with 401 Unauthorized.",
|
||||||
|
"",
|
||||||
"Body (JSON):",
|
"Body (JSON):",
|
||||||
"{",
|
"{",
|
||||||
' "requestType": "agent",',
|
' "requestType": "agent",',
|
||||||
|
|||||||
Reference in New Issue
Block a user