Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 47 additions & 8 deletions src/components/HelpTooltip.tsx
Original file line number Diff line number Diff line change
@@ -1,29 +1,68 @@
import * as React from "react";
import FullTooltip from "@components/FullTooltip";
import { HelpCircle } from "lucide-react";
import { cn } from "@utils/helpers";
import { TooltipVariants } from "@components/Tooltip";

type Props = {
content: React.ReactNode;
children: React.ReactNode;
children?: React.ReactNode;
interactive?: boolean;
};
className?: string;
triggerClassName?: string;
align?: "start" | "center" | "end";
side?: "top" | "right" | "bottom" | "left";
alignOffset?: number;
sideOffset?: number;
iconSize?: number;
delayDuration?: number;
} & TooltipVariants;
export const HelpTooltip = ({
content,
children,
interactive = true,
interactive = false,
className,
variant = "default",
triggerClassName,
align = "start",
side = "top",
alignOffset = 0,
sideOffset,
iconSize = 12,
delayDuration = 300,
}: Props) => {
return (
<>
<FullTooltip
interactive={interactive}
side={"top"}
align={"start"}
alignOffset={0}
side={side}
align={align}
alignOffset={alignOffset}
sideOffset={sideOffset}
delayDuration={delayDuration}
variant={variant}
className={
"inline underline decoration-dashed underline-offset-[3px] decoration-nb-gray-300 cursor-help transition-all hover:decoration-white"
}
content={content}
content={
<div className={cn("max-w-xs text-xs", className)}>{content}</div>
}
>
{children}
{children ? (
children
) : (
<span
className={cn(
"p-2 -m-2 inline-flex items-center justify-center relative top-[1px] group/help",
triggerClassName,
)}
>
<HelpCircle
size={iconSize}
className={"text-nb-gray-300 group-hover/help:text-nb-gray-100"}
/>
</span>
)}
</FullTooltip>
</>
);
Expand Down
10 changes: 10 additions & 0 deletions src/interfaces/ReverseProxy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@ export enum ReverseProxyStatus {
ERROR = "error",
}

export type ServiceTargetOptionsPathRewrite = "preserve";

export interface ServiceTargetOptions {
skip_tls_verify?: boolean;
request_timeout?: string;
path_rewrite?: ServiceTargetOptionsPathRewrite;
custom_headers?: Record<string, string>;
}

export interface ReverseProxyTarget {
target_id?: string;
target_type: ReverseProxyTargetType;
Expand All @@ -35,6 +44,7 @@ export interface ReverseProxyTarget {
port: number;
enabled: boolean;
access_local?: boolean;
options?: ServiceTargetOptions;
// Frontend
destination?: string;
}
Expand Down
2 changes: 1 addition & 1 deletion src/modules/reverse-proxy/ReverseProxyModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ export default function ReverseProxyModal({
</TabsTrigger>
<TabsTrigger value={"settings"} disabled={!canContinueToSettings}>
<Settings size={14} />
Settings
Advanced Settings
</TabsTrigger>
</TabsList>

Expand Down
185 changes: 185 additions & 0 deletions src/modules/reverse-proxy/targets/ReverseProxyTargetCustomHeaders.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
import Button from "@components/Button";
import HelpText from "@components/HelpText";
import { Input } from "@components/Input";
import { Label } from "@components/Label";
import { MinusCircleIcon, PlusIcon } from "lucide-react";
import { useCallback, useState } from "react";

const HEADER_NAME_RE = /^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/;
const BLOCKED_HEADERS = new Set([
"host",
"connection",
"transfer-encoding",
"keep-alive",
"proxy-authenticate",
"proxy-authorization",
"te",
"trailer",
"upgrade",
]);

type HeaderEntry = { id: number; name: string; value: string };

function recordToHeaderEntries(
record: Record<string, string> | undefined,
nextId: () => number,
): HeaderEntry[] {
if (!record) return [];
return Object.entries(record).map(([name, value]) => ({
id: nextId(),
name,
value,
}));
}

export function headerEntriesToRecord(
entries: HeaderEntry[],
): Record<string, string> | undefined {
if (entries.length === 0) return undefined;
const record: Record<string, string> = {};
for (const entry of entries) {
if (entry.name) record[entry.name] = entry.value;
}
return Object.keys(record).length > 0 ? record : undefined;
}

function validateHeaderName(
name: string,
allNames: string[],
): string | undefined {
if (!name) return undefined;
if (!HEADER_NAME_RE.test(name))
return "Invalid characters in header name. Please use another one.";
if (BLOCKED_HEADERS.has(name.toLowerCase()))
return `"${name}" is a reserved header. Please use another one.`;
const dupeCount = allNames.filter(
(n) => n.toLowerCase() === name.toLowerCase(),
).length;
if (dupeCount > 1) return "Duplicate header name. Please use another one.";
return undefined;
}

function validateHeaderValue(value: string): string | undefined {
if (value.includes("\r") || value.includes("\n"))
return "Value must not contain line breaks";
return undefined;
}

export function useCustomHeaders(initialHeaders?: Record<string, string>) {
const [nextId] = useState(() => {
let id = 0;
return () => ++id;
});

const [headerEntries, setHeaderEntries] = useState<HeaderEntry[]>(() =>
recordToHeaderEntries(initialHeaders, nextId),
);

const addHeader = useCallback(() => {
setHeaderEntries((prev) => [
...prev,
{ id: nextId(), name: "", value: "" },
]);
}, [nextId]);

const removeHeader = useCallback((id: number) => {
setHeaderEntries((prev) => prev.filter((h) => h.id !== id));
}, []);

const updateHeaderEntry = useCallback(
(id: number, field: "name" | "value", fieldValue: string) => {
setHeaderEntries((prev) =>
prev.map((h) => (h.id === id ? { ...h, [field]: fieldValue } : h)),
);
},
[],
);

const allHeaderNames = headerEntries.map((h) => h.name);
const headerErrors = headerEntries.map((entry) => ({
name: validateHeaderName(entry.name, allHeaderNames),
value: validateHeaderValue(entry.value),
}));

const hasHeaderErrors = headerErrors.some((e) => e.name || e.value);
Comment thread
heisbrot marked this conversation as resolved.

return {
headerEntries,
setHeaderEntries,
addHeader,
removeHeader,
updateHeaderEntry,
headerErrors,
hasHeaderErrors,
};
}

export type CustomHeadersProps = Pick<
ReturnType<typeof useCustomHeaders>,
| "headerEntries"
| "addHeader"
| "removeHeader"
| "updateHeaderEntry"
| "headerErrors"
>;

export default function ReverseProxyTargetCustomHeaders({
headerEntries,
addHeader,
removeHeader,
updateHeaderEntry,
headerErrors,
}: CustomHeadersProps) {
return (
<div>
<Label>Custom Headers</Label>
<HelpText>
Add additional headers to include when forwarding requests.
<br />
Hop-by-hop headers like Host or Connection are not allowed.
</HelpText>
{headerEntries.length > 0 && (
<div className="flex flex-col gap-2 mb-3">
{headerEntries.map((entry, index) => (
<div key={entry.id} className="flex items-center gap-2">
<Input
placeholder="Header, e.g., Authorization"
aria-label={`Header name for entry ${entry.id}`}
value={entry.name}
onChange={(e) =>
updateHeaderEntry(entry.id, "name", e.target.value)
}
maxWidthClass="flex-1"
error={headerErrors[index]?.name}
errorTooltip
/>
<Input
placeholder="Value, e.g., Bearer eyJhbGci..."
aria-label={`Header value for entry ${entry.id}`}
value={entry.value}
onChange={(e) =>
updateHeaderEntry(entry.id, "value", e.target.value)
}
maxWidthClass="flex-1"
error={headerErrors[index]?.value}
errorTooltip
/>
Comment thread
heisbrot marked this conversation as resolved.
<Button
variant="default-outline"
className="!px-2 shrink-0"
onClick={() => removeHeader(entry.id)}
aria-label="Remove header"
>
<MinusCircleIcon size={14} />
</Button>
</div>
))}
</div>
)}
<Button variant="dotted" className="w-full" size="sm" onClick={addHeader}>
<PlusIcon size={14} />
Add Header
</Button>
</div>
);
}
Loading