Skip to content

Commit bbde5eb

Browse files
committed
feat(permissions): add server.terminal to decouple server access from root SSH
Reaching a server implied being able to open an SSH root shell on it: the /terminal websocket only checked that the server was in the caller's accessible set, so granting a server to a developer necessarily granted root on it. Add a server.terminal action, assignable on custom roles, and require it on the remote-server terminal websocket on top of server access. Owner/admin keep it through the enterprise bypass; the local host terminal stays owner/admin only. A migration grants server.terminal to existing custom roles that already have server.read, which is the permission that surfaces the terminal today, so current setups keep working. Roles without a server entry are left alone. Note: server.create still implies root execution (server.update persists server.command and server.setup runs it over SSH), reflected in the Create description in the role editor.
1 parent a8e0477 commit bbde5eb

11 files changed

Lines changed: 9336 additions & 29 deletions

File tree

‎apps/dokploy/__test__/permissions/check-permission.test.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,13 @@ describe("member is denied org-level enterprise resources (CVE: bypass via stati
126126
await expect(checkPermission(ctx, { server: ["read"] })).rejects.toThrow();
127127
});
128128

129+
it("member is denied server.terminal", async () => {
130+
memberToReturn = mockMemberData("member");
131+
await expect(
132+
checkPermission(ctx, { server: ["terminal"] }),
133+
).rejects.toThrow();
134+
});
135+
129136
it("member is denied registry.create", async () => {
130137
memberToReturn = mockMemberData("member");
131138
await expect(

‎apps/dokploy/__test__/permissions/resolve-permissions.test.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ describe("enterprise resources for static roles", () => {
105105
const perms = await resolvePermissions(ctx);
106106

107107
expect(perms.server.read).toBe(false);
108+
expect(perms.server.terminal).toBe(false);
108109
expect(perms.registry.read).toBe(false);
109110
expect(perms.certificate.read).toBe(false);
110111
expect(perms.destination.read).toBe(false);
Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
import { beforeEach, describe, expect, it, vi } from "vitest";
2+
3+
const mockMemberData = (role: string) => ({
4+
id: "member-1",
5+
role,
6+
userId: "user-1",
7+
organizationId: "org-1",
8+
accessedProjects: [] as string[],
9+
accessedServices: [] as string[],
10+
accessedEnvironments: [] as string[],
11+
accessedServers: [] as string[],
12+
canCreateProjects: false,
13+
canDeleteProjects: false,
14+
canCreateServices: false,
15+
canDeleteServices: false,
16+
canCreateEnvironments: false,
17+
canDeleteEnvironments: false,
18+
canAccessToTraefikFiles: false,
19+
canAccessToDocker: false,
20+
canAccessToAPI: false,
21+
canAccessToSSHKeys: false,
22+
canAccessToGitProviders: false,
23+
user: { id: "user-1", email: "[email protected]" },
24+
});
25+
26+
let memberToReturn = mockMemberData("deployer");
27+
let rolesToReturn: { permission: string }[] = [];
28+
29+
vi.mock("@dokploy/server/db", () => ({
30+
db: {
31+
query: {
32+
member: {
33+
findFirst: vi.fn(() => Promise.resolve(memberToReturn)),
34+
findMany: vi.fn(() => Promise.resolve([])),
35+
},
36+
organizationRole: {
37+
findFirst: vi.fn(),
38+
findMany: vi.fn(() => Promise.resolve(rolesToReturn)),
39+
},
40+
},
41+
},
42+
}));
43+
44+
vi.mock("@dokploy/server/services/proprietary/license-key", () => ({
45+
hasValidLicense: vi.fn(() => Promise.resolve(true)),
46+
}));
47+
48+
const { checkPermission, resolvePermissions } = await import(
49+
"@dokploy/server/services/permission"
50+
);
51+
52+
const ctx = {
53+
user: { id: "user-1" },
54+
session: { activeOrganizationId: "org-1" },
55+
};
56+
57+
const withPermissions = (permissions: Record<string, string[]>) => {
58+
rolesToReturn = [{ permission: JSON.stringify(permissions) }];
59+
};
60+
61+
beforeEach(() => {
62+
vi.clearAllMocks();
63+
memberToReturn = mockMemberData("deployer");
64+
rolesToReturn = [];
65+
});
66+
67+
describe("server.terminal on custom roles", () => {
68+
it("a role with server.read alone cannot open a terminal", async () => {
69+
withPermissions({ server: ["read"] });
70+
71+
await expect(
72+
checkPermission(ctx, { server: ["read"] }),
73+
).resolves.toBeUndefined();
74+
await expect(
75+
checkPermission(ctx, { server: ["terminal"] }),
76+
).rejects.toThrow();
77+
78+
const perms = await resolvePermissions(ctx);
79+
expect(perms.server.read).toBe(true);
80+
expect(perms.server.terminal).toBe(false);
81+
});
82+
83+
it("a role with server.terminal can open a terminal", async () => {
84+
withPermissions({ server: ["read", "terminal"] });
85+
86+
await expect(
87+
checkPermission(ctx, { server: ["terminal"] }),
88+
).resolves.toBeUndefined();
89+
90+
const perms = await resolvePermissions(ctx);
91+
expect(perms.server.terminal).toBe(true);
92+
});
93+
94+
it("owner and admin keep terminal access", async () => {
95+
for (const role of ["owner", "admin"]) {
96+
memberToReturn = mockMemberData(role);
97+
await expect(
98+
checkPermission(ctx, { server: ["terminal"] }),
99+
).resolves.toBeUndefined();
100+
101+
const perms = await resolvePermissions(ctx);
102+
expect(perms.server.terminal).toBe(true);
103+
}
104+
});
105+
});

‎apps/dokploy/__test__/wss/authorize.test.ts‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,35 @@ describe("canAccessTerminalOverWss", () => {
9595
});
9696

9797
it("gates a remote server terminal on server access", async () => {
98+
mockHasPermission.mockResolvedValue(true);
9899
mockGetAccessibleServerIds.mockResolvedValue(new Set(["srv-1"]));
99100
expect(await canAccessTerminalOverWss(USER, SESSION, "srv-1")).toBe(true);
100101
expect(await canAccessTerminalOverWss(USER, SESSION, "srv-2")).toBe(false);
101-
// role lookup must not be needed for the remote path
102+
// the remote path must never fall through to the owner/admin local branch
102103
expect(mockFindMember).not.toHaveBeenCalled();
103104
});
105+
106+
it("denies a remote server terminal without the server.terminal permission", async () => {
107+
// Reaching a server (to deploy on it) must not imply a root shell on it.
108+
mockGetAccessibleServerIds.mockResolvedValue(new Set(["srv-1"]));
109+
mockHasPermission.mockResolvedValue(false);
110+
expect(await canAccessTerminalOverWss(USER, SESSION, "srv-1")).toBe(false);
111+
expect(mockHasPermission).toHaveBeenCalledWith(
112+
{ user: { id: USER.id }, session: { activeOrganizationId: "org-1" } },
113+
{ server: ["terminal"] },
114+
);
115+
});
116+
117+
it("allows a remote server terminal with the server.terminal permission", async () => {
118+
mockGetAccessibleServerIds.mockResolvedValue(new Set(["srv-1"]));
119+
mockHasPermission.mockResolvedValue(true);
120+
expect(await canAccessTerminalOverWss(USER, SESSION, "srv-1")).toBe(true);
121+
});
122+
123+
it("does not check permissions for a server the caller cannot access", async () => {
124+
mockGetAccessibleServerIds.mockResolvedValue(new Set(["srv-1"]));
125+
mockHasPermission.mockResolvedValue(true);
126+
expect(await canAccessTerminalOverWss(USER, SESSION, "srv-2")).toBe(false);
127+
expect(mockHasPermission).not.toHaveBeenCalled();
128+
});
104129
});

‎apps/dokploy/components/dashboard/settings/servers/show-servers.tsx‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -250,29 +250,30 @@ export const ShowServers = () => {
250250
</div>
251251

252252
<TooltipProvider>
253-
{server.sshKeyId && (
254-
<Tooltip>
255-
<TooltipTrigger asChild>
256-
<div>
257-
<TerminalModal
258-
serverId={server.serverId}
259-
asButton={true}
260-
>
261-
<Button
262-
variant="outline"
263-
size="icon"
264-
className="h-9 w-9"
253+
{server.sshKeyId &&
254+
permissions?.server.terminal && (
255+
<Tooltip>
256+
<TooltipTrigger asChild>
257+
<div>
258+
<TerminalModal
259+
serverId={server.serverId}
260+
asButton={true}
265261
>
266-
<Terminal className="h-4 w-4" />
267-
</Button>
268-
</TerminalModal>
269-
</div>
270-
</TooltipTrigger>
271-
<TooltipContent>
272-
<p>Terminal</p>
273-
</TooltipContent>
274-
</Tooltip>
275-
)}
262+
<Button
263+
variant="outline"
264+
size="icon"
265+
className="h-9 w-9"
266+
>
267+
<Terminal className="h-4 w-4" />
268+
</Button>
269+
</TerminalModal>
270+
</div>
271+
</TooltipTrigger>
272+
<TooltipContent>
273+
<p>Terminal</p>
274+
</TooltipContent>
275+
</Tooltip>
276+
)}
276277

277278
<Tooltip>
278279
<TooltipTrigger asChild>

‎apps/dokploy/components/proprietary/roles/manage-custom-roles.tsx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,10 @@ const ACTION_META: Record<
328328
label: "Delete",
329329
description: "Remove servers from the organization",
330330
},
331+
terminal: {
332+
label: "Terminal",
333+
description: "Open an SSH root shell on remote servers",
334+
},
331335
},
332336
registry: {
333337
read: { label: "Read", description: "View configured Docker registries" },
@@ -569,7 +573,7 @@ const ROLE_PRESETS: {
569573
envVars: ["read", "write"],
570574
projectEnvVars: ["read", "write"],
571575
environmentEnvVars: ["read", "write"],
572-
server: ["read", "create", "delete"],
576+
server: ["read", "create", "delete", "terminal"],
573577
registry: ["read", "create", "delete"],
574578
certificate: ["read", "create", "delete"],
575579
backup: ["read", "create", "delete", "restore"],
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
-- Grant the new "server.terminal" permission to existing custom roles that already have
2+
-- "server.read", which is the permission that surfaces the terminal in the UI today.
3+
-- Roles without a "server" entry are deliberately left alone: they never saw the terminal in the
4+
-- UI, so from now on they are denied at the websocket too.
5+
UPDATE "organization_role" AS r
6+
SET "permission" = jsonb_set(
7+
r."permission"::jsonb,
8+
'{server}',
9+
(r."permission"::jsonb->'server') || '["terminal"]'::jsonb
10+
)::text
11+
WHERE jsonb_typeof(r."permission"::jsonb->'server') = 'array'
12+
AND r."permission"::jsonb->'server' @> '["read"]'::jsonb
13+
AND NOT r."permission"::jsonb->'server' @> '["terminal"]'::jsonb;

0 commit comments

Comments
 (0)